From a872f8d4cccc9d0c7deeee5709d59375e7c0945c Mon Sep 17 00:00:00 2001 From: awstools Date: Tue, 13 Jun 2023 18:05:39 +0000 Subject: [PATCH] chore(models): update API models --- .../sdk-codegen/aws-models/cloudtrail.json | 17797 +- .../aws-models/codeguru-security.json | 3017 + codegen/sdk-codegen/aws-models/drs.json | 16314 +- codegen/sdk-codegen/aws-models/ec2.json | 202748 ++++++++------- .../sdk-codegen/aws-models/imagebuilder.json | 21922 +- codegen/sdk-codegen/aws-models/lightsail.json | 45073 ++-- codegen/sdk-codegen/aws-models/s3.json | 6 + .../sdk-codegen/aws-models/securityhub.json | 61590 ++--- .../aws-models/simspaceweaver.json | 5529 +- .../aws-models/verifiedpermissions.json | 4314 + codegen/sdk-codegen/aws-models/wafv2.json | 25405 +- .../aws-models/wellarchitected.json | 16991 +- 12 files changed, 216602 insertions(+), 204104 deletions(-) create mode 100644 codegen/sdk-codegen/aws-models/codeguru-security.json create mode 100644 codegen/sdk-codegen/aws-models/verifiedpermissions.json diff --git a/codegen/sdk-codegen/aws-models/cloudtrail.json b/codegen/sdk-codegen/aws-models/cloudtrail.json index 12db89fdf952..a2cd6425b2a5 100644 --- a/codegen/sdk-codegen/aws-models/cloudtrail.json +++ b/codegen/sdk-codegen/aws-models/cloudtrail.json @@ -1,9238 +1,9289 @@ { - "smithy": "2.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] - }, - "shapes": { - "com.amazonaws.cloudtrail#AccountHasOngoingImportException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "AccountHasOngoingImport", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This exception is thrown when you start a new import and a previous import is still in\n progress.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#AccountId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 12, - "max": 16 - }, - "smithy.api#pattern": "^\\d+$" - } - }, - "com.amazonaws.cloudtrail#AccountNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "AccountNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

This exception is thrown when the specified account is not found or not part of an\n organization.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.cloudtrail#AccountNotRegisteredException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "AccountNotRegistered", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This exception is thrown when the specified account is not registered as the CloudTrail delegated administrator.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#AccountRegisteredException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "AccountRegistered", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This exception is thrown when the account is already registered as the CloudTrail\n delegated administrator.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#AddTags": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#AddTagsRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#AddTagsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#ChannelARNInvalidException" - }, - { - "target": "com.amazonaws.cloudtrail#ChannelNotFoundException" - }, - { - "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" - }, - { - "target": "com.amazonaws.cloudtrail#ConflictException" - }, - { - "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" - }, - { - "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" - }, - { - "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" - }, - { - "target": "com.amazonaws.cloudtrail#InvalidTagParameterException" - }, - { - "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" - }, - { - "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" - }, - { - "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.cloudtrail#AccountHasOngoingImportException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AccountHasOngoingImport", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when you start a new import and a previous import is still in\n progress.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + "com.amazonaws.cloudtrail#AccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 16 + }, + "smithy.api#pattern": "^\\d+$" + } }, - { - "target": "com.amazonaws.cloudtrail#ResourceNotFoundException" + "com.amazonaws.cloudtrail#AccountNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AccountNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

This exception is thrown when the specified account is not found or not part of an\n organization.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } }, - { - "target": "com.amazonaws.cloudtrail#ResourceTypeNotSupportedException" + "com.amazonaws.cloudtrail#AccountNotRegisteredException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AccountNotRegistered", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the specified account is not registered as the CloudTrail delegated administrator.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#TagsLimitExceededException" + "com.amazonaws.cloudtrail#AccountRegisteredException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AccountRegistered", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the account is already registered as the CloudTrail\n delegated administrator.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Adds one or more tags to a trail, event data store, or channel, up to a limit of 50. Overwrites an\n existing tag's value when a new value is specified for an existing tag key. Tag key names\n must be unique; you cannot have two keys with the same name but different\n values. If you specify a key without a value, the tag will be created with the specified\n key and a value of null. You can tag a trail or event data store that applies to all\n Amazon Web Services Regions only from the Region in which the trail or event data store\n was created (also known as its home Region).

", - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.cloudtrail#AddTagsRequest": { - "type": "structure", - "members": { - "ResourceId": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the ARN of the trail, event data store, or channel to which one or more tags will be\n added.

\n

The format of a trail ARN is:\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

\n

The format of an event data store ARN is:\n arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE\n

\n

The format of a channel ARN is:\n arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890\n

", - "smithy.api#required": {} - } - }, - "TagsList": { - "target": "com.amazonaws.cloudtrail#TagsList", - "traits": { - "smithy.api#documentation": "

Contains a list of tags, up to a limit of 50

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the tags to add to a trail, event data store, or channel.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#AddTagsResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

Returns the objects or data if successful. Otherwise, returns an error.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#AdvancedEventSelector": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.cloudtrail#SelectorName", - "traits": { - "smithy.api#documentation": "

An optional, descriptive name for an advanced event selector, such as \"Log data events\n for only two S3 buckets\".

" - } - }, - "FieldSelectors": { - "target": "com.amazonaws.cloudtrail#AdvancedFieldSelectors", - "traits": { - "smithy.api#documentation": "

Contains all selector statements in an advanced event selector.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Advanced event selectors let you create fine-grained selectors for the following CloudTrail event record fields. They help you control costs by logging only those\n events that are important to you. For more information about advanced event selectors, see\n Logging data events in the CloudTrail User Guide.

\n \n

You cannot apply both event selectors and advanced event selectors to a trail.

" - } - }, - "com.amazonaws.cloudtrail#AdvancedEventSelectors": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudtrail#AdvancedEventSelector" - } - }, - "com.amazonaws.cloudtrail#AdvancedFieldSelector": { - "type": "structure", - "members": { - "Field": { - "target": "com.amazonaws.cloudtrail#SelectorField", - "traits": { - "smithy.api#documentation": "

A field in a CloudTrail event record on which to filter events to be logged. For\n event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, the field is used only for\n selecting events as filtering is not supported.

\n

For CloudTrail event records, supported fields include readOnly,\n eventCategory, eventSource (for management events),\n eventName, resources.type, and resources.ARN.

\n

For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, the only supported field is\n eventCategory.

\n ", - "smithy.api#required": {} - } - }, - "Equals": { - "target": "com.amazonaws.cloudtrail#Operator", - "traits": { - "smithy.api#documentation": "

An operator that includes events that match the exact value of the event record field\n specified as the value of Field. This is the only valid operator that you can\n use with the readOnly, eventCategory, and\n resources.type fields.

" - } - }, - "StartsWith": { - "target": "com.amazonaws.cloudtrail#Operator", - "traits": { - "smithy.api#documentation": "

An operator that includes events that match the first few characters of the event record\n field specified as the value of Field.

" - } - }, - "EndsWith": { - "target": "com.amazonaws.cloudtrail#Operator", - "traits": { - "smithy.api#documentation": "

An operator that includes events that match the last few characters of the event record\n field specified as the value of Field.

" - } - }, - "NotEquals": { - "target": "com.amazonaws.cloudtrail#Operator", - "traits": { - "smithy.api#documentation": "

An operator that excludes events that match the exact value of the event record field\n specified as the value of Field.

" - } - }, - "NotStartsWith": { - "target": "com.amazonaws.cloudtrail#Operator", - "traits": { - "smithy.api#documentation": "

An operator that excludes events that match the first few characters of the event\n record field specified as the value of Field.

" - } - }, - "NotEndsWith": { - "target": "com.amazonaws.cloudtrail#Operator", - "traits": { - "smithy.api#documentation": "

An operator that excludes events that match the last few characters of the event record\n field specified as the value of Field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A single selector statement in an advanced event selector.

" - } - }, - "com.amazonaws.cloudtrail#AdvancedFieldSelectors": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudtrail#AdvancedFieldSelector" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.cloudtrail#Boolean": { - "type": "boolean" - }, - "com.amazonaws.cloudtrail#ByteBuffer": { - "type": "blob" - }, - "com.amazonaws.cloudtrail#CancelQuery": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#CancelQueryRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#CancelQueryResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#ConflictException" + "com.amazonaws.cloudtrail#AddTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#AddTagsRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#AddTagsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#ChannelARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#ChannelNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#ConflictException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTagParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourceTypeNotSupportedException" + }, + { + "target": "com.amazonaws.cloudtrail#TagsLimitExceededException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds one or more tags to a trail, event data store, or channel, up to a limit of 50. Overwrites an\n existing tag's value when a new value is specified for an existing tag key. Tag key names\n must be unique; you cannot have two keys with the same name but different\n values. If you specify a key without a value, the tag will be created with the specified\n key and a value of null. You can tag a trail or event data store that applies to all\n Amazon Web Services Regions only from the Region in which the trail or event data store\n was created (also known as its home Region).

", + "smithy.api#idempotent": {} + } }, - { - "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + "com.amazonaws.cloudtrail#AddTagsRequest": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the ARN of the trail, event data store, or channel to which one or more tags will be\n added.

\n

The format of a trail ARN is:\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

\n

The format of an event data store ARN is:\n arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE\n

\n

The format of a channel ARN is:\n arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890\n

", + "smithy.api#required": {} + } + }, + "TagsList": { + "target": "com.amazonaws.cloudtrail#TagsList", + "traits": { + "smithy.api#documentation": "

Contains a list of tags, up to a limit of 50

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the tags to add to a trail, event data store, or channel.

", + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + "com.amazonaws.cloudtrail#AddTagsResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Returns the objects or data if successful. Otherwise, returns an error.

", + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + "com.amazonaws.cloudtrail#AdvancedEventSelector": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudtrail#SelectorName", + "traits": { + "smithy.api#documentation": "

An optional, descriptive name for an advanced event selector, such as \"Log data events\n for only two S3 buckets\".

" + } + }, + "FieldSelectors": { + "target": "com.amazonaws.cloudtrail#AdvancedFieldSelectors", + "traits": { + "smithy.api#documentation": "

Contains all selector statements in an advanced event selector.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Advanced event selectors let you create fine-grained selectors for the following CloudTrail event record fields. They help you control costs by logging only those\n events that are important to you. For more information about advanced event selectors, see\n Logging data events in the CloudTrail User Guide.

\n \n

You cannot apply both event selectors and advanced event selectors to a trail.

" + } }, - { - "target": "com.amazonaws.cloudtrail#InactiveQueryException" + "com.amazonaws.cloudtrail#AdvancedEventSelectors": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#AdvancedEventSelector" + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidParameterException" + "com.amazonaws.cloudtrail#AdvancedFieldSelector": { + "type": "structure", + "members": { + "Field": { + "target": "com.amazonaws.cloudtrail#SelectorField", + "traits": { + "smithy.api#documentation": "

A field in a CloudTrail event record on which to filter events to be logged. For\n event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, the field is used only for\n selecting events as filtering is not supported.

\n

For CloudTrail event records, supported fields include readOnly,\n eventCategory, eventSource (for management events),\n eventName, resources.type, and resources.ARN.

\n

For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, the only supported field is\n eventCategory.

\n ", + "smithy.api#required": {} + } + }, + "Equals": { + "target": "com.amazonaws.cloudtrail#Operator", + "traits": { + "smithy.api#documentation": "

An operator that includes events that match the exact value of the event record field\n specified as the value of Field. This is the only valid operator that you can\n use with the readOnly, eventCategory, and\n resources.type fields.

" + } + }, + "StartsWith": { + "target": "com.amazonaws.cloudtrail#Operator", + "traits": { + "smithy.api#documentation": "

An operator that includes events that match the first few characters of the event record\n field specified as the value of Field.

" + } + }, + "EndsWith": { + "target": "com.amazonaws.cloudtrail#Operator", + "traits": { + "smithy.api#documentation": "

An operator that includes events that match the last few characters of the event record\n field specified as the value of Field.

" + } + }, + "NotEquals": { + "target": "com.amazonaws.cloudtrail#Operator", + "traits": { + "smithy.api#documentation": "

An operator that excludes events that match the exact value of the event record field\n specified as the value of Field.

" + } + }, + "NotStartsWith": { + "target": "com.amazonaws.cloudtrail#Operator", + "traits": { + "smithy.api#documentation": "

An operator that excludes events that match the first few characters of the event\n record field specified as the value of Field.

" + } + }, + "NotEndsWith": { + "target": "com.amazonaws.cloudtrail#Operator", + "traits": { + "smithy.api#documentation": "

An operator that excludes events that match the last few characters of the event record\n field specified as the value of Field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A single selector statement in an advanced event selector.

" + } }, - { - "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + "com.amazonaws.cloudtrail#AdvancedFieldSelectors": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#AdvancedFieldSelector" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + "com.amazonaws.cloudtrail#Boolean": { + "type": "boolean" }, - { - "target": "com.amazonaws.cloudtrail#QueryIdNotFoundException" + "com.amazonaws.cloudtrail#ByteBuffer": { + "type": "blob" }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Cancels a query if the query is not in a terminated state, such as\n CANCELLED, FAILED, TIMED_OUT, or\n FINISHED. You must specify an ARN value for EventDataStore.\n The ID of the query that you want to cancel is also required. When you run\n CancelQuery, the query status might show as CANCELLED even if\n the operation is not yet finished.

", - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.cloudtrail#CancelQueryRequest": { - "type": "structure", - "members": { - "EventDataStore": { - "target": "com.amazonaws.cloudtrail#EventDataStoreArn", - "traits": { - "smithy.api#deprecated": { - "message": "EventDataStore is no longer required by CancelQueryRequest" - }, - "smithy.api#documentation": "

The ARN (or the ID suffix of the ARN) of an event data store on which the specified\n query is running.

" - } - }, - "QueryId": { - "target": "com.amazonaws.cloudtrail#UUID", - "traits": { - "smithy.api#documentation": "

The ID of the query that you want to cancel. The QueryId comes from the\n response of a StartQuery operation.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#CancelQueryResponse": { - "type": "structure", - "members": { - "QueryId": { - "target": "com.amazonaws.cloudtrail#UUID", - "traits": { - "smithy.api#documentation": "

The ID of the canceled query.

", - "smithy.api#required": {} - } - }, - "QueryStatus": { - "target": "com.amazonaws.cloudtrail#QueryStatus", - "traits": { - "smithy.api#documentation": "

Shows the status of a query after a CancelQuery request. Typically, the\n values shown are either RUNNING or CANCELLED.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#CannotDelegateManagementAccountException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "CannotDelegateManagementAccount", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This exception is thrown when the management account of an organization is registered as\n the CloudTrail delegated administrator.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#Channel": { - "type": "structure", - "members": { - "ChannelArn": { - "target": "com.amazonaws.cloudtrail#ChannelArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a channel.

" - } - }, - "Name": { - "target": "com.amazonaws.cloudtrail#ChannelName", - "traits": { - "smithy.api#documentation": "

The name of the CloudTrail channel. For service-linked channels, the name is\n aws-service-channel/service-name/custom-suffix where\n service-name represents the name of the Amazon Web Services service that\n created the channel and custom-suffix represents the suffix created by the\n Amazon Web Services service.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about a returned CloudTrail channel.

" - } - }, - "com.amazonaws.cloudtrail#ChannelARNInvalidException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ChannelARNInvalid", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This exception is thrown when the specified value of ChannelARN is not\n valid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#ChannelAlreadyExistsException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ChannelAlreadyExists", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

\n This exception is thrown when the provided channel already exists.\n

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#ChannelArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 256 - }, - "smithy.api#pattern": "^[a-zA-Z0-9._/\\-:]+$" - } - }, - "com.amazonaws.cloudtrail#ChannelExistsForEDSException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ChannelExistsForEDS", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This exception is thrown when the specified event data store cannot yet be deleted because it \n is in use by a channel.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#ChannelMaxLimitExceededException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ChannelMaxLimitExceeded", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

\n This exception is thrown when the maximum number of channels limit is exceeded.\n

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#ChannelName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 128 - }, - "smithy.api#pattern": "^[a-zA-Z0-9._\\-]+$" - } - }, - "com.amazonaws.cloudtrail#ChannelNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ChannelNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

This exception is thrown when CloudTrail cannot find the specified channel.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.cloudtrail#Channels": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudtrail#Channel" - } - }, - "com.amazonaws.cloudtrail#CloudTrailARNInvalidException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "CloudTrailARNInvalid", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This exception is thrown when an operation is called with a trail ARN that is not valid.\n The following is the format of a trail ARN.

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

\n

This exception is also thrown when you call AddTags or RemoveTags on a trail, event data store, or channel with a resource ARN that is not valid.

\n

The following is the format of an event data store ARN:\n arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE\n

\n

The following is the format of a channel ARN:\n arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890\n

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "CloudTrailAccessNotEnabled", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see Enabling Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your Organization.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#CloudTrailInvalidClientTokenIdException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "CloudTrailInvalidClientTokenId", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This exception is thrown when a call results in the InvalidClientTokenId\n error code. This can occur when you are creating or updating a trail to send notifications\n to an Amazon SNS topic that is in a suspended Amazon Web Services account.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#CloudTrail_20131101": { - "type": "service", - "version": "2013-11-01", - "operations": [ - { - "target": "com.amazonaws.cloudtrail#AddTags" + "com.amazonaws.cloudtrail#CancelQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#CancelQueryRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#CancelQueryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#ConflictException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveQueryException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#QueryIdNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Cancels a query if the query is not in a terminated state, such as\n CANCELLED, FAILED, TIMED_OUT, or\n FINISHED. You must specify an ARN value for EventDataStore.\n The ID of the query that you want to cancel is also required. When you run\n CancelQuery, the query status might show as CANCELLED even if\n the operation is not yet finished.

", + "smithy.api#idempotent": {} + } }, - { - "target": "com.amazonaws.cloudtrail#CancelQuery" + "com.amazonaws.cloudtrail#CancelQueryRequest": { + "type": "structure", + "members": { + "EventDataStore": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#deprecated": { + "message": "EventDataStore is no longer required by CancelQueryRequest" + }, + "smithy.api#documentation": "

The ARN (or the ID suffix of the ARN) of an event data store on which the specified\n query is running.

" + } + }, + "QueryId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The ID of the query that you want to cancel. The QueryId comes from the\n response of a StartQuery operation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#CreateChannel" + "com.amazonaws.cloudtrail#CancelQueryResponse": { + "type": "structure", + "members": { + "QueryId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The ID of the canceled query.

", + "smithy.api#required": {} + } + }, + "QueryStatus": { + "target": "com.amazonaws.cloudtrail#QueryStatus", + "traits": { + "smithy.api#documentation": "

Shows the status of a query after a CancelQuery request. Typically, the\n values shown are either RUNNING or CANCELLED.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#CreateEventDataStore" + "com.amazonaws.cloudtrail#CannotDelegateManagementAccountException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CannotDelegateManagementAccount", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the management account of an organization is registered as\n the CloudTrail delegated administrator.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#CreateTrail" + "com.amazonaws.cloudtrail#Channel": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.cloudtrail#ChannelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a channel.

" + } + }, + "Name": { + "target": "com.amazonaws.cloudtrail#ChannelName", + "traits": { + "smithy.api#documentation": "

The name of the CloudTrail channel. For service-linked channels, the name is\n aws-service-channel/service-name/custom-suffix where\n service-name represents the name of the Amazon Web Services service that\n created the channel and custom-suffix represents the suffix created by the\n Amazon Web Services service.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a returned CloudTrail channel.

" + } }, - { - "target": "com.amazonaws.cloudtrail#DeleteChannel" + "com.amazonaws.cloudtrail#ChannelARNInvalidException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ChannelARNInvalid", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the specified value of ChannelARN is not\n valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#DeleteEventDataStore" + "com.amazonaws.cloudtrail#ChannelAlreadyExistsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ChannelAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

\n This exception is thrown when the provided channel already exists.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#DeleteResourcePolicy" + "com.amazonaws.cloudtrail#ChannelArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._/\\-:]+$" + } }, - { - "target": "com.amazonaws.cloudtrail#DeleteTrail" + "com.amazonaws.cloudtrail#ChannelExistsForEDSException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ChannelExistsForEDS", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the specified event data store cannot yet be deleted because it \n is in use by a channel.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#DeregisterOrganizationDelegatedAdmin" + "com.amazonaws.cloudtrail#ChannelMaxLimitExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ChannelMaxLimitExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

\n This exception is thrown when the maximum number of channels limit is exceeded.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#DescribeQuery" + "com.amazonaws.cloudtrail#ChannelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._\\-]+$" + } }, - { - "target": "com.amazonaws.cloudtrail#DescribeTrails" + "com.amazonaws.cloudtrail#ChannelNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ChannelNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

This exception is thrown when CloudTrail cannot find the specified channel.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } }, - { - "target": "com.amazonaws.cloudtrail#GetChannel" + "com.amazonaws.cloudtrail#Channels": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#Channel" + } }, - { - "target": "com.amazonaws.cloudtrail#GetEventDataStore" + "com.amazonaws.cloudtrail#CloudTrailARNInvalidException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CloudTrailARNInvalid", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when an operation is called with a trail ARN that is not valid.\n The following is the format of a trail ARN.

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

\n

This exception is also thrown when you call AddTags or RemoveTags on a trail, event data store, or channel with a resource ARN that is not valid.

\n

The following is the format of an event data store ARN:\n arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE\n

\n

The following is the format of a channel ARN:\n arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#GetEventSelectors" + "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CloudTrailAccessNotEnabled", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see Enabling Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your Organization.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#GetImport" + "com.amazonaws.cloudtrail#CloudTrailInvalidClientTokenIdException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CloudTrailInvalidClientTokenId", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when a call results in the InvalidClientTokenId\n error code. This can occur when you are creating or updating a trail to send notifications\n to an Amazon SNS topic that is in a suspended Amazon Web Services account.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#GetInsightSelectors" - }, - { - "target": "com.amazonaws.cloudtrail#GetQueryResults" - }, - { - "target": "com.amazonaws.cloudtrail#GetResourcePolicy" - }, - { - "target": "com.amazonaws.cloudtrail#GetTrail" - }, - { - "target": "com.amazonaws.cloudtrail#GetTrailStatus" - }, - { - "target": "com.amazonaws.cloudtrail#ListChannels" - }, - { - "target": "com.amazonaws.cloudtrail#ListEventDataStores" - }, - { - "target": "com.amazonaws.cloudtrail#ListImportFailures" - }, - { - "target": "com.amazonaws.cloudtrail#ListImports" - }, - { - "target": "com.amazonaws.cloudtrail#ListPublicKeys" - }, - { - "target": "com.amazonaws.cloudtrail#ListQueries" - }, - { - "target": "com.amazonaws.cloudtrail#ListTags" - }, - { - "target": "com.amazonaws.cloudtrail#ListTrails" - }, - { - "target": "com.amazonaws.cloudtrail#LookupEvents" - }, - { - "target": "com.amazonaws.cloudtrail#PutEventSelectors" - }, - { - "target": "com.amazonaws.cloudtrail#PutInsightSelectors" - }, - { - "target": "com.amazonaws.cloudtrail#PutResourcePolicy" - }, - { - "target": "com.amazonaws.cloudtrail#RegisterOrganizationDelegatedAdmin" - }, - { - "target": "com.amazonaws.cloudtrail#RemoveTags" - }, - { - "target": "com.amazonaws.cloudtrail#RestoreEventDataStore" - }, - { - "target": "com.amazonaws.cloudtrail#StartEventDataStoreIngestion" - }, - { - "target": "com.amazonaws.cloudtrail#StartImport" - }, - { - "target": "com.amazonaws.cloudtrail#StartLogging" - }, - { - "target": "com.amazonaws.cloudtrail#StartQuery" - }, - { - "target": "com.amazonaws.cloudtrail#StopEventDataStoreIngestion" - }, - { - "target": "com.amazonaws.cloudtrail#StopImport" - }, - { - "target": "com.amazonaws.cloudtrail#StopLogging" - }, - { - "target": "com.amazonaws.cloudtrail#UpdateChannel" - }, - { - "target": "com.amazonaws.cloudtrail#UpdateEventDataStore" - }, - { - "target": "com.amazonaws.cloudtrail#UpdateTrail" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "CloudTrail", - "arnNamespace": "cloudtrail", - "cloudFormationName": "CloudTrail", - "cloudTrailEventSource": "cloudtrail.amazonaws.com", - "endpointPrefix": "cloudtrail" - }, - "aws.auth#sigv4": { - "name": "cloudtrail" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "CloudTrail\n

This is the CloudTrail API Reference. It provides descriptions of actions, data\n types, common parameters, and common errors for CloudTrail.

\n

CloudTrail is a web service that records Amazon Web Services API calls for your\n Amazon Web Services account and delivers log files to an Amazon S3 bucket. The\n recorded information includes the identity of the user, the start time of the Amazon Web Services API call, the source IP address, the request parameters, and the response\n elements returned by the service.

\n \n

As an alternative to the API, you can use one of the Amazon Web Services SDKs, which\n consist of libraries and sample code for various programming languages and platforms\n (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide programmatic access to CloudTrail. For example, the SDKs handle cryptographically signing requests,\n managing errors, and retrying requests automatically. For more information about the\n Amazon Web Services SDKs, including how to download and install them, see Tools to Build on Amazon Web Services.

\n \n

See the CloudTrail\n User Guide for information about the data that is included with each Amazon Web Services API call listed in the log files.

\n

\n Actions available for CloudTrail trails\n

\n

The following actions are available for CloudTrail trails.

\n \n

\n Actions available for CloudTrail event data stores\n

\n

The following actions are available for CloudTrail event data stores.

\n \n

\n Actions available for CloudTrail channels\n

\n

The following actions are available for CloudTrail channels.

\n \n

\n Actions available for managing delegated administrators\n

\n

The following actions are available for adding or a removing a delegated administrator to manage an Organizations organization’s CloudTrail resources.

\n ", - "smithy.api#title": "AWS CloudTrail", - "smithy.api#xmlNamespace": { - "uri": "http://cloudtrail.amazonaws.com/doc/2013-11-01/" - }, - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ + "com.amazonaws.cloudtrail#CloudTrail_20131101": { + "type": "service", + "version": "2013-11-01", + "operations": [ { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "type": "tree", - "rules": [ + "target": "com.amazonaws.cloudtrail#AddTags" + }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" + "target": "com.amazonaws.cloudtrail#CancelQuery" }, { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + "target": "com.amazonaws.cloudtrail#CreateChannel" + }, + { + "target": "com.amazonaws.cloudtrail#CreateEventDataStore" + }, + { + "target": "com.amazonaws.cloudtrail#CreateTrail" + }, + { + "target": "com.amazonaws.cloudtrail#DeleteChannel" + }, + { + "target": "com.amazonaws.cloudtrail#DeleteEventDataStore" + }, + { + "target": "com.amazonaws.cloudtrail#DeleteResourcePolicy" + }, + { + "target": "com.amazonaws.cloudtrail#DeleteTrail" + }, + { + "target": "com.amazonaws.cloudtrail#DeregisterOrganizationDelegatedAdmin" + }, + { + "target": "com.amazonaws.cloudtrail#DescribeQuery" + }, + { + "target": "com.amazonaws.cloudtrail#DescribeTrails" + }, + { + "target": "com.amazonaws.cloudtrail#GetChannel" + }, + { + "target": "com.amazonaws.cloudtrail#GetEventDataStore" + }, + { + "target": "com.amazonaws.cloudtrail#GetEventSelectors" + }, + { + "target": "com.amazonaws.cloudtrail#GetImport" + }, + { + "target": "com.amazonaws.cloudtrail#GetInsightSelectors" + }, + { + "target": "com.amazonaws.cloudtrail#GetQueryResults" + }, + { + "target": "com.amazonaws.cloudtrail#GetResourcePolicy" + }, + { + "target": "com.amazonaws.cloudtrail#GetTrail" + }, + { + "target": "com.amazonaws.cloudtrail#GetTrailStatus" + }, + { + "target": "com.amazonaws.cloudtrail#ListChannels" + }, + { + "target": "com.amazonaws.cloudtrail#ListEventDataStores" + }, + { + "target": "com.amazonaws.cloudtrail#ListImportFailures" + }, + { + "target": "com.amazonaws.cloudtrail#ListImports" + }, + { + "target": "com.amazonaws.cloudtrail#ListPublicKeys" + }, + { + "target": "com.amazonaws.cloudtrail#ListQueries" + }, + { + "target": "com.amazonaws.cloudtrail#ListTags" + }, + { + "target": "com.amazonaws.cloudtrail#ListTrails" + }, + { + "target": "com.amazonaws.cloudtrail#LookupEvents" + }, + { + "target": "com.amazonaws.cloudtrail#PutEventSelectors" + }, + { + "target": "com.amazonaws.cloudtrail#PutInsightSelectors" + }, + { + "target": "com.amazonaws.cloudtrail#PutResourcePolicy" + }, + { + "target": "com.amazonaws.cloudtrail#RegisterOrganizationDelegatedAdmin" + }, + { + "target": "com.amazonaws.cloudtrail#RemoveTags" + }, + { + "target": "com.amazonaws.cloudtrail#RestoreEventDataStore" + }, + { + "target": "com.amazonaws.cloudtrail#StartEventDataStoreIngestion" + }, + { + "target": "com.amazonaws.cloudtrail#StartImport" + }, + { + "target": "com.amazonaws.cloudtrail#StartLogging" + }, + { + "target": "com.amazonaws.cloudtrail#StartQuery" + }, + { + "target": "com.amazonaws.cloudtrail#StopEventDataStoreIngestion" + }, + { + "target": "com.amazonaws.cloudtrail#StopImport" + }, + { + "target": "com.amazonaws.cloudtrail#StopLogging" + }, + { + "target": "com.amazonaws.cloudtrail#UpdateChannel" + }, + { + "target": "com.amazonaws.cloudtrail#UpdateEventDataStore" + }, + { + "target": "com.amazonaws.cloudtrail#UpdateTrail" } - ] - }, - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" + ], + "traits": { + "aws.api#service": { + "sdkId": "CloudTrail", + "arnNamespace": "cloudtrail", + "cloudFormationName": "CloudTrail", + "cloudTrailEventSource": "cloudtrail.amazonaws.com", + "endpointPrefix": "cloudtrail" + }, + "aws.auth#sigv4": { + "name": "cloudtrail" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "CloudTrail\n

This is the CloudTrail API Reference. It provides descriptions of actions, data\n types, common parameters, and common errors for CloudTrail.

\n

CloudTrail is a web service that records Amazon Web Services API calls for your\n Amazon Web Services account and delivers log files to an Amazon S3 bucket. The\n recorded information includes the identity of the user, the start time of the Amazon Web Services API call, the source IP address, the request parameters, and the response\n elements returned by the service.

\n \n

As an alternative to the API, you can use one of the Amazon Web Services SDKs, which\n consist of libraries and sample code for various programming languages and platforms\n (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide programmatic access to CloudTrail. For example, the SDKs handle cryptographically signing requests,\n managing errors, and retrying requests automatically. For more information about the\n Amazon Web Services SDKs, including how to download and install them, see Tools to Build on Amazon Web Services.

\n \n

See the CloudTrail\n User Guide for information about the data that is included with each Amazon Web Services API call listed in the log files.

", + "smithy.api#title": "AWS CloudTrail", + "smithy.api#xmlNamespace": { + "uri": "http://cloudtrail.amazonaws.com/doc/2013-11-01/" + }, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" } - ], - "type": "tree", - "rules": [ + }, + "rules": [ { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ + "conditions": [ { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ + "conditions": [ { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" }, { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ + "conditions": [], + "type": "tree", + "rules": [ { - "ref": "PartitionResult" + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" }, - "supportsDualStack" - ] - } - ] + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] } - ], - "type": "tree", - "rules": [ + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://cloudtrail-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-gov-east-1" + ] + } + ], + "endpoint": { + "url": "https://cloudtrail.us-gov-east-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-gov-west-1" + ] + } + ], + "endpoint": { + "url": "https://cloudtrail.us-gov-west-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://cloudtrail-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://cloudtrail.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://cloudtrail.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + } + ] + }, { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://cloudtrail-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.af-south-1.amazonaws.com" } - ] }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": false } - ] }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.ap-east-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.ap-northeast-1.amazonaws.com" } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "ref": "Region" - }, - "us-gov-east-1" - ] - } - ], - "endpoint": { - "url": "https://cloudtrail.us-gov-east-1.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "ref": "Region" - }, - "us-gov-west-1" - ] - } - ], - "endpoint": { - "url": "https://cloudtrail.us-gov-west-1.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://cloudtrail-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.ap-northeast-2.amazonaws.com" } - ] }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false } - ] }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.ap-south-1.amazonaws.com" } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://cloudtrail.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.ap-southeast-1.amazonaws.com" } - ] }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false } - ] }, { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://cloudtrail.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false } - ] - } - ] - } - ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail.af-south-1.amazonaws.com" - } - }, - "params": { - "Region": "af-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail.ap-east-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail.ap-northeast-3.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail.ap-south-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail.ap-southeast-3.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail.eu-north-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail.eu-south-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail.eu-west-2.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail.eu-west-3.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail.me-south-1.amazonaws.com" - } - }, - "params": { - "Region": "me-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail.sa-east-1.amazonaws.com" - } - }, - "params": { - "Region": "sa-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail-fips.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail-fips.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail-fips.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail.cn-northwest-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-northwest-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.us-iso-west-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.cloudtrail#CloudWatchLogsDeliveryUnavailableException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } + "traits": { + "aws.protocols#awsQueryError": { + "code": "CloudWatchLogsDeliveryUnavailable", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Cannot set a CloudWatch Logs delivery for this Region.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } }, - { - "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail.us-iso-west-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-west-1", - "UseFIPS": false, - "UseDualStack": false - } + "traits": { + "aws.protocols#awsQueryError": { + "code": "ConflictException", + "httpResponseCode": 409 + }, + "smithy.api#documentation": "

This exception is thrown when the specified resource is not ready for an operation. This\n can occur when you try to run an operation on a resource before CloudTrail has time\n to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the\n operation again.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.cloudtrail#CreateChannel": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#CreateChannelRequest" }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } + "output": { + "target": "com.amazonaws.cloudtrail#CreateChannelResponse" }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } + "errors": [ + { + "target": "com.amazonaws.cloudtrail#ChannelAlreadyExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#ChannelMaxLimitExceededException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreCategoryException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidSourceException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTagParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#TagsLimitExceededException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a channel for CloudTrail to ingest events from a partner or external source. \n After you create a channel, a CloudTrail Lake event data store can log events \n from the partner or source that you specify.

" + } + }, + "com.amazonaws.cloudtrail#CreateChannelRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudtrail#ChannelName", + "traits": { + "smithy.api#documentation": "

The name of the channel.

", + "smithy.api#required": {} + } + }, + "Source": { + "target": "com.amazonaws.cloudtrail#Source", + "traits": { + "smithy.api#documentation": "

The name of the partner or external event source. You cannot change this name after you create the \n channel. A maximum of one channel is allowed per source.

\n

\n A source can be either Custom for all valid non-Amazon Web Services\n events, or the name of a partner event source. For information about the source names for available partners, see Additional information about integration partners in the CloudTrail User Guide.\n

", + "smithy.api#required": {} + } + }, + "Destinations": { + "target": "com.amazonaws.cloudtrail#Destinations", + "traits": { + "smithy.api#documentation": "

One or more event data stores to which events arriving through a channel will be logged.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.cloudtrail#TagsList" + } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#CreateChannelResponse": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.cloudtrail#ChannelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the new channel.

" + } + }, + "Name": { + "target": "com.amazonaws.cloudtrail#ChannelName", + "traits": { + "smithy.api#documentation": "

The name of the new channel.

" + } + }, + "Source": { + "target": "com.amazonaws.cloudtrail#Source", + "traits": { + "smithy.api#documentation": "

The partner or external event source name.

" + } + }, + "Destinations": { + "target": "com.amazonaws.cloudtrail#Destinations", + "traits": { + "smithy.api#documentation": "

The event data stores that log the events arriving through the channel.

" + } + }, + "Tags": { + "target": "com.amazonaws.cloudtrail#TagsList" + } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#CreateEventDataStore": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#CreateEventDataStoreRequest" }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } + "output": { + "target": "com.amazonaws.cloudtrail#CreateEventDataStoreResponse" }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudtrail-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } + "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException" + }, + { + "target": "com.amazonaws.cloudtrail#ConflictException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreAlreadyExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreMaxLimitExceededException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidEventSelectorsException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidKmsKeyIdException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTagParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#KmsException" + }, + { + "target": "com.amazonaws.cloudtrail#KmsKeyNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new event data store.

" + } + }, + "com.amazonaws.cloudtrail#CreateEventDataStoreRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudtrail#EventDataStoreName", + "traits": { + "smithy.api#documentation": "

The name of the event data store.

", + "smithy.api#required": {} + } + }, + "AdvancedEventSelectors": { + "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", + "traits": { + "smithy.api#documentation": "

The advanced event selectors to use to select the events for the data store. You can\n configure up to five advanced event selectors for each event data store.

\n

For more information about how to use advanced event selectors to log CloudTrail\n events, see Log events by using advanced event selectors in the CloudTrail User Guide.

\n

For more information about how to use advanced event selectors to include Config configuration items in your event data store, see Create an event data store for Config configuration\n items in the CloudTrail User Guide.

\n

For more information about how to use advanced event selectors to include non-Amazon Web Services events in your event data store, see Create an integration to log events from outside Amazon Web Services in the CloudTrail User Guide.

" + } + }, + "MultiRegionEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the event data store includes events from all Regions, or only from\n the Region in which the event data store is created.

" + } + }, + "OrganizationEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether an event data store collects events logged for an organization in\n Organizations.

" + } + }, + "RetentionPeriod": { + "target": "com.amazonaws.cloudtrail#RetentionPeriod", + "traits": { + "smithy.api#documentation": "

The retention period of the event data store, in days. You can set a retention period of\n up to 2557 days, the equivalent of seven years.

" + } + }, + "TerminationProtectionEnabled": { + "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", + "traits": { + "smithy.api#documentation": "

Specifies whether termination protection is enabled for the event data store. If\n termination protection is enabled, you cannot delete the event data store until termination\n protection is disabled.

" + } + }, + "TagsList": { + "target": "com.amazonaws.cloudtrail#TagsList" + }, + "KmsKeyId": { + "target": "com.amazonaws.cloudtrail#EventDataStoreKmsKeyId", + "traits": { + "smithy.api#documentation": "

Specifies the KMS key ID to use to encrypt the events delivered by\n CloudTrail. The value can be an alias name prefixed by alias/, a\n fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique\n identifier.

\n \n

Disabling or deleting the KMS key, or removing CloudTrail\n permissions on the key, prevents CloudTrail from logging events to the event data\n store, and prevents users from querying the data in the event data store that was\n encrypted with the key. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed. Before you\n disable or delete a KMS key that you are using with an event data store,\n delete or back up your event data store.

\n \n

CloudTrail also supports KMS multi-Region keys. For more\n information about multi-Region keys, see Using multi-Region\n keys in the Key Management Service Developer Guide.

\n

Examples:

\n " + } + }, + "StartIngestion": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the event data store should start ingesting live events. The default is true.

" + } + } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#CreateEventDataStoreResponse": { + "type": "structure", + "members": { + "EventDataStoreArn": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The ARN of the event data store.

" + } + }, + "Name": { + "target": "com.amazonaws.cloudtrail#EventDataStoreName", + "traits": { + "smithy.api#documentation": "

The name of the event data store.

" + } + }, + "Status": { + "target": "com.amazonaws.cloudtrail#EventDataStoreStatus", + "traits": { + "smithy.api#documentation": "

The status of event data store creation.

" + } + }, + "AdvancedEventSelectors": { + "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", + "traits": { + "smithy.api#documentation": "

The advanced event selectors that were used to select the events for the data\n store.

" + } + }, + "MultiRegionEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the event data store collects events from all Regions, or only from\n the Region in which it was created.

" + } + }, + "OrganizationEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether an event data store is collecting logged events for an organization in\n Organizations.

" + } + }, + "RetentionPeriod": { + "target": "com.amazonaws.cloudtrail#RetentionPeriod", + "traits": { + "smithy.api#documentation": "

The retention period of an event data store, in days.

" + } + }, + "TerminationProtectionEnabled": { + "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether termination protection is enabled for the event data store.

" + } + }, + "TagsList": { + "target": "com.amazonaws.cloudtrail#TagsList" + }, + "CreatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The timestamp that shows when the event data store was created.

" + } + }, + "UpdatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The timestamp that shows when an event data store was updated, if applicable.\n UpdatedTimestamp is always either the same or newer than the time shown in\n CreatedTimestamp.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.cloudtrail#EventDataStoreKmsKeyId", + "traits": { + "smithy.api#documentation": "

Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the\n following format.

\n

\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n

" + } + } }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#CreateTrail": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#CreateTrailRequest" }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } + "output": { + "target": "com.amazonaws.cloudtrail#CreateTrailResponse" }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } + "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException" + }, + { + "target": "com.amazonaws.cloudtrail#CloudTrailInvalidClientTokenIdException" + }, + { + "target": "com.amazonaws.cloudtrail#CloudWatchLogsDeliveryUnavailableException" + }, + { + "target": "com.amazonaws.cloudtrail#ConflictException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientS3BucketPolicyException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientSnsTopicPolicyException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidCloudWatchLogsLogGroupArnException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidCloudWatchLogsRoleArnException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidKmsKeyIdException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidS3BucketNameException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidS3PrefixException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidSnsTopicNameException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTagParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + }, + { + "target": "com.amazonaws.cloudtrail#KmsException" + }, + { + "target": "com.amazonaws.cloudtrail#KmsKeyDisabledException" + }, + { + "target": "com.amazonaws.cloudtrail#KmsKeyNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#MaximumNumberOfTrailsExceededException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException" + }, + { + "target": "com.amazonaws.cloudtrail#S3BucketDoesNotExistException" + }, + { + "target": "com.amazonaws.cloudtrail#TagsLimitExceededException" + }, + { + "target": "com.amazonaws.cloudtrail#TrailAlreadyExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#TrailNotProvidedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.\n

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#CreateTrailRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the trail. The name must meet the following requirements:

\n ", + "smithy.api#required": {} + } + }, + "S3BucketName": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the Amazon S3 bucket designated for publishing log files.\n See Amazon S3\n Bucket Naming Requirements.

", + "smithy.api#required": {} + } + }, + "S3KeyPrefix": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon S3 key prefix that comes after the name of the bucket you\n have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200\n characters.

" + } + }, + "SnsTopicName": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the Amazon SNS topic defined for notification of log file\n delivery. The maximum length is 256 characters.

" + } + }, + "IncludeGlobalServiceEvents": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the trail is publishing events from global services such as IAM to the\n log files.

" + } + }, + "IsMultiRegionTrail": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the trail is created in the current Region or in all Regions. The\n default is false, which creates a trail only in the Region where you are signed in. As a\n best practice, consider creating trails that log events in all Regions.

" + } + }, + "EnableLogFileValidation": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether log file integrity validation is enabled. The default is false.

\n \n

When you disable log file integrity validation, the chain of digest files is broken\n after one hour. CloudTrail does not create digest files for log files that were\n delivered during a period in which log file integrity validation was disabled. For\n example, if you enable log file integrity validation at noon on January 1, disable it at\n noon on January 2, and re-enable it at noon on January 10, digest files will not be\n created for the log files delivered from noon on January 2 to noon on January 10. The\n same applies whenever you stop CloudTrail logging or delete a trail.

\n " + } + }, + "CloudWatchLogsLogGroupArn": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that\n represents the log group to which CloudTrail logs will be delivered. You must use a\n log group that exists in your account.

\n

Not required unless you specify CloudWatchLogsRoleArn.

" + } + }, + "CloudWatchLogsRoleArn": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's\n log group. You must use a role that exists in your account.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#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\n specified ARN to an alias, a fully specified ARN to a key, or a globally unique\n identifier.

\n

CloudTrail also supports KMS multi-Region keys. For more\n information about multi-Region keys, see Using multi-Region\n keys in the Key Management Service Developer Guide.

\n

Examples:

\n " + } + }, + "IsOrganizationTrail": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the trail is created for all accounts in an organization in Organizations, or only for the current Amazon Web Services account. The default is false,\n and cannot be true unless the call is made on behalf of an Amazon Web Services account that\n is the management account or delegated administrator account for an organization in Organizations.

" + } + }, + "TagsList": { + "target": "com.amazonaws.cloudtrail#TagsList" + } }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } + "traits": { + "smithy.api#documentation": "

Specifies the settings for each trail.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#CreateTrailResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the trail.

" + } + }, + "S3BucketName": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the Amazon S3 bucket designated for publishing log\n files.

" + } + }, + "S3KeyPrefix": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon S3 key prefix that comes after the name of the bucket you\n have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files.

" + } + }, + "SnsTopicName": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

This field is no longer in use. Use SnsTopicARN.

" + } + }, + "SnsTopicARN": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send\n notifications when log files are delivered. The format of a topic ARN is:

\n

\n arn:aws:sns:us-east-2:123456789012:MyTopic\n

" + } + }, + "IncludeGlobalServiceEvents": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the trail is publishing events from global services such as IAM to the\n log files.

" + } + }, + "IsMultiRegionTrail": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the trail exists in one Region or in all Regions.

" + } + }, + "TrailARN": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the ARN of the trail that was created. The format of a trail ARN is:

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

" + } + }, + "LogFileValidationEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether log file integrity validation is enabled.

" + } + }, + "CloudWatchLogsLogGroupArn": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail\n logs will be delivered.

" + } + }, + "CloudWatchLogsRoleArn": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's\n log group.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the\n following format.

\n

\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n

" + } + }, + "IsOrganizationTrail": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the trail is an organization trail.

" + } + } }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } + "traits": { + "smithy.api#documentation": "

Returns the objects or data listed below if successful. Otherwise, returns an\n error.

", + "smithy.api#output": {} } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.cloudtrail#CloudWatchLogsDeliveryUnavailableException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "CloudWatchLogsDeliveryUnavailable", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

Cannot set a CloudWatch Logs delivery for this Region.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#ConflictException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ConflictException", - "httpResponseCode": 409 - }, - "smithy.api#documentation": "

This exception is thrown when the specified resource is not ready for an operation. This\n can occur when you try to run an operation on a resource before CloudTrail has time\n to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the\n operation again.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.cloudtrail#CreateChannel": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#CreateChannelRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#CreateChannelResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#ChannelAlreadyExistsException" - }, - { - "target": "com.amazonaws.cloudtrail#ChannelMaxLimitExceededException" - }, - { - "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" - }, - { - "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" - }, - { - "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" - }, - { - "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreCategoryException" - }, - { - "target": "com.amazonaws.cloudtrail#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudtrail#InvalidSourceException" - }, - { - "target": "com.amazonaws.cloudtrail#InvalidTagParameterException" - }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.cloudtrail#TagsLimitExceededException" - }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a channel for CloudTrail to ingest events from a partner or external source. \n After you create a channel, a CloudTrail Lake event data store can log events \n from the partner or source that you specify.

" - } - }, - "com.amazonaws.cloudtrail#CreateChannelRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.cloudtrail#ChannelName", - "traits": { - "smithy.api#documentation": "

The name of the channel.

", - "smithy.api#required": {} - } - }, - "Source": { - "target": "com.amazonaws.cloudtrail#Source", - "traits": { - "smithy.api#documentation": "

The name of the partner or external event source. You cannot change this name after you create the \n channel. A maximum of one channel is allowed per source.

\n

\n A source can be either Custom for all valid non-Amazon Web Services\n events, or the name of a partner event source. For information about the source names for available partners, see Additional information about integration partners in the CloudTrail User Guide.\n

", - "smithy.api#required": {} - } - }, - "Destinations": { - "target": "com.amazonaws.cloudtrail#Destinations", - "traits": { - "smithy.api#documentation": "

One or more event data stores to which events arriving through a channel will be logged.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.cloudtrail#TagsList" - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#CreateChannelResponse": { - "type": "structure", - "members": { - "ChannelArn": { - "target": "com.amazonaws.cloudtrail#ChannelArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the new channel.

" - } - }, - "Name": { - "target": "com.amazonaws.cloudtrail#ChannelName", - "traits": { - "smithy.api#documentation": "

The name of the new channel.

" - } - }, - "Source": { - "target": "com.amazonaws.cloudtrail#Source", - "traits": { - "smithy.api#documentation": "

The partner or external event source name.

" - } - }, - "Destinations": { - "target": "com.amazonaws.cloudtrail#Destinations", - "traits": { - "smithy.api#documentation": "

The event data stores that log the events arriving through the channel.

" - } - }, - "Tags": { - "target": "com.amazonaws.cloudtrail#TagsList" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#CreateEventDataStore": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#CreateEventDataStoreRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#CreateEventDataStoreResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException" - }, - { - "target": "com.amazonaws.cloudtrail#ConflictException" - }, - { - "target": "com.amazonaws.cloudtrail#EventDataStoreAlreadyExistsException" - }, - { - "target": "com.amazonaws.cloudtrail#EventDataStoreMaxLimitExceededException" }, - { - "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" - }, - { - "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" + "com.amazonaws.cloudtrail#DataResource": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The resource type in which you want to log data events. You can specify the following\n basic event selector resource types:

\n \n

The following resource types are also available through advanced\n event selectors. Basic event selector resource types are valid in advanced event selectors,\n but advanced event selector resource types are not valid in basic event selectors. For more\n information, see AdvancedFieldSelector.

\n " + } + }, + "Values": { + "target": "com.amazonaws.cloudtrail#DataResourceValues", + "traits": { + "smithy.api#documentation": "

An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified\n objects.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon S3 buckets, Lambda functions, or Amazon DynamoDB tables that you specify in your event selectors for your trail to log data events. Data\n events provide information about the resource operations performed on or within a resource\n itself. These are also known as data plane operations. You can specify up to 250 data\n resources for a trail.

\n \n

The total number of allowed data resources is 250. This number can be distributed\n between 1 and 5 event selectors, but the total cannot exceed 250 across all\n selectors for the trail.

\n

If you are using advanced event selectors, the maximum total number of values for\n all conditions, across all advanced event selectors for the trail, is 500.

\n \n

The following example demonstrates how logging works when you configure logging of all\n 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\n and Write data events.

\n
    \n
  1. \n

    A user uploads an image file to bucket-1.

    \n
    2. \n
  2. \n

    The PutObject API operation is an Amazon S3 object-level API.\n It is recorded as a data event in CloudTrail. Because the CloudTrail\n user specified an S3 bucket with an empty prefix, events that occur on any object in\n that bucket are logged. The trail processes and logs the event.

    \n
    3. \n
  3. \n

    A user uploads an object to an Amazon S3 bucket named\n arn:aws:s3:::bucket-2.

    \n
    4. \n
  4. \n

    The PutObject API operation occurred for an object in an S3 bucket\n that the CloudTrail user didn't specify for the trail. The trail doesn’t log\n the event.

    \n
    5. \n
\n

The following example demonstrates how logging works when you configure logging of\n Lambda data events for a Lambda function named\n MyLambdaFunction, but not for all Lambda\n functions.

\n
    \n
  1. \n

    A user runs a script that includes a call to the\n MyLambdaFunction function and the\n MyOtherLambdaFunction function.

    \n
    2. \n
  2. \n

    The Invoke API operation on MyLambdaFunction is\n an Lambda API. It is recorded as a data event in CloudTrail.\n Because the CloudTrail user specified logging data events for\n MyLambdaFunction, any invocations of that function are\n logged. The trail processes and logs the event.

    \n
    3. \n
  3. \n

    The Invoke API operation on\n MyOtherLambdaFunction is an Lambda API. Because\n the CloudTrail user did not specify logging data events for all Lambda functions, the Invoke operation for\n MyOtherLambdaFunction does not match the function specified\n for the trail. The trail doesn’t log the event.

    \n
    4. \n
" + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidEventSelectorsException" + "com.amazonaws.cloudtrail#DataResourceValues": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#String" + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidKmsKeyIdException" + "com.amazonaws.cloudtrail#DataResources": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#DataResource" + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidParameterException" + "com.amazonaws.cloudtrail#Date": { + "type": "timestamp" }, - { - "target": "com.amazonaws.cloudtrail#InvalidTagParameterException" + "com.amazonaws.cloudtrail#DelegatedAdminAccountLimitExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DelegatedAdminAccountLimitExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the maximum number of CloudTrail delegated\n administrators is reached.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#KmsException" + "com.amazonaws.cloudtrail#DeleteChannel": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#DeleteChannelRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#DeleteChannelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#ChannelARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#ChannelNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a channel.

" + } }, - { - "target": "com.amazonaws.cloudtrail#KmsKeyNotFoundException" + "com.amazonaws.cloudtrail#DeleteChannelRequest": { + "type": "structure", + "members": { + "Channel": { + "target": "com.amazonaws.cloudtrail#ChannelArn", + "traits": { + "smithy.api#documentation": "

The ARN or the UUID value of the channel that you want to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + "com.amazonaws.cloudtrail#DeleteChannelResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + "com.amazonaws.cloudtrail#DeleteEventDataStore": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#DeleteEventDataStoreRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#DeleteEventDataStoreResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#ChannelExistsForEDSException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreHasOngoingImportException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreTerminationProtectedException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Disables the event data store specified by EventDataStore, which accepts an\n event data store ARN. After you run DeleteEventDataStore, the event data store\n enters a PENDING_DELETION state, and is automatically deleted after a wait\n period of seven days. TerminationProtectionEnabled must be set to\n False on the event data store; this operation cannot work if\n TerminationProtectionEnabled is True.

\n

After you run DeleteEventDataStore on an event data store, you cannot run\n ListQueries, DescribeQuery, or GetQueryResults on\n queries that are using an event data store in a PENDING_DELETION state. An\n event data store in the PENDING_DELETION state does not incur costs.

" + } }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + "com.amazonaws.cloudtrail#DeleteEventDataStoreRequest": { + "type": "structure", + "members": { + "EventDataStore": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The ARN (or the ID suffix of the ARN) of the event data store to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException" + "com.amazonaws.cloudtrail#DeleteEventDataStoreResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException" + "com.amazonaws.cloudtrail#DeleteResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#DeleteResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#DeleteResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourceARNNotValidException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourcePolicyNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourceTypeNotSupportedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Deletes the resource-based policy attached to the CloudTrail channel.\n

", + "smithy.api#idempotent": {} + } }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new event data store.

" - } - }, - "com.amazonaws.cloudtrail#CreateEventDataStoreRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.cloudtrail#EventDataStoreName", - "traits": { - "smithy.api#documentation": "

The name of the event data store.

", - "smithy.api#required": {} - } - }, - "AdvancedEventSelectors": { - "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", - "traits": { - "smithy.api#documentation": "

The advanced event selectors to use to select the events for the data store. You can\n configure up to five advanced event selectors for each event data store.

\n

For more information about how to use advanced event selectors to log CloudTrail\n events, see Log events by using advanced event selectors in the CloudTrail User Guide.

\n

For more information about how to use advanced event selectors to include Config configuration items in your event data store, see Create an event data store for Config configuration\n items in the CloudTrail User Guide.

\n

For more information about how to use advanced event selectors to include non-Amazon Web Services events in your event data store, see Create an integration to log events from outside Amazon Web Services in the CloudTrail User Guide.

" - } - }, - "MultiRegionEnabled": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether the event data store includes events from all Regions, or only from\n the Region in which the event data store is created.

" - } - }, - "OrganizationEnabled": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether an event data store collects events logged for an organization in\n Organizations.

" - } - }, - "RetentionPeriod": { - "target": "com.amazonaws.cloudtrail#RetentionPeriod", - "traits": { - "smithy.api#documentation": "

The retention period of the event data store, in days. You can set a retention period of\n up to 2557 days, the equivalent of seven years.

" - } - }, - "TerminationProtectionEnabled": { - "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", - "traits": { - "smithy.api#documentation": "

Specifies whether termination protection is enabled for the event data store. If\n termination protection is enabled, you cannot delete the event data store until termination\n protection is disabled.

" - } - }, - "TagsList": { - "target": "com.amazonaws.cloudtrail#TagsList" - }, - "KmsKeyId": { - "target": "com.amazonaws.cloudtrail#EventDataStoreKmsKeyId", - "traits": { - "smithy.api#documentation": "

Specifies the KMS key ID to use to encrypt the events delivered by\n CloudTrail. The value can be an alias name prefixed by alias/, a\n fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique\n identifier.

\n \n

Disabling or deleting the KMS key, or removing CloudTrail\n permissions on the key, prevents CloudTrail from logging events to the event data\n store, and prevents users from querying the data in the event data store that was\n encrypted with the key. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed. Before you\n disable or delete a KMS key that you are using with an event data store,\n delete or back up your event data store.

\n \n

CloudTrail also supports KMS multi-Region keys. For more\n information about multi-Region keys, see Using multi-Region\n keys in the Key Management Service Developer Guide.

\n

Examples:

\n " - } - }, - "StartIngestion": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether the event data store should start ingesting live events. The default is true.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#CreateEventDataStoreResponse": { - "type": "structure", - "members": { - "EventDataStoreArn": { - "target": "com.amazonaws.cloudtrail#EventDataStoreArn", - "traits": { - "smithy.api#documentation": "

The ARN of the event data store.

" - } - }, - "Name": { - "target": "com.amazonaws.cloudtrail#EventDataStoreName", - "traits": { - "smithy.api#documentation": "

The name of the event data store.

" - } - }, - "Status": { - "target": "com.amazonaws.cloudtrail#EventDataStoreStatus", - "traits": { - "smithy.api#documentation": "

The status of event data store creation.

" - } - }, - "AdvancedEventSelectors": { - "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", - "traits": { - "smithy.api#documentation": "

The advanced event selectors that were used to select the events for the data\n store.

" - } - }, - "MultiRegionEnabled": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether the event data store collects events from all Regions, or only from\n the Region in which it was created.

" - } - }, - "OrganizationEnabled": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether an event data store is collecting logged events for an organization in\n Organizations.

" - } - }, - "RetentionPeriod": { - "target": "com.amazonaws.cloudtrail#RetentionPeriod", - "traits": { - "smithy.api#documentation": "

The retention period of an event data store, in days.

" - } - }, - "TerminationProtectionEnabled": { - "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", - "traits": { - "smithy.api#documentation": "

Indicates whether termination protection is enabled for the event data store.

" - } - }, - "TagsList": { - "target": "com.amazonaws.cloudtrail#TagsList" - }, - "CreatedTimestamp": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

The timestamp that shows when the event data store was created.

" - } - }, - "UpdatedTimestamp": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

The timestamp that shows when an event data store was updated, if applicable.\n UpdatedTimestamp is always either the same or newer than the time shown in\n CreatedTimestamp.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.cloudtrail#EventDataStoreKmsKeyId", - "traits": { - "smithy.api#documentation": "

Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the\n following format.

\n

\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#CreateTrail": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#CreateTrailRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#CreateTrailResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException" + "com.amazonaws.cloudtrail#DeleteResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.cloudtrail#ResourceArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the CloudTrail channel you're deleting the resource-based policy from. \n The following is the format of a resource ARN: \n arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#CloudTrailInvalidClientTokenIdException" + "com.amazonaws.cloudtrail#DeleteResourcePolicyResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#CloudWatchLogsDeliveryUnavailableException" + "com.amazonaws.cloudtrail#DeleteTrail": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#DeleteTrailRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#DeleteTrailResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#ConflictException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidHomeRegionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#TrailNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a trail. This operation must be called from the Region in which the trail was\n created. DeleteTrail cannot be called on the shadow trails (replicated trails\n in other Regions) of a trail that is enabled in all Regions.

", + "smithy.api#idempotent": {} + } }, - { - "target": "com.amazonaws.cloudtrail#ConflictException" + "com.amazonaws.cloudtrail#DeleteTrailRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the name or the CloudTrail ARN of the trail to be deleted. The\n following is the format of a trail ARN.\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request that specifies the name of a trail to delete.

", + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + "com.amazonaws.cloudtrail#DeleteTrailResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Returns the objects or data listed below if successful. Otherwise, returns an\n error.

", + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" + "com.amazonaws.cloudtrail#DeliveryS3Uri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?$" + } }, - { - "target": "com.amazonaws.cloudtrail#InsufficientS3BucketPolicyException" + "com.amazonaws.cloudtrail#DeliveryStatus": { + "type": "enum", + "members": { + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "FAILED_SIGNING_FILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED_SIGNING_FILE" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "RESOURCE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE_NOT_FOUND" + } + }, + "ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCESS_DENIED" + } + }, + "ACCESS_DENIED_SIGNING_FILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCESS_DENIED_SIGNING_FILE" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + }, + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNKNOWN" + } + } + } }, - { - "target": "com.amazonaws.cloudtrail#InsufficientSnsTopicPolicyException" + "com.amazonaws.cloudtrail#DeregisterOrganizationDelegatedAdmin": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#DeregisterOrganizationDelegatedAdminRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#DeregisterOrganizationDelegatedAdminResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#AccountNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#AccountNotRegisteredException" + }, + { + "target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException" + }, + { + "target": "com.amazonaws.cloudtrail#ConflictException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationManagementAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes CloudTrail delegated administrator permissions from a member account in\n an organization.

", + "smithy.api#idempotent": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidCloudWatchLogsLogGroupArnException" + "com.amazonaws.cloudtrail#DeregisterOrganizationDelegatedAdminRequest": { + "type": "structure", + "members": { + "DelegatedAdminAccountId": { + "target": "com.amazonaws.cloudtrail#AccountId", + "traits": { + "smithy.api#documentation": "

A delegated administrator account ID. This is a member account in an organization that\n is currently designated as a delegated administrator.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Removes CloudTrail delegated administrator permissions from a specified member\n account in an organization that is currently designated as a delegated\n administrator.

", + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidCloudWatchLogsRoleArnException" + "com.amazonaws.cloudtrail#DeregisterOrganizationDelegatedAdminResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Returns the following response if successful. Otherwise, returns an error.

", + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidKmsKeyIdException" + "com.amazonaws.cloudtrail#DescribeQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#DescribeQueryRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#DescribeQueryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#QueryIdNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns metadata about a query, including query run time in milliseconds, number of\n events scanned and matched, and query status. If the query results were delivered to an S3 bucket, \n the response also provides the S3 URI and the delivery status.

\n

You must specify either a QueryID or a QueryAlias. Specifying\n the QueryAlias parameter returns information about the last query run for the\n alias.

", + "smithy.api#idempotent": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidParameterCombinationException" + "com.amazonaws.cloudtrail#DescribeQueryRequest": { + "type": "structure", + "members": { + "EventDataStore": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#deprecated": { + "message": "EventDataStore is no longer required by DescribeQueryRequest" + }, + "smithy.api#documentation": "

The ARN (or the ID suffix of the ARN) of an event data store on which the specified\n query was run.

" + } + }, + "QueryId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The query ID.

" + } + }, + "QueryAlias": { + "target": "com.amazonaws.cloudtrail#QueryAlias", + "traits": { + "smithy.api#documentation": "

\n The alias that identifies a query template.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidS3BucketNameException" + "com.amazonaws.cloudtrail#DescribeQueryResponse": { + "type": "structure", + "members": { + "QueryId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The ID of the query.

" + } + }, + "QueryString": { + "target": "com.amazonaws.cloudtrail#QueryStatement", + "traits": { + "smithy.api#documentation": "

The SQL code of a query.

" + } + }, + "QueryStatus": { + "target": "com.amazonaws.cloudtrail#QueryStatus", + "traits": { + "smithy.api#documentation": "

The status of a query. Values for QueryStatus include QUEUED,\n RUNNING, FINISHED, FAILED,\n TIMED_OUT, or CANCELLED\n

" + } + }, + "QueryStatistics": { + "target": "com.amazonaws.cloudtrail#QueryStatisticsForDescribeQuery", + "traits": { + "smithy.api#documentation": "

Metadata about a query, including the number of events that were matched, the total\n number of events scanned, the query run time in milliseconds, and the query's creation\n time.

" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The error message returned if a query failed.

" + } + }, + "DeliveryS3Uri": { + "target": "com.amazonaws.cloudtrail#DeliveryS3Uri", + "traits": { + "smithy.api#documentation": "

The URI for the S3 bucket where CloudTrail delivered query results, if\n applicable.

" + } + }, + "DeliveryStatus": { + "target": "com.amazonaws.cloudtrail#DeliveryStatus", + "traits": { + "smithy.api#documentation": "

The delivery status.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidS3PrefixException" + "com.amazonaws.cloudtrail#DescribeTrails": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#DescribeTrailsRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#DescribeTrailsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves settings for one or more trails associated with the current Region for your\n account.

", + "smithy.api#idempotent": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidSnsTopicNameException" + "com.amazonaws.cloudtrail#DescribeTrailsRequest": { + "type": "structure", + "members": { + "trailNameList": { + "target": "com.amazonaws.cloudtrail#TrailNameList", + "traits": { + "smithy.api#documentation": "

Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The\n format of a trail ARN is:

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

\n

If an empty list is specified, information for the trail in the current Region is\n returned.

\n \n \n

If one or more trail names are specified, information is returned only if the names\n match the names of trails belonging only to the current Region and current account. To\n return information about a trail in another Region, you must specify its trail\n ARN.

\n " + } + }, + "includeShadowTrails": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to include shadow trails in the response. A shadow trail is the\n replication in a Region of a trail that was created in a different Region, or in the case\n of an organization trail, the replication of an organization trail in member accounts. If\n you do not include shadow trails, organization trails in a member account and Region\n replication trails will not be returned. The default is true.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Returns information about the trail.

", + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidTagParameterException" + "com.amazonaws.cloudtrail#DescribeTrailsResponse": { + "type": "structure", + "members": { + "trailList": { + "target": "com.amazonaws.cloudtrail#TrailList", + "traits": { + "smithy.api#documentation": "

The list of trail objects. Trail objects with string values are only returned if values\n for the objects exist in a trail's configuration. For example, SNSTopicName\n and SNSTopicARN are only returned in results if a trail is configured to send\n SNS notifications. Similarly, KMSKeyId only appears in results if a trail's\n log files are encrypted with KMS\n customer managed keys.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Returns the objects or data listed below if successful. Otherwise, returns an\n error.

", + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + "com.amazonaws.cloudtrail#Destination": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.cloudtrail#DestinationType", + "traits": { + "smithy.api#documentation": "

The type of destination for events arriving from a channel. For channels used for a CloudTrail Lake integration, the value is EventDataStore. For service-linked channels, \n the value is AWS_SERVICE.

", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.cloudtrail#Location", + "traits": { + "smithy.api#documentation": "

For channels used for a CloudTrail Lake integration, the location is the ARN of an event data store that receives events from a channel. \n For service-linked channels, the location is the name of the Amazon Web Services service.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the destination receiving events.

" + } }, - { - "target": "com.amazonaws.cloudtrail#KmsException" + "com.amazonaws.cloudtrail#DestinationType": { + "type": "enum", + "members": { + "EVENT_DATA_STORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EVENT_DATA_STORE" + } + }, + "AWS_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_SERVICE" + } + } + } }, - { - "target": "com.amazonaws.cloudtrail#KmsKeyDisabledException" + "com.amazonaws.cloudtrail#Destinations": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#Destination" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } }, - { - "target": "com.amazonaws.cloudtrail#KmsKeyNotFoundException" + "com.amazonaws.cloudtrail#ErrorMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 1000 + }, + "smithy.api#pattern": ".*" + } }, - { - "target": "com.amazonaws.cloudtrail#MaximumNumberOfTrailsExceededException" + "com.amazonaws.cloudtrail#Event": { + "type": "structure", + "members": { + "EventId": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The CloudTrail ID of the event returned.

" + } + }, + "EventName": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The name of the event returned.

" + } + }, + "ReadOnly": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Information about whether the event is a write event or a read event.

" + } + }, + "AccessKeyId": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services access key ID that was used to sign the request. If the request\n was made with temporary security credentials, this is the access key ID of the temporary\n credentials.

" + } + }, + "EventTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The date and time of the event returned.

" + } + }, + "EventSource": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services service to which the request was made.

" + } + }, + "Username": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

A user name or role name of the requester that called the API in the event\n returned.

" + } + }, + "Resources": { + "target": "com.amazonaws.cloudtrail#ResourceList", + "traits": { + "smithy.api#documentation": "

A list of resources referenced by the event returned.

" + } + }, + "CloudTrailEvent": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

A JSON string that contains a representation of the event returned.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an event that was returned by a lookup request. The result\n includes a representation of a CloudTrail event.

" + } }, - { - "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + "com.amazonaws.cloudtrail#EventCategory": { + "type": "enum", + "members": { + "Insight": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "insight" + } + } + } }, - { - "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + "com.amazonaws.cloudtrail#EventDataStore": { + "type": "structure", + "members": { + "EventDataStoreArn": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The ARN of the event data store.

" + } + }, + "Name": { + "target": "com.amazonaws.cloudtrail#EventDataStoreName", + "traits": { + "smithy.api#documentation": "

The name of the event data store.

" + } + }, + "TerminationProtectionEnabled": { + "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", + "traits": { + "smithy.api#deprecated": { + "message": "TerminationProtectionEnabled is no longer returned by ListEventDataStores" + }, + "smithy.api#documentation": "

Indicates whether the event data store is protected from\n termination.

" + } + }, + "Status": { + "target": "com.amazonaws.cloudtrail#EventDataStoreStatus", + "traits": { + "smithy.api#deprecated": { + "message": "Status is no longer returned by ListEventDataStores" + }, + "smithy.api#documentation": "

The status of an event data store.

" + } + }, + "AdvancedEventSelectors": { + "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", + "traits": { + "smithy.api#deprecated": { + "message": "AdvancedEventSelectors is no longer returned by ListEventDataStores" + }, + "smithy.api#documentation": "

The advanced event selectors that were used to select\n events for the data store.

" + } + }, + "MultiRegionEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#deprecated": { + "message": "MultiRegionEnabled is no longer returned by ListEventDataStores" + }, + "smithy.api#documentation": "

Indicates whether the event data store includes events\n from all Regions, or only from the Region in which it was created.

" + } + }, + "OrganizationEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#deprecated": { + "message": "OrganizationEnabled is no longer returned by ListEventDataStores" + }, + "smithy.api#documentation": "

Indicates that an event data store is collecting logged\n events for an organization.

" + } + }, + "RetentionPeriod": { + "target": "com.amazonaws.cloudtrail#RetentionPeriod", + "traits": { + "smithy.api#deprecated": { + "message": "RetentionPeriod is no longer returned by ListEventDataStores" + }, + "smithy.api#documentation": "

The retention period, in days.

" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#deprecated": { + "message": "CreatedTimestamp is no longer returned by ListEventDataStores" + }, + "smithy.api#documentation": "

The timestamp of the event data store's creation.

" + } + }, + "UpdatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#deprecated": { + "message": "UpdatedTimestamp is no longer returned by ListEventDataStores" + }, + "smithy.api#documentation": "

The timestamp showing when an event data store was\n updated, if applicable. UpdatedTimestamp is always either the same or newer\n than the time shown in CreatedTimestamp.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A storage lake of event data against which you can run complex SQL-based queries. An\n event data store can include events that you have logged on your account from the last 90\n to 2557 days (about three months to up to seven years). To select events for an event data\n store, use advanced event selectors.

" + } }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "EventDataStoreARNInvalid", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified event data store ARN is not valid or does not map to an event data store\n in your account.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException" + "com.amazonaws.cloudtrail#EventDataStoreAlreadyExistsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "EventDataStoreAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

An event data store with that name already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException" + "com.amazonaws.cloudtrail#EventDataStoreArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._/\\-:]+$" + } }, - { - "target": "com.amazonaws.cloudtrail#S3BucketDoesNotExistException" + "com.amazonaws.cloudtrail#EventDataStoreHasOngoingImportException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "EventDataStoreHasOngoingImport", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when you try to update or delete an event data store that\n currently has an import in progress.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#TagsLimitExceededException" + "com.amazonaws.cloudtrail#EventDataStoreKmsKeyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 350 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._/\\-:]+$" + } }, - { - "target": "com.amazonaws.cloudtrail#TrailAlreadyExistsException" + "com.amazonaws.cloudtrail#EventDataStoreMaxLimitExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "EventDataStoreMaxLimitExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Your account has used the maximum number of event data stores.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#TrailNotProvidedException" + "com.amazonaws.cloudtrail#EventDataStoreName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._\\-]+$" + } }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.\n

", - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.cloudtrail#CreateTrailRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the trail. The name must meet the following requirements:

\n ", - "smithy.api#required": {} - } - }, - "S3BucketName": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the Amazon S3 bucket designated for publishing log files.\n See Amazon S3\n Bucket Naming Requirements.

", - "smithy.api#required": {} - } - }, - "S3KeyPrefix": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the Amazon S3 key prefix that comes after the name of the bucket you\n have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200\n characters.

" - } - }, - "SnsTopicName": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the Amazon SNS topic defined for notification of log file\n delivery. The maximum length is 256 characters.

" - } - }, - "IncludeGlobalServiceEvents": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether the trail is publishing events from global services such as IAM to the\n log files.

" - } - }, - "IsMultiRegionTrail": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether the trail is created in the current Region or in all Regions. The\n default is false, which creates a trail only in the Region where you are signed in. As a\n best practice, consider creating trails that log events in all Regions.

" - } - }, - "EnableLogFileValidation": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether log file integrity validation is enabled. The default is false.

\n \n

When you disable log file integrity validation, the chain of digest files is broken\n after one hour. CloudTrail does not create digest files for log files that were\n delivered during a period in which log file integrity validation was disabled. For\n example, if you enable log file integrity validation at noon on January 1, disable it at\n noon on January 2, and re-enable it at noon on January 10, digest files will not be\n created for the log files delivered from noon on January 2 to noon on January 10. The\n same applies whenever you stop CloudTrail logging or delete a trail.

\n " - } - }, - "CloudWatchLogsLogGroupArn": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that\n represents the log group to which CloudTrail logs will be delivered. You must use a\n log group that exists in your account.

\n

Not required unless you specify CloudWatchLogsRoleArn.

" - } - }, - "CloudWatchLogsRoleArn": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's\n log group. You must use a role that exists in your account.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#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\n specified ARN to an alias, a fully specified ARN to a key, or a globally unique\n identifier.

\n

CloudTrail also supports KMS multi-Region keys. For more\n information about multi-Region keys, see Using multi-Region\n keys in the Key Management Service Developer Guide.

\n

Examples:

\n " - } - }, - "IsOrganizationTrail": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether the trail is created for all accounts in an organization in Organizations, or only for the current Amazon Web Services account. The default is false,\n and cannot be true unless the call is made on behalf of an Amazon Web Services account that\n is the management account or delegated administrator account for an organization in Organizations.

" - } - }, - "TagsList": { - "target": "com.amazonaws.cloudtrail#TagsList" - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the settings for each trail.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#CreateTrailResponse": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the trail.

" - } - }, - "S3BucketName": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the Amazon S3 bucket designated for publishing log\n files.

" - } - }, - "S3KeyPrefix": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the Amazon S3 key prefix that comes after the name of the bucket you\n have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files.

" - } - }, - "SnsTopicName": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

This field is no longer in use. Use SnsTopicARN.

" - } - }, - "SnsTopicARN": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send\n notifications when log files are delivered. The format of a topic ARN is:

\n

\n arn:aws:sns:us-east-2:123456789012:MyTopic\n

" - } - }, - "IncludeGlobalServiceEvents": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether the trail is publishing events from global services such as IAM to the\n log files.

" - } - }, - "IsMultiRegionTrail": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether the trail exists in one Region or in all Regions.

" - } - }, - "TrailARN": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the ARN of the trail that was created. The format of a trail ARN is:

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

" - } - }, - "LogFileValidationEnabled": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether log file integrity validation is enabled.

" - } - }, - "CloudWatchLogsLogGroupArn": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail\n logs will be delivered.

" - } - }, - "CloudWatchLogsRoleArn": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's\n log group.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the\n following format.

\n

\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n

" - } - }, - "IsOrganizationTrail": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether the trail is an organization trail.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Returns the objects or data listed below if successful. Otherwise, returns an\n error.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#DataResource": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

The resource type in which you want to log data events. You can specify the following\n basic event selector resource types:

\n \n

The following resource types are also available through advanced\n event selectors. Basic event selector resource types are valid in advanced event selectors,\n but advanced event selector resource types are not valid in basic event selectors. For more\n information, see AdvancedFieldSelector$Field.

\n " - } - }, - "Values": { - "target": "com.amazonaws.cloudtrail#DataResourceValues", - "traits": { - "smithy.api#documentation": "

An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified\n objects.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

The Amazon S3 buckets, Lambda functions, or Amazon DynamoDB tables that you specify in your event selectors for your trail to log data events. Data\n events provide information about the resource operations performed on or within a resource\n itself. These are also known as data plane operations. You can specify up to 250 data\n resources for a trail.

\n \n

The total number of allowed data resources is 250. This number can be distributed\n between 1 and 5 event selectors, but the total cannot exceed 250 across all\n selectors for the trail.

\n

If you are using advanced event selectors, the maximum total number of values for\n all conditions, across all advanced event selectors for the trail, is 500.

\n \n

The following example demonstrates how logging works when you configure logging of all\n 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\n and Write data events.

\n
    \n
  1. \n

    A user uploads an image file to bucket-1.

    \n
    2. \n
  2. \n

    The PutObject API operation is an Amazon S3 object-level API.\n It is recorded as a data event in CloudTrail. Because the CloudTrail\n user specified an S3 bucket with an empty prefix, events that occur on any object in\n that bucket are logged. The trail processes and logs the event.

    \n
    3. \n
  3. \n

    A user uploads an object to an Amazon S3 bucket named\n arn:aws:s3:::bucket-2.

    \n
    4. \n
  4. \n

    The PutObject API operation occurred for an object in an S3 bucket\n that the CloudTrail user didn't specify for the trail. The trail doesn’t log\n the event.

    \n
    5. \n
\n

The following example demonstrates how logging works when you configure logging of\n Lambda data events for a Lambda function named\n MyLambdaFunction, but not for all Lambda\n functions.

\n
    \n
  1. \n

    A user runs a script that includes a call to the\n MyLambdaFunction function and the\n MyOtherLambdaFunction function.

    \n
    2. \n
  2. \n

    The Invoke API operation on MyLambdaFunction is\n an Lambda API. It is recorded as a data event in CloudTrail.\n Because the CloudTrail user specified logging data events for\n MyLambdaFunction, any invocations of that function are\n logged. The trail processes and logs the event.

    \n
    3. \n
  3. \n

    The Invoke API operation on\n MyOtherLambdaFunction is an Lambda API. Because\n the CloudTrail user did not specify logging data events for all Lambda functions, the Invoke operation for\n MyOtherLambdaFunction does not match the function specified\n for the trail. The trail doesn’t log the event.

    \n
    4. \n
" - } - }, - "com.amazonaws.cloudtrail#DataResourceValues": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudtrail#String" - } - }, - "com.amazonaws.cloudtrail#DataResources": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudtrail#DataResource" - } - }, - "com.amazonaws.cloudtrail#Date": { - "type": "timestamp" - }, - "com.amazonaws.cloudtrail#DelegatedAdminAccountLimitExceededException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DelegatedAdminAccountLimitExceeded", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This exception is thrown when the maximum number of CloudTrail delegated\n administrators is reached.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#DeleteChannel": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#DeleteChannelRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#DeleteChannelResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#ChannelARNInvalidException" - }, - { - "target": "com.amazonaws.cloudtrail#ChannelNotFoundException" - }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a channel.

" - } - }, - "com.amazonaws.cloudtrail#DeleteChannelRequest": { - "type": "structure", - "members": { - "Channel": { - "target": "com.amazonaws.cloudtrail#ChannelArn", - "traits": { - "smithy.api#documentation": "

The ARN or the UUID value of the channel that you want to delete.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#DeleteChannelResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#DeleteEventDataStore": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#DeleteEventDataStoreRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#DeleteEventDataStoreResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#ChannelExistsForEDSException" + "com.amazonaws.cloudtrail#EventDataStoreNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "EventDataStoreNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified event data store was not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } }, - { - "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + "com.amazonaws.cloudtrail#EventDataStoreStatus": { + "type": "enum", + "members": { + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATED" + } + }, + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "PENDING_DELETION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_DELETION" + } + }, + "STARTING_INGESTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTING_INGESTION" + } + }, + "STOPPING_INGESTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING_INGESTION" + } + }, + "STOPPED_INGESTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED_INGESTION" + } + } + } }, - { - "target": "com.amazonaws.cloudtrail#EventDataStoreHasOngoingImportException" + "com.amazonaws.cloudtrail#EventDataStoreTerminationProtectedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "EventDataStoreTerminationProtectedException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The event data store cannot be deleted because termination protection is enabled for\n it.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + "com.amazonaws.cloudtrail#EventDataStores": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#EventDataStore" + } }, - { - "target": "com.amazonaws.cloudtrail#EventDataStoreTerminationProtectedException" + "com.amazonaws.cloudtrail#EventSelector": { + "type": "structure", + "members": { + "ReadWriteType": { + "target": "com.amazonaws.cloudtrail#ReadWriteType", + "traits": { + "smithy.api#documentation": "

Specify if you want your trail to log read-only events, write-only events, or all. For\n example, the EC2 GetConsoleOutput is a read-only API operation and\n RunInstances is a write-only API operation.

\n

By default, the value is All.

" + } + }, + "IncludeManagementEvents": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specify if you want your event selector to include management events for your\n trail.

\n

For more information, see Management Events in the CloudTrail User\n Guide.

\n

By default, the value is true.

\n

The first copy of management events is free. You are charged for additional copies of\n management events that you are logging on any subsequent trail in the same Region. For more\n information about CloudTrail pricing, see CloudTrail Pricing.

" + } + }, + "DataResources": { + "target": "com.amazonaws.cloudtrail#DataResources", + "traits": { + "smithy.api#documentation": "

CloudTrail supports data event logging for Amazon S3 objects, Lambda functions, and Amazon DynamoDB tables with basic event selectors.\n You can specify up to 250 resources for an individual event selector, but the total number\n of data resources cannot exceed 250 across all event selectors in a trail. This limit does\n not apply if you configure resource logging for all data events.

\n

For more information, see Data\n Events and Limits in CloudTrail in the CloudTrail User\n Guide.

" + } + }, + "ExcludeManagementEventSources": { + "target": "com.amazonaws.cloudtrail#ExcludeManagementEventSources", + "traits": { + "smithy.api#documentation": "

An optional list of service event sources from which you do not want management events\n to be logged on your trail. In this release, the list can be empty (disables the filter),\n or it can filter out Key Management Service or Amazon RDS Data API events by\n containing kms.amazonaws.com or rdsdata.amazonaws.com. By\n default, ExcludeManagementEventSources is empty, and KMS and\n Amazon RDS Data API events are logged to your trail. You can exclude management\n event sources only in Regions that support the event source.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Use event selectors to further specify the management and data event settings for your\n trail. By default, trails created without specific event selectors will be configured to\n log all read and write management events, and no data events. When an event occurs in your\n account, CloudTrail evaluates the event selector for all trails. For each trail, if\n the event matches any event selector, the trail processes and logs the event. If the event\n doesn't match any event selector, the trail doesn't log the event.

\n

You can configure up to five event selectors for a trail.

\n

You cannot apply both event selectors and advanced event selectors to a trail.

" + } }, - { - "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + "com.amazonaws.cloudtrail#EventSelectors": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#EventSelector" + } }, - { - "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + "com.amazonaws.cloudtrail#EventsList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#Event" + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidParameterException" + "com.amazonaws.cloudtrail#ExcludeManagementEventSources": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#String" + } }, - { - "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + "com.amazonaws.cloudtrail#GetChannel": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#GetChannelRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#GetChannelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#ChannelARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#ChannelNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a specific channel.\n

", + "smithy.api#idempotent": {} + } }, - { - "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + "com.amazonaws.cloudtrail#GetChannelRequest": { + "type": "structure", + "members": { + "Channel": { + "target": "com.amazonaws.cloudtrail#ChannelArn", + "traits": { + "smithy.api#documentation": "

The ARN or UUID of a channel.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + "com.amazonaws.cloudtrail#GetChannelResponse": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.cloudtrail#ChannelArn", + "traits": { + "smithy.api#documentation": "

The ARN of an channel returned by a GetChannel request.

" + } + }, + "Name": { + "target": "com.amazonaws.cloudtrail#ChannelName", + "traits": { + "smithy.api#documentation": "

The name of the CloudTrail channel. For service-linked channels, the name is\n aws-service-channel/service-name/custom-suffix where\n service-name represents the name of the Amazon Web Services service that\n created the channel and custom-suffix represents the suffix generated by the\n Amazon Web Services service.

" + } + }, + "Source": { + "target": "com.amazonaws.cloudtrail#Source", + "traits": { + "smithy.api#documentation": "

The source for the CloudTrail channel.

" + } + }, + "SourceConfig": { + "target": "com.amazonaws.cloudtrail#SourceConfig", + "traits": { + "smithy.api#documentation": "

Provides information about the advanced event selectors configured for the channel, and\n whether the channel applies to all Regions or a single Region.

" + } + }, + "Destinations": { + "target": "com.amazonaws.cloudtrail#Destinations", + "traits": { + "smithy.api#documentation": "

The destinations for the channel. For channels created for integrations, \n the destinations are the event data stores that log events arriving through the channel. \n For service-linked channels, the destination is the Amazon Web Services service that created the service-linked channel to receive events.

" + } + }, + "IngestionStatus": { + "target": "com.amazonaws.cloudtrail#IngestionStatus", + "traits": { + "smithy.api#documentation": "

A table showing information about the most recent successful and failed attempts \n to ingest events.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Disables the event data store specified by EventDataStore, which accepts an\n event data store ARN. After you run DeleteEventDataStore, the event data store\n enters a PENDING_DELETION state, and is automatically deleted after a wait\n period of seven days. TerminationProtectionEnabled must be set to\n False on the event data store; this operation cannot work if\n TerminationProtectionEnabled is True.

\n

After you run DeleteEventDataStore on an event data store, you cannot run\n ListQueries, DescribeQuery, or GetQueryResults on\n queries that are using an event data store in a PENDING_DELETION state. An\n event data store in the PENDING_DELETION state does not incur costs.

" - } - }, - "com.amazonaws.cloudtrail#DeleteEventDataStoreRequest": { - "type": "structure", - "members": { - "EventDataStore": { - "target": "com.amazonaws.cloudtrail#EventDataStoreArn", - "traits": { - "smithy.api#documentation": "

The ARN (or the ID suffix of the ARN) of the event data store to delete.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#DeleteEventDataStoreResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#DeleteResourcePolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#DeleteResourcePolicyRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#DeleteResourcePolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.cloudtrail#ResourceARNNotValidException" - }, - { - "target": "com.amazonaws.cloudtrail#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudtrail#ResourcePolicyNotFoundException" - }, - { - "target": "com.amazonaws.cloudtrail#ResourceTypeNotSupportedException" - }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Deletes the resource-based policy attached to the CloudTrail channel.\n

", - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.cloudtrail#DeleteResourcePolicyRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.cloudtrail#ResourceArn", - "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the CloudTrail channel you're deleting the resource-based policy from. \n The following is the format of a resource ARN: \n arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel.\n

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#DeleteResourcePolicyResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#DeleteTrail": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#DeleteTrailRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#DeleteTrailResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + "com.amazonaws.cloudtrail#GetEventDataStore": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#GetEventDataStoreRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#GetEventDataStoreResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about an event data store specified as either an ARN or the ID\n portion of the ARN.

", + "smithy.api#idempotent": {} + } }, - { - "target": "com.amazonaws.cloudtrail#ConflictException" + "com.amazonaws.cloudtrail#GetEventDataStoreRequest": { + "type": "structure", + "members": { + "EventDataStore": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The ARN (or ID suffix of the ARN) of the event data store about which you want\n information.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + "com.amazonaws.cloudtrail#GetEventDataStoreResponse": { + "type": "structure", + "members": { + "EventDataStoreArn": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The event data store Amazon Resource Number (ARN).

" + } + }, + "Name": { + "target": "com.amazonaws.cloudtrail#EventDataStoreName", + "traits": { + "smithy.api#documentation": "

The name of the event data store.

" + } + }, + "Status": { + "target": "com.amazonaws.cloudtrail#EventDataStoreStatus", + "traits": { + "smithy.api#documentation": "

The status of an event data store.

" + } + }, + "AdvancedEventSelectors": { + "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", + "traits": { + "smithy.api#documentation": "

The advanced event selectors used to select events for the data store.

" + } + }, + "MultiRegionEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the event data store includes events from all Regions, or only from\n the Region in which it was created.

" + } + }, + "OrganizationEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether an event data store is collecting logged events for an organization in\n Organizations.

" + } + }, + "RetentionPeriod": { + "target": "com.amazonaws.cloudtrail#RetentionPeriod", + "traits": { + "smithy.api#documentation": "

The retention period of the event data store, in days.

" + } + }, + "TerminationProtectionEnabled": { + "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", + "traits": { + "smithy.api#documentation": "

Indicates that termination protection is enabled.

" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The timestamp of the event data store's creation.

" + } + }, + "UpdatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Shows the time that an event data store was updated, if applicable.\n UpdatedTimestamp is always either the same or newer than the time shown in\n CreatedTimestamp.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.cloudtrail#EventDataStoreKmsKeyId", + "traits": { + "smithy.api#documentation": "

Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the\n following format.

\n

\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidHomeRegionException" + "com.amazonaws.cloudtrail#GetEventSelectors": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#GetEventSelectorsRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#GetEventSelectorsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#TrailNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the settings for the event selectors that you configured for your trail. The\n information returned for your event selectors includes the following:

\n \n

For more information about logging management and data events, see the following topics\n in the CloudTrail User Guide:

\n ", + "smithy.api#idempotent": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + "com.amazonaws.cloudtrail#GetEventSelectorsRequest": { + "type": "structure", + "members": { + "TrailName": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the trail or trail ARN. If you specify a trail name, the string\n must meet the following requirements:

\n \n

If you specify a trail ARN, it must be in the format:

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + "com.amazonaws.cloudtrail#GetEventSelectorsResponse": { + "type": "structure", + "members": { + "TrailARN": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The specified trail ARN that has the event selectors.

" + } + }, + "EventSelectors": { + "target": "com.amazonaws.cloudtrail#EventSelectors", + "traits": { + "smithy.api#documentation": "

The event selectors that are configured for the trail.

" + } + }, + "AdvancedEventSelectors": { + "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", + "traits": { + "smithy.api#documentation": "

The advanced event selectors that are configured for the trail.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + "com.amazonaws.cloudtrail#GetImport": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#GetImportRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#GetImportResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#ImportNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a specific import.

" + } }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + "com.amazonaws.cloudtrail#GetImportRequest": { + "type": "structure", + "members": { + "ImportId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The ID for the import.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#TrailNotFoundException" + "com.amazonaws.cloudtrail#GetImportResponse": { + "type": "structure", + "members": { + "ImportId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The ID of the import.

" + } + }, + "Destinations": { + "target": "com.amazonaws.cloudtrail#ImportDestinations", + "traits": { + "smithy.api#documentation": "

The ARN of the destination event data store.

" + } + }, + "ImportSource": { + "target": "com.amazonaws.cloudtrail#ImportSource", + "traits": { + "smithy.api#documentation": "

The source S3 bucket.

" + } + }, + "StartEventTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Used with EndEventTime to bound a StartImport request, and\n limit imported trail events to only those events logged within a specified time period.\n

" + } + }, + "EndEventTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Used with StartEventTime to bound a StartImport request, and\n limit imported trail events to only those events logged within a specified time period.\n

" + } + }, + "ImportStatus": { + "target": "com.amazonaws.cloudtrail#ImportStatus", + "traits": { + "smithy.api#documentation": "

The status of the import.

" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The timestamp of the import's creation.

" + } + }, + "UpdatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The timestamp of when the import was updated.

" + } + }, + "ImportStatistics": { + "target": "com.amazonaws.cloudtrail#ImportStatistics", + "traits": { + "smithy.api#documentation": "

Provides statistics for the import. CloudTrail does not update import statistics\n in real-time. Returned values for parameters such as EventsCompleted may be\n lower than the actual value, because CloudTrail updates statistics incrementally\n over the course of the import.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a trail. This operation must be called from the Region in which the trail was\n created. DeleteTrail cannot be called on the shadow trails (replicated trails\n in other Regions) of a trail that is enabled in all Regions.

", - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.cloudtrail#DeleteTrailRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the name or the CloudTrail ARN of the trail to be deleted. The\n following is the format of a trail ARN.\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The request that specifies the name of a trail to delete.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#DeleteTrailResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

Returns the objects or data listed below if successful. Otherwise, returns an\n error.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#DeliveryS3Uri": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?$" - } - }, - "com.amazonaws.cloudtrail#DeliveryStatus": { - "type": "enum", - "members": { - "SUCCESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCESS" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "FAILED_SIGNING_FILE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED_SIGNING_FILE" - } - }, - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "RESOURCE_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RESOURCE_NOT_FOUND" - } - }, - "ACCESS_DENIED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACCESS_DENIED" - } - }, - "ACCESS_DENIED_SIGNING_FILE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACCESS_DENIED_SIGNING_FILE" - } - }, - "CANCELLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CANCELLED" - } - }, - "UNKNOWN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNKNOWN" - } - } - } - }, - "com.amazonaws.cloudtrail#DeregisterOrganizationDelegatedAdmin": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#DeregisterOrganizationDelegatedAdminRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#DeregisterOrganizationDelegatedAdminResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#AccountNotFoundException" + "com.amazonaws.cloudtrail#GetInsightSelectors": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#GetInsightSelectorsRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#GetInsightSelectorsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#InsightNotEnabledException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#TrailNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the settings for the Insights event selectors that you configured for your\n trail. GetInsightSelectors shows if CloudTrail Insights event logging\n is enabled on the trail, and if it is, which insight types are enabled. If you run\n GetInsightSelectors on a trail that does not have Insights events enabled,\n the operation throws the exception InsightNotEnabledException\n

\n

For more information, see Logging CloudTrail Insights Events for Trails in the CloudTrail User Guide.

", + "smithy.api#idempotent": {} + } }, - { - "target": "com.amazonaws.cloudtrail#AccountNotRegisteredException" + "com.amazonaws.cloudtrail#GetInsightSelectorsRequest": { + "type": "structure", + "members": { + "TrailName": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the trail or trail ARN. If you specify a trail name, the string\n must meet the following requirements:

\n \n

If you specify a trail ARN, it must be in the format:

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException" + "com.amazonaws.cloudtrail#GetInsightSelectorsResponse": { + "type": "structure", + "members": { + "TrailARN": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a trail for which you want to get Insights\n selectors.

" + } + }, + "InsightSelectors": { + "target": "com.amazonaws.cloudtrail#InsightSelectors", + "traits": { + "smithy.api#documentation": "

A JSON string that contains the insight types you want to log on a trail. In this\n release, ApiErrorRateInsight and ApiCallRateInsight are supported\n as insight types.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#ConflictException" + "com.amazonaws.cloudtrail#GetQueryResults": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#GetQueryResultsRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#GetQueryResultsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidMaxResultsException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#QueryIdNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets event data results of a query. You must specify the QueryID value\n returned by the StartQuery operation.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken" + } + } }, - { - "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + "com.amazonaws.cloudtrail#GetQueryResultsRequest": { + "type": "structure", + "members": { + "EventDataStore": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#deprecated": { + "message": "EventDataStore is no longer required by GetQueryResultsRequest" + }, + "smithy.api#documentation": "

The ARN (or ID suffix of the ARN) of the event data store against which the query was\n run.

" + } + }, + "QueryId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The ID of the query for which you want to get results.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token you can use to get the next page of query results.

" + } + }, + "MaxQueryResults": { + "target": "com.amazonaws.cloudtrail#MaxQueryResults", + "traits": { + "smithy.api#documentation": "

The maximum number of query results to display on a single page.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidParameterException" + "com.amazonaws.cloudtrail#GetQueryResultsResponse": { + "type": "structure", + "members": { + "QueryStatus": { + "target": "com.amazonaws.cloudtrail#QueryStatus", + "traits": { + "smithy.api#documentation": "

The status of the query. Values include QUEUED, RUNNING,\n FINISHED, FAILED, TIMED_OUT, or\n CANCELLED.

" + } + }, + "QueryStatistics": { + "target": "com.amazonaws.cloudtrail#QueryStatistics", + "traits": { + "smithy.api#documentation": "

Shows the count of query results.

" + } + }, + "QueryResultRows": { + "target": "com.amazonaws.cloudtrail#QueryResultRows", + "traits": { + "smithy.api#documentation": "

Contains the individual event results of the query.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token you can use to get the next page of query results.

" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The error message returned if a query failed.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#NotOrganizationManagementAccountException" + "com.amazonaws.cloudtrail#GetResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#GetResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#GetResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourceARNNotValidException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourcePolicyNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourceTypeNotSupportedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Retrieves the JSON text of the resource-based policy document attached to the CloudTrail channel.\n

", + "smithy.api#idempotent": {} + } }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + "com.amazonaws.cloudtrail#GetResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.cloudtrail#ResourceArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the CloudTrail channel attached to the resource-based policy. \n The following is the format of a resource ARN: \n arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException" + "com.amazonaws.cloudtrail#GetResourcePolicyResponse": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.cloudtrail#ResourceArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the CloudTrail channel attached to resource-based policy. \n

" + } + }, + "ResourcePolicy": { + "target": "com.amazonaws.cloudtrail#ResourcePolicy", + "traits": { + "smithy.api#documentation": "

\n A JSON-formatted string that contains the resource-based policy attached to the CloudTrail channel.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException" + "com.amazonaws.cloudtrail#GetTrail": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#GetTrailRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#GetTrailResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#TrailNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns settings information for a specified trail.

", + "smithy.api#idempotent": {} + } }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes CloudTrail delegated administrator permissions from a member account in\n an organization.

", - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.cloudtrail#DeregisterOrganizationDelegatedAdminRequest": { - "type": "structure", - "members": { - "DelegatedAdminAccountId": { - "target": "com.amazonaws.cloudtrail#AccountId", - "traits": { - "smithy.api#documentation": "

A delegated administrator account ID. This is a member account in an organization that\n is currently designated as a delegated administrator.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Removes CloudTrail delegated administrator permissions from a specified member\n account in an organization that is currently designated as a delegated\n administrator.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#DeregisterOrganizationDelegatedAdminResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

Returns the following response if successful. Otherwise, returns an error.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#DescribeQuery": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#DescribeQueryRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#DescribeQueryResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" - }, - { - "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" - }, - { - "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" - }, - { - "target": "com.amazonaws.cloudtrail#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" - }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.cloudtrail#QueryIdNotFoundException" - }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns metadata about a query, including query run time in milliseconds, number of\n events scanned and matched, and query status. You must specify an ARN for\n EventDataStore, and a value for QueryID.

", - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.cloudtrail#DescribeQueryRequest": { - "type": "structure", - "members": { - "EventDataStore": { - "target": "com.amazonaws.cloudtrail#EventDataStoreArn", - "traits": { - "smithy.api#deprecated": { - "message": "EventDataStore is no longer required by DescribeQueryRequest" - }, - "smithy.api#documentation": "

The ARN (or the ID suffix of the ARN) of an event data store on which the specified\n query was run.

" - } - }, - "QueryId": { - "target": "com.amazonaws.cloudtrail#UUID", - "traits": { - "smithy.api#documentation": "

The query ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#DescribeQueryResponse": { - "type": "structure", - "members": { - "QueryId": { - "target": "com.amazonaws.cloudtrail#UUID", - "traits": { - "smithy.api#documentation": "

The ID of the query.

" - } - }, - "QueryString": { - "target": "com.amazonaws.cloudtrail#QueryStatement", - "traits": { - "smithy.api#documentation": "

The SQL code of a query.

" - } - }, - "QueryStatus": { - "target": "com.amazonaws.cloudtrail#QueryStatus", - "traits": { - "smithy.api#documentation": "

The status of a query. Values for QueryStatus include QUEUED,\n RUNNING, FINISHED, FAILED,\n TIMED_OUT, or CANCELLED\n

" - } - }, - "QueryStatistics": { - "target": "com.amazonaws.cloudtrail#QueryStatisticsForDescribeQuery", - "traits": { - "smithy.api#documentation": "

Metadata about a query, including the number of events that were matched, the total\n number of events scanned, the query run time in milliseconds, and the query's creation\n time.

" - } - }, - "ErrorMessage": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

The error message returned if a query failed.

" - } - }, - "DeliveryS3Uri": { - "target": "com.amazonaws.cloudtrail#DeliveryS3Uri", - "traits": { - "smithy.api#documentation": "

The URI for the S3 bucket where CloudTrail delivered query results, if\n applicable.

" - } - }, - "DeliveryStatus": { - "target": "com.amazonaws.cloudtrail#DeliveryStatus", - "traits": { - "smithy.api#documentation": "

The delivery status.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#DescribeTrails": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#DescribeTrailsRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#DescribeTrailsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" - }, - { - "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" - }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves settings for one or more trails associated with the current Region for your\n account.

", - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.cloudtrail#DescribeTrailsRequest": { - "type": "structure", - "members": { - "trailNameList": { - "target": "com.amazonaws.cloudtrail#TrailNameList", - "traits": { - "smithy.api#documentation": "

Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The\n format of a trail ARN is:

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

\n

If an empty list is specified, information for the trail in the current Region is\n returned.

\n \n \n

If one or more trail names are specified, information is returned only if the names\n match the names of trails belonging only to the current Region and current account. To\n return information about a trail in another Region, you must specify its trail\n ARN.

\n " - } - }, - "includeShadowTrails": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether to include shadow trails in the response. A shadow trail is the\n replication in a Region of a trail that was created in a different Region, or in the case\n of an organization trail, the replication of an organization trail in member accounts. If\n you do not include shadow trails, organization trails in a member account and Region\n replication trails will not be returned. The default is true.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Returns information about the trail.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#DescribeTrailsResponse": { - "type": "structure", - "members": { - "trailList": { - "target": "com.amazonaws.cloudtrail#TrailList", - "traits": { - "smithy.api#documentation": "

The list of trail objects. Trail objects with string values are only returned if values\n for the objects exist in a trail's configuration. For example, SNSTopicName\n and SNSTopicARN are only returned in results if a trail is configured to send\n SNS notifications. Similarly, KMSKeyId only appears in results if a trail's\n log files are encrypted with KMS\n customer managed keys.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Returns the objects or data listed below if successful. Otherwise, returns an\n error.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#Destination": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.cloudtrail#DestinationType", - "traits": { - "smithy.api#documentation": "

The type of destination for events arriving from a channel. For channels used for a CloudTrail Lake integration, the value is EventDataStore. For service-linked channels, \n the value is AWS_SERVICE.

", - "smithy.api#required": {} - } - }, - "Location": { - "target": "com.amazonaws.cloudtrail#Location", - "traits": { - "smithy.api#documentation": "

For channels used for a CloudTrail Lake integration, the location is the ARN of an event data store that receives events from a channel. \n For service-linked channels, the location is the name of the Amazon Web Services service.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about the destination receiving events.

" - } - }, - "com.amazonaws.cloudtrail#DestinationType": { - "type": "enum", - "members": { - "EVENT_DATA_STORE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EVENT_DATA_STORE" - } - }, - "AWS_SERVICE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AWS_SERVICE" - } - } - } - }, - "com.amazonaws.cloudtrail#Destinations": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudtrail#Destination" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.cloudtrail#ErrorMessage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 4, - "max": 1000 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.cloudtrail#Event": { - "type": "structure", - "members": { - "EventId": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

The CloudTrail ID of the event returned.

" - } - }, - "EventName": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

The name of the event returned.

" - } - }, - "ReadOnly": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Information about whether the event is a write event or a read event.

" - } - }, - "AccessKeyId": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services access key ID that was used to sign the request. If the request\n was made with temporary security credentials, this is the access key ID of the temporary\n credentials.

" - } - }, - "EventTime": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

The date and time of the event returned.

" - } - }, - "EventSource": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services service to which the request was made.

" - } - }, - "Username": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

A user name or role name of the requester that called the API in the event\n returned.

" - } - }, - "Resources": { - "target": "com.amazonaws.cloudtrail#ResourceList", - "traits": { - "smithy.api#documentation": "

A list of resources referenced by the event returned.

" - } - }, - "CloudTrailEvent": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

A JSON string that contains a representation of the event returned.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about an event that was returned by a lookup request. The result\n includes a representation of a CloudTrail event.

" - } - }, - "com.amazonaws.cloudtrail#EventCategory": { - "type": "enum", - "members": { - "Insight": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "insight" - } - } - } - }, - "com.amazonaws.cloudtrail#EventDataStore": { - "type": "structure", - "members": { - "EventDataStoreArn": { - "target": "com.amazonaws.cloudtrail#EventDataStoreArn", - "traits": { - "smithy.api#documentation": "

The ARN of the event data store.

" - } - }, - "Name": { - "target": "com.amazonaws.cloudtrail#EventDataStoreName", - "traits": { - "smithy.api#documentation": "

The name of the event data store.

" - } - }, - "TerminationProtectionEnabled": { - "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", - "traits": { - "smithy.api#deprecated": { - "message": "TerminationProtectionEnabled is no longer returned by ListEventDataStores" - }, - "smithy.api#documentation": "

Indicates whether the event data store is protected from\n termination.

" - } - }, - "Status": { - "target": "com.amazonaws.cloudtrail#EventDataStoreStatus", - "traits": { - "smithy.api#deprecated": { - "message": "Status is no longer returned by ListEventDataStores" - }, - "smithy.api#documentation": "

The status of an event data store.

" - } - }, - "AdvancedEventSelectors": { - "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", - "traits": { - "smithy.api#deprecated": { - "message": "AdvancedEventSelectors is no longer returned by ListEventDataStores" - }, - "smithy.api#documentation": "

The advanced event selectors that were used to select\n events for the data store.

" - } - }, - "MultiRegionEnabled": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#deprecated": { - "message": "MultiRegionEnabled is no longer returned by ListEventDataStores" - }, - "smithy.api#documentation": "

Indicates whether the event data store includes events\n from all Regions, or only from the Region in which it was created.

" - } - }, - "OrganizationEnabled": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#deprecated": { - "message": "OrganizationEnabled is no longer returned by ListEventDataStores" - }, - "smithy.api#documentation": "

Indicates that an event data store is collecting logged\n events for an organization.

" - } - }, - "RetentionPeriod": { - "target": "com.amazonaws.cloudtrail#RetentionPeriod", - "traits": { - "smithy.api#deprecated": { - "message": "RetentionPeriod is no longer returned by ListEventDataStores" - }, - "smithy.api#documentation": "

The retention period, in days.

" - } - }, - "CreatedTimestamp": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#deprecated": { - "message": "CreatedTimestamp is no longer returned by ListEventDataStores" - }, - "smithy.api#documentation": "

The timestamp of the event data store's creation.

" - } - }, - "UpdatedTimestamp": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#deprecated": { - "message": "UpdatedTimestamp is no longer returned by ListEventDataStores" - }, - "smithy.api#documentation": "

The timestamp showing when an event data store was\n updated, if applicable. UpdatedTimestamp is always either the same or newer\n than the time shown in CreatedTimestamp.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A storage lake of event data against which you can run complex SQL-based queries. An\n event data store can include events that you have logged on your account from the last 90\n to 2557 days (about three months to up to seven years). To select events for an event data\n store, use advanced event selectors.

" - } - }, - "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "EventDataStoreARNInvalid", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The specified event data store ARN is not valid or does not map to an event data store\n in your account.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#EventDataStoreAlreadyExistsException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "EventDataStoreAlreadyExists", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

An event data store with that name already exists.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#EventDataStoreArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 256 - }, - "smithy.api#pattern": "^[a-zA-Z0-9._/\\-:]+$" - } - }, - "com.amazonaws.cloudtrail#EventDataStoreHasOngoingImportException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "EventDataStoreHasOngoingImport", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This exception is thrown when you try to update or delete an event data store that\n currently has an import in progress.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#EventDataStoreKmsKeyId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 350 - }, - "smithy.api#pattern": "^[a-zA-Z0-9._/\\-:]+$" - } - }, - "com.amazonaws.cloudtrail#EventDataStoreMaxLimitExceededException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "EventDataStoreMaxLimitExceeded", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

Your account has used the maximum number of event data stores.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#EventDataStoreName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 128 - }, - "smithy.api#pattern": "^[a-zA-Z0-9._\\-]+$" - } - }, - "com.amazonaws.cloudtrail#EventDataStoreNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "EventDataStoreNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The specified event data store was not found.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.cloudtrail#EventDataStoreStatus": { - "type": "enum", - "members": { - "CREATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATED" - } - }, - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "PENDING_DELETION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING_DELETION" - } - }, - "STARTING_INGESTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STARTING_INGESTION" - } - }, - "STOPPING_INGESTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STOPPING_INGESTION" - } - }, - "STOPPED_INGESTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STOPPED_INGESTION" - } - } - } - }, - "com.amazonaws.cloudtrail#EventDataStoreTerminationProtectedException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "EventDataStoreTerminationProtectedException", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The event data store cannot be deleted because termination protection is enabled for\n it.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#EventDataStores": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudtrail#EventDataStore" - } - }, - "com.amazonaws.cloudtrail#EventSelector": { - "type": "structure", - "members": { - "ReadWriteType": { - "target": "com.amazonaws.cloudtrail#ReadWriteType", - "traits": { - "smithy.api#documentation": "

Specify if you want your trail to log read-only events, write-only events, or all. For\n example, the EC2 GetConsoleOutput is a read-only API operation and\n RunInstances is a write-only API operation.

\n

By default, the value is All.

" - } - }, - "IncludeManagementEvents": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Specify if you want your event selector to include management events for your\n trail.

\n

For more information, see Management Events in the CloudTrail User\n Guide.

\n

By default, the value is true.

\n

The first copy of management events is free. You are charged for additional copies of\n management events that you are logging on any subsequent trail in the same Region. For more\n information about CloudTrail pricing, see CloudTrail Pricing.

" - } - }, - "DataResources": { - "target": "com.amazonaws.cloudtrail#DataResources", - "traits": { - "smithy.api#documentation": "

CloudTrail supports data event logging for Amazon S3 objects, Lambda functions, and Amazon DynamoDB tables with basic event selectors.\n You can specify up to 250 resources for an individual event selector, but the total number\n of data resources cannot exceed 250 across all event selectors in a trail. This limit does\n not apply if you configure resource logging for all data events.

\n

For more information, see Data\n Events and Limits in CloudTrail in the CloudTrail User\n Guide.

" - } - }, - "ExcludeManagementEventSources": { - "target": "com.amazonaws.cloudtrail#ExcludeManagementEventSources", - "traits": { - "smithy.api#documentation": "

An optional list of service event sources from which you do not want management events\n to be logged on your trail. In this release, the list can be empty (disables the filter),\n or it can filter out Key Management Service or Amazon RDS Data API events by\n containing kms.amazonaws.com or rdsdata.amazonaws.com. By\n default, ExcludeManagementEventSources is empty, and KMS and\n Amazon RDS Data API events are logged to your trail. You can exclude management\n event sources only in Regions that support the event source.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Use event selectors to further specify the management and data event settings for your\n trail. By default, trails created without specific event selectors will be configured to\n log all read and write management events, and no data events. When an event occurs in your\n account, CloudTrail evaluates the event selector for all trails. For each trail, if\n the event matches any event selector, the trail processes and logs the event. If the event\n doesn't match any event selector, the trail doesn't log the event.

\n

You can configure up to five event selectors for a trail.

\n

You cannot apply both event selectors and advanced event selectors to a trail.

" - } - }, - "com.amazonaws.cloudtrail#EventSelectors": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudtrail#EventSelector" - } - }, - "com.amazonaws.cloudtrail#EventsList": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudtrail#Event" - } - }, - "com.amazonaws.cloudtrail#ExcludeManagementEventSources": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudtrail#String" - } - }, - "com.amazonaws.cloudtrail#GetChannel": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#GetChannelRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#GetChannelResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#ChannelARNInvalidException" - }, - { - "target": "com.amazonaws.cloudtrail#ChannelNotFoundException" - }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about a specific channel.\n

", - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.cloudtrail#GetChannelRequest": { - "type": "structure", - "members": { - "Channel": { - "target": "com.amazonaws.cloudtrail#ChannelArn", - "traits": { - "smithy.api#documentation": "

The ARN or UUID of a channel.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#GetChannelResponse": { - "type": "structure", - "members": { - "ChannelArn": { - "target": "com.amazonaws.cloudtrail#ChannelArn", - "traits": { - "smithy.api#documentation": "

The ARN of an channel returned by a GetChannel request.

" - } - }, - "Name": { - "target": "com.amazonaws.cloudtrail#ChannelName", - "traits": { - "smithy.api#documentation": "

The name of the CloudTrail channel. For service-linked channels, the name is\n aws-service-channel/service-name/custom-suffix where\n service-name represents the name of the Amazon Web Services service that\n created the channel and custom-suffix represents the suffix generated by the\n Amazon Web Services service.

" - } - }, - "Source": { - "target": "com.amazonaws.cloudtrail#Source", - "traits": { - "smithy.api#documentation": "

The source for the CloudTrail channel.

" - } - }, - "SourceConfig": { - "target": "com.amazonaws.cloudtrail#SourceConfig", - "traits": { - "smithy.api#documentation": "

Provides information about the advanced event selectors configured for the channel, and\n whether the channel applies to all Regions or a single Region.

" - } - }, - "Destinations": { - "target": "com.amazonaws.cloudtrail#Destinations", - "traits": { - "smithy.api#documentation": "

The destinations for the channel. For channels created for integrations, \n the destinations are the event data stores that log events arriving through the channel. \n For service-linked channels, the destination is the Amazon Web Services service that created the service-linked channel to receive events.

" - } - }, - "IngestionStatus": { - "target": "com.amazonaws.cloudtrail#IngestionStatus", - "traits": { - "smithy.api#documentation": "

A table showing information about the most recent successful and failed attempts \n to ingest events.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#GetEventDataStore": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#GetEventDataStoreRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#GetEventDataStoreResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" - }, - { - "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" - }, - { - "target": "com.amazonaws.cloudtrail#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" - }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about an event data store specified as either an ARN or the ID\n portion of the ARN.

", - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.cloudtrail#GetEventDataStoreRequest": { - "type": "structure", - "members": { - "EventDataStore": { - "target": "com.amazonaws.cloudtrail#EventDataStoreArn", - "traits": { - "smithy.api#documentation": "

The ARN (or ID suffix of the ARN) of the event data store about which you want\n information.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#GetEventDataStoreResponse": { - "type": "structure", - "members": { - "EventDataStoreArn": { - "target": "com.amazonaws.cloudtrail#EventDataStoreArn", - "traits": { - "smithy.api#documentation": "

The event data store Amazon Resource Number (ARN).

" - } - }, - "Name": { - "target": "com.amazonaws.cloudtrail#EventDataStoreName", - "traits": { - "smithy.api#documentation": "

The name of the event data store.

" - } - }, - "Status": { - "target": "com.amazonaws.cloudtrail#EventDataStoreStatus", - "traits": { - "smithy.api#documentation": "

The status of an event data store.

" - } - }, - "AdvancedEventSelectors": { - "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", - "traits": { - "smithy.api#documentation": "

The advanced event selectors used to select events for the data store.

" - } - }, - "MultiRegionEnabled": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether the event data store includes events from all Regions, or only from\n the Region in which it was created.

" - } - }, - "OrganizationEnabled": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether an event data store is collecting logged events for an organization in\n Organizations.

" - } - }, - "RetentionPeriod": { - "target": "com.amazonaws.cloudtrail#RetentionPeriod", - "traits": { - "smithy.api#documentation": "

The retention period of the event data store, in days.

" - } - }, - "TerminationProtectionEnabled": { - "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", - "traits": { - "smithy.api#documentation": "

Indicates that termination protection is enabled.

" - } - }, - "CreatedTimestamp": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

The timestamp of the event data store's creation.

" - } - }, - "UpdatedTimestamp": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

Shows the time that an event data store was updated, if applicable.\n UpdatedTimestamp is always either the same or newer than the time shown in\n CreatedTimestamp.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.cloudtrail#EventDataStoreKmsKeyId", - "traits": { - "smithy.api#documentation": "

Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the\n following format.

\n

\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#GetEventSelectors": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#GetEventSelectorsRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#GetEventSelectorsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" - }, - { - "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" - }, - { - "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" - }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.cloudtrail#TrailNotFoundException" - }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the settings for the event selectors that you configured for your trail. The\n information returned for your event selectors includes the following:

\n \n

For more information about logging management and data events, see the following topics\n in the CloudTrail User Guide:

\n ", - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.cloudtrail#GetEventSelectorsRequest": { - "type": "structure", - "members": { - "TrailName": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the trail or trail ARN. If you specify a trail name, the string\n must meet the following requirements:

\n \n

If you specify a trail ARN, it must be in the format:

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#GetEventSelectorsResponse": { - "type": "structure", - "members": { - "TrailARN": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

The specified trail ARN that has the event selectors.

" - } - }, - "EventSelectors": { - "target": "com.amazonaws.cloudtrail#EventSelectors", - "traits": { - "smithy.api#documentation": "

The event selectors that are configured for the trail.

" - } - }, - "AdvancedEventSelectors": { - "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", - "traits": { - "smithy.api#documentation": "

The advanced event selectors that are configured for the trail.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#GetImport": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#GetImportRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#GetImportResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#ImportNotFoundException" - }, - { - "target": "com.amazonaws.cloudtrail#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about a specific import.

" - } - }, - "com.amazonaws.cloudtrail#GetImportRequest": { - "type": "structure", - "members": { - "ImportId": { - "target": "com.amazonaws.cloudtrail#UUID", - "traits": { - "smithy.api#documentation": "

The ID for the import.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#GetImportResponse": { - "type": "structure", - "members": { - "ImportId": { - "target": "com.amazonaws.cloudtrail#UUID", - "traits": { - "smithy.api#documentation": "

The ID of the import.

" - } - }, - "Destinations": { - "target": "com.amazonaws.cloudtrail#ImportDestinations", - "traits": { - "smithy.api#documentation": "

The ARN of the destination event data store.

" - } - }, - "ImportSource": { - "target": "com.amazonaws.cloudtrail#ImportSource", - "traits": { - "smithy.api#documentation": "

The source S3 bucket.

" - } - }, - "StartEventTime": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

Used with EndEventTime to bound a StartImport request, and\n limit imported trail events to only those events logged within a specified time period.\n

" - } - }, - "EndEventTime": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

Used with StartEventTime to bound a StartImport request, and\n limit imported trail events to only those events logged within a specified time period.\n

" - } - }, - "ImportStatus": { - "target": "com.amazonaws.cloudtrail#ImportStatus", - "traits": { - "smithy.api#documentation": "

The status of the import.

" - } - }, - "CreatedTimestamp": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

The timestamp of the import's creation.

" - } - }, - "UpdatedTimestamp": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

The timestamp of when the import was updated.

" - } - }, - "ImportStatistics": { - "target": "com.amazonaws.cloudtrail#ImportStatistics", - "traits": { - "smithy.api#documentation": "

Provides statistics for the import. CloudTrail does not update import statistics\n in real-time. Returned values for parameters such as EventsCompleted may be\n lower than the actual value, because CloudTrail updates statistics incrementally\n over the course of the import.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#GetInsightSelectors": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#GetInsightSelectorsRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#GetInsightSelectorsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" - }, - { - "target": "com.amazonaws.cloudtrail#InsightNotEnabledException" - }, - { - "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" - }, - { - "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" - }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.cloudtrail#TrailNotFoundException" - }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the settings for the Insights event selectors that you configured for your\n trail. GetInsightSelectors shows if CloudTrail Insights event logging\n is enabled on the trail, and if it is, which insight types are enabled. If you run\n GetInsightSelectors on a trail that does not have Insights events enabled,\n the operation throws the exception InsightNotEnabledException\n

\n

For more information, see Logging CloudTrail Insights Events for Trails in the CloudTrail User Guide.

", - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.cloudtrail#GetInsightSelectorsRequest": { - "type": "structure", - "members": { - "TrailName": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the trail or trail ARN. If you specify a trail name, the string\n must meet the following requirements:

\n \n

If you specify a trail ARN, it must be in the format:

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#GetInsightSelectorsResponse": { - "type": "structure", - "members": { - "TrailARN": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a trail for which you want to get Insights\n selectors.

" - } - }, - "InsightSelectors": { - "target": "com.amazonaws.cloudtrail#InsightSelectors", - "traits": { - "smithy.api#documentation": "

A JSON string that contains the insight types you want to log on a trail. In this\n release, ApiErrorRateInsight and ApiCallRateInsight are supported\n as insight types.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#GetQueryResults": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#GetQueryResultsRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#GetQueryResultsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + "com.amazonaws.cloudtrail#GetTrailRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The name or the Amazon Resource Name (ARN) of the trail for which you want to retrieve\n settings information.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + "com.amazonaws.cloudtrail#GetTrailResponse": { + "type": "structure", + "members": { + "Trail": { + "target": "com.amazonaws.cloudtrail#Trail" + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + "com.amazonaws.cloudtrail#GetTrailStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#GetTrailStatusRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#GetTrailStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#TrailNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a JSON-formatted list of information about the specified trail. Fields include\n information on delivery errors, Amazon SNS and Amazon S3 errors, and start\n and stop logging times for each trail. This operation returns trail status from a single\n Region. To return trail status from all Regions, you must call the operation on each\n Region.

", + "smithy.api#idempotent": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" + "com.amazonaws.cloudtrail#GetTrailStatusRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the name or the CloudTrail ARN of the trail for which you are\n requesting status. To get the status of a shadow trail (a replication of the trail in\n another Region), you must specify its ARN. The following is the format of a trail\n ARN.

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The name of a trail about which you want the current status.

", + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidMaxResultsException" + "com.amazonaws.cloudtrail#GetTrailStatusResponse": { + "type": "structure", + "members": { + "IsLogging": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Whether the CloudTrail trail is currently logging Amazon Web Services API\n calls.

" + } + }, + "LatestDeliveryError": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Displays any Amazon S3 error that CloudTrail encountered when attempting\n to deliver log files to the designated bucket. For more information, see Error\n Responses in the Amazon S3 API Reference.

\n \n

This error occurs only when there is a problem with the destination S3 bucket, and\n does not occur for requests that time out. To resolve the issue, create a new bucket,\n and then call UpdateTrail to specify the new bucket; or fix the existing\n objects so that CloudTrail can again write to the bucket.

\n " + } + }, + "LatestNotificationError": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Displays any Amazon SNS error that CloudTrail encountered when attempting\n to send a notification. For more information about Amazon SNS errors, see the\n Amazon SNS\n Developer Guide.

" + } + }, + "LatestDeliveryTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Specifies the date and time that CloudTrail last delivered log files to an\n account's Amazon S3 bucket.

" + } + }, + "LatestNotificationTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Specifies the date and time of the most recent Amazon SNS notification that\n CloudTrail has written a new log file to an account's Amazon S3\n bucket.

" + } + }, + "StartLoggingTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Specifies the most recent date and time when CloudTrail started recording API\n calls for an Amazon Web Services account.

" + } + }, + "StopLoggingTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Specifies the most recent date and time when CloudTrail stopped recording API\n calls for an Amazon Web Services account.

" + } + }, + "LatestCloudWatchLogsDeliveryError": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Displays any CloudWatch Logs error that CloudTrail encountered when attempting\n to deliver logs to CloudWatch Logs.

" + } + }, + "LatestCloudWatchLogsDeliveryTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Displays the most recent date and time when CloudTrail delivered logs to CloudWatch Logs.

" + } + }, + "LatestDigestDeliveryTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Specifies the date and time that CloudTrail last delivered a digest file to an\n account's Amazon S3 bucket.

" + } + }, + "LatestDigestDeliveryError": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Displays any Amazon S3 error that CloudTrail encountered when attempting\n to deliver a digest file to the designated bucket. For more information, see Error\n Responses in the Amazon S3 API Reference.

\n \n

This error occurs only when there is a problem with the destination S3 bucket, and\n does not occur for requests that time out. To resolve the issue, create a new bucket,\n and then call UpdateTrail to specify the new bucket; or fix the existing\n objects so that CloudTrail can again write to the bucket.

\n " + } + }, + "LatestDeliveryAttemptTime": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

This field is no longer in use.

" + } + }, + "LatestNotificationAttemptTime": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

This field is no longer in use.

" + } + }, + "LatestNotificationAttemptSucceeded": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

This field is no longer in use.

" + } + }, + "LatestDeliveryAttemptSucceeded": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

This field is no longer in use.

" + } + }, + "TimeLoggingStarted": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

This field is no longer in use.

" + } + }, + "TimeLoggingStopped": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

This field is no longer in use.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Returns the objects or data listed below if successful. Otherwise, returns an\n error.

", + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidNextTokenException" + "com.amazonaws.cloudtrail#ImportDestinations": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidParameterException" + "com.amazonaws.cloudtrail#ImportFailureList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#ImportFailureListItem" + } }, - { - "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + "com.amazonaws.cloudtrail#ImportFailureListItem": { + "type": "structure", + "members": { + "Location": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The location of the failure in the S3 bucket.

" + } + }, + "Status": { + "target": "com.amazonaws.cloudtrail#ImportFailureStatus", + "traits": { + "smithy.api#documentation": "

The status of the import.

" + } + }, + "ErrorType": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The type of import error.

" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Provides the reason the import failed.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

When the import was last updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about an import failure.

" + } }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + "com.amazonaws.cloudtrail#ImportFailureStatus": { + "type": "enum", + "members": { + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "RETRY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETRY" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + } + } }, - { - "target": "com.amazonaws.cloudtrail#QueryIdNotFoundException" + "com.amazonaws.cloudtrail#ImportNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ImportNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified import was not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets event data results of a query. You must specify the QueryID value\n returned by the StartQuery operation, and an ARN for\n EventDataStore.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken" - } - } - }, - "com.amazonaws.cloudtrail#GetQueryResultsRequest": { - "type": "structure", - "members": { - "EventDataStore": { - "target": "com.amazonaws.cloudtrail#EventDataStoreArn", - "traits": { - "smithy.api#deprecated": { - "message": "EventDataStore is no longer required by GetQueryResultsRequest" - }, - "smithy.api#documentation": "

The ARN (or ID suffix of the ARN) of the event data store against which the query was\n run.

" - } - }, - "QueryId": { - "target": "com.amazonaws.cloudtrail#UUID", - "traits": { - "smithy.api#documentation": "

The ID of the query for which you want to get results.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.cloudtrail#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token you can use to get the next page of query results.

" - } - }, - "MaxQueryResults": { - "target": "com.amazonaws.cloudtrail#MaxQueryResults", - "traits": { - "smithy.api#documentation": "

The maximum number of query results to display on a single page.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#GetQueryResultsResponse": { - "type": "structure", - "members": { - "QueryStatus": { - "target": "com.amazonaws.cloudtrail#QueryStatus", - "traits": { - "smithy.api#documentation": "

The status of the query. Values include QUEUED, RUNNING,\n FINISHED, FAILED, TIMED_OUT, or\n CANCELLED.

" - } - }, - "QueryStatistics": { - "target": "com.amazonaws.cloudtrail#QueryStatistics", - "traits": { - "smithy.api#documentation": "

Shows the count of query results.

" - } - }, - "QueryResultRows": { - "target": "com.amazonaws.cloudtrail#QueryResultRows", - "traits": { - "smithy.api#documentation": "

Contains the individual event results of the query.

" - } - }, - "NextToken": { - "target": "com.amazonaws.cloudtrail#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token you can use to get the next page of query results.

" - } - }, - "ErrorMessage": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

The error message returned if a query failed.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#GetResourcePolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#GetResourcePolicyRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#GetResourcePolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.cloudtrail#ResourceARNNotValidException" - }, - { - "target": "com.amazonaws.cloudtrail#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudtrail#ResourcePolicyNotFoundException" - }, - { - "target": "com.amazonaws.cloudtrail#ResourceTypeNotSupportedException" - }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Retrieves the JSON text of the resource-based policy document attached to the CloudTrail channel.\n

", - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.cloudtrail#GetResourcePolicyRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.cloudtrail#ResourceArn", - "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the CloudTrail channel attached to the resource-based policy. \n The following is the format of a resource ARN: \n arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel.\n

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#GetResourcePolicyResponse": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.cloudtrail#ResourceArn", - "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the CloudTrail channel attached to resource-based policy. \n

" - } - }, - "ResourcePolicy": { - "target": "com.amazonaws.cloudtrail#ResourcePolicy", - "traits": { - "smithy.api#documentation": "

\n A JSON-formatted string that contains the resource-based policy attached to the CloudTrail channel.\n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#GetTrail": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#GetTrailRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#GetTrailResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" - }, - { - "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" - }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.cloudtrail#TrailNotFoundException" - }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns settings information for a specified trail.

", - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.cloudtrail#GetTrailRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

The name or the Amazon Resource Name (ARN) of the trail for which you want to retrieve\n settings information.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#GetTrailResponse": { - "type": "structure", - "members": { - "Trail": { - "target": "com.amazonaws.cloudtrail#Trail" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#GetTrailStatus": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#GetTrailStatusRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#GetTrailStatusResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" - }, - { - "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" - }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.cloudtrail#TrailNotFoundException" - }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a JSON-formatted list of information about the specified trail. Fields include\n information on delivery errors, Amazon SNS and Amazon S3 errors, and start\n and stop logging times for each trail. This operation returns trail status from a single\n Region. To return trail status from all Regions, you must call the operation on each\n Region.

", - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.cloudtrail#GetTrailStatusRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the name or the CloudTrail ARN of the trail for which you are\n requesting status. To get the status of a shadow trail (a replication of the trail in\n another Region), you must specify its ARN. The following is the format of a trail\n ARN.

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The name of a trail about which you want the current status.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#GetTrailStatusResponse": { - "type": "structure", - "members": { - "IsLogging": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Whether the CloudTrail trail is currently logging Amazon Web Services API\n calls.

" - } - }, - "LatestDeliveryError": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Displays any Amazon S3 error that CloudTrail encountered when attempting\n to deliver log files to the designated bucket. For more information, see Error\n Responses in the Amazon S3 API Reference.

\n \n

This error occurs only when there is a problem with the destination S3 bucket, and\n does not occur for requests that time out. To resolve the issue, create a new bucket,\n and then call UpdateTrail to specify the new bucket; or fix the existing\n objects so that CloudTrail can again write to the bucket.

\n " - } - }, - "LatestNotificationError": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Displays any Amazon SNS error that CloudTrail encountered when attempting\n to send a notification. For more information about Amazon SNS errors, see the\n Amazon SNS\n Developer Guide.

" - } - }, - "LatestDeliveryTime": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

Specifies the date and time that CloudTrail last delivered log files to an\n account's Amazon S3 bucket.

" - } - }, - "LatestNotificationTime": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

Specifies the date and time of the most recent Amazon SNS notification that\n CloudTrail has written a new log file to an account's Amazon S3\n bucket.

" - } - }, - "StartLoggingTime": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

Specifies the most recent date and time when CloudTrail started recording API\n calls for an Amazon Web Services account.

" - } - }, - "StopLoggingTime": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

Specifies the most recent date and time when CloudTrail stopped recording API\n calls for an Amazon Web Services account.

" - } - }, - "LatestCloudWatchLogsDeliveryError": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Displays any CloudWatch Logs error that CloudTrail encountered when attempting\n to deliver logs to CloudWatch Logs.

" - } - }, - "LatestCloudWatchLogsDeliveryTime": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

Displays the most recent date and time when CloudTrail delivered logs to CloudWatch Logs.

" - } - }, - "LatestDigestDeliveryTime": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

Specifies the date and time that CloudTrail last delivered a digest file to an\n account's Amazon S3 bucket.

" - } - }, - "LatestDigestDeliveryError": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Displays any Amazon S3 error that CloudTrail encountered when attempting\n to deliver a digest file to the designated bucket. For more information, see Error\n Responses in the Amazon S3 API Reference.

\n \n

This error occurs only when there is a problem with the destination S3 bucket, and\n does not occur for requests that time out. To resolve the issue, create a new bucket,\n and then call UpdateTrail to specify the new bucket; or fix the existing\n objects so that CloudTrail can again write to the bucket.

\n " - } - }, - "LatestDeliveryAttemptTime": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

This field is no longer in use.

" - } - }, - "LatestNotificationAttemptTime": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

This field is no longer in use.

" - } - }, - "LatestNotificationAttemptSucceeded": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

This field is no longer in use.

" - } - }, - "LatestDeliveryAttemptSucceeded": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

This field is no longer in use.

" - } - }, - "TimeLoggingStarted": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

This field is no longer in use.

" - } - }, - "TimeLoggingStopped": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

This field is no longer in use.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Returns the objects or data listed below if successful. Otherwise, returns an\n error.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#ImportDestinations": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudtrail#EventDataStoreArn" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.cloudtrail#ImportFailureList": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudtrail#ImportFailureListItem" - } - }, - "com.amazonaws.cloudtrail#ImportFailureListItem": { - "type": "structure", - "members": { - "Location": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

The location of the failure in the S3 bucket.

" - } - }, - "Status": { - "target": "com.amazonaws.cloudtrail#ImportFailureStatus", - "traits": { - "smithy.api#documentation": "

The status of the import.

" - } - }, - "ErrorType": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

The type of import error.

" - } - }, - "ErrorMessage": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Provides the reason the import failed.

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

When the import was last updated.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about an import failure.

" - } - }, - "com.amazonaws.cloudtrail#ImportFailureStatus": { - "type": "enum", - "members": { - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "RETRY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RETRY" - } - }, - "SUCCEEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCEEDED" - } - } - } - }, - "com.amazonaws.cloudtrail#ImportNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ImportNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The specified import was not found.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.cloudtrail#ImportSource": { - "type": "structure", - "members": { - "S3": { - "target": "com.amazonaws.cloudtrail#S3ImportSource", - "traits": { - "smithy.api#documentation": "

The source S3 bucket.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The import source.

" - } - }, - "com.amazonaws.cloudtrail#ImportStatistics": { - "type": "structure", - "members": { - "PrefixesFound": { - "target": "com.amazonaws.cloudtrail#Long", - "traits": { - "smithy.api#documentation": "

The number of S3 prefixes found for the import.

" - } - }, - "PrefixesCompleted": { - "target": "com.amazonaws.cloudtrail#Long", - "traits": { - "smithy.api#documentation": "

The number of S3 prefixes that completed import.

" - } - }, - "FilesCompleted": { - "target": "com.amazonaws.cloudtrail#Long", - "traits": { - "smithy.api#documentation": "

The number of log files that completed import.

" - } - }, - "EventsCompleted": { - "target": "com.amazonaws.cloudtrail#Long", - "traits": { - "smithy.api#documentation": "

The number of trail events imported into the event data store.

" - } - }, - "FailedEntries": { - "target": "com.amazonaws.cloudtrail#Long", - "traits": { - "smithy.api#documentation": "

The number of failed entries.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides statistics for the specified ImportID. CloudTrail does not\n update import statistics in real-time. Returned values for parameters such as\n EventsCompleted may be lower than the actual value, because CloudTrail updates statistics incrementally over the course of the import.

" - } - }, - "com.amazonaws.cloudtrail#ImportStatus": { - "type": "enum", - "members": { - "INITIALIZING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INITIALIZING" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_PROGRESS" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "STOPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STOPPED" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - } - } - }, - "com.amazonaws.cloudtrail#ImportsList": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudtrail#ImportsListItem" - } - }, - "com.amazonaws.cloudtrail#ImportsListItem": { - "type": "structure", - "members": { - "ImportId": { - "target": "com.amazonaws.cloudtrail#UUID", - "traits": { - "smithy.api#documentation": "

The ID of the import.

" - } - }, - "ImportStatus": { - "target": "com.amazonaws.cloudtrail#ImportStatus", - "traits": { - "smithy.api#documentation": "

The status of the import.

" - } - }, - "Destinations": { - "target": "com.amazonaws.cloudtrail#ImportDestinations", - "traits": { - "smithy.api#documentation": "

The ARN of the destination event data store.

" - } - }, - "CreatedTimestamp": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

The timestamp of the import's creation.

" - } - }, - "UpdatedTimestamp": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

The timestamp of the import's last update.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about an import that was returned by a lookup request.

" - } - }, - "com.amazonaws.cloudtrail#InactiveEventDataStoreException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InactiveEventDataStore", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The event data store is inactive.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#InactiveQueryException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InactiveQuery", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The specified query cannot be canceled because it is in the FINISHED,\n FAILED, TIMED_OUT, or CANCELLED state.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#IngestionStatus": { - "type": "structure", - "members": { - "LatestIngestionSuccessTime": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

The time stamp of the most recent successful ingestion of events for the channel.

" - } - }, - "LatestIngestionSuccessEventID": { - "target": "com.amazonaws.cloudtrail#UUID", - "traits": { - "smithy.api#documentation": "

The event ID of the most recent successful ingestion of events.

" - } - }, - "LatestIngestionErrorCode": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

The error code for the most recent failure to ingest events.

" - } - }, - "LatestIngestionAttemptTime": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

The time stamp of the most recent attempt to ingest events on the channel.

" - } - }, - "LatestIngestionAttemptEventID": { - "target": "com.amazonaws.cloudtrail#UUID", - "traits": { - "smithy.api#documentation": "

The event ID of the most recent attempt to ingest events.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A table showing information about the most recent successful and failed attempts \n to ingest events.

" - } - }, - "com.amazonaws.cloudtrail#InsightNotEnabledException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InsightNotEnabled", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

If you run GetInsightSelectors on a trail that does not have Insights\n events enabled, the operation throws the exception\n InsightNotEnabledException.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#InsightSelector": { - "type": "structure", - "members": { - "InsightType": { - "target": "com.amazonaws.cloudtrail#InsightType", - "traits": { - "smithy.api#documentation": "

The type of Insights events to log on a trail. ApiCallRateInsight and\n ApiErrorRateInsight are valid Insight types.

\n

The ApiCallRateInsight Insights type analyzes write-only\n management API calls that are aggregated per minute against a baseline API call volume.

\n

The ApiErrorRateInsight Insights type analyzes management\n API calls that result in error codes. The error is shown if the API call is\n unsuccessful.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A JSON string that contains a list of Insights types that are logged on a trail.

" - } - }, - "com.amazonaws.cloudtrail#InsightSelectors": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudtrail#InsightSelector" - } - }, - "com.amazonaws.cloudtrail#InsightType": { - "type": "enum", - "members": { - "ApiCallRateInsight": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ApiCallRateInsight" - } - }, - "ApiErrorRateInsight": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ApiErrorRateInsight" - } - } - } - }, - "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InsufficientDependencyServiceAccessPermission", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This exception is thrown when the IAM identity that is used to create\n the organization resource lacks one or more required permissions for creating an\n organization resource in a required service.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InsufficientEncryptionPolicy", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This exception is thrown when the policy on the S3 bucket or KMS key does\n not have sufficient permissions for the operation.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#InsufficientS3BucketPolicyException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InsufficientS3BucketPolicy", - "httpResponseCode": 403 - }, - "smithy.api#documentation": "

This exception is thrown when the policy on the S3 bucket is not sufficient.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.cloudtrail#InsufficientSnsTopicPolicyException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InsufficientSnsTopicPolicy", - "httpResponseCode": 403 - }, - "smithy.api#documentation": "

This exception is thrown when the policy on the Amazon SNS topic is not\n sufficient.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.cloudtrail#Integer": { - "type": "integer" - }, - "com.amazonaws.cloudtrail#InvalidCloudWatchLogsLogGroupArnException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidCloudWatchLogsLogGroupArn", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This exception is thrown when the provided CloudWatch Logs log group is not\n valid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#InvalidCloudWatchLogsRoleArnException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidCloudWatchLogsRoleArn", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This exception is thrown when the provided role is not valid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#InvalidDateRangeException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidDateRange", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

A date range for the query was specified that is not valid. Be sure that the start time\n is chronologically before the end time. For more information about writing a query, see\n Create or edit a query in the CloudTrail User Guide.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#InvalidEventCategoryException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidEventCategory", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

Occurs if an event category that is not valid is specified as a value of\n EventCategory.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#InvalidEventDataStoreCategoryException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidEventDataStoreCategory", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This exception is thrown when event categories of specified event data stores are not\n valid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#InvalidEventDataStoreStatusException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidEventDataStoreStatus", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The event data store is not in a status that supports the operation.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#InvalidEventSelectorsException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidEventSelectors", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This exception is thrown when the PutEventSelectors operation is called\n with a number of event selectors, advanced event selectors, or data resources that is not\n valid. The combination of event selectors or advanced event selectors and data resources is\n not valid. A trail can have up to 5 event selectors. If a trail uses advanced event\n selectors, a maximum of 500 total values for all conditions in all advanced event selectors\n is allowed. A trail is limited to 250 data resources. These data resources can be\n distributed across event selectors, but the overall total cannot exceed 250.

\n

You can:

\n ", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#InvalidHomeRegionException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidHomeRegion", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This exception is thrown when an operation is called on a trail from a Region other than\n the Region in which the trail was created.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#InvalidImportSourceException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidImportSource", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This exception is thrown when the provided source S3 bucket is not valid for import.\n

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#InvalidInsightSelectorsException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidInsightSelectors", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The formatting or syntax of the InsightSelectors JSON statement in your\n PutInsightSelectors or GetInsightSelectors request is not\n valid, or the specified insight type in the InsightSelectors statement is not\n a valid insight type.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#InvalidKmsKeyIdException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidKmsKeyId", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This exception is thrown when the KMS key ARN is not valid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#InvalidLookupAttributesException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidLookupAttributes", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

Occurs when a lookup attribute is specified that is not valid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#InvalidMaxResultsException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidMaxResults", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This exception is thrown if the limit specified is not valid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#InvalidNextTokenException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidNextToken", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

A token that is not valid, or a token that was previously used in a request with\n different parameters. This exception is thrown if the token is not valid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#InvalidParameterCombinationException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidParameterCombinationError", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This exception is thrown when the combination of parameters provided is not\n valid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#InvalidParameterException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidParameter", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The request includes a parameter that is not valid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#InvalidQueryStatementException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidQueryStatement", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The query that was submitted has validation errors, or uses incorrect syntax or\n unsupported keywords. For more information about writing a query, see Create or edit a query in the CloudTrail User\n Guide.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#InvalidQueryStatusException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidQueryStatus", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The query status is not valid for the operation.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#InvalidS3BucketNameException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidS3BucketName", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This exception is thrown when the provided S3 bucket name is not valid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#InvalidS3PrefixException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidS3Prefix", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This exception is thrown when the provided S3 prefix is not valid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#InvalidSnsTopicNameException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidSnsTopicName", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This exception is thrown when the provided SNS topic name is not valid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#InvalidSourceException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidSource", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This exception is thrown when the specified value of Source is not valid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#InvalidTagParameterException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidTagParameter", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This exception is thrown when the specified tag key or values are not valid. It can also\n occur if there are duplicate tags or too many tags on the resource.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#InvalidTimeRangeException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidTimeRange", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

Occurs if the timestamp values are not valid. Either the start time occurs after the end\n time, or the time range is outside the range of possible values.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#InvalidTokenException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidToken", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

Reserved for future use.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#InvalidTrailNameException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidTrailName", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This exception is thrown when the provided trail name is not valid. Trail names must\n meet the following requirements:

\n ", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#KmsException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "KmsException", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This exception is thrown when there is an issue with the specified KMS\n key and the trail or event data store can't be updated.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#KmsKeyDisabledException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "KmsKeyDisabled", - "httpResponseCode": 400 - }, - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

This exception is no longer in use.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#KmsKeyNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "KmsKeyNotFound", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This exception is thrown when the KMS key does not exist, when the S3\n bucket and the KMS key are not in the same Region, or when the KMS key associated with the Amazon SNS topic either does not exist or is\n not in the same Region.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#ListChannels": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#ListChannelsRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#ListChannelsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the channels in the current account, and their source names. \n

", - "smithy.api#idempotent": {}, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.cloudtrail#ListChannelsMaxResultsCount": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.cloudtrail#ListChannelsRequest": { - "type": "structure", - "members": { - "MaxResults": { - "target": "com.amazonaws.cloudtrail#ListChannelsMaxResultsCount", - "traits": { - "smithy.api#documentation": "

The maximum number of CloudTrail channels to display on a single page.

" - } - }, - "NextToken": { - "target": "com.amazonaws.cloudtrail#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token to use to get the next page of results after a previous API call. This token\n must be passed in with the same parameters that were specified in the original call. For\n example, if the original call specified an AttributeKey of 'Username' with a value of\n 'root', the call with NextToken should include those same parameters.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#ListChannelsResponse": { - "type": "structure", - "members": { - "Channels": { - "target": "com.amazonaws.cloudtrail#Channels", - "traits": { - "smithy.api#documentation": "

The list of channels in the account.

" - } - }, - "NextToken": { - "target": "com.amazonaws.cloudtrail#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token to use to get the next page of results after a previous API call.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#ListEventDataStores": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#ListEventDataStoresRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#ListEventDataStoresResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#InvalidMaxResultsException" - }, - { - "target": "com.amazonaws.cloudtrail#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" - }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about all event data stores in the account, in the current\n Region.

", - "smithy.api#idempotent": {}, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.cloudtrail#ListEventDataStoresMaxResultsCount": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.cloudtrail#ListEventDataStoresRequest": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.cloudtrail#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token you can use to get the next page of event data store results.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.cloudtrail#ListEventDataStoresMaxResultsCount", - "traits": { - "smithy.api#documentation": "

The maximum number of event data stores to display on a single page.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#ListEventDataStoresResponse": { - "type": "structure", - "members": { - "EventDataStores": { - "target": "com.amazonaws.cloudtrail#EventDataStores", - "traits": { - "smithy.api#documentation": "

Contains information about event data stores in the account, in the current\n Region.

" - } - }, - "NextToken": { - "target": "com.amazonaws.cloudtrail#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token you can use to get the next page of results.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#ListImportFailures": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#ListImportFailuresRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#ListImportFailuresResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of failures for the specified import.

", - "smithy.api#idempotent": {}, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Failures", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.cloudtrail#ListImportFailuresMaxResultsCount": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.cloudtrail#ListImportFailuresRequest": { - "type": "structure", - "members": { - "ImportId": { - "target": "com.amazonaws.cloudtrail#UUID", - "traits": { - "smithy.api#documentation": "

The ID of the import.

", - "smithy.api#required": {} - } - }, - "MaxResults": { - "target": "com.amazonaws.cloudtrail#ListImportFailuresMaxResultsCount", - "traits": { - "smithy.api#documentation": "

The maximum number of failures to display on a single page.

" - } - }, - "NextToken": { - "target": "com.amazonaws.cloudtrail#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token you can use to get the next page of import failures.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#ListImportFailuresResponse": { - "type": "structure", - "members": { - "Failures": { - "target": "com.amazonaws.cloudtrail#ImportFailureList", - "traits": { - "smithy.api#documentation": "

Contains information about the import failures.

" - } - }, - "NextToken": { - "target": "com.amazonaws.cloudtrail#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token you can use to get the next page of results.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#ListImports": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#ListImportsRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#ListImportsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" - }, - { - "target": "com.amazonaws.cloudtrail#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.cloudtrail#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information on all imports, or a select set of imports by\n ImportStatus or Destination.

", - "smithy.api#idempotent": {}, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Imports", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.cloudtrail#ListImportsMaxResultsCount": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.cloudtrail#ListImportsRequest": { - "type": "structure", - "members": { - "MaxResults": { - "target": "com.amazonaws.cloudtrail#ListImportsMaxResultsCount", - "traits": { - "smithy.api#documentation": "

The maximum number of imports to display on a single page.

" - } - }, - "Destination": { - "target": "com.amazonaws.cloudtrail#EventDataStoreArn", - "traits": { - "smithy.api#documentation": "

The ARN of the destination event data store.

" - } - }, - "ImportStatus": { - "target": "com.amazonaws.cloudtrail#ImportStatus", - "traits": { - "smithy.api#documentation": "

The status of the import.

" - } - }, - "NextToken": { - "target": "com.amazonaws.cloudtrail#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token you can use to get the next page of import results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#ListImportsResponse": { - "type": "structure", - "members": { - "Imports": { - "target": "com.amazonaws.cloudtrail#ImportsList", - "traits": { - "smithy.api#documentation": "

The list of returned imports.

" - } - }, - "NextToken": { - "target": "com.amazonaws.cloudtrail#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token you can use to get the next page of import results.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#ListPublicKeys": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#ListPublicKeysRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#ListPublicKeysResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#InvalidTimeRangeException" - }, - { - "target": "com.amazonaws.cloudtrail#InvalidTokenException" - }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns all public keys whose private keys were used to sign the digest files within the\n specified time range. The public key is needed to validate digest files that were signed\n with its corresponding private key.

\n \n

CloudTrail uses different private and public key pairs per Region. Each digest\n file is signed with a private key unique to its Region. When you validate a digest file\n from a specific Region, you must look in the same Region for its corresponding public\n key.

\n ", - "smithy.api#idempotent": {}, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "PublicKeyList" - } - } - }, - "com.amazonaws.cloudtrail#ListPublicKeysRequest": { - "type": "structure", - "members": { - "StartTime": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

Optionally specifies, in UTC, the start of the time range to look up public keys for\n CloudTrail digest files. If not specified, the current time is used, and the\n current public key is returned.

" - } - }, - "EndTime": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

Optionally specifies, in UTC, the end of the time range to look up public keys for\n CloudTrail digest files. If not specified, the current time is used.

" - } - }, - "NextToken": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Reserved for future use.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Requests the public keys for a specified time range.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#ListPublicKeysResponse": { - "type": "structure", - "members": { - "PublicKeyList": { - "target": "com.amazonaws.cloudtrail#PublicKeyList", - "traits": { - "smithy.api#documentation": "

Contains an array of PublicKey objects.

\n \n

The returned public keys may have validity time ranges that overlap.

\n " - } - }, - "NextToken": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Reserved for future use.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Returns the objects or data listed below if successful. Otherwise, returns an\n error.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#ListQueries": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#ListQueriesRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#ListQueriesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + "com.amazonaws.cloudtrail#ImportSource": { + "type": "structure", + "members": { + "S3": { + "target": "com.amazonaws.cloudtrail#S3ImportSource", + "traits": { + "smithy.api#documentation": "

The source S3 bucket.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The import source.

" + } }, - { - "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + "com.amazonaws.cloudtrail#ImportStatistics": { + "type": "structure", + "members": { + "PrefixesFound": { + "target": "com.amazonaws.cloudtrail#Long", + "traits": { + "smithy.api#documentation": "

The number of S3 prefixes found for the import.

" + } + }, + "PrefixesCompleted": { + "target": "com.amazonaws.cloudtrail#Long", + "traits": { + "smithy.api#documentation": "

The number of S3 prefixes that completed import.

" + } + }, + "FilesCompleted": { + "target": "com.amazonaws.cloudtrail#Long", + "traits": { + "smithy.api#documentation": "

The number of log files that completed import.

" + } + }, + "EventsCompleted": { + "target": "com.amazonaws.cloudtrail#Long", + "traits": { + "smithy.api#documentation": "

The number of trail events imported into the event data store.

" + } + }, + "FailedEntries": { + "target": "com.amazonaws.cloudtrail#Long", + "traits": { + "smithy.api#documentation": "

The number of failed entries.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides statistics for the specified ImportID. CloudTrail does not\n update import statistics in real-time. Returned values for parameters such as\n EventsCompleted may be lower than the actual value, because CloudTrail updates statistics incrementally over the course of the import.

" + } }, - { - "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + "com.amazonaws.cloudtrail#ImportStatus": { + "type": "enum", + "members": { + "INITIALIZING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INITIALIZING" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + } + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidDateRangeException" + "com.amazonaws.cloudtrail#ImportsList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#ImportsListItem" + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidMaxResultsException" + "com.amazonaws.cloudtrail#ImportsListItem": { + "type": "structure", + "members": { + "ImportId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The ID of the import.

" + } + }, + "ImportStatus": { + "target": "com.amazonaws.cloudtrail#ImportStatus", + "traits": { + "smithy.api#documentation": "

The status of the import.

" + } + }, + "Destinations": { + "target": "com.amazonaws.cloudtrail#ImportDestinations", + "traits": { + "smithy.api#documentation": "

The ARN of the destination event data store.

" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The timestamp of the import's creation.

" + } + }, + "UpdatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The timestamp of the import's last update.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an import that was returned by a lookup request.

" + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidNextTokenException" + "com.amazonaws.cloudtrail#InactiveEventDataStoreException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InactiveEventDataStore", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The event data store is inactive.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidParameterException" + "com.amazonaws.cloudtrail#InactiveQueryException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InactiveQuery", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified query cannot be canceled because it is in the FINISHED,\n FAILED, TIMED_OUT, or CANCELLED state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidQueryStatusException" + "com.amazonaws.cloudtrail#IngestionStatus": { + "type": "structure", + "members": { + "LatestIngestionSuccessTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The time stamp of the most recent successful ingestion of events for the channel.

" + } + }, + "LatestIngestionSuccessEventID": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The event ID of the most recent successful ingestion of events.

" + } + }, + "LatestIngestionErrorCode": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The error code for the most recent failure to ingest events.

" + } + }, + "LatestIngestionAttemptTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The time stamp of the most recent attempt to ingest events on the channel.

" + } + }, + "LatestIngestionAttemptEventID": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The event ID of the most recent attempt to ingest events.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A table showing information about the most recent successful and failed attempts \n to ingest events.

" + } }, - { - "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + "com.amazonaws.cloudtrail#InsightNotEnabledException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InsightNotEnabled", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

If you run GetInsightSelectors on a trail that does not have Insights\n events enabled, the operation throws the exception\n InsightNotEnabledException.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + "com.amazonaws.cloudtrail#InsightSelector": { + "type": "structure", + "members": { + "InsightType": { + "target": "com.amazonaws.cloudtrail#InsightType", + "traits": { + "smithy.api#documentation": "

The type of Insights events to log on a trail. ApiCallRateInsight and\n ApiErrorRateInsight are valid Insight types.

\n

The ApiCallRateInsight Insights type analyzes write-only\n management API calls that are aggregated per minute against a baseline API call volume.

\n

The ApiErrorRateInsight Insights type analyzes management\n API calls that result in error codes. The error is shown if the API call is\n unsuccessful.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A JSON string that contains a list of Insights types that are logged on a trail.

" + } }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of queries and query statuses for the past seven days. You must specify\n an ARN value for EventDataStore. Optionally, to shorten the list of results,\n you can specify a time range, formatted as timestamps, by adding StartTime and\n EndTime parameters, and a QueryStatus value. Valid values for\n QueryStatus include QUEUED, RUNNING,\n FINISHED, FAILED, TIMED_OUT, or\n CANCELLED.

", - "smithy.api#idempotent": {}, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.cloudtrail#ListQueriesMaxResultsCount": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.cloudtrail#ListQueriesRequest": { - "type": "structure", - "members": { - "EventDataStore": { - "target": "com.amazonaws.cloudtrail#EventDataStoreArn", - "traits": { - "smithy.api#documentation": "

The ARN (or the ID suffix of the ARN) of an event data store on which queries were\n run.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.cloudtrail#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token you can use to get the next page of results.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.cloudtrail#ListQueriesMaxResultsCount", - "traits": { - "smithy.api#documentation": "

The maximum number of queries to show on a page.

" - } - }, - "StartTime": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

Use with EndTime to bound a ListQueries request, and limit its\n results to only those queries run within a specified time period.

" - } - }, - "EndTime": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

Use with StartTime to bound a ListQueries request, and limit\n its results to only those queries run within a specified time period.

" - } - }, - "QueryStatus": { - "target": "com.amazonaws.cloudtrail#QueryStatus", - "traits": { - "smithy.api#documentation": "

The status of queries that you want to return in results. Valid values for\n QueryStatus include QUEUED, RUNNING,\n FINISHED, FAILED, TIMED_OUT, or\n CANCELLED.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#ListQueriesResponse": { - "type": "structure", - "members": { - "Queries": { - "target": "com.amazonaws.cloudtrail#Queries", - "traits": { - "smithy.api#documentation": "

Lists matching query results, and shows query ID, status, and creation time of each\n query.

" - } - }, - "NextToken": { - "target": "com.amazonaws.cloudtrail#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token you can use to get the next page of results.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#ListTags": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#ListTagsRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#ListTagsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#ChannelARNInvalidException" + "com.amazonaws.cloudtrail#InsightSelectors": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#InsightSelector" + } }, - { - "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + "com.amazonaws.cloudtrail#InsightType": { + "type": "enum", + "members": { + "ApiCallRateInsight": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ApiCallRateInsight" + } + }, + "ApiErrorRateInsight": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ApiErrorRateInsight" + } + } + } }, - { - "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientDependencyServiceAccessPermission", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the IAM identity that is used to create\n the organization resource lacks one or more required permissions for creating an\n organization resource in a required service.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientEncryptionPolicy", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the policy on the S3 bucket or KMS key does\n not have sufficient permissions for the operation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + "com.amazonaws.cloudtrail#InsufficientS3BucketPolicyException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientS3BucketPolicy", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

This exception is thrown when the policy on the S3 bucket is not sufficient.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidTokenException" + "com.amazonaws.cloudtrail#InsufficientSnsTopicPolicyException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientSnsTopicPolicy", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

This exception is thrown when the policy on the Amazon SNS topic is not\n sufficient.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + "com.amazonaws.cloudtrail#Integer": { + "type": "integer" }, - { - "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + "com.amazonaws.cloudtrail#InvalidCloudWatchLogsLogGroupArnException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidCloudWatchLogsLogGroupArn", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the provided CloudWatch Logs log group is not\n valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + "com.amazonaws.cloudtrail#InvalidCloudWatchLogsRoleArnException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidCloudWatchLogsRoleArn", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the provided role is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#ResourceNotFoundException" + "com.amazonaws.cloudtrail#InvalidDateRangeException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDateRange", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

A date range for the query was specified that is not valid. Be sure that the start time\n is chronologically before the end time. For more information about writing a query, see\n Create or edit a query in the CloudTrail User Guide.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#ResourceTypeNotSupportedException" + "com.amazonaws.cloudtrail#InvalidEventCategoryException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidEventCategory", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Occurs if an event category that is not valid is specified as a value of\n EventCategory.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the tags for the specified trails, event data stores, or channels in the current Region.

", - "smithy.api#idempotent": {}, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ResourceTagList" - } - } - }, - "com.amazonaws.cloudtrail#ListTagsRequest": { - "type": "structure", - "members": { - "ResourceIdList": { - "target": "com.amazonaws.cloudtrail#ResourceIdList", - "traits": { - "smithy.api#documentation": "

Specifies a list of trail, event data store, or channel ARNs whose tags will be listed. The list\n has a limit of 20 ARNs.

\n

Example trail ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

\n

Example event data store ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE\n

\n

Example channel ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890\n

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Reserved for future use.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies a list of tags to return.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#ListTagsResponse": { - "type": "structure", - "members": { - "ResourceTagList": { - "target": "com.amazonaws.cloudtrail#ResourceTagList", - "traits": { - "smithy.api#documentation": "

A list of resource tags.

" - } - }, - "NextToken": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Reserved for future use.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Returns the objects or data listed below if successful. Otherwise, returns an\n error.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#ListTrails": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#ListTrailsRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#ListTrailsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists trails that are in the current account.

", - "smithy.api#idempotent": {}, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Trails" - } - } - }, - "com.amazonaws.cloudtrail#ListTrailsRequest": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

The token to use to get the next page of results after a previous API call. This token\n must be passed in with the same parameters that were specified in the original call. For\n example, if the original call specified an AttributeKey of 'Username' with a value of\n 'root', the call with NextToken should include those same parameters.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#ListTrailsResponse": { - "type": "structure", - "members": { - "Trails": { - "target": "com.amazonaws.cloudtrail#Trails", - "traits": { - "smithy.api#documentation": "

Returns the name, ARN, and home Region of trails in the current account.

" - } - }, - "NextToken": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

The token to use to get the next page of results after a previous API call. If the token\n does not appear, there are no more results to return. The token must be passed in with the\n same parameters as the previous call. For example, if the original call specified an\n AttributeKey of 'Username' with a value of 'root', the call with NextToken should include\n those same parameters.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#Location": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 1024 - }, - "smithy.api#pattern": "^[a-zA-Z0-9._/\\-:]+$" - } - }, - "com.amazonaws.cloudtrail#Long": { - "type": "long" - }, - "com.amazonaws.cloudtrail#LookupAttribute": { - "type": "structure", - "members": { - "AttributeKey": { - "target": "com.amazonaws.cloudtrail#LookupAttributeKey", - "traits": { - "smithy.api#documentation": "

Specifies an attribute on which to filter the events returned.

", - "smithy.api#required": {} - } - }, - "AttributeValue": { - "target": "com.amazonaws.cloudtrail#LookupAttributeValue", - "traits": { - "smithy.api#documentation": "

Specifies a value for the specified AttributeKey.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies an attribute and value that filter the events returned.

" - } - }, - "com.amazonaws.cloudtrail#LookupAttributeKey": { - "type": "enum", - "members": { - "EVENT_ID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EventId" - } - }, - "EVENT_NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EventName" - } - }, - "READ_ONLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ReadOnly" - } - }, - "USERNAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Username" - } - }, - "RESOURCE_TYPE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ResourceType" - } - }, - "RESOURCE_NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ResourceName" - } - }, - "EVENT_SOURCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EventSource" - } - }, - "ACCESS_KEY_ID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AccessKeyId" - } - } - } - }, - "com.amazonaws.cloudtrail#LookupAttributeValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2000 - } - } - }, - "com.amazonaws.cloudtrail#LookupAttributesList": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudtrail#LookupAttribute" - } - }, - "com.amazonaws.cloudtrail#LookupEvents": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#LookupEventsRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#LookupEventsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#InvalidEventCategoryException" - }, - { - "target": "com.amazonaws.cloudtrail#InvalidLookupAttributesException" - }, - { - "target": "com.amazonaws.cloudtrail#InvalidMaxResultsException" - }, - { - "target": "com.amazonaws.cloudtrail#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.cloudtrail#InvalidTimeRangeException" - }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Looks up management events or CloudTrail Insights events that are captured by CloudTrail.\n You can look up events that occurred in a Region within the last 90 days. Lookup supports\n the following attributes for management events:

\n \n

Lookup supports the following attributes for Insights events:

\n \n

All attributes are optional. The default number of results returned is 50, with a\n maximum of 50 possible. The response includes a token that you can use to get the next page\n of results.

\n \n

The rate of lookup requests is limited to two per second, per account, per Region. If\n this limit is exceeded, a throttling error occurs.

\n ", - "smithy.api#idempotent": {}, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Events", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.cloudtrail#LookupEventsRequest": { - "type": "structure", - "members": { - "LookupAttributes": { - "target": "com.amazonaws.cloudtrail#LookupAttributesList", - "traits": { - "smithy.api#documentation": "

Contains a list of lookup attributes. Currently the list can contain only one\n item.

" - } - }, - "StartTime": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

Specifies that only events that occur after or at the specified time are returned. If\n the specified start time is after the specified end time, an error is returned.

" - } - }, - "EndTime": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

Specifies that only events that occur before or at the specified time are returned. If\n the specified end time is before the specified start time, an error is returned.

" - } - }, - "EventCategory": { - "target": "com.amazonaws.cloudtrail#EventCategory", - "traits": { - "smithy.api#documentation": "

Specifies the event category. If you do not specify an event category, events of the\n category are not returned in the response. For example, if you do not specify\n insight as the value of EventCategory, no Insights events are\n returned.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.cloudtrail#MaxResults", - "traits": { - "smithy.api#documentation": "

The number of events to return. Possible values are 1 through 50. The default is\n 50.

" - } - }, - "NextToken": { - "target": "com.amazonaws.cloudtrail#NextToken", - "traits": { - "smithy.api#documentation": "

The token to use to get the next page of results after a previous API call. This token\n must be passed in with the same parameters that were specified in the original call. For\n example, if the original call specified an AttributeKey of 'Username' with a value of\n 'root', the call with NextToken should include those same parameters.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains a request for LookupEvents.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#LookupEventsResponse": { - "type": "structure", - "members": { - "Events": { - "target": "com.amazonaws.cloudtrail#EventsList", - "traits": { - "smithy.api#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\n first.

" - } - }, - "NextToken": { - "target": "com.amazonaws.cloudtrail#NextToken", - "traits": { - "smithy.api#documentation": "

The token to use to get the next page of results after a previous API call. If the token\n does not appear, there are no more results to return. The token must be passed in with the\n same parameters as the previous call. For example, if the original call specified an\n AttributeKey of 'Username' with a value of 'root', the call with NextToken should include\n those same parameters.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains a response to a LookupEvents action.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#MaxConcurrentQueriesException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "MaxConcurrentQueries", - "httpResponseCode": 429 - }, - "smithy.api#documentation": "

You are already running the maximum number of concurrent queries. Wait a minute for some\n queries to finish, and then run the query again.

", - "smithy.api#error": "client", - "smithy.api#httpError": 429 - } - }, - "com.amazonaws.cloudtrail#MaxQueryResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.cloudtrail#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.cloudtrail#MaximumNumberOfTrailsExceededException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "MaximumNumberOfTrailsExceeded", - "httpResponseCode": 403 - }, - "smithy.api#documentation": "

This exception is thrown when the maximum number of trails is reached.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.cloudtrail#NextToken": { - "type": "string" - }, - "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "NoManagementAccountSLRExists", - "httpResponseCode": 403 - }, - "smithy.api#documentation": "

This exception is thrown when the management account does not have a service-linked\n role.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.cloudtrail#NotOrganizationManagementAccountException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "NotOrganizationManagementAccount", - "httpResponseCode": 403 - }, - "smithy.api#documentation": "

This exception is thrown when the account making the request is not the organization's\n management account.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "NotOrganizationMasterAccount", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This exception is thrown when the Amazon Web Services account making the request to\n create or update an organization trail or event data store is not the management account\n for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#OperationNotPermittedException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "OperationNotPermitted", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This exception is thrown when the requested operation is not permitted.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#Operator": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudtrail#OperatorValue" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.cloudtrail#OperatorValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^.+$" - } - }, - "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "OrganizationNotInAllFeaturesMode", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This exception is thrown when Organizations is not configured to support all\n features. All features must be enabled in Organizations to support creating an\n organization trail or event data store.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#OrganizationsNotInUseException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "OrganizationsNotInUse", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

This exception is thrown when the request is made from an Amazon Web Services account\n that is not a member of an organization. To make this request, sign in using the\n credentials of an account that belongs to an organization.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.cloudtrail#PaginationToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 4, - "max": 1000 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.cloudtrail#PublicKey": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.cloudtrail#ByteBuffer", - "traits": { - "smithy.api#documentation": "

The DER encoded public key value in PKCS#1 format.

" - } - }, - "ValidityStartTime": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

The starting time of validity of the public key.

" - } - }, - "ValidityEndTime": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

The ending time of validity of the public key.

" - } - }, - "Fingerprint": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

The fingerprint of the public key.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about a returned public key.

" - } - }, - "com.amazonaws.cloudtrail#PublicKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudtrail#PublicKey" - } - }, - "com.amazonaws.cloudtrail#PutEventSelectors": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#PutEventSelectorsRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#PutEventSelectorsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + "com.amazonaws.cloudtrail#InvalidEventDataStoreCategoryException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidEventDataStoreCategory", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when event categories of specified event data stores are not\n valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#ConflictException" + "com.amazonaws.cloudtrail#InvalidEventDataStoreStatusException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidEventDataStoreStatus", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The event data store is not in a status that supports the operation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + "com.amazonaws.cloudtrail#InvalidEventSelectorsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidEventSelectors", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the PutEventSelectors operation is called\n with a number of event selectors, advanced event selectors, or data resources that is not\n valid. The combination of event selectors or advanced event selectors and data resources is\n not valid. A trail can have up to 5 event selectors. If a trail uses advanced event\n selectors, a maximum of 500 total values for all conditions in all advanced event selectors\n is allowed. A trail is limited to 250 data resources. These data resources can be\n distributed across event selectors, but the overall total cannot exceed 250.

\n

You can:

\n ", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidEventSelectorsException" + "com.amazonaws.cloudtrail#InvalidHomeRegionException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidHomeRegion", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when an operation is called on a trail from a Region other than\n the Region in which the trail was created.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidHomeRegionException" + "com.amazonaws.cloudtrail#InvalidImportSourceException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidImportSource", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the provided source S3 bucket is not valid for import.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + "com.amazonaws.cloudtrail#InvalidInsightSelectorsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidInsightSelectors", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The formatting or syntax of the InsightSelectors JSON statement in your\n PutInsightSelectors or GetInsightSelectors request is not\n valid, or the specified insight type in the InsightSelectors statement is not\n a valid insight type.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + "com.amazonaws.cloudtrail#InvalidKmsKeyIdException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidKmsKeyId", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the KMS key ARN is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + "com.amazonaws.cloudtrail#InvalidLookupAttributesException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidLookupAttributes", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Occurs when a lookup attribute is specified that is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + "com.amazonaws.cloudtrail#InvalidMaxResultsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidMaxResults", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown if the limit specified is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#TrailNotFoundException" + "com.amazonaws.cloudtrail#InvalidNextTokenException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidNextToken", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

A token that is not valid, or a token that was previously used in a request with\n different parameters. This exception is thrown if the token is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Configures an event selector or advanced event selectors for your trail. Use event\n selectors or advanced event selectors to specify management and data event settings for\n your trail. If you want your trail to log Insights events, be sure the event selector \n enables logging of the Insights event types you want configured for your trail. For more information about logging Insights events, see Logging Insights events for trails in the CloudTrail User Guide.\n By default, trails created without specific event selectors are configured to\n log all read and write management events, and no data events.

\n

When an event occurs in your account, CloudTrail evaluates the event selectors or\n advanced event selectors in all trails. For each trail, if the event matches any event\n selector, the trail processes and logs the event. If the event doesn't match any event\n selector, the trail doesn't log the event.

\n

Example

\n
    \n
  1. \n

    You create an event selector for a trail and specify that you want write-only\n events.

    \n
    2. \n
  2. \n

    The EC2 GetConsoleOutput and RunInstances API operations\n occur in your account.

    \n
    3. \n
  3. \n

    CloudTrail evaluates whether the events match your event selectors.

    \n
    4. \n
  4. \n

    The RunInstances is a write-only event and it matches your event\n selector. The trail logs the event.

    \n
    5. \n
  5. \n

    The GetConsoleOutput is a read-only event that doesn't match your\n event selector. The trail doesn't log the event.

    \n
    6. \n
\n

The PutEventSelectors operation must be called from the Region in which the\n trail was created; otherwise, an InvalidHomeRegionException exception is\n thrown.

\n

You can configure up to five event selectors for each trail. For more information, see\n Logging management events, Logging\n data events, and Quotas in CloudTrail in the CloudTrail User\n Guide.

\n

You can add advanced event selectors, and conditions for your advanced event selectors,\n up to a maximum of 500 values for all conditions and selectors on a trail. You can use\n either AdvancedEventSelectors or EventSelectors, but not both. If\n you apply AdvancedEventSelectors to a trail, any existing\n EventSelectors are overwritten. For more information about advanced event\n selectors, see Logging data events in the CloudTrail User Guide.

", - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.cloudtrail#PutEventSelectorsRequest": { - "type": "structure", - "members": { - "TrailName": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the trail or trail ARN. If you specify a trail name, the string\n must meet the following requirements:

\n \n

If you specify a trail ARN, it must be in the following format.

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

", - "smithy.api#required": {} - } - }, - "EventSelectors": { - "target": "com.amazonaws.cloudtrail#EventSelectors", - "traits": { - "smithy.api#documentation": "

Specifies the settings for your event selectors. You can configure up to five event\n selectors for a trail. You can use either EventSelectors or\n AdvancedEventSelectors in a PutEventSelectors request, but not\n both. If you apply EventSelectors to a trail, any existing\n AdvancedEventSelectors are overwritten.

" - } - }, - "AdvancedEventSelectors": { - "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", - "traits": { - "smithy.api#documentation": "

Specifies the settings for advanced event selectors. You can add advanced event\n selectors, and conditions for your advanced event selectors, up to a maximum of 500 values\n for all conditions and selectors on a trail. You can use either\n AdvancedEventSelectors or EventSelectors, but not both. If you\n apply AdvancedEventSelectors to a trail, any existing\n EventSelectors are overwritten. For more information about advanced event\n selectors, see Logging data events in the CloudTrail User Guide.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#PutEventSelectorsResponse": { - "type": "structure", - "members": { - "TrailARN": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the ARN of the trail that was updated with event selectors. The following is\n the format of a trail ARN.

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

" - } - }, - "EventSelectors": { - "target": "com.amazonaws.cloudtrail#EventSelectors", - "traits": { - "smithy.api#documentation": "

Specifies the event selectors configured for your trail.

" - } - }, - "AdvancedEventSelectors": { - "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", - "traits": { - "smithy.api#documentation": "

Specifies the advanced event selectors configured for your trail.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#PutInsightSelectors": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#PutInsightSelectorsRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#PutInsightSelectorsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + "com.amazonaws.cloudtrail#InvalidParameterCombinationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidParameterCombinationError", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the combination of parameters provided is not\n valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" + "com.amazonaws.cloudtrail#InvalidParameterException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidParameter", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request includes a parameter that is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#InsufficientS3BucketPolicyException" + "com.amazonaws.cloudtrail#InvalidQueryStatementException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidQueryStatement", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The query that was submitted has validation errors, or uses incorrect syntax or\n unsupported keywords. For more information about writing a query, see Create or edit a query in the CloudTrail User\n Guide.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidHomeRegionException" + "com.amazonaws.cloudtrail#InvalidQueryStatusException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidQueryStatus", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The query status is not valid for the operation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidInsightSelectorsException" + "com.amazonaws.cloudtrail#InvalidS3BucketNameException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidS3BucketName", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the provided S3 bucket name is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + "com.amazonaws.cloudtrail#InvalidS3PrefixException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidS3Prefix", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the provided S3 prefix is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#KmsException" + "com.amazonaws.cloudtrail#InvalidSnsTopicNameException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidSnsTopicName", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the provided SNS topic name is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + "com.amazonaws.cloudtrail#InvalidSourceException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidSource", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the specified value of Source is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + "com.amazonaws.cloudtrail#InvalidTagParameterException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidTagParameter", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the specified tag key or values are not valid. It can also\n occur if there are duplicate tags or too many tags on the resource.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + "com.amazonaws.cloudtrail#InvalidTimeRangeException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidTimeRange", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Occurs if the timestamp values are not valid. Either the start time occurs after the end\n time, or the time range is outside the range of possible values.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#S3BucketDoesNotExistException" + "com.amazonaws.cloudtrail#InvalidTokenException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidToken", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Reserved for future use.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#TrailNotFoundException" + "com.amazonaws.cloudtrail#InvalidTrailNameException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidTrailName", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the provided trail name is not valid. Trail names must\n meet the following requirements:

\n ", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lets you enable Insights event logging by specifying the Insights selectors that you\n want to enable on an existing trail. You also use PutInsightSelectors to turn\n off Insights event logging, by passing an empty list of insight types. The valid Insights\n event types in this release are ApiErrorRateInsight and\n ApiCallRateInsight.

\n

To log CloudTrail Insights events on API call volume, the trail\n must log write management events. To log CloudTrail\n Insights events on API error rate, the trail must log read or\n write management events. You can call GetEventSelectors on a trail \n to check whether the trail logs management events.

", - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.cloudtrail#PutInsightSelectorsRequest": { - "type": "structure", - "members": { - "TrailName": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

The name of the CloudTrail trail for which you want to change or add Insights\n selectors.

", - "smithy.api#required": {} - } - }, - "InsightSelectors": { - "target": "com.amazonaws.cloudtrail#InsightSelectors", - "traits": { - "smithy.api#documentation": "

A JSON string that contains the insight types you want to log on a trail.\n ApiCallRateInsight and ApiErrorRateInsight are valid Insight\n types.

\n

The ApiCallRateInsight Insights type analyzes write-only\n management API calls that are aggregated per minute against a baseline API call volume.

\n

The ApiErrorRateInsight Insights type analyzes management\n API calls that result in error codes. The error is shown if the API call is\n unsuccessful.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#PutInsightSelectorsResponse": { - "type": "structure", - "members": { - "TrailARN": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a trail for which you want to change or add Insights\n selectors.

" - } - }, - "InsightSelectors": { - "target": "com.amazonaws.cloudtrail#InsightSelectors", - "traits": { - "smithy.api#documentation": "

A JSON string that contains the Insights event types that you want to log on a trail.\n The valid Insights types in this release are ApiErrorRateInsight and\n ApiCallRateInsight.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#PutResourcePolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#PutResourcePolicyRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#PutResourcePolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.cloudtrail#ResourceARNNotValidException" - }, - { - "target": "com.amazonaws.cloudtrail#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudtrail#ResourcePolicyNotValidException" - }, - { - "target": "com.amazonaws.cloudtrail#ResourceTypeNotSupportedException" - }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Attaches a resource-based permission policy to a CloudTrail channel that is used for an integration with an event source outside of Amazon Web Services. For more information about resource-based policies, see \n CloudTrail resource-based policy examples \n in the CloudTrail User Guide.\n

", - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.cloudtrail#PutResourcePolicyRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.cloudtrail#ResourceArn", - "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the CloudTrail channel attached to the resource-based policy. \n The following is the format of a resource ARN: \n arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel.\n

", - "smithy.api#required": {} - } - }, - "ResourcePolicy": { - "target": "com.amazonaws.cloudtrail#ResourcePolicy", - "traits": { - "smithy.api#documentation": "

\n A JSON-formatted string for an Amazon Web Services resource-based policy.\n

\n

The following are requirements for the resource policy:

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#PutResourcePolicyResponse": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.cloudtrail#ResourceArn", - "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the CloudTrail channel attached to the resource-based policy.\n

" - } - }, - "ResourcePolicy": { - "target": "com.amazonaws.cloudtrail#ResourcePolicy", - "traits": { - "smithy.api#documentation": "

\n The JSON-formatted string of the Amazon Web Services resource-based policy attached to the CloudTrail channel.\n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#Queries": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudtrail#Query" - } - }, - "com.amazonaws.cloudtrail#Query": { - "type": "structure", - "members": { - "QueryId": { - "target": "com.amazonaws.cloudtrail#UUID", - "traits": { - "smithy.api#documentation": "

The ID of a query.

" - } - }, - "QueryStatus": { - "target": "com.amazonaws.cloudtrail#QueryStatus", - "traits": { - "smithy.api#documentation": "

The status of the query. This can be QUEUED, RUNNING,\n FINISHED, FAILED, TIMED_OUT, or\n CANCELLED.

" - } - }, - "CreationTime": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

The creation time of a query.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A SQL string of criteria about events that you want to collect in an event data\n store.

" - } - }, - "com.amazonaws.cloudtrail#QueryIdNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "QueryIdNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The query ID does not exist or does not map to a query.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.cloudtrail#QueryResultColumn": { - "type": "map", - "key": { - "target": "com.amazonaws.cloudtrail#QueryResultKey" - }, - "value": { - "target": "com.amazonaws.cloudtrail#QueryResultValue" - } - }, - "com.amazonaws.cloudtrail#QueryResultKey": { - "type": "string" - }, - "com.amazonaws.cloudtrail#QueryResultRow": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudtrail#QueryResultColumn" - } - }, - "com.amazonaws.cloudtrail#QueryResultRows": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudtrail#QueryResultRow" - } - }, - "com.amazonaws.cloudtrail#QueryResultValue": { - "type": "string" - }, - "com.amazonaws.cloudtrail#QueryStatement": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10000 - }, - "smithy.api#pattern": "^(?s)" - } - }, - "com.amazonaws.cloudtrail#QueryStatistics": { - "type": "structure", - "members": { - "ResultsCount": { - "target": "com.amazonaws.cloudtrail#Integer", - "traits": { - "smithy.api#documentation": "

The number of results returned.

" - } - }, - "TotalResultsCount": { - "target": "com.amazonaws.cloudtrail#Integer", - "traits": { - "smithy.api#documentation": "

The total number of results returned by a query.

" - } - }, - "BytesScanned": { - "target": "com.amazonaws.cloudtrail#Long", - "traits": { - "smithy.api#documentation": "

The total bytes that the query scanned in the event data store. This value matches the\n number of bytes for which your account is billed for the query, unless the query is still\n running.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Metadata about a query, such as the number of results.

" - } - }, - "com.amazonaws.cloudtrail#QueryStatisticsForDescribeQuery": { - "type": "structure", - "members": { - "EventsMatched": { - "target": "com.amazonaws.cloudtrail#Long", - "traits": { - "smithy.api#documentation": "

The number of events that matched a query.

" - } - }, - "EventsScanned": { - "target": "com.amazonaws.cloudtrail#Long", - "traits": { - "smithy.api#documentation": "

The number of events that the query scanned in the event data store.

" - } - }, - "BytesScanned": { - "target": "com.amazonaws.cloudtrail#Long", - "traits": { - "smithy.api#documentation": "

The total bytes that the query scanned in the event data store. This value matches the\n number of bytes for which your account is billed for the query, unless the query is still\n running.

" - } - }, - "ExecutionTimeInMillis": { - "target": "com.amazonaws.cloudtrail#Integer", - "traits": { - "smithy.api#documentation": "

The query's run time, in milliseconds.

" - } - }, - "CreationTime": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

The creation time of the query.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Gets metadata about a query, including the number of events that were matched, the total\n number of events scanned, the query run time in milliseconds, and the query's creation\n time.

" - } - }, - "com.amazonaws.cloudtrail#QueryStatus": { - "type": "enum", - "members": { - "QUEUED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUEUED" - } - }, - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING" - } - }, - "FINISHED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FINISHED" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "CANCELLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CANCELLED" - } - }, - "TIMED_OUT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TIMED_OUT" - } - } - } - }, - "com.amazonaws.cloudtrail#ReadWriteType": { - "type": "enum", - "members": { - "ReadOnly": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ReadOnly" - } - }, - "WriteOnly": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WriteOnly" - } - }, - "All": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "All" - } - } - } - }, - "com.amazonaws.cloudtrail#RegisterOrganizationDelegatedAdmin": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#RegisterOrganizationDelegatedAdminRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#RegisterOrganizationDelegatedAdminResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#AccountNotFoundException" + "com.amazonaws.cloudtrail#KmsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KmsException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when there is an issue with the specified KMS\n key and the trail or event data store can't be updated.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#AccountRegisteredException" + "com.amazonaws.cloudtrail#KmsKeyDisabledException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KmsKeyDisabled", + "httpResponseCode": 400 + }, + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

This exception is no longer in use.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#CannotDelegateManagementAccountException" + "com.amazonaws.cloudtrail#KmsKeyNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KmsKeyNotFound", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the KMS key does not exist, when the S3\n bucket and the KMS key are not in the same Region, or when the KMS key associated with the Amazon SNS topic either does not exist or is\n not in the same Region.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException" + "com.amazonaws.cloudtrail#ListChannels": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#ListChannelsRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#ListChannelsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the channels in the current account, and their source names. \n

", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } }, - { - "target": "com.amazonaws.cloudtrail#ConflictException" + "com.amazonaws.cloudtrail#ListChannelsMaxResultsCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } }, - { - "target": "com.amazonaws.cloudtrail#DelegatedAdminAccountLimitExceededException" + "com.amazonaws.cloudtrail#ListChannelsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.cloudtrail#ListChannelsMaxResultsCount", + "traits": { + "smithy.api#documentation": "

The maximum number of CloudTrail channels to display on a single page.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token to use to get the next page of results after a previous API call. This token\n must be passed in with the same parameters that were specified in the original call. For\n example, if the original call specified an AttributeKey of 'Username' with a value of\n 'root', the call with NextToken should include those same parameters.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + "com.amazonaws.cloudtrail#ListChannelsResponse": { + "type": "structure", + "members": { + "Channels": { + "target": "com.amazonaws.cloudtrail#Channels", + "traits": { + "smithy.api#documentation": "

The list of channels in the account.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token to use to get the next page of results after a previous API call.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidParameterException" + "com.amazonaws.cloudtrail#ListEventDataStores": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#ListEventDataStoresRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#ListEventDataStoresResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#InvalidMaxResultsException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about all event data stores in the account, in the current\n Region.

", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } }, - { - "target": "com.amazonaws.cloudtrail#NotOrganizationManagementAccountException" + "com.amazonaws.cloudtrail#ListEventDataStoresMaxResultsCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + "com.amazonaws.cloudtrail#ListEventDataStoresRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token you can use to get the next page of event data store results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.cloudtrail#ListEventDataStoresMaxResultsCount", + "traits": { + "smithy.api#documentation": "

The maximum number of event data stores to display on a single page.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException" + "com.amazonaws.cloudtrail#ListEventDataStoresResponse": { + "type": "structure", + "members": { + "EventDataStores": { + "target": "com.amazonaws.cloudtrail#EventDataStores", + "traits": { + "smithy.api#documentation": "

Contains information about event data stores in the account, in the current\n Region.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token you can use to get the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException" + "com.amazonaws.cloudtrail#ListImportFailures": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#ListImportFailuresRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#ListImportFailuresResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of failures for the specified import.

", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Failures", + "pageSize": "MaxResults" + } + } }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Registers an organization’s member account as the CloudTrail delegated\n administrator.

", - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.cloudtrail#RegisterOrganizationDelegatedAdminRequest": { - "type": "structure", - "members": { - "MemberAccountId": { - "target": "com.amazonaws.cloudtrail#AccountId", - "traits": { - "smithy.api#documentation": "

An organization member account ID that you want to designate as a delegated\n administrator.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies an organization member account ID as a CloudTrail delegated\n administrator.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#RegisterOrganizationDelegatedAdminResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

Returns the following response if successful. Otherwise, returns an error.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#RemoveTags": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#RemoveTagsRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#RemoveTagsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#ChannelARNInvalidException" + "com.amazonaws.cloudtrail#ListImportFailuresMaxResultsCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } }, - { - "target": "com.amazonaws.cloudtrail#ChannelNotFoundException" + "com.amazonaws.cloudtrail#ListImportFailuresRequest": { + "type": "structure", + "members": { + "ImportId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The ID of the import.

", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.cloudtrail#ListImportFailuresMaxResultsCount", + "traits": { + "smithy.api#documentation": "

The maximum number of failures to display on a single page.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token you can use to get the next page of import failures.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + "com.amazonaws.cloudtrail#ListImportFailuresResponse": { + "type": "structure", + "members": { + "Failures": { + "target": "com.amazonaws.cloudtrail#ImportFailureList", + "traits": { + "smithy.api#documentation": "

Contains information about the import failures.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token you can use to get the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + "com.amazonaws.cloudtrail#ListImports": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#ListImportsRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#ListImportsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information on all imports, or a select set of imports by\n ImportStatus or Destination.

", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Imports", + "pageSize": "MaxResults" + } + } }, - { - "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + "com.amazonaws.cloudtrail#ListImportsMaxResultsCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } }, - { - "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + "com.amazonaws.cloudtrail#ListImportsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.cloudtrail#ListImportsMaxResultsCount", + "traits": { + "smithy.api#documentation": "

The maximum number of imports to display on a single page.

" + } + }, + "Destination": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The ARN of the destination event data store.

" + } + }, + "ImportStatus": { + "target": "com.amazonaws.cloudtrail#ImportStatus", + "traits": { + "smithy.api#documentation": "

The status of the import.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token you can use to get the next page of import results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidTagParameterException" + "com.amazonaws.cloudtrail#ListImportsResponse": { + "type": "structure", + "members": { + "Imports": { + "target": "com.amazonaws.cloudtrail#ImportsList", + "traits": { + "smithy.api#documentation": "

The list of returned imports.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token you can use to get the next page of import results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + "com.amazonaws.cloudtrail#ListPublicKeys": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#ListPublicKeysRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#ListPublicKeysResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#InvalidTimeRangeException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTokenException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns all public keys whose private keys were used to sign the digest files within the\n specified time range. The public key is needed to validate digest files that were signed\n with its corresponding private key.

\n \n

CloudTrail uses different private and public key pairs per Region. Each digest\n file is signed with a private key unique to its Region. When you validate a digest file\n from a specific Region, you must look in the same Region for its corresponding public\n key.

\n ", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PublicKeyList" + } + } }, - { - "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + "com.amazonaws.cloudtrail#ListPublicKeysRequest": { + "type": "structure", + "members": { + "StartTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Optionally specifies, in UTC, the start of the time range to look up public keys for\n CloudTrail digest files. If not specified, the current time is used, and the\n current public key is returned.

" + } + }, + "EndTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Optionally specifies, in UTC, the end of the time range to look up public keys for\n CloudTrail digest files. If not specified, the current time is used.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Requests the public keys for a specified time range.

", + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + "com.amazonaws.cloudtrail#ListPublicKeysResponse": { + "type": "structure", + "members": { + "PublicKeyList": { + "target": "com.amazonaws.cloudtrail#PublicKeyList", + "traits": { + "smithy.api#documentation": "

Contains an array of PublicKey objects.

\n \n

The returned public keys may have validity time ranges that overlap.

\n " + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Returns the objects or data listed below if successful. Otherwise, returns an\n error.

", + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + "com.amazonaws.cloudtrail#ListQueries": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#ListQueriesRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#ListQueriesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidDateRangeException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidMaxResultsException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidQueryStatusException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of queries and query statuses for the past seven days. You must specify\n an ARN value for EventDataStore. Optionally, to shorten the list of results,\n you can specify a time range, formatted as timestamps, by adding StartTime and\n EndTime parameters, and a QueryStatus value. Valid values for\n QueryStatus include QUEUED, RUNNING,\n FINISHED, FAILED, TIMED_OUT, or\n CANCELLED.

", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } }, - { - "target": "com.amazonaws.cloudtrail#ResourceNotFoundException" + "com.amazonaws.cloudtrail#ListQueriesMaxResultsCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } }, - { - "target": "com.amazonaws.cloudtrail#ResourceTypeNotSupportedException" + "com.amazonaws.cloudtrail#ListQueriesRequest": { + "type": "structure", + "members": { + "EventDataStore": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The ARN (or the ID suffix of the ARN) of an event data store on which queries were\n run.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token you can use to get the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.cloudtrail#ListQueriesMaxResultsCount", + "traits": { + "smithy.api#documentation": "

The maximum number of queries to show on a page.

" + } + }, + "StartTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Use with EndTime to bound a ListQueries request, and limit its\n results to only those queries run within a specified time period.

" + } + }, + "EndTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Use with StartTime to bound a ListQueries request, and limit\n its results to only those queries run within a specified time period.

" + } + }, + "QueryStatus": { + "target": "com.amazonaws.cloudtrail#QueryStatus", + "traits": { + "smithy.api#documentation": "

The status of queries that you want to return in results. Valid values for\n QueryStatus include QUEUED, RUNNING,\n FINISHED, FAILED, TIMED_OUT, or\n CANCELLED.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes the specified tags from a trail, event data store, or channel.

", - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.cloudtrail#RemoveTagsRequest": { - "type": "structure", - "members": { - "ResourceId": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the ARN of the trail, event data store, or channel from which tags should be\n removed.

\n

Example trail ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

\n

Example event data store ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE\n

\n

Example channel ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890\n

", - "smithy.api#required": {} - } - }, - "TagsList": { - "target": "com.amazonaws.cloudtrail#TagsList", - "traits": { - "smithy.api#documentation": "

Specifies a list of tags to be removed.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the tags to remove from a trail, event data store, or channel.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#RemoveTagsResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

Returns the objects or data listed below if successful. Otherwise, returns an\n error.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#Resource": { - "type": "structure", - "members": { - "ResourceType": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

The type of a resource referenced by the event returned. When the resource type cannot\n be determined, null is returned. Some examples of resource types are: Instance for EC2, Trail for CloudTrail, DBInstance for Amazon RDS, and AccessKey for IAM. To learn more about how to look up and filter\n events by the resource types supported for a service, see Filtering CloudTrail Events.

" - } - }, - "ResourceName": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

The name of the resource referenced by the event returned. These are user-created names\n whose values will depend on the environment. For example, the resource name might be\n \"auto-scaling-test-group\" for an Auto Scaling Group or \"i-1234567\" for an EC2\n Instance.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the type and name of a resource referenced by an event.

" - } - }, - "com.amazonaws.cloudtrail#ResourceARNNotValidException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ResourceARNNotValid", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

\n This exception is thrown when the provided resource does not exist, or the ARN format of the resource is not valid. The following is the valid format for a resource ARN: \n arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel.\n

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#ResourceArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 256 - }, - "smithy.api#pattern": "^[a-zA-Z0-9._/\\-:]+$" - } - }, - "com.amazonaws.cloudtrail#ResourceIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudtrail#String" - } - }, - "com.amazonaws.cloudtrail#ResourceList": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudtrail#Resource" - }, - "traits": { - "smithy.api#documentation": "

A list of resources referenced by the event returned.

" - } - }, - "com.amazonaws.cloudtrail#ResourceNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ResourceNotFound", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This exception is thrown when the specified resource is not found.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#ResourcePolicy": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 8192 - } - } - }, - "com.amazonaws.cloudtrail#ResourcePolicyNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ResourcePolicyNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

\n This exception is thrown when the specified resource policy is not found.\n

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.cloudtrail#ResourcePolicyNotValidException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ResourcePolicyNotValid", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

\n This exception is thrown when the resouce-based policy has syntax errors, or contains a principal that is not valid.\n

\n

The following are requirements for the resource policy:

\n ", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#ResourceTag": { - "type": "structure", - "members": { - "ResourceId": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the ARN of the resource.

" - } - }, - "TagsList": { - "target": "com.amazonaws.cloudtrail#TagsList", - "traits": { - "smithy.api#documentation": "

A list of tags.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A resource tag.

" - } - }, - "com.amazonaws.cloudtrail#ResourceTagList": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudtrail#ResourceTag" - } - }, - "com.amazonaws.cloudtrail#ResourceTypeNotSupportedException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ResourceTypeNotSupported", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This exception is thrown when the specified resource type is not supported by CloudTrail.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#RestoreEventDataStore": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#RestoreEventDataStoreRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#RestoreEventDataStoreResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException" + "com.amazonaws.cloudtrail#ListQueriesResponse": { + "type": "structure", + "members": { + "Queries": { + "target": "com.amazonaws.cloudtrail#Queries", + "traits": { + "smithy.api#documentation": "

Lists matching query results, and shows query ID, status, and creation time of each\n query.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token you can use to get the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + "com.amazonaws.cloudtrail#ListTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#ListTagsRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#ListTagsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#ChannelARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTokenException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourceTypeNotSupportedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the tags for the specified trails, event data stores, or channels in the current Region.

", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ResourceTagList" + } + } }, - { - "target": "com.amazonaws.cloudtrail#EventDataStoreMaxLimitExceededException" + "com.amazonaws.cloudtrail#ListTagsRequest": { + "type": "structure", + "members": { + "ResourceIdList": { + "target": "com.amazonaws.cloudtrail#ResourceIdList", + "traits": { + "smithy.api#documentation": "

Specifies a list of trail, event data store, or channel ARNs whose tags will be listed. The list\n has a limit of 20 ARNs.

\n

Example trail ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

\n

Example event data store ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE\n

\n

Example channel ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890\n

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a list of tags to return.

", + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + "com.amazonaws.cloudtrail#ListTagsResponse": { + "type": "structure", + "members": { + "ResourceTagList": { + "target": "com.amazonaws.cloudtrail#ResourceTagList", + "traits": { + "smithy.api#documentation": "

A list of resource tags.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Returns the objects or data listed below if successful. Otherwise, returns an\n error.

", + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + "com.amazonaws.cloudtrail#ListTrails": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#ListTrailsRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#ListTrailsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists trails that are in the current account.

", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Trails" + } + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreStatusException" + "com.amazonaws.cloudtrail#ListTrailsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The token to use to get the next page of results after a previous API call. This token\n must be passed in with the same parameters that were specified in the original call. For\n example, if the original call specified an AttributeKey of 'Username' with a value of\n 'root', the call with NextToken should include those same parameters.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidParameterException" + "com.amazonaws.cloudtrail#ListTrailsResponse": { + "type": "structure", + "members": { + "Trails": { + "target": "com.amazonaws.cloudtrail#Trails", + "traits": { + "smithy.api#documentation": "

Returns the name, ARN, and home Region of trails in the current account.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The token to use to get the next page of results after a previous API call. If the token\n does not appear, there are no more results to return. The token must be passed in with the\n same parameters as the previous call. For example, if the original call specified an\n AttributeKey of 'Username' with a value of 'root', the call with NextToken should include\n those same parameters.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + "com.amazonaws.cloudtrail#Location": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 1024 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._/\\-:]+$" + } }, - { - "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + "com.amazonaws.cloudtrail#Long": { + "type": "long" + }, + "com.amazonaws.cloudtrail#LookupAttribute": { + "type": "structure", + "members": { + "AttributeKey": { + "target": "com.amazonaws.cloudtrail#LookupAttributeKey", + "traits": { + "smithy.api#documentation": "

Specifies an attribute on which to filter the events returned.

", + "smithy.api#required": {} + } + }, + "AttributeValue": { + "target": "com.amazonaws.cloudtrail#LookupAttributeValue", + "traits": { + "smithy.api#documentation": "

Specifies a value for the specified AttributeKey.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies an attribute and value that filter the events returned.

" + } }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + "com.amazonaws.cloudtrail#LookupAttributeKey": { + "type": "enum", + "members": { + "EVENT_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EventId" + } + }, + "EVENT_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EventName" + } + }, + "READ_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ReadOnly" + } + }, + "USERNAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Username" + } + }, + "RESOURCE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ResourceType" + } + }, + "RESOURCE_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ResourceName" + } + }, + "EVENT_SOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EventSource" + } + }, + "ACCESS_KEY_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccessKeyId" + } + } + } }, - { - "target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException" + "com.amazonaws.cloudtrail#LookupAttributeValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2000 + } + } }, - { - "target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException" + "com.amazonaws.cloudtrail#LookupAttributesList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#LookupAttribute" + } }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Restores a deleted event data store specified by EventDataStore, which\n accepts an event data store ARN. You can only restore a deleted event data store within the\n seven-day wait period after deletion. Restoring an event data store can take several\n minutes, depending on the size of the event data store.

" - } - }, - "com.amazonaws.cloudtrail#RestoreEventDataStoreRequest": { - "type": "structure", - "members": { - "EventDataStore": { - "target": "com.amazonaws.cloudtrail#EventDataStoreArn", - "traits": { - "smithy.api#documentation": "

The ARN (or the ID suffix of the ARN) of the event data store that you want to\n restore.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#RestoreEventDataStoreResponse": { - "type": "structure", - "members": { - "EventDataStoreArn": { - "target": "com.amazonaws.cloudtrail#EventDataStoreArn", - "traits": { - "smithy.api#documentation": "

The event data store ARN.

" - } - }, - "Name": { - "target": "com.amazonaws.cloudtrail#EventDataStoreName", - "traits": { - "smithy.api#documentation": "

The name of the event data store.

" - } - }, - "Status": { - "target": "com.amazonaws.cloudtrail#EventDataStoreStatus", - "traits": { - "smithy.api#documentation": "

The status of the event data store.

" - } - }, - "AdvancedEventSelectors": { - "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", - "traits": { - "smithy.api#documentation": "

The advanced event selectors that were used to select events.

" - } - }, - "MultiRegionEnabled": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether the event data store is collecting events from all Regions, or only\n from the Region in which the event data store was created.

" - } - }, - "OrganizationEnabled": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether an event data store is collecting logged events for an organization in\n Organizations.

" - } - }, - "RetentionPeriod": { - "target": "com.amazonaws.cloudtrail#RetentionPeriod", - "traits": { - "smithy.api#documentation": "

The retention period, in days.

" - } - }, - "TerminationProtectionEnabled": { - "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", - "traits": { - "smithy.api#documentation": "

Indicates that termination protection is enabled and the event data store cannot be\n automatically deleted.

" - } - }, - "CreatedTimestamp": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

The timestamp of an event data store's creation.

" - } - }, - "UpdatedTimestamp": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

The timestamp that shows when an event data store was updated, if applicable.\n UpdatedTimestamp is always either the same or newer than the time shown in\n CreatedTimestamp.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.cloudtrail#EventDataStoreKmsKeyId", - "traits": { - "smithy.api#documentation": "

Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the\n following format.

\n

\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#RetentionPeriod": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 7, - "max": 2557 - } - } - }, - "com.amazonaws.cloudtrail#S3BucketDoesNotExistException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "S3BucketDoesNotExist", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

This exception is thrown when the specified S3 bucket does not exist.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.cloudtrail#S3ImportSource": { - "type": "structure", - "members": { - "S3LocationUri": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

The URI for the source S3 bucket.

", - "smithy.api#required": {} - } - }, - "S3BucketRegion": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

The Region associated with the source S3 bucket.

", - "smithy.api#required": {} - } - }, - "S3BucketAccessRoleArn": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

The IAM ARN role used to access the source S3 bucket.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The settings for the source S3 bucket.

" - } - }, - "com.amazonaws.cloudtrail#SelectorField": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - }, - "smithy.api#pattern": "^[\\w|\\d|\\.|_]+$" - } - }, - "com.amazonaws.cloudtrail#SelectorName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1000 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.cloudtrail#Source": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.cloudtrail#SourceConfig": { - "type": "structure", - "members": { - "ApplyToAllRegions": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether the channel applies to a single Region or to all Regions.

" - } - }, - "AdvancedEventSelectors": { - "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", - "traits": { - "smithy.api#documentation": "

The advanced event selectors that are configured for the channel.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains configuration information about the channel.

" - } - }, - "com.amazonaws.cloudtrail#StartEventDataStoreIngestion": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#StartEventDataStoreIngestionRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#StartEventDataStoreIngestionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + "com.amazonaws.cloudtrail#LookupEvents": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#LookupEventsRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#LookupEventsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#InvalidEventCategoryException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidLookupAttributesException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidMaxResultsException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTimeRangeException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Looks up management events or CloudTrail Insights events that are captured by CloudTrail.\n You can look up events that occurred in a Region within the last 90 days. Lookup supports\n the following attributes for management events:

\n \n

Lookup supports the following attributes for Insights events:

\n \n

All attributes are optional. The default number of results returned is 50, with a\n maximum of 50 possible. The response includes a token that you can use to get the next page\n of results.

\n \n

The rate of lookup requests is limited to two per second, per account, per Region. If\n this limit is exceeded, a throttling error occurs.

\n ", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Events", + "pageSize": "MaxResults" + } + } }, - { - "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + "com.amazonaws.cloudtrail#LookupEventsRequest": { + "type": "structure", + "members": { + "LookupAttributes": { + "target": "com.amazonaws.cloudtrail#LookupAttributesList", + "traits": { + "smithy.api#documentation": "

Contains a list of lookup attributes. Currently the list can contain only one\n item.

" + } + }, + "StartTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Specifies that only events that occur after or at the specified time are returned. If\n the specified start time is after the specified end time, an error is returned.

" + } + }, + "EndTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Specifies that only events that occur before or at the specified time are returned. If\n the specified end time is before the specified start time, an error is returned.

" + } + }, + "EventCategory": { + "target": "com.amazonaws.cloudtrail#EventCategory", + "traits": { + "smithy.api#documentation": "

Specifies the event category. If you do not specify an event category, events of the\n category are not returned in the response. For example, if you do not specify\n insight as the value of EventCategory, no Insights events are\n returned.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.cloudtrail#MaxResults", + "traits": { + "smithy.api#documentation": "

The number of events to return. Possible values are 1 through 50. The default is\n 50.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use to get the next page of results after a previous API call. This token\n must be passed in with the same parameters that were specified in the original call. For\n example, if the original call specified an AttributeKey of 'Username' with a value of\n 'root', the call with NextToken should include those same parameters.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains a request for LookupEvents.

", + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + "com.amazonaws.cloudtrail#LookupEventsResponse": { + "type": "structure", + "members": { + "Events": { + "target": "com.amazonaws.cloudtrail#EventsList", + "traits": { + "smithy.api#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\n first.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use to get the next page of results after a previous API call. If the token\n does not appear, there are no more results to return. The token must be passed in with the\n same parameters as the previous call. For example, if the original call specified an\n AttributeKey of 'Username' with a value of 'root', the call with NextToken should include\n those same parameters.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains a response to a LookupEvents action.

", + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreCategoryException" + "com.amazonaws.cloudtrail#MaxConcurrentQueriesException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "MaxConcurrentQueries", + "httpResponseCode": 429 + }, + "smithy.api#documentation": "

You are already running the maximum number of concurrent queries. Wait a minute for some\n queries to finish, and then run the query again.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreStatusException" + "com.amazonaws.cloudtrail#MaxQueryResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidParameterException" + "com.amazonaws.cloudtrail#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } }, - { - "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + "com.amazonaws.cloudtrail#MaximumNumberOfTrailsExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "MaximumNumberOfTrailsExceeded", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

This exception is thrown when the maximum number of trails is reached.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } }, - { - "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + "com.amazonaws.cloudtrail#NextToken": { + "type": "string" }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "NoManagementAccountSLRExists", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

This exception is thrown when the management account does not have a service-linked\n role.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Starts the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN. To start ingestion, the event data store Status must be STOPPED_INGESTION \n and the eventCategory must be Management, Data, or ConfigurationItem.

" - } - }, - "com.amazonaws.cloudtrail#StartEventDataStoreIngestionRequest": { - "type": "structure", - "members": { - "EventDataStore": { - "target": "com.amazonaws.cloudtrail#EventDataStoreArn", - "traits": { - "smithy.api#documentation": "

The ARN (or ID suffix of the ARN) of the event data store for which you want to start ingestion.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#StartEventDataStoreIngestionResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#StartImport": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#StartImportRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#StartImportResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#AccountHasOngoingImportException" + "com.amazonaws.cloudtrail#NotOrganizationManagementAccountException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "NotOrganizationManagementAccount", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

This exception is thrown when the account making the request is not the organization's\n management account.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } }, - { - "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "NotOrganizationMasterAccount", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the Amazon Web Services account making the request to\n create or update an organization trail or event data store is not the management account\n for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + "com.amazonaws.cloudtrail#OperationNotPermittedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "OperationNotPermitted", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the requested operation is not permitted.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#ImportNotFoundException" + "com.amazonaws.cloudtrail#Operator": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#OperatorValue" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } }, - { - "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + "com.amazonaws.cloudtrail#OperatorValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^.+$" + } }, - { - "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" + "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "OrganizationNotInAllFeaturesMode", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when Organizations is not configured to support all\n features. All features must be enabled in Organizations to support creating an\n organization trail or event data store.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreCategoryException" + "com.amazonaws.cloudtrail#OrganizationsNotInUseException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "OrganizationsNotInUse", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

This exception is thrown when the request is made from an Amazon Web Services account\n that is not a member of an organization. To make this request, sign in using the\n credentials of an account that belongs to an organization.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreStatusException" + "com.amazonaws.cloudtrail#PaginationToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 1000 + }, + "smithy.api#pattern": ".*" + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidImportSourceException" + "com.amazonaws.cloudtrail#PublicKey": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.cloudtrail#ByteBuffer", + "traits": { + "smithy.api#documentation": "

The DER encoded public key value in PKCS#1 format.

" + } + }, + "ValidityStartTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The starting time of validity of the public key.

" + } + }, + "ValidityEndTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The ending time of validity of the public key.

" + } + }, + "Fingerprint": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The fingerprint of the public key.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a returned public key.

" + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidParameterException" + "com.amazonaws.cloudtrail#PublicKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#PublicKey" + } }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + "com.amazonaws.cloudtrail#PutEventSelectors": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#PutEventSelectorsRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#PutEventSelectorsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#ConflictException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidEventSelectorsException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidHomeRegionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#TrailNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Configures an event selector or advanced event selectors for your trail. Use event\n selectors or advanced event selectors to specify management and data event settings for\n your trail. If you want your trail to log Insights events, be sure the event selector \n enables logging of the Insights event types you want configured for your trail. For more information about logging Insights events, see Logging Insights events for trails in the CloudTrail User Guide.\n By default, trails created without specific event selectors are configured to\n log all read and write management events, and no data events.

\n

When an event occurs in your account, CloudTrail evaluates the event selectors or\n advanced event selectors in all trails. For each trail, if the event matches any event\n selector, the trail processes and logs the event. If the event doesn't match any event\n selector, the trail doesn't log the event.

\n

Example

\n
    \n
  1. \n

    You create an event selector for a trail and specify that you want write-only\n events.

    \n
    2. \n
  2. \n

    The EC2 GetConsoleOutput and RunInstances API operations\n occur in your account.

    \n
    3. \n
  3. \n

    CloudTrail evaluates whether the events match your event selectors.

    \n
    4. \n
  4. \n

    The RunInstances is a write-only event and it matches your event\n selector. The trail logs the event.

    \n
    5. \n
  5. \n

    The GetConsoleOutput is a read-only event that doesn't match your\n event selector. The trail doesn't log the event.

    \n
    6. \n
\n

The PutEventSelectors operation must be called from the Region in which the\n trail was created; otherwise, an InvalidHomeRegionException exception is\n thrown.

\n

You can configure up to five event selectors for each trail. For more information, see\n Logging management events, Logging\n data events, and Quotas in CloudTrail in the CloudTrail User\n Guide.

\n

You can add advanced event selectors, and conditions for your advanced event selectors,\n up to a maximum of 500 values for all conditions and selectors on a trail. You can use\n either AdvancedEventSelectors or EventSelectors, but not both. If\n you apply AdvancedEventSelectors to a trail, any existing\n EventSelectors are overwritten. For more information about advanced event\n selectors, see Logging data events in the CloudTrail User Guide.

", + "smithy.api#idempotent": {} + } }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Starts an import of logged trail events from a source S3 bucket to a destination event\n data store. By default, CloudTrail only imports events contained in the S3 bucket's\n CloudTrail prefix and the prefixes inside the CloudTrail prefix, and does not check prefixes for other Amazon Web Services\n services. If you want to import CloudTrail events contained in another prefix, you\n must include the prefix in the S3LocationUri. For more considerations about\n importing trail events, see Considerations.

\n

When you start a new import, the Destinations and\n ImportSource parameters are required. Before starting a new import, disable\n any access control lists (ACLs) attached to the source S3 bucket. For more information\n about disabling ACLs, see Controlling ownership of\n objects and disabling ACLs for your bucket.

\n

When you retry an import, the ImportID parameter is required.

\n \n

If the destination event data store is for an organization, you must use the\n management account to import trail events. You cannot use the delegated administrator\n account for the organization.

\n " - } - }, - "com.amazonaws.cloudtrail#StartImportRequest": { - "type": "structure", - "members": { - "Destinations": { - "target": "com.amazonaws.cloudtrail#ImportDestinations", - "traits": { - "smithy.api#documentation": "

The ARN of the destination event data store. Use this parameter for a new import.\n

" - } - }, - "ImportSource": { - "target": "com.amazonaws.cloudtrail#ImportSource", - "traits": { - "smithy.api#documentation": "

The source S3 bucket for the import. Use this parameter for a new import.

" - } - }, - "StartEventTime": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

Use with EndEventTime to bound a StartImport request, and\n limit imported trail events to only those events logged within a specified time period.\n When you specify a time range, CloudTrail checks the prefix and log file names to\n verify the names contain a date between the specified StartEventTime and\n EndEventTime before attempting to import events.

" - } - }, - "EndEventTime": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

Use with StartEventTime to bound a StartImport request, and\n limit imported trail events to only those events logged within a specified time period.\n When you specify a time range, CloudTrail checks the prefix and log file names to\n verify the names contain a date between the specified StartEventTime and\n EndEventTime before attempting to import events.

" - } - }, - "ImportId": { - "target": "com.amazonaws.cloudtrail#UUID", - "traits": { - "smithy.api#documentation": "

The ID of the import. Use this parameter when you are retrying an import.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#StartImportResponse": { - "type": "structure", - "members": { - "ImportId": { - "target": "com.amazonaws.cloudtrail#UUID", - "traits": { - "smithy.api#documentation": "

The ID of the import.

" - } - }, - "Destinations": { - "target": "com.amazonaws.cloudtrail#ImportDestinations", - "traits": { - "smithy.api#documentation": "

The ARN of the destination event data store.

" - } - }, - "ImportSource": { - "target": "com.amazonaws.cloudtrail#ImportSource", - "traits": { - "smithy.api#documentation": "

The source S3 bucket for the import.

" - } - }, - "StartEventTime": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

Used with EndEventTime to bound a StartImport request, and\n limit imported trail events to only those events logged within a specified time period.\n

" - } - }, - "EndEventTime": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

Used with StartEventTime to bound a StartImport request, and\n limit imported trail events to only those events logged within a specified time period.\n

" - } - }, - "ImportStatus": { - "target": "com.amazonaws.cloudtrail#ImportStatus", - "traits": { - "smithy.api#documentation": "

Shows the status of the import after a StartImport request. An import\n finishes with a status of COMPLETED if there were no failures, or\n FAILED if there were failures.

" - } - }, - "CreatedTimestamp": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

The timestamp for the import's creation.

" - } - }, - "UpdatedTimestamp": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

The timestamp of the import's last update, if applicable.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#StartLogging": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#StartLoggingRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#StartLoggingResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + "com.amazonaws.cloudtrail#PutEventSelectorsRequest": { + "type": "structure", + "members": { + "TrailName": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the trail or trail ARN. If you specify a trail name, the string\n must meet the following requirements:

\n \n

If you specify a trail ARN, it must be in the following format.

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

", + "smithy.api#required": {} + } + }, + "EventSelectors": { + "target": "com.amazonaws.cloudtrail#EventSelectors", + "traits": { + "smithy.api#documentation": "

Specifies the settings for your event selectors. You can configure up to five event\n selectors for a trail. You can use either EventSelectors or\n AdvancedEventSelectors in a PutEventSelectors request, but not\n both. If you apply EventSelectors to a trail, any existing\n AdvancedEventSelectors are overwritten.

" + } + }, + "AdvancedEventSelectors": { + "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", + "traits": { + "smithy.api#documentation": "

Specifies the settings for advanced event selectors. You can add advanced event\n selectors, and conditions for your advanced event selectors, up to a maximum of 500 values\n for all conditions and selectors on a trail. You can use either\n AdvancedEventSelectors or EventSelectors, but not both. If you\n apply AdvancedEventSelectors to a trail, any existing\n EventSelectors are overwritten. For more information about advanced event\n selectors, see Logging data events in the CloudTrail User Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#ConflictException" + "com.amazonaws.cloudtrail#PutEventSelectorsResponse": { + "type": "structure", + "members": { + "TrailARN": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the ARN of the trail that was updated with event selectors. The following is\n the format of a trail ARN.

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

" + } + }, + "EventSelectors": { + "target": "com.amazonaws.cloudtrail#EventSelectors", + "traits": { + "smithy.api#documentation": "

Specifies the event selectors configured for your trail.

" + } + }, + "AdvancedEventSelectors": { + "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", + "traits": { + "smithy.api#documentation": "

Specifies the advanced event selectors configured for your trail.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + "com.amazonaws.cloudtrail#PutInsightSelectors": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#PutInsightSelectorsRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#PutInsightSelectorsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientS3BucketPolicyException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidHomeRegionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidInsightSelectorsException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + }, + { + "target": "com.amazonaws.cloudtrail#KmsException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#S3BucketDoesNotExistException" + }, + { + "target": "com.amazonaws.cloudtrail#TrailNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lets you enable Insights event logging by specifying the Insights selectors that you\n want to enable on an existing trail. You also use PutInsightSelectors to turn\n off Insights event logging, by passing an empty list of insight types. The valid Insights\n event types in this release are ApiErrorRateInsight and\n ApiCallRateInsight.

\n

To log CloudTrail Insights events on API call volume, the trail\n must log write management events. To log CloudTrail\n Insights events on API error rate, the trail must log read or\n write management events. You can call GetEventSelectors on a trail \n to check whether the trail logs management events.

", + "smithy.api#idempotent": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidHomeRegionException" + "com.amazonaws.cloudtrail#PutInsightSelectorsRequest": { + "type": "structure", + "members": { + "TrailName": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The name of the CloudTrail trail for which you want to change or add Insights\n selectors.

", + "smithy.api#required": {} + } + }, + "InsightSelectors": { + "target": "com.amazonaws.cloudtrail#InsightSelectors", + "traits": { + "smithy.api#documentation": "

A JSON string that contains the insight types you want to log on a trail.\n ApiCallRateInsight and ApiErrorRateInsight are valid Insight\n types.

\n

The ApiCallRateInsight Insights type analyzes write-only\n management API calls that are aggregated per minute against a baseline API call volume.

\n

The ApiErrorRateInsight Insights type analyzes management\n API calls that result in error codes. The error is shown if the API call is\n unsuccessful.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + "com.amazonaws.cloudtrail#PutInsightSelectorsResponse": { + "type": "structure", + "members": { + "TrailARN": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a trail for which you want to change or add Insights\n selectors.

" + } + }, + "InsightSelectors": { + "target": "com.amazonaws.cloudtrail#InsightSelectors", + "traits": { + "smithy.api#documentation": "

A JSON string that contains the Insights event types that you want to log on a trail.\n The valid Insights types in this release are ApiErrorRateInsight and\n ApiCallRateInsight.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + "com.amazonaws.cloudtrail#PutResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#PutResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#PutResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourceARNNotValidException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourcePolicyNotValidException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourceTypeNotSupportedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Attaches a resource-based permission policy to a CloudTrail channel that is used for an integration with an event source outside of Amazon Web Services. For more information about resource-based policies, see \n CloudTrail resource-based policy examples \n in the CloudTrail User Guide.\n

", + "smithy.api#idempotent": {} + } }, - { - "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + "com.amazonaws.cloudtrail#PutResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.cloudtrail#ResourceArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the CloudTrail channel attached to the resource-based policy. \n The following is the format of a resource ARN: \n arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel.\n

", + "smithy.api#required": {} + } + }, + "ResourcePolicy": { + "target": "com.amazonaws.cloudtrail#ResourcePolicy", + "traits": { + "smithy.api#documentation": "

\n A JSON-formatted string for an Amazon Web Services resource-based policy.\n

\n

The following are requirements for the resource policy:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + "com.amazonaws.cloudtrail#PutResourcePolicyResponse": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.cloudtrail#ResourceArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the CloudTrail channel attached to the resource-based policy.\n

" + } + }, + "ResourcePolicy": { + "target": "com.amazonaws.cloudtrail#ResourcePolicy", + "traits": { + "smithy.api#documentation": "

\n The JSON-formatted string of the Amazon Web Services resource-based policy attached to the CloudTrail channel.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#TrailNotFoundException" + "com.amazonaws.cloudtrail#Queries": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#Query" + } }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Starts the recording of Amazon Web Services API calls and log file delivery for a trail.\n For a trail that is enabled in all Regions, this operation must be called from the Region\n in which the trail was created. This operation cannot be called on the shadow trails\n (replicated trails in other Regions) of a trail that is enabled in all Regions.

", - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.cloudtrail#StartLoggingRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the name or the CloudTrail ARN of the trail for which CloudTrail\n logs Amazon Web Services API calls. The following is the format of a trail ARN.

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The request to CloudTrail to start logging Amazon Web Services API calls for an\n account.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#StartLoggingResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

Returns the objects or data listed below if successful. Otherwise, returns an\n error.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#StartQuery": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#StartQueryRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#StartQueryResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + "com.amazonaws.cloudtrail#Query": { + "type": "structure", + "members": { + "QueryId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The ID of a query.

" + } + }, + "QueryStatus": { + "target": "com.amazonaws.cloudtrail#QueryStatus", + "traits": { + "smithy.api#documentation": "

The status of the query. This can be QUEUED, RUNNING,\n FINISHED, FAILED, TIMED_OUT, or\n CANCELLED.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The creation time of a query.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A SQL string of criteria about events that you want to collect in an event data\n store.

" + } }, - { - "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + "com.amazonaws.cloudtrail#QueryAlias": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9._\\-]*$" + } }, - { - "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + "com.amazonaws.cloudtrail#QueryIdNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "QueryIdNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The query ID does not exist or does not map to a query.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } }, - { - "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" + "com.amazonaws.cloudtrail#QueryParameter": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": ".*" + } }, - { - "target": "com.amazonaws.cloudtrail#InsufficientS3BucketPolicyException" + "com.amazonaws.cloudtrail#QueryParameters": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#QueryParameter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidParameterException" + "com.amazonaws.cloudtrail#QueryResultColumn": { + "type": "map", + "key": { + "target": "com.amazonaws.cloudtrail#QueryResultKey" + }, + "value": { + "target": "com.amazonaws.cloudtrail#QueryResultValue" + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidQueryStatementException" + "com.amazonaws.cloudtrail#QueryResultKey": { + "type": "string" }, - { - "target": "com.amazonaws.cloudtrail#InvalidS3BucketNameException" + "com.amazonaws.cloudtrail#QueryResultRow": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#QueryResultColumn" + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidS3PrefixException" + "com.amazonaws.cloudtrail#QueryResultRows": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#QueryResultRow" + } }, - { - "target": "com.amazonaws.cloudtrail#MaxConcurrentQueriesException" + "com.amazonaws.cloudtrail#QueryResultValue": { + "type": "string" }, - { - "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + "com.amazonaws.cloudtrail#QueryStatement": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10000 + }, + "smithy.api#pattern": "^(?s)" + } }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + "com.amazonaws.cloudtrail#QueryStatistics": { + "type": "structure", + "members": { + "ResultsCount": { + "target": "com.amazonaws.cloudtrail#Integer", + "traits": { + "smithy.api#documentation": "

The number of results returned.

" + } + }, + "TotalResultsCount": { + "target": "com.amazonaws.cloudtrail#Integer", + "traits": { + "smithy.api#documentation": "

The total number of results returned by a query.

" + } + }, + "BytesScanned": { + "target": "com.amazonaws.cloudtrail#Long", + "traits": { + "smithy.api#documentation": "

The total bytes that the query scanned in the event data store. This value matches the\n number of bytes for which your account is billed for the query, unless the query is still\n running.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Metadata about a query, such as the number of results.

" + } }, - { - "target": "com.amazonaws.cloudtrail#S3BucketDoesNotExistException" + "com.amazonaws.cloudtrail#QueryStatisticsForDescribeQuery": { + "type": "structure", + "members": { + "EventsMatched": { + "target": "com.amazonaws.cloudtrail#Long", + "traits": { + "smithy.api#documentation": "

The number of events that matched a query.

" + } + }, + "EventsScanned": { + "target": "com.amazonaws.cloudtrail#Long", + "traits": { + "smithy.api#documentation": "

The number of events that the query scanned in the event data store.

" + } + }, + "BytesScanned": { + "target": "com.amazonaws.cloudtrail#Long", + "traits": { + "smithy.api#documentation": "

The total bytes that the query scanned in the event data store. This value matches the\n number of bytes for which your account is billed for the query, unless the query is still\n running.

" + } + }, + "ExecutionTimeInMillis": { + "target": "com.amazonaws.cloudtrail#Integer", + "traits": { + "smithy.api#documentation": "

The query's run time, in milliseconds.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The creation time of the query.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Gets metadata about a query, including the number of events that were matched, the total\n number of events scanned, the query run time in milliseconds, and the query's creation\n time.

" + } }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Starts a CloudTrail Lake query. The required QueryStatement\n parameter provides your SQL query, enclosed in single quotation marks. Use the optional\n DeliveryS3Uri parameter to deliver the query results to an S3\n bucket.

", - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.cloudtrail#StartQueryRequest": { - "type": "structure", - "members": { - "QueryStatement": { - "target": "com.amazonaws.cloudtrail#QueryStatement", - "traits": { - "smithy.api#documentation": "

The SQL code of your query.

", - "smithy.api#required": {} - } - }, - "DeliveryS3Uri": { - "target": "com.amazonaws.cloudtrail#DeliveryS3Uri", - "traits": { - "smithy.api#documentation": "

The URI for the S3 bucket where CloudTrail delivers the query results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#StartQueryResponse": { - "type": "structure", - "members": { - "QueryId": { - "target": "com.amazonaws.cloudtrail#UUID", - "traits": { - "smithy.api#documentation": "

The ID of the started query.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#StopEventDataStoreIngestion": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#StopEventDataStoreIngestionRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#StopEventDataStoreIngestionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + "com.amazonaws.cloudtrail#QueryStatus": { + "type": "enum", + "members": { + "QUEUED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUEUED" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "FINISHED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FINISHED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + }, + "TIMED_OUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMED_OUT" + } + } + } }, - { - "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + "com.amazonaws.cloudtrail#ReadWriteType": { + "type": "enum", + "members": { + "ReadOnly": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ReadOnly" + } + }, + "WriteOnly": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WriteOnly" + } + }, + "All": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "All" + } + } + } }, - { - "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + "com.amazonaws.cloudtrail#RegisterOrganizationDelegatedAdmin": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#RegisterOrganizationDelegatedAdminRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#RegisterOrganizationDelegatedAdminResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#AccountNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#AccountRegisteredException" + }, + { + "target": "com.amazonaws.cloudtrail#CannotDelegateManagementAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException" + }, + { + "target": "com.amazonaws.cloudtrail#ConflictException" + }, + { + "target": "com.amazonaws.cloudtrail#DelegatedAdminAccountLimitExceededException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationManagementAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Registers an organization’s member account as the CloudTrail delegated\n administrator.

", + "smithy.api#idempotent": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreCategoryException" + "com.amazonaws.cloudtrail#RegisterOrganizationDelegatedAdminRequest": { + "type": "structure", + "members": { + "MemberAccountId": { + "target": "com.amazonaws.cloudtrail#AccountId", + "traits": { + "smithy.api#documentation": "

An organization member account ID that you want to designate as a delegated\n administrator.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies an organization member account ID as a CloudTrail delegated\n administrator.

", + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreStatusException" + "com.amazonaws.cloudtrail#RegisterOrganizationDelegatedAdminResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Returns the following response if successful. Otherwise, returns an error.

", + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidParameterException" + "com.amazonaws.cloudtrail#RemoveTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#RemoveTagsRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#RemoveTagsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#ChannelARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#ChannelNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTagParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourceTypeNotSupportedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the specified tags from a trail, event data store, or channel.

", + "smithy.api#idempotent": {} + } }, - { - "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + "com.amazonaws.cloudtrail#RemoveTagsRequest": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the ARN of the trail, event data store, or channel from which tags should be\n removed.

\n

Example trail ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

\n

Example event data store ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE\n

\n

Example channel ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890\n

", + "smithy.api#required": {} + } + }, + "TagsList": { + "target": "com.amazonaws.cloudtrail#TagsList", + "traits": { + "smithy.api#documentation": "

Specifies a list of tags to be removed.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the tags to remove from a trail, event data store, or channel.

", + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + "com.amazonaws.cloudtrail#RemoveTagsResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Returns the objects or data listed below if successful. Otherwise, returns an\n error.

", + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + "com.amazonaws.cloudtrail#Resource": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The type of a resource referenced by the event returned. When the resource type cannot\n be determined, null is returned. Some examples of resource types are: Instance for EC2, Trail for CloudTrail, DBInstance for Amazon RDS, and AccessKey for IAM. To learn more about how to look up and filter\n events by the resource types supported for a service, see Filtering CloudTrail Events.

" + } + }, + "ResourceName": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The name of the resource referenced by the event returned. These are user-created names\n whose values will depend on the environment. For example, the resource name might be\n \"auto-scaling-test-group\" for an Auto Scaling Group or \"i-1234567\" for an EC2\n Instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the type and name of a resource referenced by an event.

" + } }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Stops the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN. To stop ingestion, the event data store Status must be ENABLED \n and the eventCategory must be Management, Data, or ConfigurationItem.

" - } - }, - "com.amazonaws.cloudtrail#StopEventDataStoreIngestionRequest": { - "type": "structure", - "members": { - "EventDataStore": { - "target": "com.amazonaws.cloudtrail#EventDataStoreArn", - "traits": { - "smithy.api#documentation": "

The ARN (or ID suffix of the ARN) of the event data store for which you want to stop ingestion.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#StopEventDataStoreIngestionResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#StopImport": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#StopImportRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#StopImportResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#ImportNotFoundException" - }, - { - "target": "com.amazonaws.cloudtrail#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Stops a specified import.

" - } - }, - "com.amazonaws.cloudtrail#StopImportRequest": { - "type": "structure", - "members": { - "ImportId": { - "target": "com.amazonaws.cloudtrail#UUID", - "traits": { - "smithy.api#documentation": "

The ID of the import.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#StopImportResponse": { - "type": "structure", - "members": { - "ImportId": { - "target": "com.amazonaws.cloudtrail#UUID", - "traits": { - "smithy.api#documentation": "

The ID for the import.

" - } - }, - "ImportSource": { - "target": "com.amazonaws.cloudtrail#ImportSource", - "traits": { - "smithy.api#documentation": "

The source S3 bucket for the import.

" - } - }, - "Destinations": { - "target": "com.amazonaws.cloudtrail#ImportDestinations", - "traits": { - "smithy.api#documentation": "

The ARN of the destination event data store.

" - } - }, - "ImportStatus": { - "target": "com.amazonaws.cloudtrail#ImportStatus", - "traits": { - "smithy.api#documentation": "

The status of the import.

" - } - }, - "CreatedTimestamp": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

The timestamp of the import's creation.

" - } - }, - "UpdatedTimestamp": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

The timestamp of the import's last update.

" - } - }, - "StartEventTime": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

Used with EndEventTime to bound a StartImport request, and\n limit imported trail events to only those events logged within a specified time period.\n

" - } - }, - "EndEventTime": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

Used with StartEventTime to bound a StartImport request, and\n limit imported trail events to only those events logged within a specified time period.\n

" - } - }, - "ImportStatistics": { - "target": "com.amazonaws.cloudtrail#ImportStatistics", - "traits": { - "smithy.api#documentation": "

Returns information on the stopped import.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#StopLogging": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#StopLoggingRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#StopLoggingResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + "com.amazonaws.cloudtrail#ResourceARNNotValidException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourceARNNotValid", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

\n This exception is thrown when the provided resource does not exist, or the ARN format of the resource is not valid. The following is the valid format for a resource ARN: \n arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#ConflictException" + "com.amazonaws.cloudtrail#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._/\\-:]+$" + } }, - { - "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + "com.amazonaws.cloudtrail#ResourceIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#String" + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidHomeRegionException" + "com.amazonaws.cloudtrail#ResourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#Resource" + }, + "traits": { + "smithy.api#documentation": "

A list of resources referenced by the event returned.

" + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + "com.amazonaws.cloudtrail#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourceNotFound", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the specified resource is not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + "com.amazonaws.cloudtrail#ResourcePolicy": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 8192 + } + } }, - { - "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + "com.amazonaws.cloudtrail#ResourcePolicyNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourcePolicyNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n This exception is thrown when the specified resource policy is not found.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + "com.amazonaws.cloudtrail#ResourcePolicyNotValidException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourcePolicyNotValid", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

\n This exception is thrown when the resouce-based policy has syntax errors, or contains a principal that is not valid.\n

\n

The following are requirements for the resource policy:

\n ", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#TrailNotFoundException" + "com.amazonaws.cloudtrail#ResourceTag": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the ARN of the resource.

" + } + }, + "TagsList": { + "target": "com.amazonaws.cloudtrail#TagsList", + "traits": { + "smithy.api#documentation": "

A list of tags.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A resource tag.

" + } }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Suspends the recording of Amazon Web Services API calls and log file delivery for the\n specified trail. Under most circumstances, there is no need to use this action. You can\n update a trail without stopping it first. This action is the only way to stop recording.\n For a trail enabled in all Regions, this operation must be called from the Region in which\n the trail was created, or an InvalidHomeRegionException will occur. This\n operation cannot be called on the shadow trails (replicated trails in other Regions) of a\n trail enabled in all Regions.

", - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.cloudtrail#StopLoggingRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the name or the CloudTrail ARN of the trail for which CloudTrail\n will stop logging Amazon Web Services API calls. The following is the format of a trail\n ARN.

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Passes the request to CloudTrail to stop logging Amazon Web Services API calls for\n the specified account.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#StopLoggingResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

Returns the objects or data listed below if successful. Otherwise, returns an\n error.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#String": { - "type": "string" - }, - "com.amazonaws.cloudtrail#Tag": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.cloudtrail#TagKey", - "traits": { - "smithy.api#documentation": "

The key in a key-value pair. The key must be must be no longer than 128 Unicode\n characters. The key must be unique for the resource to which it applies.

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.cloudtrail#TagValue", - "traits": { - "smithy.api#documentation": "

The value in a key-value pair of a tag. The value must be no longer than 256 Unicode\n characters.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A custom key-value pair associated with a resource such as a CloudTrail\n trail, event data store, or channel.

" - } - }, - "com.amazonaws.cloudtrail#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.cloudtrail#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.cloudtrail#TagsLimitExceededException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "TagsLimitExceeded", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The number of tags per trail, event data store, or channel has exceeded the permitted amount. Currently, the limit is\n 50.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#TagsList": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudtrail#Tag" - }, - "traits": { - "smithy.api#documentation": "

A list of tags.

", - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.cloudtrail#TerminationProtectionEnabled": { - "type": "boolean" - }, - "com.amazonaws.cloudtrail#Trail": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Name of the trail set by calling CreateTrail. The maximum length is\n 128 characters.

" - } - }, - "S3BucketName": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Name of the Amazon S3 bucket into which CloudTrail delivers your trail\n files. See Amazon S3\n Bucket Naming Requirements.

" - } - }, - "S3KeyPrefix": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the Amazon S3 key prefix that comes after the name of the bucket you\n have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200\n characters.

" - } - }, - "SnsTopicName": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

This field is no longer in use. Use SnsTopicARN.

" - } - }, - "SnsTopicARN": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send\n notifications when log files are delivered. The following is the format of a topic\n ARN.

\n

\n arn:aws:sns:us-east-2:123456789012:MyTopic\n

" - } - }, - "IncludeGlobalServiceEvents": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Set to True to include Amazon Web Services API calls\n from Amazon Web Services global services such as IAM. Otherwise, False.

" - } - }, - "IsMultiRegionTrail": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether the trail exists only in one Region or exists in all Regions.

" - } - }, - "HomeRegion": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

The Region in which the trail was created.

" - } - }, - "TrailARN": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the ARN of the trail. The following is the format of a trail ARN.

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

" - } - }, - "LogFileValidationEnabled": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether log file validation is enabled.

" - } - }, - "CloudWatchLogsLogGroupArn": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log\n group to which CloudTrail logs will be delivered.

" - } - }, - "CloudWatchLogsRoleArn": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's\n log group.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#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\n following format.

\n

\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n

" - } - }, - "HasCustomEventSelectors": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies if the trail has custom event selectors.

" - } - }, - "HasInsightSelectors": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether a trail has insight types specified in an InsightSelector\n list.

" - } - }, - "IsOrganizationTrail": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether the trail is an organization trail.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The settings for a trail.

" - } - }, - "com.amazonaws.cloudtrail#TrailAlreadyExistsException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "TrailAlreadyExists", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This exception is thrown when the specified trail already exists.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#TrailInfo": { - "type": "structure", - "members": { - "TrailARN": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

The ARN of a trail.

" - } - }, - "Name": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

The name of a trail.

" - } - }, - "HomeRegion": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region in which a trail was created.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a CloudTrail trail, including the trail's name, home Region,\n and Amazon Resource Name (ARN).

" - } - }, - "com.amazonaws.cloudtrail#TrailList": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudtrail#Trail" - } - }, - "com.amazonaws.cloudtrail#TrailNameList": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudtrail#String" - } - }, - "com.amazonaws.cloudtrail#TrailNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "TrailNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

This exception is thrown when the trail with the given name is not found.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.cloudtrail#TrailNotProvidedException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "TrailNotProvided", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

This exception is no longer in use.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.cloudtrail#Trails": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudtrail#TrailInfo" - } - }, - "com.amazonaws.cloudtrail#UUID": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 36, - "max": 36 - }, - "smithy.api#pattern": "^[a-f0-9\\-]+$" - } - }, - "com.amazonaws.cloudtrail#UnsupportedOperationException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "UnsupportedOperation", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This exception is thrown when the requested operation is not supported.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudtrail#UpdateChannel": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#UpdateChannelRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#UpdateChannelResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#ChannelAlreadyExistsException" + "com.amazonaws.cloudtrail#ResourceTagList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#ResourceTag" + } }, - { - "target": "com.amazonaws.cloudtrail#ChannelARNInvalidException" + "com.amazonaws.cloudtrail#ResourceTypeNotSupportedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourceTypeNotSupported", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the specified resource type is not supported by CloudTrail.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#ChannelNotFoundException" + "com.amazonaws.cloudtrail#RestoreEventDataStore": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#RestoreEventDataStoreRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#RestoreEventDataStoreResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreMaxLimitExceededException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreStatusException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Restores a deleted event data store specified by EventDataStore, which\n accepts an event data store ARN. You can only restore a deleted event data store within the\n seven-day wait period after deletion. Restoring an event data store can take several\n minutes, depending on the size of the event data store.

" + } }, - { - "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + "com.amazonaws.cloudtrail#RestoreEventDataStoreRequest": { + "type": "structure", + "members": { + "EventDataStore": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The ARN (or the ID suffix of the ARN) of the event data store that you want to\n restore.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + "com.amazonaws.cloudtrail#RestoreEventDataStoreResponse": { + "type": "structure", + "members": { + "EventDataStoreArn": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The event data store ARN.

" + } + }, + "Name": { + "target": "com.amazonaws.cloudtrail#EventDataStoreName", + "traits": { + "smithy.api#documentation": "

The name of the event data store.

" + } + }, + "Status": { + "target": "com.amazonaws.cloudtrail#EventDataStoreStatus", + "traits": { + "smithy.api#documentation": "

The status of the event data store.

" + } + }, + "AdvancedEventSelectors": { + "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", + "traits": { + "smithy.api#documentation": "

The advanced event selectors that were used to select events.

" + } + }, + "MultiRegionEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the event data store is collecting events from all Regions, or only\n from the Region in which the event data store was created.

" + } + }, + "OrganizationEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether an event data store is collecting logged events for an organization in\n Organizations.

" + } + }, + "RetentionPeriod": { + "target": "com.amazonaws.cloudtrail#RetentionPeriod", + "traits": { + "smithy.api#documentation": "

The retention period, in days.

" + } + }, + "TerminationProtectionEnabled": { + "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", + "traits": { + "smithy.api#documentation": "

Indicates that termination protection is enabled and the event data store cannot be\n automatically deleted.

" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The timestamp of an event data store's creation.

" + } + }, + "UpdatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The timestamp that shows when an event data store was updated, if applicable.\n UpdatedTimestamp is always either the same or newer than the time shown in\n CreatedTimestamp.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.cloudtrail#EventDataStoreKmsKeyId", + "traits": { + "smithy.api#documentation": "

Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the\n following format.

\n

\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + "com.amazonaws.cloudtrail#RetentionPeriod": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 7, + "max": 2557 + } + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreCategoryException" + "com.amazonaws.cloudtrail#S3BucketDoesNotExistException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "S3BucketDoesNotExist", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

This exception is thrown when the specified S3 bucket does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidParameterException" + "com.amazonaws.cloudtrail#S3ImportSource": { + "type": "structure", + "members": { + "S3LocationUri": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The URI for the source S3 bucket.

", + "smithy.api#required": {} + } + }, + "S3BucketRegion": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The Region associated with the source S3 bucket.

", + "smithy.api#required": {} + } + }, + "S3BucketAccessRoleArn": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The IAM ARN role used to access the source S3 bucket.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The settings for the source S3 bucket.

" + } }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + "com.amazonaws.cloudtrail#SelectorField": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#pattern": "^[\\w|\\d|\\.|_]+$" + } }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a channel specified by a required channel ARN or UUID.

", - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.cloudtrail#UpdateChannelRequest": { - "type": "structure", - "members": { - "Channel": { - "target": "com.amazonaws.cloudtrail#ChannelArn", - "traits": { - "smithy.api#documentation": "

The ARN or ID (the ARN suffix) of the channel that you want to update.

", - "smithy.api#required": {} - } - }, - "Destinations": { - "target": "com.amazonaws.cloudtrail#Destinations", - "traits": { - "smithy.api#documentation": "

The ARNs of event data stores that you want to log events arriving through the channel.

" - } - }, - "Name": { - "target": "com.amazonaws.cloudtrail#ChannelName", - "traits": { - "smithy.api#documentation": "

\n Changes the name of the channel.\n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#UpdateChannelResponse": { - "type": "structure", - "members": { - "ChannelArn": { - "target": "com.amazonaws.cloudtrail#ChannelArn", - "traits": { - "smithy.api#documentation": "

The ARN of the channel that was updated.

" - } - }, - "Name": { - "target": "com.amazonaws.cloudtrail#ChannelName", - "traits": { - "smithy.api#documentation": "

The name of the channel that was updated.

" - } - }, - "Source": { - "target": "com.amazonaws.cloudtrail#Source", - "traits": { - "smithy.api#documentation": "

The event source of the channel that was updated.

" - } - }, - "Destinations": { - "target": "com.amazonaws.cloudtrail#Destinations", - "traits": { - "smithy.api#documentation": "

The event data stores that log events arriving through the channel.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#UpdateEventDataStore": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#UpdateEventDataStoreRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#UpdateEventDataStoreResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException" + "com.amazonaws.cloudtrail#SelectorName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + }, + "smithy.api#pattern": ".*" + } }, - { - "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + "com.amazonaws.cloudtrail#Source": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": ".*" + } }, - { - "target": "com.amazonaws.cloudtrail#EventDataStoreHasOngoingImportException" + "com.amazonaws.cloudtrail#SourceConfig": { + "type": "structure", + "members": { + "ApplyToAllRegions": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the channel applies to a single Region or to all Regions.

" + } + }, + "AdvancedEventSelectors": { + "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", + "traits": { + "smithy.api#documentation": "

The advanced event selectors that are configured for the channel.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains configuration information about the channel.

" + } }, - { - "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + "com.amazonaws.cloudtrail#StartEventDataStoreIngestion": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#StartEventDataStoreIngestionRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#StartEventDataStoreIngestionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreCategoryException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreStatusException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN. To start ingestion, the event data store Status must be STOPPED_INGESTION \n and the eventCategory must be Management, Data, or ConfigurationItem.

" + } }, - { - "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + "com.amazonaws.cloudtrail#StartEventDataStoreIngestionRequest": { + "type": "structure", + "members": { + "EventDataStore": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The ARN (or ID suffix of the ARN) of the event data store for which you want to start ingestion.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + "com.amazonaws.cloudtrail#StartEventDataStoreIngestionResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" + "com.amazonaws.cloudtrail#StartImport": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#StartImportRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#StartImportResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#AccountHasOngoingImportException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#ImportNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreCategoryException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreStatusException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidImportSourceException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an import of logged trail events from a source S3 bucket to a destination event\n data store. By default, CloudTrail only imports events contained in the S3 bucket's\n CloudTrail prefix and the prefixes inside the CloudTrail prefix, and does not check prefixes for other Amazon Web Services\n services. If you want to import CloudTrail events contained in another prefix, you\n must include the prefix in the S3LocationUri. For more considerations about\n importing trail events, see Considerations.

\n

When you start a new import, the Destinations and\n ImportSource parameters are required. Before starting a new import, disable\n any access control lists (ACLs) attached to the source S3 bucket. For more information\n about disabling ACLs, see Controlling ownership of\n objects and disabling ACLs for your bucket.

\n

When you retry an import, the ImportID parameter is required.

\n \n

If the destination event data store is for an organization, you must use the\n management account to import trail events. You cannot use the delegated administrator\n account for the organization.

\n " + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidEventSelectorsException" + "com.amazonaws.cloudtrail#StartImportRequest": { + "type": "structure", + "members": { + "Destinations": { + "target": "com.amazonaws.cloudtrail#ImportDestinations", + "traits": { + "smithy.api#documentation": "

The ARN of the destination event data store. Use this parameter for a new import.\n

" + } + }, + "ImportSource": { + "target": "com.amazonaws.cloudtrail#ImportSource", + "traits": { + "smithy.api#documentation": "

The source S3 bucket for the import. Use this parameter for a new import.

" + } + }, + "StartEventTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Use with EndEventTime to bound a StartImport request, and\n limit imported trail events to only those events logged within a specified time period.\n When you specify a time range, CloudTrail checks the prefix and log file names to\n verify the names contain a date between the specified StartEventTime and\n EndEventTime before attempting to import events.

" + } + }, + "EndEventTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Use with StartEventTime to bound a StartImport request, and\n limit imported trail events to only those events logged within a specified time period.\n When you specify a time range, CloudTrail checks the prefix and log file names to\n verify the names contain a date between the specified StartEventTime and\n EndEventTime before attempting to import events.

" + } + }, + "ImportId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The ID of the import. Use this parameter when you are retrying an import.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidKmsKeyIdException" + "com.amazonaws.cloudtrail#StartImportResponse": { + "type": "structure", + "members": { + "ImportId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The ID of the import.

" + } + }, + "Destinations": { + "target": "com.amazonaws.cloudtrail#ImportDestinations", + "traits": { + "smithy.api#documentation": "

The ARN of the destination event data store.

" + } + }, + "ImportSource": { + "target": "com.amazonaws.cloudtrail#ImportSource", + "traits": { + "smithy.api#documentation": "

The source S3 bucket for the import.

" + } + }, + "StartEventTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Used with EndEventTime to bound a StartImport request, and\n limit imported trail events to only those events logged within a specified time period.\n

" + } + }, + "EndEventTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Used with StartEventTime to bound a StartImport request, and\n limit imported trail events to only those events logged within a specified time period.\n

" + } + }, + "ImportStatus": { + "target": "com.amazonaws.cloudtrail#ImportStatus", + "traits": { + "smithy.api#documentation": "

Shows the status of the import after a StartImport request. An import\n finishes with a status of COMPLETED if there were no failures, or\n FAILED if there were failures.

" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The timestamp for the import's creation.

" + } + }, + "UpdatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The timestamp of the import's last update, if applicable.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidParameterException" + "com.amazonaws.cloudtrail#StartLogging": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#StartLoggingRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#StartLoggingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#ConflictException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidHomeRegionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#TrailNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts the recording of Amazon Web Services API calls and log file delivery for a trail.\n For a trail that is enabled in all Regions, this operation must be called from the Region\n in which the trail was created. This operation cannot be called on the shadow trails\n (replicated trails in other Regions) of a trail that is enabled in all Regions.

", + "smithy.api#idempotent": {} + } }, - { - "target": "com.amazonaws.cloudtrail#KmsException" + "com.amazonaws.cloudtrail#StartLoggingRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the name or the CloudTrail ARN of the trail for which CloudTrail\n logs Amazon Web Services API calls. The following is the format of a trail ARN.

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request to CloudTrail to start logging Amazon Web Services API calls for an\n account.

", + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#KmsKeyNotFoundException" + "com.amazonaws.cloudtrail#StartLoggingResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Returns the objects or data listed below if successful. Otherwise, returns an\n error.

", + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + "com.amazonaws.cloudtrail#StartQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#StartQueryRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#StartQueryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientS3BucketPolicyException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidQueryStatementException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidS3BucketNameException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidS3PrefixException" + }, + { + "target": "com.amazonaws.cloudtrail#MaxConcurrentQueriesException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#S3BucketDoesNotExistException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a CloudTrail Lake query. Use the QueryStatement\n parameter to provide your SQL query, enclosed in single quotation marks. Use the optional\n DeliveryS3Uri parameter to deliver the query results to an S3\n bucket.

\n

\n StartQuery requires you specify either the QueryStatement parameter, or a QueryAlias and any QueryParameters. In the current release, \n the QueryAlias and QueryParameters parameters are used only for the queries that populate the CloudTrail Lake dashboards.

", + "smithy.api#idempotent": {} + } }, - { - "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + "com.amazonaws.cloudtrail#StartQueryRequest": { + "type": "structure", + "members": { + "QueryStatement": { + "target": "com.amazonaws.cloudtrail#QueryStatement", + "traits": { + "smithy.api#documentation": "

The SQL code of your query.

" + } + }, + "DeliveryS3Uri": { + "target": "com.amazonaws.cloudtrail#DeliveryS3Uri", + "traits": { + "smithy.api#documentation": "

The URI for the S3 bucket where CloudTrail delivers the query results.

" + } + }, + "QueryAlias": { + "target": "com.amazonaws.cloudtrail#QueryAlias", + "traits": { + "smithy.api#documentation": "

\n The alias that identifies a query template.\n

" + } + }, + "QueryParameters": { + "target": "com.amazonaws.cloudtrail#QueryParameters", + "traits": { + "smithy.api#documentation": "

\n The query parameters for the specified QueryAlias.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + "com.amazonaws.cloudtrail#StartQueryResponse": { + "type": "structure", + "members": { + "QueryId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The ID of the started query.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException" + "com.amazonaws.cloudtrail#StopEventDataStoreIngestion": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#StopEventDataStoreIngestionRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#StopEventDataStoreIngestionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreCategoryException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreStatusException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN. To stop ingestion, the event data store Status must be ENABLED \n and the eventCategory must be Management, Data, or ConfigurationItem.

" + } }, - { - "target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException" + "com.amazonaws.cloudtrail#StopEventDataStoreIngestionRequest": { + "type": "structure", + "members": { + "EventDataStore": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The ARN (or ID suffix of the ARN) of the event data store for which you want to stop ingestion.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates an event data store. The required EventDataStore value is an ARN or\n the ID portion of the ARN. Other parameters are optional, but at least one optional\n parameter must be specified, or CloudTrail throws an error.\n RetentionPeriod is in days, and valid values are integers between 90 and\n 2557. By default, TerminationProtection is enabled.

\n

For event data stores for CloudTrail events, AdvancedEventSelectors\n includes or excludes management and data events in your event data store. For more\n information about AdvancedEventSelectors, see PutEventSelectorsRequest$AdvancedEventSelectors.

\n

For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events,\n AdvancedEventSelectors includes events of that type in your event data store.

", - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.cloudtrail#UpdateEventDataStoreRequest": { - "type": "structure", - "members": { - "EventDataStore": { - "target": "com.amazonaws.cloudtrail#EventDataStoreArn", - "traits": { - "smithy.api#documentation": "

The ARN (or the ID suffix of the ARN) of the event data store that you want to\n update.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.cloudtrail#EventDataStoreName", - "traits": { - "smithy.api#documentation": "

The event data store name.

" - } - }, - "AdvancedEventSelectors": { - "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", - "traits": { - "smithy.api#documentation": "

The advanced event selectors used to select events for the event data store. You can\n configure up to five advanced event selectors for each event data store.

" - } - }, - "MultiRegionEnabled": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether an event data store collects events from all Regions, or only from the\n Region in which it was created.

" - } - }, - "OrganizationEnabled": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether an event data store collects events logged for an organization in\n Organizations.

" - } - }, - "RetentionPeriod": { - "target": "com.amazonaws.cloudtrail#RetentionPeriod", - "traits": { - "smithy.api#documentation": "

The retention period, in days.

" - } - }, - "TerminationProtectionEnabled": { - "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", - "traits": { - "smithy.api#documentation": "

Indicates that termination protection is enabled and the event data store cannot be\n automatically deleted.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.cloudtrail#EventDataStoreKmsKeyId", - "traits": { - "smithy.api#documentation": "

Specifies the KMS key ID to use to encrypt the events delivered by\n CloudTrail. The value can be an alias name prefixed by alias/, a\n fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique\n identifier.

\n \n

Disabling or deleting the KMS key, or removing CloudTrail\n permissions on the key, prevents CloudTrail from logging events to the event data\n store, and prevents users from querying the data in the event data store that was\n encrypted with the key. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed. Before you\n disable or delete a KMS key that you are using with an event data store,\n delete or back up your event data store.

\n \n

CloudTrail also supports KMS multi-Region keys. For more\n information about multi-Region keys, see Using multi-Region\n keys in the Key Management Service Developer Guide.

\n

Examples:

\n " - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#UpdateEventDataStoreResponse": { - "type": "structure", - "members": { - "EventDataStoreArn": { - "target": "com.amazonaws.cloudtrail#EventDataStoreArn", - "traits": { - "smithy.api#documentation": "

The ARN of the event data store.

" - } - }, - "Name": { - "target": "com.amazonaws.cloudtrail#EventDataStoreName", - "traits": { - "smithy.api#documentation": "

The name of the event data store.

" - } - }, - "Status": { - "target": "com.amazonaws.cloudtrail#EventDataStoreStatus", - "traits": { - "smithy.api#documentation": "

The status of an event data store.

" - } - }, - "AdvancedEventSelectors": { - "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", - "traits": { - "smithy.api#documentation": "

The advanced event selectors that are applied to the event data store.

" - } - }, - "MultiRegionEnabled": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether the event data store includes events from all Regions, or only from\n the Region in which it was created.

" - } - }, - "OrganizationEnabled": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether an event data store is collecting logged events for an organization in\n Organizations.

" - } - }, - "RetentionPeriod": { - "target": "com.amazonaws.cloudtrail#RetentionPeriod", - "traits": { - "smithy.api#documentation": "

The retention period, in days.

" - } - }, - "TerminationProtectionEnabled": { - "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", - "traits": { - "smithy.api#documentation": "

Indicates whether termination protection is enabled for the event data store.

" - } - }, - "CreatedTimestamp": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

The timestamp that shows when an event data store was first created.

" - } - }, - "UpdatedTimestamp": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

The timestamp that shows when the event data store was last updated.\n UpdatedTimestamp is always either the same or newer than the time shown in\n CreatedTimestamp.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.cloudtrail#EventDataStoreKmsKeyId", - "traits": { - "smithy.api#documentation": "

Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the\n following format.

\n

\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudtrail#UpdateTrail": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudtrail#UpdateTrailRequest" - }, - "output": { - "target": "com.amazonaws.cloudtrail#UpdateTrailResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException" + "com.amazonaws.cloudtrail#StopEventDataStoreIngestionResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + "com.amazonaws.cloudtrail#StopImport": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#StopImportRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#StopImportResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#ImportNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops a specified import.

" + } }, - { - "target": "com.amazonaws.cloudtrail#CloudTrailInvalidClientTokenIdException" + "com.amazonaws.cloudtrail#StopImportRequest": { + "type": "structure", + "members": { + "ImportId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The ID of the import.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#CloudWatchLogsDeliveryUnavailableException" + "com.amazonaws.cloudtrail#StopImportResponse": { + "type": "structure", + "members": { + "ImportId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The ID for the import.

" + } + }, + "ImportSource": { + "target": "com.amazonaws.cloudtrail#ImportSource", + "traits": { + "smithy.api#documentation": "

The source S3 bucket for the import.

" + } + }, + "Destinations": { + "target": "com.amazonaws.cloudtrail#ImportDestinations", + "traits": { + "smithy.api#documentation": "

The ARN of the destination event data store.

" + } + }, + "ImportStatus": { + "target": "com.amazonaws.cloudtrail#ImportStatus", + "traits": { + "smithy.api#documentation": "

The status of the import.

" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The timestamp of the import's creation.

" + } + }, + "UpdatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The timestamp of the import's last update.

" + } + }, + "StartEventTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Used with EndEventTime to bound a StartImport request, and\n limit imported trail events to only those events logged within a specified time period.\n

" + } + }, + "EndEventTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Used with StartEventTime to bound a StartImport request, and\n limit imported trail events to only those events logged within a specified time period.\n

" + } + }, + "ImportStatistics": { + "target": "com.amazonaws.cloudtrail#ImportStatistics", + "traits": { + "smithy.api#documentation": "

Returns information on the stopped import.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#ConflictException" + "com.amazonaws.cloudtrail#StopLogging": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#StopLoggingRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#StopLoggingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#ConflictException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidHomeRegionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#TrailNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Suspends the recording of Amazon Web Services API calls and log file delivery for the\n specified trail. Under most circumstances, there is no need to use this action. You can\n update a trail without stopping it first. This action is the only way to stop recording.\n For a trail enabled in all Regions, this operation must be called from the Region in which\n the trail was created, or an InvalidHomeRegionException will occur. This\n operation cannot be called on the shadow trails (replicated trails in other Regions) of a\n trail enabled in all Regions.

", + "smithy.api#idempotent": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + "com.amazonaws.cloudtrail#StopLoggingRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the name or the CloudTrail ARN of the trail for which CloudTrail\n will stop logging Amazon Web Services API calls. The following is the format of a trail\n ARN.

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Passes the request to CloudTrail to stop logging Amazon Web Services API calls for\n the specified account.

", + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" + "com.amazonaws.cloudtrail#StopLoggingResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Returns the objects or data listed below if successful. Otherwise, returns an\n error.

", + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#InsufficientS3BucketPolicyException" + "com.amazonaws.cloudtrail#String": { + "type": "string" + }, + "com.amazonaws.cloudtrail#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.cloudtrail#TagKey", + "traits": { + "smithy.api#documentation": "

The key in a key-value pair. The key must be must be no longer than 128 Unicode\n characters. The key must be unique for the resource to which it applies.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.cloudtrail#TagValue", + "traits": { + "smithy.api#documentation": "

The value in a key-value pair of a tag. The value must be no longer than 256 Unicode\n characters.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A custom key-value pair associated with a resource such as a CloudTrail\n trail, event data store, or channel.

" + } }, - { - "target": "com.amazonaws.cloudtrail#InsufficientSnsTopicPolicyException" + "com.amazonaws.cloudtrail#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidCloudWatchLogsLogGroupArnException" + "com.amazonaws.cloudtrail#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidCloudWatchLogsRoleArnException" + "com.amazonaws.cloudtrail#TagsLimitExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "TagsLimitExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The number of tags per trail, event data store, or channel has exceeded the permitted amount. Currently, the limit is\n 50.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidEventSelectorsException" + "com.amazonaws.cloudtrail#TagsList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#Tag" + }, + "traits": { + "smithy.api#documentation": "

A list of tags.

", + "smithy.api#length": { + "min": 0, + "max": 200 + } + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidHomeRegionException" + "com.amazonaws.cloudtrail#TerminationProtectionEnabled": { + "type": "boolean" }, - { - "target": "com.amazonaws.cloudtrail#InvalidKmsKeyIdException" + "com.amazonaws.cloudtrail#Trail": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Name of the trail set by calling CreateTrail. The maximum length is\n 128 characters.

" + } + }, + "S3BucketName": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Name of the Amazon S3 bucket into which CloudTrail delivers your trail\n files. See Amazon S3\n Bucket Naming Requirements.

" + } + }, + "S3KeyPrefix": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon S3 key prefix that comes after the name of the bucket you\n have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200\n characters.

" + } + }, + "SnsTopicName": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

This field is no longer in use. Use SnsTopicARN.

" + } + }, + "SnsTopicARN": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send\n notifications when log files are delivered. The following is the format of a topic\n ARN.

\n

\n arn:aws:sns:us-east-2:123456789012:MyTopic\n

" + } + }, + "IncludeGlobalServiceEvents": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Set to True to include Amazon Web Services API calls\n from Amazon Web Services global services such as IAM. Otherwise, False.

" + } + }, + "IsMultiRegionTrail": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the trail exists only in one Region or exists in all Regions.

" + } + }, + "HomeRegion": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The Region in which the trail was created.

" + } + }, + "TrailARN": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the ARN of the trail. The following is the format of a trail ARN.

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

" + } + }, + "LogFileValidationEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether log file validation is enabled.

" + } + }, + "CloudWatchLogsLogGroupArn": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log\n group to which CloudTrail logs will be delivered.

" + } + }, + "CloudWatchLogsRoleArn": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's\n log group.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#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\n following format.

\n

\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n

" + } + }, + "HasCustomEventSelectors": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies if the trail has custom event selectors.

" + } + }, + "HasInsightSelectors": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether a trail has insight types specified in an InsightSelector\n list.

" + } + }, + "IsOrganizationTrail": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the trail is an organization trail.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The settings for a trail.

" + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidParameterCombinationException" + "com.amazonaws.cloudtrail#TrailAlreadyExistsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "TrailAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the specified trail already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidParameterException" + "com.amazonaws.cloudtrail#TrailInfo": { + "type": "structure", + "members": { + "TrailARN": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The ARN of a trail.

" + } + }, + "Name": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The name of a trail.

" + } + }, + "HomeRegion": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region in which a trail was created.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a CloudTrail trail, including the trail's name, home Region,\n and Amazon Resource Name (ARN).

" + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidS3BucketNameException" + "com.amazonaws.cloudtrail#TrailList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#Trail" + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidS3PrefixException" + "com.amazonaws.cloudtrail#TrailNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#String" + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidSnsTopicNameException" + "com.amazonaws.cloudtrail#TrailNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "TrailNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

This exception is thrown when the trail with the given name is not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } }, - { - "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + "com.amazonaws.cloudtrail#TrailNotProvidedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "TrailNotProvided", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

This exception is no longer in use.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } }, - { - "target": "com.amazonaws.cloudtrail#KmsException" + "com.amazonaws.cloudtrail#Trails": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#TrailInfo" + } }, - { - "target": "com.amazonaws.cloudtrail#KmsKeyDisabledException" + "com.amazonaws.cloudtrail#UUID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[a-f0-9\\-]+$" + } }, - { - "target": "com.amazonaws.cloudtrail#KmsKeyNotFoundException" + "com.amazonaws.cloudtrail#UnsupportedOperationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "UnsupportedOperation", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the requested operation is not supported.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + "com.amazonaws.cloudtrail#UpdateChannel": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#UpdateChannelRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#UpdateChannelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#ChannelAlreadyExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#ChannelARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#ChannelNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreCategoryException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a channel specified by a required channel ARN or UUID.

", + "smithy.api#idempotent": {} + } }, - { - "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + "com.amazonaws.cloudtrail#UpdateChannelRequest": { + "type": "structure", + "members": { + "Channel": { + "target": "com.amazonaws.cloudtrail#ChannelArn", + "traits": { + "smithy.api#documentation": "

The ARN or ID (the ARN suffix) of the channel that you want to update.

", + "smithy.api#required": {} + } + }, + "Destinations": { + "target": "com.amazonaws.cloudtrail#Destinations", + "traits": { + "smithy.api#documentation": "

The ARNs of event data stores that you want to log events arriving through the channel.

" + } + }, + "Name": { + "target": "com.amazonaws.cloudtrail#ChannelName", + "traits": { + "smithy.api#documentation": "

\n Changes the name of the channel.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + "com.amazonaws.cloudtrail#UpdateChannelResponse": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.cloudtrail#ChannelArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel that was updated.

" + } + }, + "Name": { + "target": "com.amazonaws.cloudtrail#ChannelName", + "traits": { + "smithy.api#documentation": "

The name of the channel that was updated.

" + } + }, + "Source": { + "target": "com.amazonaws.cloudtrail#Source", + "traits": { + "smithy.api#documentation": "

The event source of the channel that was updated.

" + } + }, + "Destinations": { + "target": "com.amazonaws.cloudtrail#Destinations", + "traits": { + "smithy.api#documentation": "

The event data stores that log events arriving through the channel.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException" + "com.amazonaws.cloudtrail#UpdateEventDataStore": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#UpdateEventDataStoreRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#UpdateEventDataStoreResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreAlreadyExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreHasOngoingImportException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidEventSelectorsException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidKmsKeyIdException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#KmsException" + }, + { + "target": "com.amazonaws.cloudtrail#KmsKeyNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an event data store. The required EventDataStore value is an ARN or\n the ID portion of the ARN. Other parameters are optional, but at least one optional\n parameter must be specified, or CloudTrail throws an error.\n RetentionPeriod is in days, and valid values are integers between 90 and\n 2557. By default, TerminationProtection is enabled.

\n

For event data stores for CloudTrail events, AdvancedEventSelectors\n includes or excludes management and data events in your event data store. For more\n information about AdvancedEventSelectors, see \n AdvancedEventSelectors.

\n

For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events,\n AdvancedEventSelectors includes events of that type in your event data store.

", + "smithy.api#idempotent": {} + } }, - { - "target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException" + "com.amazonaws.cloudtrail#UpdateEventDataStoreRequest": { + "type": "structure", + "members": { + "EventDataStore": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The ARN (or the ID suffix of the ARN) of the event data store that you want to\n update.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.cloudtrail#EventDataStoreName", + "traits": { + "smithy.api#documentation": "

The event data store name.

" + } + }, + "AdvancedEventSelectors": { + "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", + "traits": { + "smithy.api#documentation": "

The advanced event selectors used to select events for the event data store. You can\n configure up to five advanced event selectors for each event data store.

" + } + }, + "MultiRegionEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether an event data store collects events from all Regions, or only from the\n Region in which it was created.

" + } + }, + "OrganizationEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether an event data store collects events logged for an organization in\n Organizations.

" + } + }, + "RetentionPeriod": { + "target": "com.amazonaws.cloudtrail#RetentionPeriod", + "traits": { + "smithy.api#documentation": "

The retention period, in days.

" + } + }, + "TerminationProtectionEnabled": { + "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", + "traits": { + "smithy.api#documentation": "

Indicates that termination protection is enabled and the event data store cannot be\n automatically deleted.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.cloudtrail#EventDataStoreKmsKeyId", + "traits": { + "smithy.api#documentation": "

Specifies the KMS key ID to use to encrypt the events delivered by\n CloudTrail. The value can be an alias name prefixed by alias/, a\n fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique\n identifier.

\n \n

Disabling or deleting the KMS key, or removing CloudTrail\n permissions on the key, prevents CloudTrail from logging events to the event data\n store, and prevents users from querying the data in the event data store that was\n encrypted with the key. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed. Before you\n disable or delete a KMS key that you are using with an event data store,\n delete or back up your event data store.

\n \n

CloudTrail also supports KMS multi-Region keys. For more\n information about multi-Region keys, see Using multi-Region\n keys in the Key Management Service Developer Guide.

\n

Examples:

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#S3BucketDoesNotExistException" + "com.amazonaws.cloudtrail#UpdateEventDataStoreResponse": { + "type": "structure", + "members": { + "EventDataStoreArn": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The ARN of the event data store.

" + } + }, + "Name": { + "target": "com.amazonaws.cloudtrail#EventDataStoreName", + "traits": { + "smithy.api#documentation": "

The name of the event data store.

" + } + }, + "Status": { + "target": "com.amazonaws.cloudtrail#EventDataStoreStatus", + "traits": { + "smithy.api#documentation": "

The status of an event data store.

" + } + }, + "AdvancedEventSelectors": { + "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", + "traits": { + "smithy.api#documentation": "

The advanced event selectors that are applied to the event data store.

" + } + }, + "MultiRegionEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the event data store includes events from all Regions, or only from\n the Region in which it was created.

" + } + }, + "OrganizationEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether an event data store is collecting logged events for an organization in\n Organizations.

" + } + }, + "RetentionPeriod": { + "target": "com.amazonaws.cloudtrail#RetentionPeriod", + "traits": { + "smithy.api#documentation": "

The retention period, in days.

" + } + }, + "TerminationProtectionEnabled": { + "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether termination protection is enabled for the event data store.

" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The timestamp that shows when an event data store was first created.

" + } + }, + "UpdatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The timestamp that shows when the event data store was last updated.\n UpdatedTimestamp is always either the same or newer than the time shown in\n CreatedTimestamp.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.cloudtrail#EventDataStoreKmsKeyId", + "traits": { + "smithy.api#documentation": "

Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the\n following format.

\n

\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudtrail#TrailNotFoundException" + "com.amazonaws.cloudtrail#UpdateTrail": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#UpdateTrailRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#UpdateTrailResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException" + }, + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#CloudTrailInvalidClientTokenIdException" + }, + { + "target": "com.amazonaws.cloudtrail#CloudWatchLogsDeliveryUnavailableException" + }, + { + "target": "com.amazonaws.cloudtrail#ConflictException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientS3BucketPolicyException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientSnsTopicPolicyException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidCloudWatchLogsLogGroupArnException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidCloudWatchLogsRoleArnException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidEventSelectorsException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidHomeRegionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidKmsKeyIdException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidS3BucketNameException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidS3PrefixException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidSnsTopicNameException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + }, + { + "target": "com.amazonaws.cloudtrail#KmsException" + }, + { + "target": "com.amazonaws.cloudtrail#KmsKeyDisabledException" + }, + { + "target": "com.amazonaws.cloudtrail#KmsKeyNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException" + }, + { + "target": "com.amazonaws.cloudtrail#S3BucketDoesNotExistException" + }, + { + "target": "com.amazonaws.cloudtrail#TrailNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#TrailNotProvidedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates trail settings that control what events you are logging, and how to handle log\n files. Changes to a trail do not require stopping the CloudTrail service. Use this\n action to designate an existing bucket for log delivery. If the existing bucket has\n previously been a target for CloudTrail log files, an IAM policy\n exists for the bucket. UpdateTrail must be called from the Region in which the\n trail was created; otherwise, an InvalidHomeRegionException is thrown.

", + "smithy.api#idempotent": {} + } }, - { - "target": "com.amazonaws.cloudtrail#TrailNotProvidedException" + "com.amazonaws.cloudtrail#UpdateTrailRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the trail or trail ARN. If Name is a trail name, the\n string must meet the following requirements:

\n \n

If Name is a trail ARN, it must be in the following format.

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

", + "smithy.api#required": {} + } + }, + "S3BucketName": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the Amazon S3 bucket designated for publishing log files.\n See Amazon S3\n Bucket Naming Requirements.

" + } + }, + "S3KeyPrefix": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon S3 key prefix that comes after the name of the bucket you\n have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200\n characters.

" + } + }, + "SnsTopicName": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the Amazon SNS topic defined for notification of log file\n delivery. The maximum length is 256 characters.

" + } + }, + "IncludeGlobalServiceEvents": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the trail is publishing events from global services such as IAM to the log files.

" + } + }, + "IsMultiRegionTrail": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the trail applies only to the current Region or to all Regions. The\n default is false. If the trail exists only in the current Region and this value is set to\n true, shadow trails (replications of the trail) will be created in the other Regions. If\n the trail exists in all Regions and this value is set to false, the trail will remain in\n the Region where it was created, and its shadow trails in other Regions will be deleted. As\n a best practice, consider using trails that log events in all Regions.

" + } + }, + "EnableLogFileValidation": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether log file validation is enabled. The default is false.

\n \n

When you disable log file integrity validation, the chain of digest files is broken\n after one hour. CloudTrail does not create digest files for log files that were\n delivered during a period in which log file integrity validation was disabled. For\n example, if you enable log file integrity validation at noon on January 1, disable it at\n noon on January 2, and re-enable it at noon on January 10, digest files will not be\n created for the log files delivered from noon on January 2 to noon on January 10. The\n same applies whenever you stop CloudTrail logging or delete a trail.

\n " + } + }, + "CloudWatchLogsLogGroupArn": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that\n represents the log group to which CloudTrail logs are delivered. You must use a log\n group that exists in your account.

\n

Not required unless you specify CloudWatchLogsRoleArn.

" + } + }, + "CloudWatchLogsRoleArn": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's\n log group. You must use a role that exists in your account.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#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\n an alias, a fully specified ARN to a key, or a globally unique identifier.

\n

CloudTrail also supports KMS multi-Region keys. For more\n information about multi-Region keys, see Using multi-Region\n keys in the Key Management Service Developer Guide.

\n

Examples:

\n " + } + }, + "IsOrganizationTrail": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the trail is applied to all accounts in an organization in Organizations, or only for the current Amazon Web Services account. The default is false,\n and cannot be true unless the call is made on behalf of an Amazon Web Services account that\n is the management account or delegated administrator account for an organization in Organizations. If the trail is not an organization trail and this is set to\n true, the trail will be created in all Amazon Web Services accounts that\n belong to the organization. If the trail is an organization trail and this is set to\n false, the trail will remain in the current Amazon Web Services account but\n be deleted from all member accounts in the organization.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies settings to update for the trail.

", + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates trail settings that control what events you are logging, and how to handle log\n files. Changes to a trail do not require stopping the CloudTrail service. Use this\n action to designate an existing bucket for log delivery. If the existing bucket has\n previously been a target for CloudTrail log files, an IAM policy\n exists for the bucket. UpdateTrail must be called from the Region in which the\n trail was created; otherwise, an InvalidHomeRegionException is thrown.

", - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.cloudtrail#UpdateTrailRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the trail or trail ARN. If Name is a trail name, the\n string must meet the following requirements:

\n \n

If Name is a trail ARN, it must be in the following format.

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

", - "smithy.api#required": {} - } - }, - "S3BucketName": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the Amazon S3 bucket designated for publishing log files.\n See Amazon S3\n Bucket Naming Requirements.

" - } - }, - "S3KeyPrefix": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the Amazon S3 key prefix that comes after the name of the bucket you\n have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200\n characters.

" - } - }, - "SnsTopicName": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the Amazon SNS topic defined for notification of log file\n delivery. The maximum length is 256 characters.

" - } - }, - "IncludeGlobalServiceEvents": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether the trail is publishing events from global services such as IAM to the log files.

" - } - }, - "IsMultiRegionTrail": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether the trail applies only to the current Region or to all Regions. The\n default is false. If the trail exists only in the current Region and this value is set to\n true, shadow trails (replications of the trail) will be created in the other Regions. If\n the trail exists in all Regions and this value is set to false, the trail will remain in\n the Region where it was created, and its shadow trails in other Regions will be deleted. As\n a best practice, consider using trails that log events in all Regions.

" - } - }, - "EnableLogFileValidation": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether log file validation is enabled. The default is false.

\n \n

When you disable log file integrity validation, the chain of digest files is broken\n after one hour. CloudTrail does not create digest files for log files that were\n delivered during a period in which log file integrity validation was disabled. For\n example, if you enable log file integrity validation at noon on January 1, disable it at\n noon on January 2, and re-enable it at noon on January 10, digest files will not be\n created for the log files delivered from noon on January 2 to noon on January 10. The\n same applies whenever you stop CloudTrail logging or delete a trail.

\n " - } - }, - "CloudWatchLogsLogGroupArn": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that\n represents the log group to which CloudTrail logs are delivered. You must use a log\n group that exists in your account.

\n

Not required unless you specify CloudWatchLogsRoleArn.

" - } - }, - "CloudWatchLogsRoleArn": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's\n log group. You must use a role that exists in your account.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#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\n an alias, a fully specified ARN to a key, or a globally unique identifier.

\n

CloudTrail also supports KMS multi-Region keys. For more\n information about multi-Region keys, see Using multi-Region\n keys in the Key Management Service Developer Guide.

\n

Examples:

\n " - } - }, - "IsOrganizationTrail": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether the trail is applied to all accounts in an organization in Organizations, or only for the current Amazon Web Services account. The default is false,\n and cannot be true unless the call is made on behalf of an Amazon Web Services account that\n is the management account or delegated administrator account for an organization in Organizations. If the trail is not an organization trail and this is set to\n true, the trail will be created in all Amazon Web Services accounts that\n belong to the organization. If the trail is an organization trail and this is set to\n false, the trail will remain in the current Amazon Web Services account but\n be deleted from all member accounts in the organization.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies settings to update for the trail.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudtrail#UpdateTrailResponse": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the trail.

" - } - }, - "S3BucketName": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the Amazon S3 bucket designated for publishing log\n files.

" - } - }, - "S3KeyPrefix": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the Amazon S3 key prefix that comes after the name of the bucket you\n have designated for log file delivery. For more information, see Finding Your IAM Log Files.

" - } - }, - "SnsTopicName": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

This field is no longer in use. Use UpdateTrailResponse$SnsTopicARN.

" - } - }, - "SnsTopicARN": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send\n notifications when log files are delivered. The following is the format of a topic\n ARN.

\n

\n arn:aws:sns:us-east-2:123456789012:MyTopic\n

" - } - }, - "IncludeGlobalServiceEvents": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether the trail is publishing events from global services such as IAM to the log files.

" - } - }, - "IsMultiRegionTrail": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether the trail exists in one Region or in all Regions.

" - } - }, - "TrailARN": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the ARN of the trail that was updated. The following is the format of a trail\n ARN.

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

" - } - }, - "LogFileValidationEnabled": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether log file integrity validation is enabled.

" - } - }, - "CloudWatchLogsLogGroupArn": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail\n logs are delivered.

" - } - }, - "CloudWatchLogsRoleArn": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's\n log group.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#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\n following format.

\n

\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n

" - } - }, - "IsOrganizationTrail": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether the trail is an organization trail.

" - } + "com.amazonaws.cloudtrail#UpdateTrailResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the trail.

" + } + }, + "S3BucketName": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the Amazon S3 bucket designated for publishing log\n files.

" + } + }, + "S3KeyPrefix": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon S3 key prefix that comes after the name of the bucket you\n have designated for log file delivery. For more information, see Finding Your IAM Log Files.

" + } + }, + "SnsTopicName": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

This field is no longer in use. Use SnsTopicARN.

" + } + }, + "SnsTopicARN": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send\n notifications when log files are delivered. The following is the format of a topic\n ARN.

\n

\n arn:aws:sns:us-east-2:123456789012:MyTopic\n

" + } + }, + "IncludeGlobalServiceEvents": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the trail is publishing events from global services such as IAM to the log files.

" + } + }, + "IsMultiRegionTrail": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the trail exists in one Region or in all Regions.

" + } + }, + "TrailARN": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the ARN of the trail that was updated. The following is the format of a trail\n ARN.

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

" + } + }, + "LogFileValidationEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether log file integrity validation is enabled.

" + } + }, + "CloudWatchLogsLogGroupArn": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail\n logs are delivered.

" + } + }, + "CloudWatchLogsRoleArn": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's\n log group.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#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\n following format.

\n

\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n

" + } + }, + "IsOrganizationTrail": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the trail is an organization trail.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Returns the objects or data listed below if successful. Otherwise, returns an\n error.

", + "smithy.api#output": {} + } } - }, - "traits": { - "smithy.api#documentation": "

Returns the objects or data listed below if successful. Otherwise, returns an\n error.

", - "smithy.api#output": {} - } } - } } diff --git a/codegen/sdk-codegen/aws-models/codeguru-security.json b/codegen/sdk-codegen/aws-models/codeguru-security.json new file mode 100644 index 000000000000..d9a0416ab6aa --- /dev/null +++ b/codegen/sdk-codegen/aws-models/codeguru-security.json @@ -0,0 +1,3017 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.codegurusecurity#AccessDeniedException": { + "type": "structure", + "members": { + "errorCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The identifier for the error.

", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Description of the error.

", + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The identifier for the resource you don't have access to.

" + } + }, + "resourceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The type of resource you don't have access to.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

You do not have sufficient access to perform this action.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.codegurusecurity#AccountFindingsMetric": { + "type": "structure", + "members": { + "date": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date from which the finding metrics were retrieved.

" + } + }, + "newFindings": { + "target": "com.amazonaws.codegurusecurity#FindingMetricsValuePerSeverity", + "traits": { + "smithy.api#documentation": "

The number of new findings of each severity in account on the specified date.

" + } + }, + "closedFindings": { + "target": "com.amazonaws.codegurusecurity#FindingMetricsValuePerSeverity", + "traits": { + "smithy.api#documentation": "

The number of closed findings of each severity in an account on the specified date.

" + } + }, + "openFindings": { + "target": "com.amazonaws.codegurusecurity#FindingMetricsValuePerSeverity", + "traits": { + "smithy.api#documentation": "

The number of open findings of each severity in an account as of the specified date.

" + } + }, + "meanTimeToClose": { + "target": "com.amazonaws.codegurusecurity#FindingMetricsValuePerSeverity", + "traits": { + "smithy.api#documentation": "

The average time it takes to close findings of each severity in days.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary of findings metrics in an account.

" + } + }, + "com.amazonaws.codegurusecurity#AnalysisType": { + "type": "enum", + "members": { + "SECURITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Security" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "All" + } + } + } + }, + "com.amazonaws.codegurusecurity#AwsCodeGuruSecurity": { + "type": "service", + "version": "2018-05-10", + "operations": [ + { + "target": "com.amazonaws.codegurusecurity#BatchGetFindings" + }, + { + "target": "com.amazonaws.codegurusecurity#CreateScan" + }, + { + "target": "com.amazonaws.codegurusecurity#CreateUploadUrl" + }, + { + "target": "com.amazonaws.codegurusecurity#GetAccountConfiguration" + }, + { + "target": "com.amazonaws.codegurusecurity#GetFindings" + }, + { + "target": "com.amazonaws.codegurusecurity#GetMetricsSummary" + }, + { + "target": "com.amazonaws.codegurusecurity#GetScan" + }, + { + "target": "com.amazonaws.codegurusecurity#ListFindingsMetrics" + }, + { + "target": "com.amazonaws.codegurusecurity#ListScans" + }, + { + "target": "com.amazonaws.codegurusecurity#ListTagsForResource" + }, + { + "target": "com.amazonaws.codegurusecurity#TagResource" + }, + { + "target": "com.amazonaws.codegurusecurity#UntagResource" + }, + { + "target": "com.amazonaws.codegurusecurity#UpdateAccountConfiguration" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "CodeGuru Security", + "arnNamespace": "codeguru-security", + "cloudTrailEventSource": "codeguru-security.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "codeguru-security" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "Authorization", + "Content-Type", + "Credentials", + "X-Amz-Date", + "X-Api-Key", + "X-Amz-Security-Token", + "x-amz-content-sha256", + "X-Amz-User-Agent" + ], + "additionalExposedHeaders": [ + "x-amzn-errortype", + "x-amzn-requestid", + "x-amzn-errormessage", + "x-amzn-trace-id", + "x-amz-apigw-id", + "date" + ], + "origin": "*" + }, + "smithy.api#documentation": "

This section provides documentation for the Amazon CodeGuru Security API operations.\n CodeGuru Security is a service that uses program analysis and machine learning to detect\n security policy violations and vulnerabilities, and recommends ways to address these security\n risks.

\n

By proactively detecting and providing recommendations for addressing security risks,\n CodeGuru Security improves the overall security of your application code. For more information\n about CodeGuru Security, see the \n Amazon CodeGuru Security User Guide.

", + "smithy.api#title": "Amazon CodeGuru Security", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://codeguru-security-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://codeguru-security-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://codeguru-security.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://codeguru-security.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://codeguru-security-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codeguru-security-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://codeguru-security.us-gov-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codeguru-security.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://codeguru-security-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codeguru-security-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://codeguru-security.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codeguru-security.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codeguru-security-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codeguru-security.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://codeguru-security-fips.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codeguru-security-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://codeguru-security.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codeguru-security.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codeguru-security-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codeguru-security.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.codegurusecurity#BatchGetFindings": { + "type": "operation", + "input": { + "target": "com.amazonaws.codegurusecurity#BatchGetFindingsRequest" + }, + "output": { + "target": "com.amazonaws.codegurusecurity#BatchGetFindingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.codegurusecurity#AccessDeniedException" + }, + { + "target": "com.amazonaws.codegurusecurity#InternalServerException" + }, + { + "target": "com.amazonaws.codegurusecurity#ThrottlingException" + }, + { + "target": "com.amazonaws.codegurusecurity#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of all requested findings.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/batchGetFindings" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.codegurusecurity#BatchGetFindingsError": { + "type": "structure", + "members": { + "scanName": { + "target": "com.amazonaws.codegurusecurity#ScanName", + "traits": { + "smithy.api#documentation": "

The name of the scan that generated the finding.

", + "smithy.api#required": {} + } + }, + "findingId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The finding ID of the finding that was not fetched.

", + "smithy.api#required": {} + } + }, + "errorCode": { + "target": "com.amazonaws.codegurusecurity#ErrorCode", + "traits": { + "smithy.api#documentation": "

A code associated with the type of error.

", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Describes the error.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the error that caused a finding to fail to be retrieved.

" + } + }, + "com.amazonaws.codegurusecurity#BatchGetFindingsErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.codegurusecurity#BatchGetFindingsError" + } + }, + "com.amazonaws.codegurusecurity#BatchGetFindingsRequest": { + "type": "structure", + "members": { + "findingIdentifiers": { + "target": "com.amazonaws.codegurusecurity#FindingIdentifiers", + "traits": { + "smithy.api#documentation": "

A list of finding identifiers. Each identifier consists of a scanName and a\n findingId. You retrieve the findingId when you call\n GetFindings.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codegurusecurity#BatchGetFindingsResponse": { + "type": "structure", + "members": { + "findings": { + "target": "com.amazonaws.codegurusecurity#Findings", + "traits": { + "smithy.api#documentation": "

A list of all requested findings.

", + "smithy.api#required": {} + } + }, + "failedFindings": { + "target": "com.amazonaws.codegurusecurity#BatchGetFindingsErrors", + "traits": { + "smithy.api#documentation": "

A list of errors for individual findings which were not fetched. Each\n BatchGetFindingsError contains the scanName, findingId,\n errorCode and error message.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codegurusecurity#CategoriesWithMostFindings": { + "type": "list", + "member": { + "target": "com.amazonaws.codegurusecurity#CategoryWithFindingNum" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.codegurusecurity#CategoryWithFindingNum": { + "type": "structure", + "members": { + "categoryName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the finding category. A finding category is determined by the detector that\n detected the finding.

" + } + }, + "findingNumber": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of open findings in the category.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a finding category with open findings.

" + } + }, + "com.amazonaws.codegurusecurity#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.codegurusecurity#CodeLine": { + "type": "structure", + "members": { + "number": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The code line number.

" + } + }, + "content": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The code that contains a vulnerability.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The line of code where a finding was detected.

" + } + }, + "com.amazonaws.codegurusecurity#CodeSnippet": { + "type": "list", + "member": { + "target": "com.amazonaws.codegurusecurity#CodeLine" + } + }, + "com.amazonaws.codegurusecurity#ConflictException": { + "type": "structure", + "members": { + "errorCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The identifier for the error.

", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Description of the error.

", + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The identifier for the service resource associated with the request.

", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The type of resource associated with the request.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#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.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.codegurusecurity#CreateScan": { + "type": "operation", + "input": { + "target": "com.amazonaws.codegurusecurity#CreateScanRequest" + }, + "output": { + "target": "com.amazonaws.codegurusecurity#CreateScanResponse" + }, + "errors": [ + { + "target": "com.amazonaws.codegurusecurity#AccessDeniedException" + }, + { + "target": "com.amazonaws.codegurusecurity#ConflictException" + }, + { + "target": "com.amazonaws.codegurusecurity#InternalServerException" + }, + { + "target": "com.amazonaws.codegurusecurity#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.codegurusecurity#ThrottlingException" + }, + { + "target": "com.amazonaws.codegurusecurity#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Use to create a scan using code uploaded to an S3 bucket.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/scans" + } + } + }, + "com.amazonaws.codegurusecurity#CreateScanRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.codegurusecurity#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token for the request. Amazon CodeGuru Security uses this value to prevent\n the accidental creation of duplicate scans if there are failures and retries.

", + "smithy.api#idempotencyToken": {} + } + }, + "resourceId": { + "target": "com.amazonaws.codegurusecurity#ResourceId", + "traits": { + "smithy.api#documentation": "

The identifier for an input resource used to create a scan.

", + "smithy.api#required": {} + } + }, + "scanName": { + "target": "com.amazonaws.codegurusecurity#ScanName", + "traits": { + "smithy.api#documentation": "

The unique name that CodeGuru Security uses to track revisions across multiple\n scans of the same resource. Only allowed for a STANDARD scan type. If not\n specified, it will be auto generated.

", + "smithy.api#required": {} + } + }, + "scanType": { + "target": "com.amazonaws.codegurusecurity#ScanType", + "traits": { + "smithy.api#documentation": "

The type of scan, either Standard or Express. Defaults to\n Standard type if missing.

\n

\n Express scans run on limited resources and use a limited set of detectors to\n analyze your code in near-real time. Standard scans have standard resource limits\n and use the full set of detectors to analyze your code.

" + } + }, + "analysisType": { + "target": "com.amazonaws.codegurusecurity#AnalysisType", + "traits": { + "smithy.api#documentation": "

The type of analysis you want CodeGuru Security to perform in the scan, either\n Security or All. The Secuirty type only generates\n findings related to security. The All type generates both security findings and\n quality findings. Defaults to Security type if missing.

" + } + }, + "tags": { + "target": "com.amazonaws.codegurusecurity#TagMap", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs used to tag a scan. A tag is a custom attribute\n label with two parts:

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codegurusecurity#CreateScanResponse": { + "type": "structure", + "members": { + "scanName": { + "target": "com.amazonaws.codegurusecurity#ScanName", + "traits": { + "smithy.api#documentation": "

The name of the scan.

", + "smithy.api#required": {} + } + }, + "runId": { + "target": "com.amazonaws.codegurusecurity#Uuid", + "traits": { + "smithy.api#documentation": "

UUID that identifies the individual scan run.

", + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.codegurusecurity#ResourceId", + "traits": { + "smithy.api#documentation": "

The identifier for the resource object that contains resources that were scanned.

", + "smithy.api#required": {} + } + }, + "scanState": { + "target": "com.amazonaws.codegurusecurity#ScanState", + "traits": { + "smithy.api#documentation": "

The current state of the scan. Returns either InProgress,\n Successful, or Failed.

", + "smithy.api#required": {} + } + }, + "scanNameArn": { + "target": "com.amazonaws.codegurusecurity#ScanNameArn", + "traits": { + "smithy.api#documentation": "

The ARN for the scan name.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codegurusecurity#CreateUploadUrl": { + "type": "operation", + "input": { + "target": "com.amazonaws.codegurusecurity#CreateUploadUrlRequest" + }, + "output": { + "target": "com.amazonaws.codegurusecurity#CreateUploadUrlResponse" + }, + "errors": [ + { + "target": "com.amazonaws.codegurusecurity#AccessDeniedException" + }, + { + "target": "com.amazonaws.codegurusecurity#InternalServerException" + }, + { + "target": "com.amazonaws.codegurusecurity#ThrottlingException" + }, + { + "target": "com.amazonaws.codegurusecurity#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Generates a pre-signed URL and request headers used to upload a code resource.

\n

You can upload your code resource to the URL and add the request headers using any HTTP\n client.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/uploadUrl" + } + } + }, + "com.amazonaws.codegurusecurity#CreateUploadUrlRequest": { + "type": "structure", + "members": { + "scanName": { + "target": "com.amazonaws.codegurusecurity#ScanName", + "traits": { + "smithy.api#documentation": "

The name of the scan that will use the uploaded resource. CodeGuru Security uses the\n unique scan name to track revisions across multiple scans of the same resource. Use this \n scanName when you call CreateScan on the code resource you upload to this URL.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codegurusecurity#CreateUploadUrlResponse": { + "type": "structure", + "members": { + "s3Url": { + "target": "com.amazonaws.codegurusecurity#S3Url", + "traits": { + "smithy.api#documentation": "

A pre-signed S3 URL. You can upload the code file you want to scan and add the required\n requestHeaders using any HTTP client.

", + "smithy.api#required": {} + } + }, + "requestHeaders": { + "target": "com.amazonaws.codegurusecurity#RequestHeaderMap", + "traits": { + "smithy.api#documentation": "

A set of key-value pairs that contain the required headers when uploading your\n resource.

", + "smithy.api#required": {} + } + }, + "codeArtifactId": { + "target": "com.amazonaws.codegurusecurity#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier for the uploaded code resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codegurusecurity#DetectorTags": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.codegurusecurity#EncryptionConfig": { + "type": "structure", + "members": { + "kmsKeyArn": { + "target": "com.amazonaws.codegurusecurity#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The KMS key ARN to use for encryption. This must be provided as a header when uploading\n your code resource.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about account-level configuration.

" + } + }, + "com.amazonaws.codegurusecurity#ErrorCode": { + "type": "enum", + "members": { + "DUPLICATE_IDENTIFIER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DUPLICATE_IDENTIFIER" + } + }, + "ITEM_DOES_NOT_EXIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ITEM_DOES_NOT_EXIST" + } + }, + "INTERNAL_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_ERROR" + } + }, + "INVALID_FINDING_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_FINDING_ID" + } + }, + "INVALID_SCAN_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_SCAN_NAME" + } + } + } + }, + "com.amazonaws.codegurusecurity#FilePath": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the file.

" + } + }, + "path": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The path to the resource with the security vulnerability.

" + } + }, + "startLine": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The first line number of the code snippet where the security vulnerability appears in your code.

" + } + }, + "endLine": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The last line number of the code snippet where the security vulnerability appears in your\n code.

" + } + }, + "codeSnippet": { + "target": "com.amazonaws.codegurusecurity#CodeSnippet", + "traits": { + "smithy.api#documentation": "

A list of CodeLine objects that describe where the security vulnerability\n appears in your code.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the location of security vulnerabilities that Amazon CodeGuru Security\n detected in your code.

" + } + }, + "com.amazonaws.codegurusecurity#Finding": { + "type": "structure", + "members": { + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the finding was created.

" + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A description of the finding.

" + } + }, + "generatorId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The identifier for the component that generated a finding such as AWSCodeGuruSecurity or\n AWSInspector.

" + } + }, + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The identifier for a finding.

" + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the finding was last updated. Findings are updated when you remediate them\n or when the finding code location changes.

" + } + }, + "type": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The type of finding.

" + } + }, + "status": { + "target": "com.amazonaws.codegurusecurity#Status", + "traits": { + "smithy.api#documentation": "

The status of the finding. A finding status can be open or closed.

" + } + }, + "resource": { + "target": "com.amazonaws.codegurusecurity#Resource", + "traits": { + "smithy.api#documentation": "

The resource where Amazon CodeGuru Security detected a finding.

" + } + }, + "vulnerability": { + "target": "com.amazonaws.codegurusecurity#Vulnerability", + "traits": { + "smithy.api#documentation": "

An object that describes the detected security vulnerability.

" + } + }, + "severity": { + "target": "com.amazonaws.codegurusecurity#Severity", + "traits": { + "smithy.api#documentation": "

The severity of the finding.

" + } + }, + "remediation": { + "target": "com.amazonaws.codegurusecurity#Remediation", + "traits": { + "smithy.api#documentation": "

An object that contains the details about how to remediate a finding.

" + } + }, + "title": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The title of the finding.

" + } + }, + "detectorTags": { + "target": "com.amazonaws.codegurusecurity#DetectorTags", + "traits": { + "smithy.api#documentation": "

One or more tags or categorizations that are associated with a detector. These tags are\n defined by type, programming language, or other classification such as maintainability or\n consistency.

" + } + }, + "detectorId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The identifier for the detector that detected the finding in your code. A detector is a\n defined rule based on industry standards and AWS best practices.

" + } + }, + "detectorName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the detector that identified the security vulnerability in your code.

" + } + }, + "ruleId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The identifier for the rule that generated the finding.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a finding that was detected in your code.

" + } + }, + "com.amazonaws.codegurusecurity#FindingIdentifier": { + "type": "structure", + "members": { + "scanName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the scan that generated the finding.

", + "smithy.api#required": {} + } + }, + "findingId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The identifier for a finding.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains information about a finding and the scan that generated it.

" + } + }, + "com.amazonaws.codegurusecurity#FindingIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.codegurusecurity#FindingIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.codegurusecurity#FindingMetricsValuePerSeverity": { + "type": "structure", + "members": { + "info": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

The finding is related to quality or readability improvements and not considered\n actionable.

" + } + }, + "low": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

The severity of the finding is low and does require action on its own.

" + } + }, + "medium": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

The severity of the finding is medium and should be addressed as a mid-term priority.

" + } + }, + "high": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

The severity of the finding is high and should be addressed as a near-term priority.

" + } + }, + "critical": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

The severity of the finding is critical and should be addressed immediately.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The severity of the issue in the code that generated a finding.

" + } + }, + "com.amazonaws.codegurusecurity#Findings": { + "type": "list", + "member": { + "target": "com.amazonaws.codegurusecurity#Finding" + } + }, + "com.amazonaws.codegurusecurity#FindingsMetricList": { + "type": "list", + "member": { + "target": "com.amazonaws.codegurusecurity#AccountFindingsMetric" + } + }, + "com.amazonaws.codegurusecurity#GetAccountConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.codegurusecurity#GetAccountConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.codegurusecurity#GetAccountConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.codegurusecurity#AccessDeniedException" + }, + { + "target": "com.amazonaws.codegurusecurity#InternalServerException" + }, + { + "target": "com.amazonaws.codegurusecurity#ThrottlingException" + }, + { + "target": "com.amazonaws.codegurusecurity#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Use to get account level configuration.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/accountConfiguration/get" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.codegurusecurity#GetAccountConfigurationRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codegurusecurity#GetAccountConfigurationResponse": { + "type": "structure", + "members": { + "encryptionConfig": { + "target": "com.amazonaws.codegurusecurity#EncryptionConfig", + "traits": { + "smithy.api#documentation": "

An EncryptionConfig object that contains the KMS key ARN to use for\n encryption. By default, CodeGuru Security uses an AWS-managed key for encryption. To specify\n your own key, call UpdateAccountConfiguration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codegurusecurity#GetFindings": { + "type": "operation", + "input": { + "target": "com.amazonaws.codegurusecurity#GetFindingsRequest" + }, + "output": { + "target": "com.amazonaws.codegurusecurity#GetFindingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.codegurusecurity#AccessDeniedException" + }, + { + "target": "com.amazonaws.codegurusecurity#ConflictException" + }, + { + "target": "com.amazonaws.codegurusecurity#InternalServerException" + }, + { + "target": "com.amazonaws.codegurusecurity#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.codegurusecurity#ThrottlingException" + }, + { + "target": "com.amazonaws.codegurusecurity#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of all findings generated by a particular scan.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/findings/{scanName}" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "findings" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.codegurusecurity#GetFindingsRequest": { + "type": "structure", + "members": { + "scanName": { + "target": "com.amazonaws.codegurusecurity#ScanName", + "traits": { + "smithy.api#documentation": "

The name of the scan you want to retrieve findings from.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.codegurusecurity#NextToken", + "traits": { + "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value of\n this parameter to null for the first request. For subsequent calls, use the nextToken value\n returned from the previous request to continue listing results after the first page.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in the response. Use this parameter when\n paginating results. If additional results exist beyond the number you specify, the nextToken\n element is returned in the response. Use nextToken in a subsequent request to retrieve\n additional results.

", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "status": { + "target": "com.amazonaws.codegurusecurity#Status", + "traits": { + "smithy.api#documentation": "

The status of the findings you want to get. Pass either Open,\n Closed, or All.

", + "smithy.api#httpQuery": "status" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codegurusecurity#GetFindingsResponse": { + "type": "structure", + "members": { + "findings": { + "target": "com.amazonaws.codegurusecurity#Findings", + "traits": { + "smithy.api#documentation": "

A list of findings generated by the specified scan.

" + } + }, + "nextToken": { + "target": "com.amazonaws.codegurusecurity#NextToken", + "traits": { + "smithy.api#documentation": "

A pagination token. You can use this in future calls to GetFindings to continue listing\n results after the current page.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codegurusecurity#GetMetricsSummary": { + "type": "operation", + "input": { + "target": "com.amazonaws.codegurusecurity#GetMetricsSummaryRequest" + }, + "output": { + "target": "com.amazonaws.codegurusecurity#GetMetricsSummaryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.codegurusecurity#AccessDeniedException" + }, + { + "target": "com.amazonaws.codegurusecurity#InternalServerException" + }, + { + "target": "com.amazonaws.codegurusecurity#ThrottlingException" + }, + { + "target": "com.amazonaws.codegurusecurity#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns top level metrics about an account from a specified date, including number of open\n findings, the categories with most findings, the scans with most open findings, and scans with\n most open critical findings.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/metrics/summary" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.codegurusecurity#GetMetricsSummaryRequest": { + "type": "structure", + "members": { + "date": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date you want to retrieve summary metrics from, rounded to the nearest day. The date\n must be within the past two years since metrics data is only stored for two years. If a date\n outside of this range is passed, the response will be empty.

", + "smithy.api#httpQuery": "date", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codegurusecurity#GetMetricsSummaryResponse": { + "type": "structure", + "members": { + "metricsSummary": { + "target": "com.amazonaws.codegurusecurity#MetricsSummary", + "traits": { + "smithy.api#documentation": "

The summary metrics from the specified date.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codegurusecurity#GetScan": { + "type": "operation", + "input": { + "target": "com.amazonaws.codegurusecurity#GetScanRequest" + }, + "output": { + "target": "com.amazonaws.codegurusecurity#GetScanResponse" + }, + "errors": [ + { + "target": "com.amazonaws.codegurusecurity#AccessDeniedException" + }, + { + "target": "com.amazonaws.codegurusecurity#InternalServerException" + }, + { + "target": "com.amazonaws.codegurusecurity#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.codegurusecurity#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns details about a scan, including whether or not a scan has completed.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/scans/{scanName}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.codegurusecurity#GetScanRequest": { + "type": "structure", + "members": { + "scanName": { + "target": "com.amazonaws.codegurusecurity#ScanName", + "traits": { + "smithy.api#documentation": "

The name of the scan you want to view details about.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "runId": { + "target": "com.amazonaws.codegurusecurity#Uuid", + "traits": { + "smithy.api#documentation": "

UUID that identifies the individual scan run you want to view details about. You retrieve\n this when you call the CreateScan operation. Defaults to the latest scan run if missing.

", + "smithy.api#httpQuery": "runId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codegurusecurity#GetScanResponse": { + "type": "structure", + "members": { + "scanName": { + "target": "com.amazonaws.codegurusecurity#ScanName", + "traits": { + "smithy.api#documentation": "

The name of the scan.

", + "smithy.api#required": {} + } + }, + "runId": { + "target": "com.amazonaws.codegurusecurity#Uuid", + "traits": { + "smithy.api#documentation": "

UUID that identifies the individual scan run.

", + "smithy.api#required": {} + } + }, + "scanState": { + "target": "com.amazonaws.codegurusecurity#ScanState", + "traits": { + "smithy.api#documentation": "

The current state of the scan. Pass either InProgress,\n Successful, or Failed.

", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the scan was created.

", + "smithy.api#required": {} + } + }, + "analysisType": { + "target": "com.amazonaws.codegurusecurity#AnalysisType", + "traits": { + "smithy.api#documentation": "

The type of analysis CodeGuru Security performed in the scan, either\n Security or All. The Security type only generates\n findings related to security. The All type generates both security findings and\n quality findings.

", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the scan was last updated. Only available for STANDARD scan types.

" + } + }, + "numberOfRevisions": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The number of times a scan has been re-run on a revised resource.

" + } + }, + "scanNameArn": { + "target": "com.amazonaws.codegurusecurity#ScanNameArn", + "traits": { + "smithy.api#documentation": "

The ARN for the scan name.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codegurusecurity#HeaderKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.codegurusecurity#HeaderValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.codegurusecurity#InternalServerException": { + "type": "structure", + "members": { + "error": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The internal error encountered by the server.

" + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Description of the error.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The server encountered an internal error and is unable to complete the request.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.codegurusecurity#KmsKeyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws:kms:[\\S]+:[\\d]{12}:key\\/(([a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})|(mrk-[0-9a-zA-Z]{32}))$" + } + }, + "com.amazonaws.codegurusecurity#ListFindingsMetrics": { + "type": "operation", + "input": { + "target": "com.amazonaws.codegurusecurity#ListFindingsMetricsRequest" + }, + "output": { + "target": "com.amazonaws.codegurusecurity#ListFindingsMetricsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.codegurusecurity#AccessDeniedException" + }, + { + "target": "com.amazonaws.codegurusecurity#InternalServerException" + }, + { + "target": "com.amazonaws.codegurusecurity#ThrottlingException" + }, + { + "target": "com.amazonaws.codegurusecurity#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns metrics about all findings in an account within a specified time range.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/metrics/findings" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "findingsMetrics" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.codegurusecurity#ListFindingsMetricsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.codegurusecurity#NextToken", + "traits": { + "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the\n value of this parameter to null for the first request. For subsequent calls, use the nextToken\n value returned from the previous request to continue listing results after the first\n page.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in the response. Use this parameter when\n paginating results. If additional results exist beyond the number you specify, the nextToken\n element is returned in the response. Use nextToken in a subsequent request to retrieve\n additional results.

", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "startDate": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The start date of the interval which you want to retrieve metrics from.

", + "smithy.api#httpQuery": "startDate", + "smithy.api#required": {} + } + }, + "endDate": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The end date of the interval which you want to retrieve metrics from.

", + "smithy.api#httpQuery": "endDate", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codegurusecurity#ListFindingsMetricsResponse": { + "type": "structure", + "members": { + "findingsMetrics": { + "target": "com.amazonaws.codegurusecurity#FindingsMetricList", + "traits": { + "smithy.api#documentation": "

A list of AccountFindingsMetric objects retrieved from the specified time interval.

" + } + }, + "nextToken": { + "target": "com.amazonaws.codegurusecurity#NextToken", + "traits": { + "smithy.api#documentation": "

A pagination token. You can use this in future calls to ListFindingMetrics to continue\n listing results after the current page.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codegurusecurity#ListScans": { + "type": "operation", + "input": { + "target": "com.amazonaws.codegurusecurity#ListScansRequest" + }, + "output": { + "target": "com.amazonaws.codegurusecurity#ListScansResponse" + }, + "errors": [ + { + "target": "com.amazonaws.codegurusecurity#AccessDeniedException" + }, + { + "target": "com.amazonaws.codegurusecurity#InternalServerException" + }, + { + "target": "com.amazonaws.codegurusecurity#ThrottlingException" + }, + { + "target": "com.amazonaws.codegurusecurity#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of all the scans in an account.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/scans" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "summaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.codegurusecurity#ListScansRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.codegurusecurity#NextToken", + "traits": { + "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value of\n this parameter to null for the first request. For subsequent calls, use the nextToken value\n returned from the previous request to continue listing results after the first page.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in the response. Use this parameter when\n paginating results. If additional results exist beyond the number you specify, the nextToken\n element is returned in the response. Use nextToken in a subsequent request to retrieve\n additional results.

", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codegurusecurity#ListScansResponse": { + "type": "structure", + "members": { + "summaries": { + "target": "com.amazonaws.codegurusecurity#ScanSummaries", + "traits": { + "smithy.api#documentation": "

A list of ScanSummary objects with information about all scans in an account.

" + } + }, + "nextToken": { + "target": "com.amazonaws.codegurusecurity#NextToken", + "traits": { + "smithy.api#documentation": "

A pagination token. You can use this in future calls to ListScans to continue listing\n results after the current page.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codegurusecurity#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.codegurusecurity#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.codegurusecurity#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.codegurusecurity#AccessDeniedException" + }, + { + "target": "com.amazonaws.codegurusecurity#ConflictException" + }, + { + "target": "com.amazonaws.codegurusecurity#InternalServerException" + }, + { + "target": "com.amazonaws.codegurusecurity#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.codegurusecurity#ThrottlingException" + }, + { + "target": "com.amazonaws.codegurusecurity#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of all tags associated with a scan.

", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{resourceArn}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.codegurusecurity#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.codegurusecurity#ScanNameArn", + "traits": { + "smithy.api#documentation": "

The ARN of the ScanName object. You can retrieve this ARN by calling\n ListScans or GetScan.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codegurusecurity#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.codegurusecurity#TagMap", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs used to tag an existing scan. A tag is a custom attribute\n label with two parts:

\n " + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codegurusecurity#MetricsSummary": { + "type": "structure", + "members": { + "date": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date from which the metrics summary information was retrieved.

" + } + }, + "openFindings": { + "target": "com.amazonaws.codegurusecurity#FindingMetricsValuePerSeverity", + "traits": { + "smithy.api#documentation": "

The number of open findings of each severity in an account.

" + } + }, + "categoriesWithMostFindings": { + "target": "com.amazonaws.codegurusecurity#CategoriesWithMostFindings", + "traits": { + "smithy.api#documentation": "

A list of CategoryWithFindingNum objects for the top 5 finding categories\n with the most open findings in an account.

" + } + }, + "scansWithMostOpenFindings": { + "target": "com.amazonaws.codegurusecurity#ScansWithMostOpenFindings", + "traits": { + "smithy.api#documentation": "

A list of ScanNameWithFindingNum objects for the top 3 scans with the most\n number of open critical findings in an account.

" + } + }, + "scansWithMostOpenCriticalFindings": { + "target": "com.amazonaws.codegurusecurity#ScansWithMostOpenCriticalFindings", + "traits": { + "smithy.api#documentation": "

A list of ScanNameWithFindingNum objects for the top 3 scans with the most\n number of open findings in an account.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about summary metrics in an account.

" + } + }, + "com.amazonaws.codegurusecurity#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.codegurusecurity#Recommendation": { + "type": "structure", + "members": { + "text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The recommended course of action to remediate the finding.

" + } + }, + "url": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The URL address to the recommendation for remediating the finding.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the recommended course of action to remediate a finding.

" + } + }, + "com.amazonaws.codegurusecurity#ReferenceUrls": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.codegurusecurity#RelatedVulnerabilities": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.codegurusecurity#Remediation": { + "type": "structure", + "members": { + "recommendation": { + "target": "com.amazonaws.codegurusecurity#Recommendation", + "traits": { + "smithy.api#documentation": "

An object that contains information about the recommended course of action to remediate a finding.

" + } + }, + "suggestedFixes": { + "target": "com.amazonaws.codegurusecurity#SuggestedFixes", + "traits": { + "smithy.api#documentation": "

A list of SuggestedFix objects. Each object contains information about a suggested code\n fix to remediate the finding.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about how to remediate a finding.

" + } + }, + "com.amazonaws.codegurusecurity#RequestHeaderMap": { + "type": "map", + "key": { + "target": "com.amazonaws.codegurusecurity#HeaderKey" + }, + "value": { + "target": "com.amazonaws.codegurusecurity#HeaderValue" + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.codegurusecurity#Resource": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The identifier for the resource.

" + } + }, + "subResourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The identifier for a section of the resource, such as an AWS Lambda layer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a resource, such as an Amazon S3 bucket or AWS Lambda function, that\n contains a finding.

" + } + }, + "com.amazonaws.codegurusecurity#ResourceId": { + "type": "union", + "members": { + "codeArtifactId": { + "target": "com.amazonaws.codegurusecurity#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier for the code file uploaded to the resource where a finding was detected.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The identifier for a resource object that contains resources where a finding was detected.

" + } + }, + "com.amazonaws.codegurusecurity#ResourceNotFoundException": { + "type": "structure", + "members": { + "errorCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The identifier for the error.

", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Description of the error.

", + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The identifier for the resource that was not found.

", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The type of resource that was not found.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The resource specified in the request was not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.codegurusecurity#S3Url": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.codegurusecurity#ScanName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 140 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-_$:.]*$" + } + }, + "com.amazonaws.codegurusecurity#ScanNameArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + }, + "smithy.api#pattern": "^arn:aws:codeguru-security:[\\S]+:[\\d]{12}:scans\\/[a-zA-Z0-9-_$:.]*$" + } + }, + "com.amazonaws.codegurusecurity#ScanNameWithFindingNum": { + "type": "structure", + "members": { + "scanName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the scan.

" + } + }, + "findingNumber": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of open findings generated by a scan.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a scan with open findings.

" + } + }, + "com.amazonaws.codegurusecurity#ScanState": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "SUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Successful" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } + } + }, + "com.amazonaws.codegurusecurity#ScanSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.codegurusecurity#ScanSummary" + } + }, + "com.amazonaws.codegurusecurity#ScanSummary": { + "type": "structure", + "members": { + "scanState": { + "target": "com.amazonaws.codegurusecurity#ScanState", + "traits": { + "smithy.api#documentation": "

The state of the scan. A scan can be In Progress, \n Complete, or Failed.

", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the scan was created.

", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the scan was last updated. A scan is updated when it is re-run.

" + } + }, + "scanName": { + "target": "com.amazonaws.codegurusecurity#ScanName", + "traits": { + "smithy.api#documentation": "

The name of the scan.

", + "smithy.api#required": {} + } + }, + "runId": { + "target": "com.amazonaws.codegurusecurity#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier for the scan run.

", + "smithy.api#required": {} + } + }, + "scanNameArn": { + "target": "com.amazonaws.codegurusecurity#ScanNameArn", + "traits": { + "smithy.api#documentation": "

The ARN for the scan name.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a scan.

" + } + }, + "com.amazonaws.codegurusecurity#ScanType": { + "type": "enum", + "members": { + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Standard" + } + }, + "EXPRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Express" + } + } + } + }, + "com.amazonaws.codegurusecurity#ScansWithMostOpenCriticalFindings": { + "type": "list", + "member": { + "target": "com.amazonaws.codegurusecurity#ScanNameWithFindingNum" + }, + "traits": { + "smithy.api#length": { + "max": 3 + } + } + }, + "com.amazonaws.codegurusecurity#ScansWithMostOpenFindings": { + "type": "list", + "member": { + "target": "com.amazonaws.codegurusecurity#ScanNameWithFindingNum" + }, + "traits": { + "smithy.api#length": { + "max": 3 + } + } + }, + "com.amazonaws.codegurusecurity#Severity": { + "type": "enum", + "members": { + "CRITICAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Critical" + } + }, + "HIGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "High" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Medium" + } + }, + "LOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Low" + } + }, + "INFO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Info" + } + } + } + }, + "com.amazonaws.codegurusecurity#Status": { + "type": "enum", + "members": { + "CLOSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Closed" + } + }, + "OPEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Open" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "All" + } + } + } + }, + "com.amazonaws.codegurusecurity#SuggestedFix": { + "type": "structure", + "members": { + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A description of the suggested code fix and why it is being suggested.

" + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The suggested code to add to your file.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the suggested code fix to remediate a finding.

" + } + }, + "com.amazonaws.codegurusecurity#SuggestedFixes": { + "type": "list", + "member": { + "target": "com.amazonaws.codegurusecurity#SuggestedFix" + } + }, + "com.amazonaws.codegurusecurity#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.codegurusecurity#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.codegurusecurity#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.codegurusecurity#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.codegurusecurity#TagKey" + }, + "value": { + "target": "com.amazonaws.codegurusecurity#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.codegurusecurity#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.codegurusecurity#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.codegurusecurity#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.codegurusecurity#AccessDeniedException" + }, + { + "target": "com.amazonaws.codegurusecurity#ConflictException" + }, + { + "target": "com.amazonaws.codegurusecurity#InternalServerException" + }, + { + "target": "com.amazonaws.codegurusecurity#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.codegurusecurity#ThrottlingException" + }, + { + "target": "com.amazonaws.codegurusecurity#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Use to add one or more tags to an existing scan.

", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{resourceArn}", + "code": 204 + } + } + }, + "com.amazonaws.codegurusecurity#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.codegurusecurity#ScanNameArn", + "traits": { + "smithy.api#documentation": "

The ARN of the ScanName object. You can retrieve this ARN by calling\n ListScans or GetScan.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.codegurusecurity#TagMap", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs used to tag an existing scan. A tag is a custom attribute\n label with two parts:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codegurusecurity#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codegurusecurity#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.codegurusecurity#ThrottlingException": { + "type": "structure", + "members": { + "errorCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The identifier for the error.

", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Description of the error.

", + "smithy.api#required": {} + } + }, + "serviceCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The identifier for the originating service.

" + } + }, + "quotaCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The identifier for the originating quota.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The request was denied due to request throttling.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": { + "throttling": true + } + } + }, + "com.amazonaws.codegurusecurity#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.codegurusecurity#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.codegurusecurity#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.codegurusecurity#AccessDeniedException" + }, + { + "target": "com.amazonaws.codegurusecurity#ConflictException" + }, + { + "target": "com.amazonaws.codegurusecurity#InternalServerException" + }, + { + "target": "com.amazonaws.codegurusecurity#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.codegurusecurity#ThrottlingException" + }, + { + "target": "com.amazonaws.codegurusecurity#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Use to remove one or more tags from an existing scan.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{resourceArn}", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.codegurusecurity#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.codegurusecurity#ScanNameArn", + "traits": { + "smithy.api#documentation": "

The ARN of the ScanName object. You can retrieve this ARN by calling\n ListScans or GetScan.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.codegurusecurity#TagKeyList", + "traits": { + "smithy.api#documentation": "

A list of keys for each tag you want to remove from a scan.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codegurusecurity#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codegurusecurity#UpdateAccountConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.codegurusecurity#UpdateAccountConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.codegurusecurity#UpdateAccountConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.codegurusecurity#AccessDeniedException" + }, + { + "target": "com.amazonaws.codegurusecurity#InternalServerException" + }, + { + "target": "com.amazonaws.codegurusecurity#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.codegurusecurity#ThrottlingException" + }, + { + "target": "com.amazonaws.codegurusecurity#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Use to update account-level configuration with an encryption key.

", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/updateAccountConfiguration" + } + } + }, + "com.amazonaws.codegurusecurity#UpdateAccountConfigurationRequest": { + "type": "structure", + "members": { + "encryptionConfig": { + "target": "com.amazonaws.codegurusecurity#EncryptionConfig", + "traits": { + "smithy.api#documentation": "

The KMS key ARN you want to use for encryption. Defaults to service-side encryption if missing.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codegurusecurity#UpdateAccountConfigurationResponse": { + "type": "structure", + "members": { + "encryptionConfig": { + "target": "com.amazonaws.codegurusecurity#EncryptionConfig", + "traits": { + "smithy.api#documentation": "

An EncryptionConfig object that contains the KMS key ARN to use for\n encryption.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codegurusecurity#Uuid": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + } + }, + "com.amazonaws.codegurusecurity#ValidationException": { + "type": "structure", + "members": { + "errorCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The identifier for the error.

", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Description of the error.

", + "smithy.api#required": {} + } + }, + "reason": { + "target": "com.amazonaws.codegurusecurity#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "

The reason the request failed validation.

", + "smithy.api#required": {} + } + }, + "fieldList": { + "target": "com.amazonaws.codegurusecurity#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "

The field that caused the error, if applicable.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The input fails to satisfy the specified constraints.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.codegurusecurity#ValidationExceptionField": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the exception.

", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Describes the exception.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a validation exception.

" + } + }, + "com.amazonaws.codegurusecurity#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.codegurusecurity#ValidationExceptionField" + } + }, + "com.amazonaws.codegurusecurity#ValidationExceptionReason": { + "type": "enum", + "members": { + "UNKNOWN_OPERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unknownOperation" + } + }, + "CANNOT_PARSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cannotParse" + } + }, + "FIELD_VALIDATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fieldValidationFailed" + } + }, + "OTHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "other" + } + }, + "LAMBDA_CODE_SHA_MISMATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lambdaCodeShaMisMatch" + } + } + } + }, + "com.amazonaws.codegurusecurity#Vulnerability": { + "type": "structure", + "members": { + "referenceUrls": { + "target": "com.amazonaws.codegurusecurity#ReferenceUrls", + "traits": { + "smithy.api#documentation": "

One or more URL addresses that contain details about a vulnerability.

" + } + }, + "relatedVulnerabilities": { + "target": "com.amazonaws.codegurusecurity#RelatedVulnerabilities", + "traits": { + "smithy.api#documentation": "

One or more vulnerabilities that are related to the vulnerability being described.

" + } + }, + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The identifier for the vulnerability.

" + } + }, + "filePath": { + "target": "com.amazonaws.codegurusecurity#FilePath", + "traits": { + "smithy.api#documentation": "

An object that describes the location of the detected security vulnerability in your\n code.

" + } + }, + "itemCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of times the vulnerability appears in your code.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a security vulnerability that Amazon CodeGuru Security detected.

" + } + } + } +} \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/drs.json b/codegen/sdk-codegen/aws-models/drs.json index 91f6dca1f16c..bab16cabee29 100644 --- a/codegen/sdk-codegen/aws-models/drs.json +++ b/codegen/sdk-codegen/aws-models/drs.json @@ -1,7611 +1,8763 @@ { - "smithy": "2.0", - "shapes": { - "com.amazonaws.drs#ARN": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:.{16,2044}$" - } - }, - "com.amazonaws.drs#AccessDeniedException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.drs#LargeBoundedString" - }, - "code": { - "target": "com.amazonaws.drs#LargeBoundedString" - } - }, - "traits": { - "smithy.api#documentation": "

You do not have sufficient access to perform this action.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.drs#Account": { - "type": "structure", - "members": { - "accountID": { - "target": "com.amazonaws.drs#AccountID", - "traits": { - "smithy.api#documentation": "

Account ID of AWS account.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

AWS account.

" - } - }, - "com.amazonaws.drs#AccountID": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 12, - "max": 12 - }, - "smithy.api#pattern": "[0-9]{12,}" - } - }, - "com.amazonaws.drs#AccountIDs": { - "type": "list", - "member": { - "target": "com.amazonaws.drs#AccountID" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.drs#AccountResource": { - "type": "resource", - "identifiers": { - "accountID": { - "target": "com.amazonaws.drs#AccountID" - } - }, - "traits": { - "aws.iam#disableConditionKeyInference": {} - } - }, - "com.amazonaws.drs#Accounts": { - "type": "list", - "member": { - "target": "com.amazonaws.drs#Account" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.drs#AwsAvailabilityZone": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - }, - "smithy.api#pattern": "^(us(-gov)?|ap|ca|cn|eu|sa|af|me)-(central|north|(north(?:east|west))|south|south(?:east|west)|east|west)-[0-9][a-z]$" - } - }, - "com.amazonaws.drs#AwsRegion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - }, - "smithy.api#pattern": "^(us(-gov)?|ap|ca|cn|eu|sa|af|me)-(central|north|(north(?:east|west))|south|south(?:east|west)|east|west)-[0-9]$" - } - }, - "com.amazonaws.drs#BoundedString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.drs#CPU": { - "type": "structure", - "members": { - "cores": { - "target": "com.amazonaws.drs#PositiveInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of CPU cores.

" - } - }, - "modelName": { - "target": "com.amazonaws.drs#BoundedString", - "traits": { - "smithy.api#documentation": "

The model name of the CPU.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a server's CPU.

" - } - }, - "com.amazonaws.drs#ConflictException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.drs#LargeBoundedString" - }, - "code": { - "target": "com.amazonaws.drs#LargeBoundedString" - }, - "resourceId": { - "target": "com.amazonaws.drs#LargeBoundedString", - "traits": { - "smithy.api#documentation": "

The ID of the resource.

" - } - }, - "resourceType": { - "target": "com.amazonaws.drs#LargeBoundedString", - "traits": { - "smithy.api#documentation": "

The type of the resource.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The request could not be completed due to a conflict with the current state of the target resource.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.drs#ConversionMap": { - "type": "map", - "key": { - "target": "com.amazonaws.drs#EbsSnapshot" - }, - "value": { - "target": "com.amazonaws.drs#EbsSnapshot" - } - }, - "com.amazonaws.drs#ConversionProperties": { - "type": "structure", - "members": { - "volumeToConversionMap": { - "target": "com.amazonaws.drs#VolumeToConversionMap", - "traits": { - "smithy.api#documentation": "

A mapping between the volumes being converted and the converted snapshot ids

" - } - }, - "rootVolumeName": { - "target": "com.amazonaws.drs#LargeBoundedString", - "traits": { - "smithy.api#documentation": "

The root volume name of a conversion job

" - } - }, - "forceUefi": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Whether the volume being converted uses UEFI or not

" - } - }, - "dataTimestamp": { - "target": "com.amazonaws.drs#LargeBoundedString", - "traits": { - "smithy.api#documentation": "

The timestamp of when the snapshot being converted was taken

" - } - }, - "volumeToVolumeSize": { - "target": "com.amazonaws.drs#VolumeToSizeMap", - "traits": { - "smithy.api#documentation": "

A mapping between the volumes and their sizes

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Properties of a conversion job

" - } - }, - "com.amazonaws.drs#Cpus": { - "type": "list", - "member": { - "target": "com.amazonaws.drs#CPU" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.drs#CreateExtendedSourceServer": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#CreateExtendedSourceServerRequest" - }, - "output": { - "target": "com.amazonaws.drs#CreateExtendedSourceServerResponse" - }, - "errors": [ - { - "target": "com.amazonaws.drs#AccessDeniedException" - }, - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.drs#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#UninitializedAccountException" - }, - { - "target": "com.amazonaws.drs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Create an extended source server in the target Account based on the source server in staging account.

", - "smithy.api#http": { - "uri": "/CreateExtendedSourceServer", - "method": "POST", - "code": 201 - } - } - }, - "com.amazonaws.drs#CreateExtendedSourceServerRequest": { - "type": "structure", - "members": { - "sourceServerArn": { - "target": "com.amazonaws.drs#SourceServerARN", - "traits": { - "smithy.api#documentation": "

This defines the ARN of the source server in staging Account based on which you want to create an extended source server.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.drs#TagsMap", - "traits": { - "smithy.api#documentation": "

A list of tags associated with the extended source server.

" - } - } - } - }, - "com.amazonaws.drs#CreateExtendedSourceServerResponse": { - "type": "structure", - "members": { - "sourceServer": { - "target": "com.amazonaws.drs#SourceServer", - "traits": { - "smithy.api#documentation": "

Created extended source server.

" - } - } - } - }, - "com.amazonaws.drs#CreateLaunchConfigurationTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#CreateLaunchConfigurationTemplateRequest" - }, - "output": { - "target": "com.amazonaws.drs#CreateLaunchConfigurationTemplateResponse" - }, - "errors": [ - { - "target": "com.amazonaws.drs#AccessDeniedException" - }, - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#UninitializedAccountException" - }, - { - "target": "com.amazonaws.drs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new Launch Configuration Template.

", - "smithy.api#http": { - "uri": "/CreateLaunchConfigurationTemplate", - "method": "POST", - "code": 201 - } - } - }, - "com.amazonaws.drs#CreateLaunchConfigurationTemplateRequest": { - "type": "structure", - "members": { - "tags": { - "target": "com.amazonaws.drs#TagsMap", - "traits": { - "smithy.api#documentation": "

Request to associate tags during creation of a Launch Configuration Template.

" - } - }, - "launchDisposition": { - "target": "com.amazonaws.drs#LaunchDisposition", - "traits": { - "smithy.api#documentation": "

Launch disposition.

" - } - }, - "targetInstanceTypeRightSizingMethod": { - "target": "com.amazonaws.drs#TargetInstanceTypeRightSizingMethod", - "traits": { - "smithy.api#documentation": "

Target instance type right-sizing method.

" - } - }, - "copyPrivateIp": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Copy private IP.

" - } - }, - "copyTags": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Copy tags.

" - } - }, - "licensing": { - "target": "com.amazonaws.drs#Licensing", - "traits": { - "smithy.api#documentation": "

Licensing.

" - } - } - } - }, - "com.amazonaws.drs#CreateLaunchConfigurationTemplateResponse": { - "type": "structure", - "members": { - "launchConfigurationTemplate": { - "target": "com.amazonaws.drs#LaunchConfigurationTemplate", - "traits": { - "smithy.api#documentation": "

Created Launch Configuration Template.

" - } - } - } - }, - "com.amazonaws.drs#CreateReplicationConfigurationTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#CreateReplicationConfigurationTemplateRequest" - }, - "output": { - "target": "com.amazonaws.drs#ReplicationConfigurationTemplate" - }, - "errors": [ - { - "target": "com.amazonaws.drs#AccessDeniedException" - }, - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#UninitializedAccountException" - }, - { - "target": "com.amazonaws.drs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new ReplicationConfigurationTemplate.

", - "smithy.api#http": { - "uri": "/CreateReplicationConfigurationTemplate", - "method": "POST", - "code": 201 - } - } - }, - "com.amazonaws.drs#CreateReplicationConfigurationTemplateRequest": { - "type": "structure", - "members": { - "stagingAreaSubnetId": { - "target": "com.amazonaws.drs#SubnetID", - "traits": { - "smithy.api#documentation": "

The subnet to be used by the replication staging area.

", - "smithy.api#required": {} - } - }, - "associateDefaultSecurityGroup": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.

", - "smithy.api#required": {} - } - }, - "replicationServersSecurityGroupsIDs": { - "target": "com.amazonaws.drs#ReplicationServersSecurityGroupsIDs", - "traits": { - "smithy.api#documentation": "

The security group IDs that will be used by the replication server.

", - "smithy.api#required": {} - } - }, - "replicationServerInstanceType": { - "target": "com.amazonaws.drs#EC2InstanceType", - "traits": { - "smithy.api#documentation": "

The instance type to be used for the replication server.

", - "smithy.api#required": {} - } - }, - "useDedicatedReplicationServer": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to use a dedicated Replication Server in the replication staging area.

", - "smithy.api#required": {} - } - }, - "defaultLargeStagingDiskType": { - "target": "com.amazonaws.drs#ReplicationConfigurationDefaultLargeStagingDiskType", - "traits": { - "smithy.api#documentation": "

The Staging Disk EBS volume type to be used during replication.

", - "smithy.api#required": {} - } - }, - "ebsEncryption": { - "target": "com.amazonaws.drs#ReplicationConfigurationEbsEncryption", - "traits": { - "smithy.api#documentation": "

The type of EBS encryption to be used during replication.

", - "smithy.api#required": {} - } - }, - "ebsEncryptionKeyArn": { - "target": "com.amazonaws.drs#ARN", - "traits": { - "smithy.api#documentation": "

The ARN of the EBS encryption key to be used during replication.

" - } - }, - "bandwidthThrottling": { - "target": "com.amazonaws.drs#PositiveInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.

", - "smithy.api#required": {} - } - }, - "dataPlaneRouting": { - "target": "com.amazonaws.drs#ReplicationConfigurationDataPlaneRouting", - "traits": { - "smithy.api#documentation": "

The data plane routing mechanism that will be used for replication.

", - "smithy.api#required": {} - } - }, - "createPublicIP": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to create a Public IP for the Recovery Instance by default.

", - "smithy.api#required": {} - } - }, - "stagingAreaTags": { - "target": "com.amazonaws.drs#TagsMap", - "traits": { - "smithy.api#documentation": "

A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.

", - "smithy.api#required": {} - } - }, - "pitPolicy": { - "target": "com.amazonaws.drs#PITPolicy", - "traits": { - "smithy.api#documentation": "

The Point in time (PIT) policy to manage snapshots taken during replication.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.drs#TagsMap", - "traits": { - "smithy.api#documentation": "

A set of tags to be associated with the Replication Configuration Template resource.

" - } - }, - "autoReplicateNewDisks": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to allow the AWS replication agent to automatically replicate newly added disks.

" - } - } - } - }, - "com.amazonaws.drs#DataReplicationError": { - "type": "structure", - "members": { - "error": { - "target": "com.amazonaws.drs#DataReplicationErrorString", - "traits": { - "smithy.api#documentation": "

Error in data replication.

" - } - }, - "rawError": { - "target": "com.amazonaws.drs#LargeBoundedString", - "traits": { - "smithy.api#documentation": "

Error in data replication.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Error in data replication.

" - } - }, - "com.amazonaws.drs#DataReplicationErrorString": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "AGENT_NOT_SEEN", - "value": "AGENT_NOT_SEEN" - }, - { - "name": "SNAPSHOTS_FAILURE", - "value": "SNAPSHOTS_FAILURE" - }, - { - "name": "NOT_CONVERGING", - "value": "NOT_CONVERGING" - }, - { - "name": "UNSTABLE_NETWORK", - "value": "UNSTABLE_NETWORK" - }, - { - "name": "FAILED_TO_CREATE_SECURITY_GROUP", - "value": "FAILED_TO_CREATE_SECURITY_GROUP" - }, - { - "name": "FAILED_TO_LAUNCH_REPLICATION_SERVER", - "value": "FAILED_TO_LAUNCH_REPLICATION_SERVER" - }, - { - "name": "FAILED_TO_BOOT_REPLICATION_SERVER", - "value": "FAILED_TO_BOOT_REPLICATION_SERVER" - }, - { - "name": "FAILED_TO_AUTHENTICATE_WITH_SERVICE", - "value": "FAILED_TO_AUTHENTICATE_WITH_SERVICE" - }, - { - "name": "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE", - "value": "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE" - }, - { - "name": "FAILED_TO_CREATE_STAGING_DISKS", - "value": "FAILED_TO_CREATE_STAGING_DISKS" - }, - { - "name": "FAILED_TO_ATTACH_STAGING_DISKS", - "value": "FAILED_TO_ATTACH_STAGING_DISKS" - }, - { - "name": "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT", - "value": "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT" - }, - { - "name": "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER", - "value": "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER" - }, - { - "name": "FAILED_TO_START_DATA_TRANSFER", - "value": "FAILED_TO_START_DATA_TRANSFER" - } - ] - } - }, - "com.amazonaws.drs#DataReplicationInfo": { - "type": "structure", - "members": { - "lagDuration": { - "target": "com.amazonaws.drs#ISO8601DurationString", - "traits": { - "smithy.api#documentation": "

Data replication lag duration.

" - } - }, - "etaDateTime": { - "target": "com.amazonaws.drs#ISO8601DatetimeString", - "traits": { - "smithy.api#documentation": "

An estimate of when the data replication will be completed.

" - } - }, - "replicatedDisks": { - "target": "com.amazonaws.drs#DataReplicationInfoReplicatedDisks", - "traits": { - "smithy.api#documentation": "

The disks that should be replicated.

" - } - }, - "dataReplicationState": { - "target": "com.amazonaws.drs#DataReplicationState", - "traits": { - "smithy.api#documentation": "

The state of the data replication.

" - } - }, - "dataReplicationInitiation": { - "target": "com.amazonaws.drs#DataReplicationInitiation", - "traits": { - "smithy.api#documentation": "

Information about whether the data replication has been initiated.

" - } - }, - "dataReplicationError": { - "target": "com.amazonaws.drs#DataReplicationError", - "traits": { - "smithy.api#documentation": "

Error in data replication.

" - } - }, - "stagingAvailabilityZone": { - "target": "com.amazonaws.drs#AwsAvailabilityZone", - "traits": { - "smithy.api#documentation": "

AWS Availability zone into which data is being replicated.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about Data Replication

" - } - }, - "com.amazonaws.drs#DataReplicationInfoReplicatedDisk": { - "type": "structure", - "members": { - "deviceName": { - "target": "com.amazonaws.drs#BoundedString", - "traits": { - "smithy.api#documentation": "

The name of the device.

" - } - }, - "totalStorageBytes": { - "target": "com.amazonaws.drs#PositiveInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The total amount of data to be replicated in bytes.

" - } - }, - "replicatedStorageBytes": { - "target": "com.amazonaws.drs#PositiveInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The amount of data replicated so far in bytes.

" - } - }, - "rescannedStorageBytes": { - "target": "com.amazonaws.drs#PositiveInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The amount of data to be rescanned in bytes.

" - } - }, - "backloggedStorageBytes": { - "target": "com.amazonaws.drs#PositiveInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The size of the replication backlog in bytes.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A disk that should be replicated.

" - } - }, - "com.amazonaws.drs#DataReplicationInfoReplicatedDisks": { - "type": "list", - "member": { - "target": "com.amazonaws.drs#DataReplicationInfoReplicatedDisk" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 60 - } - } - }, - "com.amazonaws.drs#DataReplicationInitiation": { - "type": "structure", - "members": { - "startDateTime": { - "target": "com.amazonaws.drs#ISO8601DatetimeString", - "traits": { - "smithy.api#documentation": "

The date and time of the current attempt to initiate data replication.

" - } - }, - "nextAttemptDateTime": { - "target": "com.amazonaws.drs#ISO8601DatetimeString", - "traits": { - "smithy.api#documentation": "

The date and time of the next attempt to initiate data replication.

" - } - }, - "steps": { - "target": "com.amazonaws.drs#DataReplicationInitiationSteps", - "traits": { - "smithy.api#documentation": "

The steps of the current attempt to initiate data replication.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Data replication initiation.

" - } - }, - "com.amazonaws.drs#DataReplicationInitiationStep": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.drs#DataReplicationInitiationStepName", - "traits": { - "smithy.api#documentation": "

The name of the step.

" - } - }, - "status": { - "target": "com.amazonaws.drs#DataReplicationInitiationStepStatus", - "traits": { - "smithy.api#documentation": "

The status of the step.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Data replication initiation step.

" - } - }, - "com.amazonaws.drs#DataReplicationInitiationStepName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "WAIT", - "name": "WAIT" - }, - { - "value": "CREATE_SECURITY_GROUP", - "name": "CREATE_SECURITY_GROUP" - }, - { - "value": "LAUNCH_REPLICATION_SERVER", - "name": "LAUNCH_REPLICATION_SERVER" - }, - { - "value": "BOOT_REPLICATION_SERVER", - "name": "BOOT_REPLICATION_SERVER" - }, - { - "value": "AUTHENTICATE_WITH_SERVICE", - "name": "AUTHENTICATE_WITH_SERVICE" - }, - { - "value": "DOWNLOAD_REPLICATION_SOFTWARE", - "name": "DOWNLOAD_REPLICATION_SOFTWARE" - }, - { - "value": "CREATE_STAGING_DISKS", - "name": "CREATE_STAGING_DISKS" - }, - { - "value": "ATTACH_STAGING_DISKS", - "name": "ATTACH_STAGING_DISKS" - }, - { - "value": "PAIR_REPLICATION_SERVER_WITH_AGENT", - "name": "PAIR_REPLICATION_SERVER_WITH_AGENT" - }, - { - "value": "CONNECT_AGENT_TO_REPLICATION_SERVER", - "name": "CONNECT_AGENT_TO_REPLICATION_SERVER" - }, - { - "value": "START_DATA_TRANSFER", - "name": "START_DATA_TRANSFER" - } - ] - } - }, - "com.amazonaws.drs#DataReplicationInitiationStepStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "NOT_STARTED", - "value": "NOT_STARTED" - }, - { - "name": "IN_PROGRESS", - "value": "IN_PROGRESS" - }, - { - "name": "SUCCEEDED", - "value": "SUCCEEDED" - }, - { - "name": "FAILED", - "value": "FAILED" - }, - { - "name": "SKIPPED", - "value": "SKIPPED" - } - ] - } - }, - "com.amazonaws.drs#DataReplicationInitiationSteps": { - "type": "list", - "member": { - "target": "com.amazonaws.drs#DataReplicationInitiationStep" - } - }, - "com.amazonaws.drs#DataReplicationState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "STOPPED", - "value": "STOPPED" - }, - { - "name": "INITIATING", - "value": "INITIATING" - }, - { - "name": "INITIAL_SYNC", - "value": "INITIAL_SYNC" - }, - { - "name": "BACKLOG", - "value": "BACKLOG" - }, - { - "name": "CREATING_SNAPSHOT", - "value": "CREATING_SNAPSHOT" - }, - { - "name": "CONTINUOUS", - "value": "CONTINUOUS" - }, - { - "name": "PAUSED", - "value": "PAUSED" - }, - { - "name": "RESCAN", - "value": "RESCAN" - }, - { - "name": "STALLED", - "value": "STALLED" - }, - { - "name": "DISCONNECTED", - "value": "DISCONNECTED" - } - ] - } - }, - "com.amazonaws.drs#DeleteJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#DeleteJobRequest" - }, - "output": { - "target": "com.amazonaws.drs#DeleteJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.drs#ConflictException" - }, - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#UninitializedAccountException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a single Job by ID.

", - "smithy.api#http": { - "uri": "/DeleteJob", - "method": "POST", - "code": 204 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.drs#DeleteJobRequest": { - "type": "structure", - "members": { - "jobID": { - "target": "com.amazonaws.drs#JobID", - "traits": { - "smithy.api#documentation": "

The ID of the Job to be deleted.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.drs#DeleteJobResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.drs#DeleteLaunchConfigurationTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#DeleteLaunchConfigurationTemplateRequest" - }, - "output": { - "target": "com.amazonaws.drs#DeleteLaunchConfigurationTemplateResponse" - }, - "errors": [ - { - "target": "com.amazonaws.drs#ConflictException" - }, - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#UninitializedAccountException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a single Launch Configuration Template by ID.

", - "smithy.api#http": { - "uri": "/DeleteLaunchConfigurationTemplate", - "method": "POST", - "code": 204 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.drs#DeleteLaunchConfigurationTemplateRequest": { - "type": "structure", - "members": { - "launchConfigurationTemplateID": { - "target": "com.amazonaws.drs#LaunchConfigurationTemplateID", - "traits": { - "smithy.api#documentation": "

The ID of the Launch Configuration Template to be deleted.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.drs#DeleteLaunchConfigurationTemplateResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.drs#DeleteRecoveryInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#DeleteRecoveryInstanceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.drs#AccessDeniedException" - }, - { - "target": "com.amazonaws.drs#ConflictException" - }, - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#UninitializedAccountException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a single Recovery Instance by ID. This deletes the Recovery Instance resource from Elastic Disaster Recovery. The Recovery Instance must be disconnected first in order to delete it.

", - "smithy.api#http": { - "uri": "/DeleteRecoveryInstance", - "method": "POST", - "code": 200 - } - } - }, - "com.amazonaws.drs#DeleteRecoveryInstanceRequest": { - "type": "structure", - "members": { - "recoveryInstanceID": { - "target": "com.amazonaws.drs#RecoveryInstanceID", - "traits": { - "smithy.api#documentation": "

The ID of the Recovery Instance to be deleted.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.drs#DeleteReplicationConfigurationTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#DeleteReplicationConfigurationTemplateRequest" - }, - "output": { - "target": "com.amazonaws.drs#DeleteReplicationConfigurationTemplateResponse" - }, - "errors": [ - { - "target": "com.amazonaws.drs#ConflictException" - }, - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#UninitializedAccountException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a single Replication Configuration Template by ID

", - "smithy.api#http": { - "uri": "/DeleteReplicationConfigurationTemplate", - "method": "POST", - "code": 204 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.drs#DeleteReplicationConfigurationTemplateRequest": { - "type": "structure", - "members": { - "replicationConfigurationTemplateID": { - "target": "com.amazonaws.drs#ReplicationConfigurationTemplateID", - "traits": { - "smithy.api#documentation": "

The ID of the Replication Configuration Template to be deleted.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.drs#DeleteReplicationConfigurationTemplateResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.drs#DeleteSourceServer": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#DeleteSourceServerRequest" - }, - "output": { - "target": "com.amazonaws.drs#DeleteSourceServerResponse" - }, - "errors": [ - { - "target": "com.amazonaws.drs#ConflictException" - }, - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#UninitializedAccountException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a single Source Server by ID. The Source Server must be disconnected first.

", - "smithy.api#http": { - "uri": "/DeleteSourceServer", - "method": "POST", - "code": 204 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.drs#DeleteSourceServerRequest": { - "type": "structure", - "members": { - "sourceServerID": { - "target": "com.amazonaws.drs#SourceServerID", - "traits": { - "smithy.api#documentation": "

The ID of the Source Server to be deleted.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.drs#DeleteSourceServerResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.drs#DescribeJobLogItems": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#DescribeJobLogItemsRequest" - }, - "output": { - "target": "com.amazonaws.drs#DescribeJobLogItemsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#UninitializedAccountException" - }, - { - "target": "com.amazonaws.drs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves a detailed Job log with pagination.

", - "smithy.api#http": { - "uri": "/DescribeJobLogItems", - "method": "POST", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "items" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.drs#DescribeJobLogItemsRequest": { - "type": "structure", - "members": { - "jobID": { - "target": "com.amazonaws.drs#JobID", - "traits": { - "smithy.api#documentation": "

The ID of the Job for which Job log items will be retrieved.

", - "smithy.api#required": {} - } - }, - "maxResults": { - "target": "com.amazonaws.drs#StrictlyPositiveInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Maximum number of Job log items to retrieve.

" - } - }, - "nextToken": { - "target": "com.amazonaws.drs#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token of the next Job log items to retrieve.

" - } - } - } - }, - "com.amazonaws.drs#DescribeJobLogItemsResponse": { - "type": "structure", - "members": { - "items": { - "target": "com.amazonaws.drs#JobLogs", - "traits": { - "smithy.api#documentation": "

An array of Job log items.

" - } - }, - "nextToken": { - "target": "com.amazonaws.drs#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token of the next Job log items to retrieve.

" - } - } - } - }, - "com.amazonaws.drs#DescribeJobs": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#DescribeJobsRequest" - }, - "output": { - "target": "com.amazonaws.drs#DescribeJobsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#UninitializedAccountException" - }, - { - "target": "com.amazonaws.drs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of Jobs. Use the JobsID and fromDate and toDate filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are created by the StartRecovery, TerminateRecoveryInstances and StartFailbackLaunch APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to *Support* and only used in response to relevant support tickets.

", - "smithy.api#http": { - "uri": "/DescribeJobs", - "method": "POST", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "items" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.drs#DescribeJobsRequest": { - "type": "structure", - "members": { - "filters": { - "target": "com.amazonaws.drs#DescribeJobsRequestFilters", - "traits": { - "smithy.api#documentation": "

A set of filters by which to return Jobs.

" - } - }, - "maxResults": { - "target": "com.amazonaws.drs#StrictlyPositiveInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Maximum number of Jobs to retrieve.

" - } - }, - "nextToken": { - "target": "com.amazonaws.drs#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token of the next Job to retrieve.

" - } - } - } - }, - "com.amazonaws.drs#DescribeJobsRequestFilters": { - "type": "structure", - "members": { - "jobIDs": { - "target": "com.amazonaws.drs#DescribeJobsRequestFiltersJobIDs", - "traits": { - "smithy.api#documentation": "

An array of Job IDs that should be returned. An empty array means all jobs.

" - } - }, - "fromDate": { - "target": "com.amazonaws.drs#ISO8601DatetimeString", - "traits": { - "smithy.api#documentation": "

The start date in a date range query.

" - } - }, - "toDate": { - "target": "com.amazonaws.drs#ISO8601DatetimeString", - "traits": { - "smithy.api#documentation": "

The end date in a date range query.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A set of filters by which to return Jobs.

" - } - }, - "com.amazonaws.drs#DescribeJobsRequestFiltersJobIDs": { - "type": "list", - "member": { - "target": "com.amazonaws.drs#JobID" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1000 - } - } - }, - "com.amazonaws.drs#DescribeJobsResponse": { - "type": "structure", - "members": { - "items": { - "target": "com.amazonaws.drs#JobsList", - "traits": { - "smithy.api#documentation": "

An array of Jobs.

" - } - }, - "nextToken": { - "target": "com.amazonaws.drs#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token of the next Job to retrieve.

" - } - } - } - }, - "com.amazonaws.drs#DescribeLaunchConfigurationTemplates": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#DescribeLaunchConfigurationTemplatesRequest" - }, - "output": { - "target": "com.amazonaws.drs#DescribeLaunchConfigurationTemplatesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#UninitializedAccountException" - }, - { - "target": "com.amazonaws.drs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all Launch Configuration Templates, filtered by Launch Configuration Template IDs

", - "smithy.api#http": { - "uri": "/DescribeLaunchConfigurationTemplates", - "method": "POST", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "items" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.drs#DescribeLaunchConfigurationTemplatesRequest": { - "type": "structure", - "members": { - "launchConfigurationTemplateIDs": { - "target": "com.amazonaws.drs#LaunchConfigurationTemplateIDs", - "traits": { - "smithy.api#documentation": "

Request to filter Launch Configuration Templates list by Launch Configuration Template ID.

" - } - }, - "maxResults": { - "target": "com.amazonaws.drs#MaxResultsType", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Maximum results to be returned in DescribeLaunchConfigurationTemplates.

" - } - }, - "nextToken": { - "target": "com.amazonaws.drs#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token of the next Launch Configuration Template to retrieve.

" - } - } - } - }, - "com.amazonaws.drs#DescribeLaunchConfigurationTemplatesResponse": { - "type": "structure", - "members": { - "items": { - "target": "com.amazonaws.drs#LaunchConfigurationTemplates", - "traits": { - "smithy.api#documentation": "

List of items returned by DescribeLaunchConfigurationTemplates.

" - } - }, - "nextToken": { - "target": "com.amazonaws.drs#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token of the next Launch Configuration Template to retrieve.

" - } - } - } - }, - "com.amazonaws.drs#DescribeRecoveryInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#DescribeRecoveryInstancesRequest" - }, - "output": { - "target": "com.amazonaws.drs#DescribeRecoveryInstancesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.drs#AccessDeniedException" - }, - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#UninitializedAccountException" - } - ], - "traits": { - "aws.iam#requiredActions": ["ec2:DescribeInstances", "drs:DescribeSourceServers"], - "smithy.api#documentation": "

Lists all Recovery Instances or multiple Recovery Instances by ID.

", - "smithy.api#http": { - "uri": "/DescribeRecoveryInstances", - "method": "POST", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "items" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.drs#DescribeRecoveryInstancesItems": { - "type": "list", - "member": { - "target": "com.amazonaws.drs#RecoveryInstance" - } - }, - "com.amazonaws.drs#DescribeRecoveryInstancesRequest": { - "type": "structure", - "members": { - "filters": { - "target": "com.amazonaws.drs#DescribeRecoveryInstancesRequestFilters", - "traits": { - "smithy.api#documentation": "

A set of filters by which to return Recovery Instances.

" - } - }, - "maxResults": { - "target": "com.amazonaws.drs#StrictlyPositiveInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Maximum number of Recovery Instances to retrieve.

" - } - }, - "nextToken": { - "target": "com.amazonaws.drs#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token of the next Recovery Instance to retrieve.

" - } - } - } - }, - "com.amazonaws.drs#DescribeRecoveryInstancesRequestFilters": { - "type": "structure", - "members": { - "recoveryInstanceIDs": { - "target": "com.amazonaws.drs#RecoveryInstanceIDs", - "traits": { - "smithy.api#documentation": "

An array of Recovery Instance IDs that should be returned. An empty array means all Recovery Instances.

" - } - }, - "sourceServerIDs": { - "target": "com.amazonaws.drs#SourceServerIDs", - "traits": { - "smithy.api#documentation": "

An array of Source Server IDs for which associated Recovery Instances should be returned.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A set of filters by which to return Recovery Instances.

" - } - }, - "com.amazonaws.drs#DescribeRecoveryInstancesResponse": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.drs#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token of the next Recovery Instance to retrieve.

" - } - }, - "items": { - "target": "com.amazonaws.drs#DescribeRecoveryInstancesItems", - "traits": { - "smithy.api#documentation": "

An array of Recovery Instances.

" - } - } - } - }, - "com.amazonaws.drs#DescribeRecoverySnapshots": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#DescribeRecoverySnapshotsRequest" - }, - "output": { - "target": "com.amazonaws.drs#DescribeRecoverySnapshotsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.drs#AccessDeniedException" - }, - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#UninitializedAccountException" - }, - { - "target": "com.amazonaws.drs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all Recovery Snapshots for a single Source Server.

", - "smithy.api#http": { - "uri": "/DescribeRecoverySnapshots", - "method": "POST", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "items" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.drs#DescribeRecoverySnapshotsRequest": { - "type": "structure", - "members": { - "sourceServerID": { - "target": "com.amazonaws.drs#SourceServerID", - "traits": { - "smithy.api#documentation": "

Filter Recovery Snapshots by Source Server ID.

", - "smithy.api#required": {} - } - }, - "filters": { - "target": "com.amazonaws.drs#DescribeRecoverySnapshotsRequestFilters", - "traits": { - "smithy.api#documentation": "

A set of filters by which to return Recovery Snapshots.

" - } - }, - "order": { - "target": "com.amazonaws.drs#RecoverySnapshotsOrder", - "traits": { - "smithy.api#documentation": "

The sorted ordering by which to return Recovery Snapshots.

" - } - }, - "maxResults": { - "target": "com.amazonaws.drs#StrictlyPositiveInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Maximum number of Recovery Snapshots to retrieve.

" - } - }, - "nextToken": { - "target": "com.amazonaws.drs#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token of the next Recovery Snapshot to retrieve.

" - } - } - } - }, - "com.amazonaws.drs#DescribeRecoverySnapshotsRequestFilters": { - "type": "structure", - "members": { - "fromDateTime": { - "target": "com.amazonaws.drs#ISO8601DatetimeString", - "traits": { - "smithy.api#documentation": "

The start date in a date range query.

" - } - }, - "toDateTime": { - "target": "com.amazonaws.drs#ISO8601DatetimeString", - "traits": { - "smithy.api#documentation": "

The end date in a date range query.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A set of filters by which to return Recovery Snapshots.

" - } - }, - "com.amazonaws.drs#DescribeRecoverySnapshotsResponse": { - "type": "structure", - "members": { - "items": { - "target": "com.amazonaws.drs#RecoverySnapshotsList", - "traits": { - "smithy.api#documentation": "

An array of Recovery Snapshots.

" - } - }, - "nextToken": { - "target": "com.amazonaws.drs#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token of the next Recovery Snapshot to retrieve.

" - } - } - } - }, - "com.amazonaws.drs#DescribeReplicationConfigurationTemplates": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#DescribeReplicationConfigurationTemplatesRequest" - }, - "output": { - "target": "com.amazonaws.drs#DescribeReplicationConfigurationTemplatesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#UninitializedAccountException" - }, - { - "target": "com.amazonaws.drs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.

", - "smithy.api#http": { - "uri": "/DescribeReplicationConfigurationTemplates", - "method": "POST", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "items" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.drs#DescribeReplicationConfigurationTemplatesRequest": { - "type": "structure", - "members": { - "replicationConfigurationTemplateIDs": { - "target": "com.amazonaws.drs#ReplicationConfigurationTemplateIDs", - "traits": { - "smithy.api#documentation": "

The IDs of the Replication Configuration Templates to retrieve. An empty list means all Replication Configuration Templates.

" - } - }, - "maxResults": { - "target": "com.amazonaws.drs#StrictlyPositiveInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Maximum number of Replication Configuration Templates to retrieve.

" - } - }, - "nextToken": { - "target": "com.amazonaws.drs#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token of the next Replication Configuration Template to retrieve.

" - } - } - } - }, - "com.amazonaws.drs#DescribeReplicationConfigurationTemplatesResponse": { - "type": "structure", - "members": { - "items": { - "target": "com.amazonaws.drs#ReplicationConfigurationTemplates", - "traits": { - "smithy.api#documentation": "

An array of Replication Configuration Templates.

" - } - }, - "nextToken": { - "target": "com.amazonaws.drs#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token of the next Replication Configuration Template to retrieve.

" - } - } - } - }, - "com.amazonaws.drs#DescribeSourceServers": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#DescribeSourceServersRequest" - }, - "output": { - "target": "com.amazonaws.drs#DescribeSourceServersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#UninitializedAccountException" - }, - { - "target": "com.amazonaws.drs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all Source Servers or multiple Source Servers filtered by ID.

", - "smithy.api#http": { - "uri": "/DescribeSourceServers", - "method": "POST", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "items" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.drs#DescribeSourceServersRequest": { - "type": "structure", - "members": { - "filters": { - "target": "com.amazonaws.drs#DescribeSourceServersRequestFilters", - "traits": { - "smithy.api#documentation": "

A set of filters by which to return Source Servers.

" - } - }, - "maxResults": { - "target": "com.amazonaws.drs#StrictlyPositiveInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Maximum number of Source Servers to retrieve.

" - } - }, - "nextToken": { - "target": "com.amazonaws.drs#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token of the next Source Server to retrieve.

" - } - } - } - }, - "com.amazonaws.drs#DescribeSourceServersRequestFilters": { - "type": "structure", - "members": { - "sourceServerIDs": { - "target": "com.amazonaws.drs#DescribeSourceServersRequestFiltersIDs", - "traits": { - "smithy.api#documentation": "

An array of Source Servers IDs that should be returned. An empty array means all Source Servers.

" - } - }, - "hardwareId": { - "target": "com.amazonaws.drs#BoundedString", - "traits": { - "smithy.api#documentation": "

An ID that describes the hardware of the Source Server. This is either an EC2 instance id, a VMware uuid or a mac address.

" - } - }, - "stagingAccountIDs": { - "target": "com.amazonaws.drs#AccountIDs", - "traits": { - "smithy.api#documentation": "

An array of staging account IDs that extended source servers belong to. An empty array means all source servers will be shown.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A set of filters by which to return Source Servers.

" - } - }, - "com.amazonaws.drs#DescribeSourceServersRequestFiltersIDs": { - "type": "list", - "member": { - "target": "com.amazonaws.drs#SourceServerID" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.drs#DescribeSourceServersResponse": { - "type": "structure", - "members": { - "items": { - "target": "com.amazonaws.drs#SourceServersList", - "traits": { - "smithy.api#documentation": "

An array of Source Servers.

" - } - }, - "nextToken": { - "target": "com.amazonaws.drs#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token of the next Source Server to retrieve.

" - } - } - } - }, - "com.amazonaws.drs#DisconnectRecoveryInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#DisconnectRecoveryInstanceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.drs#AccessDeniedException" - }, - { - "target": "com.amazonaws.drs#ConflictException" - }, - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#UninitializedAccountException" - } - ], - "traits": { - "smithy.api#documentation": "

Disconnect a Recovery Instance from Elastic Disaster Recovery. Data replication is stopped immediately. All AWS resources created by Elastic Disaster Recovery for enabling the replication of the Recovery Instance will be terminated / deleted within 90 minutes. If the agent on the Recovery Instance has not been prevented from communicating with the Elastic Disaster Recovery service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the Recovery Instance will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.

", - "smithy.api#http": { - "uri": "/DisconnectRecoveryInstance", - "method": "POST", - "code": 200 - } - } - }, - "com.amazonaws.drs#DisconnectRecoveryInstanceRequest": { - "type": "structure", - "members": { - "recoveryInstanceID": { - "target": "com.amazonaws.drs#RecoveryInstanceID", - "traits": { - "smithy.api#documentation": "

The ID of the Recovery Instance to disconnect.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.drs#DisconnectSourceServer": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#DisconnectSourceServerRequest" - }, - "output": { - "target": "com.amazonaws.drs#SourceServer" - }, - "errors": [ - { - "target": "com.amazonaws.drs#ConflictException" - }, - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#UninitializedAccountException" - } - ], - "traits": { - "smithy.api#documentation": "

Disconnects a specific Source Server from Elastic Disaster Recovery. Data replication is stopped immediately. All AWS resources created by Elastic Disaster Recovery for enabling the replication of the Source Server will be terminated / deleted within 90 minutes. You cannot disconnect a Source Server if it has a Recovery Instance. If the agent on the Source Server has not been prevented from communicating with the Elastic Disaster Recovery service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.

", - "smithy.api#http": { - "uri": "/DisconnectSourceServer", - "method": "POST", - "code": 200 - } - } - }, - "com.amazonaws.drs#DisconnectSourceServerRequest": { - "type": "structure", - "members": { - "sourceServerID": { - "target": "com.amazonaws.drs#SourceServerID", - "traits": { - "smithy.api#documentation": "

The ID of the Source Server to disconnect.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.drs#Disk": { - "type": "structure", - "members": { - "deviceName": { - "target": "com.amazonaws.drs#BoundedString", - "traits": { - "smithy.api#documentation": "

The disk or device name.

" - } - }, - "bytes": { - "target": "com.amazonaws.drs#PositiveInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The amount of storage on the disk in bytes.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An object representing a data storage device on a server.

" - } - }, - "com.amazonaws.drs#Disks": { - "type": "list", - "member": { - "target": "com.amazonaws.drs#Disk" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1000 - } - } - }, - "com.amazonaws.drs#EC2InstanceID": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - }, - "smithy.api#pattern": "^i-[0-9a-fA-F]{8,}$" - } - }, - "com.amazonaws.drs#EC2InstanceState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "PENDING", - "value": "PENDING" - }, - { - "name": "RUNNING", - "value": "RUNNING" - }, - { - "name": "STOPPING", - "value": "STOPPING" - }, - { - "name": "STOPPED", - "value": "STOPPED" - }, - { - "name": "SHUTTING_DOWN", - "value": "SHUTTING-DOWN" - }, - { - "name": "TERMINATED", - "value": "TERMINATED" - }, - { - "name": "NOT_FOUND", - "value": "NOT_FOUND" - } - ] - } - }, - "com.amazonaws.drs#EC2InstanceType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - } - } - }, - "com.amazonaws.drs#EbsSnapshot": { - "type": "string", - "traits": { - "smithy.api#pattern": "^snap-[0-9a-zA-Z]{17}$" - } - }, - "com.amazonaws.drs#EbsSnapshotsList": { - "type": "list", - "member": { - "target": "com.amazonaws.drs#EbsSnapshot" - } - }, - "com.amazonaws.drs#EbsVolumeID": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 10, - "max": 19 - }, - "smithy.api#pattern": "^vol-([0-9a-fA-F]{8}|[0-9a-fA-F]{17})$" - } - }, - "com.amazonaws.drs#ElasticDisasterRecoveryService": { - "type": "service", - "version": "2020-02-26", - "operations": [ - { - "target": "com.amazonaws.drs#CreateExtendedSourceServer" - }, - { - "target": "com.amazonaws.drs#InitializeService" - }, - { - "target": "com.amazonaws.drs#ListExtensibleSourceServers" - }, - { - "target": "com.amazonaws.drs#ListStagingAccounts" - }, - { - "target": "com.amazonaws.drs#ListTagsForResource" - }, - { - "target": "com.amazonaws.drs#TagResource" - }, - { - "target": "com.amazonaws.drs#UntagResource" - } - ], - "resources": [ - { - "target": "com.amazonaws.drs#AccountResource" + "smithy": "2.0", + "shapes": { + "com.amazonaws.drs#ARN": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:.{16,2044}$" + } + }, + "com.amazonaws.drs#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.drs#LargeBoundedString" + }, + "code": { + "target": "com.amazonaws.drs#LargeBoundedString" + } + }, + "traits": { + "smithy.api#documentation": "

You do not have sufficient access to perform this action.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.drs#Account": { + "type": "structure", + "members": { + "accountID": { + "target": "com.amazonaws.drs#AccountID", + "traits": { + "smithy.api#documentation": "

Account ID of AWS account.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

AWS account.

" + } + }, + "com.amazonaws.drs#AccountID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "[0-9]{12,}" + } + }, + "com.amazonaws.drs#AccountIDs": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#AccountID" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.drs#AccountResource": { + "type": "resource", + "identifiers": { + "accountID": { + "target": "com.amazonaws.drs#AccountID" + } + }, + "traits": { + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.drs#Accounts": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#Account" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.drs#AssociateSourceNetworkStack": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#AssociateSourceNetworkStackRequest" + }, + "output": { + "target": "com.amazonaws.drs#AssociateSourceNetworkStackResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "cloudformation:DescribeStacks", + "cloudformation:DescribeStackResource", + "ec2:DescribeVpcs", + "ec2:DescribeSubnets", + "ec2:DescribeSecurityGroups", + "ec2:DescribeLaunchTemplates", + "ec2:DescribeLaunchTemplateVersions", + "ec2:ModifyLaunchTemplate", + "ec2:CreateLaunchTemplateVersion", + "drs:GetLaunchConfiguration" + ], + "smithy.api#documentation": "

Associate a Source Network to an existing CloudFormation Stack and modify launch templates to use this network. Can be used for reverting to previously deployed CloudFormation stacks.

", + "smithy.api#http": { + "uri": "/AssociateSourceNetworkStack", + "method": "POST", + "code": 202 + } + } + }, + "com.amazonaws.drs#AssociateSourceNetworkStackRequest": { + "type": "structure", + "members": { + "sourceNetworkID": { + "target": "com.amazonaws.drs#SourceNetworkID", + "traits": { + "smithy.api#documentation": "

The Source Network ID to associate with CloudFormation template.

", + "smithy.api#required": {} + } + }, + "cfnStackName": { + "target": "com.amazonaws.drs#CfnStackName", + "traits": { + "smithy.api#documentation": "

CloudFormation template to associate with a Source Network.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.drs#AssociateSourceNetworkStackResponse": { + "type": "structure", + "members": { + "job": { + "target": "com.amazonaws.drs#Job", + "traits": { + "smithy.api#documentation": "

The Source Network association Job.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.drs#AwsAvailabilityZone": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^(us(-gov)?|ap|ca|cn|eu|sa|af|me)-(central|north|(north(?:east|west))|south|south(?:east|west)|east|west)-[0-9][a-z]$" + } + }, + "com.amazonaws.drs#AwsRegion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^(us(-gov)?|ap|ca|cn|eu|sa|af|me)-(central|north|(north(?:east|west))|south|south(?:east|west)|east|west)-[0-9]$" + } + }, + "com.amazonaws.drs#BoundedString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.drs#CPU": { + "type": "structure", + "members": { + "cores": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of CPU cores.

" + } + }, + "modelName": { + "target": "com.amazonaws.drs#BoundedString", + "traits": { + "smithy.api#documentation": "

The model name of the CPU.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a server's CPU.

" + } + }, + "com.amazonaws.drs#CfnStackName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z][-a-zA-Z0-9]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.drs#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.drs#LargeBoundedString" + }, + "code": { + "target": "com.amazonaws.drs#LargeBoundedString" + }, + "resourceId": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "

The ID of the resource.

" + } + }, + "resourceType": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "

The type of the resource.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The request could not be completed due to a conflict with the current state of the target resource.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.drs#ConversionMap": { + "type": "map", + "key": { + "target": "com.amazonaws.drs#EbsSnapshot" + }, + "value": { + "target": "com.amazonaws.drs#EbsSnapshot" + } + }, + "com.amazonaws.drs#ConversionProperties": { + "type": "structure", + "members": { + "volumeToConversionMap": { + "target": "com.amazonaws.drs#VolumeToConversionMap", + "traits": { + "smithy.api#documentation": "

A mapping between the volumes being converted and the converted snapshot ids

" + } + }, + "rootVolumeName": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "

The root volume name of a conversion job

" + } + }, + "forceUefi": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether the volume being converted uses UEFI or not

" + } + }, + "dataTimestamp": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "

The timestamp of when the snapshot being converted was taken

" + } + }, + "volumeToVolumeSize": { + "target": "com.amazonaws.drs#VolumeToSizeMap", + "traits": { + "smithy.api#documentation": "

A mapping between the volumes and their sizes

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Properties of a conversion job

" + } + }, + "com.amazonaws.drs#Cpus": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#CPU" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.drs#CreateExtendedSourceServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#CreateExtendedSourceServerRequest" + }, + "output": { + "target": "com.amazonaws.drs#CreateExtendedSourceServerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#AccessDeniedException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Create an extended source server in the target Account based on the source server in staging account.

", + "smithy.api#http": { + "uri": "/CreateExtendedSourceServer", + "method": "POST", + "code": 201 + } + } + }, + "com.amazonaws.drs#CreateExtendedSourceServerRequest": { + "type": "structure", + "members": { + "sourceServerArn": { + "target": "com.amazonaws.drs#SourceServerARN", + "traits": { + "smithy.api#documentation": "

This defines the ARN of the source server in staging Account based on which you want to create an extended source server.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "

A list of tags associated with the extended source server.

" + } + } + } + }, + "com.amazonaws.drs#CreateExtendedSourceServerResponse": { + "type": "structure", + "members": { + "sourceServer": { + "target": "com.amazonaws.drs#SourceServer", + "traits": { + "smithy.api#documentation": "

Created extended source server.

" + } + } + } + }, + "com.amazonaws.drs#CreateLaunchConfigurationTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#CreateLaunchConfigurationTemplateRequest" + }, + "output": { + "target": "com.amazonaws.drs#CreateLaunchConfigurationTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#AccessDeniedException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new Launch Configuration Template.

", + "smithy.api#http": { + "uri": "/CreateLaunchConfigurationTemplate", + "method": "POST", + "code": 201 + } + } + }, + "com.amazonaws.drs#CreateLaunchConfigurationTemplateRequest": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "

Request to associate tags during creation of a Launch Configuration Template.

" + } + }, + "launchDisposition": { + "target": "com.amazonaws.drs#LaunchDisposition", + "traits": { + "smithy.api#documentation": "

Launch disposition.

" + } + }, + "targetInstanceTypeRightSizingMethod": { + "target": "com.amazonaws.drs#TargetInstanceTypeRightSizingMethod", + "traits": { + "smithy.api#documentation": "

Target instance type right-sizing method.

" + } + }, + "copyPrivateIp": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Copy private IP.

" + } + }, + "copyTags": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Copy tags.

" + } + }, + "licensing": { + "target": "com.amazonaws.drs#Licensing", + "traits": { + "smithy.api#documentation": "

Licensing.

" + } + }, + "exportBucketArn": { + "target": "com.amazonaws.drs#ARN", + "traits": { + "smithy.api#documentation": "

S3 bucket ARN to export Source Network templates.

" + } + } + } + }, + "com.amazonaws.drs#CreateLaunchConfigurationTemplateResponse": { + "type": "structure", + "members": { + "launchConfigurationTemplate": { + "target": "com.amazonaws.drs#LaunchConfigurationTemplate", + "traits": { + "smithy.api#documentation": "

Created Launch Configuration Template.

" + } + } + } + }, + "com.amazonaws.drs#CreateReplicationConfigurationTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#CreateReplicationConfigurationTemplateRequest" + }, + "output": { + "target": "com.amazonaws.drs#ReplicationConfigurationTemplate" + }, + "errors": [ + { + "target": "com.amazonaws.drs#AccessDeniedException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new ReplicationConfigurationTemplate.

", + "smithy.api#http": { + "uri": "/CreateReplicationConfigurationTemplate", + "method": "POST", + "code": 201 + } + } + }, + "com.amazonaws.drs#CreateReplicationConfigurationTemplateRequest": { + "type": "structure", + "members": { + "stagingAreaSubnetId": { + "target": "com.amazonaws.drs#SubnetID", + "traits": { + "smithy.api#documentation": "

The subnet to be used by the replication staging area.

", + "smithy.api#required": {} + } + }, + "associateDefaultSecurityGroup": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.

", + "smithy.api#required": {} + } + }, + "replicationServersSecurityGroupsIDs": { + "target": "com.amazonaws.drs#ReplicationServersSecurityGroupsIDs", + "traits": { + "smithy.api#documentation": "

The security group IDs that will be used by the replication server.

", + "smithy.api#required": {} + } + }, + "replicationServerInstanceType": { + "target": "com.amazonaws.drs#EC2InstanceType", + "traits": { + "smithy.api#documentation": "

The instance type to be used for the replication server.

", + "smithy.api#required": {} + } + }, + "useDedicatedReplicationServer": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to use a dedicated Replication Server in the replication staging area.

", + "smithy.api#required": {} + } + }, + "defaultLargeStagingDiskType": { + "target": "com.amazonaws.drs#ReplicationConfigurationDefaultLargeStagingDiskType", + "traits": { + "smithy.api#documentation": "

The Staging Disk EBS volume type to be used during replication.

", + "smithy.api#required": {} + } + }, + "ebsEncryption": { + "target": "com.amazonaws.drs#ReplicationConfigurationEbsEncryption", + "traits": { + "smithy.api#documentation": "

The type of EBS encryption to be used during replication.

", + "smithy.api#required": {} + } + }, + "ebsEncryptionKeyArn": { + "target": "com.amazonaws.drs#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the EBS encryption key to be used during replication.

" + } + }, + "bandwidthThrottling": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.

", + "smithy.api#required": {} + } + }, + "dataPlaneRouting": { + "target": "com.amazonaws.drs#ReplicationConfigurationDataPlaneRouting", + "traits": { + "smithy.api#documentation": "

The data plane routing mechanism that will be used for replication.

", + "smithy.api#required": {} + } + }, + "createPublicIP": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to create a Public IP for the Recovery Instance by default.

", + "smithy.api#required": {} + } + }, + "stagingAreaTags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "

A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.

", + "smithy.api#required": {} + } + }, + "pitPolicy": { + "target": "com.amazonaws.drs#PITPolicy", + "traits": { + "smithy.api#documentation": "

The Point in time (PIT) policy to manage snapshots taken during replication.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "

A set of tags to be associated with the Replication Configuration Template resource.

" + } + }, + "autoReplicateNewDisks": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to allow the AWS replication agent to automatically replicate newly added disks.

" + } + } + } + }, + "com.amazonaws.drs#CreateSourceNetwork": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#CreateSourceNetworkRequest" + }, + "output": { + "target": "com.amazonaws.drs#CreateSourceNetworkResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "ec2:DescribeVpcs", + "ec2:DescribeInstances" + ], + "smithy.api#documentation": "

Create a new Source Network resource for a provided VPC ID.

", + "smithy.api#http": { + "uri": "/CreateSourceNetwork", + "method": "POST", + "code": 201 + } + } + }, + "com.amazonaws.drs#CreateSourceNetworkRequest": { + "type": "structure", + "members": { + "vpcID": { + "target": "com.amazonaws.drs#VpcID", + "traits": { + "smithy.api#documentation": "

Which VPC ID to protect.

", + "smithy.api#required": {} + } + }, + "originAccountID": { + "target": "com.amazonaws.drs#AccountID", + "traits": { + "smithy.api#documentation": "

Account containing the VPC to protect.

", + "smithy.api#required": {} + } + }, + "originRegion": { + "target": "com.amazonaws.drs#AwsRegion", + "traits": { + "smithy.api#documentation": "

Region containing the VPC to protect.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "

A set of tags to be associated with the Source Network resource.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.drs#CreateSourceNetworkResponse": { + "type": "structure", + "members": { + "sourceNetworkID": { + "target": "com.amazonaws.drs#SourceNetworkID", + "traits": { + "smithy.api#documentation": "

ID of the created Source Network.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.drs#DataReplicationError": { + "type": "structure", + "members": { + "error": { + "target": "com.amazonaws.drs#DataReplicationErrorString", + "traits": { + "smithy.api#documentation": "

Error in data replication.

" + } + }, + "rawError": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "

Error in data replication.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Error in data replication.

" + } + }, + "com.amazonaws.drs#DataReplicationErrorString": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "AGENT_NOT_SEEN", + "value": "AGENT_NOT_SEEN" + }, + { + "name": "SNAPSHOTS_FAILURE", + "value": "SNAPSHOTS_FAILURE" + }, + { + "name": "NOT_CONVERGING", + "value": "NOT_CONVERGING" + }, + { + "name": "UNSTABLE_NETWORK", + "value": "UNSTABLE_NETWORK" + }, + { + "name": "FAILED_TO_CREATE_SECURITY_GROUP", + "value": "FAILED_TO_CREATE_SECURITY_GROUP" + }, + { + "name": "FAILED_TO_LAUNCH_REPLICATION_SERVER", + "value": "FAILED_TO_LAUNCH_REPLICATION_SERVER" + }, + { + "name": "FAILED_TO_BOOT_REPLICATION_SERVER", + "value": "FAILED_TO_BOOT_REPLICATION_SERVER" + }, + { + "name": "FAILED_TO_AUTHENTICATE_WITH_SERVICE", + "value": "FAILED_TO_AUTHENTICATE_WITH_SERVICE" + }, + { + "name": "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE", + "value": "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE" + }, + { + "name": "FAILED_TO_CREATE_STAGING_DISKS", + "value": "FAILED_TO_CREATE_STAGING_DISKS" + }, + { + "name": "FAILED_TO_ATTACH_STAGING_DISKS", + "value": "FAILED_TO_ATTACH_STAGING_DISKS" + }, + { + "name": "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT", + "value": "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT" + }, + { + "name": "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER", + "value": "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER" + }, + { + "name": "FAILED_TO_START_DATA_TRANSFER", + "value": "FAILED_TO_START_DATA_TRANSFER" + } + ] + } + }, + "com.amazonaws.drs#DataReplicationInfo": { + "type": "structure", + "members": { + "lagDuration": { + "target": "com.amazonaws.drs#ISO8601DurationString", + "traits": { + "smithy.api#documentation": "

Data replication lag duration.

" + } + }, + "etaDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "

An estimate of when the data replication will be completed.

" + } + }, + "replicatedDisks": { + "target": "com.amazonaws.drs#DataReplicationInfoReplicatedDisks", + "traits": { + "smithy.api#documentation": "

The disks that should be replicated.

" + } + }, + "dataReplicationState": { + "target": "com.amazonaws.drs#DataReplicationState", + "traits": { + "smithy.api#documentation": "

The state of the data replication.

" + } + }, + "dataReplicationInitiation": { + "target": "com.amazonaws.drs#DataReplicationInitiation", + "traits": { + "smithy.api#documentation": "

Information about whether the data replication has been initiated.

" + } + }, + "dataReplicationError": { + "target": "com.amazonaws.drs#DataReplicationError", + "traits": { + "smithy.api#documentation": "

Error in data replication.

" + } + }, + "stagingAvailabilityZone": { + "target": "com.amazonaws.drs#AwsAvailabilityZone", + "traits": { + "smithy.api#documentation": "

AWS Availability zone into which data is being replicated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about Data Replication

" + } + }, + "com.amazonaws.drs#DataReplicationInfoReplicatedDisk": { + "type": "structure", + "members": { + "deviceName": { + "target": "com.amazonaws.drs#BoundedString", + "traits": { + "smithy.api#documentation": "

The name of the device.

" + } + }, + "totalStorageBytes": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total amount of data to be replicated in bytes.

" + } + }, + "replicatedStorageBytes": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount of data replicated so far in bytes.

" + } + }, + "rescannedStorageBytes": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount of data to be rescanned in bytes.

" + } + }, + "backloggedStorageBytes": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The size of the replication backlog in bytes.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A disk that should be replicated.

" + } + }, + "com.amazonaws.drs#DataReplicationInfoReplicatedDisks": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#DataReplicationInfoReplicatedDisk" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 60 + } + } + }, + "com.amazonaws.drs#DataReplicationInitiation": { + "type": "structure", + "members": { + "startDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "

The date and time of the current attempt to initiate data replication.

" + } + }, + "nextAttemptDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "

The date and time of the next attempt to initiate data replication.

" + } + }, + "steps": { + "target": "com.amazonaws.drs#DataReplicationInitiationSteps", + "traits": { + "smithy.api#documentation": "

The steps of the current attempt to initiate data replication.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Data replication initiation.

" + } + }, + "com.amazonaws.drs#DataReplicationInitiationStep": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.drs#DataReplicationInitiationStepName", + "traits": { + "smithy.api#documentation": "

The name of the step.

" + } + }, + "status": { + "target": "com.amazonaws.drs#DataReplicationInitiationStepStatus", + "traits": { + "smithy.api#documentation": "

The status of the step.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Data replication initiation step.

" + } + }, + "com.amazonaws.drs#DataReplicationInitiationStepName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "WAIT", + "name": "WAIT" + }, + { + "value": "CREATE_SECURITY_GROUP", + "name": "CREATE_SECURITY_GROUP" + }, + { + "value": "LAUNCH_REPLICATION_SERVER", + "name": "LAUNCH_REPLICATION_SERVER" + }, + { + "value": "BOOT_REPLICATION_SERVER", + "name": "BOOT_REPLICATION_SERVER" + }, + { + "value": "AUTHENTICATE_WITH_SERVICE", + "name": "AUTHENTICATE_WITH_SERVICE" + }, + { + "value": "DOWNLOAD_REPLICATION_SOFTWARE", + "name": "DOWNLOAD_REPLICATION_SOFTWARE" + }, + { + "value": "CREATE_STAGING_DISKS", + "name": "CREATE_STAGING_DISKS" + }, + { + "value": "ATTACH_STAGING_DISKS", + "name": "ATTACH_STAGING_DISKS" + }, + { + "value": "PAIR_REPLICATION_SERVER_WITH_AGENT", + "name": "PAIR_REPLICATION_SERVER_WITH_AGENT" + }, + { + "value": "CONNECT_AGENT_TO_REPLICATION_SERVER", + "name": "CONNECT_AGENT_TO_REPLICATION_SERVER" + }, + { + "value": "START_DATA_TRANSFER", + "name": "START_DATA_TRANSFER" + } + ] + } + }, + "com.amazonaws.drs#DataReplicationInitiationStepStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "NOT_STARTED", + "value": "NOT_STARTED" + }, + { + "name": "IN_PROGRESS", + "value": "IN_PROGRESS" + }, + { + "name": "SUCCEEDED", + "value": "SUCCEEDED" + }, + { + "name": "FAILED", + "value": "FAILED" + }, + { + "name": "SKIPPED", + "value": "SKIPPED" + } + ] + } + }, + "com.amazonaws.drs#DataReplicationInitiationSteps": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#DataReplicationInitiationStep" + } + }, + "com.amazonaws.drs#DataReplicationState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "STOPPED", + "value": "STOPPED" + }, + { + "name": "INITIATING", + "value": "INITIATING" + }, + { + "name": "INITIAL_SYNC", + "value": "INITIAL_SYNC" + }, + { + "name": "BACKLOG", + "value": "BACKLOG" + }, + { + "name": "CREATING_SNAPSHOT", + "value": "CREATING_SNAPSHOT" + }, + { + "name": "CONTINUOUS", + "value": "CONTINUOUS" + }, + { + "name": "PAUSED", + "value": "PAUSED" + }, + { + "name": "RESCAN", + "value": "RESCAN" + }, + { + "name": "STALLED", + "value": "STALLED" + }, + { + "name": "DISCONNECTED", + "value": "DISCONNECTED" + } + ] + } + }, + "com.amazonaws.drs#DeleteJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#DeleteJobRequest" + }, + "output": { + "target": "com.amazonaws.drs#DeleteJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a single Job by ID.

", + "smithy.api#http": { + "uri": "/DeleteJob", + "method": "POST", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.drs#DeleteJobRequest": { + "type": "structure", + "members": { + "jobID": { + "target": "com.amazonaws.drs#JobID", + "traits": { + "smithy.api#documentation": "

The ID of the Job to be deleted.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.drs#DeleteJobResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.drs#DeleteLaunchConfigurationTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#DeleteLaunchConfigurationTemplateRequest" + }, + "output": { + "target": "com.amazonaws.drs#DeleteLaunchConfigurationTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a single Launch Configuration Template by ID.

", + "smithy.api#http": { + "uri": "/DeleteLaunchConfigurationTemplate", + "method": "POST", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.drs#DeleteLaunchConfigurationTemplateRequest": { + "type": "structure", + "members": { + "launchConfigurationTemplateID": { + "target": "com.amazonaws.drs#LaunchConfigurationTemplateID", + "traits": { + "smithy.api#documentation": "

The ID of the Launch Configuration Template to be deleted.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.drs#DeleteLaunchConfigurationTemplateResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.drs#DeleteRecoveryInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#DeleteRecoveryInstanceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.drs#AccessDeniedException" + }, + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a single Recovery Instance by ID. This deletes the Recovery Instance resource from Elastic Disaster Recovery. The Recovery Instance must be disconnected first in order to delete it.

", + "smithy.api#http": { + "uri": "/DeleteRecoveryInstance", + "method": "POST", + "code": 200 + } + } + }, + "com.amazonaws.drs#DeleteRecoveryInstanceRequest": { + "type": "structure", + "members": { + "recoveryInstanceID": { + "target": "com.amazonaws.drs#RecoveryInstanceID", + "traits": { + "smithy.api#documentation": "

The ID of the Recovery Instance to be deleted.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.drs#DeleteReplicationConfigurationTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#DeleteReplicationConfigurationTemplateRequest" + }, + "output": { + "target": "com.amazonaws.drs#DeleteReplicationConfigurationTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a single Replication Configuration Template by ID

", + "smithy.api#http": { + "uri": "/DeleteReplicationConfigurationTemplate", + "method": "POST", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.drs#DeleteReplicationConfigurationTemplateRequest": { + "type": "structure", + "members": { + "replicationConfigurationTemplateID": { + "target": "com.amazonaws.drs#ReplicationConfigurationTemplateID", + "traits": { + "smithy.api#documentation": "

The ID of the Replication Configuration Template to be deleted.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.drs#DeleteReplicationConfigurationTemplateResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.drs#DeleteSourceNetwork": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#DeleteSourceNetworkRequest" + }, + "output": { + "target": "com.amazonaws.drs#DeleteSourceNetworkResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + } + ], + "traits": { + "smithy.api#documentation": "

Delete Source Network resource.

", + "smithy.api#http": { + "uri": "/DeleteSourceNetwork", + "method": "POST", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.drs#DeleteSourceNetworkRequest": { + "type": "structure", + "members": { + "sourceNetworkID": { + "target": "com.amazonaws.drs#SourceNetworkID", + "traits": { + "smithy.api#documentation": "

ID of the Source Network to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.drs#DeleteSourceNetworkResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.drs#DeleteSourceServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#DeleteSourceServerRequest" + }, + "output": { + "target": "com.amazonaws.drs#DeleteSourceServerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a single Source Server by ID. The Source Server must be disconnected first.

", + "smithy.api#http": { + "uri": "/DeleteSourceServer", + "method": "POST", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.drs#DeleteSourceServerRequest": { + "type": "structure", + "members": { + "sourceServerID": { + "target": "com.amazonaws.drs#SourceServerID", + "traits": { + "smithy.api#documentation": "

The ID of the Source Server to be deleted.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.drs#DeleteSourceServerResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.drs#DescribeJobLogItems": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#DescribeJobLogItemsRequest" + }, + "output": { + "target": "com.amazonaws.drs#DescribeJobLogItemsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a detailed Job log with pagination.

", + "smithy.api#http": { + "uri": "/DescribeJobLogItems", + "method": "POST", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.drs#DescribeJobLogItemsRequest": { + "type": "structure", + "members": { + "jobID": { + "target": "com.amazonaws.drs#JobID", + "traits": { + "smithy.api#documentation": "

The ID of the Job for which Job log items will be retrieved.

", + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.drs#StrictlyPositiveInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Maximum number of Job log items to retrieve.

" + } + }, + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token of the next Job log items to retrieve.

" + } + } + } + }, + "com.amazonaws.drs#DescribeJobLogItemsResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.drs#JobLogs", + "traits": { + "smithy.api#documentation": "

An array of Job log items.

" + } + }, + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token of the next Job log items to retrieve.

" + } + } + } + }, + "com.amazonaws.drs#DescribeJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#DescribeJobsRequest" + }, + "output": { + "target": "com.amazonaws.drs#DescribeJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of Jobs. Use the JobsID and fromDate and toDate filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are created by the StartRecovery, TerminateRecoveryInstances and StartFailbackLaunch APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to *Support* and only used in response to relevant support tickets.

", + "smithy.api#http": { + "uri": "/DescribeJobs", + "method": "POST", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.drs#DescribeJobsRequest": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.drs#DescribeJobsRequestFilters", + "traits": { + "smithy.api#documentation": "

A set of filters by which to return Jobs.

" + } + }, + "maxResults": { + "target": "com.amazonaws.drs#StrictlyPositiveInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Maximum number of Jobs to retrieve.

" + } + }, + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token of the next Job to retrieve.

" + } + } + } + }, + "com.amazonaws.drs#DescribeJobsRequestFilters": { + "type": "structure", + "members": { + "jobIDs": { + "target": "com.amazonaws.drs#DescribeJobsRequestFiltersJobIDs", + "traits": { + "smithy.api#documentation": "

An array of Job IDs that should be returned. An empty array means all jobs.

" + } + }, + "fromDate": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "

The start date in a date range query.

" + } + }, + "toDate": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "

The end date in a date range query.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A set of filters by which to return Jobs.

" + } + }, + "com.amazonaws.drs#DescribeJobsRequestFiltersJobIDs": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#JobID" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + } + } + }, + "com.amazonaws.drs#DescribeJobsResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.drs#JobsList", + "traits": { + "smithy.api#documentation": "

An array of Jobs.

" + } + }, + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token of the next Job to retrieve.

" + } + } + } + }, + "com.amazonaws.drs#DescribeLaunchConfigurationTemplates": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#DescribeLaunchConfigurationTemplatesRequest" + }, + "output": { + "target": "com.amazonaws.drs#DescribeLaunchConfigurationTemplatesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all Launch Configuration Templates, filtered by Launch Configuration Template IDs

", + "smithy.api#http": { + "uri": "/DescribeLaunchConfigurationTemplates", + "method": "POST", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.drs#DescribeLaunchConfigurationTemplatesRequest": { + "type": "structure", + "members": { + "launchConfigurationTemplateIDs": { + "target": "com.amazonaws.drs#LaunchConfigurationTemplateIDs", + "traits": { + "smithy.api#documentation": "

Request to filter Launch Configuration Templates list by Launch Configuration Template ID.

" + } + }, + "maxResults": { + "target": "com.amazonaws.drs#MaxResultsType", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Maximum results to be returned in DescribeLaunchConfigurationTemplates.

" + } + }, + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token of the next Launch Configuration Template to retrieve.

" + } + } + } + }, + "com.amazonaws.drs#DescribeLaunchConfigurationTemplatesResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.drs#LaunchConfigurationTemplates", + "traits": { + "smithy.api#documentation": "

List of items returned by DescribeLaunchConfigurationTemplates.

" + } + }, + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token of the next Launch Configuration Template to retrieve.

" + } + } + } + }, + "com.amazonaws.drs#DescribeRecoveryInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#DescribeRecoveryInstancesRequest" + }, + "output": { + "target": "com.amazonaws.drs#DescribeRecoveryInstancesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#AccessDeniedException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "ec2:DescribeInstances", + "drs:DescribeSourceServers" + ], + "smithy.api#documentation": "

Lists all Recovery Instances or multiple Recovery Instances by ID.

", + "smithy.api#http": { + "uri": "/DescribeRecoveryInstances", + "method": "POST", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.drs#DescribeRecoveryInstancesItems": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#RecoveryInstance" + } + }, + "com.amazonaws.drs#DescribeRecoveryInstancesRequest": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.drs#DescribeRecoveryInstancesRequestFilters", + "traits": { + "smithy.api#documentation": "

A set of filters by which to return Recovery Instances.

" + } + }, + "maxResults": { + "target": "com.amazonaws.drs#StrictlyPositiveInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Maximum number of Recovery Instances to retrieve.

" + } + }, + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token of the next Recovery Instance to retrieve.

" + } + } + } + }, + "com.amazonaws.drs#DescribeRecoveryInstancesRequestFilters": { + "type": "structure", + "members": { + "recoveryInstanceIDs": { + "target": "com.amazonaws.drs#RecoveryInstanceIDs", + "traits": { + "smithy.api#documentation": "

An array of Recovery Instance IDs that should be returned. An empty array means all Recovery Instances.

" + } + }, + "sourceServerIDs": { + "target": "com.amazonaws.drs#SourceServerIDs", + "traits": { + "smithy.api#documentation": "

An array of Source Server IDs for which associated Recovery Instances should be returned.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A set of filters by which to return Recovery Instances.

" + } + }, + "com.amazonaws.drs#DescribeRecoveryInstancesResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token of the next Recovery Instance to retrieve.

" + } + }, + "items": { + "target": "com.amazonaws.drs#DescribeRecoveryInstancesItems", + "traits": { + "smithy.api#documentation": "

An array of Recovery Instances.

" + } + } + } + }, + "com.amazonaws.drs#DescribeRecoverySnapshots": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#DescribeRecoverySnapshotsRequest" + }, + "output": { + "target": "com.amazonaws.drs#DescribeRecoverySnapshotsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#AccessDeniedException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all Recovery Snapshots for a single Source Server.

", + "smithy.api#http": { + "uri": "/DescribeRecoverySnapshots", + "method": "POST", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.drs#DescribeRecoverySnapshotsRequest": { + "type": "structure", + "members": { + "sourceServerID": { + "target": "com.amazonaws.drs#SourceServerID", + "traits": { + "smithy.api#documentation": "

Filter Recovery Snapshots by Source Server ID.

", + "smithy.api#required": {} + } + }, + "filters": { + "target": "com.amazonaws.drs#DescribeRecoverySnapshotsRequestFilters", + "traits": { + "smithy.api#documentation": "

A set of filters by which to return Recovery Snapshots.

" + } + }, + "order": { + "target": "com.amazonaws.drs#RecoverySnapshotsOrder", + "traits": { + "smithy.api#documentation": "

The sorted ordering by which to return Recovery Snapshots.

" + } + }, + "maxResults": { + "target": "com.amazonaws.drs#StrictlyPositiveInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Maximum number of Recovery Snapshots to retrieve.

" + } + }, + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token of the next Recovery Snapshot to retrieve.

" + } + } + } + }, + "com.amazonaws.drs#DescribeRecoverySnapshotsRequestFilters": { + "type": "structure", + "members": { + "fromDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "

The start date in a date range query.

" + } + }, + "toDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "

The end date in a date range query.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A set of filters by which to return Recovery Snapshots.

" + } + }, + "com.amazonaws.drs#DescribeRecoverySnapshotsResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.drs#RecoverySnapshotsList", + "traits": { + "smithy.api#documentation": "

An array of Recovery Snapshots.

" + } + }, + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token of the next Recovery Snapshot to retrieve.

" + } + } + } + }, + "com.amazonaws.drs#DescribeReplicationConfigurationTemplates": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#DescribeReplicationConfigurationTemplatesRequest" + }, + "output": { + "target": "com.amazonaws.drs#DescribeReplicationConfigurationTemplatesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.

", + "smithy.api#http": { + "uri": "/DescribeReplicationConfigurationTemplates", + "method": "POST", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.drs#DescribeReplicationConfigurationTemplatesRequest": { + "type": "structure", + "members": { + "replicationConfigurationTemplateIDs": { + "target": "com.amazonaws.drs#ReplicationConfigurationTemplateIDs", + "traits": { + "smithy.api#documentation": "

The IDs of the Replication Configuration Templates to retrieve. An empty list means all Replication Configuration Templates.

" + } + }, + "maxResults": { + "target": "com.amazonaws.drs#StrictlyPositiveInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Maximum number of Replication Configuration Templates to retrieve.

" + } + }, + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token of the next Replication Configuration Template to retrieve.

" + } + } + } + }, + "com.amazonaws.drs#DescribeReplicationConfigurationTemplatesResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.drs#ReplicationConfigurationTemplates", + "traits": { + "smithy.api#documentation": "

An array of Replication Configuration Templates.

" + } + }, + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token of the next Replication Configuration Template to retrieve.

" + } + } + } + }, + "com.amazonaws.drs#DescribeSourceNetworks": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#DescribeSourceNetworksRequest" + }, + "output": { + "target": "com.amazonaws.drs#DescribeSourceNetworksResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all Source Networks or multiple Source Networks filtered by ID.

", + "smithy.api#http": { + "uri": "/DescribeSourceNetworks", + "method": "POST", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.drs#DescribeSourceNetworksRequest": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.drs#DescribeSourceNetworksRequestFilters", + "traits": { + "smithy.api#documentation": "

A set of filters by which to return Source Networks.

" + } + }, + "maxResults": { + "target": "com.amazonaws.drs#StrictlyPositiveInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Maximum number of Source Networks to retrieve.

" + } + }, + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token of the next Source Networks to retrieve.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.drs#DescribeSourceNetworksRequestFilters": { + "type": "structure", + "members": { + "sourceNetworkIDs": { + "target": "com.amazonaws.drs#DescribeSourceNetworksRequestFiltersIDs", + "traits": { + "smithy.api#documentation": "

An array of Source Network IDs that should be returned. An empty array means all Source Networks.

" + } + }, + "originAccountID": { + "target": "com.amazonaws.drs#AccountID", + "traits": { + "smithy.api#documentation": "

Filter Source Networks by account ID containing the protected VPCs.

" + } + }, + "originRegion": { + "target": "com.amazonaws.drs#AwsRegion", + "traits": { + "smithy.api#documentation": "

Filter Source Networks by the region containing the protected VPCs.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A set of filters by which to return Source Networks.

" + } + }, + "com.amazonaws.drs#DescribeSourceNetworksRequestFiltersIDs": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#SourceNetworkID" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.drs#DescribeSourceNetworksResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.drs#SourceNetworksList", + "traits": { + "smithy.api#documentation": "

An array of Source Networks.

" + } + }, + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token of the next Source Networks to retrieve.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.drs#DescribeSourceServers": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#DescribeSourceServersRequest" + }, + "output": { + "target": "com.amazonaws.drs#DescribeSourceServersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all Source Servers or multiple Source Servers filtered by ID.

", + "smithy.api#http": { + "uri": "/DescribeSourceServers", + "method": "POST", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.drs#DescribeSourceServersRequest": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.drs#DescribeSourceServersRequestFilters", + "traits": { + "smithy.api#documentation": "

A set of filters by which to return Source Servers.

" + } + }, + "maxResults": { + "target": "com.amazonaws.drs#StrictlyPositiveInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Maximum number of Source Servers to retrieve.

" + } + }, + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token of the next Source Server to retrieve.

" + } + } + } + }, + "com.amazonaws.drs#DescribeSourceServersRequestFilters": { + "type": "structure", + "members": { + "sourceServerIDs": { + "target": "com.amazonaws.drs#DescribeSourceServersRequestFiltersIDs", + "traits": { + "smithy.api#documentation": "

An array of Source Servers IDs that should be returned. An empty array means all Source Servers.

" + } + }, + "hardwareId": { + "target": "com.amazonaws.drs#BoundedString", + "traits": { + "smithy.api#documentation": "

An ID that describes the hardware of the Source Server. This is either an EC2 instance id, a VMware uuid or a mac address.

" + } + }, + "stagingAccountIDs": { + "target": "com.amazonaws.drs#AccountIDs", + "traits": { + "smithy.api#documentation": "

An array of staging account IDs that extended source servers belong to. An empty array means all source servers will be shown.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A set of filters by which to return Source Servers.

" + } + }, + "com.amazonaws.drs#DescribeSourceServersRequestFiltersIDs": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#SourceServerID" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.drs#DescribeSourceServersResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.drs#SourceServersList", + "traits": { + "smithy.api#documentation": "

An array of Source Servers.

" + } + }, + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token of the next Source Server to retrieve.

" + } + } + } + }, + "com.amazonaws.drs#DisconnectRecoveryInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#DisconnectRecoveryInstanceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.drs#AccessDeniedException" + }, + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + } + ], + "traits": { + "smithy.api#documentation": "

Disconnect a Recovery Instance from Elastic Disaster Recovery. Data replication is stopped immediately. All AWS resources created by Elastic Disaster Recovery for enabling the replication of the Recovery Instance will be terminated / deleted within 90 minutes. If the agent on the Recovery Instance has not been prevented from communicating with the Elastic Disaster Recovery service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the Recovery Instance will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.

", + "smithy.api#http": { + "uri": "/DisconnectRecoveryInstance", + "method": "POST", + "code": 200 + } + } + }, + "com.amazonaws.drs#DisconnectRecoveryInstanceRequest": { + "type": "structure", + "members": { + "recoveryInstanceID": { + "target": "com.amazonaws.drs#RecoveryInstanceID", + "traits": { + "smithy.api#documentation": "

The ID of the Recovery Instance to disconnect.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.drs#DisconnectSourceServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#DisconnectSourceServerRequest" + }, + "output": { + "target": "com.amazonaws.drs#SourceServer" + }, + "errors": [ + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + } + ], + "traits": { + "smithy.api#documentation": "

Disconnects a specific Source Server from Elastic Disaster Recovery. Data replication is stopped immediately. All AWS resources created by Elastic Disaster Recovery for enabling the replication of the Source Server will be terminated / deleted within 90 minutes. You cannot disconnect a Source Server if it has a Recovery Instance. If the agent on the Source Server has not been prevented from communicating with the Elastic Disaster Recovery service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.

", + "smithy.api#http": { + "uri": "/DisconnectSourceServer", + "method": "POST", + "code": 200 + } + } + }, + "com.amazonaws.drs#DisconnectSourceServerRequest": { + "type": "structure", + "members": { + "sourceServerID": { + "target": "com.amazonaws.drs#SourceServerID", + "traits": { + "smithy.api#documentation": "

The ID of the Source Server to disconnect.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.drs#Disk": { + "type": "structure", + "members": { + "deviceName": { + "target": "com.amazonaws.drs#BoundedString", + "traits": { + "smithy.api#documentation": "

The disk or device name.

" + } + }, + "bytes": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount of storage on the disk in bytes.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing a data storage device on a server.

" + } + }, + "com.amazonaws.drs#Disks": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#Disk" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + } + } + }, + "com.amazonaws.drs#EC2InstanceID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^i-[0-9a-fA-F]{8,}$" + } + }, + "com.amazonaws.drs#EC2InstanceState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "PENDING", + "value": "PENDING" + }, + { + "name": "RUNNING", + "value": "RUNNING" + }, + { + "name": "STOPPING", + "value": "STOPPING" + }, + { + "name": "STOPPED", + "value": "STOPPED" + }, + { + "name": "SHUTTING_DOWN", + "value": "SHUTTING-DOWN" + }, + { + "name": "TERMINATED", + "value": "TERMINATED" + }, + { + "name": "NOT_FOUND", + "value": "NOT_FOUND" + } + ] + } + }, + "com.amazonaws.drs#EC2InstanceType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.drs#EbsSnapshot": { + "type": "string", + "traits": { + "smithy.api#pattern": "^snap-[0-9a-zA-Z]{17}$" + } + }, + "com.amazonaws.drs#EbsSnapshotsList": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#EbsSnapshot" + } + }, + "com.amazonaws.drs#EbsVolumeID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 19 + }, + "smithy.api#pattern": "^vol-([0-9a-fA-F]{8}|[0-9a-fA-F]{17})$" + } + }, + "com.amazonaws.drs#ElasticDisasterRecoveryService": { + "type": "service", + "version": "2020-02-26", + "operations": [ + { + "target": "com.amazonaws.drs#CreateExtendedSourceServer" + }, + { + "target": "com.amazonaws.drs#InitializeService" + }, + { + "target": "com.amazonaws.drs#ListExtensibleSourceServers" + }, + { + "target": "com.amazonaws.drs#ListStagingAccounts" + }, + { + "target": "com.amazonaws.drs#ListTagsForResource" + }, + { + "target": "com.amazonaws.drs#TagResource" + }, + { + "target": "com.amazonaws.drs#UntagResource" + } + ], + "resources": [ + { + "target": "com.amazonaws.drs#AccountResource" + }, + { + "target": "com.amazonaws.drs#JobResource" + }, + { + "target": "com.amazonaws.drs#LaunchConfigurationTemplateResource" + }, + { + "target": "com.amazonaws.drs#RecoveryInstanceResource" + }, + { + "target": "com.amazonaws.drs#ReplicationConfigurationTemplateResource" + }, + { + "target": "com.amazonaws.drs#SourceNetworkResource" + }, + { + "target": "com.amazonaws.drs#SourceServerResource" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "drs", + "arnNamespace": "drs", + "awsProductName": "drs", + "cloudTrailEventSource": "drs.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "drs" + }, + "aws.iam#defineConditionKeys": { + "drs:EC2InstanceARN": { + "type": "String", + "documentation": "Filters access by the EC2 instance the request originated from" + } + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "Content-Type", + "X-Amz-Content-Sha256", + "X-Amz-User-Agent", + "X-Amzn-Trace-Id" + ], + "additionalExposedHeaders": [ + "X-Amzn-Errortype", + "X-Amzn-Requestid", + "X-Amzn-Trace-Id", + "X-Amz-Apigw-Id" + ] + }, + "smithy.api#documentation": "

AWS Elastic Disaster Recovery Service.

", + "smithy.api#title": "Elastic Disaster Recovery Service", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://drs-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://drs-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://drs.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://drs.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://drs.af-south-1.amazonaws.com" + } + }, + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://drs.ap-east-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://drs.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://drs.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://drs.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://drs.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://drs.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://drs.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://drs.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://drs.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://drs.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://drs.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://drs.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://drs.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://drs.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://drs.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://drs.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://drs.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://drs.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://drs.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://drs.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://drs-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://drs-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://drs.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://drs-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://drs-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://drs.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://drs.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://drs-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://drs-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://drs.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://drs.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://drs-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://drs.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://drs-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://drs.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.drs#EventResourceData": { + "type": "union", + "members": { + "sourceNetworkData": { + "target": "com.amazonaws.drs#SourceNetworkData", + "traits": { + "smithy.api#documentation": "

Source Network properties.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Properties of resource related to a job event.

" + } + }, + "com.amazonaws.drs#ExportSourceNetworkCfnTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#ExportSourceNetworkCfnTemplateRequest" + }, + "output": { + "target": "com.amazonaws.drs#ExportSourceNetworkCfnTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "s3:GetBucketLocation", + "s3:PutObject", + "s3:GetObject" + ], + "smithy.api#documentation": "

Export the Source Network CloudFormation template to an S3 bucket.

", + "smithy.api#http": { + "uri": "/ExportSourceNetworkCfnTemplate", + "method": "POST", + "code": 200 + } + } + }, + "com.amazonaws.drs#ExportSourceNetworkCfnTemplateRequest": { + "type": "structure", + "members": { + "sourceNetworkID": { + "target": "com.amazonaws.drs#SourceNetworkID", + "traits": { + "smithy.api#documentation": "

The Source Network ID to export its CloudFormation template to an S3 bucket.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.drs#ExportSourceNetworkCfnTemplateResponse": { + "type": "structure", + "members": { + "s3DestinationUrl": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "

S3 bucket URL where the Source Network CloudFormation template was exported to.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.drs#ExtensionStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "EXTENDED", + "value": "EXTENDED" + }, + { + "name": "EXTENSION_ERROR", + "value": "EXTENSION_ERROR" + }, + { + "name": "NOT_EXTENDED", + "value": "NOT_EXTENDED" + } + ] + } + }, + "com.amazonaws.drs#FailbackLaunchType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "RECOVERY", + "value": "RECOVERY" + }, + { + "name": "DRILL", + "value": "DRILL" + } + ] + } + }, + "com.amazonaws.drs#FailbackReplicationError": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "AGENT_NOT_SEEN", + "value": "AGENT_NOT_SEEN" + }, + { + "name": "FAILBACK_CLIENT_NOT_SEEN", + "value": "FAILBACK_CLIENT_NOT_SEEN" + }, + { + "name": "NOT_CONVERGING", + "value": "NOT_CONVERGING" + }, + { + "name": "UNSTABLE_NETWORK", + "value": "UNSTABLE_NETWORK" + }, + { + "name": "FAILED_TO_ESTABLISH_RECOVERY_INSTANCE_COMMUNICATION", + "value": "FAILED_TO_ESTABLISH_RECOVERY_INSTANCE_COMMUNICATION" + }, + { + "name": "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE_TO_FAILBACK_CLIENT", + "value": "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE_TO_FAILBACK_CLIENT" + }, + { + "name": "FAILED_TO_CONFIGURE_REPLICATION_SOFTWARE", + "value": "FAILED_TO_CONFIGURE_REPLICATION_SOFTWARE" + }, + { + "name": "FAILED_TO_PAIR_AGENT_WITH_REPLICATION_SOFTWARE", + "value": "FAILED_TO_PAIR_AGENT_WITH_REPLICATION_SOFTWARE" + }, + { + "name": "FAILED_TO_ESTABLISH_AGENT_REPLICATOR_SOFTWARE_COMMUNICATION", + "value": "FAILED_TO_ESTABLISH_AGENT_REPLICATOR_SOFTWARE_COMMUNICATION" + }, + { + "name": "FAILED_GETTING_REPLICATION_STATE", + "value": "FAILED_GETTING_REPLICATION_STATE" + }, + { + "name": "SNAPSHOTS_FAILURE", + "value": "SNAPSHOTS_FAILURE" + }, + { + "name": "FAILED_TO_CREATE_SECURITY_GROUP", + "value": "FAILED_TO_CREATE_SECURITY_GROUP" + }, + { + "name": "FAILED_TO_LAUNCH_REPLICATION_SERVER", + "value": "FAILED_TO_LAUNCH_REPLICATION_SERVER" + }, + { + "name": "FAILED_TO_BOOT_REPLICATION_SERVER", + "value": "FAILED_TO_BOOT_REPLICATION_SERVER" + }, + { + "name": "FAILED_TO_AUTHENTICATE_WITH_SERVICE", + "value": "FAILED_TO_AUTHENTICATE_WITH_SERVICE" + }, + { + "name": "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE", + "value": "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE" + }, + { + "name": "FAILED_TO_CREATE_STAGING_DISKS", + "value": "FAILED_TO_CREATE_STAGING_DISKS" + }, + { + "name": "FAILED_TO_ATTACH_STAGING_DISKS", + "value": "FAILED_TO_ATTACH_STAGING_DISKS" + }, + { + "name": "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT", + "value": "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT" + }, + { + "name": "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER", + "value": "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER" + }, + { + "name": "FAILED_TO_START_DATA_TRANSFER", + "value": "FAILED_TO_START_DATA_TRANSFER" + } + ] + } + }, + "com.amazonaws.drs#FailbackState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "FAILBACK_NOT_STARTED", + "value": "FAILBACK_NOT_STARTED" + }, + { + "name": "FAILBACK_IN_PROGRESS", + "value": "FAILBACK_IN_PROGRESS" + }, + { + "name": "FAILBACK_READY_FOR_LAUNCH", + "value": "FAILBACK_READY_FOR_LAUNCH" + }, + { + "name": "FAILBACK_COMPLETED", + "value": "FAILBACK_COMPLETED" + }, + { + "name": "FAILBACK_ERROR", + "value": "FAILBACK_ERROR" + }, + { + "name": "FAILBACK_NOT_READY_FOR_LAUNCH", + "value": "FAILBACK_NOT_READY_FOR_LAUNCH" + }, + { + "name": "FAILBACK_LAUNCH_STATE_NOT_AVAILABLE", + "value": "FAILBACK_LAUNCH_STATE_NOT_AVAILABLE" + } + ] + } + }, + "com.amazonaws.drs#GetFailbackReplicationConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#GetFailbackReplicationConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.drs#GetFailbackReplicationConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all Failback ReplicationConfigurations, filtered by Recovery Instance ID.

", + "smithy.api#http": { + "uri": "/GetFailbackReplicationConfiguration", + "method": "POST", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.drs#GetFailbackReplicationConfigurationRequest": { + "type": "structure", + "members": { + "recoveryInstanceID": { + "target": "com.amazonaws.drs#RecoveryInstanceID", + "traits": { + "smithy.api#documentation": "

The ID of the Recovery Instance whose failback replication configuration should be returned.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.drs#GetFailbackReplicationConfigurationResponse": { + "type": "structure", + "members": { + "recoveryInstanceID": { + "target": "com.amazonaws.drs#RecoveryInstanceID", + "traits": { + "smithy.api#documentation": "

The ID of the Recovery Instance.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.drs#BoundedString", + "traits": { + "smithy.api#documentation": "

The name of the Failback Replication Configuration.

" + } + }, + "bandwidthThrottling": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Configure bandwidth throttling for the outbound data transfer rate of the Recovery Instance in Mbps.

" + } + }, + "usePrivateIP": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to use Private IP for the failback replication of the Recovery Instance.

" + } + } + } + }, + "com.amazonaws.drs#GetLaunchConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#GetLaunchConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.drs#LaunchConfiguration" + }, + "errors": [ + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a LaunchConfiguration, filtered by Source Server IDs.

", + "smithy.api#http": { + "uri": "/GetLaunchConfiguration", + "method": "POST", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.drs#GetLaunchConfigurationRequest": { + "type": "structure", + "members": { + "sourceServerID": { + "target": "com.amazonaws.drs#SourceServerID", + "traits": { + "smithy.api#documentation": "

The ID of the Source Server that we want to retrieve a Launch Configuration for.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.drs#GetReplicationConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#GetReplicationConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.drs#ReplicationConfiguration" + }, + "errors": [ + { + "target": "com.amazonaws.drs#AccessDeniedException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a ReplicationConfiguration, filtered by Source Server ID.

", + "smithy.api#http": { + "uri": "/GetReplicationConfiguration", + "method": "POST", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.drs#GetReplicationConfigurationRequest": { + "type": "structure", + "members": { + "sourceServerID": { + "target": "com.amazonaws.drs#SourceServerID", + "traits": { + "smithy.api#documentation": "

The ID of the Source Serve for this Replication Configuration.r

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.drs#IPsList": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#BoundedString" + } + }, + "com.amazonaws.drs#ISO8601DatetimeString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 19, + "max": 32 + }, + "smithy.api#pattern": "^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?Z$" + } + }, + "com.amazonaws.drs#ISO8601DurationString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.drs#IdentificationHints": { + "type": "structure", + "members": { + "fqdn": { + "target": "com.amazonaws.drs#BoundedString", + "traits": { + "smithy.api#documentation": "

Fully Qualified Domain Name identification hint.

" + } + }, + "hostname": { + "target": "com.amazonaws.drs#BoundedString", + "traits": { + "smithy.api#documentation": "

Hostname identification hint.

" + } + }, + "vmWareUuid": { + "target": "com.amazonaws.drs#BoundedString", + "traits": { + "smithy.api#documentation": "

vCenter VM path identification hint.

" + } + }, + "awsInstanceID": { + "target": "com.amazonaws.drs#EC2InstanceID", + "traits": { + "smithy.api#documentation": "

AWS Instance ID identification hint.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Hints used to uniquely identify a machine.

" + } + }, + "com.amazonaws.drs#InitializeService": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#InitializeServiceRequest" + }, + "output": { + "target": "com.amazonaws.drs#InitializeServiceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#AccessDeniedException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "iam:CreateServiceLinkedRole", + "iam:GetInstanceProfile", + "iam:CreateInstanceProfile", + "iam:AddRoleToInstanceProfile" + ], + "smithy.api#documentation": "

Initialize Elastic Disaster Recovery.

", + "smithy.api#http": { + "uri": "/InitializeService", + "method": "POST", + "code": 204 + } + } + }, + "com.amazonaws.drs#InitializeServiceRequest": { + "type": "structure", + "members": {} + }, + "com.amazonaws.drs#InitializeServiceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.drs#InitiatedBy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "START_RECOVERY", + "name": "START_RECOVERY" + }, + { + "value": "START_DRILL", + "name": "START_DRILL" + }, + { + "value": "FAILBACK", + "name": "FAILBACK" + }, + { + "value": "DIAGNOSTIC", + "name": "DIAGNOSTIC" + }, + { + "value": "TERMINATE_RECOVERY_INSTANCES", + "name": "TERMINATE_RECOVERY_INSTANCES" + }, + { + "value": "TARGET_ACCOUNT", + "name": "TARGET_ACCOUNT" + }, + { + "value": "CREATE_NETWORK_RECOVERY", + "name": "CREATE_NETWORK_RECOVERY" + }, + { + "value": "UPDATE_NETWORK_RECOVERY", + "name": "UPDATE_NETWORK_RECOVERY" + }, + { + "value": "ASSOCIATE_NETWORK_RECOVERY", + "name": "ASSOCIATE_NETWORK_RECOVERY" + } + ] + } + }, + "com.amazonaws.drs#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#required": {} + } + }, + "retryAfterSeconds": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of seconds after which the request should be safe to retry.

", + "smithy.api#httpHeader": "Retry-After" + } + } + }, + "traits": { + "smithy.api#documentation": "

The request processing has failed because of an unknown error, exception or failure.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.drs#Job": { + "type": "structure", + "members": { + "jobID": { + "target": "com.amazonaws.drs#JobID", + "traits": { + "smithy.api#documentation": "

The ID of the Job.

", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.drs#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of a Job.

" + } + }, + "type": { + "target": "com.amazonaws.drs#JobType", + "traits": { + "smithy.api#documentation": "

The type of the Job.

" + } + }, + "initiatedBy": { + "target": "com.amazonaws.drs#InitiatedBy", + "traits": { + "smithy.api#documentation": "

A string representing who initiated the Job.

" + } + }, + "creationDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "

The date and time of when the Job was created.

" + } + }, + "endDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "

The date and time of when the Job ended.

" + } + }, + "status": { + "target": "com.amazonaws.drs#JobStatus", + "traits": { + "smithy.api#documentation": "

The status of the Job.

" + } + }, + "participatingServers": { + "target": "com.amazonaws.drs#ParticipatingServers", + "traits": { + "smithy.api#documentation": "

A list of servers that the Job is acting upon.

" + } + }, + "tags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "

A list of tags associated with the Job.

" + } + }, + "participatingResources": { + "target": "com.amazonaws.drs#ParticipatingResources", + "traits": { + "smithy.api#documentation": "

A list of resources that the Job is acting upon.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A job is an asynchronous workflow.

" + } + }, + "com.amazonaws.drs#JobID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 24, + "max": 24 + }, + "smithy.api#pattern": "^drsjob-[0-9a-zA-Z]{17}$" + } + }, + "com.amazonaws.drs#JobLog": { + "type": "structure", + "members": { + "logDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "

The date and time the log was taken.

" + } + }, + "event": { + "target": "com.amazonaws.drs#JobLogEvent", + "traits": { + "smithy.api#documentation": "

The event represents the type of a log.

" + } + }, + "eventData": { + "target": "com.amazonaws.drs#JobLogEventData", + "traits": { + "smithy.api#documentation": "

Metadata associated with a Job log.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A log outputted by a Job.

" + } + }, + "com.amazonaws.drs#JobLogEvent": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "JOB_START", + "value": "JOB_START" + }, + { + "name": "SERVER_SKIPPED", + "value": "SERVER_SKIPPED" + }, + { + "name": "CLEANUP_START", + "value": "CLEANUP_START" + }, + { + "name": "CLEANUP_END", + "value": "CLEANUP_END" + }, + { + "name": "CLEANUP_FAIL", + "value": "CLEANUP_FAIL" + }, + { + "name": "SNAPSHOT_START", + "value": "SNAPSHOT_START" + }, + { + "name": "SNAPSHOT_END", + "value": "SNAPSHOT_END" + }, + { + "name": "SNAPSHOT_FAIL", + "value": "SNAPSHOT_FAIL" + }, + { + "name": "USING_PREVIOUS_SNAPSHOT", + "value": "USING_PREVIOUS_SNAPSHOT" + }, + { + "name": "USING_PREVIOUS_SNAPSHOT_FAILED", + "value": "USING_PREVIOUS_SNAPSHOT_FAILED" + }, + { + "name": "CONVERSION_START", + "value": "CONVERSION_START" + }, + { + "name": "CONVERSION_END", + "value": "CONVERSION_END" + }, + { + "name": "CONVERSION_FAIL", + "value": "CONVERSION_FAIL" + }, + { + "name": "LAUNCH_START", + "value": "LAUNCH_START" + }, + { + "name": "LAUNCH_FAILED", + "value": "LAUNCH_FAILED" + }, + { + "name": "JOB_CANCEL", + "value": "JOB_CANCEL" + }, + { + "name": "JOB_END", + "value": "JOB_END" + }, + { + "name": "DEPLOY_NETWORK_CONFIGURATION_START", + "value": "DEPLOY_NETWORK_CONFIGURATION_START" + }, + { + "name": "DEPLOY_NETWORK_CONFIGURATION_END", + "value": "DEPLOY_NETWORK_CONFIGURATION_END" + }, + { + "name": "DEPLOY_NETWORK_CONFIGURATION_FAILED", + "value": "DEPLOY_NETWORK_CONFIGURATION_FAILED" + }, + { + "name": "UPDATE_NETWORK_CONFIGURATION_START", + "value": "UPDATE_NETWORK_CONFIGURATION_START" + }, + { + "name": "UPDATE_NETWORK_CONFIGURATION_END", + "value": "UPDATE_NETWORK_CONFIGURATION_END" + }, + { + "name": "UPDATE_NETWORK_CONFIGURATION_FAILED", + "value": "UPDATE_NETWORK_CONFIGURATION_FAILED" + }, + { + "name": "UPDATE_LAUNCH_TEMPLATE_START", + "value": "UPDATE_LAUNCH_TEMPLATE_START" + }, + { + "name": "UPDATE_LAUNCH_TEMPLATE_END", + "value": "UPDATE_LAUNCH_TEMPLATE_END" + }, + { + "name": "UPDATE_LAUNCH_TEMPLATE_FAILED", + "value": "UPDATE_LAUNCH_TEMPLATE_FAILED" + }, + { + "name": "NETWORK_RECOVERY_FAIL", + "value": "NETWORK_RECOVERY_FAIL" + } + ] + } + }, + "com.amazonaws.drs#JobLogEventData": { + "type": "structure", + "members": { + "sourceServerID": { + "target": "com.amazonaws.drs#SourceServerID", + "traits": { + "smithy.api#documentation": "

The ID of a Source Server.

" + } + }, + "conversionServerID": { + "target": "com.amazonaws.drs#EC2InstanceID", + "traits": { + "smithy.api#documentation": "

The ID of a conversion server.

" + } + }, + "targetInstanceID": { + "target": "com.amazonaws.drs#EC2InstanceID", + "traits": { + "smithy.api#documentation": "

The ID of a Recovery Instance.

" + } + }, + "rawError": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "

A string representing a job error.

" + } + }, + "conversionProperties": { + "target": "com.amazonaws.drs#ConversionProperties", + "traits": { + "smithy.api#documentation": "

Properties of a conversion job

" + } + }, + "eventResourceData": { + "target": "com.amazonaws.drs#EventResourceData", + "traits": { + "smithy.api#documentation": "

Properties of resource related to a job event.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Metadata associated with a Job log.

" + } + }, + "com.amazonaws.drs#JobLogs": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#JobLog" + } + }, + "com.amazonaws.drs#JobResource": { + "type": "resource", + "identifiers": { + "jobID": { + "target": "com.amazonaws.drs#JobID" + } + }, + "delete": { + "target": "com.amazonaws.drs#DeleteJob" + }, + "list": { + "target": "com.amazonaws.drs#DescribeJobs" + }, + "operations": [ + { + "target": "com.amazonaws.drs#DescribeJobLogItems" + } + ], + "traits": { + "aws.api#arn": { + "template": "job/{jobID}" + }, + "aws.iam#conditionKeys": [ + "aws:ResourceTag" + ], + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.drs#JobStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "STARTED", + "name": "STARTED" + }, + { + "value": "COMPLETED", + "name": "COMPLETED" + } + ] + } + }, + "com.amazonaws.drs#JobType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "LAUNCH", + "name": "LAUNCH" + }, + { + "value": "TERMINATE", + "name": "TERMINATE" + }, + { + "value": "CREATE_CONVERTED_SNAPSHOT", + "name": "CREATE_CONVERTED_SNAPSHOT" + } + ] + } + }, + "com.amazonaws.drs#JobsList": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#Job" + } + }, + "com.amazonaws.drs#LargeBoundedString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 65536 + } + } + }, + "com.amazonaws.drs#LastLaunchResult": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "NOT_STARTED", + "value": "NOT_STARTED" + }, + { + "name": "PENDING", + "value": "PENDING" + }, + { + "name": "SUCCEEDED", + "value": "SUCCEEDED" + }, + { + "name": "FAILED", + "value": "FAILED" + } + ] + } + }, + "com.amazonaws.drs#LastLaunchType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "RECOVERY", + "value": "RECOVERY" + }, + { + "name": "DRILL", + "value": "DRILL" + } + ] + } + }, + "com.amazonaws.drs#LaunchConfiguration": { + "type": "structure", + "members": { + "sourceServerID": { + "target": "com.amazonaws.drs#SourceServerID", + "traits": { + "smithy.api#documentation": "

The ID of the Source Server for this launch configuration.

" + } + }, + "name": { + "target": "com.amazonaws.drs#SmallBoundedString", + "traits": { + "smithy.api#documentation": "

The name of the launch configuration.

" + } + }, + "ec2LaunchTemplateID": { + "target": "com.amazonaws.drs#BoundedString", + "traits": { + "smithy.api#documentation": "

The EC2 launch template ID of this launch configuration.

" + } + }, + "launchDisposition": { + "target": "com.amazonaws.drs#LaunchDisposition", + "traits": { + "smithy.api#documentation": "

The state of the Recovery Instance in EC2 after the recovery operation.

" + } + }, + "targetInstanceTypeRightSizingMethod": { + "target": "com.amazonaws.drs#TargetInstanceTypeRightSizingMethod", + "traits": { + "smithy.api#documentation": "

Whether Elastic Disaster Recovery should try to automatically choose the instance type that best matches the OS, CPU, and RAM of your Source Server.

" + } + }, + "copyPrivateIp": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether we should copy the Private IP of the Source Server to the Recovery Instance.

" + } + }, + "copyTags": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether we want to copy the tags of the Source Server to the EC2 machine of the Recovery Instance.

" + } + }, + "licensing": { + "target": "com.amazonaws.drs#Licensing", + "traits": { + "smithy.api#documentation": "

The licensing configuration to be used for this launch configuration.

" + } + } + } + }, + "com.amazonaws.drs#LaunchConfigurationTemplate": { + "type": "structure", + "members": { + "launchConfigurationTemplateID": { + "target": "com.amazonaws.drs#LaunchConfigurationTemplateID", + "traits": { + "smithy.api#documentation": "

ID of the Launch Configuration Template.

" + } + }, + "arn": { + "target": "com.amazonaws.drs#ARN", + "traits": { + "smithy.api#documentation": "

ARN of the Launch Configuration Template.

" + } + }, + "tags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "

Tags of the Launch Configuration Template.

" + } + }, + "launchDisposition": { + "target": "com.amazonaws.drs#LaunchDisposition", + "traits": { + "smithy.api#documentation": "

Launch disposition.

" + } + }, + "targetInstanceTypeRightSizingMethod": { + "target": "com.amazonaws.drs#TargetInstanceTypeRightSizingMethod", + "traits": { + "smithy.api#documentation": "

Target instance type right-sizing method.

" + } + }, + "copyPrivateIp": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Copy private IP.

" + } + }, + "copyTags": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Copy tags.

" + } + }, + "licensing": { + "target": "com.amazonaws.drs#Licensing", + "traits": { + "smithy.api#documentation": "

Licensing.

" + } + }, + "exportBucketArn": { + "target": "com.amazonaws.drs#ARN", + "traits": { + "smithy.api#documentation": "

S3 bucket ARN to export Source Network templates.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Account level Launch Configuration Template.

" + } + }, + "com.amazonaws.drs#LaunchConfigurationTemplateID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 21, + "max": 21 + }, + "smithy.api#pattern": "^lct-[0-9a-zA-Z]{17}$" + } + }, + "com.amazonaws.drs#LaunchConfigurationTemplateIDs": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#LaunchConfigurationTemplateID" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.drs#LaunchConfigurationTemplateResource": { + "type": "resource", + "identifiers": { + "launchConfigurationTemplateID": { + "target": "com.amazonaws.drs#LaunchConfigurationTemplateID" + } + }, + "create": { + "target": "com.amazonaws.drs#CreateLaunchConfigurationTemplate" + }, + "update": { + "target": "com.amazonaws.drs#UpdateLaunchConfigurationTemplate" + }, + "delete": { + "target": "com.amazonaws.drs#DeleteLaunchConfigurationTemplate" + }, + "list": { + "target": "com.amazonaws.drs#DescribeLaunchConfigurationTemplates" + }, + "traits": { + "aws.api#arn": { + "template": "launch-configuration-template/{launchConfigurationTemplateID}" + } + } + }, + "com.amazonaws.drs#LaunchConfigurationTemplates": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#LaunchConfigurationTemplate" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.drs#LaunchDisposition": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "STOPPED", + "value": "STOPPED" + }, + { + "name": "STARTED", + "value": "STARTED" + } + ] + } + }, + "com.amazonaws.drs#LaunchStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { + "value": "LAUNCHED", + "name": "LAUNCHED" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "TERMINATED", + "name": "TERMINATED" + } + ] + } + }, + "com.amazonaws.drs#Licensing": { + "type": "structure", + "members": { + "osByol": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to enable \"Bring your own license\" or not.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration of a machine's license.

" + } + }, + "com.amazonaws.drs#LifeCycle": { + "type": "structure", + "members": { + "addedToServiceDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "

The date and time of when the Source Server was added to the service.

" + } + }, + "firstByteDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "

The date and time of the first byte that was replicated from the Source Server.

" + } + }, + "elapsedReplicationDuration": { + "target": "com.amazonaws.drs#ISO8601DurationString", + "traits": { + "smithy.api#documentation": "

The amount of time that the Source Server has been replicating for.

" + } + }, + "lastSeenByServiceDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "

The date and time this Source Server was last seen by the service.

" + } + }, + "lastLaunch": { + "target": "com.amazonaws.drs#LifeCycleLastLaunch", + "traits": { + "smithy.api#documentation": "

An object containing information regarding the last launch of the Source Server.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing the Source Server Lifecycle.

" + } + }, + "com.amazonaws.drs#LifeCycleLastLaunch": { + "type": "structure", + "members": { + "initiated": { + "target": "com.amazonaws.drs#LifeCycleLastLaunchInitiated", + "traits": { + "smithy.api#documentation": "

An object containing information regarding the initiation of the last launch of a Source Server.

" + } + }, + "status": { + "target": "com.amazonaws.drs#LaunchStatus", + "traits": { + "smithy.api#documentation": "

Status of Source Server's last launch.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object containing information regarding the last launch of a Source Server.

" + } + }, + "com.amazonaws.drs#LifeCycleLastLaunchInitiated": { + "type": "structure", + "members": { + "apiCallDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "

The date and time the last Source Server launch was initiated.

" + } + }, + "jobID": { + "target": "com.amazonaws.drs#JobID", + "traits": { + "smithy.api#documentation": "

The ID of the Job that was used to last launch the Source Server.

" + } + }, + "type": { + "target": "com.amazonaws.drs#LastLaunchType", + "traits": { + "smithy.api#documentation": "

The Job type that was used to last launch the Source Server.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object containing information regarding the initiation of the last launch of a Source Server.

" + } + }, + "com.amazonaws.drs#ListExtensibleSourceServers": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#ListExtensibleSourceServersRequest" + }, + "output": { + "target": "com.amazonaws.drs#ListExtensibleSourceServersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#AccessDeniedException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of source servers on a staging account that are extensible, which means that:\n a. The source server is not already extended into this Account.\n b. The source server on the Account we’re reading from is not an extension of another source server.\n

", + "smithy.api#http": { + "uri": "/ListExtensibleSourceServers", + "method": "POST", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.drs#ListExtensibleSourceServersRequest": { + "type": "structure", + "members": { + "stagingAccountID": { + "target": "com.amazonaws.drs#AccountID", + "traits": { + "smithy.api#documentation": "

The Id of the staging Account to retrieve extensible source servers from.

", + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.drs#MaxResultsReplicatingSourceServers", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of extensible source servers to retrieve.

" + } + }, + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token of the next extensible source server to retrieve.

" + } + } + } + }, + "com.amazonaws.drs#ListExtensibleSourceServersResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.drs#StagingSourceServersList", + "traits": { + "smithy.api#documentation": "

A list of source servers on a staging Account that are extensible.

" + } + }, + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token of the next extensible source server to retrieve.

" + } + } + } + }, + "com.amazonaws.drs#ListStagingAccounts": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#ListStagingAccountsRequest" + }, + "output": { + "target": "com.amazonaws.drs#ListStagingAccountsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#AccessDeniedException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns an array of staging accounts for existing extended source servers.

", + "smithy.api#http": { + "uri": "/ListStagingAccounts", + "method": "GET", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "accounts" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.drs#ListStagingAccountsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of staging Accounts to retrieve.

", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token of the next staging Account to retrieve.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.drs#ListStagingAccountsResponse": { + "type": "structure", + "members": { + "accounts": { + "target": "com.amazonaws.drs#Accounts", + "traits": { + "smithy.api#documentation": "

An array of staging AWS Accounts.

" + } + }, + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token of the next staging Account to retrieve.

" + } + } + } + }, + "com.amazonaws.drs#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.drs#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#AccessDeniedException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List all tags for your Elastic Disaster Recovery resources.

", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{resourceArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.drs#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.drs#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the resource whose tags should be returned.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.drs#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "

The tags of the requested resource.

" + } + } + } + }, + "com.amazonaws.drs#MaxResultsReplicatingSourceServers": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.drs#MaxResultsType": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.drs#NetworkInterface": { + "type": "structure", + "members": { + "macAddress": { + "target": "com.amazonaws.drs#BoundedString", + "traits": { + "smithy.api#documentation": "

The MAC address of the network interface.

" + } + }, + "ips": { + "target": "com.amazonaws.drs#IPsList", + "traits": { + "smithy.api#documentation": "

Network interface IPs.

" + } + }, + "isPrimary": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether this is the primary network interface.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Network interface.

" + } + }, + "com.amazonaws.drs#NetworkInterfaces": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#NetworkInterface" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + } + } + }, + "com.amazonaws.drs#OS": { + "type": "structure", + "members": { + "fullString": { + "target": "com.amazonaws.drs#BoundedString", + "traits": { + "smithy.api#documentation": "

The long name of the Operating System.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Operating System.

" + } + }, + "com.amazonaws.drs#OriginEnvironment": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "ON_PREMISES", + "value": "ON_PREMISES" + }, + { + "name": "AWS", + "value": "AWS" + } + ] + } + }, + "com.amazonaws.drs#PITPolicy": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#PITPolicyRule" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.drs#PITPolicyRule": { + "type": "structure", + "members": { + "ruleID": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The ID of the rule.

" + } + }, + "units": { + "target": "com.amazonaws.drs#PITPolicyRuleUnits", + "traits": { + "smithy.api#documentation": "

The units used to measure the interval and retentionDuration.

", + "smithy.api#required": {} + } + }, + "interval": { + "target": "com.amazonaws.drs#StrictlyPositiveInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

How often, in the chosen units, a snapshot should be taken.

", + "smithy.api#required": {} + } + }, + "retentionDuration": { + "target": "com.amazonaws.drs#StrictlyPositiveInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The duration to retain a snapshot for, in the chosen units.

", + "smithy.api#required": {} + } + }, + "enabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether this rule is enabled or not.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A rule in the Point in Time (PIT) policy representing when to take snapshots and how long to retain them for.

" + } + }, + "com.amazonaws.drs#PITPolicyRuleUnits": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "MINUTE", + "name": "MINUTE" + }, + { + "value": "HOUR", + "name": "HOUR" + }, + { + "value": "DAY", + "name": "DAY" + } + ] + } + }, + "com.amazonaws.drs#PaginationToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + } + } + }, + "com.amazonaws.drs#ParticipatingResource": { + "type": "structure", + "members": { + "participatingResourceID": { + "target": "com.amazonaws.drs#ParticipatingResourceID", + "traits": { + "smithy.api#documentation": "

The ID of a participating resource.

" + } + }, + "launchStatus": { + "target": "com.amazonaws.drs#LaunchStatus", + "traits": { + "smithy.api#documentation": "

The launch status of a participating resource.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a resource participating in an asynchronous Job.

" + } + }, + "com.amazonaws.drs#ParticipatingResourceID": { + "type": "union", + "members": { + "sourceNetworkID": { + "target": "com.amazonaws.drs#SourceNetworkID", + "traits": { + "smithy.api#documentation": "

Source Network ID.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

ID of a resource participating in an asynchronous Job.

" + } + }, + "com.amazonaws.drs#ParticipatingResources": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#ParticipatingResource" + } + }, + "com.amazonaws.drs#ParticipatingServer": { + "type": "structure", + "members": { + "sourceServerID": { + "target": "com.amazonaws.drs#SourceServerID", + "traits": { + "smithy.api#documentation": "

The Source Server ID of a participating server.

" + } + }, + "recoveryInstanceID": { + "target": "com.amazonaws.drs#RecoveryInstanceID", + "traits": { + "smithy.api#documentation": "

The Recovery Instance ID of a participating server.

" + } + }, + "launchStatus": { + "target": "com.amazonaws.drs#LaunchStatus", + "traits": { + "smithy.api#documentation": "

The launch status of a participating server.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a server participating in an asynchronous Job.

" + } + }, + "com.amazonaws.drs#ParticipatingServers": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#ParticipatingServer" + } + }, + "com.amazonaws.drs#PositiveInteger": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.drs#RecoveryInstance": { + "type": "structure", + "members": { + "ec2InstanceID": { + "target": "com.amazonaws.drs#EC2InstanceID", + "traits": { + "smithy.api#documentation": "

The EC2 instance ID of the Recovery Instance.

" + } + }, + "ec2InstanceState": { + "target": "com.amazonaws.drs#EC2InstanceState", + "traits": { + "smithy.api#documentation": "

The state of the EC2 instance for this Recovery Instance.

" + } + }, + "jobID": { + "target": "com.amazonaws.drs#JobID", + "traits": { + "smithy.api#documentation": "

The ID of the Job that created the Recovery Instance.

" + } + }, + "recoveryInstanceID": { + "target": "com.amazonaws.drs#RecoveryInstanceID", + "traits": { + "smithy.api#documentation": "

The ID of the Recovery Instance.

" + } + }, + "sourceServerID": { + "target": "com.amazonaws.drs#SourceServerID", + "traits": { + "smithy.api#documentation": "

The Source Server ID that this Recovery Instance is associated with.

" + } + }, + "arn": { + "target": "com.amazonaws.drs#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the Recovery Instance.

" + } + }, + "tags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "

An array of tags that are associated with the Recovery Instance.

" + } + }, + "failback": { + "target": "com.amazonaws.drs#RecoveryInstanceFailback", + "traits": { + "smithy.api#documentation": "

An object representing failback related information of the Recovery Instance.

" + } + }, + "dataReplicationInfo": { + "target": "com.amazonaws.drs#RecoveryInstanceDataReplicationInfo", + "traits": { + "smithy.api#documentation": "

The Data Replication Info of the Recovery Instance.

" + } + }, + "recoveryInstanceProperties": { + "target": "com.amazonaws.drs#RecoveryInstanceProperties", + "traits": { + "smithy.api#documentation": "

Properties of the Recovery Instance machine.

" + } + }, + "pointInTimeSnapshotDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "

The date and time of the Point in Time (PIT) snapshot that this Recovery Instance was launched from.

" + } + }, + "isDrill": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether this Recovery Instance was created for a drill or for an actual Recovery event.

" + } + }, + "originEnvironment": { + "target": "com.amazonaws.drs#OriginEnvironment", + "traits": { + "smithy.api#documentation": "

Environment (On Premises / AWS) of the instance that the recovery instance originated from.

" + } + }, + "originAvailabilityZone": { + "target": "com.amazonaws.drs#AwsAvailabilityZone", + "traits": { + "smithy.api#documentation": "

AWS availability zone associated with the recovery instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A Recovery Instance is a replica of a Source Server running on EC2.

" + } + }, + "com.amazonaws.drs#RecoveryInstanceDataReplicationError": { + "type": "structure", + "members": { + "error": { + "target": "com.amazonaws.drs#FailbackReplicationError", + "traits": { + "smithy.api#documentation": "

Error in data replication.

" + } + }, + "rawError": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "

Error in data replication.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Error in data replication.

" + } + }, + "com.amazonaws.drs#RecoveryInstanceDataReplicationInfo": { + "type": "structure", + "members": { + "lagDuration": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "

Data replication lag duration.

" + } + }, + "etaDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "

An estimate of when the data replication will be completed.

" + } + }, + "replicatedDisks": { + "target": "com.amazonaws.drs#RecoveryInstanceDataReplicationInfoReplicatedDisks", + "traits": { + "smithy.api#documentation": "

The disks that should be replicated.

" + } + }, + "dataReplicationState": { + "target": "com.amazonaws.drs#RecoveryInstanceDataReplicationState", + "traits": { + "smithy.api#documentation": "

The state of the data replication.

" + } + }, + "dataReplicationInitiation": { + "target": "com.amazonaws.drs#RecoveryInstanceDataReplicationInitiation", + "traits": { + "smithy.api#documentation": "

Information about whether the data replication has been initiated.

" + } + }, + "dataReplicationError": { + "target": "com.amazonaws.drs#RecoveryInstanceDataReplicationError", + "traits": { + "smithy.api#documentation": "

Information about Data Replication

" + } + }, + "stagingAvailabilityZone": { + "target": "com.amazonaws.drs#AwsAvailabilityZone", + "traits": { + "smithy.api#documentation": "

AWS Availability zone into which data is being replicated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about Data Replication

" + } + }, + "com.amazonaws.drs#RecoveryInstanceDataReplicationInfoReplicatedDisk": { + "type": "structure", + "members": { + "deviceName": { + "target": "com.amazonaws.drs#BoundedString", + "traits": { + "smithy.api#documentation": "

The name of the device.

" + } + }, + "totalStorageBytes": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total amount of data to be replicated in bytes.

" + } + }, + "replicatedStorageBytes": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount of data replicated so far in bytes.

" + } + }, + "rescannedStorageBytes": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount of data to be rescanned in bytes.

" + } + }, + "backloggedStorageBytes": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The size of the replication backlog in bytes.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A disk that should be replicated.

" + } + }, + "com.amazonaws.drs#RecoveryInstanceDataReplicationInfoReplicatedDisks": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#RecoveryInstanceDataReplicationInfoReplicatedDisk" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 60 + } + } + }, + "com.amazonaws.drs#RecoveryInstanceDataReplicationInitiation": { + "type": "structure", + "members": { + "startDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "

The date and time of the current attempt to initiate data replication.

" + } + }, + "steps": { + "target": "com.amazonaws.drs#RecoveryInstanceDataReplicationInitiationSteps", + "traits": { + "smithy.api#documentation": "

The steps of the current attempt to initiate data replication.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Data replication initiation.

" + } + }, + "com.amazonaws.drs#RecoveryInstanceDataReplicationInitiationStep": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.drs#RecoveryInstanceDataReplicationInitiationStepName", + "traits": { + "smithy.api#documentation": "

The name of the step.

" + } + }, + "status": { + "target": "com.amazonaws.drs#RecoveryInstanceDataReplicationInitiationStepStatus", + "traits": { + "smithy.api#documentation": "

The status of the step.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Data replication initiation step.

" + } + }, + "com.amazonaws.drs#RecoveryInstanceDataReplicationInitiationStepName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "LINK_FAILBACK_CLIENT_WITH_RECOVERY_INSTANCE", + "value": "LINK_FAILBACK_CLIENT_WITH_RECOVERY_INSTANCE" + }, + { + "name": "COMPLETE_VOLUME_MAPPING", + "value": "COMPLETE_VOLUME_MAPPING" + }, + { + "name": "ESTABLISH_RECOVERY_INSTANCE_COMMUNICATION", + "value": "ESTABLISH_RECOVERY_INSTANCE_COMMUNICATION" + }, + { + "name": "DOWNLOAD_REPLICATION_SOFTWARE_TO_FAILBACK_CLIENT", + "value": "DOWNLOAD_REPLICATION_SOFTWARE_TO_FAILBACK_CLIENT" + }, + { + "name": "CONFIGURE_REPLICATION_SOFTWARE", + "value": "CONFIGURE_REPLICATION_SOFTWARE" + }, + { + "name": "PAIR_AGENT_WITH_REPLICATION_SOFTWARE", + "value": "PAIR_AGENT_WITH_REPLICATION_SOFTWARE" + }, + { + "name": "ESTABLISH_AGENT_REPLICATOR_SOFTWARE_COMMUNICATION", + "value": "ESTABLISH_AGENT_REPLICATOR_SOFTWARE_COMMUNICATION" + }, + { + "value": "WAIT", + "name": "WAIT" + }, + { + "value": "CREATE_SECURITY_GROUP", + "name": "CREATE_SECURITY_GROUP" + }, + { + "value": "LAUNCH_REPLICATION_SERVER", + "name": "LAUNCH_REPLICATION_SERVER" + }, + { + "value": "BOOT_REPLICATION_SERVER", + "name": "BOOT_REPLICATION_SERVER" + }, + { + "value": "AUTHENTICATE_WITH_SERVICE", + "name": "AUTHENTICATE_WITH_SERVICE" + }, + { + "value": "DOWNLOAD_REPLICATION_SOFTWARE", + "name": "DOWNLOAD_REPLICATION_SOFTWARE" + }, + { + "value": "CREATE_STAGING_DISKS", + "name": "CREATE_STAGING_DISKS" + }, + { + "value": "ATTACH_STAGING_DISKS", + "name": "ATTACH_STAGING_DISKS" + }, + { + "value": "PAIR_REPLICATION_SERVER_WITH_AGENT", + "name": "PAIR_REPLICATION_SERVER_WITH_AGENT" + }, + { + "value": "CONNECT_AGENT_TO_REPLICATION_SERVER", + "name": "CONNECT_AGENT_TO_REPLICATION_SERVER" + }, + { + "value": "START_DATA_TRANSFER", + "name": "START_DATA_TRANSFER" + } + ] + } + }, + "com.amazonaws.drs#RecoveryInstanceDataReplicationInitiationStepStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "NOT_STARTED", + "value": "NOT_STARTED" + }, + { + "name": "IN_PROGRESS", + "value": "IN_PROGRESS" + }, + { + "name": "SUCCEEDED", + "value": "SUCCEEDED" + }, + { + "name": "FAILED", + "value": "FAILED" + }, + { + "name": "SKIPPED", + "value": "SKIPPED" + } + ] + } + }, + "com.amazonaws.drs#RecoveryInstanceDataReplicationInitiationSteps": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#RecoveryInstanceDataReplicationInitiationStep" + } + }, + "com.amazonaws.drs#RecoveryInstanceDataReplicationState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "STOPPED", + "value": "STOPPED" + }, + { + "name": "INITIATING", + "value": "INITIATING" + }, + { + "name": "INITIAL_SYNC", + "value": "INITIAL_SYNC" + }, + { + "name": "BACKLOG", + "value": "BACKLOG" + }, + { + "name": "CREATING_SNAPSHOT", + "value": "CREATING_SNAPSHOT" + }, + { + "name": "CONTINUOUS", + "value": "CONTINUOUS" + }, + { + "name": "PAUSED", + "value": "PAUSED" + }, + { + "name": "RESCAN", + "value": "RESCAN" + }, + { + "name": "STALLED", + "value": "STALLED" + }, + { + "name": "DISCONNECTED", + "value": "DISCONNECTED" + }, + { + "name": "REPLICATION_STATE_NOT_AVAILABLE", + "value": "REPLICATION_STATE_NOT_AVAILABLE" + }, + { + "name": "NOT_STARTED", + "value": "NOT_STARTED" + } + ] + } + }, + "com.amazonaws.drs#RecoveryInstanceDisk": { + "type": "structure", + "members": { + "internalDeviceName": { + "target": "com.amazonaws.drs#BoundedString", + "traits": { + "smithy.api#documentation": "

The internal device name of this disk. This is the name that is visible on the machine itself and not from the EC2 console.

" + } + }, + "bytes": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount of storage on the disk in bytes.

" + } + }, + "ebsVolumeID": { + "target": "com.amazonaws.drs#EbsVolumeID", + "traits": { + "smithy.api#documentation": "

The EBS Volume ID of this disk.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing a block storage device on the Recovery Instance.

" + } + }, + "com.amazonaws.drs#RecoveryInstanceDisks": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#RecoveryInstanceDisk" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + } + } + }, + "com.amazonaws.drs#RecoveryInstanceFailback": { + "type": "structure", + "members": { + "failbackClientID": { + "target": "com.amazonaws.drs#BoundedString", + "traits": { + "smithy.api#documentation": "

The ID of the failback client that this Recovery Instance is associated with.

" + } + }, + "failbackJobID": { + "target": "com.amazonaws.drs#JobID", + "traits": { + "smithy.api#documentation": "

The Job ID of the last failback log for this Recovery Instance.

" + } + }, + "failbackInitiationTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "

The date and time that the failback initiation started.

" + } + }, + "state": { + "target": "com.amazonaws.drs#FailbackState", + "traits": { + "smithy.api#documentation": "

The state of the failback process that this Recovery Instance is in.

" + } + }, + "agentLastSeenByServiceDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "

The date and time the agent on the Recovery Instance was last seen by the service.

" + } + }, + "failbackClientLastSeenByServiceDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "

The date and time that the failback client was last seen by the service.

" + } + }, + "failbackToOriginalServer": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether we are failing back to the original Source Server for this Recovery Instance.

" + } + }, + "firstByteDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "

The date and time of the first byte that was replicated from the Recovery Instance.

" + } + }, + "elapsedReplicationDuration": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "

The amount of time that the Recovery Instance has been replicating for.

" + } + }, + "failbackLaunchType": { + "target": "com.amazonaws.drs#FailbackLaunchType", + "traits": { + "smithy.api#documentation": "

The launch type (Recovery / Drill) of the last launch for the failback replication of this recovery instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing failback related information of the Recovery Instance.

" + } + }, + "com.amazonaws.drs#RecoveryInstanceID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 19 + }, + "smithy.api#pattern": "^i-[0-9a-fA-F]{8,}$" + } + }, + "com.amazonaws.drs#RecoveryInstanceIDs": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#RecoveryInstanceID" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.drs#RecoveryInstanceProperties": { + "type": "structure", + "members": { + "lastUpdatedDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "

The date and time the Recovery Instance properties were last updated on.

" + } + }, + "identificationHints": { + "target": "com.amazonaws.drs#IdentificationHints", + "traits": { + "smithy.api#documentation": "

Hints used to uniquely identify a machine.

" + } + }, + "networkInterfaces": { + "target": "com.amazonaws.drs#NetworkInterfaces", + "traits": { + "smithy.api#documentation": "

An array of network interfaces.

" + } + }, + "disks": { + "target": "com.amazonaws.drs#RecoveryInstanceDisks", + "traits": { + "smithy.api#documentation": "

An array of disks.

" + } + }, + "cpus": { + "target": "com.amazonaws.drs#Cpus", + "traits": { + "smithy.api#documentation": "

An array of CPUs.

" + } + }, + "ramBytes": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount of RAM in bytes.

" + } + }, + "os": { + "target": "com.amazonaws.drs#OS", + "traits": { + "smithy.api#documentation": "

Operating system.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Properties of the Recovery Instance machine.

" + } + }, + "com.amazonaws.drs#RecoveryInstanceResource": { + "type": "resource", + "identifiers": { + "recoveryInstanceID": { + "target": "com.amazonaws.drs#RecoveryInstanceID" + } + }, + "list": { + "target": "com.amazonaws.drs#DescribeRecoveryInstances" + }, + "operations": [ + { + "target": "com.amazonaws.drs#DeleteRecoveryInstance" + }, + { + "target": "com.amazonaws.drs#DisconnectRecoveryInstance" + }, + { + "target": "com.amazonaws.drs#GetFailbackReplicationConfiguration" + }, + { + "target": "com.amazonaws.drs#ReverseReplication" + }, + { + "target": "com.amazonaws.drs#StopFailback" + }, + { + "target": "com.amazonaws.drs#UpdateFailbackReplicationConfiguration" + } + ], + "collectionOperations": [ + { + "target": "com.amazonaws.drs#StartFailbackLaunch" + }, + { + "target": "com.amazonaws.drs#TerminateRecoveryInstances" + } + ], + "traits": { + "aws.api#arn": { + "template": "recovery-instance/{recoveryInstanceID}" + }, + "aws.iam#conditionKeys": [ + "drs:EC2InstanceARN", + "aws:ResourceTag" + ], + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.drs#RecoveryInstancesForTerminationRequest": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#RecoveryInstanceID" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.drs#RecoveryLifeCycle": { + "type": "structure", + "members": { + "apiCallDateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time the last Source Network recovery was initiated.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "jobID": { + "target": "com.amazonaws.drs#JobID", + "traits": { + "smithy.api#documentation": "

The ID of the Job that was used to last recover the Source Network.

" + } + }, + "lastRecoveryResult": { + "target": "com.amazonaws.drs#RecoveryResult", + "traits": { + "smithy.api#documentation": "

The status of the last recovery status of this Source Network.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing the Source Network recovery Lifecycle.

" + } + }, + "com.amazonaws.drs#RecoveryResult": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NOT_STARTED", + "name": "NOT_STARTED" + }, + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { + "value": "SUCCESS", + "name": "SUCCESS" + }, + { + "value": "FAIL", + "name": "FAIL" + }, + { + "value": "PARTIAL_SUCCESS", + "name": "PARTIAL_SUCCESS" + }, + { + "value": "ASSOCIATE_SUCCESS", + "name": "ASSOCIATE_SUCCESS" + }, + { + "value": "ASSOCIATE_FAIL", + "name": "ASSOCIATE_FAIL" + } + ] + } + }, + "com.amazonaws.drs#RecoverySnapshot": { + "type": "structure", + "members": { + "snapshotID": { + "target": "com.amazonaws.drs#RecoverySnapshotID", + "traits": { + "smithy.api#documentation": "

The ID of the Recovery Snapshot.

", + "smithy.api#required": {} + } + }, + "sourceServerID": { + "target": "com.amazonaws.drs#SourceServerID", + "traits": { + "smithy.api#documentation": "

The ID of the Source Server that the snapshot was taken for.

", + "smithy.api#required": {} + } + }, + "expectedTimestamp": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "

The timestamp of when we expect the snapshot to be taken.

", + "smithy.api#required": {} + } + }, + "timestamp": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "

The actual timestamp that the snapshot was taken.

" + } + }, + "ebsSnapshots": { + "target": "com.amazonaws.drs#EbsSnapshotsList", + "traits": { + "smithy.api#documentation": "

A list of EBS snapshots.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A snapshot of a Source Server used during recovery.

" + } + }, + "com.amazonaws.drs#RecoverySnapshotID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 21, + "max": 21 + }, + "smithy.api#pattern": "^pit-[0-9a-zA-Z]{17}$" + } + }, + "com.amazonaws.drs#RecoverySnapshotsList": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#RecoverySnapshot" + } + }, + "com.amazonaws.drs#RecoverySnapshotsOrder": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "ASC", + "value": "ASC" + }, + { + "name": "DESC", + "value": "DESC" + } + ] + } + }, + "com.amazonaws.drs#ReplicationConfiguration": { + "type": "structure", + "members": { + "sourceServerID": { + "target": "com.amazonaws.drs#SourceServerID", + "traits": { + "smithy.api#documentation": "

The ID of the Source Server for this Replication Configuration.

" + } + }, + "name": { + "target": "com.amazonaws.drs#SmallBoundedString", + "traits": { + "smithy.api#documentation": "

The name of the Replication Configuration.

" + } + }, + "stagingAreaSubnetId": { + "target": "com.amazonaws.drs#SubnetID", + "traits": { + "smithy.api#documentation": "

The subnet to be used by the replication staging area.

" + } + }, + "associateDefaultSecurityGroup": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration.

" + } + }, + "replicationServersSecurityGroupsIDs": { + "target": "com.amazonaws.drs#ReplicationServersSecurityGroupsIDs", + "traits": { + "smithy.api#documentation": "

The security group IDs that will be used by the replication server.

" + } + }, + "replicationServerInstanceType": { + "target": "com.amazonaws.drs#EC2InstanceType", + "traits": { + "smithy.api#documentation": "

The instance type to be used for the replication server.

" + } + }, + "useDedicatedReplicationServer": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to use a dedicated Replication Server in the replication staging area.

" + } + }, + "defaultLargeStagingDiskType": { + "target": "com.amazonaws.drs#ReplicationConfigurationDefaultLargeStagingDiskType", + "traits": { + "smithy.api#documentation": "

The Staging Disk EBS volume type to be used during replication.

" + } + }, + "replicatedDisks": { + "target": "com.amazonaws.drs#ReplicationConfigurationReplicatedDisks", + "traits": { + "smithy.api#documentation": "

The configuration of the disks of the Source Server to be replicated.

" + } + }, + "ebsEncryption": { + "target": "com.amazonaws.drs#ReplicationConfigurationEbsEncryption", + "traits": { + "smithy.api#documentation": "

The type of EBS encryption to be used during replication.

" + } + }, + "ebsEncryptionKeyArn": { + "target": "com.amazonaws.drs#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the EBS encryption key to be used during replication.

" + } + }, + "bandwidthThrottling": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.

" + } + }, + "dataPlaneRouting": { + "target": "com.amazonaws.drs#ReplicationConfigurationDataPlaneRouting", + "traits": { + "smithy.api#documentation": "

The data plane routing mechanism that will be used for replication.

" + } + }, + "createPublicIP": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to create a Public IP for the Recovery Instance by default.

" + } + }, + "stagingAreaTags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "

A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.

" + } + }, + "pitPolicy": { + "target": "com.amazonaws.drs#PITPolicy", + "traits": { + "smithy.api#documentation": "

The Point in time (PIT) policy to manage snapshots taken during replication.

" + } + }, + "autoReplicateNewDisks": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to allow the AWS replication agent to automatically replicate newly added disks.

" + } + } + } + }, + "com.amazonaws.drs#ReplicationConfigurationDataPlaneRouting": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PRIVATE_IP", + "name": "PRIVATE_IP" + }, + { + "value": "PUBLIC_IP", + "name": "PUBLIC_IP" + } + ] + } + }, + "com.amazonaws.drs#ReplicationConfigurationDefaultLargeStagingDiskType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "GP2", + "name": "GP2" + }, + { + "value": "GP3", + "name": "GP3" + }, + { + "value": "ST1", + "name": "ST1" + }, + { + "value": "AUTO", + "name": "AUTO" + } + ] + } + }, + "com.amazonaws.drs#ReplicationConfigurationEbsEncryption": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DEFAULT", + "name": "DEFAULT" + }, + { + "value": "CUSTOM", + "name": "CUSTOM" + }, + { + "value": "NONE", + "name": "NONE" + } + ] + } + }, + "com.amazonaws.drs#ReplicationConfigurationReplicatedDisk": { + "type": "structure", + "members": { + "deviceName": { + "target": "com.amazonaws.drs#BoundedString", + "traits": { + "smithy.api#documentation": "

The name of the device.

" + } + }, + "isBootDisk": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to boot from this disk or not.

" + } + }, + "stagingDiskType": { + "target": "com.amazonaws.drs#ReplicationConfigurationReplicatedDiskStagingDiskType", + "traits": { + "smithy.api#documentation": "

The Staging Disk EBS volume type to be used during replication.

" + } + }, + "iops": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The requested number of I/O operations per second (IOPS).

" + } + }, + "throughput": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The throughput to use for the EBS volume in MiB/s. This parameter is valid only for gp3 volumes.

" + } + }, + "optimizedStagingDiskType": { + "target": "com.amazonaws.drs#ReplicationConfigurationReplicatedDiskStagingDiskType", + "traits": { + "smithy.api#documentation": "

The Staging Disk EBS volume type to be used during replication when stagingDiskType is set to Auto. This is a read-only field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a disk of the Source Server to be replicated.

" + } + }, + "com.amazonaws.drs#ReplicationConfigurationReplicatedDiskStagingDiskType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AUTO", + "name": "AUTO" + }, + { + "value": "GP2", + "name": "GP2" + }, + { + "value": "GP3", + "name": "GP3" + }, + { + "value": "IO1", + "name": "IO1" + }, + { + "value": "SC1", + "name": "SC1" + }, + { + "value": "ST1", + "name": "ST1" + }, + { + "value": "STANDARD", + "name": "STANDARD" + } + ] + } + }, + "com.amazonaws.drs#ReplicationConfigurationReplicatedDisks": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#ReplicationConfigurationReplicatedDisk" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 60 + } + } + }, + "com.amazonaws.drs#ReplicationConfigurationTemplate": { + "type": "structure", + "members": { + "replicationConfigurationTemplateID": { + "target": "com.amazonaws.drs#ReplicationConfigurationTemplateID", + "traits": { + "smithy.api#documentation": "

The Replication Configuration Template ID.

", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.drs#ARN", + "traits": { + "smithy.api#documentation": "

The Replication Configuration Template ARN.

" + } + }, + "stagingAreaSubnetId": { + "target": "com.amazonaws.drs#SubnetID", + "traits": { + "smithy.api#documentation": "

The subnet to be used by the replication staging area.

" + } + }, + "associateDefaultSecurityGroup": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.

" + } + }, + "replicationServersSecurityGroupsIDs": { + "target": "com.amazonaws.drs#ReplicationServersSecurityGroupsIDs", + "traits": { + "smithy.api#documentation": "

The security group IDs that will be used by the replication server.

" + } + }, + "replicationServerInstanceType": { + "target": "com.amazonaws.drs#EC2InstanceType", + "traits": { + "smithy.api#documentation": "

The instance type to be used for the replication server.

" + } + }, + "useDedicatedReplicationServer": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to use a dedicated Replication Server in the replication staging area.

" + } + }, + "defaultLargeStagingDiskType": { + "target": "com.amazonaws.drs#ReplicationConfigurationDefaultLargeStagingDiskType", + "traits": { + "smithy.api#documentation": "

The Staging Disk EBS volume type to be used during replication.

" + } + }, + "ebsEncryption": { + "target": "com.amazonaws.drs#ReplicationConfigurationEbsEncryption", + "traits": { + "smithy.api#documentation": "

The type of EBS encryption to be used during replication.

" + } + }, + "ebsEncryptionKeyArn": { + "target": "com.amazonaws.drs#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the EBS encryption key to be used during replication.

" + } + }, + "bandwidthThrottling": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.

" + } + }, + "dataPlaneRouting": { + "target": "com.amazonaws.drs#ReplicationConfigurationDataPlaneRouting", + "traits": { + "smithy.api#documentation": "

The data plane routing mechanism that will be used for replication.

" + } + }, + "createPublicIP": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to create a Public IP for the Recovery Instance by default.

" + } + }, + "stagingAreaTags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "

A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.

" + } + }, + "tags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "

A set of tags to be associated with the Replication Configuration Template resource.

" + } + }, + "pitPolicy": { + "target": "com.amazonaws.drs#PITPolicy", + "traits": { + "smithy.api#documentation": "

The Point in time (PIT) policy to manage snapshots taken during replication.

" + } + }, + "autoReplicateNewDisks": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to allow the AWS replication agent to automatically replicate newly added disks.

" + } + } + } + }, + "com.amazonaws.drs#ReplicationConfigurationTemplateID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 21, + "max": 21 + }, + "smithy.api#pattern": "^rct-[0-9a-zA-Z]{17}$" + } + }, + "com.amazonaws.drs#ReplicationConfigurationTemplateIDs": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#ReplicationConfigurationTemplateID" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.drs#ReplicationConfigurationTemplateResource": { + "type": "resource", + "identifiers": { + "replicationConfigurationTemplateID": { + "target": "com.amazonaws.drs#ReplicationConfigurationTemplateID" + } + }, + "create": { + "target": "com.amazonaws.drs#CreateReplicationConfigurationTemplate" + }, + "update": { + "target": "com.amazonaws.drs#UpdateReplicationConfigurationTemplate" + }, + "delete": { + "target": "com.amazonaws.drs#DeleteReplicationConfigurationTemplate" + }, + "list": { + "target": "com.amazonaws.drs#DescribeReplicationConfigurationTemplates" + }, + "traits": { + "aws.api#arn": { + "template": "replication-configuration-template/{replicationConfigurationTemplateID}" + }, + "aws.iam#conditionKeys": [ + "aws:ResourceTag" + ], + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.drs#ReplicationConfigurationTemplates": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#ReplicationConfigurationTemplate" + } + }, + "com.amazonaws.drs#ReplicationDirection": { + "type": "string", + "traits": { + "smithy.api#documentation": "

Replication direction designates if this is a failover replication, or a failback replication. When a DRS agent is installed on an instance, the replication direction is failover. In cases where a recovery launch was made in the recovery location and a new recovery instance was created, and then a failback replication was initiated from that recovery instance back to the origin location, then the replication direction will be failback.

", + "smithy.api#enum": [ + { + "name": "FAILOVER", + "value": "FAILOVER" + }, + { + "name": "FAILBACK", + "value": "FAILBACK" + } + ] + } + }, + "com.amazonaws.drs#ReplicationServersSecurityGroupsIDs": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#SecurityGroupID" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + } + } + }, + "com.amazonaws.drs#ReplicationStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "STOPPED", + "name": "STOPPED" + }, + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { + "value": "PROTECTED", + "name": "PROTECTED" + }, + { + "value": "ERROR", + "name": "ERROR" + } + ] + } + }, + "com.amazonaws.drs#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.drs#LargeBoundedString" + }, + "code": { + "target": "com.amazonaws.drs#LargeBoundedString" + }, + "resourceId": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "

The ID of the resource.

" + } + }, + "resourceType": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "

The type of the resource.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The resource for this operation was not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.drs#RetryDataReplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#RetryDataReplicationRequest" + }, + "output": { + "target": "com.amazonaws.drs#SourceServer" + }, + "errors": [ + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#deprecated": { + "message": "WARNING: RetryDataReplication is deprecated" + }, + "smithy.api#documentation": "

WARNING: RetryDataReplication is deprecated.\n Causes the data replication initiation sequence to begin immediately upon next Handshake for the specified Source Server ID, regardless of when the previous initiation started. This command will work only if the Source Server is stalled or is in a DISCONNECTED or STOPPED state.\n

", + "smithy.api#http": { + "uri": "/RetryDataReplication", + "method": "POST", + "code": 200 + } + } + }, + "com.amazonaws.drs#RetryDataReplicationRequest": { + "type": "structure", + "members": { + "sourceServerID": { + "target": "com.amazonaws.drs#SourceServerID", + "traits": { + "smithy.api#documentation": "

The ID of the Source Server whose data replication should be retried.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#deprecated": { + "message": "WARNING: RetryDataReplication is deprecated" + } + } + }, + "com.amazonaws.drs#ReverseReplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#ReverseReplicationRequest" + }, + "output": { + "target": "com.amazonaws.drs#ReverseReplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#AccessDeniedException" + }, + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "ec2:DescribeInstances", + "drs:DescribeReplicationConfigurationTemplates", + "drs:DescribeSourceServers" + ], + "smithy.api#documentation": "

Start replication to origin / target region - applies only to protected instances that originated in EC2.\n For recovery instances on target region - starts replication back to origin region.\n For failback instances on origin region - starts replication to target region to re-protect them.\n

", + "smithy.api#http": { + "uri": "/ReverseReplication", + "method": "POST", + "code": 200 + } + } + }, + "com.amazonaws.drs#ReverseReplicationRequest": { + "type": "structure", + "members": { + "recoveryInstanceID": { + "target": "com.amazonaws.drs#RecoveryInstanceID", + "traits": { + "smithy.api#documentation": "

The ID of the Recovery Instance that we want to reverse the replication for.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.drs#ReverseReplicationResponse": { + "type": "structure", + "members": { + "reversedDirectionSourceServerArn": { + "target": "com.amazonaws.drs#SourceServerARN", + "traits": { + "smithy.api#documentation": "

ARN of created SourceServer.

" + } + } + } + }, + "com.amazonaws.drs#SecurityGroupID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^sg-[0-9a-fA-F]{8,}$" + } + }, + "com.amazonaws.drs#SensitiveBoundedString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.drs#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.drs#LargeBoundedString" + }, + "code": { + "target": "com.amazonaws.drs#LargeBoundedString" + }, + "resourceId": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "

The ID of the resource.

" + } + }, + "resourceType": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "

The type of the resource.

" + } + }, + "serviceCode": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "

Service code.

" + } + }, + "quotaCode": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "

Quota code.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The request could not be completed because its exceeded the service quota.

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.drs#SmallBoundedString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + } + } + }, + "com.amazonaws.drs#SourceCloudProperties": { + "type": "structure", + "members": { + "originAccountID": { + "target": "com.amazonaws.drs#AccountID", + "traits": { + "smithy.api#documentation": "

AWS Account ID for an EC2-originated Source Server.

" + } + }, + "originRegion": { + "target": "com.amazonaws.drs#AwsRegion", + "traits": { + "smithy.api#documentation": "

AWS Region for an EC2-originated Source Server.

" + } + }, + "originAvailabilityZone": { + "target": "com.amazonaws.drs#AwsAvailabilityZone", + "traits": { + "smithy.api#documentation": "

AWS Availability Zone for an EC2-originated Source Server.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Properties of the cloud environment where this Source Server originated from.

" + } + }, + "com.amazonaws.drs#SourceNetwork": { + "type": "structure", + "members": { + "sourceNetworkID": { + "target": "com.amazonaws.drs#SourceNetworkID", + "traits": { + "smithy.api#documentation": "

Source Network ID.

" + } + }, + "sourceVpcID": { + "target": "com.amazonaws.drs#VpcID", + "traits": { + "smithy.api#documentation": "

VPC ID protected by the Source Network.

" + } + }, + "arn": { + "target": "com.amazonaws.drs#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the Source Network.

" + } + }, + "tags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "

A list of tags associated with the Source Network.

" + } + }, + "replicationStatus": { + "target": "com.amazonaws.drs#ReplicationStatus", + "traits": { + "smithy.api#documentation": "

Status of Source Network Replication. Possible values:\n (a) STOPPED - Source Network is not replicating.\n (b) IN_PROGRESS - Source Network is being replicated.\n (c) PROTECTED - Source Network was replicated successfully and is being synchronized for changes.\n (d) ERROR - Source Network replication has failed

" + } + }, + "replicationStatusDetails": { + "target": "com.amazonaws.drs#SensitiveBoundedString", + "traits": { + "smithy.api#documentation": "

Error details in case Source Network replication status is ERROR.

" + } + }, + "cfnStackName": { + "target": "com.amazonaws.drs#CfnStackName", + "traits": { + "smithy.api#documentation": "

CloudFormation stack name that was deployed for recovering the Source Network.

" + } + }, + "sourceRegion": { + "target": "com.amazonaws.drs#AwsRegion", + "traits": { + "smithy.api#documentation": "

Region containing the VPC protected by the Source Network.

" + } + }, + "sourceAccountID": { + "target": "com.amazonaws.drs#AccountID", + "traits": { + "smithy.api#documentation": "

Account ID containing the VPC protected by the Source Network.

" + } + }, + "lastRecovery": { + "target": "com.amazonaws.drs#RecoveryLifeCycle", + "traits": { + "smithy.api#documentation": "

An object containing information regarding the last recovery of the Source Network.

" + } + }, + "launchedVpcID": { + "target": "com.amazonaws.drs#VpcID", + "traits": { + "smithy.api#documentation": "

ID of the recovered VPC following Source Network recovery.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The ARN of the Source Network.

", + "smithy.api#references": [ + { + "resource": "com.amazonaws.drs#SourceNetworkResource" + } + ] + } + }, + "com.amazonaws.drs#SourceNetworkData": { + "type": "structure", + "members": { + "sourceNetworkID": { + "target": "com.amazonaws.drs#SourceNetworkID", + "traits": { + "smithy.api#documentation": "

Source Network ID.

" + } + }, + "sourceVpc": { + "target": "com.amazonaws.drs#VpcID", + "traits": { + "smithy.api#documentation": "

VPC ID protected by the Source Network.

" + } + }, + "targetVpc": { + "target": "com.amazonaws.drs#VpcID", + "traits": { + "smithy.api#documentation": "

ID of the recovered VPC following Source Network recovery.

" + } + }, + "stackName": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "

CloudFormation stack name that was deployed for recovering the Source Network.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Properties of Source Network related to a job event.

" + } + }, + "com.amazonaws.drs#SourceNetworkID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 20 + }, + "smithy.api#pattern": "^sn-[0-9a-zA-Z]{17}$" + } + }, + "com.amazonaws.drs#SourceNetworkResource": { + "type": "resource", + "identifiers": { + "sourceNetworkID": { + "target": "com.amazonaws.drs#SourceNetworkID" + } + }, + "create": { + "target": "com.amazonaws.drs#CreateSourceNetwork" + }, + "delete": { + "target": "com.amazonaws.drs#DeleteSourceNetwork" + }, + "list": { + "target": "com.amazonaws.drs#DescribeSourceNetworks" + }, + "operations": [ + { + "target": "com.amazonaws.drs#AssociateSourceNetworkStack" + }, + { + "target": "com.amazonaws.drs#ExportSourceNetworkCfnTemplate" + }, + { + "target": "com.amazonaws.drs#StartSourceNetworkReplication" + }, + { + "target": "com.amazonaws.drs#StopSourceNetworkReplication" + } + ], + "collectionOperations": [ + { + "target": "com.amazonaws.drs#StartSourceNetworkRecovery" + } + ], + "traits": { + "aws.api#arn": { + "template": "source-network/{sourceNetworkID}" + }, + "aws.iam#conditionKeys": [ + "aws:ResourceTag" + ], + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.drs#SourceNetworksList": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#SourceNetwork" + } + }, + "com.amazonaws.drs#SourceProperties": { + "type": "structure", + "members": { + "lastUpdatedDateTime": { + "target": "com.amazonaws.drs#ISO8601DatetimeString", + "traits": { + "smithy.api#documentation": "

The date and time the Source Properties were last updated on.

" + } + }, + "recommendedInstanceType": { + "target": "com.amazonaws.drs#EC2InstanceType", + "traits": { + "smithy.api#documentation": "

The recommended EC2 instance type that will be used when recovering the Source Server.

" + } + }, + "identificationHints": { + "target": "com.amazonaws.drs#IdentificationHints", + "traits": { + "smithy.api#documentation": "

Hints used to uniquely identify a machine.

" + } + }, + "networkInterfaces": { + "target": "com.amazonaws.drs#NetworkInterfaces", + "traits": { + "smithy.api#documentation": "

An array of network interfaces.

" + } + }, + "disks": { + "target": "com.amazonaws.drs#Disks", + "traits": { + "smithy.api#documentation": "

An array of disks.

" + } + }, + "cpus": { + "target": "com.amazonaws.drs#Cpus", + "traits": { + "smithy.api#documentation": "

An array of CPUs.

" + } + }, + "ramBytes": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount of RAM in bytes.

" + } + }, + "os": { + "target": "com.amazonaws.drs#OS", + "traits": { + "smithy.api#documentation": "

Operating system.

" + } + }, + "supportsNitroInstances": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Are EC2 nitro instance types supported when recovering the Source Server.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Properties of the Source Server machine.

" + } + }, + "com.amazonaws.drs#SourceServer": { + "type": "structure", + "members": { + "sourceServerID": { + "target": "com.amazonaws.drs#SourceServerID", + "traits": { + "smithy.api#documentation": "

The ID of the Source Server.

" + } + }, + "arn": { + "target": "com.amazonaws.drs#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the Source Server.

" + } + }, + "tags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "

The tags associated with the Source Server.

" + } + }, + "recoveryInstanceId": { + "target": "com.amazonaws.drs#RecoveryInstanceID", + "traits": { + "smithy.api#documentation": "

The ID of the Recovery Instance associated with this Source Server.

" + } + }, + "lastLaunchResult": { + "target": "com.amazonaws.drs#LastLaunchResult", + "traits": { + "smithy.api#documentation": "

The status of the last recovery launch of this Source Server.

" + } + }, + "dataReplicationInfo": { + "target": "com.amazonaws.drs#DataReplicationInfo", + "traits": { + "smithy.api#documentation": "

The Data Replication Info of the Source Server.

" + } + }, + "lifeCycle": { + "target": "com.amazonaws.drs#LifeCycle", + "traits": { + "smithy.api#documentation": "

The lifecycle information of this Source Server.

" + } + }, + "sourceProperties": { + "target": "com.amazonaws.drs#SourceProperties", + "traits": { + "smithy.api#documentation": "

The source properties of the Source Server.

" + } + }, + "stagingArea": { + "target": "com.amazonaws.drs#StagingArea", + "traits": { + "smithy.api#documentation": "

The staging area of the source server.

" + } + }, + "sourceCloudProperties": { + "target": "com.amazonaws.drs#SourceCloudProperties", + "traits": { + "smithy.api#documentation": "

Source cloud properties of the Source Server.

" + } + }, + "replicationDirection": { + "target": "com.amazonaws.drs#ReplicationDirection", + "traits": { + "smithy.api#documentation": "

Replication direction of the Source Server.

" + } + }, + "reversedDirectionSourceServerArn": { + "target": "com.amazonaws.drs#SourceServerARN", + "traits": { + "smithy.api#documentation": "

For EC2-originated Source Servers which have been failed over and then failed back, this value will mean the ARN of the Source Server on the opposite replication direction.

" + } + }, + "sourceNetworkID": { + "target": "com.amazonaws.drs#SourceNetworkID", + "traits": { + "smithy.api#documentation": "

ID of the Source Network which is protecting this Source Server's network.

" + } + } + }, + "traits": { + "smithy.api#references": [ + { + "resource": "com.amazonaws.drs#SourceServerResource" + } + ] + } + }, + "com.amazonaws.drs#SourceServerARN": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(?:[0-9a-zA-Z_-]+:){3}([0-9]{12,}):source-server/(s-[0-9a-zA-Z]{17})$" + } + }, + "com.amazonaws.drs#SourceServerID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 19, + "max": 19 + }, + "smithy.api#pattern": "^s-[0-9a-zA-Z]{17}$" + } + }, + "com.amazonaws.drs#SourceServerIDs": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#SourceServerID" + } + }, + "com.amazonaws.drs#SourceServerResource": { + "type": "resource", + "identifiers": { + "sourceServerID": { + "target": "com.amazonaws.drs#SourceServerID" + } + }, + "delete": { + "target": "com.amazonaws.drs#DeleteSourceServer" + }, + "list": { + "target": "com.amazonaws.drs#DescribeSourceServers" + }, + "operations": [ + { + "target": "com.amazonaws.drs#DescribeRecoverySnapshots" + }, + { + "target": "com.amazonaws.drs#DisconnectSourceServer" + }, + { + "target": "com.amazonaws.drs#GetLaunchConfiguration" + }, + { + "target": "com.amazonaws.drs#GetReplicationConfiguration" + }, + { + "target": "com.amazonaws.drs#RetryDataReplication" + }, + { + "target": "com.amazonaws.drs#StartReplication" + }, + { + "target": "com.amazonaws.drs#StopReplication" + }, + { + "target": "com.amazonaws.drs#UpdateLaunchConfiguration" + }, + { + "target": "com.amazonaws.drs#UpdateReplicationConfiguration" + } + ], + "collectionOperations": [ + { + "target": "com.amazonaws.drs#StartRecovery" + } + ], + "traits": { + "aws.api#arn": { + "template": "source-server/{sourceServerID}" + }, + "aws.iam#conditionKeys": [ + "aws:ResourceTag" + ], + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.drs#SourceServersList": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#SourceServer" + } + }, + "com.amazonaws.drs#StagingArea": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.drs#ExtensionStatus", + "traits": { + "smithy.api#documentation": "

Status of Source server extension. Possible values:\n (a) NOT_EXTENDED - This is a source server that is replicating in the current account.\n (b) EXTENDED - Source server is extended from a staging source server. In this case, the value of stagingSourceServerArn is pointing to the Arn of the source server in the staging account.\n (c) EXTENSION_ERROR - Some issue occurred when accessing staging source server. In this case, errorMessage field will contain an error message that explains what happened.

" + } + }, + "stagingAccountID": { + "target": "com.amazonaws.drs#AccountID", + "traits": { + "smithy.api#documentation": "

Account ID of the account to which source server belongs. If this source server is extended - shows Account ID of staging source server.

" + } + }, + "stagingSourceServerArn": { + "target": "com.amazonaws.drs#ARN", + "traits": { + "smithy.api#documentation": "

Arn of the staging source server if this source server is extended

" + } + }, + "errorMessage": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "

Shows an error message that occurred when DRS tried to access the staging source server. In this case StagingArea$status will have value EXTENSION_ERROR

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Staging information related to source server.

" + } + }, + "com.amazonaws.drs#StagingSourceServer": { + "type": "structure", + "members": { + "hostname": { + "target": "com.amazonaws.drs#BoundedString", + "traits": { + "smithy.api#documentation": "

Hostname of staging source server.

" + } + }, + "arn": { + "target": "com.amazonaws.drs#SourceServerARN", + "traits": { + "smithy.api#documentation": "

The ARN of the source server.

" + } + }, + "tags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "

A list of tags associated with the staging source server.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Source server in staging account that extended source server connected to.

" + } + }, + "com.amazonaws.drs#StagingSourceServersList": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#StagingSourceServer" + } + }, + "com.amazonaws.drs#StartFailbackLaunch": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#StartFailbackLaunchRequest" + }, + "output": { + "target": "com.amazonaws.drs#StartFailbackLaunchResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Initiates a Job for launching the machine that is being failed back to from the specified Recovery Instance. This will run conversion on the failback client and will reboot your machine, thus completing the failback process.

", + "smithy.api#http": { + "uri": "/StartFailbackLaunch", + "method": "POST", + "code": 200 + } + } + }, + "com.amazonaws.drs#StartFailbackLaunchRequest": { + "type": "structure", + "members": { + "recoveryInstanceIDs": { + "target": "com.amazonaws.drs#StartFailbackRequestRecoveryInstanceIDs", + "traits": { + "smithy.api#documentation": "

The IDs of the Recovery Instance whose failback launch we want to request.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "

The tags to be associated with the failback launch Job.

" + } + } + } + }, + "com.amazonaws.drs#StartFailbackLaunchResponse": { + "type": "structure", + "members": { + "job": { + "target": "com.amazonaws.drs#Job", + "traits": { + "smithy.api#documentation": "

The failback launch Job.

" + } + } + } + }, + "com.amazonaws.drs#StartFailbackRequestRecoveryInstanceIDs": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#RecoveryInstanceID" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.drs#StartRecovery": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#StartRecoveryRequest" + }, + "output": { + "target": "com.amazonaws.drs#StartRecoveryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "ec2:DetachVolume", + "ec2:DescribeInstances", + "ec2:TerminateInstances", + "ec2:CreateTags", + "ec2:DescribeLaunchTemplateVersions", + "ec2:RunInstances", + "ec2:DescribeSnapshots", + "ec2:StopInstances", + "ec2:CreateLaunchTemplateVersion", + "ec2:DeleteVolume", + "ec2:StartInstances", + "ec2:DescribeVolumes", + "ec2:DeleteLaunchTemplateVersions", + "ec2:AttachVolume", + "ec2:AuthorizeSecurityGroupEgress", + "ec2:AuthorizeSecurityGroupIngress", + "ec2:CreateLaunchTemplate", + "ec2:CreateSnapshot", + "ec2:CreateVolume", + "ec2:DeleteSnapshot", + "ec2:DescribeImages", + "ec2:DescribeInstanceAttribute", + "ec2:DescribeInstanceStatus", + "ec2:DescribeLaunchTemplates", + "ec2:DescribeSecurityGroups", + "ec2:DescribeSubnets", + "ec2:ModifyInstanceAttribute", + "ec2:ModifyLaunchTemplate", + "ec2:RevokeSecurityGroupEgress", + "ec2:DescribeAccountAttributes", + "ec2:DescribeAvailabilityZones", + "ec2:DescribeInstanceTypes", + "iam:PassRole", + "drs:CreateRecoveryInstanceForDrs", + "drs:ListTagsForResource" + ], + "smithy.api#documentation": "

Launches Recovery Instances for the specified Source Servers. For each Source Server you may choose a point in time snapshot to launch from, or use an on demand snapshot.

", + "smithy.api#http": { + "uri": "/StartRecovery", + "method": "POST", + "code": 202 + } + } + }, + "com.amazonaws.drs#StartRecoveryRequest": { + "type": "structure", + "members": { + "sourceServers": { + "target": "com.amazonaws.drs#StartRecoveryRequestSourceServers", + "traits": { + "smithy.api#documentation": "

The Source Servers that we want to start a Recovery Job for.

", + "smithy.api#required": {} + } + }, + "isDrill": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether this Source Server Recovery operation is a drill or not.

" + } + }, + "tags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "

The tags to be associated with the Recovery Job.

" + } + } + } + }, + "com.amazonaws.drs#StartRecoveryRequestSourceServer": { + "type": "structure", + "members": { + "sourceServerID": { + "target": "com.amazonaws.drs#SourceServerID", + "traits": { + "smithy.api#documentation": "

The ID of the Source Server you want to recover.

", + "smithy.api#required": {} + } + }, + "recoverySnapshotID": { + "target": "com.amazonaws.drs#RecoverySnapshotID", + "traits": { + "smithy.api#documentation": "

The ID of a Recovery Snapshot we want to recover from. Omit this field to launch from the latest data by taking an on-demand snapshot.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing the Source Server to recover.

" + } + }, + "com.amazonaws.drs#StartRecoveryRequestSourceServers": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#StartRecoveryRequestSourceServer" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.drs#StartRecoveryResponse": { + "type": "structure", + "members": { + "job": { + "target": "com.amazonaws.drs#Job", + "traits": { + "smithy.api#documentation": "

The Recovery Job.

" + } + } + } + }, + "com.amazonaws.drs#StartReplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#StartReplicationRequest" + }, + "output": { + "target": "com.amazonaws.drs#StartReplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts replication for a stopped Source Server. This action would make the Source Server protected again and restart billing for it.

", + "smithy.api#http": { + "uri": "/StartReplication", + "method": "POST", + "code": 200 + } + } + }, + "com.amazonaws.drs#StartReplicationRequest": { + "type": "structure", + "members": { + "sourceServerID": { + "target": "com.amazonaws.drs#SourceServerID", + "traits": { + "smithy.api#documentation": "

The ID of the Source Server to start replication for.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.drs#StartReplicationResponse": { + "type": "structure", + "members": { + "sourceServer": { + "target": "com.amazonaws.drs#SourceServer", + "traits": { + "smithy.api#documentation": "

The Source Server that this action was targeted on.

" + } + } + } + }, + "com.amazonaws.drs#StartSourceNetworkRecovery": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#StartSourceNetworkRecoveryRequest" + }, + "output": { + "target": "com.amazonaws.drs#StartSourceNetworkRecoveryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "ec2:DescribeSubnets", + "ec2:DescribeSecurityGroups", + "ec2:DescribeLaunchTemplates", + "ec2:DescribeLaunchTemplateVersions", + "ec2:ModifyLaunchTemplate", + "ec2:CreateLaunchTemplateVersion", + "ec2:DescribeVpcs", + "ec2:DescribeSubnets", + "ec2:DescribeSecurityGroups", + "ec2:DescribeLaunchTemplates", + "ec2:DescribeLaunchTemplateVersions", + "cloudformation:DescribeStacks", + "cloudformation:UpdateStack", + "cloudformation:CreateStack", + "cloudformation:DescribeStackResource", + "cloudformation:DescribeStacks", + "drs:GetLaunchConfiguration", + "s3:PutObject", + "s3:GetObject" + ], + "smithy.api#documentation": "

Deploy VPC for the specified Source Network and modify launch templates to use this network. The VPC will be deployed using a dedicated CloudFormation stack.

", + "smithy.api#http": { + "uri": "/StartSourceNetworkRecovery", + "method": "POST", + "code": 202 + } + } + }, + "com.amazonaws.drs#StartSourceNetworkRecoveryRequest": { + "type": "structure", + "members": { + "sourceNetworks": { + "target": "com.amazonaws.drs#StartSourceNetworkRecoveryRequestNetworkEntries", + "traits": { + "smithy.api#documentation": "

The Source Networks that we want to start a Recovery Job for.

", + "smithy.api#required": {} + } + }, + "deployAsNew": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Don't update existing CloudFormation Stack, recover the network using a new stack.

" + } + }, + "tags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "

The tags to be associated with the Source Network recovery Job.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.drs#StartSourceNetworkRecoveryRequestNetworkEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#StartSourceNetworkRecoveryRequestNetworkEntry" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.drs#StartSourceNetworkRecoveryRequestNetworkEntry": { + "type": "structure", + "members": { + "sourceNetworkID": { + "target": "com.amazonaws.drs#SourceNetworkID", + "traits": { + "smithy.api#documentation": "

The ID of the Source Network you want to recover.

", + "smithy.api#required": {} + } + }, + "cfnStackName": { + "target": "com.amazonaws.drs#CfnStackName", + "traits": { + "smithy.api#documentation": "

CloudFormation stack name to be used for recovering the network.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing the Source Network to recover.

" + } + }, + "com.amazonaws.drs#StartSourceNetworkRecoveryResponse": { + "type": "structure", + "members": { + "job": { + "target": "com.amazonaws.drs#Job", + "traits": { + "smithy.api#documentation": "

The Source Network recovery Job.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.drs#StartSourceNetworkReplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#StartSourceNetworkReplicationRequest" + }, + "output": { + "target": "com.amazonaws.drs#StartSourceNetworkReplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts replication for a Source Network. This action would make the Source Network protected.

", + "smithy.api#http": { + "uri": "/StartSourceNetworkReplication", + "method": "POST", + "code": 200 + } + } + }, + "com.amazonaws.drs#StartSourceNetworkReplicationRequest": { + "type": "structure", + "members": { + "sourceNetworkID": { + "target": "com.amazonaws.drs#SourceNetworkID", + "traits": { + "smithy.api#documentation": "

ID of the Source Network to replicate.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.drs#StartSourceNetworkReplicationResponse": { + "type": "structure", + "members": { + "sourceNetwork": { + "target": "com.amazonaws.drs#SourceNetwork", + "traits": { + "smithy.api#documentation": "

Source Network which was requested for replication.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.drs#StopFailback": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#StopFailbackRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops the failback process for a specified Recovery Instance. This changes the Failback State of the Recovery Instance back to FAILBACK_NOT_STARTED.

", + "smithy.api#http": { + "uri": "/StopFailback", + "method": "POST", + "code": 200 + } + } + }, + "com.amazonaws.drs#StopFailbackRequest": { + "type": "structure", + "members": { + "recoveryInstanceID": { + "target": "com.amazonaws.drs#RecoveryInstanceID", + "traits": { + "smithy.api#documentation": "

The ID of the Recovery Instance we want to stop failback for.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.drs#StopReplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#StopReplicationRequest" + }, + "output": { + "target": "com.amazonaws.drs#StopReplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops replication for a Source Server. This action would make the Source Server unprotected, delete its existing snapshots and stop billing for it.

", + "smithy.api#http": { + "uri": "/StopReplication", + "method": "POST", + "code": 200 + } + } + }, + "com.amazonaws.drs#StopReplicationRequest": { + "type": "structure", + "members": { + "sourceServerID": { + "target": "com.amazonaws.drs#SourceServerID", + "traits": { + "smithy.api#documentation": "

The ID of the Source Server to stop replication for.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.drs#StopReplicationResponse": { + "type": "structure", + "members": { + "sourceServer": { + "target": "com.amazonaws.drs#SourceServer", + "traits": { + "smithy.api#documentation": "

The Source Server that this action was targeted on.

" + } + } + } + }, + "com.amazonaws.drs#StopSourceNetworkReplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#StopSourceNetworkReplicationRequest" + }, + "output": { + "target": "com.amazonaws.drs#StopSourceNetworkReplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops replication for a Source Network. This action would make the Source Network unprotected.

", + "smithy.api#http": { + "uri": "/StopSourceNetworkReplication", + "method": "POST", + "code": 200 + } + } + }, + "com.amazonaws.drs#StopSourceNetworkReplicationRequest": { + "type": "structure", + "members": { + "sourceNetworkID": { + "target": "com.amazonaws.drs#SourceNetworkID", + "traits": { + "smithy.api#documentation": "

ID of the Source Network to stop replication.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.drs#StopSourceNetworkReplicationResponse": { + "type": "structure", + "members": { + "sourceNetwork": { + "target": "com.amazonaws.drs#SourceNetwork", + "traits": { + "smithy.api#documentation": "

Source Network which was requested to stop replication.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.drs#StrictlyPositiveInteger": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.drs#SubnetID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^subnet-[0-9a-fA-F]{8,}$" + } + }, + "com.amazonaws.drs#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.drs#TagKeys": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#TagKey" + }, + "traits": { + "smithy.api#sensitive": {} + } }, - { - "target": "com.amazonaws.drs#JobResource" + "com.amazonaws.drs#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#TagResourceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.drs#AccessDeniedException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds or overwrites only the specified tags for the specified Elastic Disaster Recovery resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value.

", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{resourceArn}" + }, + "smithy.api#idempotent": {} + } }, - { - "target": "com.amazonaws.drs#LaunchConfigurationTemplateResource" + "com.amazonaws.drs#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.drs#ARN", + "traits": { + "smithy.api#documentation": "

ARN of the resource for which tags are to be added or updated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "

Array of tags to be added or updated.

", + "smithy.api#required": {} + } + } + } }, - { - "target": "com.amazonaws.drs#RecoveryInstanceResource" + "com.amazonaws.drs#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } }, - { - "target": "com.amazonaws.drs#ReplicationConfigurationTemplateResource" + "com.amazonaws.drs#TagsMap": { + "type": "map", + "key": { + "target": "com.amazonaws.drs#TagKey" + }, + "value": { + "target": "com.amazonaws.drs#TagValue" + }, + "traits": { + "smithy.api#sensitive": {} + } }, - { - "target": "com.amazonaws.drs#SourceServerResource" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "drs", - "arnNamespace": "drs", - "awsProductName": "drs", - "cloudTrailEventSource": "drs.amazonaws.com" - }, - "aws.auth#sigv4": { - "name": "drs" - }, - "aws.iam#defineConditionKeys": { - "drs:EC2InstanceARN": { - "type": "String", - "documentation": "Filters access by the EC2 instance the request originated from" - } - }, - "aws.protocols#restJson1": {}, - "smithy.api#cors": { - "additionalAllowedHeaders": ["Content-Type", "X-Amz-Content-Sha256", "X-Amz-User-Agent", "X-Amzn-Trace-Id"], - "additionalExposedHeaders": ["X-Amzn-Errortype", "X-Amzn-Requestid", "X-Amzn-Trace-Id", "X-Amz-Apigw-Id"] - }, - "smithy.api#documentation": "

AWS Elastic Disaster Recovery Service.

", - "smithy.api#title": "Elastic Disaster Recovery Service", - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "type": "tree", - "rules": [ + "com.amazonaws.drs#TargetInstanceTypeRightSizingMethod": { + "type": "string", + "traits": { + "smithy.api#enum": [ { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" + "name": "NONE", + "value": "NONE" }, { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "name": "BASIC", + "value": "BASIC" + } + ] + } + }, + "com.amazonaws.drs#TerminateRecoveryInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#TerminateRecoveryInstancesRequest" + }, + "output": { + "target": "com.amazonaws.drs#TerminateRecoveryInstancesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "ec2:DescribeVolumes", + "ec2:DescribeInstances", + "ec2:TerminateInstances", + "ec2:DeleteVolume", + "drs:DescribeSourceServers" + ], + "smithy.api#documentation": "

Initiates a Job for terminating the EC2 resources associated with the specified Recovery Instances, and then will delete the Recovery Instances from the Elastic Disaster Recovery service.

", + "smithy.api#http": { + "uri": "/TerminateRecoveryInstances", + "method": "POST", + "code": 200 + } + } + }, + "com.amazonaws.drs#TerminateRecoveryInstancesRequest": { + "type": "structure", + "members": { + "recoveryInstanceIDs": { + "target": "com.amazonaws.drs#RecoveryInstancesForTerminationRequest", + "traits": { + "smithy.api#documentation": "

The IDs of the Recovery Instances that should be terminated.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.drs#TerminateRecoveryInstancesResponse": { + "type": "structure", + "members": { + "job": { + "target": "com.amazonaws.drs#Job", + "traits": { + "smithy.api#documentation": "

The Job for terminating the Recovery Instances.

" + } + } + } + }, + "com.amazonaws.drs#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#required": {} + } + }, + "serviceCode": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "

Service code.

" + } + }, + "quotaCode": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "

Quota code.

" } - ] + }, + "retryAfterSeconds": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "

The number of seconds after which the request should be safe to retry.

", + "smithy.api#httpHeader": "Retry-After" + } + } + }, + "traits": { + "smithy.api#documentation": "

The request was denied due to request throttling.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.drs#UninitializedAccountException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.drs#LargeBoundedString" + }, + "code": { + "target": "com.amazonaws.drs#LargeBoundedString" } - ] }, - { - "conditions": [], - "type": "tree", - "rules": [ + "traits": { + "smithy.api#documentation": "

The account performing the request has not been initialized.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.drs#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#UntagResourceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] + "target": "com.amazonaws.drs#AccessDeniedException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified set of tags from the specified set of Elastic Disaster Recovery resources.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{resourceArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.drs#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.drs#ARN", + "traits": { + "smithy.api#documentation": "

ARN of the resource for which tags are to be removed.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://drs-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://drs-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://drs.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ] - }, - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://drs.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - } - ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://drs.af-south-1.amazonaws.com" - } - }, - "params": { - "Region": "af-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://drs.ap-east-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://drs.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://drs.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://drs.ap-northeast-3.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://drs.ap-south-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://drs.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://drs.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://drs.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://drs.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://drs.eu-north-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://drs.eu-south-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://drs.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://drs.eu-west-2.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://drs.eu-west-3.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://drs.me-south-1.amazonaws.com" - } - }, - "params": { - "Region": "me-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://drs.sa-east-1.amazonaws.com" - } - }, - "params": { - "Region": "sa-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://drs.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://drs.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://drs.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://drs.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://drs-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://drs-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://drs.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://drs-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://drs-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://drs.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://drs.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://drs-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://drs-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://drs.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://drs.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://drs-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://drs.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://drs-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://drs.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.drs#ExtensionStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "EXTENDED", - "value": "EXTENDED" - }, - { - "name": "EXTENSION_ERROR", - "value": "EXTENSION_ERROR" - }, - { - "name": "NOT_EXTENDED", - "value": "NOT_EXTENDED" - } - ] - } - }, - "com.amazonaws.drs#FailbackLaunchType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "RECOVERY", - "value": "RECOVERY" - }, - { - "name": "DRILL", - "value": "DRILL" - } - ] - } - }, - "com.amazonaws.drs#FailbackReplicationError": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "AGENT_NOT_SEEN", - "value": "AGENT_NOT_SEEN" - }, - { - "name": "FAILBACK_CLIENT_NOT_SEEN", - "value": "FAILBACK_CLIENT_NOT_SEEN" - }, - { - "name": "NOT_CONVERGING", - "value": "NOT_CONVERGING" - }, - { - "name": "UNSTABLE_NETWORK", - "value": "UNSTABLE_NETWORK" - }, - { - "name": "FAILED_TO_ESTABLISH_RECOVERY_INSTANCE_COMMUNICATION", - "value": "FAILED_TO_ESTABLISH_RECOVERY_INSTANCE_COMMUNICATION" - }, - { - "name": "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE_TO_FAILBACK_CLIENT", - "value": "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE_TO_FAILBACK_CLIENT" - }, - { - "name": "FAILED_TO_CONFIGURE_REPLICATION_SOFTWARE", - "value": "FAILED_TO_CONFIGURE_REPLICATION_SOFTWARE" - }, - { - "name": "FAILED_TO_PAIR_AGENT_WITH_REPLICATION_SOFTWARE", - "value": "FAILED_TO_PAIR_AGENT_WITH_REPLICATION_SOFTWARE" - }, - { - "name": "FAILED_TO_ESTABLISH_AGENT_REPLICATOR_SOFTWARE_COMMUNICATION", - "value": "FAILED_TO_ESTABLISH_AGENT_REPLICATOR_SOFTWARE_COMMUNICATION" - }, - { - "name": "FAILED_GETTING_REPLICATION_STATE", - "value": "FAILED_GETTING_REPLICATION_STATE" - }, - { - "name": "SNAPSHOTS_FAILURE", - "value": "SNAPSHOTS_FAILURE" - }, - { - "name": "FAILED_TO_CREATE_SECURITY_GROUP", - "value": "FAILED_TO_CREATE_SECURITY_GROUP" - }, - { - "name": "FAILED_TO_LAUNCH_REPLICATION_SERVER", - "value": "FAILED_TO_LAUNCH_REPLICATION_SERVER" - }, - { - "name": "FAILED_TO_BOOT_REPLICATION_SERVER", - "value": "FAILED_TO_BOOT_REPLICATION_SERVER" - }, - { - "name": "FAILED_TO_AUTHENTICATE_WITH_SERVICE", - "value": "FAILED_TO_AUTHENTICATE_WITH_SERVICE" - }, - { - "name": "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE", - "value": "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE" - }, - { - "name": "FAILED_TO_CREATE_STAGING_DISKS", - "value": "FAILED_TO_CREATE_STAGING_DISKS" - }, - { - "name": "FAILED_TO_ATTACH_STAGING_DISKS", - "value": "FAILED_TO_ATTACH_STAGING_DISKS" - }, - { - "name": "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT", - "value": "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT" - }, - { - "name": "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER", - "value": "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER" - }, - { - "name": "FAILED_TO_START_DATA_TRANSFER", - "value": "FAILED_TO_START_DATA_TRANSFER" - } - ] - } - }, - "com.amazonaws.drs#FailbackState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "FAILBACK_NOT_STARTED", - "value": "FAILBACK_NOT_STARTED" - }, - { - "name": "FAILBACK_IN_PROGRESS", - "value": "FAILBACK_IN_PROGRESS" - }, - { - "name": "FAILBACK_READY_FOR_LAUNCH", - "value": "FAILBACK_READY_FOR_LAUNCH" - }, - { - "name": "FAILBACK_COMPLETED", - "value": "FAILBACK_COMPLETED" - }, - { - "name": "FAILBACK_ERROR", - "value": "FAILBACK_ERROR" - }, - { - "name": "FAILBACK_NOT_READY_FOR_LAUNCH", - "value": "FAILBACK_NOT_READY_FOR_LAUNCH" - }, - { - "name": "FAILBACK_LAUNCH_STATE_NOT_AVAILABLE", - "value": "FAILBACK_LAUNCH_STATE_NOT_AVAILABLE" - } - ] - } - }, - "com.amazonaws.drs#GetFailbackReplicationConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#GetFailbackReplicationConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.drs#GetFailbackReplicationConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#UninitializedAccountException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all Failback ReplicationConfigurations, filtered by Recovery Instance ID.

", - "smithy.api#http": { - "uri": "/GetFailbackReplicationConfiguration", - "method": "POST", - "code": 200 - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.drs#GetFailbackReplicationConfigurationRequest": { - "type": "structure", - "members": { - "recoveryInstanceID": { - "target": "com.amazonaws.drs#RecoveryInstanceID", - "traits": { - "smithy.api#documentation": "

The ID of the Recovery Instance whose failback replication configuration should be returned.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.drs#GetFailbackReplicationConfigurationResponse": { - "type": "structure", - "members": { - "recoveryInstanceID": { - "target": "com.amazonaws.drs#RecoveryInstanceID", - "traits": { - "smithy.api#documentation": "

The ID of the Recovery Instance.

", - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.drs#BoundedString", - "traits": { - "smithy.api#documentation": "

The name of the Failback Replication Configuration.

" - } - }, - "bandwidthThrottling": { - "target": "com.amazonaws.drs#PositiveInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Configure bandwidth throttling for the outbound data transfer rate of the Recovery Instance in Mbps.

" - } - }, - "usePrivateIP": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to use Private IP for the failback replication of the Recovery Instance.

" - } - } - } - }, - "com.amazonaws.drs#GetLaunchConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#GetLaunchConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.drs#LaunchConfiguration" - }, - "errors": [ - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#UninitializedAccountException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets a LaunchConfiguration, filtered by Source Server IDs.

", - "smithy.api#http": { - "uri": "/GetLaunchConfiguration", - "method": "POST", - "code": 200 - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.drs#GetLaunchConfigurationRequest": { - "type": "structure", - "members": { - "sourceServerID": { - "target": "com.amazonaws.drs#SourceServerID", - "traits": { - "smithy.api#documentation": "

The ID of the Source Server that we want to retrieve a Launch Configuration for.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.drs#GetReplicationConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#GetReplicationConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.drs#ReplicationConfiguration" - }, - "errors": [ - { - "target": "com.amazonaws.drs#AccessDeniedException" - }, - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#UninitializedAccountException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets a ReplicationConfiguration, filtered by Source Server ID.

", - "smithy.api#http": { - "uri": "/GetReplicationConfiguration", - "method": "POST", - "code": 200 - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.drs#GetReplicationConfigurationRequest": { - "type": "structure", - "members": { - "sourceServerID": { - "target": "com.amazonaws.drs#SourceServerID", - "traits": { - "smithy.api#documentation": "

The ID of the Source Serve for this Replication Configuration.r

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.drs#IPsList": { - "type": "list", - "member": { - "target": "com.amazonaws.drs#BoundedString" - } - }, - "com.amazonaws.drs#ISO8601DatetimeString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 19, - "max": 32 - }, - "smithy.api#pattern": "^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?Z$" - } - }, - "com.amazonaws.drs#ISO8601DurationString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.drs#IdentificationHints": { - "type": "structure", - "members": { - "fqdn": { - "target": "com.amazonaws.drs#BoundedString", - "traits": { - "smithy.api#documentation": "

Fully Qualified Domain Name identification hint.

" - } - }, - "hostname": { - "target": "com.amazonaws.drs#BoundedString", - "traits": { - "smithy.api#documentation": "

Hostname identification hint.

" - } - }, - "vmWareUuid": { - "target": "com.amazonaws.drs#BoundedString", - "traits": { - "smithy.api#documentation": "

vCenter VM path identification hint.

" - } - }, - "awsInstanceID": { - "target": "com.amazonaws.drs#EC2InstanceID", - "traits": { - "smithy.api#documentation": "

AWS Instance ID identification hint.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Hints used to uniquely identify a machine.

" - } - }, - "com.amazonaws.drs#InitializeService": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#InitializeServiceRequest" - }, - "output": { - "target": "com.amazonaws.drs#InitializeServiceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.drs#AccessDeniedException" - }, - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#ValidationException" - } - ], - "traits": { - "aws.iam#requiredActions": [ - "iam:CreateServiceLinkedRole", - "iam:GetInstanceProfile", - "iam:CreateInstanceProfile", - "iam:AddRoleToInstanceProfile" - ], - "smithy.api#documentation": "

Initialize Elastic Disaster Recovery.

", - "smithy.api#http": { - "uri": "/InitializeService", - "method": "POST", - "code": 204 - } - } - }, - "com.amazonaws.drs#InitializeServiceRequest": { - "type": "structure", - "members": {} - }, - "com.amazonaws.drs#InitializeServiceResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.drs#InitiatedBy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "START_RECOVERY", - "name": "START_RECOVERY" - }, - { - "value": "START_DRILL", - "name": "START_DRILL" - }, - { - "value": "FAILBACK", - "name": "FAILBACK" - }, - { - "value": "DIAGNOSTIC", - "name": "DIAGNOSTIC" - }, - { - "value": "TERMINATE_RECOVERY_INSTANCES", - "name": "TERMINATE_RECOVERY_INSTANCES" - }, - { - "value": "TARGET_ACCOUNT", - "name": "TARGET_ACCOUNT" - } - ] - } - }, - "com.amazonaws.drs#InternalServerException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.drs#LargeBoundedString", - "traits": { - "smithy.api#required": {} - } - }, - "retryAfterSeconds": { - "target": "com.amazonaws.drs#PositiveInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of seconds after which the request should be safe to retry.

", - "smithy.api#httpHeader": "Retry-After" - } - } - }, - "traits": { - "smithy.api#documentation": "

The request processing has failed because of an unknown error, exception or failure.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.drs#Job": { - "type": "structure", - "members": { - "jobID": { - "target": "com.amazonaws.drs#JobID", - "traits": { - "smithy.api#documentation": "

The ID of the Job.

", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.drs#ARN", - "traits": { - "smithy.api#documentation": "

The ARN of a Job.

" - } - }, - "type": { - "target": "com.amazonaws.drs#JobType", - "traits": { - "smithy.api#documentation": "

The type of the Job.

" - } - }, - "initiatedBy": { - "target": "com.amazonaws.drs#InitiatedBy", - "traits": { - "smithy.api#documentation": "

A string representing who initiated the Job.

" - } - }, - "creationDateTime": { - "target": "com.amazonaws.drs#ISO8601DatetimeString", - "traits": { - "smithy.api#documentation": "

The date and time of when the Job was created.

" - } - }, - "endDateTime": { - "target": "com.amazonaws.drs#ISO8601DatetimeString", - "traits": { - "smithy.api#documentation": "

The date and time of when the Job ended.

" - } - }, - "status": { - "target": "com.amazonaws.drs#JobStatus", - "traits": { - "smithy.api#documentation": "

The status of the Job.

" - } - }, - "participatingServers": { - "target": "com.amazonaws.drs#ParticipatingServers", - "traits": { - "smithy.api#documentation": "

A list of servers that the Job is acting upon.

" - } - }, - "tags": { - "target": "com.amazonaws.drs#TagsMap", - "traits": { - "smithy.api#documentation": "

A list of tags associated with the Job.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A job is an asynchronous workflow.

" - } - }, - "com.amazonaws.drs#JobID": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 24, - "max": 24 - }, - "smithy.api#pattern": "^drsjob-[0-9a-zA-Z]{17}$" - } - }, - "com.amazonaws.drs#JobLog": { - "type": "structure", - "members": { - "logDateTime": { - "target": "com.amazonaws.drs#ISO8601DatetimeString", - "traits": { - "smithy.api#documentation": "

The date and time the log was taken.

" - } - }, - "event": { - "target": "com.amazonaws.drs#JobLogEvent", - "traits": { - "smithy.api#documentation": "

The event represents the type of a log.

" - } - }, - "eventData": { - "target": "com.amazonaws.drs#JobLogEventData", - "traits": { - "smithy.api#documentation": "

Metadata associated with a Job log.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A log outputted by a Job.

" - } - }, - "com.amazonaws.drs#JobLogEvent": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "JOB_START", - "value": "JOB_START" - }, - { - "name": "SERVER_SKIPPED", - "value": "SERVER_SKIPPED" - }, - { - "name": "CLEANUP_START", - "value": "CLEANUP_START" - }, - { - "name": "CLEANUP_END", - "value": "CLEANUP_END" - }, - { - "name": "CLEANUP_FAIL", - "value": "CLEANUP_FAIL" - }, - { - "name": "SNAPSHOT_START", - "value": "SNAPSHOT_START" - }, - { - "name": "SNAPSHOT_END", - "value": "SNAPSHOT_END" - }, - { - "name": "SNAPSHOT_FAIL", - "value": "SNAPSHOT_FAIL" - }, - { - "name": "USING_PREVIOUS_SNAPSHOT", - "value": "USING_PREVIOUS_SNAPSHOT" - }, - { - "name": "USING_PREVIOUS_SNAPSHOT_FAILED", - "value": "USING_PREVIOUS_SNAPSHOT_FAILED" - }, - { - "name": "CONVERSION_START", - "value": "CONVERSION_START" - }, - { - "name": "CONVERSION_END", - "value": "CONVERSION_END" - }, - { - "name": "CONVERSION_FAIL", - "value": "CONVERSION_FAIL" - }, - { - "name": "LAUNCH_START", - "value": "LAUNCH_START" - }, - { - "name": "LAUNCH_FAILED", - "value": "LAUNCH_FAILED" - }, - { - "name": "JOB_CANCEL", - "value": "JOB_CANCEL" - }, - { - "name": "JOB_END", - "value": "JOB_END" - } - ] - } - }, - "com.amazonaws.drs#JobLogEventData": { - "type": "structure", - "members": { - "sourceServerID": { - "target": "com.amazonaws.drs#SourceServerID", - "traits": { - "smithy.api#documentation": "

The ID of a Source Server.

" - } - }, - "conversionServerID": { - "target": "com.amazonaws.drs#EC2InstanceID", - "traits": { - "smithy.api#documentation": "

The ID of a conversion server.

" - } - }, - "targetInstanceID": { - "target": "com.amazonaws.drs#EC2InstanceID", - "traits": { - "smithy.api#documentation": "

The ID of a Recovery Instance.

" - } - }, - "rawError": { - "target": "com.amazonaws.drs#LargeBoundedString", - "traits": { - "smithy.api#documentation": "

A string representing a job error.

" - } - }, - "conversionProperties": { - "target": "com.amazonaws.drs#ConversionProperties", - "traits": { - "smithy.api#documentation": "

Properties of a conversion job

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Metadata associated with a Job log.

" - } - }, - "com.amazonaws.drs#JobLogs": { - "type": "list", - "member": { - "target": "com.amazonaws.drs#JobLog" - } - }, - "com.amazonaws.drs#JobResource": { - "type": "resource", - "identifiers": { - "jobID": { - "target": "com.amazonaws.drs#JobID" - } - }, - "delete": { - "target": "com.amazonaws.drs#DeleteJob" - }, - "list": { - "target": "com.amazonaws.drs#DescribeJobs" - }, - "operations": [ - { - "target": "com.amazonaws.drs#DescribeJobLogItems" - } - ], - "traits": { - "aws.api#arn": { - "template": "job/{jobID}" - }, - "aws.iam#conditionKeys": ["aws:ResourceTag"], - "aws.iam#disableConditionKeyInference": {} - } - }, - "com.amazonaws.drs#JobStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "PENDING" - }, - { - "value": "STARTED", - "name": "STARTED" - }, - { - "value": "COMPLETED", - "name": "COMPLETED" - } - ] - } - }, - "com.amazonaws.drs#JobType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "LAUNCH", - "name": "LAUNCH" - }, - { - "value": "TERMINATE", - "name": "TERMINATE" - }, - { - "value": "CREATE_CONVERTED_SNAPSHOT", - "name": "CREATE_CONVERTED_SNAPSHOT" - } - ] - } - }, - "com.amazonaws.drs#JobsList": { - "type": "list", - "member": { - "target": "com.amazonaws.drs#Job" - } - }, - "com.amazonaws.drs#LargeBoundedString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 65536 - } - } - }, - "com.amazonaws.drs#LastLaunchResult": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "NOT_STARTED", - "value": "NOT_STARTED" - }, - { - "name": "PENDING", - "value": "PENDING" - }, - { - "name": "SUCCEEDED", - "value": "SUCCEEDED" - }, - { - "name": "FAILED", - "value": "FAILED" - } - ] - } - }, - "com.amazonaws.drs#LastLaunchType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "RECOVERY", - "value": "RECOVERY" - }, - { - "name": "DRILL", - "value": "DRILL" - } - ] - } - }, - "com.amazonaws.drs#LaunchConfiguration": { - "type": "structure", - "members": { - "sourceServerID": { - "target": "com.amazonaws.drs#SourceServerID", - "traits": { - "smithy.api#documentation": "

The ID of the Source Server for this launch configuration.

" - } - }, - "name": { - "target": "com.amazonaws.drs#SmallBoundedString", - "traits": { - "smithy.api#documentation": "

The name of the launch configuration.

" - } - }, - "ec2LaunchTemplateID": { - "target": "com.amazonaws.drs#BoundedString", - "traits": { - "smithy.api#documentation": "

The EC2 launch template ID of this launch configuration.

" - } - }, - "launchDisposition": { - "target": "com.amazonaws.drs#LaunchDisposition", - "traits": { - "smithy.api#documentation": "

The state of the Recovery Instance in EC2 after the recovery operation.

" - } - }, - "targetInstanceTypeRightSizingMethod": { - "target": "com.amazonaws.drs#TargetInstanceTypeRightSizingMethod", - "traits": { - "smithy.api#documentation": "

Whether Elastic Disaster Recovery should try to automatically choose the instance type that best matches the OS, CPU, and RAM of your Source Server.

" - } - }, - "copyPrivateIp": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Whether we should copy the Private IP of the Source Server to the Recovery Instance.

" - } - }, - "copyTags": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Whether we want to copy the tags of the Source Server to the EC2 machine of the Recovery Instance.

" - } - }, - "licensing": { - "target": "com.amazonaws.drs#Licensing", - "traits": { - "smithy.api#documentation": "

The licensing configuration to be used for this launch configuration.

" - } - } - } - }, - "com.amazonaws.drs#LaunchConfigurationTemplate": { - "type": "structure", - "members": { - "launchConfigurationTemplateID": { - "target": "com.amazonaws.drs#LaunchConfigurationTemplateID", - "traits": { - "smithy.api#documentation": "

ID of the Launch Configuration Template.

" - } - }, - "arn": { - "target": "com.amazonaws.drs#ARN", - "traits": { - "smithy.api#documentation": "

ARN of the Launch Configuration Template.

" - } - }, - "tags": { - "target": "com.amazonaws.drs#TagsMap", - "traits": { - "smithy.api#documentation": "

Tags of the Launch Configuration Template.

" - } - }, - "launchDisposition": { - "target": "com.amazonaws.drs#LaunchDisposition", - "traits": { - "smithy.api#documentation": "

Launch disposition.

" - } - }, - "targetInstanceTypeRightSizingMethod": { - "target": "com.amazonaws.drs#TargetInstanceTypeRightSizingMethod", - "traits": { - "smithy.api#documentation": "

Target instance type right-sizing method.

" - } - }, - "copyPrivateIp": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Copy private IP.

" - } - }, - "copyTags": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Copy tags.

" - } - }, - "licensing": { - "target": "com.amazonaws.drs#Licensing", - "traits": { - "smithy.api#documentation": "

Licensing.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Account level Launch Configuration Template.

" - } - }, - "com.amazonaws.drs#LaunchConfigurationTemplateID": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 21, - "max": 21 - }, - "smithy.api#pattern": "^lct-[0-9a-zA-Z]{17}$" - } - }, - "com.amazonaws.drs#LaunchConfigurationTemplateIDs": { - "type": "list", - "member": { - "target": "com.amazonaws.drs#LaunchConfigurationTemplateID" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.drs#LaunchConfigurationTemplateResource": { - "type": "resource", - "identifiers": { - "launchConfigurationTemplateID": { - "target": "com.amazonaws.drs#LaunchConfigurationTemplateID" - } - }, - "create": { - "target": "com.amazonaws.drs#CreateLaunchConfigurationTemplate" - }, - "update": { - "target": "com.amazonaws.drs#UpdateLaunchConfigurationTemplate" - }, - "delete": { - "target": "com.amazonaws.drs#DeleteLaunchConfigurationTemplate" - }, - "list": { - "target": "com.amazonaws.drs#DescribeLaunchConfigurationTemplates" - }, - "traits": { - "aws.api#arn": { - "template": "launch-configuration-template/{launchConfigurationTemplateID}" - } - } - }, - "com.amazonaws.drs#LaunchConfigurationTemplates": { - "type": "list", - "member": { - "target": "com.amazonaws.drs#LaunchConfigurationTemplate" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.drs#LaunchDisposition": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "STOPPED", - "value": "STOPPED" - }, - { - "name": "STARTED", - "value": "STARTED" - } - ] - } - }, - "com.amazonaws.drs#LaunchStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "PENDING" - }, - { - "value": "IN_PROGRESS", - "name": "IN_PROGRESS" - }, - { - "value": "LAUNCHED", - "name": "LAUNCHED" - }, - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "TERMINATED", - "name": "TERMINATED" - } - ] - } - }, - "com.amazonaws.drs#Licensing": { - "type": "structure", - "members": { - "osByol": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to enable \"Bring your own license\" or not.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Configuration of a machine's license.

" - } - }, - "com.amazonaws.drs#LifeCycle": { - "type": "structure", - "members": { - "addedToServiceDateTime": { - "target": "com.amazonaws.drs#ISO8601DatetimeString", - "traits": { - "smithy.api#documentation": "

The date and time of when the Source Server was added to the service.

" - } - }, - "firstByteDateTime": { - "target": "com.amazonaws.drs#ISO8601DatetimeString", - "traits": { - "smithy.api#documentation": "

The date and time of the first byte that was replicated from the Source Server.

" - } - }, - "elapsedReplicationDuration": { - "target": "com.amazonaws.drs#ISO8601DurationString", - "traits": { - "smithy.api#documentation": "

The amount of time that the Source Server has been replicating for.

" - } - }, - "lastSeenByServiceDateTime": { - "target": "com.amazonaws.drs#ISO8601DatetimeString", - "traits": { - "smithy.api#documentation": "

The date and time this Source Server was last seen by the service.

" - } - }, - "lastLaunch": { - "target": "com.amazonaws.drs#LifeCycleLastLaunch", - "traits": { - "smithy.api#documentation": "

An object containing information regarding the last launch of the Source Server.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An object representing the Source Server Lifecycle.

" - } - }, - "com.amazonaws.drs#LifeCycleLastLaunch": { - "type": "structure", - "members": { - "initiated": { - "target": "com.amazonaws.drs#LifeCycleLastLaunchInitiated", - "traits": { - "smithy.api#documentation": "

An object containing information regarding the initiation of the last launch of a Source Server.

" - } - }, - "status": { - "target": "com.amazonaws.drs#LaunchStatus", - "traits": { - "smithy.api#documentation": "

Status of Source Server's last launch.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An object containing information regarding the last launch of a Source Server.

" - } - }, - "com.amazonaws.drs#LifeCycleLastLaunchInitiated": { - "type": "structure", - "members": { - "apiCallDateTime": { - "target": "com.amazonaws.drs#ISO8601DatetimeString", - "traits": { - "smithy.api#documentation": "

The date and time the last Source Server launch was initiated.

" - } - }, - "jobID": { - "target": "com.amazonaws.drs#JobID", - "traits": { - "smithy.api#documentation": "

The ID of the Job that was used to last launch the Source Server.

" - } - }, - "type": { - "target": "com.amazonaws.drs#LastLaunchType", - "traits": { - "smithy.api#documentation": "

The Job type that was used to last launch the Source Server.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An object containing information regarding the initiation of the last launch of a Source Server.

" - } - }, - "com.amazonaws.drs#ListExtensibleSourceServers": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#ListExtensibleSourceServersRequest" - }, - "output": { - "target": "com.amazonaws.drs#ListExtensibleSourceServersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.drs#AccessDeniedException" - }, - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#UninitializedAccountException" - }, - { - "target": "com.amazonaws.drs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of source servers on a staging account that are extensible, which means that:\n a. The source server is not already extended into this Account.\n b. The source server on the Account we’re reading from is not an extension of another source server.\n

", - "smithy.api#http": { - "uri": "/ListExtensibleSourceServers", - "method": "POST", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "items" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.drs#ListExtensibleSourceServersRequest": { - "type": "structure", - "members": { - "stagingAccountID": { - "target": "com.amazonaws.drs#AccountID", - "traits": { - "smithy.api#documentation": "

The Id of the staging Account to retrieve extensible source servers from.

", - "smithy.api#required": {} - } - }, - "maxResults": { - "target": "com.amazonaws.drs#MaxResultsReplicatingSourceServers", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of extensible source servers to retrieve.

" - } - }, - "nextToken": { - "target": "com.amazonaws.drs#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token of the next extensible source server to retrieve.

" - } - } - } - }, - "com.amazonaws.drs#ListExtensibleSourceServersResponse": { - "type": "structure", - "members": { - "items": { - "target": "com.amazonaws.drs#StagingSourceServersList", - "traits": { - "smithy.api#documentation": "

A list of source servers on a staging Account that are extensible.

" - } - }, - "nextToken": { - "target": "com.amazonaws.drs#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token of the next extensible source server to retrieve.

" - } - } - } - }, - "com.amazonaws.drs#ListStagingAccounts": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#ListStagingAccountsRequest" - }, - "output": { - "target": "com.amazonaws.drs#ListStagingAccountsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.drs#AccessDeniedException" - }, - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#UninitializedAccountException" - }, - { - "target": "com.amazonaws.drs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns an array of staging accounts for existing extended source servers.

", - "smithy.api#http": { - "uri": "/ListStagingAccounts", - "method": "GET", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "accounts" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.drs#ListStagingAccountsRequest": { - "type": "structure", - "members": { - "maxResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The maximum number of staging Accounts to retrieve.

", - "smithy.api#httpQuery": "maxResults", - "smithy.api#range": { - "min": 1, - "max": 50 - } - } - }, - "nextToken": { - "target": "com.amazonaws.drs#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token of the next staging Account to retrieve.

", - "smithy.api#httpQuery": "nextToken" - } - } - } - }, - "com.amazonaws.drs#ListStagingAccountsResponse": { - "type": "structure", - "members": { - "accounts": { - "target": "com.amazonaws.drs#Accounts", - "traits": { - "smithy.api#documentation": "

An array of staging AWS Accounts.

" - } - }, - "nextToken": { - "target": "com.amazonaws.drs#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token of the next staging Account to retrieve.

" - } - } - } - }, - "com.amazonaws.drs#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.drs#ListTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.drs#AccessDeniedException" - }, - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

List all tags for your Elastic Disaster Recovery resources.

", - "smithy.api#http": { - "method": "GET", - "uri": "/tags/{resourceArn}" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.drs#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.drs#ARN", - "traits": { - "smithy.api#documentation": "

The ARN of the resource whose tags should be returned.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.drs#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "tags": { - "target": "com.amazonaws.drs#TagsMap", - "traits": { - "smithy.api#documentation": "

The tags of the requested resource.

" - } - } - } - }, - "com.amazonaws.drs#MaxResultsReplicatingSourceServers": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 300 - } - } - }, - "com.amazonaws.drs#MaxResultsType": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.drs#NetworkInterface": { - "type": "structure", - "members": { - "macAddress": { - "target": "com.amazonaws.drs#BoundedString", - "traits": { - "smithy.api#documentation": "

The MAC address of the network interface.

" - } - }, - "ips": { - "target": "com.amazonaws.drs#IPsList", - "traits": { - "smithy.api#documentation": "

Network interface IPs.

" - } - }, - "isPrimary": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Whether this is the primary network interface.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Network interface.

" - } - }, - "com.amazonaws.drs#NetworkInterfaces": { - "type": "list", - "member": { - "target": "com.amazonaws.drs#NetworkInterface" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 32 - } - } - }, - "com.amazonaws.drs#OS": { - "type": "structure", - "members": { - "fullString": { - "target": "com.amazonaws.drs#BoundedString", - "traits": { - "smithy.api#documentation": "

The long name of the Operating System.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Operating System.

" - } - }, - "com.amazonaws.drs#OriginEnvironment": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "ON_PREMISES", - "value": "ON_PREMISES" - }, - { - "name": "AWS", - "value": "AWS" - } - ] - } - }, - "com.amazonaws.drs#PITPolicy": { - "type": "list", - "member": { - "target": "com.amazonaws.drs#PITPolicyRule" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.drs#PITPolicyRule": { - "type": "structure", - "members": { - "ruleID": { - "target": "com.amazonaws.drs#PositiveInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The ID of the rule.

" - } - }, - "units": { - "target": "com.amazonaws.drs#PITPolicyRuleUnits", - "traits": { - "smithy.api#documentation": "

The units used to measure the interval and retentionDuration.

", - "smithy.api#required": {} - } - }, - "interval": { - "target": "com.amazonaws.drs#StrictlyPositiveInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

How often, in the chosen units, a snapshot should be taken.

", - "smithy.api#required": {} - } - }, - "retentionDuration": { - "target": "com.amazonaws.drs#StrictlyPositiveInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The duration to retain a snapshot for, in the chosen units.

", - "smithy.api#required": {} - } - }, - "enabled": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Whether this rule is enabled or not.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A rule in the Point in Time (PIT) policy representing when to take snapshots and how long to retain them for.

" - } - }, - "com.amazonaws.drs#PITPolicyRuleUnits": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "MINUTE", - "name": "MINUTE" - }, - { - "value": "HOUR", - "name": "HOUR" - }, - { - "value": "DAY", - "name": "DAY" - } - ] - } - }, - "com.amazonaws.drs#PaginationToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2048 - } - } - }, - "com.amazonaws.drs#ParticipatingServer": { - "type": "structure", - "members": { - "sourceServerID": { - "target": "com.amazonaws.drs#SourceServerID", - "traits": { - "smithy.api#documentation": "

The Source Server ID of a participating server.

" - } - }, - "recoveryInstanceID": { - "target": "com.amazonaws.drs#RecoveryInstanceID", - "traits": { - "smithy.api#documentation": "

The Recovery Instance ID of a participating server.

" - } - }, - "launchStatus": { - "target": "com.amazonaws.drs#LaunchStatus", - "traits": { - "smithy.api#documentation": "

The launch status of a participating server.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents a server participating in an asynchronous Job.

" - } - }, - "com.amazonaws.drs#ParticipatingServers": { - "type": "list", - "member": { - "target": "com.amazonaws.drs#ParticipatingServer" - } - }, - "com.amazonaws.drs#PositiveInteger": { - "type": "long", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.drs#RecoveryInstance": { - "type": "structure", - "members": { - "ec2InstanceID": { - "target": "com.amazonaws.drs#EC2InstanceID", - "traits": { - "smithy.api#documentation": "

The EC2 instance ID of the Recovery Instance.

" - } - }, - "ec2InstanceState": { - "target": "com.amazonaws.drs#EC2InstanceState", - "traits": { - "smithy.api#documentation": "

The state of the EC2 instance for this Recovery Instance.

" - } - }, - "jobID": { - "target": "com.amazonaws.drs#JobID", - "traits": { - "smithy.api#documentation": "

The ID of the Job that created the Recovery Instance.

" - } - }, - "recoveryInstanceID": { - "target": "com.amazonaws.drs#RecoveryInstanceID", - "traits": { - "smithy.api#documentation": "

The ID of the Recovery Instance.

" - } - }, - "sourceServerID": { - "target": "com.amazonaws.drs#SourceServerID", - "traits": { - "smithy.api#documentation": "

The Source Server ID that this Recovery Instance is associated with.

" - } - }, - "arn": { - "target": "com.amazonaws.drs#ARN", - "traits": { - "smithy.api#documentation": "

The ARN of the Recovery Instance.

" - } - }, - "tags": { - "target": "com.amazonaws.drs#TagsMap", - "traits": { - "smithy.api#documentation": "

An array of tags that are associated with the Recovery Instance.

" - } - }, - "failback": { - "target": "com.amazonaws.drs#RecoveryInstanceFailback", - "traits": { - "smithy.api#documentation": "

An object representing failback related information of the Recovery Instance.

" - } - }, - "dataReplicationInfo": { - "target": "com.amazonaws.drs#RecoveryInstanceDataReplicationInfo", - "traits": { - "smithy.api#documentation": "

The Data Replication Info of the Recovery Instance.

" - } - }, - "recoveryInstanceProperties": { - "target": "com.amazonaws.drs#RecoveryInstanceProperties", - "traits": { - "smithy.api#documentation": "

Properties of the Recovery Instance machine.

" - } - }, - "pointInTimeSnapshotDateTime": { - "target": "com.amazonaws.drs#ISO8601DatetimeString", - "traits": { - "smithy.api#documentation": "

The date and time of the Point in Time (PIT) snapshot that this Recovery Instance was launched from.

" - } - }, - "isDrill": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Whether this Recovery Instance was created for a drill or for an actual Recovery event.

" - } - }, - "originEnvironment": { - "target": "com.amazonaws.drs#OriginEnvironment", - "traits": { - "smithy.api#documentation": "

Environment (On Premises / AWS) of the instance that the recovery instance originated from.

" - } - }, - "originAvailabilityZone": { - "target": "com.amazonaws.drs#AwsAvailabilityZone", - "traits": { - "smithy.api#documentation": "

AWS availability zone associated with the recovery instance.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A Recovery Instance is a replica of a Source Server running on EC2.

" - } - }, - "com.amazonaws.drs#RecoveryInstanceDataReplicationError": { - "type": "structure", - "members": { - "error": { - "target": "com.amazonaws.drs#FailbackReplicationError", - "traits": { - "smithy.api#documentation": "

Error in data replication.

" - } - }, - "rawError": { - "target": "com.amazonaws.drs#LargeBoundedString", - "traits": { - "smithy.api#documentation": "

Error in data replication.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Error in data replication.

" - } - }, - "com.amazonaws.drs#RecoveryInstanceDataReplicationInfo": { - "type": "structure", - "members": { - "lagDuration": { - "target": "com.amazonaws.drs#ISO8601DatetimeString", - "traits": { - "smithy.api#documentation": "

Data replication lag duration.

" - } - }, - "etaDateTime": { - "target": "com.amazonaws.drs#ISO8601DatetimeString", - "traits": { - "smithy.api#documentation": "

An estimate of when the data replication will be completed.

" - } - }, - "replicatedDisks": { - "target": "com.amazonaws.drs#RecoveryInstanceDataReplicationInfoReplicatedDisks", - "traits": { - "smithy.api#documentation": "

The disks that should be replicated.

" - } - }, - "dataReplicationState": { - "target": "com.amazonaws.drs#RecoveryInstanceDataReplicationState", - "traits": { - "smithy.api#documentation": "

The state of the data replication.

" - } - }, - "dataReplicationInitiation": { - "target": "com.amazonaws.drs#RecoveryInstanceDataReplicationInitiation", - "traits": { - "smithy.api#documentation": "

Information about whether the data replication has been initiated.

" - } - }, - "dataReplicationError": { - "target": "com.amazonaws.drs#RecoveryInstanceDataReplicationError", - "traits": { - "smithy.api#documentation": "

Information about Data Replication

" - } - }, - "stagingAvailabilityZone": { - "target": "com.amazonaws.drs#AwsAvailabilityZone", - "traits": { - "smithy.api#documentation": "

AWS Availability zone into which data is being replicated.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about Data Replication

" - } - }, - "com.amazonaws.drs#RecoveryInstanceDataReplicationInfoReplicatedDisk": { - "type": "structure", - "members": { - "deviceName": { - "target": "com.amazonaws.drs#BoundedString", - "traits": { - "smithy.api#documentation": "

The name of the device.

" - } - }, - "totalStorageBytes": { - "target": "com.amazonaws.drs#PositiveInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The total amount of data to be replicated in bytes.

" - } - }, - "replicatedStorageBytes": { - "target": "com.amazonaws.drs#PositiveInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The amount of data replicated so far in bytes.

" - } - }, - "rescannedStorageBytes": { - "target": "com.amazonaws.drs#PositiveInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The amount of data to be rescanned in bytes.

" - } - }, - "backloggedStorageBytes": { - "target": "com.amazonaws.drs#PositiveInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The size of the replication backlog in bytes.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A disk that should be replicated.

" - } - }, - "com.amazonaws.drs#RecoveryInstanceDataReplicationInfoReplicatedDisks": { - "type": "list", - "member": { - "target": "com.amazonaws.drs#RecoveryInstanceDataReplicationInfoReplicatedDisk" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 60 - } - } - }, - "com.amazonaws.drs#RecoveryInstanceDataReplicationInitiation": { - "type": "structure", - "members": { - "startDateTime": { - "target": "com.amazonaws.drs#ISO8601DatetimeString", - "traits": { - "smithy.api#documentation": "

The date and time of the current attempt to initiate data replication.

" - } - }, - "steps": { - "target": "com.amazonaws.drs#RecoveryInstanceDataReplicationInitiationSteps", - "traits": { - "smithy.api#documentation": "

The steps of the current attempt to initiate data replication.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Data replication initiation.

" - } - }, - "com.amazonaws.drs#RecoveryInstanceDataReplicationInitiationStep": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.drs#RecoveryInstanceDataReplicationInitiationStepName", - "traits": { - "smithy.api#documentation": "

The name of the step.

" - } - }, - "status": { - "target": "com.amazonaws.drs#RecoveryInstanceDataReplicationInitiationStepStatus", - "traits": { - "smithy.api#documentation": "

The status of the step.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Data replication initiation step.

" - } - }, - "com.amazonaws.drs#RecoveryInstanceDataReplicationInitiationStepName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "LINK_FAILBACK_CLIENT_WITH_RECOVERY_INSTANCE", - "value": "LINK_FAILBACK_CLIENT_WITH_RECOVERY_INSTANCE" - }, - { - "name": "COMPLETE_VOLUME_MAPPING", - "value": "COMPLETE_VOLUME_MAPPING" - }, - { - "name": "ESTABLISH_RECOVERY_INSTANCE_COMMUNICATION", - "value": "ESTABLISH_RECOVERY_INSTANCE_COMMUNICATION" - }, - { - "name": "DOWNLOAD_REPLICATION_SOFTWARE_TO_FAILBACK_CLIENT", - "value": "DOWNLOAD_REPLICATION_SOFTWARE_TO_FAILBACK_CLIENT" - }, - { - "name": "CONFIGURE_REPLICATION_SOFTWARE", - "value": "CONFIGURE_REPLICATION_SOFTWARE" - }, - { - "name": "PAIR_AGENT_WITH_REPLICATION_SOFTWARE", - "value": "PAIR_AGENT_WITH_REPLICATION_SOFTWARE" - }, - { - "name": "ESTABLISH_AGENT_REPLICATOR_SOFTWARE_COMMUNICATION", - "value": "ESTABLISH_AGENT_REPLICATOR_SOFTWARE_COMMUNICATION" - }, - { - "value": "WAIT", - "name": "WAIT" - }, - { - "value": "CREATE_SECURITY_GROUP", - "name": "CREATE_SECURITY_GROUP" - }, - { - "value": "LAUNCH_REPLICATION_SERVER", - "name": "LAUNCH_REPLICATION_SERVER" - }, - { - "value": "BOOT_REPLICATION_SERVER", - "name": "BOOT_REPLICATION_SERVER" - }, - { - "value": "AUTHENTICATE_WITH_SERVICE", - "name": "AUTHENTICATE_WITH_SERVICE" - }, - { - "value": "DOWNLOAD_REPLICATION_SOFTWARE", - "name": "DOWNLOAD_REPLICATION_SOFTWARE" - }, - { - "value": "CREATE_STAGING_DISKS", - "name": "CREATE_STAGING_DISKS" - }, - { - "value": "ATTACH_STAGING_DISKS", - "name": "ATTACH_STAGING_DISKS" - }, - { - "value": "PAIR_REPLICATION_SERVER_WITH_AGENT", - "name": "PAIR_REPLICATION_SERVER_WITH_AGENT" - }, - { - "value": "CONNECT_AGENT_TO_REPLICATION_SERVER", - "name": "CONNECT_AGENT_TO_REPLICATION_SERVER" - }, - { - "value": "START_DATA_TRANSFER", - "name": "START_DATA_TRANSFER" - } - ] - } - }, - "com.amazonaws.drs#RecoveryInstanceDataReplicationInitiationStepStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "NOT_STARTED", - "value": "NOT_STARTED" - }, - { - "name": "IN_PROGRESS", - "value": "IN_PROGRESS" - }, - { - "name": "SUCCEEDED", - "value": "SUCCEEDED" - }, - { - "name": "FAILED", - "value": "FAILED" - }, - { - "name": "SKIPPED", - "value": "SKIPPED" - } - ] - } - }, - "com.amazonaws.drs#RecoveryInstanceDataReplicationInitiationSteps": { - "type": "list", - "member": { - "target": "com.amazonaws.drs#RecoveryInstanceDataReplicationInitiationStep" - } - }, - "com.amazonaws.drs#RecoveryInstanceDataReplicationState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "STOPPED", - "value": "STOPPED" - }, - { - "name": "INITIATING", - "value": "INITIATING" - }, - { - "name": "INITIAL_SYNC", - "value": "INITIAL_SYNC" - }, - { - "name": "BACKLOG", - "value": "BACKLOG" - }, - { - "name": "CREATING_SNAPSHOT", - "value": "CREATING_SNAPSHOT" - }, - { - "name": "CONTINUOUS", - "value": "CONTINUOUS" - }, - { - "name": "PAUSED", - "value": "PAUSED" - }, - { - "name": "RESCAN", - "value": "RESCAN" - }, - { - "name": "STALLED", - "value": "STALLED" - }, - { - "name": "DISCONNECTED", - "value": "DISCONNECTED" - }, - { - "name": "REPLICATION_STATE_NOT_AVAILABLE", - "value": "REPLICATION_STATE_NOT_AVAILABLE" - }, - { - "name": "NOT_STARTED", - "value": "NOT_STARTED" - } - ] - } - }, - "com.amazonaws.drs#RecoveryInstanceDisk": { - "type": "structure", - "members": { - "internalDeviceName": { - "target": "com.amazonaws.drs#BoundedString", - "traits": { - "smithy.api#documentation": "

The internal device name of this disk. This is the name that is visible on the machine itself and not from the EC2 console.

" - } - }, - "bytes": { - "target": "com.amazonaws.drs#PositiveInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The amount of storage on the disk in bytes.

" - } - }, - "ebsVolumeID": { - "target": "com.amazonaws.drs#EbsVolumeID", - "traits": { - "smithy.api#documentation": "

The EBS Volume ID of this disk.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An object representing a block storage device on the Recovery Instance.

" - } - }, - "com.amazonaws.drs#RecoveryInstanceDisks": { - "type": "list", - "member": { - "target": "com.amazonaws.drs#RecoveryInstanceDisk" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1000 - } - } - }, - "com.amazonaws.drs#RecoveryInstanceFailback": { - "type": "structure", - "members": { - "failbackClientID": { - "target": "com.amazonaws.drs#BoundedString", - "traits": { - "smithy.api#documentation": "

The ID of the failback client that this Recovery Instance is associated with.

" - } - }, - "failbackJobID": { - "target": "com.amazonaws.drs#JobID", - "traits": { - "smithy.api#documentation": "

The Job ID of the last failback log for this Recovery Instance.

" - } - }, - "failbackInitiationTime": { - "target": "com.amazonaws.drs#ISO8601DatetimeString", - "traits": { - "smithy.api#documentation": "

The date and time that the failback initiation started.

" - } - }, - "state": { - "target": "com.amazonaws.drs#FailbackState", - "traits": { - "smithy.api#documentation": "

The state of the failback process that this Recovery Instance is in.

" - } - }, - "agentLastSeenByServiceDateTime": { - "target": "com.amazonaws.drs#ISO8601DatetimeString", - "traits": { - "smithy.api#documentation": "

The date and time the agent on the Recovery Instance was last seen by the service.

" - } - }, - "failbackClientLastSeenByServiceDateTime": { - "target": "com.amazonaws.drs#ISO8601DatetimeString", - "traits": { - "smithy.api#documentation": "

The date and time that the failback client was last seen by the service.

" - } - }, - "failbackToOriginalServer": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Whether we are failing back to the original Source Server for this Recovery Instance.

" - } - }, - "firstByteDateTime": { - "target": "com.amazonaws.drs#ISO8601DatetimeString", - "traits": { - "smithy.api#documentation": "

The date and time of the first byte that was replicated from the Recovery Instance.

" - } - }, - "elapsedReplicationDuration": { - "target": "com.amazonaws.drs#ISO8601DatetimeString", - "traits": { - "smithy.api#documentation": "

The amount of time that the Recovery Instance has been replicating for.

" - } - }, - "failbackLaunchType": { - "target": "com.amazonaws.drs#FailbackLaunchType", - "traits": { - "smithy.api#documentation": "

The launch type (Recovery / Drill) of the last launch for the failback replication of this recovery instance.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An object representing failback related information of the Recovery Instance.

" - } - }, - "com.amazonaws.drs#RecoveryInstanceID": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 10, - "max": 19 - }, - "smithy.api#pattern": "^i-[0-9a-fA-F]{8,}$" - } - }, - "com.amazonaws.drs#RecoveryInstanceIDs": { - "type": "list", - "member": { - "target": "com.amazonaws.drs#RecoveryInstanceID" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.drs#RecoveryInstanceProperties": { - "type": "structure", - "members": { - "lastUpdatedDateTime": { - "target": "com.amazonaws.drs#ISO8601DatetimeString", - "traits": { - "smithy.api#documentation": "

The date and time the Recovery Instance properties were last updated on.

" - } - }, - "identificationHints": { - "target": "com.amazonaws.drs#IdentificationHints", - "traits": { - "smithy.api#documentation": "

Hints used to uniquely identify a machine.

" - } - }, - "networkInterfaces": { - "target": "com.amazonaws.drs#NetworkInterfaces", - "traits": { - "smithy.api#documentation": "

An array of network interfaces.

" - } - }, - "disks": { - "target": "com.amazonaws.drs#RecoveryInstanceDisks", - "traits": { - "smithy.api#documentation": "

An array of disks.

" - } - }, - "cpus": { - "target": "com.amazonaws.drs#Cpus", - "traits": { - "smithy.api#documentation": "

An array of CPUs.

" - } - }, - "ramBytes": { - "target": "com.amazonaws.drs#PositiveInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The amount of RAM in bytes.

" - } - }, - "os": { - "target": "com.amazonaws.drs#OS", - "traits": { - "smithy.api#documentation": "

Operating system.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Properties of the Recovery Instance machine.

" - } - }, - "com.amazonaws.drs#RecoveryInstanceResource": { - "type": "resource", - "identifiers": { - "recoveryInstanceID": { - "target": "com.amazonaws.drs#RecoveryInstanceID" - } - }, - "list": { - "target": "com.amazonaws.drs#DescribeRecoveryInstances" - }, - "operations": [ - { - "target": "com.amazonaws.drs#DeleteRecoveryInstance" + }, + "tagKeys": { + "target": "com.amazonaws.drs#TagKeys", + "traits": { + "smithy.api#documentation": "

Array of tags to be removed.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.drs#UpdateFailbackReplicationConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#UpdateFailbackReplicationConfigurationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.drs#AccessDeniedException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + } + ], + "traits": { + "smithy.api#documentation": "

Allows you to update the failback replication configuration of a Recovery Instance by ID.

", + "smithy.api#http": { + "uri": "/UpdateFailbackReplicationConfiguration", + "method": "POST", + "code": 200 + } + } + }, + "com.amazonaws.drs#UpdateFailbackReplicationConfigurationRequest": { + "type": "structure", + "members": { + "recoveryInstanceID": { + "target": "com.amazonaws.drs#RecoveryInstanceID", + "traits": { + "smithy.api#documentation": "

The ID of the Recovery Instance.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.drs#BoundedString", + "traits": { + "smithy.api#documentation": "

The name of the Failback Replication Configuration.

" + } + }, + "bandwidthThrottling": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Configure bandwidth throttling for the outbound data transfer rate of the Recovery Instance in Mbps.

" + } + }, + "usePrivateIP": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to use Private IP for the failback replication of the Recovery Instance.

" + } + } + } + }, + "com.amazonaws.drs#UpdateLaunchConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#UpdateLaunchConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.drs#LaunchConfiguration" + }, + "errors": [ + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a LaunchConfiguration by Source Server ID.

", + "smithy.api#http": { + "uri": "/UpdateLaunchConfiguration", + "method": "POST", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.drs#UpdateLaunchConfigurationRequest": { + "type": "structure", + "members": { + "sourceServerID": { + "target": "com.amazonaws.drs#SourceServerID", + "traits": { + "smithy.api#documentation": "

The ID of the Source Server that we want to retrieve a Launch Configuration for.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.drs#SmallBoundedString", + "traits": { + "smithy.api#documentation": "

The name of the launch configuration.

" + } + }, + "launchDisposition": { + "target": "com.amazonaws.drs#LaunchDisposition", + "traits": { + "smithy.api#documentation": "

The state of the Recovery Instance in EC2 after the recovery operation.

" + } + }, + "targetInstanceTypeRightSizingMethod": { + "target": "com.amazonaws.drs#TargetInstanceTypeRightSizingMethod", + "traits": { + "smithy.api#documentation": "

Whether Elastic Disaster Recovery should try to automatically choose the instance type that best matches the OS, CPU, and RAM of your Source Server.

" + } + }, + "copyPrivateIp": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether we should copy the Private IP of the Source Server to the Recovery Instance.

" + } + }, + "copyTags": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether we want to copy the tags of the Source Server to the EC2 machine of the Recovery Instance.

" + } + }, + "licensing": { + "target": "com.amazonaws.drs#Licensing", + "traits": { + "smithy.api#documentation": "

The licensing configuration to be used for this launch configuration.

" + } + } + } }, - { - "target": "com.amazonaws.drs#DisconnectRecoveryInstance" + "com.amazonaws.drs#UpdateLaunchConfigurationTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#UpdateLaunchConfigurationTemplateRequest" + }, + "output": { + "target": "com.amazonaws.drs#UpdateLaunchConfigurationTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#AccessDeniedException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an existing Launch Configuration Template by ID.

", + "smithy.api#http": { + "uri": "/UpdateLaunchConfigurationTemplate", + "method": "POST", + "code": 200 + } + } }, - { - "target": "com.amazonaws.drs#GetFailbackReplicationConfiguration" + "com.amazonaws.drs#UpdateLaunchConfigurationTemplateRequest": { + "type": "structure", + "members": { + "launchConfigurationTemplateID": { + "target": "com.amazonaws.drs#LaunchConfigurationTemplateID", + "traits": { + "smithy.api#documentation": "

Launch Configuration Template ID.

", + "smithy.api#required": {} + } + }, + "launchDisposition": { + "target": "com.amazonaws.drs#LaunchDisposition", + "traits": { + "smithy.api#documentation": "

Launch disposition.

" + } + }, + "targetInstanceTypeRightSizingMethod": { + "target": "com.amazonaws.drs#TargetInstanceTypeRightSizingMethod", + "traits": { + "smithy.api#documentation": "

Target instance type right-sizing method.

" + } + }, + "copyPrivateIp": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Copy private IP.

" + } + }, + "copyTags": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Copy tags.

" + } + }, + "licensing": { + "target": "com.amazonaws.drs#Licensing", + "traits": { + "smithy.api#documentation": "

Licensing.

" + } + }, + "exportBucketArn": { + "target": "com.amazonaws.drs#ARN", + "traits": { + "smithy.api#documentation": "

S3 bucket ARN to export Source Network templates.

" + } + } + } }, - { - "target": "com.amazonaws.drs#ReverseReplication" + "com.amazonaws.drs#UpdateLaunchConfigurationTemplateResponse": { + "type": "structure", + "members": { + "launchConfigurationTemplate": { + "target": "com.amazonaws.drs#LaunchConfigurationTemplate", + "traits": { + "smithy.api#documentation": "

Updated Launch Configuration Template.

" + } + } + } }, - { - "target": "com.amazonaws.drs#StopFailback" + "com.amazonaws.drs#UpdateReplicationConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#UpdateReplicationConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.drs#ReplicationConfiguration" + }, + "errors": [ + { + "target": "com.amazonaws.drs#AccessDeniedException" + }, + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Allows you to update a ReplicationConfiguration by Source Server ID.

", + "smithy.api#http": { + "uri": "/UpdateReplicationConfiguration", + "method": "POST", + "code": 200 + }, + "smithy.api#idempotent": {} + } }, - { - "target": "com.amazonaws.drs#UpdateFailbackReplicationConfiguration" - } - ], - "collectionOperations": [ - { - "target": "com.amazonaws.drs#StartFailbackLaunch" + "com.amazonaws.drs#UpdateReplicationConfigurationRequest": { + "type": "structure", + "members": { + "sourceServerID": { + "target": "com.amazonaws.drs#SourceServerID", + "traits": { + "smithy.api#documentation": "

The ID of the Source Server for this Replication Configuration.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.drs#SmallBoundedString", + "traits": { + "smithy.api#documentation": "

The name of the Replication Configuration.

" + } + }, + "stagingAreaSubnetId": { + "target": "com.amazonaws.drs#SubnetID", + "traits": { + "smithy.api#documentation": "

The subnet to be used by the replication staging area.

" + } + }, + "associateDefaultSecurityGroup": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration.

" + } + }, + "replicationServersSecurityGroupsIDs": { + "target": "com.amazonaws.drs#ReplicationServersSecurityGroupsIDs", + "traits": { + "smithy.api#documentation": "

The security group IDs that will be used by the replication server.

" + } + }, + "replicationServerInstanceType": { + "target": "com.amazonaws.drs#EC2InstanceType", + "traits": { + "smithy.api#documentation": "

The instance type to be used for the replication server.

" + } + }, + "useDedicatedReplicationServer": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to use a dedicated Replication Server in the replication staging area.

" + } + }, + "defaultLargeStagingDiskType": { + "target": "com.amazonaws.drs#ReplicationConfigurationDefaultLargeStagingDiskType", + "traits": { + "smithy.api#documentation": "

The Staging Disk EBS volume type to be used during replication.

" + } + }, + "replicatedDisks": { + "target": "com.amazonaws.drs#ReplicationConfigurationReplicatedDisks", + "traits": { + "smithy.api#documentation": "

The configuration of the disks of the Source Server to be replicated.

" + } + }, + "ebsEncryption": { + "target": "com.amazonaws.drs#ReplicationConfigurationEbsEncryption", + "traits": { + "smithy.api#documentation": "

The type of EBS encryption to be used during replication.

" + } + }, + "ebsEncryptionKeyArn": { + "target": "com.amazonaws.drs#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the EBS encryption key to be used during replication.

" + } + }, + "bandwidthThrottling": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.

" + } + }, + "dataPlaneRouting": { + "target": "com.amazonaws.drs#ReplicationConfigurationDataPlaneRouting", + "traits": { + "smithy.api#documentation": "

The data plane routing mechanism that will be used for replication.

" + } + }, + "createPublicIP": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to create a Public IP for the Recovery Instance by default.

" + } + }, + "stagingAreaTags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "

A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.

" + } + }, + "pitPolicy": { + "target": "com.amazonaws.drs#PITPolicy", + "traits": { + "smithy.api#documentation": "

The Point in time (PIT) policy to manage snapshots taken during replication.

" + } + }, + "autoReplicateNewDisks": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to allow the AWS replication agent to automatically replicate newly added disks.

" + } + } + } }, - { - "target": "com.amazonaws.drs#TerminateRecoveryInstances" - } - ], - "traits": { - "aws.api#arn": { - "template": "recovery-instance/{recoveryInstanceID}" - }, - "aws.iam#conditionKeys": ["drs:EC2InstanceARN", "aws:ResourceTag"], - "aws.iam#disableConditionKeyInference": {} - } - }, - "com.amazonaws.drs#RecoveryInstancesForTerminationRequest": { - "type": "list", - "member": { - "target": "com.amazonaws.drs#RecoveryInstanceID" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.drs#RecoverySnapshot": { - "type": "structure", - "members": { - "snapshotID": { - "target": "com.amazonaws.drs#RecoverySnapshotID", - "traits": { - "smithy.api#documentation": "

The ID of the Recovery Snapshot.

", - "smithy.api#required": {} - } - }, - "sourceServerID": { - "target": "com.amazonaws.drs#SourceServerID", - "traits": { - "smithy.api#documentation": "

The ID of the Source Server that the snapshot was taken for.

", - "smithy.api#required": {} - } - }, - "expectedTimestamp": { - "target": "com.amazonaws.drs#ISO8601DatetimeString", - "traits": { - "smithy.api#documentation": "

The timestamp of when we expect the snapshot to be taken.

", - "smithy.api#required": {} - } - }, - "timestamp": { - "target": "com.amazonaws.drs#ISO8601DatetimeString", - "traits": { - "smithy.api#documentation": "

The actual timestamp that the snapshot was taken.

" - } - }, - "ebsSnapshots": { - "target": "com.amazonaws.drs#EbsSnapshotsList", - "traits": { - "smithy.api#documentation": "

A list of EBS snapshots.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A snapshot of a Source Server used during recovery.

" - } - }, - "com.amazonaws.drs#RecoverySnapshotID": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 21, - "max": 21 - }, - "smithy.api#pattern": "^pit-[0-9a-zA-Z]{17}$" - } - }, - "com.amazonaws.drs#RecoverySnapshotsList": { - "type": "list", - "member": { - "target": "com.amazonaws.drs#RecoverySnapshot" - } - }, - "com.amazonaws.drs#RecoverySnapshotsOrder": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "ASC", - "value": "ASC" - }, - { - "name": "DESC", - "value": "DESC" - } - ] - } - }, - "com.amazonaws.drs#ReplicationConfiguration": { - "type": "structure", - "members": { - "sourceServerID": { - "target": "com.amazonaws.drs#SourceServerID", - "traits": { - "smithy.api#documentation": "

The ID of the Source Server for this Replication Configuration.

" - } - }, - "name": { - "target": "com.amazonaws.drs#SmallBoundedString", - "traits": { - "smithy.api#documentation": "

The name of the Replication Configuration.

" - } - }, - "stagingAreaSubnetId": { - "target": "com.amazonaws.drs#SubnetID", - "traits": { - "smithy.api#documentation": "

The subnet to be used by the replication staging area.

" - } - }, - "associateDefaultSecurityGroup": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration.

" - } - }, - "replicationServersSecurityGroupsIDs": { - "target": "com.amazonaws.drs#ReplicationServersSecurityGroupsIDs", - "traits": { - "smithy.api#documentation": "

The security group IDs that will be used by the replication server.

" - } - }, - "replicationServerInstanceType": { - "target": "com.amazonaws.drs#EC2InstanceType", - "traits": { - "smithy.api#documentation": "

The instance type to be used for the replication server.

" - } - }, - "useDedicatedReplicationServer": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to use a dedicated Replication Server in the replication staging area.

" - } - }, - "defaultLargeStagingDiskType": { - "target": "com.amazonaws.drs#ReplicationConfigurationDefaultLargeStagingDiskType", - "traits": { - "smithy.api#documentation": "

The Staging Disk EBS volume type to be used during replication.

" - } - }, - "replicatedDisks": { - "target": "com.amazonaws.drs#ReplicationConfigurationReplicatedDisks", - "traits": { - "smithy.api#documentation": "

The configuration of the disks of the Source Server to be replicated.

" - } - }, - "ebsEncryption": { - "target": "com.amazonaws.drs#ReplicationConfigurationEbsEncryption", - "traits": { - "smithy.api#documentation": "

The type of EBS encryption to be used during replication.

" - } - }, - "ebsEncryptionKeyArn": { - "target": "com.amazonaws.drs#ARN", - "traits": { - "smithy.api#documentation": "

The ARN of the EBS encryption key to be used during replication.

" - } - }, - "bandwidthThrottling": { - "target": "com.amazonaws.drs#PositiveInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.

" - } - }, - "dataPlaneRouting": { - "target": "com.amazonaws.drs#ReplicationConfigurationDataPlaneRouting", - "traits": { - "smithy.api#documentation": "

The data plane routing mechanism that will be used for replication.

" - } - }, - "createPublicIP": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to create a Public IP for the Recovery Instance by default.

" - } - }, - "stagingAreaTags": { - "target": "com.amazonaws.drs#TagsMap", - "traits": { - "smithy.api#documentation": "

A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.

" - } - }, - "pitPolicy": { - "target": "com.amazonaws.drs#PITPolicy", - "traits": { - "smithy.api#documentation": "

The Point in time (PIT) policy to manage snapshots taken during replication.

" - } - }, - "autoReplicateNewDisks": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to allow the AWS replication agent to automatically replicate newly added disks.

" - } - } - } - }, - "com.amazonaws.drs#ReplicationConfigurationDataPlaneRouting": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PRIVATE_IP", - "name": "PRIVATE_IP" - }, - { - "value": "PUBLIC_IP", - "name": "PUBLIC_IP" - } - ] - } - }, - "com.amazonaws.drs#ReplicationConfigurationDefaultLargeStagingDiskType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "GP2", - "name": "GP2" - }, - { - "value": "GP3", - "name": "GP3" - }, - { - "value": "ST1", - "name": "ST1" - }, - { - "value": "AUTO", - "name": "AUTO" - } - ] - } - }, - "com.amazonaws.drs#ReplicationConfigurationEbsEncryption": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DEFAULT", - "name": "DEFAULT" - }, - { - "value": "CUSTOM", - "name": "CUSTOM" - } - ] - } - }, - "com.amazonaws.drs#ReplicationConfigurationReplicatedDisk": { - "type": "structure", - "members": { - "deviceName": { - "target": "com.amazonaws.drs#BoundedString", - "traits": { - "smithy.api#documentation": "

The name of the device.

" - } - }, - "isBootDisk": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to boot from this disk or not.

" - } - }, - "stagingDiskType": { - "target": "com.amazonaws.drs#ReplicationConfigurationReplicatedDiskStagingDiskType", - "traits": { - "smithy.api#documentation": "

The Staging Disk EBS volume type to be used during replication.

" - } - }, - "iops": { - "target": "com.amazonaws.drs#PositiveInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The requested number of I/O operations per second (IOPS).

" - } - }, - "throughput": { - "target": "com.amazonaws.drs#PositiveInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The throughput to use for the EBS volume in MiB/s. This parameter is valid only for gp3 volumes.

" - } - }, - "optimizedStagingDiskType": { - "target": "com.amazonaws.drs#ReplicationConfigurationReplicatedDiskStagingDiskType", - "traits": { - "smithy.api#documentation": "

The Staging Disk EBS volume type to be used during replication when stagingDiskType is set to Auto. This is a read-only field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a disk of the Source Server to be replicated.

" - } - }, - "com.amazonaws.drs#ReplicationConfigurationReplicatedDiskStagingDiskType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AUTO", - "name": "AUTO" - }, - { - "value": "GP2", - "name": "GP2" - }, - { - "value": "GP3", - "name": "GP3" - }, - { - "value": "IO1", - "name": "IO1" - }, - { - "value": "SC1", - "name": "SC1" - }, - { - "value": "ST1", - "name": "ST1" - }, - { - "value": "STANDARD", - "name": "STANDARD" - } - ] - } - }, - "com.amazonaws.drs#ReplicationConfigurationReplicatedDisks": { - "type": "list", - "member": { - "target": "com.amazonaws.drs#ReplicationConfigurationReplicatedDisk" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 60 - } - } - }, - "com.amazonaws.drs#ReplicationConfigurationTemplate": { - "type": "structure", - "members": { - "replicationConfigurationTemplateID": { - "target": "com.amazonaws.drs#ReplicationConfigurationTemplateID", - "traits": { - "smithy.api#documentation": "

The Replication Configuration Template ID.

", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.drs#ARN", - "traits": { - "smithy.api#documentation": "

The Replication Configuration Template ARN.

" - } - }, - "stagingAreaSubnetId": { - "target": "com.amazonaws.drs#SubnetID", - "traits": { - "smithy.api#documentation": "

The subnet to be used by the replication staging area.

" - } - }, - "associateDefaultSecurityGroup": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.

" - } - }, - "replicationServersSecurityGroupsIDs": { - "target": "com.amazonaws.drs#ReplicationServersSecurityGroupsIDs", - "traits": { - "smithy.api#documentation": "

The security group IDs that will be used by the replication server.

" - } - }, - "replicationServerInstanceType": { - "target": "com.amazonaws.drs#EC2InstanceType", - "traits": { - "smithy.api#documentation": "

The instance type to be used for the replication server.

" - } - }, - "useDedicatedReplicationServer": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to use a dedicated Replication Server in the replication staging area.

" - } - }, - "defaultLargeStagingDiskType": { - "target": "com.amazonaws.drs#ReplicationConfigurationDefaultLargeStagingDiskType", - "traits": { - "smithy.api#documentation": "

The Staging Disk EBS volume type to be used during replication.

" - } - }, - "ebsEncryption": { - "target": "com.amazonaws.drs#ReplicationConfigurationEbsEncryption", - "traits": { - "smithy.api#documentation": "

The type of EBS encryption to be used during replication.

" - } - }, - "ebsEncryptionKeyArn": { - "target": "com.amazonaws.drs#ARN", - "traits": { - "smithy.api#documentation": "

The ARN of the EBS encryption key to be used during replication.

" - } - }, - "bandwidthThrottling": { - "target": "com.amazonaws.drs#PositiveInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.

" - } - }, - "dataPlaneRouting": { - "target": "com.amazonaws.drs#ReplicationConfigurationDataPlaneRouting", - "traits": { - "smithy.api#documentation": "

The data plane routing mechanism that will be used for replication.

" - } - }, - "createPublicIP": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to create a Public IP for the Recovery Instance by default.

" - } - }, - "stagingAreaTags": { - "target": "com.amazonaws.drs#TagsMap", - "traits": { - "smithy.api#documentation": "

A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.

" - } - }, - "tags": { - "target": "com.amazonaws.drs#TagsMap", - "traits": { - "smithy.api#documentation": "

A set of tags to be associated with the Replication Configuration Template resource.

" - } - }, - "pitPolicy": { - "target": "com.amazonaws.drs#PITPolicy", - "traits": { - "smithy.api#documentation": "

The Point in time (PIT) policy to manage snapshots taken during replication.

" - } - }, - "autoReplicateNewDisks": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to allow the AWS replication agent to automatically replicate newly added disks.

" - } - } - } - }, - "com.amazonaws.drs#ReplicationConfigurationTemplateID": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 21, - "max": 21 - }, - "smithy.api#pattern": "^rct-[0-9a-zA-Z]{17}$" - } - }, - "com.amazonaws.drs#ReplicationConfigurationTemplateIDs": { - "type": "list", - "member": { - "target": "com.amazonaws.drs#ReplicationConfigurationTemplateID" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.drs#ReplicationConfigurationTemplateResource": { - "type": "resource", - "identifiers": { - "replicationConfigurationTemplateID": { - "target": "com.amazonaws.drs#ReplicationConfigurationTemplateID" - } - }, - "create": { - "target": "com.amazonaws.drs#CreateReplicationConfigurationTemplate" - }, - "update": { - "target": "com.amazonaws.drs#UpdateReplicationConfigurationTemplate" - }, - "delete": { - "target": "com.amazonaws.drs#DeleteReplicationConfigurationTemplate" - }, - "list": { - "target": "com.amazonaws.drs#DescribeReplicationConfigurationTemplates" - }, - "traits": { - "aws.api#arn": { - "template": "replication-configuration-template/{replicationConfigurationTemplateID}" - }, - "aws.iam#conditionKeys": ["aws:ResourceTag"], - "aws.iam#disableConditionKeyInference": {} - } - }, - "com.amazonaws.drs#ReplicationConfigurationTemplates": { - "type": "list", - "member": { - "target": "com.amazonaws.drs#ReplicationConfigurationTemplate" - } - }, - "com.amazonaws.drs#ReplicationDirection": { - "type": "string", - "traits": { - "smithy.api#documentation": "

Replication direction designates if this is a failover replication, or a failback replication. When a DRS agent is installed on an instance, the replication direction is failover. In cases where a recovery launch was made in the recovery location and a new recovery instance was created, and then a failback replication was initiated from that recovery instance back to the origin location, then the replication direction will be failback.

", - "smithy.api#enum": [ - { - "name": "FAILOVER", - "value": "FAILOVER" - }, - { - "name": "FAILBACK", - "value": "FAILBACK" - } - ] - } - }, - "com.amazonaws.drs#ReplicationServersSecurityGroupsIDs": { - "type": "list", - "member": { - "target": "com.amazonaws.drs#SecurityGroupID" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 32 - } - } - }, - "com.amazonaws.drs#ResourceNotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.drs#LargeBoundedString" - }, - "code": { - "target": "com.amazonaws.drs#LargeBoundedString" - }, - "resourceId": { - "target": "com.amazonaws.drs#LargeBoundedString", - "traits": { - "smithy.api#documentation": "

The ID of the resource.

" - } - }, - "resourceType": { - "target": "com.amazonaws.drs#LargeBoundedString", - "traits": { - "smithy.api#documentation": "

The type of the resource.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The resource for this operation was not found.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.drs#RetryDataReplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#RetryDataReplicationRequest" - }, - "output": { - "target": "com.amazonaws.drs#SourceServer" - }, - "errors": [ - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#UninitializedAccountException" - }, - { - "target": "com.amazonaws.drs#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "WARNING: RetryDataReplication is deprecated" - }, - "smithy.api#documentation": "

WARNING: RetryDataReplication is deprecated.\n Causes the data replication initiation sequence to begin immediately upon next Handshake for the specified Source Server ID, regardless of when the previous initiation started. This command will work only if the Source Server is stalled or is in a DISCONNECTED or STOPPED state.\n

", - "smithy.api#http": { - "uri": "/RetryDataReplication", - "method": "POST", - "code": 200 - } - } - }, - "com.amazonaws.drs#RetryDataReplicationRequest": { - "type": "structure", - "members": { - "sourceServerID": { - "target": "com.amazonaws.drs#SourceServerID", - "traits": { - "smithy.api#documentation": "

The ID of the Source Server whose data replication should be retried.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "WARNING: RetryDataReplication is deprecated" - } - } - }, - "com.amazonaws.drs#ReverseReplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#ReverseReplicationRequest" - }, - "output": { - "target": "com.amazonaws.drs#ReverseReplicationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.drs#AccessDeniedException" - }, - { - "target": "com.amazonaws.drs#ConflictException" - }, - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#UninitializedAccountException" - }, - { - "target": "com.amazonaws.drs#ValidationException" - } - ], - "traits": { - "aws.iam#requiredActions": [ - "ec2:DescribeInstances", - "drs:DescribeReplicationConfigurationTemplates", - "drs:DescribeSourceServers" - ], - "smithy.api#documentation": "

Start replication to origin / target region - applies only to protected instances that originated in EC2.\n For recovery instances on target region - starts replication back to origin region.\n For failback instances on origin region - starts replication to target region to re-protect them.\n

", - "smithy.api#http": { - "uri": "/ReverseReplication", - "method": "POST", - "code": 200 - } - } - }, - "com.amazonaws.drs#ReverseReplicationRequest": { - "type": "structure", - "members": { - "recoveryInstanceID": { - "target": "com.amazonaws.drs#RecoveryInstanceID", - "traits": { - "smithy.api#documentation": "

The ID of the Recovery Instance that we want to reverse the replication for.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.drs#ReverseReplicationResponse": { - "type": "structure", - "members": { - "reversedDirectionSourceServerArn": { - "target": "com.amazonaws.drs#SourceServerARN", - "traits": { - "smithy.api#documentation": "

ARN of created SourceServer.

" - } - } - } - }, - "com.amazonaws.drs#SecurityGroupID": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - }, - "smithy.api#pattern": "^sg-[0-9a-fA-F]{8,}$" - } - }, - "com.amazonaws.drs#ServiceQuotaExceededException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.drs#LargeBoundedString" - }, - "code": { - "target": "com.amazonaws.drs#LargeBoundedString" - }, - "resourceId": { - "target": "com.amazonaws.drs#LargeBoundedString", - "traits": { - "smithy.api#documentation": "

The ID of the resource.

" - } - }, - "resourceType": { - "target": "com.amazonaws.drs#LargeBoundedString", - "traits": { - "smithy.api#documentation": "

The type of the resource.

" - } - }, - "serviceCode": { - "target": "com.amazonaws.drs#LargeBoundedString", - "traits": { - "smithy.api#documentation": "

Service code.

" - } - }, - "quotaCode": { - "target": "com.amazonaws.drs#LargeBoundedString", - "traits": { - "smithy.api#documentation": "

Quota code.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The request could not be completed because its exceeded the service quota.

", - "smithy.api#error": "client", - "smithy.api#httpError": 402 - } - }, - "com.amazonaws.drs#SmallBoundedString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 128 - } - } - }, - "com.amazonaws.drs#SourceCloudProperties": { - "type": "structure", - "members": { - "originAccountID": { - "target": "com.amazonaws.drs#AccountID", - "traits": { - "smithy.api#documentation": "

AWS Account ID for an EC2-originated Source Server.

" - } - }, - "originRegion": { - "target": "com.amazonaws.drs#AwsRegion", - "traits": { - "smithy.api#documentation": "

AWS Region for an EC2-originated Source Server.

" - } - }, - "originAvailabilityZone": { - "target": "com.amazonaws.drs#AwsAvailabilityZone", - "traits": { - "smithy.api#documentation": "

AWS Availability Zone for an EC2-originated Source Server.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Properties of the cloud environment where this Source Server originated from.

" - } - }, - "com.amazonaws.drs#SourceProperties": { - "type": "structure", - "members": { - "lastUpdatedDateTime": { - "target": "com.amazonaws.drs#ISO8601DatetimeString", - "traits": { - "smithy.api#documentation": "

The date and time the Source Properties were last updated on.

" - } - }, - "recommendedInstanceType": { - "target": "com.amazonaws.drs#EC2InstanceType", - "traits": { - "smithy.api#documentation": "

The recommended EC2 instance type that will be used when recovering the Source Server.

" - } - }, - "identificationHints": { - "target": "com.amazonaws.drs#IdentificationHints", - "traits": { - "smithy.api#documentation": "

Hints used to uniquely identify a machine.

" - } - }, - "networkInterfaces": { - "target": "com.amazonaws.drs#NetworkInterfaces", - "traits": { - "smithy.api#documentation": "

An array of network interfaces.

" - } - }, - "disks": { - "target": "com.amazonaws.drs#Disks", - "traits": { - "smithy.api#documentation": "

An array of disks.

" - } - }, - "cpus": { - "target": "com.amazonaws.drs#Cpus", - "traits": { - "smithy.api#documentation": "

An array of CPUs.

" - } - }, - "ramBytes": { - "target": "com.amazonaws.drs#PositiveInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The amount of RAM in bytes.

" - } - }, - "os": { - "target": "com.amazonaws.drs#OS", - "traits": { - "smithy.api#documentation": "

Operating system.

" - } - }, - "supportsNitroInstances": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Are EC2 nitro instance types supported when recovering the Source Server.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Properties of the Source Server machine.

" - } - }, - "com.amazonaws.drs#SourceServer": { - "type": "structure", - "members": { - "sourceServerID": { - "target": "com.amazonaws.drs#SourceServerID", - "traits": { - "smithy.api#documentation": "

The ID of the Source Server.

" - } - }, - "arn": { - "target": "com.amazonaws.drs#ARN", - "traits": { - "smithy.api#documentation": "

The ARN of the Source Server.

" - } - }, - "tags": { - "target": "com.amazonaws.drs#TagsMap", - "traits": { - "smithy.api#documentation": "

The tags associated with the Source Server.

" - } - }, - "recoveryInstanceId": { - "target": "com.amazonaws.drs#RecoveryInstanceID", - "traits": { - "smithy.api#documentation": "

The ID of the Recovery Instance associated with this Source Server.

" - } - }, - "lastLaunchResult": { - "target": "com.amazonaws.drs#LastLaunchResult", - "traits": { - "smithy.api#documentation": "

The status of the last recovery launch of this Source Server.

" - } - }, - "dataReplicationInfo": { - "target": "com.amazonaws.drs#DataReplicationInfo", - "traits": { - "smithy.api#documentation": "

The Data Replication Info of the Source Server.

" - } - }, - "lifeCycle": { - "target": "com.amazonaws.drs#LifeCycle", - "traits": { - "smithy.api#documentation": "

The lifecycle information of this Source Server.

" - } - }, - "sourceProperties": { - "target": "com.amazonaws.drs#SourceProperties", - "traits": { - "smithy.api#documentation": "

The source properties of the Source Server.

" - } - }, - "stagingArea": { - "target": "com.amazonaws.drs#StagingArea", - "traits": { - "smithy.api#documentation": "

The staging area of the source server.

" - } - }, - "sourceCloudProperties": { - "target": "com.amazonaws.drs#SourceCloudProperties", - "traits": { - "smithy.api#documentation": "

Source cloud properties of the Source Server.

" - } - }, - "replicationDirection": { - "target": "com.amazonaws.drs#ReplicationDirection", - "traits": { - "smithy.api#documentation": "

Replication direction of the Source Server.

" - } - }, - "reversedDirectionSourceServerArn": { - "target": "com.amazonaws.drs#SourceServerARN", - "traits": { - "smithy.api#documentation": "

For EC2-originated Source Servers which have been failed over and then failed back, this value will mean the ARN of the Source Server on the opposite replication direction.

" - } - } - }, - "traits": { - "smithy.api#references": [ - { - "resource": "com.amazonaws.drs#SourceServerResource" - } - ] - } - }, - "com.amazonaws.drs#SourceServerARN": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:(?:[0-9a-zA-Z_-]+:){3}([0-9]{12,}):source-server/(s-[0-9a-zA-Z]{17})$" - } - }, - "com.amazonaws.drs#SourceServerID": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 19, - "max": 19 - }, - "smithy.api#pattern": "^s-[0-9a-zA-Z]{17}$" - } - }, - "com.amazonaws.drs#SourceServerIDs": { - "type": "list", - "member": { - "target": "com.amazonaws.drs#SourceServerID" - } - }, - "com.amazonaws.drs#SourceServerResource": { - "type": "resource", - "identifiers": { - "sourceServerID": { - "target": "com.amazonaws.drs#SourceServerID" - } - }, - "delete": { - "target": "com.amazonaws.drs#DeleteSourceServer" - }, - "list": { - "target": "com.amazonaws.drs#DescribeSourceServers" - }, - "operations": [ - { - "target": "com.amazonaws.drs#DescribeRecoverySnapshots" + "com.amazonaws.drs#UpdateReplicationConfigurationTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#UpdateReplicationConfigurationTemplateRequest" + }, + "output": { + "target": "com.amazonaws.drs#ReplicationConfigurationTemplate" + }, + "errors": [ + { + "target": "com.amazonaws.drs#AccessDeniedException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a ReplicationConfigurationTemplate by ID.

", + "smithy.api#http": { + "uri": "/UpdateReplicationConfigurationTemplate", + "method": "POST", + "code": 200 + } + } }, - { - "target": "com.amazonaws.drs#DisconnectSourceServer" + "com.amazonaws.drs#UpdateReplicationConfigurationTemplateRequest": { + "type": "structure", + "members": { + "replicationConfigurationTemplateID": { + "target": "com.amazonaws.drs#ReplicationConfigurationTemplateID", + "traits": { + "smithy.api#documentation": "

The Replication Configuration Template ID.

", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.drs#ARN", + "traits": { + "smithy.api#documentation": "

The Replication Configuration Template ARN.

" + } + }, + "stagingAreaSubnetId": { + "target": "com.amazonaws.drs#SubnetID", + "traits": { + "smithy.api#documentation": "

The subnet to be used by the replication staging area.

" + } + }, + "associateDefaultSecurityGroup": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.

" + } + }, + "replicationServersSecurityGroupsIDs": { + "target": "com.amazonaws.drs#ReplicationServersSecurityGroupsIDs", + "traits": { + "smithy.api#documentation": "

The security group IDs that will be used by the replication server.

" + } + }, + "replicationServerInstanceType": { + "target": "com.amazonaws.drs#EC2InstanceType", + "traits": { + "smithy.api#documentation": "

The instance type to be used for the replication server.

" + } + }, + "useDedicatedReplicationServer": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to use a dedicated Replication Server in the replication staging area.

" + } + }, + "defaultLargeStagingDiskType": { + "target": "com.amazonaws.drs#ReplicationConfigurationDefaultLargeStagingDiskType", + "traits": { + "smithy.api#documentation": "

The Staging Disk EBS volume type to be used during replication.

" + } + }, + "ebsEncryption": { + "target": "com.amazonaws.drs#ReplicationConfigurationEbsEncryption", + "traits": { + "smithy.api#documentation": "

The type of EBS encryption to be used during replication.

" + } + }, + "ebsEncryptionKeyArn": { + "target": "com.amazonaws.drs#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the EBS encryption key to be used during replication.

" + } + }, + "bandwidthThrottling": { + "target": "com.amazonaws.drs#PositiveInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.

" + } + }, + "dataPlaneRouting": { + "target": "com.amazonaws.drs#ReplicationConfigurationDataPlaneRouting", + "traits": { + "smithy.api#documentation": "

The data plane routing mechanism that will be used for replication.

" + } + }, + "createPublicIP": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to create a Public IP for the Recovery Instance by default.

" + } + }, + "stagingAreaTags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "

A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.

" + } + }, + "pitPolicy": { + "target": "com.amazonaws.drs#PITPolicy", + "traits": { + "smithy.api#documentation": "

The Point in time (PIT) policy to manage snapshots taken during replication.

" + } + }, + "autoReplicateNewDisks": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to allow the AWS replication agent to automatically replicate newly added disks.

" + } + } + } }, - { - "target": "com.amazonaws.drs#GetLaunchConfiguration" + "com.amazonaws.drs#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.drs#LargeBoundedString" + }, + "code": { + "target": "com.amazonaws.drs#LargeBoundedString" + }, + "reason": { + "target": "com.amazonaws.drs#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "

Validation exception reason.

" + } + }, + "fieldList": { + "target": "com.amazonaws.drs#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "

A list of fields that failed validation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The input fails to satisfy the constraints specified by the AWS service.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.drs#GetReplicationConfiguration" + "com.amazonaws.drs#ValidationExceptionField": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "

Validate exception field name.

" + } + }, + "message": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "

Validate exception field message.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Validate exception field.

" + } }, - { - "target": "com.amazonaws.drs#RetryDataReplication" + "com.amazonaws.drs#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#ValidationExceptionField" + } }, - { - "target": "com.amazonaws.drs#StartReplication" + "com.amazonaws.drs#ValidationExceptionReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "unknownOperation", + "name": "UNKNOWN_OPERATION" + }, + { + "value": "cannotParse", + "name": "CANNOT_PARSE" + }, + { + "value": "fieldValidationFailed", + "name": "FIELD_VALIDATION_FAILED" + }, + { + "value": "other", + "name": "OTHER" + } + ] + } }, - { - "target": "com.amazonaws.drs#StopReplication" + "com.amazonaws.drs#VolumeToConversionMap": { + "type": "map", + "key": { + "target": "com.amazonaws.drs#LargeBoundedString" + }, + "value": { + "target": "com.amazonaws.drs#ConversionMap" + } }, - { - "target": "com.amazonaws.drs#UpdateLaunchConfiguration" + "com.amazonaws.drs#VolumeToSizeMap": { + "type": "map", + "key": { + "target": "com.amazonaws.drs#LargeBoundedString" + }, + "value": { + "target": "com.amazonaws.drs#PositiveInteger" + } }, - { - "target": "com.amazonaws.drs#UpdateReplicationConfiguration" - } - ], - "collectionOperations": [ - { - "target": "com.amazonaws.drs#StartRecovery" - } - ], - "traits": { - "aws.api#arn": { - "template": "source-server/{sourceServerID}" - }, - "aws.iam#conditionKeys": ["aws:ResourceTag"], - "aws.iam#disableConditionKeyInference": {} - } - }, - "com.amazonaws.drs#SourceServersList": { - "type": "list", - "member": { - "target": "com.amazonaws.drs#SourceServer" - } - }, - "com.amazonaws.drs#StagingArea": { - "type": "structure", - "members": { - "status": { - "target": "com.amazonaws.drs#ExtensionStatus", - "traits": { - "smithy.api#documentation": "

Status of Source server extension. Possible values:\n (a) NOT_EXTENDED - This is a source server that is replicating in the current account.\n (b) EXTENDED - Source server is extended from a staging source server. In this case, the value of stagingSourceServerArn is pointing to the Arn of the source server in the staging account.\n (c) EXTENSION_ERROR - Some issue occurred when accessing staging source server. In this case, errorMessage field will contain an error message that explains what happened.

" - } - }, - "stagingAccountID": { - "target": "com.amazonaws.drs#AccountID", - "traits": { - "smithy.api#documentation": "

Account ID of the account to which source server belongs. If this source server is extended - shows Account ID of staging source server.

" - } - }, - "stagingSourceServerArn": { - "target": "com.amazonaws.drs#ARN", - "traits": { - "smithy.api#documentation": "

Arn of the staging source server if this source server is extended

" - } - }, - "errorMessage": { - "target": "com.amazonaws.drs#LargeBoundedString", - "traits": { - "smithy.api#documentation": "

Shows an error message that occurred when DRS tried to access the staging source server. In this case StagingArea$status will have value EXTENSION_ERROR

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Staging information related to source server.

" - } - }, - "com.amazonaws.drs#StagingSourceServer": { - "type": "structure", - "members": { - "hostname": { - "target": "com.amazonaws.drs#BoundedString", - "traits": { - "smithy.api#documentation": "

Hostname of staging source server.

" - } - }, - "arn": { - "target": "com.amazonaws.drs#SourceServerARN", - "traits": { - "smithy.api#documentation": "

The ARN of the source server.

" - } - }, - "tags": { - "target": "com.amazonaws.drs#TagsMap", - "traits": { - "smithy.api#documentation": "

A list of tags associated with the staging source server.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Source server in staging account that extended source server connected to.

" - } - }, - "com.amazonaws.drs#StagingSourceServersList": { - "type": "list", - "member": { - "target": "com.amazonaws.drs#StagingSourceServer" - } - }, - "com.amazonaws.drs#StartFailbackLaunch": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#StartFailbackLaunchRequest" - }, - "output": { - "target": "com.amazonaws.drs#StartFailbackLaunchResponse" - }, - "errors": [ - { - "target": "com.amazonaws.drs#ConflictException" - }, - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#UninitializedAccountException" - }, - { - "target": "com.amazonaws.drs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Initiates a Job for launching the machine that is being failed back to from the specified Recovery Instance. This will run conversion on the failback client and will reboot your machine, thus completing the failback process.

", - "smithy.api#http": { - "uri": "/StartFailbackLaunch", - "method": "POST", - "code": 200 - } - } - }, - "com.amazonaws.drs#StartFailbackLaunchRequest": { - "type": "structure", - "members": { - "recoveryInstanceIDs": { - "target": "com.amazonaws.drs#StartFailbackRequestRecoveryInstanceIDs", - "traits": { - "smithy.api#documentation": "

The IDs of the Recovery Instance whose failback launch we want to request.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.drs#TagsMap", - "traits": { - "smithy.api#documentation": "

The tags to be associated with the failback launch Job.

" - } - } - } - }, - "com.amazonaws.drs#StartFailbackLaunchResponse": { - "type": "structure", - "members": { - "job": { - "target": "com.amazonaws.drs#Job", - "traits": { - "smithy.api#documentation": "

The failback launch Job.

" - } - } - } - }, - "com.amazonaws.drs#StartFailbackRequestRecoveryInstanceIDs": { - "type": "list", - "member": { - "target": "com.amazonaws.drs#RecoveryInstanceID" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.drs#StartRecovery": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#StartRecoveryRequest" - }, - "output": { - "target": "com.amazonaws.drs#StartRecoveryResponse" - }, - "errors": [ - { - "target": "com.amazonaws.drs#ConflictException" - }, - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#UninitializedAccountException" - } - ], - "traits": { - "aws.iam#requiredActions": [ - "ec2:DetachVolume", - "ec2:DescribeInstances", - "ec2:TerminateInstances", - "ec2:CreateTags", - "ec2:DescribeLaunchTemplateVersions", - "ec2:RunInstances", - "ec2:DescribeSnapshots", - "ec2:StopInstances", - "ec2:CreateLaunchTemplateVersion", - "ec2:DeleteVolume", - "ec2:StartInstances", - "ec2:DescribeVolumes", - "ec2:DeleteLaunchTemplateVersions", - "ec2:AttachVolume", - "ec2:AuthorizeSecurityGroupEgress", - "ec2:AuthorizeSecurityGroupIngress", - "ec2:CreateLaunchTemplate", - "ec2:CreateSnapshot", - "ec2:CreateVolume", - "ec2:DeleteSnapshot", - "ec2:DescribeImages", - "ec2:DescribeInstanceAttribute", - "ec2:DescribeInstanceStatus", - "ec2:DescribeLaunchTemplates", - "ec2:DescribeSecurityGroups", - "ec2:DescribeSubnets", - "ec2:ModifyInstanceAttribute", - "ec2:ModifyLaunchTemplate", - "ec2:RevokeSecurityGroupEgress", - "ec2:DescribeAccountAttributes", - "ec2:DescribeAvailabilityZones", - "ec2:DescribeInstanceTypes", - "iam:PassRole", - "drs:CreateRecoveryInstanceForDrs", - "drs:ListTagsForResource" - ], - "smithy.api#documentation": "

Launches Recovery Instances for the specified Source Servers. For each Source Server you may choose a point in time snapshot to launch from, or use an on demand snapshot.

", - "smithy.api#http": { - "uri": "/StartRecovery", - "method": "POST", - "code": 202 - } - } - }, - "com.amazonaws.drs#StartRecoveryRequest": { - "type": "structure", - "members": { - "sourceServers": { - "target": "com.amazonaws.drs#StartRecoveryRequestSourceServers", - "traits": { - "smithy.api#documentation": "

The Source Servers that we want to start a Recovery Job for.

", - "smithy.api#required": {} - } - }, - "isDrill": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Whether this Source Server Recovery operation is a drill or not.

" - } - }, - "tags": { - "target": "com.amazonaws.drs#TagsMap", - "traits": { - "smithy.api#documentation": "

The tags to be associated with the Recovery Job.

" - } - } - } - }, - "com.amazonaws.drs#StartRecoveryRequestSourceServer": { - "type": "structure", - "members": { - "sourceServerID": { - "target": "com.amazonaws.drs#SourceServerID", - "traits": { - "smithy.api#documentation": "

The ID of the Source Server you want to recover.

", - "smithy.api#required": {} - } - }, - "recoverySnapshotID": { - "target": "com.amazonaws.drs#RecoverySnapshotID", - "traits": { - "smithy.api#documentation": "

The ID of a Recovery Snapshot we want to recover from. Omit this field to launch from the latest data by taking an on-demand snapshot.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An object representing the Source Server to recover.

" - } - }, - "com.amazonaws.drs#StartRecoveryRequestSourceServers": { - "type": "list", - "member": { - "target": "com.amazonaws.drs#StartRecoveryRequestSourceServer" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.drs#StartRecoveryResponse": { - "type": "structure", - "members": { - "job": { - "target": "com.amazonaws.drs#Job", - "traits": { - "smithy.api#documentation": "

The Recovery Job.

" - } - } - } - }, - "com.amazonaws.drs#StartReplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#StartReplicationRequest" - }, - "output": { - "target": "com.amazonaws.drs#StartReplicationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.drs#ConflictException" - }, - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#UninitializedAccountException" - } - ], - "traits": { - "smithy.api#documentation": "

Starts replication for a stopped Source Server. This action would make the Source Server protected again and restart billing for it.

", - "smithy.api#http": { - "uri": "/StartReplication", - "method": "POST", - "code": 200 - } - } - }, - "com.amazonaws.drs#StartReplicationRequest": { - "type": "structure", - "members": { - "sourceServerID": { - "target": "com.amazonaws.drs#SourceServerID", - "traits": { - "smithy.api#documentation": "

The ID of the Source Server to start replication for.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.drs#StartReplicationResponse": { - "type": "structure", - "members": { - "sourceServer": { - "target": "com.amazonaws.drs#SourceServer", - "traits": { - "smithy.api#documentation": "

The Source Server that this action was targeted on.

" - } - } - } - }, - "com.amazonaws.drs#StopFailback": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#StopFailbackRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#UninitializedAccountException" - } - ], - "traits": { - "smithy.api#documentation": "

Stops the failback process for a specified Recovery Instance. This changes the Failback State of the Recovery Instance back to FAILBACK_NOT_STARTED.

", - "smithy.api#http": { - "uri": "/StopFailback", - "method": "POST", - "code": 200 - } - } - }, - "com.amazonaws.drs#StopFailbackRequest": { - "type": "structure", - "members": { - "recoveryInstanceID": { - "target": "com.amazonaws.drs#RecoveryInstanceID", - "traits": { - "smithy.api#documentation": "

The ID of the Recovery Instance we want to stop failback for.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.drs#StopReplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#StopReplicationRequest" - }, - "output": { - "target": "com.amazonaws.drs#StopReplicationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.drs#ConflictException" - }, - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#UninitializedAccountException" - } - ], - "traits": { - "smithy.api#documentation": "

Stops replication for a Source Server. This action would make the Source Server unprotected, delete its existing snapshots and stop billing for it.

", - "smithy.api#http": { - "uri": "/StopReplication", - "method": "POST", - "code": 200 - } - } - }, - "com.amazonaws.drs#StopReplicationRequest": { - "type": "structure", - "members": { - "sourceServerID": { - "target": "com.amazonaws.drs#SourceServerID", - "traits": { - "smithy.api#documentation": "

The ID of the Source Server to stop replication for.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.drs#StopReplicationResponse": { - "type": "structure", - "members": { - "sourceServer": { - "target": "com.amazonaws.drs#SourceServer", - "traits": { - "smithy.api#documentation": "

The Source Server that this action was targeted on.

" - } - } - } - }, - "com.amazonaws.drs#StrictlyPositiveInteger": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.drs#SubnetID": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - }, - "smithy.api#pattern": "^subnet-[0-9a-fA-F]{8,}$" - } - }, - "com.amazonaws.drs#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.drs#TagKeys": { - "type": "list", - "member": { - "target": "com.amazonaws.drs#TagKey" - }, - "traits": { - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.drs#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#TagResourceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.drs#AccessDeniedException" - }, - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Adds or overwrites only the specified tags for the specified Elastic Disaster Recovery resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value.

", - "smithy.api#http": { - "method": "POST", - "uri": "/tags/{resourceArn}" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.drs#TagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.drs#ARN", - "traits": { - "smithy.api#documentation": "

ARN of the resource for which tags are to be added or updated.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.drs#TagsMap", - "traits": { - "smithy.api#documentation": "

Array of tags to be added or updated.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.drs#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.drs#TagsMap": { - "type": "map", - "key": { - "target": "com.amazonaws.drs#TagKey" - }, - "value": { - "target": "com.amazonaws.drs#TagValue" - }, - "traits": { - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.drs#TargetInstanceTypeRightSizingMethod": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "NONE", - "value": "NONE" - }, - { - "name": "BASIC", - "value": "BASIC" - } - ] - } - }, - "com.amazonaws.drs#TerminateRecoveryInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#TerminateRecoveryInstancesRequest" - }, - "output": { - "target": "com.amazonaws.drs#TerminateRecoveryInstancesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.drs#ConflictException" - }, - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#UninitializedAccountException" - } - ], - "traits": { - "aws.iam#requiredActions": [ - "ec2:DescribeVolumes", - "ec2:DescribeInstances", - "ec2:TerminateInstances", - "ec2:DeleteVolume", - "drs:DescribeSourceServers" - ], - "smithy.api#documentation": "

Initiates a Job for terminating the EC2 resources associated with the specified Recovery Instances, and then will delete the Recovery Instances from the Elastic Disaster Recovery service.

", - "smithy.api#http": { - "uri": "/TerminateRecoveryInstances", - "method": "POST", - "code": 200 - } - } - }, - "com.amazonaws.drs#TerminateRecoveryInstancesRequest": { - "type": "structure", - "members": { - "recoveryInstanceIDs": { - "target": "com.amazonaws.drs#RecoveryInstancesForTerminationRequest", - "traits": { - "smithy.api#documentation": "

The IDs of the Recovery Instances that should be terminated.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.drs#TerminateRecoveryInstancesResponse": { - "type": "structure", - "members": { - "job": { - "target": "com.amazonaws.drs#Job", - "traits": { - "smithy.api#documentation": "

The Job for terminating the Recovery Instances.

" - } - } - } - }, - "com.amazonaws.drs#ThrottlingException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.drs#LargeBoundedString", - "traits": { - "smithy.api#required": {} - } - }, - "serviceCode": { - "target": "com.amazonaws.drs#LargeBoundedString", - "traits": { - "smithy.api#documentation": "

Service code.

" - } - }, - "quotaCode": { - "target": "com.amazonaws.drs#LargeBoundedString", - "traits": { - "smithy.api#documentation": "

Quota code.

" - } - }, - "retryAfterSeconds": { - "target": "com.amazonaws.drs#LargeBoundedString", - "traits": { - "smithy.api#documentation": "

The number of seconds after which the request should be safe to retry.

", - "smithy.api#httpHeader": "Retry-After" - } - } - }, - "traits": { - "smithy.api#documentation": "

The request was denied due to request throttling.

", - "smithy.api#error": "client", - "smithy.api#httpError": 429 - } - }, - "com.amazonaws.drs#UninitializedAccountException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.drs#LargeBoundedString" - }, - "code": { - "target": "com.amazonaws.drs#LargeBoundedString" - } - }, - "traits": { - "smithy.api#documentation": "

The account performing the request has not been initialized.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.drs#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#UntagResourceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.drs#AccessDeniedException" - }, - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the specified set of tags from the specified set of Elastic Disaster Recovery resources.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/tags/{resourceArn}" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.drs#UntagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.drs#ARN", - "traits": { - "smithy.api#documentation": "

ARN of the resource for which tags are to be removed.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tagKeys": { - "target": "com.amazonaws.drs#TagKeys", - "traits": { - "smithy.api#documentation": "

Array of tags to be removed.

", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.drs#UpdateFailbackReplicationConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#UpdateFailbackReplicationConfigurationRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.drs#AccessDeniedException" - }, - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#UninitializedAccountException" - } - ], - "traits": { - "smithy.api#documentation": "

Allows you to update the failback replication configuration of a Recovery Instance by ID.

", - "smithy.api#http": { - "uri": "/UpdateFailbackReplicationConfiguration", - "method": "POST", - "code": 200 - } - } - }, - "com.amazonaws.drs#UpdateFailbackReplicationConfigurationRequest": { - "type": "structure", - "members": { - "recoveryInstanceID": { - "target": "com.amazonaws.drs#RecoveryInstanceID", - "traits": { - "smithy.api#documentation": "

The ID of the Recovery Instance.

", - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.drs#BoundedString", - "traits": { - "smithy.api#documentation": "

The name of the Failback Replication Configuration.

" - } - }, - "bandwidthThrottling": { - "target": "com.amazonaws.drs#PositiveInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Configure bandwidth throttling for the outbound data transfer rate of the Recovery Instance in Mbps.

" - } - }, - "usePrivateIP": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to use Private IP for the failback replication of the Recovery Instance.

" - } - } - } - }, - "com.amazonaws.drs#UpdateLaunchConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#UpdateLaunchConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.drs#LaunchConfiguration" - }, - "errors": [ - { - "target": "com.amazonaws.drs#ConflictException" - }, - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#UninitializedAccountException" - }, - { - "target": "com.amazonaws.drs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a LaunchConfiguration by Source Server ID.

", - "smithy.api#http": { - "uri": "/UpdateLaunchConfiguration", - "method": "POST", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.drs#UpdateLaunchConfigurationRequest": { - "type": "structure", - "members": { - "sourceServerID": { - "target": "com.amazonaws.drs#SourceServerID", - "traits": { - "smithy.api#documentation": "

The ID of the Source Server that we want to retrieve a Launch Configuration for.

", - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.drs#SmallBoundedString", - "traits": { - "smithy.api#documentation": "

The name of the launch configuration.

" - } - }, - "launchDisposition": { - "target": "com.amazonaws.drs#LaunchDisposition", - "traits": { - "smithy.api#documentation": "

The state of the Recovery Instance in EC2 after the recovery operation.

" - } - }, - "targetInstanceTypeRightSizingMethod": { - "target": "com.amazonaws.drs#TargetInstanceTypeRightSizingMethod", - "traits": { - "smithy.api#documentation": "

Whether Elastic Disaster Recovery should try to automatically choose the instance type that best matches the OS, CPU, and RAM of your Source Server.

" - } - }, - "copyPrivateIp": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Whether we should copy the Private IP of the Source Server to the Recovery Instance.

" - } - }, - "copyTags": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Whether we want to copy the tags of the Source Server to the EC2 machine of the Recovery Instance.

" - } - }, - "licensing": { - "target": "com.amazonaws.drs#Licensing", - "traits": { - "smithy.api#documentation": "

The licensing configuration to be used for this launch configuration.

" - } - } - } - }, - "com.amazonaws.drs#UpdateLaunchConfigurationTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#UpdateLaunchConfigurationTemplateRequest" - }, - "output": { - "target": "com.amazonaws.drs#UpdateLaunchConfigurationTemplateResponse" - }, - "errors": [ - { - "target": "com.amazonaws.drs#AccessDeniedException" - }, - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#UninitializedAccountException" - }, - { - "target": "com.amazonaws.drs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates an existing Launch Configuration Template by ID.

", - "smithy.api#http": { - "uri": "/UpdateLaunchConfigurationTemplate", - "method": "POST", - "code": 200 - } - } - }, - "com.amazonaws.drs#UpdateLaunchConfigurationTemplateRequest": { - "type": "structure", - "members": { - "launchConfigurationTemplateID": { - "target": "com.amazonaws.drs#LaunchConfigurationTemplateID", - "traits": { - "smithy.api#documentation": "

Launch Configuration Template ID.

", - "smithy.api#required": {} - } - }, - "launchDisposition": { - "target": "com.amazonaws.drs#LaunchDisposition", - "traits": { - "smithy.api#documentation": "

Launch disposition.

" - } - }, - "targetInstanceTypeRightSizingMethod": { - "target": "com.amazonaws.drs#TargetInstanceTypeRightSizingMethod", - "traits": { - "smithy.api#documentation": "

Target instance type right-sizing method.

" - } - }, - "copyPrivateIp": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Copy private IP.

" - } - }, - "copyTags": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Copy tags.

" - } - }, - "licensing": { - "target": "com.amazonaws.drs#Licensing", - "traits": { - "smithy.api#documentation": "

Licensing.

" - } - } - } - }, - "com.amazonaws.drs#UpdateLaunchConfigurationTemplateResponse": { - "type": "structure", - "members": { - "launchConfigurationTemplate": { - "target": "com.amazonaws.drs#LaunchConfigurationTemplate", - "traits": { - "smithy.api#documentation": "

Updated Launch Configuration Template.

" - } - } - } - }, - "com.amazonaws.drs#UpdateReplicationConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#UpdateReplicationConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.drs#ReplicationConfiguration" - }, - "errors": [ - { - "target": "com.amazonaws.drs#AccessDeniedException" - }, - { - "target": "com.amazonaws.drs#ConflictException" - }, - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#UninitializedAccountException" - }, - { - "target": "com.amazonaws.drs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Allows you to update a ReplicationConfiguration by Source Server ID.

", - "smithy.api#http": { - "uri": "/UpdateReplicationConfiguration", - "method": "POST", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.drs#UpdateReplicationConfigurationRequest": { - "type": "structure", - "members": { - "sourceServerID": { - "target": "com.amazonaws.drs#SourceServerID", - "traits": { - "smithy.api#documentation": "

The ID of the Source Server for this Replication Configuration.

", - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.drs#SmallBoundedString", - "traits": { - "smithy.api#documentation": "

The name of the Replication Configuration.

" - } - }, - "stagingAreaSubnetId": { - "target": "com.amazonaws.drs#SubnetID", - "traits": { - "smithy.api#documentation": "

The subnet to be used by the replication staging area.

" - } - }, - "associateDefaultSecurityGroup": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration.

" - } - }, - "replicationServersSecurityGroupsIDs": { - "target": "com.amazonaws.drs#ReplicationServersSecurityGroupsIDs", - "traits": { - "smithy.api#documentation": "

The security group IDs that will be used by the replication server.

" - } - }, - "replicationServerInstanceType": { - "target": "com.amazonaws.drs#EC2InstanceType", - "traits": { - "smithy.api#documentation": "

The instance type to be used for the replication server.

" - } - }, - "useDedicatedReplicationServer": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to use a dedicated Replication Server in the replication staging area.

" - } - }, - "defaultLargeStagingDiskType": { - "target": "com.amazonaws.drs#ReplicationConfigurationDefaultLargeStagingDiskType", - "traits": { - "smithy.api#documentation": "

The Staging Disk EBS volume type to be used during replication.

" - } - }, - "replicatedDisks": { - "target": "com.amazonaws.drs#ReplicationConfigurationReplicatedDisks", - "traits": { - "smithy.api#documentation": "

The configuration of the disks of the Source Server to be replicated.

" - } - }, - "ebsEncryption": { - "target": "com.amazonaws.drs#ReplicationConfigurationEbsEncryption", - "traits": { - "smithy.api#documentation": "

The type of EBS encryption to be used during replication.

" - } - }, - "ebsEncryptionKeyArn": { - "target": "com.amazonaws.drs#ARN", - "traits": { - "smithy.api#documentation": "

The ARN of the EBS encryption key to be used during replication.

" - } - }, - "bandwidthThrottling": { - "target": "com.amazonaws.drs#PositiveInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.

" - } - }, - "dataPlaneRouting": { - "target": "com.amazonaws.drs#ReplicationConfigurationDataPlaneRouting", - "traits": { - "smithy.api#documentation": "

The data plane routing mechanism that will be used for replication.

" - } - }, - "createPublicIP": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to create a Public IP for the Recovery Instance by default.

" - } - }, - "stagingAreaTags": { - "target": "com.amazonaws.drs#TagsMap", - "traits": { - "smithy.api#documentation": "

A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.

" - } - }, - "pitPolicy": { - "target": "com.amazonaws.drs#PITPolicy", - "traits": { - "smithy.api#documentation": "

The Point in time (PIT) policy to manage snapshots taken during replication.

" - } - }, - "autoReplicateNewDisks": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to allow the AWS replication agent to automatically replicate newly added disks.

" - } - } - } - }, - "com.amazonaws.drs#UpdateReplicationConfigurationTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.drs#UpdateReplicationConfigurationTemplateRequest" - }, - "output": { - "target": "com.amazonaws.drs#ReplicationConfigurationTemplate" - }, - "errors": [ - { - "target": "com.amazonaws.drs#AccessDeniedException" - }, - { - "target": "com.amazonaws.drs#InternalServerException" - }, - { - "target": "com.amazonaws.drs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.drs#ThrottlingException" - }, - { - "target": "com.amazonaws.drs#UninitializedAccountException" - }, - { - "target": "com.amazonaws.drs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a ReplicationConfigurationTemplate by ID.

", - "smithy.api#http": { - "uri": "/UpdateReplicationConfigurationTemplate", - "method": "POST", - "code": 200 - } - } - }, - "com.amazonaws.drs#UpdateReplicationConfigurationTemplateRequest": { - "type": "structure", - "members": { - "replicationConfigurationTemplateID": { - "target": "com.amazonaws.drs#ReplicationConfigurationTemplateID", - "traits": { - "smithy.api#documentation": "

The Replication Configuration Template ID.

", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.drs#ARN", - "traits": { - "smithy.api#documentation": "

The Replication Configuration Template ARN.

" - } - }, - "stagingAreaSubnetId": { - "target": "com.amazonaws.drs#SubnetID", - "traits": { - "smithy.api#documentation": "

The subnet to be used by the replication staging area.

" - } - }, - "associateDefaultSecurityGroup": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.

" - } - }, - "replicationServersSecurityGroupsIDs": { - "target": "com.amazonaws.drs#ReplicationServersSecurityGroupsIDs", - "traits": { - "smithy.api#documentation": "

The security group IDs that will be used by the replication server.

" - } - }, - "replicationServerInstanceType": { - "target": "com.amazonaws.drs#EC2InstanceType", - "traits": { - "smithy.api#documentation": "

The instance type to be used for the replication server.

" - } - }, - "useDedicatedReplicationServer": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to use a dedicated Replication Server in the replication staging area.

" - } - }, - "defaultLargeStagingDiskType": { - "target": "com.amazonaws.drs#ReplicationConfigurationDefaultLargeStagingDiskType", - "traits": { - "smithy.api#documentation": "

The Staging Disk EBS volume type to be used during replication.

" - } - }, - "ebsEncryption": { - "target": "com.amazonaws.drs#ReplicationConfigurationEbsEncryption", - "traits": { - "smithy.api#documentation": "

The type of EBS encryption to be used during replication.

" - } - }, - "ebsEncryptionKeyArn": { - "target": "com.amazonaws.drs#ARN", - "traits": { - "smithy.api#documentation": "

The ARN of the EBS encryption key to be used during replication.

" - } - }, - "bandwidthThrottling": { - "target": "com.amazonaws.drs#PositiveInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.

" - } - }, - "dataPlaneRouting": { - "target": "com.amazonaws.drs#ReplicationConfigurationDataPlaneRouting", - "traits": { - "smithy.api#documentation": "

The data plane routing mechanism that will be used for replication.

" - } - }, - "createPublicIP": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to create a Public IP for the Recovery Instance by default.

" - } - }, - "stagingAreaTags": { - "target": "com.amazonaws.drs#TagsMap", - "traits": { - "smithy.api#documentation": "

A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.

" - } - }, - "pitPolicy": { - "target": "com.amazonaws.drs#PITPolicy", - "traits": { - "smithy.api#documentation": "

The Point in time (PIT) policy to manage snapshots taken during replication.

" - } - }, - "autoReplicateNewDisks": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to allow the AWS replication agent to automatically replicate newly added disks.

" - } - } - } - }, - "com.amazonaws.drs#ValidationException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.drs#LargeBoundedString" - }, - "code": { - "target": "com.amazonaws.drs#LargeBoundedString" - }, - "reason": { - "target": "com.amazonaws.drs#ValidationExceptionReason", - "traits": { - "smithy.api#documentation": "

Validation exception reason.

" - } - }, - "fieldList": { - "target": "com.amazonaws.drs#ValidationExceptionFieldList", - "traits": { - "smithy.api#documentation": "

A list of fields that failed validation.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The input fails to satisfy the constraints specified by the AWS service.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.drs#ValidationExceptionField": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.drs#LargeBoundedString", - "traits": { - "smithy.api#documentation": "

Validate exception field name.

" - } - }, - "message": { - "target": "com.amazonaws.drs#LargeBoundedString", - "traits": { - "smithy.api#documentation": "

Validate exception field message.

" - } + "com.amazonaws.drs#VpcID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 21 + }, + "smithy.api#pattern": "^vpc-[0-9a-fA-F]{8,}$" + } } - }, - "traits": { - "smithy.api#documentation": "

Validate exception field.

" - } - }, - "com.amazonaws.drs#ValidationExceptionFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.drs#ValidationExceptionField" - } - }, - "com.amazonaws.drs#ValidationExceptionReason": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "unknownOperation", - "name": "UNKNOWN_OPERATION" - }, - { - "value": "cannotParse", - "name": "CANNOT_PARSE" - }, - { - "value": "fieldValidationFailed", - "name": "FIELD_VALIDATION_FAILED" - }, - { - "value": "other", - "name": "OTHER" - } - ] - } - }, - "com.amazonaws.drs#VolumeToConversionMap": { - "type": "map", - "key": { - "target": "com.amazonaws.drs#LargeBoundedString" - }, - "value": { - "target": "com.amazonaws.drs#ConversionMap" - } - }, - "com.amazonaws.drs#VolumeToSizeMap": { - "type": "map", - "key": { - "target": "com.amazonaws.drs#LargeBoundedString" - }, - "value": { - "target": "com.amazonaws.drs#PositiveInteger" - } } - } -} +} \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/ec2.json b/codegen/sdk-codegen/aws-models/ec2.json index 0d717c9736d4..4d35d56d54a9 100644 --- a/codegen/sdk-codegen/aws-models/ec2.json +++ b/codegen/sdk-codegen/aws-models/ec2.json @@ -1,101222 +1,101714 @@ { - "smithy": "2.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] - }, - "shapes": { - "com.amazonaws.ec2#AcceleratorCount": { - "type": "structure", - "members": { - "Min": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Min", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum number of accelerators. If this parameter is not specified, there is no minimum\n limit.

", - "smithy.api#xmlName": "min" - } - }, - "Max": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Max", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of accelerators. If this parameter is not specified, there is no\n maximum limit.

", - "smithy.api#xmlName": "max" - } - } - }, - "traits": { - "smithy.api#documentation": "

The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips)\n on an instance.

" - } - }, - "com.amazonaws.ec2#AcceleratorCountRequest": { - "type": "structure", - "members": { - "Min": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum number of accelerators. To specify no minimum limit, omit this\n parameter.

" - } - }, - "Max": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of accelerators. To specify no maximum limit, omit this\n parameter. To exclude accelerator-enabled instance types, set Max to\n 0.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips)\n on an instance. To exclude accelerator-enabled instance types, set Max to\n 0.

" - } - }, - "com.amazonaws.ec2#AcceleratorManufacturer": { - "type": "enum", - "members": { - "NVIDIA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "nvidia" - } - }, - "AMD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "amd" - } - }, - "AMAZON_WEB_SERVICES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "amazon-web-services" - } - }, - "XILINX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "xilinx" - } - } - } - }, - "com.amazonaws.ec2#AcceleratorManufacturerSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#AcceleratorManufacturer", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#AcceleratorName": { - "type": "enum", - "members": { - "A100": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "a100" - } - }, - "V100": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "v100" - } - }, - "K80": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "k80" - } - }, - "T4": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "t4" - } - }, - "M60": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m60" - } - }, - "RADEON_PRO_V520": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "radeon-pro-v520" - } - }, - "VU9P": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "vu9p" - } - }, - "INFERENTIA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "inferentia" - } - }, - "K520": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "k520" - } - } - } - }, - "com.amazonaws.ec2#AcceleratorNameSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#AcceleratorName", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#AcceleratorTotalMemoryMiB": { - "type": "structure", - "members": { - "Min": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Min", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum amount of accelerator memory, in MiB. If this parameter is not specified,\n there is no minimum limit.

", - "smithy.api#xmlName": "min" - } - }, - "Max": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Max", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum amount of accelerator memory, in MiB. If this parameter is not specified,\n there is no maximum limit.

", - "smithy.api#xmlName": "max" - } - } - }, - "traits": { - "smithy.api#documentation": "

The minimum and maximum amount of total accelerator memory, in MiB.

" - } - }, - "com.amazonaws.ec2#AcceleratorTotalMemoryMiBRequest": { - "type": "structure", - "members": { - "Min": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this\n parameter.

" - } - }, - "Max": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this\n parameter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The minimum and maximum amount of total accelerator memory, in MiB.

" - } - }, - "com.amazonaws.ec2#AcceleratorType": { - "type": "enum", - "members": { - "GPU": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "gpu" - } - }, - "FPGA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "fpga" - } - }, - "INFERENCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "inference" - } - } - } - }, - "com.amazonaws.ec2#AcceleratorTypeSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#AcceleratorType", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#AcceptAddressTransfer": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#AcceptAddressTransferRequest" - }, - "output": { - "target": "com.amazonaws.ec2#AcceptAddressTransferResult" - }, - "traits": { - "smithy.api#documentation": "

Accepts an Elastic IP address transfer. For more information, see Accept a transferred Elastic IP address in the Amazon Virtual Private Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#AcceptAddressTransferRequest": { - "type": "structure", - "members": { - "Address": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Elastic IP address you are accepting for transfer.

", - "smithy.api#required": {} - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

\n tag: - 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.\n 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.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#AcceptAddressTransferResult": { - "type": "structure", - "members": { - "AddressTransfer": { - "target": "com.amazonaws.ec2#AddressTransfer", - "traits": { - "aws.protocols#ec2QueryName": "AddressTransfer", - "smithy.api#documentation": "

An Elastic IP address transfer.

", - "smithy.api#xmlName": "addressTransfer" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#AcceptReservedInstancesExchangeQuote": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#AcceptReservedInstancesExchangeQuoteRequest" - }, - "output": { - "target": "com.amazonaws.ec2#AcceptReservedInstancesExchangeQuoteResult" - }, - "traits": { - "smithy.api#documentation": "

Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.

" - } - }, - "com.amazonaws.ec2#AcceptReservedInstancesExchangeQuoteRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "ReservedInstanceIds": { - "target": "com.amazonaws.ec2#ReservedInstanceIdSet", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IDs of the Convertible Reserved Instances to exchange for another Convertible\n Reserved Instance of the same or higher value.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "ReservedInstanceId" - } - }, - "TargetConfigurations": { - "target": "com.amazonaws.ec2#TargetConfigurationRequestSet", - "traits": { - "smithy.api#documentation": "

The configuration of the target Convertible Reserved Instance to exchange for your\n current Convertible Reserved Instances.

", - "smithy.api#xmlName": "TargetConfiguration" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for accepting the quote.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#AcceptReservedInstancesExchangeQuoteResult": { - "type": "structure", - "members": { - "ExchangeId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ExchangeId", - "smithy.api#documentation": "

The ID of the successful exchange.

", - "smithy.api#xmlName": "exchangeId" - } - } - }, - "traits": { - "smithy.api#documentation": "

The result of the exchange and whether it was successful.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#AcceptTransitGatewayMulticastDomainAssociations": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#AcceptTransitGatewayMulticastDomainAssociationsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#AcceptTransitGatewayMulticastDomainAssociationsResult" - }, - "traits": { - "smithy.api#documentation": "

Accepts a request to associate subnets with a transit gateway multicast domain.

" - } - }, - "com.amazonaws.ec2#AcceptTransitGatewayMulticastDomainAssociationsRequest": { - "type": "structure", - "members": { - "TransitGatewayMulticastDomainId": { - "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", - "traits": { - "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

" - } - }, - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", - "traits": { - "smithy.api#documentation": "

The ID of the transit gateway attachment.

" - } - }, - "SubnetIds": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#documentation": "

The IDs of the subnets to associate with the transit gateway multicast domain.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#AcceptTransitGatewayMulticastDomainAssociationsResult": { - "type": "structure", - "members": { - "Associations": { - "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainAssociations", - "traits": { - "aws.protocols#ec2QueryName": "Associations", - "smithy.api#documentation": "

Information about the multicast domain associations.

", - "smithy.api#xmlName": "associations" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#AcceptTransitGatewayPeeringAttachment": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#AcceptTransitGatewayPeeringAttachmentRequest" - }, - "output": { - "target": "com.amazonaws.ec2#AcceptTransitGatewayPeeringAttachmentResult" - }, - "traits": { - "smithy.api#documentation": "

Accepts a transit gateway peering attachment request. The peering attachment must be\n in the pendingAcceptance state.

" - } - }, - "com.amazonaws.ec2#AcceptTransitGatewayPeeringAttachmentRequest": { - "type": "structure", - "members": { - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the transit gateway attachment.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#AcceptTransitGatewayPeeringAttachmentResult": { - "type": "structure", - "members": { - "TransitGatewayPeeringAttachment": { - "target": "com.amazonaws.ec2#TransitGatewayPeeringAttachment", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayPeeringAttachment", - "smithy.api#documentation": "

The transit gateway peering attachment.

", - "smithy.api#xmlName": "transitGatewayPeeringAttachment" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#AcceptTransitGatewayVpcAttachment": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#AcceptTransitGatewayVpcAttachmentRequest" - }, - "output": { - "target": "com.amazonaws.ec2#AcceptTransitGatewayVpcAttachmentResult" - }, - "traits": { - "smithy.api#documentation": "

Accepts a request to attach a VPC to a transit gateway.

\n

The VPC attachment must be in the pendingAcceptance state.\n Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests.\n Use RejectTransitGatewayVpcAttachment to reject a VPC attachment request.

" - } - }, - "com.amazonaws.ec2#AcceptTransitGatewayVpcAttachmentRequest": { - "type": "structure", - "members": { - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the attachment.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#AcceptTransitGatewayVpcAttachmentResult": { - "type": "structure", - "members": { - "TransitGatewayVpcAttachment": { - "target": "com.amazonaws.ec2#TransitGatewayVpcAttachment", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayVpcAttachment", - "smithy.api#documentation": "

The VPC attachment.

", - "smithy.api#xmlName": "transitGatewayVpcAttachment" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#AcceptVpcEndpointConnections": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#AcceptVpcEndpointConnectionsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#AcceptVpcEndpointConnectionsResult" - }, - "traits": { - "smithy.api#documentation": "

Accepts connection requests to your VPC endpoint service.

" - } - }, - "com.amazonaws.ec2#AcceptVpcEndpointConnectionsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "ServiceId": { - "target": "com.amazonaws.ec2#VpcEndpointServiceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the VPC endpoint service.

", - "smithy.api#required": {} - } - }, - "VpcEndpointIds": { - "target": "com.amazonaws.ec2#VpcEndpointIdList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IDs of the interface VPC endpoints.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "VpcEndpointId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#AcceptVpcEndpointConnectionsResult": { - "type": "structure", - "members": { - "Unsuccessful": { - "target": "com.amazonaws.ec2#UnsuccessfulItemSet", - "traits": { - "aws.protocols#ec2QueryName": "Unsuccessful", - "smithy.api#documentation": "

Information about the interface endpoints that were not accepted, if\n applicable.

", - "smithy.api#xmlName": "unsuccessful" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#AcceptVpcPeeringConnection": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#AcceptVpcPeeringConnectionRequest" - }, - "output": { - "target": "com.amazonaws.ec2#AcceptVpcPeeringConnectionResult" - }, - "traits": { - "smithy.api#documentation": "

Accept a VPC peering connection request. To accept a request, the VPC peering connection must\n be in the pending-acceptance state, and you must be the owner of the peer VPC.\n Use DescribeVpcPeeringConnections to view your outstanding VPC\n peering connection requests.

\n

For an inter-Region VPC peering connection request, you must accept the VPC peering\n connection in the Region of the accepter VPC.

" - } - }, - "com.amazonaws.ec2#AcceptVpcPeeringConnectionRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "VpcPeeringConnectionId": { - "target": "com.amazonaws.ec2#VpcPeeringConnectionIdWithResolver", - "traits": { - "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the VPC peering connection. You must specify this parameter in the\n\t\t\trequest.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "vpcPeeringConnectionId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#AcceptVpcPeeringConnectionResult": { - "type": "structure", - "members": { - "VpcPeeringConnection": { - "target": "com.amazonaws.ec2#VpcPeeringConnection", - "traits": { - "aws.protocols#ec2QueryName": "VpcPeeringConnection", - "smithy.api#documentation": "

Information about the VPC peering connection.

", - "smithy.api#xmlName": "vpcPeeringConnection" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#AccessScopeAnalysisFinding": { - "type": "structure", - "members": { - "NetworkInsightsAccessScopeAnalysisId": { - "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisId", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeAnalysisId", - "smithy.api#documentation": "

The ID of the Network Access Scope analysis.

", - "smithy.api#xmlName": "networkInsightsAccessScopeAnalysisId" - } - }, - "NetworkInsightsAccessScopeId": { - "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeId", - "smithy.api#documentation": "

The ID of the Network Access Scope.

", - "smithy.api#xmlName": "networkInsightsAccessScopeId" - } - }, - "FindingId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "FindingId", - "smithy.api#documentation": "

The ID of the finding.

", - "smithy.api#xmlName": "findingId" - } - }, - "FindingComponents": { - "target": "com.amazonaws.ec2#PathComponentList", - "traits": { - "aws.protocols#ec2QueryName": "FindingComponentSet", - "smithy.api#documentation": "

The finding components.

", - "smithy.api#xmlName": "findingComponentSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a finding for a Network Access Scope.

" - } - }, - "com.amazonaws.ec2#AccessScopeAnalysisFindingList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#AccessScopeAnalysisFinding", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#AccessScopePath": { - "type": "structure", - "members": { - "Source": { - "target": "com.amazonaws.ec2#PathStatement", - "traits": { - "aws.protocols#ec2QueryName": "Source", - "smithy.api#documentation": "

The source.

", - "smithy.api#xmlName": "source" - } - }, - "Destination": { - "target": "com.amazonaws.ec2#PathStatement", - "traits": { - "aws.protocols#ec2QueryName": "Destination", - "smithy.api#documentation": "

The destination.

", - "smithy.api#xmlName": "destination" - } - }, - "ThroughResources": { - "target": "com.amazonaws.ec2#ThroughResourcesStatementList", - "traits": { - "aws.protocols#ec2QueryName": "ThroughResourceSet", - "smithy.api#documentation": "

The through resources.

", - "smithy.api#xmlName": "throughResourceSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a path.

" - } - }, - "com.amazonaws.ec2#AccessScopePathList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#AccessScopePath", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#AccessScopePathListRequest": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#AccessScopePathRequest", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#AccessScopePathRequest": { - "type": "structure", - "members": { - "Source": { - "target": "com.amazonaws.ec2#PathStatementRequest", - "traits": { - "smithy.api#documentation": "

The source.

" - } - }, - "Destination": { - "target": "com.amazonaws.ec2#PathStatementRequest", - "traits": { - "smithy.api#documentation": "

The destination.

" - } - }, - "ThroughResources": { - "target": "com.amazonaws.ec2#ThroughResourcesStatementRequestList", - "traits": { - "smithy.api#documentation": "

The through resources.

", - "smithy.api#xmlName": "ThroughResource" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a path.

" - } - }, - "com.amazonaws.ec2#AccountAttribute": { - "type": "structure", - "members": { - "AttributeName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AttributeName", - "smithy.api#documentation": "

The name of the account attribute.

", - "smithy.api#xmlName": "attributeName" - } - }, - "AttributeValues": { - "target": "com.amazonaws.ec2#AccountAttributeValueList", - "traits": { - "aws.protocols#ec2QueryName": "AttributeValueSet", - "smithy.api#documentation": "

The values for the account attribute.

", - "smithy.api#xmlName": "attributeValueSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an account attribute.

" - } - }, - "com.amazonaws.ec2#AccountAttributeList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#AccountAttribute", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#AccountAttributeName": { - "type": "enum", - "members": { - "supported_platforms": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "supported-platforms" - } - }, - "default_vpc": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "default-vpc" - } - } - } - }, - "com.amazonaws.ec2#AccountAttributeNameStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#AccountAttributeName", - "traits": { - "smithy.api#xmlName": "attributeName" - } - } - }, - "com.amazonaws.ec2#AccountAttributeValue": { - "type": "structure", - "members": { - "AttributeValue": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AttributeValue", - "smithy.api#documentation": "

The value of the attribute.

", - "smithy.api#xmlName": "attributeValue" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a value of an account attribute.

" - } - }, - "com.amazonaws.ec2#AccountAttributeValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#AccountAttributeValue", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ActiveInstance": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#xmlName": "instanceId" - } - }, - "InstanceType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type.

", - "smithy.api#xmlName": "instanceType" - } - }, - "SpotInstanceRequestId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SpotInstanceRequestId", - "smithy.api#documentation": "

The ID of the Spot Instance request.

", - "smithy.api#xmlName": "spotInstanceRequestId" - } - }, - "InstanceHealth": { - "target": "com.amazonaws.ec2#InstanceHealthStatus", - "traits": { - "aws.protocols#ec2QueryName": "InstanceHealth", - "smithy.api#documentation": "

The health status of the instance. If the status of either the instance status check\n or the system status check is impaired, the health status of the instance\n is unhealthy. Otherwise, the health status is healthy.

", - "smithy.api#xmlName": "instanceHealth" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a running instance in a Spot Fleet.

" - } - }, - "com.amazonaws.ec2#ActiveInstanceSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ActiveInstance", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ActivityStatus": { - "type": "enum", - "members": { - "ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "error" - } - }, - "PENDING_FULFILLMENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending_fulfillment" - } - }, - "PENDING_TERMINATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending_termination" - } - }, - "FULFILLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "fulfilled" - } - } - } - }, - "com.amazonaws.ec2#AddIpamOperatingRegion": { - "type": "structure", - "members": { - "RegionName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The name of the operating Region.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Add an operating Region to an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

\n

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.\n

" - } - }, - "com.amazonaws.ec2#AddIpamOperatingRegionSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#AddIpamOperatingRegion" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.ec2#AddPrefixListEntries": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#AddPrefixListEntry" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.ec2#AddPrefixListEntry": { - "type": "structure", - "members": { - "Cidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The CIDR block.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A description for the entry.

\n

Constraints: Up to 255 characters in length.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An entry for a prefix list.

" - } - }, - "com.amazonaws.ec2#AddedPrincipal": { - "type": "structure", - "members": { - "PrincipalType": { - "target": "com.amazonaws.ec2#PrincipalType", - "traits": { - "aws.protocols#ec2QueryName": "PrincipalType", - "smithy.api#documentation": "

The type of principal.

", - "smithy.api#xmlName": "principalType" - } - }, - "Principal": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Principal", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the principal.

", - "smithy.api#xmlName": "principal" - } - }, - "ServicePermissionId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ServicePermissionId", - "smithy.api#documentation": "

The ID of the service permission.

", - "smithy.api#xmlName": "servicePermissionId" - } - }, - "ServiceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ServiceId", - "smithy.api#documentation": "

The ID of the service.

", - "smithy.api#xmlName": "serviceId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a principal.

" - } - }, - "com.amazonaws.ec2#AddedPrincipalSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#AddedPrincipal", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#AdditionalDetail": { - "type": "structure", - "members": { - "AdditionalDetailType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AdditionalDetailType", - "smithy.api#documentation": "

The additional detail code.

", - "smithy.api#xmlName": "additionalDetailType" - } - }, - "Component": { - "target": "com.amazonaws.ec2#AnalysisComponent", - "traits": { - "aws.protocols#ec2QueryName": "Component", - "smithy.api#documentation": "

The path component.

", - "smithy.api#xmlName": "component" - } - }, - "VpcEndpointService": { - "target": "com.amazonaws.ec2#AnalysisComponent", - "traits": { - "aws.protocols#ec2QueryName": "VpcEndpointService", - "smithy.api#documentation": "

The VPC endpoint service.

", - "smithy.api#xmlName": "vpcEndpointService" - } - }, - "RuleOptions": { - "target": "com.amazonaws.ec2#RuleOptionList", - "traits": { - "aws.protocols#ec2QueryName": "RuleOptionSet", - "smithy.api#documentation": "

The rule options.

", - "smithy.api#xmlName": "ruleOptionSet" - } - }, - "RuleGroupTypePairs": { - "target": "com.amazonaws.ec2#RuleGroupTypePairList", - "traits": { - "aws.protocols#ec2QueryName": "RuleGroupTypePairSet", - "smithy.api#documentation": "

The rule group type.

", - "smithy.api#xmlName": "ruleGroupTypePairSet" - } - }, - "RuleGroupRuleOptionsPairs": { - "target": "com.amazonaws.ec2#RuleGroupRuleOptionsPairList", - "traits": { - "aws.protocols#ec2QueryName": "RuleGroupRuleOptionsPairSet", - "smithy.api#documentation": "

The rule options.

", - "smithy.api#xmlName": "ruleGroupRuleOptionsPairSet" - } - }, - "ServiceName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ServiceName", - "smithy.api#documentation": "

The name of the VPC endpoint service.

", - "smithy.api#xmlName": "serviceName" - } - }, - "LoadBalancers": { - "target": "com.amazonaws.ec2#AnalysisComponentList", - "traits": { - "aws.protocols#ec2QueryName": "LoadBalancerSet", - "smithy.api#documentation": "

The load balancers.

", - "smithy.api#xmlName": "loadBalancerSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an additional detail for a path analysis. For more information, see Reachability Analyzer additional detail codes.

" - } - }, - "com.amazonaws.ec2#AdditionalDetailList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#AdditionalDetail", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#Address": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance that the address is associated with (if any).

", - "smithy.api#xmlName": "instanceId" - } - }, - "PublicIp": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PublicIp", - "smithy.api#documentation": "

The Elastic IP address.

", - "smithy.api#xmlName": "publicIp" - } - }, - "AllocationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AllocationId", - "smithy.api#documentation": "

The ID representing the allocation of the address for use with EC2-VPC.

", - "smithy.api#xmlName": "allocationId" - } - }, - "AssociationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AssociationId", - "smithy.api#documentation": "

The ID representing the association of the address with an instance in a VPC.

", - "smithy.api#xmlName": "associationId" - } - }, - "Domain": { - "target": "com.amazonaws.ec2#DomainType", - "traits": { - "aws.protocols#ec2QueryName": "Domain", - "smithy.api#documentation": "

Indicates whether this Elastic IP address is for use with instances\n\t\t\t\tin EC2-Classic (standard) or instances in a VPC (vpc).

", - "smithy.api#xmlName": "domain" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "

The ID of the network interface.

", - "smithy.api#xmlName": "networkInterfaceId" - } - }, - "NetworkInterfaceOwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceOwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the network interface.

", - "smithy.api#xmlName": "networkInterfaceOwnerId" - } - }, - "PrivateIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrivateIpAddress", - "smithy.api#documentation": "

The private IP address associated with the Elastic IP address.

", - "smithy.api#xmlName": "privateIpAddress" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the Elastic IP address.

", - "smithy.api#xmlName": "tagSet" - } - }, - "PublicIpv4Pool": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PublicIpv4Pool", - "smithy.api#documentation": "

The ID of an address pool.

", - "smithy.api#xmlName": "publicIpv4Pool" - } - }, - "NetworkBorderGroup": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NetworkBorderGroup", - "smithy.api#documentation": "

The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from\n which Amazon Web Services advertises IP addresses.

", - "smithy.api#xmlName": "networkBorderGroup" - } - }, - "CustomerOwnedIp": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CustomerOwnedIp", - "smithy.api#documentation": "

The customer-owned IP address.

", - "smithy.api#xmlName": "customerOwnedIp" - } - }, - "CustomerOwnedIpv4Pool": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CustomerOwnedIpv4Pool", - "smithy.api#documentation": "

The ID of the customer-owned address pool.

", - "smithy.api#xmlName": "customerOwnedIpv4Pool" - } - }, - "CarrierIp": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CarrierIp", - "smithy.api#documentation": "

The carrier IP address associated. This option is only available for network interfaces\n which reside in a subnet in a Wavelength Zone (for example an EC2 instance).

", - "smithy.api#xmlName": "carrierIp" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an Elastic IP address, or a carrier IP address.

" - } - }, - "com.amazonaws.ec2#AddressAttribute": { - "type": "structure", - "members": { - "PublicIp": { - "target": "com.amazonaws.ec2#PublicIpAddress", - "traits": { - "aws.protocols#ec2QueryName": "PublicIp", - "smithy.api#documentation": "

The public IP address.

", - "smithy.api#xmlName": "publicIp" - } - }, - "AllocationId": { - "target": "com.amazonaws.ec2#AllocationId", - "traits": { - "aws.protocols#ec2QueryName": "AllocationId", - "smithy.api#documentation": "

[EC2-VPC] The allocation ID.

", - "smithy.api#xmlName": "allocationId" - } - }, - "PtrRecord": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PtrRecord", - "smithy.api#documentation": "

The pointer (PTR) record for the IP address.

", - "smithy.api#xmlName": "ptrRecord" - } - }, - "PtrRecordUpdate": { - "target": "com.amazonaws.ec2#PtrUpdateStatus", - "traits": { - "aws.protocols#ec2QueryName": "PtrRecordUpdate", - "smithy.api#documentation": "

The updated PTR record for the IP address.

", - "smithy.api#xmlName": "ptrRecordUpdate" - } - } - }, - "traits": { - "smithy.api#documentation": "

The attributes associated with an Elastic IP address.

" - } - }, - "com.amazonaws.ec2#AddressAttributeName": { - "type": "enum", - "members": { - "domain_name": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "domain-name" - } - } - } - }, - "com.amazonaws.ec2#AddressFamily": { - "type": "enum", - "members": { - "ipv4": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ipv4" - } - }, - "ipv6": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ipv6" - } - } - } - }, - "com.amazonaws.ec2#AddressList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Address", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#AddressMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#AddressSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#AddressAttribute", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#AddressTransfer": { - "type": "structure", - "members": { - "PublicIp": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PublicIp", - "smithy.api#documentation": "

The Elastic IP address being transferred.

", - "smithy.api#xmlName": "publicIp" - } - }, - "AllocationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AllocationId", - "smithy.api#documentation": "

The allocation ID of an Elastic IP address.

", - "smithy.api#xmlName": "allocationId" - } - }, - "TransferAccountId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransferAccountId", - "smithy.api#documentation": "

The ID of the account that you want to transfer the Elastic IP address to.

", - "smithy.api#xmlName": "transferAccountId" - } - }, - "TransferOfferExpirationTimestamp": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "TransferOfferExpirationTimestamp", - "smithy.api#documentation": "

The timestamp when the Elastic IP address transfer expired. When the source account starts\n the transfer, the transfer account has seven hours to allocate the Elastic IP address to\n complete the transfer, or the Elastic IP address will return to its original owner.

", - "smithy.api#xmlName": "transferOfferExpirationTimestamp" - } - }, - "TransferOfferAcceptedTimestamp": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "TransferOfferAcceptedTimestamp", - "smithy.api#documentation": "

The timestamp when the Elastic IP address transfer was accepted.

", - "smithy.api#xmlName": "transferOfferAcceptedTimestamp" - } - }, - "AddressTransferStatus": { - "target": "com.amazonaws.ec2#AddressTransferStatus", - "traits": { - "aws.protocols#ec2QueryName": "AddressTransferStatus", - "smithy.api#documentation": "

The Elastic IP address transfer status.

", - "smithy.api#xmlName": "addressTransferStatus" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details on the Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon Virtual Private Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#AddressTransferList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#AddressTransfer", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#AddressTransferStatus": { - "type": "enum", - "members": { - "pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "disabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disabled" - } - }, - "accepted": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "accepted" - } - } - } - }, - "com.amazonaws.ec2#AdvertiseByoipCidr": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#AdvertiseByoipCidrRequest" - }, - "output": { - "target": "com.amazonaws.ec2#AdvertiseByoipCidrResult" - }, - "traits": { - "smithy.api#documentation": "

Advertises an IPv4 or IPv6 address range that is provisioned for use with your Amazon Web Services resources through \n bring your own IP addresses (BYOIP).

\n

You can perform this operation at most once every 10 seconds, even if you specify different \n address ranges each time.

\n

We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise\n it from Amazon Web Services. To minimize down time, you can configure your Amazon Web Services resources to use an address from a\n BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current \n location and start advertising it through Amazon Web Services.

\n

It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services\n because of BGP propagation delays.

\n

To stop advertising the BYOIP CIDR, use WithdrawByoipCidr.

" - } - }, - "com.amazonaws.ec2#AdvertiseByoipCidrRequest": { - "type": "structure", - "members": { - "Cidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The address range, in CIDR notation. This must be the exact range that you provisioned. \n You can't advertise only a portion of the provisioned range.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#AdvertiseByoipCidrResult": { - "type": "structure", - "members": { - "ByoipCidr": { - "target": "com.amazonaws.ec2#ByoipCidr", - "traits": { - "aws.protocols#ec2QueryName": "ByoipCidr", - "smithy.api#documentation": "

Information about the address range.

", - "smithy.api#xmlName": "byoipCidr" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#Affinity": { - "type": "enum", - "members": { - "default": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "default" - } - }, - "host": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "host" - } - } - } - }, - "com.amazonaws.ec2#AllocateAddress": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#AllocateAddressRequest" - }, - "output": { - "target": "com.amazonaws.ec2#AllocateAddressResult" - }, - "traits": { - "smithy.api#documentation": "

Allocates an Elastic IP address to your Amazon Web Services account. After you allocate the Elastic IP address you can associate \n it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address \n pool and can be allocated to a different Amazon Web Services account.

\n

You can allocate an Elastic IP address from an address pool owned by Amazon Web Services or from an address pool created \n from a public IPv4 address range that you have brought to Amazon Web Services for use with your Amazon Web Services resources using bring your own \n IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.

\n

[EC2-VPC] If you release an Elastic IP address, you might be able to recover it. You cannot recover an \n Elastic IP address that you released after it is allocated to another Amazon Web Services account. You cannot recover an Elastic IP\n address for EC2-Classic. To attempt to recover an Elastic IP address that you released, specify it in this operation.

\n

An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. By default, you can allocate\n 5 Elastic IP addresses for EC2-Classic per Region and 5 Elastic IP addresses for EC2-VPC per Region.

\n

For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

\n

You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " - } - }, - "com.amazonaws.ec2#AllocateAddressRequest": { - "type": "structure", - "members": { - "Domain": { - "target": "com.amazonaws.ec2#DomainType", - "traits": { - "smithy.api#documentation": "

Indicates whether the Elastic IP address is for use with instances in a VPC or instances in EC2-Classic.

\n

Default: If the Region supports EC2-Classic, the default is standard. Otherwise, the default\n is vpc.

" - } - }, - "Address": { - "target": "com.amazonaws.ec2#PublicIpAddress", - "traits": { - "smithy.api#documentation": "

[EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.

" - } - }, - "PublicIpv4Pool": { - "target": "com.amazonaws.ec2#Ipv4PoolEc2Id", - "traits": { - "smithy.api#documentation": "

The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool.\n To specify a specific address from the address pool, use the Address parameter instead.

" - } - }, - "NetworkBorderGroup": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services\n advertises IP addresses. Use this parameter to limit the IP address to this location. IP\n addresses cannot move between network border groups.

\n

Use DescribeAvailabilityZones to view the network border groups.

\n

You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 Classic, \n you receive an InvalidParameterCombination error.

" - } - }, - "CustomerOwnedIpv4Pool": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 \n select an address from the address pool. Alternatively, specify a specific \n address from the address pool.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to assign to the Elastic IP address.

", - "smithy.api#xmlName": "TagSpecification" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#AllocateAddressResult": { - "type": "structure", - "members": { - "PublicIp": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PublicIp", - "smithy.api#documentation": "

The Elastic IP address.

", - "smithy.api#xmlName": "publicIp" - } - }, - "AllocationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AllocationId", - "smithy.api#documentation": "

[EC2-VPC] The ID that Amazon Web Services assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.

", - "smithy.api#xmlName": "allocationId" - } - }, - "PublicIpv4Pool": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PublicIpv4Pool", - "smithy.api#documentation": "

The ID of an address pool.

", - "smithy.api#xmlName": "publicIpv4Pool" - } - }, - "NetworkBorderGroup": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NetworkBorderGroup", - "smithy.api#documentation": "

The set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises\n IP addresses.

", - "smithy.api#xmlName": "networkBorderGroup" - } - }, - "Domain": { - "target": "com.amazonaws.ec2#DomainType", - "traits": { - "aws.protocols#ec2QueryName": "Domain", - "smithy.api#documentation": "

Indicates whether the Elastic IP address is for use with instances in a VPC (vpc) or\n\t\t\t\tinstances in EC2-Classic (standard).

", - "smithy.api#xmlName": "domain" - } - }, - "CustomerOwnedIp": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CustomerOwnedIp", - "smithy.api#documentation": "

The customer-owned IP address.

", - "smithy.api#xmlName": "customerOwnedIp" - } - }, - "CustomerOwnedIpv4Pool": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CustomerOwnedIpv4Pool", - "smithy.api#documentation": "

The ID of the customer-owned address pool.

", - "smithy.api#xmlName": "customerOwnedIpv4Pool" - } - }, - "CarrierIp": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CarrierIp", - "smithy.api#documentation": "

The carrier IP address. This option is only available for network interfaces which reside\n in a subnet in a Wavelength Zone (for example an EC2 instance).

", - "smithy.api#xmlName": "carrierIp" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#AllocateHosts": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#AllocateHostsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#AllocateHostsResult" - }, - "traits": { - "smithy.api#documentation": "

Allocates a Dedicated Host to your account. At a minimum, specify the supported\n instance type or instance family, the Availability Zone in which to allocate the host,\n and the number of hosts to allocate.

" - } - }, - "com.amazonaws.ec2#AllocateHostsRequest": { - "type": "structure", - "members": { - "AutoPlacement": { - "target": "com.amazonaws.ec2#AutoPlacement", - "traits": { - "aws.protocols#ec2QueryName": "AutoPlacement", - "smithy.api#documentation": "

Indicates whether the host accepts any untargeted instance launches that match its\n instance type configuration, or if it only accepts Host tenancy instance launches that\n specify its unique host ID. For more information, see Understanding auto-placement and affinity in the\n Amazon EC2 User Guide.

\n

Default: on\n

", - "smithy.api#xmlName": "autoPlacement" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Availability Zone in which to allocate the Dedicated Host.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "availabilityZone" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

", - "smithy.api#xmlName": "clientToken" - } - }, - "InstanceType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

Specifies the instance type to be supported by the Dedicated Hosts. If you specify an\n instance type, the Dedicated Hosts support instances of the specified instance type\n only.

\n

If you want the Dedicated Hosts to support multiple instance types in a specific\n instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the\n same request.

", - "smithy.api#xmlName": "instanceType" - } - }, - "InstanceFamily": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Specifies the instance family to be supported by the Dedicated Hosts. If you specify\n an instance family, the Dedicated Hosts support multiple instance types within that\n instance family.

\n

If you want the Dedicated Hosts to support a specific instance type only, omit this\n parameter and specify InstanceType instead. You cannot\n specify InstanceFamily and InstanceType in the same request.

" - } - }, - "Quantity": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Quantity", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of Dedicated Hosts to allocate to your account with these\n parameters.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "quantity" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the Dedicated Host during creation.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "HostRecovery": { - "target": "com.amazonaws.ec2#HostRecovery", - "traits": { - "smithy.api#documentation": "

Indicates whether to enable or disable host recovery for the Dedicated Host. Host\n recovery is disabled by default. For more information, see Host recovery\n in the Amazon EC2 User Guide.

\n

Default: off\n

" - } - }, - "OutpostArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate\n the Dedicated Host.

" - } - }, - "HostMaintenance": { - "target": "com.amazonaws.ec2#HostMaintenance", - "traits": { - "smithy.api#documentation": "

Indicates whether to enable or disable host maintenance for the Dedicated Host. For\n more information, see Host\n maintenance in the Amazon EC2 User Guide.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#AllocateHostsResult": { - "type": "structure", - "members": { - "HostIds": { - "target": "com.amazonaws.ec2#ResponseHostIdList", - "traits": { - "aws.protocols#ec2QueryName": "HostIdSet", - "smithy.api#documentation": "

The ID of the allocated Dedicated Host. This is used to launch an instance onto a\n specific host.

", - "smithy.api#xmlName": "hostIdSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of AllocateHosts.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#AllocateIpamPoolCidr": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#AllocateIpamPoolCidrRequest" - }, - "output": { - "target": "com.amazonaws.ec2#AllocateIpamPoolCidrResult" - }, - "traits": { - "smithy.api#documentation": "

Allocate a CIDR from an IPAM pool. In IPAM, an allocation is a CIDR assignment from an IPAM pool to another IPAM pool or to a resource. For more information, see Allocate CIDRs in the Amazon VPC IPAM User Guide.

\n \n

This action creates an allocation with strong consistency. The returned CIDR will not overlap with any other allocations from the same pool.

\n " - } - }, - "com.amazonaws.ec2#AllocateIpamPoolCidrRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "IpamPoolId": { - "target": "com.amazonaws.ec2#IpamPoolId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the IPAM pool from which you would like to allocate a CIDR.

", - "smithy.api#required": {} - } - }, - "Cidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The CIDR you would like to allocate from the IPAM pool. Note the following:

\n \n

Possible values: Any available IPv4 or IPv6 CIDR.

" - } - }, - "NetmaskLength": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The netmask length of the CIDR you would like to allocate from the IPAM pool. Note the following:

\n \n

Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

", - "smithy.api#idempotencyToken": {} - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A description for the allocation.

" - } - }, - "PreviewNextCidr": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

A preview of the next available CIDR in a pool.

" - } - }, - "DisallowedCidrs": { - "target": "com.amazonaws.ec2#IpamPoolAllocationDisallowedCidrs", - "traits": { - "smithy.api#documentation": "

Exclude a particular CIDR range from being returned by the pool. Disallowed CIDRs are only allowed if using netmask length for allocation.

", - "smithy.api#xmlName": "DisallowedCidr" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#AllocateIpamPoolCidrResult": { - "type": "structure", - "members": { - "IpamPoolAllocation": { - "target": "com.amazonaws.ec2#IpamPoolAllocation", - "traits": { - "aws.protocols#ec2QueryName": "IpamPoolAllocation", - "smithy.api#documentation": "

Information about the allocation created.

", - "smithy.api#xmlName": "ipamPoolAllocation" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#AllocationId": { - "type": "string" - }, - "com.amazonaws.ec2#AllocationIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#AllocationId", - "traits": { - "smithy.api#xmlName": "AllocationId" - } - } - }, - "com.amazonaws.ec2#AllocationIds": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#AllocationId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#AllocationState": { - "type": "enum", - "members": { - "available": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "available" - } - }, - "under_assessment": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "under-assessment" - } - }, - "permanent_failure": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "permanent-failure" - } - }, - "released": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "released" - } - }, - "released_permanent_failure": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "released-permanent-failure" - } - }, - "pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - } - } - }, - "com.amazonaws.ec2#AllocationStrategy": { - "type": "enum", - "members": { - "LOWEST_PRICE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "lowestPrice" - } - }, - "DIVERSIFIED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "diversified" - } - }, - "CAPACITY_OPTIMIZED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "capacityOptimized" - } - }, - "CAPACITY_OPTIMIZED_PRIORITIZED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "capacityOptimizedPrioritized" - } - }, - "PRICE_CAPACITY_OPTIMIZED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "priceCapacityOptimized" - } - } - } - }, - "com.amazonaws.ec2#AllocationType": { - "type": "enum", - "members": { - "used": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "used" - } - } - } - }, - "com.amazonaws.ec2#AllowedInstanceType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 30 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\.\\*]+$" - } - }, - "com.amazonaws.ec2#AllowedInstanceTypeSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#AllowedInstanceType", - "traits": { - "smithy.api#xmlName": "item" - } - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 400 - } - } - }, - "com.amazonaws.ec2#AllowedPrincipal": { - "type": "structure", - "members": { - "PrincipalType": { - "target": "com.amazonaws.ec2#PrincipalType", - "traits": { - "aws.protocols#ec2QueryName": "PrincipalType", - "smithy.api#documentation": "

The type of principal.

", - "smithy.api#xmlName": "principalType" - } - }, - "Principal": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Principal", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the principal.

", - "smithy.api#xmlName": "principal" - } - }, - "ServicePermissionId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ServicePermissionId", - "smithy.api#documentation": "

The ID of the service permission.

", - "smithy.api#xmlName": "servicePermissionId" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags.

", - "smithy.api#xmlName": "tagSet" - } - }, - "ServiceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ServiceId", - "smithy.api#documentation": "

The ID of the service.

", - "smithy.api#xmlName": "serviceId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a principal.

" - } - }, - "com.amazonaws.ec2#AllowedPrincipalSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#AllowedPrincipal", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#AllowsMultipleInstanceTypes": { - "type": "enum", - "members": { - "on": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "on" - } - }, - "off": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "off" - } - } - } - }, - "com.amazonaws.ec2#AlternatePathHint": { - "type": "structure", - "members": { - "ComponentId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ComponentId", - "smithy.api#documentation": "

The ID of the component.

", - "smithy.api#xmlName": "componentId" - } - }, - "ComponentArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ComponentArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component.

", - "smithy.api#xmlName": "componentArn" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an potential intermediate component of a feasible path.

" - } - }, - "com.amazonaws.ec2#AlternatePathHintList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#AlternatePathHint", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#AmazonEC2": { - "type": "service", - "version": "2016-11-15", - "operations": [ - { - "target": "com.amazonaws.ec2#AcceptAddressTransfer" + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.ec2#AcceleratorCount": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Min", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum number of accelerators. If this parameter is not specified, there is no minimum\n limit.

", + "smithy.api#xmlName": "min" + } + }, + "Max": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Max", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of accelerators. If this parameter is not specified, there is no\n maximum limit.

", + "smithy.api#xmlName": "max" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips)\n on an instance.

" + } }, - { - "target": "com.amazonaws.ec2#AcceptReservedInstancesExchangeQuote" + "com.amazonaws.ec2#AcceleratorCountRequest": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum number of accelerators. To specify no minimum limit, omit this\n parameter.

" + } + }, + "Max": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of accelerators. To specify no maximum limit, omit this\n parameter. To exclude accelerator-enabled instance types, set Max to\n 0.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips)\n on an instance. To exclude accelerator-enabled instance types, set Max to\n 0.

" + } }, - { - "target": "com.amazonaws.ec2#AcceptTransitGatewayMulticastDomainAssociations" + "com.amazonaws.ec2#AcceleratorManufacturer": { + "type": "enum", + "members": { + "NVIDIA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nvidia" + } + }, + "AMD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "amd" + } + }, + "AMAZON_WEB_SERVICES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "amazon-web-services" + } + }, + "XILINX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "xilinx" + } + } + } }, - { - "target": "com.amazonaws.ec2#AcceptTransitGatewayPeeringAttachment" + "com.amazonaws.ec2#AcceleratorManufacturerSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AcceleratorManufacturer", + "traits": { + "smithy.api#xmlName": "item" + } + } }, - { - "target": "com.amazonaws.ec2#AcceptTransitGatewayVpcAttachment" + "com.amazonaws.ec2#AcceleratorName": { + "type": "enum", + "members": { + "A100": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "a100" + } + }, + "V100": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "v100" + } + }, + "K80": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "k80" + } + }, + "T4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t4" + } + }, + "M60": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m60" + } + }, + "RADEON_PRO_V520": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "radeon-pro-v520" + } + }, + "VU9P": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vu9p" + } + }, + "INFERENTIA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inferentia" + } + }, + "K520": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "k520" + } + } + } }, - { - "target": "com.amazonaws.ec2#AcceptVpcEndpointConnections" + "com.amazonaws.ec2#AcceleratorNameSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AcceleratorName", + "traits": { + "smithy.api#xmlName": "item" + } + } }, - { - "target": "com.amazonaws.ec2#AcceptVpcPeeringConnection" + "com.amazonaws.ec2#AcceleratorTotalMemoryMiB": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Min", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum amount of accelerator memory, in MiB. If this parameter is not specified,\n there is no minimum limit.

", + "smithy.api#xmlName": "min" + } + }, + "Max": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Max", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum amount of accelerator memory, in MiB. If this parameter is not specified,\n there is no maximum limit.

", + "smithy.api#xmlName": "max" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum amount of total accelerator memory, in MiB.

" + } }, - { - "target": "com.amazonaws.ec2#AdvertiseByoipCidr" + "com.amazonaws.ec2#AcceleratorTotalMemoryMiBRequest": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this\n parameter.

" + } + }, + "Max": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this\n parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum amount of total accelerator memory, in MiB.

" + } }, - { - "target": "com.amazonaws.ec2#AllocateAddress" + "com.amazonaws.ec2#AcceleratorType": { + "type": "enum", + "members": { + "GPU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "gpu" + } + }, + "FPGA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fpga" + } + }, + "INFERENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inference" + } + } + } }, - { - "target": "com.amazonaws.ec2#AllocateHosts" + "com.amazonaws.ec2#AcceleratorTypeSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AcceleratorType", + "traits": { + "smithy.api#xmlName": "item" + } + } }, - { - "target": "com.amazonaws.ec2#AllocateIpamPoolCidr" + "com.amazonaws.ec2#AcceptAddressTransfer": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AcceptAddressTransferRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AcceptAddressTransferResult" + }, + "traits": { + "smithy.api#documentation": "

Accepts an Elastic IP address transfer. For more information, see Accept a transferred Elastic IP address in the Amazon Virtual Private Cloud User Guide.

" + } }, - { - "target": "com.amazonaws.ec2#ApplySecurityGroupsToClientVpnTargetNetwork" + "com.amazonaws.ec2#AcceptAddressTransferRequest": { + "type": "structure", + "members": { + "Address": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Elastic IP address you are accepting for transfer.

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

\n tag: - 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.\n 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.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.ec2#AssignIpv6Addresses" - }, - { - "target": "com.amazonaws.ec2#AssignPrivateIpAddresses" + "com.amazonaws.ec2#AcceptAddressTransferResult": { + "type": "structure", + "members": { + "AddressTransfer": { + "target": "com.amazonaws.ec2#AddressTransfer", + "traits": { + "aws.protocols#ec2QueryName": "AddressTransfer", + "smithy.api#documentation": "

An Elastic IP address transfer.

", + "smithy.api#xmlName": "addressTransfer" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.ec2#AssignPrivateNatGatewayAddress" + "com.amazonaws.ec2#AcceptReservedInstancesExchangeQuote": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AcceptReservedInstancesExchangeQuoteRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AcceptReservedInstancesExchangeQuoteResult" + }, + "traits": { + "smithy.api#documentation": "

Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.

" + } }, - { - "target": "com.amazonaws.ec2#AssociateAddress" + "com.amazonaws.ec2#AcceptReservedInstancesExchangeQuoteRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ReservedInstanceIds": { + "target": "com.amazonaws.ec2#ReservedInstanceIdSet", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the Convertible Reserved Instances to exchange for another Convertible\n Reserved Instance of the same or higher value.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "ReservedInstanceId" + } + }, + "TargetConfigurations": { + "target": "com.amazonaws.ec2#TargetConfigurationRequestSet", + "traits": { + "smithy.api#documentation": "

The configuration of the target Convertible Reserved Instance to exchange for your\n current Convertible Reserved Instances.

", + "smithy.api#xmlName": "TargetConfiguration" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for accepting the quote.

", + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.ec2#AssociateClientVpnTargetNetwork" + "com.amazonaws.ec2#AcceptReservedInstancesExchangeQuoteResult": { + "type": "structure", + "members": { + "ExchangeId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ExchangeId", + "smithy.api#documentation": "

The ID of the successful exchange.

", + "smithy.api#xmlName": "exchangeId" + } + } + }, + "traits": { + "smithy.api#documentation": "

The result of the exchange and whether it was successful.

", + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.ec2#AssociateDhcpOptions" + "com.amazonaws.ec2#AcceptTransitGatewayMulticastDomainAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AcceptTransitGatewayMulticastDomainAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AcceptTransitGatewayMulticastDomainAssociationsResult" + }, + "traits": { + "smithy.api#documentation": "

Accepts a request to associate subnets with a transit gateway multicast domain.

" + } }, - { - "target": "com.amazonaws.ec2#AssociateEnclaveCertificateIamRole" + "com.amazonaws.ec2#AcceptTransitGatewayMulticastDomainAssociationsRequest": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

" + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway attachment.

" + } + }, + "SubnetIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the subnets to associate with the transit gateway multicast domain.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.ec2#AssociateIamInstanceProfile" + "com.amazonaws.ec2#AcceptTransitGatewayMulticastDomainAssociationsResult": { + "type": "structure", + "members": { + "Associations": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainAssociations", + "traits": { + "aws.protocols#ec2QueryName": "Associations", + "smithy.api#documentation": "

Information about the multicast domain associations.

", + "smithy.api#xmlName": "associations" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.ec2#AssociateInstanceEventWindow" + "com.amazonaws.ec2#AcceptTransitGatewayPeeringAttachment": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AcceptTransitGatewayPeeringAttachmentRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AcceptTransitGatewayPeeringAttachmentResult" + }, + "traits": { + "smithy.api#documentation": "

Accepts a transit gateway peering attachment request. The peering attachment must be\n in the pendingAcceptance state.

" + } }, - { - "target": "com.amazonaws.ec2#AssociateIpamResourceDiscovery" + "com.amazonaws.ec2#AcceptTransitGatewayPeeringAttachmentRequest": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway attachment.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.ec2#AssociateNatGatewayAddress" + "com.amazonaws.ec2#AcceptTransitGatewayPeeringAttachmentResult": { + "type": "structure", + "members": { + "TransitGatewayPeeringAttachment": { + "target": "com.amazonaws.ec2#TransitGatewayPeeringAttachment", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayPeeringAttachment", + "smithy.api#documentation": "

The transit gateway peering attachment.

", + "smithy.api#xmlName": "transitGatewayPeeringAttachment" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.ec2#AssociateRouteTable" + "com.amazonaws.ec2#AcceptTransitGatewayVpcAttachment": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AcceptTransitGatewayVpcAttachmentRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AcceptTransitGatewayVpcAttachmentResult" + }, + "traits": { + "smithy.api#documentation": "

Accepts a request to attach a VPC to a transit gateway.

\n

The VPC attachment must be in the pendingAcceptance state.\n Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests.\n Use RejectTransitGatewayVpcAttachment to reject a VPC attachment request.

" + } }, - { - "target": "com.amazonaws.ec2#AssociateSubnetCidrBlock" + "com.amazonaws.ec2#AcceptTransitGatewayVpcAttachmentRequest": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.ec2#AssociateTransitGatewayMulticastDomain" + "com.amazonaws.ec2#AcceptTransitGatewayVpcAttachmentResult": { + "type": "structure", + "members": { + "TransitGatewayVpcAttachment": { + "target": "com.amazonaws.ec2#TransitGatewayVpcAttachment", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayVpcAttachment", + "smithy.api#documentation": "

The VPC attachment.

", + "smithy.api#xmlName": "transitGatewayVpcAttachment" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.ec2#AssociateTransitGatewayPolicyTable" + "com.amazonaws.ec2#AcceptVpcEndpointConnections": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AcceptVpcEndpointConnectionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AcceptVpcEndpointConnectionsResult" + }, + "traits": { + "smithy.api#documentation": "

Accepts connection requests to your VPC endpoint service.

" + } }, - { - "target": "com.amazonaws.ec2#AssociateTransitGatewayRouteTable" + "com.amazonaws.ec2#AcceptVpcEndpointConnectionsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ServiceId": { + "target": "com.amazonaws.ec2#VpcEndpointServiceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC endpoint service.

", + "smithy.api#required": {} + } + }, + "VpcEndpointIds": { + "target": "com.amazonaws.ec2#VpcEndpointIdList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the interface VPC endpoints.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "VpcEndpointId" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.ec2#AssociateTrunkInterface" + "com.amazonaws.ec2#AcceptVpcEndpointConnectionsResult": { + "type": "structure", + "members": { + "Unsuccessful": { + "target": "com.amazonaws.ec2#UnsuccessfulItemSet", + "traits": { + "aws.protocols#ec2QueryName": "Unsuccessful", + "smithy.api#documentation": "

Information about the interface endpoints that were not accepted, if\n applicable.

", + "smithy.api#xmlName": "unsuccessful" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.ec2#AssociateVpcCidrBlock" + "com.amazonaws.ec2#AcceptVpcPeeringConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AcceptVpcPeeringConnectionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AcceptVpcPeeringConnectionResult" + }, + "traits": { + "smithy.api#documentation": "

Accept a VPC peering connection request. To accept a request, the VPC peering connection must\n be in the pending-acceptance state, and you must be the owner of the peer VPC.\n Use DescribeVpcPeeringConnections to view your outstanding VPC\n peering connection requests.

\n

For an inter-Region VPC peering connection request, you must accept the VPC peering\n connection in the Region of the accepter VPC.

" + } }, - { - "target": "com.amazonaws.ec2#AttachClassicLinkVpc" + "com.amazonaws.ec2#AcceptVpcPeeringConnectionRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "VpcPeeringConnectionId": { + "target": "com.amazonaws.ec2#VpcPeeringConnectionIdWithResolver", + "traits": { + "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC peering connection. You must specify this parameter in the\n\t\t\trequest.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "vpcPeeringConnectionId" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.ec2#AttachInternetGateway" + "com.amazonaws.ec2#AcceptVpcPeeringConnectionResult": { + "type": "structure", + "members": { + "VpcPeeringConnection": { + "target": "com.amazonaws.ec2#VpcPeeringConnection", + "traits": { + "aws.protocols#ec2QueryName": "VpcPeeringConnection", + "smithy.api#documentation": "

Information about the VPC peering connection.

", + "smithy.api#xmlName": "vpcPeeringConnection" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.ec2#AttachNetworkInterface" + "com.amazonaws.ec2#AccessScopeAnalysisFinding": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeAnalysisId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeAnalysisId", + "smithy.api#documentation": "

The ID of the Network Access Scope analysis.

", + "smithy.api#xmlName": "networkInsightsAccessScopeAnalysisId" + } + }, + "NetworkInsightsAccessScopeId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeId", + "smithy.api#documentation": "

The ID of the Network Access Scope.

", + "smithy.api#xmlName": "networkInsightsAccessScopeId" + } + }, + "FindingId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "FindingId", + "smithy.api#documentation": "

The ID of the finding.

", + "smithy.api#xmlName": "findingId" + } + }, + "FindingComponents": { + "target": "com.amazonaws.ec2#PathComponentList", + "traits": { + "aws.protocols#ec2QueryName": "FindingComponentSet", + "smithy.api#documentation": "

The finding components.

", + "smithy.api#xmlName": "findingComponentSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a finding for a Network Access Scope.

" + } }, - { - "target": "com.amazonaws.ec2#AttachVerifiedAccessTrustProvider" + "com.amazonaws.ec2#AccessScopeAnalysisFindingList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AccessScopeAnalysisFinding", + "traits": { + "smithy.api#xmlName": "item" + } + } }, - { - "target": "com.amazonaws.ec2#AttachVolume" + "com.amazonaws.ec2#AccessScopePath": { + "type": "structure", + "members": { + "Source": { + "target": "com.amazonaws.ec2#PathStatement", + "traits": { + "aws.protocols#ec2QueryName": "Source", + "smithy.api#documentation": "

The source.

", + "smithy.api#xmlName": "source" + } + }, + "Destination": { + "target": "com.amazonaws.ec2#PathStatement", + "traits": { + "aws.protocols#ec2QueryName": "Destination", + "smithy.api#documentation": "

The destination.

", + "smithy.api#xmlName": "destination" + } + }, + "ThroughResources": { + "target": "com.amazonaws.ec2#ThroughResourcesStatementList", + "traits": { + "aws.protocols#ec2QueryName": "ThroughResourceSet", + "smithy.api#documentation": "

The through resources.

", + "smithy.api#xmlName": "throughResourceSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a path.

" + } }, - { - "target": "com.amazonaws.ec2#AttachVpnGateway" + "com.amazonaws.ec2#AccessScopePathList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AccessScopePath", + "traits": { + "smithy.api#xmlName": "item" + } + } }, - { - "target": "com.amazonaws.ec2#AuthorizeClientVpnIngress" + "com.amazonaws.ec2#AccessScopePathListRequest": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AccessScopePathRequest", + "traits": { + "smithy.api#xmlName": "item" + } + } }, - { - "target": "com.amazonaws.ec2#AuthorizeSecurityGroupEgress" + "com.amazonaws.ec2#AccessScopePathRequest": { + "type": "structure", + "members": { + "Source": { + "target": "com.amazonaws.ec2#PathStatementRequest", + "traits": { + "smithy.api#documentation": "

The source.

" + } + }, + "Destination": { + "target": "com.amazonaws.ec2#PathStatementRequest", + "traits": { + "smithy.api#documentation": "

The destination.

" + } + }, + "ThroughResources": { + "target": "com.amazonaws.ec2#ThroughResourcesStatementRequestList", + "traits": { + "smithy.api#documentation": "

The through resources.

", + "smithy.api#xmlName": "ThroughResource" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a path.

" + } }, - { - "target": "com.amazonaws.ec2#AuthorizeSecurityGroupIngress" + "com.amazonaws.ec2#AccountAttribute": { + "type": "structure", + "members": { + "AttributeName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AttributeName", + "smithy.api#documentation": "

The name of the account attribute.

", + "smithy.api#xmlName": "attributeName" + } + }, + "AttributeValues": { + "target": "com.amazonaws.ec2#AccountAttributeValueList", + "traits": { + "aws.protocols#ec2QueryName": "AttributeValueSet", + "smithy.api#documentation": "

The values for the account attribute.

", + "smithy.api#xmlName": "attributeValueSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an account attribute.

" + } }, - { - "target": "com.amazonaws.ec2#BundleInstance" + "com.amazonaws.ec2#AccountAttributeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AccountAttribute", + "traits": { + "smithy.api#xmlName": "item" + } + } }, - { - "target": "com.amazonaws.ec2#CancelBundleTask" + "com.amazonaws.ec2#AccountAttributeName": { + "type": "enum", + "members": { + "supported_platforms": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "supported-platforms" + } + }, + "default_vpc": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "default-vpc" + } + } + } }, - { - "target": "com.amazonaws.ec2#CancelCapacityReservation" + "com.amazonaws.ec2#AccountAttributeNameStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AccountAttributeName", + "traits": { + "smithy.api#xmlName": "attributeName" + } + } }, - { - "target": "com.amazonaws.ec2#CancelCapacityReservationFleets" + "com.amazonaws.ec2#AccountAttributeValue": { + "type": "structure", + "members": { + "AttributeValue": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AttributeValue", + "smithy.api#documentation": "

The value of the attribute.

", + "smithy.api#xmlName": "attributeValue" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a value of an account attribute.

" + } }, - { - "target": "com.amazonaws.ec2#CancelConversionTask" + "com.amazonaws.ec2#AccountAttributeValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AccountAttributeValue", + "traits": { + "smithy.api#xmlName": "item" + } + } }, - { - "target": "com.amazonaws.ec2#CancelExportTask" + "com.amazonaws.ec2#ActiveInstance": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type.

", + "smithy.api#xmlName": "instanceType" + } + }, + "SpotInstanceRequestId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpotInstanceRequestId", + "smithy.api#documentation": "

The ID of the Spot Instance request.

", + "smithy.api#xmlName": "spotInstanceRequestId" + } + }, + "InstanceHealth": { + "target": "com.amazonaws.ec2#InstanceHealthStatus", + "traits": { + "aws.protocols#ec2QueryName": "InstanceHealth", + "smithy.api#documentation": "

The health status of the instance. If the status of either the instance status check\n or the system status check is impaired, the health status of the instance\n is unhealthy. Otherwise, the health status is healthy.

", + "smithy.api#xmlName": "instanceHealth" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a running instance in a Spot Fleet.

" + } }, - { - "target": "com.amazonaws.ec2#CancelImageLaunchPermission" + "com.amazonaws.ec2#ActiveInstanceSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ActiveInstance", + "traits": { + "smithy.api#xmlName": "item" + } + } }, - { - "target": "com.amazonaws.ec2#CancelImportTask" + "com.amazonaws.ec2#ActivityStatus": { + "type": "enum", + "members": { + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "error" + } + }, + "PENDING_FULFILLMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending_fulfillment" + } + }, + "PENDING_TERMINATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending_termination" + } + }, + "FULFILLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fulfilled" + } + } + } }, - { - "target": "com.amazonaws.ec2#CancelReservedInstancesListing" + "com.amazonaws.ec2#AddIpamOperatingRegion": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the operating Region.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Add an operating Region to an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

\n

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.\n

" + } }, - { - "target": "com.amazonaws.ec2#CancelSpotFleetRequests" + "com.amazonaws.ec2#AddIpamOperatingRegionSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AddIpamOperatingRegion" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } }, - { - "target": "com.amazonaws.ec2#CancelSpotInstanceRequests" + "com.amazonaws.ec2#AddPrefixListEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AddPrefixListEntry" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } }, - { - "target": "com.amazonaws.ec2#ConfirmProductInstance" + "com.amazonaws.ec2#AddPrefixListEntry": { + "type": "structure", + "members": { + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The CIDR block.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the entry.

\n

Constraints: Up to 255 characters in length.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An entry for a prefix list.

" + } }, - { - "target": "com.amazonaws.ec2#CopyFpgaImage" + "com.amazonaws.ec2#AddedPrincipal": { + "type": "structure", + "members": { + "PrincipalType": { + "target": "com.amazonaws.ec2#PrincipalType", + "traits": { + "aws.protocols#ec2QueryName": "PrincipalType", + "smithy.api#documentation": "

The type of principal.

", + "smithy.api#xmlName": "principalType" + } + }, + "Principal": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Principal", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the principal.

", + "smithy.api#xmlName": "principal" + } + }, + "ServicePermissionId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ServicePermissionId", + "smithy.api#documentation": "

The ID of the service permission.

", + "smithy.api#xmlName": "servicePermissionId" + } + }, + "ServiceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ServiceId", + "smithy.api#documentation": "

The ID of the service.

", + "smithy.api#xmlName": "serviceId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a principal.

" + } }, - { - "target": "com.amazonaws.ec2#CopyImage" + "com.amazonaws.ec2#AddedPrincipalSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AddedPrincipal", + "traits": { + "smithy.api#xmlName": "item" + } + } }, - { - "target": "com.amazonaws.ec2#CopySnapshot" + "com.amazonaws.ec2#AdditionalDetail": { + "type": "structure", + "members": { + "AdditionalDetailType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AdditionalDetailType", + "smithy.api#documentation": "

The additional detail code.

", + "smithy.api#xmlName": "additionalDetailType" + } + }, + "Component": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "Component", + "smithy.api#documentation": "

The path component.

", + "smithy.api#xmlName": "component" + } + }, + "VpcEndpointService": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "VpcEndpointService", + "smithy.api#documentation": "

The VPC endpoint service.

", + "smithy.api#xmlName": "vpcEndpointService" + } + }, + "RuleOptions": { + "target": "com.amazonaws.ec2#RuleOptionList", + "traits": { + "aws.protocols#ec2QueryName": "RuleOptionSet", + "smithy.api#documentation": "

The rule options.

", + "smithy.api#xmlName": "ruleOptionSet" + } + }, + "RuleGroupTypePairs": { + "target": "com.amazonaws.ec2#RuleGroupTypePairList", + "traits": { + "aws.protocols#ec2QueryName": "RuleGroupTypePairSet", + "smithy.api#documentation": "

The rule group type.

", + "smithy.api#xmlName": "ruleGroupTypePairSet" + } + }, + "RuleGroupRuleOptionsPairs": { + "target": "com.amazonaws.ec2#RuleGroupRuleOptionsPairList", + "traits": { + "aws.protocols#ec2QueryName": "RuleGroupRuleOptionsPairSet", + "smithy.api#documentation": "

The rule options.

", + "smithy.api#xmlName": "ruleGroupRuleOptionsPairSet" + } + }, + "ServiceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ServiceName", + "smithy.api#documentation": "

The name of the VPC endpoint service.

", + "smithy.api#xmlName": "serviceName" + } + }, + "LoadBalancers": { + "target": "com.amazonaws.ec2#AnalysisComponentList", + "traits": { + "aws.protocols#ec2QueryName": "LoadBalancerSet", + "smithy.api#documentation": "

The load balancers.

", + "smithy.api#xmlName": "loadBalancerSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an additional detail for a path analysis. For more information, see Reachability Analyzer additional detail codes.

" + } }, - { - "target": "com.amazonaws.ec2#CreateCapacityReservation" + "com.amazonaws.ec2#AdditionalDetailList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AdditionalDetail", + "traits": { + "smithy.api#xmlName": "item" + } + } }, - { - "target": "com.amazonaws.ec2#CreateCapacityReservationFleet" + "com.amazonaws.ec2#Address": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance that the address is associated with (if any).

", + "smithy.api#xmlName": "instanceId" + } + }, + "PublicIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicIp", + "smithy.api#documentation": "

The Elastic IP address.

", + "smithy.api#xmlName": "publicIp" + } + }, + "AllocationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AllocationId", + "smithy.api#documentation": "

The ID representing the allocation of the address.

", + "smithy.api#xmlName": "allocationId" + } + }, + "AssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#documentation": "

The ID representing the association of the address with an instance.

", + "smithy.api#xmlName": "associationId" + } + }, + "Domain": { + "target": "com.amazonaws.ec2#DomainType", + "traits": { + "aws.protocols#ec2QueryName": "Domain", + "smithy.api#documentation": "

The network (vpc).

", + "smithy.api#xmlName": "domain" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "NetworkInterfaceOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceOwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the network interface.

", + "smithy.api#xmlName": "networkInterfaceOwnerId" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

The private IP address associated with the Elastic IP address.

", + "smithy.api#xmlName": "privateIpAddress" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the Elastic IP address.

", + "smithy.api#xmlName": "tagSet" + } + }, + "PublicIpv4Pool": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicIpv4Pool", + "smithy.api#documentation": "

The ID of an address pool.

", + "smithy.api#xmlName": "publicIpv4Pool" + } + }, + "NetworkBorderGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkBorderGroup", + "smithy.api#documentation": "

The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from\n which Amazon Web Services advertises IP addresses.

", + "smithy.api#xmlName": "networkBorderGroup" + } + }, + "CustomerOwnedIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CustomerOwnedIp", + "smithy.api#documentation": "

The customer-owned IP address.

", + "smithy.api#xmlName": "customerOwnedIp" + } + }, + "CustomerOwnedIpv4Pool": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CustomerOwnedIpv4Pool", + "smithy.api#documentation": "

The ID of the customer-owned address pool.

", + "smithy.api#xmlName": "customerOwnedIpv4Pool" + } + }, + "CarrierIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CarrierIp", + "smithy.api#documentation": "

The carrier IP address associated. This option is only available for network interfaces\n which reside in a subnet in a Wavelength Zone (for example an EC2 instance).

", + "smithy.api#xmlName": "carrierIp" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an Elastic IP address, or a carrier IP address.

" + } }, - { - "target": "com.amazonaws.ec2#CreateCarrierGateway" + "com.amazonaws.ec2#AddressAttribute": { + "type": "structure", + "members": { + "PublicIp": { + "target": "com.amazonaws.ec2#PublicIpAddress", + "traits": { + "aws.protocols#ec2QueryName": "PublicIp", + "smithy.api#documentation": "

The public IP address.

", + "smithy.api#xmlName": "publicIp" + } + }, + "AllocationId": { + "target": "com.amazonaws.ec2#AllocationId", + "traits": { + "aws.protocols#ec2QueryName": "AllocationId", + "smithy.api#documentation": "

[EC2-VPC] The allocation ID.

", + "smithy.api#xmlName": "allocationId" + } + }, + "PtrRecord": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PtrRecord", + "smithy.api#documentation": "

The pointer (PTR) record for the IP address.

", + "smithy.api#xmlName": "ptrRecord" + } + }, + "PtrRecordUpdate": { + "target": "com.amazonaws.ec2#PtrUpdateStatus", + "traits": { + "aws.protocols#ec2QueryName": "PtrRecordUpdate", + "smithy.api#documentation": "

The updated PTR record for the IP address.

", + "smithy.api#xmlName": "ptrRecordUpdate" + } + } + }, + "traits": { + "smithy.api#documentation": "

The attributes associated with an Elastic IP address.

" + } }, - { - "target": "com.amazonaws.ec2#CreateClientVpnEndpoint" + "com.amazonaws.ec2#AddressAttributeName": { + "type": "enum", + "members": { + "domain_name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "domain-name" + } + } + } }, - { - "target": "com.amazonaws.ec2#CreateClientVpnRoute" - }, - { - "target": "com.amazonaws.ec2#CreateCoipCidr" - }, - { - "target": "com.amazonaws.ec2#CreateCoipPool" - }, - { - "target": "com.amazonaws.ec2#CreateCustomerGateway" - }, - { - "target": "com.amazonaws.ec2#CreateDefaultSubnet" - }, - { - "target": "com.amazonaws.ec2#CreateDefaultVpc" - }, - { - "target": "com.amazonaws.ec2#CreateDhcpOptions" - }, - { - "target": "com.amazonaws.ec2#CreateEgressOnlyInternetGateway" - }, - { - "target": "com.amazonaws.ec2#CreateFleet" - }, - { - "target": "com.amazonaws.ec2#CreateFlowLogs" - }, - { - "target": "com.amazonaws.ec2#CreateFpgaImage" - }, - { - "target": "com.amazonaws.ec2#CreateImage" - }, - { - "target": "com.amazonaws.ec2#CreateInstanceEventWindow" - }, - { - "target": "com.amazonaws.ec2#CreateInstanceExportTask" - }, - { - "target": "com.amazonaws.ec2#CreateInternetGateway" - }, - { - "target": "com.amazonaws.ec2#CreateIpam" - }, - { - "target": "com.amazonaws.ec2#CreateIpamPool" - }, - { - "target": "com.amazonaws.ec2#CreateIpamResourceDiscovery" - }, - { - "target": "com.amazonaws.ec2#CreateIpamScope" - }, - { - "target": "com.amazonaws.ec2#CreateKeyPair" - }, - { - "target": "com.amazonaws.ec2#CreateLaunchTemplate" - }, - { - "target": "com.amazonaws.ec2#CreateLaunchTemplateVersion" - }, - { - "target": "com.amazonaws.ec2#CreateLocalGatewayRoute" - }, - { - "target": "com.amazonaws.ec2#CreateLocalGatewayRouteTable" - }, - { - "target": "com.amazonaws.ec2#CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation" - }, - { - "target": "com.amazonaws.ec2#CreateLocalGatewayRouteTableVpcAssociation" - }, - { - "target": "com.amazonaws.ec2#CreateManagedPrefixList" - }, - { - "target": "com.amazonaws.ec2#CreateNatGateway" - }, - { - "target": "com.amazonaws.ec2#CreateNetworkAcl" - }, - { - "target": "com.amazonaws.ec2#CreateNetworkAclEntry" - }, - { - "target": "com.amazonaws.ec2#CreateNetworkInsightsAccessScope" - }, - { - "target": "com.amazonaws.ec2#CreateNetworkInsightsPath" - }, - { - "target": "com.amazonaws.ec2#CreateNetworkInterface" - }, - { - "target": "com.amazonaws.ec2#CreateNetworkInterfacePermission" - }, - { - "target": "com.amazonaws.ec2#CreatePlacementGroup" - }, - { - "target": "com.amazonaws.ec2#CreatePublicIpv4Pool" - }, - { - "target": "com.amazonaws.ec2#CreateReplaceRootVolumeTask" - }, - { - "target": "com.amazonaws.ec2#CreateReservedInstancesListing" - }, - { - "target": "com.amazonaws.ec2#CreateRestoreImageTask" - }, - { - "target": "com.amazonaws.ec2#CreateRoute" - }, - { - "target": "com.amazonaws.ec2#CreateRouteTable" - }, - { - "target": "com.amazonaws.ec2#CreateSecurityGroup" - }, - { - "target": "com.amazonaws.ec2#CreateSnapshot" - }, - { - "target": "com.amazonaws.ec2#CreateSnapshots" - }, - { - "target": "com.amazonaws.ec2#CreateSpotDatafeedSubscription" - }, - { - "target": "com.amazonaws.ec2#CreateStoreImageTask" - }, - { - "target": "com.amazonaws.ec2#CreateSubnet" - }, - { - "target": "com.amazonaws.ec2#CreateSubnetCidrReservation" - }, - { - "target": "com.amazonaws.ec2#CreateTags" - }, - { - "target": "com.amazonaws.ec2#CreateTrafficMirrorFilter" + "com.amazonaws.ec2#AddressFamily": { + "type": "enum", + "members": { + "ipv4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv4" + } + }, + "ipv6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv6" + } + } + } }, - { - "target": "com.amazonaws.ec2#CreateTrafficMirrorFilterRule" + "com.amazonaws.ec2#AddressList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Address", + "traits": { + "smithy.api#xmlName": "item" + } + } }, - { - "target": "com.amazonaws.ec2#CreateTrafficMirrorSession" + "com.amazonaws.ec2#AddressMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } }, - { - "target": "com.amazonaws.ec2#CreateTrafficMirrorTarget" + "com.amazonaws.ec2#AddressSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AddressAttribute", + "traits": { + "smithy.api#xmlName": "item" + } + } }, - { - "target": "com.amazonaws.ec2#CreateTransitGateway" + "com.amazonaws.ec2#AddressTransfer": { + "type": "structure", + "members": { + "PublicIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicIp", + "smithy.api#documentation": "

The Elastic IP address being transferred.

", + "smithy.api#xmlName": "publicIp" + } + }, + "AllocationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AllocationId", + "smithy.api#documentation": "

The allocation ID of an Elastic IP address.

", + "smithy.api#xmlName": "allocationId" + } + }, + "TransferAccountId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransferAccountId", + "smithy.api#documentation": "

The ID of the account that you want to transfer the Elastic IP address to.

", + "smithy.api#xmlName": "transferAccountId" + } + }, + "TransferOfferExpirationTimestamp": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "TransferOfferExpirationTimestamp", + "smithy.api#documentation": "

The timestamp when the Elastic IP address transfer expired. When the source account starts\n the transfer, the transfer account has seven hours to allocate the Elastic IP address to\n complete the transfer, or the Elastic IP address will return to its original owner.

", + "smithy.api#xmlName": "transferOfferExpirationTimestamp" + } + }, + "TransferOfferAcceptedTimestamp": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "TransferOfferAcceptedTimestamp", + "smithy.api#documentation": "

The timestamp when the Elastic IP address transfer was accepted.

", + "smithy.api#xmlName": "transferOfferAcceptedTimestamp" + } + }, + "AddressTransferStatus": { + "target": "com.amazonaws.ec2#AddressTransferStatus", + "traits": { + "aws.protocols#ec2QueryName": "AddressTransferStatus", + "smithy.api#documentation": "

The Elastic IP address transfer status.

", + "smithy.api#xmlName": "addressTransferStatus" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details on the Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon Virtual Private Cloud User Guide.

" + } }, - { - "target": "com.amazonaws.ec2#CreateTransitGatewayConnect" + "com.amazonaws.ec2#AddressTransferList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AddressTransfer", + "traits": { + "smithy.api#xmlName": "item" + } + } }, - { - "target": "com.amazonaws.ec2#CreateTransitGatewayConnectPeer" + "com.amazonaws.ec2#AddressTransferStatus": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "accepted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "accepted" + } + } + } }, - { - "target": "com.amazonaws.ec2#CreateTransitGatewayMulticastDomain" + "com.amazonaws.ec2#AdvertiseByoipCidr": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AdvertiseByoipCidrRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AdvertiseByoipCidrResult" + }, + "traits": { + "smithy.api#documentation": "

Advertises an IPv4 or IPv6 address range that is provisioned for use with your Amazon Web Services resources through \n bring your own IP addresses (BYOIP).

\n

You can perform this operation at most once every 10 seconds, even if you specify different \n address ranges each time.

\n

We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise\n it from Amazon Web Services. To minimize down time, you can configure your Amazon Web Services resources to use an address from a\n BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current \n location and start advertising it through Amazon Web Services.

\n

It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services\n because of BGP propagation delays.

\n

To stop advertising the BYOIP CIDR, use WithdrawByoipCidr.

" + } }, - { - "target": "com.amazonaws.ec2#CreateTransitGatewayPeeringAttachment" + "com.amazonaws.ec2#AdvertiseByoipCidrRequest": { + "type": "structure", + "members": { + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The address range, in CIDR notation. This must be the exact range that you provisioned. \n You can't advertise only a portion of the provisioned range.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.ec2#CreateTransitGatewayPolicyTable" + "com.amazonaws.ec2#AdvertiseByoipCidrResult": { + "type": "structure", + "members": { + "ByoipCidr": { + "target": "com.amazonaws.ec2#ByoipCidr", + "traits": { + "aws.protocols#ec2QueryName": "ByoipCidr", + "smithy.api#documentation": "

Information about the address range.

", + "smithy.api#xmlName": "byoipCidr" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.ec2#CreateTransitGatewayPrefixListReference" + "com.amazonaws.ec2#Affinity": { + "type": "enum", + "members": { + "default": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "default" + } + }, + "host": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "host" + } + } + } }, - { - "target": "com.amazonaws.ec2#CreateTransitGatewayRoute" + "com.amazonaws.ec2#AllocateAddress": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AllocateAddressRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AllocateAddressResult" + }, + "traits": { + "smithy.api#documentation": "

Allocates an Elastic IP address to your Amazon Web Services account. After you allocate the Elastic IP address you can associate \n it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address \n pool and can be allocated to a different Amazon Web Services account.

\n

You can allocate an Elastic IP address from an address pool owned by Amazon Web Services or from an address pool created \n from a public IPv4 address range that you have brought to Amazon Web Services for use with your Amazon Web Services resources using bring your own \n IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.

\n

If you release an Elastic IP address, you might be able to recover it. You cannot recover\n an Elastic IP address that you released after it is allocated to another Amazon Web Services account. To attempt to recover an Elastic IP address that you released, specify\n it in this operation.

\n

For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

\n

You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, \n to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).

" + } }, - { - "target": "com.amazonaws.ec2#CreateTransitGatewayRouteTable" + "com.amazonaws.ec2#AllocateAddressRequest": { + "type": "structure", + "members": { + "Domain": { + "target": "com.amazonaws.ec2#DomainType", + "traits": { + "smithy.api#documentation": "

The network (vpc).

" + } + }, + "Address": { + "target": "com.amazonaws.ec2#PublicIpAddress", + "traits": { + "smithy.api#documentation": "

The Elastic IP address to recover or an IPv4 address from an address pool.

" + } + }, + "PublicIpv4Pool": { + "target": "com.amazonaws.ec2#Ipv4PoolEc2Id", + "traits": { + "smithy.api#documentation": "

The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool.\n To specify a specific address from the address pool, use the Address parameter instead.

" + } + }, + "NetworkBorderGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services\n advertises IP addresses. Use this parameter to limit the IP address to this location. IP\n addresses cannot move between network border groups.

\n

Use DescribeAvailabilityZones to view the network border groups.

\n

You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 Classic, \n you receive an InvalidParameterCombination error.

" + } + }, + "CustomerOwnedIpv4Pool": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 \n select an address from the address pool. Alternatively, specify a specific \n address from the address pool.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the Elastic IP address.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.ec2#CreateTransitGatewayRouteTableAnnouncement" + "com.amazonaws.ec2#AllocateAddressResult": { + "type": "structure", + "members": { + "PublicIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicIp", + "smithy.api#documentation": "

The Elastic IP address.

", + "smithy.api#xmlName": "publicIp" + } + }, + "AllocationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AllocationId", + "smithy.api#documentation": "

The ID that represents the allocation of the Elastic IP address.

", + "smithy.api#xmlName": "allocationId" + } + }, + "PublicIpv4Pool": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicIpv4Pool", + "smithy.api#documentation": "

The ID of an address pool.

", + "smithy.api#xmlName": "publicIpv4Pool" + } + }, + "NetworkBorderGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkBorderGroup", + "smithy.api#documentation": "

The set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises\n IP addresses.

", + "smithy.api#xmlName": "networkBorderGroup" + } + }, + "Domain": { + "target": "com.amazonaws.ec2#DomainType", + "traits": { + "aws.protocols#ec2QueryName": "Domain", + "smithy.api#documentation": "

The network (vpc).

", + "smithy.api#xmlName": "domain" + } + }, + "CustomerOwnedIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CustomerOwnedIp", + "smithy.api#documentation": "

The customer-owned IP address.

", + "smithy.api#xmlName": "customerOwnedIp" + } + }, + "CustomerOwnedIpv4Pool": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CustomerOwnedIpv4Pool", + "smithy.api#documentation": "

The ID of the customer-owned address pool.

", + "smithy.api#xmlName": "customerOwnedIpv4Pool" + } + }, + "CarrierIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CarrierIp", + "smithy.api#documentation": "

The carrier IP address. This option is only available for network interfaces that reside\n in a subnet in a Wavelength Zone.

", + "smithy.api#xmlName": "carrierIp" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.ec2#CreateTransitGatewayVpcAttachment" + "com.amazonaws.ec2#AllocateHosts": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AllocateHostsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AllocateHostsResult" + }, + "traits": { + "smithy.api#documentation": "

Allocates a Dedicated Host to your account. At a minimum, specify the supported\n instance type or instance family, the Availability Zone in which to allocate the host,\n and the number of hosts to allocate.

" + } }, - { - "target": "com.amazonaws.ec2#CreateVerifiedAccessEndpoint" + "com.amazonaws.ec2#AllocateHostsRequest": { + "type": "structure", + "members": { + "AutoPlacement": { + "target": "com.amazonaws.ec2#AutoPlacement", + "traits": { + "aws.protocols#ec2QueryName": "AutoPlacement", + "smithy.api#documentation": "

Indicates whether the host accepts any untargeted instance launches that match its\n instance type configuration, or if it only accepts Host tenancy instance launches that\n specify its unique host ID. For more information, see Understanding auto-placement and affinity in the\n Amazon EC2 User Guide.

\n

Default: on\n

", + "smithy.api#xmlName": "autoPlacement" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Availability Zone in which to allocate the Dedicated Host.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "availabilityZone" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

", + "smithy.api#xmlName": "clientToken" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

Specifies the instance type to be supported by the Dedicated Hosts. If you specify an\n instance type, the Dedicated Hosts support instances of the specified instance type\n only.

\n

If you want the Dedicated Hosts to support multiple instance types in a specific\n instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the\n same request.

", + "smithy.api#xmlName": "instanceType" + } + }, + "InstanceFamily": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Specifies the instance family to be supported by the Dedicated Hosts. If you specify\n an instance family, the Dedicated Hosts support multiple instance types within that\n instance family.

\n

If you want the Dedicated Hosts to support a specific instance type only, omit this\n parameter and specify InstanceType instead. You cannot\n specify InstanceFamily and InstanceType in the same request.

" + } + }, + "Quantity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Quantity", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of Dedicated Hosts to allocate to your account with these\n parameters.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "quantity" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the Dedicated Host during creation.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "HostRecovery": { + "target": "com.amazonaws.ec2#HostRecovery", + "traits": { + "smithy.api#documentation": "

Indicates whether to enable or disable host recovery for the Dedicated Host. Host\n recovery is disabled by default. For more information, see Host recovery\n in the Amazon EC2 User Guide.

\n

Default: off\n

" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate\n the Dedicated Host.

" + } + }, + "HostMaintenance": { + "target": "com.amazonaws.ec2#HostMaintenance", + "traits": { + "smithy.api#documentation": "

Indicates whether to enable or disable host maintenance for the Dedicated Host. For\n more information, see Host\n maintenance in the Amazon EC2 User Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.ec2#CreateVerifiedAccessGroup" + "com.amazonaws.ec2#AllocateHostsResult": { + "type": "structure", + "members": { + "HostIds": { + "target": "com.amazonaws.ec2#ResponseHostIdList", + "traits": { + "aws.protocols#ec2QueryName": "HostIdSet", + "smithy.api#documentation": "

The ID of the allocated Dedicated Host. This is used to launch an instance onto a\n specific host.

", + "smithy.api#xmlName": "hostIdSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of AllocateHosts.

", + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.ec2#CreateVerifiedAccessInstance" + "com.amazonaws.ec2#AllocateIpamPoolCidr": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AllocateIpamPoolCidrRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AllocateIpamPoolCidrResult" + }, + "traits": { + "smithy.api#documentation": "

Allocate a CIDR from an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the Amazon Web Services Region where this IPAM pool is available for allocations.

\n

In IPAM, an allocation is a CIDR assignment from an IPAM pool to another IPAM pool or to a resource. For more information, see Allocate CIDRs in the Amazon VPC IPAM User Guide.

\n \n

This action creates an allocation with strong consistency. The returned CIDR will not overlap with any other allocations from the same pool.

\n " + } }, - { - "target": "com.amazonaws.ec2#CreateVerifiedAccessTrustProvider" + "com.amazonaws.ec2#AllocateIpamPoolCidrRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the IPAM pool from which you would like to allocate a CIDR.

", + "smithy.api#required": {} + } + }, + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The CIDR you would like to allocate from the IPAM pool. Note the following:

\n \n

Possible values: Any available IPv4 or IPv6 CIDR.

" + } + }, + "NetmaskLength": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The netmask length of the CIDR you would like to allocate from the IPAM pool. Note the following:

\n \n

Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the allocation.

" + } + }, + "PreviewNextCidr": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

A preview of the next available CIDR in a pool.

" + } + }, + "DisallowedCidrs": { + "target": "com.amazonaws.ec2#IpamPoolAllocationDisallowedCidrs", + "traits": { + "smithy.api#documentation": "

Exclude a particular CIDR range from being returned by the pool. Disallowed CIDRs are only allowed if using netmask length for allocation.

", + "smithy.api#xmlName": "DisallowedCidr" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.ec2#CreateVolume" + "com.amazonaws.ec2#AllocateIpamPoolCidrResult": { + "type": "structure", + "members": { + "IpamPoolAllocation": { + "target": "com.amazonaws.ec2#IpamPoolAllocation", + "traits": { + "aws.protocols#ec2QueryName": "IpamPoolAllocation", + "smithy.api#documentation": "

Information about the allocation created.

", + "smithy.api#xmlName": "ipamPoolAllocation" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.ec2#CreateVpc" + "com.amazonaws.ec2#AllocationId": { + "type": "string" }, - { - "target": "com.amazonaws.ec2#CreateVpcEndpoint" + "com.amazonaws.ec2#AllocationIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AllocationId", + "traits": { + "smithy.api#xmlName": "AllocationId" + } + } }, - { - "target": "com.amazonaws.ec2#CreateVpcEndpointConnectionNotification" + "com.amazonaws.ec2#AllocationIds": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AllocationId", + "traits": { + "smithy.api#xmlName": "item" + } + } }, - { - "target": "com.amazonaws.ec2#CreateVpcEndpointServiceConfiguration" + "com.amazonaws.ec2#AllocationState": { + "type": "enum", + "members": { + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "under_assessment": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "under-assessment" + } + }, + "permanent_failure": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "permanent-failure" + } + }, + "released": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "released" + } + }, + "released_permanent_failure": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "released-permanent-failure" + } + }, + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + } + } }, - { - "target": "com.amazonaws.ec2#CreateVpcPeeringConnection" + "com.amazonaws.ec2#AllocationStrategy": { + "type": "enum", + "members": { + "LOWEST_PRICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lowestPrice" + } + }, + "DIVERSIFIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "diversified" + } + }, + "CAPACITY_OPTIMIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "capacityOptimized" + } + }, + "CAPACITY_OPTIMIZED_PRIORITIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "capacityOptimizedPrioritized" + } + }, + "PRICE_CAPACITY_OPTIMIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "priceCapacityOptimized" + } + } + } }, - { - "target": "com.amazonaws.ec2#CreateVpnConnection" + "com.amazonaws.ec2#AllocationType": { + "type": "enum", + "members": { + "used": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "used" + } + } + } }, - { - "target": "com.amazonaws.ec2#CreateVpnConnectionRoute" + "com.amazonaws.ec2#AllowedInstanceType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\.\\*]+$" + } }, - { - "target": "com.amazonaws.ec2#CreateVpnGateway" + "com.amazonaws.ec2#AllowedInstanceTypeSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AllowedInstanceType", + "traits": { + "smithy.api#xmlName": "item" + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 400 + } + } }, - { - "target": "com.amazonaws.ec2#DeleteCarrierGateway" + "com.amazonaws.ec2#AllowedPrincipal": { + "type": "structure", + "members": { + "PrincipalType": { + "target": "com.amazonaws.ec2#PrincipalType", + "traits": { + "aws.protocols#ec2QueryName": "PrincipalType", + "smithy.api#documentation": "

The type of principal.

", + "smithy.api#xmlName": "principalType" + } + }, + "Principal": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Principal", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the principal.

", + "smithy.api#xmlName": "principal" + } + }, + "ServicePermissionId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ServicePermissionId", + "smithy.api#documentation": "

The ID of the service permission.

", + "smithy.api#xmlName": "servicePermissionId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags.

", + "smithy.api#xmlName": "tagSet" + } + }, + "ServiceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ServiceId", + "smithy.api#documentation": "

The ID of the service.

", + "smithy.api#xmlName": "serviceId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a principal.

" + } }, - { - "target": "com.amazonaws.ec2#DeleteClientVpnEndpoint" + "com.amazonaws.ec2#AllowedPrincipalSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AllowedPrincipal", + "traits": { + "smithy.api#xmlName": "item" + } + } }, - { - "target": "com.amazonaws.ec2#DeleteClientVpnRoute" + "com.amazonaws.ec2#AllowsMultipleInstanceTypes": { + "type": "enum", + "members": { + "on": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "on" + } + }, + "off": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "off" + } + } + } }, - { - "target": "com.amazonaws.ec2#DeleteCoipCidr" + "com.amazonaws.ec2#AlternatePathHint": { + "type": "structure", + "members": { + "ComponentId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ComponentId", + "smithy.api#documentation": "

The ID of the component.

", + "smithy.api#xmlName": "componentId" + } + }, + "ComponentArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ComponentArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component.

", + "smithy.api#xmlName": "componentArn" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an potential intermediate component of a feasible path.

" + } }, - { - "target": "com.amazonaws.ec2#DeleteCoipPool" + "com.amazonaws.ec2#AlternatePathHintList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AlternatePathHint", + "traits": { + "smithy.api#xmlName": "item" + } + } }, - { - "target": "com.amazonaws.ec2#DeleteCustomerGateway" - }, - { - "target": "com.amazonaws.ec2#DeleteDhcpOptions" - }, - { - "target": "com.amazonaws.ec2#DeleteEgressOnlyInternetGateway" - }, - { - "target": "com.amazonaws.ec2#DeleteFleets" - }, - { - "target": "com.amazonaws.ec2#DeleteFlowLogs" - }, - { - "target": "com.amazonaws.ec2#DeleteFpgaImage" - }, - { - "target": "com.amazonaws.ec2#DeleteInstanceEventWindow" - }, - { - "target": "com.amazonaws.ec2#DeleteInternetGateway" - }, - { - "target": "com.amazonaws.ec2#DeleteIpam" - }, - { - "target": "com.amazonaws.ec2#DeleteIpamPool" - }, - { - "target": "com.amazonaws.ec2#DeleteIpamResourceDiscovery" - }, - { - "target": "com.amazonaws.ec2#DeleteIpamScope" - }, - { - "target": "com.amazonaws.ec2#DeleteKeyPair" - }, - { - "target": "com.amazonaws.ec2#DeleteLaunchTemplate" - }, - { - "target": "com.amazonaws.ec2#DeleteLaunchTemplateVersions" - }, - { - "target": "com.amazonaws.ec2#DeleteLocalGatewayRoute" - }, - { - "target": "com.amazonaws.ec2#DeleteLocalGatewayRouteTable" - }, - { - "target": "com.amazonaws.ec2#DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation" - }, - { - "target": "com.amazonaws.ec2#DeleteLocalGatewayRouteTableVpcAssociation" - }, - { - "target": "com.amazonaws.ec2#DeleteManagedPrefixList" - }, - { - "target": "com.amazonaws.ec2#DeleteNatGateway" - }, - { - "target": "com.amazonaws.ec2#DeleteNetworkAcl" - }, - { - "target": "com.amazonaws.ec2#DeleteNetworkAclEntry" - }, - { - "target": "com.amazonaws.ec2#DeleteNetworkInsightsAccessScope" - }, - { - "target": "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeAnalysis" - }, - { - "target": "com.amazonaws.ec2#DeleteNetworkInsightsAnalysis" - }, - { - "target": "com.amazonaws.ec2#DeleteNetworkInsightsPath" - }, - { - "target": "com.amazonaws.ec2#DeleteNetworkInterface" - }, - { - "target": "com.amazonaws.ec2#DeleteNetworkInterfacePermission" - }, - { - "target": "com.amazonaws.ec2#DeletePlacementGroup" - }, - { - "target": "com.amazonaws.ec2#DeletePublicIpv4Pool" - }, - { - "target": "com.amazonaws.ec2#DeleteQueuedReservedInstances" - }, - { - "target": "com.amazonaws.ec2#DeleteRoute" - }, - { - "target": "com.amazonaws.ec2#DeleteRouteTable" - }, - { - "target": "com.amazonaws.ec2#DeleteSecurityGroup" - }, - { - "target": "com.amazonaws.ec2#DeleteSnapshot" - }, - { - "target": "com.amazonaws.ec2#DeleteSpotDatafeedSubscription" - }, - { - "target": "com.amazonaws.ec2#DeleteSubnet" - }, - { - "target": "com.amazonaws.ec2#DeleteSubnetCidrReservation" - }, - { - "target": "com.amazonaws.ec2#DeleteTags" - }, - { - "target": "com.amazonaws.ec2#DeleteTrafficMirrorFilter" - }, - { - "target": "com.amazonaws.ec2#DeleteTrafficMirrorFilterRule" - }, - { - "target": "com.amazonaws.ec2#DeleteTrafficMirrorSession" - }, - { - "target": "com.amazonaws.ec2#DeleteTrafficMirrorTarget" - }, - { - "target": "com.amazonaws.ec2#DeleteTransitGateway" - }, - { - "target": "com.amazonaws.ec2#DeleteTransitGatewayConnect" - }, - { - "target": "com.amazonaws.ec2#DeleteTransitGatewayConnectPeer" - }, - { - "target": "com.amazonaws.ec2#DeleteTransitGatewayMulticastDomain" - }, - { - "target": "com.amazonaws.ec2#DeleteTransitGatewayPeeringAttachment" - }, - { - "target": "com.amazonaws.ec2#DeleteTransitGatewayPolicyTable" - }, - { - "target": "com.amazonaws.ec2#DeleteTransitGatewayPrefixListReference" - }, - { - "target": "com.amazonaws.ec2#DeleteTransitGatewayRoute" - }, - { - "target": "com.amazonaws.ec2#DeleteTransitGatewayRouteTable" - }, - { - "target": "com.amazonaws.ec2#DeleteTransitGatewayRouteTableAnnouncement" - }, - { - "target": "com.amazonaws.ec2#DeleteTransitGatewayVpcAttachment" - }, - { - "target": "com.amazonaws.ec2#DeleteVerifiedAccessEndpoint" - }, - { - "target": "com.amazonaws.ec2#DeleteVerifiedAccessGroup" - }, - { - "target": "com.amazonaws.ec2#DeleteVerifiedAccessInstance" - }, - { - "target": "com.amazonaws.ec2#DeleteVerifiedAccessTrustProvider" - }, - { - "target": "com.amazonaws.ec2#DeleteVolume" - }, - { - "target": "com.amazonaws.ec2#DeleteVpc" - }, - { - "target": "com.amazonaws.ec2#DeleteVpcEndpointConnectionNotifications" - }, - { - "target": "com.amazonaws.ec2#DeleteVpcEndpoints" - }, - { - "target": "com.amazonaws.ec2#DeleteVpcEndpointServiceConfigurations" - }, - { - "target": "com.amazonaws.ec2#DeleteVpcPeeringConnection" - }, - { - "target": "com.amazonaws.ec2#DeleteVpnConnection" - }, - { - "target": "com.amazonaws.ec2#DeleteVpnConnectionRoute" - }, - { - "target": "com.amazonaws.ec2#DeleteVpnGateway" - }, - { - "target": "com.amazonaws.ec2#DeprovisionByoipCidr" - }, - { - "target": "com.amazonaws.ec2#DeprovisionIpamPoolCidr" - }, - { - "target": "com.amazonaws.ec2#DeprovisionPublicIpv4PoolCidr" - }, - { - "target": "com.amazonaws.ec2#DeregisterImage" - }, - { - "target": "com.amazonaws.ec2#DeregisterInstanceEventNotificationAttributes" - }, - { - "target": "com.amazonaws.ec2#DeregisterTransitGatewayMulticastGroupMembers" - }, - { - "target": "com.amazonaws.ec2#DeregisterTransitGatewayMulticastGroupSources" - }, - { - "target": "com.amazonaws.ec2#DescribeAccountAttributes" - }, - { - "target": "com.amazonaws.ec2#DescribeAddresses" - }, - { - "target": "com.amazonaws.ec2#DescribeAddressesAttribute" - }, - { - "target": "com.amazonaws.ec2#DescribeAddressTransfers" - }, - { - "target": "com.amazonaws.ec2#DescribeAggregateIdFormat" - }, - { - "target": "com.amazonaws.ec2#DescribeAvailabilityZones" - }, - { - "target": "com.amazonaws.ec2#DescribeAwsNetworkPerformanceMetricSubscriptions" - }, - { - "target": "com.amazonaws.ec2#DescribeBundleTasks" - }, - { - "target": "com.amazonaws.ec2#DescribeByoipCidrs" - }, - { - "target": "com.amazonaws.ec2#DescribeCapacityReservationFleets" - }, - { - "target": "com.amazonaws.ec2#DescribeCapacityReservations" - }, - { - "target": "com.amazonaws.ec2#DescribeCarrierGateways" - }, - { - "target": "com.amazonaws.ec2#DescribeClassicLinkInstances" - }, - { - "target": "com.amazonaws.ec2#DescribeClientVpnAuthorizationRules" - }, - { - "target": "com.amazonaws.ec2#DescribeClientVpnConnections" - }, - { - "target": "com.amazonaws.ec2#DescribeClientVpnEndpoints" - }, - { - "target": "com.amazonaws.ec2#DescribeClientVpnRoutes" - }, - { - "target": "com.amazonaws.ec2#DescribeClientVpnTargetNetworks" - }, - { - "target": "com.amazonaws.ec2#DescribeCoipPools" - }, - { - "target": "com.amazonaws.ec2#DescribeConversionTasks" - }, - { - "target": "com.amazonaws.ec2#DescribeCustomerGateways" - }, - { - "target": "com.amazonaws.ec2#DescribeDhcpOptions" - }, - { - "target": "com.amazonaws.ec2#DescribeEgressOnlyInternetGateways" - }, - { - "target": "com.amazonaws.ec2#DescribeElasticGpus" - }, - { - "target": "com.amazonaws.ec2#DescribeExportImageTasks" - }, - { - "target": "com.amazonaws.ec2#DescribeExportTasks" - }, - { - "target": "com.amazonaws.ec2#DescribeFastLaunchImages" - }, - { - "target": "com.amazonaws.ec2#DescribeFastSnapshotRestores" - }, - { - "target": "com.amazonaws.ec2#DescribeFleetHistory" - }, - { - "target": "com.amazonaws.ec2#DescribeFleetInstances" - }, - { - "target": "com.amazonaws.ec2#DescribeFleets" - }, - { - "target": "com.amazonaws.ec2#DescribeFlowLogs" - }, - { - "target": "com.amazonaws.ec2#DescribeFpgaImageAttribute" - }, - { - "target": "com.amazonaws.ec2#DescribeFpgaImages" - }, - { - "target": "com.amazonaws.ec2#DescribeHostReservationOfferings" - }, - { - "target": "com.amazonaws.ec2#DescribeHostReservations" - }, - { - "target": "com.amazonaws.ec2#DescribeHosts" - }, - { - "target": "com.amazonaws.ec2#DescribeIamInstanceProfileAssociations" - }, - { - "target": "com.amazonaws.ec2#DescribeIdentityIdFormat" - }, - { - "target": "com.amazonaws.ec2#DescribeIdFormat" - }, - { - "target": "com.amazonaws.ec2#DescribeImageAttribute" - }, - { - "target": "com.amazonaws.ec2#DescribeImages" - }, - { - "target": "com.amazonaws.ec2#DescribeImportImageTasks" - }, - { - "target": "com.amazonaws.ec2#DescribeImportSnapshotTasks" - }, - { - "target": "com.amazonaws.ec2#DescribeInstanceAttribute" - }, - { - "target": "com.amazonaws.ec2#DescribeInstanceCreditSpecifications" - }, - { - "target": "com.amazonaws.ec2#DescribeInstanceEventNotificationAttributes" - }, - { - "target": "com.amazonaws.ec2#DescribeInstanceEventWindows" - }, - { - "target": "com.amazonaws.ec2#DescribeInstances" - }, - { - "target": "com.amazonaws.ec2#DescribeInstanceStatus" - }, - { - "target": "com.amazonaws.ec2#DescribeInstanceTypeOfferings" - }, - { - "target": "com.amazonaws.ec2#DescribeInstanceTypes" - }, - { - "target": "com.amazonaws.ec2#DescribeInternetGateways" - }, - { - "target": "com.amazonaws.ec2#DescribeIpamPools" - }, - { - "target": "com.amazonaws.ec2#DescribeIpamResourceDiscoveries" - }, - { - "target": "com.amazonaws.ec2#DescribeIpamResourceDiscoveryAssociations" - }, - { - "target": "com.amazonaws.ec2#DescribeIpams" - }, - { - "target": "com.amazonaws.ec2#DescribeIpamScopes" - }, - { - "target": "com.amazonaws.ec2#DescribeIpv6Pools" - }, - { - "target": "com.amazonaws.ec2#DescribeKeyPairs" - }, - { - "target": "com.amazonaws.ec2#DescribeLaunchTemplates" - }, - { - "target": "com.amazonaws.ec2#DescribeLaunchTemplateVersions" - }, - { - "target": "com.amazonaws.ec2#DescribeLocalGatewayRouteTables" - }, - { - "target": "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations" - }, - { - "target": "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVpcAssociations" - }, - { - "target": "com.amazonaws.ec2#DescribeLocalGateways" - }, - { - "target": "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfaceGroups" - }, - { - "target": "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfaces" - }, - { - "target": "com.amazonaws.ec2#DescribeManagedPrefixLists" - }, - { - "target": "com.amazonaws.ec2#DescribeMovingAddresses" - }, - { - "target": "com.amazonaws.ec2#DescribeNatGateways" - }, - { - "target": "com.amazonaws.ec2#DescribeNetworkAcls" - }, - { - "target": "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopeAnalyses" - }, - { - "target": "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopes" - }, - { - "target": "com.amazonaws.ec2#DescribeNetworkInsightsAnalyses" - }, - { - "target": "com.amazonaws.ec2#DescribeNetworkInsightsPaths" - }, - { - "target": "com.amazonaws.ec2#DescribeNetworkInterfaceAttribute" - }, - { - "target": "com.amazonaws.ec2#DescribeNetworkInterfacePermissions" - }, - { - "target": "com.amazonaws.ec2#DescribeNetworkInterfaces" - }, - { - "target": "com.amazonaws.ec2#DescribePlacementGroups" - }, - { - "target": "com.amazonaws.ec2#DescribePrefixLists" - }, - { - "target": "com.amazonaws.ec2#DescribePrincipalIdFormat" - }, - { - "target": "com.amazonaws.ec2#DescribePublicIpv4Pools" - }, - { - "target": "com.amazonaws.ec2#DescribeRegions" - }, - { - "target": "com.amazonaws.ec2#DescribeReplaceRootVolumeTasks" - }, - { - "target": "com.amazonaws.ec2#DescribeReservedInstances" - }, - { - "target": "com.amazonaws.ec2#DescribeReservedInstancesListings" - }, - { - "target": "com.amazonaws.ec2#DescribeReservedInstancesModifications" - }, - { - "target": "com.amazonaws.ec2#DescribeReservedInstancesOfferings" - }, - { - "target": "com.amazonaws.ec2#DescribeRouteTables" - }, - { - "target": "com.amazonaws.ec2#DescribeScheduledInstanceAvailability" - }, - { - "target": "com.amazonaws.ec2#DescribeScheduledInstances" - }, - { - "target": "com.amazonaws.ec2#DescribeSecurityGroupReferences" - }, - { - "target": "com.amazonaws.ec2#DescribeSecurityGroupRules" - }, - { - "target": "com.amazonaws.ec2#DescribeSecurityGroups" - }, - { - "target": "com.amazonaws.ec2#DescribeSnapshotAttribute" - }, - { - "target": "com.amazonaws.ec2#DescribeSnapshots" - }, - { - "target": "com.amazonaws.ec2#DescribeSnapshotTierStatus" - }, - { - "target": "com.amazonaws.ec2#DescribeSpotDatafeedSubscription" - }, - { - "target": "com.amazonaws.ec2#DescribeSpotFleetInstances" - }, - { - "target": "com.amazonaws.ec2#DescribeSpotFleetRequestHistory" - }, - { - "target": "com.amazonaws.ec2#DescribeSpotFleetRequests" - }, - { - "target": "com.amazonaws.ec2#DescribeSpotInstanceRequests" - }, - { - "target": "com.amazonaws.ec2#DescribeSpotPriceHistory" - }, - { - "target": "com.amazonaws.ec2#DescribeStaleSecurityGroups" - }, - { - "target": "com.amazonaws.ec2#DescribeStoreImageTasks" - }, - { - "target": "com.amazonaws.ec2#DescribeSubnets" - }, - { - "target": "com.amazonaws.ec2#DescribeTags" - }, - { - "target": "com.amazonaws.ec2#DescribeTrafficMirrorFilters" - }, - { - "target": "com.amazonaws.ec2#DescribeTrafficMirrorSessions" - }, - { - "target": "com.amazonaws.ec2#DescribeTrafficMirrorTargets" - }, - { - "target": "com.amazonaws.ec2#DescribeTransitGatewayAttachments" - }, - { - "target": "com.amazonaws.ec2#DescribeTransitGatewayConnectPeers" - }, - { - "target": "com.amazonaws.ec2#DescribeTransitGatewayConnects" - }, - { - "target": "com.amazonaws.ec2#DescribeTransitGatewayMulticastDomains" - }, - { - "target": "com.amazonaws.ec2#DescribeTransitGatewayPeeringAttachments" - }, - { - "target": "com.amazonaws.ec2#DescribeTransitGatewayPolicyTables" - }, - { - "target": "com.amazonaws.ec2#DescribeTransitGatewayRouteTableAnnouncements" - }, - { - "target": "com.amazonaws.ec2#DescribeTransitGatewayRouteTables" - }, - { - "target": "com.amazonaws.ec2#DescribeTransitGateways" - }, - { - "target": "com.amazonaws.ec2#DescribeTransitGatewayVpcAttachments" - }, - { - "target": "com.amazonaws.ec2#DescribeTrunkInterfaceAssociations" - }, - { - "target": "com.amazonaws.ec2#DescribeVerifiedAccessEndpoints" - }, - { - "target": "com.amazonaws.ec2#DescribeVerifiedAccessGroups" - }, - { - "target": "com.amazonaws.ec2#DescribeVerifiedAccessInstanceLoggingConfigurations" - }, - { - "target": "com.amazonaws.ec2#DescribeVerifiedAccessInstances" - }, - { - "target": "com.amazonaws.ec2#DescribeVerifiedAccessTrustProviders" - }, - { - "target": "com.amazonaws.ec2#DescribeVolumeAttribute" - }, - { - "target": "com.amazonaws.ec2#DescribeVolumes" - }, - { - "target": "com.amazonaws.ec2#DescribeVolumesModifications" - }, - { - "target": "com.amazonaws.ec2#DescribeVolumeStatus" - }, - { - "target": "com.amazonaws.ec2#DescribeVpcAttribute" - }, - { - "target": "com.amazonaws.ec2#DescribeVpcClassicLink" - }, - { - "target": "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupport" - }, - { - "target": "com.amazonaws.ec2#DescribeVpcEndpointConnectionNotifications" - }, - { - "target": "com.amazonaws.ec2#DescribeVpcEndpointConnections" - }, - { - "target": "com.amazonaws.ec2#DescribeVpcEndpoints" - }, - { - "target": "com.amazonaws.ec2#DescribeVpcEndpointServiceConfigurations" - }, - { - "target": "com.amazonaws.ec2#DescribeVpcEndpointServicePermissions" - }, - { - "target": "com.amazonaws.ec2#DescribeVpcEndpointServices" - }, - { - "target": "com.amazonaws.ec2#DescribeVpcPeeringConnections" - }, - { - "target": "com.amazonaws.ec2#DescribeVpcs" - }, - { - "target": "com.amazonaws.ec2#DescribeVpnConnections" - }, - { - "target": "com.amazonaws.ec2#DescribeVpnGateways" - }, - { - "target": "com.amazonaws.ec2#DetachClassicLinkVpc" - }, - { - "target": "com.amazonaws.ec2#DetachInternetGateway" - }, - { - "target": "com.amazonaws.ec2#DetachNetworkInterface" - }, - { - "target": "com.amazonaws.ec2#DetachVerifiedAccessTrustProvider" - }, - { - "target": "com.amazonaws.ec2#DetachVolume" - }, - { - "target": "com.amazonaws.ec2#DetachVpnGateway" - }, - { - "target": "com.amazonaws.ec2#DisableAddressTransfer" - }, - { - "target": "com.amazonaws.ec2#DisableAwsNetworkPerformanceMetricSubscription" - }, - { - "target": "com.amazonaws.ec2#DisableEbsEncryptionByDefault" - }, - { - "target": "com.amazonaws.ec2#DisableFastLaunch" - }, - { - "target": "com.amazonaws.ec2#DisableFastSnapshotRestores" - }, - { - "target": "com.amazonaws.ec2#DisableImageDeprecation" - }, - { - "target": "com.amazonaws.ec2#DisableIpamOrganizationAdminAccount" - }, - { - "target": "com.amazonaws.ec2#DisableSerialConsoleAccess" - }, - { - "target": "com.amazonaws.ec2#DisableTransitGatewayRouteTablePropagation" - }, - { - "target": "com.amazonaws.ec2#DisableVgwRoutePropagation" - }, - { - "target": "com.amazonaws.ec2#DisableVpcClassicLink" - }, - { - "target": "com.amazonaws.ec2#DisableVpcClassicLinkDnsSupport" - }, - { - "target": "com.amazonaws.ec2#DisassociateAddress" - }, - { - "target": "com.amazonaws.ec2#DisassociateClientVpnTargetNetwork" - }, - { - "target": "com.amazonaws.ec2#DisassociateEnclaveCertificateIamRole" - }, - { - "target": "com.amazonaws.ec2#DisassociateIamInstanceProfile" - }, - { - "target": "com.amazonaws.ec2#DisassociateInstanceEventWindow" - }, - { - "target": "com.amazonaws.ec2#DisassociateIpamResourceDiscovery" - }, - { - "target": "com.amazonaws.ec2#DisassociateNatGatewayAddress" - }, - { - "target": "com.amazonaws.ec2#DisassociateRouteTable" - }, - { - "target": "com.amazonaws.ec2#DisassociateSubnetCidrBlock" - }, - { - "target": "com.amazonaws.ec2#DisassociateTransitGatewayMulticastDomain" - }, - { - "target": "com.amazonaws.ec2#DisassociateTransitGatewayPolicyTable" - }, - { - "target": "com.amazonaws.ec2#DisassociateTransitGatewayRouteTable" - }, - { - "target": "com.amazonaws.ec2#DisassociateTrunkInterface" - }, - { - "target": "com.amazonaws.ec2#DisassociateVpcCidrBlock" - }, - { - "target": "com.amazonaws.ec2#EnableAddressTransfer" - }, - { - "target": "com.amazonaws.ec2#EnableAwsNetworkPerformanceMetricSubscription" - }, - { - "target": "com.amazonaws.ec2#EnableEbsEncryptionByDefault" - }, - { - "target": "com.amazonaws.ec2#EnableFastLaunch" - }, - { - "target": "com.amazonaws.ec2#EnableFastSnapshotRestores" - }, - { - "target": "com.amazonaws.ec2#EnableImageDeprecation" - }, - { - "target": "com.amazonaws.ec2#EnableIpamOrganizationAdminAccount" - }, - { - "target": "com.amazonaws.ec2#EnableReachabilityAnalyzerOrganizationSharing" - }, - { - "target": "com.amazonaws.ec2#EnableSerialConsoleAccess" - }, - { - "target": "com.amazonaws.ec2#EnableTransitGatewayRouteTablePropagation" - }, - { - "target": "com.amazonaws.ec2#EnableVgwRoutePropagation" - }, - { - "target": "com.amazonaws.ec2#EnableVolumeIO" - }, - { - "target": "com.amazonaws.ec2#EnableVpcClassicLink" - }, - { - "target": "com.amazonaws.ec2#EnableVpcClassicLinkDnsSupport" - }, - { - "target": "com.amazonaws.ec2#ExportClientVpnClientCertificateRevocationList" - }, - { - "target": "com.amazonaws.ec2#ExportClientVpnClientConfiguration" - }, - { - "target": "com.amazonaws.ec2#ExportImage" - }, - { - "target": "com.amazonaws.ec2#ExportTransitGatewayRoutes" - }, - { - "target": "com.amazonaws.ec2#GetAssociatedEnclaveCertificateIamRoles" - }, - { - "target": "com.amazonaws.ec2#GetAssociatedIpv6PoolCidrs" - }, - { - "target": "com.amazonaws.ec2#GetAwsNetworkPerformanceData" - }, - { - "target": "com.amazonaws.ec2#GetCapacityReservationUsage" - }, - { - "target": "com.amazonaws.ec2#GetCoipPoolUsage" - }, - { - "target": "com.amazonaws.ec2#GetConsoleOutput" - }, - { - "target": "com.amazonaws.ec2#GetConsoleScreenshot" - }, - { - "target": "com.amazonaws.ec2#GetDefaultCreditSpecification" - }, - { - "target": "com.amazonaws.ec2#GetEbsDefaultKmsKeyId" - }, - { - "target": "com.amazonaws.ec2#GetEbsEncryptionByDefault" - }, - { - "target": "com.amazonaws.ec2#GetFlowLogsIntegrationTemplate" - }, - { - "target": "com.amazonaws.ec2#GetGroupsForCapacityReservation" - }, - { - "target": "com.amazonaws.ec2#GetHostReservationPurchasePreview" - }, - { - "target": "com.amazonaws.ec2#GetInstanceTypesFromInstanceRequirements" - }, - { - "target": "com.amazonaws.ec2#GetInstanceUefiData" - }, - { - "target": "com.amazonaws.ec2#GetIpamAddressHistory" - }, - { - "target": "com.amazonaws.ec2#GetIpamDiscoveredAccounts" - }, - { - "target": "com.amazonaws.ec2#GetIpamDiscoveredResourceCidrs" - }, - { - "target": "com.amazonaws.ec2#GetIpamPoolAllocations" - }, - { - "target": "com.amazonaws.ec2#GetIpamPoolCidrs" - }, - { - "target": "com.amazonaws.ec2#GetIpamResourceCidrs" - }, - { - "target": "com.amazonaws.ec2#GetLaunchTemplateData" - }, - { - "target": "com.amazonaws.ec2#GetManagedPrefixListAssociations" - }, - { - "target": "com.amazonaws.ec2#GetManagedPrefixListEntries" - }, - { - "target": "com.amazonaws.ec2#GetNetworkInsightsAccessScopeAnalysisFindings" - }, - { - "target": "com.amazonaws.ec2#GetNetworkInsightsAccessScopeContent" - }, - { - "target": "com.amazonaws.ec2#GetPasswordData" - }, - { - "target": "com.amazonaws.ec2#GetReservedInstancesExchangeQuote" - }, - { - "target": "com.amazonaws.ec2#GetSerialConsoleAccessStatus" - }, - { - "target": "com.amazonaws.ec2#GetSpotPlacementScores" - }, - { - "target": "com.amazonaws.ec2#GetSubnetCidrReservations" - }, - { - "target": "com.amazonaws.ec2#GetTransitGatewayAttachmentPropagations" - }, - { - "target": "com.amazonaws.ec2#GetTransitGatewayMulticastDomainAssociations" - }, - { - "target": "com.amazonaws.ec2#GetTransitGatewayPolicyTableAssociations" - }, - { - "target": "com.amazonaws.ec2#GetTransitGatewayPolicyTableEntries" - }, - { - "target": "com.amazonaws.ec2#GetTransitGatewayPrefixListReferences" - }, - { - "target": "com.amazonaws.ec2#GetTransitGatewayRouteTableAssociations" - }, - { - "target": "com.amazonaws.ec2#GetTransitGatewayRouteTablePropagations" - }, - { - "target": "com.amazonaws.ec2#GetVerifiedAccessEndpointPolicy" - }, - { - "target": "com.amazonaws.ec2#GetVerifiedAccessGroupPolicy" - }, - { - "target": "com.amazonaws.ec2#GetVpnConnectionDeviceSampleConfiguration" - }, - { - "target": "com.amazonaws.ec2#GetVpnConnectionDeviceTypes" - }, - { - "target": "com.amazonaws.ec2#GetVpnTunnelReplacementStatus" - }, - { - "target": "com.amazonaws.ec2#ImportClientVpnClientCertificateRevocationList" - }, - { - "target": "com.amazonaws.ec2#ImportImage" - }, - { - "target": "com.amazonaws.ec2#ImportInstance" - }, - { - "target": "com.amazonaws.ec2#ImportKeyPair" - }, - { - "target": "com.amazonaws.ec2#ImportSnapshot" - }, - { - "target": "com.amazonaws.ec2#ImportVolume" - }, - { - "target": "com.amazonaws.ec2#ListImagesInRecycleBin" - }, - { - "target": "com.amazonaws.ec2#ListSnapshotsInRecycleBin" - }, - { - "target": "com.amazonaws.ec2#ModifyAddressAttribute" - }, - { - "target": "com.amazonaws.ec2#ModifyAvailabilityZoneGroup" - }, - { - "target": "com.amazonaws.ec2#ModifyCapacityReservation" - }, - { - "target": "com.amazonaws.ec2#ModifyCapacityReservationFleet" - }, - { - "target": "com.amazonaws.ec2#ModifyClientVpnEndpoint" - }, - { - "target": "com.amazonaws.ec2#ModifyDefaultCreditSpecification" - }, - { - "target": "com.amazonaws.ec2#ModifyEbsDefaultKmsKeyId" - }, - { - "target": "com.amazonaws.ec2#ModifyFleet" - }, - { - "target": "com.amazonaws.ec2#ModifyFpgaImageAttribute" - }, - { - "target": "com.amazonaws.ec2#ModifyHosts" - }, - { - "target": "com.amazonaws.ec2#ModifyIdentityIdFormat" - }, - { - "target": "com.amazonaws.ec2#ModifyIdFormat" - }, - { - "target": "com.amazonaws.ec2#ModifyImageAttribute" - }, - { - "target": "com.amazonaws.ec2#ModifyInstanceAttribute" - }, - { - "target": "com.amazonaws.ec2#ModifyInstanceCapacityReservationAttributes" - }, - { - "target": "com.amazonaws.ec2#ModifyInstanceCreditSpecification" - }, - { - "target": "com.amazonaws.ec2#ModifyInstanceEventStartTime" - }, - { - "target": "com.amazonaws.ec2#ModifyInstanceEventWindow" - }, - { - "target": "com.amazonaws.ec2#ModifyInstanceMaintenanceOptions" - }, - { - "target": "com.amazonaws.ec2#ModifyInstanceMetadataOptions" - }, - { - "target": "com.amazonaws.ec2#ModifyInstancePlacement" - }, - { - "target": "com.amazonaws.ec2#ModifyIpam" - }, - { - "target": "com.amazonaws.ec2#ModifyIpamPool" - }, - { - "target": "com.amazonaws.ec2#ModifyIpamResourceCidr" - }, - { - "target": "com.amazonaws.ec2#ModifyIpamResourceDiscovery" - }, - { - "target": "com.amazonaws.ec2#ModifyIpamScope" - }, - { - "target": "com.amazonaws.ec2#ModifyLaunchTemplate" - }, - { - "target": "com.amazonaws.ec2#ModifyLocalGatewayRoute" - }, - { - "target": "com.amazonaws.ec2#ModifyManagedPrefixList" - }, - { - "target": "com.amazonaws.ec2#ModifyNetworkInterfaceAttribute" - }, - { - "target": "com.amazonaws.ec2#ModifyPrivateDnsNameOptions" - }, - { - "target": "com.amazonaws.ec2#ModifyReservedInstances" - }, - { - "target": "com.amazonaws.ec2#ModifySecurityGroupRules" - }, - { - "target": "com.amazonaws.ec2#ModifySnapshotAttribute" - }, - { - "target": "com.amazonaws.ec2#ModifySnapshotTier" - }, - { - "target": "com.amazonaws.ec2#ModifySpotFleetRequest" - }, - { - "target": "com.amazonaws.ec2#ModifySubnetAttribute" - }, - { - "target": "com.amazonaws.ec2#ModifyTrafficMirrorFilterNetworkServices" - }, - { - "target": "com.amazonaws.ec2#ModifyTrafficMirrorFilterRule" - }, - { - "target": "com.amazonaws.ec2#ModifyTrafficMirrorSession" - }, - { - "target": "com.amazonaws.ec2#ModifyTransitGateway" - }, - { - "target": "com.amazonaws.ec2#ModifyTransitGatewayPrefixListReference" - }, - { - "target": "com.amazonaws.ec2#ModifyTransitGatewayVpcAttachment" - }, - { - "target": "com.amazonaws.ec2#ModifyVerifiedAccessEndpoint" - }, - { - "target": "com.amazonaws.ec2#ModifyVerifiedAccessEndpointPolicy" - }, - { - "target": "com.amazonaws.ec2#ModifyVerifiedAccessGroup" - }, - { - "target": "com.amazonaws.ec2#ModifyVerifiedAccessGroupPolicy" - }, - { - "target": "com.amazonaws.ec2#ModifyVerifiedAccessInstance" - }, - { - "target": "com.amazonaws.ec2#ModifyVerifiedAccessInstanceLoggingConfiguration" - }, - { - "target": "com.amazonaws.ec2#ModifyVerifiedAccessTrustProvider" - }, - { - "target": "com.amazonaws.ec2#ModifyVolume" - }, - { - "target": "com.amazonaws.ec2#ModifyVolumeAttribute" - }, - { - "target": "com.amazonaws.ec2#ModifyVpcAttribute" - }, - { - "target": "com.amazonaws.ec2#ModifyVpcEndpoint" - }, - { - "target": "com.amazonaws.ec2#ModifyVpcEndpointConnectionNotification" - }, - { - "target": "com.amazonaws.ec2#ModifyVpcEndpointServiceConfiguration" - }, - { - "target": "com.amazonaws.ec2#ModifyVpcEndpointServicePayerResponsibility" - }, - { - "target": "com.amazonaws.ec2#ModifyVpcEndpointServicePermissions" - }, - { - "target": "com.amazonaws.ec2#ModifyVpcPeeringConnectionOptions" - }, - { - "target": "com.amazonaws.ec2#ModifyVpcTenancy" - }, - { - "target": "com.amazonaws.ec2#ModifyVpnConnection" - }, - { - "target": "com.amazonaws.ec2#ModifyVpnConnectionOptions" - }, - { - "target": "com.amazonaws.ec2#ModifyVpnTunnelCertificate" - }, - { - "target": "com.amazonaws.ec2#ModifyVpnTunnelOptions" - }, - { - "target": "com.amazonaws.ec2#MonitorInstances" - }, - { - "target": "com.amazonaws.ec2#MoveAddressToVpc" - }, - { - "target": "com.amazonaws.ec2#MoveByoipCidrToIpam" - }, - { - "target": "com.amazonaws.ec2#ProvisionByoipCidr" - }, - { - "target": "com.amazonaws.ec2#ProvisionIpamPoolCidr" - }, - { - "target": "com.amazonaws.ec2#ProvisionPublicIpv4PoolCidr" - }, - { - "target": "com.amazonaws.ec2#PurchaseHostReservation" - }, - { - "target": "com.amazonaws.ec2#PurchaseReservedInstancesOffering" - }, - { - "target": "com.amazonaws.ec2#PurchaseScheduledInstances" - }, - { - "target": "com.amazonaws.ec2#RebootInstances" - }, - { - "target": "com.amazonaws.ec2#RegisterImage" - }, - { - "target": "com.amazonaws.ec2#RegisterInstanceEventNotificationAttributes" - }, - { - "target": "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupMembers" - }, - { - "target": "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupSources" - }, - { - "target": "com.amazonaws.ec2#RejectTransitGatewayMulticastDomainAssociations" - }, - { - "target": "com.amazonaws.ec2#RejectTransitGatewayPeeringAttachment" - }, - { - "target": "com.amazonaws.ec2#RejectTransitGatewayVpcAttachment" - }, - { - "target": "com.amazonaws.ec2#RejectVpcEndpointConnections" - }, - { - "target": "com.amazonaws.ec2#RejectVpcPeeringConnection" - }, - { - "target": "com.amazonaws.ec2#ReleaseAddress" - }, - { - "target": "com.amazonaws.ec2#ReleaseHosts" - }, - { - "target": "com.amazonaws.ec2#ReleaseIpamPoolAllocation" - }, - { - "target": "com.amazonaws.ec2#ReplaceIamInstanceProfileAssociation" - }, - { - "target": "com.amazonaws.ec2#ReplaceNetworkAclAssociation" - }, - { - "target": "com.amazonaws.ec2#ReplaceNetworkAclEntry" - }, - { - "target": "com.amazonaws.ec2#ReplaceRoute" - }, - { - "target": "com.amazonaws.ec2#ReplaceRouteTableAssociation" - }, - { - "target": "com.amazonaws.ec2#ReplaceTransitGatewayRoute" - }, - { - "target": "com.amazonaws.ec2#ReplaceVpnTunnel" - }, - { - "target": "com.amazonaws.ec2#ReportInstanceStatus" - }, - { - "target": "com.amazonaws.ec2#RequestSpotFleet" - }, - { - "target": "com.amazonaws.ec2#RequestSpotInstances" - }, - { - "target": "com.amazonaws.ec2#ResetAddressAttribute" - }, - { - "target": "com.amazonaws.ec2#ResetEbsDefaultKmsKeyId" - }, - { - "target": "com.amazonaws.ec2#ResetFpgaImageAttribute" - }, - { - "target": "com.amazonaws.ec2#ResetImageAttribute" - }, - { - "target": "com.amazonaws.ec2#ResetInstanceAttribute" - }, - { - "target": "com.amazonaws.ec2#ResetNetworkInterfaceAttribute" - }, - { - "target": "com.amazonaws.ec2#ResetSnapshotAttribute" - }, - { - "target": "com.amazonaws.ec2#RestoreAddressToClassic" - }, - { - "target": "com.amazonaws.ec2#RestoreImageFromRecycleBin" - }, - { - "target": "com.amazonaws.ec2#RestoreManagedPrefixListVersion" - }, - { - "target": "com.amazonaws.ec2#RestoreSnapshotFromRecycleBin" - }, - { - "target": "com.amazonaws.ec2#RestoreSnapshotTier" - }, - { - "target": "com.amazonaws.ec2#RevokeClientVpnIngress" - }, - { - "target": "com.amazonaws.ec2#RevokeSecurityGroupEgress" - }, - { - "target": "com.amazonaws.ec2#RevokeSecurityGroupIngress" - }, - { - "target": "com.amazonaws.ec2#RunInstances" - }, - { - "target": "com.amazonaws.ec2#RunScheduledInstances" - }, - { - "target": "com.amazonaws.ec2#SearchLocalGatewayRoutes" - }, - { - "target": "com.amazonaws.ec2#SearchTransitGatewayMulticastGroups" - }, - { - "target": "com.amazonaws.ec2#SearchTransitGatewayRoutes" - }, - { - "target": "com.amazonaws.ec2#SendDiagnosticInterrupt" - }, - { - "target": "com.amazonaws.ec2#StartInstances" - }, - { - "target": "com.amazonaws.ec2#StartNetworkInsightsAccessScopeAnalysis" - }, - { - "target": "com.amazonaws.ec2#StartNetworkInsightsAnalysis" - }, - { - "target": "com.amazonaws.ec2#StartVpcEndpointServicePrivateDnsVerification" - }, - { - "target": "com.amazonaws.ec2#StopInstances" - }, - { - "target": "com.amazonaws.ec2#TerminateClientVpnConnections" - }, - { - "target": "com.amazonaws.ec2#TerminateInstances" - }, - { - "target": "com.amazonaws.ec2#UnassignIpv6Addresses" - }, - { - "target": "com.amazonaws.ec2#UnassignPrivateIpAddresses" - }, - { - "target": "com.amazonaws.ec2#UnassignPrivateNatGatewayAddress" - }, - { - "target": "com.amazonaws.ec2#UnmonitorInstances" - }, - { - "target": "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsEgress" - }, - { - "target": "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsIngress" - }, - { - "target": "com.amazonaws.ec2#WithdrawByoipCidr" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "EC2", - "arnNamespace": "ec2", - "cloudFormationName": "EC2", - "cloudTrailEventSource": "ec2.amazonaws.com", - "endpointPrefix": "ec2" - }, - "aws.auth#sigv4": { - "name": "ec2" - }, - "aws.protocols#ec2Query": {}, - "smithy.api#documentation": "Amazon Elastic Compute Cloud\n

Amazon Elastic Compute Cloud (Amazon EC2) provides secure and resizable computing capacity in the Amazon Web Services Cloud. \n Using Amazon EC2 eliminates the need to invest in hardware up front, so you can develop and deploy applications \n faster. Amazon Virtual Private Cloud (Amazon VPC) enables you to provision a logically isolated section of the \n Amazon Web Services Cloud where you can launch Amazon Web Services resources in a virtual network that you've defined. Amazon Elastic Block Store \n (Amazon EBS) provides block level storage volumes for use with EC2 instances. EBS volumes are highly available \n and reliable storage volumes that can be attached to any running instance and used like a hard drive.

\n

To learn more, see the following resources:

\n ", - "smithy.api#title": "Amazon Elastic Compute Cloud", - "smithy.api#xmlNamespace": { - "uri": "http://ec2.amazonaws.com/doc/2016-11-15" - }, - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://ec2-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - "aws-us-gov", - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - } - ] - } - ], - "endpoint": { - "url": "https://ec2.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://ec2-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://ec2.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ] - }, - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://ec2.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - } - ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ec2.af-south-1.amazonaws.com" - } - }, - "params": { - "Region": "af-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ec2.ap-east-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ec2.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ec2.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ec2.ap-northeast-3.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ec2.ap-south-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://ec2.ap-south-1.api.aws" - } - }, - "params": { - "Region": "ap-south-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ec2.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ec2.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ec2.ap-southeast-3.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ec2.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ec2-fips.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ec2.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ec2.eu-north-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ec2.eu-south-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ec2.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://ec2.eu-west-1.api.aws" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ec2.eu-west-2.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ec2.eu-west-3.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ec2.me-south-1.amazonaws.com" - } - }, - "params": { - "Region": "me-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ec2.sa-east-1.amazonaws.com" - } - }, - "params": { - "Region": "sa-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://ec2.sa-east-1.api.aws" - } - }, - "params": { - "Region": "sa-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ec2.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ec2-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://ec2.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ec2.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ec2-fips.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://ec2.us-east-2.api.aws" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ec2.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ec2-fips.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ec2.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ec2-fips.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://ec2.us-west-2.api.aws" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://ec2-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ec2.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ec2.cn-northwest-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-northwest-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://ec2-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ec2-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://ec2.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ec2.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ec2.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://ec2-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ec2.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://ec2.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ec2.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ec2.us-iso-west-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ec2-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ec2.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ec2-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.ec2#AmdSevSnpSpecification": { - "type": "enum", - "members": { - "enabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enabled" - } - }, - "disabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disabled" - } - } - } - }, - "com.amazonaws.ec2#AnalysisAclRule": { - "type": "structure", - "members": { - "Cidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Cidr", - "smithy.api#documentation": "

The IPv4 address range, in CIDR notation.

", - "smithy.api#xmlName": "cidr" - } - }, - "Egress": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Egress", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the rule is an outbound rule.

", - "smithy.api#xmlName": "egress" - } - }, - "PortRange": { - "target": "com.amazonaws.ec2#PortRange", - "traits": { - "aws.protocols#ec2QueryName": "PortRange", - "smithy.api#documentation": "

The range of ports.

", - "smithy.api#xmlName": "portRange" - } - }, - "Protocol": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Protocol", - "smithy.api#documentation": "

The protocol.

", - "smithy.api#xmlName": "protocol" - } - }, - "RuleAction": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "RuleAction", - "smithy.api#documentation": "

Indicates whether to allow or deny traffic that matches the rule.

", - "smithy.api#xmlName": "ruleAction" - } - }, - "RuleNumber": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "RuleNumber", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The rule number.

", - "smithy.api#xmlName": "ruleNumber" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a network access control (ACL) rule.

" - } - }, - "com.amazonaws.ec2#AnalysisComponent": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Id", - "smithy.api#documentation": "

The ID of the component.

", - "smithy.api#xmlName": "id" - } - }, - "Arn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Arn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component.

", - "smithy.api#xmlName": "arn" - } - }, - "Name": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Name", - "smithy.api#documentation": "

The name of the analysis component.

", - "smithy.api#xmlName": "name" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a path component.

" - } - }, - "com.amazonaws.ec2#AnalysisComponentList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#AnalysisComponent", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#AnalysisLoadBalancerListener": { - "type": "structure", - "members": { - "LoadBalancerPort": { - "target": "com.amazonaws.ec2#Port", - "traits": { - "aws.protocols#ec2QueryName": "LoadBalancerPort", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The port on which the load balancer is listening.

", - "smithy.api#xmlName": "loadBalancerPort" - } - }, - "InstancePort": { - "target": "com.amazonaws.ec2#Port", - "traits": { - "aws.protocols#ec2QueryName": "InstancePort", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

[Classic Load Balancers] The back-end port for the listener.

", - "smithy.api#xmlName": "instancePort" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a load balancer listener.

" - } - }, - "com.amazonaws.ec2#AnalysisLoadBalancerTarget": { - "type": "structure", - "members": { - "Address": { - "target": "com.amazonaws.ec2#IpAddress", - "traits": { - "aws.protocols#ec2QueryName": "Address", - "smithy.api#documentation": "

The IP address.

", - "smithy.api#xmlName": "address" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone.

", - "smithy.api#xmlName": "availabilityZone" - } - }, - "Instance": { - "target": "com.amazonaws.ec2#AnalysisComponent", - "traits": { - "aws.protocols#ec2QueryName": "Instance", - "smithy.api#documentation": "

Information about the instance.

", - "smithy.api#xmlName": "instance" - } - }, - "Port": { - "target": "com.amazonaws.ec2#Port", - "traits": { - "aws.protocols#ec2QueryName": "Port", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The port on which the target is listening.

", - "smithy.api#xmlName": "port" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a load balancer target.

" - } - }, - "com.amazonaws.ec2#AnalysisPacketHeader": { - "type": "structure", - "members": { - "DestinationAddresses": { - "target": "com.amazonaws.ec2#IpAddressList", - "traits": { - "aws.protocols#ec2QueryName": "DestinationAddressSet", - "smithy.api#documentation": "

The destination addresses.

", - "smithy.api#xmlName": "destinationAddressSet" - } - }, - "DestinationPortRanges": { - "target": "com.amazonaws.ec2#PortRangeList", - "traits": { - "aws.protocols#ec2QueryName": "DestinationPortRangeSet", - "smithy.api#documentation": "

The destination port ranges.

", - "smithy.api#xmlName": "destinationPortRangeSet" - } - }, - "Protocol": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Protocol", - "smithy.api#documentation": "

The protocol.

", - "smithy.api#xmlName": "protocol" - } - }, - "SourceAddresses": { - "target": "com.amazonaws.ec2#IpAddressList", - "traits": { - "aws.protocols#ec2QueryName": "SourceAddressSet", - "smithy.api#documentation": "

The source addresses.

", - "smithy.api#xmlName": "sourceAddressSet" - } - }, - "SourcePortRanges": { - "target": "com.amazonaws.ec2#PortRangeList", - "traits": { - "aws.protocols#ec2QueryName": "SourcePortRangeSet", - "smithy.api#documentation": "

The source port ranges.

", - "smithy.api#xmlName": "sourcePortRangeSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a header. Reflects any changes made by a component as traffic passes through.\n The fields of an inbound header are null except for the first component of a path.

" - } - }, - "com.amazonaws.ec2#AnalysisRouteTableRoute": { - "type": "structure", - "members": { - "DestinationCidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DestinationCidr", - "smithy.api#documentation": "

The destination IPv4 address, in CIDR notation.

", - "smithy.api#xmlName": "destinationCidr" - } - }, - "DestinationPrefixListId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DestinationPrefixListId", - "smithy.api#documentation": "

The prefix of the Amazon Web Service.

", - "smithy.api#xmlName": "destinationPrefixListId" - } - }, - "EgressOnlyInternetGatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "EgressOnlyInternetGatewayId", - "smithy.api#documentation": "

The ID of an egress-only internet gateway.

", - "smithy.api#xmlName": "egressOnlyInternetGatewayId" - } - }, - "GatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GatewayId", - "smithy.api#documentation": "

The ID of the gateway, such as an internet gateway or virtual private gateway.

", - "smithy.api#xmlName": "gatewayId" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance, such as a NAT instance.

", - "smithy.api#xmlName": "instanceId" - } - }, - "NatGatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NatGatewayId", - "smithy.api#documentation": "

The ID of a NAT gateway.

", - "smithy.api#xmlName": "natGatewayId" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "

The ID of a network interface.

", - "smithy.api#xmlName": "networkInterfaceId" - } - }, - "Origin": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Origin", - "smithy.api#documentation": "

Describes how the route was created. The following are the possible values:

\n ", - "smithy.api#xmlName": "origin" - } - }, - "TransitGatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayId", - "smithy.api#documentation": "

The ID of a transit gateway.

", - "smithy.api#xmlName": "transitGatewayId" - } - }, - "VpcPeeringConnectionId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", - "smithy.api#documentation": "

The ID of a VPC peering connection.

", - "smithy.api#xmlName": "vpcPeeringConnectionId" - } - }, - "State": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state. The following are the possible values:

\n ", - "smithy.api#xmlName": "state" - } - }, - "CarrierGatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CarrierGatewayId", - "smithy.api#documentation": "

The ID of a carrier gateway.

", - "smithy.api#xmlName": "carrierGatewayId" - } - }, - "CoreNetworkArn": { - "target": "com.amazonaws.ec2#ResourceArn", - "traits": { - "aws.protocols#ec2QueryName": "CoreNetworkArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a core network.

", - "smithy.api#xmlName": "coreNetworkArn" - } - }, - "LocalGatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayId", - "smithy.api#documentation": "

The ID of a local gateway.

", - "smithy.api#xmlName": "localGatewayId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a route table route.

" - } - }, - "com.amazonaws.ec2#AnalysisSecurityGroupRule": { - "type": "structure", - "members": { - "Cidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Cidr", - "smithy.api#documentation": "

The IPv4 address range, in CIDR notation.

", - "smithy.api#xmlName": "cidr" - } - }, - "Direction": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Direction", - "smithy.api#documentation": "

The direction. The following are the possible values:

\n ", - "smithy.api#xmlName": "direction" - } - }, - "SecurityGroupId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SecurityGroupId", - "smithy.api#documentation": "

The security group ID.

", - "smithy.api#xmlName": "securityGroupId" - } - }, - "PortRange": { - "target": "com.amazonaws.ec2#PortRange", - "traits": { - "aws.protocols#ec2QueryName": "PortRange", - "smithy.api#documentation": "

The port range.

", - "smithy.api#xmlName": "portRange" - } - }, - "PrefixListId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrefixListId", - "smithy.api#documentation": "

The prefix list ID.

", - "smithy.api#xmlName": "prefixListId" - } - }, - "Protocol": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Protocol", - "smithy.api#documentation": "

The protocol name.

", - "smithy.api#xmlName": "protocol" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a security group rule.

" - } - }, - "com.amazonaws.ec2#AnalysisStatus": { - "type": "enum", - "members": { - "running": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "running" - } - }, - "succeeded": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "succeeded" - } - }, - "failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failed" - } - } - } - }, - "com.amazonaws.ec2#ApplianceModeSupportValue": { - "type": "enum", - "members": { - "enable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enable" - } - }, - "disable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disable" - } - } - } - }, - "com.amazonaws.ec2#ApplySecurityGroupsToClientVpnTargetNetwork": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ApplySecurityGroupsToClientVpnTargetNetworkRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ApplySecurityGroupsToClientVpnTargetNetworkResult" - }, - "traits": { - "smithy.api#documentation": "

Applies a security group to the association between the target network and the Client VPN endpoint. This action replaces the existing \n\t\t\tsecurity groups with the specified security groups.

" - } - }, - "com.amazonaws.ec2#ApplySecurityGroupsToClientVpnTargetNetworkRequest": { - "type": "structure", - "members": { - "ClientVpnEndpointId": { - "target": "com.amazonaws.ec2#ClientVpnEndpointId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", - "smithy.api#required": {} - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the VPC in which the associated target network is located.

", - "smithy.api#required": {} - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.ec2#ClientVpnSecurityGroupIdSet", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IDs of the security groups to apply to the associated target network. Up to 5 security groups can \n\t\t\tbe applied to an associated target network.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "SecurityGroupId" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ApplySecurityGroupsToClientVpnTargetNetworkResult": { - "type": "structure", - "members": { - "SecurityGroupIds": { - "target": "com.amazonaws.ec2#ClientVpnSecurityGroupIdSet", - "traits": { - "aws.protocols#ec2QueryName": "SecurityGroupIds", - "smithy.api#documentation": "

The IDs of the applied security groups.

", - "smithy.api#xmlName": "securityGroupIds" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ArchitectureType": { - "type": "enum", - "members": { - "i386": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "i386" - } - }, - "x86_64": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x86_64" - } - }, - "arm64": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "arm64" - } - }, - "x86_64_mac": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x86_64_mac" - } - }, - "arm64_mac": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "arm64_mac" - } - } - } - }, - "com.amazonaws.ec2#ArchitectureTypeList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ArchitectureType", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ArchitectureTypeSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ArchitectureType", - "traits": { - "smithy.api#xmlName": "item" - } - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 3 - } - } - }, - "com.amazonaws.ec2#ArchitectureValues": { - "type": "enum", - "members": { - "i386": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "i386" - } - }, - "x86_64": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x86_64" - } - }, - "arm64": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "arm64" - } - }, - "x86_64_mac": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x86_64_mac" - } - }, - "arm64_mac": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "arm64_mac" - } - } - } - }, - "com.amazonaws.ec2#ArnList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ResourceArn", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#AssignIpv6Addresses": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#AssignIpv6AddressesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#AssignIpv6AddressesResult" - }, - "traits": { - "smithy.api#documentation": "

Assigns one or more IPv6 addresses to the specified network interface. You can\n specify one or more specific IPv6 addresses, or you can specify the number of IPv6\n addresses to be automatically assigned from within the subnet's IPv6 CIDR block range.\n You can assign as many IPv6 addresses to a network interface as you can assign private\n IPv4 addresses, and the limit varies per instance type. For information, see IP Addresses Per Network Interface Per Instance Type\n in the Amazon Elastic Compute Cloud User Guide.

\n

You must specify either the IPv6 addresses or the IPv6 address count in the request.

\n

You can optionally use Prefix Delegation on the network interface. You must specify\n either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For\n information, see \n Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#AssignIpv6AddressesRequest": { - "type": "structure", - "members": { - "Ipv6AddressCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6AddressCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of additional IPv6 addresses to assign to the network interface. \n \t\tThe specified number of IPv6 addresses are assigned in addition to the \n \t\texisting IPv6 addresses that are already assigned to the network interface. \n \t\tAmazon EC2 automatically selects the IPv6 addresses from the subnet range. You \n \t\tcan't use this option if specifying specific IPv6 addresses.

", - "smithy.api#xmlName": "ipv6AddressCount" - } - }, - "Ipv6Addresses": { - "target": "com.amazonaws.ec2#Ipv6AddressList", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6Addresses", - "smithy.api#documentation": "

The IPv6 addresses to be assigned to the network interface. You can't use this option if you're specifying a number of IPv6 addresses.

", - "smithy.api#xmlName": "ipv6Addresses" - } - }, - "Ipv6PrefixCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of IPv6 prefixes that Amazon Web Services automatically assigns to the\n network interface. You cannot use this option if you use the Ipv6Prefixes\n option.

" - } - }, - "Ipv6Prefixes": { - "target": "com.amazonaws.ec2#IpPrefixList", - "traits": { - "smithy.api#documentation": "

One or more IPv6 prefixes assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.

", - "smithy.api#xmlName": "Ipv6Prefix" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#NetworkInterfaceId", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the network interface.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "networkInterfaceId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#AssignIpv6AddressesResult": { - "type": "structure", - "members": { - "AssignedIpv6Addresses": { - "target": "com.amazonaws.ec2#Ipv6AddressList", - "traits": { - "aws.protocols#ec2QueryName": "AssignedIpv6Addresses", - "smithy.api#documentation": "

The new IPv6 addresses assigned to the network interface. Existing IPv6 addresses \n \tthat were assigned to the network interface before the request are not included.

", - "smithy.api#xmlName": "assignedIpv6Addresses" - } - }, - "AssignedIpv6Prefixes": { - "target": "com.amazonaws.ec2#IpPrefixList", - "traits": { - "aws.protocols#ec2QueryName": "AssignedIpv6PrefixSet", - "smithy.api#documentation": "

The IPv6 prefixes that are assigned to the network interface.

", - "smithy.api#xmlName": "assignedIpv6PrefixSet" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "

The ID of the network interface.

", - "smithy.api#xmlName": "networkInterfaceId" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#AssignPrivateIpAddresses": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#AssignPrivateIpAddressesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#AssignPrivateIpAddressesResult" - }, - "traits": { - "smithy.api#documentation": "

Assigns one or more secondary private IP addresses to the specified network interface.

\n

You can specify one or more specific secondary IP addresses, or you can specify the number \n of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. \n The number of secondary IP addresses that you can assign to an instance varies by instance type.\n For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about \n Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

\n

When you move a secondary private IP address to another network interface, any Elastic IP address \n that is associated with the IP address is also moved.

\n

Remapping an IP address is an asynchronous operation. When you move an IP address from one network\n interface to another, check network/interfaces/macs/mac/local-ipv4s in the instance\n metadata to confirm that the remapping is complete.

\n

You must specify either the IP addresses or the IP address count in the request.

\n

You can optionally use Prefix Delegation on the network interface. You must specify\n either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For\n information, see \n Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#AssignPrivateIpAddressesRequest": { - "type": "structure", - "members": { - "AllowReassignment": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "AllowReassignment", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#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.

", - "smithy.api#xmlName": "allowReassignment" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#NetworkInterfaceId", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the network interface.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "networkInterfaceId" - } - }, - "PrivateIpAddresses": { - "target": "com.amazonaws.ec2#PrivateIpAddressStringList", - "traits": { - "aws.protocols#ec2QueryName": "PrivateIpAddress", - "smithy.api#documentation": "

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

\n

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

", - "smithy.api#xmlName": "privateIpAddress" - } - }, - "SecondaryPrivateIpAddressCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "SecondaryPrivateIpAddressCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#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.

", - "smithy.api#xmlName": "secondaryPrivateIpAddressCount" - } - }, - "Ipv4Prefixes": { - "target": "com.amazonaws.ec2#IpPrefixList", - "traits": { - "smithy.api#documentation": "

One or more IPv4 prefixes assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.

", - "smithy.api#xmlName": "Ipv4Prefix" - } - }, - "Ipv4PrefixCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes option.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for AssignPrivateIpAddresses.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#AssignPrivateIpAddressesResult": { - "type": "structure", - "members": { - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "

The ID of the network interface.

", - "smithy.api#xmlName": "networkInterfaceId" - } - }, - "AssignedPrivateIpAddresses": { - "target": "com.amazonaws.ec2#AssignedPrivateIpAddressList", - "traits": { - "aws.protocols#ec2QueryName": "AssignedPrivateIpAddressesSet", - "smithy.api#documentation": "

The private IP addresses assigned to the network interface.

", - "smithy.api#xmlName": "assignedPrivateIpAddressesSet" - } - }, - "AssignedIpv4Prefixes": { - "target": "com.amazonaws.ec2#Ipv4PrefixesList", - "traits": { - "aws.protocols#ec2QueryName": "AssignedIpv4PrefixSet", - "smithy.api#documentation": "

The IPv4 prefixes that are assigned to the network interface.

", - "smithy.api#xmlName": "assignedIpv4PrefixSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#AssignPrivateNatGatewayAddress": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#AssignPrivateNatGatewayAddressRequest" - }, - "output": { - "target": "com.amazonaws.ec2#AssignPrivateNatGatewayAddressResult" - }, - "traits": { - "smithy.api#documentation": "

Assigns one or more private IPv4 addresses to a private NAT gateway. For more information, see Work with NAT gateways in the Amazon Virtual Private Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#AssignPrivateNatGatewayAddressRequest": { - "type": "structure", - "members": { - "NatGatewayId": { - "target": "com.amazonaws.ec2#NatGatewayId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The NAT gateway ID.

", - "smithy.api#required": {} - } - }, - "PrivateIpAddresses": { - "target": "com.amazonaws.ec2#IpList", - "traits": { - "smithy.api#documentation": "

The private IPv4 addresses you want to assign to the private NAT gateway.

", - "smithy.api#xmlName": "PrivateIpAddress" - } - }, - "PrivateIpAddressCount": { - "target": "com.amazonaws.ec2#PrivateIpAddressCount", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of private IP addresses to assign to the NAT gateway. You can't specify this parameter when also specifying private IP addresses.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#AssignPrivateNatGatewayAddressResult": { - "type": "structure", - "members": { - "NatGatewayId": { - "target": "com.amazonaws.ec2#NatGatewayId", - "traits": { - "aws.protocols#ec2QueryName": "NatGatewayId", - "smithy.api#documentation": "

The NAT gateway ID.

", - "smithy.api#xmlName": "natGatewayId" - } - }, - "NatGatewayAddresses": { - "target": "com.amazonaws.ec2#NatGatewayAddressList", - "traits": { - "aws.protocols#ec2QueryName": "NatGatewayAddressSet", - "smithy.api#documentation": "

NAT gateway IP addresses.

", - "smithy.api#xmlName": "natGatewayAddressSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#AssignedPrivateIpAddress": { - "type": "structure", - "members": { - "PrivateIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrivateIpAddress", - "smithy.api#documentation": "

The private IP address assigned to the network interface.

", - "smithy.api#xmlName": "privateIpAddress" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the private IP addresses assigned to a network interface.

" - } - }, - "com.amazonaws.ec2#AssignedPrivateIpAddressList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#AssignedPrivateIpAddress", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#AssociateAddress": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#AssociateAddressRequest" - }, - "output": { - "target": "com.amazonaws.ec2#AssociateAddressResult" - }, - "traits": { - "smithy.api#documentation": "

Associates an Elastic IP address, or carrier IP address (for instances that are in\n subnets in Wavelength Zones) with an instance or a network interface. Before you can use an\n Elastic IP address, you must allocate it to your account.

\n

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC.\n\t\t\tFor more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

\n

[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already\n associated with a different instance, it is disassociated from that instance and associated\n with the specified instance. If you associate an Elastic IP address with an instance that has\n an existing Elastic IP address, the existing address is disassociated from the instance, but\n remains allocated to your account.

\n

[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic\n IP address is associated with the primary IP address. If the Elastic IP address is already\n associated with a different instance or a network interface, you get an error unless you allow\n reassociation. You cannot associate an Elastic IP address with an instance or network\n interface that has an existing Elastic IP address.

\n

[Subnets in Wavelength Zones] You can associate an IP address from the telecommunication\n carrier to the instance or network interface.

\n

You cannot associate an Elastic IP address with an interface in a different network border group.

\n \n

This is an idempotent operation. If you perform the operation more than once, Amazon EC2\n doesn't return an error, and you may be charged for each time the Elastic IP address is\n remapped to the same instance. For more information, see the Elastic IP\n Addresses section of Amazon EC2\n Pricing.

\n \n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " - } - }, - "com.amazonaws.ec2#AssociateAddressRequest": { - "type": "structure", - "members": { - "AllocationId": { - "target": "com.amazonaws.ec2#AllocationId", - "traits": { - "smithy.api#documentation": "

[EC2-VPC] The allocation ID. This is required for EC2-VPC.

" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "smithy.api#documentation": "

The ID of the instance. The instance must have exactly one attached network interface.\n For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both.\n For EC2-Classic, you must specify an instance ID and the instance must be in the running\n state.

" - } - }, - "PublicIp": { - "target": "com.amazonaws.ec2#EipAllocationPublicIp", - "traits": { - "smithy.api#documentation": "

[EC2-Classic] The Elastic IP address to associate with the instance. This is required for\n EC2-Classic.

" - } - }, - "AllowReassociation": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "AllowReassociation", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#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.

", - "smithy.api#xmlName": "allowReassociation" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#NetworkInterfaceId", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#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.

\n

For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both.

", - "smithy.api#xmlName": "networkInterfaceId" - } - }, - "PrivateIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrivateIpAddress", - "smithy.api#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.

", - "smithy.api#xmlName": "privateIpAddress" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#AssociateAddressResult": { - "type": "structure", - "members": { - "AssociationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AssociationId", - "smithy.api#documentation": "

[EC2-VPC] The ID that represents the association of the Elastic IP address with an instance.

", - "smithy.api#xmlName": "associationId" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#AssociateClientVpnTargetNetwork": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#AssociateClientVpnTargetNetworkRequest" - }, - "output": { - "target": "com.amazonaws.ec2#AssociateClientVpnTargetNetworkResult" - }, - "traits": { - "smithy.api#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.

\n

If you specified a VPC when you created the Client VPN endpoint or if you have previous subnet associations, the specified subnet must be in the same VPC. To specify a subnet that's in a different VPC, you must first modify the Client VPN endpoint (ModifyClientVpnEndpoint) and change the VPC that's associated with it.

" - } - }, - "com.amazonaws.ec2#AssociateClientVpnTargetNetworkRequest": { - "type": "structure", - "members": { - "ClientVpnEndpointId": { - "target": "com.amazonaws.ec2#ClientVpnEndpointId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", - "smithy.api#required": {} - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#SubnetId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the subnet to associate with the Client VPN endpoint.

", - "smithy.api#required": {} - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

", - "smithy.api#idempotencyToken": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#AssociateClientVpnTargetNetworkResult": { - "type": "structure", - "members": { - "AssociationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AssociationId", - "smithy.api#documentation": "

The unique ID of the target network association.

", - "smithy.api#xmlName": "associationId" - } - }, - "Status": { - "target": "com.amazonaws.ec2#AssociationStatus", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The current state of the target network association.

", - "smithy.api#xmlName": "status" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#AssociateDhcpOptions": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#AssociateDhcpOptionsRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.

\n

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.

\n

For more information, see DHCP options sets\n in the Amazon Virtual Private Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#AssociateDhcpOptionsRequest": { - "type": "structure", - "members": { - "DhcpOptionsId": { - "target": "com.amazonaws.ec2#DefaultingDhcpOptionsId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the DHCP options set, or default to associate \n no DHCP options with the VPC.

", - "smithy.api#required": {} - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#AssociateEnclaveCertificateIamRole": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#AssociateEnclaveCertificateIamRoleRequest" - }, - "output": { - "target": "com.amazonaws.ec2#AssociateEnclaveCertificateIamRoleResult" - }, - "traits": { - "smithy.api#documentation": "

Associates an Identity and Access Management (IAM) role with an Certificate Manager (ACM) certificate. \n\t\t\tThis enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. For more \n\t\t\tinformation, see Certificate Manager for Nitro Enclaves in the Amazon Web Services Nitro Enclaves \n\t\t\t\t\tUser Guide.

\n

When the IAM role is associated with the ACM certificate, the certificate, certificate chain, and encrypted \n\t\t\tprivate key are placed in an Amazon S3 location that only the associated IAM role can access. The private key of the certificate \n\t\t\tis encrypted with an Amazon Web Services managed key that has an attached attestation-based key policy.

\n

To enable the IAM role to access the Amazon S3 object, you must grant it permission to call s3:GetObject \n\t\t\ton the Amazon S3 bucket returned by the command. To enable the IAM role to access the KMS key,\n\t\t\tyou must grant it permission to call kms:Decrypt on the KMS key returned by the command. \n\t\t\tFor more information, see \n\t\t\t\tGrant the role permission to access the certificate and encryption key in the \n\t\t\tAmazon Web Services Nitro Enclaves User Guide.

" - } - }, - "com.amazonaws.ec2#AssociateEnclaveCertificateIamRoleRequest": { - "type": "structure", - "members": { - "CertificateArn": { - "target": "com.amazonaws.ec2#CertificateId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ARN of the ACM certificate with which to associate the IAM role.

", - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.ec2#RoleId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ARN of the IAM role to associate with the ACM certificate. You can associate up to 16 IAM roles with an ACM \n\t\t\tcertificate.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#AssociateEnclaveCertificateIamRoleResult": { - "type": "structure", - "members": { - "CertificateS3BucketName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CertificateS3BucketName", - "smithy.api#documentation": "

The name of the Amazon S3 bucket to which the certificate was uploaded.

", - "smithy.api#xmlName": "certificateS3BucketName" - } - }, - "CertificateS3ObjectKey": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CertificateS3ObjectKey", - "smithy.api#documentation": "

The Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored. The \n\t\t\tobject key is formatted as follows: role_arn/certificate_arn.

", - "smithy.api#xmlName": "certificateS3ObjectKey" - } - }, - "EncryptionKmsKeyId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "EncryptionKmsKeyId", - "smithy.api#documentation": "

The ID of the KMS key used to encrypt the private key of the certificate.

", - "smithy.api#xmlName": "encryptionKmsKeyId" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#AssociateIamInstanceProfile": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#AssociateIamInstanceProfileRequest" - }, - "output": { - "target": "com.amazonaws.ec2#AssociateIamInstanceProfileResult" - }, - "traits": { - "smithy.api#documentation": "

Associates an IAM instance profile with a running or stopped instance. You cannot\n associate more than one IAM instance profile with an instance.

" - } - }, - "com.amazonaws.ec2#AssociateIamInstanceProfileRequest": { - "type": "structure", - "members": { - "IamInstanceProfile": { - "target": "com.amazonaws.ec2#IamInstanceProfileSpecification", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IAM instance profile.

", - "smithy.api#required": {} - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#AssociateIamInstanceProfileResult": { - "type": "structure", - "members": { - "IamInstanceProfileAssociation": { - "target": "com.amazonaws.ec2#IamInstanceProfileAssociation", - "traits": { - "aws.protocols#ec2QueryName": "IamInstanceProfileAssociation", - "smithy.api#documentation": "

Information about the IAM instance profile association.

", - "smithy.api#xmlName": "iamInstanceProfileAssociation" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#AssociateInstanceEventWindow": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#AssociateInstanceEventWindowRequest" - }, - "output": { - "target": "com.amazonaws.ec2#AssociateInstanceEventWindowResult" - }, - "traits": { - "smithy.api#documentation": "

Associates one or more targets with an event window. Only one type of target (instance IDs,\n Dedicated Host IDs, or tags) can be specified with an event window.

\n

For more information, see Define event windows for scheduled\n events in the Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#AssociateInstanceEventWindowRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "InstanceEventWindowId": { - "target": "com.amazonaws.ec2#InstanceEventWindowId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the event window.

", - "smithy.api#required": {} - } - }, - "AssociationTarget": { - "target": "com.amazonaws.ec2#InstanceEventWindowAssociationRequest", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

One or more targets associated with the specified event window.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#AssociateInstanceEventWindowResult": { - "type": "structure", - "members": { - "InstanceEventWindow": { - "target": "com.amazonaws.ec2#InstanceEventWindow", - "traits": { - "aws.protocols#ec2QueryName": "InstanceEventWindow", - "smithy.api#documentation": "

Information about the event window.

", - "smithy.api#xmlName": "instanceEventWindow" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#AssociateIpamResourceDiscovery": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#AssociateIpamResourceDiscoveryRequest" - }, - "output": { - "target": "com.amazonaws.ec2#AssociateIpamResourceDiscoveryResult" - }, - "traits": { - "smithy.api#documentation": "

Associates an IPAM resource discovery with an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

" - } - }, - "com.amazonaws.ec2#AssociateIpamResourceDiscoveryRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "IpamId": { - "target": "com.amazonaws.ec2#IpamId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

An IPAM ID.

", - "smithy.api#required": {} - } - }, - "IpamResourceDiscoveryId": { - "target": "com.amazonaws.ec2#IpamResourceDiscoveryId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A resource discovery ID.

", - "smithy.api#required": {} - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

Tag specifications.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A client token.

", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#AssociateIpamResourceDiscoveryResult": { - "type": "structure", - "members": { - "IpamResourceDiscoveryAssociation": { - "target": "com.amazonaws.ec2#IpamResourceDiscoveryAssociation", - "traits": { - "aws.protocols#ec2QueryName": "IpamResourceDiscoveryAssociation", - "smithy.api#documentation": "

A resource discovery association. An associated resource discovery is a resource discovery that has been associated with an IPAM.

", - "smithy.api#xmlName": "ipamResourceDiscoveryAssociation" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#AssociateNatGatewayAddress": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#AssociateNatGatewayAddressRequest" - }, - "output": { - "target": "com.amazonaws.ec2#AssociateNatGatewayAddressResult" - }, - "traits": { - "smithy.api#documentation": "

Associates Elastic IP addresses (EIPs) and private IPv4 addresses with a public NAT gateway. For more information, see Work with NAT gateways in the Amazon Virtual Private Cloud User Guide.

\n

By default, you can associate up to 2 Elastic IP addresses per public NAT gateway. You can increase the limit by requesting a quota adjustment. For more information, see Elastic IP address quotas in the Amazon Virtual Private Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#AssociateNatGatewayAddressRequest": { - "type": "structure", - "members": { - "NatGatewayId": { - "target": "com.amazonaws.ec2#NatGatewayId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The NAT gateway ID.

", - "smithy.api#required": {} - } - }, - "AllocationIds": { - "target": "com.amazonaws.ec2#AllocationIdList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The allocation IDs of EIPs that you want to associate with your NAT gateway.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "AllocationId" - } - }, - "PrivateIpAddresses": { - "target": "com.amazonaws.ec2#IpList", - "traits": { - "smithy.api#documentation": "

The private IPv4 addresses that you want to assign to the NAT gateway.

", - "smithy.api#xmlName": "PrivateIpAddress" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#AssociateNatGatewayAddressResult": { - "type": "structure", - "members": { - "NatGatewayId": { - "target": "com.amazonaws.ec2#NatGatewayId", - "traits": { - "aws.protocols#ec2QueryName": "NatGatewayId", - "smithy.api#documentation": "

The NAT gateway ID.

", - "smithy.api#xmlName": "natGatewayId" - } - }, - "NatGatewayAddresses": { - "target": "com.amazonaws.ec2#NatGatewayAddressList", - "traits": { - "aws.protocols#ec2QueryName": "NatGatewayAddressSet", - "smithy.api#documentation": "

The IP addresses.

", - "smithy.api#xmlName": "natGatewayAddressSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#AssociateRouteTable": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#AssociateRouteTableRequest" - }, - "output": { - "target": "com.amazonaws.ec2#AssociateRouteTableResult" - }, - "traits": { - "smithy.api#documentation": "

Associates a subnet in your VPC or an internet gateway or virtual private gateway\n attached to your VPC with a route table in your VPC. This association causes traffic\n from the subnet or gateway to be routed according to the routes in the route table. The\n action returns an association ID, which you need in order to disassociate the route\n table later. A route table can be associated with multiple subnets.

\n

For more information, see Route tables in the\n Amazon Virtual Private Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#AssociateRouteTableRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "RouteTableId": { - "target": "com.amazonaws.ec2#RouteTableId", - "traits": { - "aws.protocols#ec2QueryName": "RouteTableId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the route table.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "routeTableId" - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#SubnetId", - "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#documentation": "

The ID of the subnet.

", - "smithy.api#xmlName": "subnetId" - } - }, - "GatewayId": { - "target": "com.amazonaws.ec2#RouteGatewayId", - "traits": { - "smithy.api#documentation": "

The ID of the internet gateway or virtual private gateway.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#AssociateRouteTableResult": { - "type": "structure", - "members": { - "AssociationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AssociationId", - "smithy.api#documentation": "

The route table association ID. This ID is required for disassociating the route\n\t\t\ttable.

", - "smithy.api#xmlName": "associationId" - } - }, - "AssociationState": { - "target": "com.amazonaws.ec2#RouteTableAssociationState", - "traits": { - "aws.protocols#ec2QueryName": "AssociationState", - "smithy.api#documentation": "

The state of the association.

", - "smithy.api#xmlName": "associationState" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#AssociateSubnetCidrBlock": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#AssociateSubnetCidrBlockRequest" - }, - "output": { - "target": "com.amazonaws.ec2#AssociateSubnetCidrBlockResult" - }, - "traits": { - "smithy.api#documentation": "

Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR\n block with your subnet. An IPv6 CIDR block must have a prefix length of /64.

" - } - }, - "com.amazonaws.ec2#AssociateSubnetCidrBlockRequest": { - "type": "structure", - "members": { - "Ipv6CidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6CidrBlock", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IPv6 CIDR block for your subnet. The subnet must have a /64 prefix\n length.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "ipv6CidrBlock" - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#SubnetId", - "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of your subnet.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "subnetId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#AssociateSubnetCidrBlockResult": { - "type": "structure", - "members": { - "Ipv6CidrBlockAssociation": { - "target": "com.amazonaws.ec2#SubnetIpv6CidrBlockAssociation", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6CidrBlockAssociation", - "smithy.api#documentation": "

Information about the IPv6 association.

", - "smithy.api#xmlName": "ipv6CidrBlockAssociation" - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#documentation": "

The ID of the subnet.

", - "smithy.api#xmlName": "subnetId" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#AssociateTransitGatewayMulticastDomain": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#AssociateTransitGatewayMulticastDomainRequest" - }, - "output": { - "target": "com.amazonaws.ec2#AssociateTransitGatewayMulticastDomainResult" - }, - "traits": { - "smithy.api#documentation": "

Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.

\n

The transit gateway attachment must be in the available state before you can add a resource. Use DescribeTransitGatewayAttachments \n to see the state of the attachment.

" - } - }, - "com.amazonaws.ec2#AssociateTransitGatewayMulticastDomainRequest": { - "type": "structure", - "members": { - "TransitGatewayMulticastDomainId": { - "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", - "smithy.api#required": {} - } - }, - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the transit gateway attachment to associate with the transit gateway multicast domain.

", - "smithy.api#required": {} - } - }, - "SubnetIds": { - "target": "com.amazonaws.ec2#TransitGatewaySubnetIdList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IDs of the subnets to associate with the transit gateway multicast domain.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#AssociateTransitGatewayMulticastDomainResult": { - "type": "structure", - "members": { - "Associations": { - "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainAssociations", - "traits": { - "aws.protocols#ec2QueryName": "Associations", - "smithy.api#documentation": "

Information about the transit gateway multicast domain associations.

", - "smithy.api#xmlName": "associations" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#AssociateTransitGatewayPolicyTable": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#AssociateTransitGatewayPolicyTableRequest" - }, - "output": { - "target": "com.amazonaws.ec2#AssociateTransitGatewayPolicyTableResult" - }, - "traits": { - "smithy.api#documentation": "

Associates the specified transit gateway attachment with a transit gateway policy table.

" - } - }, - "com.amazonaws.ec2#AssociateTransitGatewayPolicyTableRequest": { - "type": "structure", - "members": { - "TransitGatewayPolicyTableId": { - "target": "com.amazonaws.ec2#TransitGatewayPolicyTableId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the transit gateway policy table to associate with the transit gateway attachment.

", - "smithy.api#required": {} - } - }, - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the transit gateway attachment to associate with the policy table.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#AssociateTransitGatewayPolicyTableResult": { - "type": "structure", - "members": { - "Association": { - "target": "com.amazonaws.ec2#TransitGatewayPolicyTableAssociation", - "traits": { - "aws.protocols#ec2QueryName": "Association", - "smithy.api#documentation": "

Describes the association of a transit gateway and a transit gateway policy table.

", - "smithy.api#xmlName": "association" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#AssociateTransitGatewayRouteTable": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#AssociateTransitGatewayRouteTableRequest" - }, - "output": { - "target": "com.amazonaws.ec2#AssociateTransitGatewayRouteTableResult" - }, - "traits": { - "smithy.api#documentation": "

Associates the specified attachment with the specified transit gateway route table. You can \n associate only one route table with an attachment.

" - } - }, - "com.amazonaws.ec2#AssociateTransitGatewayRouteTableRequest": { - "type": "structure", - "members": { - "TransitGatewayRouteTableId": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the transit gateway route table.

", - "smithy.api#required": {} - } - }, - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the attachment.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#AssociateTransitGatewayRouteTableResult": { - "type": "structure", - "members": { - "Association": { - "target": "com.amazonaws.ec2#TransitGatewayAssociation", - "traits": { - "aws.protocols#ec2QueryName": "Association", - "smithy.api#documentation": "

The ID of the association.

", - "smithy.api#xmlName": "association" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#AssociateTrunkInterface": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#AssociateTrunkInterfaceRequest" - }, - "output": { - "target": "com.amazonaws.ec2#AssociateTrunkInterfaceResult" - }, - "traits": { - "smithy.api#documentation": "\n

This API action is currently in limited preview only. \n If you are interested in using this feature, contact your account manager.

\n \n

Associates a branch network interface with a trunk network interface.

\n

Before you create the association, run the create-network-interface command and set\n --interface-type to trunk. You must also create a network interface for each branch network interface that you want to associate with the trunk network interface.

" - } - }, - "com.amazonaws.ec2#AssociateTrunkInterfaceRequest": { - "type": "structure", - "members": { - "BranchInterfaceId": { - "target": "com.amazonaws.ec2#NetworkInterfaceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the branch network interface.

", - "smithy.api#required": {} - } - }, - "TrunkInterfaceId": { - "target": "com.amazonaws.ec2#NetworkInterfaceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the trunk network interface.

", - "smithy.api#required": {} - } - }, - "VlanId": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The ID of the VLAN. This applies to the VLAN protocol.

" - } - }, - "GreKey": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The application key. This applies to the GRE protocol.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to Ensure\n Idempotency.

", - "smithy.api#idempotencyToken": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#AssociateTrunkInterfaceResult": { - "type": "structure", - "members": { - "InterfaceAssociation": { - "target": "com.amazonaws.ec2#TrunkInterfaceAssociation", - "traits": { - "aws.protocols#ec2QueryName": "InterfaceAssociation", - "smithy.api#documentation": "

Information about the association between the trunk network interface and branch network interface.

", - "smithy.api#xmlName": "interfaceAssociation" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to Ensure\n Idempotency.

", - "smithy.api#xmlName": "clientToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#AssociateVpcCidrBlock": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#AssociateVpcCidrBlockRequest" - }, - "output": { - "target": "com.amazonaws.ec2#AssociateVpcCidrBlockResult" - }, - "traits": { - "smithy.api#documentation": "

Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block,\n an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that\n you provisioned through bring your own IP addresses (BYOIP). The IPv6 CIDR block size is fixed\n at /56.

\n

You must specify one of the following in the request: an IPv4 CIDR block, an IPv6\n pool, or an Amazon-provided IPv6 CIDR block.

\n

For more information about associating CIDR blocks with your VPC and applicable\n restrictions, see VPC and subnet sizing in the\n Amazon Virtual Private Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#AssociateVpcCidrBlockRequest": { - "type": "structure", - "members": { - "AmazonProvidedIpv6CidrBlock": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "AmazonProvidedIpv6CidrBlock", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#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.

", - "smithy.api#xmlName": "amazonProvidedIpv6CidrBlock" - } - }, - "CidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

An IPv4 CIDR block to associate with the VPC.

" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "vpcId" - } - }, - "Ipv6CidrBlockNetworkBorderGroup": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The name of the location from which we advertise the IPV6 CIDR block. Use this parameter\n to limit the CIDR block to this location.

\n

You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.

\n

You can have one IPv6 CIDR block association per network border group.

" - } - }, - "Ipv6Pool": { - "target": "com.amazonaws.ec2#Ipv6PoolEc2Id", - "traits": { - "smithy.api#documentation": "

The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.

" - } - }, - "Ipv6CidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

An IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.

\n

To let Amazon choose the IPv6 CIDR block for you, omit this parameter.

" - } - }, - "Ipv4IpamPoolId": { - "target": "com.amazonaws.ec2#IpamPoolId", - "traits": { - "smithy.api#documentation": "

Associate a CIDR allocated from an IPv4 IPAM pool to a VPC. For more information about Amazon VPC IP Address Manager (IPAM), see What is IPAM? in the Amazon VPC IPAM User Guide.

" - } - }, - "Ipv4NetmaskLength": { - "target": "com.amazonaws.ec2#NetmaskLength", - "traits": { - "smithy.api#documentation": "

The netmask length of the IPv4 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.\n

" - } - }, - "Ipv6IpamPoolId": { - "target": "com.amazonaws.ec2#IpamPoolId", - "traits": { - "smithy.api#documentation": "

Associates a CIDR allocated from an IPv6 IPAM pool to a VPC. For more information about Amazon VPC IP Address Manager (IPAM), see What is IPAM? in the Amazon VPC IPAM User Guide.

" - } - }, - "Ipv6NetmaskLength": { - "target": "com.amazonaws.ec2#NetmaskLength", - "traits": { - "smithy.api#documentation": "

The netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#AssociateVpcCidrBlockResult": { - "type": "structure", - "members": { - "Ipv6CidrBlockAssociation": { - "target": "com.amazonaws.ec2#VpcIpv6CidrBlockAssociation", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6CidrBlockAssociation", - "smithy.api#documentation": "

Information about the IPv6 CIDR block association.

", - "smithy.api#xmlName": "ipv6CidrBlockAssociation" - } - }, - "CidrBlockAssociation": { - "target": "com.amazonaws.ec2#VpcCidrBlockAssociation", - "traits": { - "aws.protocols#ec2QueryName": "CidrBlockAssociation", - "smithy.api#documentation": "

Information about the IPv4 CIDR block association.

", - "smithy.api#xmlName": "cidrBlockAssociation" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#xmlName": "vpcId" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#AssociatedNetworkType": { - "type": "enum", - "members": { - "vpc": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "vpc" - } - } - } - }, - "com.amazonaws.ec2#AssociatedRole": { - "type": "structure", - "members": { - "AssociatedRoleArn": { - "target": "com.amazonaws.ec2#ResourceArn", - "traits": { - "aws.protocols#ec2QueryName": "AssociatedRoleArn", - "smithy.api#documentation": "

The ARN of the associated IAM role.

", - "smithy.api#xmlName": "associatedRoleArn" - } - }, - "CertificateS3BucketName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CertificateS3BucketName", - "smithy.api#documentation": "

The name of the Amazon S3 bucket in which the Amazon S3 object is stored.

", - "smithy.api#xmlName": "certificateS3BucketName" - } - }, - "CertificateS3ObjectKey": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CertificateS3ObjectKey", - "smithy.api#documentation": "

The key of the Amazon S3 object ey where the certificate, certificate chain, and encrypted private key bundle \n\t\t\tis stored. The object key is formated as follows: role_arn/certificate_arn.\n\t\t

", - "smithy.api#xmlName": "certificateS3ObjectKey" - } - }, - "EncryptionKmsKeyId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "EncryptionKmsKeyId", - "smithy.api#documentation": "

The ID of the KMS customer master key (CMK) used to encrypt the private key.

", - "smithy.api#xmlName": "encryptionKmsKeyId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the associated IAM roles.

" - } - }, - "com.amazonaws.ec2#AssociatedRolesList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#AssociatedRole", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#AssociatedTargetNetwork": { - "type": "structure", - "members": { - "NetworkId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NetworkId", - "smithy.api#documentation": "

The ID of the subnet.

", - "smithy.api#xmlName": "networkId" - } - }, - "NetworkType": { - "target": "com.amazonaws.ec2#AssociatedNetworkType", - "traits": { - "aws.protocols#ec2QueryName": "NetworkType", - "smithy.api#documentation": "

The target network type.

", - "smithy.api#xmlName": "networkType" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a target network that is associated with a Client VPN endpoint. A target network is a subnet in a VPC.

" - } - }, - "com.amazonaws.ec2#AssociatedTargetNetworkSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#AssociatedTargetNetwork", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#AssociationIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#IamInstanceProfileAssociationId", - "traits": { - "smithy.api#xmlName": "AssociationId" - } - } - }, - "com.amazonaws.ec2#AssociationStatus": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.ec2#AssociationStatusCode", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The state of the target network association.

", - "smithy.api#xmlName": "code" - } - }, - "Message": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "

A message about the status of the target network association, if applicable.

", - "smithy.api#xmlName": "message" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the state of a target network association.

" - } - }, - "com.amazonaws.ec2#AssociationStatusCode": { - "type": "enum", - "members": { - "associating": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "associating" - } - }, - "associated": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "associated" - } - }, - "association_failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "association-failed" - } - }, - "disassociating": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disassociating" - } - }, - "disassociated": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disassociated" - } - } - } - }, - "com.amazonaws.ec2#AthenaIntegration": { - "type": "structure", - "members": { - "IntegrationResultS3DestinationArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The location in Amazon S3 to store the generated CloudFormation template.

", - "smithy.api#required": {} - } - }, - "PartitionLoadFrequency": { - "target": "com.amazonaws.ec2#PartitionLoadFrequency", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The schedule for adding new partitions to the table.

", - "smithy.api#required": {} - } - }, - "PartitionStartDate": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "smithy.api#documentation": "

The start date for the partition.

" - } - }, - "PartitionEndDate": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "smithy.api#documentation": "

The end date for the partition.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes integration options for Amazon Athena.

" - } - }, - "com.amazonaws.ec2#AthenaIntegrationsSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#AthenaIntegration", - "traits": { - "smithy.api#xmlName": "item" - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.ec2#AttachClassicLinkVpc": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#AttachClassicLinkVpcRequest" - }, - "output": { - "target": "com.amazonaws.ec2#AttachClassicLinkVpcResult" - }, - "traits": { - "smithy.api#documentation": "\n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n \n

Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's\n\t\t\tsecurity groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You\n\t\t\tcan only link an instance that's in the running state. An instance is\n\t\t\tautomatically unlinked from a VPC when it's stopped - you can link it to the VPC again when\n\t\t\tyou restart it.

\n

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.

\n

Linking your instance to a VPC is sometimes referred to as attaching your instance.

" - } - }, - "com.amazonaws.ec2#AttachClassicLinkVpcRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "Groups": { - "target": "com.amazonaws.ec2#GroupIdStringList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "SecurityGroupId" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "instanceId" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of a ClassicLink-enabled VPC.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "vpcId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#AttachClassicLinkVpcResult": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#AttachInternetGateway": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#AttachInternetGatewayRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and\n\t\t\tthe VPC. For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#AttachInternetGatewayRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "InternetGatewayId": { - "target": "com.amazonaws.ec2#InternetGatewayId", - "traits": { - "aws.protocols#ec2QueryName": "InternetGatewayId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the internet gateway.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "internetGatewayId" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "vpcId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#AttachNetworkInterface": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#AttachNetworkInterfaceRequest" - }, - "output": { - "target": "com.amazonaws.ec2#AttachNetworkInterfaceResult" - }, - "traits": { - "smithy.api#documentation": "

Attaches a network interface to an instance.

" - } - }, - "com.amazonaws.ec2#AttachNetworkInterfaceRequest": { - "type": "structure", - "members": { - "DeviceIndex": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "DeviceIndex", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The index of the device for the network interface attachment.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "deviceIndex" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "instanceId" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#NetworkInterfaceId", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the network interface.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "networkInterfaceId" - } - }, - "NetworkCardIndex": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The index of the network card. Some instance types support multiple network cards. \n The primary network interface must be assigned to network card index 0. \n The default is network card index 0.

" - } - }, - "EnaSrdSpecification": { - "target": "com.amazonaws.ec2#EnaSrdSpecification", - "traits": { - "smithy.api#documentation": "

Configures ENA Express for the network interface that this action attaches to the instance.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for AttachNetworkInterface.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#AttachNetworkInterfaceResult": { - "type": "structure", - "members": { - "AttachmentId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AttachmentId", - "smithy.api#documentation": "

The ID of the network interface attachment.

", - "smithy.api#xmlName": "attachmentId" - } - }, - "NetworkCardIndex": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "NetworkCardIndex", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The index of the network card.

", - "smithy.api#xmlName": "networkCardIndex" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of AttachNetworkInterface.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#AttachVerifiedAccessTrustProvider": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#AttachVerifiedAccessTrustProviderRequest" - }, - "output": { - "target": "com.amazonaws.ec2#AttachVerifiedAccessTrustProviderResult" - }, - "traits": { - "smithy.api#documentation": "

Attaches the specified Amazon Web Services Verified Access trust provider to the specified Amazon Web Services Verified Access instance.

" - } - }, - "com.amazonaws.ec2#AttachVerifiedAccessTrustProviderRequest": { - "type": "structure", - "members": { - "VerifiedAccessInstanceId": { - "target": "com.amazonaws.ec2#VerifiedAccessInstanceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Verified Access instance.

", - "smithy.api#required": {} - } - }, - "VerifiedAccessTrustProviderId": { - "target": "com.amazonaws.ec2#VerifiedAccessTrustProviderId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Verified Access trust provider.

", - "smithy.api#required": {} - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.

", - "smithy.api#idempotencyToken": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#AttachVerifiedAccessTrustProviderResult": { - "type": "structure", - "members": { - "VerifiedAccessTrustProvider": { - "target": "com.amazonaws.ec2#VerifiedAccessTrustProvider", - "traits": { - "aws.protocols#ec2QueryName": "VerifiedAccessTrustProvider", - "smithy.api#documentation": "

The ID of the Verified Access trust provider.

", - "smithy.api#xmlName": "verifiedAccessTrustProvider" - } - }, - "VerifiedAccessInstance": { - "target": "com.amazonaws.ec2#VerifiedAccessInstance", - "traits": { - "aws.protocols#ec2QueryName": "VerifiedAccessInstance", - "smithy.api#documentation": "

The ID of the Verified Access instance.

", - "smithy.api#xmlName": "verifiedAccessInstance" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#AttachVolume": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#AttachVolumeRequest" - }, - "output": { - "target": "com.amazonaws.ec2#VolumeAttachment" - }, - "traits": { - "smithy.api#documentation": "

Attaches an EBS volume to a running or stopped instance and exposes it to the instance\n with the specified device name.

\n

Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. For\n more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.

\n

After you attach an EBS volume, you must make it available. For more information, see \n Make an EBS volume available for use.

\n

If a volume has an Amazon Web Services Marketplace product code:

\n \n

For more information, see Attach an Amazon EBS volume to an instance in the\n Amazon Elastic Compute Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#AttachVolumeRequest": { - "type": "structure", - "members": { - "Device": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The device name (for example, /dev/sdh or xvdh).

", - "smithy.api#required": {} - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#required": {} - } - }, - "VolumeId": { - "target": "com.amazonaws.ec2#VolumeId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the EBS volume. The volume and instance must be within the same Availability\n Zone.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#AttachVpnGateway": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#AttachVpnGatewayRequest" - }, - "output": { - "target": "com.amazonaws.ec2#AttachVpnGatewayResult" - }, - "traits": { - "smithy.api#documentation": "

Attaches a virtual private gateway to a VPC. You can attach one virtual private\n gateway to one VPC at a time.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

" - } - }, - "com.amazonaws.ec2#AttachVpnGatewayRequest": { - "type": "structure", - "members": { - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#required": {} - } - }, - "VpnGatewayId": { - "target": "com.amazonaws.ec2#VpnGatewayId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the virtual private gateway.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for AttachVpnGateway.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#AttachVpnGatewayResult": { - "type": "structure", - "members": { - "VpcAttachment": { - "target": "com.amazonaws.ec2#VpcAttachment", - "traits": { - "aws.protocols#ec2QueryName": "Attachment", - "smithy.api#documentation": "

Information about the attachment.

", - "smithy.api#xmlName": "attachment" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of AttachVpnGateway.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#AttachmentEnaSrdSpecification": { - "type": "structure", - "members": { - "EnaSrdEnabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "EnaSrdEnabled", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether ENA Express is enabled for the network interface that's attached to the\n\t\t\tinstance.

", - "smithy.api#xmlName": "enaSrdEnabled" - } - }, - "EnaSrdUdpSpecification": { - "target": "com.amazonaws.ec2#AttachmentEnaSrdUdpSpecification", - "traits": { - "aws.protocols#ec2QueryName": "EnaSrdUdpSpecification", - "smithy.api#documentation": "

ENA Express configuration for UDP network traffic.

", - "smithy.api#xmlName": "enaSrdUdpSpecification" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the ENA Express configuration for the network interface that's attached to the instance.

" - } - }, - "com.amazonaws.ec2#AttachmentEnaSrdUdpSpecification": { - "type": "structure", - "members": { - "EnaSrdUdpEnabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "EnaSrdUdpEnabled", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, \n\t\t\tyou must first enable ENA Express.

", - "smithy.api#xmlName": "enaSrdUdpEnabled" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the ENA Express configuration for UDP traffic on the network interface that's attached to \n\t\t\tthe instance.

" - } - }, - "com.amazonaws.ec2#AttachmentStatus": { - "type": "enum", - "members": { - "attaching": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "attaching" - } - }, - "attached": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "attached" - } - }, - "detaching": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "detaching" - } - }, - "detached": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "detached" - } - } - } - }, - "com.amazonaws.ec2#AttributeBooleanValue": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Value", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

The attribute value. The valid values are true or false.

", - "smithy.api#xmlName": "value" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a value for a resource attribute that is a Boolean value.

" - } - }, - "com.amazonaws.ec2#AttributeValue": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Value", - "smithy.api#documentation": "

The attribute value. The value is case-sensitive.

", - "smithy.api#xmlName": "value" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a value for a resource attribute that is a String.

" - } - }, - "com.amazonaws.ec2#AuthorizationRule": { - "type": "structure", - "members": { - "ClientVpnEndpointId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientVpnEndpointId", - "smithy.api#documentation": "

The ID of the Client VPN endpoint with which the authorization rule is associated.

", - "smithy.api#xmlName": "clientVpnEndpointId" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A brief description of the authorization rule.

", - "smithy.api#xmlName": "description" - } - }, - "GroupId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupId", - "smithy.api#documentation": "

The ID of the Active Directory group to which the authorization rule grants access.

", - "smithy.api#xmlName": "groupId" - } - }, - "AccessAll": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "AccessAll", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the authorization rule grants access to all clients.

", - "smithy.api#xmlName": "accessAll" - } - }, - "DestinationCidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DestinationCidr", - "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, of the network to which the authorization rule applies.

", - "smithy.api#xmlName": "destinationCidr" - } - }, - "Status": { - "target": "com.amazonaws.ec2#ClientVpnAuthorizationRuleStatus", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The current state of the authorization rule.

", - "smithy.api#xmlName": "status" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about an authorization rule.

" - } - }, - "com.amazonaws.ec2#AuthorizationRuleSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#AuthorizationRule", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#AuthorizeClientVpnIngress": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#AuthorizeClientVpnIngressRequest" - }, - "output": { - "target": "com.amazonaws.ec2#AuthorizeClientVpnIngressResult" - }, - "traits": { - "smithy.api#documentation": "

Adds an ingress authorization rule to a Client VPN endpoint. Ingress authorization rules act as \n\t\t\tfirewall rules that grant access to networks. You must configure ingress authorization rules to \n\t\t\tenable clients to access resources in Amazon Web Services or on-premises networks.

" - } - }, - "com.amazonaws.ec2#AuthorizeClientVpnIngressRequest": { - "type": "structure", - "members": { - "ClientVpnEndpointId": { - "target": "com.amazonaws.ec2#ClientVpnEndpointId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", - "smithy.api#required": {} - } - }, - "TargetNetworkCidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, of the network for which access is being authorized.

", - "smithy.api#required": {} - } - }, - "AccessGroupId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group. Required if AuthorizeAllGroups is false or not specified.

" - } - }, - "AuthorizeAllGroups": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to grant access to all clients. Specify true to grant all\n clients who successfully establish a VPN connection access to the network. Must be set\n to true if AccessGroupId is not specified.

" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A brief description of the authorization rule.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

", - "smithy.api#idempotencyToken": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#AuthorizeClientVpnIngressResult": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.ec2#ClientVpnAuthorizationRuleStatus", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The current state of the authorization rule.

", - "smithy.api#xmlName": "status" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#AuthorizeSecurityGroupEgress": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#AuthorizeSecurityGroupEgressRequest" - }, - "output": { - "target": "com.amazonaws.ec2#AuthorizeSecurityGroupEgressResult" - }, - "traits": { - "smithy.api#documentation": "

[VPC only] Adds the specified outbound (egress) rules to a security group for use with a VPC.

\n

An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR\n address ranges, or to the instances that are associated with the specified source\n security groups. When specifying an outbound rule for your security group in a VPC, the\n IpPermissions must include a destination for the traffic.

\n

You specify a protocol for each rule (for example, TCP). \n For the TCP and UDP protocols, you must also specify the destination port or port range. \n For the ICMP protocol, you must also specify the ICMP type and code. \n You can use -1 for the type or code to mean all types or all codes.

\n

Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.

\n

For information about VPC security group quotas, see Amazon VPC quotas.

" - } - }, - "com.amazonaws.ec2#AuthorizeSecurityGroupEgressRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "GroupId": { - "target": "com.amazonaws.ec2#SecurityGroupId", - "traits": { - "aws.protocols#ec2QueryName": "GroupId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the security group.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "groupId" - } - }, - "IpPermissions": { - "target": "com.amazonaws.ec2#IpPermissionList", - "traits": { - "aws.protocols#ec2QueryName": "IpPermissions", - "smithy.api#documentation": "

The sets of IP permissions. You can't specify a destination security group and a CIDR IP\n address range in the same set of permissions.

", - "smithy.api#xmlName": "ipPermissions" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags applied to the security group rule.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "CidrIp": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CidrIp", - "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify the CIDR.

", - "smithy.api#xmlName": "cidrIp" - } - }, - "FromPort": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "FromPort", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify the port.

", - "smithy.api#xmlName": "fromPort" - } - }, - "IpProtocol": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "IpProtocol", - "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify the protocol name or\n number.

", - "smithy.api#xmlName": "ipProtocol" - } - }, - "ToPort": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "ToPort", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify the port.

", - "smithy.api#xmlName": "toPort" - } - }, - "SourceSecurityGroupName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SourceSecurityGroupName", - "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify a\n destination security group.

", - "smithy.api#xmlName": "sourceSecurityGroupName" - } - }, - "SourceSecurityGroupOwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SourceSecurityGroupOwnerId", - "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify a\n destination security group.

", - "smithy.api#xmlName": "sourceSecurityGroupOwnerId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#AuthorizeSecurityGroupEgressResult": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, returns an error.

", - "smithy.api#xmlName": "return" - } - }, - "SecurityGroupRules": { - "target": "com.amazonaws.ec2#SecurityGroupRuleList", - "traits": { - "aws.protocols#ec2QueryName": "SecurityGroupRuleSet", - "smithy.api#documentation": "

Information about the outbound (egress) security group rules that were added.

", - "smithy.api#xmlName": "securityGroupRuleSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#AuthorizeSecurityGroupIngress": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#AuthorizeSecurityGroupIngressRequest" - }, - "output": { - "target": "com.amazonaws.ec2#AuthorizeSecurityGroupIngressResult" - }, - "traits": { - "smithy.api#documentation": "

Adds the specified inbound (ingress) rules to a security group.

\n

An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR\n address range, or from the instances that are associated with the specified destination security \n groups. When specifying an inbound rule for your security group in a VPC, the\n IpPermissions must include a source for the traffic.

\n

You specify a protocol for each rule (for example, TCP). \n For TCP and UDP, you must also specify the destination port or port range. \n For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. \n You can use -1 to mean all types or all codes.

\n

Rule changes are propagated to instances within the security group as quickly as possible. \n However, a small delay might occur.

\n

For more information about VPC security group quotas, see Amazon VPC quotas.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " - } - }, - "com.amazonaws.ec2#AuthorizeSecurityGroupIngressRequest": { - "type": "structure", - "members": { - "CidrIp": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The IPv4 address range, in CIDR format. You can't specify this parameter when specifying a source\n security group. To specify an IPv6 address range, use a set of IP permissions.

\n

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

" - } - }, - "FromPort": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

If the protocol is TCP or UDP, this is the start of the port range.\n If the protocol is ICMP, this is the type number. A value of -1 indicates all ICMP types. \n If you specify all ICMP types, you must specify all ICMP codes.

\n

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

" - } - }, - "GroupId": { - "target": "com.amazonaws.ec2#SecurityGroupId", - "traits": { - "smithy.api#documentation": "

The ID of the security group. You must specify either the security group ID or the\n\t\t\tsecurity group name in the request. For security groups in a nondefault VPC, you must\n\t\t\tspecify the security group ID.

" - } - }, - "GroupName": { - "target": "com.amazonaws.ec2#SecurityGroupName", - "traits": { - "smithy.api#documentation": "

[EC2-Classic, default VPC] The name of the security group. You must specify either the\n security group ID or the security group name in the request. For security groups in a\n nondefault VPC, you must specify the security group ID.

" - } - }, - "IpPermissions": { - "target": "com.amazonaws.ec2#IpPermissionList", - "traits": { - "smithy.api#documentation": "

The sets of IP permissions.

" - } - }, - "IpProtocol": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The IP protocol name (tcp, udp, icmp) or number\n (see Protocol Numbers). To specify icmpv6, use a set of IP permissions.

\n

[VPC only] Use -1 to specify all protocols. If you specify -1 or a \n protocol other than tcp, udp, or icmp, traffic on all ports \n is allowed, regardless of any ports you specify.

\n

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

" - } - }, - "SourceSecurityGroupName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter \n in combination with the following parameters: the CIDR IP address range, the start of the port range, \n the IP protocol, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. \n To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. For \n EC2-VPC, the source security group must be in the same VPC.

" - } - }, - "SourceSecurityGroupOwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

[nondefault VPC] The Amazon Web Services account ID for the source security group, if the source security group is \n in a different account. You can't specify this parameter in combination with the following parameters: \n the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. \n Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol \n and port range, use a set of IP permissions instead.

" - } - }, - "ToPort": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

If the protocol is TCP or UDP, this is the end of the port range.\n If the protocol is ICMP, this is the code. A value of -1 indicates all ICMP codes. \n If you specify all ICMP types, you must specify all ICMP codes.

\n

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

[VPC Only] The tags applied to the security group rule.

", - "smithy.api#xmlName": "TagSpecification" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#AuthorizeSecurityGroupIngressResult": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, returns an error.

", - "smithy.api#xmlName": "return" - } - }, - "SecurityGroupRules": { - "target": "com.amazonaws.ec2#SecurityGroupRuleList", - "traits": { - "aws.protocols#ec2QueryName": "SecurityGroupRuleSet", - "smithy.api#documentation": "

Information about the inbound (ingress) security group rules that were added.

", - "smithy.api#xmlName": "securityGroupRuleSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#AutoAcceptSharedAssociationsValue": { - "type": "enum", - "members": { - "enable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enable" - } - }, - "disable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disable" - } - } - } - }, - "com.amazonaws.ec2#AutoAcceptSharedAttachmentsValue": { - "type": "enum", - "members": { - "enable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enable" - } - }, - "disable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disable" - } - } - } - }, - "com.amazonaws.ec2#AutoPlacement": { - "type": "enum", - "members": { - "on": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "on" - } - }, - "off": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "off" - } - } - } - }, - "com.amazonaws.ec2#AutoRecoveryFlag": { - "type": "boolean" - }, - "com.amazonaws.ec2#AvailabilityZone": { - "type": "structure", - "members": { - "State": { - "target": "com.amazonaws.ec2#AvailabilityZoneState", - "traits": { - "aws.protocols#ec2QueryName": "ZoneState", - "smithy.api#documentation": "

The state of the Availability Zone, Local Zone, or Wavelength Zone. This value is always\n available.

", - "smithy.api#xmlName": "zoneState" - } - }, - "OptInStatus": { - "target": "com.amazonaws.ec2#AvailabilityZoneOptInStatus", - "traits": { - "aws.protocols#ec2QueryName": "OptInStatus", - "smithy.api#documentation": "

For Availability Zones, this parameter always has the value of\n opt-in-not-required.

\n

For Local Zones and Wavelength Zones, this parameter is the opt-in status. The possible\n values are opted-in, and not-opted-in.

", - "smithy.api#xmlName": "optInStatus" - } - }, - "Messages": { - "target": "com.amazonaws.ec2#AvailabilityZoneMessageList", - "traits": { - "aws.protocols#ec2QueryName": "MessageSet", - "smithy.api#documentation": "

Any messages about the Availability Zone, Local Zone, or Wavelength Zone.

", - "smithy.api#xmlName": "messageSet" - } - }, - "RegionName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "RegionName", - "smithy.api#documentation": "

The name of the Region.

", - "smithy.api#xmlName": "regionName" - } - }, - "ZoneName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ZoneName", - "smithy.api#documentation": "

The name of the Availability Zone, Local Zone, or Wavelength Zone.

", - "smithy.api#xmlName": "zoneName" - } - }, - "ZoneId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ZoneId", - "smithy.api#documentation": "

The ID of the Availability Zone, Local Zone, or Wavelength Zone.

", - "smithy.api#xmlName": "zoneId" - } - }, - "GroupName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupName", - "smithy.api#documentation": "

For Availability Zones, this parameter has the same value as the Region name.

\n

For Local Zones, the name of the associated group, for example\n us-west-2-lax-1.

\n

For Wavelength Zones, the name of the associated group, for example\n us-east-1-wl1-bos-wlz-1.

", - "smithy.api#xmlName": "groupName" - } - }, - "NetworkBorderGroup": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NetworkBorderGroup", - "smithy.api#documentation": "

The name of the network border group.

", - "smithy.api#xmlName": "networkBorderGroup" - } - }, - "ZoneType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ZoneType", - "smithy.api#documentation": "

The type of zone. The valid values are availability-zone,\n local-zone, and wavelength-zone.

", - "smithy.api#xmlName": "zoneType" - } - }, - "ParentZoneName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ParentZoneName", - "smithy.api#documentation": "

The name of the zone that handles some of the Local Zone or Wavelength Zone control plane\n operations, such as API calls.

", - "smithy.api#xmlName": "parentZoneName" - } - }, - "ParentZoneId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ParentZoneId", - "smithy.api#documentation": "

The ID of the zone that handles some of the Local Zone or Wavelength Zone control plane\n operations, such as API calls.

", - "smithy.api#xmlName": "parentZoneId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes Availability Zones, Local Zones, and Wavelength Zones.

" - } - }, - "com.amazonaws.ec2#AvailabilityZoneList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#AvailabilityZone", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#AvailabilityZoneMessage": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "

The message about the Availability Zone, Local Zone, or Wavelength Zone.

", - "smithy.api#xmlName": "message" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a message about an Availability Zone, Local Zone, or Wavelength Zone.

" - } - }, - "com.amazonaws.ec2#AvailabilityZoneMessageList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#AvailabilityZoneMessage", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#AvailabilityZoneName": { - "type": "string" - }, - "com.amazonaws.ec2#AvailabilityZoneOptInStatus": { - "type": "enum", - "members": { - "opt_in_not_required": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "opt-in-not-required" - } - }, - "opted_in": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "opted-in" - } - }, - "not_opted_in": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "not-opted-in" - } - } - } - }, - "com.amazonaws.ec2#AvailabilityZoneState": { - "type": "enum", - "members": { - "available": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "available" - } - }, - "information": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "information" - } - }, - "impaired": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "impaired" - } - }, - "unavailable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unavailable" - } - } - } - }, - "com.amazonaws.ec2#AvailabilityZoneStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#xmlName": "AvailabilityZone" - } - } - }, - "com.amazonaws.ec2#AvailableCapacity": { - "type": "structure", - "members": { - "AvailableInstanceCapacity": { - "target": "com.amazonaws.ec2#AvailableInstanceCapacityList", - "traits": { - "aws.protocols#ec2QueryName": "AvailableInstanceCapacity", - "smithy.api#documentation": "

The number of instances that can be launched onto the Dedicated Host depending on the\n host's available capacity. For Dedicated Hosts that support multiple instance types,\n this parameter represents the number of instances for each instance size that is\n supported on the host.

", - "smithy.api#xmlName": "availableInstanceCapacity" - } - }, - "AvailableVCpus": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "AvailableVCpus", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of vCPUs available for launching instances onto the Dedicated Host.

", - "smithy.api#xmlName": "availableVCpus" - } - } - }, - "traits": { - "smithy.api#documentation": "

The capacity information for instances that can be launched onto the Dedicated Host.\n

" - } - }, - "com.amazonaws.ec2#AvailableInstanceCapacityList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#InstanceCapacity", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#BareMetal": { - "type": "enum", - "members": { - "INCLUDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "included" - } - }, - "REQUIRED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "required" - } - }, - "EXCLUDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "excluded" - } - } - } - }, - "com.amazonaws.ec2#BareMetalFlag": { - "type": "boolean" - }, - "com.amazonaws.ec2#BaselineBandwidthInMbps": { - "type": "integer" - }, - "com.amazonaws.ec2#BaselineEbsBandwidthMbps": { - "type": "structure", - "members": { - "Min": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Min", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum baseline bandwidth, in Mbps. If this parameter is not specified, there is no\n minimum limit.

", - "smithy.api#xmlName": "min" - } - }, - "Max": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Max", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum baseline bandwidth, in Mbps. If this parameter is not specified, there is no\n maximum limit.

", - "smithy.api#xmlName": "max" - } - } - }, - "traits": { - "smithy.api#documentation": "

The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see\n Amazon\n EBS–optimized instances in the Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#BaselineEbsBandwidthMbpsRequest": { - "type": "structure", - "members": { - "Min": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit\n this parameter.

" - } - }, - "Max": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit\n this parameter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see\n Amazon\n EBS–optimized instances in the Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#BaselineIops": { - "type": "integer" - }, - "com.amazonaws.ec2#BaselineThroughputInMBps": { - "type": "double" - }, - "com.amazonaws.ec2#BatchState": { - "type": "enum", - "members": { - "SUBMITTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "submitted" - } - }, - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "active" - } - }, - "CANCELLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cancelled" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failed" - } - }, - "CANCELLED_RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cancelled_running" - } - }, - "CANCELLED_TERMINATING_INSTANCES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cancelled_terminating" - } - }, - "MODIFYING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "modifying" - } - } - } - }, - "com.amazonaws.ec2#BgpStatus": { - "type": "enum", - "members": { - "up": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "up" - } - }, - "down": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "down" - } - } - } - }, - "com.amazonaws.ec2#BillingProductList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#Blob": { - "type": "blob" - }, - "com.amazonaws.ec2#BlobAttributeValue": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.ec2#Blob", - "traits": { - "aws.protocols#ec2QueryName": "Value", - "smithy.api#xmlName": "value" - } - } - } - }, - "com.amazonaws.ec2#BlockDeviceMapping": { - "type": "structure", - "members": { - "DeviceName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DeviceName", - "smithy.api#documentation": "

The device name (for example, /dev/sdh or xvdh).

", - "smithy.api#xmlName": "deviceName" - } - }, - "VirtualName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VirtualName", - "smithy.api#documentation": "

The virtual device name (ephemeralN). Instance store volumes are numbered\n starting from 0. An instance type with 2 available instance store volumes can specify\n mappings for ephemeral0 and ephemeral1. The number of\n available instance store volumes depends on the instance type. After you connect to the\n instance, you must mount the volume.

\n

NVMe instance store volumes are automatically enumerated and assigned a device name.\n Including them in your block device mapping has no effect.

\n

Constraints: For M3 instances, you must specify instance store volumes in the block\n device mapping for the instance. When you launch an M3 instance, we ignore any instance\n store volumes specified in the block device mapping for the AMI.

", - "smithy.api#xmlName": "virtualName" - } - }, - "Ebs": { - "target": "com.amazonaws.ec2#EbsBlockDevice", - "traits": { - "aws.protocols#ec2QueryName": "Ebs", - "smithy.api#documentation": "

Parameters used to automatically set up EBS volumes when the instance is\n launched.

", - "smithy.api#xmlName": "ebs" - } - }, - "NoDevice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NoDevice", - "smithy.api#documentation": "

To omit the device from the block device mapping, specify an empty string. When this\n property is specified, the device is removed from the block device mapping regardless of\n the assigned value.

", - "smithy.api#xmlName": "noDevice" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a block device mapping, which defines the EBS volumes and instance store\n volumes to attach to an instance at launch.

" - } - }, - "com.amazonaws.ec2#BlockDeviceMappingList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#BlockDeviceMapping", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#BlockDeviceMappingRequestList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#BlockDeviceMapping", - "traits": { - "smithy.api#xmlName": "BlockDeviceMapping" - } - } - }, - "com.amazonaws.ec2#Boolean": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.ec2#BootModeType": { - "type": "enum", - "members": { - "legacy_bios": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "legacy-bios" - } - }, - "uefi": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "uefi" - } - } - } - }, - "com.amazonaws.ec2#BootModeTypeList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#BootModeType", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#BootModeValues": { - "type": "enum", - "members": { - "legacy_bios": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "legacy-bios" - } - }, - "uefi": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "uefi" - } - }, - "uefi_preferred": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "uefi-preferred" - } - } - } - }, - "com.amazonaws.ec2#BoxedDouble": { - "type": "double" - }, - "com.amazonaws.ec2#BundleId": { - "type": "string" - }, - "com.amazonaws.ec2#BundleIdStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#BundleId", - "traits": { - "smithy.api#xmlName": "BundleId" - } - } - }, - "com.amazonaws.ec2#BundleInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#BundleInstanceRequest" - }, - "output": { - "target": "com.amazonaws.ec2#BundleInstanceResult" - }, - "traits": { - "smithy.api#documentation": "

Bundles an Amazon instance store-backed Windows instance.

\n

During bundling, only the root device volume (C:\\) is bundled. Data on other instance store volumes is not preserved.

\n \n

This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.

\n " - } - }, - "com.amazonaws.ec2#BundleInstanceRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the instance to bundle.

\n

Type: String

\n

Default: None

\n

Required: Yes

", - "smithy.api#required": {} - } - }, - "Storage": { - "target": "com.amazonaws.ec2#Storage", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#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.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for BundleInstance.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#BundleInstanceResult": { - "type": "structure", - "members": { - "BundleTask": { - "target": "com.amazonaws.ec2#BundleTask", - "traits": { - "aws.protocols#ec2QueryName": "BundleInstanceTask", - "smithy.api#documentation": "

Information about the bundle task.

", - "smithy.api#xmlName": "bundleInstanceTask" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of BundleInstance.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#BundleTask": { - "type": "structure", - "members": { - "BundleId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "BundleId", - "smithy.api#documentation": "

The ID of the bundle task.

", - "smithy.api#xmlName": "bundleId" - } - }, - "BundleTaskError": { - "target": "com.amazonaws.ec2#BundleTaskError", - "traits": { - "aws.protocols#ec2QueryName": "Error", - "smithy.api#documentation": "

If the task fails, a description of the error.

", - "smithy.api#xmlName": "error" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance associated with this bundle task.

", - "smithy.api#xmlName": "instanceId" - } - }, - "Progress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Progress", - "smithy.api#documentation": "

The level of task completion, as a percent (for example, 20%).

", - "smithy.api#xmlName": "progress" - } - }, - "StartTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "StartTime", - "smithy.api#documentation": "

The time this task started.

", - "smithy.api#xmlName": "startTime" - } - }, - "State": { - "target": "com.amazonaws.ec2#BundleTaskState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the task.

", - "smithy.api#xmlName": "state" - } - }, - "Storage": { - "target": "com.amazonaws.ec2#Storage", - "traits": { - "aws.protocols#ec2QueryName": "Storage", - "smithy.api#documentation": "

The Amazon S3 storage locations.

", - "smithy.api#xmlName": "storage" - } - }, - "UpdateTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "UpdateTime", - "smithy.api#documentation": "

The time of the most recent update for the task.

", - "smithy.api#xmlName": "updateTime" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a bundle task.

" - } - }, - "com.amazonaws.ec2#BundleTaskError": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The error code.

", - "smithy.api#xmlName": "code" - } - }, - "Message": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "

The error message.

", - "smithy.api#xmlName": "message" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an error for BundleInstance.

" - } - }, - "com.amazonaws.ec2#BundleTaskList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#BundleTask", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#BundleTaskState": { - "type": "enum", - "members": { - "pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "waiting_for_shutdown": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "waiting-for-shutdown" - } - }, - "bundling": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "bundling" - } - }, - "storing": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "storing" - } - }, - "cancelling": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cancelling" - } - }, - "complete": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "complete" - } - }, - "failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failed" - } - } - } - }, - "com.amazonaws.ec2#BurstablePerformance": { - "type": "enum", - "members": { - "INCLUDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "included" - } - }, - "REQUIRED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "required" - } - }, - "EXCLUDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "excluded" - } - } - } - }, - "com.amazonaws.ec2#BurstablePerformanceFlag": { - "type": "boolean" - }, - "com.amazonaws.ec2#ByoipCidr": { - "type": "structure", - "members": { - "Cidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Cidr", - "smithy.api#documentation": "

The address range, in CIDR notation.

", - "smithy.api#xmlName": "cidr" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

The description of the address range.

", - "smithy.api#xmlName": "description" - } - }, - "StatusMessage": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StatusMessage", - "smithy.api#documentation": "

Upon success, contains the ID of the address pool. Otherwise, contains an error message.

", - "smithy.api#xmlName": "statusMessage" - } - }, - "State": { - "target": "com.amazonaws.ec2#ByoipCidrState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the address pool.

", - "smithy.api#xmlName": "state" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about an address range that is provisioned for use with your Amazon Web Services resources \n through bring your own IP addresses (BYOIP).

" - } - }, - "com.amazonaws.ec2#ByoipCidrSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ByoipCidr", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ByoipCidrState": { - "type": "enum", - "members": { - "advertised": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "advertised" - } - }, - "deprovisioned": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deprovisioned" - } - }, - "failed_deprovision": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failed-deprovision" - } - }, - "failed_provision": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failed-provision" - } - }, - "pending_deprovision": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending-deprovision" - } - }, - "pending_provision": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending-provision" - } - }, - "provisioned": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "provisioned" - } - }, - "provisioned_not_publicly_advertisable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "provisioned-not-publicly-advertisable" - } - } - } - }, - "com.amazonaws.ec2#CancelBatchErrorCode": { - "type": "enum", - "members": { - "FLEET_REQUEST_ID_DOES_NOT_EXIST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "fleetRequestIdDoesNotExist" - } - }, - "FLEET_REQUEST_ID_MALFORMED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "fleetRequestIdMalformed" - } - }, - "FLEET_REQUEST_NOT_IN_CANCELLABLE_STATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "fleetRequestNotInCancellableState" - } - }, - "UNEXPECTED_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unexpectedError" - } - } - } - }, - "com.amazonaws.ec2#CancelBundleTask": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CancelBundleTaskRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CancelBundleTaskResult" - }, - "traits": { - "smithy.api#documentation": "

Cancels a bundling operation for an instance store-backed Windows instance.

" - } - }, - "com.amazonaws.ec2#CancelBundleTaskRequest": { - "type": "structure", - "members": { - "BundleId": { - "target": "com.amazonaws.ec2#BundleId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the bundle task.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for CancelBundleTask.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CancelBundleTaskResult": { - "type": "structure", - "members": { - "BundleTask": { - "target": "com.amazonaws.ec2#BundleTask", - "traits": { - "aws.protocols#ec2QueryName": "BundleInstanceTask", - "smithy.api#documentation": "

Information about the bundle task.

", - "smithy.api#xmlName": "bundleInstanceTask" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of CancelBundleTask.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CancelCapacityReservation": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CancelCapacityReservationRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CancelCapacityReservationResult" - }, - "traits": { - "smithy.api#documentation": "

Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation's state to\n\t\t\tcancelled.

\n

Instances running in the reserved capacity continue running until you stop them. Stopped\n\t\t\tinstances that target the Capacity Reservation can no longer launch. Modify these instances to either\n\t\t\ttarget a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation\n\t\t\tthat has matching attributes and sufficient capacity.

" - } - }, - "com.amazonaws.ec2#CancelCapacityReservationFleetError": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.ec2#CancelCapacityReservationFleetErrorCode", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The error code.

", - "smithy.api#xmlName": "code" - } - }, - "Message": { - "target": "com.amazonaws.ec2#CancelCapacityReservationFleetErrorMessage", - "traits": { - "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "

The error message.

", - "smithy.api#xmlName": "message" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a Capacity Reservation Fleet cancellation error.

" - } - }, - "com.amazonaws.ec2#CancelCapacityReservationFleetErrorCode": { - "type": "string" - }, - "com.amazonaws.ec2#CancelCapacityReservationFleetErrorMessage": { - "type": "string" - }, - "com.amazonaws.ec2#CancelCapacityReservationFleets": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CancelCapacityReservationFleetsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CancelCapacityReservationFleetsResult" - }, - "traits": { - "smithy.api#documentation": "

Cancels one or more Capacity Reservation Fleets. When you cancel a Capacity Reservation \n\t\t\tFleet, the following happens:

\n " - } - }, - "com.amazonaws.ec2#CancelCapacityReservationFleetsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - }, - "CapacityReservationFleetIds": { - "target": "com.amazonaws.ec2#CapacityReservationFleetIdSet", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IDs of the Capacity Reservation Fleets to cancel.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "CapacityReservationFleetId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CancelCapacityReservationFleetsResult": { - "type": "structure", - "members": { - "SuccessfulFleetCancellations": { - "target": "com.amazonaws.ec2#CapacityReservationFleetCancellationStateSet", - "traits": { - "aws.protocols#ec2QueryName": "SuccessfulFleetCancellationSet", - "smithy.api#documentation": "

Information about the Capacity Reservation Fleets that were successfully cancelled.

", - "smithy.api#xmlName": "successfulFleetCancellationSet" - } - }, - "FailedFleetCancellations": { - "target": "com.amazonaws.ec2#FailedCapacityReservationFleetCancellationResultSet", - "traits": { - "aws.protocols#ec2QueryName": "FailedFleetCancellationSet", - "smithy.api#documentation": "

Information about the Capacity Reservation Fleets that could not be cancelled.

", - "smithy.api#xmlName": "failedFleetCancellationSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CancelCapacityReservationRequest": { - "type": "structure", - "members": { - "CapacityReservationId": { - "target": "com.amazonaws.ec2#CapacityReservationId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Capacity Reservation to be cancelled.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CancelCapacityReservationResult": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CancelConversionRequest": { - "type": "structure", - "members": { - "ConversionTaskId": { - "target": "com.amazonaws.ec2#ConversionTaskId", - "traits": { - "aws.protocols#ec2QueryName": "ConversionTaskId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the conversion task.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "conversionTaskId" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "ReasonMessage": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ReasonMessage", - "smithy.api#documentation": "

The reason for canceling the conversion task.

", - "smithy.api#xmlName": "reasonMessage" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CancelConversionTask": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CancelConversionRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all\n artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is\n in the process of transferring the final disk image, the command fails and returns an exception.

\n

For more information, see Importing a Virtual Machine Using the Amazon\n EC2 CLI.

" - } - }, - "com.amazonaws.ec2#CancelExportTask": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CancelExportTaskRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Cancels an active export task. The request removes all artifacts of the export, including any partially-created\n Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the\n command fails and returns an error.

" - } - }, - "com.amazonaws.ec2#CancelExportTaskRequest": { - "type": "structure", - "members": { - "ExportTaskId": { - "target": "com.amazonaws.ec2#ExportVmTaskId", - "traits": { - "aws.protocols#ec2QueryName": "ExportTaskId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the export task. This is the ID returned by CreateInstanceExportTask.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "exportTaskId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CancelImageLaunchPermission": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CancelImageLaunchPermissionRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CancelImageLaunchPermissionResult" - }, - "traits": { - "smithy.api#documentation": "

Removes your Amazon Web Services account from the launch permissions for the specified AMI. For more\n information, see \n Cancel having an AMI shared with your Amazon Web Services account in the \n Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#CancelImageLaunchPermissionRequest": { - "type": "structure", - "members": { - "ImageId": { - "target": "com.amazonaws.ec2#ImageId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the AMI that was shared with your Amazon Web Services account.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CancelImageLaunchPermissionResult": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CancelImportTask": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CancelImportTaskRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CancelImportTaskResult" - }, - "traits": { - "smithy.api#documentation": "

Cancels an in-process import virtual machine or import snapshot task.

" - } - }, - "com.amazonaws.ec2#CancelImportTaskRequest": { - "type": "structure", - "members": { - "CancelReason": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The reason for canceling the task.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "ImportTaskId": { - "target": "com.amazonaws.ec2#ImportTaskId", - "traits": { - "smithy.api#documentation": "

The ID of the import image or import snapshot task to be canceled.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CancelImportTaskResult": { - "type": "structure", - "members": { - "ImportTaskId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ImportTaskId", - "smithy.api#documentation": "

The ID of the task being canceled.

", - "smithy.api#xmlName": "importTaskId" - } - }, - "PreviousState": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PreviousState", - "smithy.api#documentation": "

The current state of the task being canceled.

", - "smithy.api#xmlName": "previousState" - } - }, - "State": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The current state of the task being canceled.

", - "smithy.api#xmlName": "state" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CancelReservedInstancesListing": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CancelReservedInstancesListingRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CancelReservedInstancesListingResult" - }, - "traits": { - "smithy.api#documentation": "

Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.

\n

For more information, see \n Reserved Instance Marketplace \n in the Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#CancelReservedInstancesListingRequest": { - "type": "structure", - "members": { - "ReservedInstancesListingId": { - "target": "com.amazonaws.ec2#ReservedInstancesListingId", - "traits": { - "aws.protocols#ec2QueryName": "ReservedInstancesListingId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Reserved Instance listing.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "reservedInstancesListingId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for CancelReservedInstancesListing.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CancelReservedInstancesListingResult": { - "type": "structure", - "members": { - "ReservedInstancesListings": { - "target": "com.amazonaws.ec2#ReservedInstancesListingList", - "traits": { - "aws.protocols#ec2QueryName": "ReservedInstancesListingsSet", - "smithy.api#documentation": "

The Reserved Instance listing.

", - "smithy.api#xmlName": "reservedInstancesListingsSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of CancelReservedInstancesListing.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CancelSpotFleetRequests": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CancelSpotFleetRequestsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CancelSpotFleetRequestsResponse" - }, - "traits": { - "smithy.api#documentation": "

Cancels the specified Spot Fleet requests.

\n

After you cancel a Spot Fleet request, the Spot Fleet launches no new instances.

\n

You must also specify whether a canceled Spot Fleet request should terminate its instances. If you\n choose to terminate the instances, the Spot Fleet request enters the\n cancelled_terminating state. Otherwise, the Spot Fleet request enters\n the cancelled_running state and the instances continue to run until they\n are interrupted or you terminate them manually.

" - } - }, - "com.amazonaws.ec2#CancelSpotFleetRequestsError": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.ec2#CancelBatchErrorCode", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The error code.

", - "smithy.api#xmlName": "code" - } - }, - "Message": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "

The description for the error code.

", - "smithy.api#xmlName": "message" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a Spot Fleet error.

" - } - }, - "com.amazonaws.ec2#CancelSpotFleetRequestsErrorItem": { - "type": "structure", - "members": { - "Error": { - "target": "com.amazonaws.ec2#CancelSpotFleetRequestsError", - "traits": { - "aws.protocols#ec2QueryName": "Error", - "smithy.api#documentation": "

The error.

", - "smithy.api#xmlName": "error" - } - }, - "SpotFleetRequestId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SpotFleetRequestId", - "smithy.api#documentation": "

The ID of the Spot Fleet request.

", - "smithy.api#xmlName": "spotFleetRequestId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a Spot Fleet request that was not successfully canceled.

" - } - }, - "com.amazonaws.ec2#CancelSpotFleetRequestsErrorSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#CancelSpotFleetRequestsErrorItem", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#CancelSpotFleetRequestsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "SpotFleetRequestIds": { - "target": "com.amazonaws.ec2#SpotFleetRequestIdList", - "traits": { - "aws.protocols#ec2QueryName": "SpotFleetRequestId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IDs of the Spot Fleet requests.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "spotFleetRequestId" - } - }, - "TerminateInstances": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "TerminateInstances", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to terminate the associated instances when the Spot Fleet request is canceled. \n The default is to terminate the instances.

\n

To let the instances continue to run after the Spot Fleet request is canceled, specify\n no-terminate-instances.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "terminateInstances" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for CancelSpotFleetRequests.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CancelSpotFleetRequestsResponse": { - "type": "structure", - "members": { - "SuccessfulFleetRequests": { - "target": "com.amazonaws.ec2#CancelSpotFleetRequestsSuccessSet", - "traits": { - "aws.protocols#ec2QueryName": "SuccessfulFleetRequestSet", - "smithy.api#documentation": "

Information about the Spot Fleet requests that are successfully canceled.

", - "smithy.api#xmlName": "successfulFleetRequestSet" - } - }, - "UnsuccessfulFleetRequests": { - "target": "com.amazonaws.ec2#CancelSpotFleetRequestsErrorSet", - "traits": { - "aws.protocols#ec2QueryName": "UnsuccessfulFleetRequestSet", - "smithy.api#documentation": "

Information about the Spot Fleet requests that are not successfully canceled.

", - "smithy.api#xmlName": "unsuccessfulFleetRequestSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of CancelSpotFleetRequests.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CancelSpotFleetRequestsSuccessItem": { - "type": "structure", - "members": { - "CurrentSpotFleetRequestState": { - "target": "com.amazonaws.ec2#BatchState", - "traits": { - "aws.protocols#ec2QueryName": "CurrentSpotFleetRequestState", - "smithy.api#documentation": "

The current state of the Spot Fleet request.

", - "smithy.api#xmlName": "currentSpotFleetRequestState" - } - }, - "PreviousSpotFleetRequestState": { - "target": "com.amazonaws.ec2#BatchState", - "traits": { - "aws.protocols#ec2QueryName": "PreviousSpotFleetRequestState", - "smithy.api#documentation": "

The previous state of the Spot Fleet request.

", - "smithy.api#xmlName": "previousSpotFleetRequestState" - } - }, - "SpotFleetRequestId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SpotFleetRequestId", - "smithy.api#documentation": "

The ID of the Spot Fleet request.

", - "smithy.api#xmlName": "spotFleetRequestId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a Spot Fleet request that was successfully canceled.

" - } - }, - "com.amazonaws.ec2#CancelSpotFleetRequestsSuccessSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#CancelSpotFleetRequestsSuccessItem", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#CancelSpotInstanceRequestState": { - "type": "enum", - "members": { - "active": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "active" - } - }, - "open": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "open" - } - }, - "closed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "closed" - } - }, - "cancelled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cancelled" - } - }, - "completed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "completed" - } - } - } - }, - "com.amazonaws.ec2#CancelSpotInstanceRequests": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CancelSpotInstanceRequestsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CancelSpotInstanceRequestsResult" - }, - "traits": { - "smithy.api#documentation": "

Cancels one or more Spot Instance requests.

\n \n

Canceling a Spot Instance request does not terminate running Spot Instances\n associated with the request.

\n " - } - }, - "com.amazonaws.ec2#CancelSpotInstanceRequestsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "SpotInstanceRequestIds": { - "target": "com.amazonaws.ec2#SpotInstanceRequestIdList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IDs of the Spot Instance requests.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "SpotInstanceRequestId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for CancelSpotInstanceRequests.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CancelSpotInstanceRequestsResult": { - "type": "structure", - "members": { - "CancelledSpotInstanceRequests": { - "target": "com.amazonaws.ec2#CancelledSpotInstanceRequestList", - "traits": { - "aws.protocols#ec2QueryName": "SpotInstanceRequestSet", - "smithy.api#documentation": "

The Spot Instance requests.

", - "smithy.api#xmlName": "spotInstanceRequestSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of CancelSpotInstanceRequests.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CancelledSpotInstanceRequest": { - "type": "structure", - "members": { - "SpotInstanceRequestId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SpotInstanceRequestId", - "smithy.api#documentation": "

The ID of the Spot Instance request.

", - "smithy.api#xmlName": "spotInstanceRequestId" - } - }, - "State": { - "target": "com.amazonaws.ec2#CancelSpotInstanceRequestState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the Spot Instance request.

", - "smithy.api#xmlName": "state" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a request to cancel a Spot Instance.

" - } - }, - "com.amazonaws.ec2#CancelledSpotInstanceRequestList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#CancelledSpotInstanceRequest", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#CapacityAllocation": { - "type": "structure", - "members": { - "AllocationType": { - "target": "com.amazonaws.ec2#AllocationType", - "traits": { - "aws.protocols#ec2QueryName": "AllocationType", - "smithy.api#documentation": "

The usage type. used indicates that the instance capacity is \n\t\t\tin use by instances that are running in the Capacity Reservation.

", - "smithy.api#xmlName": "allocationType" - } - }, - "Count": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Count", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The amount of instance capacity associated with the usage. For example a value of \n\t\t\t4 indicates that instance capacity for 4 instances is currently in use.

", - "smithy.api#xmlName": "count" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about instance capacity usage for a Capacity Reservation.

" - } - }, - "com.amazonaws.ec2#CapacityAllocations": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#CapacityAllocation", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#CapacityReservation": { - "type": "structure", - "members": { - "CapacityReservationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CapacityReservationId", - "smithy.api#documentation": "

The ID of the Capacity Reservation.

", - "smithy.api#xmlName": "capacityReservationId" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the Capacity Reservation.

", - "smithy.api#xmlName": "ownerId" - } - }, - "CapacityReservationArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CapacityReservationArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Capacity Reservation.

", - "smithy.api#xmlName": "capacityReservationArn" - } - }, - "AvailabilityZoneId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZoneId", - "smithy.api#documentation": "

The Availability Zone ID of the Capacity Reservation.

", - "smithy.api#xmlName": "availabilityZoneId" - } - }, - "InstanceType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The type of instance for which the Capacity Reservation reserves capacity.

", - "smithy.api#xmlName": "instanceType" - } - }, - "InstancePlatform": { - "target": "com.amazonaws.ec2#CapacityReservationInstancePlatform", - "traits": { - "aws.protocols#ec2QueryName": "InstancePlatform", - "smithy.api#documentation": "

The type of operating system for which the Capacity Reservation reserves capacity.

", - "smithy.api#xmlName": "instancePlatform" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone in which the capacity is reserved.

", - "smithy.api#xmlName": "availabilityZone" - } - }, - "Tenancy": { - "target": "com.amazonaws.ec2#CapacityReservationTenancy", - "traits": { - "aws.protocols#ec2QueryName": "Tenancy", - "smithy.api#documentation": "

Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

\n ", - "smithy.api#xmlName": "tenancy" - } - }, - "TotalInstanceCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "TotalInstanceCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The total number of instances for which the Capacity Reservation reserves capacity.

", - "smithy.api#xmlName": "totalInstanceCount" - } - }, - "AvailableInstanceCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "AvailableInstanceCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.

", - "smithy.api#xmlName": "availableInstanceCount" - } - }, - "EbsOptimized": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "EbsOptimized", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides\n\t\t\tdedicated throughput to Amazon EBS and an optimized configuration stack to provide\n\t\t\toptimal I/O performance. This optimization isn't available with all instance types.\n\t\t\tAdditional usage charges apply when using an EBS- optimized instance.

", - "smithy.api#xmlName": "ebsOptimized" - } - }, - "EphemeralStorage": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "EphemeralStorage", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

\n Deprecated.\n

", - "smithy.api#xmlName": "ephemeralStorage" - } - }, - "State": { - "target": "com.amazonaws.ec2#CapacityReservationState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

\n ", - "smithy.api#xmlName": "state" - } - }, - "StartDate": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "StartDate", - "smithy.api#documentation": "

The date and time at which the Capacity Reservation was started.

", - "smithy.api#xmlName": "startDate" - } - }, - "EndDate": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "EndDate", - "smithy.api#documentation": "

The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity\n\t\t\tis released and you can no longer launch instances into it. The Capacity Reservation's state changes to\n\t\t\t\texpired when it reaches its end date and time.

", - "smithy.api#xmlName": "endDate" - } - }, - "EndDateType": { - "target": "com.amazonaws.ec2#EndDateType", - "traits": { - "aws.protocols#ec2QueryName": "EndDateType", - "smithy.api#documentation": "

Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end\n\t\t\ttypes:

\n ", - "smithy.api#xmlName": "endDateType" - } - }, - "InstanceMatchCriteria": { - "target": "com.amazonaws.ec2#InstanceMatchCriteria", - "traits": { - "aws.protocols#ec2QueryName": "InstanceMatchCriteria", - "smithy.api#documentation": "

Indicates the type of instance launches that the Capacity Reservation accepts. The options\n\t\t\tinclude:

\n ", - "smithy.api#xmlName": "instanceMatchCriteria" - } - }, - "CreateDate": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "CreateDate", - "smithy.api#documentation": "

The date and time at which the Capacity Reservation was created.

", - "smithy.api#xmlName": "createDate" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the Capacity Reservation.

", - "smithy.api#xmlName": "tagSet" - } - }, - "OutpostArn": { - "target": "com.amazonaws.ec2#OutpostArn", - "traits": { - "aws.protocols#ec2QueryName": "OutpostArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost on which the Capacity \n\t \t\tReservation was created.

", - "smithy.api#xmlName": "outpostArn" - } - }, - "CapacityReservationFleetId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CapacityReservationFleetId", - "smithy.api#documentation": "

The ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs. \n\t\t\tOnly valid for Capacity Reservations that were created by a Capacity Reservation Fleet.

", - "smithy.api#xmlName": "capacityReservationFleetId" - } - }, - "PlacementGroupArn": { - "target": "com.amazonaws.ec2#PlacementGroupArn", - "traits": { - "aws.protocols#ec2QueryName": "PlacementGroupArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster placement group in which \n\t\t\tthe Capacity Reservation was created. For more information, see \n\t\t\t\n\t\t\t\tCapacity Reservations for cluster placement groups in the \n\t\t\tAmazon EC2 User Guide.

", - "smithy.api#xmlName": "placementGroupArn" - } - }, - "CapacityAllocations": { - "target": "com.amazonaws.ec2#CapacityAllocations", - "traits": { - "aws.protocols#ec2QueryName": "CapacityAllocationSet", - "smithy.api#documentation": "

Information about instance capacity usage.

", - "smithy.api#xmlName": "capacityAllocationSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a Capacity Reservation.

" - } - }, - "com.amazonaws.ec2#CapacityReservationFleet": { - "type": "structure", - "members": { - "CapacityReservationFleetId": { - "target": "com.amazonaws.ec2#CapacityReservationFleetId", - "traits": { - "aws.protocols#ec2QueryName": "CapacityReservationFleetId", - "smithy.api#documentation": "

The ID of the Capacity Reservation Fleet.

", - "smithy.api#xmlName": "capacityReservationFleetId" - } - }, - "CapacityReservationFleetArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CapacityReservationFleetArn", - "smithy.api#documentation": "

The ARN of the Capacity Reservation Fleet.

", - "smithy.api#xmlName": "capacityReservationFleetArn" - } - }, - "State": { - "target": "com.amazonaws.ec2#CapacityReservationFleetState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the Capacity Reservation Fleet. Possible states include:

\n ", - "smithy.api#xmlName": "state" - } - }, - "TotalTargetCapacity": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "TotalTargetCapacity", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The total number of capacity units for which the Capacity Reservation Fleet reserves capacity. \n\t\t\tFor more information, see Total target capacity \n\t\t\tin the Amazon EC2 User Guide.

", - "smithy.api#xmlName": "totalTargetCapacity" - } - }, - "TotalFulfilledCapacity": { - "target": "com.amazonaws.ec2#Double", - "traits": { - "aws.protocols#ec2QueryName": "TotalFulfilledCapacity", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The capacity units that have been fulfilled.

", - "smithy.api#xmlName": "totalFulfilledCapacity" - } - }, - "Tenancy": { - "target": "com.amazonaws.ec2#FleetCapacityReservationTenancy", - "traits": { - "aws.protocols#ec2QueryName": "Tenancy", - "smithy.api#documentation": "

The tenancy of the Capacity Reservation Fleet. Tenancies include:

\n ", - "smithy.api#xmlName": "tenancy" - } - }, - "EndDate": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "EndDate", - "smithy.api#documentation": "

The date and time at which the Capacity Reservation Fleet expires.

", - "smithy.api#xmlName": "endDate" - } - }, - "CreateTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "CreateTime", - "smithy.api#documentation": "

The date and time at which the Capacity Reservation Fleet was created.

", - "smithy.api#xmlName": "createTime" - } - }, - "InstanceMatchCriteria": { - "target": "com.amazonaws.ec2#FleetInstanceMatchCriteria", - "traits": { - "aws.protocols#ec2QueryName": "InstanceMatchCriteria", - "smithy.api#documentation": "

Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All \n\t\t\tCapacity Reservations in the Fleet inherit this instance matching criteria.

\n

Currently, Capacity Reservation Fleets support open instance matching criteria \n\t\t\tonly. This means that instances that have matching attributes (instance type, platform, and \n\t\t\tAvailability Zone) run in the Capacity Reservations automatically. Instances do not need to \n\t\t\texplicitly target a Capacity Reservation Fleet to use its reserved capacity.

", - "smithy.api#xmlName": "instanceMatchCriteria" - } - }, - "AllocationStrategy": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AllocationStrategy", - "smithy.api#documentation": "

The strategy used by the Capacity Reservation Fleet to determine which of the specified \n\t\t\tinstance types to use. For more information, see For more information, see \n\t\t\t\n\t\t\t\tAllocation strategy in the Amazon EC2 User Guide.

", - "smithy.api#xmlName": "allocationStrategy" - } - }, - "InstanceTypeSpecifications": { - "target": "com.amazonaws.ec2#FleetCapacityReservationSet", - "traits": { - "aws.protocols#ec2QueryName": "InstanceTypeSpecificationSet", - "smithy.api#documentation": "

Information about the instance types for which to reserve the capacity.

", - "smithy.api#xmlName": "instanceTypeSpecificationSet" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags assigned to the Capacity Reservation Fleet.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a Capacity Reservation Fleet.

" - } - }, - "com.amazonaws.ec2#CapacityReservationFleetCancellationState": { - "type": "structure", - "members": { - "CurrentFleetState": { - "target": "com.amazonaws.ec2#CapacityReservationFleetState", - "traits": { - "aws.protocols#ec2QueryName": "CurrentFleetState", - "smithy.api#documentation": "

The current state of the Capacity Reservation Fleet.

", - "smithy.api#xmlName": "currentFleetState" - } - }, - "PreviousFleetState": { - "target": "com.amazonaws.ec2#CapacityReservationFleetState", - "traits": { - "aws.protocols#ec2QueryName": "PreviousFleetState", - "smithy.api#documentation": "

The previous state of the Capacity Reservation Fleet.

", - "smithy.api#xmlName": "previousFleetState" - } - }, - "CapacityReservationFleetId": { - "target": "com.amazonaws.ec2#CapacityReservationFleetId", - "traits": { - "aws.protocols#ec2QueryName": "CapacityReservationFleetId", - "smithy.api#documentation": "

The ID of the Capacity Reservation Fleet that was successfully cancelled.

", - "smithy.api#xmlName": "capacityReservationFleetId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a Capacity Reservation Fleet that was successfully cancelled.

" - } - }, - "com.amazonaws.ec2#CapacityReservationFleetCancellationStateSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#CapacityReservationFleetCancellationState", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#CapacityReservationFleetId": { - "type": "string" - }, - "com.amazonaws.ec2#CapacityReservationFleetIdSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#CapacityReservationFleetId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#CapacityReservationFleetSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#CapacityReservationFleet", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#CapacityReservationFleetState": { - "type": "enum", - "members": { - "SUBMITTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "submitted" - } - }, - "MODIFYING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "modifying" - } - }, - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "active" - } - }, - "PARTIALLY_FULFILLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "partially_fulfilled" - } - }, - "EXPIRING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "expiring" - } - }, - "EXPIRED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "expired" - } - }, - "CANCELLING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cancelling" - } - }, - "CANCELLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cancelled" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failed" - } - } - } - }, - "com.amazonaws.ec2#CapacityReservationGroup": { - "type": "structure", - "members": { - "GroupArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupArn", - "smithy.api#documentation": "

The ARN of the resource group.

", - "smithy.api#xmlName": "groupArn" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the resource group.

", - "smithy.api#xmlName": "ownerId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a resource group to which a Capacity Reservation has been added.

" - } - }, - "com.amazonaws.ec2#CapacityReservationGroupSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#CapacityReservationGroup", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#CapacityReservationId": { - "type": "string" - }, - "com.amazonaws.ec2#CapacityReservationIdSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#CapacityReservationId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#CapacityReservationInstancePlatform": { - "type": "enum", - "members": { - "LINUX_UNIX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Linux/UNIX" - } - }, - "RED_HAT_ENTERPRISE_LINUX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Red Hat Enterprise Linux" - } - }, - "SUSE_LINUX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUSE Linux" - } - }, - "WINDOWS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Windows" - } - }, - "WINDOWS_WITH_SQL_SERVER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Windows with SQL Server" - } - }, - "WINDOWS_WITH_SQL_SERVER_ENTERPRISE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Windows with SQL Server Enterprise" - } - }, - "WINDOWS_WITH_SQL_SERVER_STANDARD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Windows with SQL Server Standard" - } - }, - "WINDOWS_WITH_SQL_SERVER_WEB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Windows with SQL Server Web" - } - }, - "LINUX_WITH_SQL_SERVER_STANDARD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Linux with SQL Server Standard" - } - }, - "LINUX_WITH_SQL_SERVER_WEB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Linux with SQL Server Web" - } - }, - "LINUX_WITH_SQL_SERVER_ENTERPRISE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Linux with SQL Server Enterprise" - } - }, - "RHEL_WITH_SQL_SERVER_STANDARD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RHEL with SQL Server Standard" - } - }, - "RHEL_WITH_SQL_SERVER_ENTERPRISE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RHEL with SQL Server Enterprise" - } - }, - "RHEL_WITH_SQL_SERVER_WEB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RHEL with SQL Server Web" - } - }, - "RHEL_WITH_HA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RHEL with HA" - } - }, - "RHEL_WITH_HA_AND_SQL_SERVER_STANDARD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RHEL with HA and SQL Server Standard" - } - }, - "RHEL_WITH_HA_AND_SQL_SERVER_ENTERPRISE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RHEL with HA and SQL Server Enterprise" - } - } - } - }, - "com.amazonaws.ec2#CapacityReservationOptions": { - "type": "structure", - "members": { - "UsageStrategy": { - "target": "com.amazonaws.ec2#FleetCapacityReservationUsageStrategy", - "traits": { - "aws.protocols#ec2QueryName": "UsageStrategy", - "smithy.api#documentation": "

Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.

\n

If you specify use-capacity-reservations-first, the fleet uses unused\n Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If\n multiple instance pools have unused Capacity Reservations, the On-Demand allocation\n strategy (lowest-price or prioritized) is applied. If the number\n of unused Capacity Reservations is less than the On-Demand target capacity, the remaining\n On-Demand target capacity is launched according to the On-Demand allocation strategy\n (lowest-price or prioritized).

\n

If you do not specify a value, the fleet fulfils the On-Demand capacity according to the\n chosen On-Demand allocation strategy.

", - "smithy.api#xmlName": "usageStrategy" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand\n capacity.

\n \n

This strategy can only be used if the EC2 Fleet is of type\n instant.

\n \n

For more information about Capacity Reservations, see On-Demand Capacity\n Reservations in the Amazon EC2 User Guide. For examples of using\n Capacity Reservations in an EC2 Fleet, see EC2 Fleet example\n configurations in the Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#CapacityReservationOptionsRequest": { - "type": "structure", - "members": { - "UsageStrategy": { - "target": "com.amazonaws.ec2#FleetCapacityReservationUsageStrategy", - "traits": { - "smithy.api#documentation": "

Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.

\n

If you specify use-capacity-reservations-first, the fleet uses unused\n Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If\n multiple instance pools have unused Capacity Reservations, the On-Demand allocation\n strategy (lowest-price or prioritized) is applied. If the number\n of unused Capacity Reservations is less than the On-Demand target capacity, the remaining\n On-Demand target capacity is launched according to the On-Demand allocation strategy\n (lowest-price or prioritized).

\n

If you do not specify a value, the fleet fulfils the On-Demand capacity according to the\n chosen On-Demand allocation strategy.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand\n capacity.

\n \n

This strategy can only be used if the EC2 Fleet is of type instant.

\n \n

For more information about Capacity Reservations, see On-Demand Capacity\n Reservations in the Amazon EC2 User Guide. For examples of using\n Capacity Reservations in an EC2 Fleet, see EC2 Fleet example\n configurations in the Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#CapacityReservationPreference": { - "type": "enum", - "members": { - "open": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "open" - } - }, - "none": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "none" - } - } - } - }, - "com.amazonaws.ec2#CapacityReservationSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#CapacityReservation", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#CapacityReservationSpecification": { - "type": "structure", - "members": { - "CapacityReservationPreference": { - "target": "com.amazonaws.ec2#CapacityReservationPreference", - "traits": { - "smithy.api#documentation": "

Indicates the instance's Capacity Reservation preferences. Possible preferences include:

\n " - } - }, - "CapacityReservationTarget": { - "target": "com.amazonaws.ec2#CapacityReservationTarget", - "traits": { - "smithy.api#documentation": "

Information about the target Capacity Reservation or Capacity Reservation group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an instance's Capacity Reservation targeting option. You can specify only one parameter \n\t\t\tat a time. If you specify CapacityReservationPreference and \n\t\t\tCapacityReservationTarget, the request fails.

\n

Use the CapacityReservationPreference parameter to configure the instance\n\t\t\tto run as an On-Demand Instance or to run in any open Capacity Reservation that has\n\t\t\tmatching attributes (instance type, platform, Availability Zone). Use the\n\t\t\tCapacityReservationTarget parameter to explicitly target a specific\n\t\t\t \tCapacity Reservation or a Capacity Reservation group.

" - } - }, - "com.amazonaws.ec2#CapacityReservationSpecificationResponse": { - "type": "structure", - "members": { - "CapacityReservationPreference": { - "target": "com.amazonaws.ec2#CapacityReservationPreference", - "traits": { - "aws.protocols#ec2QueryName": "CapacityReservationPreference", - "smithy.api#documentation": "

Describes the instance's Capacity Reservation preferences. Possible preferences include:

\n ", - "smithy.api#xmlName": "capacityReservationPreference" - } - }, - "CapacityReservationTarget": { - "target": "com.amazonaws.ec2#CapacityReservationTargetResponse", - "traits": { - "aws.protocols#ec2QueryName": "CapacityReservationTarget", - "smithy.api#documentation": "

Information about the targeted Capacity Reservation or Capacity Reservation group.

", - "smithy.api#xmlName": "capacityReservationTarget" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the instance's Capacity Reservation targeting preferences. The action returns the\n capacityReservationPreference response element if the instance is\n configured to run in On-Demand capacity, or if it is configured in run in any\n open Capacity Reservation that has matching attributes (instance type, platform,\n Availability Zone). The action returns the capacityReservationTarget\n response element if the instance explicily targets a specific Capacity Reservation or Capacity Reservation group.

" - } - }, - "com.amazonaws.ec2#CapacityReservationState": { - "type": "enum", - "members": { - "active": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "active" - } - }, - "expired": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "expired" - } - }, - "cancelled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cancelled" - } - }, - "pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failed" - } - } - } - }, - "com.amazonaws.ec2#CapacityReservationTarget": { - "type": "structure", - "members": { - "CapacityReservationId": { - "target": "com.amazonaws.ec2#CapacityReservationId", - "traits": { - "smithy.api#documentation": "

The ID of the Capacity Reservation in which to run the instance.

" - } - }, - "CapacityReservationResourceGroupArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The ARN of the Capacity Reservation resource group in which to run the instance.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a target Capacity Reservation or Capacity Reservation group.

" - } - }, - "com.amazonaws.ec2#CapacityReservationTargetResponse": { - "type": "structure", - "members": { - "CapacityReservationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CapacityReservationId", - "smithy.api#documentation": "

The ID of the targeted Capacity Reservation.

", - "smithy.api#xmlName": "capacityReservationId" - } - }, - "CapacityReservationResourceGroupArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CapacityReservationResourceGroupArn", - "smithy.api#documentation": "

The ARN of the targeted Capacity Reservation group.

", - "smithy.api#xmlName": "capacityReservationResourceGroupArn" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a target Capacity Reservation or Capacity Reservation group.

" - } - }, - "com.amazonaws.ec2#CapacityReservationTenancy": { - "type": "enum", - "members": { - "default": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "default" - } - }, - "dedicated": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "dedicated" - } - } - } - }, - "com.amazonaws.ec2#CarrierGateway": { - "type": "structure", - "members": { - "CarrierGatewayId": { - "target": "com.amazonaws.ec2#CarrierGatewayId", - "traits": { - "aws.protocols#ec2QueryName": "CarrierGatewayId", - "smithy.api#documentation": "

The ID of the carrier gateway.

", - "smithy.api#xmlName": "carrierGatewayId" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC associated with the carrier gateway.

", - "smithy.api#xmlName": "vpcId" - } - }, - "State": { - "target": "com.amazonaws.ec2#CarrierGatewayState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the carrier gateway.

", - "smithy.api#xmlName": "state" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the carrier gateway.

", - "smithy.api#xmlName": "ownerId" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags assigned to the carrier gateway.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a carrier gateway.

" - } - }, - "com.amazonaws.ec2#CarrierGatewayId": { - "type": "string" - }, - "com.amazonaws.ec2#CarrierGatewayIdSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#CarrierGatewayId" - } - }, - "com.amazonaws.ec2#CarrierGatewayMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#CarrierGatewaySet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#CarrierGateway", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#CarrierGatewayState": { - "type": "enum", - "members": { - "pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "available": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "available" - } - }, - "deleting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleting" - } - }, - "deleted": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleted" - } - } - } - }, - "com.amazonaws.ec2#CertificateArn": { - "type": "string" - }, - "com.amazonaws.ec2#CertificateAuthentication": { - "type": "structure", - "members": { - "ClientRootCertificateChain": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientRootCertificateChain", - "smithy.api#documentation": "

The ARN of the client certificate.

", - "smithy.api#xmlName": "clientRootCertificateChain" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the client certificate used for authentication.

" - } - }, - "com.amazonaws.ec2#CertificateAuthenticationRequest": { - "type": "structure", - "members": { - "ClientRootCertificateChainArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The ARN of the client certificate. The certificate must be signed by a certificate \n\t\t\tauthority (CA) and it must be provisioned in Certificate Manager (ACM).

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the client certificate to be used for authentication.

" - } - }, - "com.amazonaws.ec2#CertificateId": { - "type": "string" - }, - "com.amazonaws.ec2#CidrAuthorizationContext": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The plain-text authorization message for the prefix and account.

", - "smithy.api#required": {} - } - }, - "Signature": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The signed authorization message for the prefix and account.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides authorization for Amazon to bring a specific IP address range to a specific\n Amazon Web Services account using bring your own IP addresses (BYOIP). For more information, see Configuring your BYOIP address range in the Amazon Elastic Compute Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#CidrBlock": { - "type": "structure", - "members": { - "CidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CidrBlock", - "smithy.api#documentation": "

The IPv4 CIDR block.

", - "smithy.api#xmlName": "cidrBlock" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an IPv4 CIDR block.

" - } - }, - "com.amazonaws.ec2#CidrBlockSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#CidrBlock", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ClassicLinkDnsSupport": { - "type": "structure", - "members": { - "ClassicLinkDnsSupported": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "ClassicLinkDnsSupported", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether ClassicLink DNS support is enabled for the VPC.

", - "smithy.api#xmlName": "classicLinkDnsSupported" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#xmlName": "vpcId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the ClassicLink DNS support status of a VPC.

" - } - }, - "com.amazonaws.ec2#ClassicLinkDnsSupportList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ClassicLinkDnsSupport", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ClassicLinkInstance": { - "type": "structure", - "members": { - "Groups": { - "target": "com.amazonaws.ec2#GroupIdentifierList", - "traits": { - "aws.protocols#ec2QueryName": "GroupSet", - "smithy.api#documentation": "

A list of security groups.

", - "smithy.api#xmlName": "groupSet" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#xmlName": "instanceId" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the instance.

", - "smithy.api#xmlName": "tagSet" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#xmlName": "vpcId" - } - } - }, - "traits": { - "smithy.api#documentation": "\n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n \n

Describes a linked EC2-Classic instance.

" - } - }, - "com.amazonaws.ec2#ClassicLinkInstanceList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ClassicLinkInstance", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ClassicLoadBalancer": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Name", - "smithy.api#documentation": "

The name of the load balancer.

", - "smithy.api#xmlName": "name" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a Classic Load Balancer.

" - } - }, - "com.amazonaws.ec2#ClassicLoadBalancers": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ClassicLoadBalancer", - "traits": { - "smithy.api#xmlName": "item" - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.ec2#ClassicLoadBalancersConfig": { - "type": "structure", - "members": { - "ClassicLoadBalancers": { - "target": "com.amazonaws.ec2#ClassicLoadBalancers", - "traits": { - "aws.protocols#ec2QueryName": "ClassicLoadBalancers", - "smithy.api#documentation": "

One or more Classic Load Balancers.

", - "smithy.api#xmlName": "classicLoadBalancers" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the Classic Load Balancers to attach to a Spot Fleet. Spot Fleet registers\n the running Spot Instances with these Classic Load Balancers.

" - } - }, - "com.amazonaws.ec2#ClientCertificateRevocationListStatus": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.ec2#ClientCertificateRevocationListStatusCode", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The state of the client certificate revocation list.

", - "smithy.api#xmlName": "code" - } - }, - "Message": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "

A message about the status of the client certificate revocation list, if applicable.

", - "smithy.api#xmlName": "message" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the state of a client certificate revocation list.

" - } - }, - "com.amazonaws.ec2#ClientCertificateRevocationListStatusCode": { - "type": "enum", - "members": { - "pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "active": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "active" - } - } - } - }, - "com.amazonaws.ec2#ClientConnectOptions": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether client connect options are enabled. The default is false (not enabled).

" - } - }, - "LambdaFunctionArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Lambda function used for connection authorization.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options for managing connection authorization for new client connections.

" - } - }, - "com.amazonaws.ec2#ClientConnectResponseOptions": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Enabled", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether client connect options are enabled.

", - "smithy.api#xmlName": "enabled" - } - }, - "LambdaFunctionArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LambdaFunctionArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Lambda function used for connection authorization.

", - "smithy.api#xmlName": "lambdaFunctionArn" - } - }, - "Status": { - "target": "com.amazonaws.ec2#ClientVpnEndpointAttributeStatus", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The status of any updates to the client connect options.

", - "smithy.api#xmlName": "status" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options for managing connection authorization for new client connections.

" - } - }, - "com.amazonaws.ec2#ClientData": { - "type": "structure", - "members": { - "Comment": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A user-defined comment about the disk upload.

" - } - }, - "UploadEnd": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "smithy.api#documentation": "

The time that the disk upload ends.

" - } - }, - "UploadSize": { - "target": "com.amazonaws.ec2#Double", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The size of the uploaded disk image, in GiB.

" - } - }, - "UploadStart": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "smithy.api#documentation": "

The time that the disk upload starts.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the client-specific data.

" - } - }, - "com.amazonaws.ec2#ClientLoginBannerOptions": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Enable or disable a customizable text banner that will be displayed on\n\t\t\tAmazon Web Services provided clients when a VPN session is established.

\n

Valid values: true | false\n

\n

Default value: false\n

" - } - }, - "BannerText": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Customizable text that will be displayed in a banner on Amazon Web Services provided\n\t\t\tclients when a VPN session is established. UTF-8 encoded characters only. Maximum of\n\t\t\t1400 characters.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Options for enabling a customizable text banner that will be displayed on\n\t\t\tAmazon Web Services provided clients when a VPN session is established.

" - } - }, - "com.amazonaws.ec2#ClientLoginBannerResponseOptions": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Enabled", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Current state of text banner feature.

\n

Valid values: true | false\n

", - "smithy.api#xmlName": "enabled" - } - }, - "BannerText": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "BannerText", - "smithy.api#documentation": "

Customizable text that will be displayed in a banner on Amazon Web Services provided\n\t\t\tclients when a VPN session is established. UTF-8 encoded\n\t\t\tcharacters only. Maximum of 1400 characters.

", - "smithy.api#xmlName": "bannerText" - } - } - }, - "traits": { - "smithy.api#documentation": "

Current state of options for customizable text banner that will be displayed on\n\t\t\tAmazon Web Services provided clients when a VPN session is established.

" - } - }, - "com.amazonaws.ec2#ClientSecretType": { - "type": "string", - "traits": { - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.ec2#ClientVpnAssociationId": { - "type": "string" - }, - "com.amazonaws.ec2#ClientVpnAuthentication": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.ec2#ClientVpnAuthenticationType", - "traits": { - "aws.protocols#ec2QueryName": "Type", - "smithy.api#documentation": "

The authentication type used.

", - "smithy.api#xmlName": "type" - } - }, - "ActiveDirectory": { - "target": "com.amazonaws.ec2#DirectoryServiceAuthentication", - "traits": { - "aws.protocols#ec2QueryName": "ActiveDirectory", - "smithy.api#documentation": "

Information about the Active Directory, if applicable.

", - "smithy.api#xmlName": "activeDirectory" - } - }, - "MutualAuthentication": { - "target": "com.amazonaws.ec2#CertificateAuthentication", - "traits": { - "aws.protocols#ec2QueryName": "MutualAuthentication", - "smithy.api#documentation": "

Information about the authentication certificates, if applicable.

", - "smithy.api#xmlName": "mutualAuthentication" - } - }, - "FederatedAuthentication": { - "target": "com.amazonaws.ec2#FederatedAuthentication", - "traits": { - "aws.protocols#ec2QueryName": "FederatedAuthentication", - "smithy.api#documentation": "

Information about the IAM SAML identity provider, if applicable.

", - "smithy.api#xmlName": "federatedAuthentication" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the authentication methods used by a Client VPN endpoint. For more information, see Authentication \n\t\t\tin the Client VPN Administrator Guide.

" - } - }, - "com.amazonaws.ec2#ClientVpnAuthenticationList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ClientVpnAuthentication", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ClientVpnAuthenticationRequest": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.ec2#ClientVpnAuthenticationType", - "traits": { - "smithy.api#documentation": "

The type of client authentication to be used.

" - } - }, - "ActiveDirectory": { - "target": "com.amazonaws.ec2#DirectoryServiceAuthenticationRequest", - "traits": { - "smithy.api#documentation": "

Information about the Active Directory to be used, if applicable. You must provide this information if Type is directory-service-authentication.

" - } - }, - "MutualAuthentication": { - "target": "com.amazonaws.ec2#CertificateAuthenticationRequest", - "traits": { - "smithy.api#documentation": "

Information about the authentication certificates to be used, if applicable. You must provide this information if Type is certificate-authentication.

" - } - }, - "FederatedAuthentication": { - "target": "com.amazonaws.ec2#FederatedAuthenticationRequest", - "traits": { - "smithy.api#documentation": "

Information about the IAM SAML identity provider to be used, if applicable. You must provide this information if Type is federated-authentication.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the authentication method to be used by a Client VPN endpoint. For more information, see Authentication \n\t\t\tin the Client VPN Administrator Guide.

" - } - }, - "com.amazonaws.ec2#ClientVpnAuthenticationRequestList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ClientVpnAuthenticationRequest" - } - }, - "com.amazonaws.ec2#ClientVpnAuthenticationType": { - "type": "enum", - "members": { - "certificate_authentication": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "certificate-authentication" - } - }, - "directory_service_authentication": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "directory-service-authentication" - } - }, - "federated_authentication": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "federated-authentication" - } - } - } - }, - "com.amazonaws.ec2#ClientVpnAuthorizationRuleStatus": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.ec2#ClientVpnAuthorizationRuleStatusCode", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The state of the authorization rule.

", - "smithy.api#xmlName": "code" - } - }, - "Message": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "

A message about the status of the authorization rule, if applicable.

", - "smithy.api#xmlName": "message" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the state of an authorization rule.

" - } - }, - "com.amazonaws.ec2#ClientVpnAuthorizationRuleStatusCode": { - "type": "enum", - "members": { - "authorizing": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "authorizing" - } - }, - "active": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "active" - } - }, - "failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failed" - } - }, - "revoking": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "revoking" - } - } - } - }, - "com.amazonaws.ec2#ClientVpnConnection": { - "type": "structure", - "members": { - "ClientVpnEndpointId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientVpnEndpointId", - "smithy.api#documentation": "

The ID of the Client VPN endpoint to which the client is connected.

", - "smithy.api#xmlName": "clientVpnEndpointId" - } - }, - "Timestamp": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Timestamp", - "smithy.api#documentation": "

The current date and time.

", - "smithy.api#xmlName": "timestamp" - } - }, - "ConnectionId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ConnectionId", - "smithy.api#documentation": "

The ID of the client connection.

", - "smithy.api#xmlName": "connectionId" - } - }, - "Username": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Username", - "smithy.api#documentation": "

The username of the client who established the client connection. This information is only provided \n\t\t\tif Active Directory client authentication is used.

", - "smithy.api#xmlName": "username" - } - }, - "ConnectionEstablishedTime": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ConnectionEstablishedTime", - "smithy.api#documentation": "

The date and time the client connection was established.

", - "smithy.api#xmlName": "connectionEstablishedTime" - } - }, - "IngressBytes": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "IngressBytes", - "smithy.api#documentation": "

The number of bytes sent by the client.

", - "smithy.api#xmlName": "ingressBytes" - } - }, - "EgressBytes": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "EgressBytes", - "smithy.api#documentation": "

The number of bytes received by the client.

", - "smithy.api#xmlName": "egressBytes" - } - }, - "IngressPackets": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "IngressPackets", - "smithy.api#documentation": "

The number of packets sent by the client.

", - "smithy.api#xmlName": "ingressPackets" - } - }, - "EgressPackets": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "EgressPackets", - "smithy.api#documentation": "

The number of packets received by the client.

", - "smithy.api#xmlName": "egressPackets" - } - }, - "ClientIp": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientIp", - "smithy.api#documentation": "

The IP address of the client.

", - "smithy.api#xmlName": "clientIp" - } - }, - "CommonName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CommonName", - "smithy.api#documentation": "

The common name associated with the client. This is either the name of the client certificate,\n\t\t\tor the Active Directory user name.

", - "smithy.api#xmlName": "commonName" - } - }, - "Status": { - "target": "com.amazonaws.ec2#ClientVpnConnectionStatus", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The current state of the client connection.

", - "smithy.api#xmlName": "status" - } - }, - "ConnectionEndTime": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ConnectionEndTime", - "smithy.api#documentation": "

The date and time the client connection was terminated.

", - "smithy.api#xmlName": "connectionEndTime" - } - }, - "PostureComplianceStatuses": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "PostureComplianceStatusSet", - "smithy.api#documentation": "

The statuses returned by the client connect handler for posture compliance, if applicable.

", - "smithy.api#xmlName": "postureComplianceStatusSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a client connection.

" - } - }, - "com.amazonaws.ec2#ClientVpnConnectionSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ClientVpnConnection", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ClientVpnConnectionStatus": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.ec2#ClientVpnConnectionStatusCode", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The state of the client connection.

", - "smithy.api#xmlName": "code" - } - }, - "Message": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "

A message about the status of the client connection, if applicable.

", - "smithy.api#xmlName": "message" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the status of a client connection.

" - } - }, - "com.amazonaws.ec2#ClientVpnConnectionStatusCode": { - "type": "enum", - "members": { - "active": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "active" - } - }, - "failed_to_terminate": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failed-to-terminate" - } - }, - "terminating": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "terminating" - } - }, - "terminated": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "terminated" - } - } - } - }, - "com.amazonaws.ec2#ClientVpnEndpoint": { - "type": "structure", - "members": { - "ClientVpnEndpointId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientVpnEndpointId", - "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", - "smithy.api#xmlName": "clientVpnEndpointId" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A brief description of the endpoint.

", - "smithy.api#xmlName": "description" - } - }, - "Status": { - "target": "com.amazonaws.ec2#ClientVpnEndpointStatus", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The current state of the Client VPN endpoint.

", - "smithy.api#xmlName": "status" - } - }, - "CreationTime": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CreationTime", - "smithy.api#documentation": "

The date and time the Client VPN endpoint was created.

", - "smithy.api#xmlName": "creationTime" - } - }, - "DeletionTime": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DeletionTime", - "smithy.api#documentation": "

The date and time the Client VPN endpoint was deleted, if applicable.

", - "smithy.api#xmlName": "deletionTime" - } - }, - "DnsName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DnsName", - "smithy.api#documentation": "

The DNS name to be used by clients when connecting to the Client VPN endpoint.

", - "smithy.api#xmlName": "dnsName" - } - }, - "ClientCidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientCidrBlock", - "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.

", - "smithy.api#xmlName": "clientCidrBlock" - } - }, - "DnsServers": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "DnsServer", - "smithy.api#documentation": "

Information about the DNS servers to be used for DNS resolution.

", - "smithy.api#xmlName": "dnsServer" - } - }, - "SplitTunnel": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "SplitTunnel", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether split-tunnel is enabled in the Client VPN endpoint.

\n

For information about split-tunnel VPN endpoints, see Split-Tunnel Client VPN endpoint \n\t\t\tin the Client VPN Administrator Guide.

", - "smithy.api#xmlName": "splitTunnel" - } - }, - "VpnProtocol": { - "target": "com.amazonaws.ec2#VpnProtocol", - "traits": { - "aws.protocols#ec2QueryName": "VpnProtocol", - "smithy.api#documentation": "

The protocol used by the VPN session.

", - "smithy.api#xmlName": "vpnProtocol" - } - }, - "TransportProtocol": { - "target": "com.amazonaws.ec2#TransportProtocol", - "traits": { - "aws.protocols#ec2QueryName": "TransportProtocol", - "smithy.api#documentation": "

The transport protocol used by the Client VPN endpoint.

", - "smithy.api#xmlName": "transportProtocol" - } - }, - "VpnPort": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "VpnPort", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The port number for the Client VPN endpoint.

", - "smithy.api#xmlName": "vpnPort" - } - }, - "AssociatedTargetNetworks": { - "target": "com.amazonaws.ec2#AssociatedTargetNetworkSet", - "traits": { - "aws.protocols#ec2QueryName": "AssociatedTargetNetwork", - "smithy.api#deprecated": { - "message": "This property is deprecated. To view the target networks associated with a Client VPN endpoint, call DescribeClientVpnTargetNetworks and inspect the clientVpnTargetNetworks response element." - }, - "smithy.api#documentation": "

Information about the associated target networks. A target network is a subnet in a VPC.

", - "smithy.api#xmlName": "associatedTargetNetwork" - } - }, - "ServerCertificateArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ServerCertificateArn", - "smithy.api#documentation": "

The ARN of the server certificate.

", - "smithy.api#xmlName": "serverCertificateArn" - } - }, - "AuthenticationOptions": { - "target": "com.amazonaws.ec2#ClientVpnAuthenticationList", - "traits": { - "aws.protocols#ec2QueryName": "AuthenticationOptions", - "smithy.api#documentation": "

Information about the authentication method used by the Client VPN endpoint.

", - "smithy.api#xmlName": "authenticationOptions" - } - }, - "ConnectionLogOptions": { - "target": "com.amazonaws.ec2#ConnectionLogResponseOptions", - "traits": { - "aws.protocols#ec2QueryName": "ConnectionLogOptions", - "smithy.api#documentation": "

Information about the client connection logging options for the Client VPN endpoint.

", - "smithy.api#xmlName": "connectionLogOptions" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the Client VPN endpoint.

", - "smithy.api#xmlName": "tagSet" - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.ec2#ClientVpnSecurityGroupIdSet", - "traits": { - "aws.protocols#ec2QueryName": "SecurityGroupIdSet", - "smithy.api#documentation": "

The IDs of the security groups for the target network.

", - "smithy.api#xmlName": "securityGroupIdSet" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#xmlName": "vpcId" - } - }, - "SelfServicePortalUrl": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SelfServicePortalUrl", - "smithy.api#documentation": "

The URL of the self-service portal.

", - "smithy.api#xmlName": "selfServicePortalUrl" - } - }, - "ClientConnectOptions": { - "target": "com.amazonaws.ec2#ClientConnectResponseOptions", - "traits": { - "aws.protocols#ec2QueryName": "ClientConnectOptions", - "smithy.api#documentation": "

The options for managing connection authorization for new client connections.

", - "smithy.api#xmlName": "clientConnectOptions" - } - }, - "SessionTimeoutHours": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "SessionTimeoutHours", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum VPN session duration time in hours.

\n

Valid values: 8 | 10 | 12 | 24\n

\n

Default value: 24\n

", - "smithy.api#xmlName": "sessionTimeoutHours" - } - }, - "ClientLoginBannerOptions": { - "target": "com.amazonaws.ec2#ClientLoginBannerResponseOptions", - "traits": { - "aws.protocols#ec2QueryName": "ClientLoginBannerOptions", - "smithy.api#documentation": "

Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is\n\t\t\testablished.

", - "smithy.api#xmlName": "clientLoginBannerOptions" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a Client VPN endpoint.

" - } - }, - "com.amazonaws.ec2#ClientVpnEndpointAttributeStatus": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.ec2#ClientVpnEndpointAttributeStatusCode", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The status code.

", - "smithy.api#xmlName": "code" - } - }, - "Message": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "

The status message.

", - "smithy.api#xmlName": "message" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the status of the Client VPN endpoint attribute.

" - } - }, - "com.amazonaws.ec2#ClientVpnEndpointAttributeStatusCode": { - "type": "enum", - "members": { - "applying": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "applying" - } - }, - "applied": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "applied" - } - } - } - }, - "com.amazonaws.ec2#ClientVpnEndpointId": { - "type": "string" - }, - "com.amazonaws.ec2#ClientVpnEndpointIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ClientVpnEndpointId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ClientVpnEndpointStatus": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.ec2#ClientVpnEndpointStatusCode", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The state of the Client VPN endpoint. Possible states include:

\n ", - "smithy.api#xmlName": "code" - } - }, - "Message": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "

A message about the status of the Client VPN endpoint.

", - "smithy.api#xmlName": "message" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the state of a Client VPN endpoint.

" - } - }, - "com.amazonaws.ec2#ClientVpnEndpointStatusCode": { - "type": "enum", - "members": { - "pending_associate": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending-associate" - } - }, - "available": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "available" - } - }, - "deleting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleting" - } - }, - "deleted": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleted" - } - } - } - }, - "com.amazonaws.ec2#ClientVpnRoute": { - "type": "structure", - "members": { - "ClientVpnEndpointId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientVpnEndpointId", - "smithy.api#documentation": "

The ID of the Client VPN endpoint with which the route is associated.

", - "smithy.api#xmlName": "clientVpnEndpointId" - } - }, - "DestinationCidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DestinationCidr", - "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, of the route destination.

", - "smithy.api#xmlName": "destinationCidr" - } - }, - "TargetSubnet": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TargetSubnet", - "smithy.api#documentation": "

The ID of the subnet through which traffic is routed.

", - "smithy.api#xmlName": "targetSubnet" - } - }, - "Type": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Type", - "smithy.api#documentation": "

The route type.

", - "smithy.api#xmlName": "type" - } - }, - "Origin": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Origin", - "smithy.api#documentation": "

Indicates how the route was associated with the Client VPN endpoint. \n\t\t\tassociate indicates that the route was automatically added when the target network \n\t\t\twas associated with the Client VPN endpoint. add-route indicates that the route \n\t\t\twas manually added using the CreateClientVpnRoute action.

", - "smithy.api#xmlName": "origin" - } - }, - "Status": { - "target": "com.amazonaws.ec2#ClientVpnRouteStatus", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The current state of the route.

", - "smithy.api#xmlName": "status" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A brief description of the route.

", - "smithy.api#xmlName": "description" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a Client VPN endpoint route.

" - } - }, - "com.amazonaws.ec2#ClientVpnRouteSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ClientVpnRoute", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ClientVpnRouteStatus": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.ec2#ClientVpnRouteStatusCode", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The state of the Client VPN endpoint route.

", - "smithy.api#xmlName": "code" - } - }, - "Message": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "

A message about the status of the Client VPN endpoint route, if applicable.

", - "smithy.api#xmlName": "message" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the state of a Client VPN endpoint route.

" - } - }, - "com.amazonaws.ec2#ClientVpnRouteStatusCode": { - "type": "enum", - "members": { - "creating": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "creating" - } - }, - "active": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "active" - } - }, - "failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failed" - } - }, - "deleting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleting" - } - } - } - }, - "com.amazonaws.ec2#ClientVpnSecurityGroupIdSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SecurityGroupId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#CloudWatchLogGroupArn": { - "type": "string" - }, - "com.amazonaws.ec2#CloudWatchLogOptions": { - "type": "structure", - "members": { - "LogEnabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "LogEnabled", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Status of VPN tunnel logging feature. Default value is False.

\n

Valid values: True | False\n

", - "smithy.api#xmlName": "logEnabled" - } - }, - "LogGroupArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LogGroupArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudWatch log group to send logs to.

", - "smithy.api#xmlName": "logGroupArn" - } - }, - "LogOutputFormat": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LogOutputFormat", - "smithy.api#documentation": "

Configured log format. Default format is json.

\n

Valid values: json | text\n

", - "smithy.api#xmlName": "logOutputFormat" - } - } - }, - "traits": { - "smithy.api#documentation": "

Options for sending VPN tunnel logs to CloudWatch.

" - } - }, - "com.amazonaws.ec2#CloudWatchLogOptionsSpecification": { - "type": "structure", - "members": { - "LogEnabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Enable or disable VPN tunnel logging feature. Default value is False.

\n

Valid values: True | False\n

" - } - }, - "LogGroupArn": { - "target": "com.amazonaws.ec2#CloudWatchLogGroupArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudWatch log group to send logs to.

" - } - }, - "LogOutputFormat": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Set log format. Default format is json.

\n

Valid values: json | text\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Options for sending VPN tunnel logs to CloudWatch.

" - } - }, - "com.amazonaws.ec2#CoipAddressUsage": { - "type": "structure", - "members": { - "AllocationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AllocationId", - "smithy.api#documentation": "

The allocation ID of the address.

", - "smithy.api#xmlName": "allocationId" - } - }, - "AwsAccountId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AwsAccountId", - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#xmlName": "awsAccountId" - } - }, - "AwsService": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AwsService", - "smithy.api#documentation": "

The Amazon Web Services service.

", - "smithy.api#xmlName": "awsService" - } - }, - "CoIp": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CoIp", - "smithy.api#documentation": "

The customer-owned IP address.

", - "smithy.api#xmlName": "coIp" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes address usage for a customer-owned address pool.

" - } - }, - "com.amazonaws.ec2#CoipAddressUsageSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#CoipAddressUsage", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#CoipCidr": { - "type": "structure", - "members": { - "Cidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Cidr", - "smithy.api#documentation": "

\n An address range in a customer-owned IP address space.\n

", - "smithy.api#xmlName": "cidr" - } - }, - "CoipPoolId": { - "target": "com.amazonaws.ec2#Ipv4PoolCoipId", - "traits": { - "aws.protocols#ec2QueryName": "CoipPoolId", - "smithy.api#documentation": "

\n The ID of the address pool.\n

", - "smithy.api#xmlName": "coipPoolId" - } - }, - "LocalGatewayRouteTableId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayRouteTableId", - "smithy.api#documentation": "

\n The ID of the local gateway route table.\n

", - "smithy.api#xmlName": "localGatewayRouteTableId" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Information about a customer-owned IP address range.\n

" - } - }, - "com.amazonaws.ec2#CoipPool": { - "type": "structure", - "members": { - "PoolId": { - "target": "com.amazonaws.ec2#Ipv4PoolCoipId", - "traits": { - "aws.protocols#ec2QueryName": "PoolId", - "smithy.api#documentation": "

The ID of the address pool.

", - "smithy.api#xmlName": "poolId" - } - }, - "PoolCidrs": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "PoolCidrSet", - "smithy.api#documentation": "

The address ranges of the address pool.

", - "smithy.api#xmlName": "poolCidrSet" - } - }, - "LocalGatewayRouteTableId": { - "target": "com.amazonaws.ec2#LocalGatewayRoutetableId", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayRouteTableId", - "smithy.api#documentation": "

The ID of the local gateway route table.

", - "smithy.api#xmlName": "localGatewayRouteTableId" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags.

", - "smithy.api#xmlName": "tagSet" - } - }, - "PoolArn": { - "target": "com.amazonaws.ec2#ResourceArn", - "traits": { - "aws.protocols#ec2QueryName": "PoolArn", - "smithy.api#documentation": "

The ARN of the address pool.

", - "smithy.api#xmlName": "poolArn" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a customer-owned address pool.

" - } - }, - "com.amazonaws.ec2#CoipPoolId": { - "type": "string" - }, - "com.amazonaws.ec2#CoipPoolIdSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Ipv4PoolCoipId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#CoipPoolMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#CoipPoolSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#CoipPool", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ComponentAccount": { - "type": "string", - "traits": { - "smithy.api#pattern": "^\\d{12}$" - } - }, - "com.amazonaws.ec2#ComponentRegion": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-z]{2}-[a-z]+-[1-9]+$" - } - }, - "com.amazonaws.ec2#ConfirmProductInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ConfirmProductInstanceRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ConfirmProductInstanceResult" - }, - "traits": { - "smithy.api#documentation": "

Determines whether a product code is associated with an instance. This action can only\n be used by the owner of the product code. It is useful when a product code owner must\n verify whether another user's instance is eligible for support.

" - } - }, - "com.amazonaws.ec2#ConfirmProductInstanceRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#required": {} - } - }, - "ProductCode": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The product code. This must be a product code that you own.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ConfirmProductInstanceResult": { - "type": "structure", - "members": { - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The Amazon Web Services account ID of the instance owner. This is only present if the\n product code is attached to the instance.

", - "smithy.api#xmlName": "ownerId" - } - }, - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

The return value of the request. Returns true if the specified product\n code is owned by the requester and associated with the specified instance.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ConnectionLogOptions": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether connection logging is enabled.

" - } - }, - "CloudwatchLogGroup": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The name of the CloudWatch Logs log group. Required if connection logging is enabled.

" - } - }, - "CloudwatchLogStream": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The name of the CloudWatch Logs log stream to which the connection data is published.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the client connection logging options for the Client VPN endpoint.

" - } - }, - "com.amazonaws.ec2#ConnectionLogResponseOptions": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether client connection logging is enabled for the Client VPN endpoint.

" - } - }, - "CloudwatchLogGroup": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The name of the Amazon CloudWatch Logs log group to which connection logging data is published.

" - } - }, - "CloudwatchLogStream": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The name of the Amazon CloudWatch Logs log stream to which connection logging data is published.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the client connection logging options for a Client VPN endpoint.

" - } - }, - "com.amazonaws.ec2#ConnectionNotification": { - "type": "structure", - "members": { - "ConnectionNotificationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ConnectionNotificationId", - "smithy.api#documentation": "

The ID of the notification.

", - "smithy.api#xmlName": "connectionNotificationId" - } - }, - "ServiceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ServiceId", - "smithy.api#documentation": "

The ID of the endpoint service.

", - "smithy.api#xmlName": "serviceId" - } - }, - "VpcEndpointId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcEndpointId", - "smithy.api#documentation": "

The ID of the VPC endpoint.

", - "smithy.api#xmlName": "vpcEndpointId" - } - }, - "ConnectionNotificationType": { - "target": "com.amazonaws.ec2#ConnectionNotificationType", - "traits": { - "aws.protocols#ec2QueryName": "ConnectionNotificationType", - "smithy.api#documentation": "

The type of notification.

", - "smithy.api#xmlName": "connectionNotificationType" - } - }, - "ConnectionNotificationArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ConnectionNotificationArn", - "smithy.api#documentation": "

The ARN of the SNS topic for the notification.

", - "smithy.api#xmlName": "connectionNotificationArn" - } - }, - "ConnectionEvents": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "ConnectionEvents", - "smithy.api#documentation": "

The events for the notification. Valid values are Accept,\n Connect, Delete, and Reject.

", - "smithy.api#xmlName": "connectionEvents" - } - }, - "ConnectionNotificationState": { - "target": "com.amazonaws.ec2#ConnectionNotificationState", - "traits": { - "aws.protocols#ec2QueryName": "ConnectionNotificationState", - "smithy.api#documentation": "

The state of the notification.

", - "smithy.api#xmlName": "connectionNotificationState" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a connection notification for a VPC endpoint or VPC endpoint\n service.

" - } - }, - "com.amazonaws.ec2#ConnectionNotificationId": { - "type": "string" - }, - "com.amazonaws.ec2#ConnectionNotificationIdsList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ConnectionNotificationId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ConnectionNotificationSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ConnectionNotification", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ConnectionNotificationState": { - "type": "enum", - "members": { - "Enabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Enabled" - } - }, - "Disabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Disabled" - } - } - } - }, - "com.amazonaws.ec2#ConnectionNotificationType": { - "type": "enum", - "members": { - "Topic": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Topic" - } - } - } - }, - "com.amazonaws.ec2#ConnectivityType": { - "type": "enum", - "members": { - "PRIVATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "private" - } - }, - "PUBLIC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "public" - } - } - } - }, - "com.amazonaws.ec2#ContainerFormat": { - "type": "enum", - "members": { - "ova": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ova" - } - } - } - }, - "com.amazonaws.ec2#ConversionIdStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ConversionTaskId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ConversionTask": { - "type": "structure", - "members": { - "ConversionTaskId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ConversionTaskId", - "smithy.api#documentation": "

The ID of the conversion task.

", - "smithy.api#xmlName": "conversionTaskId" - } - }, - "ExpirationTime": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ExpirationTime", - "smithy.api#documentation": "

The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel\n the task.

", - "smithy.api#xmlName": "expirationTime" - } - }, - "ImportInstance": { - "target": "com.amazonaws.ec2#ImportInstanceTaskDetails", - "traits": { - "aws.protocols#ec2QueryName": "ImportInstance", - "smithy.api#documentation": "

If the task is for importing an instance, this contains information about the import instance task.

", - "smithy.api#xmlName": "importInstance" - } - }, - "ImportVolume": { - "target": "com.amazonaws.ec2#ImportVolumeTaskDetails", - "traits": { - "aws.protocols#ec2QueryName": "ImportVolume", - "smithy.api#documentation": "

If the task is for importing a volume, this contains information about the import volume task.

", - "smithy.api#xmlName": "importVolume" - } - }, - "State": { - "target": "com.amazonaws.ec2#ConversionTaskState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the conversion task.

", - "smithy.api#xmlName": "state" - } - }, - "StatusMessage": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StatusMessage", - "smithy.api#documentation": "

The status message related to the conversion task.

", - "smithy.api#xmlName": "statusMessage" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the task.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a conversion task.

" - } - }, - "com.amazonaws.ec2#ConversionTaskId": { - "type": "string" - }, - "com.amazonaws.ec2#ConversionTaskState": { - "type": "enum", - "members": { - "active": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "active" - } - }, - "cancelling": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cancelling" - } - }, - "cancelled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cancelled" - } - }, - "completed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "completed" - } - } - } - }, - "com.amazonaws.ec2#CopyFpgaImage": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CopyFpgaImageRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CopyFpgaImageResult" - }, - "traits": { - "smithy.api#documentation": "

Copies the specified Amazon FPGA Image (AFI) to the current Region.

" - } - }, - "com.amazonaws.ec2#CopyFpgaImageRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "SourceFpgaImageId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the source AFI.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The description for the new AFI.

" - } - }, - "Name": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The name for the new AFI. The default is the name of the source AFI.

" - } - }, - "SourceRegion": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Region that contains the source AFI.

", - "smithy.api#required": {} - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. \n For more information, see Ensuring idempotency.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CopyFpgaImageResult": { - "type": "structure", - "members": { - "FpgaImageId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "FpgaImageId", - "smithy.api#documentation": "

The ID of the new AFI.

", - "smithy.api#xmlName": "fpgaImageId" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CopyImage": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CopyImageRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CopyImageResult" - }, - "traits": { - "smithy.api#documentation": "

Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a\n Region to an Outpost. You can't copy an AMI from an Outpost to a Region, from one Outpost\n to another, or within the same Outpost. To copy an AMI to another partition, see CreateStoreImageTask.

\n

To copy an AMI from one Region to another, specify the source Region using the \n \t\tSourceRegion parameter, and specify the \n \t\tdestination Region using its endpoint. Copies of encrypted backing snapshots for\n \t\tthe AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, \n \t\tunless you set Encrypted during the copy operation. You cannot \n \t\tcreate an unencrypted copy of an encrypted backing snapshot.

\n

To copy an AMI from a Region to an Outpost, specify the source Region using the \n \t\tSourceRegion parameter, and specify the \n \t\tARN of the destination Outpost using DestinationOutpostArn. \n \t\tBacking snapshots copied to an Outpost are encrypted by default using the default\n \t\tencryption key for the Region, or a different key that you specify in the request using \n \t\tKmsKeyId. Outposts do not support unencrypted \n \t\tsnapshots. For more information, \n \t\t\tAmazon EBS local snapshots on Outposts in the Amazon EC2 User Guide.

\n

For more information about the prerequisites and limits when copying an AMI, see Copy an AMI in the\n Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#CopyImageRequest": { - "type": "structure", - "members": { - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure\n idempotency of the request. For more information, see Ensuring idempotency \n in the Amazon EC2 API Reference.

" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A description for the new AMI in the destination Region.

" - } - }, - "Encrypted": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Encrypted", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether the destination snapshots of the copied image should be encrypted. You\n can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an\n encrypted snapshot. The default KMS key for Amazon EBS is used unless you specify a non-default\n Key Management Service (KMS) KMS key using KmsKeyId. For more information, see Amazon EBS encryption in the\n Amazon EC2 User Guide.

", - "smithy.api#xmlName": "encrypted" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.ec2#KmsKeyId", - "traits": { - "aws.protocols#ec2QueryName": "KmsKeyId", - "smithy.api#documentation": "

The identifier of the symmetric Key Management Service (KMS) KMS key to use when creating\n \t\tencrypted volumes. If this parameter is not specified, your Amazon Web Services managed KMS key for Amazon EBS is used. \n \t\tIf you specify a KMS key, you must also set the encrypted state to true.

\n

You can specify a KMS key using any of the following:

\n \n

Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an identifier that is not valid,\n the action can appear to complete, but eventually fails.

\n

The specified KMS key must exist in the destination Region.

\n

Amazon EBS does not support asymmetric KMS keys.

", - "smithy.api#xmlName": "kmsKeyId" - } - }, - "Name": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the new AMI in the destination Region.

", - "smithy.api#required": {} - } - }, - "SourceImageId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the AMI to copy.

", - "smithy.api#required": {} - } - }, - "SourceRegion": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Region that contains the AMI to copy.

", - "smithy.api#required": {} - } - }, - "DestinationOutpostArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only \n \t\tspecify this parameter when copying an AMI from an Amazon Web Services Region to an Outpost. \n \t\tThe AMI must be in the Region of the destination Outpost. You cannot copy an \n \t\tAMI from an Outpost to a Region, from one Outpost to another, or within the same \n \t\tOutpost.

\n

For more information, see Copy AMIs from an Amazon Web Services\n Region to an Outpost in the Amazon EC2 User Guide.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "CopyImageTags": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to include your user-defined AMI tags when copying the AMI.

\n

The following tags will not be copied:

\n \n

Default: Your user-defined AMI tags are not copied.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for CopyImage.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CopyImageResult": { - "type": "structure", - "members": { - "ImageId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ImageId", - "smithy.api#documentation": "

The ID of the new AMI.

", - "smithy.api#xmlName": "imageId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of CopyImage.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CopySnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CopySnapshotRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CopySnapshotResult" - }, - "traits": { - "smithy.api#documentation": "

Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy a\n snapshot within the same Region, from one Region to another, or from a Region to an Outpost. \n You can't copy a snapshot from an Outpost to a Region, from one Outpost to another, or within \n the same Outpost.

\n

You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).

\n

When copying snapshots to a Region, copies of encrypted EBS snapshots remain encrypted. \n \tCopies of unencrypted snapshots remain unencrypted, unless you enable encryption for the \n \tsnapshot copy operation. By default, encrypted snapshot copies use the default Key Management Service (KMS) \n \tKMS key; however, you can specify a different KMS key. To copy an encrypted \n \tsnapshot that has been shared from another account, you must have permissions for the KMS key \n \tused to encrypt the snapshot.

\n

Snapshots copied to an Outpost are encrypted by default using the default\n \t\tencryption key for the Region, or a different key that you specify in the request using \n \t\tKmsKeyId. Outposts do not support unencrypted \n \t\tsnapshots. For more information, \n \t\t\tAmazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.

\n

Snapshots created by copying another snapshot have an arbitrary volume ID that should not\n be used for any purpose.

\n

For more information, see Copy an Amazon EBS snapshot in the\n Amazon Elastic Compute Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#CopySnapshotRequest": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A description for the EBS snapshot.

" - } - }, - "DestinationOutpostArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only \n\t\tspecify this parameter when copying a snapshot from an Amazon Web Services Region to an Outpost. \n\t\tThe snapshot must be in the Region for the destination Outpost. You cannot copy a \n\t\tsnapshot from an Outpost to a Region, from one Outpost to another, or within the same \n\t\tOutpost.

\n

For more information, see \n \t\tCopy snapshots from an Amazon Web Services Region to an Outpost in the \n \t\tAmazon Elastic Compute Cloud User Guide.

" - } - }, - "DestinationRegion": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DestinationRegion", - "smithy.api#documentation": "

The destination Region to use in the PresignedUrl parameter of a snapshot\n copy operation. This parameter is only valid for specifying the destination Region in a\n PresignedUrl parameter, where it is required.

\n

The snapshot copy is sent to the regional endpoint that you sent the HTTP\n \trequest to (for example, ec2.us-east-1.amazonaws.com). With the CLI, this is\n specified using the --region parameter or the default Region in your Amazon Web Services\n configuration file.

", - "smithy.api#xmlName": "destinationRegion" - } - }, - "Encrypted": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Encrypted", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, \n enable encryption using this parameter. Otherwise, omit this parameter. Encrypted snapshots \n are encrypted, even if you omit this parameter and encryption by default is not enabled. You \n cannot set this parameter to false. For more information, see Amazon EBS encryption in the \n Amazon Elastic Compute Cloud User Guide.

", - "smithy.api#xmlName": "encrypted" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.ec2#KmsKeyId", - "traits": { - "aws.protocols#ec2QueryName": "KmsKeyId", - "smithy.api#documentation": "

The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption.\n If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is\n specified, the encrypted state must be true.

\n

You can specify the KMS key using any of the following:

\n \n

Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, \n the action can appear to complete, but eventually fails.

", - "smithy.api#xmlName": "kmsKeyId" - } - }, - "PresignedUrl": { - "target": "com.amazonaws.ec2#CopySnapshotRequestPSU", - "traits": { - "aws.protocols#ec2QueryName": "PresignedUrl", - "smithy.api#documentation": "

When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a\n pre-signed URL. This parameter is optional for unencrypted snapshots. For more information,\n see Query\n requests.

\n

The PresignedUrl should use the snapshot source endpoint, the\n CopySnapshot action, and include the SourceRegion,\n SourceSnapshotId, and DestinationRegion parameters. The\n PresignedUrl must be signed using Amazon Web Services Signature Version 4. Because EBS\n snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic\n that is described in Authenticating Requests: Using Query\n Parameters (Amazon Web Services Signature Version 4) in the Amazon Simple Storage Service API Reference. An\n invalid or improperly signed PresignedUrl will cause the copy operation to fail\n asynchronously, and the snapshot will move to an error state.

", - "smithy.api#xmlName": "presignedUrl" - } - }, - "SourceRegion": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Region that contains the snapshot to be copied.

", - "smithy.api#required": {} - } - }, - "SourceSnapshotId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the EBS snapshot to copy.

", - "smithy.api#required": {} - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the new snapshot.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CopySnapshotRequestPSU": { - "type": "string", - "traits": { - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.ec2#CopySnapshotResult": { - "type": "structure", - "members": { - "SnapshotId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SnapshotId", - "smithy.api#documentation": "

The ID of the new snapshot.

", - "smithy.api#xmlName": "snapshotId" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags applied to the new snapshot.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CopyTagsFromSource": { - "type": "enum", - "members": { - "volume": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "volume" - } - } - } - }, - "com.amazonaws.ec2#CoreCount": { - "type": "integer" - }, - "com.amazonaws.ec2#CoreCountList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#CoreCount", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#CoreNetworkArn": { - "type": "string" - }, - "com.amazonaws.ec2#CpuManufacturer": { - "type": "enum", - "members": { - "INTEL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "intel" - } - }, - "AMD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "amd" - } - }, - "AMAZON_WEB_SERVICES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "amazon-web-services" - } - } - } - }, - "com.amazonaws.ec2#CpuManufacturerSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#CpuManufacturer", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#CpuOptions": { - "type": "structure", - "members": { - "CoreCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "CoreCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of CPU cores for the instance.

", - "smithy.api#xmlName": "coreCount" - } - }, - "ThreadsPerCore": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "ThreadsPerCore", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of threads per CPU core.

", - "smithy.api#xmlName": "threadsPerCore" - } - }, - "AmdSevSnp": { - "target": "com.amazonaws.ec2#AmdSevSnpSpecification", - "traits": { - "aws.protocols#ec2QueryName": "AmdSevSnp", - "smithy.api#documentation": "

Indicates whether the instance is enabled for AMD SEV-SNP.

", - "smithy.api#xmlName": "amdSevSnp" - } - } - }, - "traits": { - "smithy.api#documentation": "

The CPU options for the instance.

" - } - }, - "com.amazonaws.ec2#CpuOptionsRequest": { - "type": "structure", - "members": { - "CoreCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of CPU cores for the instance.

" - } - }, - "ThreadsPerCore": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of threads per CPU core. To disable multithreading for the instance,\n specify a value of 1. Otherwise, specify the default value of\n 2.

" - } - }, - "AmdSevSnp": { - "target": "com.amazonaws.ec2#AmdSevSnpSpecification", - "traits": { - "smithy.api#documentation": "

Indicates whether to enable the instance for AMD SEV-SNP. AMD SEV-SNP is supported \n with M6a, R6a, and C6a instance types only.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The CPU options for the instance. Both the core count and threads per core must be\n specified in the request.

" - } - }, - "com.amazonaws.ec2#CreateCapacityReservation": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateCapacityReservationRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateCapacityReservationResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a new Capacity Reservation with the specified attributes.

\n

Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration. This \n\t\t\tgives you the flexibility to selectively add capacity reservations and still get the Regional RI discounts for that usage. \n\t\t\tBy 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. \n\t\t\tFor more information, see Capacity Reservations in the Amazon EC2 User Guide.

\n

Your request to create a Capacity Reservation could fail if Amazon EC2 does not have sufficient capacity to\n\t\t\tfulfill the request. If your request fails due to Amazon EC2 capacity constraints, either try\n\t\t\tagain at a later time, try in a different Availability Zone, or request a smaller\n\t\t\tcapacity reservation. If your application is flexible across instance types and sizes,\n\t\t\ttry to create a Capacity Reservation with different instance attributes.

\n

Your request could also fail if the requested quantity exceeds your On-Demand Instance\n\t\t\tlimit for the selected instance type. If your request fails due to limit constraints,\n\t\t\tincrease your On-Demand Instance limit for the required instance type and try again. For\n\t\t\tmore information about increasing your instance limits, see Amazon EC2 Service\n\t\t\t\tQuotas in the Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#CreateCapacityReservationFleet": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateCapacityReservationFleetRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateCapacityReservationFleetResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a Capacity Reservation Fleet. For more information, see Create a Capacity \n\t\t\tReservation Fleet in the Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#CreateCapacityReservationFleetRequest": { - "type": "structure", - "members": { - "AllocationStrategy": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The strategy used by the Capacity Reservation Fleet to determine which of the \n\t\t\tspecified instance types to use. Currently, only the prioritized \n\t\t\tallocation strategy is supported. For more information, see \n\t\t\t\tAllocation strategy in the Amazon EC2 User Guide.

\n

Valid values: prioritized\n

" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

", - "smithy.api#idempotencyToken": {} - } - }, - "InstanceTypeSpecifications": { - "target": "com.amazonaws.ec2#ReservationFleetInstanceSpecificationList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Information about the instance types for which to reserve the capacity.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "InstanceTypeSpecification" - } - }, - "Tenancy": { - "target": "com.amazonaws.ec2#FleetCapacityReservationTenancy", - "traits": { - "smithy.api#documentation": "

Indicates the tenancy of the Capacity Reservation Fleet. All Capacity Reservations \n\t\t\tin the Fleet inherit this tenancy. The Capacity Reservation Fleet can have one of \n\t\t\tthe following tenancy settings:

\n " - } - }, - "TotalTargetCapacity": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The total number of capacity units to be reserved by the Capacity Reservation Fleet. This \n\t\t\tvalue, together with the instance type weights that you assign to each instance type used by \n\t\t\tthe Fleet determine the number of instances for which the Fleet reserves capacity. Both values \n\t\t\tare based on units that make sense for your workload. For more information, see \n\t\t\t\tTotal target capacity in the Amazon EC2 User Guide.

", - "smithy.api#required": {} - } - }, - "EndDate": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "smithy.api#documentation": "

The date and time at which the Capacity Reservation Fleet expires. When the Capacity \n\t\t\tReservation Fleet expires, its state changes to expired and all of the Capacity \n\t\t\tReservations in the Fleet expire.

\n

The Capacity Reservation Fleet expires within an hour after the specified time. For example, \n\t\t\tif you specify 5/31/2019, 13:30:55, the Capacity Reservation Fleet \n\t\t\tis guaranteed to expire between 13:30:55 and 14:30:55 on \n\t\t\t5/31/2019.\n\t\t

" - } - }, - "InstanceMatchCriteria": { - "target": "com.amazonaws.ec2#FleetInstanceMatchCriteria", - "traits": { - "smithy.api#documentation": "

Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All \n\t\t\tCapacity Reservations in the Fleet inherit this instance matching criteria.

\n

Currently, Capacity Reservation Fleets support open instance matching criteria \n\t\t\tonly. This means that instances that have matching attributes (instance type, platform, and \n\t\t\tAvailability Zone) run in the Capacity Reservations automatically. Instances do not need to \n\t\t\texplicitly target a Capacity Reservation Fleet to use its reserved capacity.

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to assign to the Capacity Reservation Fleet. The tags are automatically assigned \n\t\t\tto the Capacity Reservations in the Fleet.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateCapacityReservationFleetResult": { - "type": "structure", - "members": { - "CapacityReservationFleetId": { - "target": "com.amazonaws.ec2#CapacityReservationFleetId", - "traits": { - "aws.protocols#ec2QueryName": "CapacityReservationFleetId", - "smithy.api#documentation": "

The ID of the Capacity Reservation Fleet.

", - "smithy.api#xmlName": "capacityReservationFleetId" - } - }, - "State": { - "target": "com.amazonaws.ec2#CapacityReservationFleetState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The status of the Capacity Reservation Fleet.

", - "smithy.api#xmlName": "state" - } - }, - "TotalTargetCapacity": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "TotalTargetCapacity", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The total number of capacity units for which the Capacity Reservation Fleet reserves capacity.

", - "smithy.api#xmlName": "totalTargetCapacity" - } - }, - "TotalFulfilledCapacity": { - "target": "com.amazonaws.ec2#Double", - "traits": { - "aws.protocols#ec2QueryName": "TotalFulfilledCapacity", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The requested capacity units that have been successfully reserved.

", - "smithy.api#xmlName": "totalFulfilledCapacity" - } - }, - "InstanceMatchCriteria": { - "target": "com.amazonaws.ec2#FleetInstanceMatchCriteria", - "traits": { - "aws.protocols#ec2QueryName": "InstanceMatchCriteria", - "smithy.api#documentation": "

The instance matching criteria for the Capacity Reservation Fleet.

", - "smithy.api#xmlName": "instanceMatchCriteria" - } - }, - "AllocationStrategy": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AllocationStrategy", - "smithy.api#documentation": "

The allocation strategy used by the Capacity Reservation Fleet.

", - "smithy.api#xmlName": "allocationStrategy" - } - }, - "CreateTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "CreateTime", - "smithy.api#documentation": "

The date and time at which the Capacity Reservation Fleet was created.

", - "smithy.api#xmlName": "createTime" - } - }, - "EndDate": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "EndDate", - "smithy.api#documentation": "

The date and time at which the Capacity Reservation Fleet expires.

", - "smithy.api#xmlName": "endDate" - } - }, - "Tenancy": { - "target": "com.amazonaws.ec2#FleetCapacityReservationTenancy", - "traits": { - "aws.protocols#ec2QueryName": "Tenancy", - "smithy.api#documentation": "

Indicates the tenancy of Capacity Reservation Fleet.

", - "smithy.api#xmlName": "tenancy" - } - }, - "FleetCapacityReservations": { - "target": "com.amazonaws.ec2#FleetCapacityReservationSet", - "traits": { - "aws.protocols#ec2QueryName": "FleetCapacityReservationSet", - "smithy.api#documentation": "

Information about the individual Capacity Reservations in the Capacity Reservation Fleet.

", - "smithy.api#xmlName": "fleetCapacityReservationSet" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags assigned to the Capacity Reservation Fleet.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateCapacityReservationRequest": { - "type": "structure", - "members": { - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

" - } - }, - "InstanceType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The instance type for which to reserve capacity. For more information, see Instance types in the Amazon EC2 User Guide.

", - "smithy.api#required": {} - } - }, - "InstancePlatform": { - "target": "com.amazonaws.ec2#CapacityReservationInstancePlatform", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The type of operating system for which to reserve capacity.

", - "smithy.api#required": {} - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The Availability Zone in which to create the Capacity Reservation.

" - } - }, - "AvailabilityZoneId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The ID of the Availability Zone in which to create the Capacity Reservation.

" - } - }, - "Tenancy": { - "target": "com.amazonaws.ec2#CapacityReservationTenancy", - "traits": { - "smithy.api#documentation": "

Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

\n " - } - }, - "InstanceCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of instances for which to reserve capacity.

\n

Valid range: 1 - 1000

", - "smithy.api#required": {} - } - }, - "EbsOptimized": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides\n\t\t\tdedicated throughput to Amazon EBS and an optimized configuration stack to provide\n\t\t\toptimal I/O performance. This optimization isn't available with all instance types.\n\t\t\tAdditional usage charges apply when using an EBS- optimized instance.

" - } - }, - "EphemeralStorage": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

\n Deprecated.\n

" - } - }, - "EndDate": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "smithy.api#documentation": "

The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity\n\t\t\tis released and you can no longer launch instances into it. The Capacity Reservation's state changes to\n\t\t\t\texpired when it reaches its end date and time.

\n

You must provide an EndDate value if EndDateType is\n\t\t\t\tlimited. Omit EndDate if EndDateType is\n\t\t\t\tunlimited.

\n

If the EndDateType is limited, the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify \n\t\t\t5/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": { - "target": "com.amazonaws.ec2#EndDateType", - "traits": { - "smithy.api#documentation": "

Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end\n\t\t\ttypes:

\n " - } - }, - "InstanceMatchCriteria": { - "target": "com.amazonaws.ec2#InstanceMatchCriteria", - "traits": { - "smithy.api#documentation": "

Indicates the type of instance launches that the Capacity Reservation accepts. The options\n\t\t\tinclude:

\n \n

Default: open\n

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the Capacity Reservation during launch.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - }, - "OutpostArn": { - "target": "com.amazonaws.ec2#OutpostArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.

" - } - }, - "PlacementGroupArn": { - "target": "com.amazonaws.ec2#PlacementGroupArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster placement group in which \n\t\t\tto create the Capacity Reservation. For more information, see \n\t\t\t\n\t\t\t\tCapacity Reservations for cluster placement groups in the \n\t\t\tAmazon EC2 User Guide.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateCapacityReservationResult": { - "type": "structure", - "members": { - "CapacityReservation": { - "target": "com.amazonaws.ec2#CapacityReservation", - "traits": { - "aws.protocols#ec2QueryName": "CapacityReservation", - "smithy.api#documentation": "

Information about the Capacity Reservation.

", - "smithy.api#xmlName": "capacityReservation" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateCarrierGateway": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateCarrierGatewayRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateCarrierGatewayResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a carrier gateway. For more information about carrier gateways, see Carrier gateways in the Amazon Web Services Wavelength Developer Guide.

" - } - }, - "com.amazonaws.ec2#CreateCarrierGatewayRequest": { - "type": "structure", - "members": { - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the VPC to associate with the carrier gateway.

", - "smithy.api#required": {} - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to associate with the carrier gateway.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateCarrierGatewayResult": { - "type": "structure", - "members": { - "CarrierGateway": { - "target": "com.amazonaws.ec2#CarrierGateway", - "traits": { - "aws.protocols#ec2QueryName": "CarrierGateway", - "smithy.api#documentation": "

Information about the carrier gateway.

", - "smithy.api#xmlName": "carrierGateway" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateClientVpnEndpoint": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateClientVpnEndpointRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateClientVpnEndpointResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to \n\t\t\tenable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions \n\t\t\tare terminated.

" - } - }, - "com.amazonaws.ec2#CreateClientVpnEndpointRequest": { - "type": "structure", - "members": { - "ClientCidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#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. Client CIDR range must have a size of at least /22 and must not be greater than /12.

", - "smithy.api#required": {} - } - }, - "ServerCertificateArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ARN of the server certificate. For more information, see \n\t\t\tthe Certificate Manager User Guide.

", - "smithy.api#required": {} - } - }, - "AuthenticationOptions": { - "target": "com.amazonaws.ec2#ClientVpnAuthenticationRequestList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Information about the authentication method to be used to authenticate clients.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "Authentication" - } - }, - "ConnectionLogOptions": { - "target": "com.amazonaws.ec2#ConnectionLogOptions", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Information about the client connection logging options.

\n

If you enable client connection logging, data about client connections is sent to a\n\t\t\tCloudwatch Logs log stream. The following information is logged:

\n ", - "smithy.api#required": {} - } - }, - "DnsServers": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#documentation": "

Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can\n\t\t\thave 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": { - "target": "com.amazonaws.ec2#TransportProtocol", - "traits": { - "smithy.api#documentation": "

The transport protocol to be used by the VPN session.

\n

Default value: udp\n

" - } - }, - "VpnPort": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

\n

Valid Values: 443 | 1194\n

\n

Default Value: 443\n

" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A brief description of the Client VPN endpoint.

" - } - }, - "SplitTunnel": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether split-tunnel is enabled on the Client VPN endpoint.

\n

By default, split-tunnel on a VPN endpoint is disabled.

\n

For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the \n\t\t\tClient VPN Administrator Guide.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without 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": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

", - "smithy.api#idempotencyToken": {} - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the Client VPN endpoint during creation.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.ec2#ClientVpnSecurityGroupIdSet", - "traits": { - "smithy.api#documentation": "

The IDs of one or more security groups to apply to the target network. You must also specify the ID of the VPC that contains the security groups.

", - "smithy.api#xmlName": "SecurityGroupId" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", - "traits": { - "smithy.api#documentation": "

The ID of the VPC to associate with the Client VPN endpoint. If no security group IDs are specified in the request, the default security group for the VPC is applied.

" - } - }, - "SelfServicePortal": { - "target": "com.amazonaws.ec2#SelfServicePortal", - "traits": { - "smithy.api#documentation": "

Specify whether to enable the self-service portal for the Client VPN endpoint.

\n

Default Value: enabled\n

" - } - }, - "ClientConnectOptions": { - "target": "com.amazonaws.ec2#ClientConnectOptions", - "traits": { - "smithy.api#documentation": "

The options for managing connection authorization for new client connections.

" - } - }, - "SessionTimeoutHours": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum VPN session duration time in hours.

\n

Valid values: 8 | 10 | 12 | 24\n

\n

Default value: 24\n

" - } - }, - "ClientLoginBannerOptions": { - "target": "com.amazonaws.ec2#ClientLoginBannerOptions", - "traits": { - "smithy.api#documentation": "

Options for enabling a customizable text banner that will be displayed on\n\t\t\tAmazon Web Services provided clients when a VPN session is established.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateClientVpnEndpointResult": { - "type": "structure", - "members": { - "ClientVpnEndpointId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientVpnEndpointId", - "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", - "smithy.api#xmlName": "clientVpnEndpointId" - } - }, - "Status": { - "target": "com.amazonaws.ec2#ClientVpnEndpointStatus", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The current state of the Client VPN endpoint.

", - "smithy.api#xmlName": "status" - } - }, - "DnsName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DnsName", - "smithy.api#documentation": "

The DNS name to be used by clients when establishing their VPN session.

", - "smithy.api#xmlName": "dnsName" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateClientVpnRoute": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateClientVpnRouteRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateClientVpnRouteResult" - }, - "traits": { - "smithy.api#documentation": "

Adds a route to a network to a Client VPN endpoint. Each Client VPN endpoint has a route table that describes the \n\t\t\tavailable destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks.

" - } - }, - "com.amazonaws.ec2#CreateClientVpnRouteRequest": { - "type": "structure", - "members": { - "ClientVpnEndpointId": { - "target": "com.amazonaws.ec2#ClientVpnEndpointId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Client VPN endpoint to which to add the route.

", - "smithy.api#required": {} - } - }, - "DestinationCidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, of the route destination. For example:

\n ", - "smithy.api#required": {} - } - }, - "TargetVpcSubnetId": { - "target": "com.amazonaws.ec2#SubnetId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the subnet through which you want to route traffic. The specified subnet must be\n\t\t\tan existing target network of the Client VPN endpoint.

\n

Alternatively, if you're adding a route for the local network, specify local.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A brief description of the route.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

", - "smithy.api#idempotencyToken": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateClientVpnRouteResult": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.ec2#ClientVpnRouteStatus", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The current state of the route.

", - "smithy.api#xmlName": "status" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateCoipCidr": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateCoipCidrRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateCoipCidrResult" - }, - "traits": { - "smithy.api#documentation": "

\n Creates a range of customer-owned IP addresses.\n

" - } - }, - "com.amazonaws.ec2#CreateCoipCidrRequest": { - "type": "structure", - "members": { - "Cidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

\n A customer-owned IP address range to create.\n

", - "smithy.api#required": {} - } - }, - "CoipPoolId": { - "target": "com.amazonaws.ec2#Ipv4PoolCoipId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

\n The ID of the address pool.\n

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateCoipCidrResult": { - "type": "structure", - "members": { - "CoipCidr": { - "target": "com.amazonaws.ec2#CoipCidr", - "traits": { - "aws.protocols#ec2QueryName": "CoipCidr", - "smithy.api#documentation": "

\n Information about a range of customer-owned IP addresses.\n

", - "smithy.api#xmlName": "coipCidr" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateCoipPool": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateCoipPoolRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateCoipPoolResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a pool of customer-owned IP (CoIP) addresses.

" - } - }, - "com.amazonaws.ec2#CreateCoipPoolRequest": { - "type": "structure", - "members": { - "LocalGatewayRouteTableId": { - "target": "com.amazonaws.ec2#LocalGatewayRoutetableId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

\n The ID of the local gateway route table.\n

", - "smithy.api#required": {} - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

\n The tags to assign to the CoIP address pool.\n

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateCoipPoolResult": { - "type": "structure", - "members": { - "CoipPool": { - "target": "com.amazonaws.ec2#CoipPool", - "traits": { - "aws.protocols#ec2QueryName": "CoipPool", - "smithy.api#documentation": "

Information about the CoIP address pool.

", - "smithy.api#xmlName": "coipPool" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateCustomerGateway": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateCustomerGatewayRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateCustomerGatewayResult" - }, - "traits": { - "smithy.api#documentation": "

Provides information to Amazon Web Services about your customer gateway device. The\n customer gateway device is the appliance at your end of the VPN connection. You\n must provide the IP address of the customer gateway device’s external\n interface. The IP address must be static and can be behind a device performing network\n address translation (NAT).

\n

For devices that use Border Gateway Protocol (BGP), you can also provide the device's\n BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network.\n If you don't have an ASN already, you can use a private ASN. For more information, see \n Customer gateway \n options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.

\n

To create more than one customer gateway with the same VPN type, IP address, and\n BGP ASN, specify a unique device name for each customer gateway. An identical request\n returns information about the existing customer gateway; it doesn't create a new customer\n gateway.

" - } - }, - "com.amazonaws.ec2#CreateCustomerGatewayRequest": { - "type": "structure", - "members": { - "BgpAsn": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

For devices that support BGP, the customer gateway's BGP ASN.

\n

Default: 65000

" - } - }, - "PublicIp": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

\n This member has been deprecated. The Internet-routable IP address for the customer gateway's outside interface. The\n address must be static.

" - } - }, - "CertificateArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the customer gateway certificate.

" - } - }, - "Type": { - "target": "com.amazonaws.ec2#GatewayType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The type of VPN connection that this customer gateway supports\n (ipsec.1).

", - "smithy.api#required": {} - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the customer gateway.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "DeviceName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A name for the customer gateway device.

\n

Length Constraints: Up to 255 characters.

" - } - }, - "IpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

\n IPv4 address for the customer gateway device's outside interface. The address must be static.\n

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for CreateCustomerGateway.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateCustomerGatewayResult": { - "type": "structure", - "members": { - "CustomerGateway": { - "target": "com.amazonaws.ec2#CustomerGateway", - "traits": { - "aws.protocols#ec2QueryName": "CustomerGateway", - "smithy.api#documentation": "

Information about the customer gateway.

", - "smithy.api#xmlName": "customerGateway" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of CreateCustomerGateway.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateDefaultSubnet": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateDefaultSubnetRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateDefaultSubnetResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a default subnet with a size /20 IPv4 CIDR block in the\n specified Availability Zone in your default VPC. You can have only one default subnet\n per Availability Zone. For more information, see Creating a default\n subnet in the Amazon Virtual Private Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#CreateDefaultSubnetRequest": { - "type": "structure", - "members": { - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Availability Zone in which to create the default subnet.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "Ipv6Native": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to create an IPv6 only subnet. If you already have a default subnet\n for this Availability Zone, you must delete it before you can create an IPv6 only subnet.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateDefaultSubnetResult": { - "type": "structure", - "members": { - "Subnet": { - "target": "com.amazonaws.ec2#Subnet", - "traits": { - "aws.protocols#ec2QueryName": "Subnet", - "smithy.api#documentation": "

Information about the subnet.

", - "smithy.api#xmlName": "subnet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateDefaultVpc": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateDefaultVpcRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateDefaultVpcResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a default VPC with a size /16 IPv4 CIDR block and a default subnet\n\t\t\tin each Availability Zone. For more information about the components of a default VPC,\n\t\t\tsee Default VPC and\n\t\t\tdefault subnets in the Amazon Virtual Private Cloud User Guide. You cannot\n\t\t\tspecify the components of the default VPC yourself.

\n

If you deleted your previous default VPC, you can create a default VPC. You cannot have\n\t\t\tmore than one default VPC per Region.

\n

If your account supports EC2-Classic, you cannot use this action to create a default VPC\n\t\t\tin a Region that supports EC2-Classic. If you want a default VPC in a Region that\n\t\t\tsupports EC2-Classic, see \"I really want a default VPC for my existing EC2 account. Is\n\t\t\tthat possible?\" in the Default VPCs\n\t\t\tFAQ.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " - } - }, - "com.amazonaws.ec2#CreateDefaultVpcRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateDefaultVpcResult": { - "type": "structure", - "members": { - "Vpc": { - "target": "com.amazonaws.ec2#Vpc", - "traits": { - "aws.protocols#ec2QueryName": "Vpc", - "smithy.api#documentation": "

Information about the VPC.

", - "smithy.api#xmlName": "vpc" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateDhcpOptions": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateDhcpOptionsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateDhcpOptionsResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a set of DHCP options for your VPC. After creating the set, you must\n\t\t\t\tassociate it with the VPC, causing all existing and new instances that you launch in\n\t\t\t\tthe VPC to use this set of DHCP options. The following are the individual DHCP\n\t\t\t\toptions you can specify. For more information about the options, see RFC 2132.

\n \n

Your VPC automatically starts out with a set of DHCP options that includes only a DNS\n\t\t\tserver that we provide (AmazonProvidedDNS). If you create a set of options, and if your\n\t\t\tVPC has an internet gateway, make sure to set the domain-name-servers\n\t\t\toption either to AmazonProvidedDNS or to a domain name server of your\n\t\t\tchoice. For more information, see DHCP options sets in the\n\t\t\tAmazon Virtual Private Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#CreateDhcpOptionsRequest": { - "type": "structure", - "members": { - "DhcpConfigurations": { - "target": "com.amazonaws.ec2#NewDhcpConfigurationList", - "traits": { - "aws.protocols#ec2QueryName": "DhcpConfiguration", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A DHCP configuration option.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "dhcpConfiguration" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to assign to the DHCP option.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateDhcpOptionsResult": { - "type": "structure", - "members": { - "DhcpOptions": { - "target": "com.amazonaws.ec2#DhcpOptions", - "traits": { - "aws.protocols#ec2QueryName": "DhcpOptions", - "smithy.api#documentation": "

A set of DHCP options.

", - "smithy.api#xmlName": "dhcpOptions" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateEgressOnlyInternetGateway": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateEgressOnlyInternetGatewayRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateEgressOnlyInternetGatewayResult" - }, - "traits": { - "smithy.api#documentation": "

[IPv6 only] Creates an egress-only internet gateway for your VPC. An egress-only\n\t\t\tinternet gateway is used to enable outbound communication over IPv6 from instances in\n\t\t\tyour VPC to the internet, and prevents hosts outside of your VPC from initiating an IPv6\n\t\t\tconnection with your instance.

" - } - }, - "com.amazonaws.ec2#CreateEgressOnlyInternetGatewayRequest": { - "type": "structure", - "members": { - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n\t\t\trequest. For more information, see How to ensure\n\t\t\t\tidempotency.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the VPC for which to create the egress-only internet gateway.

", - "smithy.api#required": {} - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to assign to the egress-only internet gateway.

", - "smithy.api#xmlName": "TagSpecification" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateEgressOnlyInternetGatewayResult": { - "type": "structure", - "members": { - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n\t\t\trequest.

", - "smithy.api#xmlName": "clientToken" - } - }, - "EgressOnlyInternetGateway": { - "target": "com.amazonaws.ec2#EgressOnlyInternetGateway", - "traits": { - "aws.protocols#ec2QueryName": "EgressOnlyInternetGateway", - "smithy.api#documentation": "

Information about the egress-only internet gateway.

", - "smithy.api#xmlName": "egressOnlyInternetGateway" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateFleet": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateFleetRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateFleetResult" - }, - "traits": { - "smithy.api#documentation": "

Launches an EC2 Fleet.

\n

You can create a single EC2 Fleet that includes multiple launch specifications that vary by\n instance type, AMI, Availability Zone, or subnet.

\n

For more information, see EC2 Fleet in the Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#CreateFleetError": { - "type": "structure", - "members": { - "LaunchTemplateAndOverrides": { - "target": "com.amazonaws.ec2#LaunchTemplateAndOverridesResponse", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateAndOverrides", - "smithy.api#documentation": "

The launch templates and overrides that were used for launching the instances. The\n values that you specify in the Overrides replace the values in the launch template.

", - "smithy.api#xmlName": "launchTemplateAndOverrides" - } - }, - "Lifecycle": { - "target": "com.amazonaws.ec2#InstanceLifecycle", - "traits": { - "aws.protocols#ec2QueryName": "Lifecycle", - "smithy.api#documentation": "

Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.

", - "smithy.api#xmlName": "lifecycle" - } - }, - "ErrorCode": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ErrorCode", - "smithy.api#documentation": "

The error code that indicates why the instance could not be launched. For more\n information about error codes, see Error codes.

", - "smithy.api#xmlName": "errorCode" - } - }, - "ErrorMessage": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ErrorMessage", - "smithy.api#documentation": "

The error message that describes why the instance could not be launched. For more\n information about error messages, see Error codes.

", - "smithy.api#xmlName": "errorMessage" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the instances that could not be launched by the fleet.

" - } - }, - "com.amazonaws.ec2#CreateFleetErrorsSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#CreateFleetError", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#CreateFleetInstance": { - "type": "structure", - "members": { - "LaunchTemplateAndOverrides": { - "target": "com.amazonaws.ec2#LaunchTemplateAndOverridesResponse", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateAndOverrides", - "smithy.api#documentation": "

The launch templates and overrides that were used for launching the instances. The\n values that you specify in the Overrides replace the values in the launch template.

", - "smithy.api#xmlName": "launchTemplateAndOverrides" - } - }, - "Lifecycle": { - "target": "com.amazonaws.ec2#InstanceLifecycle", - "traits": { - "aws.protocols#ec2QueryName": "Lifecycle", - "smithy.api#documentation": "

Indicates if the instance that was launched is a Spot Instance or On-Demand Instance.

", - "smithy.api#xmlName": "lifecycle" - } - }, - "InstanceIds": { - "target": "com.amazonaws.ec2#InstanceIdsSet", - "traits": { - "aws.protocols#ec2QueryName": "InstanceIds", - "smithy.api#documentation": "

The IDs of the instances.

", - "smithy.api#xmlName": "instanceIds" - } - }, - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type.

", - "smithy.api#xmlName": "instanceType" - } - }, - "Platform": { - "target": "com.amazonaws.ec2#PlatformValues", - "traits": { - "aws.protocols#ec2QueryName": "Platform", - "smithy.api#documentation": "

The value is Windows for Windows instances. Otherwise, the value is\n blank.

", - "smithy.api#xmlName": "platform" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the instances that were launched by the fleet.

" - } - }, - "com.amazonaws.ec2#CreateFleetInstancesSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#CreateFleetInstance", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#CreateFleetRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.

" - } - }, - "SpotOptions": { - "target": "com.amazonaws.ec2#SpotOptionsRequest", - "traits": { - "smithy.api#documentation": "

Describes the configuration of Spot Instances in an EC2 Fleet.

" - } - }, - "OnDemandOptions": { - "target": "com.amazonaws.ec2#OnDemandOptionsRequest", - "traits": { - "smithy.api#documentation": "

Describes the configuration of On-Demand Instances in an EC2 Fleet.

" - } - }, - "ExcessCapacityTerminationPolicy": { - "target": "com.amazonaws.ec2#FleetExcessCapacityTerminationPolicy", - "traits": { - "smithy.api#documentation": "

Indicates whether running instances should be terminated if the total target capacity of\n the EC2 Fleet is decreased below the current size of the EC2 Fleet.

\n

Supported only for fleets of type maintain.

" - } - }, - "LaunchTemplateConfigs": { - "target": "com.amazonaws.ec2#FleetLaunchTemplateConfigListRequest", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The configuration for the EC2 Fleet.

", - "smithy.api#required": {} - } - }, - "TargetCapacitySpecification": { - "target": "com.amazonaws.ec2#TargetCapacitySpecificationRequest", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The number of units to request.

", - "smithy.api#required": {} - } - }, - "TerminateInstancesWithExpiration": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether running instances should be terminated when the EC2 Fleet expires.

" - } - }, - "Type": { - "target": "com.amazonaws.ec2#FleetType", - "traits": { - "smithy.api#documentation": "

The fleet type. The default value is maintain.

\n \n

For more information, see EC2 Fleet\n request types in the Amazon EC2 User Guide.

" - } - }, - "ValidFrom": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "smithy.api#documentation": "

The start date and time of the request, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).\n The default is to start fulfilling the request immediately.

" - } - }, - "ValidUntil": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "smithy.api#documentation": "

The end date and time of the request, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).\n 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": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for\n fleets of type maintain. For more information, see EC2 Fleet\n health checks in the Amazon EC2 User Guide.

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The key-value pair for tagging the EC2 Fleet request on creation. For more information, see \n Tagging your resources.

\n

If the fleet type is instant, specify a resource type of fleet \n to tag the fleet or instance to tag the instances at launch.

\n

If the fleet type is maintain or request, specify a resource\n type of fleet to tag the fleet. You cannot specify a resource type of\n instance. To tag instances at launch, specify the tags in a launch template.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "Context": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Reserved.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateFleetResult": { - "type": "structure", - "members": { - "FleetId": { - "target": "com.amazonaws.ec2#FleetId", - "traits": { - "aws.protocols#ec2QueryName": "FleetId", - "smithy.api#documentation": "

The ID of the EC2 Fleet.

", - "smithy.api#xmlName": "fleetId" - } - }, - "Errors": { - "target": "com.amazonaws.ec2#CreateFleetErrorsSet", - "traits": { - "aws.protocols#ec2QueryName": "ErrorSet", - "smithy.api#documentation": "

Information about the instances that could not be launched by the fleet. Supported only for\n fleets of type instant.

", - "smithy.api#xmlName": "errorSet" - } - }, - "Instances": { - "target": "com.amazonaws.ec2#CreateFleetInstancesSet", - "traits": { - "aws.protocols#ec2QueryName": "FleetInstanceSet", - "smithy.api#documentation": "

Information about the instances that were launched by the fleet. Supported only for\n fleets of type instant.

", - "smithy.api#xmlName": "fleetInstanceSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateFlowLogs": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateFlowLogsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateFlowLogsResult" - }, - "traits": { - "smithy.api#documentation": "

Creates one or more flow logs to capture information about IP traffic for a specific network interface,\n subnet, or VPC.

\n

Flow log data for a monitored network interface is recorded as flow log records, which are log events \n consisting of fields that describe the traffic flow. For more information, see \n Flow log records \n in the Amazon Virtual Private Cloud User Guide.

\n

When publishing to CloudWatch Logs, flow log records are published to a log group, and each network \n interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all \n of the monitored network interfaces are published to a single log file object that is stored in the specified \n bucket.

\n

For more information, see VPC Flow Logs in the Amazon Virtual Private Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#CreateFlowLogsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

" - } - }, - "DeliverLogsPermissionArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The ARN of the IAM role that allows Amazon EC2 to publish flow logs to a CloudWatch Logs log group in\n your account.

\n

This parameter is required if the destination type is cloud-watch-logs\n and unsupported otherwise.

" - } - }, - "DeliverCrossAccountRole": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts.

" - } - }, - "LogGroupName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.

\n

This parameter is valid only if the destination type is cloud-watch-logs.

" - } - }, - "ResourceIds": { - "target": "com.amazonaws.ec2#FlowLogResourceIds", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IDs of the resources to monitor. For example, if the resource type is\n VPC, specify the IDs of the VPCs.

\n

Constraints: Maximum of 25 for transit gateway resource types. Maximum of 1000 for the\n other resource types.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "ResourceId" - } - }, - "ResourceType": { - "target": "com.amazonaws.ec2#FlowLogsResourceType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The type of resource to monitor.

", - "smithy.api#required": {} - } - }, - "TrafficType": { - "target": "com.amazonaws.ec2#TrafficType", - "traits": { - "smithy.api#documentation": "

The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic).\n This parameter is not supported for transit gateway resource types. It is required for\n the other resource types.

" - } - }, - "LogDestinationType": { - "target": "com.amazonaws.ec2#LogDestinationType", - "traits": { - "smithy.api#documentation": "

The type of destination for the flow log data.

\n

Default: cloud-watch-logs\n

" - } - }, - "LogDestination": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The destination for the flow log data. The meaning of this parameter depends on the destination type.

\n " - } - }, - "LogFormat": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The fields to include in the flow log record. List the fields in the order in which\n they should appear. If you omit this parameter, the flow log is created using the\n default format. If you specify this parameter, you must include at least one\n field. For more information about the available fields, see Flow log\n records in the Amazon VPC User Guide or Transit Gateway Flow Log\n records in the Amazon Web Services Transit Gateway Guide.

\n

Specify the fields using the ${field-id} format, separated by spaces. For\n the CLI, surround this parameter value with single quotes on Linux or\n double quotes on Windows.

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the flow logs.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "MaxAggregationInterval": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. \n The possible values are 60 seconds (1 minute) or 600 seconds (10 minutes).\n This parameter must be 60 seconds for transit gateway resource types.

\n

When a network interface is attached to a Nitro-based\n instance, the aggregation interval is always 60 seconds or less, regardless\n of the value that you specify.

\n

Default: 600

" - } - }, - "DestinationOptions": { - "target": "com.amazonaws.ec2#DestinationOptionsRequest", - "traits": { - "smithy.api#documentation": "

The destination options.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateFlowLogsResult": { - "type": "structure", - "members": { - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", - "smithy.api#xmlName": "clientToken" - } - }, - "FlowLogIds": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "FlowLogIdSet", - "smithy.api#documentation": "

The IDs of the flow logs.

", - "smithy.api#xmlName": "flowLogIdSet" - } - }, - "Unsuccessful": { - "target": "com.amazonaws.ec2#UnsuccessfulItemSet", - "traits": { - "aws.protocols#ec2QueryName": "Unsuccessful", - "smithy.api#documentation": "

Information about the flow logs that could not be created successfully.

", - "smithy.api#xmlName": "unsuccessful" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateFpgaImage": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateFpgaImageRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateFpgaImageResult" - }, - "traits": { - "smithy.api#documentation": "

Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).

\n

The create operation is asynchronous. To verify that the AFI is ready for use, \n check the output logs.

\n

An AFI contains the FPGA bitstream that is ready to download to an FPGA. \n You can securely deploy an AFI on multiple FPGA-accelerated instances.\n For more information, see the Amazon Web Services FPGA Hardware Development Kit.

" - } - }, - "com.amazonaws.ec2#CreateFpgaImageRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "InputStorageLocation": { - "target": "com.amazonaws.ec2#StorageLocation", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The location of the encrypted design checkpoint in Amazon S3. The input must be a tarball.

", - "smithy.api#required": {} - } - }, - "LogsStorageLocation": { - "target": "com.amazonaws.ec2#StorageLocation", - "traits": { - "smithy.api#documentation": "

The location in Amazon S3 for the output logs.

" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A description for the AFI.

" - } - }, - "Name": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A name for the AFI.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. \n For more information, see Ensuring Idempotency.

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the FPGA image during creation.

", - "smithy.api#xmlName": "TagSpecification" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateFpgaImageResult": { - "type": "structure", - "members": { - "FpgaImageId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "FpgaImageId", - "smithy.api#documentation": "

The FPGA image identifier (AFI ID).

", - "smithy.api#xmlName": "fpgaImageId" - } - }, - "FpgaImageGlobalId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "FpgaImageGlobalId", - "smithy.api#documentation": "

The global FPGA image identifier (AGFI ID).

", - "smithy.api#xmlName": "fpgaImageGlobalId" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateImage": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateImageRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateImageResult" - }, - "traits": { - "smithy.api#documentation": "

Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance \n \tthat is either running or stopped.

\n

By default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can \n\t\t\t\t\ttake snapshots of the attached volumes while data is at rest, in order to ensure a consistent \n\t\t\t\t\tstate. You can set the NoReboot parameter to true in the API request, \n\t\t\t\t\tor use the --no-reboot option in the CLI to prevent Amazon EC2 from shutting down and \n\t\t\t\t\trebooting the instance.

\n \n

If you choose to bypass the shutdown and reboot process by setting the NoReboot \n\t\t\t\t\tparameter to true in the API request, or by using the --no-reboot option \n\t\t\t\t\tin the CLI, we can't guarantee the file system integrity of the created image.

\n \n

If you customized your instance with instance store volumes or Amazon EBS volumes in addition to the root device volume, the \n \tnew AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, \n \tthe instance automatically launches with those additional volumes.

\n

For more information, see Create an Amazon EBS-backed Linux\n AMI in the Amazon Elastic Compute Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#CreateImageRequest": { - "type": "structure", - "members": { - "BlockDeviceMappings": { - "target": "com.amazonaws.ec2#BlockDeviceMappingRequestList", - "traits": { - "aws.protocols#ec2QueryName": "BlockDeviceMapping", - "smithy.api#documentation": "

The block device mappings. This parameter cannot be used to modify the encryption \n \t\tstatus of existing volumes or snapshots. To create an AMI with encrypted snapshots, \n \t\tuse the CopyImage action.

", - "smithy.api#xmlName": "blockDeviceMapping" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description for the new image.

", - "smithy.api#xmlName": "description" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "instanceId" - } - }, - "Name": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Name", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A name for the new image.

\n

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", - "smithy.api#required": {}, - "smithy.api#xmlName": "name" - } - }, - "NoReboot": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "NoReboot", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

By default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can \n\t\t\t\t\ttake snapshots of the attached volumes while data is at rest, in order to ensure a consistent \n\t\t\t\t\tstate. You can set the NoReboot parameter to true in the API request, \n\t\t\t\t\tor use the --no-reboot option in the CLI to prevent Amazon EC2 from shutting down and \n\t\t\t\t\trebooting the instance.

\n \n

If you choose to bypass the shutdown and reboot process by setting the NoReboot \n\t\t\t\t\tparameter to true in the API request, or by using the --no-reboot option \n\t\t\t\t\tin the CLI, we can't guarantee the file system integrity of the created image.

\n \n

Default: false (follow standard reboot process)

", - "smithy.api#xmlName": "noReboot" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the\n snapshots, or both.

\n \n

If you specify other values for ResourceType, the request fails.

\n

To tag an AMI or snapshot after it has been created, see CreateTags.

", - "smithy.api#xmlName": "TagSpecification" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateImageResult": { - "type": "structure", - "members": { - "ImageId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ImageId", - "smithy.api#documentation": "

The ID of the new AMI.

", - "smithy.api#xmlName": "imageId" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateInstanceEventWindow": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateInstanceEventWindowRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateInstanceEventWindowResult" - }, - "traits": { - "smithy.api#documentation": "

Creates an event window in which scheduled events for the associated Amazon EC2 instances can\n run.

\n

You can define either a set of time ranges or a cron expression when creating the event\n window, but not both. All event window times are in UTC.

\n

You can create up to 200 event windows per Amazon Web Services Region.

\n

When you create the event window, targets (instance IDs, Dedicated Host IDs, or tags)\n are not yet associated with it. To ensure that the event window can be used, you must\n associate one or more targets with it by using the AssociateInstanceEventWindow API.

\n \n

Event windows are applicable only for scheduled events that stop, reboot, or\n terminate instances.

\n

Event windows are not applicable for:

\n \n \n

For more information, see Define event windows for scheduled\n events in the Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#CreateInstanceEventWindowRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "Name": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The name of the event window.

" - } - }, - "TimeRanges": { - "target": "com.amazonaws.ec2#InstanceEventWindowTimeRangeRequestSet", - "traits": { - "smithy.api#documentation": "

The time range for the event window. If you specify a time range, you can't specify a cron\n expression.

", - "smithy.api#xmlName": "TimeRange" - } - }, - "CronExpression": { - "target": "com.amazonaws.ec2#InstanceEventWindowCronExpression", - "traits": { - "smithy.api#documentation": "

The cron expression for the event window, for example, * 0-4,20-23 * * 1,5. If\n you specify a cron expression, you can't specify a time range.

\n

Constraints:

\n \n

For more information about cron expressions, see cron on the Wikipedia\n website.

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the event window.

", - "smithy.api#xmlName": "TagSpecification" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateInstanceEventWindowResult": { - "type": "structure", - "members": { - "InstanceEventWindow": { - "target": "com.amazonaws.ec2#InstanceEventWindow", - "traits": { - "aws.protocols#ec2QueryName": "InstanceEventWindow", - "smithy.api#documentation": "

Information about the event window.

", - "smithy.api#xmlName": "instanceEventWindow" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateInstanceExportTask": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateInstanceExportTaskRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateInstanceExportTaskResult" - }, - "traits": { - "smithy.api#documentation": "

Exports a running or stopped instance to an Amazon S3 bucket.

\n

For information about the supported operating systems, image formats, and known limitations\n for the types of instances you can export, see Exporting an instance as a VM Using VM Import/Export\n in the VM Import/Export User Guide.

" - } - }, - "com.amazonaws.ec2#CreateInstanceExportTaskRequest": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description for the conversion task or the resource being exported. The maximum length is 255 characters.

", - "smithy.api#xmlName": "description" - } - }, - "ExportToS3Task": { - "target": "com.amazonaws.ec2#ExportToS3TaskSpecification", - "traits": { - "aws.protocols#ec2QueryName": "ExportToS3", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The format and location for an export instance task.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "exportToS3" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "instanceId" - } - }, - "TargetEnvironment": { - "target": "com.amazonaws.ec2#ExportEnvironment", - "traits": { - "aws.protocols#ec2QueryName": "TargetEnvironment", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The target virtualization environment.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "targetEnvironment" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the export instance task during creation.

", - "smithy.api#xmlName": "TagSpecification" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateInstanceExportTaskResult": { - "type": "structure", - "members": { - "ExportTask": { - "target": "com.amazonaws.ec2#ExportTask", - "traits": { - "aws.protocols#ec2QueryName": "ExportTask", - "smithy.api#documentation": "

Information about the export instance task.

", - "smithy.api#xmlName": "exportTask" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateInternetGateway": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateInternetGatewayRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateInternetGatewayResult" - }, - "traits": { - "smithy.api#documentation": "

Creates an internet gateway for use with a VPC. After creating the internet gateway,\n\t\t\tyou attach it to a VPC using AttachInternetGateway.

\n

For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#CreateInternetGatewayRequest": { - "type": "structure", - "members": { - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to assign to the internet gateway.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateInternetGatewayResult": { - "type": "structure", - "members": { - "InternetGateway": { - "target": "com.amazonaws.ec2#InternetGateway", - "traits": { - "aws.protocols#ec2QueryName": "InternetGateway", - "smithy.api#documentation": "

Information about the internet gateway.

", - "smithy.api#xmlName": "internetGateway" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateIpam": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateIpamRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateIpamResult" - }, - "traits": { - "smithy.api#documentation": "

Create an IPAM. Amazon VPC IP Address Manager (IPAM) is a VPC feature that you can use\n to automate your IP address management workflows including assigning, tracking,\n troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts\n throughout your Amazon Web Services Organization.

\n

For more information, see Create an IPAM in the Amazon VPC IPAM User Guide.\n

" - } - }, - "com.amazonaws.ec2#CreateIpamPool": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateIpamPoolRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateIpamPoolResult" - }, - "traits": { - "smithy.api#documentation": "

Create an IP address pool for Amazon VPC IP Address Manager (IPAM). In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.

\n

For more information, see Create a top-level pool in the Amazon VPC IPAM User Guide.\n

" - } - }, - "com.amazonaws.ec2#CreateIpamPoolRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "IpamScopeId": { - "target": "com.amazonaws.ec2#IpamScopeId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the scope in which you would like to create the IPAM pool.

", - "smithy.api#required": {} - } - }, - "Locale": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you do not choose a locale, resources in Regions others than the IPAM's home region cannot use CIDRs from this pool.

\n

Possible values: Any Amazon Web Services Region, such as us-east-1.

" - } - }, - "SourceIpamPoolId": { - "target": "com.amazonaws.ec2#IpamPoolId", - "traits": { - "smithy.api#documentation": "

The ID of the source IPAM pool. Use this option to create a pool within an existing pool. Note that the CIDR you provision for the pool within the source pool must be available in the source pool's CIDR range.

" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A description for the IPAM pool.

" - } - }, - "AddressFamily": { - "target": "com.amazonaws.ec2#AddressFamily", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool.

", - "smithy.api#required": {} - } - }, - "AutoImport": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

If selected, IPAM will continuously look for resources within the CIDR range of this pool \n and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for\n these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import \n a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently \n marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM \n discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.\n

\n

A locale must be set on the pool for this feature to work.

" - } - }, - "PubliclyAdvertisable": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Determines if the pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4.

" - } - }, - "AllocationMinNetmaskLength": { - "target": "com.amazonaws.ec2#IpamNetmaskLength", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be \n less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

" - } - }, - "AllocationMaxNetmaskLength": { - "target": "com.amazonaws.ec2#IpamNetmaskLength", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be \n greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

" - } - }, - "AllocationDefaultNetmaskLength": { - "target": "com.amazonaws.ec2#IpamNetmaskLength", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, \n new allocations will default to 10.0.0.0/16.

" - } - }, - "AllocationResourceTags": { - "target": "com.amazonaws.ec2#RequestIpamResourceTagList", - "traits": { - "smithy.api#documentation": "

Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.

", - "smithy.api#xmlName": "AllocationResourceTag" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

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.\n 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.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

", - "smithy.api#idempotencyToken": {} - } - }, - "AwsService": { - "target": "com.amazonaws.ec2#IpamPoolAwsService", - "traits": { - "smithy.api#documentation": "

Limits which service in Amazon Web Services that the pool can be used in. \"ec2\", for example, allows users to use space for Elastic IP addresses and VPCs.

" - } - }, - "PublicIpSource": { - "target": "com.amazonaws.ec2#IpamPoolPublicIpSource", - "traits": { - "smithy.api#documentation": "

The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is byoip. For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide. \n By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool if PublicIpSource is amazon. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateIpamPoolResult": { - "type": "structure", - "members": { - "IpamPool": { - "target": "com.amazonaws.ec2#IpamPool", - "traits": { - "aws.protocols#ec2QueryName": "IpamPool", - "smithy.api#documentation": "

Information about the IPAM pool created.

", - "smithy.api#xmlName": "ipamPool" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateIpamRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A description for the IPAM.

" - } - }, - "OperatingRegions": { - "target": "com.amazonaws.ec2#AddIpamOperatingRegionSet", - "traits": { - "smithy.api#documentation": "

The operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

\n

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.\n

", - "smithy.api#xmlName": "OperatingRegion" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

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.\n 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.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateIpamResourceDiscovery": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateIpamResourceDiscoveryRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateIpamResourceDiscoveryResult" - }, - "traits": { - "smithy.api#documentation": "

Creates an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

" - } - }, - "com.amazonaws.ec2#CreateIpamResourceDiscoveryRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A description for the IPAM resource discovery.

" - } - }, - "OperatingRegions": { - "target": "com.amazonaws.ec2#AddIpamOperatingRegionSet", - "traits": { - "smithy.api#documentation": "

Operating Regions for the IPAM resource discovery. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

", - "smithy.api#xmlName": "OperatingRegion" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

Tag specifications for the IPAM resource discovery.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A client token for the IPAM resource discovery.

", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateIpamResourceDiscoveryResult": { - "type": "structure", - "members": { - "IpamResourceDiscovery": { - "target": "com.amazonaws.ec2#IpamResourceDiscovery", - "traits": { - "aws.protocols#ec2QueryName": "IpamResourceDiscovery", - "smithy.api#documentation": "

An IPAM resource discovery.

", - "smithy.api#xmlName": "ipamResourceDiscovery" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateIpamResult": { - "type": "structure", - "members": { - "Ipam": { - "target": "com.amazonaws.ec2#Ipam", - "traits": { - "aws.protocols#ec2QueryName": "Ipam", - "smithy.api#documentation": "

Information about the IPAM created.

", - "smithy.api#xmlName": "ipam" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateIpamScope": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateIpamScopeRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateIpamScopeResult" - }, - "traits": { - "smithy.api#documentation": "

Create an IPAM scope. In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.

\n

For more information, see Add a scope in the Amazon VPC IPAM User Guide.

" - } - }, - "com.amazonaws.ec2#CreateIpamScopeRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "IpamId": { - "target": "com.amazonaws.ec2#IpamId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the IPAM for which you're creating this scope.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A description for the scope you're creating.

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

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.\n 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.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateIpamScopeResult": { - "type": "structure", - "members": { - "IpamScope": { - "target": "com.amazonaws.ec2#IpamScope", - "traits": { - "aws.protocols#ec2QueryName": "IpamScope", - "smithy.api#documentation": "

Information about the created scope.

", - "smithy.api#xmlName": "ipamScope" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateKeyPair": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateKeyPairRequest" - }, - "output": { - "target": "com.amazonaws.ec2#KeyPair" - }, - "traits": { - "smithy.api#documentation": "

Creates an ED25519 or 2048-bit RSA key pair with the specified name and in the\n specified PEM or PPK format. Amazon EC2 stores the public key and displays the private\n key for you to save to a file. The private key is returned as an unencrypted PEM encoded\n PKCS#1 private key or an unencrypted PPK formatted private key for use with PuTTY. If a\n key with the specified name already exists, Amazon EC2 returns an error.

\n

The key pair returned to you is available only in the Amazon Web Services Region in which you create it.\n If you prefer, you can create your own key pair using a third-party tool and upload it\n to any Region using ImportKeyPair.

\n

You can have up to 5,000 key pairs per Amazon Web Services Region.

\n

For more information, see Amazon EC2 key pairs in the\n Amazon Elastic Compute Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#CreateKeyPairRequest": { - "type": "structure", - "members": { - "KeyName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A unique name for the key pair.

\n

Constraints: Up to 255 ASCII characters

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "KeyType": { - "target": "com.amazonaws.ec2#KeyType", - "traits": { - "smithy.api#documentation": "

The type of key pair. Note that ED25519 keys are not supported for Windows instances.

\n

Default: rsa\n

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the new key pair.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "KeyFormat": { - "target": "com.amazonaws.ec2#KeyFormat", - "traits": { - "smithy.api#documentation": "

The format of the key pair.

\n

Default: pem\n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateLaunchTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateLaunchTemplateRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateLaunchTemplateResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a launch template.

\n

A launch template contains the parameters to launch an instance. When you launch an\n instance using RunInstances, you can specify a launch template instead\n of providing the launch parameters in the request. For more information, see Launch\n an instance from a launch template in the\n Amazon Elastic Compute Cloud User Guide.

\n

If you want to clone an existing launch template as the basis for creating a new\n launch template, you can use the Amazon EC2 console. The API, SDKs, and CLI do not support\n cloning a template. For more information, see Create a launch template from an existing launch template in the\n Amazon Elastic Compute Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#CreateLaunchTemplateRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.

\n

Constraint: Maximum 128 ASCII characters.

" - } - }, - "LaunchTemplateName": { - "target": "com.amazonaws.ec2#LaunchTemplateName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A name for the launch template.

", - "smithy.api#required": {} - } - }, - "VersionDescription": { - "target": "com.amazonaws.ec2#VersionDescription", - "traits": { - "smithy.api#documentation": "

A description for the first version of the launch template.

" - } - }, - "LaunchTemplateData": { - "target": "com.amazonaws.ec2#RequestLaunchTemplateData", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The information for the launch template.

", - "smithy.api#required": {} - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the launch template on creation. To tag the launch template, the\n resource type must be launch-template.

\n \n

To specify the tags for the resources that are created when an instance is\n launched, you must use the TagSpecifications parameter in the launch\n template data structure.

\n ", - "smithy.api#xmlName": "TagSpecification" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateLaunchTemplateResult": { - "type": "structure", - "members": { - "LaunchTemplate": { - "target": "com.amazonaws.ec2#LaunchTemplate", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplate", - "smithy.api#documentation": "

Information about the launch template.

", - "smithy.api#xmlName": "launchTemplate" - } - }, - "Warning": { - "target": "com.amazonaws.ec2#ValidationWarning", - "traits": { - "aws.protocols#ec2QueryName": "Warning", - "smithy.api#documentation": "

If the launch template contains parameters or parameter combinations that are not\n valid, an error code and an error message are returned for each issue that's\n found.

", - "smithy.api#xmlName": "warning" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateLaunchTemplateVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateLaunchTemplateVersionRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateLaunchTemplateVersionResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a new version of a launch template. You can specify an existing version of\n launch template from which to base the new version.

\n

Launch template versions are numbered in the order in which they are created. You\n cannot specify, change, or replace the numbering of launch template versions.

\n

Launch templates are immutable; after you create a launch template, you can't modify\n it. Instead, you can create a new version of the launch template that includes any\n changes you require.

\n

For more information, see Modify a launch template (manage launch template versions) in the\n Amazon Elastic Compute Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#CreateLaunchTemplateVersionRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.

\n

Constraint: Maximum 128 ASCII characters.

" - } - }, - "LaunchTemplateId": { - "target": "com.amazonaws.ec2#LaunchTemplateId", - "traits": { - "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify either the LaunchTemplateId or the\n LaunchTemplateName, but not both.

" - } - }, - "LaunchTemplateName": { - "target": "com.amazonaws.ec2#LaunchTemplateName", - "traits": { - "smithy.api#documentation": "

The name of the launch template.

\n

You must specify the LaunchTemplateName or the\n LaunchTemplateId, but not both.

" - } - }, - "SourceVersion": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The version number of the launch template version on which to base the new version.\n The new version inherits the same launch parameters as the source version, except for\n parameters that you specify in LaunchTemplateData. Snapshots applied to the\n block device mapping are ignored when creating a new version unless they are explicitly\n included.

" - } - }, - "VersionDescription": { - "target": "com.amazonaws.ec2#VersionDescription", - "traits": { - "smithy.api#documentation": "

A description for the version of the launch template.

" - } - }, - "LaunchTemplateData": { - "target": "com.amazonaws.ec2#RequestLaunchTemplateData", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The information for the launch template.

", - "smithy.api#required": {} - } - }, - "ResolveAlias": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

If true, and if a Systems Manager parameter is specified for ImageId,\n the AMI ID is displayed in the response for imageID. For more information, see Use a Systems \n Manager parameter instead of an AMI ID in the Amazon Elastic Compute Cloud User Guide.

\n

Default: false\n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateLaunchTemplateVersionResult": { - "type": "structure", - "members": { - "LaunchTemplateVersion": { - "target": "com.amazonaws.ec2#LaunchTemplateVersion", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateVersion", - "smithy.api#documentation": "

Information about the launch template version.

", - "smithy.api#xmlName": "launchTemplateVersion" - } - }, - "Warning": { - "target": "com.amazonaws.ec2#ValidationWarning", - "traits": { - "aws.protocols#ec2QueryName": "Warning", - "smithy.api#documentation": "

If the new version of the launch template contains parameters or parameter\n combinations that are not valid, an error code and an error message are returned for\n each issue that's found.

", - "smithy.api#xmlName": "warning" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateLocalGatewayRoute": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateLocalGatewayRouteRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateLocalGatewayRouteResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a static route for the specified local gateway route table. You must specify one of the \n following targets:

\n " - } - }, - "com.amazonaws.ec2#CreateLocalGatewayRouteRequest": { - "type": "structure", - "members": { - "DestinationCidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The CIDR range used for destination matches. Routing decisions are based on \n the most specific match.

" - } - }, - "LocalGatewayRouteTableId": { - "target": "com.amazonaws.ec2#LocalGatewayRoutetableId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the local gateway route table.

", - "smithy.api#required": {} - } - }, - "LocalGatewayVirtualInterfaceGroupId": { - "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupId", - "traits": { - "smithy.api#documentation": "

The ID of the virtual interface group.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#NetworkInterfaceId", - "traits": { - "smithy.api#documentation": "

The ID of the network interface.

" - } - }, - "DestinationPrefixListId": { - "target": "com.amazonaws.ec2#PrefixListResourceId", - "traits": { - "smithy.api#documentation": "

\n The ID of the prefix list. Use a prefix list in place of DestinationCidrBlock. You \n cannot use DestinationPrefixListId and DestinationCidrBlock in the same request.\n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateLocalGatewayRouteResult": { - "type": "structure", - "members": { - "Route": { - "target": "com.amazonaws.ec2#LocalGatewayRoute", - "traits": { - "aws.protocols#ec2QueryName": "Route", - "smithy.api#documentation": "

Information about the route.

", - "smithy.api#xmlName": "route" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateLocalGatewayRouteTable": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateLocalGatewayRouteTableRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateLocalGatewayRouteTableResult" - }, - "traits": { - "smithy.api#documentation": "

\n Creates a local gateway route table. \n

" - } - }, - "com.amazonaws.ec2#CreateLocalGatewayRouteTableRequest": { - "type": "structure", - "members": { - "LocalGatewayId": { - "target": "com.amazonaws.ec2#LocalGatewayId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

\n The ID of the local gateway. \n

", - "smithy.api#required": {} - } - }, - "Mode": { - "target": "com.amazonaws.ec2#LocalGatewayRouteTableMode", - "traits": { - "smithy.api#documentation": "

\n The mode of the local gateway route table.\n

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

\n The tags assigned to the local gateway route table.\n

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateLocalGatewayRouteTableResult": { - "type": "structure", - "members": { - "LocalGatewayRouteTable": { - "target": "com.amazonaws.ec2#LocalGatewayRouteTable", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayRouteTable", - "smithy.api#documentation": "

Information about the local gateway route table.

", - "smithy.api#xmlName": "localGatewayRouteTable" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationResult" - }, - "traits": { - "smithy.api#documentation": "

\n Creates a local gateway route table virtual interface group association. \n

" - } - }, - "com.amazonaws.ec2#CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationRequest": { - "type": "structure", - "members": { - "LocalGatewayRouteTableId": { - "target": "com.amazonaws.ec2#LocalGatewayRoutetableId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

\n The ID of the local gateway route table.\n

", - "smithy.api#required": {} - } - }, - "LocalGatewayVirtualInterfaceGroupId": { - "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

\n The ID of the local gateway route table virtual interface group association.\n

", - "smithy.api#required": {} - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

\n The tags assigned to the local gateway route table virtual interface group association.\n

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationResult": { - "type": "structure", - "members": { - "LocalGatewayRouteTableVirtualInterfaceGroupAssociation": { - "target": "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociation", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayRouteTableVirtualInterfaceGroupAssociation", - "smithy.api#documentation": "

Information about the local gateway route table virtual interface group association.

", - "smithy.api#xmlName": "localGatewayRouteTableVirtualInterfaceGroupAssociation" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateLocalGatewayRouteTableVpcAssociation": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateLocalGatewayRouteTableVpcAssociationRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateLocalGatewayRouteTableVpcAssociationResult" - }, - "traits": { - "smithy.api#documentation": "

Associates the specified VPC with the specified local gateway route table.

" - } - }, - "com.amazonaws.ec2#CreateLocalGatewayRouteTableVpcAssociationRequest": { - "type": "structure", - "members": { - "LocalGatewayRouteTableId": { - "target": "com.amazonaws.ec2#LocalGatewayRoutetableId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the local gateway route table.

", - "smithy.api#required": {} - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#required": {} - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to assign to the local gateway route table VPC association.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateLocalGatewayRouteTableVpcAssociationResult": { - "type": "structure", - "members": { - "LocalGatewayRouteTableVpcAssociation": { - "target": "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociation", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayRouteTableVpcAssociation", - "smithy.api#documentation": "

Information about the association.

", - "smithy.api#xmlName": "localGatewayRouteTableVpcAssociation" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateManagedPrefixList": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateManagedPrefixListRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateManagedPrefixListResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a managed prefix list. You can specify one or more entries for the prefix list. \n Each entry consists of a CIDR block and an optional description.

" - } - }, - "com.amazonaws.ec2#CreateManagedPrefixListRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "PrefixListName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A name for the prefix list.

\n

Constraints: Up to 255 characters in length. The name cannot start with com.amazonaws.

", - "smithy.api#required": {} - } - }, - "Entries": { - "target": "com.amazonaws.ec2#AddPrefixListEntries", - "traits": { - "smithy.api#documentation": "

One or more entries for the prefix list.

", - "smithy.api#xmlName": "Entry" - } - }, - "MaxEntries": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of entries for the prefix list.

", - "smithy.api#required": {} - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the prefix list during creation.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "AddressFamily": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IP address type.

\n

Valid Values: IPv4 | IPv6\n

", - "smithy.api#required": {} - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n Idempotency.

\n

Constraints: Up to 255 UTF-8 characters in length.

", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateManagedPrefixListResult": { - "type": "structure", - "members": { - "PrefixList": { - "target": "com.amazonaws.ec2#ManagedPrefixList", - "traits": { - "aws.protocols#ec2QueryName": "PrefixList", - "smithy.api#documentation": "

Information about the prefix list.

", - "smithy.api#xmlName": "prefixList" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateNatGateway": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateNatGatewayRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateNatGatewayResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a NAT gateway in the specified subnet. This action creates a network interface\n in the specified subnet with a private IP address from the IP address range of the\n subnet. You can create either a public NAT gateway or a private NAT gateway.

\n

With a public NAT gateway, internet-bound traffic from a private subnet can be routed\n to the NAT gateway, so that instances in a private subnet can connect to the internet.

\n

With a private NAT gateway, private communication is routed across VPCs and on-premises\n networks through a transit gateway or virtual private gateway. Common use cases include\n running large workloads behind a small pool of allowlisted IPv4 addresses, preserving\n private IPv4 addresses, and communicating between overlapping networks.

\n

For more information, see NAT gateways in the Amazon Virtual Private Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#CreateNatGatewayRequest": { - "type": "structure", - "members": { - "AllocationId": { - "target": "com.amazonaws.ec2#AllocationId", - "traits": { - "smithy.api#documentation": "

[Public NAT gateways only] The allocation ID of an Elastic IP address to associate \n with the NAT gateway. You cannot specify an Elastic IP address with a private NAT gateway.\n If the Elastic IP address is associated with another resource, you must first disassociate it.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n\t\t\trequest. For more information, see How to ensure\n\t\t\t\tidempotency.

\n

Constraint: Maximum 64 ASCII characters.

", - "smithy.api#idempotencyToken": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#SubnetId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the subnet in which to create the NAT gateway.

", - "smithy.api#required": {} - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to assign to the NAT gateway.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "ConnectivityType": { - "target": "com.amazonaws.ec2#ConnectivityType", - "traits": { - "smithy.api#documentation": "

Indicates whether the NAT gateway supports public or private connectivity. \n The default is public connectivity.

" - } - }, - "PrivateIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.

" - } - }, - "SecondaryAllocationIds": { - "target": "com.amazonaws.ec2#AllocationIdList", - "traits": { - "smithy.api#documentation": "

Secondary EIP allocation IDs. For more information about secondary addresses, see Create a NAT gateway in the Amazon Virtual Private Cloud User Guide.

", - "smithy.api#xmlName": "SecondaryAllocationId" - } - }, - "SecondaryPrivateIpAddresses": { - "target": "com.amazonaws.ec2#IpList", - "traits": { - "smithy.api#documentation": "

Secondary private IPv4 addresses. For more information about secondary addresses, see Create a NAT gateway in the Amazon Virtual Private Cloud User Guide.

", - "smithy.api#xmlName": "SecondaryPrivateIpAddress" - } - }, - "SecondaryPrivateIpAddressCount": { - "target": "com.amazonaws.ec2#PrivateIpAddressCount", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

[Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway. For more information about secondary addresses, see Create a NAT gateway in the Amazon Virtual Private Cloud User Guide.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateNatGatewayResult": { - "type": "structure", - "members": { - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.

", - "smithy.api#xmlName": "clientToken" - } - }, - "NatGateway": { - "target": "com.amazonaws.ec2#NatGateway", - "traits": { - "aws.protocols#ec2QueryName": "NatGateway", - "smithy.api#documentation": "

Information about the NAT gateway.

", - "smithy.api#xmlName": "natGateway" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateNetworkAcl": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateNetworkAclRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateNetworkAclResult" - }, - "traits": { - "smithy.api#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.

\n

For more information, see Network ACLs in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#CreateNetworkAclEntry": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateNetworkAclEntryRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#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 \n\t\t and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated \n\t\t 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 \n\t\t ingress rules and a separate set of egress rules.

\n

We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the \n\t\t other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.

\n

After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.

\n

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#CreateNetworkAclEntryRequest": { - "type": "structure", - "members": { - "CidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CidrBlock", - "smithy.api#documentation": "

The IPv4 network range to allow or deny, in CIDR notation (for example\n\t\t 172.16.0.0/24). We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

", - "smithy.api#xmlName": "cidrBlock" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "Egress": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Egress", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).

", - "smithy.api#required": {}, - "smithy.api#xmlName": "egress" - } - }, - "IcmpTypeCode": { - "target": "com.amazonaws.ec2#IcmpTypeCode", - "traits": { - "smithy.api#documentation": "

ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol \n\t\t 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.

", - "smithy.api#xmlName": "Icmp" - } - }, - "Ipv6CidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6CidrBlock", - "smithy.api#documentation": "

The IPv6 network range to allow or deny, in CIDR notation (for example\n 2001:db8:1234:1a00::/64).

", - "smithy.api#xmlName": "ipv6CidrBlock" - } - }, - "NetworkAclId": { - "target": "com.amazonaws.ec2#NetworkAclId", - "traits": { - "aws.protocols#ec2QueryName": "NetworkAclId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the network ACL.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "networkAclId" - } - }, - "PortRange": { - "target": "com.amazonaws.ec2#PortRange", - "traits": { - "aws.protocols#ec2QueryName": "PortRange", - "smithy.api#documentation": "

TCP or UDP protocols: The range of ports the rule applies to.\n\t\t Required if specifying protocol 6 (TCP) or 17 (UDP).

", - "smithy.api#xmlName": "portRange" - } - }, - "Protocol": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Protocol", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The protocol number. A value of \"-1\" means all protocols. If you specify \"-1\" or a\n \t\t\tprotocol number other than \"6\" (TCP), \"17\" (UDP), or \"1\" (ICMP), traffic on all ports is \n\t\t\tallowed, regardless of any ports or ICMP types or codes that you specify. If you specify \n\t\t\tprotocol \"58\" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and \n\t\t\tcodes allowed, regardless of any that you specify. If you specify protocol \"58\" (ICMPv6) \n\t\t\tand specify an IPv6 CIDR block, you must specify an ICMP type and code.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "protocol" - } - }, - "RuleAction": { - "target": "com.amazonaws.ec2#RuleAction", - "traits": { - "aws.protocols#ec2QueryName": "RuleAction", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Indicates whether to allow or deny the traffic that matches the rule.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "ruleAction" - } - }, - "RuleNumber": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "RuleNumber", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.

\n

Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "ruleNumber" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateNetworkAclRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "vpcId" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to assign to the network ACL.

", - "smithy.api#xmlName": "TagSpecification" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateNetworkAclResult": { - "type": "structure", - "members": { - "NetworkAcl": { - "target": "com.amazonaws.ec2#NetworkAcl", - "traits": { - "aws.protocols#ec2QueryName": "NetworkAcl", - "smithy.api#documentation": "

Information about the network ACL.

", - "smithy.api#xmlName": "networkAcl" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateNetworkInsightsAccessScope": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateNetworkInsightsAccessScopeRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateNetworkInsightsAccessScopeResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a Network Access Scope.

\n

Amazon Web Services Network Access Analyzer enables cloud networking and cloud operations teams \n to verify that their networks on Amazon Web Services conform to their network security and governance \n objectives. For more information, see the Amazon Web Services Network Access Analyzer Guide.

" - } - }, - "com.amazonaws.ec2#CreateNetworkInsightsAccessScopeRequest": { - "type": "structure", - "members": { - "MatchPaths": { - "target": "com.amazonaws.ec2#AccessScopePathListRequest", - "traits": { - "smithy.api#documentation": "

The paths to match.

", - "smithy.api#xmlName": "MatchPath" - } - }, - "ExcludePaths": { - "target": "com.amazonaws.ec2#AccessScopePathListRequest", - "traits": { - "smithy.api#documentation": "

The paths to exclude.

", - "smithy.api#xmlName": "ExcludePath" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, \n see How to ensure idempotency.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateNetworkInsightsAccessScopeResult": { - "type": "structure", - "members": { - "NetworkInsightsAccessScope": { - "target": "com.amazonaws.ec2#NetworkInsightsAccessScope", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInsightsAccessScope", - "smithy.api#documentation": "

The Network Access Scope.

", - "smithy.api#xmlName": "networkInsightsAccessScope" - } - }, - "NetworkInsightsAccessScopeContent": { - "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeContent", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeContent", - "smithy.api#documentation": "

The Network Access Scope content.

", - "smithy.api#xmlName": "networkInsightsAccessScopeContent" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateNetworkInsightsPath": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateNetworkInsightsPathRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateNetworkInsightsPathResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a path to analyze for reachability.

\n

Reachability Analyzer enables you to analyze and debug network reachability between\n two resources in your virtual private cloud (VPC). For more information, see the \n Reachability Analyzer Guide.

" - } - }, - "com.amazonaws.ec2#CreateNetworkInsightsPathRequest": { - "type": "structure", - "members": { - "SourceIp": { - "target": "com.amazonaws.ec2#IpAddress", - "traits": { - "smithy.api#documentation": "

The IP address of the source.

" - } - }, - "DestinationIp": { - "target": "com.amazonaws.ec2#IpAddress", - "traits": { - "smithy.api#documentation": "

The IP address of the destination.

" - } - }, - "Source": { - "target": "com.amazonaws.ec2#NetworkInsightsResourceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID or ARN of the source. If the resource is in another account, you must specify an ARN.

", - "smithy.api#required": {} - } - }, - "Destination": { - "target": "com.amazonaws.ec2#NetworkInsightsResourceId", - "traits": { - "smithy.api#documentation": "

The ID or ARN of the destination. If the resource is in another account, you must specify an ARN.

" - } - }, - "Protocol": { - "target": "com.amazonaws.ec2#Protocol", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The protocol.

", - "smithy.api#required": {} - } - }, - "DestinationPort": { - "target": "com.amazonaws.ec2#Port", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The destination port.

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to add to the path.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, \n see How to ensure idempotency.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "FilterAtSource": { - "target": "com.amazonaws.ec2#PathRequestFilter", - "traits": { - "smithy.api#documentation": "

Scopes the analysis to network paths that match specific filters at the source. If you specify\n this parameter, you can't specify the parameters for the source IP address or the destination port.

" - } - }, - "FilterAtDestination": { - "target": "com.amazonaws.ec2#PathRequestFilter", - "traits": { - "smithy.api#documentation": "

Scopes the analysis to network paths that match specific filters at the destination. If you specify\n this parameter, you can't specify the parameter for the destination IP address.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateNetworkInsightsPathResult": { - "type": "structure", - "members": { - "NetworkInsightsPath": { - "target": "com.amazonaws.ec2#NetworkInsightsPath", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInsightsPath", - "smithy.api#documentation": "

Information about the path.

", - "smithy.api#xmlName": "networkInsightsPath" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateNetworkInterface": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateNetworkInterfaceRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateNetworkInterfaceResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a network interface in the specified subnet.

\n

The number of IP addresses you can assign to a network interface varies by instance\n type. For more information, see IP Addresses Per ENI Per\n Instance Type in the Amazon Virtual Private Cloud User Guide.

\n

For more information about network interfaces, see Elastic network interfaces \n in the Amazon Elastic Compute Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#CreateNetworkInterfacePermission": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateNetworkInterfacePermissionRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateNetworkInterfacePermissionResult" - }, - "traits": { - "smithy.api#documentation": "

Grants an Amazon Web Services-authorized account permission to attach the specified network interface to\n an instance in their account.

\n

You can grant permission to a single Amazon Web Services account only, and only one account at a time.

" - } - }, - "com.amazonaws.ec2#CreateNetworkInterfacePermissionRequest": { - "type": "structure", - "members": { - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#NetworkInterfaceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the network interface.

", - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

" - } - }, - "AwsService": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Service. Currently not supported.

" - } - }, - "Permission": { - "target": "com.amazonaws.ec2#InterfacePermissionType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The type of permission to grant.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is DryRunOperation. \n\t\t\tOtherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for CreateNetworkInterfacePermission.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateNetworkInterfacePermissionResult": { - "type": "structure", - "members": { - "InterfacePermission": { - "target": "com.amazonaws.ec2#NetworkInterfacePermission", - "traits": { - "aws.protocols#ec2QueryName": "InterfacePermission", - "smithy.api#documentation": "

Information about the permission for the network interface.

", - "smithy.api#xmlName": "interfacePermission" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of CreateNetworkInterfacePermission.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateNetworkInterfaceRequest": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description for the network interface.

", - "smithy.api#xmlName": "description" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "Groups": { - "target": "com.amazonaws.ec2#SecurityGroupIdStringList", - "traits": { - "smithy.api#documentation": "

The IDs of one or more security groups.

", - "smithy.api#xmlName": "SecurityGroupId" - } - }, - "Ipv6AddressCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6AddressCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of IPv6 addresses to assign to a network interface. Amazon EC2\n automatically selects the IPv6 addresses from the subnet range.

\n

You can't specify a count of IPv6 addresses using this parameter if you've specified \n one of the following: specific IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.

\n

If your subnet has the AssignIpv6AddressOnCreation attribute set, you can\n override that setting by specifying 0 as the IPv6 address count.

", - "smithy.api#xmlName": "ipv6AddressCount" - } - }, - "Ipv6Addresses": { - "target": "com.amazonaws.ec2#InstanceIpv6AddressList", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6Addresses", - "smithy.api#documentation": "

The IPv6 addresses from the IPv6 CIDR block range of your subnet.

\n

You can't specify IPv6 addresses using this parameter if you've specified one of the \n following: a count of IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.

", - "smithy.api#xmlName": "ipv6Addresses" - } - }, - "PrivateIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrivateIpAddress", - "smithy.api#documentation": "

The primary private IPv4 address of the network interface. If you don't specify an\n IPv4 address, Amazon EC2 selects one for you from the subnet's IPv4 CIDR range. If you\n specify an IP address, you cannot indicate any IP addresses specified in\n privateIpAddresses as primary (only one IP address can be designated as\n primary).

", - "smithy.api#xmlName": "privateIpAddress" - } - }, - "PrivateIpAddresses": { - "target": "com.amazonaws.ec2#PrivateIpAddressSpecificationList", - "traits": { - "aws.protocols#ec2QueryName": "PrivateIpAddresses", - "smithy.api#documentation": "

The private IPv4 addresses.

\n

You can't specify private IPv4 addresses if you've specified one of the following:\n a count of private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.

", - "smithy.api#xmlName": "privateIpAddresses" - } - }, - "SecondaryPrivateIpAddressCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "SecondaryPrivateIpAddressCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of secondary private IPv4 addresses to assign to a network interface. When\n you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses\n within the subnet's IPv4 CIDR range. You can't specify this option and specify more than\n one private IP address using privateIpAddresses.

\n

You can't specify a count of private IPv4 addresses if you've specified one of the following:\n specific private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.

", - "smithy.api#xmlName": "secondaryPrivateIpAddressCount" - } - }, - "Ipv4Prefixes": { - "target": "com.amazonaws.ec2#Ipv4PrefixList", - "traits": { - "smithy.api#documentation": "

The IPv4 prefixes assigned to the network interface.

\n

You can't specify IPv4 prefixes if you've specified one of the following:\n a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.

", - "smithy.api#xmlName": "Ipv4Prefix" - } - }, - "Ipv4PrefixCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface.

\n

You can't specify a count of IPv4 prefixes if you've specified one of the following:\n specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4\n addresses.

" - } - }, - "Ipv6Prefixes": { - "target": "com.amazonaws.ec2#Ipv6PrefixList", - "traits": { - "smithy.api#documentation": "

The IPv6 prefixes assigned to the network interface.

\n

You can't specify IPv6 prefixes if you've specified one of the following:\n a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.

", - "smithy.api#xmlName": "Ipv6Prefix" - } - }, - "Ipv6PrefixCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface.

\n

You can't specify a count of IPv6 prefixes if you've specified one of the following:\n specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.

" - } - }, - "InterfaceType": { - "target": "com.amazonaws.ec2#NetworkInterfaceCreationType", - "traits": { - "smithy.api#documentation": "

The type of network interface. The default is interface.

\n

The only supported values are efa and trunk.

" - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#SubnetId", - "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the subnet to associate with the network interface.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "subnetId" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the new network interface.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateNetworkInterfaceResult": { - "type": "structure", - "members": { - "NetworkInterface": { - "target": "com.amazonaws.ec2#NetworkInterface", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterface", - "smithy.api#documentation": "

Information about the network interface.

", - "smithy.api#xmlName": "networkInterface" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "clientToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreatePlacementGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreatePlacementGroupRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreatePlacementGroupResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a placement group in which to launch instances. The strategy of the placement\n group determines how the instances are organized within the group.

\n

A cluster placement group is a logical grouping of instances within a\n single Availability Zone that benefit from low network latency, high network throughput.\n A spread placement group places instances on distinct hardware. A\n partition placement group places groups of instances in different\n partitions, where instances in one partition do not share the same hardware with\n instances in another partition.

\n

For more information, see Placement groups in the\n Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#CreatePlacementGroupRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "GroupName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupName", - "smithy.api#documentation": "

A name for the placement group. Must be unique within the scope of your account for\n the Region.

\n

Constraints: Up to 255 ASCII characters

", - "smithy.api#xmlName": "groupName" - } - }, - "Strategy": { - "target": "com.amazonaws.ec2#PlacementStrategy", - "traits": { - "aws.protocols#ec2QueryName": "Strategy", - "smithy.api#documentation": "

The placement strategy.

", - "smithy.api#xmlName": "strategy" - } - }, - "PartitionCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of partitions. Valid only when Strategy is\n set to partition.

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the new placement group.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "SpreadLevel": { - "target": "com.amazonaws.ec2#SpreadLevel", - "traits": { - "smithy.api#documentation": "

Determines how placement groups spread instances.

\n " - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreatePlacementGroupResult": { - "type": "structure", - "members": { - "PlacementGroup": { - "target": "com.amazonaws.ec2#PlacementGroup", - "traits": { - "aws.protocols#ec2QueryName": "PlacementGroup", - "smithy.api#documentation": "

Information about the placement group.

", - "smithy.api#xmlName": "placementGroup" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreatePublicIpv4Pool": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreatePublicIpv4PoolRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreatePublicIpv4PoolResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a public IPv4 address pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only. To monitor the status of pool creation, use DescribePublicIpv4Pools.

" - } - }, - "com.amazonaws.ec2#CreatePublicIpv4PoolRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

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.\n 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.

", - "smithy.api#xmlName": "TagSpecification" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreatePublicIpv4PoolResult": { - "type": "structure", - "members": { - "PoolId": { - "target": "com.amazonaws.ec2#Ipv4PoolEc2Id", - "traits": { - "aws.protocols#ec2QueryName": "PoolId", - "smithy.api#documentation": "

The ID of the public IPv4 pool.

", - "smithy.api#xmlName": "poolId" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateReplaceRootVolumeTask": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateReplaceRootVolumeTaskRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateReplaceRootVolumeTaskResult" - }, - "traits": { - "smithy.api#documentation": "

Replaces the EBS-backed root volume for a running instance with a new \n volume that is restored to the original root volume's launch state, that is restored to a \n specific snapshot taken from the original root volume, or that is restored from an AMI \n that has the same key characteristics as that of the instance.

\n

For more information, see Replace a root volume in the Amazon Elastic Compute Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#CreateReplaceRootVolumeTaskRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the instance for which to replace the root volume.

", - "smithy.api#required": {} - } - }, - "SnapshotId": { - "target": "com.amazonaws.ec2#SnapshotId", - "traits": { - "smithy.api#documentation": "

The ID of the snapshot from which to restore the replacement root volume. The \n specified snapshot must be a snapshot that you previously created from the original \n root volume.

\n

If you want to restore the replacement root volume to the initial launch state, \n or if you want to restore the replacement root volume from an AMI, omit this \n parameter.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. \n If you do not specify a client token, a randomly generated token is used for the request \n to ensure idempotency. For more information, see Ensuring idempotency.

", - "smithy.api#idempotencyToken": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the root volume replacement task.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "ImageId": { - "target": "com.amazonaws.ec2#ImageId", - "traits": { - "smithy.api#documentation": "

The ID of the AMI to use to restore the root volume. The specified AMI must have the \n same product code, billing information, architecture type, and virtualization type as \n that of the instance.

\n

If you want to restore the replacement volume from a specific snapshot, or if you want \n to restore it to its launch state, omit this parameter.

" - } - }, - "DeleteReplacedRootVolume": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to automatically delete the original root volume after the root volume \n replacement task completes. To delete the original root volume, specify true. \n If you choose to keep the original root volume after the replacement task completes, you must \n manually delete it when you no longer need it.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateReplaceRootVolumeTaskResult": { - "type": "structure", - "members": { - "ReplaceRootVolumeTask": { - "target": "com.amazonaws.ec2#ReplaceRootVolumeTask", - "traits": { - "aws.protocols#ec2QueryName": "ReplaceRootVolumeTask", - "smithy.api#documentation": "

Information about the root volume replacement task.

", - "smithy.api#xmlName": "replaceRootVolumeTask" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateReservedInstancesListing": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateReservedInstancesListingRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateReservedInstancesListingResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance\n\t\t\tMarketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your\n\t\t\tStandard Reserved Instances, you can use the DescribeReservedInstances operation.

\n \n

Only Standard Reserved Instances can be sold in the Reserved Instance Marketplace. \n Convertible Reserved Instances cannot be sold.

\n \n

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.

\n

To sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance\n Marketplace. After completing the registration process, you can create a Reserved Instance\n Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price\n to receive for them. Your Standard Reserved Instance listings then become available for purchase. To\n view the details of your Standard Reserved Instance listing, you can use the\n DescribeReservedInstancesListings operation.

\n

For more information, see Reserved Instance Marketplace in the\n\t\t\t\tAmazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#CreateReservedInstancesListingRequest": { - "type": "structure", - "members": { - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure idempotency of your\n\t\t\t\tlistings. This helps avoid duplicate listings. For more information, see \n\t\t\t\tEnsuring Idempotency.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "clientToken" - } - }, - "InstanceCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "InstanceCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#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.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "instanceCount" - } - }, - "PriceSchedules": { - "target": "com.amazonaws.ec2#PriceScheduleSpecificationList", - "traits": { - "aws.protocols#ec2QueryName": "PriceSchedules", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A list specifying the price of the Standard Reserved Instance for each month remaining in the Reserved Instance term.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "priceSchedules" - } - }, - "ReservedInstancesId": { - "target": "com.amazonaws.ec2#ReservationId", - "traits": { - "aws.protocols#ec2QueryName": "ReservedInstancesId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the active Standard Reserved Instance.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "reservedInstancesId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for CreateReservedInstancesListing.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateReservedInstancesListingResult": { - "type": "structure", - "members": { - "ReservedInstancesListings": { - "target": "com.amazonaws.ec2#ReservedInstancesListingList", - "traits": { - "aws.protocols#ec2QueryName": "ReservedInstancesListingsSet", - "smithy.api#documentation": "

Information about the Standard Reserved Instance listing.

", - "smithy.api#xmlName": "reservedInstancesListingsSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of CreateReservedInstancesListing.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateRestoreImageTask": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateRestoreImageTaskRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateRestoreImageTaskResult" - }, - "traits": { - "smithy.api#documentation": "

Starts a task that restores an AMI from an Amazon S3 object that was previously created by using\n CreateStoreImageTask.

\n

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the\n Amazon EC2 User Guide.

\n

For more information, see Store and restore an AMI using\n \tAmazon S3 in the Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#CreateRestoreImageTaskRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Amazon S3 bucket that contains the stored AMI object.

", - "smithy.api#required": {} - } - }, - "ObjectKey": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the stored AMI object in the bucket.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The name for the restored AMI. The name must be unique for AMIs in the Region for this\n account. If you do not provide a name, the new AMI gets the same name as the original\n AMI.

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the AMI and snapshots on restoration. You can tag the AMI, the\n snapshots, or both.

\n ", - "smithy.api#xmlName": "TagSpecification" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateRestoreImageTaskResult": { - "type": "structure", - "members": { - "ImageId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ImageId", - "smithy.api#documentation": "

The AMI ID.

", - "smithy.api#xmlName": "imageId" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateRoute": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateRouteRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateRouteResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a route in a route table within a VPC.

\n

You must specify either a destination CIDR block or a prefix list ID. You must also specify \n exactly one of the resources from the parameter list.

\n

When determining how to route traffic, we use the route with the most specific match.\n For example, traffic is destined for the IPv4 address 192.0.2.3, and the\n route table includes the following two IPv4 routes:

\n \n

Both routes apply to the traffic destined for 192.0.2.3. However, the second route\n\t\t\t\tin the list covers a smaller number of IP addresses and is therefore more specific,\n\t\t\t\tso we use that route to determine where to target the traffic.

\n

For more information about route tables, see Route tables in the\n Amazon Virtual Private Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#CreateRouteRequest": { - "type": "structure", - "members": { - "DestinationCidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DestinationCidrBlock", - "smithy.api#documentation": "

The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

", - "smithy.api#xmlName": "destinationCidrBlock" - } - }, - "DestinationIpv6CidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DestinationIpv6CidrBlock", - "smithy.api#documentation": "

The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.

", - "smithy.api#xmlName": "destinationIpv6CidrBlock" - } - }, - "DestinationPrefixListId": { - "target": "com.amazonaws.ec2#PrefixListResourceId", - "traits": { - "smithy.api#documentation": "

The ID of a prefix list used for the destination match.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "VpcEndpointId": { - "target": "com.amazonaws.ec2#VpcEndpointId", - "traits": { - "smithy.api#documentation": "

The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.

" - } - }, - "EgressOnlyInternetGatewayId": { - "target": "com.amazonaws.ec2#EgressOnlyInternetGatewayId", - "traits": { - "aws.protocols#ec2QueryName": "EgressOnlyInternetGatewayId", - "smithy.api#documentation": "

[IPv6 traffic only] The ID of an egress-only internet gateway.

", - "smithy.api#xmlName": "egressOnlyInternetGatewayId" - } - }, - "GatewayId": { - "target": "com.amazonaws.ec2#RouteGatewayId", - "traits": { - "aws.protocols#ec2QueryName": "GatewayId", - "smithy.api#documentation": "

The ID of an internet gateway or virtual private gateway attached to your\n\t\t\tVPC.

", - "smithy.api#xmlName": "gatewayId" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#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.

", - "smithy.api#xmlName": "instanceId" - } - }, - "NatGatewayId": { - "target": "com.amazonaws.ec2#NatGatewayId", - "traits": { - "aws.protocols#ec2QueryName": "NatGatewayId", - "smithy.api#documentation": "

[IPv4 traffic only] The ID of a NAT gateway.

", - "smithy.api#xmlName": "natGatewayId" - } - }, - "TransitGatewayId": { - "target": "com.amazonaws.ec2#TransitGatewayId", - "traits": { - "smithy.api#documentation": "

The ID of a transit gateway.

" - } - }, - "LocalGatewayId": { - "target": "com.amazonaws.ec2#LocalGatewayId", - "traits": { - "smithy.api#documentation": "

The ID of the local gateway.

" - } - }, - "CarrierGatewayId": { - "target": "com.amazonaws.ec2#CarrierGatewayId", - "traits": { - "smithy.api#documentation": "

The ID of the carrier gateway.

\n

You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.

" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#NetworkInterfaceId", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "

The ID of a network interface.

", - "smithy.api#xmlName": "networkInterfaceId" - } - }, - "RouteTableId": { - "target": "com.amazonaws.ec2#RouteTableId", - "traits": { - "aws.protocols#ec2QueryName": "RouteTableId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the route table for the route.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "routeTableId" - } - }, - "VpcPeeringConnectionId": { - "target": "com.amazonaws.ec2#VpcPeeringConnectionId", - "traits": { - "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", - "smithy.api#documentation": "

The ID of a VPC peering connection.

", - "smithy.api#xmlName": "vpcPeeringConnectionId" - } - }, - "CoreNetworkArn": { - "target": "com.amazonaws.ec2#CoreNetworkArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the core network.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateRouteResult": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateRouteTable": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateRouteTableRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateRouteTableResult" - }, - "traits": { - "smithy.api#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.

\n

For more information, see Route tables in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#CreateRouteTableRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "vpcId" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to assign to the route table.

", - "smithy.api#xmlName": "TagSpecification" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateRouteTableResult": { - "type": "structure", - "members": { - "RouteTable": { - "target": "com.amazonaws.ec2#RouteTable", - "traits": { - "aws.protocols#ec2QueryName": "RouteTable", - "smithy.api#documentation": "

Information about the route table.

", - "smithy.api#xmlName": "routeTable" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateSecurityGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateSecurityGroupRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateSecurityGroupResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a security group.

\n

A security group acts as a virtual firewall for your instance to control inbound and outbound traffic.\n For more information, see\n\t\t\t\tAmazon EC2 security groups in \n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide and \n\t\t\t\tSecurity groups for your VPC in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

\n

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.

\n

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.

\n

You can add or remove rules from your security groups using \n\t\t\t\t\tAuthorizeSecurityGroupIngress,\n\t\t\t\t\tAuthorizeSecurityGroupEgress,\n\t\t\t\t\tRevokeSecurityGroupIngress, and\n\t\t\t\t\tRevokeSecurityGroupEgress.

\n

For more information about VPC security group limits, see Amazon VPC Limits.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " - } - }, - "com.amazonaws.ec2#CreateSecurityGroupRequest": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A description for the security group.

\n

Constraints: Up to 255 characters in length

\n

Constraints for EC2-Classic: ASCII characters

\n

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

", - "smithy.api#required": {}, - "smithy.api#xmlName": "GroupDescription" - } - }, - "GroupName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the security group.

\n

Constraints: Up to 255 characters in length. Cannot start with\n sg-.

\n

Constraints for EC2-Classic: ASCII characters

\n

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

", - "smithy.api#required": {} - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", - "traits": { - "smithy.api#documentation": "

[EC2-VPC] The ID of the VPC. Required for EC2-VPC.

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to assign to the security group.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateSecurityGroupResult": { - "type": "structure", - "members": { - "GroupId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupId", - "smithy.api#documentation": "

The ID of the security group.

", - "smithy.api#xmlName": "groupId" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags assigned to the security group.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateSnapshotRequest" - }, - "output": { - "target": "com.amazonaws.ec2#Snapshot" - }, - "traits": { - "smithy.api#documentation": "

Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for\n \tbackups, to make copies of EBS volumes, and to save data before shutting down an\n \tinstance.

\n

You can create snapshots of volumes in a Region and volumes on an Outpost. If you \n \tcreate a snapshot of a volume in a Region, the snapshot must be stored in the same \n \tRegion as the volume. If you create a snapshot of a volume on an Outpost, the snapshot \n \tcan be stored on the same Outpost as the volume, or in the Region for that Outpost.

\n

When a snapshot is created, any Amazon Web Services Marketplace product codes that are associated with the\n source volume are propagated to the snapshot.

\n

You can take a snapshot of an attached volume that is in use. However, snapshots only\n capture data that has been written to your Amazon EBS volume at the time the snapshot command is\n issued; this might exclude any data that has been cached by any applications or the operating\n system. If you can pause any file systems on the volume long enough to take a snapshot, your\n snapshot should be complete. However, if you cannot pause all file writes to the volume, you\n should unmount the volume from within the instance, issue the snapshot command, and then\n remount the volume to ensure a consistent and complete snapshot. You may remount and use your\n volume while the snapshot status is pending.

\n

When you create a snapshot for an EBS volume that serves as a root device, we recommend \n that you stop the instance before taking the snapshot.

\n

Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that\n are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes\n and any associated snapshots always remain protected.

\n

You can tag your snapshots during creation. For more information, see Tag your Amazon EC2\n resources in the Amazon Elastic Compute Cloud User Guide.

\n

For more information, see Amazon Elastic Block Store and Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#CreateSnapshotRequest": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A description for the snapshot.

" - } - }, - "OutpostArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost on which to create a local \n \tsnapshot.

\n \n

For more information, see Create local snapshots from volumes on an Outpost in the Amazon Elastic Compute Cloud User Guide.

" - } - }, - "VolumeId": { - "target": "com.amazonaws.ec2#VolumeId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Amazon EBS volume.

", - "smithy.api#required": {} - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the snapshot during creation.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateSnapshots": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateSnapshotsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateSnapshotsResult" - }, - "traits": { - "smithy.api#documentation": "

Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3.\n Volumes are chosen by specifying an instance. Any attached volumes will produce one snapshot\n each that is crash-consistent across the instance.

\n

You can include all of the volumes currently attached to the instance, or you can exclude \n the root volume or specific data (non-root) volumes from the multi-volume snapshot set.

\n

You can create multi-volume snapshots of instances in a Region and instances on an \n \tOutpost. If you create snapshots from an instance in a Region, the snapshots must be stored \n \tin the same Region as the instance. If you create snapshots from an instance on an Outpost, \n \tthe snapshots can be stored on the same Outpost as the instance, or in the Region for that \n \tOutpost.

" - } - }, - "com.amazonaws.ec2#CreateSnapshotsRequest": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A description propagated to every snapshot specified by the instance.

" - } - }, - "InstanceSpecification": { - "target": "com.amazonaws.ec2#InstanceSpecification", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The instance to specify which volumes should be included in the snapshots.

", - "smithy.api#required": {} - } - }, - "OutpostArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost on which to create the local \n \t\tsnapshots.

\n \n

For more information, see \n \t\tCreate multi-volume local snapshots from instances on an Outpost in the \n \t\tAmazon Elastic Compute Cloud User Guide.

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

Tags to apply to every snapshot specified by the instance.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "CopyTagsFromSource": { - "target": "com.amazonaws.ec2#CopyTagsFromSource", - "traits": { - "smithy.api#documentation": "

Copies the tags from the specified volume to corresponding snapshot.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateSnapshotsResult": { - "type": "structure", - "members": { - "Snapshots": { - "target": "com.amazonaws.ec2#SnapshotSet", - "traits": { - "aws.protocols#ec2QueryName": "SnapshotSet", - "smithy.api#documentation": "

List of snapshots.

", - "smithy.api#xmlName": "snapshotSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateSpotDatafeedSubscription": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateSpotDatafeedSubscriptionRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateSpotDatafeedSubscriptionResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs.\n You can create one data feed per Amazon Web Services account. For more information, see\n Spot Instance data feed \n in the Amazon EC2 User Guide for Linux Instances.

" - } - }, - "com.amazonaws.ec2#CreateSpotDatafeedSubscriptionRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Bucket", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Amazon S3 bucket in which to store the Spot Instance data feed. For\n more information about bucket names, see Rules for bucket\n naming in the Amazon S3 Developer Guide.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "bucket" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "Prefix": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Prefix", - "smithy.api#documentation": "

The prefix for the data feed file names.

", - "smithy.api#xmlName": "prefix" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for CreateSpotDatafeedSubscription.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateSpotDatafeedSubscriptionResult": { - "type": "structure", - "members": { - "SpotDatafeedSubscription": { - "target": "com.amazonaws.ec2#SpotDatafeedSubscription", - "traits": { - "aws.protocols#ec2QueryName": "SpotDatafeedSubscription", - "smithy.api#documentation": "

The Spot Instance data feed subscription.

", - "smithy.api#xmlName": "spotDatafeedSubscription" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of CreateSpotDatafeedSubscription.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateStoreImageTask": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateStoreImageTaskRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateStoreImageTaskResult" - }, - "traits": { - "smithy.api#documentation": "

Stores an AMI as a single object in an Amazon S3 bucket.

\n

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the\n Amazon EC2 User Guide.

\n

For more information, see Store and restore an AMI using\n \tAmazon S3 in the Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#CreateStoreImageTaskRequest": { - "type": "structure", - "members": { - "ImageId": { - "target": "com.amazonaws.ec2#ImageId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the AMI.

", - "smithy.api#required": {} - } - }, - "Bucket": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Amazon S3 bucket in which the AMI object will be stored. The bucket must be in\n the Region in which the request is being made. The AMI object appears in the bucket only after\n the upload task has completed.

", - "smithy.api#required": {} - } - }, - "S3ObjectTags": { - "target": "com.amazonaws.ec2#S3ObjectTagList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the AMI object that will be stored in the Amazon S3 bucket.

", - "smithy.api#xmlName": "S3ObjectTag" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateStoreImageTaskResult": { - "type": "structure", - "members": { - "ObjectKey": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ObjectKey", - "smithy.api#documentation": "

The name of the stored AMI object in the S3 bucket.

", - "smithy.api#xmlName": "objectKey" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateSubnet": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateSubnetRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateSubnetResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a subnet in the specified VPC. For an IPv4 only subnet, specify an IPv4 CIDR block.\n If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead.\n For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both\n an IPv4 CIDR block and an IPv6 CIDR block.

\n

A subnet CIDR block must not overlap the CIDR block of an existing subnet in the VPC.\n After you create a subnet, you can't change its CIDR block.

\n

The allowed size for an IPv4 subnet is between a /28 netmask (16 IP addresses) and \n a /16 netmask (65,536 IP addresses). Amazon Web Services reserves both the first four and \n the last IPv4 address in each subnet's CIDR block. They're not available for your use.

\n

If you've associated an IPv6 CIDR block with your VPC, you can associate an IPv6 CIDR block \n with a subnet when you create it. The allowed block size for an IPv6 subnet is a /64 netmask.

\n

If you add more than one subnet to a VPC, they're set up in a star topology with a\n logical router in the middle.

\n

When you stop an instance in a subnet, it retains its private IPv4 address. It's\n therefore possible to have a subnet with no running instances (they're all stopped), but\n no remaining IP addresses available.

\n

For more information, see Subnets in the Amazon Virtual Private Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#CreateSubnetCidrReservation": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateSubnetCidrReservationRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateSubnetCidrReservationResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a subnet CIDR reservation. For information about subnet CIDR reservations, see Subnet CIDR reservations in the Amazon Virtual Private Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#CreateSubnetCidrReservationRequest": { - "type": "structure", - "members": { - "SubnetId": { - "target": "com.amazonaws.ec2#SubnetId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the subnet.

", - "smithy.api#required": {} - } - }, - "Cidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IPv4 or IPV6 CIDR range to reserve.

", - "smithy.api#required": {} - } - }, - "ReservationType": { - "target": "com.amazonaws.ec2#SubnetCidrReservationType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The type of reservation.

\n

The following are valid values:

\n ", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The\n description\n to assign to the subnet CIDR reservation.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to assign to the subnet CIDR reservation.

", - "smithy.api#xmlName": "TagSpecification" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateSubnetCidrReservationResult": { - "type": "structure", - "members": { - "SubnetCidrReservation": { - "target": "com.amazonaws.ec2#SubnetCidrReservation", - "traits": { - "aws.protocols#ec2QueryName": "SubnetCidrReservation", - "smithy.api#documentation": "

Information about the created subnet CIDR reservation.

", - "smithy.api#xmlName": "subnetCidrReservation" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateSubnetRequest": { - "type": "structure", - "members": { - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to assign to the subnet.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The Availability Zone or Local Zone for the subnet.

\n

Default: Amazon Web Services selects one for you. If you create more than one subnet in your VPC, we \n do not necessarily select a different zone for each subnet.

\n

To create a subnet in a Local Zone, set this value to the Local Zone ID, for example\n us-west-2-lax-1a. For information about the Regions that support Local Zones, \n see Available Regions in the Amazon Elastic Compute Cloud User Guide.

\n

To create a subnet in an Outpost, set this value to the Availability Zone for the\n Outpost and specify the Outpost ARN.

" - } - }, - "AvailabilityZoneId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The AZ ID or the Local Zone ID of the subnet.

" - } - }, - "CidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/24. \n We modify the specified CIDR block to its canonical form; for example, if you specify \n 100.68.0.18/18, we modify it to 100.68.0.0/18.

\n

This parameter is not supported for an IPv6 only subnet.

" - } - }, - "Ipv6CidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a\n /64 prefix length.

\n

This parameter is required for an IPv6 only subnet.

" - } - }, - "OutpostArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost. If you specify an Outpost ARN, you must also\n specify the Availability Zone of the Outpost subnet.

" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "Ipv6Native": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to create an IPv6 only subnet.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateSubnetResult": { - "type": "structure", - "members": { - "Subnet": { - "target": "com.amazonaws.ec2#Subnet", - "traits": { - "aws.protocols#ec2QueryName": "Subnet", - "smithy.api#documentation": "

Information about the subnet.

", - "smithy.api#xmlName": "subnet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateTags": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateTagsRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Adds or overwrites only the specified tags for the specified Amazon EC2 resource or\n resources. When you specify an existing tag key, the value is overwritten with\n the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and\n optional value. Tag keys must be unique per resource.

\n

For more information about tags, see Tag your Amazon EC2 resources in the\n Amazon Elastic Compute Cloud User Guide. For more information about\n creating IAM policies that control users' access to resources based on tags, see Supported\n resource-level permissions for Amazon EC2 API actions in the Amazon\n Elastic Compute Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#CreateTagsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "Resources": { - "target": "com.amazonaws.ec2#ResourceIdList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IDs of the resources, separated by spaces.

\n

Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "ResourceId" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The tags. The value parameter is required, but if you don't want the tag to have a value,\n specify the parameter with no value, and we set the value to an empty string.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "Tag" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateTrafficMirrorFilter": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateTrafficMirrorFilterRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateTrafficMirrorFilterResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a Traffic Mirror filter.

\n

A Traffic Mirror filter is a set of rules that defines the traffic to mirror.

\n

By default, no traffic is mirrored. To mirror traffic, use CreateTrafficMirrorFilterRule to add Traffic Mirror rules to the filter. The rules you\n add define what traffic gets mirrored. You can also use ModifyTrafficMirrorFilterNetworkServices to mirror supported network services.

" - } - }, - "com.amazonaws.ec2#CreateTrafficMirrorFilterRequest": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The description of the Traffic Mirror filter.

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to assign to a Traffic Mirror filter.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateTrafficMirrorFilterResult": { - "type": "structure", - "members": { - "TrafficMirrorFilter": { - "target": "com.amazonaws.ec2#TrafficMirrorFilter", - "traits": { - "aws.protocols#ec2QueryName": "TrafficMirrorFilter", - "smithy.api#documentation": "

Information about the Traffic Mirror filter.

", - "smithy.api#xmlName": "trafficMirrorFilter" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

", - "smithy.api#xmlName": "clientToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateTrafficMirrorFilterRule": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateTrafficMirrorFilterRuleRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateTrafficMirrorFilterRuleResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a Traffic Mirror filter rule.

\n

A Traffic Mirror rule defines the Traffic Mirror source traffic to mirror.

\n

You need the Traffic Mirror filter ID when you create the rule.

" - } - }, - "com.amazonaws.ec2#CreateTrafficMirrorFilterRuleRequest": { - "type": "structure", - "members": { - "TrafficMirrorFilterId": { - "target": "com.amazonaws.ec2#TrafficMirrorFilterId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the filter that this rule is associated with.

", - "smithy.api#required": {} - } - }, - "TrafficDirection": { - "target": "com.amazonaws.ec2#TrafficDirection", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The type of traffic.

", - "smithy.api#required": {} - } - }, - "RuleNumber": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given\n direction. The rules are processed in ascending order by rule number.

", - "smithy.api#required": {} - } - }, - "RuleAction": { - "target": "com.amazonaws.ec2#TrafficMirrorRuleAction", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The action to take on the filtered traffic.

", - "smithy.api#required": {} - } - }, - "DestinationPortRange": { - "target": "com.amazonaws.ec2#TrafficMirrorPortRangeRequest", - "traits": { - "smithy.api#documentation": "

The destination port range.

" - } - }, - "SourcePortRange": { - "target": "com.amazonaws.ec2#TrafficMirrorPortRangeRequest", - "traits": { - "smithy.api#documentation": "

The source port range.

" - } - }, - "Protocol": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The protocol, for example UDP, to assign to the Traffic Mirror rule.

\n

For information about the protocol value, see Protocol Numbers on the Internet Assigned Numbers Authority (IANA) website.

" - } - }, - "DestinationCidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The destination CIDR block to assign to the Traffic Mirror rule.

", - "smithy.api#required": {} - } - }, - "SourceCidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The source CIDR block to assign to the Traffic Mirror rule.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The description of the Traffic Mirror rule.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateTrafficMirrorFilterRuleResult": { - "type": "structure", - "members": { - "TrafficMirrorFilterRule": { - "target": "com.amazonaws.ec2#TrafficMirrorFilterRule", - "traits": { - "aws.protocols#ec2QueryName": "TrafficMirrorFilterRule", - "smithy.api#documentation": "

The Traffic Mirror rule.

", - "smithy.api#xmlName": "trafficMirrorFilterRule" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

", - "smithy.api#xmlName": "clientToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateTrafficMirrorSession": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateTrafficMirrorSessionRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateTrafficMirrorSessionResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a Traffic Mirror session.

\n

A Traffic Mirror session actively copies packets from a Traffic Mirror source to a Traffic Mirror target. Create a filter, and then assign it\n to the session to define a subset of the traffic to mirror, for example all TCP\n traffic.

\n

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.

\n

By default, no traffic is mirrored. Use CreateTrafficMirrorFilter to\n create filter rules that specify the traffic to mirror.

" - } - }, - "com.amazonaws.ec2#CreateTrafficMirrorSessionRequest": { - "type": "structure", - "members": { - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#NetworkInterfaceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the source network interface.

", - "smithy.api#required": {} - } - }, - "TrafficMirrorTargetId": { - "target": "com.amazonaws.ec2#TrafficMirrorTargetId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Traffic Mirror target.

", - "smithy.api#required": {} - } - }, - "TrafficMirrorFilterId": { - "target": "com.amazonaws.ec2#TrafficMirrorFilterId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Traffic Mirror filter.

", - "smithy.api#required": {} - } - }, - "PacketLength": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of bytes in each packet to mirror. These are bytes after the VXLAN header. Do\n not specify this parameter when you want to mirror the entire packet. To mirror a subset of\n the packet, set this to the length (in bytes) that you want to mirror. For example, if you\n set this value to 100, then the first 100 bytes that meet the filter criteria are copied to\n the target.

\n

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": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#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.

\n

Valid values are 1-32766.

", - "smithy.api#required": {} - } - }, - "VirtualNetworkId": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The VXLAN ID for the Traffic Mirror session. For more information about the VXLAN\n protocol, see RFC 7348. If you do\n not specify a VirtualNetworkId, an account-wide unique id is chosen at\n random.

" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The description of the Traffic Mirror session.

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to assign to a Traffic Mirror session.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateTrafficMirrorSessionResult": { - "type": "structure", - "members": { - "TrafficMirrorSession": { - "target": "com.amazonaws.ec2#TrafficMirrorSession", - "traits": { - "aws.protocols#ec2QueryName": "TrafficMirrorSession", - "smithy.api#documentation": "

Information about the Traffic Mirror session.

", - "smithy.api#xmlName": "trafficMirrorSession" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

", - "smithy.api#xmlName": "clientToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateTrafficMirrorTarget": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateTrafficMirrorTargetRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateTrafficMirrorTargetResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a target for your Traffic Mirror session.

\n

A Traffic Mirror target is the destination for mirrored traffic. The Traffic Mirror source and\n the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in\n different VPCs connected via VPC peering or a transit gateway.

\n

A Traffic Mirror target can be a network interface, a Network Load Balancer, or a Gateway Load Balancer endpoint.

\n

To use the target in a Traffic Mirror session, use CreateTrafficMirrorSession.

" - } - }, - "com.amazonaws.ec2#CreateTrafficMirrorTargetRequest": { - "type": "structure", - "members": { - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#NetworkInterfaceId", - "traits": { - "smithy.api#documentation": "

The network interface ID that is associated with the target.

" - } - }, - "NetworkLoadBalancerArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target.

" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The description of the Traffic Mirror target.

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to assign to the Traffic Mirror target.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

", - "smithy.api#idempotencyToken": {} - } - }, - "GatewayLoadBalancerEndpointId": { - "target": "com.amazonaws.ec2#VpcEndpointId", - "traits": { - "smithy.api#documentation": "

The ID of the Gateway Load Balancer endpoint.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateTrafficMirrorTargetResult": { - "type": "structure", - "members": { - "TrafficMirrorTarget": { - "target": "com.amazonaws.ec2#TrafficMirrorTarget", - "traits": { - "aws.protocols#ec2QueryName": "TrafficMirrorTarget", - "smithy.api#documentation": "

Information about the Traffic Mirror target.

", - "smithy.api#xmlName": "trafficMirrorTarget" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

", - "smithy.api#xmlName": "clientToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateTransitGateway": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateTransitGatewayRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateTransitGatewayResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a transit gateway.

\n

You can use a transit gateway to interconnect your virtual private clouds (VPC) and on-premises networks.\n After the transit gateway enters the available state, you can attach your VPCs and VPN\n connections to the transit gateway.

\n

To attach your VPCs, use CreateTransitGatewayVpcAttachment.

\n

To attach a VPN connection, use CreateCustomerGateway to create a customer \n gateway and specify the ID of the customer gateway and the ID of the transit gateway in a call to\n CreateVpnConnection.

\n

When you create a transit gateway, we create a default transit gateway route table and use it as the default association route table\n and the default propagation route table. You can use CreateTransitGatewayRouteTable to create\n additional transit gateway route tables. If you disable automatic route propagation, we do not create a default transit gateway route table. \n You can use EnableTransitGatewayRouteTablePropagation to propagate routes from a resource \n 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.

" - } - }, - "com.amazonaws.ec2#CreateTransitGatewayConnect": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateTransitGatewayConnectRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateTransitGatewayConnectResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a Connect attachment from a specified transit gateway attachment. A Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a transit gateway and an appliance.

\n

A Connect attachment uses an existing VPC or Amazon Web Services Direct Connect attachment as the underlying transport mechanism.

" - } - }, - "com.amazonaws.ec2#CreateTransitGatewayConnectPeer": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateTransitGatewayConnectPeerRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateTransitGatewayConnectPeerResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a Connect peer for a specified transit gateway Connect attachment between a\n transit gateway and an appliance.

\n

The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).

\n

For more information, see Connect peers in the Transit Gateways Guide.

" - } - }, - "com.amazonaws.ec2#CreateTransitGatewayConnectPeerRequest": { - "type": "structure", - "members": { - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Connect attachment.

", - "smithy.api#required": {} - } - }, - "TransitGatewayAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The peer IP address (GRE outer IP address) on the transit gateway side of the Connect peer, which must be\n specified from a transit gateway CIDR block. If not specified, Amazon automatically assigns\n the first available IP address from the transit gateway CIDR block.

" - } - }, - "PeerAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The peer IP address (GRE outer IP address) on the appliance side of the Connect peer.

", - "smithy.api#required": {} - } - }, - "BgpOptions": { - "target": "com.amazonaws.ec2#TransitGatewayConnectRequestBgpOptions", - "traits": { - "smithy.api#documentation": "

The BGP options for the Connect peer.

" - } - }, - "InsideCidrBlocks": { - "target": "com.amazonaws.ec2#InsideCidrBlocksStringList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The range of inside IP addresses that are used for BGP peering. You must specify a\n size /29 IPv4 CIDR block from the 169.254.0.0/16 range. The first address\n from the range must be configured on the appliance as the BGP IP address. You can also\n optionally specify a size /125 IPv6 CIDR block from the fd00::/8\n range.

", - "smithy.api#required": {} - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the Connect peer.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateTransitGatewayConnectPeerResult": { - "type": "structure", - "members": { - "TransitGatewayConnectPeer": { - "target": "com.amazonaws.ec2#TransitGatewayConnectPeer", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayConnectPeer", - "smithy.api#documentation": "

Information about the Connect peer.

", - "smithy.api#xmlName": "transitGatewayConnectPeer" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateTransitGatewayConnectRequest": { - "type": "structure", - "members": { - "TransportTransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the transit gateway attachment. You can specify a VPC attachment or Amazon Web Services Direct Connect attachment.

", - "smithy.api#required": {} - } - }, - "Options": { - "target": "com.amazonaws.ec2#CreateTransitGatewayConnectRequestOptions", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Connect attachment options.

", - "smithy.api#required": {} - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the Connect attachment.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateTransitGatewayConnectRequestOptions": { - "type": "structure", - "members": { - "Protocol": { - "target": "com.amazonaws.ec2#ProtocolValue", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The tunnel protocol.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The options for a Connect attachment.

" - } - }, - "com.amazonaws.ec2#CreateTransitGatewayConnectResult": { - "type": "structure", - "members": { - "TransitGatewayConnect": { - "target": "com.amazonaws.ec2#TransitGatewayConnect", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayConnect", - "smithy.api#documentation": "

Information about the Connect attachment.

", - "smithy.api#xmlName": "transitGatewayConnect" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateTransitGatewayMulticastDomain": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateTransitGatewayMulticastDomainRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateTransitGatewayMulticastDomainResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a multicast domain using the specified transit gateway.

\n

The transit gateway must be in the available state before you create a domain. Use DescribeTransitGateways to see the state of transit gateway.

" - } - }, - "com.amazonaws.ec2#CreateTransitGatewayMulticastDomainRequest": { - "type": "structure", - "members": { - "TransitGatewayId": { - "target": "com.amazonaws.ec2#TransitGatewayId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the transit gateway.

", - "smithy.api#required": {} - } - }, - "Options": { - "target": "com.amazonaws.ec2#CreateTransitGatewayMulticastDomainRequestOptions", - "traits": { - "smithy.api#documentation": "

The options for the transit gateway multicast domain.

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags for the transit gateway multicast domain.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateTransitGatewayMulticastDomainRequestOptions": { - "type": "structure", - "members": { - "Igmpv2Support": { - "target": "com.amazonaws.ec2#Igmpv2SupportValue", - "traits": { - "smithy.api#documentation": "

Specify whether to enable Internet Group Management Protocol (IGMP) version 2 for the transit gateway multicast domain.

" - } - }, - "StaticSourcesSupport": { - "target": "com.amazonaws.ec2#StaticSourcesSupportValue", - "traits": { - "smithy.api#documentation": "

Specify whether to enable support for statically configuring multicast group sources for a domain.

" - } - }, - "AutoAcceptSharedAssociations": { - "target": "com.amazonaws.ec2#AutoAcceptSharedAssociationsValue", - "traits": { - "smithy.api#documentation": "

Indicates whether to automatically accept cross-account subnet associations that are associated with the transit gateway multicast domain.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options for the transit gateway multicast domain.

" - } - }, - "com.amazonaws.ec2#CreateTransitGatewayMulticastDomainResult": { - "type": "structure", - "members": { - "TransitGatewayMulticastDomain": { - "target": "com.amazonaws.ec2#TransitGatewayMulticastDomain", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayMulticastDomain", - "smithy.api#documentation": "

Information about the transit gateway multicast domain.

", - "smithy.api#xmlName": "transitGatewayMulticastDomain" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateTransitGatewayPeeringAttachment": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateTransitGatewayPeeringAttachmentRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateTransitGatewayPeeringAttachmentResult" - }, - "traits": { - "smithy.api#documentation": "

Requests a transit gateway peering attachment between the specified transit gateway\n (requester) and a peer transit gateway (accepter). The peer transit gateway can be in \n your account or a different Amazon Web Services account.

\n

After you create the peering attachment, the owner of the accepter transit gateway \n must accept the attachment request.

" - } - }, - "com.amazonaws.ec2#CreateTransitGatewayPeeringAttachmentRequest": { - "type": "structure", - "members": { - "TransitGatewayId": { - "target": "com.amazonaws.ec2#TransitGatewayId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the transit gateway.

", - "smithy.api#required": {} - } - }, - "PeerTransitGatewayId": { - "target": "com.amazonaws.ec2#TransitAssociationGatewayId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the peer transit gateway with which to create the peering attachment.

", - "smithy.api#required": {} - } - }, - "PeerAccountId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the peer transit gateway.

", - "smithy.api#required": {} - } - }, - "PeerRegion": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Region where the peer transit gateway is located.

", - "smithy.api#required": {} - } - }, - "Options": { - "target": "com.amazonaws.ec2#CreateTransitGatewayPeeringAttachmentRequestOptions", - "traits": { - "smithy.api#documentation": "

Requests a transit gateway peering attachment.

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the transit gateway peering attachment.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateTransitGatewayPeeringAttachmentRequestOptions": { - "type": "structure", - "members": { - "DynamicRouting": { - "target": "com.amazonaws.ec2#DynamicRoutingValue", - "traits": { - "smithy.api#documentation": "

Indicates whether dynamic routing is enabled or disabled.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes whether dynamic routing is enabled or disabled for the transit gateway peering request.

" - } - }, - "com.amazonaws.ec2#CreateTransitGatewayPeeringAttachmentResult": { - "type": "structure", - "members": { - "TransitGatewayPeeringAttachment": { - "target": "com.amazonaws.ec2#TransitGatewayPeeringAttachment", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayPeeringAttachment", - "smithy.api#documentation": "

The transit gateway peering attachment.

", - "smithy.api#xmlName": "transitGatewayPeeringAttachment" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateTransitGatewayPolicyTable": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateTransitGatewayPolicyTableRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateTransitGatewayPolicyTableResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a transit gateway policy table.

" - } - }, - "com.amazonaws.ec2#CreateTransitGatewayPolicyTableRequest": { - "type": "structure", - "members": { - "TransitGatewayId": { - "target": "com.amazonaws.ec2#TransitGatewayId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the transit gateway used for the policy table.

", - "smithy.api#required": {} - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags specification for the transit gateway policy table created during the request.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateTransitGatewayPolicyTableResult": { - "type": "structure", - "members": { - "TransitGatewayPolicyTable": { - "target": "com.amazonaws.ec2#TransitGatewayPolicyTable", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayPolicyTable", - "smithy.api#documentation": "

Describes the created transit gateway policy table.

", - "smithy.api#xmlName": "transitGatewayPolicyTable" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateTransitGatewayPrefixListReference": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateTransitGatewayPrefixListReferenceRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateTransitGatewayPrefixListReferenceResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a reference (route) to a prefix list in a specified transit gateway route table.

" - } - }, - "com.amazonaws.ec2#CreateTransitGatewayPrefixListReferenceRequest": { - "type": "structure", - "members": { - "TransitGatewayRouteTableId": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the transit gateway route table.

", - "smithy.api#required": {} - } - }, - "PrefixListId": { - "target": "com.amazonaws.ec2#PrefixListResourceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the prefix list that is used for destination matches.

", - "smithy.api#required": {} - } - }, - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", - "traits": { - "smithy.api#documentation": "

The ID of the attachment to which traffic is routed.

" - } - }, - "Blackhole": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to drop traffic that matches this route.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateTransitGatewayPrefixListReferenceResult": { - "type": "structure", - "members": { - "TransitGatewayPrefixListReference": { - "target": "com.amazonaws.ec2#TransitGatewayPrefixListReference", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayPrefixListReference", - "smithy.api#documentation": "

Information about the prefix list reference.

", - "smithy.api#xmlName": "transitGatewayPrefixListReference" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateTransitGatewayRequest": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A description of the transit gateway.

" - } - }, - "Options": { - "target": "com.amazonaws.ec2#TransitGatewayRequestOptions", - "traits": { - "smithy.api#documentation": "

The transit gateway options.

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the transit gateway.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateTransitGatewayResult": { - "type": "structure", - "members": { - "TransitGateway": { - "target": "com.amazonaws.ec2#TransitGateway", - "traits": { - "aws.protocols#ec2QueryName": "TransitGateway", - "smithy.api#documentation": "

Information about the transit gateway.

", - "smithy.api#xmlName": "transitGateway" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateTransitGatewayRoute": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateTransitGatewayRouteRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateTransitGatewayRouteResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a static route for the specified transit gateway route table.

" - } - }, - "com.amazonaws.ec2#CreateTransitGatewayRouteRequest": { - "type": "structure", - "members": { - "DestinationCidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The CIDR range used for destination matches. Routing decisions are based on the\n most specific match.

", - "smithy.api#required": {} - } - }, - "TransitGatewayRouteTableId": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the transit gateway route table.

", - "smithy.api#required": {} - } - }, - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", - "traits": { - "smithy.api#documentation": "

The ID of the attachment.

" - } - }, - "Blackhole": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to drop traffic that matches this route.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateTransitGatewayRouteResult": { - "type": "structure", - "members": { - "Route": { - "target": "com.amazonaws.ec2#TransitGatewayRoute", - "traits": { - "aws.protocols#ec2QueryName": "Route", - "smithy.api#documentation": "

Information about the route.

", - "smithy.api#xmlName": "route" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateTransitGatewayRouteTable": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateTransitGatewayRouteTableRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateTransitGatewayRouteTableResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a route table for the specified transit gateway.

" - } - }, - "com.amazonaws.ec2#CreateTransitGatewayRouteTableAnnouncement": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateTransitGatewayRouteTableAnnouncementRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateTransitGatewayRouteTableAnnouncementResult" - }, - "traits": { - "smithy.api#documentation": "

Advertises a new transit gateway route table.

" - } - }, - "com.amazonaws.ec2#CreateTransitGatewayRouteTableAnnouncementRequest": { - "type": "structure", - "members": { - "TransitGatewayRouteTableId": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the transit gateway route table.

", - "smithy.api#required": {} - } - }, - "PeeringAttachmentId": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the peering attachment.

", - "smithy.api#required": {} - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags specifications applied to the transit gateway route table announcement.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateTransitGatewayRouteTableAnnouncementResult": { - "type": "structure", - "members": { - "TransitGatewayRouteTableAnnouncement": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncement", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayRouteTableAnnouncement", - "smithy.api#documentation": "

Provides details about the transit gateway route table announcement.

", - "smithy.api#xmlName": "transitGatewayRouteTableAnnouncement" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateTransitGatewayRouteTableRequest": { - "type": "structure", - "members": { - "TransitGatewayId": { - "target": "com.amazonaws.ec2#TransitGatewayId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the transit gateway.

", - "smithy.api#required": {} - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the transit gateway route table.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateTransitGatewayRouteTableResult": { - "type": "structure", - "members": { - "TransitGatewayRouteTable": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTable", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayRouteTable", - "smithy.api#documentation": "

Information about the transit gateway route table.

", - "smithy.api#xmlName": "transitGatewayRouteTable" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateTransitGatewayVpcAttachment": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateTransitGatewayVpcAttachmentRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateTransitGatewayVpcAttachmentResult" - }, - "traits": { - "smithy.api#documentation": "

Attaches the specified VPC to the specified transit gateway.

\n

If you attach a VPC with a CIDR range that overlaps the CIDR range of a VPC that is already attached,\n the new VPC CIDR range is not propagated to the default propagation route table.

\n

To send VPC traffic to an attached transit gateway, add a route to the VPC route table using CreateRoute.

" - } - }, - "com.amazonaws.ec2#CreateTransitGatewayVpcAttachmentRequest": { - "type": "structure", - "members": { - "TransitGatewayId": { - "target": "com.amazonaws.ec2#TransitGatewayId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the transit gateway.

", - "smithy.api#required": {} - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#required": {} - } - }, - "SubnetIds": { - "target": "com.amazonaws.ec2#TransitGatewaySubnetIdList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IDs of one or more subnets. You can specify only one subnet per Availability Zone. \n You must specify at least one subnet, but we recommend that you specify two subnets for better availability.\n The transit gateway uses one IP address from each specified subnet.

", - "smithy.api#required": {} - } - }, - "Options": { - "target": "com.amazonaws.ec2#CreateTransitGatewayVpcAttachmentRequestOptions", - "traits": { - "smithy.api#documentation": "

The VPC attachment options.

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the VPC attachment.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateTransitGatewayVpcAttachmentRequestOptions": { - "type": "structure", - "members": { - "DnsSupport": { - "target": "com.amazonaws.ec2#DnsSupportValue", - "traits": { - "smithy.api#documentation": "

Enable or disable DNS support. The default is enable.

" - } - }, - "Ipv6Support": { - "target": "com.amazonaws.ec2#Ipv6SupportValue", - "traits": { - "smithy.api#documentation": "

Enable or disable IPv6 support. The default is disable.

" - } - }, - "ApplianceModeSupport": { - "target": "com.amazonaws.ec2#ApplianceModeSupportValue", - "traits": { - "smithy.api#documentation": "

Enable or disable support for appliance mode. If enabled, a traffic flow between a source and destination uses the same Availability Zone for the VPC attachment for the lifetime of that flow. The default is disable.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the options for a VPC attachment.

" - } - }, - "com.amazonaws.ec2#CreateTransitGatewayVpcAttachmentResult": { - "type": "structure", - "members": { - "TransitGatewayVpcAttachment": { - "target": "com.amazonaws.ec2#TransitGatewayVpcAttachment", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayVpcAttachment", - "smithy.api#documentation": "

Information about the VPC attachment.

", - "smithy.api#xmlName": "transitGatewayVpcAttachment" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateVerifiedAccessEndpoint": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateVerifiedAccessEndpointRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateVerifiedAccessEndpointResult" - }, - "traits": { - "smithy.api#documentation": "

An Amazon Web Services Verified Access endpoint is where you define your application along with an optional endpoint-level access policy.

" - } - }, - "com.amazonaws.ec2#CreateVerifiedAccessEndpointEniOptions": { - "type": "structure", - "members": { - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#NetworkInterfaceId", - "traits": { - "smithy.api#documentation": "

The ID of the network interface.

" - } - }, - "Protocol": { - "target": "com.amazonaws.ec2#VerifiedAccessEndpointProtocol", - "traits": { - "smithy.api#documentation": "

The IP protocol.

" - } - }, - "Port": { - "target": "com.amazonaws.ec2#VerifiedAccessEndpointPortNumber", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The IP port number.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the network interface options when creating an Amazon Web Services Verified Access endpoint using the\n network-interface type.

" - } - }, - "com.amazonaws.ec2#CreateVerifiedAccessEndpointLoadBalancerOptions": { - "type": "structure", - "members": { - "Protocol": { - "target": "com.amazonaws.ec2#VerifiedAccessEndpointProtocol", - "traits": { - "smithy.api#documentation": "

The IP protocol.

" - } - }, - "Port": { - "target": "com.amazonaws.ec2#VerifiedAccessEndpointPortNumber", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The IP port number.

" - } - }, - "LoadBalancerArn": { - "target": "com.amazonaws.ec2#LoadBalancerArn", - "traits": { - "smithy.api#documentation": "

The ARN of the load balancer.

" - } - }, - "SubnetIds": { - "target": "com.amazonaws.ec2#CreateVerifiedAccessEndpointSubnetIdList", - "traits": { - "smithy.api#documentation": "

The IDs of the subnets.

", - "smithy.api#xmlName": "SubnetId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the load balancer options when creating an Amazon Web Services Verified Access endpoint using the\n load-balancer type.

" - } - }, - "com.amazonaws.ec2#CreateVerifiedAccessEndpointRequest": { - "type": "structure", - "members": { - "VerifiedAccessGroupId": { - "target": "com.amazonaws.ec2#VerifiedAccessGroupId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Verified Access group to associate the endpoint with.

", - "smithy.api#required": {} - } - }, - "EndpointType": { - "target": "com.amazonaws.ec2#VerifiedAccessEndpointType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The type of Verified Access endpoint to create.

", - "smithy.api#required": {} - } - }, - "AttachmentType": { - "target": "com.amazonaws.ec2#VerifiedAccessEndpointAttachmentType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The type of attachment.

", - "smithy.api#required": {} - } - }, - "DomainCertificateArn": { - "target": "com.amazonaws.ec2#CertificateArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ARN of the public TLS/SSL certificate in Amazon Web Services Certificate Manager to associate with the endpoint.\n The CN in the certificate must match the DNS name your end users will use to reach your\n application.

", - "smithy.api#required": {} - } - }, - "ApplicationDomain": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The DNS name for users to reach your application.

", - "smithy.api#required": {} - } - }, - "EndpointDomainPrefix": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A custom identifier that is prepended to the DNS name that is generated for the\n endpoint.

", - "smithy.api#required": {} - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.ec2#SecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

The IDs of the security groups to associate with the Verified Access endpoint.

", - "smithy.api#xmlName": "SecurityGroupId" - } - }, - "LoadBalancerOptions": { - "target": "com.amazonaws.ec2#CreateVerifiedAccessEndpointLoadBalancerOptions", - "traits": { - "smithy.api#documentation": "

The load balancer details. This parameter is required if the endpoint type is\n load-balancer.

" - } - }, - "NetworkInterfaceOptions": { - "target": "com.amazonaws.ec2#CreateVerifiedAccessEndpointEniOptions", - "traits": { - "smithy.api#documentation": "

The network interface details. This parameter is required if the endpoint type is\n network-interface.

" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A description for the Verified Access endpoint.

" - } - }, - "PolicyDocument": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The Verified Access policy document.

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to assign to the Verified Access endpoint.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.

", - "smithy.api#idempotencyToken": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateVerifiedAccessEndpointResult": { - "type": "structure", - "members": { - "VerifiedAccessEndpoint": { - "target": "com.amazonaws.ec2#VerifiedAccessEndpoint", - "traits": { - "aws.protocols#ec2QueryName": "VerifiedAccessEndpoint", - "smithy.api#documentation": "

The ID of the Verified Access endpoint.

", - "smithy.api#xmlName": "verifiedAccessEndpoint" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateVerifiedAccessEndpointSubnetIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SubnetId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#CreateVerifiedAccessGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateVerifiedAccessGroupRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateVerifiedAccessGroupResult" - }, - "traits": { - "smithy.api#documentation": "

An Amazon Web Services Verified Access group is a collection of Amazon Web Services Verified Access endpoints who's associated applications have\n similar security requirements. Each instance within a Verified Access group shares an Verified Access policy. For\n example, you can group all Verified Access instances associated with \"sales\" applications together and\n use one common Verified Access policy.

" - } - }, - "com.amazonaws.ec2#CreateVerifiedAccessGroupRequest": { - "type": "structure", - "members": { - "VerifiedAccessInstanceId": { - "target": "com.amazonaws.ec2#VerifiedAccessInstanceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Verified Access instance.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A description for the Verified Access group.

" - } - }, - "PolicyDocument": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The Verified Access policy document.

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to assign to the Verified Access group.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.

", - "smithy.api#idempotencyToken": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateVerifiedAccessGroupResult": { - "type": "structure", - "members": { - "VerifiedAccessGroup": { - "target": "com.amazonaws.ec2#VerifiedAccessGroup", - "traits": { - "aws.protocols#ec2QueryName": "VerifiedAccessGroup", - "smithy.api#documentation": "

The ID of the Verified Access group.

", - "smithy.api#xmlName": "verifiedAccessGroup" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateVerifiedAccessInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateVerifiedAccessInstanceRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateVerifiedAccessInstanceResult" - }, - "traits": { - "smithy.api#documentation": "

An Amazon Web Services Verified Access instance is a regional entity that evaluates application requests and grants\n access only when your security requirements are met.

" - } - }, - "com.amazonaws.ec2#CreateVerifiedAccessInstanceRequest": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A description for the Verified Access instance.

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to assign to the Verified Access instance.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.

", - "smithy.api#idempotencyToken": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateVerifiedAccessInstanceResult": { - "type": "structure", - "members": { - "VerifiedAccessInstance": { - "target": "com.amazonaws.ec2#VerifiedAccessInstance", - "traits": { - "aws.protocols#ec2QueryName": "VerifiedAccessInstance", - "smithy.api#documentation": "

The ID of the Verified Access instance.

", - "smithy.api#xmlName": "verifiedAccessInstance" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateVerifiedAccessTrustProvider": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateVerifiedAccessTrustProviderRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateVerifiedAccessTrustProviderResult" - }, - "traits": { - "smithy.api#documentation": "

A trust provider is a third-party entity that creates, maintains, and manages identity\n information for users and devices. When an application request is made, the identity\n information sent by the trust provider is evaluated by Verified Access before allowing or\n denying the application request.

" - } - }, - "com.amazonaws.ec2#CreateVerifiedAccessTrustProviderDeviceOptions": { - "type": "structure", - "members": { - "TenantId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The ID of the tenant application with the device-identity provider.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the options when creating an Amazon Web Services Verified Access trust provider using the\n device type.

" - } - }, - "com.amazonaws.ec2#CreateVerifiedAccessTrustProviderOidcOptions": { - "type": "structure", - "members": { - "Issuer": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The OIDC issuer.

" - } - }, - "AuthorizationEndpoint": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The OIDC authorization endpoint.

" - } - }, - "TokenEndpoint": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The OIDC token endpoint.

" - } - }, - "UserInfoEndpoint": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The OIDC user info endpoint.

" - } - }, - "ClientId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The client identifier.

" - } - }, - "ClientSecret": { - "target": "com.amazonaws.ec2#ClientSecretType", - "traits": { - "smithy.api#documentation": "

The client secret.

" - } - }, - "Scope": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

OpenID Connect (OIDC) scopes are used by an application during authentication to authorize access to a user's details. Each scope returns a specific set of user attributes.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the options when creating an Amazon Web Services Verified Access trust provider using the user\n type.

" - } - }, - "com.amazonaws.ec2#CreateVerifiedAccessTrustProviderRequest": { - "type": "structure", - "members": { - "TrustProviderType": { - "target": "com.amazonaws.ec2#TrustProviderType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The type of trust provider.

", - "smithy.api#required": {} - } - }, - "UserTrustProviderType": { - "target": "com.amazonaws.ec2#UserTrustProviderType", - "traits": { - "smithy.api#documentation": "

The type of user-based trust provider. This parameter is required when the provider type\n is user.

" - } - }, - "DeviceTrustProviderType": { - "target": "com.amazonaws.ec2#DeviceTrustProviderType", - "traits": { - "smithy.api#documentation": "

The type of device-based trust provider. This parameter is required when the provider\n type is device.

" - } - }, - "OidcOptions": { - "target": "com.amazonaws.ec2#CreateVerifiedAccessTrustProviderOidcOptions", - "traits": { - "smithy.api#documentation": "

The options for a OpenID Connect-compatible user-identity trust provider. This parameter\n is required when the provider type is user.

" - } - }, - "DeviceOptions": { - "target": "com.amazonaws.ec2#CreateVerifiedAccessTrustProviderDeviceOptions", - "traits": { - "smithy.api#documentation": "

The options for a device-based trust provider. This parameter is required when the\n provider type is device.

" - } - }, - "PolicyReferenceName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The identifier to be used when working with policy rules.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A description for the Verified Access trust provider.

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to assign to the Verified Access trust provider.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.

", - "smithy.api#idempotencyToken": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateVerifiedAccessTrustProviderResult": { - "type": "structure", - "members": { - "VerifiedAccessTrustProvider": { - "target": "com.amazonaws.ec2#VerifiedAccessTrustProvider", - "traits": { - "aws.protocols#ec2QueryName": "VerifiedAccessTrustProvider", - "smithy.api#documentation": "

The ID of the Verified Access trust provider.

", - "smithy.api#xmlName": "verifiedAccessTrustProvider" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateVolume": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateVolumeRequest" - }, - "output": { - "target": "com.amazonaws.ec2#Volume" - }, - "traits": { - "smithy.api#documentation": "

Creates an EBS volume that can be attached to an instance in the same Availability Zone.

\n

You can create a new empty volume or restore a volume from an EBS snapshot.\n Any Amazon Web Services Marketplace product codes from the snapshot are propagated to the volume.

\n

You can create encrypted volumes. Encrypted volumes must be attached to instances that \n support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically \n encrypted. For more information, see Amazon EBS encryption\n in the Amazon Elastic Compute Cloud User Guide.

\n

You can tag your volumes during creation. For more information, see Tag your Amazon EC2\n resources in the Amazon Elastic Compute Cloud User Guide.

\n

For more information, see Create an Amazon EBS volume in the\n Amazon Elastic Compute Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#CreateVolumePermission": { - "type": "structure", - "members": { - "Group": { - "target": "com.amazonaws.ec2#PermissionGroup", - "traits": { - "aws.protocols#ec2QueryName": "Group", - "smithy.api#documentation": "

The group to be added or removed. The possible value is all.

", - "smithy.api#xmlName": "group" - } - }, - "UserId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "UserId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account to be added or removed.

", - "smithy.api#xmlName": "userId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the user or group to be added or removed from the list of create volume\n permissions for a volume.

" - } - }, - "com.amazonaws.ec2#CreateVolumePermissionList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#CreateVolumePermission", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#CreateVolumePermissionModifications": { - "type": "structure", - "members": { - "Add": { - "target": "com.amazonaws.ec2#CreateVolumePermissionList", - "traits": { - "smithy.api#documentation": "

Adds the specified Amazon Web Services account ID or group to the list.

" - } - }, - "Remove": { - "target": "com.amazonaws.ec2#CreateVolumePermissionList", - "traits": { - "smithy.api#documentation": "

Removes the specified Amazon Web Services account ID or group from the list.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes modifications to the list of create volume permissions for a volume.

" - } - }, - "com.amazonaws.ec2#CreateVolumeRequest": { - "type": "structure", - "members": { - "AvailabilityZone": { - "target": "com.amazonaws.ec2#AvailabilityZoneName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Availability Zone in which to create the volume.

", - "smithy.api#required": {} - } - }, - "Encrypted": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Encrypted", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the volume should be encrypted. \n The effect of setting the encryption state to true depends on \nthe volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. \n For more information, see Encryption by default\n in the Amazon Elastic Compute Cloud User Guide.

\n

Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. \n For more information, see Supported\n instance types.

", - "smithy.api#xmlName": "encrypted" - } - }, - "Iops": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents \n the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline \n performance of the volume and the rate at which the volume accumulates I/O credits for bursting.

\n

The following are the supported values for each volume type:

\n \n

\n io1 and io2 volumes support up to 64,000 IOPS only on \n Instances built on the Nitro System. Other instance families support performance \n up to 32,000 IOPS.

\n

This parameter is required for io1 and io2 volumes.\n The default for gp3 volumes is 3,000 IOPS.\n This parameter is not supported for gp2, st1, sc1, or standard volumes.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.ec2#KmsKeyId", - "traits": { - "smithy.api#documentation": "

The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption.\n If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is\n specified, the encrypted state must be true.

\n

You can specify the KMS key using any of the following:

\n \n

Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, \n the action can appear to complete, but eventually fails.

" - } - }, - "OutpostArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

" - } - }, - "Size": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size.\n If you specify a snapshot, the default is the snapshot size. You can specify a volume \n size that is equal to or larger than the snapshot size.

\n

The following are the supported volumes sizes for each volume type:

\n " - } - }, - "SnapshotId": { - "target": "com.amazonaws.ec2#SnapshotId", - "traits": { - "smithy.api#documentation": "

The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.

" - } - }, - "VolumeType": { - "target": "com.amazonaws.ec2#VolumeType", - "traits": { - "smithy.api#documentation": "

The volume type. This parameter can be one of the following values:

\n \n \n

Throughput Optimized HDD (st1) and Cold HDD (sc1) volumes can't be used as boot volumes.

\n \n

For more information, see Amazon EBS volume types in the\n Amazon Elastic Compute Cloud User Guide.

\n

Default: gp2\n

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the volume during creation.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "MultiAttachEnabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the \n \tvolume to up to 16 Instances built on the Nitro System in the same Availability Zone. This parameter is \n \tsupported with io1 and io2 volumes only. For more information, \n \tsee \n \t\tAmazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.

" - } - }, - "Throughput": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The throughput to provision for a volume, with a maximum of 1,000 MiB/s.

\n

This parameter is valid only for gp3 volumes.

\n

Valid Range: Minimum value of 125. Maximum value of 1000.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency \n of the request. For more information, see Ensure \n Idempotency.

", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateVpc": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateVpcRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateVpcResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a VPC with the specified CIDR blocks. For more information, see\n\t VPC CIDR blocks in the Amazon Virtual Private Cloud User Guide.

\n

You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided \n IPv6 CIDR block from Amazon's pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address \n pool that you provisioned through bring your own IP addresses (BYOIP).

\n

By default, each instance that you launch in the VPC has the default DHCP options, which\n\t\t\tinclude only a default DNS server that we provide (AmazonProvidedDNS). For more\n\t\t\tinformation, see DHCP option sets in the Amazon Virtual Private Cloud User Guide.

\n

You can specify the instance tenancy value for the VPC when you create it. You can't change\n this value for the VPC after you create it. For more information, see Dedicated Instances in the\n Amazon Elastic Compute Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#CreateVpcEndpoint": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateVpcEndpointRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateVpcEndpointResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a VPC endpoint for a specified service. An endpoint enables you to create a\n private connection between your VPC and the service. The service may be provided by Amazon Web Services,\n an Amazon Web Services Marketplace Partner, or another Amazon Web Services account. For more information, \n see the Amazon Web Services PrivateLink Guide.

" - } - }, - "com.amazonaws.ec2#CreateVpcEndpointConnectionNotification": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateVpcEndpointConnectionNotificationRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateVpcEndpointConnectionNotificationResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a connection notification for a specified VPC endpoint or VPC endpoint\n service. A connection notification notifies you of specific endpoint events. You must\n create an SNS topic to receive notifications. For more information, see Create a Topic in\n the Amazon Simple Notification Service Developer Guide.

\n

You can create a connection notification for interface endpoints only.

" - } - }, - "com.amazonaws.ec2#CreateVpcEndpointConnectionNotificationRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "ServiceId": { - "target": "com.amazonaws.ec2#VpcEndpointServiceId", - "traits": { - "smithy.api#documentation": "

The ID of the endpoint service.

" - } - }, - "VpcEndpointId": { - "target": "com.amazonaws.ec2#VpcEndpointId", - "traits": { - "smithy.api#documentation": "

The ID of the endpoint.

" - } - }, - "ConnectionNotificationArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ARN of the SNS topic for the notifications.

", - "smithy.api#required": {} - } - }, - "ConnectionEvents": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The endpoint events for which to receive notifications. Valid values are\n Accept, Connect, Delete, and\n Reject.

", - "smithy.api#required": {} - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateVpcEndpointConnectionNotificationResult": { - "type": "structure", - "members": { - "ConnectionNotification": { - "target": "com.amazonaws.ec2#ConnectionNotification", - "traits": { - "aws.protocols#ec2QueryName": "ConnectionNotification", - "smithy.api#documentation": "

Information about the notification.

", - "smithy.api#xmlName": "connectionNotification" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", - "smithy.api#xmlName": "clientToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateVpcEndpointRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "VpcEndpointType": { - "target": "com.amazonaws.ec2#VpcEndpointType", - "traits": { - "smithy.api#documentation": "

The type of endpoint.

\n

Default: Gateway

" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the VPC for the endpoint.

", - "smithy.api#required": {} - } - }, - "ServiceName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The service name.

", - "smithy.api#required": {} - } - }, - "PolicyDocument": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the\n service. The policy must be in valid JSON format. If this parameter is not specified, we\n attach a default policy that allows full access to the service.

" - } - }, - "RouteTableIds": { - "target": "com.amazonaws.ec2#VpcEndpointRouteTableIdList", - "traits": { - "smithy.api#documentation": "

(Gateway endpoint) The route table IDs.

", - "smithy.api#xmlName": "RouteTableId" - } - }, - "SubnetIds": { - "target": "com.amazonaws.ec2#VpcEndpointSubnetIdList", - "traits": { - "smithy.api#documentation": "

(Interface and Gateway Load Balancer endpoints) The IDs of the subnets in which to create an endpoint\n network interface. For a Gateway Load Balancer endpoint, you can specify only one subnet.

", - "smithy.api#xmlName": "SubnetId" - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.ec2#VpcEndpointSecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

(Interface endpoint) The IDs of the security groups to associate with the\n endpoint network interface. If this parameter is not specified, we use the default \n security group for the VPC.

", - "smithy.api#xmlName": "SecurityGroupId" - } - }, - "IpAddressType": { - "target": "com.amazonaws.ec2#IpAddressType", - "traits": { - "smithy.api#documentation": "

The IP address type for the endpoint.

" - } - }, - "DnsOptions": { - "target": "com.amazonaws.ec2#DnsOptionsSpecification", - "traits": { - "smithy.api#documentation": "

The DNS options for the endpoint.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

" - } - }, - "PrivateDnsEnabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

(Interface endpoint) Indicates whether to associate a private hosted zone with the\n specified VPC. The private hosted zone contains a record set for the default public DNS\n name for the service for the Region (for example,\n kinesis.us-east-1.amazonaws.com), which resolves to the private IP\n addresses of the endpoint network interfaces in the VPC. This enables you to make\n requests to the default public DNS name for the service instead of the public DNS names\n that are automatically generated by the VPC endpoint service.

\n

To use a private hosted zone, you must set the following VPC attributes to\n true: enableDnsHostnames and\n enableDnsSupport. Use ModifyVpcAttribute to set the VPC\n attributes.

\n

Default: true\n

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to associate with the endpoint.

", - "smithy.api#xmlName": "TagSpecification" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateVpcEndpointResult": { - "type": "structure", - "members": { - "VpcEndpoint": { - "target": "com.amazonaws.ec2#VpcEndpoint", - "traits": { - "aws.protocols#ec2QueryName": "VpcEndpoint", - "smithy.api#documentation": "

Information about the endpoint.

", - "smithy.api#xmlName": "vpcEndpoint" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", - "smithy.api#xmlName": "clientToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateVpcEndpointServiceConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateVpcEndpointServiceConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateVpcEndpointServiceConfigurationResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a VPC endpoint service to which service consumers (Amazon Web Services accounts,\n users, and IAM roles) can connect.

\n

Before you create an endpoint service, you must create one of the following for your service:

\n \n

If you set the private DNS name, you must prove that you own the private DNS domain\n name.

\n

For more information, see the Amazon Web Services PrivateLink \n\t Guide.

" - } - }, - "com.amazonaws.ec2#CreateVpcEndpointServiceConfigurationRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "AcceptanceRequired": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether requests from service consumers to create an endpoint to your service must\n be accepted manually.

" - } - }, - "PrivateDnsName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

(Interface endpoint configuration) The private DNS name to assign to the VPC endpoint service.

" - } - }, - "NetworkLoadBalancerArns": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the Network Load Balancers.

", - "smithy.api#xmlName": "NetworkLoadBalancerArn" - } - }, - "GatewayLoadBalancerArns": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the Gateway Load Balancers.

", - "smithy.api#xmlName": "GatewayLoadBalancerArn" - } - }, - "SupportedIpAddressTypes": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#documentation": "

The supported IP address types. The possible values are ipv4 and ipv6.

", - "smithy.api#xmlName": "SupportedIpAddressType" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.\n For more information, see How to ensure\n idempotency.

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to associate with the service.

", - "smithy.api#xmlName": "TagSpecification" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateVpcEndpointServiceConfigurationResult": { - "type": "structure", - "members": { - "ServiceConfiguration": { - "target": "com.amazonaws.ec2#ServiceConfiguration", - "traits": { - "aws.protocols#ec2QueryName": "ServiceConfiguration", - "smithy.api#documentation": "

Information about the service configuration.

", - "smithy.api#xmlName": "serviceConfiguration" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", - "smithy.api#xmlName": "clientToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateVpcPeeringConnection": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateVpcPeeringConnectionRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateVpcPeeringConnectionResult" - }, - "traits": { - "smithy.api#documentation": "

Requests a VPC peering connection between two VPCs: a requester VPC that you own and\n\t\t an accepter VPC with which to create the connection. The accepter VPC can belong to\n\t\t another Amazon Web Services account and can be in a different Region to the requester VPC. \n The requester VPC and accepter VPC cannot have overlapping CIDR blocks.

\n \n

Limitations and rules apply to a VPC peering connection. For more information, see \n the limitations section in the VPC Peering Guide.

\n \n

The owner of the accepter VPC must accept the peering request to activate the peering\n connection. The VPC peering connection request expires after 7 days, after which it\n cannot be accepted or rejected.

\n

If you create a VPC peering connection request between VPCs with overlapping CIDR\n blocks, the VPC peering connection has a status of failed.

" - } - }, - "com.amazonaws.ec2#CreateVpcPeeringConnectionRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "PeerOwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PeerOwnerId", - "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the accepter VPC.

\n

Default: Your Amazon Web Services account ID

", - "smithy.api#xmlName": "peerOwnerId" - } - }, - "PeerVpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PeerVpcId", - "smithy.api#documentation": "

The ID of the VPC with which you are creating the VPC peering connection. You must\n\t\t\tspecify this parameter in the request.

", - "smithy.api#xmlName": "peerVpcId" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the requester VPC. You must specify this parameter in the\n\t\t\trequest.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "vpcId" - } - }, - "PeerRegion": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The Region code for the accepter VPC, if the accepter VPC is located in a Region\n other than the Region in which you make the request.

\n

Default: The Region in which you make the request.

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to assign to the peering connection.

", - "smithy.api#xmlName": "TagSpecification" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateVpcPeeringConnectionResult": { - "type": "structure", - "members": { - "VpcPeeringConnection": { - "target": "com.amazonaws.ec2#VpcPeeringConnection", - "traits": { - "aws.protocols#ec2QueryName": "VpcPeeringConnection", - "smithy.api#documentation": "

Information about the VPC peering connection.

", - "smithy.api#xmlName": "vpcPeeringConnection" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateVpcRequest": { - "type": "structure", - "members": { - "CidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The IPv4 network range for the VPC, in CIDR notation. For example,\n\t\t 10.0.0.0/16. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

" - } - }, - "AmazonProvidedIpv6CidrBlock": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "AmazonProvidedIpv6CidrBlock", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC.\n You cannot specify the range of IP addresses, or the size of the CIDR block.

", - "smithy.api#xmlName": "amazonProvidedIpv6CidrBlock" - } - }, - "Ipv6Pool": { - "target": "com.amazonaws.ec2#Ipv6PoolEc2Id", - "traits": { - "smithy.api#documentation": "

The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.

" - } - }, - "Ipv6CidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.

\n

To let Amazon choose the IPv6 CIDR block for you, omit this parameter.

" - } - }, - "Ipv4IpamPoolId": { - "target": "com.amazonaws.ec2#IpamPoolId", - "traits": { - "smithy.api#documentation": "

The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.\n \n

" - } - }, - "Ipv4NetmaskLength": { - "target": "com.amazonaws.ec2#NetmaskLength", - "traits": { - "smithy.api#documentation": "

The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.

" - } - }, - "Ipv6IpamPoolId": { - "target": "com.amazonaws.ec2#IpamPoolId", - "traits": { - "smithy.api#documentation": "

The ID of an IPv6 IPAM pool which will be used to allocate this VPC an IPv6 CIDR. IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.

" - } - }, - "Ipv6NetmaskLength": { - "target": "com.amazonaws.ec2#NetmaskLength", - "traits": { - "smithy.api#documentation": "

The netmask length of the IPv6 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "InstanceTenancy": { - "target": "com.amazonaws.ec2#Tenancy", - "traits": { - "aws.protocols#ec2QueryName": "InstanceTenancy", - "smithy.api#documentation": "

The tenancy options for instances launched into the VPC. For default, instances\n are launched with shared tenancy by default. You can launch instances with any tenancy into a\n shared tenancy VPC. For dedicated, instances are launched as dedicated tenancy\n instances by default. You can only launch instances with a tenancy of dedicated\n or host into a dedicated tenancy VPC.

\n

\n Important: The host value cannot be used with this parameter. Use the default or dedicated values only.

\n

Default: default\n

", - "smithy.api#xmlName": "instanceTenancy" - } - }, - "Ipv6CidrBlockNetworkBorderGroup": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the address to this location.

\n

You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to assign to the VPC.

", - "smithy.api#xmlName": "TagSpecification" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateVpcResult": { - "type": "structure", - "members": { - "Vpc": { - "target": "com.amazonaws.ec2#Vpc", - "traits": { - "aws.protocols#ec2QueryName": "Vpc", - "smithy.api#documentation": "

Information about the VPC.

", - "smithy.api#xmlName": "vpc" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateVpnConnection": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateVpnConnectionRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateVpnConnectionResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a VPN connection between an existing virtual private gateway or transit\n gateway and a customer gateway. The supported connection type is\n ipsec.1.

\n

The response includes information that you need to give to your network administrator\n to configure your customer gateway.

\n \n

We strongly recommend that you use HTTPS when calling this operation because the\n response contains sensitive cryptographic information for configuring your customer\n gateway device.

\n \n

If you decide to shut down your VPN connection for any reason and later create a new\n VPN connection, you must reconfigure your customer gateway with the new information\n returned from this call.

\n

This is an idempotent operation. If you perform the operation more than once, Amazon\n EC2 doesn't return an error.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

" - } - }, - "com.amazonaws.ec2#CreateVpnConnectionRequest": { - "type": "structure", - "members": { - "CustomerGatewayId": { - "target": "com.amazonaws.ec2#CustomerGatewayId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the customer gateway.

", - "smithy.api#required": {} - } - }, - "Type": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The type of VPN connection (ipsec.1).

", - "smithy.api#required": {} - } - }, - "VpnGatewayId": { - "target": "com.amazonaws.ec2#VpnGatewayId", - "traits": { - "smithy.api#documentation": "

The ID of the virtual private gateway. If you specify a virtual private gateway, you\n cannot specify a transit gateway.

" - } - }, - "TransitGatewayId": { - "target": "com.amazonaws.ec2#TransitGatewayId", - "traits": { - "smithy.api#documentation": "

The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private\n gateway.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "Options": { - "target": "com.amazonaws.ec2#VpnConnectionOptionsSpecification", - "traits": { - "aws.protocols#ec2QueryName": "Options", - "smithy.api#documentation": "

The options for the VPN connection.

", - "smithy.api#xmlName": "options" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the VPN connection.

", - "smithy.api#xmlName": "TagSpecification" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for CreateVpnConnection.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateVpnConnectionResult": { - "type": "structure", - "members": { - "VpnConnection": { - "target": "com.amazonaws.ec2#VpnConnection", - "traits": { - "aws.protocols#ec2QueryName": "VpnConnection", - "smithy.api#documentation": "

Information about the VPN connection.

", - "smithy.api#xmlName": "vpnConnection" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of CreateVpnConnection.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreateVpnConnectionRoute": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateVpnConnectionRouteRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Creates a static route associated with a VPN connection between an existing virtual\n private gateway and a VPN customer gateway. The static route allows traffic to be routed\n from the virtual private gateway to the VPN customer gateway.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

" - } - }, - "com.amazonaws.ec2#CreateVpnConnectionRouteRequest": { - "type": "structure", - "members": { - "DestinationCidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The CIDR block associated with the local subnet of the customer network.

", - "smithy.api#required": {} - } - }, - "VpnConnectionId": { - "target": "com.amazonaws.ec2#VpnConnectionId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the VPN connection.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for CreateVpnConnectionRoute.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateVpnGateway": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#CreateVpnGatewayRequest" - }, - "output": { - "target": "com.amazonaws.ec2#CreateVpnGatewayResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a virtual private gateway. A virtual private gateway is the endpoint on the\n VPC side of your VPN connection. You can create a virtual private gateway before\n creating the VPC itself.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

" - } - }, - "com.amazonaws.ec2#CreateVpnGatewayRequest": { - "type": "structure", - "members": { - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The Availability Zone for the virtual private gateway.

" - } - }, - "Type": { - "target": "com.amazonaws.ec2#GatewayType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The type of VPN connection this virtual private gateway supports.

", - "smithy.api#required": {} - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the virtual private gateway.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "AmazonSideAsn": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

A private Autonomous System Number (ASN) for the Amazon side of a BGP session. If\n you're using a 16-bit ASN, it must be in the 64512 to 65534 range. If you're using a\n 32-bit ASN, it must be in the 4200000000 to 4294967294 range.

\n

Default: 64512

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for CreateVpnGateway.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#CreateVpnGatewayResult": { - "type": "structure", - "members": { - "VpnGateway": { - "target": "com.amazonaws.ec2#VpnGateway", - "traits": { - "aws.protocols#ec2QueryName": "VpnGateway", - "smithy.api#documentation": "

Information about the virtual private gateway.

", - "smithy.api#xmlName": "vpnGateway" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of CreateVpnGateway.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#CreditSpecification": { - "type": "structure", - "members": { - "CpuCredits": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CpuCredits", - "smithy.api#documentation": "

The credit option for CPU usage of a T instance.

\n

Valid values: standard | unlimited\n

", - "smithy.api#xmlName": "cpuCredits" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the credit option for CPU usage of a T instance.

" - } - }, - "com.amazonaws.ec2#CreditSpecificationRequest": { - "type": "structure", - "members": { - "CpuCredits": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The credit option for CPU usage of a T instance.

\n

Valid values: standard | unlimited\n

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The credit option for CPU usage of a T instance.

" - } - }, - "com.amazonaws.ec2#CurrencyCodeValues": { - "type": "enum", - "members": { - "USD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "USD" - } - } - } - }, - "com.amazonaws.ec2#CurrentGenerationFlag": { - "type": "boolean" - }, - "com.amazonaws.ec2#CustomerGateway": { - "type": "structure", - "members": { - "BgpAsn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "BgpAsn", - "smithy.api#documentation": "

The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number\n (ASN).

", - "smithy.api#xmlName": "bgpAsn" - } - }, - "CustomerGatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CustomerGatewayId", - "smithy.api#documentation": "

The ID of the customer gateway.

", - "smithy.api#xmlName": "customerGatewayId" - } - }, - "IpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "IpAddress", - "smithy.api#documentation": "

The IP address of the customer gateway device's outside interface.

", - "smithy.api#xmlName": "ipAddress" - } - }, - "CertificateArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CertificateArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the customer gateway certificate.

", - "smithy.api#xmlName": "certificateArn" - } - }, - "State": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The current state of the customer gateway (pending | available | deleting |\n deleted).

", - "smithy.api#xmlName": "state" - } - }, - "Type": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Type", - "smithy.api#documentation": "

The type of VPN connection the customer gateway supports\n (ipsec.1).

", - "smithy.api#xmlName": "type" - } - }, - "DeviceName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DeviceName", - "smithy.api#documentation": "

The name of customer gateway device.

", - "smithy.api#xmlName": "deviceName" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the customer gateway.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a customer gateway.

" - } - }, - "com.amazonaws.ec2#CustomerGatewayId": { - "type": "string" - }, - "com.amazonaws.ec2#CustomerGatewayIdStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#CustomerGatewayId", - "traits": { - "smithy.api#xmlName": "CustomerGatewayId" - } - } - }, - "com.amazonaws.ec2#CustomerGatewayList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#CustomerGateway", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#DITMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 5, - "max": 100 - } - } - }, - "com.amazonaws.ec2#DITOMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 5, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#DataQueries": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#DataQuery" - } - }, - "com.amazonaws.ec2#DataQuery": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A user-defined ID associated with a data query that's returned in the dataResponse identifying the query. For example, if you set the Id to MyQuery01in the query, the dataResponse identifies the query as MyQuery01.

" - } - }, - "Source": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The Region or Availability Zone that's the source for the data query. For example, us-east-1.

" - } - }, - "Destination": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The Region or Availability Zone that's the target for the data query. For example, eu-north-1.

" - } - }, - "Metric": { - "target": "com.amazonaws.ec2#MetricType", - "traits": { - "smithy.api#documentation": "

The metric, aggregation-latency, indicating that network latency is aggregated for the query. This is the only supported metric.

" - } - }, - "Statistic": { - "target": "com.amazonaws.ec2#StatisticType", - "traits": { - "smithy.api#documentation": "

The metric data aggregation period, p50, between the specified startDate and endDate. For example, a metric of five_minutes is the median of all the data points gathered within those five minutes. p50 is the only supported metric.

" - } - }, - "Period": { - "target": "com.amazonaws.ec2#PeriodType", - "traits": { - "smithy.api#documentation": "

The aggregation period used for the data query.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A query used for retrieving network health data.

" - } - }, - "com.amazonaws.ec2#DataResponse": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Id", - "smithy.api#documentation": "

The ID passed in the DataQuery.

", - "smithy.api#xmlName": "id" - } - }, - "Source": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Source", - "smithy.api#documentation": "

The Region or Availability Zone that's the source for the data query. For example, us-east-1.

", - "smithy.api#xmlName": "source" - } - }, - "Destination": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Destination", - "smithy.api#documentation": "

The Region or Availability Zone that's the destination for the data query. For example, eu-west-1.

", - "smithy.api#xmlName": "destination" - } - }, - "Metric": { - "target": "com.amazonaws.ec2#MetricType", - "traits": { - "aws.protocols#ec2QueryName": "Metric", - "smithy.api#documentation": "

The metric used for the network performance request. Only aggregate-latency is supported, which shows network latency during a specified period.

", - "smithy.api#xmlName": "metric" - } - }, - "Statistic": { - "target": "com.amazonaws.ec2#StatisticType", - "traits": { - "aws.protocols#ec2QueryName": "Statistic", - "smithy.api#documentation": "

The statistic used for the network performance request.

", - "smithy.api#xmlName": "statistic" - } - }, - "Period": { - "target": "com.amazonaws.ec2#PeriodType", - "traits": { - "aws.protocols#ec2QueryName": "Period", - "smithy.api#documentation": "

The period used for the network performance request.

", - "smithy.api#xmlName": "period" - } - }, - "MetricPoints": { - "target": "com.amazonaws.ec2#MetricPoints", - "traits": { - "aws.protocols#ec2QueryName": "MetricPointSet", - "smithy.api#documentation": "

A list of MetricPoint objects.

", - "smithy.api#xmlName": "metricPointSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

The response to a DataQuery.

" - } - }, - "com.amazonaws.ec2#DataResponses": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#DataResponse", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#DatafeedSubscriptionState": { - "type": "enum", - "members": { - "Active": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Active" - } - }, - "Inactive": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Inactive" - } - } - } - }, - "com.amazonaws.ec2#DateTime": { - "type": "timestamp" - }, - "com.amazonaws.ec2#DedicatedHostFlag": { - "type": "boolean" - }, - "com.amazonaws.ec2#DedicatedHostId": { - "type": "string" - }, - "com.amazonaws.ec2#DedicatedHostIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#DedicatedHostId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#DefaultNetworkCardIndex": { - "type": "integer" - }, - "com.amazonaws.ec2#DefaultRouteTableAssociationValue": { - "type": "enum", - "members": { - "enable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enable" - } - }, - "disable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disable" - } - } - } - }, - "com.amazonaws.ec2#DefaultRouteTablePropagationValue": { - "type": "enum", - "members": { - "enable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enable" - } - }, - "disable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disable" - } - } - } - }, - "com.amazonaws.ec2#DefaultTargetCapacityType": { - "type": "enum", - "members": { - "SPOT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "spot" - } - }, - "ON_DEMAND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "on-demand" - } - } - } - }, - "com.amazonaws.ec2#DefaultingDhcpOptionsId": { - "type": "string" - }, - "com.amazonaws.ec2#DeleteCarrierGateway": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteCarrierGatewayRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteCarrierGatewayResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes a carrier gateway.

\n \n

If you do not delete the route that contains the carrier gateway as the\n Target, the route is a blackhole route. For information about how to delete a route, see \n DeleteRoute.

\n " - } - }, - "com.amazonaws.ec2#DeleteCarrierGatewayRequest": { - "type": "structure", - "members": { - "CarrierGatewayId": { - "target": "com.amazonaws.ec2#CarrierGatewayId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the carrier gateway.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteCarrierGatewayResult": { - "type": "structure", - "members": { - "CarrierGateway": { - "target": "com.amazonaws.ec2#CarrierGateway", - "traits": { - "aws.protocols#ec2QueryName": "CarrierGateway", - "smithy.api#documentation": "

Information about the carrier gateway.

", - "smithy.api#xmlName": "carrierGateway" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteClientVpnEndpoint": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteClientVpnEndpointRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteClientVpnEndpointResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified Client VPN endpoint. You must disassociate all target networks before you \n\t\t\tcan delete a Client VPN endpoint.

" - } - }, - "com.amazonaws.ec2#DeleteClientVpnEndpointRequest": { - "type": "structure", - "members": { - "ClientVpnEndpointId": { - "target": "com.amazonaws.ec2#ClientVpnEndpointId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Client VPN to be deleted.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteClientVpnEndpointResult": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.ec2#ClientVpnEndpointStatus", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The current state of the Client VPN endpoint.

", - "smithy.api#xmlName": "status" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteClientVpnRoute": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteClientVpnRouteRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteClientVpnRouteResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes a route from a Client VPN endpoint. You can only delete routes that you manually added using \n\t\t\tthe CreateClientVpnRoute action. You cannot delete routes that were \n\t\t\tautomatically added when associating a subnet. To remove routes that have been automatically added, \n\t\t\tdisassociate the target subnet from the Client VPN endpoint.

" - } - }, - "com.amazonaws.ec2#DeleteClientVpnRouteRequest": { - "type": "structure", - "members": { - "ClientVpnEndpointId": { - "target": "com.amazonaws.ec2#ClientVpnEndpointId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Client VPN endpoint from which the route is to be deleted.

", - "smithy.api#required": {} - } - }, - "TargetVpcSubnetId": { - "target": "com.amazonaws.ec2#SubnetId", - "traits": { - "smithy.api#documentation": "

The ID of the target subnet used by the route.

" - } - }, - "DestinationCidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, of the route to be deleted.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteClientVpnRouteResult": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.ec2#ClientVpnRouteStatus", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The current state of the route.

", - "smithy.api#xmlName": "status" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteCoipCidr": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteCoipCidrRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteCoipCidrResult" - }, - "traits": { - "smithy.api#documentation": "

\n Deletes a range of customer-owned IP addresses.\n

" - } - }, - "com.amazonaws.ec2#DeleteCoipCidrRequest": { - "type": "structure", - "members": { - "Cidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A customer-owned IP address range that you want to delete.

", - "smithy.api#required": {} - } - }, - "CoipPoolId": { - "target": "com.amazonaws.ec2#Ipv4PoolCoipId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

\n The ID of the customer-owned address pool. \n

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteCoipCidrResult": { - "type": "structure", - "members": { - "CoipCidr": { - "target": "com.amazonaws.ec2#CoipCidr", - "traits": { - "aws.protocols#ec2QueryName": "CoipCidr", - "smithy.api#documentation": "

\n Information about a range of customer-owned IP addresses.\n

", - "smithy.api#xmlName": "coipCidr" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteCoipPool": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteCoipPoolRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteCoipPoolResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes a pool of customer-owned IP (CoIP) addresses.

" - } - }, - "com.amazonaws.ec2#DeleteCoipPoolRequest": { - "type": "structure", - "members": { - "CoipPoolId": { - "target": "com.amazonaws.ec2#Ipv4PoolCoipId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the CoIP pool that you want to delete.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteCoipPoolResult": { - "type": "structure", - "members": { - "CoipPool": { - "target": "com.amazonaws.ec2#CoipPool", - "traits": { - "aws.protocols#ec2QueryName": "CoipPool", - "smithy.api#documentation": "

Information about the CoIP address pool.

", - "smithy.api#xmlName": "coipPool" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteCustomerGateway": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteCustomerGatewayRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified customer gateway. You must delete the VPN connection before you\n can delete the customer gateway.

" - } - }, - "com.amazonaws.ec2#DeleteCustomerGatewayRequest": { - "type": "structure", - "members": { - "CustomerGatewayId": { - "target": "com.amazonaws.ec2#CustomerGatewayId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the customer gateway.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for DeleteCustomerGateway.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteDhcpOptions": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteDhcpOptionsRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#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.

" - } - }, - "com.amazonaws.ec2#DeleteDhcpOptionsRequest": { - "type": "structure", - "members": { - "DhcpOptionsId": { - "target": "com.amazonaws.ec2#DhcpOptionsId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the DHCP options set.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteEgressOnlyInternetGateway": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteEgressOnlyInternetGatewayRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteEgressOnlyInternetGatewayResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes an egress-only internet gateway.

" - } - }, - "com.amazonaws.ec2#DeleteEgressOnlyInternetGatewayRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "EgressOnlyInternetGatewayId": { - "target": "com.amazonaws.ec2#EgressOnlyInternetGatewayId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the egress-only internet gateway.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteEgressOnlyInternetGatewayResult": { - "type": "structure", - "members": { - "ReturnCode": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "ReturnCode", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", - "smithy.api#xmlName": "returnCode" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteFleetError": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.ec2#DeleteFleetErrorCode", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The error code.

", - "smithy.api#xmlName": "code" - } - }, - "Message": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "

The description for the error code.

", - "smithy.api#xmlName": "message" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an EC2 Fleet error.

" - } - }, - "com.amazonaws.ec2#DeleteFleetErrorCode": { - "type": "enum", - "members": { - "FLEET_ID_DOES_NOT_EXIST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "fleetIdDoesNotExist" - } - }, - "FLEET_ID_MALFORMED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "fleetIdMalformed" - } - }, - "FLEET_NOT_IN_DELETABLE_STATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "fleetNotInDeletableState" - } - }, - "UNEXPECTED_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unexpectedError" - } - } - } - }, - "com.amazonaws.ec2#DeleteFleetErrorItem": { - "type": "structure", - "members": { - "Error": { - "target": "com.amazonaws.ec2#DeleteFleetError", - "traits": { - "aws.protocols#ec2QueryName": "Error", - "smithy.api#documentation": "

The error.

", - "smithy.api#xmlName": "error" - } - }, - "FleetId": { - "target": "com.amazonaws.ec2#FleetId", - "traits": { - "aws.protocols#ec2QueryName": "FleetId", - "smithy.api#documentation": "

The ID of the EC2 Fleet.

", - "smithy.api#xmlName": "fleetId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an EC2 Fleet that was not successfully deleted.

" - } - }, - "com.amazonaws.ec2#DeleteFleetErrorSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#DeleteFleetErrorItem", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#DeleteFleetSuccessItem": { - "type": "structure", - "members": { - "CurrentFleetState": { - "target": "com.amazonaws.ec2#FleetStateCode", - "traits": { - "aws.protocols#ec2QueryName": "CurrentFleetState", - "smithy.api#documentation": "

The current state of the EC2 Fleet.

", - "smithy.api#xmlName": "currentFleetState" - } - }, - "PreviousFleetState": { - "target": "com.amazonaws.ec2#FleetStateCode", - "traits": { - "aws.protocols#ec2QueryName": "PreviousFleetState", - "smithy.api#documentation": "

The previous state of the EC2 Fleet.

", - "smithy.api#xmlName": "previousFleetState" - } - }, - "FleetId": { - "target": "com.amazonaws.ec2#FleetId", - "traits": { - "aws.protocols#ec2QueryName": "FleetId", - "smithy.api#documentation": "

The ID of the EC2 Fleet.

", - "smithy.api#xmlName": "fleetId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an EC2 Fleet that was successfully deleted.

" - } - }, - "com.amazonaws.ec2#DeleteFleetSuccessSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#DeleteFleetSuccessItem", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#DeleteFleets": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteFleetsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteFleetsResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified EC2 Fleets.

\n

After you delete an EC2 Fleet, it launches no new instances.

\n

You must also specify whether a deleted EC2 Fleet should terminate its instances. If you\n choose to terminate the instances, the EC2 Fleet enters the deleted_terminating\n state. Otherwise, the EC2 Fleet enters the deleted_running state, and the instances\n continue to run until they are interrupted or you terminate them manually.

\n

For instant fleets, EC2 Fleet must terminate the instances when the fleet is\n deleted. A deleted instant fleet with running instances is not\n supported.

\n

\n Restrictions\n

\n \n

For more information, see Delete an EC2\n Fleet in the Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#DeleteFleetsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "FleetIds": { - "target": "com.amazonaws.ec2#FleetIdSet", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IDs of the EC2 Fleets.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "FleetId" - } - }, - "TerminateInstances": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to terminate the associated instances when the EC2 Fleet is deleted. The default is to\n terminate the instances.

\n

To let the instances continue to run after the EC2 Fleet is deleted, specify\n no-terminate-instances. Supported only for fleets of type\n maintain and request.

\n

For instant fleets, you cannot specify NoTerminateInstances. A\n deleted instant fleet with running instances is not supported.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteFleetsResult": { - "type": "structure", - "members": { - "SuccessfulFleetDeletions": { - "target": "com.amazonaws.ec2#DeleteFleetSuccessSet", - "traits": { - "aws.protocols#ec2QueryName": "SuccessfulFleetDeletionSet", - "smithy.api#documentation": "

Information about the EC2 Fleets that are successfully deleted.

", - "smithy.api#xmlName": "successfulFleetDeletionSet" - } - }, - "UnsuccessfulFleetDeletions": { - "target": "com.amazonaws.ec2#DeleteFleetErrorSet", - "traits": { - "aws.protocols#ec2QueryName": "UnsuccessfulFleetDeletionSet", - "smithy.api#documentation": "

Information about the EC2 Fleets that are not successfully deleted.

", - "smithy.api#xmlName": "unsuccessfulFleetDeletionSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteFlowLogs": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteFlowLogsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteFlowLogsResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes one or more flow logs.

" - } - }, - "com.amazonaws.ec2#DeleteFlowLogsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "FlowLogIds": { - "target": "com.amazonaws.ec2#FlowLogIdList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

One or more flow log IDs.

\n

Constraint: Maximum of 1000 flow log IDs.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "FlowLogId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteFlowLogsResult": { - "type": "structure", - "members": { - "Unsuccessful": { - "target": "com.amazonaws.ec2#UnsuccessfulItemSet", - "traits": { - "aws.protocols#ec2QueryName": "Unsuccessful", - "smithy.api#documentation": "

Information about the flow logs that could not be deleted successfully.

", - "smithy.api#xmlName": "unsuccessful" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteFpgaImage": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteFpgaImageRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteFpgaImageResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified Amazon FPGA Image (AFI).

" - } - }, - "com.amazonaws.ec2#DeleteFpgaImageRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "FpgaImageId": { - "target": "com.amazonaws.ec2#FpgaImageId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the AFI.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteFpgaImageResult": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Is true if the request succeeds, and an error otherwise.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteInstanceEventWindow": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteInstanceEventWindowRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteInstanceEventWindowResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified event window.

\n

For more information, see Define event windows for scheduled\n events in the Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#DeleteInstanceEventWindowRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "ForceDelete": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Specify true to force delete the event window. Use the force delete parameter\n if the event window is currently associated with targets.

" - } - }, - "InstanceEventWindowId": { - "target": "com.amazonaws.ec2#InstanceEventWindowId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the event window.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "InstanceEventWindowId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteInstanceEventWindowResult": { - "type": "structure", - "members": { - "InstanceEventWindowState": { - "target": "com.amazonaws.ec2#InstanceEventWindowStateChange", - "traits": { - "aws.protocols#ec2QueryName": "InstanceEventWindowState", - "smithy.api#documentation": "

The state of the event window.

", - "smithy.api#xmlName": "instanceEventWindowState" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteInternetGateway": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteInternetGatewayRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified internet gateway. You must detach the internet gateway from the\n\t\t\tVPC before you can delete it.

" - } - }, - "com.amazonaws.ec2#DeleteInternetGatewayRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "InternetGatewayId": { - "target": "com.amazonaws.ec2#InternetGatewayId", - "traits": { - "aws.protocols#ec2QueryName": "InternetGatewayId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the internet gateway.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "internetGatewayId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteIpam": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteIpamRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteIpamResult" - }, - "traits": { - "smithy.api#documentation": "

Delete an IPAM. Deleting an IPAM removes all monitored data associated with the IPAM including the historical data for CIDRs.

\n

For more information, see Delete an IPAM in the Amazon VPC IPAM User Guide.\n

" - } - }, - "com.amazonaws.ec2#DeleteIpamPool": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteIpamPoolRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteIpamPoolResult" - }, - "traits": { - "smithy.api#documentation": "

Delete an IPAM pool.

\n \n

You cannot delete an IPAM pool if there are allocations in it or CIDRs provisioned to it. To release \n allocations, see ReleaseIpamPoolAllocation. To deprovision pool \n CIDRs, see DeprovisionIpamPoolCidr.

\n \n

For more information, see Delete a pool in the Amazon VPC IPAM User Guide.\n

" - } - }, - "com.amazonaws.ec2#DeleteIpamPoolRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "IpamPoolId": { - "target": "com.amazonaws.ec2#IpamPoolId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the pool to delete.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteIpamPoolResult": { - "type": "structure", - "members": { - "IpamPool": { - "target": "com.amazonaws.ec2#IpamPool", - "traits": { - "aws.protocols#ec2QueryName": "IpamPool", - "smithy.api#documentation": "

Information about the results of the deletion.

", - "smithy.api#xmlName": "ipamPool" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteIpamRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "IpamId": { - "target": "com.amazonaws.ec2#IpamId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the IPAM to delete.

", - "smithy.api#required": {} - } - }, - "Cascade": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and\n any allocations in the pools in private scopes. You cannot delete the IPAM with this option if there is a pool in your public scope. If you use this option, IPAM does the following:

\n " - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteIpamResourceDiscovery": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteIpamResourceDiscoveryRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteIpamResourceDiscoveryResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

" - } - }, - "com.amazonaws.ec2#DeleteIpamResourceDiscoveryRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "IpamResourceDiscoveryId": { - "target": "com.amazonaws.ec2#IpamResourceDiscoveryId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IPAM resource discovery ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteIpamResourceDiscoveryResult": { - "type": "structure", - "members": { - "IpamResourceDiscovery": { - "target": "com.amazonaws.ec2#IpamResourceDiscovery", - "traits": { - "aws.protocols#ec2QueryName": "IpamResourceDiscovery", - "smithy.api#documentation": "

The IPAM resource discovery.

", - "smithy.api#xmlName": "ipamResourceDiscovery" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteIpamResult": { - "type": "structure", - "members": { - "Ipam": { - "target": "com.amazonaws.ec2#Ipam", - "traits": { - "aws.protocols#ec2QueryName": "Ipam", - "smithy.api#documentation": "

Information about the results of the deletion.

", - "smithy.api#xmlName": "ipam" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteIpamScope": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteIpamScopeRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteIpamScopeResult" - }, - "traits": { - "smithy.api#documentation": "

Delete the scope for an IPAM. You cannot delete the default scopes.

\n

For more information, see Delete a scope in the Amazon VPC IPAM User Guide.\n

" - } - }, - "com.amazonaws.ec2#DeleteIpamScopeRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "IpamScopeId": { - "target": "com.amazonaws.ec2#IpamScopeId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the scope to delete.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteIpamScopeResult": { - "type": "structure", - "members": { - "IpamScope": { - "target": "com.amazonaws.ec2#IpamScope", - "traits": { - "aws.protocols#ec2QueryName": "IpamScope", - "smithy.api#documentation": "

Information about the results of the deletion.

", - "smithy.api#xmlName": "ipamScope" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteKeyPair": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteKeyPairRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified key pair, by removing the public key from Amazon EC2.

" - } - }, - "com.amazonaws.ec2#DeleteKeyPairRequest": { - "type": "structure", - "members": { - "KeyName": { - "target": "com.amazonaws.ec2#KeyPairName", - "traits": { - "smithy.api#documentation": "

The name of the key pair.

" - } - }, - "KeyPairId": { - "target": "com.amazonaws.ec2#KeyPairId", - "traits": { - "smithy.api#documentation": "

The ID of the key pair.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteLaunchTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteLaunchTemplateRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteLaunchTemplateResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes a launch template. Deleting a launch template deletes all of its\n versions.

" - } - }, - "com.amazonaws.ec2#DeleteLaunchTemplateRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" - } - }, - "LaunchTemplateId": { - "target": "com.amazonaws.ec2#LaunchTemplateId", - "traits": { - "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify either the LaunchTemplateId or the\n LaunchTemplateName, but not both.

" - } - }, - "LaunchTemplateName": { - "target": "com.amazonaws.ec2#LaunchTemplateName", - "traits": { - "smithy.api#documentation": "

The name of the launch template.

\n

You must specify either the LaunchTemplateName or the\n LaunchTemplateId, but not both.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteLaunchTemplateResult": { - "type": "structure", - "members": { - "LaunchTemplate": { - "target": "com.amazonaws.ec2#LaunchTemplate", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplate", - "smithy.api#documentation": "

Information about the launch template.

", - "smithy.api#xmlName": "launchTemplate" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteLaunchTemplateVersions": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteLaunchTemplateVersionsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteLaunchTemplateVersionsResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes one or more versions of a launch template. You cannot delete the default\n version of a launch template; you must first assign a different version as the default.\n If the default version is the only version for the launch template, you must delete the\n entire launch template using DeleteLaunchTemplate.

" - } - }, - "com.amazonaws.ec2#DeleteLaunchTemplateVersionsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" - } - }, - "LaunchTemplateId": { - "target": "com.amazonaws.ec2#LaunchTemplateId", - "traits": { - "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify either the LaunchTemplateId or the\n LaunchTemplateName, but not both.

" - } - }, - "LaunchTemplateName": { - "target": "com.amazonaws.ec2#LaunchTemplateName", - "traits": { - "smithy.api#documentation": "

The name of the launch template.

\n

You must specify either the LaunchTemplateName or the\n LaunchTemplateId, but not both.

" - } - }, - "Versions": { - "target": "com.amazonaws.ec2#VersionStringList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The version numbers of one or more launch template versions to delete.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "LaunchTemplateVersion" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteLaunchTemplateVersionsResponseErrorItem": { - "type": "structure", - "members": { - "LaunchTemplateId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateId", - "smithy.api#documentation": "

The ID of the launch template.

", - "smithy.api#xmlName": "launchTemplateId" - } - }, - "LaunchTemplateName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateName", - "smithy.api#documentation": "

The name of the launch template.

", - "smithy.api#xmlName": "launchTemplateName" - } - }, - "VersionNumber": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "aws.protocols#ec2QueryName": "VersionNumber", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The version number of the launch template.

", - "smithy.api#xmlName": "versionNumber" - } - }, - "ResponseError": { - "target": "com.amazonaws.ec2#ResponseError", - "traits": { - "aws.protocols#ec2QueryName": "ResponseError", - "smithy.api#documentation": "

Information about the error.

", - "smithy.api#xmlName": "responseError" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a launch template version that could not be deleted.

" - } - }, - "com.amazonaws.ec2#DeleteLaunchTemplateVersionsResponseErrorSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#DeleteLaunchTemplateVersionsResponseErrorItem", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#DeleteLaunchTemplateVersionsResponseSuccessItem": { - "type": "structure", - "members": { - "LaunchTemplateId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateId", - "smithy.api#documentation": "

The ID of the launch template.

", - "smithy.api#xmlName": "launchTemplateId" - } - }, - "LaunchTemplateName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateName", - "smithy.api#documentation": "

The name of the launch template.

", - "smithy.api#xmlName": "launchTemplateName" - } - }, - "VersionNumber": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "aws.protocols#ec2QueryName": "VersionNumber", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The version number of the launch template.

", - "smithy.api#xmlName": "versionNumber" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a launch template version that was successfully deleted.

" - } - }, - "com.amazonaws.ec2#DeleteLaunchTemplateVersionsResponseSuccessSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#DeleteLaunchTemplateVersionsResponseSuccessItem", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#DeleteLaunchTemplateVersionsResult": { - "type": "structure", - "members": { - "SuccessfullyDeletedLaunchTemplateVersions": { - "target": "com.amazonaws.ec2#DeleteLaunchTemplateVersionsResponseSuccessSet", - "traits": { - "aws.protocols#ec2QueryName": "SuccessfullyDeletedLaunchTemplateVersionSet", - "smithy.api#documentation": "

Information about the launch template versions that were successfully deleted.

", - "smithy.api#xmlName": "successfullyDeletedLaunchTemplateVersionSet" - } - }, - "UnsuccessfullyDeletedLaunchTemplateVersions": { - "target": "com.amazonaws.ec2#DeleteLaunchTemplateVersionsResponseErrorSet", - "traits": { - "aws.protocols#ec2QueryName": "UnsuccessfullyDeletedLaunchTemplateVersionSet", - "smithy.api#documentation": "

Information about the launch template versions that could not be deleted.

", - "smithy.api#xmlName": "unsuccessfullyDeletedLaunchTemplateVersionSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteLocalGatewayRoute": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteLocalGatewayRouteRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteLocalGatewayRouteResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified route from the specified local gateway route table.

" - } - }, - "com.amazonaws.ec2#DeleteLocalGatewayRouteRequest": { - "type": "structure", - "members": { - "DestinationCidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The CIDR range for the route. This must match the CIDR for the route exactly.

" - } - }, - "LocalGatewayRouteTableId": { - "target": "com.amazonaws.ec2#LocalGatewayRoutetableId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the local gateway route table.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "DestinationPrefixListId": { - "target": "com.amazonaws.ec2#PrefixListResourceId", - "traits": { - "smithy.api#documentation": "

\n Use a prefix list in place of DestinationCidrBlock. You cannot use \n DestinationPrefixListId and DestinationCidrBlock in the same request.\n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteLocalGatewayRouteResult": { - "type": "structure", - "members": { - "Route": { - "target": "com.amazonaws.ec2#LocalGatewayRoute", - "traits": { - "aws.protocols#ec2QueryName": "Route", - "smithy.api#documentation": "

Information about the route.

", - "smithy.api#xmlName": "route" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteLocalGatewayRouteTable": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteLocalGatewayRouteTableRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteLocalGatewayRouteTableResult" - }, - "traits": { - "smithy.api#documentation": "

\n Deletes a local gateway route table.\n

" - } - }, - "com.amazonaws.ec2#DeleteLocalGatewayRouteTableRequest": { - "type": "structure", - "members": { - "LocalGatewayRouteTableId": { - "target": "com.amazonaws.ec2#LocalGatewayRoutetableId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

\n The ID of the local gateway route table.\n

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteLocalGatewayRouteTableResult": { - "type": "structure", - "members": { - "LocalGatewayRouteTable": { - "target": "com.amazonaws.ec2#LocalGatewayRouteTable", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayRouteTable", - "smithy.api#documentation": "

Information about the local gateway route table.

", - "smithy.api#xmlName": "localGatewayRouteTable" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationResult" - }, - "traits": { - "smithy.api#documentation": "

\n Deletes a local gateway route table virtual interface group association.\n

" - } - }, - "com.amazonaws.ec2#DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationRequest": { - "type": "structure", - "members": { - "LocalGatewayRouteTableVirtualInterfaceGroupAssociationId": { - "target": "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociationId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

\n The ID of the local gateway route table virtual interface group association.\n

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationResult": { - "type": "structure", - "members": { - "LocalGatewayRouteTableVirtualInterfaceGroupAssociation": { - "target": "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociation", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayRouteTableVirtualInterfaceGroupAssociation", - "smithy.api#documentation": "

Information about the association.

", - "smithy.api#xmlName": "localGatewayRouteTableVirtualInterfaceGroupAssociation" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteLocalGatewayRouteTableVpcAssociation": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteLocalGatewayRouteTableVpcAssociationRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteLocalGatewayRouteTableVpcAssociationResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified association between a VPC and local gateway route table.

" - } - }, - "com.amazonaws.ec2#DeleteLocalGatewayRouteTableVpcAssociationRequest": { - "type": "structure", - "members": { - "LocalGatewayRouteTableVpcAssociationId": { - "target": "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociationId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the association.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteLocalGatewayRouteTableVpcAssociationResult": { - "type": "structure", - "members": { - "LocalGatewayRouteTableVpcAssociation": { - "target": "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociation", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayRouteTableVpcAssociation", - "smithy.api#documentation": "

Information about the association.

", - "smithy.api#xmlName": "localGatewayRouteTableVpcAssociation" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteManagedPrefixList": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteManagedPrefixListRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteManagedPrefixListResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified managed prefix list. You must first remove all references to the prefix list in your resources.

" - } - }, - "com.amazonaws.ec2#DeleteManagedPrefixListRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "PrefixListId": { - "target": "com.amazonaws.ec2#PrefixListResourceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the prefix list.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteManagedPrefixListResult": { - "type": "structure", - "members": { - "PrefixList": { - "target": "com.amazonaws.ec2#ManagedPrefixList", - "traits": { - "aws.protocols#ec2QueryName": "PrefixList", - "smithy.api#documentation": "

Information about the prefix list.

", - "smithy.api#xmlName": "prefixList" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteNatGateway": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteNatGatewayRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteNatGatewayResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified NAT gateway. Deleting a public NAT gateway disassociates its Elastic IP address, \n but does not release the address from your account. Deleting a NAT gateway does not delete any NAT gateway \n routes in your route tables.

" - } - }, - "com.amazonaws.ec2#DeleteNatGatewayRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "NatGatewayId": { - "target": "com.amazonaws.ec2#NatGatewayId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the NAT gateway.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "NatGatewayId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteNatGatewayResult": { - "type": "structure", - "members": { - "NatGatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NatGatewayId", - "smithy.api#documentation": "

The ID of the NAT gateway.

", - "smithy.api#xmlName": "natGatewayId" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteNetworkAcl": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteNetworkAclRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#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.

" - } - }, - "com.amazonaws.ec2#DeleteNetworkAclEntry": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteNetworkAclEntryRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified ingress or egress entry (rule) from the specified network ACL.

" - } - }, - "com.amazonaws.ec2#DeleteNetworkAclEntryRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "Egress": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Egress", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the rule is an egress rule.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "egress" - } - }, - "NetworkAclId": { - "target": "com.amazonaws.ec2#NetworkAclId", - "traits": { - "aws.protocols#ec2QueryName": "NetworkAclId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the network ACL.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "networkAclId" - } - }, - "RuleNumber": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "RuleNumber", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The rule number of the entry to delete.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "ruleNumber" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteNetworkAclRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "NetworkAclId": { - "target": "com.amazonaws.ec2#NetworkAclId", - "traits": { - "aws.protocols#ec2QueryName": "NetworkAclId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the network ACL.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "networkAclId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteNetworkInsightsAccessScope": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified Network Access Scope.

" - } - }, - "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeAnalysis": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeAnalysisRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeAnalysisResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified Network Access Scope analysis.

" - } - }, - "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeAnalysisRequest": { - "type": "structure", - "members": { - "NetworkInsightsAccessScopeAnalysisId": { - "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Network Access Scope analysis.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeAnalysisResult": { - "type": "structure", - "members": { - "NetworkInsightsAccessScopeAnalysisId": { - "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisId", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeAnalysisId", - "smithy.api#documentation": "

The ID of the Network Access Scope analysis.

", - "smithy.api#xmlName": "networkInsightsAccessScopeAnalysisId" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "NetworkInsightsAccessScopeId": { - "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Network Access Scope.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeResult": { - "type": "structure", - "members": { - "NetworkInsightsAccessScopeId": { - "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeId", - "smithy.api#documentation": "

The ID of the Network Access Scope.

", - "smithy.api#xmlName": "networkInsightsAccessScopeId" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteNetworkInsightsAnalysis": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteNetworkInsightsAnalysisRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteNetworkInsightsAnalysisResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified network insights analysis.

" - } - }, - "com.amazonaws.ec2#DeleteNetworkInsightsAnalysisRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "NetworkInsightsAnalysisId": { - "target": "com.amazonaws.ec2#NetworkInsightsAnalysisId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the network insights analysis.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteNetworkInsightsAnalysisResult": { - "type": "structure", - "members": { - "NetworkInsightsAnalysisId": { - "target": "com.amazonaws.ec2#NetworkInsightsAnalysisId", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInsightsAnalysisId", - "smithy.api#documentation": "

The ID of the network insights analysis.

", - "smithy.api#xmlName": "networkInsightsAnalysisId" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteNetworkInsightsPath": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteNetworkInsightsPathRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteNetworkInsightsPathResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified path.

" - } - }, - "com.amazonaws.ec2#DeleteNetworkInsightsPathRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "NetworkInsightsPathId": { - "target": "com.amazonaws.ec2#NetworkInsightsPathId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the path.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteNetworkInsightsPathResult": { - "type": "structure", - "members": { - "NetworkInsightsPathId": { - "target": "com.amazonaws.ec2#NetworkInsightsPathId", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInsightsPathId", - "smithy.api#documentation": "

The ID of the path.

", - "smithy.api#xmlName": "networkInsightsPathId" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteNetworkInterface": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteNetworkInterfaceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified network interface. You must detach the network interface before you can delete it.

" - } - }, - "com.amazonaws.ec2#DeleteNetworkInterfacePermission": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteNetworkInterfacePermissionRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteNetworkInterfacePermissionResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes a permission for a network interface. By default, you cannot delete the\n\t\t\tpermission if the account for which you're removing the permission has attached the\n\t\t\tnetwork interface to an instance. However, you can force delete the permission,\n\t\t\tregardless of any attachment.

" - } - }, - "com.amazonaws.ec2#DeleteNetworkInterfacePermissionRequest": { - "type": "structure", - "members": { - "NetworkInterfacePermissionId": { - "target": "com.amazonaws.ec2#NetworkInterfacePermissionId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the network interface permission.

", - "smithy.api#required": {} - } - }, - "Force": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Specify true to remove the permission even if the network interface is\n\t\t\tattached to an instance.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is DryRunOperation. \n\t\t\tOtherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for DeleteNetworkInterfacePermission.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteNetworkInterfacePermissionResult": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds, otherwise returns an error.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output for DeleteNetworkInterfacePermission.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteNetworkInterfaceRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#NetworkInterfaceId", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the network interface.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "networkInterfaceId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for DeleteNetworkInterface.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeletePlacementGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeletePlacementGroupRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified placement group. You must terminate all instances in the\n placement group before you can delete the placement group. For more information, see\n Placement groups in the Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#DeletePlacementGroupRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "GroupName": { - "target": "com.amazonaws.ec2#PlacementGroupName", - "traits": { - "aws.protocols#ec2QueryName": "GroupName", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the placement group.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "groupName" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeletePublicIpv4Pool": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeletePublicIpv4PoolRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeletePublicIpv4PoolResult" - }, - "traits": { - "smithy.api#documentation": "

Delete a public IPv4 pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only.

" - } - }, - "com.amazonaws.ec2#DeletePublicIpv4PoolRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "PoolId": { - "target": "com.amazonaws.ec2#Ipv4PoolEc2Id", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the public IPv4 pool you want to delete.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeletePublicIpv4PoolResult": { - "type": "structure", - "members": { - "ReturnValue": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "ReturnValue", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Information about the result of deleting the public IPv4 pool.

", - "smithy.api#xmlName": "returnValue" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteQueuedReservedInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteQueuedReservedInstancesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteQueuedReservedInstancesResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes the queued purchases for the specified Reserved Instances.

" - } - }, - "com.amazonaws.ec2#DeleteQueuedReservedInstancesError": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.ec2#DeleteQueuedReservedInstancesErrorCode", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The error code.

", - "smithy.api#xmlName": "code" - } - }, - "Message": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "

The error message.

", - "smithy.api#xmlName": "message" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the error for a Reserved Instance whose queued purchase could not be deleted.

" - } - }, - "com.amazonaws.ec2#DeleteQueuedReservedInstancesErrorCode": { - "type": "enum", - "members": { - "RESERVED_INSTANCES_ID_INVALID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "reserved-instances-id-invalid" - } - }, - "RESERVED_INSTANCES_NOT_IN_QUEUED_STATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "reserved-instances-not-in-queued-state" - } - }, - "UNEXPECTED_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unexpected-error" - } - } - } - }, - "com.amazonaws.ec2#DeleteQueuedReservedInstancesIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ReservationId", - "traits": { - "smithy.api#xmlName": "item" - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.ec2#DeleteQueuedReservedInstancesRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "ReservedInstancesIds": { - "target": "com.amazonaws.ec2#DeleteQueuedReservedInstancesIdList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IDs of the Reserved Instances.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "ReservedInstancesId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteQueuedReservedInstancesResult": { - "type": "structure", - "members": { - "SuccessfulQueuedPurchaseDeletions": { - "target": "com.amazonaws.ec2#SuccessfulQueuedPurchaseDeletionSet", - "traits": { - "aws.protocols#ec2QueryName": "SuccessfulQueuedPurchaseDeletionSet", - "smithy.api#documentation": "

Information about the queued purchases that were successfully deleted.

", - "smithy.api#xmlName": "successfulQueuedPurchaseDeletionSet" - } - }, - "FailedQueuedPurchaseDeletions": { - "target": "com.amazonaws.ec2#FailedQueuedPurchaseDeletionSet", - "traits": { - "aws.protocols#ec2QueryName": "FailedQueuedPurchaseDeletionSet", - "smithy.api#documentation": "

Information about the queued purchases that could not be deleted.

", - "smithy.api#xmlName": "failedQueuedPurchaseDeletionSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteRoute": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteRouteRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified route from the specified route table.

" - } - }, - "com.amazonaws.ec2#DeleteRouteRequest": { - "type": "structure", - "members": { - "DestinationCidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DestinationCidrBlock", - "smithy.api#documentation": "

The IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly.

", - "smithy.api#xmlName": "destinationCidrBlock" - } - }, - "DestinationIpv6CidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DestinationIpv6CidrBlock", - "smithy.api#documentation": "

The IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly.

", - "smithy.api#xmlName": "destinationIpv6CidrBlock" - } - }, - "DestinationPrefixListId": { - "target": "com.amazonaws.ec2#PrefixListResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the prefix list for the route.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "RouteTableId": { - "target": "com.amazonaws.ec2#RouteTableId", - "traits": { - "aws.protocols#ec2QueryName": "RouteTableId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the route table.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "routeTableId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteRouteTable": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteRouteTableRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#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.

" - } - }, - "com.amazonaws.ec2#DeleteRouteTableRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "RouteTableId": { - "target": "com.amazonaws.ec2#RouteTableId", - "traits": { - "aws.protocols#ec2QueryName": "RouteTableId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the route table.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "routeTableId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteSecurityGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteSecurityGroupRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Deletes a security group.

\n

If you attempt to delete a security group that is associated with an instance, or is\n\t\t\t referenced by another security group, the operation fails with\n\t\t\t\tInvalidGroup.InUse in EC2-Classic or\n\t\t\t\tDependencyViolation in EC2-VPC.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " - } - }, - "com.amazonaws.ec2#DeleteSecurityGroupRequest": { - "type": "structure", - "members": { - "GroupId": { - "target": "com.amazonaws.ec2#SecurityGroupId", - "traits": { - "smithy.api#documentation": "

The ID of the security group. Required for a nondefault VPC.

" - } - }, - "GroupName": { - "target": "com.amazonaws.ec2#SecurityGroupName", - "traits": { - "smithy.api#documentation": "

[EC2-Classic, default VPC] The name of the security group. You can specify either the\n security group name or the security group ID. For security groups in a nondefault VPC,\n you must specify the security group ID.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteSnapshotRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified snapshot.

\n

When you make periodic snapshots of a volume, the snapshots are incremental, and only the\n blocks on the device that have changed since your last snapshot are saved in the new snapshot.\n When you delete a snapshot, only the data not needed for any other snapshot is removed. So\n regardless of which prior snapshots have been deleted, all active snapshots will have access\n to all the information needed to restore the volume.

\n

You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI.\n You must first de-register the AMI before you can delete the snapshot.

\n

For more information, see Delete an Amazon EBS snapshot in the\n Amazon Elastic Compute Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#DeleteSnapshotRequest": { - "type": "structure", - "members": { - "SnapshotId": { - "target": "com.amazonaws.ec2#SnapshotId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the EBS snapshot.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteSpotDatafeedSubscription": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteSpotDatafeedSubscriptionRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Deletes the data feed for Spot Instances.

" - } - }, - "com.amazonaws.ec2#DeleteSpotDatafeedSubscriptionRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for DeleteSpotDatafeedSubscription.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteSubnet": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteSubnetRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.

" - } - }, - "com.amazonaws.ec2#DeleteSubnetCidrReservation": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteSubnetCidrReservationRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteSubnetCidrReservationResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes a subnet CIDR reservation.

" - } - }, - "com.amazonaws.ec2#DeleteSubnetCidrReservationRequest": { - "type": "structure", - "members": { - "SubnetCidrReservationId": { - "target": "com.amazonaws.ec2#SubnetCidrReservationId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the subnet CIDR reservation.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteSubnetCidrReservationResult": { - "type": "structure", - "members": { - "DeletedSubnetCidrReservation": { - "target": "com.amazonaws.ec2#SubnetCidrReservation", - "traits": { - "aws.protocols#ec2QueryName": "DeletedSubnetCidrReservation", - "smithy.api#documentation": "

Information about the deleted subnet CIDR reservation.

", - "smithy.api#xmlName": "deletedSubnetCidrReservation" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteSubnetRequest": { - "type": "structure", - "members": { - "SubnetId": { - "target": "com.amazonaws.ec2#SubnetId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the subnet.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteTags": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteTagsRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified set of tags from the specified set of resources.

\n

To list the current tags, use DescribeTags. For more information about\n tags, see Tag\n your Amazon EC2 resources in the Amazon Elastic Compute Cloud User\n Guide.

" - } - }, - "com.amazonaws.ec2#DeleteTagsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "Resources": { - "target": "com.amazonaws.ec2#ResourceIdList", - "traits": { - "aws.protocols#ec2QueryName": "ResourceId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IDs of the resources, separated by spaces.

\n

Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "resourceId" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "Tag", - "smithy.api#documentation": "

The tags to delete. Specify a tag key and an optional tag value to delete\n specific tags. If you specify a tag key without a tag value, we delete any tag with this\n key regardless of its value. If you specify a tag key with an empty string as the tag\n value, we delete the tag only if its value is an empty string.

\n

If you omit this parameter, we delete all user-defined tags for the specified\n resources. We do not delete Amazon Web Services-generated tags (tags that have the aws:\n prefix).

\n

Constraints: Up to 1000 tags.

", - "smithy.api#xmlName": "tag" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteTrafficMirrorFilter": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteTrafficMirrorFilterRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteTrafficMirrorFilterResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified Traffic Mirror filter.

\n

You cannot delete a Traffic Mirror filter that is in use by a Traffic Mirror session.

" - } - }, - "com.amazonaws.ec2#DeleteTrafficMirrorFilterRequest": { - "type": "structure", - "members": { - "TrafficMirrorFilterId": { - "target": "com.amazonaws.ec2#TrafficMirrorFilterId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Traffic Mirror filter.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteTrafficMirrorFilterResult": { - "type": "structure", - "members": { - "TrafficMirrorFilterId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TrafficMirrorFilterId", - "smithy.api#documentation": "

The ID of the Traffic Mirror filter.

", - "smithy.api#xmlName": "trafficMirrorFilterId" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteTrafficMirrorFilterRule": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteTrafficMirrorFilterRuleRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteTrafficMirrorFilterRuleResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified Traffic Mirror rule.

" - } - }, - "com.amazonaws.ec2#DeleteTrafficMirrorFilterRuleRequest": { - "type": "structure", - "members": { - "TrafficMirrorFilterRuleId": { - "target": "com.amazonaws.ec2#TrafficMirrorFilterRuleIdWithResolver", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Traffic Mirror rule.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteTrafficMirrorFilterRuleResult": { - "type": "structure", - "members": { - "TrafficMirrorFilterRuleId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TrafficMirrorFilterRuleId", - "smithy.api#documentation": "

The ID of the deleted Traffic Mirror rule.

", - "smithy.api#xmlName": "trafficMirrorFilterRuleId" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteTrafficMirrorSession": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteTrafficMirrorSessionRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteTrafficMirrorSessionResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified Traffic Mirror session.

" - } - }, - "com.amazonaws.ec2#DeleteTrafficMirrorSessionRequest": { - "type": "structure", - "members": { - "TrafficMirrorSessionId": { - "target": "com.amazonaws.ec2#TrafficMirrorSessionId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Traffic Mirror session.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteTrafficMirrorSessionResult": { - "type": "structure", - "members": { - "TrafficMirrorSessionId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TrafficMirrorSessionId", - "smithy.api#documentation": "

The ID of the deleted Traffic Mirror session.

", - "smithy.api#xmlName": "trafficMirrorSessionId" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteTrafficMirrorTarget": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteTrafficMirrorTargetRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteTrafficMirrorTargetResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified Traffic Mirror target.

\n

You cannot delete a Traffic Mirror target that is in use by a Traffic Mirror session.

" - } - }, - "com.amazonaws.ec2#DeleteTrafficMirrorTargetRequest": { - "type": "structure", - "members": { - "TrafficMirrorTargetId": { - "target": "com.amazonaws.ec2#TrafficMirrorTargetId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Traffic Mirror target.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteTrafficMirrorTargetResult": { - "type": "structure", - "members": { - "TrafficMirrorTargetId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TrafficMirrorTargetId", - "smithy.api#documentation": "

The ID of the deleted Traffic Mirror target.

", - "smithy.api#xmlName": "trafficMirrorTargetId" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteTransitGateway": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteTransitGatewayRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteTransitGatewayResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified transit gateway.

" - } - }, - "com.amazonaws.ec2#DeleteTransitGatewayConnect": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteTransitGatewayConnectRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteTransitGatewayConnectResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified Connect attachment. You must first delete any Connect peers for\n the attachment.

" - } - }, - "com.amazonaws.ec2#DeleteTransitGatewayConnectPeer": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteTransitGatewayConnectPeerRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteTransitGatewayConnectPeerResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified Connect peer.

" - } - }, - "com.amazonaws.ec2#DeleteTransitGatewayConnectPeerRequest": { - "type": "structure", - "members": { - "TransitGatewayConnectPeerId": { - "target": "com.amazonaws.ec2#TransitGatewayConnectPeerId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Connect peer.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteTransitGatewayConnectPeerResult": { - "type": "structure", - "members": { - "TransitGatewayConnectPeer": { - "target": "com.amazonaws.ec2#TransitGatewayConnectPeer", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayConnectPeer", - "smithy.api#documentation": "

Information about the deleted Connect peer.

", - "smithy.api#xmlName": "transitGatewayConnectPeer" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteTransitGatewayConnectRequest": { - "type": "structure", - "members": { - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Connect attachment.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteTransitGatewayConnectResult": { - "type": "structure", - "members": { - "TransitGatewayConnect": { - "target": "com.amazonaws.ec2#TransitGatewayConnect", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayConnect", - "smithy.api#documentation": "

Information about the deleted Connect attachment.

", - "smithy.api#xmlName": "transitGatewayConnect" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteTransitGatewayMulticastDomain": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteTransitGatewayMulticastDomainRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteTransitGatewayMulticastDomainResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified transit gateway multicast domain.

" - } - }, - "com.amazonaws.ec2#DeleteTransitGatewayMulticastDomainRequest": { - "type": "structure", - "members": { - "TransitGatewayMulticastDomainId": { - "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteTransitGatewayMulticastDomainResult": { - "type": "structure", - "members": { - "TransitGatewayMulticastDomain": { - "target": "com.amazonaws.ec2#TransitGatewayMulticastDomain", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayMulticastDomain", - "smithy.api#documentation": "

Information about the deleted transit gateway multicast domain.

", - "smithy.api#xmlName": "transitGatewayMulticastDomain" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteTransitGatewayPeeringAttachment": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteTransitGatewayPeeringAttachmentRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteTransitGatewayPeeringAttachmentResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes a transit gateway peering attachment.

" - } - }, - "com.amazonaws.ec2#DeleteTransitGatewayPeeringAttachmentRequest": { - "type": "structure", - "members": { - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the transit gateway peering attachment.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteTransitGatewayPeeringAttachmentResult": { - "type": "structure", - "members": { - "TransitGatewayPeeringAttachment": { - "target": "com.amazonaws.ec2#TransitGatewayPeeringAttachment", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayPeeringAttachment", - "smithy.api#documentation": "

The transit gateway peering attachment.

", - "smithy.api#xmlName": "transitGatewayPeeringAttachment" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteTransitGatewayPolicyTable": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteTransitGatewayPolicyTableRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteTransitGatewayPolicyTableResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified transit gateway policy table.

" - } - }, - "com.amazonaws.ec2#DeleteTransitGatewayPolicyTableRequest": { - "type": "structure", - "members": { - "TransitGatewayPolicyTableId": { - "target": "com.amazonaws.ec2#TransitGatewayPolicyTableId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The transit gateway policy table to delete.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteTransitGatewayPolicyTableResult": { - "type": "structure", - "members": { - "TransitGatewayPolicyTable": { - "target": "com.amazonaws.ec2#TransitGatewayPolicyTable", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayPolicyTable", - "smithy.api#documentation": "

Provides details about the deleted transit gateway policy table.

", - "smithy.api#xmlName": "transitGatewayPolicyTable" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteTransitGatewayPrefixListReference": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteTransitGatewayPrefixListReferenceRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteTransitGatewayPrefixListReferenceResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes a reference (route) to a prefix list in a specified transit gateway route table.

" - } - }, - "com.amazonaws.ec2#DeleteTransitGatewayPrefixListReferenceRequest": { - "type": "structure", - "members": { - "TransitGatewayRouteTableId": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the route table.

", - "smithy.api#required": {} - } - }, - "PrefixListId": { - "target": "com.amazonaws.ec2#PrefixListResourceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the prefix list.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteTransitGatewayPrefixListReferenceResult": { - "type": "structure", - "members": { - "TransitGatewayPrefixListReference": { - "target": "com.amazonaws.ec2#TransitGatewayPrefixListReference", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayPrefixListReference", - "smithy.api#documentation": "

Information about the deleted prefix list reference.

", - "smithy.api#xmlName": "transitGatewayPrefixListReference" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteTransitGatewayRequest": { - "type": "structure", - "members": { - "TransitGatewayId": { - "target": "com.amazonaws.ec2#TransitGatewayId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the transit gateway.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteTransitGatewayResult": { - "type": "structure", - "members": { - "TransitGateway": { - "target": "com.amazonaws.ec2#TransitGateway", - "traits": { - "aws.protocols#ec2QueryName": "TransitGateway", - "smithy.api#documentation": "

Information about the deleted transit gateway.

", - "smithy.api#xmlName": "transitGateway" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteTransitGatewayRoute": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteTransitGatewayRouteRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteTransitGatewayRouteResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified route from the specified transit gateway route table.

" - } - }, - "com.amazonaws.ec2#DeleteTransitGatewayRouteRequest": { - "type": "structure", - "members": { - "TransitGatewayRouteTableId": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the transit gateway route table.

", - "smithy.api#required": {} - } - }, - "DestinationCidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The CIDR range for the route. This must match the CIDR for the route exactly.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteTransitGatewayRouteResult": { - "type": "structure", - "members": { - "Route": { - "target": "com.amazonaws.ec2#TransitGatewayRoute", - "traits": { - "aws.protocols#ec2QueryName": "Route", - "smithy.api#documentation": "

Information about the route.

", - "smithy.api#xmlName": "route" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteTransitGatewayRouteTable": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteTransitGatewayRouteTableRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteTransitGatewayRouteTableResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified transit gateway route table. You must disassociate the route table from any\n transit gateway route tables before you can delete it.

" - } - }, - "com.amazonaws.ec2#DeleteTransitGatewayRouteTableAnnouncement": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteTransitGatewayRouteTableAnnouncementRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteTransitGatewayRouteTableAnnouncementResult" - }, - "traits": { - "smithy.api#documentation": "

Advertises to the transit gateway that a transit gateway route table is deleted.

" - } - }, - "com.amazonaws.ec2#DeleteTransitGatewayRouteTableAnnouncementRequest": { - "type": "structure", - "members": { - "TransitGatewayRouteTableAnnouncementId": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The transit gateway route table ID that's being deleted.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteTransitGatewayRouteTableAnnouncementResult": { - "type": "structure", - "members": { - "TransitGatewayRouteTableAnnouncement": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncement", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayRouteTableAnnouncement", - "smithy.api#documentation": "

Provides details about a deleted transit gateway route table.

", - "smithy.api#xmlName": "transitGatewayRouteTableAnnouncement" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteTransitGatewayRouteTableRequest": { - "type": "structure", - "members": { - "TransitGatewayRouteTableId": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the transit gateway route table.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteTransitGatewayRouteTableResult": { - "type": "structure", - "members": { - "TransitGatewayRouteTable": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTable", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayRouteTable", - "smithy.api#documentation": "

Information about the deleted transit gateway route table.

", - "smithy.api#xmlName": "transitGatewayRouteTable" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteTransitGatewayVpcAttachment": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteTransitGatewayVpcAttachmentRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteTransitGatewayVpcAttachmentResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified VPC attachment.

" - } - }, - "com.amazonaws.ec2#DeleteTransitGatewayVpcAttachmentRequest": { - "type": "structure", - "members": { - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the attachment.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteTransitGatewayVpcAttachmentResult": { - "type": "structure", - "members": { - "TransitGatewayVpcAttachment": { - "target": "com.amazonaws.ec2#TransitGatewayVpcAttachment", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayVpcAttachment", - "smithy.api#documentation": "

Information about the deleted VPC attachment.

", - "smithy.api#xmlName": "transitGatewayVpcAttachment" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteVerifiedAccessEndpoint": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteVerifiedAccessEndpointRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteVerifiedAccessEndpointResult" - }, - "traits": { - "smithy.api#documentation": "

Delete an Amazon Web Services Verified Access endpoint.

" - } - }, - "com.amazonaws.ec2#DeleteVerifiedAccessEndpointRequest": { - "type": "structure", - "members": { - "VerifiedAccessEndpointId": { - "target": "com.amazonaws.ec2#VerifiedAccessEndpointId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Verified Access endpoint.

", - "smithy.api#required": {} - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.

", - "smithy.api#idempotencyToken": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteVerifiedAccessEndpointResult": { - "type": "structure", - "members": { - "VerifiedAccessEndpoint": { - "target": "com.amazonaws.ec2#VerifiedAccessEndpoint", - "traits": { - "aws.protocols#ec2QueryName": "VerifiedAccessEndpoint", - "smithy.api#documentation": "

The ID of the Verified Access endpoint.

", - "smithy.api#xmlName": "verifiedAccessEndpoint" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteVerifiedAccessGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteVerifiedAccessGroupRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteVerifiedAccessGroupResult" - }, - "traits": { - "smithy.api#documentation": "

Delete an Amazon Web Services Verified Access group.

" - } - }, - "com.amazonaws.ec2#DeleteVerifiedAccessGroupRequest": { - "type": "structure", - "members": { - "VerifiedAccessGroupId": { - "target": "com.amazonaws.ec2#VerifiedAccessGroupId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Verified Access group.

", - "smithy.api#required": {} - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.

", - "smithy.api#idempotencyToken": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteVerifiedAccessGroupResult": { - "type": "structure", - "members": { - "VerifiedAccessGroup": { - "target": "com.amazonaws.ec2#VerifiedAccessGroup", - "traits": { - "aws.protocols#ec2QueryName": "VerifiedAccessGroup", - "smithy.api#documentation": "

The ID of the Verified Access group.

", - "smithy.api#xmlName": "verifiedAccessGroup" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteVerifiedAccessInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteVerifiedAccessInstanceRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteVerifiedAccessInstanceResult" - }, - "traits": { - "smithy.api#documentation": "

Delete an Amazon Web Services Verified Access instance.

" - } - }, - "com.amazonaws.ec2#DeleteVerifiedAccessInstanceRequest": { - "type": "structure", - "members": { - "VerifiedAccessInstanceId": { - "target": "com.amazonaws.ec2#VerifiedAccessInstanceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Verified Access instance.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.

", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteVerifiedAccessInstanceResult": { - "type": "structure", - "members": { - "VerifiedAccessInstance": { - "target": "com.amazonaws.ec2#VerifiedAccessInstance", - "traits": { - "aws.protocols#ec2QueryName": "VerifiedAccessInstance", - "smithy.api#documentation": "

The ID of the Verified Access instance.

", - "smithy.api#xmlName": "verifiedAccessInstance" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteVerifiedAccessTrustProvider": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteVerifiedAccessTrustProviderRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteVerifiedAccessTrustProviderResult" - }, - "traits": { - "smithy.api#documentation": "

Delete an Amazon Web Services Verified Access trust provider.

" - } - }, - "com.amazonaws.ec2#DeleteVerifiedAccessTrustProviderRequest": { - "type": "structure", - "members": { - "VerifiedAccessTrustProviderId": { - "target": "com.amazonaws.ec2#VerifiedAccessTrustProviderId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Verified Access trust provider.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.

", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteVerifiedAccessTrustProviderResult": { - "type": "structure", - "members": { - "VerifiedAccessTrustProvider": { - "target": "com.amazonaws.ec2#VerifiedAccessTrustProvider", - "traits": { - "aws.protocols#ec2QueryName": "VerifiedAccessTrustProvider", - "smithy.api#documentation": "

The ID of the Verified Access trust provider.

", - "smithy.api#xmlName": "verifiedAccessTrustProvider" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteVolume": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteVolumeRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified EBS volume. The volume must be in the available state\n (not attached to an instance).

\n

The volume can remain in the deleting state for several minutes.

\n

For more information, see Delete an Amazon EBS volume in the\n Amazon Elastic Compute Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#DeleteVolumeRequest": { - "type": "structure", - "members": { - "VolumeId": { - "target": "com.amazonaws.ec2#VolumeId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the volume.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteVpc": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteVpcRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#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.

" - } - }, - "com.amazonaws.ec2#DeleteVpcEndpointConnectionNotifications": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteVpcEndpointConnectionNotificationsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteVpcEndpointConnectionNotificationsResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified VPC endpoint connection notifications.

" - } - }, - "com.amazonaws.ec2#DeleteVpcEndpointConnectionNotificationsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "ConnectionNotificationIds": { - "target": "com.amazonaws.ec2#ConnectionNotificationIdsList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IDs of the notifications.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "ConnectionNotificationId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteVpcEndpointConnectionNotificationsResult": { - "type": "structure", - "members": { - "Unsuccessful": { - "target": "com.amazonaws.ec2#UnsuccessfulItemSet", - "traits": { - "aws.protocols#ec2QueryName": "Unsuccessful", - "smithy.api#documentation": "

Information about the notifications that could not be deleted\n successfully.

", - "smithy.api#xmlName": "unsuccessful" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteVpcEndpointServiceConfigurations": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteVpcEndpointServiceConfigurationsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteVpcEndpointServiceConfigurationsResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified VPC endpoint service configurations. Before you can delete\n an endpoint service configuration, you must reject any Available or\n PendingAcceptance interface endpoint connections that are attached to\n the service.

" - } - }, - "com.amazonaws.ec2#DeleteVpcEndpointServiceConfigurationsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "ServiceIds": { - "target": "com.amazonaws.ec2#VpcEndpointServiceIdList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IDs of the services.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "ServiceId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteVpcEndpointServiceConfigurationsResult": { - "type": "structure", - "members": { - "Unsuccessful": { - "target": "com.amazonaws.ec2#UnsuccessfulItemSet", - "traits": { - "aws.protocols#ec2QueryName": "Unsuccessful", - "smithy.api#documentation": "

Information about the service configurations that were not deleted, if\n applicable.

", - "smithy.api#xmlName": "unsuccessful" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteVpcEndpoints": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteVpcEndpointsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteVpcEndpointsResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified VPC endpoints.

\n

When you delete a gateway endpoint, we delete the endpoint routes in the route tables for the endpoint.

\n

When you delete a Gateway Load Balancer endpoint, we delete its endpoint network interfaces. \n You can only delete Gateway Load Balancer endpoints when the routes that are associated with the endpoint are deleted.

\n

When you delete an interface endpoint, we delete its endpoint network interfaces.

" - } - }, - "com.amazonaws.ec2#DeleteVpcEndpointsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "VpcEndpointIds": { - "target": "com.amazonaws.ec2#VpcEndpointIdList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IDs of the VPC endpoints.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "VpcEndpointId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteVpcEndpointsResult": { - "type": "structure", - "members": { - "Unsuccessful": { - "target": "com.amazonaws.ec2#UnsuccessfulItemSet", - "traits": { - "aws.protocols#ec2QueryName": "Unsuccessful", - "smithy.api#documentation": "

Information about the VPC endpoints that were not successfully deleted.

", - "smithy.api#xmlName": "unsuccessful" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteVpcPeeringConnection": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteVpcPeeringConnectionRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeleteVpcPeeringConnectionResult" - }, - "traits": { - "smithy.api#documentation": "

Deletes a VPC peering connection. Either the owner of the requester VPC or the owner\n of the accepter VPC can delete the VPC peering connection if it's in the\n active state. The owner of the requester VPC can delete a VPC peering\n connection in the pending-acceptance state. You cannot delete a VPC peering\n connection that's in the failed state.

" - } - }, - "com.amazonaws.ec2#DeleteVpcPeeringConnectionRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "VpcPeeringConnectionId": { - "target": "com.amazonaws.ec2#VpcPeeringConnectionId", - "traits": { - "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the VPC peering connection.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "vpcPeeringConnectionId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteVpcPeeringConnectionResult": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeleteVpcRequest": { - "type": "structure", - "members": { - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteVpnConnection": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteVpnConnectionRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified VPN connection.

\n

If you're deleting the VPC and its associated components, we recommend that you detach\n the virtual private gateway from the VPC and delete the VPC before deleting the VPN\n connection. If you believe that the tunnel credentials for your VPN connection have been\n compromised, you can delete the VPN connection and create a new one that has new keys,\n without needing to delete the VPC or virtual private gateway. If you create a new VPN\n connection, you must reconfigure the customer gateway device using the new configuration\n information returned with the new VPN connection ID.

\n

For certificate-based authentication, delete all Certificate Manager (ACM) private\n certificates used for the Amazon Web Services-side tunnel endpoints for the VPN\n connection before deleting the VPN connection.

" - } - }, - "com.amazonaws.ec2#DeleteVpnConnectionRequest": { - "type": "structure", - "members": { - "VpnConnectionId": { - "target": "com.amazonaws.ec2#VpnConnectionId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the VPN connection.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for DeleteVpnConnection.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteVpnConnectionRoute": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteVpnConnectionRouteRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified static route associated with a VPN connection between an\n existing virtual private gateway and a VPN customer gateway. The static route allows\n traffic to be routed from the virtual private gateway to the VPN customer\n gateway.

" - } - }, - "com.amazonaws.ec2#DeleteVpnConnectionRouteRequest": { - "type": "structure", - "members": { - "DestinationCidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The CIDR block associated with the local subnet of the customer network.

", - "smithy.api#required": {} - } - }, - "VpnConnectionId": { - "target": "com.amazonaws.ec2#VpnConnectionId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the VPN connection.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for DeleteVpnConnectionRoute.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeleteVpnGateway": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeleteVpnGatewayRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Deletes the specified virtual private gateway. You must first detach the virtual\n private gateway from the VPC. Note that you don't need to delete the virtual private\n gateway if you plan to delete and recreate the VPN connection between your VPC and your\n network.

" - } - }, - "com.amazonaws.ec2#DeleteVpnGatewayRequest": { - "type": "structure", - "members": { - "VpnGatewayId": { - "target": "com.amazonaws.ec2#VpnGatewayId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the virtual private gateway.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for DeleteVpnGateway.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeprovisionByoipCidr": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeprovisionByoipCidrRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeprovisionByoipCidrResult" - }, - "traits": { - "smithy.api#documentation": "

Releases the specified address range that you provisioned for use with your Amazon Web Services resources\n through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.

\n

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\n address range.

" - } - }, - "com.amazonaws.ec2#DeprovisionByoipCidrRequest": { - "type": "structure", - "members": { - "Cidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The address range, in CIDR notation. The prefix must be the same prefix \n that you specified when you provisioned the address range.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeprovisionByoipCidrResult": { - "type": "structure", - "members": { - "ByoipCidr": { - "target": "com.amazonaws.ec2#ByoipCidr", - "traits": { - "aws.protocols#ec2QueryName": "ByoipCidr", - "smithy.api#documentation": "

Information about the address range.

", - "smithy.api#xmlName": "byoipCidr" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeprovisionIpamPoolCidr": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeprovisionIpamPoolCidrRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeprovisionIpamPoolCidrResult" - }, - "traits": { - "smithy.api#documentation": "

Deprovision a CIDR provisioned from an IPAM pool. If you deprovision a CIDR from a pool that has a source pool, the CIDR is recycled back into the source pool. For more information, see Deprovision pool CIDRs in the Amazon VPC IPAM User Guide.

" - } - }, - "com.amazonaws.ec2#DeprovisionIpamPoolCidrRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "IpamPoolId": { - "target": "com.amazonaws.ec2#IpamPoolId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the pool that has the CIDR you want to deprovision.

", - "smithy.api#required": {} - } - }, - "Cidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The CIDR which you want to deprovision from the pool.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeprovisionIpamPoolCidrResult": { - "type": "structure", - "members": { - "IpamPoolCidr": { - "target": "com.amazonaws.ec2#IpamPoolCidr", - "traits": { - "aws.protocols#ec2QueryName": "IpamPoolCidr", - "smithy.api#documentation": "

The deprovisioned pool CIDR.

", - "smithy.api#xmlName": "ipamPoolCidr" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeprovisionPublicIpv4PoolCidr": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeprovisionPublicIpv4PoolCidrRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeprovisionPublicIpv4PoolCidrResult" - }, - "traits": { - "smithy.api#documentation": "

Deprovision a CIDR from a public IPv4 pool.

" - } - }, - "com.amazonaws.ec2#DeprovisionPublicIpv4PoolCidrRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "PoolId": { - "target": "com.amazonaws.ec2#Ipv4PoolEc2Id", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the pool that you want to deprovision the CIDR from.

", - "smithy.api#required": {} - } - }, - "Cidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The CIDR you want to deprovision from the pool. Enter the CIDR you want to deprovision with a netmask of /32. You must rerun this command for each IP address in the CIDR range. If your CIDR is a /24, you will have to run this command to deprovision each of the 256 IP addresses in the /24 CIDR.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeprovisionPublicIpv4PoolCidrResult": { - "type": "structure", - "members": { - "PoolId": { - "target": "com.amazonaws.ec2#Ipv4PoolEc2Id", - "traits": { - "aws.protocols#ec2QueryName": "PoolId", - "smithy.api#documentation": "

The ID of the pool that you deprovisioned the CIDR from.

", - "smithy.api#xmlName": "poolId" - } - }, - "DeprovisionedAddresses": { - "target": "com.amazonaws.ec2#DeprovisionedAddressSet", - "traits": { - "aws.protocols#ec2QueryName": "DeprovisionedAddressSet", - "smithy.api#documentation": "

The deprovisioned CIDRs.

", - "smithy.api#xmlName": "deprovisionedAddressSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeprovisionedAddressSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#DeregisterImage": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeregisterImageRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Deregisters the specified AMI. After you deregister an AMI, it can't be used to \n launch new instances.

\n

If you deregister an AMI that matches a Recycle Bin retention rule, the AMI is retained\n in the Recycle Bin for the specified retention period. For more information, see Recycle Bin in\n the Amazon EC2 User Guide.

\n

When you deregister an AMI, it doesn't affect any instances that you've already \n launched from the AMI. You'll continue to incur usage costs for those instances until \n you terminate them.

\n

When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was\n\t\t\tcreated for the root volume of the instance during the AMI creation process. When you\n\t\t\tderegister an instance store-backed AMI, it doesn't affect the files that you uploaded\n\t\t\tto Amazon S3 when you created the AMI.

" - } - }, - "com.amazonaws.ec2#DeregisterImageRequest": { - "type": "structure", - "members": { - "ImageId": { - "target": "com.amazonaws.ec2#ImageId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the AMI.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for DeregisterImage.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeregisterInstanceEventNotificationAttributes": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeregisterInstanceEventNotificationAttributesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeregisterInstanceEventNotificationAttributesResult" - }, - "traits": { - "smithy.api#documentation": "

Deregisters tag keys to prevent tags that have the specified tag keys from being included\n\t\t\tin scheduled event notifications for resources in the Region.

" - } - }, - "com.amazonaws.ec2#DeregisterInstanceEventNotificationAttributesRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "InstanceTagAttribute": { - "target": "com.amazonaws.ec2#DeregisterInstanceTagAttributeRequest", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Information about the tag keys to deregister.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeregisterInstanceEventNotificationAttributesResult": { - "type": "structure", - "members": { - "InstanceTagAttribute": { - "target": "com.amazonaws.ec2#InstanceTagNotificationAttribute", - "traits": { - "aws.protocols#ec2QueryName": "InstanceTagAttribute", - "smithy.api#documentation": "

The resulting set of tag keys.

", - "smithy.api#xmlName": "instanceTagAttribute" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeregisterInstanceTagAttributeRequest": { - "type": "structure", - "members": { - "IncludeAllTagsOfInstance": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to deregister all tag keys in the current Region. Specify false \n \t\tto deregister all tag keys.

" - } - }, - "InstanceTagKeys": { - "target": "com.amazonaws.ec2#InstanceTagKeySet", - "traits": { - "smithy.api#documentation": "

Information about the tag keys to deregister.

", - "smithy.api#xmlName": "InstanceTagKey" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the tag keys to deregister for the current Region. You can either specify \n \t\tindividual tag keys or deregister all tag keys in the current Region. You must specify either\n \t\tIncludeAllTagsOfInstance or InstanceTagKeys in the request

" - } - }, - "com.amazonaws.ec2#DeregisterTransitGatewayMulticastGroupMembers": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeregisterTransitGatewayMulticastGroupMembersRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeregisterTransitGatewayMulticastGroupMembersResult" - }, - "traits": { - "smithy.api#documentation": "

Deregisters the specified members (network interfaces) from the transit gateway multicast group.

" - } - }, - "com.amazonaws.ec2#DeregisterTransitGatewayMulticastGroupMembersRequest": { - "type": "structure", - "members": { - "TransitGatewayMulticastDomainId": { - "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", - "traits": { - "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

" - } - }, - "GroupIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

" - } - }, - "NetworkInterfaceIds": { - "target": "com.amazonaws.ec2#TransitGatewayNetworkInterfaceIdList", - "traits": { - "smithy.api#documentation": "

The IDs of the group members' network interfaces.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeregisterTransitGatewayMulticastGroupMembersResult": { - "type": "structure", - "members": { - "DeregisteredMulticastGroupMembers": { - "target": "com.amazonaws.ec2#TransitGatewayMulticastDeregisteredGroupMembers", - "traits": { - "aws.protocols#ec2QueryName": "DeregisteredMulticastGroupMembers", - "smithy.api#documentation": "

Information about the deregistered members.

", - "smithy.api#xmlName": "deregisteredMulticastGroupMembers" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DeregisterTransitGatewayMulticastGroupSources": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DeregisterTransitGatewayMulticastGroupSourcesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DeregisterTransitGatewayMulticastGroupSourcesResult" - }, - "traits": { - "smithy.api#documentation": "

Deregisters the specified sources (network interfaces) from the transit gateway multicast group.

" - } - }, - "com.amazonaws.ec2#DeregisterTransitGatewayMulticastGroupSourcesRequest": { - "type": "structure", - "members": { - "TransitGatewayMulticastDomainId": { - "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", - "traits": { - "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

" - } - }, - "GroupIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

" - } - }, - "NetworkInterfaceIds": { - "target": "com.amazonaws.ec2#TransitGatewayNetworkInterfaceIdList", - "traits": { - "smithy.api#documentation": "

The IDs of the group sources' network interfaces.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeregisterTransitGatewayMulticastGroupSourcesResult": { - "type": "structure", - "members": { - "DeregisteredMulticastGroupSources": { - "target": "com.amazonaws.ec2#TransitGatewayMulticastDeregisteredGroupSources", - "traits": { - "aws.protocols#ec2QueryName": "DeregisteredMulticastGroupSources", - "smithy.api#documentation": "

Information about the deregistered group sources.

", - "smithy.api#xmlName": "deregisteredMulticastGroupSources" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeAccountAttributes": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeAccountAttributesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeAccountAttributesResult" - }, - "traits": { - "smithy.api#documentation": "

Describes attributes of your Amazon Web Services account. The following are the supported account attributes:

\n \n \n

We are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide.

\n " - } - }, - "com.amazonaws.ec2#DescribeAccountAttributesRequest": { - "type": "structure", - "members": { - "AttributeNames": { - "target": "com.amazonaws.ec2#AccountAttributeNameStringList", - "traits": { - "aws.protocols#ec2QueryName": "AttributeName", - "smithy.api#documentation": "

The account attribute names.

", - "smithy.api#xmlName": "attributeName" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeAccountAttributesResult": { - "type": "structure", - "members": { - "AccountAttributes": { - "target": "com.amazonaws.ec2#AccountAttributeList", - "traits": { - "aws.protocols#ec2QueryName": "AccountAttributeSet", - "smithy.api#documentation": "

Information about the account attributes.

", - "smithy.api#xmlName": "accountAttributeSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeAddressTransfers": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeAddressTransfersRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeAddressTransfersResult" - }, - "traits": { - "smithy.api#documentation": "

Describes an Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon Virtual Private Cloud User Guide.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "AddressTransfers", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeAddressTransfersMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#DescribeAddressTransfersRequest": { - "type": "structure", - "members": { - "AllocationIds": { - "target": "com.amazonaws.ec2#AllocationIdList", - "traits": { - "smithy.api#documentation": "

The allocation IDs of Elastic IP addresses.

", - "smithy.api#xmlName": "AllocationId" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeAddressTransfersMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of address transfers to return in one page of results.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeAddressTransfersResult": { - "type": "structure", - "members": { - "AddressTransfers": { - "target": "com.amazonaws.ec2#AddressTransferList", - "traits": { - "aws.protocols#ec2QueryName": "AddressTransferSet", - "smithy.api#documentation": "

The Elastic IP address transfer.

", - "smithy.api#xmlName": "addressTransferSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeAddresses": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeAddressesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeAddressesResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the specified Elastic IP addresses or all of your Elastic IP addresses.

\n

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC.\n\t\t\t\tFor more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " - } - }, - "com.amazonaws.ec2#DescribeAddressesAttribute": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeAddressesAttributeRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeAddressesAttributeResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the attributes of the specified Elastic IP addresses. For requirements, see Using reverse DNS for email applications.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Addresses", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeAddressesAttributeRequest": { - "type": "structure", - "members": { - "AllocationIds": { - "target": "com.amazonaws.ec2#AllocationIds", - "traits": { - "smithy.api#documentation": "

[EC2-VPC] The allocation IDs.

", - "smithy.api#xmlName": "AllocationId" - } - }, - "Attribute": { - "target": "com.amazonaws.ec2#AddressAttributeName", - "traits": { - "smithy.api#documentation": "

The attribute of the IP address.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#AddressMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#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.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeAddressesAttributeResult": { - "type": "structure", - "members": { - "Addresses": { - "target": "com.amazonaws.ec2#AddressSet", - "traits": { - "aws.protocols#ec2QueryName": "AddressSet", - "smithy.api#documentation": "

Information about the IP addresses.

", - "smithy.api#xmlName": "addressSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeAddressesRequest": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "PublicIps": { - "target": "com.amazonaws.ec2#PublicIpStringList", - "traits": { - "smithy.api#documentation": "

One or more Elastic IP addresses.

\n

Default: Describes all your Elastic IP addresses.

", - "smithy.api#xmlName": "PublicIp" - } - }, - "AllocationIds": { - "target": "com.amazonaws.ec2#AllocationIdList", - "traits": { - "smithy.api#documentation": "

[EC2-VPC] Information about the allocation IDs.

", - "smithy.api#xmlName": "AllocationId" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeAddressesResult": { - "type": "structure", - "members": { - "Addresses": { - "target": "com.amazonaws.ec2#AddressList", - "traits": { - "aws.protocols#ec2QueryName": "AddressesSet", - "smithy.api#documentation": "

Information about the Elastic IP addresses.

", - "smithy.api#xmlName": "addressesSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeAggregateIdFormat": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeAggregateIdFormatRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeAggregateIdFormatResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the longer ID format settings for all resource types in a specific\n Region. This request is useful for performing a quick audit to determine whether a\n specific Region is fully opted in for longer IDs (17-character IDs).

\n

This request only returns information about resource types that support longer IDs.

\n

The following resource types support longer IDs: bundle |\n conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | instance | internet-gateway |\n network-acl | network-acl-association |\n network-interface | network-interface-attachment |\n prefix-list | reservation | route-table |\n route-table-association | security-group |\n snapshot | subnet |\n subnet-cidr-block-association | volume | vpc |\n vpc-cidr-block-association | vpc-endpoint |\n vpc-peering-connection | vpn-connection | vpn-gateway.

" - } - }, - "com.amazonaws.ec2#DescribeAggregateIdFormatRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeAggregateIdFormatResult": { - "type": "structure", - "members": { - "UseLongIdsAggregated": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "UseLongIdsAggregated", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether all resource types in the Region are configured to use longer IDs.\n This value is only true if all users are configured to use longer IDs for\n all resources types in the Region.

", - "smithy.api#xmlName": "useLongIdsAggregated" - } - }, - "Statuses": { - "target": "com.amazonaws.ec2#IdFormatList", - "traits": { - "aws.protocols#ec2QueryName": "StatusSet", - "smithy.api#documentation": "

Information about each resource's ID format.

", - "smithy.api#xmlName": "statusSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeAvailabilityZones": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeAvailabilityZonesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeAvailabilityZonesResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the Availability Zones, Local Zones, and Wavelength Zones that are available to\n you. If there is an event impacting a zone, you can use this request to view the state and any\n provided messages for that zone.

\n

For more information about Availability Zones, Local Zones, and Wavelength Zones, see\n Regions and zones \n in the Amazon Elastic Compute Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#DescribeAvailabilityZonesRequest": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "ZoneNames": { - "target": "com.amazonaws.ec2#ZoneNameStringList", - "traits": { - "smithy.api#documentation": "

The names of the Availability Zones, Local Zones, and Wavelength Zones.

", - "smithy.api#xmlName": "ZoneName" - } - }, - "ZoneIds": { - "target": "com.amazonaws.ec2#ZoneIdStringList", - "traits": { - "smithy.api#documentation": "

The IDs of the Availability Zones, Local Zones, and Wavelength Zones.

", - "smithy.api#xmlName": "ZoneId" - } - }, - "AllAvailabilityZones": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Include all Availability Zones, Local Zones, and Wavelength Zones regardless of your\n opt-in status.

\n

If you do not use this parameter, the results include only the zones for the Regions where you have chosen the option to opt in.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeAvailabilityZonesResult": { - "type": "structure", - "members": { - "AvailabilityZones": { - "target": "com.amazonaws.ec2#AvailabilityZoneList", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZoneInfo", - "smithy.api#documentation": "

Information about the Availability Zones, Local Zones, and Wavelength Zones.

", - "smithy.api#xmlName": "availabilityZoneInfo" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeAwsNetworkPerformanceMetricSubscriptions": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeAwsNetworkPerformanceMetricSubscriptionsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeAwsNetworkPerformanceMetricSubscriptionsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the current Infrastructure Performance metric subscriptions.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Subscriptions", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeAwsNetworkPerformanceMetricSubscriptionsRequest": { - "type": "structure", - "members": { - "MaxResults": { - "target": "com.amazonaws.ec2#MaxResultsParam", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

", - "smithy.api#xmlName": "Filter" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeAwsNetworkPerformanceMetricSubscriptionsResult": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - }, - "Subscriptions": { - "target": "com.amazonaws.ec2#SubscriptionList", - "traits": { - "aws.protocols#ec2QueryName": "SubscriptionSet", - "smithy.api#documentation": "

Describes the current Infrastructure Performance subscriptions.

", - "smithy.api#xmlName": "subscriptionSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeBundleTasks": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeBundleTasksRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeBundleTasksResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the specified bundle tasks or all of your bundle tasks.

\n \n

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.

\n ", - "smithy.waiters#waitable": { - "BundleTaskComplete": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "BundleTasks[].State", - "expected": "complete", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "BundleTasks[].State", - "expected": "failed", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 15 - } - } - } - }, - "com.amazonaws.ec2#DescribeBundleTasksRequest": { - "type": "structure", - "members": { - "BundleIds": { - "target": "com.amazonaws.ec2#BundleIdStringList", - "traits": { - "smithy.api#documentation": "

The bundle task IDs.

\n

Default: Describes all your bundle tasks.

", - "smithy.api#xmlName": "BundleId" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeBundleTasksResult": { - "type": "structure", - "members": { - "BundleTasks": { - "target": "com.amazonaws.ec2#BundleTaskList", - "traits": { - "aws.protocols#ec2QueryName": "BundleInstanceTasksSet", - "smithy.api#documentation": "

Information about the bundle tasks.

", - "smithy.api#xmlName": "bundleInstanceTasksSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeByoipCidrs": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeByoipCidrsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeByoipCidrsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the IP address ranges that were specified in calls to ProvisionByoipCidr.

\n

To describe the address pools that were created when you provisioned the address\n ranges, use DescribePublicIpv4Pools or DescribeIpv6Pools.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ByoipCidrs", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeByoipCidrsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.ec2#DescribeByoipCidrsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeByoipCidrsMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeByoipCidrsResult": { - "type": "structure", - "members": { - "ByoipCidrs": { - "target": "com.amazonaws.ec2#ByoipCidrSet", - "traits": { - "aws.protocols#ec2QueryName": "ByoipCidrSet", - "smithy.api#documentation": "

Information about your address ranges.

", - "smithy.api#xmlName": "byoipCidrSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeCapacityReservationFleets": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeCapacityReservationFleetsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeCapacityReservationFleetsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes one or more Capacity Reservation Fleets.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "CapacityReservationFleets", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeCapacityReservationFleetsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.ec2#DescribeCapacityReservationFleetsRequest": { - "type": "structure", - "members": { - "CapacityReservationFleetIds": { - "target": "com.amazonaws.ec2#CapacityReservationFleetIdSet", - "traits": { - "smithy.api#documentation": "

The IDs of the Capacity Reservation Fleets to describe.

", - "smithy.api#xmlName": "CapacityReservationFleetId" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeCapacityReservationFleetsMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#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.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeCapacityReservationFleetsResult": { - "type": "structure", - "members": { - "CapacityReservationFleets": { - "target": "com.amazonaws.ec2#CapacityReservationFleetSet", - "traits": { - "aws.protocols#ec2QueryName": "CapacityReservationFleetSet", - "smithy.api#documentation": "

Information about the Capacity Reservation Fleets.

", - "smithy.api#xmlName": "capacityReservationFleetSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeCapacityReservations": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeCapacityReservationsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeCapacityReservationsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the \n\t\t \tAmazon Web Services Region that you're currently using.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "CapacityReservations", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeCapacityReservationsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#DescribeCapacityReservationsRequest": { - "type": "structure", - "members": { - "CapacityReservationIds": { - "target": "com.amazonaws.ec2#CapacityReservationIdSet", - "traits": { - "smithy.api#documentation": "

The ID of the Capacity Reservation.

", - "smithy.api#xmlName": "CapacityReservationId" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeCapacityReservationsMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#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.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeCapacityReservationsResult": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - }, - "CapacityReservations": { - "target": "com.amazonaws.ec2#CapacityReservationSet", - "traits": { - "aws.protocols#ec2QueryName": "CapacityReservationSet", - "smithy.api#documentation": "

Information about the Capacity Reservations.

", - "smithy.api#xmlName": "capacityReservationSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeCarrierGateways": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeCarrierGatewaysRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeCarrierGatewaysResult" - }, - "traits": { - "smithy.api#documentation": "

Describes one or more of your carrier gateways.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "CarrierGateways", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeCarrierGatewaysRequest": { - "type": "structure", - "members": { - "CarrierGatewayIds": { - "target": "com.amazonaws.ec2#CarrierGatewayIdSet", - "traits": { - "smithy.api#documentation": "

One or more carrier gateway IDs.

", - "smithy.api#xmlName": "CarrierGatewayId" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#CarrierGatewayMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeCarrierGatewaysResult": { - "type": "structure", - "members": { - "CarrierGateways": { - "target": "com.amazonaws.ec2#CarrierGatewaySet", - "traits": { - "aws.protocols#ec2QueryName": "CarrierGatewaySet", - "smithy.api#documentation": "

Information about the carrier gateway.

", - "smithy.api#xmlName": "carrierGatewaySet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeClassicLinkInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeClassicLinkInstancesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeClassicLinkInstancesResult" - }, - "traits": { - "smithy.api#documentation": "

Describes one or more of your linked EC2-Classic instances. This request only returns\n\t\t\tinformation about EC2-Classic instances linked to a VPC through ClassicLink. You cannot\n\t\t\tuse this request to return information about other instances.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n ", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Instances", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeClassicLinkInstancesMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#DescribeClassicLinkInstancesRequest": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "InstanceIds": { - "target": "com.amazonaws.ec2#InstanceIdStringList", - "traits": { - "smithy.api#documentation": "

One or more instance IDs. Must be instances linked to a VPC through ClassicLink.

", - "smithy.api#xmlName": "InstanceId" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeClassicLinkInstancesMaxResults", - "traits": { - "aws.protocols#ec2QueryName": "MaxResults", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

\n

Constraint: If the value is greater than 1000, we return only 1000 items.

", - "smithy.api#xmlName": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeClassicLinkInstancesResult": { - "type": "structure", - "members": { - "Instances": { - "target": "com.amazonaws.ec2#ClassicLinkInstanceList", - "traits": { - "aws.protocols#ec2QueryName": "InstancesSet", - "smithy.api#documentation": "

Information about one or more linked EC2-Classic instances.

", - "smithy.api#xmlName": "instancesSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeClientVpnAuthorizationRules": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeClientVpnAuthorizationRulesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeClientVpnAuthorizationRulesResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the authorization rules for a specified Client VPN endpoint.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "AuthorizationRules", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeClientVpnAuthorizationRulesMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#DescribeClientVpnAuthorizationRulesRequest": { - "type": "structure", - "members": { - "ClientVpnEndpointId": { - "target": "com.amazonaws.ec2#ClientVpnEndpointId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without 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": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token to retrieve the next page of results.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeClientVpnAuthorizationRulesMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#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.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeClientVpnAuthorizationRulesResult": { - "type": "structure", - "members": { - "AuthorizationRules": { - "target": "com.amazonaws.ec2#AuthorizationRuleSet", - "traits": { - "aws.protocols#ec2QueryName": "AuthorizationRule", - "smithy.api#documentation": "

Information about the authorization rules.

", - "smithy.api#xmlName": "authorizationRule" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeClientVpnConnections": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeClientVpnConnectionsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeClientVpnConnectionsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes active client connections and connections that have been terminated within the last 60 \n\t\t\tminutes for the specified Client VPN endpoint.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Connections", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeClientVpnConnectionsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#DescribeClientVpnConnectionsRequest": { - "type": "structure", - "members": { - "ClientVpnEndpointId": { - "target": "com.amazonaws.ec2#ClientVpnEndpointId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token to retrieve the next page of results.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeClientVpnConnectionsMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#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": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeClientVpnConnectionsResult": { - "type": "structure", - "members": { - "Connections": { - "target": "com.amazonaws.ec2#ClientVpnConnectionSet", - "traits": { - "aws.protocols#ec2QueryName": "Connections", - "smithy.api#documentation": "

Information about the active and terminated client connections.

", - "smithy.api#xmlName": "connections" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeClientVpnEndpointMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#DescribeClientVpnEndpoints": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeClientVpnEndpointsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeClientVpnEndpointsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes one or more Client VPN endpoints in the account.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ClientVpnEndpoints", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeClientVpnEndpointsRequest": { - "type": "structure", - "members": { - "ClientVpnEndpointIds": { - "target": "com.amazonaws.ec2#ClientVpnEndpointIdList", - "traits": { - "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", - "smithy.api#xmlName": "ClientVpnEndpointId" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeClientVpnEndpointMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#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": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token to retrieve the next page of results.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeClientVpnEndpointsResult": { - "type": "structure", - "members": { - "ClientVpnEndpoints": { - "target": "com.amazonaws.ec2#EndpointSet", - "traits": { - "aws.protocols#ec2QueryName": "ClientVpnEndpoint", - "smithy.api#documentation": "

Information about the Client VPN endpoints.

", - "smithy.api#xmlName": "clientVpnEndpoint" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeClientVpnRoutes": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeClientVpnRoutesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeClientVpnRoutesResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the routes for the specified Client VPN endpoint.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Routes", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeClientVpnRoutesMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#DescribeClientVpnRoutesRequest": { - "type": "structure", - "members": { - "ClientVpnEndpointId": { - "target": "com.amazonaws.ec2#ClientVpnEndpointId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeClientVpnRoutesMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#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": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token to retrieve the next page of results.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeClientVpnRoutesResult": { - "type": "structure", - "members": { - "Routes": { - "target": "com.amazonaws.ec2#ClientVpnRouteSet", - "traits": { - "aws.protocols#ec2QueryName": "Routes", - "smithy.api#documentation": "

Information about the Client VPN endpoint routes.

", - "smithy.api#xmlName": "routes" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeClientVpnTargetNetworks": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeClientVpnTargetNetworksRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeClientVpnTargetNetworksResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the target networks associated with the specified Client VPN endpoint.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ClientVpnTargetNetworks", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeClientVpnTargetNetworksMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#DescribeClientVpnTargetNetworksRequest": { - "type": "structure", - "members": { - "ClientVpnEndpointId": { - "target": "com.amazonaws.ec2#ClientVpnEndpointId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", - "smithy.api#required": {} - } - }, - "AssociationIds": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#documentation": "

The IDs of the target network associations.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeClientVpnTargetNetworksMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#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": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token to retrieve the next page of results.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeClientVpnTargetNetworksResult": { - "type": "structure", - "members": { - "ClientVpnTargetNetworks": { - "target": "com.amazonaws.ec2#TargetNetworkSet", - "traits": { - "aws.protocols#ec2QueryName": "ClientVpnTargetNetworks", - "smithy.api#documentation": "

Information about the associated target networks.

", - "smithy.api#xmlName": "clientVpnTargetNetworks" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeCoipPools": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeCoipPoolsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeCoipPoolsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the specified customer-owned address pools or all of your customer-owned address pools.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "CoipPools", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeCoipPoolsRequest": { - "type": "structure", - "members": { - "PoolIds": { - "target": "com.amazonaws.ec2#CoipPoolIdSet", - "traits": { - "smithy.api#documentation": "

The IDs of the address pools.

", - "smithy.api#xmlName": "PoolId" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#CoipPoolMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeCoipPoolsResult": { - "type": "structure", - "members": { - "CoipPools": { - "target": "com.amazonaws.ec2#CoipPoolSet", - "traits": { - "aws.protocols#ec2QueryName": "CoipPoolSet", - "smithy.api#documentation": "

Information about the address pools.

", - "smithy.api#xmlName": "coipPoolSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeConversionTaskList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ConversionTask", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#DescribeConversionTasks": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeConversionTasksRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeConversionTasksResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the specified conversion tasks or all your conversion tasks. For more information, see the\n VM Import/Export User Guide.

\n

For information about the import manifest referenced by this API action, see VM Import Manifest.

", - "smithy.waiters#waitable": { - "ConversionTaskCancelled": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "ConversionTasks[].State", - "expected": "cancelled", - "comparator": "allStringEquals" - } - } - } - ], - "minDelay": 15 - }, - "ConversionTaskCompleted": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "ConversionTasks[].State", - "expected": "completed", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "ConversionTasks[].State", - "expected": "cancelled", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "ConversionTasks[].State", - "expected": "cancelling", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 15 - }, - "ConversionTaskDeleted": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "ConversionTasks[].State", - "expected": "deleted", - "comparator": "allStringEquals" - } - } - } - ], - "minDelay": 15 - } - } - } - }, - "com.amazonaws.ec2#DescribeConversionTasksRequest": { - "type": "structure", - "members": { - "ConversionTaskIds": { - "target": "com.amazonaws.ec2#ConversionIdStringList", - "traits": { - "aws.protocols#ec2QueryName": "ConversionTaskId", - "smithy.api#documentation": "

The conversion task IDs.

", - "smithy.api#xmlName": "conversionTaskId" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeConversionTasksResult": { - "type": "structure", - "members": { - "ConversionTasks": { - "target": "com.amazonaws.ec2#DescribeConversionTaskList", - "traits": { - "aws.protocols#ec2QueryName": "ConversionTasks", - "smithy.api#documentation": "

Information about the conversion tasks.

", - "smithy.api#xmlName": "conversionTasks" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeCustomerGateways": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeCustomerGatewaysRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeCustomerGatewaysResult" - }, - "traits": { - "smithy.api#documentation": "

Describes one or more of your VPN customer gateways.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

", - "smithy.waiters#waitable": { - "CustomerGatewayAvailable": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "CustomerGateways[].State", - "expected": "available", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "CustomerGateways[].State", - "expected": "deleted", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "CustomerGateways[].State", - "expected": "deleting", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 15 - } - } - } - }, - "com.amazonaws.ec2#DescribeCustomerGatewaysRequest": { - "type": "structure", - "members": { - "CustomerGatewayIds": { - "target": "com.amazonaws.ec2#CustomerGatewayIdStringList", - "traits": { - "smithy.api#documentation": "

One or more customer gateway IDs.

\n

Default: Describes all your customer gateways.

", - "smithy.api#xmlName": "CustomerGatewayId" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for DescribeCustomerGateways.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeCustomerGatewaysResult": { - "type": "structure", - "members": { - "CustomerGateways": { - "target": "com.amazonaws.ec2#CustomerGatewayList", - "traits": { - "aws.protocols#ec2QueryName": "CustomerGatewaySet", - "smithy.api#documentation": "

Information about one or more customer gateways.

", - "smithy.api#xmlName": "customerGatewaySet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of DescribeCustomerGateways.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeDhcpOptions": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeDhcpOptionsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeDhcpOptionsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes one or more of your DHCP options sets.

\n

For more information, see DHCP options sets in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "DhcpOptions", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeDhcpOptionsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#DescribeDhcpOptionsRequest": { - "type": "structure", - "members": { - "DhcpOptionsIds": { - "target": "com.amazonaws.ec2#DhcpOptionsIdStringList", - "traits": { - "smithy.api#documentation": "

The IDs of one or more DHCP options sets.

\n

Default: Describes all your DHCP options sets.

", - "smithy.api#xmlName": "DhcpOptionsId" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeDhcpOptionsMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeDhcpOptionsResult": { - "type": "structure", - "members": { - "DhcpOptions": { - "target": "com.amazonaws.ec2#DhcpOptionsList", - "traits": { - "aws.protocols#ec2QueryName": "DhcpOptionsSet", - "smithy.api#documentation": "

Information about one or more DHCP options sets.

", - "smithy.api#xmlName": "dhcpOptionsSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeEgressOnlyInternetGateways": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeEgressOnlyInternetGatewaysRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeEgressOnlyInternetGatewaysResult" - }, - "traits": { - "smithy.api#documentation": "

Describes one or more of your egress-only internet gateways.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "EgressOnlyInternetGateways", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeEgressOnlyInternetGatewaysMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 255 - } - } - }, - "com.amazonaws.ec2#DescribeEgressOnlyInternetGatewaysRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "EgressOnlyInternetGatewayIds": { - "target": "com.amazonaws.ec2#EgressOnlyInternetGatewayIdList", - "traits": { - "smithy.api#documentation": "

One or more egress-only internet gateway IDs.

", - "smithy.api#xmlName": "EgressOnlyInternetGatewayId" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeEgressOnlyInternetGatewaysMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeEgressOnlyInternetGatewaysResult": { - "type": "structure", - "members": { - "EgressOnlyInternetGateways": { - "target": "com.amazonaws.ec2#EgressOnlyInternetGatewayList", - "traits": { - "aws.protocols#ec2QueryName": "EgressOnlyInternetGatewaySet", - "smithy.api#documentation": "

Information about the egress-only internet gateways.

", - "smithy.api#xmlName": "egressOnlyInternetGatewaySet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeElasticGpus": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeElasticGpusRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeElasticGpusResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the Elastic Graphics accelerator associated with your instances. For more information\n about Elastic Graphics, see Amazon Elastic Graphics.

" - } - }, - "com.amazonaws.ec2#DescribeElasticGpusMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 10, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#DescribeElasticGpusRequest": { - "type": "structure", - "members": { - "ElasticGpuIds": { - "target": "com.amazonaws.ec2#ElasticGpuIdSet", - "traits": { - "smithy.api#documentation": "

The Elastic Graphics accelerator IDs.

", - "smithy.api#xmlName": "ElasticGpuId" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeElasticGpusMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned NextToken value. This value\n can be between 5 and 1000.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token to request the next page of results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeElasticGpusResult": { - "type": "structure", - "members": { - "ElasticGpuSet": { - "target": "com.amazonaws.ec2#ElasticGpuSet", - "traits": { - "aws.protocols#ec2QueryName": "ElasticGpuSet", - "smithy.api#documentation": "

Information about the Elastic Graphics accelerators.

", - "smithy.api#xmlName": "elasticGpuSet" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "MaxResults", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

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

", - "smithy.api#xmlName": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is\n null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeExportImageTasks": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeExportImageTasksRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeExportImageTasksResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the specified export image tasks or all of your export image tasks.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ExportImageTasks", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeExportImageTasksMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 500 - } - } - }, - "com.amazonaws.ec2#DescribeExportImageTasksRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

Filter tasks using the task-state filter and one of the following values: active,\n completed, deleting, or deleted.

", - "smithy.api#xmlName": "Filter" - } - }, - "ExportImageTaskIds": { - "target": "com.amazonaws.ec2#ExportImageTaskIdList", - "traits": { - "smithy.api#documentation": "

The IDs of the export image tasks.

", - "smithy.api#xmlName": "ExportImageTaskId" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeExportImageTasksMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return in a single call.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

A token that indicates the next page of results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeExportImageTasksResult": { - "type": "structure", - "members": { - "ExportImageTasks": { - "target": "com.amazonaws.ec2#ExportImageTaskList", - "traits": { - "aws.protocols#ec2QueryName": "ExportImageTaskSet", - "smithy.api#documentation": "

Information about the export image tasks.

", - "smithy.api#xmlName": "exportImageTaskSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to get the next page of results. This value is null when there are no more results\n to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeExportTasks": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeExportTasksRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeExportTasksResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the specified export instance tasks or all of your export instance tasks.

", - "smithy.waiters#waitable": { - "ExportTaskCancelled": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "ExportTasks[].State", - "expected": "cancelled", - "comparator": "allStringEquals" - } - } - } - ], - "minDelay": 15 - }, - "ExportTaskCompleted": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "ExportTasks[].State", - "expected": "completed", - "comparator": "allStringEquals" - } - } - } - ], - "minDelay": 15 - } - } - } - }, - "com.amazonaws.ec2#DescribeExportTasksRequest": { - "type": "structure", - "members": { - "ExportTaskIds": { - "target": "com.amazonaws.ec2#ExportTaskIdStringList", - "traits": { - "aws.protocols#ec2QueryName": "ExportTaskId", - "smithy.api#documentation": "

The export task IDs.

", - "smithy.api#xmlName": "exportTaskId" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

the filters for the export tasks.

", - "smithy.api#xmlName": "Filter" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeExportTasksResult": { - "type": "structure", - "members": { - "ExportTasks": { - "target": "com.amazonaws.ec2#ExportTaskList", - "traits": { - "aws.protocols#ec2QueryName": "ExportTaskSet", - "smithy.api#documentation": "

Information about the export tasks.

", - "smithy.api#xmlName": "exportTaskSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeFastLaunchImages": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeFastLaunchImagesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeFastLaunchImagesResult" - }, - "traits": { - "smithy.api#documentation": "

Describe details for Windows AMIs that are configured for faster launching.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "FastLaunchImages", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeFastLaunchImagesRequest": { - "type": "structure", - "members": { - "ImageIds": { - "target": "com.amazonaws.ec2#FastLaunchImageIdList", - "traits": { - "smithy.api#documentation": "

Details for one or more Windows AMI image IDs.

", - "smithy.api#xmlName": "ImageId" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

Use the following filters to streamline results.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeFastLaunchImagesRequestMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeFastLaunchImagesRequestMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.ec2#DescribeFastLaunchImagesResult": { - "type": "structure", - "members": { - "FastLaunchImages": { - "target": "com.amazonaws.ec2#DescribeFastLaunchImagesSuccessSet", - "traits": { - "aws.protocols#ec2QueryName": "FastLaunchImageSet", - "smithy.api#documentation": "

A collection of details about the fast-launch enabled Windows images that meet \n\t\t\tthe requested criteria.

", - "smithy.api#xmlName": "fastLaunchImageSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeFastLaunchImagesSuccessItem": { - "type": "structure", - "members": { - "ImageId": { - "target": "com.amazonaws.ec2#ImageId", - "traits": { - "aws.protocols#ec2QueryName": "ImageId", - "smithy.api#documentation": "

The image ID that identifies the fast-launch enabled Windows image.

", - "smithy.api#xmlName": "imageId" - } - }, - "ResourceType": { - "target": "com.amazonaws.ec2#FastLaunchResourceType", - "traits": { - "aws.protocols#ec2QueryName": "ResourceType", - "smithy.api#documentation": "

The resource type that is used for pre-provisioning the Windows AMI. Supported values \n\t\t\tinclude: snapshot.

", - "smithy.api#xmlName": "resourceType" - } - }, - "SnapshotConfiguration": { - "target": "com.amazonaws.ec2#FastLaunchSnapshotConfigurationResponse", - "traits": { - "aws.protocols#ec2QueryName": "SnapshotConfiguration", - "smithy.api#documentation": "

A group of parameters that are used for pre-provisioning the associated \n\t\t\tWindows AMI using snapshots.

", - "smithy.api#xmlName": "snapshotConfiguration" - } - }, - "LaunchTemplate": { - "target": "com.amazonaws.ec2#FastLaunchLaunchTemplateSpecificationResponse", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplate", - "smithy.api#documentation": "

The launch template that the fast-launch enabled Windows AMI uses when it launches \n\t\t\tWindows instances from pre-provisioned snapshots.

", - "smithy.api#xmlName": "launchTemplate" - } - }, - "MaxParallelLaunches": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "MaxParallelLaunches", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of instances that Amazon EC2 can launch at the same time to create \n\t\t\tpre-provisioned snapshots for Windows faster launching.

", - "smithy.api#xmlName": "maxParallelLaunches" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The owner ID for the fast-launch enabled Windows AMI.

", - "smithy.api#xmlName": "ownerId" - } - }, - "State": { - "target": "com.amazonaws.ec2#FastLaunchStateCode", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The current state of faster launching for the specified Windows AMI.

", - "smithy.api#xmlName": "state" - } - }, - "StateTransitionReason": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StateTransitionReason", - "smithy.api#documentation": "

The reason that faster launching for the Windows AMI changed to the current state.

", - "smithy.api#xmlName": "stateTransitionReason" - } - }, - "StateTransitionTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "StateTransitionTime", - "smithy.api#documentation": "

The time that faster launching for the Windows AMI changed to the current state.

", - "smithy.api#xmlName": "stateTransitionTime" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describe details about a fast-launch enabled Windows image that meets the requested \n\t\t\tcriteria. Criteria are defined by the DescribeFastLaunchImages action filters.

" - } - }, - "com.amazonaws.ec2#DescribeFastLaunchImagesSuccessSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#DescribeFastLaunchImagesSuccessItem", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#DescribeFastSnapshotRestoreSuccessItem": { - "type": "structure", - "members": { - "SnapshotId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SnapshotId", - "smithy.api#documentation": "

The ID of the snapshot.

", - "smithy.api#xmlName": "snapshotId" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone.

", - "smithy.api#xmlName": "availabilityZone" - } - }, - "State": { - "target": "com.amazonaws.ec2#FastSnapshotRestoreStateCode", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of fast snapshot restores.

", - "smithy.api#xmlName": "state" - } - }, - "StateTransitionReason": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StateTransitionReason", - "smithy.api#documentation": "

The reason for the state transition. The possible values are as follows:

\n ", - "smithy.api#xmlName": "stateTransitionReason" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that enabled fast snapshot restores on the snapshot.

", - "smithy.api#xmlName": "ownerId" - } - }, - "OwnerAlias": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerAlias", - "smithy.api#documentation": "

The Amazon Web Services owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.

", - "smithy.api#xmlName": "ownerAlias" - } - }, - "EnablingTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "EnablingTime", - "smithy.api#documentation": "

The time at which fast snapshot restores entered the enabling state.

", - "smithy.api#xmlName": "enablingTime" - } - }, - "OptimizingTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "OptimizingTime", - "smithy.api#documentation": "

The time at which fast snapshot restores entered the optimizing state.

", - "smithy.api#xmlName": "optimizingTime" - } - }, - "EnabledTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "EnabledTime", - "smithy.api#documentation": "

The time at which fast snapshot restores entered the enabled state.

", - "smithy.api#xmlName": "enabledTime" - } - }, - "DisablingTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "DisablingTime", - "smithy.api#documentation": "

The time at which fast snapshot restores entered the disabling state.

", - "smithy.api#xmlName": "disablingTime" - } - }, - "DisabledTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "DisabledTime", - "smithy.api#documentation": "

The time at which fast snapshot restores entered the disabled state.

", - "smithy.api#xmlName": "disabledTime" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes fast snapshot restores for a snapshot.

" - } - }, - "com.amazonaws.ec2#DescribeFastSnapshotRestoreSuccessSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#DescribeFastSnapshotRestoreSuccessItem", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#DescribeFastSnapshotRestores": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeFastSnapshotRestoresRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeFastSnapshotRestoresResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the state of fast snapshot restores for your snapshots.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "FastSnapshotRestores", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeFastSnapshotRestoresMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.ec2#DescribeFastSnapshotRestoresRequest": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters. The possible values are:

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeFastSnapshotRestoresMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output. \n\tFor more information, see Pagination.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeFastSnapshotRestoresResult": { - "type": "structure", - "members": { - "FastSnapshotRestores": { - "target": "com.amazonaws.ec2#DescribeFastSnapshotRestoreSuccessSet", - "traits": { - "aws.protocols#ec2QueryName": "FastSnapshotRestoreSet", - "smithy.api#documentation": "

Information about the state of fast snapshot restores.

", - "smithy.api#xmlName": "fastSnapshotRestoreSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n This value is null when there are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeFleetError": { - "type": "structure", - "members": { - "LaunchTemplateAndOverrides": { - "target": "com.amazonaws.ec2#LaunchTemplateAndOverridesResponse", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateAndOverrides", - "smithy.api#documentation": "

The launch templates and overrides that were used for launching the instances. The\n values that you specify in the Overrides replace the values in the launch template.

", - "smithy.api#xmlName": "launchTemplateAndOverrides" - } - }, - "Lifecycle": { - "target": "com.amazonaws.ec2#InstanceLifecycle", - "traits": { - "aws.protocols#ec2QueryName": "Lifecycle", - "smithy.api#documentation": "

Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.

", - "smithy.api#xmlName": "lifecycle" - } - }, - "ErrorCode": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ErrorCode", - "smithy.api#documentation": "

The error code that indicates why the instance could not be launched. For more\n information about error codes, see Error codes.

", - "smithy.api#xmlName": "errorCode" - } - }, - "ErrorMessage": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ErrorMessage", - "smithy.api#documentation": "

The error message that describes why the instance could not be launched. For more\n information about error messages, see Error codes.

", - "smithy.api#xmlName": "errorMessage" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the instances that could not be launched by the fleet.

" - } - }, - "com.amazonaws.ec2#DescribeFleetHistory": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeFleetHistoryRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeFleetHistoryResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the events for the specified EC2 Fleet during the specified time.

\n

EC2 Fleet events are delayed by up to 30 seconds before they can be described. This ensures\n that you can query by the last evaluated time and not miss a recorded event. EC2 Fleet events\n are available for 48 hours.

\n

For more information, see Monitor fleet events using Amazon EventBridge in the\n Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#DescribeFleetHistoryRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "EventType": { - "target": "com.amazonaws.ec2#FleetEventType", - "traits": { - "smithy.api#documentation": "

The type of events to describe. By default, all events are described.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" - } - }, - "FleetId": { - "target": "com.amazonaws.ec2#FleetId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the EC2 Fleet.

", - "smithy.api#required": {} - } - }, - "StartTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The start date and time for the events, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeFleetHistoryResult": { - "type": "structure", - "members": { - "HistoryRecords": { - "target": "com.amazonaws.ec2#HistoryRecordSet", - "traits": { - "aws.protocols#ec2QueryName": "HistoryRecordSet", - "smithy.api#documentation": "

Information about the events in the history of the EC2 Fleet.

", - "smithy.api#xmlName": "historyRecordSet" - } - }, - "LastEvaluatedTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "LastEvaluatedTime", - "smithy.api#documentation": "

The last date and time for the events, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).\n All records up to this time were retrieved.

\n

If nextToken indicates that there are more items, this value is not\n present.

", - "smithy.api#xmlName": "lastEvaluatedTime" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - }, - "FleetId": { - "target": "com.amazonaws.ec2#FleetId", - "traits": { - "aws.protocols#ec2QueryName": "FleetId", - "smithy.api#documentation": "

The ID of the EC Fleet.

", - "smithy.api#xmlName": "fleetId" - } - }, - "StartTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "StartTime", - "smithy.api#documentation": "

The start date and time for the events, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", - "smithy.api#xmlName": "startTime" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeFleetInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeFleetInstancesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeFleetInstancesResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the running instances for the specified EC2 Fleet.

\n

For more information, see Monitor your EC2 Fleet in the Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#DescribeFleetInstancesRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" - } - }, - "FleetId": { - "target": "com.amazonaws.ec2#FleetId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the EC2 Fleet.

", - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeFleetInstancesResult": { - "type": "structure", - "members": { - "ActiveInstances": { - "target": "com.amazonaws.ec2#ActiveInstanceSet", - "traits": { - "aws.protocols#ec2QueryName": "ActiveInstanceSet", - "smithy.api#documentation": "

The running instances. This list is refreshed periodically and might be out of\n date.

", - "smithy.api#xmlName": "activeInstanceSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - }, - "FleetId": { - "target": "com.amazonaws.ec2#FleetId", - "traits": { - "aws.protocols#ec2QueryName": "FleetId", - "smithy.api#documentation": "

The ID of the EC2 Fleet.

", - "smithy.api#xmlName": "fleetId" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeFleets": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeFleetsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeFleetsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the specified EC2 Fleets or all of your EC2 Fleets.

\n

For more information, see Monitor your EC2 Fleet in the Amazon EC2 User Guide.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Fleets", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeFleetsErrorSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#DescribeFleetError", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#DescribeFleetsInstances": { - "type": "structure", - "members": { - "LaunchTemplateAndOverrides": { - "target": "com.amazonaws.ec2#LaunchTemplateAndOverridesResponse", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateAndOverrides", - "smithy.api#documentation": "

The launch templates and overrides that were used for launching the instances. The\n values that you specify in the Overrides replace the values in the launch template.

", - "smithy.api#xmlName": "launchTemplateAndOverrides" - } - }, - "Lifecycle": { - "target": "com.amazonaws.ec2#InstanceLifecycle", - "traits": { - "aws.protocols#ec2QueryName": "Lifecycle", - "smithy.api#documentation": "

Indicates if the instance that was launched is a Spot Instance or On-Demand Instance.

", - "smithy.api#xmlName": "lifecycle" - } - }, - "InstanceIds": { - "target": "com.amazonaws.ec2#InstanceIdsSet", - "traits": { - "aws.protocols#ec2QueryName": "InstanceIds", - "smithy.api#documentation": "

The IDs of the instances.

", - "smithy.api#xmlName": "instanceIds" - } - }, - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type.

", - "smithy.api#xmlName": "instanceType" - } - }, - "Platform": { - "target": "com.amazonaws.ec2#PlatformValues", - "traits": { - "aws.protocols#ec2QueryName": "Platform", - "smithy.api#documentation": "

The value is Windows for Windows instances. Otherwise, the value is\n blank.

", - "smithy.api#xmlName": "platform" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the instances that were launched by the fleet.

" - } - }, - "com.amazonaws.ec2#DescribeFleetsInstancesSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#DescribeFleetsInstances", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#DescribeFleetsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" - } - }, - "FleetIds": { - "target": "com.amazonaws.ec2#FleetIdSet", - "traits": { - "smithy.api#documentation": "

The IDs of the EC2 Fleets.

\n \n

If a fleet is of type instant, you must specify the fleet ID, otherwise\n it does not appear in the response.

\n ", - "smithy.api#xmlName": "FleetId" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeFleetsResult": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - }, - "Fleets": { - "target": "com.amazonaws.ec2#FleetSet", - "traits": { - "aws.protocols#ec2QueryName": "FleetSet", - "smithy.api#documentation": "

Information about the EC2 Fleets.

", - "smithy.api#xmlName": "fleetSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeFlowLogs": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeFlowLogsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeFlowLogsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes one or more flow logs.

\n

To view the published flow log records, you must view the log destination. For example, \n the CloudWatch Logs log group, the Amazon S3 bucket, or the Kinesis Data Firehose delivery stream.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "FlowLogs", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeFlowLogsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "Filter": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n " - } - }, - "FlowLogIds": { - "target": "com.amazonaws.ec2#FlowLogIdList", - "traits": { - "smithy.api#documentation": "

One or more flow log IDs.

\n

Constraint: Maximum of 1000 flow log IDs.

", - "smithy.api#xmlName": "FlowLogId" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token to request the next page of items. Pagination continues from the end of the items returned by the previous request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeFlowLogsResult": { - "type": "structure", - "members": { - "FlowLogs": { - "target": "com.amazonaws.ec2#FlowLogSet", - "traits": { - "aws.protocols#ec2QueryName": "FlowLogSet", - "smithy.api#documentation": "

Information about the flow logs.

", - "smithy.api#xmlName": "flowLogSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to request the next page of items. This value is null when there are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeFpgaImageAttribute": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeFpgaImageAttributeRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeFpgaImageAttributeResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the specified attribute of the specified Amazon FPGA Image (AFI).

" - } - }, - "com.amazonaws.ec2#DescribeFpgaImageAttributeRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "FpgaImageId": { - "target": "com.amazonaws.ec2#FpgaImageId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the AFI.

", - "smithy.api#required": {} - } - }, - "Attribute": { - "target": "com.amazonaws.ec2#FpgaImageAttributeName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The AFI attribute.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeFpgaImageAttributeResult": { - "type": "structure", - "members": { - "FpgaImageAttribute": { - "target": "com.amazonaws.ec2#FpgaImageAttribute", - "traits": { - "aws.protocols#ec2QueryName": "FpgaImageAttribute", - "smithy.api#documentation": "

Information about the attribute.

", - "smithy.api#xmlName": "fpgaImageAttribute" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeFpgaImages": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeFpgaImagesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeFpgaImagesResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the Amazon FPGA Images (AFIs) available to you. These include public AFIs,\n\t\t\tprivate AFIs that you own, and AFIs owned by other Amazon Web Services accounts for which you have load\n\t\t\tpermissions.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "FpgaImages", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeFpgaImagesMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#DescribeFpgaImagesRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "FpgaImageIds": { - "target": "com.amazonaws.ec2#FpgaImageIdList", - "traits": { - "smithy.api#documentation": "

The AFI IDs.

", - "smithy.api#xmlName": "FpgaImageId" - } - }, - "Owners": { - "target": "com.amazonaws.ec2#OwnerStringList", - "traits": { - "smithy.api#documentation": "

Filters the AFI by owner. Specify an Amazon Web Services account ID, self \n\t\t\t(owner is the sender of the request), or an Amazon Web Services owner alias (valid values are \n\t\t\tamazon | aws-marketplace).

", - "smithy.api#xmlName": "Owner" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token to retrieve the next page of results.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeFpgaImagesMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return in a single call.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeFpgaImagesResult": { - "type": "structure", - "members": { - "FpgaImages": { - "target": "com.amazonaws.ec2#FpgaImageList", - "traits": { - "aws.protocols#ec2QueryName": "FpgaImageSet", - "smithy.api#documentation": "

Information about the FPGA images.

", - "smithy.api#xmlName": "fpgaImageSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeHostReservationOfferings": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeHostReservationOfferingsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeHostReservationOfferingsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the Dedicated Host reservations that are available to purchase.

\n

The results describe all of the Dedicated Host reservation offerings, including\n offerings that might not match the instance family and Region of your Dedicated Hosts.\n When purchasing an offering, ensure that the instance family and Region of the offering\n matches that of the Dedicated Hosts with which it is to be associated. For more\n information about supported instance types, see Dedicated Hosts\n in the Amazon EC2 User Guide.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "OfferingSet", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeHostReservationOfferingsRequest": { - "type": "structure", - "members": { - "Filter": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n " - } - }, - "MaxDuration": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

This is the maximum duration of the reservation to purchase, specified in seconds.\n Reservations are available in one-year and three-year terms. The number of seconds\n specified must be the number of seconds in a year (365x24x60x60) times one of the\n supported durations (1 or 3). For example, specify 94608000 for three years.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeHostReservationsMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#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": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

This is the minimum duration of the reservation you'd like to purchase, specified in\n seconds. Reservations are available in one-year and three-year terms. The number of\n seconds specified must be the number of seconds in a year (365x24x60x60) times one of\n the supported durations (1 or 3). For example, specify 31536000 for one year.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" - } - }, - "OfferingId": { - "target": "com.amazonaws.ec2#OfferingId", - "traits": { - "smithy.api#documentation": "

The ID of the reservation offering.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeHostReservationOfferingsResult": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - }, - "OfferingSet": { - "target": "com.amazonaws.ec2#HostOfferingSet", - "traits": { - "aws.protocols#ec2QueryName": "OfferingSet", - "smithy.api#documentation": "

Information about the offerings.

", - "smithy.api#xmlName": "offeringSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeHostReservations": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeHostReservationsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeHostReservationsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes reservations that are associated with Dedicated Hosts in your\n account.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "HostReservationSet", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeHostReservationsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 500 - } - } - }, - "com.amazonaws.ec2#DescribeHostReservationsRequest": { - "type": "structure", - "members": { - "Filter": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n " - } - }, - "HostReservationIdSet": { - "target": "com.amazonaws.ec2#HostReservationIdSet", - "traits": { - "smithy.api#documentation": "

The host reservation IDs.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#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": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeHostReservationsResult": { - "type": "structure", - "members": { - "HostReservationSet": { - "target": "com.amazonaws.ec2#HostReservationSet", - "traits": { - "aws.protocols#ec2QueryName": "HostReservationSet", - "smithy.api#documentation": "

Details about the reservation's configuration.

", - "smithy.api#xmlName": "hostReservationSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeHosts": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeHostsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeHostsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the specified Dedicated Hosts or all your Dedicated Hosts.

\n

The results describe only the Dedicated Hosts in the Region you're currently using.\n All listed instances consume capacity on your Dedicated Host. Dedicated Hosts that have\n recently been released are listed with the state released.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Hosts", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeHostsRequest": { - "type": "structure", - "members": { - "Filter": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "aws.protocols#ec2QueryName": "Filter", - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "filter" - } - }, - "HostIds": { - "target": "com.amazonaws.ec2#RequestHostIdList", - "traits": { - "aws.protocols#ec2QueryName": "HostId", - "smithy.api#documentation": "

The IDs of the Dedicated Hosts. The IDs are used for targeted instance\n launches.

", - "smithy.api#xmlName": "hostId" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "MaxResults", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#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.

\n

You cannot specify this parameter and the host IDs parameter in the same\n request.

", - "smithy.api#xmlName": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeHostsResult": { - "type": "structure", - "members": { - "Hosts": { - "target": "com.amazonaws.ec2#HostList", - "traits": { - "aws.protocols#ec2QueryName": "HostSet", - "smithy.api#documentation": "

Information about the Dedicated Hosts.

", - "smithy.api#xmlName": "hostSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeIamInstanceProfileAssociations": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeIamInstanceProfileAssociationsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeIamInstanceProfileAssociationsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes your IAM instance profile associations.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "IamInstanceProfileAssociations", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeIamInstanceProfileAssociationsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#DescribeIamInstanceProfileAssociationsRequest": { - "type": "structure", - "members": { - "AssociationIds": { - "target": "com.amazonaws.ec2#AssociationIdList", - "traits": { - "smithy.api#documentation": "

The IAM instance profile associations.

", - "smithy.api#xmlName": "AssociationId" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeIamInstanceProfileAssociationsMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request. To get the next page of\n items, make another request with the token returned in the output. For more information, \n see Pagination.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeIamInstanceProfileAssociationsResult": { - "type": "structure", - "members": { - "IamInstanceProfileAssociations": { - "target": "com.amazonaws.ec2#IamInstanceProfileAssociationSet", - "traits": { - "aws.protocols#ec2QueryName": "IamInstanceProfileAssociationSet", - "smithy.api#documentation": "

Information about the IAM instance profile associations.

", - "smithy.api#xmlName": "iamInstanceProfileAssociationSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n This value is null when there are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeIdFormat": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeIdFormatRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeIdFormatResult" - }, - "traits": { - "smithy.api#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.

\n

The following resource types support longer IDs: bundle |\n conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | instance | internet-gateway |\n network-acl | network-acl-association |\n network-interface | network-interface-attachment |\n prefix-list | reservation | route-table |\n route-table-association | security-group |\n snapshot | subnet |\n subnet-cidr-block-association | volume | vpc\n | vpc-cidr-block-association | vpc-endpoint |\n vpc-peering-connection | vpn-connection | vpn-gateway.

\n

These settings apply to the IAM user who makes the request; they do not apply to the entire\n Amazon Web Services account. By default, an IAM user defaults to the same settings as the root user, unless\n they explicitly override the settings by running the ModifyIdFormat command. Resources\n created with longer IDs are visible to all IAM users, regardless of these settings and\n provided that they have permission to use the relevant Describe command for the\n resource type.

" - } - }, - "com.amazonaws.ec2#DescribeIdFormatRequest": { - "type": "structure", - "members": { - "Resource": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The type of resource: bundle |\n conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | instance | internet-gateway |\n network-acl | network-acl-association |\n network-interface | network-interface-attachment |\n prefix-list | reservation | route-table |\n route-table-association | security-group |\n snapshot | subnet |\n subnet-cidr-block-association | volume | vpc\n | vpc-cidr-block-association | vpc-endpoint |\n vpc-peering-connection | vpn-connection | vpn-gateway\n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeIdFormatResult": { - "type": "structure", - "members": { - "Statuses": { - "target": "com.amazonaws.ec2#IdFormatList", - "traits": { - "aws.protocols#ec2QueryName": "StatusSet", - "smithy.api#documentation": "

Information about the ID format for the resource.

", - "smithy.api#xmlName": "statusSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeIdentityIdFormat": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeIdentityIdFormatRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeIdentityIdFormatResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the ID format settings for resources for the specified IAM user, IAM role, or root\n user. For example, you can view the resource types that are enabled for longer IDs. This request only\n returns information about resource types whose ID formats can be modified; it does not return\n information about other resource types. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.

\n

The following resource types support longer IDs: bundle |\n conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | instance | internet-gateway |\n network-acl | network-acl-association |\n network-interface | network-interface-attachment |\n prefix-list | reservation | route-table |\n route-table-association | security-group |\n snapshot | subnet |\n subnet-cidr-block-association | volume | vpc\n | vpc-cidr-block-association | vpc-endpoint |\n vpc-peering-connection | vpn-connection | vpn-gateway.

\n

These settings apply to the principal specified in the request. They do not apply to the\n principal that makes the request.

" - } - }, - "com.amazonaws.ec2#DescribeIdentityIdFormatRequest": { - "type": "structure", - "members": { - "PrincipalArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrincipalArn", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ARN of the principal, which can be an IAM role, IAM user, or the root user.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "principalArn" - } - }, - "Resource": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Resource", - "smithy.api#documentation": "

The type of resource: bundle |\n conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | instance | internet-gateway |\n network-acl | network-acl-association |\n network-interface | network-interface-attachment |\n prefix-list | reservation | route-table |\n route-table-association | security-group |\n snapshot | subnet |\n subnet-cidr-block-association | volume | vpc\n | vpc-cidr-block-association | vpc-endpoint |\n vpc-peering-connection | vpn-connection | vpn-gateway\n

", - "smithy.api#xmlName": "resource" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeIdentityIdFormatResult": { - "type": "structure", - "members": { - "Statuses": { - "target": "com.amazonaws.ec2#IdFormatList", - "traits": { - "aws.protocols#ec2QueryName": "StatusSet", - "smithy.api#documentation": "

Information about the ID format for the resources.

", - "smithy.api#xmlName": "statusSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeImageAttribute": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeImageAttributeRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ImageAttribute" - }, - "traits": { - "smithy.api#documentation": "

Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.

" - } - }, - "com.amazonaws.ec2#DescribeImageAttributeRequest": { - "type": "structure", - "members": { - "Attribute": { - "target": "com.amazonaws.ec2#ImageAttributeName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The AMI attribute.

\n

\n Note: The blockDeviceMapping attribute is deprecated. \n \t Using this attribute returns the Client.AuthFailure error. To get information about \n \t the block device mappings for an AMI, use the DescribeImages action.

", - "smithy.api#required": {} - } - }, - "ImageId": { - "target": "com.amazonaws.ec2#ImageId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the AMI.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for DescribeImageAttribute.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeImages": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeImagesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeImagesResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.

\n

The images available to you include public images, private images that you own, and private images owned by other \n Amazon Web Services accounts for which you have explicit launch permissions.

\n

Recently deregistered images appear in the returned results for a short interval and then\n return empty results. After all instances that reference a deregistered AMI are terminated,\n specifying the ID of the image will eventually return an error indicating that the AMI ID\n cannot be found.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Images", - "pageSize": "MaxResults" - }, - "smithy.api#suppress": ["WaitableTraitInvalidErrorType"], - "smithy.waiters#waitable": { - "ImageAvailable": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "Images[].State", - "expected": "available", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Images[].State", - "expected": "failed", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 15 - }, - "ImageExists": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "length(Images[]) > `0`", - "expected": "true", - "comparator": "booleanEquals" - } - } - }, - { - "state": "retry", - "matcher": { - "errorType": "InvalidAMIID.NotFound" - } - } - ], - "minDelay": 15 - } - } - } - }, - "com.amazonaws.ec2#DescribeImagesRequest": { - "type": "structure", - "members": { - "ExecutableUsers": { - "target": "com.amazonaws.ec2#ExecutableByStringList", - "traits": { - "smithy.api#documentation": "

Scopes the images by users with explicit launch permissions. \n Specify an Amazon Web Services account ID, self (the sender of the request),\n\t\t\t\tor all (public AMIs).

\n ", - "smithy.api#xmlName": "ExecutableBy" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "ImageIds": { - "target": "com.amazonaws.ec2#ImageIdStringList", - "traits": { - "smithy.api#documentation": "

The image IDs.

\n

Default: Describes all images available to you.

", - "smithy.api#xmlName": "ImageId" - } - }, - "Owners": { - "target": "com.amazonaws.ec2#OwnerStringList", - "traits": { - "smithy.api#documentation": "

Scopes the results to images with the specified owners. You can specify a combination of \n Amazon Web Services account IDs, self, amazon, and aws-marketplace. \n If you omit this parameter, the results include all images for which you have launch permissions, \n regardless of ownership.

", - "smithy.api#xmlName": "Owner" - } - }, - "IncludeDeprecated": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether to include deprecated AMIs.

\n

Default: No deprecated AMIs are included in the response.

\n \n

If you are the AMI owner, all deprecated AMIs appear in the response regardless of what\n you specify for this parameter.

\n " - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeImagesResult": { - "type": "structure", - "members": { - "Images": { - "target": "com.amazonaws.ec2#ImageList", - "traits": { - "aws.protocols#ec2QueryName": "ImagesSet", - "smithy.api#documentation": "

Information about the images.

", - "smithy.api#xmlName": "imagesSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeImportImageTasks": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeImportImageTasksRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeImportImageTasksResult" - }, - "traits": { - "smithy.api#documentation": "

Displays details about an import virtual machine or import snapshot tasks that are already created.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ImportImageTasks", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeImportImageTasksRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

Filter tasks using the task-state filter and one of the following values: active,\n completed, deleting, or deleted.

", - "smithy.api#xmlName": "Filters" - } - }, - "ImportTaskIds": { - "target": "com.amazonaws.ec2#ImportTaskIdList", - "traits": { - "smithy.api#documentation": "

The IDs of the import image tasks.

", - "smithy.api#xmlName": "ImportTaskId" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return in a single call.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A token that indicates the next page of results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeImportImageTasksResult": { - "type": "structure", - "members": { - "ImportImageTasks": { - "target": "com.amazonaws.ec2#ImportImageTaskList", - "traits": { - "aws.protocols#ec2QueryName": "ImportImageTaskSet", - "smithy.api#documentation": "

A list of zero or more import image tasks that are currently active or were completed or canceled in the\n previous 7 days.

", - "smithy.api#xmlName": "importImageTaskSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to get the next page of results. This value is null when there are no more results\n to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeImportSnapshotTasks": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeImportSnapshotTasksRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeImportSnapshotTasksResult" - }, - "traits": { - "smithy.api#documentation": "

Describes your import snapshot tasks.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ImportSnapshotTasks", - "pageSize": "MaxResults" - }, - "smithy.waiters#waitable": { - "SnapshotImported": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "ImportSnapshotTasks[].SnapshotTaskDetail.Status", - "expected": "completed", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "ImportSnapshotTasks[].SnapshotTaskDetail.Status", - "expected": "error", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 15 - } - } - } - }, - "com.amazonaws.ec2#DescribeImportSnapshotTasksRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

", - "smithy.api#xmlName": "Filters" - } - }, - "ImportTaskIds": { - "target": "com.amazonaws.ec2#ImportSnapshotTaskIdList", - "traits": { - "smithy.api#documentation": "

A list of import snapshot task IDs.

", - "smithy.api#xmlName": "ImportTaskId" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining results, make another call\n with the returned NextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A token that indicates the next page of results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeImportSnapshotTasksResult": { - "type": "structure", - "members": { - "ImportSnapshotTasks": { - "target": "com.amazonaws.ec2#ImportSnapshotTaskList", - "traits": { - "aws.protocols#ec2QueryName": "ImportSnapshotTaskSet", - "smithy.api#documentation": "

A list of zero or more import snapshot tasks that are currently active or were completed or canceled in the\n previous 7 days.

", - "smithy.api#xmlName": "importSnapshotTaskSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to get the next page of results. This value is null when there are no more results\n to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeInstanceAttribute": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeInstanceAttributeRequest" - }, - "output": { - "target": "com.amazonaws.ec2#InstanceAttribute" - }, - "traits": { - "smithy.api#documentation": "

Describes the specified attribute of the specified instance. You can specify only one\n attribute at a time. Valid attribute values are: instanceType |\n kernel | ramdisk | userData |\n disableApiTermination | instanceInitiatedShutdownBehavior\n | rootDeviceName | blockDeviceMapping |\n productCodes | sourceDestCheck | groupSet |\n ebsOptimized | sriovNetSupport\n

" - } - }, - "com.amazonaws.ec2#DescribeInstanceAttributeRequest": { - "type": "structure", - "members": { - "Attribute": { - "target": "com.amazonaws.ec2#InstanceAttributeName", - "traits": { - "aws.protocols#ec2QueryName": "Attribute", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The instance attribute.

\n

Note: The enaSupport attribute is not supported at this time.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "attribute" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "instanceId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeInstanceCreditSpecifications": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeInstanceCreditSpecificationsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeInstanceCreditSpecificationsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the credit option for CPU usage of the specified burstable performance\n instances. The credit options are standard and\n unlimited.

\n

If you do not specify an instance ID, Amazon EC2 returns burstable performance\n instances with the unlimited credit option, as well as instances that were\n previously configured as T2, T3, and T3a with the unlimited credit option.\n For example, if you resize a T2 instance, while it is configured as\n unlimited, to an M4 instance, Amazon EC2 returns the M4\n instance.

\n

If you specify one or more instance IDs, Amazon EC2 returns the credit option\n (standard or unlimited) of those instances. If you specify\n an instance ID that is not valid, such as an instance that is not a burstable\n performance instance, an error is returned.

\n

Recently terminated instances might appear in the returned results. This interval is\n usually less than one hour.

\n

If an Availability Zone is experiencing a service disruption and you specify instance\n IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If\n you specify only instance IDs in an unaffected zone, the call works normally.

\n

For more information, see Burstable\n performance instances in the Amazon EC2 User Guide.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "InstanceCreditSpecifications", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeInstanceCreditSpecificationsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#DescribeInstanceCreditSpecificationsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "InstanceIds": { - "target": "com.amazonaws.ec2#InstanceIdStringList", - "traits": { - "smithy.api#documentation": "

The instance IDs.

\n

Default: Describes all your instances.

\n

Constraints: Maximum 1000 explicitly specified instance IDs.

", - "smithy.api#xmlName": "InstanceId" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeInstanceCreditSpecificationsMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

\n

You cannot specify this parameter and the instance IDs\n parameter in the same call.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeInstanceCreditSpecificationsResult": { - "type": "structure", - "members": { - "InstanceCreditSpecifications": { - "target": "com.amazonaws.ec2#InstanceCreditSpecificationList", - "traits": { - "aws.protocols#ec2QueryName": "InstanceCreditSpecificationSet", - "smithy.api#documentation": "

Information about the credit option for CPU usage of an instance.

", - "smithy.api#xmlName": "instanceCreditSpecificationSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeInstanceEventNotificationAttributes": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeInstanceEventNotificationAttributesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeInstanceEventNotificationAttributesResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the tag keys that are registered to appear in scheduled event notifications for \n \tresources in the current Region.

" - } - }, - "com.amazonaws.ec2#DescribeInstanceEventNotificationAttributesRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeInstanceEventNotificationAttributesResult": { - "type": "structure", - "members": { - "InstanceTagAttribute": { - "target": "com.amazonaws.ec2#InstanceTagNotificationAttribute", - "traits": { - "aws.protocols#ec2QueryName": "InstanceTagAttribute", - "smithy.api#documentation": "

Information about the registered tag keys.

", - "smithy.api#xmlName": "instanceTagAttribute" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeInstanceEventWindows": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeInstanceEventWindowsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeInstanceEventWindowsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the specified event windows or all event windows.

\n

If you specify event window IDs, the output includes information for only the specified\n event windows. If you specify filters, the output includes information for only those event\n windows that meet the filter criteria. If you do not specify event windows IDs or filters,\n the output includes information for all event windows, which can affect performance. We\n recommend that you use pagination to ensure that the operation returns quickly and\n successfully.

\n

For more information, see Define event windows for scheduled\n events in the Amazon EC2 User Guide.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "InstanceEventWindows", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeInstanceEventWindowsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "InstanceEventWindowIds": { - "target": "com.amazonaws.ec2#InstanceEventWindowIdSet", - "traits": { - "smithy.api#documentation": "

The IDs of the event windows.

", - "smithy.api#xmlName": "InstanceEventWindowId" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#ResultRange", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned NextToken value. This value can\n be between 20 and 500. You cannot specify this parameter and the event window IDs parameter\n in the same call.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token to request the next page of results.

" - } - } - }, - "traits": { - "smithy.api#documentation": "Describe instance event windows by InstanceEventWindow.", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeInstanceEventWindowsResult": { - "type": "structure", - "members": { - "InstanceEventWindows": { - "target": "com.amazonaws.ec2#InstanceEventWindowSet", - "traits": { - "aws.protocols#ec2QueryName": "InstanceEventWindowSet", - "smithy.api#documentation": "

Information about the event windows.

", - "smithy.api#xmlName": "instanceEventWindowSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeInstanceStatus": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeInstanceStatusRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeInstanceStatusResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the status of the specified instances or all of your instances. By default,\n only running instances are described, unless you specifically indicate to return the\n status of all instances.

\n

Instance status includes the following components:

\n ", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "InstanceStatuses", - "pageSize": "MaxResults" - }, - "smithy.api#suppress": ["WaitableTraitInvalidErrorType"], - "smithy.waiters#waitable": { - "InstanceStatusOk": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "InstanceStatuses[].InstanceStatus.Status", - "expected": "ok", - "comparator": "allStringEquals" - } - } - }, - { - "state": "retry", - "matcher": { - "errorType": "InvalidInstanceID.NotFound" - } - } - ], - "minDelay": 15 - }, - "SystemStatusOk": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "InstanceStatuses[].SystemStatus.Status", - "expected": "ok", - "comparator": "allStringEquals" - } - } - } - ], - "minDelay": 15 - } - } - } - }, - "com.amazonaws.ec2#DescribeInstanceStatusRequest": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "InstanceIds": { - "target": "com.amazonaws.ec2#InstanceIdStringList", - "traits": { - "smithy.api#documentation": "

The instance IDs.

\n

Default: Describes all your instances.

\n

Constraints: Maximum 100 explicitly specified instance IDs.

", - "smithy.api#xmlName": "InstanceId" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

\n

You cannot specify this parameter and the instance IDs parameter in the same request.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "IncludeAllInstances": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "IncludeAllInstances", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

When true, includes the health status for all instances. When\n false, includes the health status for running instances only.

\n

Default: false\n

", - "smithy.api#xmlName": "includeAllInstances" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeInstanceStatusResult": { - "type": "structure", - "members": { - "InstanceStatuses": { - "target": "com.amazonaws.ec2#InstanceStatusList", - "traits": { - "aws.protocols#ec2QueryName": "InstanceStatusSet", - "smithy.api#documentation": "

Information about the status of the instances.

", - "smithy.api#xmlName": "instanceStatusSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeInstanceTypeOfferings": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeInstanceTypeOfferingsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeInstanceTypeOfferingsResult" - }, - "traits": { - "smithy.api#documentation": "

Returns a list of all instance types offered. The results can be filtered by location (Region or Availability\n Zone). If no location is specified, the instance types offered in the current Region are returned.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "InstanceTypeOfferings", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeInstanceTypeOfferingsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request,\n and provides an error response. If you have the required permissions, the error response is\n DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - }, - "LocationType": { - "target": "com.amazonaws.ec2#LocationType", - "traits": { - "smithy.api#documentation": "

The location type.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DITOMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeInstanceTypeOfferingsResult": { - "type": "structure", - "members": { - "InstanceTypeOfferings": { - "target": "com.amazonaws.ec2#InstanceTypeOfferingsList", - "traits": { - "aws.protocols#ec2QueryName": "InstanceTypeOfferingSet", - "smithy.api#documentation": "

The instance types offered.

", - "smithy.api#xmlName": "instanceTypeOfferingSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeInstanceTypes": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeInstanceTypesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeInstanceTypesResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the details of the instance types that are offered in a location. The results can be filtered by the\n attributes of the instance types.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "InstanceTypes", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeInstanceTypesRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request,\n and provides an error response. If you have the required permissions, the error response is\n DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - }, - "InstanceTypes": { - "target": "com.amazonaws.ec2#RequestInstanceTypeList", - "traits": { - "smithy.api#documentation": "

The instance types. For more information, see Instance types in the Amazon EC2 User Guide.

", - "smithy.api#xmlName": "InstanceType" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DITMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeInstanceTypesResult": { - "type": "structure", - "members": { - "InstanceTypes": { - "target": "com.amazonaws.ec2#InstanceTypeInfoList", - "traits": { - "aws.protocols#ec2QueryName": "InstanceTypeSet", - "smithy.api#documentation": "

The instance type. For more information, see Instance types in the Amazon EC2 User Guide.

", - "smithy.api#xmlName": "instanceTypeSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeInstancesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeInstancesResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the specified instances or all instances.

\n

If you specify instance IDs, the output includes information for only the specified\n instances. If you specify filters, the output includes information for only those\n instances that meet the filter criteria. If you do not specify instance IDs or filters,\n the output includes information for all instances, which can affect performance. We\n recommend that you use pagination to ensure that the operation returns quickly and\n successfully.

\n

If you specify an instance ID that is not valid, an error is returned. If you specify\n an instance that you do not own, it is not included in the output.

\n

Recently terminated instances might appear in the returned results. This interval is\n usually less than one hour.

\n

If you describe instances in the rare case where an Availability Zone is experiencing\n a service disruption and you specify instance IDs that are in the affected zone, or do\n not specify any instance IDs at all, the call fails. If you describe instances and\n specify only instance IDs that are in an unaffected zone, the call works\n normally.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Reservations", - "pageSize": "MaxResults" - }, - "smithy.api#suppress": ["WaitableTraitInvalidErrorType"], - "smithy.waiters#waitable": { - "InstanceExists": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "length(Reservations[]) > `0`", - "expected": "true", - "comparator": "booleanEquals" - } - } - }, - { - "state": "retry", - "matcher": { - "errorType": "InvalidInstanceID.NotFound" - } - } - ], - "minDelay": 5 - }, - "InstanceRunning": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "Reservations[].Instances[].State.Name", - "expected": "running", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Reservations[].Instances[].State.Name", - "expected": "shutting-down", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Reservations[].Instances[].State.Name", - "expected": "terminated", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Reservations[].Instances[].State.Name", - "expected": "stopping", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "retry", - "matcher": { - "errorType": "InvalidInstanceID.NotFound" - } - } - ], - "minDelay": 15 - }, - "InstanceStopped": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "Reservations[].Instances[].State.Name", - "expected": "stopped", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Reservations[].Instances[].State.Name", - "expected": "pending", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Reservations[].Instances[].State.Name", - "expected": "terminated", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 15 - }, - "InstanceTerminated": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "Reservations[].Instances[].State.Name", - "expected": "terminated", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Reservations[].Instances[].State.Name", - "expected": "pending", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Reservations[].Instances[].State.Name", - "expected": "stopping", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 15 - } - } - } - }, - "com.amazonaws.ec2#DescribeInstancesRequest": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "InstanceIds": { - "target": "com.amazonaws.ec2#InstanceIdStringList", - "traits": { - "smithy.api#documentation": "

The instance IDs.

\n

Default: Describes all your instances.

", - "smithy.api#xmlName": "InstanceId" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "MaxResults", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

\n

You cannot specify this parameter and the instance IDs parameter in the same request.

", - "smithy.api#xmlName": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeInstancesResult": { - "type": "structure", - "members": { - "Reservations": { - "target": "com.amazonaws.ec2#ReservationList", - "traits": { - "aws.protocols#ec2QueryName": "ReservationSet", - "smithy.api#documentation": "

Information about the reservations.

", - "smithy.api#xmlName": "reservationSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeInternetGateways": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeInternetGatewaysRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeInternetGatewaysResult" - }, - "traits": { - "smithy.api#documentation": "

Describes one or more of your internet gateways.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "InternetGateways", - "pageSize": "MaxResults" - }, - "smithy.api#suppress": ["WaitableTraitInvalidErrorType"], - "smithy.waiters#waitable": { - "InternetGatewayExists": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "length(InternetGateways[].InternetGatewayId) > `0`", - "expected": "true", - "comparator": "booleanEquals" - } - } - }, - { - "state": "retry", - "matcher": { - "errorType": "InvalidInternetGateway.NotFound" - } - } - ], - "minDelay": 5 - } - } - } - }, - "com.amazonaws.ec2#DescribeInternetGatewaysMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#DescribeInternetGatewaysRequest": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "InternetGatewayIds": { - "target": "com.amazonaws.ec2#InternetGatewayIdList", - "traits": { - "aws.protocols#ec2QueryName": "InternetGatewayId", - "smithy.api#documentation": "

One or more internet gateway IDs.

\n

Default: Describes all your internet gateways.

", - "smithy.api#xmlName": "internetGatewayId" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeInternetGatewaysMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeInternetGatewaysResult": { - "type": "structure", - "members": { - "InternetGateways": { - "target": "com.amazonaws.ec2#InternetGatewayList", - "traits": { - "aws.protocols#ec2QueryName": "InternetGatewaySet", - "smithy.api#documentation": "

Information about one or more internet gateways.

", - "smithy.api#xmlName": "internetGatewaySet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeIpamPools": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeIpamPoolsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeIpamPoolsResult" - }, - "traits": { - "smithy.api#documentation": "

Get information about your IPAM pools.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "IpamPools", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeIpamPoolsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters for the request. For more information about filtering, see Filtering CLI output.

", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#IpamMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return in the request.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "IpamPoolIds": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#documentation": "

The IDs of the IPAM pools you would like information on.

", - "smithy.api#xmlName": "IpamPoolId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeIpamPoolsResult": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - }, - "IpamPools": { - "target": "com.amazonaws.ec2#IpamPoolSet", - "traits": { - "aws.protocols#ec2QueryName": "IpamPoolSet", - "smithy.api#documentation": "

Information about the IPAM pools.

", - "smithy.api#xmlName": "ipamPoolSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeIpamResourceDiscoveries": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeIpamResourceDiscoveriesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeIpamResourceDiscoveriesResult" - }, - "traits": { - "smithy.api#documentation": "

Describes IPAM resource discoveries. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "IpamResourceDiscoveries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeIpamResourceDiscoveriesRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "IpamResourceDiscoveryIds": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#documentation": "

The IPAM resource discovery IDs.

", - "smithy.api#xmlName": "IpamResourceDiscoveryId" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#IpamMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of resource discoveries to return in one page of results.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The resource discovery filters.

", - "smithy.api#xmlName": "Filter" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeIpamResourceDiscoveriesResult": { - "type": "structure", - "members": { - "IpamResourceDiscoveries": { - "target": "com.amazonaws.ec2#IpamResourceDiscoverySet", - "traits": { - "aws.protocols#ec2QueryName": "IpamResourceDiscoverySet", - "smithy.api#documentation": "

The resource discoveries.

", - "smithy.api#xmlName": "ipamResourceDiscoverySet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeIpamResourceDiscoveryAssociations": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeIpamResourceDiscoveryAssociationsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeIpamResourceDiscoveryAssociationsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes resource discovery association with an Amazon VPC IPAM. An associated resource discovery is a resource discovery that has been associated with an IPAM..

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "IpamResourceDiscoveryAssociations", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeIpamResourceDiscoveryAssociationsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "IpamResourceDiscoveryAssociationIds": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#documentation": "

The resource discovery association IDs.

", - "smithy.api#xmlName": "IpamResourceDiscoveryAssociationId" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#IpamMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of resource discovery associations to return in one page of results.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The resource discovery association filters.

", - "smithy.api#xmlName": "Filter" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeIpamResourceDiscoveryAssociationsResult": { - "type": "structure", - "members": { - "IpamResourceDiscoveryAssociations": { - "target": "com.amazonaws.ec2#IpamResourceDiscoveryAssociationSet", - "traits": { - "aws.protocols#ec2QueryName": "IpamResourceDiscoveryAssociationSet", - "smithy.api#documentation": "

The resource discovery associations.

", - "smithy.api#xmlName": "ipamResourceDiscoveryAssociationSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeIpamScopes": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeIpamScopesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeIpamScopesResult" - }, - "traits": { - "smithy.api#documentation": "

Get information about your IPAM scopes.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "IpamScopes", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeIpamScopesRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters for the request. For more information about filtering, see Filtering CLI output.

", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#IpamMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return in the request.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "IpamScopeIds": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#documentation": "

The IDs of the scopes you want information on.

", - "smithy.api#xmlName": "IpamScopeId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeIpamScopesResult": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - }, - "IpamScopes": { - "target": "com.amazonaws.ec2#IpamScopeSet", - "traits": { - "aws.protocols#ec2QueryName": "IpamScopeSet", - "smithy.api#documentation": "

The scopes you want information on.

", - "smithy.api#xmlName": "ipamScopeSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeIpams": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeIpamsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeIpamsResult" - }, - "traits": { - "smithy.api#documentation": "

Get information about your IPAM pools.

\n

For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.\n

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Ipams", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeIpamsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters for the request. For more information about filtering, see Filtering CLI output.

", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#IpamMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return in the request.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "IpamIds": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#documentation": "

The IDs of the IPAMs you want information on.

", - "smithy.api#xmlName": "IpamId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeIpamsResult": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - }, - "Ipams": { - "target": "com.amazonaws.ec2#IpamSet", - "traits": { - "aws.protocols#ec2QueryName": "IpamSet", - "smithy.api#documentation": "

Information about the IPAMs.

", - "smithy.api#xmlName": "ipamSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeIpv6Pools": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeIpv6PoolsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeIpv6PoolsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes your IPv6 address pools.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Ipv6Pools", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeIpv6PoolsRequest": { - "type": "structure", - "members": { - "PoolIds": { - "target": "com.amazonaws.ec2#Ipv6PoolIdList", - "traits": { - "smithy.api#documentation": "

The IDs of the IPv6 address pools.

", - "smithy.api#xmlName": "PoolId" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#Ipv6PoolMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeIpv6PoolsResult": { - "type": "structure", - "members": { - "Ipv6Pools": { - "target": "com.amazonaws.ec2#Ipv6PoolSet", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6PoolSet", - "smithy.api#documentation": "

Information about the IPv6 address pools.

", - "smithy.api#xmlName": "ipv6PoolSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeKeyPairs": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeKeyPairsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeKeyPairsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the specified key pairs or all of your key pairs.

\n

For more information about key pairs, see Amazon EC2 key pairs \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.

", - "smithy.api#suppress": ["WaitableTraitInvalidErrorType"], - "smithy.waiters#waitable": { - "KeyPairExists": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "length(KeyPairs[].KeyName) > `0`", - "expected": "true", - "comparator": "booleanEquals" - } - } - }, - { - "state": "retry", - "matcher": { - "errorType": "InvalidKeyPair.NotFound" - } - } - ], - "minDelay": 5 - } - } - } - }, - "com.amazonaws.ec2#DescribeKeyPairsRequest": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "KeyNames": { - "target": "com.amazonaws.ec2#KeyNameStringList", - "traits": { - "smithy.api#documentation": "

The key pair names.

\n

Default: Describes all of your key pairs.

", - "smithy.api#xmlName": "KeyName" - } - }, - "KeyPairIds": { - "target": "com.amazonaws.ec2#KeyPairIdStringList", - "traits": { - "smithy.api#documentation": "

The IDs of the key pairs.

", - "smithy.api#xmlName": "KeyPairId" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "IncludePublicKey": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

If true, the public key material is included in the response.

\n

Default: false\n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeKeyPairsResult": { - "type": "structure", - "members": { - "KeyPairs": { - "target": "com.amazonaws.ec2#KeyPairList", - "traits": { - "aws.protocols#ec2QueryName": "KeySet", - "smithy.api#documentation": "

Information about the key pairs.

", - "smithy.api#xmlName": "keySet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeLaunchTemplateVersions": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeLaunchTemplateVersionsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeLaunchTemplateVersionsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes one or more versions of a specified launch template. You can describe all\n versions, individual versions, or a range of versions. You can also describe all the\n latest versions or all the default versions of all the launch templates in your\n account.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "LaunchTemplateVersions", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeLaunchTemplateVersionsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" - } - }, - "LaunchTemplateId": { - "target": "com.amazonaws.ec2#LaunchTemplateId", - "traits": { - "smithy.api#documentation": "

The ID of the launch template.

\n

To describe one or more versions of a specified launch template, you must specify\n either the LaunchTemplateId or the LaunchTemplateName, but not\n both.

\n

To describe all the latest or default launch template versions in your account, you\n must omit this parameter.

" - } - }, - "LaunchTemplateName": { - "target": "com.amazonaws.ec2#LaunchTemplateName", - "traits": { - "smithy.api#documentation": "

The name of the launch template.

\n

To describe one or more versions of a specified launch template, you must specify\n either the LaunchTemplateName or the LaunchTemplateId, but not\n both.

\n

To describe all the latest or default launch template versions in your account, you\n must omit this parameter.

" - } - }, - "Versions": { - "target": "com.amazonaws.ec2#VersionStringList", - "traits": { - "smithy.api#documentation": "

One or more versions of the launch template. Valid values depend on whether you are\n describing a specified launch template (by ID or name) or all launch templates in your\n account.

\n

To describe one or more versions of a specified launch template, valid values are\n $Latest, $Default, and numbers.

\n

To describe all launch templates in your account that are defined as the latest\n version, the valid value is $Latest. To describe all launch templates in\n your account that are defined as the default version, the valid value is\n $Default. You can specify $Latest and\n $Default in the same request. You cannot specify numbers.

", - "smithy.api#xmlName": "LaunchTemplateVersion" - } - }, - "MinVersion": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The version number after which to describe launch template versions.

" - } - }, - "MaxVersion": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The version number up to which to describe launch template versions.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token to request the next page of results.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned NextToken value. This value\n can be between 1 and 200.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "ResolveAlias": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

If true, and if a Systems Manager parameter is specified for ImageId,\n the AMI ID is displayed in the response for imageId.

\n

If false, and if a Systems Manager parameter is specified for ImageId,\n the parameter is displayed in the response for imageId.

\n

For more information, see Use a Systems \n Manager parameter instead of an AMI ID in the Amazon Elastic Compute Cloud User Guide.

\n

Default: false\n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeLaunchTemplateVersionsResult": { - "type": "structure", - "members": { - "LaunchTemplateVersions": { - "target": "com.amazonaws.ec2#LaunchTemplateVersionSet", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateVersionSet", - "smithy.api#documentation": "

Information about the launch template versions.

", - "smithy.api#xmlName": "launchTemplateVersionSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null\n when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeLaunchTemplates": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeLaunchTemplatesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeLaunchTemplatesResult" - }, - "traits": { - "smithy.api#documentation": "

Describes one or more launch templates.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "LaunchTemplates", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeLaunchTemplatesMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.ec2#DescribeLaunchTemplatesRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" - } - }, - "LaunchTemplateIds": { - "target": "com.amazonaws.ec2#LaunchTemplateIdStringList", - "traits": { - "smithy.api#documentation": "

One or more launch template IDs.

", - "smithy.api#xmlName": "LaunchTemplateId" - } - }, - "LaunchTemplateNames": { - "target": "com.amazonaws.ec2#LaunchTemplateNameStringList", - "traits": { - "smithy.api#documentation": "

One or more launch template names.

", - "smithy.api#xmlName": "LaunchTemplateName" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token to request the next page of results.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeLaunchTemplatesMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned NextToken value. This value\n can be between 1 and 200.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeLaunchTemplatesResult": { - "type": "structure", - "members": { - "LaunchTemplates": { - "target": "com.amazonaws.ec2#LaunchTemplateSet", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplates", - "smithy.api#documentation": "

Information about the launch templates.

", - "smithy.api#xmlName": "launchTemplates" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null\n when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the associations between virtual interface groups and local gateway route tables.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "LocalGatewayRouteTableVirtualInterfaceGroupAssociations", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest": { - "type": "structure", - "members": { - "LocalGatewayRouteTableVirtualInterfaceGroupAssociationIds": { - "target": "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociationIdSet", - "traits": { - "smithy.api#documentation": "

The IDs of the associations.

", - "smithy.api#xmlName": "LocalGatewayRouteTableVirtualInterfaceGroupAssociationId" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#LocalGatewayMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult": { - "type": "structure", - "members": { - "LocalGatewayRouteTableVirtualInterfaceGroupAssociations": { - "target": "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociationSet", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayRouteTableVirtualInterfaceGroupAssociationSet", - "smithy.api#documentation": "

Information about the associations.

", - "smithy.api#xmlName": "localGatewayRouteTableVirtualInterfaceGroupAssociationSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVpcAssociations": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVpcAssociationsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVpcAssociationsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the specified associations between VPCs and local gateway route tables.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "LocalGatewayRouteTableVpcAssociations", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVpcAssociationsRequest": { - "type": "structure", - "members": { - "LocalGatewayRouteTableVpcAssociationIds": { - "target": "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociationIdSet", - "traits": { - "smithy.api#documentation": "

The IDs of the associations.

", - "smithy.api#xmlName": "LocalGatewayRouteTableVpcAssociationId" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#LocalGatewayMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVpcAssociationsResult": { - "type": "structure", - "members": { - "LocalGatewayRouteTableVpcAssociations": { - "target": "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociationSet", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayRouteTableVpcAssociationSet", - "smithy.api#documentation": "

Information about the associations.

", - "smithy.api#xmlName": "localGatewayRouteTableVpcAssociationSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeLocalGatewayRouteTables": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeLocalGatewayRouteTablesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeLocalGatewayRouteTablesResult" - }, - "traits": { - "smithy.api#documentation": "

Describes one or more local gateway route tables. By default, all local gateway route tables are described.\n Alternatively, you can filter the results.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "LocalGatewayRouteTables", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeLocalGatewayRouteTablesRequest": { - "type": "structure", - "members": { - "LocalGatewayRouteTableIds": { - "target": "com.amazonaws.ec2#LocalGatewayRouteTableIdSet", - "traits": { - "smithy.api#documentation": "

The IDs of the local gateway route tables.

", - "smithy.api#xmlName": "LocalGatewayRouteTableId" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#LocalGatewayMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeLocalGatewayRouteTablesResult": { - "type": "structure", - "members": { - "LocalGatewayRouteTables": { - "target": "com.amazonaws.ec2#LocalGatewayRouteTableSet", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayRouteTableSet", - "smithy.api#documentation": "

Information about the local gateway route tables.

", - "smithy.api#xmlName": "localGatewayRouteTableSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfaceGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfaceGroupsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfaceGroupsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the specified local gateway virtual interface groups.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "LocalGatewayVirtualInterfaceGroups", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfaceGroupsRequest": { - "type": "structure", - "members": { - "LocalGatewayVirtualInterfaceGroupIds": { - "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupIdSet", - "traits": { - "smithy.api#documentation": "

The IDs of the virtual interface groups.

", - "smithy.api#xmlName": "LocalGatewayVirtualInterfaceGroupId" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#LocalGatewayMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfaceGroupsResult": { - "type": "structure", - "members": { - "LocalGatewayVirtualInterfaceGroups": { - "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupSet", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayVirtualInterfaceGroupSet", - "smithy.api#documentation": "

The virtual interface groups.

", - "smithy.api#xmlName": "localGatewayVirtualInterfaceGroupSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfaces": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfacesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfacesResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the specified local gateway virtual interfaces.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "LocalGatewayVirtualInterfaces", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfacesRequest": { - "type": "structure", - "members": { - "LocalGatewayVirtualInterfaceIds": { - "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceIdSet", - "traits": { - "smithy.api#documentation": "

The IDs of the virtual interfaces.

", - "smithy.api#xmlName": "LocalGatewayVirtualInterfaceId" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#LocalGatewayMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfacesResult": { - "type": "structure", - "members": { - "LocalGatewayVirtualInterfaces": { - "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceSet", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayVirtualInterfaceSet", - "smithy.api#documentation": "

Information about the virtual interfaces.

", - "smithy.api#xmlName": "localGatewayVirtualInterfaceSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeLocalGateways": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeLocalGatewaysRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeLocalGatewaysResult" - }, - "traits": { - "smithy.api#documentation": "

Describes one or more local gateways. By default, all local gateways are described. \n Alternatively, you can filter the results.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "LocalGateways", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeLocalGatewaysRequest": { - "type": "structure", - "members": { - "LocalGatewayIds": { - "target": "com.amazonaws.ec2#LocalGatewayIdSet", - "traits": { - "smithy.api#documentation": "

The IDs of the local gateways.

", - "smithy.api#xmlName": "LocalGatewayId" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#LocalGatewayMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeLocalGatewaysResult": { - "type": "structure", - "members": { - "LocalGateways": { - "target": "com.amazonaws.ec2#LocalGatewaySet", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewaySet", - "smithy.api#documentation": "

Information about the local gateways.

", - "smithy.api#xmlName": "localGatewaySet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeManagedPrefixLists": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeManagedPrefixListsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeManagedPrefixListsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes your managed prefix lists and any Amazon Web Services-managed prefix lists.

\n

To view the entries for your prefix list, use GetManagedPrefixListEntries.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "PrefixLists", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeManagedPrefixListsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#PrefixListMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "PrefixListIds": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#documentation": "

One or more prefix list IDs.

", - "smithy.api#xmlName": "PrefixListId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeManagedPrefixListsResult": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - }, - "PrefixLists": { - "target": "com.amazonaws.ec2#ManagedPrefixListSet", - "traits": { - "aws.protocols#ec2QueryName": "PrefixListSet", - "smithy.api#documentation": "

Information about the prefix lists.

", - "smithy.api#xmlName": "prefixListSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeMovingAddresses": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeMovingAddressesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeMovingAddressesResult" - }, - "traits": { - "smithy.api#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.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "MovingAddressStatuses", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeMovingAddressesMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#DescribeMovingAddressesRequest": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "aws.protocols#ec2QueryName": "Filter", - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "filter" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeMovingAddressesMaxResults", - "traits": { - "aws.protocols#ec2QueryName": "MaxResults", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining\n results of the initial request can be seen by sending another request with the returned\n NextToken value. This value can be between 5 and 1000; if\n MaxResults is given a value outside of this range, an error is returned.

\n

Default: If no value is provided, the default is 1000.

", - "smithy.api#xmlName": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token for the next page of results.

", - "smithy.api#xmlName": "nextToken" - } - }, - "PublicIps": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "PublicIp", - "smithy.api#documentation": "

One or more Elastic IP addresses.

", - "smithy.api#xmlName": "publicIp" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeMovingAddressesResult": { - "type": "structure", - "members": { - "MovingAddressStatuses": { - "target": "com.amazonaws.ec2#MovingAddressStatusSet", - "traits": { - "aws.protocols#ec2QueryName": "MovingAddressStatusSet", - "smithy.api#documentation": "

The status for each Elastic IP address.

", - "smithy.api#xmlName": "movingAddressStatusSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeNatGateways": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeNatGatewaysRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeNatGatewaysResult" - }, - "traits": { - "smithy.api#documentation": "

Describes one or more of your NAT gateways.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "NatGateways", - "pageSize": "MaxResults" - }, - "smithy.api#suppress": ["WaitableTraitInvalidErrorType"], - "smithy.waiters#waitable": { - "NatGatewayAvailable": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "NatGateways[].State", - "expected": "available", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "NatGateways[].State", - "expected": "failed", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "NatGateways[].State", - "expected": "deleting", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "NatGateways[].State", - "expected": "deleted", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "retry", - "matcher": { - "errorType": "NatGatewayNotFound" - } - } - ], - "minDelay": 15 - }, - "NatGatewayDeleted": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "NatGateways[].State", - "expected": "deleted", - "comparator": "allStringEquals" - } - } - }, - { - "state": "success", - "matcher": { - "errorType": "NatGatewayNotFound" - } - } - ], - "minDelay": 15 - } - } - } - }, - "com.amazonaws.ec2#DescribeNatGatewaysMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#DescribeNatGatewaysRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "Filter": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n " - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeNatGatewaysMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" - } - }, - "NatGatewayIds": { - "target": "com.amazonaws.ec2#NatGatewayIdStringList", - "traits": { - "smithy.api#documentation": "

One or more NAT gateway IDs.

", - "smithy.api#xmlName": "NatGatewayId" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeNatGatewaysResult": { - "type": "structure", - "members": { - "NatGateways": { - "target": "com.amazonaws.ec2#NatGatewayList", - "traits": { - "aws.protocols#ec2QueryName": "NatGatewaySet", - "smithy.api#documentation": "

Information about the NAT gateways.

", - "smithy.api#xmlName": "natGatewaySet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeNetworkAcls": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeNetworkAclsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeNetworkAclsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes one or more of your network ACLs.

\n

For more information, see Network ACLs in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "NetworkAcls", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeNetworkAclsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#DescribeNetworkAclsRequest": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "NetworkAclIds": { - "target": "com.amazonaws.ec2#NetworkAclIdStringList", - "traits": { - "smithy.api#documentation": "

One or more network ACL IDs.

\n

Default: Describes all your network ACLs.

", - "smithy.api#xmlName": "NetworkAclId" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeNetworkAclsMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeNetworkAclsResult": { - "type": "structure", - "members": { - "NetworkAcls": { - "target": "com.amazonaws.ec2#NetworkAclList", - "traits": { - "aws.protocols#ec2QueryName": "NetworkAclSet", - "smithy.api#documentation": "

Information about one or more network ACLs.

", - "smithy.api#xmlName": "networkAclSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopeAnalyses": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopeAnalysesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopeAnalysesResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the specified Network Access Scope analyses.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "NetworkInsightsAccessScopeAnalyses", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopeAnalysesRequest": { - "type": "structure", - "members": { - "NetworkInsightsAccessScopeAnalysisIds": { - "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisIdList", - "traits": { - "smithy.api#documentation": "

The IDs of the Network Access Scope analyses.

", - "smithy.api#xmlName": "NetworkInsightsAccessScopeAnalysisId" - } - }, - "NetworkInsightsAccessScopeId": { - "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", - "traits": { - "smithy.api#documentation": "

The ID of the Network Access Scope.

" - } - }, - "AnalysisStartTimeBegin": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "smithy.api#documentation": "

Filters the results based on the start time. The analysis must have started on or after this time.

" - } - }, - "AnalysisStartTimeEnd": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "smithy.api#documentation": "

Filters the results based on the start time. The analysis must have started on or before this time.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

There are no supported filters.

", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#NetworkInsightsMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopeAnalysesResult": { - "type": "structure", - "members": { - "NetworkInsightsAccessScopeAnalyses": { - "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisList", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeAnalysisSet", - "smithy.api#documentation": "

The Network Access Scope analyses.

", - "smithy.api#xmlName": "networkInsightsAccessScopeAnalysisSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopes": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopesResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the specified Network Access Scopes.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "NetworkInsightsAccessScopes", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopesRequest": { - "type": "structure", - "members": { - "NetworkInsightsAccessScopeIds": { - "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeIdList", - "traits": { - "smithy.api#documentation": "

The IDs of the Network Access Scopes.

", - "smithy.api#xmlName": "NetworkInsightsAccessScopeId" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

There are no supported filters.

", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#NetworkInsightsMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopesResult": { - "type": "structure", - "members": { - "NetworkInsightsAccessScopes": { - "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeList", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeSet", - "smithy.api#documentation": "

The Network Access Scopes.

", - "smithy.api#xmlName": "networkInsightsAccessScopeSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeNetworkInsightsAnalyses": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeNetworkInsightsAnalysesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeNetworkInsightsAnalysesResult" - }, - "traits": { - "smithy.api#documentation": "

Describes one or more of your network insights analyses.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "NetworkInsightsAnalyses", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeNetworkInsightsAnalysesRequest": { - "type": "structure", - "members": { - "NetworkInsightsAnalysisIds": { - "target": "com.amazonaws.ec2#NetworkInsightsAnalysisIdList", - "traits": { - "smithy.api#documentation": "

The ID of the network insights analyses. You must specify either analysis IDs or a path ID.

", - "smithy.api#xmlName": "NetworkInsightsAnalysisId" - } - }, - "NetworkInsightsPathId": { - "target": "com.amazonaws.ec2#NetworkInsightsPathId", - "traits": { - "smithy.api#documentation": "

The ID of the path. You must specify either a path ID or analysis IDs.

" - } - }, - "AnalysisStartTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "smithy.api#documentation": "

The time when the network insights analyses started.

" - } - }, - "AnalysisEndTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "smithy.api#documentation": "

The time when the network insights analyses ended.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters. The following are the possible values:

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#NetworkInsightsMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeNetworkInsightsAnalysesResult": { - "type": "structure", - "members": { - "NetworkInsightsAnalyses": { - "target": "com.amazonaws.ec2#NetworkInsightsAnalysisList", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInsightsAnalysisSet", - "smithy.api#documentation": "

Information about the network insights analyses.

", - "smithy.api#xmlName": "networkInsightsAnalysisSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeNetworkInsightsPaths": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeNetworkInsightsPathsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeNetworkInsightsPathsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes one or more of your paths.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "NetworkInsightsPaths", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeNetworkInsightsPathsRequest": { - "type": "structure", - "members": { - "NetworkInsightsPathIds": { - "target": "com.amazonaws.ec2#NetworkInsightsPathIdList", - "traits": { - "smithy.api#documentation": "

The IDs of the paths.

", - "smithy.api#xmlName": "NetworkInsightsPathId" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters. The following are the possible values:

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#NetworkInsightsMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeNetworkInsightsPathsResult": { - "type": "structure", - "members": { - "NetworkInsightsPaths": { - "target": "com.amazonaws.ec2#NetworkInsightsPathList", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInsightsPathSet", - "smithy.api#documentation": "

Information about the paths.

", - "smithy.api#xmlName": "networkInsightsPathSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeNetworkInterfaceAttribute": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeNetworkInterfaceAttributeRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeNetworkInterfaceAttributeResult" - }, - "traits": { - "smithy.api#documentation": "

Describes a network interface attribute. You can specify only one attribute at a time.

" - } - }, - "com.amazonaws.ec2#DescribeNetworkInterfaceAttributeRequest": { - "type": "structure", - "members": { - "Attribute": { - "target": "com.amazonaws.ec2#NetworkInterfaceAttribute", - "traits": { - "aws.protocols#ec2QueryName": "Attribute", - "smithy.api#documentation": "

The attribute of the network interface. This parameter is required.

", - "smithy.api#xmlName": "attribute" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#NetworkInterfaceId", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the network interface.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "networkInterfaceId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for DescribeNetworkInterfaceAttribute.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeNetworkInterfaceAttributeResult": { - "type": "structure", - "members": { - "Attachment": { - "target": "com.amazonaws.ec2#NetworkInterfaceAttachment", - "traits": { - "aws.protocols#ec2QueryName": "Attachment", - "smithy.api#documentation": "

The attachment (if any) of the network interface.

", - "smithy.api#xmlName": "attachment" - } - }, - "Description": { - "target": "com.amazonaws.ec2#AttributeValue", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

The description of the network interface.

", - "smithy.api#xmlName": "description" - } - }, - "Groups": { - "target": "com.amazonaws.ec2#GroupIdentifierList", - "traits": { - "aws.protocols#ec2QueryName": "GroupSet", - "smithy.api#documentation": "

The security groups associated with the network interface.

", - "smithy.api#xmlName": "groupSet" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "

The ID of the network interface.

", - "smithy.api#xmlName": "networkInterfaceId" - } - }, - "SourceDestCheck": { - "target": "com.amazonaws.ec2#AttributeBooleanValue", - "traits": { - "aws.protocols#ec2QueryName": "SourceDestCheck", - "smithy.api#documentation": "

Indicates whether source/destination checking is enabled.

", - "smithy.api#xmlName": "sourceDestCheck" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of DescribeNetworkInterfaceAttribute.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeNetworkInterfacePermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeNetworkInterfacePermissionsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeNetworkInterfacePermissionsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the permissions for your network interfaces.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "NetworkInterfacePermissions", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeNetworkInterfacePermissionsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 255 - } - } - }, - "com.amazonaws.ec2#DescribeNetworkInterfacePermissionsRequest": { - "type": "structure", - "members": { - "NetworkInterfacePermissionIds": { - "target": "com.amazonaws.ec2#NetworkInterfacePermissionIdList", - "traits": { - "smithy.api#documentation": "

The network interface permission IDs.

", - "smithy.api#xmlName": "NetworkInterfacePermissionId" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request.\n\t\t Pagination continues from the end of the items returned by the previous request.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeNetworkInterfacePermissionsMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request. To get the next page of items,\n\t\t\tmake another request with the token returned in the output. If this parameter is not specified, \n\t\t\tup to 50 results are returned by default. For more information, see\n\t\t\tPagination.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for DescribeNetworkInterfacePermissions.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeNetworkInterfacePermissionsResult": { - "type": "structure", - "members": { - "NetworkInterfacePermissions": { - "target": "com.amazonaws.ec2#NetworkInterfacePermissionList", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfacePermissions", - "smithy.api#documentation": "

The network interface permissions.

", - "smithy.api#xmlName": "networkInterfacePermissions" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items.\n\t\t This value is null when there are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output for DescribeNetworkInterfacePermissions.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeNetworkInterfaces": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeNetworkInterfacesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeNetworkInterfacesResult" - }, - "traits": { - "smithy.api#documentation": "

Describes one or more of your network interfaces.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "NetworkInterfaces", - "pageSize": "MaxResults" - }, - "smithy.api#suppress": ["WaitableTraitInvalidErrorType"], - "smithy.waiters#waitable": { - "NetworkInterfaceAvailable": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "NetworkInterfaces[].Status", - "expected": "available", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "errorType": "InvalidNetworkInterfaceID.NotFound" - } - } - ], - "minDelay": 20 - } - } - } - }, - "com.amazonaws.ec2#DescribeNetworkInterfacesMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#DescribeNetworkInterfacesRequest": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "aws.protocols#ec2QueryName": "Filter", - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "filter" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "NetworkInterfaceIds": { - "target": "com.amazonaws.ec2#NetworkInterfaceIdList", - "traits": { - "smithy.api#documentation": "

The network interface IDs.

\n

Default: Describes all your network interfaces.

", - "smithy.api#xmlName": "NetworkInterfaceId" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request.\n\t\t Pagination continues from the end of the items returned by the previous request.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeNetworkInterfacesMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request. To get the next page of items,\n\t\t make another request with the token returned in the output. You cannot specify this\n\t\t parameter and the network interface IDs parameter in the same request. For more information, \n\t\t see Pagination.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for DescribeNetworkInterfaces.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeNetworkInterfacesResult": { - "type": "structure", - "members": { - "NetworkInterfaces": { - "target": "com.amazonaws.ec2#NetworkInterfaceList", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceSet", - "smithy.api#documentation": "

Information about one or more network interfaces.

", - "smithy.api#xmlName": "networkInterfaceSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n\t\t This value is null when there are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribePlacementGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribePlacementGroupsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribePlacementGroupsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the specified placement groups or all of your placement groups. For more\n information, see Placement groups in the\n Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#DescribePlacementGroupsRequest": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "GroupNames": { - "target": "com.amazonaws.ec2#PlacementGroupStringList", - "traits": { - "aws.protocols#ec2QueryName": "GroupName", - "smithy.api#documentation": "

The names of the placement groups.

\n

Default: Describes all your placement groups, or only those otherwise\n specified.

", - "smithy.api#xmlName": "groupName" - } - }, - "GroupIds": { - "target": "com.amazonaws.ec2#PlacementGroupIdStringList", - "traits": { - "smithy.api#documentation": "

The IDs of the placement groups.

", - "smithy.api#xmlName": "GroupId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribePlacementGroupsResult": { - "type": "structure", - "members": { - "PlacementGroups": { - "target": "com.amazonaws.ec2#PlacementGroupList", - "traits": { - "aws.protocols#ec2QueryName": "PlacementGroupSet", - "smithy.api#documentation": "

Information about the placement groups.

", - "smithy.api#xmlName": "placementGroupSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribePrefixLists": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribePrefixListsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribePrefixListsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes available Amazon Web Services services in a prefix list format, which includes the prefix list\n name and prefix list ID of the service and the IP address range for the service.

\n

We recommend that you use DescribeManagedPrefixLists instead.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "PrefixLists", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribePrefixListsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "PrefixListIds": { - "target": "com.amazonaws.ec2#PrefixListResourceIdStringList", - "traits": { - "smithy.api#documentation": "

One or more prefix list IDs.

", - "smithy.api#xmlName": "PrefixListId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribePrefixListsResult": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - }, - "PrefixLists": { - "target": "com.amazonaws.ec2#PrefixListSet", - "traits": { - "aws.protocols#ec2QueryName": "PrefixListSet", - "smithy.api#documentation": "

All available prefix lists.

", - "smithy.api#xmlName": "prefixListSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribePrincipalIdFormat": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribePrincipalIdFormatRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribePrincipalIdFormatResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the ID format settings for the root user and all IAM roles and IAM users\n that have explicitly specified a longer ID (17-character ID) preference.

\n

By default, all IAM roles and IAM users default to the same ID settings as the root user, unless they\n explicitly override the settings. This request is useful for identifying those IAM users and IAM roles\n that have overridden the default ID settings.

\n

The following resource types support longer IDs: bundle |\n conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | instance | internet-gateway |\n network-acl | network-acl-association |\n network-interface | network-interface-attachment |\n prefix-list | reservation | route-table |\n route-table-association | security-group |\n snapshot | subnet |\n subnet-cidr-block-association | volume | vpc\n | vpc-cidr-block-association | vpc-endpoint |\n vpc-peering-connection | vpn-connection | vpn-gateway.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Principals", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribePrincipalIdFormatMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#DescribePrincipalIdFormatRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "Resources": { - "target": "com.amazonaws.ec2#ResourceList", - "traits": { - "smithy.api#documentation": "

The type of resource: bundle |\n conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | instance | internet-gateway |\n network-acl | network-acl-association |\n network-interface | network-interface-attachment |\n prefix-list | reservation | route-table |\n route-table-association | security-group |\n snapshot | subnet |\n subnet-cidr-block-association | volume | vpc\n | vpc-cidr-block-association | vpc-endpoint |\n vpc-peering-connection | vpn-connection | vpn-gateway\n

", - "smithy.api#xmlName": "Resource" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribePrincipalIdFormatMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned NextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token to request the next page of results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribePrincipalIdFormatResult": { - "type": "structure", - "members": { - "Principals": { - "target": "com.amazonaws.ec2#PrincipalIdFormatList", - "traits": { - "aws.protocols#ec2QueryName": "PrincipalSet", - "smithy.api#documentation": "

Information about the ID format settings for the ARN.

", - "smithy.api#xmlName": "principalSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribePublicIpv4Pools": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribePublicIpv4PoolsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribePublicIpv4PoolsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the specified IPv4 address pools.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "PublicIpv4Pools", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribePublicIpv4PoolsRequest": { - "type": "structure", - "members": { - "PoolIds": { - "target": "com.amazonaws.ec2#PublicIpv4PoolIdStringList", - "traits": { - "smithy.api#documentation": "

The IDs of the address pools.

", - "smithy.api#xmlName": "PoolId" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#PoolMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribePublicIpv4PoolsResult": { - "type": "structure", - "members": { - "PublicIpv4Pools": { - "target": "com.amazonaws.ec2#PublicIpv4PoolSet", - "traits": { - "aws.protocols#ec2QueryName": "PublicIpv4PoolSet", - "smithy.api#documentation": "

Information about the address pools.

", - "smithy.api#xmlName": "publicIpv4PoolSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeRegions": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeRegionsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeRegionsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the Regions that are enabled for your account, or all Regions.

\n

For a list of the Regions supported by Amazon EC2, see \n Amazon Elastic Compute Cloud endpoints and quotas.

\n

For information about enabling and disabling Regions for your account, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference.

" - } - }, - "com.amazonaws.ec2#DescribeRegionsRequest": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "RegionNames": { - "target": "com.amazonaws.ec2#RegionNameStringList", - "traits": { - "smithy.api#documentation": "

The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.

", - "smithy.api#xmlName": "RegionName" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "AllRegions": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to display all Regions, including Regions that are disabled for your account.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeRegionsResult": { - "type": "structure", - "members": { - "Regions": { - "target": "com.amazonaws.ec2#RegionList", - "traits": { - "aws.protocols#ec2QueryName": "RegionInfo", - "smithy.api#documentation": "

Information about the Regions.

", - "smithy.api#xmlName": "regionInfo" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeReplaceRootVolumeTasks": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeReplaceRootVolumeTasksRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeReplaceRootVolumeTasksResult" - }, - "traits": { - "smithy.api#documentation": "

Describes a root volume replacement task. For more information, see \n Replace a root volume in the Amazon Elastic Compute Cloud User Guide.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ReplaceRootVolumeTasks", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeReplaceRootVolumeTasksMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.ec2#DescribeReplaceRootVolumeTasksRequest": { - "type": "structure", - "members": { - "ReplaceRootVolumeTaskIds": { - "target": "com.amazonaws.ec2#ReplaceRootVolumeTaskIds", - "traits": { - "smithy.api#documentation": "

The ID of the root volume replacement task to view.

", - "smithy.api#xmlName": "ReplaceRootVolumeTaskId" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

Filter to use:

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeReplaceRootVolumeTasksMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output. \n\tFor more information, see Pagination.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeReplaceRootVolumeTasksResult": { - "type": "structure", - "members": { - "ReplaceRootVolumeTasks": { - "target": "com.amazonaws.ec2#ReplaceRootVolumeTasks", - "traits": { - "aws.protocols#ec2QueryName": "ReplaceRootVolumeTaskSet", - "smithy.api#documentation": "

Information about the root volume replacement task.

", - "smithy.api#xmlName": "replaceRootVolumeTaskSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n This value is null when there are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeReservedInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeReservedInstancesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeReservedInstancesResult" - }, - "traits": { - "smithy.api#documentation": "

Describes one or more of the Reserved Instances that you purchased.

\n

For more information about Reserved Instances, see Reserved\n\t\t\t\tInstances in the Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#DescribeReservedInstancesListings": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeReservedInstancesListingsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeReservedInstancesListingsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.

\n

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.

\n

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.

\n

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.

\n

For more information, see Reserved Instance Marketplace \n in the Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#DescribeReservedInstancesListingsRequest": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "ReservedInstancesId": { - "target": "com.amazonaws.ec2#ReservationId", - "traits": { - "aws.protocols#ec2QueryName": "ReservedInstancesId", - "smithy.api#documentation": "

One or more Reserved Instance IDs.

", - "smithy.api#xmlName": "reservedInstancesId" - } - }, - "ReservedInstancesListingId": { - "target": "com.amazonaws.ec2#ReservedInstancesListingId", - "traits": { - "aws.protocols#ec2QueryName": "ReservedInstancesListingId", - "smithy.api#documentation": "

One or more Reserved Instance listing IDs.

", - "smithy.api#xmlName": "reservedInstancesListingId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for DescribeReservedInstancesListings.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeReservedInstancesListingsResult": { - "type": "structure", - "members": { - "ReservedInstancesListings": { - "target": "com.amazonaws.ec2#ReservedInstancesListingList", - "traits": { - "aws.protocols#ec2QueryName": "ReservedInstancesListingsSet", - "smithy.api#documentation": "

Information about the Reserved Instance listing.

", - "smithy.api#xmlName": "reservedInstancesListingsSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of DescribeReservedInstancesListings.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeReservedInstancesModifications": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeReservedInstancesModificationsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeReservedInstancesModificationsResult" - }, - "traits": { - "smithy.api#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.

\n

For more information, see Modifying Reserved Instances in the Amazon EC2 User Guide.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ReservedInstancesModifications" - } - } - }, - "com.amazonaws.ec2#DescribeReservedInstancesModificationsRequest": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "ReservedInstancesModificationIds": { - "target": "com.amazonaws.ec2#ReservedInstancesModificationIdStringList", - "traits": { - "smithy.api#documentation": "

IDs for the submitted modification request.

", - "smithy.api#xmlName": "ReservedInstancesModificationId" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to retrieve the next page of results.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for DescribeReservedInstancesModifications.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeReservedInstancesModificationsResult": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when\n\t\t\tthere are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - }, - "ReservedInstancesModifications": { - "target": "com.amazonaws.ec2#ReservedInstancesModificationList", - "traits": { - "aws.protocols#ec2QueryName": "ReservedInstancesModificationsSet", - "smithy.api#documentation": "

The Reserved Instance modification information.

", - "smithy.api#xmlName": "reservedInstancesModificationsSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of DescribeReservedInstancesModifications.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeReservedInstancesOfferings": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeReservedInstancesOfferingsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeReservedInstancesOfferingsResult" - }, - "traits": { - "smithy.api#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.

\n

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.

\n

For more information, see Reserved Instance Marketplace\n\t\t\t\tin the Amazon EC2 User Guide.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ReservedInstancesOfferings", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeReservedInstancesOfferingsRequest": { - "type": "structure", - "members": { - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The Availability Zone in which the Reserved Instance can be used.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "IncludeMarketplace": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Include Reserved Instance Marketplace offerings in the response.

" - } - }, - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", - "traits": { - "smithy.api#documentation": "

The instance type that the reservation will cover (for example, m1.small). For more information, see \n Instance types in the\n Amazon EC2 User Guide.

" - } - }, - "MaxDuration": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum duration (in seconds) to filter when searching for offerings.

\n

Default: 94608000 (3 years)

" - } - }, - "MaxInstanceCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of instances to filter when searching for offerings.

\n

Default: 20

" - } - }, - "MinDuration": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum duration (in seconds) to filter when searching for offerings.

\n

Default: 2592000 (1 month)

" - } - }, - "OfferingClass": { - "target": "com.amazonaws.ec2#OfferingClassType", - "traits": { - "smithy.api#documentation": "

The offering class of the Reserved Instance. Can be standard or convertible.

" - } - }, - "ProductDescription": { - "target": "com.amazonaws.ec2#RIProductDescription", - "traits": { - "smithy.api#documentation": "

The Reserved Instance product platform description. Instances that include (Amazon\n VPC) in the description are for use with Amazon VPC.

" - } - }, - "ReservedInstancesOfferingIds": { - "target": "com.amazonaws.ec2#ReservedInstancesOfferingIdStringList", - "traits": { - "smithy.api#documentation": "

One or more Reserved Instances offering IDs.

", - "smithy.api#xmlName": "ReservedInstancesOfferingId" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "InstanceTenancy": { - "target": "com.amazonaws.ec2#Tenancy", - "traits": { - "aws.protocols#ec2QueryName": "InstanceTenancy", - "smithy.api#documentation": "

The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy\n of dedicated is applied to instances that run in a VPC on single-tenant hardware\n (i.e., Dedicated Instances).

\n

\n Important: The host value cannot be used with this parameter. Use the default or dedicated values only.

\n

Default: default\n

", - "smithy.api#xmlName": "instanceTenancy" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "MaxResults", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining\n\t\t\tresults of the initial request can be seen by sending another request with the returned\n\t\t\t\tNextToken value. The maximum is 100.

\n

Default: 100

", - "smithy.api#xmlName": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to retrieve the next page of results.

", - "smithy.api#xmlName": "nextToken" - } - }, - "OfferingType": { - "target": "com.amazonaws.ec2#OfferingTypeValues", - "traits": { - "aws.protocols#ec2QueryName": "OfferingType", - "smithy.api#documentation": "

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API\n\t\t\tversion, you only have access to the Medium Utilization Reserved Instance\n\t\t\toffering type.

", - "smithy.api#xmlName": "offeringType" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for DescribeReservedInstancesOfferings.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeReservedInstancesOfferingsResult": { - "type": "structure", - "members": { - "ReservedInstancesOfferings": { - "target": "com.amazonaws.ec2#ReservedInstancesOfferingList", - "traits": { - "aws.protocols#ec2QueryName": "ReservedInstancesOfferingsSet", - "smithy.api#documentation": "

A list of Reserved Instances offerings.

", - "smithy.api#xmlName": "reservedInstancesOfferingsSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when\n\t\t\tthere are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of DescribeReservedInstancesOfferings.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeReservedInstancesRequest": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "OfferingClass": { - "target": "com.amazonaws.ec2#OfferingClassType", - "traits": { - "smithy.api#documentation": "

Describes whether the Reserved Instance is Standard or Convertible.

" - } - }, - "ReservedInstancesIds": { - "target": "com.amazonaws.ec2#ReservedInstancesIdStringList", - "traits": { - "smithy.api#documentation": "

One or more Reserved Instance IDs.

\n

Default: Describes all your Reserved Instances, or only those otherwise specified.

", - "smithy.api#xmlName": "ReservedInstancesId" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "OfferingType": { - "target": "com.amazonaws.ec2#OfferingTypeValues", - "traits": { - "aws.protocols#ec2QueryName": "OfferingType", - "smithy.api#documentation": "

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API\n\t\t\tversion, you only have access to the Medium Utilization Reserved Instance\n\t\t\toffering type.

", - "smithy.api#xmlName": "offeringType" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for DescribeReservedInstances.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeReservedInstancesResult": { - "type": "structure", - "members": { - "ReservedInstances": { - "target": "com.amazonaws.ec2#ReservedInstancesList", - "traits": { - "aws.protocols#ec2QueryName": "ReservedInstancesSet", - "smithy.api#documentation": "

A list of Reserved Instances.

", - "smithy.api#xmlName": "reservedInstancesSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output for DescribeReservedInstances.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeRouteTables": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeRouteTablesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeRouteTablesResult" - }, - "traits": { - "smithy.api#documentation": "

Describes one or more of your route tables.

\n

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.

\n

For more information, see Route tables in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "RouteTables", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeRouteTablesMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 100 - } - } - }, - "com.amazonaws.ec2#DescribeRouteTablesRequest": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "RouteTableIds": { - "target": "com.amazonaws.ec2#RouteTableIdStringList", - "traits": { - "smithy.api#documentation": "

One or more route table IDs.

\n

Default: Describes all your route tables.

", - "smithy.api#xmlName": "RouteTableId" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeRouteTablesMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeRouteTablesResult": { - "type": "structure", - "members": { - "RouteTables": { - "target": "com.amazonaws.ec2#RouteTableList", - "traits": { - "aws.protocols#ec2QueryName": "RouteTableSet", - "smithy.api#documentation": "

Information about one or more route tables.

", - "smithy.api#xmlName": "routeTableSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of DescribeRouteTables.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeScheduledInstanceAvailability": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeScheduledInstanceAvailabilityRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeScheduledInstanceAvailabilityResult" - }, - "traits": { - "smithy.api#documentation": "

Finds available schedules that meet the specified criteria.

\n

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.

\n

After you find a schedule that meets your needs, call PurchaseScheduledInstances\n to purchase Scheduled Instances with that schedule.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ScheduledInstanceAvailabilitySet", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeScheduledInstanceAvailabilityMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 300 - } - } - }, - "com.amazonaws.ec2#DescribeScheduledInstanceAvailabilityRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "FirstSlotStartTimeRange": { - "target": "com.amazonaws.ec2#SlotDateTimeRangeRequest", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The time period for the first schedule to start.

", - "smithy.api#required": {} - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeScheduledInstanceAvailabilityMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return in a single call. \n This value can be between 5 and 300. The default value is 300.\n To retrieve the remaining results, make another call with the returned\n NextToken value.

" - } - }, - "MaxSlotDurationInHours": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours\n and less than 1,720.

" - } - }, - "MinSlotDurationInHours": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#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": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results.

" - } - }, - "Recurrence": { - "target": "com.amazonaws.ec2#ScheduledInstanceRecurrenceRequest", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The schedule recurrence.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for DescribeScheduledInstanceAvailability.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeScheduledInstanceAvailabilityResult": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - }, - "ScheduledInstanceAvailabilitySet": { - "target": "com.amazonaws.ec2#ScheduledInstanceAvailabilitySet", - "traits": { - "aws.protocols#ec2QueryName": "ScheduledInstanceAvailabilitySet", - "smithy.api#documentation": "

Information about the available Scheduled Instances.

", - "smithy.api#xmlName": "scheduledInstanceAvailabilitySet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of DescribeScheduledInstanceAvailability.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeScheduledInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeScheduledInstancesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeScheduledInstancesResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the specified Scheduled Instances or all your Scheduled Instances.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ScheduledInstanceSet", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeScheduledInstancesRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return in a single call. \n This value can be between 5 and 300. The default value is 100.\n To retrieve the remaining results, make another call with the returned\n NextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results.

" - } - }, - "ScheduledInstanceIds": { - "target": "com.amazonaws.ec2#ScheduledInstanceIdRequestSet", - "traits": { - "smithy.api#documentation": "

The Scheduled Instance IDs.

", - "smithy.api#xmlName": "ScheduledInstanceId" - } - }, - "SlotStartTimeRange": { - "target": "com.amazonaws.ec2#SlotStartTimeRangeRequest", - "traits": { - "smithy.api#documentation": "

The time period for the first schedule to start.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for DescribeScheduledInstances.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeScheduledInstancesResult": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - }, - "ScheduledInstanceSet": { - "target": "com.amazonaws.ec2#ScheduledInstanceSet", - "traits": { - "aws.protocols#ec2QueryName": "ScheduledInstanceSet", - "smithy.api#documentation": "

Information about the Scheduled Instances.

", - "smithy.api#xmlName": "scheduledInstanceSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of DescribeScheduledInstances.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeSecurityGroupReferences": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeSecurityGroupReferencesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeSecurityGroupReferencesResult" - }, - "traits": { - "smithy.api#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.

" - } - }, - "com.amazonaws.ec2#DescribeSecurityGroupReferencesRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "GroupId": { - "target": "com.amazonaws.ec2#GroupIds", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IDs of the security groups in your account.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeSecurityGroupReferencesResult": { - "type": "structure", - "members": { - "SecurityGroupReferenceSet": { - "target": "com.amazonaws.ec2#SecurityGroupReferences", - "traits": { - "aws.protocols#ec2QueryName": "SecurityGroupReferenceSet", - "smithy.api#documentation": "

Information about the VPCs with the referencing security groups.

", - "smithy.api#xmlName": "securityGroupReferenceSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeSecurityGroupRules": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeSecurityGroupRulesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeSecurityGroupRulesResult" - }, - "traits": { - "smithy.api#documentation": "

Describes one or more of your security group rules.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "SecurityGroupRules", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeSecurityGroupRulesMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#DescribeSecurityGroupRulesRequest": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "SecurityGroupRuleIds": { - "target": "com.amazonaws.ec2#SecurityGroupRuleIdList", - "traits": { - "smithy.api#documentation": "

The IDs of the security group rules.

", - "smithy.api#xmlName": "SecurityGroupRuleId" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeSecurityGroupRulesMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request. To get the next page of \n items, make another request with the token returned in the output. This value\n can be between 5 and 1000. If this parameter is not specified, then all items are\n returned. For more information, see Pagination.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeSecurityGroupRulesResult": { - "type": "structure", - "members": { - "SecurityGroupRules": { - "target": "com.amazonaws.ec2#SecurityGroupRuleList", - "traits": { - "aws.protocols#ec2QueryName": "SecurityGroupRuleSet", - "smithy.api#documentation": "

Information about security group rules.

", - "smithy.api#xmlName": "securityGroupRuleSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n This value is null when there are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeSecurityGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeSecurityGroupsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeSecurityGroupsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the specified security groups or all of your security groups.

\n

A security group is for use with instances either in the EC2-Classic platform \n\t\t\t\tor in a specific VPC. For more information, see\n\t\t\t\tAmazon EC2 security groups in \n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide and \n\t\t\t\tSecurity groups for your VPC in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n ", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "SecurityGroups", - "pageSize": "MaxResults" - }, - "smithy.api#suppress": ["WaitableTraitInvalidErrorType"], - "smithy.waiters#waitable": { - "SecurityGroupExists": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "length(SecurityGroups[].GroupId) > `0`", - "expected": "true", - "comparator": "booleanEquals" - } - } - }, - { - "state": "retry", - "matcher": { - "errorType": "InvalidGroup.NotFound" - } - } - ], - "minDelay": 5 - } - } - } - }, - "com.amazonaws.ec2#DescribeSecurityGroupsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#DescribeSecurityGroupsRequest": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#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.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "GroupIds": { - "target": "com.amazonaws.ec2#GroupIdStringList", - "traits": { - "smithy.api#documentation": "

The IDs of the security groups. Required for security groups in a nondefault VPC.

\n

Default: Describes all of your security groups.

", - "smithy.api#xmlName": "GroupId" - } - }, - "GroupNames": { - "target": "com.amazonaws.ec2#GroupNameStringList", - "traits": { - "smithy.api#documentation": "

[EC2-Classic and default VPC only] The names of the security groups. You can specify either\n\t\t\tthe security group name or the security group ID. For security groups in a nondefault VPC, use\n\t\t\tthe group-name filter to describe security groups by name.

\n

Default: Describes all of your security groups.

", - "smithy.api#xmlName": "GroupName" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeSecurityGroupsMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request. To get the next page of items,\n make another request with the token returned in the output. This value can be between 5 and 1000. \n If this parameter is not specified, then all items are returned. For more information, see \n Pagination.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeSecurityGroupsResult": { - "type": "structure", - "members": { - "SecurityGroups": { - "target": "com.amazonaws.ec2#SecurityGroupList", - "traits": { - "aws.protocols#ec2QueryName": "SecurityGroupInfo", - "smithy.api#documentation": "

Information about the security groups.

", - "smithy.api#xmlName": "securityGroupInfo" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n This value is null when there are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeSnapshotAttribute": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeSnapshotAttributeRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeSnapshotAttributeResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the specified attribute of the specified snapshot. You can specify only one\n attribute at a time.

\n

For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#DescribeSnapshotAttributeRequest": { - "type": "structure", - "members": { - "Attribute": { - "target": "com.amazonaws.ec2#SnapshotAttributeName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The snapshot attribute you would like to view.

", - "smithy.api#required": {} - } - }, - "SnapshotId": { - "target": "com.amazonaws.ec2#SnapshotId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the EBS snapshot.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeSnapshotAttributeResult": { - "type": "structure", - "members": { - "CreateVolumePermissions": { - "target": "com.amazonaws.ec2#CreateVolumePermissionList", - "traits": { - "aws.protocols#ec2QueryName": "CreateVolumePermission", - "smithy.api#documentation": "

The users and groups that have the permissions for creating volumes from the\n snapshot.

", - "smithy.api#xmlName": "createVolumePermission" - } - }, - "ProductCodes": { - "target": "com.amazonaws.ec2#ProductCodeList", - "traits": { - "aws.protocols#ec2QueryName": "ProductCodes", - "smithy.api#documentation": "

The product codes.

", - "smithy.api#xmlName": "productCodes" - } - }, - "SnapshotId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SnapshotId", - "smithy.api#documentation": "

The ID of the EBS snapshot.

", - "smithy.api#xmlName": "snapshotId" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeSnapshotTierStatus": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeSnapshotTierStatusRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeSnapshotTierStatusResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the storage tier status of one or more Amazon EBS snapshots.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "SnapshotTierStatuses", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeSnapshotTierStatusMaxResults": { - "type": "integer" - }, - "com.amazonaws.ec2#DescribeSnapshotTierStatusRequest": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeSnapshotTierStatusMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output. \n\tFor more information, see Pagination.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeSnapshotTierStatusResult": { - "type": "structure", - "members": { - "SnapshotTierStatuses": { - "target": "com.amazonaws.ec2#snapshotTierStatusSet", - "traits": { - "aws.protocols#ec2QueryName": "SnapshotTierStatusSet", - "smithy.api#documentation": "

Information about the snapshot's storage tier.

", - "smithy.api#xmlName": "snapshotTierStatusSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n This value is null when there are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeSnapshots": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeSnapshotsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeSnapshotsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the specified EBS snapshots available to you or all of the EBS snapshots\n available to you.

\n

The snapshots available to you include public snapshots, private snapshots that you own,\n and private snapshots owned by other Amazon Web Services accounts for which you have explicit create volume\n permissions.

\n

The create volume permissions fall into the following categories:

\n \n

The list of snapshots returned can be filtered by specifying snapshot IDs, snapshot\n owners, or Amazon Web Services accounts with create volume permissions. If no options are specified, \n Amazon EC2 returns all snapshots for which you have create volume permissions.

\n

If you specify one or more snapshot IDs, only snapshots that have the specified IDs are\n returned. If you specify an invalid snapshot ID, an error is returned. If you specify a\n snapshot ID for which you do not have access, it is not included in the returned\n results.

\n

If you specify one or more snapshot owners using the OwnerIds option, only\n snapshots from the specified owners and for which you have access are returned. The results\n can include the Amazon Web Services account IDs of the specified owners, amazon for snapshots\n owned by Amazon, or self for snapshots that you own.

\n

If you specify a list of restorable users, only snapshots with create snapshot permissions\n for those users are returned. You can specify Amazon Web Services account IDs (if you own the snapshots),\n self for snapshots for which you own or have explicit permissions, or\n all for public snapshots.

\n

If you are describing a long list of snapshots, we recommend that you paginate the output to make the\n list more manageable. For more information, see Pagination.

\n

To get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores.

\n

For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Snapshots", - "pageSize": "MaxResults" - }, - "smithy.waiters#waitable": { - "SnapshotCompleted": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "Snapshots[].State", - "expected": "completed", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Snapshots[].State", - "expected": "error", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 15 - } - } - } - }, - "com.amazonaws.ec2#DescribeSnapshotsRequest": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of snapshots to return for this request.\n This value can be between 5 and 1,000; if this value is larger than 1,000, only 1,000 results are returned. \n If this parameter is not used, then the request returns all snapshots. \n You cannot specify this parameter and the snapshot IDs parameter in the same request. For more information, \n see Pagination.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.

" - } - }, - "OwnerIds": { - "target": "com.amazonaws.ec2#OwnerStringList", - "traits": { - "smithy.api#documentation": "

Scopes the results to snapshots with the specified owners. You can specify a combination of\n Amazon Web Services account IDs, self, and amazon.

", - "smithy.api#xmlName": "Owner" - } - }, - "RestorableByUserIds": { - "target": "com.amazonaws.ec2#RestorableByStringList", - "traits": { - "smithy.api#documentation": "

The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.

", - "smithy.api#xmlName": "RestorableBy" - } - }, - "SnapshotIds": { - "target": "com.amazonaws.ec2#SnapshotIdStringList", - "traits": { - "smithy.api#documentation": "

The snapshot IDs.

\n

Default: Describes the snapshots for which you have create volume permissions.

", - "smithy.api#xmlName": "SnapshotId" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeSnapshotsResult": { - "type": "structure", - "members": { - "Snapshots": { - "target": "com.amazonaws.ec2#SnapshotList", - "traits": { - "aws.protocols#ec2QueryName": "SnapshotSet", - "smithy.api#documentation": "

Information about the snapshots.

", - "smithy.api#xmlName": "snapshotSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to return the next page of snapshots. \n This value is null when there are no more snapshots to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeSpotDatafeedSubscription": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeSpotDatafeedSubscriptionRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeSpotDatafeedSubscriptionResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the data feed for Spot Instances. For more information, see Spot\n Instance data feed in the Amazon EC2 User Guide for Linux Instances.

" - } - }, - "com.amazonaws.ec2#DescribeSpotDatafeedSubscriptionRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for DescribeSpotDatafeedSubscription.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeSpotDatafeedSubscriptionResult": { - "type": "structure", - "members": { - "SpotDatafeedSubscription": { - "target": "com.amazonaws.ec2#SpotDatafeedSubscription", - "traits": { - "aws.protocols#ec2QueryName": "SpotDatafeedSubscription", - "smithy.api#documentation": "

The Spot Instance data feed subscription.

", - "smithy.api#xmlName": "spotDatafeedSubscription" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of DescribeSpotDatafeedSubscription.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeSpotFleetInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeSpotFleetInstancesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeSpotFleetInstancesResponse" - }, - "traits": { - "smithy.api#documentation": "

Describes the running instances for the specified Spot Fleet.

" - } - }, - "com.amazonaws.ec2#DescribeSpotFleetInstancesMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#DescribeSpotFleetInstancesRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeSpotFleetInstancesMaxResults", - "traits": { - "aws.protocols#ec2QueryName": "MaxResults", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

", - "smithy.api#xmlName": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - }, - "SpotFleetRequestId": { - "target": "com.amazonaws.ec2#SpotFleetRequestId", - "traits": { - "aws.protocols#ec2QueryName": "SpotFleetRequestId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Spot Fleet request.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "spotFleetRequestId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for DescribeSpotFleetInstances.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeSpotFleetInstancesResponse": { - "type": "structure", - "members": { - "ActiveInstances": { - "target": "com.amazonaws.ec2#ActiveInstanceSet", - "traits": { - "aws.protocols#ec2QueryName": "ActiveInstanceSet", - "smithy.api#documentation": "

The running instances. This list is refreshed periodically and might be out of\n date.

", - "smithy.api#xmlName": "activeInstanceSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - }, - "SpotFleetRequestId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SpotFleetRequestId", - "smithy.api#documentation": "

The ID of the Spot Fleet request.

", - "smithy.api#xmlName": "spotFleetRequestId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of DescribeSpotFleetInstances.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeSpotFleetRequestHistory": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeSpotFleetRequestHistoryRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeSpotFleetRequestHistoryResponse" - }, - "traits": { - "smithy.api#documentation": "

Describes the events for the specified Spot Fleet request during the specified\n time.

\n

Spot Fleet events are delayed by up to 30 seconds before they can be described. This\n ensures that you can query by the last evaluated time and not miss a recorded event.\n Spot Fleet events are available for 48 hours.

\n

For more information, see Monitor fleet events using Amazon\n EventBridge in the Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#DescribeSpotFleetRequestHistoryMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#DescribeSpotFleetRequestHistoryRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "EventType": { - "target": "com.amazonaws.ec2#EventType", - "traits": { - "aws.protocols#ec2QueryName": "EventType", - "smithy.api#documentation": "

The type of events to describe. By default, all events are described.

", - "smithy.api#xmlName": "eventType" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeSpotFleetRequestHistoryMaxResults", - "traits": { - "aws.protocols#ec2QueryName": "MaxResults", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

", - "smithy.api#xmlName": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - }, - "SpotFleetRequestId": { - "target": "com.amazonaws.ec2#SpotFleetRequestId", - "traits": { - "aws.protocols#ec2QueryName": "SpotFleetRequestId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Spot Fleet request.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "spotFleetRequestId" - } - }, - "StartTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "StartTime", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The starting date and time for the events, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", - "smithy.api#required": {}, - "smithy.api#xmlName": "startTime" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for DescribeSpotFleetRequestHistory.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeSpotFleetRequestHistoryResponse": { - "type": "structure", - "members": { - "HistoryRecords": { - "target": "com.amazonaws.ec2#HistoryRecords", - "traits": { - "aws.protocols#ec2QueryName": "HistoryRecordSet", - "smithy.api#documentation": "

Information about the events in the history of the Spot Fleet request.

", - "smithy.api#xmlName": "historyRecordSet" - } - }, - "LastEvaluatedTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "LastEvaluatedTime", - "smithy.api#documentation": "

The last date and time for the events, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).\n All records up to this time were retrieved.

\n

If nextToken indicates that there are more items, this value is not\n present.

", - "smithy.api#xmlName": "lastEvaluatedTime" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - }, - "SpotFleetRequestId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SpotFleetRequestId", - "smithy.api#documentation": "

The ID of the Spot Fleet request.

", - "smithy.api#xmlName": "spotFleetRequestId" - } - }, - "StartTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "StartTime", - "smithy.api#documentation": "

The starting date and time for the events, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", - "smithy.api#xmlName": "startTime" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of DescribeSpotFleetRequestHistory.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeSpotFleetRequests": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeSpotFleetRequestsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeSpotFleetRequestsResponse" - }, - "traits": { - "smithy.api#documentation": "

Describes your Spot Fleet requests.

\n

Spot Fleet requests are deleted 48 hours after they are canceled and their instances\n are terminated.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "SpotFleetRequestConfigs", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeSpotFleetRequestsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "MaxResults", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

", - "smithy.api#xmlName": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - }, - "SpotFleetRequestIds": { - "target": "com.amazonaws.ec2#SpotFleetRequestIdList", - "traits": { - "aws.protocols#ec2QueryName": "SpotFleetRequestId", - "smithy.api#documentation": "

The IDs of the Spot Fleet requests.

", - "smithy.api#xmlName": "spotFleetRequestId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for DescribeSpotFleetRequests.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeSpotFleetRequestsResponse": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - }, - "SpotFleetRequestConfigs": { - "target": "com.amazonaws.ec2#SpotFleetRequestConfigSet", - "traits": { - "aws.protocols#ec2QueryName": "SpotFleetRequestConfigSet", - "smithy.api#documentation": "

Information about the configuration of your Spot Fleet.

", - "smithy.api#xmlName": "spotFleetRequestConfigSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of DescribeSpotFleetRequests.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeSpotInstanceRequests": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeSpotInstanceRequestsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeSpotInstanceRequestsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the specified Spot Instance requests.

\n

You can use DescribeSpotInstanceRequests to find a running Spot Instance by\n examining the response. If the status of the Spot Instance is fulfilled, the\n instance ID appears in the response and contains the identifier of the instance.\n Alternatively, you can use DescribeInstances\n with a filter to look for instances where the instance lifecycle is\n spot.

\n

We recommend that you set MaxResults to a value between 5 and 1000 to\n limit the number of items returned. This paginates the output, which makes the list\n more manageable and returns the items faster. If the list of items exceeds your\n MaxResults value, then that number of items is returned along with a\n NextToken value that can be passed to a subsequent\n DescribeSpotInstanceRequests request to retrieve the remaining\n items.

\n

Spot Instance requests are deleted four hours after they are canceled and their instances are\n terminated.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "SpotInstanceRequests", - "pageSize": "MaxResults" - }, - "smithy.api#suppress": ["WaitableTraitInvalidErrorType"], - "smithy.waiters#waitable": { - "SpotInstanceRequestFulfilled": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "SpotInstanceRequests[].Status.Code", - "expected": "fulfilled", - "comparator": "allStringEquals" - } - } - }, - { - "state": "success", - "matcher": { - "output": { - "path": "SpotInstanceRequests[].Status.Code", - "expected": "request-canceled-and-instance-running", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "SpotInstanceRequests[].Status.Code", - "expected": "schedule-expired", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "SpotInstanceRequests[].Status.Code", - "expected": "canceled-before-fulfillment", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "SpotInstanceRequests[].Status.Code", - "expected": "bad-parameters", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "SpotInstanceRequests[].Status.Code", - "expected": "system-error", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "retry", - "matcher": { - "errorType": "InvalidSpotInstanceRequestID.NotFound" - } - } - ], - "minDelay": 15 - } - } - } - }, - "com.amazonaws.ec2#DescribeSpotInstanceRequestsRequest": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "SpotInstanceRequestIds": { - "target": "com.amazonaws.ec2#SpotInstanceRequestIdList", - "traits": { - "smithy.api#documentation": "

The IDs of the Spot Instance requests.

", - "smithy.api#xmlName": "SpotInstanceRequestId" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for DescribeSpotInstanceRequests.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeSpotInstanceRequestsResult": { - "type": "structure", - "members": { - "SpotInstanceRequests": { - "target": "com.amazonaws.ec2#SpotInstanceRequestList", - "traits": { - "aws.protocols#ec2QueryName": "SpotInstanceRequestSet", - "smithy.api#documentation": "

The Spot Instance requests.

", - "smithy.api#xmlName": "spotInstanceRequestSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of DescribeSpotInstanceRequests.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeSpotPriceHistory": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeSpotPriceHistoryRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeSpotPriceHistoryResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the Spot price history. For more information, see Spot Instance pricing history in the\n Amazon EC2 User Guide for Linux Instances.

\n

When you specify a start and end time, the operation returns the prices of the\n instance types within that time range. It also returns the last price change before the\n start time, which is the effective price as of the start time.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "SpotPriceHistory", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeSpotPriceHistoryRequest": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

Filters the results by the specified Availability Zone.

", - "smithy.api#xmlName": "availabilityZone" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "EndTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "EndTime", - "smithy.api#documentation": "

The date and time, up to the current date, from which to stop retrieving the price\n history data, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", - "smithy.api#xmlName": "endTime" - } - }, - "InstanceTypes": { - "target": "com.amazonaws.ec2#InstanceTypeList", - "traits": { - "smithy.api#documentation": "

Filters the results by the specified instance types.

", - "smithy.api#xmlName": "InstanceType" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "MaxResults", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

", - "smithy.api#xmlName": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

", - "smithy.api#xmlName": "nextToken" - } - }, - "ProductDescriptions": { - "target": "com.amazonaws.ec2#ProductDescriptionList", - "traits": { - "smithy.api#documentation": "

Filters the results by the specified basic product descriptions.

", - "smithy.api#xmlName": "ProductDescription" - } - }, - "StartTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "StartTime", - "smithy.api#documentation": "

The date and time, up to the past 90 days, from which to start retrieving the price\n history data, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", - "smithy.api#xmlName": "startTime" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for DescribeSpotPriceHistory.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeSpotPriceHistoryResult": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - }, - "SpotPriceHistory": { - "target": "com.amazonaws.ec2#SpotPriceHistoryList", - "traits": { - "aws.protocols#ec2QueryName": "SpotPriceHistorySet", - "smithy.api#documentation": "

The historical Spot prices.

", - "smithy.api#xmlName": "spotPriceHistorySet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of DescribeSpotPriceHistory.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeStaleSecurityGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeStaleSecurityGroupsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeStaleSecurityGroupsResult" - }, - "traits": { - "smithy.api#documentation": "

[VPC only] Describes the stale security group rules for security groups in a specified VPC. \n Rules are stale when they reference a deleted security group in the same VPC or in a peer VPC, \n or if they reference a security group in a peer VPC for which the VPC peering connection has \n been deleted.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "StaleSecurityGroupSet", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeStaleSecurityGroupsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 255 - } - } - }, - "com.amazonaws.ec2#DescribeStaleSecurityGroupsNextToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.ec2#DescribeStaleSecurityGroupsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeStaleSecurityGroupsMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request. To get the next page of items,\n make another request with the token returned in the output. For more information, \n see Pagination.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#DescribeStaleSecurityGroupsNextToken", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.

" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeStaleSecurityGroupsResult": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n If there are no additional items to return, the string is empty.

", - "smithy.api#xmlName": "nextToken" - } - }, - "StaleSecurityGroupSet": { - "target": "com.amazonaws.ec2#StaleSecurityGroupSet", - "traits": { - "aws.protocols#ec2QueryName": "StaleSecurityGroupSet", - "smithy.api#documentation": "

Information about the stale security groups.

", - "smithy.api#xmlName": "staleSecurityGroupSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeStoreImageTasks": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeStoreImageTasksRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeStoreImageTasksResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the progress of the AMI store tasks. You can describe the store tasks for\n specified AMIs. If you don't specify the AMIs, you get a paginated list of store tasks from\n the last 31 days.

\n

For each AMI task, the response indicates if the task is InProgress,\n Completed, or Failed. For tasks InProgress, the\n response shows the estimated progress as a percentage.

\n

Tasks are listed in reverse chronological order. Currently, only tasks from the past 31\n days can be viewed.

\n

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the\n Amazon EC2 User Guide.

\n

For more information, see Store and restore an AMI using\n \tAmazon S3 in the Amazon EC2 User Guide.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "StoreImageTaskResults", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeStoreImageTasksRequest": { - "type": "structure", - "members": { - "ImageIds": { - "target": "com.amazonaws.ec2#ImageIdList", - "traits": { - "smithy.api#documentation": "

The AMI IDs for which to show progress. Up to 20 AMI IDs can be included in a request.

", - "smithy.api#xmlName": "ImageId" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeStoreImageTasksRequestMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

\n

You cannot specify this parameter and the ImageIDs parameter\n in the same call.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeStoreImageTasksRequestMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.ec2#DescribeStoreImageTasksResult": { - "type": "structure", - "members": { - "StoreImageTaskResults": { - "target": "com.amazonaws.ec2#StoreImageTaskResultSet", - "traits": { - "aws.protocols#ec2QueryName": "StoreImageTaskResultSet", - "smithy.api#documentation": "

The information about the AMI store tasks.

", - "smithy.api#xmlName": "storeImageTaskResultSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeSubnets": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeSubnetsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeSubnetsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes one or more of your subnets.

\n

For more information, see Your VPC and subnets in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Subnets", - "pageSize": "MaxResults" - }, - "smithy.waiters#waitable": { - "SubnetAvailable": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "Subnets[].State", - "expected": "available", - "comparator": "allStringEquals" - } - } - } - ], - "minDelay": 15 - } - } - } - }, - "com.amazonaws.ec2#DescribeSubnetsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#DescribeSubnetsRequest": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "SubnetIds": { - "target": "com.amazonaws.ec2#SubnetIdStringList", - "traits": { - "smithy.api#documentation": "

One or more subnet IDs.

\n

Default: Describes all your subnets.

", - "smithy.api#xmlName": "SubnetId" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeSubnetsMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeSubnetsResult": { - "type": "structure", - "members": { - "Subnets": { - "target": "com.amazonaws.ec2#SubnetList", - "traits": { - "aws.protocols#ec2QueryName": "SubnetSet", - "smithy.api#documentation": "

Information about one or more subnets.

", - "smithy.api#xmlName": "subnetSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeTags": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeTagsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeTagsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the specified tags for your EC2 resources.

\n

For more information about tags, see Tag your Amazon EC2 resources in the\n Amazon Elastic Compute Cloud User Guide.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Tags", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeTagsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "MaxResults", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request. This value can be between 5 and 1000. \n To get the next page of items, make another request with the token returned in the output.\n For more information, see Pagination.

", - "smithy.api#xmlName": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeTagsResult": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n This value is null when there are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagDescriptionList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeTrafficMirrorFilters": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeTrafficMirrorFiltersRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeTrafficMirrorFiltersResult" - }, - "traits": { - "smithy.api#documentation": "

Describes one or more Traffic Mirror filters.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "TrafficMirrorFilters", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeTrafficMirrorFiltersRequest": { - "type": "structure", - "members": { - "TrafficMirrorFilterIds": { - "target": "com.amazonaws.ec2#TrafficMirrorFilterIdList", - "traits": { - "smithy.api#documentation": "

The ID of the Traffic Mirror filter.

", - "smithy.api#xmlName": "TrafficMirrorFilterId" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#TrafficMirroringMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeTrafficMirrorFiltersResult": { - "type": "structure", - "members": { - "TrafficMirrorFilters": { - "target": "com.amazonaws.ec2#TrafficMirrorFilterSet", - "traits": { - "aws.protocols#ec2QueryName": "TrafficMirrorFilterSet", - "smithy.api#documentation": "

Information about one or more Traffic Mirror filters.

", - "smithy.api#xmlName": "trafficMirrorFilterSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. The value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeTrafficMirrorSessions": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeTrafficMirrorSessionsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeTrafficMirrorSessionsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "TrafficMirrorSessions", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeTrafficMirrorSessionsRequest": { - "type": "structure", - "members": { - "TrafficMirrorSessionIds": { - "target": "com.amazonaws.ec2#TrafficMirrorSessionIdList", - "traits": { - "smithy.api#documentation": "

The ID of the Traffic Mirror session.

", - "smithy.api#xmlName": "TrafficMirrorSessionId" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#TrafficMirroringMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeTrafficMirrorSessionsResult": { - "type": "structure", - "members": { - "TrafficMirrorSessions": { - "target": "com.amazonaws.ec2#TrafficMirrorSessionSet", - "traits": { - "aws.protocols#ec2QueryName": "TrafficMirrorSessionSet", - "smithy.api#documentation": "

Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.

", - "smithy.api#xmlName": "trafficMirrorSessionSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. The value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeTrafficMirrorTargets": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeTrafficMirrorTargetsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeTrafficMirrorTargetsResult" - }, - "traits": { - "smithy.api#documentation": "

Information about one or more Traffic Mirror targets.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "TrafficMirrorTargets", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeTrafficMirrorTargetsRequest": { - "type": "structure", - "members": { - "TrafficMirrorTargetIds": { - "target": "com.amazonaws.ec2#TrafficMirrorTargetIdList", - "traits": { - "smithy.api#documentation": "

The ID of the Traffic Mirror targets.

", - "smithy.api#xmlName": "TrafficMirrorTargetId" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#TrafficMirroringMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeTrafficMirrorTargetsResult": { - "type": "structure", - "members": { - "TrafficMirrorTargets": { - "target": "com.amazonaws.ec2#TrafficMirrorTargetSet", - "traits": { - "aws.protocols#ec2QueryName": "TrafficMirrorTargetSet", - "smithy.api#documentation": "

Information about one or more Traffic Mirror targets.

", - "smithy.api#xmlName": "trafficMirrorTargetSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. The value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeTransitGatewayAttachments": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeTransitGatewayAttachmentsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeTransitGatewayAttachmentsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes one or more attachments between resources and transit gateways. By default, all attachments are described.\n Alternatively, you can filter the results by attachment ID, attachment state, resource ID, or resource owner.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "TransitGatewayAttachments", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeTransitGatewayAttachmentsRequest": { - "type": "structure", - "members": { - "TransitGatewayAttachmentIds": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentIdStringList", - "traits": { - "smithy.api#documentation": "

The IDs of the attachments.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#TransitGatewayMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeTransitGatewayAttachmentsResult": { - "type": "structure", - "members": { - "TransitGatewayAttachments": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentList", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayAttachments", - "smithy.api#documentation": "

Information about the attachments.

", - "smithy.api#xmlName": "transitGatewayAttachments" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeTransitGatewayConnectPeers": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeTransitGatewayConnectPeersRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeTransitGatewayConnectPeersResult" - }, - "traits": { - "smithy.api#documentation": "

Describes one or more Connect peers.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "TransitGatewayConnectPeers", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeTransitGatewayConnectPeersRequest": { - "type": "structure", - "members": { - "TransitGatewayConnectPeerIds": { - "target": "com.amazonaws.ec2#TransitGatewayConnectPeerIdStringList", - "traits": { - "smithy.api#documentation": "

The IDs of the Connect peers.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#TransitGatewayMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeTransitGatewayConnectPeersResult": { - "type": "structure", - "members": { - "TransitGatewayConnectPeers": { - "target": "com.amazonaws.ec2#TransitGatewayConnectPeerList", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayConnectPeerSet", - "smithy.api#documentation": "

Information about the Connect peers.

", - "smithy.api#xmlName": "transitGatewayConnectPeerSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeTransitGatewayConnects": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeTransitGatewayConnectsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeTransitGatewayConnectsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes one or more Connect attachments.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "TransitGatewayConnects", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeTransitGatewayConnectsRequest": { - "type": "structure", - "members": { - "TransitGatewayAttachmentIds": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentIdStringList", - "traits": { - "smithy.api#documentation": "

The IDs of the attachments.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#TransitGatewayMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeTransitGatewayConnectsResult": { - "type": "structure", - "members": { - "TransitGatewayConnects": { - "target": "com.amazonaws.ec2#TransitGatewayConnectList", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayConnectSet", - "smithy.api#documentation": "

Information about the Connect attachments.

", - "smithy.api#xmlName": "transitGatewayConnectSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeTransitGatewayMulticastDomains": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeTransitGatewayMulticastDomainsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeTransitGatewayMulticastDomainsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes one or more transit gateway multicast domains.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "TransitGatewayMulticastDomains", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeTransitGatewayMulticastDomainsRequest": { - "type": "structure", - "members": { - "TransitGatewayMulticastDomainIds": { - "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainIdStringList", - "traits": { - "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#TransitGatewayMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeTransitGatewayMulticastDomainsResult": { - "type": "structure", - "members": { - "TransitGatewayMulticastDomains": { - "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainList", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayMulticastDomains", - "smithy.api#documentation": "

Information about the transit gateway multicast domains.

", - "smithy.api#xmlName": "transitGatewayMulticastDomains" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeTransitGatewayPeeringAttachments": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeTransitGatewayPeeringAttachmentsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeTransitGatewayPeeringAttachmentsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes your transit gateway peering attachments.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "TransitGatewayPeeringAttachments", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeTransitGatewayPeeringAttachmentsRequest": { - "type": "structure", - "members": { - "TransitGatewayAttachmentIds": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentIdStringList", - "traits": { - "smithy.api#documentation": "

One or more IDs of the transit gateway peering attachments.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#TransitGatewayMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeTransitGatewayPeeringAttachmentsResult": { - "type": "structure", - "members": { - "TransitGatewayPeeringAttachments": { - "target": "com.amazonaws.ec2#TransitGatewayPeeringAttachmentList", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayPeeringAttachments", - "smithy.api#documentation": "

The transit gateway peering attachments.

", - "smithy.api#xmlName": "transitGatewayPeeringAttachments" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeTransitGatewayPolicyTables": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeTransitGatewayPolicyTablesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeTransitGatewayPolicyTablesResult" - }, - "traits": { - "smithy.api#documentation": "

Describes one or more transit gateway route policy tables.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "TransitGatewayPolicyTables", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeTransitGatewayPolicyTablesRequest": { - "type": "structure", - "members": { - "TransitGatewayPolicyTableIds": { - "target": "com.amazonaws.ec2#TransitGatewayPolicyTableIdStringList", - "traits": { - "smithy.api#documentation": "

The IDs of the transit gateway policy tables.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters associated with the transit gateway policy table.

", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#TransitGatewayMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeTransitGatewayPolicyTablesResult": { - "type": "structure", - "members": { - "TransitGatewayPolicyTables": { - "target": "com.amazonaws.ec2#TransitGatewayPolicyTableList", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayPolicyTables", - "smithy.api#documentation": "

Describes the transit gateway policy tables.

", - "smithy.api#xmlName": "transitGatewayPolicyTables" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token for the next page of results.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeTransitGatewayRouteTableAnnouncements": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeTransitGatewayRouteTableAnnouncementsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeTransitGatewayRouteTableAnnouncementsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes one or more transit gateway route table advertisements.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "TransitGatewayRouteTableAnnouncements", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeTransitGatewayRouteTableAnnouncementsRequest": { - "type": "structure", - "members": { - "TransitGatewayRouteTableAnnouncementIds": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementIdStringList", - "traits": { - "smithy.api#documentation": "

The IDs of the transit gateway route tables that are being advertised.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters associated with the transit gateway policy table.

", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#TransitGatewayMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeTransitGatewayRouteTableAnnouncementsResult": { - "type": "structure", - "members": { - "TransitGatewayRouteTableAnnouncements": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementList", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayRouteTableAnnouncements", - "smithy.api#documentation": "

Describes the transit gateway route table announcement.

", - "smithy.api#xmlName": "transitGatewayRouteTableAnnouncements" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token for the next page of results.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeTransitGatewayRouteTables": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeTransitGatewayRouteTablesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeTransitGatewayRouteTablesResult" - }, - "traits": { - "smithy.api#documentation": "

Describes one or more transit gateway route tables. By default, all transit gateway route tables are described.\n Alternatively, you can filter the results.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "TransitGatewayRouteTables", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeTransitGatewayRouteTablesRequest": { - "type": "structure", - "members": { - "TransitGatewayRouteTableIds": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableIdStringList", - "traits": { - "smithy.api#documentation": "

The IDs of the transit gateway route tables.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#TransitGatewayMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeTransitGatewayRouteTablesResult": { - "type": "structure", - "members": { - "TransitGatewayRouteTables": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableList", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayRouteTables", - "smithy.api#documentation": "

Information about the transit gateway route tables.

", - "smithy.api#xmlName": "transitGatewayRouteTables" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeTransitGatewayVpcAttachments": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeTransitGatewayVpcAttachmentsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeTransitGatewayVpcAttachmentsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes one or more VPC attachments. By default, all VPC attachments are described.\n Alternatively, you can filter the results.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "TransitGatewayVpcAttachments", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeTransitGatewayVpcAttachmentsRequest": { - "type": "structure", - "members": { - "TransitGatewayAttachmentIds": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentIdStringList", - "traits": { - "smithy.api#documentation": "

The IDs of the attachments.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#TransitGatewayMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeTransitGatewayVpcAttachmentsResult": { - "type": "structure", - "members": { - "TransitGatewayVpcAttachments": { - "target": "com.amazonaws.ec2#TransitGatewayVpcAttachmentList", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayVpcAttachments", - "smithy.api#documentation": "

Information about the VPC attachments.

", - "smithy.api#xmlName": "transitGatewayVpcAttachments" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeTransitGateways": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeTransitGatewaysRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeTransitGatewaysResult" - }, - "traits": { - "smithy.api#documentation": "

Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can\n filter the results.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "TransitGateways", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeTransitGatewaysRequest": { - "type": "structure", - "members": { - "TransitGatewayIds": { - "target": "com.amazonaws.ec2#TransitGatewayIdStringList", - "traits": { - "smithy.api#documentation": "

The IDs of the transit gateways.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#TransitGatewayMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeTransitGatewaysResult": { - "type": "structure", - "members": { - "TransitGateways": { - "target": "com.amazonaws.ec2#TransitGatewayList", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewaySet", - "smithy.api#documentation": "

Information about the transit gateways.

", - "smithy.api#xmlName": "transitGatewaySet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeTrunkInterfaceAssociations": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeTrunkInterfaceAssociationsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeTrunkInterfaceAssociationsResult" - }, - "traits": { - "smithy.api#documentation": "\n

This API action is currently in limited preview only. \n If you are interested in using this feature, contact your account manager.

\n \n

Describes one or more network interface trunk associations.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "InterfaceAssociations", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeTrunkInterfaceAssociationsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 255 - } - } - }, - "com.amazonaws.ec2#DescribeTrunkInterfaceAssociationsRequest": { - "type": "structure", - "members": { - "AssociationIds": { - "target": "com.amazonaws.ec2#TrunkInterfaceAssociationIdList", - "traits": { - "smithy.api#documentation": "

The IDs of the associations.

", - "smithy.api#xmlName": "AssociationId" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeTrunkInterfaceAssociationsMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeTrunkInterfaceAssociationsResult": { - "type": "structure", - "members": { - "InterfaceAssociations": { - "target": "com.amazonaws.ec2#TrunkInterfaceAssociationList", - "traits": { - "aws.protocols#ec2QueryName": "InterfaceAssociationSet", - "smithy.api#documentation": "

Information about the trunk associations.

", - "smithy.api#xmlName": "interfaceAssociationSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeVerifiedAccessEndpoints": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeVerifiedAccessEndpointsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeVerifiedAccessEndpointsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the specified Amazon Web Services Verified Access endpoints.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "VerifiedAccessEndpoints", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeVerifiedAccessEndpointsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#DescribeVerifiedAccessEndpointsRequest": { - "type": "structure", - "members": { - "VerifiedAccessEndpointIds": { - "target": "com.amazonaws.ec2#VerifiedAccessEndpointIdList", - "traits": { - "smithy.api#documentation": "

The ID of the Verified Access endpoint.

", - "smithy.api#xmlName": "VerifiedAccessEndpointId" - } - }, - "VerifiedAccessInstanceId": { - "target": "com.amazonaws.ec2#VerifiedAccessInstanceId", - "traits": { - "smithy.api#documentation": "

The ID of the Verified Access instance.

" - } - }, - "VerifiedAccessGroupId": { - "target": "com.amazonaws.ec2#VerifiedAccessGroupId", - "traits": { - "smithy.api#documentation": "

The ID of the Verified Access group.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeVerifiedAccessEndpointsMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

", - "smithy.api#xmlName": "Filter" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeVerifiedAccessEndpointsResult": { - "type": "structure", - "members": { - "VerifiedAccessEndpoints": { - "target": "com.amazonaws.ec2#VerifiedAccessEndpointList", - "traits": { - "aws.protocols#ec2QueryName": "VerifiedAccessEndpointSet", - "smithy.api#documentation": "

The ID of the Verified Access endpoint.

", - "smithy.api#xmlName": "verifiedAccessEndpointSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeVerifiedAccessGroupMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#DescribeVerifiedAccessGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeVerifiedAccessGroupsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeVerifiedAccessGroupsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the specified Verified Access groups.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "VerifiedAccessGroups", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeVerifiedAccessGroupsRequest": { - "type": "structure", - "members": { - "VerifiedAccessGroupIds": { - "target": "com.amazonaws.ec2#VerifiedAccessGroupIdList", - "traits": { - "smithy.api#documentation": "

The ID of the Verified Access groups.

", - "smithy.api#xmlName": "VerifiedAccessGroupId" - } - }, - "VerifiedAccessInstanceId": { - "target": "com.amazonaws.ec2#VerifiedAccessInstanceId", - "traits": { - "smithy.api#documentation": "

The ID of the Verified Access instance.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeVerifiedAccessGroupMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

", - "smithy.api#xmlName": "Filter" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeVerifiedAccessGroupsResult": { - "type": "structure", - "members": { - "VerifiedAccessGroups": { - "target": "com.amazonaws.ec2#VerifiedAccessGroupList", - "traits": { - "aws.protocols#ec2QueryName": "VerifiedAccessGroupSet", - "smithy.api#documentation": "

The ID of the Verified Access group.

", - "smithy.api#xmlName": "verifiedAccessGroupSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeVerifiedAccessInstanceLoggingConfigurations": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeVerifiedAccessInstanceLoggingConfigurationsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeVerifiedAccessInstanceLoggingConfigurationsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the specified Amazon Web Services Verified Access instances.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "LoggingConfigurations", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeVerifiedAccessInstanceLoggingConfigurationsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.ec2#DescribeVerifiedAccessInstanceLoggingConfigurationsRequest": { - "type": "structure", - "members": { - "VerifiedAccessInstanceIds": { - "target": "com.amazonaws.ec2#VerifiedAccessInstanceIdList", - "traits": { - "smithy.api#documentation": "

The IDs of the Verified Access instances.

", - "smithy.api#xmlName": "VerifiedAccessInstanceId" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeVerifiedAccessInstanceLoggingConfigurationsMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

", - "smithy.api#xmlName": "Filter" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeVerifiedAccessInstanceLoggingConfigurationsResult": { - "type": "structure", - "members": { - "LoggingConfigurations": { - "target": "com.amazonaws.ec2#VerifiedAccessInstanceLoggingConfigurationList", - "traits": { - "aws.protocols#ec2QueryName": "LoggingConfigurationSet", - "smithy.api#documentation": "

The current logging configuration for the Verified Access instances.

", - "smithy.api#xmlName": "loggingConfigurationSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeVerifiedAccessInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeVerifiedAccessInstancesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeVerifiedAccessInstancesResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the specified Amazon Web Services Verified Access instances.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "VerifiedAccessInstances", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeVerifiedAccessInstancesMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 200 - } - } - }, - "com.amazonaws.ec2#DescribeVerifiedAccessInstancesRequest": { - "type": "structure", - "members": { - "VerifiedAccessInstanceIds": { - "target": "com.amazonaws.ec2#VerifiedAccessInstanceIdList", - "traits": { - "smithy.api#documentation": "

The IDs of the Verified Access instances.

", - "smithy.api#xmlName": "VerifiedAccessInstanceId" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeVerifiedAccessInstancesMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

", - "smithy.api#xmlName": "Filter" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeVerifiedAccessInstancesResult": { - "type": "structure", - "members": { - "VerifiedAccessInstances": { - "target": "com.amazonaws.ec2#VerifiedAccessInstanceList", - "traits": { - "aws.protocols#ec2QueryName": "VerifiedAccessInstanceSet", - "smithy.api#documentation": "

The IDs of the Verified Access instances.

", - "smithy.api#xmlName": "verifiedAccessInstanceSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeVerifiedAccessTrustProviders": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeVerifiedAccessTrustProvidersRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeVerifiedAccessTrustProvidersResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the specified Amazon Web Services Verified Access trust providers.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "VerifiedAccessTrustProviders", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeVerifiedAccessTrustProvidersMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 200 - } - } - }, - "com.amazonaws.ec2#DescribeVerifiedAccessTrustProvidersRequest": { - "type": "structure", - "members": { - "VerifiedAccessTrustProviderIds": { - "target": "com.amazonaws.ec2#VerifiedAccessTrustProviderIdList", - "traits": { - "smithy.api#documentation": "

The IDs of the Verified Access trust providers.

", - "smithy.api#xmlName": "VerifiedAccessTrustProviderId" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeVerifiedAccessTrustProvidersMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

", - "smithy.api#xmlName": "Filter" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeVerifiedAccessTrustProvidersResult": { - "type": "structure", - "members": { - "VerifiedAccessTrustProviders": { - "target": "com.amazonaws.ec2#VerifiedAccessTrustProviderList", - "traits": { - "aws.protocols#ec2QueryName": "VerifiedAccessTrustProviderSet", - "smithy.api#documentation": "

The IDs of the Verified Access trust providers.

", - "smithy.api#xmlName": "verifiedAccessTrustProviderSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeVolumeAttribute": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeVolumeAttributeRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeVolumeAttributeResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the specified attribute of the specified volume. You can specify only one\n attribute at a time.

\n

For more information about EBS volumes, see Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#DescribeVolumeAttributeRequest": { - "type": "structure", - "members": { - "Attribute": { - "target": "com.amazonaws.ec2#VolumeAttributeName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The attribute of the volume. This parameter is required.

", - "smithy.api#required": {} - } - }, - "VolumeId": { - "target": "com.amazonaws.ec2#VolumeId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the volume.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeVolumeAttributeResult": { - "type": "structure", - "members": { - "AutoEnableIO": { - "target": "com.amazonaws.ec2#AttributeBooleanValue", - "traits": { - "aws.protocols#ec2QueryName": "AutoEnableIO", - "smithy.api#documentation": "

The state of autoEnableIO attribute.

", - "smithy.api#xmlName": "autoEnableIO" - } - }, - "ProductCodes": { - "target": "com.amazonaws.ec2#ProductCodeList", - "traits": { - "aws.protocols#ec2QueryName": "ProductCodes", - "smithy.api#documentation": "

A list of product codes.

", - "smithy.api#xmlName": "productCodes" - } - }, - "VolumeId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VolumeId", - "smithy.api#documentation": "

The ID of the volume.

", - "smithy.api#xmlName": "volumeId" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeVolumeStatus": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeVolumeStatusRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeVolumeStatusResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the status of the specified volumes. Volume status provides the result of the\n checks performed on your volumes to determine events that can impair the performance of your\n volumes. The performance of a volume can be affected if an issue occurs on the volume's\n underlying host. If the volume's underlying host experiences a power outage or system issue,\n after the system is restored, there could be data inconsistencies on the volume. Volume events\n notify you if this occurs. Volume actions notify you if any action needs to be taken in\n response to the event.

\n

The DescribeVolumeStatus operation provides the following information about\n the specified volumes:

\n

\n Status: Reflects the current status of the volume. The possible\n values are ok, impaired , warning, or\n insufficient-data. If all checks pass, the overall status of the volume is\n ok. If the check fails, the overall status is impaired. If the\n status is insufficient-data, then the checks might still be taking place on your\n volume at the time. We recommend that you retry the request. For more information about volume\n status, see Monitor the status of your volumes in the\n Amazon Elastic Compute Cloud User Guide.

\n

\n Events: Reflect the cause of a volume status and might require you to\n take action. For example, if your volume returns an impaired status, then the\n volume event might be potential-data-inconsistency. This means that your volume\n has been affected by an issue with the underlying host, has all I/O operations disabled, and\n might have inconsistent data.

\n

\n Actions: Reflect the actions you might have to take in response to an\n event. For example, if the status of the volume is impaired and the volume event\n shows potential-data-inconsistency, then the action shows\n enable-volume-io. This means that you may want to enable the I/O operations for\n the volume by calling the EnableVolumeIO action and then check the volume\n for data consistency.

\n

Volume status is based on the volume status checks, and does not reflect the volume state.\n Therefore, volume status does not indicate volumes in the error state (for\n example, when a volume is incapable of accepting I/O.)

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "VolumeStatuses", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeVolumeStatusRequest": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request. To get the next page of items,\n make another request with the token returned in the output. This value can be between 5 and 1,000;\n if the value is larger than 1,000, only 1,000 results are returned. If this parameter is not used, \n then all items are returned. You cannot specify this parameter and the volume IDs parameter in the \n same request. For more information, see Pagination.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.

" - } - }, - "VolumeIds": { - "target": "com.amazonaws.ec2#VolumeIdStringList", - "traits": { - "smithy.api#documentation": "

The IDs of the volumes.

\n

Default: Describes all your volumes.

", - "smithy.api#xmlName": "VolumeId" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeVolumeStatusResult": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n This value is null when there are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - }, - "VolumeStatuses": { - "target": "com.amazonaws.ec2#VolumeStatusList", - "traits": { - "aws.protocols#ec2QueryName": "VolumeStatusSet", - "smithy.api#documentation": "

Information about the status of the volumes.

", - "smithy.api#xmlName": "volumeStatusSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeVolumes": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeVolumesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeVolumesResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the specified EBS volumes or all of your EBS volumes.

\n

If you are describing a long list of volumes, we recommend that you paginate the output to make the list\n more manageable. For more information, see Pagination.

\n

For more information about EBS volumes, see Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Volumes", - "pageSize": "MaxResults" - }, - "smithy.api#suppress": ["WaitableTraitInvalidErrorType"], - "smithy.waiters#waitable": { - "VolumeAvailable": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "Volumes[].State", - "expected": "available", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Volumes[].State", - "expected": "deleted", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 15 - }, - "VolumeDeleted": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "Volumes[].State", - "expected": "deleted", - "comparator": "allStringEquals" - } - } - }, - { - "state": "success", - "matcher": { - "errorType": "InvalidVolume.NotFound" - } - } - ], - "minDelay": 15 - }, - "VolumeInUse": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "Volumes[].State", - "expected": "in-use", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Volumes[].State", - "expected": "deleted", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 15 - } - } - } - }, - "com.amazonaws.ec2#DescribeVolumesModifications": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeVolumesModificationsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeVolumesModificationsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the most recent volume modification request for the specified EBS volumes.

\n

If a volume has never been modified, some information in the output will be null.\n If a volume has been modified more than once, the output includes only the most \n recent modification request.

\n

You can also use CloudWatch Events to check the status of a modification to an EBS\n volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. For more information, see\n Monitor the progress of volume modifications in the Amazon Elastic Compute Cloud User Guide.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "VolumesModifications", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeVolumesModificationsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "VolumeIds": { - "target": "com.amazonaws.ec2#VolumeIdStringList", - "traits": { - "smithy.api#documentation": "

The IDs of the volumes.

", - "smithy.api#xmlName": "VolumeId" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token returned by a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results (up to a limit of 500) to be returned in a paginated\n request. For more information, see Pagination.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeVolumesModificationsResult": { - "type": "structure", - "members": { - "VolumesModifications": { - "target": "com.amazonaws.ec2#VolumeModificationList", - "traits": { - "aws.protocols#ec2QueryName": "VolumeModificationSet", - "smithy.api#documentation": "

Information about the volume modifications.

", - "smithy.api#xmlName": "volumeModificationSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n This value is null if there are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeVolumesRequest": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "VolumeIds": { - "target": "com.amazonaws.ec2#VolumeIdStringList", - "traits": { - "smithy.api#documentation": "

The volume IDs.

", - "smithy.api#xmlName": "VolumeId" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "MaxResults", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of volumes to return for this request. \n This value can be between 5 and 500; if you specify a value larger than 500, only 500 items are returned. \n If this parameter is not used, then all items are returned. You cannot specify this parameter and the\n volume IDs parameter in the same request. For more information, see Pagination.

", - "smithy.api#xmlName": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token returned from a previous paginated request. \n Pagination continues from the end of the items returned from the previous request.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeVolumesResult": { - "type": "structure", - "members": { - "Volumes": { - "target": "com.amazonaws.ec2#VolumeList", - "traits": { - "aws.protocols#ec2QueryName": "VolumeSet", - "smithy.api#documentation": "

Information about the volumes.

", - "smithy.api#xmlName": "volumeSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n This value is null when there are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeVpcAttribute": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeVpcAttributeRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeVpcAttributeResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.

" - } - }, - "com.amazonaws.ec2#DescribeVpcAttributeRequest": { - "type": "structure", - "members": { - "Attribute": { - "target": "com.amazonaws.ec2#VpcAttributeName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The VPC attribute.

", - "smithy.api#required": {} - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeVpcAttributeResult": { - "type": "structure", - "members": { - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#xmlName": "vpcId" - } - }, - "EnableDnsHostnames": { - "target": "com.amazonaws.ec2#AttributeBooleanValue", - "traits": { - "aws.protocols#ec2QueryName": "EnableDnsHostnames", - "smithy.api#documentation": "

Indicates whether the instances launched in the VPC get DNS hostnames.\n\t\t\t\tIf this attribute is true, instances in the VPC get DNS hostnames;\n\t\t\t\totherwise, they do not.

", - "smithy.api#xmlName": "enableDnsHostnames" - } - }, - "EnableDnsSupport": { - "target": "com.amazonaws.ec2#AttributeBooleanValue", - "traits": { - "aws.protocols#ec2QueryName": "EnableDnsSupport", - "smithy.api#documentation": "

Indicates whether DNS resolution is enabled for\n\t\t\t\tthe VPC. If this attribute is true, the Amazon DNS server\n\t\t\t\tresolves DNS hostnames for your instances to their corresponding\n\t\t\t\tIP addresses; otherwise, it does not.

", - "smithy.api#xmlName": "enableDnsSupport" - } - }, - "EnableNetworkAddressUsageMetrics": { - "target": "com.amazonaws.ec2#AttributeBooleanValue", - "traits": { - "aws.protocols#ec2QueryName": "EnableNetworkAddressUsageMetrics", - "smithy.api#documentation": "

Indicates whether Network Address Usage metrics are enabled for your VPC.

", - "smithy.api#xmlName": "enableNetworkAddressUsageMetrics" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeVpcClassicLink": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeVpcClassicLinkRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeVpcClassicLinkResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the ClassicLink status of one or more VPCs.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " - } - }, - "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupport": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupportRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupportResult" - }, - "traits": { - "smithy.api#documentation": "\n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n \n

Describes the ClassicLink DNS support status of one or more VPCs. If enabled, the DNS\n hostname of a linked EC2-Classic instance resolves to its private IP address when\n addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname\n of an instance in a VPC resolves to its private IP address when addressed from a linked\n EC2-Classic instance. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Vpcs", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupportMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 255 - } - } - }, - "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupportNextToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupportRequest": { - "type": "structure", - "members": { - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupportMaxResults", - "traits": { - "aws.protocols#ec2QueryName": "MaxResults", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

", - "smithy.api#xmlName": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupportNextToken", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

", - "smithy.api#xmlName": "nextToken" - } - }, - "VpcIds": { - "target": "com.amazonaws.ec2#VpcClassicLinkIdList", - "traits": { - "smithy.api#documentation": "

One or more VPC IDs.

", - "smithy.api#xmlName": "VpcIds" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupportResult": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupportNextToken", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - }, - "Vpcs": { - "target": "com.amazonaws.ec2#ClassicLinkDnsSupportList", - "traits": { - "aws.protocols#ec2QueryName": "Vpcs", - "smithy.api#documentation": "

Information about the ClassicLink DNS support status of the VPCs.

", - "smithy.api#xmlName": "vpcs" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeVpcClassicLinkRequest": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "VpcIds": { - "target": "com.amazonaws.ec2#VpcClassicLinkIdList", - "traits": { - "smithy.api#documentation": "

One or more VPCs for which you want to describe the ClassicLink status.

", - "smithy.api#xmlName": "VpcId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeVpcClassicLinkResult": { - "type": "structure", - "members": { - "Vpcs": { - "target": "com.amazonaws.ec2#VpcClassicLinkList", - "traits": { - "aws.protocols#ec2QueryName": "VpcSet", - "smithy.api#documentation": "

The ClassicLink status of one or more VPCs.

", - "smithy.api#xmlName": "vpcSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeVpcEndpointConnectionNotifications": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeVpcEndpointConnectionNotificationsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeVpcEndpointConnectionNotificationsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the connection notifications for VPC endpoints and VPC endpoint\n services.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ConnectionNotificationSet", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeVpcEndpointConnectionNotificationsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "ConnectionNotificationId": { - "target": "com.amazonaws.ec2#ConnectionNotificationId", - "traits": { - "smithy.api#documentation": "

The ID of the notification.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another request with the returned NextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token to request the next page of results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeVpcEndpointConnectionNotificationsResult": { - "type": "structure", - "members": { - "ConnectionNotificationSet": { - "target": "com.amazonaws.ec2#ConnectionNotificationSet", - "traits": { - "aws.protocols#ec2QueryName": "ConnectionNotificationSet", - "smithy.api#documentation": "

The notifications.

", - "smithy.api#xmlName": "connectionNotificationSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is\n null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeVpcEndpointConnections": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeVpcEndpointConnectionsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeVpcEndpointConnectionsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the VPC endpoint connections to your VPC endpoint services, including any\n endpoints that are pending your acceptance.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "VpcEndpointConnections", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeVpcEndpointConnectionsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining\n results of the initial request can be seen by sending another request with the returned\n NextToken value. This value can be between 5 and 1,000; if\n MaxResults is given a value larger than 1,000, only 1,000 results are\n returned.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token to retrieve the next page of results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeVpcEndpointConnectionsResult": { - "type": "structure", - "members": { - "VpcEndpointConnections": { - "target": "com.amazonaws.ec2#VpcEndpointConnectionSet", - "traits": { - "aws.protocols#ec2QueryName": "VpcEndpointConnectionSet", - "smithy.api#documentation": "

Information about the VPC endpoint connections.

", - "smithy.api#xmlName": "vpcEndpointConnectionSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeVpcEndpointServiceConfigurations": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeVpcEndpointServiceConfigurationsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeVpcEndpointServiceConfigurationsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the VPC endpoint service configurations in your account (your services).

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ServiceConfigurations", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeVpcEndpointServiceConfigurationsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "ServiceIds": { - "target": "com.amazonaws.ec2#VpcEndpointServiceIdList", - "traits": { - "smithy.api#documentation": "

The IDs of the endpoint services.

", - "smithy.api#xmlName": "ServiceId" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining\n results of the initial request can be seen by sending another request with the returned\n NextToken value. This value can be between 5 and 1,000; if\n MaxResults is given a value larger than 1,000, only 1,000 results are\n returned.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token to retrieve the next page of results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeVpcEndpointServiceConfigurationsResult": { - "type": "structure", - "members": { - "ServiceConfigurations": { - "target": "com.amazonaws.ec2#ServiceConfigurationSet", - "traits": { - "aws.protocols#ec2QueryName": "ServiceConfigurationSet", - "smithy.api#documentation": "

Information about the services.

", - "smithy.api#xmlName": "serviceConfigurationSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeVpcEndpointServicePermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeVpcEndpointServicePermissionsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeVpcEndpointServicePermissionsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the principals (service consumers) that are permitted to discover your VPC\n endpoint service.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "AllowedPrincipals", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeVpcEndpointServicePermissionsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "ServiceId": { - "target": "com.amazonaws.ec2#VpcEndpointServiceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the service.

", - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining\n results of the initial request can be seen by sending another request with the returned\n NextToken value. This value can be between 5 and 1,000; if\n MaxResults is given a value larger than 1,000, only 1,000 results are\n returned.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token to retrieve the next page of results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeVpcEndpointServicePermissionsResult": { - "type": "structure", - "members": { - "AllowedPrincipals": { - "target": "com.amazonaws.ec2#AllowedPrincipalSet", - "traits": { - "aws.protocols#ec2QueryName": "AllowedPrincipals", - "smithy.api#documentation": "

Information about the allowed principals.

", - "smithy.api#xmlName": "allowedPrincipals" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeVpcEndpointServices": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeVpcEndpointServicesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeVpcEndpointServicesResult" - }, - "traits": { - "smithy.api#documentation": "

Describes available services to which you can create a VPC endpoint.

\n

When the service provider and the consumer have different accounts in multiple\n Availability Zones, and the consumer views the VPC endpoint service information, the\n response only includes the common Availability Zones. For example, when the service\n provider account uses us-east-1a and us-east-1c and the\n consumer uses us-east-1a and us-east-1b, the response includes\n the VPC endpoint services in the common Availability Zone,\n us-east-1a.

" - } - }, - "com.amazonaws.ec2#DescribeVpcEndpointServicesRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "ServiceNames": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#documentation": "

The service names.

", - "smithy.api#xmlName": "ServiceName" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#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.

\n

Constraint: If the value is greater than 1,000, we return only 1,000 items.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a prior call.)

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeVpcEndpointServicesResult": { - "type": "structure", - "members": { - "ServiceNames": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "ServiceNameSet", - "smithy.api#documentation": "

The supported services.

", - "smithy.api#xmlName": "serviceNameSet" - } - }, - "ServiceDetails": { - "target": "com.amazonaws.ec2#ServiceDetailSet", - "traits": { - "aws.protocols#ec2QueryName": "ServiceDetailSet", - "smithy.api#documentation": "

Information about the service.

", - "smithy.api#xmlName": "serviceDetailSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeVpcEndpoints": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeVpcEndpointsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeVpcEndpointsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes your VPC endpoints.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "VpcEndpoints", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#DescribeVpcEndpointsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "VpcEndpointIds": { - "target": "com.amazonaws.ec2#VpcEndpointIdList", - "traits": { - "smithy.api#documentation": "

The IDs of the VPC endpoints.

", - "smithy.api#xmlName": "VpcEndpointId" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#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.

\n

Constraint: If the value is greater than 1,000, we return only 1,000 items.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a prior call.)

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeVpcEndpointsResult": { - "type": "structure", - "members": { - "VpcEndpoints": { - "target": "com.amazonaws.ec2#VpcEndpointSet", - "traits": { - "aws.protocols#ec2QueryName": "VpcEndpointSet", - "smithy.api#documentation": "

Information about the endpoints.

", - "smithy.api#xmlName": "vpcEndpointSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeVpcPeeringConnections": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeVpcPeeringConnectionsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeVpcPeeringConnectionsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes one or more of your VPC peering connections.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "VpcPeeringConnections", - "pageSize": "MaxResults" - }, - "smithy.api#suppress": ["WaitableTraitInvalidErrorType"], - "smithy.waiters#waitable": { - "VpcPeeringConnectionDeleted": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "VpcPeeringConnections[].Status.Code", - "expected": "deleted", - "comparator": "allStringEquals" - } - } - }, - { - "state": "success", - "matcher": { - "errorType": "InvalidVpcPeeringConnectionID.NotFound" - } - } - ], - "minDelay": 15 - }, - "VpcPeeringConnectionExists": { - "acceptors": [ - { - "state": "success", - "matcher": { - "success": true - } - }, - { - "state": "retry", - "matcher": { - "errorType": "InvalidVpcPeeringConnectionID.NotFound" - } - } - ], - "minDelay": 15 - } - } - } - }, - "com.amazonaws.ec2#DescribeVpcPeeringConnectionsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#DescribeVpcPeeringConnectionsRequest": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "VpcPeeringConnectionIds": { - "target": "com.amazonaws.ec2#VpcPeeringConnectionIdList", - "traits": { - "smithy.api#documentation": "

One or more VPC peering connection IDs.

\n

Default: Describes all your VPC peering connections.

", - "smithy.api#xmlName": "VpcPeeringConnectionId" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeVpcPeeringConnectionsMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeVpcPeeringConnectionsResult": { - "type": "structure", - "members": { - "VpcPeeringConnections": { - "target": "com.amazonaws.ec2#VpcPeeringConnectionList", - "traits": { - "aws.protocols#ec2QueryName": "VpcPeeringConnectionSet", - "smithy.api#documentation": "

Information about the VPC peering connections.

", - "smithy.api#xmlName": "vpcPeeringConnectionSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeVpcs": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeVpcsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeVpcsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes one or more of your VPCs.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Vpcs", - "pageSize": "MaxResults" - }, - "smithy.api#suppress": ["WaitableTraitInvalidErrorType"], - "smithy.waiters#waitable": { - "VpcAvailable": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "Vpcs[].State", - "expected": "available", - "comparator": "allStringEquals" - } - } - } - ], - "minDelay": 15 - }, - "VpcExists": { - "acceptors": [ - { - "state": "success", - "matcher": { - "success": true - } - }, - { - "state": "retry", - "matcher": { - "errorType": "InvalidVpcID.NotFound" - } - } - ], - "minDelay": 1 - } - } - } - }, - "com.amazonaws.ec2#DescribeVpcsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#DescribeVpcsRequest": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "VpcIds": { - "target": "com.amazonaws.ec2#VpcIdStringList", - "traits": { - "smithy.api#documentation": "

One or more VPC IDs.

\n

Default: Describes all your VPCs.

", - "smithy.api#xmlName": "VpcId" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeVpcsMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeVpcsResult": { - "type": "structure", - "members": { - "Vpcs": { - "target": "com.amazonaws.ec2#VpcList", - "traits": { - "aws.protocols#ec2QueryName": "VpcSet", - "smithy.api#documentation": "

Information about one or more VPCs.

", - "smithy.api#xmlName": "vpcSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeVpnConnections": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeVpnConnectionsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeVpnConnectionsResult" - }, - "traits": { - "smithy.api#documentation": "

Describes one or more of your VPN connections.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

", - "smithy.waiters#waitable": { - "VpnConnectionAvailable": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "VpnConnections[].State", - "expected": "available", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "VpnConnections[].State", - "expected": "deleting", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "VpnConnections[].State", - "expected": "deleted", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 15 - }, - "VpnConnectionDeleted": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "VpnConnections[].State", - "expected": "deleted", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "VpnConnections[].State", - "expected": "pending", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 15 - } - } - } - }, - "com.amazonaws.ec2#DescribeVpnConnectionsRequest": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "VpnConnectionIds": { - "target": "com.amazonaws.ec2#VpnConnectionIdStringList", - "traits": { - "smithy.api#documentation": "

One or more VPN connection IDs.

\n

Default: Describes your VPN connections.

", - "smithy.api#xmlName": "VpnConnectionId" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for DescribeVpnConnections.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeVpnConnectionsResult": { - "type": "structure", - "members": { - "VpnConnections": { - "target": "com.amazonaws.ec2#VpnConnectionList", - "traits": { - "aws.protocols#ec2QueryName": "VpnConnectionSet", - "smithy.api#documentation": "

Information about one or more VPN connections.

", - "smithy.api#xmlName": "vpnConnectionSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of DescribeVpnConnections.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DescribeVpnGateways": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DescribeVpnGatewaysRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DescribeVpnGatewaysResult" - }, - "traits": { - "smithy.api#documentation": "

Describes one or more of your virtual private gateways.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

" - } - }, - "com.amazonaws.ec2#DescribeVpnGatewaysRequest": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "VpnGatewayIds": { - "target": "com.amazonaws.ec2#VpnGatewayIdStringList", - "traits": { - "smithy.api#documentation": "

One or more virtual private gateway IDs.

\n

Default: Describes all your virtual private gateways.

", - "smithy.api#xmlName": "VpnGatewayId" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for DescribeVpnGateways.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DescribeVpnGatewaysResult": { - "type": "structure", - "members": { - "VpnGateways": { - "target": "com.amazonaws.ec2#VpnGatewayList", - "traits": { - "aws.protocols#ec2QueryName": "VpnGatewaySet", - "smithy.api#documentation": "

Information about one or more virtual private gateways.

", - "smithy.api#xmlName": "vpnGatewaySet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of DescribeVpnGateways.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DestinationFileFormat": { - "type": "enum", - "members": { - "plain_text": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "plain-text" - } - }, - "parquet": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "parquet" - } - } - } - }, - "com.amazonaws.ec2#DestinationOptionsRequest": { - "type": "structure", - "members": { - "FileFormat": { - "target": "com.amazonaws.ec2#DestinationFileFormat", - "traits": { - "smithy.api#documentation": "

The format for the flow log. The default is plain-text.

" - } - }, - "HiveCompatiblePartitions": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3.\n The default is false.

" - } - }, - "PerHourPartition": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to partition the flow log per hour. This reduces the cost and response \n time for queries. The default is false.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the destination options for a flow log.

" - } - }, - "com.amazonaws.ec2#DestinationOptionsResponse": { - "type": "structure", - "members": { - "FileFormat": { - "target": "com.amazonaws.ec2#DestinationFileFormat", - "traits": { - "aws.protocols#ec2QueryName": "FileFormat", - "smithy.api#documentation": "

The format for the flow log.

", - "smithy.api#xmlName": "fileFormat" - } - }, - "HiveCompatiblePartitions": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "HiveCompatiblePartitions", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3.

", - "smithy.api#xmlName": "hiveCompatiblePartitions" - } - }, - "PerHourPartition": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "PerHourPartition", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to partition the flow log per hour.

", - "smithy.api#xmlName": "perHourPartition" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the destination options for a flow log.

" - } - }, - "com.amazonaws.ec2#DetachClassicLinkVpc": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DetachClassicLinkVpcRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DetachClassicLinkVpcResult" - }, - "traits": { - "smithy.api#documentation": "\n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n \n

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.

" - } - }, - "com.amazonaws.ec2#DetachClassicLinkVpcRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the instance to unlink from the VPC.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "instanceId" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the VPC to which the instance is linked.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "vpcId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DetachClassicLinkVpcResult": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DetachInternetGateway": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DetachInternetGatewayRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Detaches an internet gateway from a VPC, disabling connectivity between the internet\n\t\t\tand the VPC. The VPC must not contain any running instances with Elastic IP addresses or\n\t\t\tpublic IPv4 addresses.

" - } - }, - "com.amazonaws.ec2#DetachInternetGatewayRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "InternetGatewayId": { - "target": "com.amazonaws.ec2#InternetGatewayId", - "traits": { - "aws.protocols#ec2QueryName": "InternetGatewayId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the internet gateway.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "internetGatewayId" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "vpcId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DetachNetworkInterface": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DetachNetworkInterfaceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Detaches a network interface from an instance.

" - } - }, - "com.amazonaws.ec2#DetachNetworkInterfaceRequest": { - "type": "structure", - "members": { - "AttachmentId": { - "target": "com.amazonaws.ec2#NetworkInterfaceAttachmentId", - "traits": { - "aws.protocols#ec2QueryName": "AttachmentId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the attachment.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "attachmentId" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "Force": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Force", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether to force a detachment.

\n \n \n ", - "smithy.api#xmlName": "force" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for DetachNetworkInterface.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DetachVerifiedAccessTrustProvider": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DetachVerifiedAccessTrustProviderRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DetachVerifiedAccessTrustProviderResult" - }, - "traits": { - "smithy.api#documentation": "

Detaches the specified Amazon Web Services Verified Access trust provider from the specified Amazon Web Services Verified Access instance.

" - } - }, - "com.amazonaws.ec2#DetachVerifiedAccessTrustProviderRequest": { - "type": "structure", - "members": { - "VerifiedAccessInstanceId": { - "target": "com.amazonaws.ec2#VerifiedAccessInstanceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Verified Access instance.

", - "smithy.api#required": {} - } - }, - "VerifiedAccessTrustProviderId": { - "target": "com.amazonaws.ec2#VerifiedAccessTrustProviderId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Verified Access trust provider.

", - "smithy.api#required": {} - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.

", - "smithy.api#idempotencyToken": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DetachVerifiedAccessTrustProviderResult": { - "type": "structure", - "members": { - "VerifiedAccessTrustProvider": { - "target": "com.amazonaws.ec2#VerifiedAccessTrustProvider", - "traits": { - "aws.protocols#ec2QueryName": "VerifiedAccessTrustProvider", - "smithy.api#documentation": "

The ID of the Verified Access trust provider.

", - "smithy.api#xmlName": "verifiedAccessTrustProvider" - } - }, - "VerifiedAccessInstance": { - "target": "com.amazonaws.ec2#VerifiedAccessInstance", - "traits": { - "aws.protocols#ec2QueryName": "VerifiedAccessInstance", - "smithy.api#documentation": "

The ID of the Verified Access instance.

", - "smithy.api#xmlName": "verifiedAccessInstance" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DetachVolume": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DetachVolumeRequest" - }, - "output": { - "target": "com.amazonaws.ec2#VolumeAttachment" - }, - "traits": { - "smithy.api#documentation": "

Detaches an EBS volume from an instance. Make sure to unmount any file systems on the\n device within your operating system before detaching the volume. Failure to do so can result\n in the volume becoming stuck in the busy state while detaching. If this happens,\n detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot\n the instance, or all three. If an EBS volume is the root device of an instance, it can't be\n detached while the instance is running. To detach the root volume, stop the instance\n first.

\n

When a volume with an Amazon Web Services Marketplace product code is detached from an instance, the\n product code is no longer associated with the instance.

\n

For more information, see Detach an Amazon EBS volume in the\n Amazon Elastic Compute Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#DetachVolumeRequest": { - "type": "structure", - "members": { - "Device": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The device name.

" - } - }, - "Force": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Forces detachment if the previous detachment attempt did not occur cleanly (for example,\n logging into an instance, unmounting the volume, and detaching normally). This option can lead\n to data loss or a corrupted file system. Use this option only as a last resort to detach a\n volume from a failed instance. The instance won't have an opportunity to flush file system\n caches or file system metadata. If you use this option, you must perform file system check and\n repair procedures.

" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceIdForResolver", - "traits": { - "smithy.api#documentation": "

The ID of the instance. If you are detaching a Multi-Attach enabled volume, you must specify an instance ID.

" - } - }, - "VolumeId": { - "target": "com.amazonaws.ec2#VolumeIdWithResolver", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the volume.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DetachVpnGateway": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DetachVpnGatewayRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Detaches a virtual private gateway from a VPC. You do this if you're planning to turn\n off the VPC and not use it anymore. You can confirm a virtual private gateway has been\n completely detached from a VPC by describing the virtual private gateway (any\n attachments to the virtual private gateway are also described).

\n

You must wait for the attachment's state to switch to detached before you\n can delete the VPC or attach a different VPC to the virtual private gateway.

" - } - }, - "com.amazonaws.ec2#DetachVpnGatewayRequest": { - "type": "structure", - "members": { - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#required": {} - } - }, - "VpnGatewayId": { - "target": "com.amazonaws.ec2#VpnGatewayId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the virtual private gateway.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for DetachVpnGateway.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DeviceOptions": { - "type": "structure", - "members": { - "TenantId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TenantId", - "smithy.api#documentation": "

The ID of the tenant application with the device-identity provider.

", - "smithy.api#xmlName": "tenantId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the options for an Amazon Web Services Verified Access device-identity based trust provider.

" - } - }, - "com.amazonaws.ec2#DeviceTrustProviderType": { - "type": "enum", - "members": { - "jamf": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "jamf" - } - }, - "crowdstrike": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "crowdstrike" - } - } - } - }, - "com.amazonaws.ec2#DeviceType": { - "type": "enum", - "members": { - "ebs": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ebs" - } - }, - "instance_store": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "instance-store" - } - } - } - }, - "com.amazonaws.ec2#DhcpConfiguration": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Key", - "smithy.api#documentation": "

The name of a DHCP option.

", - "smithy.api#xmlName": "key" - } - }, - "Values": { - "target": "com.amazonaws.ec2#DhcpConfigurationValueList", - "traits": { - "aws.protocols#ec2QueryName": "ValueSet", - "smithy.api#documentation": "

One or more values for the DHCP option.

", - "smithy.api#xmlName": "valueSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a DHCP configuration option.

" - } - }, - "com.amazonaws.ec2#DhcpConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#DhcpConfiguration", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#DhcpConfigurationValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#AttributeValue", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#DhcpOptions": { - "type": "structure", - "members": { - "DhcpConfigurations": { - "target": "com.amazonaws.ec2#DhcpConfigurationList", - "traits": { - "aws.protocols#ec2QueryName": "DhcpConfigurationSet", - "smithy.api#documentation": "

One or more DHCP options in the set.

", - "smithy.api#xmlName": "dhcpConfigurationSet" - } - }, - "DhcpOptionsId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DhcpOptionsId", - "smithy.api#documentation": "

The ID of the set of DHCP options.

", - "smithy.api#xmlName": "dhcpOptionsId" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the DHCP options set.

", - "smithy.api#xmlName": "ownerId" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the DHCP options set.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a set of DHCP options.

" - } - }, - "com.amazonaws.ec2#DhcpOptionsId": { - "type": "string" - }, - "com.amazonaws.ec2#DhcpOptionsIdStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#DhcpOptionsId", - "traits": { - "smithy.api#xmlName": "DhcpOptionsId" - } - } - }, - "com.amazonaws.ec2#DhcpOptionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#DhcpOptions", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#DirectoryServiceAuthentication": { - "type": "structure", - "members": { - "DirectoryId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DirectoryId", - "smithy.api#documentation": "

The ID of the Active Directory used for authentication.

", - "smithy.api#xmlName": "directoryId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an Active Directory.

" - } - }, - "com.amazonaws.ec2#DirectoryServiceAuthenticationRequest": { - "type": "structure", - "members": { - "DirectoryId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The ID of the Active Directory to be used for authentication.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the Active Directory to be used for client authentication.

" - } - }, - "com.amazonaws.ec2#DisableAddressTransfer": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DisableAddressTransferRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DisableAddressTransferResult" - }, - "traits": { - "smithy.api#documentation": "

Disables Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon Virtual Private Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#DisableAddressTransferRequest": { - "type": "structure", - "members": { - "AllocationId": { - "target": "com.amazonaws.ec2#AllocationId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The allocation ID of an Elastic IP address.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DisableAddressTransferResult": { - "type": "structure", - "members": { - "AddressTransfer": { - "target": "com.amazonaws.ec2#AddressTransfer", - "traits": { - "aws.protocols#ec2QueryName": "AddressTransfer", - "smithy.api#documentation": "

An Elastic IP address transfer.

", - "smithy.api#xmlName": "addressTransfer" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DisableAwsNetworkPerformanceMetricSubscription": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DisableAwsNetworkPerformanceMetricSubscriptionRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DisableAwsNetworkPerformanceMetricSubscriptionResult" - }, - "traits": { - "smithy.api#documentation": "

Disables Infrastructure Performance metric subscriptions.

" - } - }, - "com.amazonaws.ec2#DisableAwsNetworkPerformanceMetricSubscriptionRequest": { - "type": "structure", - "members": { - "Source": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The source Region or Availability Zone that the metric subscription is disabled for. For example, us-east-1.

" - } - }, - "Destination": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The target Region or Availability Zone that the metric subscription is disabled for. For example, eu-north-1.

" - } - }, - "Metric": { - "target": "com.amazonaws.ec2#MetricType", - "traits": { - "smithy.api#documentation": "

The metric used for the disabled subscription.

" - } - }, - "Statistic": { - "target": "com.amazonaws.ec2#StatisticType", - "traits": { - "smithy.api#documentation": "

The statistic used for the disabled subscription.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DisableAwsNetworkPerformanceMetricSubscriptionResult": { - "type": "structure", - "members": { - "Output": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Output", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the unsubscribe action was successful.

", - "smithy.api#xmlName": "output" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DisableEbsEncryptionByDefault": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DisableEbsEncryptionByDefaultRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DisableEbsEncryptionByDefaultResult" - }, - "traits": { - "smithy.api#documentation": "

Disables EBS encryption by default for your account in the current Region.

\n

After you disable encryption by default, you can still create encrypted volumes by \n enabling encryption when you create each volume.

\n

Disabling encryption by default does not change the encryption status of your\n existing volumes.

\n

For more information, see Amazon EBS encryption in the\n Amazon Elastic Compute Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#DisableEbsEncryptionByDefaultRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DisableEbsEncryptionByDefaultResult": { - "type": "structure", - "members": { - "EbsEncryptionByDefault": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "EbsEncryptionByDefault", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

The updated status of encryption by default.

", - "smithy.api#xmlName": "ebsEncryptionByDefault" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DisableFastLaunch": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DisableFastLaunchRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DisableFastLaunchResult" - }, - "traits": { - "smithy.api#documentation": "

Discontinue faster launching for a Windows AMI, and clean up existing pre-provisioned snapshots. \n\t\t\tWhen you disable faster launching, the AMI uses the standard launch process for each \n\t\t\tinstance. All pre-provisioned snapshots must be removed before you can enable faster launching again.

\n \n

To change these settings, you must own the AMI.

\n " - } - }, - "com.amazonaws.ec2#DisableFastLaunchRequest": { - "type": "structure", - "members": { - "ImageId": { - "target": "com.amazonaws.ec2#ImageId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the image for which you’re turning off faster launching, and removing pre-provisioned snapshots.

", - "smithy.api#required": {} - } - }, - "Force": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Forces the image settings to turn off faster launching for your Windows AMI. This parameter overrides \n\t\t\tany errors that are encountered while cleaning up resources in your account.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DisableFastLaunchResult": { - "type": "structure", - "members": { - "ImageId": { - "target": "com.amazonaws.ec2#ImageId", - "traits": { - "aws.protocols#ec2QueryName": "ImageId", - "smithy.api#documentation": "

The ID of the image for which faster-launching has been turned off.

", - "smithy.api#xmlName": "imageId" - } - }, - "ResourceType": { - "target": "com.amazonaws.ec2#FastLaunchResourceType", - "traits": { - "aws.protocols#ec2QueryName": "ResourceType", - "smithy.api#documentation": "

The pre-provisioning resource type that must be cleaned after turning off faster launching \n\t\t\tfor the Windows AMI. Supported values include: snapshot.

", - "smithy.api#xmlName": "resourceType" - } - }, - "SnapshotConfiguration": { - "target": "com.amazonaws.ec2#FastLaunchSnapshotConfigurationResponse", - "traits": { - "aws.protocols#ec2QueryName": "SnapshotConfiguration", - "smithy.api#documentation": "

Parameters that were used for faster launching for the Windows AMI before \n\t\t\tfaster launching was turned off. This informs the clean-up process.

", - "smithy.api#xmlName": "snapshotConfiguration" - } - }, - "LaunchTemplate": { - "target": "com.amazonaws.ec2#FastLaunchLaunchTemplateSpecificationResponse", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplate", - "smithy.api#documentation": "

The launch template that was used to launch Windows instances from pre-provisioned snapshots.

", - "smithy.api#xmlName": "launchTemplate" - } - }, - "MaxParallelLaunches": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "MaxParallelLaunches", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of instances that Amazon EC2 can launch at the same time to \n\t\t\tcreate pre-provisioned snapshots for Windows faster launching.

", - "smithy.api#xmlName": "maxParallelLaunches" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The owner of the Windows AMI for which faster launching was turned off.

", - "smithy.api#xmlName": "ownerId" - } - }, - "State": { - "target": "com.amazonaws.ec2#FastLaunchStateCode", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The current state of faster launching for the specified Windows AMI.

", - "smithy.api#xmlName": "state" - } - }, - "StateTransitionReason": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StateTransitionReason", - "smithy.api#documentation": "

The reason that the state changed for faster launching for the Windows AMI.

", - "smithy.api#xmlName": "stateTransitionReason" - } - }, - "StateTransitionTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "StateTransitionTime", - "smithy.api#documentation": "

The time that the state changed for faster launching for the Windows AMI.

", - "smithy.api#xmlName": "stateTransitionTime" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DisableFastSnapshotRestoreErrorItem": { - "type": "structure", - "members": { - "SnapshotId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SnapshotId", - "smithy.api#documentation": "

The ID of the snapshot.

", - "smithy.api#xmlName": "snapshotId" - } - }, - "FastSnapshotRestoreStateErrors": { - "target": "com.amazonaws.ec2#DisableFastSnapshotRestoreStateErrorSet", - "traits": { - "aws.protocols#ec2QueryName": "FastSnapshotRestoreStateErrorSet", - "smithy.api#documentation": "

The errors.

", - "smithy.api#xmlName": "fastSnapshotRestoreStateErrorSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about the errors that occurred when disabling fast snapshot restores.

" - } - }, - "com.amazonaws.ec2#DisableFastSnapshotRestoreErrorSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#DisableFastSnapshotRestoreErrorItem", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#DisableFastSnapshotRestoreStateError": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The error code.

", - "smithy.api#xmlName": "code" - } - }, - "Message": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "

The error message.

", - "smithy.api#xmlName": "message" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an error that occurred when disabling fast snapshot restores.

" - } - }, - "com.amazonaws.ec2#DisableFastSnapshotRestoreStateErrorItem": { - "type": "structure", - "members": { - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone.

", - "smithy.api#xmlName": "availabilityZone" - } - }, - "Error": { - "target": "com.amazonaws.ec2#DisableFastSnapshotRestoreStateError", - "traits": { - "aws.protocols#ec2QueryName": "Error", - "smithy.api#documentation": "

The error.

", - "smithy.api#xmlName": "error" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about an error that occurred when disabling fast snapshot restores.

" - } - }, - "com.amazonaws.ec2#DisableFastSnapshotRestoreStateErrorSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#DisableFastSnapshotRestoreStateErrorItem", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#DisableFastSnapshotRestoreSuccessItem": { - "type": "structure", - "members": { - "SnapshotId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SnapshotId", - "smithy.api#documentation": "

The ID of the snapshot.

", - "smithy.api#xmlName": "snapshotId" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone.

", - "smithy.api#xmlName": "availabilityZone" - } - }, - "State": { - "target": "com.amazonaws.ec2#FastSnapshotRestoreStateCode", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of fast snapshot restores for the snapshot.

", - "smithy.api#xmlName": "state" - } - }, - "StateTransitionReason": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StateTransitionReason", - "smithy.api#documentation": "

The reason for the state transition. The possible values are as follows:

\n ", - "smithy.api#xmlName": "stateTransitionReason" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that enabled fast snapshot restores on the snapshot.

", - "smithy.api#xmlName": "ownerId" - } - }, - "OwnerAlias": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerAlias", - "smithy.api#documentation": "

The Amazon Web Services owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.

", - "smithy.api#xmlName": "ownerAlias" - } - }, - "EnablingTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "EnablingTime", - "smithy.api#documentation": "

The time at which fast snapshot restores entered the enabling state.

", - "smithy.api#xmlName": "enablingTime" - } - }, - "OptimizingTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "OptimizingTime", - "smithy.api#documentation": "

The time at which fast snapshot restores entered the optimizing state.

", - "smithy.api#xmlName": "optimizingTime" - } - }, - "EnabledTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "EnabledTime", - "smithy.api#documentation": "

The time at which fast snapshot restores entered the enabled state.

", - "smithy.api#xmlName": "enabledTime" - } - }, - "DisablingTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "DisablingTime", - "smithy.api#documentation": "

The time at which fast snapshot restores entered the disabling state.

", - "smithy.api#xmlName": "disablingTime" - } - }, - "DisabledTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "DisabledTime", - "smithy.api#documentation": "

The time at which fast snapshot restores entered the disabled state.

", - "smithy.api#xmlName": "disabledTime" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes fast snapshot restores that were successfully disabled.

" - } - }, - "com.amazonaws.ec2#DisableFastSnapshotRestoreSuccessSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#DisableFastSnapshotRestoreSuccessItem", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#DisableFastSnapshotRestores": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DisableFastSnapshotRestoresRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DisableFastSnapshotRestoresResult" - }, - "traits": { - "smithy.api#documentation": "

Disables fast snapshot restores for the specified snapshots in the specified Availability Zones.

" - } - }, - "com.amazonaws.ec2#DisableFastSnapshotRestoresRequest": { - "type": "structure", - "members": { - "AvailabilityZones": { - "target": "com.amazonaws.ec2#AvailabilityZoneStringList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

One or more Availability Zones. For example, us-east-2a.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "AvailabilityZone" - } - }, - "SourceSnapshotIds": { - "target": "com.amazonaws.ec2#SnapshotIdStringList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IDs of one or more snapshots. For example, snap-1234567890abcdef0.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "SourceSnapshotId" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DisableFastSnapshotRestoresResult": { - "type": "structure", - "members": { - "Successful": { - "target": "com.amazonaws.ec2#DisableFastSnapshotRestoreSuccessSet", - "traits": { - "aws.protocols#ec2QueryName": "Successful", - "smithy.api#documentation": "

Information about the snapshots for which fast snapshot restores were successfully disabled.

", - "smithy.api#xmlName": "successful" - } - }, - "Unsuccessful": { - "target": "com.amazonaws.ec2#DisableFastSnapshotRestoreErrorSet", - "traits": { - "aws.protocols#ec2QueryName": "Unsuccessful", - "smithy.api#documentation": "

Information about the snapshots for which fast snapshot restores could not be disabled.

", - "smithy.api#xmlName": "unsuccessful" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DisableImageDeprecation": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DisableImageDeprecationRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DisableImageDeprecationResult" - }, - "traits": { - "smithy.api#documentation": "

Cancels the deprecation of the specified AMI.

\n

For more information, see Deprecate an AMI in the\n Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#DisableImageDeprecationRequest": { - "type": "structure", - "members": { - "ImageId": { - "target": "com.amazonaws.ec2#ImageId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the AMI.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DisableImageDeprecationResult": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DisableIpamOrganizationAdminAccount": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DisableIpamOrganizationAdminAccountRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DisableIpamOrganizationAdminAccountResult" - }, - "traits": { - "smithy.api#documentation": "

Disable the IPAM account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide.\n

" - } - }, - "com.amazonaws.ec2#DisableIpamOrganizationAdminAccountRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "DelegatedAdminAccountId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Organizations member account ID that you want to disable as IPAM account.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DisableIpamOrganizationAdminAccountResult": { - "type": "structure", - "members": { - "Success": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Success", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

The result of disabling the IPAM account.

", - "smithy.api#xmlName": "success" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DisableSerialConsoleAccess": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DisableSerialConsoleAccessRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DisableSerialConsoleAccessResult" - }, - "traits": { - "smithy.api#documentation": "

Disables access to the EC2 serial console of all instances for your account. By default,\n\t\t\taccess to the EC2 serial console is disabled for your account. For more information, see\n\t\t\t\tManage account access to the EC2 serial console in the Amazon EC2\n\t\t\t\tUser Guide.

" - } - }, - "com.amazonaws.ec2#DisableSerialConsoleAccessRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DisableSerialConsoleAccessResult": { - "type": "structure", - "members": { - "SerialConsoleAccessEnabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "SerialConsoleAccessEnabled", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

If true, access to the EC2 serial console of all instances is enabled for\n\t\t\tyour account. If false, access to the EC2 serial console of all instances\n\t\t\tis disabled for your account.

", - "smithy.api#xmlName": "serialConsoleAccessEnabled" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DisableTransitGatewayRouteTablePropagation": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DisableTransitGatewayRouteTablePropagationRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DisableTransitGatewayRouteTablePropagationResult" - }, - "traits": { - "smithy.api#documentation": "

Disables the specified resource attachment from propagating routes to the specified\n propagation route table.

" - } - }, - "com.amazonaws.ec2#DisableTransitGatewayRouteTablePropagationRequest": { - "type": "structure", - "members": { - "TransitGatewayRouteTableId": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the propagation route table.

", - "smithy.api#required": {} - } - }, - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", - "traits": { - "smithy.api#documentation": "

The ID of the attachment.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "TransitGatewayRouteTableAnnouncementId": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementId", - "traits": { - "smithy.api#documentation": "

The ID of the route table announcement.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DisableTransitGatewayRouteTablePropagationResult": { - "type": "structure", - "members": { - "Propagation": { - "target": "com.amazonaws.ec2#TransitGatewayPropagation", - "traits": { - "aws.protocols#ec2QueryName": "Propagation", - "smithy.api#documentation": "

Information about route propagation.

", - "smithy.api#xmlName": "propagation" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DisableVgwRoutePropagation": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DisableVgwRoutePropagationRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Disables a virtual private gateway (VGW) from propagating routes to a specified route\n table of a VPC.

" - } - }, - "com.amazonaws.ec2#DisableVgwRoutePropagationRequest": { - "type": "structure", - "members": { - "GatewayId": { - "target": "com.amazonaws.ec2#VpnGatewayId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the virtual private gateway.

", - "smithy.api#required": {} - } - }, - "RouteTableId": { - "target": "com.amazonaws.ec2#RouteTableId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the route table.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for DisableVgwRoutePropagation.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DisableVpcClassicLink": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DisableVpcClassicLinkRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DisableVpcClassicLinkResult" - }, - "traits": { - "smithy.api#documentation": "

Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " - } - }, - "com.amazonaws.ec2#DisableVpcClassicLinkDnsSupport": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DisableVpcClassicLinkDnsSupportRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DisableVpcClassicLinkDnsSupportResult" - }, - "traits": { - "smithy.api#documentation": "

Disables ClassicLink DNS support for a VPC. If disabled, DNS hostnames resolve to\n\t\t\tpublic IP addresses when addressed between a linked EC2-Classic instance and instances\n\t\t\tin the VPC to which it's linked. For more information, see ClassicLink in the\n\t\t\t\tAmazon Elastic Compute Cloud User Guide.

\n

You must specify a VPC ID in the request.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " - } - }, - "com.amazonaws.ec2#DisableVpcClassicLinkDnsSupportRequest": { - "type": "structure", - "members": { - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", - "traits": { - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#xmlName": "VpcId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DisableVpcClassicLinkDnsSupportResult": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DisableVpcClassicLinkRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "vpcId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DisableVpcClassicLinkResult": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DisassociateAddress": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DisassociateAddressRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Disassociates an Elastic IP address from the instance or network interface it's associated with.

\n

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more\n\t\t\tinformation, see Elastic IP\n\t\t\t\tAddresses in the Amazon Elastic Compute Cloud User Guide.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n \n

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

" - } - }, - "com.amazonaws.ec2#DisassociateAddressRequest": { - "type": "structure", - "members": { - "AssociationId": { - "target": "com.amazonaws.ec2#ElasticIpAssociationId", - "traits": { - "smithy.api#documentation": "

[EC2-VPC] The association ID. Required for EC2-VPC.

" - } - }, - "PublicIp": { - "target": "com.amazonaws.ec2#EipAllocationPublicIp", - "traits": { - "smithy.api#documentation": "

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DisassociateClientVpnTargetNetwork": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DisassociateClientVpnTargetNetworkRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DisassociateClientVpnTargetNetworkResult" - }, - "traits": { - "smithy.api#documentation": "

Disassociates a target network from the specified Client VPN endpoint. When you disassociate the \n\t\t\tlast target network from a Client VPN, the following happens:

\n " - } - }, - "com.amazonaws.ec2#DisassociateClientVpnTargetNetworkRequest": { - "type": "structure", - "members": { - "ClientVpnEndpointId": { - "target": "com.amazonaws.ec2#ClientVpnEndpointId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Client VPN endpoint from which to disassociate the target network.

", - "smithy.api#required": {} - } - }, - "AssociationId": { - "target": "com.amazonaws.ec2#ClientVpnAssociationId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the target network association.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DisassociateClientVpnTargetNetworkResult": { - "type": "structure", - "members": { - "AssociationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AssociationId", - "smithy.api#documentation": "

The ID of the target network association.

", - "smithy.api#xmlName": "associationId" - } - }, - "Status": { - "target": "com.amazonaws.ec2#AssociationStatus", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The current state of the target network association.

", - "smithy.api#xmlName": "status" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DisassociateEnclaveCertificateIamRole": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DisassociateEnclaveCertificateIamRoleRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DisassociateEnclaveCertificateIamRoleResult" - }, - "traits": { - "smithy.api#documentation": "

Disassociates an IAM role from an Certificate Manager (ACM) certificate. Disassociating an IAM role \n\t\t\tfrom an ACM certificate removes the Amazon S3 object that contains the certificate, certificate chain, and \n\t\t\tencrypted private key from the Amazon S3 bucket. It also revokes the IAM role's permission to use the\n\t\t\tKMS key used to encrypt the private key. This effectively revokes the role's permission \n\t\t\tto use the certificate.

" - } - }, - "com.amazonaws.ec2#DisassociateEnclaveCertificateIamRoleRequest": { - "type": "structure", - "members": { - "CertificateArn": { - "target": "com.amazonaws.ec2#CertificateId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ARN of the ACM certificate from which to disassociate the IAM role.

", - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.ec2#RoleId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ARN of the IAM role to disassociate.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DisassociateEnclaveCertificateIamRoleResult": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DisassociateIamInstanceProfile": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DisassociateIamInstanceProfileRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DisassociateIamInstanceProfileResult" - }, - "traits": { - "smithy.api#documentation": "

Disassociates an IAM instance profile from a running or stopped instance.

\n

Use DescribeIamInstanceProfileAssociations to get the association\n ID.

" - } - }, - "com.amazonaws.ec2#DisassociateIamInstanceProfileRequest": { - "type": "structure", - "members": { - "AssociationId": { - "target": "com.amazonaws.ec2#IamInstanceProfileAssociationId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the IAM instance profile association.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DisassociateIamInstanceProfileResult": { - "type": "structure", - "members": { - "IamInstanceProfileAssociation": { - "target": "com.amazonaws.ec2#IamInstanceProfileAssociation", - "traits": { - "aws.protocols#ec2QueryName": "IamInstanceProfileAssociation", - "smithy.api#documentation": "

Information about the IAM instance profile association.

", - "smithy.api#xmlName": "iamInstanceProfileAssociation" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DisassociateInstanceEventWindow": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DisassociateInstanceEventWindowRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DisassociateInstanceEventWindowResult" - }, - "traits": { - "smithy.api#documentation": "

Disassociates one or more targets from an event window.

\n

For more information, see Define event windows for scheduled\n events in the Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#DisassociateInstanceEventWindowRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "InstanceEventWindowId": { - "target": "com.amazonaws.ec2#InstanceEventWindowId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the event window.

", - "smithy.api#required": {} - } - }, - "AssociationTarget": { - "target": "com.amazonaws.ec2#InstanceEventWindowDisassociationRequest", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

One or more targets to disassociate from the specified event window.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DisassociateInstanceEventWindowResult": { - "type": "structure", - "members": { - "InstanceEventWindow": { - "target": "com.amazonaws.ec2#InstanceEventWindow", - "traits": { - "aws.protocols#ec2QueryName": "InstanceEventWindow", - "smithy.api#documentation": "

Information about the event window.

", - "smithy.api#xmlName": "instanceEventWindow" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DisassociateIpamResourceDiscovery": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DisassociateIpamResourceDiscoveryRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DisassociateIpamResourceDiscoveryResult" - }, - "traits": { - "smithy.api#documentation": "

Disassociates a resource discovery from an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

" - } - }, - "com.amazonaws.ec2#DisassociateIpamResourceDiscoveryRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "IpamResourceDiscoveryAssociationId": { - "target": "com.amazonaws.ec2#IpamResourceDiscoveryAssociationId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A resource discovery association ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DisassociateIpamResourceDiscoveryResult": { - "type": "structure", - "members": { - "IpamResourceDiscoveryAssociation": { - "target": "com.amazonaws.ec2#IpamResourceDiscoveryAssociation", - "traits": { - "aws.protocols#ec2QueryName": "IpamResourceDiscoveryAssociation", - "smithy.api#documentation": "

A resource discovery association.

", - "smithy.api#xmlName": "ipamResourceDiscoveryAssociation" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DisassociateNatGatewayAddress": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DisassociateNatGatewayAddressRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DisassociateNatGatewayAddressResult" - }, - "traits": { - "smithy.api#documentation": "

Disassociates secondary Elastic IP addresses (EIPs) from a public NAT gateway. You cannot disassociate your primary EIP. For more information, see Edit secondary IP address associations in the Amazon Virtual Private Cloud User Guide.

\n

While disassociating is in progress, you cannot associate/disassociate additional EIPs while the connections are being drained. You are, however, allowed to delete the NAT gateway.

\n

An EIP will only be released at the end of MaxDrainDurationSeconds. The EIPs stay\n associated and support the existing connections but do not support any new connections\n (new connections are distributed across the remaining associated EIPs). As the existing\n connections drain out, the EIPs (and the corresponding private IPs mapped to them) get\n released.

" - } - }, - "com.amazonaws.ec2#DisassociateNatGatewayAddressRequest": { - "type": "structure", - "members": { - "NatGatewayId": { - "target": "com.amazonaws.ec2#NatGatewayId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The NAT gateway ID.

", - "smithy.api#required": {} - } - }, - "AssociationIds": { - "target": "com.amazonaws.ec2#EipAssociationIdList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The association IDs of EIPs that have been associated with the NAT gateway.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "AssociationId" - } - }, - "MaxDrainDurationSeconds": { - "target": "com.amazonaws.ec2#DrainSeconds", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DisassociateNatGatewayAddressResult": { - "type": "structure", - "members": { - "NatGatewayId": { - "target": "com.amazonaws.ec2#NatGatewayId", - "traits": { - "aws.protocols#ec2QueryName": "NatGatewayId", - "smithy.api#documentation": "

The NAT gateway ID.

", - "smithy.api#xmlName": "natGatewayId" - } - }, - "NatGatewayAddresses": { - "target": "com.amazonaws.ec2#NatGatewayAddressList", - "traits": { - "aws.protocols#ec2QueryName": "NatGatewayAddressSet", - "smithy.api#documentation": "

Information about the NAT gateway IP addresses.

", - "smithy.api#xmlName": "natGatewayAddressSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DisassociateRouteTable": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DisassociateRouteTableRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Disassociates a subnet or gateway from a route table.

\n

After you perform this action, the subnet no longer uses the routes in the route table.\n\t\t\t\tInstead, it uses the routes in the VPC's main route table. For more information\n\t\t\t\tabout route tables, see Route\n\t\t\t\ttables in the Amazon Virtual Private Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#DisassociateRouteTableRequest": { - "type": "structure", - "members": { - "AssociationId": { - "target": "com.amazonaws.ec2#RouteTableAssociationId", - "traits": { - "aws.protocols#ec2QueryName": "AssociationId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The association ID representing the current association between the route table and subnet or gateway.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "associationId" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DisassociateSubnetCidrBlock": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DisassociateSubnetCidrBlockRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DisassociateSubnetCidrBlockResult" - }, - "traits": { - "smithy.api#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.

" - } - }, - "com.amazonaws.ec2#DisassociateSubnetCidrBlockRequest": { - "type": "structure", - "members": { - "AssociationId": { - "target": "com.amazonaws.ec2#SubnetCidrAssociationId", - "traits": { - "aws.protocols#ec2QueryName": "AssociationId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The association ID for the CIDR block.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "associationId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DisassociateSubnetCidrBlockResult": { - "type": "structure", - "members": { - "Ipv6CidrBlockAssociation": { - "target": "com.amazonaws.ec2#SubnetIpv6CidrBlockAssociation", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6CidrBlockAssociation", - "smithy.api#documentation": "

Information about the IPv6 CIDR block association.

", - "smithy.api#xmlName": "ipv6CidrBlockAssociation" - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#documentation": "

The ID of the subnet.

", - "smithy.api#xmlName": "subnetId" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DisassociateTransitGatewayMulticastDomain": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DisassociateTransitGatewayMulticastDomainRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DisassociateTransitGatewayMulticastDomainResult" - }, - "traits": { - "smithy.api#documentation": "

Disassociates the specified subnets from the transit gateway multicast domain.

" - } - }, - "com.amazonaws.ec2#DisassociateTransitGatewayMulticastDomainRequest": { - "type": "structure", - "members": { - "TransitGatewayMulticastDomainId": { - "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", - "smithy.api#required": {} - } - }, - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the attachment.

", - "smithy.api#required": {} - } - }, - "SubnetIds": { - "target": "com.amazonaws.ec2#TransitGatewaySubnetIdList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IDs of the subnets;

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DisassociateTransitGatewayMulticastDomainResult": { - "type": "structure", - "members": { - "Associations": { - "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainAssociations", - "traits": { - "aws.protocols#ec2QueryName": "Associations", - "smithy.api#documentation": "

Information about the association.

", - "smithy.api#xmlName": "associations" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DisassociateTransitGatewayPolicyTable": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DisassociateTransitGatewayPolicyTableRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DisassociateTransitGatewayPolicyTableResult" - }, - "traits": { - "smithy.api#documentation": "

Removes the association between an an attachment and a policy table.

" - } - }, - "com.amazonaws.ec2#DisassociateTransitGatewayPolicyTableRequest": { - "type": "structure", - "members": { - "TransitGatewayPolicyTableId": { - "target": "com.amazonaws.ec2#TransitGatewayPolicyTableId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the disassociated policy table.

", - "smithy.api#required": {} - } - }, - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the transit gateway attachment to disassociate from the policy table.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DisassociateTransitGatewayPolicyTableResult": { - "type": "structure", - "members": { - "Association": { - "target": "com.amazonaws.ec2#TransitGatewayPolicyTableAssociation", - "traits": { - "aws.protocols#ec2QueryName": "Association", - "smithy.api#documentation": "

Returns details about the transit gateway policy table disassociation.

", - "smithy.api#xmlName": "association" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DisassociateTransitGatewayRouteTable": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DisassociateTransitGatewayRouteTableRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DisassociateTransitGatewayRouteTableResult" - }, - "traits": { - "smithy.api#documentation": "

Disassociates a resource attachment from a transit gateway route table.

" - } - }, - "com.amazonaws.ec2#DisassociateTransitGatewayRouteTableRequest": { - "type": "structure", - "members": { - "TransitGatewayRouteTableId": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the transit gateway route table.

", - "smithy.api#required": {} - } - }, - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the attachment.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DisassociateTransitGatewayRouteTableResult": { - "type": "structure", - "members": { - "Association": { - "target": "com.amazonaws.ec2#TransitGatewayAssociation", - "traits": { - "aws.protocols#ec2QueryName": "Association", - "smithy.api#documentation": "

Information about the association.

", - "smithy.api#xmlName": "association" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DisassociateTrunkInterface": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DisassociateTrunkInterfaceRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DisassociateTrunkInterfaceResult" - }, - "traits": { - "smithy.api#documentation": "\n

This API action is currently in limited preview only. \n If you are interested in using this feature, contact your account manager.

\n \n

Removes an association between a branch network interface with a trunk network interface.

" - } - }, - "com.amazonaws.ec2#DisassociateTrunkInterfaceRequest": { - "type": "structure", - "members": { - "AssociationId": { - "target": "com.amazonaws.ec2#TrunkInterfaceAssociationId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the association

", - "smithy.api#required": {} - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to Ensure\n Idempotency.

", - "smithy.api#idempotencyToken": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DisassociateTrunkInterfaceResult": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", - "smithy.api#xmlName": "return" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to Ensure\n Idempotency.

", - "smithy.api#xmlName": "clientToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DisassociateVpcCidrBlock": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#DisassociateVpcCidrBlockRequest" - }, - "output": { - "target": "com.amazonaws.ec2#DisassociateVpcCidrBlockResult" - }, - "traits": { - "smithy.api#documentation": "

Disassociates a CIDR block from a VPC. To disassociate the CIDR block, you must\n specify its association ID. You can get the association ID by using\n DescribeVpcs. You must detach or delete all gateways and resources that\n are associated with the CIDR block before you can disassociate it.

\n

You cannot disassociate the CIDR block with which you originally created the VPC (the\n\t\t\tprimary CIDR block).

" - } - }, - "com.amazonaws.ec2#DisassociateVpcCidrBlockRequest": { - "type": "structure", - "members": { - "AssociationId": { - "target": "com.amazonaws.ec2#VpcCidrAssociationId", - "traits": { - "aws.protocols#ec2QueryName": "AssociationId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The association ID for the CIDR block.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "associationId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#DisassociateVpcCidrBlockResult": { - "type": "structure", - "members": { - "Ipv6CidrBlockAssociation": { - "target": "com.amazonaws.ec2#VpcIpv6CidrBlockAssociation", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6CidrBlockAssociation", - "smithy.api#documentation": "

Information about the IPv6 CIDR block association.

", - "smithy.api#xmlName": "ipv6CidrBlockAssociation" - } - }, - "CidrBlockAssociation": { - "target": "com.amazonaws.ec2#VpcCidrBlockAssociation", - "traits": { - "aws.protocols#ec2QueryName": "CidrBlockAssociation", - "smithy.api#documentation": "

Information about the IPv4 CIDR block association.

", - "smithy.api#xmlName": "cidrBlockAssociation" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#xmlName": "vpcId" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#DiskCount": { - "type": "integer" - }, - "com.amazonaws.ec2#DiskImage": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A description of the disk image.

" - } - }, - "Image": { - "target": "com.amazonaws.ec2#DiskImageDetail", - "traits": { - "smithy.api#documentation": "

Information about the disk image.

" - } - }, - "Volume": { - "target": "com.amazonaws.ec2#VolumeDetail", - "traits": { - "smithy.api#documentation": "

Information about the volume.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a disk image.

" - } - }, - "com.amazonaws.ec2#DiskImageDescription": { - "type": "structure", - "members": { - "Checksum": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Checksum", - "smithy.api#documentation": "

The checksum computed for the disk image.

", - "smithy.api#xmlName": "checksum" - } - }, - "Format": { - "target": "com.amazonaws.ec2#DiskImageFormat", - "traits": { - "aws.protocols#ec2QueryName": "Format", - "smithy.api#documentation": "

The disk image format.

", - "smithy.api#xmlName": "format" - } - }, - "ImportManifestUrl": { - "target": "com.amazonaws.ec2#ImportManifestUrl", - "traits": { - "aws.protocols#ec2QueryName": "ImportManifestUrl", - "smithy.api#documentation": "

A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for\n an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in\n the Amazon Simple Storage Service Developer Guide.

\n

For information about the import manifest referenced by this API action, see VM Import Manifest.

", - "smithy.api#xmlName": "importManifestUrl" - } - }, - "Size": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "aws.protocols#ec2QueryName": "Size", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The size of the disk image, in GiB.

", - "smithy.api#xmlName": "size" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a disk image.

" - } - }, - "com.amazonaws.ec2#DiskImageDetail": { - "type": "structure", - "members": { - "Bytes": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "aws.protocols#ec2QueryName": "Bytes", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The size of the disk image, in GiB.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "bytes" - } - }, - "Format": { - "target": "com.amazonaws.ec2#DiskImageFormat", - "traits": { - "aws.protocols#ec2QueryName": "Format", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The disk image format.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "format" - } - }, - "ImportManifestUrl": { - "target": "com.amazonaws.ec2#ImportManifestUrl", - "traits": { - "aws.protocols#ec2QueryName": "ImportManifestUrl", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL.\n For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication\n Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer\n Guide.

\n

For information about the import manifest referenced by this API action, see VM Import Manifest.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "importManifestUrl" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a disk image.

" - } - }, - "com.amazonaws.ec2#DiskImageFormat": { - "type": "enum", - "members": { - "VMDK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VMDK" - } - }, - "RAW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RAW" - } - }, - "VHD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VHD" - } - } - } - }, - "com.amazonaws.ec2#DiskImageList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#DiskImage" - } - }, - "com.amazonaws.ec2#DiskImageVolumeDescription": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Id", - "smithy.api#documentation": "

The volume identifier.

", - "smithy.api#xmlName": "id" - } - }, - "Size": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "aws.protocols#ec2QueryName": "Size", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The size of the volume, in GiB.

", - "smithy.api#xmlName": "size" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a disk image volume.

" - } - }, - "com.amazonaws.ec2#DiskInfo": { - "type": "structure", - "members": { - "SizeInGB": { - "target": "com.amazonaws.ec2#DiskSize", - "traits": { - "aws.protocols#ec2QueryName": "SizeInGB", - "smithy.api#documentation": "

The size of the disk in GB.

", - "smithy.api#xmlName": "sizeInGB" - } - }, - "Count": { - "target": "com.amazonaws.ec2#DiskCount", - "traits": { - "aws.protocols#ec2QueryName": "Count", - "smithy.api#documentation": "

The number of disks with this configuration.

", - "smithy.api#xmlName": "count" - } - }, - "Type": { - "target": "com.amazonaws.ec2#DiskType", - "traits": { - "aws.protocols#ec2QueryName": "Type", - "smithy.api#documentation": "

The type of disk.

", - "smithy.api#xmlName": "type" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a disk.

" - } - }, - "com.amazonaws.ec2#DiskInfoList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#DiskInfo", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#DiskSize": { - "type": "long" - }, - "com.amazonaws.ec2#DiskType": { - "type": "enum", - "members": { - "hdd": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "hdd" - } - }, - "ssd": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ssd" - } - } - } - }, - "com.amazonaws.ec2#DnsEntry": { - "type": "structure", - "members": { - "DnsName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DnsName", - "smithy.api#documentation": "

The DNS name.

", - "smithy.api#xmlName": "dnsName" - } - }, - "HostedZoneId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "HostedZoneId", - "smithy.api#documentation": "

The ID of the private hosted zone.

", - "smithy.api#xmlName": "hostedZoneId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a DNS entry.

" - } - }, - "com.amazonaws.ec2#DnsEntrySet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#DnsEntry", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#DnsNameState": { - "type": "enum", - "members": { - "PendingVerification": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pendingVerification" - } - }, - "Verified": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "verified" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failed" - } - } - } - }, - "com.amazonaws.ec2#DnsOptions": { - "type": "structure", - "members": { - "DnsRecordIpType": { - "target": "com.amazonaws.ec2#DnsRecordIpType", - "traits": { - "aws.protocols#ec2QueryName": "DnsRecordIpType", - "smithy.api#documentation": "

The DNS records created for the endpoint.

", - "smithy.api#xmlName": "dnsRecordIpType" - } - }, - "PrivateDnsOnlyForInboundResolverEndpoint": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "PrivateDnsOnlyForInboundResolverEndpoint", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to enable private DNS only for inbound endpoints.

", - "smithy.api#xmlName": "privateDnsOnlyForInboundResolverEndpoint" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the DNS options for an endpoint.

" - } - }, - "com.amazonaws.ec2#DnsOptionsSpecification": { - "type": "structure", - "members": { - "DnsRecordIpType": { - "target": "com.amazonaws.ec2#DnsRecordIpType", - "traits": { - "smithy.api#documentation": "

The DNS records created for the endpoint.

" - } - }, - "PrivateDnsOnlyForInboundResolverEndpoint": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to enable private DNS only for inbound endpoints. This option is\n available only for services that support both gateway and interface endpoints. It routes\n traffic that originates from the VPC to the gateway endpoint and traffic that originates\n from on-premises to the interface endpoint.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the DNS options for an endpoint.

" - } - }, - "com.amazonaws.ec2#DnsRecordIpType": { - "type": "enum", - "members": { - "ipv4": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ipv4" - } - }, - "dualstack": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "dualstack" - } - }, - "ipv6": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ipv6" - } - }, - "service_defined": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "service-defined" - } - } - } - }, - "com.amazonaws.ec2#DnsServersOptionsModifyStructure": { - "type": "structure", - "members": { - "CustomDnsServers": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, of the DNS servers to be used. You can specify up to \n\t\t\ttwo DNS servers. Ensure that the DNS servers can be reached by the clients. The specified values \n\t\t\toverwrite the existing values.

" - } - }, - "Enabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether DNS servers should be used. Specify False to delete the existing DNS \n\t\t\tservers.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the DNS server to be used.

" - } - }, - "com.amazonaws.ec2#DnsSupportValue": { - "type": "enum", - "members": { - "enable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enable" - } - }, - "disable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disable" - } - } - } - }, - "com.amazonaws.ec2#DomainType": { - "type": "enum", - "members": { - "vpc": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "vpc" - } - }, - "standard": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "standard" - } - } - } - }, - "com.amazonaws.ec2#Double": { - "type": "double", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.ec2#DoubleWithConstraints": { - "type": "double", - "traits": { - "smithy.api#range": { - "min": 0.001, - "max": 99.999 - } - } - }, - "com.amazonaws.ec2#DrainSeconds": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 4000 - } - } - }, - "com.amazonaws.ec2#DynamicRoutingValue": { - "type": "enum", - "members": { - "enable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enable" - } - }, - "disable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disable" - } - } - } - }, - "com.amazonaws.ec2#EbsBlockDevice": { - "type": "structure", - "members": { - "DeleteOnTermination": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DeleteOnTermination", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the EBS volume is deleted on instance termination. For more\n information, see Preserving Amazon EBS volumes on instance termination in the\n Amazon EC2 User Guide.

", - "smithy.api#xmlName": "deleteOnTermination" - } - }, - "Iops": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Iops", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes,\n this represents the number of IOPS that are provisioned for the volume. For gp2\n volumes, this represents the baseline performance of the volume and the rate at which\n the volume accumulates I/O credits for bursting.

\n

The following are the supported values for each volume type:

\n \n

For io1 and io2 volumes, we guarantee 64,000 IOPS only for\n Instances built on the\n Nitro System. Other instance families guarantee performance up to\n 32,000 IOPS.

\n

This parameter is required for io1 and io2 volumes. The default for gp3 volumes\n is 3,000 IOPS. This parameter is not supported for gp2, st1, sc1, or standard\n volumes.

", - "smithy.api#xmlName": "iops" - } - }, - "SnapshotId": { - "target": "com.amazonaws.ec2#SnapshotId", - "traits": { - "aws.protocols#ec2QueryName": "SnapshotId", - "smithy.api#documentation": "

The ID of the snapshot.

", - "smithy.api#xmlName": "snapshotId" - } - }, - "VolumeSize": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "VolumeSize", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume\n size. If you specify a snapshot, the default is the snapshot size. You can specify a\n volume size that is equal to or larger than the snapshot size.

\n

The following are the supported volumes sizes for each volume type:

\n ", - "smithy.api#xmlName": "volumeSize" - } - }, - "VolumeType": { - "target": "com.amazonaws.ec2#VolumeType", - "traits": { - "aws.protocols#ec2QueryName": "VolumeType", - "smithy.api#documentation": "

The volume type. For more information, see Amazon EBS volume types in the\n Amazon EC2 User Guide. If the volume type is io1 or\n io2, you must specify the IOPS that the volume supports.

", - "smithy.api#xmlName": "volumeType" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "KmsKeyId", - "smithy.api#documentation": "

Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under\n which the EBS volume is encrypted.

\n

This parameter is only supported on BlockDeviceMapping objects called by\n RunInstances, RequestSpotFleet,\n and RequestSpotInstances.

", - "smithy.api#xmlName": "kmsKeyId" - } - }, - "Throughput": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Throughput", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The throughput that the volume supports, in MiB/s.

\n

This parameter is valid only for gp3 volumes.

\n

Valid Range: Minimum value of 125. Maximum value of 1000.

", - "smithy.api#xmlName": "throughput" - } - }, - "OutpostArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OutpostArn", - "smithy.api#documentation": "

The ARN of the Outpost on which the snapshot is stored.

\n

This parameter is only supported on BlockDeviceMapping objects called by\n \n CreateImage.

", - "smithy.api#xmlName": "outpostArn" - } - }, - "Encrypted": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Encrypted", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the encryption state of an EBS volume is changed while being\n restored from a backing snapshot. The effect of setting the encryption state to true depends on \nthe 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 EC2 User Guide.

\n

In no case can you remove encryption from an encrypted volume.

\n

Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For\n more information, see Supported instance types.

\n

This parameter is not returned by DescribeImageAttribute.

\n

For CreateImage and RegisterImage, whether you can \n include this parameter, and the allowed values differ depending on the type of block \n device mapping you are creating.

\n ", - "smithy.api#xmlName": "encrypted" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a block device for an EBS volume.

" - } - }, - "com.amazonaws.ec2#EbsEncryptionSupport": { - "type": "enum", - "members": { - "unsupported": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unsupported" - } - }, - "supported": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "supported" - } - } - } - }, - "com.amazonaws.ec2#EbsInfo": { - "type": "structure", - "members": { - "EbsOptimizedSupport": { - "target": "com.amazonaws.ec2#EbsOptimizedSupport", - "traits": { - "aws.protocols#ec2QueryName": "EbsOptimizedSupport", - "smithy.api#documentation": "

Indicates whether the instance type is Amazon EBS-optimized. For more information, see Amazon EBS-optimized\n instances in Amazon EC2 User Guide.

", - "smithy.api#xmlName": "ebsOptimizedSupport" - } - }, - "EncryptionSupport": { - "target": "com.amazonaws.ec2#EbsEncryptionSupport", - "traits": { - "aws.protocols#ec2QueryName": "EncryptionSupport", - "smithy.api#documentation": "

Indicates whether Amazon EBS encryption is supported.

", - "smithy.api#xmlName": "encryptionSupport" - } - }, - "EbsOptimizedInfo": { - "target": "com.amazonaws.ec2#EbsOptimizedInfo", - "traits": { - "aws.protocols#ec2QueryName": "EbsOptimizedInfo", - "smithy.api#documentation": "

Describes the optimized EBS performance for the instance type.

", - "smithy.api#xmlName": "ebsOptimizedInfo" - } - }, - "NvmeSupport": { - "target": "com.amazonaws.ec2#EbsNvmeSupport", - "traits": { - "aws.protocols#ec2QueryName": "NvmeSupport", - "smithy.api#documentation": "

Indicates whether non-volatile memory express (NVMe) is supported.

", - "smithy.api#xmlName": "nvmeSupport" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the Amazon EBS features supported by the instance type.

" - } - }, - "com.amazonaws.ec2#EbsInstanceBlockDevice": { - "type": "structure", - "members": { - "AttachTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "AttachTime", - "smithy.api#documentation": "

The time stamp when the attachment initiated.

", - "smithy.api#xmlName": "attachTime" - } - }, - "DeleteOnTermination": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DeleteOnTermination", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the volume is deleted on instance termination.

", - "smithy.api#xmlName": "deleteOnTermination" - } - }, - "Status": { - "target": "com.amazonaws.ec2#AttachmentStatus", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The attachment state.

", - "smithy.api#xmlName": "status" - } - }, - "VolumeId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VolumeId", - "smithy.api#documentation": "

The ID of the EBS volume.

", - "smithy.api#xmlName": "volumeId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a parameter used to set up an EBS volume in a block device mapping.

" - } - }, - "com.amazonaws.ec2#EbsInstanceBlockDeviceSpecification": { - "type": "structure", - "members": { - "DeleteOnTermination": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DeleteOnTermination", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the volume is deleted on instance termination.

", - "smithy.api#xmlName": "deleteOnTermination" - } - }, - "VolumeId": { - "target": "com.amazonaws.ec2#VolumeId", - "traits": { - "aws.protocols#ec2QueryName": "VolumeId", - "smithy.api#documentation": "

The ID of the EBS volume.

", - "smithy.api#xmlName": "volumeId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes information used to set up an EBS volume specified in a block device\n mapping.

" - } - }, - "com.amazonaws.ec2#EbsNvmeSupport": { - "type": "enum", - "members": { - "UNSUPPORTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unsupported" - } - }, - "SUPPORTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "supported" - } - }, - "REQUIRED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "required" - } - } - } - }, - "com.amazonaws.ec2#EbsOptimizedInfo": { - "type": "structure", - "members": { - "BaselineBandwidthInMbps": { - "target": "com.amazonaws.ec2#BaselineBandwidthInMbps", - "traits": { - "aws.protocols#ec2QueryName": "BaselineBandwidthInMbps", - "smithy.api#documentation": "

The baseline bandwidth performance for an EBS-optimized instance type, in Mbps.

", - "smithy.api#xmlName": "baselineBandwidthInMbps" - } - }, - "BaselineThroughputInMBps": { - "target": "com.amazonaws.ec2#BaselineThroughputInMBps", - "traits": { - "aws.protocols#ec2QueryName": "BaselineThroughputInMBps", - "smithy.api#documentation": "

The baseline throughput performance for an EBS-optimized instance type, in MB/s.

", - "smithy.api#xmlName": "baselineThroughputInMBps" - } - }, - "BaselineIops": { - "target": "com.amazonaws.ec2#BaselineIops", - "traits": { - "aws.protocols#ec2QueryName": "BaselineIops", - "smithy.api#documentation": "

The baseline input/output storage operations per seconds for an EBS-optimized instance type.

", - "smithy.api#xmlName": "baselineIops" - } - }, - "MaximumBandwidthInMbps": { - "target": "com.amazonaws.ec2#MaximumBandwidthInMbps", - "traits": { - "aws.protocols#ec2QueryName": "MaximumBandwidthInMbps", - "smithy.api#documentation": "

The maximum bandwidth performance for an EBS-optimized instance type, in Mbps.

", - "smithy.api#xmlName": "maximumBandwidthInMbps" - } - }, - "MaximumThroughputInMBps": { - "target": "com.amazonaws.ec2#MaximumThroughputInMBps", - "traits": { - "aws.protocols#ec2QueryName": "MaximumThroughputInMBps", - "smithy.api#documentation": "

The maximum throughput performance for an EBS-optimized instance type, in MB/s.

", - "smithy.api#xmlName": "maximumThroughputInMBps" - } - }, - "MaximumIops": { - "target": "com.amazonaws.ec2#MaximumIops", - "traits": { - "aws.protocols#ec2QueryName": "MaximumIops", - "smithy.api#documentation": "

The maximum input/output storage operations per second for an EBS-optimized instance type.

", - "smithy.api#xmlName": "maximumIops" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the optimized EBS performance for supported instance types.

" - } - }, - "com.amazonaws.ec2#EbsOptimizedSupport": { - "type": "enum", - "members": { - "unsupported": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unsupported" - } - }, - "supported": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "supported" - } - }, - "default": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "default" - } - } - } - }, - "com.amazonaws.ec2#EfaInfo": { - "type": "structure", - "members": { - "MaximumEfaInterfaces": { - "target": "com.amazonaws.ec2#MaximumEfaInterfaces", - "traits": { - "aws.protocols#ec2QueryName": "MaximumEfaInterfaces", - "smithy.api#documentation": "

The maximum number of Elastic Fabric Adapters for the instance type.

", - "smithy.api#xmlName": "maximumEfaInterfaces" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the Elastic Fabric Adapters for the instance type.

" - } - }, - "com.amazonaws.ec2#EfaSupportedFlag": { - "type": "boolean" - }, - "com.amazonaws.ec2#EgressOnlyInternetGateway": { - "type": "structure", - "members": { - "Attachments": { - "target": "com.amazonaws.ec2#InternetGatewayAttachmentList", - "traits": { - "aws.protocols#ec2QueryName": "AttachmentSet", - "smithy.api#documentation": "

Information about the attachment of the egress-only internet gateway.

", - "smithy.api#xmlName": "attachmentSet" - } - }, - "EgressOnlyInternetGatewayId": { - "target": "com.amazonaws.ec2#EgressOnlyInternetGatewayId", - "traits": { - "aws.protocols#ec2QueryName": "EgressOnlyInternetGatewayId", - "smithy.api#documentation": "

The ID of the egress-only internet gateway.

", - "smithy.api#xmlName": "egressOnlyInternetGatewayId" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags assigned to the egress-only internet gateway.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an egress-only internet gateway.

" - } - }, - "com.amazonaws.ec2#EgressOnlyInternetGatewayId": { - "type": "string" - }, - "com.amazonaws.ec2#EgressOnlyInternetGatewayIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#EgressOnlyInternetGatewayId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#EgressOnlyInternetGatewayList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#EgressOnlyInternetGateway", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#EipAllocationPublicIp": { - "type": "string" - }, - "com.amazonaws.ec2#EipAssociationIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ElasticIpAssociationId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ElasticGpuAssociation": { - "type": "structure", - "members": { - "ElasticGpuId": { - "target": "com.amazonaws.ec2#ElasticGpuId", - "traits": { - "aws.protocols#ec2QueryName": "ElasticGpuId", - "smithy.api#documentation": "

The ID of the Elastic Graphics accelerator.

", - "smithy.api#xmlName": "elasticGpuId" - } - }, - "ElasticGpuAssociationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ElasticGpuAssociationId", - "smithy.api#documentation": "

The ID of the association.

", - "smithy.api#xmlName": "elasticGpuAssociationId" - } - }, - "ElasticGpuAssociationState": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ElasticGpuAssociationState", - "smithy.api#documentation": "

The state of the association between the instance and the\n Elastic Graphics accelerator.

", - "smithy.api#xmlName": "elasticGpuAssociationState" - } - }, - "ElasticGpuAssociationTime": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ElasticGpuAssociationTime", - "smithy.api#documentation": "

The time the Elastic Graphics accelerator was associated with the instance.

", - "smithy.api#xmlName": "elasticGpuAssociationTime" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the association between an instance and an Elastic Graphics accelerator.

" - } - }, - "com.amazonaws.ec2#ElasticGpuAssociationList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ElasticGpuAssociation", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ElasticGpuHealth": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.ec2#ElasticGpuStatus", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The health status.

", - "smithy.api#xmlName": "status" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the status of an Elastic Graphics accelerator.

" - } - }, - "com.amazonaws.ec2#ElasticGpuId": { - "type": "string" - }, - "com.amazonaws.ec2#ElasticGpuIdSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ElasticGpuId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ElasticGpuSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ElasticGpus", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ElasticGpuSpecification": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The type of Elastic Graphics accelerator. For more information about the values to specify for\n Type, see Elastic Graphics Basics, specifically the Elastic Graphics accelerator column, in the \n Amazon Elastic Compute Cloud User Guide for Windows Instances.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A specification for an Elastic Graphics accelerator.

" - } - }, - "com.amazonaws.ec2#ElasticGpuSpecificationList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ElasticGpuSpecification", - "traits": { - "smithy.api#xmlName": "ElasticGpuSpecification" - } - } - }, - "com.amazonaws.ec2#ElasticGpuSpecificationResponse": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Type", - "smithy.api#documentation": "

The elastic GPU type.

", - "smithy.api#xmlName": "type" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an elastic GPU.

" - } - }, - "com.amazonaws.ec2#ElasticGpuSpecificationResponseList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ElasticGpuSpecificationResponse", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ElasticGpuSpecifications": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ElasticGpuSpecification", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ElasticGpuState": { - "type": "enum", - "members": { - "Attached": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ATTACHED" - } - } - } - }, - "com.amazonaws.ec2#ElasticGpuStatus": { - "type": "enum", - "members": { - "Ok": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OK" - } - }, - "Impaired": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IMPAIRED" - } - } - } - }, - "com.amazonaws.ec2#ElasticGpus": { - "type": "structure", - "members": { - "ElasticGpuId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ElasticGpuId", - "smithy.api#documentation": "

The ID of the Elastic Graphics accelerator.

", - "smithy.api#xmlName": "elasticGpuId" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone in the which the Elastic Graphics accelerator resides.

", - "smithy.api#xmlName": "availabilityZone" - } - }, - "ElasticGpuType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ElasticGpuType", - "smithy.api#documentation": "

The type of Elastic Graphics accelerator.

", - "smithy.api#xmlName": "elasticGpuType" - } - }, - "ElasticGpuHealth": { - "target": "com.amazonaws.ec2#ElasticGpuHealth", - "traits": { - "aws.protocols#ec2QueryName": "ElasticGpuHealth", - "smithy.api#documentation": "

The status of the Elastic Graphics accelerator.

", - "smithy.api#xmlName": "elasticGpuHealth" - } - }, - "ElasticGpuState": { - "target": "com.amazonaws.ec2#ElasticGpuState", - "traits": { - "aws.protocols#ec2QueryName": "ElasticGpuState", - "smithy.api#documentation": "

The state of the Elastic Graphics accelerator.

", - "smithy.api#xmlName": "elasticGpuState" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance to which the Elastic Graphics accelerator is attached.

", - "smithy.api#xmlName": "instanceId" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags assigned to the Elastic Graphics accelerator.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an Elastic Graphics accelerator.

" - } - }, - "com.amazonaws.ec2#ElasticInferenceAccelerator": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

\n \tThe type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, eia1.xlarge, eia2.medium, eia2.large, and eia2.xlarge.\n

", - "smithy.api#required": {} - } - }, - "Count": { - "target": "com.amazonaws.ec2#ElasticInferenceAcceleratorCount", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The number of elastic inference accelerators to attach to the instance. \n

\n

Default: 1

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Describes an elastic inference accelerator. \n

" - } - }, - "com.amazonaws.ec2#ElasticInferenceAcceleratorAssociation": { - "type": "structure", - "members": { - "ElasticInferenceAcceleratorArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ElasticInferenceAcceleratorArn", - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the elastic inference accelerator. \n

", - "smithy.api#xmlName": "elasticInferenceAcceleratorArn" - } - }, - "ElasticInferenceAcceleratorAssociationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ElasticInferenceAcceleratorAssociationId", - "smithy.api#documentation": "

\n The ID of the association. \n

", - "smithy.api#xmlName": "elasticInferenceAcceleratorAssociationId" - } - }, - "ElasticInferenceAcceleratorAssociationState": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ElasticInferenceAcceleratorAssociationState", - "smithy.api#documentation": "

\n The state of the elastic inference accelerator.\n

", - "smithy.api#xmlName": "elasticInferenceAcceleratorAssociationState" - } - }, - "ElasticInferenceAcceleratorAssociationTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "ElasticInferenceAcceleratorAssociationTime", - "smithy.api#documentation": "

\n The time at which the elastic inference accelerator is associated with an instance.\n

", - "smithy.api#xmlName": "elasticInferenceAcceleratorAssociationTime" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Describes the association between an instance and an elastic inference accelerator. \n

" - } - }, - "com.amazonaws.ec2#ElasticInferenceAcceleratorAssociationList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ElasticInferenceAcceleratorAssociation", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ElasticInferenceAcceleratorCount": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.ec2#ElasticInferenceAccelerators": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ElasticInferenceAccelerator", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ElasticIpAssociationId": { - "type": "string" - }, - "com.amazonaws.ec2#EnaSrdSpecification": { - "type": "structure", - "members": { - "EnaSrdEnabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether ENA Express is enabled for the network interface.

" - } - }, - "EnaSrdUdpSpecification": { - "target": "com.amazonaws.ec2#EnaSrdUdpSpecification", - "traits": { - "smithy.api#documentation": "

Configures ENA Express for UDP network traffic.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

ENA Express uses Amazon Web Services Scalable Reliable Datagram (SRD) technology to increase the \n\t\t\tmaximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances. \n\t\t\tWith ENA Express, you can communicate between two EC2 instances in the same subnet within the same \n\t\t\taccount, or in different accounts. Both sending and receiving instances must have ENA Express enabled.

\n

To improve the reliability of network packet delivery, ENA Express reorders network packets on the \n\t\t\treceiving end by default. However, some UDP-based applications are designed to handle network packets \n\t\t\tthat are out of order to reduce the overhead for packet delivery at the network layer. When ENA Express \n\t\t\tis enabled, you can specify whether UDP network traffic uses it.

" - } - }, - "com.amazonaws.ec2#EnaSrdSupported": { - "type": "boolean" - }, - "com.amazonaws.ec2#EnaSrdUdpSpecification": { - "type": "structure", - "members": { - "EnaSrdUdpEnabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether UDP traffic uses ENA Express. To specify this setting, you must first enable ENA Express.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

ENA Express is compatible with both TCP and UDP transport protocols. When it’s enabled, TCP traffic \n\t\t\tautomatically uses it. However, some UDP-based applications are designed to handle network packets that are \n\t\t\tout of order, without a need for retransmission, such as live video broadcasting or other near-real-time \n\t\t\tapplications. For UDP traffic, you can specify whether to use ENA Express, based on your application \n\t\t\tenvironment needs.

" - } - }, - "com.amazonaws.ec2#EnaSupport": { - "type": "enum", - "members": { - "unsupported": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unsupported" - } - }, - "supported": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "supported" - } - }, - "required": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "required" - } - } - } - }, - "com.amazonaws.ec2#EnableAddressTransfer": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#EnableAddressTransferRequest" - }, - "output": { - "target": "com.amazonaws.ec2#EnableAddressTransferResult" - }, - "traits": { - "smithy.api#documentation": "

Enables Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon Virtual Private Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#EnableAddressTransferRequest": { - "type": "structure", - "members": { - "AllocationId": { - "target": "com.amazonaws.ec2#AllocationId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The allocation ID of an Elastic IP address.

", - "smithy.api#required": {} - } - }, - "TransferAccountId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the account that you want to transfer the Elastic IP address to.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#EnableAddressTransferResult": { - "type": "structure", - "members": { - "AddressTransfer": { - "target": "com.amazonaws.ec2#AddressTransfer", - "traits": { - "aws.protocols#ec2QueryName": "AddressTransfer", - "smithy.api#documentation": "

An Elastic IP address transfer.

", - "smithy.api#xmlName": "addressTransfer" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#EnableAwsNetworkPerformanceMetricSubscription": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#EnableAwsNetworkPerformanceMetricSubscriptionRequest" - }, - "output": { - "target": "com.amazonaws.ec2#EnableAwsNetworkPerformanceMetricSubscriptionResult" - }, - "traits": { - "smithy.api#documentation": "

Enables Infrastructure Performance subscriptions.

" - } - }, - "com.amazonaws.ec2#EnableAwsNetworkPerformanceMetricSubscriptionRequest": { - "type": "structure", - "members": { - "Source": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The source Region or Availability Zone that the metric subscription is enabled for. For example, us-east-1.

" - } - }, - "Destination": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The target Region or Availability Zone that the metric subscription is enabled for. For example, eu-west-1.

" - } - }, - "Metric": { - "target": "com.amazonaws.ec2#MetricType", - "traits": { - "smithy.api#documentation": "

The metric used for the enabled subscription.

" - } - }, - "Statistic": { - "target": "com.amazonaws.ec2#StatisticType", - "traits": { - "smithy.api#documentation": "

The statistic used for the enabled subscription.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#EnableAwsNetworkPerformanceMetricSubscriptionResult": { - "type": "structure", - "members": { - "Output": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Output", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the subscribe action was successful.

", - "smithy.api#xmlName": "output" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#EnableEbsEncryptionByDefault": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#EnableEbsEncryptionByDefaultRequest" - }, - "output": { - "target": "com.amazonaws.ec2#EnableEbsEncryptionByDefaultResult" - }, - "traits": { - "smithy.api#documentation": "

Enables EBS encryption by default for your account in the current Region.

\n

After you enable encryption by default, the EBS volumes that you create are\n \talways encrypted, either using the default KMS key or the KMS key that you specified\n when you created each volume. For more information, see Amazon EBS encryption in the\n Amazon Elastic Compute Cloud User Guide.

\n

You can specify the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId\n or ResetEbsDefaultKmsKeyId.

\n

Enabling encryption by default has no effect on the encryption status of your \n existing volumes.

\n

After you enable encryption by default, you can no longer launch instances\n using instance types that do not support encryption. For more information, see Supported\n instance types.

" - } - }, - "com.amazonaws.ec2#EnableEbsEncryptionByDefaultRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#EnableEbsEncryptionByDefaultResult": { - "type": "structure", - "members": { - "EbsEncryptionByDefault": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "EbsEncryptionByDefault", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

The updated status of encryption by default.

", - "smithy.api#xmlName": "ebsEncryptionByDefault" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#EnableFastLaunch": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#EnableFastLaunchRequest" - }, - "output": { - "target": "com.amazonaws.ec2#EnableFastLaunchResult" - }, - "traits": { - "smithy.api#documentation": "

When you enable faster launching for a Windows AMI, images are pre-provisioned, \n\t\t\tusing snapshots to launch instances up to 65% faster. To create the optimized Windows \n\t\t\timage, Amazon EC2 launches an instance and runs through Sysprep steps, rebooting as required. \n\t\t\tThen it creates a set of reserved snapshots that are used for subsequent launches. The \n\t\t\treserved snapshots are automatically replenished as they are used, depending on your \n\t\t\tsettings for launch frequency.

\n \n

To change these settings, you must own the AMI.

\n " - } - }, - "com.amazonaws.ec2#EnableFastLaunchRequest": { - "type": "structure", - "members": { - "ImageId": { - "target": "com.amazonaws.ec2#ImageId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the image for which you’re enabling faster launching.

", - "smithy.api#required": {} - } - }, - "ResourceType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The type of resource to use for pre-provisioning the Windows AMI for faster launching. \n\t\t\tSupported values include: snapshot, which is the default value.

" - } - }, - "SnapshotConfiguration": { - "target": "com.amazonaws.ec2#FastLaunchSnapshotConfigurationRequest", - "traits": { - "smithy.api#documentation": "

Configuration settings for creating and managing the snapshots that are used for \n\t\t\tpre-provisioning the Windows AMI for faster launching. The associated ResourceType \n\t\t\tmust be snapshot.

" - } - }, - "LaunchTemplate": { - "target": "com.amazonaws.ec2#FastLaunchLaunchTemplateSpecificationRequest", - "traits": { - "smithy.api#documentation": "

The launch template to use when launching Windows instances from pre-provisioned \n\t\t\tsnapshots. Launch template parameters can include either the name or ID of the launch \n\t\t\ttemplate, but not both.

" - } - }, - "MaxParallelLaunches": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of instances that Amazon EC2 can launch at the same time to create \n\t\t\tpre-provisioned snapshots for Windows faster launching. Value must be \n\t\t\t6 or greater.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#EnableFastLaunchResult": { - "type": "structure", - "members": { - "ImageId": { - "target": "com.amazonaws.ec2#ImageId", - "traits": { - "aws.protocols#ec2QueryName": "ImageId", - "smithy.api#documentation": "

The image ID that identifies the Windows AMI for which faster launching was enabled.

", - "smithy.api#xmlName": "imageId" - } - }, - "ResourceType": { - "target": "com.amazonaws.ec2#FastLaunchResourceType", - "traits": { - "aws.protocols#ec2QueryName": "ResourceType", - "smithy.api#documentation": "

The type of resource that was defined for pre-provisioning the Windows AMI for faster launching.

", - "smithy.api#xmlName": "resourceType" - } - }, - "SnapshotConfiguration": { - "target": "com.amazonaws.ec2#FastLaunchSnapshotConfigurationResponse", - "traits": { - "aws.protocols#ec2QueryName": "SnapshotConfiguration", - "smithy.api#documentation": "

Settings to create and manage the pre-provisioned snapshots that Amazon EC2 uses for faster \n\t\t\tlaunches from the Windows AMI. This property is returned when the associated \n\t\t\tresourceType is snapshot.

", - "smithy.api#xmlName": "snapshotConfiguration" - } - }, - "LaunchTemplate": { - "target": "com.amazonaws.ec2#FastLaunchLaunchTemplateSpecificationResponse", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplate", - "smithy.api#documentation": "

The launch template that is used when launching Windows instances from pre-provisioned snapshots.

", - "smithy.api#xmlName": "launchTemplate" - } - }, - "MaxParallelLaunches": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "MaxParallelLaunches", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of instances that Amazon EC2 can launch at the same time to \n\t\t\tcreate pre-provisioned snapshots for Windows faster launching.

", - "smithy.api#xmlName": "maxParallelLaunches" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The owner ID for the Windows AMI for which faster launching was enabled.

", - "smithy.api#xmlName": "ownerId" - } - }, - "State": { - "target": "com.amazonaws.ec2#FastLaunchStateCode", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The current state of faster launching for the specified Windows AMI.

", - "smithy.api#xmlName": "state" - } - }, - "StateTransitionReason": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StateTransitionReason", - "smithy.api#documentation": "

The reason that the state changed for faster launching for the Windows AMI.

", - "smithy.api#xmlName": "stateTransitionReason" - } - }, - "StateTransitionTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "StateTransitionTime", - "smithy.api#documentation": "

The time that the state changed for faster launching for the Windows AMI.

", - "smithy.api#xmlName": "stateTransitionTime" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#EnableFastSnapshotRestoreErrorItem": { - "type": "structure", - "members": { - "SnapshotId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SnapshotId", - "smithy.api#documentation": "

The ID of the snapshot.

", - "smithy.api#xmlName": "snapshotId" - } - }, - "FastSnapshotRestoreStateErrors": { - "target": "com.amazonaws.ec2#EnableFastSnapshotRestoreStateErrorSet", - "traits": { - "aws.protocols#ec2QueryName": "FastSnapshotRestoreStateErrorSet", - "smithy.api#documentation": "

The errors.

", - "smithy.api#xmlName": "fastSnapshotRestoreStateErrorSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about the errors that occurred when enabling fast snapshot restores.

" - } - }, - "com.amazonaws.ec2#EnableFastSnapshotRestoreErrorSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#EnableFastSnapshotRestoreErrorItem", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#EnableFastSnapshotRestoreStateError": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The error code.

", - "smithy.api#xmlName": "code" - } - }, - "Message": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "

The error message.

", - "smithy.api#xmlName": "message" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an error that occurred when enabling fast snapshot restores.

" - } - }, - "com.amazonaws.ec2#EnableFastSnapshotRestoreStateErrorItem": { - "type": "structure", - "members": { - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone.

", - "smithy.api#xmlName": "availabilityZone" - } - }, - "Error": { - "target": "com.amazonaws.ec2#EnableFastSnapshotRestoreStateError", - "traits": { - "aws.protocols#ec2QueryName": "Error", - "smithy.api#documentation": "

The error.

", - "smithy.api#xmlName": "error" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about an error that occurred when enabling fast snapshot restores.

" - } - }, - "com.amazonaws.ec2#EnableFastSnapshotRestoreStateErrorSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#EnableFastSnapshotRestoreStateErrorItem", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#EnableFastSnapshotRestoreSuccessItem": { - "type": "structure", - "members": { - "SnapshotId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SnapshotId", - "smithy.api#documentation": "

The ID of the snapshot.

", - "smithy.api#xmlName": "snapshotId" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone.

", - "smithy.api#xmlName": "availabilityZone" - } - }, - "State": { - "target": "com.amazonaws.ec2#FastSnapshotRestoreStateCode", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of fast snapshot restores.

", - "smithy.api#xmlName": "state" - } - }, - "StateTransitionReason": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StateTransitionReason", - "smithy.api#documentation": "

The reason for the state transition. The possible values are as follows:

\n ", - "smithy.api#xmlName": "stateTransitionReason" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that enabled fast snapshot restores on the snapshot.

", - "smithy.api#xmlName": "ownerId" - } - }, - "OwnerAlias": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerAlias", - "smithy.api#documentation": "

The Amazon Web Services owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.

", - "smithy.api#xmlName": "ownerAlias" - } - }, - "EnablingTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "EnablingTime", - "smithy.api#documentation": "

The time at which fast snapshot restores entered the enabling state.

", - "smithy.api#xmlName": "enablingTime" - } - }, - "OptimizingTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "OptimizingTime", - "smithy.api#documentation": "

The time at which fast snapshot restores entered the optimizing state.

", - "smithy.api#xmlName": "optimizingTime" - } - }, - "EnabledTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "EnabledTime", - "smithy.api#documentation": "

The time at which fast snapshot restores entered the enabled state.

", - "smithy.api#xmlName": "enabledTime" - } - }, - "DisablingTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "DisablingTime", - "smithy.api#documentation": "

The time at which fast snapshot restores entered the disabling state.

", - "smithy.api#xmlName": "disablingTime" - } - }, - "DisabledTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "DisabledTime", - "smithy.api#documentation": "

The time at which fast snapshot restores entered the disabled state.

", - "smithy.api#xmlName": "disabledTime" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes fast snapshot restores that were successfully enabled.

" - } - }, - "com.amazonaws.ec2#EnableFastSnapshotRestoreSuccessSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#EnableFastSnapshotRestoreSuccessItem", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#EnableFastSnapshotRestores": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#EnableFastSnapshotRestoresRequest" - }, - "output": { - "target": "com.amazonaws.ec2#EnableFastSnapshotRestoresResult" - }, - "traits": { - "smithy.api#documentation": "

Enables fast snapshot restores for the specified snapshots in the specified Availability Zones.

\n

You get the full benefit of fast snapshot restores after they enter the enabled state.\n To get the current state of fast snapshot restores, use DescribeFastSnapshotRestores.\n To disable fast snapshot restores, use DisableFastSnapshotRestores.

\n

For more information, see Amazon EBS fast snapshot\n restore in the Amazon Elastic Compute Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#EnableFastSnapshotRestoresRequest": { - "type": "structure", - "members": { - "AvailabilityZones": { - "target": "com.amazonaws.ec2#AvailabilityZoneStringList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

One or more Availability Zones. For example, us-east-2a.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "AvailabilityZone" - } - }, - "SourceSnapshotIds": { - "target": "com.amazonaws.ec2#SnapshotIdStringList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IDs of one or more snapshots. For example, snap-1234567890abcdef0. You can specify\n a snapshot that was shared with you from another Amazon Web Services account.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "SourceSnapshotId" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#EnableFastSnapshotRestoresResult": { - "type": "structure", - "members": { - "Successful": { - "target": "com.amazonaws.ec2#EnableFastSnapshotRestoreSuccessSet", - "traits": { - "aws.protocols#ec2QueryName": "Successful", - "smithy.api#documentation": "

Information about the snapshots for which fast snapshot restores were successfully enabled.

", - "smithy.api#xmlName": "successful" - } - }, - "Unsuccessful": { - "target": "com.amazonaws.ec2#EnableFastSnapshotRestoreErrorSet", - "traits": { - "aws.protocols#ec2QueryName": "Unsuccessful", - "smithy.api#documentation": "

Information about the snapshots for which fast snapshot restores could not be enabled.

", - "smithy.api#xmlName": "unsuccessful" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#EnableImageDeprecation": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#EnableImageDeprecationRequest" - }, - "output": { - "target": "com.amazonaws.ec2#EnableImageDeprecationResult" - }, - "traits": { - "smithy.api#documentation": "

Enables deprecation of the specified AMI at the specified date and time.

\n

For more information, see Deprecate an AMI in the Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#EnableImageDeprecationRequest": { - "type": "structure", - "members": { - "ImageId": { - "target": "com.amazonaws.ec2#ImageId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the AMI.

", - "smithy.api#required": {} - } - }, - "DeprecateAt": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The date and time to deprecate the AMI, in UTC, in the following format:\n YYYY-MM-DDTHH:MM:SSZ.\n If you specify a value for seconds, Amazon EC2 rounds the seconds to the\n nearest minute.

\n

You can’t specify a date in the past. The upper limit for DeprecateAt is 10\n years from now, except for public AMIs, where the upper limit is 2 years from the creation date.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#EnableImageDeprecationResult": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#EnableIpamOrganizationAdminAccount": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#EnableIpamOrganizationAdminAccountRequest" - }, - "output": { - "target": "com.amazonaws.ec2#EnableIpamOrganizationAdminAccountResult" - }, - "traits": { - "smithy.api#documentation": "

Enable an Organizations member account as the IPAM admin account. You cannot select the Organizations management account as the IPAM admin account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide.\n

" - } - }, - "com.amazonaws.ec2#EnableIpamOrganizationAdminAccountRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "DelegatedAdminAccountId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Organizations member account ID that you want to enable as the IPAM account.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#EnableIpamOrganizationAdminAccountResult": { - "type": "structure", - "members": { - "Success": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Success", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

The result of enabling the IPAM account.

", - "smithy.api#xmlName": "success" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#EnableReachabilityAnalyzerOrganizationSharing": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#EnableReachabilityAnalyzerOrganizationSharingRequest" - }, - "output": { - "target": "com.amazonaws.ec2#EnableReachabilityAnalyzerOrganizationSharingResult" - }, - "traits": { - "smithy.api#documentation": "

Establishes a trust relationship between Reachability Analyzer and Organizations.\n This operation must be performed by the management account for the organization.

\n

After you establish a trust relationship, a user in the management account or \n a delegated administrator account can run a cross-account analysis using resources \n from the member accounts.

" - } - }, - "com.amazonaws.ec2#EnableReachabilityAnalyzerOrganizationSharingRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#EnableReachabilityAnalyzerOrganizationSharingResult": { - "type": "structure", - "members": { - "ReturnValue": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "ReturnValue", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, returns an error.

", - "smithy.api#xmlName": "returnValue" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#EnableSerialConsoleAccess": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#EnableSerialConsoleAccessRequest" - }, - "output": { - "target": "com.amazonaws.ec2#EnableSerialConsoleAccessResult" - }, - "traits": { - "smithy.api#documentation": "

Enables access to the EC2 serial console of all instances for your account. By default,\n\t\t\taccess to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console\n\t\t\tin the Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#EnableSerialConsoleAccessRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#EnableSerialConsoleAccessResult": { - "type": "structure", - "members": { - "SerialConsoleAccessEnabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "SerialConsoleAccessEnabled", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

If true, access to the EC2 serial console of all instances is enabled for\n\t\t\tyour account. If false, access to the EC2 serial console of all instances\n\t\t\tis disabled for your account.

", - "smithy.api#xmlName": "serialConsoleAccessEnabled" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#EnableTransitGatewayRouteTablePropagation": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#EnableTransitGatewayRouteTablePropagationRequest" - }, - "output": { - "target": "com.amazonaws.ec2#EnableTransitGatewayRouteTablePropagationResult" - }, - "traits": { - "smithy.api#documentation": "

Enables the specified attachment to propagate routes to the specified\n propagation route table.

" - } - }, - "com.amazonaws.ec2#EnableTransitGatewayRouteTablePropagationRequest": { - "type": "structure", - "members": { - "TransitGatewayRouteTableId": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the propagation route table.

", - "smithy.api#required": {} - } - }, - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", - "traits": { - "smithy.api#documentation": "

The ID of the attachment.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "TransitGatewayRouteTableAnnouncementId": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementId", - "traits": { - "smithy.api#documentation": "

The ID of the transit gateway route table announcement.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#EnableTransitGatewayRouteTablePropagationResult": { - "type": "structure", - "members": { - "Propagation": { - "target": "com.amazonaws.ec2#TransitGatewayPropagation", - "traits": { - "aws.protocols#ec2QueryName": "Propagation", - "smithy.api#documentation": "

Information about route propagation.

", - "smithy.api#xmlName": "propagation" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#EnableVgwRoutePropagation": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#EnableVgwRoutePropagationRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Enables a virtual private gateway (VGW) to propagate routes to the specified route\n table of a VPC.

" - } - }, - "com.amazonaws.ec2#EnableVgwRoutePropagationRequest": { - "type": "structure", - "members": { - "GatewayId": { - "target": "com.amazonaws.ec2#VpnGatewayId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the virtual private gateway that is attached to a VPC. The virtual private\n gateway must be attached to the same VPC that the routing tables are associated with.\n

", - "smithy.api#required": {} - } - }, - "RouteTableId": { - "target": "com.amazonaws.ec2#RouteTableId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the route table. The routing table must be associated with the same VPC that\n the virtual private gateway is attached to.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for EnableVgwRoutePropagation.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#EnableVolumeIO": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#EnableVolumeIORequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Enables I/O operations for a volume that had I/O operations disabled because the data on\n the volume was potentially inconsistent.

" - } - }, - "com.amazonaws.ec2#EnableVolumeIORequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "VolumeId": { - "target": "com.amazonaws.ec2#VolumeId", - "traits": { - "aws.protocols#ec2QueryName": "VolumeId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the volume.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "volumeId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#EnableVpcClassicLink": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#EnableVpcClassicLinkRequest" - }, - "output": { - "target": "com.amazonaws.ec2#EnableVpcClassicLinkResult" - }, - "traits": { - "smithy.api#documentation": "\n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n \n

Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your\n\t\t\tClassicLink-enabled VPC to allow communication over private IP addresses. You cannot\n\t\t\tenable your VPC for ClassicLink if any of your VPC route tables have existing routes for\n\t\t\taddress ranges within the 10.0.0.0/8 IP address range, excluding local\n\t\t\troutes for VPCs in the 10.0.0.0/16 and 10.1.0.0/16 IP address\n\t\t\tranges. For more information, see ClassicLink in the\n\t\t\t\tAmazon Elastic Compute Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#EnableVpcClassicLinkDnsSupport": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#EnableVpcClassicLinkDnsSupportRequest" - }, - "output": { - "target": "com.amazonaws.ec2#EnableVpcClassicLinkDnsSupportResult" - }, - "traits": { - "smithy.api#documentation": "\n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n \n

Enables a VPC to support DNS hostname resolution for ClassicLink. If enabled, the DNS\n\t\t\thostname of a linked EC2-Classic instance resolves to its private IP address when\n\t\t\taddressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname\n\t\t\tof an instance in a VPC resolves to its private IP address when addressed from a linked\n\t\t\tEC2-Classic instance. For more information, see ClassicLink in the\n\t\t\t\tAmazon Elastic Compute Cloud User Guide.

\n

You must specify a VPC ID in the request.

" - } - }, - "com.amazonaws.ec2#EnableVpcClassicLinkDnsSupportRequest": { - "type": "structure", - "members": { - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", - "traits": { - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#xmlName": "VpcId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#EnableVpcClassicLinkDnsSupportResult": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#EnableVpcClassicLinkRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "vpcId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#EnableVpcClassicLinkResult": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#EnclaveOptions": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Enabled", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

If this parameter is set to true, the instance is enabled for Amazon Web Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro\n Enclaves.

", - "smithy.api#xmlName": "enabled" - } - } - }, - "traits": { - "smithy.api#documentation": "

Indicates whether the instance is enabled for Amazon Web Services Nitro\n Enclaves.

" - } - }, - "com.amazonaws.ec2#EnclaveOptionsRequest": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to\n true.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For\n more information, see What is Amazon Web Services Nitro\n Enclaves? in the Amazon Web Services Nitro Enclaves User\n Guide.

" - } - }, - "com.amazonaws.ec2#EncryptionInTransitSupported": { - "type": "boolean" - }, - "com.amazonaws.ec2#EndDateType": { - "type": "enum", - "members": { - "unlimited": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unlimited" - } - }, - "limited": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "limited" - } - } - } - }, - "com.amazonaws.ec2#EndpointSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ClientVpnEndpoint", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#EphemeralNvmeSupport": { - "type": "enum", - "members": { - "UNSUPPORTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unsupported" - } - }, - "SUPPORTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "supported" - } - }, - "REQUIRED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "required" - } - } - } - }, - "com.amazonaws.ec2#ErrorSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ValidationError", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#EventCode": { - "type": "enum", - "members": { - "instance_reboot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "instance-reboot" - } - }, - "system_reboot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "system-reboot" - } - }, - "system_maintenance": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "system-maintenance" - } - }, - "instance_retirement": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "instance-retirement" - } - }, - "instance_stop": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "instance-stop" - } - } - } - }, - "com.amazonaws.ec2#EventInformation": { - "type": "structure", - "members": { - "EventDescription": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "EventDescription", - "smithy.api#documentation": "

The description of the event.

", - "smithy.api#xmlName": "eventDescription" - } - }, - "EventSubType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "EventSubType", - "smithy.api#documentation": "

The event.

\n

\n error events:

\n \n

\n fleetRequestChange events:

\n \n

\n instanceChange events:

\n \n

\n Information events:

\n ", - "smithy.api#xmlName": "eventSubType" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance. This information is available only for\n instanceChange events.

", - "smithy.api#xmlName": "instanceId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an EC2 Fleet or Spot Fleet event.

" - } - }, - "com.amazonaws.ec2#EventType": { - "type": "enum", - "members": { - "INSTANCE_CHANGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "instanceChange" - } - }, - "BATCH_CHANGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "fleetRequestChange" - } - }, - "ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "error" - } - }, - "INFORMATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "information" - } - } - } - }, - "com.amazonaws.ec2#ExcessCapacityTerminationPolicy": { - "type": "enum", - "members": { - "NO_TERMINATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "noTermination" - } - }, - "DEFAULT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "default" - } - } - } - }, - "com.amazonaws.ec2#ExcludedInstanceType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 30 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\.\\*]+$" - } - }, - "com.amazonaws.ec2#ExcludedInstanceTypeSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ExcludedInstanceType", - "traits": { - "smithy.api#xmlName": "item" - } - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 400 - } - } - }, - "com.amazonaws.ec2#ExecutableByStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#xmlName": "ExecutableBy" - } - } - }, - "com.amazonaws.ec2#Explanation": { - "type": "structure", - "members": { - "Acl": { - "target": "com.amazonaws.ec2#AnalysisComponent", - "traits": { - "aws.protocols#ec2QueryName": "Acl", - "smithy.api#documentation": "

The network ACL.

", - "smithy.api#xmlName": "acl" - } - }, - "AclRule": { - "target": "com.amazonaws.ec2#AnalysisAclRule", - "traits": { - "aws.protocols#ec2QueryName": "AclRule", - "smithy.api#documentation": "

The network ACL rule.

", - "smithy.api#xmlName": "aclRule" - } - }, - "Address": { - "target": "com.amazonaws.ec2#IpAddress", - "traits": { - "aws.protocols#ec2QueryName": "Address", - "smithy.api#documentation": "

The IPv4 address, in CIDR notation.

", - "smithy.api#xmlName": "address" - } - }, - "Addresses": { - "target": "com.amazonaws.ec2#IpAddressList", - "traits": { - "aws.protocols#ec2QueryName": "AddressSet", - "smithy.api#documentation": "

The IPv4 addresses, in CIDR notation.

", - "smithy.api#xmlName": "addressSet" - } - }, - "AttachedTo": { - "target": "com.amazonaws.ec2#AnalysisComponent", - "traits": { - "aws.protocols#ec2QueryName": "AttachedTo", - "smithy.api#documentation": "

The resource to which the component is attached.

", - "smithy.api#xmlName": "attachedTo" - } - }, - "AvailabilityZones": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZoneSet", - "smithy.api#documentation": "

The Availability Zones.

", - "smithy.api#xmlName": "availabilityZoneSet" - } - }, - "Cidrs": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "CidrSet", - "smithy.api#documentation": "

The CIDR ranges.

", - "smithy.api#xmlName": "cidrSet" - } - }, - "Component": { - "target": "com.amazonaws.ec2#AnalysisComponent", - "traits": { - "aws.protocols#ec2QueryName": "Component", - "smithy.api#documentation": "

The component.

", - "smithy.api#xmlName": "component" - } - }, - "CustomerGateway": { - "target": "com.amazonaws.ec2#AnalysisComponent", - "traits": { - "aws.protocols#ec2QueryName": "CustomerGateway", - "smithy.api#documentation": "

The customer gateway.

", - "smithy.api#xmlName": "customerGateway" - } - }, - "Destination": { - "target": "com.amazonaws.ec2#AnalysisComponent", - "traits": { - "aws.protocols#ec2QueryName": "Destination", - "smithy.api#documentation": "

The destination.

", - "smithy.api#xmlName": "destination" - } - }, - "DestinationVpc": { - "target": "com.amazonaws.ec2#AnalysisComponent", - "traits": { - "aws.protocols#ec2QueryName": "DestinationVpc", - "smithy.api#documentation": "

The destination VPC.

", - "smithy.api#xmlName": "destinationVpc" - } - }, - "Direction": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Direction", - "smithy.api#documentation": "

The direction. The following are the possible values:

\n ", - "smithy.api#xmlName": "direction" - } - }, - "ExplanationCode": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ExplanationCode", - "smithy.api#documentation": "

The explanation code.

", - "smithy.api#xmlName": "explanationCode" - } - }, - "IngressRouteTable": { - "target": "com.amazonaws.ec2#AnalysisComponent", - "traits": { - "aws.protocols#ec2QueryName": "IngressRouteTable", - "smithy.api#documentation": "

The route table.

", - "smithy.api#xmlName": "ingressRouteTable" - } - }, - "InternetGateway": { - "target": "com.amazonaws.ec2#AnalysisComponent", - "traits": { - "aws.protocols#ec2QueryName": "InternetGateway", - "smithy.api#documentation": "

The internet gateway.

", - "smithy.api#xmlName": "internetGateway" - } - }, - "LoadBalancerArn": { - "target": "com.amazonaws.ec2#ResourceArn", - "traits": { - "aws.protocols#ec2QueryName": "LoadBalancerArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the load balancer.

", - "smithy.api#xmlName": "loadBalancerArn" - } - }, - "ClassicLoadBalancerListener": { - "target": "com.amazonaws.ec2#AnalysisLoadBalancerListener", - "traits": { - "aws.protocols#ec2QueryName": "ClassicLoadBalancerListener", - "smithy.api#documentation": "

The listener for a Classic Load Balancer.

", - "smithy.api#xmlName": "classicLoadBalancerListener" - } - }, - "LoadBalancerListenerPort": { - "target": "com.amazonaws.ec2#Port", - "traits": { - "aws.protocols#ec2QueryName": "LoadBalancerListenerPort", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The listener port of the load balancer.

", - "smithy.api#xmlName": "loadBalancerListenerPort" - } - }, - "LoadBalancerTarget": { - "target": "com.amazonaws.ec2#AnalysisLoadBalancerTarget", - "traits": { - "aws.protocols#ec2QueryName": "LoadBalancerTarget", - "smithy.api#documentation": "

The target.

", - "smithy.api#xmlName": "loadBalancerTarget" - } - }, - "LoadBalancerTargetGroup": { - "target": "com.amazonaws.ec2#AnalysisComponent", - "traits": { - "aws.protocols#ec2QueryName": "LoadBalancerTargetGroup", - "smithy.api#documentation": "

The target group.

", - "smithy.api#xmlName": "loadBalancerTargetGroup" - } - }, - "LoadBalancerTargetGroups": { - "target": "com.amazonaws.ec2#AnalysisComponentList", - "traits": { - "aws.protocols#ec2QueryName": "LoadBalancerTargetGroupSet", - "smithy.api#documentation": "

The target groups.

", - "smithy.api#xmlName": "loadBalancerTargetGroupSet" - } - }, - "LoadBalancerTargetPort": { - "target": "com.amazonaws.ec2#Port", - "traits": { - "aws.protocols#ec2QueryName": "LoadBalancerTargetPort", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The target port.

", - "smithy.api#xmlName": "loadBalancerTargetPort" - } - }, - "ElasticLoadBalancerListener": { - "target": "com.amazonaws.ec2#AnalysisComponent", - "traits": { - "aws.protocols#ec2QueryName": "ElasticLoadBalancerListener", - "smithy.api#documentation": "

The load balancer listener.

", - "smithy.api#xmlName": "elasticLoadBalancerListener" - } - }, - "MissingComponent": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "MissingComponent", - "smithy.api#documentation": "

The missing component.

", - "smithy.api#xmlName": "missingComponent" - } - }, - "NatGateway": { - "target": "com.amazonaws.ec2#AnalysisComponent", - "traits": { - "aws.protocols#ec2QueryName": "NatGateway", - "smithy.api#documentation": "

The NAT gateway.

", - "smithy.api#xmlName": "natGateway" - } - }, - "NetworkInterface": { - "target": "com.amazonaws.ec2#AnalysisComponent", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterface", - "smithy.api#documentation": "

The network interface.

", - "smithy.api#xmlName": "networkInterface" - } - }, - "PacketField": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PacketField", - "smithy.api#documentation": "

The packet field.

", - "smithy.api#xmlName": "packetField" - } - }, - "VpcPeeringConnection": { - "target": "com.amazonaws.ec2#AnalysisComponent", - "traits": { - "aws.protocols#ec2QueryName": "VpcPeeringConnection", - "smithy.api#documentation": "

The VPC peering connection.

", - "smithy.api#xmlName": "vpcPeeringConnection" - } - }, - "Port": { - "target": "com.amazonaws.ec2#Port", - "traits": { - "aws.protocols#ec2QueryName": "Port", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The port.

", - "smithy.api#xmlName": "port" - } - }, - "PortRanges": { - "target": "com.amazonaws.ec2#PortRangeList", - "traits": { - "aws.protocols#ec2QueryName": "PortRangeSet", - "smithy.api#documentation": "

The port ranges.

", - "smithy.api#xmlName": "portRangeSet" - } - }, - "PrefixList": { - "target": "com.amazonaws.ec2#AnalysisComponent", - "traits": { - "aws.protocols#ec2QueryName": "PrefixList", - "smithy.api#documentation": "

The prefix list.

", - "smithy.api#xmlName": "prefixList" - } - }, - "Protocols": { - "target": "com.amazonaws.ec2#StringList", - "traits": { - "aws.protocols#ec2QueryName": "ProtocolSet", - "smithy.api#documentation": "

The protocols.

", - "smithy.api#xmlName": "protocolSet" - } - }, - "RouteTableRoute": { - "target": "com.amazonaws.ec2#AnalysisRouteTableRoute", - "traits": { - "aws.protocols#ec2QueryName": "RouteTableRoute", - "smithy.api#documentation": "

The route table route.

", - "smithy.api#xmlName": "routeTableRoute" - } - }, - "RouteTable": { - "target": "com.amazonaws.ec2#AnalysisComponent", - "traits": { - "aws.protocols#ec2QueryName": "RouteTable", - "smithy.api#documentation": "

The route table.

", - "smithy.api#xmlName": "routeTable" - } - }, - "SecurityGroup": { - "target": "com.amazonaws.ec2#AnalysisComponent", - "traits": { - "aws.protocols#ec2QueryName": "SecurityGroup", - "smithy.api#documentation": "

The security group.

", - "smithy.api#xmlName": "securityGroup" - } - }, - "SecurityGroupRule": { - "target": "com.amazonaws.ec2#AnalysisSecurityGroupRule", - "traits": { - "aws.protocols#ec2QueryName": "SecurityGroupRule", - "smithy.api#documentation": "

The security group rule.

", - "smithy.api#xmlName": "securityGroupRule" - } - }, - "SecurityGroups": { - "target": "com.amazonaws.ec2#AnalysisComponentList", - "traits": { - "aws.protocols#ec2QueryName": "SecurityGroupSet", - "smithy.api#documentation": "

The security groups.

", - "smithy.api#xmlName": "securityGroupSet" - } - }, - "SourceVpc": { - "target": "com.amazonaws.ec2#AnalysisComponent", - "traits": { - "aws.protocols#ec2QueryName": "SourceVpc", - "smithy.api#documentation": "

The source VPC.

", - "smithy.api#xmlName": "sourceVpc" - } - }, - "State": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state.

", - "smithy.api#xmlName": "state" - } - }, - "Subnet": { - "target": "com.amazonaws.ec2#AnalysisComponent", - "traits": { - "aws.protocols#ec2QueryName": "Subnet", - "smithy.api#documentation": "

The subnet.

", - "smithy.api#xmlName": "subnet" - } - }, - "SubnetRouteTable": { - "target": "com.amazonaws.ec2#AnalysisComponent", - "traits": { - "aws.protocols#ec2QueryName": "SubnetRouteTable", - "smithy.api#documentation": "

The route table for the subnet.

", - "smithy.api#xmlName": "subnetRouteTable" - } - }, - "Vpc": { - "target": "com.amazonaws.ec2#AnalysisComponent", - "traits": { - "aws.protocols#ec2QueryName": "Vpc", - "smithy.api#documentation": "

The component VPC.

", - "smithy.api#xmlName": "vpc" - } - }, - "VpcEndpoint": { - "target": "com.amazonaws.ec2#AnalysisComponent", - "traits": { - "aws.protocols#ec2QueryName": "VpcEndpoint", - "smithy.api#documentation": "

The VPC endpoint.

", - "smithy.api#xmlName": "vpcEndpoint" - } - }, - "VpnConnection": { - "target": "com.amazonaws.ec2#AnalysisComponent", - "traits": { - "aws.protocols#ec2QueryName": "VpnConnection", - "smithy.api#documentation": "

The VPN connection.

", - "smithy.api#xmlName": "vpnConnection" - } - }, - "VpnGateway": { - "target": "com.amazonaws.ec2#AnalysisComponent", - "traits": { - "aws.protocols#ec2QueryName": "VpnGateway", - "smithy.api#documentation": "

The VPN gateway.

", - "smithy.api#xmlName": "vpnGateway" - } - }, - "TransitGateway": { - "target": "com.amazonaws.ec2#AnalysisComponent", - "traits": { - "aws.protocols#ec2QueryName": "TransitGateway", - "smithy.api#documentation": "

The transit gateway.

", - "smithy.api#xmlName": "transitGateway" - } - }, - "TransitGatewayRouteTable": { - "target": "com.amazonaws.ec2#AnalysisComponent", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayRouteTable", - "smithy.api#documentation": "

The transit gateway route table.

", - "smithy.api#xmlName": "transitGatewayRouteTable" - } - }, - "TransitGatewayRouteTableRoute": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableRoute", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayRouteTableRoute", - "smithy.api#documentation": "

The transit gateway route table route.

", - "smithy.api#xmlName": "transitGatewayRouteTableRoute" - } - }, - "TransitGatewayAttachment": { - "target": "com.amazonaws.ec2#AnalysisComponent", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayAttachment", - "smithy.api#documentation": "

The transit gateway attachment.

", - "smithy.api#xmlName": "transitGatewayAttachment" - } - }, - "ComponentAccount": { - "target": "com.amazonaws.ec2#ComponentAccount", - "traits": { - "aws.protocols#ec2QueryName": "ComponentAccount", - "smithy.api#documentation": "

The Amazon Web Services account for the component.

", - "smithy.api#xmlName": "componentAccount" - } - }, - "ComponentRegion": { - "target": "com.amazonaws.ec2#ComponentRegion", - "traits": { - "aws.protocols#ec2QueryName": "ComponentRegion", - "smithy.api#documentation": "

The Region for the component.

", - "smithy.api#xmlName": "componentRegion" - } - }, - "FirewallStatelessRule": { - "target": "com.amazonaws.ec2#FirewallStatelessRule", - "traits": { - "aws.protocols#ec2QueryName": "FirewallStatelessRule", - "smithy.api#documentation": "

The Network Firewall stateless rule.

", - "smithy.api#xmlName": "firewallStatelessRule" - } - }, - "FirewallStatefulRule": { - "target": "com.amazonaws.ec2#FirewallStatefulRule", - "traits": { - "aws.protocols#ec2QueryName": "FirewallStatefulRule", - "smithy.api#documentation": "

The Network Firewall stateful rule.

", - "smithy.api#xmlName": "firewallStatefulRule" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an explanation code for an unreachable path. For more information, see Reachability Analyzer explanation codes.

" - } - }, - "com.amazonaws.ec2#ExplanationList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Explanation", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ExportClientVpnClientCertificateRevocationList": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ExportClientVpnClientCertificateRevocationListRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ExportClientVpnClientCertificateRevocationListResult" - }, - "traits": { - "smithy.api#documentation": "

Downloads the client certificate revocation list for the specified Client VPN endpoint.

" - } - }, - "com.amazonaws.ec2#ExportClientVpnClientCertificateRevocationListRequest": { - "type": "structure", - "members": { - "ClientVpnEndpointId": { - "target": "com.amazonaws.ec2#ClientVpnEndpointId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ExportClientVpnClientCertificateRevocationListResult": { - "type": "structure", - "members": { - "CertificateRevocationList": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CertificateRevocationList", - "smithy.api#documentation": "

Information about the client certificate revocation list.

", - "smithy.api#xmlName": "certificateRevocationList" - } - }, - "Status": { - "target": "com.amazonaws.ec2#ClientCertificateRevocationListStatus", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The current state of the client certificate revocation list.

", - "smithy.api#xmlName": "status" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ExportClientVpnClientConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ExportClientVpnClientConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ExportClientVpnClientConfigurationResult" - }, - "traits": { - "smithy.api#documentation": "

Downloads the contents of the Client VPN endpoint configuration file for the specified Client VPN endpoint. The Client VPN endpoint configuration \n\t\t\tfile includes the Client VPN endpoint and certificate information clients need to establish a connection \n\t\t\twith the Client VPN endpoint.

" - } - }, - "com.amazonaws.ec2#ExportClientVpnClientConfigurationRequest": { - "type": "structure", - "members": { - "ClientVpnEndpointId": { - "target": "com.amazonaws.ec2#ClientVpnEndpointId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ExportClientVpnClientConfigurationResult": { - "type": "structure", - "members": { - "ClientConfiguration": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientConfiguration", - "smithy.api#documentation": "

The contents of the Client VPN endpoint configuration file.

", - "smithy.api#xmlName": "clientConfiguration" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ExportEnvironment": { - "type": "enum", - "members": { - "citrix": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "citrix" - } - }, - "vmware": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "vmware" - } - }, - "microsoft": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "microsoft" - } - } - } - }, - "com.amazonaws.ec2#ExportImage": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ExportImageRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ExportImageResult" - }, - "traits": { - "smithy.api#documentation": "

Exports an Amazon Machine Image (AMI) to a VM file. For more information, see Exporting a VM\n directly from an Amazon Machine Image (AMI) in the\n VM Import/Export User Guide.

" - } - }, - "com.amazonaws.ec2#ExportImageRequest": { - "type": "structure", - "members": { - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Token to enable idempotency for export image requests.

", - "smithy.api#idempotencyToken": {} - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A description of the image being exported. The maximum length is 255 characters.

" - } - }, - "DiskImageFormat": { - "target": "com.amazonaws.ec2#DiskImageFormat", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The disk image format.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "ImageId": { - "target": "com.amazonaws.ec2#ImageId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the image.

", - "smithy.api#required": {} - } - }, - "S3ExportLocation": { - "target": "com.amazonaws.ec2#ExportTaskS3LocationRequest", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Amazon S3 bucket for the destination image. The destination bucket must exist.

", - "smithy.api#required": {} - } - }, - "RoleName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The name of the role that grants VM Import/Export permission to export images to your Amazon\n S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the export image task during creation.

", - "smithy.api#xmlName": "TagSpecification" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ExportImageResult": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description of the image being exported.

", - "smithy.api#xmlName": "description" - } - }, - "DiskImageFormat": { - "target": "com.amazonaws.ec2#DiskImageFormat", - "traits": { - "aws.protocols#ec2QueryName": "DiskImageFormat", - "smithy.api#documentation": "

The disk image format for the exported image.

", - "smithy.api#xmlName": "diskImageFormat" - } - }, - "ExportImageTaskId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ExportImageTaskId", - "smithy.api#documentation": "

The ID of the export image task.

", - "smithy.api#xmlName": "exportImageTaskId" - } - }, - "ImageId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ImageId", - "smithy.api#documentation": "

The ID of the image.

", - "smithy.api#xmlName": "imageId" - } - }, - "RoleName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "RoleName", - "smithy.api#documentation": "

The name of the role that grants VM Import/Export permission to export images to your Amazon\n S3 bucket.

", - "smithy.api#xmlName": "roleName" - } - }, - "Progress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Progress", - "smithy.api#documentation": "

The percent complete of the export image task.

", - "smithy.api#xmlName": "progress" - } - }, - "S3ExportLocation": { - "target": "com.amazonaws.ec2#ExportTaskS3Location", - "traits": { - "aws.protocols#ec2QueryName": "S3ExportLocation", - "smithy.api#documentation": "

Information about the destination Amazon S3 bucket.

", - "smithy.api#xmlName": "s3ExportLocation" - } - }, - "Status": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The status of the export image task. The possible values are active, completed,\n deleting, and deleted.

", - "smithy.api#xmlName": "status" - } - }, - "StatusMessage": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StatusMessage", - "smithy.api#documentation": "

The status message for the export image task.

", - "smithy.api#xmlName": "statusMessage" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the export image task.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ExportImageTask": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description of the image being exported.

", - "smithy.api#xmlName": "description" - } - }, - "ExportImageTaskId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ExportImageTaskId", - "smithy.api#documentation": "

The ID of the export image task.

", - "smithy.api#xmlName": "exportImageTaskId" - } - }, - "ImageId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ImageId", - "smithy.api#documentation": "

The ID of the image.

", - "smithy.api#xmlName": "imageId" - } - }, - "Progress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Progress", - "smithy.api#documentation": "

The percent complete of the export image task.

", - "smithy.api#xmlName": "progress" - } - }, - "S3ExportLocation": { - "target": "com.amazonaws.ec2#ExportTaskS3Location", - "traits": { - "aws.protocols#ec2QueryName": "S3ExportLocation", - "smithy.api#documentation": "

Information about the destination Amazon S3 bucket.

", - "smithy.api#xmlName": "s3ExportLocation" - } - }, - "Status": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The status of the export image task. The possible values are active, completed,\n deleting, and deleted.

", - "smithy.api#xmlName": "status" - } - }, - "StatusMessage": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StatusMessage", - "smithy.api#documentation": "

The status message for the export image task.

", - "smithy.api#xmlName": "statusMessage" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the export image task.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an export image task.

" - } - }, - "com.amazonaws.ec2#ExportImageTaskId": { - "type": "string" - }, - "com.amazonaws.ec2#ExportImageTaskIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ExportImageTaskId", - "traits": { - "smithy.api#xmlName": "ExportImageTaskId" - } - } - }, - "com.amazonaws.ec2#ExportImageTaskList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ExportImageTask", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ExportTask": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description of the resource being exported.

", - "smithy.api#xmlName": "description" - } - }, - "ExportTaskId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ExportTaskId", - "smithy.api#documentation": "

The ID of the export task.

", - "smithy.api#xmlName": "exportTaskId" - } - }, - "ExportToS3Task": { - "target": "com.amazonaws.ec2#ExportToS3Task", - "traits": { - "aws.protocols#ec2QueryName": "ExportToS3", - "smithy.api#documentation": "

Information about the export task.

", - "smithy.api#xmlName": "exportToS3" - } - }, - "InstanceExportDetails": { - "target": "com.amazonaws.ec2#InstanceExportDetails", - "traits": { - "aws.protocols#ec2QueryName": "InstanceExport", - "smithy.api#documentation": "

Information about the instance to export.

", - "smithy.api#xmlName": "instanceExport" - } - }, - "State": { - "target": "com.amazonaws.ec2#ExportTaskState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the export task.

", - "smithy.api#xmlName": "state" - } - }, - "StatusMessage": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StatusMessage", - "smithy.api#documentation": "

The status message related to the export task.

", - "smithy.api#xmlName": "statusMessage" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags for the export task.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an export instance task.

" - } - }, - "com.amazonaws.ec2#ExportTaskId": { - "type": "string" - }, - "com.amazonaws.ec2#ExportTaskIdStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ExportTaskId", - "traits": { - "smithy.api#xmlName": "ExportTaskId" - } - } - }, - "com.amazonaws.ec2#ExportTaskList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ExportTask", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ExportTaskS3Location": { - "type": "structure", - "members": { - "S3Bucket": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "S3Bucket", - "smithy.api#documentation": "

The destination Amazon S3 bucket.

", - "smithy.api#xmlName": "s3Bucket" - } - }, - "S3Prefix": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "S3Prefix", - "smithy.api#documentation": "

The prefix (logical hierarchy) in the bucket.

", - "smithy.api#xmlName": "s3Prefix" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the destination for an export image task.

" - } - }, - "com.amazonaws.ec2#ExportTaskS3LocationRequest": { - "type": "structure", - "members": { - "S3Bucket": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The destination Amazon S3 bucket.

", - "smithy.api#required": {} - } - }, - "S3Prefix": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The prefix (logical hierarchy) in the bucket.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the destination for an export image task.

" - } - }, - "com.amazonaws.ec2#ExportTaskState": { - "type": "enum", - "members": { - "active": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "active" - } - }, - "cancelling": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cancelling" - } - }, - "cancelled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cancelled" - } - }, - "completed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "completed" - } - } - } - }, - "com.amazonaws.ec2#ExportToS3Task": { - "type": "structure", - "members": { - "ContainerFormat": { - "target": "com.amazonaws.ec2#ContainerFormat", - "traits": { - "aws.protocols#ec2QueryName": "ContainerFormat", - "smithy.api#documentation": "

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is\n exported.

", - "smithy.api#xmlName": "containerFormat" - } - }, - "DiskImageFormat": { - "target": "com.amazonaws.ec2#DiskImageFormat", - "traits": { - "aws.protocols#ec2QueryName": "DiskImageFormat", - "smithy.api#documentation": "

The format for the exported image.

", - "smithy.api#xmlName": "diskImageFormat" - } - }, - "S3Bucket": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "S3Bucket", - "smithy.api#documentation": "

The Amazon S3 bucket for the destination image. The destination bucket must exist and have\n an access control list (ACL) attached that specifies the Region-specific canonical account ID for\n the Grantee. For more information about the ACL to your S3 bucket, see Prerequisites in the VM Import/Export User Guide.

", - "smithy.api#xmlName": "s3Bucket" - } - }, - "S3Key": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "S3Key", - "smithy.api#documentation": "

The encryption key for your S3 bucket.

", - "smithy.api#xmlName": "s3Key" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the format and location for the export task.

" - } - }, - "com.amazonaws.ec2#ExportToS3TaskSpecification": { - "type": "structure", - "members": { - "ContainerFormat": { - "target": "com.amazonaws.ec2#ContainerFormat", - "traits": { - "aws.protocols#ec2QueryName": "ContainerFormat", - "smithy.api#documentation": "

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is\n exported.

", - "smithy.api#xmlName": "containerFormat" - } - }, - "DiskImageFormat": { - "target": "com.amazonaws.ec2#DiskImageFormat", - "traits": { - "aws.protocols#ec2QueryName": "DiskImageFormat", - "smithy.api#documentation": "

The format for the exported image.

", - "smithy.api#xmlName": "diskImageFormat" - } - }, - "S3Bucket": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "S3Bucket", - "smithy.api#documentation": "

The Amazon S3 bucket for the destination image. The destination bucket must exist and have\n an access control list (ACL) attached that specifies the Region-specific canonical account ID for\n the Grantee. For more information about the ACL to your S3 bucket, see Prerequisites in the VM Import/Export User Guide.

", - "smithy.api#xmlName": "s3Bucket" - } - }, - "S3Prefix": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "S3Prefix", - "smithy.api#documentation": "

The image is written to a single object in the Amazon S3 bucket at the S3 key s3prefix +\n exportTaskId + '.' + diskImageFormat.

", - "smithy.api#xmlName": "s3Prefix" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an export instance task.

" - } - }, - "com.amazonaws.ec2#ExportTransitGatewayRoutes": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ExportTransitGatewayRoutesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ExportTransitGatewayRoutesResult" - }, - "traits": { - "smithy.api#documentation": "

Exports routes from the specified transit gateway route table to the specified S3 bucket.\n By default, all routes are exported. Alternatively, you can filter by CIDR range.

\n

The routes are saved to the specified bucket in a JSON file. For more information, see\n Export Route Tables\n to Amazon S3 in Transit Gateways.

" - } - }, - "com.amazonaws.ec2#ExportTransitGatewayRoutesRequest": { - "type": "structure", - "members": { - "TransitGatewayRouteTableId": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the route table.

", - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "S3Bucket": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the S3 bucket.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ExportTransitGatewayRoutesResult": { - "type": "structure", - "members": { - "S3Location": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "S3Location", - "smithy.api#documentation": "

The URL of the exported file in Amazon S3. For example, \n s3://bucket_name/VPCTransitGateway/TransitGatewayRouteTables/file_name.

", - "smithy.api#xmlName": "s3Location" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ExportVmTaskId": { - "type": "string" - }, - "com.amazonaws.ec2#FailedCapacityReservationFleetCancellationResult": { - "type": "structure", - "members": { - "CapacityReservationFleetId": { - "target": "com.amazonaws.ec2#CapacityReservationFleetId", - "traits": { - "aws.protocols#ec2QueryName": "CapacityReservationFleetId", - "smithy.api#documentation": "

The ID of the Capacity Reservation Fleet that could not be cancelled.

", - "smithy.api#xmlName": "capacityReservationFleetId" - } - }, - "CancelCapacityReservationFleetError": { - "target": "com.amazonaws.ec2#CancelCapacityReservationFleetError", - "traits": { - "aws.protocols#ec2QueryName": "CancelCapacityReservationFleetError", - "smithy.api#documentation": "

Information about the Capacity Reservation Fleet cancellation error.

", - "smithy.api#xmlName": "cancelCapacityReservationFleetError" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a Capacity Reservation Fleet that could not be cancelled.

" - } - }, - "com.amazonaws.ec2#FailedCapacityReservationFleetCancellationResultSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#FailedCapacityReservationFleetCancellationResult", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#FailedQueuedPurchaseDeletion": { - "type": "structure", - "members": { - "Error": { - "target": "com.amazonaws.ec2#DeleteQueuedReservedInstancesError", - "traits": { - "aws.protocols#ec2QueryName": "Error", - "smithy.api#documentation": "

The error.

", - "smithy.api#xmlName": "error" - } - }, - "ReservedInstancesId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ReservedInstancesId", - "smithy.api#documentation": "

The ID of the Reserved Instance.

", - "smithy.api#xmlName": "reservedInstancesId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a Reserved Instance whose queued purchase was not deleted.

" - } - }, - "com.amazonaws.ec2#FailedQueuedPurchaseDeletionSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#FailedQueuedPurchaseDeletion", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#FastLaunchImageIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ImageId", - "traits": { - "smithy.api#xmlName": "ImageId" - } - } - }, - "com.amazonaws.ec2#FastLaunchLaunchTemplateSpecificationRequest": { - "type": "structure", - "members": { - "LaunchTemplateId": { - "target": "com.amazonaws.ec2#LaunchTemplateId", - "traits": { - "smithy.api#documentation": "

The ID of the launch template to use for faster launching for a Windows AMI.

" - } - }, - "LaunchTemplateName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The name of the launch template to use for faster launching for a Windows AMI.

" - } - }, - "Version": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The version of the launch template to use for faster launching for a Windows AMI.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Request to create a launch template for a fast-launch enabled Windows AMI.

\n \n

Note - You can specify either the LaunchTemplateName or the \n\t\t\t\tLaunchTemplateId, but not both.

\n " - } - }, - "com.amazonaws.ec2#FastLaunchLaunchTemplateSpecificationResponse": { - "type": "structure", - "members": { - "LaunchTemplateId": { - "target": "com.amazonaws.ec2#LaunchTemplateId", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateId", - "smithy.api#documentation": "

The ID of the launch template for faster launching of the associated Windows AMI.

", - "smithy.api#xmlName": "launchTemplateId" - } - }, - "LaunchTemplateName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateName", - "smithy.api#documentation": "

The name of the launch template for faster launching of the associated Windows AMI.

", - "smithy.api#xmlName": "launchTemplateName" - } - }, - "Version": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Version", - "smithy.api#documentation": "

The version of the launch template for faster launching of the associated Windows AMI.

", - "smithy.api#xmlName": "version" - } - } - }, - "traits": { - "smithy.api#documentation": "

Identifies the launch template to use for faster launching of the Windows AMI.

" - } - }, - "com.amazonaws.ec2#FastLaunchResourceType": { - "type": "enum", - "members": { - "SNAPSHOT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "snapshot" - } - } - } - }, - "com.amazonaws.ec2#FastLaunchSnapshotConfigurationRequest": { - "type": "structure", - "members": { - "TargetResourceCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Configuration settings for creating and managing pre-provisioned snapshots for a fast-launch enabled Windows AMI.

" - } - }, - "com.amazonaws.ec2#FastLaunchSnapshotConfigurationResponse": { - "type": "structure", - "members": { - "TargetResourceCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "TargetResourceCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of pre-provisioned snapshots requested to keep on hand for a fast-launch enabled Windows AMI.

", - "smithy.api#xmlName": "targetResourceCount" - } - } - }, - "traits": { - "smithy.api#documentation": "

Configuration settings for creating and managing pre-provisioned snapshots for a fast-launch enabled Windows AMI.

" - } - }, - "com.amazonaws.ec2#FastLaunchStateCode": { - "type": "enum", - "members": { - "enabling": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enabling" - } - }, - "enabling_failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enabling-failed" - } - }, - "enabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enabled" - } - }, - "enabled_failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enabled-failed" - } - }, - "disabling": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disabling" - } - }, - "disabling_failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disabling-failed" - } - } - } - }, - "com.amazonaws.ec2#FastSnapshotRestoreStateCode": { - "type": "enum", - "members": { - "enabling": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enabling" - } - }, - "optimizing": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "optimizing" - } - }, - "enabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enabled" - } - }, - "disabling": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disabling" - } - }, - "disabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disabled" - } - } - } - }, - "com.amazonaws.ec2#FederatedAuthentication": { - "type": "structure", - "members": { - "SamlProviderArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SamlProviderArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM SAML identity provider.

", - "smithy.api#xmlName": "samlProviderArn" - } - }, - "SelfServiceSamlProviderArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SelfServiceSamlProviderArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM SAML identity provider for the self-service portal.

", - "smithy.api#xmlName": "selfServiceSamlProviderArn" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the IAM SAML identity providers used for federated authentication.

" - } - }, - "com.amazonaws.ec2#FederatedAuthenticationRequest": { - "type": "structure", - "members": { - "SAMLProviderArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM SAML identity provider.

" - } - }, - "SelfServiceSAMLProviderArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM SAML identity provider for the self-service portal.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The IAM SAML identity provider used for federated authentication.

" - } - }, - "com.amazonaws.ec2#Filter": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The name of the filter. Filter names are case-sensitive.

" - } - }, - "Values": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#documentation": "

The filter values. Filter values are case-sensitive. If you specify multiple values for a \n filter, the values are joined with an OR, and the request returns all results \n that match any of the specified values.

", - "smithy.api#xmlName": "Value" - } - } - }, - "traits": { - "smithy.api#documentation": "

A filter name and value pair that is used to return a more specific list of results from a describe operation. \n Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

\n

If you specify multiple filters, the filters are joined with an AND, and the request returns only \n results that match all of the specified filters.

" - } - }, - "com.amazonaws.ec2#FilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Filter", - "traits": { - "smithy.api#xmlName": "Filter" - } - } - }, - "com.amazonaws.ec2#FilterPortRange": { - "type": "structure", - "members": { - "FromPort": { - "target": "com.amazonaws.ec2#Port", - "traits": { - "aws.protocols#ec2QueryName": "FromPort", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The first port in the range.

", - "smithy.api#xmlName": "fromPort" - } - }, - "ToPort": { - "target": "com.amazonaws.ec2#Port", - "traits": { - "aws.protocols#ec2QueryName": "ToPort", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The last port in the range.

", - "smithy.api#xmlName": "toPort" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a port range.

" - } - }, - "com.amazonaws.ec2#FindingsFound": { - "type": "enum", - "members": { - "true": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "true" - } - }, - "false": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "false" - } - }, - "unknown": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unknown" - } - } - } - }, - "com.amazonaws.ec2#FirewallStatefulRule": { - "type": "structure", - "members": { - "RuleGroupArn": { - "target": "com.amazonaws.ec2#ResourceArn", - "traits": { - "aws.protocols#ec2QueryName": "RuleGroupArn", - "smithy.api#documentation": "

The ARN of the stateful rule group.

", - "smithy.api#xmlName": "ruleGroupArn" - } - }, - "Sources": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "SourceSet", - "smithy.api#documentation": "

The source IP addresses, in CIDR notation.

", - "smithy.api#xmlName": "sourceSet" - } - }, - "Destinations": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "DestinationSet", - "smithy.api#documentation": "

The destination IP addresses, in CIDR notation.

", - "smithy.api#xmlName": "destinationSet" - } - }, - "SourcePorts": { - "target": "com.amazonaws.ec2#PortRangeList", - "traits": { - "aws.protocols#ec2QueryName": "SourcePortSet", - "smithy.api#documentation": "

The source ports.

", - "smithy.api#xmlName": "sourcePortSet" - } - }, - "DestinationPorts": { - "target": "com.amazonaws.ec2#PortRangeList", - "traits": { - "aws.protocols#ec2QueryName": "DestinationPortSet", - "smithy.api#documentation": "

The destination ports.

", - "smithy.api#xmlName": "destinationPortSet" - } - }, - "Protocol": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Protocol", - "smithy.api#documentation": "

The protocol.

", - "smithy.api#xmlName": "protocol" - } - }, - "RuleAction": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "RuleAction", - "smithy.api#documentation": "

The rule action. The possible values are pass, drop, and \n alert.

", - "smithy.api#xmlName": "ruleAction" - } - }, - "Direction": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Direction", - "smithy.api#documentation": "

The direction. The possible values are FORWARD and ANY.

", - "smithy.api#xmlName": "direction" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a stateful rule.

" - } - }, - "com.amazonaws.ec2#FirewallStatelessRule": { - "type": "structure", - "members": { - "RuleGroupArn": { - "target": "com.amazonaws.ec2#ResourceArn", - "traits": { - "aws.protocols#ec2QueryName": "RuleGroupArn", - "smithy.api#documentation": "

The ARN of the stateless rule group.

", - "smithy.api#xmlName": "ruleGroupArn" - } - }, - "Sources": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "SourceSet", - "smithy.api#documentation": "

The source IP addresses, in CIDR notation.

", - "smithy.api#xmlName": "sourceSet" - } - }, - "Destinations": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "DestinationSet", - "smithy.api#documentation": "

The destination IP addresses, in CIDR notation.

", - "smithy.api#xmlName": "destinationSet" - } - }, - "SourcePorts": { - "target": "com.amazonaws.ec2#PortRangeList", - "traits": { - "aws.protocols#ec2QueryName": "SourcePortSet", - "smithy.api#documentation": "

The source ports.

", - "smithy.api#xmlName": "sourcePortSet" - } - }, - "DestinationPorts": { - "target": "com.amazonaws.ec2#PortRangeList", - "traits": { - "aws.protocols#ec2QueryName": "DestinationPortSet", - "smithy.api#documentation": "

The destination ports.

", - "smithy.api#xmlName": "destinationPortSet" - } - }, - "Protocols": { - "target": "com.amazonaws.ec2#ProtocolIntList", - "traits": { - "aws.protocols#ec2QueryName": "ProtocolSet", - "smithy.api#documentation": "

The protocols.

", - "smithy.api#xmlName": "protocolSet" - } - }, - "RuleAction": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "RuleAction", - "smithy.api#documentation": "

The rule action. The possible values are pass, drop, and \n forward_to_site.

", - "smithy.api#xmlName": "ruleAction" - } - }, - "Priority": { - "target": "com.amazonaws.ec2#Priority", - "traits": { - "aws.protocols#ec2QueryName": "Priority", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The rule priority.

", - "smithy.api#xmlName": "priority" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a stateless rule.

" - } - }, - "com.amazonaws.ec2#FleetActivityStatus": { - "type": "enum", - "members": { - "ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "error" - } - }, - "PENDING_FULFILLMENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending_fulfillment" - } - }, - "PENDING_TERMINATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending_termination" - } - }, - "FULFILLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "fulfilled" - } - } - } - }, - "com.amazonaws.ec2#FleetCapacityReservation": { - "type": "structure", - "members": { - "CapacityReservationId": { - "target": "com.amazonaws.ec2#CapacityReservationId", - "traits": { - "aws.protocols#ec2QueryName": "CapacityReservationId", - "smithy.api#documentation": "

The ID of the Capacity Reservation.

", - "smithy.api#xmlName": "capacityReservationId" - } - }, - "AvailabilityZoneId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZoneId", - "smithy.api#documentation": "

The ID of the Availability Zone in which the Capacity Reservation reserves capacity.

", - "smithy.api#xmlName": "availabilityZoneId" - } - }, - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type for which the Capacity Reservation reserves capacity.

", - "smithy.api#xmlName": "instanceType" - } - }, - "InstancePlatform": { - "target": "com.amazonaws.ec2#CapacityReservationInstancePlatform", - "traits": { - "aws.protocols#ec2QueryName": "InstancePlatform", - "smithy.api#documentation": "

The type of operating system for which the Capacity Reservation reserves capacity.

", - "smithy.api#xmlName": "instancePlatform" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone in which the Capacity Reservation reserves capacity.

", - "smithy.api#xmlName": "availabilityZone" - } - }, - "TotalInstanceCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "TotalInstanceCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The total number of instances for which the Capacity Reservation reserves capacity.

", - "smithy.api#xmlName": "totalInstanceCount" - } - }, - "FulfilledCapacity": { - "target": "com.amazonaws.ec2#Double", - "traits": { - "aws.protocols#ec2QueryName": "FulfilledCapacity", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of capacity units fulfilled by the Capacity Reservation. For more information, see \n\t\t\t\n\t\t\t\tTotal target capacity in the Amazon EC2 User Guide.

", - "smithy.api#xmlName": "fulfilledCapacity" - } - }, - "EbsOptimized": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "EbsOptimized", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the Capacity Reservation reserves capacity for EBS-optimized instance types.

", - "smithy.api#xmlName": "ebsOptimized" - } - }, - "CreateDate": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "CreateDate", - "smithy.api#documentation": "

The date and time at which the Capacity Reservation was created.

", - "smithy.api#xmlName": "createDate" - } - }, - "Weight": { - "target": "com.amazonaws.ec2#DoubleWithConstraints", - "traits": { - "aws.protocols#ec2QueryName": "Weight", - "smithy.api#documentation": "

The weight of the instance type in the Capacity Reservation Fleet. For more information, \n\t\t\tsee \n\t\t\t\tInstance type weight in the Amazon EC2 User Guide.

", - "smithy.api#xmlName": "weight" - } - }, - "Priority": { - "target": "com.amazonaws.ec2#IntegerWithConstraints", - "traits": { - "aws.protocols#ec2QueryName": "Priority", - "smithy.api#documentation": "

The priority of the instance type in the Capacity Reservation Fleet. For more information, \n\t\t\tsee \n\t\t\t\tInstance type priority in the Amazon EC2 User Guide.

", - "smithy.api#xmlName": "priority" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a Capacity Reservation in a Capacity Reservation Fleet.

" - } - }, - "com.amazonaws.ec2#FleetCapacityReservationSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#FleetCapacityReservation", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#FleetCapacityReservationTenancy": { - "type": "enum", - "members": { - "default": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "default" - } - } - } - }, - "com.amazonaws.ec2#FleetCapacityReservationUsageStrategy": { - "type": "enum", - "members": { - "USE_CAPACITY_RESERVATIONS_FIRST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "use-capacity-reservations-first" - } - } - } - }, - "com.amazonaws.ec2#FleetData": { - "type": "structure", - "members": { - "ActivityStatus": { - "target": "com.amazonaws.ec2#FleetActivityStatus", - "traits": { - "aws.protocols#ec2QueryName": "ActivityStatus", - "smithy.api#documentation": "

The progress of the EC2 Fleet. If there is an error, the status is error. After\n all requests are placed, the status is pending_fulfillment. If the size of the\n EC2 Fleet is equal to or greater than its target capacity, the status is fulfilled.\n If the size of the EC2 Fleet is decreased, the status is pending_termination while\n instances are terminating.

", - "smithy.api#xmlName": "activityStatus" - } - }, - "CreateTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "CreateTime", - "smithy.api#documentation": "

The creation date and time of the EC2 Fleet.

", - "smithy.api#xmlName": "createTime" - } - }, - "FleetId": { - "target": "com.amazonaws.ec2#FleetId", - "traits": { - "aws.protocols#ec2QueryName": "FleetId", - "smithy.api#documentation": "

The ID of the EC2 Fleet.

", - "smithy.api#xmlName": "fleetId" - } - }, - "FleetState": { - "target": "com.amazonaws.ec2#FleetStateCode", - "traits": { - "aws.protocols#ec2QueryName": "FleetState", - "smithy.api#documentation": "

The state of the EC2 Fleet.

", - "smithy.api#xmlName": "fleetState" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.

\n

Constraints: Maximum 64 ASCII characters

", - "smithy.api#xmlName": "clientToken" - } - }, - "ExcessCapacityTerminationPolicy": { - "target": "com.amazonaws.ec2#FleetExcessCapacityTerminationPolicy", - "traits": { - "aws.protocols#ec2QueryName": "ExcessCapacityTerminationPolicy", - "smithy.api#documentation": "

Indicates whether running instances should be terminated if the target capacity of the\n EC2 Fleet is decreased below the current size of the EC2 Fleet.

\n

Supported only for fleets of type maintain.

", - "smithy.api#xmlName": "excessCapacityTerminationPolicy" - } - }, - "FulfilledCapacity": { - "target": "com.amazonaws.ec2#Double", - "traits": { - "aws.protocols#ec2QueryName": "FulfilledCapacity", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of units fulfilled by this request compared to the set target\n capacity.

", - "smithy.api#xmlName": "fulfilledCapacity" - } - }, - "FulfilledOnDemandCapacity": { - "target": "com.amazonaws.ec2#Double", - "traits": { - "aws.protocols#ec2QueryName": "FulfilledOnDemandCapacity", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of units fulfilled by this request compared to the set target On-Demand\n capacity.

", - "smithy.api#xmlName": "fulfilledOnDemandCapacity" - } - }, - "LaunchTemplateConfigs": { - "target": "com.amazonaws.ec2#FleetLaunchTemplateConfigList", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateConfigs", - "smithy.api#documentation": "

The launch template and overrides.

", - "smithy.api#xmlName": "launchTemplateConfigs" - } - }, - "TargetCapacitySpecification": { - "target": "com.amazonaws.ec2#TargetCapacitySpecification", - "traits": { - "aws.protocols#ec2QueryName": "TargetCapacitySpecification", - "smithy.api#documentation": "

The number of units to request. You can choose to set the target capacity in terms of\n instances or a performance characteristic that is important to your application workload,\n such as vCPUs, memory, or I/O. If the request type is maintain, you can\n specify a target capacity of 0 and add capacity later.

", - "smithy.api#xmlName": "targetCapacitySpecification" - } - }, - "TerminateInstancesWithExpiration": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "TerminateInstancesWithExpiration", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether running instances should be terminated when the EC2 Fleet expires.

", - "smithy.api#xmlName": "terminateInstancesWithExpiration" - } - }, - "Type": { - "target": "com.amazonaws.ec2#FleetType", - "traits": { - "aws.protocols#ec2QueryName": "Type", - "smithy.api#documentation": "

The type of request. Indicates whether the EC2 Fleet only requests the target\n capacity, or also attempts to maintain it. If you request a certain target\n capacity, EC2 Fleet only places the required requests; it does not attempt to replenish\n instances if capacity is diminished, and it does not submit requests in alternative\n capacity pools if capacity is unavailable. To maintain a certain target capacity, EC2 Fleet\n places the required requests to meet this target capacity. It also automatically\n replenishes any interrupted Spot Instances. Default: maintain.

", - "smithy.api#xmlName": "type" - } - }, - "ValidFrom": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "ValidFrom", - "smithy.api#documentation": "

The start date and time of the request, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).\n The default is to start fulfilling the request immediately.

", - "smithy.api#xmlName": "validFrom" - } - }, - "ValidUntil": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "ValidUntil", - "smithy.api#documentation": "

The end date and time of the request, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).\n At this point, no new instance requests are placed or able to fulfill the request. The\n default end date is 7 days from the current date.

", - "smithy.api#xmlName": "validUntil" - } - }, - "ReplaceUnhealthyInstances": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "ReplaceUnhealthyInstances", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for\n fleets of type maintain. For more information, see EC2 Fleet\n health checks in the Amazon EC2 User Guide.

", - "smithy.api#xmlName": "replaceUnhealthyInstances" - } - }, - "SpotOptions": { - "target": "com.amazonaws.ec2#SpotOptions", - "traits": { - "aws.protocols#ec2QueryName": "SpotOptions", - "smithy.api#documentation": "

The configuration of Spot Instances in an EC2 Fleet.

", - "smithy.api#xmlName": "spotOptions" - } - }, - "OnDemandOptions": { - "target": "com.amazonaws.ec2#OnDemandOptions", - "traits": { - "aws.protocols#ec2QueryName": "OnDemandOptions", - "smithy.api#documentation": "

The allocation strategy of On-Demand Instances in an EC2 Fleet.

", - "smithy.api#xmlName": "onDemandOptions" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags for an EC2 Fleet resource.

", - "smithy.api#xmlName": "tagSet" - } - }, - "Errors": { - "target": "com.amazonaws.ec2#DescribeFleetsErrorSet", - "traits": { - "aws.protocols#ec2QueryName": "ErrorSet", - "smithy.api#documentation": "

Information about the instances that could not be launched by the fleet. Valid only when\n Type is set to instant.

", - "smithy.api#xmlName": "errorSet" - } - }, - "Instances": { - "target": "com.amazonaws.ec2#DescribeFleetsInstancesSet", - "traits": { - "aws.protocols#ec2QueryName": "FleetInstanceSet", - "smithy.api#documentation": "

Information about the instances that were launched by the fleet. Valid only when\n Type is set to instant.

", - "smithy.api#xmlName": "fleetInstanceSet" - } - }, - "Context": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Context", - "smithy.api#documentation": "

Reserved.

", - "smithy.api#xmlName": "context" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an EC2 Fleet.

" - } - }, - "com.amazonaws.ec2#FleetEventType": { - "type": "enum", - "members": { - "INSTANCE_CHANGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "instance-change" - } - }, - "FLEET_CHANGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "fleet-change" - } - }, - "SERVICE_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "service-error" - } - } - } - }, - "com.amazonaws.ec2#FleetExcessCapacityTerminationPolicy": { - "type": "enum", - "members": { - "NO_TERMINATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "no-termination" - } - }, - "TERMINATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "termination" - } - } - } - }, - "com.amazonaws.ec2#FleetId": { - "type": "string" - }, - "com.amazonaws.ec2#FleetIdSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#FleetId" - } - }, - "com.amazonaws.ec2#FleetInstanceMatchCriteria": { - "type": "enum", - "members": { - "open": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "open" - } - } - } - }, - "com.amazonaws.ec2#FleetLaunchTemplateConfig": { - "type": "structure", - "members": { - "LaunchTemplateSpecification": { - "target": "com.amazonaws.ec2#FleetLaunchTemplateSpecification", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateSpecification", - "smithy.api#documentation": "

The launch template.

", - "smithy.api#xmlName": "launchTemplateSpecification" - } - }, - "Overrides": { - "target": "com.amazonaws.ec2#FleetLaunchTemplateOverridesList", - "traits": { - "aws.protocols#ec2QueryName": "Overrides", - "smithy.api#documentation": "

Any parameters that you specify override the same parameters in the launch\n template.

", - "smithy.api#xmlName": "overrides" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a launch template and overrides.

" - } - }, - "com.amazonaws.ec2#FleetLaunchTemplateConfigList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#FleetLaunchTemplateConfig", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#FleetLaunchTemplateConfigListRequest": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#FleetLaunchTemplateConfigRequest", - "traits": { - "smithy.api#xmlName": "item" - } - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.ec2#FleetLaunchTemplateConfigRequest": { - "type": "structure", - "members": { - "LaunchTemplateSpecification": { - "target": "com.amazonaws.ec2#FleetLaunchTemplateSpecificationRequest", - "traits": { - "smithy.api#documentation": "

The launch template to use. You must specify either the launch template ID or launch\n template name in the request.

" - } - }, - "Overrides": { - "target": "com.amazonaws.ec2#FleetLaunchTemplateOverridesListRequest", - "traits": { - "smithy.api#documentation": "

Any parameters that you specify override the same parameters in the launch\n template.

\n

For fleets of type request and maintain, a maximum of 300\n items is allowed across all launch templates.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a launch template and overrides.

" - } - }, - "com.amazonaws.ec2#FleetLaunchTemplateOverrides": { - "type": "structure", - "members": { - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type.

\n

\n mac1.metal is not supported as a launch template override.

\n \n

If you specify InstanceType, you can't specify\n InstanceRequirements.

\n ", - "smithy.api#xmlName": "instanceType" - } - }, - "MaxPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "MaxPrice", - "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.\n

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n ", - "smithy.api#xmlName": "maxPrice" - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#documentation": "

The ID of the subnet in which to launch the instances.

", - "smithy.api#xmlName": "subnetId" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone in which to launch the instances.

", - "smithy.api#xmlName": "availabilityZone" - } - }, - "WeightedCapacity": { - "target": "com.amazonaws.ec2#Double", - "traits": { - "aws.protocols#ec2QueryName": "WeightedCapacity", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of units provided by the specified instance type.

", - "smithy.api#xmlName": "weightedCapacity" - } - }, - "Priority": { - "target": "com.amazonaws.ec2#Double", - "traits": { - "aws.protocols#ec2QueryName": "Priority", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The priority for the launch template override. The highest priority is launched\n first.

\n

If the On-Demand AllocationStrategy is set to prioritized,\n EC2 Fleet uses priority to determine which launch template override to use first in fulfilling\n On-Demand capacity.

\n

If the Spot AllocationStrategy is set to\n capacity-optimized-prioritized, EC2 Fleet uses priority on a best-effort basis\n to determine which launch template override to use in fulfilling Spot capacity, but\n optimizes for capacity first.

\n

Valid values are whole numbers starting at 0. The lower the number, the\n higher the priority. If no number is set, the override has the lowest priority. You can set\n the same priority for different launch template overrides.

", - "smithy.api#xmlName": "priority" - } - }, - "Placement": { - "target": "com.amazonaws.ec2#PlacementResponse", - "traits": { - "aws.protocols#ec2QueryName": "Placement", - "smithy.api#documentation": "

The location where the instance launched, if applicable.

", - "smithy.api#xmlName": "placement" - } - }, - "InstanceRequirements": { - "target": "com.amazonaws.ec2#InstanceRequirements", - "traits": { - "aws.protocols#ec2QueryName": "InstanceRequirements", - "smithy.api#documentation": "

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with those attributes.

\n \n

If you specify InstanceRequirements, you can't specify\n InstanceType.

\n ", - "smithy.api#xmlName": "instanceRequirements" - } - }, - "ImageId": { - "target": "com.amazonaws.ec2#ImageId", - "traits": { - "aws.protocols#ec2QueryName": "ImageId", - "smithy.api#documentation": "

The ID of the AMI. An AMI is required to launch an instance. The AMI ID must be specified here or in the launch template.

", - "smithy.api#xmlName": "imageId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes overrides for a launch template.

" - } - }, - "com.amazonaws.ec2#FleetLaunchTemplateOverridesList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#FleetLaunchTemplateOverrides", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#FleetLaunchTemplateOverridesListRequest": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#FleetLaunchTemplateOverridesRequest", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#FleetLaunchTemplateOverridesRequest": { - "type": "structure", - "members": { - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", - "traits": { - "smithy.api#documentation": "

The instance type.

\n

\n mac1.metal is not supported as a launch template override.

\n \n

If you specify InstanceType, you can't specify\n InstanceRequirements.

\n " - } - }, - "MaxPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.\n

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n " - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#SubnetId", - "traits": { - "smithy.api#documentation": "

The IDs of the subnets in which to launch the instances. Separate multiple subnet IDs using commas (for example, subnet-1234abcdeexample1, subnet-0987cdef6example2). A request of type instant can have only one subnet ID.

" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The Availability Zone in which to launch the instances.

" - } - }, - "WeightedCapacity": { - "target": "com.amazonaws.ec2#Double", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of units provided by the specified instance type.

" - } - }, - "Priority": { - "target": "com.amazonaws.ec2#Double", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The priority for the launch template override. The highest priority is launched\n first.

\n

If the On-Demand AllocationStrategy is set to prioritized,\n EC2 Fleet uses priority to determine which launch template override to use first in fulfilling\n On-Demand capacity.

\n

If the Spot AllocationStrategy is set to\n capacity-optimized-prioritized, EC2 Fleet uses priority on a best-effort basis\n to determine which launch template override to use in fulfilling Spot capacity, but\n optimizes for capacity first.

\n

Valid values are whole numbers starting at 0. The lower the number, the\n higher the priority. If no number is set, the launch template override has the lowest\n priority. You can set the same priority for different launch template overrides.

" - } - }, - "Placement": { - "target": "com.amazonaws.ec2#Placement", - "traits": { - "smithy.api#documentation": "

The location where the instance launched, if applicable.

" - } - }, - "InstanceRequirements": { - "target": "com.amazonaws.ec2#InstanceRequirementsRequest", - "traits": { - "smithy.api#documentation": "

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with those attributes.

\n \n

If you specify InstanceRequirements, you can't specify\n InstanceType.

\n " - } - }, - "ImageId": { - "target": "com.amazonaws.ec2#ImageId", - "traits": { - "smithy.api#documentation": "

The ID of the AMI. An AMI is required to launch an instance. The AMI ID must be specified here or in the launch template.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes overrides for a launch template.

" - } - }, - "com.amazonaws.ec2#FleetLaunchTemplateSpecification": { - "type": "structure", - "members": { - "LaunchTemplateId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateId", - "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify the LaunchTemplateId or the LaunchTemplateName, but not both.

", - "smithy.api#xmlName": "launchTemplateId" - } - }, - "LaunchTemplateName": { - "target": "com.amazonaws.ec2#LaunchTemplateName", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateName", - "smithy.api#documentation": "

The name of the launch template.

\n

You must specify the LaunchTemplateName or the LaunchTemplateId, but not both.

", - "smithy.api#xmlName": "launchTemplateName" - } - }, - "Version": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Version", - "smithy.api#documentation": "

The launch template version number, $Latest, or $Default.\n You must specify a value, otherwise the request fails.

\n

If the value is $Latest, Amazon EC2 uses the latest version of the launch\n template.

\n

If the value is $Default, Amazon EC2 uses the default version of the launch\n template.

", - "smithy.api#xmlName": "version" - } - } - }, - "traits": { - "smithy.api#documentation": "

The Amazon EC2 launch template that can be used by\n a Spot Fleet to configure Amazon EC2 instances. You must specify either the ID or name of the launch template in the request, but not both.

\n

For information about launch templates,\n see Launch an instance from a launch template in the\n Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#FleetLaunchTemplateSpecificationRequest": { - "type": "structure", - "members": { - "LaunchTemplateId": { - "target": "com.amazonaws.ec2#LaunchTemplateId", - "traits": { - "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify the LaunchTemplateId or the LaunchTemplateName, but not both.

" - } - }, - "LaunchTemplateName": { - "target": "com.amazonaws.ec2#LaunchTemplateName", - "traits": { - "smithy.api#documentation": "

The name of the launch template.

\n

You must specify the LaunchTemplateName or the LaunchTemplateId, but not both.

" - } - }, - "Version": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The launch template version number, $Latest, or $Default. You must specify a value, otherwise the request fails.

\n

If the value is $Latest, Amazon EC2 uses the latest version of the launch template.

\n

If the value is $Default, Amazon EC2 uses the default version of the launch template.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The Amazon EC2 launch template that can be used by\n an EC2 Fleet to configure Amazon EC2 instances. You must specify either the ID or name of the launch template in the request, but not both.

\n

For information about launch templates, see Launch\n an instance from a launch template in the\n Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#FleetOnDemandAllocationStrategy": { - "type": "enum", - "members": { - "LOWEST_PRICE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "lowest-price" - } - }, - "PRIORITIZED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "prioritized" - } - } - } - }, - "com.amazonaws.ec2#FleetReplacementStrategy": { - "type": "enum", - "members": { - "LAUNCH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "launch" - } - }, - "LAUNCH_BEFORE_TERMINATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "launch-before-terminate" - } - } - } - }, - "com.amazonaws.ec2#FleetSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#FleetData", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#FleetSpotCapacityRebalance": { - "type": "structure", - "members": { - "ReplacementStrategy": { - "target": "com.amazonaws.ec2#FleetReplacementStrategy", - "traits": { - "aws.protocols#ec2QueryName": "ReplacementStrategy", - "smithy.api#documentation": "

The replacement strategy to use. Only available for fleets of type\n maintain.

\n

\n launch - EC2 Fleet launches a new replacement Spot Instance when a\n rebalance notification is emitted for an existing Spot Instance in the fleet. EC2 Fleet\n does not terminate the instances that receive a rebalance notification. You can terminate\n the old instances, or you can leave them running. You are charged for all instances while\n they are running.

\n

\n launch-before-terminate - EC2 Fleet launches a new replacement Spot\n Instance when a rebalance notification is emitted for an existing Spot Instance in the\n fleet, and then, after a delay that you specify (in TerminationDelay),\n terminates the instances that received a rebalance notification.

", - "smithy.api#xmlName": "replacementStrategy" - } - }, - "TerminationDelay": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "TerminationDelay", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot\n Instance after launching a new replacement Spot Instance.

\n

Required when ReplacementStrategy is set to launch-before-terminate.

\n

Not valid when ReplacementStrategy is set to launch.

\n

Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.

", - "smithy.api#xmlName": "terminationDelay" - } - } - }, - "traits": { - "smithy.api#documentation": "

The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an\n elevated risk of being interrupted.

" - } - }, - "com.amazonaws.ec2#FleetSpotCapacityRebalanceRequest": { - "type": "structure", - "members": { - "ReplacementStrategy": { - "target": "com.amazonaws.ec2#FleetReplacementStrategy", - "traits": { - "smithy.api#documentation": "

The replacement strategy to use. Only available for fleets of type\n maintain.

\n

\n launch - EC2 Fleet launches a replacement Spot Instance when a rebalance\n notification is emitted for an existing Spot Instance in the fleet. EC2 Fleet does not\n terminate the instances that receive a rebalance notification. You can terminate the old\n instances, or you can leave them running. You are charged for all instances while they are\n running.

\n

\n launch-before-terminate - EC2 Fleet launches a replacement Spot Instance\n when a rebalance notification is emitted for an existing Spot Instance in the fleet, and\n then, after a delay that you specify (in TerminationDelay), terminates the\n instances that received a rebalance notification.

" - } - }, - "TerminationDelay": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot\n Instance after launching a new replacement Spot Instance.

\n

Required when ReplacementStrategy is set to launch-before-terminate.

\n

Not valid when ReplacementStrategy is set to launch.

\n

Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The Spot Instance replacement strategy to use when Amazon EC2 emits a rebalance\n notification signal that your Spot Instance is at an elevated risk of being interrupted.\n For more information, see Capacity rebalancing in the Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#FleetSpotMaintenanceStrategies": { - "type": "structure", - "members": { - "CapacityRebalance": { - "target": "com.amazonaws.ec2#FleetSpotCapacityRebalance", - "traits": { - "aws.protocols#ec2QueryName": "CapacityRebalance", - "smithy.api#documentation": "

The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an\n elevated risk of being interrupted.

", - "smithy.api#xmlName": "capacityRebalance" - } - } - }, - "traits": { - "smithy.api#documentation": "

The strategies for managing your Spot Instances that are at an elevated risk of being\n interrupted.

" - } - }, - "com.amazonaws.ec2#FleetSpotMaintenanceStrategiesRequest": { - "type": "structure", - "members": { - "CapacityRebalance": { - "target": "com.amazonaws.ec2#FleetSpotCapacityRebalanceRequest", - "traits": { - "smithy.api#documentation": "

The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an\n elevated risk of being interrupted.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.

" - } - }, - "com.amazonaws.ec2#FleetStateCode": { - "type": "enum", - "members": { - "SUBMITTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "submitted" - } - }, - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "active" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleted" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failed" - } - }, - "DELETED_RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleted_running" - } - }, - "DELETED_TERMINATING_INSTANCES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleted_terminating" - } - }, - "MODIFYING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "modifying" - } - } - } - }, - "com.amazonaws.ec2#FleetType": { - "type": "enum", - "members": { - "REQUEST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "request" - } - }, - "MAINTAIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "maintain" - } - }, - "INSTANT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "instant" - } - } - } - }, - "com.amazonaws.ec2#Float": { - "type": "float", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.ec2#FlowLog": { - "type": "structure", - "members": { - "CreationTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "CreationTime", - "smithy.api#documentation": "

The date and time the flow log was created.

", - "smithy.api#xmlName": "creationTime" - } - }, - "DeliverLogsErrorMessage": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DeliverLogsErrorMessage", - "smithy.api#documentation": "

Information about the error that occurred. Rate limited indicates that\n CloudWatch Logs throttling has been applied for one or more network interfaces, or that you've\n reached the limit on the number of log groups that you can create. Access\n error indicates that the IAM role associated with the flow log does not have\n sufficient permissions to publish to CloudWatch Logs. Unknown error indicates an\n internal error.

", - "smithy.api#xmlName": "deliverLogsErrorMessage" - } - }, - "DeliverLogsPermissionArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DeliverLogsPermissionArn", - "smithy.api#documentation": "

The ARN of the IAM role allows the service to publish logs to CloudWatch Logs.

", - "smithy.api#xmlName": "deliverLogsPermissionArn" - } - }, - "DeliverCrossAccountRole": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DeliverCrossAccountRole", - "smithy.api#documentation": "

The ARN of the IAM role that allows the service to publish flow logs across accounts.

", - "smithy.api#xmlName": "deliverCrossAccountRole" - } - }, - "DeliverLogsStatus": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DeliverLogsStatus", - "smithy.api#documentation": "

The status of the logs delivery (SUCCESS | FAILED).

", - "smithy.api#xmlName": "deliverLogsStatus" - } - }, - "FlowLogId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "FlowLogId", - "smithy.api#documentation": "

The ID of the flow log.

", - "smithy.api#xmlName": "flowLogId" - } - }, - "FlowLogStatus": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "FlowLogStatus", - "smithy.api#documentation": "

The status of the flow log (ACTIVE).

", - "smithy.api#xmlName": "flowLogStatus" - } - }, - "LogGroupName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LogGroupName", - "smithy.api#documentation": "

The name of the flow log group.

", - "smithy.api#xmlName": "logGroupName" - } - }, - "ResourceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceId", - "smithy.api#documentation": "

The ID of the resource being monitored.

", - "smithy.api#xmlName": "resourceId" - } - }, - "TrafficType": { - "target": "com.amazonaws.ec2#TrafficType", - "traits": { - "aws.protocols#ec2QueryName": "TrafficType", - "smithy.api#documentation": "

The type of traffic captured for the flow log.

", - "smithy.api#xmlName": "trafficType" - } - }, - "LogDestinationType": { - "target": "com.amazonaws.ec2#LogDestinationType", - "traits": { - "aws.protocols#ec2QueryName": "LogDestinationType", - "smithy.api#documentation": "

The type of destination for the flow log data.

", - "smithy.api#xmlName": "logDestinationType" - } - }, - "LogDestination": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LogDestination", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the destination for the flow log data.

", - "smithy.api#xmlName": "logDestination" - } - }, - "LogFormat": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LogFormat", - "smithy.api#documentation": "

The format of the flow log record.

", - "smithy.api#xmlName": "logFormat" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags for the flow log.

", - "smithy.api#xmlName": "tagSet" - } - }, - "MaxAggregationInterval": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "MaxAggregationInterval", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.

\n

When a network interface is attached to a Nitro-based\n instance, the aggregation interval is always 60 seconds (1 minute) or less,\n regardless of the specified value.

\n

Valid Values: 60 | 600\n

", - "smithy.api#xmlName": "maxAggregationInterval" - } - }, - "DestinationOptions": { - "target": "com.amazonaws.ec2#DestinationOptionsResponse", - "traits": { - "aws.protocols#ec2QueryName": "DestinationOptions", - "smithy.api#documentation": "

The destination options.

", - "smithy.api#xmlName": "destinationOptions" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a flow log.

" - } - }, - "com.amazonaws.ec2#FlowLogIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VpcFlowLogId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#FlowLogResourceId": { - "type": "string" - }, - "com.amazonaws.ec2#FlowLogResourceIds": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#FlowLogResourceId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#FlowLogSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#FlowLog", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#FlowLogsResourceType": { - "type": "enum", - "members": { - "VPC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VPC" - } - }, - "Subnet": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Subnet" - } - }, - "NetworkInterface": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NetworkInterface" - } - }, - "TransitGateway": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TransitGateway" - } - }, - "TransitGatewayAttachment": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TransitGatewayAttachment" - } - } - } - }, - "com.amazonaws.ec2#FpgaDeviceCount": { - "type": "integer" - }, - "com.amazonaws.ec2#FpgaDeviceInfo": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.ec2#FpgaDeviceName", - "traits": { - "aws.protocols#ec2QueryName": "Name", - "smithy.api#documentation": "

The name of the FPGA accelerator.

", - "smithy.api#xmlName": "name" - } - }, - "Manufacturer": { - "target": "com.amazonaws.ec2#FpgaDeviceManufacturerName", - "traits": { - "aws.protocols#ec2QueryName": "Manufacturer", - "smithy.api#documentation": "

The manufacturer of the FPGA accelerator.

", - "smithy.api#xmlName": "manufacturer" - } - }, - "Count": { - "target": "com.amazonaws.ec2#FpgaDeviceCount", - "traits": { - "aws.protocols#ec2QueryName": "Count", - "smithy.api#documentation": "

The count of FPGA accelerators for the instance type.

", - "smithy.api#xmlName": "count" - } - }, - "MemoryInfo": { - "target": "com.amazonaws.ec2#FpgaDeviceMemoryInfo", - "traits": { - "aws.protocols#ec2QueryName": "MemoryInfo", - "smithy.api#documentation": "

Describes the memory for the FPGA accelerator for the instance type.

", - "smithy.api#xmlName": "memoryInfo" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the FPGA accelerator for the instance type.

" - } - }, - "com.amazonaws.ec2#FpgaDeviceInfoList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#FpgaDeviceInfo", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#FpgaDeviceManufacturerName": { - "type": "string" - }, - "com.amazonaws.ec2#FpgaDeviceMemoryInfo": { - "type": "structure", - "members": { - "SizeInMiB": { - "target": "com.amazonaws.ec2#FpgaDeviceMemorySize", - "traits": { - "aws.protocols#ec2QueryName": "SizeInMiB", - "smithy.api#documentation": "

The size of the memory available to the FPGA accelerator, in MiB.

", - "smithy.api#xmlName": "sizeInMiB" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the memory for the FPGA accelerator for the instance type.

" - } - }, - "com.amazonaws.ec2#FpgaDeviceMemorySize": { - "type": "integer" - }, - "com.amazonaws.ec2#FpgaDeviceName": { - "type": "string" - }, - "com.amazonaws.ec2#FpgaImage": { - "type": "structure", - "members": { - "FpgaImageId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "FpgaImageId", - "smithy.api#documentation": "

The FPGA image identifier (AFI ID).

", - "smithy.api#xmlName": "fpgaImageId" - } - }, - "FpgaImageGlobalId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "FpgaImageGlobalId", - "smithy.api#documentation": "

The global FPGA image identifier (AGFI ID).

", - "smithy.api#xmlName": "fpgaImageGlobalId" - } - }, - "Name": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Name", - "smithy.api#documentation": "

The name of the AFI.

", - "smithy.api#xmlName": "name" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

The description of the AFI.

", - "smithy.api#xmlName": "description" - } - }, - "ShellVersion": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ShellVersion", - "smithy.api#documentation": "

The version of the Amazon Web Services Shell that was used to create the bitstream.

", - "smithy.api#xmlName": "shellVersion" - } - }, - "PciId": { - "target": "com.amazonaws.ec2#PciId", - "traits": { - "aws.protocols#ec2QueryName": "PciId", - "smithy.api#documentation": "

Information about the PCI bus.

", - "smithy.api#xmlName": "pciId" - } - }, - "State": { - "target": "com.amazonaws.ec2#FpgaImageState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

Information about the state of the AFI.

", - "smithy.api#xmlName": "state" - } - }, - "CreateTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "CreateTime", - "smithy.api#documentation": "

The date and time the AFI was created.

", - "smithy.api#xmlName": "createTime" - } - }, - "UpdateTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "UpdateTime", - "smithy.api#documentation": "

The time of the most recent update to the AFI.

", - "smithy.api#xmlName": "updateTime" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the AFI.

", - "smithy.api#xmlName": "ownerId" - } - }, - "OwnerAlias": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerAlias", - "smithy.api#documentation": "

The alias of the AFI owner. Possible values include self, amazon, and aws-marketplace.

", - "smithy.api#xmlName": "ownerAlias" - } - }, - "ProductCodes": { - "target": "com.amazonaws.ec2#ProductCodeList", - "traits": { - "aws.protocols#ec2QueryName": "ProductCodes", - "smithy.api#documentation": "

The product codes for the AFI.

", - "smithy.api#xmlName": "productCodes" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "Tags", - "smithy.api#documentation": "

Any tags assigned to the AFI.

", - "smithy.api#xmlName": "tags" - } - }, - "Public": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Public", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the AFI is public.

", - "smithy.api#xmlName": "public" - } - }, - "DataRetentionSupport": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DataRetentionSupport", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether data retention support is enabled for the AFI.

", - "smithy.api#xmlName": "dataRetentionSupport" - } - }, - "InstanceTypes": { - "target": "com.amazonaws.ec2#InstanceTypesList", - "traits": { - "aws.protocols#ec2QueryName": "InstanceTypes", - "smithy.api#documentation": "

The instance types supported by the AFI.

", - "smithy.api#xmlName": "instanceTypes" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an Amazon FPGA image (AFI).

" - } - }, - "com.amazonaws.ec2#FpgaImageAttribute": { - "type": "structure", - "members": { - "FpgaImageId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "FpgaImageId", - "smithy.api#documentation": "

The ID of the AFI.

", - "smithy.api#xmlName": "fpgaImageId" - } - }, - "Name": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Name", - "smithy.api#documentation": "

The name of the AFI.

", - "smithy.api#xmlName": "name" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

The description of the AFI.

", - "smithy.api#xmlName": "description" - } - }, - "LoadPermissions": { - "target": "com.amazonaws.ec2#LoadPermissionList", - "traits": { - "aws.protocols#ec2QueryName": "LoadPermissions", - "smithy.api#documentation": "

The load permissions.

", - "smithy.api#xmlName": "loadPermissions" - } - }, - "ProductCodes": { - "target": "com.amazonaws.ec2#ProductCodeList", - "traits": { - "aws.protocols#ec2QueryName": "ProductCodes", - "smithy.api#documentation": "

The product codes.

", - "smithy.api#xmlName": "productCodes" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an Amazon FPGA image (AFI) attribute.

" - } - }, - "com.amazonaws.ec2#FpgaImageAttributeName": { - "type": "enum", - "members": { - "description": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "description" - } - }, - "name": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "name" - } - }, - "loadPermission": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "loadPermission" - } - }, - "productCodes": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "productCodes" - } - } - } - }, - "com.amazonaws.ec2#FpgaImageId": { - "type": "string" - }, - "com.amazonaws.ec2#FpgaImageIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#FpgaImageId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#FpgaImageList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#FpgaImage", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#FpgaImageState": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.ec2#FpgaImageStateCode", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The state. The following are the possible values:

\n ", - "smithy.api#xmlName": "code" - } - }, - "Message": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "

If the state is failed, this is the error message.

", - "smithy.api#xmlName": "message" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the state of the bitstream generation process for an Amazon FPGA image (AFI).

" - } - }, - "com.amazonaws.ec2#FpgaImageStateCode": { - "type": "enum", - "members": { - "pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failed" - } - }, - "available": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "available" - } - }, - "unavailable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unavailable" - } - } - } - }, - "com.amazonaws.ec2#FpgaInfo": { - "type": "structure", - "members": { - "Fpgas": { - "target": "com.amazonaws.ec2#FpgaDeviceInfoList", - "traits": { - "aws.protocols#ec2QueryName": "Fpgas", - "smithy.api#documentation": "

Describes the FPGAs for the instance type.

", - "smithy.api#xmlName": "fpgas" - } - }, - "TotalFpgaMemoryInMiB": { - "target": "com.amazonaws.ec2#totalFpgaMemory", - "traits": { - "aws.protocols#ec2QueryName": "TotalFpgaMemoryInMiB", - "smithy.api#documentation": "

The total memory of all FPGA accelerators for the instance type.

", - "smithy.api#xmlName": "totalFpgaMemoryInMiB" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the FPGAs for the instance type.

" - } - }, - "com.amazonaws.ec2#FreeTierEligibleFlag": { - "type": "boolean" - }, - "com.amazonaws.ec2#GVCDMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 200, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#GatewayAssociationState": { - "type": "enum", - "members": { - "associated": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "associated" - } - }, - "not_associated": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "not-associated" - } - }, - "associating": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "associating" - } - }, - "disassociating": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disassociating" - } - } - } - }, - "com.amazonaws.ec2#GatewayType": { - "type": "enum", - "members": { - "ipsec_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ipsec.1" - } - } - } - }, - "com.amazonaws.ec2#GetAssociatedEnclaveCertificateIamRoles": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetAssociatedEnclaveCertificateIamRolesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetAssociatedEnclaveCertificateIamRolesResult" - }, - "traits": { - "smithy.api#documentation": "

Returns the IAM roles that are associated with the specified ACM (ACM) certificate. \n\t\t\tIt also returns the name of the Amazon S3 bucket and the Amazon S3 object key where the certificate, \n\t\t\tcertificate chain, and encrypted private key bundle are stored, and the ARN of the KMS key \n\t\t\tthat's used to encrypt the private key.

" - } - }, - "com.amazonaws.ec2#GetAssociatedEnclaveCertificateIamRolesRequest": { - "type": "structure", - "members": { - "CertificateArn": { - "target": "com.amazonaws.ec2#CertificateId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ARN of the ACM certificate for which to view the associated IAM roles, encryption keys, and Amazon \n\t\t\tS3 object information.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetAssociatedEnclaveCertificateIamRolesResult": { - "type": "structure", - "members": { - "AssociatedRoles": { - "target": "com.amazonaws.ec2#AssociatedRolesList", - "traits": { - "aws.protocols#ec2QueryName": "AssociatedRoleSet", - "smithy.api#documentation": "

Information about the associated IAM roles.

", - "smithy.api#xmlName": "associatedRoleSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetAssociatedIpv6PoolCidrs": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetAssociatedIpv6PoolCidrsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetAssociatedIpv6PoolCidrsResult" - }, - "traits": { - "smithy.api#documentation": "

Gets information about the IPv6 CIDR block associations for a specified IPv6 address pool.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Ipv6CidrAssociations", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#GetAssociatedIpv6PoolCidrsRequest": { - "type": "structure", - "members": { - "PoolId": { - "target": "com.amazonaws.ec2#Ipv6PoolEc2Id", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the IPv6 address pool.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#Ipv6PoolMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetAssociatedIpv6PoolCidrsResult": { - "type": "structure", - "members": { - "Ipv6CidrAssociations": { - "target": "com.amazonaws.ec2#Ipv6CidrAssociationSet", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6CidrAssociationSet", - "smithy.api#documentation": "

Information about the IPv6 CIDR block associations.

", - "smithy.api#xmlName": "ipv6CidrAssociationSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetAwsNetworkPerformanceData": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetAwsNetworkPerformanceDataRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetAwsNetworkPerformanceDataResult" - }, - "traits": { - "smithy.api#documentation": "

Gets network performance data.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "DataResponses", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#GetAwsNetworkPerformanceDataRequest": { - "type": "structure", - "members": { - "DataQueries": { - "target": "com.amazonaws.ec2#DataQueries", - "traits": { - "smithy.api#documentation": "

A list of network performance data queries.

", - "smithy.api#xmlName": "DataQuery" - } - }, - "StartTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "smithy.api#documentation": "

The starting time for the performance data request. The starting time must be formatted\n as yyyy-mm-ddThh:mm:ss. For example, 2022-06-10T12:00:00.000Z.

" - } - }, - "EndTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "smithy.api#documentation": "

The ending time for the performance data request. The end time must be formatted as yyyy-mm-ddThh:mm:ss. For example, 2022-06-12T12:00:00.000Z.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetAwsNetworkPerformanceDataResult": { - "type": "structure", - "members": { - "DataResponses": { - "target": "com.amazonaws.ec2#DataResponses", - "traits": { - "aws.protocols#ec2QueryName": "DataResponseSet", - "smithy.api#documentation": "

The list of data responses.

", - "smithy.api#xmlName": "dataResponseSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetCapacityReservationUsage": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetCapacityReservationUsageRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetCapacityReservationUsageResult" - }, - "traits": { - "smithy.api#documentation": "

Gets usage information about a Capacity Reservation. If the Capacity Reservation is shared, it shows usage information for the Capacity Reservation owner \n\t\t\tand each Amazon Web Services account that is currently using the shared capacity. If the Capacity Reservation is not shared, it shows only \n\t\t\tthe Capacity Reservation owner's usage.

" - } - }, - "com.amazonaws.ec2#GetCapacityReservationUsageRequest": { - "type": "structure", - "members": { - "CapacityReservationId": { - "target": "com.amazonaws.ec2#CapacityReservationId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Capacity Reservation.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#GetCapacityReservationUsageRequestMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#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.

\n

Valid range: Minimum value of 1. Maximum value of 1000.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetCapacityReservationUsageRequestMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#GetCapacityReservationUsageResult": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - }, - "CapacityReservationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CapacityReservationId", - "smithy.api#documentation": "

The ID of the Capacity Reservation.

", - "smithy.api#xmlName": "capacityReservationId" - } - }, - "InstanceType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The type of instance for which the Capacity Reservation reserves capacity.

", - "smithy.api#xmlName": "instanceType" - } - }, - "TotalInstanceCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "TotalInstanceCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of instances for which the Capacity Reservation reserves capacity.

", - "smithy.api#xmlName": "totalInstanceCount" - } - }, - "AvailableInstanceCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "AvailableInstanceCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.

", - "smithy.api#xmlName": "availableInstanceCount" - } - }, - "State": { - "target": "com.amazonaws.ec2#CapacityReservationState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

\n ", - "smithy.api#xmlName": "state" - } - }, - "InstanceUsages": { - "target": "com.amazonaws.ec2#InstanceUsageSet", - "traits": { - "aws.protocols#ec2QueryName": "InstanceUsageSet", - "smithy.api#documentation": "

Information about the Capacity Reservation usage.

", - "smithy.api#xmlName": "instanceUsageSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetCoipPoolUsage": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetCoipPoolUsageRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetCoipPoolUsageResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the allocations from the specified customer-owned address pool.

" - } - }, - "com.amazonaws.ec2#GetCoipPoolUsageRequest": { - "type": "structure", - "members": { - "PoolId": { - "target": "com.amazonaws.ec2#Ipv4PoolCoipId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the address pool.

", - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#CoipPoolMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetCoipPoolUsageResult": { - "type": "structure", - "members": { - "CoipPoolId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CoipPoolId", - "smithy.api#documentation": "

The ID of the customer-owned address pool.

", - "smithy.api#xmlName": "coipPoolId" - } - }, - "CoipAddressUsages": { - "target": "com.amazonaws.ec2#CoipAddressUsageSet", - "traits": { - "aws.protocols#ec2QueryName": "CoipAddressUsageSet", - "smithy.api#documentation": "

Information about the address usage.

", - "smithy.api#xmlName": "coipAddressUsageSet" - } - }, - "LocalGatewayRouteTableId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayRouteTableId", - "smithy.api#documentation": "

The ID of the local gateway route table.

", - "smithy.api#xmlName": "localGatewayRouteTableId" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetConsoleOutput": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetConsoleOutputRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetConsoleOutputResult" - }, - "traits": { - "smithy.api#documentation": "

Gets the console output for the specified instance. For Linux instances, the instance\n console output displays the exact console output that would normally be displayed on a\n physical monitor attached to a computer. For Windows instances, the instance console\n output includes the last three system event log errors.

\n

By default, the console output returns buffered information that was posted shortly\n after an instance transition state (start, stop, reboot, or terminate). This information\n is available for at least one hour after the most recent post. Only the most recent 64\n KB of console output is available.

\n

You can optionally retrieve the latest serial console output at any time during the\n instance lifecycle. This option is supported on instance types that use the Nitro\n hypervisor.

\n

For more information, see Instance\n console output in the Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#GetConsoleOutputRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "Latest": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

When enabled, retrieves the latest console output for the instance.

\n

Default: disabled (false)

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetConsoleOutputResult": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#xmlName": "instanceId" - } - }, - "Output": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Output", - "smithy.api#documentation": "

The console output, base64-encoded. If you are using a command line tool, the tool\n decodes the output for you.

", - "smithy.api#xmlName": "output" - } - }, - "Timestamp": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "Timestamp", - "smithy.api#documentation": "

The time at which the output was last updated.

", - "smithy.api#xmlName": "timestamp" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetConsoleScreenshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetConsoleScreenshotRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetConsoleScreenshotResult" - }, - "traits": { - "smithy.api#documentation": "

Retrieve a JPG-format screenshot of a running instance to help with\n troubleshooting.

\n

The returned content is Base64-encoded.

" - } - }, - "com.amazonaws.ec2#GetConsoleScreenshotRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#required": {} - } - }, - "WakeUp": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

When set to true, acts as keystroke input and wakes up an instance that's\n in standby or \"sleep\" mode.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetConsoleScreenshotResult": { - "type": "structure", - "members": { - "ImageData": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ImageData", - "smithy.api#documentation": "

The data that comprises the image.

", - "smithy.api#xmlName": "imageData" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#xmlName": "instanceId" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetDefaultCreditSpecification": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetDefaultCreditSpecificationRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetDefaultCreditSpecificationResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the default credit option for CPU usage of a burstable performance instance\n family.

\n

For more information, see Burstable\n performance instances in the Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#GetDefaultCreditSpecificationRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "InstanceFamily": { - "target": "com.amazonaws.ec2#UnlimitedSupportedInstanceFamily", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The instance family.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetDefaultCreditSpecificationResult": { - "type": "structure", - "members": { - "InstanceFamilyCreditSpecification": { - "target": "com.amazonaws.ec2#InstanceFamilyCreditSpecification", - "traits": { - "aws.protocols#ec2QueryName": "InstanceFamilyCreditSpecification", - "smithy.api#documentation": "

The default credit option for CPU usage of the instance family.

", - "smithy.api#xmlName": "instanceFamilyCreditSpecification" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetEbsDefaultKmsKeyId": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetEbsDefaultKmsKeyIdRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetEbsDefaultKmsKeyIdResult" - }, - "traits": { - "smithy.api#documentation": "

Describes the default KMS key for EBS encryption by default for your account in this Region. \n \t\tYou can change the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId or\n ResetEbsDefaultKmsKeyId.

\n

For more information, see Amazon EBS encryption\n in the Amazon Elastic Compute Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#GetEbsDefaultKmsKeyIdRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetEbsDefaultKmsKeyIdResult": { - "type": "structure", - "members": { - "KmsKeyId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "KmsKeyId", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the default KMS key for encryption by default.

", - "smithy.api#xmlName": "kmsKeyId" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetEbsEncryptionByDefault": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetEbsEncryptionByDefaultRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetEbsEncryptionByDefaultResult" - }, - "traits": { - "smithy.api#documentation": "

Describes whether EBS encryption by default is enabled for your account in the current\n Region.

\n

For more information, see Amazon EBS encryption\n in the Amazon Elastic Compute Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#GetEbsEncryptionByDefaultRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetEbsEncryptionByDefaultResult": { - "type": "structure", - "members": { - "EbsEncryptionByDefault": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "EbsEncryptionByDefault", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether encryption by default is enabled.

", - "smithy.api#xmlName": "ebsEncryptionByDefault" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetFlowLogsIntegrationTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetFlowLogsIntegrationTemplateRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetFlowLogsIntegrationTemplateResult" - }, - "traits": { - "smithy.api#documentation": "

Generates a CloudFormation template that streamlines and automates the integration of VPC flow logs \n with Amazon Athena. This make it easier for you to query and gain insights from VPC flow logs data. \n Based on the information that you provide, we configure resources in the template to do the following:

\n " - } - }, - "com.amazonaws.ec2#GetFlowLogsIntegrationTemplateRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "FlowLogId": { - "target": "com.amazonaws.ec2#VpcFlowLogId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the flow log.

", - "smithy.api#required": {} - } - }, - "ConfigDeliveryS3DestinationArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

To store the CloudFormation template in Amazon S3, specify the location in Amazon S3.

", - "smithy.api#required": {} - } - }, - "IntegrateServices": { - "target": "com.amazonaws.ec2#IntegrateServices", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Information about the service integration.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "IntegrateService" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetFlowLogsIntegrationTemplateResult": { - "type": "structure", - "members": { - "Result": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Result", - "smithy.api#documentation": "

The generated CloudFormation template.

", - "smithy.api#xmlName": "result" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetGroupsForCapacityReservation": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetGroupsForCapacityReservationRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetGroupsForCapacityReservationResult" - }, - "traits": { - "smithy.api#documentation": "

Lists the resource groups to which a Capacity Reservation has been added.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "CapacityReservationGroups", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#GetGroupsForCapacityReservationRequest": { - "type": "structure", - "members": { - "CapacityReservationId": { - "target": "com.amazonaws.ec2#CapacityReservationId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Capacity Reservation. If you specify a Capacity Reservation that is shared \n\t\t\twith you, the operation returns only Capacity Reservation groups that you own.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#GetGroupsForCapacityReservationRequestMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#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.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetGroupsForCapacityReservationRequestMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#GetGroupsForCapacityReservationResult": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - }, - "CapacityReservationGroups": { - "target": "com.amazonaws.ec2#CapacityReservationGroupSet", - "traits": { - "aws.protocols#ec2QueryName": "CapacityReservationGroupSet", - "smithy.api#documentation": "

Information about the resource groups to which the Capacity Reservation has been added.

", - "smithy.api#xmlName": "capacityReservationGroupSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetHostReservationPurchasePreview": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetHostReservationPurchasePreviewRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetHostReservationPurchasePreviewResult" - }, - "traits": { - "smithy.api#documentation": "

Preview a reservation purchase with configurations that match those of your Dedicated\n Host. You must have active Dedicated Hosts in your account before you purchase a\n reservation.

\n

This is a preview of the PurchaseHostReservation action and does not\n result in the offering being purchased.

" - } - }, - "com.amazonaws.ec2#GetHostReservationPurchasePreviewRequest": { - "type": "structure", - "members": { - "HostIdSet": { - "target": "com.amazonaws.ec2#RequestHostIdSet", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IDs of the Dedicated Hosts with which the reservation is associated.

", - "smithy.api#required": {} - } - }, - "OfferingId": { - "target": "com.amazonaws.ec2#OfferingId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The offering ID of the reservation.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetHostReservationPurchasePreviewResult": { - "type": "structure", - "members": { - "CurrencyCode": { - "target": "com.amazonaws.ec2#CurrencyCodeValues", - "traits": { - "aws.protocols#ec2QueryName": "CurrencyCode", - "smithy.api#documentation": "

The currency in which the totalUpfrontPrice and\n totalHourlyPrice amounts are specified. At this time, the only\n supported currency is USD.

", - "smithy.api#xmlName": "currencyCode" - } - }, - "Purchase": { - "target": "com.amazonaws.ec2#PurchaseSet", - "traits": { - "aws.protocols#ec2QueryName": "Purchase", - "smithy.api#documentation": "

The purchase information of the Dedicated Host reservation and the Dedicated Hosts\n associated with it.

", - "smithy.api#xmlName": "purchase" - } - }, - "TotalHourlyPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TotalHourlyPrice", - "smithy.api#documentation": "

The potential total hourly price of the reservation per hour.

", - "smithy.api#xmlName": "totalHourlyPrice" - } - }, - "TotalUpfrontPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TotalUpfrontPrice", - "smithy.api#documentation": "

The potential total upfront price. This is billed immediately.

", - "smithy.api#xmlName": "totalUpfrontPrice" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetInstanceTypesFromInstanceRequirements": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetInstanceTypesFromInstanceRequirementsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetInstanceTypesFromInstanceRequirementsResult" - }, - "traits": { - "smithy.api#documentation": "

Returns a list of instance types with the specified instance attributes. You can\n use the response to preview the instance types without launching instances. Note\n that the response does not consider capacity.

\n

When you specify multiple parameters, you get instance types that satisfy all of the\n specified parameters. If you specify multiple values for a parameter, you get instance\n types that satisfy any of the specified values.

\n

For more information, see Preview instance types with specified attributes, Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot\n placement score in the Amazon EC2 User Guide, and Creating an\n Auto Scaling group using attribute-based instance type selection in the\n Amazon EC2 Auto Scaling User Guide.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "InstanceTypes", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#GetInstanceTypesFromInstanceRequirementsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "ArchitectureTypes": { - "target": "com.amazonaws.ec2#ArchitectureTypeSet", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The processor architecture type.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "ArchitectureType" - } - }, - "VirtualizationTypes": { - "target": "com.amazonaws.ec2#VirtualizationTypeSet", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The virtualization type.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "VirtualizationType" - } - }, - "InstanceRequirements": { - "target": "com.amazonaws.ec2#InstanceRequirementsRequest", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The attributes required for the instance types.

", - "smithy.api#required": {} - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetInstanceTypesFromInstanceRequirementsResult": { - "type": "structure", - "members": { - "InstanceTypes": { - "target": "com.amazonaws.ec2#InstanceTypeInfoFromInstanceRequirementsSet", - "traits": { - "aws.protocols#ec2QueryName": "InstanceTypeSet", - "smithy.api#documentation": "

The instance types with the specified instance attributes.

", - "smithy.api#xmlName": "instanceTypeSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetInstanceUefiData": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetInstanceUefiDataRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetInstanceUefiDataResult" - }, - "traits": { - "smithy.api#documentation": "

A binary representation of the UEFI variable store. Only non-volatile variables are\n stored. This is a base64 encoded and zlib compressed binary value that must be properly\n encoded.

\n

When you use register-image to create\n an AMI, you can create an exact copy of your variable store by passing the UEFI data in\n the UefiData parameter. You can modify the UEFI data by using the python-uefivars tool on\n GitHub. You can use the tool to convert the UEFI data into a human-readable format\n (JSON), which you can inspect and modify, and then convert back into the binary format\n to use with register-image.

\n

For more information, see UEFI Secure Boot in the\n Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#GetInstanceUefiDataRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the instance from which to retrieve the UEFI data.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "InstanceId" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetInstanceUefiDataResult": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance from which to retrieve the UEFI data.

", - "smithy.api#xmlName": "instanceId" - } - }, - "UefiData": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "UefiData", - "smithy.api#documentation": "

Base64 representation of the non-volatile UEFI variable store.

", - "smithy.api#xmlName": "uefiData" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetIpamAddressHistory": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetIpamAddressHistoryRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetIpamAddressHistoryResult" - }, - "traits": { - "smithy.api#documentation": "

Retrieve historical information about a CIDR within an IPAM scope. For more information, see View the history of IP addresses in the Amazon VPC IPAM User Guide.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "HistoryRecords", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#GetIpamAddressHistoryRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "Cidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The CIDR you want the history of. The CIDR can be an IPv4 or IPv6 IP address range. \n If you enter a /16 IPv4 CIDR, you will get records that match it exactly. You will not get records for any subnets within the /16 CIDR.

", - "smithy.api#required": {} - } - }, - "IpamScopeId": { - "target": "com.amazonaws.ec2#IpamScopeId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the IPAM scope that the CIDR is in.

", - "smithy.api#required": {} - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The ID of the VPC you want your history records filtered by.

" - } - }, - "StartTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "smithy.api#documentation": "

The start of the time period for which you are looking for history. If you omit this option, it will default to the value of EndTime.

" - } - }, - "EndTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "smithy.api#documentation": "

The end of the time period for which you are looking for history. If you omit this option, it will default to the current time.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#IpamAddressHistoryMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of historical results you would like returned per page. Defaults to 100.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetIpamAddressHistoryResult": { - "type": "structure", - "members": { - "HistoryRecords": { - "target": "com.amazonaws.ec2#IpamAddressHistoryRecordSet", - "traits": { - "aws.protocols#ec2QueryName": "HistoryRecordSet", - "smithy.api#documentation": "

A historical record for a CIDR within an IPAM scope. If the CIDR is associated with an EC2 instance, you will see an object in the response for the instance and one for the network interface.

", - "smithy.api#xmlName": "historyRecordSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetIpamDiscoveredAccounts": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetIpamDiscoveredAccountsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetIpamDiscoveredAccountsResult" - }, - "traits": { - "smithy.api#documentation": "

Gets IPAM discovered accounts. A discovered account is an Amazon Web Services account that is monitored under a resource discovery. If you have integrated IPAM with Amazon Web Services Organizations, all accounts in the organization are discovered accounts. Only the IPAM account can get all discovered accounts in the organization.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "IpamDiscoveredAccounts", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#GetIpamDiscoveredAccountsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "IpamResourceDiscoveryId": { - "target": "com.amazonaws.ec2#IpamResourceDiscoveryId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A resource discovery ID.

", - "smithy.api#required": {} - } - }, - "DiscoveryRegion": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Amazon Web Services Region that the account information is returned from.

", - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

Discovered account filters.

", - "smithy.api#xmlName": "Filter" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#IpamMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of discovered accounts to return in one page of results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetIpamDiscoveredAccountsResult": { - "type": "structure", - "members": { - "IpamDiscoveredAccounts": { - "target": "com.amazonaws.ec2#IpamDiscoveredAccountSet", - "traits": { - "aws.protocols#ec2QueryName": "IpamDiscoveredAccountSet", - "smithy.api#documentation": "

Discovered accounts.

", - "smithy.api#xmlName": "ipamDiscoveredAccountSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetIpamDiscoveredResourceCidrs": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetIpamDiscoveredResourceCidrsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetIpamDiscoveredResourceCidrsResult" - }, - "traits": { - "smithy.api#documentation": "

Returns the resource CIDRs that are monitored as part of a resource discovery. A discovered resource is a resource CIDR monitored under a resource discovery. The following resources can be discovered: VPCs, Public IPv4 pools, VPC subnets, and Elastic IP addresses.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "IpamDiscoveredResourceCidrs", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#GetIpamDiscoveredResourceCidrsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "IpamResourceDiscoveryId": { - "target": "com.amazonaws.ec2#IpamResourceDiscoveryId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A resource discovery ID.

", - "smithy.api#required": {} - } - }, - "ResourceRegion": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A resource Region.

", - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

Filters.

", - "smithy.api#xmlName": "Filter" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#IpamMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of discovered resource CIDRs to return in one page of results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetIpamDiscoveredResourceCidrsResult": { - "type": "structure", - "members": { - "IpamDiscoveredResourceCidrs": { - "target": "com.amazonaws.ec2#IpamDiscoveredResourceCidrSet", - "traits": { - "aws.protocols#ec2QueryName": "IpamDiscoveredResourceCidrSet", - "smithy.api#documentation": "

Discovered resource CIDRs.

", - "smithy.api#xmlName": "ipamDiscoveredResourceCidrSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetIpamPoolAllocations": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetIpamPoolAllocationsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetIpamPoolAllocationsResult" - }, - "traits": { - "smithy.api#documentation": "

Get a list of all the CIDR allocations in an IPAM pool.

\n \n

If you use this action after AllocateIpamPoolCidr or ReleaseIpamPoolAllocation, note that all EC2 API actions follow an eventual consistency model.

\n ", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "IpamPoolAllocations", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#GetIpamPoolAllocationsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1000, - "max": 100000 - } - } - }, - "com.amazonaws.ec2#GetIpamPoolAllocationsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "IpamPoolId": { - "target": "com.amazonaws.ec2#IpamPoolId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the IPAM pool you want to see the allocations for.

", - "smithy.api#required": {} - } - }, - "IpamPoolAllocationId": { - "target": "com.amazonaws.ec2#IpamPoolAllocationId", - "traits": { - "smithy.api#documentation": "

The ID of the allocation.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters for the request. For more information about filtering, see Filtering CLI output.

", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#GetIpamPoolAllocationsMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results you would like returned per page.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetIpamPoolAllocationsResult": { - "type": "structure", - "members": { - "IpamPoolAllocations": { - "target": "com.amazonaws.ec2#IpamPoolAllocationSet", - "traits": { - "aws.protocols#ec2QueryName": "IpamPoolAllocationSet", - "smithy.api#documentation": "

The IPAM pool allocations you want information on.

", - "smithy.api#xmlName": "ipamPoolAllocationSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetIpamPoolCidrs": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetIpamPoolCidrsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetIpamPoolCidrsResult" - }, - "traits": { - "smithy.api#documentation": "

Get the CIDRs provisioned to an IPAM pool.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "IpamPoolCidrs", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#GetIpamPoolCidrsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "IpamPoolId": { - "target": "com.amazonaws.ec2#IpamPoolId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the IPAM pool you want the CIDR for.

", - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters for the request. For more information about filtering, see Filtering CLI output.

", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#IpamMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return in the request.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetIpamPoolCidrsResult": { - "type": "structure", - "members": { - "IpamPoolCidrs": { - "target": "com.amazonaws.ec2#IpamPoolCidrSet", - "traits": { - "aws.protocols#ec2QueryName": "IpamPoolCidrSet", - "smithy.api#documentation": "

Information about the CIDRs provisioned to an IPAM pool.

", - "smithy.api#xmlName": "ipamPoolCidrSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetIpamResourceCidrs": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetIpamResourceCidrsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetIpamResourceCidrsResult" - }, - "traits": { - "smithy.api#documentation": "

Returns resource CIDRs managed by IPAM in a given scope. If an IPAM is associated with more than one resource discovery, the resource CIDRs across all of the resource discoveries is returned. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "IpamResourceCidrs", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#GetIpamResourceCidrsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters for the request. For more information about filtering, see Filtering CLI output.

", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#IpamMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return in the request.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "IpamScopeId": { - "target": "com.amazonaws.ec2#IpamScopeId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the scope that the resource is in.

", - "smithy.api#required": {} - } - }, - "IpamPoolId": { - "target": "com.amazonaws.ec2#IpamPoolId", - "traits": { - "smithy.api#documentation": "

The ID of the IPAM pool that the resource is in.

" - } - }, - "ResourceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The ID of the resource.

" - } - }, - "ResourceType": { - "target": "com.amazonaws.ec2#IpamResourceType", - "traits": { - "smithy.api#documentation": "

The resource type.

" - } - }, - "ResourceTag": { - "target": "com.amazonaws.ec2#RequestIpamResourceTag", - "traits": { - "smithy.api#documentation": "

The resource tag.

" - } - }, - "ResourceOwner": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the resource.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetIpamResourceCidrsResult": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - }, - "IpamResourceCidrs": { - "target": "com.amazonaws.ec2#IpamResourceCidrSet", - "traits": { - "aws.protocols#ec2QueryName": "IpamResourceCidrSet", - "smithy.api#documentation": "

The resource CIDRs.

", - "smithy.api#xmlName": "ipamResourceCidrSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetLaunchTemplateData": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetLaunchTemplateDataRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetLaunchTemplateDataResult" - }, - "traits": { - "smithy.api#documentation": "

Retrieves the configuration data of the specified instance. You can use this data to\n create a launch template.

\n

This action calls on other describe actions to get instance information. Depending on\n your instance configuration, you may need to allow the following actions in your IAM\n policy: DescribeSpotInstanceRequests,\n DescribeInstanceCreditSpecifications, DescribeVolumes,\n DescribeInstanceAttribute, and DescribeElasticGpus. Or,\n you can allow describe* depending on your instance requirements.

" - } - }, - "com.amazonaws.ec2#GetLaunchTemplateDataRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetLaunchTemplateDataResult": { - "type": "structure", - "members": { - "LaunchTemplateData": { - "target": "com.amazonaws.ec2#ResponseLaunchTemplateData", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateData", - "smithy.api#documentation": "

The instance data.

", - "smithy.api#xmlName": "launchTemplateData" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetManagedPrefixListAssociations": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetManagedPrefixListAssociationsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetManagedPrefixListAssociationsResult" - }, - "traits": { - "smithy.api#documentation": "

Gets information about the resources that are associated with the specified managed prefix list.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "PrefixListAssociations", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#GetManagedPrefixListAssociationsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 255 - } - } - }, - "com.amazonaws.ec2#GetManagedPrefixListAssociationsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "PrefixListId": { - "target": "com.amazonaws.ec2#PrefixListResourceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the prefix list.

", - "smithy.api#required": {} - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#GetManagedPrefixListAssociationsMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetManagedPrefixListAssociationsResult": { - "type": "structure", - "members": { - "PrefixListAssociations": { - "target": "com.amazonaws.ec2#PrefixListAssociationSet", - "traits": { - "aws.protocols#ec2QueryName": "PrefixListAssociationSet", - "smithy.api#documentation": "

Information about the associations.

", - "smithy.api#xmlName": "prefixListAssociationSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetManagedPrefixListEntries": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetManagedPrefixListEntriesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetManagedPrefixListEntriesResult" - }, - "traits": { - "smithy.api#documentation": "

Gets information about the entries for a specified managed prefix list.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Entries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#GetManagedPrefixListEntriesRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "PrefixListId": { - "target": "com.amazonaws.ec2#PrefixListResourceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the prefix list.

", - "smithy.api#required": {} - } - }, - "TargetVersion": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The version of the prefix list for which to return the entries. The default is the current version.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#PrefixListMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetManagedPrefixListEntriesResult": { - "type": "structure", - "members": { - "Entries": { - "target": "com.amazonaws.ec2#PrefixListEntrySet", - "traits": { - "aws.protocols#ec2QueryName": "EntrySet", - "smithy.api#documentation": "

Information about the prefix list entries.

", - "smithy.api#xmlName": "entrySet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetNetworkInsightsAccessScopeAnalysisFindings": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetNetworkInsightsAccessScopeAnalysisFindingsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetNetworkInsightsAccessScopeAnalysisFindingsResult" - }, - "traits": { - "smithy.api#documentation": "

Gets the findings for the specified Network Access Scope analysis.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "AnalysisFindings", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#GetNetworkInsightsAccessScopeAnalysisFindingsRequest": { - "type": "structure", - "members": { - "NetworkInsightsAccessScopeAnalysisId": { - "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Network Access Scope analysis.

", - "smithy.api#required": {} - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#NetworkInsightsMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetNetworkInsightsAccessScopeAnalysisFindingsResult": { - "type": "structure", - "members": { - "NetworkInsightsAccessScopeAnalysisId": { - "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisId", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeAnalysisId", - "smithy.api#documentation": "

The ID of the Network Access Scope analysis.

", - "smithy.api#xmlName": "networkInsightsAccessScopeAnalysisId" - } - }, - "AnalysisStatus": { - "target": "com.amazonaws.ec2#AnalysisStatus", - "traits": { - "aws.protocols#ec2QueryName": "AnalysisStatus", - "smithy.api#documentation": "

The status of Network Access Scope Analysis.

", - "smithy.api#xmlName": "analysisStatus" - } - }, - "AnalysisFindings": { - "target": "com.amazonaws.ec2#AccessScopeAnalysisFindingList", - "traits": { - "aws.protocols#ec2QueryName": "AnalysisFindingSet", - "smithy.api#documentation": "

The findings associated with Network Access Scope Analysis.

", - "smithy.api#xmlName": "analysisFindingSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetNetworkInsightsAccessScopeContent": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetNetworkInsightsAccessScopeContentRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetNetworkInsightsAccessScopeContentResult" - }, - "traits": { - "smithy.api#documentation": "

Gets the content for the specified Network Access Scope.

" - } - }, - "com.amazonaws.ec2#GetNetworkInsightsAccessScopeContentRequest": { - "type": "structure", - "members": { - "NetworkInsightsAccessScopeId": { - "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Network Access Scope.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetNetworkInsightsAccessScopeContentResult": { - "type": "structure", - "members": { - "NetworkInsightsAccessScopeContent": { - "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeContent", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeContent", - "smithy.api#documentation": "

The Network Access Scope content.

", - "smithy.api#xmlName": "networkInsightsAccessScopeContent" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetPasswordData": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetPasswordDataRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetPasswordDataResult" - }, - "traits": { - "smithy.api#documentation": "

Retrieves the encrypted administrator password for a running Windows instance.

\n

The Windows password is generated at boot by the EC2Config service or\n EC2Launch scripts (Windows Server 2016 and later). This usually only\n happens the first time an instance is launched. For more information, see EC2Config and EC2Launch in the\n Amazon EC2 User Guide.

\n

For the EC2Config service, the password is not generated for rebundled\n AMIs unless Ec2SetPassword is enabled before bundling.

\n

The password is encrypted using the key pair that you specified when you launched the\n instance. You must provide the corresponding key pair file.

\n

When you launch an instance, password generation and encryption may take a few\n minutes. If you try to retrieve the password before it's available, the output returns\n an empty string. We recommend that you wait up to 15 minutes after launching an instance\n before trying to retrieve the generated password.

", - "smithy.waiters#waitable": { - "PasswordDataAvailable": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "length(PasswordData) > `0`", - "expected": "true", - "comparator": "booleanEquals" - } - } - } - ], - "minDelay": 15 - } - } - } - }, - "com.amazonaws.ec2#GetPasswordDataRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Windows instance.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetPasswordDataResult": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the Windows instance.

", - "smithy.api#xmlName": "instanceId" - } - }, - "PasswordData": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PasswordData", - "smithy.api#documentation": "

The password of the instance. Returns an empty string if the password is not\n available.

", - "smithy.api#xmlName": "passwordData" - } - }, - "Timestamp": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "Timestamp", - "smithy.api#documentation": "

The time the data was last updated.

", - "smithy.api#xmlName": "timestamp" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetReservedInstancesExchangeQuote": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetReservedInstancesExchangeQuoteRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetReservedInstancesExchangeQuoteResult" - }, - "traits": { - "smithy.api#documentation": "

Returns a quote and exchange information for exchanging one or more specified\n Convertible Reserved Instances for a new Convertible Reserved Instance. If the exchange\n cannot be performed, the reason is returned in the response. Use AcceptReservedInstancesExchangeQuote to perform the exchange.

" - } - }, - "com.amazonaws.ec2#GetReservedInstancesExchangeQuoteRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "ReservedInstanceIds": { - "target": "com.amazonaws.ec2#ReservedInstanceIdSet", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IDs of the Convertible Reserved Instances to exchange.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "ReservedInstanceId" - } - }, - "TargetConfigurations": { - "target": "com.amazonaws.ec2#TargetConfigurationRequestSet", - "traits": { - "smithy.api#documentation": "

The configuration of the target Convertible Reserved Instance to exchange for your\n current Convertible Reserved Instances.

", - "smithy.api#xmlName": "TargetConfiguration" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for GetReservedInstanceExchangeQuote.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetReservedInstancesExchangeQuoteResult": { - "type": "structure", - "members": { - "CurrencyCode": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CurrencyCode", - "smithy.api#documentation": "

The currency of the transaction.

", - "smithy.api#xmlName": "currencyCode" - } - }, - "IsValidExchange": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "IsValidExchange", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

If true, the exchange is valid. If false, the exchange cannot be completed.

", - "smithy.api#xmlName": "isValidExchange" - } - }, - "OutputReservedInstancesWillExpireAt": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "OutputReservedInstancesWillExpireAt", - "smithy.api#documentation": "

The new end date of the reservation term.

", - "smithy.api#xmlName": "outputReservedInstancesWillExpireAt" - } - }, - "PaymentDue": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PaymentDue", - "smithy.api#documentation": "

The total true upfront charge for the exchange.

", - "smithy.api#xmlName": "paymentDue" - } - }, - "ReservedInstanceValueRollup": { - "target": "com.amazonaws.ec2#ReservationValue", - "traits": { - "aws.protocols#ec2QueryName": "ReservedInstanceValueRollup", - "smithy.api#documentation": "

The cost associated with the Reserved Instance.

", - "smithy.api#xmlName": "reservedInstanceValueRollup" - } - }, - "ReservedInstanceValueSet": { - "target": "com.amazonaws.ec2#ReservedInstanceReservationValueSet", - "traits": { - "aws.protocols#ec2QueryName": "ReservedInstanceValueSet", - "smithy.api#documentation": "

The configuration of your Convertible Reserved Instances.

", - "smithy.api#xmlName": "reservedInstanceValueSet" - } - }, - "TargetConfigurationValueRollup": { - "target": "com.amazonaws.ec2#ReservationValue", - "traits": { - "aws.protocols#ec2QueryName": "TargetConfigurationValueRollup", - "smithy.api#documentation": "

The cost associated with the Reserved Instance.

", - "smithy.api#xmlName": "targetConfigurationValueRollup" - } - }, - "TargetConfigurationValueSet": { - "target": "com.amazonaws.ec2#TargetReservationValueSet", - "traits": { - "aws.protocols#ec2QueryName": "TargetConfigurationValueSet", - "smithy.api#documentation": "

The values of the target Convertible Reserved Instances.

", - "smithy.api#xmlName": "targetConfigurationValueSet" - } - }, - "ValidationFailureReason": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ValidationFailureReason", - "smithy.api#documentation": "

Describes the reason why the exchange cannot be completed.

", - "smithy.api#xmlName": "validationFailureReason" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of GetReservedInstancesExchangeQuote.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetSerialConsoleAccessStatus": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetSerialConsoleAccessStatusRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetSerialConsoleAccessStatusResult" - }, - "traits": { - "smithy.api#documentation": "

Retrieves the access status of your account to the EC2 serial console of all instances. By\n\t\t\tdefault, access to the EC2 serial console is disabled for your account. For more\n\t\t\tinformation, see Manage account access to the EC2 serial console in the Amazon EC2\n\t\t\t\tUser Guide.

" - } - }, - "com.amazonaws.ec2#GetSerialConsoleAccessStatusRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetSerialConsoleAccessStatusResult": { - "type": "structure", - "members": { - "SerialConsoleAccessEnabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "SerialConsoleAccessEnabled", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

If true, access to the EC2 serial console of all instances is enabled for\n\t\t\tyour account. If false, access to the EC2 serial console of all instances\n\t\t\tis disabled for your account.

", - "smithy.api#xmlName": "serialConsoleAccessEnabled" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetSpotPlacementScores": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetSpotPlacementScoresRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetSpotPlacementScoresResult" - }, - "traits": { - "smithy.api#documentation": "

Calculates the Spot placement score for a Region or Availability Zone based on the\n specified target capacity and compute requirements.

\n

You can specify your compute requirements either by using\n InstanceRequirementsWithMetadata and letting Amazon EC2 choose the optimal\n instance types to fulfill your Spot request, or you can specify the instance types by using\n InstanceTypes.

\n

For more information, see Spot placement score in\n the Amazon EC2 User Guide.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "SpotPlacementScores", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#GetSpotPlacementScoresRequest": { - "type": "structure", - "members": { - "InstanceTypes": { - "target": "com.amazonaws.ec2#InstanceTypes", - "traits": { - "smithy.api#documentation": "

The instance types. We recommend that you specify at least three instance types. If you\n specify one or two instance types, or specify variations of a single instance type (for\n example, an m3.xlarge with and without instance storage), the returned\n placement score will always be low.

\n

If you specify InstanceTypes, you can't specify\n InstanceRequirementsWithMetadata.

", - "smithy.api#xmlName": "InstanceType" - } - }, - "TargetCapacity": { - "target": "com.amazonaws.ec2#SpotPlacementScoresTargetCapacity", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The target capacity.

", - "smithy.api#required": {} - } - }, - "TargetCapacityUnitType": { - "target": "com.amazonaws.ec2#TargetCapacityUnitType", - "traits": { - "smithy.api#documentation": "

The unit for the target capacity.

\n

Default: units (translates to number of instances)

" - } - }, - "SingleAvailabilityZone": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Specify true so that the response returns a list of scored Availability Zones.\n Otherwise, the response returns a list of scored Regions.

\n

A list of scored Availability Zones is useful if you want to launch all of your Spot\n capacity into a single Availability Zone.

" - } - }, - "RegionNames": { - "target": "com.amazonaws.ec2#RegionNames", - "traits": { - "smithy.api#documentation": "

The Regions used to narrow down the list of Regions to be scored. Enter the Region code,\n for example, us-east-1.

", - "smithy.api#xmlName": "RegionName" - } - }, - "InstanceRequirementsWithMetadata": { - "target": "com.amazonaws.ec2#InstanceRequirementsWithMetadataRequest", - "traits": { - "smithy.api#documentation": "

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with those attributes.

\n

If you specify InstanceRequirementsWithMetadata, you can't specify\n InstanceTypes.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#SpotPlacementScoresMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetSpotPlacementScoresResult": { - "type": "structure", - "members": { - "SpotPlacementScores": { - "target": "com.amazonaws.ec2#SpotPlacementScores", - "traits": { - "aws.protocols#ec2QueryName": "SpotPlacementScoreSet", - "smithy.api#documentation": "

The Spot placement score for the top 10 Regions or Availability Zones, scored on a scale\n from 1 to 10. Each score\u2028 reflects how likely it is that each Region or Availability Zone\n will succeed at fulfilling the specified target capacity\u2028 at the time of the Spot\n placement score request. A score of 10 means that your Spot\n capacity request is highly likely to succeed in that Region or Availability Zone.

\n

If you request a Spot placement score for Regions, a high score assumes that your fleet\n request will be configured to use all Availability Zones and the\n capacity-optimized allocation strategy. If you request a Spot placement\n score for Availability Zones, a high score assumes that your fleet request will be\n configured to use a single Availability Zone and the capacity-optimized\n allocation strategy.

\n

Different\u2028 Regions or Availability Zones might return the same score.

\n \n

The Spot placement score serves as a recommendation only. No score guarantees that your\n Spot request will be fully or partially fulfilled.

\n ", - "smithy.api#xmlName": "spotPlacementScoreSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetSubnetCidrReservations": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetSubnetCidrReservationsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetSubnetCidrReservationsResult" - }, - "traits": { - "smithy.api#documentation": "

Gets information about the subnet CIDR reservations.

" - } - }, - "com.amazonaws.ec2#GetSubnetCidrReservationsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#GetSubnetCidrReservationsRequest": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#SubnetId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the subnet.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#GetSubnetCidrReservationsMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetSubnetCidrReservationsResult": { - "type": "structure", - "members": { - "SubnetIpv4CidrReservations": { - "target": "com.amazonaws.ec2#SubnetCidrReservationList", - "traits": { - "aws.protocols#ec2QueryName": "SubnetIpv4CidrReservationSet", - "smithy.api#documentation": "

Information about the IPv4 subnet CIDR reservations.

", - "smithy.api#xmlName": "subnetIpv4CidrReservationSet" - } - }, - "SubnetIpv6CidrReservations": { - "target": "com.amazonaws.ec2#SubnetCidrReservationList", - "traits": { - "aws.protocols#ec2QueryName": "SubnetIpv6CidrReservationSet", - "smithy.api#documentation": "

Information about the IPv6 subnet CIDR reservations.

", - "smithy.api#xmlName": "subnetIpv6CidrReservationSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetTransitGatewayAttachmentPropagations": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetTransitGatewayAttachmentPropagationsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetTransitGatewayAttachmentPropagationsResult" - }, - "traits": { - "smithy.api#documentation": "

Lists the route tables to which the specified resource attachment propagates routes.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "TransitGatewayAttachmentPropagations", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#GetTransitGatewayAttachmentPropagationsRequest": { - "type": "structure", - "members": { - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the attachment.

", - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#TransitGatewayMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetTransitGatewayAttachmentPropagationsResult": { - "type": "structure", - "members": { - "TransitGatewayAttachmentPropagations": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentPropagationList", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayAttachmentPropagations", - "smithy.api#documentation": "

Information about the propagation route tables.

", - "smithy.api#xmlName": "transitGatewayAttachmentPropagations" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetTransitGatewayMulticastDomainAssociations": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetTransitGatewayMulticastDomainAssociationsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetTransitGatewayMulticastDomainAssociationsResult" - }, - "traits": { - "smithy.api#documentation": "

Gets information about the associations for the transit gateway multicast domain.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "MulticastDomainAssociations", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#GetTransitGatewayMulticastDomainAssociationsRequest": { - "type": "structure", - "members": { - "TransitGatewayMulticastDomainId": { - "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#TransitGatewayMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetTransitGatewayMulticastDomainAssociationsResult": { - "type": "structure", - "members": { - "MulticastDomainAssociations": { - "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainAssociationList", - "traits": { - "aws.protocols#ec2QueryName": "MulticastDomainAssociations", - "smithy.api#documentation": "

Information about the multicast domain associations.

", - "smithy.api#xmlName": "multicastDomainAssociations" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetTransitGatewayPolicyTableAssociations": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetTransitGatewayPolicyTableAssociationsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetTransitGatewayPolicyTableAssociationsResult" - }, - "traits": { - "smithy.api#documentation": "

Gets a list of the transit gateway policy table associations.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Associations", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#GetTransitGatewayPolicyTableAssociationsRequest": { - "type": "structure", - "members": { - "TransitGatewayPolicyTableId": { - "target": "com.amazonaws.ec2#TransitGatewayPolicyTableId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the transit gateway policy table.

", - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters associated with the transit gateway policy table.

", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#TransitGatewayMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetTransitGatewayPolicyTableAssociationsResult": { - "type": "structure", - "members": { - "Associations": { - "target": "com.amazonaws.ec2#TransitGatewayPolicyTableAssociationList", - "traits": { - "aws.protocols#ec2QueryName": "Associations", - "smithy.api#documentation": "

Returns details about the transit gateway policy table association.

", - "smithy.api#xmlName": "associations" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token for the next page of results.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetTransitGatewayPolicyTableEntries": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetTransitGatewayPolicyTableEntriesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetTransitGatewayPolicyTableEntriesResult" - }, - "traits": { - "smithy.api#documentation": "

Returns a list of transit gateway policy table entries.

" - } - }, - "com.amazonaws.ec2#GetTransitGatewayPolicyTableEntriesRequest": { - "type": "structure", - "members": { - "TransitGatewayPolicyTableId": { - "target": "com.amazonaws.ec2#TransitGatewayPolicyTableId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the transit gateway policy table.

", - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters associated with the transit gateway policy table.

", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#TransitGatewayMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetTransitGatewayPolicyTableEntriesResult": { - "type": "structure", - "members": { - "TransitGatewayPolicyTableEntries": { - "target": "com.amazonaws.ec2#TransitGatewayPolicyTableEntryList", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayPolicyTableEntries", - "smithy.api#documentation": "

The entries for the transit gateway policy table.

", - "smithy.api#xmlName": "transitGatewayPolicyTableEntries" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetTransitGatewayPrefixListReferences": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetTransitGatewayPrefixListReferencesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetTransitGatewayPrefixListReferencesResult" - }, - "traits": { - "smithy.api#documentation": "

Gets information about the prefix list references in a specified transit gateway route table.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "TransitGatewayPrefixListReferences", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#GetTransitGatewayPrefixListReferencesRequest": { - "type": "structure", - "members": { - "TransitGatewayRouteTableId": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the transit gateway route table.

", - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#TransitGatewayMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetTransitGatewayPrefixListReferencesResult": { - "type": "structure", - "members": { - "TransitGatewayPrefixListReferences": { - "target": "com.amazonaws.ec2#TransitGatewayPrefixListReferenceSet", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayPrefixListReferenceSet", - "smithy.api#documentation": "

Information about the prefix list references.

", - "smithy.api#xmlName": "transitGatewayPrefixListReferenceSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetTransitGatewayRouteTableAssociations": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetTransitGatewayRouteTableAssociationsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetTransitGatewayRouteTableAssociationsResult" - }, - "traits": { - "smithy.api#documentation": "

Gets information about the associations for the specified transit gateway route table.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Associations", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#GetTransitGatewayRouteTableAssociationsRequest": { - "type": "structure", - "members": { - "TransitGatewayRouteTableId": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the transit gateway route table.

", - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#TransitGatewayMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetTransitGatewayRouteTableAssociationsResult": { - "type": "structure", - "members": { - "Associations": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableAssociationList", - "traits": { - "aws.protocols#ec2QueryName": "Associations", - "smithy.api#documentation": "

Information about the associations.

", - "smithy.api#xmlName": "associations" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetTransitGatewayRouteTablePropagations": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetTransitGatewayRouteTablePropagationsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetTransitGatewayRouteTablePropagationsResult" - }, - "traits": { - "smithy.api#documentation": "

Gets information about the route table propagations for the specified transit gateway route table.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "TransitGatewayRouteTablePropagations", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#GetTransitGatewayRouteTablePropagationsRequest": { - "type": "structure", - "members": { - "TransitGatewayRouteTableId": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the transit gateway route table.

", - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#TransitGatewayMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetTransitGatewayRouteTablePropagationsResult": { - "type": "structure", - "members": { - "TransitGatewayRouteTablePropagations": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTablePropagationList", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayRouteTablePropagations", - "smithy.api#documentation": "

Information about the route table propagations.

", - "smithy.api#xmlName": "transitGatewayRouteTablePropagations" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetVerifiedAccessEndpointPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetVerifiedAccessEndpointPolicyRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetVerifiedAccessEndpointPolicyResult" - }, - "traits": { - "smithy.api#documentation": "

Get the Verified Access policy associated with the endpoint.

" - } - }, - "com.amazonaws.ec2#GetVerifiedAccessEndpointPolicyRequest": { - "type": "structure", - "members": { - "VerifiedAccessEndpointId": { - "target": "com.amazonaws.ec2#VerifiedAccessEndpointId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Verified Access endpoint.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetVerifiedAccessEndpointPolicyResult": { - "type": "structure", - "members": { - "PolicyEnabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "PolicyEnabled", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

The status of the Verified Access policy.

", - "smithy.api#xmlName": "policyEnabled" - } - }, - "PolicyDocument": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PolicyDocument", - "smithy.api#documentation": "

The Verified Access policy document.

", - "smithy.api#xmlName": "policyDocument" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetVerifiedAccessGroupPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetVerifiedAccessGroupPolicyRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetVerifiedAccessGroupPolicyResult" - }, - "traits": { - "smithy.api#documentation": "

Shows the contents of the Verified Access policy associated with the group.

" - } - }, - "com.amazonaws.ec2#GetVerifiedAccessGroupPolicyRequest": { - "type": "structure", - "members": { - "VerifiedAccessGroupId": { - "target": "com.amazonaws.ec2#VerifiedAccessGroupId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Verified Access group.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetVerifiedAccessGroupPolicyResult": { - "type": "structure", - "members": { - "PolicyEnabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "PolicyEnabled", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

The status of the Verified Access policy.

", - "smithy.api#xmlName": "policyEnabled" - } - }, - "PolicyDocument": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PolicyDocument", - "smithy.api#documentation": "

The Verified Access policy document.

", - "smithy.api#xmlName": "policyDocument" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetVpnConnectionDeviceSampleConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetVpnConnectionDeviceSampleConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetVpnConnectionDeviceSampleConfigurationResult" - }, - "traits": { - "smithy.api#documentation": "

Download an Amazon Web Services-provided sample configuration file to be used with the customer\n gateway device specified for your Site-to-Site VPN connection.

" - } - }, - "com.amazonaws.ec2#GetVpnConnectionDeviceSampleConfigurationRequest": { - "type": "structure", - "members": { - "VpnConnectionId": { - "target": "com.amazonaws.ec2#VpnConnectionId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The VpnConnectionId specifies the Site-to-Site VPN connection used for the sample\n configuration.

", - "smithy.api#required": {} - } - }, - "VpnConnectionDeviceTypeId": { - "target": "com.amazonaws.ec2#VpnConnectionDeviceTypeId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Device identifier provided by the GetVpnConnectionDeviceTypes API.

", - "smithy.api#required": {} - } - }, - "InternetKeyExchangeVersion": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The IKE version to be used in the sample configuration file for your customer gateway\n device. You can specify one of the following versions: ikev1 or\n ikev2.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetVpnConnectionDeviceSampleConfigurationResult": { - "type": "structure", - "members": { - "VpnConnectionDeviceSampleConfiguration": { - "target": "com.amazonaws.ec2#VpnConnectionDeviceSampleConfiguration", - "traits": { - "aws.protocols#ec2QueryName": "VpnConnectionDeviceSampleConfiguration", - "smithy.api#documentation": "

Sample configuration file for the specified customer gateway device.

", - "smithy.api#xmlName": "vpnConnectionDeviceSampleConfiguration" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetVpnConnectionDeviceTypes": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetVpnConnectionDeviceTypesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetVpnConnectionDeviceTypesResult" - }, - "traits": { - "smithy.api#documentation": "

Obtain a list of customer gateway devices for which sample configuration\n files can be provided. The request has no additional parameters. You can also see the\n list of device types with sample configuration files available under Your customer gateway\n device in the Amazon Web Services Site-to-Site VPN User Guide.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "VpnConnectionDeviceTypes", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#GetVpnConnectionDeviceTypesRequest": { - "type": "structure", - "members": { - "MaxResults": { - "target": "com.amazonaws.ec2#GVCDMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results returned by GetVpnConnectionDeviceTypes in\n paginated output. When this parameter is used, GetVpnConnectionDeviceTypes\n only returns MaxResults results in a single page along with a\n NextToken response element. The remaining results of the initial\n request can be seen by sending another GetVpnConnectionDeviceTypes request\n with the returned NextToken value. This value can be between 200 and 1000.\n If this parameter is not used, then GetVpnConnectionDeviceTypes returns all\n results.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The NextToken value returned from a previous paginated\n GetVpnConnectionDeviceTypes request where MaxResults was\n used and the results exceeded the value of that parameter. Pagination continues from the\n end of the previous results that returned the NextToken value. This value\n is null when there are no more results to return.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetVpnConnectionDeviceTypesResult": { - "type": "structure", - "members": { - "VpnConnectionDeviceTypes": { - "target": "com.amazonaws.ec2#VpnConnectionDeviceTypeList", - "traits": { - "aws.protocols#ec2QueryName": "VpnConnectionDeviceTypeSet", - "smithy.api#documentation": "

List of customer gateway devices that have a sample configuration file available for\n use.

", - "smithy.api#xmlName": "vpnConnectionDeviceTypeSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The NextToken value to include in a future\n GetVpnConnectionDeviceTypes request. When the results of a\n GetVpnConnectionDeviceTypes request exceed MaxResults,\n this value can be used to retrieve the next page of results. This value is null when\n there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GetVpnTunnelReplacementStatus": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#GetVpnTunnelReplacementStatusRequest" - }, - "output": { - "target": "com.amazonaws.ec2#GetVpnTunnelReplacementStatusResult" - }, - "traits": { - "smithy.api#documentation": "

Get details of available tunnel endpoint maintenance.

" - } - }, - "com.amazonaws.ec2#GetVpnTunnelReplacementStatusRequest": { - "type": "structure", - "members": { - "VpnConnectionId": { - "target": "com.amazonaws.ec2#VpnConnectionId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Site-to-Site VPN connection.

", - "smithy.api#required": {} - } - }, - "VpnTunnelOutsideIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The external IP address of the VPN tunnel.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#GetVpnTunnelReplacementStatusResult": { - "type": "structure", - "members": { - "VpnConnectionId": { - "target": "com.amazonaws.ec2#VpnConnectionId", - "traits": { - "aws.protocols#ec2QueryName": "VpnConnectionId", - "smithy.api#documentation": "

The ID of the Site-to-Site VPN connection.

", - "smithy.api#xmlName": "vpnConnectionId" - } - }, - "TransitGatewayId": { - "target": "com.amazonaws.ec2#TransitGatewayId", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayId", - "smithy.api#documentation": "

The ID of the transit gateway associated with the VPN connection.

", - "smithy.api#xmlName": "transitGatewayId" - } - }, - "CustomerGatewayId": { - "target": "com.amazonaws.ec2#CustomerGatewayId", - "traits": { - "aws.protocols#ec2QueryName": "CustomerGatewayId", - "smithy.api#documentation": "

The ID of the customer gateway.

", - "smithy.api#xmlName": "customerGatewayId" - } - }, - "VpnGatewayId": { - "target": "com.amazonaws.ec2#VpnGatewayId", - "traits": { - "aws.protocols#ec2QueryName": "VpnGatewayId", - "smithy.api#documentation": "

The ID of the virtual private gateway.

", - "smithy.api#xmlName": "vpnGatewayId" - } - }, - "VpnTunnelOutsideIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpnTunnelOutsideIpAddress", - "smithy.api#documentation": "

The external IP address of the VPN tunnel.

", - "smithy.api#xmlName": "vpnTunnelOutsideIpAddress" - } - }, - "MaintenanceDetails": { - "target": "com.amazonaws.ec2#MaintenanceDetails", - "traits": { - "aws.protocols#ec2QueryName": "MaintenanceDetails", - "smithy.api#documentation": "

Get details of pending tunnel endpoint maintenance.

", - "smithy.api#xmlName": "maintenanceDetails" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#GpuDeviceCount": { - "type": "integer" - }, - "com.amazonaws.ec2#GpuDeviceInfo": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.ec2#GpuDeviceName", - "traits": { - "aws.protocols#ec2QueryName": "Name", - "smithy.api#documentation": "

The name of the GPU accelerator.

", - "smithy.api#xmlName": "name" - } - }, - "Manufacturer": { - "target": "com.amazonaws.ec2#GpuDeviceManufacturerName", - "traits": { - "aws.protocols#ec2QueryName": "Manufacturer", - "smithy.api#documentation": "

The manufacturer of the GPU accelerator.

", - "smithy.api#xmlName": "manufacturer" - } - }, - "Count": { - "target": "com.amazonaws.ec2#GpuDeviceCount", - "traits": { - "aws.protocols#ec2QueryName": "Count", - "smithy.api#documentation": "

The number of GPUs for the instance type.

", - "smithy.api#xmlName": "count" - } - }, - "MemoryInfo": { - "target": "com.amazonaws.ec2#GpuDeviceMemoryInfo", - "traits": { - "aws.protocols#ec2QueryName": "MemoryInfo", - "smithy.api#documentation": "

Describes the memory available to the GPU accelerator.

", - "smithy.api#xmlName": "memoryInfo" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the GPU accelerators for the instance type.

" - } - }, - "com.amazonaws.ec2#GpuDeviceInfoList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#GpuDeviceInfo", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#GpuDeviceManufacturerName": { - "type": "string" - }, - "com.amazonaws.ec2#GpuDeviceMemoryInfo": { - "type": "structure", - "members": { - "SizeInMiB": { - "target": "com.amazonaws.ec2#GpuDeviceMemorySize", - "traits": { - "aws.protocols#ec2QueryName": "SizeInMiB", - "smithy.api#documentation": "

The size of the memory available to the GPU accelerator, in MiB.

", - "smithy.api#xmlName": "sizeInMiB" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the memory available to the GPU accelerator.

" - } - }, - "com.amazonaws.ec2#GpuDeviceMemorySize": { - "type": "integer" - }, - "com.amazonaws.ec2#GpuDeviceName": { - "type": "string" - }, - "com.amazonaws.ec2#GpuInfo": { - "type": "structure", - "members": { - "Gpus": { - "target": "com.amazonaws.ec2#GpuDeviceInfoList", - "traits": { - "aws.protocols#ec2QueryName": "Gpus", - "smithy.api#documentation": "

Describes the GPU accelerators for the instance type.

", - "smithy.api#xmlName": "gpus" - } - }, - "TotalGpuMemoryInMiB": { - "target": "com.amazonaws.ec2#totalGpuMemory", - "traits": { - "aws.protocols#ec2QueryName": "TotalGpuMemoryInMiB", - "smithy.api#documentation": "

The total size of the memory for the GPU accelerators for the instance type, in MiB.

", - "smithy.api#xmlName": "totalGpuMemoryInMiB" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the GPU accelerators for the instance type.

" - } - }, - "com.amazonaws.ec2#GroupIdStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SecurityGroupId", - "traits": { - "smithy.api#xmlName": "groupId" - } - } - }, - "com.amazonaws.ec2#GroupIdentifier": { - "type": "structure", - "members": { - "GroupName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupName", - "smithy.api#documentation": "

The name of the security group.

", - "smithy.api#xmlName": "groupName" - } - }, - "GroupId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupId", - "smithy.api#documentation": "

The ID of the security group.

", - "smithy.api#xmlName": "groupId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a security group.

" - } - }, - "com.amazonaws.ec2#GroupIdentifierList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#GroupIdentifier", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#GroupIdentifierSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SecurityGroupIdentifier", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#GroupIds": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SecurityGroupId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#GroupNameStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SecurityGroupName", - "traits": { - "smithy.api#xmlName": "GroupName" - } - } - }, - "com.amazonaws.ec2#HibernationFlag": { - "type": "boolean" - }, - "com.amazonaws.ec2#HibernationOptions": { - "type": "structure", - "members": { - "Configured": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Configured", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

If this parameter is set to true, your instance is enabled for\n hibernation; otherwise, it is not enabled for hibernation.

", - "smithy.api#xmlName": "configured" - } - } - }, - "traits": { - "smithy.api#documentation": "

Indicates whether your instance is configured for hibernation. This parameter is valid\n only if the instance meets the hibernation\n prerequisites. For more information, see Hibernate your instance in the\n Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#HibernationOptionsRequest": { - "type": "structure", - "members": { - "Configured": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

If you set this parameter to true, your instance is enabled for\n hibernation.

\n

Default: false\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Indicates whether your instance is configured for hibernation. This parameter is valid\n only if the instance meets the hibernation\n prerequisites. For more information, see Hibernate your instance in the\n Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#HistoryRecord": { - "type": "structure", - "members": { - "EventInformation": { - "target": "com.amazonaws.ec2#EventInformation", - "traits": { - "aws.protocols#ec2QueryName": "EventInformation", - "smithy.api#documentation": "

Information about the event.

", - "smithy.api#xmlName": "eventInformation" - } - }, - "EventType": { - "target": "com.amazonaws.ec2#EventType", - "traits": { - "aws.protocols#ec2QueryName": "EventType", - "smithy.api#documentation": "

The event type.

\n ", - "smithy.api#xmlName": "eventType" - } - }, - "Timestamp": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "Timestamp", - "smithy.api#documentation": "

The date and time of the event, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", - "smithy.api#xmlName": "timestamp" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an event in the history of the Spot Fleet request.

" - } - }, - "com.amazonaws.ec2#HistoryRecordEntry": { - "type": "structure", - "members": { - "EventInformation": { - "target": "com.amazonaws.ec2#EventInformation", - "traits": { - "aws.protocols#ec2QueryName": "EventInformation", - "smithy.api#documentation": "

Information about the event.

", - "smithy.api#xmlName": "eventInformation" - } - }, - "EventType": { - "target": "com.amazonaws.ec2#FleetEventType", - "traits": { - "aws.protocols#ec2QueryName": "EventType", - "smithy.api#documentation": "

The event type.

", - "smithy.api#xmlName": "eventType" - } - }, - "Timestamp": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "Timestamp", - "smithy.api#documentation": "

The date and time of the event, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", - "smithy.api#xmlName": "timestamp" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an event in the history of an EC2 Fleet.

" - } - }, - "com.amazonaws.ec2#HistoryRecordSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#HistoryRecordEntry", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#HistoryRecords": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#HistoryRecord", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#Host": { - "type": "structure", - "members": { - "AutoPlacement": { - "target": "com.amazonaws.ec2#AutoPlacement", - "traits": { - "aws.protocols#ec2QueryName": "AutoPlacement", - "smithy.api#documentation": "

Whether auto-placement is on or off.

", - "smithy.api#xmlName": "autoPlacement" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone of the Dedicated Host.

", - "smithy.api#xmlName": "availabilityZone" - } - }, - "AvailableCapacity": { - "target": "com.amazonaws.ec2#AvailableCapacity", - "traits": { - "aws.protocols#ec2QueryName": "AvailableCapacity", - "smithy.api#documentation": "

Information about the instances running on the Dedicated Host.

", - "smithy.api#xmlName": "availableCapacity" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

", - "smithy.api#xmlName": "clientToken" - } - }, - "HostId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "HostId", - "smithy.api#documentation": "

The ID of the Dedicated Host.

", - "smithy.api#xmlName": "hostId" - } - }, - "HostProperties": { - "target": "com.amazonaws.ec2#HostProperties", - "traits": { - "aws.protocols#ec2QueryName": "HostProperties", - "smithy.api#documentation": "

The hardware specifications of the Dedicated Host.

", - "smithy.api#xmlName": "hostProperties" - } - }, - "HostReservationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "HostReservationId", - "smithy.api#documentation": "

The reservation ID of the Dedicated Host. This returns a null response if\n the Dedicated Host doesn't have an associated reservation.

", - "smithy.api#xmlName": "hostReservationId" - } - }, - "Instances": { - "target": "com.amazonaws.ec2#HostInstanceList", - "traits": { - "aws.protocols#ec2QueryName": "Instances", - "smithy.api#documentation": "

The IDs and instance type that are currently running on the Dedicated Host.

", - "smithy.api#xmlName": "instances" - } - }, - "State": { - "target": "com.amazonaws.ec2#AllocationState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The Dedicated Host's state.

", - "smithy.api#xmlName": "state" - } - }, - "AllocationTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "AllocationTime", - "smithy.api#documentation": "

The time that the Dedicated Host was allocated.

", - "smithy.api#xmlName": "allocationTime" - } - }, - "ReleaseTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "ReleaseTime", - "smithy.api#documentation": "

The time that the Dedicated Host was released.

", - "smithy.api#xmlName": "releaseTime" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the Dedicated Host.

", - "smithy.api#xmlName": "tagSet" - } - }, - "HostRecovery": { - "target": "com.amazonaws.ec2#HostRecovery", - "traits": { - "aws.protocols#ec2QueryName": "HostRecovery", - "smithy.api#documentation": "

Indicates whether host recovery is enabled or disabled for the Dedicated Host.

", - "smithy.api#xmlName": "hostRecovery" - } - }, - "AllowsMultipleInstanceTypes": { - "target": "com.amazonaws.ec2#AllowsMultipleInstanceTypes", - "traits": { - "aws.protocols#ec2QueryName": "AllowsMultipleInstanceTypes", - "smithy.api#documentation": "

Indicates whether the Dedicated Host supports multiple instance types of the same\n instance family. If the value is on, the Dedicated Host supports multiple\n instance types in the instance family. If the value is off, the Dedicated\n Host supports a single instance type only.

", - "smithy.api#xmlName": "allowsMultipleInstanceTypes" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the Dedicated Host.

", - "smithy.api#xmlName": "ownerId" - } - }, - "AvailabilityZoneId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZoneId", - "smithy.api#documentation": "

The ID of the Availability Zone in which the Dedicated Host is allocated.

", - "smithy.api#xmlName": "availabilityZoneId" - } - }, - "MemberOfServiceLinkedResourceGroup": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "MemberOfServiceLinkedResourceGroup", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the Dedicated Host is in a host resource group. If memberOfServiceLinkedResourceGroup is true, the\n host is in a host resource group; otherwise, it is not.

", - "smithy.api#xmlName": "memberOfServiceLinkedResourceGroup" - } - }, - "OutpostArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OutpostArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which the\n Dedicated Host is allocated.

", - "smithy.api#xmlName": "outpostArn" - } - }, - "HostMaintenance": { - "target": "com.amazonaws.ec2#HostMaintenance", - "traits": { - "aws.protocols#ec2QueryName": "HostMaintenance", - "smithy.api#documentation": "

Indicates whether host maintenance is enabled or disabled for the Dedicated\n Host.

", - "smithy.api#xmlName": "hostMaintenance" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the properties of the Dedicated Host.

" - } - }, - "com.amazonaws.ec2#HostInstance": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of instance that is running on the Dedicated Host.

", - "smithy.api#xmlName": "instanceId" - } - }, - "InstanceType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type (for example, m3.medium) of the running\n instance.

", - "smithy.api#xmlName": "instanceType" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the instance.

", - "smithy.api#xmlName": "ownerId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an instance running on a Dedicated Host.

" - } - }, - "com.amazonaws.ec2#HostInstanceList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#HostInstance", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#HostList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Host", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#HostMaintenance": { - "type": "enum", - "members": { - "on": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "on" - } - }, - "off": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "off" - } - } - } - }, - "com.amazonaws.ec2#HostOffering": { - "type": "structure", - "members": { - "CurrencyCode": { - "target": "com.amazonaws.ec2#CurrencyCodeValues", - "traits": { - "aws.protocols#ec2QueryName": "CurrencyCode", - "smithy.api#documentation": "

The currency of the offering.

", - "smithy.api#xmlName": "currencyCode" - } - }, - "Duration": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Duration", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The duration of the offering (in seconds).

", - "smithy.api#xmlName": "duration" - } - }, - "HourlyPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "HourlyPrice", - "smithy.api#documentation": "

The hourly price of the offering.

", - "smithy.api#xmlName": "hourlyPrice" - } - }, - "InstanceFamily": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceFamily", - "smithy.api#documentation": "

The instance family of the offering.

", - "smithy.api#xmlName": "instanceFamily" - } - }, - "OfferingId": { - "target": "com.amazonaws.ec2#OfferingId", - "traits": { - "aws.protocols#ec2QueryName": "OfferingId", - "smithy.api#documentation": "

The ID of the offering.

", - "smithy.api#xmlName": "offeringId" - } - }, - "PaymentOption": { - "target": "com.amazonaws.ec2#PaymentOption", - "traits": { - "aws.protocols#ec2QueryName": "PaymentOption", - "smithy.api#documentation": "

The available payment option.

", - "smithy.api#xmlName": "paymentOption" - } - }, - "UpfrontPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "UpfrontPrice", - "smithy.api#documentation": "

The upfront price of the offering. Does not apply to No Upfront offerings.

", - "smithy.api#xmlName": "upfrontPrice" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about the Dedicated Host Reservation offering.

" - } - }, - "com.amazonaws.ec2#HostOfferingSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#HostOffering", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#HostProperties": { - "type": "structure", - "members": { - "Cores": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Cores", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of cores on the Dedicated Host.

", - "smithy.api#xmlName": "cores" - } - }, - "InstanceType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type supported by the Dedicated Host. For example, m5.large.\n If the host supports multiple instance types, no instanceType is returned.

", - "smithy.api#xmlName": "instanceType" - } - }, - "InstanceFamily": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceFamily", - "smithy.api#documentation": "

The instance family supported by the Dedicated Host. For example,\n m5.

", - "smithy.api#xmlName": "instanceFamily" - } - }, - "Sockets": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Sockets", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of sockets on the Dedicated Host.

", - "smithy.api#xmlName": "sockets" - } - }, - "TotalVCpus": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "TotalVCpus", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The total number of vCPUs on the Dedicated Host.

", - "smithy.api#xmlName": "totalVCpus" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the properties of a Dedicated Host.

" - } - }, - "com.amazonaws.ec2#HostRecovery": { - "type": "enum", - "members": { - "on": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "on" - } - }, - "off": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "off" - } - } - } - }, - "com.amazonaws.ec2#HostReservation": { - "type": "structure", - "members": { - "Count": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Count", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of Dedicated Hosts the reservation is associated with.

", - "smithy.api#xmlName": "count" - } - }, - "CurrencyCode": { - "target": "com.amazonaws.ec2#CurrencyCodeValues", - "traits": { - "aws.protocols#ec2QueryName": "CurrencyCode", - "smithy.api#documentation": "

The currency in which the upfrontPrice and hourlyPrice\n amounts are specified. At this time, the only supported currency is\n USD.

", - "smithy.api#xmlName": "currencyCode" - } - }, - "Duration": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Duration", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The length of the reservation's term, specified in seconds. Can be 31536000 (1\n year) | 94608000 (3 years).

", - "smithy.api#xmlName": "duration" - } - }, - "End": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "End", - "smithy.api#documentation": "

The date and time that the reservation ends.

", - "smithy.api#xmlName": "end" - } - }, - "HostIdSet": { - "target": "com.amazonaws.ec2#ResponseHostIdSet", - "traits": { - "aws.protocols#ec2QueryName": "HostIdSet", - "smithy.api#documentation": "

The IDs of the Dedicated Hosts associated with the reservation.

", - "smithy.api#xmlName": "hostIdSet" - } - }, - "HostReservationId": { - "target": "com.amazonaws.ec2#HostReservationId", - "traits": { - "aws.protocols#ec2QueryName": "HostReservationId", - "smithy.api#documentation": "

The ID of the reservation that specifies the associated Dedicated Hosts.

", - "smithy.api#xmlName": "hostReservationId" - } - }, - "HourlyPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "HourlyPrice", - "smithy.api#documentation": "

The hourly price of the reservation.

", - "smithy.api#xmlName": "hourlyPrice" - } - }, - "InstanceFamily": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceFamily", - "smithy.api#documentation": "

The instance family of the Dedicated Host Reservation. The instance family on the\n Dedicated Host must be the same in order for it to benefit from the reservation.

", - "smithy.api#xmlName": "instanceFamily" - } - }, - "OfferingId": { - "target": "com.amazonaws.ec2#OfferingId", - "traits": { - "aws.protocols#ec2QueryName": "OfferingId", - "smithy.api#documentation": "

The ID of the reservation. This remains the same regardless of which Dedicated Hosts\n are associated with it.

", - "smithy.api#xmlName": "offeringId" - } - }, - "PaymentOption": { - "target": "com.amazonaws.ec2#PaymentOption", - "traits": { - "aws.protocols#ec2QueryName": "PaymentOption", - "smithy.api#documentation": "

The payment option selected for this reservation.

", - "smithy.api#xmlName": "paymentOption" - } - }, - "Start": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "Start", - "smithy.api#documentation": "

The date and time that the reservation started.

", - "smithy.api#xmlName": "start" - } - }, - "State": { - "target": "com.amazonaws.ec2#ReservationState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the reservation.

", - "smithy.api#xmlName": "state" - } - }, - "UpfrontPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "UpfrontPrice", - "smithy.api#documentation": "

The upfront price of the reservation.

", - "smithy.api#xmlName": "upfrontPrice" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the Dedicated Host Reservation.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about the Dedicated Host Reservation and associated Dedicated Hosts.

" - } - }, - "com.amazonaws.ec2#HostReservationId": { - "type": "string" - }, - "com.amazonaws.ec2#HostReservationIdSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#HostReservationId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#HostReservationSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#HostReservation", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#HostTenancy": { - "type": "enum", - "members": { - "dedicated": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "dedicated" - } - }, - "host": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "host" - } - } - } - }, - "com.amazonaws.ec2#HostnameType": { - "type": "enum", - "members": { - "ip_name": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ip-name" - } - }, - "resource_name": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "resource-name" - } - } - } - }, - "com.amazonaws.ec2#Hour": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 23 - } - } - }, - "com.amazonaws.ec2#HttpTokensState": { - "type": "enum", - "members": { - "optional": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "optional" - } - }, - "required": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "required" - } - } - } - }, - "com.amazonaws.ec2#HypervisorType": { - "type": "enum", - "members": { - "ovm": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ovm" - } - }, - "xen": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "xen" - } - } - } - }, - "com.amazonaws.ec2#IKEVersionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#IKEVersionsListValue", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#IKEVersionsListValue": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Value", - "smithy.api#documentation": "

The IKE version.

", - "smithy.api#xmlName": "value" - } - } - }, - "traits": { - "smithy.api#documentation": "

The internet key exchange (IKE) version permitted for the VPN tunnel.

" - } - }, - "com.amazonaws.ec2#IKEVersionsRequestList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#IKEVersionsRequestListValue", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#IKEVersionsRequestListValue": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The IKE version.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The IKE version that is permitted for the VPN tunnel.

" - } - }, - "com.amazonaws.ec2#IamInstanceProfile": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Arn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the instance profile.

", - "smithy.api#xmlName": "arn" - } - }, - "Id": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Id", - "smithy.api#documentation": "

The ID of the instance profile.

", - "smithy.api#xmlName": "id" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an IAM instance profile.

" - } - }, - "com.amazonaws.ec2#IamInstanceProfileAssociation": { - "type": "structure", - "members": { - "AssociationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AssociationId", - "smithy.api#documentation": "

The ID of the association.

", - "smithy.api#xmlName": "associationId" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#xmlName": "instanceId" - } - }, - "IamInstanceProfile": { - "target": "com.amazonaws.ec2#IamInstanceProfile", - "traits": { - "aws.protocols#ec2QueryName": "IamInstanceProfile", - "smithy.api#documentation": "

The IAM instance profile.

", - "smithy.api#xmlName": "iamInstanceProfile" - } - }, - "State": { - "target": "com.amazonaws.ec2#IamInstanceProfileAssociationState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the association.

", - "smithy.api#xmlName": "state" - } - }, - "Timestamp": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "Timestamp", - "smithy.api#documentation": "

The time the IAM instance profile was associated with the instance.

", - "smithy.api#xmlName": "timestamp" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an association between an IAM instance profile and an instance.

" - } - }, - "com.amazonaws.ec2#IamInstanceProfileAssociationId": { - "type": "string" - }, - "com.amazonaws.ec2#IamInstanceProfileAssociationSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#IamInstanceProfileAssociation", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#IamInstanceProfileAssociationState": { - "type": "enum", - "members": { - "ASSOCIATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "associating" - } - }, - "ASSOCIATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "associated" - } - }, - "DISASSOCIATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disassociating" - } - }, - "DISASSOCIATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disassociated" - } - } - } - }, - "com.amazonaws.ec2#IamInstanceProfileSpecification": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Arn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the instance profile.

", - "smithy.api#xmlName": "arn" - } - }, - "Name": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Name", - "smithy.api#documentation": "

The name of the instance profile.

", - "smithy.api#xmlName": "name" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an IAM instance profile.

" - } - }, - "com.amazonaws.ec2#IcmpTypeCode": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The ICMP code. A value of -1 means all codes for the specified ICMP type.

", - "smithy.api#xmlName": "code" - } - }, - "Type": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Type", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The ICMP type. A value of -1 means all types.

", - "smithy.api#xmlName": "type" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the ICMP type and code.

" - } - }, - "com.amazonaws.ec2#IdFormat": { - "type": "structure", - "members": { - "Deadline": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "Deadline", - "smithy.api#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.

", - "smithy.api#xmlName": "deadline" - } - }, - "Resource": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Resource", - "smithy.api#documentation": "

The type of resource.

", - "smithy.api#xmlName": "resource" - } - }, - "UseLongIds": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "UseLongIds", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether longer IDs (17-character IDs) are enabled for the resource.

", - "smithy.api#xmlName": "useLongIds" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the ID format for a resource.

" - } - }, - "com.amazonaws.ec2#IdFormatList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#IdFormat", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#Igmpv2SupportValue": { - "type": "enum", - "members": { - "enable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enable" - } - }, - "disable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disable" - } - } - } - }, - "com.amazonaws.ec2#Image": { - "type": "structure", - "members": { - "Architecture": { - "target": "com.amazonaws.ec2#ArchitectureValues", - "traits": { - "aws.protocols#ec2QueryName": "Architecture", - "smithy.api#documentation": "

The architecture of the image.

", - "smithy.api#xmlName": "architecture" - } - }, - "CreationDate": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CreationDate", - "smithy.api#documentation": "

The date and time the image was created.

", - "smithy.api#xmlName": "creationDate" - } - }, - "ImageId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ImageId", - "smithy.api#documentation": "

The ID of the AMI.

", - "smithy.api#xmlName": "imageId" - } - }, - "ImageLocation": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ImageLocation", - "smithy.api#documentation": "

The location of the AMI.

", - "smithy.api#xmlName": "imageLocation" - } - }, - "ImageType": { - "target": "com.amazonaws.ec2#ImageTypeValues", - "traits": { - "aws.protocols#ec2QueryName": "ImageType", - "smithy.api#documentation": "

The type of image.

", - "smithy.api#xmlName": "imageType" - } - }, - "Public": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "IsPublic", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the image has public launch permissions. The value is true if\n\t\t\t\tthis image has public launch permissions or false\n\t\t\t\tif it has only implicit and explicit launch permissions.

", - "smithy.api#xmlName": "isPublic" - } - }, - "KernelId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "KernelId", - "smithy.api#documentation": "

The kernel associated with the image, if any. Only applicable for machine images.

", - "smithy.api#xmlName": "kernelId" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ImageOwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the image.

", - "smithy.api#xmlName": "imageOwnerId" - } - }, - "Platform": { - "target": "com.amazonaws.ec2#PlatformValues", - "traits": { - "aws.protocols#ec2QueryName": "Platform", - "smithy.api#documentation": "

This value is set to windows for Windows AMIs; otherwise, it is blank.

", - "smithy.api#xmlName": "platform" - } - }, - "PlatformDetails": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PlatformDetails", - "smithy.api#documentation": "

The platform details associated with the billing code of the AMI. For more information,\n see Understand\n AMI billing information in the Amazon EC2 User Guide.

", - "smithy.api#xmlName": "platformDetails" - } - }, - "UsageOperation": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "UsageOperation", - "smithy.api#documentation": "

The operation of the Amazon EC2 instance and the billing code that is associated with the AMI.\n usageOperation corresponds to the lineitem/Operation column on your Amazon Web Services Cost and Usage Report and in the Amazon Web Services Price\n \tList API. You can view these fields on the Instances or \n \tAMIs pages in the Amazon EC2 console, or in the responses that are \n \treturned by the DescribeImages \n \tcommand in the Amazon EC2 API, or the describe-images \n \tcommand in the CLI.

", - "smithy.api#xmlName": "usageOperation" - } - }, - "ProductCodes": { - "target": "com.amazonaws.ec2#ProductCodeList", - "traits": { - "aws.protocols#ec2QueryName": "ProductCodes", - "smithy.api#documentation": "

Any product codes associated with the AMI.

", - "smithy.api#xmlName": "productCodes" - } - }, - "RamdiskId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "RamdiskId", - "smithy.api#documentation": "

The RAM disk associated with the image, if any. Only applicable for machine images.

", - "smithy.api#xmlName": "ramdiskId" - } - }, - "State": { - "target": "com.amazonaws.ec2#ImageState", - "traits": { - "aws.protocols#ec2QueryName": "ImageState", - "smithy.api#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.

", - "smithy.api#xmlName": "imageState" - } - }, - "BlockDeviceMappings": { - "target": "com.amazonaws.ec2#BlockDeviceMappingList", - "traits": { - "aws.protocols#ec2QueryName": "BlockDeviceMapping", - "smithy.api#documentation": "

Any block device mapping entries.

", - "smithy.api#xmlName": "blockDeviceMapping" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

The description of the AMI that was provided during image creation.

", - "smithy.api#xmlName": "description" - } - }, - "EnaSupport": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "EnaSupport", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether enhanced networking with ENA is enabled.

", - "smithy.api#xmlName": "enaSupport" - } - }, - "Hypervisor": { - "target": "com.amazonaws.ec2#HypervisorType", - "traits": { - "aws.protocols#ec2QueryName": "Hypervisor", - "smithy.api#documentation": "

The hypervisor type of the image.

", - "smithy.api#xmlName": "hypervisor" - } - }, - "ImageOwnerAlias": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ImageOwnerAlias", - "smithy.api#documentation": "

The Amazon Web Services account alias (for example, amazon, self) or\n the Amazon Web Services account ID of the AMI owner.

", - "smithy.api#xmlName": "imageOwnerAlias" - } - }, - "Name": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Name", - "smithy.api#documentation": "

The name of the AMI that was provided during image creation.

", - "smithy.api#xmlName": "name" - } - }, - "RootDeviceName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "RootDeviceName", - "smithy.api#documentation": "

The device name of the root device volume (for example, /dev/sda1).

", - "smithy.api#xmlName": "rootDeviceName" - } - }, - "RootDeviceType": { - "target": "com.amazonaws.ec2#DeviceType", - "traits": { - "aws.protocols#ec2QueryName": "RootDeviceType", - "smithy.api#documentation": "

The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.

", - "smithy.api#xmlName": "rootDeviceType" - } - }, - "SriovNetSupport": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SriovNetSupport", - "smithy.api#documentation": "

Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

", - "smithy.api#xmlName": "sriovNetSupport" - } - }, - "StateReason": { - "target": "com.amazonaws.ec2#StateReason", - "traits": { - "aws.protocols#ec2QueryName": "StateReason", - "smithy.api#documentation": "

The reason for the state change.

", - "smithy.api#xmlName": "stateReason" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the image.

", - "smithy.api#xmlName": "tagSet" - } - }, - "VirtualizationType": { - "target": "com.amazonaws.ec2#VirtualizationType", - "traits": { - "aws.protocols#ec2QueryName": "VirtualizationType", - "smithy.api#documentation": "

The type of virtualization of the AMI.

", - "smithy.api#xmlName": "virtualizationType" - } - }, - "BootMode": { - "target": "com.amazonaws.ec2#BootModeValues", - "traits": { - "aws.protocols#ec2QueryName": "BootMode", - "smithy.api#documentation": "

The boot mode of the image. For more information, see Boot modes in the\n Amazon EC2 User Guide.

", - "smithy.api#xmlName": "bootMode" - } - }, - "TpmSupport": { - "target": "com.amazonaws.ec2#TpmSupportValues", - "traits": { - "aws.protocols#ec2QueryName": "TpmSupport", - "smithy.api#documentation": "

If the image is configured for NitroTPM support, the value is v2.0. \n For more information, see NitroTPM in the\n Amazon EC2 User Guide.

", - "smithy.api#xmlName": "tpmSupport" - } - }, - "DeprecationTime": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DeprecationTime", - "smithy.api#documentation": "

The date and time to deprecate the AMI, in UTC, in the following format: \n YYYY-MM-DDTHH:MM:SSZ.\n If you specified a value for seconds, Amazon EC2 rounds the seconds to the\n nearest minute.

", - "smithy.api#xmlName": "deprecationTime" - } - }, - "ImdsSupport": { - "target": "com.amazonaws.ec2#ImdsSupportValues", - "traits": { - "aws.protocols#ec2QueryName": "ImdsSupport", - "smithy.api#documentation": "

If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched\n from this AMI will have HttpTokens automatically set to required so\n that, by default, the instance requires that IMDSv2 is used when requesting instance metadata.\n In addition, HttpPutResponseHopLimit is set to 2. For more\n information, see Configure\n the AMI in the Amazon EC2 User Guide.

", - "smithy.api#xmlName": "imdsSupport" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an image.

" - } - }, - "com.amazonaws.ec2#ImageAttribute": { - "type": "structure", - "members": { - "BlockDeviceMappings": { - "target": "com.amazonaws.ec2#BlockDeviceMappingList", - "traits": { - "aws.protocols#ec2QueryName": "BlockDeviceMapping", - "smithy.api#documentation": "

The block device mapping entries.

", - "smithy.api#xmlName": "blockDeviceMapping" - } - }, - "ImageId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ImageId", - "smithy.api#documentation": "

The ID of the AMI.

", - "smithy.api#xmlName": "imageId" - } - }, - "LaunchPermissions": { - "target": "com.amazonaws.ec2#LaunchPermissionList", - "traits": { - "aws.protocols#ec2QueryName": "LaunchPermission", - "smithy.api#documentation": "

The launch permissions.

", - "smithy.api#xmlName": "launchPermission" - } - }, - "ProductCodes": { - "target": "com.amazonaws.ec2#ProductCodeList", - "traits": { - "aws.protocols#ec2QueryName": "ProductCodes", - "smithy.api#documentation": "

The product codes.

", - "smithy.api#xmlName": "productCodes" - } - }, - "Description": { - "target": "com.amazonaws.ec2#AttributeValue", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description for the AMI.

", - "smithy.api#xmlName": "description" - } - }, - "KernelId": { - "target": "com.amazonaws.ec2#AttributeValue", - "traits": { - "aws.protocols#ec2QueryName": "Kernel", - "smithy.api#documentation": "

The kernel ID.

", - "smithy.api#xmlName": "kernel" - } - }, - "RamdiskId": { - "target": "com.amazonaws.ec2#AttributeValue", - "traits": { - "aws.protocols#ec2QueryName": "Ramdisk", - "smithy.api#documentation": "

The RAM disk ID.

", - "smithy.api#xmlName": "ramdisk" - } - }, - "SriovNetSupport": { - "target": "com.amazonaws.ec2#AttributeValue", - "traits": { - "aws.protocols#ec2QueryName": "SriovNetSupport", - "smithy.api#documentation": "

Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

", - "smithy.api#xmlName": "sriovNetSupport" - } - }, - "BootMode": { - "target": "com.amazonaws.ec2#AttributeValue", - "traits": { - "aws.protocols#ec2QueryName": "BootMode", - "smithy.api#documentation": "

The boot mode.

", - "smithy.api#xmlName": "bootMode" - } - }, - "TpmSupport": { - "target": "com.amazonaws.ec2#AttributeValue", - "traits": { - "aws.protocols#ec2QueryName": "TpmSupport", - "smithy.api#documentation": "

If the image is configured for NitroTPM support, the value is v2.0.

", - "smithy.api#xmlName": "tpmSupport" - } - }, - "UefiData": { - "target": "com.amazonaws.ec2#AttributeValue", - "traits": { - "aws.protocols#ec2QueryName": "UefiData", - "smithy.api#documentation": "

Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data,\n use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the\n python-uefivars tool on\n GitHub. For more information, see UEFI Secure Boot in the\n Amazon EC2 User Guide.

", - "smithy.api#xmlName": "uefiData" - } - }, - "LastLaunchedTime": { - "target": "com.amazonaws.ec2#AttributeValue", - "traits": { - "aws.protocols#ec2QueryName": "LastLaunchedTime", - "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the AMI was last used to launch an EC2 instance. When the AMI is used\n to launch an instance, there is a 24-hour delay before that usage is reported.

\n \n

\n lastLaunchedTime data is available starting April 2017.

\n ", - "smithy.api#xmlName": "lastLaunchedTime" - } - }, - "ImdsSupport": { - "target": "com.amazonaws.ec2#AttributeValue", - "traits": { - "aws.protocols#ec2QueryName": "ImdsSupport", - "smithy.api#documentation": "

If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched\n from this AMI will have HttpTokens automatically set to required so\n that, by default, the instance requires that IMDSv2 is used when requesting instance metadata.\n In addition, HttpPutResponseHopLimit is set to 2. For more\n information, see Configure\n the AMI in the Amazon EC2 User Guide.

", - "smithy.api#xmlName": "imdsSupport" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an image attribute.

" - } - }, - "com.amazonaws.ec2#ImageAttributeName": { - "type": "enum", - "members": { - "description": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "description" - } - }, - "kernel": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "kernel" - } - }, - "ramdisk": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ramdisk" - } - }, - "launchPermission": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "launchPermission" - } - }, - "productCodes": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "productCodes" - } - }, - "blockDeviceMapping": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "blockDeviceMapping" - } - }, - "sriovNetSupport": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "sriovNetSupport" - } - }, - "bootMode": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "bootMode" - } - }, - "tpmSupport": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "tpmSupport" - } - }, - "uefiData": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "uefiData" - } - }, - "lastLaunchedTime": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "lastLaunchedTime" - } - }, - "imdsSupport": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "imdsSupport" - } - } - } - }, - "com.amazonaws.ec2#ImageDiskContainer": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The description of the disk image.

" - } - }, - "DeviceName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The block device mapping for the disk.

" - } - }, - "Format": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The format of the disk image being imported.

\n

Valid values: OVA | VHD | VHDX | VMDK | RAW\n

" - } - }, - "SnapshotId": { - "target": "com.amazonaws.ec2#SnapshotId", - "traits": { - "smithy.api#documentation": "

The ID of the EBS snapshot to be used for importing the snapshot.

" - } - }, - "Url": { - "target": "com.amazonaws.ec2#SensitiveUrl", - "traits": { - "smithy.api#documentation": "

The URL to the Amazon S3-based disk image being imported. The URL can either be a https URL (https://..) or an\n Amazon S3 URL (s3://..)

" - } - }, - "UserBucket": { - "target": "com.amazonaws.ec2#UserBucket", - "traits": { - "smithy.api#documentation": "

The S3 bucket for the disk image.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the disk container object for an import image task.

" - } - }, - "com.amazonaws.ec2#ImageDiskContainerList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ImageDiskContainer", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ImageId": { - "type": "string" - }, - "com.amazonaws.ec2#ImageIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ImageId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ImageIdStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ImageId", - "traits": { - "smithy.api#xmlName": "ImageId" - } - } - }, - "com.amazonaws.ec2#ImageList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Image", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ImageRecycleBinInfo": { - "type": "structure", - "members": { - "ImageId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ImageId", - "smithy.api#documentation": "

The ID of the AMI.

", - "smithy.api#xmlName": "imageId" - } - }, - "Name": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Name", - "smithy.api#documentation": "

The name of the AMI.

", - "smithy.api#xmlName": "name" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

The description of the AMI.

", - "smithy.api#xmlName": "description" - } - }, - "RecycleBinEnterTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "RecycleBinEnterTime", - "smithy.api#documentation": "

The date and time when the AMI entered the Recycle Bin.

", - "smithy.api#xmlName": "recycleBinEnterTime" - } - }, - "RecycleBinExitTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "RecycleBinExitTime", - "smithy.api#documentation": "

The date and time when the AMI is to be permanently deleted from the Recycle Bin.

", - "smithy.api#xmlName": "recycleBinExitTime" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about an AMI that is currently in the Recycle Bin.

" - } - }, - "com.amazonaws.ec2#ImageRecycleBinInfoList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ImageRecycleBinInfo", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ImageState": { - "type": "enum", - "members": { - "pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "available": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "available" - } - }, - "invalid": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "invalid" - } - }, - "deregistered": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deregistered" - } - }, - "transient": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "transient" - } - }, - "failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failed" - } - }, - "error": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "error" - } - } - } - }, - "com.amazonaws.ec2#ImageTypeValues": { - "type": "enum", - "members": { - "machine": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "machine" - } - }, - "kernel": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "kernel" - } - }, - "ramdisk": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ramdisk" - } - } - } - }, - "com.amazonaws.ec2#ImdsSupportValues": { - "type": "enum", - "members": { - "v2_0": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "v2.0" - } - } - } - }, - "com.amazonaws.ec2#ImportClientVpnClientCertificateRevocationList": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ImportClientVpnClientCertificateRevocationListRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ImportClientVpnClientCertificateRevocationListResult" - }, - "traits": { - "smithy.api#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.

\n

Uploading a client certificate revocation list resets existing client connections.

" - } - }, - "com.amazonaws.ec2#ImportClientVpnClientCertificateRevocationListRequest": { - "type": "structure", - "members": { - "ClientVpnEndpointId": { - "target": "com.amazonaws.ec2#ClientVpnEndpointId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Client VPN endpoint to which the client certificate revocation list applies.

", - "smithy.api#required": {} - } - }, - "CertificateRevocationList": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The client certificate revocation list file. For more information, see Generate a Client Certificate Revocation List in the\n\t\t\t\tClient VPN Administrator Guide.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ImportClientVpnClientCertificateRevocationListResult": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ImportImage": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ImportImageRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ImportImageResult" - }, - "traits": { - "smithy.api#documentation": "\n

To import your virtual machines (VMs) with a console-based experience, you can use the\n Import virtual machine images to Amazon Web Services template in the Migration Hub Orchestrator console. For more\n information, see the \n Migration Hub Orchestrator User Guide\n .

\n \n

Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).

\n \n

Amazon Web Services VM Import/Export strongly recommends specifying a value for either the\n --license-type or --usage-operation parameter when you create a new\n VM Import task. This ensures your operating system is licensed appropriately and your billing is\n optimized.

\n \n

For more information, see Importing a \n VM as an image using VM Import/Export in the VM Import/Export User Guide.

" - } - }, - "com.amazonaws.ec2#ImportImageLicenseConfigurationRequest": { - "type": "structure", - "members": { - "LicenseConfigurationArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The ARN of a license configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The request information of license configurations.

" - } - }, - "com.amazonaws.ec2#ImportImageLicenseConfigurationResponse": { - "type": "structure", - "members": { - "LicenseConfigurationArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LicenseConfigurationArn", - "smithy.api#documentation": "

The ARN of a license configuration.

", - "smithy.api#xmlName": "licenseConfigurationArn" - } - } - }, - "traits": { - "smithy.api#documentation": "

The response information for license configurations.

" - } - }, - "com.amazonaws.ec2#ImportImageLicenseSpecificationListRequest": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ImportImageLicenseConfigurationRequest", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ImportImageLicenseSpecificationListResponse": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ImportImageLicenseConfigurationResponse", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ImportImageRequest": { - "type": "structure", - "members": { - "Architecture": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The architecture of the virtual machine.

\n

Valid values: i386 | x86_64\n

" - } - }, - "ClientData": { - "target": "com.amazonaws.ec2#ClientData", - "traits": { - "smithy.api#documentation": "

The client-specific data.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token to enable idempotency for VM import requests.

" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A description string for the import image task.

" - } - }, - "DiskContainers": { - "target": "com.amazonaws.ec2#ImageDiskContainerList", - "traits": { - "smithy.api#documentation": "

Information about the disk containers.

", - "smithy.api#xmlName": "DiskContainer" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "Encrypted": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether the destination AMI of the imported image should be encrypted. The default KMS key for EBS is used\n unless you specify a non-default KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the\n Amazon Elastic Compute Cloud User Guide.

" - } - }, - "Hypervisor": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The target hypervisor platform.

\n

Valid values: xen\n

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.ec2#KmsKeyId", - "traits": { - "smithy.api#documentation": "

An identifier for the symmetric KMS key to use when creating the\n encrypted AMI. This parameter is only required if you want to use a non-default KMS key; if this\n parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is\n specified, the Encrypted flag must also be set.

\n

The KMS key identifier may be provided in any of the following formats:

\n \n

Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even\n though you provided an invalid identifier. This action will eventually report failure.

\n

The specified KMS key must exist in the Region that the AMI is being copied to.

\n

Amazon EBS does not support asymmetric KMS keys.

" - } - }, - "LicenseType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The license type to be used for the Amazon Machine Image (AMI) after importing.

\n

Specify AWS to replace the source-system license with an Amazon Web Services\n license or BYOL to retain the source-system license. Leaving this parameter\n undefined is the same as choosing AWS when importing a Windows Server operating\n system, and the same as choosing BYOL when importing a Windows client operating\n system (such as Windows 10) or a Linux operating system.

\n

To use BYOL, you must have existing licenses with rights to use these licenses in a third party\n cloud, such as Amazon Web Services. For more information, see Prerequisites in the\n VM Import/Export User Guide.

" - } - }, - "Platform": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The operating system of the virtual machine.

\n

Valid values: Windows | Linux\n

" - } - }, - "RoleName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The name of the role to use when not using the default role, 'vmimport'.

" - } - }, - "LicenseSpecifications": { - "target": "com.amazonaws.ec2#ImportImageLicenseSpecificationListRequest", - "traits": { - "smithy.api#documentation": "

The ARNs of the license configurations.

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the import image task during creation.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "UsageOperation": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The usage operation value. For more information, see Licensing options in the VM Import/Export User Guide.

" - } - }, - "BootMode": { - "target": "com.amazonaws.ec2#BootModeValues", - "traits": { - "smithy.api#documentation": "

The boot mode of the virtual machine.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ImportImageResult": { - "type": "structure", - "members": { - "Architecture": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Architecture", - "smithy.api#documentation": "

The architecture of the virtual machine.

", - "smithy.api#xmlName": "architecture" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description of the import task.

", - "smithy.api#xmlName": "description" - } - }, - "Encrypted": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Encrypted", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the AMI is encrypted.

", - "smithy.api#xmlName": "encrypted" - } - }, - "Hypervisor": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Hypervisor", - "smithy.api#documentation": "

The target hypervisor of the import task.

", - "smithy.api#xmlName": "hypervisor" - } - }, - "ImageId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ImageId", - "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI) created by the import task.

", - "smithy.api#xmlName": "imageId" - } - }, - "ImportTaskId": { - "target": "com.amazonaws.ec2#ImportImageTaskId", - "traits": { - "aws.protocols#ec2QueryName": "ImportTaskId", - "smithy.api#documentation": "

The task ID of the import image task.

", - "smithy.api#xmlName": "importTaskId" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.ec2#KmsKeyId", - "traits": { - "aws.protocols#ec2QueryName": "KmsKeyId", - "smithy.api#documentation": "

The identifier for the symmetric KMS key that was used to create the encrypted AMI.

", - "smithy.api#xmlName": "kmsKeyId" - } - }, - "LicenseType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LicenseType", - "smithy.api#documentation": "

The license type of the virtual machine.

", - "smithy.api#xmlName": "licenseType" - } - }, - "Platform": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Platform", - "smithy.api#documentation": "

The operating system of the virtual machine.

", - "smithy.api#xmlName": "platform" - } - }, - "Progress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Progress", - "smithy.api#documentation": "

The progress of the task.

", - "smithy.api#xmlName": "progress" - } - }, - "SnapshotDetails": { - "target": "com.amazonaws.ec2#SnapshotDetailList", - "traits": { - "aws.protocols#ec2QueryName": "SnapshotDetailSet", - "smithy.api#documentation": "

Information about the snapshots.

", - "smithy.api#xmlName": "snapshotDetailSet" - } - }, - "Status": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

A brief status of the task.

", - "smithy.api#xmlName": "status" - } - }, - "StatusMessage": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StatusMessage", - "smithy.api#documentation": "

A detailed status message of the import task.

", - "smithy.api#xmlName": "statusMessage" - } - }, - "LicenseSpecifications": { - "target": "com.amazonaws.ec2#ImportImageLicenseSpecificationListResponse", - "traits": { - "aws.protocols#ec2QueryName": "LicenseSpecifications", - "smithy.api#documentation": "

The ARNs of the license configurations.

", - "smithy.api#xmlName": "licenseSpecifications" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the import image task.

", - "smithy.api#xmlName": "tagSet" - } - }, - "UsageOperation": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "UsageOperation", - "smithy.api#documentation": "

The usage operation value.

", - "smithy.api#xmlName": "usageOperation" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ImportImageTask": { - "type": "structure", - "members": { - "Architecture": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Architecture", - "smithy.api#documentation": "

The architecture of the virtual machine.

\n

Valid values: i386 | x86_64 | arm64\n

", - "smithy.api#xmlName": "architecture" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description of the import task.

", - "smithy.api#xmlName": "description" - } - }, - "Encrypted": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Encrypted", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the image is encrypted.

", - "smithy.api#xmlName": "encrypted" - } - }, - "Hypervisor": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Hypervisor", - "smithy.api#documentation": "

The target hypervisor for the import task.

\n

Valid values: xen\n

", - "smithy.api#xmlName": "hypervisor" - } - }, - "ImageId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ImageId", - "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI) of the imported virtual machine.

", - "smithy.api#xmlName": "imageId" - } - }, - "ImportTaskId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ImportTaskId", - "smithy.api#documentation": "

The ID of the import image task.

", - "smithy.api#xmlName": "importTaskId" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "KmsKeyId", - "smithy.api#documentation": "

The identifier for the KMS key that was used to create the encrypted image.

", - "smithy.api#xmlName": "kmsKeyId" - } - }, - "LicenseType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LicenseType", - "smithy.api#documentation": "

The license type of the virtual machine.

", - "smithy.api#xmlName": "licenseType" - } - }, - "Platform": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Platform", - "smithy.api#documentation": "

The description string for the import image task.

", - "smithy.api#xmlName": "platform" - } - }, - "Progress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Progress", - "smithy.api#documentation": "

The percentage of progress of the import image task.

", - "smithy.api#xmlName": "progress" - } - }, - "SnapshotDetails": { - "target": "com.amazonaws.ec2#SnapshotDetailList", - "traits": { - "aws.protocols#ec2QueryName": "SnapshotDetailSet", - "smithy.api#documentation": "

Information about the snapshots.

", - "smithy.api#xmlName": "snapshotDetailSet" - } - }, - "Status": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

A brief status for the import image task.

", - "smithy.api#xmlName": "status" - } - }, - "StatusMessage": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StatusMessage", - "smithy.api#documentation": "

A descriptive status message for the import image task.

", - "smithy.api#xmlName": "statusMessage" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags for the import image task.

", - "smithy.api#xmlName": "tagSet" - } - }, - "LicenseSpecifications": { - "target": "com.amazonaws.ec2#ImportImageLicenseSpecificationListResponse", - "traits": { - "aws.protocols#ec2QueryName": "LicenseSpecifications", - "smithy.api#documentation": "

The ARNs of the license configurations that are associated with the import image task.

", - "smithy.api#xmlName": "licenseSpecifications" - } - }, - "UsageOperation": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "UsageOperation", - "smithy.api#documentation": "

The usage operation value.

", - "smithy.api#xmlName": "usageOperation" - } - }, - "BootMode": { - "target": "com.amazonaws.ec2#BootModeValues", - "traits": { - "aws.protocols#ec2QueryName": "BootMode", - "smithy.api#documentation": "

The boot mode of the virtual machine.

", - "smithy.api#xmlName": "bootMode" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an import image task.

" - } - }, - "com.amazonaws.ec2#ImportImageTaskId": { - "type": "string" - }, - "com.amazonaws.ec2#ImportImageTaskList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ImportImageTask", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ImportInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ImportInstanceRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ImportInstanceResult" - }, - "traits": { - "smithy.api#documentation": "

Creates an import instance task using metadata from the specified disk image.

\n

This API action supports only single-volume VMs. To import multi-volume VMs, use ImportImage\n instead.

\n

This API action is not supported by the Command Line Interface (CLI). For \n information about using the Amazon EC2 CLI, which is deprecated, see\n Importing a VM to Amazon EC2 in the Amazon EC2 CLI Reference PDF file.

\n

For information about the import manifest referenced by this API action, see VM Import Manifest.

" - } - }, - "com.amazonaws.ec2#ImportInstanceLaunchSpecification": { - "type": "structure", - "members": { - "AdditionalInfo": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AdditionalInfo", - "smithy.api#documentation": "

Reserved.

", - "smithy.api#xmlName": "additionalInfo" - } - }, - "Architecture": { - "target": "com.amazonaws.ec2#ArchitectureValues", - "traits": { - "aws.protocols#ec2QueryName": "Architecture", - "smithy.api#documentation": "

The architecture of the instance.

", - "smithy.api#xmlName": "architecture" - } - }, - "GroupIds": { - "target": "com.amazonaws.ec2#SecurityGroupIdStringList", - "traits": { - "smithy.api#documentation": "

The security group IDs.

", - "smithy.api#xmlName": "GroupId" - } - }, - "GroupNames": { - "target": "com.amazonaws.ec2#SecurityGroupStringList", - "traits": { - "smithy.api#documentation": "

The security group names.

", - "smithy.api#xmlName": "GroupName" - } - }, - "InstanceInitiatedShutdownBehavior": { - "target": "com.amazonaws.ec2#ShutdownBehavior", - "traits": { - "aws.protocols#ec2QueryName": "InstanceInitiatedShutdownBehavior", - "smithy.api#documentation": "

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the\n operating system command for system shutdown).

", - "smithy.api#xmlName": "instanceInitiatedShutdownBehavior" - } - }, - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type. For more information about the instance types that you can import, see Instance Types in the\n VM Import/Export User Guide.

", - "smithy.api#xmlName": "instanceType" - } - }, - "Monitoring": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Monitoring", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether monitoring is enabled.

", - "smithy.api#xmlName": "monitoring" - } - }, - "Placement": { - "target": "com.amazonaws.ec2#Placement", - "traits": { - "aws.protocols#ec2QueryName": "Placement", - "smithy.api#documentation": "

The placement information for the instance.

", - "smithy.api#xmlName": "placement" - } - }, - "PrivateIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrivateIpAddress", - "smithy.api#documentation": "

[EC2-VPC] An available IP address from the IP address range of the subnet.

", - "smithy.api#xmlName": "privateIpAddress" - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#SubnetId", - "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#documentation": "

[EC2-VPC] The ID of the subnet in which to launch the instance.

", - "smithy.api#xmlName": "subnetId" - } - }, - "UserData": { - "target": "com.amazonaws.ec2#UserData", - "traits": { - "aws.protocols#ec2QueryName": "UserData", - "smithy.api#documentation": "

The Base64-encoded user data to make available to the instance.

", - "smithy.api#xmlName": "userData" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the launch specification for VM import.

" - } - }, - "com.amazonaws.ec2#ImportInstanceRequest": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description for the instance being imported.

", - "smithy.api#xmlName": "description" - } - }, - "DiskImages": { - "target": "com.amazonaws.ec2#DiskImageList", - "traits": { - "aws.protocols#ec2QueryName": "DiskImage", - "smithy.api#documentation": "

The disk image.

", - "smithy.api#xmlName": "diskImage" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "LaunchSpecification": { - "target": "com.amazonaws.ec2#ImportInstanceLaunchSpecification", - "traits": { - "aws.protocols#ec2QueryName": "LaunchSpecification", - "smithy.api#documentation": "

The launch specification.

", - "smithy.api#xmlName": "launchSpecification" - } - }, - "Platform": { - "target": "com.amazonaws.ec2#PlatformValues", - "traits": { - "aws.protocols#ec2QueryName": "Platform", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The instance operating system.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "platform" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ImportInstanceResult": { - "type": "structure", - "members": { - "ConversionTask": { - "target": "com.amazonaws.ec2#ConversionTask", - "traits": { - "aws.protocols#ec2QueryName": "ConversionTask", - "smithy.api#documentation": "

Information about the conversion task.

", - "smithy.api#xmlName": "conversionTask" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ImportInstanceTaskDetails": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description of the task.

", - "smithy.api#xmlName": "description" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#xmlName": "instanceId" - } - }, - "Platform": { - "target": "com.amazonaws.ec2#PlatformValues", - "traits": { - "aws.protocols#ec2QueryName": "Platform", - "smithy.api#documentation": "

The instance operating system.

", - "smithy.api#xmlName": "platform" - } - }, - "Volumes": { - "target": "com.amazonaws.ec2#ImportInstanceVolumeDetailSet", - "traits": { - "aws.protocols#ec2QueryName": "Volumes", - "smithy.api#documentation": "

The volumes.

", - "smithy.api#xmlName": "volumes" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an import instance task.

" - } - }, - "com.amazonaws.ec2#ImportInstanceVolumeDetailItem": { - "type": "structure", - "members": { - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone where the resulting instance will reside.

", - "smithy.api#xmlName": "availabilityZone" - } - }, - "BytesConverted": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "aws.protocols#ec2QueryName": "BytesConverted", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of bytes converted so far.

", - "smithy.api#xmlName": "bytesConverted" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description of the task.

", - "smithy.api#xmlName": "description" - } - }, - "Image": { - "target": "com.amazonaws.ec2#DiskImageDescription", - "traits": { - "aws.protocols#ec2QueryName": "Image", - "smithy.api#documentation": "

The image.

", - "smithy.api#xmlName": "image" - } - }, - "Status": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The status of the import of this particular disk image.

", - "smithy.api#xmlName": "status" - } - }, - "StatusMessage": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StatusMessage", - "smithy.api#documentation": "

The status information or errors related to the disk image.

", - "smithy.api#xmlName": "statusMessage" - } - }, - "Volume": { - "target": "com.amazonaws.ec2#DiskImageVolumeDescription", - "traits": { - "aws.protocols#ec2QueryName": "Volume", - "smithy.api#documentation": "

The volume.

", - "smithy.api#xmlName": "volume" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an import volume task.

" - } - }, - "com.amazonaws.ec2#ImportInstanceVolumeDetailSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ImportInstanceVolumeDetailItem", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ImportKeyPair": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ImportKeyPairRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ImportKeyPairResult" - }, - "traits": { - "smithy.api#documentation": "

Imports the public key from an RSA or ED25519 key pair that you created with a third-party tool. \n Compare this with CreateKeyPair, in which Amazon Web Services creates the key pair and gives the keys to you \n (Amazon Web Services keeps a copy of the public key). With ImportKeyPair, you create the key pair and give Amazon Web Services just the public key. \n The private key is never transferred between you and Amazon Web Services.

\n

For more information about key pairs, see Amazon EC2 key pairs \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#ImportKeyPairRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "KeyName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "KeyName", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A unique name for the key pair.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "keyName" - } - }, - "PublicKeyMaterial": { - "target": "com.amazonaws.ec2#Blob", - "traits": { - "aws.protocols#ec2QueryName": "PublicKeyMaterial", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "publicKeyMaterial" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the imported key pair.

", - "smithy.api#xmlName": "TagSpecification" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ImportKeyPairResult": { - "type": "structure", - "members": { - "KeyFingerprint": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "KeyFingerprint", - "smithy.api#documentation": "", - "smithy.api#xmlName": "keyFingerprint" - } - }, - "KeyName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "KeyName", - "smithy.api#documentation": "

The key pair name that you provided.

", - "smithy.api#xmlName": "keyName" - } - }, - "KeyPairId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "KeyPairId", - "smithy.api#documentation": "

The ID of the resulting key pair.

", - "smithy.api#xmlName": "keyPairId" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags applied to the imported key pair.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ImportManifestUrl": { - "type": "string", - "traits": { - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.ec2#ImportSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ImportSnapshotRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ImportSnapshotResult" - }, - "traits": { - "smithy.api#documentation": "

Imports a disk into an EBS snapshot.

\n

For more information, see Importing a disk as a snapshot using VM Import/Export in the \n VM Import/Export User Guide.

" - } - }, - "com.amazonaws.ec2#ImportSnapshotRequest": { - "type": "structure", - "members": { - "ClientData": { - "target": "com.amazonaws.ec2#ClientData", - "traits": { - "smithy.api#documentation": "

The client-specific data.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Token to enable idempotency for VM import requests.

" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The description string for the import snapshot task.

" - } - }, - "DiskContainer": { - "target": "com.amazonaws.ec2#SnapshotDiskContainer", - "traits": { - "smithy.api#documentation": "

Information about the disk container.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "Encrypted": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS is\n used unless you specify a non-default KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the\n Amazon Elastic Compute Cloud User Guide.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.ec2#KmsKeyId", - "traits": { - "smithy.api#documentation": "

An identifier for the symmetric KMS key to use when creating the\n encrypted snapshot. This parameter is only required if you want to use a non-default KMS key; if this\n parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is\n specified, the Encrypted flag must also be set.

\n

The KMS key identifier may be provided in any of the following formats:

\n \n

Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even\n though you provided an invalid identifier. This action will eventually report failure.

\n

The specified KMS key must exist in the Region that the snapshot is being copied to.

\n

Amazon EBS does not support asymmetric KMS keys.

" - } - }, - "RoleName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The name of the role to use when not using the default role, 'vmimport'.

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the import snapshot task during creation.

", - "smithy.api#xmlName": "TagSpecification" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ImportSnapshotResult": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description of the import snapshot task.

", - "smithy.api#xmlName": "description" - } - }, - "ImportTaskId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ImportTaskId", - "smithy.api#documentation": "

The ID of the import snapshot task.

", - "smithy.api#xmlName": "importTaskId" - } - }, - "SnapshotTaskDetail": { - "target": "com.amazonaws.ec2#SnapshotTaskDetail", - "traits": { - "aws.protocols#ec2QueryName": "SnapshotTaskDetail", - "smithy.api#documentation": "

Information about the import snapshot task.

", - "smithy.api#xmlName": "snapshotTaskDetail" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the import snapshot task.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ImportSnapshotTask": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description of the import snapshot task.

", - "smithy.api#xmlName": "description" - } - }, - "ImportTaskId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ImportTaskId", - "smithy.api#documentation": "

The ID of the import snapshot task.

", - "smithy.api#xmlName": "importTaskId" - } - }, - "SnapshotTaskDetail": { - "target": "com.amazonaws.ec2#SnapshotTaskDetail", - "traits": { - "aws.protocols#ec2QueryName": "SnapshotTaskDetail", - "smithy.api#documentation": "

Describes an import snapshot task.

", - "smithy.api#xmlName": "snapshotTaskDetail" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags for the import snapshot task.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an import snapshot task.

" - } - }, - "com.amazonaws.ec2#ImportSnapshotTaskId": { - "type": "string" - }, - "com.amazonaws.ec2#ImportSnapshotTaskIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ImportSnapshotTaskId", - "traits": { - "smithy.api#xmlName": "ImportTaskId" - } - } - }, - "com.amazonaws.ec2#ImportSnapshotTaskList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ImportSnapshotTask", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ImportTaskId": { - "type": "string" - }, - "com.amazonaws.ec2#ImportTaskIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ImportImageTaskId", - "traits": { - "smithy.api#xmlName": "ImportTaskId" - } - } - }, - "com.amazonaws.ec2#ImportVolume": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ImportVolumeRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ImportVolumeResult" - }, - "traits": { - "smithy.api#documentation": "

Creates an import volume task using metadata from the specified disk image.

\n

This API action supports only single-volume VMs. To import multi-volume VMs, use \n ImportImage instead. To import a disk to a snapshot, use\n ImportSnapshot instead.

\n

This API action is not supported by the Command Line Interface (CLI). For \n information about using the Amazon EC2 CLI, which is deprecated, see Importing Disks to Amazon EBS in the Amazon EC2 CLI Reference PDF file.

\n

For information about the import manifest referenced by this API action, see VM Import Manifest.

" - } - }, - "com.amazonaws.ec2#ImportVolumeRequest": { - "type": "structure", - "members": { - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Availability Zone for the resulting EBS volume.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "availabilityZone" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description of the volume.

", - "smithy.api#xmlName": "description" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "Image": { - "target": "com.amazonaws.ec2#DiskImageDetail", - "traits": { - "aws.protocols#ec2QueryName": "Image", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The disk image.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "image" - } - }, - "Volume": { - "target": "com.amazonaws.ec2#VolumeDetail", - "traits": { - "aws.protocols#ec2QueryName": "Volume", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The volume size.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "volume" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ImportVolumeResult": { - "type": "structure", - "members": { - "ConversionTask": { - "target": "com.amazonaws.ec2#ConversionTask", - "traits": { - "aws.protocols#ec2QueryName": "ConversionTask", - "smithy.api#documentation": "

Information about the conversion task.

", - "smithy.api#xmlName": "conversionTask" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ImportVolumeTaskDetails": { - "type": "structure", - "members": { - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone where the resulting volume will reside.

", - "smithy.api#xmlName": "availabilityZone" - } - }, - "BytesConverted": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "aws.protocols#ec2QueryName": "BytesConverted", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of bytes converted so far.

", - "smithy.api#xmlName": "bytesConverted" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

The description you provided when starting the import volume task.

", - "smithy.api#xmlName": "description" - } - }, - "Image": { - "target": "com.amazonaws.ec2#DiskImageDescription", - "traits": { - "aws.protocols#ec2QueryName": "Image", - "smithy.api#documentation": "

The image.

", - "smithy.api#xmlName": "image" - } - }, - "Volume": { - "target": "com.amazonaws.ec2#DiskImageVolumeDescription", - "traits": { - "aws.protocols#ec2QueryName": "Volume", - "smithy.api#documentation": "

The volume.

", - "smithy.api#xmlName": "volume" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an import volume task.

" - } - }, - "com.amazonaws.ec2#InferenceAcceleratorInfo": { - "type": "structure", - "members": { - "Accelerators": { - "target": "com.amazonaws.ec2#InferenceDeviceInfoList", - "traits": { - "aws.protocols#ec2QueryName": "Accelerators", - "smithy.api#documentation": "

Describes the Inference accelerators for the instance type.

", - "smithy.api#xmlName": "accelerators" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the Inference accelerators for the instance type.

" - } - }, - "com.amazonaws.ec2#InferenceDeviceCount": { - "type": "integer" - }, - "com.amazonaws.ec2#InferenceDeviceInfo": { - "type": "structure", - "members": { - "Count": { - "target": "com.amazonaws.ec2#InferenceDeviceCount", - "traits": { - "aws.protocols#ec2QueryName": "Count", - "smithy.api#documentation": "

The number of Inference accelerators for the instance type.

", - "smithy.api#xmlName": "count" - } - }, - "Name": { - "target": "com.amazonaws.ec2#InferenceDeviceName", - "traits": { - "aws.protocols#ec2QueryName": "Name", - "smithy.api#documentation": "

The name of the Inference accelerator.

", - "smithy.api#xmlName": "name" - } - }, - "Manufacturer": { - "target": "com.amazonaws.ec2#InferenceDeviceManufacturerName", - "traits": { - "aws.protocols#ec2QueryName": "Manufacturer", - "smithy.api#documentation": "

The manufacturer of the Inference accelerator.

", - "smithy.api#xmlName": "manufacturer" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the Inference accelerators for the instance type.

" - } - }, - "com.amazonaws.ec2#InferenceDeviceInfoList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#InferenceDeviceInfo" - } - }, - "com.amazonaws.ec2#InferenceDeviceManufacturerName": { - "type": "string" - }, - "com.amazonaws.ec2#InferenceDeviceName": { - "type": "string" - }, - "com.amazonaws.ec2#InsideCidrBlocksStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#Instance": { - "type": "structure", - "members": { - "AmiLaunchIndex": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "AmiLaunchIndex", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The AMI launch index, which can be used to find this instance in the launch\n group.

", - "smithy.api#xmlName": "amiLaunchIndex" - } - }, - "ImageId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ImageId", - "smithy.api#documentation": "

The ID of the AMI used to launch the instance.

", - "smithy.api#xmlName": "imageId" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#xmlName": "instanceId" - } - }, - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type.

", - "smithy.api#xmlName": "instanceType" - } - }, - "KernelId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "KernelId", - "smithy.api#documentation": "

The kernel associated with this instance, if applicable.

", - "smithy.api#xmlName": "kernelId" - } - }, - "KeyName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "KeyName", - "smithy.api#documentation": "

The name of the key pair, if this instance was launched with an associated key\n pair.

", - "smithy.api#xmlName": "keyName" - } - }, - "LaunchTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTime", - "smithy.api#documentation": "

The time the instance was launched.

", - "smithy.api#xmlName": "launchTime" - } - }, - "Monitoring": { - "target": "com.amazonaws.ec2#Monitoring", - "traits": { - "aws.protocols#ec2QueryName": "Monitoring", - "smithy.api#documentation": "

The monitoring for the instance.

", - "smithy.api#xmlName": "monitoring" - } - }, - "Placement": { - "target": "com.amazonaws.ec2#Placement", - "traits": { - "aws.protocols#ec2QueryName": "Placement", - "smithy.api#documentation": "

The location where the instance launched, if applicable.

", - "smithy.api#xmlName": "placement" - } - }, - "Platform": { - "target": "com.amazonaws.ec2#PlatformValues", - "traits": { - "aws.protocols#ec2QueryName": "Platform", - "smithy.api#documentation": "

The value is Windows for Windows instances; otherwise blank.

", - "smithy.api#xmlName": "platform" - } - }, - "PrivateDnsName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrivateDnsName", - "smithy.api#documentation": "

[IPv4 only] The private DNS hostname name assigned to the instance. This DNS hostname\n can only be used inside the Amazon EC2 network. This name is not available until the\n instance enters the running state.

\n

The Amazon-provided DNS server resolves Amazon-provided private DNS\n hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not\n using the Amazon-provided DNS server in your VPC, your custom domain name servers must\n resolve the hostname as appropriate.

", - "smithy.api#xmlName": "privateDnsName" - } - }, - "PrivateIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrivateIpAddress", - "smithy.api#documentation": "

The private IPv4 address assigned to the instance.

", - "smithy.api#xmlName": "privateIpAddress" - } - }, - "ProductCodes": { - "target": "com.amazonaws.ec2#ProductCodeList", - "traits": { - "aws.protocols#ec2QueryName": "ProductCodes", - "smithy.api#documentation": "

The product codes attached to this instance, if applicable.

", - "smithy.api#xmlName": "productCodes" - } - }, - "PublicDnsName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DnsName", - "smithy.api#documentation": "

[IPv4 only] The public DNS name assigned to the instance. This name is not available\n until the instance enters the running state. This name is only\n available if you've enabled DNS hostnames for your VPC.

", - "smithy.api#xmlName": "dnsName" - } - }, - "PublicIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "IpAddress", - "smithy.api#documentation": "

The public IPv4 address, or the Carrier IP address assigned to the instance, if\n applicable.

\n

A Carrier IP address only applies to an instance launched in a subnet associated with\n a Wavelength Zone.

", - "smithy.api#xmlName": "ipAddress" - } - }, - "RamdiskId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "RamdiskId", - "smithy.api#documentation": "

The RAM disk associated with this instance, if applicable.

", - "smithy.api#xmlName": "ramdiskId" - } - }, - "State": { - "target": "com.amazonaws.ec2#InstanceState", - "traits": { - "aws.protocols#ec2QueryName": "InstanceState", - "smithy.api#documentation": "

The current state of the instance.

", - "smithy.api#xmlName": "instanceState" - } - }, - "StateTransitionReason": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Reason", - "smithy.api#documentation": "

The reason for the most recent state transition. This might be an empty string.

", - "smithy.api#xmlName": "reason" - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#documentation": "

The ID of the subnet in which the instance is running.

", - "smithy.api#xmlName": "subnetId" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC in which the instance is running.

", - "smithy.api#xmlName": "vpcId" - } - }, - "Architecture": { - "target": "com.amazonaws.ec2#ArchitectureValues", - "traits": { - "aws.protocols#ec2QueryName": "Architecture", - "smithy.api#documentation": "

The architecture of the image.

", - "smithy.api#xmlName": "architecture" - } - }, - "BlockDeviceMappings": { - "target": "com.amazonaws.ec2#InstanceBlockDeviceMappingList", - "traits": { - "aws.protocols#ec2QueryName": "BlockDeviceMapping", - "smithy.api#documentation": "

Any block device mapping entries for the instance.

", - "smithy.api#xmlName": "blockDeviceMapping" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

The idempotency token you provided when you launched the instance, if\n applicable.

", - "smithy.api#xmlName": "clientToken" - } - }, - "EbsOptimized": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "EbsOptimized", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the instance is optimized for Amazon EBS I/O. This optimization\n provides dedicated throughput to Amazon EBS and an optimized configuration stack to\n provide optimal I/O performance. This optimization isn't available with all instance\n types. Additional usage charges apply when using an EBS Optimized instance.

", - "smithy.api#xmlName": "ebsOptimized" - } - }, - "EnaSupport": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "EnaSupport", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether enhanced networking with ENA is enabled.

", - "smithy.api#xmlName": "enaSupport" - } - }, - "Hypervisor": { - "target": "com.amazonaws.ec2#HypervisorType", - "traits": { - "aws.protocols#ec2QueryName": "Hypervisor", - "smithy.api#documentation": "

The hypervisor type of the instance. The value xen is used for both Xen\n and Nitro hypervisors.

", - "smithy.api#xmlName": "hypervisor" - } - }, - "IamInstanceProfile": { - "target": "com.amazonaws.ec2#IamInstanceProfile", - "traits": { - "aws.protocols#ec2QueryName": "IamInstanceProfile", - "smithy.api#documentation": "

The IAM instance profile associated with the instance, if\n applicable.

", - "smithy.api#xmlName": "iamInstanceProfile" - } - }, - "InstanceLifecycle": { - "target": "com.amazonaws.ec2#InstanceLifecycleType", - "traits": { - "aws.protocols#ec2QueryName": "InstanceLifecycle", - "smithy.api#documentation": "

Indicates whether this is a Spot Instance or a Scheduled Instance.

", - "smithy.api#xmlName": "instanceLifecycle" - } - }, - "ElasticGpuAssociations": { - "target": "com.amazonaws.ec2#ElasticGpuAssociationList", - "traits": { - "aws.protocols#ec2QueryName": "ElasticGpuAssociationSet", - "smithy.api#documentation": "

The Elastic GPU associated with the instance.

", - "smithy.api#xmlName": "elasticGpuAssociationSet" - } - }, - "ElasticInferenceAcceleratorAssociations": { - "target": "com.amazonaws.ec2#ElasticInferenceAcceleratorAssociationList", - "traits": { - "aws.protocols#ec2QueryName": "ElasticInferenceAcceleratorAssociationSet", - "smithy.api#documentation": "

The elastic inference accelerator associated with the instance.

", - "smithy.api#xmlName": "elasticInferenceAcceleratorAssociationSet" - } - }, - "NetworkInterfaces": { - "target": "com.amazonaws.ec2#InstanceNetworkInterfaceList", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceSet", - "smithy.api#documentation": "

The network interfaces for the instance.

", - "smithy.api#xmlName": "networkInterfaceSet" - } - }, - "OutpostArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OutpostArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

", - "smithy.api#xmlName": "outpostArn" - } - }, - "RootDeviceName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "RootDeviceName", - "smithy.api#documentation": "

The device name of the root device volume (for example,\n /dev/sda1).

", - "smithy.api#xmlName": "rootDeviceName" - } - }, - "RootDeviceType": { - "target": "com.amazonaws.ec2#DeviceType", - "traits": { - "aws.protocols#ec2QueryName": "RootDeviceType", - "smithy.api#documentation": "

The root device type used by the AMI. The AMI can use an EBS volume or an instance\n store volume.

", - "smithy.api#xmlName": "rootDeviceType" - } - }, - "SecurityGroups": { - "target": "com.amazonaws.ec2#GroupIdentifierList", - "traits": { - "aws.protocols#ec2QueryName": "GroupSet", - "smithy.api#documentation": "

The security groups for the instance.

", - "smithy.api#xmlName": "groupSet" - } - }, - "SourceDestCheck": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "SourceDestCheck", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether source/destination checking is enabled.

", - "smithy.api#xmlName": "sourceDestCheck" - } - }, - "SpotInstanceRequestId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SpotInstanceRequestId", - "smithy.api#documentation": "

If the request is a Spot Instance request, the ID of the request.

", - "smithy.api#xmlName": "spotInstanceRequestId" - } - }, - "SriovNetSupport": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SriovNetSupport", - "smithy.api#documentation": "

Specifies whether enhanced networking with the Intel 82599 Virtual Function interface\n is enabled.

", - "smithy.api#xmlName": "sriovNetSupport" - } - }, - "StateReason": { - "target": "com.amazonaws.ec2#StateReason", - "traits": { - "aws.protocols#ec2QueryName": "StateReason", - "smithy.api#documentation": "

The reason for the most recent state transition.

", - "smithy.api#xmlName": "stateReason" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the instance.

", - "smithy.api#xmlName": "tagSet" - } - }, - "VirtualizationType": { - "target": "com.amazonaws.ec2#VirtualizationType", - "traits": { - "aws.protocols#ec2QueryName": "VirtualizationType", - "smithy.api#documentation": "

The virtualization type of the instance.

", - "smithy.api#xmlName": "virtualizationType" - } - }, - "CpuOptions": { - "target": "com.amazonaws.ec2#CpuOptions", - "traits": { - "aws.protocols#ec2QueryName": "CpuOptions", - "smithy.api#documentation": "

The CPU options for the instance.

", - "smithy.api#xmlName": "cpuOptions" - } - }, - "CapacityReservationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CapacityReservationId", - "smithy.api#documentation": "

The ID of the Capacity Reservation.

", - "smithy.api#xmlName": "capacityReservationId" - } - }, - "CapacityReservationSpecification": { - "target": "com.amazonaws.ec2#CapacityReservationSpecificationResponse", - "traits": { - "aws.protocols#ec2QueryName": "CapacityReservationSpecification", - "smithy.api#documentation": "

Information about the Capacity Reservation targeting option.

", - "smithy.api#xmlName": "capacityReservationSpecification" - } - }, - "HibernationOptions": { - "target": "com.amazonaws.ec2#HibernationOptions", - "traits": { - "aws.protocols#ec2QueryName": "HibernationOptions", - "smithy.api#documentation": "

Indicates whether the instance is enabled for hibernation.

", - "smithy.api#xmlName": "hibernationOptions" - } - }, - "Licenses": { - "target": "com.amazonaws.ec2#LicenseList", - "traits": { - "aws.protocols#ec2QueryName": "LicenseSet", - "smithy.api#documentation": "

The license configurations for the instance.

", - "smithy.api#xmlName": "licenseSet" - } - }, - "MetadataOptions": { - "target": "com.amazonaws.ec2#InstanceMetadataOptionsResponse", - "traits": { - "aws.protocols#ec2QueryName": "MetadataOptions", - "smithy.api#documentation": "

The metadata options for the instance.

", - "smithy.api#xmlName": "metadataOptions" - } - }, - "EnclaveOptions": { - "target": "com.amazonaws.ec2#EnclaveOptions", - "traits": { - "aws.protocols#ec2QueryName": "EnclaveOptions", - "smithy.api#documentation": "

Indicates whether the instance is enabled for Amazon Web Services Nitro\n Enclaves.

", - "smithy.api#xmlName": "enclaveOptions" - } - }, - "BootMode": { - "target": "com.amazonaws.ec2#BootModeValues", - "traits": { - "aws.protocols#ec2QueryName": "BootMode", - "smithy.api#documentation": "

The boot mode that was specified by the AMI. If the value is uefi-preferred, \n the AMI supports both UEFI and Legacy BIOS. The currentInstanceBootMode parameter \n is the boot mode that is used to boot the instance at launch or start.

\n \n

The operating system contained in the AMI must be configured to support the specified boot mode.

\n \n

For more information, see Boot modes in the\n Amazon EC2 User Guide.

", - "smithy.api#xmlName": "bootMode" - } - }, - "PlatformDetails": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PlatformDetails", - "smithy.api#documentation": "

The platform details value for the instance. For more information, see AMI\n billing information fields in the\n Amazon EC2 User Guide.

", - "smithy.api#xmlName": "platformDetails" - } - }, - "UsageOperation": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "UsageOperation", - "smithy.api#documentation": "

The usage operation value for the instance. For more information, see AMI\n billing information fields in the\n Amazon EC2 User Guide.

", - "smithy.api#xmlName": "usageOperation" - } - }, - "UsageOperationUpdateTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "UsageOperationUpdateTime", - "smithy.api#documentation": "

The time that the usage operation was last updated.

", - "smithy.api#xmlName": "usageOperationUpdateTime" - } - }, - "PrivateDnsNameOptions": { - "target": "com.amazonaws.ec2#PrivateDnsNameOptionsResponse", - "traits": { - "aws.protocols#ec2QueryName": "PrivateDnsNameOptions", - "smithy.api#documentation": "

The options for the instance hostname.

", - "smithy.api#xmlName": "privateDnsNameOptions" - } - }, - "Ipv6Address": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6Address", - "smithy.api#documentation": "

The IPv6 address assigned to the instance.

", - "smithy.api#xmlName": "ipv6Address" - } - }, - "TpmSupport": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TpmSupport", - "smithy.api#documentation": "

If the instance is configured for NitroTPM support, the value is v2.0.\n For more information, see NitroTPM in the\n Amazon EC2 User Guide.

", - "smithy.api#xmlName": "tpmSupport" - } - }, - "MaintenanceOptions": { - "target": "com.amazonaws.ec2#InstanceMaintenanceOptions", - "traits": { - "aws.protocols#ec2QueryName": "MaintenanceOptions", - "smithy.api#documentation": "

Provides information on the recovery and maintenance options of your instance.

", - "smithy.api#xmlName": "maintenanceOptions" - } - }, - "CurrentInstanceBootMode": { - "target": "com.amazonaws.ec2#InstanceBootModeValues", - "traits": { - "aws.protocols#ec2QueryName": "CurrentInstanceBootMode", - "smithy.api#documentation": "

The boot mode that is used to boot the instance at launch or start. For more information, see Boot modes in the\n Amazon EC2 User Guide.

", - "smithy.api#xmlName": "currentInstanceBootMode" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an instance.

" - } - }, - "com.amazonaws.ec2#InstanceAttribute": { - "type": "structure", - "members": { - "Groups": { - "target": "com.amazonaws.ec2#GroupIdentifierList", - "traits": { - "aws.protocols#ec2QueryName": "GroupSet", - "smithy.api#documentation": "

The security groups associated with the instance.

", - "smithy.api#xmlName": "groupSet" - } - }, - "BlockDeviceMappings": { - "target": "com.amazonaws.ec2#InstanceBlockDeviceMappingList", - "traits": { - "aws.protocols#ec2QueryName": "BlockDeviceMapping", - "smithy.api#documentation": "

The block device mapping of the instance.

", - "smithy.api#xmlName": "blockDeviceMapping" - } - }, - "DisableApiTermination": { - "target": "com.amazonaws.ec2#AttributeBooleanValue", - "traits": { - "aws.protocols#ec2QueryName": "DisableApiTermination", - "smithy.api#documentation": "

If the value is true, you can't terminate the instance through the Amazon\n EC2 console, CLI, or API; otherwise, you can.

", - "smithy.api#xmlName": "disableApiTermination" - } - }, - "EnaSupport": { - "target": "com.amazonaws.ec2#AttributeBooleanValue", - "traits": { - "aws.protocols#ec2QueryName": "EnaSupport", - "smithy.api#documentation": "

Indicates whether enhanced networking with ENA is enabled.

", - "smithy.api#xmlName": "enaSupport" - } - }, - "EnclaveOptions": { - "target": "com.amazonaws.ec2#EnclaveOptions", - "traits": { - "aws.protocols#ec2QueryName": "EnclaveOptions", - "smithy.api#documentation": "

To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to\n true; otherwise, set it to false.

", - "smithy.api#xmlName": "enclaveOptions" - } - }, - "EbsOptimized": { - "target": "com.amazonaws.ec2#AttributeBooleanValue", - "traits": { - "aws.protocols#ec2QueryName": "EbsOptimized", - "smithy.api#documentation": "

Indicates whether the instance is optimized for Amazon EBS I/O.

", - "smithy.api#xmlName": "ebsOptimized" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#xmlName": "instanceId" - } - }, - "InstanceInitiatedShutdownBehavior": { - "target": "com.amazonaws.ec2#AttributeValue", - "traits": { - "aws.protocols#ec2QueryName": "InstanceInitiatedShutdownBehavior", - "smithy.api#documentation": "

Indicates whether an instance stops or terminates when you initiate shutdown from the\n instance (using the operating system command for system shutdown).

", - "smithy.api#xmlName": "instanceInitiatedShutdownBehavior" - } - }, - "InstanceType": { - "target": "com.amazonaws.ec2#AttributeValue", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type.

", - "smithy.api#xmlName": "instanceType" - } - }, - "KernelId": { - "target": "com.amazonaws.ec2#AttributeValue", - "traits": { - "aws.protocols#ec2QueryName": "Kernel", - "smithy.api#documentation": "

The kernel ID.

", - "smithy.api#xmlName": "kernel" - } - }, - "ProductCodes": { - "target": "com.amazonaws.ec2#ProductCodeList", - "traits": { - "aws.protocols#ec2QueryName": "ProductCodes", - "smithy.api#documentation": "

A list of product codes.

", - "smithy.api#xmlName": "productCodes" - } - }, - "RamdiskId": { - "target": "com.amazonaws.ec2#AttributeValue", - "traits": { - "aws.protocols#ec2QueryName": "Ramdisk", - "smithy.api#documentation": "

The RAM disk ID.

", - "smithy.api#xmlName": "ramdisk" - } - }, - "RootDeviceName": { - "target": "com.amazonaws.ec2#AttributeValue", - "traits": { - "aws.protocols#ec2QueryName": "RootDeviceName", - "smithy.api#documentation": "

The device name of the root device volume (for example,\n /dev/sda1).

", - "smithy.api#xmlName": "rootDeviceName" - } - }, - "SourceDestCheck": { - "target": "com.amazonaws.ec2#AttributeBooleanValue", - "traits": { - "aws.protocols#ec2QueryName": "SourceDestCheck", - "smithy.api#documentation": "

Enable or disable source/destination checks, which ensure that the instance is either\n the source or the destination of any traffic that it receives. If the value is\n true, source/destination checks are enabled; otherwise, they are\n disabled. The default value is true. You must disable source/destination\n checks if the instance runs services such as network address translation, routing, or\n firewalls.

", - "smithy.api#xmlName": "sourceDestCheck" - } - }, - "SriovNetSupport": { - "target": "com.amazonaws.ec2#AttributeValue", - "traits": { - "aws.protocols#ec2QueryName": "SriovNetSupport", - "smithy.api#documentation": "

Indicates whether enhanced networking with the Intel 82599 Virtual Function interface\n is enabled.

", - "smithy.api#xmlName": "sriovNetSupport" - } - }, - "UserData": { - "target": "com.amazonaws.ec2#AttributeValue", - "traits": { - "aws.protocols#ec2QueryName": "UserData", - "smithy.api#documentation": "

The user data.

", - "smithy.api#xmlName": "userData" - } - }, - "DisableApiStop": { - "target": "com.amazonaws.ec2#AttributeBooleanValue", - "traits": { - "aws.protocols#ec2QueryName": "DisableApiStop", - "smithy.api#documentation": "

To enable the instance for Amazon Web Services Stop Protection, set this parameter to\n true; otherwise, set it to false.

", - "smithy.api#xmlName": "disableApiStop" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an instance attribute.

" - } - }, - "com.amazonaws.ec2#InstanceAttributeName": { - "type": "enum", - "members": { - "instanceType": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "instanceType" - } - }, - "kernel": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "kernel" - } - }, - "ramdisk": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ramdisk" - } - }, - "userData": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "userData" - } - }, - "disableApiTermination": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disableApiTermination" - } - }, - "instanceInitiatedShutdownBehavior": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "instanceInitiatedShutdownBehavior" - } - }, - "rootDeviceName": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "rootDeviceName" - } - }, - "blockDeviceMapping": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "blockDeviceMapping" - } - }, - "productCodes": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "productCodes" - } - }, - "sourceDestCheck": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "sourceDestCheck" - } - }, - "groupSet": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "groupSet" - } - }, - "ebsOptimized": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ebsOptimized" - } - }, - "sriovNetSupport": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "sriovNetSupport" - } - }, - "enaSupport": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enaSupport" - } - }, - "enclaveOptions": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enclaveOptions" - } - }, - "disableApiStop": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disableApiStop" - } - } - } - }, - "com.amazonaws.ec2#InstanceAutoRecoveryState": { - "type": "enum", - "members": { - "disabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disabled" - } - }, - "default": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "default" - } - } - } - }, - "com.amazonaws.ec2#InstanceBlockDeviceMapping": { - "type": "structure", - "members": { - "DeviceName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DeviceName", - "smithy.api#documentation": "

The device name (for example, /dev/sdh or xvdh).

", - "smithy.api#xmlName": "deviceName" - } - }, - "Ebs": { - "target": "com.amazonaws.ec2#EbsInstanceBlockDevice", - "traits": { - "aws.protocols#ec2QueryName": "Ebs", - "smithy.api#documentation": "

Parameters used to automatically set up EBS volumes when the instance is\n launched.

", - "smithy.api#xmlName": "ebs" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a block device mapping.

" - } - }, - "com.amazonaws.ec2#InstanceBlockDeviceMappingList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#InstanceBlockDeviceMapping", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#InstanceBlockDeviceMappingSpecification": { - "type": "structure", - "members": { - "DeviceName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DeviceName", - "smithy.api#documentation": "

The device name (for example, /dev/sdh or xvdh).

", - "smithy.api#xmlName": "deviceName" - } - }, - "Ebs": { - "target": "com.amazonaws.ec2#EbsInstanceBlockDeviceSpecification", - "traits": { - "aws.protocols#ec2QueryName": "Ebs", - "smithy.api#documentation": "

Parameters used to automatically set up EBS volumes when the instance is\n launched.

", - "smithy.api#xmlName": "ebs" - } - }, - "NoDevice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NoDevice", - "smithy.api#documentation": "

suppress the specified device included in the block device mapping.

", - "smithy.api#xmlName": "noDevice" - } - }, - "VirtualName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VirtualName", - "smithy.api#documentation": "

The virtual device name.

", - "smithy.api#xmlName": "virtualName" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a block device mapping entry.

" - } - }, - "com.amazonaws.ec2#InstanceBlockDeviceMappingSpecificationList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#InstanceBlockDeviceMappingSpecification", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#InstanceBootModeValues": { - "type": "enum", - "members": { - "legacy_bios": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "legacy-bios" - } - }, - "uefi": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "uefi" - } - } - } - }, - "com.amazonaws.ec2#InstanceCapacity": { - "type": "structure", - "members": { - "AvailableCapacity": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "AvailableCapacity", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of instances that can be launched onto the Dedicated Host based on the\n host's available capacity.

", - "smithy.api#xmlName": "availableCapacity" - } - }, - "InstanceType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type supported by the Dedicated Host.

", - "smithy.api#xmlName": "instanceType" - } - }, - "TotalCapacity": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "TotalCapacity", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The total number of instances that can be launched onto the Dedicated Host if there\n are no instances running on it.

", - "smithy.api#xmlName": "totalCapacity" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the number of instances that can be launched onto the Dedicated\n Host.

" - } - }, - "com.amazonaws.ec2#InstanceCount": { - "type": "structure", - "members": { - "InstanceCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "InstanceCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of listed Reserved Instances in the state specified by the state.

", - "smithy.api#xmlName": "instanceCount" - } - }, - "State": { - "target": "com.amazonaws.ec2#ListingState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The states of the listed Reserved Instances.

", - "smithy.api#xmlName": "state" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a Reserved Instance listing state.

" - } - }, - "com.amazonaws.ec2#InstanceCountList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#InstanceCount", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#InstanceCreditSpecification": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#xmlName": "instanceId" - } - }, - "CpuCredits": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CpuCredits", - "smithy.api#documentation": "

The credit option for CPU usage of the instance.

\n

Valid values: standard | unlimited\n

", - "smithy.api#xmlName": "cpuCredits" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the credit option for CPU usage of a burstable performance instance.

" - } - }, - "com.amazonaws.ec2#InstanceCreditSpecificationList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#InstanceCreditSpecification", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#InstanceCreditSpecificationListRequest": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#InstanceCreditSpecificationRequest", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#InstanceCreditSpecificationRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#required": {} - } - }, - "CpuCredits": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The credit option for CPU usage of the instance.

\n

Valid values: standard | unlimited\n

\n

T3 instances with host tenancy do not support the unlimited\n CPU credit option.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the credit option for CPU usage of a burstable performance instance.

" - } - }, - "com.amazonaws.ec2#InstanceEventId": { - "type": "string" - }, - "com.amazonaws.ec2#InstanceEventWindow": { - "type": "structure", - "members": { - "InstanceEventWindowId": { - "target": "com.amazonaws.ec2#InstanceEventWindowId", - "traits": { - "aws.protocols#ec2QueryName": "InstanceEventWindowId", - "smithy.api#documentation": "

The ID of the event window.

", - "smithy.api#xmlName": "instanceEventWindowId" - } - }, - "TimeRanges": { - "target": "com.amazonaws.ec2#InstanceEventWindowTimeRangeList", - "traits": { - "aws.protocols#ec2QueryName": "TimeRangeSet", - "smithy.api#documentation": "

One or more time ranges defined for the event window.

", - "smithy.api#xmlName": "timeRangeSet" - } - }, - "Name": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Name", - "smithy.api#documentation": "

The name of the event window.

", - "smithy.api#xmlName": "name" - } - }, - "CronExpression": { - "target": "com.amazonaws.ec2#InstanceEventWindowCronExpression", - "traits": { - "aws.protocols#ec2QueryName": "CronExpression", - "smithy.api#documentation": "

The cron expression defined for the event window.

", - "smithy.api#xmlName": "cronExpression" - } - }, - "AssociationTarget": { - "target": "com.amazonaws.ec2#InstanceEventWindowAssociationTarget", - "traits": { - "aws.protocols#ec2QueryName": "AssociationTarget", - "smithy.api#documentation": "

One or more targets associated with the event window.

", - "smithy.api#xmlName": "associationTarget" - } - }, - "State": { - "target": "com.amazonaws.ec2#InstanceEventWindowState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The current state of the event window.

", - "smithy.api#xmlName": "state" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The instance tags associated with the event window.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

The event window.

" - } - }, - "com.amazonaws.ec2#InstanceEventWindowAssociationRequest": { - "type": "structure", - "members": { - "InstanceIds": { - "target": "com.amazonaws.ec2#InstanceIdList", - "traits": { - "smithy.api#documentation": "

The IDs of the instances to associate with the event window. If the instance is on a\n Dedicated Host, you can't specify the Instance ID parameter; you must use the Dedicated\n Host ID parameter.

", - "smithy.api#xmlName": "InstanceId" - } - }, - "InstanceTags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "smithy.api#documentation": "

The instance tags to associate with the event window. Any instances associated with the\n tags will be associated with the event window.

", - "smithy.api#xmlName": "InstanceTag" - } - }, - "DedicatedHostIds": { - "target": "com.amazonaws.ec2#DedicatedHostIdList", - "traits": { - "smithy.api#documentation": "

The IDs of the Dedicated Hosts to associate with the event window.

", - "smithy.api#xmlName": "DedicatedHostId" - } - } - }, - "traits": { - "smithy.api#documentation": "

One or more targets associated with the specified event window. Only one\n type of target (instance ID, instance tag, or Dedicated Host ID)\n can be associated with an event window.

" - } - }, - "com.amazonaws.ec2#InstanceEventWindowAssociationTarget": { - "type": "structure", - "members": { - "InstanceIds": { - "target": "com.amazonaws.ec2#InstanceIdList", - "traits": { - "aws.protocols#ec2QueryName": "InstanceIdSet", - "smithy.api#documentation": "

The IDs of the instances associated with the event window.

", - "smithy.api#xmlName": "instanceIdSet" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The instance tags associated with the event window. Any instances associated with the tags\n will be associated with the event window.

", - "smithy.api#xmlName": "tagSet" - } - }, - "DedicatedHostIds": { - "target": "com.amazonaws.ec2#DedicatedHostIdList", - "traits": { - "aws.protocols#ec2QueryName": "DedicatedHostIdSet", - "smithy.api#documentation": "

The IDs of the Dedicated Hosts associated with the event window.

", - "smithy.api#xmlName": "dedicatedHostIdSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

One or more targets associated with the event window.

" - } - }, - "com.amazonaws.ec2#InstanceEventWindowCronExpression": { - "type": "string" - }, - "com.amazonaws.ec2#InstanceEventWindowDisassociationRequest": { - "type": "structure", - "members": { - "InstanceIds": { - "target": "com.amazonaws.ec2#InstanceIdList", - "traits": { - "smithy.api#documentation": "

The IDs of the instances to disassociate from the event window.

", - "smithy.api#xmlName": "InstanceId" - } - }, - "InstanceTags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "smithy.api#documentation": "

The instance tags to disassociate from the event window. Any instances associated with\n the tags will be disassociated from the event window.

", - "smithy.api#xmlName": "InstanceTag" - } - }, - "DedicatedHostIds": { - "target": "com.amazonaws.ec2#DedicatedHostIdList", - "traits": { - "smithy.api#documentation": "

The IDs of the Dedicated Hosts to disassociate from the event window.

", - "smithy.api#xmlName": "DedicatedHostId" - } - } - }, - "traits": { - "smithy.api#documentation": "

The targets to disassociate from the specified event window.

" - } - }, - "com.amazonaws.ec2#InstanceEventWindowId": { - "type": "string" - }, - "com.amazonaws.ec2#InstanceEventWindowIdSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#InstanceEventWindowId", - "traits": { - "smithy.api#xmlName": "InstanceEventWindowId" - } - } - }, - "com.amazonaws.ec2#InstanceEventWindowSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#InstanceEventWindow", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#InstanceEventWindowState": { - "type": "enum", - "members": { - "creating": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "creating" - } - }, - "deleting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleting" - } - }, - "active": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "active" - } - }, - "deleted": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleted" - } - } - } - }, - "com.amazonaws.ec2#InstanceEventWindowStateChange": { - "type": "structure", - "members": { - "InstanceEventWindowId": { - "target": "com.amazonaws.ec2#InstanceEventWindowId", - "traits": { - "aws.protocols#ec2QueryName": "InstanceEventWindowId", - "smithy.api#documentation": "

The ID of the event window.

", - "smithy.api#xmlName": "instanceEventWindowId" - } - }, - "State": { - "target": "com.amazonaws.ec2#InstanceEventWindowState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The current state of the event window.

", - "smithy.api#xmlName": "state" - } - } - }, - "traits": { - "smithy.api#documentation": "

The state of the event window.

" - } - }, - "com.amazonaws.ec2#InstanceEventWindowTimeRange": { - "type": "structure", - "members": { - "StartWeekDay": { - "target": "com.amazonaws.ec2#WeekDay", - "traits": { - "aws.protocols#ec2QueryName": "StartWeekDay", - "smithy.api#documentation": "

The day on which the time range begins.

", - "smithy.api#xmlName": "startWeekDay" - } - }, - "StartHour": { - "target": "com.amazonaws.ec2#Hour", - "traits": { - "aws.protocols#ec2QueryName": "StartHour", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The hour when the time range begins.

", - "smithy.api#xmlName": "startHour" - } - }, - "EndWeekDay": { - "target": "com.amazonaws.ec2#WeekDay", - "traits": { - "aws.protocols#ec2QueryName": "EndWeekDay", - "smithy.api#documentation": "

The day on which the time range ends.

", - "smithy.api#xmlName": "endWeekDay" - } - }, - "EndHour": { - "target": "com.amazonaws.ec2#Hour", - "traits": { - "aws.protocols#ec2QueryName": "EndHour", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The hour when the time range ends.

", - "smithy.api#xmlName": "endHour" - } - } - }, - "traits": { - "smithy.api#documentation": "

The start day and time and the end day and time of the time range, in UTC.

" - } - }, - "com.amazonaws.ec2#InstanceEventWindowTimeRangeList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#InstanceEventWindowTimeRange", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#InstanceEventWindowTimeRangeRequest": { - "type": "structure", - "members": { - "StartWeekDay": { - "target": "com.amazonaws.ec2#WeekDay", - "traits": { - "smithy.api#documentation": "

The day on which the time range begins.

" - } - }, - "StartHour": { - "target": "com.amazonaws.ec2#Hour", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The hour when the time range begins.

" - } - }, - "EndWeekDay": { - "target": "com.amazonaws.ec2#WeekDay", - "traits": { - "smithy.api#documentation": "

The day on which the time range ends.

" - } - }, - "EndHour": { - "target": "com.amazonaws.ec2#Hour", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The hour when the time range ends.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The start day and time and the end day and time of the time range, in UTC.

" - } - }, - "com.amazonaws.ec2#InstanceEventWindowTimeRangeRequestSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#InstanceEventWindowTimeRangeRequest" - } - }, - "com.amazonaws.ec2#InstanceExportDetails": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the resource being exported.

", - "smithy.api#xmlName": "instanceId" - } - }, - "TargetEnvironment": { - "target": "com.amazonaws.ec2#ExportEnvironment", - "traits": { - "aws.protocols#ec2QueryName": "TargetEnvironment", - "smithy.api#documentation": "

The target virtualization environment.

", - "smithy.api#xmlName": "targetEnvironment" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an instance to export.

" - } - }, - "com.amazonaws.ec2#InstanceFamilyCreditSpecification": { - "type": "structure", - "members": { - "InstanceFamily": { - "target": "com.amazonaws.ec2#UnlimitedSupportedInstanceFamily", - "traits": { - "aws.protocols#ec2QueryName": "InstanceFamily", - "smithy.api#documentation": "

The instance family.

", - "smithy.api#xmlName": "instanceFamily" - } - }, - "CpuCredits": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CpuCredits", - "smithy.api#documentation": "

The default credit option for CPU usage of the instance family. Valid values are\n standard and unlimited.

", - "smithy.api#xmlName": "cpuCredits" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the default credit option for CPU usage of a burstable performance instance\n family.

" - } - }, - "com.amazonaws.ec2#InstanceGeneration": { - "type": "enum", - "members": { - "CURRENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "current" - } - }, - "PREVIOUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "previous" - } - } - } - }, - "com.amazonaws.ec2#InstanceGenerationSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#InstanceGeneration", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#InstanceHealthStatus": { - "type": "enum", - "members": { - "HEALTHY_STATUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "healthy" - } - }, - "UNHEALTHY_STATUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unhealthy" - } - } - } - }, - "com.amazonaws.ec2#InstanceId": { - "type": "string" - }, - "com.amazonaws.ec2#InstanceIdForResolver": { - "type": "string" - }, - "com.amazonaws.ec2#InstanceIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#InstanceIdSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#InstanceIdStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "smithy.api#xmlName": "InstanceId" - } - } - }, - "com.amazonaws.ec2#InstanceIdWithVolumeResolver": { - "type": "string" - }, - "com.amazonaws.ec2#InstanceIdsSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#InstanceInterruptionBehavior": { - "type": "enum", - "members": { - "hibernate": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "hibernate" - } - }, - "stop": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "stop" - } - }, - "terminate": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "terminate" - } - } - } - }, - "com.amazonaws.ec2#InstanceIpv4Prefix": { - "type": "structure", - "members": { - "Ipv4Prefix": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Ipv4Prefix", - "smithy.api#documentation": "

One or more IPv4 prefixes assigned to the network interface.

", - "smithy.api#xmlName": "ipv4Prefix" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about an IPv4 prefix.

" - } - }, - "com.amazonaws.ec2#InstanceIpv4PrefixList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#InstanceIpv4Prefix", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#InstanceIpv6Address": { - "type": "structure", - "members": { - "Ipv6Address": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6Address", - "smithy.api#documentation": "

The IPv6 address.

", - "smithy.api#xmlName": "ipv6Address" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an IPv6 address.

" - } - }, - "com.amazonaws.ec2#InstanceIpv6AddressList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#InstanceIpv6Address", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#InstanceIpv6AddressListRequest": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#InstanceIpv6AddressRequest", - "traits": { - "smithy.api#xmlName": "InstanceIpv6Address" - } - } - }, - "com.amazonaws.ec2#InstanceIpv6AddressRequest": { - "type": "structure", - "members": { - "Ipv6Address": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The IPv6 address.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an IPv6 address.

" - } - }, - "com.amazonaws.ec2#InstanceIpv6Prefix": { - "type": "structure", - "members": { - "Ipv6Prefix": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6Prefix", - "smithy.api#documentation": "

One or more IPv6 prefixes assigned to the network interface.

", - "smithy.api#xmlName": "ipv6Prefix" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about an IPv6 prefix.

" - } - }, - "com.amazonaws.ec2#InstanceIpv6PrefixList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#InstanceIpv6Prefix", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#InstanceLifecycle": { - "type": "enum", - "members": { - "SPOT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "spot" - } - }, - "ON_DEMAND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "on-demand" - } - } - } - }, - "com.amazonaws.ec2#InstanceLifecycleType": { - "type": "enum", - "members": { - "spot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "spot" - } - }, - "scheduled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "scheduled" - } - } - } - }, - "com.amazonaws.ec2#InstanceList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Instance", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#InstanceMaintenanceOptions": { - "type": "structure", - "members": { - "AutoRecovery": { - "target": "com.amazonaws.ec2#InstanceAutoRecoveryState", - "traits": { - "aws.protocols#ec2QueryName": "AutoRecovery", - "smithy.api#documentation": "

Provides information on the current automatic recovery behavior of your\n instance.

", - "smithy.api#xmlName": "autoRecovery" - } - } - }, - "traits": { - "smithy.api#documentation": "

The maintenance options for the instance.

" - } - }, - "com.amazonaws.ec2#InstanceMaintenanceOptionsRequest": { - "type": "structure", - "members": { - "AutoRecovery": { - "target": "com.amazonaws.ec2#InstanceAutoRecoveryState", - "traits": { - "smithy.api#documentation": "

Disables the automatic recovery behavior of your instance or sets it to default. For\n more information, see Simplified automatic recovery.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The maintenance options for the instance.

" - } - }, - "com.amazonaws.ec2#InstanceMarketOptionsRequest": { - "type": "structure", - "members": { - "MarketType": { - "target": "com.amazonaws.ec2#MarketType", - "traits": { - "smithy.api#documentation": "

The market type.

" - } - }, - "SpotOptions": { - "target": "com.amazonaws.ec2#SpotMarketOptions", - "traits": { - "smithy.api#documentation": "

The options for Spot Instances.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the market (purchasing) option for the instances.

" - } - }, - "com.amazonaws.ec2#InstanceMatchCriteria": { - "type": "enum", - "members": { - "open": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "open" - } - }, - "targeted": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "targeted" - } - } - } - }, - "com.amazonaws.ec2#InstanceMetadataEndpointState": { - "type": "enum", - "members": { - "disabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disabled" - } - }, - "enabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enabled" - } - } - } - }, - "com.amazonaws.ec2#InstanceMetadataOptionsRequest": { - "type": "structure", - "members": { - "HttpTokens": { - "target": "com.amazonaws.ec2#HttpTokensState", - "traits": { - "smithy.api#documentation": "

IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to optional\n (in other words, set the use of IMDSv2 to optional) or\n required (in other words, set the use of IMDSv2 to\n required).

\n \n

Default: optional\n

" - } - }, - "HttpPutResponseHopLimit": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel.

\n

Default: 1

\n

Possible values: Integers from 1 to 64

" - } - }, - "HttpEndpoint": { - "target": "com.amazonaws.ec2#InstanceMetadataEndpointState", - "traits": { - "smithy.api#documentation": "

Enables or disables the HTTP metadata endpoint on your instances.

\n

If you specify a value of disabled, you cannot access your instance\n metadata.

\n

Default: enabled\n

" - } - }, - "HttpProtocolIpv6": { - "target": "com.amazonaws.ec2#InstanceMetadataProtocolState", - "traits": { - "smithy.api#documentation": "

Enables or disables the IPv6 endpoint for the instance metadata service.

" - } - }, - "InstanceMetadataTags": { - "target": "com.amazonaws.ec2#InstanceMetadataTagsState", - "traits": { - "smithy.api#documentation": "

Set to enabled to allow access to instance tags from the instance\n metadata. Set to disabled to turn off access to instance tags from the\n instance metadata. For more information, see Work with\n instance tags using the instance metadata.

\n

Default: disabled\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The metadata options for the instance.

" - } - }, - "com.amazonaws.ec2#InstanceMetadataOptionsResponse": { - "type": "structure", - "members": { - "State": { - "target": "com.amazonaws.ec2#InstanceMetadataOptionsState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the metadata option changes.

\n

\n pending - The metadata options are being updated and the instance is not\n ready to process metadata traffic with the new selection.

\n

\n applied - The metadata options have been successfully applied on the\n instance.

", - "smithy.api#xmlName": "state" - } - }, - "HttpTokens": { - "target": "com.amazonaws.ec2#HttpTokensState", - "traits": { - "aws.protocols#ec2QueryName": "HttpTokens", - "smithy.api#documentation": "

IMDSv2 uses token-backed sessions. Indicates whether the use of HTTP tokens is\n optional (in other words, indicates whether the use of IMDSv2 is\n optional) or required (in other words, indicates whether\n the use of IMDSv2 is required).

\n \n

Default: optional\n

", - "smithy.api#xmlName": "httpTokens" - } - }, - "HttpPutResponseHopLimit": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "HttpPutResponseHopLimit", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel.

\n

Default: 1

\n

Possible values: Integers from 1 to 64

", - "smithy.api#xmlName": "httpPutResponseHopLimit" - } - }, - "HttpEndpoint": { - "target": "com.amazonaws.ec2#InstanceMetadataEndpointState", - "traits": { - "aws.protocols#ec2QueryName": "HttpEndpoint", - "smithy.api#documentation": "

Indicates whether the HTTP metadata endpoint on your instances is enabled or\n disabled.

\n

If the value is disabled, you cannot access your instance\n metadata.

", - "smithy.api#xmlName": "httpEndpoint" - } - }, - "HttpProtocolIpv6": { - "target": "com.amazonaws.ec2#InstanceMetadataProtocolState", - "traits": { - "aws.protocols#ec2QueryName": "HttpProtocolIpv6", - "smithy.api#documentation": "

Indicates whether the IPv6 endpoint for the instance metadata service is enabled or\n disabled.

", - "smithy.api#xmlName": "httpProtocolIpv6" - } - }, - "InstanceMetadataTags": { - "target": "com.amazonaws.ec2#InstanceMetadataTagsState", - "traits": { - "aws.protocols#ec2QueryName": "InstanceMetadataTags", - "smithy.api#documentation": "

Indicates whether access to instance tags from the instance metadata is enabled or\n disabled. For more information, see Work with\n instance tags using the instance metadata.

", - "smithy.api#xmlName": "instanceMetadataTags" - } - } - }, - "traits": { - "smithy.api#documentation": "

The metadata options for the instance.

" - } - }, - "com.amazonaws.ec2#InstanceMetadataOptionsState": { - "type": "enum", - "members": { - "pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "applied": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "applied" - } - } - } - }, - "com.amazonaws.ec2#InstanceMetadataProtocolState": { - "type": "enum", - "members": { - "disabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disabled" - } - }, - "enabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enabled" - } - } - } - }, - "com.amazonaws.ec2#InstanceMetadataTagsState": { - "type": "enum", - "members": { - "disabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disabled" - } - }, - "enabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enabled" - } - } - } - }, - "com.amazonaws.ec2#InstanceMonitoring": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#xmlName": "instanceId" - } - }, - "Monitoring": { - "target": "com.amazonaws.ec2#Monitoring", - "traits": { - "aws.protocols#ec2QueryName": "Monitoring", - "smithy.api#documentation": "

The monitoring for the instance.

", - "smithy.api#xmlName": "monitoring" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the monitoring of an instance.

" - } - }, - "com.amazonaws.ec2#InstanceMonitoringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#InstanceMonitoring", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#InstanceNetworkInterface": { - "type": "structure", - "members": { - "Association": { - "target": "com.amazonaws.ec2#InstanceNetworkInterfaceAssociation", - "traits": { - "aws.protocols#ec2QueryName": "Association", - "smithy.api#documentation": "

The association information for an Elastic IPv4 associated with the network\n interface.

", - "smithy.api#xmlName": "association" - } - }, - "Attachment": { - "target": "com.amazonaws.ec2#InstanceNetworkInterfaceAttachment", - "traits": { - "aws.protocols#ec2QueryName": "Attachment", - "smithy.api#documentation": "

The network interface attachment.

", - "smithy.api#xmlName": "attachment" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

The description.

", - "smithy.api#xmlName": "description" - } - }, - "Groups": { - "target": "com.amazonaws.ec2#GroupIdentifierList", - "traits": { - "aws.protocols#ec2QueryName": "GroupSet", - "smithy.api#documentation": "

The security groups.

", - "smithy.api#xmlName": "groupSet" - } - }, - "Ipv6Addresses": { - "target": "com.amazonaws.ec2#InstanceIpv6AddressList", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6AddressesSet", - "smithy.api#documentation": "

The IPv6 addresses associated with the network interface.

", - "smithy.api#xmlName": "ipv6AddressesSet" - } - }, - "MacAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "MacAddress", - "smithy.api#documentation": "

The MAC address.

", - "smithy.api#xmlName": "macAddress" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "

The ID of the network interface.

", - "smithy.api#xmlName": "networkInterfaceId" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that created the network interface.

", - "smithy.api#xmlName": "ownerId" - } - }, - "PrivateDnsName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrivateDnsName", - "smithy.api#documentation": "

The private DNS name.

", - "smithy.api#xmlName": "privateDnsName" - } - }, - "PrivateIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrivateIpAddress", - "smithy.api#documentation": "

The IPv4 address of the network interface within the subnet.

", - "smithy.api#xmlName": "privateIpAddress" - } - }, - "PrivateIpAddresses": { - "target": "com.amazonaws.ec2#InstancePrivateIpAddressList", - "traits": { - "aws.protocols#ec2QueryName": "PrivateIpAddressesSet", - "smithy.api#documentation": "

The private IPv4 addresses associated with the network interface.

", - "smithy.api#xmlName": "privateIpAddressesSet" - } - }, - "SourceDestCheck": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "SourceDestCheck", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether source/destination checking is enabled.

", - "smithy.api#xmlName": "sourceDestCheck" - } - }, - "Status": { - "target": "com.amazonaws.ec2#NetworkInterfaceStatus", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The status of the network interface.

", - "smithy.api#xmlName": "status" - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#documentation": "

The ID of the subnet.

", - "smithy.api#xmlName": "subnetId" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#xmlName": "vpcId" - } - }, - "InterfaceType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InterfaceType", - "smithy.api#documentation": "

The type of network interface.

\n

Valid values: interface | efa | trunk\n

", - "smithy.api#xmlName": "interfaceType" - } - }, - "Ipv4Prefixes": { - "target": "com.amazonaws.ec2#InstanceIpv4PrefixList", - "traits": { - "aws.protocols#ec2QueryName": "Ipv4PrefixSet", - "smithy.api#documentation": "

The IPv4 delegated prefixes that are assigned to the network interface.

", - "smithy.api#xmlName": "ipv4PrefixSet" - } - }, - "Ipv6Prefixes": { - "target": "com.amazonaws.ec2#InstanceIpv6PrefixList", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6PrefixSet", - "smithy.api#documentation": "

The IPv6 delegated prefixes that are assigned to the network interface.

", - "smithy.api#xmlName": "ipv6PrefixSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a network interface.

" - } - }, - "com.amazonaws.ec2#InstanceNetworkInterfaceAssociation": { - "type": "structure", - "members": { - "CarrierIp": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CarrierIp", - "smithy.api#documentation": "

The carrier IP address associated with the network interface.

", - "smithy.api#xmlName": "carrierIp" - } - }, - "CustomerOwnedIp": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CustomerOwnedIp", - "smithy.api#documentation": "

The customer-owned IP address associated with the network interface.

", - "smithy.api#xmlName": "customerOwnedIp" - } - }, - "IpOwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "IpOwnerId", - "smithy.api#documentation": "

The ID of the owner of the Elastic IP address.

", - "smithy.api#xmlName": "ipOwnerId" - } - }, - "PublicDnsName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PublicDnsName", - "smithy.api#documentation": "

The public DNS name.

", - "smithy.api#xmlName": "publicDnsName" - } - }, - "PublicIp": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PublicIp", - "smithy.api#documentation": "

The public IP address or Elastic IP address bound to the network interface.

", - "smithy.api#xmlName": "publicIp" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes association information for an Elastic IP address (IPv4).

" - } - }, - "com.amazonaws.ec2#InstanceNetworkInterfaceAttachment": { - "type": "structure", - "members": { - "AttachTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "AttachTime", - "smithy.api#documentation": "

The time stamp when the attachment initiated.

", - "smithy.api#xmlName": "attachTime" - } - }, - "AttachmentId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AttachmentId", - "smithy.api#documentation": "

The ID of the network interface attachment.

", - "smithy.api#xmlName": "attachmentId" - } - }, - "DeleteOnTermination": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DeleteOnTermination", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the network interface is deleted when the instance is terminated.

", - "smithy.api#xmlName": "deleteOnTermination" - } - }, - "DeviceIndex": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "DeviceIndex", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The index of the device on the instance for the network interface attachment.

", - "smithy.api#xmlName": "deviceIndex" - } - }, - "Status": { - "target": "com.amazonaws.ec2#AttachmentStatus", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The attachment state.

", - "smithy.api#xmlName": "status" - } - }, - "NetworkCardIndex": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "NetworkCardIndex", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The index of the network card.

", - "smithy.api#xmlName": "networkCardIndex" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a network interface attachment.

" - } - }, - "com.amazonaws.ec2#InstanceNetworkInterfaceList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#InstanceNetworkInterface", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#InstanceNetworkInterfaceSpecification": { - "type": "structure", - "members": { - "AssociatePublicIpAddress": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "AssociatePublicIpAddress", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The\n public IP address can only be assigned to a network interface for eth0, and can only be\n assigned to a new network interface, not an existing one. You cannot specify more than one\n network interface in the request. If launching into a default subnet, the default value is\n true.

", - "smithy.api#xmlName": "associatePublicIpAddress" - } - }, - "DeleteOnTermination": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DeleteOnTermination", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

If set to true, the interface is deleted when the instance is terminated. You can\n specify true only if creating a new network interface when launching an\n instance.

", - "smithy.api#xmlName": "deleteOnTermination" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

The description of the network interface. Applies only if creating a network interface when launching an instance.

", - "smithy.api#xmlName": "description" - } - }, - "DeviceIndex": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "DeviceIndex", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The position of the network interface in the attachment order. \n A primary network interface has a device index of 0.

\n

If you specify a network interface when launching an instance, \n you must specify the device index.

", - "smithy.api#xmlName": "deviceIndex" - } - }, - "Groups": { - "target": "com.amazonaws.ec2#SecurityGroupIdStringList", - "traits": { - "smithy.api#documentation": "

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

", - "smithy.api#xmlName": "SecurityGroupId" - } - }, - "Ipv6AddressCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6AddressCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses\n the IPv6 addresses from the range of the subnet. You cannot specify this option and the\n option to assign specific IPv6 addresses in the same request. You can specify this\n option if you've specified a minimum number of instances to launch.

", - "smithy.api#xmlName": "ipv6AddressCount" - } - }, - "Ipv6Addresses": { - "target": "com.amazonaws.ec2#InstanceIpv6AddressList", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6Addresses", - "smithy.api#documentation": "

The IPv6 addresses to assign to the network interface. You cannot specify\n this option and the option to assign a number of IPv6 addresses in the same request. You\n cannot specify this option if you've specified a minimum number of instances to\n launch.

", - "smithy.api#xmlName": "ipv6AddressesSet" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#NetworkInterfaceId", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "

The ID of the network interface.

\n

If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.

", - "smithy.api#xmlName": "networkInterfaceId" - } - }, - "PrivateIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrivateIpAddress", - "smithy.api#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\n \tmore than one instance in a RunInstances request.

", - "smithy.api#xmlName": "privateIpAddress" - } - }, - "PrivateIpAddresses": { - "target": "com.amazonaws.ec2#PrivateIpAddressSpecificationList", - "traits": { - "aws.protocols#ec2QueryName": "PrivateIpAddresses", - "smithy.api#documentation": "

The 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\n \tlaunching more than one instance in a RunInstances request.

", - "smithy.api#xmlName": "privateIpAddressesSet" - } - }, - "SecondaryPrivateIpAddressCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "SecondaryPrivateIpAddressCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#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\n \tlaunching more than one instance in a RunInstances request.

", - "smithy.api#xmlName": "secondaryPrivateIpAddressCount" - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#documentation": "

The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.

", - "smithy.api#xmlName": "subnetId" - } - }, - "AssociateCarrierIpAddress": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to assign a carrier IP address to the network interface.

\n

You can only assign a carrier IP address to a network interface that is in a subnet in\n a Wavelength Zone. For more information about carrier IP addresses, see Carrier IP address in the Amazon Web Services Wavelength Developer\n Guide.

" - } - }, - "InterfaceType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The type of network interface.

\n

Valid values: interface | efa\n

" - } - }, - "NetworkCardIndex": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The index of the network card. Some instance types support multiple network cards. \n The primary network interface must be assigned to network card index 0. \n The default is network card index 0.

\n

If you are using RequestSpotInstances to create Spot Instances, omit this parameter because\n you can’t specify the network card index when using this API. To specify the network\n card index, use RunInstances.

" - } - }, - "Ipv4Prefixes": { - "target": "com.amazonaws.ec2#Ipv4PrefixList", - "traits": { - "smithy.api#documentation": "

The IPv4 delegated prefixes to be assigned to the network interface. You cannot \n use this option if you use the Ipv4PrefixCount option.

", - "smithy.api#xmlName": "Ipv4Prefix" - } - }, - "Ipv4PrefixCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of IPv4 delegated prefixes to be automatically assigned to the network interface. \n You cannot use this option if you use the Ipv4Prefix option.

" - } - }, - "Ipv6Prefixes": { - "target": "com.amazonaws.ec2#Ipv6PrefixList", - "traits": { - "smithy.api#documentation": "

The IPv6 delegated prefixes to be assigned to the network interface. You cannot \n use this option if you use the Ipv6PrefixCount option.

", - "smithy.api#xmlName": "Ipv6Prefix" - } - }, - "Ipv6PrefixCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of IPv6 delegated prefixes to be automatically assigned to the network interface. \n You cannot use this option if you use the Ipv6Prefix option.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a network interface.

" - } - }, - "com.amazonaws.ec2#InstanceNetworkInterfaceSpecificationList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#InstanceNetworkInterfaceSpecification", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#InstancePrivateIpAddress": { - "type": "structure", - "members": { - "Association": { - "target": "com.amazonaws.ec2#InstanceNetworkInterfaceAssociation", - "traits": { - "aws.protocols#ec2QueryName": "Association", - "smithy.api#documentation": "

The association information for an Elastic IP address for the network interface.

", - "smithy.api#xmlName": "association" - } - }, - "Primary": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Primary", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether this IPv4 address is the primary private IP address of the network interface.

", - "smithy.api#xmlName": "primary" - } - }, - "PrivateDnsName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrivateDnsName", - "smithy.api#documentation": "

The private IPv4 DNS name.

", - "smithy.api#xmlName": "privateDnsName" - } - }, - "PrivateIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrivateIpAddress", - "smithy.api#documentation": "

The private IPv4 address of the network interface.

", - "smithy.api#xmlName": "privateIpAddress" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a private IPv4 address.

" - } - }, - "com.amazonaws.ec2#InstancePrivateIpAddressList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#InstancePrivateIpAddress", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#InstanceRequirements": { - "type": "structure", - "members": { - "VCpuCount": { - "target": "com.amazonaws.ec2#VCpuCountRange", - "traits": { - "aws.protocols#ec2QueryName": "VCpuCount", - "smithy.api#documentation": "

The minimum and maximum number of vCPUs.

", - "smithy.api#xmlName": "vCpuCount" - } - }, - "MemoryMiB": { - "target": "com.amazonaws.ec2#MemoryMiB", - "traits": { - "aws.protocols#ec2QueryName": "MemoryMiB", - "smithy.api#documentation": "

The minimum and maximum amount of memory, in MiB.

", - "smithy.api#xmlName": "memoryMiB" - } - }, - "CpuManufacturers": { - "target": "com.amazonaws.ec2#CpuManufacturerSet", - "traits": { - "aws.protocols#ec2QueryName": "CpuManufacturerSet", - "smithy.api#documentation": "

The CPU manufacturers to include.

\n \n \n

Don't confuse the CPU manufacturer with the CPU architecture. Instances will \n be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you \n specify in your launch template.

\n \n

Default: Any manufacturer

", - "smithy.api#xmlName": "cpuManufacturerSet" - } - }, - "MemoryGiBPerVCpu": { - "target": "com.amazonaws.ec2#MemoryGiBPerVCpu", - "traits": { - "aws.protocols#ec2QueryName": "MemoryGiBPerVCpu", - "smithy.api#documentation": "

The minimum and maximum amount of memory per vCPU, in GiB.

\n

Default: No minimum or maximum limits

", - "smithy.api#xmlName": "memoryGiBPerVCpu" - } - }, - "ExcludedInstanceTypes": { - "target": "com.amazonaws.ec2#ExcludedInstanceTypeSet", - "traits": { - "aws.protocols#ec2QueryName": "ExcludedInstanceTypeSet", - "smithy.api#documentation": "

The instance types to exclude.

\n

You can use strings with one or more wild cards, represented by\n an asterisk (*), to exclude an instance type, size, or generation. The\n following are examples: m5.8xlarge, c5*.*, m5a.*,\n r*, *3*.

\n

For example, if you specify c5*,Amazon EC2 will exclude the entire C5 instance\n family, which includes all C5a and C5n instance types. If you specify\n m5a.*, Amazon EC2 will exclude all the M5a instance types, but not the M5n\n instance types.

\n \n

If you specify ExcludedInstanceTypes, you can't specify AllowedInstanceTypes.

\n \n

Default: No excluded instance types

", - "smithy.api#xmlName": "excludedInstanceTypeSet" - } - }, - "InstanceGenerations": { - "target": "com.amazonaws.ec2#InstanceGenerationSet", - "traits": { - "aws.protocols#ec2QueryName": "InstanceGenerationSet", - "smithy.api#documentation": "

Indicates whether current or previous generation instance types are included. The\n current generation instance types are recommended for use. Current generation instance types are\n typically the latest two to three generations in each instance family. For more\n information, see Instance types in the\n Amazon EC2 User Guide.

\n

For current generation instance types, specify current.

\n

For previous generation instance types, specify previous.

\n

Default: Current and previous generation instance types

", - "smithy.api#xmlName": "instanceGenerationSet" - } - }, - "SpotMaxPricePercentageOverLowestPrice": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "SpotMaxPricePercentageOverLowestPrice", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance,\n expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified\n attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance\n types priced above your threshold.

\n

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

\n

To turn off price protection, specify a high value, such as 999999.

\n

This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.

\n \n

If you set TargetCapacityUnitType to vcpu or\n memory-mib, the price protection threshold is applied based on the\n per-vCPU or per-memory price instead of the per-instance price.

\n \n

Default: 100\n

", - "smithy.api#xmlName": "spotMaxPricePercentageOverLowestPrice" - } - }, - "OnDemandMaxPricePercentageOverLowestPrice": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "OnDemandMaxPricePercentageOverLowestPrice", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance,\n expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified\n attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance\n types priced above your threshold.

\n

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

\n

To turn off price protection, specify a high value, such as 999999.

\n

This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.

\n \n

If you set TargetCapacityUnitType to vcpu or\n memory-mib, the price protection threshold is applied based on the\n per-vCPU or per-memory price instead of the per-instance price.

\n \n

Default: 20\n

", - "smithy.api#xmlName": "onDemandMaxPricePercentageOverLowestPrice" - } - }, - "BareMetal": { - "target": "com.amazonaws.ec2#BareMetal", - "traits": { - "aws.protocols#ec2QueryName": "BareMetal", - "smithy.api#documentation": "

Indicates whether bare metal instance types must be included, excluded, or required.

\n \n

Default: excluded\n

", - "smithy.api#xmlName": "bareMetal" - } - }, - "BurstablePerformance": { - "target": "com.amazonaws.ec2#BurstablePerformance", - "traits": { - "aws.protocols#ec2QueryName": "BurstablePerformance", - "smithy.api#documentation": "

Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see \n Burstable performance instances.

\n \n

Default: excluded\n

", - "smithy.api#xmlName": "burstablePerformance" - } - }, - "RequireHibernateSupport": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "RequireHibernateSupport", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether instance types must support hibernation for On-Demand\n Instances.

\n

This parameter is not supported for GetSpotPlacementScores.

\n

Default: false\n

", - "smithy.api#xmlName": "requireHibernateSupport" - } - }, - "NetworkInterfaceCount": { - "target": "com.amazonaws.ec2#NetworkInterfaceCount", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceCount", - "smithy.api#documentation": "

The minimum and maximum number of network interfaces.

\n

Default: No minimum or maximum limits

", - "smithy.api#xmlName": "networkInterfaceCount" - } - }, - "LocalStorage": { - "target": "com.amazonaws.ec2#LocalStorage", - "traits": { - "aws.protocols#ec2QueryName": "LocalStorage", - "smithy.api#documentation": "

Indicates whether instance types with instance store volumes are included, excluded, or required. For more information,\n Amazon\n EC2 instance store in the Amazon EC2 User Guide.

\n \n

Default: included\n

", - "smithy.api#xmlName": "localStorage" - } - }, - "LocalStorageTypes": { - "target": "com.amazonaws.ec2#LocalStorageTypeSet", - "traits": { - "aws.protocols#ec2QueryName": "LocalStorageTypeSet", - "smithy.api#documentation": "

The type of local storage that is required.

\n \n

Default: hdd and ssd\n

", - "smithy.api#xmlName": "localStorageTypeSet" - } - }, - "TotalLocalStorageGB": { - "target": "com.amazonaws.ec2#TotalLocalStorageGB", - "traits": { - "aws.protocols#ec2QueryName": "TotalLocalStorageGB", - "smithy.api#documentation": "

The minimum and maximum amount of total local storage, in GB.

\n

Default: No minimum or maximum limits

", - "smithy.api#xmlName": "totalLocalStorageGB" - } - }, - "BaselineEbsBandwidthMbps": { - "target": "com.amazonaws.ec2#BaselineEbsBandwidthMbps", - "traits": { - "aws.protocols#ec2QueryName": "BaselineEbsBandwidthMbps", - "smithy.api#documentation": "

The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see\n Amazon\n EBS–optimized instances in the Amazon EC2 User Guide.

\n

Default: No minimum or maximum limits

", - "smithy.api#xmlName": "baselineEbsBandwidthMbps" - } - }, - "AcceleratorTypes": { - "target": "com.amazonaws.ec2#AcceleratorTypeSet", - "traits": { - "aws.protocols#ec2QueryName": "AcceleratorTypeSet", - "smithy.api#documentation": "

The accelerator types that must be on the instance type.

\n \n

Default: Any accelerator type

", - "smithy.api#xmlName": "acceleratorTypeSet" - } - }, - "AcceleratorCount": { - "target": "com.amazonaws.ec2#AcceleratorCount", - "traits": { - "aws.protocols#ec2QueryName": "AcceleratorCount", - "smithy.api#documentation": "

The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on\n an instance.

\n

To exclude accelerator-enabled instance types, set Max to 0.

\n

Default: No minimum or maximum limits

", - "smithy.api#xmlName": "acceleratorCount" - } - }, - "AcceleratorManufacturers": { - "target": "com.amazonaws.ec2#AcceleratorManufacturerSet", - "traits": { - "aws.protocols#ec2QueryName": "AcceleratorManufacturerSet", - "smithy.api#documentation": "

Indicates whether instance types must have accelerators by specific manufacturers.

\n \n

Default: Any manufacturer

", - "smithy.api#xmlName": "acceleratorManufacturerSet" - } - }, - "AcceleratorNames": { - "target": "com.amazonaws.ec2#AcceleratorNameSet", - "traits": { - "aws.protocols#ec2QueryName": "AcceleratorNameSet", - "smithy.api#documentation": "

The accelerators that must be on the instance type.

\n \n

Default: Any accelerator

", - "smithy.api#xmlName": "acceleratorNameSet" - } - }, - "AcceleratorTotalMemoryMiB": { - "target": "com.amazonaws.ec2#AcceleratorTotalMemoryMiB", - "traits": { - "aws.protocols#ec2QueryName": "AcceleratorTotalMemoryMiB", - "smithy.api#documentation": "

The minimum and maximum amount of total accelerator memory, in MiB.

\n

Default: No minimum or maximum limits

", - "smithy.api#xmlName": "acceleratorTotalMemoryMiB" - } - }, - "NetworkBandwidthGbps": { - "target": "com.amazonaws.ec2#NetworkBandwidthGbps", - "traits": { - "aws.protocols#ec2QueryName": "NetworkBandwidthGbps", - "smithy.api#documentation": "

The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).

\n

Default: No minimum or maximum limits

", - "smithy.api#xmlName": "networkBandwidthGbps" - } - }, - "AllowedInstanceTypes": { - "target": "com.amazonaws.ec2#AllowedInstanceTypeSet", - "traits": { - "aws.protocols#ec2QueryName": "AllowedInstanceTypeSet", - "smithy.api#documentation": "

The instance types to apply your specified attributes against. All other instance types \n are ignored, even if they match your specified attributes.

\n

You can use strings with one or more wild cards, represented by\n an asterisk (*), to allow an instance type, size, or generation. The\n following are examples: m5.8xlarge, c5*.*, m5a.*,\n r*, *3*.

\n

For example, if you specify c5*,Amazon EC2 will allow the entire C5 instance\n family, which includes all C5a and C5n instance types. If you specify\n m5a.*, Amazon EC2 will allow all the M5a instance types, but not the M5n\n instance types.

\n \n

If you specify AllowedInstanceTypes, you can't specify ExcludedInstanceTypes.

\n \n

Default: All instance types

", - "smithy.api#xmlName": "allowedInstanceTypeSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with these attributes.

\n

When you specify multiple attributes, you get instance types that satisfy all of the\n specified attributes. If you specify multiple values for an attribute, you get instance\n types that satisfy any of the specified values.

\n

To limit the list of instance types from which Amazon EC2 can identify matching instance types, \n you can use one of the following parameters, but not both in the same request:

\n \n \n

You must specify VCpuCount and MemoryMiB. All other attributes\n are optional. Any unspecified optional attribute is set to its default.

\n \n

For more information, see Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot\n placement score in the Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#InstanceRequirementsRequest": { - "type": "structure", - "members": { - "VCpuCount": { - "target": "com.amazonaws.ec2#VCpuCountRangeRequest", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The minimum and maximum number of vCPUs.

", - "smithy.api#required": {} - } - }, - "MemoryMiB": { - "target": "com.amazonaws.ec2#MemoryMiBRequest", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The minimum and maximum amount of memory, in MiB.

", - "smithy.api#required": {} - } - }, - "CpuManufacturers": { - "target": "com.amazonaws.ec2#CpuManufacturerSet", - "traits": { - "smithy.api#documentation": "

The CPU manufacturers to include.

\n \n \n

Don't confuse the CPU manufacturer with the CPU architecture. Instances will \n be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you \n specify in your launch template.

\n \n

Default: Any manufacturer

", - "smithy.api#xmlName": "CpuManufacturer" - } - }, - "MemoryGiBPerVCpu": { - "target": "com.amazonaws.ec2#MemoryGiBPerVCpuRequest", - "traits": { - "smithy.api#documentation": "

The minimum and maximum amount of memory per vCPU, in GiB.

\n

Default: No minimum or maximum limits

" - } - }, - "ExcludedInstanceTypes": { - "target": "com.amazonaws.ec2#ExcludedInstanceTypeSet", - "traits": { - "smithy.api#documentation": "

The instance types to exclude.

\n

You can use strings with one or more wild cards, represented by\n an asterisk (*), to exclude an instance family, type, size, or generation. The\n following are examples: m5.8xlarge, c5*.*, m5a.*,\n r*, *3*.

\n

For example, if you specify c5*,Amazon EC2 will exclude the entire C5 instance\n family, which includes all C5a and C5n instance types. If you specify\n m5a.*, Amazon EC2 will exclude all the M5a instance types, but not the M5n\n instance types.

\n \n

If you specify ExcludedInstanceTypes, you can't specify AllowedInstanceTypes.

\n \n

Default: No excluded instance types

", - "smithy.api#xmlName": "ExcludedInstanceType" - } - }, - "InstanceGenerations": { - "target": "com.amazonaws.ec2#InstanceGenerationSet", - "traits": { - "smithy.api#documentation": "

Indicates whether current or previous generation instance types are included. The\n current generation instance types are recommended for use. Current generation instance types are\n typically the latest two to three generations in each instance family. For more\n information, see Instance types in the\n Amazon EC2 User Guide.

\n

For current generation instance types, specify current.

\n

For previous generation instance types, specify previous.

\n

Default: Current and previous generation instance types

", - "smithy.api#xmlName": "InstanceGeneration" - } - }, - "SpotMaxPricePercentageOverLowestPrice": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The price protection threshold for Spot Instance. This is the maximum you’ll pay for an Spot Instance,\n expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified\n attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance\n types priced above your threshold.

\n

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

\n

To turn off price protection, specify a high value, such as 999999.

\n

This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.

\n \n

If you set TargetCapacityUnitType to vcpu or\n memory-mib, the price protection threshold is applied based on the\n per-vCPU or per-memory price instead of the per-instance price.

\n \n

Default: 100\n

" - } - }, - "OnDemandMaxPricePercentageOverLowestPrice": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance,\n expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified\n attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance\n types priced above your threshold.

\n

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

\n

To turn off price protection, specify a high value, such as 999999.

\n

This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.

\n \n

If you set TargetCapacityUnitType to vcpu or\n memory-mib, the price protection threshold is applied based on the\n per-vCPU or per-memory price instead of the per-instance price.

\n \n

Default: 20\n

" - } - }, - "BareMetal": { - "target": "com.amazonaws.ec2#BareMetal", - "traits": { - "smithy.api#documentation": "

Indicates whether bare metal instance types must be included, excluded, or required.

\n \n

Default: excluded\n

" - } - }, - "BurstablePerformance": { - "target": "com.amazonaws.ec2#BurstablePerformance", - "traits": { - "smithy.api#documentation": "

Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see \n Burstable performance instances.

\n \n

Default: excluded\n

" - } - }, - "RequireHibernateSupport": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether instance types must support hibernation for On-Demand Instances.

\n

This parameter is not supported for GetSpotPlacementScores.

\n

Default: false\n

" - } - }, - "NetworkInterfaceCount": { - "target": "com.amazonaws.ec2#NetworkInterfaceCountRequest", - "traits": { - "smithy.api#documentation": "

The minimum and maximum number of network interfaces.

\n

Default: No minimum or maximum limits

" - } - }, - "LocalStorage": { - "target": "com.amazonaws.ec2#LocalStorage", - "traits": { - "smithy.api#documentation": "

Indicates whether instance types with instance store volumes are included, excluded, or required. For more information,\n Amazon\n EC2 instance store in the Amazon EC2 User Guide.

\n \n

Default: included\n

" - } - }, - "LocalStorageTypes": { - "target": "com.amazonaws.ec2#LocalStorageTypeSet", - "traits": { - "smithy.api#documentation": "

The type of local storage that is required.

\n \n

Default: hdd and ssd\n

", - "smithy.api#xmlName": "LocalStorageType" - } - }, - "TotalLocalStorageGB": { - "target": "com.amazonaws.ec2#TotalLocalStorageGBRequest", - "traits": { - "smithy.api#documentation": "

The minimum and maximum amount of total local storage, in GB.

\n

Default: No minimum or maximum limits

" - } - }, - "BaselineEbsBandwidthMbps": { - "target": "com.amazonaws.ec2#BaselineEbsBandwidthMbpsRequest", - "traits": { - "smithy.api#documentation": "

The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see\n Amazon\n EBS–optimized instances in the Amazon EC2 User Guide.

\n

Default: No minimum or maximum limits

" - } - }, - "AcceleratorTypes": { - "target": "com.amazonaws.ec2#AcceleratorTypeSet", - "traits": { - "smithy.api#documentation": "

The accelerator types that must be on the instance type.

\n \n

Default: Any accelerator type

", - "smithy.api#xmlName": "AcceleratorType" - } - }, - "AcceleratorCount": { - "target": "com.amazonaws.ec2#AcceleratorCountRequest", - "traits": { - "smithy.api#documentation": "

The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on\n an instance.

\n

To exclude accelerator-enabled instance types, set Max to 0.

\n

Default: No minimum or maximum limits

" - } - }, - "AcceleratorManufacturers": { - "target": "com.amazonaws.ec2#AcceleratorManufacturerSet", - "traits": { - "smithy.api#documentation": "

Indicates whether instance types must have accelerators by specific manufacturers.

\n \n

Default: Any manufacturer

", - "smithy.api#xmlName": "AcceleratorManufacturer" - } - }, - "AcceleratorNames": { - "target": "com.amazonaws.ec2#AcceleratorNameSet", - "traits": { - "smithy.api#documentation": "

The accelerators that must be on the instance type.

\n \n

Default: Any accelerator

", - "smithy.api#xmlName": "AcceleratorName" - } - }, - "AcceleratorTotalMemoryMiB": { - "target": "com.amazonaws.ec2#AcceleratorTotalMemoryMiBRequest", - "traits": { - "smithy.api#documentation": "

The minimum and maximum amount of total accelerator memory, in MiB.

\n

Default: No minimum or maximum limits

" - } - }, - "NetworkBandwidthGbps": { - "target": "com.amazonaws.ec2#NetworkBandwidthGbpsRequest", - "traits": { - "smithy.api#documentation": "

The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).

\n

Default: No minimum or maximum limits

" - } - }, - "AllowedInstanceTypes": { - "target": "com.amazonaws.ec2#AllowedInstanceTypeSet", - "traits": { - "smithy.api#documentation": "

The instance types to apply your specified attributes against. All other instance types \n are ignored, even if they match your specified attributes.

\n

You can use strings with one or more wild cards, represented by\n an asterisk (*), to allow an instance type, size, or generation. The\n following are examples: m5.8xlarge, c5*.*, m5a.*,\n r*, *3*.

\n

For example, if you specify c5*,Amazon EC2 will allow the entire C5 instance\n family, which includes all C5a and C5n instance types. If you specify\n m5a.*, Amazon EC2 will allow all the M5a instance types, but not the M5n\n instance types.

\n \n

If you specify AllowedInstanceTypes, you can't specify ExcludedInstanceTypes.

\n \n

Default: All instance types

", - "smithy.api#xmlName": "AllowedInstanceType" - } - } - }, - "traits": { - "smithy.api#documentation": "

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with these attributes.

\n

When you specify multiple attributes, you get instance types that satisfy all of the\n specified attributes. If you specify multiple values for an attribute, you get instance\n types that satisfy any of the specified values.

\n

To limit the list of instance types from which Amazon EC2 can identify matching instance types, \n you can use one of the following parameters, but not both in the same request:

\n \n \n

You must specify VCpuCount and MemoryMiB. All other attributes\n are optional. Any unspecified optional attribute is set to its default.

\n \n

For more information, see Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot\n placement score in the Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#InstanceRequirementsWithMetadataRequest": { - "type": "structure", - "members": { - "ArchitectureTypes": { - "target": "com.amazonaws.ec2#ArchitectureTypeSet", - "traits": { - "smithy.api#documentation": "

The architecture type.

", - "smithy.api#xmlName": "ArchitectureType" - } - }, - "VirtualizationTypes": { - "target": "com.amazonaws.ec2#VirtualizationTypeSet", - "traits": { - "smithy.api#documentation": "

The virtualization type.

", - "smithy.api#xmlName": "VirtualizationType" - } - }, - "InstanceRequirements": { - "target": "com.amazonaws.ec2#InstanceRequirementsRequest", - "traits": { - "smithy.api#documentation": "

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with those attributes.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The architecture type, virtualization type, and other attributes for the instance types.\n When you specify instance attributes, Amazon EC2 will identify instance types with those\n attributes.

\n

If you specify InstanceRequirementsWithMetadataRequest, you can't specify\n InstanceTypes.

" - } - }, - "com.amazonaws.ec2#InstanceSpecification": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceIdWithVolumeResolver", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The instance to specify which volumes should be snapshotted.

", - "smithy.api#required": {} - } - }, - "ExcludeBootVolume": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Excludes the root volume from being snapshotted.

" - } - }, - "ExcludeDataVolumeIds": { - "target": "com.amazonaws.ec2#VolumeIdStringList", - "traits": { - "smithy.api#documentation": "

The IDs of the data (non-root) volumes to exclude from the multi-volume snapshot set. \n If you specify the ID of the root volume, the request fails. To exclude the root volume, \n use ExcludeBootVolume.

\n

You can specify up to 40 volume IDs per request.

", - "smithy.api#xmlName": "ExcludeDataVolumeId" - } - } - }, - "traits": { - "smithy.api#documentation": "

The instance details to specify which volumes should be snapshotted.

" - } - }, - "com.amazonaws.ec2#InstanceState": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The state of the instance as a 16-bit unsigned integer.

\n

The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values\n between 256 and 65,535. These numerical values are used for internal purposes and should\n be ignored.

\n

The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values\n between 0 and 255.

\n

The valid values for instance-state-code will all be in the range of the low byte and\n they are:

\n \n

You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in\n decimal.

", - "smithy.api#xmlName": "code" - } - }, - "Name": { - "target": "com.amazonaws.ec2#InstanceStateName", - "traits": { - "aws.protocols#ec2QueryName": "Name", - "smithy.api#documentation": "

The current state of the instance.

", - "smithy.api#xmlName": "name" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the current state of an instance.

" - } - }, - "com.amazonaws.ec2#InstanceStateChange": { - "type": "structure", - "members": { - "CurrentState": { - "target": "com.amazonaws.ec2#InstanceState", - "traits": { - "aws.protocols#ec2QueryName": "CurrentState", - "smithy.api#documentation": "

The current state of the instance.

", - "smithy.api#xmlName": "currentState" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#xmlName": "instanceId" - } - }, - "PreviousState": { - "target": "com.amazonaws.ec2#InstanceState", - "traits": { - "aws.protocols#ec2QueryName": "PreviousState", - "smithy.api#documentation": "

The previous state of the instance.

", - "smithy.api#xmlName": "previousState" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an instance state change.

" - } - }, - "com.amazonaws.ec2#InstanceStateChangeList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#InstanceStateChange", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#InstanceStateName": { - "type": "enum", - "members": { - "pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "running": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "running" - } - }, - "shutting_down": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "shutting-down" - } - }, - "terminated": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "terminated" - } - }, - "stopping": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "stopping" - } - }, - "stopped": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "stopped" - } - } - } - }, - "com.amazonaws.ec2#InstanceStatus": { - "type": "structure", - "members": { - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone of the instance.

", - "smithy.api#xmlName": "availabilityZone" - } - }, - "OutpostArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OutpostArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

", - "smithy.api#xmlName": "outpostArn" - } - }, - "Events": { - "target": "com.amazonaws.ec2#InstanceStatusEventList", - "traits": { - "aws.protocols#ec2QueryName": "EventsSet", - "smithy.api#documentation": "

Any scheduled events associated with the instance.

", - "smithy.api#xmlName": "eventsSet" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#xmlName": "instanceId" - } - }, - "InstanceState": { - "target": "com.amazonaws.ec2#InstanceState", - "traits": { - "aws.protocols#ec2QueryName": "InstanceState", - "smithy.api#documentation": "

The intended state of the instance. DescribeInstanceStatus requires\n that an instance be in the running state.

", - "smithy.api#xmlName": "instanceState" - } - }, - "InstanceStatus": { - "target": "com.amazonaws.ec2#InstanceStatusSummary", - "traits": { - "aws.protocols#ec2QueryName": "InstanceStatus", - "smithy.api#documentation": "

Reports impaired functionality that stems from issues internal to the instance, such\n as impaired reachability.

", - "smithy.api#xmlName": "instanceStatus" - } - }, - "SystemStatus": { - "target": "com.amazonaws.ec2#InstanceStatusSummary", - "traits": { - "aws.protocols#ec2QueryName": "SystemStatus", - "smithy.api#documentation": "

Reports impaired functionality that stems from issues related to the systems that\n support an instance, such as hardware failures and network connectivity problems.

", - "smithy.api#xmlName": "systemStatus" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the status of an instance.

" - } - }, - "com.amazonaws.ec2#InstanceStatusDetails": { - "type": "structure", - "members": { - "ImpairedSince": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "ImpairedSince", - "smithy.api#documentation": "

The time when a status check failed. For an instance that was launched and impaired,\n this is the time when the instance was launched.

", - "smithy.api#xmlName": "impairedSince" - } - }, - "Name": { - "target": "com.amazonaws.ec2#StatusName", - "traits": { - "aws.protocols#ec2QueryName": "Name", - "smithy.api#documentation": "

The type of instance status.

", - "smithy.api#xmlName": "name" - } - }, - "Status": { - "target": "com.amazonaws.ec2#StatusType", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The status.

", - "smithy.api#xmlName": "status" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the instance status.

" - } - }, - "com.amazonaws.ec2#InstanceStatusDetailsList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#InstanceStatusDetails", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#InstanceStatusEvent": { - "type": "structure", - "members": { - "InstanceEventId": { - "target": "com.amazonaws.ec2#InstanceEventId", - "traits": { - "aws.protocols#ec2QueryName": "InstanceEventId", - "smithy.api#documentation": "

The ID of the event.

", - "smithy.api#xmlName": "instanceEventId" - } - }, - "Code": { - "target": "com.amazonaws.ec2#EventCode", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The event code.

", - "smithy.api#xmlName": "code" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description of the event.

\n

After a scheduled event is completed, it can still be described for up to a week. If\n the event has been completed, this description starts with the following text:\n [Completed].

", - "smithy.api#xmlName": "description" - } - }, - "NotAfter": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "NotAfter", - "smithy.api#documentation": "

The latest scheduled end time for the event.

", - "smithy.api#xmlName": "notAfter" - } - }, - "NotBefore": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "NotBefore", - "smithy.api#documentation": "

The earliest scheduled start time for the event.

", - "smithy.api#xmlName": "notBefore" - } - }, - "NotBeforeDeadline": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "NotBeforeDeadline", - "smithy.api#documentation": "

The deadline for starting the event.

", - "smithy.api#xmlName": "notBeforeDeadline" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a scheduled event for an instance.

" - } - }, - "com.amazonaws.ec2#InstanceStatusEventList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#InstanceStatusEvent", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#InstanceStatusList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#InstanceStatus", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#InstanceStatusSummary": { - "type": "structure", - "members": { - "Details": { - "target": "com.amazonaws.ec2#InstanceStatusDetailsList", - "traits": { - "aws.protocols#ec2QueryName": "Details", - "smithy.api#documentation": "

The system instance health or application instance health.

", - "smithy.api#xmlName": "details" - } - }, - "Status": { - "target": "com.amazonaws.ec2#SummaryStatus", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The status.

", - "smithy.api#xmlName": "status" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the status of an instance.

" - } - }, - "com.amazonaws.ec2#InstanceStorageEncryptionSupport": { - "type": "enum", - "members": { - "unsupported": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unsupported" - } - }, - "required": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "required" - } - } - } - }, - "com.amazonaws.ec2#InstanceStorageFlag": { - "type": "boolean" - }, - "com.amazonaws.ec2#InstanceStorageInfo": { - "type": "structure", - "members": { - "TotalSizeInGB": { - "target": "com.amazonaws.ec2#DiskSize", - "traits": { - "aws.protocols#ec2QueryName": "TotalSizeInGB", - "smithy.api#documentation": "

The total size of the disks, in GB.

", - "smithy.api#xmlName": "totalSizeInGB" - } - }, - "Disks": { - "target": "com.amazonaws.ec2#DiskInfoList", - "traits": { - "aws.protocols#ec2QueryName": "Disks", - "smithy.api#documentation": "

Describes the disks that are available for the instance type.

", - "smithy.api#xmlName": "disks" - } - }, - "NvmeSupport": { - "target": "com.amazonaws.ec2#EphemeralNvmeSupport", - "traits": { - "aws.protocols#ec2QueryName": "NvmeSupport", - "smithy.api#documentation": "

Indicates whether non-volatile memory express (NVMe) is supported.

", - "smithy.api#xmlName": "nvmeSupport" - } - }, - "EncryptionSupport": { - "target": "com.amazonaws.ec2#InstanceStorageEncryptionSupport", - "traits": { - "aws.protocols#ec2QueryName": "EncryptionSupport", - "smithy.api#documentation": "

Indicates whether data is encrypted at rest.

", - "smithy.api#xmlName": "encryptionSupport" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the instance store features that are supported by the instance type.

" - } - }, - "com.amazonaws.ec2#InstanceTagKeySet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#InstanceTagNotificationAttribute": { - "type": "structure", - "members": { - "InstanceTagKeys": { - "target": "com.amazonaws.ec2#InstanceTagKeySet", - "traits": { - "aws.protocols#ec2QueryName": "InstanceTagKeySet", - "smithy.api#documentation": "

The registered tag keys.

", - "smithy.api#xmlName": "instanceTagKeySet" - } - }, - "IncludeAllTagsOfInstance": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "IncludeAllTagsOfInstance", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates wheter all tag keys in the current Region are registered to appear in scheduled event notifications. \n \ttrue indicates that all tag keys in the current Region are registered.

", - "smithy.api#xmlName": "includeAllTagsOfInstance" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the registered tag keys for the current Region.

" - } - }, - "com.amazonaws.ec2#InstanceType": { - "type": "enum", - "members": { - "a1_medium": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "a1.medium" - } - }, - "a1_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "a1.large" - } - }, - "a1_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "a1.xlarge" - } - }, - "a1_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "a1.2xlarge" - } - }, - "a1_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "a1.4xlarge" - } - }, - "a1_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "a1.metal" - } - }, - "c1_medium": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c1.medium" - } - }, - "c1_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c1.xlarge" - } - }, - "c3_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c3.large" - } - }, - "c3_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c3.xlarge" - } - }, - "c3_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c3.2xlarge" - } - }, - "c3_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c3.4xlarge" - } - }, - "c3_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c3.8xlarge" - } - }, - "c4_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c4.large" - } - }, - "c4_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c4.xlarge" - } - }, - "c4_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c4.2xlarge" - } - }, - "c4_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c4.4xlarge" - } - }, - "c4_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c4.8xlarge" - } - }, - "c5_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5.large" - } - }, - "c5_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5.xlarge" - } - }, - "c5_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5.2xlarge" - } - }, - "c5_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5.4xlarge" - } - }, - "c5_9xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5.9xlarge" - } - }, - "c5_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5.12xlarge" - } - }, - "c5_18xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5.18xlarge" - } - }, - "c5_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5.24xlarge" - } - }, - "c5_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5.metal" - } - }, - "c5a_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5a.large" - } - }, - "c5a_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5a.xlarge" - } - }, - "c5a_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5a.2xlarge" - } - }, - "c5a_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5a.4xlarge" - } - }, - "c5a_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5a.8xlarge" - } - }, - "c5a_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5a.12xlarge" - } - }, - "c5a_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5a.16xlarge" - } - }, - "c5a_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5a.24xlarge" - } - }, - "c5ad_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5ad.large" - } - }, - "c5ad_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5ad.xlarge" - } - }, - "c5ad_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5ad.2xlarge" - } - }, - "c5ad_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5ad.4xlarge" - } - }, - "c5ad_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5ad.8xlarge" - } - }, - "c5ad_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5ad.12xlarge" - } - }, - "c5ad_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5ad.16xlarge" - } - }, - "c5ad_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5ad.24xlarge" - } - }, - "c5d_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5d.large" - } - }, - "c5d_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5d.xlarge" - } - }, - "c5d_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5d.2xlarge" - } - }, - "c5d_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5d.4xlarge" - } - }, - "c5d_9xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5d.9xlarge" - } - }, - "c5d_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5d.12xlarge" - } - }, - "c5d_18xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5d.18xlarge" - } - }, - "c5d_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5d.24xlarge" - } - }, - "c5d_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5d.metal" - } - }, - "c5n_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5n.large" - } - }, - "c5n_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5n.xlarge" - } - }, - "c5n_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5n.2xlarge" - } - }, - "c5n_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5n.4xlarge" - } - }, - "c5n_9xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5n.9xlarge" - } - }, - "c5n_18xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5n.18xlarge" - } - }, - "c5n_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c5n.metal" - } - }, - "c6g_medium": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6g.medium" - } - }, - "c6g_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6g.large" - } - }, - "c6g_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6g.xlarge" - } - }, - "c6g_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6g.2xlarge" - } - }, - "c6g_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6g.4xlarge" - } - }, - "c6g_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6g.8xlarge" - } - }, - "c6g_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6g.12xlarge" - } - }, - "c6g_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6g.16xlarge" - } - }, - "c6g_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6g.metal" - } - }, - "c6gd_medium": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6gd.medium" - } - }, - "c6gd_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6gd.large" - } - }, - "c6gd_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6gd.xlarge" - } - }, - "c6gd_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6gd.2xlarge" - } - }, - "c6gd_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6gd.4xlarge" - } - }, - "c6gd_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6gd.8xlarge" - } - }, - "c6gd_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6gd.12xlarge" - } - }, - "c6gd_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6gd.16xlarge" - } - }, - "c6gd_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6gd.metal" - } - }, - "c6gn_medium": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6gn.medium" - } - }, - "c6gn_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6gn.large" - } - }, - "c6gn_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6gn.xlarge" - } - }, - "c6gn_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6gn.2xlarge" - } - }, - "c6gn_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6gn.4xlarge" - } - }, - "c6gn_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6gn.8xlarge" - } - }, - "c6gn_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6gn.12xlarge" - } - }, - "c6gn_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6gn.16xlarge" - } - }, - "c6i_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6i.large" - } - }, - "c6i_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6i.xlarge" - } - }, - "c6i_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6i.2xlarge" - } - }, - "c6i_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6i.4xlarge" - } - }, - "c6i_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6i.8xlarge" - } - }, - "c6i_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6i.12xlarge" - } - }, - "c6i_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6i.16xlarge" - } - }, - "c6i_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6i.24xlarge" - } - }, - "c6i_32xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6i.32xlarge" - } - }, - "c6i_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6i.metal" - } - }, - "cc1_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cc1.4xlarge" - } - }, - "cc2_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cc2.8xlarge" - } - }, - "cg1_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cg1.4xlarge" - } - }, - "cr1_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cr1.8xlarge" - } - }, - "d2_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "d2.xlarge" - } - }, - "d2_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "d2.2xlarge" - } - }, - "d2_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "d2.4xlarge" - } - }, - "d2_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "d2.8xlarge" - } - }, - "d3_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "d3.xlarge" - } - }, - "d3_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "d3.2xlarge" - } - }, - "d3_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "d3.4xlarge" - } - }, - "d3_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "d3.8xlarge" - } - }, - "d3en_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "d3en.xlarge" - } - }, - "d3en_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "d3en.2xlarge" - } - }, - "d3en_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "d3en.4xlarge" - } - }, - "d3en_6xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "d3en.6xlarge" - } - }, - "d3en_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "d3en.8xlarge" - } - }, - "d3en_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "d3en.12xlarge" - } - }, - "dl1_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "dl1.24xlarge" - } - }, - "f1_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "f1.2xlarge" - } - }, - "f1_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "f1.4xlarge" - } - }, - "f1_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "f1.16xlarge" - } - }, - "g2_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "g2.2xlarge" - } - }, - "g2_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "g2.8xlarge" - } - }, - "g3_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "g3.4xlarge" - } - }, - "g3_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "g3.8xlarge" - } - }, - "g3_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "g3.16xlarge" - } - }, - "g3s_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "g3s.xlarge" - } - }, - "g4ad_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "g4ad.xlarge" - } - }, - "g4ad_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "g4ad.2xlarge" - } - }, - "g4ad_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "g4ad.4xlarge" - } - }, - "g4ad_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "g4ad.8xlarge" - } - }, - "g4ad_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "g4ad.16xlarge" - } - }, - "g4dn_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "g4dn.xlarge" - } - }, - "g4dn_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "g4dn.2xlarge" - } - }, - "g4dn_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "g4dn.4xlarge" - } - }, - "g4dn_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "g4dn.8xlarge" - } - }, - "g4dn_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "g4dn.12xlarge" - } - }, - "g4dn_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "g4dn.16xlarge" - } - }, - "g4dn_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "g4dn.metal" - } - }, - "g5_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "g5.xlarge" - } - }, - "g5_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "g5.2xlarge" - } - }, - "g5_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "g5.4xlarge" - } - }, - "g5_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "g5.8xlarge" - } - }, - "g5_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "g5.12xlarge" - } - }, - "g5_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "g5.16xlarge" - } - }, - "g5_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "g5.24xlarge" - } - }, - "g5_48xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "g5.48xlarge" - } - }, - "g5g_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "g5g.xlarge" - } - }, - "g5g_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "g5g.2xlarge" - } - }, - "g5g_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "g5g.4xlarge" - } - }, - "g5g_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "g5g.8xlarge" - } - }, - "g5g_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "g5g.16xlarge" - } - }, - "g5g_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "g5g.metal" - } - }, - "hi1_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "hi1.4xlarge" - } - }, - "hpc6a_48xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "hpc6a.48xlarge" - } - }, - "hs1_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "hs1.8xlarge" - } - }, - "h1_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "h1.2xlarge" - } - }, - "h1_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "h1.4xlarge" - } - }, - "h1_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "h1.8xlarge" - } - }, - "h1_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "h1.16xlarge" - } - }, - "i2_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "i2.xlarge" - } - }, - "i2_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "i2.2xlarge" - } - }, - "i2_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "i2.4xlarge" - } - }, - "i2_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "i2.8xlarge" - } - }, - "i3_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "i3.large" - } - }, - "i3_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "i3.xlarge" - } - }, - "i3_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "i3.2xlarge" - } - }, - "i3_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "i3.4xlarge" - } - }, - "i3_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "i3.8xlarge" - } - }, - "i3_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "i3.16xlarge" - } - }, - "i3_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "i3.metal" - } - }, - "i3en_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "i3en.large" - } - }, - "i3en_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "i3en.xlarge" - } - }, - "i3en_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "i3en.2xlarge" - } - }, - "i3en_3xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "i3en.3xlarge" - } - }, - "i3en_6xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "i3en.6xlarge" - } - }, - "i3en_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "i3en.12xlarge" - } - }, - "i3en_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "i3en.24xlarge" - } - }, - "i3en_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "i3en.metal" - } - }, - "im4gn_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "im4gn.large" - } - }, - "im4gn_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "im4gn.xlarge" - } - }, - "im4gn_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "im4gn.2xlarge" - } - }, - "im4gn_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "im4gn.4xlarge" - } - }, - "im4gn_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "im4gn.8xlarge" - } - }, - "im4gn_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "im4gn.16xlarge" - } - }, - "inf1_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "inf1.xlarge" - } - }, - "inf1_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "inf1.2xlarge" - } - }, - "inf1_6xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "inf1.6xlarge" - } - }, - "inf1_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "inf1.24xlarge" - } - }, - "is4gen_medium": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "is4gen.medium" - } - }, - "is4gen_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "is4gen.large" - } - }, - "is4gen_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "is4gen.xlarge" - } - }, - "is4gen_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "is4gen.2xlarge" - } - }, - "is4gen_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "is4gen.4xlarge" - } - }, - "is4gen_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "is4gen.8xlarge" - } - }, - "m1_small": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m1.small" - } - }, - "m1_medium": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m1.medium" - } - }, - "m1_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m1.large" - } - }, - "m1_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m1.xlarge" - } - }, - "m2_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m2.xlarge" - } - }, - "m2_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m2.2xlarge" - } - }, - "m2_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m2.4xlarge" - } - }, - "m3_medium": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m3.medium" - } - }, - "m3_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m3.large" - } - }, - "m3_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m3.xlarge" - } - }, - "m3_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m3.2xlarge" - } - }, - "m4_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m4.large" - } - }, - "m4_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m4.xlarge" - } - }, - "m4_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m4.2xlarge" - } - }, - "m4_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m4.4xlarge" - } - }, - "m4_10xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m4.10xlarge" - } - }, - "m4_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m4.16xlarge" - } - }, - "m5_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5.large" - } - }, - "m5_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5.xlarge" - } - }, - "m5_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5.2xlarge" - } - }, - "m5_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5.4xlarge" - } - }, - "m5_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5.8xlarge" - } - }, - "m5_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5.12xlarge" - } - }, - "m5_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5.16xlarge" - } - }, - "m5_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5.24xlarge" - } - }, - "m5_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5.metal" - } - }, - "m5a_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5a.large" - } - }, - "m5a_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5a.xlarge" - } - }, - "m5a_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5a.2xlarge" - } - }, - "m5a_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5a.4xlarge" - } - }, - "m5a_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5a.8xlarge" - } - }, - "m5a_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5a.12xlarge" - } - }, - "m5a_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5a.16xlarge" - } - }, - "m5a_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5a.24xlarge" - } - }, - "m5ad_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5ad.large" - } - }, - "m5ad_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5ad.xlarge" - } - }, - "m5ad_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5ad.2xlarge" - } - }, - "m5ad_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5ad.4xlarge" - } - }, - "m5ad_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5ad.8xlarge" - } - }, - "m5ad_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5ad.12xlarge" - } - }, - "m5ad_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5ad.16xlarge" - } - }, - "m5ad_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5ad.24xlarge" - } - }, - "m5d_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5d.large" - } - }, - "m5d_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5d.xlarge" - } - }, - "m5d_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5d.2xlarge" - } - }, - "m5d_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5d.4xlarge" - } - }, - "m5d_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5d.8xlarge" - } - }, - "m5d_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5d.12xlarge" - } - }, - "m5d_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5d.16xlarge" - } - }, - "m5d_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5d.24xlarge" - } - }, - "m5d_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5d.metal" - } - }, - "m5dn_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5dn.large" - } - }, - "m5dn_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5dn.xlarge" - } - }, - "m5dn_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5dn.2xlarge" - } - }, - "m5dn_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5dn.4xlarge" - } - }, - "m5dn_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5dn.8xlarge" - } - }, - "m5dn_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5dn.12xlarge" - } - }, - "m5dn_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5dn.16xlarge" - } - }, - "m5dn_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5dn.24xlarge" - } - }, - "m5dn_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5dn.metal" - } - }, - "m5n_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5n.large" - } - }, - "m5n_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5n.xlarge" - } - }, - "m5n_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5n.2xlarge" - } - }, - "m5n_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5n.4xlarge" - } - }, - "m5n_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5n.8xlarge" - } - }, - "m5n_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5n.12xlarge" - } - }, - "m5n_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5n.16xlarge" - } - }, - "m5n_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5n.24xlarge" - } - }, - "m5n_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5n.metal" - } - }, - "m5zn_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5zn.large" - } - }, - "m5zn_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5zn.xlarge" - } - }, - "m5zn_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5zn.2xlarge" - } - }, - "m5zn_3xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5zn.3xlarge" - } - }, - "m5zn_6xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5zn.6xlarge" - } - }, - "m5zn_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5zn.12xlarge" - } - }, - "m5zn_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m5zn.metal" - } - }, - "m6a_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6a.large" - } - }, - "m6a_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6a.xlarge" - } - }, - "m6a_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6a.2xlarge" - } - }, - "m6a_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6a.4xlarge" - } - }, - "m6a_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6a.8xlarge" - } - }, - "m6a_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6a.12xlarge" - } - }, - "m6a_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6a.16xlarge" - } - }, - "m6a_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6a.24xlarge" - } - }, - "m6a_32xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6a.32xlarge" - } - }, - "m6a_48xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6a.48xlarge" - } - }, - "m6g_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6g.metal" - } - }, - "m6g_medium": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6g.medium" - } - }, - "m6g_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6g.large" - } - }, - "m6g_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6g.xlarge" - } - }, - "m6g_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6g.2xlarge" - } - }, - "m6g_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6g.4xlarge" - } - }, - "m6g_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6g.8xlarge" - } - }, - "m6g_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6g.12xlarge" - } - }, - "m6g_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6g.16xlarge" - } - }, - "m6gd_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6gd.metal" - } - }, - "m6gd_medium": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6gd.medium" - } - }, - "m6gd_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6gd.large" - } - }, - "m6gd_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6gd.xlarge" - } - }, - "m6gd_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6gd.2xlarge" - } - }, - "m6gd_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6gd.4xlarge" - } - }, - "m6gd_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6gd.8xlarge" - } - }, - "m6gd_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6gd.12xlarge" - } - }, - "m6gd_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6gd.16xlarge" - } - }, - "m6i_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6i.large" - } - }, - "m6i_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6i.xlarge" - } - }, - "m6i_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6i.2xlarge" - } - }, - "m6i_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6i.4xlarge" - } - }, - "m6i_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6i.8xlarge" - } - }, - "m6i_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6i.12xlarge" - } - }, - "m6i_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6i.16xlarge" - } - }, - "m6i_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6i.24xlarge" - } - }, - "m6i_32xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6i.32xlarge" - } - }, - "m6i_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6i.metal" - } - }, - "mac1_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "mac1.metal" - } - }, - "p2_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "p2.xlarge" - } - }, - "p2_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "p2.8xlarge" - } - }, - "p2_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "p2.16xlarge" - } - }, - "p3_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "p3.2xlarge" - } - }, - "p3_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "p3.8xlarge" - } - }, - "p3_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "p3.16xlarge" - } - }, - "p3dn_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "p3dn.24xlarge" - } - }, - "p4d_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "p4d.24xlarge" - } - }, - "r3_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r3.large" - } - }, - "r3_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r3.xlarge" - } - }, - "r3_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r3.2xlarge" - } - }, - "r3_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r3.4xlarge" - } - }, - "r3_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r3.8xlarge" - } - }, - "r4_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r4.large" - } - }, - "r4_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r4.xlarge" - } - }, - "r4_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r4.2xlarge" - } - }, - "r4_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r4.4xlarge" - } - }, - "r4_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r4.8xlarge" - } - }, - "r4_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r4.16xlarge" - } - }, - "r5_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5.large" - } - }, - "r5_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5.xlarge" - } - }, - "r5_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5.2xlarge" - } - }, - "r5_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5.4xlarge" - } - }, - "r5_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5.8xlarge" - } - }, - "r5_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5.12xlarge" - } - }, - "r5_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5.16xlarge" - } - }, - "r5_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5.24xlarge" - } - }, - "r5_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5.metal" - } - }, - "r5a_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5a.large" - } - }, - "r5a_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5a.xlarge" - } - }, - "r5a_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5a.2xlarge" - } - }, - "r5a_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5a.4xlarge" - } - }, - "r5a_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5a.8xlarge" - } - }, - "r5a_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5a.12xlarge" - } - }, - "r5a_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5a.16xlarge" - } - }, - "r5a_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5a.24xlarge" - } - }, - "r5ad_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5ad.large" - } - }, - "r5ad_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5ad.xlarge" - } - }, - "r5ad_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5ad.2xlarge" - } - }, - "r5ad_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5ad.4xlarge" - } - }, - "r5ad_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5ad.8xlarge" - } - }, - "r5ad_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5ad.12xlarge" - } - }, - "r5ad_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5ad.16xlarge" - } - }, - "r5ad_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5ad.24xlarge" - } - }, - "r5b_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5b.large" - } - }, - "r5b_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5b.xlarge" - } - }, - "r5b_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5b.2xlarge" - } - }, - "r5b_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5b.4xlarge" - } - }, - "r5b_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5b.8xlarge" - } - }, - "r5b_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5b.12xlarge" - } - }, - "r5b_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5b.16xlarge" - } - }, - "r5b_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5b.24xlarge" - } - }, - "r5b_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5b.metal" - } - }, - "r5d_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5d.large" - } - }, - "r5d_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5d.xlarge" - } - }, - "r5d_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5d.2xlarge" - } - }, - "r5d_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5d.4xlarge" - } - }, - "r5d_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5d.8xlarge" - } - }, - "r5d_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5d.12xlarge" - } - }, - "r5d_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5d.16xlarge" - } - }, - "r5d_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5d.24xlarge" - } - }, - "r5d_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5d.metal" - } - }, - "r5dn_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5dn.large" - } - }, - "r5dn_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5dn.xlarge" - } - }, - "r5dn_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5dn.2xlarge" - } - }, - "r5dn_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5dn.4xlarge" - } - }, - "r5dn_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5dn.8xlarge" - } - }, - "r5dn_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5dn.12xlarge" - } - }, - "r5dn_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5dn.16xlarge" - } - }, - "r5dn_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5dn.24xlarge" - } - }, - "r5dn_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5dn.metal" - } - }, - "r5n_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5n.large" - } - }, - "r5n_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5n.xlarge" - } - }, - "r5n_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5n.2xlarge" - } - }, - "r5n_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5n.4xlarge" - } - }, - "r5n_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5n.8xlarge" - } - }, - "r5n_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5n.12xlarge" - } - }, - "r5n_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5n.16xlarge" - } - }, - "r5n_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5n.24xlarge" - } - }, - "r5n_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r5n.metal" - } - }, - "r6g_medium": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6g.medium" - } - }, - "r6g_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6g.large" - } - }, - "r6g_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6g.xlarge" - } - }, - "r6g_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6g.2xlarge" - } - }, - "r6g_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6g.4xlarge" - } - }, - "r6g_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6g.8xlarge" - } - }, - "r6g_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6g.12xlarge" - } - }, - "r6g_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6g.16xlarge" - } - }, - "r6g_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6g.metal" - } - }, - "r6gd_medium": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6gd.medium" - } - }, - "r6gd_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6gd.large" - } - }, - "r6gd_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6gd.xlarge" - } - }, - "r6gd_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6gd.2xlarge" - } - }, - "r6gd_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6gd.4xlarge" - } - }, - "r6gd_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6gd.8xlarge" - } - }, - "r6gd_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6gd.12xlarge" - } - }, - "r6gd_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6gd.16xlarge" - } - }, - "r6gd_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6gd.metal" - } - }, - "r6i_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6i.large" - } - }, - "r6i_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6i.xlarge" - } - }, - "r6i_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6i.2xlarge" - } - }, - "r6i_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6i.4xlarge" - } - }, - "r6i_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6i.8xlarge" - } - }, - "r6i_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6i.12xlarge" - } - }, - "r6i_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6i.16xlarge" - } - }, - "r6i_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6i.24xlarge" - } - }, - "r6i_32xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6i.32xlarge" - } - }, - "r6i_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6i.metal" - } - }, - "t1_micro": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "t1.micro" - } - }, - "t2_nano": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "t2.nano" - } - }, - "t2_micro": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "t2.micro" - } - }, - "t2_small": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "t2.small" - } - }, - "t2_medium": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "t2.medium" - } - }, - "t2_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "t2.large" - } - }, - "t2_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "t2.xlarge" - } - }, - "t2_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "t2.2xlarge" - } - }, - "t3_nano": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "t3.nano" - } - }, - "t3_micro": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "t3.micro" - } - }, - "t3_small": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "t3.small" - } - }, - "t3_medium": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "t3.medium" - } - }, - "t3_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "t3.large" - } - }, - "t3_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "t3.xlarge" - } - }, - "t3_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "t3.2xlarge" - } - }, - "t3a_nano": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "t3a.nano" - } - }, - "t3a_micro": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "t3a.micro" - } - }, - "t3a_small": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "t3a.small" - } - }, - "t3a_medium": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "t3a.medium" - } - }, - "t3a_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "t3a.large" - } - }, - "t3a_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "t3a.xlarge" - } - }, - "t3a_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "t3a.2xlarge" - } - }, - "t4g_nano": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "t4g.nano" - } - }, - "t4g_micro": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "t4g.micro" - } - }, - "t4g_small": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "t4g.small" - } - }, - "t4g_medium": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "t4g.medium" - } - }, - "t4g_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "t4g.large" - } - }, - "t4g_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "t4g.xlarge" - } - }, - "t4g_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "t4g.2xlarge" - } - }, - "u_6tb1_56xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "u-6tb1.56xlarge" - } - }, - "u_6tb1_112xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "u-6tb1.112xlarge" - } - }, - "u_9tb1_112xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "u-9tb1.112xlarge" - } - }, - "u_12tb1_112xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "u-12tb1.112xlarge" - } - }, - "u_6tb1_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "u-6tb1.metal" - } - }, - "u_9tb1_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "u-9tb1.metal" - } - }, - "u_12tb1_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "u-12tb1.metal" - } - }, - "u_18tb1_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "u-18tb1.metal" - } - }, - "u_24tb1_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "u-24tb1.metal" - } - }, - "vt1_3xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "vt1.3xlarge" - } - }, - "vt1_6xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "vt1.6xlarge" - } - }, - "vt1_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "vt1.24xlarge" - } - }, - "x1_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x1.16xlarge" - } - }, - "x1_32xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x1.32xlarge" - } - }, - "x1e_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x1e.xlarge" - } - }, - "x1e_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x1e.2xlarge" - } - }, - "x1e_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x1e.4xlarge" - } - }, - "x1e_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x1e.8xlarge" - } - }, - "x1e_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x1e.16xlarge" - } - }, - "x1e_32xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x1e.32xlarge" - } - }, - "x2iezn_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x2iezn.2xlarge" - } - }, - "x2iezn_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x2iezn.4xlarge" - } - }, - "x2iezn_6xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x2iezn.6xlarge" - } - }, - "x2iezn_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x2iezn.8xlarge" - } - }, - "x2iezn_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x2iezn.12xlarge" - } - }, - "x2iezn_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x2iezn.metal" - } - }, - "x2gd_medium": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x2gd.medium" - } - }, - "x2gd_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x2gd.large" - } - }, - "x2gd_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x2gd.xlarge" - } - }, - "x2gd_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x2gd.2xlarge" - } - }, - "x2gd_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x2gd.4xlarge" - } - }, - "x2gd_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x2gd.8xlarge" - } - }, - "x2gd_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x2gd.12xlarge" - } - }, - "x2gd_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x2gd.16xlarge" - } - }, - "x2gd_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x2gd.metal" - } - }, - "z1d_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "z1d.large" - } - }, - "z1d_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "z1d.xlarge" - } - }, - "z1d_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "z1d.2xlarge" - } - }, - "z1d_3xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "z1d.3xlarge" - } - }, - "z1d_6xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "z1d.6xlarge" - } - }, - "z1d_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "z1d.12xlarge" - } - }, - "z1d_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "z1d.metal" - } - }, - "x2idn_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x2idn.16xlarge" - } - }, - "x2idn_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x2idn.24xlarge" - } - }, - "x2idn_32xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x2idn.32xlarge" - } - }, - "x2iedn_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x2iedn.xlarge" - } - }, - "x2iedn_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x2iedn.2xlarge" - } - }, - "x2iedn_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x2iedn.4xlarge" - } - }, - "x2iedn_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x2iedn.8xlarge" - } - }, - "x2iedn_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x2iedn.16xlarge" - } - }, - "x2iedn_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x2iedn.24xlarge" - } - }, - "x2iedn_32xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x2iedn.32xlarge" - } - }, - "c6a_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6a.large" - } - }, - "c6a_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6a.xlarge" - } - }, - "c6a_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6a.2xlarge" - } - }, - "c6a_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6a.4xlarge" - } - }, - "c6a_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6a.8xlarge" - } - }, - "c6a_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6a.12xlarge" - } - }, - "c6a_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6a.16xlarge" - } - }, - "c6a_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6a.24xlarge" - } - }, - "c6a_32xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6a.32xlarge" - } - }, - "c6a_48xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6a.48xlarge" - } - }, - "c6a_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6a.metal" - } - }, - "m6a_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6a.metal" - } - }, - "i4i_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "i4i.large" - } - }, - "i4i_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "i4i.xlarge" - } - }, - "i4i_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "i4i.2xlarge" - } - }, - "i4i_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "i4i.4xlarge" - } - }, - "i4i_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "i4i.8xlarge" - } - }, - "i4i_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "i4i.16xlarge" - } - }, - "i4i_32xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "i4i.32xlarge" - } - }, - "i4i_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "i4i.metal" - } - }, - "x2idn_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x2idn.metal" - } - }, - "x2iedn_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x2iedn.metal" - } - }, - "c7g_medium": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c7g.medium" - } - }, - "c7g_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c7g.large" - } - }, - "c7g_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c7g.xlarge" - } - }, - "c7g_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c7g.2xlarge" - } - }, - "c7g_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c7g.4xlarge" - } - }, - "c7g_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c7g.8xlarge" - } - }, - "c7g_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c7g.12xlarge" - } - }, - "c7g_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c7g.16xlarge" - } - }, - "mac2_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "mac2.metal" - } - }, - "c6id_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6id.large" - } - }, - "c6id_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6id.xlarge" - } - }, - "c6id_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6id.2xlarge" - } - }, - "c6id_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6id.4xlarge" - } - }, - "c6id_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6id.8xlarge" - } - }, - "c6id_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6id.12xlarge" - } - }, - "c6id_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6id.16xlarge" - } - }, - "c6id_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6id.24xlarge" - } - }, - "c6id_32xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6id.32xlarge" - } - }, - "c6id_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6id.metal" - } - }, - "m6id_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6id.large" - } - }, - "m6id_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6id.xlarge" - } - }, - "m6id_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6id.2xlarge" - } - }, - "m6id_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6id.4xlarge" - } - }, - "m6id_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6id.8xlarge" - } - }, - "m6id_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6id.12xlarge" - } - }, - "m6id_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6id.16xlarge" - } - }, - "m6id_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6id.24xlarge" - } - }, - "m6id_32xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6id.32xlarge" - } - }, - "m6id_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6id.metal" - } - }, - "r6id_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6id.large" - } - }, - "r6id_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6id.xlarge" - } - }, - "r6id_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6id.2xlarge" - } - }, - "r6id_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6id.4xlarge" - } - }, - "r6id_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6id.8xlarge" - } - }, - "r6id_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6id.12xlarge" - } - }, - "r6id_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6id.16xlarge" - } - }, - "r6id_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6id.24xlarge" - } - }, - "r6id_32xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6id.32xlarge" - } - }, - "r6id_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6id.metal" - } - }, - "r6a_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6a.large" - } - }, - "r6a_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6a.xlarge" - } - }, - "r6a_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6a.2xlarge" - } - }, - "r6a_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6a.4xlarge" - } - }, - "r6a_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6a.8xlarge" - } - }, - "r6a_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6a.12xlarge" - } - }, - "r6a_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6a.16xlarge" - } - }, - "r6a_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6a.24xlarge" - } - }, - "r6a_32xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6a.32xlarge" - } - }, - "r6a_48xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6a.48xlarge" - } - }, - "r6a_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6a.metal" - } - }, - "p4de_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "p4de.24xlarge" - } - }, - "u_3tb1_56xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "u-3tb1.56xlarge" - } - }, - "u_18tb1_112xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "u-18tb1.112xlarge" - } - }, - "u_24tb1_112xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "u-24tb1.112xlarge" - } - }, - "trn1_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "trn1.2xlarge" - } - }, - "trn1_32xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "trn1.32xlarge" - } - }, - "hpc6id_32xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "hpc6id.32xlarge" - } - }, - "c6in_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6in.large" - } - }, - "c6in_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6in.xlarge" - } - }, - "c6in_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6in.2xlarge" - } - }, - "c6in_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6in.4xlarge" - } - }, - "c6in_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6in.8xlarge" - } - }, - "c6in_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6in.12xlarge" - } - }, - "c6in_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6in.16xlarge" - } - }, - "c6in_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6in.24xlarge" - } - }, - "c6in_32xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6in.32xlarge" - } - }, - "m6in_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6in.large" - } - }, - "m6in_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6in.xlarge" - } - }, - "m6in_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6in.2xlarge" - } - }, - "m6in_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6in.4xlarge" - } - }, - "m6in_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6in.8xlarge" - } - }, - "m6in_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6in.12xlarge" - } - }, - "m6in_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6in.16xlarge" - } - }, - "m6in_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6in.24xlarge" - } - }, - "m6in_32xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6in.32xlarge" - } - }, - "m6idn_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6idn.large" - } - }, - "m6idn_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6idn.xlarge" - } - }, - "m6idn_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6idn.2xlarge" - } - }, - "m6idn_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6idn.4xlarge" - } - }, - "m6idn_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6idn.8xlarge" - } - }, - "m6idn_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6idn.12xlarge" - } - }, - "m6idn_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6idn.16xlarge" - } - }, - "m6idn_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6idn.24xlarge" - } - }, - "m6idn_32xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6idn.32xlarge" - } - }, - "r6in_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6in.large" - } - }, - "r6in_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6in.xlarge" - } - }, - "r6in_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6in.2xlarge" - } - }, - "r6in_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6in.4xlarge" - } - }, - "r6in_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6in.8xlarge" - } - }, - "r6in_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6in.12xlarge" - } - }, - "r6in_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6in.16xlarge" - } - }, - "r6in_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6in.24xlarge" - } - }, - "r6in_32xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6in.32xlarge" - } - }, - "r6idn_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6idn.large" - } - }, - "r6idn_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6idn.xlarge" - } - }, - "r6idn_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6idn.2xlarge" - } - }, - "r6idn_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6idn.4xlarge" - } - }, - "r6idn_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6idn.8xlarge" - } - }, - "r6idn_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6idn.12xlarge" - } - }, - "r6idn_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6idn.16xlarge" - } - }, - "r6idn_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6idn.24xlarge" - } - }, - "r6idn_32xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6idn.32xlarge" - } - }, - "c7g_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c7g.metal" - } - }, - "m7g_medium": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m7g.medium" - } - }, - "m7g_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m7g.large" - } - }, - "m7g_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m7g.xlarge" - } - }, - "m7g_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m7g.2xlarge" - } - }, - "m7g_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m7g.4xlarge" - } - }, - "m7g_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m7g.8xlarge" - } - }, - "m7g_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m7g.12xlarge" - } - }, - "m7g_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m7g.16xlarge" - } - }, - "m7g_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m7g.metal" - } - }, - "r7g_medium": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r7g.medium" - } - }, - "r7g_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r7g.large" - } - }, - "r7g_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r7g.xlarge" - } - }, - "r7g_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r7g.2xlarge" - } - }, - "r7g_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r7g.4xlarge" - } - }, - "r7g_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r7g.8xlarge" - } - }, - "r7g_12xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r7g.12xlarge" - } - }, - "r7g_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r7g.16xlarge" - } - }, - "r7g_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r7g.metal" - } - }, - "c6in_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "c6in.metal" - } - }, - "m6in_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6in.metal" - } - }, - "m6idn_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m6idn.metal" - } - }, - "r6in_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6in.metal" - } - }, - "r6idn_metal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "r6idn.metal" - } - }, - "inf2_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "inf2.xlarge" - } - }, - "inf2_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "inf2.8xlarge" - } - }, - "inf2_24xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "inf2.24xlarge" - } - }, - "inf2_48xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "inf2.48xlarge" - } - }, - "trn1n_32xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "trn1n.32xlarge" - } - }, - "i4g_large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "i4g.large" - } - }, - "i4g_xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "i4g.xlarge" - } - }, - "i4g_2xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "i4g.2xlarge" - } - }, - "i4g_4xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "i4g.4xlarge" - } - }, - "i4g_8xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "i4g.8xlarge" - } - }, - "i4g_16xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "i4g.16xlarge" - } - } - } - }, - "com.amazonaws.ec2#InstanceTypeHypervisor": { - "type": "enum", - "members": { - "NITRO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "nitro" - } - }, - "XEN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "xen" - } - } - } - }, - "com.amazonaws.ec2#InstanceTypeInfo": { - "type": "structure", - "members": { - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type. For more information, see Instance types in the Amazon EC2 User Guide.

", - "smithy.api#xmlName": "instanceType" - } - }, - "CurrentGeneration": { - "target": "com.amazonaws.ec2#CurrentGenerationFlag", - "traits": { - "aws.protocols#ec2QueryName": "CurrentGeneration", - "smithy.api#documentation": "

Indicates whether the instance type is current generation.

", - "smithy.api#xmlName": "currentGeneration" - } - }, - "FreeTierEligible": { - "target": "com.amazonaws.ec2#FreeTierEligibleFlag", - "traits": { - "aws.protocols#ec2QueryName": "FreeTierEligible", - "smithy.api#documentation": "

Indicates whether the instance type is eligible for the free tier.

", - "smithy.api#xmlName": "freeTierEligible" - } - }, - "SupportedUsageClasses": { - "target": "com.amazonaws.ec2#UsageClassTypeList", - "traits": { - "aws.protocols#ec2QueryName": "SupportedUsageClasses", - "smithy.api#documentation": "

Indicates whether the instance type is offered for spot or On-Demand.

", - "smithy.api#xmlName": "supportedUsageClasses" - } - }, - "SupportedRootDeviceTypes": { - "target": "com.amazonaws.ec2#RootDeviceTypeList", - "traits": { - "aws.protocols#ec2QueryName": "SupportedRootDeviceTypes", - "smithy.api#documentation": "

The supported root device types.

", - "smithy.api#xmlName": "supportedRootDeviceTypes" - } - }, - "SupportedVirtualizationTypes": { - "target": "com.amazonaws.ec2#VirtualizationTypeList", - "traits": { - "aws.protocols#ec2QueryName": "SupportedVirtualizationTypes", - "smithy.api#documentation": "

The supported virtualization types.

", - "smithy.api#xmlName": "supportedVirtualizationTypes" - } - }, - "BareMetal": { - "target": "com.amazonaws.ec2#BareMetalFlag", - "traits": { - "aws.protocols#ec2QueryName": "BareMetal", - "smithy.api#documentation": "

Indicates whether the instance is a bare metal instance type.

", - "smithy.api#xmlName": "bareMetal" - } - }, - "Hypervisor": { - "target": "com.amazonaws.ec2#InstanceTypeHypervisor", - "traits": { - "aws.protocols#ec2QueryName": "Hypervisor", - "smithy.api#documentation": "

The hypervisor for the instance type.

", - "smithy.api#xmlName": "hypervisor" - } - }, - "ProcessorInfo": { - "target": "com.amazonaws.ec2#ProcessorInfo", - "traits": { - "aws.protocols#ec2QueryName": "ProcessorInfo", - "smithy.api#documentation": "

Describes the processor.

", - "smithy.api#xmlName": "processorInfo" - } - }, - "VCpuInfo": { - "target": "com.amazonaws.ec2#VCpuInfo", - "traits": { - "aws.protocols#ec2QueryName": "VCpuInfo", - "smithy.api#documentation": "

Describes the vCPU configurations for the instance type.

", - "smithy.api#xmlName": "vCpuInfo" - } - }, - "MemoryInfo": { - "target": "com.amazonaws.ec2#MemoryInfo", - "traits": { - "aws.protocols#ec2QueryName": "MemoryInfo", - "smithy.api#documentation": "

Describes the memory for the instance type.

", - "smithy.api#xmlName": "memoryInfo" - } - }, - "InstanceStorageSupported": { - "target": "com.amazonaws.ec2#InstanceStorageFlag", - "traits": { - "aws.protocols#ec2QueryName": "InstanceStorageSupported", - "smithy.api#documentation": "

Indicates whether instance storage is supported.

", - "smithy.api#xmlName": "instanceStorageSupported" - } - }, - "InstanceStorageInfo": { - "target": "com.amazonaws.ec2#InstanceStorageInfo", - "traits": { - "aws.protocols#ec2QueryName": "InstanceStorageInfo", - "smithy.api#documentation": "

Describes the instance storage for the instance type.

", - "smithy.api#xmlName": "instanceStorageInfo" - } - }, - "EbsInfo": { - "target": "com.amazonaws.ec2#EbsInfo", - "traits": { - "aws.protocols#ec2QueryName": "EbsInfo", - "smithy.api#documentation": "

Describes the Amazon EBS settings for the instance type.

", - "smithy.api#xmlName": "ebsInfo" - } - }, - "NetworkInfo": { - "target": "com.amazonaws.ec2#NetworkInfo", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInfo", - "smithy.api#documentation": "

Describes the network settings for the instance type.

", - "smithy.api#xmlName": "networkInfo" - } - }, - "GpuInfo": { - "target": "com.amazonaws.ec2#GpuInfo", - "traits": { - "aws.protocols#ec2QueryName": "GpuInfo", - "smithy.api#documentation": "

Describes the GPU accelerator settings for the instance type.

", - "smithy.api#xmlName": "gpuInfo" - } - }, - "FpgaInfo": { - "target": "com.amazonaws.ec2#FpgaInfo", - "traits": { - "aws.protocols#ec2QueryName": "FpgaInfo", - "smithy.api#documentation": "

Describes the FPGA accelerator settings for the instance type.

", - "smithy.api#xmlName": "fpgaInfo" - } - }, - "PlacementGroupInfo": { - "target": "com.amazonaws.ec2#PlacementGroupInfo", - "traits": { - "aws.protocols#ec2QueryName": "PlacementGroupInfo", - "smithy.api#documentation": "

Describes the placement group settings for the instance type.

", - "smithy.api#xmlName": "placementGroupInfo" - } - }, - "InferenceAcceleratorInfo": { - "target": "com.amazonaws.ec2#InferenceAcceleratorInfo", - "traits": { - "aws.protocols#ec2QueryName": "InferenceAcceleratorInfo", - "smithy.api#documentation": "

Describes the Inference accelerator settings for the instance type.

", - "smithy.api#xmlName": "inferenceAcceleratorInfo" - } - }, - "HibernationSupported": { - "target": "com.amazonaws.ec2#HibernationFlag", - "traits": { - "aws.protocols#ec2QueryName": "HibernationSupported", - "smithy.api#documentation": "

Indicates whether On-Demand hibernation is supported.

", - "smithy.api#xmlName": "hibernationSupported" - } - }, - "BurstablePerformanceSupported": { - "target": "com.amazonaws.ec2#BurstablePerformanceFlag", - "traits": { - "aws.protocols#ec2QueryName": "BurstablePerformanceSupported", - "smithy.api#documentation": "

Indicates whether the instance type is a burstable performance instance type.

", - "smithy.api#xmlName": "burstablePerformanceSupported" - } - }, - "DedicatedHostsSupported": { - "target": "com.amazonaws.ec2#DedicatedHostFlag", - "traits": { - "aws.protocols#ec2QueryName": "DedicatedHostsSupported", - "smithy.api#documentation": "

Indicates whether Dedicated Hosts are supported on the instance type.

", - "smithy.api#xmlName": "dedicatedHostsSupported" - } - }, - "AutoRecoverySupported": { - "target": "com.amazonaws.ec2#AutoRecoveryFlag", - "traits": { - "aws.protocols#ec2QueryName": "AutoRecoverySupported", - "smithy.api#documentation": "

Indicates whether Amazon CloudWatch action based recovery is supported.

", - "smithy.api#xmlName": "autoRecoverySupported" - } - }, - "SupportedBootModes": { - "target": "com.amazonaws.ec2#BootModeTypeList", - "traits": { - "aws.protocols#ec2QueryName": "SupportedBootModes", - "smithy.api#documentation": "

The supported boot modes. For more information, see Boot modes in the\n Amazon EC2 User Guide.

", - "smithy.api#xmlName": "supportedBootModes" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the instance type.

" - } - }, - "com.amazonaws.ec2#InstanceTypeInfoFromInstanceRequirements": { - "type": "structure", - "members": { - "InstanceType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The matching instance type.

", - "smithy.api#xmlName": "instanceType" - } - } - }, - "traits": { - "smithy.api#documentation": "

The list of instance types with the specified instance attributes.

" - } - }, - "com.amazonaws.ec2#InstanceTypeInfoFromInstanceRequirementsSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#InstanceTypeInfoFromInstanceRequirements", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#InstanceTypeInfoList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#InstanceTypeInfo", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#InstanceTypeList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#InstanceType" - } - }, - "com.amazonaws.ec2#InstanceTypeOffering": { - "type": "structure", - "members": { - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type. For more information, see Instance types in the Amazon EC2 User Guide.

", - "smithy.api#xmlName": "instanceType" - } - }, - "LocationType": { - "target": "com.amazonaws.ec2#LocationType", - "traits": { - "aws.protocols#ec2QueryName": "LocationType", - "smithy.api#documentation": "

The location type.

", - "smithy.api#xmlName": "locationType" - } - }, - "Location": { - "target": "com.amazonaws.ec2#Location", - "traits": { - "aws.protocols#ec2QueryName": "Location", - "smithy.api#documentation": "

The identifier for the location. This depends on the location type. For example, if the location type is\n region, the location is the Region code (for example, us-east-2.)

", - "smithy.api#xmlName": "location" - } - } - }, - "traits": { - "smithy.api#documentation": "

The instance types offered.

" - } - }, - "com.amazonaws.ec2#InstanceTypeOfferingsList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#InstanceTypeOffering", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#InstanceTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#String" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#InstanceTypesList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#InstanceUsage": { - "type": "structure", - "members": { - "AccountId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AccountId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that is making use of the Capacity Reservation.

", - "smithy.api#xmlName": "accountId" - } - }, - "UsedInstanceCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "UsedInstanceCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of instances the Amazon Web Services account currently has in the Capacity Reservation.

", - "smithy.api#xmlName": "usedInstanceCount" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the Capacity Reservation usage.

" - } - }, - "com.amazonaws.ec2#InstanceUsageSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#InstanceUsage", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#Integer": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.ec2#IntegerWithConstraints": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.ec2#IntegrateServices": { - "type": "structure", - "members": { - "AthenaIntegrations": { - "target": "com.amazonaws.ec2#AthenaIntegrationsSet", - "traits": { - "smithy.api#documentation": "

Information about the integration with Amazon Athena.

", - "smithy.api#xmlName": "AthenaIntegration" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes service integrations with VPC Flow logs.

" - } - }, - "com.amazonaws.ec2#InterfacePermissionType": { - "type": "enum", - "members": { - "INSTANCE_ATTACH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INSTANCE-ATTACH" - } - }, - "EIP_ASSOCIATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EIP-ASSOCIATE" - } - } - } - }, - "com.amazonaws.ec2#InterfaceProtocolType": { - "type": "enum", - "members": { - "VLAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VLAN" - } - }, - "GRE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GRE" - } - } - } - }, - "com.amazonaws.ec2#InternetGateway": { - "type": "structure", - "members": { - "Attachments": { - "target": "com.amazonaws.ec2#InternetGatewayAttachmentList", - "traits": { - "aws.protocols#ec2QueryName": "AttachmentSet", - "smithy.api#documentation": "

Any VPCs attached to the internet gateway.

", - "smithy.api#xmlName": "attachmentSet" - } - }, - "InternetGatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InternetGatewayId", - "smithy.api#documentation": "

The ID of the internet gateway.

", - "smithy.api#xmlName": "internetGatewayId" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the internet gateway.

", - "smithy.api#xmlName": "ownerId" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the internet gateway.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an internet gateway.

" - } - }, - "com.amazonaws.ec2#InternetGatewayAttachment": { - "type": "structure", - "members": { - "State": { - "target": "com.amazonaws.ec2#AttachmentStatus", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The current state of the attachment. For an internet gateway, the state is\n\t\t\t\tavailable when attached to a VPC; otherwise, this value is not\n\t\t\treturned.

", - "smithy.api#xmlName": "state" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#xmlName": "vpcId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the attachment of a VPC to an internet gateway or an egress-only internet\n\t\t\tgateway.

" - } - }, - "com.amazonaws.ec2#InternetGatewayAttachmentList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#InternetGatewayAttachment", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#InternetGatewayId": { - "type": "string" - }, - "com.amazonaws.ec2#InternetGatewayIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#InternetGatewayId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#InternetGatewayList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#InternetGateway", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#IpAddress": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 15 - }, - "smithy.api#pattern": "^([0-9]{1,3}.){3}[0-9]{1,3}$" - } - }, - "com.amazonaws.ec2#IpAddressList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#IpAddress", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#IpAddressType": { - "type": "enum", - "members": { - "ipv4": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ipv4" - } - }, - "dualstack": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "dualstack" - } - }, - "ipv6": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ipv6" - } - } - } - }, - "com.amazonaws.ec2#IpList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#IpPermission": { - "type": "structure", - "members": { - "FromPort": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "FromPort", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

If the protocol is TCP or UDP, this is the start of the port range.\n If the protocol is ICMP or ICMPv6, this is the type number. A value of -1 indicates all ICMP/ICMPv6 types. \n If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.

", - "smithy.api#xmlName": "fromPort" - } - }, - "IpProtocol": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "IpProtocol", - "smithy.api#documentation": "

The IP protocol name (tcp, udp, icmp, icmpv6) \n or number (see Protocol Numbers).

\n

[VPC only] Use -1 to specify all protocols. When authorizing\n security group rules, specifying -1 or a protocol number other than\n tcp, udp, icmp, or icmpv6 allows\n traffic on all ports, regardless of any port range you specify. For tcp,\n udp, and icmp, you must specify a port range. For icmpv6,\n the port range is optional; if you omit the port range, traffic for all types and codes is allowed.

", - "smithy.api#xmlName": "ipProtocol" - } - }, - "IpRanges": { - "target": "com.amazonaws.ec2#IpRangeList", - "traits": { - "aws.protocols#ec2QueryName": "IpRanges", - "smithy.api#documentation": "

The IPv4 ranges.

", - "smithy.api#xmlName": "ipRanges" - } - }, - "Ipv6Ranges": { - "target": "com.amazonaws.ec2#Ipv6RangeList", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6Ranges", - "smithy.api#documentation": "

[VPC only] The IPv6 ranges.

", - "smithy.api#xmlName": "ipv6Ranges" - } - }, - "PrefixListIds": { - "target": "com.amazonaws.ec2#PrefixListIdList", - "traits": { - "aws.protocols#ec2QueryName": "PrefixListIds", - "smithy.api#documentation": "

[VPC only] The prefix list IDs.

", - "smithy.api#xmlName": "prefixListIds" - } - }, - "ToPort": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "ToPort", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

If the protocol is TCP or UDP, this is the end of the port range.\n If the protocol is ICMP or ICMPv6, this is the code. A value of -1 indicates all ICMP/ICMPv6 codes. \n If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.

", - "smithy.api#xmlName": "toPort" - } - }, - "UserIdGroupPairs": { - "target": "com.amazonaws.ec2#UserIdGroupPairList", - "traits": { - "aws.protocols#ec2QueryName": "Groups", - "smithy.api#documentation": "

The security group and Amazon Web Services account ID pairs.

", - "smithy.api#xmlName": "groups" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a set of permissions for a security group rule.

" - } - }, - "com.amazonaws.ec2#IpPermissionList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#IpPermission", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#IpPrefixList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#IpRange": { - "type": "structure", - "members": { - "CidrIp": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CidrIp", - "smithy.api#documentation": "

The IPv4 CIDR range. You can either specify a CIDR range or a source security group,\n not both. To specify a single IPv4 address, use the /32 prefix length.

", - "smithy.api#xmlName": "cidrIp" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description for the security group rule that references this IPv4 address range.

\n

Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9,\n spaces, and ._-:/()#,@[]+=&;{}!$*

", - "smithy.api#xmlName": "description" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an IPv4 range.

" - } - }, - "com.amazonaws.ec2#IpRangeList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#IpRange", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#IpRanges": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#Ipam": { - "type": "structure", - "members": { - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the IPAM.

", - "smithy.api#xmlName": "ownerId" - } - }, - "IpamId": { - "target": "com.amazonaws.ec2#IpamId", - "traits": { - "aws.protocols#ec2QueryName": "IpamId", - "smithy.api#documentation": "

The ID of the IPAM.

", - "smithy.api#xmlName": "ipamId" - } - }, - "IpamArn": { - "target": "com.amazonaws.ec2#ResourceArn", - "traits": { - "aws.protocols#ec2QueryName": "IpamArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IPAM.

", - "smithy.api#xmlName": "ipamArn" - } - }, - "IpamRegion": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "IpamRegion", - "smithy.api#documentation": "

The Amazon Web Services Region of the IPAM.

", - "smithy.api#xmlName": "ipamRegion" - } - }, - "PublicDefaultScopeId": { - "target": "com.amazonaws.ec2#IpamScopeId", - "traits": { - "aws.protocols#ec2QueryName": "PublicDefaultScopeId", - "smithy.api#documentation": "

The ID of the IPAM's default public scope.

", - "smithy.api#xmlName": "publicDefaultScopeId" - } - }, - "PrivateDefaultScopeId": { - "target": "com.amazonaws.ec2#IpamScopeId", - "traits": { - "aws.protocols#ec2QueryName": "PrivateDefaultScopeId", - "smithy.api#documentation": "

The ID of the IPAM's default private scope.

", - "smithy.api#xmlName": "privateDefaultScopeId" - } - }, - "ScopeCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "ScopeCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see Quotas in IPAM in the Amazon VPC IPAM User Guide.\n

", - "smithy.api#xmlName": "scopeCount" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

The description for the IPAM.

", - "smithy.api#xmlName": "description" - } - }, - "OperatingRegions": { - "target": "com.amazonaws.ec2#IpamOperatingRegionSet", - "traits": { - "aws.protocols#ec2QueryName": "OperatingRegionSet", - "smithy.api#documentation": "

The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

\n

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.

", - "smithy.api#xmlName": "operatingRegionSet" - } - }, - "State": { - "target": "com.amazonaws.ec2#IpamState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the IPAM.

", - "smithy.api#xmlName": "state" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

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.\n 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.

", - "smithy.api#xmlName": "tagSet" - } - }, - "DefaultResourceDiscoveryId": { - "target": "com.amazonaws.ec2#IpamResourceDiscoveryId", - "traits": { - "aws.protocols#ec2QueryName": "DefaultResourceDiscoveryId", - "smithy.api#documentation": "

The IPAM's default resource discovery ID.

", - "smithy.api#xmlName": "defaultResourceDiscoveryId" - } - }, - "DefaultResourceDiscoveryAssociationId": { - "target": "com.amazonaws.ec2#IpamResourceDiscoveryAssociationId", - "traits": { - "aws.protocols#ec2QueryName": "DefaultResourceDiscoveryAssociationId", - "smithy.api#documentation": "

The IPAM's default resource discovery association ID.

", - "smithy.api#xmlName": "defaultResourceDiscoveryAssociationId" - } - }, - "ResourceDiscoveryAssociationCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "ResourceDiscoveryAssociationCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The IPAM's resource discovery association count.

", - "smithy.api#xmlName": "resourceDiscoveryAssociationCount" - } - } - }, - "traits": { - "smithy.api#documentation": "

IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.

" - } - }, - "com.amazonaws.ec2#IpamAddressHistoryMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#IpamAddressHistoryRecord": { - "type": "structure", - "members": { - "ResourceOwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceOwnerId", - "smithy.api#documentation": "

The ID of the resource owner.

", - "smithy.api#xmlName": "resourceOwnerId" - } - }, - "ResourceRegion": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceRegion", - "smithy.api#documentation": "

The Amazon Web Services Region of the resource.

", - "smithy.api#xmlName": "resourceRegion" - } - }, - "ResourceType": { - "target": "com.amazonaws.ec2#IpamAddressHistoryResourceType", - "traits": { - "aws.protocols#ec2QueryName": "ResourceType", - "smithy.api#documentation": "

The type of the resource.

", - "smithy.api#xmlName": "resourceType" - } - }, - "ResourceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceId", - "smithy.api#documentation": "

The ID of the resource.

", - "smithy.api#xmlName": "resourceId" - } - }, - "ResourceCidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceCidr", - "smithy.api#documentation": "

The CIDR of the resource.

", - "smithy.api#xmlName": "resourceCidr" - } - }, - "ResourceName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceName", - "smithy.api#documentation": "

The name of the resource.

", - "smithy.api#xmlName": "resourceName" - } - }, - "ResourceComplianceStatus": { - "target": "com.amazonaws.ec2#IpamComplianceStatus", - "traits": { - "aws.protocols#ec2QueryName": "ResourceComplianceStatus", - "smithy.api#documentation": "

The compliance status of a resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.

", - "smithy.api#xmlName": "resourceComplianceStatus" - } - }, - "ResourceOverlapStatus": { - "target": "com.amazonaws.ec2#IpamOverlapStatus", - "traits": { - "aws.protocols#ec2QueryName": "ResourceOverlapStatus", - "smithy.api#documentation": "

The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.

", - "smithy.api#xmlName": "resourceOverlapStatus" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The VPC ID of the resource.

", - "smithy.api#xmlName": "vpcId" - } - }, - "SampledStartTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "SampledStartTime", - "smithy.api#documentation": "

Sampled start time of the resource-to-CIDR association within the IPAM scope. Changes are picked up in periodic snapshots, so the start time may have occurred before this specific time.

", - "smithy.api#xmlName": "sampledStartTime" - } - }, - "SampledEndTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "SampledEndTime", - "smithy.api#documentation": "

Sampled end time of the resource-to-CIDR association within the IPAM scope. Changes are picked up in periodic snapshots, so the end time may have occurred before this specific time.

", - "smithy.api#xmlName": "sampledEndTime" - } - } - }, - "traits": { - "smithy.api#documentation": "

The historical record of a CIDR within an IPAM scope. For more information, see View the history of IP addresses in the Amazon VPC IPAM User Guide.\n

" - } - }, - "com.amazonaws.ec2#IpamAddressHistoryRecordSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#IpamAddressHistoryRecord", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#IpamAddressHistoryResourceType": { - "type": "enum", - "members": { - "eip": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eip" - } - }, - "vpc": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "vpc" - } - }, - "subnet": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "subnet" - } - }, - "network_interface": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "network-interface" - } - }, - "instance": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "instance" - } - } - } - }, - "com.amazonaws.ec2#IpamAssociatedResourceDiscoveryStatus": { - "type": "enum", - "members": { - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "active" - } - }, - "NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "not-found" - } - } - } - }, - "com.amazonaws.ec2#IpamCidrAuthorizationContext": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The plain-text authorization message for the prefix and account.

" - } - }, - "Signature": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The signed authorization message for the prefix and account.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.

" - } - }, - "com.amazonaws.ec2#IpamComplianceStatus": { - "type": "enum", - "members": { - "compliant": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "compliant" - } - }, - "noncompliant": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "noncompliant" - } - }, - "unmanaged": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unmanaged" - } - }, - "ignored": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ignored" - } - } - } - }, - "com.amazonaws.ec2#IpamDiscoveredAccount": { - "type": "structure", - "members": { - "AccountId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AccountId", - "smithy.api#documentation": "

The account ID.

", - "smithy.api#xmlName": "accountId" - } - }, - "DiscoveryRegion": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DiscoveryRegion", - "smithy.api#documentation": "

The Amazon Web Services Region that the account information is returned from. \n An account can be discovered in multiple regions and will have a separate discovered account for each Region.

", - "smithy.api#xmlName": "discoveryRegion" - } - }, - "FailureReason": { - "target": "com.amazonaws.ec2#IpamDiscoveryFailureReason", - "traits": { - "aws.protocols#ec2QueryName": "FailureReason", - "smithy.api#documentation": "

The resource discovery failure reason.

", - "smithy.api#xmlName": "failureReason" - } - }, - "LastAttemptedDiscoveryTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "LastAttemptedDiscoveryTime", - "smithy.api#documentation": "

The last attempted resource discovery time.

", - "smithy.api#xmlName": "lastAttemptedDiscoveryTime" - } - }, - "LastSuccessfulDiscoveryTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "LastSuccessfulDiscoveryTime", - "smithy.api#documentation": "

The last successful resource discovery time.

", - "smithy.api#xmlName": "lastSuccessfulDiscoveryTime" - } - } - }, - "traits": { - "smithy.api#documentation": "

An IPAM discovered account. A discovered account is an Amazon Web Services account that is monitored under a resource discovery. If you have integrated IPAM with Amazon Web Services Organizations, all accounts in the organization are discovered accounts.

" - } - }, - "com.amazonaws.ec2#IpamDiscoveredAccountSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#IpamDiscoveredAccount", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#IpamDiscoveredResourceCidr": { - "type": "structure", - "members": { - "IpamResourceDiscoveryId": { - "target": "com.amazonaws.ec2#IpamResourceDiscoveryId", - "traits": { - "aws.protocols#ec2QueryName": "IpamResourceDiscoveryId", - "smithy.api#documentation": "

The resource discovery ID.

", - "smithy.api#xmlName": "ipamResourceDiscoveryId" - } - }, - "ResourceRegion": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceRegion", - "smithy.api#documentation": "

The resource Region.

", - "smithy.api#xmlName": "resourceRegion" - } - }, - "ResourceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceId", - "smithy.api#documentation": "

The resource ID.

", - "smithy.api#xmlName": "resourceId" - } - }, - "ResourceOwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceOwnerId", - "smithy.api#documentation": "

The resource owner ID.

", - "smithy.api#xmlName": "resourceOwnerId" - } - }, - "ResourceCidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceCidr", - "smithy.api#documentation": "

The resource CIDR.

", - "smithy.api#xmlName": "resourceCidr" - } - }, - "ResourceType": { - "target": "com.amazonaws.ec2#IpamResourceType", - "traits": { - "aws.protocols#ec2QueryName": "ResourceType", - "smithy.api#documentation": "

The resource type.

", - "smithy.api#xmlName": "resourceType" - } - }, - "ResourceTags": { - "target": "com.amazonaws.ec2#IpamResourceTagList", - "traits": { - "aws.protocols#ec2QueryName": "ResourceTagSet", - "smithy.api#documentation": "

The resource tags.

", - "smithy.api#xmlName": "resourceTagSet" - } - }, - "IpUsage": { - "target": "com.amazonaws.ec2#BoxedDouble", - "traits": { - "aws.protocols#ec2QueryName": "IpUsage", - "smithy.api#documentation": "

The percentage of IP address space in use. To convert the decimal to a percentage, multiply the decimal by 100. Note the following:

\n ", - "smithy.api#xmlName": "ipUsage" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The VPC ID.

", - "smithy.api#xmlName": "vpcId" - } - }, - "SampleTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "SampleTime", - "smithy.api#documentation": "

The last successful resource discovery time.

", - "smithy.api#xmlName": "sampleTime" - } - } - }, - "traits": { - "smithy.api#documentation": "

An IPAM discovered resource CIDR. A discovered resource is a resource CIDR monitored under a resource discovery. The following resources can be discovered: VPCs, Public IPv4 pools, VPC subnets, and Elastic IP addresses. The discovered resource CIDR is the IP address range in CIDR notation that is associated with the resource.

" - } - }, - "com.amazonaws.ec2#IpamDiscoveredResourceCidrSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#IpamDiscoveredResourceCidr", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#IpamDiscoveryFailureCode": { - "type": "enum", - "members": { - "assume_role_failure": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "assume-role-failure" - } - }, - "throttling_failure": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "throttling-failure" - } - }, - "unauthorized_failure": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unauthorized-failure" - } - } - } - }, - "com.amazonaws.ec2#IpamDiscoveryFailureReason": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.ec2#IpamDiscoveryFailureCode", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The discovery failure code.

\n ", - "smithy.api#xmlName": "code" - } - }, - "Message": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "

The discovery failure message.

", - "smithy.api#xmlName": "message" - } - } - }, - "traits": { - "smithy.api#documentation": "

The discovery failure reason.

" - } - }, - "com.amazonaws.ec2#IpamId": { - "type": "string" - }, - "com.amazonaws.ec2#IpamManagementState": { - "type": "enum", - "members": { - "managed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "managed" - } - }, - "unmanaged": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unmanaged" - } - }, - "ignored": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ignored" - } - } - } - }, - "com.amazonaws.ec2#IpamMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#IpamNetmaskLength": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 128 - } - } - }, - "com.amazonaws.ec2#IpamOperatingRegion": { - "type": "structure", - "members": { - "RegionName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "RegionName", - "smithy.api#documentation": "

The name of the operating Region.

", - "smithy.api#xmlName": "regionName" - } - } - }, - "traits": { - "smithy.api#documentation": "

The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

\n

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.

" - } - }, - "com.amazonaws.ec2#IpamOperatingRegionSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#IpamOperatingRegion", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#IpamOverlapStatus": { - "type": "enum", - "members": { - "overlapping": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "overlapping" - } - }, - "nonoverlapping": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "nonoverlapping" - } - }, - "ignored": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ignored" - } - } - } - }, - "com.amazonaws.ec2#IpamPool": { - "type": "structure", - "members": { - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the IPAM pool.

", - "smithy.api#xmlName": "ownerId" - } - }, - "IpamPoolId": { - "target": "com.amazonaws.ec2#IpamPoolId", - "traits": { - "aws.protocols#ec2QueryName": "IpamPoolId", - "smithy.api#documentation": "

The ID of the IPAM pool.

", - "smithy.api#xmlName": "ipamPoolId" - } - }, - "SourceIpamPoolId": { - "target": "com.amazonaws.ec2#IpamPoolId", - "traits": { - "aws.protocols#ec2QueryName": "SourceIpamPoolId", - "smithy.api#documentation": "

The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool.

", - "smithy.api#xmlName": "sourceIpamPoolId" - } - }, - "IpamPoolArn": { - "target": "com.amazonaws.ec2#ResourceArn", - "traits": { - "aws.protocols#ec2QueryName": "IpamPoolArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IPAM pool.

", - "smithy.api#xmlName": "ipamPoolArn" - } - }, - "IpamScopeArn": { - "target": "com.amazonaws.ec2#ResourceArn", - "traits": { - "aws.protocols#ec2QueryName": "IpamScopeArn", - "smithy.api#documentation": "

The ARN of the scope of the IPAM pool.

", - "smithy.api#xmlName": "ipamScopeArn" - } - }, - "IpamScopeType": { - "target": "com.amazonaws.ec2#IpamScopeType", - "traits": { - "aws.protocols#ec2QueryName": "IpamScopeType", - "smithy.api#documentation": "

In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.

", - "smithy.api#xmlName": "ipamScopeType" - } - }, - "IpamArn": { - "target": "com.amazonaws.ec2#ResourceArn", - "traits": { - "aws.protocols#ec2QueryName": "IpamArn", - "smithy.api#documentation": "

The ARN of the IPAM.

", - "smithy.api#xmlName": "ipamArn" - } - }, - "IpamRegion": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "IpamRegion", - "smithy.api#documentation": "

The Amazon Web Services Region of the IPAM pool.

", - "smithy.api#xmlName": "ipamRegion" - } - }, - "Locale": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Locale", - "smithy.api#documentation": "

The locale of the IPAM pool. In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you choose an Amazon Web Services Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.

", - "smithy.api#xmlName": "locale" - } - }, - "PoolDepth": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "PoolDepth", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The depth of pools in your IPAM pool. The pool depth quota is 10. For more information, see Quotas in IPAM in the Amazon VPC IPAM User Guide.\n

", - "smithy.api#xmlName": "poolDepth" - } - }, - "State": { - "target": "com.amazonaws.ec2#IpamPoolState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the IPAM pool.

", - "smithy.api#xmlName": "state" - } - }, - "StateMessage": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StateMessage", - "smithy.api#documentation": "

A message related to the failed creation of an IPAM pool.

", - "smithy.api#xmlName": "stateMessage" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

The description of the IPAM pool.

", - "smithy.api#xmlName": "description" - } - }, - "AutoImport": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "AutoImport", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

If selected, IPAM will continuously look for resources within the CIDR range of this pool \n and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for\n these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import \n a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently \n marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM \n discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.\n

\n

A locale must be set on the pool for this feature to work.

", - "smithy.api#xmlName": "autoImport" - } - }, - "PubliclyAdvertisable": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "PubliclyAdvertisable", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4.

", - "smithy.api#xmlName": "publiclyAdvertisable" - } - }, - "AddressFamily": { - "target": "com.amazonaws.ec2#AddressFamily", - "traits": { - "aws.protocols#ec2QueryName": "AddressFamily", - "smithy.api#documentation": "

The address family of the pool.

", - "smithy.api#xmlName": "addressFamily" - } - }, - "AllocationMinNetmaskLength": { - "target": "com.amazonaws.ec2#IpamNetmaskLength", - "traits": { - "aws.protocols#ec2QueryName": "AllocationMinNetmaskLength", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

", - "smithy.api#xmlName": "allocationMinNetmaskLength" - } - }, - "AllocationMaxNetmaskLength": { - "target": "com.amazonaws.ec2#IpamNetmaskLength", - "traits": { - "aws.protocols#ec2QueryName": "AllocationMaxNetmaskLength", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

", - "smithy.api#xmlName": "allocationMaxNetmaskLength" - } - }, - "AllocationDefaultNetmaskLength": { - "target": "com.amazonaws.ec2#IpamNetmaskLength", - "traits": { - "aws.protocols#ec2QueryName": "AllocationDefaultNetmaskLength", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and \n you enter 16 here, new allocations will default to 10.0.0.0/16.

", - "smithy.api#xmlName": "allocationDefaultNetmaskLength" - } - }, - "AllocationResourceTags": { - "target": "com.amazonaws.ec2#IpamResourceTagList", - "traits": { - "aws.protocols#ec2QueryName": "AllocationResourceTagSet", - "smithy.api#documentation": "

Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.

", - "smithy.api#xmlName": "allocationResourceTagSet" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

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.\n 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.

", - "smithy.api#xmlName": "tagSet" - } - }, - "AwsService": { - "target": "com.amazonaws.ec2#IpamPoolAwsService", - "traits": { - "aws.protocols#ec2QueryName": "AwsService", - "smithy.api#documentation": "

Limits which service in Amazon Web Services that the pool can be used in. \"ec2\", for example, allows users to use space for Elastic IP addresses and VPCs.

", - "smithy.api#xmlName": "awsService" - } - }, - "PublicIpSource": { - "target": "com.amazonaws.ec2#IpamPoolPublicIpSource", - "traits": { - "aws.protocols#ec2QueryName": "PublicIpSource", - "smithy.api#documentation": "

The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is BYOIP. For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide. \n By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.

", - "smithy.api#xmlName": "publicIpSource" - } - } - }, - "traits": { - "smithy.api#documentation": "

In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.

" - } - }, - "com.amazonaws.ec2#IpamPoolAllocation": { - "type": "structure", - "members": { - "Cidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Cidr", - "smithy.api#documentation": "

The CIDR for the allocation. A CIDR is a representation of an IP address and its associated network mask (or netmask) and \n refers to a range of IP addresses. An IPv4 CIDR example is 10.24.34.0/23. An IPv6 CIDR example is 2001:DB8::/32.

", - "smithy.api#xmlName": "cidr" - } - }, - "IpamPoolAllocationId": { - "target": "com.amazonaws.ec2#IpamPoolAllocationId", - "traits": { - "aws.protocols#ec2QueryName": "IpamPoolAllocationId", - "smithy.api#documentation": "

The ID of an allocation.

", - "smithy.api#xmlName": "ipamPoolAllocationId" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description of the pool allocation.

", - "smithy.api#xmlName": "description" - } - }, - "ResourceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceId", - "smithy.api#documentation": "

The ID of the resource.

", - "smithy.api#xmlName": "resourceId" - } - }, - "ResourceType": { - "target": "com.amazonaws.ec2#IpamPoolAllocationResourceType", - "traits": { - "aws.protocols#ec2QueryName": "ResourceType", - "smithy.api#documentation": "

The type of the resource.

", - "smithy.api#xmlName": "resourceType" - } - }, - "ResourceRegion": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceRegion", - "smithy.api#documentation": "

The Amazon Web Services Region of the resource.

", - "smithy.api#xmlName": "resourceRegion" - } - }, - "ResourceOwner": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceOwner", - "smithy.api#documentation": "

The owner of the resource.

", - "smithy.api#xmlName": "resourceOwner" - } - } - }, - "traits": { - "smithy.api#documentation": "

In IPAM, an allocation is a CIDR assignment from an IPAM pool to another IPAM pool or to a resource.

" - } - }, - "com.amazonaws.ec2#IpamPoolAllocationDisallowedCidrs": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#IpamPoolAllocationId": { - "type": "string" - }, - "com.amazonaws.ec2#IpamPoolAllocationResourceType": { - "type": "enum", - "members": { - "ipam_pool": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ipam-pool" - } - }, - "vpc": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "vpc" - } - }, - "ec2_public_ipv4_pool": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ec2-public-ipv4-pool" - } - }, - "custom": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "custom" - } - } - } - }, - "com.amazonaws.ec2#IpamPoolAllocationSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#IpamPoolAllocation", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#IpamPoolAwsService": { - "type": "enum", - "members": { - "ec2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ec2" - } - } - } - }, - "com.amazonaws.ec2#IpamPoolCidr": { - "type": "structure", - "members": { - "Cidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Cidr", - "smithy.api#documentation": "

The CIDR provisioned to the IPAM pool. A CIDR is a representation of an IP address and its associated network mask (or netmask) \n and refers to a range of IP addresses. An IPv4 CIDR example is 10.24.34.0/23. An IPv6 CIDR example is 2001:DB8::/32.

", - "smithy.api#xmlName": "cidr" - } - }, - "State": { - "target": "com.amazonaws.ec2#IpamPoolCidrState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the CIDR.

", - "smithy.api#xmlName": "state" - } - }, - "FailureReason": { - "target": "com.amazonaws.ec2#IpamPoolCidrFailureReason", - "traits": { - "aws.protocols#ec2QueryName": "FailureReason", - "smithy.api#documentation": "

Details related to why an IPAM pool CIDR failed to be provisioned.

", - "smithy.api#xmlName": "failureReason" - } - }, - "IpamPoolCidrId": { - "target": "com.amazonaws.ec2#IpamPoolCidrId", - "traits": { - "aws.protocols#ec2QueryName": "IpamPoolCidrId", - "smithy.api#documentation": "

The IPAM pool CIDR ID.

", - "smithy.api#xmlName": "ipamPoolCidrId" - } - }, - "NetmaskLength": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "NetmaskLength", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The netmask length of the CIDR you'd like to provision to a pool. Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. \"NetmaskLength\" or \"Cidr\" is required.

", - "smithy.api#xmlName": "netmaskLength" - } - } - }, - "traits": { - "smithy.api#documentation": "

A CIDR provisioned to an IPAM pool.

" - } - }, - "com.amazonaws.ec2#IpamPoolCidrFailureCode": { - "type": "enum", - "members": { - "cidr_not_available": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cidr-not-available" - } - }, - "limit_exceeded": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "limit-exceeded" - } - } - } - }, - "com.amazonaws.ec2#IpamPoolCidrFailureReason": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.ec2#IpamPoolCidrFailureCode", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

An error code related to why an IPAM pool CIDR failed to be provisioned.

", - "smithy.api#xmlName": "code" - } - }, - "Message": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "

A message related to why an IPAM pool CIDR failed to be provisioned.

", - "smithy.api#xmlName": "message" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details related to why an IPAM pool CIDR failed to be provisioned.

" - } - }, - "com.amazonaws.ec2#IpamPoolCidrId": { - "type": "string" - }, - "com.amazonaws.ec2#IpamPoolCidrSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#IpamPoolCidr", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#IpamPoolCidrState": { - "type": "enum", - "members": { - "pending_provision": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending-provision" - } - }, - "provisioned": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "provisioned" - } - }, - "failed_provision": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failed-provision" - } - }, - "pending_deprovision": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending-deprovision" - } - }, - "deprovisioned": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deprovisioned" - } - }, - "failed_deprovision": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failed-deprovision" - } - }, - "pending_import": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending-import" - } - }, - "failed_import": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failed-import" - } - } - } - }, - "com.amazonaws.ec2#IpamPoolId": { - "type": "string" - }, - "com.amazonaws.ec2#IpamPoolPublicIpSource": { - "type": "enum", - "members": { - "amazon": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "amazon" - } - }, - "byoip": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "byoip" - } - } - } - }, - "com.amazonaws.ec2#IpamPoolSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#IpamPool", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#IpamPoolState": { - "type": "enum", - "members": { - "create_in_progress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "create-in-progress" - } - }, - "create_complete": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "create-complete" - } - }, - "create_failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "create-failed" - } - }, - "modify_in_progress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "modify-in-progress" - } - }, - "modify_complete": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "modify-complete" - } - }, - "modify_failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "modify-failed" - } - }, - "delete_in_progress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "delete-in-progress" - } - }, - "delete_complete": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "delete-complete" - } - }, - "delete_failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "delete-failed" - } - }, - "isolate_in_progress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "isolate-in-progress" - } - }, - "isolate_complete": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "isolate-complete" - } - }, - "restore_in_progress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "restore-in-progress" - } - } - } - }, - "com.amazonaws.ec2#IpamResourceCidr": { - "type": "structure", - "members": { - "IpamId": { - "target": "com.amazonaws.ec2#IpamId", - "traits": { - "aws.protocols#ec2QueryName": "IpamId", - "smithy.api#documentation": "

The IPAM ID for an IPAM resource.

", - "smithy.api#xmlName": "ipamId" - } - }, - "IpamScopeId": { - "target": "com.amazonaws.ec2#IpamScopeId", - "traits": { - "aws.protocols#ec2QueryName": "IpamScopeId", - "smithy.api#documentation": "

The scope ID for an IPAM resource.

", - "smithy.api#xmlName": "ipamScopeId" - } - }, - "IpamPoolId": { - "target": "com.amazonaws.ec2#IpamPoolId", - "traits": { - "aws.protocols#ec2QueryName": "IpamPoolId", - "smithy.api#documentation": "

The pool ID for an IPAM resource.

", - "smithy.api#xmlName": "ipamPoolId" - } - }, - "ResourceRegion": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceRegion", - "smithy.api#documentation": "

The Amazon Web Services Region for an IPAM resource.

", - "smithy.api#xmlName": "resourceRegion" - } - }, - "ResourceOwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceOwnerId", - "smithy.api#documentation": "

The Amazon Web Services account number of the owner of an IPAM resource.

", - "smithy.api#xmlName": "resourceOwnerId" - } - }, - "ResourceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceId", - "smithy.api#documentation": "

The ID of an IPAM resource.

", - "smithy.api#xmlName": "resourceId" - } - }, - "ResourceName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceName", - "smithy.api#documentation": "

The name of an IPAM resource.

", - "smithy.api#xmlName": "resourceName" - } - }, - "ResourceCidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceCidr", - "smithy.api#documentation": "

The CIDR for an IPAM resource.

", - "smithy.api#xmlName": "resourceCidr" - } - }, - "ResourceType": { - "target": "com.amazonaws.ec2#IpamResourceType", - "traits": { - "aws.protocols#ec2QueryName": "ResourceType", - "smithy.api#documentation": "

The type of IPAM resource.

", - "smithy.api#xmlName": "resourceType" - } - }, - "ResourceTags": { - "target": "com.amazonaws.ec2#IpamResourceTagList", - "traits": { - "aws.protocols#ec2QueryName": "ResourceTagSet", - "smithy.api#documentation": "

The tags for an IPAM resource.

", - "smithy.api#xmlName": "resourceTagSet" - } - }, - "IpUsage": { - "target": "com.amazonaws.ec2#BoxedDouble", - "traits": { - "aws.protocols#ec2QueryName": "IpUsage", - "smithy.api#documentation": "

The percentage of IP address space in use. To convert the decimal to a percentage, multiply the decimal by 100. Note the following:

\n ", - "smithy.api#xmlName": "ipUsage" - } - }, - "ComplianceStatus": { - "target": "com.amazonaws.ec2#IpamComplianceStatus", - "traits": { - "aws.protocols#ec2QueryName": "ComplianceStatus", - "smithy.api#documentation": "

The compliance status of the IPAM resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.

", - "smithy.api#xmlName": "complianceStatus" - } - }, - "ManagementState": { - "target": "com.amazonaws.ec2#IpamManagementState", - "traits": { - "aws.protocols#ec2QueryName": "ManagementState", - "smithy.api#documentation": "

The management state of the resource. For more information about management states, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.

", - "smithy.api#xmlName": "managementState" - } - }, - "OverlapStatus": { - "target": "com.amazonaws.ec2#IpamOverlapStatus", - "traits": { - "aws.protocols#ec2QueryName": "OverlapStatus", - "smithy.api#documentation": "

The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.

", - "smithy.api#xmlName": "overlapStatus" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of a VPC.

", - "smithy.api#xmlName": "vpcId" - } - } - }, - "traits": { - "smithy.api#documentation": "

The CIDR for an IPAM resource.

" - } - }, - "com.amazonaws.ec2#IpamResourceCidrSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#IpamResourceCidr", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#IpamResourceDiscovery": { - "type": "structure", - "members": { - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the owner.

", - "smithy.api#xmlName": "ownerId" - } - }, - "IpamResourceDiscoveryId": { - "target": "com.amazonaws.ec2#IpamResourceDiscoveryId", - "traits": { - "aws.protocols#ec2QueryName": "IpamResourceDiscoveryId", - "smithy.api#documentation": "

The resource discovery ID.

", - "smithy.api#xmlName": "ipamResourceDiscoveryId" - } - }, - "IpamResourceDiscoveryArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "IpamResourceDiscoveryArn", - "smithy.api#documentation": "

The resource discovery Amazon Resource Name (ARN).

", - "smithy.api#xmlName": "ipamResourceDiscoveryArn" - } - }, - "IpamResourceDiscoveryRegion": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "IpamResourceDiscoveryRegion", - "smithy.api#documentation": "

The resource discovery Region.

", - "smithy.api#xmlName": "ipamResourceDiscoveryRegion" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

The resource discovery description.

", - "smithy.api#xmlName": "description" - } - }, - "OperatingRegions": { - "target": "com.amazonaws.ec2#IpamOperatingRegionSet", - "traits": { - "aws.protocols#ec2QueryName": "OperatingRegionSet", - "smithy.api#documentation": "

The operating Regions for the resource discovery. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

", - "smithy.api#xmlName": "operatingRegionSet" - } - }, - "IsDefault": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "IsDefault", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Defines if the resource discovery is the default. The default resource discovery is the resource discovery automatically created when you create an IPAM.

", - "smithy.api#xmlName": "isDefault" - } - }, - "State": { - "target": "com.amazonaws.ec2#IpamResourceDiscoveryState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The lifecycle state of the resource discovery.

\n ", - "smithy.api#xmlName": "state" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

" - } - }, - "com.amazonaws.ec2#IpamResourceDiscoveryAssociation": { - "type": "structure", - "members": { - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The Amazon Web Services account ID of the resource discovery owner.

", - "smithy.api#xmlName": "ownerId" - } - }, - "IpamResourceDiscoveryAssociationId": { - "target": "com.amazonaws.ec2#IpamResourceDiscoveryAssociationId", - "traits": { - "aws.protocols#ec2QueryName": "IpamResourceDiscoveryAssociationId", - "smithy.api#documentation": "

The resource discovery association ID.

", - "smithy.api#xmlName": "ipamResourceDiscoveryAssociationId" - } - }, - "IpamResourceDiscoveryAssociationArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "IpamResourceDiscoveryAssociationArn", - "smithy.api#documentation": "

The resource discovery association Amazon Resource Name (ARN).

", - "smithy.api#xmlName": "ipamResourceDiscoveryAssociationArn" - } - }, - "IpamResourceDiscoveryId": { - "target": "com.amazonaws.ec2#IpamResourceDiscoveryId", - "traits": { - "aws.protocols#ec2QueryName": "IpamResourceDiscoveryId", - "smithy.api#documentation": "

The resource discovery ID.

", - "smithy.api#xmlName": "ipamResourceDiscoveryId" - } - }, - "IpamId": { - "target": "com.amazonaws.ec2#IpamId", - "traits": { - "aws.protocols#ec2QueryName": "IpamId", - "smithy.api#documentation": "

The IPAM ID.

", - "smithy.api#xmlName": "ipamId" - } - }, - "IpamArn": { - "target": "com.amazonaws.ec2#ResourceArn", - "traits": { - "aws.protocols#ec2QueryName": "IpamArn", - "smithy.api#documentation": "

The IPAM ARN.

", - "smithy.api#xmlName": "ipamArn" - } - }, - "IpamRegion": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "IpamRegion", - "smithy.api#documentation": "

The IPAM home Region.

", - "smithy.api#xmlName": "ipamRegion" - } - }, - "IsDefault": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "IsDefault", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Defines if the resource discovery is the default. When you create an IPAM, a default resource discovery is created for your IPAM and it's associated with your IPAM.

", - "smithy.api#xmlName": "isDefault" - } - }, - "ResourceDiscoveryStatus": { - "target": "com.amazonaws.ec2#IpamAssociatedResourceDiscoveryStatus", - "traits": { - "aws.protocols#ec2QueryName": "ResourceDiscoveryStatus", - "smithy.api#documentation": "

The resource discovery status.

\n ", - "smithy.api#xmlName": "resourceDiscoveryStatus" - } - }, - "State": { - "target": "com.amazonaws.ec2#IpamResourceDiscoveryAssociationState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The lifecycle state of the association when you associate or disassociate a resource discovery.

\n ", - "smithy.api#xmlName": "state" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

An IPAM resource discovery association. An associated resource discovery is a resource discovery that has been associated with an IPAM. IPAM aggregates the resource CIDRs discovered by the associated resource discovery.

" - } - }, - "com.amazonaws.ec2#IpamResourceDiscoveryAssociationId": { - "type": "string" - }, - "com.amazonaws.ec2#IpamResourceDiscoveryAssociationSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#IpamResourceDiscoveryAssociation", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#IpamResourceDiscoveryAssociationState": { - "type": "enum", - "members": { - "ASSOCIATE_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "associate-in-progress" - } - }, - "ASSOCIATE_COMPLETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "associate-complete" - } - }, - "ASSOCIATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "associate-failed" - } - }, - "DISASSOCIATE_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disassociate-in-progress" - } - }, - "DISASSOCIATE_COMPLETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disassociate-complete" - } - }, - "DISASSOCIATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disassociate-failed" - } - }, - "ISOLATE_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "isolate-in-progress" - } - }, - "ISOLATE_COMPLETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "isolate-complete" - } - }, - "RESTORE_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "restore-in-progress" - } - } - } - }, - "com.amazonaws.ec2#IpamResourceDiscoveryId": { - "type": "string" - }, - "com.amazonaws.ec2#IpamResourceDiscoverySet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#IpamResourceDiscovery", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#IpamResourceDiscoveryState": { - "type": "enum", - "members": { - "CREATE_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "create-in-progress" - } - }, - "CREATE_COMPLETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "create-complete" - } - }, - "CREATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "create-failed" - } - }, - "MODIFY_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "modify-in-progress" - } - }, - "MODIFY_COMPLETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "modify-complete" - } - }, - "MODIFY_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "modify-failed" - } - }, - "DELETE_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "delete-in-progress" - } - }, - "DELETE_COMPLETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "delete-complete" - } - }, - "DELETE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "delete-failed" - } - }, - "ISOLATE_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "isolate-in-progress" - } - }, - "ISOLATE_COMPLETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "isolate-complete" - } - }, - "RESTORE_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "restore-in-progress" - } - } - } - }, - "com.amazonaws.ec2#IpamResourceTag": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Key", - "smithy.api#documentation": "

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.

", - "smithy.api#xmlName": "key" - } - }, - "Value": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Value", - "smithy.api#documentation": "

The value of the tag.

", - "smithy.api#xmlName": "value" - } - } - }, - "traits": { - "smithy.api#documentation": "

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.\n 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.

" - } - }, - "com.amazonaws.ec2#IpamResourceTagList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#IpamResourceTag", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#IpamResourceType": { - "type": "enum", - "members": { - "vpc": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "vpc" - } - }, - "subnet": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "subnet" - } - }, - "eip": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eip" - } - }, - "public_ipv4_pool": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "public-ipv4-pool" - } - }, - "ipv6_pool": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ipv6-pool" - } - } - } - }, - "com.amazonaws.ec2#IpamScope": { - "type": "structure", - "members": { - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the scope.

", - "smithy.api#xmlName": "ownerId" - } - }, - "IpamScopeId": { - "target": "com.amazonaws.ec2#IpamScopeId", - "traits": { - "aws.protocols#ec2QueryName": "IpamScopeId", - "smithy.api#documentation": "

The ID of the scope.

", - "smithy.api#xmlName": "ipamScopeId" - } - }, - "IpamScopeArn": { - "target": "com.amazonaws.ec2#ResourceArn", - "traits": { - "aws.protocols#ec2QueryName": "IpamScopeArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the scope.

", - "smithy.api#xmlName": "ipamScopeArn" - } - }, - "IpamArn": { - "target": "com.amazonaws.ec2#ResourceArn", - "traits": { - "aws.protocols#ec2QueryName": "IpamArn", - "smithy.api#documentation": "

The ARN of the IPAM.

", - "smithy.api#xmlName": "ipamArn" - } - }, - "IpamRegion": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "IpamRegion", - "smithy.api#documentation": "

The Amazon Web Services Region of the IPAM scope.

", - "smithy.api#xmlName": "ipamRegion" - } - }, - "IpamScopeType": { - "target": "com.amazonaws.ec2#IpamScopeType", - "traits": { - "aws.protocols#ec2QueryName": "IpamScopeType", - "smithy.api#documentation": "

The type of the scope.

", - "smithy.api#xmlName": "ipamScopeType" - } - }, - "IsDefault": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "IsDefault", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Defines if the scope is the default scope or not.

", - "smithy.api#xmlName": "isDefault" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

The description of the scope.

", - "smithy.api#xmlName": "description" - } - }, - "PoolCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "PoolCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of pools in the scope.

", - "smithy.api#xmlName": "poolCount" - } - }, - "State": { - "target": "com.amazonaws.ec2#IpamScopeState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the IPAM scope.

", - "smithy.api#xmlName": "state" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

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.\n 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.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.

\n

For more information, see How IPAM works in the Amazon VPC IPAM User Guide.

" - } - }, - "com.amazonaws.ec2#IpamScopeId": { - "type": "string" - }, - "com.amazonaws.ec2#IpamScopeSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#IpamScope", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#IpamScopeState": { - "type": "enum", - "members": { - "create_in_progress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "create-in-progress" - } - }, - "create_complete": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "create-complete" - } - }, - "create_failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "create-failed" - } - }, - "modify_in_progress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "modify-in-progress" - } - }, - "modify_complete": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "modify-complete" - } - }, - "modify_failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "modify-failed" - } - }, - "delete_in_progress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "delete-in-progress" - } - }, - "delete_complete": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "delete-complete" - } - }, - "delete_failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "delete-failed" - } - }, - "isolate_in_progress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "isolate-in-progress" - } - }, - "isolate_complete": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "isolate-complete" - } - }, - "restore_in_progress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "restore-in-progress" - } - } - } - }, - "com.amazonaws.ec2#IpamScopeType": { - "type": "enum", - "members": { - "public": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "public" - } - }, - "private": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "private" - } - } - } - }, - "com.amazonaws.ec2#IpamSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Ipam", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#IpamState": { - "type": "enum", - "members": { - "create_in_progress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "create-in-progress" - } - }, - "create_complete": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "create-complete" - } - }, - "create_failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "create-failed" - } - }, - "modify_in_progress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "modify-in-progress" - } - }, - "modify_complete": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "modify-complete" - } - }, - "modify_failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "modify-failed" - } - }, - "delete_in_progress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "delete-in-progress" - } - }, - "delete_complete": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "delete-complete" - } - }, - "delete_failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "delete-failed" - } - }, - "isolate_in_progress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "isolate-in-progress" - } - }, - "isolate_complete": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "isolate-complete" - } - }, - "restore_in_progress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "restore-in-progress" - } - } - } - }, - "com.amazonaws.ec2#Ipv4PoolCoipId": { - "type": "string" - }, - "com.amazonaws.ec2#Ipv4PoolEc2Id": { - "type": "string" - }, - "com.amazonaws.ec2#Ipv4PrefixList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Ipv4PrefixSpecificationRequest", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#Ipv4PrefixListResponse": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Ipv4PrefixSpecificationResponse", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#Ipv4PrefixSpecification": { - "type": "structure", - "members": { - "Ipv4Prefix": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Ipv4Prefix", - "smithy.api#documentation": "

The IPv4 prefix. For information, see \n Assigning prefixes to Amazon EC2 network interfaces in the\n Amazon Elastic Compute Cloud User Guide.

", - "smithy.api#xmlName": "ipv4Prefix" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an IPv4 prefix.

" - } - }, - "com.amazonaws.ec2#Ipv4PrefixSpecificationRequest": { - "type": "structure", - "members": { - "Ipv4Prefix": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The IPv4 prefix. For information, see \n Assigning prefixes to Amazon EC2 network interfaces in the\n Amazon Elastic Compute Cloud User Guide.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the IPv4 prefix option for a network interface.

" - } - }, - "com.amazonaws.ec2#Ipv4PrefixSpecificationResponse": { - "type": "structure", - "members": { - "Ipv4Prefix": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Ipv4Prefix", - "smithy.api#documentation": "

The IPv4 delegated prefixes assigned to the network interface.

", - "smithy.api#xmlName": "ipv4Prefix" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the IPv4 delegated prefixes assigned \n to a network interface.

" - } - }, - "com.amazonaws.ec2#Ipv4PrefixesList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Ipv4PrefixSpecification", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#Ipv6Address": { - "type": "string" - }, - "com.amazonaws.ec2#Ipv6AddressList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#Ipv6CidrAssociation": { - "type": "structure", - "members": { - "Ipv6Cidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6Cidr", - "smithy.api#documentation": "

The IPv6 CIDR block.

", - "smithy.api#xmlName": "ipv6Cidr" - } - }, - "AssociatedResource": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AssociatedResource", - "smithy.api#documentation": "

The resource that's associated with the IPv6 CIDR block.

", - "smithy.api#xmlName": "associatedResource" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an IPv6 CIDR block association.

" - } - }, - "com.amazonaws.ec2#Ipv6CidrAssociationSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Ipv6CidrAssociation", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#Ipv6CidrBlock": { - "type": "structure", - "members": { - "Ipv6CidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6CidrBlock", - "smithy.api#documentation": "

The IPv6 CIDR block.

", - "smithy.api#xmlName": "ipv6CidrBlock" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an IPv6 CIDR block.

" - } - }, - "com.amazonaws.ec2#Ipv6CidrBlockSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Ipv6CidrBlock", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#Ipv6Flag": { - "type": "boolean" - }, - "com.amazonaws.ec2#Ipv6Pool": { - "type": "structure", - "members": { - "PoolId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PoolId", - "smithy.api#documentation": "

The ID of the address pool.

", - "smithy.api#xmlName": "poolId" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

The description for the address pool.

", - "smithy.api#xmlName": "description" - } - }, - "PoolCidrBlocks": { - "target": "com.amazonaws.ec2#PoolCidrBlocksSet", - "traits": { - "aws.protocols#ec2QueryName": "PoolCidrBlockSet", - "smithy.api#documentation": "

The CIDR blocks for the address pool.

", - "smithy.api#xmlName": "poolCidrBlockSet" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags for the address pool.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an IPv6 address pool.

" - } - }, - "com.amazonaws.ec2#Ipv6PoolEc2Id": { - "type": "string" - }, - "com.amazonaws.ec2#Ipv6PoolIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Ipv6PoolEc2Id", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#Ipv6PoolMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#Ipv6PoolSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Ipv6Pool", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#Ipv6PrefixList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Ipv6PrefixSpecificationRequest", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#Ipv6PrefixListResponse": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Ipv6PrefixSpecificationResponse", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#Ipv6PrefixSpecification": { - "type": "structure", - "members": { - "Ipv6Prefix": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6Prefix", - "smithy.api#documentation": "

The IPv6 prefix.

", - "smithy.api#xmlName": "ipv6Prefix" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the IPv6 prefix.

" - } - }, - "com.amazonaws.ec2#Ipv6PrefixSpecificationRequest": { - "type": "structure", - "members": { - "Ipv6Prefix": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The IPv6 prefix.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the IPv4 prefix option for a network interface.

" - } - }, - "com.amazonaws.ec2#Ipv6PrefixSpecificationResponse": { - "type": "structure", - "members": { - "Ipv6Prefix": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6Prefix", - "smithy.api#documentation": "

The IPv6 delegated prefixes assigned to the network interface.

", - "smithy.api#xmlName": "ipv6Prefix" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the IPv6 delegated prefixes assigned \n to a network interface.

" - } - }, - "com.amazonaws.ec2#Ipv6PrefixesList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Ipv6PrefixSpecification", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#Ipv6Range": { - "type": "structure", - "members": { - "CidrIpv6": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CidrIpv6", - "smithy.api#documentation": "

The IPv6 CIDR range. You can either specify a CIDR range or a source security group,\n not both. To specify a single IPv6 address, use the /128 prefix length.

", - "smithy.api#xmlName": "cidrIpv6" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description for the security group rule that references this IPv6 address range.

\n

Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9,\n spaces, and ._-:/()#,@[]+=&;{}!$*

", - "smithy.api#xmlName": "description" - } - } - }, - "traits": { - "smithy.api#documentation": "

[EC2-VPC only] Describes an IPv6 range.

" - } - }, - "com.amazonaws.ec2#Ipv6RangeList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Ipv6Range", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#Ipv6SupportValue": { - "type": "enum", - "members": { - "enable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enable" - } - }, - "disable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disable" - } - } - } - }, - "com.amazonaws.ec2#KernelId": { - "type": "string" - }, - "com.amazonaws.ec2#KeyFormat": { - "type": "enum", - "members": { - "pem": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pem" - } - }, - "ppk": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ppk" - } - } - } - }, - "com.amazonaws.ec2#KeyNameStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#KeyPairName", - "traits": { - "smithy.api#xmlName": "KeyName" - } - } - }, - "com.amazonaws.ec2#KeyPair": { - "type": "structure", - "members": { - "KeyFingerprint": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "KeyFingerprint", - "smithy.api#documentation": "", - "smithy.api#xmlName": "keyFingerprint" - } - }, - "KeyMaterial": { - "target": "com.amazonaws.ec2#SensitiveUserData", - "traits": { - "aws.protocols#ec2QueryName": "KeyMaterial", - "smithy.api#documentation": "

An unencrypted PEM encoded RSA or ED25519 private key.

", - "smithy.api#xmlName": "keyMaterial" - } - }, - "KeyName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "KeyName", - "smithy.api#documentation": "

The name of the key pair.

", - "smithy.api#xmlName": "keyName" - } - }, - "KeyPairId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "KeyPairId", - "smithy.api#documentation": "

The ID of the key pair.

", - "smithy.api#xmlName": "keyPairId" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags applied to the key pair.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a key pair.

" - } - }, - "com.amazonaws.ec2#KeyPairId": { - "type": "string" - }, - "com.amazonaws.ec2#KeyPairIdStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#KeyPairId", - "traits": { - "smithy.api#xmlName": "KeyPairId" - } - } - }, - "com.amazonaws.ec2#KeyPairInfo": { - "type": "structure", - "members": { - "KeyPairId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "KeyPairId", - "smithy.api#documentation": "

The ID of the key pair.

", - "smithy.api#xmlName": "keyPairId" - } - }, - "KeyFingerprint": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "KeyFingerprint", - "smithy.api#documentation": "

If you used CreateKeyPair to create the key pair:

\n \n

If you used ImportKeyPair to provide Amazon Web Services the public key:

\n ", - "smithy.api#xmlName": "keyFingerprint" - } - }, - "KeyName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "KeyName", - "smithy.api#documentation": "

The name of the key pair.

", - "smithy.api#xmlName": "keyName" - } - }, - "KeyType": { - "target": "com.amazonaws.ec2#KeyType", - "traits": { - "aws.protocols#ec2QueryName": "KeyType", - "smithy.api#documentation": "

The type of key pair.

", - "smithy.api#xmlName": "keyType" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags applied to the key pair.

", - "smithy.api#xmlName": "tagSet" - } - }, - "PublicKey": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PublicKey", - "smithy.api#documentation": "

The public key material.

", - "smithy.api#xmlName": "publicKey" - } - }, - "CreateTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "CreateTime", - "smithy.api#documentation": "

If you used Amazon EC2 to create the key pair, this is the date and time when the key\n was created, in ISO\n 8601 date-time format, in the UTC time zone.

\n

If you imported an existing key pair to Amazon EC2, this is the date and time the key\n was imported, in ISO\n 8601 date-time format, in the UTC time zone.

", - "smithy.api#xmlName": "createTime" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a key pair.

" - } - }, - "com.amazonaws.ec2#KeyPairList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#KeyPairInfo", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#KeyPairName": { - "type": "string" - }, - "com.amazonaws.ec2#KeyType": { - "type": "enum", - "members": { - "rsa": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "rsa" - } - }, - "ed25519": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ed25519" - } - } - } - }, - "com.amazonaws.ec2#KmsKeyId": { - "type": "string" - }, - "com.amazonaws.ec2#LastError": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "

The error message for the VPC endpoint error.

", - "smithy.api#xmlName": "message" - } - }, - "Code": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The error code for the VPC endpoint error.

", - "smithy.api#xmlName": "code" - } - } - }, - "traits": { - "smithy.api#documentation": "

The last error that occurred for a VPC endpoint.

" - } - }, - "com.amazonaws.ec2#LaunchPermission": { - "type": "structure", - "members": { - "Group": { - "target": "com.amazonaws.ec2#PermissionGroup", - "traits": { - "aws.protocols#ec2QueryName": "Group", - "smithy.api#documentation": "

The name of the group.

", - "smithy.api#xmlName": "group" - } - }, - "UserId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "UserId", - "smithy.api#documentation": "

The Amazon Web Services account ID.

\n

Constraints: Up to 10 000 account IDs can be specified in a single request.

", - "smithy.api#xmlName": "userId" - } - }, - "OrganizationArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OrganizationArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an organization.

", - "smithy.api#xmlName": "organizationArn" - } - }, - "OrganizationalUnitArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OrganizationalUnitArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an organizational unit (OU).

", - "smithy.api#xmlName": "organizationalUnitArn" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a launch permission.

" - } - }, - "com.amazonaws.ec2#LaunchPermissionList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#LaunchPermission", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#LaunchPermissionModifications": { - "type": "structure", - "members": { - "Add": { - "target": "com.amazonaws.ec2#LaunchPermissionList", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID, organization ARN, or OU ARN to add to the list of launch permissions for the AMI.

" - } - }, - "Remove": { - "target": "com.amazonaws.ec2#LaunchPermissionList", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID, organization ARN, or OU ARN to remove from the list of launch permissions for the AMI.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a launch permission modification.

" - } - }, - "com.amazonaws.ec2#LaunchSpecification": { - "type": "structure", - "members": { - "UserData": { - "target": "com.amazonaws.ec2#SensitiveUserData", - "traits": { - "aws.protocols#ec2QueryName": "UserData", - "smithy.api#documentation": "

The base64-encoded user data that instances use when starting up. User data is limited to 16 KB.

", - "smithy.api#xmlName": "userData" - } - }, - "SecurityGroups": { - "target": "com.amazonaws.ec2#GroupIdentifierList", - "traits": { - "aws.protocols#ec2QueryName": "GroupSet", - "smithy.api#documentation": "

The IDs of the security groups.

", - "smithy.api#xmlName": "groupSet" - } - }, - "AddressingType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AddressingType", - "smithy.api#documentation": "

Deprecated.

", - "smithy.api#xmlName": "addressingType" - } - }, - "BlockDeviceMappings": { - "target": "com.amazonaws.ec2#BlockDeviceMappingList", - "traits": { - "aws.protocols#ec2QueryName": "BlockDeviceMapping", - "smithy.api#documentation": "

The block device mapping entries.

", - "smithy.api#xmlName": "blockDeviceMapping" - } - }, - "EbsOptimized": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "EbsOptimized", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#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.

\n

Default: false\n

", - "smithy.api#xmlName": "ebsOptimized" - } - }, - "IamInstanceProfile": { - "target": "com.amazonaws.ec2#IamInstanceProfileSpecification", - "traits": { - "aws.protocols#ec2QueryName": "IamInstanceProfile", - "smithy.api#documentation": "

The IAM instance profile.

", - "smithy.api#xmlName": "iamInstanceProfile" - } - }, - "ImageId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ImageId", - "smithy.api#documentation": "

The ID of the AMI.

", - "smithy.api#xmlName": "imageId" - } - }, - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type. Only one instance type can be specified.

", - "smithy.api#xmlName": "instanceType" - } - }, - "KernelId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "KernelId", - "smithy.api#documentation": "

The ID of the kernel.

", - "smithy.api#xmlName": "kernelId" - } - }, - "KeyName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "KeyName", - "smithy.api#documentation": "

The name of the key pair.

", - "smithy.api#xmlName": "keyName" - } - }, - "NetworkInterfaces": { - "target": "com.amazonaws.ec2#InstanceNetworkInterfaceSpecificationList", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceSet", - "smithy.api#documentation": "

The network interfaces. If you specify a network interface, you must specify \n subnet IDs and security group IDs using the network interface.

", - "smithy.api#xmlName": "networkInterfaceSet" - } - }, - "Placement": { - "target": "com.amazonaws.ec2#SpotPlacement", - "traits": { - "aws.protocols#ec2QueryName": "Placement", - "smithy.api#documentation": "

The placement information for the instance.

", - "smithy.api#xmlName": "placement" - } - }, - "RamdiskId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "RamdiskId", - "smithy.api#documentation": "

The ID of the RAM disk.

", - "smithy.api#xmlName": "ramdiskId" - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#documentation": "

The ID of the subnet in which to launch the instance.

", - "smithy.api#xmlName": "subnetId" - } - }, - "Monitoring": { - "target": "com.amazonaws.ec2#RunInstancesMonitoringEnabled", - "traits": { - "aws.protocols#ec2QueryName": "Monitoring", - "smithy.api#xmlName": "monitoring" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the launch specification for an instance.

" - } - }, - "com.amazonaws.ec2#LaunchSpecsList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SpotFleetLaunchSpecification", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#LaunchTemplate": { - "type": "structure", - "members": { - "LaunchTemplateId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateId", - "smithy.api#documentation": "

The ID of the launch template.

", - "smithy.api#xmlName": "launchTemplateId" - } - }, - "LaunchTemplateName": { - "target": "com.amazonaws.ec2#LaunchTemplateName", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateName", - "smithy.api#documentation": "

The name of the launch template.

", - "smithy.api#xmlName": "launchTemplateName" - } - }, - "CreateTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "CreateTime", - "smithy.api#documentation": "

The time launch template was created.

", - "smithy.api#xmlName": "createTime" - } - }, - "CreatedBy": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CreatedBy", - "smithy.api#documentation": "

The principal that created the launch template.

", - "smithy.api#xmlName": "createdBy" - } - }, - "DefaultVersionNumber": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "aws.protocols#ec2QueryName": "DefaultVersionNumber", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The version number of the default version of the launch template.

", - "smithy.api#xmlName": "defaultVersionNumber" - } - }, - "LatestVersionNumber": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "aws.protocols#ec2QueryName": "LatestVersionNumber", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The version number of the latest version of the launch template.

", - "smithy.api#xmlName": "latestVersionNumber" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags for the launch template.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a launch template.

" - } - }, - "com.amazonaws.ec2#LaunchTemplateAndOverridesResponse": { - "type": "structure", - "members": { - "LaunchTemplateSpecification": { - "target": "com.amazonaws.ec2#FleetLaunchTemplateSpecification", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateSpecification", - "smithy.api#documentation": "

The launch template.

", - "smithy.api#xmlName": "launchTemplateSpecification" - } - }, - "Overrides": { - "target": "com.amazonaws.ec2#FleetLaunchTemplateOverrides", - "traits": { - "aws.protocols#ec2QueryName": "Overrides", - "smithy.api#documentation": "

Any parameters that you specify override the same parameters in the launch\n template.

", - "smithy.api#xmlName": "overrides" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a launch template and overrides.

" - } - }, - "com.amazonaws.ec2#LaunchTemplateAutoRecoveryState": { - "type": "enum", - "members": { - "default": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "default" - } - }, - "disabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disabled" - } - } - } - }, - "com.amazonaws.ec2#LaunchTemplateBlockDeviceMapping": { - "type": "structure", - "members": { - "DeviceName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DeviceName", - "smithy.api#documentation": "

The device name.

", - "smithy.api#xmlName": "deviceName" - } - }, - "VirtualName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VirtualName", - "smithy.api#documentation": "

The virtual device name (ephemeralN).

", - "smithy.api#xmlName": "virtualName" - } - }, - "Ebs": { - "target": "com.amazonaws.ec2#LaunchTemplateEbsBlockDevice", - "traits": { - "aws.protocols#ec2QueryName": "Ebs", - "smithy.api#documentation": "

Information about the block device for an EBS volume.

", - "smithy.api#xmlName": "ebs" - } - }, - "NoDevice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NoDevice", - "smithy.api#documentation": "

To omit the device from the block device mapping, specify an empty string.

", - "smithy.api#xmlName": "noDevice" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a block device mapping.

" - } - }, - "com.amazonaws.ec2#LaunchTemplateBlockDeviceMappingList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#LaunchTemplateBlockDeviceMapping", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#LaunchTemplateBlockDeviceMappingRequest": { - "type": "structure", - "members": { - "DeviceName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The device name (for example, /dev/sdh or xvdh).

" - } - }, - "VirtualName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The virtual device name (ephemeralN). Instance store volumes are numbered starting\n from 0. An instance type with 2 available instance store volumes can specify mappings\n for ephemeral0 and ephemeral1. The number of available instance store volumes depends on\n the instance type. After you connect to the instance, you must mount the volume.

" - } - }, - "Ebs": { - "target": "com.amazonaws.ec2#LaunchTemplateEbsBlockDeviceRequest", - "traits": { - "smithy.api#documentation": "

Parameters used to automatically set up EBS volumes when the instance is\n launched.

" - } - }, - "NoDevice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

To omit the device from the block device mapping, specify an empty string.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a block device mapping.

" - } - }, - "com.amazonaws.ec2#LaunchTemplateBlockDeviceMappingRequestList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#LaunchTemplateBlockDeviceMappingRequest", - "traits": { - "smithy.api#xmlName": "BlockDeviceMapping" - } - } - }, - "com.amazonaws.ec2#LaunchTemplateCapacityReservationSpecificationRequest": { - "type": "structure", - "members": { - "CapacityReservationPreference": { - "target": "com.amazonaws.ec2#CapacityReservationPreference", - "traits": { - "smithy.api#documentation": "

Indicates the instance's Capacity Reservation preferences. Possible preferences\n include:

\n " - } - }, - "CapacityReservationTarget": { - "target": "com.amazonaws.ec2#CapacityReservationTarget", - "traits": { - "smithy.api#documentation": "

Information about the target Capacity Reservation or Capacity Reservation\n group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an instance's Capacity Reservation targeting option. You can specify only\n one option at a time. Use the CapacityReservationPreference parameter to\n configure the instance to run in On-Demand capacity or to run in any open\n Capacity Reservation that has matching attributes (instance type, platform, Availability\n Zone). Use the CapacityReservationTarget parameter to explicitly target a\n specific Capacity Reservation or a Capacity Reservation group.

" - } - }, - "com.amazonaws.ec2#LaunchTemplateCapacityReservationSpecificationResponse": { - "type": "structure", - "members": { - "CapacityReservationPreference": { - "target": "com.amazonaws.ec2#CapacityReservationPreference", - "traits": { - "aws.protocols#ec2QueryName": "CapacityReservationPreference", - "smithy.api#documentation": "

Indicates the instance's Capacity Reservation preferences. Possible preferences\n include:

\n ", - "smithy.api#xmlName": "capacityReservationPreference" - } - }, - "CapacityReservationTarget": { - "target": "com.amazonaws.ec2#CapacityReservationTargetResponse", - "traits": { - "aws.protocols#ec2QueryName": "CapacityReservationTarget", - "smithy.api#documentation": "

Information about the target Capacity Reservation or Capacity Reservation\n group.

", - "smithy.api#xmlName": "capacityReservationTarget" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the Capacity Reservation targeting option.

" - } - }, - "com.amazonaws.ec2#LaunchTemplateConfig": { - "type": "structure", - "members": { - "LaunchTemplateSpecification": { - "target": "com.amazonaws.ec2#FleetLaunchTemplateSpecification", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateSpecification", - "smithy.api#documentation": "

The launch template.

", - "smithy.api#xmlName": "launchTemplateSpecification" - } - }, - "Overrides": { - "target": "com.amazonaws.ec2#LaunchTemplateOverridesList", - "traits": { - "aws.protocols#ec2QueryName": "Overrides", - "smithy.api#documentation": "

Any parameters that you specify override the same parameters in the launch\n template.

", - "smithy.api#xmlName": "overrides" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a launch template and overrides.

" - } - }, - "com.amazonaws.ec2#LaunchTemplateConfigList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#LaunchTemplateConfig", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#LaunchTemplateCpuOptions": { - "type": "structure", - "members": { - "CoreCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "CoreCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of CPU cores for the instance.

", - "smithy.api#xmlName": "coreCount" - } - }, - "ThreadsPerCore": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "ThreadsPerCore", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of threads per CPU core.

", - "smithy.api#xmlName": "threadsPerCore" - } - }, - "AmdSevSnp": { - "target": "com.amazonaws.ec2#AmdSevSnpSpecification", - "traits": { - "aws.protocols#ec2QueryName": "AmdSevSnp", - "smithy.api#documentation": "

Indicates whether the instance is enabled for \n AMD SEV-SNP.

", - "smithy.api#xmlName": "amdSevSnp" - } - } - }, - "traits": { - "smithy.api#documentation": "

The CPU options for the instance.

" - } - }, - "com.amazonaws.ec2#LaunchTemplateCpuOptionsRequest": { - "type": "structure", - "members": { - "CoreCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of CPU cores for the instance.

" - } - }, - "ThreadsPerCore": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of threads per CPU core. To disable multithreading for the instance,\n specify a value of 1. Otherwise, specify the default value of\n 2.

" - } - }, - "AmdSevSnp": { - "target": "com.amazonaws.ec2#AmdSevSnpSpecification", - "traits": { - "smithy.api#documentation": "

Indicates whether to enable the instance for AMD SEV-SNP. AMD SEV-SNP is supported \n with M6a, R6a, and C6a instance types only.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The CPU options for the instance. Both the core count and threads per core must be\n specified in the request.

" - } - }, - "com.amazonaws.ec2#LaunchTemplateEbsBlockDevice": { - "type": "structure", - "members": { - "Encrypted": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Encrypted", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the EBS volume is encrypted.

", - "smithy.api#xmlName": "encrypted" - } - }, - "DeleteOnTermination": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DeleteOnTermination", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the EBS volume is deleted on instance termination.

", - "smithy.api#xmlName": "deleteOnTermination" - } - }, - "Iops": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Iops", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of I/O operations per second (IOPS) that the volume supports.

", - "smithy.api#xmlName": "iops" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.ec2#KmsKeyId", - "traits": { - "aws.protocols#ec2QueryName": "KmsKeyId", - "smithy.api#documentation": "

The ARN of the Key Management Service (KMS) CMK used for encryption.

", - "smithy.api#xmlName": "kmsKeyId" - } - }, - "SnapshotId": { - "target": "com.amazonaws.ec2#SnapshotId", - "traits": { - "aws.protocols#ec2QueryName": "SnapshotId", - "smithy.api#documentation": "

The ID of the snapshot.

", - "smithy.api#xmlName": "snapshotId" - } - }, - "VolumeSize": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "VolumeSize", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The size of the volume, in GiB.

", - "smithy.api#xmlName": "volumeSize" - } - }, - "VolumeType": { - "target": "com.amazonaws.ec2#VolumeType", - "traits": { - "aws.protocols#ec2QueryName": "VolumeType", - "smithy.api#documentation": "

The volume type.

", - "smithy.api#xmlName": "volumeType" - } - }, - "Throughput": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Throughput", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The throughput that the volume supports, in MiB/s.

", - "smithy.api#xmlName": "throughput" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a block device for an EBS volume.

" - } - }, - "com.amazonaws.ec2#LaunchTemplateEbsBlockDeviceRequest": { - "type": "structure", - "members": { - "Encrypted": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached\n to instances that support Amazon EBS encryption. If you are creating a volume from a\n snapshot, you can't specify an encryption value.

" - } - }, - "DeleteOnTermination": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the EBS volume is deleted on instance termination.

" - } - }, - "Iops": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of I/O operations per second (IOPS). For gp3,\n io1, and io2 volumes, this represents the number of IOPS that\n are provisioned for the volume. For gp2 volumes, this represents the\n baseline performance of the volume and the rate at which the volume accumulates I/O\n credits for bursting.

\n

The following are the supported values for each volume type:

\n \n

For io1 and io2 volumes, we guarantee\n 64,000 IOPS only for Instances built on the\n Nitro System. Other instance families guarantee performance up to\n 32,000 IOPS.

\n

This parameter is supported for io1, io2, and gp3 volumes only. This parameter\n is not supported for gp2, st1, sc1, or standard volumes.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.ec2#KmsKeyId", - "traits": { - "smithy.api#documentation": "

The ARN of the symmetric Key Management Service (KMS) CMK used for encryption.

" - } - }, - "SnapshotId": { - "target": "com.amazonaws.ec2#SnapshotId", - "traits": { - "smithy.api#documentation": "

The ID of the snapshot.

" - } - }, - "VolumeSize": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume\n size. The following are the supported volumes sizes for each volume type:

\n " - } - }, - "VolumeType": { - "target": "com.amazonaws.ec2#VolumeType", - "traits": { - "smithy.api#documentation": "

The volume type. For more information, see Amazon EBS volume types in the\n Amazon Elastic Compute Cloud User Guide.

" - } - }, - "Throughput": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The throughput to provision for a gp3 volume, with a maximum of 1,000\n MiB/s.

\n

Valid Range: Minimum value of 125. Maximum value of 1000.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for a block device for an EBS volume.

" - } - }, - "com.amazonaws.ec2#LaunchTemplateElasticInferenceAccelerator": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The type of elastic inference accelerator. The possible values are eia1.medium,\n eia1.large, and eia1.xlarge.

", - "smithy.api#required": {} - } - }, - "Count": { - "target": "com.amazonaws.ec2#LaunchTemplateElasticInferenceAcceleratorCount", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of elastic inference accelerators to attach to the instance.

\n

Default: 1

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an elastic inference accelerator.

" - } - }, - "com.amazonaws.ec2#LaunchTemplateElasticInferenceAcceleratorCount": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.ec2#LaunchTemplateElasticInferenceAcceleratorList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#LaunchTemplateElasticInferenceAccelerator", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#LaunchTemplateElasticInferenceAcceleratorResponse": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Type", - "smithy.api#documentation": "

The type of elastic inference accelerator. The possible values are eia1.medium,\n eia1.large, and eia1.xlarge.

", - "smithy.api#xmlName": "type" - } - }, - "Count": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Count", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of elastic inference accelerators to attach to the instance.

\n

Default: 1

", - "smithy.api#xmlName": "count" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an elastic inference accelerator.

" - } - }, - "com.amazonaws.ec2#LaunchTemplateElasticInferenceAcceleratorResponseList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#LaunchTemplateElasticInferenceAcceleratorResponse", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#LaunchTemplateEnclaveOptions": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Enabled", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

If this parameter is set to true, the instance is enabled for Amazon Web Services Nitro\n Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro Enclaves.

", - "smithy.api#xmlName": "enabled" - } - } - }, - "traits": { - "smithy.api#documentation": "

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.

" - } - }, - "com.amazonaws.ec2#LaunchTemplateEnclaveOptionsRequest": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to\n true.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more\n information, see What is Amazon Web Services Nitro Enclaves?\n in the Amazon Web Services Nitro Enclaves User Guide.

" - } - }, - "com.amazonaws.ec2#LaunchTemplateErrorCode": { - "type": "enum", - "members": { - "LAUNCH_TEMPLATE_ID_DOES_NOT_EXIST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "launchTemplateIdDoesNotExist" - } - }, - "LAUNCH_TEMPLATE_ID_MALFORMED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "launchTemplateIdMalformed" - } - }, - "LAUNCH_TEMPLATE_NAME_DOES_NOT_EXIST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "launchTemplateNameDoesNotExist" - } - }, - "LAUNCH_TEMPLATE_NAME_MALFORMED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "launchTemplateNameMalformed" - } - }, - "LAUNCH_TEMPLATE_VERSION_DOES_NOT_EXIST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "launchTemplateVersionDoesNotExist" - } - }, - "UNEXPECTED_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unexpectedError" - } - } - } - }, - "com.amazonaws.ec2#LaunchTemplateHibernationOptions": { - "type": "structure", - "members": { - "Configured": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Configured", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

If this parameter is set to true, the instance is enabled for\n hibernation; otherwise, it is not enabled for hibernation.

", - "smithy.api#xmlName": "configured" - } - } - }, - "traits": { - "smithy.api#documentation": "

Indicates whether an instance is configured for hibernation.

" - } - }, - "com.amazonaws.ec2#LaunchTemplateHibernationOptionsRequest": { - "type": "structure", - "members": { - "Configured": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

If you set this parameter to true, the instance is enabled for\n hibernation.

\n

Default: false\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Indicates whether the instance is configured for hibernation. This parameter is valid\n only if the instance meets the hibernation\n prerequisites.

" - } - }, - "com.amazonaws.ec2#LaunchTemplateHttpTokensState": { - "type": "enum", - "members": { - "optional": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "optional" - } - }, - "required": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "required" - } - } - } - }, - "com.amazonaws.ec2#LaunchTemplateIamInstanceProfileSpecification": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Arn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the instance profile.

", - "smithy.api#xmlName": "arn" - } - }, - "Name": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Name", - "smithy.api#documentation": "

The name of the instance profile.

", - "smithy.api#xmlName": "name" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an IAM instance profile.

" - } - }, - "com.amazonaws.ec2#LaunchTemplateIamInstanceProfileSpecificationRequest": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the instance profile.

" - } - }, - "Name": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The name of the instance profile.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An IAM instance profile.

" - } - }, - "com.amazonaws.ec2#LaunchTemplateId": { - "type": "string" - }, - "com.amazonaws.ec2#LaunchTemplateIdStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#LaunchTemplateId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#LaunchTemplateInstanceMaintenanceOptions": { - "type": "structure", - "members": { - "AutoRecovery": { - "target": "com.amazonaws.ec2#LaunchTemplateAutoRecoveryState", - "traits": { - "aws.protocols#ec2QueryName": "AutoRecovery", - "smithy.api#documentation": "

Disables the automatic recovery behavior of your instance or sets it to\n default.

", - "smithy.api#xmlName": "autoRecovery" - } - } - }, - "traits": { - "smithy.api#documentation": "

The maintenance options of your instance.

" - } - }, - "com.amazonaws.ec2#LaunchTemplateInstanceMaintenanceOptionsRequest": { - "type": "structure", - "members": { - "AutoRecovery": { - "target": "com.amazonaws.ec2#LaunchTemplateAutoRecoveryState", - "traits": { - "smithy.api#documentation": "

Disables the automatic recovery behavior of your instance or sets it to default. For\n more information, see Simplified automatic recovery.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The maintenance options of your instance.

" - } - }, - "com.amazonaws.ec2#LaunchTemplateInstanceMarketOptions": { - "type": "structure", - "members": { - "MarketType": { - "target": "com.amazonaws.ec2#MarketType", - "traits": { - "aws.protocols#ec2QueryName": "MarketType", - "smithy.api#documentation": "

The market type.

", - "smithy.api#xmlName": "marketType" - } - }, - "SpotOptions": { - "target": "com.amazonaws.ec2#LaunchTemplateSpotMarketOptions", - "traits": { - "aws.protocols#ec2QueryName": "SpotOptions", - "smithy.api#documentation": "

The options for Spot Instances.

", - "smithy.api#xmlName": "spotOptions" - } - } - }, - "traits": { - "smithy.api#documentation": "

The market (purchasing) option for the instances.

" - } - }, - "com.amazonaws.ec2#LaunchTemplateInstanceMarketOptionsRequest": { - "type": "structure", - "members": { - "MarketType": { - "target": "com.amazonaws.ec2#MarketType", - "traits": { - "smithy.api#documentation": "

The market type.

" - } - }, - "SpotOptions": { - "target": "com.amazonaws.ec2#LaunchTemplateSpotMarketOptionsRequest", - "traits": { - "smithy.api#documentation": "

The options for Spot Instances.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The market (purchasing) option for the instances.

" - } - }, - "com.amazonaws.ec2#LaunchTemplateInstanceMetadataEndpointState": { - "type": "enum", - "members": { - "disabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disabled" - } - }, - "enabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enabled" - } - } - } - }, - "com.amazonaws.ec2#LaunchTemplateInstanceMetadataOptions": { - "type": "structure", - "members": { - "State": { - "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataOptionsState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the metadata option changes.

\n

\n pending - The metadata options are being updated and the instance is not\n ready to process metadata traffic with the new selection.

\n

\n applied - The metadata options have been successfully applied on the\n instance.

", - "smithy.api#xmlName": "state" - } - }, - "HttpTokens": { - "target": "com.amazonaws.ec2#LaunchTemplateHttpTokensState", - "traits": { - "aws.protocols#ec2QueryName": "HttpTokens", - "smithy.api#documentation": "

Indicates whether IMDSv2 is optional or required.

\n

\n optional - When IMDSv2 is optional, you can choose to retrieve instance metadata with or without \n a session token in your request. If you retrieve the IAM role credentials \n without a token, the IMDSv1 role credentials are returned. If you retrieve the IAM role credentials \n using a valid session token, the IMDSv2 role credentials are returned.

\n

\n required - When IMDSv2 is required, you must send a session token \n with any instance metadata retrieval requests. In this state, retrieving the IAM role \n credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.

\n

Default: optional\n

", - "smithy.api#xmlName": "httpTokens" - } - }, - "HttpPutResponseHopLimit": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "HttpPutResponseHopLimit", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel.

\n

Default: 1

\n

Possible values: Integers from 1 to 64

", - "smithy.api#xmlName": "httpPutResponseHopLimit" - } - }, - "HttpEndpoint": { - "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataEndpointState", - "traits": { - "aws.protocols#ec2QueryName": "HttpEndpoint", - "smithy.api#documentation": "

Enables or disables the HTTP metadata endpoint on your instances. If the parameter is\n not specified, the default state is enabled.

\n \n

If you specify a value of disabled, you will not be able to access\n your instance metadata.

\n ", - "smithy.api#xmlName": "httpEndpoint" - } - }, - "HttpProtocolIpv6": { - "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataProtocolIpv6", - "traits": { - "aws.protocols#ec2QueryName": "HttpProtocolIpv6", - "smithy.api#documentation": "

Enables or disables the IPv6 endpoint for the instance metadata service.

\n

Default: disabled\n

", - "smithy.api#xmlName": "httpProtocolIpv6" - } - }, - "InstanceMetadataTags": { - "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataTagsState", - "traits": { - "aws.protocols#ec2QueryName": "InstanceMetadataTags", - "smithy.api#documentation": "

Set to enabled to allow access to instance tags from the instance\n metadata. Set to disabled to turn off access to instance tags from the\n instance metadata. For more information, see Work with\n instance tags using the instance metadata.

\n

Default: disabled\n

", - "smithy.api#xmlName": "instanceMetadataTags" - } - } - }, - "traits": { - "smithy.api#documentation": "

The metadata options for the instance. For more information, see Instance metadata and user data in the\n Amazon Elastic Compute Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#LaunchTemplateInstanceMetadataOptionsRequest": { - "type": "structure", - "members": { - "HttpTokens": { - "target": "com.amazonaws.ec2#LaunchTemplateHttpTokensState", - "traits": { - "smithy.api#documentation": "

IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to optional\n (in other words, set the use of IMDSv2 to optional) or\n required (in other words, set the use of IMDSv2 to\n required).

\n \n

Default: optional\n

" - } - }, - "HttpPutResponseHopLimit": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel.

\n

Default: 1\n

\n

Possible values: Integers from 1 to 64

" - } - }, - "HttpEndpoint": { - "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataEndpointState", - "traits": { - "smithy.api#documentation": "

Enables or disables the HTTP metadata endpoint on your instances. If the parameter is\n not specified, the default state is enabled.

\n \n

If you specify a value of disabled, you will not be able to access\n your instance metadata.

\n " - } - }, - "HttpProtocolIpv6": { - "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataProtocolIpv6", - "traits": { - "smithy.api#documentation": "

Enables or disables the IPv6 endpoint for the instance metadata service.

\n

Default: disabled\n

" - } - }, - "InstanceMetadataTags": { - "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataTagsState", - "traits": { - "smithy.api#documentation": "

Set to enabled to allow access to instance tags from the instance\n metadata. Set to disabled to turn off access to instance tags from the\n instance metadata. For more information, see Work with\n instance tags using the instance metadata.

\n

Default: disabled\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The metadata options for the instance. For more information, see Instance metadata and user data in the\n Amazon Elastic Compute Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#LaunchTemplateInstanceMetadataOptionsState": { - "type": "enum", - "members": { - "pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "applied": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "applied" - } - } - } - }, - "com.amazonaws.ec2#LaunchTemplateInstanceMetadataProtocolIpv6": { - "type": "enum", - "members": { - "disabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disabled" - } - }, - "enabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enabled" - } - } - } - }, - "com.amazonaws.ec2#LaunchTemplateInstanceMetadataTagsState": { - "type": "enum", - "members": { - "disabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disabled" - } - }, - "enabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enabled" - } - } - } - }, - "com.amazonaws.ec2#LaunchTemplateInstanceNetworkInterfaceSpecification": { - "type": "structure", - "members": { - "AssociateCarrierIpAddress": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "AssociateCarrierIpAddress", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to associate a Carrier IP address with eth0 for a new network\n interface.

\n

Use this option when you launch an instance in a Wavelength Zone and want to associate\n a Carrier IP address with the network interface. For more information about Carrier IP\n addresses, see Carrier IP addresses in the Wavelength Developer\n Guide.

", - "smithy.api#xmlName": "associateCarrierIpAddress" - } - }, - "AssociatePublicIpAddress": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "AssociatePublicIpAddress", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to associate a public IPv4 address with eth0 for a new network\n interface.

", - "smithy.api#xmlName": "associatePublicIpAddress" - } - }, - "DeleteOnTermination": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DeleteOnTermination", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the network interface is deleted when the instance is\n terminated.

", - "smithy.api#xmlName": "deleteOnTermination" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description for the network interface.

", - "smithy.api#xmlName": "description" - } - }, - "DeviceIndex": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "DeviceIndex", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The device index for the network interface attachment.

", - "smithy.api#xmlName": "deviceIndex" - } - }, - "Groups": { - "target": "com.amazonaws.ec2#GroupIdStringList", - "traits": { - "aws.protocols#ec2QueryName": "GroupSet", - "smithy.api#documentation": "

The IDs of one or more security groups.

", - "smithy.api#xmlName": "groupSet" - } - }, - "InterfaceType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InterfaceType", - "smithy.api#documentation": "

The type of network interface.

", - "smithy.api#xmlName": "interfaceType" - } - }, - "Ipv6AddressCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6AddressCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of IPv6 addresses for the network interface.

", - "smithy.api#xmlName": "ipv6AddressCount" - } - }, - "Ipv6Addresses": { - "target": "com.amazonaws.ec2#InstanceIpv6AddressList", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6AddressesSet", - "smithy.api#documentation": "

The IPv6 addresses for the network interface.

", - "smithy.api#xmlName": "ipv6AddressesSet" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#NetworkInterfaceId", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "

The ID of the network interface.

", - "smithy.api#xmlName": "networkInterfaceId" - } - }, - "PrivateIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrivateIpAddress", - "smithy.api#documentation": "

The primary private IPv4 address of the network interface.

", - "smithy.api#xmlName": "privateIpAddress" - } - }, - "PrivateIpAddresses": { - "target": "com.amazonaws.ec2#PrivateIpAddressSpecificationList", - "traits": { - "aws.protocols#ec2QueryName": "PrivateIpAddressesSet", - "smithy.api#documentation": "

One or more private IPv4 addresses.

", - "smithy.api#xmlName": "privateIpAddressesSet" - } - }, - "SecondaryPrivateIpAddressCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "SecondaryPrivateIpAddressCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of secondary private IPv4 addresses for the network interface.

", - "smithy.api#xmlName": "secondaryPrivateIpAddressCount" - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#SubnetId", - "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#documentation": "

The ID of the subnet for the network interface.

", - "smithy.api#xmlName": "subnetId" - } - }, - "NetworkCardIndex": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "NetworkCardIndex", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The index of the network card.

", - "smithy.api#xmlName": "networkCardIndex" - } - }, - "Ipv4Prefixes": { - "target": "com.amazonaws.ec2#Ipv4PrefixListResponse", - "traits": { - "aws.protocols#ec2QueryName": "Ipv4PrefixSet", - "smithy.api#documentation": "

One or more IPv4 prefixes assigned to the network interface.

", - "smithy.api#xmlName": "ipv4PrefixSet" - } - }, - "Ipv4PrefixCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Ipv4PrefixCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of IPv4 prefixes that Amazon Web Services automatically assigned to the network\n interface.

", - "smithy.api#xmlName": "ipv4PrefixCount" - } - }, - "Ipv6Prefixes": { - "target": "com.amazonaws.ec2#Ipv6PrefixListResponse", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6PrefixSet", - "smithy.api#documentation": "

One or more IPv6 prefixes assigned to the network interface.

", - "smithy.api#xmlName": "ipv6PrefixSet" - } - }, - "Ipv6PrefixCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6PrefixCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of IPv6 prefixes that Amazon Web Services automatically assigned to the network\n interface.

", - "smithy.api#xmlName": "ipv6PrefixCount" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a network interface.

" - } - }, - "com.amazonaws.ec2#LaunchTemplateInstanceNetworkInterfaceSpecificationList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#LaunchTemplateInstanceNetworkInterfaceSpecification", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#LaunchTemplateInstanceNetworkInterfaceSpecificationRequest": { - "type": "structure", - "members": { - "AssociateCarrierIpAddress": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Associates a Carrier IP address with eth0 for a new network interface.

\n

Use this option when you launch an instance in a Wavelength Zone and want to associate\n a Carrier IP address with the network interface. For more information about Carrier IP\n addresses, see Carrier IP addresses in the Wavelength Developer\n Guide.

" - } - }, - "AssociatePublicIpAddress": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Associates a public IPv4 address with eth0 for a new network interface.

" - } - }, - "DeleteOnTermination": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the network interface is deleted when the instance is\n terminated.

" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A description for the network interface.

" - } - }, - "DeviceIndex": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The device index for the network interface attachment.

" - } - }, - "Groups": { - "target": "com.amazonaws.ec2#SecurityGroupIdStringList", - "traits": { - "smithy.api#documentation": "

The IDs of one or more security groups.

", - "smithy.api#xmlName": "SecurityGroupId" - } - }, - "InterfaceType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The type of network interface. To create an Elastic Fabric Adapter (EFA), specify\n efa. For more information, see Elastic Fabric Adapter in the\n Amazon Elastic Compute Cloud User Guide.

\n

If you are not creating an EFA, specify interface or omit this\n parameter.

\n

Valid values: interface | efa\n

" - } - }, - "Ipv6AddressCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of IPv6 addresses to assign to a network interface. Amazon EC2\n automatically selects the IPv6 addresses from the subnet range. You can't use this\n option if specifying specific IPv6 addresses.

" - } - }, - "Ipv6Addresses": { - "target": "com.amazonaws.ec2#InstanceIpv6AddressListRequest", - "traits": { - "smithy.api#documentation": "

One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You\n can't use this option if you're specifying a number of IPv6 addresses.

" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#NetworkInterfaceId", - "traits": { - "smithy.api#documentation": "

The ID of the network interface.

" - } - }, - "PrivateIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The primary private IPv4 address of the network interface.

" - } - }, - "PrivateIpAddresses": { - "target": "com.amazonaws.ec2#PrivateIpAddressSpecificationList", - "traits": { - "smithy.api#documentation": "

One or more private IPv4 addresses.

" - } - }, - "SecondaryPrivateIpAddressCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of secondary private IPv4 addresses to assign to a network\n interface.

" - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#SubnetId", - "traits": { - "smithy.api#documentation": "

The ID of the subnet for the network interface.

" - } - }, - "NetworkCardIndex": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The index of the network card. Some instance types support multiple network cards. The\n primary network interface must be assigned to network card index 0. The default is\n network card index 0.

" - } - }, - "Ipv4Prefixes": { - "target": "com.amazonaws.ec2#Ipv4PrefixList", - "traits": { - "smithy.api#documentation": "

One or more IPv4 prefixes to be assigned to the network interface. You cannot use this\n option if you use the Ipv4PrefixCount option.

", - "smithy.api#xmlName": "Ipv4Prefix" - } - }, - "Ipv4PrefixCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of IPv4 prefixes to be automatically assigned to the network interface. You\n cannot use this option if you use the Ipv4Prefix option.

" - } - }, - "Ipv6Prefixes": { - "target": "com.amazonaws.ec2#Ipv6PrefixList", - "traits": { - "smithy.api#documentation": "

One or more IPv6 prefixes to be assigned to the network interface. You cannot use this\n option if you use the Ipv6PrefixCount option.

", - "smithy.api#xmlName": "Ipv6Prefix" - } - }, - "Ipv6PrefixCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of IPv6 prefixes to be automatically assigned to the network interface. You\n cannot use this option if you use the Ipv6Prefix option.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for a network interface.

" - } - }, - "com.amazonaws.ec2#LaunchTemplateInstanceNetworkInterfaceSpecificationRequestList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#LaunchTemplateInstanceNetworkInterfaceSpecificationRequest", - "traits": { - "smithy.api#xmlName": "InstanceNetworkInterfaceSpecification" - } - } - }, - "com.amazonaws.ec2#LaunchTemplateLicenseConfiguration": { - "type": "structure", - "members": { - "LicenseConfigurationArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LicenseConfigurationArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the license configuration.

", - "smithy.api#xmlName": "licenseConfigurationArn" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a license configuration.

" - } - }, - "com.amazonaws.ec2#LaunchTemplateLicenseConfigurationRequest": { - "type": "structure", - "members": { - "LicenseConfigurationArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the license configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a license configuration.

" - } - }, - "com.amazonaws.ec2#LaunchTemplateLicenseList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#LaunchTemplateLicenseConfiguration", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#LaunchTemplateLicenseSpecificationListRequest": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#LaunchTemplateLicenseConfigurationRequest", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#LaunchTemplateName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 128 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\(\\)\\.\\-/_]+$" - } - }, - "com.amazonaws.ec2#LaunchTemplateNameStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#LaunchTemplateName", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#LaunchTemplateOverrides": { - "type": "structure", - "members": { - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type.

", - "smithy.api#xmlName": "instanceType" - } - }, - "SpotPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SpotPrice", - "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to \n increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n ", - "smithy.api#xmlName": "spotPrice" - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#SubnetId", - "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#documentation": "

The ID of the subnet in which to launch the instances.

", - "smithy.api#xmlName": "subnetId" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone in which to launch the instances.

", - "smithy.api#xmlName": "availabilityZone" - } - }, - "WeightedCapacity": { - "target": "com.amazonaws.ec2#Double", - "traits": { - "aws.protocols#ec2QueryName": "WeightedCapacity", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of units provided by the specified instance type.

", - "smithy.api#xmlName": "weightedCapacity" - } - }, - "Priority": { - "target": "com.amazonaws.ec2#Double", - "traits": { - "aws.protocols#ec2QueryName": "Priority", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The priority for the launch template override. The highest priority is launched\n first.

\n

If OnDemandAllocationStrategy is set to prioritized, Spot Fleet\n uses priority to determine which launch template override to use first in fulfilling\n On-Demand capacity.

\n

If the Spot AllocationStrategy is set to\n capacityOptimizedPrioritized, Spot Fleet uses priority on a best-effort basis\n to determine which launch template override to use in fulfilling Spot capacity, but\n optimizes for capacity first.

\n

Valid values are whole numbers starting at 0. The lower the number, the\n higher the priority. If no number is set, the launch template override has the lowest\n priority. You can set the same priority for different launch template overrides.

", - "smithy.api#xmlName": "priority" - } - }, - "InstanceRequirements": { - "target": "com.amazonaws.ec2#InstanceRequirements", - "traits": { - "aws.protocols#ec2QueryName": "InstanceRequirements", - "smithy.api#documentation": "

The instance requirements. When you specify instance requirements, Amazon EC2 will identify\n instance types with the provided requirements, and then use your On-Demand and Spot\n allocation strategies to launch instances from these instance types, in the same way as\n when you specify a list of instance types.

\n \n

If you specify InstanceRequirements, you can't specify\n InstanceType.

\n ", - "smithy.api#xmlName": "instanceRequirements" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes overrides for a launch template.

" - } - }, - "com.amazonaws.ec2#LaunchTemplateOverridesList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#LaunchTemplateOverrides", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#LaunchTemplatePlacement": { - "type": "structure", - "members": { - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone of the instance.

", - "smithy.api#xmlName": "availabilityZone" - } - }, - "Affinity": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Affinity", - "smithy.api#documentation": "

The affinity setting for the instance on the Dedicated Host.

", - "smithy.api#xmlName": "affinity" - } - }, - "GroupName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupName", - "smithy.api#documentation": "

The name of the placement group for the instance.

", - "smithy.api#xmlName": "groupName" - } - }, - "HostId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "HostId", - "smithy.api#documentation": "

The ID of the Dedicated Host for the instance.

", - "smithy.api#xmlName": "hostId" - } - }, - "Tenancy": { - "target": "com.amazonaws.ec2#Tenancy", - "traits": { - "aws.protocols#ec2QueryName": "Tenancy", - "smithy.api#documentation": "

The tenancy of the instance. An instance with a\n tenancy of dedicated runs on single-tenant hardware.

", - "smithy.api#xmlName": "tenancy" - } - }, - "SpreadDomain": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SpreadDomain", - "smithy.api#documentation": "

Reserved for future use.

", - "smithy.api#xmlName": "spreadDomain" - } - }, - "HostResourceGroupArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "HostResourceGroupArn", - "smithy.api#documentation": "

The ARN of the host resource group in which to launch the instances.

", - "smithy.api#xmlName": "hostResourceGroupArn" - } - }, - "PartitionNumber": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "PartitionNumber", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of the partition the instance should launch in. Valid only if the placement\n group strategy is set to partition.

", - "smithy.api#xmlName": "partitionNumber" - } - }, - "GroupId": { - "target": "com.amazonaws.ec2#PlacementGroupId", - "traits": { - "aws.protocols#ec2QueryName": "GroupId", - "smithy.api#documentation": "

The Group ID of the placement group. You must specify the Placement Group Group ID to launch an instance in a shared placement\n group.

", - "smithy.api#xmlName": "groupId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the placement of an instance.

" - } - }, - "com.amazonaws.ec2#LaunchTemplatePlacementRequest": { - "type": "structure", - "members": { - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The Availability Zone for the instance.

" - } - }, - "Affinity": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The affinity setting for an instance on a Dedicated Host.

" - } - }, - "GroupName": { - "target": "com.amazonaws.ec2#PlacementGroupName", - "traits": { - "smithy.api#documentation": "

The name of the placement group for the instance.

" - } - }, - "HostId": { - "target": "com.amazonaws.ec2#DedicatedHostId", - "traits": { - "smithy.api#documentation": "

The ID of the Dedicated Host for the instance.

" - } - }, - "Tenancy": { - "target": "com.amazonaws.ec2#Tenancy", - "traits": { - "smithy.api#documentation": "

The tenancy of the instance. An instance with a\n tenancy of dedicated runs on single-tenant hardware.

" - } - }, - "SpreadDomain": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Reserved for future use.

" - } - }, - "HostResourceGroupArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The ARN of the host resource group in which to launch the instances. If you specify a\n host resource group ARN, omit the Tenancy parameter or\n set it to host.

" - } - }, - "PartitionNumber": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of the partition the instance should launch in. Valid only if the placement\n group strategy is set to partition.

" - } - }, - "GroupId": { - "target": "com.amazonaws.ec2#PlacementGroupId", - "traits": { - "smithy.api#documentation": "

The Group Id of a placement group. You must specify the Placement Group Group Id to launch an instance in a shared placement\n group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the placement of an instance.

" - } - }, - "com.amazonaws.ec2#LaunchTemplatePrivateDnsNameOptions": { - "type": "structure", - "members": { - "HostnameType": { - "target": "com.amazonaws.ec2#HostnameType", - "traits": { - "aws.protocols#ec2QueryName": "HostnameType", - "smithy.api#documentation": "

The type of hostname to assign to an instance.

", - "smithy.api#xmlName": "hostnameType" - } - }, - "EnableResourceNameDnsARecord": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "EnableResourceNameDnsARecord", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS A\n records.

", - "smithy.api#xmlName": "enableResourceNameDnsARecord" - } - }, - "EnableResourceNameDnsAAAARecord": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "EnableResourceNameDnsAAAARecord", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA\n records.

", - "smithy.api#xmlName": "enableResourceNameDnsAAAARecord" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the options for instance hostnames.

" - } - }, - "com.amazonaws.ec2#LaunchTemplatePrivateDnsNameOptionsRequest": { - "type": "structure", - "members": { - "HostnameType": { - "target": "com.amazonaws.ec2#HostnameType", - "traits": { - "smithy.api#documentation": "

The type of hostname for Amazon EC2 instances. For IPv4 only subnets, an instance DNS name\n must be based on the instance IPv4 address. For IPv6 native subnets, an instance DNS\n name must be based on the instance ID. For dual-stack subnets, you can specify whether\n DNS names use the instance IPv4 address or the instance ID.

" - } - }, - "EnableResourceNameDnsARecord": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS A\n records.

" - } - }, - "EnableResourceNameDnsAAAARecord": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA\n records.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the options for instance hostnames.

" - } - }, - "com.amazonaws.ec2#LaunchTemplateSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#LaunchTemplate", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#LaunchTemplateSpecification": { - "type": "structure", - "members": { - "LaunchTemplateId": { - "target": "com.amazonaws.ec2#LaunchTemplateId", - "traits": { - "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify the LaunchTemplateId or the\n LaunchTemplateName, but not both.

" - } - }, - "LaunchTemplateName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The name of the launch template.

\n

You must specify the LaunchTemplateName or the\n LaunchTemplateId, but not both.

" - } - }, - "Version": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The launch template version number, $Latest, or\n $Default.

\n

If the value is $Latest, Amazon EC2 uses the latest version of the launch\n template.

\n

If the value is $Default, Amazon EC2 uses the default version of the\n launch template.

\n

Default: The default version of the launch template.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The launch template to use. You must specify either the launch template ID or launch\n template name in the request, but not both.

" - } - }, - "com.amazonaws.ec2#LaunchTemplateSpotMarketOptions": { - "type": "structure", - "members": { - "MaxPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "MaxPrice", - "smithy.api#documentation": "

The maximum hourly price you're willing to pay for the Spot Instances. We do not\n recommend using this parameter because it can lead to increased interruptions. If you do\n not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your Spot Instances will be interrupted more\n frequently than if you do not specify this parameter.

\n ", - "smithy.api#xmlName": "maxPrice" - } - }, - "SpotInstanceType": { - "target": "com.amazonaws.ec2#SpotInstanceType", - "traits": { - "aws.protocols#ec2QueryName": "SpotInstanceType", - "smithy.api#documentation": "

The Spot Instance request type.

", - "smithy.api#xmlName": "spotInstanceType" - } - }, - "BlockDurationMinutes": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "BlockDurationMinutes", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The required duration for the Spot Instances (also known as Spot blocks), in minutes.\n This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).

", - "smithy.api#xmlName": "blockDurationMinutes" - } - }, - "ValidUntil": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "ValidUntil", - "smithy.api#documentation": "

The end date of the request. For a one-time request, the request remains active until\n all instances launch, the request is canceled, or this date is reached. If the request\n is persistent, it remains active until it is canceled or this date and time is\n reached.

", - "smithy.api#xmlName": "validUntil" - } - }, - "InstanceInterruptionBehavior": { - "target": "com.amazonaws.ec2#InstanceInterruptionBehavior", - "traits": { - "aws.protocols#ec2QueryName": "InstanceInterruptionBehavior", - "smithy.api#documentation": "

The behavior when a Spot Instance is interrupted.

", - "smithy.api#xmlName": "instanceInterruptionBehavior" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options for Spot Instances.

" - } - }, - "com.amazonaws.ec2#LaunchTemplateSpotMarketOptionsRequest": { - "type": "structure", - "members": { - "MaxPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The maximum hourly price you're willing to pay for the Spot Instances. We do not\n recommend using this parameter because it can lead to increased interruptions. If you do\n not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your Spot Instances will be interrupted more\n frequently than if you do not specify this parameter.

\n " - } - }, - "SpotInstanceType": { - "target": "com.amazonaws.ec2#SpotInstanceType", - "traits": { - "smithy.api#documentation": "

The Spot Instance request type.

" - } - }, - "BlockDurationMinutes": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

Deprecated.

" - } - }, - "ValidUntil": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "smithy.api#documentation": "

The end date of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ). Supported only for\n persistent requests.

\n \n

Default: 7 days from the current date

" - } - }, - "InstanceInterruptionBehavior": { - "target": "com.amazonaws.ec2#InstanceInterruptionBehavior", - "traits": { - "smithy.api#documentation": "

The behavior when a Spot Instance is interrupted. The default is\n terminate.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options for Spot Instances.

" - } - }, - "com.amazonaws.ec2#LaunchTemplateTagSpecification": { - "type": "structure", - "members": { - "ResourceType": { - "target": "com.amazonaws.ec2#ResourceType", - "traits": { - "aws.protocols#ec2QueryName": "ResourceType", - "smithy.api#documentation": "

The type of resource to tag.

", - "smithy.api#xmlName": "resourceType" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags for the resource.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

The tags specification for the launch template.

" - } - }, - "com.amazonaws.ec2#LaunchTemplateTagSpecificationList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#LaunchTemplateTagSpecification", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#LaunchTemplateTagSpecificationRequest": { - "type": "structure", - "members": { - "ResourceType": { - "target": "com.amazonaws.ec2#ResourceType", - "traits": { - "smithy.api#documentation": "

The type of resource to tag.

\n

The Valid Values are all the resource types that can be tagged. However,\n when creating a launch template, you can specify tags for the following resource types\n only: instance | volume | elastic-gpu |\n network-interface | spot-instances-request\n

\n

To tag a resource after it has been created, see CreateTags.

" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the resource.

", - "smithy.api#xmlName": "Tag" - } - } - }, - "traits": { - "smithy.api#documentation": "

The tags specification for the resources that are created during instance\n launch.

" - } - }, - "com.amazonaws.ec2#LaunchTemplateTagSpecificationRequestList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#LaunchTemplateTagSpecificationRequest", - "traits": { - "smithy.api#xmlName": "LaunchTemplateTagSpecificationRequest" - } - } - }, - "com.amazonaws.ec2#LaunchTemplateVersion": { - "type": "structure", - "members": { - "LaunchTemplateId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateId", - "smithy.api#documentation": "

The ID of the launch template.

", - "smithy.api#xmlName": "launchTemplateId" - } - }, - "LaunchTemplateName": { - "target": "com.amazonaws.ec2#LaunchTemplateName", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateName", - "smithy.api#documentation": "

The name of the launch template.

", - "smithy.api#xmlName": "launchTemplateName" - } - }, - "VersionNumber": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "aws.protocols#ec2QueryName": "VersionNumber", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The version number.

", - "smithy.api#xmlName": "versionNumber" - } - }, - "VersionDescription": { - "target": "com.amazonaws.ec2#VersionDescription", - "traits": { - "aws.protocols#ec2QueryName": "VersionDescription", - "smithy.api#documentation": "

The description for the version.

", - "smithy.api#xmlName": "versionDescription" - } - }, - "CreateTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "CreateTime", - "smithy.api#documentation": "

The time the version was created.

", - "smithy.api#xmlName": "createTime" - } - }, - "CreatedBy": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CreatedBy", - "smithy.api#documentation": "

The principal that created the version.

", - "smithy.api#xmlName": "createdBy" - } - }, - "DefaultVersion": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DefaultVersion", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the version is the default version.

", - "smithy.api#xmlName": "defaultVersion" - } - }, - "LaunchTemplateData": { - "target": "com.amazonaws.ec2#ResponseLaunchTemplateData", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateData", - "smithy.api#documentation": "

Information about the launch template.

", - "smithy.api#xmlName": "launchTemplateData" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a launch template version.

" - } - }, - "com.amazonaws.ec2#LaunchTemplateVersionSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#LaunchTemplateVersion", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#LaunchTemplatesMonitoring": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Enabled", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is\n enabled.

", - "smithy.api#xmlName": "enabled" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the monitoring for the instance.

" - } - }, - "com.amazonaws.ec2#LaunchTemplatesMonitoringRequest": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Specify true to enable detailed monitoring. Otherwise, basic monitoring\n is enabled.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the monitoring for the instance.

" - } - }, - "com.amazonaws.ec2#LicenseConfiguration": { - "type": "structure", - "members": { - "LicenseConfigurationArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LicenseConfigurationArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the license configuration.

", - "smithy.api#xmlName": "licenseConfigurationArn" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a license configuration.

" - } - }, - "com.amazonaws.ec2#LicenseConfigurationRequest": { - "type": "structure", - "members": { - "LicenseConfigurationArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the license configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a license configuration.

" - } - }, - "com.amazonaws.ec2#LicenseList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#LicenseConfiguration", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#LicenseSpecificationListRequest": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#LicenseConfigurationRequest", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ListImagesInRecycleBin": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ListImagesInRecycleBinRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ListImagesInRecycleBinResult" - }, - "traits": { - "smithy.api#documentation": "

Lists one or more AMIs that are currently in the Recycle Bin. For more information, \n see Recycle\n Bin in the Amazon EC2 User Guide.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Images", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#ListImagesInRecycleBinMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#ListImagesInRecycleBinRequest": { - "type": "structure", - "members": { - "ImageIds": { - "target": "com.amazonaws.ec2#ImageIdStringList", - "traits": { - "smithy.api#documentation": "

The IDs of the AMIs to list. Omit this parameter to list all of the AMIs that \n are in the Recycle Bin. You can specify up to 20 IDs in a single request.

", - "smithy.api#xmlName": "ImageId" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#ListImagesInRecycleBinMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ListImagesInRecycleBinResult": { - "type": "structure", - "members": { - "Images": { - "target": "com.amazonaws.ec2#ImageRecycleBinInfoList", - "traits": { - "aws.protocols#ec2QueryName": "ImageSet", - "smithy.api#documentation": "

Information about the AMIs.

", - "smithy.api#xmlName": "imageSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ListSnapshotsInRecycleBin": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ListSnapshotsInRecycleBinRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ListSnapshotsInRecycleBinResult" - }, - "traits": { - "smithy.api#documentation": "

Lists one or more snapshots that are currently in the Recycle Bin.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Snapshots", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#ListSnapshotsInRecycleBinMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 5, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#ListSnapshotsInRecycleBinRequest": { - "type": "structure", - "members": { - "MaxResults": { - "target": "com.amazonaws.ec2#ListSnapshotsInRecycleBinMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output. \n\tFor more information, see Pagination.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.

" - } - }, - "SnapshotIds": { - "target": "com.amazonaws.ec2#SnapshotIdStringList", - "traits": { - "smithy.api#documentation": "

The IDs of the snapshots to list. Omit this parameter to list all of the \n snapshots that are in the Recycle Bin.

", - "smithy.api#xmlName": "SnapshotId" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ListSnapshotsInRecycleBinResult": { - "type": "structure", - "members": { - "Snapshots": { - "target": "com.amazonaws.ec2#SnapshotRecycleBinInfoList", - "traits": { - "aws.protocols#ec2QueryName": "SnapshotSet", - "smithy.api#documentation": "

Information about the snapshots.

", - "smithy.api#xmlName": "snapshotSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n This value is null when there are no more items to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ListingState": { - "type": "enum", - "members": { - "available": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "available" - } - }, - "sold": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "sold" - } - }, - "cancelled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cancelled" - } - }, - "pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - } - } - }, - "com.amazonaws.ec2#ListingStatus": { - "type": "enum", - "members": { - "active": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "active" - } - }, - "pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "cancelled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cancelled" - } - }, - "closed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "closed" - } - } - } - }, - "com.amazonaws.ec2#LoadBalancerArn": { - "type": "string" - }, - "com.amazonaws.ec2#LoadBalancersConfig": { - "type": "structure", - "members": { - "ClassicLoadBalancersConfig": { - "target": "com.amazonaws.ec2#ClassicLoadBalancersConfig", - "traits": { - "aws.protocols#ec2QueryName": "ClassicLoadBalancersConfig", - "smithy.api#documentation": "

The Classic Load Balancers.

", - "smithy.api#xmlName": "classicLoadBalancersConfig" - } - }, - "TargetGroupsConfig": { - "target": "com.amazonaws.ec2#TargetGroupsConfig", - "traits": { - "aws.protocols#ec2QueryName": "TargetGroupsConfig", - "smithy.api#documentation": "

The target groups.

", - "smithy.api#xmlName": "targetGroupsConfig" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the Classic Load Balancers and target groups to attach to a Spot Fleet\n request.

" - } - }, - "com.amazonaws.ec2#LoadPermission": { - "type": "structure", - "members": { - "UserId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "UserId", - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#xmlName": "userId" - } - }, - "Group": { - "target": "com.amazonaws.ec2#PermissionGroup", - "traits": { - "aws.protocols#ec2QueryName": "Group", - "smithy.api#documentation": "

The name of the group.

", - "smithy.api#xmlName": "group" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a load permission.

" - } - }, - "com.amazonaws.ec2#LoadPermissionList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#LoadPermission", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#LoadPermissionListRequest": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#LoadPermissionRequest", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#LoadPermissionModifications": { - "type": "structure", - "members": { - "Add": { - "target": "com.amazonaws.ec2#LoadPermissionListRequest", - "traits": { - "smithy.api#documentation": "

The load permissions to add.

" - } - }, - "Remove": { - "target": "com.amazonaws.ec2#LoadPermissionListRequest", - "traits": { - "smithy.api#documentation": "

The load permissions to remove.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes modifications to the load permissions of an Amazon FPGA image (AFI).

" - } - }, - "com.amazonaws.ec2#LoadPermissionRequest": { - "type": "structure", - "members": { - "Group": { - "target": "com.amazonaws.ec2#PermissionGroup", - "traits": { - "smithy.api#documentation": "

The name of the group.

" - } - }, - "UserId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a load permission.

" - } - }, - "com.amazonaws.ec2#LocalGateway": { - "type": "structure", - "members": { - "LocalGatewayId": { - "target": "com.amazonaws.ec2#LocalGatewayId", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayId", - "smithy.api#documentation": "

The ID of the local gateway.

", - "smithy.api#xmlName": "localGatewayId" - } - }, - "OutpostArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OutpostArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

", - "smithy.api#xmlName": "outpostArn" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the local gateway.

", - "smithy.api#xmlName": "ownerId" - } - }, - "State": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the local gateway.

", - "smithy.api#xmlName": "state" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags assigned to the local gateway.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a local gateway.

" - } - }, - "com.amazonaws.ec2#LocalGatewayId": { - "type": "string" - }, - "com.amazonaws.ec2#LocalGatewayIdSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#LocalGatewayId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#LocalGatewayMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#LocalGatewayRoute": { - "type": "structure", - "members": { - "DestinationCidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DestinationCidrBlock", - "smithy.api#documentation": "

The CIDR block used for destination matches.

", - "smithy.api#xmlName": "destinationCidrBlock" - } - }, - "LocalGatewayVirtualInterfaceGroupId": { - "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupId", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayVirtualInterfaceGroupId", - "smithy.api#documentation": "

The ID of the virtual interface group.

", - "smithy.api#xmlName": "localGatewayVirtualInterfaceGroupId" - } - }, - "Type": { - "target": "com.amazonaws.ec2#LocalGatewayRouteType", - "traits": { - "aws.protocols#ec2QueryName": "Type", - "smithy.api#documentation": "

The route type.

", - "smithy.api#xmlName": "type" - } - }, - "State": { - "target": "com.amazonaws.ec2#LocalGatewayRouteState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the route.

", - "smithy.api#xmlName": "state" - } - }, - "LocalGatewayRouteTableId": { - "target": "com.amazonaws.ec2#LocalGatewayRoutetableId", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayRouteTableId", - "smithy.api#documentation": "

The ID of the local gateway route table.

", - "smithy.api#xmlName": "localGatewayRouteTableId" - } - }, - "LocalGatewayRouteTableArn": { - "target": "com.amazonaws.ec2#ResourceArn", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayRouteTableArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the local gateway route table.

", - "smithy.api#xmlName": "localGatewayRouteTableArn" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the local gateway route.

", - "smithy.api#xmlName": "ownerId" - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#SubnetId", - "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#documentation": "

The ID of the subnet.

", - "smithy.api#xmlName": "subnetId" - } - }, - "CoipPoolId": { - "target": "com.amazonaws.ec2#CoipPoolId", - "traits": { - "aws.protocols#ec2QueryName": "CoipPoolId", - "smithy.api#documentation": "

The ID of the customer-owned address pool.

", - "smithy.api#xmlName": "coipPoolId" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#NetworkInterfaceId", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "

The ID of the network interface.

", - "smithy.api#xmlName": "networkInterfaceId" - } - }, - "DestinationPrefixListId": { - "target": "com.amazonaws.ec2#PrefixListResourceId", - "traits": { - "aws.protocols#ec2QueryName": "DestinationPrefixListId", - "smithy.api#documentation": "

\n The ID of the prefix list.\n

", - "smithy.api#xmlName": "destinationPrefixListId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a route for a local gateway route table.

" - } - }, - "com.amazonaws.ec2#LocalGatewayRouteList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#LocalGatewayRoute", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#LocalGatewayRouteState": { - "type": "enum", - "members": { - "pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "active": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "active" - } - }, - "blackhole": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "blackhole" - } - }, - "deleting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleting" - } - }, - "deleted": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleted" - } - } - } - }, - "com.amazonaws.ec2#LocalGatewayRouteTable": { - "type": "structure", - "members": { - "LocalGatewayRouteTableId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayRouteTableId", - "smithy.api#documentation": "

The ID of the local gateway route table.

", - "smithy.api#xmlName": "localGatewayRouteTableId" - } - }, - "LocalGatewayRouteTableArn": { - "target": "com.amazonaws.ec2#ResourceArn", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayRouteTableArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the local gateway route table.

", - "smithy.api#xmlName": "localGatewayRouteTableArn" - } - }, - "LocalGatewayId": { - "target": "com.amazonaws.ec2#LocalGatewayId", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayId", - "smithy.api#documentation": "

The ID of the local gateway.

", - "smithy.api#xmlName": "localGatewayId" - } - }, - "OutpostArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OutpostArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

", - "smithy.api#xmlName": "outpostArn" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the local gateway route table.

", - "smithy.api#xmlName": "ownerId" - } - }, - "State": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the local gateway route table.

", - "smithy.api#xmlName": "state" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags assigned to the local gateway route table.

", - "smithy.api#xmlName": "tagSet" - } - }, - "Mode": { - "target": "com.amazonaws.ec2#LocalGatewayRouteTableMode", - "traits": { - "aws.protocols#ec2QueryName": "Mode", - "smithy.api#documentation": "

The mode of the local gateway route table.

", - "smithy.api#xmlName": "mode" - } - }, - "StateReason": { - "target": "com.amazonaws.ec2#StateReason", - "traits": { - "aws.protocols#ec2QueryName": "StateReason", - "smithy.api#documentation": "

Information about the state change.

", - "smithy.api#xmlName": "stateReason" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a local gateway route table.

" - } - }, - "com.amazonaws.ec2#LocalGatewayRouteTableIdSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#LocalGatewayRoutetableId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#LocalGatewayRouteTableMode": { - "type": "enum", - "members": { - "direct_vpc_routing": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "direct-vpc-routing" - } - }, - "coip": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "coip" - } - } - } - }, - "com.amazonaws.ec2#LocalGatewayRouteTableSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#LocalGatewayRouteTable", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociation": { - "type": "structure", - "members": { - "LocalGatewayRouteTableVirtualInterfaceGroupAssociationId": { - "target": "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociationId", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayRouteTableVirtualInterfaceGroupAssociationId", - "smithy.api#documentation": "

The ID of the association.

", - "smithy.api#xmlName": "localGatewayRouteTableVirtualInterfaceGroupAssociationId" - } - }, - "LocalGatewayVirtualInterfaceGroupId": { - "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupId", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayVirtualInterfaceGroupId", - "smithy.api#documentation": "

The ID of the virtual interface group.

", - "smithy.api#xmlName": "localGatewayVirtualInterfaceGroupId" - } - }, - "LocalGatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayId", - "smithy.api#documentation": "

The ID of the local gateway.

", - "smithy.api#xmlName": "localGatewayId" - } - }, - "LocalGatewayRouteTableId": { - "target": "com.amazonaws.ec2#LocalGatewayId", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayRouteTableId", - "smithy.api#documentation": "

The ID of the local gateway route table.

", - "smithy.api#xmlName": "localGatewayRouteTableId" - } - }, - "LocalGatewayRouteTableArn": { - "target": "com.amazonaws.ec2#ResourceArn", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayRouteTableArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the local gateway route table for the virtual interface group.

", - "smithy.api#xmlName": "localGatewayRouteTableArn" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the local gateway virtual interface group association.

", - "smithy.api#xmlName": "ownerId" - } - }, - "State": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the association.

", - "smithy.api#xmlName": "state" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags assigned to the association.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an association between a local gateway route table and a virtual interface group.

" - } - }, - "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociationId": { - "type": "string" - }, - "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociationIdSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociationId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociationSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociation", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociation": { - "type": "structure", - "members": { - "LocalGatewayRouteTableVpcAssociationId": { - "target": "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociationId", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayRouteTableVpcAssociationId", - "smithy.api#documentation": "

The ID of the association.

", - "smithy.api#xmlName": "localGatewayRouteTableVpcAssociationId" - } - }, - "LocalGatewayRouteTableId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayRouteTableId", - "smithy.api#documentation": "

The ID of the local gateway route table.

", - "smithy.api#xmlName": "localGatewayRouteTableId" - } - }, - "LocalGatewayRouteTableArn": { - "target": "com.amazonaws.ec2#ResourceArn", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayRouteTableArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the local gateway route table for the association.

", - "smithy.api#xmlName": "localGatewayRouteTableArn" - } - }, - "LocalGatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayId", - "smithy.api#documentation": "

The ID of the local gateway.

", - "smithy.api#xmlName": "localGatewayId" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#xmlName": "vpcId" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the local gateway route table for the association.

", - "smithy.api#xmlName": "ownerId" - } - }, - "State": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the association.

", - "smithy.api#xmlName": "state" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags assigned to the association.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an association between a local gateway route table and a VPC.

" - } - }, - "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociationId": { - "type": "string" - }, - "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociationIdSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociationId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociationSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociation", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#LocalGatewayRouteType": { - "type": "enum", - "members": { - "static": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "static" - } - }, - "propagated": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "propagated" - } - } - } - }, - "com.amazonaws.ec2#LocalGatewayRoutetableId": { - "type": "string" - }, - "com.amazonaws.ec2#LocalGatewaySet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#LocalGateway", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#LocalGatewayVirtualInterface": { - "type": "structure", - "members": { - "LocalGatewayVirtualInterfaceId": { - "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceId", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayVirtualInterfaceId", - "smithy.api#documentation": "

The ID of the virtual interface.

", - "smithy.api#xmlName": "localGatewayVirtualInterfaceId" - } - }, - "LocalGatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayId", - "smithy.api#documentation": "

The ID of the local gateway.

", - "smithy.api#xmlName": "localGatewayId" - } - }, - "Vlan": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Vlan", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The ID of the VLAN.

", - "smithy.api#xmlName": "vlan" - } - }, - "LocalAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LocalAddress", - "smithy.api#documentation": "

The local address.

", - "smithy.api#xmlName": "localAddress" - } - }, - "PeerAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PeerAddress", - "smithy.api#documentation": "

The peer address.

", - "smithy.api#xmlName": "peerAddress" - } - }, - "LocalBgpAsn": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "LocalBgpAsn", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.

", - "smithy.api#xmlName": "localBgpAsn" - } - }, - "PeerBgpAsn": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "PeerBgpAsn", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The peer BGP ASN.

", - "smithy.api#xmlName": "peerBgpAsn" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the local gateway virtual interface.

", - "smithy.api#xmlName": "ownerId" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags assigned to the virtual interface.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a local gateway virtual interface.

" - } - }, - "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroup": { - "type": "structure", - "members": { - "LocalGatewayVirtualInterfaceGroupId": { - "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupId", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayVirtualInterfaceGroupId", - "smithy.api#documentation": "

The ID of the virtual interface group.

", - "smithy.api#xmlName": "localGatewayVirtualInterfaceGroupId" - } - }, - "LocalGatewayVirtualInterfaceIds": { - "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceIdSet", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayVirtualInterfaceIdSet", - "smithy.api#documentation": "

The IDs of the virtual interfaces.

", - "smithy.api#xmlName": "localGatewayVirtualInterfaceIdSet" - } - }, - "LocalGatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayId", - "smithy.api#documentation": "

The ID of the local gateway.

", - "smithy.api#xmlName": "localGatewayId" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the local gateway virtual interface group.

", - "smithy.api#xmlName": "ownerId" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags assigned to the virtual interface group.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a local gateway virtual interface group.

" - } - }, - "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupId": { - "type": "string" - }, - "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupIdSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroup", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#LocalGatewayVirtualInterfaceId": { - "type": "string" - }, - "com.amazonaws.ec2#LocalGatewayVirtualInterfaceIdSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#LocalGatewayVirtualInterfaceSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#LocalGatewayVirtualInterface", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#LocalStorage": { - "type": "enum", - "members": { - "INCLUDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "included" - } - }, - "REQUIRED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "required" - } - }, - "EXCLUDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "excluded" - } - } - } - }, - "com.amazonaws.ec2#LocalStorageType": { - "type": "enum", - "members": { - "HDD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "hdd" - } - }, - "SSD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ssd" - } - } - } - }, - "com.amazonaws.ec2#LocalStorageTypeSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#LocalStorageType", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#Location": { - "type": "string" - }, - "com.amazonaws.ec2#LocationType": { - "type": "enum", - "members": { - "region": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "region" - } - }, - "availability_zone": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "availability-zone" - } - }, - "availability_zone_id": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "availability-zone-id" - } - } - } - }, - "com.amazonaws.ec2#LogDestinationType": { - "type": "enum", - "members": { - "cloud_watch_logs": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cloud-watch-logs" - } - }, - "s3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "s3" - } - }, - "kinesis_data_firehose": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "kinesis-data-firehose" - } - } - } - }, - "com.amazonaws.ec2#Long": { - "type": "long", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.ec2#MaintenanceDetails": { - "type": "structure", - "members": { - "PendingMaintenance": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PendingMaintenance", - "smithy.api#documentation": "

Verify existence of a pending maintenance.

", - "smithy.api#xmlName": "pendingMaintenance" - } - }, - "MaintenanceAutoAppliedAfter": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "MaintenanceAutoAppliedAfter", - "smithy.api#documentation": "

The timestamp after which Amazon Web Services will automatically apply maintenance.

", - "smithy.api#xmlName": "maintenanceAutoAppliedAfter" - } - }, - "LastMaintenanceApplied": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "LastMaintenanceApplied", - "smithy.api#documentation": "

Timestamp of last applied maintenance.

", - "smithy.api#xmlName": "lastMaintenanceApplied" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details for Site-to-Site VPN tunnel endpoint maintenance events.

" - } - }, - "com.amazonaws.ec2#ManagedPrefixList": { - "type": "structure", - "members": { - "PrefixListId": { - "target": "com.amazonaws.ec2#PrefixListResourceId", - "traits": { - "aws.protocols#ec2QueryName": "PrefixListId", - "smithy.api#documentation": "

The ID of the prefix list.

", - "smithy.api#xmlName": "prefixListId" - } - }, - "AddressFamily": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AddressFamily", - "smithy.api#documentation": "

The IP address version.

", - "smithy.api#xmlName": "addressFamily" - } - }, - "State": { - "target": "com.amazonaws.ec2#PrefixListState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The current state of the prefix list.

", - "smithy.api#xmlName": "state" - } - }, - "StateMessage": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StateMessage", - "smithy.api#documentation": "

The state message.

", - "smithy.api#xmlName": "stateMessage" - } - }, - "PrefixListArn": { - "target": "com.amazonaws.ec2#ResourceArn", - "traits": { - "aws.protocols#ec2QueryName": "PrefixListArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the prefix list.

", - "smithy.api#xmlName": "prefixListArn" - } - }, - "PrefixListName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrefixListName", - "smithy.api#documentation": "

The name of the prefix list.

", - "smithy.api#xmlName": "prefixListName" - } - }, - "MaxEntries": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "MaxEntries", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of entries for the prefix list.

", - "smithy.api#xmlName": "maxEntries" - } - }, - "Version": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "aws.protocols#ec2QueryName": "Version", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The version of the prefix list.

", - "smithy.api#xmlName": "version" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags for the prefix list.

", - "smithy.api#xmlName": "tagSet" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the owner of the prefix list.

", - "smithy.api#xmlName": "ownerId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a managed prefix list.

" - } - }, - "com.amazonaws.ec2#ManagedPrefixListSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ManagedPrefixList", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#MarketType": { - "type": "enum", - "members": { - "spot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "spot" - } - } - } - }, - "com.amazonaws.ec2#MaxIpv4AddrPerInterface": { - "type": "integer" - }, - "com.amazonaws.ec2#MaxIpv6AddrPerInterface": { - "type": "integer" - }, - "com.amazonaws.ec2#MaxNetworkInterfaces": { - "type": "integer" - }, - "com.amazonaws.ec2#MaxResults": { - "type": "integer" - }, - "com.amazonaws.ec2#MaxResultsParam": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.ec2#MaximumBandwidthInMbps": { - "type": "integer" - }, - "com.amazonaws.ec2#MaximumEfaInterfaces": { - "type": "integer" - }, - "com.amazonaws.ec2#MaximumIops": { - "type": "integer" - }, - "com.amazonaws.ec2#MaximumNetworkCards": { - "type": "integer" - }, - "com.amazonaws.ec2#MaximumThroughputInMBps": { - "type": "double" - }, - "com.amazonaws.ec2#MembershipType": { - "type": "enum", - "members": { - "static": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "static" - } - }, - "igmp": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "igmp" - } - } - } - }, - "com.amazonaws.ec2#MemoryGiBPerVCpu": { - "type": "structure", - "members": { - "Min": { - "target": "com.amazonaws.ec2#Double", - "traits": { - "aws.protocols#ec2QueryName": "Min", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is\n no minimum limit.

", - "smithy.api#xmlName": "min" - } - }, - "Max": { - "target": "com.amazonaws.ec2#Double", - "traits": { - "aws.protocols#ec2QueryName": "Max", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is\n no maximum limit.

", - "smithy.api#xmlName": "max" - } - } - }, - "traits": { - "smithy.api#documentation": "

The minimum and maximum amount of memory per vCPU, in GiB.

\n

" - } - }, - "com.amazonaws.ec2#MemoryGiBPerVCpuRequest": { - "type": "structure", - "members": { - "Min": { - "target": "com.amazonaws.ec2#Double", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this\n parameter.

" - } - }, - "Max": { - "target": "com.amazonaws.ec2#Double", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this\n parameter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The minimum and maximum amount of memory per vCPU, in GiB.

" - } - }, - "com.amazonaws.ec2#MemoryInfo": { - "type": "structure", - "members": { - "SizeInMiB": { - "target": "com.amazonaws.ec2#MemorySize", - "traits": { - "aws.protocols#ec2QueryName": "SizeInMiB", - "smithy.api#documentation": "

The size of the memory, in MiB.

", - "smithy.api#xmlName": "sizeInMiB" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the memory for the instance type.

" - } - }, - "com.amazonaws.ec2#MemoryMiB": { - "type": "structure", - "members": { - "Min": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Min", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum\n limit.

", - "smithy.api#xmlName": "min" - } - }, - "Max": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Max", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum amount of memory, in MiB. If this parameter is not specified, there is no\n maximum limit.

", - "smithy.api#xmlName": "max" - } - } - }, - "traits": { - "smithy.api#documentation": "

The minimum and maximum amount of memory, in MiB.

" - } - }, - "com.amazonaws.ec2#MemoryMiBRequest": { - "type": "structure", - "members": { - "Min": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum amount of memory, in MiB. To specify no minimum limit, specify\n 0.

", - "smithy.api#required": {} - } - }, - "Max": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum amount of memory, in MiB. To specify no maximum limit, omit this\n parameter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The minimum and maximum amount of memory, in MiB.

" - } - }, - "com.amazonaws.ec2#MemorySize": { - "type": "long" - }, - "com.amazonaws.ec2#MetricPoint": { - "type": "structure", - "members": { - "StartDate": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "StartDate", - "smithy.api#documentation": "

The start date for the metric point. The starting date for the metric point. The starting time must be formatted\n as yyyy-mm-ddThh:mm:ss. For example, 2022-06-10T12:00:00.000Z.

", - "smithy.api#xmlName": "startDate" - } - }, - "EndDate": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "EndDate", - "smithy.api#documentation": "

The end date for the metric point. The ending time must be formatted as yyyy-mm-ddThh:mm:ss. For example, 2022-06-12T12:00:00.000Z.

", - "smithy.api#xmlName": "endDate" - } - }, - "Value": { - "target": "com.amazonaws.ec2#Float", - "traits": { - "aws.protocols#ec2QueryName": "Value", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#xmlName": "value" - } - }, - "Status": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The status of the metric point.

", - "smithy.api#xmlName": "status" - } - } - }, - "traits": { - "smithy.api#documentation": "

Indicates whether the network was healthy or degraded at a particular point. The value is aggregated from the startDate to the endDate. Currently only five_minutes is supported.

" - } - }, - "com.amazonaws.ec2#MetricPoints": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#MetricPoint", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#MetricType": { - "type": "enum", - "members": { - "aggregate_latency": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "aggregate-latency" - } - } - } - }, - "com.amazonaws.ec2#MillisecondDateTime": { - "type": "timestamp" - }, - "com.amazonaws.ec2#ModifyAddressAttribute": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyAddressAttributeRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyAddressAttributeResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies an attribute of the specified Elastic IP address. For requirements, see Using reverse DNS for email applications.

" - } - }, - "com.amazonaws.ec2#ModifyAddressAttributeRequest": { - "type": "structure", - "members": { - "AllocationId": { - "target": "com.amazonaws.ec2#AllocationId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

[EC2-VPC] The allocation ID.

", - "smithy.api#required": {} - } - }, - "DomainName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The domain name to modify for the IP address.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyAddressAttributeResult": { - "type": "structure", - "members": { - "Address": { - "target": "com.amazonaws.ec2#AddressAttribute", - "traits": { - "aws.protocols#ec2QueryName": "Address", - "smithy.api#documentation": "

Information about the Elastic IP address.

", - "smithy.api#xmlName": "address" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyAvailabilityZoneGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyAvailabilityZoneGroupRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyAvailabilityZoneGroupResult" - }, - "traits": { - "smithy.api#documentation": "

Changes the opt-in status of the Local Zone and Wavelength Zone group for your\n account.

\n

Use \n \t\tDescribeAvailabilityZones to view the value for GroupName.

" - } - }, - "com.amazonaws.ec2#ModifyAvailabilityZoneGroupRequest": { - "type": "structure", - "members": { - "GroupName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Availability Zone group, Local Zone group, or Wavelength Zone\n group.

", - "smithy.api#required": {} - } - }, - "OptInStatus": { - "target": "com.amazonaws.ec2#ModifyAvailabilityZoneOptInStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Indicates whether you are opted in to the Local Zone group or Wavelength Zone group. The\n only valid value is opted-in. You must contact Amazon Web Services Support to opt out of a Local Zone or Wavelength Zone group.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyAvailabilityZoneGroupResult": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Is true if the request succeeds, and an error otherwise.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyAvailabilityZoneOptInStatus": { - "type": "enum", - "members": { - "opted_in": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "opted-in" - } - }, - "not_opted_in": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "not-opted-in" - } - } - } - }, - "com.amazonaws.ec2#ModifyCapacityReservation": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyCapacityReservationRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyCapacityReservationResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies a Capacity Reservation's capacity and the conditions under which it is to be released. You\n\t\t\tcannot change a Capacity Reservation's instance type, EBS optimization, instance store settings,\n\t\t\tplatform, Availability Zone, or instance eligibility. If you need to modify any of these\n\t\t\tattributes, we recommend that you cancel the Capacity Reservation, and then create a new one with\n\t\t\tthe required attributes.

" - } - }, - "com.amazonaws.ec2#ModifyCapacityReservationFleet": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyCapacityReservationFleetRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyCapacityReservationFleetResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies a Capacity Reservation Fleet.

\n

When you modify the total target capacity of a Capacity Reservation Fleet, the Fleet automatically \n\t\t\tcreates new Capacity Reservations, or modifies or cancels existing Capacity Reservations in the Fleet \n\t\t\tto meet the new total target capacity. When you modify the end date for the Fleet, the end dates for \n\t\t\tall of the individual Capacity Reservations in the Fleet are updated accordingly.

" - } - }, - "com.amazonaws.ec2#ModifyCapacityReservationFleetRequest": { - "type": "structure", - "members": { - "CapacityReservationFleetId": { - "target": "com.amazonaws.ec2#CapacityReservationFleetId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Capacity Reservation Fleet to modify.

", - "smithy.api#required": {} - } - }, - "TotalTargetCapacity": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The total number of capacity units to be reserved by the Capacity Reservation Fleet. This value, \n\t\t\ttogether with the instance type weights that you assign to each instance type used by the Fleet \n\t\t\tdetermine the number of instances for which the Fleet reserves capacity. Both values are based on \n\t\t\tunits that make sense for your workload. For more information, see Total target capacity \n\t\t\tin the Amazon EC2 User Guide.

" - } - }, - "EndDate": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "smithy.api#documentation": "

The date and time at which the Capacity Reservation Fleet expires. When the Capacity Reservation \n\t\t\tFleet expires, its state changes to expired and all of the Capacity Reservations in the \n\t\t\tFleet expire.

\n

The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you \n\t\t\tspecify 5/31/2019, 13:30:55, the Capacity Reservation Fleet is guaranteed \n\t\t\tto expire between 13:30:55 and 14:30:55 on 5/31/2019.

\n

You can't specify EndDate and \n\t\t\tRemoveEndDate in the same request.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - }, - "RemoveEndDate": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to remove the end date from the Capacity Reservation Fleet. If you remove the \n\t\t\tend date, the Capacity Reservation Fleet does not expire and it remains active until you explicitly \n\t\t\tcancel it using the CancelCapacityReservationFleet action.

\n

You can't specify RemoveEndDate and \n\t\t\tEndDate in the same request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyCapacityReservationFleetResult": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyCapacityReservationRequest": { - "type": "structure", - "members": { - "CapacityReservationId": { - "target": "com.amazonaws.ec2#CapacityReservationId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Capacity Reservation.

", - "smithy.api#required": {} - } - }, - "InstanceCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of instances for which to reserve capacity. The number of instances can't be increased or \n\t\t \tdecreased by more than 1000 in a single request.

" - } - }, - "EndDate": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "smithy.api#documentation": "

The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity\n\t\t\tis released and you can no longer launch instances into it. The Capacity Reservation's state changes to\n\t\t\t\texpired when it reaches its end date and time.

\n

The Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify \n\t\t\t5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.

\n

You must provide an EndDate value if EndDateType is\n\t\t\t\tlimited. Omit EndDate if EndDateType is\n\t\t\t\tunlimited.

" - } - }, - "EndDateType": { - "target": "com.amazonaws.ec2#EndDateType", - "traits": { - "smithy.api#documentation": "

Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end\n\t\t\ttypes:

\n " - } - }, - "Accept": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Reserved. Capacity Reservations you have created are accepted by default.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - }, - "AdditionalInfo": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Reserved for future use.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyCapacityReservationResult": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyClientVpnEndpoint": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyClientVpnEndpointRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyClientVpnEndpointResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies the specified Client VPN endpoint. Modifying the DNS server resets existing client connections.

" - } - }, - "com.amazonaws.ec2#ModifyClientVpnEndpointRequest": { - "type": "structure", - "members": { - "ClientVpnEndpointId": { - "target": "com.amazonaws.ec2#ClientVpnEndpointId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Client VPN endpoint to modify.

", - "smithy.api#required": {} - } - }, - "ServerCertificateArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The ARN of the server certificate to be used. The server certificate must be provisioned in \n\t\t\tCertificate Manager (ACM).

" - } - }, - "ConnectionLogOptions": { - "target": "com.amazonaws.ec2#ConnectionLogOptions", - "traits": { - "smithy.api#documentation": "

Information about the client connection logging options.

\n

If you enable client connection logging, data about client connections is sent to a\n\t\t\tCloudwatch Logs log stream. The following information is logged:

\n " - } - }, - "DnsServers": { - "target": "com.amazonaws.ec2#DnsServersOptionsModifyStructure", - "traits": { - "smithy.api#documentation": "

Information about the DNS servers to be used by Client VPN connections. A Client VPN endpoint can have \n\t\t\tup to two DNS servers.

" - } - }, - "VpnPort": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

\n

Valid Values: 443 | 1194\n

\n

Default Value: 443\n

" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A brief description of the Client VPN endpoint.

" - } - }, - "SplitTunnel": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the VPN is split-tunnel.

\n

For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the \n \tClient VPN Administrator Guide.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.ec2#ClientVpnSecurityGroupIdSet", - "traits": { - "smithy.api#documentation": "

The IDs of one or more security groups to apply to the target network.

", - "smithy.api#xmlName": "SecurityGroupId" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", - "traits": { - "smithy.api#documentation": "

The ID of the VPC to associate with the Client VPN endpoint.

" - } - }, - "SelfServicePortal": { - "target": "com.amazonaws.ec2#SelfServicePortal", - "traits": { - "smithy.api#documentation": "

Specify whether to enable the self-service portal for the Client VPN endpoint.

" - } - }, - "ClientConnectOptions": { - "target": "com.amazonaws.ec2#ClientConnectOptions", - "traits": { - "smithy.api#documentation": "

The options for managing connection authorization for new client connections.

" - } - }, - "SessionTimeoutHours": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum VPN session duration time in hours.

\n

Valid values: 8 | 10 | 12 | 24\n

\n

Default value: 24\n

" - } - }, - "ClientLoginBannerOptions": { - "target": "com.amazonaws.ec2#ClientLoginBannerOptions", - "traits": { - "smithy.api#documentation": "

Options for enabling a customizable text banner that will be displayed on\n\t\t\tAmazon Web Services provided clients when a VPN session is established.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyClientVpnEndpointResult": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyDefaultCreditSpecification": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyDefaultCreditSpecificationRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyDefaultCreditSpecificationResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies the default credit option for CPU usage of burstable performance instances.\n The default credit option is set at the account level per Amazon Web Services Region, and\n is specified per instance family. All new burstable performance instances in the account\n launch using the default credit option.

\n

\n ModifyDefaultCreditSpecification is an asynchronous operation, which\n works at an Amazon Web Services Region level and modifies the credit option for each\n Availability Zone. All zones in a Region are updated within five minutes. But if\n instances are launched during this operation, they might not get the new credit option\n until the zone is updated. To verify whether the update has occurred, you can call\n GetDefaultCreditSpecification and check\n DefaultCreditSpecification for updates.

\n

For more information, see Burstable\n performance instances in the Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#ModifyDefaultCreditSpecificationRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "InstanceFamily": { - "target": "com.amazonaws.ec2#UnlimitedSupportedInstanceFamily", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The instance family.

", - "smithy.api#required": {} - } - }, - "CpuCredits": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The credit option for CPU usage of the instance family.

\n

Valid Values: standard | unlimited\n

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyDefaultCreditSpecificationResult": { - "type": "structure", - "members": { - "InstanceFamilyCreditSpecification": { - "target": "com.amazonaws.ec2#InstanceFamilyCreditSpecification", - "traits": { - "aws.protocols#ec2QueryName": "InstanceFamilyCreditSpecification", - "smithy.api#documentation": "

The default credit option for CPU usage of the instance family.

", - "smithy.api#xmlName": "instanceFamilyCreditSpecification" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyEbsDefaultKmsKeyId": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyEbsDefaultKmsKeyIdRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyEbsDefaultKmsKeyIdResult" - }, - "traits": { - "smithy.api#documentation": "

Changes the default KMS key for EBS encryption by default for your account in this Region.

\n

Amazon Web Services creates a unique Amazon Web Services managed KMS key in each Region for use with encryption by default. If\n you change the default KMS key to a symmetric customer managed KMS key, it is used instead of the Amazon Web Services\n managed KMS key. To reset the default KMS key to the Amazon Web Services managed KMS key for EBS, use ResetEbsDefaultKmsKeyId. Amazon EBS does not support asymmetric KMS keys.

\n

If you delete or disable the customer managed KMS key that you specified for use with\n encryption by default, your instances will fail to launch.

\n

For more information, see Amazon EBS encryption\n in the Amazon Elastic Compute Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#ModifyEbsDefaultKmsKeyIdRequest": { - "type": "structure", - "members": { - "KmsKeyId": { - "target": "com.amazonaws.ec2#KmsKeyId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption.\n If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is\n specified, the encrypted state must be true.

\n

You can specify the KMS key using any of the following:

\n \n

Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, \n the action can appear to complete, but eventually fails.

\n

Amazon EBS does not support asymmetric KMS keys.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyEbsDefaultKmsKeyIdResult": { - "type": "structure", - "members": { - "KmsKeyId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "KmsKeyId", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the default KMS key for encryption by default.

", - "smithy.api#xmlName": "kmsKeyId" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyFleet": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyFleetRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyFleetResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies the specified EC2 Fleet.

\n

You can only modify an EC2 Fleet request of type maintain.

\n

While the EC2 Fleet is being modified, it is in the modifying state.

\n

To scale up your EC2 Fleet, increase its target capacity. The EC2 Fleet launches the additional\n Spot Instances according to the allocation strategy for the EC2 Fleet request. If the allocation\n strategy is lowest-price, the EC2 Fleet launches instances using the Spot Instance\n pool with the lowest price. If the allocation strategy is diversified, the\n EC2 Fleet distributes the instances across the Spot Instance pools. If the allocation strategy\n is capacity-optimized, EC2 Fleet launches instances from Spot Instance pools with optimal\n capacity for the number of instances that are launching.

\n

To scale down your EC2 Fleet, decrease its target capacity. First, the EC2 Fleet cancels any open\n requests that exceed the new target capacity. You can request that the EC2 Fleet terminate Spot\n Instances until the size of the fleet no longer exceeds the new target capacity. If the\n allocation strategy is lowest-price, the EC2 Fleet terminates the instances with\n the highest price per unit. If the allocation strategy is capacity-optimized,\n the EC2 Fleet terminates the instances in the Spot Instance pools that have the least available\n Spot Instance capacity. If the allocation strategy is diversified, the EC2 Fleet terminates\n instances across the Spot Instance pools. Alternatively, you can request that the EC2 Fleet keep\n the fleet at its current size, but not replace any Spot Instances that are interrupted or\n that you terminate manually.

\n

If you are finished with your EC2 Fleet for now, but will use it again later, you can set the\n target capacity to 0.

" - } - }, - "com.amazonaws.ec2#ModifyFleetRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "ExcessCapacityTerminationPolicy": { - "target": "com.amazonaws.ec2#FleetExcessCapacityTerminationPolicy", - "traits": { - "smithy.api#documentation": "

Indicates whether running instances should be terminated if the total target capacity of\n the EC2 Fleet is decreased below the current size of the EC2 Fleet.

\n

Supported only for fleets of type maintain.

" - } - }, - "LaunchTemplateConfigs": { - "target": "com.amazonaws.ec2#FleetLaunchTemplateConfigListRequest", - "traits": { - "smithy.api#documentation": "

The launch template and overrides.

", - "smithy.api#xmlName": "LaunchTemplateConfig" - } - }, - "FleetId": { - "target": "com.amazonaws.ec2#FleetId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the EC2 Fleet.

", - "smithy.api#required": {} - } - }, - "TargetCapacitySpecification": { - "target": "com.amazonaws.ec2#TargetCapacitySpecificationRequest", - "traits": { - "smithy.api#documentation": "

The size of the EC2 Fleet.

" - } - }, - "Context": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Reserved.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyFleetResult": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

If the request succeeds, the response returns true. If the request fails,\n no response is returned, and instead an error message is returned.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyFpgaImageAttribute": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyFpgaImageAttributeRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyFpgaImageAttributeResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies the specified attribute of the specified Amazon FPGA Image (AFI).

" - } - }, - "com.amazonaws.ec2#ModifyFpgaImageAttributeRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "FpgaImageId": { - "target": "com.amazonaws.ec2#FpgaImageId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the AFI.

", - "smithy.api#required": {} - } - }, - "Attribute": { - "target": "com.amazonaws.ec2#FpgaImageAttributeName", - "traits": { - "smithy.api#documentation": "

The name of the attribute.

" - } - }, - "OperationType": { - "target": "com.amazonaws.ec2#OperationType", - "traits": { - "smithy.api#documentation": "

The operation type.

" - } - }, - "UserIds": { - "target": "com.amazonaws.ec2#UserIdStringList", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account IDs. This parameter is valid only when modifying the loadPermission attribute.

", - "smithy.api#xmlName": "UserId" - } - }, - "UserGroups": { - "target": "com.amazonaws.ec2#UserGroupStringList", - "traits": { - "smithy.api#documentation": "

The user groups. This parameter is valid only when modifying the loadPermission attribute.

", - "smithy.api#xmlName": "UserGroup" - } - }, - "ProductCodes": { - "target": "com.amazonaws.ec2#ProductCodeStringList", - "traits": { - "smithy.api#documentation": "

The product codes. After you add a product code to an AFI, it can't be removed.\n\t\t This parameter is valid only when modifying the productCodes attribute.

", - "smithy.api#xmlName": "ProductCode" - } - }, - "LoadPermission": { - "target": "com.amazonaws.ec2#LoadPermissionModifications", - "traits": { - "smithy.api#documentation": "

The load permission for the AFI.

" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A description for the AFI.

" - } - }, - "Name": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A name for the AFI.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyFpgaImageAttributeResult": { - "type": "structure", - "members": { - "FpgaImageAttribute": { - "target": "com.amazonaws.ec2#FpgaImageAttribute", - "traits": { - "aws.protocols#ec2QueryName": "FpgaImageAttribute", - "smithy.api#documentation": "

Information about the attribute.

", - "smithy.api#xmlName": "fpgaImageAttribute" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyHosts": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyHostsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyHostsResult" - }, - "traits": { - "smithy.api#documentation": "

Modify the auto-placement setting of a Dedicated Host. When auto-placement is enabled,\n any instances that you launch with a tenancy of host but without a specific\n host ID are placed onto any available Dedicated Host in your account that has\n auto-placement enabled. When auto-placement is disabled, you need to provide a host ID\n to have the instance launch onto a specific host. If no host ID is provided, the\n instance is launched onto a suitable host with auto-placement enabled.

\n

You can also use this API action to modify a Dedicated Host to support either multiple\n instance types in an instance family, or to support a specific instance type\n only.

" - } - }, - "com.amazonaws.ec2#ModifyHostsRequest": { - "type": "structure", - "members": { - "AutoPlacement": { - "target": "com.amazonaws.ec2#AutoPlacement", - "traits": { - "aws.protocols#ec2QueryName": "AutoPlacement", - "smithy.api#documentation": "

Specify whether to enable or disable auto-placement.

", - "smithy.api#xmlName": "autoPlacement" - } - }, - "HostIds": { - "target": "com.amazonaws.ec2#RequestHostIdList", - "traits": { - "aws.protocols#ec2QueryName": "HostId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IDs of the Dedicated Hosts to modify.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "hostId" - } - }, - "HostRecovery": { - "target": "com.amazonaws.ec2#HostRecovery", - "traits": { - "smithy.api#documentation": "

Indicates whether to enable or disable host recovery for the Dedicated Host. For more\n information, see Host recovery\n in the Amazon EC2 User Guide.

" - } - }, - "InstanceType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Specifies the instance type to be supported by the Dedicated Host. Specify this\n parameter to modify a Dedicated Host to support only a specific instance type.

\n

If you want to modify a Dedicated Host to support multiple instance types in its\n current instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the\n same request.

" - } - }, - "InstanceFamily": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Specifies the instance family to be supported by the Dedicated Host. Specify this\n parameter to modify a Dedicated Host to support multiple instance types within its\n current instance family.

\n

If you want to modify a Dedicated Host to support a specific instance type only, omit\n this parameter and specify InstanceType instead. You\n cannot specify InstanceFamily and InstanceType in the same request.

" - } - }, - "HostMaintenance": { - "target": "com.amazonaws.ec2#HostMaintenance", - "traits": { - "smithy.api#documentation": "

Indicates whether to enable or disable host maintenance for the Dedicated Host. For\n more information, see Host\n maintenance in the Amazon EC2 User Guide.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyHostsResult": { - "type": "structure", - "members": { - "Successful": { - "target": "com.amazonaws.ec2#ResponseHostIdList", - "traits": { - "aws.protocols#ec2QueryName": "Successful", - "smithy.api#documentation": "

The IDs of the Dedicated Hosts that were successfully modified.

", - "smithy.api#xmlName": "successful" - } - }, - "Unsuccessful": { - "target": "com.amazonaws.ec2#UnsuccessfulItemList", - "traits": { - "aws.protocols#ec2QueryName": "Unsuccessful", - "smithy.api#documentation": "

The IDs of the Dedicated Hosts that could not be modified. Check whether the setting\n you requested can be used.

", - "smithy.api#xmlName": "unsuccessful" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyIdFormat": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyIdFormatRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Modifies the ID format for the specified resource on a per-Region basis. You can\n specify that resources should receive longer IDs (17-character IDs) when they are\n created.

\n

This request can only be used to modify longer ID settings for resource types that\n are within the opt-in period. Resources currently in their opt-in period include:\n bundle | conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | internet-gateway | network-acl\n | network-acl-association | network-interface |\n network-interface-attachment | prefix-list |\n route-table | route-table-association |\n security-group | subnet |\n subnet-cidr-block-association | vpc |\n vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

\n

This setting applies to the IAM user who makes the request; it does not apply to the\n entire Amazon Web Services account. By default, an IAM user defaults to the same settings as the root user. If\n you're using this action as the root user, then these settings apply to the entire account,\n unless an IAM user explicitly overrides these settings for themselves. For more information,\n see Resource IDs \n in the Amazon Elastic Compute Cloud User Guide.

\n

Resources created with longer IDs are visible to all IAM roles and users, regardless\n of these settings and provided that they have permission to use the relevant\n Describe command for the resource type.

" - } - }, - "com.amazonaws.ec2#ModifyIdFormatRequest": { - "type": "structure", - "members": { - "Resource": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The type of resource: bundle | conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | internet-gateway | network-acl\n | network-acl-association | network-interface |\n network-interface-attachment | prefix-list |\n route-table | route-table-association |\n security-group | subnet |\n subnet-cidr-block-association | vpc |\n vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

\n

Alternatively, use the all-current option to include all resource types that are\n currently within their opt-in period for longer IDs.

", - "smithy.api#required": {} - } - }, - "UseLongIds": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicate whether the resource should use longer IDs (17-character IDs).

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyIdentityIdFormat": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyIdentityIdFormatRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Modifies the ID format of a resource for a specified IAM user, IAM role, or the root\n user for an account; or all IAM users, IAM roles, and the root user for an account. You can\n specify that resources should receive longer IDs (17-character IDs) when they are created.

\n

This request can only be used to modify longer ID settings for resource types that are\n within the opt-in period. Resources currently in their opt-in period include:\n bundle | conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | internet-gateway | network-acl\n | network-acl-association | network-interface |\n network-interface-attachment | prefix-list |\n route-table | route-table-association |\n security-group | subnet |\n subnet-cidr-block-association | vpc |\n vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

\n

For more information, see Resource IDs in the\n Amazon Elastic Compute Cloud User Guide.

\n

This setting applies to the principal specified in the request; it does not apply to the\n principal that makes the request.

\n

Resources created with longer IDs are visible to all IAM roles and users, regardless of these\n settings and provided that they have permission to use the relevant Describe\n command for the resource type.

" - } - }, - "com.amazonaws.ec2#ModifyIdentityIdFormatRequest": { - "type": "structure", - "members": { - "PrincipalArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrincipalArn", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specify\n all to modify the ID format for all IAM users, IAM roles, and the root user of\n the account.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "principalArn" - } - }, - "Resource": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Resource", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The type of resource: bundle | conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | internet-gateway | network-acl\n | network-acl-association | network-interface |\n network-interface-attachment | prefix-list |\n route-table | route-table-association |\n security-group | subnet |\n subnet-cidr-block-association | vpc |\n vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

\n

Alternatively, use the all-current option to include all resource types that are\n currently within their opt-in period for longer IDs.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "resource" - } - }, - "UseLongIds": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "UseLongIds", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the resource should use longer IDs (17-character IDs)

", - "smithy.api#required": {}, - "smithy.api#xmlName": "useLongIds" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyImageAttribute": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyImageAttributeRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.

\n

To specify the attribute, you can use the Attribute parameter, or one of the following parameters: \n Description, ImdsSupport, or LaunchPermission.

\n

Images with an Amazon Web Services Marketplace product code cannot be made public.

\n

To enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance \n and create an AMI from the instance.

" - } - }, - "com.amazonaws.ec2#ModifyImageAttributeRequest": { - "type": "structure", - "members": { - "Attribute": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The name of the attribute to modify.

\n

Valid values: description | imdsSupport | launchPermission\n

" - } - }, - "Description": { - "target": "com.amazonaws.ec2#AttributeValue", - "traits": { - "smithy.api#documentation": "

A new description for the AMI.

" - } - }, - "ImageId": { - "target": "com.amazonaws.ec2#ImageId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the AMI.

", - "smithy.api#required": {} - } - }, - "LaunchPermission": { - "target": "com.amazonaws.ec2#LaunchPermissionModifications", - "traits": { - "smithy.api#documentation": "

A new launch permission for the AMI.

" - } - }, - "OperationType": { - "target": "com.amazonaws.ec2#OperationType", - "traits": { - "smithy.api#documentation": "

The operation type. \n This parameter can be used only when the Attribute parameter is launchPermission.

" - } - }, - "ProductCodes": { - "target": "com.amazonaws.ec2#ProductCodeStringList", - "traits": { - "smithy.api#documentation": "

Not supported.

", - "smithy.api#xmlName": "ProductCode" - } - }, - "UserGroups": { - "target": "com.amazonaws.ec2#UserGroupStringList", - "traits": { - "smithy.api#documentation": "

The user groups. \n This parameter can be used only when the Attribute parameter is launchPermission.

", - "smithy.api#xmlName": "UserGroup" - } - }, - "UserIds": { - "target": "com.amazonaws.ec2#UserIdStringList", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account IDs. \n This parameter can be used only when the Attribute parameter is launchPermission.

", - "smithy.api#xmlName": "UserId" - } - }, - "Value": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The value of the attribute being modified. \n This parameter can be used only when the Attribute parameter is description or imdsSupport.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "OrganizationArns": { - "target": "com.amazonaws.ec2#OrganizationArnStringList", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an organization. This parameter can be used only when the Attribute parameter is launchPermission.

", - "smithy.api#xmlName": "OrganizationArn" - } - }, - "OrganizationalUnitArns": { - "target": "com.amazonaws.ec2#OrganizationalUnitArnStringList", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an organizational unit (OU). This parameter can be used only when the Attribute parameter is launchPermission.

", - "smithy.api#xmlName": "OrganizationalUnitArn" - } - }, - "ImdsSupport": { - "target": "com.amazonaws.ec2#AttributeValue", - "traits": { - "smithy.api#documentation": "

Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances\n launched from this AMI will have HttpTokens automatically set to\n required so that, by default, the instance requires that IMDSv2 is used when\n requesting instance metadata. In addition, HttpPutResponseHopLimit is set to\n 2. For more information, see Configure\n the AMI in the Amazon EC2 User Guide.

\n \n

Do not use this parameter unless your AMI software supports IMDSv2. After you set the value to v2.0, \n you can't undo it. The only way to “reset” your AMI is to create a new AMI from the underlying snapshot.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for ModifyImageAttribute.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyInstanceAttribute": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyInstanceAttributeRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Modifies the specified attribute of the specified instance. You can specify only one\n attribute at a time.

\n

\n Note: Using this action to change the security groups\n associated with an elastic network interface (ENI) attached to an instance can\n result in an error if the instance has more than one ENI. To change the security groups\n associated with an ENI attached to an instance that has multiple ENIs, we recommend that\n you use the ModifyNetworkInterfaceAttribute action.

\n

To modify some attributes, the instance must be stopped. For more information, see\n Modify a stopped instance in the\n Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#ModifyInstanceAttributeRequest": { - "type": "structure", - "members": { - "SourceDestCheck": { - "target": "com.amazonaws.ec2#AttributeBooleanValue", - "traits": { - "smithy.api#documentation": "

Enable or disable source/destination checks, which ensure that the instance is either\n the source or the destination of any traffic that it receives. If the value is\n true, source/destination checks are enabled; otherwise, they are\n disabled. The default value is true. You must disable source/destination\n checks if the instance runs services such as network address translation, routing, or\n firewalls.

" - } - }, - "Attribute": { - "target": "com.amazonaws.ec2#InstanceAttributeName", - "traits": { - "aws.protocols#ec2QueryName": "Attribute", - "smithy.api#documentation": "

The name of the attribute to modify.

\n \n

You can modify the following attributes only: disableApiTermination |\n instanceType | kernel | ramdisk |\n instanceInitiatedShutdownBehavior | blockDeviceMapping\n | userData | sourceDestCheck | groupSet |\n ebsOptimized | sriovNetSupport |\n enaSupport | nvmeSupport | disableApiStop\n | enclaveOptions\n

\n ", - "smithy.api#xmlName": "attribute" - } - }, - "BlockDeviceMappings": { - "target": "com.amazonaws.ec2#InstanceBlockDeviceMappingSpecificationList", - "traits": { - "aws.protocols#ec2QueryName": "BlockDeviceMapping", - "smithy.api#documentation": "

Modifies the DeleteOnTermination attribute for volumes that are currently\n attached. The volume must be owned by the caller. If no value is specified for\n DeleteOnTermination, the default is true and the volume is\n deleted when the instance is terminated.

\n

To add instance store volumes to an Amazon EBS-backed instance, you must add them when\n you launch the instance. For more information, see Update the block device mapping when launching an instance in the\n Amazon EC2 User Guide.

", - "smithy.api#xmlName": "blockDeviceMapping" - } - }, - "DisableApiTermination": { - "target": "com.amazonaws.ec2#AttributeBooleanValue", - "traits": { - "aws.protocols#ec2QueryName": "DisableApiTermination", - "smithy.api#documentation": "

If the value is true, you can't terminate the instance using the Amazon\n EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot\n Instances.

", - "smithy.api#xmlName": "disableApiTermination" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "EbsOptimized": { - "target": "com.amazonaws.ec2#AttributeBooleanValue", - "traits": { - "aws.protocols#ec2QueryName": "EbsOptimized", - "smithy.api#documentation": "

Specifies whether the instance is optimized for Amazon EBS I/O. This optimization\n provides dedicated throughput to Amazon EBS and an optimized configuration stack to\n provide optimal EBS I/O performance. This optimization isn't available with all instance\n types. Additional usage charges apply when using an EBS Optimized instance.

", - "smithy.api#xmlName": "ebsOptimized" - } - }, - "EnaSupport": { - "target": "com.amazonaws.ec2#AttributeBooleanValue", - "traits": { - "aws.protocols#ec2QueryName": "EnaSupport", - "smithy.api#documentation": "

Set to true to enable enhanced networking with ENA for the\n instance.

\n

This option is supported only for HVM instances. Specifying this option with a PV\n instance can make it unreachable.

", - "smithy.api#xmlName": "enaSupport" - } - }, - "Groups": { - "target": "com.amazonaws.ec2#GroupIdStringList", - "traits": { - "smithy.api#documentation": "

Replaces the security groups of the instance with the specified security groups.\n You must specify the ID of at least one security group, even if it's just the default\n security group for the VPC.

", - "smithy.api#xmlName": "GroupId" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "instanceId" - } - }, - "InstanceInitiatedShutdownBehavior": { - "target": "com.amazonaws.ec2#AttributeValue", - "traits": { - "aws.protocols#ec2QueryName": "InstanceInitiatedShutdownBehavior", - "smithy.api#documentation": "

Specifies whether an instance stops or terminates when you initiate shutdown from the\n instance (using the operating system command for system shutdown).

", - "smithy.api#xmlName": "instanceInitiatedShutdownBehavior" - } - }, - "InstanceType": { - "target": "com.amazonaws.ec2#AttributeValue", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

Changes the instance type to the specified value. For more information, see Instance\n types in the Amazon EC2 User Guide. If the instance type is\n not valid, the error returned is InvalidInstanceAttributeValue.

", - "smithy.api#xmlName": "instanceType" - } - }, - "Kernel": { - "target": "com.amazonaws.ec2#AttributeValue", - "traits": { - "aws.protocols#ec2QueryName": "Kernel", - "smithy.api#documentation": "

Changes the instance's kernel to the specified value. We recommend that you use\n PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", - "smithy.api#xmlName": "kernel" - } - }, - "Ramdisk": { - "target": "com.amazonaws.ec2#AttributeValue", - "traits": { - "aws.protocols#ec2QueryName": "Ramdisk", - "smithy.api#documentation": "

Changes the instance's RAM disk to the specified value. We recommend that you use\n PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", - "smithy.api#xmlName": "ramdisk" - } - }, - "SriovNetSupport": { - "target": "com.amazonaws.ec2#AttributeValue", - "traits": { - "aws.protocols#ec2QueryName": "SriovNetSupport", - "smithy.api#documentation": "

Set to simple to enable enhanced networking with the Intel 82599 Virtual\n Function interface for the instance.

\n

There is no way to disable enhanced networking with the Intel 82599 Virtual Function\n interface at this time.

\n

This option is supported only for HVM instances. Specifying this option with a PV\n instance can make it unreachable.

", - "smithy.api#xmlName": "sriovNetSupport" - } - }, - "UserData": { - "target": "com.amazonaws.ec2#BlobAttributeValue", - "traits": { - "aws.protocols#ec2QueryName": "UserData", - "smithy.api#documentation": "

Changes the instance's user data to the specified value. If you are using an Amazon Web Services SDK or command line tool, base64-encoding is performed for you, and you\n can load the text from a file. Otherwise, you must provide base64-encoded text.

", - "smithy.api#xmlName": "userData" - } - }, - "Value": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Value", - "smithy.api#documentation": "

A new value for the attribute. Use only with the kernel,\n ramdisk, userData, disableApiTermination, or\n instanceInitiatedShutdownBehavior attribute.

", - "smithy.api#xmlName": "value" - } - }, - "DisableApiStop": { - "target": "com.amazonaws.ec2#AttributeBooleanValue", - "traits": { - "smithy.api#documentation": "

Indicates whether an instance is enabled for stop protection. For more information,\n see Stop\n Protection.

\n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyInstanceCapacityReservationAttributes": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyInstanceCapacityReservationAttributesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyInstanceCapacityReservationAttributesResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies the Capacity Reservation settings for a stopped instance. Use this action to configure an\n\t\t\tinstance to target a specific Capacity Reservation, run in any open Capacity Reservation with matching\n\t\t\tattributes, or run On-Demand Instance capacity.

" - } - }, - "com.amazonaws.ec2#ModifyInstanceCapacityReservationAttributesRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the instance to be modified.

", - "smithy.api#required": {} - } - }, - "CapacityReservationSpecification": { - "target": "com.amazonaws.ec2#CapacityReservationSpecification", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Information about the Capacity Reservation targeting option.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyInstanceCapacityReservationAttributesResult": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyInstanceCreditSpecification": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyInstanceCreditSpecificationRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyInstanceCreditSpecificationResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies the credit option for CPU usage on a running or stopped burstable performance\n instance. The credit options are standard and\n unlimited.

\n

For more information, see Burstable\n performance instances in the Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#ModifyInstanceCreditSpecificationRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring\n Idempotency.

" - } - }, - "InstanceCreditSpecifications": { - "target": "com.amazonaws.ec2#InstanceCreditSpecificationListRequest", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Information about the credit option for CPU usage.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "InstanceCreditSpecification" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyInstanceCreditSpecificationResult": { - "type": "structure", - "members": { - "SuccessfulInstanceCreditSpecifications": { - "target": "com.amazonaws.ec2#SuccessfulInstanceCreditSpecificationSet", - "traits": { - "aws.protocols#ec2QueryName": "SuccessfulInstanceCreditSpecificationSet", - "smithy.api#documentation": "

Information about the instances whose credit option for CPU usage was successfully\n modified.

", - "smithy.api#xmlName": "successfulInstanceCreditSpecificationSet" - } - }, - "UnsuccessfulInstanceCreditSpecifications": { - "target": "com.amazonaws.ec2#UnsuccessfulInstanceCreditSpecificationSet", - "traits": { - "aws.protocols#ec2QueryName": "UnsuccessfulInstanceCreditSpecificationSet", - "smithy.api#documentation": "

Information about the instances whose credit option for CPU usage was not\n modified.

", - "smithy.api#xmlName": "unsuccessfulInstanceCreditSpecificationSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyInstanceEventStartTime": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyInstanceEventStartTimeRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyInstanceEventStartTimeResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies the start time for a scheduled Amazon EC2 instance event.

" - } - }, - "com.amazonaws.ec2#ModifyInstanceEventStartTimeRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the instance with the scheduled event.

", - "smithy.api#required": {} - } - }, - "InstanceEventId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the event whose date and time you are modifying.

", - "smithy.api#required": {} - } - }, - "NotBefore": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The new date and time when the event will take place.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyInstanceEventStartTimeResult": { - "type": "structure", - "members": { - "Event": { - "target": "com.amazonaws.ec2#InstanceStatusEvent", - "traits": { - "aws.protocols#ec2QueryName": "Event", - "smithy.api#documentation": "

Information about the event.

", - "smithy.api#xmlName": "event" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyInstanceEventWindow": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyInstanceEventWindowRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyInstanceEventWindowResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies the specified event window.

\n

You can define either a set of time ranges or a cron expression when modifying the event\n window, but not both.

\n

To modify the targets associated with the event window, use the AssociateInstanceEventWindow and DisassociateInstanceEventWindow API.

\n

If Amazon Web Services has already scheduled an event, modifying an event window won't change the time\n of the scheduled event.

\n

For more information, see Define event windows for scheduled\n events in the Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#ModifyInstanceEventWindowRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "Name": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The name of the event window.

" - } - }, - "InstanceEventWindowId": { - "target": "com.amazonaws.ec2#InstanceEventWindowId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the event window.

", - "smithy.api#required": {} - } - }, - "TimeRanges": { - "target": "com.amazonaws.ec2#InstanceEventWindowTimeRangeRequestSet", - "traits": { - "smithy.api#documentation": "

The time ranges of the event window.

", - "smithy.api#xmlName": "TimeRange" - } - }, - "CronExpression": { - "target": "com.amazonaws.ec2#InstanceEventWindowCronExpression", - "traits": { - "smithy.api#documentation": "

The cron expression of the event window, for example, * 0-4,20-23 * * 1,5.

\n

Constraints:

\n \n

For more information about cron expressions, see cron on the Wikipedia\n website.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyInstanceEventWindowResult": { - "type": "structure", - "members": { - "InstanceEventWindow": { - "target": "com.amazonaws.ec2#InstanceEventWindow", - "traits": { - "aws.protocols#ec2QueryName": "InstanceEventWindow", - "smithy.api#documentation": "

Information about the event window.

", - "smithy.api#xmlName": "instanceEventWindow" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyInstanceMaintenanceOptions": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyInstanceMaintenanceOptionsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyInstanceMaintenanceOptionsResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies the recovery behavior of your instance to disable simplified automatic\n recovery or set the recovery behavior to default. The default configuration will not\n enable simplified automatic recovery for an unsupported instance type. For more\n information, see Simplified automatic recovery.

" - } - }, - "com.amazonaws.ec2#ModifyInstanceMaintenanceOptionsRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#required": {} - } - }, - "AutoRecovery": { - "target": "com.amazonaws.ec2#InstanceAutoRecoveryState", - "traits": { - "smithy.api#documentation": "

Disables the automatic recovery behavior of your instance or sets it to\n default.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyInstanceMaintenanceOptionsResult": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#xmlName": "instanceId" - } - }, - "AutoRecovery": { - "target": "com.amazonaws.ec2#InstanceAutoRecoveryState", - "traits": { - "aws.protocols#ec2QueryName": "AutoRecovery", - "smithy.api#documentation": "

Provides information on the current automatic recovery behavior of your\n instance.

", - "smithy.api#xmlName": "autoRecovery" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyInstanceMetadataOptions": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyInstanceMetadataOptionsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyInstanceMetadataOptionsResult" - }, - "traits": { - "smithy.api#documentation": "

Modify the instance metadata parameters on a running or stopped instance. When you\n modify the parameters on a stopped instance, they are applied when the instance is\n started. When you modify the parameters on a running instance, the API responds with a\n state of “pending”. After the parameter modifications are successfully applied to the\n instance, the state of the modifications changes from “pending” to “applied” in\n subsequent describe-instances API calls. For more information, see Instance metadata and user data in the\n Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#ModifyInstanceMetadataOptionsRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#required": {} - } - }, - "HttpTokens": { - "target": "com.amazonaws.ec2#HttpTokensState", - "traits": { - "smithy.api#documentation": "

IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to optional\n (in other words, set the use of IMDSv2 to optional) or\n required (in other words, set the use of IMDSv2 to\n required).

\n \n

Default: optional\n

" - } - }, - "HttpPutResponseHopLimit": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel. If no parameter is specified,\n the existing state is maintained.

\n

Possible values: Integers from 1 to 64

" - } - }, - "HttpEndpoint": { - "target": "com.amazonaws.ec2#InstanceMetadataEndpointState", - "traits": { - "smithy.api#documentation": "

Enables or disables the HTTP metadata endpoint on your instances. If this parameter is\n not specified, the existing state is maintained.

\n

If you specify a value of disabled, you cannot access your instance\n metadata.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" - } - }, - "HttpProtocolIpv6": { - "target": "com.amazonaws.ec2#InstanceMetadataProtocolState", - "traits": { - "smithy.api#documentation": "

Enables or disables the IPv6 endpoint for the instance metadata service. This setting\n applies only if you have enabled the HTTP metadata endpoint.

" - } - }, - "InstanceMetadataTags": { - "target": "com.amazonaws.ec2#InstanceMetadataTagsState", - "traits": { - "smithy.api#documentation": "

Set to enabled to allow access to instance tags from the instance\n metadata. Set to disabled to turn off access to instance tags from the\n instance metadata. For more information, see Work with\n instance tags using the instance metadata.

\n

Default: disabled\n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyInstanceMetadataOptionsResult": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#xmlName": "instanceId" - } - }, - "InstanceMetadataOptions": { - "target": "com.amazonaws.ec2#InstanceMetadataOptionsResponse", - "traits": { - "aws.protocols#ec2QueryName": "InstanceMetadataOptions", - "smithy.api#documentation": "

The metadata options for the instance.

", - "smithy.api#xmlName": "instanceMetadataOptions" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyInstancePlacement": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyInstancePlacementRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyInstancePlacementResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies the placement attributes for a specified instance. You can do the\n following:

\n \n

At least one attribute for affinity, host ID, tenancy, or placement group name must be\n specified in the request. Affinity and tenancy can be modified in the same\n request.

\n

To modify the host ID, tenancy, placement group, or partition for an instance, the\n instance must be in the stopped state.

" - } - }, - "com.amazonaws.ec2#ModifyInstancePlacementRequest": { - "type": "structure", - "members": { - "Affinity": { - "target": "com.amazonaws.ec2#Affinity", - "traits": { - "aws.protocols#ec2QueryName": "Affinity", - "smithy.api#documentation": "

The affinity setting for the instance.

", - "smithy.api#xmlName": "affinity" - } - }, - "GroupName": { - "target": "com.amazonaws.ec2#PlacementGroupName", - "traits": { - "smithy.api#documentation": "

The name of the placement group in which to place the instance. For spread placement\n groups, the instance must have a tenancy of default. For cluster and\n partition placement groups, the instance must have a tenancy of default or\n dedicated.

\n

To remove an instance from a placement group, specify an empty string (\"\").

" - } - }, - "HostId": { - "target": "com.amazonaws.ec2#DedicatedHostId", - "traits": { - "aws.protocols#ec2QueryName": "HostId", - "smithy.api#documentation": "

The ID of the Dedicated Host with which to associate the instance.

", - "smithy.api#xmlName": "hostId" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the instance that you are modifying.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "instanceId" - } - }, - "Tenancy": { - "target": "com.amazonaws.ec2#HostTenancy", - "traits": { - "aws.protocols#ec2QueryName": "Tenancy", - "smithy.api#documentation": "

The tenancy for the instance.

\n \n

For T3 instances, you can't change the tenancy from dedicated to\n host, or from host to dedicated.\n Attempting to make one of these unsupported tenancy changes results in the\n InvalidTenancy error code.

\n ", - "smithy.api#xmlName": "tenancy" - } - }, - "PartitionNumber": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of the partition in which to place the instance. Valid only if the\n placement group strategy is set to partition.

" - } - }, - "HostResourceGroupArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The ARN of the host resource group in which to place the instance.

" - } - }, - "GroupId": { - "target": "com.amazonaws.ec2#PlacementGroupId", - "traits": { - "smithy.api#documentation": "

The Group Id of a placement group. You must specify the Placement Group Group Id to launch an instance in a shared placement\n group.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyInstancePlacementResult": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Is true if the request succeeds, and an error otherwise.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyIpam": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyIpamRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyIpamResult" - }, - "traits": { - "smithy.api#documentation": "

Modify the configurations of an IPAM.\n

" - } - }, - "com.amazonaws.ec2#ModifyIpamPool": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyIpamPoolRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyIpamPoolResult" - }, - "traits": { - "smithy.api#documentation": "

Modify the configurations of an IPAM pool.

\n

For more information, see Modify a pool in the Amazon VPC IPAM User Guide.\n

" - } - }, - "com.amazonaws.ec2#ModifyIpamPoolRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "IpamPoolId": { - "target": "com.amazonaws.ec2#IpamPoolId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the IPAM pool you want to modify.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The description of the IPAM pool you want to modify.

" - } - }, - "AutoImport": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

If true, IPAM will continuously look for resources within the CIDR range of this pool \n and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for\n these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import \n a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently \n marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM \n discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.\n

\n

A locale must be set on the pool for this feature to work.

" - } - }, - "AllocationMinNetmaskLength": { - "target": "com.amazonaws.ec2#IpamNetmaskLength", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. Possible \n netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. The minimum netmask \n length must be less than the maximum netmask length.

" - } - }, - "AllocationMaxNetmaskLength": { - "target": "com.amazonaws.ec2#IpamNetmaskLength", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. Possible \n netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.The maximum netmask \n length must be greater than the minimum netmask length.

" - } - }, - "AllocationDefaultNetmaskLength": { - "target": "com.amazonaws.ec2#IpamNetmaskLength", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.

" - } - }, - "ClearAllocationDefaultNetmaskLength": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Clear the default netmask length allocation rule for this pool.

" - } - }, - "AddAllocationResourceTags": { - "target": "com.amazonaws.ec2#RequestIpamResourceTagList", - "traits": { - "smithy.api#documentation": "

Add tag allocation rules to a pool. For more information about allocation rules, see Create a top-level pool in the Amazon VPC IPAM User Guide.

", - "smithy.api#xmlName": "AddAllocationResourceTag" - } - }, - "RemoveAllocationResourceTags": { - "target": "com.amazonaws.ec2#RequestIpamResourceTagList", - "traits": { - "smithy.api#documentation": "

Remove tag allocation rules from a pool.

", - "smithy.api#xmlName": "RemoveAllocationResourceTag" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyIpamPoolResult": { - "type": "structure", - "members": { - "IpamPool": { - "target": "com.amazonaws.ec2#IpamPool", - "traits": { - "aws.protocols#ec2QueryName": "IpamPool", - "smithy.api#documentation": "

The results of the modification.

", - "smithy.api#xmlName": "ipamPool" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyIpamRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "IpamId": { - "target": "com.amazonaws.ec2#IpamId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the IPAM you want to modify.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The description of the IPAM you want to modify.

" - } - }, - "AddOperatingRegions": { - "target": "com.amazonaws.ec2#AddIpamOperatingRegionSet", - "traits": { - "smithy.api#documentation": "

Choose the operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

\n

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.

", - "smithy.api#xmlName": "AddOperatingRegion" - } - }, - "RemoveOperatingRegions": { - "target": "com.amazonaws.ec2#RemoveIpamOperatingRegionSet", - "traits": { - "smithy.api#documentation": "

The operating Regions to remove.

", - "smithy.api#xmlName": "RemoveOperatingRegion" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyIpamResourceCidr": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyIpamResourceCidrRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyIpamResourceCidrResult" - }, - "traits": { - "smithy.api#documentation": "

Modify a resource CIDR. You can use this action to transfer resource CIDRs between scopes and ignore resource CIDRs that you do not want to manage. If set to false, the resource will not be tracked for overlap, it cannot be auto-imported into a pool, and it will be removed from any pool it has an allocation in.

\n

For more information, see Move resource CIDRs between scopes and Change the monitoring state of resource CIDRs in the Amazon VPC IPAM User Guide.

" - } - }, - "com.amazonaws.ec2#ModifyIpamResourceCidrRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "ResourceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the resource you want to modify.

", - "smithy.api#required": {} - } - }, - "ResourceCidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The CIDR of the resource you want to modify.

", - "smithy.api#required": {} - } - }, - "ResourceRegion": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Amazon Web Services Region of the resource you want to modify.

", - "smithy.api#required": {} - } - }, - "CurrentIpamScopeId": { - "target": "com.amazonaws.ec2#IpamScopeId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the current scope that the resource CIDR is in.

", - "smithy.api#required": {} - } - }, - "DestinationIpamScopeId": { - "target": "com.amazonaws.ec2#IpamScopeId", - "traits": { - "smithy.api#documentation": "

The ID of the scope you want to transfer the resource CIDR to.

" - } - }, - "Monitored": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Determines if the resource is monitored by IPAM. If a resource is monitored, the resource is discovered by IPAM and you can view details about the resource’s CIDR.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyIpamResourceCidrResult": { - "type": "structure", - "members": { - "IpamResourceCidr": { - "target": "com.amazonaws.ec2#IpamResourceCidr", - "traits": { - "aws.protocols#ec2QueryName": "IpamResourceCidr", - "smithy.api#documentation": "

The CIDR of the resource.

", - "smithy.api#xmlName": "ipamResourceCidr" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyIpamResourceDiscovery": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyIpamResourceDiscoveryRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyIpamResourceDiscoveryResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies a resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

" - } - }, - "com.amazonaws.ec2#ModifyIpamResourceDiscoveryRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "IpamResourceDiscoveryId": { - "target": "com.amazonaws.ec2#IpamResourceDiscoveryId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A resource discovery ID.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A resource discovery description.

" - } - }, - "AddOperatingRegions": { - "target": "com.amazonaws.ec2#AddIpamOperatingRegionSet", - "traits": { - "smithy.api#documentation": "

Add operating Regions to the resource discovery. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

", - "smithy.api#xmlName": "AddOperatingRegion" - } - }, - "RemoveOperatingRegions": { - "target": "com.amazonaws.ec2#RemoveIpamOperatingRegionSet", - "traits": { - "smithy.api#documentation": "

Remove operating Regions.

", - "smithy.api#xmlName": "RemoveOperatingRegion" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyIpamResourceDiscoveryResult": { - "type": "structure", - "members": { - "IpamResourceDiscovery": { - "target": "com.amazonaws.ec2#IpamResourceDiscovery", - "traits": { - "aws.protocols#ec2QueryName": "IpamResourceDiscovery", - "smithy.api#documentation": "

A resource discovery.

", - "smithy.api#xmlName": "ipamResourceDiscovery" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyIpamResult": { - "type": "structure", - "members": { - "Ipam": { - "target": "com.amazonaws.ec2#Ipam", - "traits": { - "aws.protocols#ec2QueryName": "Ipam", - "smithy.api#documentation": "

The results of the modification.

", - "smithy.api#xmlName": "ipam" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyIpamScope": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyIpamScopeRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyIpamScopeResult" - }, - "traits": { - "smithy.api#documentation": "

Modify an IPAM scope.

" - } - }, - "com.amazonaws.ec2#ModifyIpamScopeRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "IpamScopeId": { - "target": "com.amazonaws.ec2#IpamScopeId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the scope you want to modify.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The description of the scope you want to modify.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyIpamScopeResult": { - "type": "structure", - "members": { - "IpamScope": { - "target": "com.amazonaws.ec2#IpamScope", - "traits": { - "aws.protocols#ec2QueryName": "IpamScope", - "smithy.api#documentation": "

The results of the modification.

", - "smithy.api#xmlName": "ipamScope" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyLaunchTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyLaunchTemplateRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyLaunchTemplateResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies a launch template. You can specify which version of the launch template to\n set as the default version. When launching an instance, the default version applies when\n a launch template version is not specified.

" - } - }, - "com.amazonaws.ec2#ModifyLaunchTemplateRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.

\n

Constraint: Maximum 128 ASCII characters.

" - } - }, - "LaunchTemplateId": { - "target": "com.amazonaws.ec2#LaunchTemplateId", - "traits": { - "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify either the LaunchTemplateId or the\n LaunchTemplateName, but not both.

" - } - }, - "LaunchTemplateName": { - "target": "com.amazonaws.ec2#LaunchTemplateName", - "traits": { - "smithy.api#documentation": "

The name of the launch template.

\n

You must specify either the LaunchTemplateName or the\n LaunchTemplateId, but not both.

" - } - }, - "DefaultVersion": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The version number of the launch template to set as the default version.

", - "smithy.api#xmlName": "SetDefaultVersion" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyLaunchTemplateResult": { - "type": "structure", - "members": { - "LaunchTemplate": { - "target": "com.amazonaws.ec2#LaunchTemplate", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplate", - "smithy.api#documentation": "

Information about the launch template.

", - "smithy.api#xmlName": "launchTemplate" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyLocalGatewayRoute": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyLocalGatewayRouteRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyLocalGatewayRouteResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies the specified local gateway route.

" - } - }, - "com.amazonaws.ec2#ModifyLocalGatewayRouteRequest": { - "type": "structure", - "members": { - "DestinationCidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The CIDR block used for destination matches. The value that you provide must match the CIDR of an existing route in the table.

" - } - }, - "LocalGatewayRouteTableId": { - "target": "com.amazonaws.ec2#LocalGatewayRoutetableId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the local gateway route table.

", - "smithy.api#required": {} - } - }, - "LocalGatewayVirtualInterfaceGroupId": { - "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupId", - "traits": { - "smithy.api#documentation": "

\n The ID of the virtual interface group.\n

" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#NetworkInterfaceId", - "traits": { - "smithy.api#documentation": "

The ID of the network interface.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "DestinationPrefixListId": { - "target": "com.amazonaws.ec2#PrefixListResourceId", - "traits": { - "smithy.api#documentation": "

\n The ID of the prefix list. Use a prefix list in place of DestinationCidrBlock. You \n cannot use DestinationPrefixListId and DestinationCidrBlock in the same request.\n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyLocalGatewayRouteResult": { - "type": "structure", - "members": { - "Route": { - "target": "com.amazonaws.ec2#LocalGatewayRoute", - "traits": { - "aws.protocols#ec2QueryName": "Route", - "smithy.api#documentation": "

Information about the local gateway route table.

", - "smithy.api#xmlName": "route" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyManagedPrefixList": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyManagedPrefixListRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyManagedPrefixListResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies the specified managed prefix list.

\n

Adding or removing entries in a prefix list creates a new version of the prefix list.\n Changing the name of the prefix list does not affect the version.

\n

If you specify a current version number that does not match the true current version\n number, the request fails.

" - } - }, - "com.amazonaws.ec2#ModifyManagedPrefixListRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "PrefixListId": { - "target": "com.amazonaws.ec2#PrefixListResourceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the prefix list.

", - "smithy.api#required": {} - } - }, - "CurrentVersion": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The current version of the prefix list.

" - } - }, - "PrefixListName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A name for the prefix list.

" - } - }, - "AddEntries": { - "target": "com.amazonaws.ec2#AddPrefixListEntries", - "traits": { - "smithy.api#documentation": "

One or more entries to add to the prefix list.

", - "smithy.api#xmlName": "AddEntry" - } - }, - "RemoveEntries": { - "target": "com.amazonaws.ec2#RemovePrefixListEntries", - "traits": { - "smithy.api#documentation": "

One or more entries to remove from the prefix list.

", - "smithy.api#xmlName": "RemoveEntry" - } - }, - "MaxEntries": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of entries for the prefix list. You cannot modify the entries \n of a prefix list and modify the size of a prefix list at the same time.

\n

If any of the resources that reference the prefix list cannot support the new\n maximum size, the modify operation fails. Check the state message for the IDs of \n the first ten resources that do not support the new maximum size.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyManagedPrefixListResult": { - "type": "structure", - "members": { - "PrefixList": { - "target": "com.amazonaws.ec2#ManagedPrefixList", - "traits": { - "aws.protocols#ec2QueryName": "PrefixList", - "smithy.api#documentation": "

Information about the prefix list.

", - "smithy.api#xmlName": "prefixList" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyNetworkInterfaceAttribute": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyNetworkInterfaceAttributeRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Modifies the specified network interface attribute. You can specify only one\n attribute at a time. You can use this action to attach and detach security groups from\n an existing EC2 instance.

" - } - }, - "com.amazonaws.ec2#ModifyNetworkInterfaceAttributeRequest": { - "type": "structure", - "members": { - "Attachment": { - "target": "com.amazonaws.ec2#NetworkInterfaceAttachmentChanges", - "traits": { - "aws.protocols#ec2QueryName": "Attachment", - "smithy.api#documentation": "

Information about the interface attachment. If modifying the delete on\n\t\t\t\ttermination attribute, you must specify the ID of the interface\n\t\t\tattachment.

", - "smithy.api#xmlName": "attachment" - } - }, - "Description": { - "target": "com.amazonaws.ec2#AttributeValue", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description for the network interface.

", - "smithy.api#xmlName": "description" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "Groups": { - "target": "com.amazonaws.ec2#SecurityGroupIdStringList", - "traits": { - "smithy.api#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.

", - "smithy.api#xmlName": "SecurityGroupId" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#NetworkInterfaceId", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the network interface.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "networkInterfaceId" - } - }, - "SourceDestCheck": { - "target": "com.amazonaws.ec2#AttributeBooleanValue", - "traits": { - "aws.protocols#ec2QueryName": "SourceDestCheck", - "smithy.api#documentation": "

Enable or disable source/destination checks, which ensure that the instance\n is either the source or the destination of any traffic that it receives.\n If the value is true, source/destination checks are enabled;\n otherwise, they are disabled. The default value is true. \n You must disable source/destination checks if the instance runs services \n such as network address translation, routing, or firewalls.

", - "smithy.api#xmlName": "sourceDestCheck" - } - }, - "EnaSrdSpecification": { - "target": "com.amazonaws.ec2#EnaSrdSpecification", - "traits": { - "smithy.api#documentation": "

Updates the ENA Express configuration for the network interface that’s attached to the\n\t\t\tinstance.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for ModifyNetworkInterfaceAttribute.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyPrivateDnsNameOptions": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyPrivateDnsNameOptionsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyPrivateDnsNameOptionsResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies the options for instance hostnames for the specified instance.

" - } - }, - "com.amazonaws.ec2#ModifyPrivateDnsNameOptionsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#required": {} - } - }, - "PrivateDnsHostnameType": { - "target": "com.amazonaws.ec2#HostnameType", - "traits": { - "smithy.api#documentation": "

The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name\n must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name\n must be based on the instance ID. For dual-stack subnets, you can specify whether DNS\n names use the instance IPv4 address or the instance ID.

" - } - }, - "EnableResourceNameDnsARecord": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS A\n records.

" - } - }, - "EnableResourceNameDnsAAAARecord": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA\n records.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyPrivateDnsNameOptionsResult": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an\n error.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyReservedInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyReservedInstancesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyReservedInstancesResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies the configuration of your Reserved Instances, such as the Availability Zone, \n instance count, or instance type. The Reserved Instances to be modified must be identical, \n except for Availability Zone, network platform, and instance type.

\n

For more information, see Modifying Reserved\n\t\t\t\tInstances in the Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#ModifyReservedInstancesRequest": { - "type": "structure", - "members": { - "ReservedInstancesIds": { - "target": "com.amazonaws.ec2#ReservedInstancesIdStringList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IDs of the Reserved Instances to modify.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "ReservedInstancesId" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see \n \t\tEnsuring Idempotency.

", - "smithy.api#xmlName": "clientToken" - } - }, - "TargetConfigurations": { - "target": "com.amazonaws.ec2#ReservedInstancesConfigurationList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The configuration settings for the Reserved Instances to modify.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "ReservedInstancesConfigurationSetItemType" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for ModifyReservedInstances.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyReservedInstancesResult": { - "type": "structure", - "members": { - "ReservedInstancesModificationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ReservedInstancesModificationId", - "smithy.api#documentation": "

The ID for the modification.

", - "smithy.api#xmlName": "reservedInstancesModificationId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of ModifyReservedInstances.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifySecurityGroupRules": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifySecurityGroupRulesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifySecurityGroupRulesResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies the rules of a security group.

" - } - }, - "com.amazonaws.ec2#ModifySecurityGroupRulesRequest": { - "type": "structure", - "members": { - "GroupId": { - "target": "com.amazonaws.ec2#SecurityGroupId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the security group.

", - "smithy.api#required": {} - } - }, - "SecurityGroupRules": { - "target": "com.amazonaws.ec2#SecurityGroupRuleUpdateList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Information about the security group properties to update.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "SecurityGroupRule" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifySecurityGroupRulesResult": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, returns an error.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifySnapshotAttribute": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifySnapshotAttributeRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Adds or removes permission settings for the specified snapshot. You may add or remove\n specified Amazon Web Services account IDs from a snapshot's list of create volume permissions, but you cannot\n do both in a single operation. If you need to both add and remove account IDs for a snapshot,\n you must use multiple operations. You can make up to 500 modifications to a snapshot in a single operation.

\n

Encrypted snapshots and snapshots with Amazon Web Services Marketplace product codes cannot be made\n public. Snapshots encrypted with your default KMS key cannot be shared with other accounts.

\n

For more information about modifying snapshot permissions, see Share a snapshot in the\n Amazon Elastic Compute Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#ModifySnapshotAttributeRequest": { - "type": "structure", - "members": { - "Attribute": { - "target": "com.amazonaws.ec2#SnapshotAttributeName", - "traits": { - "smithy.api#documentation": "

The snapshot attribute to modify. Only volume creation permissions can be modified.

" - } - }, - "CreateVolumePermission": { - "target": "com.amazonaws.ec2#CreateVolumePermissionModifications", - "traits": { - "smithy.api#documentation": "

A JSON representation of the snapshot attribute modification.

" - } - }, - "GroupNames": { - "target": "com.amazonaws.ec2#GroupNameStringList", - "traits": { - "smithy.api#documentation": "

The group to modify for the snapshot.

", - "smithy.api#xmlName": "UserGroup" - } - }, - "OperationType": { - "target": "com.amazonaws.ec2#OperationType", - "traits": { - "smithy.api#documentation": "

The type of operation to perform to the attribute.

" - } - }, - "SnapshotId": { - "target": "com.amazonaws.ec2#SnapshotId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the snapshot.

", - "smithy.api#required": {} - } - }, - "UserIds": { - "target": "com.amazonaws.ec2#UserIdStringList", - "traits": { - "smithy.api#documentation": "

The account ID to modify for the snapshot.

", - "smithy.api#xmlName": "UserId" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifySnapshotTier": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifySnapshotTierRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifySnapshotTierResult" - }, - "traits": { - "smithy.api#documentation": "

Archives an Amazon EBS snapshot. When you archive a snapshot, it is converted to a full \n snapshot that includes all of the blocks of data that were written to the volume at the \n time the snapshot was created, and moved from the standard tier to the archive \n tier. For more information, see Archive Amazon EBS snapshots \n in the Amazon Elastic Compute Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#ModifySnapshotTierRequest": { - "type": "structure", - "members": { - "SnapshotId": { - "target": "com.amazonaws.ec2#SnapshotId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the snapshot.

", - "smithy.api#required": {} - } - }, - "StorageTier": { - "target": "com.amazonaws.ec2#TargetStorageTier", - "traits": { - "smithy.api#documentation": "

The name of the storage tier. You must specify archive.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifySnapshotTierResult": { - "type": "structure", - "members": { - "SnapshotId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SnapshotId", - "smithy.api#documentation": "

The ID of the snapshot.

", - "smithy.api#xmlName": "snapshotId" - } - }, - "TieringStartTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "TieringStartTime", - "smithy.api#documentation": "

The date and time when the archive process was started.

", - "smithy.api#xmlName": "tieringStartTime" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifySpotFleetRequest": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifySpotFleetRequestRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifySpotFleetRequestResponse" - }, - "traits": { - "smithy.api#documentation": "

Modifies the specified Spot Fleet request.

\n

You can only modify a Spot Fleet request of type maintain.

\n

While the Spot Fleet request is being modified, it is in the modifying\n state.

\n

To scale up your Spot Fleet, increase its target capacity. The Spot Fleet launches the\n additional Spot Instances according to the allocation strategy for the Spot Fleet\n request. If the allocation strategy is lowestPrice, the Spot Fleet launches\n instances using the Spot Instance pool with the lowest price. If the allocation strategy\n is diversified, the Spot Fleet distributes the instances across the Spot\n Instance pools. If the allocation strategy is capacityOptimized, Spot Fleet\n launches instances from Spot Instance pools with optimal capacity for the number of instances\n that are launching.

\n

To scale down your Spot Fleet, decrease its target capacity. First, the Spot Fleet\n cancels any open requests that exceed the new target capacity. You can request that the\n Spot Fleet terminate Spot Instances until the size of the fleet no longer exceeds the\n new target capacity. If the allocation strategy is lowestPrice, the Spot\n Fleet terminates the instances with the highest price per unit. If the allocation\n strategy is capacityOptimized, the Spot Fleet terminates the instances in\n the Spot Instance pools that have the least available Spot Instance capacity. If the allocation\n strategy is diversified, the Spot Fleet terminates instances across the\n Spot Instance pools. Alternatively, you can request that the Spot Fleet keep the fleet\n at its current size, but not replace any Spot Instances that are interrupted or that you\n terminate manually.

\n

If you are finished with your Spot Fleet for now, but will use it again later, you can\n set the target capacity to 0.

" - } - }, - "com.amazonaws.ec2#ModifySpotFleetRequestRequest": { - "type": "structure", - "members": { - "ExcessCapacityTerminationPolicy": { - "target": "com.amazonaws.ec2#ExcessCapacityTerminationPolicy", - "traits": { - "aws.protocols#ec2QueryName": "ExcessCapacityTerminationPolicy", - "smithy.api#documentation": "

Indicates whether running instances should be terminated if the target capacity\n of the Spot Fleet request is decreased below the current size of the Spot Fleet.

\n

Supported only for fleets of type maintain.

", - "smithy.api#xmlName": "excessCapacityTerminationPolicy" - } - }, - "LaunchTemplateConfigs": { - "target": "com.amazonaws.ec2#LaunchTemplateConfigList", - "traits": { - "smithy.api#documentation": "

The launch template and overrides. You can only use this parameter if you specified a\n launch template (LaunchTemplateConfigs) in your Spot Fleet request. If you\n specified LaunchSpecifications in your Spot Fleet request, then omit this\n parameter.

", - "smithy.api#xmlName": "LaunchTemplateConfig" - } - }, - "SpotFleetRequestId": { - "target": "com.amazonaws.ec2#SpotFleetRequestId", - "traits": { - "aws.protocols#ec2QueryName": "SpotFleetRequestId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Spot Fleet request.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "spotFleetRequestId" - } - }, - "TargetCapacity": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "TargetCapacity", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The size of the fleet.

", - "smithy.api#xmlName": "targetCapacity" - } - }, - "OnDemandTargetCapacity": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of On-Demand Instances in the fleet.

" - } - }, - "Context": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Reserved.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for ModifySpotFleetRequest.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifySpotFleetRequestResponse": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

If the request succeeds, the response returns true. If the request fails,\n no response is returned, and instead an error message is returned.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of ModifySpotFleetRequest.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifySubnetAttribute": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifySubnetAttributeRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Modifies a subnet attribute. You can only modify one attribute at a time.

\n

Use this action to modify subnets on Amazon Web Services Outposts.

\n \n

For more information about Amazon Web Services Outposts, see the following:

\n " - } - }, - "com.amazonaws.ec2#ModifySubnetAttributeRequest": { - "type": "structure", - "members": { - "AssignIpv6AddressOnCreation": { - "target": "com.amazonaws.ec2#AttributeBooleanValue", - "traits": { - "smithy.api#documentation": "

Specify true to indicate that network interfaces created in the\n specified subnet should be assigned an IPv6 address. This includes a network interface\n that's created when launching an instance into the subnet (the instance therefore\n receives an IPv6 address).

\n

If you enable the IPv6 addressing feature for your subnet, your network interface\n or instance only receives an IPv6 address if it's created using version\n 2016-11-15 or later of the Amazon EC2 API.

" - } - }, - "MapPublicIpOnLaunch": { - "target": "com.amazonaws.ec2#AttributeBooleanValue", - "traits": { - "smithy.api#documentation": "

Specify true to indicate that network interfaces attached to instances created in the\n specified subnet should be assigned a public IPv4 address.

" - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#SubnetId", - "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the subnet.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "subnetId" - } - }, - "MapCustomerOwnedIpOnLaunch": { - "target": "com.amazonaws.ec2#AttributeBooleanValue", - "traits": { - "smithy.api#documentation": "

Specify true to indicate that network interfaces attached to instances created in the\n specified subnet should be assigned a customer-owned IPv4 address.

\n

When this value is true, you must specify the customer-owned IP pool using CustomerOwnedIpv4Pool.

" - } - }, - "CustomerOwnedIpv4Pool": { - "target": "com.amazonaws.ec2#CoipPoolId", - "traits": { - "smithy.api#documentation": "

The customer-owned IPv4 address pool associated with the subnet.

\n

You must set this value when you specify true for MapCustomerOwnedIpOnLaunch.

" - } - }, - "EnableDns64": { - "target": "com.amazonaws.ec2#AttributeBooleanValue", - "traits": { - "smithy.api#documentation": "

Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet \n should return synthetic IPv6 addresses for IPv4-only destinations.

" - } - }, - "PrivateDnsHostnameTypeOnLaunch": { - "target": "com.amazonaws.ec2#HostnameType", - "traits": { - "smithy.api#documentation": "

The type of hostname to assign to instances in the subnet at launch. For IPv4-only and dual-stack (IPv4 and IPv6) subnets, an\n instance DNS name can be based on the instance IPv4 address (ip-name) or the instance ID (resource-name). For IPv6 only subnets, an instance\n DNS name must be based on the instance ID (resource-name).

" - } - }, - "EnableResourceNameDnsARecordOnLaunch": { - "target": "com.amazonaws.ec2#AttributeBooleanValue", - "traits": { - "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS A records.

" - } - }, - "EnableResourceNameDnsAAAARecordOnLaunch": { - "target": "com.amazonaws.ec2#AttributeBooleanValue", - "traits": { - "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.

" - } - }, - "EnableLniAtDeviceIndex": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

\n Indicates the device position for local network interfaces in this subnet. For example, \n 1 indicates local network interfaces in this subnet are the secondary \n network interface (eth1). A local network interface cannot be the primary network\n interface (eth0).\n

" - } - }, - "DisableLniAtDeviceIndex": { - "target": "com.amazonaws.ec2#AttributeBooleanValue", - "traits": { - "smithy.api#documentation": "

\n Specify true to indicate that local network interfaces at the current \n position should be disabled. \n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyTrafficMirrorFilterNetworkServices": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyTrafficMirrorFilterNetworkServicesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyTrafficMirrorFilterNetworkServicesResult" - }, - "traits": { - "smithy.api#documentation": "

Allows or restricts mirroring network services.

\n

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.\n When you no longer want to mirror network services, use RemoveNetworkServices to remove the network services from the Traffic Mirror filter.\n

" - } - }, - "com.amazonaws.ec2#ModifyTrafficMirrorFilterNetworkServicesRequest": { - "type": "structure", - "members": { - "TrafficMirrorFilterId": { - "target": "com.amazonaws.ec2#TrafficMirrorFilterId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Traffic Mirror filter.

", - "smithy.api#required": {} - } - }, - "AddNetworkServices": { - "target": "com.amazonaws.ec2#TrafficMirrorNetworkServiceList", - "traits": { - "smithy.api#documentation": "

The network service, for example Amazon DNS, that you want to mirror.

", - "smithy.api#xmlName": "AddNetworkService" - } - }, - "RemoveNetworkServices": { - "target": "com.amazonaws.ec2#TrafficMirrorNetworkServiceList", - "traits": { - "smithy.api#documentation": "

The network service, for example Amazon DNS, that you no longer want to mirror.

", - "smithy.api#xmlName": "RemoveNetworkService" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyTrafficMirrorFilterNetworkServicesResult": { - "type": "structure", - "members": { - "TrafficMirrorFilter": { - "target": "com.amazonaws.ec2#TrafficMirrorFilter", - "traits": { - "aws.protocols#ec2QueryName": "TrafficMirrorFilter", - "smithy.api#documentation": "

The Traffic Mirror filter that the network service is associated with.

", - "smithy.api#xmlName": "trafficMirrorFilter" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyTrafficMirrorFilterRule": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyTrafficMirrorFilterRuleRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyTrafficMirrorFilterRuleResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies the specified Traffic Mirror rule.

\n

\n DestinationCidrBlock and SourceCidrBlock must both be an IPv4\n range or an IPv6 range.

" - } - }, - "com.amazonaws.ec2#ModifyTrafficMirrorFilterRuleRequest": { - "type": "structure", - "members": { - "TrafficMirrorFilterRuleId": { - "target": "com.amazonaws.ec2#TrafficMirrorFilterRuleIdWithResolver", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Traffic Mirror rule.

", - "smithy.api#required": {} - } - }, - "TrafficDirection": { - "target": "com.amazonaws.ec2#TrafficDirection", - "traits": { - "smithy.api#documentation": "

The type of traffic to assign to the rule.

" - } - }, - "RuleNumber": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given\n direction. The rules are processed in ascending order by rule number.

" - } - }, - "RuleAction": { - "target": "com.amazonaws.ec2#TrafficMirrorRuleAction", - "traits": { - "smithy.api#documentation": "

The action to assign to the rule.

" - } - }, - "DestinationPortRange": { - "target": "com.amazonaws.ec2#TrafficMirrorPortRangeRequest", - "traits": { - "smithy.api#documentation": "

The destination ports that are associated with the Traffic Mirror rule.

" - } - }, - "SourcePortRange": { - "target": "com.amazonaws.ec2#TrafficMirrorPortRangeRequest", - "traits": { - "smithy.api#documentation": "

The port range to assign to the Traffic Mirror rule.

" - } - }, - "Protocol": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The protocol, for example TCP, to assign to the Traffic Mirror rule.

" - } - }, - "DestinationCidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The destination CIDR block to assign to the Traffic Mirror rule.

" - } - }, - "SourceCidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The source CIDR block to assign to the Traffic Mirror rule.

" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The description to assign to the Traffic Mirror rule.

" - } - }, - "RemoveFields": { - "target": "com.amazonaws.ec2#TrafficMirrorFilterRuleFieldList", - "traits": { - "smithy.api#documentation": "

The properties that you want to remove from the Traffic Mirror filter rule.

\n

When you remove a property from a Traffic Mirror filter rule, the property is set to the default.

", - "smithy.api#xmlName": "RemoveField" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyTrafficMirrorFilterRuleResult": { - "type": "structure", - "members": { - "TrafficMirrorFilterRule": { - "target": "com.amazonaws.ec2#TrafficMirrorFilterRule", - "traits": { - "aws.protocols#ec2QueryName": "TrafficMirrorFilterRule", - "smithy.api#documentation": "

Modifies a Traffic Mirror rule.

", - "smithy.api#xmlName": "trafficMirrorFilterRule" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyTrafficMirrorSession": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyTrafficMirrorSessionRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyTrafficMirrorSessionResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies a Traffic Mirror session.

" - } - }, - "com.amazonaws.ec2#ModifyTrafficMirrorSessionRequest": { - "type": "structure", - "members": { - "TrafficMirrorSessionId": { - "target": "com.amazonaws.ec2#TrafficMirrorSessionId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Traffic Mirror session.

", - "smithy.api#required": {} - } - }, - "TrafficMirrorTargetId": { - "target": "com.amazonaws.ec2#TrafficMirrorTargetId", - "traits": { - "smithy.api#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": { - "target": "com.amazonaws.ec2#TrafficMirrorFilterId", - "traits": { - "smithy.api#documentation": "

The ID of the Traffic Mirror filter.

" - } - }, - "PacketLength": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#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": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#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.

\n

Valid values are 1-32766.

" - } - }, - "VirtualNetworkId": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The virtual network ID of the Traffic Mirror session.

" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The description to assign to the Traffic Mirror session.

" - } - }, - "RemoveFields": { - "target": "com.amazonaws.ec2#TrafficMirrorSessionFieldList", - "traits": { - "smithy.api#documentation": "

The properties that you want to remove from the Traffic Mirror session.

\n

When you remove a property from a Traffic Mirror session, the property is set to the default.

", - "smithy.api#xmlName": "RemoveField" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyTrafficMirrorSessionResult": { - "type": "structure", - "members": { - "TrafficMirrorSession": { - "target": "com.amazonaws.ec2#TrafficMirrorSession", - "traits": { - "aws.protocols#ec2QueryName": "TrafficMirrorSession", - "smithy.api#documentation": "

Information about the Traffic Mirror session.

", - "smithy.api#xmlName": "trafficMirrorSession" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyTransitGateway": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyTransitGatewayRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyTransitGatewayResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies the specified transit gateway. When you modify a transit gateway, the modified options are applied to new transit gateway attachments only. Your existing transit gateway attachments are not modified.

" - } - }, - "com.amazonaws.ec2#ModifyTransitGatewayOptions": { - "type": "structure", - "members": { - "AddTransitGatewayCidrBlocks": { - "target": "com.amazonaws.ec2#TransitGatewayCidrBlockStringList", - "traits": { - "smithy.api#documentation": "

Adds IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.

" - } - }, - "RemoveTransitGatewayCidrBlocks": { - "target": "com.amazonaws.ec2#TransitGatewayCidrBlockStringList", - "traits": { - "smithy.api#documentation": "

Removes CIDR blocks for the transit gateway.

" - } - }, - "VpnEcmpSupport": { - "target": "com.amazonaws.ec2#VpnEcmpSupportValue", - "traits": { - "smithy.api#documentation": "

Enable or disable Equal Cost Multipath Protocol support.

" - } - }, - "DnsSupport": { - "target": "com.amazonaws.ec2#DnsSupportValue", - "traits": { - "smithy.api#documentation": "

Enable or disable DNS support.

" - } - }, - "AutoAcceptSharedAttachments": { - "target": "com.amazonaws.ec2#AutoAcceptSharedAttachmentsValue", - "traits": { - "smithy.api#documentation": "

Enable or disable automatic acceptance of attachment requests.

" - } - }, - "DefaultRouteTableAssociation": { - "target": "com.amazonaws.ec2#DefaultRouteTableAssociationValue", - "traits": { - "smithy.api#documentation": "

Enable or disable automatic association with the default association route table.

" - } - }, - "AssociationDefaultRouteTableId": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", - "traits": { - "smithy.api#documentation": "

The ID of the default association route table.

" - } - }, - "DefaultRouteTablePropagation": { - "target": "com.amazonaws.ec2#DefaultRouteTablePropagationValue", - "traits": { - "smithy.api#documentation": "

Enable or disable automatic propagation of routes to the default propagation route table.

" - } - }, - "PropagationDefaultRouteTableId": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", - "traits": { - "smithy.api#documentation": "

The ID of the default propagation route table.

" - } - }, - "AmazonSideAsn": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

A private Autonomous System Number (ASN) for the Amazon side of a BGP session. \n The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.

\n

The modify ASN operation is not allowed on a transit gateway with active BGP sessions. You must first delete all transit gateway attachments that have BGP configured prior to modifying the ASN on the transit gateway.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The transit gateway options.

" - } - }, - "com.amazonaws.ec2#ModifyTransitGatewayPrefixListReference": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyTransitGatewayPrefixListReferenceRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyTransitGatewayPrefixListReferenceResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies a reference (route) to a prefix list in a specified transit gateway route table.

" - } - }, - "com.amazonaws.ec2#ModifyTransitGatewayPrefixListReferenceRequest": { - "type": "structure", - "members": { - "TransitGatewayRouteTableId": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the transit gateway route table.

", - "smithy.api#required": {} - } - }, - "PrefixListId": { - "target": "com.amazonaws.ec2#PrefixListResourceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the prefix list.

", - "smithy.api#required": {} - } - }, - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", - "traits": { - "smithy.api#documentation": "

The ID of the attachment to which traffic is routed.

" - } - }, - "Blackhole": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to drop traffic that matches this route.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyTransitGatewayPrefixListReferenceResult": { - "type": "structure", - "members": { - "TransitGatewayPrefixListReference": { - "target": "com.amazonaws.ec2#TransitGatewayPrefixListReference", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayPrefixListReference", - "smithy.api#documentation": "

Information about the prefix list reference.

", - "smithy.api#xmlName": "transitGatewayPrefixListReference" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyTransitGatewayRequest": { - "type": "structure", - "members": { - "TransitGatewayId": { - "target": "com.amazonaws.ec2#TransitGatewayId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the transit gateway.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The description for the transit gateway.

" - } - }, - "Options": { - "target": "com.amazonaws.ec2#ModifyTransitGatewayOptions", - "traits": { - "smithy.api#documentation": "

The options to modify.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyTransitGatewayResult": { - "type": "structure", - "members": { - "TransitGateway": { - "target": "com.amazonaws.ec2#TransitGateway", - "traits": { - "aws.protocols#ec2QueryName": "TransitGateway", - "smithy.api#documentation": "

Information about the transit gateway.

", - "smithy.api#xmlName": "transitGateway" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyTransitGatewayVpcAttachment": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyTransitGatewayVpcAttachmentRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyTransitGatewayVpcAttachmentResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies the specified VPC attachment.

" - } - }, - "com.amazonaws.ec2#ModifyTransitGatewayVpcAttachmentRequest": { - "type": "structure", - "members": { - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the attachment.

", - "smithy.api#required": {} - } - }, - "AddSubnetIds": { - "target": "com.amazonaws.ec2#TransitGatewaySubnetIdList", - "traits": { - "smithy.api#documentation": "

The IDs of one or more subnets to add. You can specify at most one subnet per Availability Zone.

" - } - }, - "RemoveSubnetIds": { - "target": "com.amazonaws.ec2#TransitGatewaySubnetIdList", - "traits": { - "smithy.api#documentation": "

The IDs of one or more subnets to remove.

" - } - }, - "Options": { - "target": "com.amazonaws.ec2#ModifyTransitGatewayVpcAttachmentRequestOptions", - "traits": { - "smithy.api#documentation": "

The new VPC attachment options.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyTransitGatewayVpcAttachmentRequestOptions": { - "type": "structure", - "members": { - "DnsSupport": { - "target": "com.amazonaws.ec2#DnsSupportValue", - "traits": { - "smithy.api#documentation": "

Enable or disable DNS support. The default is enable.

" - } - }, - "Ipv6Support": { - "target": "com.amazonaws.ec2#Ipv6SupportValue", - "traits": { - "smithy.api#documentation": "

Enable or disable IPv6 support. The default is enable.

" - } - }, - "ApplianceModeSupport": { - "target": "com.amazonaws.ec2#ApplianceModeSupportValue", - "traits": { - "smithy.api#documentation": "

Enable or disable support for appliance mode. If enabled, a traffic flow between a source and destination uses the same Availability Zone for the VPC attachment for the lifetime of that flow. The default is disable.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the options for a VPC attachment.

" - } - }, - "com.amazonaws.ec2#ModifyTransitGatewayVpcAttachmentResult": { - "type": "structure", - "members": { - "TransitGatewayVpcAttachment": { - "target": "com.amazonaws.ec2#TransitGatewayVpcAttachment", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayVpcAttachment", - "smithy.api#documentation": "

Information about the modified attachment.

", - "smithy.api#xmlName": "transitGatewayVpcAttachment" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyVerifiedAccessEndpoint": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyVerifiedAccessEndpointRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyVerifiedAccessEndpointResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies the configuration of the specified Amazon Web Services Verified Access endpoint.

" - } - }, - "com.amazonaws.ec2#ModifyVerifiedAccessEndpointEniOptions": { - "type": "structure", - "members": { - "Protocol": { - "target": "com.amazonaws.ec2#VerifiedAccessEndpointProtocol", - "traits": { - "smithy.api#documentation": "

The IP protocol.

" - } - }, - "Port": { - "target": "com.amazonaws.ec2#VerifiedAccessEndpointPortNumber", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The IP port number.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the options when modifying a Verified Access endpoint with the\n network-interface type.

" - } - }, - "com.amazonaws.ec2#ModifyVerifiedAccessEndpointLoadBalancerOptions": { - "type": "structure", - "members": { - "SubnetIds": { - "target": "com.amazonaws.ec2#ModifyVerifiedAccessEndpointSubnetIdList", - "traits": { - "smithy.api#documentation": "

The IDs of the subnets.

", - "smithy.api#xmlName": "SubnetId" - } - }, - "Protocol": { - "target": "com.amazonaws.ec2#VerifiedAccessEndpointProtocol", - "traits": { - "smithy.api#documentation": "

The IP protocol.

" - } - }, - "Port": { - "target": "com.amazonaws.ec2#VerifiedAccessEndpointPortNumber", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The IP port number.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a load balancer when creating an Amazon Web Services Verified Access endpoint using the\n load-balancer type.

" - } - }, - "com.amazonaws.ec2#ModifyVerifiedAccessEndpointPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyVerifiedAccessEndpointPolicyRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyVerifiedAccessEndpointPolicyResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies the specified Amazon Web Services Verified Access endpoint policy.

" - } - }, - "com.amazonaws.ec2#ModifyVerifiedAccessEndpointPolicyRequest": { - "type": "structure", - "members": { - "VerifiedAccessEndpointId": { - "target": "com.amazonaws.ec2#VerifiedAccessEndpointId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Verified Access endpoint.

", - "smithy.api#required": {} - } - }, - "PolicyEnabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

The status of the Verified Access policy.

", - "smithy.api#required": {} - } - }, - "PolicyDocument": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The Verified Access policy document.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.

", - "smithy.api#idempotencyToken": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyVerifiedAccessEndpointPolicyResult": { - "type": "structure", - "members": { - "PolicyEnabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "PolicyEnabled", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

The status of the Verified Access policy.

", - "smithy.api#xmlName": "policyEnabled" - } - }, - "PolicyDocument": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PolicyDocument", - "smithy.api#documentation": "

The Verified Access policy document.

", - "smithy.api#xmlName": "policyDocument" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyVerifiedAccessEndpointRequest": { - "type": "structure", - "members": { - "VerifiedAccessEndpointId": { - "target": "com.amazonaws.ec2#VerifiedAccessEndpointId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Verified Access endpoint.

", - "smithy.api#required": {} - } - }, - "VerifiedAccessGroupId": { - "target": "com.amazonaws.ec2#VerifiedAccessGroupId", - "traits": { - "smithy.api#documentation": "

The ID of the Verified Access group.

" - } - }, - "LoadBalancerOptions": { - "target": "com.amazonaws.ec2#ModifyVerifiedAccessEndpointLoadBalancerOptions", - "traits": { - "smithy.api#documentation": "

The load balancer details if creating the Verified Access endpoint as\n load-balancertype.

" - } - }, - "NetworkInterfaceOptions": { - "target": "com.amazonaws.ec2#ModifyVerifiedAccessEndpointEniOptions", - "traits": { - "smithy.api#documentation": "

The network interface options.

" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A description for the Verified Access endpoint.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.

", - "smithy.api#idempotencyToken": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyVerifiedAccessEndpointResult": { - "type": "structure", - "members": { - "VerifiedAccessEndpoint": { - "target": "com.amazonaws.ec2#VerifiedAccessEndpoint", - "traits": { - "aws.protocols#ec2QueryName": "VerifiedAccessEndpoint", - "smithy.api#documentation": "

The Verified Access endpoint details.

", - "smithy.api#xmlName": "verifiedAccessEndpoint" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyVerifiedAccessEndpointSubnetIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SubnetId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ModifyVerifiedAccessGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyVerifiedAccessGroupRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyVerifiedAccessGroupResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies the specified Amazon Web Services Verified Access group configuration.

" - } - }, - "com.amazonaws.ec2#ModifyVerifiedAccessGroupPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyVerifiedAccessGroupPolicyRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyVerifiedAccessGroupPolicyResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies the specified Amazon Web Services Verified Access group policy.

" - } - }, - "com.amazonaws.ec2#ModifyVerifiedAccessGroupPolicyRequest": { - "type": "structure", - "members": { - "VerifiedAccessGroupId": { - "target": "com.amazonaws.ec2#VerifiedAccessGroupId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Verified Access group.

", - "smithy.api#required": {} - } - }, - "PolicyEnabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

The status of the Verified Access policy.

", - "smithy.api#required": {} - } - }, - "PolicyDocument": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The Verified Access policy document.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.

", - "smithy.api#idempotencyToken": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyVerifiedAccessGroupPolicyResult": { - "type": "structure", - "members": { - "PolicyEnabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "PolicyEnabled", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

The status of the Verified Access policy.

", - "smithy.api#xmlName": "policyEnabled" - } - }, - "PolicyDocument": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PolicyDocument", - "smithy.api#documentation": "

The Verified Access policy document.

", - "smithy.api#xmlName": "policyDocument" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyVerifiedAccessGroupRequest": { - "type": "structure", - "members": { - "VerifiedAccessGroupId": { - "target": "com.amazonaws.ec2#VerifiedAccessGroupId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Verified Access group.

", - "smithy.api#required": {} - } - }, - "VerifiedAccessInstanceId": { - "target": "com.amazonaws.ec2#VerifiedAccessInstanceId", - "traits": { - "smithy.api#documentation": "

The ID of the Verified Access instance.

" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A description for the Verified Access group.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.

", - "smithy.api#idempotencyToken": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyVerifiedAccessGroupResult": { - "type": "structure", - "members": { - "VerifiedAccessGroup": { - "target": "com.amazonaws.ec2#VerifiedAccessGroup", - "traits": { - "aws.protocols#ec2QueryName": "VerifiedAccessGroup", - "smithy.api#documentation": "

Details of Verified Access group.

", - "smithy.api#xmlName": "verifiedAccessGroup" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyVerifiedAccessInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyVerifiedAccessInstanceRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyVerifiedAccessInstanceResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies the configuration of the specified Amazon Web Services Verified Access instance.

" - } - }, - "com.amazonaws.ec2#ModifyVerifiedAccessInstanceLoggingConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyVerifiedAccessInstanceLoggingConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyVerifiedAccessInstanceLoggingConfigurationResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies the logging configuration for the specified Amazon Web Services Verified Access instance.

" - } - }, - "com.amazonaws.ec2#ModifyVerifiedAccessInstanceLoggingConfigurationRequest": { - "type": "structure", - "members": { - "VerifiedAccessInstanceId": { - "target": "com.amazonaws.ec2#VerifiedAccessInstanceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Verified Access instance.

", - "smithy.api#required": {} - } - }, - "AccessLogs": { - "target": "com.amazonaws.ec2#VerifiedAccessLogOptions", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The configuration options for Verified Access instances.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.

", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyVerifiedAccessInstanceLoggingConfigurationResult": { - "type": "structure", - "members": { - "LoggingConfiguration": { - "target": "com.amazonaws.ec2#VerifiedAccessInstanceLoggingConfiguration", - "traits": { - "aws.protocols#ec2QueryName": "LoggingConfiguration", - "smithy.api#documentation": "

The logging configuration for the Verified Access instance.

", - "smithy.api#xmlName": "loggingConfiguration" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyVerifiedAccessInstanceRequest": { - "type": "structure", - "members": { - "VerifiedAccessInstanceId": { - "target": "com.amazonaws.ec2#VerifiedAccessInstanceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Verified Access instance.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A description for the Verified Access instance.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.

", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyVerifiedAccessInstanceResult": { - "type": "structure", - "members": { - "VerifiedAccessInstance": { - "target": "com.amazonaws.ec2#VerifiedAccessInstance", - "traits": { - "aws.protocols#ec2QueryName": "VerifiedAccessInstance", - "smithy.api#documentation": "

The ID of the Verified Access instance.

", - "smithy.api#xmlName": "verifiedAccessInstance" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyVerifiedAccessTrustProvider": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyVerifiedAccessTrustProviderRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyVerifiedAccessTrustProviderResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies the configuration of the specified Amazon Web Services Verified Access trust provider.

" - } - }, - "com.amazonaws.ec2#ModifyVerifiedAccessTrustProviderOidcOptions": { - "type": "structure", - "members": { - "Issuer": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The OIDC issuer.

" - } - }, - "AuthorizationEndpoint": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The OIDC authorization endpoint.

" - } - }, - "TokenEndpoint": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The OIDC token endpoint.

" - } - }, - "UserInfoEndpoint": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The OIDC user info endpoint.

" - } - }, - "ClientId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The client identifier.

" - } - }, - "ClientSecret": { - "target": "com.amazonaws.ec2#ClientSecretType", - "traits": { - "smithy.api#documentation": "

The client secret.

" - } - }, - "Scope": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

OpenID Connect (OIDC) scopes are used by an application during authentication to authorize access to a user's details. Each scope returns a specific set of user attributes.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Options for an OpenID Connect-compatible user-identity trust provider.

" - } - }, - "com.amazonaws.ec2#ModifyVerifiedAccessTrustProviderRequest": { - "type": "structure", - "members": { - "VerifiedAccessTrustProviderId": { - "target": "com.amazonaws.ec2#VerifiedAccessTrustProviderId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Verified Access trust provider.

", - "smithy.api#required": {} - } - }, - "OidcOptions": { - "target": "com.amazonaws.ec2#ModifyVerifiedAccessTrustProviderOidcOptions", - "traits": { - "smithy.api#documentation": "

The options for an OpenID Connect-compatible user-identity trust provider.

" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A description for the Verified Access trust provider.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.

", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyVerifiedAccessTrustProviderResult": { - "type": "structure", - "members": { - "VerifiedAccessTrustProvider": { - "target": "com.amazonaws.ec2#VerifiedAccessTrustProvider", - "traits": { - "aws.protocols#ec2QueryName": "VerifiedAccessTrustProvider", - "smithy.api#documentation": "

The ID of the Verified Access trust provider.

", - "smithy.api#xmlName": "verifiedAccessTrustProvider" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyVolume": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyVolumeRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyVolumeResult" - }, - "traits": { - "smithy.api#documentation": "

You can modify several parameters of an existing EBS volume, including volume size, volume\n type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance\n type, you might be able to apply these changes without stopping the instance or detaching the\n volume from it. For more information about modifying EBS volumes, see Amazon EBS Elastic Volumes (Linux instances) \n or Amazon EBS Elastic Volumes (Windows instances).

\n

When you complete a resize operation on your volume, you need to extend the volume's\n file-system size to take advantage of the new storage capacity. For more information, see Extend a Linux file system or \n Extend a Windows file system.

\n

You can use CloudWatch Events to check the status of a modification to an EBS volume. For\n information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. You can also track the status of a\n modification using DescribeVolumesModifications. For information\n about tracking status changes using either method, see Monitor the progress of volume modifications.

\n

With previous-generation instance types, resizing an EBS volume might require detaching and\n reattaching the volume or stopping and restarting the instance.

\n

After modifying a volume, you must wait at least six hours and ensure that the volume \n is in the in-use or available state before you can modify the same \n volume. This is sometimes referred to as a cooldown period.

" - } - }, - "com.amazonaws.ec2#ModifyVolumeAttribute": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyVolumeAttributeRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Modifies a volume attribute.

\n

By default, all I/O operations for the volume are suspended when the data on the volume is\n determined to be potentially inconsistent, to prevent undetectable, latent data corruption.\n The I/O access to the volume can be resumed by first enabling I/O access and then checking the\n data consistency on your volume.

\n

You can change the default behavior to resume I/O operations. We recommend that you change\n this only for boot volumes or for volumes that are stateless or disposable.

" - } - }, - "com.amazonaws.ec2#ModifyVolumeAttributeRequest": { - "type": "structure", - "members": { - "AutoEnableIO": { - "target": "com.amazonaws.ec2#AttributeBooleanValue", - "traits": { - "smithy.api#documentation": "

Indicates whether the volume should be auto-enabled for I/O operations.

" - } - }, - "VolumeId": { - "target": "com.amazonaws.ec2#VolumeId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the volume.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyVolumeRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "VolumeId": { - "target": "com.amazonaws.ec2#VolumeId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the volume.

", - "smithy.api#required": {} - } - }, - "Size": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The target size of the volume, in GiB. The target volume size must be greater than or\n equal to the existing size of the volume.

\n

The following are the supported volumes sizes for each volume type:

\n \n

Default: The existing size is retained.

" - } - }, - "VolumeType": { - "target": "com.amazonaws.ec2#VolumeType", - "traits": { - "smithy.api#documentation": "

The target EBS volume type of the volume. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.

\n

Default: The existing type is retained.

" - } - }, - "Iops": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The target IOPS rate of the volume. This parameter is valid only for gp3, io1, and io2 volumes.

\n

The following are the supported values for each volume type:

\n \n

Default: The existing value is retained if you keep the same volume type. If you change\n the volume type to io1, io2, or gp3, the default is 3,000.

" - } - }, - "Throughput": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The target throughput of the volume, in MiB/s. This parameter is valid only for gp3 volumes. \n The maximum value is 1,000.

\n

Default: The existing value is retained if the source and target volume type is gp3.\n Otherwise, the default value is 125.

\n

Valid Range: Minimum value of 125. Maximum value of 1000.

" - } - }, - "MultiAttachEnabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the \n\t\tvolume to up to 16 \n\t\t\tNitro-based instances in the same Availability Zone. This parameter is \n\t\tsupported with io1 and io2 volumes only. For more information, see \n\t\t\n\t\t\tAmazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyVolumeResult": { - "type": "structure", - "members": { - "VolumeModification": { - "target": "com.amazonaws.ec2#VolumeModification", - "traits": { - "aws.protocols#ec2QueryName": "VolumeModification", - "smithy.api#documentation": "

Information about the volume modification.

", - "smithy.api#xmlName": "volumeModification" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyVpcAttribute": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyVpcAttributeRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Modifies the specified attribute of the specified VPC.

" - } - }, - "com.amazonaws.ec2#ModifyVpcAttributeRequest": { - "type": "structure", - "members": { - "EnableDnsHostnames": { - "target": "com.amazonaws.ec2#AttributeBooleanValue", - "traits": { - "smithy.api#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.

\n

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": { - "target": "com.amazonaws.ec2#AttributeBooleanValue", - "traits": { - "smithy.api#documentation": "

Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to\n\t\t\tthe Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP\n\t\t\taddress at the base of the VPC network range \"plus two\" succeed. If disabled, the Amazon\n\t\t\tprovided DNS service in the VPC that resolves public DNS hostnames to IP addresses is\n\t\t\tnot enabled.

\n

You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute.

" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "vpcId" - } - }, - "EnableNetworkAddressUsageMetrics": { - "target": "com.amazonaws.ec2#AttributeBooleanValue", - "traits": { - "smithy.api#documentation": "

Indicates whether Network Address Usage metrics are enabled for your VPC.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyVpcEndpoint": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyVpcEndpointRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyVpcEndpointResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies attributes of a specified VPC endpoint. The attributes that you can modify\n depend on the type of VPC endpoint (interface, gateway, or Gateway Load Balancer). For more information, \n see the Amazon Web Services PrivateLink \n Guide.

" - } - }, - "com.amazonaws.ec2#ModifyVpcEndpointConnectionNotification": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyVpcEndpointConnectionNotificationRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyVpcEndpointConnectionNotificationResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies a connection notification for VPC endpoint or VPC endpoint service. You\n can change the SNS topic for the notification, or the events for which to be notified.

" - } - }, - "com.amazonaws.ec2#ModifyVpcEndpointConnectionNotificationRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "ConnectionNotificationId": { - "target": "com.amazonaws.ec2#ConnectionNotificationId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the notification.

", - "smithy.api#required": {} - } - }, - "ConnectionNotificationArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The ARN for the SNS topic for the notification.

" - } - }, - "ConnectionEvents": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#documentation": "

The events for the endpoint. Valid values are Accept,\n Connect, Delete, and Reject.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyVpcEndpointConnectionNotificationResult": { - "type": "structure", - "members": { - "ReturnValue": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyVpcEndpointRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "VpcEndpointId": { - "target": "com.amazonaws.ec2#VpcEndpointId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the endpoint.

", - "smithy.api#required": {} - } - }, - "ResetPolicy": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

(Gateway endpoint) Specify true to reset the policy document to the\n default policy. The default policy allows full access to the service.

" - } - }, - "PolicyDocument": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must\n be in valid JSON format.

" - } - }, - "AddRouteTableIds": { - "target": "com.amazonaws.ec2#VpcEndpointRouteTableIdList", - "traits": { - "smithy.api#documentation": "

(Gateway endpoint) The IDs of the route tables to associate with the endpoint.

", - "smithy.api#xmlName": "AddRouteTableId" - } - }, - "RemoveRouteTableIds": { - "target": "com.amazonaws.ec2#VpcEndpointRouteTableIdList", - "traits": { - "smithy.api#documentation": "

(Gateway endpoint) The IDs of the route tables to disassociate from the endpoint.

", - "smithy.api#xmlName": "RemoveRouteTableId" - } - }, - "AddSubnetIds": { - "target": "com.amazonaws.ec2#VpcEndpointSubnetIdList", - "traits": { - "smithy.api#documentation": "

(Interface and Gateway Load Balancer endpoints) The IDs of the subnets in which to serve the endpoint. \n For a Gateway Load Balancer endpoint, you can specify only one subnet.

", - "smithy.api#xmlName": "AddSubnetId" - } - }, - "RemoveSubnetIds": { - "target": "com.amazonaws.ec2#VpcEndpointSubnetIdList", - "traits": { - "smithy.api#documentation": "

(Interface endpoint) The IDs of the subnets from which to remove the endpoint.

", - "smithy.api#xmlName": "RemoveSubnetId" - } - }, - "AddSecurityGroupIds": { - "target": "com.amazonaws.ec2#VpcEndpointSecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

(Interface endpoint) The IDs of the security groups to associate with the network interface.

", - "smithy.api#xmlName": "AddSecurityGroupId" - } - }, - "RemoveSecurityGroupIds": { - "target": "com.amazonaws.ec2#VpcEndpointSecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

(Interface endpoint) The IDs of the security groups to disassociate from the network interface.

", - "smithy.api#xmlName": "RemoveSecurityGroupId" - } - }, - "IpAddressType": { - "target": "com.amazonaws.ec2#IpAddressType", - "traits": { - "smithy.api#documentation": "

The IP address type for the endpoint.

" - } - }, - "DnsOptions": { - "target": "com.amazonaws.ec2#DnsOptionsSpecification", - "traits": { - "smithy.api#documentation": "

The DNS options for the endpoint.

" - } - }, - "PrivateDnsEnabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

(Interface endpoint) Indicates whether a private hosted zone is associated with the\n VPC.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyVpcEndpointResult": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyVpcEndpointServiceConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyVpcEndpointServiceConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyVpcEndpointServiceConfigurationResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies the attributes of your VPC endpoint service configuration. You can change the\n Network Load Balancers or Gateway Load Balancers for your service, and you can specify whether acceptance is\n required for requests to connect to your endpoint service through an interface VPC\n endpoint.

\n

If you set or modify the private DNS name, you must prove that you own the private DNS\n domain name.

" - } - }, - "com.amazonaws.ec2#ModifyVpcEndpointServiceConfigurationRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "ServiceId": { - "target": "com.amazonaws.ec2#VpcEndpointServiceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the service.

", - "smithy.api#required": {} - } - }, - "PrivateDnsName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

(Interface endpoint configuration) The private DNS name to assign to the endpoint service.

" - } - }, - "RemovePrivateDnsName": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

(Interface endpoint configuration) Removes the private DNS name of the endpoint service.

" - } - }, - "AcceptanceRequired": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether requests to create an endpoint to your service must be accepted.

" - } - }, - "AddNetworkLoadBalancerArns": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of Network Load Balancers to add to your service\n configuration.

", - "smithy.api#xmlName": "AddNetworkLoadBalancerArn" - } - }, - "RemoveNetworkLoadBalancerArns": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your service\n configuration.

", - "smithy.api#xmlName": "RemoveNetworkLoadBalancerArn" - } - }, - "AddGatewayLoadBalancerArns": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of Gateway Load Balancers to add to your service\n configuration.

", - "smithy.api#xmlName": "AddGatewayLoadBalancerArn" - } - }, - "RemoveGatewayLoadBalancerArns": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of Gateway Load Balancers to remove from your service\n configuration.

", - "smithy.api#xmlName": "RemoveGatewayLoadBalancerArn" - } - }, - "AddSupportedIpAddressTypes": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#documentation": "

The IP address types to add to your service configuration.

", - "smithy.api#xmlName": "AddSupportedIpAddressType" - } - }, - "RemoveSupportedIpAddressTypes": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#documentation": "

The IP address types to remove from your service configuration.

", - "smithy.api#xmlName": "RemoveSupportedIpAddressType" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyVpcEndpointServiceConfigurationResult": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyVpcEndpointServicePayerResponsibility": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyVpcEndpointServicePayerResponsibilityRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyVpcEndpointServicePayerResponsibilityResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies the payer responsibility for your VPC endpoint service.

" - } - }, - "com.amazonaws.ec2#ModifyVpcEndpointServicePayerResponsibilityRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "ServiceId": { - "target": "com.amazonaws.ec2#VpcEndpointServiceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the service.

", - "smithy.api#required": {} - } - }, - "PayerResponsibility": { - "target": "com.amazonaws.ec2#PayerResponsibility", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The entity that is responsible for the endpoint costs. The default is the endpoint owner.\n If you set the payer responsibility to the service owner, you cannot set it back to the\n endpoint owner.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyVpcEndpointServicePayerResponsibilityResult": { - "type": "structure", - "members": { - "ReturnValue": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyVpcEndpointServicePermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyVpcEndpointServicePermissionsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyVpcEndpointServicePermissionsResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies the permissions for your VPC endpoint service. You can add or remove permissions\n for service consumers (Amazon Web Services accounts, users, and IAM roles) to connect to\n your endpoint service.

\n

If you grant permissions to all principals, the service is public. Any users who know the name of a\n\t public service can send a request to attach an endpoint. If the service does not require manual approval,\n\t attachments are automatically approved.

" - } - }, - "com.amazonaws.ec2#ModifyVpcEndpointServicePermissionsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "ServiceId": { - "target": "com.amazonaws.ec2#VpcEndpointServiceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the service.

", - "smithy.api#required": {} - } - }, - "AddAllowedPrincipals": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the principals.\n\t Permissions are granted to the principals in this list.\n\t To grant permissions to all principals, specify an asterisk (*).

" - } - }, - "RemoveAllowedPrincipals": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the principals.\n\t Permissions are revoked for principals in this list.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyVpcEndpointServicePermissionsResult": { - "type": "structure", - "members": { - "AddedPrincipals": { - "target": "com.amazonaws.ec2#AddedPrincipalSet", - "traits": { - "aws.protocols#ec2QueryName": "AddedPrincipalSet", - "smithy.api#documentation": "

Information about the added principals.

", - "smithy.api#xmlName": "addedPrincipalSet" - } - }, - "ReturnValue": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyVpcPeeringConnectionOptions": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyVpcPeeringConnectionOptionsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyVpcPeeringConnectionOptionsResult" - }, - "traits": { - "smithy.api#documentation": "\n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n \n

Modifies the VPC peering connection options on one side of a VPC peering connection. You can do the following:

\n \n

If the peered VPCs are in the same Amazon Web Services account, you can enable DNS\n resolution for queries from the local VPC. This ensures that queries from the local VPC\n resolve to private IP addresses in the peer VPC. This option is not available if the\n peered VPCs are in different Amazon Web Services accounts or different Regions. For\n peered VPCs in different Amazon Web Services accounts, each Amazon Web Services account\n owner must initiate a separate request to modify the peering connection options. For\n inter-region peering connections, you must use the Region for the requester VPC to\n modify the requester VPC peering options and the Region for the accepter VPC to modify\n the accepter VPC peering options. To verify which VPCs are the accepter and the\n requester for a VPC peering connection, use the DescribeVpcPeeringConnections command.

" - } - }, - "com.amazonaws.ec2#ModifyVpcPeeringConnectionOptionsRequest": { - "type": "structure", - "members": { - "AccepterPeeringConnectionOptions": { - "target": "com.amazonaws.ec2#PeeringConnectionOptionsRequest", - "traits": { - "smithy.api#documentation": "

The VPC peering connection options for the accepter VPC.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "RequesterPeeringConnectionOptions": { - "target": "com.amazonaws.ec2#PeeringConnectionOptionsRequest", - "traits": { - "smithy.api#documentation": "

The VPC peering connection options for the requester VPC.

" - } - }, - "VpcPeeringConnectionId": { - "target": "com.amazonaws.ec2#VpcPeeringConnectionId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the VPC peering connection.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyVpcPeeringConnectionOptionsResult": { - "type": "structure", - "members": { - "AccepterPeeringConnectionOptions": { - "target": "com.amazonaws.ec2#PeeringConnectionOptions", - "traits": { - "aws.protocols#ec2QueryName": "AccepterPeeringConnectionOptions", - "smithy.api#documentation": "

Information about the VPC peering connection options for the accepter VPC.

", - "smithy.api#xmlName": "accepterPeeringConnectionOptions" - } - }, - "RequesterPeeringConnectionOptions": { - "target": "com.amazonaws.ec2#PeeringConnectionOptions", - "traits": { - "aws.protocols#ec2QueryName": "RequesterPeeringConnectionOptions", - "smithy.api#documentation": "

Information about the VPC peering connection options for the requester VPC.

", - "smithy.api#xmlName": "requesterPeeringConnectionOptions" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyVpcTenancy": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyVpcTenancyRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyVpcTenancyResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies the instance tenancy attribute of the specified VPC. You can change the\n instance tenancy attribute of a VPC to default only. You cannot change the\n instance tenancy attribute to dedicated.

\n

After you modify the tenancy of the VPC, any new instances that you launch into the\n VPC have a tenancy of default, unless you specify otherwise during launch.\n The tenancy of any existing instances in the VPC is not affected.

\n

For more information, see Dedicated Instances in the\n\t\t\t\tAmazon Elastic Compute Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#ModifyVpcTenancyRequest": { - "type": "structure", - "members": { - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#required": {} - } - }, - "InstanceTenancy": { - "target": "com.amazonaws.ec2#VpcTenancy", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The instance tenancy attribute for the VPC.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyVpcTenancyResult": { - "type": "structure", - "members": { - "ReturnValue": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, returns an\n error.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyVpnConnection": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyVpnConnectionRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyVpnConnectionResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies the customer gateway or the target gateway of an Amazon Web Services Site-to-Site VPN connection. To\n modify the target gateway, the following migration options are available:

\n \n

Before you perform the migration to the new gateway, you must configure the new\n gateway. Use CreateVpnGateway to create a virtual private gateway, or\n CreateTransitGateway to create a transit gateway.

\n

This step is required when you migrate from a virtual private gateway with static\n routes to a transit gateway.

\n

You must delete the static routes before you migrate to the new gateway.

\n

Keep a copy of the static route before you delete it. You will need to add back these\n routes to the transit gateway after the VPN connection migration is complete.

\n

After you migrate to the new gateway, you might need to modify your VPC route table.\n Use CreateRoute and DeleteRoute to make the changes\n described in Update VPC route\n tables in the Amazon Web Services Site-to-Site VPN User Guide.

\n

When the new gateway is a transit gateway, modify the transit gateway route table to\n allow traffic between the VPC and the Amazon Web Services Site-to-Site VPN connection.\n Use CreateTransitGatewayRoute to add the routes.

\n

If you deleted VPN static routes, you must add the static routes to the transit\n gateway route table.

\n

After you perform this operation, the VPN endpoint's IP addresses on the Amazon Web Services side and the tunnel options remain intact. Your Amazon Web Services Site-to-Site VPN connection will\n be temporarily unavailable for a brief period while we provision the new\n endpoints.

" - } - }, - "com.amazonaws.ec2#ModifyVpnConnectionOptions": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyVpnConnectionOptionsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyVpnConnectionOptionsResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies the connection options for your Site-to-Site VPN connection.

\n

When you modify the VPN connection options, the VPN endpoint IP addresses on the\n Amazon Web Services side do not change, and the tunnel options do not change. Your\n VPN connection will be temporarily unavailable for a brief period while the VPN\n connection is updated.

" - } - }, - "com.amazonaws.ec2#ModifyVpnConnectionOptionsRequest": { - "type": "structure", - "members": { - "VpnConnectionId": { - "target": "com.amazonaws.ec2#VpnConnectionId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Site-to-Site VPN connection.

", - "smithy.api#required": {} - } - }, - "LocalIpv4NetworkCidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.

\n

Default: 0.0.0.0/0\n

" - } - }, - "RemoteIpv4NetworkCidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The IPv4 CIDR on the Amazon Web Services side of the VPN connection.

\n

Default: 0.0.0.0/0\n

" - } - }, - "LocalIpv6NetworkCidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.

\n

Default: ::/0\n

" - } - }, - "RemoteIpv6NetworkCidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The IPv6 CIDR on the Amazon Web Services side of the VPN connection.

\n

Default: ::/0\n

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyVpnConnectionOptionsResult": { - "type": "structure", - "members": { - "VpnConnection": { - "target": "com.amazonaws.ec2#VpnConnection", - "traits": { - "aws.protocols#ec2QueryName": "VpnConnection", - "smithy.api#documentation": "

Information about the VPN connection.

", - "smithy.api#xmlName": "vpnConnection" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyVpnConnectionRequest": { - "type": "structure", - "members": { - "VpnConnectionId": { - "target": "com.amazonaws.ec2#VpnConnectionId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the VPN connection.

", - "smithy.api#required": {} - } - }, - "TransitGatewayId": { - "target": "com.amazonaws.ec2#TransitGatewayId", - "traits": { - "smithy.api#documentation": "

The ID of the transit gateway.

" - } - }, - "CustomerGatewayId": { - "target": "com.amazonaws.ec2#CustomerGatewayId", - "traits": { - "smithy.api#documentation": "

The ID of the customer gateway at your end of the VPN connection.

" - } - }, - "VpnGatewayId": { - "target": "com.amazonaws.ec2#VpnGatewayId", - "traits": { - "smithy.api#documentation": "

The ID of the virtual private gateway at the Amazon Web Services side of the VPN\n connection.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyVpnConnectionResult": { - "type": "structure", - "members": { - "VpnConnection": { - "target": "com.amazonaws.ec2#VpnConnection", - "traits": { - "aws.protocols#ec2QueryName": "VpnConnection", - "smithy.api#documentation": "

Information about the VPN connection.

", - "smithy.api#xmlName": "vpnConnection" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyVpnTunnelCertificate": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyVpnTunnelCertificateRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyVpnTunnelCertificateResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies the VPN tunnel endpoint certificate.

" - } - }, - "com.amazonaws.ec2#ModifyVpnTunnelCertificateRequest": { - "type": "structure", - "members": { - "VpnConnectionId": { - "target": "com.amazonaws.ec2#VpnConnectionId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Amazon Web Services Site-to-Site VPN connection.

", - "smithy.api#required": {} - } - }, - "VpnTunnelOutsideIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The external IP address of the VPN tunnel.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyVpnTunnelCertificateResult": { - "type": "structure", - "members": { - "VpnConnection": { - "target": "com.amazonaws.ec2#VpnConnection", - "traits": { - "aws.protocols#ec2QueryName": "VpnConnection", - "smithy.api#documentation": "

Information about the VPN connection.

", - "smithy.api#xmlName": "vpnConnection" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyVpnTunnelOptions": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ModifyVpnTunnelOptionsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ModifyVpnTunnelOptionsResult" - }, - "traits": { - "smithy.api#documentation": "

Modifies the options for a VPN tunnel in an Amazon Web Services Site-to-Site VPN connection. You can modify\n multiple options for a tunnel in a single request, but you can only modify one tunnel at\n a time. For more information, see Site-to-Site VPN tunnel options for your Site-to-Site VPN\n connection in the Amazon Web Services Site-to-Site VPN User Guide.

" - } - }, - "com.amazonaws.ec2#ModifyVpnTunnelOptionsRequest": { - "type": "structure", - "members": { - "VpnConnectionId": { - "target": "com.amazonaws.ec2#VpnConnectionId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Amazon Web Services Site-to-Site VPN connection.

", - "smithy.api#required": {} - } - }, - "VpnTunnelOutsideIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The external IP address of the VPN tunnel.

", - "smithy.api#required": {} - } - }, - "TunnelOptions": { - "target": "com.amazonaws.ec2#ModifyVpnTunnelOptionsSpecification", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The tunnel options to modify.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" - } - }, - "SkipTunnelReplacement": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Choose whether or not to trigger immediate tunnel replacement.

\n

Valid values: True | False\n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ModifyVpnTunnelOptionsResult": { - "type": "structure", - "members": { - "VpnConnection": { - "target": "com.amazonaws.ec2#VpnConnection", - "traits": { - "aws.protocols#ec2QueryName": "VpnConnection", - "smithy.api#documentation": "

Information about the VPN connection.

", - "smithy.api#xmlName": "vpnConnection" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ModifyVpnTunnelOptionsSpecification": { - "type": "structure", - "members": { - "TunnelInsideCidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be\n unique across all VPN connections that use the same virtual private gateway.

\n

Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The\n following CIDR blocks are reserved and cannot be used:

\n " - } - }, - "TunnelInsideIpv6Cidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be\n unique across all VPN connections that use the same transit gateway.

\n

Constraints: A size /126 CIDR block from the local fd00::/8 range.

" - } - }, - "PreSharedKey": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The pre-shared key (PSK) to establish initial authentication between the virtual\n private gateway and the customer gateway.

\n

Constraints: Allowed characters are alphanumeric characters, periods (.), and\n underscores (_). Must be between 8 and 64 characters in length and cannot start with\n zero (0).

" - } - }, - "Phase1LifetimeSeconds": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The lifetime for phase 1 of the IKE negotiation, in seconds.

\n

Constraints: A value between 900 and 28,800.

\n

Default: 28800\n

" - } - }, - "Phase2LifetimeSeconds": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The lifetime for phase 2 of the IKE negotiation, in seconds.

\n

Constraints: A value between 900 and 3,600. The value must be less than the value for\n Phase1LifetimeSeconds.

\n

Default: 3600\n

" - } - }, - "RekeyMarginTimeSeconds": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The margin time, in seconds, before the phase 2 lifetime expires, during which the\n Amazon Web Services side of the VPN connection performs an IKE rekey. The exact time\n of the rekey is randomly selected based on the value for\n RekeyFuzzPercentage.

\n

Constraints: A value between 60 and half of Phase2LifetimeSeconds.

\n

Default: 540\n

" - } - }, - "RekeyFuzzPercentage": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The percentage of the rekey window (determined by RekeyMarginTimeSeconds)\n during which the rekey time is randomly selected.

\n

Constraints: A value between 0 and 100.

\n

Default: 100\n

" - } - }, - "ReplayWindowSize": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of packets in an IKE replay window.

\n

Constraints: A value between 64 and 2048.

\n

Default: 1024\n

" - } - }, - "DPDTimeoutSeconds": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of seconds after which a DPD timeout occurs.

\n

Constraints: A value greater than or equal to 30.

\n

Default: 30\n

" - } - }, - "DPDTimeoutAction": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The action to take after DPD timeout occurs. Specify restart to restart\n the IKE initiation. Specify clear to end the IKE session.

\n

Valid Values: clear | none | restart\n

\n

Default: clear\n

" - } - }, - "Phase1EncryptionAlgorithms": { - "target": "com.amazonaws.ec2#Phase1EncryptionAlgorithmsRequestList", - "traits": { - "smithy.api#documentation": "

One or more encryption algorithms that are permitted for the VPN tunnel for phase 1\n IKE negotiations.

\n

Valid values: AES128 | AES256 | AES128-GCM-16 |\n AES256-GCM-16\n

", - "smithy.api#xmlName": "Phase1EncryptionAlgorithm" - } - }, - "Phase2EncryptionAlgorithms": { - "target": "com.amazonaws.ec2#Phase2EncryptionAlgorithmsRequestList", - "traits": { - "smithy.api#documentation": "

One or more encryption algorithms that are permitted for the VPN tunnel for phase 2\n IKE negotiations.

\n

Valid values: AES128 | AES256 | AES128-GCM-16 |\n AES256-GCM-16\n

", - "smithy.api#xmlName": "Phase2EncryptionAlgorithm" - } - }, - "Phase1IntegrityAlgorithms": { - "target": "com.amazonaws.ec2#Phase1IntegrityAlgorithmsRequestList", - "traits": { - "smithy.api#documentation": "

One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE\n negotiations.

\n

Valid values: SHA1 | SHA2-256 | SHA2-384 |\n SHA2-512\n

", - "smithy.api#xmlName": "Phase1IntegrityAlgorithm" - } - }, - "Phase2IntegrityAlgorithms": { - "target": "com.amazonaws.ec2#Phase2IntegrityAlgorithmsRequestList", - "traits": { - "smithy.api#documentation": "

One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE\n negotiations.

\n

Valid values: SHA1 | SHA2-256 | SHA2-384 |\n SHA2-512\n

", - "smithy.api#xmlName": "Phase2IntegrityAlgorithm" - } - }, - "Phase1DHGroupNumbers": { - "target": "com.amazonaws.ec2#Phase1DHGroupNumbersRequestList", - "traits": { - "smithy.api#documentation": "

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for\n phase 1 IKE negotiations.

\n

Valid values: 2 | 14 | 15 | 16 |\n 17 | 18 | 19 | 20 |\n 21 | 22 | 23 | 24\n

", - "smithy.api#xmlName": "Phase1DHGroupNumber" - } - }, - "Phase2DHGroupNumbers": { - "target": "com.amazonaws.ec2#Phase2DHGroupNumbersRequestList", - "traits": { - "smithy.api#documentation": "

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for\n phase 2 IKE negotiations.

\n

Valid values: 2 | 5 | 14 | 15 |\n 16 | 17 | 18 | 19 |\n 20 | 21 | 22 | 23 |\n 24\n

", - "smithy.api#xmlName": "Phase2DHGroupNumber" - } - }, - "IKEVersions": { - "target": "com.amazonaws.ec2#IKEVersionsRequestList", - "traits": { - "smithy.api#documentation": "

The IKE versions that are permitted for the VPN tunnel.

\n

Valid values: ikev1 | ikev2\n

", - "smithy.api#xmlName": "IKEVersion" - } - }, - "StartupAction": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The action to take when the establishing the tunnel for the VPN connection. By\n default, your customer gateway device must initiate the IKE negotiation and bring up the\n tunnel. Specify start for Amazon Web Services to initiate the IKE\n negotiation.

\n

Valid Values: add | start\n

\n

Default: add\n

" - } - }, - "LogOptions": { - "target": "com.amazonaws.ec2#VpnTunnelLogOptionsSpecification", - "traits": { - "smithy.api#documentation": "

Options for logging VPN tunnel activity.

" - } - }, - "EnableTunnelLifecycleControl": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Turn on or off tunnel endpoint lifecycle control feature.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Site-to-Site VPN tunnel options to modify.

" - } - }, - "com.amazonaws.ec2#MonitorInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#MonitorInstancesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#MonitorInstancesResult" - }, - "traits": { - "smithy.api#documentation": "

Enables detailed monitoring for a running instance. Otherwise, basic monitoring is\n enabled. For more information, see Monitor your instances using\n CloudWatch in the Amazon EC2 User Guide.

\n

To disable detailed monitoring, see UnmonitorInstances.

" - } - }, - "com.amazonaws.ec2#MonitorInstancesRequest": { - "type": "structure", - "members": { - "InstanceIds": { - "target": "com.amazonaws.ec2#InstanceIdStringList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IDs of the instances.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "InstanceId" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#MonitorInstancesResult": { - "type": "structure", - "members": { - "InstanceMonitorings": { - "target": "com.amazonaws.ec2#InstanceMonitoringList", - "traits": { - "aws.protocols#ec2QueryName": "InstancesSet", - "smithy.api#documentation": "

The monitoring information.

", - "smithy.api#xmlName": "instancesSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#Monitoring": { - "type": "structure", - "members": { - "State": { - "target": "com.amazonaws.ec2#MonitoringState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is\n enabled.

", - "smithy.api#xmlName": "state" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the monitoring of an instance.

" - } - }, - "com.amazonaws.ec2#MonitoringState": { - "type": "enum", - "members": { - "disabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disabled" - } - }, - "disabling": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disabling" - } - }, - "enabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enabled" - } - }, - "pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - } - } - }, - "com.amazonaws.ec2#MoveAddressToVpc": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#MoveAddressToVpcRequest" - }, - "output": { - "target": "com.amazonaws.ec2#MoveAddressToVpcResult" - }, - "traits": { - "smithy.api#documentation": "

Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The\n Elastic IP address must be allocated to your account for more than 24 hours, and it must not\n be associated with an instance. After the Elastic IP address is moved, it is no longer\n available for use in the EC2-Classic platform, unless you move it back using the\n RestoreAddressToClassic request. You cannot move an Elastic IP address that was\n originally allocated for use in the EC2-VPC platform to the EC2-Classic platform.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " - } - }, - "com.amazonaws.ec2#MoveAddressToVpcRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "PublicIp": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PublicIp", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Elastic IP address.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "publicIp" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#MoveAddressToVpcResult": { - "type": "structure", - "members": { - "AllocationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AllocationId", - "smithy.api#documentation": "

The allocation ID for the Elastic IP address.

", - "smithy.api#xmlName": "allocationId" - } - }, - "Status": { - "target": "com.amazonaws.ec2#Status", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The status of the move of the IP address.

", - "smithy.api#xmlName": "status" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#MoveByoipCidrToIpam": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#MoveByoipCidrToIpamRequest" - }, - "output": { - "target": "com.amazonaws.ec2#MoveByoipCidrToIpamResult" - }, - "traits": { - "smithy.api#documentation": "

Move a BYOIPv4 CIDR to IPAM from a public IPv4 pool.

\n

If you already have a BYOIPv4 CIDR with Amazon Web Services, you can move the CIDR to IPAM from a public IPv4 pool. You cannot move an IPv6 CIDR to IPAM. If you are bringing a new IP address to Amazon Web Services for the first time, complete the steps in Tutorial: BYOIP address CIDRs to IPAM.

" - } - }, - "com.amazonaws.ec2#MoveByoipCidrToIpamRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "Cidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The BYOIP CIDR.

", - "smithy.api#required": {} - } - }, - "IpamPoolId": { - "target": "com.amazonaws.ec2#IpamPoolId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IPAM pool ID.

", - "smithy.api#required": {} - } - }, - "IpamPoolOwner": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the IPAM pool.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#MoveByoipCidrToIpamResult": { - "type": "structure", - "members": { - "ByoipCidr": { - "target": "com.amazonaws.ec2#ByoipCidr", - "traits": { - "aws.protocols#ec2QueryName": "ByoipCidr", - "smithy.api#documentation": "

The BYOIP CIDR.

", - "smithy.api#xmlName": "byoipCidr" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#MoveStatus": { - "type": "enum", - "members": { - "movingToVpc": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "movingToVpc" - } - }, - "restoringToClassic": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "restoringToClassic" - } - } - } - }, - "com.amazonaws.ec2#MovingAddressStatus": { - "type": "structure", - "members": { - "MoveStatus": { - "target": "com.amazonaws.ec2#MoveStatus", - "traits": { - "aws.protocols#ec2QueryName": "MoveStatus", - "smithy.api#documentation": "

The status of the Elastic IP address that's being moved to the EC2-VPC platform, or restored to the EC2-Classic platform.

", - "smithy.api#xmlName": "moveStatus" - } - }, - "PublicIp": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PublicIp", - "smithy.api#documentation": "

The Elastic IP address.

", - "smithy.api#xmlName": "publicIp" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the status of a moving Elastic IP address.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " - } - }, - "com.amazonaws.ec2#MovingAddressStatusSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#MovingAddressStatus", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#MulticastSupportValue": { - "type": "enum", - "members": { - "enable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enable" - } - }, - "disable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disable" - } - } - } - }, - "com.amazonaws.ec2#NatGateway": { - "type": "structure", - "members": { - "CreateTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "CreateTime", - "smithy.api#documentation": "

The date and time the NAT gateway was created.

", - "smithy.api#xmlName": "createTime" - } - }, - "DeleteTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "DeleteTime", - "smithy.api#documentation": "

The date and time the NAT gateway was deleted, if applicable.

", - "smithy.api#xmlName": "deleteTime" - } - }, - "FailureCode": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "FailureCode", - "smithy.api#documentation": "

If the NAT gateway could not be created, specifies the error code for the failure.\n (InsufficientFreeAddressesInSubnet | Gateway.NotAttached |\n InvalidAllocationID.NotFound | Resource.AlreadyAssociated |\n InternalError | InvalidSubnetID.NotFound)

", - "smithy.api#xmlName": "failureCode" - } - }, - "FailureMessage": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "FailureMessage", - "smithy.api#documentation": "

If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.

\n ", - "smithy.api#xmlName": "failureMessage" - } - }, - "NatGatewayAddresses": { - "target": "com.amazonaws.ec2#NatGatewayAddressList", - "traits": { - "aws.protocols#ec2QueryName": "NatGatewayAddressSet", - "smithy.api#documentation": "

Information about the IP addresses and network interface associated with the NAT gateway.

", - "smithy.api#xmlName": "natGatewayAddressSet" - } - }, - "NatGatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NatGatewayId", - "smithy.api#documentation": "

The ID of the NAT gateway.

", - "smithy.api#xmlName": "natGatewayId" - } - }, - "ProvisionedBandwidth": { - "target": "com.amazonaws.ec2#ProvisionedBandwidth", - "traits": { - "aws.protocols#ec2QueryName": "ProvisionedBandwidth", - "smithy.api#documentation": "

Reserved. If you need to sustain traffic greater than the documented limits, contact us through \n the Support Center.

", - "smithy.api#xmlName": "provisionedBandwidth" - } - }, - "State": { - "target": "com.amazonaws.ec2#NatGatewayState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the NAT gateway.

\n ", - "smithy.api#xmlName": "state" - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#documentation": "

The ID of the subnet in which the NAT gateway is located.

", - "smithy.api#xmlName": "subnetId" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC in which the NAT gateway is located.

", - "smithy.api#xmlName": "vpcId" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags for the NAT gateway.

", - "smithy.api#xmlName": "tagSet" - } - }, - "ConnectivityType": { - "target": "com.amazonaws.ec2#ConnectivityType", - "traits": { - "aws.protocols#ec2QueryName": "ConnectivityType", - "smithy.api#documentation": "

Indicates whether the NAT gateway supports public or private connectivity.

", - "smithy.api#xmlName": "connectivityType" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a NAT gateway.

" - } - }, - "com.amazonaws.ec2#NatGatewayAddress": { - "type": "structure", - "members": { - "AllocationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AllocationId", - "smithy.api#documentation": "

[Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway.

", - "smithy.api#xmlName": "allocationId" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "

The ID of the network interface associated with the NAT gateway.

", - "smithy.api#xmlName": "networkInterfaceId" - } - }, - "PrivateIp": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrivateIp", - "smithy.api#documentation": "

The private IP address associated with the NAT gateway.

", - "smithy.api#xmlName": "privateIp" - } - }, - "PublicIp": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PublicIp", - "smithy.api#documentation": "

[Public NAT gateway only] The Elastic IP address associated with the NAT gateway.

", - "smithy.api#xmlName": "publicIp" - } - }, - "AssociationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AssociationId", - "smithy.api#documentation": "

[Public NAT gateway only] The association ID of the Elastic IP address that's associated with the NAT gateway.

", - "smithy.api#xmlName": "associationId" - } - }, - "IsPrimary": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "IsPrimary", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Defines if the IP address is the primary address.

", - "smithy.api#xmlName": "isPrimary" - } - }, - "FailureMessage": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "FailureMessage", - "smithy.api#documentation": "

The address failure message.

", - "smithy.api#xmlName": "failureMessage" - } - }, - "Status": { - "target": "com.amazonaws.ec2#NatGatewayAddressStatus", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The address status.

", - "smithy.api#xmlName": "status" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the IP addresses and network interface associated with a NAT gateway.

" - } - }, - "com.amazonaws.ec2#NatGatewayAddressList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#NatGatewayAddress", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#NatGatewayAddressStatus": { - "type": "enum", - "members": { - "ASSIGNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "assigning" - } - }, - "UNASSIGNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unassigning" - } - }, - "ASSOCIATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "associating" - } - }, - "DISASSOCIATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disassociating" - } - }, - "SUCCEEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "succeeded" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failed" - } - } - } - }, - "com.amazonaws.ec2#NatGatewayId": { - "type": "string" - }, - "com.amazonaws.ec2#NatGatewayIdStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#NatGatewayId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#NatGatewayList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#NatGateway", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#NatGatewayState": { - "type": "enum", - "members": { - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failed" - } - }, - "AVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "available" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleting" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleted" - } - } - } - }, - "com.amazonaws.ec2#NetmaskLength": { - "type": "integer" - }, - "com.amazonaws.ec2#NetworkAcl": { - "type": "structure", - "members": { - "Associations": { - "target": "com.amazonaws.ec2#NetworkAclAssociationList", - "traits": { - "aws.protocols#ec2QueryName": "AssociationSet", - "smithy.api#documentation": "

Any associations between the network ACL and one or more subnets

", - "smithy.api#xmlName": "associationSet" - } - }, - "Entries": { - "target": "com.amazonaws.ec2#NetworkAclEntryList", - "traits": { - "aws.protocols#ec2QueryName": "EntrySet", - "smithy.api#documentation": "

One or more entries (rules) in the network ACL.

", - "smithy.api#xmlName": "entrySet" - } - }, - "IsDefault": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Default", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether this is the default network ACL for the VPC.

", - "smithy.api#xmlName": "default" - } - }, - "NetworkAclId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NetworkAclId", - "smithy.api#documentation": "

The ID of the network ACL.

", - "smithy.api#xmlName": "networkAclId" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the network ACL.

", - "smithy.api#xmlName": "tagSet" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC for the network ACL.

", - "smithy.api#xmlName": "vpcId" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the network ACL.

", - "smithy.api#xmlName": "ownerId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a network ACL.

" - } - }, - "com.amazonaws.ec2#NetworkAclAssociation": { - "type": "structure", - "members": { - "NetworkAclAssociationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NetworkAclAssociationId", - "smithy.api#documentation": "

The ID of the association between a network ACL and a subnet.

", - "smithy.api#xmlName": "networkAclAssociationId" - } - }, - "NetworkAclId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NetworkAclId", - "smithy.api#documentation": "

The ID of the network ACL.

", - "smithy.api#xmlName": "networkAclId" - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#documentation": "

The ID of the subnet.

", - "smithy.api#xmlName": "subnetId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an association between a network ACL and a subnet.

" - } - }, - "com.amazonaws.ec2#NetworkAclAssociationId": { - "type": "string" - }, - "com.amazonaws.ec2#NetworkAclAssociationList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#NetworkAclAssociation", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#NetworkAclEntry": { - "type": "structure", - "members": { - "CidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CidrBlock", - "smithy.api#documentation": "

The IPv4 network range to allow or deny, in CIDR notation.

", - "smithy.api#xmlName": "cidrBlock" - } - }, - "Egress": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Egress", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).

", - "smithy.api#xmlName": "egress" - } - }, - "IcmpTypeCode": { - "target": "com.amazonaws.ec2#IcmpTypeCode", - "traits": { - "aws.protocols#ec2QueryName": "IcmpTypeCode", - "smithy.api#documentation": "

ICMP protocol: The ICMP type and code.

", - "smithy.api#xmlName": "icmpTypeCode" - } - }, - "Ipv6CidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6CidrBlock", - "smithy.api#documentation": "

The IPv6 network range to allow or deny, in CIDR notation.

", - "smithy.api#xmlName": "ipv6CidrBlock" - } - }, - "PortRange": { - "target": "com.amazonaws.ec2#PortRange", - "traits": { - "aws.protocols#ec2QueryName": "PortRange", - "smithy.api#documentation": "

TCP or UDP protocols: The range of ports the rule applies to.

", - "smithy.api#xmlName": "portRange" - } - }, - "Protocol": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Protocol", - "smithy.api#documentation": "

The protocol number. A value of \"-1\" means all protocols.

", - "smithy.api#xmlName": "protocol" - } - }, - "RuleAction": { - "target": "com.amazonaws.ec2#RuleAction", - "traits": { - "aws.protocols#ec2QueryName": "RuleAction", - "smithy.api#documentation": "

Indicates whether to allow or deny the traffic that matches the rule.

", - "smithy.api#xmlName": "ruleAction" - } - }, - "RuleNumber": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "RuleNumber", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The rule number for the entry. ACL entries are processed in ascending order by rule number.

", - "smithy.api#xmlName": "ruleNumber" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an entry in a network ACL.

" - } - }, - "com.amazonaws.ec2#NetworkAclEntryList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#NetworkAclEntry", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#NetworkAclId": { - "type": "string" - }, - "com.amazonaws.ec2#NetworkAclIdStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#NetworkAclId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#NetworkAclList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#NetworkAcl", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#NetworkBandwidthGbps": { - "type": "structure", - "members": { - "Min": { - "target": "com.amazonaws.ec2#Double", - "traits": { - "aws.protocols#ec2QueryName": "Min", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no minimum\n limit.

", - "smithy.api#xmlName": "min" - } - }, - "Max": { - "target": "com.amazonaws.ec2#Double", - "traits": { - "aws.protocols#ec2QueryName": "Max", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no\n maximum limit.

", - "smithy.api#xmlName": "max" - } - } - }, - "traits": { - "smithy.api#documentation": "

The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).

\n \n

Setting the minimum bandwidth does not guarantee that your instance will achieve the \n minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum \n bandwidth, but the actual bandwidth of your instance might go below the specified minimum \n at times. For more information, see Available instance bandwidth in the\n Amazon EC2 User Guide.

\n " - } - }, - "com.amazonaws.ec2#NetworkBandwidthGbpsRequest": { - "type": "structure", - "members": { - "Min": { - "target": "com.amazonaws.ec2#Double", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum amount of network bandwidth, in Gbps. To specify no minimum limit, omit this\n parameter.

" - } - }, - "Max": { - "target": "com.amazonaws.ec2#Double", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum amount of network bandwidth, in Gbps. To specify no maximum limit, omit this\n parameter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).

\n \n

Setting the minimum bandwidth does not guarantee that your instance will achieve the \n minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum \n bandwidth, but the actual bandwidth of your instance might go below the specified minimum \n at times. For more information, see Available instance bandwidth in the\n Amazon EC2 User Guide.

\n " - } - }, - "com.amazonaws.ec2#NetworkCardIndex": { - "type": "integer" - }, - "com.amazonaws.ec2#NetworkCardInfo": { - "type": "structure", - "members": { - "NetworkCardIndex": { - "target": "com.amazonaws.ec2#NetworkCardIndex", - "traits": { - "aws.protocols#ec2QueryName": "NetworkCardIndex", - "smithy.api#documentation": "

The index of the network card.

", - "smithy.api#xmlName": "networkCardIndex" - } - }, - "NetworkPerformance": { - "target": "com.amazonaws.ec2#NetworkPerformance", - "traits": { - "aws.protocols#ec2QueryName": "NetworkPerformance", - "smithy.api#documentation": "

The network performance of the network card.

", - "smithy.api#xmlName": "networkPerformance" - } - }, - "MaximumNetworkInterfaces": { - "target": "com.amazonaws.ec2#MaxNetworkInterfaces", - "traits": { - "aws.protocols#ec2QueryName": "MaximumNetworkInterfaces", - "smithy.api#documentation": "

The maximum number of network interfaces for the network card.

", - "smithy.api#xmlName": "maximumNetworkInterfaces" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the network card support of the instance type.

" - } - }, - "com.amazonaws.ec2#NetworkCardInfoList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#NetworkCardInfo", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#NetworkInfo": { - "type": "structure", - "members": { - "NetworkPerformance": { - "target": "com.amazonaws.ec2#NetworkPerformance", - "traits": { - "aws.protocols#ec2QueryName": "NetworkPerformance", - "smithy.api#documentation": "

The network performance.

", - "smithy.api#xmlName": "networkPerformance" - } - }, - "MaximumNetworkInterfaces": { - "target": "com.amazonaws.ec2#MaxNetworkInterfaces", - "traits": { - "aws.protocols#ec2QueryName": "MaximumNetworkInterfaces", - "smithy.api#documentation": "

The maximum number of network interfaces for the instance type.

", - "smithy.api#xmlName": "maximumNetworkInterfaces" - } - }, - "MaximumNetworkCards": { - "target": "com.amazonaws.ec2#MaximumNetworkCards", - "traits": { - "aws.protocols#ec2QueryName": "MaximumNetworkCards", - "smithy.api#documentation": "

The maximum number of physical network cards that can be allocated to the instance.

", - "smithy.api#xmlName": "maximumNetworkCards" - } - }, - "DefaultNetworkCardIndex": { - "target": "com.amazonaws.ec2#DefaultNetworkCardIndex", - "traits": { - "aws.protocols#ec2QueryName": "DefaultNetworkCardIndex", - "smithy.api#documentation": "

The index of the default network card, starting at 0.

", - "smithy.api#xmlName": "defaultNetworkCardIndex" - } - }, - "NetworkCards": { - "target": "com.amazonaws.ec2#NetworkCardInfoList", - "traits": { - "aws.protocols#ec2QueryName": "NetworkCards", - "smithy.api#documentation": "

Describes the network cards for the instance type.

", - "smithy.api#xmlName": "networkCards" - } - }, - "Ipv4AddressesPerInterface": { - "target": "com.amazonaws.ec2#MaxIpv4AddrPerInterface", - "traits": { - "aws.protocols#ec2QueryName": "Ipv4AddressesPerInterface", - "smithy.api#documentation": "

The maximum number of IPv4 addresses per network interface.

", - "smithy.api#xmlName": "ipv4AddressesPerInterface" - } - }, - "Ipv6AddressesPerInterface": { - "target": "com.amazonaws.ec2#MaxIpv6AddrPerInterface", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6AddressesPerInterface", - "smithy.api#documentation": "

The maximum number of IPv6 addresses per network interface.

", - "smithy.api#xmlName": "ipv6AddressesPerInterface" - } - }, - "Ipv6Supported": { - "target": "com.amazonaws.ec2#Ipv6Flag", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6Supported", - "smithy.api#documentation": "

Indicates whether IPv6 is supported.

", - "smithy.api#xmlName": "ipv6Supported" - } - }, - "EnaSupport": { - "target": "com.amazonaws.ec2#EnaSupport", - "traits": { - "aws.protocols#ec2QueryName": "EnaSupport", - "smithy.api#documentation": "

Indicates whether Elastic Network Adapter (ENA) is supported.

", - "smithy.api#xmlName": "enaSupport" - } - }, - "EfaSupported": { - "target": "com.amazonaws.ec2#EfaSupportedFlag", - "traits": { - "aws.protocols#ec2QueryName": "EfaSupported", - "smithy.api#documentation": "

Indicates whether Elastic Fabric Adapter (EFA) is supported.

", - "smithy.api#xmlName": "efaSupported" - } - }, - "EfaInfo": { - "target": "com.amazonaws.ec2#EfaInfo", - "traits": { - "aws.protocols#ec2QueryName": "EfaInfo", - "smithy.api#documentation": "

Describes the Elastic Fabric Adapters for the instance type.

", - "smithy.api#xmlName": "efaInfo" - } - }, - "EncryptionInTransitSupported": { - "target": "com.amazonaws.ec2#EncryptionInTransitSupported", - "traits": { - "aws.protocols#ec2QueryName": "EncryptionInTransitSupported", - "smithy.api#documentation": "

Indicates whether the instance type automatically encrypts in-transit traffic between instances.

", - "smithy.api#xmlName": "encryptionInTransitSupported" - } - }, - "EnaSrdSupported": { - "target": "com.amazonaws.ec2#EnaSrdSupported", - "traits": { - "aws.protocols#ec2QueryName": "EnaSrdSupported", - "smithy.api#documentation": "

Indicates whether the instance type supports ENA Express. ENA Express uses Amazon Web Services Scalable \n Reliable Datagram (SRD) technology to increase the maximum bandwidth used per stream and \n minimize tail latency of network traffic between EC2 instances.

", - "smithy.api#xmlName": "enaSrdSupported" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the networking features of the instance type.

" - } - }, - "com.amazonaws.ec2#NetworkInsightsAccessScope": { - "type": "structure", - "members": { - "NetworkInsightsAccessScopeId": { - "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeId", - "smithy.api#documentation": "

The ID of the Network Access Scope.

", - "smithy.api#xmlName": "networkInsightsAccessScopeId" - } - }, - "NetworkInsightsAccessScopeArn": { - "target": "com.amazonaws.ec2#ResourceArn", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Network Access Scope.

", - "smithy.api#xmlName": "networkInsightsAccessScopeArn" - } - }, - "CreatedDate": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "CreatedDate", - "smithy.api#documentation": "

The creation date.

", - "smithy.api#xmlName": "createdDate" - } - }, - "UpdatedDate": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "UpdatedDate", - "smithy.api#documentation": "

The last updated date.

", - "smithy.api#xmlName": "updatedDate" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a Network Access Scope.

" - } - }, - "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysis": { - "type": "structure", - "members": { - "NetworkInsightsAccessScopeAnalysisId": { - "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisId", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeAnalysisId", - "smithy.api#documentation": "

The ID of the Network Access Scope analysis.

", - "smithy.api#xmlName": "networkInsightsAccessScopeAnalysisId" - } - }, - "NetworkInsightsAccessScopeAnalysisArn": { - "target": "com.amazonaws.ec2#ResourceArn", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeAnalysisArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Network Access Scope analysis.

", - "smithy.api#xmlName": "networkInsightsAccessScopeAnalysisArn" - } - }, - "NetworkInsightsAccessScopeId": { - "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeId", - "smithy.api#documentation": "

The ID of the Network Access Scope.

", - "smithy.api#xmlName": "networkInsightsAccessScopeId" - } - }, - "Status": { - "target": "com.amazonaws.ec2#AnalysisStatus", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The status.

", - "smithy.api#xmlName": "status" - } - }, - "StatusMessage": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StatusMessage", - "smithy.api#documentation": "

The status message.

", - "smithy.api#xmlName": "statusMessage" - } - }, - "WarningMessage": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "WarningMessage", - "smithy.api#documentation": "

The warning message.

", - "smithy.api#xmlName": "warningMessage" - } - }, - "StartDate": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "StartDate", - "smithy.api#documentation": "

The analysis start date.

", - "smithy.api#xmlName": "startDate" - } - }, - "EndDate": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "EndDate", - "smithy.api#documentation": "

The analysis end date.

", - "smithy.api#xmlName": "endDate" - } - }, - "FindingsFound": { - "target": "com.amazonaws.ec2#FindingsFound", - "traits": { - "aws.protocols#ec2QueryName": "FindingsFound", - "smithy.api#documentation": "

Indicates whether there are findings.

", - "smithy.api#xmlName": "findingsFound" - } - }, - "AnalyzedEniCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "AnalyzedEniCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of network interfaces analyzed.

", - "smithy.api#xmlName": "analyzedEniCount" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a Network Access Scope analysis.

" - } - }, - "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisId": { - "type": "string" - }, - "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysis", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#NetworkInsightsAccessScopeContent": { - "type": "structure", - "members": { - "NetworkInsightsAccessScopeId": { - "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeId", - "smithy.api#documentation": "

The ID of the Network Access Scope.

", - "smithy.api#xmlName": "networkInsightsAccessScopeId" - } - }, - "MatchPaths": { - "target": "com.amazonaws.ec2#AccessScopePathList", - "traits": { - "aws.protocols#ec2QueryName": "MatchPathSet", - "smithy.api#documentation": "

The paths to match.

", - "smithy.api#xmlName": "matchPathSet" - } - }, - "ExcludePaths": { - "target": "com.amazonaws.ec2#AccessScopePathList", - "traits": { - "aws.protocols#ec2QueryName": "ExcludePathSet", - "smithy.api#documentation": "

The paths to exclude.

", - "smithy.api#xmlName": "excludePathSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the Network Access Scope content.

" - } - }, - "com.amazonaws.ec2#NetworkInsightsAccessScopeId": { - "type": "string" - }, - "com.amazonaws.ec2#NetworkInsightsAccessScopeIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#NetworkInsightsAccessScopeList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#NetworkInsightsAccessScope", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#NetworkInsightsAnalysis": { - "type": "structure", - "members": { - "NetworkInsightsAnalysisId": { - "target": "com.amazonaws.ec2#NetworkInsightsAnalysisId", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInsightsAnalysisId", - "smithy.api#documentation": "

The ID of the network insights analysis.

", - "smithy.api#xmlName": "networkInsightsAnalysisId" - } - }, - "NetworkInsightsAnalysisArn": { - "target": "com.amazonaws.ec2#ResourceArn", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInsightsAnalysisArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network insights analysis.

", - "smithy.api#xmlName": "networkInsightsAnalysisArn" - } - }, - "NetworkInsightsPathId": { - "target": "com.amazonaws.ec2#NetworkInsightsPathId", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInsightsPathId", - "smithy.api#documentation": "

The ID of the path.

", - "smithy.api#xmlName": "networkInsightsPathId" - } - }, - "AdditionalAccounts": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "AdditionalAccountSet", - "smithy.api#documentation": "

The member accounts that contain resources that the path can traverse.

", - "smithy.api#xmlName": "additionalAccountSet" - } - }, - "FilterInArns": { - "target": "com.amazonaws.ec2#ArnList", - "traits": { - "aws.protocols#ec2QueryName": "FilterInArnSet", - "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the resources that the path must traverse.

", - "smithy.api#xmlName": "filterInArnSet" - } - }, - "StartDate": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "StartDate", - "smithy.api#documentation": "

The time the analysis started.

", - "smithy.api#xmlName": "startDate" - } - }, - "Status": { - "target": "com.amazonaws.ec2#AnalysisStatus", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The status of the network insights analysis.

", - "smithy.api#xmlName": "status" - } - }, - "StatusMessage": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StatusMessage", - "smithy.api#documentation": "

The status message, if the status is failed.

", - "smithy.api#xmlName": "statusMessage" - } - }, - "WarningMessage": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "WarningMessage", - "smithy.api#documentation": "

The warning message.

", - "smithy.api#xmlName": "warningMessage" - } - }, - "NetworkPathFound": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "NetworkPathFound", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the destination is reachable from the source.

", - "smithy.api#xmlName": "networkPathFound" - } - }, - "ForwardPathComponents": { - "target": "com.amazonaws.ec2#PathComponentList", - "traits": { - "aws.protocols#ec2QueryName": "ForwardPathComponentSet", - "smithy.api#documentation": "

The components in the path from source to destination.

", - "smithy.api#xmlName": "forwardPathComponentSet" - } - }, - "ReturnPathComponents": { - "target": "com.amazonaws.ec2#PathComponentList", - "traits": { - "aws.protocols#ec2QueryName": "ReturnPathComponentSet", - "smithy.api#documentation": "

The components in the path from destination to source.

", - "smithy.api#xmlName": "returnPathComponentSet" - } - }, - "Explanations": { - "target": "com.amazonaws.ec2#ExplanationList", - "traits": { - "aws.protocols#ec2QueryName": "ExplanationSet", - "smithy.api#documentation": "

The explanations. For more information, see Reachability Analyzer explanation codes.

", - "smithy.api#xmlName": "explanationSet" - } - }, - "AlternatePathHints": { - "target": "com.amazonaws.ec2#AlternatePathHintList", - "traits": { - "aws.protocols#ec2QueryName": "AlternatePathHintSet", - "smithy.api#documentation": "

Potential intermediate components.

", - "smithy.api#xmlName": "alternatePathHintSet" - } - }, - "SuggestedAccounts": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "SuggestedAccountSet", - "smithy.api#documentation": "

Potential intermediate accounts.

", - "smithy.api#xmlName": "suggestedAccountSet" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a network insights analysis.

" - } - }, - "com.amazonaws.ec2#NetworkInsightsAnalysisId": { - "type": "string" - }, - "com.amazonaws.ec2#NetworkInsightsAnalysisIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#NetworkInsightsAnalysisId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#NetworkInsightsAnalysisList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#NetworkInsightsAnalysis", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#NetworkInsightsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.ec2#NetworkInsightsPath": { - "type": "structure", - "members": { - "NetworkInsightsPathId": { - "target": "com.amazonaws.ec2#NetworkInsightsPathId", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInsightsPathId", - "smithy.api#documentation": "

The ID of the path.

", - "smithy.api#xmlName": "networkInsightsPathId" - } - }, - "NetworkInsightsPathArn": { - "target": "com.amazonaws.ec2#ResourceArn", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInsightsPathArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the path.

", - "smithy.api#xmlName": "networkInsightsPathArn" - } - }, - "CreatedDate": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "CreatedDate", - "smithy.api#documentation": "

The time stamp when the path was created.

", - "smithy.api#xmlName": "createdDate" - } - }, - "Source": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Source", - "smithy.api#documentation": "

The ID of the source.

", - "smithy.api#xmlName": "source" - } - }, - "Destination": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Destination", - "smithy.api#documentation": "

The ID of the destination.

", - "smithy.api#xmlName": "destination" - } - }, - "SourceArn": { - "target": "com.amazonaws.ec2#ResourceArn", - "traits": { - "aws.protocols#ec2QueryName": "SourceArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source.

", - "smithy.api#xmlName": "sourceArn" - } - }, - "DestinationArn": { - "target": "com.amazonaws.ec2#ResourceArn", - "traits": { - "aws.protocols#ec2QueryName": "DestinationArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the destination.

", - "smithy.api#xmlName": "destinationArn" - } - }, - "SourceIp": { - "target": "com.amazonaws.ec2#IpAddress", - "traits": { - "aws.protocols#ec2QueryName": "SourceIp", - "smithy.api#documentation": "

The IP address of the source.

", - "smithy.api#xmlName": "sourceIp" - } - }, - "DestinationIp": { - "target": "com.amazonaws.ec2#IpAddress", - "traits": { - "aws.protocols#ec2QueryName": "DestinationIp", - "smithy.api#documentation": "

The IP address of the destination.

", - "smithy.api#xmlName": "destinationIp" - } - }, - "Protocol": { - "target": "com.amazonaws.ec2#Protocol", - "traits": { - "aws.protocols#ec2QueryName": "Protocol", - "smithy.api#documentation": "

The protocol.

", - "smithy.api#xmlName": "protocol" - } - }, - "DestinationPort": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "DestinationPort", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The destination port.

", - "smithy.api#xmlName": "destinationPort" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags associated with the path.

", - "smithy.api#xmlName": "tagSet" - } - }, - "FilterAtSource": { - "target": "com.amazonaws.ec2#PathFilter", - "traits": { - "aws.protocols#ec2QueryName": "FilterAtSource", - "smithy.api#documentation": "

Scopes the analysis to network paths that match specific filters at the source.

", - "smithy.api#xmlName": "filterAtSource" - } - }, - "FilterAtDestination": { - "target": "com.amazonaws.ec2#PathFilter", - "traits": { - "aws.protocols#ec2QueryName": "FilterAtDestination", - "smithy.api#documentation": "

Scopes the analysis to network paths that match specific filters at the destination.

", - "smithy.api#xmlName": "filterAtDestination" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a path.

" - } - }, - "com.amazonaws.ec2#NetworkInsightsPathId": { - "type": "string" - }, - "com.amazonaws.ec2#NetworkInsightsPathIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#NetworkInsightsPathId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#NetworkInsightsPathList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#NetworkInsightsPath", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#NetworkInsightsResourceId": { - "type": "string" - }, - "com.amazonaws.ec2#NetworkInterface": { - "type": "structure", - "members": { - "Association": { - "target": "com.amazonaws.ec2#NetworkInterfaceAssociation", - "traits": { - "aws.protocols#ec2QueryName": "Association", - "smithy.api#documentation": "

The association information for an Elastic IP address (IPv4) associated with the network interface.

", - "smithy.api#xmlName": "association" - } - }, - "Attachment": { - "target": "com.amazonaws.ec2#NetworkInterfaceAttachment", - "traits": { - "aws.protocols#ec2QueryName": "Attachment", - "smithy.api#documentation": "

The network interface attachment.

", - "smithy.api#xmlName": "attachment" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone.

", - "smithy.api#xmlName": "availabilityZone" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description.

", - "smithy.api#xmlName": "description" - } - }, - "Groups": { - "target": "com.amazonaws.ec2#GroupIdentifierList", - "traits": { - "aws.protocols#ec2QueryName": "GroupSet", - "smithy.api#documentation": "

Any security groups for the network interface.

", - "smithy.api#xmlName": "groupSet" - } - }, - "InterfaceType": { - "target": "com.amazonaws.ec2#NetworkInterfaceType", - "traits": { - "aws.protocols#ec2QueryName": "InterfaceType", - "smithy.api#documentation": "

The type of network interface.

", - "smithy.api#xmlName": "interfaceType" - } - }, - "Ipv6Addresses": { - "target": "com.amazonaws.ec2#NetworkInterfaceIpv6AddressesList", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6AddressesSet", - "smithy.api#documentation": "

The IPv6 addresses associated with the network interface.

", - "smithy.api#xmlName": "ipv6AddressesSet" - } - }, - "MacAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "MacAddress", - "smithy.api#documentation": "

The MAC address.

", - "smithy.api#xmlName": "macAddress" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "

The ID of the network interface.

", - "smithy.api#xmlName": "networkInterfaceId" - } - }, - "OutpostArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OutpostArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

", - "smithy.api#xmlName": "outpostArn" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the network interface.

", - "smithy.api#xmlName": "ownerId" - } - }, - "PrivateDnsName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrivateDnsName", - "smithy.api#documentation": "

The private DNS name.

", - "smithy.api#xmlName": "privateDnsName" - } - }, - "PrivateIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrivateIpAddress", - "smithy.api#documentation": "

The IPv4 address of the network interface within the subnet.

", - "smithy.api#xmlName": "privateIpAddress" - } - }, - "PrivateIpAddresses": { - "target": "com.amazonaws.ec2#NetworkInterfacePrivateIpAddressList", - "traits": { - "aws.protocols#ec2QueryName": "PrivateIpAddressesSet", - "smithy.api#documentation": "

The private IPv4 addresses associated with the network interface.

", - "smithy.api#xmlName": "privateIpAddressesSet" - } - }, - "Ipv4Prefixes": { - "target": "com.amazonaws.ec2#Ipv4PrefixesList", - "traits": { - "aws.protocols#ec2QueryName": "Ipv4PrefixSet", - "smithy.api#documentation": "

The IPv4 prefixes that are assigned to the network interface.

", - "smithy.api#xmlName": "ipv4PrefixSet" - } - }, - "Ipv6Prefixes": { - "target": "com.amazonaws.ec2#Ipv6PrefixesList", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6PrefixSet", - "smithy.api#documentation": "

The IPv6 prefixes that are assigned to the network interface.

", - "smithy.api#xmlName": "ipv6PrefixSet" - } - }, - "RequesterId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "RequesterId", - "smithy.api#documentation": "

The alias or Amazon Web Services account ID of the principal or service that created the network interface.

", - "smithy.api#xmlName": "requesterId" - } - }, - "RequesterManaged": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "RequesterManaged", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the network interface is being managed by Amazon Web Services.

", - "smithy.api#xmlName": "requesterManaged" - } - }, - "SourceDestCheck": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "SourceDestCheck", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether source/destination checking is enabled.

", - "smithy.api#xmlName": "sourceDestCheck" - } - }, - "Status": { - "target": "com.amazonaws.ec2#NetworkInterfaceStatus", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The status of the network interface.

", - "smithy.api#xmlName": "status" - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#documentation": "

The ID of the subnet.

", - "smithy.api#xmlName": "subnetId" - } - }, - "TagSet": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the network interface.

", - "smithy.api#xmlName": "tagSet" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#xmlName": "vpcId" - } - }, - "DenyAllIgwTraffic": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DenyAllIgwTraffic", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether a network interface with an IPv6 address is unreachable from the \n public internet. If the value is true, inbound traffic from the internet \n is dropped and you cannot assign an elastic IP address to the network interface. The \n network interface is reachable from peered VPCs and resources connected through a \n transit gateway, including on-premises networks.

", - "smithy.api#xmlName": "denyAllIgwTraffic" - } - }, - "Ipv6Native": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6Native", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether this is an IPv6 only network interface.

", - "smithy.api#xmlName": "ipv6Native" - } - }, - "Ipv6Address": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6Address", - "smithy.api#documentation": "

The IPv6 globally unique address associated with the network interface.

", - "smithy.api#xmlName": "ipv6Address" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a network interface.

" - } - }, - "com.amazonaws.ec2#NetworkInterfaceAssociation": { - "type": "structure", - "members": { - "AllocationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AllocationId", - "smithy.api#documentation": "

The allocation ID.

", - "smithy.api#xmlName": "allocationId" - } - }, - "AssociationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AssociationId", - "smithy.api#documentation": "

The association ID.

", - "smithy.api#xmlName": "associationId" - } - }, - "IpOwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "IpOwnerId", - "smithy.api#documentation": "

The ID of the Elastic IP address owner.

", - "smithy.api#xmlName": "ipOwnerId" - } - }, - "PublicDnsName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PublicDnsName", - "smithy.api#documentation": "

The public DNS name.

", - "smithy.api#xmlName": "publicDnsName" - } - }, - "PublicIp": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PublicIp", - "smithy.api#documentation": "

The address of the Elastic IP address bound to the network\n interface.

", - "smithy.api#xmlName": "publicIp" - } - }, - "CustomerOwnedIp": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CustomerOwnedIp", - "smithy.api#documentation": "

The customer-owned IP address associated with the network interface.

", - "smithy.api#xmlName": "customerOwnedIp" - } - }, - "CarrierIp": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CarrierIp", - "smithy.api#documentation": "

The carrier IP address associated with the network interface.

\n

This option is only available when the network interface is in a subnet which is associated with a Wavelength Zone.

", - "smithy.api#xmlName": "carrierIp" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes association information for an Elastic IP address (IPv4 only), or a Carrier\n IP address (for a network interface which resides in a subnet in a Wavelength\n Zone).

" - } - }, - "com.amazonaws.ec2#NetworkInterfaceAttachment": { - "type": "structure", - "members": { - "AttachTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "AttachTime", - "smithy.api#documentation": "

The timestamp indicating when the attachment initiated.

", - "smithy.api#xmlName": "attachTime" - } - }, - "AttachmentId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AttachmentId", - "smithy.api#documentation": "

The ID of the network interface attachment.

", - "smithy.api#xmlName": "attachmentId" - } - }, - "DeleteOnTermination": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DeleteOnTermination", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the network interface is deleted when the instance is terminated.

", - "smithy.api#xmlName": "deleteOnTermination" - } - }, - "DeviceIndex": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "DeviceIndex", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The device index of the network interface attachment on the instance.

", - "smithy.api#xmlName": "deviceIndex" - } - }, - "NetworkCardIndex": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "NetworkCardIndex", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The index of the network card.

", - "smithy.api#xmlName": "networkCardIndex" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#xmlName": "instanceId" - } - }, - "InstanceOwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceOwnerId", - "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the instance.

", - "smithy.api#xmlName": "instanceOwnerId" - } - }, - "Status": { - "target": "com.amazonaws.ec2#AttachmentStatus", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The attachment state.

", - "smithy.api#xmlName": "status" - } - }, - "EnaSrdSpecification": { - "target": "com.amazonaws.ec2#AttachmentEnaSrdSpecification", - "traits": { - "aws.protocols#ec2QueryName": "EnaSrdSpecification", - "smithy.api#documentation": "

Configures ENA Express for the network interface that this action attaches to the instance.

", - "smithy.api#xmlName": "enaSrdSpecification" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a network interface attachment.

" - } - }, - "com.amazonaws.ec2#NetworkInterfaceAttachmentChanges": { - "type": "structure", - "members": { - "AttachmentId": { - "target": "com.amazonaws.ec2#NetworkInterfaceAttachmentId", - "traits": { - "aws.protocols#ec2QueryName": "AttachmentId", - "smithy.api#documentation": "

The ID of the network interface attachment.

", - "smithy.api#xmlName": "attachmentId" - } - }, - "DeleteOnTermination": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DeleteOnTermination", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the network interface is deleted when the instance is terminated.

", - "smithy.api#xmlName": "deleteOnTermination" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an attachment change.

" - } - }, - "com.amazonaws.ec2#NetworkInterfaceAttachmentId": { - "type": "string" - }, - "com.amazonaws.ec2#NetworkInterfaceAttribute": { - "type": "enum", - "members": { - "description": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "description" - } - }, - "groupSet": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "groupSet" - } - }, - "sourceDestCheck": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "sourceDestCheck" - } - }, - "attachment": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "attachment" - } - } - } - }, - "com.amazonaws.ec2#NetworkInterfaceCount": { - "type": "structure", - "members": { - "Min": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Min", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum number of network interfaces. If this parameter is not specified, there is no\n minimum limit.

", - "smithy.api#xmlName": "min" - } - }, - "Max": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Max", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of network interfaces. If this parameter is not specified, there is no\n maximum limit.

", - "smithy.api#xmlName": "max" - } - } - }, - "traits": { - "smithy.api#documentation": "

The minimum and maximum number of network interfaces.

" - } - }, - "com.amazonaws.ec2#NetworkInterfaceCountRequest": { - "type": "structure", - "members": { - "Min": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum number of network interfaces. To specify no minimum limit, omit this\n parameter.

" - } - }, - "Max": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of network interfaces. To specify no maximum limit, omit this\n parameter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The minimum and maximum number of network interfaces.

" - } - }, - "com.amazonaws.ec2#NetworkInterfaceCreationType": { - "type": "enum", - "members": { - "efa": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "efa" - } - }, - "branch": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "branch" - } - }, - "trunk": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "trunk" - } - } - } - }, - "com.amazonaws.ec2#NetworkInterfaceId": { - "type": "string" - }, - "com.amazonaws.ec2#NetworkInterfaceIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#NetworkInterfaceId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#NetworkInterfaceIpv6Address": { - "type": "structure", - "members": { - "Ipv6Address": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6Address", - "smithy.api#documentation": "

The IPv6 address.

", - "smithy.api#xmlName": "ipv6Address" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an IPv6 address associated with a network interface.

" - } - }, - "com.amazonaws.ec2#NetworkInterfaceIpv6AddressesList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#NetworkInterfaceIpv6Address", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#NetworkInterfaceList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#NetworkInterface", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#NetworkInterfacePermission": { - "type": "structure", - "members": { - "NetworkInterfacePermissionId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfacePermissionId", - "smithy.api#documentation": "

The ID of the network interface permission.

", - "smithy.api#xmlName": "networkInterfacePermissionId" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "

The ID of the network interface.

", - "smithy.api#xmlName": "networkInterfaceId" - } - }, - "AwsAccountId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AwsAccountId", - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#xmlName": "awsAccountId" - } - }, - "AwsService": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AwsService", - "smithy.api#documentation": "

The Amazon Web Service.

", - "smithy.api#xmlName": "awsService" - } - }, - "Permission": { - "target": "com.amazonaws.ec2#InterfacePermissionType", - "traits": { - "aws.protocols#ec2QueryName": "Permission", - "smithy.api#documentation": "

The type of permission.

", - "smithy.api#xmlName": "permission" - } - }, - "PermissionState": { - "target": "com.amazonaws.ec2#NetworkInterfacePermissionState", - "traits": { - "aws.protocols#ec2QueryName": "PermissionState", - "smithy.api#documentation": "

Information about the state of the permission.

", - "smithy.api#xmlName": "permissionState" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a permission for a network interface.

" - } - }, - "com.amazonaws.ec2#NetworkInterfacePermissionId": { - "type": "string" - }, - "com.amazonaws.ec2#NetworkInterfacePermissionIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#NetworkInterfacePermissionId" - } - }, - "com.amazonaws.ec2#NetworkInterfacePermissionList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#NetworkInterfacePermission", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#NetworkInterfacePermissionState": { - "type": "structure", - "members": { - "State": { - "target": "com.amazonaws.ec2#NetworkInterfacePermissionStateCode", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the permission.

", - "smithy.api#xmlName": "state" - } - }, - "StatusMessage": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StatusMessage", - "smithy.api#documentation": "

A status message, if applicable.

", - "smithy.api#xmlName": "statusMessage" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the state of a network interface permission.

" - } - }, - "com.amazonaws.ec2#NetworkInterfacePermissionStateCode": { - "type": "enum", - "members": { - "pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "granted": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "granted" - } - }, - "revoking": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "revoking" - } - }, - "revoked": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "revoked" - } - } - } - }, - "com.amazonaws.ec2#NetworkInterfacePrivateIpAddress": { - "type": "structure", - "members": { - "Association": { - "target": "com.amazonaws.ec2#NetworkInterfaceAssociation", - "traits": { - "aws.protocols#ec2QueryName": "Association", - "smithy.api#documentation": "

The association information for an Elastic IP address (IPv4) associated with the network interface.

", - "smithy.api#xmlName": "association" - } - }, - "Primary": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Primary", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether this IPv4 address is the primary private IPv4 address of the network interface.

", - "smithy.api#xmlName": "primary" - } - }, - "PrivateDnsName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrivateDnsName", - "smithy.api#documentation": "

The private DNS name.

", - "smithy.api#xmlName": "privateDnsName" - } - }, - "PrivateIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrivateIpAddress", - "smithy.api#documentation": "

The private IPv4 address.

", - "smithy.api#xmlName": "privateIpAddress" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the private IPv4 address of a network interface.

" - } - }, - "com.amazonaws.ec2#NetworkInterfacePrivateIpAddressList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#NetworkInterfacePrivateIpAddress", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#NetworkInterfaceStatus": { - "type": "enum", - "members": { - "available": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "available" - } - }, - "associated": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "associated" - } - }, - "attaching": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "attaching" - } - }, - "in_use": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "in-use" - } - }, - "detaching": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "detaching" - } - } - } - }, - "com.amazonaws.ec2#NetworkInterfaceType": { - "type": "enum", - "members": { - "interface": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "interface" - } - }, - "natGateway": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "natGateway" - } - }, - "efa": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "efa" - } - }, - "trunk": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "trunk" - } - }, - "load_balancer": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "load_balancer" - } - }, - "network_load_balancer": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "network_load_balancer" - } - }, - "vpc_endpoint": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "vpc_endpoint" - } - }, - "branch": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "branch" - } - }, - "transit_gateway": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "transit_gateway" - } - }, - "lambda": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "lambda" - } - }, - "quicksight": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "quicksight" - } - }, - "global_accelerator_managed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "global_accelerator_managed" - } - }, - "api_gateway_managed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "api_gateway_managed" - } - }, - "gateway_load_balancer": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "gateway_load_balancer" - } - }, - "gateway_load_balancer_endpoint": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "gateway_load_balancer_endpoint" - } - }, - "iot_rules_managed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iot_rules_managed" - } - }, - "aws_codestar_connections_managed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "aws_codestar_connections_managed" - } - } - } - }, - "com.amazonaws.ec2#NetworkPerformance": { - "type": "string" - }, - "com.amazonaws.ec2#NewDhcpConfiguration": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Key", - "smithy.api#documentation": "

The name of a DHCP option.

", - "smithy.api#xmlName": "key" - } - }, - "Values": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#documentation": "

One or more values for the DHCP option.

", - "smithy.api#xmlName": "Value" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a DHCP configuration option.

" - } - }, - "com.amazonaws.ec2#NewDhcpConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#NewDhcpConfiguration", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#NextToken": { - "type": "string" - }, - "com.amazonaws.ec2#OccurrenceDayRequestSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#xmlName": "OccurenceDay" - } - } - }, - "com.amazonaws.ec2#OccurrenceDaySet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#OfferingClassType": { - "type": "enum", - "members": { - "STANDARD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "standard" - } - }, - "CONVERTIBLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "convertible" - } - } - } - }, - "com.amazonaws.ec2#OfferingId": { - "type": "string" - }, - "com.amazonaws.ec2#OfferingTypeValues": { - "type": "enum", - "members": { - "Heavy_Utilization": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Heavy Utilization" - } - }, - "Medium_Utilization": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Medium Utilization" - } - }, - "Light_Utilization": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Light Utilization" - } - }, - "No_Upfront": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "No Upfront" - } - }, - "Partial_Upfront": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Partial Upfront" - } - }, - "All_Upfront": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "All Upfront" - } - } - } - }, - "com.amazonaws.ec2#OidcOptions": { - "type": "structure", - "members": { - "Issuer": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Issuer", - "smithy.api#documentation": "

The OIDC issuer.

", - "smithy.api#xmlName": "issuer" - } - }, - "AuthorizationEndpoint": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AuthorizationEndpoint", - "smithy.api#documentation": "

The OIDC authorization endpoint.

", - "smithy.api#xmlName": "authorizationEndpoint" - } - }, - "TokenEndpoint": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TokenEndpoint", - "smithy.api#documentation": "

The OIDC token endpoint.

", - "smithy.api#xmlName": "tokenEndpoint" - } - }, - "UserInfoEndpoint": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "UserInfoEndpoint", - "smithy.api#documentation": "

The OIDC user info endpoint.

", - "smithy.api#xmlName": "userInfoEndpoint" - } - }, - "ClientId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientId", - "smithy.api#documentation": "

The client identifier.

", - "smithy.api#xmlName": "clientId" - } - }, - "ClientSecret": { - "target": "com.amazonaws.ec2#ClientSecretType", - "traits": { - "aws.protocols#ec2QueryName": "ClientSecret", - "smithy.api#documentation": "

The client secret.

", - "smithy.api#xmlName": "clientSecret" - } - }, - "Scope": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Scope", - "smithy.api#documentation": "

The OpenID Connect (OIDC) scope specified.

", - "smithy.api#xmlName": "scope" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the options for an OpenID Connect-compatible user-identity trust\n provider.

" - } - }, - "com.amazonaws.ec2#OnDemandAllocationStrategy": { - "type": "enum", - "members": { - "LOWEST_PRICE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "lowestPrice" - } - }, - "PRIORITIZED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "prioritized" - } - } - } - }, - "com.amazonaws.ec2#OnDemandOptions": { - "type": "structure", - "members": { - "AllocationStrategy": { - "target": "com.amazonaws.ec2#FleetOnDemandAllocationStrategy", - "traits": { - "aws.protocols#ec2QueryName": "AllocationStrategy", - "smithy.api#documentation": "

The strategy that determines the order of the launch template overrides to use in\n fulfilling On-Demand capacity.

\n

\n lowest-price - EC2 Fleet uses price to determine the order, launching the lowest\n price first.

\n

\n prioritized - EC2 Fleet uses the priority that you assigned to each launch\n template override, launching the highest priority first.

\n

Default: lowest-price\n

", - "smithy.api#xmlName": "allocationStrategy" - } - }, - "CapacityReservationOptions": { - "target": "com.amazonaws.ec2#CapacityReservationOptions", - "traits": { - "aws.protocols#ec2QueryName": "CapacityReservationOptions", - "smithy.api#documentation": "

The strategy for using unused Capacity Reservations for fulfilling On-Demand\n capacity.

\n

Supported only for fleets of type instant.

", - "smithy.api#xmlName": "capacityReservationOptions" - } - }, - "SingleInstanceType": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "SingleInstanceType", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the\n fleet.

\n

Supported only for fleets of type instant.

", - "smithy.api#xmlName": "singleInstanceType" - } - }, - "SingleAvailabilityZone": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "SingleAvailabilityZone", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.

\n

Supported only for fleets of type instant.

", - "smithy.api#xmlName": "singleAvailabilityZone" - } - }, - "MinTargetCapacity": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "MinTargetCapacity", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is\n not reached, the fleet launches no instances.

\n

Supported only for fleets of type instant.

\n

At least one of the following must be specified: SingleAvailabilityZone |\n SingleInstanceType\n

", - "smithy.api#xmlName": "minTargetCapacity" - } - }, - "MaxTotalPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "MaxTotalPrice", - "smithy.api#documentation": "

The maximum amount per hour for On-Demand Instances that you're willing to pay.

", - "smithy.api#xmlName": "maxTotalPrice" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the configuration of On-Demand Instances in an EC2 Fleet.

" - } - }, - "com.amazonaws.ec2#OnDemandOptionsRequest": { - "type": "structure", - "members": { - "AllocationStrategy": { - "target": "com.amazonaws.ec2#FleetOnDemandAllocationStrategy", - "traits": { - "smithy.api#documentation": "

The strategy that determines the order of the launch template overrides to use in\n fulfilling On-Demand capacity.

\n

\n lowest-price - EC2 Fleet uses price to determine the order, launching the lowest\n price first.

\n

\n prioritized - EC2 Fleet uses the priority that you assigned to each launch\n template override, launching the highest priority first.

\n

Default: lowest-price\n

" - } - }, - "CapacityReservationOptions": { - "target": "com.amazonaws.ec2#CapacityReservationOptionsRequest", - "traits": { - "smithy.api#documentation": "

The strategy for using unused Capacity Reservations for fulfilling On-Demand\n capacity.

\n

Supported only for fleets of type instant.

" - } - }, - "SingleInstanceType": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the\n fleet.

\n

Supported only for fleets of type instant.

" - } - }, - "SingleAvailabilityZone": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.

\n

Supported only for fleets of type instant.

" - } - }, - "MinTargetCapacity": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is\n not reached, the fleet launches no instances.

\n

Supported only for fleets of type instant.

\n

At least one of the following must be specified: SingleAvailabilityZone |\n SingleInstanceType\n

" - } - }, - "MaxTotalPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The maximum amount per hour for On-Demand Instances that you're willing to pay.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the configuration of On-Demand Instances in an EC2 Fleet.

" - } - }, - "com.amazonaws.ec2#OperationType": { - "type": "enum", - "members": { - "add": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "add" - } - }, - "remove": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "remove" - } - } - } - }, - "com.amazonaws.ec2#OrganizationArnStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#xmlName": "OrganizationArn" - } - } - }, - "com.amazonaws.ec2#OrganizationalUnitArnStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#xmlName": "OrganizationalUnitArn" - } - } - }, - "com.amazonaws.ec2#OutpostArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws([a-z-]+)?:outposts:[a-z\\d-]+:\\d{12}:outpost/op-[a-f0-9]{17}$" - } - }, - "com.amazonaws.ec2#OwnerStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#xmlName": "Owner" - } - } - }, - "com.amazonaws.ec2#PacketHeaderStatement": { - "type": "structure", - "members": { - "SourceAddresses": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "SourceAddressSet", - "smithy.api#documentation": "

The source addresses.

", - "smithy.api#xmlName": "sourceAddressSet" - } - }, - "DestinationAddresses": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "DestinationAddressSet", - "smithy.api#documentation": "

The destination addresses.

", - "smithy.api#xmlName": "destinationAddressSet" - } - }, - "SourcePorts": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "SourcePortSet", - "smithy.api#documentation": "

The source ports.

", - "smithy.api#xmlName": "sourcePortSet" - } - }, - "DestinationPorts": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "DestinationPortSet", - "smithy.api#documentation": "

The destination ports.

", - "smithy.api#xmlName": "destinationPortSet" - } - }, - "SourcePrefixLists": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "SourcePrefixListSet", - "smithy.api#documentation": "

The source prefix lists.

", - "smithy.api#xmlName": "sourcePrefixListSet" - } - }, - "DestinationPrefixLists": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "DestinationPrefixListSet", - "smithy.api#documentation": "

The destination prefix lists.

", - "smithy.api#xmlName": "destinationPrefixListSet" - } - }, - "Protocols": { - "target": "com.amazonaws.ec2#ProtocolList", - "traits": { - "aws.protocols#ec2QueryName": "ProtocolSet", - "smithy.api#documentation": "

The protocols.

", - "smithy.api#xmlName": "protocolSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a packet header statement.

" - } - }, - "com.amazonaws.ec2#PacketHeaderStatementRequest": { - "type": "structure", - "members": { - "SourceAddresses": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#documentation": "

The source addresses.

", - "smithy.api#xmlName": "SourceAddress" - } - }, - "DestinationAddresses": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#documentation": "

The destination addresses.

", - "smithy.api#xmlName": "DestinationAddress" - } - }, - "SourcePorts": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#documentation": "

The source ports.

", - "smithy.api#xmlName": "SourcePort" - } - }, - "DestinationPorts": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#documentation": "

The destination ports.

", - "smithy.api#xmlName": "DestinationPort" - } - }, - "SourcePrefixLists": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#documentation": "

The source prefix lists.

", - "smithy.api#xmlName": "SourcePrefixList" - } - }, - "DestinationPrefixLists": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#documentation": "

The destination prefix lists.

", - "smithy.api#xmlName": "DestinationPrefixList" - } - }, - "Protocols": { - "target": "com.amazonaws.ec2#ProtocolList", - "traits": { - "smithy.api#documentation": "

The protocols.

", - "smithy.api#xmlName": "Protocol" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a packet header statement.

" - } - }, - "com.amazonaws.ec2#PartitionLoadFrequency": { - "type": "enum", - "members": { - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "none" - } - }, - "DAILY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "daily" - } - }, - "WEEKLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "weekly" - } - }, - "MONTHLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "monthly" - } - } - } - }, - "com.amazonaws.ec2#PathComponent": { - "type": "structure", - "members": { - "SequenceNumber": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "SequenceNumber", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The sequence number.

", - "smithy.api#xmlName": "sequenceNumber" - } - }, - "AclRule": { - "target": "com.amazonaws.ec2#AnalysisAclRule", - "traits": { - "aws.protocols#ec2QueryName": "AclRule", - "smithy.api#documentation": "

The network ACL rule.

", - "smithy.api#xmlName": "aclRule" - } - }, - "AttachedTo": { - "target": "com.amazonaws.ec2#AnalysisComponent", - "traits": { - "aws.protocols#ec2QueryName": "AttachedTo", - "smithy.api#documentation": "

The resource to which the path component is attached.

", - "smithy.api#xmlName": "attachedTo" - } - }, - "Component": { - "target": "com.amazonaws.ec2#AnalysisComponent", - "traits": { - "aws.protocols#ec2QueryName": "Component", - "smithy.api#documentation": "

The component.

", - "smithy.api#xmlName": "component" - } - }, - "DestinationVpc": { - "target": "com.amazonaws.ec2#AnalysisComponent", - "traits": { - "aws.protocols#ec2QueryName": "DestinationVpc", - "smithy.api#documentation": "

The destination VPC.

", - "smithy.api#xmlName": "destinationVpc" - } - }, - "OutboundHeader": { - "target": "com.amazonaws.ec2#AnalysisPacketHeader", - "traits": { - "aws.protocols#ec2QueryName": "OutboundHeader", - "smithy.api#documentation": "

The outbound header.

", - "smithy.api#xmlName": "outboundHeader" - } - }, - "InboundHeader": { - "target": "com.amazonaws.ec2#AnalysisPacketHeader", - "traits": { - "aws.protocols#ec2QueryName": "InboundHeader", - "smithy.api#documentation": "

The inbound header.

", - "smithy.api#xmlName": "inboundHeader" - } - }, - "RouteTableRoute": { - "target": "com.amazonaws.ec2#AnalysisRouteTableRoute", - "traits": { - "aws.protocols#ec2QueryName": "RouteTableRoute", - "smithy.api#documentation": "

The route table route.

", - "smithy.api#xmlName": "routeTableRoute" - } - }, - "SecurityGroupRule": { - "target": "com.amazonaws.ec2#AnalysisSecurityGroupRule", - "traits": { - "aws.protocols#ec2QueryName": "SecurityGroupRule", - "smithy.api#documentation": "

The security group rule.

", - "smithy.api#xmlName": "securityGroupRule" - } - }, - "SourceVpc": { - "target": "com.amazonaws.ec2#AnalysisComponent", - "traits": { - "aws.protocols#ec2QueryName": "SourceVpc", - "smithy.api#documentation": "

The source VPC.

", - "smithy.api#xmlName": "sourceVpc" - } - }, - "Subnet": { - "target": "com.amazonaws.ec2#AnalysisComponent", - "traits": { - "aws.protocols#ec2QueryName": "Subnet", - "smithy.api#documentation": "

The subnet.

", - "smithy.api#xmlName": "subnet" - } - }, - "Vpc": { - "target": "com.amazonaws.ec2#AnalysisComponent", - "traits": { - "aws.protocols#ec2QueryName": "Vpc", - "smithy.api#documentation": "

The component VPC.

", - "smithy.api#xmlName": "vpc" - } - }, - "AdditionalDetails": { - "target": "com.amazonaws.ec2#AdditionalDetailList", - "traits": { - "aws.protocols#ec2QueryName": "AdditionalDetailSet", - "smithy.api#documentation": "

The additional details.

", - "smithy.api#xmlName": "additionalDetailSet" - } - }, - "TransitGateway": { - "target": "com.amazonaws.ec2#AnalysisComponent", - "traits": { - "aws.protocols#ec2QueryName": "TransitGateway", - "smithy.api#documentation": "

The transit gateway.

", - "smithy.api#xmlName": "transitGateway" - } - }, - "TransitGatewayRouteTableRoute": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableRoute", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayRouteTableRoute", - "smithy.api#documentation": "

The route in a transit gateway route table.

", - "smithy.api#xmlName": "transitGatewayRouteTableRoute" - } - }, - "Explanations": { - "target": "com.amazonaws.ec2#ExplanationList", - "traits": { - "aws.protocols#ec2QueryName": "ExplanationSet", - "smithy.api#documentation": "

The explanation codes.

", - "smithy.api#xmlName": "explanationSet" - } - }, - "ElasticLoadBalancerListener": { - "target": "com.amazonaws.ec2#AnalysisComponent", - "traits": { - "aws.protocols#ec2QueryName": "ElasticLoadBalancerListener", - "smithy.api#documentation": "

The load balancer listener.

", - "smithy.api#xmlName": "elasticLoadBalancerListener" - } - }, - "FirewallStatelessRule": { - "target": "com.amazonaws.ec2#FirewallStatelessRule", - "traits": { - "aws.protocols#ec2QueryName": "FirewallStatelessRule", - "smithy.api#documentation": "

The Network Firewall stateless rule.

", - "smithy.api#xmlName": "firewallStatelessRule" - } - }, - "FirewallStatefulRule": { - "target": "com.amazonaws.ec2#FirewallStatefulRule", - "traits": { - "aws.protocols#ec2QueryName": "FirewallStatefulRule", - "smithy.api#documentation": "

The Network Firewall stateful rule.

", - "smithy.api#xmlName": "firewallStatefulRule" - } - }, - "ServiceName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ServiceName", - "smithy.api#documentation": "

The name of the VPC endpoint service.

", - "smithy.api#xmlName": "serviceName" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a path component.

" - } - }, - "com.amazonaws.ec2#PathComponentList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#PathComponent", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#PathFilter": { - "type": "structure", - "members": { - "SourceAddress": { - "target": "com.amazonaws.ec2#IpAddress", - "traits": { - "aws.protocols#ec2QueryName": "SourceAddress", - "smithy.api#documentation": "

The source IPv4 address.

", - "smithy.api#xmlName": "sourceAddress" - } - }, - "SourcePortRange": { - "target": "com.amazonaws.ec2#FilterPortRange", - "traits": { - "aws.protocols#ec2QueryName": "SourcePortRange", - "smithy.api#documentation": "

The source port range.

", - "smithy.api#xmlName": "sourcePortRange" - } - }, - "DestinationAddress": { - "target": "com.amazonaws.ec2#IpAddress", - "traits": { - "aws.protocols#ec2QueryName": "DestinationAddress", - "smithy.api#documentation": "

The destination IPv4 address.

", - "smithy.api#xmlName": "destinationAddress" - } - }, - "DestinationPortRange": { - "target": "com.amazonaws.ec2#FilterPortRange", - "traits": { - "aws.protocols#ec2QueryName": "DestinationPortRange", - "smithy.api#documentation": "

The destination port range.

", - "smithy.api#xmlName": "destinationPortRange" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a set of filters for a path analysis. Use path filters to scope the analysis when\n there can be multiple resulting paths.

" - } - }, - "com.amazonaws.ec2#PathRequestFilter": { - "type": "structure", - "members": { - "SourceAddress": { - "target": "com.amazonaws.ec2#IpAddress", - "traits": { - "smithy.api#documentation": "

The source IPv4 address.

" - } - }, - "SourcePortRange": { - "target": "com.amazonaws.ec2#RequestFilterPortRange", - "traits": { - "smithy.api#documentation": "

The source port range.

" - } - }, - "DestinationAddress": { - "target": "com.amazonaws.ec2#IpAddress", - "traits": { - "smithy.api#documentation": "

The destination IPv4 address.

" - } - }, - "DestinationPortRange": { - "target": "com.amazonaws.ec2#RequestFilterPortRange", - "traits": { - "smithy.api#documentation": "

The destination port range.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a set of filters for a path analysis. Use path filters to scope the analysis when\n there can be multiple resulting paths.

" - } - }, - "com.amazonaws.ec2#PathStatement": { - "type": "structure", - "members": { - "PacketHeaderStatement": { - "target": "com.amazonaws.ec2#PacketHeaderStatement", - "traits": { - "aws.protocols#ec2QueryName": "PacketHeaderStatement", - "smithy.api#documentation": "

The packet header statement.

", - "smithy.api#xmlName": "packetHeaderStatement" - } - }, - "ResourceStatement": { - "target": "com.amazonaws.ec2#ResourceStatement", - "traits": { - "aws.protocols#ec2QueryName": "ResourceStatement", - "smithy.api#documentation": "

The resource statement.

", - "smithy.api#xmlName": "resourceStatement" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a path statement.

" - } - }, - "com.amazonaws.ec2#PathStatementRequest": { - "type": "structure", - "members": { - "PacketHeaderStatement": { - "target": "com.amazonaws.ec2#PacketHeaderStatementRequest", - "traits": { - "smithy.api#documentation": "

The packet header statement.

" - } - }, - "ResourceStatement": { - "target": "com.amazonaws.ec2#ResourceStatementRequest", - "traits": { - "smithy.api#documentation": "

The resource statement.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a path statement.

" - } - }, - "com.amazonaws.ec2#PayerResponsibility": { - "type": "enum", - "members": { - "ServiceOwner": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ServiceOwner" - } - } - } - }, - "com.amazonaws.ec2#PaymentOption": { - "type": "enum", - "members": { - "ALL_UPFRONT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AllUpfront" - } - }, - "PARTIAL_UPFRONT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PartialUpfront" - } - }, - "NO_UPFRONT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NoUpfront" - } - } - } - }, - "com.amazonaws.ec2#PciId": { - "type": "structure", - "members": { - "DeviceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The ID of the device.

" - } - }, - "VendorId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The ID of the vendor.

" - } - }, - "SubsystemId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The ID of the subsystem.

" - } - }, - "SubsystemVendorId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The ID of the vendor for the subsystem.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the data that identifies an Amazon FPGA image (AFI) on the PCI bus.

" - } - }, - "com.amazonaws.ec2#PeeringAttachmentStatus": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The status code.

", - "smithy.api#xmlName": "code" - } - }, - "Message": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "

The status message, if applicable.

", - "smithy.api#xmlName": "message" - } - } - }, - "traits": { - "smithy.api#documentation": "

The status of the transit gateway peering attachment.

" - } - }, - "com.amazonaws.ec2#PeeringConnectionOptions": { - "type": "structure", - "members": { - "AllowDnsResolutionFromRemoteVpc": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "AllowDnsResolutionFromRemoteVpc", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

If true, the public DNS hostnames of instances in the specified VPC resolve to private\n IP addresses when queried from instances in the peer VPC.

", - "smithy.api#xmlName": "allowDnsResolutionFromRemoteVpc" - } - }, - "AllowEgressFromLocalClassicLinkToRemoteVpc": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "AllowEgressFromLocalClassicLinkToRemoteVpc", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

If true, enables outbound communication from an EC2-Classic instance that's linked to\n a local VPC using ClassicLink to instances in a peer VPC.

", - "smithy.api#xmlName": "allowEgressFromLocalClassicLinkToRemoteVpc" - } - }, - "AllowEgressFromLocalVpcToRemoteClassicLink": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "AllowEgressFromLocalVpcToRemoteClassicLink", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

If true, enables outbound communication from instances in a local VPC to an\n EC2-Classic instance that's linked to a peer VPC using ClassicLink.

", - "smithy.api#xmlName": "allowEgressFromLocalVpcToRemoteClassicLink" - } - } - }, - "traits": { - "smithy.api#documentation": "\n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n \n

Describes the VPC peering connection options.

" - } - }, - "com.amazonaws.ec2#PeeringConnectionOptionsRequest": { - "type": "structure", - "members": { - "AllowDnsResolutionFromRemoteVpc": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#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": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

If true, enables outbound communication from an EC2-Classic instance that's linked to\n a local VPC using ClassicLink to instances in a peer VPC.

" - } - }, - "AllowEgressFromLocalVpcToRemoteClassicLink": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

If true, enables outbound communication from instances in a local VPC to an\n EC2-Classic instance that's linked to a peer VPC using ClassicLink.

" - } - } - }, - "traits": { - "smithy.api#documentation": "\n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n \n

The VPC peering connection options.

" - } - }, - "com.amazonaws.ec2#PeeringTgwInfo": { - "type": "structure", - "members": { - "TransitGatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayId", - "smithy.api#documentation": "

The ID of the transit gateway.

", - "smithy.api#xmlName": "transitGatewayId" - } - }, - "CoreNetworkId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CoreNetworkId", - "smithy.api#documentation": "

The ID of the core network where the transit gateway peer is located.

", - "smithy.api#xmlName": "coreNetworkId" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the transit gateway.

", - "smithy.api#xmlName": "ownerId" - } - }, - "Region": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Region", - "smithy.api#documentation": "

The Region of the transit gateway.

", - "smithy.api#xmlName": "region" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the transit gateway in the peering attachment.

" - } - }, - "com.amazonaws.ec2#PeriodType": { - "type": "enum", - "members": { - "five_minutes": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "five-minutes" - } - }, - "fifteen_minutes": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "fifteen-minutes" - } - }, - "one_hour": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "one-hour" - } - }, - "three_hours": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "three-hours" - } - }, - "one_day": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "one-day" - } - }, - "one_week": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "one-week" - } - } - } - }, - "com.amazonaws.ec2#PermissionGroup": { - "type": "enum", - "members": { - "all": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "all" - } - } - } - }, - "com.amazonaws.ec2#Phase1DHGroupNumbersList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Phase1DHGroupNumbersListValue", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#Phase1DHGroupNumbersListValue": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Value", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The Diffie-Hellmann group number.

", - "smithy.api#xmlName": "value" - } - } - }, - "traits": { - "smithy.api#documentation": "

The Diffie-Hellmann group number for phase 1 IKE negotiations.

" - } - }, - "com.amazonaws.ec2#Phase1DHGroupNumbersRequestList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Phase1DHGroupNumbersRequestListValue", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#Phase1DHGroupNumbersRequestListValue": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The Diffie-Hellmann group number.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies a Diffie-Hellman group number for the VPN tunnel for phase 1 IKE\n negotiations.

" - } - }, - "com.amazonaws.ec2#Phase1EncryptionAlgorithmsList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Phase1EncryptionAlgorithmsListValue", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#Phase1EncryptionAlgorithmsListValue": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Value", - "smithy.api#documentation": "

The value for the encryption algorithm.

", - "smithy.api#xmlName": "value" - } - } - }, - "traits": { - "smithy.api#documentation": "

The encryption algorithm for phase 1 IKE negotiations.

" - } - }, - "com.amazonaws.ec2#Phase1EncryptionAlgorithmsRequestList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Phase1EncryptionAlgorithmsRequestListValue", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#Phase1EncryptionAlgorithmsRequestListValue": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The value for the encryption algorithm.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the encryption algorithm for the VPN tunnel for phase 1 IKE\n negotiations.

" - } - }, - "com.amazonaws.ec2#Phase1IntegrityAlgorithmsList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Phase1IntegrityAlgorithmsListValue", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#Phase1IntegrityAlgorithmsListValue": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Value", - "smithy.api#documentation": "

The value for the integrity algorithm.

", - "smithy.api#xmlName": "value" - } - } - }, - "traits": { - "smithy.api#documentation": "

The integrity algorithm for phase 1 IKE negotiations.

" - } - }, - "com.amazonaws.ec2#Phase1IntegrityAlgorithmsRequestList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Phase1IntegrityAlgorithmsRequestListValue", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#Phase1IntegrityAlgorithmsRequestListValue": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The value for the integrity algorithm.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the integrity algorithm for the VPN tunnel for phase 1 IKE\n negotiations.

" - } - }, - "com.amazonaws.ec2#Phase2DHGroupNumbersList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Phase2DHGroupNumbersListValue", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#Phase2DHGroupNumbersListValue": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Value", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The Diffie-Hellmann group number.

", - "smithy.api#xmlName": "value" - } - } - }, - "traits": { - "smithy.api#documentation": "

The Diffie-Hellmann group number for phase 2 IKE negotiations.

" - } - }, - "com.amazonaws.ec2#Phase2DHGroupNumbersRequestList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Phase2DHGroupNumbersRequestListValue", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#Phase2DHGroupNumbersRequestListValue": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The Diffie-Hellmann group number.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies a Diffie-Hellman group number for the VPN tunnel for phase 2 IKE\n negotiations.

" - } - }, - "com.amazonaws.ec2#Phase2EncryptionAlgorithmsList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Phase2EncryptionAlgorithmsListValue", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#Phase2EncryptionAlgorithmsListValue": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Value", - "smithy.api#documentation": "

The encryption algorithm.

", - "smithy.api#xmlName": "value" - } - } - }, - "traits": { - "smithy.api#documentation": "

The encryption algorithm for phase 2 IKE negotiations.

" - } - }, - "com.amazonaws.ec2#Phase2EncryptionAlgorithmsRequestList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Phase2EncryptionAlgorithmsRequestListValue", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#Phase2EncryptionAlgorithmsRequestListValue": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The encryption algorithm.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the encryption algorithm for the VPN tunnel for phase 2 IKE\n negotiations.

" - } - }, - "com.amazonaws.ec2#Phase2IntegrityAlgorithmsList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Phase2IntegrityAlgorithmsListValue", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#Phase2IntegrityAlgorithmsListValue": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Value", - "smithy.api#documentation": "

The integrity algorithm.

", - "smithy.api#xmlName": "value" - } - } - }, - "traits": { - "smithy.api#documentation": "

The integrity algorithm for phase 2 IKE negotiations.

" - } - }, - "com.amazonaws.ec2#Phase2IntegrityAlgorithmsRequestList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Phase2IntegrityAlgorithmsRequestListValue", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#Phase2IntegrityAlgorithmsRequestListValue": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The integrity algorithm.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the integrity algorithm for the VPN tunnel for phase 2 IKE\n negotiations.

" - } - }, - "com.amazonaws.ec2#Placement": { - "type": "structure", - "members": { - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone of the instance.

\n

If not specified, an Availability Zone will be automatically chosen for you based on\n the load balancing criteria for the Region.

\n

This parameter is not supported for CreateFleet.

", - "smithy.api#xmlName": "availabilityZone" - } - }, - "Affinity": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Affinity", - "smithy.api#documentation": "

The affinity setting for the instance on the Dedicated Host.

\n

This parameter is not supported for CreateFleet or ImportInstance.

", - "smithy.api#xmlName": "affinity" - } - }, - "GroupName": { - "target": "com.amazonaws.ec2#PlacementGroupName", - "traits": { - "aws.protocols#ec2QueryName": "GroupName", - "smithy.api#documentation": "

The name of the placement group that the instance is in. If you specify\n GroupName, you can't specify GroupId.

", - "smithy.api#xmlName": "groupName" - } - }, - "PartitionNumber": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "PartitionNumber", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of the partition that the instance is in. Valid only if the placement group\n strategy is set to partition.

\n

This parameter is not supported for CreateFleet.

", - "smithy.api#xmlName": "partitionNumber" - } - }, - "HostId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "HostId", - "smithy.api#documentation": "

The ID of the Dedicated Host on which the instance resides.

\n

This parameter is not supported for CreateFleet or ImportInstance.

", - "smithy.api#xmlName": "hostId" - } - }, - "Tenancy": { - "target": "com.amazonaws.ec2#Tenancy", - "traits": { - "aws.protocols#ec2QueryName": "Tenancy", - "smithy.api#documentation": "

The tenancy of the instance. An instance with a\n tenancy of dedicated runs on single-tenant hardware.

\n

This parameter is not supported for CreateFleet. The\n host tenancy is not supported for ImportInstance or\n for T3 instances that are configured for the unlimited CPU credit\n option.

", - "smithy.api#xmlName": "tenancy" - } - }, - "SpreadDomain": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SpreadDomain", - "smithy.api#documentation": "

Reserved for future use.

", - "smithy.api#xmlName": "spreadDomain" - } - }, - "HostResourceGroupArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "HostResourceGroupArn", - "smithy.api#documentation": "

The ARN of the host resource group in which to launch the instances.

\n

If you specify this parameter, either omit the Tenancy parameter or set it to host.

\n

This parameter is not supported for CreateFleet.

", - "smithy.api#xmlName": "hostResourceGroupArn" - } - }, - "GroupId": { - "target": "com.amazonaws.ec2#PlacementGroupId", - "traits": { - "aws.protocols#ec2QueryName": "GroupId", - "smithy.api#documentation": "

The ID of the placement group that the instance is in. If you specify\n GroupId, you can't specify GroupName.

", - "smithy.api#xmlName": "groupId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the placement of an instance.

" - } - }, - "com.amazonaws.ec2#PlacementGroup": { - "type": "structure", - "members": { - "GroupName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupName", - "smithy.api#documentation": "

The name of the placement group.

", - "smithy.api#xmlName": "groupName" - } - }, - "State": { - "target": "com.amazonaws.ec2#PlacementGroupState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the placement group.

", - "smithy.api#xmlName": "state" - } - }, - "Strategy": { - "target": "com.amazonaws.ec2#PlacementStrategy", - "traits": { - "aws.protocols#ec2QueryName": "Strategy", - "smithy.api#documentation": "

The placement strategy.

", - "smithy.api#xmlName": "strategy" - } - }, - "PartitionCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "PartitionCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of partitions. Valid only if strategy is\n set to partition.

", - "smithy.api#xmlName": "partitionCount" - } - }, - "GroupId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupId", - "smithy.api#documentation": "

The ID of the placement group.

", - "smithy.api#xmlName": "groupId" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags applied to the placement group.

", - "smithy.api#xmlName": "tagSet" - } - }, - "GroupArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the placement group.

", - "smithy.api#xmlName": "groupArn" - } - }, - "SpreadLevel": { - "target": "com.amazonaws.ec2#SpreadLevel", - "traits": { - "aws.protocols#ec2QueryName": "SpreadLevel", - "smithy.api#documentation": "

The spread level for the placement group. Only Outpost placement\n groups can be spread across hosts.

", - "smithy.api#xmlName": "spreadLevel" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a placement group.

" - } - }, - "com.amazonaws.ec2#PlacementGroupArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws([a-z-]+)?:ec2:[a-z\\d-]+:\\d{12}:placement-group/([^\\s].+[^\\s]){1,255}$" - } - }, - "com.amazonaws.ec2#PlacementGroupId": { - "type": "string" - }, - "com.amazonaws.ec2#PlacementGroupIdStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#PlacementGroupId", - "traits": { - "smithy.api#xmlName": "GroupId" - } - } - }, - "com.amazonaws.ec2#PlacementGroupInfo": { - "type": "structure", - "members": { - "SupportedStrategies": { - "target": "com.amazonaws.ec2#PlacementGroupStrategyList", - "traits": { - "aws.protocols#ec2QueryName": "SupportedStrategies", - "smithy.api#documentation": "

The supported placement group types.

", - "smithy.api#xmlName": "supportedStrategies" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the placement group support of the instance type.

" - } - }, - "com.amazonaws.ec2#PlacementGroupList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#PlacementGroup", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#PlacementGroupName": { - "type": "string" - }, - "com.amazonaws.ec2#PlacementGroupState": { - "type": "enum", - "members": { - "pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "available": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "available" - } - }, - "deleting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleting" - } - }, - "deleted": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleted" - } - } - } - }, - "com.amazonaws.ec2#PlacementGroupStrategy": { - "type": "enum", - "members": { - "cluster": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cluster" - } - }, - "partition": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "partition" - } - }, - "spread": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "spread" - } - } - } - }, - "com.amazonaws.ec2#PlacementGroupStrategyList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#PlacementGroupStrategy", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#PlacementGroupStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#PlacementGroupName" - } - }, - "com.amazonaws.ec2#PlacementResponse": { - "type": "structure", - "members": { - "GroupName": { - "target": "com.amazonaws.ec2#PlacementGroupName", - "traits": { - "aws.protocols#ec2QueryName": "GroupName", - "smithy.api#documentation": "

The name of the placement group that the instance is in.

", - "smithy.api#xmlName": "groupName" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the placement of an instance.

" - } - }, - "com.amazonaws.ec2#PlacementStrategy": { - "type": "enum", - "members": { - "cluster": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cluster" - } - }, - "spread": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "spread" - } - }, - "partition": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "partition" - } - } - } - }, - "com.amazonaws.ec2#PlatformValues": { - "type": "enum", - "members": { - "Windows": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Windows" - } - } - } - }, - "com.amazonaws.ec2#PoolCidrBlock": { - "type": "structure", - "members": { - "Cidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PoolCidrBlock", - "smithy.api#documentation": "

The CIDR block.

", - "smithy.api#xmlName": "poolCidrBlock" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a CIDR block for an address pool.

" - } - }, - "com.amazonaws.ec2#PoolCidrBlocksSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#PoolCidrBlock", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#PoolMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.ec2#Port": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 65535 - } - } - }, - "com.amazonaws.ec2#PortRange": { - "type": "structure", - "members": { - "From": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "From", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The first port in the range.

", - "smithy.api#xmlName": "from" - } - }, - "To": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "To", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The last port in the range.

", - "smithy.api#xmlName": "to" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a range of ports.

" - } - }, - "com.amazonaws.ec2#PortRangeList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#PortRange", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#PrefixList": { - "type": "structure", - "members": { - "Cidrs": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "CidrSet", - "smithy.api#documentation": "

The IP address range of the Amazon Web Service.

", - "smithy.api#xmlName": "cidrSet" - } - }, - "PrefixListId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrefixListId", - "smithy.api#documentation": "

The ID of the prefix.

", - "smithy.api#xmlName": "prefixListId" - } - }, - "PrefixListName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrefixListName", - "smithy.api#documentation": "

The name of the prefix.

", - "smithy.api#xmlName": "prefixListName" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes prefixes for Amazon Web Services services.

" - } - }, - "com.amazonaws.ec2#PrefixListAssociation": { - "type": "structure", - "members": { - "ResourceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceId", - "smithy.api#documentation": "

The ID of the resource.

", - "smithy.api#xmlName": "resourceId" - } - }, - "ResourceOwner": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceOwner", - "smithy.api#documentation": "

The owner of the resource.

", - "smithy.api#xmlName": "resourceOwner" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the resource with which a prefix list is associated.

" - } - }, - "com.amazonaws.ec2#PrefixListAssociationSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#PrefixListAssociation", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#PrefixListEntry": { - "type": "structure", - "members": { - "Cidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Cidr", - "smithy.api#documentation": "

The CIDR block.

", - "smithy.api#xmlName": "cidr" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

The description.

", - "smithy.api#xmlName": "description" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a prefix list entry.

" - } - }, - "com.amazonaws.ec2#PrefixListEntrySet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#PrefixListEntry", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#PrefixListId": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description for the security group rule that references this prefix list ID.

\n

Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9,\n spaces, and ._-:/()#,@[]+=;{}!$*

", - "smithy.api#xmlName": "description" - } - }, - "PrefixListId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrefixListId", - "smithy.api#documentation": "

The ID of the prefix.

", - "smithy.api#xmlName": "prefixListId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a prefix list ID.

" - } - }, - "com.amazonaws.ec2#PrefixListIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#PrefixListId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#PrefixListIdSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#PrefixListMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.ec2#PrefixListResourceId": { - "type": "string" - }, - "com.amazonaws.ec2#PrefixListResourceIdStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#PrefixListResourceId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#PrefixListSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#PrefixList", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#PrefixListState": { - "type": "enum", - "members": { - "create_in_progress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "create-in-progress" - } - }, - "create_complete": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "create-complete" - } - }, - "create_failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "create-failed" - } - }, - "modify_in_progress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "modify-in-progress" - } - }, - "modify_complete": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "modify-complete" - } - }, - "modify_failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "modify-failed" - } - }, - "restore_in_progress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "restore-in-progress" - } - }, - "restore_complete": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "restore-complete" - } - }, - "restore_failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "restore-failed" - } - }, - "delete_in_progress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "delete-in-progress" - } - }, - "delete_complete": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "delete-complete" - } - }, - "delete_failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "delete-failed" - } - } - } - }, - "com.amazonaws.ec2#PriceSchedule": { - "type": "structure", - "members": { - "Active": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Active", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.

\n

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.

", - "smithy.api#xmlName": "active" - } - }, - "CurrencyCode": { - "target": "com.amazonaws.ec2#CurrencyCodeValues", - "traits": { - "aws.protocols#ec2QueryName": "CurrencyCode", - "smithy.api#documentation": "

The currency for transacting the Reserved Instance resale.\n\t\t\t\tAt this time, the only supported currency is USD.

", - "smithy.api#xmlName": "currencyCode" - } - }, - "Price": { - "target": "com.amazonaws.ec2#Double", - "traits": { - "aws.protocols#ec2QueryName": "Price", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The fixed price for the term.

", - "smithy.api#xmlName": "price" - } - }, - "Term": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "aws.protocols#ec2QueryName": "Term", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", - "smithy.api#xmlName": "term" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the price for a Reserved Instance.

" - } - }, - "com.amazonaws.ec2#PriceScheduleList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#PriceSchedule", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#PriceScheduleSpecification": { - "type": "structure", - "members": { - "CurrencyCode": { - "target": "com.amazonaws.ec2#CurrencyCodeValues", - "traits": { - "aws.protocols#ec2QueryName": "CurrencyCode", - "smithy.api#documentation": "

The currency for transacting the Reserved Instance resale.\n\t\t\t\tAt this time, the only supported currency is USD.

", - "smithy.api#xmlName": "currencyCode" - } - }, - "Price": { - "target": "com.amazonaws.ec2#Double", - "traits": { - "aws.protocols#ec2QueryName": "Price", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The fixed price for the term.

", - "smithy.api#xmlName": "price" - } - }, - "Term": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "aws.protocols#ec2QueryName": "Term", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", - "smithy.api#xmlName": "term" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the price for a Reserved Instance.

" - } - }, - "com.amazonaws.ec2#PriceScheduleSpecificationList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#PriceScheduleSpecification", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#PricingDetail": { - "type": "structure", - "members": { - "Count": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Count", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of reservations available for the price.

", - "smithy.api#xmlName": "count" - } - }, - "Price": { - "target": "com.amazonaws.ec2#Double", - "traits": { - "aws.protocols#ec2QueryName": "Price", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The price per instance.

", - "smithy.api#xmlName": "price" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a Reserved Instance offering.

" - } - }, - "com.amazonaws.ec2#PricingDetailsList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#PricingDetail", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#PrincipalIdFormat": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Arn", - "smithy.api#documentation": "

PrincipalIdFormatARN description

", - "smithy.api#xmlName": "arn" - } - }, - "Statuses": { - "target": "com.amazonaws.ec2#IdFormatList", - "traits": { - "aws.protocols#ec2QueryName": "StatusSet", - "smithy.api#documentation": "

PrincipalIdFormatStatuses description

", - "smithy.api#xmlName": "statusSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

PrincipalIdFormat description

" - } - }, - "com.amazonaws.ec2#PrincipalIdFormatList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#PrincipalIdFormat", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#PrincipalType": { - "type": "enum", - "members": { - "All": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "All" - } - }, - "Service": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Service" - } - }, - "OrganizationUnit": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OrganizationUnit" - } - }, - "Account": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Account" - } - }, - "User": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "User" - } - }, - "Role": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Role" - } - } - } - }, - "com.amazonaws.ec2#Priority": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": -1, - "max": 65535 - } - } - }, - "com.amazonaws.ec2#PrivateDnsDetails": { - "type": "structure", - "members": { - "PrivateDnsName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrivateDnsName", - "smithy.api#documentation": "

The private DNS name assigned to the VPC endpoint service.

", - "smithy.api#xmlName": "privateDnsName" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the Private DNS name for interface endpoints.

" - } - }, - "com.amazonaws.ec2#PrivateDnsDetailsSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#PrivateDnsDetails", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#PrivateDnsNameConfiguration": { - "type": "structure", - "members": { - "State": { - "target": "com.amazonaws.ec2#DnsNameState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The verification state of the VPC endpoint service.

\n

>Consumers\n of the endpoint service can use the private name only when the state is\n verified.

", - "smithy.api#xmlName": "state" - } - }, - "Type": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Type", - "smithy.api#documentation": "

The endpoint service verification type, for example TXT.

", - "smithy.api#xmlName": "type" - } - }, - "Value": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Value", - "smithy.api#documentation": "

The value the service provider adds to the private DNS name domain record before verification.

", - "smithy.api#xmlName": "value" - } - }, - "Name": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Name", - "smithy.api#documentation": "

The name of the record subdomain the service provider needs to create. The service provider adds the value text to the name.

", - "smithy.api#xmlName": "name" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the private DNS name for the service endpoint.

" - } - }, - "com.amazonaws.ec2#PrivateDnsNameOptionsOnLaunch": { - "type": "structure", - "members": { - "HostnameType": { - "target": "com.amazonaws.ec2#HostnameType", - "traits": { - "aws.protocols#ec2QueryName": "HostnameType", - "smithy.api#documentation": "

The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name\n must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name\n must be based on the instance ID. For dual-stack subnets, you can specify whether DNS\n names use the instance IPv4 address or the instance ID.

", - "smithy.api#xmlName": "hostnameType" - } - }, - "EnableResourceNameDnsARecord": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "EnableResourceNameDnsARecord", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS A\n records.

", - "smithy.api#xmlName": "enableResourceNameDnsARecord" - } - }, - "EnableResourceNameDnsAAAARecord": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "EnableResourceNameDnsAAAARecord", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostname with DNS AAAA\n records.

", - "smithy.api#xmlName": "enableResourceNameDnsAAAARecord" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the options for instance hostnames.

" - } - }, - "com.amazonaws.ec2#PrivateDnsNameOptionsRequest": { - "type": "structure", - "members": { - "HostnameType": { - "target": "com.amazonaws.ec2#HostnameType", - "traits": { - "smithy.api#documentation": "

The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name\n must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name\n must be based on the instance ID. For dual-stack subnets, you can specify whether DNS\n names use the instance IPv4 address or the instance ID.

" - } - }, - "EnableResourceNameDnsARecord": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS A\n records.

" - } - }, - "EnableResourceNameDnsAAAARecord": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA\n records.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the options for instance hostnames.

" - } - }, - "com.amazonaws.ec2#PrivateDnsNameOptionsResponse": { - "type": "structure", - "members": { - "HostnameType": { - "target": "com.amazonaws.ec2#HostnameType", - "traits": { - "aws.protocols#ec2QueryName": "HostnameType", - "smithy.api#documentation": "

The type of hostname to assign to an instance.

", - "smithy.api#xmlName": "hostnameType" - } - }, - "EnableResourceNameDnsARecord": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "EnableResourceNameDnsARecord", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS A\n records.

", - "smithy.api#xmlName": "enableResourceNameDnsARecord" - } - }, - "EnableResourceNameDnsAAAARecord": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "EnableResourceNameDnsAAAARecord", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA\n records.

", - "smithy.api#xmlName": "enableResourceNameDnsAAAARecord" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the options for instance hostnames.

" - } - }, - "com.amazonaws.ec2#PrivateIpAddressConfigSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ScheduledInstancesPrivateIpAddressConfig", - "traits": { - "smithy.api#xmlName": "PrivateIpAddressConfigSet" - } - } - }, - "com.amazonaws.ec2#PrivateIpAddressCount": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 31 - } - } - }, - "com.amazonaws.ec2#PrivateIpAddressSpecification": { - "type": "structure", - "members": { - "Primary": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Primary", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the private IPv4 address is the primary private IPv4 address. Only\n one IPv4 address can be designated as primary.

", - "smithy.api#xmlName": "primary" - } - }, - "PrivateIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrivateIpAddress", - "smithy.api#documentation": "

The private IPv4 address.

", - "smithy.api#xmlName": "privateIpAddress" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a secondary private IPv4 address for a network interface.

" - } - }, - "com.amazonaws.ec2#PrivateIpAddressSpecificationList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#PrivateIpAddressSpecification", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#PrivateIpAddressStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#xmlName": "PrivateIpAddress" - } - } - }, - "com.amazonaws.ec2#ProcessorInfo": { - "type": "structure", - "members": { - "SupportedArchitectures": { - "target": "com.amazonaws.ec2#ArchitectureTypeList", - "traits": { - "aws.protocols#ec2QueryName": "SupportedArchitectures", - "smithy.api#documentation": "

The architectures supported by the instance type.

", - "smithy.api#xmlName": "supportedArchitectures" - } - }, - "SustainedClockSpeedInGhz": { - "target": "com.amazonaws.ec2#ProcessorSustainedClockSpeed", - "traits": { - "aws.protocols#ec2QueryName": "SustainedClockSpeedInGhz", - "smithy.api#documentation": "

The speed of the processor, in GHz.

", - "smithy.api#xmlName": "sustainedClockSpeedInGhz" - } - }, - "SupportedFeatures": { - "target": "com.amazonaws.ec2#SupportedAdditionalProcessorFeatureList", - "traits": { - "aws.protocols#ec2QueryName": "SupportedFeatures", - "smithy.api#documentation": "

Indicates whether the instance type supports AMD SEV-SNP. If the request returns \n amd-sev-snp, AMD SEV-SNP is supported. Otherwise, it is not supported.

", - "smithy.api#xmlName": "supportedFeatures" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the processor used by the instance type.

" - } - }, - "com.amazonaws.ec2#ProcessorSustainedClockSpeed": { - "type": "double" - }, - "com.amazonaws.ec2#ProductCode": { - "type": "structure", - "members": { - "ProductCodeId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ProductCode", - "smithy.api#documentation": "

The product code.

", - "smithy.api#xmlName": "productCode" - } - }, - "ProductCodeType": { - "target": "com.amazonaws.ec2#ProductCodeValues", - "traits": { - "aws.protocols#ec2QueryName": "Type", - "smithy.api#documentation": "

The type of product code.

", - "smithy.api#xmlName": "type" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a product code.

" - } - }, - "com.amazonaws.ec2#ProductCodeList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ProductCode", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ProductCodeStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#xmlName": "ProductCode" - } - } - }, - "com.amazonaws.ec2#ProductCodeValues": { - "type": "enum", - "members": { - "devpay": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "devpay" - } - }, - "marketplace": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "marketplace" - } - } - } - }, - "com.amazonaws.ec2#ProductDescriptionList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#String" - } - }, - "com.amazonaws.ec2#PropagatingVgw": { - "type": "structure", - "members": { - "GatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GatewayId", - "smithy.api#documentation": "

The ID of the virtual private gateway.

", - "smithy.api#xmlName": "gatewayId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a virtual private gateway propagating route.

" - } - }, - "com.amazonaws.ec2#PropagatingVgwList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#PropagatingVgw", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#Protocol": { - "type": "enum", - "members": { - "tcp": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "tcp" - } - }, - "udp": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "udp" - } - } - } - }, - "com.amazonaws.ec2#ProtocolInt": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 255 - } - } - }, - "com.amazonaws.ec2#ProtocolIntList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ProtocolInt", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ProtocolList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Protocol", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ProtocolValue": { - "type": "enum", - "members": { - "gre": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "gre" - } - } - } - }, - "com.amazonaws.ec2#ProvisionByoipCidr": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ProvisionByoipCidrRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ProvisionByoipCidrResult" - }, - "traits": { - "smithy.api#documentation": "

Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP \n addresses (BYOIP) and creates a corresponding address pool. After the address range is\n provisioned, it is ready to be advertised using AdvertiseByoipCidr.

\n

Amazon Web Services verifies that you own the address range and are authorized to advertise it. \n You must ensure that the address range is registered to you and that you created an \n RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. \n For more information, see Bring your own IP addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.

\n

Provisioning an address range is an asynchronous operation, so the call returns immediately,\n but the address range is not ready to use until its status changes from pending-provision\n to provisioned. To monitor the status of an address range, use DescribeByoipCidrs. \n To allocate an Elastic IP address from your IPv4 address pool, use AllocateAddress \n with either the specific address from the address pool or the ID of the address pool.

" - } - }, - "com.amazonaws.ec2#ProvisionByoipCidrRequest": { - "type": "structure", - "members": { - "Cidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 prefix that you can \n specify is /24. The most specific IPv6 prefix you can specify is /56. The address range cannot overlap with another address range that you've \n brought to this or another Region.

", - "smithy.api#required": {} - } - }, - "CidrAuthorizationContext": { - "target": "com.amazonaws.ec2#CidrAuthorizationContext", - "traits": { - "smithy.api#documentation": "

A signed document that proves that you are authorized to bring the specified IP address \n range to Amazon using BYOIP.

" - } - }, - "PubliclyAdvertisable": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

(IPv6 only) Indicate whether the address range will be publicly advertised to the\n internet.

\n

Default: true

" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A description for the address range and the address pool.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "PoolTagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the address pool.

", - "smithy.api#xmlName": "PoolTagSpecification" - } - }, - "MultiRegion": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Reserved.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ProvisionByoipCidrResult": { - "type": "structure", - "members": { - "ByoipCidr": { - "target": "com.amazonaws.ec2#ByoipCidr", - "traits": { - "aws.protocols#ec2QueryName": "ByoipCidr", - "smithy.api#documentation": "

Information about the address range.

", - "smithy.api#xmlName": "byoipCidr" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ProvisionIpamPoolCidr": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ProvisionIpamPoolCidrRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ProvisionIpamPoolCidrResult" - }, - "traits": { - "smithy.api#documentation": "

Provision a CIDR to an IPAM pool. You can use this action to provision new CIDRs to a top-level pool or to transfer a CIDR from a top-level pool to a pool within it.

\n

For more information, see Provision CIDRs to pools in the Amazon VPC IPAM User Guide.\n

" - } - }, - "com.amazonaws.ec2#ProvisionIpamPoolCidrRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "IpamPoolId": { - "target": "com.amazonaws.ec2#IpamPoolId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the IPAM pool to which you want to assign a CIDR.

", - "smithy.api#required": {} - } - }, - "Cidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The CIDR you want to assign to the IPAM pool. Either \"NetmaskLength\" or \"Cidr\" is required. This value will be null if you specify \"NetmaskLength\" and will be filled in during the provisioning process.

" - } - }, - "CidrAuthorizationContext": { - "target": "com.amazonaws.ec2#IpamCidrAuthorizationContext", - "traits": { - "smithy.api#documentation": "

A signed document that proves that you are authorized to bring a specified IP address range to Amazon using BYOIP. This option applies to public pools only.

" - } - }, - "NetmaskLength": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The netmask length of the CIDR you'd like to provision to a pool. Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. Either \"NetmaskLength\" or \"Cidr\" is required.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ProvisionIpamPoolCidrResult": { - "type": "structure", - "members": { - "IpamPoolCidr": { - "target": "com.amazonaws.ec2#IpamPoolCidr", - "traits": { - "aws.protocols#ec2QueryName": "IpamPoolCidr", - "smithy.api#documentation": "

Information about the provisioned CIDR.

", - "smithy.api#xmlName": "ipamPoolCidr" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ProvisionPublicIpv4PoolCidr": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ProvisionPublicIpv4PoolCidrRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ProvisionPublicIpv4PoolCidrResult" - }, - "traits": { - "smithy.api#documentation": "

Provision a CIDR to a public IPv4 pool.

\n

For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.

" - } - }, - "com.amazonaws.ec2#ProvisionPublicIpv4PoolCidrRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "IpamPoolId": { - "target": "com.amazonaws.ec2#IpamPoolId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the IPAM pool you would like to use to allocate this CIDR.

", - "smithy.api#required": {} - } - }, - "PoolId": { - "target": "com.amazonaws.ec2#Ipv4PoolEc2Id", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the public IPv4 pool you would like to use for this CIDR.

", - "smithy.api#required": {} - } - }, - "NetmaskLength": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The netmask length of the CIDR you would like to allocate to the public IPv4 pool.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ProvisionPublicIpv4PoolCidrResult": { - "type": "structure", - "members": { - "PoolId": { - "target": "com.amazonaws.ec2#Ipv4PoolEc2Id", - "traits": { - "aws.protocols#ec2QueryName": "PoolId", - "smithy.api#documentation": "

The ID of the pool that you want to provision the CIDR to.

", - "smithy.api#xmlName": "poolId" - } - }, - "PoolAddressRange": { - "target": "com.amazonaws.ec2#PublicIpv4PoolRange", - "traits": { - "aws.protocols#ec2QueryName": "PoolAddressRange", - "smithy.api#documentation": "

Information about the address range of the public IPv4 pool.

", - "smithy.api#xmlName": "poolAddressRange" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ProvisionedBandwidth": { - "type": "structure", - "members": { - "ProvisionTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "ProvisionTime", - "smithy.api#documentation": "

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", - "smithy.api#xmlName": "provisionTime" - } - }, - "Provisioned": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Provisioned", - "smithy.api#documentation": "

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", - "smithy.api#xmlName": "provisioned" - } - }, - "RequestTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "RequestTime", - "smithy.api#documentation": "

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", - "smithy.api#xmlName": "requestTime" - } - }, - "Requested": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Requested", - "smithy.api#documentation": "

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", - "smithy.api#xmlName": "requested" - } - }, - "Status": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", - "smithy.api#xmlName": "status" - } - } - }, - "traits": { - "smithy.api#documentation": "

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

" - } - }, - "com.amazonaws.ec2#PtrUpdateStatus": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Value", - "smithy.api#documentation": "

The value for the PTR record update.

", - "smithy.api#xmlName": "value" - } - }, - "Status": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The status of the PTR record update.

", - "smithy.api#xmlName": "status" - } - }, - "Reason": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Reason", - "smithy.api#documentation": "

The reason for the PTR record update.

", - "smithy.api#xmlName": "reason" - } - } - }, - "traits": { - "smithy.api#documentation": "

The status of an updated pointer (PTR) record for an Elastic IP address.

" - } - }, - "com.amazonaws.ec2#PublicIpAddress": { - "type": "string" - }, - "com.amazonaws.ec2#PublicIpStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#xmlName": "PublicIp" - } - } - }, - "com.amazonaws.ec2#PublicIpv4Pool": { - "type": "structure", - "members": { - "PoolId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PoolId", - "smithy.api#documentation": "

The ID of the address pool.

", - "smithy.api#xmlName": "poolId" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description of the address pool.

", - "smithy.api#xmlName": "description" - } - }, - "PoolAddressRanges": { - "target": "com.amazonaws.ec2#PublicIpv4PoolRangeSet", - "traits": { - "aws.protocols#ec2QueryName": "PoolAddressRangeSet", - "smithy.api#documentation": "

The address ranges.

", - "smithy.api#xmlName": "poolAddressRangeSet" - } - }, - "TotalAddressCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "TotalAddressCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The total number of addresses.

", - "smithy.api#xmlName": "totalAddressCount" - } - }, - "TotalAvailableAddressCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "TotalAvailableAddressCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The total number of available addresses.

", - "smithy.api#xmlName": "totalAvailableAddressCount" - } - }, - "NetworkBorderGroup": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NetworkBorderGroup", - "smithy.api#documentation": "

The name of the location from which the address pool is advertised. \n A network border group is a unique set of Availability Zones or Local Zones \n from where Amazon Web Services advertises public IP addresses.

", - "smithy.api#xmlName": "networkBorderGroup" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags for the address pool.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an IPv4 address pool.

" - } - }, - "com.amazonaws.ec2#PublicIpv4PoolIdStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Ipv4PoolEc2Id", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#PublicIpv4PoolRange": { - "type": "structure", - "members": { - "FirstAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "FirstAddress", - "smithy.api#documentation": "

The first IP address in the range.

", - "smithy.api#xmlName": "firstAddress" - } - }, - "LastAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LastAddress", - "smithy.api#documentation": "

The last IP address in the range.

", - "smithy.api#xmlName": "lastAddress" - } - }, - "AddressCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "AddressCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of addresses in the range.

", - "smithy.api#xmlName": "addressCount" - } - }, - "AvailableAddressCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "AvailableAddressCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of available addresses in the range.

", - "smithy.api#xmlName": "availableAddressCount" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an address range of an IPv4 address pool.

" - } - }, - "com.amazonaws.ec2#PublicIpv4PoolRangeSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#PublicIpv4PoolRange", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#PublicIpv4PoolSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#PublicIpv4Pool", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#Purchase": { - "type": "structure", - "members": { - "CurrencyCode": { - "target": "com.amazonaws.ec2#CurrencyCodeValues", - "traits": { - "aws.protocols#ec2QueryName": "CurrencyCode", - "smithy.api#documentation": "

The currency in which the UpfrontPrice and HourlyPrice\n amounts are specified. At this time, the only supported currency is\n USD.

", - "smithy.api#xmlName": "currencyCode" - } - }, - "Duration": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Duration", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The duration of the reservation's term in seconds.

", - "smithy.api#xmlName": "duration" - } - }, - "HostIdSet": { - "target": "com.amazonaws.ec2#ResponseHostIdSet", - "traits": { - "aws.protocols#ec2QueryName": "HostIdSet", - "smithy.api#documentation": "

The IDs of the Dedicated Hosts associated with the reservation.

", - "smithy.api#xmlName": "hostIdSet" - } - }, - "HostReservationId": { - "target": "com.amazonaws.ec2#HostReservationId", - "traits": { - "aws.protocols#ec2QueryName": "HostReservationId", - "smithy.api#documentation": "

The ID of the reservation.

", - "smithy.api#xmlName": "hostReservationId" - } - }, - "HourlyPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "HourlyPrice", - "smithy.api#documentation": "

The hourly price of the reservation per hour.

", - "smithy.api#xmlName": "hourlyPrice" - } - }, - "InstanceFamily": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceFamily", - "smithy.api#documentation": "

The instance family on the Dedicated Host that the reservation can be associated\n with.

", - "smithy.api#xmlName": "instanceFamily" - } - }, - "PaymentOption": { - "target": "com.amazonaws.ec2#PaymentOption", - "traits": { - "aws.protocols#ec2QueryName": "PaymentOption", - "smithy.api#documentation": "

The payment option for the reservation.

", - "smithy.api#xmlName": "paymentOption" - } - }, - "UpfrontPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "UpfrontPrice", - "smithy.api#documentation": "

The upfront price of the reservation.

", - "smithy.api#xmlName": "upfrontPrice" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the result of the purchase.

" - } - }, - "com.amazonaws.ec2#PurchaseHostReservation": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#PurchaseHostReservationRequest" - }, - "output": { - "target": "com.amazonaws.ec2#PurchaseHostReservationResult" - }, - "traits": { - "smithy.api#documentation": "

Purchase a reservation with configurations that match those of your Dedicated Host.\n You must have active Dedicated Hosts in your account before you purchase a reservation.\n This action results in the specified reservation being purchased and charged to your\n account.

" - } - }, - "com.amazonaws.ec2#PurchaseHostReservationRequest": { - "type": "structure", - "members": { - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

" - } - }, - "CurrencyCode": { - "target": "com.amazonaws.ec2#CurrencyCodeValues", - "traits": { - "smithy.api#documentation": "

The currency in which the totalUpfrontPrice, LimitPrice, and\n totalHourlyPrice amounts are specified. At this time, the only\n supported currency is USD.

" - } - }, - "HostIdSet": { - "target": "com.amazonaws.ec2#RequestHostIdSet", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IDs of the Dedicated Hosts with which the reservation will be associated.

", - "smithy.api#required": {} - } - }, - "LimitPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The specified limit is checked against the total upfront cost of the reservation\n (calculated as the offering's upfront cost multiplied by the host count). If the total\n upfront cost is greater than the specified price limit, the request fails. This is used\n to ensure that the purchase does not exceed the expected upfront cost of the purchase.\n At this time, the only supported currency is USD. For example, to indicate\n a limit price of USD 100, specify 100.00.

" - } - }, - "OfferingId": { - "target": "com.amazonaws.ec2#OfferingId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the offering.

", - "smithy.api#required": {} - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the Dedicated Host Reservation during purchase.

", - "smithy.api#xmlName": "TagSpecification" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#PurchaseHostReservationResult": { - "type": "structure", - "members": { - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

", - "smithy.api#xmlName": "clientToken" - } - }, - "CurrencyCode": { - "target": "com.amazonaws.ec2#CurrencyCodeValues", - "traits": { - "aws.protocols#ec2QueryName": "CurrencyCode", - "smithy.api#documentation": "

The currency in which the totalUpfrontPrice and\n totalHourlyPrice amounts are specified. At this time, the only\n supported currency is USD.

", - "smithy.api#xmlName": "currencyCode" - } - }, - "Purchase": { - "target": "com.amazonaws.ec2#PurchaseSet", - "traits": { - "aws.protocols#ec2QueryName": "Purchase", - "smithy.api#documentation": "

Describes the details of the purchase.

", - "smithy.api#xmlName": "purchase" - } - }, - "TotalHourlyPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TotalHourlyPrice", - "smithy.api#documentation": "

The total hourly price of the reservation calculated per hour.

", - "smithy.api#xmlName": "totalHourlyPrice" - } - }, - "TotalUpfrontPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TotalUpfrontPrice", - "smithy.api#documentation": "

The total amount charged to your account when you purchase the reservation.

", - "smithy.api#xmlName": "totalUpfrontPrice" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#PurchaseRequest": { - "type": "structure", - "members": { - "InstanceCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of instances.

", - "smithy.api#required": {} - } - }, - "PurchaseToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The purchase token.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a request to purchase Scheduled Instances.

" - } - }, - "com.amazonaws.ec2#PurchaseRequestSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#PurchaseRequest", - "traits": { - "smithy.api#xmlName": "PurchaseRequest" - } - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.ec2#PurchaseReservedInstancesOffering": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#PurchaseReservedInstancesOfferingRequest" - }, - "output": { - "target": "com.amazonaws.ec2#PurchaseReservedInstancesOfferingResult" - }, - "traits": { - "smithy.api#documentation": "

Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower \n hourly rate compared to On-Demand instance pricing.

\n

Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings \n\t\t\tthat match your specifications. After you've purchased a Reserved Instance, you can check for your\n\t\t\tnew Reserved Instance with DescribeReservedInstances.

\n

To queue a purchase for a future date and time, specify a purchase time. If you do not specify a\n purchase time, the default is the current time.

\n

For more information, see Reserved Instances and \n \t Reserved Instance Marketplace \n \t in the Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#PurchaseReservedInstancesOfferingRequest": { - "type": "structure", - "members": { - "InstanceCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of Reserved Instances to purchase.

", - "smithy.api#required": {} - } - }, - "ReservedInstancesOfferingId": { - "target": "com.amazonaws.ec2#ReservedInstancesOfferingId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Reserved Instance offering to purchase.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "LimitPrice": { - "target": "com.amazonaws.ec2#ReservedInstanceLimitPrice", - "traits": { - "aws.protocols#ec2QueryName": "LimitPrice", - "smithy.api#documentation": "

Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.

", - "smithy.api#xmlName": "limitPrice" - } - }, - "PurchaseTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "smithy.api#documentation": "

The time at which to purchase the Reserved Instance, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for PurchaseReservedInstancesOffering.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#PurchaseReservedInstancesOfferingResult": { - "type": "structure", - "members": { - "ReservedInstancesId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ReservedInstancesId", - "smithy.api#documentation": "

The IDs of the purchased Reserved Instances. If your purchase crosses into a discounted\n pricing tier, the final Reserved Instances IDs might change. For more information, see Crossing\n pricing tiers in the Amazon Elastic Compute Cloud User Guide.

", - "smithy.api#xmlName": "reservedInstancesId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of PurchaseReservedInstancesOffering.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#PurchaseScheduledInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#PurchaseScheduledInstancesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#PurchaseScheduledInstancesResult" - }, - "traits": { - "smithy.api#documentation": "\n

You can no longer purchase Scheduled Instances.

\n \n

Purchases the Scheduled Instances with the specified schedule.

\n

Scheduled Instances enable you to purchase Amazon EC2 compute capacity by the hour for a one-year term.\n Before you can purchase a Scheduled Instance, you must call DescribeScheduledInstanceAvailability\n to check for available schedules and obtain a purchase token. After you purchase a Scheduled Instance,\n you must call RunScheduledInstances during each scheduled time period.

\n

After you purchase a Scheduled Instance, you can't cancel, modify, or resell your purchase.

" - } - }, - "com.amazonaws.ec2#PurchaseScheduledInstancesRequest": { - "type": "structure", - "members": { - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that ensures the idempotency of the request. \n For more information, see Ensuring Idempotency.

", - "smithy.api#idempotencyToken": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "PurchaseRequests": { - "target": "com.amazonaws.ec2#PurchaseRequestSet", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The purchase requests.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "PurchaseRequest" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for PurchaseScheduledInstances.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#PurchaseScheduledInstancesResult": { - "type": "structure", - "members": { - "ScheduledInstanceSet": { - "target": "com.amazonaws.ec2#PurchasedScheduledInstanceSet", - "traits": { - "aws.protocols#ec2QueryName": "ScheduledInstanceSet", - "smithy.api#documentation": "

Information about the Scheduled Instances.

", - "smithy.api#xmlName": "scheduledInstanceSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of PurchaseScheduledInstances.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#PurchaseSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Purchase", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#PurchasedScheduledInstanceSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ScheduledInstance", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#RIProductDescription": { - "type": "enum", - "members": { - "Linux_UNIX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Linux/UNIX" - } - }, - "Linux_UNIX_Amazon_VPC_": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Linux/UNIX (Amazon VPC)" - } - }, - "Windows": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Windows" - } - }, - "Windows_Amazon_VPC_": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Windows (Amazon VPC)" - } - } - } - }, - "com.amazonaws.ec2#RamdiskId": { - "type": "string" - }, - "com.amazonaws.ec2#ReasonCodesList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ReportInstanceReasonCodes", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#RebootInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#RebootInstancesRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Requests a reboot of the specified instances. This operation is asynchronous; it only\n queues a request to reboot the specified instances. The operation succeeds if the\n instances are valid and belong to you. Requests to reboot terminated instances are\n ignored.

\n

If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a\n hard reboot.

\n

For more information about troubleshooting, see Troubleshoot an unreachable\n instance in the Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#RebootInstancesRequest": { - "type": "structure", - "members": { - "InstanceIds": { - "target": "com.amazonaws.ec2#InstanceIdStringList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The instance IDs.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "InstanceId" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#RecurringCharge": { - "type": "structure", - "members": { - "Amount": { - "target": "com.amazonaws.ec2#Double", - "traits": { - "aws.protocols#ec2QueryName": "Amount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The amount of the recurring charge.

", - "smithy.api#xmlName": "amount" - } - }, - "Frequency": { - "target": "com.amazonaws.ec2#RecurringChargeFrequency", - "traits": { - "aws.protocols#ec2QueryName": "Frequency", - "smithy.api#documentation": "

The frequency of the recurring charge.

", - "smithy.api#xmlName": "frequency" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a recurring charge.

" - } - }, - "com.amazonaws.ec2#RecurringChargeFrequency": { - "type": "enum", - "members": { - "Hourly": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Hourly" - } - } - } - }, - "com.amazonaws.ec2#RecurringChargesList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#RecurringCharge", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ReferencedSecurityGroup": { - "type": "structure", - "members": { - "GroupId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupId", - "smithy.api#documentation": "

The ID of the security group.

", - "smithy.api#xmlName": "groupId" - } - }, - "PeeringStatus": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PeeringStatus", - "smithy.api#documentation": "

The status of a VPC peering connection, if applicable.

", - "smithy.api#xmlName": "peeringStatus" - } - }, - "UserId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "UserId", - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#xmlName": "userId" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#xmlName": "vpcId" - } - }, - "VpcPeeringConnectionId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", - "smithy.api#documentation": "

The ID of the VPC peering connection.

", - "smithy.api#xmlName": "vpcPeeringConnectionId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the security group that is referenced in the security group rule.

" - } - }, - "com.amazonaws.ec2#Region": { - "type": "structure", - "members": { - "Endpoint": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "RegionEndpoint", - "smithy.api#documentation": "

The Region service endpoint.

", - "smithy.api#xmlName": "regionEndpoint" - } - }, - "RegionName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "RegionName", - "smithy.api#documentation": "

The name of the Region.

", - "smithy.api#xmlName": "regionName" - } - }, - "OptInStatus": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OptInStatus", - "smithy.api#documentation": "

The Region opt-in status. The possible values are opt-in-not-required, opted-in, and \n not-opted-in.

", - "smithy.api#xmlName": "optInStatus" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a Region.

" - } - }, - "com.amazonaws.ec2#RegionList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Region", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#RegionNameStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#xmlName": "RegionName" - } - } - }, - "com.amazonaws.ec2#RegionNames": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#String" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.ec2#RegisterImage": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#RegisterImageRequest" - }, - "output": { - "target": "com.amazonaws.ec2#RegisterImageResult" - }, - "traits": { - "smithy.api#documentation": "

Registers an AMI. When you're creating an AMI, this is the final step you must complete\n before you can launch an instance from the AMI. For more information about creating AMIs, see\n Create your\n own AMI in the Amazon Elastic Compute Cloud User Guide.

\n \n

For Amazon EBS-backed instances, CreateImage creates and registers the AMI\n in a single request, so you don't have to register the AMI yourself. We recommend that you\n always use CreateImage unless you have a specific reason to use\n RegisterImage.

\n \n

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. \n If you make changes to an image, deregister the previous image and register the new image.

\n

\n Register a snapshot of a root device volume\n

\n

You can use RegisterImage to create an Amazon EBS-backed Linux AMI from\n a snapshot of a root device volume. You specify the snapshot using a block device mapping.\n You can't set the encryption state of the volume using the block device mapping. If the \n snapshot is encrypted, or encryption by default is enabled, the root volume of an instance \n launched from the AMI is encrypted.

\n

For more information, see Create a Linux AMI from a snapshot and Use encryption with Amazon EBS-backed AMIs\n in the Amazon Elastic Compute Cloud User Guide.

\n

\n Amazon Web Services Marketplace product codes\n

\n

If any snapshots have Amazon Web Services Marketplace product codes, they are copied to the new\n AMI.

\n

Windows and some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE\n Linux Enterprise Server (SLES), use the Amazon EC2 billing product code associated with an AMI to\n verify the subscription status for package updates. To create a new AMI for operating systems\n that require a billing product code, instead of registering the AMI, do the following to\n preserve the billing product code association:

\n
    \n
  1. \n

    Launch an instance from an existing AMI with that billing product code.

    \n
    2. \n
  2. \n

    Customize the instance.

    \n
    3. \n
  3. \n

    Create an AMI from the instance using CreateImage.

    \n
    4. \n
\n

If you purchase a Reserved Instance to apply to an On-Demand Instance that was launched\n from an AMI with a billing product code, make sure that the Reserved Instance has the matching\n billing product code. If you purchase a Reserved Instance without the matching billing product\n code, the Reserved Instance will not be applied to the On-Demand Instance. For information\n about how to obtain the platform details and billing information of an AMI, see Understand AMI\n billing information in the Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#RegisterImageRequest": { - "type": "structure", - "members": { - "ImageLocation": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the \n \t\taws-exec-read canned access control list (ACL) to ensure that it can be accessed \n \t\tby Amazon EC2. For more information, see Canned ACLs in the \n \t\tAmazon S3 Service Developer Guide.

" - } - }, - "Architecture": { - "target": "com.amazonaws.ec2#ArchitectureValues", - "traits": { - "aws.protocols#ec2QueryName": "Architecture", - "smithy.api#documentation": "

The architecture of the AMI.

\n

Default: For Amazon EBS-backed AMIs, i386.\n For instance store-backed AMIs, the architecture specified in the manifest file.

", - "smithy.api#xmlName": "architecture" - } - }, - "BlockDeviceMappings": { - "target": "com.amazonaws.ec2#BlockDeviceMappingRequestList", - "traits": { - "smithy.api#documentation": "

The block device mapping entries.

\n

If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can't specify the encryption state of the volume.

\n

If you create an AMI on an Outpost, then all backing snapshots must be on the same\n Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can\n be used to launch instances on the same Outpost only. For more information, Amazon EBS local\n snapshots on Outposts in the Amazon EC2 User Guide.

", - "smithy.api#xmlName": "BlockDeviceMapping" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description for your AMI.

", - "smithy.api#xmlName": "description" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "EnaSupport": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "EnaSupport", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.

\n

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

", - "smithy.api#xmlName": "enaSupport" - } - }, - "KernelId": { - "target": "com.amazonaws.ec2#KernelId", - "traits": { - "aws.protocols#ec2QueryName": "KernelId", - "smithy.api#documentation": "

The ID of the kernel.

", - "smithy.api#xmlName": "kernelId" - } - }, - "Name": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Name", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A name for your AMI.

\n

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", - "smithy.api#required": {}, - "smithy.api#xmlName": "name" - } - }, - "BillingProducts": { - "target": "com.amazonaws.ec2#BillingProductList", - "traits": { - "smithy.api#documentation": "

The billing product codes. Your account must be authorized to specify billing product codes.

\n

If your account is not authorized to specify billing product codes, you can publish AMIs\n that include billable software and list them on the Amazon Web Services Marketplace. You must first register as a seller\n on the Amazon Web Services Marketplace. For more information, see Getting started as a\n seller and AMI-based\n products in the Amazon Web Services Marketplace Seller Guide.

", - "smithy.api#xmlName": "BillingProduct" - } - }, - "RamdiskId": { - "target": "com.amazonaws.ec2#RamdiskId", - "traits": { - "aws.protocols#ec2QueryName": "RamdiskId", - "smithy.api#documentation": "

The ID of the RAM disk.

", - "smithy.api#xmlName": "ramdiskId" - } - }, - "RootDeviceName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "RootDeviceName", - "smithy.api#documentation": "

The device name of the root device volume (for example, /dev/sda1).

", - "smithy.api#xmlName": "rootDeviceName" - } - }, - "SriovNetSupport": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SriovNetSupport", - "smithy.api#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.

\n

There is no way to disable sriovNetSupport at this time.

\n

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

", - "smithy.api#xmlName": "sriovNetSupport" - } - }, - "VirtualizationType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VirtualizationType", - "smithy.api#documentation": "

The type of virtualization (hvm | paravirtual).

\n

Default: paravirtual\n

", - "smithy.api#xmlName": "virtualizationType" - } - }, - "BootMode": { - "target": "com.amazonaws.ec2#BootModeValues", - "traits": { - "smithy.api#documentation": "

The boot mode of the AMI. A value of uefi-preferred indicates that the AMI supports both UEFI and Legacy BIOS.

\n \n

The operating system contained in the AMI must be configured to support the specified boot mode.

\n \n

For more information, see Boot modes in the\n Amazon EC2 User Guide.

" - } - }, - "TpmSupport": { - "target": "com.amazonaws.ec2#TpmSupportValues", - "traits": { - "smithy.api#documentation": "

Set to v2.0 to enable Trusted Platform Module (TPM) support. For more\n information, see NitroTPM in the Amazon EC2 User Guide.

" - } - }, - "UefiData": { - "target": "com.amazonaws.ec2#StringType", - "traits": { - "smithy.api#documentation": "

Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data,\n use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the\n python-uefivars tool on\n GitHub. For more information, see UEFI Secure Boot in the\n Amazon EC2 User Guide.

" - } - }, - "ImdsSupport": { - "target": "com.amazonaws.ec2#ImdsSupportValues", - "traits": { - "smithy.api#documentation": "

Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances\n launched from this AMI will have HttpTokens automatically set to\n required so that, by default, the instance requires that IMDSv2 is used when\n requesting instance metadata. In addition, HttpPutResponseHopLimit is set to\n 2. For more information, see Configure\n the AMI in the Amazon EC2 User Guide.

\n \n

If you set the value to v2.0, make sure that your AMI software can support IMDSv2.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for RegisterImage.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#RegisterImageResult": { - "type": "structure", - "members": { - "ImageId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ImageId", - "smithy.api#documentation": "

The ID of the newly registered AMI.

", - "smithy.api#xmlName": "imageId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of RegisterImage.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#RegisterInstanceEventNotificationAttributes": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#RegisterInstanceEventNotificationAttributesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#RegisterInstanceEventNotificationAttributesResult" - }, - "traits": { - "smithy.api#documentation": "

Registers a set of tag keys to include in scheduled event notifications for your resources. \n \t\t

\n

To remove tags, use DeregisterInstanceEventNotificationAttributes.

" - } - }, - "com.amazonaws.ec2#RegisterInstanceEventNotificationAttributesRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "InstanceTagAttribute": { - "target": "com.amazonaws.ec2#RegisterInstanceTagAttributeRequest", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Information about the tag keys to register.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#RegisterInstanceEventNotificationAttributesResult": { - "type": "structure", - "members": { - "InstanceTagAttribute": { - "target": "com.amazonaws.ec2#InstanceTagNotificationAttribute", - "traits": { - "aws.protocols#ec2QueryName": "InstanceTagAttribute", - "smithy.api#documentation": "

The resulting set of tag keys.

", - "smithy.api#xmlName": "instanceTagAttribute" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#RegisterInstanceTagAttributeRequest": { - "type": "structure", - "members": { - "IncludeAllTagsOfInstance": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to register all tag keys in the current Region. Specify true \n \tto register all tag keys.

" - } - }, - "InstanceTagKeys": { - "target": "com.amazonaws.ec2#InstanceTagKeySet", - "traits": { - "smithy.api#documentation": "

The tag keys to register.

", - "smithy.api#xmlName": "InstanceTagKey" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the tag keys to register for the current Region. You can either specify \n \tindividual tag keys or register all tag keys in the current Region. You must specify either\n \tIncludeAllTagsOfInstance or InstanceTagKeys in the request

" - } - }, - "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupMembers": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupMembersRequest" - }, - "output": { - "target": "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupMembersResult" - }, - "traits": { - "smithy.api#documentation": "

Registers members (network interfaces) with the transit gateway multicast group. A member is a network interface associated\n with a supported EC2 instance that receives multicast traffic. For information about\n supported instances, see Multicast\n Consideration in Amazon VPC Transit Gateways.

\n

After you add the members, use SearchTransitGatewayMulticastGroups to verify that the members were added\n to the transit gateway multicast group.

" - } - }, - "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupMembersRequest": { - "type": "structure", - "members": { - "TransitGatewayMulticastDomainId": { - "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", - "smithy.api#required": {} - } - }, - "GroupIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

" - } - }, - "NetworkInterfaceIds": { - "target": "com.amazonaws.ec2#TransitGatewayNetworkInterfaceIdList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The group members' network interface IDs to register with the transit gateway multicast group.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupMembersResult": { - "type": "structure", - "members": { - "RegisteredMulticastGroupMembers": { - "target": "com.amazonaws.ec2#TransitGatewayMulticastRegisteredGroupMembers", - "traits": { - "aws.protocols#ec2QueryName": "RegisteredMulticastGroupMembers", - "smithy.api#documentation": "

Information about the registered transit gateway multicast group members.

", - "smithy.api#xmlName": "registeredMulticastGroupMembers" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupSources": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupSourcesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupSourcesResult" - }, - "traits": { - "smithy.api#documentation": "

Registers sources (network interfaces) with the specified transit gateway multicast group.

\n

A multicast source is a network interface attached to a supported instance that sends\n multicast traffic. For information about supported instances, see Multicast\n Considerations in Amazon VPC Transit Gateways.

\n

After you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast\n group.

" - } - }, - "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupSourcesRequest": { - "type": "structure", - "members": { - "TransitGatewayMulticastDomainId": { - "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", - "smithy.api#required": {} - } - }, - "GroupIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

" - } - }, - "NetworkInterfaceIds": { - "target": "com.amazonaws.ec2#TransitGatewayNetworkInterfaceIdList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The group sources' network interface IDs to register with the transit gateway multicast group.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupSourcesResult": { - "type": "structure", - "members": { - "RegisteredMulticastGroupSources": { - "target": "com.amazonaws.ec2#TransitGatewayMulticastRegisteredGroupSources", - "traits": { - "aws.protocols#ec2QueryName": "RegisteredMulticastGroupSources", - "smithy.api#documentation": "

Information about the transit gateway multicast group sources.

", - "smithy.api#xmlName": "registeredMulticastGroupSources" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#RejectTransitGatewayMulticastDomainAssociations": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#RejectTransitGatewayMulticastDomainAssociationsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#RejectTransitGatewayMulticastDomainAssociationsResult" - }, - "traits": { - "smithy.api#documentation": "

Rejects a request to associate cross-account subnets with a transit gateway multicast domain.

" - } - }, - "com.amazonaws.ec2#RejectTransitGatewayMulticastDomainAssociationsRequest": { - "type": "structure", - "members": { - "TransitGatewayMulticastDomainId": { - "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", - "traits": { - "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

" - } - }, - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", - "traits": { - "smithy.api#documentation": "

The ID of the transit gateway attachment.

" - } - }, - "SubnetIds": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#documentation": "

The IDs of the subnets to associate with the transit gateway multicast domain.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#RejectTransitGatewayMulticastDomainAssociationsResult": { - "type": "structure", - "members": { - "Associations": { - "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainAssociations", - "traits": { - "aws.protocols#ec2QueryName": "Associations", - "smithy.api#documentation": "

Information about the multicast domain associations.

", - "smithy.api#xmlName": "associations" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#RejectTransitGatewayPeeringAttachment": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#RejectTransitGatewayPeeringAttachmentRequest" - }, - "output": { - "target": "com.amazonaws.ec2#RejectTransitGatewayPeeringAttachmentResult" - }, - "traits": { - "smithy.api#documentation": "

Rejects a transit gateway peering attachment request.

" - } - }, - "com.amazonaws.ec2#RejectTransitGatewayPeeringAttachmentRequest": { - "type": "structure", - "members": { - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the transit gateway peering attachment.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#RejectTransitGatewayPeeringAttachmentResult": { - "type": "structure", - "members": { - "TransitGatewayPeeringAttachment": { - "target": "com.amazonaws.ec2#TransitGatewayPeeringAttachment", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayPeeringAttachment", - "smithy.api#documentation": "

The transit gateway peering attachment.

", - "smithy.api#xmlName": "transitGatewayPeeringAttachment" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#RejectTransitGatewayVpcAttachment": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#RejectTransitGatewayVpcAttachmentRequest" - }, - "output": { - "target": "com.amazonaws.ec2#RejectTransitGatewayVpcAttachmentResult" - }, - "traits": { - "smithy.api#documentation": "

Rejects a request to attach a VPC to a transit gateway.

\n

The VPC attachment must be in the pendingAcceptance state.\n Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests.\n Use AcceptTransitGatewayVpcAttachment to accept a VPC attachment request.

" - } - }, - "com.amazonaws.ec2#RejectTransitGatewayVpcAttachmentRequest": { - "type": "structure", - "members": { - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the attachment.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#RejectTransitGatewayVpcAttachmentResult": { - "type": "structure", - "members": { - "TransitGatewayVpcAttachment": { - "target": "com.amazonaws.ec2#TransitGatewayVpcAttachment", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayVpcAttachment", - "smithy.api#documentation": "

Information about the attachment.

", - "smithy.api#xmlName": "transitGatewayVpcAttachment" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#RejectVpcEndpointConnections": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#RejectVpcEndpointConnectionsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#RejectVpcEndpointConnectionsResult" - }, - "traits": { - "smithy.api#documentation": "

Rejects VPC endpoint connection requests to your VPC endpoint service.

" - } - }, - "com.amazonaws.ec2#RejectVpcEndpointConnectionsRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "ServiceId": { - "target": "com.amazonaws.ec2#VpcEndpointServiceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the service.

", - "smithy.api#required": {} - } - }, - "VpcEndpointIds": { - "target": "com.amazonaws.ec2#VpcEndpointIdList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IDs of the VPC endpoints.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "VpcEndpointId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#RejectVpcEndpointConnectionsResult": { - "type": "structure", - "members": { - "Unsuccessful": { - "target": "com.amazonaws.ec2#UnsuccessfulItemSet", - "traits": { - "aws.protocols#ec2QueryName": "Unsuccessful", - "smithy.api#documentation": "

Information about the endpoints that were not rejected, if applicable.

", - "smithy.api#xmlName": "unsuccessful" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#RejectVpcPeeringConnection": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#RejectVpcPeeringConnectionRequest" - }, - "output": { - "target": "com.amazonaws.ec2#RejectVpcPeeringConnectionResult" - }, - "traits": { - "smithy.api#documentation": "

Rejects a VPC peering connection request. The VPC peering connection must be in the\n\t\t\t\tpending-acceptance state. Use the DescribeVpcPeeringConnections request\n\t\t\tto view your outstanding VPC peering connection requests. To delete an active VPC peering\n\t\t\tconnection, or to delete a VPC peering connection request that you initiated, use\tDeleteVpcPeeringConnection.

" - } - }, - "com.amazonaws.ec2#RejectVpcPeeringConnectionRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "VpcPeeringConnectionId": { - "target": "com.amazonaws.ec2#VpcPeeringConnectionId", - "traits": { - "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the VPC peering connection.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "vpcPeeringConnectionId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#RejectVpcPeeringConnectionResult": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ReleaseAddress": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ReleaseAddressRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Releases the specified Elastic IP address.

\n

[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it\n\t\t\t\tfrom any instance that it's associated with. To disassociate an Elastic IP address without\n\t\t\t\treleasing it, use DisassociateAddress.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n \n

[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address\n\t\t\t before you can release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).

\n

After releasing an Elastic IP address, it is released to the IP address pool. \n Be sure to update your DNS records and any servers or devices that communicate with the address. \n If you attempt to release an Elastic IP address that you already released, you'll get an\n AuthFailure error if the address is already allocated to another Amazon Web Services account.

\n

[EC2-VPC] After you release an Elastic IP address for use in a VPC, you might be able to recover it.\n For more information, see AllocateAddress.

\n

For more\n information, see Elastic IP\n Addresses in the Amazon Elastic Compute Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#ReleaseAddressRequest": { - "type": "structure", - "members": { - "AllocationId": { - "target": "com.amazonaws.ec2#AllocationId", - "traits": { - "smithy.api#documentation": "

[EC2-VPC] The allocation ID. Required for EC2-VPC.

" - } - }, - "PublicIp": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

" - } - }, - "NetworkBorderGroup": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises\n IP addresses.

\n

If you provide an incorrect network border group, you receive an InvalidAddress.NotFound error.

\n

You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you \n receive an InvalidParameterCombination error.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ReleaseHosts": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ReleaseHostsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ReleaseHostsResult" - }, - "traits": { - "smithy.api#documentation": "

When you no longer want to use an On-Demand Dedicated Host it can be released.\n On-Demand billing is stopped and the host goes into released state. The\n host ID of Dedicated Hosts that have been released can no longer be specified in another\n request, for example, to modify the host. You must stop or terminate all instances on a\n host before it can be released.

\n

When Dedicated Hosts are released, it may take some time for them to stop counting\n toward your limit and you may receive capacity errors when trying to allocate new\n Dedicated Hosts. Wait a few minutes and then try again.

\n

Released hosts still appear in a DescribeHosts response.

" - } - }, - "com.amazonaws.ec2#ReleaseHostsRequest": { - "type": "structure", - "members": { - "HostIds": { - "target": "com.amazonaws.ec2#RequestHostIdList", - "traits": { - "aws.protocols#ec2QueryName": "HostId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IDs of the Dedicated Hosts to release.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "hostId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ReleaseHostsResult": { - "type": "structure", - "members": { - "Successful": { - "target": "com.amazonaws.ec2#ResponseHostIdList", - "traits": { - "aws.protocols#ec2QueryName": "Successful", - "smithy.api#documentation": "

The IDs of the Dedicated Hosts that were successfully released.

", - "smithy.api#xmlName": "successful" - } - }, - "Unsuccessful": { - "target": "com.amazonaws.ec2#UnsuccessfulItemList", - "traits": { - "aws.protocols#ec2QueryName": "Unsuccessful", - "smithy.api#documentation": "

The IDs of the Dedicated Hosts that could not be released, including an error\n message.

", - "smithy.api#xmlName": "unsuccessful" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ReleaseIpamPoolAllocation": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ReleaseIpamPoolAllocationRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ReleaseIpamPoolAllocationResult" - }, - "traits": { - "smithy.api#documentation": "

Release an allocation within an IPAM pool. You can only use this action to release manual allocations. To remove an allocation for a resource without deleting the resource, set its monitored state to false using ModifyIpamResourceCidr. For more information, see Release an allocation in the Amazon VPC IPAM User Guide.\n

\n \n

All EC2 API actions follow an eventual consistency model.

\n " - } - }, - "com.amazonaws.ec2#ReleaseIpamPoolAllocationRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "IpamPoolId": { - "target": "com.amazonaws.ec2#IpamPoolId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the IPAM pool which contains the allocation you want to release.

", - "smithy.api#required": {} - } - }, - "Cidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The CIDR of the allocation you want to release.

", - "smithy.api#required": {} - } - }, - "IpamPoolAllocationId": { - "target": "com.amazonaws.ec2#IpamPoolAllocationId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the allocation.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ReleaseIpamPoolAllocationResult": { - "type": "structure", - "members": { - "Success": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Success", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates if the release was successful.

", - "smithy.api#xmlName": "success" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#RemoveIpamOperatingRegion": { - "type": "structure", - "members": { - "RegionName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The name of the operating Region you want to remove.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Remove an operating Region from an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

\n

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide\n

" - } - }, - "com.amazonaws.ec2#RemoveIpamOperatingRegionSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#RemoveIpamOperatingRegion" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.ec2#RemovePrefixListEntries": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#RemovePrefixListEntry" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.ec2#RemovePrefixListEntry": { - "type": "structure", - "members": { - "Cidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The CIDR block.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An entry for a prefix list.

" - } - }, - "com.amazonaws.ec2#ReplaceIamInstanceProfileAssociation": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ReplaceIamInstanceProfileAssociationRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ReplaceIamInstanceProfileAssociationResult" - }, - "traits": { - "smithy.api#documentation": "

Replaces an IAM instance profile for the specified running instance. You can use\n this action to change the IAM instance profile that's associated with an instance\n without having to disassociate the existing IAM instance profile first.

\n

Use DescribeIamInstanceProfileAssociations to get the association\n ID.

" - } - }, - "com.amazonaws.ec2#ReplaceIamInstanceProfileAssociationRequest": { - "type": "structure", - "members": { - "IamInstanceProfile": { - "target": "com.amazonaws.ec2#IamInstanceProfileSpecification", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IAM instance profile.

", - "smithy.api#required": {} - } - }, - "AssociationId": { - "target": "com.amazonaws.ec2#IamInstanceProfileAssociationId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the existing IAM instance profile association.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ReplaceIamInstanceProfileAssociationResult": { - "type": "structure", - "members": { - "IamInstanceProfileAssociation": { - "target": "com.amazonaws.ec2#IamInstanceProfileAssociation", - "traits": { - "aws.protocols#ec2QueryName": "IamInstanceProfileAssociation", - "smithy.api#documentation": "

Information about the IAM instance profile association.

", - "smithy.api#xmlName": "iamInstanceProfileAssociation" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ReplaceNetworkAclAssociation": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ReplaceNetworkAclAssociationRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ReplaceNetworkAclAssociationResult" - }, - "traits": { - "smithy.api#documentation": "

Changes which network ACL a subnet is associated with. By default when you create a\n\t\t\tsubnet, it's automatically associated with the default network ACL. For more\n\t\t\tinformation, see Network\n\t\t\tACLs in the Amazon Virtual Private Cloud User Guide.

\n

This is an idempotent operation.

" - } - }, - "com.amazonaws.ec2#ReplaceNetworkAclAssociationRequest": { - "type": "structure", - "members": { - "AssociationId": { - "target": "com.amazonaws.ec2#NetworkAclAssociationId", - "traits": { - "aws.protocols#ec2QueryName": "AssociationId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the current association between the original network ACL and the subnet.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "associationId" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "NetworkAclId": { - "target": "com.amazonaws.ec2#NetworkAclId", - "traits": { - "aws.protocols#ec2QueryName": "NetworkAclId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the new network ACL to associate with the subnet.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "networkAclId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ReplaceNetworkAclAssociationResult": { - "type": "structure", - "members": { - "NewAssociationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NewAssociationId", - "smithy.api#documentation": "

The ID of the new association.

", - "smithy.api#xmlName": "newAssociationId" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ReplaceNetworkAclEntry": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ReplaceNetworkAclEntryRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#ReplaceNetworkAclEntryRequest": { - "type": "structure", - "members": { - "CidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CidrBlock", - "smithy.api#documentation": "

The IPv4 network range to allow or deny, in CIDR notation (for example\n 172.16.0.0/24).

", - "smithy.api#xmlName": "cidrBlock" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "Egress": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Egress", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to replace the egress rule.

\n

Default: If no value is specified, we replace the ingress rule.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "egress" - } - }, - "IcmpTypeCode": { - "target": "com.amazonaws.ec2#IcmpTypeCode", - "traits": { - "smithy.api#documentation": "

ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol\n\t\t 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.

", - "smithy.api#xmlName": "Icmp" - } - }, - "Ipv6CidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6CidrBlock", - "smithy.api#documentation": "

The IPv6 network range to allow or deny, in CIDR notation (for example\n 2001:bd8:1234:1a00::/64).

", - "smithy.api#xmlName": "ipv6CidrBlock" - } - }, - "NetworkAclId": { - "target": "com.amazonaws.ec2#NetworkAclId", - "traits": { - "aws.protocols#ec2QueryName": "NetworkAclId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the ACL.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "networkAclId" - } - }, - "PortRange": { - "target": "com.amazonaws.ec2#PortRange", - "traits": { - "aws.protocols#ec2QueryName": "PortRange", - "smithy.api#documentation": "

TCP or UDP protocols: The range of ports the rule applies to. \n\t\t Required if specifying protocol 6 (TCP) or 17 (UDP).

", - "smithy.api#xmlName": "portRange" - } - }, - "Protocol": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Protocol", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The protocol number. A value of \"-1\" means all protocols. If you specify \"-1\" or a\n protocol number other than \"6\" (TCP), \"17\" (UDP), or \"1\" (ICMP), traffic on all ports is \n allowed, regardless of any ports or ICMP types or codes that you specify. If you specify \n protocol \"58\" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and \n codes allowed, regardless of any that you specify. If you specify protocol \"58\" (ICMPv6) \n and specify an IPv6 CIDR block, you must specify an ICMP type and code.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "protocol" - } - }, - "RuleAction": { - "target": "com.amazonaws.ec2#RuleAction", - "traits": { - "aws.protocols#ec2QueryName": "RuleAction", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Indicates whether to allow or deny the traffic that matches the rule.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "ruleAction" - } - }, - "RuleNumber": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "RuleNumber", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The rule number of the entry to replace.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "ruleNumber" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ReplaceRootVolumeTask": { - "type": "structure", - "members": { - "ReplaceRootVolumeTaskId": { - "target": "com.amazonaws.ec2#ReplaceRootVolumeTaskId", - "traits": { - "aws.protocols#ec2QueryName": "ReplaceRootVolumeTaskId", - "smithy.api#documentation": "

The ID of the root volume replacement task.

", - "smithy.api#xmlName": "replaceRootVolumeTaskId" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance for which the root volume replacement task was created.

", - "smithy.api#xmlName": "instanceId" - } - }, - "TaskState": { - "target": "com.amazonaws.ec2#ReplaceRootVolumeTaskState", - "traits": { - "aws.protocols#ec2QueryName": "TaskState", - "smithy.api#documentation": "

The state of the task. The task can be in one of the following states:

\n ", - "smithy.api#xmlName": "taskState" - } - }, - "StartTime": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StartTime", - "smithy.api#documentation": "

The time the task was started.

", - "smithy.api#xmlName": "startTime" - } - }, - "CompleteTime": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CompleteTime", - "smithy.api#documentation": "

The time the task completed.

", - "smithy.api#xmlName": "completeTime" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags assigned to the task.

", - "smithy.api#xmlName": "tagSet" - } - }, - "ImageId": { - "target": "com.amazonaws.ec2#ImageId", - "traits": { - "aws.protocols#ec2QueryName": "ImageId", - "smithy.api#documentation": "

The ID of the AMI used to create the replacement root volume.

", - "smithy.api#xmlName": "imageId" - } - }, - "SnapshotId": { - "target": "com.amazonaws.ec2#SnapshotId", - "traits": { - "aws.protocols#ec2QueryName": "SnapshotId", - "smithy.api#documentation": "

The ID of the snapshot used to create the replacement root volume.

", - "smithy.api#xmlName": "snapshotId" - } - }, - "DeleteReplacedRootVolume": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DeleteReplacedRootVolume", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the original root volume is to be deleted after the root volume \n replacement task completes.

", - "smithy.api#xmlName": "deleteReplacedRootVolume" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a root volume replacement task.

" - } - }, - "com.amazonaws.ec2#ReplaceRootVolumeTaskId": { - "type": "string" - }, - "com.amazonaws.ec2#ReplaceRootVolumeTaskIds": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ReplaceRootVolumeTaskId", - "traits": { - "smithy.api#xmlName": "ReplaceRootVolumeTaskId" - } - } - }, - "com.amazonaws.ec2#ReplaceRootVolumeTaskState": { - "type": "enum", - "members": { - "pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "in_progress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "in-progress" - } - }, - "failing": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failing" - } - }, - "succeeded": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "succeeded" - } - }, - "failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failed" - } - }, - "failed_detached": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failed-detached" - } - } - } - }, - "com.amazonaws.ec2#ReplaceRootVolumeTasks": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ReplaceRootVolumeTask", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ReplaceRoute": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ReplaceRouteRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Replaces an existing route within a route table in a VPC.

\n

You must specify either a destination CIDR block or a prefix list ID. You must also specify \n exactly one of the resources from the parameter list, or reset the local route to its default \n target.

\n

For more information, see Route tables in the\n Amazon Virtual Private Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#ReplaceRouteRequest": { - "type": "structure", - "members": { - "DestinationCidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DestinationCidrBlock", - "smithy.api#documentation": "

The IPv4 CIDR address block used for the destination match. The value that you\n\t\t\tprovide must match the CIDR of an existing route in the table.

", - "smithy.api#xmlName": "destinationCidrBlock" - } - }, - "DestinationIpv6CidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DestinationIpv6CidrBlock", - "smithy.api#documentation": "

The IPv6 CIDR address block used for the destination match. The value that you\n\t\t\tprovide must match the CIDR of an existing route in the table.

", - "smithy.api#xmlName": "destinationIpv6CidrBlock" - } - }, - "DestinationPrefixListId": { - "target": "com.amazonaws.ec2#PrefixListResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the prefix list for the route.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "VpcEndpointId": { - "target": "com.amazonaws.ec2#VpcEndpointId", - "traits": { - "smithy.api#documentation": "

The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.

" - } - }, - "EgressOnlyInternetGatewayId": { - "target": "com.amazonaws.ec2#EgressOnlyInternetGatewayId", - "traits": { - "aws.protocols#ec2QueryName": "EgressOnlyInternetGatewayId", - "smithy.api#documentation": "

[IPv6 traffic only] The ID of an egress-only internet gateway.

", - "smithy.api#xmlName": "egressOnlyInternetGatewayId" - } - }, - "GatewayId": { - "target": "com.amazonaws.ec2#RouteGatewayId", - "traits": { - "aws.protocols#ec2QueryName": "GatewayId", - "smithy.api#documentation": "

The ID of an internet gateway or virtual private gateway.

", - "smithy.api#xmlName": "gatewayId" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of a NAT instance in your VPC.

", - "smithy.api#xmlName": "instanceId" - } - }, - "LocalTarget": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether to reset the local route to its default target (local).

" - } - }, - "NatGatewayId": { - "target": "com.amazonaws.ec2#NatGatewayId", - "traits": { - "aws.protocols#ec2QueryName": "NatGatewayId", - "smithy.api#documentation": "

[IPv4 traffic only] The ID of a NAT gateway.

", - "smithy.api#xmlName": "natGatewayId" - } - }, - "TransitGatewayId": { - "target": "com.amazonaws.ec2#TransitGatewayId", - "traits": { - "smithy.api#documentation": "

The ID of a transit gateway.

" - } - }, - "LocalGatewayId": { - "target": "com.amazonaws.ec2#LocalGatewayId", - "traits": { - "smithy.api#documentation": "

The ID of the local gateway.

" - } - }, - "CarrierGatewayId": { - "target": "com.amazonaws.ec2#CarrierGatewayId", - "traits": { - "smithy.api#documentation": "

[IPv4 traffic only] The ID of a carrier gateway.

" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#NetworkInterfaceId", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "

The ID of a network interface.

", - "smithy.api#xmlName": "networkInterfaceId" - } - }, - "RouteTableId": { - "target": "com.amazonaws.ec2#RouteTableId", - "traits": { - "aws.protocols#ec2QueryName": "RouteTableId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the route table.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "routeTableId" - } - }, - "VpcPeeringConnectionId": { - "target": "com.amazonaws.ec2#VpcPeeringConnectionId", - "traits": { - "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", - "smithy.api#documentation": "

The ID of a VPC peering connection.

", - "smithy.api#xmlName": "vpcPeeringConnectionId" - } - }, - "CoreNetworkArn": { - "target": "com.amazonaws.ec2#CoreNetworkArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the core network.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ReplaceRouteTableAssociation": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ReplaceRouteTableAssociationRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ReplaceRouteTableAssociationResult" - }, - "traits": { - "smithy.api#documentation": "

Changes the route table associated with a given subnet, internet gateway, or virtual private gateway in a VPC. After the operation\n completes, the subnet or gateway uses the routes in the new route table. For more\n information about route tables, see Route\n tables in the Amazon Virtual Private Cloud User Guide.

\n

You can also use this operation to change which table is the main route table in the VPC. Specify the main route table's association ID and the route table ID of the new main route table.

" - } - }, - "com.amazonaws.ec2#ReplaceRouteTableAssociationRequest": { - "type": "structure", - "members": { - "AssociationId": { - "target": "com.amazonaws.ec2#RouteTableAssociationId", - "traits": { - "aws.protocols#ec2QueryName": "AssociationId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The association ID.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "associationId" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "RouteTableId": { - "target": "com.amazonaws.ec2#RouteTableId", - "traits": { - "aws.protocols#ec2QueryName": "RouteTableId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the new route table to associate with the subnet.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "routeTableId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ReplaceRouteTableAssociationResult": { - "type": "structure", - "members": { - "NewAssociationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NewAssociationId", - "smithy.api#documentation": "

The ID of the new association.

", - "smithy.api#xmlName": "newAssociationId" - } - }, - "AssociationState": { - "target": "com.amazonaws.ec2#RouteTableAssociationState", - "traits": { - "aws.protocols#ec2QueryName": "AssociationState", - "smithy.api#documentation": "

The state of the association.

", - "smithy.api#xmlName": "associationState" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ReplaceTransitGatewayRoute": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ReplaceTransitGatewayRouteRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ReplaceTransitGatewayRouteResult" - }, - "traits": { - "smithy.api#documentation": "

Replaces the specified route in the specified transit gateway route table.

" - } - }, - "com.amazonaws.ec2#ReplaceTransitGatewayRouteRequest": { - "type": "structure", - "members": { - "DestinationCidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The CIDR range used for the destination match. Routing decisions are based on the most specific match.

", - "smithy.api#required": {} - } - }, - "TransitGatewayRouteTableId": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the route table.

", - "smithy.api#required": {} - } - }, - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", - "traits": { - "smithy.api#documentation": "

The ID of the attachment.

" - } - }, - "Blackhole": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether traffic matching this route is to be dropped.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ReplaceTransitGatewayRouteResult": { - "type": "structure", - "members": { - "Route": { - "target": "com.amazonaws.ec2#TransitGatewayRoute", - "traits": { - "aws.protocols#ec2QueryName": "Route", - "smithy.api#documentation": "

Information about the modified route.

", - "smithy.api#xmlName": "route" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ReplaceVpnTunnel": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ReplaceVpnTunnelRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ReplaceVpnTunnelResult" - }, - "traits": { - "smithy.api#documentation": "

Trigger replacement of specified VPN tunnel.

" - } - }, - "com.amazonaws.ec2#ReplaceVpnTunnelRequest": { - "type": "structure", - "members": { - "VpnConnectionId": { - "target": "com.amazonaws.ec2#VpnConnectionId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Site-to-Site VPN connection.

", - "smithy.api#required": {} - } - }, - "VpnTunnelOutsideIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The external IP address of the VPN tunnel.

", - "smithy.api#required": {} - } - }, - "ApplyPendingMaintenance": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Trigger pending tunnel endpoint maintenance.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ReplaceVpnTunnelResult": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Confirmation of replace tunnel operation.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ReplacementStrategy": { - "type": "enum", - "members": { - "LAUNCH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "launch" - } - }, - "LAUNCH_BEFORE_TERMINATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "launch-before-terminate" - } - } - } - }, - "com.amazonaws.ec2#ReportInstanceReasonCodes": { - "type": "enum", - "members": { - "instance_stuck_in_state": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "instance-stuck-in-state" - } - }, - "unresponsive": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unresponsive" - } - }, - "not_accepting_credentials": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "not-accepting-credentials" - } - }, - "password_not_available": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "password-not-available" - } - }, - "performance_network": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "performance-network" - } - }, - "performance_instance_store": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "performance-instance-store" - } - }, - "performance_ebs_volume": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "performance-ebs-volume" - } - }, - "performance_other": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "performance-other" - } - }, - "other": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "other" - } - } - } - }, - "com.amazonaws.ec2#ReportInstanceStatus": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ReportInstanceStatusRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Submits feedback about the status of an instance. The instance must be in the\n running state. If your experience with the instance differs from the\n instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon\n EC2 collects this information to improve the accuracy of status checks.

\n

Use of this action does not change the value returned by DescribeInstanceStatus.

" - } - }, - "com.amazonaws.ec2#ReportInstanceStatusRequest": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

Descriptive text about the health state of your instance.

", - "smithy.api#xmlName": "description" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "EndTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "EndTime", - "smithy.api#documentation": "

The time at which the reported instance health state ended.

", - "smithy.api#xmlName": "endTime" - } - }, - "Instances": { - "target": "com.amazonaws.ec2#InstanceIdStringList", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The instances.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "instanceId" - } - }, - "ReasonCodes": { - "target": "com.amazonaws.ec2#ReasonCodesList", - "traits": { - "aws.protocols#ec2QueryName": "ReasonCode", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The reason codes that describe the health state of your instance.

\n ", - "smithy.api#required": {}, - "smithy.api#xmlName": "reasonCode" - } - }, - "StartTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "StartTime", - "smithy.api#documentation": "

The time at which the reported instance health state began.

", - "smithy.api#xmlName": "startTime" - } - }, - "Status": { - "target": "com.amazonaws.ec2#ReportStatusType", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The status of all instances listed.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "status" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ReportStatusType": { - "type": "enum", - "members": { - "ok": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ok" - } - }, - "impaired": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "impaired" - } - } - } - }, - "com.amazonaws.ec2#RequestFilterPortRange": { - "type": "structure", - "members": { - "FromPort": { - "target": "com.amazonaws.ec2#Port", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The first port in the range.

" - } - }, - "ToPort": { - "target": "com.amazonaws.ec2#Port", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The last port in the range.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a port range.

" - } - }, - "com.amazonaws.ec2#RequestHostIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#DedicatedHostId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#RequestHostIdSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#DedicatedHostId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#RequestInstanceTypeList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#InstanceType" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.ec2#RequestIpamResourceTag": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

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.

" - } - }, - "Value": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The value for the tag.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A tag on an IPAM resource.

" - } - }, - "com.amazonaws.ec2#RequestIpamResourceTagList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#RequestIpamResourceTag", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#RequestLaunchTemplateData": { - "type": "structure", - "members": { - "KernelId": { - "target": "com.amazonaws.ec2#KernelId", - "traits": { - "smithy.api#documentation": "

The ID of the kernel.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon Elastic Compute Cloud User Guide.

\n " - } - }, - "EbsOptimized": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the instance is optimized for Amazon EBS I/O. This optimization\n provides dedicated throughput to Amazon EBS and an optimized configuration stack to\n provide optimal Amazon EBS I/O performance. This optimization isn't available with all\n instance types. Additional usage charges apply when using an EBS-optimized\n instance.

" - } - }, - "IamInstanceProfile": { - "target": "com.amazonaws.ec2#LaunchTemplateIamInstanceProfileSpecificationRequest", - "traits": { - "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of an IAM instance profile.

" - } - }, - "BlockDeviceMappings": { - "target": "com.amazonaws.ec2#LaunchTemplateBlockDeviceMappingRequestList", - "traits": { - "smithy.api#documentation": "

The block device mapping.

", - "smithy.api#xmlName": "BlockDeviceMapping" - } - }, - "NetworkInterfaces": { - "target": "com.amazonaws.ec2#LaunchTemplateInstanceNetworkInterfaceSpecificationRequestList", - "traits": { - "smithy.api#documentation": "

One or more network interfaces. If you specify a network interface, you must specify\n any security groups and subnets as part of the network interface.

", - "smithy.api#xmlName": "NetworkInterface" - } - }, - "ImageId": { - "target": "com.amazonaws.ec2#ImageId", - "traits": { - "smithy.api#documentation": "

The ID of the AMI. Alternatively, you can specify a Systems Manager parameter, which\n will resolve to an AMI ID on launch.

\n

Valid formats:

\n \n \n

Currently, EC2 Fleet and Spot Fleet do not support specifying a Systems Manager parameter. \n If the launch template will be used by an EC2 Fleet or Spot Fleet, you must specify the AMI ID.

\n \n

For more information, see Use a Systems Manager parameter instead of an AMI ID in the Amazon Elastic Compute Cloud User Guide.

" - } - }, - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", - "traits": { - "smithy.api#documentation": "

The instance type. For more information, see Instance types in the\n Amazon Elastic Compute Cloud User Guide.

\n

If you specify InstanceType, you can't specify\n InstanceRequirements.

" - } - }, - "KeyName": { - "target": "com.amazonaws.ec2#KeyPairName", - "traits": { - "smithy.api#documentation": "

The name of the key pair. You can create a key pair using CreateKeyPair or\n ImportKeyPair.

\n \n

If you do not specify a key pair, you can't connect to the instance unless you\n choose an AMI that is configured to allow users another way to log in.

\n " - } - }, - "Monitoring": { - "target": "com.amazonaws.ec2#LaunchTemplatesMonitoringRequest", - "traits": { - "smithy.api#documentation": "

The monitoring for the instance.

" - } - }, - "Placement": { - "target": "com.amazonaws.ec2#LaunchTemplatePlacementRequest", - "traits": { - "smithy.api#documentation": "

The placement for the instance.

" - } - }, - "RamDiskId": { - "target": "com.amazonaws.ec2#RamdiskId", - "traits": { - "smithy.api#documentation": "

The ID of the RAM disk.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon Elastic Compute Cloud User Guide.

\n " - } - }, - "DisableApiTermination": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

If you set this parameter to true, you can't terminate the instance using\n the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after\n launch, use ModifyInstanceAttribute. Alternatively, if you set\n InstanceInitiatedShutdownBehavior to terminate, you can\n terminate the instance by running the shutdown command from the instance.

" - } - }, - "InstanceInitiatedShutdownBehavior": { - "target": "com.amazonaws.ec2#ShutdownBehavior", - "traits": { - "smithy.api#documentation": "

Indicates whether an instance stops or terminates when you initiate shutdown from the\n instance (using the operating system command for system shutdown).

\n

Default: stop\n

" - } - }, - "UserData": { - "target": "com.amazonaws.ec2#SensitiveUserData", - "traits": { - "smithy.api#documentation": "

The user data to make available to the instance. You must provide base64-encoded text.\n User data is limited to 16 KB. For more information, see Run commands on your Linux instance at\n launch (Linux) or Work with instance\n user data (Windows) in the Amazon Elastic Compute Cloud User Guide.

\n

If you are creating the launch template for use with Batch, the user\n data must be provided in the MIME multi-part archive format. For more information, see Amazon EC2 user data in launch templates in the Batch User Guide.

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#LaunchTemplateTagSpecificationRequestList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the resources that are created during instance launch.

\n

You can specify tags for the following resources only:

\n \n

To tag a resource after it has been created, see CreateTags.

\n \n

To tag the launch template itself, you must use the TagSpecification parameter.

\n ", - "smithy.api#xmlName": "TagSpecification" - } - }, - "ElasticGpuSpecifications": { - "target": "com.amazonaws.ec2#ElasticGpuSpecificationList", - "traits": { - "smithy.api#documentation": "

An elastic GPU to associate with the instance.

", - "smithy.api#xmlName": "ElasticGpuSpecification" - } - }, - "ElasticInferenceAccelerators": { - "target": "com.amazonaws.ec2#LaunchTemplateElasticInferenceAcceleratorList", - "traits": { - "smithy.api#documentation": "

The elastic inference accelerator for the instance.

", - "smithy.api#xmlName": "ElasticInferenceAccelerator" - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.ec2#SecurityGroupIdStringList", - "traits": { - "smithy.api#documentation": "

One or more security group IDs. You can create a security group using CreateSecurityGroup. You cannot specify both a security group ID and\n security name in the same request.

", - "smithy.api#xmlName": "SecurityGroupId" - } - }, - "SecurityGroups": { - "target": "com.amazonaws.ec2#SecurityGroupStringList", - "traits": { - "smithy.api#documentation": "

One or more security group names. For a nondefault VPC, you must use security group\n IDs instead. You cannot specify both a security group ID and security name in the same\n request.

", - "smithy.api#xmlName": "SecurityGroup" - } - }, - "InstanceMarketOptions": { - "target": "com.amazonaws.ec2#LaunchTemplateInstanceMarketOptionsRequest", - "traits": { - "smithy.api#documentation": "

The market (purchasing) option for the instances.

" - } - }, - "CreditSpecification": { - "target": "com.amazonaws.ec2#CreditSpecificationRequest", - "traits": { - "smithy.api#documentation": "

The credit option for CPU usage of the instance. Valid only for T instances.

" - } - }, - "CpuOptions": { - "target": "com.amazonaws.ec2#LaunchTemplateCpuOptionsRequest", - "traits": { - "smithy.api#documentation": "

The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User\n Guide.

" - } - }, - "CapacityReservationSpecification": { - "target": "com.amazonaws.ec2#LaunchTemplateCapacityReservationSpecificationRequest", - "traits": { - "smithy.api#documentation": "

The Capacity Reservation targeting option. If you do not specify this parameter, the\n instance's Capacity Reservation preference defaults to open, which enables\n it to run in any open Capacity Reservation that has matching attributes (instance type,\n platform, Availability Zone).

" - } - }, - "LicenseSpecifications": { - "target": "com.amazonaws.ec2#LaunchTemplateLicenseSpecificationListRequest", - "traits": { - "smithy.api#documentation": "

The license configurations.

", - "smithy.api#xmlName": "LicenseSpecification" - } - }, - "HibernationOptions": { - "target": "com.amazonaws.ec2#LaunchTemplateHibernationOptionsRequest", - "traits": { - "smithy.api#documentation": "

Indicates whether an instance is enabled for hibernation. This parameter is valid only\n if the instance meets the hibernation\n prerequisites. For more information, see Hibernate your instance in the\n Amazon Elastic Compute Cloud User Guide.

" - } - }, - "MetadataOptions": { - "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataOptionsRequest", - "traits": { - "smithy.api#documentation": "

The metadata options for the instance. For more information, see Instance metadata and user data in the\n Amazon Elastic Compute Cloud User Guide.

" - } - }, - "EnclaveOptions": { - "target": "com.amazonaws.ec2#LaunchTemplateEnclaveOptionsRequest", - "traits": { - "smithy.api#documentation": "

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more\n information, see What is Amazon Web Services Nitro Enclaves?\n in the Amazon Web Services Nitro Enclaves User Guide.

\n

You can't enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.

" - } - }, - "InstanceRequirements": { - "target": "com.amazonaws.ec2#InstanceRequirementsRequest", - "traits": { - "smithy.api#documentation": "

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with these attributes.

\n

If you specify InstanceRequirements, you can't specify\n InstanceType.

" - } - }, - "PrivateDnsNameOptions": { - "target": "com.amazonaws.ec2#LaunchTemplatePrivateDnsNameOptionsRequest", - "traits": { - "smithy.api#documentation": "

The options for the instance hostname. The default values are inherited from the\n subnet.

" - } - }, - "MaintenanceOptions": { - "target": "com.amazonaws.ec2#LaunchTemplateInstanceMaintenanceOptionsRequest", - "traits": { - "smithy.api#documentation": "

The maintenance options for the instance.

" - } - }, - "DisableApiStop": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to enable the instance for stop protection. For more information,\n see Stop\n protection in the Amazon Elastic Compute Cloud User Guide.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The information to include in the launch template.

\n \n

You must specify at least one parameter for the launch template data.

\n " - } - }, - "com.amazonaws.ec2#RequestSpotFleet": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#RequestSpotFleetRequest" - }, - "output": { - "target": "com.amazonaws.ec2#RequestSpotFleetResponse" - }, - "traits": { - "smithy.api#documentation": "

Creates a Spot Fleet request.

\n

The Spot Fleet request specifies the total target capacity and the On-Demand target\n capacity. Amazon EC2 calculates the difference between the total capacity and On-Demand\n capacity, and launches the difference as Spot capacity.

\n

You can submit a single request that includes multiple launch specifications that vary\n by instance type, AMI, Availability Zone, or subnet.

\n

By default, the Spot Fleet requests Spot Instances in the Spot Instance pool where the\n price per unit is the lowest. Each launch specification can include its own instance\n weighting that reflects the value of the instance type to your application\n workload.

\n

Alternatively, you can specify that the Spot Fleet distribute the target capacity\n across the Spot pools included in its launch specifications. By ensuring that the Spot\n Instances in your Spot Fleet are in different Spot pools, you can improve the\n availability of your fleet.

\n

You can specify tags for the Spot Fleet request and instances launched by the fleet.\n You cannot tag other resource types in a Spot Fleet request because only the\n spot-fleet-request and instance resource types are\n supported.

\n

For more information, see Spot Fleet requests\n in the Amazon EC2 User Guide.

\n \n

We strongly discourage using the RequestSpotFleet API because it is a legacy\n API with no planned investment. For options for requesting Spot Instances, see\n Which\n is the best Spot request method to use? in the\n Amazon EC2 User Guide.

\n " - } - }, - "com.amazonaws.ec2#RequestSpotFleetRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "SpotFleetRequestConfig": { - "target": "com.amazonaws.ec2#SpotFleetRequestConfigData", - "traits": { - "aws.protocols#ec2QueryName": "SpotFleetRequestConfig", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The configuration for the Spot Fleet request.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "spotFleetRequestConfig" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for RequestSpotFleet.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#RequestSpotFleetResponse": { - "type": "structure", - "members": { - "SpotFleetRequestId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SpotFleetRequestId", - "smithy.api#documentation": "

The ID of the Spot Fleet request.

", - "smithy.api#xmlName": "spotFleetRequestId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of RequestSpotFleet.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#RequestSpotInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#RequestSpotInstancesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#RequestSpotInstancesResult" - }, - "traits": { - "smithy.api#documentation": "

Creates a Spot Instance request.

\n

For more information, see Spot Instance requests in\n the Amazon EC2 User Guide for Linux Instances.

\n \n

We strongly discourage using the RequestSpotInstances API because it is a legacy\n API with no planned investment. For options for requesting Spot Instances, see\n Which\n is the best Spot request method to use? in the\n Amazon EC2 User Guide for Linux Instances.

\n " - } - }, - "com.amazonaws.ec2#RequestSpotInstancesRequest": { - "type": "structure", - "members": { - "AvailabilityZoneGroup": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZoneGroup", - "smithy.api#documentation": "

The user-specified name for a logical grouping of requests.

\n

When you specify an Availability Zone group in a Spot Instance request, all Spot\n Instances in the request are launched in the same Availability Zone. Instance proximity\n is maintained with this parameter, but the choice of Availability Zone is not. The group\n applies only to requests for Spot Instances of the same instance type. Any additional\n Spot Instance requests that are specified with the same Availability Zone group name are\n launched in that same Availability Zone, as long as at least one instance from the group\n is still active.

\n

If there is no active instance running in the Availability Zone group that you specify\n for a new Spot Instance request (all instances are terminated, the request is expired,\n or the maximum price you specified falls below current Spot price), then Amazon EC2 launches\n the instance in any Availability Zone where the constraint can be met. Consequently, the\n subsequent set of Spot Instances could be placed in a different zone from the original\n request, even if you specified the same Availability Zone group.

\n

Default: Instances are launched in any available Availability Zone.

", - "smithy.api#xmlName": "availabilityZoneGroup" - } - }, - "BlockDurationMinutes": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "BlockDurationMinutes", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

Deprecated.

", - "smithy.api#xmlName": "blockDurationMinutes" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to Ensure\n Idempotency in the Amazon EC2 User Guide for Linux Instances.

", - "smithy.api#xmlName": "clientToken" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "InstanceCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "InstanceCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of Spot Instances to launch.

\n

Default: 1

", - "smithy.api#xmlName": "instanceCount" - } - }, - "LaunchGroup": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LaunchGroup", - "smithy.api#documentation": "

The instance launch group. Launch groups are Spot Instances that launch together and\n terminate together.

\n

Default: Instances are launched and terminated individually

", - "smithy.api#xmlName": "launchGroup" - } - }, - "LaunchSpecification": { - "target": "com.amazonaws.ec2#RequestSpotLaunchSpecification", - "traits": { - "smithy.api#documentation": "

The launch specification.

" - } - }, - "SpotPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SpotPrice", - "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend \n using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n ", - "smithy.api#xmlName": "spotPrice" - } - }, - "Type": { - "target": "com.amazonaws.ec2#SpotInstanceType", - "traits": { - "aws.protocols#ec2QueryName": "Type", - "smithy.api#documentation": "

The Spot Instance request type.

\n

Default: one-time\n

", - "smithy.api#xmlName": "type" - } - }, - "ValidFrom": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "ValidFrom", - "smithy.api#documentation": "

The start date of the request. If this is a one-time request, the request becomes\n active at this date and time and remains active until all instances launch, the request\n expires, or the request is canceled. If the request is persistent, the request becomes\n active at this date and time and remains active until it expires or is canceled.

\n

The specified start date and time cannot be equal to the current date and time. You\n must specify a start date and time that occurs after the current date and time.

", - "smithy.api#xmlName": "validFrom" - } - }, - "ValidUntil": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "ValidUntil", - "smithy.api#documentation": "

The end date of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ).

\n ", - "smithy.api#xmlName": "validUntil" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The key-value pair for tagging the Spot Instance request on creation. The value for\n ResourceType must be spot-instances-request, otherwise the\n Spot Instance request fails. To tag the Spot Instance request after it has been created,\n see CreateTags.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "InstanceInterruptionBehavior": { - "target": "com.amazonaws.ec2#InstanceInterruptionBehavior", - "traits": { - "smithy.api#documentation": "

The behavior when a Spot Instance is interrupted. The default is terminate.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for RequestSpotInstances.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#RequestSpotInstancesResult": { - "type": "structure", - "members": { - "SpotInstanceRequests": { - "target": "com.amazonaws.ec2#SpotInstanceRequestList", - "traits": { - "aws.protocols#ec2QueryName": "SpotInstanceRequestSet", - "smithy.api#documentation": "

The Spot Instance requests.

", - "smithy.api#xmlName": "spotInstanceRequestSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of RequestSpotInstances.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#RequestSpotLaunchSpecification": { - "type": "structure", - "members": { - "SecurityGroupIds": { - "target": "com.amazonaws.ec2#RequestSpotLaunchSpecificationSecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

The IDs of the security groups.

", - "smithy.api#xmlName": "SecurityGroupId" - } - }, - "SecurityGroups": { - "target": "com.amazonaws.ec2#RequestSpotLaunchSpecificationSecurityGroupList", - "traits": { - "smithy.api#documentation": "

Not supported.

", - "smithy.api#xmlName": "SecurityGroup" - } - }, - "AddressingType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AddressingType", - "smithy.api#documentation": "

Deprecated.

", - "smithy.api#xmlName": "addressingType" - } - }, - "BlockDeviceMappings": { - "target": "com.amazonaws.ec2#BlockDeviceMappingList", - "traits": { - "aws.protocols#ec2QueryName": "BlockDeviceMapping", - "smithy.api#documentation": "

The block device mapping entries. You can't specify both a snapshot ID and an encryption value. \n This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, \n it is not blank and its encryption status is used for the volume encryption status.

", - "smithy.api#xmlName": "blockDeviceMapping" - } - }, - "EbsOptimized": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "EbsOptimized", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#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.

\n

Default: false\n

", - "smithy.api#xmlName": "ebsOptimized" - } - }, - "IamInstanceProfile": { - "target": "com.amazonaws.ec2#IamInstanceProfileSpecification", - "traits": { - "aws.protocols#ec2QueryName": "IamInstanceProfile", - "smithy.api#documentation": "

The IAM instance profile.

", - "smithy.api#xmlName": "iamInstanceProfile" - } - }, - "ImageId": { - "target": "com.amazonaws.ec2#ImageId", - "traits": { - "aws.protocols#ec2QueryName": "ImageId", - "smithy.api#documentation": "

The ID of the AMI.

", - "smithy.api#xmlName": "imageId" - } - }, - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type. Only one instance type can be specified.

", - "smithy.api#xmlName": "instanceType" - } - }, - "KernelId": { - "target": "com.amazonaws.ec2#KernelId", - "traits": { - "aws.protocols#ec2QueryName": "KernelId", - "smithy.api#documentation": "

The ID of the kernel.

", - "smithy.api#xmlName": "kernelId" - } - }, - "KeyName": { - "target": "com.amazonaws.ec2#KeyPairName", - "traits": { - "aws.protocols#ec2QueryName": "KeyName", - "smithy.api#documentation": "

The name of the key pair.

", - "smithy.api#xmlName": "keyName" - } - }, - "Monitoring": { - "target": "com.amazonaws.ec2#RunInstancesMonitoringEnabled", - "traits": { - "aws.protocols#ec2QueryName": "Monitoring", - "smithy.api#documentation": "

Indicates whether basic or detailed monitoring is enabled for the instance.

\n

Default: Disabled

", - "smithy.api#xmlName": "monitoring" - } - }, - "NetworkInterfaces": { - "target": "com.amazonaws.ec2#InstanceNetworkInterfaceSpecificationList", - "traits": { - "smithy.api#documentation": "

The network interfaces. If you specify a network interface, you must specify \n subnet IDs and security group IDs using the network interface.

", - "smithy.api#xmlName": "NetworkInterface" - } - }, - "Placement": { - "target": "com.amazonaws.ec2#SpotPlacement", - "traits": { - "aws.protocols#ec2QueryName": "Placement", - "smithy.api#documentation": "

The placement information for the instance.

", - "smithy.api#xmlName": "placement" - } - }, - "RamdiskId": { - "target": "com.amazonaws.ec2#RamdiskId", - "traits": { - "aws.protocols#ec2QueryName": "RamdiskId", - "smithy.api#documentation": "

The ID of the RAM disk.

", - "smithy.api#xmlName": "ramdiskId" - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#SubnetId", - "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#documentation": "

The ID of the subnet in which to launch the instance.

", - "smithy.api#xmlName": "subnetId" - } - }, - "UserData": { - "target": "com.amazonaws.ec2#SensitiveUserData", - "traits": { - "aws.protocols#ec2QueryName": "UserData", - "smithy.api#documentation": "

The base64-encoded user data that instances use when starting up. User data is limited to 16 KB.

", - "smithy.api#xmlName": "userData" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the launch specification for an instance.

" - } - }, - "com.amazonaws.ec2#RequestSpotLaunchSpecificationSecurityGroupIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SecurityGroupId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#RequestSpotLaunchSpecificationSecurityGroupList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#Reservation": { - "type": "structure", - "members": { - "Groups": { - "target": "com.amazonaws.ec2#GroupIdentifierList", - "traits": { - "aws.protocols#ec2QueryName": "GroupSet", - "smithy.api#documentation": "

Not supported.

", - "smithy.api#xmlName": "groupSet" - } - }, - "Instances": { - "target": "com.amazonaws.ec2#InstanceList", - "traits": { - "aws.protocols#ec2QueryName": "InstancesSet", - "smithy.api#documentation": "

The instances.

", - "smithy.api#xmlName": "instancesSet" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the reservation.

", - "smithy.api#xmlName": "ownerId" - } - }, - "RequesterId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "RequesterId", - "smithy.api#documentation": "

The ID of the requester that launched the instances on your behalf (for example,\n Amazon Web Services Management Console or Auto Scaling).

", - "smithy.api#xmlName": "requesterId" - } - }, - "ReservationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ReservationId", - "smithy.api#documentation": "

The ID of the reservation.

", - "smithy.api#xmlName": "reservationId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a launch request for one or more instances, and includes owner, requester,\n and security group information that applies to all instances in the launch\n request.

" - } - }, - "com.amazonaws.ec2#ReservationFleetInstanceSpecification": { - "type": "structure", - "members": { - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", - "traits": { - "smithy.api#documentation": "

The instance type for which the Capacity Reservation Fleet reserves capacity.

" - } - }, - "InstancePlatform": { - "target": "com.amazonaws.ec2#CapacityReservationInstancePlatform", - "traits": { - "smithy.api#documentation": "

The type of operating system for which the Capacity Reservation Fleet reserves capacity.

" - } - }, - "Weight": { - "target": "com.amazonaws.ec2#DoubleWithConstraints", - "traits": { - "smithy.api#documentation": "

The number of capacity units provided by the specified instance type. This value, together with the \n\t\t\ttotal target capacity that you specify for the Fleet determine the number of instances for which the \n\t\t\tFleet reserves capacity. Both values are based on units that make sense for your workload. For more \n\t\t\tinformation, see Total target capacity \n\t\t\tin the Amazon EC2 User Guide.

" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The Availability Zone in which the Capacity Reservation Fleet reserves the capacity. A Capacity \n\t\t\tReservation Fleet can't span Availability Zones. All instance type specifications that you specify \n\t\t\tfor the Fleet must use the same Availability Zone.

" - } - }, - "AvailabilityZoneId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The ID of the Availability Zone in which the Capacity Reservation Fleet reserves the capacity. A \n\t\t\tCapacity Reservation Fleet can't span Availability Zones. All instance type specifications that you \n\t\t\tspecify for the Fleet must use the same Availability Zone.

" - } - }, - "EbsOptimized": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the Capacity Reservation Fleet supports EBS-optimized instances types. This \n\t\t\toptimization provides dedicated throughput to Amazon EBS and an optimized configuration stack \n\t\t\tto provide optimal I/O performance. This optimization isn't available with all instance types. Additional \n\t\t\tusage charges apply when using EBS-optimized instance types.

" - } - }, - "Priority": { - "target": "com.amazonaws.ec2#IntegerWithConstraints", - "traits": { - "smithy.api#documentation": "

The priority to assign to the instance type. This value is used to determine which of the instance types \n\t\t\tspecified for the Fleet should be prioritized for use. A lower value indicates a high priority. For more \n\t\t\tinformation, see Instance type priority \n\t\t\tin the Amazon EC2 User Guide.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about an instance type to use in a Capacity Reservation Fleet.

" - } - }, - "com.amazonaws.ec2#ReservationFleetInstanceSpecificationList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ReservationFleetInstanceSpecification" - } - }, - "com.amazonaws.ec2#ReservationId": { - "type": "string" - }, - "com.amazonaws.ec2#ReservationList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Reservation", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ReservationState": { - "type": "enum", - "members": { - "PAYMENT_PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "payment-pending" - } - }, - "PAYMENT_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "payment-failed" - } - }, - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "active" - } - }, - "RETIRED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "retired" - } - } - } - }, - "com.amazonaws.ec2#ReservationValue": { - "type": "structure", - "members": { - "HourlyPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "HourlyPrice", - "smithy.api#documentation": "

The hourly rate of the reservation.

", - "smithy.api#xmlName": "hourlyPrice" - } - }, - "RemainingTotalValue": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "RemainingTotalValue", - "smithy.api#documentation": "

The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * number of hours remaining).

", - "smithy.api#xmlName": "remainingTotalValue" - } - }, - "RemainingUpfrontValue": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "RemainingUpfrontValue", - "smithy.api#documentation": "

The remaining upfront cost of the reservation.

", - "smithy.api#xmlName": "remainingUpfrontValue" - } - } - }, - "traits": { - "smithy.api#documentation": "

The cost associated with the Reserved Instance.

" - } - }, - "com.amazonaws.ec2#ReservedInstanceIdSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ReservationId", - "traits": { - "smithy.api#xmlName": "ReservedInstanceId" - } - } - }, - "com.amazonaws.ec2#ReservedInstanceLimitPrice": { - "type": "structure", - "members": { - "Amount": { - "target": "com.amazonaws.ec2#Double", - "traits": { - "aws.protocols#ec2QueryName": "Amount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).

", - "smithy.api#xmlName": "amount" - } - }, - "CurrencyCode": { - "target": "com.amazonaws.ec2#CurrencyCodeValues", - "traits": { - "aws.protocols#ec2QueryName": "CurrencyCode", - "smithy.api#documentation": "

The currency in which the limitPrice amount is specified.\n\t\t\t\tAt this time, the only supported currency is USD.

", - "smithy.api#xmlName": "currencyCode" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the limit price of a Reserved Instance offering.

" - } - }, - "com.amazonaws.ec2#ReservedInstanceReservationValue": { - "type": "structure", - "members": { - "ReservationValue": { - "target": "com.amazonaws.ec2#ReservationValue", - "traits": { - "aws.protocols#ec2QueryName": "ReservationValue", - "smithy.api#documentation": "

The total value of the Convertible Reserved Instance that you are exchanging.

", - "smithy.api#xmlName": "reservationValue" - } - }, - "ReservedInstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ReservedInstanceId", - "smithy.api#documentation": "

The ID of the Convertible Reserved Instance that you are exchanging.

", - "smithy.api#xmlName": "reservedInstanceId" - } - } - }, - "traits": { - "smithy.api#documentation": "

The total value of the Convertible Reserved Instance.

" - } - }, - "com.amazonaws.ec2#ReservedInstanceReservationValueSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ReservedInstanceReservationValue", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ReservedInstanceState": { - "type": "enum", - "members": { - "payment_pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "payment-pending" - } - }, - "active": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "active" - } - }, - "payment_failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "payment-failed" - } - }, - "retired": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "retired" - } - }, - "queued": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "queued" - } - }, - "queued_deleted": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "queued-deleted" - } - } - } - }, - "com.amazonaws.ec2#ReservedInstances": { - "type": "structure", - "members": { - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone in which the Reserved Instance can be used.

", - "smithy.api#xmlName": "availabilityZone" - } - }, - "Duration": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "aws.protocols#ec2QueryName": "Duration", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The duration of the Reserved Instance, in seconds.

", - "smithy.api#xmlName": "duration" - } - }, - "End": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "End", - "smithy.api#documentation": "

The time when the Reserved Instance expires.

", - "smithy.api#xmlName": "end" - } - }, - "FixedPrice": { - "target": "com.amazonaws.ec2#Float", - "traits": { - "aws.protocols#ec2QueryName": "FixedPrice", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The purchase price of the Reserved Instance.

", - "smithy.api#xmlName": "fixedPrice" - } - }, - "InstanceCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "InstanceCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of reservations purchased.

", - "smithy.api#xmlName": "instanceCount" - } - }, - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type on which the Reserved Instance can be used.

", - "smithy.api#xmlName": "instanceType" - } - }, - "ProductDescription": { - "target": "com.amazonaws.ec2#RIProductDescription", - "traits": { - "aws.protocols#ec2QueryName": "ProductDescription", - "smithy.api#documentation": "

The Reserved Instance product platform description.

", - "smithy.api#xmlName": "productDescription" - } - }, - "ReservedInstancesId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ReservedInstancesId", - "smithy.api#documentation": "

The ID of the Reserved Instance.

", - "smithy.api#xmlName": "reservedInstancesId" - } - }, - "Start": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "Start", - "smithy.api#documentation": "

The date and time the Reserved Instance started.

", - "smithy.api#xmlName": "start" - } - }, - "State": { - "target": "com.amazonaws.ec2#ReservedInstanceState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the Reserved Instance purchase.

", - "smithy.api#xmlName": "state" - } - }, - "UsagePrice": { - "target": "com.amazonaws.ec2#Float", - "traits": { - "aws.protocols#ec2QueryName": "UsagePrice", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The usage price of the Reserved Instance, per hour.

", - "smithy.api#xmlName": "usagePrice" - } - }, - "CurrencyCode": { - "target": "com.amazonaws.ec2#CurrencyCodeValues", - "traits": { - "aws.protocols#ec2QueryName": "CurrencyCode", - "smithy.api#documentation": "

The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes.\n\t\t\t\tAt this time, the only supported currency is USD.

", - "smithy.api#xmlName": "currencyCode" - } - }, - "InstanceTenancy": { - "target": "com.amazonaws.ec2#Tenancy", - "traits": { - "aws.protocols#ec2QueryName": "InstanceTenancy", - "smithy.api#documentation": "

The tenancy of the instance.

", - "smithy.api#xmlName": "instanceTenancy" - } - }, - "OfferingClass": { - "target": "com.amazonaws.ec2#OfferingClassType", - "traits": { - "aws.protocols#ec2QueryName": "OfferingClass", - "smithy.api#documentation": "

The offering class of the Reserved Instance.

", - "smithy.api#xmlName": "offeringClass" - } - }, - "OfferingType": { - "target": "com.amazonaws.ec2#OfferingTypeValues", - "traits": { - "aws.protocols#ec2QueryName": "OfferingType", - "smithy.api#documentation": "

The Reserved Instance offering type.

", - "smithy.api#xmlName": "offeringType" - } - }, - "RecurringCharges": { - "target": "com.amazonaws.ec2#RecurringChargesList", - "traits": { - "aws.protocols#ec2QueryName": "RecurringCharges", - "smithy.api#documentation": "

The recurring charge tag assigned to the resource.

", - "smithy.api#xmlName": "recurringCharges" - } - }, - "Scope": { - "target": "com.amazonaws.ec2#scope", - "traits": { - "aws.protocols#ec2QueryName": "Scope", - "smithy.api#documentation": "

The scope of the Reserved Instance.

", - "smithy.api#xmlName": "scope" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the resource.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a Reserved Instance.

" - } - }, - "com.amazonaws.ec2#ReservedInstancesConfiguration": { - "type": "structure", - "members": { - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone for the modified Reserved Instances.

", - "smithy.api#xmlName": "availabilityZone" - } - }, - "InstanceCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "InstanceCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of modified Reserved Instances.

\n \n

This is a required field for a request.

\n ", - "smithy.api#xmlName": "instanceCount" - } - }, - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type for the modified Reserved Instances.

", - "smithy.api#xmlName": "instanceType" - } - }, - "Platform": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Platform", - "smithy.api#documentation": "

The network platform of the modified Reserved Instances.

", - "smithy.api#xmlName": "platform" - } - }, - "Scope": { - "target": "com.amazonaws.ec2#scope", - "traits": { - "aws.protocols#ec2QueryName": "Scope", - "smithy.api#documentation": "

Whether the Reserved Instance is applied to instances in a Region or instances in a specific Availability Zone.

", - "smithy.api#xmlName": "scope" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the configuration settings for the modified Reserved Instances.

" - } - }, - "com.amazonaws.ec2#ReservedInstancesConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ReservedInstancesConfiguration", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ReservedInstancesId": { - "type": "structure", - "members": { - "ReservedInstancesId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ReservedInstancesId", - "smithy.api#documentation": "

The ID of the Reserved Instance.

", - "smithy.api#xmlName": "reservedInstancesId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the ID of a Reserved Instance.

" - } - }, - "com.amazonaws.ec2#ReservedInstancesIdStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ReservationId", - "traits": { - "smithy.api#xmlName": "ReservedInstancesId" - } - } - }, - "com.amazonaws.ec2#ReservedInstancesList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ReservedInstances", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ReservedInstancesListing": { - "type": "structure", - "members": { - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

A unique, case-sensitive key supplied by the client to ensure that the request is\n\t\t\tidempotent. For more information, see Ensuring Idempotency.

", - "smithy.api#xmlName": "clientToken" - } - }, - "CreateDate": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "CreateDate", - "smithy.api#documentation": "

The time the listing was created.

", - "smithy.api#xmlName": "createDate" - } - }, - "InstanceCounts": { - "target": "com.amazonaws.ec2#InstanceCountList", - "traits": { - "aws.protocols#ec2QueryName": "InstanceCounts", - "smithy.api#documentation": "

The number of instances in this state.

", - "smithy.api#xmlName": "instanceCounts" - } - }, - "PriceSchedules": { - "target": "com.amazonaws.ec2#PriceScheduleList", - "traits": { - "aws.protocols#ec2QueryName": "PriceSchedules", - "smithy.api#documentation": "

The price of the Reserved Instance listing.

", - "smithy.api#xmlName": "priceSchedules" - } - }, - "ReservedInstancesId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ReservedInstancesId", - "smithy.api#documentation": "

The ID of the Reserved Instance.

", - "smithy.api#xmlName": "reservedInstancesId" - } - }, - "ReservedInstancesListingId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ReservedInstancesListingId", - "smithy.api#documentation": "

The ID of the Reserved Instance listing.

", - "smithy.api#xmlName": "reservedInstancesListingId" - } - }, - "Status": { - "target": "com.amazonaws.ec2#ListingStatus", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The status of the Reserved Instance listing.

", - "smithy.api#xmlName": "status" - } - }, - "StatusMessage": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StatusMessage", - "smithy.api#documentation": "

The reason for the current status of the Reserved Instance listing. The response can be blank.

", - "smithy.api#xmlName": "statusMessage" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the resource.

", - "smithy.api#xmlName": "tagSet" - } - }, - "UpdateDate": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "UpdateDate", - "smithy.api#documentation": "

The last modified timestamp of the listing.

", - "smithy.api#xmlName": "updateDate" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a Reserved Instance listing.

" - } - }, - "com.amazonaws.ec2#ReservedInstancesListingId": { - "type": "string" - }, - "com.amazonaws.ec2#ReservedInstancesListingList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ReservedInstancesListing", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ReservedInstancesModification": { - "type": "structure", - "members": { - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

A unique, case-sensitive key supplied by the client to ensure that the request is idempotent.\n\t\t\tFor more information, see Ensuring\n\t\t\t\tIdempotency.

", - "smithy.api#xmlName": "clientToken" - } - }, - "CreateDate": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "CreateDate", - "smithy.api#documentation": "

The time when the modification request was created.

", - "smithy.api#xmlName": "createDate" - } - }, - "EffectiveDate": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "EffectiveDate", - "smithy.api#documentation": "

The time for the modification to become effective.

", - "smithy.api#xmlName": "effectiveDate" - } - }, - "ModificationResults": { - "target": "com.amazonaws.ec2#ReservedInstancesModificationResultList", - "traits": { - "aws.protocols#ec2QueryName": "ModificationResultSet", - "smithy.api#documentation": "

Contains target configurations along with their corresponding new Reserved Instance IDs.

", - "smithy.api#xmlName": "modificationResultSet" - } - }, - "ReservedInstancesIds": { - "target": "com.amazonaws.ec2#ReservedIntancesIds", - "traits": { - "aws.protocols#ec2QueryName": "ReservedInstancesSet", - "smithy.api#documentation": "

The IDs of one or more Reserved Instances.

", - "smithy.api#xmlName": "reservedInstancesSet" - } - }, - "ReservedInstancesModificationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ReservedInstancesModificationId", - "smithy.api#documentation": "

A unique ID for the Reserved Instance modification.

", - "smithy.api#xmlName": "reservedInstancesModificationId" - } - }, - "Status": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The status of the Reserved Instances modification request.

", - "smithy.api#xmlName": "status" - } - }, - "StatusMessage": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StatusMessage", - "smithy.api#documentation": "

The reason for the status.

", - "smithy.api#xmlName": "statusMessage" - } - }, - "UpdateDate": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "UpdateDate", - "smithy.api#documentation": "

The time when the modification request was last updated.

", - "smithy.api#xmlName": "updateDate" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a Reserved Instance modification.

" - } - }, - "com.amazonaws.ec2#ReservedInstancesModificationId": { - "type": "string" - }, - "com.amazonaws.ec2#ReservedInstancesModificationIdStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ReservedInstancesModificationId", - "traits": { - "smithy.api#xmlName": "ReservedInstancesModificationId" - } - } - }, - "com.amazonaws.ec2#ReservedInstancesModificationList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ReservedInstancesModification", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ReservedInstancesModificationResult": { - "type": "structure", - "members": { - "ReservedInstancesId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ReservedInstancesId", - "smithy.api#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.

", - "smithy.api#xmlName": "reservedInstancesId" - } - }, - "TargetConfiguration": { - "target": "com.amazonaws.ec2#ReservedInstancesConfiguration", - "traits": { - "aws.protocols#ec2QueryName": "TargetConfiguration", - "smithy.api#documentation": "

The target Reserved Instances configurations supplied as part of the modification request.

", - "smithy.api#xmlName": "targetConfiguration" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the modification request/s.

" - } - }, - "com.amazonaws.ec2#ReservedInstancesModificationResultList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ReservedInstancesModificationResult", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ReservedInstancesOffering": { - "type": "structure", - "members": { - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone in which the Reserved Instance can be used.

", - "smithy.api#xmlName": "availabilityZone" - } - }, - "Duration": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "aws.protocols#ec2QueryName": "Duration", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The duration of the Reserved Instance, in seconds.

", - "smithy.api#xmlName": "duration" - } - }, - "FixedPrice": { - "target": "com.amazonaws.ec2#Float", - "traits": { - "aws.protocols#ec2QueryName": "FixedPrice", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The purchase price of the Reserved Instance.

", - "smithy.api#xmlName": "fixedPrice" - } - }, - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type on which the Reserved Instance can be used.

", - "smithy.api#xmlName": "instanceType" - } - }, - "ProductDescription": { - "target": "com.amazonaws.ec2#RIProductDescription", - "traits": { - "aws.protocols#ec2QueryName": "ProductDescription", - "smithy.api#documentation": "

The Reserved Instance product platform description.

", - "smithy.api#xmlName": "productDescription" - } - }, - "ReservedInstancesOfferingId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ReservedInstancesOfferingId", - "smithy.api#documentation": "

The ID of the Reserved Instance offering. This is the offering ID used in GetReservedInstancesExchangeQuote \n to confirm that an exchange can be made.

", - "smithy.api#xmlName": "reservedInstancesOfferingId" - } - }, - "UsagePrice": { - "target": "com.amazonaws.ec2#Float", - "traits": { - "aws.protocols#ec2QueryName": "UsagePrice", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The usage price of the Reserved Instance, per hour.

", - "smithy.api#xmlName": "usagePrice" - } - }, - "CurrencyCode": { - "target": "com.amazonaws.ec2#CurrencyCodeValues", - "traits": { - "aws.protocols#ec2QueryName": "CurrencyCode", - "smithy.api#documentation": "

The currency of the Reserved Instance offering you are purchasing. It's \n\t\t\t\tspecified using ISO 4217 standard currency codes. At this time, \n\t\t\t\tthe only supported currency is USD.

", - "smithy.api#xmlName": "currencyCode" - } - }, - "InstanceTenancy": { - "target": "com.amazonaws.ec2#Tenancy", - "traits": { - "aws.protocols#ec2QueryName": "InstanceTenancy", - "smithy.api#documentation": "

The tenancy of the instance.

", - "smithy.api#xmlName": "instanceTenancy" - } - }, - "Marketplace": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Marketplace", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or Amazon Web Services. \n If it's a Reserved Instance Marketplace offering, this is true.

", - "smithy.api#xmlName": "marketplace" - } - }, - "OfferingClass": { - "target": "com.amazonaws.ec2#OfferingClassType", - "traits": { - "aws.protocols#ec2QueryName": "OfferingClass", - "smithy.api#documentation": "

If convertible it can be exchanged for Reserved Instances of\n the same or higher monetary value, with different configurations. If standard, it is not \n possible to perform an exchange.

", - "smithy.api#xmlName": "offeringClass" - } - }, - "OfferingType": { - "target": "com.amazonaws.ec2#OfferingTypeValues", - "traits": { - "aws.protocols#ec2QueryName": "OfferingType", - "smithy.api#documentation": "

The Reserved Instance offering type.

", - "smithy.api#xmlName": "offeringType" - } - }, - "PricingDetails": { - "target": "com.amazonaws.ec2#PricingDetailsList", - "traits": { - "aws.protocols#ec2QueryName": "PricingDetailsSet", - "smithy.api#documentation": "

The pricing details of the Reserved Instance offering.

", - "smithy.api#xmlName": "pricingDetailsSet" - } - }, - "RecurringCharges": { - "target": "com.amazonaws.ec2#RecurringChargesList", - "traits": { - "aws.protocols#ec2QueryName": "RecurringCharges", - "smithy.api#documentation": "

The recurring charge tag assigned to the resource.

", - "smithy.api#xmlName": "recurringCharges" - } - }, - "Scope": { - "target": "com.amazonaws.ec2#scope", - "traits": { - "aws.protocols#ec2QueryName": "Scope", - "smithy.api#documentation": "

Whether the Reserved Instance is applied to instances in a Region or an Availability Zone.

", - "smithy.api#xmlName": "scope" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a Reserved Instance offering.

" - } - }, - "com.amazonaws.ec2#ReservedInstancesOfferingId": { - "type": "string" - }, - "com.amazonaws.ec2#ReservedInstancesOfferingIdStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ReservedInstancesOfferingId" - } - }, - "com.amazonaws.ec2#ReservedInstancesOfferingList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ReservedInstancesOffering", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ReservedIntancesIds": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ReservedInstancesId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ResetAddressAttribute": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ResetAddressAttributeRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ResetAddressAttributeResult" - }, - "traits": { - "smithy.api#documentation": "

Resets the attribute of the specified IP address. For requirements, see Using reverse DNS for email applications.

" - } - }, - "com.amazonaws.ec2#ResetAddressAttributeRequest": { - "type": "structure", - "members": { - "AllocationId": { - "target": "com.amazonaws.ec2#AllocationId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

[EC2-VPC] The allocation ID.

", - "smithy.api#required": {} - } - }, - "Attribute": { - "target": "com.amazonaws.ec2#AddressAttributeName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The attribute of the IP address.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ResetAddressAttributeResult": { - "type": "structure", - "members": { - "Address": { - "target": "com.amazonaws.ec2#AddressAttribute", - "traits": { - "aws.protocols#ec2QueryName": "Address", - "smithy.api#documentation": "

Information about the IP address.

", - "smithy.api#xmlName": "address" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ResetEbsDefaultKmsKeyId": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ResetEbsDefaultKmsKeyIdRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ResetEbsDefaultKmsKeyIdResult" - }, - "traits": { - "smithy.api#documentation": "

Resets the default KMS key for EBS encryption for your account in this Region \n to the Amazon Web Services managed KMS key for EBS.

\n

After resetting the default KMS key to the Amazon Web Services managed KMS key, you can continue to encrypt by a \n customer managed KMS key by specifying it when you create the volume. For more information, see\n Amazon EBS encryption\n in the Amazon Elastic Compute Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#ResetEbsDefaultKmsKeyIdRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ResetEbsDefaultKmsKeyIdResult": { - "type": "structure", - "members": { - "KmsKeyId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "KmsKeyId", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the default KMS key for EBS encryption by default.

", - "smithy.api#xmlName": "kmsKeyId" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ResetFpgaImageAttribute": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ResetFpgaImageAttributeRequest" - }, - "output": { - "target": "com.amazonaws.ec2#ResetFpgaImageAttributeResult" - }, - "traits": { - "smithy.api#documentation": "

Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default value.\n\t\t You can only reset the load permission attribute.

" - } - }, - "com.amazonaws.ec2#ResetFpgaImageAttributeName": { - "type": "enum", - "members": { - "loadPermission": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "loadPermission" - } - } - } - }, - "com.amazonaws.ec2#ResetFpgaImageAttributeRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "FpgaImageId": { - "target": "com.amazonaws.ec2#FpgaImageId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the AFI.

", - "smithy.api#required": {} - } - }, - "Attribute": { - "target": "com.amazonaws.ec2#ResetFpgaImageAttributeName", - "traits": { - "smithy.api#documentation": "

The attribute.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ResetFpgaImageAttributeResult": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Is true if the request succeeds, and an error otherwise.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ResetImageAttribute": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ResetImageAttributeRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Resets an attribute of an AMI to its default value.

" - } - }, - "com.amazonaws.ec2#ResetImageAttributeName": { - "type": "enum", - "members": { - "launchPermission": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "launchPermission" - } - } - } - }, - "com.amazonaws.ec2#ResetImageAttributeRequest": { - "type": "structure", - "members": { - "Attribute": { - "target": "com.amazonaws.ec2#ResetImageAttributeName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The attribute to reset (currently you can only reset the launch permission attribute).

", - "smithy.api#required": {} - } - }, - "ImageId": { - "target": "com.amazonaws.ec2#ImageId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the AMI.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for ResetImageAttribute.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ResetInstanceAttribute": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ResetInstanceAttributeRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Resets an attribute of an instance to its default value. To reset the\n kernel or ramdisk, the instance must be in a stopped\n state. To reset the sourceDestCheck, the instance can be either running or\n stopped.

\n

The sourceDestCheck attribute controls whether source/destination\n checking is enabled. The default value is true, which means checking is\n enabled. This value must be false for a NAT instance to perform NAT. For\n more information, see NAT Instances in the\n Amazon VPC User Guide.

" - } - }, - "com.amazonaws.ec2#ResetInstanceAttributeRequest": { - "type": "structure", - "members": { - "Attribute": { - "target": "com.amazonaws.ec2#InstanceAttributeName", - "traits": { - "aws.protocols#ec2QueryName": "Attribute", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The attribute to reset.

\n \n

You can only reset the following attributes: kernel |\n ramdisk | sourceDestCheck.

\n ", - "smithy.api#required": {}, - "smithy.api#xmlName": "attribute" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "instanceId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ResetNetworkInterfaceAttribute": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ResetNetworkInterfaceAttributeRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Resets a network interface attribute. You can specify only one attribute at a time.

" - } - }, - "com.amazonaws.ec2#ResetNetworkInterfaceAttributeRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#NetworkInterfaceId", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the network interface.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "networkInterfaceId" - } - }, - "SourceDestCheck": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SourceDestCheck", - "smithy.api#documentation": "

The source/destination checking attribute. Resets the value to true.

", - "smithy.api#xmlName": "sourceDestCheck" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for ResetNetworkInterfaceAttribute.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ResetSnapshotAttribute": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#ResetSnapshotAttributeRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Resets permission settings for the specified snapshot.

\n

For more information about modifying snapshot permissions, see Share a snapshot in the\n Amazon Elastic Compute Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#ResetSnapshotAttributeRequest": { - "type": "structure", - "members": { - "Attribute": { - "target": "com.amazonaws.ec2#SnapshotAttributeName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The attribute to reset. Currently, only the attribute for permission to create volumes can\n be reset.

", - "smithy.api#required": {} - } - }, - "SnapshotId": { - "target": "com.amazonaws.ec2#SnapshotId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the snapshot.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#ResourceArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1283 - } - } - }, - "com.amazonaws.ec2#ResourceIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TaggableResourceId" - } - }, - "com.amazonaws.ec2#ResourceList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ResourceStatement": { - "type": "structure", - "members": { - "Resources": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "ResourceSet", - "smithy.api#documentation": "

The resources.

", - "smithy.api#xmlName": "resourceSet" - } - }, - "ResourceTypes": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "ResourceTypeSet", - "smithy.api#documentation": "

The resource types.

", - "smithy.api#xmlName": "resourceTypeSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a resource statement.

" - } - }, - "com.amazonaws.ec2#ResourceStatementRequest": { - "type": "structure", - "members": { - "Resources": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#documentation": "

The resources.

", - "smithy.api#xmlName": "Resource" - } - }, - "ResourceTypes": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#documentation": "

The resource types.

", - "smithy.api#xmlName": "ResourceType" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a resource statement.

" - } - }, - "com.amazonaws.ec2#ResourceType": { - "type": "enum", - "members": { - "capacity_reservation": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "capacity-reservation" - } - }, - "client_vpn_endpoint": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "client-vpn-endpoint" - } - }, - "customer_gateway": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "customer-gateway" - } - }, - "carrier_gateway": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "carrier-gateway" - } - }, - "coip_pool": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "coip-pool" - } - }, - "dedicated_host": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "dedicated-host" - } - }, - "dhcp_options": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "dhcp-options" - } - }, - "egress_only_internet_gateway": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "egress-only-internet-gateway" - } - }, - "elastic_ip": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "elastic-ip" - } - }, - "elastic_gpu": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "elastic-gpu" - } - }, - "export_image_task": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "export-image-task" - } - }, - "export_instance_task": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "export-instance-task" - } - }, - "fleet": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "fleet" - } - }, - "fpga_image": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "fpga-image" - } - }, - "host_reservation": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "host-reservation" - } - }, - "image": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "image" - } - }, - "import_image_task": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "import-image-task" - } - }, - "import_snapshot_task": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "import-snapshot-task" - } - }, - "instance": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "instance" - } - }, - "instance_event_window": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "instance-event-window" - } - }, - "internet_gateway": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "internet-gateway" - } - }, - "ipam": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ipam" - } - }, - "ipam_pool": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ipam-pool" - } - }, - "ipam_scope": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ipam-scope" - } - }, - "ipv4pool_ec2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ipv4pool-ec2" - } - }, - "ipv6pool_ec2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ipv6pool-ec2" - } - }, - "key_pair": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "key-pair" - } - }, - "launch_template": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "launch-template" - } - }, - "local_gateway": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "local-gateway" - } - }, - "local_gateway_route_table": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "local-gateway-route-table" - } - }, - "local_gateway_virtual_interface": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "local-gateway-virtual-interface" - } - }, - "local_gateway_virtual_interface_group": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "local-gateway-virtual-interface-group" - } - }, - "local_gateway_route_table_vpc_association": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "local-gateway-route-table-vpc-association" - } - }, - "local_gateway_route_table_virtual_interface_group_association": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "local-gateway-route-table-virtual-interface-group-association" - } - }, - "natgateway": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "natgateway" - } - }, - "network_acl": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "network-acl" - } - }, - "network_interface": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "network-interface" - } - }, - "network_insights_analysis": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "network-insights-analysis" - } - }, - "network_insights_path": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "network-insights-path" - } - }, - "network_insights_access_scope": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "network-insights-access-scope" - } - }, - "network_insights_access_scope_analysis": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "network-insights-access-scope-analysis" - } - }, - "placement_group": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "placement-group" - } - }, - "prefix_list": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "prefix-list" - } - }, - "replace_root_volume_task": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "replace-root-volume-task" - } - }, - "reserved_instances": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "reserved-instances" - } - }, - "route_table": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "route-table" - } - }, - "security_group": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "security-group" - } - }, - "security_group_rule": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "security-group-rule" - } - }, - "snapshot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "snapshot" - } - }, - "spot_fleet_request": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "spot-fleet-request" - } - }, - "spot_instances_request": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "spot-instances-request" - } - }, - "subnet": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "subnet" - } - }, - "subnet_cidr_reservation": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "subnet-cidr-reservation" - } - }, - "traffic_mirror_filter": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "traffic-mirror-filter" - } - }, - "traffic_mirror_session": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "traffic-mirror-session" - } - }, - "traffic_mirror_target": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "traffic-mirror-target" - } - }, - "transit_gateway": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "transit-gateway" - } - }, - "transit_gateway_attachment": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "transit-gateway-attachment" - } - }, - "transit_gateway_connect_peer": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "transit-gateway-connect-peer" - } - }, - "transit_gateway_multicast_domain": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "transit-gateway-multicast-domain" - } - }, - "transit_gateway_policy_table": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "transit-gateway-policy-table" - } - }, - "transit_gateway_route_table": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "transit-gateway-route-table" - } - }, - "transit_gateway_route_table_announcement": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "transit-gateway-route-table-announcement" - } - }, - "volume": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "volume" - } - }, - "vpc": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "vpc" - } - }, - "vpc_endpoint": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "vpc-endpoint" - } - }, - "vpc_endpoint_connection": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "vpc-endpoint-connection" - } - }, - "vpc_endpoint_service": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "vpc-endpoint-service" - } - }, - "vpc_endpoint_service_permission": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "vpc-endpoint-service-permission" - } - }, - "vpc_peering_connection": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "vpc-peering-connection" - } - }, - "vpn_connection": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "vpn-connection" - } - }, - "vpn_gateway": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "vpn-gateway" - } - }, - "vpc_flow_log": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "vpc-flow-log" - } - }, - "capacity_reservation_fleet": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "capacity-reservation-fleet" - } - }, - "traffic_mirror_filter_rule": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "traffic-mirror-filter-rule" - } - }, - "vpc_endpoint_connection_device_type": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "vpc-endpoint-connection-device-type" - } - }, - "verified_access_instance": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "verified-access-instance" - } - }, - "verified_access_group": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "verified-access-group" - } - }, - "verified_access_endpoint": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "verified-access-endpoint" - } - }, - "verified_access_policy": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "verified-access-policy" - } - }, - "verified_access_trust_provider": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "verified-access-trust-provider" - } - }, - "vpn_connection_device_type": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "vpn-connection-device-type" - } - }, - "vpc_block_public_access_exclusion": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "vpc-block-public-access-exclusion" - } - }, - "ipam_resource_discovery": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ipam-resource-discovery" - } - }, - "ipam_resource_discovery_association": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ipam-resource-discovery-association" - } - } - } - }, - "com.amazonaws.ec2#ResponseError": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.ec2#LaunchTemplateErrorCode", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The error code.

", - "smithy.api#xmlName": "code" - } - }, - "Message": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "

The error message, if applicable.

", - "smithy.api#xmlName": "message" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the error that's returned when you cannot delete a launch template\n version.

" - } - }, - "com.amazonaws.ec2#ResponseHostIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ResponseHostIdSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ResponseLaunchTemplateData": { - "type": "structure", - "members": { - "KernelId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "KernelId", - "smithy.api#documentation": "

The ID of the kernel, if applicable.

", - "smithy.api#xmlName": "kernelId" - } - }, - "EbsOptimized": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "EbsOptimized", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the instance is optimized for Amazon EBS I/O.

", - "smithy.api#xmlName": "ebsOptimized" - } - }, - "IamInstanceProfile": { - "target": "com.amazonaws.ec2#LaunchTemplateIamInstanceProfileSpecification", - "traits": { - "aws.protocols#ec2QueryName": "IamInstanceProfile", - "smithy.api#documentation": "

The IAM instance profile.

", - "smithy.api#xmlName": "iamInstanceProfile" - } - }, - "BlockDeviceMappings": { - "target": "com.amazonaws.ec2#LaunchTemplateBlockDeviceMappingList", - "traits": { - "aws.protocols#ec2QueryName": "BlockDeviceMappingSet", - "smithy.api#documentation": "

The block device mappings.

", - "smithy.api#xmlName": "blockDeviceMappingSet" - } - }, - "NetworkInterfaces": { - "target": "com.amazonaws.ec2#LaunchTemplateInstanceNetworkInterfaceSpecificationList", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceSet", - "smithy.api#documentation": "

The network interfaces.

", - "smithy.api#xmlName": "networkInterfaceSet" - } - }, - "ImageId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ImageId", - "smithy.api#documentation": "

The ID of the AMI or a Systems Manager parameter. The Systems Manager parameter will\n resolve to the ID of the AMI at instance launch.

\n

The value depends on what you specified in the request. The possible values are:

\n \n

For more information, see Use a Systems \n Manager parameter instead of an AMI ID in the Amazon Elastic Compute Cloud User Guide.

", - "smithy.api#xmlName": "imageId" - } - }, - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type.

", - "smithy.api#xmlName": "instanceType" - } - }, - "KeyName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "KeyName", - "smithy.api#documentation": "

The name of the key pair.

", - "smithy.api#xmlName": "keyName" - } - }, - "Monitoring": { - "target": "com.amazonaws.ec2#LaunchTemplatesMonitoring", - "traits": { - "aws.protocols#ec2QueryName": "Monitoring", - "smithy.api#documentation": "

The monitoring for the instance.

", - "smithy.api#xmlName": "monitoring" - } - }, - "Placement": { - "target": "com.amazonaws.ec2#LaunchTemplatePlacement", - "traits": { - "aws.protocols#ec2QueryName": "Placement", - "smithy.api#documentation": "

The placement of the instance.

", - "smithy.api#xmlName": "placement" - } - }, - "RamDiskId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "RamDiskId", - "smithy.api#documentation": "

The ID of the RAM disk, if applicable.

", - "smithy.api#xmlName": "ramDiskId" - } - }, - "DisableApiTermination": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DisableApiTermination", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

If set to true, indicates that the instance cannot be terminated using\n the Amazon EC2 console, command line tool, or API.

", - "smithy.api#xmlName": "disableApiTermination" - } - }, - "InstanceInitiatedShutdownBehavior": { - "target": "com.amazonaws.ec2#ShutdownBehavior", - "traits": { - "aws.protocols#ec2QueryName": "InstanceInitiatedShutdownBehavior", - "smithy.api#documentation": "

Indicates whether an instance stops or terminates when you initiate shutdown from the\n instance (using the operating system command for system shutdown).

", - "smithy.api#xmlName": "instanceInitiatedShutdownBehavior" - } - }, - "UserData": { - "target": "com.amazonaws.ec2#SensitiveUserData", - "traits": { - "aws.protocols#ec2QueryName": "UserData", - "smithy.api#documentation": "

The user data for the instance.

", - "smithy.api#xmlName": "userData" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#LaunchTemplateTagSpecificationList", - "traits": { - "aws.protocols#ec2QueryName": "TagSpecificationSet", - "smithy.api#documentation": "

The tags that are applied to the resources that are created during instance\n launch.

", - "smithy.api#xmlName": "tagSpecificationSet" - } - }, - "ElasticGpuSpecifications": { - "target": "com.amazonaws.ec2#ElasticGpuSpecificationResponseList", - "traits": { - "aws.protocols#ec2QueryName": "ElasticGpuSpecificationSet", - "smithy.api#documentation": "

The elastic GPU specification.

", - "smithy.api#xmlName": "elasticGpuSpecificationSet" - } - }, - "ElasticInferenceAccelerators": { - "target": "com.amazonaws.ec2#LaunchTemplateElasticInferenceAcceleratorResponseList", - "traits": { - "aws.protocols#ec2QueryName": "ElasticInferenceAcceleratorSet", - "smithy.api#documentation": "

The elastic inference accelerator for the instance.

", - "smithy.api#xmlName": "elasticInferenceAcceleratorSet" - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "SecurityGroupIdSet", - "smithy.api#documentation": "

The security group IDs.

", - "smithy.api#xmlName": "securityGroupIdSet" - } - }, - "SecurityGroups": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "SecurityGroupSet", - "smithy.api#documentation": "

The security group names.

", - "smithy.api#xmlName": "securityGroupSet" - } - }, - "InstanceMarketOptions": { - "target": "com.amazonaws.ec2#LaunchTemplateInstanceMarketOptions", - "traits": { - "aws.protocols#ec2QueryName": "InstanceMarketOptions", - "smithy.api#documentation": "

The market (purchasing) option for the instances.

", - "smithy.api#xmlName": "instanceMarketOptions" - } - }, - "CreditSpecification": { - "target": "com.amazonaws.ec2#CreditSpecification", - "traits": { - "aws.protocols#ec2QueryName": "CreditSpecification", - "smithy.api#documentation": "

The credit option for CPU usage of the instance.

", - "smithy.api#xmlName": "creditSpecification" - } - }, - "CpuOptions": { - "target": "com.amazonaws.ec2#LaunchTemplateCpuOptions", - "traits": { - "aws.protocols#ec2QueryName": "CpuOptions", - "smithy.api#documentation": "

The CPU options for the instance. For more information, see Optimizing CPU options in the Amazon Elastic Compute Cloud User\n Guide.

", - "smithy.api#xmlName": "cpuOptions" - } - }, - "CapacityReservationSpecification": { - "target": "com.amazonaws.ec2#LaunchTemplateCapacityReservationSpecificationResponse", - "traits": { - "aws.protocols#ec2QueryName": "CapacityReservationSpecification", - "smithy.api#documentation": "

Information about the Capacity Reservation targeting option.

", - "smithy.api#xmlName": "capacityReservationSpecification" - } - }, - "LicenseSpecifications": { - "target": "com.amazonaws.ec2#LaunchTemplateLicenseList", - "traits": { - "aws.protocols#ec2QueryName": "LicenseSet", - "smithy.api#documentation": "

The license configurations.

", - "smithy.api#xmlName": "licenseSet" - } - }, - "HibernationOptions": { - "target": "com.amazonaws.ec2#LaunchTemplateHibernationOptions", - "traits": { - "aws.protocols#ec2QueryName": "HibernationOptions", - "smithy.api#documentation": "

Indicates whether an instance is configured for hibernation. For more information, see\n Hibernate\n your instance in the Amazon Elastic Compute Cloud User Guide.

", - "smithy.api#xmlName": "hibernationOptions" - } - }, - "MetadataOptions": { - "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataOptions", - "traits": { - "aws.protocols#ec2QueryName": "MetadataOptions", - "smithy.api#documentation": "

The metadata options for the instance. For more information, see Instance metadata and user data in the\n Amazon Elastic Compute Cloud User Guide.

", - "smithy.api#xmlName": "metadataOptions" - } - }, - "EnclaveOptions": { - "target": "com.amazonaws.ec2#LaunchTemplateEnclaveOptions", - "traits": { - "aws.protocols#ec2QueryName": "EnclaveOptions", - "smithy.api#documentation": "

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.

", - "smithy.api#xmlName": "enclaveOptions" - } - }, - "InstanceRequirements": { - "target": "com.amazonaws.ec2#InstanceRequirements", - "traits": { - "aws.protocols#ec2QueryName": "InstanceRequirements", - "smithy.api#documentation": "

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with these attributes.

\n

If you specify InstanceRequirements, you can't specify\n InstanceTypes.

", - "smithy.api#xmlName": "instanceRequirements" - } - }, - "PrivateDnsNameOptions": { - "target": "com.amazonaws.ec2#LaunchTemplatePrivateDnsNameOptions", - "traits": { - "aws.protocols#ec2QueryName": "PrivateDnsNameOptions", - "smithy.api#documentation": "

The options for the instance hostname.

", - "smithy.api#xmlName": "privateDnsNameOptions" - } - }, - "MaintenanceOptions": { - "target": "com.amazonaws.ec2#LaunchTemplateInstanceMaintenanceOptions", - "traits": { - "aws.protocols#ec2QueryName": "MaintenanceOptions", - "smithy.api#documentation": "

The maintenance options for your instance.

", - "smithy.api#xmlName": "maintenanceOptions" - } - }, - "DisableApiStop": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DisableApiStop", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the instance is enabled for stop protection. For more information,\n see Stop\n protection in the Amazon Elastic Compute Cloud User Guide.

", - "smithy.api#xmlName": "disableApiStop" - } - } - }, - "traits": { - "smithy.api#documentation": "

The information for a launch template.

" - } - }, - "com.amazonaws.ec2#RestorableByStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#String" - } - }, - "com.amazonaws.ec2#RestoreAddressToClassic": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#RestoreAddressToClassicRequest" - }, - "output": { - "target": "com.amazonaws.ec2#RestoreAddressToClassicResult" - }, - "traits": { - "smithy.api#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.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " - } - }, - "com.amazonaws.ec2#RestoreAddressToClassicRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "PublicIp": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PublicIp", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Elastic IP address.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "publicIp" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#RestoreAddressToClassicResult": { - "type": "structure", - "members": { - "PublicIp": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PublicIp", - "smithy.api#documentation": "

The Elastic IP address.

", - "smithy.api#xmlName": "publicIp" - } - }, - "Status": { - "target": "com.amazonaws.ec2#Status", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The move status for the IP address.

", - "smithy.api#xmlName": "status" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#RestoreImageFromRecycleBin": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#RestoreImageFromRecycleBinRequest" - }, - "output": { - "target": "com.amazonaws.ec2#RestoreImageFromRecycleBinResult" - }, - "traits": { - "smithy.api#documentation": "

Restores an AMI from the Recycle Bin. For more information, see Recycle Bin in the Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#RestoreImageFromRecycleBinRequest": { - "type": "structure", - "members": { - "ImageId": { - "target": "com.amazonaws.ec2#ImageId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the AMI to restore.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#RestoreImageFromRecycleBinResult": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#RestoreManagedPrefixListVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#RestoreManagedPrefixListVersionRequest" - }, - "output": { - "target": "com.amazonaws.ec2#RestoreManagedPrefixListVersionResult" - }, - "traits": { - "smithy.api#documentation": "

Restores the entries from a previous version of a managed prefix list to a new version of the prefix list.

" - } - }, - "com.amazonaws.ec2#RestoreManagedPrefixListVersionRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "PrefixListId": { - "target": "com.amazonaws.ec2#PrefixListResourceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the prefix list.

", - "smithy.api#required": {} - } - }, - "PreviousVersion": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The version to restore.

", - "smithy.api#required": {} - } - }, - "CurrentVersion": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The current version number for the prefix list.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#RestoreManagedPrefixListVersionResult": { - "type": "structure", - "members": { - "PrefixList": { - "target": "com.amazonaws.ec2#ManagedPrefixList", - "traits": { - "aws.protocols#ec2QueryName": "PrefixList", - "smithy.api#documentation": "

Information about the prefix list.

", - "smithy.api#xmlName": "prefixList" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#RestoreSnapshotFromRecycleBin": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#RestoreSnapshotFromRecycleBinRequest" - }, - "output": { - "target": "com.amazonaws.ec2#RestoreSnapshotFromRecycleBinResult" - }, - "traits": { - "smithy.api#documentation": "

Restores a snapshot from the Recycle Bin. For more information, see Restore \n snapshots from the Recycle Bin in the Amazon Elastic Compute Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#RestoreSnapshotFromRecycleBinRequest": { - "type": "structure", - "members": { - "SnapshotId": { - "target": "com.amazonaws.ec2#SnapshotId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the snapshot to restore.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#RestoreSnapshotFromRecycleBinResult": { - "type": "structure", - "members": { - "SnapshotId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SnapshotId", - "smithy.api#documentation": "

The ID of the snapshot.

", - "smithy.api#xmlName": "snapshotId" - } - }, - "OutpostArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OutpostArn", - "smithy.api#documentation": "

The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the \n Amazon Elastic Compute Cloud User Guide.

", - "smithy.api#xmlName": "outpostArn" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

The description for the snapshot.

", - "smithy.api#xmlName": "description" - } - }, - "Encrypted": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Encrypted", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the snapshot is encrypted.

", - "smithy.api#xmlName": "encrypted" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the EBS snapshot.

", - "smithy.api#xmlName": "ownerId" - } - }, - "Progress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Progress", - "smithy.api#documentation": "

The progress of the snapshot, as a percentage.

", - "smithy.api#xmlName": "progress" - } - }, - "StartTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "StartTime", - "smithy.api#documentation": "

The time stamp when the snapshot was initiated.

", - "smithy.api#xmlName": "startTime" - } - }, - "State": { - "target": "com.amazonaws.ec2#SnapshotState", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The state of the snapshot.

", - "smithy.api#xmlName": "status" - } - }, - "VolumeId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VolumeId", - "smithy.api#documentation": "

The ID of the volume that was used to create the snapshot.

", - "smithy.api#xmlName": "volumeId" - } - }, - "VolumeSize": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "VolumeSize", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The size of the volume, in GiB.

", - "smithy.api#xmlName": "volumeSize" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#RestoreSnapshotTier": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#RestoreSnapshotTierRequest" - }, - "output": { - "target": "com.amazonaws.ec2#RestoreSnapshotTierResult" - }, - "traits": { - "smithy.api#documentation": "

Restores an archived Amazon EBS snapshot for use temporarily or permanently, or modifies the restore \n period or restore type for a snapshot that was previously temporarily restored.

\n

For more information see \n Restore an archived snapshot and \n modify the restore period or restore type for a temporarily restored snapshot in the Amazon Elastic Compute Cloud User Guide.

" - } - }, - "com.amazonaws.ec2#RestoreSnapshotTierRequest": { - "type": "structure", - "members": { - "SnapshotId": { - "target": "com.amazonaws.ec2#SnapshotId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the snapshot to restore.

", - "smithy.api#required": {} - } - }, - "TemporaryRestoreDays": { - "target": "com.amazonaws.ec2#RestoreSnapshotTierRequestTemporaryRestoreDays", - "traits": { - "smithy.api#documentation": "

Specifies the number of days for which to temporarily restore an archived snapshot. \n Required for temporary restores only. The snapshot will be automatically re-archived \n after this period.

\n

To temporarily restore an archived snapshot, specify the number of days and omit \n the PermanentRestore parameter or set it to \n false.

" - } - }, - "PermanentRestore": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to permanently restore an archived snapshot. To permanently restore \n an archived snapshot, specify true and omit the \n RestoreSnapshotTierRequest$TemporaryRestoreDays parameter.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#RestoreSnapshotTierRequestTemporaryRestoreDays": { - "type": "integer" - }, - "com.amazonaws.ec2#RestoreSnapshotTierResult": { - "type": "structure", - "members": { - "SnapshotId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SnapshotId", - "smithy.api#documentation": "

The ID of the snapshot.

", - "smithy.api#xmlName": "snapshotId" - } - }, - "RestoreStartTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "RestoreStartTime", - "smithy.api#documentation": "

The date and time when the snapshot restore process started.

", - "smithy.api#xmlName": "restoreStartTime" - } - }, - "RestoreDuration": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "RestoreDuration", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

For temporary restores only. The number of days for which the archived snapshot \n is temporarily restored.

", - "smithy.api#xmlName": "restoreDuration" - } - }, - "IsPermanentRestore": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "IsPermanentRestore", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the snapshot is permanently restored. true indicates a permanent \n restore. false indicates a temporary restore.

", - "smithy.api#xmlName": "isPermanentRestore" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ResultRange": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 20, - "max": 500 - } - } - }, - "com.amazonaws.ec2#RevokeClientVpnIngress": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#RevokeClientVpnIngressRequest" - }, - "output": { - "target": "com.amazonaws.ec2#RevokeClientVpnIngressResult" - }, - "traits": { - "smithy.api#documentation": "

Removes an ingress authorization rule from a Client VPN endpoint.

" - } - }, - "com.amazonaws.ec2#RevokeClientVpnIngressRequest": { - "type": "structure", - "members": { - "ClientVpnEndpointId": { - "target": "com.amazonaws.ec2#ClientVpnEndpointId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Client VPN endpoint with which the authorization rule is associated.

", - "smithy.api#required": {} - } - }, - "TargetNetworkCidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, of the network for which access is being removed.

", - "smithy.api#required": {} - } - }, - "AccessGroupId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The ID of the Active Directory group for which to revoke access.

" - } - }, - "RevokeAllGroups": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether access should be revoked for all clients.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#RevokeClientVpnIngressResult": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.ec2#ClientVpnAuthorizationRuleStatus", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The current state of the authorization rule.

", - "smithy.api#xmlName": "status" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#RevokeSecurityGroupEgress": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#RevokeSecurityGroupEgressRequest" - }, - "output": { - "target": "com.amazonaws.ec2#RevokeSecurityGroupEgressResult" - }, - "traits": { - "smithy.api#documentation": "

[VPC only] Removes the specified outbound (egress) rules from a security group for EC2-VPC.\n This action does not apply to security groups for use in EC2-Classic.

\n

You can specify rules using either rule IDs or security group rule properties. If you use\n rule properties, the values that you specify (for example, ports) must match the existing rule's \n values exactly. Each rule has a protocol, from and to ports, and destination (CIDR range, \n security group, or prefix list). For the TCP and UDP protocols, you must also specify the \n destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type \n and code. If the security group rule has a description, you do not need to specify the description \n to revoke the rule.

\n

[Default VPC] If the values you specify do not match the existing rule's values, no error is\n returned, and the output describes the security group rules that were not revoked.

\n

Amazon Web Services recommends that you describe the security group to verify that the rules were removed.

\n

Rule changes are propagated to instances within the security group as quickly as possible. However, \n a small delay might occur.

" - } - }, - "com.amazonaws.ec2#RevokeSecurityGroupEgressRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "GroupId": { - "target": "com.amazonaws.ec2#SecurityGroupId", - "traits": { - "aws.protocols#ec2QueryName": "GroupId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the security group.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "groupId" - } - }, - "IpPermissions": { - "target": "com.amazonaws.ec2#IpPermissionList", - "traits": { - "aws.protocols#ec2QueryName": "IpPermissions", - "smithy.api#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.

", - "smithy.api#xmlName": "ipPermissions" - } - }, - "SecurityGroupRuleIds": { - "target": "com.amazonaws.ec2#SecurityGroupRuleIdList", - "traits": { - "smithy.api#documentation": "

The IDs of the security group rules.

", - "smithy.api#xmlName": "SecurityGroupRuleId" - } - }, - "CidrIp": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CidrIp", - "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify the CIDR.

", - "smithy.api#xmlName": "cidrIp" - } - }, - "FromPort": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "FromPort", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify the port.

", - "smithy.api#xmlName": "fromPort" - } - }, - "IpProtocol": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "IpProtocol", - "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify the protocol name or\n number.

", - "smithy.api#xmlName": "ipProtocol" - } - }, - "ToPort": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "ToPort", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify the port.

", - "smithy.api#xmlName": "toPort" - } - }, - "SourceSecurityGroupName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SourceSecurityGroupName", - "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify a\n destination security group.

", - "smithy.api#xmlName": "sourceSecurityGroupName" - } - }, - "SourceSecurityGroupOwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SourceSecurityGroupOwnerId", - "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify a destination security\n group.

", - "smithy.api#xmlName": "sourceSecurityGroupOwnerId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#RevokeSecurityGroupEgressResult": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, returns an error.

", - "smithy.api#xmlName": "return" - } - }, - "UnknownIpPermissions": { - "target": "com.amazonaws.ec2#IpPermissionList", - "traits": { - "aws.protocols#ec2QueryName": "UnknownIpPermissionSet", - "smithy.api#documentation": "

The outbound rules that were unknown to the service. In some cases,\n unknownIpPermissionSet might be in a different format from the request\n parameter.

", - "smithy.api#xmlName": "unknownIpPermissionSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#RevokeSecurityGroupIngress": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#RevokeSecurityGroupIngressRequest" - }, - "output": { - "target": "com.amazonaws.ec2#RevokeSecurityGroupIngressResult" - }, - "traits": { - "smithy.api#documentation": "

Removes the specified inbound (ingress) rules from a security group.

\n

You can specify rules using either rule IDs or security group rule properties. If you use\n rule properties, the values that you specify (for example, ports) must match the existing rule's \n values exactly. Each rule has a protocol, from and to ports, and source (CIDR range, \n security group, or prefix list). For the TCP and UDP protocols, you must also specify the \n destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type \n and code. If the security group rule has a description, you do not need to specify the description \n to revoke the rule.

\n

[EC2-Classic, default VPC] If the values you specify do not match the existing rule's values, no error is\n returned, and the output describes the security group rules that were not revoked.

\n

Amazon Web Services recommends that you describe the security group to verify that the rules were removed.

\n

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " - } - }, - "com.amazonaws.ec2#RevokeSecurityGroupIngressRequest": { - "type": "structure", - "members": { - "CidrIp": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

" - } - }, - "FromPort": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

If the protocol is TCP or UDP, this is the start of the port range.\n If the protocol is ICMP, this is the type number. A value of -1 indicates all ICMP types.

" - } - }, - "GroupId": { - "target": "com.amazonaws.ec2#SecurityGroupId", - "traits": { - "smithy.api#documentation": "

The ID of the security group. You must specify either the security group ID or the\n security group name in the request. For security groups in a nondefault VPC, you must\n specify the security group ID.

" - } - }, - "GroupName": { - "target": "com.amazonaws.ec2#SecurityGroupName", - "traits": { - "smithy.api#documentation": "

[EC2-Classic, default VPC] The name of the security group. You must specify either the\n security group ID or the security group name in the request. For security groups in a\n nondefault VPC, you must specify the security group ID.

" - } - }, - "IpPermissions": { - "target": "com.amazonaws.ec2#IpPermissionList", - "traits": { - "smithy.api#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": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The IP protocol name (tcp, udp, icmp) or number \n (see Protocol Numbers). \n Use -1 to specify all.

" - } - }, - "SourceSecurityGroupName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#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": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

[EC2-Classic] The Amazon Web Services 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": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

If the protocol is TCP or UDP, this is the end of the port range.\n If the protocol is ICMP, this is the code. A value of -1 indicates all ICMP codes.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "SecurityGroupRuleIds": { - "target": "com.amazonaws.ec2#SecurityGroupRuleIdList", - "traits": { - "smithy.api#documentation": "

The IDs of the security group rules.

", - "smithy.api#xmlName": "SecurityGroupRuleId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#RevokeSecurityGroupIngressResult": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, returns an error.

", - "smithy.api#xmlName": "return" - } - }, - "UnknownIpPermissions": { - "target": "com.amazonaws.ec2#IpPermissionList", - "traits": { - "aws.protocols#ec2QueryName": "UnknownIpPermissionSet", - "smithy.api#documentation": "

The inbound rules that were unknown to the service. In some cases,\n unknownIpPermissionSet might be in a different format from the request\n parameter.

", - "smithy.api#xmlName": "unknownIpPermissionSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#RoleId": { - "type": "string" - }, - "com.amazonaws.ec2#RootDeviceType": { - "type": "enum", - "members": { - "ebs": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ebs" - } - }, - "instance_store": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "instance-store" - } - } - } - }, - "com.amazonaws.ec2#RootDeviceTypeList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#RootDeviceType", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#Route": { - "type": "structure", - "members": { - "DestinationCidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DestinationCidrBlock", - "smithy.api#documentation": "

The IPv4 CIDR block used for the destination match.

", - "smithy.api#xmlName": "destinationCidrBlock" - } - }, - "DestinationIpv6CidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DestinationIpv6CidrBlock", - "smithy.api#documentation": "

The IPv6 CIDR block used for the destination match.

", - "smithy.api#xmlName": "destinationIpv6CidrBlock" - } - }, - "DestinationPrefixListId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DestinationPrefixListId", - "smithy.api#documentation": "

The prefix of the Amazon Web Service.

", - "smithy.api#xmlName": "destinationPrefixListId" - } - }, - "EgressOnlyInternetGatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "EgressOnlyInternetGatewayId", - "smithy.api#documentation": "

The ID of the egress-only internet gateway.

", - "smithy.api#xmlName": "egressOnlyInternetGatewayId" - } - }, - "GatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GatewayId", - "smithy.api#documentation": "

The ID of a gateway attached to your VPC.

", - "smithy.api#xmlName": "gatewayId" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of a NAT instance in your VPC.

", - "smithy.api#xmlName": "instanceId" - } - }, - "InstanceOwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceOwnerId", - "smithy.api#documentation": "

The ID of Amazon Web Services account that owns the instance.

", - "smithy.api#xmlName": "instanceOwnerId" - } - }, - "NatGatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NatGatewayId", - "smithy.api#documentation": "

The ID of a NAT gateway.

", - "smithy.api#xmlName": "natGatewayId" - } - }, - "TransitGatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayId", - "smithy.api#documentation": "

The ID of a transit gateway.

", - "smithy.api#xmlName": "transitGatewayId" - } - }, - "LocalGatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayId", - "smithy.api#documentation": "

The ID of the local gateway.

", - "smithy.api#xmlName": "localGatewayId" - } - }, - "CarrierGatewayId": { - "target": "com.amazonaws.ec2#CarrierGatewayId", - "traits": { - "aws.protocols#ec2QueryName": "CarrierGatewayId", - "smithy.api#documentation": "

The ID of the carrier gateway.

", - "smithy.api#xmlName": "carrierGatewayId" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "

The ID of the network interface.

", - "smithy.api#xmlName": "networkInterfaceId" - } - }, - "Origin": { - "target": "com.amazonaws.ec2#RouteOrigin", - "traits": { - "aws.protocols#ec2QueryName": "Origin", - "smithy.api#documentation": "

Describes how the route was created.

\n ", - "smithy.api#xmlName": "origin" - } - }, - "State": { - "target": "com.amazonaws.ec2#RouteState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the route. The blackhole state indicates that the\n\t\t\t\troute's target isn't available (for example, the specified gateway isn't attached to the\n\t\t\t\tVPC, or the specified NAT instance has been terminated).

", - "smithy.api#xmlName": "state" - } - }, - "VpcPeeringConnectionId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", - "smithy.api#documentation": "

The ID of a VPC peering connection.

", - "smithy.api#xmlName": "vpcPeeringConnectionId" - } - }, - "CoreNetworkArn": { - "target": "com.amazonaws.ec2#CoreNetworkArn", - "traits": { - "aws.protocols#ec2QueryName": "CoreNetworkArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the core network.

", - "smithy.api#xmlName": "coreNetworkArn" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a route in a route table.

" - } - }, - "com.amazonaws.ec2#RouteGatewayId": { - "type": "string" - }, - "com.amazonaws.ec2#RouteList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Route", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#RouteOrigin": { - "type": "enum", - "members": { - "CreateRouteTable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateRouteTable" - } - }, - "CreateRoute": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateRoute" - } - }, - "EnableVgwRoutePropagation": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EnableVgwRoutePropagation" - } - } - } - }, - "com.amazonaws.ec2#RouteState": { - "type": "enum", - "members": { - "active": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "active" - } - }, - "blackhole": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "blackhole" - } - } - } - }, - "com.amazonaws.ec2#RouteTable": { - "type": "structure", - "members": { - "Associations": { - "target": "com.amazonaws.ec2#RouteTableAssociationList", - "traits": { - "aws.protocols#ec2QueryName": "AssociationSet", - "smithy.api#documentation": "

The associations between the route table and one or more subnets or a gateway.

", - "smithy.api#xmlName": "associationSet" - } - }, - "PropagatingVgws": { - "target": "com.amazonaws.ec2#PropagatingVgwList", - "traits": { - "aws.protocols#ec2QueryName": "PropagatingVgwSet", - "smithy.api#documentation": "

Any virtual private gateway (VGW) propagating routes.

", - "smithy.api#xmlName": "propagatingVgwSet" - } - }, - "RouteTableId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "RouteTableId", - "smithy.api#documentation": "

The ID of the route table.

", - "smithy.api#xmlName": "routeTableId" - } - }, - "Routes": { - "target": "com.amazonaws.ec2#RouteList", - "traits": { - "aws.protocols#ec2QueryName": "RouteSet", - "smithy.api#documentation": "

The routes in the route table.

", - "smithy.api#xmlName": "routeSet" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the route table.

", - "smithy.api#xmlName": "tagSet" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#xmlName": "vpcId" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the route table.

", - "smithy.api#xmlName": "ownerId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a route table.

" - } - }, - "com.amazonaws.ec2#RouteTableAssociation": { - "type": "structure", - "members": { - "Main": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Main", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether this is the main route table.

", - "smithy.api#xmlName": "main" - } - }, - "RouteTableAssociationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "RouteTableAssociationId", - "smithy.api#documentation": "

The ID of the association.

", - "smithy.api#xmlName": "routeTableAssociationId" - } - }, - "RouteTableId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "RouteTableId", - "smithy.api#documentation": "

The ID of the route table.

", - "smithy.api#xmlName": "routeTableId" - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#documentation": "

The ID of the subnet. A subnet ID is not returned for an implicit association.

", - "smithy.api#xmlName": "subnetId" - } - }, - "GatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GatewayId", - "smithy.api#documentation": "

The ID of the internet gateway or virtual private gateway.

", - "smithy.api#xmlName": "gatewayId" - } - }, - "AssociationState": { - "target": "com.amazonaws.ec2#RouteTableAssociationState", - "traits": { - "aws.protocols#ec2QueryName": "AssociationState", - "smithy.api#documentation": "

The state of the association.

", - "smithy.api#xmlName": "associationState" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an association between a route table and a subnet or gateway.

" - } - }, - "com.amazonaws.ec2#RouteTableAssociationId": { - "type": "string" - }, - "com.amazonaws.ec2#RouteTableAssociationList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#RouteTableAssociation", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#RouteTableAssociationState": { - "type": "structure", - "members": { - "State": { - "target": "com.amazonaws.ec2#RouteTableAssociationStateCode", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the association.

", - "smithy.api#xmlName": "state" - } - }, - "StatusMessage": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StatusMessage", - "smithy.api#documentation": "

The status message, if applicable.

", - "smithy.api#xmlName": "statusMessage" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the state of an association between a route table and a subnet or gateway.

" - } - }, - "com.amazonaws.ec2#RouteTableAssociationStateCode": { - "type": "enum", - "members": { - "associating": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "associating" - } - }, - "associated": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "associated" - } - }, - "disassociating": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disassociating" - } - }, - "disassociated": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disassociated" - } - }, - "failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failed" - } - } - } - }, - "com.amazonaws.ec2#RouteTableId": { - "type": "string" - }, - "com.amazonaws.ec2#RouteTableIdStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#RouteTableId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#RouteTableList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#RouteTable", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#RuleAction": { - "type": "enum", - "members": { - "allow": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "allow" - } - }, - "deny": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deny" - } - } - } - }, - "com.amazonaws.ec2#RuleGroupRuleOptionsPair": { - "type": "structure", - "members": { - "RuleGroupArn": { - "target": "com.amazonaws.ec2#ResourceArn", - "traits": { - "aws.protocols#ec2QueryName": "RuleGroupArn", - "smithy.api#documentation": "

The ARN of the rule group.

", - "smithy.api#xmlName": "ruleGroupArn" - } - }, - "RuleOptions": { - "target": "com.amazonaws.ec2#RuleOptionList", - "traits": { - "aws.protocols#ec2QueryName": "RuleOptionSet", - "smithy.api#documentation": "

The rule options.

", - "smithy.api#xmlName": "ruleOptionSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the rule options for a stateful rule group.

" - } - }, - "com.amazonaws.ec2#RuleGroupRuleOptionsPairList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#RuleGroupRuleOptionsPair", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#RuleGroupTypePair": { - "type": "structure", - "members": { - "RuleGroupArn": { - "target": "com.amazonaws.ec2#ResourceArn", - "traits": { - "aws.protocols#ec2QueryName": "RuleGroupArn", - "smithy.api#documentation": "

The ARN of the rule group.

", - "smithy.api#xmlName": "ruleGroupArn" - } - }, - "RuleGroupType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "RuleGroupType", - "smithy.api#documentation": "

The rule group type. The possible values are Domain List and Suricata.

", - "smithy.api#xmlName": "ruleGroupType" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the type of a stateful rule group.

" - } - }, - "com.amazonaws.ec2#RuleGroupTypePairList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#RuleGroupTypePair", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#RuleOption": { - "type": "structure", - "members": { - "Keyword": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Keyword", - "smithy.api#documentation": "

The Suricata keyword.

", - "smithy.api#xmlName": "keyword" - } - }, - "Settings": { - "target": "com.amazonaws.ec2#StringList", - "traits": { - "aws.protocols#ec2QueryName": "SettingSet", - "smithy.api#documentation": "

The settings for the keyword.

", - "smithy.api#xmlName": "settingSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes additional settings for a stateful rule.

" - } - }, - "com.amazonaws.ec2#RuleOptionList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#RuleOption", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#RunInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#RunInstancesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#Reservation" - }, - "traits": { - "smithy.api#documentation": "

Launches the specified number of instances using an AMI for which you have\n permissions.

\n

You can specify a number of options, or leave the default options. The following rules\n apply:

\n \n

You can create a launch template,\n which is a resource that contains the parameters to launch an instance. When you launch\n an instance using RunInstances, you can specify the launch template\n instead of specifying the launch parameters.

\n

To ensure faster instance launches, break up large requests into smaller batches. For\n example, create five separate launch requests for 100 instances each instead of one\n launch request for 500 instances.

\n

An instance is ready for you to use when it's in the running state. You\n can check the state of your instance using DescribeInstances. You can\n tag instances and EBS volumes during launch, after launch, or both. For more\n information, see CreateTags and Tagging your Amazon EC2\n resources.

\n

Linux instances have access to the public key of the key pair at boot. You can use\n this key to provide secure access to the instance. Amazon EC2 public images use this\n feature to provide secure access without passwords. For more information, see Key\n pairs.

\n

For troubleshooting, see What to do if\n an instance immediately terminates, and Troubleshooting connecting to your instance.

" - } - }, - "com.amazonaws.ec2#RunInstancesMonitoringEnabled": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Enabled", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is\n enabled.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "enabled" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the monitoring of an instance.

" - } - }, - "com.amazonaws.ec2#RunInstancesRequest": { - "type": "structure", - "members": { - "BlockDeviceMappings": { - "target": "com.amazonaws.ec2#BlockDeviceMappingRequestList", - "traits": { - "smithy.api#documentation": "

The block device mapping, which defines the EBS volumes and instance store volumes to\n attach to the instance at launch. For more information, see Block device\n mappings in the Amazon EC2 User Guide.

", - "smithy.api#xmlName": "BlockDeviceMapping" - } - }, - "ImageId": { - "target": "com.amazonaws.ec2#ImageId", - "traits": { - "smithy.api#documentation": "

The ID of the AMI. An AMI ID is required to launch an instance and must be specified\n here or in a launch template.

" - } - }, - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", - "traits": { - "smithy.api#documentation": "

The instance type. For more information, see Instance types in the\n Amazon EC2 User Guide.

\n

Default: m1.small\n

" - } - }, - "Ipv6AddressCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of IPv6 addresses to associate with the primary network\n interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You\n cannot specify this option and the option to assign specific IPv6 addresses in the same\n request. You can specify this option if you've specified a minimum number of instances\n to launch.

\n

You cannot specify this option and the network interfaces option in the same\n request.

" - } - }, - "Ipv6Addresses": { - "target": "com.amazonaws.ec2#InstanceIpv6AddressList", - "traits": { - "smithy.api#documentation": "

The IPv6 addresses from the range of the subnet to associate with the\n primary network interface. You cannot specify this option and the option to assign a\n number of IPv6 addresses in the same request. You cannot specify this option if you've\n specified a minimum number of instances to launch.

\n

You cannot specify this option and the network interfaces option in the same\n request.

", - "smithy.api#xmlName": "Ipv6Address" - } - }, - "KernelId": { - "target": "com.amazonaws.ec2#KernelId", - "traits": { - "smithy.api#documentation": "

The ID of the kernel.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see PV-GRUB in the\n Amazon EC2 User Guide.

\n " - } - }, - "KeyName": { - "target": "com.amazonaws.ec2#KeyPairName", - "traits": { - "smithy.api#documentation": "

The name of the key pair. You can create a key pair using CreateKeyPair or\n ImportKeyPair.

\n \n

If you do not specify a key pair, you can't connect to the instance unless you\n choose an AMI that is configured to allow users another way to log in.

\n " - } - }, - "MaxCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of instances to launch. If you specify more instances than Amazon\n EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible\n number of instances above MinCount.

\n

Constraints: Between 1 and the maximum number you're allowed for the specified\n instance type. For more information about the default limits, and how to request an\n increase, see How many instances can I\n run in Amazon EC2 in the Amazon EC2 FAQ.

", - "smithy.api#required": {} - } - }, - "MinCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum number of instances to launch. If you specify a minimum that is more\n instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2\n launches no instances.

\n

Constraints: Between 1 and the maximum number you're allowed for the specified\n instance type. For more information about the default limits, and how to request an\n increase, see How many instances can I\n run in Amazon EC2 in the Amazon EC2 General FAQ.

", - "smithy.api#required": {} - } - }, - "Monitoring": { - "target": "com.amazonaws.ec2#RunInstancesMonitoringEnabled", - "traits": { - "smithy.api#documentation": "

Specifies whether detailed monitoring is enabled for the instance.

" - } - }, - "Placement": { - "target": "com.amazonaws.ec2#Placement", - "traits": { - "smithy.api#documentation": "

The placement for the instance.

" - } - }, - "RamdiskId": { - "target": "com.amazonaws.ec2#RamdiskId", - "traits": { - "smithy.api#documentation": "

The ID of the RAM disk to select. Some kernels require additional drivers at launch.\n Check the kernel requirements for information about whether you need to specify a RAM\n disk. To find kernel requirements, go to the Amazon Web Services Resource Center and\n search for the kernel ID.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see PV-GRUB in the\n Amazon EC2 User Guide.

\n " - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.ec2#SecurityGroupIdStringList", - "traits": { - "smithy.api#documentation": "

The IDs of the security groups. You can create a security group using CreateSecurityGroup.

\n

If you specify a network interface, you must specify any security groups as part of\n the network interface.

", - "smithy.api#xmlName": "SecurityGroupId" - } - }, - "SecurityGroups": { - "target": "com.amazonaws.ec2#SecurityGroupStringList", - "traits": { - "smithy.api#documentation": "

[Default VPC] The names of the security groups.

\n

If you specify a network interface, you must specify any security groups as part of\n the network interface.

\n

Default: Amazon EC2 uses the default security group.

", - "smithy.api#xmlName": "SecurityGroup" - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#SubnetId", - "traits": { - "smithy.api#documentation": "

The ID of the subnet to launch the instance into.

\n

If you specify a network interface, you must specify any subnets as part of the\n network interface.

" - } - }, - "UserData": { - "target": "com.amazonaws.ec2#RunInstancesUserData", - "traits": { - "smithy.api#documentation": "

The user data script to make available to the instance. For more information, see\n Run\n commands on your Linux instance at launch and Run commands on your\n Windows instance at launch. If you are using a command line tool,\n base64-encoding is performed for you, and you can load the text from a file. Otherwise,\n you must provide base64-encoded text. User data is limited to 16 KB.

" - } - }, - "AdditionalInfo": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AdditionalInfo", - "smithy.api#documentation": "

Reserved.

", - "smithy.api#xmlName": "additionalInfo" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. If you do not specify a client token, a randomly generated token is used for\n the request to ensure idempotency.

\n

For more information, see Ensuring\n Idempotency.

\n

Constraints: Maximum 64 ASCII characters

", - "smithy.api#idempotencyToken": {}, - "smithy.api#xmlName": "clientToken" - } - }, - "DisableApiTermination": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DisableApiTermination", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

If you set this parameter to true, you can't terminate the instance using\n the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after\n launch, use ModifyInstanceAttribute. Alternatively, if you set\n InstanceInitiatedShutdownBehavior to terminate, you can\n terminate the instance by running the shutdown command from the instance.

\n

Default: false\n

", - "smithy.api#xmlName": "disableApiTermination" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "EbsOptimized": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "EbsOptimized", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the instance is optimized for Amazon EBS I/O. This optimization\n provides dedicated throughput to Amazon EBS and an optimized configuration stack to\n provide optimal Amazon EBS I/O performance. This optimization isn't available with all\n instance types. Additional usage charges apply when using an EBS-optimized\n instance.

\n

Default: false\n

", - "smithy.api#xmlName": "ebsOptimized" - } - }, - "IamInstanceProfile": { - "target": "com.amazonaws.ec2#IamInstanceProfileSpecification", - "traits": { - "aws.protocols#ec2QueryName": "IamInstanceProfile", - "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of an IAM instance\n profile.

", - "smithy.api#xmlName": "iamInstanceProfile" - } - }, - "InstanceInitiatedShutdownBehavior": { - "target": "com.amazonaws.ec2#ShutdownBehavior", - "traits": { - "aws.protocols#ec2QueryName": "InstanceInitiatedShutdownBehavior", - "smithy.api#documentation": "

Indicates whether an instance stops or terminates when you initiate shutdown from the\n instance (using the operating system command for system shutdown).

\n

Default: stop\n

", - "smithy.api#xmlName": "instanceInitiatedShutdownBehavior" - } - }, - "NetworkInterfaces": { - "target": "com.amazonaws.ec2#InstanceNetworkInterfaceSpecificationList", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterface", - "smithy.api#documentation": "

The network interfaces to associate with the instance. If you specify a network\n interface, you must specify any security groups and subnets as part of the network\n interface.

", - "smithy.api#xmlName": "networkInterface" - } - }, - "PrivateIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrivateIpAddress", - "smithy.api#documentation": "

The primary IPv4 address. You must specify a value from the IPv4 address\n range of the subnet.

\n

Only one private IP address can be designated as primary. You can't specify this\n option if you've specified the option to designate a private IP address as the primary\n IP address in a network interface specification. You cannot specify this option if\n you're launching more than one instance in the request.

\n

You cannot specify this option and the network interfaces option in the same\n request.

", - "smithy.api#xmlName": "privateIpAddress" - } - }, - "ElasticGpuSpecification": { - "target": "com.amazonaws.ec2#ElasticGpuSpecifications", - "traits": { - "smithy.api#documentation": "

An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that\n you can attach to your Windows instance to accelerate the graphics performance of your\n applications. For more information, see Amazon EC2 Elastic GPUs in\n the Amazon EC2 User Guide.

" - } - }, - "ElasticInferenceAccelerators": { - "target": "com.amazonaws.ec2#ElasticInferenceAccelerators", - "traits": { - "smithy.api#documentation": "

An elastic inference accelerator to associate with the instance. Elastic inference\n accelerators are a resource you can attach to your Amazon EC2 instances to accelerate\n your Deep Learning (DL) inference workloads.

\n

You cannot specify accelerators from different generations in the same request.

\n \n

Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon\n Elastic Inference (EI), and will help current customers migrate their workloads to\n options that offer better price and performance. After April 15, 2023, new customers\n will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker,\n Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during\n the past 30-day period are considered current customers and will be able to continue\n using the service.

\n ", - "smithy.api#xmlName": "ElasticInferenceAccelerator" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the resources that are created during instance launch.

\n

You can specify tags for the following resources only:

\n \n

To tag a resource after it has been created, see CreateTags.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "LaunchTemplate": { - "target": "com.amazonaws.ec2#LaunchTemplateSpecification", - "traits": { - "smithy.api#documentation": "

The launch template to use to launch the instances. Any parameters that you specify in\n RunInstances override the same parameters in the launch template.\n You can specify either the name or ID of a launch template, but not both.

" - } - }, - "InstanceMarketOptions": { - "target": "com.amazonaws.ec2#InstanceMarketOptionsRequest", - "traits": { - "smithy.api#documentation": "

The market (purchasing) option for the instances.

\n

For RunInstances, persistent Spot Instance requests are\n only supported when InstanceInterruptionBehavior is set\n to either hibernate or stop.

" - } - }, - "CreditSpecification": { - "target": "com.amazonaws.ec2#CreditSpecificationRequest", - "traits": { - "smithy.api#documentation": "

The credit option for CPU usage of the burstable performance instance. Valid values\n are standard and unlimited. To change this attribute after\n launch, use \n ModifyInstanceCreditSpecification. For more information, see Burstable\n performance instances in the Amazon EC2 User Guide.

\n

Default: standard (T2 instances) or unlimited (T3/T3a/T4g\n instances)

\n

For T3 instances with host tenancy, only standard is\n supported.

" - } - }, - "CpuOptions": { - "target": "com.amazonaws.ec2#CpuOptionsRequest", - "traits": { - "smithy.api#documentation": "

The CPU options for the instance. For more information, see Optimize CPU options in the Amazon EC2 User Guide.

" - } - }, - "CapacityReservationSpecification": { - "target": "com.amazonaws.ec2#CapacityReservationSpecification", - "traits": { - "smithy.api#documentation": "

Information about the Capacity Reservation targeting option. If you do not specify this parameter, the\n instance's Capacity Reservation preference defaults to open, which enables\n it to run in any open Capacity Reservation that has matching attributes (instance type,\n platform, Availability Zone).

" - } - }, - "HibernationOptions": { - "target": "com.amazonaws.ec2#HibernationOptionsRequest", - "traits": { - "smithy.api#documentation": "

Indicates whether an instance is enabled for hibernation. For more information, see\n Hibernate\n your instance in the Amazon EC2 User Guide.

\n

You can't enable hibernation and Amazon Web Services Nitro Enclaves on the same\n instance.

" - } - }, - "LicenseSpecifications": { - "target": "com.amazonaws.ec2#LicenseSpecificationListRequest", - "traits": { - "smithy.api#documentation": "

The license configurations.

", - "smithy.api#xmlName": "LicenseSpecification" - } - }, - "MetadataOptions": { - "target": "com.amazonaws.ec2#InstanceMetadataOptionsRequest", - "traits": { - "smithy.api#documentation": "

The metadata options for the instance. For more information, see Instance metadata and user data.

" - } - }, - "EnclaveOptions": { - "target": "com.amazonaws.ec2#EnclaveOptionsRequest", - "traits": { - "smithy.api#documentation": "

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For\n more information, see What is Amazon Web Services Nitro\n Enclaves? in the Amazon Web Services Nitro Enclaves User\n Guide.

\n

You can't enable Amazon Web Services Nitro Enclaves and hibernation on the same\n instance.

" - } - }, - "PrivateDnsNameOptions": { - "target": "com.amazonaws.ec2#PrivateDnsNameOptionsRequest", - "traits": { - "smithy.api#documentation": "

The options for the instance hostname. The default values are inherited from the\n subnet.

" - } - }, - "MaintenanceOptions": { - "target": "com.amazonaws.ec2#InstanceMaintenanceOptionsRequest", - "traits": { - "smithy.api#documentation": "

The maintenance and recovery options for the instance.

" - } - }, - "DisableApiStop": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether an instance is enabled for stop protection. For more information,\n see Stop\n protection.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#RunInstancesUserData": { - "type": "string", - "traits": { - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.ec2#RunScheduledInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#RunScheduledInstancesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#RunScheduledInstancesResult" - }, - "traits": { - "smithy.api#documentation": "

Launches the specified Scheduled Instances.

\n

Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances.

\n

You must launch a Scheduled Instance during its scheduled time period. You can't stop or reboot a Scheduled Instance, \n but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, \n you can launch it again after a few minutes. For more information, see Scheduled Instances\n in the Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#RunScheduledInstancesRequest": { - "type": "structure", - "members": { - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that ensures the idempotency of the request. \n For more information, see Ensuring Idempotency.

", - "smithy.api#idempotencyToken": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "InstanceCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of instances.

\n

Default: 1

" - } - }, - "LaunchSpecification": { - "target": "com.amazonaws.ec2#ScheduledInstancesLaunchSpecification", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The launch specification. You must match the instance type, Availability Zone, \n network, and platform of the schedule that you purchased.

", - "smithy.api#required": {} - } - }, - "ScheduledInstanceId": { - "target": "com.amazonaws.ec2#ScheduledInstanceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Scheduled Instance ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for RunScheduledInstances.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#RunScheduledInstancesResult": { - "type": "structure", - "members": { - "InstanceIdSet": { - "target": "com.amazonaws.ec2#InstanceIdSet", - "traits": { - "aws.protocols#ec2QueryName": "InstanceIdSet", - "smithy.api#documentation": "

The IDs of the newly launched instances.

", - "smithy.api#xmlName": "instanceIdSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of RunScheduledInstances.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#S3ObjectTag": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and can be up to 128 Unicode characters in\n length. May not begin with aws:.

" - } - }, - "Value": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The value of the tag.

\n

Constraints: Tag values are case-sensitive and can be up to 256 Unicode characters in\n length.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The tags to apply to the AMI object that will be stored in the Amazon S3 bucket. For more\n information, see Categorizing your storage using\n tags in the Amazon Simple Storage Service User Guide.

" - } - }, - "com.amazonaws.ec2#S3ObjectTagList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#S3ObjectTag", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#S3Storage": { - "type": "structure", - "members": { - "AWSAccessKeyId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The access key ID of the owner of the bucket. Before you specify a value for your access\n key ID, review and follow the guidance in Best\n Practices for Amazon Web Services accounts in the Account ManagementReference\n Guide.

" - } - }, - "Bucket": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Bucket", - "smithy.api#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.

", - "smithy.api#xmlName": "bucket" - } - }, - "Prefix": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Prefix", - "smithy.api#documentation": "

The beginning of the file name of the AMI.

", - "smithy.api#xmlName": "prefix" - } - }, - "UploadPolicy": { - "target": "com.amazonaws.ec2#Blob", - "traits": { - "aws.protocols#ec2QueryName": "UploadPolicy", - "smithy.api#documentation": "

An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.

", - "smithy.api#xmlName": "uploadPolicy" - } - }, - "UploadPolicySignature": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "UploadPolicySignature", - "smithy.api#documentation": "

The signature of the JSON document.

", - "smithy.api#xmlName": "uploadPolicySignature" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the storage parameters for Amazon S3 and Amazon S3 buckets for an instance store-backed AMI.

" - } - }, - "com.amazonaws.ec2#ScheduledInstance": { - "type": "structure", - "members": { - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone.

", - "smithy.api#xmlName": "availabilityZone" - } - }, - "CreateDate": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "CreateDate", - "smithy.api#documentation": "

The date when the Scheduled Instance was purchased.

", - "smithy.api#xmlName": "createDate" - } - }, - "HourlyPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "HourlyPrice", - "smithy.api#documentation": "

The hourly price for a single instance.

", - "smithy.api#xmlName": "hourlyPrice" - } - }, - "InstanceCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "InstanceCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of instances.

", - "smithy.api#xmlName": "instanceCount" - } - }, - "InstanceType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type.

", - "smithy.api#xmlName": "instanceType" - } - }, - "NetworkPlatform": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NetworkPlatform", - "smithy.api#documentation": "

The network platform.

", - "smithy.api#xmlName": "networkPlatform" - } - }, - "NextSlotStartTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "NextSlotStartTime", - "smithy.api#documentation": "

The time for the next schedule to start.

", - "smithy.api#xmlName": "nextSlotStartTime" - } - }, - "Platform": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Platform", - "smithy.api#documentation": "

The platform (Linux/UNIX or Windows).

", - "smithy.api#xmlName": "platform" - } - }, - "PreviousSlotEndTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "PreviousSlotEndTime", - "smithy.api#documentation": "

The time that the previous schedule ended or will end.

", - "smithy.api#xmlName": "previousSlotEndTime" - } - }, - "Recurrence": { - "target": "com.amazonaws.ec2#ScheduledInstanceRecurrence", - "traits": { - "aws.protocols#ec2QueryName": "Recurrence", - "smithy.api#documentation": "

The schedule recurrence.

", - "smithy.api#xmlName": "recurrence" - } - }, - "ScheduledInstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ScheduledInstanceId", - "smithy.api#documentation": "

The Scheduled Instance ID.

", - "smithy.api#xmlName": "scheduledInstanceId" - } - }, - "SlotDurationInHours": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "SlotDurationInHours", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of hours in the schedule.

", - "smithy.api#xmlName": "slotDurationInHours" - } - }, - "TermEndDate": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "TermEndDate", - "smithy.api#documentation": "

The end date for the Scheduled Instance.

", - "smithy.api#xmlName": "termEndDate" - } - }, - "TermStartDate": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "TermStartDate", - "smithy.api#documentation": "

The start date for the Scheduled Instance.

", - "smithy.api#xmlName": "termStartDate" - } - }, - "TotalScheduledInstanceHours": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "TotalScheduledInstanceHours", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The total number of hours for a single instance for the entire term.

", - "smithy.api#xmlName": "totalScheduledInstanceHours" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a Scheduled Instance.

" - } - }, - "com.amazonaws.ec2#ScheduledInstanceAvailability": { - "type": "structure", - "members": { - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone.

", - "smithy.api#xmlName": "availabilityZone" - } - }, - "AvailableInstanceCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "AvailableInstanceCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of available instances.

", - "smithy.api#xmlName": "availableInstanceCount" - } - }, - "FirstSlotStartTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "FirstSlotStartTime", - "smithy.api#documentation": "

The time period for the first schedule to start.

", - "smithy.api#xmlName": "firstSlotStartTime" - } - }, - "HourlyPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "HourlyPrice", - "smithy.api#documentation": "

The hourly price for a single instance.

", - "smithy.api#xmlName": "hourlyPrice" - } - }, - "InstanceType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type. You can specify one of the C3, C4, M4, or R3 instance types.

", - "smithy.api#xmlName": "instanceType" - } - }, - "MaxTermDurationInDays": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "MaxTermDurationInDays", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum term. The only possible value is 365 days.

", - "smithy.api#xmlName": "maxTermDurationInDays" - } - }, - "MinTermDurationInDays": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "MinTermDurationInDays", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum term. The only possible value is 365 days.

", - "smithy.api#xmlName": "minTermDurationInDays" - } - }, - "NetworkPlatform": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NetworkPlatform", - "smithy.api#documentation": "

The network platform.

", - "smithy.api#xmlName": "networkPlatform" - } - }, - "Platform": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Platform", - "smithy.api#documentation": "

The platform (Linux/UNIX or Windows).

", - "smithy.api#xmlName": "platform" - } - }, - "PurchaseToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PurchaseToken", - "smithy.api#documentation": "

The purchase token. This token expires in two hours.

", - "smithy.api#xmlName": "purchaseToken" - } - }, - "Recurrence": { - "target": "com.amazonaws.ec2#ScheduledInstanceRecurrence", - "traits": { - "aws.protocols#ec2QueryName": "Recurrence", - "smithy.api#documentation": "

The schedule recurrence.

", - "smithy.api#xmlName": "recurrence" - } - }, - "SlotDurationInHours": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "SlotDurationInHours", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of hours in the schedule.

", - "smithy.api#xmlName": "slotDurationInHours" - } - }, - "TotalScheduledInstanceHours": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "TotalScheduledInstanceHours", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The total number of hours for a single instance for the entire term.

", - "smithy.api#xmlName": "totalScheduledInstanceHours" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a schedule that is available for your Scheduled Instances.

" - } - }, - "com.amazonaws.ec2#ScheduledInstanceAvailabilitySet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ScheduledInstanceAvailability", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ScheduledInstanceId": { - "type": "string" - }, - "com.amazonaws.ec2#ScheduledInstanceIdRequestSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ScheduledInstanceId", - "traits": { - "smithy.api#xmlName": "ScheduledInstanceId" - } - } - }, - "com.amazonaws.ec2#ScheduledInstanceRecurrence": { - "type": "structure", - "members": { - "Frequency": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Frequency", - "smithy.api#documentation": "

The frequency (Daily, Weekly, or Monthly).

", - "smithy.api#xmlName": "frequency" - } - }, - "Interval": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Interval", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The interval quantity. The interval unit depends on the value of frequency. For example, every 2\n weeks or every 2 months.

", - "smithy.api#xmlName": "interval" - } - }, - "OccurrenceDaySet": { - "target": "com.amazonaws.ec2#OccurrenceDaySet", - "traits": { - "aws.protocols#ec2QueryName": "OccurrenceDaySet", - "smithy.api#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).

", - "smithy.api#xmlName": "occurrenceDaySet" - } - }, - "OccurrenceRelativeToEnd": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "OccurrenceRelativeToEnd", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the occurrence is relative to the end of the specified week or month.

", - "smithy.api#xmlName": "occurrenceRelativeToEnd" - } - }, - "OccurrenceUnit": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OccurrenceUnit", - "smithy.api#documentation": "

The unit for occurrenceDaySet (DayOfWeek or DayOfMonth).

", - "smithy.api#xmlName": "occurrenceUnit" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the recurring schedule for a Scheduled Instance.

" - } - }, - "com.amazonaws.ec2#ScheduledInstanceRecurrenceRequest": { - "type": "structure", - "members": { - "Frequency": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The frequency (Daily, Weekly, or Monthly).

" - } - }, - "Interval": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The interval quantity. The interval unit depends on the value of Frequency. For example, every 2 \n weeks or every 2 months.

" - } - }, - "OccurrenceDays": { - "target": "com.amazonaws.ec2#OccurrenceDayRequestSet", - "traits": { - "smithy.api#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.

", - "smithy.api#xmlName": "OccurrenceDay" - } - }, - "OccurrenceRelativeToEnd": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#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": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The unit for OccurrenceDays (DayOfWeek or DayOfMonth).\n This value is required for a monthly schedule.\n You can't specify DayOfWeek with a weekly schedule.\n You can't specify this value with a daily schedule.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the recurring schedule for a Scheduled Instance.

" - } - }, - "com.amazonaws.ec2#ScheduledInstanceSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ScheduledInstance", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ScheduledInstancesBlockDeviceMapping": { - "type": "structure", - "members": { - "DeviceName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The device name (for example, /dev/sdh or xvdh).

" - } - }, - "Ebs": { - "target": "com.amazonaws.ec2#ScheduledInstancesEbs", - "traits": { - "smithy.api#documentation": "

Parameters used to set up EBS volumes automatically when the instance is launched.

" - } - }, - "NoDevice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

To omit the device from the block device mapping, specify an empty string.

" - } - }, - "VirtualName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The virtual device name (ephemeralN). Instance store volumes are numbered\n starting from 0. An instance type with two available instance store volumes can specify mappings\n for ephemeral0 and ephemeral1. The number of available instance store\n volumes depends on the instance type. After you connect to the instance, you must mount the\n volume.

\n

Constraints: For M3 instances, you must specify instance store volumes in the block device \n mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes \n specified in the block device mapping for the AMI.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a block device mapping for a Scheduled Instance.

" - } - }, - "com.amazonaws.ec2#ScheduledInstancesBlockDeviceMappingSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ScheduledInstancesBlockDeviceMapping", - "traits": { - "smithy.api#xmlName": "BlockDeviceMapping" - } - } - }, - "com.amazonaws.ec2#ScheduledInstancesEbs": { - "type": "structure", - "members": { - "DeleteOnTermination": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the volume is deleted on instance termination.

" - } - }, - "Encrypted": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the volume is encrypted. You can attached encrypted volumes only to instances that support them.

" - } - }, - "Iops": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of I/O operations per second (IOPS) to provision for an io1 or io2 volume, with a maximum\n \t\tratio of 50 IOPS/GiB for io1, and 500 IOPS/GiB for io2. Range is 100 to 64,000 IOPS for\n \t\tvolumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on\n \t\tinstances built on the Nitro System. Other instance families guarantee performance up to\n \t\t32,000 IOPS. For more information, see Amazon EBS volume types in the\n \t\tAmazon EC2 User Guide.

\n

This parameter is valid only for Provisioned IOPS SSD (io1 and io2) volumes.

" - } - }, - "SnapshotId": { - "target": "com.amazonaws.ec2#SnapshotId", - "traits": { - "smithy.api#documentation": "

The ID of the snapshot.

" - } - }, - "VolumeSize": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The size of the volume, in GiB.

\n

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

" - } - }, - "VolumeType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The volume type. gp2 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, Throughput Optimized HDD\n for st1, Cold HDD for sc1, or standard for\n Magnetic.

\n

Default: gp2\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an EBS volume for a Scheduled Instance.

" - } - }, - "com.amazonaws.ec2#ScheduledInstancesIamInstanceProfile": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN).

" - } - }, - "Name": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The name.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an IAM instance profile for a Scheduled Instance.

" - } - }, - "com.amazonaws.ec2#ScheduledInstancesIpv6Address": { - "type": "structure", - "members": { - "Ipv6Address": { - "target": "com.amazonaws.ec2#Ipv6Address", - "traits": { - "smithy.api#documentation": "

The IPv6 address.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an IPv6 address.

" - } - }, - "com.amazonaws.ec2#ScheduledInstancesIpv6AddressList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ScheduledInstancesIpv6Address", - "traits": { - "smithy.api#xmlName": "Ipv6Address" - } - } - }, - "com.amazonaws.ec2#ScheduledInstancesLaunchSpecification": { - "type": "structure", - "members": { - "BlockDeviceMappings": { - "target": "com.amazonaws.ec2#ScheduledInstancesBlockDeviceMappingSet", - "traits": { - "smithy.api#documentation": "

The block device mapping entries.

", - "smithy.api#xmlName": "BlockDeviceMapping" - } - }, - "EbsOptimized": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#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.

\n

Default: false\n

" - } - }, - "IamInstanceProfile": { - "target": "com.amazonaws.ec2#ScheduledInstancesIamInstanceProfile", - "traits": { - "smithy.api#documentation": "

The IAM instance profile.

" - } - }, - "ImageId": { - "target": "com.amazonaws.ec2#ImageId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI).

", - "smithy.api#required": {} - } - }, - "InstanceType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The instance type.

" - } - }, - "KernelId": { - "target": "com.amazonaws.ec2#KernelId", - "traits": { - "smithy.api#documentation": "

The ID of the kernel.

" - } - }, - "KeyName": { - "target": "com.amazonaws.ec2#KeyPairName", - "traits": { - "smithy.api#documentation": "

The name of the key pair.

" - } - }, - "Monitoring": { - "target": "com.amazonaws.ec2#ScheduledInstancesMonitoring", - "traits": { - "smithy.api#documentation": "

Enable or disable monitoring for the instances.

" - } - }, - "NetworkInterfaces": { - "target": "com.amazonaws.ec2#ScheduledInstancesNetworkInterfaceSet", - "traits": { - "smithy.api#documentation": "

The network interfaces.

", - "smithy.api#xmlName": "NetworkInterface" - } - }, - "Placement": { - "target": "com.amazonaws.ec2#ScheduledInstancesPlacement", - "traits": { - "smithy.api#documentation": "

The placement information.

" - } - }, - "RamdiskId": { - "target": "com.amazonaws.ec2#RamdiskId", - "traits": { - "smithy.api#documentation": "

The ID of the RAM disk.

" - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.ec2#ScheduledInstancesSecurityGroupIdSet", - "traits": { - "smithy.api#documentation": "

The IDs of the security groups.

", - "smithy.api#xmlName": "SecurityGroupId" - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#SubnetId", - "traits": { - "smithy.api#documentation": "

The ID of the subnet in which to launch the instances.

" - } - }, - "UserData": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The base64-encoded MIME user data.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the launch specification for a Scheduled Instance.

\n

If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet.\n You can specify the subnet using either SubnetId or NetworkInterface.

", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.ec2#ScheduledInstancesMonitoring": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether monitoring is enabled.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes whether monitoring is enabled for a Scheduled Instance.

" - } - }, - "com.amazonaws.ec2#ScheduledInstancesNetworkInterface": { - "type": "structure", - "members": { - "AssociatePublicIpAddress": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to assign a public IPv4 address to instances launched in a VPC. The\n public IPv4 address can only be assigned to a network interface for eth0, and can only be\n assigned to a new network interface, not an existing one. You cannot specify more than one\n network interface in the request. If launching into a default subnet, the default value is\n true.

" - } - }, - "DeleteOnTermination": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to delete the interface when the instance is terminated.

" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The description.

" - } - }, - "DeviceIndex": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The index of the device for the network interface attachment.

" - } - }, - "Groups": { - "target": "com.amazonaws.ec2#ScheduledInstancesSecurityGroupIdSet", - "traits": { - "smithy.api#documentation": "

The IDs of the security groups.

", - "smithy.api#xmlName": "Group" - } - }, - "Ipv6AddressCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of IPv6 addresses to assign to the network interface. The IPv6 addresses are automatically selected from the subnet range.

" - } - }, - "Ipv6Addresses": { - "target": "com.amazonaws.ec2#ScheduledInstancesIpv6AddressList", - "traits": { - "smithy.api#documentation": "

The specific IPv6 addresses from the subnet range.

", - "smithy.api#xmlName": "Ipv6Address" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#NetworkInterfaceId", - "traits": { - "smithy.api#documentation": "

The ID of the network interface.

" - } - }, - "PrivateIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The IPv4 address of the network interface within the subnet.

" - } - }, - "PrivateIpAddressConfigs": { - "target": "com.amazonaws.ec2#PrivateIpAddressConfigSet", - "traits": { - "smithy.api#documentation": "

The private IPv4 addresses.

", - "smithy.api#xmlName": "PrivateIpAddressConfig" - } - }, - "SecondaryPrivateIpAddressCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of secondary private IPv4 addresses.

" - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#SubnetId", - "traits": { - "smithy.api#documentation": "

The ID of the subnet.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a network interface for a Scheduled Instance.

" - } - }, - "com.amazonaws.ec2#ScheduledInstancesNetworkInterfaceSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ScheduledInstancesNetworkInterface", - "traits": { - "smithy.api#xmlName": "NetworkInterface" - } - } - }, - "com.amazonaws.ec2#ScheduledInstancesPlacement": { - "type": "structure", - "members": { - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The Availability Zone.

" - } - }, - "GroupName": { - "target": "com.amazonaws.ec2#PlacementGroupName", - "traits": { - "smithy.api#documentation": "

The name of the placement group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the placement for a Scheduled Instance.

" - } - }, - "com.amazonaws.ec2#ScheduledInstancesPrivateIpAddressConfig": { - "type": "structure", - "members": { - "Primary": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether this is a primary IPv4 address. Otherwise, this is a secondary IPv4 address.

" - } - }, - "PrivateIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The IPv4 address.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a private IPv4 address for a Scheduled Instance.

" - } - }, - "com.amazonaws.ec2#ScheduledInstancesSecurityGroupIdSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SecurityGroupId", - "traits": { - "smithy.api#xmlName": "SecurityGroupId" - } - } - }, - "com.amazonaws.ec2#SearchLocalGatewayRoutes": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#SearchLocalGatewayRoutesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#SearchLocalGatewayRoutesResult" - }, - "traits": { - "smithy.api#documentation": "

Searches for routes in the specified local gateway route table.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Routes", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#SearchLocalGatewayRoutesRequest": { - "type": "structure", - "members": { - "LocalGatewayRouteTableId": { - "target": "com.amazonaws.ec2#LocalGatewayRoutetableId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the local gateway route table.

", - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#SearchLocalGatewayRoutesResult": { - "type": "structure", - "members": { - "Routes": { - "target": "com.amazonaws.ec2#LocalGatewayRouteList", - "traits": { - "aws.protocols#ec2QueryName": "RouteSet", - "smithy.api#documentation": "

Information about the routes.

", - "smithy.api#xmlName": "routeSet" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#SearchTransitGatewayMulticastGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#SearchTransitGatewayMulticastGroupsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#SearchTransitGatewayMulticastGroupsResult" - }, - "traits": { - "smithy.api#documentation": "

Searches one or more transit gateway multicast groups and returns the group membership information.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "MulticastGroups", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.ec2#SearchTransitGatewayMulticastGroupsRequest": { - "type": "structure", - "members": { - "TransitGatewayMulticastDomainId": { - "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#TransitGatewayMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#SearchTransitGatewayMulticastGroupsResult": { - "type": "structure", - "members": { - "MulticastGroups": { - "target": "com.amazonaws.ec2#TransitGatewayMulticastGroupList", - "traits": { - "aws.protocols#ec2QueryName": "MulticastGroups", - "smithy.api#documentation": "

Information about the transit gateway multicast group.

", - "smithy.api#xmlName": "multicastGroups" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#SearchTransitGatewayRoutes": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#SearchTransitGatewayRoutesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#SearchTransitGatewayRoutesResult" - }, - "traits": { - "smithy.api#documentation": "

Searches for routes in the specified transit gateway route table.

" - } - }, - "com.amazonaws.ec2#SearchTransitGatewayRoutesRequest": { - "type": "structure", - "members": { - "TransitGatewayRouteTableId": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the transit gateway route table.

", - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", - "smithy.api#required": {}, - "smithy.api#xmlName": "Filter" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#TransitGatewayMaxResults", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of routes to return.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#SearchTransitGatewayRoutesResult": { - "type": "structure", - "members": { - "Routes": { - "target": "com.amazonaws.ec2#TransitGatewayRouteList", - "traits": { - "aws.protocols#ec2QueryName": "RouteSet", - "smithy.api#documentation": "

Information about the routes.

", - "smithy.api#xmlName": "routeSet" - } - }, - "AdditionalRoutesAvailable": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "AdditionalRoutesAvailable", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether there are additional routes available.

", - "smithy.api#xmlName": "additionalRoutesAvailable" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#SecurityGroup": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupDescription", - "smithy.api#documentation": "

A description of the security group.

", - "smithy.api#xmlName": "groupDescription" - } - }, - "GroupName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupName", - "smithy.api#documentation": "

The name of the security group.

", - "smithy.api#xmlName": "groupName" - } - }, - "IpPermissions": { - "target": "com.amazonaws.ec2#IpPermissionList", - "traits": { - "aws.protocols#ec2QueryName": "IpPermissions", - "smithy.api#documentation": "

The inbound rules associated with the security group.

", - "smithy.api#xmlName": "ipPermissions" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the security group.

", - "smithy.api#xmlName": "ownerId" - } - }, - "GroupId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupId", - "smithy.api#documentation": "

The ID of the security group.

", - "smithy.api#xmlName": "groupId" - } - }, - "IpPermissionsEgress": { - "target": "com.amazonaws.ec2#IpPermissionList", - "traits": { - "aws.protocols#ec2QueryName": "IpPermissionsEgress", - "smithy.api#documentation": "

[VPC only] The outbound rules associated with the security group.

", - "smithy.api#xmlName": "ipPermissionsEgress" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the security group.

", - "smithy.api#xmlName": "tagSet" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

[VPC only] The ID of the VPC for the security group.

", - "smithy.api#xmlName": "vpcId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a security group.

" - } - }, - "com.amazonaws.ec2#SecurityGroupId": { - "type": "string" - }, - "com.amazonaws.ec2#SecurityGroupIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SecurityGroupId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#SecurityGroupIdStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SecurityGroupId", - "traits": { - "smithy.api#xmlName": "SecurityGroupId" - } - } - }, - "com.amazonaws.ec2#SecurityGroupIdentifier": { - "type": "structure", - "members": { - "GroupId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupId", - "smithy.api#documentation": "

The ID of the security group.

", - "smithy.api#xmlName": "groupId" - } - }, - "GroupName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupName", - "smithy.api#documentation": "

The name of the security group.

", - "smithy.api#xmlName": "groupName" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a security group.

" - } - }, - "com.amazonaws.ec2#SecurityGroupList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SecurityGroup", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#SecurityGroupName": { - "type": "string" - }, - "com.amazonaws.ec2#SecurityGroupReference": { - "type": "structure", - "members": { - "GroupId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupId", - "smithy.api#documentation": "

The ID of your security group.

", - "smithy.api#xmlName": "groupId" - } - }, - "ReferencingVpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ReferencingVpcId", - "smithy.api#documentation": "

The ID of the VPC with the referencing security group.

", - "smithy.api#xmlName": "referencingVpcId" - } - }, - "VpcPeeringConnectionId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", - "smithy.api#documentation": "

The ID of the VPC peering connection.

", - "smithy.api#xmlName": "vpcPeeringConnectionId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a VPC with a security group that references your security group.

" - } - }, - "com.amazonaws.ec2#SecurityGroupReferences": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SecurityGroupReference", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#SecurityGroupRule": { - "type": "structure", - "members": { - "SecurityGroupRuleId": { - "target": "com.amazonaws.ec2#SecurityGroupRuleId", - "traits": { - "aws.protocols#ec2QueryName": "SecurityGroupRuleId", - "smithy.api#documentation": "

The ID of the security group rule.

", - "smithy.api#xmlName": "securityGroupRuleId" - } - }, - "GroupId": { - "target": "com.amazonaws.ec2#SecurityGroupId", - "traits": { - "aws.protocols#ec2QueryName": "GroupId", - "smithy.api#documentation": "

The ID of the security group.

", - "smithy.api#xmlName": "groupId" - } - }, - "GroupOwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupOwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the security group.

", - "smithy.api#xmlName": "groupOwnerId" - } - }, - "IsEgress": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "IsEgress", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the security group rule is an outbound rule.

", - "smithy.api#xmlName": "isEgress" - } - }, - "IpProtocol": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "IpProtocol", - "smithy.api#documentation": "

The IP protocol name (tcp, udp, icmp,\n icmpv6) or number (see Protocol Numbers).

\n

Use -1 to specify all protocols.

", - "smithy.api#xmlName": "ipProtocol" - } - }, - "FromPort": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "FromPort", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

If the protocol is TCP or UDP, this is the start of the port range.\n If the protocol is ICMP or ICMPv6, this is the type number. A value of -1 indicates all ICMP/ICMPv6 types. \n If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.

", - "smithy.api#xmlName": "fromPort" - } - }, - "ToPort": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "ToPort", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

If the protocol is TCP or UDP, this is the end of the port range.\n If the protocol is ICMP or ICMPv6, this is the type number. A value of -1 indicates all ICMP/ICMPv6 codes. \n If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.

", - "smithy.api#xmlName": "toPort" - } - }, - "CidrIpv4": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CidrIpv4", - "smithy.api#documentation": "

The IPv4 CIDR range.

", - "smithy.api#xmlName": "cidrIpv4" - } - }, - "CidrIpv6": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CidrIpv6", - "smithy.api#documentation": "

The IPv6 CIDR range.

", - "smithy.api#xmlName": "cidrIpv6" - } - }, - "PrefixListId": { - "target": "com.amazonaws.ec2#PrefixListResourceId", - "traits": { - "aws.protocols#ec2QueryName": "PrefixListId", - "smithy.api#documentation": "

The ID of the prefix list.

", - "smithy.api#xmlName": "prefixListId" - } - }, - "ReferencedGroupInfo": { - "target": "com.amazonaws.ec2#ReferencedSecurityGroup", - "traits": { - "aws.protocols#ec2QueryName": "ReferencedGroupInfo", - "smithy.api#documentation": "

Describes the security group that is referenced in the rule.

", - "smithy.api#xmlName": "referencedGroupInfo" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

The security group rule description.

", - "smithy.api#xmlName": "description" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags applied to the security group rule.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a security group rule.

" - } - }, - "com.amazonaws.ec2#SecurityGroupRuleDescription": { - "type": "structure", - "members": { - "SecurityGroupRuleId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The ID of the security group rule.

" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The description of the security group rule.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the description of a security group rule.

\n

You can use this when you want to update the security group rule description for either an inbound or outbound rule.

" - } - }, - "com.amazonaws.ec2#SecurityGroupRuleDescriptionList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SecurityGroupRuleDescription", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#SecurityGroupRuleId": { - "type": "string" - }, - "com.amazonaws.ec2#SecurityGroupRuleIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#SecurityGroupRuleList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SecurityGroupRule", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#SecurityGroupRuleRequest": { - "type": "structure", - "members": { - "IpProtocol": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The IP protocol name (tcp, udp, icmp,\n icmpv6) or number (see Protocol Numbers).

\n

Use -1 to specify all protocols.

" - } - }, - "FromPort": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

If the protocol is TCP or UDP, this is the start of the port range.\n If the protocol is ICMP or ICMPv6, this is the type number. A value of -1 indicates all ICMP/ICMPv6 types. \n If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.

" - } - }, - "ToPort": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

If the protocol is TCP or UDP, this is the end of the port range.\n If the protocol is ICMP or ICMPv6, this is the code. A value of -1 indicates all ICMP/ICMPv6 codes. \n If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.

" - } - }, - "CidrIpv4": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The IPv4 CIDR range. To specify a single IPv4 address, use the /32 prefix length.

" - } - }, - "CidrIpv6": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The IPv6 CIDR range. To specify a single IPv6 address, use the /128 prefix length.

" - } - }, - "PrefixListId": { - "target": "com.amazonaws.ec2#PrefixListResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the prefix list.

" - } - }, - "ReferencedGroupId": { - "target": "com.amazonaws.ec2#SecurityGroupId", - "traits": { - "smithy.api#documentation": "

The ID of the security group that is referenced in the security group rule.

" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The description of the security group rule.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a security group rule.

\n

You must specify exactly one of the following parameters, based on the rule type:

\n \n

When you modify a rule, you cannot change the rule type. For example, if the rule \n uses an IPv4 address range, you must use CidrIpv4 to specify a new IPv4 \n address range.

" - } - }, - "com.amazonaws.ec2#SecurityGroupRuleUpdate": { - "type": "structure", - "members": { - "SecurityGroupRuleId": { - "target": "com.amazonaws.ec2#SecurityGroupRuleId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the security group rule.

", - "smithy.api#required": {} - } - }, - "SecurityGroupRule": { - "target": "com.amazonaws.ec2#SecurityGroupRuleRequest", - "traits": { - "smithy.api#documentation": "

Information about the security group rule.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an update to a security group rule.

" - } - }, - "com.amazonaws.ec2#SecurityGroupRuleUpdateList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SecurityGroupRuleUpdate", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#SecurityGroupStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SecurityGroupName", - "traits": { - "smithy.api#xmlName": "SecurityGroup" - } - } - }, - "com.amazonaws.ec2#SelfServicePortal": { - "type": "enum", - "members": { - "enabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enabled" - } - }, - "disabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disabled" - } - } - } - }, - "com.amazonaws.ec2#SendDiagnosticInterrupt": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#SendDiagnosticInterruptRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a\n kernel panic (on Linux instances), or a blue\n screen/stop error (on Windows instances). For\n instances based on Intel and AMD processors, the interrupt is received as a\n non-maskable interrupt (NMI).

\n

In general, the operating system crashes and reboots when a kernel panic or stop error\n is triggered. The operating system can also be configured to perform diagnostic tasks,\n such as generating a memory dump file, loading a secondary kernel, or obtaining a call\n trace.

\n

Before sending a diagnostic interrupt to your instance, ensure that its operating\n system is configured to perform the required diagnostic tasks.

\n

For more information about configuring your operating system to generate a crash dump\n when a kernel panic or stop error occurs, see Send a diagnostic interrupt\n (for advanced users) (Linux instances) or Send a diagnostic\n interrupt (for advanced users) (Windows instances).

" - } - }, - "com.amazonaws.ec2#SendDiagnosticInterruptRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#SensitiveUrl": { - "type": "string", - "traits": { - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.ec2#SensitiveUserData": { - "type": "string", - "traits": { - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.ec2#ServiceConfiguration": { - "type": "structure", - "members": { - "ServiceType": { - "target": "com.amazonaws.ec2#ServiceTypeDetailSet", - "traits": { - "aws.protocols#ec2QueryName": "ServiceType", - "smithy.api#documentation": "

The type of service.

", - "smithy.api#xmlName": "serviceType" - } - }, - "ServiceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ServiceId", - "smithy.api#documentation": "

The ID of the service.

", - "smithy.api#xmlName": "serviceId" - } - }, - "ServiceName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ServiceName", - "smithy.api#documentation": "

The name of the service.

", - "smithy.api#xmlName": "serviceName" - } - }, - "ServiceState": { - "target": "com.amazonaws.ec2#ServiceState", - "traits": { - "aws.protocols#ec2QueryName": "ServiceState", - "smithy.api#documentation": "

The service state.

", - "smithy.api#xmlName": "serviceState" - } - }, - "AvailabilityZones": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZoneSet", - "smithy.api#documentation": "

The Availability Zones in which the service is available.

", - "smithy.api#xmlName": "availabilityZoneSet" - } - }, - "AcceptanceRequired": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "AcceptanceRequired", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether requests from other Amazon Web Services accounts to create an endpoint to the service must first be accepted.

", - "smithy.api#xmlName": "acceptanceRequired" - } - }, - "ManagesVpcEndpoints": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "ManagesVpcEndpoints", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the service manages its VPC endpoints. Management of the service VPC\n endpoints using the VPC endpoint API is restricted.

", - "smithy.api#xmlName": "managesVpcEndpoints" - } - }, - "NetworkLoadBalancerArns": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "NetworkLoadBalancerArnSet", - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the Network Load Balancers for the service.

", - "smithy.api#xmlName": "networkLoadBalancerArnSet" - } - }, - "GatewayLoadBalancerArns": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "GatewayLoadBalancerArnSet", - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.

", - "smithy.api#xmlName": "gatewayLoadBalancerArnSet" - } - }, - "SupportedIpAddressTypes": { - "target": "com.amazonaws.ec2#SupportedIpAddressTypes", - "traits": { - "aws.protocols#ec2QueryName": "SupportedIpAddressTypeSet", - "smithy.api#documentation": "

The supported IP address types.

", - "smithy.api#xmlName": "supportedIpAddressTypeSet" - } - }, - "BaseEndpointDnsNames": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "BaseEndpointDnsNameSet", - "smithy.api#documentation": "

The DNS names for the service.

", - "smithy.api#xmlName": "baseEndpointDnsNameSet" - } - }, - "PrivateDnsName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrivateDnsName", - "smithy.api#documentation": "

The private DNS name for the service.

", - "smithy.api#xmlName": "privateDnsName" - } - }, - "PrivateDnsNameConfiguration": { - "target": "com.amazonaws.ec2#PrivateDnsNameConfiguration", - "traits": { - "aws.protocols#ec2QueryName": "PrivateDnsNameConfiguration", - "smithy.api#documentation": "

Information about the endpoint service private DNS name configuration.

", - "smithy.api#xmlName": "privateDnsNameConfiguration" - } - }, - "PayerResponsibility": { - "target": "com.amazonaws.ec2#PayerResponsibility", - "traits": { - "aws.protocols#ec2QueryName": "PayerResponsibility", - "smithy.api#documentation": "

The payer responsibility.

", - "smithy.api#xmlName": "payerResponsibility" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags assigned to the service.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a service configuration for a VPC endpoint service.

" - } - }, - "com.amazonaws.ec2#ServiceConfigurationSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ServiceConfiguration", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ServiceConnectivityType": { - "type": "enum", - "members": { - "ipv4": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ipv4" - } - }, - "ipv6": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ipv6" - } - } - } - }, - "com.amazonaws.ec2#ServiceDetail": { - "type": "structure", - "members": { - "ServiceName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ServiceName", - "smithy.api#documentation": "

The name of the service.

", - "smithy.api#xmlName": "serviceName" - } - }, - "ServiceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ServiceId", - "smithy.api#documentation": "

The ID of the endpoint service.

", - "smithy.api#xmlName": "serviceId" - } - }, - "ServiceType": { - "target": "com.amazonaws.ec2#ServiceTypeDetailSet", - "traits": { - "aws.protocols#ec2QueryName": "ServiceType", - "smithy.api#documentation": "

The type of service.

", - "smithy.api#xmlName": "serviceType" - } - }, - "AvailabilityZones": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZoneSet", - "smithy.api#documentation": "

The Availability Zones in which the service is available.

", - "smithy.api#xmlName": "availabilityZoneSet" - } - }, - "Owner": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Owner", - "smithy.api#documentation": "

The Amazon Web Services account ID of the service owner.

", - "smithy.api#xmlName": "owner" - } - }, - "BaseEndpointDnsNames": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "BaseEndpointDnsNameSet", - "smithy.api#documentation": "

The DNS names for the service.

", - "smithy.api#xmlName": "baseEndpointDnsNameSet" - } - }, - "PrivateDnsName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrivateDnsName", - "smithy.api#documentation": "

The private DNS name for the service.

", - "smithy.api#xmlName": "privateDnsName" - } - }, - "PrivateDnsNames": { - "target": "com.amazonaws.ec2#PrivateDnsDetailsSet", - "traits": { - "aws.protocols#ec2QueryName": "PrivateDnsNameSet", - "smithy.api#documentation": "

The private DNS names assigned to the VPC endpoint service.

", - "smithy.api#xmlName": "privateDnsNameSet" - } - }, - "VpcEndpointPolicySupported": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "VpcEndpointPolicySupported", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the service supports endpoint policies.

", - "smithy.api#xmlName": "vpcEndpointPolicySupported" - } - }, - "AcceptanceRequired": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "AcceptanceRequired", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether VPC endpoint connection requests to the service must be accepted by the service owner.

", - "smithy.api#xmlName": "acceptanceRequired" - } - }, - "ManagesVpcEndpoints": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "ManagesVpcEndpoints", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the service manages its VPC endpoints. Management of the service VPC\n endpoints using the VPC endpoint API is restricted.

", - "smithy.api#xmlName": "managesVpcEndpoints" - } - }, - "PayerResponsibility": { - "target": "com.amazonaws.ec2#PayerResponsibility", - "traits": { - "aws.protocols#ec2QueryName": "PayerResponsibility", - "smithy.api#documentation": "

The payer responsibility.

", - "smithy.api#xmlName": "payerResponsibility" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags assigned to the service.

", - "smithy.api#xmlName": "tagSet" - } - }, - "PrivateDnsNameVerificationState": { - "target": "com.amazonaws.ec2#DnsNameState", - "traits": { - "aws.protocols#ec2QueryName": "PrivateDnsNameVerificationState", - "smithy.api#documentation": "

The verification state of the VPC endpoint service.

\n

Consumers of the endpoint service cannot use the private name when the state is not verified.

", - "smithy.api#xmlName": "privateDnsNameVerificationState" - } - }, - "SupportedIpAddressTypes": { - "target": "com.amazonaws.ec2#SupportedIpAddressTypes", - "traits": { - "aws.protocols#ec2QueryName": "SupportedIpAddressTypeSet", - "smithy.api#documentation": "

The supported IP address types.

", - "smithy.api#xmlName": "supportedIpAddressTypeSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a VPC endpoint service.

" - } - }, - "com.amazonaws.ec2#ServiceDetailSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ServiceDetail", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ServiceState": { - "type": "enum", - "members": { - "Pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Pending" - } - }, - "Available": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Available" - } - }, - "Deleting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deleting" - } - }, - "Deleted": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deleted" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - } - } - }, - "com.amazonaws.ec2#ServiceType": { - "type": "enum", - "members": { - "Interface": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Interface" - } - }, - "Gateway": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Gateway" - } - }, - "GatewayLoadBalancer": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GatewayLoadBalancer" - } - } - } - }, - "com.amazonaws.ec2#ServiceTypeDetail": { - "type": "structure", - "members": { - "ServiceType": { - "target": "com.amazonaws.ec2#ServiceType", - "traits": { - "aws.protocols#ec2QueryName": "ServiceType", - "smithy.api#documentation": "

The type of service.

", - "smithy.api#xmlName": "serviceType" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the type of service for a VPC endpoint.

" - } - }, - "com.amazonaws.ec2#ServiceTypeDetailSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ServiceTypeDetail", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ShutdownBehavior": { - "type": "enum", - "members": { - "stop": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "stop" - } - }, - "terminate": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "terminate" - } - } - } - }, - "com.amazonaws.ec2#SlotDateTimeRangeRequest": { - "type": "structure", - "members": { - "EarliestTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The earliest date and time, in UTC, for the Scheduled Instance to start.

", - "smithy.api#required": {} - } - }, - "LatestTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#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.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the time period for a Scheduled Instance to start its first schedule. The time period must span less than one day.

" - } - }, - "com.amazonaws.ec2#SlotStartTimeRangeRequest": { - "type": "structure", - "members": { - "EarliestTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "smithy.api#documentation": "

The earliest date and time, in UTC, for the Scheduled Instance to start.

" - } - }, - "LatestTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "smithy.api#documentation": "

The latest date and time, in UTC, for the Scheduled Instance to start.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the time period for a Scheduled Instance to start its first schedule.

" - } - }, - "com.amazonaws.ec2#Snapshot": { - "type": "structure", - "members": { - "DataEncryptionKeyId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DataEncryptionKeyId", - "smithy.api#documentation": "

The data encryption key identifier for the snapshot. This value is a unique identifier\n that corresponds to the data encryption key that was used to encrypt the original volume or\n snapshot copy. Because data encryption keys are inherited by volumes created from snapshots,\n and vice versa, if snapshots share the same data encryption key identifier, then they belong\n to the same volume/snapshot lineage. This parameter is only returned by DescribeSnapshots.

", - "smithy.api#xmlName": "dataEncryptionKeyId" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

The description for the snapshot.

", - "smithy.api#xmlName": "description" - } - }, - "Encrypted": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Encrypted", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the snapshot is encrypted.

", - "smithy.api#xmlName": "encrypted" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "KmsKeyId", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the\n volume encryption key for the parent volume.

", - "smithy.api#xmlName": "kmsKeyId" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the EBS snapshot.

", - "smithy.api#xmlName": "ownerId" - } - }, - "Progress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Progress", - "smithy.api#documentation": "

The progress of the snapshot, as a percentage.

", - "smithy.api#xmlName": "progress" - } - }, - "SnapshotId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SnapshotId", - "smithy.api#documentation": "

The ID of the snapshot. Each snapshot receives a unique identifier when it is\n created.

", - "smithy.api#xmlName": "snapshotId" - } - }, - "StartTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "StartTime", - "smithy.api#documentation": "

The time stamp when the snapshot was initiated.

", - "smithy.api#xmlName": "startTime" - } - }, - "State": { - "target": "com.amazonaws.ec2#SnapshotState", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The snapshot state.

", - "smithy.api#xmlName": "status" - } - }, - "StateMessage": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StatusMessage", - "smithy.api#documentation": "

Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails\n (for example, if the proper Key Management Service (KMS) permissions are not obtained) this field displays error\n state details to help you diagnose why the error occurred. This parameter is only returned by\n DescribeSnapshots.

", - "smithy.api#xmlName": "statusMessage" - } - }, - "VolumeId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VolumeId", - "smithy.api#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\n purpose.

", - "smithy.api#xmlName": "volumeId" - } - }, - "VolumeSize": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "VolumeSize", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The size of the volume, in GiB.

", - "smithy.api#xmlName": "volumeSize" - } - }, - "OwnerAlias": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerAlias", - "smithy.api#documentation": "

The Amazon Web Services owner alias, from an Amazon-maintained list (amazon). This is not \n the user-configured Amazon Web Services account alias set using the IAM console.

", - "smithy.api#xmlName": "ownerAlias" - } - }, - "OutpostArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OutpostArn", - "smithy.api#documentation": "

The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the \n \t\tAmazon Elastic Compute Cloud User Guide.

", - "smithy.api#xmlName": "outpostArn" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the snapshot.

", - "smithy.api#xmlName": "tagSet" - } - }, - "StorageTier": { - "target": "com.amazonaws.ec2#StorageTier", - "traits": { - "aws.protocols#ec2QueryName": "StorageTier", - "smithy.api#documentation": "

The storage tier in which the snapshot is stored. standard indicates \n that the snapshot is stored in the standard snapshot storage tier and that it is ready \n for use. archive indicates that the snapshot is currently archived and that \n it must be restored before it can be used.

", - "smithy.api#xmlName": "storageTier" - } - }, - "RestoreExpiryTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "RestoreExpiryTime", - "smithy.api#documentation": "

Only for archived snapshots that are temporarily restored. Indicates the date and \n time when a temporarily restored snapshot will be automatically re-archived.

", - "smithy.api#xmlName": "restoreExpiryTime" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a snapshot.

" - } - }, - "com.amazonaws.ec2#SnapshotAttributeName": { - "type": "enum", - "members": { - "productCodes": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "productCodes" - } - }, - "createVolumePermission": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "createVolumePermission" - } - } - } - }, - "com.amazonaws.ec2#SnapshotDetail": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description for the snapshot.

", - "smithy.api#xmlName": "description" - } - }, - "DeviceName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DeviceName", - "smithy.api#documentation": "

The block device mapping for the snapshot.

", - "smithy.api#xmlName": "deviceName" - } - }, - "DiskImageSize": { - "target": "com.amazonaws.ec2#Double", - "traits": { - "aws.protocols#ec2QueryName": "DiskImageSize", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The size of the disk in the snapshot, in GiB.

", - "smithy.api#xmlName": "diskImageSize" - } - }, - "Format": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Format", - "smithy.api#documentation": "

The format of the disk image from which the snapshot is created.

", - "smithy.api#xmlName": "format" - } - }, - "Progress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Progress", - "smithy.api#documentation": "

The percentage of progress for the task.

", - "smithy.api#xmlName": "progress" - } - }, - "SnapshotId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SnapshotId", - "smithy.api#documentation": "

The snapshot ID of the disk being imported.

", - "smithy.api#xmlName": "snapshotId" - } - }, - "Status": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

A brief status of the snapshot creation.

", - "smithy.api#xmlName": "status" - } - }, - "StatusMessage": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StatusMessage", - "smithy.api#documentation": "

A detailed status message for the snapshot creation.

", - "smithy.api#xmlName": "statusMessage" - } - }, - "Url": { - "target": "com.amazonaws.ec2#SensitiveUrl", - "traits": { - "aws.protocols#ec2QueryName": "Url", - "smithy.api#documentation": "

The URL used to access the disk image.

", - "smithy.api#xmlName": "url" - } - }, - "UserBucket": { - "target": "com.amazonaws.ec2#UserBucketDetails", - "traits": { - "aws.protocols#ec2QueryName": "UserBucket", - "smithy.api#documentation": "

The Amazon S3 bucket for the disk image.

", - "smithy.api#xmlName": "userBucket" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the snapshot created from the imported disk.

" - } - }, - "com.amazonaws.ec2#SnapshotDetailList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SnapshotDetail", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#SnapshotDiskContainer": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The description of the disk image being imported.

" - } - }, - "Format": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The format of the disk image being imported.

\n

Valid values: VHD | VMDK | RAW\n

" - } - }, - "Url": { - "target": "com.amazonaws.ec2#SensitiveUrl", - "traits": { - "smithy.api#documentation": "

The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon\n S3 URL (s3://..).

" - } - }, - "UserBucket": { - "target": "com.amazonaws.ec2#UserBucket", - "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket for the disk image.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The disk container object for the import snapshot request.

" - } - }, - "com.amazonaws.ec2#SnapshotId": { - "type": "string" - }, - "com.amazonaws.ec2#SnapshotIdStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SnapshotId", - "traits": { - "smithy.api#xmlName": "SnapshotId" - } - } - }, - "com.amazonaws.ec2#SnapshotInfo": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

Description specified by the CreateSnapshotRequest that has been applied to all \n snapshots.

", - "smithy.api#xmlName": "description" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Tags associated with this snapshot.

", - "smithy.api#xmlName": "tagSet" - } - }, - "Encrypted": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Encrypted", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the snapshot is encrypted.

", - "smithy.api#xmlName": "encrypted" - } - }, - "VolumeId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VolumeId", - "smithy.api#documentation": "

Source volume from which this snapshot was created.

", - "smithy.api#xmlName": "volumeId" - } - }, - "State": { - "target": "com.amazonaws.ec2#SnapshotState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

Current state of the snapshot.

", - "smithy.api#xmlName": "state" - } - }, - "VolumeSize": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "VolumeSize", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

Size of the volume from which this snapshot was created.

", - "smithy.api#xmlName": "volumeSize" - } - }, - "StartTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "StartTime", - "smithy.api#documentation": "

Time this snapshot was started. This is the same for all snapshots initiated by the\n same request.

", - "smithy.api#xmlName": "startTime" - } - }, - "Progress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Progress", - "smithy.api#documentation": "

Progress this snapshot has made towards completing.

", - "smithy.api#xmlName": "progress" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

Account id used when creating this snapshot.

", - "smithy.api#xmlName": "ownerId" - } - }, - "SnapshotId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SnapshotId", - "smithy.api#documentation": "

Snapshot id that can be used to describe this snapshot.

", - "smithy.api#xmlName": "snapshotId" - } - }, - "OutpostArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OutpostArn", - "smithy.api#documentation": "

The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the \n \t\tAmazon Elastic Compute Cloud User Guide.

", - "smithy.api#xmlName": "outpostArn" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a snapshot.

" - } - }, - "com.amazonaws.ec2#SnapshotList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Snapshot", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#SnapshotRecycleBinInfo": { - "type": "structure", - "members": { - "SnapshotId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SnapshotId", - "smithy.api#documentation": "

The ID of the snapshot.

", - "smithy.api#xmlName": "snapshotId" - } - }, - "RecycleBinEnterTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "RecycleBinEnterTime", - "smithy.api#documentation": "

The date and time when the snaphsot entered the Recycle Bin.

", - "smithy.api#xmlName": "recycleBinEnterTime" - } - }, - "RecycleBinExitTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "RecycleBinExitTime", - "smithy.api#documentation": "

The date and time when the snapshot is to be permanently deleted from the Recycle Bin.

", - "smithy.api#xmlName": "recycleBinExitTime" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

The description for the snapshot.

", - "smithy.api#xmlName": "description" - } - }, - "VolumeId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VolumeId", - "smithy.api#documentation": "

The ID of the volume from which the snapshot was created.

", - "smithy.api#xmlName": "volumeId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a snapshot that is currently in the Recycle Bin.

" - } - }, - "com.amazonaws.ec2#SnapshotRecycleBinInfoList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SnapshotRecycleBinInfo", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#SnapshotSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SnapshotInfo", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#SnapshotState": { - "type": "enum", - "members": { - "pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "completed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "completed" - } - }, - "error": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "error" - } - }, - "recoverable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "recoverable" - } - }, - "recovering": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "recovering" - } - } - } - }, - "com.amazonaws.ec2#SnapshotTaskDetail": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

The description of the snapshot.

", - "smithy.api#xmlName": "description" - } - }, - "DiskImageSize": { - "target": "com.amazonaws.ec2#Double", - "traits": { - "aws.protocols#ec2QueryName": "DiskImageSize", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The size of the disk in the snapshot, in GiB.

", - "smithy.api#xmlName": "diskImageSize" - } - }, - "Encrypted": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Encrypted", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the snapshot is encrypted.

", - "smithy.api#xmlName": "encrypted" - } - }, - "Format": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Format", - "smithy.api#documentation": "

The format of the disk image from which the snapshot is created.

", - "smithy.api#xmlName": "format" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "KmsKeyId", - "smithy.api#documentation": "

The identifier for the KMS key that was used to create the encrypted snapshot.

", - "smithy.api#xmlName": "kmsKeyId" - } - }, - "Progress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Progress", - "smithy.api#documentation": "

The percentage of completion for the import snapshot task.

", - "smithy.api#xmlName": "progress" - } - }, - "SnapshotId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SnapshotId", - "smithy.api#documentation": "

The snapshot ID of the disk being imported.

", - "smithy.api#xmlName": "snapshotId" - } - }, - "Status": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

A brief status for the import snapshot task.

", - "smithy.api#xmlName": "status" - } - }, - "StatusMessage": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StatusMessage", - "smithy.api#documentation": "

A detailed status message for the import snapshot task.

", - "smithy.api#xmlName": "statusMessage" - } - }, - "Url": { - "target": "com.amazonaws.ec2#SensitiveUrl", - "traits": { - "aws.protocols#ec2QueryName": "Url", - "smithy.api#documentation": "

The URL of the disk image from which the snapshot is created.

", - "smithy.api#xmlName": "url" - } - }, - "UserBucket": { - "target": "com.amazonaws.ec2#UserBucketDetails", - "traits": { - "aws.protocols#ec2QueryName": "UserBucket", - "smithy.api#documentation": "

The Amazon S3 bucket for the disk image.

", - "smithy.api#xmlName": "userBucket" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about the import snapshot task.

" - } - }, - "com.amazonaws.ec2#SnapshotTierStatus": { - "type": "structure", - "members": { - "SnapshotId": { - "target": "com.amazonaws.ec2#SnapshotId", - "traits": { - "aws.protocols#ec2QueryName": "SnapshotId", - "smithy.api#documentation": "

The ID of the snapshot.

", - "smithy.api#xmlName": "snapshotId" - } - }, - "VolumeId": { - "target": "com.amazonaws.ec2#VolumeId", - "traits": { - "aws.protocols#ec2QueryName": "VolumeId", - "smithy.api#documentation": "

The ID of the volume from which the snapshot was created.

", - "smithy.api#xmlName": "volumeId" - } - }, - "Status": { - "target": "com.amazonaws.ec2#SnapshotState", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The state of the snapshot.

", - "smithy.api#xmlName": "status" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the snapshot.

", - "smithy.api#xmlName": "ownerId" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags that are assigned to the snapshot.

", - "smithy.api#xmlName": "tagSet" - } - }, - "StorageTier": { - "target": "com.amazonaws.ec2#StorageTier", - "traits": { - "aws.protocols#ec2QueryName": "StorageTier", - "smithy.api#documentation": "

The storage tier in which the snapshot is stored. standard indicates \n that the snapshot is stored in the standard snapshot storage tier and that it is ready \n for use. archive indicates that the snapshot is currently archived and that \n it must be restored before it can be used.

", - "smithy.api#xmlName": "storageTier" - } - }, - "LastTieringStartTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "LastTieringStartTime", - "smithy.api#documentation": "

The date and time when the last archive or restore process was started.

", - "smithy.api#xmlName": "lastTieringStartTime" - } - }, - "LastTieringProgress": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "LastTieringProgress", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The progress of the last archive or restore process, as a percentage.

", - "smithy.api#xmlName": "lastTieringProgress" - } - }, - "LastTieringOperationStatus": { - "target": "com.amazonaws.ec2#TieringOperationStatus", - "traits": { - "aws.protocols#ec2QueryName": "LastTieringOperationStatus", - "smithy.api#documentation": "

The status of the last archive or restore process.

", - "smithy.api#xmlName": "lastTieringOperationStatus" - } - }, - "LastTieringOperationStatusDetail": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LastTieringOperationStatusDetail", - "smithy.api#documentation": "

A message describing the status of the last archive or restore process.

", - "smithy.api#xmlName": "lastTieringOperationStatusDetail" - } - }, - "ArchivalCompleteTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "ArchivalCompleteTime", - "smithy.api#documentation": "

The date and time when the last archive process was completed.

", - "smithy.api#xmlName": "archivalCompleteTime" - } - }, - "RestoreExpiryTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "RestoreExpiryTime", - "smithy.api#documentation": "

Only for archived snapshots that are temporarily restored. Indicates the date and \n time when a temporarily restored snapshot will be automatically re-archived.

", - "smithy.api#xmlName": "restoreExpiryTime" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about a snapshot's storage tier.

" - } - }, - "com.amazonaws.ec2#SpotAllocationStrategy": { - "type": "enum", - "members": { - "LOWEST_PRICE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "lowest-price" - } - }, - "DIVERSIFIED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "diversified" - } - }, - "CAPACITY_OPTIMIZED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "capacity-optimized" - } - }, - "CAPACITY_OPTIMIZED_PRIORITIZED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "capacity-optimized-prioritized" - } - }, - "PRICE_CAPACITY_OPTIMIZED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "price-capacity-optimized" - } - } - } - }, - "com.amazonaws.ec2#SpotCapacityRebalance": { - "type": "structure", - "members": { - "ReplacementStrategy": { - "target": "com.amazonaws.ec2#ReplacementStrategy", - "traits": { - "aws.protocols#ec2QueryName": "ReplacementStrategy", - "smithy.api#documentation": "

The replacement strategy to use. Only available for fleets of type\n maintain.

\n

\n launch - Spot Fleet launches a new replacement Spot Instance when a\n rebalance notification is emitted for an existing Spot Instance in the fleet. Spot Fleet\n does not terminate the instances that receive a rebalance notification. You can\n terminate the old instances, or you can leave them running. You are charged for all\n instances while they are running.

\n

\n launch-before-terminate - Spot Fleet launches a new replacement Spot\n Instance when a rebalance notification is emitted for an existing Spot Instance in the\n fleet, and then, after a delay that you specify (in TerminationDelay),\n terminates the instances that received a rebalance notification.

", - "smithy.api#xmlName": "replacementStrategy" - } - }, - "TerminationDelay": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "TerminationDelay", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot\n Instance after launching a new replacement Spot Instance.

\n

Required when ReplacementStrategy is set to launch-before-terminate.

\n

Not valid when ReplacementStrategy is set to launch.

\n

Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.

", - "smithy.api#xmlName": "terminationDelay" - } - } - }, - "traits": { - "smithy.api#documentation": "

The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your\n Spot Instance is at an elevated risk of being interrupted. For more information, see\n Capacity rebalancing in the Amazon EC2 User Guide for Linux Instances.

" - } - }, - "com.amazonaws.ec2#SpotDatafeedSubscription": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Bucket", - "smithy.api#documentation": "

The name of the Amazon S3 bucket where the Spot Instance data feed is located.

", - "smithy.api#xmlName": "bucket" - } - }, - "Fault": { - "target": "com.amazonaws.ec2#SpotInstanceStateFault", - "traits": { - "aws.protocols#ec2QueryName": "Fault", - "smithy.api#documentation": "

The fault codes for the Spot Instance request, if any.

", - "smithy.api#xmlName": "fault" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The Amazon Web Services account ID of the account.

", - "smithy.api#xmlName": "ownerId" - } - }, - "Prefix": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Prefix", - "smithy.api#documentation": "

The prefix for the data feed files.

", - "smithy.api#xmlName": "prefix" - } - }, - "State": { - "target": "com.amazonaws.ec2#DatafeedSubscriptionState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the Spot Instance data feed subscription.

", - "smithy.api#xmlName": "state" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the data feed for a Spot Instance.

" - } - }, - "com.amazonaws.ec2#SpotFleetLaunchSpecification": { - "type": "structure", - "members": { - "SecurityGroups": { - "target": "com.amazonaws.ec2#GroupIdentifierList", - "traits": { - "aws.protocols#ec2QueryName": "GroupSet", - "smithy.api#documentation": "

The security groups.

", - "smithy.api#xmlName": "groupSet" - } - }, - "AddressingType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AddressingType", - "smithy.api#documentation": "

Deprecated.

", - "smithy.api#xmlName": "addressingType" - } - }, - "BlockDeviceMappings": { - "target": "com.amazonaws.ec2#BlockDeviceMappingList", - "traits": { - "aws.protocols#ec2QueryName": "BlockDeviceMapping", - "smithy.api#documentation": "

One or more block devices that are mapped to the Spot Instances. You can't specify both\n a snapshot ID and an encryption value. This is because only blank volumes can be\n encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its\n encryption status is used for the volume encryption status.

", - "smithy.api#xmlName": "blockDeviceMapping" - } - }, - "EbsOptimized": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "EbsOptimized", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#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.

\n

Default: false\n

", - "smithy.api#xmlName": "ebsOptimized" - } - }, - "IamInstanceProfile": { - "target": "com.amazonaws.ec2#IamInstanceProfileSpecification", - "traits": { - "aws.protocols#ec2QueryName": "IamInstanceProfile", - "smithy.api#documentation": "

The IAM instance profile.

", - "smithy.api#xmlName": "iamInstanceProfile" - } - }, - "ImageId": { - "target": "com.amazonaws.ec2#ImageId", - "traits": { - "aws.protocols#ec2QueryName": "ImageId", - "smithy.api#documentation": "

The ID of the AMI.

", - "smithy.api#xmlName": "imageId" - } - }, - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type.

", - "smithy.api#xmlName": "instanceType" - } - }, - "KernelId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "KernelId", - "smithy.api#documentation": "

The ID of the kernel.

", - "smithy.api#xmlName": "kernelId" - } - }, - "KeyName": { - "target": "com.amazonaws.ec2#KeyPairName", - "traits": { - "aws.protocols#ec2QueryName": "KeyName", - "smithy.api#documentation": "

The name of the key pair.

", - "smithy.api#xmlName": "keyName" - } - }, - "Monitoring": { - "target": "com.amazonaws.ec2#SpotFleetMonitoring", - "traits": { - "aws.protocols#ec2QueryName": "Monitoring", - "smithy.api#documentation": "

Enable or disable monitoring for the instances.

", - "smithy.api#xmlName": "monitoring" - } - }, - "NetworkInterfaces": { - "target": "com.amazonaws.ec2#InstanceNetworkInterfaceSpecificationList", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceSet", - "smithy.api#documentation": "

One or more network interfaces. If you specify a network interface, you must specify \n subnet IDs and security group IDs using the network interface.

\n \n

\n SpotFleetLaunchSpecification currently does not support Elastic Fabric Adapter (EFA). To specify an EFA, you must use LaunchTemplateConfig.

\n ", - "smithy.api#xmlName": "networkInterfaceSet" - } - }, - "Placement": { - "target": "com.amazonaws.ec2#SpotPlacement", - "traits": { - "aws.protocols#ec2QueryName": "Placement", - "smithy.api#documentation": "

The placement information.

", - "smithy.api#xmlName": "placement" - } - }, - "RamdiskId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "RamdiskId", - "smithy.api#documentation": "

The ID of the RAM disk. Some kernels require additional drivers at launch. Check the kernel \n requirements for information about whether you need to specify a RAM disk. To find kernel \n requirements, refer to the Amazon Web Services Resource Center and search for the kernel ID.

", - "smithy.api#xmlName": "ramdiskId" - } - }, - "SpotPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SpotPrice", - "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to \n increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n ", - "smithy.api#xmlName": "spotPrice" - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#SubnetId", - "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#documentation": "

The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate\n them using commas; for example, \"subnet-1234abcdeexample1, subnet-0987cdef6example2\".

", - "smithy.api#xmlName": "subnetId" - } - }, - "UserData": { - "target": "com.amazonaws.ec2#SensitiveUserData", - "traits": { - "aws.protocols#ec2QueryName": "UserData", - "smithy.api#documentation": "

The base64-encoded user data that instances use when starting up. User data is limited to 16 KB.

", - "smithy.api#xmlName": "userData" - } - }, - "WeightedCapacity": { - "target": "com.amazonaws.ec2#Double", - "traits": { - "aws.protocols#ec2QueryName": "WeightedCapacity", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#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.

\n

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.

", - "smithy.api#xmlName": "weightedCapacity" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#SpotFleetTagSpecificationList", - "traits": { - "aws.protocols#ec2QueryName": "TagSpecificationSet", - "smithy.api#documentation": "

The tags to apply during creation.

", - "smithy.api#xmlName": "tagSpecificationSet" - } - }, - "InstanceRequirements": { - "target": "com.amazonaws.ec2#InstanceRequirements", - "traits": { - "aws.protocols#ec2QueryName": "InstanceRequirements", - "smithy.api#documentation": "

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with those attributes.

\n \n

If you specify InstanceRequirements, you can't specify\n InstanceType.

\n ", - "smithy.api#xmlName": "instanceRequirements" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the launch specification for one or more Spot Instances. If you include\n On-Demand capacity in your fleet request or want to specify an EFA network device, you\n can't use SpotFleetLaunchSpecification; you must use LaunchTemplateConfig.

" - } - }, - "com.amazonaws.ec2#SpotFleetMonitoring": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Enabled", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Enables monitoring for the instance.

\n

Default: false\n

", - "smithy.api#xmlName": "enabled" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes whether monitoring is enabled.

" - } - }, - "com.amazonaws.ec2#SpotFleetRequestConfig": { - "type": "structure", - "members": { - "ActivityStatus": { - "target": "com.amazonaws.ec2#ActivityStatus", - "traits": { - "aws.protocols#ec2QueryName": "ActivityStatus", - "smithy.api#documentation": "

The progress of the Spot Fleet request. \n If there is an error, the status is error.\n After all requests are placed, the status is pending_fulfillment.\n If the size of the fleet is equal to or greater than its target capacity, the status is fulfilled.\n If the size of the fleet is decreased, the status is pending_termination\n while Spot Instances are terminating.

", - "smithy.api#xmlName": "activityStatus" - } - }, - "CreateTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "CreateTime", - "smithy.api#documentation": "

The creation date and time of the request.

", - "smithy.api#xmlName": "createTime" - } - }, - "SpotFleetRequestConfig": { - "target": "com.amazonaws.ec2#SpotFleetRequestConfigData", - "traits": { - "aws.protocols#ec2QueryName": "SpotFleetRequestConfig", - "smithy.api#documentation": "

The configuration of the Spot Fleet request.

", - "smithy.api#xmlName": "spotFleetRequestConfig" - } - }, - "SpotFleetRequestId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SpotFleetRequestId", - "smithy.api#documentation": "

The ID of the Spot Fleet request.

", - "smithy.api#xmlName": "spotFleetRequestId" - } - }, - "SpotFleetRequestState": { - "target": "com.amazonaws.ec2#BatchState", - "traits": { - "aws.protocols#ec2QueryName": "SpotFleetRequestState", - "smithy.api#documentation": "

The state of the Spot Fleet request.

", - "smithy.api#xmlName": "spotFleetRequestState" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags for a Spot Fleet resource.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a Spot Fleet request.

" - } - }, - "com.amazonaws.ec2#SpotFleetRequestConfigData": { - "type": "structure", - "members": { - "AllocationStrategy": { - "target": "com.amazonaws.ec2#AllocationStrategy", - "traits": { - "aws.protocols#ec2QueryName": "AllocationStrategy", - "smithy.api#documentation": "

The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\n pools specified by the Spot Fleet launch configuration. For more information, see Allocation\n strategies for Spot Instances in the Amazon EC2 User Guide.

\n
\n
priceCapacityOptimized (recommended)
\n
\n

Spot Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. Spot Fleet then requests Spot Instances from the lowest priced of these pools.

\n
\n
capacityOptimized
\n
\n

Spot Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. To give certain\n instance types a higher chance of launching first, use\n capacityOptimizedPrioritized. Set a priority for each instance type by\n using the Priority parameter for LaunchTemplateOverrides. You can\n assign the same priority to different LaunchTemplateOverrides. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacityOptimizedPrioritized is supported only if your Spot Fleet uses a\n launch template. Note that if the OnDemandAllocationStrategy is set to\n prioritized, the same priority is applied when fulfilling On-Demand\n capacity.

\n
\n
diversified
\n
\n

Spot Fleet requests instances from all of the Spot Instance pools that you\n specify.

\n
\n
lowestPrice
\n
\n

Spot Fleet requests instances from the lowest priced Spot Instance pool that\n has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances\n come from the next lowest priced pool that has available capacity. If a pool runs out of\n capacity before fulfilling your desired capacity, Spot Fleet will continue to fulfill your\n request by drawing from the next lowest priced pool. To ensure that your desired capacity is\n met, you might receive Spot Instances from several pools. Because this strategy only considers instance \n price and not capacity availability, it might lead to high interruption rates.

\n
\n
\n

Default: lowestPrice\n

", - "smithy.api#xmlName": "allocationStrategy" - } - }, - "OnDemandAllocationStrategy": { - "target": "com.amazonaws.ec2#OnDemandAllocationStrategy", - "traits": { - "aws.protocols#ec2QueryName": "OnDemandAllocationStrategy", - "smithy.api#documentation": "

The order of the launch template overrides to use in fulfilling On-Demand capacity. If\n you specify lowestPrice, Spot Fleet uses price to determine the order, launching\n the lowest price first. If you specify prioritized, Spot Fleet uses the priority\n that you assign to each Spot Fleet launch template override, launching the highest priority\n first. If you do not specify a value, Spot Fleet defaults to lowestPrice.

", - "smithy.api#xmlName": "onDemandAllocationStrategy" - } - }, - "SpotMaintenanceStrategies": { - "target": "com.amazonaws.ec2#SpotMaintenanceStrategies", - "traits": { - "aws.protocols#ec2QueryName": "SpotMaintenanceStrategies", - "smithy.api#documentation": "

The strategies for managing your Spot Instances that are at an elevated risk of being\n interrupted.

", - "smithy.api#xmlName": "spotMaintenanceStrategies" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of your\n listings. This helps to avoid duplicate listings. For more information, see Ensuring Idempotency.

", - "smithy.api#xmlName": "clientToken" - } - }, - "ExcessCapacityTerminationPolicy": { - "target": "com.amazonaws.ec2#ExcessCapacityTerminationPolicy", - "traits": { - "aws.protocols#ec2QueryName": "ExcessCapacityTerminationPolicy", - "smithy.api#documentation": "

Indicates whether running instances should be terminated if you decrease the\n target capacity of the Spot Fleet request below the current size of the Spot Fleet.

\n

Supported only for fleets of type maintain.

", - "smithy.api#xmlName": "excessCapacityTerminationPolicy" - } - }, - "FulfilledCapacity": { - "target": "com.amazonaws.ec2#Double", - "traits": { - "aws.protocols#ec2QueryName": "FulfilledCapacity", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of units fulfilled by this request compared to the set target capacity. You\n cannot set this value.

", - "smithy.api#xmlName": "fulfilledCapacity" - } - }, - "OnDemandFulfilledCapacity": { - "target": "com.amazonaws.ec2#Double", - "traits": { - "aws.protocols#ec2QueryName": "OnDemandFulfilledCapacity", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of On-Demand units fulfilled by this request compared to the set target\n On-Demand capacity.

", - "smithy.api#xmlName": "onDemandFulfilledCapacity" - } - }, - "IamFleetRole": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "IamFleetRole", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that\n grants the Spot Fleet the permission to request, launch, terminate, and tag instances on\n your behalf. For more information, see Spot\n Fleet prerequisites in the Amazon EC2 User Guide. Spot Fleet\n can terminate Spot Instances on your behalf when you cancel its Spot Fleet request using\n CancelSpotFleetRequests or when the Spot Fleet request expires, if you set\n TerminateInstancesWithExpiration.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "iamFleetRole" - } - }, - "LaunchSpecifications": { - "target": "com.amazonaws.ec2#LaunchSpecsList", - "traits": { - "aws.protocols#ec2QueryName": "LaunchSpecifications", - "smithy.api#documentation": "

The launch specifications for the Spot Fleet request. If you specify\n LaunchSpecifications, you can't specify\n LaunchTemplateConfigs. If you include On-Demand capacity in your\n request, you must use LaunchTemplateConfigs.

", - "smithy.api#xmlName": "launchSpecifications" - } - }, - "LaunchTemplateConfigs": { - "target": "com.amazonaws.ec2#LaunchTemplateConfigList", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateConfigs", - "smithy.api#documentation": "

The launch template and overrides. If you specify LaunchTemplateConfigs,\n you can't specify LaunchSpecifications. If you include On-Demand capacity\n in your request, you must use LaunchTemplateConfigs.

", - "smithy.api#xmlName": "launchTemplateConfigs" - } - }, - "SpotPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SpotPrice", - "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend \n using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n ", - "smithy.api#xmlName": "spotPrice" - } - }, - "TargetCapacity": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "TargetCapacity", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of units to request for the Spot Fleet. You can choose to set the target\n capacity in terms of instances or a performance characteristic that is important to your\n application workload, such as vCPUs, memory, or I/O. If the request type is\n maintain, you can specify a target capacity of 0 and add capacity\n later.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "targetCapacity" - } - }, - "OnDemandTargetCapacity": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "OnDemandTargetCapacity", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of On-Demand units to request. You can choose to set the target capacity in\n terms of instances or a performance characteristic that is important to your application\n workload, such as vCPUs, memory, or I/O. If the request type is maintain,\n you can specify a target capacity of 0 and add capacity later.

", - "smithy.api#xmlName": "onDemandTargetCapacity" - } - }, - "OnDemandMaxTotalPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OnDemandMaxTotalPrice", - "smithy.api#documentation": "

The maximum amount per hour for On-Demand Instances that you're willing to pay. You\n can use the onDemandMaxTotalPrice parameter, the\n spotMaxTotalPrice parameter, or both parameters to ensure that your\n fleet cost does not exceed your budget. If you set a maximum price per hour for the\n On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the\n maximum amount you're willing to pay. When the maximum amount you're willing to pay is\n reached, the fleet stops launching instances even if it hasn’t met the target\n capacity.

", - "smithy.api#xmlName": "onDemandMaxTotalPrice" - } - }, - "SpotMaxTotalPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SpotMaxTotalPrice", - "smithy.api#documentation": "

The maximum amount per hour for Spot Instances that you're willing to pay. You can use\n the spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice\n parameter, or both parameters to ensure that your fleet cost does not exceed your\n budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request,\n Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay.\n When the maximum amount you're willing to pay is reached, the fleet stops launching\n instances even if it hasn’t met the target capacity.

", - "smithy.api#xmlName": "spotMaxTotalPrice" - } - }, - "TerminateInstancesWithExpiration": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "TerminateInstancesWithExpiration", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether running Spot Instances are terminated when the Spot Fleet request\n expires.

", - "smithy.api#xmlName": "terminateInstancesWithExpiration" - } - }, - "Type": { - "target": "com.amazonaws.ec2#FleetType", - "traits": { - "aws.protocols#ec2QueryName": "Type", - "smithy.api#documentation": "

The type of request. Indicates whether the Spot Fleet only requests the target\n capacity or also attempts to maintain it. When this value is request, the\n Spot Fleet only places the required requests. It does not attempt to replenish Spot\n Instances if capacity is diminished, nor does it submit requests in alternative Spot\n pools if capacity is not available. When this value is maintain, the Spot\n Fleet maintains the target capacity. The Spot Fleet places the required requests to meet\n capacity and automatically replenishes any interrupted instances. Default:\n maintain. instant is listed but is not used by Spot\n Fleet.

", - "smithy.api#xmlName": "type" - } - }, - "ValidFrom": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "ValidFrom", - "smithy.api#documentation": "

The start date and time of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ).\n By default, Amazon EC2 starts fulfilling the request immediately.

", - "smithy.api#xmlName": "validFrom" - } - }, - "ValidUntil": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "ValidUntil", - "smithy.api#documentation": "

The end date and time of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ).\n After the end date and time, no new Spot Instance requests are placed or able to fulfill\n the request. If no value is specified, the Spot Fleet request remains until you cancel\n it.

", - "smithy.api#xmlName": "validUntil" - } - }, - "ReplaceUnhealthyInstances": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "ReplaceUnhealthyInstances", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether Spot Fleet should replace unhealthy instances.

", - "smithy.api#xmlName": "replaceUnhealthyInstances" - } - }, - "InstanceInterruptionBehavior": { - "target": "com.amazonaws.ec2#InstanceInterruptionBehavior", - "traits": { - "aws.protocols#ec2QueryName": "InstanceInterruptionBehavior", - "smithy.api#documentation": "

The behavior when a Spot Instance is interrupted. The default is\n terminate.

", - "smithy.api#xmlName": "instanceInterruptionBehavior" - } - }, - "LoadBalancersConfig": { - "target": "com.amazonaws.ec2#LoadBalancersConfig", - "traits": { - "aws.protocols#ec2QueryName": "LoadBalancersConfig", - "smithy.api#documentation": "

One or more Classic Load Balancers and target groups to attach to the Spot Fleet\n request. Spot Fleet registers the running Spot Instances with the specified Classic Load\n Balancers and target groups.

\n

With Network Load Balancers, Spot Fleet cannot register instances that have the\n following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2,\n M3, and T1.

", - "smithy.api#xmlName": "loadBalancersConfig" - } - }, - "InstancePoolsToUseCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "InstancePoolsToUseCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of Spot pools across which to allocate your target Spot capacity. Valid\n only when Spot AllocationStrategy is set to\n lowest-price. Spot Fleet selects the cheapest Spot pools and evenly\n allocates your target Spot capacity across the number of Spot pools that you\n specify.

\n

Note that Spot Fleet attempts to draw Spot Instances from the number of pools that you specify on a\n best effort basis. If a pool runs out of Spot capacity before fulfilling your target\n capacity, Spot Fleet will continue to fulfill your request by drawing from the next cheapest\n pool. To ensure that your target capacity is met, you might receive Spot Instances from more than\n the number of pools that you specified. Similarly, if most of the pools have no Spot\n capacity, you might receive your full target capacity from fewer than the number of\n pools that you specified.

", - "smithy.api#xmlName": "instancePoolsToUseCount" - } - }, - "Context": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Context", - "smithy.api#documentation": "

Reserved.

", - "smithy.api#xmlName": "context" - } - }, - "TargetCapacityUnitType": { - "target": "com.amazonaws.ec2#TargetCapacityUnitType", - "traits": { - "aws.protocols#ec2QueryName": "TargetCapacityUnitType", - "smithy.api#documentation": "

The unit for the target capacity. TargetCapacityUnitType can only be specified when InstanceRequirements is specified.

\n

Default: units (translates to number of instances)

", - "smithy.api#xmlName": "targetCapacityUnitType" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The key-value pair for tagging the Spot Fleet request on creation. The value for\n ResourceType must be spot-fleet-request, otherwise the\n Spot Fleet request fails. To tag instances at launch, specify the tags in the launch\n template (valid only if you use LaunchTemplateConfigs) or in\n the \n SpotFleetTagSpecification\n (valid only if you use\n LaunchSpecifications). For information about tagging after launch, see\n Tagging Your Resources.

", - "smithy.api#xmlName": "TagSpecification" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the configuration of a Spot Fleet request.

" - } - }, - "com.amazonaws.ec2#SpotFleetRequestConfigSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SpotFleetRequestConfig", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#SpotFleetRequestId": { - "type": "string" - }, - "com.amazonaws.ec2#SpotFleetRequestIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SpotFleetRequestId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#SpotFleetTagSpecification": { - "type": "structure", - "members": { - "ResourceType": { - "target": "com.amazonaws.ec2#ResourceType", - "traits": { - "aws.protocols#ec2QueryName": "ResourceType", - "smithy.api#documentation": "

The type of resource. Currently, the only resource type that is supported is\n instance. To tag the Spot Fleet request on creation, use the\n TagSpecifications parameter in \n SpotFleetRequestConfigData\n .

", - "smithy.api#xmlName": "resourceType" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "Tag", - "smithy.api#documentation": "

The tags.

", - "smithy.api#xmlName": "tag" - } - } - }, - "traits": { - "smithy.api#documentation": "

The tags for a Spot Fleet resource.

" - } - }, - "com.amazonaws.ec2#SpotFleetTagSpecificationList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SpotFleetTagSpecification", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#SpotInstanceInterruptionBehavior": { - "type": "enum", - "members": { - "hibernate": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "hibernate" - } - }, - "stop": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "stop" - } - }, - "terminate": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "terminate" - } - } - } - }, - "com.amazonaws.ec2#SpotInstanceRequest": { - "type": "structure", - "members": { - "ActualBlockHourlyPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ActualBlockHourlyPrice", - "smithy.api#documentation": "

Deprecated.

", - "smithy.api#xmlName": "actualBlockHourlyPrice" - } - }, - "AvailabilityZoneGroup": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZoneGroup", - "smithy.api#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.

", - "smithy.api#xmlName": "availabilityZoneGroup" - } - }, - "BlockDurationMinutes": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "BlockDurationMinutes", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

Deprecated.

", - "smithy.api#xmlName": "blockDurationMinutes" - } - }, - "CreateTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "CreateTime", - "smithy.api#documentation": "

The date and time when the Spot Instance request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", - "smithy.api#xmlName": "createTime" - } - }, - "Fault": { - "target": "com.amazonaws.ec2#SpotInstanceStateFault", - "traits": { - "aws.protocols#ec2QueryName": "Fault", - "smithy.api#documentation": "

The fault codes for the Spot Instance request, if any.

", - "smithy.api#xmlName": "fault" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The instance ID, if an instance has been launched to fulfill the Spot Instance request.

", - "smithy.api#xmlName": "instanceId" - } - }, - "LaunchGroup": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LaunchGroup", - "smithy.api#documentation": "

The instance launch group. Launch groups are Spot Instances that launch together and terminate together.

", - "smithy.api#xmlName": "launchGroup" - } - }, - "LaunchSpecification": { - "target": "com.amazonaws.ec2#LaunchSpecification", - "traits": { - "aws.protocols#ec2QueryName": "LaunchSpecification", - "smithy.api#documentation": "

Additional information for launching instances.

", - "smithy.api#xmlName": "launchSpecification" - } - }, - "LaunchedAvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LaunchedAvailabilityZone", - "smithy.api#documentation": "

The Availability Zone in which the request is launched.

", - "smithy.api#xmlName": "launchedAvailabilityZone" - } - }, - "ProductDescription": { - "target": "com.amazonaws.ec2#RIProductDescription", - "traits": { - "aws.protocols#ec2QueryName": "ProductDescription", - "smithy.api#documentation": "

The product description associated with the Spot Instance.

", - "smithy.api#xmlName": "productDescription" - } - }, - "SpotInstanceRequestId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SpotInstanceRequestId", - "smithy.api#documentation": "

The ID of the Spot Instance request.

", - "smithy.api#xmlName": "spotInstanceRequestId" - } - }, - "SpotPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SpotPrice", - "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend \n using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n ", - "smithy.api#xmlName": "spotPrice" - } - }, - "State": { - "target": "com.amazonaws.ec2#SpotInstanceState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the Spot Instance request. Spot request status information helps track your Spot\n Instance requests. For more information, see Spot request status in the\n Amazon EC2 User Guide for Linux Instances.

", - "smithy.api#xmlName": "state" - } - }, - "Status": { - "target": "com.amazonaws.ec2#SpotInstanceStatus", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The status code and status message describing the Spot Instance request.

", - "smithy.api#xmlName": "status" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the resource.

", - "smithy.api#xmlName": "tagSet" - } - }, - "Type": { - "target": "com.amazonaws.ec2#SpotInstanceType", - "traits": { - "aws.protocols#ec2QueryName": "Type", - "smithy.api#documentation": "

The Spot Instance request type.

", - "smithy.api#xmlName": "type" - } - }, - "ValidFrom": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "ValidFrom", - "smithy.api#documentation": "

The start date of the request, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).\n The request becomes active at this date and time.

", - "smithy.api#xmlName": "validFrom" - } - }, - "ValidUntil": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "ValidUntil", - "smithy.api#documentation": "

The end date of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ).

\n ", - "smithy.api#xmlName": "validUntil" - } - }, - "InstanceInterruptionBehavior": { - "target": "com.amazonaws.ec2#InstanceInterruptionBehavior", - "traits": { - "aws.protocols#ec2QueryName": "InstanceInterruptionBehavior", - "smithy.api#documentation": "

The behavior when a Spot Instance is interrupted.

", - "smithy.api#xmlName": "instanceInterruptionBehavior" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a Spot Instance request.

" - } - }, - "com.amazonaws.ec2#SpotInstanceRequestId": { - "type": "string" - }, - "com.amazonaws.ec2#SpotInstanceRequestIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SpotInstanceRequestId", - "traits": { - "smithy.api#xmlName": "SpotInstanceRequestId" - } - } - }, - "com.amazonaws.ec2#SpotInstanceRequestList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SpotInstanceRequest", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#SpotInstanceState": { - "type": "enum", - "members": { - "open": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "open" - } - }, - "active": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "active" - } - }, - "closed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "closed" - } - }, - "cancelled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cancelled" - } - }, - "failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failed" - } - } - } - }, - "com.amazonaws.ec2#SpotInstanceStateFault": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The reason code for the Spot Instance state change.

", - "smithy.api#xmlName": "code" - } - }, - "Message": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "

The message for the Spot Instance state change.

", - "smithy.api#xmlName": "message" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a Spot Instance state change.

" - } - }, - "com.amazonaws.ec2#SpotInstanceStatus": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The status code. For a list of status codes, see Spot request status codes in the Amazon EC2 User Guide for Linux Instances.

", - "smithy.api#xmlName": "code" - } - }, - "Message": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "

The description for the status code.

", - "smithy.api#xmlName": "message" - } - }, - "UpdateTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "UpdateTime", - "smithy.api#documentation": "

The date and time of the most recent status update, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", - "smithy.api#xmlName": "updateTime" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the status of a Spot Instance request.

" - } - }, - "com.amazonaws.ec2#SpotInstanceType": { - "type": "enum", - "members": { - "one_time": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "one-time" - } - }, - "persistent": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "persistent" - } - } - } - }, - "com.amazonaws.ec2#SpotMaintenanceStrategies": { - "type": "structure", - "members": { - "CapacityRebalance": { - "target": "com.amazonaws.ec2#SpotCapacityRebalance", - "traits": { - "aws.protocols#ec2QueryName": "CapacityRebalance", - "smithy.api#documentation": "

The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your\n Spot Instance is at an elevated risk of being interrupted. For more information, see\n Capacity rebalancing in the Amazon EC2 User Guide for Linux Instances.

", - "smithy.api#xmlName": "capacityRebalance" - } - } - }, - "traits": { - "smithy.api#documentation": "

The strategies for managing your Spot Instances that are at an elevated risk of being\n interrupted.

" - } - }, - "com.amazonaws.ec2#SpotMarketOptions": { - "type": "structure", - "members": { - "MaxPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The maximum hourly price that you're willing to pay for a Spot Instance. We do not\n recommend using this parameter because it can lead to increased interruptions. If you do\n not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your Spot Instances will be interrupted more\n frequently than if you do not specify this parameter.

\n " - } - }, - "SpotInstanceType": { - "target": "com.amazonaws.ec2#SpotInstanceType", - "traits": { - "smithy.api#documentation": "

The Spot Instance request type. For RunInstances, persistent\n Spot Instance requests are only supported when the instance interruption behavior is\n either hibernate or stop.

" - } - }, - "BlockDurationMinutes": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

Deprecated.

" - } - }, - "ValidUntil": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "smithy.api#documentation": "

The end date of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ).\n Supported only for persistent requests.

\n " - } - }, - "InstanceInterruptionBehavior": { - "target": "com.amazonaws.ec2#InstanceInterruptionBehavior", - "traits": { - "smithy.api#documentation": "

The behavior when a Spot Instance is interrupted. The default is\n terminate.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options for Spot Instances.

" - } - }, - "com.amazonaws.ec2#SpotOptions": { - "type": "structure", - "members": { - "AllocationStrategy": { - "target": "com.amazonaws.ec2#SpotAllocationStrategy", - "traits": { - "aws.protocols#ec2QueryName": "AllocationStrategy", - "smithy.api#documentation": "

The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\n pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the\n Amazon EC2 User Guide.

\n
\n
price-capacity-optimized (recommended)
\n
\n

EC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. EC2 Fleet then requests Spot Instances from the lowest priced of these pools.

\n
\n
capacity-optimized
\n
\n

EC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. To give certain\n instance types a higher chance of launching first, use\n capacity-optimized-prioritized. Set a priority for each instance type by\n using the Priority parameter for LaunchTemplateOverrides. You can\n assign the same priority to different LaunchTemplateOverrides. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacity-optimized-prioritized is supported only if your EC2 Fleet uses a\n launch template. Note that if the On-Demand AllocationStrategy is set to\n prioritized, the same priority is applied when fulfilling On-Demand\n capacity.

\n
\n
diversified
\n
\n

EC2 Fleet requests instances from all of the Spot Instance pools that you\n specify.

\n
\n
lowest-price
\n
\n

EC2 Fleet requests instances from the lowest priced Spot Instance pool that\n has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances\n come from the next lowest priced pool that has available capacity. If a pool runs out of\n capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your\n request by drawing from the next lowest priced pool. To ensure that your desired capacity is\n met, you might receive Spot Instances from several pools. Because this strategy only considers instance \n price and not capacity availability, it might lead to high interruption rates.

\n
\n
\n

Default: lowest-price\n

", - "smithy.api#xmlName": "allocationStrategy" - } - }, - "MaintenanceStrategies": { - "target": "com.amazonaws.ec2#FleetSpotMaintenanceStrategies", - "traits": { - "aws.protocols#ec2QueryName": "MaintenanceStrategies", - "smithy.api#documentation": "

The strategies for managing your workloads on your Spot Instances that will be\n interrupted. Currently only the capacity rebalance strategy is available.

", - "smithy.api#xmlName": "maintenanceStrategies" - } - }, - "InstanceInterruptionBehavior": { - "target": "com.amazonaws.ec2#SpotInstanceInterruptionBehavior", - "traits": { - "aws.protocols#ec2QueryName": "InstanceInterruptionBehavior", - "smithy.api#documentation": "

The behavior when a Spot Instance is interrupted.

\n

Default: terminate\n

", - "smithy.api#xmlName": "instanceInterruptionBehavior" - } - }, - "InstancePoolsToUseCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "InstancePoolsToUseCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of Spot pools across which to allocate your target Spot capacity. Supported\n only when AllocationStrategy is set to lowest-price. EC2 Fleet selects\n the cheapest Spot pools and evenly allocates your target Spot capacity across the number of\n Spot pools that you specify.

\n

Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a\n best effort basis. If a pool runs out of Spot capacity before fulfilling your target\n capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest\n pool. To ensure that your target capacity is met, you might receive Spot Instances from more than\n the number of pools that you specified. Similarly, if most of the pools have no Spot\n capacity, you might receive your full target capacity from fewer than the number of pools\n that you specified.

", - "smithy.api#xmlName": "instancePoolsToUseCount" - } - }, - "SingleInstanceType": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "SingleInstanceType", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates that the fleet uses a single instance type to launch all Spot Instances in the\n fleet.

\n

Supported only for fleets of type instant.

", - "smithy.api#xmlName": "singleInstanceType" - } - }, - "SingleAvailabilityZone": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "SingleAvailabilityZone", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates that the fleet launches all Spot Instances into a single Availability Zone.

\n

Supported only for fleets of type instant.

", - "smithy.api#xmlName": "singleAvailabilityZone" - } - }, - "MinTargetCapacity": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "MinTargetCapacity", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is\n not reached, the fleet launches no instances.

\n

Supported only for fleets of type instant.

\n

At least one of the following must be specified: SingleAvailabilityZone |\n SingleInstanceType\n

", - "smithy.api#xmlName": "minTargetCapacity" - } - }, - "MaxTotalPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "MaxTotalPrice", - "smithy.api#documentation": "

The maximum amount per hour for Spot Instances that you're willing to pay. We do not recommend\n using this parameter because it can lead to increased interruptions. If you do not specify\n this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.

\n ", - "smithy.api#xmlName": "maxTotalPrice" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the configuration of Spot Instances in an EC2 Fleet.

" - } - }, - "com.amazonaws.ec2#SpotOptionsRequest": { - "type": "structure", - "members": { - "AllocationStrategy": { - "target": "com.amazonaws.ec2#SpotAllocationStrategy", - "traits": { - "smithy.api#documentation": "

The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\n pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the\n Amazon EC2 User Guide.

\n
\n
price-capacity-optimized (recommended)
\n
\n

EC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. EC2 Fleet then requests Spot Instances from the lowest priced of these pools.

\n
\n
capacity-optimized
\n
\n

EC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. To give certain\n instance types a higher chance of launching first, use\n capacity-optimized-prioritized. Set a priority for each instance type by\n using the Priority parameter for LaunchTemplateOverrides. You can\n assign the same priority to different LaunchTemplateOverrides. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacity-optimized-prioritized is supported only if your EC2 Fleet uses a\n launch template. Note that if the On-Demand AllocationStrategy is set to\n prioritized, the same priority is applied when fulfilling On-Demand\n capacity.

\n
\n
diversified
\n
\n

EC2 Fleet requests instances from all of the Spot Instance pools that you\n specify.

\n
\n
lowest-price
\n
\n

EC2 Fleet requests instances from the lowest priced Spot Instance pool that\n has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances\n come from the next lowest priced pool that has available capacity. If a pool runs out of\n capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your\n request by drawing from the next lowest priced pool. To ensure that your desired capacity is\n met, you might receive Spot Instances from several pools. Because this strategy only considers instance \n price and not capacity availability, it might lead to high interruption rates.

\n
\n
\n

Default: lowest-price\n

" - } - }, - "MaintenanceStrategies": { - "target": "com.amazonaws.ec2#FleetSpotMaintenanceStrategiesRequest", - "traits": { - "smithy.api#documentation": "

The strategies for managing your Spot Instances that are at an elevated risk of being\n interrupted.

" - } - }, - "InstanceInterruptionBehavior": { - "target": "com.amazonaws.ec2#SpotInstanceInterruptionBehavior", - "traits": { - "smithy.api#documentation": "

The behavior when a Spot Instance is interrupted.

\n

Default: terminate\n

" - } - }, - "InstancePoolsToUseCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of Spot pools across which to allocate your target Spot capacity. Supported\n only when Spot AllocationStrategy is set to lowest-price. EC2 Fleet\n selects the cheapest Spot pools and evenly allocates your target Spot capacity across the\n number of Spot pools that you specify.

\n

Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a\n best effort basis. If a pool runs out of Spot capacity before fulfilling your target\n capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest\n pool. To ensure that your target capacity is met, you might receive Spot Instances from more than\n the number of pools that you specified. Similarly, if most of the pools have no Spot\n capacity, you might receive your full target capacity from fewer than the number of pools\n that you specified.

" - } - }, - "SingleInstanceType": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates that the fleet uses a single instance type to launch all Spot Instances in the\n fleet.

\n

Supported only for fleets of type instant.

" - } - }, - "SingleAvailabilityZone": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates that the fleet launches all Spot Instances into a single Availability Zone.

\n

Supported only for fleets of type instant.

" - } - }, - "MinTargetCapacity": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is\n not reached, the fleet launches no instances.

\n

Supported only for fleets of type instant.

\n

At least one of the following must be specified: SingleAvailabilityZone |\n SingleInstanceType\n

" - } - }, - "MaxTotalPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The maximum amount per hour for Spot Instances that you're willing to pay. We do not recommend\n using this parameter because it can lead to increased interruptions. If you do not specify\n this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the configuration of Spot Instances in an EC2 Fleet request.

" - } - }, - "com.amazonaws.ec2#SpotPlacement": { - "type": "structure", - "members": { - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone.

\n

[Spot Fleet only] To specify multiple Availability Zones, separate them using commas;\n for example, \"us-west-2a, us-west-2b\".

", - "smithy.api#xmlName": "availabilityZone" - } - }, - "GroupName": { - "target": "com.amazonaws.ec2#PlacementGroupName", - "traits": { - "aws.protocols#ec2QueryName": "GroupName", - "smithy.api#documentation": "

The name of the placement group.

", - "smithy.api#xmlName": "groupName" - } - }, - "Tenancy": { - "target": "com.amazonaws.ec2#Tenancy", - "traits": { - "aws.protocols#ec2QueryName": "Tenancy", - "smithy.api#documentation": "

The tenancy of the instance (if the instance is running in a VPC). An instance with a\n tenancy of dedicated runs on single-tenant hardware. The host\n tenancy is not supported for Spot Instances.

", - "smithy.api#xmlName": "tenancy" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes Spot Instance placement.

" - } - }, - "com.amazonaws.ec2#SpotPlacementScore": { - "type": "structure", - "members": { - "Region": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Region", - "smithy.api#documentation": "

The Region.

", - "smithy.api#xmlName": "region" - } - }, - "AvailabilityZoneId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZoneId", - "smithy.api#documentation": "

The Availability Zone.

", - "smithy.api#xmlName": "availabilityZoneId" - } - }, - "Score": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Score", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The placement score, on a scale from 1 to 10. A score of\n 10 indicates that your Spot request is highly likely to succeed in this\n Region or Availability Zone. A score of 1 indicates that your Spot request is\n not likely to succeed.

", - "smithy.api#xmlName": "score" - } - } - }, - "traits": { - "smithy.api#documentation": "

The Spot placement score for this Region or Availability Zone. The score is calculated\n based on the assumption that the capacity-optimized allocation strategy is\n used and that all of the Availability Zones in the Region can be used.

" - } - }, - "com.amazonaws.ec2#SpotPlacementScores": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SpotPlacementScore", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#SpotPlacementScoresMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 10, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#SpotPlacementScoresTargetCapacity": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 2000000000 - } - } - }, - "com.amazonaws.ec2#SpotPrice": { - "type": "structure", - "members": { - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone.

", - "smithy.api#xmlName": "availabilityZone" - } - }, - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type.

", - "smithy.api#xmlName": "instanceType" - } - }, - "ProductDescription": { - "target": "com.amazonaws.ec2#RIProductDescription", - "traits": { - "aws.protocols#ec2QueryName": "ProductDescription", - "smithy.api#documentation": "

A general description of the AMI.

", - "smithy.api#xmlName": "productDescription" - } - }, - "SpotPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SpotPrice", - "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend \n using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n ", - "smithy.api#xmlName": "spotPrice" - } - }, - "Timestamp": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "Timestamp", - "smithy.api#documentation": "

The date and time the request was created, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", - "smithy.api#xmlName": "timestamp" - } - } - }, - "traits": { - "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend \n using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n " - } - }, - "com.amazonaws.ec2#SpotPriceHistoryList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SpotPrice", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#SpreadLevel": { - "type": "enum", - "members": { - "host": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "host" - } - }, - "rack": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "rack" - } - } - } - }, - "com.amazonaws.ec2#StaleIpPermission": { - "type": "structure", - "members": { - "FromPort": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "FromPort", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The start of the port range for the TCP and UDP protocols, or an ICMP type number. A value of\n -1 indicates all ICMP types.

", - "smithy.api#xmlName": "fromPort" - } - }, - "IpProtocol": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "IpProtocol", - "smithy.api#documentation": "

The IP protocol name (for tcp, udp, and icmp) or number (see Protocol Numbers).

", - "smithy.api#xmlName": "ipProtocol" - } - }, - "IpRanges": { - "target": "com.amazonaws.ec2#IpRanges", - "traits": { - "aws.protocols#ec2QueryName": "IpRanges", - "smithy.api#documentation": "

The IP ranges. Not applicable for stale security group rules.

", - "smithy.api#xmlName": "ipRanges" - } - }, - "PrefixListIds": { - "target": "com.amazonaws.ec2#PrefixListIdSet", - "traits": { - "aws.protocols#ec2QueryName": "PrefixListIds", - "smithy.api#documentation": "

The prefix list IDs. Not applicable for stale security group rules.

", - "smithy.api#xmlName": "prefixListIds" - } - }, - "ToPort": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "ToPort", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The end of the port range for the TCP and UDP protocols, or an ICMP type number. A value of\n -1 indicates all ICMP types.

", - "smithy.api#xmlName": "toPort" - } - }, - "UserIdGroupPairs": { - "target": "com.amazonaws.ec2#UserIdGroupPairSet", - "traits": { - "aws.protocols#ec2QueryName": "Groups", - "smithy.api#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.

", - "smithy.api#xmlName": "groups" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a stale rule in a security group.

" - } - }, - "com.amazonaws.ec2#StaleIpPermissionSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#StaleIpPermission", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#StaleSecurityGroup": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

The description of the security group.

", - "smithy.api#xmlName": "description" - } - }, - "GroupId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupId", - "smithy.api#documentation": "

The ID of the security group.

", - "smithy.api#xmlName": "groupId" - } - }, - "GroupName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupName", - "smithy.api#documentation": "

The name of the security group.

", - "smithy.api#xmlName": "groupName" - } - }, - "StaleIpPermissions": { - "target": "com.amazonaws.ec2#StaleIpPermissionSet", - "traits": { - "aws.protocols#ec2QueryName": "StaleIpPermissions", - "smithy.api#documentation": "

Information about the stale inbound rules in the security group.

", - "smithy.api#xmlName": "staleIpPermissions" - } - }, - "StaleIpPermissionsEgress": { - "target": "com.amazonaws.ec2#StaleIpPermissionSet", - "traits": { - "aws.protocols#ec2QueryName": "StaleIpPermissionsEgress", - "smithy.api#documentation": "

Information about the stale outbound rules in the security group.

", - "smithy.api#xmlName": "staleIpPermissionsEgress" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC for the security group.

", - "smithy.api#xmlName": "vpcId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a stale security group (a security group that contains stale rules).

" - } - }, - "com.amazonaws.ec2#StaleSecurityGroupSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#StaleSecurityGroup", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#StartInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#StartInstancesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#StartInstancesResult" - }, - "traits": { - "smithy.api#documentation": "

Starts an Amazon EBS-backed instance that you've previously stopped.

\n

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and\n started. When an instance is stopped, the compute resources are released and you are not\n billed for instance usage. However, your root partition Amazon EBS volume remains and\n continues to persist your data, and you are charged for Amazon EBS volume usage. You can\n restart your instance at any time. Every time you start your instance, Amazon EC2\n charges a one-minute minimum for instance usage, and thereafter charges per second for\n instance usage.

\n

Before stopping an instance, make sure it is in a state from which it can be\n restarted. Stopping an instance does not preserve data stored in RAM.

\n

Performing this operation on an instance that uses an instance store as its root\n device returns an error.

\n

If you attempt to start a T3 instance with host tenancy and the\n unlimted CPU credit option, the request fails. The\n unlimited CPU credit option is not supported on Dedicated Hosts. Before\n you start the instance, either change its CPU credit option to standard, or\n change its tenancy to default or dedicated.

\n

For more information, see Stop and start your instance\n in the Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#StartInstancesRequest": { - "type": "structure", - "members": { - "InstanceIds": { - "target": "com.amazonaws.ec2#InstanceIdStringList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IDs of the instances.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "InstanceId" - } - }, - "AdditionalInfo": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AdditionalInfo", - "smithy.api#documentation": "

Reserved.

", - "smithy.api#xmlName": "additionalInfo" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#StartInstancesResult": { - "type": "structure", - "members": { - "StartingInstances": { - "target": "com.amazonaws.ec2#InstanceStateChangeList", - "traits": { - "aws.protocols#ec2QueryName": "InstancesSet", - "smithy.api#documentation": "

Information about the started instances.

", - "smithy.api#xmlName": "instancesSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#StartNetworkInsightsAccessScopeAnalysis": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#StartNetworkInsightsAccessScopeAnalysisRequest" - }, - "output": { - "target": "com.amazonaws.ec2#StartNetworkInsightsAccessScopeAnalysisResult" - }, - "traits": { - "smithy.api#documentation": "

Starts analyzing the specified Network Access Scope.

" - } - }, - "com.amazonaws.ec2#StartNetworkInsightsAccessScopeAnalysisRequest": { - "type": "structure", - "members": { - "NetworkInsightsAccessScopeId": { - "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Network Access Scope.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, \n see How to ensure idempotency.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#StartNetworkInsightsAccessScopeAnalysisResult": { - "type": "structure", - "members": { - "NetworkInsightsAccessScopeAnalysis": { - "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysis", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeAnalysis", - "smithy.api#documentation": "

The Network Access Scope analysis.

", - "smithy.api#xmlName": "networkInsightsAccessScopeAnalysis" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#StartNetworkInsightsAnalysis": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#StartNetworkInsightsAnalysisRequest" - }, - "output": { - "target": "com.amazonaws.ec2#StartNetworkInsightsAnalysisResult" - }, - "traits": { - "smithy.api#documentation": "

Starts analyzing the specified path. If the path is reachable, the\n operation returns the shortest feasible path.

" - } - }, - "com.amazonaws.ec2#StartNetworkInsightsAnalysisRequest": { - "type": "structure", - "members": { - "NetworkInsightsPathId": { - "target": "com.amazonaws.ec2#NetworkInsightsPathId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the path.

", - "smithy.api#required": {} - } - }, - "AdditionalAccounts": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#documentation": "

The member accounts that contain resources that the path can traverse.

", - "smithy.api#xmlName": "AdditionalAccount" - } - }, - "FilterInArns": { - "target": "com.amazonaws.ec2#ArnList", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the resources that the path must traverse.

", - "smithy.api#xmlName": "FilterInArn" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, \n see How to ensure idempotency.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#StartNetworkInsightsAnalysisResult": { - "type": "structure", - "members": { - "NetworkInsightsAnalysis": { - "target": "com.amazonaws.ec2#NetworkInsightsAnalysis", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInsightsAnalysis", - "smithy.api#documentation": "

Information about the network insights analysis.

", - "smithy.api#xmlName": "networkInsightsAnalysis" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#StartVpcEndpointServicePrivateDnsVerification": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#StartVpcEndpointServicePrivateDnsVerificationRequest" - }, - "output": { - "target": "com.amazonaws.ec2#StartVpcEndpointServicePrivateDnsVerificationResult" - }, - "traits": { - "smithy.api#documentation": "

Initiates the verification process to prove that the service provider owns the private\n DNS name domain for the endpoint service.

\n

The service provider must successfully perform the verification before the consumer can use the name to access the service.

\n

Before the service provider runs this command, they must add a record to the DNS server.

" - } - }, - "com.amazonaws.ec2#StartVpcEndpointServicePrivateDnsVerificationRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "ServiceId": { - "target": "com.amazonaws.ec2#VpcEndpointServiceId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the endpoint service.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#StartVpcEndpointServicePrivateDnsVerificationResult": { - "type": "structure", - "members": { - "ReturnValue": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#State": { - "type": "enum", - "members": { - "PendingAcceptance": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PendingAcceptance" - } - }, - "Pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Pending" - } - }, - "Available": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Available" - } - }, - "Deleting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deleting" - } - }, - "Deleted": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deleted" - } - }, - "Rejected": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Rejected" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "Expired": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Expired" - } - } - } - }, - "com.amazonaws.ec2#StateReason": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The reason code for the state change.

", - "smithy.api#xmlName": "code" - } - }, - "Message": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "

The message for the state change.

\n ", - "smithy.api#xmlName": "message" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a state change.

" - } - }, - "com.amazonaws.ec2#StaticSourcesSupportValue": { - "type": "enum", - "members": { - "enable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enable" - } - }, - "disable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disable" - } - } - } - }, - "com.amazonaws.ec2#StatisticType": { - "type": "enum", - "members": { - "p50": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "p50" - } - } - } - }, - "com.amazonaws.ec2#Status": { - "type": "enum", - "members": { - "moveInProgress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MoveInProgress" - } - }, - "inVpc": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InVpc" - } - }, - "inClassic": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InClassic" - } - } - } - }, - "com.amazonaws.ec2#StatusName": { - "type": "enum", - "members": { - "reachability": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "reachability" - } - } - } - }, - "com.amazonaws.ec2#StatusType": { - "type": "enum", - "members": { - "passed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "passed" - } - }, - "failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failed" - } - }, - "insufficient_data": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "insufficient-data" - } - }, - "initializing": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "initializing" - } - } - } - }, - "com.amazonaws.ec2#StopInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#StopInstancesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#StopInstancesResult" - }, - "traits": { - "smithy.api#documentation": "

Stops an Amazon EBS-backed instance. For more information, see Stop and start\n your instance in the Amazon EC2 User Guide.

\n

You can use the Stop action to hibernate an instance if the instance is enabled for\n hibernation and it meets the hibernation\n prerequisites. For more information, see Hibernate your instance in the\n Amazon EC2 User Guide.

\n

We don't charge usage for a stopped instance, or data transfer fees; however, your\n root partition Amazon EBS volume remains and continues to persist your data, and you are\n charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2\n charges a one-minute minimum for instance usage, and thereafter charges per second for\n instance usage.

\n

You can't stop or hibernate instance store-backed instances. You can't use the Stop\n action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate\n Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the\n Amazon EC2 User Guide.

\n

When you stop or hibernate an instance, we shut it down. You can restart your instance\n at any time. Before stopping or hibernating an instance, make sure it is in a state from\n which it can be restarted. Stopping an instance does not preserve data stored in RAM,\n but hibernating an instance does preserve data stored in RAM. If an instance cannot\n hibernate successfully, a normal shutdown occurs.

\n

Stopping and hibernating an instance is different to rebooting or terminating it. For\n example, when you stop or hibernate an instance, the root device and any other devices\n attached to the instance persist. When you terminate an instance, the root device and\n any other devices attached during the instance launch are automatically deleted. For\n more information about the differences between rebooting, stopping, hibernating, and\n terminating instances, see Instance lifecycle\n in the Amazon EC2 User Guide.

\n

When you stop an instance, we attempt to shut it down forcibly after a short while. If\n your instance appears stuck in the stopping state after a period of time, there may be\n an issue with the underlying host computer. For more information, see Troubleshoot\n stopping your instance in the Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#StopInstancesRequest": { - "type": "structure", - "members": { - "InstanceIds": { - "target": "com.amazonaws.ec2#InstanceIdStringList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IDs of the instances.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "InstanceId" - } - }, - "Hibernate": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Hibernates the instance if the instance was enabled for hibernation at launch. If the\n instance cannot hibernate successfully, a normal shutdown occurs. For more information,\n see Hibernate\n your instance in the Amazon EC2 User Guide.

\n

Default: false\n

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, - "Force": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Force", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Forces the instances to stop. The instances do not have an opportunity to flush file\n system caches or file system metadata. If you use this option, you must perform file\n system check and repair procedures. This option is not recommended for Windows\n instances.

\n

Default: false\n

", - "smithy.api#xmlName": "force" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#StopInstancesResult": { - "type": "structure", - "members": { - "StoppingInstances": { - "target": "com.amazonaws.ec2#InstanceStateChangeList", - "traits": { - "aws.protocols#ec2QueryName": "InstancesSet", - "smithy.api#documentation": "

Information about the stopped instances.

", - "smithy.api#xmlName": "instancesSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#Storage": { - "type": "structure", - "members": { - "S3": { - "target": "com.amazonaws.ec2#S3Storage", - "traits": { - "smithy.api#documentation": "

An Amazon S3 storage location.

", - "smithy.api#xmlName": "S3" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the storage location for an instance store-backed AMI.

" - } - }, - "com.amazonaws.ec2#StorageLocation": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The name of the S3 bucket.

" - } - }, - "Key": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The key.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a storage location in Amazon S3.

" - } - }, - "com.amazonaws.ec2#StorageTier": { - "type": "enum", - "members": { - "archive": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "archive" - } - }, - "standard": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "standard" - } - } - } - }, - "com.amazonaws.ec2#StoreImageTaskResult": { - "type": "structure", - "members": { - "AmiId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AmiId", - "smithy.api#documentation": "

The ID of the AMI that is being stored.

", - "smithy.api#xmlName": "amiId" - } - }, - "TaskStartTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "TaskStartTime", - "smithy.api#documentation": "

The time the task started.

", - "smithy.api#xmlName": "taskStartTime" - } - }, - "Bucket": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Bucket", - "smithy.api#documentation": "

The name of the Amazon S3 bucket that contains the stored AMI object.

", - "smithy.api#xmlName": "bucket" - } - }, - "S3objectKey": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "S3objectKey", - "smithy.api#documentation": "

The name of the stored AMI object in the bucket.

", - "smithy.api#xmlName": "s3objectKey" - } - }, - "ProgressPercentage": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "ProgressPercentage", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The progress of the task as a percentage.

", - "smithy.api#xmlName": "progressPercentage" - } - }, - "StoreTaskState": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StoreTaskState", - "smithy.api#documentation": "

The state of the store task (InProgress, Completed, or\n Failed).

", - "smithy.api#xmlName": "storeTaskState" - } - }, - "StoreTaskFailureReason": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StoreTaskFailureReason", - "smithy.api#documentation": "

If the tasks fails, the reason for the failure is returned. If the task succeeds,\n null is returned.

", - "smithy.api#xmlName": "storeTaskFailureReason" - } - } - }, - "traits": { - "smithy.api#documentation": "

The information about the AMI store task, including the progress of the task.

" - } - }, - "com.amazonaws.ec2#StoreImageTaskResultSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#StoreImageTaskResult", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#String": { - "type": "string" - }, - "com.amazonaws.ec2#StringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#StringType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64000 - } - } - }, - "com.amazonaws.ec2#Subnet": { - "type": "structure", - "members": { - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone of the subnet.

", - "smithy.api#xmlName": "availabilityZone" - } - }, - "AvailabilityZoneId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZoneId", - "smithy.api#documentation": "

The AZ ID of the subnet.

", - "smithy.api#xmlName": "availabilityZoneId" - } - }, - "AvailableIpAddressCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "AvailableIpAddressCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any\n\t\t\tstopped instances are considered unavailable.

", - "smithy.api#xmlName": "availableIpAddressCount" - } - }, - "CidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CidrBlock", - "smithy.api#documentation": "

The IPv4 CIDR block assigned to the subnet.

", - "smithy.api#xmlName": "cidrBlock" - } - }, - "DefaultForAz": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DefaultForAz", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether this is the default subnet for the Availability Zone.

", - "smithy.api#xmlName": "defaultForAz" - } - }, - "EnableLniAtDeviceIndex": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "EnableLniAtDeviceIndex", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

\n Indicates the device position for local network interfaces in this subnet. For example, \n 1 indicates local network interfaces in this subnet are the secondary \n network interface (eth1). \n

", - "smithy.api#xmlName": "enableLniAtDeviceIndex" - } - }, - "MapPublicIpOnLaunch": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "MapPublicIpOnLaunch", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether instances launched in this subnet receive a public IPv4 address.

", - "smithy.api#xmlName": "mapPublicIpOnLaunch" - } - }, - "MapCustomerOwnedIpOnLaunch": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "MapCustomerOwnedIpOnLaunch", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether a network interface created in this subnet (including a network\n interface created by RunInstances) receives a customer-owned IPv4 address.

", - "smithy.api#xmlName": "mapCustomerOwnedIpOnLaunch" - } - }, - "CustomerOwnedIpv4Pool": { - "target": "com.amazonaws.ec2#CoipPoolId", - "traits": { - "aws.protocols#ec2QueryName": "CustomerOwnedIpv4Pool", - "smithy.api#documentation": "

The customer-owned IPv4 address pool associated with the subnet.

", - "smithy.api#xmlName": "customerOwnedIpv4Pool" - } - }, - "State": { - "target": "com.amazonaws.ec2#SubnetState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The current state of the subnet.

", - "smithy.api#xmlName": "state" - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#documentation": "

The ID of the subnet.

", - "smithy.api#xmlName": "subnetId" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC the subnet is in.

", - "smithy.api#xmlName": "vpcId" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the subnet.

", - "smithy.api#xmlName": "ownerId" - } - }, - "AssignIpv6AddressOnCreation": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "AssignIpv6AddressOnCreation", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether a network interface created in this subnet (including a network\n interface created by RunInstances) receives an IPv6 address.

", - "smithy.api#xmlName": "assignIpv6AddressOnCreation" - } - }, - "Ipv6CidrBlockAssociationSet": { - "target": "com.amazonaws.ec2#SubnetIpv6CidrBlockAssociationSet", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6CidrBlockAssociationSet", - "smithy.api#documentation": "

Information about the IPv6 CIDR blocks associated with the subnet.

", - "smithy.api#xmlName": "ipv6CidrBlockAssociationSet" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the subnet.

", - "smithy.api#xmlName": "tagSet" - } - }, - "SubnetArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SubnetArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the subnet.

", - "smithy.api#xmlName": "subnetArn" - } - }, - "OutpostArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OutpostArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

", - "smithy.api#xmlName": "outpostArn" - } - }, - "EnableDns64": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "EnableDns64", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet \n should return synthetic IPv6 addresses for IPv4-only destinations.

", - "smithy.api#xmlName": "enableDns64" - } - }, - "Ipv6Native": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6Native", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether this is an IPv6 only subnet.

", - "smithy.api#xmlName": "ipv6Native" - } - }, - "PrivateDnsNameOptionsOnLaunch": { - "target": "com.amazonaws.ec2#PrivateDnsNameOptionsOnLaunch", - "traits": { - "aws.protocols#ec2QueryName": "PrivateDnsNameOptionsOnLaunch", - "smithy.api#documentation": "

The type of hostnames to assign to instances in the subnet at launch. An instance hostname\n is based on the IPv4 address or ID of the instance.

", - "smithy.api#xmlName": "privateDnsNameOptionsOnLaunch" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a subnet.

" - } - }, - "com.amazonaws.ec2#SubnetAssociation": { - "type": "structure", - "members": { - "SubnetId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#documentation": "

The ID of the subnet.

", - "smithy.api#xmlName": "subnetId" - } - }, - "State": { - "target": "com.amazonaws.ec2#TransitGatewayMulitcastDomainAssociationState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the subnet association.

", - "smithy.api#xmlName": "state" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the subnet association with the transit gateway multicast domain.

" - } - }, - "com.amazonaws.ec2#SubnetAssociationList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SubnetAssociation", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#SubnetCidrAssociationId": { - "type": "string" - }, - "com.amazonaws.ec2#SubnetCidrBlockState": { - "type": "structure", - "members": { - "State": { - "target": "com.amazonaws.ec2#SubnetCidrBlockStateCode", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of a CIDR block.

", - "smithy.api#xmlName": "state" - } - }, - "StatusMessage": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StatusMessage", - "smithy.api#documentation": "

A message about the status of the CIDR block, if applicable.

", - "smithy.api#xmlName": "statusMessage" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the state of a CIDR block.

" - } - }, - "com.amazonaws.ec2#SubnetCidrBlockStateCode": { - "type": "enum", - "members": { - "associating": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "associating" - } - }, - "associated": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "associated" - } - }, - "disassociating": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disassociating" - } - }, - "disassociated": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disassociated" - } - }, - "failing": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failing" - } - }, - "failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failed" - } - } - } - }, - "com.amazonaws.ec2#SubnetCidrReservation": { - "type": "structure", - "members": { - "SubnetCidrReservationId": { - "target": "com.amazonaws.ec2#SubnetCidrReservationId", - "traits": { - "aws.protocols#ec2QueryName": "SubnetCidrReservationId", - "smithy.api#documentation": "

The ID of the subnet CIDR reservation.

", - "smithy.api#xmlName": "subnetCidrReservationId" - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#SubnetId", - "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#documentation": "

The ID of the subnet.

", - "smithy.api#xmlName": "subnetId" - } - }, - "Cidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Cidr", - "smithy.api#documentation": "

The CIDR that has been reserved.

", - "smithy.api#xmlName": "cidr" - } - }, - "ReservationType": { - "target": "com.amazonaws.ec2#SubnetCidrReservationType", - "traits": { - "aws.protocols#ec2QueryName": "ReservationType", - "smithy.api#documentation": "

The type of reservation.

", - "smithy.api#xmlName": "reservationType" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the account that owns the subnet CIDR reservation.

", - "smithy.api#xmlName": "ownerId" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

The\n description\n assigned to the subnet CIDR\n reservation.

", - "smithy.api#xmlName": "description" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags assigned to the subnet CIDR reservation.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a subnet CIDR reservation.

" - } - }, - "com.amazonaws.ec2#SubnetCidrReservationId": { - "type": "string" - }, - "com.amazonaws.ec2#SubnetCidrReservationList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SubnetCidrReservation", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#SubnetCidrReservationType": { - "type": "enum", - "members": { - "prefix": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "prefix" - } - }, - "explicit": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "explicit" - } - } - } - }, - "com.amazonaws.ec2#SubnetId": { - "type": "string" - }, - "com.amazonaws.ec2#SubnetIdStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SubnetId", - "traits": { - "smithy.api#xmlName": "SubnetId" - } - } - }, - "com.amazonaws.ec2#SubnetIpv6CidrBlockAssociation": { - "type": "structure", - "members": { - "AssociationId": { - "target": "com.amazonaws.ec2#SubnetCidrAssociationId", - "traits": { - "aws.protocols#ec2QueryName": "AssociationId", - "smithy.api#documentation": "

The ID of the association.

", - "smithy.api#xmlName": "associationId" - } - }, - "Ipv6CidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6CidrBlock", - "smithy.api#documentation": "

The IPv6 CIDR block.

", - "smithy.api#xmlName": "ipv6CidrBlock" - } - }, - "Ipv6CidrBlockState": { - "target": "com.amazonaws.ec2#SubnetCidrBlockState", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6CidrBlockState", - "smithy.api#documentation": "

The state of the CIDR block.

", - "smithy.api#xmlName": "ipv6CidrBlockState" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an association between a subnet and an IPv6 CIDR block.

" - } - }, - "com.amazonaws.ec2#SubnetIpv6CidrBlockAssociationSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SubnetIpv6CidrBlockAssociation", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#SubnetList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Subnet", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#SubnetState": { - "type": "enum", - "members": { - "pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "available": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "available" - } - } - } - }, - "com.amazonaws.ec2#Subscription": { - "type": "structure", - "members": { - "Source": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Source", - "smithy.api#documentation": "

The Region or Availability Zone that's the source for the subscription. For example, us-east-1.

", - "smithy.api#xmlName": "source" - } - }, - "Destination": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Destination", - "smithy.api#documentation": "

The Region or Availability Zone that's the target for the subscription. For example, eu-west-1.

", - "smithy.api#xmlName": "destination" - } - }, - "Metric": { - "target": "com.amazonaws.ec2#MetricType", - "traits": { - "aws.protocols#ec2QueryName": "Metric", - "smithy.api#documentation": "

The metric used for the subscription.

", - "smithy.api#xmlName": "metric" - } - }, - "Statistic": { - "target": "com.amazonaws.ec2#StatisticType", - "traits": { - "aws.protocols#ec2QueryName": "Statistic", - "smithy.api#documentation": "

The statistic used for the subscription.

", - "smithy.api#xmlName": "statistic" - } - }, - "Period": { - "target": "com.amazonaws.ec2#PeriodType", - "traits": { - "aws.protocols#ec2QueryName": "Period", - "smithy.api#documentation": "

The data aggregation time for the subscription.

", - "smithy.api#xmlName": "period" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an Infrastructure Performance subscription.

" - } - }, - "com.amazonaws.ec2#SubscriptionList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Subscription", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#SuccessfulInstanceCreditSpecificationItem": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#xmlName": "instanceId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the burstable performance instance whose credit option for CPU usage was\n successfully modified.

" - } - }, - "com.amazonaws.ec2#SuccessfulInstanceCreditSpecificationSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SuccessfulInstanceCreditSpecificationItem", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#SuccessfulQueuedPurchaseDeletion": { - "type": "structure", - "members": { - "ReservedInstancesId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ReservedInstancesId", - "smithy.api#documentation": "

The ID of the Reserved Instance.

", - "smithy.api#xmlName": "reservedInstancesId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a Reserved Instance whose queued purchase was successfully deleted.

" - } - }, - "com.amazonaws.ec2#SuccessfulQueuedPurchaseDeletionSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SuccessfulQueuedPurchaseDeletion", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#SummaryStatus": { - "type": "enum", - "members": { - "ok": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ok" - } - }, - "impaired": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "impaired" - } - }, - "insufficient_data": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "insufficient-data" - } - }, - "not_applicable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "not-applicable" - } - }, - "initializing": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "initializing" - } - } - } - }, - "com.amazonaws.ec2#SupportedAdditionalProcessorFeature": { - "type": "enum", - "members": { - "AMD_SEV_SNP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "amd-sev-snp" - } - } - } - }, - "com.amazonaws.ec2#SupportedAdditionalProcessorFeatureList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SupportedAdditionalProcessorFeature", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#SupportedIpAddressTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ServiceConnectivityType", - "traits": { - "smithy.api#xmlName": "item" - } - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2 - } - } - }, - "com.amazonaws.ec2#Tag": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Key", - "smithy.api#documentation": "

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. \n May not begin with aws:.

", - "smithy.api#xmlName": "key" - } - }, - "Value": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Value", - "smithy.api#documentation": "

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

", - "smithy.api#xmlName": "value" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a tag.

" - } - }, - "com.amazonaws.ec2#TagDescription": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Key", - "smithy.api#documentation": "

The tag key.

", - "smithy.api#xmlName": "key" - } - }, - "ResourceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceId", - "smithy.api#documentation": "

The ID of the resource.

", - "smithy.api#xmlName": "resourceId" - } - }, - "ResourceType": { - "target": "com.amazonaws.ec2#ResourceType", - "traits": { - "aws.protocols#ec2QueryName": "ResourceType", - "smithy.api#documentation": "

The resource type.

", - "smithy.api#xmlName": "resourceType" - } - }, - "Value": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Value", - "smithy.api#documentation": "

The tag value.

", - "smithy.api#xmlName": "value" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a tag.

" - } - }, - "com.amazonaws.ec2#TagDescriptionList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TagDescription", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TagList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Tag", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TagSpecification": { - "type": "structure", - "members": { - "ResourceType": { - "target": "com.amazonaws.ec2#ResourceType", - "traits": { - "aws.protocols#ec2QueryName": "ResourceType", - "smithy.api#documentation": "

The type of resource to tag on creation.

", - "smithy.api#xmlName": "resourceType" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the resource.

", - "smithy.api#xmlName": "Tag" - } - } - }, - "traits": { - "smithy.api#documentation": "

The tags to apply to a resource when the resource is being created. When you specify a tag, you must \n specify the resource type to tag, otherwise the request will fail.

\n \n

The Valid Values lists all the resource types that can be tagged.\n However, the action you're using might not support tagging all of these resource types.\n If you try to tag a resource type that is unsupported for the action you're using,\n you'll get an error.

\n " - } - }, - "com.amazonaws.ec2#TagSpecificationList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TagSpecification", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TaggableResourceId": { - "type": "string" - }, - "com.amazonaws.ec2#TargetCapacitySpecification": { - "type": "structure", - "members": { - "TotalTargetCapacity": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "TotalTargetCapacity", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of units to request, filled using\n DefaultTargetCapacityType.

", - "smithy.api#xmlName": "totalTargetCapacity" - } - }, - "OnDemandTargetCapacity": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "OnDemandTargetCapacity", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#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.

", - "smithy.api#xmlName": "onDemandTargetCapacity" - } - }, - "SpotTargetCapacity": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "SpotTargetCapacity", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#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.

", - "smithy.api#xmlName": "spotTargetCapacity" - } - }, - "DefaultTargetCapacityType": { - "target": "com.amazonaws.ec2#DefaultTargetCapacityType", - "traits": { - "aws.protocols#ec2QueryName": "DefaultTargetCapacityType", - "smithy.api#documentation": "

The default TotalTargetCapacity, which is either Spot or\n On-Demand.

", - "smithy.api#xmlName": "defaultTargetCapacityType" - } - }, - "TargetCapacityUnitType": { - "target": "com.amazonaws.ec2#TargetCapacityUnitType", - "traits": { - "aws.protocols#ec2QueryName": "TargetCapacityUnitType", - "smithy.api#documentation": "

The unit for the target capacity. TargetCapacityUnitType can only be specified when InstanceRequirements is specified.

\n

Default: units (translates to number of instances)

", - "smithy.api#xmlName": "targetCapacityUnitType" - } - } - }, - "traits": { - "smithy.api#documentation": "

The number of units to request. You can choose to set the target capacity in terms of\n instances or a performance characteristic that is important to your application workload,\n such as vCPUs, memory, or I/O. If the request type is maintain, you can\n specify a target capacity of 0 and add capacity later.

\n

You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance\n MaxTotalPrice, or both to ensure that your fleet cost does not exceed your\n budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet\n will launch instances until it reaches the maximum amount that you're willing to pay. When\n the maximum amount you're willing to pay is reached, the fleet stops launching instances\n even if it hasn’t met the target capacity. The MaxTotalPrice parameters are\n located in OnDemandOptions \n and SpotOptions.

" - } - }, - "com.amazonaws.ec2#TargetCapacitySpecificationRequest": { - "type": "structure", - "members": { - "TotalTargetCapacity": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of units to request, filled using\n DefaultTargetCapacityType.

", - "smithy.api#required": {} - } - }, - "OnDemandTargetCapacity": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of On-Demand units to request.

" - } - }, - "SpotTargetCapacity": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of Spot units to request.

" - } - }, - "DefaultTargetCapacityType": { - "target": "com.amazonaws.ec2#DefaultTargetCapacityType", - "traits": { - "smithy.api#documentation": "

The default TotalTargetCapacity, which is either Spot or\n On-Demand.

" - } - }, - "TargetCapacityUnitType": { - "target": "com.amazonaws.ec2#TargetCapacityUnitType", - "traits": { - "smithy.api#documentation": "

The unit for the target capacity. TargetCapacityUnitType can only be specified when InstanceRequirements is specified.

\n

Default: units (translates to number of instances)

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The number of units to request. You can choose to set the target capacity as the number of \n instances. Or you can set the target capacity to a performance characteristic that is important to your application workload,\n such as vCPUs, memory, or I/O. If the request type is maintain, you can\n specify a target capacity of 0 and add capacity later.

\n

You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance\n MaxTotalPrice parameter, or both parameters to ensure that your fleet cost\n does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances\n in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you're\n willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops\n launching instances even if it hasn’t met the target capacity. The\n MaxTotalPrice parameters are located in OnDemandOptionsRequest \n and SpotOptionsRequest.

" - } - }, - "com.amazonaws.ec2#TargetCapacityUnitType": { - "type": "enum", - "members": { - "VCPU": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "vcpu" - } - }, - "MEMORY_MIB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "memory-mib" - } - }, - "UNITS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "units" - } - } - } - }, - "com.amazonaws.ec2#TargetConfiguration": { - "type": "structure", - "members": { - "InstanceCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "InstanceCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of instances the Convertible Reserved Instance offering can be applied to. This parameter is \n reserved and cannot be specified in a request

", - "smithy.api#xmlName": "instanceCount" - } - }, - "OfferingId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OfferingId", - "smithy.api#documentation": "

The ID of the Convertible Reserved Instance offering.

", - "smithy.api#xmlName": "offeringId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the Convertible Reserved Instance offering.

" - } - }, - "com.amazonaws.ec2#TargetConfigurationRequest": { - "type": "structure", - "members": { - "InstanceCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of instances the Convertible Reserved Instance offering can be applied to. This parameter is reserved and cannot \n be specified in a request

" - } - }, - "OfferingId": { - "target": "com.amazonaws.ec2#ReservedInstancesOfferingId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Convertible Reserved Instance offering ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about the target configuration.

" - } - }, - "com.amazonaws.ec2#TargetConfigurationRequestSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TargetConfigurationRequest", - "traits": { - "smithy.api#xmlName": "TargetConfigurationRequest" - } - } - }, - "com.amazonaws.ec2#TargetGroup": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Arn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target group.

", - "smithy.api#xmlName": "arn" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a load balancer target group.

" - } - }, - "com.amazonaws.ec2#TargetGroups": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TargetGroup", - "traits": { - "smithy.api#xmlName": "item" - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.ec2#TargetGroupsConfig": { - "type": "structure", - "members": { - "TargetGroups": { - "target": "com.amazonaws.ec2#TargetGroups", - "traits": { - "aws.protocols#ec2QueryName": "TargetGroups", - "smithy.api#documentation": "

One or more target groups.

", - "smithy.api#xmlName": "targetGroups" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the target groups to attach to a Spot Fleet. Spot Fleet registers the\n running Spot Instances with these target groups.

" - } - }, - "com.amazonaws.ec2#TargetNetwork": { - "type": "structure", - "members": { - "AssociationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AssociationId", - "smithy.api#documentation": "

The ID of the association.

", - "smithy.api#xmlName": "associationId" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC in which the target network (subnet) is located.

", - "smithy.api#xmlName": "vpcId" - } - }, - "TargetNetworkId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TargetNetworkId", - "smithy.api#documentation": "

The ID of the subnet specified as the target network.

", - "smithy.api#xmlName": "targetNetworkId" - } - }, - "ClientVpnEndpointId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientVpnEndpointId", - "smithy.api#documentation": "

The ID of the Client VPN endpoint with which the target network is associated.

", - "smithy.api#xmlName": "clientVpnEndpointId" - } - }, - "Status": { - "target": "com.amazonaws.ec2#AssociationStatus", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The current state of the target network association.

", - "smithy.api#xmlName": "status" - } - }, - "SecurityGroups": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "SecurityGroups", - "smithy.api#documentation": "

The IDs of the security groups applied to the target network association.

", - "smithy.api#xmlName": "securityGroups" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a target network associated with a Client VPN endpoint.

" - } - }, - "com.amazonaws.ec2#TargetNetworkSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TargetNetwork", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TargetReservationValue": { - "type": "structure", - "members": { - "ReservationValue": { - "target": "com.amazonaws.ec2#ReservationValue", - "traits": { - "aws.protocols#ec2QueryName": "ReservationValue", - "smithy.api#documentation": "

The total value of the Convertible Reserved Instances that make up the exchange. This is the sum of\n the list value, remaining upfront price, and additional upfront cost of the exchange.

", - "smithy.api#xmlName": "reservationValue" - } - }, - "TargetConfiguration": { - "target": "com.amazonaws.ec2#TargetConfiguration", - "traits": { - "aws.protocols#ec2QueryName": "TargetConfiguration", - "smithy.api#documentation": "

The configuration of the Convertible Reserved Instances that make up the exchange.

", - "smithy.api#xmlName": "targetConfiguration" - } - } - }, - "traits": { - "smithy.api#documentation": "

The total value of the new Convertible Reserved Instances.

" - } - }, - "com.amazonaws.ec2#TargetReservationValueSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TargetReservationValue", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TargetStorageTier": { - "type": "enum", - "members": { - "archive": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "archive" - } - } - } - }, - "com.amazonaws.ec2#TelemetryStatus": { - "type": "enum", - "members": { - "UP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UP" - } - }, - "DOWN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOWN" - } - } - } - }, - "com.amazonaws.ec2#Tenancy": { - "type": "enum", - "members": { - "default": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "default" - } - }, - "dedicated": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "dedicated" - } - }, - "host": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "host" - } - } - } - }, - "com.amazonaws.ec2#TerminateClientVpnConnections": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#TerminateClientVpnConnectionsRequest" - }, - "output": { - "target": "com.amazonaws.ec2#TerminateClientVpnConnectionsResult" - }, - "traits": { - "smithy.api#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.

" - } - }, - "com.amazonaws.ec2#TerminateClientVpnConnectionsRequest": { - "type": "structure", - "members": { - "ClientVpnEndpointId": { - "target": "com.amazonaws.ec2#ClientVpnEndpointId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Client VPN endpoint to which the client is connected.

", - "smithy.api#required": {} - } - }, - "ConnectionId": { - "target": "com.amazonaws.ec2#VpnConnectionId", - "traits": { - "smithy.api#documentation": "

The ID of the client connection to be terminated.

" - } - }, - "Username": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The name of the user who initiated the connection. Use this option to terminate all active connections for \n\t\t\tthe specified user. This option can only be used if the user has established up to five connections.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#TerminateClientVpnConnectionsResult": { - "type": "structure", - "members": { - "ClientVpnEndpointId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientVpnEndpointId", - "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", - "smithy.api#xmlName": "clientVpnEndpointId" - } - }, - "Username": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Username", - "smithy.api#documentation": "

The user who established the terminated client connections.

", - "smithy.api#xmlName": "username" - } - }, - "ConnectionStatuses": { - "target": "com.amazonaws.ec2#TerminateConnectionStatusSet", - "traits": { - "aws.protocols#ec2QueryName": "ConnectionStatuses", - "smithy.api#documentation": "

The current state of the client connections.

", - "smithy.api#xmlName": "connectionStatuses" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#TerminateConnectionStatus": { - "type": "structure", - "members": { - "ConnectionId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ConnectionId", - "smithy.api#documentation": "

The ID of the client connection.

", - "smithy.api#xmlName": "connectionId" - } - }, - "PreviousStatus": { - "target": "com.amazonaws.ec2#ClientVpnConnectionStatus", - "traits": { - "aws.protocols#ec2QueryName": "PreviousStatus", - "smithy.api#documentation": "

The state of the client connection.

", - "smithy.api#xmlName": "previousStatus" - } - }, - "CurrentStatus": { - "target": "com.amazonaws.ec2#ClientVpnConnectionStatus", - "traits": { - "aws.protocols#ec2QueryName": "CurrentStatus", - "smithy.api#documentation": "

A message about the status of the client connection, if applicable.

", - "smithy.api#xmlName": "currentStatus" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a terminated Client VPN endpoint client connection.

" - } - }, - "com.amazonaws.ec2#TerminateConnectionStatusSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TerminateConnectionStatus", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TerminateInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#TerminateInstancesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#TerminateInstancesResult" - }, - "traits": { - "smithy.api#documentation": "

Shuts down the specified instances. This operation is idempotent; if you terminate an\n instance more than once, each call succeeds.

\n

If you specify multiple instances and the request fails (for example, because of a\n single incorrect instance ID), none of the instances are terminated.

\n

If you terminate multiple instances across multiple Availability Zones, and one or\n more of the specified instances are enabled for termination protection, the request\n fails with the following results:

\n \n

For example, say you have the following instances:

\n \n

If you attempt to terminate all of these instances in the same request, the request\n reports failure with the following results:

\n \n

Terminated instances remain visible after termination (for approximately one\n hour).

\n

By default, Amazon EC2 deletes all EBS volumes that were attached when the instance\n launched. Volumes attached after instance launch continue running.

\n

You can stop, start, and terminate EBS-backed instances. You can only terminate\n instance store-backed instances. What happens to an instance differs if you stop it or\n terminate it. For example, when you stop an instance, the root device and any other\n devices attached to the instance persist. When you terminate an instance, any attached\n EBS volumes with the DeleteOnTermination block device mapping parameter set\n to true are automatically deleted. For more information about the\n differences between stopping and terminating instances, see Instance lifecycle\n in the Amazon EC2 User Guide.

\n

For more information about troubleshooting, see Troubleshooting terminating your instance in the\n Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#TerminateInstancesRequest": { - "type": "structure", - "members": { - "InstanceIds": { - "target": "com.amazonaws.ec2#InstanceIdStringList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IDs of the instances.

\n

Constraints: Up to 1000 instance IDs. We recommend breaking up this request into\n smaller batches.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "InstanceId" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#TerminateInstancesResult": { - "type": "structure", - "members": { - "TerminatingInstances": { - "target": "com.amazonaws.ec2#InstanceStateChangeList", - "traits": { - "aws.protocols#ec2QueryName": "InstancesSet", - "smithy.api#documentation": "

Information about the terminated instances.

", - "smithy.api#xmlName": "instancesSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ThreadsPerCore": { - "type": "integer" - }, - "com.amazonaws.ec2#ThreadsPerCoreList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ThreadsPerCore", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ThroughResourcesStatement": { - "type": "structure", - "members": { - "ResourceStatement": { - "target": "com.amazonaws.ec2#ResourceStatement", - "traits": { - "aws.protocols#ec2QueryName": "ResourceStatement", - "smithy.api#documentation": "

The resource statement.

", - "smithy.api#xmlName": "resourceStatement" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a through resource statement.

" - } - }, - "com.amazonaws.ec2#ThroughResourcesStatementList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ThroughResourcesStatement", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#ThroughResourcesStatementRequest": { - "type": "structure", - "members": { - "ResourceStatement": { - "target": "com.amazonaws.ec2#ResourceStatementRequest", - "traits": { - "smithy.api#documentation": "

The resource statement.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a through resource statement.

" - } - }, - "com.amazonaws.ec2#ThroughResourcesStatementRequestList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#ThroughResourcesStatementRequest", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TieringOperationStatus": { - "type": "enum", - "members": { - "archival_in_progress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "archival-in-progress" - } - }, - "archival_completed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "archival-completed" - } - }, - "archival_failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "archival-failed" - } - }, - "temporary_restore_in_progress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "temporary-restore-in-progress" - } - }, - "temporary_restore_completed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "temporary-restore-completed" - } - }, - "temporary_restore_failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "temporary-restore-failed" - } - }, - "permanent_restore_in_progress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "permanent-restore-in-progress" - } - }, - "permanent_restore_completed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "permanent-restore-completed" - } - }, - "permanent_restore_failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "permanent-restore-failed" - } - } - } - }, - "com.amazonaws.ec2#TotalLocalStorageGB": { - "type": "structure", - "members": { - "Min": { - "target": "com.amazonaws.ec2#Double", - "traits": { - "aws.protocols#ec2QueryName": "Min", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum amount of total local storage, in GB. If this parameter is not specified, there is\n no minimum limit.

", - "smithy.api#xmlName": "min" - } - }, - "Max": { - "target": "com.amazonaws.ec2#Double", - "traits": { - "aws.protocols#ec2QueryName": "Max", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum amount of total local storage, in GB. If this parameter is not specified, there is\n no maximum limit.

", - "smithy.api#xmlName": "max" - } - } - }, - "traits": { - "smithy.api#documentation": "

The minimum and maximum amount of total local storage, in GB.

" - } - }, - "com.amazonaws.ec2#TotalLocalStorageGBRequest": { - "type": "structure", - "members": { - "Min": { - "target": "com.amazonaws.ec2#Double", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum amount of total local storage, in GB. To specify no minimum limit, omit this\n parameter.

" - } - }, - "Max": { - "target": "com.amazonaws.ec2#Double", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum amount of total local storage, in GB. To specify no maximum limit, omit this\n parameter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The minimum and maximum amount of total local storage, in GB.

" - } - }, - "com.amazonaws.ec2#TpmSupportValues": { - "type": "enum", - "members": { - "v2_0": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "v2.0" - } - } - } - }, - "com.amazonaws.ec2#TrafficDirection": { - "type": "enum", - "members": { - "ingress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ingress" - } - }, - "egress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "egress" - } - } - } - }, - "com.amazonaws.ec2#TrafficMirrorFilter": { - "type": "structure", - "members": { - "TrafficMirrorFilterId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TrafficMirrorFilterId", - "smithy.api#documentation": "

The ID of the Traffic Mirror filter.

", - "smithy.api#xmlName": "trafficMirrorFilterId" - } - }, - "IngressFilterRules": { - "target": "com.amazonaws.ec2#TrafficMirrorFilterRuleList", - "traits": { - "aws.protocols#ec2QueryName": "IngressFilterRuleSet", - "smithy.api#documentation": "

Information about the ingress rules that are associated with the Traffic Mirror filter.

", - "smithy.api#xmlName": "ingressFilterRuleSet" - } - }, - "EgressFilterRules": { - "target": "com.amazonaws.ec2#TrafficMirrorFilterRuleList", - "traits": { - "aws.protocols#ec2QueryName": "EgressFilterRuleSet", - "smithy.api#documentation": "

Information about the egress rules that are associated with the Traffic Mirror filter.

", - "smithy.api#xmlName": "egressFilterRuleSet" - } - }, - "NetworkServices": { - "target": "com.amazonaws.ec2#TrafficMirrorNetworkServiceList", - "traits": { - "aws.protocols#ec2QueryName": "NetworkServiceSet", - "smithy.api#documentation": "

The network service traffic that is associated with the Traffic Mirror filter.

", - "smithy.api#xmlName": "networkServiceSet" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

The description of the Traffic Mirror filter.

", - "smithy.api#xmlName": "description" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags assigned to the Traffic Mirror filter.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the Traffic Mirror filter.

" - } - }, - "com.amazonaws.ec2#TrafficMirrorFilterId": { - "type": "string" - }, - "com.amazonaws.ec2#TrafficMirrorFilterIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TrafficMirrorFilterId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TrafficMirrorFilterRule": { - "type": "structure", - "members": { - "TrafficMirrorFilterRuleId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TrafficMirrorFilterRuleId", - "smithy.api#documentation": "

The ID of the Traffic Mirror rule.

", - "smithy.api#xmlName": "trafficMirrorFilterRuleId" - } - }, - "TrafficMirrorFilterId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TrafficMirrorFilterId", - "smithy.api#documentation": "

The ID of the Traffic Mirror filter that the rule is associated with.

", - "smithy.api#xmlName": "trafficMirrorFilterId" - } - }, - "TrafficDirection": { - "target": "com.amazonaws.ec2#TrafficDirection", - "traits": { - "aws.protocols#ec2QueryName": "TrafficDirection", - "smithy.api#documentation": "

The traffic direction assigned to the Traffic Mirror rule.

", - "smithy.api#xmlName": "trafficDirection" - } - }, - "RuleNumber": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "RuleNumber", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The rule number of the Traffic Mirror rule.

", - "smithy.api#xmlName": "ruleNumber" - } - }, - "RuleAction": { - "target": "com.amazonaws.ec2#TrafficMirrorRuleAction", - "traits": { - "aws.protocols#ec2QueryName": "RuleAction", - "smithy.api#documentation": "

The action assigned to the Traffic Mirror rule.

", - "smithy.api#xmlName": "ruleAction" - } - }, - "Protocol": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Protocol", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The protocol assigned to the Traffic Mirror rule.

", - "smithy.api#xmlName": "protocol" - } - }, - "DestinationPortRange": { - "target": "com.amazonaws.ec2#TrafficMirrorPortRange", - "traits": { - "aws.protocols#ec2QueryName": "DestinationPortRange", - "smithy.api#documentation": "

The destination port range assigned to the Traffic Mirror rule.

", - "smithy.api#xmlName": "destinationPortRange" - } - }, - "SourcePortRange": { - "target": "com.amazonaws.ec2#TrafficMirrorPortRange", - "traits": { - "aws.protocols#ec2QueryName": "SourcePortRange", - "smithy.api#documentation": "

The source port range assigned to the Traffic Mirror rule.

", - "smithy.api#xmlName": "sourcePortRange" - } - }, - "DestinationCidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DestinationCidrBlock", - "smithy.api#documentation": "

The destination CIDR block assigned to the Traffic Mirror rule.

", - "smithy.api#xmlName": "destinationCidrBlock" - } - }, - "SourceCidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SourceCidrBlock", - "smithy.api#documentation": "

The source CIDR block assigned to the Traffic Mirror rule.

", - "smithy.api#xmlName": "sourceCidrBlock" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

The description of the Traffic Mirror rule.

", - "smithy.api#xmlName": "description" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the Traffic Mirror rule.

" - } - }, - "com.amazonaws.ec2#TrafficMirrorFilterRuleField": { - "type": "enum", - "members": { - "destination_port_range": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "destination-port-range" - } - }, - "source_port_range": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "source-port-range" - } - }, - "protocol": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "protocol" - } - }, - "description": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "description" - } - } - } - }, - "com.amazonaws.ec2#TrafficMirrorFilterRuleFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TrafficMirrorFilterRuleField" - } - }, - "com.amazonaws.ec2#TrafficMirrorFilterRuleIdWithResolver": { - "type": "string" - }, - "com.amazonaws.ec2#TrafficMirrorFilterRuleList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TrafficMirrorFilterRule", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TrafficMirrorFilterSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TrafficMirrorFilter", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TrafficMirrorNetworkService": { - "type": "enum", - "members": { - "amazon_dns": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "amazon-dns" - } - } - } - }, - "com.amazonaws.ec2#TrafficMirrorNetworkServiceList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TrafficMirrorNetworkService", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TrafficMirrorPortRange": { - "type": "structure", - "members": { - "FromPort": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "FromPort", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.

", - "smithy.api#xmlName": "fromPort" - } - }, - "ToPort": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "ToPort", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.

", - "smithy.api#xmlName": "toPort" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the Traffic Mirror port range.

" - } - }, - "com.amazonaws.ec2#TrafficMirrorPortRangeRequest": { - "type": "structure", - "members": { - "FromPort": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The first port in the Traffic Mirror port range. This applies to the TCP and UDP protocols.

" - } - }, - "ToPort": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The last port in the Traffic Mirror port range. This applies to the TCP and UDP protocols.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the Traffic Mirror filter rule port range.

" - } - }, - "com.amazonaws.ec2#TrafficMirrorRuleAction": { - "type": "enum", - "members": { - "accept": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "accept" - } - }, - "reject": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "reject" - } - } - } - }, - "com.amazonaws.ec2#TrafficMirrorSession": { - "type": "structure", - "members": { - "TrafficMirrorSessionId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TrafficMirrorSessionId", - "smithy.api#documentation": "

The ID for the Traffic Mirror session.

", - "smithy.api#xmlName": "trafficMirrorSessionId" - } - }, - "TrafficMirrorTargetId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TrafficMirrorTargetId", - "smithy.api#documentation": "

The ID of the Traffic Mirror target.

", - "smithy.api#xmlName": "trafficMirrorTargetId" - } - }, - "TrafficMirrorFilterId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TrafficMirrorFilterId", - "smithy.api#documentation": "

The ID of the Traffic Mirror filter.

", - "smithy.api#xmlName": "trafficMirrorFilterId" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "

The ID of the Traffic Mirror session's network interface.

", - "smithy.api#xmlName": "networkInterfaceId" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the account that owns the Traffic Mirror session.

", - "smithy.api#xmlName": "ownerId" - } - }, - "PacketLength": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "PacketLength", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#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

", - "smithy.api#xmlName": "packetLength" - } - }, - "SessionNumber": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "SessionNumber", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#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.

\n

Valid values are 1-32766.

", - "smithy.api#xmlName": "sessionNumber" - } - }, - "VirtualNetworkId": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "VirtualNetworkId", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The virtual network ID associated with the Traffic Mirror session.

", - "smithy.api#xmlName": "virtualNetworkId" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

The description of the Traffic Mirror session.

", - "smithy.api#xmlName": "description" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags assigned to the Traffic Mirror session.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a Traffic Mirror session.

" - } - }, - "com.amazonaws.ec2#TrafficMirrorSessionField": { - "type": "enum", - "members": { - "packet_length": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "packet-length" - } - }, - "description": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "description" - } - }, - "virtual_network_id": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "virtual-network-id" - } - } - } - }, - "com.amazonaws.ec2#TrafficMirrorSessionFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TrafficMirrorSessionField" - } - }, - "com.amazonaws.ec2#TrafficMirrorSessionId": { - "type": "string" - }, - "com.amazonaws.ec2#TrafficMirrorSessionIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TrafficMirrorSessionId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TrafficMirrorSessionSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TrafficMirrorSession", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TrafficMirrorTarget": { - "type": "structure", - "members": { - "TrafficMirrorTargetId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TrafficMirrorTargetId", - "smithy.api#documentation": "

The ID of the Traffic Mirror target.

", - "smithy.api#xmlName": "trafficMirrorTargetId" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "

The network interface ID that is attached to the target.

", - "smithy.api#xmlName": "networkInterfaceId" - } - }, - "NetworkLoadBalancerArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NetworkLoadBalancerArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Network Load Balancer.

", - "smithy.api#xmlName": "networkLoadBalancerArn" - } - }, - "Type": { - "target": "com.amazonaws.ec2#TrafficMirrorTargetType", - "traits": { - "aws.protocols#ec2QueryName": "Type", - "smithy.api#documentation": "

The type of Traffic Mirror target.

", - "smithy.api#xmlName": "type" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

Information about the Traffic Mirror target.

", - "smithy.api#xmlName": "description" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the account that owns the Traffic Mirror target.

", - "smithy.api#xmlName": "ownerId" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags assigned to the Traffic Mirror target.

", - "smithy.api#xmlName": "tagSet" - } - }, - "GatewayLoadBalancerEndpointId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GatewayLoadBalancerEndpointId", - "smithy.api#documentation": "

The ID of the Gateway Load Balancer endpoint.

", - "smithy.api#xmlName": "gatewayLoadBalancerEndpointId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a Traffic Mirror target.

" - } - }, - "com.amazonaws.ec2#TrafficMirrorTargetId": { - "type": "string" - }, - "com.amazonaws.ec2#TrafficMirrorTargetIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TrafficMirrorTargetId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TrafficMirrorTargetSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TrafficMirrorTarget", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TrafficMirrorTargetType": { - "type": "enum", - "members": { - "network_interface": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "network-interface" - } - }, - "network_load_balancer": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "network-load-balancer" - } - }, - "gateway_load_balancer_endpoint": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "gateway-load-balancer-endpoint" - } - } - } - }, - "com.amazonaws.ec2#TrafficMirroringMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#TrafficType": { - "type": "enum", - "members": { - "ACCEPT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACCEPT" - } - }, - "REJECT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REJECT" - } - }, - "ALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL" - } - } - } - }, - "com.amazonaws.ec2#TransitAssociationGatewayId": { - "type": "string" - }, - "com.amazonaws.ec2#TransitGateway": { - "type": "structure", - "members": { - "TransitGatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayId", - "smithy.api#documentation": "

The ID of the transit gateway.

", - "smithy.api#xmlName": "transitGatewayId" - } - }, - "TransitGatewayArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the transit gateway.

", - "smithy.api#xmlName": "transitGatewayArn" - } - }, - "State": { - "target": "com.amazonaws.ec2#TransitGatewayState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the transit gateway.

", - "smithy.api#xmlName": "state" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the transit gateway.

", - "smithy.api#xmlName": "ownerId" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

The description of the transit gateway.

", - "smithy.api#xmlName": "description" - } - }, - "CreationTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "CreationTime", - "smithy.api#documentation": "

The creation time.

", - "smithy.api#xmlName": "creationTime" - } - }, - "Options": { - "target": "com.amazonaws.ec2#TransitGatewayOptions", - "traits": { - "aws.protocols#ec2QueryName": "Options", - "smithy.api#documentation": "

The transit gateway options.

", - "smithy.api#xmlName": "options" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags for the transit gateway.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a transit gateway.

" - } - }, - "com.amazonaws.ec2#TransitGatewayAssociation": { - "type": "structure", - "members": { - "TransitGatewayRouteTableId": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayRouteTableId", - "smithy.api#documentation": "

The ID of the transit gateway route table.

", - "smithy.api#xmlName": "transitGatewayRouteTableId" - } - }, - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", - "smithy.api#documentation": "

The ID of the attachment.

", - "smithy.api#xmlName": "transitGatewayAttachmentId" - } - }, - "ResourceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceId", - "smithy.api#documentation": "

The ID of the resource.

", - "smithy.api#xmlName": "resourceId" - } - }, - "ResourceType": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", - "traits": { - "aws.protocols#ec2QueryName": "ResourceType", - "smithy.api#documentation": "

The resource type. Note that the tgw-peering resource type has been deprecated.

", - "smithy.api#xmlName": "resourceType" - } - }, - "State": { - "target": "com.amazonaws.ec2#TransitGatewayAssociationState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the association.

", - "smithy.api#xmlName": "state" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an association between a resource attachment and a transit gateway route table.

" - } - }, - "com.amazonaws.ec2#TransitGatewayAssociationState": { - "type": "enum", - "members": { - "associating": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "associating" - } - }, - "associated": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "associated" - } - }, - "disassociating": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disassociating" - } - }, - "disassociated": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disassociated" - } - } - } - }, - "com.amazonaws.ec2#TransitGatewayAttachment": { - "type": "structure", - "members": { - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", - "smithy.api#documentation": "

The ID of the attachment.

", - "smithy.api#xmlName": "transitGatewayAttachmentId" - } - }, - "TransitGatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayId", - "smithy.api#documentation": "

The ID of the transit gateway.

", - "smithy.api#xmlName": "transitGatewayId" - } - }, - "TransitGatewayOwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayOwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the transit gateway.

", - "smithy.api#xmlName": "transitGatewayOwnerId" - } - }, - "ResourceOwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceOwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the resource.

", - "smithy.api#xmlName": "resourceOwnerId" - } - }, - "ResourceType": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", - "traits": { - "aws.protocols#ec2QueryName": "ResourceType", - "smithy.api#documentation": "

The resource type. Note that the tgw-peering resource type has been deprecated.

", - "smithy.api#xmlName": "resourceType" - } - }, - "ResourceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceId", - "smithy.api#documentation": "

The ID of the resource.

", - "smithy.api#xmlName": "resourceId" - } - }, - "State": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The attachment state. Note that the initiating state has been deprecated.

", - "smithy.api#xmlName": "state" - } - }, - "Association": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentAssociation", - "traits": { - "aws.protocols#ec2QueryName": "Association", - "smithy.api#documentation": "

The association.

", - "smithy.api#xmlName": "association" - } - }, - "CreationTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "CreationTime", - "smithy.api#documentation": "

The creation time.

", - "smithy.api#xmlName": "creationTime" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags for the attachment.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an attachment between a resource and a transit gateway.

" - } - }, - "com.amazonaws.ec2#TransitGatewayAttachmentAssociation": { - "type": "structure", - "members": { - "TransitGatewayRouteTableId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayRouteTableId", - "smithy.api#documentation": "

The ID of the route table for the transit gateway.

", - "smithy.api#xmlName": "transitGatewayRouteTableId" - } - }, - "State": { - "target": "com.amazonaws.ec2#TransitGatewayAssociationState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the association.

", - "smithy.api#xmlName": "state" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an association.

" - } - }, - "com.amazonaws.ec2#TransitGatewayAttachmentBgpConfiguration": { - "type": "structure", - "members": { - "TransitGatewayAsn": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayAsn", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The transit gateway Autonomous System Number (ASN).

", - "smithy.api#xmlName": "transitGatewayAsn" - } - }, - "PeerAsn": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "aws.protocols#ec2QueryName": "PeerAsn", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The peer Autonomous System Number (ASN).

", - "smithy.api#xmlName": "peerAsn" - } - }, - "TransitGatewayAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayAddress", - "smithy.api#documentation": "

The interior BGP peer IP address for the transit gateway.

", - "smithy.api#xmlName": "transitGatewayAddress" - } - }, - "PeerAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PeerAddress", - "smithy.api#documentation": "

The interior BGP peer IP address for the appliance.

", - "smithy.api#xmlName": "peerAddress" - } - }, - "BgpStatus": { - "target": "com.amazonaws.ec2#BgpStatus", - "traits": { - "aws.protocols#ec2QueryName": "BgpStatus", - "smithy.api#documentation": "

The BGP status.

", - "smithy.api#xmlName": "bgpStatus" - } - } - }, - "traits": { - "smithy.api#documentation": "

The BGP configuration information.

" - } - }, - "com.amazonaws.ec2#TransitGatewayAttachmentBgpConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentBgpConfiguration", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TransitGatewayAttachmentId": { - "type": "string" - }, - "com.amazonaws.ec2#TransitGatewayAttachmentIdStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId" - } - }, - "com.amazonaws.ec2#TransitGatewayAttachmentList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TransitGatewayAttachment", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TransitGatewayAttachmentPropagation": { - "type": "structure", - "members": { - "TransitGatewayRouteTableId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayRouteTableId", - "smithy.api#documentation": "

The ID of the propagation route table.

", - "smithy.api#xmlName": "transitGatewayRouteTableId" - } - }, - "State": { - "target": "com.amazonaws.ec2#TransitGatewayPropagationState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the propagation route table.

", - "smithy.api#xmlName": "state" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a propagation route table.

" - } - }, - "com.amazonaws.ec2#TransitGatewayAttachmentPropagationList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentPropagation", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TransitGatewayAttachmentResourceType": { - "type": "enum", - "members": { - "vpc": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "vpc" - } - }, - "vpn": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "vpn" - } - }, - "direct_connect_gateway": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "direct-connect-gateway" - } - }, - "connect": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "connect" - } - }, - "peering": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "peering" - } - }, - "tgw_peering": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "tgw-peering" - } - } - } - }, - "com.amazonaws.ec2#TransitGatewayAttachmentState": { - "type": "enum", - "members": { - "initiating": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "initiating" - } - }, - "initiatingRequest": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "initiatingRequest" - } - }, - "pendingAcceptance": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pendingAcceptance" - } - }, - "rollingBack": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "rollingBack" - } - }, - "pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "available": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "available" - } - }, - "modifying": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "modifying" - } - }, - "deleting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleting" - } - }, - "deleted": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleted" - } - }, - "failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failed" - } - }, - "rejected": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "rejected" - } - }, - "rejecting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "rejecting" - } - }, - "failing": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failing" - } - } - } - }, - "com.amazonaws.ec2#TransitGatewayCidrBlockStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TransitGatewayConnect": { - "type": "structure", - "members": { - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", - "smithy.api#documentation": "

The ID of the Connect attachment.

", - "smithy.api#xmlName": "transitGatewayAttachmentId" - } - }, - "TransportTransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", - "traits": { - "aws.protocols#ec2QueryName": "TransportTransitGatewayAttachmentId", - "smithy.api#documentation": "

The ID of the attachment from which the Connect attachment was created.

", - "smithy.api#xmlName": "transportTransitGatewayAttachmentId" - } - }, - "TransitGatewayId": { - "target": "com.amazonaws.ec2#TransitGatewayId", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayId", - "smithy.api#documentation": "

The ID of the transit gateway.

", - "smithy.api#xmlName": "transitGatewayId" - } - }, - "State": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the attachment.

", - "smithy.api#xmlName": "state" - } - }, - "CreationTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "CreationTime", - "smithy.api#documentation": "

The creation time.

", - "smithy.api#xmlName": "creationTime" - } - }, - "Options": { - "target": "com.amazonaws.ec2#TransitGatewayConnectOptions", - "traits": { - "aws.protocols#ec2QueryName": "Options", - "smithy.api#documentation": "

The Connect attachment options.

", - "smithy.api#xmlName": "options" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags for the attachment.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a transit gateway Connect attachment.

" - } - }, - "com.amazonaws.ec2#TransitGatewayConnectList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TransitGatewayConnect", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TransitGatewayConnectOptions": { - "type": "structure", - "members": { - "Protocol": { - "target": "com.amazonaws.ec2#ProtocolValue", - "traits": { - "aws.protocols#ec2QueryName": "Protocol", - "smithy.api#documentation": "

The tunnel protocol.

", - "smithy.api#xmlName": "protocol" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the Connect attachment options.

" - } - }, - "com.amazonaws.ec2#TransitGatewayConnectPeer": { - "type": "structure", - "members": { - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", - "smithy.api#documentation": "

The ID of the Connect attachment.

", - "smithy.api#xmlName": "transitGatewayAttachmentId" - } - }, - "TransitGatewayConnectPeerId": { - "target": "com.amazonaws.ec2#TransitGatewayConnectPeerId", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayConnectPeerId", - "smithy.api#documentation": "

The ID of the Connect peer.

", - "smithy.api#xmlName": "transitGatewayConnectPeerId" - } - }, - "State": { - "target": "com.amazonaws.ec2#TransitGatewayConnectPeerState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the Connect peer.

", - "smithy.api#xmlName": "state" - } - }, - "CreationTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "CreationTime", - "smithy.api#documentation": "

The creation time.

", - "smithy.api#xmlName": "creationTime" - } - }, - "ConnectPeerConfiguration": { - "target": "com.amazonaws.ec2#TransitGatewayConnectPeerConfiguration", - "traits": { - "aws.protocols#ec2QueryName": "ConnectPeerConfiguration", - "smithy.api#documentation": "

The Connect peer details.

", - "smithy.api#xmlName": "connectPeerConfiguration" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags for the Connect peer.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a transit gateway Connect peer.

" - } - }, - "com.amazonaws.ec2#TransitGatewayConnectPeerConfiguration": { - "type": "structure", - "members": { - "TransitGatewayAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayAddress", - "smithy.api#documentation": "

The Connect peer IP address on the transit gateway side of the tunnel.

", - "smithy.api#xmlName": "transitGatewayAddress" - } - }, - "PeerAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PeerAddress", - "smithy.api#documentation": "

The Connect peer IP address on the appliance side of the tunnel.

", - "smithy.api#xmlName": "peerAddress" - } - }, - "InsideCidrBlocks": { - "target": "com.amazonaws.ec2#InsideCidrBlocksStringList", - "traits": { - "aws.protocols#ec2QueryName": "InsideCidrBlocks", - "smithy.api#documentation": "

The range of interior BGP peer IP addresses.

", - "smithy.api#xmlName": "insideCidrBlocks" - } - }, - "Protocol": { - "target": "com.amazonaws.ec2#ProtocolValue", - "traits": { - "aws.protocols#ec2QueryName": "Protocol", - "smithy.api#documentation": "

The tunnel protocol.

", - "smithy.api#xmlName": "protocol" - } - }, - "BgpConfigurations": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentBgpConfigurationList", - "traits": { - "aws.protocols#ec2QueryName": "BgpConfigurations", - "smithy.api#documentation": "

The BGP configuration details.

", - "smithy.api#xmlName": "bgpConfigurations" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the Connect peer details.

" - } - }, - "com.amazonaws.ec2#TransitGatewayConnectPeerId": { - "type": "string" - }, - "com.amazonaws.ec2#TransitGatewayConnectPeerIdStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TransitGatewayConnectPeerId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TransitGatewayConnectPeerList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TransitGatewayConnectPeer", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TransitGatewayConnectPeerState": { - "type": "enum", - "members": { - "pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "available": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "available" - } - }, - "deleting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleting" - } - }, - "deleted": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleted" - } - } - } - }, - "com.amazonaws.ec2#TransitGatewayConnectRequestBgpOptions": { - "type": "structure", - "members": { - "PeerAsn": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The peer Autonomous System Number (ASN).

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The BGP options for the Connect attachment.

" - } - }, - "com.amazonaws.ec2#TransitGatewayId": { - "type": "string" - }, - "com.amazonaws.ec2#TransitGatewayIdStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TransitGatewayId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TransitGatewayList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TransitGateway", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TransitGatewayMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 5, - "max": 1000 - } - } - }, - "com.amazonaws.ec2#TransitGatewayMulitcastDomainAssociationState": { - "type": "enum", - "members": { - "pendingAcceptance": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pendingAcceptance" - } - }, - "associating": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "associating" - } - }, - "associated": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "associated" - } - }, - "disassociating": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disassociating" - } - }, - "disassociated": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disassociated" - } - }, - "rejected": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "rejected" - } - }, - "failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failed" - } - } - } - }, - "com.amazonaws.ec2#TransitGatewayMulticastDeregisteredGroupMembers": { - "type": "structure", - "members": { - "TransitGatewayMulticastDomainId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayMulticastDomainId", - "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", - "smithy.api#xmlName": "transitGatewayMulticastDomainId" - } - }, - "DeregisteredNetworkInterfaceIds": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "DeregisteredNetworkInterfaceIds", - "smithy.api#documentation": "

The network interface IDs of the deregistered members.

", - "smithy.api#xmlName": "deregisteredNetworkInterfaceIds" - } - }, - "GroupIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupIpAddress", - "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

", - "smithy.api#xmlName": "groupIpAddress" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the deregistered transit gateway multicast group members.

" - } - }, - "com.amazonaws.ec2#TransitGatewayMulticastDeregisteredGroupSources": { - "type": "structure", - "members": { - "TransitGatewayMulticastDomainId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayMulticastDomainId", - "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", - "smithy.api#xmlName": "transitGatewayMulticastDomainId" - } - }, - "DeregisteredNetworkInterfaceIds": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "DeregisteredNetworkInterfaceIds", - "smithy.api#documentation": "

The network interface IDs of the non-registered members.

", - "smithy.api#xmlName": "deregisteredNetworkInterfaceIds" - } - }, - "GroupIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupIpAddress", - "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

", - "smithy.api#xmlName": "groupIpAddress" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the deregistered transit gateway multicast group sources.

" - } - }, - "com.amazonaws.ec2#TransitGatewayMulticastDomain": { - "type": "structure", - "members": { - "TransitGatewayMulticastDomainId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayMulticastDomainId", - "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", - "smithy.api#xmlName": "transitGatewayMulticastDomainId" - } - }, - "TransitGatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayId", - "smithy.api#documentation": "

The ID of the transit gateway.

", - "smithy.api#xmlName": "transitGatewayId" - } - }, - "TransitGatewayMulticastDomainArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayMulticastDomainArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the transit gateway multicast domain.

", - "smithy.api#xmlName": "transitGatewayMulticastDomainArn" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the transit gateway multicast domain.

", - "smithy.api#xmlName": "ownerId" - } - }, - "Options": { - "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainOptions", - "traits": { - "aws.protocols#ec2QueryName": "Options", - "smithy.api#documentation": "

The options for the transit gateway multicast domain.

", - "smithy.api#xmlName": "options" - } - }, - "State": { - "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the transit gateway multicast domain.

", - "smithy.api#xmlName": "state" - } - }, - "CreationTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "CreationTime", - "smithy.api#documentation": "

The time the transit gateway multicast domain was created.

", - "smithy.api#xmlName": "creationTime" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags for the transit gateway multicast domain.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the transit gateway multicast domain.

" - } - }, - "com.amazonaws.ec2#TransitGatewayMulticastDomainAssociation": { - "type": "structure", - "members": { - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", - "smithy.api#documentation": "

The ID of the transit gateway attachment.

", - "smithy.api#xmlName": "transitGatewayAttachmentId" - } - }, - "ResourceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceId", - "smithy.api#documentation": "

The ID of the resource.

", - "smithy.api#xmlName": "resourceId" - } - }, - "ResourceType": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", - "traits": { - "aws.protocols#ec2QueryName": "ResourceType", - "smithy.api#documentation": "

The type of resource, for example a VPC attachment.

", - "smithy.api#xmlName": "resourceType" - } - }, - "ResourceOwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceOwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the transit gateway multicast domain association resource.

", - "smithy.api#xmlName": "resourceOwnerId" - } - }, - "Subnet": { - "target": "com.amazonaws.ec2#SubnetAssociation", - "traits": { - "aws.protocols#ec2QueryName": "Subnet", - "smithy.api#documentation": "

The subnet associated with the transit gateway multicast domain.

", - "smithy.api#xmlName": "subnet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the resources associated with the transit gateway multicast domain.

" - } - }, - "com.amazonaws.ec2#TransitGatewayMulticastDomainAssociationList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainAssociation", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TransitGatewayMulticastDomainAssociations": { - "type": "structure", - "members": { - "TransitGatewayMulticastDomainId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayMulticastDomainId", - "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", - "smithy.api#xmlName": "transitGatewayMulticastDomainId" - } - }, - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", - "smithy.api#documentation": "

The ID of the transit gateway attachment.

", - "smithy.api#xmlName": "transitGatewayAttachmentId" - } - }, - "ResourceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceId", - "smithy.api#documentation": "

The ID of the resource.

", - "smithy.api#xmlName": "resourceId" - } - }, - "ResourceType": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", - "traits": { - "aws.protocols#ec2QueryName": "ResourceType", - "smithy.api#documentation": "

The type of resource, for example a VPC attachment.

", - "smithy.api#xmlName": "resourceType" - } - }, - "ResourceOwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceOwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the resource.

", - "smithy.api#xmlName": "resourceOwnerId" - } - }, - "Subnets": { - "target": "com.amazonaws.ec2#SubnetAssociationList", - "traits": { - "aws.protocols#ec2QueryName": "Subnets", - "smithy.api#documentation": "

The subnets associated with the multicast domain.

", - "smithy.api#xmlName": "subnets" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the multicast domain associations.

" - } - }, - "com.amazonaws.ec2#TransitGatewayMulticastDomainId": { - "type": "string" - }, - "com.amazonaws.ec2#TransitGatewayMulticastDomainIdStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TransitGatewayMulticastDomainList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TransitGatewayMulticastDomain", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TransitGatewayMulticastDomainOptions": { - "type": "structure", - "members": { - "Igmpv2Support": { - "target": "com.amazonaws.ec2#Igmpv2SupportValue", - "traits": { - "aws.protocols#ec2QueryName": "Igmpv2Support", - "smithy.api#documentation": "

Indicates whether Internet Group Management Protocol (IGMP) version 2 is turned on for the transit gateway multicast domain.

", - "smithy.api#xmlName": "igmpv2Support" - } - }, - "StaticSourcesSupport": { - "target": "com.amazonaws.ec2#StaticSourcesSupportValue", - "traits": { - "aws.protocols#ec2QueryName": "StaticSourcesSupport", - "smithy.api#documentation": "

Indicates whether support for statically configuring transit gateway multicast group sources is turned on.

", - "smithy.api#xmlName": "staticSourcesSupport" - } - }, - "AutoAcceptSharedAssociations": { - "target": "com.amazonaws.ec2#AutoAcceptSharedAssociationsValue", - "traits": { - "aws.protocols#ec2QueryName": "AutoAcceptSharedAssociations", - "smithy.api#documentation": "

Indicates whether to automatically cross-account subnet associations that are associated with the transit gateway multicast domain.

", - "smithy.api#xmlName": "autoAcceptSharedAssociations" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the options for a transit gateway multicast domain.

" - } - }, - "com.amazonaws.ec2#TransitGatewayMulticastDomainState": { - "type": "enum", - "members": { - "pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "available": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "available" - } - }, - "deleting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleting" - } - }, - "deleted": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleted" - } - } - } - }, - "com.amazonaws.ec2#TransitGatewayMulticastGroup": { - "type": "structure", - "members": { - "GroupIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupIpAddress", - "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

", - "smithy.api#xmlName": "groupIpAddress" - } - }, - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", - "smithy.api#documentation": "

The ID of the transit gateway attachment.

", - "smithy.api#xmlName": "transitGatewayAttachmentId" - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#documentation": "

The ID of the subnet.

", - "smithy.api#xmlName": "subnetId" - } - }, - "ResourceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceId", - "smithy.api#documentation": "

The ID of the resource.

", - "smithy.api#xmlName": "resourceId" - } - }, - "ResourceType": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", - "traits": { - "aws.protocols#ec2QueryName": "ResourceType", - "smithy.api#documentation": "

The type of resource, for example a VPC attachment.

", - "smithy.api#xmlName": "resourceType" - } - }, - "ResourceOwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceOwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the transit gateway multicast domain group resource.

", - "smithy.api#xmlName": "resourceOwnerId" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "

The ID of the transit gateway attachment.

", - "smithy.api#xmlName": "networkInterfaceId" - } - }, - "GroupMember": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "GroupMember", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates that the resource is a transit gateway multicast group member.

", - "smithy.api#xmlName": "groupMember" - } - }, - "GroupSource": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "GroupSource", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates that the resource is a transit gateway multicast group member.

", - "smithy.api#xmlName": "groupSource" - } - }, - "MemberType": { - "target": "com.amazonaws.ec2#MembershipType", - "traits": { - "aws.protocols#ec2QueryName": "MemberType", - "smithy.api#documentation": "

The member type (for example, static).

", - "smithy.api#xmlName": "memberType" - } - }, - "SourceType": { - "target": "com.amazonaws.ec2#MembershipType", - "traits": { - "aws.protocols#ec2QueryName": "SourceType", - "smithy.api#documentation": "

The source type.

", - "smithy.api#xmlName": "sourceType" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the transit gateway multicast group resources.

" - } - }, - "com.amazonaws.ec2#TransitGatewayMulticastGroupList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TransitGatewayMulticastGroup", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TransitGatewayMulticastRegisteredGroupMembers": { - "type": "structure", - "members": { - "TransitGatewayMulticastDomainId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayMulticastDomainId", - "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", - "smithy.api#xmlName": "transitGatewayMulticastDomainId" - } - }, - "RegisteredNetworkInterfaceIds": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "RegisteredNetworkInterfaceIds", - "smithy.api#documentation": "

The ID of the registered network interfaces.

", - "smithy.api#xmlName": "registeredNetworkInterfaceIds" - } - }, - "GroupIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupIpAddress", - "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

", - "smithy.api#xmlName": "groupIpAddress" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the registered transit gateway multicast group members.

" - } - }, - "com.amazonaws.ec2#TransitGatewayMulticastRegisteredGroupSources": { - "type": "structure", - "members": { - "TransitGatewayMulticastDomainId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayMulticastDomainId", - "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", - "smithy.api#xmlName": "transitGatewayMulticastDomainId" - } - }, - "RegisteredNetworkInterfaceIds": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "RegisteredNetworkInterfaceIds", - "smithy.api#documentation": "

The IDs of the network interfaces members registered with the transit gateway multicast group.

", - "smithy.api#xmlName": "registeredNetworkInterfaceIds" - } - }, - "GroupIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupIpAddress", - "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

", - "smithy.api#xmlName": "groupIpAddress" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the members registered with the transit gateway multicast group.

" - } - }, - "com.amazonaws.ec2#TransitGatewayNetworkInterfaceIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#NetworkInterfaceId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TransitGatewayOptions": { - "type": "structure", - "members": { - "AmazonSideAsn": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "aws.protocols#ec2QueryName": "AmazonSideAsn", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

A private Autonomous System Number (ASN) for the Amazon side of a BGP session. \n The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.

", - "smithy.api#xmlName": "amazonSideAsn" - } - }, - "TransitGatewayCidrBlocks": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayCidrBlocks", - "smithy.api#documentation": "

The transit gateway CIDR blocks.

", - "smithy.api#xmlName": "transitGatewayCidrBlocks" - } - }, - "AutoAcceptSharedAttachments": { - "target": "com.amazonaws.ec2#AutoAcceptSharedAttachmentsValue", - "traits": { - "aws.protocols#ec2QueryName": "AutoAcceptSharedAttachments", - "smithy.api#documentation": "

Indicates whether attachment requests are automatically accepted.

", - "smithy.api#xmlName": "autoAcceptSharedAttachments" - } - }, - "DefaultRouteTableAssociation": { - "target": "com.amazonaws.ec2#DefaultRouteTableAssociationValue", - "traits": { - "aws.protocols#ec2QueryName": "DefaultRouteTableAssociation", - "smithy.api#documentation": "

Indicates whether resource attachments are automatically associated with the default association route table.

", - "smithy.api#xmlName": "defaultRouteTableAssociation" - } - }, - "AssociationDefaultRouteTableId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AssociationDefaultRouteTableId", - "smithy.api#documentation": "

The ID of the default association route table.

", - "smithy.api#xmlName": "associationDefaultRouteTableId" - } - }, - "DefaultRouteTablePropagation": { - "target": "com.amazonaws.ec2#DefaultRouteTablePropagationValue", - "traits": { - "aws.protocols#ec2QueryName": "DefaultRouteTablePropagation", - "smithy.api#documentation": "

Indicates whether resource attachments automatically propagate routes to the default propagation route table.

", - "smithy.api#xmlName": "defaultRouteTablePropagation" - } - }, - "PropagationDefaultRouteTableId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PropagationDefaultRouteTableId", - "smithy.api#documentation": "

The ID of the default propagation route table.

", - "smithy.api#xmlName": "propagationDefaultRouteTableId" - } - }, - "VpnEcmpSupport": { - "target": "com.amazonaws.ec2#VpnEcmpSupportValue", - "traits": { - "aws.protocols#ec2QueryName": "VpnEcmpSupport", - "smithy.api#documentation": "

Indicates whether Equal Cost Multipath Protocol support is enabled.

", - "smithy.api#xmlName": "vpnEcmpSupport" - } - }, - "DnsSupport": { - "target": "com.amazonaws.ec2#DnsSupportValue", - "traits": { - "aws.protocols#ec2QueryName": "DnsSupport", - "smithy.api#documentation": "

Indicates whether DNS support is enabled.

", - "smithy.api#xmlName": "dnsSupport" - } - }, - "MulticastSupport": { - "target": "com.amazonaws.ec2#MulticastSupportValue", - "traits": { - "aws.protocols#ec2QueryName": "MulticastSupport", - "smithy.api#documentation": "

Indicates whether multicast is enabled on the transit gateway

", - "smithy.api#xmlName": "multicastSupport" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the options for a transit gateway.

" - } - }, - "com.amazonaws.ec2#TransitGatewayPeeringAttachment": { - "type": "structure", - "members": { - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", - "smithy.api#documentation": "

The ID of the transit gateway peering attachment.

", - "smithy.api#xmlName": "transitGatewayAttachmentId" - } - }, - "AccepterTransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AccepterTransitGatewayAttachmentId", - "smithy.api#documentation": "

The ID of the accepter transit gateway attachment.

", - "smithy.api#xmlName": "accepterTransitGatewayAttachmentId" - } - }, - "RequesterTgwInfo": { - "target": "com.amazonaws.ec2#PeeringTgwInfo", - "traits": { - "aws.protocols#ec2QueryName": "RequesterTgwInfo", - "smithy.api#documentation": "

Information about the requester transit gateway.

", - "smithy.api#xmlName": "requesterTgwInfo" - } - }, - "AccepterTgwInfo": { - "target": "com.amazonaws.ec2#PeeringTgwInfo", - "traits": { - "aws.protocols#ec2QueryName": "AccepterTgwInfo", - "smithy.api#documentation": "

Information about the accepter transit gateway.

", - "smithy.api#xmlName": "accepterTgwInfo" - } - }, - "Options": { - "target": "com.amazonaws.ec2#TransitGatewayPeeringAttachmentOptions", - "traits": { - "aws.protocols#ec2QueryName": "Options", - "smithy.api#documentation": "

Details about the transit gateway peering attachment.

", - "smithy.api#xmlName": "options" - } - }, - "Status": { - "target": "com.amazonaws.ec2#PeeringAttachmentStatus", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The status of the transit gateway peering attachment.

", - "smithy.api#xmlName": "status" - } - }, - "State": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the transit gateway peering attachment. Note that the initiating state has been deprecated.

", - "smithy.api#xmlName": "state" - } - }, - "CreationTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "CreationTime", - "smithy.api#documentation": "

The time the transit gateway peering attachment was created.

", - "smithy.api#xmlName": "creationTime" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags for the transit gateway peering attachment.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the transit gateway peering attachment.

" - } - }, - "com.amazonaws.ec2#TransitGatewayPeeringAttachmentList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TransitGatewayPeeringAttachment", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TransitGatewayPeeringAttachmentOptions": { - "type": "structure", - "members": { - "DynamicRouting": { - "target": "com.amazonaws.ec2#DynamicRoutingValue", - "traits": { - "aws.protocols#ec2QueryName": "DynamicRouting", - "smithy.api#documentation": "

Describes whether dynamic routing is enabled or disabled for the transit gateway peering attachment.

", - "smithy.api#xmlName": "dynamicRouting" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes dynamic routing for the transit gateway peering attachment.

" - } - }, - "com.amazonaws.ec2#TransitGatewayPolicyRule": { - "type": "structure", - "members": { - "SourceCidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SourceCidrBlock", - "smithy.api#documentation": "

The source CIDR block for the transit gateway policy rule.

", - "smithy.api#xmlName": "sourceCidrBlock" - } - }, - "SourcePortRange": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SourcePortRange", - "smithy.api#documentation": "

The port range for the transit gateway policy rule. Currently this is set to * (all).

", - "smithy.api#xmlName": "sourcePortRange" - } - }, - "DestinationCidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DestinationCidrBlock", - "smithy.api#documentation": "

The destination CIDR block for the transit gateway policy rule.

", - "smithy.api#xmlName": "destinationCidrBlock" - } - }, - "DestinationPortRange": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DestinationPortRange", - "smithy.api#documentation": "

The port range for the transit gateway policy rule. Currently this is set to * (all).

", - "smithy.api#xmlName": "destinationPortRange" - } - }, - "Protocol": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Protocol", - "smithy.api#documentation": "

The protocol used by the transit gateway policy rule.

", - "smithy.api#xmlName": "protocol" - } - }, - "MetaData": { - "target": "com.amazonaws.ec2#TransitGatewayPolicyRuleMetaData", - "traits": { - "aws.protocols#ec2QueryName": "MetaData", - "smithy.api#documentation": "

The meta data tags used for the transit gateway policy rule.

", - "smithy.api#xmlName": "metaData" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a rule associated with a transit gateway policy.

" - } - }, - "com.amazonaws.ec2#TransitGatewayPolicyRuleMetaData": { - "type": "structure", - "members": { - "MetaDataKey": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "MetaDataKey", - "smithy.api#documentation": "

The key name for the transit gateway policy rule meta data tag.

", - "smithy.api#xmlName": "metaDataKey" - } - }, - "MetaDataValue": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "MetaDataValue", - "smithy.api#documentation": "

The value of the key for the transit gateway policy rule meta data tag.

", - "smithy.api#xmlName": "metaDataValue" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the meta data tags associated with a transit gateway policy rule.

" - } - }, - "com.amazonaws.ec2#TransitGatewayPolicyTable": { - "type": "structure", - "members": { - "TransitGatewayPolicyTableId": { - "target": "com.amazonaws.ec2#TransitGatewayPolicyTableId", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayPolicyTableId", - "smithy.api#documentation": "

The ID of the transit gateway policy table.

", - "smithy.api#xmlName": "transitGatewayPolicyTableId" - } - }, - "TransitGatewayId": { - "target": "com.amazonaws.ec2#TransitGatewayId", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayId", - "smithy.api#documentation": "

The ID of the transit gateway.

", - "smithy.api#xmlName": "transitGatewayId" - } - }, - "State": { - "target": "com.amazonaws.ec2#TransitGatewayPolicyTableState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the transit gateway policy table

", - "smithy.api#xmlName": "state" - } - }, - "CreationTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "CreationTime", - "smithy.api#documentation": "

The timestamp when the transit gateway policy table was created.

", - "smithy.api#xmlName": "creationTime" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

he key-value pairs associated with the transit gateway policy table.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a transit gateway policy table.

" - } - }, - "com.amazonaws.ec2#TransitGatewayPolicyTableAssociation": { - "type": "structure", - "members": { - "TransitGatewayPolicyTableId": { - "target": "com.amazonaws.ec2#TransitGatewayPolicyTableId", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayPolicyTableId", - "smithy.api#documentation": "

The ID of the transit gateway policy table.

", - "smithy.api#xmlName": "transitGatewayPolicyTableId" - } - }, - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", - "smithy.api#documentation": "

The ID of the transit gateway attachment.

", - "smithy.api#xmlName": "transitGatewayAttachmentId" - } - }, - "ResourceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceId", - "smithy.api#documentation": "

The resource ID of the transit gateway attachment.

", - "smithy.api#xmlName": "resourceId" - } - }, - "ResourceType": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", - "traits": { - "aws.protocols#ec2QueryName": "ResourceType", - "smithy.api#documentation": "

The resource type for the transit gateway policy table association.

", - "smithy.api#xmlName": "resourceType" - } - }, - "State": { - "target": "com.amazonaws.ec2#TransitGatewayAssociationState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the transit gateway policy table association.

", - "smithy.api#xmlName": "state" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a transit gateway policy table association.

" - } - }, - "com.amazonaws.ec2#TransitGatewayPolicyTableAssociationList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TransitGatewayPolicyTableAssociation", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TransitGatewayPolicyTableEntry": { - "type": "structure", - "members": { - "PolicyRuleNumber": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PolicyRuleNumber", - "smithy.api#documentation": "

The rule number for the transit gateway policy table entry.

", - "smithy.api#xmlName": "policyRuleNumber" - } - }, - "PolicyRule": { - "target": "com.amazonaws.ec2#TransitGatewayPolicyRule", - "traits": { - "aws.protocols#ec2QueryName": "PolicyRule", - "smithy.api#documentation": "

The policy rule associated with the transit gateway policy table.

", - "smithy.api#xmlName": "policyRule" - } - }, - "TargetRouteTableId": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", - "traits": { - "aws.protocols#ec2QueryName": "TargetRouteTableId", - "smithy.api#documentation": "

The ID of the target route table.

", - "smithy.api#xmlName": "targetRouteTableId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a transit gateway policy table entry

" - } - }, - "com.amazonaws.ec2#TransitGatewayPolicyTableEntryList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TransitGatewayPolicyTableEntry", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TransitGatewayPolicyTableId": { - "type": "string" - }, - "com.amazonaws.ec2#TransitGatewayPolicyTableIdStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TransitGatewayPolicyTableId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TransitGatewayPolicyTableList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TransitGatewayPolicyTable", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TransitGatewayPolicyTableState": { - "type": "enum", - "members": { - "pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "available": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "available" - } - }, - "deleting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleting" - } - }, - "deleted": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleted" - } - } - } - }, - "com.amazonaws.ec2#TransitGatewayPrefixListAttachment": { - "type": "structure", - "members": { - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", - "smithy.api#documentation": "

The ID of the attachment.

", - "smithy.api#xmlName": "transitGatewayAttachmentId" - } - }, - "ResourceType": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", - "traits": { - "aws.protocols#ec2QueryName": "ResourceType", - "smithy.api#documentation": "

The resource type. Note that the tgw-peering resource type has been deprecated.

", - "smithy.api#xmlName": "resourceType" - } - }, - "ResourceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceId", - "smithy.api#documentation": "

The ID of the resource.

", - "smithy.api#xmlName": "resourceId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a transit gateway prefix list attachment.

" - } - }, - "com.amazonaws.ec2#TransitGatewayPrefixListReference": { - "type": "structure", - "members": { - "TransitGatewayRouteTableId": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayRouteTableId", - "smithy.api#documentation": "

The ID of the transit gateway route table.

", - "smithy.api#xmlName": "transitGatewayRouteTableId" - } - }, - "PrefixListId": { - "target": "com.amazonaws.ec2#PrefixListResourceId", - "traits": { - "aws.protocols#ec2QueryName": "PrefixListId", - "smithy.api#documentation": "

The ID of the prefix list.

", - "smithy.api#xmlName": "prefixListId" - } - }, - "PrefixListOwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrefixListOwnerId", - "smithy.api#documentation": "

The ID of the prefix list owner.

", - "smithy.api#xmlName": "prefixListOwnerId" - } - }, - "State": { - "target": "com.amazonaws.ec2#TransitGatewayPrefixListReferenceState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the prefix list reference.

", - "smithy.api#xmlName": "state" - } - }, - "Blackhole": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Blackhole", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether traffic that matches this route is dropped.

", - "smithy.api#xmlName": "blackhole" - } - }, - "TransitGatewayAttachment": { - "target": "com.amazonaws.ec2#TransitGatewayPrefixListAttachment", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayAttachment", - "smithy.api#documentation": "

Information about the transit gateway attachment.

", - "smithy.api#xmlName": "transitGatewayAttachment" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a prefix list reference.

" - } - }, - "com.amazonaws.ec2#TransitGatewayPrefixListReferenceSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TransitGatewayPrefixListReference", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TransitGatewayPrefixListReferenceState": { - "type": "enum", - "members": { - "pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "available": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "available" - } - }, - "modifying": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "modifying" - } - }, - "deleting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleting" - } - } - } - }, - "com.amazonaws.ec2#TransitGatewayPropagation": { - "type": "structure", - "members": { - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", - "smithy.api#documentation": "

The ID of the attachment.

", - "smithy.api#xmlName": "transitGatewayAttachmentId" - } - }, - "ResourceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceId", - "smithy.api#documentation": "

The ID of the resource.

", - "smithy.api#xmlName": "resourceId" - } - }, - "ResourceType": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", - "traits": { - "aws.protocols#ec2QueryName": "ResourceType", - "smithy.api#documentation": "

The resource type. Note that the tgw-peering resource type has been deprecated.

", - "smithy.api#xmlName": "resourceType" - } - }, - "TransitGatewayRouteTableId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayRouteTableId", - "smithy.api#documentation": "

The ID of the transit gateway route table.

", - "smithy.api#xmlName": "transitGatewayRouteTableId" - } - }, - "State": { - "target": "com.amazonaws.ec2#TransitGatewayPropagationState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state.

", - "smithy.api#xmlName": "state" - } - }, - "TransitGatewayRouteTableAnnouncementId": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementId", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayRouteTableAnnouncementId", - "smithy.api#documentation": "

The ID of the transit gateway route table announcement.

", - "smithy.api#xmlName": "transitGatewayRouteTableAnnouncementId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes route propagation.

" - } - }, - "com.amazonaws.ec2#TransitGatewayPropagationState": { - "type": "enum", - "members": { - "enabling": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enabling" - } - }, - "enabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enabled" - } - }, - "disabling": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disabling" - } - }, - "disabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disabled" - } - } - } - }, - "com.amazonaws.ec2#TransitGatewayRequestOptions": { - "type": "structure", - "members": { - "AmazonSideAsn": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

A private Autonomous System Number (ASN) for the Amazon side of a BGP session. \n The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. The default is 64512.

" - } - }, - "AutoAcceptSharedAttachments": { - "target": "com.amazonaws.ec2#AutoAcceptSharedAttachmentsValue", - "traits": { - "smithy.api#documentation": "

Enable or disable automatic acceptance of attachment requests. Disabled by default.

" - } - }, - "DefaultRouteTableAssociation": { - "target": "com.amazonaws.ec2#DefaultRouteTableAssociationValue", - "traits": { - "smithy.api#documentation": "

Enable or disable automatic association with the default association route table. Enabled by default.

" - } - }, - "DefaultRouteTablePropagation": { - "target": "com.amazonaws.ec2#DefaultRouteTablePropagationValue", - "traits": { - "smithy.api#documentation": "

Enable or disable automatic propagation of routes to the default propagation route table. Enabled by default.

" - } - }, - "VpnEcmpSupport": { - "target": "com.amazonaws.ec2#VpnEcmpSupportValue", - "traits": { - "smithy.api#documentation": "

Enable or disable Equal Cost Multipath Protocol support. Enabled by default.

" - } - }, - "DnsSupport": { - "target": "com.amazonaws.ec2#DnsSupportValue", - "traits": { - "smithy.api#documentation": "

Enable or disable DNS support. Enabled by default.

" - } - }, - "MulticastSupport": { - "target": "com.amazonaws.ec2#MulticastSupportValue", - "traits": { - "smithy.api#documentation": "

Indicates whether multicast is enabled on the transit gateway

" - } - }, - "TransitGatewayCidrBlocks": { - "target": "com.amazonaws.ec2#TransitGatewayCidrBlockStringList", - "traits": { - "smithy.api#documentation": "

One or more IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the options for a transit gateway.

" - } - }, - "com.amazonaws.ec2#TransitGatewayRoute": { - "type": "structure", - "members": { - "DestinationCidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DestinationCidrBlock", - "smithy.api#documentation": "

The CIDR block used for destination matches.

", - "smithy.api#xmlName": "destinationCidrBlock" - } - }, - "PrefixListId": { - "target": "com.amazonaws.ec2#PrefixListResourceId", - "traits": { - "aws.protocols#ec2QueryName": "PrefixListId", - "smithy.api#documentation": "

The ID of the prefix list used for destination matches.

", - "smithy.api#xmlName": "prefixListId" - } - }, - "TransitGatewayRouteTableAnnouncementId": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementId", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayRouteTableAnnouncementId", - "smithy.api#documentation": "

The ID of the transit gateway route table announcement.

", - "smithy.api#xmlName": "transitGatewayRouteTableAnnouncementId" - } - }, - "TransitGatewayAttachments": { - "target": "com.amazonaws.ec2#TransitGatewayRouteAttachmentList", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayAttachments", - "smithy.api#documentation": "

The attachments.

", - "smithy.api#xmlName": "transitGatewayAttachments" - } - }, - "Type": { - "target": "com.amazonaws.ec2#TransitGatewayRouteType", - "traits": { - "aws.protocols#ec2QueryName": "Type", - "smithy.api#documentation": "

The route type.

", - "smithy.api#xmlName": "type" - } - }, - "State": { - "target": "com.amazonaws.ec2#TransitGatewayRouteState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the route.

", - "smithy.api#xmlName": "state" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a route for a transit gateway route table.

" - } - }, - "com.amazonaws.ec2#TransitGatewayRouteAttachment": { - "type": "structure", - "members": { - "ResourceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceId", - "smithy.api#documentation": "

The ID of the resource.

", - "smithy.api#xmlName": "resourceId" - } - }, - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", - "smithy.api#documentation": "

The ID of the attachment.

", - "smithy.api#xmlName": "transitGatewayAttachmentId" - } - }, - "ResourceType": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", - "traits": { - "aws.protocols#ec2QueryName": "ResourceType", - "smithy.api#documentation": "

The resource type. Note that the tgw-peering resource type has been deprecated.

", - "smithy.api#xmlName": "resourceType" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a route attachment.

" - } - }, - "com.amazonaws.ec2#TransitGatewayRouteAttachmentList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TransitGatewayRouteAttachment", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TransitGatewayRouteList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TransitGatewayRoute", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TransitGatewayRouteState": { - "type": "enum", - "members": { - "pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "active": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "active" - } - }, - "blackhole": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "blackhole" - } - }, - "deleting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleting" - } - }, - "deleted": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleted" - } - } - } - }, - "com.amazonaws.ec2#TransitGatewayRouteTable": { - "type": "structure", - "members": { - "TransitGatewayRouteTableId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayRouteTableId", - "smithy.api#documentation": "

The ID of the transit gateway route table.

", - "smithy.api#xmlName": "transitGatewayRouteTableId" - } - }, - "TransitGatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayId", - "smithy.api#documentation": "

The ID of the transit gateway.

", - "smithy.api#xmlName": "transitGatewayId" - } - }, - "State": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the transit gateway route table.

", - "smithy.api#xmlName": "state" - } - }, - "DefaultAssociationRouteTable": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DefaultAssociationRouteTable", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether this is the default association route table for the transit gateway.

", - "smithy.api#xmlName": "defaultAssociationRouteTable" - } - }, - "DefaultPropagationRouteTable": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DefaultPropagationRouteTable", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether this is the default propagation route table for the transit gateway.

", - "smithy.api#xmlName": "defaultPropagationRouteTable" - } - }, - "CreationTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "CreationTime", - "smithy.api#documentation": "

The creation time.

", - "smithy.api#xmlName": "creationTime" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the route table.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a transit gateway route table.

" - } - }, - "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncement": { - "type": "structure", - "members": { - "TransitGatewayRouteTableAnnouncementId": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementId", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayRouteTableAnnouncementId", - "smithy.api#documentation": "

The ID of the transit gateway route table announcement.

", - "smithy.api#xmlName": "transitGatewayRouteTableAnnouncementId" - } - }, - "TransitGatewayId": { - "target": "com.amazonaws.ec2#TransitGatewayId", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayId", - "smithy.api#documentation": "

The ID of the transit gateway.

", - "smithy.api#xmlName": "transitGatewayId" - } - }, - "CoreNetworkId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CoreNetworkId", - "smithy.api#documentation": "

The ID of the core network for the transit gateway route table announcement.

", - "smithy.api#xmlName": "coreNetworkId" - } - }, - "PeerTransitGatewayId": { - "target": "com.amazonaws.ec2#TransitGatewayId", - "traits": { - "aws.protocols#ec2QueryName": "PeerTransitGatewayId", - "smithy.api#documentation": "

The ID of the peer transit gateway.

", - "smithy.api#xmlName": "peerTransitGatewayId" - } - }, - "PeerCoreNetworkId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PeerCoreNetworkId", - "smithy.api#documentation": "

The ID of the core network ID for the peer.

", - "smithy.api#xmlName": "peerCoreNetworkId" - } - }, - "PeeringAttachmentId": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", - "traits": { - "aws.protocols#ec2QueryName": "PeeringAttachmentId", - "smithy.api#documentation": "

The ID of the peering attachment.

", - "smithy.api#xmlName": "peeringAttachmentId" - } - }, - "AnnouncementDirection": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementDirection", - "traits": { - "aws.protocols#ec2QueryName": "AnnouncementDirection", - "smithy.api#documentation": "

The direction for the route table announcement.

", - "smithy.api#xmlName": "announcementDirection" - } - }, - "TransitGatewayRouteTableId": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayRouteTableId", - "smithy.api#documentation": "

The ID of the transit gateway route table.

", - "smithy.api#xmlName": "transitGatewayRouteTableId" - } - }, - "State": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the transit gateway announcement.

", - "smithy.api#xmlName": "state" - } - }, - "CreationTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "CreationTime", - "smithy.api#documentation": "

The timestamp when the transit gateway route table announcement was created.

", - "smithy.api#xmlName": "creationTime" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The key-value pairs associated with the route table announcement.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a transit gateway route table announcement.

" - } - }, - "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementDirection": { - "type": "enum", - "members": { - "outgoing": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "outgoing" - } - }, - "incoming": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "incoming" - } - } - } - }, - "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementId": { - "type": "string" - }, - "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementIdStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncement", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementState": { - "type": "enum", - "members": { - "available": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "available" - } - }, - "pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "failing": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failing" - } - }, - "failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failed" - } - }, - "deleting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleting" - } - }, - "deleted": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleted" - } - } - } - }, - "com.amazonaws.ec2#TransitGatewayRouteTableAssociation": { - "type": "structure", - "members": { - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", - "smithy.api#documentation": "

The ID of the attachment.

", - "smithy.api#xmlName": "transitGatewayAttachmentId" - } - }, - "ResourceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceId", - "smithy.api#documentation": "

The ID of the resource.

", - "smithy.api#xmlName": "resourceId" - } - }, - "ResourceType": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", - "traits": { - "aws.protocols#ec2QueryName": "ResourceType", - "smithy.api#documentation": "

The resource type. Note that the tgw-peering resource type has been deprecated.

", - "smithy.api#xmlName": "resourceType" - } - }, - "State": { - "target": "com.amazonaws.ec2#TransitGatewayAssociationState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the association.

", - "smithy.api#xmlName": "state" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an association between a route table and a resource attachment.

" - } - }, - "com.amazonaws.ec2#TransitGatewayRouteTableAssociationList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableAssociation", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TransitGatewayRouteTableId": { - "type": "string" - }, - "com.amazonaws.ec2#TransitGatewayRouteTableIdStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TransitGatewayRouteTableList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTable", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TransitGatewayRouteTablePropagation": { - "type": "structure", - "members": { - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", - "smithy.api#documentation": "

The ID of the attachment.

", - "smithy.api#xmlName": "transitGatewayAttachmentId" - } - }, - "ResourceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceId", - "smithy.api#documentation": "

The ID of the resource.

", - "smithy.api#xmlName": "resourceId" - } - }, - "ResourceType": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", - "traits": { - "aws.protocols#ec2QueryName": "ResourceType", - "smithy.api#documentation": "

The type of resource. Note that the tgw-peering resource type has been deprecated.

", - "smithy.api#xmlName": "resourceType" - } - }, - "State": { - "target": "com.amazonaws.ec2#TransitGatewayPropagationState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the resource.

", - "smithy.api#xmlName": "state" - } - }, - "TransitGatewayRouteTableAnnouncementId": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementId", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayRouteTableAnnouncementId", - "smithy.api#documentation": "

The ID of the transit gateway route table announcement.

", - "smithy.api#xmlName": "transitGatewayRouteTableAnnouncementId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a route table propagation.

" - } - }, - "com.amazonaws.ec2#TransitGatewayRouteTablePropagationList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTablePropagation", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TransitGatewayRouteTableRoute": { - "type": "structure", - "members": { - "DestinationCidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DestinationCidr", - "smithy.api#documentation": "

The CIDR block used for destination matches.

", - "smithy.api#xmlName": "destinationCidr" - } - }, - "State": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the route.

", - "smithy.api#xmlName": "state" - } - }, - "RouteOrigin": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "RouteOrigin", - "smithy.api#documentation": "

The route origin. The following are the possible values:

\n ", - "smithy.api#xmlName": "routeOrigin" - } - }, - "PrefixListId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrefixListId", - "smithy.api#documentation": "

The ID of the prefix list.

", - "smithy.api#xmlName": "prefixListId" - } - }, - "AttachmentId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AttachmentId", - "smithy.api#documentation": "

The ID of the route attachment.

", - "smithy.api#xmlName": "attachmentId" - } - }, - "ResourceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceId", - "smithy.api#documentation": "

The ID of the resource for the route attachment.

", - "smithy.api#xmlName": "resourceId" - } - }, - "ResourceType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceType", - "smithy.api#documentation": "

The resource type for the route attachment.

", - "smithy.api#xmlName": "resourceType" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a route in a transit gateway route table.

" - } - }, - "com.amazonaws.ec2#TransitGatewayRouteTableState": { - "type": "enum", - "members": { - "pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "available": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "available" - } - }, - "deleting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleting" - } - }, - "deleted": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleted" - } - } - } - }, - "com.amazonaws.ec2#TransitGatewayRouteType": { - "type": "enum", - "members": { - "static": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "static" - } - }, - "propagated": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "propagated" - } - } - } - }, - "com.amazonaws.ec2#TransitGatewayState": { - "type": "enum", - "members": { - "pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "available": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "available" - } - }, - "modifying": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "modifying" - } - }, - "deleting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleting" - } - }, - "deleted": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleted" - } - } - } - }, - "com.amazonaws.ec2#TransitGatewaySubnetIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SubnetId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TransitGatewayVpcAttachment": { - "type": "structure", - "members": { - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", - "smithy.api#documentation": "

The ID of the attachment.

", - "smithy.api#xmlName": "transitGatewayAttachmentId" - } - }, - "TransitGatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayId", - "smithy.api#documentation": "

The ID of the transit gateway.

", - "smithy.api#xmlName": "transitGatewayId" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#xmlName": "vpcId" - } - }, - "VpcOwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcOwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the VPC.

", - "smithy.api#xmlName": "vpcOwnerId" - } - }, - "State": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the VPC attachment. Note that the initiating state has been deprecated.

", - "smithy.api#xmlName": "state" - } - }, - "SubnetIds": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "SubnetIds", - "smithy.api#documentation": "

The IDs of the subnets.

", - "smithy.api#xmlName": "subnetIds" - } - }, - "CreationTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "CreationTime", - "smithy.api#documentation": "

The creation time.

", - "smithy.api#xmlName": "creationTime" - } - }, - "Options": { - "target": "com.amazonaws.ec2#TransitGatewayVpcAttachmentOptions", - "traits": { - "aws.protocols#ec2QueryName": "Options", - "smithy.api#documentation": "

The VPC attachment options.

", - "smithy.api#xmlName": "options" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags for the VPC attachment.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a VPC attachment.

" - } - }, - "com.amazonaws.ec2#TransitGatewayVpcAttachmentList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TransitGatewayVpcAttachment", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TransitGatewayVpcAttachmentOptions": { - "type": "structure", - "members": { - "DnsSupport": { - "target": "com.amazonaws.ec2#DnsSupportValue", - "traits": { - "aws.protocols#ec2QueryName": "DnsSupport", - "smithy.api#documentation": "

Indicates whether DNS support is enabled.

", - "smithy.api#xmlName": "dnsSupport" - } - }, - "Ipv6Support": { - "target": "com.amazonaws.ec2#Ipv6SupportValue", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6Support", - "smithy.api#documentation": "

Indicates whether IPv6 support is disabled.

", - "smithy.api#xmlName": "ipv6Support" - } - }, - "ApplianceModeSupport": { - "target": "com.amazonaws.ec2#ApplianceModeSupportValue", - "traits": { - "aws.protocols#ec2QueryName": "ApplianceModeSupport", - "smithy.api#documentation": "

Indicates whether appliance mode support is enabled.

", - "smithy.api#xmlName": "applianceModeSupport" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the VPC attachment options.

" - } - }, - "com.amazonaws.ec2#TransportProtocol": { - "type": "enum", - "members": { - "tcp": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "tcp" - } - }, - "udp": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "udp" - } - } - } - }, - "com.amazonaws.ec2#TrunkInterfaceAssociation": { - "type": "structure", - "members": { - "AssociationId": { - "target": "com.amazonaws.ec2#TrunkInterfaceAssociationId", - "traits": { - "aws.protocols#ec2QueryName": "AssociationId", - "smithy.api#documentation": "

The ID of the association.

", - "smithy.api#xmlName": "associationId" - } - }, - "BranchInterfaceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "BranchInterfaceId", - "smithy.api#documentation": "

The ID of the branch network interface.

", - "smithy.api#xmlName": "branchInterfaceId" - } - }, - "TrunkInterfaceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TrunkInterfaceId", - "smithy.api#documentation": "

The ID of the trunk network interface.

", - "smithy.api#xmlName": "trunkInterfaceId" - } - }, - "InterfaceProtocol": { - "target": "com.amazonaws.ec2#InterfaceProtocolType", - "traits": { - "aws.protocols#ec2QueryName": "InterfaceProtocol", - "smithy.api#documentation": "

The interface protocol. Valid values are VLAN and GRE.

", - "smithy.api#xmlName": "interfaceProtocol" - } - }, - "VlanId": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "VlanId", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The ID of the VLAN when you use the VLAN protocol.

", - "smithy.api#xmlName": "vlanId" - } - }, - "GreKey": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "GreKey", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The application key when you use the GRE protocol.

", - "smithy.api#xmlName": "greKey" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags for the trunk interface association.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "\n

Currently available in limited preview only. \n If you are interested in using this feature, contact your account manager.

\n \n

Information about an association between a branch network interface with a trunk network interface.

" - } - }, - "com.amazonaws.ec2#TrunkInterfaceAssociationId": { - "type": "string" - }, - "com.amazonaws.ec2#TrunkInterfaceAssociationIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TrunkInterfaceAssociationId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TrunkInterfaceAssociationList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TrunkInterfaceAssociation", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#TrustProviderType": { - "type": "enum", - "members": { - "user": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "user" - } - }, - "device": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "device" - } - } - } - }, - "com.amazonaws.ec2#TunnelInsideIpVersion": { - "type": "enum", - "members": { - "ipv4": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ipv4" - } - }, - "ipv6": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ipv6" - } - } - } - }, - "com.amazonaws.ec2#TunnelOption": { - "type": "structure", - "members": { - "OutsideIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OutsideIpAddress", - "smithy.api#documentation": "

The external IP address of the VPN tunnel.

", - "smithy.api#xmlName": "outsideIpAddress" - } - }, - "TunnelInsideCidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TunnelInsideCidr", - "smithy.api#documentation": "

The range of inside IPv4 addresses for the tunnel.

", - "smithy.api#xmlName": "tunnelInsideCidr" - } - }, - "TunnelInsideIpv6Cidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TunnelInsideIpv6Cidr", - "smithy.api#documentation": "

The range of inside IPv6 addresses for the tunnel.

", - "smithy.api#xmlName": "tunnelInsideIpv6Cidr" - } - }, - "PreSharedKey": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PreSharedKey", - "smithy.api#documentation": "

The pre-shared key (PSK) to establish initial authentication between the virtual\n private gateway and the customer gateway.

", - "smithy.api#xmlName": "preSharedKey" - } - }, - "Phase1LifetimeSeconds": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Phase1LifetimeSeconds", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The lifetime for phase 1 of the IKE negotiation, in seconds.

", - "smithy.api#xmlName": "phase1LifetimeSeconds" - } - }, - "Phase2LifetimeSeconds": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Phase2LifetimeSeconds", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The lifetime for phase 2 of the IKE negotiation, in seconds.

", - "smithy.api#xmlName": "phase2LifetimeSeconds" - } - }, - "RekeyMarginTimeSeconds": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "RekeyMarginTimeSeconds", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The margin time, in seconds, before the phase 2 lifetime expires, during which the\n Amazon Web Services side of the VPN connection performs an IKE rekey.

", - "smithy.api#xmlName": "rekeyMarginTimeSeconds" - } - }, - "RekeyFuzzPercentage": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "RekeyFuzzPercentage", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The percentage of the rekey window determined by RekeyMarginTimeSeconds\n during which the rekey time is randomly selected.

", - "smithy.api#xmlName": "rekeyFuzzPercentage" - } - }, - "ReplayWindowSize": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "ReplayWindowSize", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of packets in an IKE replay window.

", - "smithy.api#xmlName": "replayWindowSize" - } - }, - "DpdTimeoutSeconds": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "DpdTimeoutSeconds", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of seconds after which a DPD timeout occurs.

", - "smithy.api#xmlName": "dpdTimeoutSeconds" - } - }, - "DpdTimeoutAction": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DpdTimeoutAction", - "smithy.api#documentation": "

The action to take after a DPD timeout occurs.

", - "smithy.api#xmlName": "dpdTimeoutAction" - } - }, - "Phase1EncryptionAlgorithms": { - "target": "com.amazonaws.ec2#Phase1EncryptionAlgorithmsList", - "traits": { - "aws.protocols#ec2QueryName": "Phase1EncryptionAlgorithmSet", - "smithy.api#documentation": "

The permitted encryption algorithms for the VPN tunnel for phase 1 IKE\n negotiations.

", - "smithy.api#xmlName": "phase1EncryptionAlgorithmSet" - } - }, - "Phase2EncryptionAlgorithms": { - "target": "com.amazonaws.ec2#Phase2EncryptionAlgorithmsList", - "traits": { - "aws.protocols#ec2QueryName": "Phase2EncryptionAlgorithmSet", - "smithy.api#documentation": "

The permitted encryption algorithms for the VPN tunnel for phase 2 IKE\n negotiations.

", - "smithy.api#xmlName": "phase2EncryptionAlgorithmSet" - } - }, - "Phase1IntegrityAlgorithms": { - "target": "com.amazonaws.ec2#Phase1IntegrityAlgorithmsList", - "traits": { - "aws.protocols#ec2QueryName": "Phase1IntegrityAlgorithmSet", - "smithy.api#documentation": "

The permitted integrity algorithms for the VPN tunnel for phase 1 IKE\n negotiations.

", - "smithy.api#xmlName": "phase1IntegrityAlgorithmSet" - } - }, - "Phase2IntegrityAlgorithms": { - "target": "com.amazonaws.ec2#Phase2IntegrityAlgorithmsList", - "traits": { - "aws.protocols#ec2QueryName": "Phase2IntegrityAlgorithmSet", - "smithy.api#documentation": "

The permitted integrity algorithms for the VPN tunnel for phase 2 IKE\n negotiations.

", - "smithy.api#xmlName": "phase2IntegrityAlgorithmSet" - } - }, - "Phase1DHGroupNumbers": { - "target": "com.amazonaws.ec2#Phase1DHGroupNumbersList", - "traits": { - "aws.protocols#ec2QueryName": "Phase1DHGroupNumberSet", - "smithy.api#documentation": "

The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE\n negotiations.

", - "smithy.api#xmlName": "phase1DHGroupNumberSet" - } - }, - "Phase2DHGroupNumbers": { - "target": "com.amazonaws.ec2#Phase2DHGroupNumbersList", - "traits": { - "aws.protocols#ec2QueryName": "Phase2DHGroupNumberSet", - "smithy.api#documentation": "

The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE\n negotiations.

", - "smithy.api#xmlName": "phase2DHGroupNumberSet" - } - }, - "IkeVersions": { - "target": "com.amazonaws.ec2#IKEVersionsList", - "traits": { - "aws.protocols#ec2QueryName": "IkeVersionSet", - "smithy.api#documentation": "

The IKE versions that are permitted for the VPN tunnel.

", - "smithy.api#xmlName": "ikeVersionSet" - } - }, - "StartupAction": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StartupAction", - "smithy.api#documentation": "

The action to take when the establishing the VPN tunnels for a VPN connection.

", - "smithy.api#xmlName": "startupAction" - } - }, - "LogOptions": { - "target": "com.amazonaws.ec2#VpnTunnelLogOptions", - "traits": { - "aws.protocols#ec2QueryName": "LogOptions", - "smithy.api#documentation": "

Options for logging VPN tunnel activity.

", - "smithy.api#xmlName": "logOptions" - } - }, - "EnableTunnelLifecycleControl": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "EnableTunnelLifecycleControl", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Status of tunnel endpoint lifecycle control feature.

", - "smithy.api#xmlName": "enableTunnelLifecycleControl" - } - } - }, - "traits": { - "smithy.api#documentation": "

The VPN tunnel options.

" - } - }, - "com.amazonaws.ec2#TunnelOptionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#TunnelOption", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#UnassignIpv6Addresses": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#UnassignIpv6AddressesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#UnassignIpv6AddressesResult" - }, - "traits": { - "smithy.api#documentation": "

Unassigns one or more IPv6 addresses IPv4 Prefix Delegation prefixes from a network interface.

" - } - }, - "com.amazonaws.ec2#UnassignIpv6AddressesRequest": { - "type": "structure", - "members": { - "Ipv6Addresses": { - "target": "com.amazonaws.ec2#Ipv6AddressList", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6Addresses", - "smithy.api#documentation": "

The IPv6 addresses to unassign from the network interface.

", - "smithy.api#xmlName": "ipv6Addresses" - } - }, - "Ipv6Prefixes": { - "target": "com.amazonaws.ec2#IpPrefixList", - "traits": { - "smithy.api#documentation": "

The IPv6 prefixes to unassign from the network interface.

", - "smithy.api#xmlName": "Ipv6Prefix" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#NetworkInterfaceId", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the network interface.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "networkInterfaceId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#UnassignIpv6AddressesResult": { - "type": "structure", - "members": { - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "

The ID of the network interface.

", - "smithy.api#xmlName": "networkInterfaceId" - } - }, - "UnassignedIpv6Addresses": { - "target": "com.amazonaws.ec2#Ipv6AddressList", - "traits": { - "aws.protocols#ec2QueryName": "UnassignedIpv6Addresses", - "smithy.api#documentation": "

The IPv6 addresses that have been unassigned from the network interface.

", - "smithy.api#xmlName": "unassignedIpv6Addresses" - } - }, - "UnassignedIpv6Prefixes": { - "target": "com.amazonaws.ec2#IpPrefixList", - "traits": { - "aws.protocols#ec2QueryName": "UnassignedIpv6PrefixSet", - "smithy.api#documentation": "

The IPv4 prefixes that have been unassigned from the network interface.

", - "smithy.api#xmlName": "unassignedIpv6PrefixSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#UnassignPrivateIpAddresses": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#UnassignPrivateIpAddressesRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "

Unassigns one or more secondary private IP addresses, or IPv4 Prefix Delegation prefixes from a \n \tnetwork interface.

" - } - }, - "com.amazonaws.ec2#UnassignPrivateIpAddressesRequest": { - "type": "structure", - "members": { - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#NetworkInterfaceId", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the network interface.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "networkInterfaceId" - } - }, - "PrivateIpAddresses": { - "target": "com.amazonaws.ec2#PrivateIpAddressStringList", - "traits": { - "aws.protocols#ec2QueryName": "PrivateIpAddress", - "smithy.api#documentation": "

The secondary private IP addresses to unassign from the network interface. You can specify this \n \toption multiple times to unassign more than one IP address.

", - "smithy.api#xmlName": "privateIpAddress" - } - }, - "Ipv4Prefixes": { - "target": "com.amazonaws.ec2#IpPrefixList", - "traits": { - "smithy.api#documentation": "

The IPv4 prefixes to unassign from the network interface.

", - "smithy.api#xmlName": "Ipv4Prefix" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the parameters for UnassignPrivateIpAddresses.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#UnassignPrivateNatGatewayAddress": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#UnassignPrivateNatGatewayAddressRequest" - }, - "output": { - "target": "com.amazonaws.ec2#UnassignPrivateNatGatewayAddressResult" - }, - "traits": { - "smithy.api#documentation": "

Unassigns secondary private IPv4 addresses from a private NAT gateway. You cannot unassign your primary private IP. For more information, see Edit secondary IP address associations in the Amazon Virtual Private Cloud User Guide.

\n

While unassigning is in progress, you cannot assign/unassign additional IP addresses while the connections are being drained. You are, however, allowed to delete the NAT gateway.

\n

A private IP address will only be released at the end of MaxDrainDurationSeconds. The\n private IP addresses stay associated and support the existing connections but do not\n support any new connections (new connections are distributed across the remaining\n assigned private IP address). After the existing connections drain out, the private IP\n addresses get released.

\n

\n

" - } - }, - "com.amazonaws.ec2#UnassignPrivateNatGatewayAddressRequest": { - "type": "structure", - "members": { - "NatGatewayId": { - "target": "com.amazonaws.ec2#NatGatewayId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The NAT gateway ID.

", - "smithy.api#required": {} - } - }, - "PrivateIpAddresses": { - "target": "com.amazonaws.ec2#IpList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The private IPv4 addresses you want to unassign.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "PrivateIpAddress" - } - }, - "MaxDrainDurationSeconds": { - "target": "com.amazonaws.ec2#DrainSeconds", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#UnassignPrivateNatGatewayAddressResult": { - "type": "structure", - "members": { - "NatGatewayId": { - "target": "com.amazonaws.ec2#NatGatewayId", - "traits": { - "aws.protocols#ec2QueryName": "NatGatewayId", - "smithy.api#documentation": "

The NAT gateway ID.

", - "smithy.api#xmlName": "natGatewayId" - } - }, - "NatGatewayAddresses": { - "target": "com.amazonaws.ec2#NatGatewayAddressList", - "traits": { - "aws.protocols#ec2QueryName": "NatGatewayAddressSet", - "smithy.api#documentation": "

Information about the NAT gateway IP addresses.

", - "smithy.api#xmlName": "natGatewayAddressSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#UnlimitedSupportedInstanceFamily": { - "type": "enum", - "members": { - "t2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "t2" - } - }, - "t3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "t3" - } - }, - "t3a": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "t3a" - } - }, - "t4g": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "t4g" - } - } - } - }, - "com.amazonaws.ec2#UnmonitorInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#UnmonitorInstancesRequest" - }, - "output": { - "target": "com.amazonaws.ec2#UnmonitorInstancesResult" - }, - "traits": { - "smithy.api#documentation": "

Disables detailed monitoring for a running instance. For more information, see Monitoring\n your instances and volumes in the\n Amazon EC2 User Guide.

" - } - }, - "com.amazonaws.ec2#UnmonitorInstancesRequest": { - "type": "structure", - "members": { - "InstanceIds": { - "target": "com.amazonaws.ec2#InstanceIdStringList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IDs of the instances.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "InstanceId" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#UnmonitorInstancesResult": { - "type": "structure", - "members": { - "InstanceMonitorings": { - "target": "com.amazonaws.ec2#InstanceMonitoringList", - "traits": { - "aws.protocols#ec2QueryName": "InstancesSet", - "smithy.api#documentation": "

The monitoring information.

", - "smithy.api#xmlName": "instancesSet" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#UnsuccessfulInstanceCreditSpecificationErrorCode": { - "type": "enum", - "members": { - "INVALID_INSTANCE_ID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InvalidInstanceID.Malformed" - } - }, - "INSTANCE_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InvalidInstanceID.NotFound" - } - }, - "INCORRECT_INSTANCE_STATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IncorrectInstanceState" - } - }, - "INSTANCE_CREDIT_SPECIFICATION_NOT_SUPPORTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InstanceCreditSpecification.NotSupported" - } - } - } - }, - "com.amazonaws.ec2#UnsuccessfulInstanceCreditSpecificationItem": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#xmlName": "instanceId" - } - }, - "Error": { - "target": "com.amazonaws.ec2#UnsuccessfulInstanceCreditSpecificationItemError", - "traits": { - "aws.protocols#ec2QueryName": "Error", - "smithy.api#documentation": "

The applicable error for the burstable performance instance whose credit option for\n CPU usage was not modified.

", - "smithy.api#xmlName": "error" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the burstable performance instance whose credit option for CPU usage was not\n modified.

" - } - }, - "com.amazonaws.ec2#UnsuccessfulInstanceCreditSpecificationItemError": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.ec2#UnsuccessfulInstanceCreditSpecificationErrorCode", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The error code.

", - "smithy.api#xmlName": "code" - } - }, - "Message": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "

The applicable error message.

", - "smithy.api#xmlName": "message" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the error for the burstable performance instance whose credit option\n for CPU usage was not modified.

" - } - }, - "com.amazonaws.ec2#UnsuccessfulInstanceCreditSpecificationSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#UnsuccessfulInstanceCreditSpecificationItem", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#UnsuccessfulItem": { - "type": "structure", - "members": { - "Error": { - "target": "com.amazonaws.ec2#UnsuccessfulItemError", - "traits": { - "aws.protocols#ec2QueryName": "Error", - "smithy.api#documentation": "

Information about the error.

", - "smithy.api#xmlName": "error" - } - }, - "ResourceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceId", - "smithy.api#documentation": "

The ID of the resource.

", - "smithy.api#xmlName": "resourceId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about items that were not successfully processed in a batch call.

" - } - }, - "com.amazonaws.ec2#UnsuccessfulItemError": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The error code.

", - "smithy.api#xmlName": "code" - } - }, - "Message": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "

The error message accompanying the error code.

", - "smithy.api#xmlName": "message" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the error that occurred. For more information about errors, see Error codes.

" - } - }, - "com.amazonaws.ec2#UnsuccessfulItemList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#UnsuccessfulItem", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#UnsuccessfulItemSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#UnsuccessfulItem", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsEgress": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsEgressRequest" - }, - "output": { - "target": "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsEgressResult" - }, - "traits": { - "smithy.api#documentation": "

[VPC only] Updates the description of an egress (outbound) security group rule. You\n\t\t\tcan replace an existing description, or add a description to a rule that did not have one\n\t\t\tpreviously. You can remove a description for a security group rule by omitting the \n\t\t\tdescription parameter in the request.

" - } - }, - "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsEgressRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "GroupId": { - "target": "com.amazonaws.ec2#SecurityGroupId", - "traits": { - "smithy.api#documentation": "

The ID of the security group. You must specify either the security group ID or the\n\t\t\tsecurity group name in the request. For security groups in a nondefault VPC, you must\n\t\t\tspecify the security group ID.

" - } - }, - "GroupName": { - "target": "com.amazonaws.ec2#SecurityGroupName", - "traits": { - "smithy.api#documentation": "

[Default VPC] The name of the security group. You must specify either the security group\n\t\t\tID or the security group name in the request.

" - } - }, - "IpPermissions": { - "target": "com.amazonaws.ec2#IpPermissionList", - "traits": { - "smithy.api#documentation": "

The IP permissions for the security group rule. You must specify either the IP permissions\n\t\t or the description.

" - } - }, - "SecurityGroupRuleDescriptions": { - "target": "com.amazonaws.ec2#SecurityGroupRuleDescriptionList", - "traits": { - "smithy.api#documentation": "

The description for the egress security group rules. You must specify either the\n description or the IP permissions.

", - "smithy.api#xmlName": "SecurityGroupRuleDescription" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsEgressResult": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, returns an error.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsIngress": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsIngressRequest" - }, - "output": { - "target": "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsIngressResult" - }, - "traits": { - "smithy.api#documentation": "

Updates the description of an ingress (inbound) security group rule. You can replace an\n\t\t\texisting description, or add a description to a rule that did not have one previously.\n\t\t You can remove a description for a security group rule by omitting the description \n\t\t parameter in the request.

" - } - }, - "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsIngressRequest": { - "type": "structure", - "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - }, - "GroupId": { - "target": "com.amazonaws.ec2#SecurityGroupId", - "traits": { - "smithy.api#documentation": "

The ID of the security group. You must specify either the security group ID or the\n\t\t\tsecurity group name in the request. For security groups in a nondefault VPC, you must\n\t\t\tspecify the security group ID.

" - } - }, - "GroupName": { - "target": "com.amazonaws.ec2#SecurityGroupName", - "traits": { - "smithy.api#documentation": "

[EC2-Classic, default VPC] The name of the security group. You must specify either the\n security group ID or the security group name in the request. For security groups in a\n nondefault VPC, you must specify the security group ID.

" - } - }, - "IpPermissions": { - "target": "com.amazonaws.ec2#IpPermissionList", - "traits": { - "smithy.api#documentation": "

The IP permissions for the security group rule. You must specify either IP permissions\n\t\t or a description.

" - } - }, - "SecurityGroupRuleDescriptions": { - "target": "com.amazonaws.ec2#SecurityGroupRuleDescriptionList", - "traits": { - "smithy.api#documentation": "

[VPC only] The description for the ingress security group rules. You must specify either\n a description or IP permissions.

", - "smithy.api#xmlName": "SecurityGroupRuleDescription" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsIngressResult": { - "type": "structure", - "members": { - "Return": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Return", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, returns an error.

", - "smithy.api#xmlName": "return" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#UsageClassType": { - "type": "enum", - "members": { - "spot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "spot" - } - }, - "on_demand": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "on-demand" - } - } - } - }, - "com.amazonaws.ec2#UsageClassTypeList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#UsageClassType", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#UserBucket": { - "type": "structure", - "members": { - "S3Bucket": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The name of the Amazon S3 bucket where the disk image is located.

" - } - }, - "S3Key": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The file name of the disk image.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the Amazon S3 bucket for the disk image.

" - } - }, - "com.amazonaws.ec2#UserBucketDetails": { - "type": "structure", - "members": { - "S3Bucket": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "S3Bucket", - "smithy.api#documentation": "

The Amazon S3 bucket from which the disk image was created.

", - "smithy.api#xmlName": "s3Bucket" - } - }, - "S3Key": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "S3Key", - "smithy.api#documentation": "

The file name of the disk image.

", - "smithy.api#xmlName": "s3Key" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the Amazon S3 bucket for the disk image.

" - } - }, - "com.amazonaws.ec2#UserData": { - "type": "structure", - "members": { - "Data": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Data", - "smithy.api#documentation": "

The user data. If you are using an Amazon Web Services SDK or command line tool, Base64-encoding is performed for you, and you\n can load the text from a file. Otherwise, you must provide Base64-encoded text.

", - "smithy.api#xmlName": "data" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the user data for an instance.

", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.ec2#UserGroupStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#xmlName": "UserGroup" - } - } - }, - "com.amazonaws.ec2#UserIdGroupPair": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description for the security group rule that references this user ID group\n\t\t\tpair.

\n

Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9,\n spaces, and ._-:/()#,@[]+=;{}!$*

", - "smithy.api#xmlName": "description" - } - }, - "GroupId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupId", - "smithy.api#documentation": "

The ID of the security group.

", - "smithy.api#xmlName": "groupId" - } - }, - "GroupName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupName", - "smithy.api#documentation": "

The name of the security group. In a request, use this parameter for a security group\n in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the\n security group ID.

\n

For a referenced security group in another VPC, this value is not returned if the\n referenced security group is deleted.

", - "smithy.api#xmlName": "groupName" - } - }, - "PeeringStatus": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PeeringStatus", - "smithy.api#documentation": "

The status of a VPC peering connection, if applicable.

", - "smithy.api#xmlName": "peeringStatus" - } - }, - "UserId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "UserId", - "smithy.api#documentation": "

The ID of an Amazon Web Services account.

\n

For a referenced security group in another VPC, the account ID of the referenced\n security group is returned in the response. If the referenced security group is deleted,\n this value is not returned.

\n

[EC2-Classic] Required when adding or removing rules that reference a security group\n in another Amazon Web Services account.

", - "smithy.api#xmlName": "userId" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC for the referenced security group, if applicable.

", - "smithy.api#xmlName": "vpcId" - } - }, - "VpcPeeringConnectionId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", - "smithy.api#documentation": "

The ID of the VPC peering connection, if applicable.

", - "smithy.api#xmlName": "vpcPeeringConnectionId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a security group and Amazon Web Services account ID pair.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " - } - }, - "com.amazonaws.ec2#UserIdGroupPairList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#UserIdGroupPair", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#UserIdGroupPairSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#UserIdGroupPair", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#UserIdStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#xmlName": "UserId" - } - } - }, - "com.amazonaws.ec2#UserTrustProviderType": { - "type": "enum", - "members": { - "iam_identity_center": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iam-identity-center" - } - }, - "oidc": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "oidc" - } - } - } - }, - "com.amazonaws.ec2#VCpuCount": { - "type": "integer" - }, - "com.amazonaws.ec2#VCpuCountRange": { - "type": "structure", - "members": { - "Min": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Min", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum number of vCPUs. If the value is 0, there is no minimum\n limit.

", - "smithy.api#xmlName": "min" - } - }, - "Max": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Max", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of vCPUs. If this parameter is not specified, there is no maximum\n limit.

", - "smithy.api#xmlName": "max" - } - } - }, - "traits": { - "smithy.api#documentation": "

The minimum and maximum number of vCPUs.

" - } - }, - "com.amazonaws.ec2#VCpuCountRangeRequest": { - "type": "structure", - "members": { - "Min": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum number of vCPUs. To specify no minimum limit, specify 0.

", - "smithy.api#required": {} - } - }, - "Max": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of vCPUs. To specify no maximum limit, omit this parameter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The minimum and maximum number of vCPUs.

" - } - }, - "com.amazonaws.ec2#VCpuInfo": { - "type": "structure", - "members": { - "DefaultVCpus": { - "target": "com.amazonaws.ec2#VCpuCount", - "traits": { - "aws.protocols#ec2QueryName": "DefaultVCpus", - "smithy.api#documentation": "

The default number of vCPUs for the instance type.

", - "smithy.api#xmlName": "defaultVCpus" - } - }, - "DefaultCores": { - "target": "com.amazonaws.ec2#CoreCount", - "traits": { - "aws.protocols#ec2QueryName": "DefaultCores", - "smithy.api#documentation": "

The default number of cores for the instance type.

", - "smithy.api#xmlName": "defaultCores" - } - }, - "DefaultThreadsPerCore": { - "target": "com.amazonaws.ec2#ThreadsPerCore", - "traits": { - "aws.protocols#ec2QueryName": "DefaultThreadsPerCore", - "smithy.api#documentation": "

The default number of threads per core for the instance type.

", - "smithy.api#xmlName": "defaultThreadsPerCore" - } - }, - "ValidCores": { - "target": "com.amazonaws.ec2#CoreCountList", - "traits": { - "aws.protocols#ec2QueryName": "ValidCores", - "smithy.api#documentation": "

The valid number of cores that can be configured for the instance type.

", - "smithy.api#xmlName": "validCores" - } - }, - "ValidThreadsPerCore": { - "target": "com.amazonaws.ec2#ThreadsPerCoreList", - "traits": { - "aws.protocols#ec2QueryName": "ValidThreadsPerCore", - "smithy.api#documentation": "

The valid number of threads per core that can be configured for the instance type.

", - "smithy.api#xmlName": "validThreadsPerCore" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the vCPU configurations for the instance type.

" - } - }, - "com.amazonaws.ec2#ValidationError": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The error code that indicates why the parameter or parameter combination is not valid.\n For more information about error codes, see Error codes.

", - "smithy.api#xmlName": "code" - } - }, - "Message": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "

The error message that describes why the parameter or parameter combination is not\n valid. For more information about error messages, see Error codes.

", - "smithy.api#xmlName": "message" - } - } - }, - "traits": { - "smithy.api#documentation": "

The error code and error message that is returned for a parameter or parameter\n combination that is not valid when a new launch template or new version of a launch\n template is created.

" - } - }, - "com.amazonaws.ec2#ValidationWarning": { - "type": "structure", - "members": { - "Errors": { - "target": "com.amazonaws.ec2#ErrorSet", - "traits": { - "aws.protocols#ec2QueryName": "ErrorSet", - "smithy.api#documentation": "

The error codes and error messages.

", - "smithy.api#xmlName": "errorSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

The error codes and error messages that are returned for the parameters or parameter\n combinations that are not valid when a new launch template or new version of a launch\n template is created.

" - } - }, - "com.amazonaws.ec2#ValueStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VerifiedAccessEndpoint": { - "type": "structure", - "members": { - "VerifiedAccessInstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VerifiedAccessInstanceId", - "smithy.api#documentation": "

The ID of the Amazon Web Services Verified Access instance.

", - "smithy.api#xmlName": "verifiedAccessInstanceId" - } - }, - "VerifiedAccessGroupId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VerifiedAccessGroupId", - "smithy.api#documentation": "

The ID of the Amazon Web Services Verified Access group.

", - "smithy.api#xmlName": "verifiedAccessGroupId" - } - }, - "VerifiedAccessEndpointId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VerifiedAccessEndpointId", - "smithy.api#documentation": "

The ID of the Amazon Web Services Verified Access endpoint.

", - "smithy.api#xmlName": "verifiedAccessEndpointId" - } - }, - "ApplicationDomain": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ApplicationDomain", - "smithy.api#documentation": "

The DNS name for users to reach your application.

", - "smithy.api#xmlName": "applicationDomain" - } - }, - "EndpointType": { - "target": "com.amazonaws.ec2#VerifiedAccessEndpointType", - "traits": { - "aws.protocols#ec2QueryName": "EndpointType", - "smithy.api#documentation": "

The type of Amazon Web Services Verified Access endpoint. Incoming application requests will be sent to an IP\n address, load balancer or a network interface depending on the endpoint type\n specified.

", - "smithy.api#xmlName": "endpointType" - } - }, - "AttachmentType": { - "target": "com.amazonaws.ec2#VerifiedAccessEndpointAttachmentType", - "traits": { - "aws.protocols#ec2QueryName": "AttachmentType", - "smithy.api#documentation": "

The type of attachment used to provide connectivity between the Amazon Web Services Verified Access endpoint and the\n application.

", - "smithy.api#xmlName": "attachmentType" - } - }, - "DomainCertificateArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DomainCertificateArn", - "smithy.api#documentation": "

The ARN of a public TLS/SSL certificate imported into or created with ACM.

", - "smithy.api#xmlName": "domainCertificateArn" - } - }, - "EndpointDomain": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "EndpointDomain", - "smithy.api#documentation": "

A DNS name that is generated for the endpoint.

", - "smithy.api#xmlName": "endpointDomain" - } - }, - "DeviceValidationDomain": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DeviceValidationDomain", - "smithy.api#documentation": "

Returned if endpoint has a device trust provider attached.

", - "smithy.api#xmlName": "deviceValidationDomain" - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.ec2#SecurityGroupIdList", - "traits": { - "aws.protocols#ec2QueryName": "SecurityGroupIdSet", - "smithy.api#documentation": "

The IDs of the security groups for the endpoint.

", - "smithy.api#xmlName": "securityGroupIdSet" - } - }, - "LoadBalancerOptions": { - "target": "com.amazonaws.ec2#VerifiedAccessEndpointLoadBalancerOptions", - "traits": { - "aws.protocols#ec2QueryName": "LoadBalancerOptions", - "smithy.api#documentation": "

The load balancer details if creating the Amazon Web Services Verified Access endpoint as\n load-balancertype.

", - "smithy.api#xmlName": "loadBalancerOptions" - } - }, - "NetworkInterfaceOptions": { - "target": "com.amazonaws.ec2#VerifiedAccessEndpointEniOptions", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceOptions", - "smithy.api#documentation": "

The options for network-interface type endpoint.

", - "smithy.api#xmlName": "networkInterfaceOptions" - } - }, - "Status": { - "target": "com.amazonaws.ec2#VerifiedAccessEndpointStatus", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The endpoint status.

", - "smithy.api#xmlName": "status" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description for the Amazon Web Services Verified Access endpoint.

", - "smithy.api#xmlName": "description" - } - }, - "CreationTime": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CreationTime", - "smithy.api#documentation": "

The creation time.

", - "smithy.api#xmlName": "creationTime" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LastUpdatedTime", - "smithy.api#documentation": "

The last updated time.

", - "smithy.api#xmlName": "lastUpdatedTime" - } - }, - "DeletionTime": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DeletionTime", - "smithy.api#documentation": "

The deletion time.

", - "smithy.api#xmlName": "deletionTime" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

An Amazon Web Services Verified Access endpoint specifies the application that Amazon Web Services Verified Access provides access to. It must be\n attached to an Amazon Web Services Verified Access group. An Amazon Web Services Verified Access endpoint must also have an attached access policy\n before you attached it to a group.

" - } - }, - "com.amazonaws.ec2#VerifiedAccessEndpointAttachmentType": { - "type": "enum", - "members": { - "vpc": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "vpc" - } - } - } - }, - "com.amazonaws.ec2#VerifiedAccessEndpointEniOptions": { - "type": "structure", - "members": { - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#NetworkInterfaceId", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "

The ID of the network interface.

", - "smithy.api#xmlName": "networkInterfaceId" - } - }, - "Protocol": { - "target": "com.amazonaws.ec2#VerifiedAccessEndpointProtocol", - "traits": { - "aws.protocols#ec2QueryName": "Protocol", - "smithy.api#documentation": "

The IP protocol.

", - "smithy.api#xmlName": "protocol" - } - }, - "Port": { - "target": "com.amazonaws.ec2#VerifiedAccessEndpointPortNumber", - "traits": { - "aws.protocols#ec2QueryName": "Port", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The IP port number.

", - "smithy.api#xmlName": "port" - } - } - }, - "traits": { - "smithy.api#documentation": "

Options for a network-interface type endpoint.

" - } - }, - "com.amazonaws.ec2#VerifiedAccessEndpointId": { - "type": "string" - }, - "com.amazonaws.ec2#VerifiedAccessEndpointIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VerifiedAccessEndpointId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VerifiedAccessEndpointList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VerifiedAccessEndpoint", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VerifiedAccessEndpointLoadBalancerOptions": { - "type": "structure", - "members": { - "Protocol": { - "target": "com.amazonaws.ec2#VerifiedAccessEndpointProtocol", - "traits": { - "aws.protocols#ec2QueryName": "Protocol", - "smithy.api#documentation": "

The IP protocol.

", - "smithy.api#xmlName": "protocol" - } - }, - "Port": { - "target": "com.amazonaws.ec2#VerifiedAccessEndpointPortNumber", - "traits": { - "aws.protocols#ec2QueryName": "Port", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The IP port number.

", - "smithy.api#xmlName": "port" - } - }, - "LoadBalancerArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LoadBalancerArn", - "smithy.api#documentation": "

The ARN of the load balancer.

", - "smithy.api#xmlName": "loadBalancerArn" - } - }, - "SubnetIds": { - "target": "com.amazonaws.ec2#VerifiedAccessEndpointSubnetIdList", - "traits": { - "aws.protocols#ec2QueryName": "SubnetIdSet", - "smithy.api#documentation": "

The IDs of the subnets.

", - "smithy.api#xmlName": "subnetIdSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a load balancer when creating an Amazon Web Services Verified Access endpoint using the\n load-balancer type.

" - } - }, - "com.amazonaws.ec2#VerifiedAccessEndpointPortNumber": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 65535 - } - } - }, - "com.amazonaws.ec2#VerifiedAccessEndpointProtocol": { - "type": "enum", - "members": { - "http": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "http" - } - }, - "https": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "https" - } - } - } - }, - "com.amazonaws.ec2#VerifiedAccessEndpointStatus": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.ec2#VerifiedAccessEndpointStatusCode", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The status code of the Verified Access endpoint.

", - "smithy.api#xmlName": "code" - } - }, - "Message": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "

The status message of the Verified Access endpoint.

", - "smithy.api#xmlName": "message" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the status of a Verified Access endpoint.

" - } - }, - "com.amazonaws.ec2#VerifiedAccessEndpointStatusCode": { - "type": "enum", - "members": { - "pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "active": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "active" - } - }, - "updating": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "updating" - } - }, - "deleting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleting" - } - }, - "deleted": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleted" - } - } - } - }, - "com.amazonaws.ec2#VerifiedAccessEndpointSubnetIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SubnetId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VerifiedAccessEndpointType": { - "type": "enum", - "members": { - "load_balancer": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "load-balancer" - } - }, - "network_interface": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "network-interface" - } - } - } - }, - "com.amazonaws.ec2#VerifiedAccessGroup": { - "type": "structure", - "members": { - "VerifiedAccessGroupId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VerifiedAccessGroupId", - "smithy.api#documentation": "

The ID of the Verified Access group.

", - "smithy.api#xmlName": "verifiedAccessGroupId" - } - }, - "VerifiedAccessInstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VerifiedAccessInstanceId", - "smithy.api#documentation": "

The ID of the Amazon Web Services Verified Access instance.

", - "smithy.api#xmlName": "verifiedAccessInstanceId" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description for the Amazon Web Services Verified Access group.

", - "smithy.api#xmlName": "description" - } - }, - "Owner": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Owner", - "smithy.api#documentation": "

The Amazon Web Services account number that owns the group.

", - "smithy.api#xmlName": "owner" - } - }, - "VerifiedAccessGroupArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VerifiedAccessGroupArn", - "smithy.api#documentation": "

The ARN of the Verified Access group.

", - "smithy.api#xmlName": "verifiedAccessGroupArn" - } - }, - "CreationTime": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CreationTime", - "smithy.api#documentation": "

The creation time.

", - "smithy.api#xmlName": "creationTime" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LastUpdatedTime", - "smithy.api#documentation": "

The last updated time.

", - "smithy.api#xmlName": "lastUpdatedTime" - } - }, - "DeletionTime": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DeletionTime", - "smithy.api#documentation": "

The deletion time.

", - "smithy.api#xmlName": "deletionTime" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a Verified Access group.

" - } - }, - "com.amazonaws.ec2#VerifiedAccessGroupId": { - "type": "string" - }, - "com.amazonaws.ec2#VerifiedAccessGroupIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VerifiedAccessGroupId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VerifiedAccessGroupList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VerifiedAccessGroup", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VerifiedAccessInstance": { - "type": "structure", - "members": { - "VerifiedAccessInstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VerifiedAccessInstanceId", - "smithy.api#documentation": "

The ID of the Amazon Web Services Verified Access instance.

", - "smithy.api#xmlName": "verifiedAccessInstanceId" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description for the Amazon Web Services Verified Access instance.

", - "smithy.api#xmlName": "description" - } - }, - "VerifiedAccessTrustProviders": { - "target": "com.amazonaws.ec2#VerifiedAccessTrustProviderCondensedList", - "traits": { - "aws.protocols#ec2QueryName": "VerifiedAccessTrustProviderSet", - "smithy.api#documentation": "

The IDs of the Amazon Web Services Verified Access trust providers.

", - "smithy.api#xmlName": "verifiedAccessTrustProviderSet" - } - }, - "CreationTime": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CreationTime", - "smithy.api#documentation": "

The creation time.

", - "smithy.api#xmlName": "creationTime" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LastUpdatedTime", - "smithy.api#documentation": "

The last updated time.

", - "smithy.api#xmlName": "lastUpdatedTime" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a Verified Access instance.

" - } - }, - "com.amazonaws.ec2#VerifiedAccessInstanceId": { - "type": "string" - }, - "com.amazonaws.ec2#VerifiedAccessInstanceIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VerifiedAccessInstanceId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VerifiedAccessInstanceList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VerifiedAccessInstance", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VerifiedAccessInstanceLoggingConfiguration": { - "type": "structure", - "members": { - "VerifiedAccessInstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VerifiedAccessInstanceId", - "smithy.api#documentation": "

The ID of the Amazon Web Services Verified Access instance.

", - "smithy.api#xmlName": "verifiedAccessInstanceId" - } - }, - "AccessLogs": { - "target": "com.amazonaws.ec2#VerifiedAccessLogs", - "traits": { - "aws.protocols#ec2QueryName": "AccessLogs", - "smithy.api#documentation": "

Details about the logging options.

", - "smithy.api#xmlName": "accessLogs" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes logging options for an Amazon Web Services Verified Access instance.

" - } - }, - "com.amazonaws.ec2#VerifiedAccessInstanceLoggingConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VerifiedAccessInstanceLoggingConfiguration", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VerifiedAccessLogCloudWatchLogsDestination": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Enabled", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether logging is enabled.

", - "smithy.api#xmlName": "enabled" - } - }, - "DeliveryStatus": { - "target": "com.amazonaws.ec2#VerifiedAccessLogDeliveryStatus", - "traits": { - "aws.protocols#ec2QueryName": "DeliveryStatus", - "smithy.api#documentation": "

The delivery status for access logs.

", - "smithy.api#xmlName": "deliveryStatus" - } - }, - "LogGroup": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LogGroup", - "smithy.api#documentation": "

The ID of the CloudWatch Logs log group.

", - "smithy.api#xmlName": "logGroup" - } - } - }, - "traits": { - "smithy.api#documentation": "

Options for CloudWatch Logs as a logging destination.

" - } - }, - "com.amazonaws.ec2#VerifiedAccessLogCloudWatchLogsDestinationOptions": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether logging is enabled.

", - "smithy.api#required": {} - } - }, - "LogGroup": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The ID of the CloudWatch Logs log group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Options for CloudWatch Logs as a logging destination.

" - } - }, - "com.amazonaws.ec2#VerifiedAccessLogDeliveryStatus": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.ec2#VerifiedAccessLogDeliveryStatusCode", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The status code.

", - "smithy.api#xmlName": "code" - } - }, - "Message": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "

The status message.

", - "smithy.api#xmlName": "message" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a log delivery status.

" - } - }, - "com.amazonaws.ec2#VerifiedAccessLogDeliveryStatusCode": { - "type": "enum", - "members": { - "SUCCESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "success" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failed" - } - } - } - }, - "com.amazonaws.ec2#VerifiedAccessLogKinesisDataFirehoseDestination": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Enabled", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether logging is enabled.

", - "smithy.api#xmlName": "enabled" - } - }, - "DeliveryStatus": { - "target": "com.amazonaws.ec2#VerifiedAccessLogDeliveryStatus", - "traits": { - "aws.protocols#ec2QueryName": "DeliveryStatus", - "smithy.api#documentation": "

The delivery status.

", - "smithy.api#xmlName": "deliveryStatus" - } - }, - "DeliveryStream": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DeliveryStream", - "smithy.api#documentation": "

The ID of the delivery stream.

", - "smithy.api#xmlName": "deliveryStream" - } - } - }, - "traits": { - "smithy.api#documentation": "

Options for Kinesis as a logging destination.

" - } - }, - "com.amazonaws.ec2#VerifiedAccessLogKinesisDataFirehoseDestinationOptions": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether logging is enabled.

", - "smithy.api#required": {} - } - }, - "DeliveryStream": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The ID of the delivery stream.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes Amazon Kinesis Data Firehose logging options.

" - } - }, - "com.amazonaws.ec2#VerifiedAccessLogOptions": { - "type": "structure", - "members": { - "S3": { - "target": "com.amazonaws.ec2#VerifiedAccessLogS3DestinationOptions", - "traits": { - "smithy.api#documentation": "

Sends Verified Access logs to Amazon S3.

" - } - }, - "CloudWatchLogs": { - "target": "com.amazonaws.ec2#VerifiedAccessLogCloudWatchLogsDestinationOptions", - "traits": { - "smithy.api#documentation": "

Sends Verified Access logs to CloudWatch Logs.

" - } - }, - "KinesisDataFirehose": { - "target": "com.amazonaws.ec2#VerifiedAccessLogKinesisDataFirehoseDestinationOptions", - "traits": { - "smithy.api#documentation": "

Sends Verified Access logs to Kinesis.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the destinations for Verified Access logs.

" - } - }, - "com.amazonaws.ec2#VerifiedAccessLogS3Destination": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Enabled", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether logging is enabled.

", - "smithy.api#xmlName": "enabled" - } - }, - "DeliveryStatus": { - "target": "com.amazonaws.ec2#VerifiedAccessLogDeliveryStatus", - "traits": { - "aws.protocols#ec2QueryName": "DeliveryStatus", - "smithy.api#documentation": "

The delivery status.

", - "smithy.api#xmlName": "deliveryStatus" - } - }, - "BucketName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "BucketName", - "smithy.api#documentation": "

The bucket name.

", - "smithy.api#xmlName": "bucketName" - } - }, - "Prefix": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Prefix", - "smithy.api#documentation": "

The bucket prefix.

", - "smithy.api#xmlName": "prefix" - } - }, - "BucketOwner": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "BucketOwner", - "smithy.api#documentation": "

The Amazon Web Services account number that owns the bucket.

", - "smithy.api#xmlName": "bucketOwner" - } - } - }, - "traits": { - "smithy.api#documentation": "

Options for Amazon S3 as a logging destination.

" - } - }, - "com.amazonaws.ec2#VerifiedAccessLogS3DestinationOptions": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether logging is enabled.

", - "smithy.api#required": {} - } - }, - "BucketName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The bucket name.

" - } - }, - "Prefix": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The bucket prefix.

" - } - }, - "BucketOwner": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the Amazon S3 bucket.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Options for Amazon S3 as a logging destination.

" - } - }, - "com.amazonaws.ec2#VerifiedAccessLogs": { - "type": "structure", - "members": { - "S3": { - "target": "com.amazonaws.ec2#VerifiedAccessLogS3Destination", - "traits": { - "aws.protocols#ec2QueryName": "S3", - "smithy.api#documentation": "

Amazon S3 logging options.

", - "smithy.api#xmlName": "s3" - } - }, - "CloudWatchLogs": { - "target": "com.amazonaws.ec2#VerifiedAccessLogCloudWatchLogsDestination", - "traits": { - "aws.protocols#ec2QueryName": "CloudWatchLogs", - "smithy.api#documentation": "

CloudWatch Logs logging destination.

", - "smithy.api#xmlName": "cloudWatchLogs" - } - }, - "KinesisDataFirehose": { - "target": "com.amazonaws.ec2#VerifiedAccessLogKinesisDataFirehoseDestination", - "traits": { - "aws.protocols#ec2QueryName": "KinesisDataFirehose", - "smithy.api#documentation": "

Kinesis logging destination.

", - "smithy.api#xmlName": "kinesisDataFirehose" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the destinations for Verified Access logs.

" - } - }, - "com.amazonaws.ec2#VerifiedAccessTrustProvider": { - "type": "structure", - "members": { - "VerifiedAccessTrustProviderId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VerifiedAccessTrustProviderId", - "smithy.api#documentation": "

The ID of the Amazon Web Services Verified Access trust provider.

", - "smithy.api#xmlName": "verifiedAccessTrustProviderId" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description for the Amazon Web Services Verified Access trust provider.

", - "smithy.api#xmlName": "description" - } - }, - "TrustProviderType": { - "target": "com.amazonaws.ec2#TrustProviderType", - "traits": { - "aws.protocols#ec2QueryName": "TrustProviderType", - "smithy.api#documentation": "

The type of Verified Access trust provider.

", - "smithy.api#xmlName": "trustProviderType" - } - }, - "UserTrustProviderType": { - "target": "com.amazonaws.ec2#UserTrustProviderType", - "traits": { - "aws.protocols#ec2QueryName": "UserTrustProviderType", - "smithy.api#documentation": "

The type of user-based trust provider.

", - "smithy.api#xmlName": "userTrustProviderType" - } - }, - "DeviceTrustProviderType": { - "target": "com.amazonaws.ec2#DeviceTrustProviderType", - "traits": { - "aws.protocols#ec2QueryName": "DeviceTrustProviderType", - "smithy.api#documentation": "

The type of device-based trust provider.

", - "smithy.api#xmlName": "deviceTrustProviderType" - } - }, - "OidcOptions": { - "target": "com.amazonaws.ec2#OidcOptions", - "traits": { - "aws.protocols#ec2QueryName": "OidcOptions", - "smithy.api#documentation": "

The options for an OpenID Connect-compatible user-identity trust provider.

", - "smithy.api#xmlName": "oidcOptions" - } - }, - "DeviceOptions": { - "target": "com.amazonaws.ec2#DeviceOptions", - "traits": { - "aws.protocols#ec2QueryName": "DeviceOptions", - "smithy.api#documentation": "

The options for device-identity trust provider.

", - "smithy.api#xmlName": "deviceOptions" - } - }, - "PolicyReferenceName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PolicyReferenceName", - "smithy.api#documentation": "

The identifier to be used when working with policy rules.

", - "smithy.api#xmlName": "policyReferenceName" - } - }, - "CreationTime": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CreationTime", - "smithy.api#documentation": "

The creation time.

", - "smithy.api#xmlName": "creationTime" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LastUpdatedTime", - "smithy.api#documentation": "

The last updated time.

", - "smithy.api#xmlName": "lastUpdatedTime" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a Verified Access trust provider.

" - } - }, - "com.amazonaws.ec2#VerifiedAccessTrustProviderCondensed": { - "type": "structure", - "members": { - "VerifiedAccessTrustProviderId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VerifiedAccessTrustProviderId", - "smithy.api#documentation": "

The ID of the trust provider.

", - "smithy.api#xmlName": "verifiedAccessTrustProviderId" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

The description of trust provider.

", - "smithy.api#xmlName": "description" - } - }, - "TrustProviderType": { - "target": "com.amazonaws.ec2#TrustProviderType", - "traits": { - "aws.protocols#ec2QueryName": "TrustProviderType", - "smithy.api#documentation": "

The type of trust provider (user- or device-based).

", - "smithy.api#xmlName": "trustProviderType" - } - }, - "UserTrustProviderType": { - "target": "com.amazonaws.ec2#UserTrustProviderType", - "traits": { - "aws.protocols#ec2QueryName": "UserTrustProviderType", - "smithy.api#documentation": "

The type of user-based trust provider.

", - "smithy.api#xmlName": "userTrustProviderType" - } - }, - "DeviceTrustProviderType": { - "target": "com.amazonaws.ec2#DeviceTrustProviderType", - "traits": { - "aws.protocols#ec2QueryName": "DeviceTrustProviderType", - "smithy.api#documentation": "

The type of device-based trust provider.

", - "smithy.api#xmlName": "deviceTrustProviderType" - } - } - }, - "traits": { - "smithy.api#documentation": "

Condensed information about a trust provider.

" - } - }, - "com.amazonaws.ec2#VerifiedAccessTrustProviderCondensedList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VerifiedAccessTrustProviderCondensed", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VerifiedAccessTrustProviderId": { - "type": "string" - }, - "com.amazonaws.ec2#VerifiedAccessTrustProviderIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VerifiedAccessTrustProviderId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VerifiedAccessTrustProviderList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VerifiedAccessTrustProvider", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VersionDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - } - } - }, - "com.amazonaws.ec2#VersionStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VgwTelemetry": { - "type": "structure", - "members": { - "AcceptedRouteCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "AcceptedRouteCount", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of accepted routes.

", - "smithy.api#xmlName": "acceptedRouteCount" - } - }, - "LastStatusChange": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "LastStatusChange", - "smithy.api#documentation": "

The date and time of the last change in status.

", - "smithy.api#xmlName": "lastStatusChange" - } - }, - "OutsideIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OutsideIpAddress", - "smithy.api#documentation": "

The Internet-routable IP address of the virtual private gateway's outside\n interface.

", - "smithy.api#xmlName": "outsideIpAddress" - } - }, - "Status": { - "target": "com.amazonaws.ec2#TelemetryStatus", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The status of the VPN tunnel.

", - "smithy.api#xmlName": "status" - } - }, - "StatusMessage": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StatusMessage", - "smithy.api#documentation": "

If an error occurs, a description of the error.

", - "smithy.api#xmlName": "statusMessage" - } - }, - "CertificateArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CertificateArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate.

", - "smithy.api#xmlName": "certificateArn" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes telemetry for a VPN tunnel.

" - } - }, - "com.amazonaws.ec2#VgwTelemetryList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VgwTelemetry", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VirtualizationType": { - "type": "enum", - "members": { - "hvm": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "hvm" - } - }, - "paravirtual": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "paravirtual" - } - } - } - }, - "com.amazonaws.ec2#VirtualizationTypeList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VirtualizationType", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VirtualizationTypeSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VirtualizationType", - "traits": { - "smithy.api#xmlName": "item" - } - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2 - } - } - }, - "com.amazonaws.ec2#Volume": { - "type": "structure", - "members": { - "Attachments": { - "target": "com.amazonaws.ec2#VolumeAttachmentList", - "traits": { - "aws.protocols#ec2QueryName": "AttachmentSet", - "smithy.api#documentation": "

Information about the volume attachments.

", - "smithy.api#xmlName": "attachmentSet" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone for the volume.

", - "smithy.api#xmlName": "availabilityZone" - } - }, - "CreateTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "CreateTime", - "smithy.api#documentation": "

The time stamp when volume creation was initiated.

", - "smithy.api#xmlName": "createTime" - } - }, - "Encrypted": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Encrypted", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the volume is encrypted.

", - "smithy.api#xmlName": "encrypted" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "KmsKeyId", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the\n volume encryption key for the volume.

", - "smithy.api#xmlName": "kmsKeyId" - } - }, - "OutpostArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OutpostArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

", - "smithy.api#xmlName": "outpostArn" - } - }, - "Size": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Size", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The size of the volume, in GiBs.

", - "smithy.api#xmlName": "size" - } - }, - "SnapshotId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SnapshotId", - "smithy.api#documentation": "

The snapshot from which the volume was created, if applicable.

", - "smithy.api#xmlName": "snapshotId" - } - }, - "State": { - "target": "com.amazonaws.ec2#VolumeState", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The volume state.

", - "smithy.api#xmlName": "status" - } - }, - "VolumeId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VolumeId", - "smithy.api#documentation": "

The ID of the volume.

", - "smithy.api#xmlName": "volumeId" - } - }, - "Iops": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Iops", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents \n the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline \n performance of the volume and the rate at which the volume accumulates I/O credits for bursting.

", - "smithy.api#xmlName": "iops" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the volume.

", - "smithy.api#xmlName": "tagSet" - } - }, - "VolumeType": { - "target": "com.amazonaws.ec2#VolumeType", - "traits": { - "aws.protocols#ec2QueryName": "VolumeType", - "smithy.api#documentation": "

The volume type.

", - "smithy.api#xmlName": "volumeType" - } - }, - "FastRestored": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "FastRestored", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the volume was created using fast snapshot restore.

", - "smithy.api#xmlName": "fastRestored" - } - }, - "MultiAttachEnabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "MultiAttachEnabled", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether Amazon EBS Multi-Attach is enabled.

", - "smithy.api#xmlName": "multiAttachEnabled" - } - }, - "Throughput": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Throughput", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The throughput that the volume supports, in MiB/s.

", - "smithy.api#xmlName": "throughput" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a volume.

" - } - }, - "com.amazonaws.ec2#VolumeAttachment": { - "type": "structure", - "members": { - "AttachTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "AttachTime", - "smithy.api#documentation": "

The time stamp when the attachment initiated.

", - "smithy.api#xmlName": "attachTime" - } - }, - "Device": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Device", - "smithy.api#documentation": "

The device name.

", - "smithy.api#xmlName": "device" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#xmlName": "instanceId" - } - }, - "State": { - "target": "com.amazonaws.ec2#VolumeAttachmentState", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The attachment state of the volume.

", - "smithy.api#xmlName": "status" - } - }, - "VolumeId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VolumeId", - "smithy.api#documentation": "

The ID of the volume.

", - "smithy.api#xmlName": "volumeId" - } - }, - "DeleteOnTermination": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DeleteOnTermination", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the EBS volume is deleted on instance termination.

", - "smithy.api#xmlName": "deleteOnTermination" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes volume attachment details.

" - } - }, - "com.amazonaws.ec2#VolumeAttachmentList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VolumeAttachment", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VolumeAttachmentState": { - "type": "enum", - "members": { - "attaching": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "attaching" - } - }, - "attached": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "attached" - } - }, - "detaching": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "detaching" - } - }, - "detached": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "detached" - } - }, - "busy": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "busy" - } - } - } - }, - "com.amazonaws.ec2#VolumeAttributeName": { - "type": "enum", - "members": { - "autoEnableIO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "autoEnableIO" - } - }, - "productCodes": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "productCodes" - } - } - } - }, - "com.amazonaws.ec2#VolumeDetail": { - "type": "structure", - "members": { - "Size": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "aws.protocols#ec2QueryName": "Size", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The size of the volume, in GiB.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "size" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an EBS volume.

" - } - }, - "com.amazonaws.ec2#VolumeId": { - "type": "string" - }, - "com.amazonaws.ec2#VolumeIdStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VolumeId", - "traits": { - "smithy.api#xmlName": "VolumeId" - } - } - }, - "com.amazonaws.ec2#VolumeIdWithResolver": { - "type": "string" - }, - "com.amazonaws.ec2#VolumeList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Volume", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VolumeModification": { - "type": "structure", - "members": { - "VolumeId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VolumeId", - "smithy.api#documentation": "

The ID of the volume.

", - "smithy.api#xmlName": "volumeId" - } - }, - "ModificationState": { - "target": "com.amazonaws.ec2#VolumeModificationState", - "traits": { - "aws.protocols#ec2QueryName": "ModificationState", - "smithy.api#documentation": "

The current modification state. The modification state is null for unmodified\n volumes.

", - "smithy.api#xmlName": "modificationState" - } - }, - "StatusMessage": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StatusMessage", - "smithy.api#documentation": "

A status message about the modification progress or failure.

", - "smithy.api#xmlName": "statusMessage" - } - }, - "TargetSize": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "TargetSize", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The target size of the volume, in GiB.

", - "smithy.api#xmlName": "targetSize" - } - }, - "TargetIops": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "TargetIops", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The target IOPS rate of the volume.

", - "smithy.api#xmlName": "targetIops" - } - }, - "TargetVolumeType": { - "target": "com.amazonaws.ec2#VolumeType", - "traits": { - "aws.protocols#ec2QueryName": "TargetVolumeType", - "smithy.api#documentation": "

The target EBS volume type of the volume.

", - "smithy.api#xmlName": "targetVolumeType" - } - }, - "TargetThroughput": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "TargetThroughput", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The target throughput of the volume, in MiB/s.

", - "smithy.api#xmlName": "targetThroughput" - } - }, - "TargetMultiAttachEnabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "TargetMultiAttachEnabled", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

The target setting for Amazon EBS Multi-Attach.

", - "smithy.api#xmlName": "targetMultiAttachEnabled" - } - }, - "OriginalSize": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "OriginalSize", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The original size of the volume, in GiB.

", - "smithy.api#xmlName": "originalSize" - } - }, - "OriginalIops": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "OriginalIops", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The original IOPS rate of the volume.

", - "smithy.api#xmlName": "originalIops" - } - }, - "OriginalVolumeType": { - "target": "com.amazonaws.ec2#VolumeType", - "traits": { - "aws.protocols#ec2QueryName": "OriginalVolumeType", - "smithy.api#documentation": "

The original EBS volume type of the volume.

", - "smithy.api#xmlName": "originalVolumeType" - } - }, - "OriginalThroughput": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "OriginalThroughput", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The original throughput of the volume, in MiB/s.

", - "smithy.api#xmlName": "originalThroughput" - } - }, - "OriginalMultiAttachEnabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "OriginalMultiAttachEnabled", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

The original setting for Amazon EBS Multi-Attach.

", - "smithy.api#xmlName": "originalMultiAttachEnabled" - } - }, - "Progress": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "aws.protocols#ec2QueryName": "Progress", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The modification progress, from 0 to 100 percent complete.

", - "smithy.api#xmlName": "progress" - } - }, - "StartTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "StartTime", - "smithy.api#documentation": "

The modification start time.

", - "smithy.api#xmlName": "startTime" - } - }, - "EndTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "EndTime", - "smithy.api#documentation": "

The modification completion or failure time.

", - "smithy.api#xmlName": "endTime" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the modification status of an EBS volume.

\n

If the volume has never been modified, some element values will be null.

" - } - }, - "com.amazonaws.ec2#VolumeModificationList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VolumeModification", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VolumeModificationState": { - "type": "enum", - "members": { - "modifying": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "modifying" - } - }, - "optimizing": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "optimizing" - } - }, - "completed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "completed" - } - }, - "failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failed" - } - } - } - }, - "com.amazonaws.ec2#VolumeState": { - "type": "enum", - "members": { - "creating": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "creating" - } - }, - "available": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "available" - } - }, - "in_use": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "in-use" - } - }, - "deleting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleting" - } - }, - "deleted": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleted" - } - }, - "error": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "error" - } - } - } - }, - "com.amazonaws.ec2#VolumeStatusAction": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The code identifying the operation, for example, enable-volume-io.

", - "smithy.api#xmlName": "code" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description of the operation.

", - "smithy.api#xmlName": "description" - } - }, - "EventId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "EventId", - "smithy.api#documentation": "

The ID of the event associated with this operation.

", - "smithy.api#xmlName": "eventId" - } - }, - "EventType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "EventType", - "smithy.api#documentation": "

The event type associated with this operation.

", - "smithy.api#xmlName": "eventType" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a volume status operation code.

" - } - }, - "com.amazonaws.ec2#VolumeStatusActionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VolumeStatusAction", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VolumeStatusAttachmentStatus": { - "type": "structure", - "members": { - "IoPerformance": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "IoPerformance", - "smithy.api#documentation": "

The maximum IOPS supported by the attached instance.

", - "smithy.api#xmlName": "ioPerformance" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the attached instance.

", - "smithy.api#xmlName": "instanceId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the instances to which the volume is attached.

" - } - }, - "com.amazonaws.ec2#VolumeStatusAttachmentStatusList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VolumeStatusAttachmentStatus", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VolumeStatusDetails": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.ec2#VolumeStatusName", - "traits": { - "aws.protocols#ec2QueryName": "Name", - "smithy.api#documentation": "

The name of the volume status.

", - "smithy.api#xmlName": "name" - } - }, - "Status": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The intended status of the volume status.

", - "smithy.api#xmlName": "status" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a volume status.

" - } - }, - "com.amazonaws.ec2#VolumeStatusDetailsList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VolumeStatusDetails", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VolumeStatusEvent": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description of the event.

", - "smithy.api#xmlName": "description" - } - }, - "EventId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "EventId", - "smithy.api#documentation": "

The ID of this event.

", - "smithy.api#xmlName": "eventId" - } - }, - "EventType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "EventType", - "smithy.api#documentation": "

The type of this event.

", - "smithy.api#xmlName": "eventType" - } - }, - "NotAfter": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "NotAfter", - "smithy.api#documentation": "

The latest end time of the event.

", - "smithy.api#xmlName": "notAfter" - } - }, - "NotBefore": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "NotBefore", - "smithy.api#documentation": "

The earliest start time of the event.

", - "smithy.api#xmlName": "notBefore" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance associated with the event.

", - "smithy.api#xmlName": "instanceId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a volume status event.

" - } - }, - "com.amazonaws.ec2#VolumeStatusEventsList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VolumeStatusEvent", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VolumeStatusInfo": { - "type": "structure", - "members": { - "Details": { - "target": "com.amazonaws.ec2#VolumeStatusDetailsList", - "traits": { - "aws.protocols#ec2QueryName": "Details", - "smithy.api#documentation": "

The details of the volume status.

", - "smithy.api#xmlName": "details" - } - }, - "Status": { - "target": "com.amazonaws.ec2#VolumeStatusInfoStatus", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The status of the volume.

", - "smithy.api#xmlName": "status" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the status of a volume.

" - } - }, - "com.amazonaws.ec2#VolumeStatusInfoStatus": { - "type": "enum", - "members": { - "ok": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ok" - } - }, - "impaired": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "impaired" - } - }, - "insufficient_data": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "insufficient-data" - } - } - } - }, - "com.amazonaws.ec2#VolumeStatusItem": { - "type": "structure", - "members": { - "Actions": { - "target": "com.amazonaws.ec2#VolumeStatusActionsList", - "traits": { - "aws.protocols#ec2QueryName": "ActionsSet", - "smithy.api#documentation": "

The details of the operation.

", - "smithy.api#xmlName": "actionsSet" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone of the volume.

", - "smithy.api#xmlName": "availabilityZone" - } - }, - "OutpostArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OutpostArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

", - "smithy.api#xmlName": "outpostArn" - } - }, - "Events": { - "target": "com.amazonaws.ec2#VolumeStatusEventsList", - "traits": { - "aws.protocols#ec2QueryName": "EventsSet", - "smithy.api#documentation": "

A list of events associated with the volume.

", - "smithy.api#xmlName": "eventsSet" - } - }, - "VolumeId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VolumeId", - "smithy.api#documentation": "

The volume ID.

", - "smithy.api#xmlName": "volumeId" - } - }, - "VolumeStatus": { - "target": "com.amazonaws.ec2#VolumeStatusInfo", - "traits": { - "aws.protocols#ec2QueryName": "VolumeStatus", - "smithy.api#documentation": "

The volume status.

", - "smithy.api#xmlName": "volumeStatus" - } - }, - "AttachmentStatuses": { - "target": "com.amazonaws.ec2#VolumeStatusAttachmentStatusList", - "traits": { - "aws.protocols#ec2QueryName": "AttachmentStatuses", - "smithy.api#documentation": "

Information about the instances to which the volume is attached.

", - "smithy.api#xmlName": "attachmentStatuses" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the volume status.

" - } - }, - "com.amazonaws.ec2#VolumeStatusList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VolumeStatusItem", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VolumeStatusName": { - "type": "enum", - "members": { - "io_enabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "io-enabled" - } - }, - "io_performance": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "io-performance" - } - } - } - }, - "com.amazonaws.ec2#VolumeType": { - "type": "enum", - "members": { - "standard": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "standard" - } - }, - "io1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "io1" - } - }, - "io2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "io2" - } - }, - "gp2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "gp2" - } - }, - "sc1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "sc1" - } - }, - "st1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "st1" - } - }, - "gp3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "gp3" - } - } - } - }, - "com.amazonaws.ec2#Vpc": { - "type": "structure", - "members": { - "CidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CidrBlock", - "smithy.api#documentation": "

The primary IPv4 CIDR block for the VPC.

", - "smithy.api#xmlName": "cidrBlock" - } - }, - "DhcpOptionsId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DhcpOptionsId", - "smithy.api#documentation": "

The ID of the set of DHCP options you've associated with the VPC.

", - "smithy.api#xmlName": "dhcpOptionsId" - } - }, - "State": { - "target": "com.amazonaws.ec2#VpcState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The current state of the VPC.

", - "smithy.api#xmlName": "state" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#xmlName": "vpcId" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the VPC.

", - "smithy.api#xmlName": "ownerId" - } - }, - "InstanceTenancy": { - "target": "com.amazonaws.ec2#Tenancy", - "traits": { - "aws.protocols#ec2QueryName": "InstanceTenancy", - "smithy.api#documentation": "

The allowed tenancy of instances launched into the VPC.

", - "smithy.api#xmlName": "instanceTenancy" - } - }, - "Ipv6CidrBlockAssociationSet": { - "target": "com.amazonaws.ec2#VpcIpv6CidrBlockAssociationSet", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6CidrBlockAssociationSet", - "smithy.api#documentation": "

Information about the IPv6 CIDR blocks associated with the VPC.

", - "smithy.api#xmlName": "ipv6CidrBlockAssociationSet" - } - }, - "CidrBlockAssociationSet": { - "target": "com.amazonaws.ec2#VpcCidrBlockAssociationSet", - "traits": { - "aws.protocols#ec2QueryName": "CidrBlockAssociationSet", - "smithy.api#documentation": "

Information about the IPv4 CIDR blocks associated with the VPC.

", - "smithy.api#xmlName": "cidrBlockAssociationSet" - } - }, - "IsDefault": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "IsDefault", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the VPC is the default VPC.

", - "smithy.api#xmlName": "isDefault" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the VPC.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a VPC.

" - } - }, - "com.amazonaws.ec2#VpcAttachment": { - "type": "structure", - "members": { - "State": { - "target": "com.amazonaws.ec2#AttachmentStatus", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The current state of the attachment.

", - "smithy.api#xmlName": "state" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#xmlName": "vpcId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an attachment between a virtual private gateway and a VPC.

" - } - }, - "com.amazonaws.ec2#VpcAttachmentList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VpcAttachment", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VpcAttributeName": { - "type": "enum", - "members": { - "enableDnsSupport": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enableDnsSupport" - } - }, - "enableDnsHostnames": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enableDnsHostnames" - } - }, - "enableNetworkAddressUsageMetrics": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enableNetworkAddressUsageMetrics" - } - } - } - }, - "com.amazonaws.ec2#VpcCidrAssociationId": { - "type": "string" - }, - "com.amazonaws.ec2#VpcCidrBlockAssociation": { - "type": "structure", - "members": { - "AssociationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AssociationId", - "smithy.api#documentation": "

The association ID for the IPv4 CIDR block.

", - "smithy.api#xmlName": "associationId" - } - }, - "CidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CidrBlock", - "smithy.api#documentation": "

The IPv4 CIDR block.

", - "smithy.api#xmlName": "cidrBlock" - } - }, - "CidrBlockState": { - "target": "com.amazonaws.ec2#VpcCidrBlockState", - "traits": { - "aws.protocols#ec2QueryName": "CidrBlockState", - "smithy.api#documentation": "

Information about the state of the CIDR block.

", - "smithy.api#xmlName": "cidrBlockState" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an IPv4 CIDR block associated with a VPC.

" - } - }, - "com.amazonaws.ec2#VpcCidrBlockAssociationSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VpcCidrBlockAssociation", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VpcCidrBlockState": { - "type": "structure", - "members": { - "State": { - "target": "com.amazonaws.ec2#VpcCidrBlockStateCode", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the CIDR block.

", - "smithy.api#xmlName": "state" - } - }, - "StatusMessage": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StatusMessage", - "smithy.api#documentation": "

A message about the status of the CIDR block, if applicable.

", - "smithy.api#xmlName": "statusMessage" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the state of a CIDR block.

" - } - }, - "com.amazonaws.ec2#VpcCidrBlockStateCode": { - "type": "enum", - "members": { - "associating": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "associating" - } - }, - "associated": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "associated" - } - }, - "disassociating": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disassociating" - } - }, - "disassociated": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disassociated" - } - }, - "failing": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failing" - } - }, - "failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failed" - } - } - } - }, - "com.amazonaws.ec2#VpcClassicLink": { - "type": "structure", - "members": { - "ClassicLinkEnabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "ClassicLinkEnabled", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the VPC is enabled for ClassicLink.

", - "smithy.api#xmlName": "classicLinkEnabled" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the VPC.

", - "smithy.api#xmlName": "tagSet" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#xmlName": "vpcId" - } - } - }, - "traits": { - "smithy.api#documentation": "\n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n \n

Describes whether a VPC is enabled for ClassicLink.

" - } - }, - "com.amazonaws.ec2#VpcClassicLinkIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VpcId", - "traits": { - "smithy.api#xmlName": "VpcId" - } - } - }, - "com.amazonaws.ec2#VpcClassicLinkList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VpcClassicLink", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VpcEndpoint": { - "type": "structure", - "members": { - "VpcEndpointId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcEndpointId", - "smithy.api#documentation": "

The ID of the endpoint.

", - "smithy.api#xmlName": "vpcEndpointId" - } - }, - "VpcEndpointType": { - "target": "com.amazonaws.ec2#VpcEndpointType", - "traits": { - "aws.protocols#ec2QueryName": "VpcEndpointType", - "smithy.api#documentation": "

The type of endpoint.

", - "smithy.api#xmlName": "vpcEndpointType" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC to which the endpoint is associated.

", - "smithy.api#xmlName": "vpcId" - } - }, - "ServiceName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ServiceName", - "smithy.api#documentation": "

The name of the service to which the endpoint is associated.

", - "smithy.api#xmlName": "serviceName" - } - }, - "State": { - "target": "com.amazonaws.ec2#State", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the endpoint.

", - "smithy.api#xmlName": "state" - } - }, - "PolicyDocument": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PolicyDocument", - "smithy.api#documentation": "

The policy document associated with the endpoint, if applicable.

", - "smithy.api#xmlName": "policyDocument" - } - }, - "RouteTableIds": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "RouteTableIdSet", - "smithy.api#documentation": "

(Gateway endpoint) The IDs of the route tables associated with the endpoint.

", - "smithy.api#xmlName": "routeTableIdSet" - } - }, - "SubnetIds": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "SubnetIdSet", - "smithy.api#documentation": "

(Interface endpoint) The subnets for the endpoint.

", - "smithy.api#xmlName": "subnetIdSet" - } - }, - "Groups": { - "target": "com.amazonaws.ec2#GroupIdentifierSet", - "traits": { - "aws.protocols#ec2QueryName": "GroupSet", - "smithy.api#documentation": "

(Interface endpoint) Information about the security groups that are associated with\n the network interface.

", - "smithy.api#xmlName": "groupSet" - } - }, - "IpAddressType": { - "target": "com.amazonaws.ec2#IpAddressType", - "traits": { - "aws.protocols#ec2QueryName": "IpAddressType", - "smithy.api#documentation": "

The IP address type for the endpoint.

", - "smithy.api#xmlName": "ipAddressType" - } - }, - "DnsOptions": { - "target": "com.amazonaws.ec2#DnsOptions", - "traits": { - "aws.protocols#ec2QueryName": "DnsOptions", - "smithy.api#documentation": "

The DNS options for the endpoint.

", - "smithy.api#xmlName": "dnsOptions" - } - }, - "PrivateDnsEnabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "PrivateDnsEnabled", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

(Interface endpoint) Indicates whether the VPC is associated with a private hosted zone.

", - "smithy.api#xmlName": "privateDnsEnabled" - } - }, - "RequesterManaged": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "RequesterManaged", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the endpoint is being managed by its service.

", - "smithy.api#xmlName": "requesterManaged" - } - }, - "NetworkInterfaceIds": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceIdSet", - "smithy.api#documentation": "

(Interface endpoint) The network interfaces for the endpoint.

", - "smithy.api#xmlName": "networkInterfaceIdSet" - } - }, - "DnsEntries": { - "target": "com.amazonaws.ec2#DnsEntrySet", - "traits": { - "aws.protocols#ec2QueryName": "DnsEntrySet", - "smithy.api#documentation": "

(Interface endpoint) The DNS entries for the endpoint.

", - "smithy.api#xmlName": "dnsEntrySet" - } - }, - "CreationTimestamp": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "CreationTimestamp", - "smithy.api#documentation": "

The date and time that the endpoint was created.

", - "smithy.api#xmlName": "creationTimestamp" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags assigned to the endpoint.

", - "smithy.api#xmlName": "tagSet" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the endpoint.

", - "smithy.api#xmlName": "ownerId" - } - }, - "LastError": { - "target": "com.amazonaws.ec2#LastError", - "traits": { - "aws.protocols#ec2QueryName": "LastError", - "smithy.api#documentation": "

The last error that occurred for endpoint.

", - "smithy.api#xmlName": "lastError" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a VPC endpoint.

" - } - }, - "com.amazonaws.ec2#VpcEndpointConnection": { - "type": "structure", - "members": { - "ServiceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ServiceId", - "smithy.api#documentation": "

The ID of the service to which the endpoint is connected.

", - "smithy.api#xmlName": "serviceId" - } - }, - "VpcEndpointId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcEndpointId", - "smithy.api#documentation": "

The ID of the VPC endpoint.

", - "smithy.api#xmlName": "vpcEndpointId" - } - }, - "VpcEndpointOwner": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcEndpointOwner", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the VPC endpoint.

", - "smithy.api#xmlName": "vpcEndpointOwner" - } - }, - "VpcEndpointState": { - "target": "com.amazonaws.ec2#State", - "traits": { - "aws.protocols#ec2QueryName": "VpcEndpointState", - "smithy.api#documentation": "

The state of the VPC endpoint.

", - "smithy.api#xmlName": "vpcEndpointState" - } - }, - "CreationTimestamp": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "CreationTimestamp", - "smithy.api#documentation": "

The date and time that the VPC endpoint was created.

", - "smithy.api#xmlName": "creationTimestamp" - } - }, - "DnsEntries": { - "target": "com.amazonaws.ec2#DnsEntrySet", - "traits": { - "aws.protocols#ec2QueryName": "DnsEntrySet", - "smithy.api#documentation": "

The DNS entries for the VPC endpoint.

", - "smithy.api#xmlName": "dnsEntrySet" - } - }, - "NetworkLoadBalancerArns": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "NetworkLoadBalancerArnSet", - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the network load balancers for the service.

", - "smithy.api#xmlName": "networkLoadBalancerArnSet" - } - }, - "GatewayLoadBalancerArns": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "GatewayLoadBalancerArnSet", - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.

", - "smithy.api#xmlName": "gatewayLoadBalancerArnSet" - } - }, - "IpAddressType": { - "target": "com.amazonaws.ec2#IpAddressType", - "traits": { - "aws.protocols#ec2QueryName": "IpAddressType", - "smithy.api#documentation": "

The IP address type for the endpoint.

", - "smithy.api#xmlName": "ipAddressType" - } - }, - "VpcEndpointConnectionId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcEndpointConnectionId", - "smithy.api#documentation": "

The ID of the VPC endpoint connection.

", - "smithy.api#xmlName": "vpcEndpointConnectionId" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a VPC endpoint connection to a service.

" - } - }, - "com.amazonaws.ec2#VpcEndpointConnectionSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VpcEndpointConnection", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VpcEndpointId": { - "type": "string" - }, - "com.amazonaws.ec2#VpcEndpointIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VpcEndpointId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VpcEndpointRouteTableIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#RouteTableId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VpcEndpointSecurityGroupIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SecurityGroupId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VpcEndpointServiceId": { - "type": "string" - }, - "com.amazonaws.ec2#VpcEndpointServiceIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VpcEndpointServiceId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VpcEndpointSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VpcEndpoint", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VpcEndpointSubnetIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SubnetId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VpcEndpointType": { - "type": "enum", - "members": { - "Interface": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Interface" - } - }, - "Gateway": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Gateway" - } - }, - "GatewayLoadBalancer": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GatewayLoadBalancer" - } - } - } - }, - "com.amazonaws.ec2#VpcFlowLogId": { - "type": "string" - }, - "com.amazonaws.ec2#VpcId": { - "type": "string" - }, - "com.amazonaws.ec2#VpcIdStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VpcId", - "traits": { - "smithy.api#xmlName": "VpcId" - } - } - }, - "com.amazonaws.ec2#VpcIpv6CidrBlockAssociation": { - "type": "structure", - "members": { - "AssociationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AssociationId", - "smithy.api#documentation": "

The association ID for the IPv6 CIDR block.

", - "smithy.api#xmlName": "associationId" - } - }, - "Ipv6CidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6CidrBlock", - "smithy.api#documentation": "

The IPv6 CIDR block.

", - "smithy.api#xmlName": "ipv6CidrBlock" - } - }, - "Ipv6CidrBlockState": { - "target": "com.amazonaws.ec2#VpcCidrBlockState", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6CidrBlockState", - "smithy.api#documentation": "

Information about the state of the CIDR block.

", - "smithy.api#xmlName": "ipv6CidrBlockState" - } - }, - "NetworkBorderGroup": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NetworkBorderGroup", - "smithy.api#documentation": "

The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from\n which Amazon Web Services advertises IP addresses, for example, us-east-1-wl1-bos-wlz-1.

", - "smithy.api#xmlName": "networkBorderGroup" - } - }, - "Ipv6Pool": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6Pool", - "smithy.api#documentation": "

The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.

", - "smithy.api#xmlName": "ipv6Pool" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an IPv6 CIDR block associated with a VPC.

" - } - }, - "com.amazonaws.ec2#VpcIpv6CidrBlockAssociationSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VpcIpv6CidrBlockAssociation", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VpcList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#Vpc", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VpcPeeringConnection": { - "type": "structure", - "members": { - "AccepterVpcInfo": { - "target": "com.amazonaws.ec2#VpcPeeringConnectionVpcInfo", - "traits": { - "aws.protocols#ec2QueryName": "AccepterVpcInfo", - "smithy.api#documentation": "

Information about the accepter VPC. CIDR block information is only returned when describing an active VPC peering connection.

", - "smithy.api#xmlName": "accepterVpcInfo" - } - }, - "ExpirationTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "ExpirationTime", - "smithy.api#documentation": "

The time that an unaccepted VPC peering connection will expire.

", - "smithy.api#xmlName": "expirationTime" - } - }, - "RequesterVpcInfo": { - "target": "com.amazonaws.ec2#VpcPeeringConnectionVpcInfo", - "traits": { - "aws.protocols#ec2QueryName": "RequesterVpcInfo", - "smithy.api#documentation": "

Information about the requester VPC. CIDR block information is only returned when describing an active VPC peering connection.

", - "smithy.api#xmlName": "requesterVpcInfo" - } - }, - "Status": { - "target": "com.amazonaws.ec2#VpcPeeringConnectionStateReason", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The status of the VPC peering connection.

", - "smithy.api#xmlName": "status" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the resource.

", - "smithy.api#xmlName": "tagSet" - } - }, - "VpcPeeringConnectionId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", - "smithy.api#documentation": "

The ID of the VPC peering connection.

", - "smithy.api#xmlName": "vpcPeeringConnectionId" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a VPC peering connection.

" - } - }, - "com.amazonaws.ec2#VpcPeeringConnectionId": { - "type": "string" - }, - "com.amazonaws.ec2#VpcPeeringConnectionIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VpcPeeringConnectionId", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VpcPeeringConnectionIdWithResolver": { - "type": "string" - }, - "com.amazonaws.ec2#VpcPeeringConnectionList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VpcPeeringConnection", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VpcPeeringConnectionOptionsDescription": { - "type": "structure", - "members": { - "AllowDnsResolutionFromRemoteVpc": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "AllowDnsResolutionFromRemoteVpc", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.

", - "smithy.api#xmlName": "allowDnsResolutionFromRemoteVpc" - } - }, - "AllowEgressFromLocalClassicLinkToRemoteVpc": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "AllowEgressFromLocalClassicLinkToRemoteVpc", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.

", - "smithy.api#xmlName": "allowEgressFromLocalClassicLinkToRemoteVpc" - } - }, - "AllowEgressFromLocalVpcToRemoteClassicLink": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "AllowEgressFromLocalVpcToRemoteClassicLink", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.

", - "smithy.api#xmlName": "allowEgressFromLocalVpcToRemoteClassicLink" - } - } - }, - "traits": { - "smithy.api#documentation": "\n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n \n

Describes the VPC peering connection options.

" - } - }, - "com.amazonaws.ec2#VpcPeeringConnectionStateReason": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.ec2#VpcPeeringConnectionStateReasonCode", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The status of the VPC peering connection.

", - "smithy.api#xmlName": "code" - } - }, - "Message": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "

A message that provides more information about the status, if applicable.

", - "smithy.api#xmlName": "message" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the status of a VPC peering connection.

" - } - }, - "com.amazonaws.ec2#VpcPeeringConnectionStateReasonCode": { - "type": "enum", - "members": { - "initiating_request": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "initiating-request" - } - }, - "pending_acceptance": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending-acceptance" - } - }, - "active": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "active" - } - }, - "deleted": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleted" - } - }, - "rejected": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "rejected" - } - }, - "failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failed" - } - }, - "expired": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "expired" - } - }, - "provisioning": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "provisioning" - } - }, - "deleting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleting" - } - } - } - }, - "com.amazonaws.ec2#VpcPeeringConnectionVpcInfo": { - "type": "structure", - "members": { - "CidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CidrBlock", - "smithy.api#documentation": "

The IPv4 CIDR block for the VPC.

", - "smithy.api#xmlName": "cidrBlock" - } - }, - "Ipv6CidrBlockSet": { - "target": "com.amazonaws.ec2#Ipv6CidrBlockSet", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6CidrBlockSet", - "smithy.api#documentation": "

The IPv6 CIDR block for the VPC.

", - "smithy.api#xmlName": "ipv6CidrBlockSet" - } - }, - "CidrBlockSet": { - "target": "com.amazonaws.ec2#CidrBlockSet", - "traits": { - "aws.protocols#ec2QueryName": "CidrBlockSet", - "smithy.api#documentation": "

Information about the IPv4 CIDR blocks for the VPC.

", - "smithy.api#xmlName": "cidrBlockSet" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the VPC.

", - "smithy.api#xmlName": "ownerId" - } - }, - "PeeringOptions": { - "target": "com.amazonaws.ec2#VpcPeeringConnectionOptionsDescription", - "traits": { - "aws.protocols#ec2QueryName": "PeeringOptions", - "smithy.api#documentation": "

Information about the VPC peering connection options for the accepter or requester VPC.

", - "smithy.api#xmlName": "peeringOptions" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#xmlName": "vpcId" - } - }, - "Region": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Region", - "smithy.api#documentation": "

The Region in which the VPC is located.

", - "smithy.api#xmlName": "region" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a VPC in a VPC peering connection.

" - } - }, - "com.amazonaws.ec2#VpcState": { - "type": "enum", - "members": { - "pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "available": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "available" - } - } - } - }, - "com.amazonaws.ec2#VpcTenancy": { - "type": "enum", - "members": { - "default": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "default" - } - } - } - }, - "com.amazonaws.ec2#VpnConnection": { - "type": "structure", - "members": { - "CustomerGatewayConfiguration": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CustomerGatewayConfiguration", - "smithy.api#documentation": "

The configuration information for the VPN connection's customer gateway (in the native\n XML format). This element is always present in the CreateVpnConnection\n response; however, it's present in the DescribeVpnConnections response\n only if the VPN connection is in the pending or available\n state.

", - "smithy.api#xmlName": "customerGatewayConfiguration" - } - }, - "CustomerGatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CustomerGatewayId", - "smithy.api#documentation": "

The ID of the customer gateway at your end of the VPN connection.

", - "smithy.api#xmlName": "customerGatewayId" - } - }, - "Category": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Category", - "smithy.api#documentation": "

The category of the VPN connection. A value of VPN indicates an Amazon Web Services VPN connection. A value of VPN-Classic indicates an Amazon Web Services Classic VPN connection.

", - "smithy.api#xmlName": "category" - } - }, - "State": { - "target": "com.amazonaws.ec2#VpnState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The current state of the VPN connection.

", - "smithy.api#xmlName": "state" - } - }, - "Type": { - "target": "com.amazonaws.ec2#GatewayType", - "traits": { - "aws.protocols#ec2QueryName": "Type", - "smithy.api#documentation": "

The type of VPN connection.

", - "smithy.api#xmlName": "type" - } - }, - "VpnConnectionId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpnConnectionId", - "smithy.api#documentation": "

The ID of the VPN connection.

", - "smithy.api#xmlName": "vpnConnectionId" - } - }, - "VpnGatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpnGatewayId", - "smithy.api#documentation": "

The ID of the virtual private gateway at the Amazon Web Services side of the VPN\n connection.

", - "smithy.api#xmlName": "vpnGatewayId" - } - }, - "TransitGatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayId", - "smithy.api#documentation": "

The ID of the transit gateway associated with the VPN connection.

", - "smithy.api#xmlName": "transitGatewayId" - } - }, - "CoreNetworkArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CoreNetworkArn", - "smithy.api#documentation": "

The ARN of the core network.

", - "smithy.api#xmlName": "coreNetworkArn" - } - }, - "CoreNetworkAttachmentArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CoreNetworkAttachmentArn", - "smithy.api#documentation": "

The ARN of the core network attachment.

", - "smithy.api#xmlName": "coreNetworkAttachmentArn" - } - }, - "GatewayAssociationState": { - "target": "com.amazonaws.ec2#GatewayAssociationState", - "traits": { - "aws.protocols#ec2QueryName": "GatewayAssociationState", - "smithy.api#documentation": "

The current state of the gateway association.

", - "smithy.api#xmlName": "gatewayAssociationState" - } - }, - "Options": { - "target": "com.amazonaws.ec2#VpnConnectionOptions", - "traits": { - "aws.protocols#ec2QueryName": "Options", - "smithy.api#documentation": "

The VPN connection options.

", - "smithy.api#xmlName": "options" - } - }, - "Routes": { - "target": "com.amazonaws.ec2#VpnStaticRouteList", - "traits": { - "aws.protocols#ec2QueryName": "Routes", - "smithy.api#documentation": "

The static routes associated with the VPN connection.

", - "smithy.api#xmlName": "routes" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the VPN connection.

", - "smithy.api#xmlName": "tagSet" - } - }, - "VgwTelemetry": { - "target": "com.amazonaws.ec2#VgwTelemetryList", - "traits": { - "aws.protocols#ec2QueryName": "VgwTelemetry", - "smithy.api#documentation": "

Information about the VPN tunnel.

", - "smithy.api#xmlName": "vgwTelemetry" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a VPN connection.

" - } - }, - "com.amazonaws.ec2#VpnConnectionDeviceSampleConfiguration": { - "type": "string", - "traits": { - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.ec2#VpnConnectionDeviceType": { - "type": "structure", - "members": { - "VpnConnectionDeviceTypeId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpnConnectionDeviceTypeId", - "smithy.api#documentation": "

Customer gateway device identifier.

", - "smithy.api#xmlName": "vpnConnectionDeviceTypeId" - } - }, - "Vendor": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Vendor", - "smithy.api#documentation": "

Customer gateway device vendor.

", - "smithy.api#xmlName": "vendor" - } - }, - "Platform": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Platform", - "smithy.api#documentation": "

Customer gateway device platform.

", - "smithy.api#xmlName": "platform" - } - }, - "Software": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Software", - "smithy.api#documentation": "

Customer gateway device software version.

", - "smithy.api#xmlName": "software" - } - } - }, - "traits": { - "smithy.api#documentation": "

List of customer gateway devices that have a sample configuration file available for\n use. You can also see the list of device types with sample configuration files available\n under Your customer\n gateway device in the Amazon Web Services Site-to-Site VPN User Guide.

" - } - }, - "com.amazonaws.ec2#VpnConnectionDeviceTypeId": { - "type": "string" - }, - "com.amazonaws.ec2#VpnConnectionDeviceTypeList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VpnConnectionDeviceType", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VpnConnectionId": { - "type": "string" - }, - "com.amazonaws.ec2#VpnConnectionIdStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VpnConnectionId", - "traits": { - "smithy.api#xmlName": "VpnConnectionId" - } - } - }, - "com.amazonaws.ec2#VpnConnectionList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VpnConnection", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VpnConnectionOptions": { - "type": "structure", - "members": { - "EnableAcceleration": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "EnableAcceleration", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether acceleration is enabled for the VPN connection.

", - "smithy.api#xmlName": "enableAcceleration" - } - }, - "StaticRoutesOnly": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "StaticRoutesOnly", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the VPN connection uses static routes only. Static routes must be\n used for devices that don't support BGP.

", - "smithy.api#xmlName": "staticRoutesOnly" - } - }, - "LocalIpv4NetworkCidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LocalIpv4NetworkCidr", - "smithy.api#documentation": "

The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.

", - "smithy.api#xmlName": "localIpv4NetworkCidr" - } - }, - "RemoteIpv4NetworkCidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "RemoteIpv4NetworkCidr", - "smithy.api#documentation": "

The IPv4 CIDR on the Amazon Web Services side of the VPN connection.

", - "smithy.api#xmlName": "remoteIpv4NetworkCidr" - } - }, - "LocalIpv6NetworkCidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LocalIpv6NetworkCidr", - "smithy.api#documentation": "

The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.

", - "smithy.api#xmlName": "localIpv6NetworkCidr" - } - }, - "RemoteIpv6NetworkCidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "RemoteIpv6NetworkCidr", - "smithy.api#documentation": "

The IPv6 CIDR on the Amazon Web Services side of the VPN connection.

", - "smithy.api#xmlName": "remoteIpv6NetworkCidr" - } - }, - "OutsideIpAddressType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OutsideIpAddressType", - "smithy.api#documentation": "

The type of IPv4 address assigned to the outside interface of the customer gateway.

\n

Valid values: PrivateIpv4 | PublicIpv4\n

\n

Default: PublicIpv4\n

", - "smithy.api#xmlName": "outsideIpAddressType" - } - }, - "TransportTransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransportTransitGatewayAttachmentId", - "smithy.api#documentation": "

The transit gateway attachment ID in use for the VPN tunnel.

", - "smithy.api#xmlName": "transportTransitGatewayAttachmentId" - } - }, - "TunnelInsideIpVersion": { - "target": "com.amazonaws.ec2#TunnelInsideIpVersion", - "traits": { - "aws.protocols#ec2QueryName": "TunnelInsideIpVersion", - "smithy.api#documentation": "

Indicates whether the VPN tunnels process IPv4 or IPv6 traffic.

", - "smithy.api#xmlName": "tunnelInsideIpVersion" - } - }, - "TunnelOptions": { - "target": "com.amazonaws.ec2#TunnelOptionsList", - "traits": { - "aws.protocols#ec2QueryName": "TunnelOptionSet", - "smithy.api#documentation": "

Indicates the VPN tunnel options.

", - "smithy.api#xmlName": "tunnelOptionSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes VPN connection options.

" - } - }, - "com.amazonaws.ec2#VpnConnectionOptionsSpecification": { - "type": "structure", - "members": { - "EnableAcceleration": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicate whether to enable acceleration for the VPN connection.

\n

Default: false\n

" - } - }, - "StaticRoutesOnly": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "StaticRoutesOnly", - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Indicate whether the VPN connection uses static routes only. If you are creating a VPN\n connection for a device that does not support BGP, you must specify true.\n Use CreateVpnConnectionRoute to create a static route.

\n

Default: false\n

", - "smithy.api#xmlName": "staticRoutesOnly" - } - }, - "TunnelInsideIpVersion": { - "target": "com.amazonaws.ec2#TunnelInsideIpVersion", - "traits": { - "smithy.api#documentation": "

Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.

\n

Default: ipv4\n

" - } - }, - "TunnelOptions": { - "target": "com.amazonaws.ec2#VpnTunnelOptionsSpecificationsList", - "traits": { - "smithy.api#documentation": "

The tunnel options for the VPN connection.

" - } - }, - "LocalIpv4NetworkCidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.

\n

Default: 0.0.0.0/0\n

" - } - }, - "RemoteIpv4NetworkCidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The IPv4 CIDR on the Amazon Web Services side of the VPN connection.

\n

Default: 0.0.0.0/0\n

" - } - }, - "LocalIpv6NetworkCidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.

\n

Default: ::/0\n

" - } - }, - "RemoteIpv6NetworkCidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The IPv6 CIDR on the Amazon Web Services side of the VPN connection.

\n

Default: ::/0\n

" - } - }, - "OutsideIpAddressType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The type of IPv4 address assigned to the outside interface of the customer gateway device.

\n

Valid values: PrivateIpv4 | PublicIpv4\n

\n

Default: PublicIpv4\n

" - } - }, - "TransportTransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", - "traits": { - "smithy.api#documentation": "

The transit gateway attachment ID to use for the VPN tunnel.

\n

Required if OutsideIpAddressType is set to PrivateIpv4.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes VPN connection options.

" - } - }, - "com.amazonaws.ec2#VpnEcmpSupportValue": { - "type": "enum", - "members": { - "enable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enable" - } - }, - "disable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disable" - } - } - } - }, - "com.amazonaws.ec2#VpnGateway": { - "type": "structure", - "members": { - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone where the virtual private gateway was created, if applicable.\n This field may be empty or not returned.

", - "smithy.api#xmlName": "availabilityZone" - } - }, - "State": { - "target": "com.amazonaws.ec2#VpnState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The current state of the virtual private gateway.

", - "smithy.api#xmlName": "state" - } - }, - "Type": { - "target": "com.amazonaws.ec2#GatewayType", - "traits": { - "aws.protocols#ec2QueryName": "Type", - "smithy.api#documentation": "

The type of VPN connection the virtual private gateway supports.

", - "smithy.api#xmlName": "type" - } - }, - "VpcAttachments": { - "target": "com.amazonaws.ec2#VpcAttachmentList", - "traits": { - "aws.protocols#ec2QueryName": "Attachments", - "smithy.api#documentation": "

Any VPCs attached to the virtual private gateway.

", - "smithy.api#xmlName": "attachments" - } - }, - "VpnGatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpnGatewayId", - "smithy.api#documentation": "

The ID of the virtual private gateway.

", - "smithy.api#xmlName": "vpnGatewayId" - } - }, - "AmazonSideAsn": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "aws.protocols#ec2QueryName": "AmazonSideAsn", - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The private Autonomous System Number (ASN) for the Amazon side of a BGP\n session.

", - "smithy.api#xmlName": "amazonSideAsn" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the virtual private gateway.

", - "smithy.api#xmlName": "tagSet" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a virtual private gateway.

" - } - }, - "com.amazonaws.ec2#VpnGatewayId": { - "type": "string" - }, - "com.amazonaws.ec2#VpnGatewayIdStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VpnGatewayId", - "traits": { - "smithy.api#xmlName": "VpnGatewayId" - } - } - }, - "com.amazonaws.ec2#VpnGatewayList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VpnGateway", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VpnProtocol": { - "type": "enum", - "members": { - "openvpn": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "openvpn" - } - } - } - }, - "com.amazonaws.ec2#VpnState": { - "type": "enum", - "members": { - "pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "available": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "available" - } - }, - "deleting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleting" - } - }, - "deleted": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleted" - } - } - } - }, - "com.amazonaws.ec2#VpnStaticRoute": { - "type": "structure", - "members": { - "DestinationCidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DestinationCidrBlock", - "smithy.api#documentation": "

The CIDR block associated with the local subnet of the customer data center.

", - "smithy.api#xmlName": "destinationCidrBlock" - } - }, - "Source": { - "target": "com.amazonaws.ec2#VpnStaticRouteSource", - "traits": { - "aws.protocols#ec2QueryName": "Source", - "smithy.api#documentation": "

Indicates how the routes were provided.

", - "smithy.api#xmlName": "source" - } - }, - "State": { - "target": "com.amazonaws.ec2#VpnState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The current state of the static route.

", - "smithy.api#xmlName": "state" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a static route for a VPN connection.

" - } - }, - "com.amazonaws.ec2#VpnStaticRouteList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VpnStaticRoute", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.ec2#VpnStaticRouteSource": { - "type": "enum", - "members": { - "Static": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Static" - } - } - } - }, - "com.amazonaws.ec2#VpnTunnelLogOptions": { - "type": "structure", - "members": { - "CloudWatchLogOptions": { - "target": "com.amazonaws.ec2#CloudWatchLogOptions", - "traits": { - "aws.protocols#ec2QueryName": "CloudWatchLogOptions", - "smithy.api#documentation": "

Options for sending VPN tunnel logs to CloudWatch.

", - "smithy.api#xmlName": "cloudWatchLogOptions" - } - } - }, - "traits": { - "smithy.api#documentation": "

Options for logging VPN tunnel activity.

" - } - }, - "com.amazonaws.ec2#VpnTunnelLogOptionsSpecification": { - "type": "structure", - "members": { - "CloudWatchLogOptions": { - "target": "com.amazonaws.ec2#CloudWatchLogOptionsSpecification", - "traits": { - "smithy.api#documentation": "

Options for sending VPN tunnel logs to CloudWatch.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Options for logging VPN tunnel activity.

" - } - }, - "com.amazonaws.ec2#VpnTunnelOptionsSpecification": { - "type": "structure", - "members": { - "TunnelInsideCidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be\n unique across all VPN connections that use the same virtual private gateway.

\n

Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The\n following CIDR blocks are reserved and cannot be used:

\n " - } - }, - "TunnelInsideIpv6Cidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be\n unique across all VPN connections that use the same transit gateway.

\n

Constraints: A size /126 CIDR block from the local fd00::/8 range.

" - } - }, - "PreSharedKey": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The pre-shared key (PSK) to establish initial authentication between the virtual\n private gateway and customer gateway.

\n

Constraints: Allowed characters are alphanumeric characters, periods (.), and\n underscores (_). Must be between 8 and 64 characters in length and cannot start with\n zero (0).

" - } - }, - "Phase1LifetimeSeconds": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The lifetime for phase 1 of the IKE negotiation, in seconds.

\n

Constraints: A value between 900 and 28,800.

\n

Default: 28800\n

" - } - }, - "Phase2LifetimeSeconds": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The lifetime for phase 2 of the IKE negotiation, in seconds.

\n

Constraints: A value between 900 and 3,600. The value must be less than the value for\n Phase1LifetimeSeconds.

\n

Default: 3600\n

" - } - }, - "RekeyMarginTimeSeconds": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The margin time, in seconds, before the phase 2 lifetime expires, during which the\n Amazon Web Services side of the VPN connection performs an IKE rekey. The exact time\n of the rekey is randomly selected based on the value for\n RekeyFuzzPercentage.

\n

Constraints: A value between 60 and half of Phase2LifetimeSeconds.

\n

Default: 540\n

" - } - }, - "RekeyFuzzPercentage": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The percentage of the rekey window (determined by RekeyMarginTimeSeconds)\n during which the rekey time is randomly selected.

\n

Constraints: A value between 0 and 100.

\n

Default: 100\n

" - } - }, - "ReplayWindowSize": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of packets in an IKE replay window.

\n

Constraints: A value between 64 and 2048.

\n

Default: 1024\n

" - } - }, - "DPDTimeoutSeconds": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of seconds after which a DPD timeout occurs.

\n

Constraints: A value greater than or equal to 30.

\n

Default: 30\n

" - } - }, - "DPDTimeoutAction": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The action to take after DPD timeout occurs. Specify restart to restart\n the IKE initiation. Specify clear to end the IKE session.

\n

Valid Values: clear | none | restart\n

\n

Default: clear\n

" - } - }, - "Phase1EncryptionAlgorithms": { - "target": "com.amazonaws.ec2#Phase1EncryptionAlgorithmsRequestList", - "traits": { - "smithy.api#documentation": "

One or more encryption algorithms that are permitted for the VPN tunnel for phase 1\n IKE negotiations.

\n

Valid values: AES128 | AES256 | AES128-GCM-16 |\n AES256-GCM-16\n

", - "smithy.api#xmlName": "Phase1EncryptionAlgorithm" - } - }, - "Phase2EncryptionAlgorithms": { - "target": "com.amazonaws.ec2#Phase2EncryptionAlgorithmsRequestList", - "traits": { - "smithy.api#documentation": "

One or more encryption algorithms that are permitted for the VPN tunnel for phase 2\n IKE negotiations.

\n

Valid values: AES128 | AES256 | AES128-GCM-16 |\n AES256-GCM-16\n

", - "smithy.api#xmlName": "Phase2EncryptionAlgorithm" - } - }, - "Phase1IntegrityAlgorithms": { - "target": "com.amazonaws.ec2#Phase1IntegrityAlgorithmsRequestList", - "traits": { - "smithy.api#documentation": "

One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE\n negotiations.

\n

Valid values: SHA1 | SHA2-256 | SHA2-384 |\n SHA2-512\n

", - "smithy.api#xmlName": "Phase1IntegrityAlgorithm" - } - }, - "Phase2IntegrityAlgorithms": { - "target": "com.amazonaws.ec2#Phase2IntegrityAlgorithmsRequestList", - "traits": { - "smithy.api#documentation": "

One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE\n negotiations.

\n

Valid values: SHA1 | SHA2-256 | SHA2-384 |\n SHA2-512\n

", - "smithy.api#xmlName": "Phase2IntegrityAlgorithm" - } - }, - "Phase1DHGroupNumbers": { - "target": "com.amazonaws.ec2#Phase1DHGroupNumbersRequestList", - "traits": { - "smithy.api#documentation": "

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for\n phase 1 IKE negotiations.

\n

Valid values: 2 | 14 | 15 | 16 |\n 17 | 18 | 19 | 20 |\n 21 | 22 | 23 | 24\n

", - "smithy.api#xmlName": "Phase1DHGroupNumber" - } - }, - "Phase2DHGroupNumbers": { - "target": "com.amazonaws.ec2#Phase2DHGroupNumbersRequestList", - "traits": { - "smithy.api#documentation": "

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for\n phase 2 IKE negotiations.

\n

Valid values: 2 | 5 | 14 | 15 |\n 16 | 17 | 18 | 19 |\n 20 | 21 | 22 | 23 |\n 24\n

", - "smithy.api#xmlName": "Phase2DHGroupNumber" - } - }, - "IKEVersions": { - "target": "com.amazonaws.ec2#IKEVersionsRequestList", - "traits": { - "smithy.api#documentation": "

The IKE versions that are permitted for the VPN tunnel.

\n

Valid values: ikev1 | ikev2\n

", - "smithy.api#xmlName": "IKEVersion" - } - }, - "StartupAction": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The action to take when the establishing the tunnel for the VPN connection. By\n default, your customer gateway device must initiate the IKE negotiation and bring up the\n tunnel. Specify start for Amazon Web Services to initiate the IKE\n negotiation.

\n

Valid Values: add | start\n

\n

Default: add\n

" - } - }, - "LogOptions": { - "target": "com.amazonaws.ec2#VpnTunnelLogOptionsSpecification", - "traits": { - "smithy.api#documentation": "

Options for logging VPN tunnel activity.

" - } - }, - "EnableTunnelLifecycleControl": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Turn on or off tunnel endpoint lifecycle control feature.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The tunnel options for a single VPN tunnel.

" - } - }, - "com.amazonaws.ec2#VpnTunnelOptionsSpecificationsList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#VpnTunnelOptionsSpecification" - } - }, - "com.amazonaws.ec2#WeekDay": { - "type": "enum", - "members": { - "sunday": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "sunday" - } - }, - "monday": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "monday" - } - }, - "tuesday": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "tuesday" - } - }, - "wednesday": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "wednesday" - } - }, - "thursday": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "thursday" - } - }, - "friday": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "friday" - } - }, - "saturday": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "saturday" - } - } - } - }, - "com.amazonaws.ec2#WithdrawByoipCidr": { - "type": "operation", - "input": { - "target": "com.amazonaws.ec2#WithdrawByoipCidrRequest" - }, - "output": { - "target": "com.amazonaws.ec2#WithdrawByoipCidrResult" - }, - "traits": { - "smithy.api#documentation": "

Stops advertising an address range that is provisioned as an address pool.

\n

You can perform this operation at most once every 10 seconds, even if you specify different \n address ranges each time.

\n

It can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services\n because of BGP propagation delays.

" - } - }, - "com.amazonaws.ec2#WithdrawByoipCidrRequest": { - "type": "structure", - "members": { - "Cidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The address range, in CIDR notation.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#default": false, - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ec2#WithdrawByoipCidrResult": { - "type": "structure", - "members": { - "ByoipCidr": { - "target": "com.amazonaws.ec2#ByoipCidr", - "traits": { - "aws.protocols#ec2QueryName": "ByoipCidr", - "smithy.api#documentation": "

Information about the address pool.

", - "smithy.api#xmlName": "byoipCidr" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ec2#ZoneIdStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#xmlName": "ZoneId" - } - } - }, - "com.amazonaws.ec2#ZoneNameStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#xmlName": "ZoneName" - } - } - }, - "com.amazonaws.ec2#scope": { - "type": "enum", - "members": { - "AVAILABILITY_ZONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Availability Zone" - } - }, - "REGIONAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Region" - } - } - } - }, - "com.amazonaws.ec2#snapshotTierStatusSet": { - "type": "list", - "member": { - "target": "com.amazonaws.ec2#SnapshotTierStatus", - "traits": { - "smithy.api#xmlName": "item" + "com.amazonaws.ec2#AmazonEC2": { + "type": "service", + "version": "2016-11-15", + "operations": [ + { + "target": "com.amazonaws.ec2#AcceptAddressTransfer" + }, + { + "target": "com.amazonaws.ec2#AcceptReservedInstancesExchangeQuote" + }, + { + "target": "com.amazonaws.ec2#AcceptTransitGatewayMulticastDomainAssociations" + }, + { + "target": "com.amazonaws.ec2#AcceptTransitGatewayPeeringAttachment" + }, + { + "target": "com.amazonaws.ec2#AcceptTransitGatewayVpcAttachment" + }, + { + "target": "com.amazonaws.ec2#AcceptVpcEndpointConnections" + }, + { + "target": "com.amazonaws.ec2#AcceptVpcPeeringConnection" + }, + { + "target": "com.amazonaws.ec2#AdvertiseByoipCidr" + }, + { + "target": "com.amazonaws.ec2#AllocateAddress" + }, + { + "target": "com.amazonaws.ec2#AllocateHosts" + }, + { + "target": "com.amazonaws.ec2#AllocateIpamPoolCidr" + }, + { + "target": "com.amazonaws.ec2#ApplySecurityGroupsToClientVpnTargetNetwork" + }, + { + "target": "com.amazonaws.ec2#AssignIpv6Addresses" + }, + { + "target": "com.amazonaws.ec2#AssignPrivateIpAddresses" + }, + { + "target": "com.amazonaws.ec2#AssignPrivateNatGatewayAddress" + }, + { + "target": "com.amazonaws.ec2#AssociateAddress" + }, + { + "target": "com.amazonaws.ec2#AssociateClientVpnTargetNetwork" + }, + { + "target": "com.amazonaws.ec2#AssociateDhcpOptions" + }, + { + "target": "com.amazonaws.ec2#AssociateEnclaveCertificateIamRole" + }, + { + "target": "com.amazonaws.ec2#AssociateIamInstanceProfile" + }, + { + "target": "com.amazonaws.ec2#AssociateInstanceEventWindow" + }, + { + "target": "com.amazonaws.ec2#AssociateIpamResourceDiscovery" + }, + { + "target": "com.amazonaws.ec2#AssociateNatGatewayAddress" + }, + { + "target": "com.amazonaws.ec2#AssociateRouteTable" + }, + { + "target": "com.amazonaws.ec2#AssociateSubnetCidrBlock" + }, + { + "target": "com.amazonaws.ec2#AssociateTransitGatewayMulticastDomain" + }, + { + "target": "com.amazonaws.ec2#AssociateTransitGatewayPolicyTable" + }, + { + "target": "com.amazonaws.ec2#AssociateTransitGatewayRouteTable" + }, + { + "target": "com.amazonaws.ec2#AssociateTrunkInterface" + }, + { + "target": "com.amazonaws.ec2#AssociateVpcCidrBlock" + }, + { + "target": "com.amazonaws.ec2#AttachClassicLinkVpc" + }, + { + "target": "com.amazonaws.ec2#AttachInternetGateway" + }, + { + "target": "com.amazonaws.ec2#AttachNetworkInterface" + }, + { + "target": "com.amazonaws.ec2#AttachVerifiedAccessTrustProvider" + }, + { + "target": "com.amazonaws.ec2#AttachVolume" + }, + { + "target": "com.amazonaws.ec2#AttachVpnGateway" + }, + { + "target": "com.amazonaws.ec2#AuthorizeClientVpnIngress" + }, + { + "target": "com.amazonaws.ec2#AuthorizeSecurityGroupEgress" + }, + { + "target": "com.amazonaws.ec2#AuthorizeSecurityGroupIngress" + }, + { + "target": "com.amazonaws.ec2#BundleInstance" + }, + { + "target": "com.amazonaws.ec2#CancelBundleTask" + }, + { + "target": "com.amazonaws.ec2#CancelCapacityReservation" + }, + { + "target": "com.amazonaws.ec2#CancelCapacityReservationFleets" + }, + { + "target": "com.amazonaws.ec2#CancelConversionTask" + }, + { + "target": "com.amazonaws.ec2#CancelExportTask" + }, + { + "target": "com.amazonaws.ec2#CancelImageLaunchPermission" + }, + { + "target": "com.amazonaws.ec2#CancelImportTask" + }, + { + "target": "com.amazonaws.ec2#CancelReservedInstancesListing" + }, + { + "target": "com.amazonaws.ec2#CancelSpotFleetRequests" + }, + { + "target": "com.amazonaws.ec2#CancelSpotInstanceRequests" + }, + { + "target": "com.amazonaws.ec2#ConfirmProductInstance" + }, + { + "target": "com.amazonaws.ec2#CopyFpgaImage" + }, + { + "target": "com.amazonaws.ec2#CopyImage" + }, + { + "target": "com.amazonaws.ec2#CopySnapshot" + }, + { + "target": "com.amazonaws.ec2#CreateCapacityReservation" + }, + { + "target": "com.amazonaws.ec2#CreateCapacityReservationFleet" + }, + { + "target": "com.amazonaws.ec2#CreateCarrierGateway" + }, + { + "target": "com.amazonaws.ec2#CreateClientVpnEndpoint" + }, + { + "target": "com.amazonaws.ec2#CreateClientVpnRoute" + }, + { + "target": "com.amazonaws.ec2#CreateCoipCidr" + }, + { + "target": "com.amazonaws.ec2#CreateCoipPool" + }, + { + "target": "com.amazonaws.ec2#CreateCustomerGateway" + }, + { + "target": "com.amazonaws.ec2#CreateDefaultSubnet" + }, + { + "target": "com.amazonaws.ec2#CreateDefaultVpc" + }, + { + "target": "com.amazonaws.ec2#CreateDhcpOptions" + }, + { + "target": "com.amazonaws.ec2#CreateEgressOnlyInternetGateway" + }, + { + "target": "com.amazonaws.ec2#CreateFleet" + }, + { + "target": "com.amazonaws.ec2#CreateFlowLogs" + }, + { + "target": "com.amazonaws.ec2#CreateFpgaImage" + }, + { + "target": "com.amazonaws.ec2#CreateImage" + }, + { + "target": "com.amazonaws.ec2#CreateInstanceConnectEndpoint" + }, + { + "target": "com.amazonaws.ec2#CreateInstanceEventWindow" + }, + { + "target": "com.amazonaws.ec2#CreateInstanceExportTask" + }, + { + "target": "com.amazonaws.ec2#CreateInternetGateway" + }, + { + "target": "com.amazonaws.ec2#CreateIpam" + }, + { + "target": "com.amazonaws.ec2#CreateIpamPool" + }, + { + "target": "com.amazonaws.ec2#CreateIpamResourceDiscovery" + }, + { + "target": "com.amazonaws.ec2#CreateIpamScope" + }, + { + "target": "com.amazonaws.ec2#CreateKeyPair" + }, + { + "target": "com.amazonaws.ec2#CreateLaunchTemplate" + }, + { + "target": "com.amazonaws.ec2#CreateLaunchTemplateVersion" + }, + { + "target": "com.amazonaws.ec2#CreateLocalGatewayRoute" + }, + { + "target": "com.amazonaws.ec2#CreateLocalGatewayRouteTable" + }, + { + "target": "com.amazonaws.ec2#CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation" + }, + { + "target": "com.amazonaws.ec2#CreateLocalGatewayRouteTableVpcAssociation" + }, + { + "target": "com.amazonaws.ec2#CreateManagedPrefixList" + }, + { + "target": "com.amazonaws.ec2#CreateNatGateway" + }, + { + "target": "com.amazonaws.ec2#CreateNetworkAcl" + }, + { + "target": "com.amazonaws.ec2#CreateNetworkAclEntry" + }, + { + "target": "com.amazonaws.ec2#CreateNetworkInsightsAccessScope" + }, + { + "target": "com.amazonaws.ec2#CreateNetworkInsightsPath" + }, + { + "target": "com.amazonaws.ec2#CreateNetworkInterface" + }, + { + "target": "com.amazonaws.ec2#CreateNetworkInterfacePermission" + }, + { + "target": "com.amazonaws.ec2#CreatePlacementGroup" + }, + { + "target": "com.amazonaws.ec2#CreatePublicIpv4Pool" + }, + { + "target": "com.amazonaws.ec2#CreateReplaceRootVolumeTask" + }, + { + "target": "com.amazonaws.ec2#CreateReservedInstancesListing" + }, + { + "target": "com.amazonaws.ec2#CreateRestoreImageTask" + }, + { + "target": "com.amazonaws.ec2#CreateRoute" + }, + { + "target": "com.amazonaws.ec2#CreateRouteTable" + }, + { + "target": "com.amazonaws.ec2#CreateSecurityGroup" + }, + { + "target": "com.amazonaws.ec2#CreateSnapshot" + }, + { + "target": "com.amazonaws.ec2#CreateSnapshots" + }, + { + "target": "com.amazonaws.ec2#CreateSpotDatafeedSubscription" + }, + { + "target": "com.amazonaws.ec2#CreateStoreImageTask" + }, + { + "target": "com.amazonaws.ec2#CreateSubnet" + }, + { + "target": "com.amazonaws.ec2#CreateSubnetCidrReservation" + }, + { + "target": "com.amazonaws.ec2#CreateTags" + }, + { + "target": "com.amazonaws.ec2#CreateTrafficMirrorFilter" + }, + { + "target": "com.amazonaws.ec2#CreateTrafficMirrorFilterRule" + }, + { + "target": "com.amazonaws.ec2#CreateTrafficMirrorSession" + }, + { + "target": "com.amazonaws.ec2#CreateTrafficMirrorTarget" + }, + { + "target": "com.amazonaws.ec2#CreateTransitGateway" + }, + { + "target": "com.amazonaws.ec2#CreateTransitGatewayConnect" + }, + { + "target": "com.amazonaws.ec2#CreateTransitGatewayConnectPeer" + }, + { + "target": "com.amazonaws.ec2#CreateTransitGatewayMulticastDomain" + }, + { + "target": "com.amazonaws.ec2#CreateTransitGatewayPeeringAttachment" + }, + { + "target": "com.amazonaws.ec2#CreateTransitGatewayPolicyTable" + }, + { + "target": "com.amazonaws.ec2#CreateTransitGatewayPrefixListReference" + }, + { + "target": "com.amazonaws.ec2#CreateTransitGatewayRoute" + }, + { + "target": "com.amazonaws.ec2#CreateTransitGatewayRouteTable" + }, + { + "target": "com.amazonaws.ec2#CreateTransitGatewayRouteTableAnnouncement" + }, + { + "target": "com.amazonaws.ec2#CreateTransitGatewayVpcAttachment" + }, + { + "target": "com.amazonaws.ec2#CreateVerifiedAccessEndpoint" + }, + { + "target": "com.amazonaws.ec2#CreateVerifiedAccessGroup" + }, + { + "target": "com.amazonaws.ec2#CreateVerifiedAccessInstance" + }, + { + "target": "com.amazonaws.ec2#CreateVerifiedAccessTrustProvider" + }, + { + "target": "com.amazonaws.ec2#CreateVolume" + }, + { + "target": "com.amazonaws.ec2#CreateVpc" + }, + { + "target": "com.amazonaws.ec2#CreateVpcEndpoint" + }, + { + "target": "com.amazonaws.ec2#CreateVpcEndpointConnectionNotification" + }, + { + "target": "com.amazonaws.ec2#CreateVpcEndpointServiceConfiguration" + }, + { + "target": "com.amazonaws.ec2#CreateVpcPeeringConnection" + }, + { + "target": "com.amazonaws.ec2#CreateVpnConnection" + }, + { + "target": "com.amazonaws.ec2#CreateVpnConnectionRoute" + }, + { + "target": "com.amazonaws.ec2#CreateVpnGateway" + }, + { + "target": "com.amazonaws.ec2#DeleteCarrierGateway" + }, + { + "target": "com.amazonaws.ec2#DeleteClientVpnEndpoint" + }, + { + "target": "com.amazonaws.ec2#DeleteClientVpnRoute" + }, + { + "target": "com.amazonaws.ec2#DeleteCoipCidr" + }, + { + "target": "com.amazonaws.ec2#DeleteCoipPool" + }, + { + "target": "com.amazonaws.ec2#DeleteCustomerGateway" + }, + { + "target": "com.amazonaws.ec2#DeleteDhcpOptions" + }, + { + "target": "com.amazonaws.ec2#DeleteEgressOnlyInternetGateway" + }, + { + "target": "com.amazonaws.ec2#DeleteFleets" + }, + { + "target": "com.amazonaws.ec2#DeleteFlowLogs" + }, + { + "target": "com.amazonaws.ec2#DeleteFpgaImage" + }, + { + "target": "com.amazonaws.ec2#DeleteInstanceConnectEndpoint" + }, + { + "target": "com.amazonaws.ec2#DeleteInstanceEventWindow" + }, + { + "target": "com.amazonaws.ec2#DeleteInternetGateway" + }, + { + "target": "com.amazonaws.ec2#DeleteIpam" + }, + { + "target": "com.amazonaws.ec2#DeleteIpamPool" + }, + { + "target": "com.amazonaws.ec2#DeleteIpamResourceDiscovery" + }, + { + "target": "com.amazonaws.ec2#DeleteIpamScope" + }, + { + "target": "com.amazonaws.ec2#DeleteKeyPair" + }, + { + "target": "com.amazonaws.ec2#DeleteLaunchTemplate" + }, + { + "target": "com.amazonaws.ec2#DeleteLaunchTemplateVersions" + }, + { + "target": "com.amazonaws.ec2#DeleteLocalGatewayRoute" + }, + { + "target": "com.amazonaws.ec2#DeleteLocalGatewayRouteTable" + }, + { + "target": "com.amazonaws.ec2#DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation" + }, + { + "target": "com.amazonaws.ec2#DeleteLocalGatewayRouteTableVpcAssociation" + }, + { + "target": "com.amazonaws.ec2#DeleteManagedPrefixList" + }, + { + "target": "com.amazonaws.ec2#DeleteNatGateway" + }, + { + "target": "com.amazonaws.ec2#DeleteNetworkAcl" + }, + { + "target": "com.amazonaws.ec2#DeleteNetworkAclEntry" + }, + { + "target": "com.amazonaws.ec2#DeleteNetworkInsightsAccessScope" + }, + { + "target": "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeAnalysis" + }, + { + "target": "com.amazonaws.ec2#DeleteNetworkInsightsAnalysis" + }, + { + "target": "com.amazonaws.ec2#DeleteNetworkInsightsPath" + }, + { + "target": "com.amazonaws.ec2#DeleteNetworkInterface" + }, + { + "target": "com.amazonaws.ec2#DeleteNetworkInterfacePermission" + }, + { + "target": "com.amazonaws.ec2#DeletePlacementGroup" + }, + { + "target": "com.amazonaws.ec2#DeletePublicIpv4Pool" + }, + { + "target": "com.amazonaws.ec2#DeleteQueuedReservedInstances" + }, + { + "target": "com.amazonaws.ec2#DeleteRoute" + }, + { + "target": "com.amazonaws.ec2#DeleteRouteTable" + }, + { + "target": "com.amazonaws.ec2#DeleteSecurityGroup" + }, + { + "target": "com.amazonaws.ec2#DeleteSnapshot" + }, + { + "target": "com.amazonaws.ec2#DeleteSpotDatafeedSubscription" + }, + { + "target": "com.amazonaws.ec2#DeleteSubnet" + }, + { + "target": "com.amazonaws.ec2#DeleteSubnetCidrReservation" + }, + { + "target": "com.amazonaws.ec2#DeleteTags" + }, + { + "target": "com.amazonaws.ec2#DeleteTrafficMirrorFilter" + }, + { + "target": "com.amazonaws.ec2#DeleteTrafficMirrorFilterRule" + }, + { + "target": "com.amazonaws.ec2#DeleteTrafficMirrorSession" + }, + { + "target": "com.amazonaws.ec2#DeleteTrafficMirrorTarget" + }, + { + "target": "com.amazonaws.ec2#DeleteTransitGateway" + }, + { + "target": "com.amazonaws.ec2#DeleteTransitGatewayConnect" + }, + { + "target": "com.amazonaws.ec2#DeleteTransitGatewayConnectPeer" + }, + { + "target": "com.amazonaws.ec2#DeleteTransitGatewayMulticastDomain" + }, + { + "target": "com.amazonaws.ec2#DeleteTransitGatewayPeeringAttachment" + }, + { + "target": "com.amazonaws.ec2#DeleteTransitGatewayPolicyTable" + }, + { + "target": "com.amazonaws.ec2#DeleteTransitGatewayPrefixListReference" + }, + { + "target": "com.amazonaws.ec2#DeleteTransitGatewayRoute" + }, + { + "target": "com.amazonaws.ec2#DeleteTransitGatewayRouteTable" + }, + { + "target": "com.amazonaws.ec2#DeleteTransitGatewayRouteTableAnnouncement" + }, + { + "target": "com.amazonaws.ec2#DeleteTransitGatewayVpcAttachment" + }, + { + "target": "com.amazonaws.ec2#DeleteVerifiedAccessEndpoint" + }, + { + "target": "com.amazonaws.ec2#DeleteVerifiedAccessGroup" + }, + { + "target": "com.amazonaws.ec2#DeleteVerifiedAccessInstance" + }, + { + "target": "com.amazonaws.ec2#DeleteVerifiedAccessTrustProvider" + }, + { + "target": "com.amazonaws.ec2#DeleteVolume" + }, + { + "target": "com.amazonaws.ec2#DeleteVpc" + }, + { + "target": "com.amazonaws.ec2#DeleteVpcEndpointConnectionNotifications" + }, + { + "target": "com.amazonaws.ec2#DeleteVpcEndpoints" + }, + { + "target": "com.amazonaws.ec2#DeleteVpcEndpointServiceConfigurations" + }, + { + "target": "com.amazonaws.ec2#DeleteVpcPeeringConnection" + }, + { + "target": "com.amazonaws.ec2#DeleteVpnConnection" + }, + { + "target": "com.amazonaws.ec2#DeleteVpnConnectionRoute" + }, + { + "target": "com.amazonaws.ec2#DeleteVpnGateway" + }, + { + "target": "com.amazonaws.ec2#DeprovisionByoipCidr" + }, + { + "target": "com.amazonaws.ec2#DeprovisionIpamPoolCidr" + }, + { + "target": "com.amazonaws.ec2#DeprovisionPublicIpv4PoolCidr" + }, + { + "target": "com.amazonaws.ec2#DeregisterImage" + }, + { + "target": "com.amazonaws.ec2#DeregisterInstanceEventNotificationAttributes" + }, + { + "target": "com.amazonaws.ec2#DeregisterTransitGatewayMulticastGroupMembers" + }, + { + "target": "com.amazonaws.ec2#DeregisterTransitGatewayMulticastGroupSources" + }, + { + "target": "com.amazonaws.ec2#DescribeAccountAttributes" + }, + { + "target": "com.amazonaws.ec2#DescribeAddresses" + }, + { + "target": "com.amazonaws.ec2#DescribeAddressesAttribute" + }, + { + "target": "com.amazonaws.ec2#DescribeAddressTransfers" + }, + { + "target": "com.amazonaws.ec2#DescribeAggregateIdFormat" + }, + { + "target": "com.amazonaws.ec2#DescribeAvailabilityZones" + }, + { + "target": "com.amazonaws.ec2#DescribeAwsNetworkPerformanceMetricSubscriptions" + }, + { + "target": "com.amazonaws.ec2#DescribeBundleTasks" + }, + { + "target": "com.amazonaws.ec2#DescribeByoipCidrs" + }, + { + "target": "com.amazonaws.ec2#DescribeCapacityReservationFleets" + }, + { + "target": "com.amazonaws.ec2#DescribeCapacityReservations" + }, + { + "target": "com.amazonaws.ec2#DescribeCarrierGateways" + }, + { + "target": "com.amazonaws.ec2#DescribeClassicLinkInstances" + }, + { + "target": "com.amazonaws.ec2#DescribeClientVpnAuthorizationRules" + }, + { + "target": "com.amazonaws.ec2#DescribeClientVpnConnections" + }, + { + "target": "com.amazonaws.ec2#DescribeClientVpnEndpoints" + }, + { + "target": "com.amazonaws.ec2#DescribeClientVpnRoutes" + }, + { + "target": "com.amazonaws.ec2#DescribeClientVpnTargetNetworks" + }, + { + "target": "com.amazonaws.ec2#DescribeCoipPools" + }, + { + "target": "com.amazonaws.ec2#DescribeConversionTasks" + }, + { + "target": "com.amazonaws.ec2#DescribeCustomerGateways" + }, + { + "target": "com.amazonaws.ec2#DescribeDhcpOptions" + }, + { + "target": "com.amazonaws.ec2#DescribeEgressOnlyInternetGateways" + }, + { + "target": "com.amazonaws.ec2#DescribeElasticGpus" + }, + { + "target": "com.amazonaws.ec2#DescribeExportImageTasks" + }, + { + "target": "com.amazonaws.ec2#DescribeExportTasks" + }, + { + "target": "com.amazonaws.ec2#DescribeFastLaunchImages" + }, + { + "target": "com.amazonaws.ec2#DescribeFastSnapshotRestores" + }, + { + "target": "com.amazonaws.ec2#DescribeFleetHistory" + }, + { + "target": "com.amazonaws.ec2#DescribeFleetInstances" + }, + { + "target": "com.amazonaws.ec2#DescribeFleets" + }, + { + "target": "com.amazonaws.ec2#DescribeFlowLogs" + }, + { + "target": "com.amazonaws.ec2#DescribeFpgaImageAttribute" + }, + { + "target": "com.amazonaws.ec2#DescribeFpgaImages" + }, + { + "target": "com.amazonaws.ec2#DescribeHostReservationOfferings" + }, + { + "target": "com.amazonaws.ec2#DescribeHostReservations" + }, + { + "target": "com.amazonaws.ec2#DescribeHosts" + }, + { + "target": "com.amazonaws.ec2#DescribeIamInstanceProfileAssociations" + }, + { + "target": "com.amazonaws.ec2#DescribeIdentityIdFormat" + }, + { + "target": "com.amazonaws.ec2#DescribeIdFormat" + }, + { + "target": "com.amazonaws.ec2#DescribeImageAttribute" + }, + { + "target": "com.amazonaws.ec2#DescribeImages" + }, + { + "target": "com.amazonaws.ec2#DescribeImportImageTasks" + }, + { + "target": "com.amazonaws.ec2#DescribeImportSnapshotTasks" + }, + { + "target": "com.amazonaws.ec2#DescribeInstanceAttribute" + }, + { + "target": "com.amazonaws.ec2#DescribeInstanceConnectEndpoints" + }, + { + "target": "com.amazonaws.ec2#DescribeInstanceCreditSpecifications" + }, + { + "target": "com.amazonaws.ec2#DescribeInstanceEventNotificationAttributes" + }, + { + "target": "com.amazonaws.ec2#DescribeInstanceEventWindows" + }, + { + "target": "com.amazonaws.ec2#DescribeInstances" + }, + { + "target": "com.amazonaws.ec2#DescribeInstanceStatus" + }, + { + "target": "com.amazonaws.ec2#DescribeInstanceTypeOfferings" + }, + { + "target": "com.amazonaws.ec2#DescribeInstanceTypes" + }, + { + "target": "com.amazonaws.ec2#DescribeInternetGateways" + }, + { + "target": "com.amazonaws.ec2#DescribeIpamPools" + }, + { + "target": "com.amazonaws.ec2#DescribeIpamResourceDiscoveries" + }, + { + "target": "com.amazonaws.ec2#DescribeIpamResourceDiscoveryAssociations" + }, + { + "target": "com.amazonaws.ec2#DescribeIpams" + }, + { + "target": "com.amazonaws.ec2#DescribeIpamScopes" + }, + { + "target": "com.amazonaws.ec2#DescribeIpv6Pools" + }, + { + "target": "com.amazonaws.ec2#DescribeKeyPairs" + }, + { + "target": "com.amazonaws.ec2#DescribeLaunchTemplates" + }, + { + "target": "com.amazonaws.ec2#DescribeLaunchTemplateVersions" + }, + { + "target": "com.amazonaws.ec2#DescribeLocalGatewayRouteTables" + }, + { + "target": "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations" + }, + { + "target": "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVpcAssociations" + }, + { + "target": "com.amazonaws.ec2#DescribeLocalGateways" + }, + { + "target": "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfaceGroups" + }, + { + "target": "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfaces" + }, + { + "target": "com.amazonaws.ec2#DescribeManagedPrefixLists" + }, + { + "target": "com.amazonaws.ec2#DescribeMovingAddresses" + }, + { + "target": "com.amazonaws.ec2#DescribeNatGateways" + }, + { + "target": "com.amazonaws.ec2#DescribeNetworkAcls" + }, + { + "target": "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopeAnalyses" + }, + { + "target": "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopes" + }, + { + "target": "com.amazonaws.ec2#DescribeNetworkInsightsAnalyses" + }, + { + "target": "com.amazonaws.ec2#DescribeNetworkInsightsPaths" + }, + { + "target": "com.amazonaws.ec2#DescribeNetworkInterfaceAttribute" + }, + { + "target": "com.amazonaws.ec2#DescribeNetworkInterfacePermissions" + }, + { + "target": "com.amazonaws.ec2#DescribeNetworkInterfaces" + }, + { + "target": "com.amazonaws.ec2#DescribePlacementGroups" + }, + { + "target": "com.amazonaws.ec2#DescribePrefixLists" + }, + { + "target": "com.amazonaws.ec2#DescribePrincipalIdFormat" + }, + { + "target": "com.amazonaws.ec2#DescribePublicIpv4Pools" + }, + { + "target": "com.amazonaws.ec2#DescribeRegions" + }, + { + "target": "com.amazonaws.ec2#DescribeReplaceRootVolumeTasks" + }, + { + "target": "com.amazonaws.ec2#DescribeReservedInstances" + }, + { + "target": "com.amazonaws.ec2#DescribeReservedInstancesListings" + }, + { + "target": "com.amazonaws.ec2#DescribeReservedInstancesModifications" + }, + { + "target": "com.amazonaws.ec2#DescribeReservedInstancesOfferings" + }, + { + "target": "com.amazonaws.ec2#DescribeRouteTables" + }, + { + "target": "com.amazonaws.ec2#DescribeScheduledInstanceAvailability" + }, + { + "target": "com.amazonaws.ec2#DescribeScheduledInstances" + }, + { + "target": "com.amazonaws.ec2#DescribeSecurityGroupReferences" + }, + { + "target": "com.amazonaws.ec2#DescribeSecurityGroupRules" + }, + { + "target": "com.amazonaws.ec2#DescribeSecurityGroups" + }, + { + "target": "com.amazonaws.ec2#DescribeSnapshotAttribute" + }, + { + "target": "com.amazonaws.ec2#DescribeSnapshots" + }, + { + "target": "com.amazonaws.ec2#DescribeSnapshotTierStatus" + }, + { + "target": "com.amazonaws.ec2#DescribeSpotDatafeedSubscription" + }, + { + "target": "com.amazonaws.ec2#DescribeSpotFleetInstances" + }, + { + "target": "com.amazonaws.ec2#DescribeSpotFleetRequestHistory" + }, + { + "target": "com.amazonaws.ec2#DescribeSpotFleetRequests" + }, + { + "target": "com.amazonaws.ec2#DescribeSpotInstanceRequests" + }, + { + "target": "com.amazonaws.ec2#DescribeSpotPriceHistory" + }, + { + "target": "com.amazonaws.ec2#DescribeStaleSecurityGroups" + }, + { + "target": "com.amazonaws.ec2#DescribeStoreImageTasks" + }, + { + "target": "com.amazonaws.ec2#DescribeSubnets" + }, + { + "target": "com.amazonaws.ec2#DescribeTags" + }, + { + "target": "com.amazonaws.ec2#DescribeTrafficMirrorFilters" + }, + { + "target": "com.amazonaws.ec2#DescribeTrafficMirrorSessions" + }, + { + "target": "com.amazonaws.ec2#DescribeTrafficMirrorTargets" + }, + { + "target": "com.amazonaws.ec2#DescribeTransitGatewayAttachments" + }, + { + "target": "com.amazonaws.ec2#DescribeTransitGatewayConnectPeers" + }, + { + "target": "com.amazonaws.ec2#DescribeTransitGatewayConnects" + }, + { + "target": "com.amazonaws.ec2#DescribeTransitGatewayMulticastDomains" + }, + { + "target": "com.amazonaws.ec2#DescribeTransitGatewayPeeringAttachments" + }, + { + "target": "com.amazonaws.ec2#DescribeTransitGatewayPolicyTables" + }, + { + "target": "com.amazonaws.ec2#DescribeTransitGatewayRouteTableAnnouncements" + }, + { + "target": "com.amazonaws.ec2#DescribeTransitGatewayRouteTables" + }, + { + "target": "com.amazonaws.ec2#DescribeTransitGateways" + }, + { + "target": "com.amazonaws.ec2#DescribeTransitGatewayVpcAttachments" + }, + { + "target": "com.amazonaws.ec2#DescribeTrunkInterfaceAssociations" + }, + { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessEndpoints" + }, + { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessGroups" + }, + { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessInstanceLoggingConfigurations" + }, + { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessInstances" + }, + { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessTrustProviders" + }, + { + "target": "com.amazonaws.ec2#DescribeVolumeAttribute" + }, + { + "target": "com.amazonaws.ec2#DescribeVolumes" + }, + { + "target": "com.amazonaws.ec2#DescribeVolumesModifications" + }, + { + "target": "com.amazonaws.ec2#DescribeVolumeStatus" + }, + { + "target": "com.amazonaws.ec2#DescribeVpcAttribute" + }, + { + "target": "com.amazonaws.ec2#DescribeVpcClassicLink" + }, + { + "target": "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupport" + }, + { + "target": "com.amazonaws.ec2#DescribeVpcEndpointConnectionNotifications" + }, + { + "target": "com.amazonaws.ec2#DescribeVpcEndpointConnections" + }, + { + "target": "com.amazonaws.ec2#DescribeVpcEndpoints" + }, + { + "target": "com.amazonaws.ec2#DescribeVpcEndpointServiceConfigurations" + }, + { + "target": "com.amazonaws.ec2#DescribeVpcEndpointServicePermissions" + }, + { + "target": "com.amazonaws.ec2#DescribeVpcEndpointServices" + }, + { + "target": "com.amazonaws.ec2#DescribeVpcPeeringConnections" + }, + { + "target": "com.amazonaws.ec2#DescribeVpcs" + }, + { + "target": "com.amazonaws.ec2#DescribeVpnConnections" + }, + { + "target": "com.amazonaws.ec2#DescribeVpnGateways" + }, + { + "target": "com.amazonaws.ec2#DetachClassicLinkVpc" + }, + { + "target": "com.amazonaws.ec2#DetachInternetGateway" + }, + { + "target": "com.amazonaws.ec2#DetachNetworkInterface" + }, + { + "target": "com.amazonaws.ec2#DetachVerifiedAccessTrustProvider" + }, + { + "target": "com.amazonaws.ec2#DetachVolume" + }, + { + "target": "com.amazonaws.ec2#DetachVpnGateway" + }, + { + "target": "com.amazonaws.ec2#DisableAddressTransfer" + }, + { + "target": "com.amazonaws.ec2#DisableAwsNetworkPerformanceMetricSubscription" + }, + { + "target": "com.amazonaws.ec2#DisableEbsEncryptionByDefault" + }, + { + "target": "com.amazonaws.ec2#DisableFastLaunch" + }, + { + "target": "com.amazonaws.ec2#DisableFastSnapshotRestores" + }, + { + "target": "com.amazonaws.ec2#DisableImageDeprecation" + }, + { + "target": "com.amazonaws.ec2#DisableIpamOrganizationAdminAccount" + }, + { + "target": "com.amazonaws.ec2#DisableSerialConsoleAccess" + }, + { + "target": "com.amazonaws.ec2#DisableTransitGatewayRouteTablePropagation" + }, + { + "target": "com.amazonaws.ec2#DisableVgwRoutePropagation" + }, + { + "target": "com.amazonaws.ec2#DisableVpcClassicLink" + }, + { + "target": "com.amazonaws.ec2#DisableVpcClassicLinkDnsSupport" + }, + { + "target": "com.amazonaws.ec2#DisassociateAddress" + }, + { + "target": "com.amazonaws.ec2#DisassociateClientVpnTargetNetwork" + }, + { + "target": "com.amazonaws.ec2#DisassociateEnclaveCertificateIamRole" + }, + { + "target": "com.amazonaws.ec2#DisassociateIamInstanceProfile" + }, + { + "target": "com.amazonaws.ec2#DisassociateInstanceEventWindow" + }, + { + "target": "com.amazonaws.ec2#DisassociateIpamResourceDiscovery" + }, + { + "target": "com.amazonaws.ec2#DisassociateNatGatewayAddress" + }, + { + "target": "com.amazonaws.ec2#DisassociateRouteTable" + }, + { + "target": "com.amazonaws.ec2#DisassociateSubnetCidrBlock" + }, + { + "target": "com.amazonaws.ec2#DisassociateTransitGatewayMulticastDomain" + }, + { + "target": "com.amazonaws.ec2#DisassociateTransitGatewayPolicyTable" + }, + { + "target": "com.amazonaws.ec2#DisassociateTransitGatewayRouteTable" + }, + { + "target": "com.amazonaws.ec2#DisassociateTrunkInterface" + }, + { + "target": "com.amazonaws.ec2#DisassociateVpcCidrBlock" + }, + { + "target": "com.amazonaws.ec2#EnableAddressTransfer" + }, + { + "target": "com.amazonaws.ec2#EnableAwsNetworkPerformanceMetricSubscription" + }, + { + "target": "com.amazonaws.ec2#EnableEbsEncryptionByDefault" + }, + { + "target": "com.amazonaws.ec2#EnableFastLaunch" + }, + { + "target": "com.amazonaws.ec2#EnableFastSnapshotRestores" + }, + { + "target": "com.amazonaws.ec2#EnableImageDeprecation" + }, + { + "target": "com.amazonaws.ec2#EnableIpamOrganizationAdminAccount" + }, + { + "target": "com.amazonaws.ec2#EnableReachabilityAnalyzerOrganizationSharing" + }, + { + "target": "com.amazonaws.ec2#EnableSerialConsoleAccess" + }, + { + "target": "com.amazonaws.ec2#EnableTransitGatewayRouteTablePropagation" + }, + { + "target": "com.amazonaws.ec2#EnableVgwRoutePropagation" + }, + { + "target": "com.amazonaws.ec2#EnableVolumeIO" + }, + { + "target": "com.amazonaws.ec2#EnableVpcClassicLink" + }, + { + "target": "com.amazonaws.ec2#EnableVpcClassicLinkDnsSupport" + }, + { + "target": "com.amazonaws.ec2#ExportClientVpnClientCertificateRevocationList" + }, + { + "target": "com.amazonaws.ec2#ExportClientVpnClientConfiguration" + }, + { + "target": "com.amazonaws.ec2#ExportImage" + }, + { + "target": "com.amazonaws.ec2#ExportTransitGatewayRoutes" + }, + { + "target": "com.amazonaws.ec2#GetAssociatedEnclaveCertificateIamRoles" + }, + { + "target": "com.amazonaws.ec2#GetAssociatedIpv6PoolCidrs" + }, + { + "target": "com.amazonaws.ec2#GetAwsNetworkPerformanceData" + }, + { + "target": "com.amazonaws.ec2#GetCapacityReservationUsage" + }, + { + "target": "com.amazonaws.ec2#GetCoipPoolUsage" + }, + { + "target": "com.amazonaws.ec2#GetConsoleOutput" + }, + { + "target": "com.amazonaws.ec2#GetConsoleScreenshot" + }, + { + "target": "com.amazonaws.ec2#GetDefaultCreditSpecification" + }, + { + "target": "com.amazonaws.ec2#GetEbsDefaultKmsKeyId" + }, + { + "target": "com.amazonaws.ec2#GetEbsEncryptionByDefault" + }, + { + "target": "com.amazonaws.ec2#GetFlowLogsIntegrationTemplate" + }, + { + "target": "com.amazonaws.ec2#GetGroupsForCapacityReservation" + }, + { + "target": "com.amazonaws.ec2#GetHostReservationPurchasePreview" + }, + { + "target": "com.amazonaws.ec2#GetInstanceTypesFromInstanceRequirements" + }, + { + "target": "com.amazonaws.ec2#GetInstanceUefiData" + }, + { + "target": "com.amazonaws.ec2#GetIpamAddressHistory" + }, + { + "target": "com.amazonaws.ec2#GetIpamDiscoveredAccounts" + }, + { + "target": "com.amazonaws.ec2#GetIpamDiscoveredResourceCidrs" + }, + { + "target": "com.amazonaws.ec2#GetIpamPoolAllocations" + }, + { + "target": "com.amazonaws.ec2#GetIpamPoolCidrs" + }, + { + "target": "com.amazonaws.ec2#GetIpamResourceCidrs" + }, + { + "target": "com.amazonaws.ec2#GetLaunchTemplateData" + }, + { + "target": "com.amazonaws.ec2#GetManagedPrefixListAssociations" + }, + { + "target": "com.amazonaws.ec2#GetManagedPrefixListEntries" + }, + { + "target": "com.amazonaws.ec2#GetNetworkInsightsAccessScopeAnalysisFindings" + }, + { + "target": "com.amazonaws.ec2#GetNetworkInsightsAccessScopeContent" + }, + { + "target": "com.amazonaws.ec2#GetPasswordData" + }, + { + "target": "com.amazonaws.ec2#GetReservedInstancesExchangeQuote" + }, + { + "target": "com.amazonaws.ec2#GetSerialConsoleAccessStatus" + }, + { + "target": "com.amazonaws.ec2#GetSpotPlacementScores" + }, + { + "target": "com.amazonaws.ec2#GetSubnetCidrReservations" + }, + { + "target": "com.amazonaws.ec2#GetTransitGatewayAttachmentPropagations" + }, + { + "target": "com.amazonaws.ec2#GetTransitGatewayMulticastDomainAssociations" + }, + { + "target": "com.amazonaws.ec2#GetTransitGatewayPolicyTableAssociations" + }, + { + "target": "com.amazonaws.ec2#GetTransitGatewayPolicyTableEntries" + }, + { + "target": "com.amazonaws.ec2#GetTransitGatewayPrefixListReferences" + }, + { + "target": "com.amazonaws.ec2#GetTransitGatewayRouteTableAssociations" + }, + { + "target": "com.amazonaws.ec2#GetTransitGatewayRouteTablePropagations" + }, + { + "target": "com.amazonaws.ec2#GetVerifiedAccessEndpointPolicy" + }, + { + "target": "com.amazonaws.ec2#GetVerifiedAccessGroupPolicy" + }, + { + "target": "com.amazonaws.ec2#GetVpnConnectionDeviceSampleConfiguration" + }, + { + "target": "com.amazonaws.ec2#GetVpnConnectionDeviceTypes" + }, + { + "target": "com.amazonaws.ec2#GetVpnTunnelReplacementStatus" + }, + { + "target": "com.amazonaws.ec2#ImportClientVpnClientCertificateRevocationList" + }, + { + "target": "com.amazonaws.ec2#ImportImage" + }, + { + "target": "com.amazonaws.ec2#ImportInstance" + }, + { + "target": "com.amazonaws.ec2#ImportKeyPair" + }, + { + "target": "com.amazonaws.ec2#ImportSnapshot" + }, + { + "target": "com.amazonaws.ec2#ImportVolume" + }, + { + "target": "com.amazonaws.ec2#ListImagesInRecycleBin" + }, + { + "target": "com.amazonaws.ec2#ListSnapshotsInRecycleBin" + }, + { + "target": "com.amazonaws.ec2#ModifyAddressAttribute" + }, + { + "target": "com.amazonaws.ec2#ModifyAvailabilityZoneGroup" + }, + { + "target": "com.amazonaws.ec2#ModifyCapacityReservation" + }, + { + "target": "com.amazonaws.ec2#ModifyCapacityReservationFleet" + }, + { + "target": "com.amazonaws.ec2#ModifyClientVpnEndpoint" + }, + { + "target": "com.amazonaws.ec2#ModifyDefaultCreditSpecification" + }, + { + "target": "com.amazonaws.ec2#ModifyEbsDefaultKmsKeyId" + }, + { + "target": "com.amazonaws.ec2#ModifyFleet" + }, + { + "target": "com.amazonaws.ec2#ModifyFpgaImageAttribute" + }, + { + "target": "com.amazonaws.ec2#ModifyHosts" + }, + { + "target": "com.amazonaws.ec2#ModifyIdentityIdFormat" + }, + { + "target": "com.amazonaws.ec2#ModifyIdFormat" + }, + { + "target": "com.amazonaws.ec2#ModifyImageAttribute" + }, + { + "target": "com.amazonaws.ec2#ModifyInstanceAttribute" + }, + { + "target": "com.amazonaws.ec2#ModifyInstanceCapacityReservationAttributes" + }, + { + "target": "com.amazonaws.ec2#ModifyInstanceCreditSpecification" + }, + { + "target": "com.amazonaws.ec2#ModifyInstanceEventStartTime" + }, + { + "target": "com.amazonaws.ec2#ModifyInstanceEventWindow" + }, + { + "target": "com.amazonaws.ec2#ModifyInstanceMaintenanceOptions" + }, + { + "target": "com.amazonaws.ec2#ModifyInstanceMetadataOptions" + }, + { + "target": "com.amazonaws.ec2#ModifyInstancePlacement" + }, + { + "target": "com.amazonaws.ec2#ModifyIpam" + }, + { + "target": "com.amazonaws.ec2#ModifyIpamPool" + }, + { + "target": "com.amazonaws.ec2#ModifyIpamResourceCidr" + }, + { + "target": "com.amazonaws.ec2#ModifyIpamResourceDiscovery" + }, + { + "target": "com.amazonaws.ec2#ModifyIpamScope" + }, + { + "target": "com.amazonaws.ec2#ModifyLaunchTemplate" + }, + { + "target": "com.amazonaws.ec2#ModifyLocalGatewayRoute" + }, + { + "target": "com.amazonaws.ec2#ModifyManagedPrefixList" + }, + { + "target": "com.amazonaws.ec2#ModifyNetworkInterfaceAttribute" + }, + { + "target": "com.amazonaws.ec2#ModifyPrivateDnsNameOptions" + }, + { + "target": "com.amazonaws.ec2#ModifyReservedInstances" + }, + { + "target": "com.amazonaws.ec2#ModifySecurityGroupRules" + }, + { + "target": "com.amazonaws.ec2#ModifySnapshotAttribute" + }, + { + "target": "com.amazonaws.ec2#ModifySnapshotTier" + }, + { + "target": "com.amazonaws.ec2#ModifySpotFleetRequest" + }, + { + "target": "com.amazonaws.ec2#ModifySubnetAttribute" + }, + { + "target": "com.amazonaws.ec2#ModifyTrafficMirrorFilterNetworkServices" + }, + { + "target": "com.amazonaws.ec2#ModifyTrafficMirrorFilterRule" + }, + { + "target": "com.amazonaws.ec2#ModifyTrafficMirrorSession" + }, + { + "target": "com.amazonaws.ec2#ModifyTransitGateway" + }, + { + "target": "com.amazonaws.ec2#ModifyTransitGatewayPrefixListReference" + }, + { + "target": "com.amazonaws.ec2#ModifyTransitGatewayVpcAttachment" + }, + { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessEndpoint" + }, + { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessEndpointPolicy" + }, + { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessGroup" + }, + { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessGroupPolicy" + }, + { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessInstance" + }, + { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessInstanceLoggingConfiguration" + }, + { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessTrustProvider" + }, + { + "target": "com.amazonaws.ec2#ModifyVolume" + }, + { + "target": "com.amazonaws.ec2#ModifyVolumeAttribute" + }, + { + "target": "com.amazonaws.ec2#ModifyVpcAttribute" + }, + { + "target": "com.amazonaws.ec2#ModifyVpcEndpoint" + }, + { + "target": "com.amazonaws.ec2#ModifyVpcEndpointConnectionNotification" + }, + { + "target": "com.amazonaws.ec2#ModifyVpcEndpointServiceConfiguration" + }, + { + "target": "com.amazonaws.ec2#ModifyVpcEndpointServicePayerResponsibility" + }, + { + "target": "com.amazonaws.ec2#ModifyVpcEndpointServicePermissions" + }, + { + "target": "com.amazonaws.ec2#ModifyVpcPeeringConnectionOptions" + }, + { + "target": "com.amazonaws.ec2#ModifyVpcTenancy" + }, + { + "target": "com.amazonaws.ec2#ModifyVpnConnection" + }, + { + "target": "com.amazonaws.ec2#ModifyVpnConnectionOptions" + }, + { + "target": "com.amazonaws.ec2#ModifyVpnTunnelCertificate" + }, + { + "target": "com.amazonaws.ec2#ModifyVpnTunnelOptions" + }, + { + "target": "com.amazonaws.ec2#MonitorInstances" + }, + { + "target": "com.amazonaws.ec2#MoveAddressToVpc" + }, + { + "target": "com.amazonaws.ec2#MoveByoipCidrToIpam" + }, + { + "target": "com.amazonaws.ec2#ProvisionByoipCidr" + }, + { + "target": "com.amazonaws.ec2#ProvisionIpamPoolCidr" + }, + { + "target": "com.amazonaws.ec2#ProvisionPublicIpv4PoolCidr" + }, + { + "target": "com.amazonaws.ec2#PurchaseHostReservation" + }, + { + "target": "com.amazonaws.ec2#PurchaseReservedInstancesOffering" + }, + { + "target": "com.amazonaws.ec2#PurchaseScheduledInstances" + }, + { + "target": "com.amazonaws.ec2#RebootInstances" + }, + { + "target": "com.amazonaws.ec2#RegisterImage" + }, + { + "target": "com.amazonaws.ec2#RegisterInstanceEventNotificationAttributes" + }, + { + "target": "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupMembers" + }, + { + "target": "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupSources" + }, + { + "target": "com.amazonaws.ec2#RejectTransitGatewayMulticastDomainAssociations" + }, + { + "target": "com.amazonaws.ec2#RejectTransitGatewayPeeringAttachment" + }, + { + "target": "com.amazonaws.ec2#RejectTransitGatewayVpcAttachment" + }, + { + "target": "com.amazonaws.ec2#RejectVpcEndpointConnections" + }, + { + "target": "com.amazonaws.ec2#RejectVpcPeeringConnection" + }, + { + "target": "com.amazonaws.ec2#ReleaseAddress" + }, + { + "target": "com.amazonaws.ec2#ReleaseHosts" + }, + { + "target": "com.amazonaws.ec2#ReleaseIpamPoolAllocation" + }, + { + "target": "com.amazonaws.ec2#ReplaceIamInstanceProfileAssociation" + }, + { + "target": "com.amazonaws.ec2#ReplaceNetworkAclAssociation" + }, + { + "target": "com.amazonaws.ec2#ReplaceNetworkAclEntry" + }, + { + "target": "com.amazonaws.ec2#ReplaceRoute" + }, + { + "target": "com.amazonaws.ec2#ReplaceRouteTableAssociation" + }, + { + "target": "com.amazonaws.ec2#ReplaceTransitGatewayRoute" + }, + { + "target": "com.amazonaws.ec2#ReplaceVpnTunnel" + }, + { + "target": "com.amazonaws.ec2#ReportInstanceStatus" + }, + { + "target": "com.amazonaws.ec2#RequestSpotFleet" + }, + { + "target": "com.amazonaws.ec2#RequestSpotInstances" + }, + { + "target": "com.amazonaws.ec2#ResetAddressAttribute" + }, + { + "target": "com.amazonaws.ec2#ResetEbsDefaultKmsKeyId" + }, + { + "target": "com.amazonaws.ec2#ResetFpgaImageAttribute" + }, + { + "target": "com.amazonaws.ec2#ResetImageAttribute" + }, + { + "target": "com.amazonaws.ec2#ResetInstanceAttribute" + }, + { + "target": "com.amazonaws.ec2#ResetNetworkInterfaceAttribute" + }, + { + "target": "com.amazonaws.ec2#ResetSnapshotAttribute" + }, + { + "target": "com.amazonaws.ec2#RestoreAddressToClassic" + }, + { + "target": "com.amazonaws.ec2#RestoreImageFromRecycleBin" + }, + { + "target": "com.amazonaws.ec2#RestoreManagedPrefixListVersion" + }, + { + "target": "com.amazonaws.ec2#RestoreSnapshotFromRecycleBin" + }, + { + "target": "com.amazonaws.ec2#RestoreSnapshotTier" + }, + { + "target": "com.amazonaws.ec2#RevokeClientVpnIngress" + }, + { + "target": "com.amazonaws.ec2#RevokeSecurityGroupEgress" + }, + { + "target": "com.amazonaws.ec2#RevokeSecurityGroupIngress" + }, + { + "target": "com.amazonaws.ec2#RunInstances" + }, + { + "target": "com.amazonaws.ec2#RunScheduledInstances" + }, + { + "target": "com.amazonaws.ec2#SearchLocalGatewayRoutes" + }, + { + "target": "com.amazonaws.ec2#SearchTransitGatewayMulticastGroups" + }, + { + "target": "com.amazonaws.ec2#SearchTransitGatewayRoutes" + }, + { + "target": "com.amazonaws.ec2#SendDiagnosticInterrupt" + }, + { + "target": "com.amazonaws.ec2#StartInstances" + }, + { + "target": "com.amazonaws.ec2#StartNetworkInsightsAccessScopeAnalysis" + }, + { + "target": "com.amazonaws.ec2#StartNetworkInsightsAnalysis" + }, + { + "target": "com.amazonaws.ec2#StartVpcEndpointServicePrivateDnsVerification" + }, + { + "target": "com.amazonaws.ec2#StopInstances" + }, + { + "target": "com.amazonaws.ec2#TerminateClientVpnConnections" + }, + { + "target": "com.amazonaws.ec2#TerminateInstances" + }, + { + "target": "com.amazonaws.ec2#UnassignIpv6Addresses" + }, + { + "target": "com.amazonaws.ec2#UnassignPrivateIpAddresses" + }, + { + "target": "com.amazonaws.ec2#UnassignPrivateNatGatewayAddress" + }, + { + "target": "com.amazonaws.ec2#UnmonitorInstances" + }, + { + "target": "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsEgress" + }, + { + "target": "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsIngress" + }, + { + "target": "com.amazonaws.ec2#WithdrawByoipCidr" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "EC2", + "arnNamespace": "ec2", + "cloudFormationName": "EC2", + "cloudTrailEventSource": "ec2.amazonaws.com", + "endpointPrefix": "ec2" + }, + "aws.auth#sigv4": { + "name": "ec2" + }, + "aws.protocols#ec2Query": {}, + "smithy.api#documentation": "Amazon Elastic Compute Cloud\n

Amazon Elastic Compute Cloud (Amazon EC2) provides secure and resizable computing capacity in the Amazon Web Services Cloud. \n Using Amazon EC2 eliminates the need to invest in hardware up front, so you can develop and deploy applications \n faster. Amazon Virtual Private Cloud (Amazon VPC) enables you to provision a logically isolated section of the \n Amazon Web Services Cloud where you can launch Amazon Web Services resources in a virtual network that you've defined. Amazon Elastic Block Store \n (Amazon EBS) provides block level storage volumes for use with EC2 instances. EBS volumes are highly available \n and reliable storage volumes that can be attached to any running instance and used like a hard drive.

\n

To learn more, see the following resources:

\n ", + "smithy.api#title": "Amazon Elastic Compute Cloud", + "smithy.api#xmlNamespace": { + "uri": "http://ec2.amazonaws.com/doc/2016-11-15" + }, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ec2-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws-us-gov", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://ec2.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://ec2-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ec2.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ec2.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.af-south-1.amazonaws.com" + } + }, + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.ap-east-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ec2.ap-south-1.api.aws" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2-fips.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ec2.eu-west-1.api.aws" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ec2.sa-east-1.api.aws" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ec2.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ec2.us-east-2.api.aws" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ec2.us-west-2.api.aws" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ec2-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ec2-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ec2.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ec2-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ec2.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.us-iso-west-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ec2-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.ec2#AmdSevSnpSpecification": { + "type": "enum", + "members": { + "enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + }, + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + } + } + }, + "com.amazonaws.ec2#AnalysisAclRule": { + "type": "structure", + "members": { + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Cidr", + "smithy.api#documentation": "

The IPv4 address range, in CIDR notation.

", + "smithy.api#xmlName": "cidr" + } + }, + "Egress": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Egress", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the rule is an outbound rule.

", + "smithy.api#xmlName": "egress" + } + }, + "PortRange": { + "target": "com.amazonaws.ec2#PortRange", + "traits": { + "aws.protocols#ec2QueryName": "PortRange", + "smithy.api#documentation": "

The range of ports.

", + "smithy.api#xmlName": "portRange" + } + }, + "Protocol": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Protocol", + "smithy.api#documentation": "

The protocol.

", + "smithy.api#xmlName": "protocol" + } + }, + "RuleAction": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RuleAction", + "smithy.api#documentation": "

Indicates whether to allow or deny traffic that matches the rule.

", + "smithy.api#xmlName": "ruleAction" + } + }, + "RuleNumber": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "RuleNumber", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The rule number.

", + "smithy.api#xmlName": "ruleNumber" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a network access control (ACL) rule.

" + } + }, + "com.amazonaws.ec2#AnalysisComponent": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Id", + "smithy.api#documentation": "

The ID of the component.

", + "smithy.api#xmlName": "id" + } + }, + "Arn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Arn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component.

", + "smithy.api#xmlName": "arn" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The name of the analysis component.

", + "smithy.api#xmlName": "name" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a path component.

" + } + }, + "com.amazonaws.ec2#AnalysisComponentList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#AnalysisLoadBalancerListener": { + "type": "structure", + "members": { + "LoadBalancerPort": { + "target": "com.amazonaws.ec2#Port", + "traits": { + "aws.protocols#ec2QueryName": "LoadBalancerPort", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The port on which the load balancer is listening.

", + "smithy.api#xmlName": "loadBalancerPort" + } + }, + "InstancePort": { + "target": "com.amazonaws.ec2#Port", + "traits": { + "aws.protocols#ec2QueryName": "InstancePort", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

[Classic Load Balancers] The back-end port for the listener.

", + "smithy.api#xmlName": "instancePort" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a load balancer listener.

" + } + }, + "com.amazonaws.ec2#AnalysisLoadBalancerTarget": { + "type": "structure", + "members": { + "Address": { + "target": "com.amazonaws.ec2#IpAddress", + "traits": { + "aws.protocols#ec2QueryName": "Address", + "smithy.api#documentation": "

The IP address.

", + "smithy.api#xmlName": "address" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "Instance": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "Instance", + "smithy.api#documentation": "

Information about the instance.

", + "smithy.api#xmlName": "instance" + } + }, + "Port": { + "target": "com.amazonaws.ec2#Port", + "traits": { + "aws.protocols#ec2QueryName": "Port", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The port on which the target is listening.

", + "smithy.api#xmlName": "port" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a load balancer target.

" + } + }, + "com.amazonaws.ec2#AnalysisPacketHeader": { + "type": "structure", + "members": { + "DestinationAddresses": { + "target": "com.amazonaws.ec2#IpAddressList", + "traits": { + "aws.protocols#ec2QueryName": "DestinationAddressSet", + "smithy.api#documentation": "

The destination addresses.

", + "smithy.api#xmlName": "destinationAddressSet" + } + }, + "DestinationPortRanges": { + "target": "com.amazonaws.ec2#PortRangeList", + "traits": { + "aws.protocols#ec2QueryName": "DestinationPortRangeSet", + "smithy.api#documentation": "

The destination port ranges.

", + "smithy.api#xmlName": "destinationPortRangeSet" + } + }, + "Protocol": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Protocol", + "smithy.api#documentation": "

The protocol.

", + "smithy.api#xmlName": "protocol" + } + }, + "SourceAddresses": { + "target": "com.amazonaws.ec2#IpAddressList", + "traits": { + "aws.protocols#ec2QueryName": "SourceAddressSet", + "smithy.api#documentation": "

The source addresses.

", + "smithy.api#xmlName": "sourceAddressSet" + } + }, + "SourcePortRanges": { + "target": "com.amazonaws.ec2#PortRangeList", + "traits": { + "aws.protocols#ec2QueryName": "SourcePortRangeSet", + "smithy.api#documentation": "

The source port ranges.

", + "smithy.api#xmlName": "sourcePortRangeSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a header. Reflects any changes made by a component as traffic passes through.\n The fields of an inbound header are null except for the first component of a path.

" + } + }, + "com.amazonaws.ec2#AnalysisRouteTableRoute": { + "type": "structure", + "members": { + "DestinationCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationCidr", + "smithy.api#documentation": "

The destination IPv4 address, in CIDR notation.

", + "smithy.api#xmlName": "destinationCidr" + } + }, + "DestinationPrefixListId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationPrefixListId", + "smithy.api#documentation": "

The prefix of the Amazon Web Service.

", + "smithy.api#xmlName": "destinationPrefixListId" + } + }, + "EgressOnlyInternetGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "EgressOnlyInternetGatewayId", + "smithy.api#documentation": "

The ID of an egress-only internet gateway.

", + "smithy.api#xmlName": "egressOnlyInternetGatewayId" + } + }, + "GatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GatewayId", + "smithy.api#documentation": "

The ID of the gateway, such as an internet gateway or virtual private gateway.

", + "smithy.api#xmlName": "gatewayId" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance, such as a NAT instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "NatGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NatGatewayId", + "smithy.api#documentation": "

The ID of a NAT gateway.

", + "smithy.api#xmlName": "natGatewayId" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of a network interface.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "Origin": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Origin", + "smithy.api#documentation": "

Describes how the route was created. The following are the possible values:

\n ", + "smithy.api#xmlName": "origin" + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayId", + "smithy.api#documentation": "

The ID of a transit gateway.

", + "smithy.api#xmlName": "transitGatewayId" + } + }, + "VpcPeeringConnectionId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", + "smithy.api#documentation": "

The ID of a VPC peering connection.

", + "smithy.api#xmlName": "vpcPeeringConnectionId" + } + }, + "State": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state. The following are the possible values:

\n ", + "smithy.api#xmlName": "state" + } + }, + "CarrierGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CarrierGatewayId", + "smithy.api#documentation": "

The ID of a carrier gateway.

", + "smithy.api#xmlName": "carrierGatewayId" + } + }, + "CoreNetworkArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "CoreNetworkArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a core network.

", + "smithy.api#xmlName": "coreNetworkArn" + } + }, + "LocalGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayId", + "smithy.api#documentation": "

The ID of a local gateway.

", + "smithy.api#xmlName": "localGatewayId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a route table route.

" + } + }, + "com.amazonaws.ec2#AnalysisSecurityGroupRule": { + "type": "structure", + "members": { + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Cidr", + "smithy.api#documentation": "

The IPv4 address range, in CIDR notation.

", + "smithy.api#xmlName": "cidr" + } + }, + "Direction": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Direction", + "smithy.api#documentation": "

The direction. The following are the possible values:

\n ", + "smithy.api#xmlName": "direction" + } + }, + "SecurityGroupId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupId", + "smithy.api#documentation": "

The security group ID.

", + "smithy.api#xmlName": "securityGroupId" + } + }, + "PortRange": { + "target": "com.amazonaws.ec2#PortRange", + "traits": { + "aws.protocols#ec2QueryName": "PortRange", + "smithy.api#documentation": "

The port range.

", + "smithy.api#xmlName": "portRange" + } + }, + "PrefixListId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListId", + "smithy.api#documentation": "

The prefix list ID.

", + "smithy.api#xmlName": "prefixListId" + } + }, + "Protocol": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Protocol", + "smithy.api#documentation": "

The protocol name.

", + "smithy.api#xmlName": "protocol" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a security group rule.

" + } + }, + "com.amazonaws.ec2#AnalysisStatus": { + "type": "enum", + "members": { + "running": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "running" + } + }, + "succeeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "succeeded" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + } + } + }, + "com.amazonaws.ec2#ApplianceModeSupportValue": { + "type": "enum", + "members": { + "enable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enable" + } + }, + "disable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disable" + } + } + } + }, + "com.amazonaws.ec2#ApplySecurityGroupsToClientVpnTargetNetwork": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ApplySecurityGroupsToClientVpnTargetNetworkRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ApplySecurityGroupsToClientVpnTargetNetworkResult" + }, + "traits": { + "smithy.api#documentation": "

Applies a security group to the association between the target network and the Client VPN endpoint. This action replaces the existing \n\t\t\tsecurity groups with the specified security groups.

" + } + }, + "com.amazonaws.ec2#ApplySecurityGroupsToClientVpnTargetNetworkRequest": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", + "smithy.api#required": {} + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC in which the associated target network is located.

", + "smithy.api#required": {} + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#ClientVpnSecurityGroupIdSet", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the security groups to apply to the associated target network. Up to 5 security groups can \n\t\t\tbe applied to an associated target network.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "SecurityGroupId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ApplySecurityGroupsToClientVpnTargetNetworkResult": { + "type": "structure", + "members": { + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#ClientVpnSecurityGroupIdSet", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupIds", + "smithy.api#documentation": "

The IDs of the applied security groups.

", + "smithy.api#xmlName": "securityGroupIds" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ArchitectureType": { + "type": "enum", + "members": { + "i386": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i386" + } + }, + "x86_64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x86_64" + } + }, + "arm64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "arm64" + } + }, + "x86_64_mac": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x86_64_mac" + } + }, + "arm64_mac": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "arm64_mac" + } + } + } + }, + "com.amazonaws.ec2#ArchitectureTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ArchitectureType", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ArchitectureTypeSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ArchitectureType", + "traits": { + "smithy.api#xmlName": "item" + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, + "com.amazonaws.ec2#ArchitectureValues": { + "type": "enum", + "members": { + "i386": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i386" + } + }, + "x86_64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x86_64" + } + }, + "arm64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "arm64" + } + }, + "x86_64_mac": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x86_64_mac" + } + }, + "arm64_mac": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "arm64_mac" + } + } + } + }, + "com.amazonaws.ec2#ArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#AssignIpv6Addresses": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssignIpv6AddressesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssignIpv6AddressesResult" + }, + "traits": { + "smithy.api#documentation": "

Assigns one or more IPv6 addresses to the specified network interface. You can\n specify one or more specific IPv6 addresses, or you can specify the number of IPv6\n addresses to be automatically assigned from within the subnet's IPv6 CIDR block range.\n You can assign as many IPv6 addresses to a network interface as you can assign private\n IPv4 addresses, and the limit varies per instance type. For information, see IP Addresses Per Network Interface Per Instance Type\n in the Amazon Elastic Compute Cloud User Guide.

\n

You must specify either the IPv6 addresses or the IPv6 address count in the request.

\n

You can optionally use Prefix Delegation on the network interface. You must specify\n either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For\n information, see \n Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#AssignIpv6AddressesRequest": { + "type": "structure", + "members": { + "Ipv6AddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6AddressCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of additional IPv6 addresses to assign to the network interface. \n \t\tThe specified number of IPv6 addresses are assigned in addition to the \n \t\texisting IPv6 addresses that are already assigned to the network interface. \n \t\tAmazon EC2 automatically selects the IPv6 addresses from the subnet range. You \n \t\tcan't use this option if specifying specific IPv6 addresses.

", + "smithy.api#xmlName": "ipv6AddressCount" + } + }, + "Ipv6Addresses": { + "target": "com.amazonaws.ec2#Ipv6AddressList", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Addresses", + "smithy.api#documentation": "

The IPv6 addresses to be assigned to the network interface. You can't use this option if you're specifying a number of IPv6 addresses.

", + "smithy.api#xmlName": "ipv6Addresses" + } + }, + "Ipv6PrefixCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of IPv6 prefixes that Amazon Web Services automatically assigns to the\n network interface. You cannot use this option if you use the Ipv6Prefixes\n option.

" + } + }, + "Ipv6Prefixes": { + "target": "com.amazonaws.ec2#IpPrefixList", + "traits": { + "smithy.api#documentation": "

One or more IPv6 prefixes assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.

", + "smithy.api#xmlName": "Ipv6Prefix" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "networkInterfaceId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssignIpv6AddressesResult": { + "type": "structure", + "members": { + "AssignedIpv6Addresses": { + "target": "com.amazonaws.ec2#Ipv6AddressList", + "traits": { + "aws.protocols#ec2QueryName": "AssignedIpv6Addresses", + "smithy.api#documentation": "

The new IPv6 addresses assigned to the network interface. Existing IPv6 addresses \n \tthat were assigned to the network interface before the request are not included.

", + "smithy.api#xmlName": "assignedIpv6Addresses" + } + }, + "AssignedIpv6Prefixes": { + "target": "com.amazonaws.ec2#IpPrefixList", + "traits": { + "aws.protocols#ec2QueryName": "AssignedIpv6PrefixSet", + "smithy.api#documentation": "

The IPv6 prefixes that are assigned to the network interface.

", + "smithy.api#xmlName": "assignedIpv6PrefixSet" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#xmlName": "networkInterfaceId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AssignPrivateIpAddresses": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssignPrivateIpAddressesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssignPrivateIpAddressesResult" + }, + "traits": { + "smithy.api#documentation": "

Assigns one or more secondary private IP addresses to the specified network interface.

\n

You can specify one or more specific secondary IP addresses, or you can specify the number \n of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. \n The number of secondary IP addresses that you can assign to an instance varies by instance type.\n For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about \n Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

\n

When you move a secondary private IP address to another network interface, any Elastic IP address \n that is associated with the IP address is also moved.

\n

Remapping an IP address is an asynchronous operation. When you move an IP address from one network\n interface to another, check network/interfaces/macs/mac/local-ipv4s in the instance\n metadata to confirm that the remapping is complete.

\n

You must specify either the IP addresses or the IP address count in the request.

\n

You can optionally use Prefix Delegation on the network interface. You must specify\n either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For\n information, see \n Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#AssignPrivateIpAddressesRequest": { + "type": "structure", + "members": { + "AllowReassignment": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AllowReassignment", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#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.

", + "smithy.api#xmlName": "allowReassignment" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "PrivateIpAddresses": { + "target": "com.amazonaws.ec2#PrivateIpAddressStringList", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

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

\n

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

", + "smithy.api#xmlName": "privateIpAddress" + } + }, + "SecondaryPrivateIpAddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "SecondaryPrivateIpAddressCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#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.

", + "smithy.api#xmlName": "secondaryPrivateIpAddressCount" + } + }, + "Ipv4Prefixes": { + "target": "com.amazonaws.ec2#IpPrefixList", + "traits": { + "smithy.api#documentation": "

One or more IPv4 prefixes assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.

", + "smithy.api#xmlName": "Ipv4Prefix" + } + }, + "Ipv4PrefixCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes option.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for AssignPrivateIpAddresses.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssignPrivateIpAddressesResult": { + "type": "structure", + "members": { + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "AssignedPrivateIpAddresses": { + "target": "com.amazonaws.ec2#AssignedPrivateIpAddressList", + "traits": { + "aws.protocols#ec2QueryName": "AssignedPrivateIpAddressesSet", + "smithy.api#documentation": "

The private IP addresses assigned to the network interface.

", + "smithy.api#xmlName": "assignedPrivateIpAddressesSet" + } + }, + "AssignedIpv4Prefixes": { + "target": "com.amazonaws.ec2#Ipv4PrefixesList", + "traits": { + "aws.protocols#ec2QueryName": "AssignedIpv4PrefixSet", + "smithy.api#documentation": "

The IPv4 prefixes that are assigned to the network interface.

", + "smithy.api#xmlName": "assignedIpv4PrefixSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AssignPrivateNatGatewayAddress": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssignPrivateNatGatewayAddressRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssignPrivateNatGatewayAddressResult" + }, + "traits": { + "smithy.api#documentation": "

Assigns one or more private IPv4 addresses to a private NAT gateway. For more information, see Work with NAT gateways in the Amazon Virtual Private Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#AssignPrivateNatGatewayAddressRequest": { + "type": "structure", + "members": { + "NatGatewayId": { + "target": "com.amazonaws.ec2#NatGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The NAT gateway ID.

", + "smithy.api#required": {} + } + }, + "PrivateIpAddresses": { + "target": "com.amazonaws.ec2#IpList", + "traits": { + "smithy.api#documentation": "

The private IPv4 addresses you want to assign to the private NAT gateway.

", + "smithy.api#xmlName": "PrivateIpAddress" + } + }, + "PrivateIpAddressCount": { + "target": "com.amazonaws.ec2#PrivateIpAddressCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of private IP addresses to assign to the NAT gateway. You can't specify this parameter when also specifying private IP addresses.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssignPrivateNatGatewayAddressResult": { + "type": "structure", + "members": { + "NatGatewayId": { + "target": "com.amazonaws.ec2#NatGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "NatGatewayId", + "smithy.api#documentation": "

The NAT gateway ID.

", + "smithy.api#xmlName": "natGatewayId" + } + }, + "NatGatewayAddresses": { + "target": "com.amazonaws.ec2#NatGatewayAddressList", + "traits": { + "aws.protocols#ec2QueryName": "NatGatewayAddressSet", + "smithy.api#documentation": "

NAT gateway IP addresses.

", + "smithy.api#xmlName": "natGatewayAddressSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AssignedPrivateIpAddress": { + "type": "structure", + "members": { + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

The private IP address assigned to the network interface.

", + "smithy.api#xmlName": "privateIpAddress" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the private IP addresses assigned to a network interface.

" + } + }, + "com.amazonaws.ec2#AssignedPrivateIpAddressList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AssignedPrivateIpAddress", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#AssociateAddress": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateAddressRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssociateAddressResult" + }, + "traits": { + "smithy.api#documentation": "

Associates an Elastic IP address, or carrier IP address (for instances that are in\n subnets in Wavelength Zones) with an instance or a network interface. Before you can use an\n Elastic IP address, you must allocate it to your account.

\n

If the Elastic IP address is already\n associated with a different instance, it is disassociated from that instance and associated\n with the specified instance. If you associate an Elastic IP address with an instance that has\n an existing Elastic IP address, the existing address is disassociated from the instance, but\n remains allocated to your account.

\n

[Subnets in Wavelength Zones] You can associate an IP address from the telecommunication\n carrier to the instance or network interface.

\n

You cannot associate an Elastic IP address with an interface in a different network border group.

\n \n

This is an idempotent operation. If you perform the operation more than once, Amazon EC2\n doesn't return an error, and you may be charged for each time the Elastic IP address is\n remapped to the same instance. For more information, see the Elastic IP\n Addresses section of Amazon EC2\n Pricing.

\n " + } + }, + "com.amazonaws.ec2#AssociateAddressRequest": { + "type": "structure", + "members": { + "AllocationId": { + "target": "com.amazonaws.ec2#AllocationId", + "traits": { + "smithy.api#documentation": "

The allocation ID. This is required.

" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#documentation": "

The ID of the instance. The instance must have exactly one attached network interface.\n You can specify either the instance ID or the network interface ID, but not both.

" + } + }, + "PublicIp": { + "target": "com.amazonaws.ec2#EipAllocationPublicIp", + "traits": { + "smithy.api#documentation": "

Deprecated.

" + } + }, + "AllowReassociation": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AllowReassociation", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Reassociation is automatic, but you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource.

", + "smithy.api#xmlName": "allowReassociation" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.

\n

You can specify either the instance ID or the network interface ID, but not both.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

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.

", + "smithy.api#xmlName": "privateIpAddress" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssociateAddressResult": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#documentation": "

The ID that represents the association of the Elastic IP address with an instance.

", + "smithy.api#xmlName": "associationId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AssociateClientVpnTargetNetwork": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateClientVpnTargetNetworkRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssociateClientVpnTargetNetworkResult" + }, + "traits": { + "smithy.api#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.

\n

If you specified a VPC when you created the Client VPN endpoint or if you have previous subnet associations, the specified subnet must be in the same VPC. To specify a subnet that's in a different VPC, you must first modify the Client VPN endpoint (ModifyClientVpnEndpoint) and change the VPC that's associated with it.

" + } + }, + "com.amazonaws.ec2#AssociateClientVpnTargetNetworkRequest": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", + "smithy.api#required": {} + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the subnet to associate with the Client VPN endpoint.

", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssociateClientVpnTargetNetworkResult": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#documentation": "

The unique ID of the target network association.

", + "smithy.api#xmlName": "associationId" + } + }, + "Status": { + "target": "com.amazonaws.ec2#AssociationStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The current state of the target network association.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AssociateDhcpOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateDhcpOptionsRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.

\n

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.

\n

For more information, see DHCP options sets\n in the Amazon Virtual Private Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#AssociateDhcpOptionsRequest": { + "type": "structure", + "members": { + "DhcpOptionsId": { + "target": "com.amazonaws.ec2#DefaultingDhcpOptionsId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the DHCP options set, or default to associate \n no DHCP options with the VPC.

", + "smithy.api#required": {} + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssociateEnclaveCertificateIamRole": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateEnclaveCertificateIamRoleRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssociateEnclaveCertificateIamRoleResult" + }, + "traits": { + "smithy.api#documentation": "

Associates an Identity and Access Management (IAM) role with an Certificate Manager (ACM) certificate. \n\t\t\tThis enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. For more \n\t\t\tinformation, see Certificate Manager for Nitro Enclaves in the Amazon Web Services Nitro Enclaves \n\t\t\t\t\tUser Guide.

\n

When the IAM role is associated with the ACM certificate, the certificate, certificate chain, and encrypted \n\t\t\tprivate key are placed in an Amazon S3 location that only the associated IAM role can access. The private key of the certificate \n\t\t\tis encrypted with an Amazon Web Services managed key that has an attached attestation-based key policy.

\n

To enable the IAM role to access the Amazon S3 object, you must grant it permission to call s3:GetObject \n\t\t\ton the Amazon S3 bucket returned by the command. To enable the IAM role to access the KMS key,\n\t\t\tyou must grant it permission to call kms:Decrypt on the KMS key returned by the command. \n\t\t\tFor more information, see \n\t\t\t\tGrant the role permission to access the certificate and encryption key in the \n\t\t\tAmazon Web Services Nitro Enclaves User Guide.

" + } + }, + "com.amazonaws.ec2#AssociateEnclaveCertificateIamRoleRequest": { + "type": "structure", + "members": { + "CertificateArn": { + "target": "com.amazonaws.ec2#CertificateId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the ACM certificate with which to associate the IAM role.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.ec2#RoleId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the IAM role to associate with the ACM certificate. You can associate up to 16 IAM roles with an ACM \n\t\t\tcertificate.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssociateEnclaveCertificateIamRoleResult": { + "type": "structure", + "members": { + "CertificateS3BucketName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CertificateS3BucketName", + "smithy.api#documentation": "

The name of the Amazon S3 bucket to which the certificate was uploaded.

", + "smithy.api#xmlName": "certificateS3BucketName" + } + }, + "CertificateS3ObjectKey": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CertificateS3ObjectKey", + "smithy.api#documentation": "

The Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored. The \n\t\t\tobject key is formatted as follows: role_arn/certificate_arn.

", + "smithy.api#xmlName": "certificateS3ObjectKey" + } + }, + "EncryptionKmsKeyId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "EncryptionKmsKeyId", + "smithy.api#documentation": "

The ID of the KMS key used to encrypt the private key of the certificate.

", + "smithy.api#xmlName": "encryptionKmsKeyId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AssociateIamInstanceProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateIamInstanceProfileRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssociateIamInstanceProfileResult" + }, + "traits": { + "smithy.api#documentation": "

Associates an IAM instance profile with a running or stopped instance. You cannot\n associate more than one IAM instance profile with an instance.

" + } + }, + "com.amazonaws.ec2#AssociateIamInstanceProfileRequest": { + "type": "structure", + "members": { + "IamInstanceProfile": { + "target": "com.amazonaws.ec2#IamInstanceProfileSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IAM instance profile.

", + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssociateIamInstanceProfileResult": { + "type": "structure", + "members": { + "IamInstanceProfileAssociation": { + "target": "com.amazonaws.ec2#IamInstanceProfileAssociation", + "traits": { + "aws.protocols#ec2QueryName": "IamInstanceProfileAssociation", + "smithy.api#documentation": "

Information about the IAM instance profile association.

", + "smithy.api#xmlName": "iamInstanceProfileAssociation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AssociateInstanceEventWindow": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateInstanceEventWindowRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssociateInstanceEventWindowResult" + }, + "traits": { + "smithy.api#documentation": "

Associates one or more targets with an event window. Only one type of target (instance IDs,\n Dedicated Host IDs, or tags) can be specified with an event window.

\n

For more information, see Define event windows for scheduled\n events in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#AssociateInstanceEventWindowRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "InstanceEventWindowId": { + "target": "com.amazonaws.ec2#InstanceEventWindowId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the event window.

", + "smithy.api#required": {} + } + }, + "AssociationTarget": { + "target": "com.amazonaws.ec2#InstanceEventWindowAssociationRequest", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

One or more targets associated with the specified event window.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssociateInstanceEventWindowResult": { + "type": "structure", + "members": { + "InstanceEventWindow": { + "target": "com.amazonaws.ec2#InstanceEventWindow", + "traits": { + "aws.protocols#ec2QueryName": "InstanceEventWindow", + "smithy.api#documentation": "

Information about the event window.

", + "smithy.api#xmlName": "instanceEventWindow" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AssociateIpamResourceDiscovery": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateIpamResourceDiscoveryRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssociateIpamResourceDiscoveryResult" + }, + "traits": { + "smithy.api#documentation": "

Associates an IPAM resource discovery with an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

" + } + }, + "com.amazonaws.ec2#AssociateIpamResourceDiscoveryRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamId": { + "target": "com.amazonaws.ec2#IpamId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An IPAM ID.

", + "smithy.api#required": {} + } + }, + "IpamResourceDiscoveryId": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A resource discovery ID.

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

Tag specifications.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A client token.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssociateIpamResourceDiscoveryResult": { + "type": "structure", + "members": { + "IpamResourceDiscoveryAssociation": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryAssociation", + "traits": { + "aws.protocols#ec2QueryName": "IpamResourceDiscoveryAssociation", + "smithy.api#documentation": "

A resource discovery association. An associated resource discovery is a resource discovery that has been associated with an IPAM.

", + "smithy.api#xmlName": "ipamResourceDiscoveryAssociation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AssociateNatGatewayAddress": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateNatGatewayAddressRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssociateNatGatewayAddressResult" + }, + "traits": { + "smithy.api#documentation": "

Associates Elastic IP addresses (EIPs) and private IPv4 addresses with a public NAT gateway. For more information, see Work with NAT gateways in the Amazon Virtual Private Cloud User Guide.

\n

By default, you can associate up to 2 Elastic IP addresses per public NAT gateway. You can increase the limit by requesting a quota adjustment. For more information, see Elastic IP address quotas in the Amazon Virtual Private Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#AssociateNatGatewayAddressRequest": { + "type": "structure", + "members": { + "NatGatewayId": { + "target": "com.amazonaws.ec2#NatGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The NAT gateway ID.

", + "smithy.api#required": {} + } + }, + "AllocationIds": { + "target": "com.amazonaws.ec2#AllocationIdList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The allocation IDs of EIPs that you want to associate with your NAT gateway.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "AllocationId" + } + }, + "PrivateIpAddresses": { + "target": "com.amazonaws.ec2#IpList", + "traits": { + "smithy.api#documentation": "

The private IPv4 addresses that you want to assign to the NAT gateway.

", + "smithy.api#xmlName": "PrivateIpAddress" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssociateNatGatewayAddressResult": { + "type": "structure", + "members": { + "NatGatewayId": { + "target": "com.amazonaws.ec2#NatGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "NatGatewayId", + "smithy.api#documentation": "

The NAT gateway ID.

", + "smithy.api#xmlName": "natGatewayId" + } + }, + "NatGatewayAddresses": { + "target": "com.amazonaws.ec2#NatGatewayAddressList", + "traits": { + "aws.protocols#ec2QueryName": "NatGatewayAddressSet", + "smithy.api#documentation": "

The IP addresses.

", + "smithy.api#xmlName": "natGatewayAddressSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AssociateRouteTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateRouteTableRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssociateRouteTableResult" + }, + "traits": { + "smithy.api#documentation": "

Associates a subnet in your VPC or an internet gateway or virtual private gateway\n attached to your VPC with a route table in your VPC. This association causes traffic\n from the subnet or gateway to be routed according to the routes in the route table. The\n action returns an association ID, which you need in order to disassociate the route\n table later. A route table can be associated with multiple subnets.

\n

For more information, see Route tables in the\n Amazon Virtual Private Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#AssociateRouteTableRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "RouteTableId": { + "target": "com.amazonaws.ec2#RouteTableId", + "traits": { + "aws.protocols#ec2QueryName": "RouteTableId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the route table.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "routeTableId" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet.

", + "smithy.api#xmlName": "subnetId" + } + }, + "GatewayId": { + "target": "com.amazonaws.ec2#RouteGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the internet gateway or virtual private gateway.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssociateRouteTableResult": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#documentation": "

The route table association ID. This ID is required for disassociating the route\n\t\t\ttable.

", + "smithy.api#xmlName": "associationId" + } + }, + "AssociationState": { + "target": "com.amazonaws.ec2#RouteTableAssociationState", + "traits": { + "aws.protocols#ec2QueryName": "AssociationState", + "smithy.api#documentation": "

The state of the association.

", + "smithy.api#xmlName": "associationState" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AssociateSubnetCidrBlock": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateSubnetCidrBlockRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssociateSubnetCidrBlockResult" + }, + "traits": { + "smithy.api#documentation": "

Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR\n block with your subnet. An IPv6 CIDR block must have a prefix length of /64.

" + } + }, + "com.amazonaws.ec2#AssociateSubnetCidrBlockRequest": { + "type": "structure", + "members": { + "Ipv6CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrBlock", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IPv6 CIDR block for your subnet. The subnet must have a /64 prefix\n length.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "ipv6CidrBlock" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of your subnet.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "subnetId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssociateSubnetCidrBlockResult": { + "type": "structure", + "members": { + "Ipv6CidrBlockAssociation": { + "target": "com.amazonaws.ec2#SubnetIpv6CidrBlockAssociation", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrBlockAssociation", + "smithy.api#documentation": "

Information about the IPv6 association.

", + "smithy.api#xmlName": "ipv6CidrBlockAssociation" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet.

", + "smithy.api#xmlName": "subnetId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AssociateTransitGatewayMulticastDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateTransitGatewayMulticastDomainRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssociateTransitGatewayMulticastDomainResult" + }, + "traits": { + "smithy.api#documentation": "

Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.

\n

The transit gateway attachment must be in the available state before you can add a resource. Use DescribeTransitGatewayAttachments \n to see the state of the attachment.

" + } + }, + "com.amazonaws.ec2#AssociateTransitGatewayMulticastDomainRequest": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", + "smithy.api#required": {} + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway attachment to associate with the transit gateway multicast domain.

", + "smithy.api#required": {} + } + }, + "SubnetIds": { + "target": "com.amazonaws.ec2#TransitGatewaySubnetIdList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the subnets to associate with the transit gateway multicast domain.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssociateTransitGatewayMulticastDomainResult": { + "type": "structure", + "members": { + "Associations": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainAssociations", + "traits": { + "aws.protocols#ec2QueryName": "Associations", + "smithy.api#documentation": "

Information about the transit gateway multicast domain associations.

", + "smithy.api#xmlName": "associations" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AssociateTransitGatewayPolicyTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateTransitGatewayPolicyTableRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssociateTransitGatewayPolicyTableResult" + }, + "traits": { + "smithy.api#documentation": "

Associates the specified transit gateway attachment with a transit gateway policy table.

" + } + }, + "com.amazonaws.ec2#AssociateTransitGatewayPolicyTableRequest": { + "type": "structure", + "members": { + "TransitGatewayPolicyTableId": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway policy table to associate with the transit gateway attachment.

", + "smithy.api#required": {} + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway attachment to associate with the policy table.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssociateTransitGatewayPolicyTableResult": { + "type": "structure", + "members": { + "Association": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableAssociation", + "traits": { + "aws.protocols#ec2QueryName": "Association", + "smithy.api#documentation": "

Describes the association of a transit gateway and a transit gateway policy table.

", + "smithy.api#xmlName": "association" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AssociateTransitGatewayRouteTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateTransitGatewayRouteTableRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssociateTransitGatewayRouteTableResult" + }, + "traits": { + "smithy.api#documentation": "

Associates the specified attachment with the specified transit gateway route table. You can \n associate only one route table with an attachment.

" + } + }, + "com.amazonaws.ec2#AssociateTransitGatewayRouteTableRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#required": {} + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssociateTransitGatewayRouteTableResult": { + "type": "structure", + "members": { + "Association": { + "target": "com.amazonaws.ec2#TransitGatewayAssociation", + "traits": { + "aws.protocols#ec2QueryName": "Association", + "smithy.api#documentation": "

The ID of the association.

", + "smithy.api#xmlName": "association" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AssociateTrunkInterface": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateTrunkInterfaceRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssociateTrunkInterfaceResult" + }, + "traits": { + "smithy.api#documentation": "\n

This API action is currently in limited preview only. \n If you are interested in using this feature, contact your account manager.

\n \n

Associates a branch network interface with a trunk network interface.

\n

Before you create the association, run the create-network-interface command and set\n --interface-type to trunk. You must also create a network interface for each branch network interface that you want to associate with the trunk network interface.

" + } + }, + "com.amazonaws.ec2#AssociateTrunkInterfaceRequest": { + "type": "structure", + "members": { + "BranchInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the branch network interface.

", + "smithy.api#required": {} + } + }, + "TrunkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the trunk network interface.

", + "smithy.api#required": {} + } + }, + "VlanId": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The ID of the VLAN. This applies to the VLAN protocol.

" + } + }, + "GreKey": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The application key. This applies to the GRE protocol.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to Ensure\n Idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssociateTrunkInterfaceResult": { + "type": "structure", + "members": { + "InterfaceAssociation": { + "target": "com.amazonaws.ec2#TrunkInterfaceAssociation", + "traits": { + "aws.protocols#ec2QueryName": "InterfaceAssociation", + "smithy.api#documentation": "

Information about the association between the trunk network interface and branch network interface.

", + "smithy.api#xmlName": "interfaceAssociation" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to Ensure\n Idempotency.

", + "smithy.api#xmlName": "clientToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AssociateVpcCidrBlock": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateVpcCidrBlockRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssociateVpcCidrBlockResult" + }, + "traits": { + "smithy.api#documentation": "

Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block,\n an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that\n you provisioned through bring your own IP addresses (BYOIP). The IPv6 CIDR block size is fixed\n at /56.

\n

You must specify one of the following in the request: an IPv4 CIDR block, an IPv6\n pool, or an Amazon-provided IPv6 CIDR block.

\n

For more information about associating CIDR blocks with your VPC and applicable\n restrictions, see VPC and subnet sizing in the\n Amazon Virtual Private Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#AssociateVpcCidrBlockRequest": { + "type": "structure", + "members": { + "AmazonProvidedIpv6CidrBlock": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AmazonProvidedIpv6CidrBlock", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#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.

", + "smithy.api#xmlName": "amazonProvidedIpv6CidrBlock" + } + }, + "CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

An IPv4 CIDR block to associate with the VPC.

" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "vpcId" + } + }, + "Ipv6CidrBlockNetworkBorderGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the location from which we advertise the IPV6 CIDR block. Use this parameter\n to limit the CIDR block to this location.

\n

You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.

\n

You can have one IPv6 CIDR block association per network border group.

" + } + }, + "Ipv6Pool": { + "target": "com.amazonaws.ec2#Ipv6PoolEc2Id", + "traits": { + "smithy.api#documentation": "

The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.

" + } + }, + "Ipv6CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

An IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.

\n

To let Amazon choose the IPv6 CIDR block for you, omit this parameter.

" + } + }, + "Ipv4IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#documentation": "

Associate a CIDR allocated from an IPv4 IPAM pool to a VPC. For more information about Amazon VPC IP Address Manager (IPAM), see What is IPAM? in the Amazon VPC IPAM User Guide.

" + } + }, + "Ipv4NetmaskLength": { + "target": "com.amazonaws.ec2#NetmaskLength", + "traits": { + "smithy.api#documentation": "

The netmask length of the IPv4 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.\n

" + } + }, + "Ipv6IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#documentation": "

Associates a CIDR allocated from an IPv6 IPAM pool to a VPC. For more information about Amazon VPC IP Address Manager (IPAM), see What is IPAM? in the Amazon VPC IPAM User Guide.

" + } + }, + "Ipv6NetmaskLength": { + "target": "com.amazonaws.ec2#NetmaskLength", + "traits": { + "smithy.api#documentation": "

The netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssociateVpcCidrBlockResult": { + "type": "structure", + "members": { + "Ipv6CidrBlockAssociation": { + "target": "com.amazonaws.ec2#VpcIpv6CidrBlockAssociation", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrBlockAssociation", + "smithy.api#documentation": "

Information about the IPv6 CIDR block association.

", + "smithy.api#xmlName": "ipv6CidrBlockAssociation" + } + }, + "CidrBlockAssociation": { + "target": "com.amazonaws.ec2#VpcCidrBlockAssociation", + "traits": { + "aws.protocols#ec2QueryName": "CidrBlockAssociation", + "smithy.api#documentation": "

Information about the IPv4 CIDR block association.

", + "smithy.api#xmlName": "cidrBlockAssociation" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AssociatedNetworkType": { + "type": "enum", + "members": { + "vpc": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc" + } + } + } + }, + "com.amazonaws.ec2#AssociatedRole": { + "type": "structure", + "members": { + "AssociatedRoleArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "AssociatedRoleArn", + "smithy.api#documentation": "

The ARN of the associated IAM role.

", + "smithy.api#xmlName": "associatedRoleArn" + } + }, + "CertificateS3BucketName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CertificateS3BucketName", + "smithy.api#documentation": "

The name of the Amazon S3 bucket in which the Amazon S3 object is stored.

", + "smithy.api#xmlName": "certificateS3BucketName" + } + }, + "CertificateS3ObjectKey": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CertificateS3ObjectKey", + "smithy.api#documentation": "

The key of the Amazon S3 object ey where the certificate, certificate chain, and encrypted private key bundle \n\t\t\tis stored. The object key is formated as follows: role_arn/certificate_arn.\n\t\t

", + "smithy.api#xmlName": "certificateS3ObjectKey" + } + }, + "EncryptionKmsKeyId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "EncryptionKmsKeyId", + "smithy.api#documentation": "

The ID of the KMS customer master key (CMK) used to encrypt the private key.

", + "smithy.api#xmlName": "encryptionKmsKeyId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the associated IAM roles.

" + } + }, + "com.amazonaws.ec2#AssociatedRolesList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AssociatedRole", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#AssociatedTargetNetwork": { + "type": "structure", + "members": { + "NetworkId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkId", + "smithy.api#documentation": "

The ID of the subnet.

", + "smithy.api#xmlName": "networkId" + } + }, + "NetworkType": { + "target": "com.amazonaws.ec2#AssociatedNetworkType", + "traits": { + "aws.protocols#ec2QueryName": "NetworkType", + "smithy.api#documentation": "

The target network type.

", + "smithy.api#xmlName": "networkType" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a target network that is associated with a Client VPN endpoint. A target network is a subnet in a VPC.

" + } + }, + "com.amazonaws.ec2#AssociatedTargetNetworkSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AssociatedTargetNetwork", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#AssociationIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IamInstanceProfileAssociationId", + "traits": { + "smithy.api#xmlName": "AssociationId" + } + } + }, + "com.amazonaws.ec2#AssociationStatus": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#AssociationStatusCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The state of the target network association.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

A message about the status of the target network association, if applicable.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the state of a target network association.

" + } + }, + "com.amazonaws.ec2#AssociationStatusCode": { + "type": "enum", + "members": { + "associating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associating" + } + }, + "associated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associated" + } + }, + "association_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "association-failed" + } + }, + "disassociating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociating" + } + }, + "disassociated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociated" + } + } + } + }, + "com.amazonaws.ec2#AthenaIntegration": { + "type": "structure", + "members": { + "IntegrationResultS3DestinationArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The location in Amazon S3 to store the generated CloudFormation template.

", + "smithy.api#required": {} + } + }, + "PartitionLoadFrequency": { + "target": "com.amazonaws.ec2#PartitionLoadFrequency", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The schedule for adding new partitions to the table.

", + "smithy.api#required": {} + } + }, + "PartitionStartDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "smithy.api#documentation": "

The start date for the partition.

" + } + }, + "PartitionEndDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "smithy.api#documentation": "

The end date for the partition.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes integration options for Amazon Athena.

" + } + }, + "com.amazonaws.ec2#AthenaIntegrationsSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AthenaIntegration", + "traits": { + "smithy.api#xmlName": "item" + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.ec2#AttachClassicLinkVpc": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AttachClassicLinkVpcRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AttachClassicLinkVpcResult" + }, + "traits": { + "smithy.api#documentation": "\n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n \n

Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's\n\t\t\tsecurity groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You\n\t\t\tcan only link an instance that's in the running state. An instance is\n\t\t\tautomatically unlinked from a VPC when it's stopped - you can link it to the VPC again when\n\t\t\tyou restart it.

\n

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.

\n

Linking your instance to a VPC is sometimes referred to as attaching your instance.

" + } + }, + "com.amazonaws.ec2#AttachClassicLinkVpcRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Groups": { + "target": "com.amazonaws.ec2#GroupIdStringList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "SecurityGroupId" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "instanceId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of a ClassicLink-enabled VPC.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "vpcId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AttachClassicLinkVpcResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AttachInternetGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AttachInternetGatewayRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and\n\t\t\tthe VPC. For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#AttachInternetGatewayRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "InternetGatewayId": { + "target": "com.amazonaws.ec2#InternetGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "InternetGatewayId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the internet gateway.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "internetGatewayId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "vpcId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AttachNetworkInterface": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AttachNetworkInterfaceRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AttachNetworkInterfaceResult" + }, + "traits": { + "smithy.api#documentation": "

Attaches a network interface to an instance.

" + } + }, + "com.amazonaws.ec2#AttachNetworkInterfaceRequest": { + "type": "structure", + "members": { + "DeviceIndex": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "DeviceIndex", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The index of the device for the network interface attachment.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "deviceIndex" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "instanceId" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "NetworkCardIndex": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The index of the network card. Some instance types support multiple network cards. \n The primary network interface must be assigned to network card index 0. \n The default is network card index 0.

" + } + }, + "EnaSrdSpecification": { + "target": "com.amazonaws.ec2#EnaSrdSpecification", + "traits": { + "smithy.api#documentation": "

Configures ENA Express for the network interface that this action attaches to the instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for AttachNetworkInterface.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AttachNetworkInterfaceResult": { + "type": "structure", + "members": { + "AttachmentId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AttachmentId", + "smithy.api#documentation": "

The ID of the network interface attachment.

", + "smithy.api#xmlName": "attachmentId" + } + }, + "NetworkCardIndex": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "NetworkCardIndex", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The index of the network card.

", + "smithy.api#xmlName": "networkCardIndex" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of AttachNetworkInterface.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AttachVerifiedAccessTrustProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AttachVerifiedAccessTrustProviderRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AttachVerifiedAccessTrustProviderResult" + }, + "traits": { + "smithy.api#documentation": "

Attaches the specified Amazon Web Services Verified Access trust provider to the specified Amazon Web Services Verified Access instance.

" + } + }, + "com.amazonaws.ec2#AttachVerifiedAccessTrustProviderRequest": { + "type": "structure", + "members": { + "VerifiedAccessInstanceId": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access instance.

", + "smithy.api#required": {} + } + }, + "VerifiedAccessTrustProviderId": { + "target": "com.amazonaws.ec2#VerifiedAccessTrustProviderId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access trust provider.

", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AttachVerifiedAccessTrustProviderResult": { + "type": "structure", + "members": { + "VerifiedAccessTrustProvider": { + "target": "com.amazonaws.ec2#VerifiedAccessTrustProvider", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessTrustProvider", + "smithy.api#documentation": "

The ID of the Verified Access trust provider.

", + "smithy.api#xmlName": "verifiedAccessTrustProvider" + } + }, + "VerifiedAccessInstance": { + "target": "com.amazonaws.ec2#VerifiedAccessInstance", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessInstance", + "smithy.api#documentation": "

The ID of the Verified Access instance.

", + "smithy.api#xmlName": "verifiedAccessInstance" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AttachVolume": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AttachVolumeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#VolumeAttachment" + }, + "traits": { + "smithy.api#documentation": "

Attaches an EBS volume to a running or stopped instance and exposes it to the instance\n with the specified device name.

\n

Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. For\n more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.

\n

After you attach an EBS volume, you must make it available. For more information, see \n Make an EBS volume available for use.

\n

If a volume has an Amazon Web Services Marketplace product code:

\n \n

For more information, see Attach an Amazon EBS volume to an instance in the\n Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#AttachVolumeRequest": { + "type": "structure", + "members": { + "Device": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The device name (for example, /dev/sdh or xvdh).

", + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {} + } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#VolumeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the EBS volume. The volume and instance must be within the same Availability\n Zone.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AttachVpnGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AttachVpnGatewayRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AttachVpnGatewayResult" + }, + "traits": { + "smithy.api#documentation": "

Attaches a virtual private gateway to a VPC. You can attach one virtual private\n gateway to one VPC at a time.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

" + } + }, + "com.amazonaws.ec2#AttachVpnGatewayRequest": { + "type": "structure", + "members": { + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {} + } + }, + "VpnGatewayId": { + "target": "com.amazonaws.ec2#VpnGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the virtual private gateway.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for AttachVpnGateway.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AttachVpnGatewayResult": { + "type": "structure", + "members": { + "VpcAttachment": { + "target": "com.amazonaws.ec2#VpcAttachment", + "traits": { + "aws.protocols#ec2QueryName": "Attachment", + "smithy.api#documentation": "

Information about the attachment.

", + "smithy.api#xmlName": "attachment" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of AttachVpnGateway.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AttachmentEnaSrdSpecification": { + "type": "structure", + "members": { + "EnaSrdEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnaSrdEnabled", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether ENA Express is enabled for the network interface that's attached to the\n\t\t\tinstance.

", + "smithy.api#xmlName": "enaSrdEnabled" + } + }, + "EnaSrdUdpSpecification": { + "target": "com.amazonaws.ec2#AttachmentEnaSrdUdpSpecification", + "traits": { + "aws.protocols#ec2QueryName": "EnaSrdUdpSpecification", + "smithy.api#documentation": "

ENA Express configuration for UDP network traffic.

", + "smithy.api#xmlName": "enaSrdUdpSpecification" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the ENA Express configuration for the network interface that's attached to the instance.

" + } + }, + "com.amazonaws.ec2#AttachmentEnaSrdUdpSpecification": { + "type": "structure", + "members": { + "EnaSrdUdpEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnaSrdUdpEnabled", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, \n\t\t\tyou must first enable ENA Express.

", + "smithy.api#xmlName": "enaSrdUdpEnabled" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the ENA Express configuration for UDP traffic on the network interface that's attached to \n\t\t\tthe instance.

" + } + }, + "com.amazonaws.ec2#AttachmentStatus": { + "type": "enum", + "members": { + "attaching": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "attaching" + } + }, + "attached": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "attached" + } + }, + "detaching": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "detaching" + } + }, + "detached": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "detached" + } + } + } + }, + "com.amazonaws.ec2#AttributeBooleanValue": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

The attribute value. The valid values are true or false.

", + "smithy.api#xmlName": "value" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a value for a resource attribute that is a Boolean value.

" + } + }, + "com.amazonaws.ec2#AttributeValue": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#documentation": "

The attribute value. The value is case-sensitive.

", + "smithy.api#xmlName": "value" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a value for a resource attribute that is a String.

" + } + }, + "com.amazonaws.ec2#AuthorizationRule": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientVpnEndpointId", + "smithy.api#documentation": "

The ID of the Client VPN endpoint with which the authorization rule is associated.

", + "smithy.api#xmlName": "clientVpnEndpointId" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A brief description of the authorization rule.

", + "smithy.api#xmlName": "description" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The ID of the Active Directory group to which the authorization rule grants access.

", + "smithy.api#xmlName": "groupId" + } + }, + "AccessAll": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AccessAll", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the authorization rule grants access to all clients.

", + "smithy.api#xmlName": "accessAll" + } + }, + "DestinationCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationCidr", + "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, of the network to which the authorization rule applies.

", + "smithy.api#xmlName": "destinationCidr" + } + }, + "Status": { + "target": "com.amazonaws.ec2#ClientVpnAuthorizationRuleStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The current state of the authorization rule.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an authorization rule.

" + } + }, + "com.amazonaws.ec2#AuthorizationRuleSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AuthorizationRule", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#AuthorizeClientVpnIngress": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AuthorizeClientVpnIngressRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AuthorizeClientVpnIngressResult" + }, + "traits": { + "smithy.api#documentation": "

Adds an ingress authorization rule to a Client VPN endpoint. Ingress authorization rules act as \n\t\t\tfirewall rules that grant access to networks. You must configure ingress authorization rules to \n\t\t\tenable clients to access resources in Amazon Web Services or on-premises networks.

" + } + }, + "com.amazonaws.ec2#AuthorizeClientVpnIngressRequest": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", + "smithy.api#required": {} + } + }, + "TargetNetworkCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, of the network for which access is being authorized.

", + "smithy.api#required": {} + } + }, + "AccessGroupId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group. Required if AuthorizeAllGroups is false or not specified.

" + } + }, + "AuthorizeAllGroups": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to grant access to all clients. Specify true to grant all\n clients who successfully establish a VPN connection access to the network. Must be set\n to true if AccessGroupId is not specified.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A brief description of the authorization rule.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AuthorizeClientVpnIngressResult": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.ec2#ClientVpnAuthorizationRuleStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The current state of the authorization rule.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AuthorizeSecurityGroupEgress": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AuthorizeSecurityGroupEgressRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AuthorizeSecurityGroupEgressResult" + }, + "traits": { + "smithy.api#documentation": "

[VPC only] Adds the specified outbound (egress) rules to a security group for use with a VPC.

\n

An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR\n address ranges, or to the instances that are associated with the specified source\n security groups. When specifying an outbound rule for your security group in a VPC, the\n IpPermissions must include a destination for the traffic.

\n

You specify a protocol for each rule (for example, TCP). \n For the TCP and UDP protocols, you must also specify the destination port or port range. \n For the ICMP protocol, you must also specify the ICMP type and code. \n You can use -1 for the type or code to mean all types or all codes.

\n

Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.

\n

For information about VPC security group quotas, see Amazon VPC quotas.

" + } + }, + "com.amazonaws.ec2#AuthorizeSecurityGroupEgressRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the security group.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "groupId" + } + }, + "IpPermissions": { + "target": "com.amazonaws.ec2#IpPermissionList", + "traits": { + "aws.protocols#ec2QueryName": "IpPermissions", + "smithy.api#documentation": "

The sets of IP permissions. You can't specify a destination security group and a CIDR IP\n address range in the same set of permissions.

", + "smithy.api#xmlName": "ipPermissions" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags applied to the security group rule.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "CidrIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrIp", + "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify the CIDR.

", + "smithy.api#xmlName": "cidrIp" + } + }, + "FromPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "FromPort", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify the port.

", + "smithy.api#xmlName": "fromPort" + } + }, + "IpProtocol": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpProtocol", + "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify the protocol name or\n number.

", + "smithy.api#xmlName": "ipProtocol" + } + }, + "ToPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "ToPort", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify the port.

", + "smithy.api#xmlName": "toPort" + } + }, + "SourceSecurityGroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SourceSecurityGroupName", + "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify a\n destination security group.

", + "smithy.api#xmlName": "sourceSecurityGroupName" + } + }, + "SourceSecurityGroupOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SourceSecurityGroupOwnerId", + "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify a\n destination security group.

", + "smithy.api#xmlName": "sourceSecurityGroupOwnerId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AuthorizeSecurityGroupEgressResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, returns an error.

", + "smithy.api#xmlName": "return" + } + }, + "SecurityGroupRules": { + "target": "com.amazonaws.ec2#SecurityGroupRuleList", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupRuleSet", + "smithy.api#documentation": "

Information about the outbound (egress) security group rules that were added.

", + "smithy.api#xmlName": "securityGroupRuleSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AuthorizeSecurityGroupIngress": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AuthorizeSecurityGroupIngressRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AuthorizeSecurityGroupIngressResult" + }, + "traits": { + "smithy.api#documentation": "

Adds the specified inbound (ingress) rules to a security group.

\n

An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR\n address range, or from the instances that are associated with the specified destination security \n groups. When specifying an inbound rule for your security group in a VPC, the\n IpPermissions must include a source for the traffic.

\n

You specify a protocol for each rule (for example, TCP). \n For TCP and UDP, you must also specify the destination port or port range. \n For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. \n You can use -1 to mean all types or all codes.

\n

Rule changes are propagated to instances within the security group as quickly as possible. \n However, a small delay might occur.

\n

For more information about VPC security group quotas, see Amazon VPC quotas.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " + } + }, + "com.amazonaws.ec2#AuthorizeSecurityGroupIngressRequest": { + "type": "structure", + "members": { + "CidrIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv4 address range, in CIDR format. You can't specify this parameter when specifying a source\n security group. To specify an IPv6 address range, use a set of IP permissions.

\n

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

" + } + }, + "FromPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

If the protocol is TCP or UDP, this is the start of the port range.\n If the protocol is ICMP, this is the type number. A value of -1 indicates all ICMP types. \n If you specify all ICMP types, you must specify all ICMP codes.

\n

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "smithy.api#documentation": "

The ID of the security group. You must specify either the security group ID or the\n\t\t\tsecurity group name in the request. For security groups in a nondefault VPC, you must\n\t\t\tspecify the security group ID.

" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#SecurityGroupName", + "traits": { + "smithy.api#documentation": "

[EC2-Classic, default VPC] The name of the security group. You must specify either the\n security group ID or the security group name in the request. For security groups in a\n nondefault VPC, you must specify the security group ID.

" + } + }, + "IpPermissions": { + "target": "com.amazonaws.ec2#IpPermissionList", + "traits": { + "smithy.api#documentation": "

The sets of IP permissions.

" + } + }, + "IpProtocol": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IP protocol name (tcp, udp, icmp) or number\n (see Protocol Numbers). To specify icmpv6, use a set of IP permissions.

\n

[VPC only] Use -1 to specify all protocols. If you specify -1 or a \n protocol other than tcp, udp, or icmp, traffic on all ports \n is allowed, regardless of any ports you specify.

\n

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

" + } + }, + "SourceSecurityGroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter \n in combination with the following parameters: the CIDR IP address range, the start of the port range, \n the IP protocol, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. \n To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. For \n EC2-VPC, the source security group must be in the same VPC.

" + } + }, + "SourceSecurityGroupOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

[nondefault VPC] The Amazon Web Services account ID for the source security group, if the source security group is \n in a different account. You can't specify this parameter in combination with the following parameters: \n the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. \n Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol \n and port range, use a set of IP permissions instead.

" + } + }, + "ToPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

If the protocol is TCP or UDP, this is the end of the port range.\n If the protocol is ICMP, this is the code. A value of -1 indicates all ICMP codes. \n If you specify all ICMP types, you must specify all ICMP codes.

\n

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

[VPC Only] The tags applied to the security group rule.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AuthorizeSecurityGroupIngressResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, returns an error.

", + "smithy.api#xmlName": "return" + } + }, + "SecurityGroupRules": { + "target": "com.amazonaws.ec2#SecurityGroupRuleList", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupRuleSet", + "smithy.api#documentation": "

Information about the inbound (ingress) security group rules that were added.

", + "smithy.api#xmlName": "securityGroupRuleSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#AutoAcceptSharedAssociationsValue": { + "type": "enum", + "members": { + "enable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enable" + } + }, + "disable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disable" + } + } + } + }, + "com.amazonaws.ec2#AutoAcceptSharedAttachmentsValue": { + "type": "enum", + "members": { + "enable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enable" + } + }, + "disable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disable" + } + } + } + }, + "com.amazonaws.ec2#AutoPlacement": { + "type": "enum", + "members": { + "on": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "on" + } + }, + "off": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "off" + } + } + } + }, + "com.amazonaws.ec2#AutoRecoveryFlag": { + "type": "boolean" + }, + "com.amazonaws.ec2#AvailabilityZone": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.ec2#AvailabilityZoneState", + "traits": { + "aws.protocols#ec2QueryName": "ZoneState", + "smithy.api#documentation": "

The state of the Availability Zone, Local Zone, or Wavelength Zone. This value is always\n available.

", + "smithy.api#xmlName": "zoneState" + } + }, + "OptInStatus": { + "target": "com.amazonaws.ec2#AvailabilityZoneOptInStatus", + "traits": { + "aws.protocols#ec2QueryName": "OptInStatus", + "smithy.api#documentation": "

For Availability Zones, this parameter always has the value of\n opt-in-not-required.

\n

For Local Zones and Wavelength Zones, this parameter is the opt-in status. The possible\n values are opted-in, and not-opted-in.

", + "smithy.api#xmlName": "optInStatus" + } + }, + "Messages": { + "target": "com.amazonaws.ec2#AvailabilityZoneMessageList", + "traits": { + "aws.protocols#ec2QueryName": "MessageSet", + "smithy.api#documentation": "

Any messages about the Availability Zone, Local Zone, or Wavelength Zone.

", + "smithy.api#xmlName": "messageSet" + } + }, + "RegionName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RegionName", + "smithy.api#documentation": "

The name of the Region.

", + "smithy.api#xmlName": "regionName" + } + }, + "ZoneName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ZoneName", + "smithy.api#documentation": "

The name of the Availability Zone, Local Zone, or Wavelength Zone.

", + "smithy.api#xmlName": "zoneName" + } + }, + "ZoneId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ZoneId", + "smithy.api#documentation": "

The ID of the Availability Zone, Local Zone, or Wavelength Zone.

", + "smithy.api#xmlName": "zoneId" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

For Availability Zones, this parameter has the same value as the Region name.

\n

For Local Zones, the name of the associated group, for example\n us-west-2-lax-1.

\n

For Wavelength Zones, the name of the associated group, for example\n us-east-1-wl1-bos-wlz-1.

", + "smithy.api#xmlName": "groupName" + } + }, + "NetworkBorderGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkBorderGroup", + "smithy.api#documentation": "

The name of the network border group.

", + "smithy.api#xmlName": "networkBorderGroup" + } + }, + "ZoneType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ZoneType", + "smithy.api#documentation": "

The type of zone. The valid values are availability-zone,\n local-zone, and wavelength-zone.

", + "smithy.api#xmlName": "zoneType" + } + }, + "ParentZoneName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ParentZoneName", + "smithy.api#documentation": "

The name of the zone that handles some of the Local Zone or Wavelength Zone control plane\n operations, such as API calls.

", + "smithy.api#xmlName": "parentZoneName" + } + }, + "ParentZoneId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ParentZoneId", + "smithy.api#documentation": "

The ID of the zone that handles some of the Local Zone or Wavelength Zone control plane\n operations, such as API calls.

", + "smithy.api#xmlName": "parentZoneId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes Availability Zones, Local Zones, and Wavelength Zones.

" + } + }, + "com.amazonaws.ec2#AvailabilityZoneList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AvailabilityZone", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#AvailabilityZoneMessage": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The message about the Availability Zone, Local Zone, or Wavelength Zone.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a message about an Availability Zone, Local Zone, or Wavelength Zone.

" + } + }, + "com.amazonaws.ec2#AvailabilityZoneMessageList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AvailabilityZoneMessage", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#AvailabilityZoneName": { + "type": "string" + }, + "com.amazonaws.ec2#AvailabilityZoneOptInStatus": { + "type": "enum", + "members": { + "opt_in_not_required": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "opt-in-not-required" + } + }, + "opted_in": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "opted-in" + } + }, + "not_opted_in": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "not-opted-in" + } + } + } + }, + "com.amazonaws.ec2#AvailabilityZoneState": { + "type": "enum", + "members": { + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "information": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "information" + } + }, + "impaired": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "impaired" + } + }, + "unavailable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unavailable" + } + } + } + }, + "com.amazonaws.ec2#AvailabilityZoneStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "AvailabilityZone" + } + } + }, + "com.amazonaws.ec2#AvailableCapacity": { + "type": "structure", + "members": { + "AvailableInstanceCapacity": { + "target": "com.amazonaws.ec2#AvailableInstanceCapacityList", + "traits": { + "aws.protocols#ec2QueryName": "AvailableInstanceCapacity", + "smithy.api#documentation": "

The number of instances that can be launched onto the Dedicated Host depending on the\n host's available capacity. For Dedicated Hosts that support multiple instance types,\n this parameter represents the number of instances for each instance size that is\n supported on the host.

", + "smithy.api#xmlName": "availableInstanceCapacity" + } + }, + "AvailableVCpus": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "AvailableVCpus", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of vCPUs available for launching instances onto the Dedicated Host.

", + "smithy.api#xmlName": "availableVCpus" + } + } + }, + "traits": { + "smithy.api#documentation": "

The capacity information for instances that can be launched onto the Dedicated Host.\n

" + } + }, + "com.amazonaws.ec2#AvailableInstanceCapacityList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceCapacity", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#BareMetal": { + "type": "enum", + "members": { + "INCLUDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "included" + } + }, + "REQUIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "required" + } + }, + "EXCLUDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "excluded" + } + } + } + }, + "com.amazonaws.ec2#BareMetalFlag": { + "type": "boolean" + }, + "com.amazonaws.ec2#BaselineBandwidthInMbps": { + "type": "integer" + }, + "com.amazonaws.ec2#BaselineEbsBandwidthMbps": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Min", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum baseline bandwidth, in Mbps. If this parameter is not specified, there is no\n minimum limit.

", + "smithy.api#xmlName": "min" + } + }, + "Max": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Max", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum baseline bandwidth, in Mbps. If this parameter is not specified, there is no\n maximum limit.

", + "smithy.api#xmlName": "max" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see\n Amazon\n EBS–optimized instances in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#BaselineEbsBandwidthMbpsRequest": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit\n this parameter.

" + } + }, + "Max": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit\n this parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see\n Amazon\n EBS–optimized instances in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#BaselineIops": { + "type": "integer" + }, + "com.amazonaws.ec2#BaselineThroughputInMBps": { + "type": "double" + }, + "com.amazonaws.ec2#BatchState": { + "type": "enum", + "members": { + "SUBMITTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "submitted" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelled" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "CANCELLED_RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelled_running" + } + }, + "CANCELLED_TERMINATING_INSTANCES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelled_terminating" + } + }, + "MODIFYING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modifying" + } + } + } + }, + "com.amazonaws.ec2#BgpStatus": { + "type": "enum", + "members": { + "up": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "up" + } + }, + "down": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "down" + } + } + } + }, + "com.amazonaws.ec2#BillingProductList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Blob": { + "type": "blob" + }, + "com.amazonaws.ec2#BlobAttributeValue": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.ec2#Blob", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#xmlName": "value" + } + } + } + }, + "com.amazonaws.ec2#BlockDeviceMapping": { + "type": "structure", + "members": { + "DeviceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DeviceName", + "smithy.api#documentation": "

The device name (for example, /dev/sdh or xvdh).

", + "smithy.api#xmlName": "deviceName" + } + }, + "VirtualName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VirtualName", + "smithy.api#documentation": "

The virtual device name (ephemeralN). Instance store volumes are numbered\n starting from 0. An instance type with 2 available instance store volumes can specify\n mappings for ephemeral0 and ephemeral1. The number of\n available instance store volumes depends on the instance type. After you connect to the\n instance, you must mount the volume.

\n

NVMe instance store volumes are automatically enumerated and assigned a device name.\n Including them in your block device mapping has no effect.

\n

Constraints: For M3 instances, you must specify instance store volumes in the block\n device mapping for the instance. When you launch an M3 instance, we ignore any instance\n store volumes specified in the block device mapping for the AMI.

", + "smithy.api#xmlName": "virtualName" + } + }, + "Ebs": { + "target": "com.amazonaws.ec2#EbsBlockDevice", + "traits": { + "aws.protocols#ec2QueryName": "Ebs", + "smithy.api#documentation": "

Parameters used to automatically set up EBS volumes when the instance is\n launched.

", + "smithy.api#xmlName": "ebs" + } + }, + "NoDevice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NoDevice", + "smithy.api#documentation": "

To omit the device from the block device mapping, specify an empty string. When this\n property is specified, the device is removed from the block device mapping regardless of\n the assigned value.

", + "smithy.api#xmlName": "noDevice" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a block device mapping, which defines the EBS volumes and instance store\n volumes to attach to an instance at launch.

" + } + }, + "com.amazonaws.ec2#BlockDeviceMappingList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#BlockDeviceMapping", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#BlockDeviceMappingRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#BlockDeviceMapping", + "traits": { + "smithy.api#xmlName": "BlockDeviceMapping" + } + } + }, + "com.amazonaws.ec2#Boolean": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.ec2#BootModeType": { + "type": "enum", + "members": { + "legacy_bios": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "legacy-bios" + } + }, + "uefi": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "uefi" + } + } + } + }, + "com.amazonaws.ec2#BootModeTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#BootModeType", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#BootModeValues": { + "type": "enum", + "members": { + "legacy_bios": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "legacy-bios" + } + }, + "uefi": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "uefi" + } + }, + "uefi_preferred": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "uefi-preferred" + } + } + } + }, + "com.amazonaws.ec2#BoxedDouble": { + "type": "double" + }, + "com.amazonaws.ec2#BundleId": { + "type": "string" + }, + "com.amazonaws.ec2#BundleIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#BundleId", + "traits": { + "smithy.api#xmlName": "BundleId" + } + } + }, + "com.amazonaws.ec2#BundleInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#BundleInstanceRequest" + }, + "output": { + "target": "com.amazonaws.ec2#BundleInstanceResult" + }, + "traits": { + "smithy.api#documentation": "

Bundles an Amazon instance store-backed Windows instance.

\n

During bundling, only the root device volume (C:\\) is bundled. Data on other instance store volumes is not preserved.

\n \n

This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.

\n " + } + }, + "com.amazonaws.ec2#BundleInstanceRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance to bundle.

\n

Type: String

\n

Default: None

\n

Required: Yes

", + "smithy.api#required": {} + } + }, + "Storage": { + "target": "com.amazonaws.ec2#Storage", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#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.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for BundleInstance.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#BundleInstanceResult": { + "type": "structure", + "members": { + "BundleTask": { + "target": "com.amazonaws.ec2#BundleTask", + "traits": { + "aws.protocols#ec2QueryName": "BundleInstanceTask", + "smithy.api#documentation": "

Information about the bundle task.

", + "smithy.api#xmlName": "bundleInstanceTask" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of BundleInstance.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#BundleTask": { + "type": "structure", + "members": { + "BundleId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "BundleId", + "smithy.api#documentation": "

The ID of the bundle task.

", + "smithy.api#xmlName": "bundleId" + } + }, + "BundleTaskError": { + "target": "com.amazonaws.ec2#BundleTaskError", + "traits": { + "aws.protocols#ec2QueryName": "Error", + "smithy.api#documentation": "

If the task fails, a description of the error.

", + "smithy.api#xmlName": "error" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance associated with this bundle task.

", + "smithy.api#xmlName": "instanceId" + } + }, + "Progress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Progress", + "smithy.api#documentation": "

The level of task completion, as a percent (for example, 20%).

", + "smithy.api#xmlName": "progress" + } + }, + "StartTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "StartTime", + "smithy.api#documentation": "

The time this task started.

", + "smithy.api#xmlName": "startTime" + } + }, + "State": { + "target": "com.amazonaws.ec2#BundleTaskState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the task.

", + "smithy.api#xmlName": "state" + } + }, + "Storage": { + "target": "com.amazonaws.ec2#Storage", + "traits": { + "aws.protocols#ec2QueryName": "Storage", + "smithy.api#documentation": "

The Amazon S3 storage locations.

", + "smithy.api#xmlName": "storage" + } + }, + "UpdateTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "UpdateTime", + "smithy.api#documentation": "

The time of the most recent update for the task.

", + "smithy.api#xmlName": "updateTime" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a bundle task.

" + } + }, + "com.amazonaws.ec2#BundleTaskError": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The error code.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The error message.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an error for BundleInstance.

" + } + }, + "com.amazonaws.ec2#BundleTaskList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#BundleTask", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#BundleTaskState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "waiting_for_shutdown": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "waiting-for-shutdown" + } + }, + "bundling": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "bundling" + } + }, + "storing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "storing" + } + }, + "cancelling": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelling" + } + }, + "complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "complete" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + } + } + }, + "com.amazonaws.ec2#BurstablePerformance": { + "type": "enum", + "members": { + "INCLUDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "included" + } + }, + "REQUIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "required" + } + }, + "EXCLUDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "excluded" + } + } + } + }, + "com.amazonaws.ec2#BurstablePerformanceFlag": { + "type": "boolean" + }, + "com.amazonaws.ec2#ByoipCidr": { + "type": "structure", + "members": { + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Cidr", + "smithy.api#documentation": "

The address range, in CIDR notation.

", + "smithy.api#xmlName": "cidr" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of the address range.

", + "smithy.api#xmlName": "description" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

Upon success, contains the ID of the address pool. Otherwise, contains an error message.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "State": { + "target": "com.amazonaws.ec2#ByoipCidrState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the address pool.

", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an address range that is provisioned for use with your Amazon Web Services resources \n through bring your own IP addresses (BYOIP).

" + } + }, + "com.amazonaws.ec2#ByoipCidrSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ByoipCidr", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ByoipCidrState": { + "type": "enum", + "members": { + "advertised": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "advertised" + } + }, + "deprovisioned": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deprovisioned" + } + }, + "failed_deprovision": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed-deprovision" + } + }, + "failed_provision": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed-provision" + } + }, + "pending_deprovision": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending-deprovision" + } + }, + "pending_provision": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending-provision" + } + }, + "provisioned": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "provisioned" + } + }, + "provisioned_not_publicly_advertisable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "provisioned-not-publicly-advertisable" + } + } + } + }, + "com.amazonaws.ec2#CancelBatchErrorCode": { + "type": "enum", + "members": { + "FLEET_REQUEST_ID_DOES_NOT_EXIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fleetRequestIdDoesNotExist" + } + }, + "FLEET_REQUEST_ID_MALFORMED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fleetRequestIdMalformed" + } + }, + "FLEET_REQUEST_NOT_IN_CANCELLABLE_STATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fleetRequestNotInCancellableState" + } + }, + "UNEXPECTED_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unexpectedError" + } + } + } + }, + "com.amazonaws.ec2#CancelBundleTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CancelBundleTaskRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CancelBundleTaskResult" + }, + "traits": { + "smithy.api#documentation": "

Cancels a bundling operation for an instance store-backed Windows instance.

" + } + }, + "com.amazonaws.ec2#CancelBundleTaskRequest": { + "type": "structure", + "members": { + "BundleId": { + "target": "com.amazonaws.ec2#BundleId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the bundle task.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for CancelBundleTask.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CancelBundleTaskResult": { + "type": "structure", + "members": { + "BundleTask": { + "target": "com.amazonaws.ec2#BundleTask", + "traits": { + "aws.protocols#ec2QueryName": "BundleInstanceTask", + "smithy.api#documentation": "

Information about the bundle task.

", + "smithy.api#xmlName": "bundleInstanceTask" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of CancelBundleTask.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CancelCapacityReservation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CancelCapacityReservationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CancelCapacityReservationResult" + }, + "traits": { + "smithy.api#documentation": "

Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation's state to\n\t\t\tcancelled.

\n

Instances running in the reserved capacity continue running until you stop them. Stopped\n\t\t\tinstances that target the Capacity Reservation can no longer launch. Modify these instances to either\n\t\t\ttarget a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation\n\t\t\tthat has matching attributes and sufficient capacity.

" + } + }, + "com.amazonaws.ec2#CancelCapacityReservationFleetError": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#CancelCapacityReservationFleetErrorCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The error code.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#CancelCapacityReservationFleetErrorMessage", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The error message.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Capacity Reservation Fleet cancellation error.

" + } + }, + "com.amazonaws.ec2#CancelCapacityReservationFleetErrorCode": { + "type": "string" + }, + "com.amazonaws.ec2#CancelCapacityReservationFleetErrorMessage": { + "type": "string" + }, + "com.amazonaws.ec2#CancelCapacityReservationFleets": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CancelCapacityReservationFleetsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CancelCapacityReservationFleetsResult" + }, + "traits": { + "smithy.api#documentation": "

Cancels one or more Capacity Reservation Fleets. When you cancel a Capacity Reservation \n\t\t\tFleet, the following happens:

\n " + } + }, + "com.amazonaws.ec2#CancelCapacityReservationFleetsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "CapacityReservationFleetIds": { + "target": "com.amazonaws.ec2#CapacityReservationFleetIdSet", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the Capacity Reservation Fleets to cancel.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "CapacityReservationFleetId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CancelCapacityReservationFleetsResult": { + "type": "structure", + "members": { + "SuccessfulFleetCancellations": { + "target": "com.amazonaws.ec2#CapacityReservationFleetCancellationStateSet", + "traits": { + "aws.protocols#ec2QueryName": "SuccessfulFleetCancellationSet", + "smithy.api#documentation": "

Information about the Capacity Reservation Fleets that were successfully cancelled.

", + "smithy.api#xmlName": "successfulFleetCancellationSet" + } + }, + "FailedFleetCancellations": { + "target": "com.amazonaws.ec2#FailedCapacityReservationFleetCancellationResultSet", + "traits": { + "aws.protocols#ec2QueryName": "FailedFleetCancellationSet", + "smithy.api#documentation": "

Information about the Capacity Reservation Fleets that could not be cancelled.

", + "smithy.api#xmlName": "failedFleetCancellationSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CancelCapacityReservationRequest": { + "type": "structure", + "members": { + "CapacityReservationId": { + "target": "com.amazonaws.ec2#CapacityReservationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Capacity Reservation to be cancelled.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CancelCapacityReservationResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CancelConversionRequest": { + "type": "structure", + "members": { + "ConversionTaskId": { + "target": "com.amazonaws.ec2#ConversionTaskId", + "traits": { + "aws.protocols#ec2QueryName": "ConversionTaskId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the conversion task.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "conversionTaskId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "ReasonMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ReasonMessage", + "smithy.api#documentation": "

The reason for canceling the conversion task.

", + "smithy.api#xmlName": "reasonMessage" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CancelConversionTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CancelConversionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all\n artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is\n in the process of transferring the final disk image, the command fails and returns an exception.

\n

For more information, see Importing a Virtual Machine Using the Amazon\n EC2 CLI.

" + } + }, + "com.amazonaws.ec2#CancelExportTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CancelExportTaskRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Cancels an active export task. The request removes all artifacts of the export, including any partially-created\n Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the\n command fails and returns an error.

" + } + }, + "com.amazonaws.ec2#CancelExportTaskRequest": { + "type": "structure", + "members": { + "ExportTaskId": { + "target": "com.amazonaws.ec2#ExportVmTaskId", + "traits": { + "aws.protocols#ec2QueryName": "ExportTaskId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the export task. This is the ID returned by CreateInstanceExportTask.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "exportTaskId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CancelImageLaunchPermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CancelImageLaunchPermissionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CancelImageLaunchPermissionResult" + }, + "traits": { + "smithy.api#documentation": "

Removes your Amazon Web Services account from the launch permissions for the specified AMI. For more\n information, see \n Cancel having an AMI shared with your Amazon Web Services account in the \n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#CancelImageLaunchPermissionRequest": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the AMI that was shared with your Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CancelImageLaunchPermissionResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CancelImportTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CancelImportTaskRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CancelImportTaskResult" + }, + "traits": { + "smithy.api#documentation": "

Cancels an in-process import virtual machine or import snapshot task.

" + } + }, + "com.amazonaws.ec2#CancelImportTaskRequest": { + "type": "structure", + "members": { + "CancelReason": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The reason for canceling the task.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ImportTaskId": { + "target": "com.amazonaws.ec2#ImportTaskId", + "traits": { + "smithy.api#documentation": "

The ID of the import image or import snapshot task to be canceled.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CancelImportTaskResult": { + "type": "structure", + "members": { + "ImportTaskId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImportTaskId", + "smithy.api#documentation": "

The ID of the task being canceled.

", + "smithy.api#xmlName": "importTaskId" + } + }, + "PreviousState": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PreviousState", + "smithy.api#documentation": "

The current state of the task being canceled.

", + "smithy.api#xmlName": "previousState" + } + }, + "State": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the task being canceled.

", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CancelReservedInstancesListing": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CancelReservedInstancesListingRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CancelReservedInstancesListingResult" + }, + "traits": { + "smithy.api#documentation": "

Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.

\n

For more information, see \n Reserved Instance Marketplace \n in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#CancelReservedInstancesListingRequest": { + "type": "structure", + "members": { + "ReservedInstancesListingId": { + "target": "com.amazonaws.ec2#ReservedInstancesListingId", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesListingId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Reserved Instance listing.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "reservedInstancesListingId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for CancelReservedInstancesListing.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CancelReservedInstancesListingResult": { + "type": "structure", + "members": { + "ReservedInstancesListings": { + "target": "com.amazonaws.ec2#ReservedInstancesListingList", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesListingsSet", + "smithy.api#documentation": "

The Reserved Instance listing.

", + "smithy.api#xmlName": "reservedInstancesListingsSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of CancelReservedInstancesListing.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CancelSpotFleetRequests": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CancelSpotFleetRequestsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CancelSpotFleetRequestsResponse" + }, + "traits": { + "smithy.api#documentation": "

Cancels the specified Spot Fleet requests.

\n

After you cancel a Spot Fleet request, the Spot Fleet launches no new instances.

\n

You must also specify whether a canceled Spot Fleet request should terminate its instances. If you\n choose to terminate the instances, the Spot Fleet request enters the\n cancelled_terminating state. Otherwise, the Spot Fleet request enters\n the cancelled_running state and the instances continue to run until they\n are interrupted or you terminate them manually.

" + } + }, + "com.amazonaws.ec2#CancelSpotFleetRequestsError": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#CancelBatchErrorCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The error code.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The description for the error code.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Spot Fleet error.

" + } + }, + "com.amazonaws.ec2#CancelSpotFleetRequestsErrorItem": { + "type": "structure", + "members": { + "Error": { + "target": "com.amazonaws.ec2#CancelSpotFleetRequestsError", + "traits": { + "aws.protocols#ec2QueryName": "Error", + "smithy.api#documentation": "

The error.

", + "smithy.api#xmlName": "error" + } + }, + "SpotFleetRequestId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpotFleetRequestId", + "smithy.api#documentation": "

The ID of the Spot Fleet request.

", + "smithy.api#xmlName": "spotFleetRequestId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Spot Fleet request that was not successfully canceled.

" + } + }, + "com.amazonaws.ec2#CancelSpotFleetRequestsErrorSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CancelSpotFleetRequestsErrorItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CancelSpotFleetRequestsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "SpotFleetRequestIds": { + "target": "com.amazonaws.ec2#SpotFleetRequestIdList", + "traits": { + "aws.protocols#ec2QueryName": "SpotFleetRequestId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the Spot Fleet requests.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "spotFleetRequestId" + } + }, + "TerminateInstances": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "TerminateInstances", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to terminate the associated instances when the Spot Fleet request is canceled. \n The default is to terminate the instances.

\n

To let the instances continue to run after the Spot Fleet request is canceled, specify\n no-terminate-instances.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "terminateInstances" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for CancelSpotFleetRequests.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CancelSpotFleetRequestsResponse": { + "type": "structure", + "members": { + "SuccessfulFleetRequests": { + "target": "com.amazonaws.ec2#CancelSpotFleetRequestsSuccessSet", + "traits": { + "aws.protocols#ec2QueryName": "SuccessfulFleetRequestSet", + "smithy.api#documentation": "

Information about the Spot Fleet requests that are successfully canceled.

", + "smithy.api#xmlName": "successfulFleetRequestSet" + } + }, + "UnsuccessfulFleetRequests": { + "target": "com.amazonaws.ec2#CancelSpotFleetRequestsErrorSet", + "traits": { + "aws.protocols#ec2QueryName": "UnsuccessfulFleetRequestSet", + "smithy.api#documentation": "

Information about the Spot Fleet requests that are not successfully canceled.

", + "smithy.api#xmlName": "unsuccessfulFleetRequestSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of CancelSpotFleetRequests.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CancelSpotFleetRequestsSuccessItem": { + "type": "structure", + "members": { + "CurrentSpotFleetRequestState": { + "target": "com.amazonaws.ec2#BatchState", + "traits": { + "aws.protocols#ec2QueryName": "CurrentSpotFleetRequestState", + "smithy.api#documentation": "

The current state of the Spot Fleet request.

", + "smithy.api#xmlName": "currentSpotFleetRequestState" + } + }, + "PreviousSpotFleetRequestState": { + "target": "com.amazonaws.ec2#BatchState", + "traits": { + "aws.protocols#ec2QueryName": "PreviousSpotFleetRequestState", + "smithy.api#documentation": "

The previous state of the Spot Fleet request.

", + "smithy.api#xmlName": "previousSpotFleetRequestState" + } + }, + "SpotFleetRequestId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpotFleetRequestId", + "smithy.api#documentation": "

The ID of the Spot Fleet request.

", + "smithy.api#xmlName": "spotFleetRequestId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Spot Fleet request that was successfully canceled.

" + } + }, + "com.amazonaws.ec2#CancelSpotFleetRequestsSuccessSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CancelSpotFleetRequestsSuccessItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CancelSpotInstanceRequestState": { + "type": "enum", + "members": { + "active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "open": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "open" + } + }, + "closed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "closed" + } + }, + "cancelled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelled" + } + }, + "completed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "completed" + } + } + } + }, + "com.amazonaws.ec2#CancelSpotInstanceRequests": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CancelSpotInstanceRequestsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CancelSpotInstanceRequestsResult" + }, + "traits": { + "smithy.api#documentation": "

Cancels one or more Spot Instance requests.

\n \n

Canceling a Spot Instance request does not terminate running Spot Instances\n associated with the request.

\n " + } + }, + "com.amazonaws.ec2#CancelSpotInstanceRequestsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "SpotInstanceRequestIds": { + "target": "com.amazonaws.ec2#SpotInstanceRequestIdList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the Spot Instance requests.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "SpotInstanceRequestId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for CancelSpotInstanceRequests.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CancelSpotInstanceRequestsResult": { + "type": "structure", + "members": { + "CancelledSpotInstanceRequests": { + "target": "com.amazonaws.ec2#CancelledSpotInstanceRequestList", + "traits": { + "aws.protocols#ec2QueryName": "SpotInstanceRequestSet", + "smithy.api#documentation": "

The Spot Instance requests.

", + "smithy.api#xmlName": "spotInstanceRequestSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of CancelSpotInstanceRequests.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CancelledSpotInstanceRequest": { + "type": "structure", + "members": { + "SpotInstanceRequestId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpotInstanceRequestId", + "smithy.api#documentation": "

The ID of the Spot Instance request.

", + "smithy.api#xmlName": "spotInstanceRequestId" + } + }, + "State": { + "target": "com.amazonaws.ec2#CancelSpotInstanceRequestState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the Spot Instance request.

", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a request to cancel a Spot Instance.

" + } + }, + "com.amazonaws.ec2#CancelledSpotInstanceRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CancelledSpotInstanceRequest", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CapacityAllocation": { + "type": "structure", + "members": { + "AllocationType": { + "target": "com.amazonaws.ec2#AllocationType", + "traits": { + "aws.protocols#ec2QueryName": "AllocationType", + "smithy.api#documentation": "

The usage type. used indicates that the instance capacity is \n\t\t\tin use by instances that are running in the Capacity Reservation.

", + "smithy.api#xmlName": "allocationType" + } + }, + "Count": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Count", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount of instance capacity associated with the usage. For example a value of \n\t\t\t4 indicates that instance capacity for 4 instances is currently in use.

", + "smithy.api#xmlName": "count" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about instance capacity usage for a Capacity Reservation.

" + } + }, + "com.amazonaws.ec2#CapacityAllocations": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CapacityAllocation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CapacityReservation": { + "type": "structure", + "members": { + "CapacityReservationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationId", + "smithy.api#documentation": "

The ID of the Capacity Reservation.

", + "smithy.api#xmlName": "capacityReservationId" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the Capacity Reservation.

", + "smithy.api#xmlName": "ownerId" + } + }, + "CapacityReservationArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Capacity Reservation.

", + "smithy.api#xmlName": "capacityReservationArn" + } + }, + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneId", + "smithy.api#documentation": "

The Availability Zone ID of the Capacity Reservation.

", + "smithy.api#xmlName": "availabilityZoneId" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The type of instance for which the Capacity Reservation reserves capacity.

", + "smithy.api#xmlName": "instanceType" + } + }, + "InstancePlatform": { + "target": "com.amazonaws.ec2#CapacityReservationInstancePlatform", + "traits": { + "aws.protocols#ec2QueryName": "InstancePlatform", + "smithy.api#documentation": "

The type of operating system for which the Capacity Reservation reserves capacity.

", + "smithy.api#xmlName": "instancePlatform" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone in which the capacity is reserved.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "Tenancy": { + "target": "com.amazonaws.ec2#CapacityReservationTenancy", + "traits": { + "aws.protocols#ec2QueryName": "Tenancy", + "smithy.api#documentation": "

Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

\n ", + "smithy.api#xmlName": "tenancy" + } + }, + "TotalInstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TotalInstanceCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of instances for which the Capacity Reservation reserves capacity.

", + "smithy.api#xmlName": "totalInstanceCount" + } + }, + "AvailableInstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "AvailableInstanceCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.

", + "smithy.api#xmlName": "availableInstanceCount" + } + }, + "EbsOptimized": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EbsOptimized", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides\n\t\t\tdedicated throughput to Amazon EBS and an optimized configuration stack to provide\n\t\t\toptimal I/O performance. This optimization isn't available with all instance types.\n\t\t\tAdditional usage charges apply when using an EBS- optimized instance.

", + "smithy.api#xmlName": "ebsOptimized" + } + }, + "EphemeralStorage": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EphemeralStorage", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

\n Deprecated.\n

", + "smithy.api#xmlName": "ephemeralStorage" + } + }, + "State": { + "target": "com.amazonaws.ec2#CapacityReservationState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

\n ", + "smithy.api#xmlName": "state" + } + }, + "StartDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "StartDate", + "smithy.api#documentation": "

The date and time at which the Capacity Reservation was started.

", + "smithy.api#xmlName": "startDate" + } + }, + "EndDate": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "EndDate", + "smithy.api#documentation": "

The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity\n\t\t\tis released and you can no longer launch instances into it. The Capacity Reservation's state changes to\n\t\t\t\texpired when it reaches its end date and time.

", + "smithy.api#xmlName": "endDate" + } + }, + "EndDateType": { + "target": "com.amazonaws.ec2#EndDateType", + "traits": { + "aws.protocols#ec2QueryName": "EndDateType", + "smithy.api#documentation": "

Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end\n\t\t\ttypes:

\n ", + "smithy.api#xmlName": "endDateType" + } + }, + "InstanceMatchCriteria": { + "target": "com.amazonaws.ec2#InstanceMatchCriteria", + "traits": { + "aws.protocols#ec2QueryName": "InstanceMatchCriteria", + "smithy.api#documentation": "

Indicates the type of instance launches that the Capacity Reservation accepts. The options\n\t\t\tinclude:

\n ", + "smithy.api#xmlName": "instanceMatchCriteria" + } + }, + "CreateDate": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreateDate", + "smithy.api#documentation": "

The date and time at which the Capacity Reservation was created.

", + "smithy.api#xmlName": "createDate" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the Capacity Reservation.

", + "smithy.api#xmlName": "tagSet" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#OutpostArn", + "traits": { + "aws.protocols#ec2QueryName": "OutpostArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost on which the Capacity \n\t \t\tReservation was created.

", + "smithy.api#xmlName": "outpostArn" + } + }, + "CapacityReservationFleetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationFleetId", + "smithy.api#documentation": "

The ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs. \n\t\t\tOnly valid for Capacity Reservations that were created by a Capacity Reservation Fleet.

", + "smithy.api#xmlName": "capacityReservationFleetId" + } + }, + "PlacementGroupArn": { + "target": "com.amazonaws.ec2#PlacementGroupArn", + "traits": { + "aws.protocols#ec2QueryName": "PlacementGroupArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster placement group in which \n\t\t\tthe Capacity Reservation was created. For more information, see \n\t\t\t\n\t\t\t\tCapacity Reservations for cluster placement groups in the \n\t\t\tAmazon EC2 User Guide.

", + "smithy.api#xmlName": "placementGroupArn" + } + }, + "CapacityAllocations": { + "target": "com.amazonaws.ec2#CapacityAllocations", + "traits": { + "aws.protocols#ec2QueryName": "CapacityAllocationSet", + "smithy.api#documentation": "

Information about instance capacity usage.

", + "smithy.api#xmlName": "capacityAllocationSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Capacity Reservation.

" + } + }, + "com.amazonaws.ec2#CapacityReservationFleet": { + "type": "structure", + "members": { + "CapacityReservationFleetId": { + "target": "com.amazonaws.ec2#CapacityReservationFleetId", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationFleetId", + "smithy.api#documentation": "

The ID of the Capacity Reservation Fleet.

", + "smithy.api#xmlName": "capacityReservationFleetId" + } + }, + "CapacityReservationFleetArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationFleetArn", + "smithy.api#documentation": "

The ARN of the Capacity Reservation Fleet.

", + "smithy.api#xmlName": "capacityReservationFleetArn" + } + }, + "State": { + "target": "com.amazonaws.ec2#CapacityReservationFleetState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the Capacity Reservation Fleet. Possible states include:

\n ", + "smithy.api#xmlName": "state" + } + }, + "TotalTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TotalTargetCapacity", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of capacity units for which the Capacity Reservation Fleet reserves capacity. \n\t\t\tFor more information, see Total target capacity \n\t\t\tin the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "totalTargetCapacity" + } + }, + "TotalFulfilledCapacity": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "TotalFulfilledCapacity", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The capacity units that have been fulfilled.

", + "smithy.api#xmlName": "totalFulfilledCapacity" + } + }, + "Tenancy": { + "target": "com.amazonaws.ec2#FleetCapacityReservationTenancy", + "traits": { + "aws.protocols#ec2QueryName": "Tenancy", + "smithy.api#documentation": "

The tenancy of the Capacity Reservation Fleet. Tenancies include:

\n ", + "smithy.api#xmlName": "tenancy" + } + }, + "EndDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "EndDate", + "smithy.api#documentation": "

The date and time at which the Capacity Reservation Fleet expires.

", + "smithy.api#xmlName": "endDate" + } + }, + "CreateTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreateTime", + "smithy.api#documentation": "

The date and time at which the Capacity Reservation Fleet was created.

", + "smithy.api#xmlName": "createTime" + } + }, + "InstanceMatchCriteria": { + "target": "com.amazonaws.ec2#FleetInstanceMatchCriteria", + "traits": { + "aws.protocols#ec2QueryName": "InstanceMatchCriteria", + "smithy.api#documentation": "

Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All \n\t\t\tCapacity Reservations in the Fleet inherit this instance matching criteria.

\n

Currently, Capacity Reservation Fleets support open instance matching criteria \n\t\t\tonly. This means that instances that have matching attributes (instance type, platform, and \n\t\t\tAvailability Zone) run in the Capacity Reservations automatically. Instances do not need to \n\t\t\texplicitly target a Capacity Reservation Fleet to use its reserved capacity.

", + "smithy.api#xmlName": "instanceMatchCriteria" + } + }, + "AllocationStrategy": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AllocationStrategy", + "smithy.api#documentation": "

The strategy used by the Capacity Reservation Fleet to determine which of the specified \n\t\t\tinstance types to use. For more information, see For more information, see \n\t\t\t\n\t\t\t\tAllocation strategy in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "allocationStrategy" + } + }, + "InstanceTypeSpecifications": { + "target": "com.amazonaws.ec2#FleetCapacityReservationSet", + "traits": { + "aws.protocols#ec2QueryName": "InstanceTypeSpecificationSet", + "smithy.api#documentation": "

Information about the instance types for which to reserve the capacity.

", + "smithy.api#xmlName": "instanceTypeSpecificationSet" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the Capacity Reservation Fleet.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a Capacity Reservation Fleet.

" + } + }, + "com.amazonaws.ec2#CapacityReservationFleetCancellationState": { + "type": "structure", + "members": { + "CurrentFleetState": { + "target": "com.amazonaws.ec2#CapacityReservationFleetState", + "traits": { + "aws.protocols#ec2QueryName": "CurrentFleetState", + "smithy.api#documentation": "

The current state of the Capacity Reservation Fleet.

", + "smithy.api#xmlName": "currentFleetState" + } + }, + "PreviousFleetState": { + "target": "com.amazonaws.ec2#CapacityReservationFleetState", + "traits": { + "aws.protocols#ec2QueryName": "PreviousFleetState", + "smithy.api#documentation": "

The previous state of the Capacity Reservation Fleet.

", + "smithy.api#xmlName": "previousFleetState" + } + }, + "CapacityReservationFleetId": { + "target": "com.amazonaws.ec2#CapacityReservationFleetId", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationFleetId", + "smithy.api#documentation": "

The ID of the Capacity Reservation Fleet that was successfully cancelled.

", + "smithy.api#xmlName": "capacityReservationFleetId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Capacity Reservation Fleet that was successfully cancelled.

" + } + }, + "com.amazonaws.ec2#CapacityReservationFleetCancellationStateSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CapacityReservationFleetCancellationState", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CapacityReservationFleetId": { + "type": "string" + }, + "com.amazonaws.ec2#CapacityReservationFleetIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CapacityReservationFleetId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CapacityReservationFleetSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CapacityReservationFleet", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CapacityReservationFleetState": { + "type": "enum", + "members": { + "SUBMITTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "submitted" + } + }, + "MODIFYING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modifying" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "PARTIALLY_FULFILLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "partially_fulfilled" + } + }, + "EXPIRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "expiring" + } + }, + "EXPIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "expired" + } + }, + "CANCELLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelling" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelled" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + } + } + }, + "com.amazonaws.ec2#CapacityReservationGroup": { + "type": "structure", + "members": { + "GroupArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupArn", + "smithy.api#documentation": "

The ARN of the resource group.

", + "smithy.api#xmlName": "groupArn" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the resource group.

", + "smithy.api#xmlName": "ownerId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a resource group to which a Capacity Reservation has been added.

" + } + }, + "com.amazonaws.ec2#CapacityReservationGroupSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CapacityReservationGroup", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CapacityReservationId": { + "type": "string" + }, + "com.amazonaws.ec2#CapacityReservationIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CapacityReservationId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CapacityReservationInstancePlatform": { + "type": "enum", + "members": { + "LINUX_UNIX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Linux/UNIX" + } + }, + "RED_HAT_ENTERPRISE_LINUX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Red Hat Enterprise Linux" + } + }, + "SUSE_LINUX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUSE Linux" + } + }, + "WINDOWS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Windows" + } + }, + "WINDOWS_WITH_SQL_SERVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Windows with SQL Server" + } + }, + "WINDOWS_WITH_SQL_SERVER_ENTERPRISE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Windows with SQL Server Enterprise" + } + }, + "WINDOWS_WITH_SQL_SERVER_STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Windows with SQL Server Standard" + } + }, + "WINDOWS_WITH_SQL_SERVER_WEB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Windows with SQL Server Web" + } + }, + "LINUX_WITH_SQL_SERVER_STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Linux with SQL Server Standard" + } + }, + "LINUX_WITH_SQL_SERVER_WEB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Linux with SQL Server Web" + } + }, + "LINUX_WITH_SQL_SERVER_ENTERPRISE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Linux with SQL Server Enterprise" + } + }, + "RHEL_WITH_SQL_SERVER_STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RHEL with SQL Server Standard" + } + }, + "RHEL_WITH_SQL_SERVER_ENTERPRISE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RHEL with SQL Server Enterprise" + } + }, + "RHEL_WITH_SQL_SERVER_WEB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RHEL with SQL Server Web" + } + }, + "RHEL_WITH_HA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RHEL with HA" + } + }, + "RHEL_WITH_HA_AND_SQL_SERVER_STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RHEL with HA and SQL Server Standard" + } + }, + "RHEL_WITH_HA_AND_SQL_SERVER_ENTERPRISE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RHEL with HA and SQL Server Enterprise" + } + } + } + }, + "com.amazonaws.ec2#CapacityReservationOptions": { + "type": "structure", + "members": { + "UsageStrategy": { + "target": "com.amazonaws.ec2#FleetCapacityReservationUsageStrategy", + "traits": { + "aws.protocols#ec2QueryName": "UsageStrategy", + "smithy.api#documentation": "

Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.

\n

If you specify use-capacity-reservations-first, the fleet uses unused\n Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If\n multiple instance pools have unused Capacity Reservations, the On-Demand allocation\n strategy (lowest-price or prioritized) is applied. If the number\n of unused Capacity Reservations is less than the On-Demand target capacity, the remaining\n On-Demand target capacity is launched according to the On-Demand allocation strategy\n (lowest-price or prioritized).

\n

If you do not specify a value, the fleet fulfils the On-Demand capacity according to the\n chosen On-Demand allocation strategy.

", + "smithy.api#xmlName": "usageStrategy" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand\n capacity.

\n \n

This strategy can only be used if the EC2 Fleet is of type\n instant.

\n \n

For more information about Capacity Reservations, see On-Demand Capacity\n Reservations in the Amazon EC2 User Guide. For examples of using\n Capacity Reservations in an EC2 Fleet, see EC2 Fleet example\n configurations in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#CapacityReservationOptionsRequest": { + "type": "structure", + "members": { + "UsageStrategy": { + "target": "com.amazonaws.ec2#FleetCapacityReservationUsageStrategy", + "traits": { + "smithy.api#documentation": "

Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.

\n

If you specify use-capacity-reservations-first, the fleet uses unused\n Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If\n multiple instance pools have unused Capacity Reservations, the On-Demand allocation\n strategy (lowest-price or prioritized) is applied. If the number\n of unused Capacity Reservations is less than the On-Demand target capacity, the remaining\n On-Demand target capacity is launched according to the On-Demand allocation strategy\n (lowest-price or prioritized).

\n

If you do not specify a value, the fleet fulfils the On-Demand capacity according to the\n chosen On-Demand allocation strategy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand\n capacity.

\n \n

This strategy can only be used if the EC2 Fleet is of type instant.

\n \n

For more information about Capacity Reservations, see On-Demand Capacity\n Reservations in the Amazon EC2 User Guide. For examples of using\n Capacity Reservations in an EC2 Fleet, see EC2 Fleet example\n configurations in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#CapacityReservationPreference": { + "type": "enum", + "members": { + "open": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "open" + } + }, + "none": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "none" + } + } + } + }, + "com.amazonaws.ec2#CapacityReservationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CapacityReservation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CapacityReservationSpecification": { + "type": "structure", + "members": { + "CapacityReservationPreference": { + "target": "com.amazonaws.ec2#CapacityReservationPreference", + "traits": { + "smithy.api#documentation": "

Indicates the instance's Capacity Reservation preferences. Possible preferences include:

\n " + } + }, + "CapacityReservationTarget": { + "target": "com.amazonaws.ec2#CapacityReservationTarget", + "traits": { + "smithy.api#documentation": "

Information about the target Capacity Reservation or Capacity Reservation group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an instance's Capacity Reservation targeting option. You can specify only one parameter \n\t\t\tat a time. If you specify CapacityReservationPreference and \n\t\t\tCapacityReservationTarget, the request fails.

\n

Use the CapacityReservationPreference parameter to configure the instance\n\t\t\tto run as an On-Demand Instance or to run in any open Capacity Reservation that has\n\t\t\tmatching attributes (instance type, platform, Availability Zone). Use the\n\t\t\tCapacityReservationTarget parameter to explicitly target a specific\n\t\t\t \tCapacity Reservation or a Capacity Reservation group.

" + } + }, + "com.amazonaws.ec2#CapacityReservationSpecificationResponse": { + "type": "structure", + "members": { + "CapacityReservationPreference": { + "target": "com.amazonaws.ec2#CapacityReservationPreference", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationPreference", + "smithy.api#documentation": "

Describes the instance's Capacity Reservation preferences. Possible preferences include:

\n ", + "smithy.api#xmlName": "capacityReservationPreference" + } + }, + "CapacityReservationTarget": { + "target": "com.amazonaws.ec2#CapacityReservationTargetResponse", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationTarget", + "smithy.api#documentation": "

Information about the targeted Capacity Reservation or Capacity Reservation group.

", + "smithy.api#xmlName": "capacityReservationTarget" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the instance's Capacity Reservation targeting preferences. The action returns the\n capacityReservationPreference response element if the instance is\n configured to run in On-Demand capacity, or if it is configured in run in any\n open Capacity Reservation that has matching attributes (instance type, platform,\n Availability Zone). The action returns the capacityReservationTarget\n response element if the instance explicily targets a specific Capacity Reservation or Capacity Reservation group.

" + } + }, + "com.amazonaws.ec2#CapacityReservationState": { + "type": "enum", + "members": { + "active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "expired": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "expired" + } + }, + "cancelled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelled" + } + }, + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + } + } + }, + "com.amazonaws.ec2#CapacityReservationTarget": { + "type": "structure", + "members": { + "CapacityReservationId": { + "target": "com.amazonaws.ec2#CapacityReservationId", + "traits": { + "smithy.api#documentation": "

The ID of the Capacity Reservation in which to run the instance.

" + } + }, + "CapacityReservationResourceGroupArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ARN of the Capacity Reservation resource group in which to run the instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a target Capacity Reservation or Capacity Reservation group.

" + } + }, + "com.amazonaws.ec2#CapacityReservationTargetResponse": { + "type": "structure", + "members": { + "CapacityReservationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationId", + "smithy.api#documentation": "

The ID of the targeted Capacity Reservation.

", + "smithy.api#xmlName": "capacityReservationId" + } + }, + "CapacityReservationResourceGroupArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationResourceGroupArn", + "smithy.api#documentation": "

The ARN of the targeted Capacity Reservation group.

", + "smithy.api#xmlName": "capacityReservationResourceGroupArn" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a target Capacity Reservation or Capacity Reservation group.

" + } + }, + "com.amazonaws.ec2#CapacityReservationTenancy": { + "type": "enum", + "members": { + "default": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "default" + } + }, + "dedicated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dedicated" + } + } + } + }, + "com.amazonaws.ec2#CarrierGateway": { + "type": "structure", + "members": { + "CarrierGatewayId": { + "target": "com.amazonaws.ec2#CarrierGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "CarrierGatewayId", + "smithy.api#documentation": "

The ID of the carrier gateway.

", + "smithy.api#xmlName": "carrierGatewayId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC associated with the carrier gateway.

", + "smithy.api#xmlName": "vpcId" + } + }, + "State": { + "target": "com.amazonaws.ec2#CarrierGatewayState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the carrier gateway.

", + "smithy.api#xmlName": "state" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the carrier gateway.

", + "smithy.api#xmlName": "ownerId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the carrier gateway.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a carrier gateway.

" + } + }, + "com.amazonaws.ec2#CarrierGatewayId": { + "type": "string" + }, + "com.amazonaws.ec2#CarrierGatewayIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CarrierGatewayId" + } + }, + "com.amazonaws.ec2#CarrierGatewayMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#CarrierGatewaySet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CarrierGateway", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CarrierGatewayState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + } + } + }, + "com.amazonaws.ec2#CertificateArn": { + "type": "string" + }, + "com.amazonaws.ec2#CertificateAuthentication": { + "type": "structure", + "members": { + "ClientRootCertificateChain": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientRootCertificateChain", + "smithy.api#documentation": "

The ARN of the client certificate.

", + "smithy.api#xmlName": "clientRootCertificateChain" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the client certificate used for authentication.

" + } + }, + "com.amazonaws.ec2#CertificateAuthenticationRequest": { + "type": "structure", + "members": { + "ClientRootCertificateChainArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ARN of the client certificate. The certificate must be signed by a certificate \n\t\t\tauthority (CA) and it must be provisioned in Certificate Manager (ACM).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the client certificate to be used for authentication.

" + } + }, + "com.amazonaws.ec2#CertificateId": { + "type": "string" + }, + "com.amazonaws.ec2#CidrAuthorizationContext": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The plain-text authorization message for the prefix and account.

", + "smithy.api#required": {} + } + }, + "Signature": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The signed authorization message for the prefix and account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides authorization for Amazon to bring a specific IP address range to a specific\n Amazon Web Services account using bring your own IP addresses (BYOIP). For more information, see Configuring your BYOIP address range in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#CidrBlock": { + "type": "structure", + "members": { + "CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrBlock", + "smithy.api#documentation": "

The IPv4 CIDR block.

", + "smithy.api#xmlName": "cidrBlock" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an IPv4 CIDR block.

" + } + }, + "com.amazonaws.ec2#CidrBlockSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CidrBlock", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ClassicLinkDnsSupport": { + "type": "structure", + "members": { + "ClassicLinkDnsSupported": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "ClassicLinkDnsSupported", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether ClassicLink DNS support is enabled for the VPC.

", + "smithy.api#xmlName": "classicLinkDnsSupported" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the ClassicLink DNS support status of a VPC.

" + } + }, + "com.amazonaws.ec2#ClassicLinkDnsSupportList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ClassicLinkDnsSupport", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ClassicLinkInstance": { + "type": "structure", + "members": { + "Groups": { + "target": "com.amazonaws.ec2#GroupIdentifierList", + "traits": { + "aws.protocols#ec2QueryName": "GroupSet", + "smithy.api#documentation": "

A list of security groups.

", + "smithy.api#xmlName": "groupSet" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the instance.

", + "smithy.api#xmlName": "tagSet" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } + } + }, + "traits": { + "smithy.api#documentation": "\n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n \n

Describes a linked EC2-Classic instance.

" + } + }, + "com.amazonaws.ec2#ClassicLinkInstanceList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ClassicLinkInstance", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ClassicLoadBalancer": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The name of the load balancer.

", + "smithy.api#xmlName": "name" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Classic Load Balancer.

" + } + }, + "com.amazonaws.ec2#ClassicLoadBalancers": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ClassicLoadBalancer", + "traits": { + "smithy.api#xmlName": "item" + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.ec2#ClassicLoadBalancersConfig": { + "type": "structure", + "members": { + "ClassicLoadBalancers": { + "target": "com.amazonaws.ec2#ClassicLoadBalancers", + "traits": { + "aws.protocols#ec2QueryName": "ClassicLoadBalancers", + "smithy.api#documentation": "

One or more Classic Load Balancers.

", + "smithy.api#xmlName": "classicLoadBalancers" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the Classic Load Balancers to attach to a Spot Fleet. Spot Fleet registers\n the running Spot Instances with these Classic Load Balancers.

" + } + }, + "com.amazonaws.ec2#ClientCertificateRevocationListStatus": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#ClientCertificateRevocationListStatusCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The state of the client certificate revocation list.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

A message about the status of the client certificate revocation list, if applicable.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the state of a client certificate revocation list.

" + } + }, + "com.amazonaws.ec2#ClientCertificateRevocationListStatusCode": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + } + } + }, + "com.amazonaws.ec2#ClientConnectOptions": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether client connect options are enabled. The default is false (not enabled).

" + } + }, + "LambdaFunctionArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Lambda function used for connection authorization.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options for managing connection authorization for new client connections.

" + } + }, + "com.amazonaws.ec2#ClientConnectResponseOptions": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Enabled", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether client connect options are enabled.

", + "smithy.api#xmlName": "enabled" + } + }, + "LambdaFunctionArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LambdaFunctionArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Lambda function used for connection authorization.

", + "smithy.api#xmlName": "lambdaFunctionArn" + } + }, + "Status": { + "target": "com.amazonaws.ec2#ClientVpnEndpointAttributeStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status of any updates to the client connect options.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options for managing connection authorization for new client connections.

" + } + }, + "com.amazonaws.ec2#ClientData": { + "type": "structure", + "members": { + "Comment": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A user-defined comment about the disk upload.

" + } + }, + "UploadEnd": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "smithy.api#documentation": "

The time that the disk upload ends.

" + } + }, + "UploadSize": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The size of the uploaded disk image, in GiB.

" + } + }, + "UploadStart": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "smithy.api#documentation": "

The time that the disk upload starts.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the client-specific data.

" + } + }, + "com.amazonaws.ec2#ClientLoginBannerOptions": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Enable or disable a customizable text banner that will be displayed on\n\t\t\tAmazon Web Services provided clients when a VPN session is established.

\n

Valid values: true | false\n

\n

Default value: false\n

" + } + }, + "BannerText": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Customizable text that will be displayed in a banner on Amazon Web Services provided\n\t\t\tclients when a VPN session is established. UTF-8 encoded characters only. Maximum of\n\t\t\t1400 characters.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Options for enabling a customizable text banner that will be displayed on\n\t\t\tAmazon Web Services provided clients when a VPN session is established.

" + } + }, + "com.amazonaws.ec2#ClientLoginBannerResponseOptions": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Enabled", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Current state of text banner feature.

\n

Valid values: true | false\n

", + "smithy.api#xmlName": "enabled" + } + }, + "BannerText": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "BannerText", + "smithy.api#documentation": "

Customizable text that will be displayed in a banner on Amazon Web Services provided\n\t\t\tclients when a VPN session is established. UTF-8 encoded\n\t\t\tcharacters only. Maximum of 1400 characters.

", + "smithy.api#xmlName": "bannerText" + } + } + }, + "traits": { + "smithy.api#documentation": "

Current state of options for customizable text banner that will be displayed on\n\t\t\tAmazon Web Services provided clients when a VPN session is established.

" + } + }, + "com.amazonaws.ec2#ClientSecretType": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.ec2#ClientVpnAssociationId": { + "type": "string" + }, + "com.amazonaws.ec2#ClientVpnAuthentication": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.ec2#ClientVpnAuthenticationType", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The authentication type used.

", + "smithy.api#xmlName": "type" + } + }, + "ActiveDirectory": { + "target": "com.amazonaws.ec2#DirectoryServiceAuthentication", + "traits": { + "aws.protocols#ec2QueryName": "ActiveDirectory", + "smithy.api#documentation": "

Information about the Active Directory, if applicable.

", + "smithy.api#xmlName": "activeDirectory" + } + }, + "MutualAuthentication": { + "target": "com.amazonaws.ec2#CertificateAuthentication", + "traits": { + "aws.protocols#ec2QueryName": "MutualAuthentication", + "smithy.api#documentation": "

Information about the authentication certificates, if applicable.

", + "smithy.api#xmlName": "mutualAuthentication" + } + }, + "FederatedAuthentication": { + "target": "com.amazonaws.ec2#FederatedAuthentication", + "traits": { + "aws.protocols#ec2QueryName": "FederatedAuthentication", + "smithy.api#documentation": "

Information about the IAM SAML identity provider, if applicable.

", + "smithy.api#xmlName": "federatedAuthentication" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the authentication methods used by a Client VPN endpoint. For more information, see Authentication \n\t\t\tin the Client VPN Administrator Guide.

" + } + }, + "com.amazonaws.ec2#ClientVpnAuthenticationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ClientVpnAuthentication", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ClientVpnAuthenticationRequest": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.ec2#ClientVpnAuthenticationType", + "traits": { + "smithy.api#documentation": "

The type of client authentication to be used.

" + } + }, + "ActiveDirectory": { + "target": "com.amazonaws.ec2#DirectoryServiceAuthenticationRequest", + "traits": { + "smithy.api#documentation": "

Information about the Active Directory to be used, if applicable. You must provide this information if Type is directory-service-authentication.

" + } + }, + "MutualAuthentication": { + "target": "com.amazonaws.ec2#CertificateAuthenticationRequest", + "traits": { + "smithy.api#documentation": "

Information about the authentication certificates to be used, if applicable. You must provide this information if Type is certificate-authentication.

" + } + }, + "FederatedAuthentication": { + "target": "com.amazonaws.ec2#FederatedAuthenticationRequest", + "traits": { + "smithy.api#documentation": "

Information about the IAM SAML identity provider to be used, if applicable. You must provide this information if Type is federated-authentication.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the authentication method to be used by a Client VPN endpoint. For more information, see Authentication \n\t\t\tin the Client VPN Administrator Guide.

" + } + }, + "com.amazonaws.ec2#ClientVpnAuthenticationRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ClientVpnAuthenticationRequest" + } + }, + "com.amazonaws.ec2#ClientVpnAuthenticationType": { + "type": "enum", + "members": { + "certificate_authentication": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "certificate-authentication" + } + }, + "directory_service_authentication": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "directory-service-authentication" + } + }, + "federated_authentication": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "federated-authentication" + } + } + } + }, + "com.amazonaws.ec2#ClientVpnAuthorizationRuleStatus": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#ClientVpnAuthorizationRuleStatusCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The state of the authorization rule.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

A message about the status of the authorization rule, if applicable.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the state of an authorization rule.

" + } + }, + "com.amazonaws.ec2#ClientVpnAuthorizationRuleStatusCode": { + "type": "enum", + "members": { + "authorizing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "authorizing" + } + }, + "active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "revoking": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "revoking" + } + } + } + }, + "com.amazonaws.ec2#ClientVpnConnection": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientVpnEndpointId", + "smithy.api#documentation": "

The ID of the Client VPN endpoint to which the client is connected.

", + "smithy.api#xmlName": "clientVpnEndpointId" + } + }, + "Timestamp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Timestamp", + "smithy.api#documentation": "

The current date and time.

", + "smithy.api#xmlName": "timestamp" + } + }, + "ConnectionId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ConnectionId", + "smithy.api#documentation": "

The ID of the client connection.

", + "smithy.api#xmlName": "connectionId" + } + }, + "Username": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Username", + "smithy.api#documentation": "

The username of the client who established the client connection. This information is only provided \n\t\t\tif Active Directory client authentication is used.

", + "smithy.api#xmlName": "username" + } + }, + "ConnectionEstablishedTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ConnectionEstablishedTime", + "smithy.api#documentation": "

The date and time the client connection was established.

", + "smithy.api#xmlName": "connectionEstablishedTime" + } + }, + "IngressBytes": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IngressBytes", + "smithy.api#documentation": "

The number of bytes sent by the client.

", + "smithy.api#xmlName": "ingressBytes" + } + }, + "EgressBytes": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "EgressBytes", + "smithy.api#documentation": "

The number of bytes received by the client.

", + "smithy.api#xmlName": "egressBytes" + } + }, + "IngressPackets": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IngressPackets", + "smithy.api#documentation": "

The number of packets sent by the client.

", + "smithy.api#xmlName": "ingressPackets" + } + }, + "EgressPackets": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "EgressPackets", + "smithy.api#documentation": "

The number of packets received by the client.

", + "smithy.api#xmlName": "egressPackets" + } + }, + "ClientIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientIp", + "smithy.api#documentation": "

The IP address of the client.

", + "smithy.api#xmlName": "clientIp" + } + }, + "CommonName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CommonName", + "smithy.api#documentation": "

The common name associated with the client. This is either the name of the client certificate,\n\t\t\tor the Active Directory user name.

", + "smithy.api#xmlName": "commonName" + } + }, + "Status": { + "target": "com.amazonaws.ec2#ClientVpnConnectionStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The current state of the client connection.

", + "smithy.api#xmlName": "status" + } + }, + "ConnectionEndTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ConnectionEndTime", + "smithy.api#documentation": "

The date and time the client connection was terminated.

", + "smithy.api#xmlName": "connectionEndTime" + } + }, + "PostureComplianceStatuses": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "PostureComplianceStatusSet", + "smithy.api#documentation": "

The statuses returned by the client connect handler for posture compliance, if applicable.

", + "smithy.api#xmlName": "postureComplianceStatusSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a client connection.

" + } + }, + "com.amazonaws.ec2#ClientVpnConnectionSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ClientVpnConnection", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ClientVpnConnectionStatus": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#ClientVpnConnectionStatusCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The state of the client connection.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

A message about the status of the client connection, if applicable.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the status of a client connection.

" + } + }, + "com.amazonaws.ec2#ClientVpnConnectionStatusCode": { + "type": "enum", + "members": { + "active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "failed_to_terminate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed-to-terminate" + } + }, + "terminating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "terminating" + } + }, + "terminated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "terminated" + } + } + } + }, + "com.amazonaws.ec2#ClientVpnEndpoint": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientVpnEndpointId", + "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", + "smithy.api#xmlName": "clientVpnEndpointId" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A brief description of the endpoint.

", + "smithy.api#xmlName": "description" + } + }, + "Status": { + "target": "com.amazonaws.ec2#ClientVpnEndpointStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The current state of the Client VPN endpoint.

", + "smithy.api#xmlName": "status" + } + }, + "CreationTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The date and time the Client VPN endpoint was created.

", + "smithy.api#xmlName": "creationTime" + } + }, + "DeletionTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DeletionTime", + "smithy.api#documentation": "

The date and time the Client VPN endpoint was deleted, if applicable.

", + "smithy.api#xmlName": "deletionTime" + } + }, + "DnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DnsName", + "smithy.api#documentation": "

The DNS name to be used by clients when connecting to the Client VPN endpoint.

", + "smithy.api#xmlName": "dnsName" + } + }, + "ClientCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientCidrBlock", + "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.

", + "smithy.api#xmlName": "clientCidrBlock" + } + }, + "DnsServers": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "DnsServer", + "smithy.api#documentation": "

Information about the DNS servers to be used for DNS resolution.

", + "smithy.api#xmlName": "dnsServer" + } + }, + "SplitTunnel": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "SplitTunnel", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether split-tunnel is enabled in the Client VPN endpoint.

\n

For information about split-tunnel VPN endpoints, see Split-Tunnel Client VPN endpoint \n\t\t\tin the Client VPN Administrator Guide.

", + "smithy.api#xmlName": "splitTunnel" + } + }, + "VpnProtocol": { + "target": "com.amazonaws.ec2#VpnProtocol", + "traits": { + "aws.protocols#ec2QueryName": "VpnProtocol", + "smithy.api#documentation": "

The protocol used by the VPN session.

", + "smithy.api#xmlName": "vpnProtocol" + } + }, + "TransportProtocol": { + "target": "com.amazonaws.ec2#TransportProtocol", + "traits": { + "aws.protocols#ec2QueryName": "TransportProtocol", + "smithy.api#documentation": "

The transport protocol used by the Client VPN endpoint.

", + "smithy.api#xmlName": "transportProtocol" + } + }, + "VpnPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "VpnPort", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The port number for the Client VPN endpoint.

", + "smithy.api#xmlName": "vpnPort" + } + }, + "AssociatedTargetNetworks": { + "target": "com.amazonaws.ec2#AssociatedTargetNetworkSet", + "traits": { + "aws.protocols#ec2QueryName": "AssociatedTargetNetwork", + "smithy.api#deprecated": { + "message": "This property is deprecated. To view the target networks associated with a Client VPN endpoint, call DescribeClientVpnTargetNetworks and inspect the clientVpnTargetNetworks response element." + }, + "smithy.api#documentation": "

Information about the associated target networks. A target network is a subnet in a VPC.

", + "smithy.api#xmlName": "associatedTargetNetwork" + } + }, + "ServerCertificateArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ServerCertificateArn", + "smithy.api#documentation": "

The ARN of the server certificate.

", + "smithy.api#xmlName": "serverCertificateArn" + } + }, + "AuthenticationOptions": { + "target": "com.amazonaws.ec2#ClientVpnAuthenticationList", + "traits": { + "aws.protocols#ec2QueryName": "AuthenticationOptions", + "smithy.api#documentation": "

Information about the authentication method used by the Client VPN endpoint.

", + "smithy.api#xmlName": "authenticationOptions" + } + }, + "ConnectionLogOptions": { + "target": "com.amazonaws.ec2#ConnectionLogResponseOptions", + "traits": { + "aws.protocols#ec2QueryName": "ConnectionLogOptions", + "smithy.api#documentation": "

Information about the client connection logging options for the Client VPN endpoint.

", + "smithy.api#xmlName": "connectionLogOptions" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the Client VPN endpoint.

", + "smithy.api#xmlName": "tagSet" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#ClientVpnSecurityGroupIdSet", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupIdSet", + "smithy.api#documentation": "

The IDs of the security groups for the target network.

", + "smithy.api#xmlName": "securityGroupIdSet" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } + }, + "SelfServicePortalUrl": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SelfServicePortalUrl", + "smithy.api#documentation": "

The URL of the self-service portal.

", + "smithy.api#xmlName": "selfServicePortalUrl" + } + }, + "ClientConnectOptions": { + "target": "com.amazonaws.ec2#ClientConnectResponseOptions", + "traits": { + "aws.protocols#ec2QueryName": "ClientConnectOptions", + "smithy.api#documentation": "

The options for managing connection authorization for new client connections.

", + "smithy.api#xmlName": "clientConnectOptions" + } + }, + "SessionTimeoutHours": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "SessionTimeoutHours", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum VPN session duration time in hours.

\n

Valid values: 8 | 10 | 12 | 24\n

\n

Default value: 24\n

", + "smithy.api#xmlName": "sessionTimeoutHours" + } + }, + "ClientLoginBannerOptions": { + "target": "com.amazonaws.ec2#ClientLoginBannerResponseOptions", + "traits": { + "aws.protocols#ec2QueryName": "ClientLoginBannerOptions", + "smithy.api#documentation": "

Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is\n\t\t\testablished.

", + "smithy.api#xmlName": "clientLoginBannerOptions" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Client VPN endpoint.

" + } + }, + "com.amazonaws.ec2#ClientVpnEndpointAttributeStatus": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#ClientVpnEndpointAttributeStatusCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The status code.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The status message.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the status of the Client VPN endpoint attribute.

" + } + }, + "com.amazonaws.ec2#ClientVpnEndpointAttributeStatusCode": { + "type": "enum", + "members": { + "applying": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "applying" + } + }, + "applied": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "applied" + } + } + } + }, + "com.amazonaws.ec2#ClientVpnEndpointId": { + "type": "string" + }, + "com.amazonaws.ec2#ClientVpnEndpointIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ClientVpnEndpointStatus": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#ClientVpnEndpointStatusCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The state of the Client VPN endpoint. Possible states include:

\n ", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

A message about the status of the Client VPN endpoint.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the state of a Client VPN endpoint.

" + } + }, + "com.amazonaws.ec2#ClientVpnEndpointStatusCode": { + "type": "enum", + "members": { + "pending_associate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending-associate" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + } + } + }, + "com.amazonaws.ec2#ClientVpnRoute": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientVpnEndpointId", + "smithy.api#documentation": "

The ID of the Client VPN endpoint with which the route is associated.

", + "smithy.api#xmlName": "clientVpnEndpointId" + } + }, + "DestinationCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationCidr", + "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, of the route destination.

", + "smithy.api#xmlName": "destinationCidr" + } + }, + "TargetSubnet": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TargetSubnet", + "smithy.api#documentation": "

The ID of the subnet through which traffic is routed.

", + "smithy.api#xmlName": "targetSubnet" + } + }, + "Type": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The route type.

", + "smithy.api#xmlName": "type" + } + }, + "Origin": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Origin", + "smithy.api#documentation": "

Indicates how the route was associated with the Client VPN endpoint. \n\t\t\tassociate indicates that the route was automatically added when the target network \n\t\t\twas associated with the Client VPN endpoint. add-route indicates that the route \n\t\t\twas manually added using the CreateClientVpnRoute action.

", + "smithy.api#xmlName": "origin" + } + }, + "Status": { + "target": "com.amazonaws.ec2#ClientVpnRouteStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The current state of the route.

", + "smithy.api#xmlName": "status" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A brief description of the route.

", + "smithy.api#xmlName": "description" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a Client VPN endpoint route.

" + } + }, + "com.amazonaws.ec2#ClientVpnRouteSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ClientVpnRoute", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ClientVpnRouteStatus": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#ClientVpnRouteStatusCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The state of the Client VPN endpoint route.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

A message about the status of the Client VPN endpoint route, if applicable.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the state of a Client VPN endpoint route.

" + } + }, + "com.amazonaws.ec2#ClientVpnRouteStatusCode": { + "type": "enum", + "members": { + "creating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "creating" + } + }, + "active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + } + } + }, + "com.amazonaws.ec2#ClientVpnSecurityGroupIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CloudWatchLogGroupArn": { + "type": "string" + }, + "com.amazonaws.ec2#CloudWatchLogOptions": { + "type": "structure", + "members": { + "LogEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "LogEnabled", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Status of VPN tunnel logging feature. Default value is False.

\n

Valid values: True | False\n

", + "smithy.api#xmlName": "logEnabled" + } + }, + "LogGroupArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LogGroupArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudWatch log group to send logs to.

", + "smithy.api#xmlName": "logGroupArn" + } + }, + "LogOutputFormat": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LogOutputFormat", + "smithy.api#documentation": "

Configured log format. Default format is json.

\n

Valid values: json | text\n

", + "smithy.api#xmlName": "logOutputFormat" + } + } + }, + "traits": { + "smithy.api#documentation": "

Options for sending VPN tunnel logs to CloudWatch.

" + } + }, + "com.amazonaws.ec2#CloudWatchLogOptionsSpecification": { + "type": "structure", + "members": { + "LogEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Enable or disable VPN tunnel logging feature. Default value is False.

\n

Valid values: True | False\n

" + } + }, + "LogGroupArn": { + "target": "com.amazonaws.ec2#CloudWatchLogGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudWatch log group to send logs to.

" + } + }, + "LogOutputFormat": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Set log format. Default format is json.

\n

Valid values: json | text\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Options for sending VPN tunnel logs to CloudWatch.

" + } + }, + "com.amazonaws.ec2#CoipAddressUsage": { + "type": "structure", + "members": { + "AllocationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AllocationId", + "smithy.api#documentation": "

The allocation ID of the address.

", + "smithy.api#xmlName": "allocationId" + } + }, + "AwsAccountId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AwsAccountId", + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#xmlName": "awsAccountId" + } + }, + "AwsService": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AwsService", + "smithy.api#documentation": "

The Amazon Web Services service.

", + "smithy.api#xmlName": "awsService" + } + }, + "CoIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CoIp", + "smithy.api#documentation": "

The customer-owned IP address.

", + "smithy.api#xmlName": "coIp" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes address usage for a customer-owned address pool.

" + } + }, + "com.amazonaws.ec2#CoipAddressUsageSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CoipAddressUsage", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CoipCidr": { + "type": "structure", + "members": { + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Cidr", + "smithy.api#documentation": "

\n An address range in a customer-owned IP address space.\n

", + "smithy.api#xmlName": "cidr" + } + }, + "CoipPoolId": { + "target": "com.amazonaws.ec2#Ipv4PoolCoipId", + "traits": { + "aws.protocols#ec2QueryName": "CoipPoolId", + "smithy.api#documentation": "

\n The ID of the address pool.\n

", + "smithy.api#xmlName": "coipPoolId" + } + }, + "LocalGatewayRouteTableId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableId", + "smithy.api#documentation": "

\n The ID of the local gateway route table.\n

", + "smithy.api#xmlName": "localGatewayRouteTableId" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Information about a customer-owned IP address range.\n

" + } + }, + "com.amazonaws.ec2#CoipPool": { + "type": "structure", + "members": { + "PoolId": { + "target": "com.amazonaws.ec2#Ipv4PoolCoipId", + "traits": { + "aws.protocols#ec2QueryName": "PoolId", + "smithy.api#documentation": "

The ID of the address pool.

", + "smithy.api#xmlName": "poolId" + } + }, + "PoolCidrs": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "PoolCidrSet", + "smithy.api#documentation": "

The address ranges of the address pool.

", + "smithy.api#xmlName": "poolCidrSet" + } + }, + "LocalGatewayRouteTableId": { + "target": "com.amazonaws.ec2#LocalGatewayRoutetableId", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableId", + "smithy.api#documentation": "

The ID of the local gateway route table.

", + "smithy.api#xmlName": "localGatewayRouteTableId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags.

", + "smithy.api#xmlName": "tagSet" + } + }, + "PoolArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "PoolArn", + "smithy.api#documentation": "

The ARN of the address pool.

", + "smithy.api#xmlName": "poolArn" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a customer-owned address pool.

" + } + }, + "com.amazonaws.ec2#CoipPoolId": { + "type": "string" + }, + "com.amazonaws.ec2#CoipPoolIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Ipv4PoolCoipId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CoipPoolMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#CoipPoolSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CoipPool", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ComponentAccount": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\d{12}$" + } + }, + "com.amazonaws.ec2#ComponentRegion": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-z]{2}-[a-z]+-[1-9]+$" + } + }, + "com.amazonaws.ec2#ConfirmProductInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ConfirmProductInstanceRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ConfirmProductInstanceResult" + }, + "traits": { + "smithy.api#documentation": "

Determines whether a product code is associated with an instance. This action can only\n be used by the owner of the product code. It is useful when a product code owner must\n verify whether another user's instance is eligible for support.

" + } + }, + "com.amazonaws.ec2#ConfirmProductInstanceRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {} + } + }, + "ProductCode": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The product code. This must be a product code that you own.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ConfirmProductInstanceResult": { + "type": "structure", + "members": { + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The Amazon Web Services account ID of the instance owner. This is only present if the\n product code is attached to the instance.

", + "smithy.api#xmlName": "ownerId" + } + }, + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

The return value of the request. Returns true if the specified product\n code is owned by the requester and associated with the specified instance.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ConnectionLogOptions": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether connection logging is enabled.

" + } + }, + "CloudwatchLogGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the CloudWatch Logs log group. Required if connection logging is enabled.

" + } + }, + "CloudwatchLogStream": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the CloudWatch Logs log stream to which the connection data is published.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the client connection logging options for the Client VPN endpoint.

" + } + }, + "com.amazonaws.ec2#ConnectionLogResponseOptions": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether client connection logging is enabled for the Client VPN endpoint.

" + } + }, + "CloudwatchLogGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon CloudWatch Logs log group to which connection logging data is published.

" + } + }, + "CloudwatchLogStream": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon CloudWatch Logs log stream to which connection logging data is published.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the client connection logging options for a Client VPN endpoint.

" + } + }, + "com.amazonaws.ec2#ConnectionNotification": { + "type": "structure", + "members": { + "ConnectionNotificationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ConnectionNotificationId", + "smithy.api#documentation": "

The ID of the notification.

", + "smithy.api#xmlName": "connectionNotificationId" + } + }, + "ServiceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ServiceId", + "smithy.api#documentation": "

The ID of the endpoint service.

", + "smithy.api#xmlName": "serviceId" + } + }, + "VpcEndpointId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcEndpointId", + "smithy.api#documentation": "

The ID of the VPC endpoint.

", + "smithy.api#xmlName": "vpcEndpointId" + } + }, + "ConnectionNotificationType": { + "target": "com.amazonaws.ec2#ConnectionNotificationType", + "traits": { + "aws.protocols#ec2QueryName": "ConnectionNotificationType", + "smithy.api#documentation": "

The type of notification.

", + "smithy.api#xmlName": "connectionNotificationType" + } + }, + "ConnectionNotificationArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ConnectionNotificationArn", + "smithy.api#documentation": "

The ARN of the SNS topic for the notification.

", + "smithy.api#xmlName": "connectionNotificationArn" + } + }, + "ConnectionEvents": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "ConnectionEvents", + "smithy.api#documentation": "

The events for the notification. Valid values are Accept,\n Connect, Delete, and Reject.

", + "smithy.api#xmlName": "connectionEvents" + } + }, + "ConnectionNotificationState": { + "target": "com.amazonaws.ec2#ConnectionNotificationState", + "traits": { + "aws.protocols#ec2QueryName": "ConnectionNotificationState", + "smithy.api#documentation": "

The state of the notification.

", + "smithy.api#xmlName": "connectionNotificationState" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a connection notification for a VPC endpoint or VPC endpoint\n service.

" + } + }, + "com.amazonaws.ec2#ConnectionNotificationId": { + "type": "string" + }, + "com.amazonaws.ec2#ConnectionNotificationIdsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ConnectionNotificationId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ConnectionNotificationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ConnectionNotification", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ConnectionNotificationState": { + "type": "enum", + "members": { + "Enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "Disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + } + } + }, + "com.amazonaws.ec2#ConnectionNotificationType": { + "type": "enum", + "members": { + "Topic": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Topic" + } + } + } + }, + "com.amazonaws.ec2#ConnectivityType": { + "type": "enum", + "members": { + "PRIVATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "private" + } + }, + "PUBLIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "public" + } + } + } + }, + "com.amazonaws.ec2#ContainerFormat": { + "type": "enum", + "members": { + "ova": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ova" + } + } + } + }, + "com.amazonaws.ec2#ConversionIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ConversionTaskId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ConversionTask": { + "type": "structure", + "members": { + "ConversionTaskId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ConversionTaskId", + "smithy.api#documentation": "

The ID of the conversion task.

", + "smithy.api#xmlName": "conversionTaskId" + } + }, + "ExpirationTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ExpirationTime", + "smithy.api#documentation": "

The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel\n the task.

", + "smithy.api#xmlName": "expirationTime" + } + }, + "ImportInstance": { + "target": "com.amazonaws.ec2#ImportInstanceTaskDetails", + "traits": { + "aws.protocols#ec2QueryName": "ImportInstance", + "smithy.api#documentation": "

If the task is for importing an instance, this contains information about the import instance task.

", + "smithy.api#xmlName": "importInstance" + } + }, + "ImportVolume": { + "target": "com.amazonaws.ec2#ImportVolumeTaskDetails", + "traits": { + "aws.protocols#ec2QueryName": "ImportVolume", + "smithy.api#documentation": "

If the task is for importing a volume, this contains information about the import volume task.

", + "smithy.api#xmlName": "importVolume" + } + }, + "State": { + "target": "com.amazonaws.ec2#ConversionTaskState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the conversion task.

", + "smithy.api#xmlName": "state" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

The status message related to the conversion task.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the task.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a conversion task.

" + } + }, + "com.amazonaws.ec2#ConversionTaskId": { + "type": "string" + }, + "com.amazonaws.ec2#ConversionTaskState": { + "type": "enum", + "members": { + "active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "cancelling": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelling" + } + }, + "cancelled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelled" + } + }, + "completed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "completed" + } + } + } + }, + "com.amazonaws.ec2#CopyFpgaImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CopyFpgaImageRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CopyFpgaImageResult" + }, + "traits": { + "smithy.api#documentation": "

Copies the specified Amazon FPGA Image (AFI) to the current Region.

" + } + }, + "com.amazonaws.ec2#CopyFpgaImageRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "SourceFpgaImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the source AFI.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The description for the new AFI.

" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name for the new AFI. The default is the name of the source AFI.

" + } + }, + "SourceRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Region that contains the source AFI.

", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. \n For more information, see Ensuring idempotency.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CopyFpgaImageResult": { + "type": "structure", + "members": { + "FpgaImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "FpgaImageId", + "smithy.api#documentation": "

The ID of the new AFI.

", + "smithy.api#xmlName": "fpgaImageId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CopyImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CopyImageRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CopyImageResult" + }, + "traits": { + "smithy.api#documentation": "

Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a\n Region to an Outpost. You can't copy an AMI from an Outpost to a Region, from one Outpost\n to another, or within the same Outpost. To copy an AMI to another partition, see CreateStoreImageTask.

\n

To copy an AMI from one Region to another, specify the source Region using the \n \t\tSourceRegion parameter, and specify the \n \t\tdestination Region using its endpoint. Copies of encrypted backing snapshots for\n \t\tthe AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, \n \t\tunless you set Encrypted during the copy operation. You cannot \n \t\tcreate an unencrypted copy of an encrypted backing snapshot.

\n

To copy an AMI from a Region to an Outpost, specify the source Region using the \n \t\tSourceRegion parameter, and specify the \n \t\tARN of the destination Outpost using DestinationOutpostArn. \n \t\tBacking snapshots copied to an Outpost are encrypted by default using the default\n \t\tencryption key for the Region, or a different key that you specify in the request using \n \t\tKmsKeyId. Outposts do not support unencrypted \n \t\tsnapshots. For more information, \n \t\t\tAmazon EBS local snapshots on Outposts in the Amazon EC2 User Guide.

\n

For more information about the prerequisites and limits when copying an AMI, see Copy an AMI in the\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#CopyImageRequest": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure\n idempotency of the request. For more information, see Ensuring idempotency \n in the Amazon EC2 API Reference.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the new AMI in the destination Region.

" + } + }, + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Encrypted", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether the destination snapshots of the copied image should be encrypted. You\n can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an\n encrypted snapshot. The default KMS key for Amazon EBS is used unless you specify a non-default\n Key Management Service (KMS) KMS key using KmsKeyId. For more information, see Amazon EBS encryption in the\n Amazon EC2 User Guide.

", + "smithy.api#xmlName": "encrypted" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.ec2#KmsKeyId", + "traits": { + "aws.protocols#ec2QueryName": "KmsKeyId", + "smithy.api#documentation": "

The identifier of the symmetric Key Management Service (KMS) KMS key to use when creating\n \t\tencrypted volumes. If this parameter is not specified, your Amazon Web Services managed KMS key for Amazon EBS is used. \n \t\tIf you specify a KMS key, you must also set the encrypted state to true.

\n

You can specify a KMS key using any of the following:

\n \n

Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an identifier that is not valid,\n the action can appear to complete, but eventually fails.

\n

The specified KMS key must exist in the destination Region.

\n

Amazon EBS does not support asymmetric KMS keys.

", + "smithy.api#xmlName": "kmsKeyId" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the new AMI in the destination Region.

", + "smithy.api#required": {} + } + }, + "SourceImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the AMI to copy.

", + "smithy.api#required": {} + } + }, + "SourceRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Region that contains the AMI to copy.

", + "smithy.api#required": {} + } + }, + "DestinationOutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only \n \t\tspecify this parameter when copying an AMI from an Amazon Web Services Region to an Outpost. \n \t\tThe AMI must be in the Region of the destination Outpost. You cannot copy an \n \t\tAMI from an Outpost to a Region, from one Outpost to another, or within the same \n \t\tOutpost.

\n

For more information, see Copy AMIs from an Amazon Web Services\n Region to an Outpost in the Amazon EC2 User Guide.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "CopyImageTags": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to include your user-defined AMI tags when copying the AMI.

\n

The following tags will not be copied:

\n \n

Default: Your user-defined AMI tags are not copied.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for CopyImage.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CopyImageResult": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the new AMI.

", + "smithy.api#xmlName": "imageId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of CopyImage.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CopySnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CopySnapshotRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CopySnapshotResult" + }, + "traits": { + "smithy.api#documentation": "

Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy a\n snapshot within the same Region, from one Region to another, or from a Region to an Outpost. \n You can't copy a snapshot from an Outpost to a Region, from one Outpost to another, or within \n the same Outpost.

\n

You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).

\n

When copying snapshots to a Region, copies of encrypted EBS snapshots remain encrypted. \n \tCopies of unencrypted snapshots remain unencrypted, unless you enable encryption for the \n \tsnapshot copy operation. By default, encrypted snapshot copies use the default Key Management Service (KMS) \n \tKMS key; however, you can specify a different KMS key. To copy an encrypted \n \tsnapshot that has been shared from another account, you must have permissions for the KMS key \n \tused to encrypt the snapshot.

\n

Snapshots copied to an Outpost are encrypted by default using the default\n \t\tencryption key for the Region, or a different key that you specify in the request using \n \t\tKmsKeyId. Outposts do not support unencrypted \n \t\tsnapshots. For more information, \n \t\t\tAmazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.

\n

Snapshots created by copying another snapshot have an arbitrary volume ID that should not\n be used for any purpose.

\n

For more information, see Copy an Amazon EBS snapshot in the\n Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#CopySnapshotRequest": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the EBS snapshot.

" + } + }, + "DestinationOutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only \n\t\tspecify this parameter when copying a snapshot from an Amazon Web Services Region to an Outpost. \n\t\tThe snapshot must be in the Region for the destination Outpost. You cannot copy a \n\t\tsnapshot from an Outpost to a Region, from one Outpost to another, or within the same \n\t\tOutpost.

\n

For more information, see \n \t\tCopy snapshots from an Amazon Web Services Region to an Outpost in the \n \t\tAmazon Elastic Compute Cloud User Guide.

" + } + }, + "DestinationRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationRegion", + "smithy.api#documentation": "

The destination Region to use in the PresignedUrl parameter of a snapshot\n copy operation. This parameter is only valid for specifying the destination Region in a\n PresignedUrl parameter, where it is required.

\n

The snapshot copy is sent to the regional endpoint that you sent the HTTP\n \trequest to (for example, ec2.us-east-1.amazonaws.com). With the CLI, this is\n specified using the --region parameter or the default Region in your Amazon Web Services\n configuration file.

", + "smithy.api#xmlName": "destinationRegion" + } + }, + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Encrypted", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, \n enable encryption using this parameter. Otherwise, omit this parameter. Encrypted snapshots \n are encrypted, even if you omit this parameter and encryption by default is not enabled. You \n cannot set this parameter to false. For more information, see Amazon EBS encryption in the \n Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#xmlName": "encrypted" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.ec2#KmsKeyId", + "traits": { + "aws.protocols#ec2QueryName": "KmsKeyId", + "smithy.api#documentation": "

The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption.\n If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is\n specified, the encrypted state must be true.

\n

You can specify the KMS key using any of the following:

\n \n

Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, \n the action can appear to complete, but eventually fails.

", + "smithy.api#xmlName": "kmsKeyId" + } + }, + "PresignedUrl": { + "target": "com.amazonaws.ec2#CopySnapshotRequestPSU", + "traits": { + "aws.protocols#ec2QueryName": "PresignedUrl", + "smithy.api#documentation": "

When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a\n pre-signed URL. This parameter is optional for unencrypted snapshots. For more information,\n see Query\n requests.

\n

The PresignedUrl should use the snapshot source endpoint, the\n CopySnapshot action, and include the SourceRegion,\n SourceSnapshotId, and DestinationRegion parameters. The\n PresignedUrl must be signed using Amazon Web Services Signature Version 4. Because EBS\n snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic\n that is described in Authenticating Requests: Using Query\n Parameters (Amazon Web Services Signature Version 4) in the Amazon Simple Storage Service API Reference. An\n invalid or improperly signed PresignedUrl will cause the copy operation to fail\n asynchronously, and the snapshot will move to an error state.

", + "smithy.api#xmlName": "presignedUrl" + } + }, + "SourceRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Region that contains the snapshot to be copied.

", + "smithy.api#required": {} + } + }, + "SourceSnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the EBS snapshot to copy.

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the new snapshot.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CopySnapshotRequestPSU": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.ec2#CopySnapshotResult": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the new snapshot.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags applied to the new snapshot.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CopyTagsFromSource": { + "type": "enum", + "members": { + "volume": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "volume" + } + } + } + }, + "com.amazonaws.ec2#CoreCount": { + "type": "integer" + }, + "com.amazonaws.ec2#CoreCountList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CoreCount", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CoreNetworkArn": { + "type": "string" + }, + "com.amazonaws.ec2#CpuManufacturer": { + "type": "enum", + "members": { + "INTEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "intel" + } + }, + "AMD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "amd" + } + }, + "AMAZON_WEB_SERVICES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "amazon-web-services" + } + } + } + }, + "com.amazonaws.ec2#CpuManufacturerSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CpuManufacturer", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CpuOptions": { + "type": "structure", + "members": { + "CoreCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "CoreCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of CPU cores for the instance.

", + "smithy.api#xmlName": "coreCount" + } + }, + "ThreadsPerCore": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "ThreadsPerCore", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of threads per CPU core.

", + "smithy.api#xmlName": "threadsPerCore" + } + }, + "AmdSevSnp": { + "target": "com.amazonaws.ec2#AmdSevSnpSpecification", + "traits": { + "aws.protocols#ec2QueryName": "AmdSevSnp", + "smithy.api#documentation": "

Indicates whether the instance is enabled for AMD SEV-SNP.

", + "smithy.api#xmlName": "amdSevSnp" + } + } + }, + "traits": { + "smithy.api#documentation": "

The CPU options for the instance.

" + } + }, + "com.amazonaws.ec2#CpuOptionsRequest": { + "type": "structure", + "members": { + "CoreCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of CPU cores for the instance.

" + } + }, + "ThreadsPerCore": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of threads per CPU core. To disable multithreading for the instance,\n specify a value of 1. Otherwise, specify the default value of\n 2.

" + } + }, + "AmdSevSnp": { + "target": "com.amazonaws.ec2#AmdSevSnpSpecification", + "traits": { + "smithy.api#documentation": "

Indicates whether to enable the instance for AMD SEV-SNP. AMD SEV-SNP is supported \n with M6a, R6a, and C6a instance types only.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The CPU options for the instance. Both the core count and threads per core must be\n specified in the request.

" + } + }, + "com.amazonaws.ec2#CreateCapacityReservation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateCapacityReservationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateCapacityReservationResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a new Capacity Reservation with the specified attributes.

\n

Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration. This \n\t\t\tgives you the flexibility to selectively add capacity reservations and still get the Regional RI discounts for that usage. \n\t\t\tBy 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. \n\t\t\tFor more information, see Capacity Reservations in the Amazon EC2 User Guide.

\n

Your request to create a Capacity Reservation could fail if Amazon EC2 does not have sufficient capacity to\n\t\t\tfulfill the request. If your request fails due to Amazon EC2 capacity constraints, either try\n\t\t\tagain at a later time, try in a different Availability Zone, or request a smaller\n\t\t\tcapacity reservation. If your application is flexible across instance types and sizes,\n\t\t\ttry to create a Capacity Reservation with different instance attributes.

\n

Your request could also fail if the requested quantity exceeds your On-Demand Instance\n\t\t\tlimit for the selected instance type. If your request fails due to limit constraints,\n\t\t\tincrease your On-Demand Instance limit for the required instance type and try again. For\n\t\t\tmore information about increasing your instance limits, see Amazon EC2 Service\n\t\t\t\tQuotas in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#CreateCapacityReservationFleet": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateCapacityReservationFleetRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateCapacityReservationFleetResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a Capacity Reservation Fleet. For more information, see Create a Capacity \n\t\t\tReservation Fleet in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#CreateCapacityReservationFleetRequest": { + "type": "structure", + "members": { + "AllocationStrategy": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The strategy used by the Capacity Reservation Fleet to determine which of the \n\t\t\tspecified instance types to use. Currently, only the prioritized \n\t\t\tallocation strategy is supported. For more information, see \n\t\t\t\tAllocation strategy in the Amazon EC2 User Guide.

\n

Valid values: prioritized\n

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "InstanceTypeSpecifications": { + "target": "com.amazonaws.ec2#ReservationFleetInstanceSpecificationList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Information about the instance types for which to reserve the capacity.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "InstanceTypeSpecification" + } + }, + "Tenancy": { + "target": "com.amazonaws.ec2#FleetCapacityReservationTenancy", + "traits": { + "smithy.api#documentation": "

Indicates the tenancy of the Capacity Reservation Fleet. All Capacity Reservations \n\t\t\tin the Fleet inherit this tenancy. The Capacity Reservation Fleet can have one of \n\t\t\tthe following tenancy settings:

\n " + } + }, + "TotalTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of capacity units to be reserved by the Capacity Reservation Fleet. This \n\t\t\tvalue, together with the instance type weights that you assign to each instance type used by \n\t\t\tthe Fleet determine the number of instances for which the Fleet reserves capacity. Both values \n\t\t\tare based on units that make sense for your workload. For more information, see \n\t\t\t\tTotal target capacity in the Amazon EC2 User Guide.

", + "smithy.api#required": {} + } + }, + "EndDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "smithy.api#documentation": "

The date and time at which the Capacity Reservation Fleet expires. When the Capacity \n\t\t\tReservation Fleet expires, its state changes to expired and all of the Capacity \n\t\t\tReservations in the Fleet expire.

\n

The Capacity Reservation Fleet expires within an hour after the specified time. For example, \n\t\t\tif you specify 5/31/2019, 13:30:55, the Capacity Reservation Fleet \n\t\t\tis guaranteed to expire between 13:30:55 and 14:30:55 on \n\t\t\t5/31/2019.\n\t\t

" + } + }, + "InstanceMatchCriteria": { + "target": "com.amazonaws.ec2#FleetInstanceMatchCriteria", + "traits": { + "smithy.api#documentation": "

Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All \n\t\t\tCapacity Reservations in the Fleet inherit this instance matching criteria.

\n

Currently, Capacity Reservation Fleets support open instance matching criteria \n\t\t\tonly. This means that instances that have matching attributes (instance type, platform, and \n\t\t\tAvailability Zone) run in the Capacity Reservations automatically. Instances do not need to \n\t\t\texplicitly target a Capacity Reservation Fleet to use its reserved capacity.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the Capacity Reservation Fleet. The tags are automatically assigned \n\t\t\tto the Capacity Reservations in the Fleet.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateCapacityReservationFleetResult": { + "type": "structure", + "members": { + "CapacityReservationFleetId": { + "target": "com.amazonaws.ec2#CapacityReservationFleetId", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationFleetId", + "smithy.api#documentation": "

The ID of the Capacity Reservation Fleet.

", + "smithy.api#xmlName": "capacityReservationFleetId" + } + }, + "State": { + "target": "com.amazonaws.ec2#CapacityReservationFleetState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The status of the Capacity Reservation Fleet.

", + "smithy.api#xmlName": "state" + } + }, + "TotalTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TotalTargetCapacity", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of capacity units for which the Capacity Reservation Fleet reserves capacity.

", + "smithy.api#xmlName": "totalTargetCapacity" + } + }, + "TotalFulfilledCapacity": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "TotalFulfilledCapacity", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The requested capacity units that have been successfully reserved.

", + "smithy.api#xmlName": "totalFulfilledCapacity" + } + }, + "InstanceMatchCriteria": { + "target": "com.amazonaws.ec2#FleetInstanceMatchCriteria", + "traits": { + "aws.protocols#ec2QueryName": "InstanceMatchCriteria", + "smithy.api#documentation": "

The instance matching criteria for the Capacity Reservation Fleet.

", + "smithy.api#xmlName": "instanceMatchCriteria" + } + }, + "AllocationStrategy": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AllocationStrategy", + "smithy.api#documentation": "

The allocation strategy used by the Capacity Reservation Fleet.

", + "smithy.api#xmlName": "allocationStrategy" + } + }, + "CreateTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreateTime", + "smithy.api#documentation": "

The date and time at which the Capacity Reservation Fleet was created.

", + "smithy.api#xmlName": "createTime" + } + }, + "EndDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "EndDate", + "smithy.api#documentation": "

The date and time at which the Capacity Reservation Fleet expires.

", + "smithy.api#xmlName": "endDate" + } + }, + "Tenancy": { + "target": "com.amazonaws.ec2#FleetCapacityReservationTenancy", + "traits": { + "aws.protocols#ec2QueryName": "Tenancy", + "smithy.api#documentation": "

Indicates the tenancy of Capacity Reservation Fleet.

", + "smithy.api#xmlName": "tenancy" + } + }, + "FleetCapacityReservations": { + "target": "com.amazonaws.ec2#FleetCapacityReservationSet", + "traits": { + "aws.protocols#ec2QueryName": "FleetCapacityReservationSet", + "smithy.api#documentation": "

Information about the individual Capacity Reservations in the Capacity Reservation Fleet.

", + "smithy.api#xmlName": "fleetCapacityReservationSet" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the Capacity Reservation Fleet.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateCapacityReservationRequest": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The instance type for which to reserve capacity. For more information, see Instance types in the Amazon EC2 User Guide.

", + "smithy.api#required": {} + } + }, + "InstancePlatform": { + "target": "com.amazonaws.ec2#CapacityReservationInstancePlatform", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of operating system for which to reserve capacity.

", + "smithy.api#required": {} + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone in which to create the Capacity Reservation.

" + } + }, + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of the Availability Zone in which to create the Capacity Reservation.

" + } + }, + "Tenancy": { + "target": "com.amazonaws.ec2#CapacityReservationTenancy", + "traits": { + "smithy.api#documentation": "

Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

\n " + } + }, + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of instances for which to reserve capacity.

\n

Valid range: 1 - 1000

", + "smithy.api#required": {} + } + }, + "EbsOptimized": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides\n\t\t\tdedicated throughput to Amazon EBS and an optimized configuration stack to provide\n\t\t\toptimal I/O performance. This optimization isn't available with all instance types.\n\t\t\tAdditional usage charges apply when using an EBS- optimized instance.

" + } + }, + "EphemeralStorage": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

\n Deprecated.\n

" + } + }, + "EndDate": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "smithy.api#documentation": "

The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity\n\t\t\tis released and you can no longer launch instances into it. The Capacity Reservation's state changes to\n\t\t\t\texpired when it reaches its end date and time.

\n

You must provide an EndDate value if EndDateType is\n\t\t\t\tlimited. Omit EndDate if EndDateType is\n\t\t\t\tunlimited.

\n

If the EndDateType is limited, the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify \n\t\t\t5/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": { + "target": "com.amazonaws.ec2#EndDateType", + "traits": { + "smithy.api#documentation": "

Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end\n\t\t\ttypes:

\n " + } + }, + "InstanceMatchCriteria": { + "target": "com.amazonaws.ec2#InstanceMatchCriteria", + "traits": { + "smithy.api#documentation": "

Indicates the type of instance launches that the Capacity Reservation accepts. The options\n\t\t\tinclude:

\n \n

Default: open\n

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the Capacity Reservation during launch.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#OutpostArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.

" + } + }, + "PlacementGroupArn": { + "target": "com.amazonaws.ec2#PlacementGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster placement group in which \n\t\t\tto create the Capacity Reservation. For more information, see \n\t\t\t\n\t\t\t\tCapacity Reservations for cluster placement groups in the \n\t\t\tAmazon EC2 User Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateCapacityReservationResult": { + "type": "structure", + "members": { + "CapacityReservation": { + "target": "com.amazonaws.ec2#CapacityReservation", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservation", + "smithy.api#documentation": "

Information about the Capacity Reservation.

", + "smithy.api#xmlName": "capacityReservation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateCarrierGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateCarrierGatewayRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateCarrierGatewayResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a carrier gateway. For more information about carrier gateways, see Carrier gateways in the Amazon Web Services Wavelength Developer Guide.

" + } + }, + "com.amazonaws.ec2#CreateCarrierGatewayRequest": { + "type": "structure", + "members": { + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC to associate with the carrier gateway.

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to associate with the carrier gateway.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateCarrierGatewayResult": { + "type": "structure", + "members": { + "CarrierGateway": { + "target": "com.amazonaws.ec2#CarrierGateway", + "traits": { + "aws.protocols#ec2QueryName": "CarrierGateway", + "smithy.api#documentation": "

Information about the carrier gateway.

", + "smithy.api#xmlName": "carrierGateway" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateClientVpnEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateClientVpnEndpointRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateClientVpnEndpointResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to \n\t\t\tenable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions \n\t\t\tare terminated.

" + } + }, + "com.amazonaws.ec2#CreateClientVpnEndpointRequest": { + "type": "structure", + "members": { + "ClientCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#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. Client CIDR range must have a size of at least /22 and must not be greater than /12.

", + "smithy.api#required": {} + } + }, + "ServerCertificateArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the server certificate. For more information, see \n\t\t\tthe Certificate Manager User Guide.

", + "smithy.api#required": {} + } + }, + "AuthenticationOptions": { + "target": "com.amazonaws.ec2#ClientVpnAuthenticationRequestList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Information about the authentication method to be used to authenticate clients.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "Authentication" + } + }, + "ConnectionLogOptions": { + "target": "com.amazonaws.ec2#ConnectionLogOptions", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Information about the client connection logging options.

\n

If you enable client connection logging, data about client connections is sent to a\n\t\t\tCloudwatch Logs log stream. The following information is logged:

\n ", + "smithy.api#required": {} + } + }, + "DnsServers": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can\n\t\t\thave 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": { + "target": "com.amazonaws.ec2#TransportProtocol", + "traits": { + "smithy.api#documentation": "

The transport protocol to be used by the VPN session.

\n

Default value: udp\n

" + } + }, + "VpnPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

\n

Valid Values: 443 | 1194\n

\n

Default Value: 443\n

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A brief description of the Client VPN endpoint.

" + } + }, + "SplitTunnel": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether split-tunnel is enabled on the Client VPN endpoint.

\n

By default, split-tunnel on a VPN endpoint is disabled.

\n

For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the \n\t\t\tClient VPN Administrator Guide.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without 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": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the Client VPN endpoint during creation.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#ClientVpnSecurityGroupIdSet", + "traits": { + "smithy.api#documentation": "

The IDs of one or more security groups to apply to the target network. You must also specify the ID of the VPC that contains the security groups.

", + "smithy.api#xmlName": "SecurityGroupId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#documentation": "

The ID of the VPC to associate with the Client VPN endpoint. If no security group IDs are specified in the request, the default security group for the VPC is applied.

" + } + }, + "SelfServicePortal": { + "target": "com.amazonaws.ec2#SelfServicePortal", + "traits": { + "smithy.api#documentation": "

Specify whether to enable the self-service portal for the Client VPN endpoint.

\n

Default Value: enabled\n

" + } + }, + "ClientConnectOptions": { + "target": "com.amazonaws.ec2#ClientConnectOptions", + "traits": { + "smithy.api#documentation": "

The options for managing connection authorization for new client connections.

" + } + }, + "SessionTimeoutHours": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum VPN session duration time in hours.

\n

Valid values: 8 | 10 | 12 | 24\n

\n

Default value: 24\n

" + } + }, + "ClientLoginBannerOptions": { + "target": "com.amazonaws.ec2#ClientLoginBannerOptions", + "traits": { + "smithy.api#documentation": "

Options for enabling a customizable text banner that will be displayed on\n\t\t\tAmazon Web Services provided clients when a VPN session is established.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateClientVpnEndpointResult": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientVpnEndpointId", + "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", + "smithy.api#xmlName": "clientVpnEndpointId" + } + }, + "Status": { + "target": "com.amazonaws.ec2#ClientVpnEndpointStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The current state of the Client VPN endpoint.

", + "smithy.api#xmlName": "status" + } + }, + "DnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DnsName", + "smithy.api#documentation": "

The DNS name to be used by clients when establishing their VPN session.

", + "smithy.api#xmlName": "dnsName" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateClientVpnRoute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateClientVpnRouteRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateClientVpnRouteResult" + }, + "traits": { + "smithy.api#documentation": "

Adds a route to a network to a Client VPN endpoint. Each Client VPN endpoint has a route table that describes the \n\t\t\tavailable destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks.

" + } + }, + "com.amazonaws.ec2#CreateClientVpnRouteRequest": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Client VPN endpoint to which to add the route.

", + "smithy.api#required": {} + } + }, + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, of the route destination. For example:

\n ", + "smithy.api#required": {} + } + }, + "TargetVpcSubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the subnet through which you want to route traffic. The specified subnet must be\n\t\t\tan existing target network of the Client VPN endpoint.

\n

Alternatively, if you're adding a route for the local network, specify local.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A brief description of the route.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateClientVpnRouteResult": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.ec2#ClientVpnRouteStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The current state of the route.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateCoipCidr": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateCoipCidrRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateCoipCidrResult" + }, + "traits": { + "smithy.api#documentation": "

\n Creates a range of customer-owned IP addresses.\n

" + } + }, + "com.amazonaws.ec2#CreateCoipCidrRequest": { + "type": "structure", + "members": { + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n A customer-owned IP address range to create.\n

", + "smithy.api#required": {} + } + }, + "CoipPoolId": { + "target": "com.amazonaws.ec2#Ipv4PoolCoipId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n The ID of the address pool.\n

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateCoipCidrResult": { + "type": "structure", + "members": { + "CoipCidr": { + "target": "com.amazonaws.ec2#CoipCidr", + "traits": { + "aws.protocols#ec2QueryName": "CoipCidr", + "smithy.api#documentation": "

\n Information about a range of customer-owned IP addresses.\n

", + "smithy.api#xmlName": "coipCidr" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateCoipPool": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateCoipPoolRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateCoipPoolResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a pool of customer-owned IP (CoIP) addresses.

" + } + }, + "com.amazonaws.ec2#CreateCoipPoolRequest": { + "type": "structure", + "members": { + "LocalGatewayRouteTableId": { + "target": "com.amazonaws.ec2#LocalGatewayRoutetableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n The ID of the local gateway route table.\n

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

\n The tags to assign to the CoIP address pool.\n

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateCoipPoolResult": { + "type": "structure", + "members": { + "CoipPool": { + "target": "com.amazonaws.ec2#CoipPool", + "traits": { + "aws.protocols#ec2QueryName": "CoipPool", + "smithy.api#documentation": "

Information about the CoIP address pool.

", + "smithy.api#xmlName": "coipPool" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateCustomerGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateCustomerGatewayRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateCustomerGatewayResult" + }, + "traits": { + "smithy.api#documentation": "

Provides information to Amazon Web Services about your customer gateway device. The\n customer gateway device is the appliance at your end of the VPN connection. You\n must provide the IP address of the customer gateway device’s external\n interface. The IP address must be static and can be behind a device performing network\n address translation (NAT).

\n

For devices that use Border Gateway Protocol (BGP), you can also provide the device's\n BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network.\n If you don't have an ASN already, you can use a private ASN. For more information, see \n Customer gateway \n options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.

\n

To create more than one customer gateway with the same VPN type, IP address, and\n BGP ASN, specify a unique device name for each customer gateway. An identical request\n returns information about the existing customer gateway; it doesn't create a new customer\n gateway.

" + } + }, + "com.amazonaws.ec2#CreateCustomerGatewayRequest": { + "type": "structure", + "members": { + "BgpAsn": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

For devices that support BGP, the customer gateway's BGP ASN.

\n

Default: 65000

" + } + }, + "PublicIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

\n This member has been deprecated. The Internet-routable IP address for the customer gateway's outside interface. The\n address must be static.

" + } + }, + "CertificateArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the customer gateway certificate.

" + } + }, + "Type": { + "target": "com.amazonaws.ec2#GatewayType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of VPN connection that this customer gateway supports\n (ipsec.1).

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the customer gateway.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DeviceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A name for the customer gateway device.

\n

Length Constraints: Up to 255 characters.

" + } + }, + "IpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

\n IPv4 address for the customer gateway device's outside interface. The address must be static.\n

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for CreateCustomerGateway.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateCustomerGatewayResult": { + "type": "structure", + "members": { + "CustomerGateway": { + "target": "com.amazonaws.ec2#CustomerGateway", + "traits": { + "aws.protocols#ec2QueryName": "CustomerGateway", + "smithy.api#documentation": "

Information about the customer gateway.

", + "smithy.api#xmlName": "customerGateway" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of CreateCustomerGateway.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateDefaultSubnet": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateDefaultSubnetRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateDefaultSubnetResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a default subnet with a size /20 IPv4 CIDR block in the\n specified Availability Zone in your default VPC. You can have only one default subnet\n per Availability Zone. For more information, see Creating a default\n subnet in the Amazon Virtual Private Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#CreateDefaultSubnetRequest": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Availability Zone in which to create the default subnet.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Ipv6Native": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to create an IPv6 only subnet. If you already have a default subnet\n for this Availability Zone, you must delete it before you can create an IPv6 only subnet.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateDefaultSubnetResult": { + "type": "structure", + "members": { + "Subnet": { + "target": "com.amazonaws.ec2#Subnet", + "traits": { + "aws.protocols#ec2QueryName": "Subnet", + "smithy.api#documentation": "

Information about the subnet.

", + "smithy.api#xmlName": "subnet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateDefaultVpc": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateDefaultVpcRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateDefaultVpcResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a default VPC with a size /16 IPv4 CIDR block and a default subnet\n\t\t\tin each Availability Zone. For more information about the components of a default VPC,\n\t\t\tsee Default VPC and\n\t\t\tdefault subnets in the Amazon Virtual Private Cloud User Guide. You cannot\n\t\t\tspecify the components of the default VPC yourself.

\n

If you deleted your previous default VPC, you can create a default VPC. You cannot have\n\t\t\tmore than one default VPC per Region.

\n

If your account supports EC2-Classic, you cannot use this action to create a default VPC\n\t\t\tin a Region that supports EC2-Classic. If you want a default VPC in a Region that\n\t\t\tsupports EC2-Classic, see \"I really want a default VPC for my existing EC2 account. Is\n\t\t\tthat possible?\" in the Default VPCs\n\t\t\tFAQ.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " + } + }, + "com.amazonaws.ec2#CreateDefaultVpcRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateDefaultVpcResult": { + "type": "structure", + "members": { + "Vpc": { + "target": "com.amazonaws.ec2#Vpc", + "traits": { + "aws.protocols#ec2QueryName": "Vpc", + "smithy.api#documentation": "

Information about the VPC.

", + "smithy.api#xmlName": "vpc" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateDhcpOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateDhcpOptionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateDhcpOptionsResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a set of DHCP options for your VPC. After creating the set, you must\n\t\t\t\tassociate it with the VPC, causing all existing and new instances that you launch in\n\t\t\t\tthe VPC to use this set of DHCP options. The following are the individual DHCP\n\t\t\t\toptions you can specify. For more information about the options, see RFC 2132.

\n \n

Your VPC automatically starts out with a set of DHCP options that includes only a DNS\n\t\t\tserver that we provide (AmazonProvidedDNS). If you create a set of options, and if your\n\t\t\tVPC has an internet gateway, make sure to set the domain-name-servers\n\t\t\toption either to AmazonProvidedDNS or to a domain name server of your\n\t\t\tchoice. For more information, see DHCP options sets in the\n\t\t\tAmazon Virtual Private Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#CreateDhcpOptionsRequest": { + "type": "structure", + "members": { + "DhcpConfigurations": { + "target": "com.amazonaws.ec2#NewDhcpConfigurationList", + "traits": { + "aws.protocols#ec2QueryName": "DhcpConfiguration", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A DHCP configuration option.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "dhcpConfiguration" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the DHCP option.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateDhcpOptionsResult": { + "type": "structure", + "members": { + "DhcpOptions": { + "target": "com.amazonaws.ec2#DhcpOptions", + "traits": { + "aws.protocols#ec2QueryName": "DhcpOptions", + "smithy.api#documentation": "

A set of DHCP options.

", + "smithy.api#xmlName": "dhcpOptions" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateEgressOnlyInternetGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateEgressOnlyInternetGatewayRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateEgressOnlyInternetGatewayResult" + }, + "traits": { + "smithy.api#documentation": "

[IPv6 only] Creates an egress-only internet gateway for your VPC. An egress-only\n\t\t\tinternet gateway is used to enable outbound communication over IPv6 from instances in\n\t\t\tyour VPC to the internet, and prevents hosts outside of your VPC from initiating an IPv6\n\t\t\tconnection with your instance.

" + } + }, + "com.amazonaws.ec2#CreateEgressOnlyInternetGatewayRequest": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n\t\t\trequest. For more information, see How to ensure\n\t\t\t\tidempotency.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC for which to create the egress-only internet gateway.

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the egress-only internet gateway.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateEgressOnlyInternetGatewayResult": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n\t\t\trequest.

", + "smithy.api#xmlName": "clientToken" + } + }, + "EgressOnlyInternetGateway": { + "target": "com.amazonaws.ec2#EgressOnlyInternetGateway", + "traits": { + "aws.protocols#ec2QueryName": "EgressOnlyInternetGateway", + "smithy.api#documentation": "

Information about the egress-only internet gateway.

", + "smithy.api#xmlName": "egressOnlyInternetGateway" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateFleet": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateFleetRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateFleetResult" + }, + "traits": { + "smithy.api#documentation": "

Launches an EC2 Fleet.

\n

You can create a single EC2 Fleet that includes multiple launch specifications that vary by\n instance type, AMI, Availability Zone, or subnet.

\n

For more information, see EC2 Fleet in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#CreateFleetError": { + "type": "structure", + "members": { + "LaunchTemplateAndOverrides": { + "target": "com.amazonaws.ec2#LaunchTemplateAndOverridesResponse", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateAndOverrides", + "smithy.api#documentation": "

The launch templates and overrides that were used for launching the instances. The\n values that you specify in the Overrides replace the values in the launch template.

", + "smithy.api#xmlName": "launchTemplateAndOverrides" + } + }, + "Lifecycle": { + "target": "com.amazonaws.ec2#InstanceLifecycle", + "traits": { + "aws.protocols#ec2QueryName": "Lifecycle", + "smithy.api#documentation": "

Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.

", + "smithy.api#xmlName": "lifecycle" + } + }, + "ErrorCode": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ErrorCode", + "smithy.api#documentation": "

The error code that indicates why the instance could not be launched. For more\n information about error codes, see Error codes.

", + "smithy.api#xmlName": "errorCode" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ErrorMessage", + "smithy.api#documentation": "

The error message that describes why the instance could not be launched. For more\n information about error messages, see Error codes.

", + "smithy.api#xmlName": "errorMessage" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the instances that could not be launched by the fleet.

" + } + }, + "com.amazonaws.ec2#CreateFleetErrorsSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CreateFleetError", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CreateFleetInstance": { + "type": "structure", + "members": { + "LaunchTemplateAndOverrides": { + "target": "com.amazonaws.ec2#LaunchTemplateAndOverridesResponse", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateAndOverrides", + "smithy.api#documentation": "

The launch templates and overrides that were used for launching the instances. The\n values that you specify in the Overrides replace the values in the launch template.

", + "smithy.api#xmlName": "launchTemplateAndOverrides" + } + }, + "Lifecycle": { + "target": "com.amazonaws.ec2#InstanceLifecycle", + "traits": { + "aws.protocols#ec2QueryName": "Lifecycle", + "smithy.api#documentation": "

Indicates if the instance that was launched is a Spot Instance or On-Demand Instance.

", + "smithy.api#xmlName": "lifecycle" + } + }, + "InstanceIds": { + "target": "com.amazonaws.ec2#InstanceIdsSet", + "traits": { + "aws.protocols#ec2QueryName": "InstanceIds", + "smithy.api#documentation": "

The IDs of the instances.

", + "smithy.api#xmlName": "instanceIds" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type.

", + "smithy.api#xmlName": "instanceType" + } + }, + "Platform": { + "target": "com.amazonaws.ec2#PlatformValues", + "traits": { + "aws.protocols#ec2QueryName": "Platform", + "smithy.api#documentation": "

The value is Windows for Windows instances. Otherwise, the value is\n blank.

", + "smithy.api#xmlName": "platform" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the instances that were launched by the fleet.

" + } + }, + "com.amazonaws.ec2#CreateFleetInstancesSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CreateFleetInstance", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CreateFleetRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.

" + } + }, + "SpotOptions": { + "target": "com.amazonaws.ec2#SpotOptionsRequest", + "traits": { + "smithy.api#documentation": "

Describes the configuration of Spot Instances in an EC2 Fleet.

" + } + }, + "OnDemandOptions": { + "target": "com.amazonaws.ec2#OnDemandOptionsRequest", + "traits": { + "smithy.api#documentation": "

Describes the configuration of On-Demand Instances in an EC2 Fleet.

" + } + }, + "ExcessCapacityTerminationPolicy": { + "target": "com.amazonaws.ec2#FleetExcessCapacityTerminationPolicy", + "traits": { + "smithy.api#documentation": "

Indicates whether running instances should be terminated if the total target capacity of\n the EC2 Fleet is decreased below the current size of the EC2 Fleet.

\n

Supported only for fleets of type maintain.

" + } + }, + "LaunchTemplateConfigs": { + "target": "com.amazonaws.ec2#FleetLaunchTemplateConfigListRequest", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The configuration for the EC2 Fleet.

", + "smithy.api#required": {} + } + }, + "TargetCapacitySpecification": { + "target": "com.amazonaws.ec2#TargetCapacitySpecificationRequest", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of units to request.

", + "smithy.api#required": {} + } + }, + "TerminateInstancesWithExpiration": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether running instances should be terminated when the EC2 Fleet expires.

" + } + }, + "Type": { + "target": "com.amazonaws.ec2#FleetType", + "traits": { + "smithy.api#documentation": "

The fleet type. The default value is maintain.

\n \n

For more information, see EC2 Fleet\n request types in the Amazon EC2 User Guide.

" + } + }, + "ValidFrom": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "smithy.api#documentation": "

The start date and time of the request, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).\n The default is to start fulfilling the request immediately.

" + } + }, + "ValidUntil": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "smithy.api#documentation": "

The end date and time of the request, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).\n 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": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for\n fleets of type maintain. For more information, see EC2 Fleet\n health checks in the Amazon EC2 User Guide.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The key-value pair for tagging the EC2 Fleet request on creation. For more information, see \n Tagging your resources.

\n

If the fleet type is instant, specify a resource type of fleet \n to tag the fleet or instance to tag the instances at launch.

\n

If the fleet type is maintain or request, specify a resource\n type of fleet to tag the fleet. You cannot specify a resource type of\n instance. To tag instances at launch, specify the tags in a launch template.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "Context": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Reserved.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateFleetResult": { + "type": "structure", + "members": { + "FleetId": { + "target": "com.amazonaws.ec2#FleetId", + "traits": { + "aws.protocols#ec2QueryName": "FleetId", + "smithy.api#documentation": "

The ID of the EC2 Fleet.

", + "smithy.api#xmlName": "fleetId" + } + }, + "Errors": { + "target": "com.amazonaws.ec2#CreateFleetErrorsSet", + "traits": { + "aws.protocols#ec2QueryName": "ErrorSet", + "smithy.api#documentation": "

Information about the instances that could not be launched by the fleet. Supported only for\n fleets of type instant.

", + "smithy.api#xmlName": "errorSet" + } + }, + "Instances": { + "target": "com.amazonaws.ec2#CreateFleetInstancesSet", + "traits": { + "aws.protocols#ec2QueryName": "FleetInstanceSet", + "smithy.api#documentation": "

Information about the instances that were launched by the fleet. Supported only for\n fleets of type instant.

", + "smithy.api#xmlName": "fleetInstanceSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateFlowLogs": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateFlowLogsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateFlowLogsResult" + }, + "traits": { + "smithy.api#documentation": "

Creates one or more flow logs to capture information about IP traffic for a specific network interface,\n subnet, or VPC.

\n

Flow log data for a monitored network interface is recorded as flow log records, which are log events \n consisting of fields that describe the traffic flow. For more information, see \n Flow log records \n in the Amazon Virtual Private Cloud User Guide.

\n

When publishing to CloudWatch Logs, flow log records are published to a log group, and each network \n interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all \n of the monitored network interfaces are published to a single log file object that is stored in the specified \n bucket.

\n

For more information, see VPC Flow Logs in the Amazon Virtual Private Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#CreateFlowLogsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

" + } + }, + "DeliverLogsPermissionArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role that allows Amazon EC2 to publish flow logs to a CloudWatch Logs log group in\n your account.

\n

This parameter is required if the destination type is cloud-watch-logs\n and unsupported otherwise.

" + } + }, + "DeliverCrossAccountRole": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts.

" + } + }, + "LogGroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.

\n

This parameter is valid only if the destination type is cloud-watch-logs.

" + } + }, + "ResourceIds": { + "target": "com.amazonaws.ec2#FlowLogResourceIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the resources to monitor. For example, if the resource type is\n VPC, specify the IDs of the VPCs.

\n

Constraints: Maximum of 25 for transit gateway resource types. Maximum of 1000 for the\n other resource types.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "ResourceId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#FlowLogsResourceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of resource to monitor.

", + "smithy.api#required": {} + } + }, + "TrafficType": { + "target": "com.amazonaws.ec2#TrafficType", + "traits": { + "smithy.api#documentation": "

The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic).\n This parameter is not supported for transit gateway resource types. It is required for\n the other resource types.

" + } + }, + "LogDestinationType": { + "target": "com.amazonaws.ec2#LogDestinationType", + "traits": { + "smithy.api#documentation": "

The type of destination for the flow log data.

\n

Default: cloud-watch-logs\n

" + } + }, + "LogDestination": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The destination for the flow log data. The meaning of this parameter depends on the destination type.

\n " + } + }, + "LogFormat": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The fields to include in the flow log record. List the fields in the order in which\n they should appear. If you omit this parameter, the flow log is created using the\n default format. If you specify this parameter, you must include at least one\n field. For more information about the available fields, see Flow log\n records in the Amazon VPC User Guide or Transit Gateway Flow Log\n records in the Amazon Web Services Transit Gateway Guide.

\n

Specify the fields using the ${field-id} format, separated by spaces. For\n the CLI, surround this parameter value with single quotes on Linux or\n double quotes on Windows.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the flow logs.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "MaxAggregationInterval": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. \n The possible values are 60 seconds (1 minute) or 600 seconds (10 minutes).\n This parameter must be 60 seconds for transit gateway resource types.

\n

When a network interface is attached to a Nitro-based\n instance, the aggregation interval is always 60 seconds or less, regardless\n of the value that you specify.

\n

Default: 600

" + } + }, + "DestinationOptions": { + "target": "com.amazonaws.ec2#DestinationOptionsRequest", + "traits": { + "smithy.api#documentation": "

The destination options.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateFlowLogsResult": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", + "smithy.api#xmlName": "clientToken" + } + }, + "FlowLogIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "FlowLogIdSet", + "smithy.api#documentation": "

The IDs of the flow logs.

", + "smithy.api#xmlName": "flowLogIdSet" + } + }, + "Unsuccessful": { + "target": "com.amazonaws.ec2#UnsuccessfulItemSet", + "traits": { + "aws.protocols#ec2QueryName": "Unsuccessful", + "smithy.api#documentation": "

Information about the flow logs that could not be created successfully.

", + "smithy.api#xmlName": "unsuccessful" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateFpgaImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateFpgaImageRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateFpgaImageResult" + }, + "traits": { + "smithy.api#documentation": "

Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).

\n

The create operation is asynchronous. To verify that the AFI is ready for use, \n check the output logs.

\n

An AFI contains the FPGA bitstream that is ready to download to an FPGA. \n You can securely deploy an AFI on multiple FPGA-accelerated instances.\n For more information, see the Amazon Web Services FPGA Hardware Development Kit.

" + } + }, + "com.amazonaws.ec2#CreateFpgaImageRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "InputStorageLocation": { + "target": "com.amazonaws.ec2#StorageLocation", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The location of the encrypted design checkpoint in Amazon S3. The input must be a tarball.

", + "smithy.api#required": {} + } + }, + "LogsStorageLocation": { + "target": "com.amazonaws.ec2#StorageLocation", + "traits": { + "smithy.api#documentation": "

The location in Amazon S3 for the output logs.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the AFI.

" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A name for the AFI.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. \n For more information, see Ensuring Idempotency.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the FPGA image during creation.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateFpgaImageResult": { + "type": "structure", + "members": { + "FpgaImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "FpgaImageId", + "smithy.api#documentation": "

The FPGA image identifier (AFI ID).

", + "smithy.api#xmlName": "fpgaImageId" + } + }, + "FpgaImageGlobalId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "FpgaImageGlobalId", + "smithy.api#documentation": "

The global FPGA image identifier (AGFI ID).

", + "smithy.api#xmlName": "fpgaImageGlobalId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateImageRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateImageResult" + }, + "traits": { + "smithy.api#documentation": "

Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance \n \tthat is either running or stopped.

\n

By default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can \n\t\t\t\t\ttake snapshots of the attached volumes while data is at rest, in order to ensure a consistent \n\t\t\t\t\tstate. You can set the NoReboot parameter to true in the API request, \n\t\t\t\t\tor use the --no-reboot option in the CLI to prevent Amazon EC2 from shutting down and \n\t\t\t\t\trebooting the instance.

\n \n

If you choose to bypass the shutdown and reboot process by setting the NoReboot \n\t\t\t\t\tparameter to true in the API request, or by using the --no-reboot option \n\t\t\t\t\tin the CLI, we can't guarantee the file system integrity of the created image.

\n \n

If you customized your instance with instance store volumes or Amazon EBS volumes in addition to the root device volume, the \n \tnew AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, \n \tthe instance automatically launches with those additional volumes.

\n

For more information, see Create an Amazon EBS-backed Linux\n AMI in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#CreateImageRequest": { + "type": "structure", + "members": { + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#BlockDeviceMappingRequestList", + "traits": { + "aws.protocols#ec2QueryName": "BlockDeviceMapping", + "smithy.api#documentation": "

The block device mappings. This parameter cannot be used to modify the encryption \n \t\tstatus of existing volumes or snapshots. To create an AMI with encrypted snapshots, \n \t\tuse the CopyImage action.

", + "smithy.api#xmlName": "blockDeviceMapping" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the new image.

", + "smithy.api#xmlName": "description" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "instanceId" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A name for the new image.

\n

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", + "smithy.api#required": {}, + "smithy.api#xmlName": "name" + } + }, + "NoReboot": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "NoReboot", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

By default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can \n\t\t\t\t\ttake snapshots of the attached volumes while data is at rest, in order to ensure a consistent \n\t\t\t\t\tstate. You can set the NoReboot parameter to true in the API request, \n\t\t\t\t\tor use the --no-reboot option in the CLI to prevent Amazon EC2 from shutting down and \n\t\t\t\t\trebooting the instance.

\n \n

If you choose to bypass the shutdown and reboot process by setting the NoReboot \n\t\t\t\t\tparameter to true in the API request, or by using the --no-reboot option \n\t\t\t\t\tin the CLI, we can't guarantee the file system integrity of the created image.

\n \n

Default: false (follow standard reboot process)

", + "smithy.api#xmlName": "noReboot" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the\n snapshots, or both.

\n \n

If you specify other values for ResourceType, the request fails.

\n

To tag an AMI or snapshot after it has been created, see CreateTags.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateImageResult": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the new AMI.

", + "smithy.api#xmlName": "imageId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateInstanceConnectEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateInstanceConnectEndpointRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateInstanceConnectEndpointResult" + }, + "traits": { + "smithy.api#documentation": "

Creates an EC2 Instance Connect Endpoint.

\n

An EC2 Instance Connect Endpoint allows you to connect to a resource, without\n requiring the resource to have a public IPv4 address. For more information, see Connect to your resources without requiring a public IPv4 address using EC2\n Instance Connect Endpoint in the Amazon EC2 User\n Guide.

" + } + }, + "com.amazonaws.ec2#CreateInstanceConnectEndpointRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the subnet in which to create the EC2 Instance Connect Endpoint.

", + "smithy.api#required": {} + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#SecurityGroupIdStringListRequest", + "traits": { + "smithy.api#documentation": "

One or more security groups to associate with the endpoint. If you don't specify a security group, \n the default security group for your VPC will be associated with the endpoint.

", + "smithy.api#xmlName": "SecurityGroupId" + } + }, + "PreserveClientIp": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether your client's IP address is preserved as the source. The value is true or false.

\n \n

Default: true\n

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", + "smithy.api#idempotencyToken": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the EC2 Instance Connect Endpoint during creation.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateInstanceConnectEndpointResult": { + "type": "structure", + "members": { + "InstanceConnectEndpoint": { + "target": "com.amazonaws.ec2#Ec2InstanceConnectEndpoint", + "traits": { + "aws.protocols#ec2QueryName": "InstanceConnectEndpoint", + "smithy.api#documentation": "

Information about the EC2 Instance Connect Endpoint.

", + "smithy.api#xmlName": "instanceConnectEndpoint" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive idempotency token provided by the client in the the request.

", + "smithy.api#xmlName": "clientToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateInstanceEventWindow": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateInstanceEventWindowRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateInstanceEventWindowResult" + }, + "traits": { + "smithy.api#documentation": "

Creates an event window in which scheduled events for the associated Amazon EC2 instances can\n run.

\n

You can define either a set of time ranges or a cron expression when creating the event\n window, but not both. All event window times are in UTC.

\n

You can create up to 200 event windows per Amazon Web Services Region.

\n

When you create the event window, targets (instance IDs, Dedicated Host IDs, or tags)\n are not yet associated with it. To ensure that the event window can be used, you must\n associate one or more targets with it by using the AssociateInstanceEventWindow API.

\n \n

Event windows are applicable only for scheduled events that stop, reboot, or\n terminate instances.

\n

Event windows are not applicable for:

\n \n \n

For more information, see Define event windows for scheduled\n events in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#CreateInstanceEventWindowRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the event window.

" + } + }, + "TimeRanges": { + "target": "com.amazonaws.ec2#InstanceEventWindowTimeRangeRequestSet", + "traits": { + "smithy.api#documentation": "

The time range for the event window. If you specify a time range, you can't specify a cron\n expression.

", + "smithy.api#xmlName": "TimeRange" + } + }, + "CronExpression": { + "target": "com.amazonaws.ec2#InstanceEventWindowCronExpression", + "traits": { + "smithy.api#documentation": "

The cron expression for the event window, for example, * 0-4,20-23 * * 1,5. If\n you specify a cron expression, you can't specify a time range.

\n

Constraints:

\n \n

For more information about cron expressions, see cron on the Wikipedia\n website.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the event window.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateInstanceEventWindowResult": { + "type": "structure", + "members": { + "InstanceEventWindow": { + "target": "com.amazonaws.ec2#InstanceEventWindow", + "traits": { + "aws.protocols#ec2QueryName": "InstanceEventWindow", + "smithy.api#documentation": "

Information about the event window.

", + "smithy.api#xmlName": "instanceEventWindow" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateInstanceExportTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateInstanceExportTaskRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateInstanceExportTaskResult" + }, + "traits": { + "smithy.api#documentation": "

Exports a running or stopped instance to an Amazon S3 bucket.

\n

For information about the supported operating systems, image formats, and known limitations\n for the types of instances you can export, see Exporting an instance as a VM Using VM Import/Export\n in the VM Import/Export User Guide.

" + } + }, + "com.amazonaws.ec2#CreateInstanceExportTaskRequest": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the conversion task or the resource being exported. The maximum length is 255 characters.

", + "smithy.api#xmlName": "description" + } + }, + "ExportToS3Task": { + "target": "com.amazonaws.ec2#ExportToS3TaskSpecification", + "traits": { + "aws.protocols#ec2QueryName": "ExportToS3", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The format and location for an export instance task.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "exportToS3" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "instanceId" + } + }, + "TargetEnvironment": { + "target": "com.amazonaws.ec2#ExportEnvironment", + "traits": { + "aws.protocols#ec2QueryName": "TargetEnvironment", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The target virtualization environment.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "targetEnvironment" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the export instance task during creation.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateInstanceExportTaskResult": { + "type": "structure", + "members": { + "ExportTask": { + "target": "com.amazonaws.ec2#ExportTask", + "traits": { + "aws.protocols#ec2QueryName": "ExportTask", + "smithy.api#documentation": "

Information about the export instance task.

", + "smithy.api#xmlName": "exportTask" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateInternetGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateInternetGatewayRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateInternetGatewayResult" + }, + "traits": { + "smithy.api#documentation": "

Creates an internet gateway for use with a VPC. After creating the internet gateway,\n\t\t\tyou attach it to a VPC using AttachInternetGateway.

\n

For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#CreateInternetGatewayRequest": { + "type": "structure", + "members": { + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the internet gateway.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateInternetGatewayResult": { + "type": "structure", + "members": { + "InternetGateway": { + "target": "com.amazonaws.ec2#InternetGateway", + "traits": { + "aws.protocols#ec2QueryName": "InternetGateway", + "smithy.api#documentation": "

Information about the internet gateway.

", + "smithy.api#xmlName": "internetGateway" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateIpam": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateIpamRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateIpamResult" + }, + "traits": { + "smithy.api#documentation": "

Create an IPAM. Amazon VPC IP Address Manager (IPAM) is a VPC feature that you can use\n to automate your IP address management workflows including assigning, tracking,\n troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts\n throughout your Amazon Web Services Organization.

\n

For more information, see Create an IPAM in the Amazon VPC IPAM User Guide.\n

" + } + }, + "com.amazonaws.ec2#CreateIpamPool": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateIpamPoolRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateIpamPoolResult" + }, + "traits": { + "smithy.api#documentation": "

Create an IP address pool for Amazon VPC IP Address Manager (IPAM). In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.

\n

For more information, see Create a top-level pool in the Amazon VPC IPAM User Guide.\n

" + } + }, + "com.amazonaws.ec2#CreateIpamPoolRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamScopeId": { + "target": "com.amazonaws.ec2#IpamScopeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the scope in which you would like to create the IPAM pool.

", + "smithy.api#required": {} + } + }, + "Locale": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you do not choose a locale, resources in Regions others than the IPAM's home region cannot use CIDRs from this pool.

\n

Possible values: Any Amazon Web Services Region, such as us-east-1.

" + } + }, + "SourceIpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#documentation": "

The ID of the source IPAM pool. Use this option to create a pool within an existing pool. Note that the CIDR you provision for the pool within the source pool must be available in the source pool's CIDR range.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the IPAM pool.

" + } + }, + "AddressFamily": { + "target": "com.amazonaws.ec2#AddressFamily", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool.

", + "smithy.api#required": {} + } + }, + "AutoImport": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

If selected, IPAM will continuously look for resources within the CIDR range of this pool \n and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for\n these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import \n a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently \n marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM \n discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.\n

\n

A locale must be set on the pool for this feature to work.

" + } + }, + "PubliclyAdvertisable": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Determines if the pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4.

" + } + }, + "AllocationMinNetmaskLength": { + "target": "com.amazonaws.ec2#IpamNetmaskLength", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be \n less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

" + } + }, + "AllocationMaxNetmaskLength": { + "target": "com.amazonaws.ec2#IpamNetmaskLength", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be \n greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

" + } + }, + "AllocationDefaultNetmaskLength": { + "target": "com.amazonaws.ec2#IpamNetmaskLength", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, \n new allocations will default to 10.0.0.0/16.

" + } + }, + "AllocationResourceTags": { + "target": "com.amazonaws.ec2#RequestIpamResourceTagList", + "traits": { + "smithy.api#documentation": "

Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.

", + "smithy.api#xmlName": "AllocationResourceTag" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

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.\n 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.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "AwsService": { + "target": "com.amazonaws.ec2#IpamPoolAwsService", + "traits": { + "smithy.api#documentation": "

Limits which service in Amazon Web Services that the pool can be used in. \"ec2\", for example, allows users to use space for Elastic IP addresses and VPCs.

" + } + }, + "PublicIpSource": { + "target": "com.amazonaws.ec2#IpamPoolPublicIpSource", + "traits": { + "smithy.api#documentation": "

The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is byoip. For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide. \n By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool if PublicIpSource is amazon. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateIpamPoolResult": { + "type": "structure", + "members": { + "IpamPool": { + "target": "com.amazonaws.ec2#IpamPool", + "traits": { + "aws.protocols#ec2QueryName": "IpamPool", + "smithy.api#documentation": "

Information about the IPAM pool created.

", + "smithy.api#xmlName": "ipamPool" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateIpamRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the IPAM.

" + } + }, + "OperatingRegions": { + "target": "com.amazonaws.ec2#AddIpamOperatingRegionSet", + "traits": { + "smithy.api#documentation": "

The operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

\n

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.\n

", + "smithy.api#xmlName": "OperatingRegion" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

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.\n 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.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateIpamResourceDiscovery": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateIpamResourceDiscoveryRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateIpamResourceDiscoveryResult" + }, + "traits": { + "smithy.api#documentation": "

Creates an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

" + } + }, + "com.amazonaws.ec2#CreateIpamResourceDiscoveryRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the IPAM resource discovery.

" + } + }, + "OperatingRegions": { + "target": "com.amazonaws.ec2#AddIpamOperatingRegionSet", + "traits": { + "smithy.api#documentation": "

Operating Regions for the IPAM resource discovery. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

", + "smithy.api#xmlName": "OperatingRegion" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

Tag specifications for the IPAM resource discovery.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A client token for the IPAM resource discovery.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateIpamResourceDiscoveryResult": { + "type": "structure", + "members": { + "IpamResourceDiscovery": { + "target": "com.amazonaws.ec2#IpamResourceDiscovery", + "traits": { + "aws.protocols#ec2QueryName": "IpamResourceDiscovery", + "smithy.api#documentation": "

An IPAM resource discovery.

", + "smithy.api#xmlName": "ipamResourceDiscovery" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateIpamResult": { + "type": "structure", + "members": { + "Ipam": { + "target": "com.amazonaws.ec2#Ipam", + "traits": { + "aws.protocols#ec2QueryName": "Ipam", + "smithy.api#documentation": "

Information about the IPAM created.

", + "smithy.api#xmlName": "ipam" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateIpamScope": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateIpamScopeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateIpamScopeResult" + }, + "traits": { + "smithy.api#documentation": "

Create an IPAM scope. In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.

\n

For more information, see Add a scope in the Amazon VPC IPAM User Guide.

" + } + }, + "com.amazonaws.ec2#CreateIpamScopeRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamId": { + "target": "com.amazonaws.ec2#IpamId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the IPAM for which you're creating this scope.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the scope you're creating.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

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.\n 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.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateIpamScopeResult": { + "type": "structure", + "members": { + "IpamScope": { + "target": "com.amazonaws.ec2#IpamScope", + "traits": { + "aws.protocols#ec2QueryName": "IpamScope", + "smithy.api#documentation": "

Information about the created scope.

", + "smithy.api#xmlName": "ipamScope" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateKeyPair": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateKeyPairRequest" + }, + "output": { + "target": "com.amazonaws.ec2#KeyPair" + }, + "traits": { + "smithy.api#documentation": "

Creates an ED25519 or 2048-bit RSA key pair with the specified name and in the\n specified PEM or PPK format. Amazon EC2 stores the public key and displays the private\n key for you to save to a file. The private key is returned as an unencrypted PEM encoded\n PKCS#1 private key or an unencrypted PPK formatted private key for use with PuTTY. If a\n key with the specified name already exists, Amazon EC2 returns an error.

\n

The key pair returned to you is available only in the Amazon Web Services Region in which you create it.\n If you prefer, you can create your own key pair using a third-party tool and upload it\n to any Region using ImportKeyPair.

\n

You can have up to 5,000 key pairs per Amazon Web Services Region.

\n

For more information, see Amazon EC2 key pairs in the\n Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#CreateKeyPairRequest": { + "type": "structure", + "members": { + "KeyName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A unique name for the key pair.

\n

Constraints: Up to 255 ASCII characters

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "KeyType": { + "target": "com.amazonaws.ec2#KeyType", + "traits": { + "smithy.api#documentation": "

The type of key pair. Note that ED25519 keys are not supported for Windows instances.

\n

Default: rsa\n

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the new key pair.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "KeyFormat": { + "target": "com.amazonaws.ec2#KeyFormat", + "traits": { + "smithy.api#documentation": "

The format of the key pair.

\n

Default: pem\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateLaunchTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateLaunchTemplateRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateLaunchTemplateResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a launch template.

\n

A launch template contains the parameters to launch an instance. When you launch an\n instance using RunInstances, you can specify a launch template instead\n of providing the launch parameters in the request. For more information, see Launch\n an instance from a launch template in the\n Amazon Elastic Compute Cloud User Guide.

\n

If you want to clone an existing launch template as the basis for creating a new\n launch template, you can use the Amazon EC2 console. The API, SDKs, and CLI do not support\n cloning a template. For more information, see Create a launch template from an existing launch template in the\n Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#CreateLaunchTemplateRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.

\n

Constraint: Maximum 128 ASCII characters.

" + } + }, + "LaunchTemplateName": { + "target": "com.amazonaws.ec2#LaunchTemplateName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A name for the launch template.

", + "smithy.api#required": {} + } + }, + "VersionDescription": { + "target": "com.amazonaws.ec2#VersionDescription", + "traits": { + "smithy.api#documentation": "

A description for the first version of the launch template.

" + } + }, + "LaunchTemplateData": { + "target": "com.amazonaws.ec2#RequestLaunchTemplateData", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The information for the launch template.

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the launch template on creation. To tag the launch template, the\n resource type must be launch-template.

\n \n

To specify the tags for the resources that are created when an instance is\n launched, you must use the TagSpecifications parameter in the launch\n template data structure.

\n ", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateLaunchTemplateResult": { + "type": "structure", + "members": { + "LaunchTemplate": { + "target": "com.amazonaws.ec2#LaunchTemplate", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplate", + "smithy.api#documentation": "

Information about the launch template.

", + "smithy.api#xmlName": "launchTemplate" + } + }, + "Warning": { + "target": "com.amazonaws.ec2#ValidationWarning", + "traits": { + "aws.protocols#ec2QueryName": "Warning", + "smithy.api#documentation": "

If the launch template contains parameters or parameter combinations that are not\n valid, an error code and an error message are returned for each issue that's\n found.

", + "smithy.api#xmlName": "warning" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateLaunchTemplateVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateLaunchTemplateVersionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateLaunchTemplateVersionResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a new version of a launch template. You can specify an existing version of\n launch template from which to base the new version.

\n

Launch template versions are numbered in the order in which they are created. You\n cannot specify, change, or replace the numbering of launch template versions.

\n

Launch templates are immutable; after you create a launch template, you can't modify\n it. Instead, you can create a new version of the launch template that includes any\n changes you require.

\n

For more information, see Modify a launch template (manage launch template versions) in the\n Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#CreateLaunchTemplateVersionRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.

\n

Constraint: Maximum 128 ASCII characters.

" + } + }, + "LaunchTemplateId": { + "target": "com.amazonaws.ec2#LaunchTemplateId", + "traits": { + "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify either the LaunchTemplateId or the\n LaunchTemplateName, but not both.

" + } + }, + "LaunchTemplateName": { + "target": "com.amazonaws.ec2#LaunchTemplateName", + "traits": { + "smithy.api#documentation": "

The name of the launch template.

\n

You must specify the LaunchTemplateName or the\n LaunchTemplateId, but not both.

" + } + }, + "SourceVersion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The version number of the launch template version on which to base the new version.\n The new version inherits the same launch parameters as the source version, except for\n parameters that you specify in LaunchTemplateData. Snapshots applied to the\n block device mapping are ignored when creating a new version unless they are explicitly\n included.

" + } + }, + "VersionDescription": { + "target": "com.amazonaws.ec2#VersionDescription", + "traits": { + "smithy.api#documentation": "

A description for the version of the launch template.

" + } + }, + "LaunchTemplateData": { + "target": "com.amazonaws.ec2#RequestLaunchTemplateData", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The information for the launch template.

", + "smithy.api#required": {} + } + }, + "ResolveAlias": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

If true, and if a Systems Manager parameter is specified for ImageId,\n the AMI ID is displayed in the response for imageID. For more information, see Use a Systems \n Manager parameter instead of an AMI ID in the Amazon Elastic Compute Cloud User Guide.

\n

Default: false\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateLaunchTemplateVersionResult": { + "type": "structure", + "members": { + "LaunchTemplateVersion": { + "target": "com.amazonaws.ec2#LaunchTemplateVersion", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateVersion", + "smithy.api#documentation": "

Information about the launch template version.

", + "smithy.api#xmlName": "launchTemplateVersion" + } + }, + "Warning": { + "target": "com.amazonaws.ec2#ValidationWarning", + "traits": { + "aws.protocols#ec2QueryName": "Warning", + "smithy.api#documentation": "

If the new version of the launch template contains parameters or parameter\n combinations that are not valid, an error code and an error message are returned for\n each issue that's found.

", + "smithy.api#xmlName": "warning" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateLocalGatewayRoute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateLocalGatewayRouteRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateLocalGatewayRouteResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a static route for the specified local gateway route table. You must specify one of the \n following targets:

\n " + } + }, + "com.amazonaws.ec2#CreateLocalGatewayRouteRequest": { + "type": "structure", + "members": { + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The CIDR range used for destination matches. Routing decisions are based on \n the most specific match.

" + } + }, + "LocalGatewayRouteTableId": { + "target": "com.amazonaws.ec2#LocalGatewayRoutetableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the local gateway route table.

", + "smithy.api#required": {} + } + }, + "LocalGatewayVirtualInterfaceGroupId": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupId", + "traits": { + "smithy.api#documentation": "

The ID of the virtual interface group.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "smithy.api#documentation": "

The ID of the network interface.

" + } + }, + "DestinationPrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "smithy.api#documentation": "

\n The ID of the prefix list. Use a prefix list in place of DestinationCidrBlock. You \n cannot use DestinationPrefixListId and DestinationCidrBlock in the same request.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateLocalGatewayRouteResult": { + "type": "structure", + "members": { + "Route": { + "target": "com.amazonaws.ec2#LocalGatewayRoute", + "traits": { + "aws.protocols#ec2QueryName": "Route", + "smithy.api#documentation": "

Information about the route.

", + "smithy.api#xmlName": "route" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateLocalGatewayRouteTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateLocalGatewayRouteTableRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateLocalGatewayRouteTableResult" + }, + "traits": { + "smithy.api#documentation": "

\n Creates a local gateway route table. \n

" + } + }, + "com.amazonaws.ec2#CreateLocalGatewayRouteTableRequest": { + "type": "structure", + "members": { + "LocalGatewayId": { + "target": "com.amazonaws.ec2#LocalGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n The ID of the local gateway. \n

", + "smithy.api#required": {} + } + }, + "Mode": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableMode", + "traits": { + "smithy.api#documentation": "

\n The mode of the local gateway route table.\n

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

\n The tags assigned to the local gateway route table.\n

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateLocalGatewayRouteTableResult": { + "type": "structure", + "members": { + "LocalGatewayRouteTable": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTable", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTable", + "smithy.api#documentation": "

Information about the local gateway route table.

", + "smithy.api#xmlName": "localGatewayRouteTable" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationResult" + }, + "traits": { + "smithy.api#documentation": "

\n Creates a local gateway route table virtual interface group association. \n

" + } + }, + "com.amazonaws.ec2#CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationRequest": { + "type": "structure", + "members": { + "LocalGatewayRouteTableId": { + "target": "com.amazonaws.ec2#LocalGatewayRoutetableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n The ID of the local gateway route table.\n

", + "smithy.api#required": {} + } + }, + "LocalGatewayVirtualInterfaceGroupId": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n The ID of the local gateway route table virtual interface group association.\n

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

\n The tags assigned to the local gateway route table virtual interface group association.\n

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationResult": { + "type": "structure", + "members": { + "LocalGatewayRouteTableVirtualInterfaceGroupAssociation": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociation", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableVirtualInterfaceGroupAssociation", + "smithy.api#documentation": "

Information about the local gateway route table virtual interface group association.

", + "smithy.api#xmlName": "localGatewayRouteTableVirtualInterfaceGroupAssociation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateLocalGatewayRouteTableVpcAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateLocalGatewayRouteTableVpcAssociationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateLocalGatewayRouteTableVpcAssociationResult" + }, + "traits": { + "smithy.api#documentation": "

Associates the specified VPC with the specified local gateway route table.

" + } + }, + "com.amazonaws.ec2#CreateLocalGatewayRouteTableVpcAssociationRequest": { + "type": "structure", + "members": { + "LocalGatewayRouteTableId": { + "target": "com.amazonaws.ec2#LocalGatewayRoutetableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the local gateway route table.

", + "smithy.api#required": {} + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the local gateway route table VPC association.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateLocalGatewayRouteTableVpcAssociationResult": { + "type": "structure", + "members": { + "LocalGatewayRouteTableVpcAssociation": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociation", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableVpcAssociation", + "smithy.api#documentation": "

Information about the association.

", + "smithy.api#xmlName": "localGatewayRouteTableVpcAssociation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateManagedPrefixList": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateManagedPrefixListRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateManagedPrefixListResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a managed prefix list. You can specify one or more entries for the prefix list. \n Each entry consists of a CIDR block and an optional description.

" + } + }, + "com.amazonaws.ec2#CreateManagedPrefixListRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "PrefixListName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A name for the prefix list.

\n

Constraints: Up to 255 characters in length. The name cannot start with com.amazonaws.

", + "smithy.api#required": {} + } + }, + "Entries": { + "target": "com.amazonaws.ec2#AddPrefixListEntries", + "traits": { + "smithy.api#documentation": "

One or more entries for the prefix list.

", + "smithy.api#xmlName": "Entry" + } + }, + "MaxEntries": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of entries for the prefix list.

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the prefix list during creation.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "AddressFamily": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IP address type.

\n

Valid Values: IPv4 | IPv6\n

", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n Idempotency.

\n

Constraints: Up to 255 UTF-8 characters in length.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateManagedPrefixListResult": { + "type": "structure", + "members": { + "PrefixList": { + "target": "com.amazonaws.ec2#ManagedPrefixList", + "traits": { + "aws.protocols#ec2QueryName": "PrefixList", + "smithy.api#documentation": "

Information about the prefix list.

", + "smithy.api#xmlName": "prefixList" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateNatGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateNatGatewayRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateNatGatewayResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a NAT gateway in the specified subnet. This action creates a network interface\n in the specified subnet with a private IP address from the IP address range of the\n subnet. You can create either a public NAT gateway or a private NAT gateway.

\n

With a public NAT gateway, internet-bound traffic from a private subnet can be routed\n to the NAT gateway, so that instances in a private subnet can connect to the internet.

\n

With a private NAT gateway, private communication is routed across VPCs and on-premises\n networks through a transit gateway or virtual private gateway. Common use cases include\n running large workloads behind a small pool of allowlisted IPv4 addresses, preserving\n private IPv4 addresses, and communicating between overlapping networks.

\n

For more information, see NAT gateways in the Amazon Virtual Private Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#CreateNatGatewayRequest": { + "type": "structure", + "members": { + "AllocationId": { + "target": "com.amazonaws.ec2#AllocationId", + "traits": { + "smithy.api#documentation": "

[Public NAT gateways only] The allocation ID of an Elastic IP address to associate \n with the NAT gateway. You cannot specify an Elastic IP address with a private NAT gateway.\n If the Elastic IP address is associated with another resource, you must first disassociate it.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n\t\t\trequest. For more information, see How to ensure\n\t\t\t\tidempotency.

\n

Constraint: Maximum 64 ASCII characters.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the subnet in which to create the NAT gateway.

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the NAT gateway.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "ConnectivityType": { + "target": "com.amazonaws.ec2#ConnectivityType", + "traits": { + "smithy.api#documentation": "

Indicates whether the NAT gateway supports public or private connectivity. \n The default is public connectivity.

" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.

" + } + }, + "SecondaryAllocationIds": { + "target": "com.amazonaws.ec2#AllocationIdList", + "traits": { + "smithy.api#documentation": "

Secondary EIP allocation IDs. For more information about secondary addresses, see Create a NAT gateway in the Amazon Virtual Private Cloud User Guide.

", + "smithy.api#xmlName": "SecondaryAllocationId" + } + }, + "SecondaryPrivateIpAddresses": { + "target": "com.amazonaws.ec2#IpList", + "traits": { + "smithy.api#documentation": "

Secondary private IPv4 addresses. For more information about secondary addresses, see Create a NAT gateway in the Amazon Virtual Private Cloud User Guide.

", + "smithy.api#xmlName": "SecondaryPrivateIpAddress" + } + }, + "SecondaryPrivateIpAddressCount": { + "target": "com.amazonaws.ec2#PrivateIpAddressCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

[Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway. For more information about secondary addresses, see Create a NAT gateway in the Amazon Virtual Private Cloud User Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateNatGatewayResult": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.

", + "smithy.api#xmlName": "clientToken" + } + }, + "NatGateway": { + "target": "com.amazonaws.ec2#NatGateway", + "traits": { + "aws.protocols#ec2QueryName": "NatGateway", + "smithy.api#documentation": "

Information about the NAT gateway.

", + "smithy.api#xmlName": "natGateway" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateNetworkAcl": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateNetworkAclRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateNetworkAclResult" + }, + "traits": { + "smithy.api#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.

\n

For more information, see Network ACLs in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#CreateNetworkAclEntry": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateNetworkAclEntryRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#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 \n\t\t and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated \n\t\t 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 \n\t\t ingress rules and a separate set of egress rules.

\n

We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the \n\t\t other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.

\n

After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.

\n

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#CreateNetworkAclEntryRequest": { + "type": "structure", + "members": { + "CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrBlock", + "smithy.api#documentation": "

The IPv4 network range to allow or deny, in CIDR notation (for example\n\t\t 172.16.0.0/24). We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

", + "smithy.api#xmlName": "cidrBlock" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Egress": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Egress", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).

", + "smithy.api#required": {}, + "smithy.api#xmlName": "egress" + } + }, + "IcmpTypeCode": { + "target": "com.amazonaws.ec2#IcmpTypeCode", + "traits": { + "smithy.api#documentation": "

ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol \n\t\t 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.

", + "smithy.api#xmlName": "Icmp" + } + }, + "Ipv6CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrBlock", + "smithy.api#documentation": "

The IPv6 network range to allow or deny, in CIDR notation (for example\n 2001:db8:1234:1a00::/64).

", + "smithy.api#xmlName": "ipv6CidrBlock" + } + }, + "NetworkAclId": { + "target": "com.amazonaws.ec2#NetworkAclId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkAclId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the network ACL.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "networkAclId" + } + }, + "PortRange": { + "target": "com.amazonaws.ec2#PortRange", + "traits": { + "aws.protocols#ec2QueryName": "PortRange", + "smithy.api#documentation": "

TCP or UDP protocols: The range of ports the rule applies to.\n\t\t Required if specifying protocol 6 (TCP) or 17 (UDP).

", + "smithy.api#xmlName": "portRange" + } + }, + "Protocol": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Protocol", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The protocol number. A value of \"-1\" means all protocols. If you specify \"-1\" or a\n \t\t\tprotocol number other than \"6\" (TCP), \"17\" (UDP), or \"1\" (ICMP), traffic on all ports is \n\t\t\tallowed, regardless of any ports or ICMP types or codes that you specify. If you specify \n\t\t\tprotocol \"58\" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and \n\t\t\tcodes allowed, regardless of any that you specify. If you specify protocol \"58\" (ICMPv6) \n\t\t\tand specify an IPv6 CIDR block, you must specify an ICMP type and code.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "protocol" + } + }, + "RuleAction": { + "target": "com.amazonaws.ec2#RuleAction", + "traits": { + "aws.protocols#ec2QueryName": "RuleAction", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Indicates whether to allow or deny the traffic that matches the rule.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "ruleAction" + } + }, + "RuleNumber": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "RuleNumber", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.

\n

Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "ruleNumber" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateNetworkAclRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "vpcId" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the network ACL.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateNetworkAclResult": { + "type": "structure", + "members": { + "NetworkAcl": { + "target": "com.amazonaws.ec2#NetworkAcl", + "traits": { + "aws.protocols#ec2QueryName": "NetworkAcl", + "smithy.api#documentation": "

Information about the network ACL.

", + "smithy.api#xmlName": "networkAcl" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateNetworkInsightsAccessScope": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateNetworkInsightsAccessScopeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateNetworkInsightsAccessScopeResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a Network Access Scope.

\n

Amazon Web Services Network Access Analyzer enables cloud networking and cloud operations teams \n to verify that their networks on Amazon Web Services conform to their network security and governance \n objectives. For more information, see the Amazon Web Services Network Access Analyzer Guide.

" + } + }, + "com.amazonaws.ec2#CreateNetworkInsightsAccessScopeRequest": { + "type": "structure", + "members": { + "MatchPaths": { + "target": "com.amazonaws.ec2#AccessScopePathListRequest", + "traits": { + "smithy.api#documentation": "

The paths to match.

", + "smithy.api#xmlName": "MatchPath" + } + }, + "ExcludePaths": { + "target": "com.amazonaws.ec2#AccessScopePathListRequest", + "traits": { + "smithy.api#documentation": "

The paths to exclude.

", + "smithy.api#xmlName": "ExcludePath" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, \n see How to ensure idempotency.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateNetworkInsightsAccessScopeResult": { + "type": "structure", + "members": { + "NetworkInsightsAccessScope": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScope", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScope", + "smithy.api#documentation": "

The Network Access Scope.

", + "smithy.api#xmlName": "networkInsightsAccessScope" + } + }, + "NetworkInsightsAccessScopeContent": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeContent", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeContent", + "smithy.api#documentation": "

The Network Access Scope content.

", + "smithy.api#xmlName": "networkInsightsAccessScopeContent" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateNetworkInsightsPath": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateNetworkInsightsPathRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateNetworkInsightsPathResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a path to analyze for reachability.

\n

Reachability Analyzer enables you to analyze and debug network reachability between\n two resources in your virtual private cloud (VPC). For more information, see the \n Reachability Analyzer Guide.

" + } + }, + "com.amazonaws.ec2#CreateNetworkInsightsPathRequest": { + "type": "structure", + "members": { + "SourceIp": { + "target": "com.amazonaws.ec2#IpAddress", + "traits": { + "smithy.api#documentation": "

The IP address of the source.

" + } + }, + "DestinationIp": { + "target": "com.amazonaws.ec2#IpAddress", + "traits": { + "smithy.api#documentation": "

The IP address of the destination.

" + } + }, + "Source": { + "target": "com.amazonaws.ec2#NetworkInsightsResourceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID or ARN of the source. If the resource is in another account, you must specify an ARN.

", + "smithy.api#required": {} + } + }, + "Destination": { + "target": "com.amazonaws.ec2#NetworkInsightsResourceId", + "traits": { + "smithy.api#documentation": "

The ID or ARN of the destination. If the resource is in another account, you must specify an ARN.

" + } + }, + "Protocol": { + "target": "com.amazonaws.ec2#Protocol", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The protocol.

", + "smithy.api#required": {} + } + }, + "DestinationPort": { + "target": "com.amazonaws.ec2#Port", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The destination port.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to add to the path.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, \n see How to ensure idempotency.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "FilterAtSource": { + "target": "com.amazonaws.ec2#PathRequestFilter", + "traits": { + "smithy.api#documentation": "

Scopes the analysis to network paths that match specific filters at the source. If you specify\n this parameter, you can't specify the parameters for the source IP address or the destination port.

" + } + }, + "FilterAtDestination": { + "target": "com.amazonaws.ec2#PathRequestFilter", + "traits": { + "smithy.api#documentation": "

Scopes the analysis to network paths that match specific filters at the destination. If you specify\n this parameter, you can't specify the parameter for the destination IP address.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateNetworkInsightsPathResult": { + "type": "structure", + "members": { + "NetworkInsightsPath": { + "target": "com.amazonaws.ec2#NetworkInsightsPath", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsPath", + "smithy.api#documentation": "

Information about the path.

", + "smithy.api#xmlName": "networkInsightsPath" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateNetworkInterface": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateNetworkInterfaceRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateNetworkInterfaceResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a network interface in the specified subnet.

\n

The number of IP addresses you can assign to a network interface varies by instance\n type. For more information, see IP Addresses Per ENI Per\n Instance Type in the Amazon Virtual Private Cloud User Guide.

\n

For more information about network interfaces, see Elastic network interfaces \n in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#CreateNetworkInterfacePermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateNetworkInterfacePermissionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateNetworkInterfacePermissionResult" + }, + "traits": { + "smithy.api#documentation": "

Grants an Amazon Web Services-authorized account permission to attach the specified network interface to\n an instance in their account.

\n

You can grant permission to a single Amazon Web Services account only, and only one account at a time.

" + } + }, + "com.amazonaws.ec2#CreateNetworkInterfacePermissionRequest": { + "type": "structure", + "members": { + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

" + } + }, + "AwsService": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Service. Currently not supported.

" + } + }, + "Permission": { + "target": "com.amazonaws.ec2#InterfacePermissionType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of permission to grant.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is DryRunOperation. \n\t\t\tOtherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for CreateNetworkInterfacePermission.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateNetworkInterfacePermissionResult": { + "type": "structure", + "members": { + "InterfacePermission": { + "target": "com.amazonaws.ec2#NetworkInterfacePermission", + "traits": { + "aws.protocols#ec2QueryName": "InterfacePermission", + "smithy.api#documentation": "

Information about the permission for the network interface.

", + "smithy.api#xmlName": "interfacePermission" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of CreateNetworkInterfacePermission.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateNetworkInterfaceRequest": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the network interface.

", + "smithy.api#xmlName": "description" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Groups": { + "target": "com.amazonaws.ec2#SecurityGroupIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of one or more security groups.

", + "smithy.api#xmlName": "SecurityGroupId" + } + }, + "Ipv6AddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6AddressCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of IPv6 addresses to assign to a network interface. Amazon EC2\n automatically selects the IPv6 addresses from the subnet range.

\n

You can't specify a count of IPv6 addresses using this parameter if you've specified \n one of the following: specific IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.

\n

If your subnet has the AssignIpv6AddressOnCreation attribute set, you can\n override that setting by specifying 0 as the IPv6 address count.

", + "smithy.api#xmlName": "ipv6AddressCount" + } + }, + "Ipv6Addresses": { + "target": "com.amazonaws.ec2#InstanceIpv6AddressList", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Addresses", + "smithy.api#documentation": "

The IPv6 addresses from the IPv6 CIDR block range of your subnet.

\n

You can't specify IPv6 addresses using this parameter if you've specified one of the \n following: a count of IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.

", + "smithy.api#xmlName": "ipv6Addresses" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

The primary private IPv4 address of the network interface. If you don't specify an\n IPv4 address, Amazon EC2 selects one for you from the subnet's IPv4 CIDR range. If you\n specify an IP address, you cannot indicate any IP addresses specified in\n privateIpAddresses as primary (only one IP address can be designated as\n primary).

", + "smithy.api#xmlName": "privateIpAddress" + } + }, + "PrivateIpAddresses": { + "target": "com.amazonaws.ec2#PrivateIpAddressSpecificationList", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddresses", + "smithy.api#documentation": "

The private IPv4 addresses.

\n

You can't specify private IPv4 addresses if you've specified one of the following:\n a count of private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.

", + "smithy.api#xmlName": "privateIpAddresses" + } + }, + "SecondaryPrivateIpAddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "SecondaryPrivateIpAddressCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of secondary private IPv4 addresses to assign to a network interface. When\n you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses\n within the subnet's IPv4 CIDR range. You can't specify this option and specify more than\n one private IP address using privateIpAddresses.

\n

You can't specify a count of private IPv4 addresses if you've specified one of the following:\n specific private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.

", + "smithy.api#xmlName": "secondaryPrivateIpAddressCount" + } + }, + "Ipv4Prefixes": { + "target": "com.amazonaws.ec2#Ipv4PrefixList", + "traits": { + "smithy.api#documentation": "

The IPv4 prefixes assigned to the network interface.

\n

You can't specify IPv4 prefixes if you've specified one of the following:\n a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.

", + "smithy.api#xmlName": "Ipv4Prefix" + } + }, + "Ipv4PrefixCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface.

\n

You can't specify a count of IPv4 prefixes if you've specified one of the following:\n specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4\n addresses.

" + } + }, + "Ipv6Prefixes": { + "target": "com.amazonaws.ec2#Ipv6PrefixList", + "traits": { + "smithy.api#documentation": "

The IPv6 prefixes assigned to the network interface.

\n

You can't specify IPv6 prefixes if you've specified one of the following:\n a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.

", + "smithy.api#xmlName": "Ipv6Prefix" + } + }, + "Ipv6PrefixCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface.

\n

You can't specify a count of IPv6 prefixes if you've specified one of the following:\n specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.

" + } + }, + "InterfaceType": { + "target": "com.amazonaws.ec2#NetworkInterfaceCreationType", + "traits": { + "smithy.api#documentation": "

The type of network interface. The default is interface.

\n

The only supported values are interface, efa, and trunk.

" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the subnet to associate with the network interface.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "subnetId" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the new network interface.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateNetworkInterfaceResult": { + "type": "structure", + "members": { + "NetworkInterface": { + "target": "com.amazonaws.ec2#NetworkInterface", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterface", + "smithy.api#documentation": "

Information about the network interface.

", + "smithy.api#xmlName": "networkInterface" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "clientToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreatePlacementGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreatePlacementGroupRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreatePlacementGroupResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a placement group in which to launch instances. The strategy of the placement\n group determines how the instances are organized within the group.

\n

A cluster placement group is a logical grouping of instances within a\n single Availability Zone that benefit from low network latency, high network throughput.\n A spread placement group places instances on distinct hardware. A\n partition placement group places groups of instances in different\n partitions, where instances in one partition do not share the same hardware with\n instances in another partition.

\n

For more information, see Placement groups in the\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#CreatePlacementGroupRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

A name for the placement group. Must be unique within the scope of your account for\n the Region.

\n

Constraints: Up to 255 ASCII characters

", + "smithy.api#xmlName": "groupName" + } + }, + "Strategy": { + "target": "com.amazonaws.ec2#PlacementStrategy", + "traits": { + "aws.protocols#ec2QueryName": "Strategy", + "smithy.api#documentation": "

The placement strategy.

", + "smithy.api#xmlName": "strategy" + } + }, + "PartitionCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of partitions. Valid only when Strategy is\n set to partition.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the new placement group.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "SpreadLevel": { + "target": "com.amazonaws.ec2#SpreadLevel", + "traits": { + "smithy.api#documentation": "

Determines how placement groups spread instances.

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreatePlacementGroupResult": { + "type": "structure", + "members": { + "PlacementGroup": { + "target": "com.amazonaws.ec2#PlacementGroup", + "traits": { + "aws.protocols#ec2QueryName": "PlacementGroup", + "smithy.api#documentation": "

Information about the placement group.

", + "smithy.api#xmlName": "placementGroup" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreatePublicIpv4Pool": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreatePublicIpv4PoolRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreatePublicIpv4PoolResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a public IPv4 address pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only. To monitor the status of pool creation, use DescribePublicIpv4Pools.

" + } + }, + "com.amazonaws.ec2#CreatePublicIpv4PoolRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

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.\n 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.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreatePublicIpv4PoolResult": { + "type": "structure", + "members": { + "PoolId": { + "target": "com.amazonaws.ec2#Ipv4PoolEc2Id", + "traits": { + "aws.protocols#ec2QueryName": "PoolId", + "smithy.api#documentation": "

The ID of the public IPv4 pool.

", + "smithy.api#xmlName": "poolId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateReplaceRootVolumeTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateReplaceRootVolumeTaskRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateReplaceRootVolumeTaskResult" + }, + "traits": { + "smithy.api#documentation": "

Replaces the EBS-backed root volume for a running instance with a new \n volume that is restored to the original root volume's launch state, that is restored to a \n specific snapshot taken from the original root volume, or that is restored from an AMI \n that has the same key characteristics as that of the instance.

\n

For more information, see Replace a root volume in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#CreateReplaceRootVolumeTaskRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance for which to replace the root volume.

", + "smithy.api#required": {} + } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "smithy.api#documentation": "

The ID of the snapshot from which to restore the replacement root volume. The \n specified snapshot must be a snapshot that you previously created from the original \n root volume.

\n

If you want to restore the replacement root volume to the initial launch state, \n or if you want to restore the replacement root volume from an AMI, omit this \n parameter.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. \n If you do not specify a client token, a randomly generated token is used for the request \n to ensure idempotency. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the root volume replacement task.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#documentation": "

The ID of the AMI to use to restore the root volume. The specified AMI must have the \n same product code, billing information, architecture type, and virtualization type as \n that of the instance.

\n

If you want to restore the replacement volume from a specific snapshot, or if you want \n to restore it to its launch state, omit this parameter.

" + } + }, + "DeleteReplacedRootVolume": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to automatically delete the original root volume after the root volume \n replacement task completes. To delete the original root volume, specify true. \n If you choose to keep the original root volume after the replacement task completes, you must \n manually delete it when you no longer need it.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateReplaceRootVolumeTaskResult": { + "type": "structure", + "members": { + "ReplaceRootVolumeTask": { + "target": "com.amazonaws.ec2#ReplaceRootVolumeTask", + "traits": { + "aws.protocols#ec2QueryName": "ReplaceRootVolumeTask", + "smithy.api#documentation": "

Information about the root volume replacement task.

", + "smithy.api#xmlName": "replaceRootVolumeTask" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateReservedInstancesListing": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateReservedInstancesListingRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateReservedInstancesListingResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance\n\t\t\tMarketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your\n\t\t\tStandard Reserved Instances, you can use the DescribeReservedInstances operation.

\n \n

Only Standard Reserved Instances can be sold in the Reserved Instance Marketplace. \n Convertible Reserved Instances cannot be sold.

\n \n

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.

\n

To sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance\n Marketplace. After completing the registration process, you can create a Reserved Instance\n Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price\n to receive for them. Your Standard Reserved Instance listings then become available for purchase. To\n view the details of your Standard Reserved Instance listing, you can use the\n DescribeReservedInstancesListings operation.

\n

For more information, see Reserved Instance Marketplace in the\n\t\t\t\tAmazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#CreateReservedInstancesListingRequest": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure idempotency of your\n\t\t\t\tlistings. This helps avoid duplicate listings. For more information, see \n\t\t\t\tEnsuring Idempotency.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "clientToken" + } + }, + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "InstanceCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#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.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "instanceCount" + } + }, + "PriceSchedules": { + "target": "com.amazonaws.ec2#PriceScheduleSpecificationList", + "traits": { + "aws.protocols#ec2QueryName": "PriceSchedules", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list specifying the price of the Standard Reserved Instance for each month remaining in the Reserved Instance term.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "priceSchedules" + } + }, + "ReservedInstancesId": { + "target": "com.amazonaws.ec2#ReservationId", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the active Standard Reserved Instance.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "reservedInstancesId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for CreateReservedInstancesListing.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateReservedInstancesListingResult": { + "type": "structure", + "members": { + "ReservedInstancesListings": { + "target": "com.amazonaws.ec2#ReservedInstancesListingList", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesListingsSet", + "smithy.api#documentation": "

Information about the Standard Reserved Instance listing.

", + "smithy.api#xmlName": "reservedInstancesListingsSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of CreateReservedInstancesListing.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateRestoreImageTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateRestoreImageTaskRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateRestoreImageTaskResult" + }, + "traits": { + "smithy.api#documentation": "

Starts a task that restores an AMI from an Amazon S3 object that was previously created by using\n CreateStoreImageTask.

\n

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the\n Amazon EC2 User Guide.

\n

For more information, see Store and restore an AMI using\n \tAmazon S3 in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#CreateRestoreImageTaskRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Amazon S3 bucket that contains the stored AMI object.

", + "smithy.api#required": {} + } + }, + "ObjectKey": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the stored AMI object in the bucket.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name for the restored AMI. The name must be unique for AMIs in the Region for this\n account. If you do not provide a name, the new AMI gets the same name as the original\n AMI.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the AMI and snapshots on restoration. You can tag the AMI, the\n snapshots, or both.

\n ", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateRestoreImageTaskResult": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The AMI ID.

", + "smithy.api#xmlName": "imageId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateRoute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateRouteRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateRouteResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a route in a route table within a VPC.

\n

You must specify either a destination CIDR block or a prefix list ID. You must also specify \n exactly one of the resources from the parameter list.

\n

When determining how to route traffic, we use the route with the most specific match.\n For example, traffic is destined for the IPv4 address 192.0.2.3, and the\n route table includes the following two IPv4 routes:

\n \n

Both routes apply to the traffic destined for 192.0.2.3. However, the second route\n\t\t\t\tin the list covers a smaller number of IP addresses and is therefore more specific,\n\t\t\t\tso we use that route to determine where to target the traffic.

\n

For more information about route tables, see Route tables in the\n Amazon Virtual Private Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#CreateRouteRequest": { + "type": "structure", + "members": { + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationCidrBlock", + "smithy.api#documentation": "

The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

", + "smithy.api#xmlName": "destinationCidrBlock" + } + }, + "DestinationIpv6CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationIpv6CidrBlock", + "smithy.api#documentation": "

The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.

", + "smithy.api#xmlName": "destinationIpv6CidrBlock" + } + }, + "DestinationPrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "smithy.api#documentation": "

The ID of a prefix list used for the destination match.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "VpcEndpointId": { + "target": "com.amazonaws.ec2#VpcEndpointId", + "traits": { + "smithy.api#documentation": "

The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.

" + } + }, + "EgressOnlyInternetGatewayId": { + "target": "com.amazonaws.ec2#EgressOnlyInternetGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "EgressOnlyInternetGatewayId", + "smithy.api#documentation": "

[IPv6 traffic only] The ID of an egress-only internet gateway.

", + "smithy.api#xmlName": "egressOnlyInternetGatewayId" + } + }, + "GatewayId": { + "target": "com.amazonaws.ec2#RouteGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "GatewayId", + "smithy.api#documentation": "

The ID of an internet gateway or virtual private gateway attached to your\n\t\t\tVPC.

", + "smithy.api#xmlName": "gatewayId" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#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.

", + "smithy.api#xmlName": "instanceId" + } + }, + "NatGatewayId": { + "target": "com.amazonaws.ec2#NatGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "NatGatewayId", + "smithy.api#documentation": "

[IPv4 traffic only] The ID of a NAT gateway.

", + "smithy.api#xmlName": "natGatewayId" + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of a transit gateway.

" + } + }, + "LocalGatewayId": { + "target": "com.amazonaws.ec2#LocalGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the local gateway.

" + } + }, + "CarrierGatewayId": { + "target": "com.amazonaws.ec2#CarrierGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the carrier gateway.

\n

You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.

" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of a network interface.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "RouteTableId": { + "target": "com.amazonaws.ec2#RouteTableId", + "traits": { + "aws.protocols#ec2QueryName": "RouteTableId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the route table for the route.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "routeTableId" + } + }, + "VpcPeeringConnectionId": { + "target": "com.amazonaws.ec2#VpcPeeringConnectionId", + "traits": { + "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", + "smithy.api#documentation": "

The ID of a VPC peering connection.

", + "smithy.api#xmlName": "vpcPeeringConnectionId" + } + }, + "CoreNetworkArn": { + "target": "com.amazonaws.ec2#CoreNetworkArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the core network.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateRouteResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateRouteTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateRouteTableRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateRouteTableResult" + }, + "traits": { + "smithy.api#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.

\n

For more information, see Route tables in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#CreateRouteTableRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "vpcId" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the route table.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateRouteTableResult": { + "type": "structure", + "members": { + "RouteTable": { + "target": "com.amazonaws.ec2#RouteTable", + "traits": { + "aws.protocols#ec2QueryName": "RouteTable", + "smithy.api#documentation": "

Information about the route table.

", + "smithy.api#xmlName": "routeTable" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateSecurityGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateSecurityGroupRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateSecurityGroupResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a security group.

\n

A security group acts as a virtual firewall for your instance to control inbound and outbound traffic.\n For more information, see\n\t\t\t\tAmazon EC2 security groups in \n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide and \n\t\t\t\tSecurity groups for your VPC in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

\n

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.

\n

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.

\n

You can add or remove rules from your security groups using \n\t\t\t\t\tAuthorizeSecurityGroupIngress,\n\t\t\t\t\tAuthorizeSecurityGroupEgress,\n\t\t\t\t\tRevokeSecurityGroupIngress, and\n\t\t\t\t\tRevokeSecurityGroupEgress.

\n

For more information about VPC security group limits, see Amazon VPC Limits.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " + } + }, + "com.amazonaws.ec2#CreateSecurityGroupRequest": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A description for the security group.

\n

Constraints: Up to 255 characters in length

\n

Constraints for EC2-Classic: ASCII characters

\n

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

", + "smithy.api#required": {}, + "smithy.api#xmlName": "GroupDescription" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the security group.

\n

Constraints: Up to 255 characters in length. Cannot start with\n sg-.

\n

Constraints for EC2-Classic: ASCII characters

\n

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

", + "smithy.api#required": {} + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#documentation": "

[EC2-VPC] The ID of the VPC. Required for EC2-VPC.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the security group.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateSecurityGroupResult": { + "type": "structure", + "members": { + "GroupId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The ID of the security group.

", + "smithy.api#xmlName": "groupId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the security group.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.ec2#Snapshot" + }, + "traits": { + "smithy.api#documentation": "

Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for\n \tbackups, to make copies of EBS volumes, and to save data before shutting down an\n \tinstance.

\n

You can create snapshots of volumes in a Region and volumes on an Outpost. If you \n \tcreate a snapshot of a volume in a Region, the snapshot must be stored in the same \n \tRegion as the volume. If you create a snapshot of a volume on an Outpost, the snapshot \n \tcan be stored on the same Outpost as the volume, or in the Region for that Outpost.

\n

When a snapshot is created, any Amazon Web Services Marketplace product codes that are associated with the\n source volume are propagated to the snapshot.

\n

You can take a snapshot of an attached volume that is in use. However, snapshots only\n capture data that has been written to your Amazon EBS volume at the time the snapshot command is\n issued; this might exclude any data that has been cached by any applications or the operating\n system. If you can pause any file systems on the volume long enough to take a snapshot, your\n snapshot should be complete. However, if you cannot pause all file writes to the volume, you\n should unmount the volume from within the instance, issue the snapshot command, and then\n remount the volume to ensure a consistent and complete snapshot. You may remount and use your\n volume while the snapshot status is pending.

\n

When you create a snapshot for an EBS volume that serves as a root device, we recommend \n that you stop the instance before taking the snapshot.

\n

Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that\n are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes\n and any associated snapshots always remain protected.

\n

You can tag your snapshots during creation. For more information, see Tag your Amazon EC2\n resources in the Amazon Elastic Compute Cloud User Guide.

\n

For more information, see Amazon Elastic Block Store and Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#CreateSnapshotRequest": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the snapshot.

" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost on which to create a local \n \tsnapshot.

\n \n

For more information, see Create local snapshots from volumes on an Outpost in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#VolumeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Amazon EBS volume.

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the snapshot during creation.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateSnapshots": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateSnapshotsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateSnapshotsResult" + }, + "traits": { + "smithy.api#documentation": "

Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3.\n Volumes are chosen by specifying an instance. Any attached volumes will produce one snapshot\n each that is crash-consistent across the instance.

\n

You can include all of the volumes currently attached to the instance, or you can exclude \n the root volume or specific data (non-root) volumes from the multi-volume snapshot set.

\n

You can create multi-volume snapshots of instances in a Region and instances on an \n \tOutpost. If you create snapshots from an instance in a Region, the snapshots must be stored \n \tin the same Region as the instance. If you create snapshots from an instance on an Outpost, \n \tthe snapshots can be stored on the same Outpost as the instance, or in the Region for that \n \tOutpost.

" + } + }, + "com.amazonaws.ec2#CreateSnapshotsRequest": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description propagated to every snapshot specified by the instance.

" + } + }, + "InstanceSpecification": { + "target": "com.amazonaws.ec2#InstanceSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The instance to specify which volumes should be included in the snapshots.

", + "smithy.api#required": {} + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost on which to create the local \n \t\tsnapshots.

\n \n

For more information, see \n \t\tCreate multi-volume local snapshots from instances on an Outpost in the \n \t\tAmazon Elastic Compute Cloud User Guide.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

Tags to apply to every snapshot specified by the instance.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "CopyTagsFromSource": { + "target": "com.amazonaws.ec2#CopyTagsFromSource", + "traits": { + "smithy.api#documentation": "

Copies the tags from the specified volume to corresponding snapshot.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateSnapshotsResult": { + "type": "structure", + "members": { + "Snapshots": { + "target": "com.amazonaws.ec2#SnapshotSet", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotSet", + "smithy.api#documentation": "

List of snapshots.

", + "smithy.api#xmlName": "snapshotSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateSpotDatafeedSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateSpotDatafeedSubscriptionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateSpotDatafeedSubscriptionResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs.\n You can create one data feed per Amazon Web Services account. For more information, see\n Spot Instance data feed \n in the Amazon EC2 User Guide for Linux Instances.

" + } + }, + "com.amazonaws.ec2#CreateSpotDatafeedSubscriptionRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Bucket", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Amazon S3 bucket in which to store the Spot Instance data feed. For\n more information about bucket names, see Rules for bucket\n naming in the Amazon S3 Developer Guide.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "bucket" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Prefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Prefix", + "smithy.api#documentation": "

The prefix for the data feed file names.

", + "smithy.api#xmlName": "prefix" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for CreateSpotDatafeedSubscription.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateSpotDatafeedSubscriptionResult": { + "type": "structure", + "members": { + "SpotDatafeedSubscription": { + "target": "com.amazonaws.ec2#SpotDatafeedSubscription", + "traits": { + "aws.protocols#ec2QueryName": "SpotDatafeedSubscription", + "smithy.api#documentation": "

The Spot Instance data feed subscription.

", + "smithy.api#xmlName": "spotDatafeedSubscription" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of CreateSpotDatafeedSubscription.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateStoreImageTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateStoreImageTaskRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateStoreImageTaskResult" + }, + "traits": { + "smithy.api#documentation": "

Stores an AMI as a single object in an Amazon S3 bucket.

\n

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the\n Amazon EC2 User Guide.

\n

For more information, see Store and restore an AMI using\n \tAmazon S3 in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#CreateStoreImageTaskRequest": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#required": {} + } + }, + "Bucket": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Amazon S3 bucket in which the AMI object will be stored. The bucket must be in\n the Region in which the request is being made. The AMI object appears in the bucket only after\n the upload task has completed.

", + "smithy.api#required": {} + } + }, + "S3ObjectTags": { + "target": "com.amazonaws.ec2#S3ObjectTagList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the AMI object that will be stored in the Amazon S3 bucket.

", + "smithy.api#xmlName": "S3ObjectTag" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateStoreImageTaskResult": { + "type": "structure", + "members": { + "ObjectKey": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ObjectKey", + "smithy.api#documentation": "

The name of the stored AMI object in the S3 bucket.

", + "smithy.api#xmlName": "objectKey" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateSubnet": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateSubnetRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateSubnetResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a subnet in the specified VPC. For an IPv4 only subnet, specify an IPv4 CIDR block.\n If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead.\n For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both\n an IPv4 CIDR block and an IPv6 CIDR block.

\n

A subnet CIDR block must not overlap the CIDR block of an existing subnet in the VPC.\n After you create a subnet, you can't change its CIDR block.

\n

The allowed size for an IPv4 subnet is between a /28 netmask (16 IP addresses) and \n a /16 netmask (65,536 IP addresses). Amazon Web Services reserves both the first four and \n the last IPv4 address in each subnet's CIDR block. They're not available for your use.

\n

If you've associated an IPv6 CIDR block with your VPC, you can associate an IPv6 CIDR block \n with a subnet when you create it. The allowed block size for an IPv6 subnet is a /64 netmask.

\n

If you add more than one subnet to a VPC, they're set up in a star topology with a\n logical router in the middle.

\n

When you stop an instance in a subnet, it retains its private IPv4 address. It's\n therefore possible to have a subnet with no running instances (they're all stopped), but\n no remaining IP addresses available.

\n

For more information, see Subnets in the Amazon Virtual Private Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#CreateSubnetCidrReservation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateSubnetCidrReservationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateSubnetCidrReservationResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a subnet CIDR reservation. For information about subnet CIDR reservations, see Subnet CIDR reservations in the Amazon Virtual Private Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#CreateSubnetCidrReservationRequest": { + "type": "structure", + "members": { + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the subnet.

", + "smithy.api#required": {} + } + }, + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IPv4 or IPV6 CIDR range to reserve.

", + "smithy.api#required": {} + } + }, + "ReservationType": { + "target": "com.amazonaws.ec2#SubnetCidrReservationType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of reservation.

\n

The following are valid values:

\n ", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The\n description\n to assign to the subnet CIDR reservation.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the subnet CIDR reservation.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateSubnetCidrReservationResult": { + "type": "structure", + "members": { + "SubnetCidrReservation": { + "target": "com.amazonaws.ec2#SubnetCidrReservation", + "traits": { + "aws.protocols#ec2QueryName": "SubnetCidrReservation", + "smithy.api#documentation": "

Information about the created subnet CIDR reservation.

", + "smithy.api#xmlName": "subnetCidrReservation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateSubnetRequest": { + "type": "structure", + "members": { + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the subnet.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone or Local Zone for the subnet.

\n

Default: Amazon Web Services selects one for you. If you create more than one subnet in your VPC, we \n do not necessarily select a different zone for each subnet.

\n

To create a subnet in a Local Zone, set this value to the Local Zone ID, for example\n us-west-2-lax-1a. For information about the Regions that support Local Zones, \n see Available Regions in the Amazon Elastic Compute Cloud User Guide.

\n

To create a subnet in an Outpost, set this value to the Availability Zone for the\n Outpost and specify the Outpost ARN.

" + } + }, + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The AZ ID or the Local Zone ID of the subnet.

" + } + }, + "CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/24. \n We modify the specified CIDR block to its canonical form; for example, if you specify \n 100.68.0.18/18, we modify it to 100.68.0.0/18.

\n

This parameter is not supported for an IPv6 only subnet.

" + } + }, + "Ipv6CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a\n /64 prefix length.

\n

This parameter is required for an IPv6 only subnet.

" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost. If you specify an Outpost ARN, you must also\n specify the Availability Zone of the Outpost subnet.

" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Ipv6Native": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to create an IPv6 only subnet.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateSubnetResult": { + "type": "structure", + "members": { + "Subnet": { + "target": "com.amazonaws.ec2#Subnet", + "traits": { + "aws.protocols#ec2QueryName": "Subnet", + "smithy.api#documentation": "

Information about the subnet.

", + "smithy.api#xmlName": "subnet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateTagsRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Adds or overwrites only the specified tags for the specified Amazon EC2 resource or\n resources. When you specify an existing tag key, the value is overwritten with\n the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and\n optional value. Tag keys must be unique per resource.

\n

For more information about tags, see Tag your Amazon EC2 resources in the\n Amazon Elastic Compute Cloud User Guide. For more information about\n creating IAM policies that control users' access to resources based on tags, see Supported\n resource-level permissions for Amazon EC2 API actions in the Amazon\n Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#CreateTagsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Resources": { + "target": "com.amazonaws.ec2#ResourceIdList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the resources, separated by spaces.

\n

Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "ResourceId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The tags. The value parameter is required, but if you don't want the tag to have a value,\n specify the parameter with no value, and we set the value to an empty string.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "Tag" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateTrafficMirrorFilter": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateTrafficMirrorFilterRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateTrafficMirrorFilterResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a Traffic Mirror filter.

\n

A Traffic Mirror filter is a set of rules that defines the traffic to mirror.

\n

By default, no traffic is mirrored. To mirror traffic, use CreateTrafficMirrorFilterRule to add Traffic Mirror rules to the filter. The rules you\n add define what traffic gets mirrored. You can also use ModifyTrafficMirrorFilterNetworkServices to mirror supported network services.

" + } + }, + "com.amazonaws.ec2#CreateTrafficMirrorFilterRequest": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The description of the Traffic Mirror filter.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to a Traffic Mirror filter.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateTrafficMirrorFilterResult": { + "type": "structure", + "members": { + "TrafficMirrorFilter": { + "target": "com.amazonaws.ec2#TrafficMirrorFilter", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorFilter", + "smithy.api#documentation": "

Information about the Traffic Mirror filter.

", + "smithy.api#xmlName": "trafficMirrorFilter" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

", + "smithy.api#xmlName": "clientToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateTrafficMirrorFilterRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateTrafficMirrorFilterRuleRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateTrafficMirrorFilterRuleResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a Traffic Mirror filter rule.

\n

A Traffic Mirror rule defines the Traffic Mirror source traffic to mirror.

\n

You need the Traffic Mirror filter ID when you create the rule.

" + } + }, + "com.amazonaws.ec2#CreateTrafficMirrorFilterRuleRequest": { + "type": "structure", + "members": { + "TrafficMirrorFilterId": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the filter that this rule is associated with.

", + "smithy.api#required": {} + } + }, + "TrafficDirection": { + "target": "com.amazonaws.ec2#TrafficDirection", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of traffic.

", + "smithy.api#required": {} + } + }, + "RuleNumber": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given\n direction. The rules are processed in ascending order by rule number.

", + "smithy.api#required": {} + } + }, + "RuleAction": { + "target": "com.amazonaws.ec2#TrafficMirrorRuleAction", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The action to take on the filtered traffic.

", + "smithy.api#required": {} + } + }, + "DestinationPortRange": { + "target": "com.amazonaws.ec2#TrafficMirrorPortRangeRequest", + "traits": { + "smithy.api#documentation": "

The destination port range.

" + } + }, + "SourcePortRange": { + "target": "com.amazonaws.ec2#TrafficMirrorPortRangeRequest", + "traits": { + "smithy.api#documentation": "

The source port range.

" + } + }, + "Protocol": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The protocol, for example UDP, to assign to the Traffic Mirror rule.

\n

For information about the protocol value, see Protocol Numbers on the Internet Assigned Numbers Authority (IANA) website.

" + } + }, + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The destination CIDR block to assign to the Traffic Mirror rule.

", + "smithy.api#required": {} + } + }, + "SourceCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The source CIDR block to assign to the Traffic Mirror rule.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The description of the Traffic Mirror rule.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateTrafficMirrorFilterRuleResult": { + "type": "structure", + "members": { + "TrafficMirrorFilterRule": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterRule", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorFilterRule", + "smithy.api#documentation": "

The Traffic Mirror rule.

", + "smithy.api#xmlName": "trafficMirrorFilterRule" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

", + "smithy.api#xmlName": "clientToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateTrafficMirrorSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateTrafficMirrorSessionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateTrafficMirrorSessionResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a Traffic Mirror session.

\n

A Traffic Mirror session actively copies packets from a Traffic Mirror source to a Traffic Mirror target. Create a filter, and then assign it\n to the session to define a subset of the traffic to mirror, for example all TCP\n traffic.

\n

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.

\n

By default, no traffic is mirrored. Use CreateTrafficMirrorFilter to\n create filter rules that specify the traffic to mirror.

" + } + }, + "com.amazonaws.ec2#CreateTrafficMirrorSessionRequest": { + "type": "structure", + "members": { + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the source network interface.

", + "smithy.api#required": {} + } + }, + "TrafficMirrorTargetId": { + "target": "com.amazonaws.ec2#TrafficMirrorTargetId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Traffic Mirror target.

", + "smithy.api#required": {} + } + }, + "TrafficMirrorFilterId": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Traffic Mirror filter.

", + "smithy.api#required": {} + } + }, + "PacketLength": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of bytes in each packet to mirror. These are bytes after the VXLAN header. Do\n not specify this parameter when you want to mirror the entire packet. To mirror a subset of\n the packet, set this to the length (in bytes) that you want to mirror. For example, if you\n set this value to 100, then the first 100 bytes that meet the filter criteria are copied to\n the target.

\n

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": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#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.

\n

Valid values are 1-32766.

", + "smithy.api#required": {} + } + }, + "VirtualNetworkId": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The VXLAN ID for the Traffic Mirror session. For more information about the VXLAN\n protocol, see RFC 7348. If you do\n not specify a VirtualNetworkId, an account-wide unique id is chosen at\n random.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The description of the Traffic Mirror session.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to a Traffic Mirror session.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateTrafficMirrorSessionResult": { + "type": "structure", + "members": { + "TrafficMirrorSession": { + "target": "com.amazonaws.ec2#TrafficMirrorSession", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorSession", + "smithy.api#documentation": "

Information about the Traffic Mirror session.

", + "smithy.api#xmlName": "trafficMirrorSession" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

", + "smithy.api#xmlName": "clientToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateTrafficMirrorTarget": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateTrafficMirrorTargetRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateTrafficMirrorTargetResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a target for your Traffic Mirror session.

\n

A Traffic Mirror target is the destination for mirrored traffic. The Traffic Mirror source and\n the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in\n different VPCs connected via VPC peering or a transit gateway.

\n

A Traffic Mirror target can be a network interface, a Network Load Balancer, or a Gateway Load Balancer endpoint.

\n

To use the target in a Traffic Mirror session, use CreateTrafficMirrorSession.

" + } + }, + "com.amazonaws.ec2#CreateTrafficMirrorTargetRequest": { + "type": "structure", + "members": { + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "smithy.api#documentation": "

The network interface ID that is associated with the target.

" + } + }, + "NetworkLoadBalancerArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The description of the Traffic Mirror target.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the Traffic Mirror target.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "GatewayLoadBalancerEndpointId": { + "target": "com.amazonaws.ec2#VpcEndpointId", + "traits": { + "smithy.api#documentation": "

The ID of the Gateway Load Balancer endpoint.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateTrafficMirrorTargetResult": { + "type": "structure", + "members": { + "TrafficMirrorTarget": { + "target": "com.amazonaws.ec2#TrafficMirrorTarget", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorTarget", + "smithy.api#documentation": "

Information about the Traffic Mirror target.

", + "smithy.api#xmlName": "trafficMirrorTarget" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

", + "smithy.api#xmlName": "clientToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateTransitGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateTransitGatewayRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateTransitGatewayResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a transit gateway.

\n

You can use a transit gateway to interconnect your virtual private clouds (VPC) and on-premises networks.\n After the transit gateway enters the available state, you can attach your VPCs and VPN\n connections to the transit gateway.

\n

To attach your VPCs, use CreateTransitGatewayVpcAttachment.

\n

To attach a VPN connection, use CreateCustomerGateway to create a customer \n gateway and specify the ID of the customer gateway and the ID of the transit gateway in a call to\n CreateVpnConnection.

\n

When you create a transit gateway, we create a default transit gateway route table and use it as the default association route table\n and the default propagation route table. You can use CreateTransitGatewayRouteTable to create\n additional transit gateway route tables. If you disable automatic route propagation, we do not create a default transit gateway route table. \n You can use EnableTransitGatewayRouteTablePropagation to propagate routes from a resource \n 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.

" + } + }, + "com.amazonaws.ec2#CreateTransitGatewayConnect": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateTransitGatewayConnectRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateTransitGatewayConnectResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a Connect attachment from a specified transit gateway attachment. A Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a transit gateway and an appliance.

\n

A Connect attachment uses an existing VPC or Amazon Web Services Direct Connect attachment as the underlying transport mechanism.

" + } + }, + "com.amazonaws.ec2#CreateTransitGatewayConnectPeer": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateTransitGatewayConnectPeerRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateTransitGatewayConnectPeerResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a Connect peer for a specified transit gateway Connect attachment between a\n transit gateway and an appliance.

\n

The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).

\n

For more information, see Connect peers in the Transit Gateways Guide.

" + } + }, + "com.amazonaws.ec2#CreateTransitGatewayConnectPeerRequest": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Connect attachment.

", + "smithy.api#required": {} + } + }, + "TransitGatewayAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The peer IP address (GRE outer IP address) on the transit gateway side of the Connect peer, which must be\n specified from a transit gateway CIDR block. If not specified, Amazon automatically assigns\n the first available IP address from the transit gateway CIDR block.

" + } + }, + "PeerAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The peer IP address (GRE outer IP address) on the appliance side of the Connect peer.

", + "smithy.api#required": {} + } + }, + "BgpOptions": { + "target": "com.amazonaws.ec2#TransitGatewayConnectRequestBgpOptions", + "traits": { + "smithy.api#documentation": "

The BGP options for the Connect peer.

" + } + }, + "InsideCidrBlocks": { + "target": "com.amazonaws.ec2#InsideCidrBlocksStringList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The range of inside IP addresses that are used for BGP peering. You must specify a\n size /29 IPv4 CIDR block from the 169.254.0.0/16 range. The first address\n from the range must be configured on the appliance as the BGP IP address. You can also\n optionally specify a size /125 IPv6 CIDR block from the fd00::/8\n range.

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the Connect peer.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayConnectPeerResult": { + "type": "structure", + "members": { + "TransitGatewayConnectPeer": { + "target": "com.amazonaws.ec2#TransitGatewayConnectPeer", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayConnectPeer", + "smithy.api#documentation": "

Information about the Connect peer.

", + "smithy.api#xmlName": "transitGatewayConnectPeer" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayConnectRequest": { + "type": "structure", + "members": { + "TransportTransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway attachment. You can specify a VPC attachment or Amazon Web Services Direct Connect attachment.

", + "smithy.api#required": {} + } + }, + "Options": { + "target": "com.amazonaws.ec2#CreateTransitGatewayConnectRequestOptions", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Connect attachment options.

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the Connect attachment.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayConnectRequestOptions": { + "type": "structure", + "members": { + "Protocol": { + "target": "com.amazonaws.ec2#ProtocolValue", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The tunnel protocol.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The options for a Connect attachment.

" + } + }, + "com.amazonaws.ec2#CreateTransitGatewayConnectResult": { + "type": "structure", + "members": { + "TransitGatewayConnect": { + "target": "com.amazonaws.ec2#TransitGatewayConnect", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayConnect", + "smithy.api#documentation": "

Information about the Connect attachment.

", + "smithy.api#xmlName": "transitGatewayConnect" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayMulticastDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateTransitGatewayMulticastDomainRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateTransitGatewayMulticastDomainResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a multicast domain using the specified transit gateway.

\n

The transit gateway must be in the available state before you create a domain. Use DescribeTransitGateways to see the state of transit gateway.

" + } + }, + "com.amazonaws.ec2#CreateTransitGatewayMulticastDomainRequest": { + "type": "structure", + "members": { + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#required": {} + } + }, + "Options": { + "target": "com.amazonaws.ec2#CreateTransitGatewayMulticastDomainRequestOptions", + "traits": { + "smithy.api#documentation": "

The options for the transit gateway multicast domain.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags for the transit gateway multicast domain.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayMulticastDomainRequestOptions": { + "type": "structure", + "members": { + "Igmpv2Support": { + "target": "com.amazonaws.ec2#Igmpv2SupportValue", + "traits": { + "smithy.api#documentation": "

Specify whether to enable Internet Group Management Protocol (IGMP) version 2 for the transit gateway multicast domain.

" + } + }, + "StaticSourcesSupport": { + "target": "com.amazonaws.ec2#StaticSourcesSupportValue", + "traits": { + "smithy.api#documentation": "

Specify whether to enable support for statically configuring multicast group sources for a domain.

" + } + }, + "AutoAcceptSharedAssociations": { + "target": "com.amazonaws.ec2#AutoAcceptSharedAssociationsValue", + "traits": { + "smithy.api#documentation": "

Indicates whether to automatically accept cross-account subnet associations that are associated with the transit gateway multicast domain.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options for the transit gateway multicast domain.

" + } + }, + "com.amazonaws.ec2#CreateTransitGatewayMulticastDomainResult": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomain": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomain", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayMulticastDomain", + "smithy.api#documentation": "

Information about the transit gateway multicast domain.

", + "smithy.api#xmlName": "transitGatewayMulticastDomain" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayPeeringAttachment": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateTransitGatewayPeeringAttachmentRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateTransitGatewayPeeringAttachmentResult" + }, + "traits": { + "smithy.api#documentation": "

Requests a transit gateway peering attachment between the specified transit gateway\n (requester) and a peer transit gateway (accepter). The peer transit gateway can be in \n your account or a different Amazon Web Services account.

\n

After you create the peering attachment, the owner of the accepter transit gateway \n must accept the attachment request.

" + } + }, + "com.amazonaws.ec2#CreateTransitGatewayPeeringAttachmentRequest": { + "type": "structure", + "members": { + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#required": {} + } + }, + "PeerTransitGatewayId": { + "target": "com.amazonaws.ec2#TransitAssociationGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the peer transit gateway with which to create the peering attachment.

", + "smithy.api#required": {} + } + }, + "PeerAccountId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the peer transit gateway.

", + "smithy.api#required": {} + } + }, + "PeerRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Region where the peer transit gateway is located.

", + "smithy.api#required": {} + } + }, + "Options": { + "target": "com.amazonaws.ec2#CreateTransitGatewayPeeringAttachmentRequestOptions", + "traits": { + "smithy.api#documentation": "

Requests a transit gateway peering attachment.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the transit gateway peering attachment.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayPeeringAttachmentRequestOptions": { + "type": "structure", + "members": { + "DynamicRouting": { + "target": "com.amazonaws.ec2#DynamicRoutingValue", + "traits": { + "smithy.api#documentation": "

Indicates whether dynamic routing is enabled or disabled.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes whether dynamic routing is enabled or disabled for the transit gateway peering request.

" + } + }, + "com.amazonaws.ec2#CreateTransitGatewayPeeringAttachmentResult": { + "type": "structure", + "members": { + "TransitGatewayPeeringAttachment": { + "target": "com.amazonaws.ec2#TransitGatewayPeeringAttachment", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayPeeringAttachment", + "smithy.api#documentation": "

The transit gateway peering attachment.

", + "smithy.api#xmlName": "transitGatewayPeeringAttachment" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayPolicyTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateTransitGatewayPolicyTableRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateTransitGatewayPolicyTableResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a transit gateway policy table.

" + } + }, + "com.amazonaws.ec2#CreateTransitGatewayPolicyTableRequest": { + "type": "structure", + "members": { + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway used for the policy table.

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags specification for the transit gateway policy table created during the request.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayPolicyTableResult": { + "type": "structure", + "members": { + "TransitGatewayPolicyTable": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTable", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayPolicyTable", + "smithy.api#documentation": "

Describes the created transit gateway policy table.

", + "smithy.api#xmlName": "transitGatewayPolicyTable" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayPrefixListReference": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateTransitGatewayPrefixListReferenceRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateTransitGatewayPrefixListReferenceResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a reference (route) to a prefix list in a specified transit gateway route table.

" + } + }, + "com.amazonaws.ec2#CreateTransitGatewayPrefixListReferenceRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#required": {} + } + }, + "PrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the prefix list that is used for destination matches.

", + "smithy.api#required": {} + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#documentation": "

The ID of the attachment to which traffic is routed.

" + } + }, + "Blackhole": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to drop traffic that matches this route.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayPrefixListReferenceResult": { + "type": "structure", + "members": { + "TransitGatewayPrefixListReference": { + "target": "com.amazonaws.ec2#TransitGatewayPrefixListReference", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayPrefixListReference", + "smithy.api#documentation": "

Information about the prefix list reference.

", + "smithy.api#xmlName": "transitGatewayPrefixListReference" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayRequest": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description of the transit gateway.

" + } + }, + "Options": { + "target": "com.amazonaws.ec2#TransitGatewayRequestOptions", + "traits": { + "smithy.api#documentation": "

The transit gateway options.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the transit gateway.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayResult": { + "type": "structure", + "members": { + "TransitGateway": { + "target": "com.amazonaws.ec2#TransitGateway", + "traits": { + "aws.protocols#ec2QueryName": "TransitGateway", + "smithy.api#documentation": "

Information about the transit gateway.

", + "smithy.api#xmlName": "transitGateway" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayRoute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateTransitGatewayRouteRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateTransitGatewayRouteResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a static route for the specified transit gateway route table.

" + } + }, + "com.amazonaws.ec2#CreateTransitGatewayRouteRequest": { + "type": "structure", + "members": { + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The CIDR range used for destination matches. Routing decisions are based on the\n most specific match.

", + "smithy.api#required": {} + } + }, + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#required": {} + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#documentation": "

The ID of the attachment.

" + } + }, + "Blackhole": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to drop traffic that matches this route.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayRouteResult": { + "type": "structure", + "members": { + "Route": { + "target": "com.amazonaws.ec2#TransitGatewayRoute", + "traits": { + "aws.protocols#ec2QueryName": "Route", + "smithy.api#documentation": "

Information about the route.

", + "smithy.api#xmlName": "route" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayRouteTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateTransitGatewayRouteTableRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateTransitGatewayRouteTableResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a route table for the specified transit gateway.

" + } + }, + "com.amazonaws.ec2#CreateTransitGatewayRouteTableAnnouncement": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateTransitGatewayRouteTableAnnouncementRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateTransitGatewayRouteTableAnnouncementResult" + }, + "traits": { + "smithy.api#documentation": "

Advertises a new transit gateway route table.

" + } + }, + "com.amazonaws.ec2#CreateTransitGatewayRouteTableAnnouncementRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#required": {} + } + }, + "PeeringAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the peering attachment.

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags specifications applied to the transit gateway route table announcement.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayRouteTableAnnouncementResult": { + "type": "structure", + "members": { + "TransitGatewayRouteTableAnnouncement": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncement", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableAnnouncement", + "smithy.api#documentation": "

Provides details about the transit gateway route table announcement.

", + "smithy.api#xmlName": "transitGatewayRouteTableAnnouncement" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayRouteTableRequest": { + "type": "structure", + "members": { + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the transit gateway route table.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayRouteTableResult": { + "type": "structure", + "members": { + "TransitGatewayRouteTable": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTable", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTable", + "smithy.api#documentation": "

Information about the transit gateway route table.

", + "smithy.api#xmlName": "transitGatewayRouteTable" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayVpcAttachment": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateTransitGatewayVpcAttachmentRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateTransitGatewayVpcAttachmentResult" + }, + "traits": { + "smithy.api#documentation": "

Attaches the specified VPC to the specified transit gateway.

\n

If you attach a VPC with a CIDR range that overlaps the CIDR range of a VPC that is already attached,\n the new VPC CIDR range is not propagated to the default propagation route table.

\n

To send VPC traffic to an attached transit gateway, add a route to the VPC route table using CreateRoute.

" + } + }, + "com.amazonaws.ec2#CreateTransitGatewayVpcAttachmentRequest": { + "type": "structure", + "members": { + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#required": {} + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {} + } + }, + "SubnetIds": { + "target": "com.amazonaws.ec2#TransitGatewaySubnetIdList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of one or more subnets. You can specify only one subnet per Availability Zone. \n You must specify at least one subnet, but we recommend that you specify two subnets for better availability.\n The transit gateway uses one IP address from each specified subnet.

", + "smithy.api#required": {} + } + }, + "Options": { + "target": "com.amazonaws.ec2#CreateTransitGatewayVpcAttachmentRequestOptions", + "traits": { + "smithy.api#documentation": "

The VPC attachment options.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the VPC attachment.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateTransitGatewayVpcAttachmentRequestOptions": { + "type": "structure", + "members": { + "DnsSupport": { + "target": "com.amazonaws.ec2#DnsSupportValue", + "traits": { + "smithy.api#documentation": "

Enable or disable DNS support. The default is enable.

" + } + }, + "Ipv6Support": { + "target": "com.amazonaws.ec2#Ipv6SupportValue", + "traits": { + "smithy.api#documentation": "

Enable or disable IPv6 support. The default is disable.

" + } + }, + "ApplianceModeSupport": { + "target": "com.amazonaws.ec2#ApplianceModeSupportValue", + "traits": { + "smithy.api#documentation": "

Enable or disable support for appliance mode. If enabled, a traffic flow between a source and destination uses the same Availability Zone for the VPC attachment for the lifetime of that flow. The default is disable.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the options for a VPC attachment.

" + } + }, + "com.amazonaws.ec2#CreateTransitGatewayVpcAttachmentResult": { + "type": "structure", + "members": { + "TransitGatewayVpcAttachment": { + "target": "com.amazonaws.ec2#TransitGatewayVpcAttachment", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayVpcAttachment", + "smithy.api#documentation": "

Information about the VPC attachment.

", + "smithy.api#xmlName": "transitGatewayVpcAttachment" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateVerifiedAccessEndpointRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateVerifiedAccessEndpointResult" + }, + "traits": { + "smithy.api#documentation": "

An Amazon Web Services Verified Access endpoint is where you define your application along with an optional endpoint-level access policy.

" + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessEndpointEniOptions": { + "type": "structure", + "members": { + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "smithy.api#documentation": "

The ID of the network interface.

" + } + }, + "Protocol": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointProtocol", + "traits": { + "smithy.api#documentation": "

The IP protocol.

" + } + }, + "Port": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointPortNumber", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The IP port number.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the network interface options when creating an Amazon Web Services Verified Access endpoint using the\n network-interface type.

" + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessEndpointLoadBalancerOptions": { + "type": "structure", + "members": { + "Protocol": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointProtocol", + "traits": { + "smithy.api#documentation": "

The IP protocol.

" + } + }, + "Port": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointPortNumber", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The IP port number.

" + } + }, + "LoadBalancerArn": { + "target": "com.amazonaws.ec2#LoadBalancerArn", + "traits": { + "smithy.api#documentation": "

The ARN of the load balancer.

" + } + }, + "SubnetIds": { + "target": "com.amazonaws.ec2#CreateVerifiedAccessEndpointSubnetIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the subnets.

", + "smithy.api#xmlName": "SubnetId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the load balancer options when creating an Amazon Web Services Verified Access endpoint using the\n load-balancer type.

" + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessEndpointRequest": { + "type": "structure", + "members": { + "VerifiedAccessGroupId": { + "target": "com.amazonaws.ec2#VerifiedAccessGroupId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access group to associate the endpoint with.

", + "smithy.api#required": {} + } + }, + "EndpointType": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of Verified Access endpoint to create.

", + "smithy.api#required": {} + } + }, + "AttachmentType": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointAttachmentType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of attachment.

", + "smithy.api#required": {} + } + }, + "DomainCertificateArn": { + "target": "com.amazonaws.ec2#CertificateArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the public TLS/SSL certificate in Amazon Web Services Certificate Manager to associate with the endpoint.\n The CN in the certificate must match the DNS name your end users will use to reach your\n application.

", + "smithy.api#required": {} + } + }, + "ApplicationDomain": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The DNS name for users to reach your application.

", + "smithy.api#required": {} + } + }, + "EndpointDomainPrefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A custom identifier that is prepended to the DNS name that is generated for the\n endpoint.

", + "smithy.api#required": {} + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#SecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the security groups to associate with the Verified Access endpoint.

", + "smithy.api#xmlName": "SecurityGroupId" + } + }, + "LoadBalancerOptions": { + "target": "com.amazonaws.ec2#CreateVerifiedAccessEndpointLoadBalancerOptions", + "traits": { + "smithy.api#documentation": "

The load balancer details. This parameter is required if the endpoint type is\n load-balancer.

" + } + }, + "NetworkInterfaceOptions": { + "target": "com.amazonaws.ec2#CreateVerifiedAccessEndpointEniOptions", + "traits": { + "smithy.api#documentation": "

The network interface details. This parameter is required if the endpoint type is\n network-interface.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the Verified Access endpoint.

" + } + }, + "PolicyDocument": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Verified Access policy document.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the Verified Access endpoint.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessEndpointResult": { + "type": "structure", + "members": { + "VerifiedAccessEndpoint": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpoint", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessEndpoint", + "smithy.api#documentation": "

The ID of the Verified Access endpoint.

", + "smithy.api#xmlName": "verifiedAccessEndpoint" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessEndpointSubnetIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateVerifiedAccessGroupRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateVerifiedAccessGroupResult" + }, + "traits": { + "smithy.api#documentation": "

An Amazon Web Services Verified Access group is a collection of Amazon Web Services Verified Access endpoints who's associated applications have\n similar security requirements. Each instance within a Verified Access group shares an Verified Access policy. For\n example, you can group all Verified Access instances associated with \"sales\" applications together and\n use one common Verified Access policy.

" + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessGroupRequest": { + "type": "structure", + "members": { + "VerifiedAccessInstanceId": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access instance.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the Verified Access group.

" + } + }, + "PolicyDocument": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Verified Access policy document.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the Verified Access group.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessGroupResult": { + "type": "structure", + "members": { + "VerifiedAccessGroup": { + "target": "com.amazonaws.ec2#VerifiedAccessGroup", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessGroup", + "smithy.api#documentation": "

The ID of the Verified Access group.

", + "smithy.api#xmlName": "verifiedAccessGroup" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateVerifiedAccessInstanceRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateVerifiedAccessInstanceResult" + }, + "traits": { + "smithy.api#documentation": "

An Amazon Web Services Verified Access instance is a regional entity that evaluates application requests and grants\n access only when your security requirements are met.

" + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessInstanceRequest": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the Verified Access instance.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the Verified Access instance.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessInstanceResult": { + "type": "structure", + "members": { + "VerifiedAccessInstance": { + "target": "com.amazonaws.ec2#VerifiedAccessInstance", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessInstance", + "smithy.api#documentation": "

The ID of the Verified Access instance.

", + "smithy.api#xmlName": "verifiedAccessInstance" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessTrustProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateVerifiedAccessTrustProviderRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateVerifiedAccessTrustProviderResult" + }, + "traits": { + "smithy.api#documentation": "

A trust provider is a third-party entity that creates, maintains, and manages identity\n information for users and devices. When an application request is made, the identity\n information sent by the trust provider is evaluated by Verified Access before allowing or\n denying the application request.

" + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessTrustProviderDeviceOptions": { + "type": "structure", + "members": { + "TenantId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of the tenant application with the device-identity provider.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the options when creating an Amazon Web Services Verified Access trust provider using the\n device type.

" + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessTrustProviderOidcOptions": { + "type": "structure", + "members": { + "Issuer": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The OIDC issuer.

" + } + }, + "AuthorizationEndpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The OIDC authorization endpoint.

" + } + }, + "TokenEndpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The OIDC token endpoint.

" + } + }, + "UserInfoEndpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The OIDC user info endpoint.

" + } + }, + "ClientId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The client identifier.

" + } + }, + "ClientSecret": { + "target": "com.amazonaws.ec2#ClientSecretType", + "traits": { + "smithy.api#documentation": "

The client secret.

" + } + }, + "Scope": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

OpenID Connect (OIDC) scopes are used by an application during authentication to authorize access to a user's details. Each scope returns a specific set of user attributes.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the options when creating an Amazon Web Services Verified Access trust provider using the user\n type.

" + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessTrustProviderRequest": { + "type": "structure", + "members": { + "TrustProviderType": { + "target": "com.amazonaws.ec2#TrustProviderType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of trust provider.

", + "smithy.api#required": {} + } + }, + "UserTrustProviderType": { + "target": "com.amazonaws.ec2#UserTrustProviderType", + "traits": { + "smithy.api#documentation": "

The type of user-based trust provider. This parameter is required when the provider type\n is user.

" + } + }, + "DeviceTrustProviderType": { + "target": "com.amazonaws.ec2#DeviceTrustProviderType", + "traits": { + "smithy.api#documentation": "

The type of device-based trust provider. This parameter is required when the provider\n type is device.

" + } + }, + "OidcOptions": { + "target": "com.amazonaws.ec2#CreateVerifiedAccessTrustProviderOidcOptions", + "traits": { + "smithy.api#documentation": "

The options for a OpenID Connect-compatible user-identity trust provider. This parameter\n is required when the provider type is user.

" + } + }, + "DeviceOptions": { + "target": "com.amazonaws.ec2#CreateVerifiedAccessTrustProviderDeviceOptions", + "traits": { + "smithy.api#documentation": "

The options for a device-based trust provider. This parameter is required when the\n provider type is device.

" + } + }, + "PolicyReferenceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier to be used when working with policy rules.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the Verified Access trust provider.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the Verified Access trust provider.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateVerifiedAccessTrustProviderResult": { + "type": "structure", + "members": { + "VerifiedAccessTrustProvider": { + "target": "com.amazonaws.ec2#VerifiedAccessTrustProvider", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessTrustProvider", + "smithy.api#documentation": "

The ID of the Verified Access trust provider.

", + "smithy.api#xmlName": "verifiedAccessTrustProvider" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateVolume": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateVolumeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#Volume" + }, + "traits": { + "smithy.api#documentation": "

Creates an EBS volume that can be attached to an instance in the same Availability Zone.

\n

You can create a new empty volume or restore a volume from an EBS snapshot.\n Any Amazon Web Services Marketplace product codes from the snapshot are propagated to the volume.

\n

You can create encrypted volumes. Encrypted volumes must be attached to instances that \n support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically \n encrypted. For more information, see Amazon EBS encryption\n in the Amazon Elastic Compute Cloud User Guide.

\n

You can tag your volumes during creation. For more information, see Tag your Amazon EC2\n resources in the Amazon Elastic Compute Cloud User Guide.

\n

For more information, see Create an Amazon EBS volume in the\n Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#CreateVolumePermission": { + "type": "structure", + "members": { + "Group": { + "target": "com.amazonaws.ec2#PermissionGroup", + "traits": { + "aws.protocols#ec2QueryName": "Group", + "smithy.api#documentation": "

The group to be added or removed. The possible value is all.

", + "smithy.api#xmlName": "group" + } + }, + "UserId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UserId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account to be added or removed.

", + "smithy.api#xmlName": "userId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the user or group to be added or removed from the list of create volume\n permissions for a volume.

" + } + }, + "com.amazonaws.ec2#CreateVolumePermissionList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CreateVolumePermission", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CreateVolumePermissionModifications": { + "type": "structure", + "members": { + "Add": { + "target": "com.amazonaws.ec2#CreateVolumePermissionList", + "traits": { + "smithy.api#documentation": "

Adds the specified Amazon Web Services account ID or group to the list.

" + } + }, + "Remove": { + "target": "com.amazonaws.ec2#CreateVolumePermissionList", + "traits": { + "smithy.api#documentation": "

Removes the specified Amazon Web Services account ID or group from the list.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes modifications to the list of create volume permissions for a volume.

" + } + }, + "com.amazonaws.ec2#CreateVolumeRequest": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#AvailabilityZoneName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Availability Zone in which to create the volume.

", + "smithy.api#required": {} + } + }, + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Encrypted", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the volume should be encrypted. \n The effect of setting the encryption state to true depends on \nthe volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. \n For more information, see Encryption by default\n in the Amazon Elastic Compute Cloud User Guide.

\n

Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. \n For more information, see Supported\n instance types.

", + "smithy.api#xmlName": "encrypted" + } + }, + "Iops": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents \n the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline \n performance of the volume and the rate at which the volume accumulates I/O credits for bursting.

\n

The following are the supported values for each volume type:

\n \n

\n io1 and io2 volumes support up to 64,000 IOPS only on \n Instances built on the Nitro System. Other instance families support performance \n up to 32,000 IOPS.

\n

This parameter is required for io1 and io2 volumes.\n The default for gp3 volumes is 3,000 IOPS.\n This parameter is not supported for gp2, st1, sc1, or standard volumes.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.ec2#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption.\n If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is\n specified, the encrypted state must be true.

\n

You can specify the KMS key using any of the following:

\n \n

Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, \n the action can appear to complete, but eventually fails.

" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

" + } + }, + "Size": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size.\n If you specify a snapshot, the default is the snapshot size. You can specify a volume \n size that is equal to or larger than the snapshot size.

\n

The following are the supported volumes sizes for each volume type:

\n " + } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "smithy.api#documentation": "

The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.

" + } + }, + "VolumeType": { + "target": "com.amazonaws.ec2#VolumeType", + "traits": { + "smithy.api#documentation": "

The volume type. This parameter can be one of the following values:

\n \n \n

Throughput Optimized HDD (st1) and Cold HDD (sc1) volumes can't be used as boot volumes.

\n \n

For more information, see Amazon EBS volume types in the\n Amazon Elastic Compute Cloud User Guide.

\n

Default: gp2\n

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the volume during creation.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "MultiAttachEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the \n \tvolume to up to 16 Instances built on the Nitro System in the same Availability Zone. This parameter is \n \tsupported with io1 and io2 volumes only. For more information, \n \tsee \n \t\tAmazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "Throughput": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The throughput to provision for a volume, with a maximum of 1,000 MiB/s.

\n

This parameter is valid only for gp3 volumes.

\n

Valid Range: Minimum value of 125. Maximum value of 1000.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency \n of the request. For more information, see Ensure \n Idempotency.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateVpc": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateVpcRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateVpcResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a VPC with the specified CIDR blocks. For more information, see\n\t VPC CIDR blocks in the Amazon Virtual Private Cloud User Guide.

\n

You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided \n IPv6 CIDR block from Amazon's pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address \n pool that you provisioned through bring your own IP addresses (BYOIP).

\n

By default, each instance that you launch in the VPC has the default DHCP options, which\n\t\t\tinclude only a default DNS server that we provide (AmazonProvidedDNS). For more\n\t\t\tinformation, see DHCP option sets in the Amazon Virtual Private Cloud User Guide.

\n

You can specify the instance tenancy value for the VPC when you create it. You can't change\n this value for the VPC after you create it. For more information, see Dedicated Instances in the\n Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#CreateVpcEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateVpcEndpointRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateVpcEndpointResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a VPC endpoint for a specified service. An endpoint enables you to create a\n private connection between your VPC and the service. The service may be provided by Amazon Web Services,\n an Amazon Web Services Marketplace Partner, or another Amazon Web Services account. For more information, \n see the Amazon Web Services PrivateLink Guide.

" + } + }, + "com.amazonaws.ec2#CreateVpcEndpointConnectionNotification": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateVpcEndpointConnectionNotificationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateVpcEndpointConnectionNotificationResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a connection notification for a specified VPC endpoint or VPC endpoint\n service. A connection notification notifies you of specific endpoint events. You must\n create an SNS topic to receive notifications. For more information, see Create a Topic in\n the Amazon Simple Notification Service Developer Guide.

\n

You can create a connection notification for interface endpoints only.

" + } + }, + "com.amazonaws.ec2#CreateVpcEndpointConnectionNotificationRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ServiceId": { + "target": "com.amazonaws.ec2#VpcEndpointServiceId", + "traits": { + "smithy.api#documentation": "

The ID of the endpoint service.

" + } + }, + "VpcEndpointId": { + "target": "com.amazonaws.ec2#VpcEndpointId", + "traits": { + "smithy.api#documentation": "

The ID of the endpoint.

" + } + }, + "ConnectionNotificationArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the SNS topic for the notifications.

", + "smithy.api#required": {} + } + }, + "ConnectionEvents": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The endpoint events for which to receive notifications. Valid values are\n Accept, Connect, Delete, and\n Reject.

", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateVpcEndpointConnectionNotificationResult": { + "type": "structure", + "members": { + "ConnectionNotification": { + "target": "com.amazonaws.ec2#ConnectionNotification", + "traits": { + "aws.protocols#ec2QueryName": "ConnectionNotification", + "smithy.api#documentation": "

Information about the notification.

", + "smithy.api#xmlName": "connectionNotification" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", + "smithy.api#xmlName": "clientToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateVpcEndpointRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "VpcEndpointType": { + "target": "com.amazonaws.ec2#VpcEndpointType", + "traits": { + "smithy.api#documentation": "

The type of endpoint.

\n

Default: Gateway

" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC for the endpoint.

", + "smithy.api#required": {} + } + }, + "ServiceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The service name.

", + "smithy.api#required": {} + } + }, + "PolicyDocument": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the\n service. The policy must be in valid JSON format. If this parameter is not specified, we\n attach a default policy that allows full access to the service.

" + } + }, + "RouteTableIds": { + "target": "com.amazonaws.ec2#VpcEndpointRouteTableIdList", + "traits": { + "smithy.api#documentation": "

(Gateway endpoint) The route table IDs.

", + "smithy.api#xmlName": "RouteTableId" + } + }, + "SubnetIds": { + "target": "com.amazonaws.ec2#VpcEndpointSubnetIdList", + "traits": { + "smithy.api#documentation": "

(Interface and Gateway Load Balancer endpoints) The IDs of the subnets in which to create an endpoint\n network interface. For a Gateway Load Balancer endpoint, you can specify only one subnet.

", + "smithy.api#xmlName": "SubnetId" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#VpcEndpointSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

(Interface endpoint) The IDs of the security groups to associate with the\n endpoint network interface. If this parameter is not specified, we use the default \n security group for the VPC.

", + "smithy.api#xmlName": "SecurityGroupId" + } + }, + "IpAddressType": { + "target": "com.amazonaws.ec2#IpAddressType", + "traits": { + "smithy.api#documentation": "

The IP address type for the endpoint.

" + } + }, + "DnsOptions": { + "target": "com.amazonaws.ec2#DnsOptionsSpecification", + "traits": { + "smithy.api#documentation": "

The DNS options for the endpoint.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

" + } + }, + "PrivateDnsEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

(Interface endpoint) Indicates whether to associate a private hosted zone with the\n specified VPC. The private hosted zone contains a record set for the default public DNS\n name for the service for the Region (for example,\n kinesis.us-east-1.amazonaws.com), which resolves to the private IP\n addresses of the endpoint network interfaces in the VPC. This enables you to make\n requests to the default public DNS name for the service instead of the public DNS names\n that are automatically generated by the VPC endpoint service.

\n

To use a private hosted zone, you must set the following VPC attributes to\n true: enableDnsHostnames and\n enableDnsSupport. Use ModifyVpcAttribute to set the VPC\n attributes.

\n

Default: true\n

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to associate with the endpoint.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateVpcEndpointResult": { + "type": "structure", + "members": { + "VpcEndpoint": { + "target": "com.amazonaws.ec2#VpcEndpoint", + "traits": { + "aws.protocols#ec2QueryName": "VpcEndpoint", + "smithy.api#documentation": "

Information about the endpoint.

", + "smithy.api#xmlName": "vpcEndpoint" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", + "smithy.api#xmlName": "clientToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateVpcEndpointServiceConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateVpcEndpointServiceConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateVpcEndpointServiceConfigurationResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a VPC endpoint service to which service consumers (Amazon Web Services accounts,\n users, and IAM roles) can connect.

\n

Before you create an endpoint service, you must create one of the following for your service:

\n \n

If you set the private DNS name, you must prove that you own the private DNS domain\n name.

\n

For more information, see the Amazon Web Services PrivateLink \n\t Guide.

" + } + }, + "com.amazonaws.ec2#CreateVpcEndpointServiceConfigurationRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "AcceptanceRequired": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether requests from service consumers to create an endpoint to your service must\n be accepted manually.

" + } + }, + "PrivateDnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

(Interface endpoint configuration) The private DNS name to assign to the VPC endpoint service.

" + } + }, + "NetworkLoadBalancerArns": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the Network Load Balancers.

", + "smithy.api#xmlName": "NetworkLoadBalancerArn" + } + }, + "GatewayLoadBalancerArns": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the Gateway Load Balancers.

", + "smithy.api#xmlName": "GatewayLoadBalancerArn" + } + }, + "SupportedIpAddressTypes": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The supported IP address types. The possible values are ipv4 and ipv6.

", + "smithy.api#xmlName": "SupportedIpAddressType" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.\n For more information, see How to ensure\n idempotency.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to associate with the service.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateVpcEndpointServiceConfigurationResult": { + "type": "structure", + "members": { + "ServiceConfiguration": { + "target": "com.amazonaws.ec2#ServiceConfiguration", + "traits": { + "aws.protocols#ec2QueryName": "ServiceConfiguration", + "smithy.api#documentation": "

Information about the service configuration.

", + "smithy.api#xmlName": "serviceConfiguration" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", + "smithy.api#xmlName": "clientToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateVpcPeeringConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateVpcPeeringConnectionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateVpcPeeringConnectionResult" + }, + "traits": { + "smithy.api#documentation": "

Requests a VPC peering connection between two VPCs: a requester VPC that you own and\n\t\t an accepter VPC with which to create the connection. The accepter VPC can belong to\n\t\t another Amazon Web Services account and can be in a different Region to the requester VPC. \n The requester VPC and accepter VPC cannot have overlapping CIDR blocks.

\n \n

Limitations and rules apply to a VPC peering connection. For more information, see \n the limitations section in the VPC Peering Guide.

\n \n

The owner of the accepter VPC must accept the peering request to activate the peering\n connection. The VPC peering connection request expires after 7 days, after which it\n cannot be accepted or rejected.

\n

If you create a VPC peering connection request between VPCs with overlapping CIDR\n blocks, the VPC peering connection has a status of failed.

" + } + }, + "com.amazonaws.ec2#CreateVpcPeeringConnectionRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "PeerOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PeerOwnerId", + "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the accepter VPC.

\n

Default: Your Amazon Web Services account ID

", + "smithy.api#xmlName": "peerOwnerId" + } + }, + "PeerVpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PeerVpcId", + "smithy.api#documentation": "

The ID of the VPC with which you are creating the VPC peering connection. You must\n\t\t\tspecify this parameter in the request.

", + "smithy.api#xmlName": "peerVpcId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the requester VPC. You must specify this parameter in the\n\t\t\trequest.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "vpcId" + } + }, + "PeerRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Region code for the accepter VPC, if the accepter VPC is located in a Region\n other than the Region in which you make the request.

\n

Default: The Region in which you make the request.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the peering connection.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateVpcPeeringConnectionResult": { + "type": "structure", + "members": { + "VpcPeeringConnection": { + "target": "com.amazonaws.ec2#VpcPeeringConnection", + "traits": { + "aws.protocols#ec2QueryName": "VpcPeeringConnection", + "smithy.api#documentation": "

Information about the VPC peering connection.

", + "smithy.api#xmlName": "vpcPeeringConnection" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateVpcRequest": { + "type": "structure", + "members": { + "CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv4 network range for the VPC, in CIDR notation. For example,\n\t\t 10.0.0.0/16. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

" + } + }, + "AmazonProvidedIpv6CidrBlock": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AmazonProvidedIpv6CidrBlock", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC.\n You cannot specify the range of IP addresses, or the size of the CIDR block.

", + "smithy.api#xmlName": "amazonProvidedIpv6CidrBlock" + } + }, + "Ipv6Pool": { + "target": "com.amazonaws.ec2#Ipv6PoolEc2Id", + "traits": { + "smithy.api#documentation": "

The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.

" + } + }, + "Ipv6CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.

\n

To let Amazon choose the IPv6 CIDR block for you, omit this parameter.

" + } + }, + "Ipv4IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#documentation": "

The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.\n \n

" + } + }, + "Ipv4NetmaskLength": { + "target": "com.amazonaws.ec2#NetmaskLength", + "traits": { + "smithy.api#documentation": "

The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.

" + } + }, + "Ipv6IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#documentation": "

The ID of an IPv6 IPAM pool which will be used to allocate this VPC an IPv6 CIDR. IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.

" + } + }, + "Ipv6NetmaskLength": { + "target": "com.amazonaws.ec2#NetmaskLength", + "traits": { + "smithy.api#documentation": "

The netmask length of the IPv6 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "InstanceTenancy": { + "target": "com.amazonaws.ec2#Tenancy", + "traits": { + "aws.protocols#ec2QueryName": "InstanceTenancy", + "smithy.api#documentation": "

The tenancy options for instances launched into the VPC. For default, instances\n are launched with shared tenancy by default. You can launch instances with any tenancy into a\n shared tenancy VPC. For dedicated, instances are launched as dedicated tenancy\n instances by default. You can only launch instances with a tenancy of dedicated\n or host into a dedicated tenancy VPC.

\n

\n Important: The host value cannot be used with this parameter. Use the default or dedicated values only.

\n

Default: default\n

", + "smithy.api#xmlName": "instanceTenancy" + } + }, + "Ipv6CidrBlockNetworkBorderGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the address to this location.

\n

You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the VPC.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateVpcResult": { + "type": "structure", + "members": { + "Vpc": { + "target": "com.amazonaws.ec2#Vpc", + "traits": { + "aws.protocols#ec2QueryName": "Vpc", + "smithy.api#documentation": "

Information about the VPC.

", + "smithy.api#xmlName": "vpc" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateVpnConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateVpnConnectionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateVpnConnectionResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a VPN connection between an existing virtual private gateway or transit\n gateway and a customer gateway. The supported connection type is\n ipsec.1.

\n

The response includes information that you need to give to your network administrator\n to configure your customer gateway.

\n \n

We strongly recommend that you use HTTPS when calling this operation because the\n response contains sensitive cryptographic information for configuring your customer\n gateway device.

\n \n

If you decide to shut down your VPN connection for any reason and later create a new\n VPN connection, you must reconfigure your customer gateway with the new information\n returned from this call.

\n

This is an idempotent operation. If you perform the operation more than once, Amazon\n EC2 doesn't return an error.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

" + } + }, + "com.amazonaws.ec2#CreateVpnConnectionRequest": { + "type": "structure", + "members": { + "CustomerGatewayId": { + "target": "com.amazonaws.ec2#CustomerGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the customer gateway.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of VPN connection (ipsec.1).

", + "smithy.api#required": {} + } + }, + "VpnGatewayId": { + "target": "com.amazonaws.ec2#VpnGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the virtual private gateway. If you specify a virtual private gateway, you\n cannot specify a transit gateway.

" + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private\n gateway.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Options": { + "target": "com.amazonaws.ec2#VpnConnectionOptionsSpecification", + "traits": { + "aws.protocols#ec2QueryName": "Options", + "smithy.api#documentation": "

The options for the VPN connection.

", + "smithy.api#xmlName": "options" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the VPN connection.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for CreateVpnConnection.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateVpnConnectionResult": { + "type": "structure", + "members": { + "VpnConnection": { + "target": "com.amazonaws.ec2#VpnConnection", + "traits": { + "aws.protocols#ec2QueryName": "VpnConnection", + "smithy.api#documentation": "

Information about the VPN connection.

", + "smithy.api#xmlName": "vpnConnection" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of CreateVpnConnection.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateVpnConnectionRoute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateVpnConnectionRouteRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Creates a static route associated with a VPN connection between an existing virtual\n private gateway and a VPN customer gateway. The static route allows traffic to be routed\n from the virtual private gateway to the VPN customer gateway.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

" + } + }, + "com.amazonaws.ec2#CreateVpnConnectionRouteRequest": { + "type": "structure", + "members": { + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The CIDR block associated with the local subnet of the customer network.

", + "smithy.api#required": {} + } + }, + "VpnConnectionId": { + "target": "com.amazonaws.ec2#VpnConnectionId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPN connection.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for CreateVpnConnectionRoute.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateVpnGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateVpnGatewayRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateVpnGatewayResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a virtual private gateway. A virtual private gateway is the endpoint on the\n VPC side of your VPN connection. You can create a virtual private gateway before\n creating the VPC itself.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

" + } + }, + "com.amazonaws.ec2#CreateVpnGatewayRequest": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone for the virtual private gateway.

" + } + }, + "Type": { + "target": "com.amazonaws.ec2#GatewayType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of VPN connection this virtual private gateway supports.

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the virtual private gateway.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "AmazonSideAsn": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

A private Autonomous System Number (ASN) for the Amazon side of a BGP session. If\n you're using a 16-bit ASN, it must be in the 64512 to 65534 range. If you're using a\n 32-bit ASN, it must be in the 4200000000 to 4294967294 range.

\n

Default: 64512

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for CreateVpnGateway.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateVpnGatewayResult": { + "type": "structure", + "members": { + "VpnGateway": { + "target": "com.amazonaws.ec2#VpnGateway", + "traits": { + "aws.protocols#ec2QueryName": "VpnGateway", + "smithy.api#documentation": "

Information about the virtual private gateway.

", + "smithy.api#xmlName": "vpnGateway" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of CreateVpnGateway.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreditSpecification": { + "type": "structure", + "members": { + "CpuCredits": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CpuCredits", + "smithy.api#documentation": "

The credit option for CPU usage of a T instance.

\n

Valid values: standard | unlimited\n

", + "smithy.api#xmlName": "cpuCredits" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the credit option for CPU usage of a T instance.

" + } + }, + "com.amazonaws.ec2#CreditSpecificationRequest": { + "type": "structure", + "members": { + "CpuCredits": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The credit option for CPU usage of a T instance.

\n

Valid values: standard | unlimited\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The credit option for CPU usage of a T instance.

" + } + }, + "com.amazonaws.ec2#CurrencyCodeValues": { + "type": "enum", + "members": { + "USD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USD" + } + } + } + }, + "com.amazonaws.ec2#CurrentGenerationFlag": { + "type": "boolean" + }, + "com.amazonaws.ec2#CustomerGateway": { + "type": "structure", + "members": { + "BgpAsn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "BgpAsn", + "smithy.api#documentation": "

The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number\n (ASN).

", + "smithy.api#xmlName": "bgpAsn" + } + }, + "CustomerGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CustomerGatewayId", + "smithy.api#documentation": "

The ID of the customer gateway.

", + "smithy.api#xmlName": "customerGatewayId" + } + }, + "IpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpAddress", + "smithy.api#documentation": "

The IP address of the customer gateway device's outside interface.

", + "smithy.api#xmlName": "ipAddress" + } + }, + "CertificateArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CertificateArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the customer gateway certificate.

", + "smithy.api#xmlName": "certificateArn" + } + }, + "State": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the customer gateway (pending | available | deleting |\n deleted).

", + "smithy.api#xmlName": "state" + } + }, + "Type": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The type of VPN connection the customer gateway supports\n (ipsec.1).

", + "smithy.api#xmlName": "type" + } + }, + "DeviceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DeviceName", + "smithy.api#documentation": "

The name of customer gateway device.

", + "smithy.api#xmlName": "deviceName" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the customer gateway.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a customer gateway.

" + } + }, + "com.amazonaws.ec2#CustomerGatewayId": { + "type": "string" + }, + "com.amazonaws.ec2#CustomerGatewayIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CustomerGatewayId", + "traits": { + "smithy.api#xmlName": "CustomerGatewayId" + } + } + }, + "com.amazonaws.ec2#CustomerGatewayList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CustomerGateway", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DITMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 100 + } + } + }, + "com.amazonaws.ec2#DITOMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DataQueries": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DataQuery" + } + }, + "com.amazonaws.ec2#DataQuery": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A user-defined ID associated with a data query that's returned in the dataResponse identifying the query. For example, if you set the Id to MyQuery01in the query, the dataResponse identifies the query as MyQuery01.

" + } + }, + "Source": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Region or Availability Zone that's the source for the data query. For example, us-east-1.

" + } + }, + "Destination": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Region or Availability Zone that's the target for the data query. For example, eu-north-1.

" + } + }, + "Metric": { + "target": "com.amazonaws.ec2#MetricType", + "traits": { + "smithy.api#documentation": "

The metric, aggregation-latency, indicating that network latency is aggregated for the query. This is the only supported metric.

" + } + }, + "Statistic": { + "target": "com.amazonaws.ec2#StatisticType", + "traits": { + "smithy.api#documentation": "

The metric data aggregation period, p50, between the specified startDate and endDate. For example, a metric of five_minutes is the median of all the data points gathered within those five minutes. p50 is the only supported metric.

" + } + }, + "Period": { + "target": "com.amazonaws.ec2#PeriodType", + "traits": { + "smithy.api#documentation": "

The aggregation period used for the data query.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A query used for retrieving network health data.

" + } + }, + "com.amazonaws.ec2#DataResponse": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Id", + "smithy.api#documentation": "

The ID passed in the DataQuery.

", + "smithy.api#xmlName": "id" + } + }, + "Source": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Source", + "smithy.api#documentation": "

The Region or Availability Zone that's the source for the data query. For example, us-east-1.

", + "smithy.api#xmlName": "source" + } + }, + "Destination": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Destination", + "smithy.api#documentation": "

The Region or Availability Zone that's the destination for the data query. For example, eu-west-1.

", + "smithy.api#xmlName": "destination" + } + }, + "Metric": { + "target": "com.amazonaws.ec2#MetricType", + "traits": { + "aws.protocols#ec2QueryName": "Metric", + "smithy.api#documentation": "

The metric used for the network performance request. Only aggregate-latency is supported, which shows network latency during a specified period.

", + "smithy.api#xmlName": "metric" + } + }, + "Statistic": { + "target": "com.amazonaws.ec2#StatisticType", + "traits": { + "aws.protocols#ec2QueryName": "Statistic", + "smithy.api#documentation": "

The statistic used for the network performance request.

", + "smithy.api#xmlName": "statistic" + } + }, + "Period": { + "target": "com.amazonaws.ec2#PeriodType", + "traits": { + "aws.protocols#ec2QueryName": "Period", + "smithy.api#documentation": "

The period used for the network performance request.

", + "smithy.api#xmlName": "period" + } + }, + "MetricPoints": { + "target": "com.amazonaws.ec2#MetricPoints", + "traits": { + "aws.protocols#ec2QueryName": "MetricPointSet", + "smithy.api#documentation": "

A list of MetricPoint objects.

", + "smithy.api#xmlName": "metricPointSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

The response to a DataQuery.

" + } + }, + "com.amazonaws.ec2#DataResponses": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DataResponse", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DatafeedSubscriptionState": { + "type": "enum", + "members": { + "Active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + }, + "Inactive": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Inactive" + } + } + } + }, + "com.amazonaws.ec2#DateTime": { + "type": "timestamp" + }, + "com.amazonaws.ec2#DedicatedHostFlag": { + "type": "boolean" + }, + "com.amazonaws.ec2#DedicatedHostId": { + "type": "string" + }, + "com.amazonaws.ec2#DedicatedHostIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DedicatedHostId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DefaultNetworkCardIndex": { + "type": "integer" + }, + "com.amazonaws.ec2#DefaultRouteTableAssociationValue": { + "type": "enum", + "members": { + "enable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enable" + } + }, + "disable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disable" + } + } + } + }, + "com.amazonaws.ec2#DefaultRouteTablePropagationValue": { + "type": "enum", + "members": { + "enable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enable" + } + }, + "disable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disable" + } + } + } + }, + "com.amazonaws.ec2#DefaultTargetCapacityType": { + "type": "enum", + "members": { + "SPOT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "spot" + } + }, + "ON_DEMAND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "on-demand" + } + } + } + }, + "com.amazonaws.ec2#DefaultingDhcpOptionsId": { + "type": "string" + }, + "com.amazonaws.ec2#DeleteCarrierGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteCarrierGatewayRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteCarrierGatewayResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes a carrier gateway.

\n \n

If you do not delete the route that contains the carrier gateway as the\n Target, the route is a blackhole route. For information about how to delete a route, see \n DeleteRoute.

\n " + } + }, + "com.amazonaws.ec2#DeleteCarrierGatewayRequest": { + "type": "structure", + "members": { + "CarrierGatewayId": { + "target": "com.amazonaws.ec2#CarrierGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the carrier gateway.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteCarrierGatewayResult": { + "type": "structure", + "members": { + "CarrierGateway": { + "target": "com.amazonaws.ec2#CarrierGateway", + "traits": { + "aws.protocols#ec2QueryName": "CarrierGateway", + "smithy.api#documentation": "

Information about the carrier gateway.

", + "smithy.api#xmlName": "carrierGateway" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteClientVpnEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteClientVpnEndpointRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteClientVpnEndpointResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified Client VPN endpoint. You must disassociate all target networks before you \n\t\t\tcan delete a Client VPN endpoint.

" + } + }, + "com.amazonaws.ec2#DeleteClientVpnEndpointRequest": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Client VPN to be deleted.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteClientVpnEndpointResult": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.ec2#ClientVpnEndpointStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The current state of the Client VPN endpoint.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteClientVpnRoute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteClientVpnRouteRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteClientVpnRouteResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes a route from a Client VPN endpoint. You can only delete routes that you manually added using \n\t\t\tthe CreateClientVpnRoute action. You cannot delete routes that were \n\t\t\tautomatically added when associating a subnet. To remove routes that have been automatically added, \n\t\t\tdisassociate the target subnet from the Client VPN endpoint.

" + } + }, + "com.amazonaws.ec2#DeleteClientVpnRouteRequest": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Client VPN endpoint from which the route is to be deleted.

", + "smithy.api#required": {} + } + }, + "TargetVpcSubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#documentation": "

The ID of the target subnet used by the route.

" + } + }, + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, of the route to be deleted.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteClientVpnRouteResult": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.ec2#ClientVpnRouteStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The current state of the route.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteCoipCidr": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteCoipCidrRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteCoipCidrResult" + }, + "traits": { + "smithy.api#documentation": "

\n Deletes a range of customer-owned IP addresses.\n

" + } + }, + "com.amazonaws.ec2#DeleteCoipCidrRequest": { + "type": "structure", + "members": { + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A customer-owned IP address range that you want to delete.

", + "smithy.api#required": {} + } + }, + "CoipPoolId": { + "target": "com.amazonaws.ec2#Ipv4PoolCoipId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n The ID of the customer-owned address pool. \n

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteCoipCidrResult": { + "type": "structure", + "members": { + "CoipCidr": { + "target": "com.amazonaws.ec2#CoipCidr", + "traits": { + "aws.protocols#ec2QueryName": "CoipCidr", + "smithy.api#documentation": "

\n Information about a range of customer-owned IP addresses.\n

", + "smithy.api#xmlName": "coipCidr" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteCoipPool": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteCoipPoolRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteCoipPoolResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes a pool of customer-owned IP (CoIP) addresses.

" + } + }, + "com.amazonaws.ec2#DeleteCoipPoolRequest": { + "type": "structure", + "members": { + "CoipPoolId": { + "target": "com.amazonaws.ec2#Ipv4PoolCoipId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the CoIP pool that you want to delete.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteCoipPoolResult": { + "type": "structure", + "members": { + "CoipPool": { + "target": "com.amazonaws.ec2#CoipPool", + "traits": { + "aws.protocols#ec2QueryName": "CoipPool", + "smithy.api#documentation": "

Information about the CoIP address pool.

", + "smithy.api#xmlName": "coipPool" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteCustomerGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteCustomerGatewayRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified customer gateway. You must delete the VPN connection before you\n can delete the customer gateway.

" + } + }, + "com.amazonaws.ec2#DeleteCustomerGatewayRequest": { + "type": "structure", + "members": { + "CustomerGatewayId": { + "target": "com.amazonaws.ec2#CustomerGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the customer gateway.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DeleteCustomerGateway.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteDhcpOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteDhcpOptionsRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#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.

" + } + }, + "com.amazonaws.ec2#DeleteDhcpOptionsRequest": { + "type": "structure", + "members": { + "DhcpOptionsId": { + "target": "com.amazonaws.ec2#DhcpOptionsId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the DHCP options set.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteEgressOnlyInternetGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteEgressOnlyInternetGatewayRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteEgressOnlyInternetGatewayResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes an egress-only internet gateway.

" + } + }, + "com.amazonaws.ec2#DeleteEgressOnlyInternetGatewayRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "EgressOnlyInternetGatewayId": { + "target": "com.amazonaws.ec2#EgressOnlyInternetGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the egress-only internet gateway.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteEgressOnlyInternetGatewayResult": { + "type": "structure", + "members": { + "ReturnCode": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "ReturnCode", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "returnCode" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteFleetError": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#DeleteFleetErrorCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The error code.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The description for the error code.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an EC2 Fleet error.

" + } + }, + "com.amazonaws.ec2#DeleteFleetErrorCode": { + "type": "enum", + "members": { + "FLEET_ID_DOES_NOT_EXIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fleetIdDoesNotExist" + } + }, + "FLEET_ID_MALFORMED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fleetIdMalformed" + } + }, + "FLEET_NOT_IN_DELETABLE_STATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fleetNotInDeletableState" + } + }, + "UNEXPECTED_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unexpectedError" + } + } + } + }, + "com.amazonaws.ec2#DeleteFleetErrorItem": { + "type": "structure", + "members": { + "Error": { + "target": "com.amazonaws.ec2#DeleteFleetError", + "traits": { + "aws.protocols#ec2QueryName": "Error", + "smithy.api#documentation": "

The error.

", + "smithy.api#xmlName": "error" + } + }, + "FleetId": { + "target": "com.amazonaws.ec2#FleetId", + "traits": { + "aws.protocols#ec2QueryName": "FleetId", + "smithy.api#documentation": "

The ID of the EC2 Fleet.

", + "smithy.api#xmlName": "fleetId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an EC2 Fleet that was not successfully deleted.

" + } + }, + "com.amazonaws.ec2#DeleteFleetErrorSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DeleteFleetErrorItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DeleteFleetSuccessItem": { + "type": "structure", + "members": { + "CurrentFleetState": { + "target": "com.amazonaws.ec2#FleetStateCode", + "traits": { + "aws.protocols#ec2QueryName": "CurrentFleetState", + "smithy.api#documentation": "

The current state of the EC2 Fleet.

", + "smithy.api#xmlName": "currentFleetState" + } + }, + "PreviousFleetState": { + "target": "com.amazonaws.ec2#FleetStateCode", + "traits": { + "aws.protocols#ec2QueryName": "PreviousFleetState", + "smithy.api#documentation": "

The previous state of the EC2 Fleet.

", + "smithy.api#xmlName": "previousFleetState" + } + }, + "FleetId": { + "target": "com.amazonaws.ec2#FleetId", + "traits": { + "aws.protocols#ec2QueryName": "FleetId", + "smithy.api#documentation": "

The ID of the EC2 Fleet.

", + "smithy.api#xmlName": "fleetId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an EC2 Fleet that was successfully deleted.

" + } + }, + "com.amazonaws.ec2#DeleteFleetSuccessSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DeleteFleetSuccessItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DeleteFleets": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteFleetsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteFleetsResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified EC2 Fleets.

\n

After you delete an EC2 Fleet, it launches no new instances.

\n

You must also specify whether a deleted EC2 Fleet should terminate its instances. If you\n choose to terminate the instances, the EC2 Fleet enters the deleted_terminating\n state. Otherwise, the EC2 Fleet enters the deleted_running state, and the instances\n continue to run until they are interrupted or you terminate them manually.

\n

For instant fleets, EC2 Fleet must terminate the instances when the fleet is\n deleted. A deleted instant fleet with running instances is not\n supported.

\n

\n Restrictions\n

\n \n

For more information, see Delete an EC2\n Fleet in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#DeleteFleetsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "FleetIds": { + "target": "com.amazonaws.ec2#FleetIdSet", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the EC2 Fleets.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "FleetId" + } + }, + "TerminateInstances": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to terminate the associated instances when the EC2 Fleet is deleted. The default is to\n terminate the instances.

\n

To let the instances continue to run after the EC2 Fleet is deleted, specify\n no-terminate-instances. Supported only for fleets of type\n maintain and request.

\n

For instant fleets, you cannot specify NoTerminateInstances. A\n deleted instant fleet with running instances is not supported.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteFleetsResult": { + "type": "structure", + "members": { + "SuccessfulFleetDeletions": { + "target": "com.amazonaws.ec2#DeleteFleetSuccessSet", + "traits": { + "aws.protocols#ec2QueryName": "SuccessfulFleetDeletionSet", + "smithy.api#documentation": "

Information about the EC2 Fleets that are successfully deleted.

", + "smithy.api#xmlName": "successfulFleetDeletionSet" + } + }, + "UnsuccessfulFleetDeletions": { + "target": "com.amazonaws.ec2#DeleteFleetErrorSet", + "traits": { + "aws.protocols#ec2QueryName": "UnsuccessfulFleetDeletionSet", + "smithy.api#documentation": "

Information about the EC2 Fleets that are not successfully deleted.

", + "smithy.api#xmlName": "unsuccessfulFleetDeletionSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteFlowLogs": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteFlowLogsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteFlowLogsResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes one or more flow logs.

" + } + }, + "com.amazonaws.ec2#DeleteFlowLogsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "FlowLogIds": { + "target": "com.amazonaws.ec2#FlowLogIdList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

One or more flow log IDs.

\n

Constraint: Maximum of 1000 flow log IDs.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "FlowLogId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteFlowLogsResult": { + "type": "structure", + "members": { + "Unsuccessful": { + "target": "com.amazonaws.ec2#UnsuccessfulItemSet", + "traits": { + "aws.protocols#ec2QueryName": "Unsuccessful", + "smithy.api#documentation": "

Information about the flow logs that could not be deleted successfully.

", + "smithy.api#xmlName": "unsuccessful" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteFpgaImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteFpgaImageRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteFpgaImageResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified Amazon FPGA Image (AFI).

" + } + }, + "com.amazonaws.ec2#DeleteFpgaImageRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "FpgaImageId": { + "target": "com.amazonaws.ec2#FpgaImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the AFI.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteFpgaImageResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Is true if the request succeeds, and an error otherwise.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteInstanceConnectEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteInstanceConnectEndpointRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteInstanceConnectEndpointResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified EC2 Instance Connect Endpoint.

" + } + }, + "com.amazonaws.ec2#DeleteInstanceConnectEndpointRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "InstanceConnectEndpointId": { + "target": "com.amazonaws.ec2#InstanceConnectEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the EC2 Instance Connect Endpoint to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteInstanceConnectEndpointResult": { + "type": "structure", + "members": { + "InstanceConnectEndpoint": { + "target": "com.amazonaws.ec2#Ec2InstanceConnectEndpoint", + "traits": { + "aws.protocols#ec2QueryName": "InstanceConnectEndpoint", + "smithy.api#documentation": "

Information about the EC2 Instance Connect Endpoint.

", + "smithy.api#xmlName": "instanceConnectEndpoint" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteInstanceEventWindow": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteInstanceEventWindowRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteInstanceEventWindowResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified event window.

\n

For more information, see Define event windows for scheduled\n events in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#DeleteInstanceEventWindowRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ForceDelete": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Specify true to force delete the event window. Use the force delete parameter\n if the event window is currently associated with targets.

" + } + }, + "InstanceEventWindowId": { + "target": "com.amazonaws.ec2#InstanceEventWindowId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the event window.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "InstanceEventWindowId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteInstanceEventWindowResult": { + "type": "structure", + "members": { + "InstanceEventWindowState": { + "target": "com.amazonaws.ec2#InstanceEventWindowStateChange", + "traits": { + "aws.protocols#ec2QueryName": "InstanceEventWindowState", + "smithy.api#documentation": "

The state of the event window.

", + "smithy.api#xmlName": "instanceEventWindowState" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteInternetGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteInternetGatewayRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified internet gateway. You must detach the internet gateway from the\n\t\t\tVPC before you can delete it.

" + } + }, + "com.amazonaws.ec2#DeleteInternetGatewayRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "InternetGatewayId": { + "target": "com.amazonaws.ec2#InternetGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "InternetGatewayId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the internet gateway.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "internetGatewayId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteIpam": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteIpamRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteIpamResult" + }, + "traits": { + "smithy.api#documentation": "

Delete an IPAM. Deleting an IPAM removes all monitored data associated with the IPAM including the historical data for CIDRs.

\n

For more information, see Delete an IPAM in the Amazon VPC IPAM User Guide.\n

" + } + }, + "com.amazonaws.ec2#DeleteIpamPool": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteIpamPoolRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteIpamPoolResult" + }, + "traits": { + "smithy.api#documentation": "

Delete an IPAM pool.

\n \n

You cannot delete an IPAM pool if there are allocations in it or CIDRs provisioned to it. To release \n allocations, see ReleaseIpamPoolAllocation. To deprovision pool \n CIDRs, see DeprovisionIpamPoolCidr.

\n \n

For more information, see Delete a pool in the Amazon VPC IPAM User Guide.\n

" + } + }, + "com.amazonaws.ec2#DeleteIpamPoolRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the pool to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteIpamPoolResult": { + "type": "structure", + "members": { + "IpamPool": { + "target": "com.amazonaws.ec2#IpamPool", + "traits": { + "aws.protocols#ec2QueryName": "IpamPool", + "smithy.api#documentation": "

Information about the results of the deletion.

", + "smithy.api#xmlName": "ipamPool" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteIpamRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamId": { + "target": "com.amazonaws.ec2#IpamId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the IPAM to delete.

", + "smithy.api#required": {} + } + }, + "Cascade": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and\n any allocations in the pools in private scopes. You cannot delete the IPAM with this option if there is a pool in your public scope. If you use this option, IPAM does the following:

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteIpamResourceDiscovery": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteIpamResourceDiscoveryRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteIpamResourceDiscoveryResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

" + } + }, + "com.amazonaws.ec2#DeleteIpamResourceDiscoveryRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamResourceDiscoveryId": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IPAM resource discovery ID.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteIpamResourceDiscoveryResult": { + "type": "structure", + "members": { + "IpamResourceDiscovery": { + "target": "com.amazonaws.ec2#IpamResourceDiscovery", + "traits": { + "aws.protocols#ec2QueryName": "IpamResourceDiscovery", + "smithy.api#documentation": "

The IPAM resource discovery.

", + "smithy.api#xmlName": "ipamResourceDiscovery" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteIpamResult": { + "type": "structure", + "members": { + "Ipam": { + "target": "com.amazonaws.ec2#Ipam", + "traits": { + "aws.protocols#ec2QueryName": "Ipam", + "smithy.api#documentation": "

Information about the results of the deletion.

", + "smithy.api#xmlName": "ipam" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteIpamScope": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteIpamScopeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteIpamScopeResult" + }, + "traits": { + "smithy.api#documentation": "

Delete the scope for an IPAM. You cannot delete the default scopes.

\n

For more information, see Delete a scope in the Amazon VPC IPAM User Guide.\n

" + } + }, + "com.amazonaws.ec2#DeleteIpamScopeRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamScopeId": { + "target": "com.amazonaws.ec2#IpamScopeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the scope to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteIpamScopeResult": { + "type": "structure", + "members": { + "IpamScope": { + "target": "com.amazonaws.ec2#IpamScope", + "traits": { + "aws.protocols#ec2QueryName": "IpamScope", + "smithy.api#documentation": "

Information about the results of the deletion.

", + "smithy.api#xmlName": "ipamScope" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteKeyPair": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteKeyPairRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified key pair, by removing the public key from Amazon EC2.

" + } + }, + "com.amazonaws.ec2#DeleteKeyPairRequest": { + "type": "structure", + "members": { + "KeyName": { + "target": "com.amazonaws.ec2#KeyPairName", + "traits": { + "smithy.api#documentation": "

The name of the key pair.

" + } + }, + "KeyPairId": { + "target": "com.amazonaws.ec2#KeyPairId", + "traits": { + "smithy.api#documentation": "

The ID of the key pair.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteLaunchTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteLaunchTemplateRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteLaunchTemplateResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes a launch template. Deleting a launch template deletes all of its\n versions.

" + } + }, + "com.amazonaws.ec2#DeleteLaunchTemplateRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + } + }, + "LaunchTemplateId": { + "target": "com.amazonaws.ec2#LaunchTemplateId", + "traits": { + "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify either the LaunchTemplateId or the\n LaunchTemplateName, but not both.

" + } + }, + "LaunchTemplateName": { + "target": "com.amazonaws.ec2#LaunchTemplateName", + "traits": { + "smithy.api#documentation": "

The name of the launch template.

\n

You must specify either the LaunchTemplateName or the\n LaunchTemplateId, but not both.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteLaunchTemplateResult": { + "type": "structure", + "members": { + "LaunchTemplate": { + "target": "com.amazonaws.ec2#LaunchTemplate", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplate", + "smithy.api#documentation": "

Information about the launch template.

", + "smithy.api#xmlName": "launchTemplate" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteLaunchTemplateVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteLaunchTemplateVersionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteLaunchTemplateVersionsResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes one or more versions of a launch template. You cannot delete the default\n version of a launch template; you must first assign a different version as the default.\n If the default version is the only version for the launch template, you must delete the\n entire launch template using DeleteLaunchTemplate.

" + } + }, + "com.amazonaws.ec2#DeleteLaunchTemplateVersionsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + } + }, + "LaunchTemplateId": { + "target": "com.amazonaws.ec2#LaunchTemplateId", + "traits": { + "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify either the LaunchTemplateId or the\n LaunchTemplateName, but not both.

" + } + }, + "LaunchTemplateName": { + "target": "com.amazonaws.ec2#LaunchTemplateName", + "traits": { + "smithy.api#documentation": "

The name of the launch template.

\n

You must specify either the LaunchTemplateName or the\n LaunchTemplateId, but not both.

" + } + }, + "Versions": { + "target": "com.amazonaws.ec2#VersionStringList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The version numbers of one or more launch template versions to delete.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "LaunchTemplateVersion" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteLaunchTemplateVersionsResponseErrorItem": { + "type": "structure", + "members": { + "LaunchTemplateId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateId", + "smithy.api#documentation": "

The ID of the launch template.

", + "smithy.api#xmlName": "launchTemplateId" + } + }, + "LaunchTemplateName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateName", + "smithy.api#documentation": "

The name of the launch template.

", + "smithy.api#xmlName": "launchTemplateName" + } + }, + "VersionNumber": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "VersionNumber", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The version number of the launch template.

", + "smithy.api#xmlName": "versionNumber" + } + }, + "ResponseError": { + "target": "com.amazonaws.ec2#ResponseError", + "traits": { + "aws.protocols#ec2QueryName": "ResponseError", + "smithy.api#documentation": "

Information about the error.

", + "smithy.api#xmlName": "responseError" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a launch template version that could not be deleted.

" + } + }, + "com.amazonaws.ec2#DeleteLaunchTemplateVersionsResponseErrorSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DeleteLaunchTemplateVersionsResponseErrorItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DeleteLaunchTemplateVersionsResponseSuccessItem": { + "type": "structure", + "members": { + "LaunchTemplateId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateId", + "smithy.api#documentation": "

The ID of the launch template.

", + "smithy.api#xmlName": "launchTemplateId" + } + }, + "LaunchTemplateName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateName", + "smithy.api#documentation": "

The name of the launch template.

", + "smithy.api#xmlName": "launchTemplateName" + } + }, + "VersionNumber": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "VersionNumber", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The version number of the launch template.

", + "smithy.api#xmlName": "versionNumber" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a launch template version that was successfully deleted.

" + } + }, + "com.amazonaws.ec2#DeleteLaunchTemplateVersionsResponseSuccessSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DeleteLaunchTemplateVersionsResponseSuccessItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DeleteLaunchTemplateVersionsResult": { + "type": "structure", + "members": { + "SuccessfullyDeletedLaunchTemplateVersions": { + "target": "com.amazonaws.ec2#DeleteLaunchTemplateVersionsResponseSuccessSet", + "traits": { + "aws.protocols#ec2QueryName": "SuccessfullyDeletedLaunchTemplateVersionSet", + "smithy.api#documentation": "

Information about the launch template versions that were successfully deleted.

", + "smithy.api#xmlName": "successfullyDeletedLaunchTemplateVersionSet" + } + }, + "UnsuccessfullyDeletedLaunchTemplateVersions": { + "target": "com.amazonaws.ec2#DeleteLaunchTemplateVersionsResponseErrorSet", + "traits": { + "aws.protocols#ec2QueryName": "UnsuccessfullyDeletedLaunchTemplateVersionSet", + "smithy.api#documentation": "

Information about the launch template versions that could not be deleted.

", + "smithy.api#xmlName": "unsuccessfullyDeletedLaunchTemplateVersionSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteLocalGatewayRoute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteLocalGatewayRouteRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteLocalGatewayRouteResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified route from the specified local gateway route table.

" + } + }, + "com.amazonaws.ec2#DeleteLocalGatewayRouteRequest": { + "type": "structure", + "members": { + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The CIDR range for the route. This must match the CIDR for the route exactly.

" + } + }, + "LocalGatewayRouteTableId": { + "target": "com.amazonaws.ec2#LocalGatewayRoutetableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the local gateway route table.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "DestinationPrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "smithy.api#documentation": "

\n Use a prefix list in place of DestinationCidrBlock. You cannot use \n DestinationPrefixListId and DestinationCidrBlock in the same request.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteLocalGatewayRouteResult": { + "type": "structure", + "members": { + "Route": { + "target": "com.amazonaws.ec2#LocalGatewayRoute", + "traits": { + "aws.protocols#ec2QueryName": "Route", + "smithy.api#documentation": "

Information about the route.

", + "smithy.api#xmlName": "route" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteLocalGatewayRouteTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteLocalGatewayRouteTableRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteLocalGatewayRouteTableResult" + }, + "traits": { + "smithy.api#documentation": "

\n Deletes a local gateway route table.\n

" + } + }, + "com.amazonaws.ec2#DeleteLocalGatewayRouteTableRequest": { + "type": "structure", + "members": { + "LocalGatewayRouteTableId": { + "target": "com.amazonaws.ec2#LocalGatewayRoutetableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n The ID of the local gateway route table.\n

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteLocalGatewayRouteTableResult": { + "type": "structure", + "members": { + "LocalGatewayRouteTable": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTable", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTable", + "smithy.api#documentation": "

Information about the local gateway route table.

", + "smithy.api#xmlName": "localGatewayRouteTable" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationResult" + }, + "traits": { + "smithy.api#documentation": "

\n Deletes a local gateway route table virtual interface group association.\n

" + } + }, + "com.amazonaws.ec2#DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationRequest": { + "type": "structure", + "members": { + "LocalGatewayRouteTableVirtualInterfaceGroupAssociationId": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n The ID of the local gateway route table virtual interface group association.\n

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationResult": { + "type": "structure", + "members": { + "LocalGatewayRouteTableVirtualInterfaceGroupAssociation": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociation", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableVirtualInterfaceGroupAssociation", + "smithy.api#documentation": "

Information about the association.

", + "smithy.api#xmlName": "localGatewayRouteTableVirtualInterfaceGroupAssociation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteLocalGatewayRouteTableVpcAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteLocalGatewayRouteTableVpcAssociationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteLocalGatewayRouteTableVpcAssociationResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified association between a VPC and local gateway route table.

" + } + }, + "com.amazonaws.ec2#DeleteLocalGatewayRouteTableVpcAssociationRequest": { + "type": "structure", + "members": { + "LocalGatewayRouteTableVpcAssociationId": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the association.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteLocalGatewayRouteTableVpcAssociationResult": { + "type": "structure", + "members": { + "LocalGatewayRouteTableVpcAssociation": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociation", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableVpcAssociation", + "smithy.api#documentation": "

Information about the association.

", + "smithy.api#xmlName": "localGatewayRouteTableVpcAssociation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteManagedPrefixList": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteManagedPrefixListRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteManagedPrefixListResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified managed prefix list. You must first remove all references to the prefix list in your resources.

" + } + }, + "com.amazonaws.ec2#DeleteManagedPrefixListRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "PrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the prefix list.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteManagedPrefixListResult": { + "type": "structure", + "members": { + "PrefixList": { + "target": "com.amazonaws.ec2#ManagedPrefixList", + "traits": { + "aws.protocols#ec2QueryName": "PrefixList", + "smithy.api#documentation": "

Information about the prefix list.

", + "smithy.api#xmlName": "prefixList" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteNatGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteNatGatewayRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteNatGatewayResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified NAT gateway. Deleting a public NAT gateway disassociates its Elastic IP address, \n but does not release the address from your account. Deleting a NAT gateway does not delete any NAT gateway \n routes in your route tables.

" + } + }, + "com.amazonaws.ec2#DeleteNatGatewayRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "NatGatewayId": { + "target": "com.amazonaws.ec2#NatGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the NAT gateway.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "NatGatewayId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteNatGatewayResult": { + "type": "structure", + "members": { + "NatGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NatGatewayId", + "smithy.api#documentation": "

The ID of the NAT gateway.

", + "smithy.api#xmlName": "natGatewayId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteNetworkAcl": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteNetworkAclRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#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.

" + } + }, + "com.amazonaws.ec2#DeleteNetworkAclEntry": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteNetworkAclEntryRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified ingress or egress entry (rule) from the specified network ACL.

" + } + }, + "com.amazonaws.ec2#DeleteNetworkAclEntryRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Egress": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Egress", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the rule is an egress rule.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "egress" + } + }, + "NetworkAclId": { + "target": "com.amazonaws.ec2#NetworkAclId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkAclId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the network ACL.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "networkAclId" + } + }, + "RuleNumber": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "RuleNumber", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The rule number of the entry to delete.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "ruleNumber" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteNetworkAclRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "NetworkAclId": { + "target": "com.amazonaws.ec2#NetworkAclId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkAclId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the network ACL.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "networkAclId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteNetworkInsightsAccessScope": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified Network Access Scope.

" + } + }, + "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeAnalysis": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeAnalysisRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeAnalysisResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified Network Access Scope analysis.

" + } + }, + "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeAnalysisRequest": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeAnalysisId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Network Access Scope analysis.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeAnalysisResult": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeAnalysisId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeAnalysisId", + "smithy.api#documentation": "

The ID of the Network Access Scope analysis.

", + "smithy.api#xmlName": "networkInsightsAccessScopeAnalysisId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "NetworkInsightsAccessScopeId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Network Access Scope.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteNetworkInsightsAccessScopeResult": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeId", + "smithy.api#documentation": "

The ID of the Network Access Scope.

", + "smithy.api#xmlName": "networkInsightsAccessScopeId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteNetworkInsightsAnalysis": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteNetworkInsightsAnalysisRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteNetworkInsightsAnalysisResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified network insights analysis.

" + } + }, + "com.amazonaws.ec2#DeleteNetworkInsightsAnalysisRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "NetworkInsightsAnalysisId": { + "target": "com.amazonaws.ec2#NetworkInsightsAnalysisId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the network insights analysis.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteNetworkInsightsAnalysisResult": { + "type": "structure", + "members": { + "NetworkInsightsAnalysisId": { + "target": "com.amazonaws.ec2#NetworkInsightsAnalysisId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAnalysisId", + "smithy.api#documentation": "

The ID of the network insights analysis.

", + "smithy.api#xmlName": "networkInsightsAnalysisId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteNetworkInsightsPath": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteNetworkInsightsPathRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteNetworkInsightsPathResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified path.

" + } + }, + "com.amazonaws.ec2#DeleteNetworkInsightsPathRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "NetworkInsightsPathId": { + "target": "com.amazonaws.ec2#NetworkInsightsPathId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the path.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteNetworkInsightsPathResult": { + "type": "structure", + "members": { + "NetworkInsightsPathId": { + "target": "com.amazonaws.ec2#NetworkInsightsPathId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsPathId", + "smithy.api#documentation": "

The ID of the path.

", + "smithy.api#xmlName": "networkInsightsPathId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteNetworkInterface": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteNetworkInterfaceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified network interface. You must detach the network interface before you can delete it.

" + } + }, + "com.amazonaws.ec2#DeleteNetworkInterfacePermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteNetworkInterfacePermissionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteNetworkInterfacePermissionResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes a permission for a network interface. By default, you cannot delete the\n\t\t\tpermission if the account for which you're removing the permission has attached the\n\t\t\tnetwork interface to an instance. However, you can force delete the permission,\n\t\t\tregardless of any attachment.

" + } + }, + "com.amazonaws.ec2#DeleteNetworkInterfacePermissionRequest": { + "type": "structure", + "members": { + "NetworkInterfacePermissionId": { + "target": "com.amazonaws.ec2#NetworkInterfacePermissionId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the network interface permission.

", + "smithy.api#required": {} + } + }, + "Force": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Specify true to remove the permission even if the network interface is\n\t\t\tattached to an instance.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is DryRunOperation. \n\t\t\tOtherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DeleteNetworkInterfacePermission.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteNetworkInterfacePermissionResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds, otherwise returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output for DeleteNetworkInterfacePermission.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteNetworkInterfaceRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "networkInterfaceId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DeleteNetworkInterface.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeletePlacementGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeletePlacementGroupRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified placement group. You must terminate all instances in the\n placement group before you can delete the placement group. For more information, see\n Placement groups in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#DeletePlacementGroupRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#PlacementGroupName", + "traits": { + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the placement group.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "groupName" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeletePublicIpv4Pool": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeletePublicIpv4PoolRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeletePublicIpv4PoolResult" + }, + "traits": { + "smithy.api#documentation": "

Delete a public IPv4 pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only.

" + } + }, + "com.amazonaws.ec2#DeletePublicIpv4PoolRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "PoolId": { + "target": "com.amazonaws.ec2#Ipv4PoolEc2Id", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the public IPv4 pool you want to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeletePublicIpv4PoolResult": { + "type": "structure", + "members": { + "ReturnValue": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "ReturnValue", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Information about the result of deleting the public IPv4 pool.

", + "smithy.api#xmlName": "returnValue" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteQueuedReservedInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteQueuedReservedInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteQueuedReservedInstancesResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the queued purchases for the specified Reserved Instances.

" + } + }, + "com.amazonaws.ec2#DeleteQueuedReservedInstancesError": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#DeleteQueuedReservedInstancesErrorCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The error code.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The error message.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the error for a Reserved Instance whose queued purchase could not be deleted.

" + } + }, + "com.amazonaws.ec2#DeleteQueuedReservedInstancesErrorCode": { + "type": "enum", + "members": { + "RESERVED_INSTANCES_ID_INVALID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "reserved-instances-id-invalid" + } + }, + "RESERVED_INSTANCES_NOT_IN_QUEUED_STATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "reserved-instances-not-in-queued-state" + } + }, + "UNEXPECTED_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unexpected-error" + } + } + } + }, + "com.amazonaws.ec2#DeleteQueuedReservedInstancesIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ReservationId", + "traits": { + "smithy.api#xmlName": "item" + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.ec2#DeleteQueuedReservedInstancesRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ReservedInstancesIds": { + "target": "com.amazonaws.ec2#DeleteQueuedReservedInstancesIdList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the Reserved Instances.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "ReservedInstancesId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteQueuedReservedInstancesResult": { + "type": "structure", + "members": { + "SuccessfulQueuedPurchaseDeletions": { + "target": "com.amazonaws.ec2#SuccessfulQueuedPurchaseDeletionSet", + "traits": { + "aws.protocols#ec2QueryName": "SuccessfulQueuedPurchaseDeletionSet", + "smithy.api#documentation": "

Information about the queued purchases that were successfully deleted.

", + "smithy.api#xmlName": "successfulQueuedPurchaseDeletionSet" + } + }, + "FailedQueuedPurchaseDeletions": { + "target": "com.amazonaws.ec2#FailedQueuedPurchaseDeletionSet", + "traits": { + "aws.protocols#ec2QueryName": "FailedQueuedPurchaseDeletionSet", + "smithy.api#documentation": "

Information about the queued purchases that could not be deleted.

", + "smithy.api#xmlName": "failedQueuedPurchaseDeletionSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteRoute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteRouteRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified route from the specified route table.

" + } + }, + "com.amazonaws.ec2#DeleteRouteRequest": { + "type": "structure", + "members": { + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationCidrBlock", + "smithy.api#documentation": "

The IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly.

", + "smithy.api#xmlName": "destinationCidrBlock" + } + }, + "DestinationIpv6CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationIpv6CidrBlock", + "smithy.api#documentation": "

The IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly.

", + "smithy.api#xmlName": "destinationIpv6CidrBlock" + } + }, + "DestinationPrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the prefix list for the route.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "RouteTableId": { + "target": "com.amazonaws.ec2#RouteTableId", + "traits": { + "aws.protocols#ec2QueryName": "RouteTableId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the route table.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "routeTableId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteRouteTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteRouteTableRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#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.

" + } + }, + "com.amazonaws.ec2#DeleteRouteTableRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "RouteTableId": { + "target": "com.amazonaws.ec2#RouteTableId", + "traits": { + "aws.protocols#ec2QueryName": "RouteTableId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the route table.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "routeTableId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteSecurityGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteSecurityGroupRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes a security group.

\n

If you attempt to delete a security group that is associated with an instance, or is\n\t\t\t referenced by another security group, the operation fails with\n\t\t\t\tInvalidGroup.InUse in EC2-Classic or\n\t\t\t\tDependencyViolation in EC2-VPC.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " + } + }, + "com.amazonaws.ec2#DeleteSecurityGroupRequest": { + "type": "structure", + "members": { + "GroupId": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "smithy.api#documentation": "

The ID of the security group. Required for a nondefault VPC.

" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#SecurityGroupName", + "traits": { + "smithy.api#documentation": "

[EC2-Classic, default VPC] The name of the security group. You can specify either the\n security group name or the security group ID. For security groups in a nondefault VPC,\n you must specify the security group ID.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteSnapshotRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified snapshot.

\n

When you make periodic snapshots of a volume, the snapshots are incremental, and only the\n blocks on the device that have changed since your last snapshot are saved in the new snapshot.\n When you delete a snapshot, only the data not needed for any other snapshot is removed. So\n regardless of which prior snapshots have been deleted, all active snapshots will have access\n to all the information needed to restore the volume.

\n

You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI.\n You must first de-register the AMI before you can delete the snapshot.

\n

For more information, see Delete an Amazon EBS snapshot in the\n Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#DeleteSnapshotRequest": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the EBS snapshot.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteSpotDatafeedSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteSpotDatafeedSubscriptionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes the data feed for Spot Instances.

" + } + }, + "com.amazonaws.ec2#DeleteSpotDatafeedSubscriptionRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DeleteSpotDatafeedSubscription.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteSubnet": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteSubnetRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.

" + } + }, + "com.amazonaws.ec2#DeleteSubnetCidrReservation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteSubnetCidrReservationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteSubnetCidrReservationResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes a subnet CIDR reservation.

" + } + }, + "com.amazonaws.ec2#DeleteSubnetCidrReservationRequest": { + "type": "structure", + "members": { + "SubnetCidrReservationId": { + "target": "com.amazonaws.ec2#SubnetCidrReservationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the subnet CIDR reservation.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteSubnetCidrReservationResult": { + "type": "structure", + "members": { + "DeletedSubnetCidrReservation": { + "target": "com.amazonaws.ec2#SubnetCidrReservation", + "traits": { + "aws.protocols#ec2QueryName": "DeletedSubnetCidrReservation", + "smithy.api#documentation": "

Information about the deleted subnet CIDR reservation.

", + "smithy.api#xmlName": "deletedSubnetCidrReservation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteSubnetRequest": { + "type": "structure", + "members": { + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the subnet.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteTagsRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified set of tags from the specified set of resources.

\n

To list the current tags, use DescribeTags. For more information about\n tags, see Tag\n your Amazon EC2 resources in the Amazon Elastic Compute Cloud User\n Guide.

" + } + }, + "com.amazonaws.ec2#DeleteTagsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Resources": { + "target": "com.amazonaws.ec2#ResourceIdList", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the resources, separated by spaces.

\n

Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "resourceId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "Tag", + "smithy.api#documentation": "

The tags to delete. Specify a tag key and an optional tag value to delete\n specific tags. If you specify a tag key without a tag value, we delete any tag with this\n key regardless of its value. If you specify a tag key with an empty string as the tag\n value, we delete the tag only if its value is an empty string.

\n

If you omit this parameter, we delete all user-defined tags for the specified\n resources. We do not delete Amazon Web Services-generated tags (tags that have the aws:\n prefix).

\n

Constraints: Up to 1000 tags.

", + "smithy.api#xmlName": "tag" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteTrafficMirrorFilter": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteTrafficMirrorFilterRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteTrafficMirrorFilterResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified Traffic Mirror filter.

\n

You cannot delete a Traffic Mirror filter that is in use by a Traffic Mirror session.

" + } + }, + "com.amazonaws.ec2#DeleteTrafficMirrorFilterRequest": { + "type": "structure", + "members": { + "TrafficMirrorFilterId": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Traffic Mirror filter.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteTrafficMirrorFilterResult": { + "type": "structure", + "members": { + "TrafficMirrorFilterId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorFilterId", + "smithy.api#documentation": "

The ID of the Traffic Mirror filter.

", + "smithy.api#xmlName": "trafficMirrorFilterId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteTrafficMirrorFilterRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteTrafficMirrorFilterRuleRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteTrafficMirrorFilterRuleResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified Traffic Mirror rule.

" + } + }, + "com.amazonaws.ec2#DeleteTrafficMirrorFilterRuleRequest": { + "type": "structure", + "members": { + "TrafficMirrorFilterRuleId": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterRuleIdWithResolver", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Traffic Mirror rule.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteTrafficMirrorFilterRuleResult": { + "type": "structure", + "members": { + "TrafficMirrorFilterRuleId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorFilterRuleId", + "smithy.api#documentation": "

The ID of the deleted Traffic Mirror rule.

", + "smithy.api#xmlName": "trafficMirrorFilterRuleId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteTrafficMirrorSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteTrafficMirrorSessionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteTrafficMirrorSessionResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified Traffic Mirror session.

" + } + }, + "com.amazonaws.ec2#DeleteTrafficMirrorSessionRequest": { + "type": "structure", + "members": { + "TrafficMirrorSessionId": { + "target": "com.amazonaws.ec2#TrafficMirrorSessionId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Traffic Mirror session.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteTrafficMirrorSessionResult": { + "type": "structure", + "members": { + "TrafficMirrorSessionId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorSessionId", + "smithy.api#documentation": "

The ID of the deleted Traffic Mirror session.

", + "smithy.api#xmlName": "trafficMirrorSessionId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteTrafficMirrorTarget": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteTrafficMirrorTargetRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteTrafficMirrorTargetResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified Traffic Mirror target.

\n

You cannot delete a Traffic Mirror target that is in use by a Traffic Mirror session.

" + } + }, + "com.amazonaws.ec2#DeleteTrafficMirrorTargetRequest": { + "type": "structure", + "members": { + "TrafficMirrorTargetId": { + "target": "com.amazonaws.ec2#TrafficMirrorTargetId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Traffic Mirror target.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteTrafficMirrorTargetResult": { + "type": "structure", + "members": { + "TrafficMirrorTargetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorTargetId", + "smithy.api#documentation": "

The ID of the deleted Traffic Mirror target.

", + "smithy.api#xmlName": "trafficMirrorTargetId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified transit gateway.

" + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayConnect": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayConnectRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayConnectResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified Connect attachment. You must first delete any Connect peers for\n the attachment.

" + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayConnectPeer": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayConnectPeerRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayConnectPeerResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified Connect peer.

" + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayConnectPeerRequest": { + "type": "structure", + "members": { + "TransitGatewayConnectPeerId": { + "target": "com.amazonaws.ec2#TransitGatewayConnectPeerId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Connect peer.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayConnectPeerResult": { + "type": "structure", + "members": { + "TransitGatewayConnectPeer": { + "target": "com.amazonaws.ec2#TransitGatewayConnectPeer", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayConnectPeer", + "smithy.api#documentation": "

Information about the deleted Connect peer.

", + "smithy.api#xmlName": "transitGatewayConnectPeer" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayConnectRequest": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Connect attachment.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayConnectResult": { + "type": "structure", + "members": { + "TransitGatewayConnect": { + "target": "com.amazonaws.ec2#TransitGatewayConnect", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayConnect", + "smithy.api#documentation": "

Information about the deleted Connect attachment.

", + "smithy.api#xmlName": "transitGatewayConnect" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayMulticastDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayMulticastDomainRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayMulticastDomainResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified transit gateway multicast domain.

" + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayMulticastDomainRequest": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayMulticastDomainResult": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomain": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomain", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayMulticastDomain", + "smithy.api#documentation": "

Information about the deleted transit gateway multicast domain.

", + "smithy.api#xmlName": "transitGatewayMulticastDomain" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayPeeringAttachment": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayPeeringAttachmentRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayPeeringAttachmentResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes a transit gateway peering attachment.

" + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayPeeringAttachmentRequest": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway peering attachment.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayPeeringAttachmentResult": { + "type": "structure", + "members": { + "TransitGatewayPeeringAttachment": { + "target": "com.amazonaws.ec2#TransitGatewayPeeringAttachment", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayPeeringAttachment", + "smithy.api#documentation": "

The transit gateway peering attachment.

", + "smithy.api#xmlName": "transitGatewayPeeringAttachment" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayPolicyTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayPolicyTableRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayPolicyTableResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified transit gateway policy table.

" + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayPolicyTableRequest": { + "type": "structure", + "members": { + "TransitGatewayPolicyTableId": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The transit gateway policy table to delete.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayPolicyTableResult": { + "type": "structure", + "members": { + "TransitGatewayPolicyTable": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTable", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayPolicyTable", + "smithy.api#documentation": "

Provides details about the deleted transit gateway policy table.

", + "smithy.api#xmlName": "transitGatewayPolicyTable" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayPrefixListReference": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayPrefixListReferenceRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayPrefixListReferenceResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes a reference (route) to a prefix list in a specified transit gateway route table.

" + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayPrefixListReferenceRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the route table.

", + "smithy.api#required": {} + } + }, + "PrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the prefix list.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayPrefixListReferenceResult": { + "type": "structure", + "members": { + "TransitGatewayPrefixListReference": { + "target": "com.amazonaws.ec2#TransitGatewayPrefixListReference", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayPrefixListReference", + "smithy.api#documentation": "

Information about the deleted prefix list reference.

", + "smithy.api#xmlName": "transitGatewayPrefixListReference" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayRequest": { + "type": "structure", + "members": { + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayResult": { + "type": "structure", + "members": { + "TransitGateway": { + "target": "com.amazonaws.ec2#TransitGateway", + "traits": { + "aws.protocols#ec2QueryName": "TransitGateway", + "smithy.api#documentation": "

Information about the deleted transit gateway.

", + "smithy.api#xmlName": "transitGateway" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayRoute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayRouteRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayRouteResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified route from the specified transit gateway route table.

" + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayRouteRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#required": {} + } + }, + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The CIDR range for the route. This must match the CIDR for the route exactly.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayRouteResult": { + "type": "structure", + "members": { + "Route": { + "target": "com.amazonaws.ec2#TransitGatewayRoute", + "traits": { + "aws.protocols#ec2QueryName": "Route", + "smithy.api#documentation": "

Information about the route.

", + "smithy.api#xmlName": "route" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayRouteTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayRouteTableRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayRouteTableResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified transit gateway route table. You must disassociate the route table from any\n transit gateway route tables before you can delete it.

" + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayRouteTableAnnouncement": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayRouteTableAnnouncementRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayRouteTableAnnouncementResult" + }, + "traits": { + "smithy.api#documentation": "

Advertises to the transit gateway that a transit gateway route table is deleted.

" + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayRouteTableAnnouncementRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableAnnouncementId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The transit gateway route table ID that's being deleted.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayRouteTableAnnouncementResult": { + "type": "structure", + "members": { + "TransitGatewayRouteTableAnnouncement": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncement", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableAnnouncement", + "smithy.api#documentation": "

Provides details about a deleted transit gateway route table.

", + "smithy.api#xmlName": "transitGatewayRouteTableAnnouncement" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayRouteTableRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayRouteTableResult": { + "type": "structure", + "members": { + "TransitGatewayRouteTable": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTable", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTable", + "smithy.api#documentation": "

Information about the deleted transit gateway route table.

", + "smithy.api#xmlName": "transitGatewayRouteTable" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayVpcAttachment": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayVpcAttachmentRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayVpcAttachmentResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified VPC attachment.

" + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayVpcAttachmentRequest": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayVpcAttachmentResult": { + "type": "structure", + "members": { + "TransitGatewayVpcAttachment": { + "target": "com.amazonaws.ec2#TransitGatewayVpcAttachment", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayVpcAttachment", + "smithy.api#documentation": "

Information about the deleted VPC attachment.

", + "smithy.api#xmlName": "transitGatewayVpcAttachment" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteVerifiedAccessEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteVerifiedAccessEndpointRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteVerifiedAccessEndpointResult" + }, + "traits": { + "smithy.api#documentation": "

Delete an Amazon Web Services Verified Access endpoint.

" + } + }, + "com.amazonaws.ec2#DeleteVerifiedAccessEndpointRequest": { + "type": "structure", + "members": { + "VerifiedAccessEndpointId": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access endpoint.

", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteVerifiedAccessEndpointResult": { + "type": "structure", + "members": { + "VerifiedAccessEndpoint": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpoint", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessEndpoint", + "smithy.api#documentation": "

The ID of the Verified Access endpoint.

", + "smithy.api#xmlName": "verifiedAccessEndpoint" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteVerifiedAccessGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteVerifiedAccessGroupRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteVerifiedAccessGroupResult" + }, + "traits": { + "smithy.api#documentation": "

Delete an Amazon Web Services Verified Access group.

" + } + }, + "com.amazonaws.ec2#DeleteVerifiedAccessGroupRequest": { + "type": "structure", + "members": { + "VerifiedAccessGroupId": { + "target": "com.amazonaws.ec2#VerifiedAccessGroupId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access group.

", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteVerifiedAccessGroupResult": { + "type": "structure", + "members": { + "VerifiedAccessGroup": { + "target": "com.amazonaws.ec2#VerifiedAccessGroup", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessGroup", + "smithy.api#documentation": "

The ID of the Verified Access group.

", + "smithy.api#xmlName": "verifiedAccessGroup" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteVerifiedAccessInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteVerifiedAccessInstanceRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteVerifiedAccessInstanceResult" + }, + "traits": { + "smithy.api#documentation": "

Delete an Amazon Web Services Verified Access instance.

" + } + }, + "com.amazonaws.ec2#DeleteVerifiedAccessInstanceRequest": { + "type": "structure", + "members": { + "VerifiedAccessInstanceId": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access instance.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteVerifiedAccessInstanceResult": { + "type": "structure", + "members": { + "VerifiedAccessInstance": { + "target": "com.amazonaws.ec2#VerifiedAccessInstance", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessInstance", + "smithy.api#documentation": "

The ID of the Verified Access instance.

", + "smithy.api#xmlName": "verifiedAccessInstance" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteVerifiedAccessTrustProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteVerifiedAccessTrustProviderRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteVerifiedAccessTrustProviderResult" + }, + "traits": { + "smithy.api#documentation": "

Delete an Amazon Web Services Verified Access trust provider.

" + } + }, + "com.amazonaws.ec2#DeleteVerifiedAccessTrustProviderRequest": { + "type": "structure", + "members": { + "VerifiedAccessTrustProviderId": { + "target": "com.amazonaws.ec2#VerifiedAccessTrustProviderId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access trust provider.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteVerifiedAccessTrustProviderResult": { + "type": "structure", + "members": { + "VerifiedAccessTrustProvider": { + "target": "com.amazonaws.ec2#VerifiedAccessTrustProvider", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessTrustProvider", + "smithy.api#documentation": "

The ID of the Verified Access trust provider.

", + "smithy.api#xmlName": "verifiedAccessTrustProvider" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteVolume": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteVolumeRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified EBS volume. The volume must be in the available state\n (not attached to an instance).

\n

The volume can remain in the deleting state for several minutes.

\n

For more information, see Delete an Amazon EBS volume in the\n Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#DeleteVolumeRequest": { + "type": "structure", + "members": { + "VolumeId": { + "target": "com.amazonaws.ec2#VolumeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the volume.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteVpc": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteVpcRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#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.

" + } + }, + "com.amazonaws.ec2#DeleteVpcEndpointConnectionNotifications": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteVpcEndpointConnectionNotificationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteVpcEndpointConnectionNotificationsResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified VPC endpoint connection notifications.

" + } + }, + "com.amazonaws.ec2#DeleteVpcEndpointConnectionNotificationsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ConnectionNotificationIds": { + "target": "com.amazonaws.ec2#ConnectionNotificationIdsList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the notifications.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "ConnectionNotificationId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteVpcEndpointConnectionNotificationsResult": { + "type": "structure", + "members": { + "Unsuccessful": { + "target": "com.amazonaws.ec2#UnsuccessfulItemSet", + "traits": { + "aws.protocols#ec2QueryName": "Unsuccessful", + "smithy.api#documentation": "

Information about the notifications that could not be deleted\n successfully.

", + "smithy.api#xmlName": "unsuccessful" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteVpcEndpointServiceConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteVpcEndpointServiceConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteVpcEndpointServiceConfigurationsResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified VPC endpoint service configurations. Before you can delete\n an endpoint service configuration, you must reject any Available or\n PendingAcceptance interface endpoint connections that are attached to\n the service.

" + } + }, + "com.amazonaws.ec2#DeleteVpcEndpointServiceConfigurationsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ServiceIds": { + "target": "com.amazonaws.ec2#VpcEndpointServiceIdList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the services.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "ServiceId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteVpcEndpointServiceConfigurationsResult": { + "type": "structure", + "members": { + "Unsuccessful": { + "target": "com.amazonaws.ec2#UnsuccessfulItemSet", + "traits": { + "aws.protocols#ec2QueryName": "Unsuccessful", + "smithy.api#documentation": "

Information about the service configurations that were not deleted, if\n applicable.

", + "smithy.api#xmlName": "unsuccessful" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteVpcEndpoints": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteVpcEndpointsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteVpcEndpointsResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified VPC endpoints.

\n

When you delete a gateway endpoint, we delete the endpoint routes in the route tables for the endpoint.

\n

When you delete a Gateway Load Balancer endpoint, we delete its endpoint network interfaces. \n You can only delete Gateway Load Balancer endpoints when the routes that are associated with the endpoint are deleted.

\n

When you delete an interface endpoint, we delete its endpoint network interfaces.

" + } + }, + "com.amazonaws.ec2#DeleteVpcEndpointsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "VpcEndpointIds": { + "target": "com.amazonaws.ec2#VpcEndpointIdList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the VPC endpoints.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "VpcEndpointId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteVpcEndpointsResult": { + "type": "structure", + "members": { + "Unsuccessful": { + "target": "com.amazonaws.ec2#UnsuccessfulItemSet", + "traits": { + "aws.protocols#ec2QueryName": "Unsuccessful", + "smithy.api#documentation": "

Information about the VPC endpoints that were not successfully deleted.

", + "smithy.api#xmlName": "unsuccessful" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteVpcPeeringConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteVpcPeeringConnectionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteVpcPeeringConnectionResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes a VPC peering connection. Either the owner of the requester VPC or the owner\n of the accepter VPC can delete the VPC peering connection if it's in the\n active state. The owner of the requester VPC can delete a VPC peering\n connection in the pending-acceptance state. You cannot delete a VPC peering\n connection that's in the failed state.

" + } + }, + "com.amazonaws.ec2#DeleteVpcPeeringConnectionRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "VpcPeeringConnectionId": { + "target": "com.amazonaws.ec2#VpcPeeringConnectionId", + "traits": { + "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC peering connection.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "vpcPeeringConnectionId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteVpcPeeringConnectionResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteVpcRequest": { + "type": "structure", + "members": { + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteVpnConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteVpnConnectionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified VPN connection.

\n

If you're deleting the VPC and its associated components, we recommend that you detach\n the virtual private gateway from the VPC and delete the VPC before deleting the VPN\n connection. If you believe that the tunnel credentials for your VPN connection have been\n compromised, you can delete the VPN connection and create a new one that has new keys,\n without needing to delete the VPC or virtual private gateway. If you create a new VPN\n connection, you must reconfigure the customer gateway device using the new configuration\n information returned with the new VPN connection ID.

\n

For certificate-based authentication, delete all Certificate Manager (ACM) private\n certificates used for the Amazon Web Services-side tunnel endpoints for the VPN\n connection before deleting the VPN connection.

" + } + }, + "com.amazonaws.ec2#DeleteVpnConnectionRequest": { + "type": "structure", + "members": { + "VpnConnectionId": { + "target": "com.amazonaws.ec2#VpnConnectionId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPN connection.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DeleteVpnConnection.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteVpnConnectionRoute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteVpnConnectionRouteRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified static route associated with a VPN connection between an\n existing virtual private gateway and a VPN customer gateway. The static route allows\n traffic to be routed from the virtual private gateway to the VPN customer\n gateway.

" + } + }, + "com.amazonaws.ec2#DeleteVpnConnectionRouteRequest": { + "type": "structure", + "members": { + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The CIDR block associated with the local subnet of the customer network.

", + "smithy.api#required": {} + } + }, + "VpnConnectionId": { + "target": "com.amazonaws.ec2#VpnConnectionId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPN connection.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DeleteVpnConnectionRoute.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteVpnGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteVpnGatewayRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified virtual private gateway. You must first detach the virtual\n private gateway from the VPC. Note that you don't need to delete the virtual private\n gateway if you plan to delete and recreate the VPN connection between your VPC and your\n network.

" + } + }, + "com.amazonaws.ec2#DeleteVpnGatewayRequest": { + "type": "structure", + "members": { + "VpnGatewayId": { + "target": "com.amazonaws.ec2#VpnGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the virtual private gateway.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DeleteVpnGateway.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeprovisionByoipCidr": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeprovisionByoipCidrRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeprovisionByoipCidrResult" + }, + "traits": { + "smithy.api#documentation": "

Releases the specified address range that you provisioned for use with your Amazon Web Services resources\n through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.

\n

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\n address range.

" + } + }, + "com.amazonaws.ec2#DeprovisionByoipCidrRequest": { + "type": "structure", + "members": { + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The address range, in CIDR notation. The prefix must be the same prefix \n that you specified when you provisioned the address range.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeprovisionByoipCidrResult": { + "type": "structure", + "members": { + "ByoipCidr": { + "target": "com.amazonaws.ec2#ByoipCidr", + "traits": { + "aws.protocols#ec2QueryName": "ByoipCidr", + "smithy.api#documentation": "

Information about the address range.

", + "smithy.api#xmlName": "byoipCidr" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeprovisionIpamPoolCidr": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeprovisionIpamPoolCidrRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeprovisionIpamPoolCidrResult" + }, + "traits": { + "smithy.api#documentation": "

Deprovision a CIDR provisioned from an IPAM pool. If you deprovision a CIDR from a pool that has a source pool, the CIDR is recycled back into the source pool. For more information, see Deprovision pool CIDRs in the Amazon VPC IPAM User Guide.

" + } + }, + "com.amazonaws.ec2#DeprovisionIpamPoolCidrRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the pool that has the CIDR you want to deprovision.

", + "smithy.api#required": {} + } + }, + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The CIDR which you want to deprovision from the pool.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeprovisionIpamPoolCidrResult": { + "type": "structure", + "members": { + "IpamPoolCidr": { + "target": "com.amazonaws.ec2#IpamPoolCidr", + "traits": { + "aws.protocols#ec2QueryName": "IpamPoolCidr", + "smithy.api#documentation": "

The deprovisioned pool CIDR.

", + "smithy.api#xmlName": "ipamPoolCidr" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeprovisionPublicIpv4PoolCidr": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeprovisionPublicIpv4PoolCidrRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeprovisionPublicIpv4PoolCidrResult" + }, + "traits": { + "smithy.api#documentation": "

Deprovision a CIDR from a public IPv4 pool.

" + } + }, + "com.amazonaws.ec2#DeprovisionPublicIpv4PoolCidrRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "PoolId": { + "target": "com.amazonaws.ec2#Ipv4PoolEc2Id", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the pool that you want to deprovision the CIDR from.

", + "smithy.api#required": {} + } + }, + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The CIDR you want to deprovision from the pool. Enter the CIDR you want to deprovision with a netmask of /32. You must rerun this command for each IP address in the CIDR range. If your CIDR is a /24, you will have to run this command to deprovision each of the 256 IP addresses in the /24 CIDR.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeprovisionPublicIpv4PoolCidrResult": { + "type": "structure", + "members": { + "PoolId": { + "target": "com.amazonaws.ec2#Ipv4PoolEc2Id", + "traits": { + "aws.protocols#ec2QueryName": "PoolId", + "smithy.api#documentation": "

The ID of the pool that you deprovisioned the CIDR from.

", + "smithy.api#xmlName": "poolId" + } + }, + "DeprovisionedAddresses": { + "target": "com.amazonaws.ec2#DeprovisionedAddressSet", + "traits": { + "aws.protocols#ec2QueryName": "DeprovisionedAddressSet", + "smithy.api#documentation": "

The deprovisioned CIDRs.

", + "smithy.api#xmlName": "deprovisionedAddressSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeprovisionedAddressSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DeregisterImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeregisterImageRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Deregisters the specified AMI. After you deregister an AMI, it can't be used to \n launch new instances.

\n

If you deregister an AMI that matches a Recycle Bin retention rule, the AMI is retained\n in the Recycle Bin for the specified retention period. For more information, see Recycle Bin in\n the Amazon EC2 User Guide.

\n

When you deregister an AMI, it doesn't affect any instances that you've already \n launched from the AMI. You'll continue to incur usage costs for those instances until \n you terminate them.

\n

When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was\n\t\t\tcreated for the root volume of the instance during the AMI creation process. When you\n\t\t\tderegister an instance store-backed AMI, it doesn't affect the files that you uploaded\n\t\t\tto Amazon S3 when you created the AMI.

" + } + }, + "com.amazonaws.ec2#DeregisterImageRequest": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DeregisterImage.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeregisterInstanceEventNotificationAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeregisterInstanceEventNotificationAttributesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeregisterInstanceEventNotificationAttributesResult" + }, + "traits": { + "smithy.api#documentation": "

Deregisters tag keys to prevent tags that have the specified tag keys from being included\n\t\t\tin scheduled event notifications for resources in the Region.

" + } + }, + "com.amazonaws.ec2#DeregisterInstanceEventNotificationAttributesRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "InstanceTagAttribute": { + "target": "com.amazonaws.ec2#DeregisterInstanceTagAttributeRequest", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Information about the tag keys to deregister.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeregisterInstanceEventNotificationAttributesResult": { + "type": "structure", + "members": { + "InstanceTagAttribute": { + "target": "com.amazonaws.ec2#InstanceTagNotificationAttribute", + "traits": { + "aws.protocols#ec2QueryName": "InstanceTagAttribute", + "smithy.api#documentation": "

The resulting set of tag keys.

", + "smithy.api#xmlName": "instanceTagAttribute" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeregisterInstanceTagAttributeRequest": { + "type": "structure", + "members": { + "IncludeAllTagsOfInstance": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to deregister all tag keys in the current Region. Specify false \n \t\tto deregister all tag keys.

" + } + }, + "InstanceTagKeys": { + "target": "com.amazonaws.ec2#InstanceTagKeySet", + "traits": { + "smithy.api#documentation": "

Information about the tag keys to deregister.

", + "smithy.api#xmlName": "InstanceTagKey" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the tag keys to deregister for the current Region. You can either specify \n \t\tindividual tag keys or deregister all tag keys in the current Region. You must specify either\n \t\tIncludeAllTagsOfInstance or InstanceTagKeys in the request

" + } + }, + "com.amazonaws.ec2#DeregisterTransitGatewayMulticastGroupMembers": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeregisterTransitGatewayMulticastGroupMembersRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeregisterTransitGatewayMulticastGroupMembersResult" + }, + "traits": { + "smithy.api#documentation": "

Deregisters the specified members (network interfaces) from the transit gateway multicast group.

" + } + }, + "com.amazonaws.ec2#DeregisterTransitGatewayMulticastGroupMembersRequest": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

" + } + }, + "GroupIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

" + } + }, + "NetworkInterfaceIds": { + "target": "com.amazonaws.ec2#TransitGatewayNetworkInterfaceIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the group members' network interfaces.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeregisterTransitGatewayMulticastGroupMembersResult": { + "type": "structure", + "members": { + "DeregisteredMulticastGroupMembers": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDeregisteredGroupMembers", + "traits": { + "aws.protocols#ec2QueryName": "DeregisteredMulticastGroupMembers", + "smithy.api#documentation": "

Information about the deregistered members.

", + "smithy.api#xmlName": "deregisteredMulticastGroupMembers" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeregisterTransitGatewayMulticastGroupSources": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeregisterTransitGatewayMulticastGroupSourcesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeregisterTransitGatewayMulticastGroupSourcesResult" + }, + "traits": { + "smithy.api#documentation": "

Deregisters the specified sources (network interfaces) from the transit gateway multicast group.

" + } + }, + "com.amazonaws.ec2#DeregisterTransitGatewayMulticastGroupSourcesRequest": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

" + } + }, + "GroupIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

" + } + }, + "NetworkInterfaceIds": { + "target": "com.amazonaws.ec2#TransitGatewayNetworkInterfaceIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the group sources' network interfaces.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeregisterTransitGatewayMulticastGroupSourcesResult": { + "type": "structure", + "members": { + "DeregisteredMulticastGroupSources": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDeregisteredGroupSources", + "traits": { + "aws.protocols#ec2QueryName": "DeregisteredMulticastGroupSources", + "smithy.api#documentation": "

Information about the deregistered group sources.

", + "smithy.api#xmlName": "deregisteredMulticastGroupSources" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeAccountAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeAccountAttributesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeAccountAttributesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes attributes of your Amazon Web Services account. The following are the supported account attributes:

\n \n \n

We are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide.

\n " + } + }, + "com.amazonaws.ec2#DescribeAccountAttributesRequest": { + "type": "structure", + "members": { + "AttributeNames": { + "target": "com.amazonaws.ec2#AccountAttributeNameStringList", + "traits": { + "aws.protocols#ec2QueryName": "AttributeName", + "smithy.api#documentation": "

The account attribute names.

", + "smithy.api#xmlName": "attributeName" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeAccountAttributesResult": { + "type": "structure", + "members": { + "AccountAttributes": { + "target": "com.amazonaws.ec2#AccountAttributeList", + "traits": { + "aws.protocols#ec2QueryName": "AccountAttributeSet", + "smithy.api#documentation": "

Information about the account attributes.

", + "smithy.api#xmlName": "accountAttributeSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeAddressTransfers": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeAddressTransfersRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeAddressTransfersResult" + }, + "traits": { + "smithy.api#documentation": "

Describes an Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon Virtual Private Cloud User Guide.

\n

When you transfer an Elastic IP address, there is a two-step handshake\n between the source and transfer Amazon Web Services accounts. When the source account starts the transfer,\n the transfer account has seven days to accept the Elastic IP address\n transfer. During those seven days, the source account can view the\n pending transfer by using this action. After seven days, the\n transfer expires and ownership of the Elastic IP\n address returns to the source\n account. Accepted transfers are visible to the source account for three days\n after the transfers have been accepted.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AddressTransfers", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeAddressTransfersMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeAddressTransfersRequest": { + "type": "structure", + "members": { + "AllocationIds": { + "target": "com.amazonaws.ec2#AllocationIdList", + "traits": { + "smithy.api#documentation": "

The allocation IDs of Elastic IP addresses.

", + "smithy.api#xmlName": "AllocationId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeAddressTransfersMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of address transfers to return in one page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeAddressTransfersResult": { + "type": "structure", + "members": { + "AddressTransfers": { + "target": "com.amazonaws.ec2#AddressTransferList", + "traits": { + "aws.protocols#ec2QueryName": "AddressTransferSet", + "smithy.api#documentation": "

The Elastic IP address transfer.

", + "smithy.api#xmlName": "addressTransferSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeAddresses": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeAddressesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeAddressesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified Elastic IP addresses or all of your Elastic IP addresses.

" + } + }, + "com.amazonaws.ec2#DescribeAddressesAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeAddressesAttributeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeAddressesAttributeResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the attributes of the specified Elastic IP addresses. For requirements, see Using reverse DNS for email applications.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Addresses", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeAddressesAttributeRequest": { + "type": "structure", + "members": { + "AllocationIds": { + "target": "com.amazonaws.ec2#AllocationIds", + "traits": { + "smithy.api#documentation": "

[EC2-VPC] The allocation IDs.

", + "smithy.api#xmlName": "AllocationId" + } + }, + "Attribute": { + "target": "com.amazonaws.ec2#AddressAttributeName", + "traits": { + "smithy.api#documentation": "

The attribute of the IP address.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#AddressMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#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.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeAddressesAttributeResult": { + "type": "structure", + "members": { + "Addresses": { + "target": "com.amazonaws.ec2#AddressSet", + "traits": { + "aws.protocols#ec2QueryName": "AddressSet", + "smithy.api#documentation": "

Information about the IP addresses.

", + "smithy.api#xmlName": "addressSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeAddressesRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "PublicIps": { + "target": "com.amazonaws.ec2#PublicIpStringList", + "traits": { + "smithy.api#documentation": "

One or more Elastic IP addresses.

\n

Default: Describes all your Elastic IP addresses.

", + "smithy.api#xmlName": "PublicIp" + } + }, + "AllocationIds": { + "target": "com.amazonaws.ec2#AllocationIdList", + "traits": { + "smithy.api#documentation": "

Information about the allocation IDs.

", + "smithy.api#xmlName": "AllocationId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeAddressesResult": { + "type": "structure", + "members": { + "Addresses": { + "target": "com.amazonaws.ec2#AddressList", + "traits": { + "aws.protocols#ec2QueryName": "AddressesSet", + "smithy.api#documentation": "

Information about the Elastic IP addresses.

", + "smithy.api#xmlName": "addressesSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeAggregateIdFormat": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeAggregateIdFormatRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeAggregateIdFormatResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the longer ID format settings for all resource types in a specific\n Region. This request is useful for performing a quick audit to determine whether a\n specific Region is fully opted in for longer IDs (17-character IDs).

\n

This request only returns information about resource types that support longer IDs.

\n

The following resource types support longer IDs: bundle |\n conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | instance | internet-gateway |\n network-acl | network-acl-association |\n network-interface | network-interface-attachment |\n prefix-list | reservation | route-table |\n route-table-association | security-group |\n snapshot | subnet |\n subnet-cidr-block-association | volume | vpc |\n vpc-cidr-block-association | vpc-endpoint |\n vpc-peering-connection | vpn-connection | vpn-gateway.

" + } + }, + "com.amazonaws.ec2#DescribeAggregateIdFormatRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeAggregateIdFormatResult": { + "type": "structure", + "members": { + "UseLongIdsAggregated": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "UseLongIdsAggregated", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether all resource types in the Region are configured to use longer IDs.\n This value is only true if all users are configured to use longer IDs for\n all resources types in the Region.

", + "smithy.api#xmlName": "useLongIdsAggregated" + } + }, + "Statuses": { + "target": "com.amazonaws.ec2#IdFormatList", + "traits": { + "aws.protocols#ec2QueryName": "StatusSet", + "smithy.api#documentation": "

Information about each resource's ID format.

", + "smithy.api#xmlName": "statusSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeAvailabilityZones": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeAvailabilityZonesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeAvailabilityZonesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the Availability Zones, Local Zones, and Wavelength Zones that are available to\n you. If there is an event impacting a zone, you can use this request to view the state and any\n provided messages for that zone.

\n

For more information about Availability Zones, Local Zones, and Wavelength Zones, see\n Regions and zones \n in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#DescribeAvailabilityZonesRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "ZoneNames": { + "target": "com.amazonaws.ec2#ZoneNameStringList", + "traits": { + "smithy.api#documentation": "

The names of the Availability Zones, Local Zones, and Wavelength Zones.

", + "smithy.api#xmlName": "ZoneName" + } + }, + "ZoneIds": { + "target": "com.amazonaws.ec2#ZoneIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the Availability Zones, Local Zones, and Wavelength Zones.

", + "smithy.api#xmlName": "ZoneId" + } + }, + "AllAvailabilityZones": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Include all Availability Zones, Local Zones, and Wavelength Zones regardless of your\n opt-in status.

\n

If you do not use this parameter, the results include only the zones for the Regions where you have chosen the option to opt in.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeAvailabilityZonesResult": { + "type": "structure", + "members": { + "AvailabilityZones": { + "target": "com.amazonaws.ec2#AvailabilityZoneList", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneInfo", + "smithy.api#documentation": "

Information about the Availability Zones, Local Zones, and Wavelength Zones.

", + "smithy.api#xmlName": "availabilityZoneInfo" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeAwsNetworkPerformanceMetricSubscriptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeAwsNetworkPerformanceMetricSubscriptionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeAwsNetworkPerformanceMetricSubscriptionsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the current Infrastructure Performance metric subscriptions.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Subscriptions", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeAwsNetworkPerformanceMetricSubscriptionsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.ec2#MaxResultsParam", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeAwsNetworkPerformanceMetricSubscriptionsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "Subscriptions": { + "target": "com.amazonaws.ec2#SubscriptionList", + "traits": { + "aws.protocols#ec2QueryName": "SubscriptionSet", + "smithy.api#documentation": "

Describes the current Infrastructure Performance subscriptions.

", + "smithy.api#xmlName": "subscriptionSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeBundleTasks": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeBundleTasksRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeBundleTasksResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified bundle tasks or all of your bundle tasks.

\n \n

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.

\n ", + "smithy.waiters#waitable": { + "BundleTaskComplete": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "BundleTasks[].State", + "expected": "complete", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "BundleTasks[].State", + "expected": "failed", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.ec2#DescribeBundleTasksRequest": { + "type": "structure", + "members": { + "BundleIds": { + "target": "com.amazonaws.ec2#BundleIdStringList", + "traits": { + "smithy.api#documentation": "

The bundle task IDs.

\n

Default: Describes all your bundle tasks.

", + "smithy.api#xmlName": "BundleId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeBundleTasksResult": { + "type": "structure", + "members": { + "BundleTasks": { + "target": "com.amazonaws.ec2#BundleTaskList", + "traits": { + "aws.protocols#ec2QueryName": "BundleInstanceTasksSet", + "smithy.api#documentation": "

Information about the bundle tasks.

", + "smithy.api#xmlName": "bundleInstanceTasksSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeByoipCidrs": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeByoipCidrsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeByoipCidrsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the IP address ranges that were specified in calls to ProvisionByoipCidr.

\n

To describe the address pools that were created when you provisioned the address\n ranges, use DescribePublicIpv4Pools or DescribeIpv6Pools.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ByoipCidrs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeByoipCidrsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.ec2#DescribeByoipCidrsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeByoipCidrsMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeByoipCidrsResult": { + "type": "structure", + "members": { + "ByoipCidrs": { + "target": "com.amazonaws.ec2#ByoipCidrSet", + "traits": { + "aws.protocols#ec2QueryName": "ByoipCidrSet", + "smithy.api#documentation": "

Information about your address ranges.

", + "smithy.api#xmlName": "byoipCidrSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeCapacityReservationFleets": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeCapacityReservationFleetsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeCapacityReservationFleetsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more Capacity Reservation Fleets.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CapacityReservationFleets", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeCapacityReservationFleetsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.ec2#DescribeCapacityReservationFleetsRequest": { + "type": "structure", + "members": { + "CapacityReservationFleetIds": { + "target": "com.amazonaws.ec2#CapacityReservationFleetIdSet", + "traits": { + "smithy.api#documentation": "

The IDs of the Capacity Reservation Fleets to describe.

", + "smithy.api#xmlName": "CapacityReservationFleetId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeCapacityReservationFleetsMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#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.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeCapacityReservationFleetsResult": { + "type": "structure", + "members": { + "CapacityReservationFleets": { + "target": "com.amazonaws.ec2#CapacityReservationFleetSet", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationFleetSet", + "smithy.api#documentation": "

Information about the Capacity Reservation Fleets.

", + "smithy.api#xmlName": "capacityReservationFleetSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeCapacityReservations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeCapacityReservationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeCapacityReservationsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the \n\t\t \tAmazon Web Services Region that you're currently using.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CapacityReservations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeCapacityReservationsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeCapacityReservationsRequest": { + "type": "structure", + "members": { + "CapacityReservationIds": { + "target": "com.amazonaws.ec2#CapacityReservationIdSet", + "traits": { + "smithy.api#documentation": "

The ID of the Capacity Reservation.

", + "smithy.api#xmlName": "CapacityReservationId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeCapacityReservationsMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#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.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeCapacityReservationsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "CapacityReservations": { + "target": "com.amazonaws.ec2#CapacityReservationSet", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationSet", + "smithy.api#documentation": "

Information about the Capacity Reservations.

", + "smithy.api#xmlName": "capacityReservationSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeCarrierGateways": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeCarrierGatewaysRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeCarrierGatewaysResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more of your carrier gateways.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CarrierGateways", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeCarrierGatewaysRequest": { + "type": "structure", + "members": { + "CarrierGatewayIds": { + "target": "com.amazonaws.ec2#CarrierGatewayIdSet", + "traits": { + "smithy.api#documentation": "

One or more carrier gateway IDs.

", + "smithy.api#xmlName": "CarrierGatewayId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#CarrierGatewayMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeCarrierGatewaysResult": { + "type": "structure", + "members": { + "CarrierGateways": { + "target": "com.amazonaws.ec2#CarrierGatewaySet", + "traits": { + "aws.protocols#ec2QueryName": "CarrierGatewaySet", + "smithy.api#documentation": "

Information about the carrier gateway.

", + "smithy.api#xmlName": "carrierGatewaySet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeClassicLinkInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeClassicLinkInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeClassicLinkInstancesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more of your linked EC2-Classic instances. This request only returns\n\t\t\tinformation about EC2-Classic instances linked to a VPC through ClassicLink. You cannot\n\t\t\tuse this request to return information about other instances.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Instances", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeClassicLinkInstancesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeClassicLinkInstancesRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "InstanceIds": { + "target": "com.amazonaws.ec2#InstanceIdStringList", + "traits": { + "smithy.api#documentation": "

One or more instance IDs. Must be instances linked to a VPC through ClassicLink.

", + "smithy.api#xmlName": "InstanceId" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeClassicLinkInstancesMaxResults", + "traits": { + "aws.protocols#ec2QueryName": "MaxResults", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

\n

Constraint: If the value is greater than 1000, we return only 1000 items.

", + "smithy.api#xmlName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeClassicLinkInstancesResult": { + "type": "structure", + "members": { + "Instances": { + "target": "com.amazonaws.ec2#ClassicLinkInstanceList", + "traits": { + "aws.protocols#ec2QueryName": "InstancesSet", + "smithy.api#documentation": "

Information about one or more linked EC2-Classic instances.

", + "smithy.api#xmlName": "instancesSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeClientVpnAuthorizationRules": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeClientVpnAuthorizationRulesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeClientVpnAuthorizationRulesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the authorization rules for a specified Client VPN endpoint.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AuthorizationRules", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeClientVpnAuthorizationRulesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeClientVpnAuthorizationRulesRequest": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without 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": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token to retrieve the next page of results.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeClientVpnAuthorizationRulesMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#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.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeClientVpnAuthorizationRulesResult": { + "type": "structure", + "members": { + "AuthorizationRules": { + "target": "com.amazonaws.ec2#AuthorizationRuleSet", + "traits": { + "aws.protocols#ec2QueryName": "AuthorizationRule", + "smithy.api#documentation": "

Information about the authorization rules.

", + "smithy.api#xmlName": "authorizationRule" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeClientVpnConnections": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeClientVpnConnectionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeClientVpnConnectionsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes active client connections and connections that have been terminated within the last 60 \n\t\t\tminutes for the specified Client VPN endpoint.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Connections", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeClientVpnConnectionsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeClientVpnConnectionsRequest": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token to retrieve the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeClientVpnConnectionsMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#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": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeClientVpnConnectionsResult": { + "type": "structure", + "members": { + "Connections": { + "target": "com.amazonaws.ec2#ClientVpnConnectionSet", + "traits": { + "aws.protocols#ec2QueryName": "Connections", + "smithy.api#documentation": "

Information about the active and terminated client connections.

", + "smithy.api#xmlName": "connections" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeClientVpnEndpointMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeClientVpnEndpoints": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeClientVpnEndpointsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeClientVpnEndpointsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more Client VPN endpoints in the account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ClientVpnEndpoints", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeClientVpnEndpointsRequest": { + "type": "structure", + "members": { + "ClientVpnEndpointIds": { + "target": "com.amazonaws.ec2#ClientVpnEndpointIdList", + "traits": { + "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", + "smithy.api#xmlName": "ClientVpnEndpointId" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeClientVpnEndpointMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#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": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token to retrieve the next page of results.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeClientVpnEndpointsResult": { + "type": "structure", + "members": { + "ClientVpnEndpoints": { + "target": "com.amazonaws.ec2#EndpointSet", + "traits": { + "aws.protocols#ec2QueryName": "ClientVpnEndpoint", + "smithy.api#documentation": "

Information about the Client VPN endpoints.

", + "smithy.api#xmlName": "clientVpnEndpoint" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeClientVpnRoutes": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeClientVpnRoutesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeClientVpnRoutesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the routes for the specified Client VPN endpoint.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Routes", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeClientVpnRoutesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeClientVpnRoutesRequest": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeClientVpnRoutesMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#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": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token to retrieve the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeClientVpnRoutesResult": { + "type": "structure", + "members": { + "Routes": { + "target": "com.amazonaws.ec2#ClientVpnRouteSet", + "traits": { + "aws.protocols#ec2QueryName": "Routes", + "smithy.api#documentation": "

Information about the Client VPN endpoint routes.

", + "smithy.api#xmlName": "routes" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeClientVpnTargetNetworks": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeClientVpnTargetNetworksRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeClientVpnTargetNetworksResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the target networks associated with the specified Client VPN endpoint.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ClientVpnTargetNetworks", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeClientVpnTargetNetworksMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeClientVpnTargetNetworksRequest": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", + "smithy.api#required": {} + } + }, + "AssociationIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the target network associations.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeClientVpnTargetNetworksMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#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": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token to retrieve the next page of results.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeClientVpnTargetNetworksResult": { + "type": "structure", + "members": { + "ClientVpnTargetNetworks": { + "target": "com.amazonaws.ec2#TargetNetworkSet", + "traits": { + "aws.protocols#ec2QueryName": "ClientVpnTargetNetworks", + "smithy.api#documentation": "

Information about the associated target networks.

", + "smithy.api#xmlName": "clientVpnTargetNetworks" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeCoipPools": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeCoipPoolsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeCoipPoolsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified customer-owned address pools or all of your customer-owned address pools.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CoipPools", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeCoipPoolsRequest": { + "type": "structure", + "members": { + "PoolIds": { + "target": "com.amazonaws.ec2#CoipPoolIdSet", + "traits": { + "smithy.api#documentation": "

The IDs of the address pools.

", + "smithy.api#xmlName": "PoolId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#CoipPoolMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeCoipPoolsResult": { + "type": "structure", + "members": { + "CoipPools": { + "target": "com.amazonaws.ec2#CoipPoolSet", + "traits": { + "aws.protocols#ec2QueryName": "CoipPoolSet", + "smithy.api#documentation": "

Information about the address pools.

", + "smithy.api#xmlName": "coipPoolSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeConversionTaskList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ConversionTask", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DescribeConversionTasks": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeConversionTasksRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeConversionTasksResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified conversion tasks or all your conversion tasks. For more information, see the\n VM Import/Export User Guide.

\n

For information about the import manifest referenced by this API action, see VM Import Manifest.

", + "smithy.waiters#waitable": { + "ConversionTaskCancelled": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "ConversionTasks[].State", + "expected": "cancelled", + "comparator": "allStringEquals" + } + } + } + ], + "minDelay": 15 + }, + "ConversionTaskCompleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "ConversionTasks[].State", + "expected": "completed", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ConversionTasks[].State", + "expected": "cancelled", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ConversionTasks[].State", + "expected": "cancelling", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 15 + }, + "ConversionTaskDeleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "ConversionTasks[].State", + "expected": "deleted", + "comparator": "allStringEquals" + } + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.ec2#DescribeConversionTasksRequest": { + "type": "structure", + "members": { + "ConversionTaskIds": { + "target": "com.amazonaws.ec2#ConversionIdStringList", + "traits": { + "aws.protocols#ec2QueryName": "ConversionTaskId", + "smithy.api#documentation": "

The conversion task IDs.

", + "smithy.api#xmlName": "conversionTaskId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeConversionTasksResult": { + "type": "structure", + "members": { + "ConversionTasks": { + "target": "com.amazonaws.ec2#DescribeConversionTaskList", + "traits": { + "aws.protocols#ec2QueryName": "ConversionTasks", + "smithy.api#documentation": "

Information about the conversion tasks.

", + "smithy.api#xmlName": "conversionTasks" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeCustomerGateways": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeCustomerGatewaysRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeCustomerGatewaysResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more of your VPN customer gateways.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

", + "smithy.waiters#waitable": { + "CustomerGatewayAvailable": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "CustomerGateways[].State", + "expected": "available", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "CustomerGateways[].State", + "expected": "deleted", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "CustomerGateways[].State", + "expected": "deleting", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.ec2#DescribeCustomerGatewaysRequest": { + "type": "structure", + "members": { + "CustomerGatewayIds": { + "target": "com.amazonaws.ec2#CustomerGatewayIdStringList", + "traits": { + "smithy.api#documentation": "

One or more customer gateway IDs.

\n

Default: Describes all your customer gateways.

", + "smithy.api#xmlName": "CustomerGatewayId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeCustomerGateways.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeCustomerGatewaysResult": { + "type": "structure", + "members": { + "CustomerGateways": { + "target": "com.amazonaws.ec2#CustomerGatewayList", + "traits": { + "aws.protocols#ec2QueryName": "CustomerGatewaySet", + "smithy.api#documentation": "

Information about one or more customer gateways.

", + "smithy.api#xmlName": "customerGatewaySet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of DescribeCustomerGateways.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeDhcpOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeDhcpOptionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeDhcpOptionsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more of your DHCP options sets.

\n

For more information, see DHCP options sets in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "DhcpOptions", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeDhcpOptionsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeDhcpOptionsRequest": { + "type": "structure", + "members": { + "DhcpOptionsIds": { + "target": "com.amazonaws.ec2#DhcpOptionsIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of one or more DHCP options sets.

\n

Default: Describes all your DHCP options sets.

", + "smithy.api#xmlName": "DhcpOptionsId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeDhcpOptionsMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeDhcpOptionsResult": { + "type": "structure", + "members": { + "DhcpOptions": { + "target": "com.amazonaws.ec2#DhcpOptionsList", + "traits": { + "aws.protocols#ec2QueryName": "DhcpOptionsSet", + "smithy.api#documentation": "

Information about one or more DHCP options sets.

", + "smithy.api#xmlName": "dhcpOptionsSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeEgressOnlyInternetGateways": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeEgressOnlyInternetGatewaysRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeEgressOnlyInternetGatewaysResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more of your egress-only internet gateways.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "EgressOnlyInternetGateways", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeEgressOnlyInternetGatewaysMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 255 + } + } + }, + "com.amazonaws.ec2#DescribeEgressOnlyInternetGatewaysRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "EgressOnlyInternetGatewayIds": { + "target": "com.amazonaws.ec2#EgressOnlyInternetGatewayIdList", + "traits": { + "smithy.api#documentation": "

One or more egress-only internet gateway IDs.

", + "smithy.api#xmlName": "EgressOnlyInternetGatewayId" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeEgressOnlyInternetGatewaysMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeEgressOnlyInternetGatewaysResult": { + "type": "structure", + "members": { + "EgressOnlyInternetGateways": { + "target": "com.amazonaws.ec2#EgressOnlyInternetGatewayList", + "traits": { + "aws.protocols#ec2QueryName": "EgressOnlyInternetGatewaySet", + "smithy.api#documentation": "

Information about the egress-only internet gateways.

", + "smithy.api#xmlName": "egressOnlyInternetGatewaySet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeElasticGpus": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeElasticGpusRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeElasticGpusResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the Elastic Graphics accelerator associated with your instances. For more information\n about Elastic Graphics, see Amazon Elastic Graphics.

" + } + }, + "com.amazonaws.ec2#DescribeElasticGpusMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 10, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeElasticGpusRequest": { + "type": "structure", + "members": { + "ElasticGpuIds": { + "target": "com.amazonaws.ec2#ElasticGpuIdSet", + "traits": { + "smithy.api#documentation": "

The Elastic Graphics accelerator IDs.

", + "smithy.api#xmlName": "ElasticGpuId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeElasticGpusMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned NextToken value. This value\n can be between 5 and 1000.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to request the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeElasticGpusResult": { + "type": "structure", + "members": { + "ElasticGpuSet": { + "target": "com.amazonaws.ec2#ElasticGpuSet", + "traits": { + "aws.protocols#ec2QueryName": "ElasticGpuSet", + "smithy.api#documentation": "

Information about the Elastic Graphics accelerators.

", + "smithy.api#xmlName": "elasticGpuSet" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MaxResults", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

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

", + "smithy.api#xmlName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is\n null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeExportImageTasks": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeExportImageTasksRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeExportImageTasksResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified export image tasks or all of your export image tasks.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ExportImageTasks", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeExportImageTasksMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.ec2#DescribeExportImageTasksRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

Filter tasks using the task-state filter and one of the following values: active,\n completed, deleting, or deleted.

", + "smithy.api#xmlName": "Filter" + } + }, + "ExportImageTaskIds": { + "target": "com.amazonaws.ec2#ExportImageTaskIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the export image tasks.

", + "smithy.api#xmlName": "ExportImageTaskId" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeExportImageTasksMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return in a single call.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

A token that indicates the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeExportImageTasksResult": { + "type": "structure", + "members": { + "ExportImageTasks": { + "target": "com.amazonaws.ec2#ExportImageTaskList", + "traits": { + "aws.protocols#ec2QueryName": "ExportImageTaskSet", + "smithy.api#documentation": "

Information about the export image tasks.

", + "smithy.api#xmlName": "exportImageTaskSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to get the next page of results. This value is null when there are no more results\n to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeExportTasks": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeExportTasksRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeExportTasksResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified export instance tasks or all of your export instance tasks.

", + "smithy.waiters#waitable": { + "ExportTaskCancelled": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "ExportTasks[].State", + "expected": "cancelled", + "comparator": "allStringEquals" + } + } + } + ], + "minDelay": 15 + }, + "ExportTaskCompleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "ExportTasks[].State", + "expected": "completed", + "comparator": "allStringEquals" + } + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.ec2#DescribeExportTasksRequest": { + "type": "structure", + "members": { + "ExportTaskIds": { + "target": "com.amazonaws.ec2#ExportTaskIdStringList", + "traits": { + "aws.protocols#ec2QueryName": "ExportTaskId", + "smithy.api#documentation": "

The export task IDs.

", + "smithy.api#xmlName": "exportTaskId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

the filters for the export tasks.

", + "smithy.api#xmlName": "Filter" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeExportTasksResult": { + "type": "structure", + "members": { + "ExportTasks": { + "target": "com.amazonaws.ec2#ExportTaskList", + "traits": { + "aws.protocols#ec2QueryName": "ExportTaskSet", + "smithy.api#documentation": "

Information about the export tasks.

", + "smithy.api#xmlName": "exportTaskSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeFastLaunchImages": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeFastLaunchImagesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeFastLaunchImagesResult" + }, + "traits": { + "smithy.api#documentation": "

Describe details for Windows AMIs that are configured for faster launching.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "FastLaunchImages", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeFastLaunchImagesRequest": { + "type": "structure", + "members": { + "ImageIds": { + "target": "com.amazonaws.ec2#FastLaunchImageIdList", + "traits": { + "smithy.api#documentation": "

Details for one or more Windows AMI image IDs.

", + "smithy.api#xmlName": "ImageId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

Use the following filters to streamline results.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeFastLaunchImagesRequestMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeFastLaunchImagesRequestMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.ec2#DescribeFastLaunchImagesResult": { + "type": "structure", + "members": { + "FastLaunchImages": { + "target": "com.amazonaws.ec2#DescribeFastLaunchImagesSuccessSet", + "traits": { + "aws.protocols#ec2QueryName": "FastLaunchImageSet", + "smithy.api#documentation": "

A collection of details about the fast-launch enabled Windows images that meet \n\t\t\tthe requested criteria.

", + "smithy.api#xmlName": "fastLaunchImageSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeFastLaunchImagesSuccessItem": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The image ID that identifies the fast-launch enabled Windows image.

", + "smithy.api#xmlName": "imageId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#FastLaunchResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The resource type that is used for pre-provisioning the Windows AMI. Supported values \n\t\t\tinclude: snapshot.

", + "smithy.api#xmlName": "resourceType" + } + }, + "SnapshotConfiguration": { + "target": "com.amazonaws.ec2#FastLaunchSnapshotConfigurationResponse", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotConfiguration", + "smithy.api#documentation": "

A group of parameters that are used for pre-provisioning the associated \n\t\t\tWindows AMI using snapshots.

", + "smithy.api#xmlName": "snapshotConfiguration" + } + }, + "LaunchTemplate": { + "target": "com.amazonaws.ec2#FastLaunchLaunchTemplateSpecificationResponse", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplate", + "smithy.api#documentation": "

The launch template that the fast-launch enabled Windows AMI uses when it launches \n\t\t\tWindows instances from pre-provisioned snapshots.

", + "smithy.api#xmlName": "launchTemplate" + } + }, + "MaxParallelLaunches": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MaxParallelLaunches", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of instances that Amazon EC2 can launch at the same time to create \n\t\t\tpre-provisioned snapshots for Windows faster launching.

", + "smithy.api#xmlName": "maxParallelLaunches" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The owner ID for the fast-launch enabled Windows AMI.

", + "smithy.api#xmlName": "ownerId" + } + }, + "State": { + "target": "com.amazonaws.ec2#FastLaunchStateCode", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of faster launching for the specified Windows AMI.

", + "smithy.api#xmlName": "state" + } + }, + "StateTransitionReason": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StateTransitionReason", + "smithy.api#documentation": "

The reason that faster launching for the Windows AMI changed to the current state.

", + "smithy.api#xmlName": "stateTransitionReason" + } + }, + "StateTransitionTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "StateTransitionTime", + "smithy.api#documentation": "

The time that faster launching for the Windows AMI changed to the current state.

", + "smithy.api#xmlName": "stateTransitionTime" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describe details about a fast-launch enabled Windows image that meets the requested \n\t\t\tcriteria. Criteria are defined by the DescribeFastLaunchImages action filters.

" + } + }, + "com.amazonaws.ec2#DescribeFastLaunchImagesSuccessSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DescribeFastLaunchImagesSuccessItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DescribeFastSnapshotRestoreSuccessItem": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the snapshot.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "State": { + "target": "com.amazonaws.ec2#FastSnapshotRestoreStateCode", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of fast snapshot restores.

", + "smithy.api#xmlName": "state" + } + }, + "StateTransitionReason": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StateTransitionReason", + "smithy.api#documentation": "

The reason for the state transition. The possible values are as follows:

\n ", + "smithy.api#xmlName": "stateTransitionReason" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that enabled fast snapshot restores on the snapshot.

", + "smithy.api#xmlName": "ownerId" + } + }, + "OwnerAlias": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerAlias", + "smithy.api#documentation": "

The Amazon Web Services owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.

", + "smithy.api#xmlName": "ownerAlias" + } + }, + "EnablingTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "EnablingTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the enabling state.

", + "smithy.api#xmlName": "enablingTime" + } + }, + "OptimizingTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "OptimizingTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the optimizing state.

", + "smithy.api#xmlName": "optimizingTime" + } + }, + "EnabledTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "EnabledTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the enabled state.

", + "smithy.api#xmlName": "enabledTime" + } + }, + "DisablingTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "DisablingTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the disabling state.

", + "smithy.api#xmlName": "disablingTime" + } + }, + "DisabledTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "DisabledTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the disabled state.

", + "smithy.api#xmlName": "disabledTime" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes fast snapshot restores for a snapshot.

" + } + }, + "com.amazonaws.ec2#DescribeFastSnapshotRestoreSuccessSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DescribeFastSnapshotRestoreSuccessItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DescribeFastSnapshotRestores": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeFastSnapshotRestoresRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeFastSnapshotRestoresResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the state of fast snapshot restores for your snapshots.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "FastSnapshotRestores", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeFastSnapshotRestoresMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.ec2#DescribeFastSnapshotRestoresRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeFastSnapshotRestoresMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output. \n\tFor more information, see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeFastSnapshotRestoresResult": { + "type": "structure", + "members": { + "FastSnapshotRestores": { + "target": "com.amazonaws.ec2#DescribeFastSnapshotRestoreSuccessSet", + "traits": { + "aws.protocols#ec2QueryName": "FastSnapshotRestoreSet", + "smithy.api#documentation": "

Information about the state of fast snapshot restores.

", + "smithy.api#xmlName": "fastSnapshotRestoreSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeFleetError": { + "type": "structure", + "members": { + "LaunchTemplateAndOverrides": { + "target": "com.amazonaws.ec2#LaunchTemplateAndOverridesResponse", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateAndOverrides", + "smithy.api#documentation": "

The launch templates and overrides that were used for launching the instances. The\n values that you specify in the Overrides replace the values in the launch template.

", + "smithy.api#xmlName": "launchTemplateAndOverrides" + } + }, + "Lifecycle": { + "target": "com.amazonaws.ec2#InstanceLifecycle", + "traits": { + "aws.protocols#ec2QueryName": "Lifecycle", + "smithy.api#documentation": "

Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.

", + "smithy.api#xmlName": "lifecycle" + } + }, + "ErrorCode": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ErrorCode", + "smithy.api#documentation": "

The error code that indicates why the instance could not be launched. For more\n information about error codes, see Error codes.

", + "smithy.api#xmlName": "errorCode" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ErrorMessage", + "smithy.api#documentation": "

The error message that describes why the instance could not be launched. For more\n information about error messages, see Error codes.

", + "smithy.api#xmlName": "errorMessage" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the instances that could not be launched by the fleet.

" + } + }, + "com.amazonaws.ec2#DescribeFleetHistory": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeFleetHistoryRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeFleetHistoryResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the events for the specified EC2 Fleet during the specified time.

\n

EC2 Fleet events are delayed by up to 30 seconds before they can be described. This ensures\n that you can query by the last evaluated time and not miss a recorded event. EC2 Fleet events\n are available for 48 hours.

\n

For more information, see Monitor fleet events using Amazon EventBridge in the\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#DescribeFleetHistoryRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "EventType": { + "target": "com.amazonaws.ec2#FleetEventType", + "traits": { + "smithy.api#documentation": "

The type of events to describe. By default, all events are described.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "FleetId": { + "target": "com.amazonaws.ec2#FleetId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the EC2 Fleet.

", + "smithy.api#required": {} + } + }, + "StartTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The start date and time for the events, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeFleetHistoryResult": { + "type": "structure", + "members": { + "HistoryRecords": { + "target": "com.amazonaws.ec2#HistoryRecordSet", + "traits": { + "aws.protocols#ec2QueryName": "HistoryRecordSet", + "smithy.api#documentation": "

Information about the events in the history of the EC2 Fleet.

", + "smithy.api#xmlName": "historyRecordSet" + } + }, + "LastEvaluatedTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "LastEvaluatedTime", + "smithy.api#documentation": "

The last date and time for the events, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).\n All records up to this time were retrieved.

\n

If nextToken indicates that there are more items, this value is not\n present.

", + "smithy.api#xmlName": "lastEvaluatedTime" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "FleetId": { + "target": "com.amazonaws.ec2#FleetId", + "traits": { + "aws.protocols#ec2QueryName": "FleetId", + "smithy.api#documentation": "

The ID of the EC Fleet.

", + "smithy.api#xmlName": "fleetId" + } + }, + "StartTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "StartTime", + "smithy.api#documentation": "

The start date and time for the events, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", + "smithy.api#xmlName": "startTime" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeFleetInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeFleetInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeFleetInstancesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the running instances for the specified EC2 Fleet.

\n

For more information, see Monitor your EC2 Fleet in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#DescribeFleetInstancesRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "FleetId": { + "target": "com.amazonaws.ec2#FleetId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the EC2 Fleet.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeFleetInstancesResult": { + "type": "structure", + "members": { + "ActiveInstances": { + "target": "com.amazonaws.ec2#ActiveInstanceSet", + "traits": { + "aws.protocols#ec2QueryName": "ActiveInstanceSet", + "smithy.api#documentation": "

The running instances. This list is refreshed periodically and might be out of\n date.

", + "smithy.api#xmlName": "activeInstanceSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "FleetId": { + "target": "com.amazonaws.ec2#FleetId", + "traits": { + "aws.protocols#ec2QueryName": "FleetId", + "smithy.api#documentation": "

The ID of the EC2 Fleet.

", + "smithy.api#xmlName": "fleetId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeFleets": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeFleetsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeFleetsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified EC2 Fleets or all of your EC2 Fleets.

\n

For more information, see Monitor your EC2 Fleet in the Amazon EC2 User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Fleets", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeFleetsErrorSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DescribeFleetError", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DescribeFleetsInstances": { + "type": "structure", + "members": { + "LaunchTemplateAndOverrides": { + "target": "com.amazonaws.ec2#LaunchTemplateAndOverridesResponse", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateAndOverrides", + "smithy.api#documentation": "

The launch templates and overrides that were used for launching the instances. The\n values that you specify in the Overrides replace the values in the launch template.

", + "smithy.api#xmlName": "launchTemplateAndOverrides" + } + }, + "Lifecycle": { + "target": "com.amazonaws.ec2#InstanceLifecycle", + "traits": { + "aws.protocols#ec2QueryName": "Lifecycle", + "smithy.api#documentation": "

Indicates if the instance that was launched is a Spot Instance or On-Demand Instance.

", + "smithy.api#xmlName": "lifecycle" + } + }, + "InstanceIds": { + "target": "com.amazonaws.ec2#InstanceIdsSet", + "traits": { + "aws.protocols#ec2QueryName": "InstanceIds", + "smithy.api#documentation": "

The IDs of the instances.

", + "smithy.api#xmlName": "instanceIds" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type.

", + "smithy.api#xmlName": "instanceType" + } + }, + "Platform": { + "target": "com.amazonaws.ec2#PlatformValues", + "traits": { + "aws.protocols#ec2QueryName": "Platform", + "smithy.api#documentation": "

The value is Windows for Windows instances. Otherwise, the value is\n blank.

", + "smithy.api#xmlName": "platform" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the instances that were launched by the fleet.

" + } + }, + "com.amazonaws.ec2#DescribeFleetsInstancesSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DescribeFleetsInstances", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DescribeFleetsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "FleetIds": { + "target": "com.amazonaws.ec2#FleetIdSet", + "traits": { + "smithy.api#documentation": "

The IDs of the EC2 Fleets.

\n \n

If a fleet is of type instant, you must specify the fleet ID, otherwise\n it does not appear in the response.

\n ", + "smithy.api#xmlName": "FleetId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeFleetsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "Fleets": { + "target": "com.amazonaws.ec2#FleetSet", + "traits": { + "aws.protocols#ec2QueryName": "FleetSet", + "smithy.api#documentation": "

Information about the EC2 Fleets.

", + "smithy.api#xmlName": "fleetSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeFlowLogs": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeFlowLogsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeFlowLogsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more flow logs.

\n

To view the published flow log records, you must view the log destination. For example, \n the CloudWatch Logs log group, the Amazon S3 bucket, or the Kinesis Data Firehose delivery stream.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "FlowLogs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeFlowLogsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filter": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n " + } + }, + "FlowLogIds": { + "target": "com.amazonaws.ec2#FlowLogIdList", + "traits": { + "smithy.api#documentation": "

One or more flow log IDs.

\n

Constraint: Maximum of 1000 flow log IDs.

", + "smithy.api#xmlName": "FlowLogId" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to request the next page of items. Pagination continues from the end of the items returned by the previous request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeFlowLogsResult": { + "type": "structure", + "members": { + "FlowLogs": { + "target": "com.amazonaws.ec2#FlowLogSet", + "traits": { + "aws.protocols#ec2QueryName": "FlowLogSet", + "smithy.api#documentation": "

Information about the flow logs.

", + "smithy.api#xmlName": "flowLogSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to request the next page of items. This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeFpgaImageAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeFpgaImageAttributeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeFpgaImageAttributeResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified attribute of the specified Amazon FPGA Image (AFI).

" + } + }, + "com.amazonaws.ec2#DescribeFpgaImageAttributeRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "FpgaImageId": { + "target": "com.amazonaws.ec2#FpgaImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the AFI.

", + "smithy.api#required": {} + } + }, + "Attribute": { + "target": "com.amazonaws.ec2#FpgaImageAttributeName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The AFI attribute.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeFpgaImageAttributeResult": { + "type": "structure", + "members": { + "FpgaImageAttribute": { + "target": "com.amazonaws.ec2#FpgaImageAttribute", + "traits": { + "aws.protocols#ec2QueryName": "FpgaImageAttribute", + "smithy.api#documentation": "

Information about the attribute.

", + "smithy.api#xmlName": "fpgaImageAttribute" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeFpgaImages": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeFpgaImagesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeFpgaImagesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the Amazon FPGA Images (AFIs) available to you. These include public AFIs,\n\t\t\tprivate AFIs that you own, and AFIs owned by other Amazon Web Services accounts for which you have load\n\t\t\tpermissions.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "FpgaImages", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeFpgaImagesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeFpgaImagesRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "FpgaImageIds": { + "target": "com.amazonaws.ec2#FpgaImageIdList", + "traits": { + "smithy.api#documentation": "

The AFI IDs.

", + "smithy.api#xmlName": "FpgaImageId" + } + }, + "Owners": { + "target": "com.amazonaws.ec2#OwnerStringList", + "traits": { + "smithy.api#documentation": "

Filters the AFI by owner. Specify an Amazon Web Services account ID, self \n\t\t\t(owner is the sender of the request), or an Amazon Web Services owner alias (valid values are \n\t\t\tamazon | aws-marketplace).

", + "smithy.api#xmlName": "Owner" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token to retrieve the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeFpgaImagesMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return in a single call.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeFpgaImagesResult": { + "type": "structure", + "members": { + "FpgaImages": { + "target": "com.amazonaws.ec2#FpgaImageList", + "traits": { + "aws.protocols#ec2QueryName": "FpgaImageSet", + "smithy.api#documentation": "

Information about the FPGA images.

", + "smithy.api#xmlName": "fpgaImageSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeHostReservationOfferings": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeHostReservationOfferingsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeHostReservationOfferingsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the Dedicated Host reservations that are available to purchase.

\n

The results describe all of the Dedicated Host reservation offerings, including\n offerings that might not match the instance family and Region of your Dedicated Hosts.\n When purchasing an offering, ensure that the instance family and Region of the offering\n matches that of the Dedicated Hosts with which it is to be associated. For more\n information about supported instance types, see Dedicated Hosts\n in the Amazon EC2 User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "OfferingSet", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeHostReservationOfferingsRequest": { + "type": "structure", + "members": { + "Filter": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n " + } + }, + "MaxDuration": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

This is the maximum duration of the reservation to purchase, specified in seconds.\n Reservations are available in one-year and three-year terms. The number of seconds\n specified must be the number of seconds in a year (365x24x60x60) times one of the\n supported durations (1 or 3). For example, specify 94608000 for three years.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeHostReservationsMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#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": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

This is the minimum duration of the reservation you'd like to purchase, specified in\n seconds. Reservations are available in one-year and three-year terms. The number of\n seconds specified must be the number of seconds in a year (365x24x60x60) times one of\n the supported durations (1 or 3). For example, specify 31536000 for one year.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" + } + }, + "OfferingId": { + "target": "com.amazonaws.ec2#OfferingId", + "traits": { + "smithy.api#documentation": "

The ID of the reservation offering.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeHostReservationOfferingsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "OfferingSet": { + "target": "com.amazonaws.ec2#HostOfferingSet", + "traits": { + "aws.protocols#ec2QueryName": "OfferingSet", + "smithy.api#documentation": "

Information about the offerings.

", + "smithy.api#xmlName": "offeringSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeHostReservations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeHostReservationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeHostReservationsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes reservations that are associated with Dedicated Hosts in your\n account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "HostReservationSet", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeHostReservationsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 500 + } + } + }, + "com.amazonaws.ec2#DescribeHostReservationsRequest": { + "type": "structure", + "members": { + "Filter": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n " + } + }, + "HostReservationIdSet": { + "target": "com.amazonaws.ec2#HostReservationIdSet", + "traits": { + "smithy.api#documentation": "

The host reservation IDs.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#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": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeHostReservationsResult": { + "type": "structure", + "members": { + "HostReservationSet": { + "target": "com.amazonaws.ec2#HostReservationSet", + "traits": { + "aws.protocols#ec2QueryName": "HostReservationSet", + "smithy.api#documentation": "

Details about the reservation's configuration.

", + "smithy.api#xmlName": "hostReservationSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeHosts": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeHostsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeHostsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified Dedicated Hosts or all your Dedicated Hosts.

\n

The results describe only the Dedicated Hosts in the Region you're currently using.\n All listed instances consume capacity on your Dedicated Host. Dedicated Hosts that have\n recently been released are listed with the state released.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Hosts", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeHostsRequest": { + "type": "structure", + "members": { + "Filter": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "aws.protocols#ec2QueryName": "Filter", + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "filter" + } + }, + "HostIds": { + "target": "com.amazonaws.ec2#RequestHostIdList", + "traits": { + "aws.protocols#ec2QueryName": "HostId", + "smithy.api#documentation": "

The IDs of the Dedicated Hosts. The IDs are used for targeted instance\n launches.

", + "smithy.api#xmlName": "hostId" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MaxResults", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#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.

\n

You cannot specify this parameter and the host IDs parameter in the same\n request.

", + "smithy.api#xmlName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeHostsResult": { + "type": "structure", + "members": { + "Hosts": { + "target": "com.amazonaws.ec2#HostList", + "traits": { + "aws.protocols#ec2QueryName": "HostSet", + "smithy.api#documentation": "

Information about the Dedicated Hosts.

", + "smithy.api#xmlName": "hostSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeIamInstanceProfileAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeIamInstanceProfileAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeIamInstanceProfileAssociationsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes your IAM instance profile associations.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "IamInstanceProfileAssociations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeIamInstanceProfileAssociationsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeIamInstanceProfileAssociationsRequest": { + "type": "structure", + "members": { + "AssociationIds": { + "target": "com.amazonaws.ec2#AssociationIdList", + "traits": { + "smithy.api#documentation": "

The IAM instance profile associations.

", + "smithy.api#xmlName": "AssociationId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeIamInstanceProfileAssociationsMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return for this request. To get the next page of\n items, make another request with the token returned in the output. For more information, \n see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeIamInstanceProfileAssociationsResult": { + "type": "structure", + "members": { + "IamInstanceProfileAssociations": { + "target": "com.amazonaws.ec2#IamInstanceProfileAssociationSet", + "traits": { + "aws.protocols#ec2QueryName": "IamInstanceProfileAssociationSet", + "smithy.api#documentation": "

Information about the IAM instance profile associations.

", + "smithy.api#xmlName": "iamInstanceProfileAssociationSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeIdFormat": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeIdFormatRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeIdFormatResult" + }, + "traits": { + "smithy.api#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.

\n

The following resource types support longer IDs: bundle |\n conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | instance | internet-gateway |\n network-acl | network-acl-association |\n network-interface | network-interface-attachment |\n prefix-list | reservation | route-table |\n route-table-association | security-group |\n snapshot | subnet |\n subnet-cidr-block-association | volume | vpc\n | vpc-cidr-block-association | vpc-endpoint |\n vpc-peering-connection | vpn-connection | vpn-gateway.

\n

These settings apply to the IAM user who makes the request; they do not apply to the entire\n Amazon Web Services account. By default, an IAM user defaults to the same settings as the root user, unless\n they explicitly override the settings by running the ModifyIdFormat command. Resources\n created with longer IDs are visible to all IAM users, regardless of these settings and\n provided that they have permission to use the relevant Describe command for the\n resource type.

" + } + }, + "com.amazonaws.ec2#DescribeIdFormatRequest": { + "type": "structure", + "members": { + "Resource": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The type of resource: bundle |\n conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | instance | internet-gateway |\n network-acl | network-acl-association |\n network-interface | network-interface-attachment |\n prefix-list | reservation | route-table |\n route-table-association | security-group |\n snapshot | subnet |\n subnet-cidr-block-association | volume | vpc\n | vpc-cidr-block-association | vpc-endpoint |\n vpc-peering-connection | vpn-connection | vpn-gateway\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeIdFormatResult": { + "type": "structure", + "members": { + "Statuses": { + "target": "com.amazonaws.ec2#IdFormatList", + "traits": { + "aws.protocols#ec2QueryName": "StatusSet", + "smithy.api#documentation": "

Information about the ID format for the resource.

", + "smithy.api#xmlName": "statusSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeIdentityIdFormat": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeIdentityIdFormatRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeIdentityIdFormatResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the ID format settings for resources for the specified IAM user, IAM role, or root\n user. For example, you can view the resource types that are enabled for longer IDs. This request only\n returns information about resource types whose ID formats can be modified; it does not return\n information about other resource types. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.

\n

The following resource types support longer IDs: bundle |\n conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | instance | internet-gateway |\n network-acl | network-acl-association |\n network-interface | network-interface-attachment |\n prefix-list | reservation | route-table |\n route-table-association | security-group |\n snapshot | subnet |\n subnet-cidr-block-association | volume | vpc\n | vpc-cidr-block-association | vpc-endpoint |\n vpc-peering-connection | vpn-connection | vpn-gateway.

\n

These settings apply to the principal specified in the request. They do not apply to the\n principal that makes the request.

" + } + }, + "com.amazonaws.ec2#DescribeIdentityIdFormatRequest": { + "type": "structure", + "members": { + "PrincipalArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrincipalArn", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the principal, which can be an IAM role, IAM user, or the root user.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "principalArn" + } + }, + "Resource": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Resource", + "smithy.api#documentation": "

The type of resource: bundle |\n conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | instance | internet-gateway |\n network-acl | network-acl-association |\n network-interface | network-interface-attachment |\n prefix-list | reservation | route-table |\n route-table-association | security-group |\n snapshot | subnet |\n subnet-cidr-block-association | volume | vpc\n | vpc-cidr-block-association | vpc-endpoint |\n vpc-peering-connection | vpn-connection | vpn-gateway\n

", + "smithy.api#xmlName": "resource" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeIdentityIdFormatResult": { + "type": "structure", + "members": { + "Statuses": { + "target": "com.amazonaws.ec2#IdFormatList", + "traits": { + "aws.protocols#ec2QueryName": "StatusSet", + "smithy.api#documentation": "

Information about the ID format for the resources.

", + "smithy.api#xmlName": "statusSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeImageAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeImageAttributeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ImageAttribute" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.

" + } + }, + "com.amazonaws.ec2#DescribeImageAttributeRequest": { + "type": "structure", + "members": { + "Attribute": { + "target": "com.amazonaws.ec2#ImageAttributeName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The AMI attribute.

\n

\n Note: The blockDeviceMapping attribute is deprecated. \n \t Using this attribute returns the Client.AuthFailure error. To get information about \n \t the block device mappings for an AMI, use the DescribeImages action.

", + "smithy.api#required": {} + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeImageAttribute.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeImages": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeImagesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeImagesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.

\n

The images available to you include public images, private images that you own, and private images owned by other \n Amazon Web Services accounts for which you have explicit launch permissions.

\n

Recently deregistered images appear in the returned results for a short interval and then\n return empty results. After all instances that reference a deregistered AMI are terminated,\n specifying the ID of the image will eventually return an error indicating that the AMI ID\n cannot be found.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Images", + "pageSize": "MaxResults" + }, + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "ImageAvailable": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Images[].State", + "expected": "available", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Images[].State", + "expected": "failed", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 15 + }, + "ImageExists": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "length(Images[]) > `0`", + "expected": "true", + "comparator": "booleanEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "errorType": "InvalidAMIID.NotFound" + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.ec2#DescribeImagesRequest": { + "type": "structure", + "members": { + "ExecutableUsers": { + "target": "com.amazonaws.ec2#ExecutableByStringList", + "traits": { + "smithy.api#documentation": "

Scopes the images by users with explicit launch permissions. \n Specify an Amazon Web Services account ID, self (the sender of the request),\n\t\t\t\tor all (public AMIs).

\n ", + "smithy.api#xmlName": "ExecutableBy" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "ImageIds": { + "target": "com.amazonaws.ec2#ImageIdStringList", + "traits": { + "smithy.api#documentation": "

The image IDs.

\n

Default: Describes all images available to you.

", + "smithy.api#xmlName": "ImageId" + } + }, + "Owners": { + "target": "com.amazonaws.ec2#OwnerStringList", + "traits": { + "smithy.api#documentation": "

Scopes the results to images with the specified owners. You can specify a combination of \n Amazon Web Services account IDs, self, amazon, and aws-marketplace. \n If you omit this parameter, the results include all images for which you have launch permissions, \n regardless of ownership.

", + "smithy.api#xmlName": "Owner" + } + }, + "IncludeDeprecated": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether to include deprecated AMIs.

\n

Default: No deprecated AMIs are included in the response.

\n \n

If you are the AMI owner, all deprecated AMIs appear in the response regardless of what\n you specify for this parameter.

\n " + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeImagesResult": { + "type": "structure", + "members": { + "Images": { + "target": "com.amazonaws.ec2#ImageList", + "traits": { + "aws.protocols#ec2QueryName": "ImagesSet", + "smithy.api#documentation": "

Information about the images.

", + "smithy.api#xmlName": "imagesSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeImportImageTasks": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeImportImageTasksRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeImportImageTasksResult" + }, + "traits": { + "smithy.api#documentation": "

Displays details about an import virtual machine or import snapshot tasks that are already created.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ImportImageTasks", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeImportImageTasksRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

Filter tasks using the task-state filter and one of the following values: active,\n completed, deleting, or deleted.

", + "smithy.api#xmlName": "Filters" + } + }, + "ImportTaskIds": { + "target": "com.amazonaws.ec2#ImportTaskIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the import image tasks.

", + "smithy.api#xmlName": "ImportTaskId" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return in a single call.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A token that indicates the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeImportImageTasksResult": { + "type": "structure", + "members": { + "ImportImageTasks": { + "target": "com.amazonaws.ec2#ImportImageTaskList", + "traits": { + "aws.protocols#ec2QueryName": "ImportImageTaskSet", + "smithy.api#documentation": "

A list of zero or more import image tasks that are currently active or were completed or canceled in the\n previous 7 days.

", + "smithy.api#xmlName": "importImageTaskSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to get the next page of results. This value is null when there are no more results\n to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeImportSnapshotTasks": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeImportSnapshotTasksRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeImportSnapshotTasksResult" + }, + "traits": { + "smithy.api#documentation": "

Describes your import snapshot tasks.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ImportSnapshotTasks", + "pageSize": "MaxResults" + }, + "smithy.waiters#waitable": { + "SnapshotImported": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "ImportSnapshotTasks[].SnapshotTaskDetail.Status", + "expected": "completed", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ImportSnapshotTasks[].SnapshotTaskDetail.Status", + "expected": "error", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.ec2#DescribeImportSnapshotTasksRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

", + "smithy.api#xmlName": "Filters" + } + }, + "ImportTaskIds": { + "target": "com.amazonaws.ec2#ImportSnapshotTaskIdList", + "traits": { + "smithy.api#documentation": "

A list of import snapshot task IDs.

", + "smithy.api#xmlName": "ImportTaskId" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining results, make another call\n with the returned NextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A token that indicates the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeImportSnapshotTasksResult": { + "type": "structure", + "members": { + "ImportSnapshotTasks": { + "target": "com.amazonaws.ec2#ImportSnapshotTaskList", + "traits": { + "aws.protocols#ec2QueryName": "ImportSnapshotTaskSet", + "smithy.api#documentation": "

A list of zero or more import snapshot tasks that are currently active or were completed or canceled in the\n previous 7 days.

", + "smithy.api#xmlName": "importSnapshotTaskSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to get the next page of results. This value is null when there are no more results\n to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeInstanceAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeInstanceAttributeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#InstanceAttribute" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified attribute of the specified instance. You can specify only one\n attribute at a time. Valid attribute values are: instanceType |\n kernel | ramdisk | userData |\n disableApiTermination | instanceInitiatedShutdownBehavior\n | rootDeviceName | blockDeviceMapping |\n productCodes | sourceDestCheck | groupSet |\n ebsOptimized | sriovNetSupport\n

" + } + }, + "com.amazonaws.ec2#DescribeInstanceAttributeRequest": { + "type": "structure", + "members": { + "Attribute": { + "target": "com.amazonaws.ec2#InstanceAttributeName", + "traits": { + "aws.protocols#ec2QueryName": "Attribute", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The instance attribute.

\n

Note: The enaSupport attribute is not supported at this time.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "attribute" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "instanceId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeInstanceConnectEndpoints": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeInstanceConnectEndpointsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeInstanceConnectEndpointsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified EC2 Instance Connect Endpoints or all EC2 Instance Connect Endpoints.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InstanceConnectEndpoints", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeInstanceConnectEndpointsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#InstanceConnectEndpointMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "InstanceConnectEndpointIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

One or more EC2 Instance Connect Endpoint IDs.

", + "smithy.api#xmlName": "InstanceConnectEndpointId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeInstanceConnectEndpointsResult": { + "type": "structure", + "members": { + "InstanceConnectEndpoints": { + "target": "com.amazonaws.ec2#InstanceConnectEndpointSet", + "traits": { + "aws.protocols#ec2QueryName": "InstanceConnectEndpointSet", + "smithy.api#documentation": "

Information about the EC2 Instance Connect Endpoints.

", + "smithy.api#xmlName": "instanceConnectEndpointSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeInstanceCreditSpecifications": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeInstanceCreditSpecificationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeInstanceCreditSpecificationsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the credit option for CPU usage of the specified burstable performance\n instances. The credit options are standard and\n unlimited.

\n

If you do not specify an instance ID, Amazon EC2 returns burstable performance\n instances with the unlimited credit option, as well as instances that were\n previously configured as T2, T3, and T3a with the unlimited credit option.\n For example, if you resize a T2 instance, while it is configured as\n unlimited, to an M4 instance, Amazon EC2 returns the M4\n instance.

\n

If you specify one or more instance IDs, Amazon EC2 returns the credit option\n (standard or unlimited) of those instances. If you specify\n an instance ID that is not valid, such as an instance that is not a burstable\n performance instance, an error is returned.

\n

Recently terminated instances might appear in the returned results. This interval is\n usually less than one hour.

\n

If an Availability Zone is experiencing a service disruption and you specify instance\n IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If\n you specify only instance IDs in an unaffected zone, the call works normally.

\n

For more information, see Burstable\n performance instances in the Amazon EC2 User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InstanceCreditSpecifications", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeInstanceCreditSpecificationsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeInstanceCreditSpecificationsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "InstanceIds": { + "target": "com.amazonaws.ec2#InstanceIdStringList", + "traits": { + "smithy.api#documentation": "

The instance IDs.

\n

Default: Describes all your instances.

\n

Constraints: Maximum 1000 explicitly specified instance IDs.

", + "smithy.api#xmlName": "InstanceId" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeInstanceCreditSpecificationsMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

\n

You cannot specify this parameter and the instance IDs\n parameter in the same call.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeInstanceCreditSpecificationsResult": { + "type": "structure", + "members": { + "InstanceCreditSpecifications": { + "target": "com.amazonaws.ec2#InstanceCreditSpecificationList", + "traits": { + "aws.protocols#ec2QueryName": "InstanceCreditSpecificationSet", + "smithy.api#documentation": "

Information about the credit option for CPU usage of an instance.

", + "smithy.api#xmlName": "instanceCreditSpecificationSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeInstanceEventNotificationAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeInstanceEventNotificationAttributesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeInstanceEventNotificationAttributesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the tag keys that are registered to appear in scheduled event notifications for \n \tresources in the current Region.

" + } + }, + "com.amazonaws.ec2#DescribeInstanceEventNotificationAttributesRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeInstanceEventNotificationAttributesResult": { + "type": "structure", + "members": { + "InstanceTagAttribute": { + "target": "com.amazonaws.ec2#InstanceTagNotificationAttribute", + "traits": { + "aws.protocols#ec2QueryName": "InstanceTagAttribute", + "smithy.api#documentation": "

Information about the registered tag keys.

", + "smithy.api#xmlName": "instanceTagAttribute" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeInstanceEventWindows": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeInstanceEventWindowsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeInstanceEventWindowsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified event windows or all event windows.

\n

If you specify event window IDs, the output includes information for only the specified\n event windows. If you specify filters, the output includes information for only those event\n windows that meet the filter criteria. If you do not specify event windows IDs or filters,\n the output includes information for all event windows, which can affect performance. We\n recommend that you use pagination to ensure that the operation returns quickly and\n successfully.

\n

For more information, see Define event windows for scheduled\n events in the Amazon EC2 User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InstanceEventWindows", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeInstanceEventWindowsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "InstanceEventWindowIds": { + "target": "com.amazonaws.ec2#InstanceEventWindowIdSet", + "traits": { + "smithy.api#documentation": "

The IDs of the event windows.

", + "smithy.api#xmlName": "InstanceEventWindowId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#ResultRange", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned NextToken value. This value can\n be between 20 and 500. You cannot specify this parameter and the event window IDs parameter\n in the same call.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to request the next page of results.

" + } + } + }, + "traits": { + "smithy.api#documentation": "Describe instance event windows by InstanceEventWindow.", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeInstanceEventWindowsResult": { + "type": "structure", + "members": { + "InstanceEventWindows": { + "target": "com.amazonaws.ec2#InstanceEventWindowSet", + "traits": { + "aws.protocols#ec2QueryName": "InstanceEventWindowSet", + "smithy.api#documentation": "

Information about the event windows.

", + "smithy.api#xmlName": "instanceEventWindowSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeInstanceStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeInstanceStatusRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeInstanceStatusResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the status of the specified instances or all of your instances. By default,\n only running instances are described, unless you specifically indicate to return the\n status of all instances.

\n

Instance status includes the following components:

\n ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InstanceStatuses", + "pageSize": "MaxResults" + }, + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "InstanceStatusOk": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "InstanceStatuses[].InstanceStatus.Status", + "expected": "ok", + "comparator": "allStringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "errorType": "InvalidInstanceID.NotFound" + } + } + ], + "minDelay": 15 + }, + "SystemStatusOk": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "InstanceStatuses[].SystemStatus.Status", + "expected": "ok", + "comparator": "allStringEquals" + } + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.ec2#DescribeInstanceStatusRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "InstanceIds": { + "target": "com.amazonaws.ec2#InstanceIdStringList", + "traits": { + "smithy.api#documentation": "

The instance IDs.

\n

Default: Describes all your instances.

\n

Constraints: Maximum 100 explicitly specified instance IDs.

", + "smithy.api#xmlName": "InstanceId" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

\n

You cannot specify this parameter and the instance IDs parameter in the same request.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "IncludeAllInstances": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "IncludeAllInstances", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

When true, includes the health status for all instances. When\n false, includes the health status for running instances only.

\n

Default: false\n

", + "smithy.api#xmlName": "includeAllInstances" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeInstanceStatusResult": { + "type": "structure", + "members": { + "InstanceStatuses": { + "target": "com.amazonaws.ec2#InstanceStatusList", + "traits": { + "aws.protocols#ec2QueryName": "InstanceStatusSet", + "smithy.api#documentation": "

Information about the status of the instances.

", + "smithy.api#xmlName": "instanceStatusSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeInstanceTypeOfferings": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeInstanceTypeOfferingsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeInstanceTypeOfferingsResult" + }, + "traits": { + "smithy.api#documentation": "

Returns a list of all instance types offered. The results can be filtered by location (Region or Availability\n Zone). If no location is specified, the instance types offered in the current Region are returned.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InstanceTypeOfferings", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeInstanceTypeOfferingsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request,\n and provides an error response. If you have the required permissions, the error response is\n DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "LocationType": { + "target": "com.amazonaws.ec2#LocationType", + "traits": { + "smithy.api#documentation": "

The location type.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DITOMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeInstanceTypeOfferingsResult": { + "type": "structure", + "members": { + "InstanceTypeOfferings": { + "target": "com.amazonaws.ec2#InstanceTypeOfferingsList", + "traits": { + "aws.protocols#ec2QueryName": "InstanceTypeOfferingSet", + "smithy.api#documentation": "

The instance types offered.

", + "smithy.api#xmlName": "instanceTypeOfferingSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeInstanceTypes": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeInstanceTypesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeInstanceTypesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the details of the instance types that are offered in a location. The results can be filtered by the\n attributes of the instance types.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InstanceTypes", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeInstanceTypesRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request,\n and provides an error response. If you have the required permissions, the error response is\n DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "InstanceTypes": { + "target": "com.amazonaws.ec2#RequestInstanceTypeList", + "traits": { + "smithy.api#documentation": "

The instance types. For more information, see Instance types in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "InstanceType" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DITMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeInstanceTypesResult": { + "type": "structure", + "members": { + "InstanceTypes": { + "target": "com.amazonaws.ec2#InstanceTypeInfoList", + "traits": { + "aws.protocols#ec2QueryName": "InstanceTypeSet", + "smithy.api#documentation": "

The instance type. For more information, see Instance types in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "instanceTypeSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeInstancesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified instances or all instances.

\n

If you specify instance IDs, the output includes information for only the specified\n instances. If you specify filters, the output includes information for only those\n instances that meet the filter criteria. If you do not specify instance IDs or filters,\n the output includes information for all instances, which can affect performance. We\n recommend that you use pagination to ensure that the operation returns quickly and\n successfully.

\n

If you specify an instance ID that is not valid, an error is returned. If you specify\n an instance that you do not own, it is not included in the output.

\n

Recently terminated instances might appear in the returned results. This interval is\n usually less than one hour.

\n

If you describe instances in the rare case where an Availability Zone is experiencing\n a service disruption and you specify instance IDs that are in the affected zone, or do\n not specify any instance IDs at all, the call fails. If you describe instances and\n specify only instance IDs that are in an unaffected zone, the call works\n normally.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Reservations", + "pageSize": "MaxResults" + }, + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "InstanceExists": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "length(Reservations[]) > `0`", + "expected": "true", + "comparator": "booleanEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "errorType": "InvalidInstanceID.NotFound" + } + } + ], + "minDelay": 5 + }, + "InstanceRunning": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Reservations[].Instances[].State.Name", + "expected": "running", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Reservations[].Instances[].State.Name", + "expected": "shutting-down", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Reservations[].Instances[].State.Name", + "expected": "terminated", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Reservations[].Instances[].State.Name", + "expected": "stopping", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "errorType": "InvalidInstanceID.NotFound" + } + } + ], + "minDelay": 15 + }, + "InstanceStopped": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Reservations[].Instances[].State.Name", + "expected": "stopped", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Reservations[].Instances[].State.Name", + "expected": "pending", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Reservations[].Instances[].State.Name", + "expected": "terminated", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 15 + }, + "InstanceTerminated": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Reservations[].Instances[].State.Name", + "expected": "terminated", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Reservations[].Instances[].State.Name", + "expected": "pending", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Reservations[].Instances[].State.Name", + "expected": "stopping", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.ec2#DescribeInstancesRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "InstanceIds": { + "target": "com.amazonaws.ec2#InstanceIdStringList", + "traits": { + "smithy.api#documentation": "

The instance IDs.

\n

Default: Describes all your instances.

", + "smithy.api#xmlName": "InstanceId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MaxResults", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

\n

You cannot specify this parameter and the instance IDs parameter in the same request.

", + "smithy.api#xmlName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeInstancesResult": { + "type": "structure", + "members": { + "Reservations": { + "target": "com.amazonaws.ec2#ReservationList", + "traits": { + "aws.protocols#ec2QueryName": "ReservationSet", + "smithy.api#documentation": "

Information about the reservations.

", + "smithy.api#xmlName": "reservationSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeInternetGateways": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeInternetGatewaysRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeInternetGatewaysResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more of your internet gateways.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InternetGateways", + "pageSize": "MaxResults" + }, + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "InternetGatewayExists": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "length(InternetGateways[].InternetGatewayId) > `0`", + "expected": "true", + "comparator": "booleanEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "errorType": "InvalidInternetGateway.NotFound" + } + } + ], + "minDelay": 5 + } + } + } + }, + "com.amazonaws.ec2#DescribeInternetGatewaysMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeInternetGatewaysRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "InternetGatewayIds": { + "target": "com.amazonaws.ec2#InternetGatewayIdList", + "traits": { + "aws.protocols#ec2QueryName": "InternetGatewayId", + "smithy.api#documentation": "

One or more internet gateway IDs.

\n

Default: Describes all your internet gateways.

", + "smithy.api#xmlName": "internetGatewayId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeInternetGatewaysMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeInternetGatewaysResult": { + "type": "structure", + "members": { + "InternetGateways": { + "target": "com.amazonaws.ec2#InternetGatewayList", + "traits": { + "aws.protocols#ec2QueryName": "InternetGatewaySet", + "smithy.api#documentation": "

Information about one or more internet gateways.

", + "smithy.api#xmlName": "internetGatewaySet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeIpamPools": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeIpamPoolsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeIpamPoolsResult" + }, + "traits": { + "smithy.api#documentation": "

Get information about your IPAM pools.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "IpamPools", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeIpamPoolsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters for the request. For more information about filtering, see Filtering CLI output.

", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#IpamMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return in the request.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "IpamPoolIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the IPAM pools you would like information on.

", + "smithy.api#xmlName": "IpamPoolId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeIpamPoolsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "IpamPools": { + "target": "com.amazonaws.ec2#IpamPoolSet", + "traits": { + "aws.protocols#ec2QueryName": "IpamPoolSet", + "smithy.api#documentation": "

Information about the IPAM pools.

", + "smithy.api#xmlName": "ipamPoolSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeIpamResourceDiscoveries": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeIpamResourceDiscoveriesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeIpamResourceDiscoveriesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes IPAM resource discoveries. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "IpamResourceDiscoveries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeIpamResourceDiscoveriesRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamResourceDiscoveryIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The IPAM resource discovery IDs.

", + "smithy.api#xmlName": "IpamResourceDiscoveryId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#IpamMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of resource discoveries to return in one page of results.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The resource discovery filters.

", + "smithy.api#xmlName": "Filter" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeIpamResourceDiscoveriesResult": { + "type": "structure", + "members": { + "IpamResourceDiscoveries": { + "target": "com.amazonaws.ec2#IpamResourceDiscoverySet", + "traits": { + "aws.protocols#ec2QueryName": "IpamResourceDiscoverySet", + "smithy.api#documentation": "

The resource discoveries.

", + "smithy.api#xmlName": "ipamResourceDiscoverySet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeIpamResourceDiscoveryAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeIpamResourceDiscoveryAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeIpamResourceDiscoveryAssociationsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes resource discovery association with an Amazon VPC IPAM. An associated resource discovery is a resource discovery that has been associated with an IPAM..

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "IpamResourceDiscoveryAssociations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeIpamResourceDiscoveryAssociationsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamResourceDiscoveryAssociationIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The resource discovery association IDs.

", + "smithy.api#xmlName": "IpamResourceDiscoveryAssociationId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#IpamMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of resource discovery associations to return in one page of results.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The resource discovery association filters.

", + "smithy.api#xmlName": "Filter" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeIpamResourceDiscoveryAssociationsResult": { + "type": "structure", + "members": { + "IpamResourceDiscoveryAssociations": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryAssociationSet", + "traits": { + "aws.protocols#ec2QueryName": "IpamResourceDiscoveryAssociationSet", + "smithy.api#documentation": "

The resource discovery associations.

", + "smithy.api#xmlName": "ipamResourceDiscoveryAssociationSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeIpamScopes": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeIpamScopesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeIpamScopesResult" + }, + "traits": { + "smithy.api#documentation": "

Get information about your IPAM scopes.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "IpamScopes", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeIpamScopesRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters for the request. For more information about filtering, see Filtering CLI output.

", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#IpamMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return in the request.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "IpamScopeIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the scopes you want information on.

", + "smithy.api#xmlName": "IpamScopeId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeIpamScopesResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "IpamScopes": { + "target": "com.amazonaws.ec2#IpamScopeSet", + "traits": { + "aws.protocols#ec2QueryName": "IpamScopeSet", + "smithy.api#documentation": "

The scopes you want information on.

", + "smithy.api#xmlName": "ipamScopeSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeIpams": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeIpamsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeIpamsResult" + }, + "traits": { + "smithy.api#documentation": "

Get information about your IPAM pools.

\n

For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.\n

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Ipams", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeIpamsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters for the request. For more information about filtering, see Filtering CLI output.

", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#IpamMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return in the request.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "IpamIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the IPAMs you want information on.

", + "smithy.api#xmlName": "IpamId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeIpamsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "Ipams": { + "target": "com.amazonaws.ec2#IpamSet", + "traits": { + "aws.protocols#ec2QueryName": "IpamSet", + "smithy.api#documentation": "

Information about the IPAMs.

", + "smithy.api#xmlName": "ipamSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeIpv6Pools": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeIpv6PoolsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeIpv6PoolsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes your IPv6 address pools.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Ipv6Pools", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeIpv6PoolsRequest": { + "type": "structure", + "members": { + "PoolIds": { + "target": "com.amazonaws.ec2#Ipv6PoolIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the IPv6 address pools.

", + "smithy.api#xmlName": "PoolId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Ipv6PoolMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeIpv6PoolsResult": { + "type": "structure", + "members": { + "Ipv6Pools": { + "target": "com.amazonaws.ec2#Ipv6PoolSet", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6PoolSet", + "smithy.api#documentation": "

Information about the IPv6 address pools.

", + "smithy.api#xmlName": "ipv6PoolSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeKeyPairs": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeKeyPairsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeKeyPairsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified key pairs or all of your key pairs.

\n

For more information about key pairs, see Amazon EC2 key pairs \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "KeyPairExists": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "length(KeyPairs[].KeyName) > `0`", + "expected": "true", + "comparator": "booleanEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "errorType": "InvalidKeyPair.NotFound" + } + } + ], + "minDelay": 5 + } + } + } + }, + "com.amazonaws.ec2#DescribeKeyPairsRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "KeyNames": { + "target": "com.amazonaws.ec2#KeyNameStringList", + "traits": { + "smithy.api#documentation": "

The key pair names.

\n

Default: Describes all of your key pairs.

", + "smithy.api#xmlName": "KeyName" + } + }, + "KeyPairIds": { + "target": "com.amazonaws.ec2#KeyPairIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the key pairs.

", + "smithy.api#xmlName": "KeyPairId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "IncludePublicKey": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

If true, the public key material is included in the response.

\n

Default: false\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeKeyPairsResult": { + "type": "structure", + "members": { + "KeyPairs": { + "target": "com.amazonaws.ec2#KeyPairList", + "traits": { + "aws.protocols#ec2QueryName": "KeySet", + "smithy.api#documentation": "

Information about the key pairs.

", + "smithy.api#xmlName": "keySet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeLaunchTemplateVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeLaunchTemplateVersionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeLaunchTemplateVersionsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more versions of a specified launch template. You can describe all\n versions, individual versions, or a range of versions. You can also describe all the\n latest versions or all the default versions of all the launch templates in your\n account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LaunchTemplateVersions", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeLaunchTemplateVersionsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + } + }, + "LaunchTemplateId": { + "target": "com.amazonaws.ec2#LaunchTemplateId", + "traits": { + "smithy.api#documentation": "

The ID of the launch template.

\n

To describe one or more versions of a specified launch template, you must specify\n either the LaunchTemplateId or the LaunchTemplateName, but not\n both.

\n

To describe all the latest or default launch template versions in your account, you\n must omit this parameter.

" + } + }, + "LaunchTemplateName": { + "target": "com.amazonaws.ec2#LaunchTemplateName", + "traits": { + "smithy.api#documentation": "

The name of the launch template.

\n

To describe one or more versions of a specified launch template, you must specify\n either the LaunchTemplateName or the LaunchTemplateId, but not\n both.

\n

To describe all the latest or default launch template versions in your account, you\n must omit this parameter.

" + } + }, + "Versions": { + "target": "com.amazonaws.ec2#VersionStringList", + "traits": { + "smithy.api#documentation": "

One or more versions of the launch template. Valid values depend on whether you are\n describing a specified launch template (by ID or name) or all launch templates in your\n account.

\n

To describe one or more versions of a specified launch template, valid values are\n $Latest, $Default, and numbers.

\n

To describe all launch templates in your account that are defined as the latest\n version, the valid value is $Latest. To describe all launch templates in\n your account that are defined as the default version, the valid value is\n $Default. You can specify $Latest and\n $Default in the same request. You cannot specify numbers.

", + "smithy.api#xmlName": "LaunchTemplateVersion" + } + }, + "MinVersion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The version number after which to describe launch template versions.

" + } + }, + "MaxVersion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The version number up to which to describe launch template versions.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to request the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned NextToken value. This value\n can be between 1 and 200.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "ResolveAlias": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

If true, and if a Systems Manager parameter is specified for ImageId,\n the AMI ID is displayed in the response for imageId.

\n

If false, and if a Systems Manager parameter is specified for ImageId,\n the parameter is displayed in the response for imageId.

\n

For more information, see Use a Systems \n Manager parameter instead of an AMI ID in the Amazon Elastic Compute Cloud User Guide.

\n

Default: false\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeLaunchTemplateVersionsResult": { + "type": "structure", + "members": { + "LaunchTemplateVersions": { + "target": "com.amazonaws.ec2#LaunchTemplateVersionSet", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateVersionSet", + "smithy.api#documentation": "

Information about the launch template versions.

", + "smithy.api#xmlName": "launchTemplateVersionSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null\n when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeLaunchTemplates": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeLaunchTemplatesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeLaunchTemplatesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more launch templates.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LaunchTemplates", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeLaunchTemplatesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.ec2#DescribeLaunchTemplatesRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + } + }, + "LaunchTemplateIds": { + "target": "com.amazonaws.ec2#LaunchTemplateIdStringList", + "traits": { + "smithy.api#documentation": "

One or more launch template IDs.

", + "smithy.api#xmlName": "LaunchTemplateId" + } + }, + "LaunchTemplateNames": { + "target": "com.amazonaws.ec2#LaunchTemplateNameStringList", + "traits": { + "smithy.api#documentation": "

One or more launch template names.

", + "smithy.api#xmlName": "LaunchTemplateName" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to request the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeLaunchTemplatesMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned NextToken value. This value\n can be between 1 and 200.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeLaunchTemplatesResult": { + "type": "structure", + "members": { + "LaunchTemplates": { + "target": "com.amazonaws.ec2#LaunchTemplateSet", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplates", + "smithy.api#documentation": "

Information about the launch templates.

", + "smithy.api#xmlName": "launchTemplates" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null\n when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the associations between virtual interface groups and local gateway route tables.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LocalGatewayRouteTableVirtualInterfaceGroupAssociations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest": { + "type": "structure", + "members": { + "LocalGatewayRouteTableVirtualInterfaceGroupAssociationIds": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociationIdSet", + "traits": { + "smithy.api#documentation": "

The IDs of the associations.

", + "smithy.api#xmlName": "LocalGatewayRouteTableVirtualInterfaceGroupAssociationId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#LocalGatewayMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult": { + "type": "structure", + "members": { + "LocalGatewayRouteTableVirtualInterfaceGroupAssociations": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociationSet", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableVirtualInterfaceGroupAssociationSet", + "smithy.api#documentation": "

Information about the associations.

", + "smithy.api#xmlName": "localGatewayRouteTableVirtualInterfaceGroupAssociationSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVpcAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVpcAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVpcAssociationsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified associations between VPCs and local gateway route tables.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LocalGatewayRouteTableVpcAssociations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVpcAssociationsRequest": { + "type": "structure", + "members": { + "LocalGatewayRouteTableVpcAssociationIds": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociationIdSet", + "traits": { + "smithy.api#documentation": "

The IDs of the associations.

", + "smithy.api#xmlName": "LocalGatewayRouteTableVpcAssociationId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#LocalGatewayMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVpcAssociationsResult": { + "type": "structure", + "members": { + "LocalGatewayRouteTableVpcAssociations": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociationSet", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableVpcAssociationSet", + "smithy.api#documentation": "

Information about the associations.

", + "smithy.api#xmlName": "localGatewayRouteTableVpcAssociationSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeLocalGatewayRouteTables": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeLocalGatewayRouteTablesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeLocalGatewayRouteTablesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more local gateway route tables. By default, all local gateway route tables are described.\n Alternatively, you can filter the results.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LocalGatewayRouteTables", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeLocalGatewayRouteTablesRequest": { + "type": "structure", + "members": { + "LocalGatewayRouteTableIds": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableIdSet", + "traits": { + "smithy.api#documentation": "

The IDs of the local gateway route tables.

", + "smithy.api#xmlName": "LocalGatewayRouteTableId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#LocalGatewayMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeLocalGatewayRouteTablesResult": { + "type": "structure", + "members": { + "LocalGatewayRouteTables": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableSet", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableSet", + "smithy.api#documentation": "

Information about the local gateway route tables.

", + "smithy.api#xmlName": "localGatewayRouteTableSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfaceGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfaceGroupsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfaceGroupsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified local gateway virtual interface groups.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LocalGatewayVirtualInterfaceGroups", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfaceGroupsRequest": { + "type": "structure", + "members": { + "LocalGatewayVirtualInterfaceGroupIds": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupIdSet", + "traits": { + "smithy.api#documentation": "

The IDs of the virtual interface groups.

", + "smithy.api#xmlName": "LocalGatewayVirtualInterfaceGroupId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#LocalGatewayMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfaceGroupsResult": { + "type": "structure", + "members": { + "LocalGatewayVirtualInterfaceGroups": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupSet", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayVirtualInterfaceGroupSet", + "smithy.api#documentation": "

The virtual interface groups.

", + "smithy.api#xmlName": "localGatewayVirtualInterfaceGroupSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfaces": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfacesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfacesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified local gateway virtual interfaces.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LocalGatewayVirtualInterfaces", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfacesRequest": { + "type": "structure", + "members": { + "LocalGatewayVirtualInterfaceIds": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceIdSet", + "traits": { + "smithy.api#documentation": "

The IDs of the virtual interfaces.

", + "smithy.api#xmlName": "LocalGatewayVirtualInterfaceId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#LocalGatewayMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfacesResult": { + "type": "structure", + "members": { + "LocalGatewayVirtualInterfaces": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceSet", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayVirtualInterfaceSet", + "smithy.api#documentation": "

Information about the virtual interfaces.

", + "smithy.api#xmlName": "localGatewayVirtualInterfaceSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeLocalGateways": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeLocalGatewaysRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeLocalGatewaysResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more local gateways. By default, all local gateways are described. \n Alternatively, you can filter the results.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LocalGateways", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeLocalGatewaysRequest": { + "type": "structure", + "members": { + "LocalGatewayIds": { + "target": "com.amazonaws.ec2#LocalGatewayIdSet", + "traits": { + "smithy.api#documentation": "

The IDs of the local gateways.

", + "smithy.api#xmlName": "LocalGatewayId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#LocalGatewayMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeLocalGatewaysResult": { + "type": "structure", + "members": { + "LocalGateways": { + "target": "com.amazonaws.ec2#LocalGatewaySet", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewaySet", + "smithy.api#documentation": "

Information about the local gateways.

", + "smithy.api#xmlName": "localGatewaySet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeManagedPrefixLists": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeManagedPrefixListsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeManagedPrefixListsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes your managed prefix lists and any Amazon Web Services-managed prefix lists.

\n

To view the entries for your prefix list, use GetManagedPrefixListEntries.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PrefixLists", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeManagedPrefixListsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#PrefixListMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "PrefixListIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

One or more prefix list IDs.

", + "smithy.api#xmlName": "PrefixListId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeManagedPrefixListsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "PrefixLists": { + "target": "com.amazonaws.ec2#ManagedPrefixListSet", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListSet", + "smithy.api#documentation": "

Information about the prefix lists.

", + "smithy.api#xmlName": "prefixListSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeMovingAddresses": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeMovingAddressesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeMovingAddressesResult" + }, + "traits": { + "smithy.api#documentation": "\n

This action is deprecated.

\n \n

Describes your Elastic IP addresses that are being moved from or being restored to the EC2-Classic platform. \n This request does not return information about any other Elastic IP addresses in your account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "MovingAddressStatuses", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeMovingAddressesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeMovingAddressesRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "aws.protocols#ec2QueryName": "Filter", + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeMovingAddressesMaxResults", + "traits": { + "aws.protocols#ec2QueryName": "MaxResults", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining\n results of the initial request can be seen by sending another request with the returned\n NextToken value. This value can be between 5 and 1000; if\n MaxResults is given a value outside of this range, an error is returned.

\n

Default: If no value is provided, the default is 1000.

", + "smithy.api#xmlName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token for the next page of results.

", + "smithy.api#xmlName": "nextToken" + } + }, + "PublicIps": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "PublicIp", + "smithy.api#documentation": "

One or more Elastic IP addresses.

", + "smithy.api#xmlName": "publicIp" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeMovingAddressesResult": { + "type": "structure", + "members": { + "MovingAddressStatuses": { + "target": "com.amazonaws.ec2#MovingAddressStatusSet", + "traits": { + "aws.protocols#ec2QueryName": "MovingAddressStatusSet", + "smithy.api#documentation": "

The status for each Elastic IP address.

", + "smithy.api#xmlName": "movingAddressStatusSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeNatGateways": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeNatGatewaysRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeNatGatewaysResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more of your NAT gateways.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "NatGateways", + "pageSize": "MaxResults" + }, + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "NatGatewayAvailable": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "NatGateways[].State", + "expected": "available", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "NatGateways[].State", + "expected": "failed", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "NatGateways[].State", + "expected": "deleting", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "NatGateways[].State", + "expected": "deleted", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "errorType": "NatGatewayNotFound" + } + } + ], + "minDelay": 15 + }, + "NatGatewayDeleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "NatGateways[].State", + "expected": "deleted", + "comparator": "allStringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "errorType": "NatGatewayNotFound" + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.ec2#DescribeNatGatewaysMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeNatGatewaysRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filter": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n " + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeNatGatewaysMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" + } + }, + "NatGatewayIds": { + "target": "com.amazonaws.ec2#NatGatewayIdStringList", + "traits": { + "smithy.api#documentation": "

One or more NAT gateway IDs.

", + "smithy.api#xmlName": "NatGatewayId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeNatGatewaysResult": { + "type": "structure", + "members": { + "NatGateways": { + "target": "com.amazonaws.ec2#NatGatewayList", + "traits": { + "aws.protocols#ec2QueryName": "NatGatewaySet", + "smithy.api#documentation": "

Information about the NAT gateways.

", + "smithy.api#xmlName": "natGatewaySet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeNetworkAcls": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeNetworkAclsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeNetworkAclsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more of your network ACLs.

\n

For more information, see Network ACLs in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "NetworkAcls", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeNetworkAclsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeNetworkAclsRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "NetworkAclIds": { + "target": "com.amazonaws.ec2#NetworkAclIdStringList", + "traits": { + "smithy.api#documentation": "

One or more network ACL IDs.

\n

Default: Describes all your network ACLs.

", + "smithy.api#xmlName": "NetworkAclId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeNetworkAclsMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeNetworkAclsResult": { + "type": "structure", + "members": { + "NetworkAcls": { + "target": "com.amazonaws.ec2#NetworkAclList", + "traits": { + "aws.protocols#ec2QueryName": "NetworkAclSet", + "smithy.api#documentation": "

Information about one or more network ACLs.

", + "smithy.api#xmlName": "networkAclSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopeAnalyses": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopeAnalysesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopeAnalysesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified Network Access Scope analyses.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "NetworkInsightsAccessScopeAnalyses", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopeAnalysesRequest": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeAnalysisIds": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the Network Access Scope analyses.

", + "smithy.api#xmlName": "NetworkInsightsAccessScopeAnalysisId" + } + }, + "NetworkInsightsAccessScopeId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", + "traits": { + "smithy.api#documentation": "

The ID of the Network Access Scope.

" + } + }, + "AnalysisStartTimeBegin": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "smithy.api#documentation": "

Filters the results based on the start time. The analysis must have started on or after this time.

" + } + }, + "AnalysisStartTimeEnd": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "smithy.api#documentation": "

Filters the results based on the start time. The analysis must have started on or before this time.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

There are no supported filters.

", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#NetworkInsightsMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopeAnalysesResult": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeAnalyses": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisList", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeAnalysisSet", + "smithy.api#documentation": "

The Network Access Scope analyses.

", + "smithy.api#xmlName": "networkInsightsAccessScopeAnalysisSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopes": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified Network Access Scopes.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "NetworkInsightsAccessScopes", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopesRequest": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeIds": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the Network Access Scopes.

", + "smithy.api#xmlName": "NetworkInsightsAccessScopeId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

There are no supported filters.

", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#NetworkInsightsMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeNetworkInsightsAccessScopesResult": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopes": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeList", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeSet", + "smithy.api#documentation": "

The Network Access Scopes.

", + "smithy.api#xmlName": "networkInsightsAccessScopeSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeNetworkInsightsAnalyses": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeNetworkInsightsAnalysesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeNetworkInsightsAnalysesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more of your network insights analyses.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "NetworkInsightsAnalyses", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeNetworkInsightsAnalysesRequest": { + "type": "structure", + "members": { + "NetworkInsightsAnalysisIds": { + "target": "com.amazonaws.ec2#NetworkInsightsAnalysisIdList", + "traits": { + "smithy.api#documentation": "

The ID of the network insights analyses. You must specify either analysis IDs or a path ID.

", + "smithy.api#xmlName": "NetworkInsightsAnalysisId" + } + }, + "NetworkInsightsPathId": { + "target": "com.amazonaws.ec2#NetworkInsightsPathId", + "traits": { + "smithy.api#documentation": "

The ID of the path. You must specify either a path ID or analysis IDs.

" + } + }, + "AnalysisStartTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "smithy.api#documentation": "

The time when the network insights analyses started.

" + } + }, + "AnalysisEndTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "smithy.api#documentation": "

The time when the network insights analyses ended.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters. The following are the possible values:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#NetworkInsightsMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeNetworkInsightsAnalysesResult": { + "type": "structure", + "members": { + "NetworkInsightsAnalyses": { + "target": "com.amazonaws.ec2#NetworkInsightsAnalysisList", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAnalysisSet", + "smithy.api#documentation": "

Information about the network insights analyses.

", + "smithy.api#xmlName": "networkInsightsAnalysisSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeNetworkInsightsPaths": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeNetworkInsightsPathsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeNetworkInsightsPathsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more of your paths.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "NetworkInsightsPaths", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeNetworkInsightsPathsRequest": { + "type": "structure", + "members": { + "NetworkInsightsPathIds": { + "target": "com.amazonaws.ec2#NetworkInsightsPathIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the paths.

", + "smithy.api#xmlName": "NetworkInsightsPathId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters. The following are the possible values:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#NetworkInsightsMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeNetworkInsightsPathsResult": { + "type": "structure", + "members": { + "NetworkInsightsPaths": { + "target": "com.amazonaws.ec2#NetworkInsightsPathList", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsPathSet", + "smithy.api#documentation": "

Information about the paths.

", + "smithy.api#xmlName": "networkInsightsPathSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeNetworkInterfaceAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeNetworkInterfaceAttributeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeNetworkInterfaceAttributeResult" + }, + "traits": { + "smithy.api#documentation": "

Describes a network interface attribute. You can specify only one attribute at a time.

" + } + }, + "com.amazonaws.ec2#DescribeNetworkInterfaceAttributeRequest": { + "type": "structure", + "members": { + "Attribute": { + "target": "com.amazonaws.ec2#NetworkInterfaceAttribute", + "traits": { + "aws.protocols#ec2QueryName": "Attribute", + "smithy.api#documentation": "

The attribute of the network interface. This parameter is required.

", + "smithy.api#xmlName": "attribute" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "networkInterfaceId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeNetworkInterfaceAttribute.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeNetworkInterfaceAttributeResult": { + "type": "structure", + "members": { + "Attachment": { + "target": "com.amazonaws.ec2#NetworkInterfaceAttachment", + "traits": { + "aws.protocols#ec2QueryName": "Attachment", + "smithy.api#documentation": "

The attachment (if any) of the network interface.

", + "smithy.api#xmlName": "attachment" + } + }, + "Description": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of the network interface.

", + "smithy.api#xmlName": "description" + } + }, + "Groups": { + "target": "com.amazonaws.ec2#GroupIdentifierList", + "traits": { + "aws.protocols#ec2QueryName": "GroupSet", + "smithy.api#documentation": "

The security groups associated with the network interface.

", + "smithy.api#xmlName": "groupSet" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "SourceDestCheck": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "aws.protocols#ec2QueryName": "SourceDestCheck", + "smithy.api#documentation": "

Indicates whether source/destination checking is enabled.

", + "smithy.api#xmlName": "sourceDestCheck" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of DescribeNetworkInterfaceAttribute.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeNetworkInterfacePermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeNetworkInterfacePermissionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeNetworkInterfacePermissionsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the permissions for your network interfaces.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "NetworkInterfacePermissions", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeNetworkInterfacePermissionsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 255 + } + } + }, + "com.amazonaws.ec2#DescribeNetworkInterfacePermissionsRequest": { + "type": "structure", + "members": { + "NetworkInterfacePermissionIds": { + "target": "com.amazonaws.ec2#NetworkInterfacePermissionIdList", + "traits": { + "smithy.api#documentation": "

The network interface permission IDs.

", + "smithy.api#xmlName": "NetworkInterfacePermissionId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request.\n\t\t Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeNetworkInterfacePermissionsMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return for this request. To get the next page of items,\n\t\t\tmake another request with the token returned in the output. If this parameter is not specified, \n\t\t\tup to 50 results are returned by default. For more information, see\n\t\t\tPagination.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeNetworkInterfacePermissions.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeNetworkInterfacePermissionsResult": { + "type": "structure", + "members": { + "NetworkInterfacePermissions": { + "target": "com.amazonaws.ec2#NetworkInterfacePermissionList", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfacePermissions", + "smithy.api#documentation": "

The network interface permissions.

", + "smithy.api#xmlName": "networkInterfacePermissions" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items.\n\t\t This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output for DescribeNetworkInterfacePermissions.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeNetworkInterfaces": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeNetworkInterfacesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeNetworkInterfacesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more of your network interfaces.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "NetworkInterfaces", + "pageSize": "MaxResults" + }, + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "NetworkInterfaceAvailable": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "NetworkInterfaces[].Status", + "expected": "available", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "errorType": "InvalidNetworkInterfaceID.NotFound" + } + } + ], + "minDelay": 20 + } + } + } + }, + "com.amazonaws.ec2#DescribeNetworkInterfacesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeNetworkInterfacesRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "aws.protocols#ec2QueryName": "Filter", + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "NetworkInterfaceIds": { + "target": "com.amazonaws.ec2#NetworkInterfaceIdList", + "traits": { + "smithy.api#documentation": "

The network interface IDs.

\n

Default: Describes all your network interfaces.

", + "smithy.api#xmlName": "NetworkInterfaceId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request.\n\t\t Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeNetworkInterfacesMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return for this request. To get the next page of items,\n\t\t make another request with the token returned in the output. You cannot specify this\n\t\t parameter and the network interface IDs parameter in the same request. For more information, \n\t\t see Pagination.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeNetworkInterfaces.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeNetworkInterfacesResult": { + "type": "structure", + "members": { + "NetworkInterfaces": { + "target": "com.amazonaws.ec2#NetworkInterfaceList", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceSet", + "smithy.api#documentation": "

Information about one or more network interfaces.

", + "smithy.api#xmlName": "networkInterfaceSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n\t\t This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribePlacementGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribePlacementGroupsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribePlacementGroupsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified placement groups or all of your placement groups. For more\n information, see Placement groups in the\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#DescribePlacementGroupsRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "GroupNames": { + "target": "com.amazonaws.ec2#PlacementGroupStringList", + "traits": { + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

The names of the placement groups.

\n

Default: Describes all your placement groups, or only those otherwise\n specified.

", + "smithy.api#xmlName": "groupName" + } + }, + "GroupIds": { + "target": "com.amazonaws.ec2#PlacementGroupIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the placement groups.

", + "smithy.api#xmlName": "GroupId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribePlacementGroupsResult": { + "type": "structure", + "members": { + "PlacementGroups": { + "target": "com.amazonaws.ec2#PlacementGroupList", + "traits": { + "aws.protocols#ec2QueryName": "PlacementGroupSet", + "smithy.api#documentation": "

Information about the placement groups.

", + "smithy.api#xmlName": "placementGroupSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribePrefixLists": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribePrefixListsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribePrefixListsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes available Amazon Web Services services in a prefix list format, which includes the prefix list\n name and prefix list ID of the service and the IP address range for the service.

\n

We recommend that you use DescribeManagedPrefixLists instead.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PrefixLists", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribePrefixListsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "PrefixListIds": { + "target": "com.amazonaws.ec2#PrefixListResourceIdStringList", + "traits": { + "smithy.api#documentation": "

One or more prefix list IDs.

", + "smithy.api#xmlName": "PrefixListId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribePrefixListsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "PrefixLists": { + "target": "com.amazonaws.ec2#PrefixListSet", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListSet", + "smithy.api#documentation": "

All available prefix lists.

", + "smithy.api#xmlName": "prefixListSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribePrincipalIdFormat": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribePrincipalIdFormatRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribePrincipalIdFormatResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the ID format settings for the root user and all IAM roles and IAM users\n that have explicitly specified a longer ID (17-character ID) preference.

\n

By default, all IAM roles and IAM users default to the same ID settings as the root user, unless they\n explicitly override the settings. This request is useful for identifying those IAM users and IAM roles\n that have overridden the default ID settings.

\n

The following resource types support longer IDs: bundle |\n conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | instance | internet-gateway |\n network-acl | network-acl-association |\n network-interface | network-interface-attachment |\n prefix-list | reservation | route-table |\n route-table-association | security-group |\n snapshot | subnet |\n subnet-cidr-block-association | volume | vpc\n | vpc-cidr-block-association | vpc-endpoint |\n vpc-peering-connection | vpn-connection | vpn-gateway.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Principals", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribePrincipalIdFormatMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribePrincipalIdFormatRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Resources": { + "target": "com.amazonaws.ec2#ResourceList", + "traits": { + "smithy.api#documentation": "

The type of resource: bundle |\n conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | instance | internet-gateway |\n network-acl | network-acl-association |\n network-interface | network-interface-attachment |\n prefix-list | reservation | route-table |\n route-table-association | security-group |\n snapshot | subnet |\n subnet-cidr-block-association | volume | vpc\n | vpc-cidr-block-association | vpc-endpoint |\n vpc-peering-connection | vpn-connection | vpn-gateway\n

", + "smithy.api#xmlName": "Resource" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribePrincipalIdFormatMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned NextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to request the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribePrincipalIdFormatResult": { + "type": "structure", + "members": { + "Principals": { + "target": "com.amazonaws.ec2#PrincipalIdFormatList", + "traits": { + "aws.protocols#ec2QueryName": "PrincipalSet", + "smithy.api#documentation": "

Information about the ID format settings for the ARN.

", + "smithy.api#xmlName": "principalSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribePublicIpv4Pools": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribePublicIpv4PoolsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribePublicIpv4PoolsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified IPv4 address pools.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PublicIpv4Pools", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribePublicIpv4PoolsRequest": { + "type": "structure", + "members": { + "PoolIds": { + "target": "com.amazonaws.ec2#PublicIpv4PoolIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the address pools.

", + "smithy.api#xmlName": "PoolId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#PoolMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribePublicIpv4PoolsResult": { + "type": "structure", + "members": { + "PublicIpv4Pools": { + "target": "com.amazonaws.ec2#PublicIpv4PoolSet", + "traits": { + "aws.protocols#ec2QueryName": "PublicIpv4PoolSet", + "smithy.api#documentation": "

Information about the address pools.

", + "smithy.api#xmlName": "publicIpv4PoolSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeRegions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeRegionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeRegionsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the Regions that are enabled for your account, or all Regions.

\n

For a list of the Regions supported by Amazon EC2, see \n Amazon Elastic Compute Cloud endpoints and quotas.

\n

For information about enabling and disabling Regions for your account, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference.

" + } + }, + "com.amazonaws.ec2#DescribeRegionsRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "RegionNames": { + "target": "com.amazonaws.ec2#RegionNameStringList", + "traits": { + "smithy.api#documentation": "

The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.

", + "smithy.api#xmlName": "RegionName" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "AllRegions": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to display all Regions, including Regions that are disabled for your account.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeRegionsResult": { + "type": "structure", + "members": { + "Regions": { + "target": "com.amazonaws.ec2#RegionList", + "traits": { + "aws.protocols#ec2QueryName": "RegionInfo", + "smithy.api#documentation": "

Information about the Regions.

", + "smithy.api#xmlName": "regionInfo" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeReplaceRootVolumeTasks": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeReplaceRootVolumeTasksRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeReplaceRootVolumeTasksResult" + }, + "traits": { + "smithy.api#documentation": "

Describes a root volume replacement task. For more information, see \n Replace a root volume in the Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ReplaceRootVolumeTasks", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeReplaceRootVolumeTasksMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.ec2#DescribeReplaceRootVolumeTasksRequest": { + "type": "structure", + "members": { + "ReplaceRootVolumeTaskIds": { + "target": "com.amazonaws.ec2#ReplaceRootVolumeTaskIds", + "traits": { + "smithy.api#documentation": "

The ID of the root volume replacement task to view.

", + "smithy.api#xmlName": "ReplaceRootVolumeTaskId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

Filter to use:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeReplaceRootVolumeTasksMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output. \n\tFor more information, see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeReplaceRootVolumeTasksResult": { + "type": "structure", + "members": { + "ReplaceRootVolumeTasks": { + "target": "com.amazonaws.ec2#ReplaceRootVolumeTasks", + "traits": { + "aws.protocols#ec2QueryName": "ReplaceRootVolumeTaskSet", + "smithy.api#documentation": "

Information about the root volume replacement task.

", + "smithy.api#xmlName": "replaceRootVolumeTaskSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeReservedInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeReservedInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeReservedInstancesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more of the Reserved Instances that you purchased.

\n

For more information about Reserved Instances, see Reserved\n\t\t\t\tInstances in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#DescribeReservedInstancesListings": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeReservedInstancesListingsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeReservedInstancesListingsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.

\n

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.

\n

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.

\n

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.

\n

For more information, see Reserved Instance Marketplace \n in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#DescribeReservedInstancesListingsRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "ReservedInstancesId": { + "target": "com.amazonaws.ec2#ReservationId", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesId", + "smithy.api#documentation": "

One or more Reserved Instance IDs.

", + "smithy.api#xmlName": "reservedInstancesId" + } + }, + "ReservedInstancesListingId": { + "target": "com.amazonaws.ec2#ReservedInstancesListingId", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesListingId", + "smithy.api#documentation": "

One or more Reserved Instance listing IDs.

", + "smithy.api#xmlName": "reservedInstancesListingId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeReservedInstancesListings.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeReservedInstancesListingsResult": { + "type": "structure", + "members": { + "ReservedInstancesListings": { + "target": "com.amazonaws.ec2#ReservedInstancesListingList", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesListingsSet", + "smithy.api#documentation": "

Information about the Reserved Instance listing.

", + "smithy.api#xmlName": "reservedInstancesListingsSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of DescribeReservedInstancesListings.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeReservedInstancesModifications": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeReservedInstancesModificationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeReservedInstancesModificationsResult" + }, + "traits": { + "smithy.api#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.

\n

For more information, see Modifying Reserved Instances in the Amazon EC2 User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ReservedInstancesModifications" + } + } + }, + "com.amazonaws.ec2#DescribeReservedInstancesModificationsRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "ReservedInstancesModificationIds": { + "target": "com.amazonaws.ec2#ReservedInstancesModificationIdStringList", + "traits": { + "smithy.api#documentation": "

IDs for the submitted modification request.

", + "smithy.api#xmlName": "ReservedInstancesModificationId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to retrieve the next page of results.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeReservedInstancesModifications.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeReservedInstancesModificationsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when\n\t\t\tthere are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "ReservedInstancesModifications": { + "target": "com.amazonaws.ec2#ReservedInstancesModificationList", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesModificationsSet", + "smithy.api#documentation": "

The Reserved Instance modification information.

", + "smithy.api#xmlName": "reservedInstancesModificationsSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of DescribeReservedInstancesModifications.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeReservedInstancesOfferings": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeReservedInstancesOfferingsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeReservedInstancesOfferingsResult" + }, + "traits": { + "smithy.api#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.

\n

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.

\n

For more information, see Reserved Instance Marketplace\n\t\t\t\tin the Amazon EC2 User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ReservedInstancesOfferings", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeReservedInstancesOfferingsRequest": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone in which the Reserved Instance can be used.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "IncludeMarketplace": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Include Reserved Instance Marketplace offerings in the response.

" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "smithy.api#documentation": "

The instance type that the reservation will cover (for example, m1.small). For more information, see \n Instance types in the\n Amazon EC2 User Guide.

" + } + }, + "MaxDuration": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum duration (in seconds) to filter when searching for offerings.

\n

Default: 94608000 (3 years)

" + } + }, + "MaxInstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of instances to filter when searching for offerings.

\n

Default: 20

" + } + }, + "MinDuration": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum duration (in seconds) to filter when searching for offerings.

\n

Default: 2592000 (1 month)

" + } + }, + "OfferingClass": { + "target": "com.amazonaws.ec2#OfferingClassType", + "traits": { + "smithy.api#documentation": "

The offering class of the Reserved Instance. Can be standard or convertible.

" + } + }, + "ProductDescription": { + "target": "com.amazonaws.ec2#RIProductDescription", + "traits": { + "smithy.api#documentation": "

The Reserved Instance product platform description. Instances that include (Amazon\n VPC) in the description are for use with Amazon VPC.

" + } + }, + "ReservedInstancesOfferingIds": { + "target": "com.amazonaws.ec2#ReservedInstancesOfferingIdStringList", + "traits": { + "smithy.api#documentation": "

One or more Reserved Instances offering IDs.

", + "smithy.api#xmlName": "ReservedInstancesOfferingId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "InstanceTenancy": { + "target": "com.amazonaws.ec2#Tenancy", + "traits": { + "aws.protocols#ec2QueryName": "InstanceTenancy", + "smithy.api#documentation": "

The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy\n of dedicated is applied to instances that run in a VPC on single-tenant hardware\n (i.e., Dedicated Instances).

\n

\n Important: The host value cannot be used with this parameter. Use the default or dedicated values only.

\n

Default: default\n

", + "smithy.api#xmlName": "instanceTenancy" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MaxResults", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining\n\t\t\tresults of the initial request can be seen by sending another request with the returned\n\t\t\t\tNextToken value. The maximum is 100.

\n

Default: 100

", + "smithy.api#xmlName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to retrieve the next page of results.

", + "smithy.api#xmlName": "nextToken" + } + }, + "OfferingType": { + "target": "com.amazonaws.ec2#OfferingTypeValues", + "traits": { + "aws.protocols#ec2QueryName": "OfferingType", + "smithy.api#documentation": "

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API\n\t\t\tversion, you only have access to the Medium Utilization Reserved Instance\n\t\t\toffering type.

", + "smithy.api#xmlName": "offeringType" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeReservedInstancesOfferings.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeReservedInstancesOfferingsResult": { + "type": "structure", + "members": { + "ReservedInstancesOfferings": { + "target": "com.amazonaws.ec2#ReservedInstancesOfferingList", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesOfferingsSet", + "smithy.api#documentation": "

A list of Reserved Instances offerings.

", + "smithy.api#xmlName": "reservedInstancesOfferingsSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when\n\t\t\tthere are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of DescribeReservedInstancesOfferings.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeReservedInstancesRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "OfferingClass": { + "target": "com.amazonaws.ec2#OfferingClassType", + "traits": { + "smithy.api#documentation": "

Describes whether the Reserved Instance is Standard or Convertible.

" + } + }, + "ReservedInstancesIds": { + "target": "com.amazonaws.ec2#ReservedInstancesIdStringList", + "traits": { + "smithy.api#documentation": "

One or more Reserved Instance IDs.

\n

Default: Describes all your Reserved Instances, or only those otherwise specified.

", + "smithy.api#xmlName": "ReservedInstancesId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "OfferingType": { + "target": "com.amazonaws.ec2#OfferingTypeValues", + "traits": { + "aws.protocols#ec2QueryName": "OfferingType", + "smithy.api#documentation": "

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API\n\t\t\tversion, you only have access to the Medium Utilization Reserved Instance\n\t\t\toffering type.

", + "smithy.api#xmlName": "offeringType" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeReservedInstances.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeReservedInstancesResult": { + "type": "structure", + "members": { + "ReservedInstances": { + "target": "com.amazonaws.ec2#ReservedInstancesList", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesSet", + "smithy.api#documentation": "

A list of Reserved Instances.

", + "smithy.api#xmlName": "reservedInstancesSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output for DescribeReservedInstances.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeRouteTables": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeRouteTablesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeRouteTablesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more of your route tables.

\n

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.

\n

For more information, see Route tables in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "RouteTables", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeRouteTablesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 100 + } + } + }, + "com.amazonaws.ec2#DescribeRouteTablesRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "RouteTableIds": { + "target": "com.amazonaws.ec2#RouteTableIdStringList", + "traits": { + "smithy.api#documentation": "

One or more route table IDs.

\n

Default: Describes all your route tables.

", + "smithy.api#xmlName": "RouteTableId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeRouteTablesMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeRouteTablesResult": { + "type": "structure", + "members": { + "RouteTables": { + "target": "com.amazonaws.ec2#RouteTableList", + "traits": { + "aws.protocols#ec2QueryName": "RouteTableSet", + "smithy.api#documentation": "

Information about one or more route tables.

", + "smithy.api#xmlName": "routeTableSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of DescribeRouteTables.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeScheduledInstanceAvailability": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeScheduledInstanceAvailabilityRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeScheduledInstanceAvailabilityResult" + }, + "traits": { + "smithy.api#documentation": "

Finds available schedules that meet the specified criteria.

\n

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.

\n

After you find a schedule that meets your needs, call PurchaseScheduledInstances\n to purchase Scheduled Instances with that schedule.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ScheduledInstanceAvailabilitySet", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeScheduledInstanceAvailabilityMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 300 + } + } + }, + "com.amazonaws.ec2#DescribeScheduledInstanceAvailabilityRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "FirstSlotStartTimeRange": { + "target": "com.amazonaws.ec2#SlotDateTimeRangeRequest", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The time period for the first schedule to start.

", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeScheduledInstanceAvailabilityMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return in a single call. \n This value can be between 5 and 300. The default value is 300.\n To retrieve the remaining results, make another call with the returned\n NextToken value.

" + } + }, + "MaxSlotDurationInHours": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours\n and less than 1,720.

" + } + }, + "MinSlotDurationInHours": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#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": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results.

" + } + }, + "Recurrence": { + "target": "com.amazonaws.ec2#ScheduledInstanceRecurrenceRequest", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The schedule recurrence.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeScheduledInstanceAvailability.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeScheduledInstanceAvailabilityResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "ScheduledInstanceAvailabilitySet": { + "target": "com.amazonaws.ec2#ScheduledInstanceAvailabilitySet", + "traits": { + "aws.protocols#ec2QueryName": "ScheduledInstanceAvailabilitySet", + "smithy.api#documentation": "

Information about the available Scheduled Instances.

", + "smithy.api#xmlName": "scheduledInstanceAvailabilitySet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of DescribeScheduledInstanceAvailability.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeScheduledInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeScheduledInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeScheduledInstancesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified Scheduled Instances or all your Scheduled Instances.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ScheduledInstanceSet", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeScheduledInstancesRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return in a single call. \n This value can be between 5 and 300. The default value is 100.\n To retrieve the remaining results, make another call with the returned\n NextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results.

" + } + }, + "ScheduledInstanceIds": { + "target": "com.amazonaws.ec2#ScheduledInstanceIdRequestSet", + "traits": { + "smithy.api#documentation": "

The Scheduled Instance IDs.

", + "smithy.api#xmlName": "ScheduledInstanceId" + } + }, + "SlotStartTimeRange": { + "target": "com.amazonaws.ec2#SlotStartTimeRangeRequest", + "traits": { + "smithy.api#documentation": "

The time period for the first schedule to start.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeScheduledInstances.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeScheduledInstancesResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "ScheduledInstanceSet": { + "target": "com.amazonaws.ec2#ScheduledInstanceSet", + "traits": { + "aws.protocols#ec2QueryName": "ScheduledInstanceSet", + "smithy.api#documentation": "

Information about the Scheduled Instances.

", + "smithy.api#xmlName": "scheduledInstanceSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of DescribeScheduledInstances.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeSecurityGroupReferences": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeSecurityGroupReferencesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeSecurityGroupReferencesResult" + }, + "traits": { + "smithy.api#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.

" + } + }, + "com.amazonaws.ec2#DescribeSecurityGroupReferencesRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#GroupIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the security groups in your account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeSecurityGroupReferencesResult": { + "type": "structure", + "members": { + "SecurityGroupReferenceSet": { + "target": "com.amazonaws.ec2#SecurityGroupReferences", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupReferenceSet", + "smithy.api#documentation": "

Information about the VPCs with the referencing security groups.

", + "smithy.api#xmlName": "securityGroupReferenceSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeSecurityGroupRules": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeSecurityGroupRulesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeSecurityGroupRulesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more of your security group rules.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "SecurityGroupRules", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeSecurityGroupRulesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeSecurityGroupRulesRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "SecurityGroupRuleIds": { + "target": "com.amazonaws.ec2#SecurityGroupRuleIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the security group rules.

", + "smithy.api#xmlName": "SecurityGroupRuleId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeSecurityGroupRulesMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return for this request. To get the next page of \n items, make another request with the token returned in the output. This value\n can be between 5 and 1000. If this parameter is not specified, then all items are\n returned. For more information, see Pagination.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeSecurityGroupRulesResult": { + "type": "structure", + "members": { + "SecurityGroupRules": { + "target": "com.amazonaws.ec2#SecurityGroupRuleList", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupRuleSet", + "smithy.api#documentation": "

Information about security group rules.

", + "smithy.api#xmlName": "securityGroupRuleSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeSecurityGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeSecurityGroupsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeSecurityGroupsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified security groups or all of your security groups.

\n

A security group is for use with instances either in the EC2-Classic platform \n\t\t\t\tor in a specific VPC. For more information, see\n\t\t\t\tAmazon EC2 security groups in \n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide and \n\t\t\t\tSecurity groups for your VPC in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "SecurityGroups", + "pageSize": "MaxResults" + }, + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "SecurityGroupExists": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "length(SecurityGroups[].GroupId) > `0`", + "expected": "true", + "comparator": "booleanEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "errorType": "InvalidGroup.NotFound" + } + } + ], + "minDelay": 5 + } + } + } + }, + "com.amazonaws.ec2#DescribeSecurityGroupsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeSecurityGroupsRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#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.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "GroupIds": { + "target": "com.amazonaws.ec2#GroupIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the security groups. Required for security groups in a nondefault VPC.

\n

Default: Describes all of your security groups.

", + "smithy.api#xmlName": "GroupId" + } + }, + "GroupNames": { + "target": "com.amazonaws.ec2#GroupNameStringList", + "traits": { + "smithy.api#documentation": "

[EC2-Classic and default VPC only] The names of the security groups. You can specify either\n\t\t\tthe security group name or the security group ID. For security groups in a nondefault VPC, use\n\t\t\tthe group-name filter to describe security groups by name.

\n

Default: Describes all of your security groups.

", + "smithy.api#xmlName": "GroupName" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeSecurityGroupsMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return for this request. To get the next page of items,\n make another request with the token returned in the output. This value can be between 5 and 1000. \n If this parameter is not specified, then all items are returned. For more information, see \n Pagination.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeSecurityGroupsResult": { + "type": "structure", + "members": { + "SecurityGroups": { + "target": "com.amazonaws.ec2#SecurityGroupList", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupInfo", + "smithy.api#documentation": "

Information about the security groups.

", + "smithy.api#xmlName": "securityGroupInfo" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeSnapshotAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeSnapshotAttributeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeSnapshotAttributeResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified attribute of the specified snapshot. You can specify only one\n attribute at a time.

\n

For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#DescribeSnapshotAttributeRequest": { + "type": "structure", + "members": { + "Attribute": { + "target": "com.amazonaws.ec2#SnapshotAttributeName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The snapshot attribute you would like to view.

", + "smithy.api#required": {} + } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the EBS snapshot.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeSnapshotAttributeResult": { + "type": "structure", + "members": { + "CreateVolumePermissions": { + "target": "com.amazonaws.ec2#CreateVolumePermissionList", + "traits": { + "aws.protocols#ec2QueryName": "CreateVolumePermission", + "smithy.api#documentation": "

The users and groups that have the permissions for creating volumes from the\n snapshot.

", + "smithy.api#xmlName": "createVolumePermission" + } + }, + "ProductCodes": { + "target": "com.amazonaws.ec2#ProductCodeList", + "traits": { + "aws.protocols#ec2QueryName": "ProductCodes", + "smithy.api#documentation": "

The product codes.

", + "smithy.api#xmlName": "productCodes" + } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the EBS snapshot.

", + "smithy.api#xmlName": "snapshotId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeSnapshotTierStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeSnapshotTierStatusRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeSnapshotTierStatusResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the storage tier status of one or more Amazon EBS snapshots.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "SnapshotTierStatuses", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeSnapshotTierStatusMaxResults": { + "type": "integer" + }, + "com.amazonaws.ec2#DescribeSnapshotTierStatusRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeSnapshotTierStatusMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output. \n\tFor more information, see Pagination.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeSnapshotTierStatusResult": { + "type": "structure", + "members": { + "SnapshotTierStatuses": { + "target": "com.amazonaws.ec2#snapshotTierStatusSet", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotTierStatusSet", + "smithy.api#documentation": "

Information about the snapshot's storage tier.

", + "smithy.api#xmlName": "snapshotTierStatusSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeSnapshots": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeSnapshotsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeSnapshotsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified EBS snapshots available to you or all of the EBS snapshots\n available to you.

\n

The snapshots available to you include public snapshots, private snapshots that you own,\n and private snapshots owned by other Amazon Web Services accounts for which you have explicit create volume\n permissions.

\n

The create volume permissions fall into the following categories:

\n \n

The list of snapshots returned can be filtered by specifying snapshot IDs, snapshot\n owners, or Amazon Web Services accounts with create volume permissions. If no options are specified, \n Amazon EC2 returns all snapshots for which you have create volume permissions.

\n

If you specify one or more snapshot IDs, only snapshots that have the specified IDs are\n returned. If you specify an invalid snapshot ID, an error is returned. If you specify a\n snapshot ID for which you do not have access, it is not included in the returned\n results.

\n

If you specify one or more snapshot owners using the OwnerIds option, only\n snapshots from the specified owners and for which you have access are returned. The results\n can include the Amazon Web Services account IDs of the specified owners, amazon for snapshots\n owned by Amazon, or self for snapshots that you own.

\n

If you specify a list of restorable users, only snapshots with create snapshot permissions\n for those users are returned. You can specify Amazon Web Services account IDs (if you own the snapshots),\n self for snapshots for which you own or have explicit permissions, or\n all for public snapshots.

\n

If you are describing a long list of snapshots, we recommend that you paginate the output to make the\n list more manageable. For more information, see Pagination.

\n

To get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores.

\n

For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Snapshots", + "pageSize": "MaxResults" + }, + "smithy.waiters#waitable": { + "SnapshotCompleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Snapshots[].State", + "expected": "completed", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Snapshots[].State", + "expected": "error", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.ec2#DescribeSnapshotsRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of snapshots to return for this request.\n This value can be between 5 and 1,000; if this value is larger than 1,000, only 1,000 results are returned. \n If this parameter is not used, then the request returns all snapshots. \n You cannot specify this parameter and the snapshot IDs parameter in the same request. For more information, \n see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.

" + } + }, + "OwnerIds": { + "target": "com.amazonaws.ec2#OwnerStringList", + "traits": { + "smithy.api#documentation": "

Scopes the results to snapshots with the specified owners. You can specify a combination of\n Amazon Web Services account IDs, self, and amazon.

", + "smithy.api#xmlName": "Owner" + } + }, + "RestorableByUserIds": { + "target": "com.amazonaws.ec2#RestorableByStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.

", + "smithy.api#xmlName": "RestorableBy" + } + }, + "SnapshotIds": { + "target": "com.amazonaws.ec2#SnapshotIdStringList", + "traits": { + "smithy.api#documentation": "

The snapshot IDs.

\n

Default: Describes the snapshots for which you have create volume permissions.

", + "smithy.api#xmlName": "SnapshotId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeSnapshotsResult": { + "type": "structure", + "members": { + "Snapshots": { + "target": "com.amazonaws.ec2#SnapshotList", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotSet", + "smithy.api#documentation": "

Information about the snapshots.

", + "smithy.api#xmlName": "snapshotSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to return the next page of snapshots. \n This value is null when there are no more snapshots to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeSpotDatafeedSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeSpotDatafeedSubscriptionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeSpotDatafeedSubscriptionResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the data feed for Spot Instances. For more information, see Spot\n Instance data feed in the Amazon EC2 User Guide for Linux Instances.

" + } + }, + "com.amazonaws.ec2#DescribeSpotDatafeedSubscriptionRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeSpotDatafeedSubscription.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeSpotDatafeedSubscriptionResult": { + "type": "structure", + "members": { + "SpotDatafeedSubscription": { + "target": "com.amazonaws.ec2#SpotDatafeedSubscription", + "traits": { + "aws.protocols#ec2QueryName": "SpotDatafeedSubscription", + "smithy.api#documentation": "

The Spot Instance data feed subscription.

", + "smithy.api#xmlName": "spotDatafeedSubscription" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of DescribeSpotDatafeedSubscription.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeSpotFleetInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeSpotFleetInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeSpotFleetInstancesResponse" + }, + "traits": { + "smithy.api#documentation": "

Describes the running instances for the specified Spot Fleet.

" + } + }, + "com.amazonaws.ec2#DescribeSpotFleetInstancesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeSpotFleetInstancesRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeSpotFleetInstancesMaxResults", + "traits": { + "aws.protocols#ec2QueryName": "MaxResults", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

", + "smithy.api#xmlName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "SpotFleetRequestId": { + "target": "com.amazonaws.ec2#SpotFleetRequestId", + "traits": { + "aws.protocols#ec2QueryName": "SpotFleetRequestId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Spot Fleet request.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "spotFleetRequestId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeSpotFleetInstances.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeSpotFleetInstancesResponse": { + "type": "structure", + "members": { + "ActiveInstances": { + "target": "com.amazonaws.ec2#ActiveInstanceSet", + "traits": { + "aws.protocols#ec2QueryName": "ActiveInstanceSet", + "smithy.api#documentation": "

The running instances. This list is refreshed periodically and might be out of\n date.

", + "smithy.api#xmlName": "activeInstanceSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "SpotFleetRequestId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpotFleetRequestId", + "smithy.api#documentation": "

The ID of the Spot Fleet request.

", + "smithy.api#xmlName": "spotFleetRequestId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of DescribeSpotFleetInstances.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeSpotFleetRequestHistory": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeSpotFleetRequestHistoryRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeSpotFleetRequestHistoryResponse" + }, + "traits": { + "smithy.api#documentation": "

Describes the events for the specified Spot Fleet request during the specified\n time.

\n

Spot Fleet events are delayed by up to 30 seconds before they can be described. This\n ensures that you can query by the last evaluated time and not miss a recorded event.\n Spot Fleet events are available for 48 hours.

\n

For more information, see Monitor fleet events using Amazon\n EventBridge in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#DescribeSpotFleetRequestHistoryMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeSpotFleetRequestHistoryRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "EventType": { + "target": "com.amazonaws.ec2#EventType", + "traits": { + "aws.protocols#ec2QueryName": "EventType", + "smithy.api#documentation": "

The type of events to describe. By default, all events are described.

", + "smithy.api#xmlName": "eventType" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeSpotFleetRequestHistoryMaxResults", + "traits": { + "aws.protocols#ec2QueryName": "MaxResults", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

", + "smithy.api#xmlName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "SpotFleetRequestId": { + "target": "com.amazonaws.ec2#SpotFleetRequestId", + "traits": { + "aws.protocols#ec2QueryName": "SpotFleetRequestId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Spot Fleet request.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "spotFleetRequestId" + } + }, + "StartTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "StartTime", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The starting date and time for the events, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", + "smithy.api#required": {}, + "smithy.api#xmlName": "startTime" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeSpotFleetRequestHistory.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeSpotFleetRequestHistoryResponse": { + "type": "structure", + "members": { + "HistoryRecords": { + "target": "com.amazonaws.ec2#HistoryRecords", + "traits": { + "aws.protocols#ec2QueryName": "HistoryRecordSet", + "smithy.api#documentation": "

Information about the events in the history of the Spot Fleet request.

", + "smithy.api#xmlName": "historyRecordSet" + } + }, + "LastEvaluatedTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "LastEvaluatedTime", + "smithy.api#documentation": "

The last date and time for the events, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).\n All records up to this time were retrieved.

\n

If nextToken indicates that there are more items, this value is not\n present.

", + "smithy.api#xmlName": "lastEvaluatedTime" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "SpotFleetRequestId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpotFleetRequestId", + "smithy.api#documentation": "

The ID of the Spot Fleet request.

", + "smithy.api#xmlName": "spotFleetRequestId" + } + }, + "StartTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "StartTime", + "smithy.api#documentation": "

The starting date and time for the events, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", + "smithy.api#xmlName": "startTime" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of DescribeSpotFleetRequestHistory.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeSpotFleetRequests": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeSpotFleetRequestsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeSpotFleetRequestsResponse" + }, + "traits": { + "smithy.api#documentation": "

Describes your Spot Fleet requests.

\n

Spot Fleet requests are deleted 48 hours after they are canceled and their instances\n are terminated.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "SpotFleetRequestConfigs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeSpotFleetRequestsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MaxResults", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

", + "smithy.api#xmlName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "SpotFleetRequestIds": { + "target": "com.amazonaws.ec2#SpotFleetRequestIdList", + "traits": { + "aws.protocols#ec2QueryName": "SpotFleetRequestId", + "smithy.api#documentation": "

The IDs of the Spot Fleet requests.

", + "smithy.api#xmlName": "spotFleetRequestId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeSpotFleetRequests.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeSpotFleetRequestsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "SpotFleetRequestConfigs": { + "target": "com.amazonaws.ec2#SpotFleetRequestConfigSet", + "traits": { + "aws.protocols#ec2QueryName": "SpotFleetRequestConfigSet", + "smithy.api#documentation": "

Information about the configuration of your Spot Fleet.

", + "smithy.api#xmlName": "spotFleetRequestConfigSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of DescribeSpotFleetRequests.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeSpotInstanceRequests": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeSpotInstanceRequestsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeSpotInstanceRequestsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified Spot Instance requests.

\n

You can use DescribeSpotInstanceRequests to find a running Spot Instance by\n examining the response. If the status of the Spot Instance is fulfilled, the\n instance ID appears in the response and contains the identifier of the instance.\n Alternatively, you can use DescribeInstances\n with a filter to look for instances where the instance lifecycle is\n spot.

\n

We recommend that you set MaxResults to a value between 5 and 1000 to\n limit the number of items returned. This paginates the output, which makes the list\n more manageable and returns the items faster. If the list of items exceeds your\n MaxResults value, then that number of items is returned along with a\n NextToken value that can be passed to a subsequent\n DescribeSpotInstanceRequests request to retrieve the remaining\n items.

\n

Spot Instance requests are deleted four hours after they are canceled and their instances are\n terminated.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "SpotInstanceRequests", + "pageSize": "MaxResults" + }, + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "SpotInstanceRequestFulfilled": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "SpotInstanceRequests[].Status.Code", + "expected": "fulfilled", + "comparator": "allStringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "output": { + "path": "SpotInstanceRequests[].Status.Code", + "expected": "request-canceled-and-instance-running", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "SpotInstanceRequests[].Status.Code", + "expected": "schedule-expired", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "SpotInstanceRequests[].Status.Code", + "expected": "canceled-before-fulfillment", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "SpotInstanceRequests[].Status.Code", + "expected": "bad-parameters", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "SpotInstanceRequests[].Status.Code", + "expected": "system-error", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "errorType": "InvalidSpotInstanceRequestID.NotFound" + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.ec2#DescribeSpotInstanceRequestsRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "SpotInstanceRequestIds": { + "target": "com.amazonaws.ec2#SpotInstanceRequestIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the Spot Instance requests.

", + "smithy.api#xmlName": "SpotInstanceRequestId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeSpotInstanceRequests.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeSpotInstanceRequestsResult": { + "type": "structure", + "members": { + "SpotInstanceRequests": { + "target": "com.amazonaws.ec2#SpotInstanceRequestList", + "traits": { + "aws.protocols#ec2QueryName": "SpotInstanceRequestSet", + "smithy.api#documentation": "

The Spot Instance requests.

", + "smithy.api#xmlName": "spotInstanceRequestSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of DescribeSpotInstanceRequests.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeSpotPriceHistory": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeSpotPriceHistoryRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeSpotPriceHistoryResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the Spot price history. For more information, see Spot Instance pricing history in the\n Amazon EC2 User Guide for Linux Instances.

\n

When you specify a start and end time, the operation returns the prices of the\n instance types within that time range. It also returns the last price change before the\n start time, which is the effective price as of the start time.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "SpotPriceHistory", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeSpotPriceHistoryRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

Filters the results by the specified Availability Zone.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "EndTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "EndTime", + "smithy.api#documentation": "

The date and time, up to the current date, from which to stop retrieving the price\n history data, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", + "smithy.api#xmlName": "endTime" + } + }, + "InstanceTypes": { + "target": "com.amazonaws.ec2#InstanceTypeList", + "traits": { + "smithy.api#documentation": "

Filters the results by the specified instance types.

", + "smithy.api#xmlName": "InstanceType" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MaxResults", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

", + "smithy.api#xmlName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

", + "smithy.api#xmlName": "nextToken" + } + }, + "ProductDescriptions": { + "target": "com.amazonaws.ec2#ProductDescriptionList", + "traits": { + "smithy.api#documentation": "

Filters the results by the specified basic product descriptions.

", + "smithy.api#xmlName": "ProductDescription" + } + }, + "StartTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "StartTime", + "smithy.api#documentation": "

The date and time, up to the past 90 days, from which to start retrieving the price\n history data, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", + "smithy.api#xmlName": "startTime" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeSpotPriceHistory.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeSpotPriceHistoryResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "SpotPriceHistory": { + "target": "com.amazonaws.ec2#SpotPriceHistoryList", + "traits": { + "aws.protocols#ec2QueryName": "SpotPriceHistorySet", + "smithy.api#documentation": "

The historical Spot prices.

", + "smithy.api#xmlName": "spotPriceHistorySet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of DescribeSpotPriceHistory.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeStaleSecurityGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeStaleSecurityGroupsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeStaleSecurityGroupsResult" + }, + "traits": { + "smithy.api#documentation": "

[VPC only] Describes the stale security group rules for security groups in a specified VPC. \n Rules are stale when they reference a deleted security group in the same VPC or in a peer VPC, \n or if they reference a security group in a peer VPC for which the VPC peering connection has \n been deleted.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "StaleSecurityGroupSet", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeStaleSecurityGroupsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 255 + } + } + }, + "com.amazonaws.ec2#DescribeStaleSecurityGroupsNextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.ec2#DescribeStaleSecurityGroupsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeStaleSecurityGroupsMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return for this request. To get the next page of items,\n make another request with the token returned in the output. For more information, \n see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#DescribeStaleSecurityGroupsNextToken", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.

" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeStaleSecurityGroupsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n If there are no additional items to return, the string is empty.

", + "smithy.api#xmlName": "nextToken" + } + }, + "StaleSecurityGroupSet": { + "target": "com.amazonaws.ec2#StaleSecurityGroupSet", + "traits": { + "aws.protocols#ec2QueryName": "StaleSecurityGroupSet", + "smithy.api#documentation": "

Information about the stale security groups.

", + "smithy.api#xmlName": "staleSecurityGroupSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeStoreImageTasks": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeStoreImageTasksRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeStoreImageTasksResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the progress of the AMI store tasks. You can describe the store tasks for\n specified AMIs. If you don't specify the AMIs, you get a paginated list of store tasks from\n the last 31 days.

\n

For each AMI task, the response indicates if the task is InProgress,\n Completed, or Failed. For tasks InProgress, the\n response shows the estimated progress as a percentage.

\n

Tasks are listed in reverse chronological order. Currently, only tasks from the past 31\n days can be viewed.

\n

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the\n Amazon EC2 User Guide.

\n

For more information, see Store and restore an AMI using\n \tAmazon S3 in the Amazon EC2 User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "StoreImageTaskResults", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeStoreImageTasksRequest": { + "type": "structure", + "members": { + "ImageIds": { + "target": "com.amazonaws.ec2#ImageIdList", + "traits": { + "smithy.api#documentation": "

The AMI IDs for which to show progress. Up to 20 AMI IDs can be included in a request.

", + "smithy.api#xmlName": "ImageId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeStoreImageTasksRequestMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

\n

You cannot specify this parameter and the ImageIDs parameter\n in the same call.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeStoreImageTasksRequestMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.ec2#DescribeStoreImageTasksResult": { + "type": "structure", + "members": { + "StoreImageTaskResults": { + "target": "com.amazonaws.ec2#StoreImageTaskResultSet", + "traits": { + "aws.protocols#ec2QueryName": "StoreImageTaskResultSet", + "smithy.api#documentation": "

The information about the AMI store tasks.

", + "smithy.api#xmlName": "storeImageTaskResultSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeSubnets": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeSubnetsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeSubnetsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more of your subnets.

\n

For more information, see Your VPC and subnets in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Subnets", + "pageSize": "MaxResults" + }, + "smithy.waiters#waitable": { + "SubnetAvailable": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Subnets[].State", + "expected": "available", + "comparator": "allStringEquals" + } + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.ec2#DescribeSubnetsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeSubnetsRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "SubnetIds": { + "target": "com.amazonaws.ec2#SubnetIdStringList", + "traits": { + "smithy.api#documentation": "

One or more subnet IDs.

\n

Default: Describes all your subnets.

", + "smithy.api#xmlName": "SubnetId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeSubnetsMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeSubnetsResult": { + "type": "structure", + "members": { + "Subnets": { + "target": "com.amazonaws.ec2#SubnetList", + "traits": { + "aws.protocols#ec2QueryName": "SubnetSet", + "smithy.api#documentation": "

Information about one or more subnets.

", + "smithy.api#xmlName": "subnetSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeTagsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeTagsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified tags for your EC2 resources.

\n

For more information about tags, see Tag your Amazon EC2 resources in the\n Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Tags", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeTagsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MaxResults", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return for this request. This value can be between 5 and 1000. \n To get the next page of items, make another request with the token returned in the output.\n For more information, see Pagination.

", + "smithy.api#xmlName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeTagsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagDescriptionList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeTrafficMirrorFilters": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeTrafficMirrorFiltersRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeTrafficMirrorFiltersResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more Traffic Mirror filters.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TrafficMirrorFilters", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeTrafficMirrorFiltersRequest": { + "type": "structure", + "members": { + "TrafficMirrorFilterIds": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterIdList", + "traits": { + "smithy.api#documentation": "

The ID of the Traffic Mirror filter.

", + "smithy.api#xmlName": "TrafficMirrorFilterId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TrafficMirroringMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeTrafficMirrorFiltersResult": { + "type": "structure", + "members": { + "TrafficMirrorFilters": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterSet", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorFilterSet", + "smithy.api#documentation": "

Information about one or more Traffic Mirror filters.

", + "smithy.api#xmlName": "trafficMirrorFilterSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. The value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeTrafficMirrorSessions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeTrafficMirrorSessionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeTrafficMirrorSessionsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TrafficMirrorSessions", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeTrafficMirrorSessionsRequest": { + "type": "structure", + "members": { + "TrafficMirrorSessionIds": { + "target": "com.amazonaws.ec2#TrafficMirrorSessionIdList", + "traits": { + "smithy.api#documentation": "

The ID of the Traffic Mirror session.

", + "smithy.api#xmlName": "TrafficMirrorSessionId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TrafficMirroringMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeTrafficMirrorSessionsResult": { + "type": "structure", + "members": { + "TrafficMirrorSessions": { + "target": "com.amazonaws.ec2#TrafficMirrorSessionSet", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorSessionSet", + "smithy.api#documentation": "

Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.

", + "smithy.api#xmlName": "trafficMirrorSessionSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. The value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeTrafficMirrorTargets": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeTrafficMirrorTargetsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeTrafficMirrorTargetsResult" + }, + "traits": { + "smithy.api#documentation": "

Information about one or more Traffic Mirror targets.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TrafficMirrorTargets", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeTrafficMirrorTargetsRequest": { + "type": "structure", + "members": { + "TrafficMirrorTargetIds": { + "target": "com.amazonaws.ec2#TrafficMirrorTargetIdList", + "traits": { + "smithy.api#documentation": "

The ID of the Traffic Mirror targets.

", + "smithy.api#xmlName": "TrafficMirrorTargetId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TrafficMirroringMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeTrafficMirrorTargetsResult": { + "type": "structure", + "members": { + "TrafficMirrorTargets": { + "target": "com.amazonaws.ec2#TrafficMirrorTargetSet", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorTargetSet", + "smithy.api#documentation": "

Information about one or more Traffic Mirror targets.

", + "smithy.api#xmlName": "trafficMirrorTargetSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. The value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayAttachments": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeTransitGatewayAttachmentsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeTransitGatewayAttachmentsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more attachments between resources and transit gateways. By default, all attachments are described.\n Alternatively, you can filter the results by attachment ID, attachment state, resource ID, or resource owner.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransitGatewayAttachments", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayAttachmentsRequest": { + "type": "structure", + "members": { + "TransitGatewayAttachmentIds": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the attachments.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayAttachmentsResult": { + "type": "structure", + "members": { + "TransitGatewayAttachments": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentList", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachments", + "smithy.api#documentation": "

Information about the attachments.

", + "smithy.api#xmlName": "transitGatewayAttachments" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayConnectPeers": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeTransitGatewayConnectPeersRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeTransitGatewayConnectPeersResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more Connect peers.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransitGatewayConnectPeers", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayConnectPeersRequest": { + "type": "structure", + "members": { + "TransitGatewayConnectPeerIds": { + "target": "com.amazonaws.ec2#TransitGatewayConnectPeerIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the Connect peers.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayConnectPeersResult": { + "type": "structure", + "members": { + "TransitGatewayConnectPeers": { + "target": "com.amazonaws.ec2#TransitGatewayConnectPeerList", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayConnectPeerSet", + "smithy.api#documentation": "

Information about the Connect peers.

", + "smithy.api#xmlName": "transitGatewayConnectPeerSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayConnects": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeTransitGatewayConnectsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeTransitGatewayConnectsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more Connect attachments.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransitGatewayConnects", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayConnectsRequest": { + "type": "structure", + "members": { + "TransitGatewayAttachmentIds": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the attachments.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayConnectsResult": { + "type": "structure", + "members": { + "TransitGatewayConnects": { + "target": "com.amazonaws.ec2#TransitGatewayConnectList", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayConnectSet", + "smithy.api#documentation": "

Information about the Connect attachments.

", + "smithy.api#xmlName": "transitGatewayConnectSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayMulticastDomains": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeTransitGatewayMulticastDomainsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeTransitGatewayMulticastDomainsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more transit gateway multicast domains.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransitGatewayMulticastDomains", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayMulticastDomainsRequest": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainIds": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainIdStringList", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayMulticastDomainsResult": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomains": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainList", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayMulticastDomains", + "smithy.api#documentation": "

Information about the transit gateway multicast domains.

", + "smithy.api#xmlName": "transitGatewayMulticastDomains" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayPeeringAttachments": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeTransitGatewayPeeringAttachmentsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeTransitGatewayPeeringAttachmentsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes your transit gateway peering attachments.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransitGatewayPeeringAttachments", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayPeeringAttachmentsRequest": { + "type": "structure", + "members": { + "TransitGatewayAttachmentIds": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentIdStringList", + "traits": { + "smithy.api#documentation": "

One or more IDs of the transit gateway peering attachments.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayPeeringAttachmentsResult": { + "type": "structure", + "members": { + "TransitGatewayPeeringAttachments": { + "target": "com.amazonaws.ec2#TransitGatewayPeeringAttachmentList", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayPeeringAttachments", + "smithy.api#documentation": "

The transit gateway peering attachments.

", + "smithy.api#xmlName": "transitGatewayPeeringAttachments" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayPolicyTables": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeTransitGatewayPolicyTablesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeTransitGatewayPolicyTablesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more transit gateway route policy tables.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransitGatewayPolicyTables", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayPolicyTablesRequest": { + "type": "structure", + "members": { + "TransitGatewayPolicyTableIds": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the transit gateway policy tables.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters associated with the transit gateway policy table.

", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayPolicyTablesResult": { + "type": "structure", + "members": { + "TransitGatewayPolicyTables": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableList", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayPolicyTables", + "smithy.api#documentation": "

Describes the transit gateway policy tables.

", + "smithy.api#xmlName": "transitGatewayPolicyTables" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token for the next page of results.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayRouteTableAnnouncements": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeTransitGatewayRouteTableAnnouncementsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeTransitGatewayRouteTableAnnouncementsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more transit gateway route table advertisements.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransitGatewayRouteTableAnnouncements", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayRouteTableAnnouncementsRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableAnnouncementIds": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the transit gateway route tables that are being advertised.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters associated with the transit gateway policy table.

", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayRouteTableAnnouncementsResult": { + "type": "structure", + "members": { + "TransitGatewayRouteTableAnnouncements": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementList", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableAnnouncements", + "smithy.api#documentation": "

Describes the transit gateway route table announcement.

", + "smithy.api#xmlName": "transitGatewayRouteTableAnnouncements" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token for the next page of results.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayRouteTables": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeTransitGatewayRouteTablesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeTransitGatewayRouteTablesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more transit gateway route tables. By default, all transit gateway route tables are described.\n Alternatively, you can filter the results.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransitGatewayRouteTables", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayRouteTablesRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableIds": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the transit gateway route tables.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayRouteTablesResult": { + "type": "structure", + "members": { + "TransitGatewayRouteTables": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableList", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTables", + "smithy.api#documentation": "

Information about the transit gateway route tables.

", + "smithy.api#xmlName": "transitGatewayRouteTables" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayVpcAttachments": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeTransitGatewayVpcAttachmentsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeTransitGatewayVpcAttachmentsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more VPC attachments. By default, all VPC attachments are described.\n Alternatively, you can filter the results.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransitGatewayVpcAttachments", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayVpcAttachmentsRequest": { + "type": "structure", + "members": { + "TransitGatewayAttachmentIds": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the attachments.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayVpcAttachmentsResult": { + "type": "structure", + "members": { + "TransitGatewayVpcAttachments": { + "target": "com.amazonaws.ec2#TransitGatewayVpcAttachmentList", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayVpcAttachments", + "smithy.api#documentation": "

Information about the VPC attachments.

", + "smithy.api#xmlName": "transitGatewayVpcAttachments" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGateways": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeTransitGatewaysRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeTransitGatewaysResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can\n filter the results.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransitGateways", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeTransitGatewaysRequest": { + "type": "structure", + "members": { + "TransitGatewayIds": { + "target": "com.amazonaws.ec2#TransitGatewayIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the transit gateways.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeTransitGatewaysResult": { + "type": "structure", + "members": { + "TransitGateways": { + "target": "com.amazonaws.ec2#TransitGatewayList", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewaySet", + "smithy.api#documentation": "

Information about the transit gateways.

", + "smithy.api#xmlName": "transitGatewaySet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeTrunkInterfaceAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeTrunkInterfaceAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeTrunkInterfaceAssociationsResult" + }, + "traits": { + "smithy.api#documentation": "\n

This API action is currently in limited preview only. \n If you are interested in using this feature, contact your account manager.

\n \n

Describes one or more network interface trunk associations.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InterfaceAssociations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeTrunkInterfaceAssociationsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 255 + } + } + }, + "com.amazonaws.ec2#DescribeTrunkInterfaceAssociationsRequest": { + "type": "structure", + "members": { + "AssociationIds": { + "target": "com.amazonaws.ec2#TrunkInterfaceAssociationIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the associations.

", + "smithy.api#xmlName": "AssociationId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeTrunkInterfaceAssociationsMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeTrunkInterfaceAssociationsResult": { + "type": "structure", + "members": { + "InterfaceAssociations": { + "target": "com.amazonaws.ec2#TrunkInterfaceAssociationList", + "traits": { + "aws.protocols#ec2QueryName": "InterfaceAssociationSet", + "smithy.api#documentation": "

Information about the trunk associations.

", + "smithy.api#xmlName": "interfaceAssociationSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessEndpoints": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessEndpointsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessEndpointsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified Amazon Web Services Verified Access endpoints.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "VerifiedAccessEndpoints", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessEndpointsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessEndpointsRequest": { + "type": "structure", + "members": { + "VerifiedAccessEndpointIds": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointIdList", + "traits": { + "smithy.api#documentation": "

The ID of the Verified Access endpoint.

", + "smithy.api#xmlName": "VerifiedAccessEndpointId" + } + }, + "VerifiedAccessInstanceId": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceId", + "traits": { + "smithy.api#documentation": "

The ID of the Verified Access instance.

" + } + }, + "VerifiedAccessGroupId": { + "target": "com.amazonaws.ec2#VerifiedAccessGroupId", + "traits": { + "smithy.api#documentation": "

The ID of the Verified Access group.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessEndpointsMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessEndpointsResult": { + "type": "structure", + "members": { + "VerifiedAccessEndpoints": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointList", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessEndpointSet", + "smithy.api#documentation": "

The ID of the Verified Access endpoint.

", + "smithy.api#xmlName": "verifiedAccessEndpointSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessGroupMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessGroupsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessGroupsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified Verified Access groups.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "VerifiedAccessGroups", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessGroupsRequest": { + "type": "structure", + "members": { + "VerifiedAccessGroupIds": { + "target": "com.amazonaws.ec2#VerifiedAccessGroupIdList", + "traits": { + "smithy.api#documentation": "

The ID of the Verified Access groups.

", + "smithy.api#xmlName": "VerifiedAccessGroupId" + } + }, + "VerifiedAccessInstanceId": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceId", + "traits": { + "smithy.api#documentation": "

The ID of the Verified Access instance.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessGroupMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessGroupsResult": { + "type": "structure", + "members": { + "VerifiedAccessGroups": { + "target": "com.amazonaws.ec2#VerifiedAccessGroupList", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessGroupSet", + "smithy.api#documentation": "

The ID of the Verified Access group.

", + "smithy.api#xmlName": "verifiedAccessGroupSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessInstanceLoggingConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessInstanceLoggingConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessInstanceLoggingConfigurationsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified Amazon Web Services Verified Access instances.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LoggingConfigurations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessInstanceLoggingConfigurationsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessInstanceLoggingConfigurationsRequest": { + "type": "structure", + "members": { + "VerifiedAccessInstanceIds": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the Verified Access instances.

", + "smithy.api#xmlName": "VerifiedAccessInstanceId" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessInstanceLoggingConfigurationsMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessInstanceLoggingConfigurationsResult": { + "type": "structure", + "members": { + "LoggingConfigurations": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceLoggingConfigurationList", + "traits": { + "aws.protocols#ec2QueryName": "LoggingConfigurationSet", + "smithy.api#documentation": "

The current logging configuration for the Verified Access instances.

", + "smithy.api#xmlName": "loggingConfigurationSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessInstancesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified Amazon Web Services Verified Access instances.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "VerifiedAccessInstances", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessInstancesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 200 + } + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessInstancesRequest": { + "type": "structure", + "members": { + "VerifiedAccessInstanceIds": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the Verified Access instances.

", + "smithy.api#xmlName": "VerifiedAccessInstanceId" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessInstancesMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessInstancesResult": { + "type": "structure", + "members": { + "VerifiedAccessInstances": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceList", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessInstanceSet", + "smithy.api#documentation": "

The IDs of the Verified Access instances.

", + "smithy.api#xmlName": "verifiedAccessInstanceSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessTrustProviders": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessTrustProvidersRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessTrustProvidersResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified Amazon Web Services Verified Access trust providers.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "VerifiedAccessTrustProviders", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessTrustProvidersMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 200 + } + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessTrustProvidersRequest": { + "type": "structure", + "members": { + "VerifiedAccessTrustProviderIds": { + "target": "com.amazonaws.ec2#VerifiedAccessTrustProviderIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the Verified Access trust providers.

", + "smithy.api#xmlName": "VerifiedAccessTrustProviderId" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeVerifiedAccessTrustProvidersMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVerifiedAccessTrustProvidersResult": { + "type": "structure", + "members": { + "VerifiedAccessTrustProviders": { + "target": "com.amazonaws.ec2#VerifiedAccessTrustProviderList", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessTrustProviderSet", + "smithy.api#documentation": "

The IDs of the Verified Access trust providers.

", + "smithy.api#xmlName": "verifiedAccessTrustProviderSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVolumeAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVolumeAttributeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVolumeAttributeResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified attribute of the specified volume. You can specify only one\n attribute at a time.

\n

For more information about EBS volumes, see Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#DescribeVolumeAttributeRequest": { + "type": "structure", + "members": { + "Attribute": { + "target": "com.amazonaws.ec2#VolumeAttributeName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The attribute of the volume. This parameter is required.

", + "smithy.api#required": {} + } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#VolumeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the volume.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVolumeAttributeResult": { + "type": "structure", + "members": { + "AutoEnableIO": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "aws.protocols#ec2QueryName": "AutoEnableIO", + "smithy.api#documentation": "

The state of autoEnableIO attribute.

", + "smithy.api#xmlName": "autoEnableIO" + } + }, + "ProductCodes": { + "target": "com.amazonaws.ec2#ProductCodeList", + "traits": { + "aws.protocols#ec2QueryName": "ProductCodes", + "smithy.api#documentation": "

A list of product codes.

", + "smithy.api#xmlName": "productCodes" + } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VolumeId", + "smithy.api#documentation": "

The ID of the volume.

", + "smithy.api#xmlName": "volumeId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVolumeStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVolumeStatusRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVolumeStatusResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the status of the specified volumes. Volume status provides the result of the\n checks performed on your volumes to determine events that can impair the performance of your\n volumes. The performance of a volume can be affected if an issue occurs on the volume's\n underlying host. If the volume's underlying host experiences a power outage or system issue,\n after the system is restored, there could be data inconsistencies on the volume. Volume events\n notify you if this occurs. Volume actions notify you if any action needs to be taken in\n response to the event.

\n

The DescribeVolumeStatus operation provides the following information about\n the specified volumes:

\n

\n Status: Reflects the current status of the volume. The possible\n values are ok, impaired , warning, or\n insufficient-data. If all checks pass, the overall status of the volume is\n ok. If the check fails, the overall status is impaired. If the\n status is insufficient-data, then the checks might still be taking place on your\n volume at the time. We recommend that you retry the request. For more information about volume\n status, see Monitor the status of your volumes in the\n Amazon Elastic Compute Cloud User Guide.

\n

\n Events: Reflect the cause of a volume status and might require you to\n take action. For example, if your volume returns an impaired status, then the\n volume event might be potential-data-inconsistency. This means that your volume\n has been affected by an issue with the underlying host, has all I/O operations disabled, and\n might have inconsistent data.

\n

\n Actions: Reflect the actions you might have to take in response to an\n event. For example, if the status of the volume is impaired and the volume event\n shows potential-data-inconsistency, then the action shows\n enable-volume-io. This means that you may want to enable the I/O operations for\n the volume by calling the EnableVolumeIO action and then check the volume\n for data consistency.

\n

Volume status is based on the volume status checks, and does not reflect the volume state.\n Therefore, volume status does not indicate volumes in the error state (for\n example, when a volume is incapable of accepting I/O.)

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "VolumeStatuses", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeVolumeStatusRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return for this request. To get the next page of items,\n make another request with the token returned in the output. This value can be between 5 and 1,000;\n if the value is larger than 1,000, only 1,000 results are returned. If this parameter is not used, \n then all items are returned. You cannot specify this parameter and the volume IDs parameter in the \n same request. For more information, see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.

" + } + }, + "VolumeIds": { + "target": "com.amazonaws.ec2#VolumeIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the volumes.

\n

Default: Describes all your volumes.

", + "smithy.api#xmlName": "VolumeId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVolumeStatusResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "VolumeStatuses": { + "target": "com.amazonaws.ec2#VolumeStatusList", + "traits": { + "aws.protocols#ec2QueryName": "VolumeStatusSet", + "smithy.api#documentation": "

Information about the status of the volumes.

", + "smithy.api#xmlName": "volumeStatusSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVolumes": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVolumesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVolumesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified EBS volumes or all of your EBS volumes.

\n

If you are describing a long list of volumes, we recommend that you paginate the output to make the list\n more manageable. For more information, see Pagination.

\n

For more information about EBS volumes, see Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Volumes", + "pageSize": "MaxResults" + }, + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "VolumeAvailable": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Volumes[].State", + "expected": "available", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Volumes[].State", + "expected": "deleted", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 15 + }, + "VolumeDeleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Volumes[].State", + "expected": "deleted", + "comparator": "allStringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "errorType": "InvalidVolume.NotFound" + } + } + ], + "minDelay": 15 + }, + "VolumeInUse": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Volumes[].State", + "expected": "in-use", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Volumes[].State", + "expected": "deleted", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.ec2#DescribeVolumesModifications": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVolumesModificationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVolumesModificationsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the most recent volume modification request for the specified EBS volumes.

\n

If a volume has never been modified, some information in the output will be null.\n If a volume has been modified more than once, the output includes only the most \n recent modification request.

\n

You can also use CloudWatch Events to check the status of a modification to an EBS\n volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. For more information, see\n Monitor the progress of volume modifications in the Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "VolumesModifications", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeVolumesModificationsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "VolumeIds": { + "target": "com.amazonaws.ec2#VolumeIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the volumes.

", + "smithy.api#xmlName": "VolumeId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned by a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results (up to a limit of 500) to be returned in a paginated\n request. For more information, see Pagination.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVolumesModificationsResult": { + "type": "structure", + "members": { + "VolumesModifications": { + "target": "com.amazonaws.ec2#VolumeModificationList", + "traits": { + "aws.protocols#ec2QueryName": "VolumeModificationSet", + "smithy.api#documentation": "

Information about the volume modifications.

", + "smithy.api#xmlName": "volumeModificationSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n This value is null if there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVolumesRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "VolumeIds": { + "target": "com.amazonaws.ec2#VolumeIdStringList", + "traits": { + "smithy.api#documentation": "

The volume IDs.

", + "smithy.api#xmlName": "VolumeId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MaxResults", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of volumes to return for this request. \n This value can be between 5 and 500; if you specify a value larger than 500, only 500 items are returned. \n If this parameter is not used, then all items are returned. You cannot specify this parameter and the\n volume IDs parameter in the same request. For more information, see Pagination.

", + "smithy.api#xmlName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token returned from a previous paginated request. \n Pagination continues from the end of the items returned from the previous request.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVolumesResult": { + "type": "structure", + "members": { + "Volumes": { + "target": "com.amazonaws.ec2#VolumeList", + "traits": { + "aws.protocols#ec2QueryName": "VolumeSet", + "smithy.api#documentation": "

Information about the volumes.

", + "smithy.api#xmlName": "volumeSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVpcAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVpcAttributeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVpcAttributeResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.

" + } + }, + "com.amazonaws.ec2#DescribeVpcAttributeRequest": { + "type": "structure", + "members": { + "Attribute": { + "target": "com.amazonaws.ec2#VpcAttributeName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The VPC attribute.

", + "smithy.api#required": {} + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVpcAttributeResult": { + "type": "structure", + "members": { + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } + }, + "EnableDnsHostnames": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "aws.protocols#ec2QueryName": "EnableDnsHostnames", + "smithy.api#documentation": "

Indicates whether the instances launched in the VPC get DNS hostnames.\n\t\t\t\tIf this attribute is true, instances in the VPC get DNS hostnames;\n\t\t\t\totherwise, they do not.

", + "smithy.api#xmlName": "enableDnsHostnames" + } + }, + "EnableDnsSupport": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "aws.protocols#ec2QueryName": "EnableDnsSupport", + "smithy.api#documentation": "

Indicates whether DNS resolution is enabled for\n\t\t\t\tthe VPC. If this attribute is true, the Amazon DNS server\n\t\t\t\tresolves DNS hostnames for your instances to their corresponding\n\t\t\t\tIP addresses; otherwise, it does not.

", + "smithy.api#xmlName": "enableDnsSupport" + } + }, + "EnableNetworkAddressUsageMetrics": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "aws.protocols#ec2QueryName": "EnableNetworkAddressUsageMetrics", + "smithy.api#documentation": "

Indicates whether Network Address Usage metrics are enabled for your VPC.

", + "smithy.api#xmlName": "enableNetworkAddressUsageMetrics" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVpcClassicLink": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVpcClassicLinkRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVpcClassicLinkResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the ClassicLink status of one or more VPCs.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " + } + }, + "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupport": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupportRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupportResult" + }, + "traits": { + "smithy.api#documentation": "\n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n \n

Describes the ClassicLink DNS support status of one or more VPCs. If enabled, the DNS\n hostname of a linked EC2-Classic instance resolves to its private IP address when\n addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname\n of an instance in a VPC resolves to its private IP address when addressed from a linked\n EC2-Classic instance. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Vpcs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupportMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 255 + } + } + }, + "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupportNextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupportRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupportMaxResults", + "traits": { + "aws.protocols#ec2QueryName": "MaxResults", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

", + "smithy.api#xmlName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupportNextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

", + "smithy.api#xmlName": "nextToken" + } + }, + "VpcIds": { + "target": "com.amazonaws.ec2#VpcClassicLinkIdList", + "traits": { + "smithy.api#documentation": "

One or more VPC IDs.

", + "smithy.api#xmlName": "VpcIds" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupportResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupportNextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "Vpcs": { + "target": "com.amazonaws.ec2#ClassicLinkDnsSupportList", + "traits": { + "aws.protocols#ec2QueryName": "Vpcs", + "smithy.api#documentation": "

Information about the ClassicLink DNS support status of the VPCs.

", + "smithy.api#xmlName": "vpcs" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVpcClassicLinkRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "VpcIds": { + "target": "com.amazonaws.ec2#VpcClassicLinkIdList", + "traits": { + "smithy.api#documentation": "

One or more VPCs for which you want to describe the ClassicLink status.

", + "smithy.api#xmlName": "VpcId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVpcClassicLinkResult": { + "type": "structure", + "members": { + "Vpcs": { + "target": "com.amazonaws.ec2#VpcClassicLinkList", + "traits": { + "aws.protocols#ec2QueryName": "VpcSet", + "smithy.api#documentation": "

The ClassicLink status of one or more VPCs.

", + "smithy.api#xmlName": "vpcSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVpcEndpointConnectionNotifications": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVpcEndpointConnectionNotificationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVpcEndpointConnectionNotificationsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the connection notifications for VPC endpoints and VPC endpoint\n services.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ConnectionNotificationSet", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeVpcEndpointConnectionNotificationsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ConnectionNotificationId": { + "target": "com.amazonaws.ec2#ConnectionNotificationId", + "traits": { + "smithy.api#documentation": "

The ID of the notification.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another request with the returned NextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to request the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVpcEndpointConnectionNotificationsResult": { + "type": "structure", + "members": { + "ConnectionNotificationSet": { + "target": "com.amazonaws.ec2#ConnectionNotificationSet", + "traits": { + "aws.protocols#ec2QueryName": "ConnectionNotificationSet", + "smithy.api#documentation": "

The notifications.

", + "smithy.api#xmlName": "connectionNotificationSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is\n null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVpcEndpointConnections": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVpcEndpointConnectionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVpcEndpointConnectionsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the VPC endpoint connections to your VPC endpoint services, including any\n endpoints that are pending your acceptance.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "VpcEndpointConnections", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeVpcEndpointConnectionsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining\n results of the initial request can be seen by sending another request with the returned\n NextToken value. This value can be between 5 and 1,000; if\n MaxResults is given a value larger than 1,000, only 1,000 results are\n returned.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to retrieve the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVpcEndpointConnectionsResult": { + "type": "structure", + "members": { + "VpcEndpointConnections": { + "target": "com.amazonaws.ec2#VpcEndpointConnectionSet", + "traits": { + "aws.protocols#ec2QueryName": "VpcEndpointConnectionSet", + "smithy.api#documentation": "

Information about the VPC endpoint connections.

", + "smithy.api#xmlName": "vpcEndpointConnectionSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVpcEndpointServiceConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVpcEndpointServiceConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVpcEndpointServiceConfigurationsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the VPC endpoint service configurations in your account (your services).

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ServiceConfigurations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeVpcEndpointServiceConfigurationsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ServiceIds": { + "target": "com.amazonaws.ec2#VpcEndpointServiceIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the endpoint services.

", + "smithy.api#xmlName": "ServiceId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining\n results of the initial request can be seen by sending another request with the returned\n NextToken value. This value can be between 5 and 1,000; if\n MaxResults is given a value larger than 1,000, only 1,000 results are\n returned.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to retrieve the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVpcEndpointServiceConfigurationsResult": { + "type": "structure", + "members": { + "ServiceConfigurations": { + "target": "com.amazonaws.ec2#ServiceConfigurationSet", + "traits": { + "aws.protocols#ec2QueryName": "ServiceConfigurationSet", + "smithy.api#documentation": "

Information about the services.

", + "smithy.api#xmlName": "serviceConfigurationSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVpcEndpointServicePermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVpcEndpointServicePermissionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVpcEndpointServicePermissionsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the principals (service consumers) that are permitted to discover your VPC\n endpoint service.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AllowedPrincipals", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeVpcEndpointServicePermissionsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ServiceId": { + "target": "com.amazonaws.ec2#VpcEndpointServiceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the service.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining\n results of the initial request can be seen by sending another request with the returned\n NextToken value. This value can be between 5 and 1,000; if\n MaxResults is given a value larger than 1,000, only 1,000 results are\n returned.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to retrieve the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVpcEndpointServicePermissionsResult": { + "type": "structure", + "members": { + "AllowedPrincipals": { + "target": "com.amazonaws.ec2#AllowedPrincipalSet", + "traits": { + "aws.protocols#ec2QueryName": "AllowedPrincipals", + "smithy.api#documentation": "

Information about the allowed principals.

", + "smithy.api#xmlName": "allowedPrincipals" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVpcEndpointServices": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVpcEndpointServicesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVpcEndpointServicesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes available services to which you can create a VPC endpoint.

\n

When the service provider and the consumer have different accounts in multiple\n Availability Zones, and the consumer views the VPC endpoint service information, the\n response only includes the common Availability Zones. For example, when the service\n provider account uses us-east-1a and us-east-1c and the\n consumer uses us-east-1a and us-east-1b, the response includes\n the VPC endpoint services in the common Availability Zone,\n us-east-1a.

" + } + }, + "com.amazonaws.ec2#DescribeVpcEndpointServicesRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ServiceNames": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The service names.

", + "smithy.api#xmlName": "ServiceName" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#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.

\n

Constraint: If the value is greater than 1,000, we return only 1,000 items.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a prior call.)

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVpcEndpointServicesResult": { + "type": "structure", + "members": { + "ServiceNames": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "ServiceNameSet", + "smithy.api#documentation": "

The supported services.

", + "smithy.api#xmlName": "serviceNameSet" + } + }, + "ServiceDetails": { + "target": "com.amazonaws.ec2#ServiceDetailSet", + "traits": { + "aws.protocols#ec2QueryName": "ServiceDetailSet", + "smithy.api#documentation": "

Information about the service.

", + "smithy.api#xmlName": "serviceDetailSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVpcEndpoints": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVpcEndpointsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVpcEndpointsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes your VPC endpoints.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "VpcEndpoints", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeVpcEndpointsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "VpcEndpointIds": { + "target": "com.amazonaws.ec2#VpcEndpointIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the VPC endpoints.

", + "smithy.api#xmlName": "VpcEndpointId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#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.

\n

Constraint: If the value is greater than 1,000, we return only 1,000 items.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a prior call.)

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVpcEndpointsResult": { + "type": "structure", + "members": { + "VpcEndpoints": { + "target": "com.amazonaws.ec2#VpcEndpointSet", + "traits": { + "aws.protocols#ec2QueryName": "VpcEndpointSet", + "smithy.api#documentation": "

Information about the endpoints.

", + "smithy.api#xmlName": "vpcEndpointSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVpcPeeringConnections": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVpcPeeringConnectionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVpcPeeringConnectionsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more of your VPC peering connections.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "VpcPeeringConnections", + "pageSize": "MaxResults" + }, + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "VpcPeeringConnectionDeleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "VpcPeeringConnections[].Status.Code", + "expected": "deleted", + "comparator": "allStringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "errorType": "InvalidVpcPeeringConnectionID.NotFound" + } + } + ], + "minDelay": 15 + }, + "VpcPeeringConnectionExists": { + "acceptors": [ + { + "state": "success", + "matcher": { + "success": true + } + }, + { + "state": "retry", + "matcher": { + "errorType": "InvalidVpcPeeringConnectionID.NotFound" + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.ec2#DescribeVpcPeeringConnectionsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeVpcPeeringConnectionsRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "VpcPeeringConnectionIds": { + "target": "com.amazonaws.ec2#VpcPeeringConnectionIdList", + "traits": { + "smithy.api#documentation": "

One or more VPC peering connection IDs.

\n

Default: Describes all your VPC peering connections.

", + "smithy.api#xmlName": "VpcPeeringConnectionId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeVpcPeeringConnectionsMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVpcPeeringConnectionsResult": { + "type": "structure", + "members": { + "VpcPeeringConnections": { + "target": "com.amazonaws.ec2#VpcPeeringConnectionList", + "traits": { + "aws.protocols#ec2QueryName": "VpcPeeringConnectionSet", + "smithy.api#documentation": "

Information about the VPC peering connections.

", + "smithy.api#xmlName": "vpcPeeringConnectionSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVpcs": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVpcsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVpcsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more of your VPCs.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Vpcs", + "pageSize": "MaxResults" + }, + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "VpcAvailable": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Vpcs[].State", + "expected": "available", + "comparator": "allStringEquals" + } + } + } + ], + "minDelay": 15 + }, + "VpcExists": { + "acceptors": [ + { + "state": "success", + "matcher": { + "success": true + } + }, + { + "state": "retry", + "matcher": { + "errorType": "InvalidVpcID.NotFound" + } + } + ], + "minDelay": 1 + } + } + } + }, + "com.amazonaws.ec2#DescribeVpcsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeVpcsRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "VpcIds": { + "target": "com.amazonaws.ec2#VpcIdStringList", + "traits": { + "smithy.api#documentation": "

One or more VPC IDs.

\n

Default: Describes all your VPCs.

", + "smithy.api#xmlName": "VpcId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeVpcsMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVpcsResult": { + "type": "structure", + "members": { + "Vpcs": { + "target": "com.amazonaws.ec2#VpcList", + "traits": { + "aws.protocols#ec2QueryName": "VpcSet", + "smithy.api#documentation": "

Information about one or more VPCs.

", + "smithy.api#xmlName": "vpcSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVpnConnections": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVpnConnectionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVpnConnectionsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more of your VPN connections.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

", + "smithy.waiters#waitable": { + "VpnConnectionAvailable": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "VpnConnections[].State", + "expected": "available", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "VpnConnections[].State", + "expected": "deleting", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "VpnConnections[].State", + "expected": "deleted", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 15 + }, + "VpnConnectionDeleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "VpnConnections[].State", + "expected": "deleted", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "VpnConnections[].State", + "expected": "pending", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.ec2#DescribeVpnConnectionsRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "VpnConnectionIds": { + "target": "com.amazonaws.ec2#VpnConnectionIdStringList", + "traits": { + "smithy.api#documentation": "

One or more VPN connection IDs.

\n

Default: Describes your VPN connections.

", + "smithy.api#xmlName": "VpnConnectionId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeVpnConnections.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVpnConnectionsResult": { + "type": "structure", + "members": { + "VpnConnections": { + "target": "com.amazonaws.ec2#VpnConnectionList", + "traits": { + "aws.protocols#ec2QueryName": "VpnConnectionSet", + "smithy.api#documentation": "

Information about one or more VPN connections.

", + "smithy.api#xmlName": "vpnConnectionSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of DescribeVpnConnections.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeVpnGateways": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeVpnGatewaysRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeVpnGatewaysResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more of your virtual private gateways.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

" + } + }, + "com.amazonaws.ec2#DescribeVpnGatewaysRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "VpnGatewayIds": { + "target": "com.amazonaws.ec2#VpnGatewayIdStringList", + "traits": { + "smithy.api#documentation": "

One or more virtual private gateway IDs.

\n

Default: Describes all your virtual private gateways.

", + "smithy.api#xmlName": "VpnGatewayId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeVpnGateways.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeVpnGatewaysResult": { + "type": "structure", + "members": { + "VpnGateways": { + "target": "com.amazonaws.ec2#VpnGatewayList", + "traits": { + "aws.protocols#ec2QueryName": "VpnGatewaySet", + "smithy.api#documentation": "

Information about one or more virtual private gateways.

", + "smithy.api#xmlName": "vpnGatewaySet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of DescribeVpnGateways.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DestinationFileFormat": { + "type": "enum", + "members": { + "plain_text": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "plain-text" + } + }, + "parquet": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "parquet" + } + } + } + }, + "com.amazonaws.ec2#DestinationOptionsRequest": { + "type": "structure", + "members": { + "FileFormat": { + "target": "com.amazonaws.ec2#DestinationFileFormat", + "traits": { + "smithy.api#documentation": "

The format for the flow log. The default is plain-text.

" + } + }, + "HiveCompatiblePartitions": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3.\n The default is false.

" + } + }, + "PerHourPartition": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to partition the flow log per hour. This reduces the cost and response \n time for queries. The default is false.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the destination options for a flow log.

" + } + }, + "com.amazonaws.ec2#DestinationOptionsResponse": { + "type": "structure", + "members": { + "FileFormat": { + "target": "com.amazonaws.ec2#DestinationFileFormat", + "traits": { + "aws.protocols#ec2QueryName": "FileFormat", + "smithy.api#documentation": "

The format for the flow log.

", + "smithy.api#xmlName": "fileFormat" + } + }, + "HiveCompatiblePartitions": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "HiveCompatiblePartitions", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3.

", + "smithy.api#xmlName": "hiveCompatiblePartitions" + } + }, + "PerHourPartition": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "PerHourPartition", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to partition the flow log per hour.

", + "smithy.api#xmlName": "perHourPartition" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the destination options for a flow log.

" + } + }, + "com.amazonaws.ec2#DetachClassicLinkVpc": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DetachClassicLinkVpcRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DetachClassicLinkVpcResult" + }, + "traits": { + "smithy.api#documentation": "\n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n \n

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.

" + } + }, + "com.amazonaws.ec2#DetachClassicLinkVpcRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance to unlink from the VPC.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "instanceId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC to which the instance is linked.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "vpcId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DetachClassicLinkVpcResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DetachInternetGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DetachInternetGatewayRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Detaches an internet gateway from a VPC, disabling connectivity between the internet\n\t\t\tand the VPC. The VPC must not contain any running instances with Elastic IP addresses or\n\t\t\tpublic IPv4 addresses.

" + } + }, + "com.amazonaws.ec2#DetachInternetGatewayRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "InternetGatewayId": { + "target": "com.amazonaws.ec2#InternetGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "InternetGatewayId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the internet gateway.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "internetGatewayId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "vpcId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DetachNetworkInterface": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DetachNetworkInterfaceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Detaches a network interface from an instance.

" + } + }, + "com.amazonaws.ec2#DetachNetworkInterfaceRequest": { + "type": "structure", + "members": { + "AttachmentId": { + "target": "com.amazonaws.ec2#NetworkInterfaceAttachmentId", + "traits": { + "aws.protocols#ec2QueryName": "AttachmentId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "attachmentId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Force": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Force", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether to force a detachment.

\n \n \n ", + "smithy.api#xmlName": "force" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DetachNetworkInterface.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DetachVerifiedAccessTrustProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DetachVerifiedAccessTrustProviderRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DetachVerifiedAccessTrustProviderResult" + }, + "traits": { + "smithy.api#documentation": "

Detaches the specified Amazon Web Services Verified Access trust provider from the specified Amazon Web Services Verified Access instance.

" + } + }, + "com.amazonaws.ec2#DetachVerifiedAccessTrustProviderRequest": { + "type": "structure", + "members": { + "VerifiedAccessInstanceId": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access instance.

", + "smithy.api#required": {} + } + }, + "VerifiedAccessTrustProviderId": { + "target": "com.amazonaws.ec2#VerifiedAccessTrustProviderId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access trust provider.

", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DetachVerifiedAccessTrustProviderResult": { + "type": "structure", + "members": { + "VerifiedAccessTrustProvider": { + "target": "com.amazonaws.ec2#VerifiedAccessTrustProvider", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessTrustProvider", + "smithy.api#documentation": "

The ID of the Verified Access trust provider.

", + "smithy.api#xmlName": "verifiedAccessTrustProvider" + } + }, + "VerifiedAccessInstance": { + "target": "com.amazonaws.ec2#VerifiedAccessInstance", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessInstance", + "smithy.api#documentation": "

The ID of the Verified Access instance.

", + "smithy.api#xmlName": "verifiedAccessInstance" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DetachVolume": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DetachVolumeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#VolumeAttachment" + }, + "traits": { + "smithy.api#documentation": "

Detaches an EBS volume from an instance. Make sure to unmount any file systems on the\n device within your operating system before detaching the volume. Failure to do so can result\n in the volume becoming stuck in the busy state while detaching. If this happens,\n detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot\n the instance, or all three. If an EBS volume is the root device of an instance, it can't be\n detached while the instance is running. To detach the root volume, stop the instance\n first.

\n

When a volume with an Amazon Web Services Marketplace product code is detached from an instance, the\n product code is no longer associated with the instance.

\n

For more information, see Detach an Amazon EBS volume in the\n Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#DetachVolumeRequest": { + "type": "structure", + "members": { + "Device": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The device name.

" + } + }, + "Force": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Forces detachment if the previous detachment attempt did not occur cleanly (for example,\n logging into an instance, unmounting the volume, and detaching normally). This option can lead\n to data loss or a corrupted file system. Use this option only as a last resort to detach a\n volume from a failed instance. The instance won't have an opportunity to flush file system\n caches or file system metadata. If you use this option, you must perform file system check and\n repair procedures.

" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceIdForResolver", + "traits": { + "smithy.api#documentation": "

The ID of the instance. If you are detaching a Multi-Attach enabled volume, you must specify an instance ID.

" + } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#VolumeIdWithResolver", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the volume.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DetachVpnGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DetachVpnGatewayRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Detaches a virtual private gateway from a VPC. You do this if you're planning to turn\n off the VPC and not use it anymore. You can confirm a virtual private gateway has been\n completely detached from a VPC by describing the virtual private gateway (any\n attachments to the virtual private gateway are also described).

\n

You must wait for the attachment's state to switch to detached before you\n can delete the VPC or attach a different VPC to the virtual private gateway.

" + } + }, + "com.amazonaws.ec2#DetachVpnGatewayRequest": { + "type": "structure", + "members": { + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {} + } + }, + "VpnGatewayId": { + "target": "com.amazonaws.ec2#VpnGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the virtual private gateway.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DetachVpnGateway.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeviceOptions": { + "type": "structure", + "members": { + "TenantId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TenantId", + "smithy.api#documentation": "

The ID of the tenant application with the device-identity provider.

", + "smithy.api#xmlName": "tenantId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the options for an Amazon Web Services Verified Access device-identity based trust provider.

" + } + }, + "com.amazonaws.ec2#DeviceTrustProviderType": { + "type": "enum", + "members": { + "jamf": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "jamf" + } + }, + "crowdstrike": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "crowdstrike" + } + } + } + }, + "com.amazonaws.ec2#DeviceType": { + "type": "enum", + "members": { + "ebs": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ebs" + } + }, + "instance_store": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "instance-store" + } + } + } + }, + "com.amazonaws.ec2#DhcpConfiguration": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Key", + "smithy.api#documentation": "

The name of a DHCP option.

", + "smithy.api#xmlName": "key" + } + }, + "Values": { + "target": "com.amazonaws.ec2#DhcpConfigurationValueList", + "traits": { + "aws.protocols#ec2QueryName": "ValueSet", + "smithy.api#documentation": "

One or more values for the DHCP option.

", + "smithy.api#xmlName": "valueSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a DHCP configuration option.

" + } + }, + "com.amazonaws.ec2#DhcpConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DhcpConfiguration", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DhcpConfigurationValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DhcpOptions": { + "type": "structure", + "members": { + "DhcpConfigurations": { + "target": "com.amazonaws.ec2#DhcpConfigurationList", + "traits": { + "aws.protocols#ec2QueryName": "DhcpConfigurationSet", + "smithy.api#documentation": "

One or more DHCP options in the set.

", + "smithy.api#xmlName": "dhcpConfigurationSet" + } + }, + "DhcpOptionsId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DhcpOptionsId", + "smithy.api#documentation": "

The ID of the set of DHCP options.

", + "smithy.api#xmlName": "dhcpOptionsId" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the DHCP options set.

", + "smithy.api#xmlName": "ownerId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the DHCP options set.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a set of DHCP options.

" + } + }, + "com.amazonaws.ec2#DhcpOptionsId": { + "type": "string" + }, + "com.amazonaws.ec2#DhcpOptionsIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DhcpOptionsId", + "traits": { + "smithy.api#xmlName": "DhcpOptionsId" + } + } + }, + "com.amazonaws.ec2#DhcpOptionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DhcpOptions", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DirectoryServiceAuthentication": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DirectoryId", + "smithy.api#documentation": "

The ID of the Active Directory used for authentication.

", + "smithy.api#xmlName": "directoryId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an Active Directory.

" + } + }, + "com.amazonaws.ec2#DirectoryServiceAuthenticationRequest": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of the Active Directory to be used for authentication.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the Active Directory to be used for client authentication.

" + } + }, + "com.amazonaws.ec2#DisableAddressTransfer": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisableAddressTransferRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisableAddressTransferResult" + }, + "traits": { + "smithy.api#documentation": "

Disables Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon Virtual Private Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#DisableAddressTransferRequest": { + "type": "structure", + "members": { + "AllocationId": { + "target": "com.amazonaws.ec2#AllocationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The allocation ID of an Elastic IP address.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisableAddressTransferResult": { + "type": "structure", + "members": { + "AddressTransfer": { + "target": "com.amazonaws.ec2#AddressTransfer", + "traits": { + "aws.protocols#ec2QueryName": "AddressTransfer", + "smithy.api#documentation": "

An Elastic IP address transfer.

", + "smithy.api#xmlName": "addressTransfer" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisableAwsNetworkPerformanceMetricSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisableAwsNetworkPerformanceMetricSubscriptionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisableAwsNetworkPerformanceMetricSubscriptionResult" + }, + "traits": { + "smithy.api#documentation": "

Disables Infrastructure Performance metric subscriptions.

" + } + }, + "com.amazonaws.ec2#DisableAwsNetworkPerformanceMetricSubscriptionRequest": { + "type": "structure", + "members": { + "Source": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The source Region or Availability Zone that the metric subscription is disabled for. For example, us-east-1.

" + } + }, + "Destination": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The target Region or Availability Zone that the metric subscription is disabled for. For example, eu-north-1.

" + } + }, + "Metric": { + "target": "com.amazonaws.ec2#MetricType", + "traits": { + "smithy.api#documentation": "

The metric used for the disabled subscription.

" + } + }, + "Statistic": { + "target": "com.amazonaws.ec2#StatisticType", + "traits": { + "smithy.api#documentation": "

The statistic used for the disabled subscription.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisableAwsNetworkPerformanceMetricSubscriptionResult": { + "type": "structure", + "members": { + "Output": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Output", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the unsubscribe action was successful.

", + "smithy.api#xmlName": "output" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisableEbsEncryptionByDefault": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisableEbsEncryptionByDefaultRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisableEbsEncryptionByDefaultResult" + }, + "traits": { + "smithy.api#documentation": "

Disables EBS encryption by default for your account in the current Region.

\n

After you disable encryption by default, you can still create encrypted volumes by \n enabling encryption when you create each volume.

\n

Disabling encryption by default does not change the encryption status of your\n existing volumes.

\n

For more information, see Amazon EBS encryption in the\n Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#DisableEbsEncryptionByDefaultRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisableEbsEncryptionByDefaultResult": { + "type": "structure", + "members": { + "EbsEncryptionByDefault": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EbsEncryptionByDefault", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

The updated status of encryption by default.

", + "smithy.api#xmlName": "ebsEncryptionByDefault" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisableFastLaunch": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisableFastLaunchRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisableFastLaunchResult" + }, + "traits": { + "smithy.api#documentation": "

Discontinue faster launching for a Windows AMI, and clean up existing pre-provisioned snapshots. \n\t\t\tWhen you disable faster launching, the AMI uses the standard launch process for each \n\t\t\tinstance. All pre-provisioned snapshots must be removed before you can enable faster launching again.

\n \n

To change these settings, you must own the AMI.

\n " + } + }, + "com.amazonaws.ec2#DisableFastLaunchRequest": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the image for which you’re turning off faster launching, and removing pre-provisioned snapshots.

", + "smithy.api#required": {} + } + }, + "Force": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Forces the image settings to turn off faster launching for your Windows AMI. This parameter overrides \n\t\t\tany errors that are encountered while cleaning up resources in your account.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisableFastLaunchResult": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the image for which faster-launching has been turned off.

", + "smithy.api#xmlName": "imageId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#FastLaunchResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The pre-provisioning resource type that must be cleaned after turning off faster launching \n\t\t\tfor the Windows AMI. Supported values include: snapshot.

", + "smithy.api#xmlName": "resourceType" + } + }, + "SnapshotConfiguration": { + "target": "com.amazonaws.ec2#FastLaunchSnapshotConfigurationResponse", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotConfiguration", + "smithy.api#documentation": "

Parameters that were used for faster launching for the Windows AMI before \n\t\t\tfaster launching was turned off. This informs the clean-up process.

", + "smithy.api#xmlName": "snapshotConfiguration" + } + }, + "LaunchTemplate": { + "target": "com.amazonaws.ec2#FastLaunchLaunchTemplateSpecificationResponse", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplate", + "smithy.api#documentation": "

The launch template that was used to launch Windows instances from pre-provisioned snapshots.

", + "smithy.api#xmlName": "launchTemplate" + } + }, + "MaxParallelLaunches": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MaxParallelLaunches", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of instances that Amazon EC2 can launch at the same time to \n\t\t\tcreate pre-provisioned snapshots for Windows faster launching.

", + "smithy.api#xmlName": "maxParallelLaunches" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The owner of the Windows AMI for which faster launching was turned off.

", + "smithy.api#xmlName": "ownerId" + } + }, + "State": { + "target": "com.amazonaws.ec2#FastLaunchStateCode", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of faster launching for the specified Windows AMI.

", + "smithy.api#xmlName": "state" + } + }, + "StateTransitionReason": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StateTransitionReason", + "smithy.api#documentation": "

The reason that the state changed for faster launching for the Windows AMI.

", + "smithy.api#xmlName": "stateTransitionReason" + } + }, + "StateTransitionTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "StateTransitionTime", + "smithy.api#documentation": "

The time that the state changed for faster launching for the Windows AMI.

", + "smithy.api#xmlName": "stateTransitionTime" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisableFastSnapshotRestoreErrorItem": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the snapshot.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "FastSnapshotRestoreStateErrors": { + "target": "com.amazonaws.ec2#DisableFastSnapshotRestoreStateErrorSet", + "traits": { + "aws.protocols#ec2QueryName": "FastSnapshotRestoreStateErrorSet", + "smithy.api#documentation": "

The errors.

", + "smithy.api#xmlName": "fastSnapshotRestoreStateErrorSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the errors that occurred when disabling fast snapshot restores.

" + } + }, + "com.amazonaws.ec2#DisableFastSnapshotRestoreErrorSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DisableFastSnapshotRestoreErrorItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DisableFastSnapshotRestoreStateError": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The error code.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The error message.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an error that occurred when disabling fast snapshot restores.

" + } + }, + "com.amazonaws.ec2#DisableFastSnapshotRestoreStateErrorItem": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "Error": { + "target": "com.amazonaws.ec2#DisableFastSnapshotRestoreStateError", + "traits": { + "aws.protocols#ec2QueryName": "Error", + "smithy.api#documentation": "

The error.

", + "smithy.api#xmlName": "error" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an error that occurred when disabling fast snapshot restores.

" + } + }, + "com.amazonaws.ec2#DisableFastSnapshotRestoreStateErrorSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DisableFastSnapshotRestoreStateErrorItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DisableFastSnapshotRestoreSuccessItem": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the snapshot.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "State": { + "target": "com.amazonaws.ec2#FastSnapshotRestoreStateCode", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of fast snapshot restores for the snapshot.

", + "smithy.api#xmlName": "state" + } + }, + "StateTransitionReason": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StateTransitionReason", + "smithy.api#documentation": "

The reason for the state transition. The possible values are as follows:

\n ", + "smithy.api#xmlName": "stateTransitionReason" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that enabled fast snapshot restores on the snapshot.

", + "smithy.api#xmlName": "ownerId" + } + }, + "OwnerAlias": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerAlias", + "smithy.api#documentation": "

The Amazon Web Services owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.

", + "smithy.api#xmlName": "ownerAlias" + } + }, + "EnablingTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "EnablingTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the enabling state.

", + "smithy.api#xmlName": "enablingTime" + } + }, + "OptimizingTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "OptimizingTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the optimizing state.

", + "smithy.api#xmlName": "optimizingTime" + } + }, + "EnabledTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "EnabledTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the enabled state.

", + "smithy.api#xmlName": "enabledTime" + } + }, + "DisablingTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "DisablingTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the disabling state.

", + "smithy.api#xmlName": "disablingTime" + } + }, + "DisabledTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "DisabledTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the disabled state.

", + "smithy.api#xmlName": "disabledTime" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes fast snapshot restores that were successfully disabled.

" + } + }, + "com.amazonaws.ec2#DisableFastSnapshotRestoreSuccessSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DisableFastSnapshotRestoreSuccessItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DisableFastSnapshotRestores": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisableFastSnapshotRestoresRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisableFastSnapshotRestoresResult" + }, + "traits": { + "smithy.api#documentation": "

Disables fast snapshot restores for the specified snapshots in the specified Availability Zones.

" + } + }, + "com.amazonaws.ec2#DisableFastSnapshotRestoresRequest": { + "type": "structure", + "members": { + "AvailabilityZones": { + "target": "com.amazonaws.ec2#AvailabilityZoneStringList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

One or more Availability Zones. For example, us-east-2a.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "AvailabilityZone" + } + }, + "SourceSnapshotIds": { + "target": "com.amazonaws.ec2#SnapshotIdStringList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of one or more snapshots. For example, snap-1234567890abcdef0.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "SourceSnapshotId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisableFastSnapshotRestoresResult": { + "type": "structure", + "members": { + "Successful": { + "target": "com.amazonaws.ec2#DisableFastSnapshotRestoreSuccessSet", + "traits": { + "aws.protocols#ec2QueryName": "Successful", + "smithy.api#documentation": "

Information about the snapshots for which fast snapshot restores were successfully disabled.

", + "smithy.api#xmlName": "successful" + } + }, + "Unsuccessful": { + "target": "com.amazonaws.ec2#DisableFastSnapshotRestoreErrorSet", + "traits": { + "aws.protocols#ec2QueryName": "Unsuccessful", + "smithy.api#documentation": "

Information about the snapshots for which fast snapshot restores could not be disabled.

", + "smithy.api#xmlName": "unsuccessful" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisableImageDeprecation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisableImageDeprecationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisableImageDeprecationResult" + }, + "traits": { + "smithy.api#documentation": "

Cancels the deprecation of the specified AMI.

\n

For more information, see Deprecate an AMI in the\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#DisableImageDeprecationRequest": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisableImageDeprecationResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisableIpamOrganizationAdminAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisableIpamOrganizationAdminAccountRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisableIpamOrganizationAdminAccountResult" + }, + "traits": { + "smithy.api#documentation": "

Disable the IPAM account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide.\n

" + } + }, + "com.amazonaws.ec2#DisableIpamOrganizationAdminAccountRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "DelegatedAdminAccountId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Organizations member account ID that you want to disable as IPAM account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisableIpamOrganizationAdminAccountResult": { + "type": "structure", + "members": { + "Success": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Success", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

The result of disabling the IPAM account.

", + "smithy.api#xmlName": "success" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisableSerialConsoleAccess": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisableSerialConsoleAccessRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisableSerialConsoleAccessResult" + }, + "traits": { + "smithy.api#documentation": "

Disables access to the EC2 serial console of all instances for your account. By default,\n\t\t\taccess to the EC2 serial console is disabled for your account. For more information, see\n\t\t\t\tManage account access to the EC2 serial console in the Amazon EC2\n\t\t\t\tUser Guide.

" + } + }, + "com.amazonaws.ec2#DisableSerialConsoleAccessRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisableSerialConsoleAccessResult": { + "type": "structure", + "members": { + "SerialConsoleAccessEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "SerialConsoleAccessEnabled", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

If true, access to the EC2 serial console of all instances is enabled for\n\t\t\tyour account. If false, access to the EC2 serial console of all instances\n\t\t\tis disabled for your account.

", + "smithy.api#xmlName": "serialConsoleAccessEnabled" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisableTransitGatewayRouteTablePropagation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisableTransitGatewayRouteTablePropagationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisableTransitGatewayRouteTablePropagationResult" + }, + "traits": { + "smithy.api#documentation": "

Disables the specified resource attachment from propagating routes to the specified\n propagation route table.

" + } + }, + "com.amazonaws.ec2#DisableTransitGatewayRouteTablePropagationRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the propagation route table.

", + "smithy.api#required": {} + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#documentation": "

The ID of the attachment.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "TransitGatewayRouteTableAnnouncementId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementId", + "traits": { + "smithy.api#documentation": "

The ID of the route table announcement.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisableTransitGatewayRouteTablePropagationResult": { + "type": "structure", + "members": { + "Propagation": { + "target": "com.amazonaws.ec2#TransitGatewayPropagation", + "traits": { + "aws.protocols#ec2QueryName": "Propagation", + "smithy.api#documentation": "

Information about route propagation.

", + "smithy.api#xmlName": "propagation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisableVgwRoutePropagation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisableVgwRoutePropagationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Disables a virtual private gateway (VGW) from propagating routes to a specified route\n table of a VPC.

" + } + }, + "com.amazonaws.ec2#DisableVgwRoutePropagationRequest": { + "type": "structure", + "members": { + "GatewayId": { + "target": "com.amazonaws.ec2#VpnGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the virtual private gateway.

", + "smithy.api#required": {} + } + }, + "RouteTableId": { + "target": "com.amazonaws.ec2#RouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the route table.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DisableVgwRoutePropagation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisableVpcClassicLink": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisableVpcClassicLinkRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisableVpcClassicLinkResult" + }, + "traits": { + "smithy.api#documentation": "

Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " + } + }, + "com.amazonaws.ec2#DisableVpcClassicLinkDnsSupport": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisableVpcClassicLinkDnsSupportRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisableVpcClassicLinkDnsSupportResult" + }, + "traits": { + "smithy.api#documentation": "

Disables ClassicLink DNS support for a VPC. If disabled, DNS hostnames resolve to\n\t\t\tpublic IP addresses when addressed between a linked EC2-Classic instance and instances\n\t\t\tin the VPC to which it's linked. For more information, see ClassicLink in the\n\t\t\t\tAmazon Elastic Compute Cloud User Guide.

\n

You must specify a VPC ID in the request.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " + } + }, + "com.amazonaws.ec2#DisableVpcClassicLinkDnsSupportRequest": { + "type": "structure", + "members": { + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "VpcId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisableVpcClassicLinkDnsSupportResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisableVpcClassicLinkRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "vpcId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisableVpcClassicLinkResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisassociateAddress": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisassociateAddressRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Disassociates an Elastic IP address from the instance or network interface it's associated with.

\n

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

" + } + }, + "com.amazonaws.ec2#DisassociateAddressRequest": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.ec2#ElasticIpAssociationId", + "traits": { + "smithy.api#documentation": "

The association ID. This parameter is required.

" + } + }, + "PublicIp": { + "target": "com.amazonaws.ec2#EipAllocationPublicIp", + "traits": { + "smithy.api#documentation": "

Deprecated.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisassociateClientVpnTargetNetwork": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisassociateClientVpnTargetNetworkRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisassociateClientVpnTargetNetworkResult" + }, + "traits": { + "smithy.api#documentation": "

Disassociates a target network from the specified Client VPN endpoint. When you disassociate the \n\t\t\tlast target network from a Client VPN, the following happens:

\n " + } + }, + "com.amazonaws.ec2#DisassociateClientVpnTargetNetworkRequest": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Client VPN endpoint from which to disassociate the target network.

", + "smithy.api#required": {} + } + }, + "AssociationId": { + "target": "com.amazonaws.ec2#ClientVpnAssociationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the target network association.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisassociateClientVpnTargetNetworkResult": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#documentation": "

The ID of the target network association.

", + "smithy.api#xmlName": "associationId" + } + }, + "Status": { + "target": "com.amazonaws.ec2#AssociationStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The current state of the target network association.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisassociateEnclaveCertificateIamRole": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisassociateEnclaveCertificateIamRoleRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisassociateEnclaveCertificateIamRoleResult" + }, + "traits": { + "smithy.api#documentation": "

Disassociates an IAM role from an Certificate Manager (ACM) certificate. Disassociating an IAM role \n\t\t\tfrom an ACM certificate removes the Amazon S3 object that contains the certificate, certificate chain, and \n\t\t\tencrypted private key from the Amazon S3 bucket. It also revokes the IAM role's permission to use the\n\t\t\tKMS key used to encrypt the private key. This effectively revokes the role's permission \n\t\t\tto use the certificate.

" + } + }, + "com.amazonaws.ec2#DisassociateEnclaveCertificateIamRoleRequest": { + "type": "structure", + "members": { + "CertificateArn": { + "target": "com.amazonaws.ec2#CertificateId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the ACM certificate from which to disassociate the IAM role.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.ec2#RoleId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the IAM role to disassociate.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisassociateEnclaveCertificateIamRoleResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisassociateIamInstanceProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisassociateIamInstanceProfileRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisassociateIamInstanceProfileResult" + }, + "traits": { + "smithy.api#documentation": "

Disassociates an IAM instance profile from a running or stopped instance.

\n

Use DescribeIamInstanceProfileAssociations to get the association\n ID.

" + } + }, + "com.amazonaws.ec2#DisassociateIamInstanceProfileRequest": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.ec2#IamInstanceProfileAssociationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the IAM instance profile association.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisassociateIamInstanceProfileResult": { + "type": "structure", + "members": { + "IamInstanceProfileAssociation": { + "target": "com.amazonaws.ec2#IamInstanceProfileAssociation", + "traits": { + "aws.protocols#ec2QueryName": "IamInstanceProfileAssociation", + "smithy.api#documentation": "

Information about the IAM instance profile association.

", + "smithy.api#xmlName": "iamInstanceProfileAssociation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisassociateInstanceEventWindow": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisassociateInstanceEventWindowRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisassociateInstanceEventWindowResult" + }, + "traits": { + "smithy.api#documentation": "

Disassociates one or more targets from an event window.

\n

For more information, see Define event windows for scheduled\n events in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#DisassociateInstanceEventWindowRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "InstanceEventWindowId": { + "target": "com.amazonaws.ec2#InstanceEventWindowId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the event window.

", + "smithy.api#required": {} + } + }, + "AssociationTarget": { + "target": "com.amazonaws.ec2#InstanceEventWindowDisassociationRequest", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

One or more targets to disassociate from the specified event window.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisassociateInstanceEventWindowResult": { + "type": "structure", + "members": { + "InstanceEventWindow": { + "target": "com.amazonaws.ec2#InstanceEventWindow", + "traits": { + "aws.protocols#ec2QueryName": "InstanceEventWindow", + "smithy.api#documentation": "

Information about the event window.

", + "smithy.api#xmlName": "instanceEventWindow" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisassociateIpamResourceDiscovery": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisassociateIpamResourceDiscoveryRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisassociateIpamResourceDiscoveryResult" + }, + "traits": { + "smithy.api#documentation": "

Disassociates a resource discovery from an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

" + } + }, + "com.amazonaws.ec2#DisassociateIpamResourceDiscoveryRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamResourceDiscoveryAssociationId": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryAssociationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A resource discovery association ID.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisassociateIpamResourceDiscoveryResult": { + "type": "structure", + "members": { + "IpamResourceDiscoveryAssociation": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryAssociation", + "traits": { + "aws.protocols#ec2QueryName": "IpamResourceDiscoveryAssociation", + "smithy.api#documentation": "

A resource discovery association.

", + "smithy.api#xmlName": "ipamResourceDiscoveryAssociation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisassociateNatGatewayAddress": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisassociateNatGatewayAddressRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisassociateNatGatewayAddressResult" + }, + "traits": { + "smithy.api#documentation": "

Disassociates secondary Elastic IP addresses (EIPs) from a public NAT gateway. You cannot disassociate your primary EIP. For more information, see Edit secondary IP address associations in the Amazon Virtual Private Cloud User Guide.

\n

While disassociating is in progress, you cannot associate/disassociate additional EIPs while the connections are being drained. You are, however, allowed to delete the NAT gateway.

\n

An EIP will only be released at the end of MaxDrainDurationSeconds. The EIPs stay\n associated and support the existing connections but do not support any new connections\n (new connections are distributed across the remaining associated EIPs). As the existing\n connections drain out, the EIPs (and the corresponding private IPs mapped to them) get\n released.

" + } + }, + "com.amazonaws.ec2#DisassociateNatGatewayAddressRequest": { + "type": "structure", + "members": { + "NatGatewayId": { + "target": "com.amazonaws.ec2#NatGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The NAT gateway ID.

", + "smithy.api#required": {} + } + }, + "AssociationIds": { + "target": "com.amazonaws.ec2#EipAssociationIdList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The association IDs of EIPs that have been associated with the NAT gateway.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "AssociationId" + } + }, + "MaxDrainDurationSeconds": { + "target": "com.amazonaws.ec2#DrainSeconds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisassociateNatGatewayAddressResult": { + "type": "structure", + "members": { + "NatGatewayId": { + "target": "com.amazonaws.ec2#NatGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "NatGatewayId", + "smithy.api#documentation": "

The NAT gateway ID.

", + "smithy.api#xmlName": "natGatewayId" + } + }, + "NatGatewayAddresses": { + "target": "com.amazonaws.ec2#NatGatewayAddressList", + "traits": { + "aws.protocols#ec2QueryName": "NatGatewayAddressSet", + "smithy.api#documentation": "

Information about the NAT gateway IP addresses.

", + "smithy.api#xmlName": "natGatewayAddressSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisassociateRouteTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisassociateRouteTableRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Disassociates a subnet or gateway from a route table.

\n

After you perform this action, the subnet no longer uses the routes in the route table.\n\t\t\t\tInstead, it uses the routes in the VPC's main route table. For more information\n\t\t\t\tabout route tables, see Route\n\t\t\t\ttables in the Amazon Virtual Private Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#DisassociateRouteTableRequest": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.ec2#RouteTableAssociationId", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The association ID representing the current association between the route table and subnet or gateway.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "associationId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisassociateSubnetCidrBlock": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisassociateSubnetCidrBlockRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisassociateSubnetCidrBlockResult" + }, + "traits": { + "smithy.api#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.

" + } + }, + "com.amazonaws.ec2#DisassociateSubnetCidrBlockRequest": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.ec2#SubnetCidrAssociationId", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The association ID for the CIDR block.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "associationId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisassociateSubnetCidrBlockResult": { + "type": "structure", + "members": { + "Ipv6CidrBlockAssociation": { + "target": "com.amazonaws.ec2#SubnetIpv6CidrBlockAssociation", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrBlockAssociation", + "smithy.api#documentation": "

Information about the IPv6 CIDR block association.

", + "smithy.api#xmlName": "ipv6CidrBlockAssociation" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet.

", + "smithy.api#xmlName": "subnetId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisassociateTransitGatewayMulticastDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisassociateTransitGatewayMulticastDomainRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisassociateTransitGatewayMulticastDomainResult" + }, + "traits": { + "smithy.api#documentation": "

Disassociates the specified subnets from the transit gateway multicast domain.

" + } + }, + "com.amazonaws.ec2#DisassociateTransitGatewayMulticastDomainRequest": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", + "smithy.api#required": {} + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#required": {} + } + }, + "SubnetIds": { + "target": "com.amazonaws.ec2#TransitGatewaySubnetIdList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the subnets;

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisassociateTransitGatewayMulticastDomainResult": { + "type": "structure", + "members": { + "Associations": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainAssociations", + "traits": { + "aws.protocols#ec2QueryName": "Associations", + "smithy.api#documentation": "

Information about the association.

", + "smithy.api#xmlName": "associations" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisassociateTransitGatewayPolicyTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisassociateTransitGatewayPolicyTableRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisassociateTransitGatewayPolicyTableResult" + }, + "traits": { + "smithy.api#documentation": "

Removes the association between an an attachment and a policy table.

" + } + }, + "com.amazonaws.ec2#DisassociateTransitGatewayPolicyTableRequest": { + "type": "structure", + "members": { + "TransitGatewayPolicyTableId": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the disassociated policy table.

", + "smithy.api#required": {} + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway attachment to disassociate from the policy table.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisassociateTransitGatewayPolicyTableResult": { + "type": "structure", + "members": { + "Association": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableAssociation", + "traits": { + "aws.protocols#ec2QueryName": "Association", + "smithy.api#documentation": "

Returns details about the transit gateway policy table disassociation.

", + "smithy.api#xmlName": "association" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisassociateTransitGatewayRouteTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisassociateTransitGatewayRouteTableRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisassociateTransitGatewayRouteTableResult" + }, + "traits": { + "smithy.api#documentation": "

Disassociates a resource attachment from a transit gateway route table.

" + } + }, + "com.amazonaws.ec2#DisassociateTransitGatewayRouteTableRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#required": {} + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisassociateTransitGatewayRouteTableResult": { + "type": "structure", + "members": { + "Association": { + "target": "com.amazonaws.ec2#TransitGatewayAssociation", + "traits": { + "aws.protocols#ec2QueryName": "Association", + "smithy.api#documentation": "

Information about the association.

", + "smithy.api#xmlName": "association" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisassociateTrunkInterface": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisassociateTrunkInterfaceRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisassociateTrunkInterfaceResult" + }, + "traits": { + "smithy.api#documentation": "\n

This API action is currently in limited preview only. \n If you are interested in using this feature, contact your account manager.

\n \n

Removes an association between a branch network interface with a trunk network interface.

" + } + }, + "com.amazonaws.ec2#DisassociateTrunkInterfaceRequest": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.ec2#TrunkInterfaceAssociationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the association

", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to Ensure\n Idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisassociateTrunkInterfaceResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to Ensure\n Idempotency.

", + "smithy.api#xmlName": "clientToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisassociateVpcCidrBlock": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisassociateVpcCidrBlockRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisassociateVpcCidrBlockResult" + }, + "traits": { + "smithy.api#documentation": "

Disassociates a CIDR block from a VPC. To disassociate the CIDR block, you must\n specify its association ID. You can get the association ID by using\n DescribeVpcs. You must detach or delete all gateways and resources that\n are associated with the CIDR block before you can disassociate it.

\n

You cannot disassociate the CIDR block with which you originally created the VPC (the\n\t\t\tprimary CIDR block).

" + } + }, + "com.amazonaws.ec2#DisassociateVpcCidrBlockRequest": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.ec2#VpcCidrAssociationId", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The association ID for the CIDR block.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "associationId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisassociateVpcCidrBlockResult": { + "type": "structure", + "members": { + "Ipv6CidrBlockAssociation": { + "target": "com.amazonaws.ec2#VpcIpv6CidrBlockAssociation", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrBlockAssociation", + "smithy.api#documentation": "

Information about the IPv6 CIDR block association.

", + "smithy.api#xmlName": "ipv6CidrBlockAssociation" + } + }, + "CidrBlockAssociation": { + "target": "com.amazonaws.ec2#VpcCidrBlockAssociation", + "traits": { + "aws.protocols#ec2QueryName": "CidrBlockAssociation", + "smithy.api#documentation": "

Information about the IPv4 CIDR block association.

", + "smithy.api#xmlName": "cidrBlockAssociation" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DiskCount": { + "type": "integer" + }, + "com.amazonaws.ec2#DiskImage": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description of the disk image.

" + } + }, + "Image": { + "target": "com.amazonaws.ec2#DiskImageDetail", + "traits": { + "smithy.api#documentation": "

Information about the disk image.

" + } + }, + "Volume": { + "target": "com.amazonaws.ec2#VolumeDetail", + "traits": { + "smithy.api#documentation": "

Information about the volume.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a disk image.

" + } + }, + "com.amazonaws.ec2#DiskImageDescription": { + "type": "structure", + "members": { + "Checksum": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Checksum", + "smithy.api#documentation": "

The checksum computed for the disk image.

", + "smithy.api#xmlName": "checksum" + } + }, + "Format": { + "target": "com.amazonaws.ec2#DiskImageFormat", + "traits": { + "aws.protocols#ec2QueryName": "Format", + "smithy.api#documentation": "

The disk image format.

", + "smithy.api#xmlName": "format" + } + }, + "ImportManifestUrl": { + "target": "com.amazonaws.ec2#ImportManifestUrl", + "traits": { + "aws.protocols#ec2QueryName": "ImportManifestUrl", + "smithy.api#documentation": "

A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for\n an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in\n the Amazon Simple Storage Service Developer Guide.

\n

For information about the import manifest referenced by this API action, see VM Import Manifest.

", + "smithy.api#xmlName": "importManifestUrl" + } + }, + "Size": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "Size", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The size of the disk image, in GiB.

", + "smithy.api#xmlName": "size" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a disk image.

" + } + }, + "com.amazonaws.ec2#DiskImageDetail": { + "type": "structure", + "members": { + "Bytes": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "Bytes", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The size of the disk image, in GiB.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "bytes" + } + }, + "Format": { + "target": "com.amazonaws.ec2#DiskImageFormat", + "traits": { + "aws.protocols#ec2QueryName": "Format", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The disk image format.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "format" + } + }, + "ImportManifestUrl": { + "target": "com.amazonaws.ec2#ImportManifestUrl", + "traits": { + "aws.protocols#ec2QueryName": "ImportManifestUrl", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL.\n For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication\n Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer\n Guide.

\n

For information about the import manifest referenced by this API action, see VM Import Manifest.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "importManifestUrl" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a disk image.

" + } + }, + "com.amazonaws.ec2#DiskImageFormat": { + "type": "enum", + "members": { + "VMDK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VMDK" + } + }, + "RAW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RAW" + } + }, + "VHD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VHD" + } + } + } + }, + "com.amazonaws.ec2#DiskImageList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DiskImage" + } + }, + "com.amazonaws.ec2#DiskImageVolumeDescription": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Id", + "smithy.api#documentation": "

The volume identifier.

", + "smithy.api#xmlName": "id" + } + }, + "Size": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "Size", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The size of the volume, in GiB.

", + "smithy.api#xmlName": "size" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a disk image volume.

" + } + }, + "com.amazonaws.ec2#DiskInfo": { + "type": "structure", + "members": { + "SizeInGB": { + "target": "com.amazonaws.ec2#DiskSize", + "traits": { + "aws.protocols#ec2QueryName": "SizeInGB", + "smithy.api#documentation": "

The size of the disk in GB.

", + "smithy.api#xmlName": "sizeInGB" + } + }, + "Count": { + "target": "com.amazonaws.ec2#DiskCount", + "traits": { + "aws.protocols#ec2QueryName": "Count", + "smithy.api#documentation": "

The number of disks with this configuration.

", + "smithy.api#xmlName": "count" + } + }, + "Type": { + "target": "com.amazonaws.ec2#DiskType", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The type of disk.

", + "smithy.api#xmlName": "type" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a disk.

" + } + }, + "com.amazonaws.ec2#DiskInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DiskInfo", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DiskSize": { + "type": "long" + }, + "com.amazonaws.ec2#DiskType": { + "type": "enum", + "members": { + "hdd": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hdd" + } + }, + "ssd": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ssd" + } + } + } + }, + "com.amazonaws.ec2#DnsEntry": { + "type": "structure", + "members": { + "DnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DnsName", + "smithy.api#documentation": "

The DNS name.

", + "smithy.api#xmlName": "dnsName" + } + }, + "HostedZoneId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "HostedZoneId", + "smithy.api#documentation": "

The ID of the private hosted zone.

", + "smithy.api#xmlName": "hostedZoneId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a DNS entry.

" + } + }, + "com.amazonaws.ec2#DnsEntrySet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DnsEntry", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#DnsNameState": { + "type": "enum", + "members": { + "PendingVerification": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pendingVerification" + } + }, + "Verified": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "verified" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + } + } + }, + "com.amazonaws.ec2#DnsOptions": { + "type": "structure", + "members": { + "DnsRecordIpType": { + "target": "com.amazonaws.ec2#DnsRecordIpType", + "traits": { + "aws.protocols#ec2QueryName": "DnsRecordIpType", + "smithy.api#documentation": "

The DNS records created for the endpoint.

", + "smithy.api#xmlName": "dnsRecordIpType" + } + }, + "PrivateDnsOnlyForInboundResolverEndpoint": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDnsOnlyForInboundResolverEndpoint", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to enable private DNS only for inbound endpoints.

", + "smithy.api#xmlName": "privateDnsOnlyForInboundResolverEndpoint" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the DNS options for an endpoint.

" + } + }, + "com.amazonaws.ec2#DnsOptionsSpecification": { + "type": "structure", + "members": { + "DnsRecordIpType": { + "target": "com.amazonaws.ec2#DnsRecordIpType", + "traits": { + "smithy.api#documentation": "

The DNS records created for the endpoint.

" + } + }, + "PrivateDnsOnlyForInboundResolverEndpoint": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to enable private DNS only for inbound endpoints. This option is\n available only for services that support both gateway and interface endpoints. It routes\n traffic that originates from the VPC to the gateway endpoint and traffic that originates\n from on-premises to the interface endpoint.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the DNS options for an endpoint.

" + } + }, + "com.amazonaws.ec2#DnsRecordIpType": { + "type": "enum", + "members": { + "ipv4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv4" + } + }, + "dualstack": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dualstack" + } + }, + "ipv6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv6" + } + }, + "service_defined": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "service-defined" + } + } + } + }, + "com.amazonaws.ec2#DnsServersOptionsModifyStructure": { + "type": "structure", + "members": { + "CustomDnsServers": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, of the DNS servers to be used. You can specify up to \n\t\t\ttwo DNS servers. Ensure that the DNS servers can be reached by the clients. The specified values \n\t\t\toverwrite the existing values.

" + } + }, + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether DNS servers should be used. Specify False to delete the existing DNS \n\t\t\tservers.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the DNS server to be used.

" + } + }, + "com.amazonaws.ec2#DnsSupportValue": { + "type": "enum", + "members": { + "enable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enable" + } + }, + "disable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disable" + } + } + } + }, + "com.amazonaws.ec2#DomainType": { + "type": "enum", + "members": { + "vpc": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc" + } + }, + "standard": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "standard" + } + } + } + }, + "com.amazonaws.ec2#Double": { + "type": "double", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.ec2#DoubleWithConstraints": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": 0.001, + "max": 99.999 + } + } + }, + "com.amazonaws.ec2#DrainSeconds": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 4000 + } + } + }, + "com.amazonaws.ec2#DynamicRoutingValue": { + "type": "enum", + "members": { + "enable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enable" + } + }, + "disable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disable" + } + } + } + }, + "com.amazonaws.ec2#EbsBlockDevice": { + "type": "structure", + "members": { + "DeleteOnTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DeleteOnTermination", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the EBS volume is deleted on instance termination. For more\n information, see Preserving Amazon EBS volumes on instance termination in the\n Amazon EC2 User Guide.

", + "smithy.api#xmlName": "deleteOnTermination" + } + }, + "Iops": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Iops", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes,\n this represents the number of IOPS that are provisioned for the volume. For gp2\n volumes, this represents the baseline performance of the volume and the rate at which\n the volume accumulates I/O credits for bursting.

\n

The following are the supported values for each volume type:

\n \n

For io1 and io2 volumes, we guarantee 64,000 IOPS only for\n Instances built on the\n Nitro System. Other instance families guarantee performance up to\n 32,000 IOPS.

\n

This parameter is required for io1 and io2 volumes. The default for gp3 volumes\n is 3,000 IOPS. This parameter is not supported for gp2, st1, sc1, or standard\n volumes.

", + "smithy.api#xmlName": "iops" + } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the snapshot.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "VolumeSize": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "VolumeSize", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume\n size. If you specify a snapshot, the default is the snapshot size. You can specify a\n volume size that is equal to or larger than the snapshot size.

\n

The following are the supported volumes sizes for each volume type:

\n ", + "smithy.api#xmlName": "volumeSize" + } + }, + "VolumeType": { + "target": "com.amazonaws.ec2#VolumeType", + "traits": { + "aws.protocols#ec2QueryName": "VolumeType", + "smithy.api#documentation": "

The volume type. For more information, see Amazon EBS volume types in the\n Amazon EC2 User Guide. If the volume type is io1 or\n io2, you must specify the IOPS that the volume supports.

", + "smithy.api#xmlName": "volumeType" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KmsKeyId", + "smithy.api#documentation": "

Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under\n which the EBS volume is encrypted.

\n

This parameter is only supported on BlockDeviceMapping objects called by\n RunInstances, RequestSpotFleet,\n and RequestSpotInstances.

", + "smithy.api#xmlName": "kmsKeyId" + } + }, + "Throughput": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Throughput", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The throughput that the volume supports, in MiB/s.

\n

This parameter is valid only for gp3 volumes.

\n

Valid Range: Minimum value of 125. Maximum value of 1000.

", + "smithy.api#xmlName": "throughput" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutpostArn", + "smithy.api#documentation": "

The ARN of the Outpost on which the snapshot is stored.

\n

This parameter is only supported on BlockDeviceMapping objects called by\n \n CreateImage.

", + "smithy.api#xmlName": "outpostArn" + } + }, + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Encrypted", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the encryption state of an EBS volume is changed while being\n restored from a backing snapshot. The effect of setting the encryption state to true depends on \nthe 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 EC2 User Guide.

\n

In no case can you remove encryption from an encrypted volume.

\n

Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For\n more information, see Supported instance types.

\n

This parameter is not returned by DescribeImageAttribute.

\n

For CreateImage and RegisterImage, whether you can \n include this parameter, and the allowed values differ depending on the type of block \n device mapping you are creating.

\n ", + "smithy.api#xmlName": "encrypted" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a block device for an EBS volume.

" + } + }, + "com.amazonaws.ec2#EbsEncryptionSupport": { + "type": "enum", + "members": { + "unsupported": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unsupported" + } + }, + "supported": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "supported" + } + } + } + }, + "com.amazonaws.ec2#EbsInfo": { + "type": "structure", + "members": { + "EbsOptimizedSupport": { + "target": "com.amazonaws.ec2#EbsOptimizedSupport", + "traits": { + "aws.protocols#ec2QueryName": "EbsOptimizedSupport", + "smithy.api#documentation": "

Indicates whether the instance type is Amazon EBS-optimized. For more information, see Amazon EBS-optimized\n instances in Amazon EC2 User Guide.

", + "smithy.api#xmlName": "ebsOptimizedSupport" + } + }, + "EncryptionSupport": { + "target": "com.amazonaws.ec2#EbsEncryptionSupport", + "traits": { + "aws.protocols#ec2QueryName": "EncryptionSupport", + "smithy.api#documentation": "

Indicates whether Amazon EBS encryption is supported.

", + "smithy.api#xmlName": "encryptionSupport" + } + }, + "EbsOptimizedInfo": { + "target": "com.amazonaws.ec2#EbsOptimizedInfo", + "traits": { + "aws.protocols#ec2QueryName": "EbsOptimizedInfo", + "smithy.api#documentation": "

Describes the optimized EBS performance for the instance type.

", + "smithy.api#xmlName": "ebsOptimizedInfo" + } + }, + "NvmeSupport": { + "target": "com.amazonaws.ec2#EbsNvmeSupport", + "traits": { + "aws.protocols#ec2QueryName": "NvmeSupport", + "smithy.api#documentation": "

Indicates whether non-volatile memory express (NVMe) is supported.

", + "smithy.api#xmlName": "nvmeSupport" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the Amazon EBS features supported by the instance type.

" + } + }, + "com.amazonaws.ec2#EbsInstanceBlockDevice": { + "type": "structure", + "members": { + "AttachTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "AttachTime", + "smithy.api#documentation": "

The time stamp when the attachment initiated.

", + "smithy.api#xmlName": "attachTime" + } + }, + "DeleteOnTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DeleteOnTermination", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the volume is deleted on instance termination.

", + "smithy.api#xmlName": "deleteOnTermination" + } + }, + "Status": { + "target": "com.amazonaws.ec2#AttachmentStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The attachment state.

", + "smithy.api#xmlName": "status" + } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VolumeId", + "smithy.api#documentation": "

The ID of the EBS volume.

", + "smithy.api#xmlName": "volumeId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a parameter used to set up an EBS volume in a block device mapping.

" + } + }, + "com.amazonaws.ec2#EbsInstanceBlockDeviceSpecification": { + "type": "structure", + "members": { + "DeleteOnTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DeleteOnTermination", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the volume is deleted on instance termination.

", + "smithy.api#xmlName": "deleteOnTermination" + } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#VolumeId", + "traits": { + "aws.protocols#ec2QueryName": "VolumeId", + "smithy.api#documentation": "

The ID of the EBS volume.

", + "smithy.api#xmlName": "volumeId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes information used to set up an EBS volume specified in a block device\n mapping.

" + } + }, + "com.amazonaws.ec2#EbsNvmeSupport": { + "type": "enum", + "members": { + "UNSUPPORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unsupported" + } + }, + "SUPPORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "supported" + } + }, + "REQUIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "required" + } + } + } + }, + "com.amazonaws.ec2#EbsOptimizedInfo": { + "type": "structure", + "members": { + "BaselineBandwidthInMbps": { + "target": "com.amazonaws.ec2#BaselineBandwidthInMbps", + "traits": { + "aws.protocols#ec2QueryName": "BaselineBandwidthInMbps", + "smithy.api#documentation": "

The baseline bandwidth performance for an EBS-optimized instance type, in Mbps.

", + "smithy.api#xmlName": "baselineBandwidthInMbps" + } + }, + "BaselineThroughputInMBps": { + "target": "com.amazonaws.ec2#BaselineThroughputInMBps", + "traits": { + "aws.protocols#ec2QueryName": "BaselineThroughputInMBps", + "smithy.api#documentation": "

The baseline throughput performance for an EBS-optimized instance type, in MB/s.

", + "smithy.api#xmlName": "baselineThroughputInMBps" + } + }, + "BaselineIops": { + "target": "com.amazonaws.ec2#BaselineIops", + "traits": { + "aws.protocols#ec2QueryName": "BaselineIops", + "smithy.api#documentation": "

The baseline input/output storage operations per seconds for an EBS-optimized instance type.

", + "smithy.api#xmlName": "baselineIops" + } + }, + "MaximumBandwidthInMbps": { + "target": "com.amazonaws.ec2#MaximumBandwidthInMbps", + "traits": { + "aws.protocols#ec2QueryName": "MaximumBandwidthInMbps", + "smithy.api#documentation": "

The maximum bandwidth performance for an EBS-optimized instance type, in Mbps.

", + "smithy.api#xmlName": "maximumBandwidthInMbps" + } + }, + "MaximumThroughputInMBps": { + "target": "com.amazonaws.ec2#MaximumThroughputInMBps", + "traits": { + "aws.protocols#ec2QueryName": "MaximumThroughputInMBps", + "smithy.api#documentation": "

The maximum throughput performance for an EBS-optimized instance type, in MB/s.

", + "smithy.api#xmlName": "maximumThroughputInMBps" + } + }, + "MaximumIops": { + "target": "com.amazonaws.ec2#MaximumIops", + "traits": { + "aws.protocols#ec2QueryName": "MaximumIops", + "smithy.api#documentation": "

The maximum input/output storage operations per second for an EBS-optimized instance type.

", + "smithy.api#xmlName": "maximumIops" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the optimized EBS performance for supported instance types.

" + } + }, + "com.amazonaws.ec2#EbsOptimizedSupport": { + "type": "enum", + "members": { + "unsupported": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unsupported" + } + }, + "supported": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "supported" + } + }, + "default": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "default" + } + } + } + }, + "com.amazonaws.ec2#Ec2InstanceConnectEndpoint": { + "type": "structure", + "members": { + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that created the EC2 Instance Connect Endpoint.

", + "smithy.api#xmlName": "ownerId" + } + }, + "InstanceConnectEndpointId": { + "target": "com.amazonaws.ec2#InstanceConnectEndpointId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceConnectEndpointId", + "smithy.api#documentation": "

The ID of the EC2 Instance Connect Endpoint.

", + "smithy.api#xmlName": "instanceConnectEndpointId" + } + }, + "InstanceConnectEndpointArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "InstanceConnectEndpointArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the EC2 Instance Connect Endpoint.

", + "smithy.api#xmlName": "instanceConnectEndpointArn" + } + }, + "State": { + "target": "com.amazonaws.ec2#Ec2InstanceConnectEndpointState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the EC2 Instance Connect Endpoint.

", + "smithy.api#xmlName": "state" + } + }, + "StateMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StateMessage", + "smithy.api#documentation": "

The message for the current state of the EC2 Instance Connect Endpoint. \n Can include a failure message.

", + "smithy.api#xmlName": "stateMessage" + } + }, + "DnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DnsName", + "smithy.api#documentation": "

The DNS name of the EC2 Instance Connect Endpoint.

", + "smithy.api#xmlName": "dnsName" + } + }, + "FipsDnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "FipsDnsName", + "smithy.api#documentation": "

", + "smithy.api#xmlName": "fipsDnsName" + } + }, + "NetworkInterfaceIds": { + "target": "com.amazonaws.ec2#NetworkInterfaceIdSet", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceIdSet", + "smithy.api#documentation": "

The ID of the elastic network interface that Amazon EC2 automatically created when creating the EC2\n Instance Connect Endpoint.

", + "smithy.api#xmlName": "networkInterfaceIdSet" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC in which the EC2 Instance Connect Endpoint was created.

", + "smithy.api#xmlName": "vpcId" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone of the EC2 Instance Connect Endpoint.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "CreatedAt": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreatedAt", + "smithy.api#documentation": "

The date and time that the EC2 Instance Connect Endpoint was created.

", + "smithy.api#xmlName": "createdAt" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet in which the EC2 Instance Connect Endpoint was created.

", + "smithy.api#xmlName": "subnetId" + } + }, + "PreserveClientIp": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "PreserveClientIp", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether your client's IP address is preserved as the source. The value is true or false.

\n \n

Default: true\n

", + "smithy.api#xmlName": "preserveClientIp" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#SecurityGroupIdSet", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupIdSet", + "smithy.api#documentation": "

The security groups associated with the endpoint. If you didn't specify a security group, \n the default security group for your VPC is associated with the endpoint.

", + "smithy.api#xmlName": "securityGroupIdSet" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the EC2 Instance Connect Endpoint.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

The EC2 Instance Connect Endpoint.

" + } + }, + "com.amazonaws.ec2#Ec2InstanceConnectEndpointState": { + "type": "enum", + "members": { + "create_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-in-progress" + } + }, + "create_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-complete" + } + }, + "create_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-failed" + } + }, + "delete_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-in-progress" + } + }, + "delete_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-complete" + } + }, + "delete_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-failed" + } + } + } + }, + "com.amazonaws.ec2#EfaInfo": { + "type": "structure", + "members": { + "MaximumEfaInterfaces": { + "target": "com.amazonaws.ec2#MaximumEfaInterfaces", + "traits": { + "aws.protocols#ec2QueryName": "MaximumEfaInterfaces", + "smithy.api#documentation": "

The maximum number of Elastic Fabric Adapters for the instance type.

", + "smithy.api#xmlName": "maximumEfaInterfaces" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the Elastic Fabric Adapters for the instance type.

" + } + }, + "com.amazonaws.ec2#EfaSupportedFlag": { + "type": "boolean" + }, + "com.amazonaws.ec2#EgressOnlyInternetGateway": { + "type": "structure", + "members": { + "Attachments": { + "target": "com.amazonaws.ec2#InternetGatewayAttachmentList", + "traits": { + "aws.protocols#ec2QueryName": "AttachmentSet", + "smithy.api#documentation": "

Information about the attachment of the egress-only internet gateway.

", + "smithy.api#xmlName": "attachmentSet" + } + }, + "EgressOnlyInternetGatewayId": { + "target": "com.amazonaws.ec2#EgressOnlyInternetGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "EgressOnlyInternetGatewayId", + "smithy.api#documentation": "

The ID of the egress-only internet gateway.

", + "smithy.api#xmlName": "egressOnlyInternetGatewayId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the egress-only internet gateway.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an egress-only internet gateway.

" + } + }, + "com.amazonaws.ec2#EgressOnlyInternetGatewayId": { + "type": "string" + }, + "com.amazonaws.ec2#EgressOnlyInternetGatewayIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#EgressOnlyInternetGatewayId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#EgressOnlyInternetGatewayList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#EgressOnlyInternetGateway", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#EipAllocationPublicIp": { + "type": "string" + }, + "com.amazonaws.ec2#EipAssociationIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ElasticIpAssociationId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ElasticGpuAssociation": { + "type": "structure", + "members": { + "ElasticGpuId": { + "target": "com.amazonaws.ec2#ElasticGpuId", + "traits": { + "aws.protocols#ec2QueryName": "ElasticGpuId", + "smithy.api#documentation": "

The ID of the Elastic Graphics accelerator.

", + "smithy.api#xmlName": "elasticGpuId" + } + }, + "ElasticGpuAssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ElasticGpuAssociationId", + "smithy.api#documentation": "

The ID of the association.

", + "smithy.api#xmlName": "elasticGpuAssociationId" + } + }, + "ElasticGpuAssociationState": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ElasticGpuAssociationState", + "smithy.api#documentation": "

The state of the association between the instance and the\n Elastic Graphics accelerator.

", + "smithy.api#xmlName": "elasticGpuAssociationState" + } + }, + "ElasticGpuAssociationTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ElasticGpuAssociationTime", + "smithy.api#documentation": "

The time the Elastic Graphics accelerator was associated with the instance.

", + "smithy.api#xmlName": "elasticGpuAssociationTime" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the association between an instance and an Elastic Graphics accelerator.

" + } + }, + "com.amazonaws.ec2#ElasticGpuAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ElasticGpuAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ElasticGpuHealth": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.ec2#ElasticGpuStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The health status.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the status of an Elastic Graphics accelerator.

" + } + }, + "com.amazonaws.ec2#ElasticGpuId": { + "type": "string" + }, + "com.amazonaws.ec2#ElasticGpuIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ElasticGpuId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ElasticGpuSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ElasticGpus", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ElasticGpuSpecification": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of Elastic Graphics accelerator. For more information about the values to specify for\n Type, see Elastic Graphics Basics, specifically the Elastic Graphics accelerator column, in the \n Amazon Elastic Compute Cloud User Guide for Windows Instances.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A specification for an Elastic Graphics accelerator.

" + } + }, + "com.amazonaws.ec2#ElasticGpuSpecificationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ElasticGpuSpecification", + "traits": { + "smithy.api#xmlName": "ElasticGpuSpecification" + } + } + }, + "com.amazonaws.ec2#ElasticGpuSpecificationResponse": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The elastic GPU type.

", + "smithy.api#xmlName": "type" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an elastic GPU.

" + } + }, + "com.amazonaws.ec2#ElasticGpuSpecificationResponseList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ElasticGpuSpecificationResponse", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ElasticGpuSpecifications": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ElasticGpuSpecification", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ElasticGpuState": { + "type": "enum", + "members": { + "Attached": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ATTACHED" + } + } + } + }, + "com.amazonaws.ec2#ElasticGpuStatus": { + "type": "enum", + "members": { + "Ok": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OK" + } + }, + "Impaired": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPAIRED" + } + } + } + }, + "com.amazonaws.ec2#ElasticGpus": { + "type": "structure", + "members": { + "ElasticGpuId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ElasticGpuId", + "smithy.api#documentation": "

The ID of the Elastic Graphics accelerator.

", + "smithy.api#xmlName": "elasticGpuId" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone in the which the Elastic Graphics accelerator resides.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "ElasticGpuType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ElasticGpuType", + "smithy.api#documentation": "

The type of Elastic Graphics accelerator.

", + "smithy.api#xmlName": "elasticGpuType" + } + }, + "ElasticGpuHealth": { + "target": "com.amazonaws.ec2#ElasticGpuHealth", + "traits": { + "aws.protocols#ec2QueryName": "ElasticGpuHealth", + "smithy.api#documentation": "

The status of the Elastic Graphics accelerator.

", + "smithy.api#xmlName": "elasticGpuHealth" + } + }, + "ElasticGpuState": { + "target": "com.amazonaws.ec2#ElasticGpuState", + "traits": { + "aws.protocols#ec2QueryName": "ElasticGpuState", + "smithy.api#documentation": "

The state of the Elastic Graphics accelerator.

", + "smithy.api#xmlName": "elasticGpuState" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance to which the Elastic Graphics accelerator is attached.

", + "smithy.api#xmlName": "instanceId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the Elastic Graphics accelerator.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an Elastic Graphics accelerator.

" + } + }, + "com.amazonaws.ec2#ElasticInferenceAccelerator": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n \tThe type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, eia1.xlarge, eia2.medium, eia2.large, and eia2.xlarge.\n

", + "smithy.api#required": {} + } + }, + "Count": { + "target": "com.amazonaws.ec2#ElasticInferenceAcceleratorCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The number of elastic inference accelerators to attach to the instance. \n

\n

Default: 1

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Describes an elastic inference accelerator. \n

" + } + }, + "com.amazonaws.ec2#ElasticInferenceAcceleratorAssociation": { + "type": "structure", + "members": { + "ElasticInferenceAcceleratorArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ElasticInferenceAcceleratorArn", + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the elastic inference accelerator. \n

", + "smithy.api#xmlName": "elasticInferenceAcceleratorArn" + } + }, + "ElasticInferenceAcceleratorAssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ElasticInferenceAcceleratorAssociationId", + "smithy.api#documentation": "

\n The ID of the association. \n

", + "smithy.api#xmlName": "elasticInferenceAcceleratorAssociationId" + } + }, + "ElasticInferenceAcceleratorAssociationState": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ElasticInferenceAcceleratorAssociationState", + "smithy.api#documentation": "

\n The state of the elastic inference accelerator.\n

", + "smithy.api#xmlName": "elasticInferenceAcceleratorAssociationState" + } + }, + "ElasticInferenceAcceleratorAssociationTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "ElasticInferenceAcceleratorAssociationTime", + "smithy.api#documentation": "

\n The time at which the elastic inference accelerator is associated with an instance.\n

", + "smithy.api#xmlName": "elasticInferenceAcceleratorAssociationTime" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Describes the association between an instance and an elastic inference accelerator. \n

" + } + }, + "com.amazonaws.ec2#ElasticInferenceAcceleratorAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ElasticInferenceAcceleratorAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ElasticInferenceAcceleratorCount": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.ec2#ElasticInferenceAccelerators": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ElasticInferenceAccelerator", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ElasticIpAssociationId": { + "type": "string" + }, + "com.amazonaws.ec2#EnaSrdSpecification": { + "type": "structure", + "members": { + "EnaSrdEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether ENA Express is enabled for the network interface.

" + } + }, + "EnaSrdUdpSpecification": { + "target": "com.amazonaws.ec2#EnaSrdUdpSpecification", + "traits": { + "smithy.api#documentation": "

Configures ENA Express for UDP network traffic.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

ENA Express uses Amazon Web Services Scalable Reliable Datagram (SRD) technology to increase the \n\t\t\tmaximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances. \n\t\t\tWith ENA Express, you can communicate between two EC2 instances in the same subnet within the same \n\t\t\taccount, or in different accounts. Both sending and receiving instances must have ENA Express enabled.

\n

To improve the reliability of network packet delivery, ENA Express reorders network packets on the \n\t\t\treceiving end by default. However, some UDP-based applications are designed to handle network packets \n\t\t\tthat are out of order to reduce the overhead for packet delivery at the network layer. When ENA Express \n\t\t\tis enabled, you can specify whether UDP network traffic uses it.

" + } + }, + "com.amazonaws.ec2#EnaSrdSupported": { + "type": "boolean" + }, + "com.amazonaws.ec2#EnaSrdUdpSpecification": { + "type": "structure", + "members": { + "EnaSrdUdpEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether UDP traffic uses ENA Express. To specify this setting, you must first enable ENA Express.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

ENA Express is compatible with both TCP and UDP transport protocols. When it’s enabled, TCP traffic \n\t\t\tautomatically uses it. However, some UDP-based applications are designed to handle network packets that are \n\t\t\tout of order, without a need for retransmission, such as live video broadcasting or other near-real-time \n\t\t\tapplications. For UDP traffic, you can specify whether to use ENA Express, based on your application \n\t\t\tenvironment needs.

" + } + }, + "com.amazonaws.ec2#EnaSupport": { + "type": "enum", + "members": { + "unsupported": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unsupported" + } + }, + "supported": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "supported" + } + }, + "required": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "required" + } + } + } + }, + "com.amazonaws.ec2#EnableAddressTransfer": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableAddressTransferRequest" + }, + "output": { + "target": "com.amazonaws.ec2#EnableAddressTransferResult" + }, + "traits": { + "smithy.api#documentation": "

Enables Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon Virtual Private Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#EnableAddressTransferRequest": { + "type": "structure", + "members": { + "AllocationId": { + "target": "com.amazonaws.ec2#AllocationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The allocation ID of an Elastic IP address.

", + "smithy.api#required": {} + } + }, + "TransferAccountId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the account that you want to transfer the Elastic IP address to.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#EnableAddressTransferResult": { + "type": "structure", + "members": { + "AddressTransfer": { + "target": "com.amazonaws.ec2#AddressTransfer", + "traits": { + "aws.protocols#ec2QueryName": "AddressTransfer", + "smithy.api#documentation": "

An Elastic IP address transfer.

", + "smithy.api#xmlName": "addressTransfer" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#EnableAwsNetworkPerformanceMetricSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableAwsNetworkPerformanceMetricSubscriptionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#EnableAwsNetworkPerformanceMetricSubscriptionResult" + }, + "traits": { + "smithy.api#documentation": "

Enables Infrastructure Performance subscriptions.

" + } + }, + "com.amazonaws.ec2#EnableAwsNetworkPerformanceMetricSubscriptionRequest": { + "type": "structure", + "members": { + "Source": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The source Region or Availability Zone that the metric subscription is enabled for. For example, us-east-1.

" + } + }, + "Destination": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The target Region or Availability Zone that the metric subscription is enabled for. For example, eu-west-1.

" + } + }, + "Metric": { + "target": "com.amazonaws.ec2#MetricType", + "traits": { + "smithy.api#documentation": "

The metric used for the enabled subscription.

" + } + }, + "Statistic": { + "target": "com.amazonaws.ec2#StatisticType", + "traits": { + "smithy.api#documentation": "

The statistic used for the enabled subscription.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#EnableAwsNetworkPerformanceMetricSubscriptionResult": { + "type": "structure", + "members": { + "Output": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Output", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the subscribe action was successful.

", + "smithy.api#xmlName": "output" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#EnableEbsEncryptionByDefault": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableEbsEncryptionByDefaultRequest" + }, + "output": { + "target": "com.amazonaws.ec2#EnableEbsEncryptionByDefaultResult" + }, + "traits": { + "smithy.api#documentation": "

Enables EBS encryption by default for your account in the current Region.

\n

After you enable encryption by default, the EBS volumes that you create are\n \talways encrypted, either using the default KMS key or the KMS key that you specified\n when you created each volume. For more information, see Amazon EBS encryption in the\n Amazon Elastic Compute Cloud User Guide.

\n

You can specify the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId\n or ResetEbsDefaultKmsKeyId.

\n

Enabling encryption by default has no effect on the encryption status of your \n existing volumes.

\n

After you enable encryption by default, you can no longer launch instances\n using instance types that do not support encryption. For more information, see Supported\n instance types.

" + } + }, + "com.amazonaws.ec2#EnableEbsEncryptionByDefaultRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#EnableEbsEncryptionByDefaultResult": { + "type": "structure", + "members": { + "EbsEncryptionByDefault": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EbsEncryptionByDefault", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

The updated status of encryption by default.

", + "smithy.api#xmlName": "ebsEncryptionByDefault" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#EnableFastLaunch": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableFastLaunchRequest" + }, + "output": { + "target": "com.amazonaws.ec2#EnableFastLaunchResult" + }, + "traits": { + "smithy.api#documentation": "

When you enable faster launching for a Windows AMI, images are pre-provisioned, \n\t\t\tusing snapshots to launch instances up to 65% faster. To create the optimized Windows \n\t\t\timage, Amazon EC2 launches an instance and runs through Sysprep steps, rebooting as required. \n\t\t\tThen it creates a set of reserved snapshots that are used for subsequent launches. The \n\t\t\treserved snapshots are automatically replenished as they are used, depending on your \n\t\t\tsettings for launch frequency.

\n \n

To change these settings, you must own the AMI.

\n " + } + }, + "com.amazonaws.ec2#EnableFastLaunchRequest": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the image for which you’re enabling faster launching.

", + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The type of resource to use for pre-provisioning the Windows AMI for faster launching. \n\t\t\tSupported values include: snapshot, which is the default value.

" + } + }, + "SnapshotConfiguration": { + "target": "com.amazonaws.ec2#FastLaunchSnapshotConfigurationRequest", + "traits": { + "smithy.api#documentation": "

Configuration settings for creating and managing the snapshots that are used for \n\t\t\tpre-provisioning the Windows AMI for faster launching. The associated ResourceType \n\t\t\tmust be snapshot.

" + } + }, + "LaunchTemplate": { + "target": "com.amazonaws.ec2#FastLaunchLaunchTemplateSpecificationRequest", + "traits": { + "smithy.api#documentation": "

The launch template to use when launching Windows instances from pre-provisioned \n\t\t\tsnapshots. Launch template parameters can include either the name or ID of the launch \n\t\t\ttemplate, but not both.

" + } + }, + "MaxParallelLaunches": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of instances that Amazon EC2 can launch at the same time to create \n\t\t\tpre-provisioned snapshots for Windows faster launching. Value must be \n\t\t\t6 or greater.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#EnableFastLaunchResult": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The image ID that identifies the Windows AMI for which faster launching was enabled.

", + "smithy.api#xmlName": "imageId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#FastLaunchResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The type of resource that was defined for pre-provisioning the Windows AMI for faster launching.

", + "smithy.api#xmlName": "resourceType" + } + }, + "SnapshotConfiguration": { + "target": "com.amazonaws.ec2#FastLaunchSnapshotConfigurationResponse", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotConfiguration", + "smithy.api#documentation": "

Settings to create and manage the pre-provisioned snapshots that Amazon EC2 uses for faster \n\t\t\tlaunches from the Windows AMI. This property is returned when the associated \n\t\t\tresourceType is snapshot.

", + "smithy.api#xmlName": "snapshotConfiguration" + } + }, + "LaunchTemplate": { + "target": "com.amazonaws.ec2#FastLaunchLaunchTemplateSpecificationResponse", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplate", + "smithy.api#documentation": "

The launch template that is used when launching Windows instances from pre-provisioned snapshots.

", + "smithy.api#xmlName": "launchTemplate" + } + }, + "MaxParallelLaunches": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MaxParallelLaunches", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of instances that Amazon EC2 can launch at the same time to \n\t\t\tcreate pre-provisioned snapshots for Windows faster launching.

", + "smithy.api#xmlName": "maxParallelLaunches" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The owner ID for the Windows AMI for which faster launching was enabled.

", + "smithy.api#xmlName": "ownerId" + } + }, + "State": { + "target": "com.amazonaws.ec2#FastLaunchStateCode", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of faster launching for the specified Windows AMI.

", + "smithy.api#xmlName": "state" + } + }, + "StateTransitionReason": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StateTransitionReason", + "smithy.api#documentation": "

The reason that the state changed for faster launching for the Windows AMI.

", + "smithy.api#xmlName": "stateTransitionReason" + } + }, + "StateTransitionTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "StateTransitionTime", + "smithy.api#documentation": "

The time that the state changed for faster launching for the Windows AMI.

", + "smithy.api#xmlName": "stateTransitionTime" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#EnableFastSnapshotRestoreErrorItem": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the snapshot.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "FastSnapshotRestoreStateErrors": { + "target": "com.amazonaws.ec2#EnableFastSnapshotRestoreStateErrorSet", + "traits": { + "aws.protocols#ec2QueryName": "FastSnapshotRestoreStateErrorSet", + "smithy.api#documentation": "

The errors.

", + "smithy.api#xmlName": "fastSnapshotRestoreStateErrorSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the errors that occurred when enabling fast snapshot restores.

" + } + }, + "com.amazonaws.ec2#EnableFastSnapshotRestoreErrorSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#EnableFastSnapshotRestoreErrorItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#EnableFastSnapshotRestoreStateError": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The error code.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The error message.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an error that occurred when enabling fast snapshot restores.

" + } + }, + "com.amazonaws.ec2#EnableFastSnapshotRestoreStateErrorItem": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "Error": { + "target": "com.amazonaws.ec2#EnableFastSnapshotRestoreStateError", + "traits": { + "aws.protocols#ec2QueryName": "Error", + "smithy.api#documentation": "

The error.

", + "smithy.api#xmlName": "error" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an error that occurred when enabling fast snapshot restores.

" + } + }, + "com.amazonaws.ec2#EnableFastSnapshotRestoreStateErrorSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#EnableFastSnapshotRestoreStateErrorItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#EnableFastSnapshotRestoreSuccessItem": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the snapshot.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "State": { + "target": "com.amazonaws.ec2#FastSnapshotRestoreStateCode", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of fast snapshot restores.

", + "smithy.api#xmlName": "state" + } + }, + "StateTransitionReason": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StateTransitionReason", + "smithy.api#documentation": "

The reason for the state transition. The possible values are as follows:

\n ", + "smithy.api#xmlName": "stateTransitionReason" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that enabled fast snapshot restores on the snapshot.

", + "smithy.api#xmlName": "ownerId" + } + }, + "OwnerAlias": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerAlias", + "smithy.api#documentation": "

The Amazon Web Services owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.

", + "smithy.api#xmlName": "ownerAlias" + } + }, + "EnablingTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "EnablingTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the enabling state.

", + "smithy.api#xmlName": "enablingTime" + } + }, + "OptimizingTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "OptimizingTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the optimizing state.

", + "smithy.api#xmlName": "optimizingTime" + } + }, + "EnabledTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "EnabledTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the enabled state.

", + "smithy.api#xmlName": "enabledTime" + } + }, + "DisablingTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "DisablingTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the disabling state.

", + "smithy.api#xmlName": "disablingTime" + } + }, + "DisabledTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "DisabledTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the disabled state.

", + "smithy.api#xmlName": "disabledTime" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes fast snapshot restores that were successfully enabled.

" + } + }, + "com.amazonaws.ec2#EnableFastSnapshotRestoreSuccessSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#EnableFastSnapshotRestoreSuccessItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#EnableFastSnapshotRestores": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableFastSnapshotRestoresRequest" + }, + "output": { + "target": "com.amazonaws.ec2#EnableFastSnapshotRestoresResult" + }, + "traits": { + "smithy.api#documentation": "

Enables fast snapshot restores for the specified snapshots in the specified Availability Zones.

\n

You get the full benefit of fast snapshot restores after they enter the enabled state.\n To get the current state of fast snapshot restores, use DescribeFastSnapshotRestores.\n To disable fast snapshot restores, use DisableFastSnapshotRestores.

\n

For more information, see Amazon EBS fast snapshot\n restore in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#EnableFastSnapshotRestoresRequest": { + "type": "structure", + "members": { + "AvailabilityZones": { + "target": "com.amazonaws.ec2#AvailabilityZoneStringList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

One or more Availability Zones. For example, us-east-2a.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "AvailabilityZone" + } + }, + "SourceSnapshotIds": { + "target": "com.amazonaws.ec2#SnapshotIdStringList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of one or more snapshots. For example, snap-1234567890abcdef0. You can specify\n a snapshot that was shared with you from another Amazon Web Services account.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "SourceSnapshotId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#EnableFastSnapshotRestoresResult": { + "type": "structure", + "members": { + "Successful": { + "target": "com.amazonaws.ec2#EnableFastSnapshotRestoreSuccessSet", + "traits": { + "aws.protocols#ec2QueryName": "Successful", + "smithy.api#documentation": "

Information about the snapshots for which fast snapshot restores were successfully enabled.

", + "smithy.api#xmlName": "successful" + } + }, + "Unsuccessful": { + "target": "com.amazonaws.ec2#EnableFastSnapshotRestoreErrorSet", + "traits": { + "aws.protocols#ec2QueryName": "Unsuccessful", + "smithy.api#documentation": "

Information about the snapshots for which fast snapshot restores could not be enabled.

", + "smithy.api#xmlName": "unsuccessful" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#EnableImageDeprecation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableImageDeprecationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#EnableImageDeprecationResult" + }, + "traits": { + "smithy.api#documentation": "

Enables deprecation of the specified AMI at the specified date and time.

\n

For more information, see Deprecate an AMI in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#EnableImageDeprecationRequest": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#required": {} + } + }, + "DeprecateAt": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The date and time to deprecate the AMI, in UTC, in the following format:\n YYYY-MM-DDTHH:MM:SSZ.\n If you specify a value for seconds, Amazon EC2 rounds the seconds to the\n nearest minute.

\n

You can’t specify a date in the past. The upper limit for DeprecateAt is 10\n years from now, except for public AMIs, where the upper limit is 2 years from the creation date.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#EnableImageDeprecationResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#EnableIpamOrganizationAdminAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableIpamOrganizationAdminAccountRequest" + }, + "output": { + "target": "com.amazonaws.ec2#EnableIpamOrganizationAdminAccountResult" + }, + "traits": { + "smithy.api#documentation": "

Enable an Organizations member account as the IPAM admin account. You cannot select the Organizations management account as the IPAM admin account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide.\n

" + } + }, + "com.amazonaws.ec2#EnableIpamOrganizationAdminAccountRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "DelegatedAdminAccountId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Organizations member account ID that you want to enable as the IPAM account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#EnableIpamOrganizationAdminAccountResult": { + "type": "structure", + "members": { + "Success": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Success", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

The result of enabling the IPAM account.

", + "smithy.api#xmlName": "success" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#EnableReachabilityAnalyzerOrganizationSharing": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableReachabilityAnalyzerOrganizationSharingRequest" + }, + "output": { + "target": "com.amazonaws.ec2#EnableReachabilityAnalyzerOrganizationSharingResult" + }, + "traits": { + "smithy.api#documentation": "

Establishes a trust relationship between Reachability Analyzer and Organizations.\n This operation must be performed by the management account for the organization.

\n

After you establish a trust relationship, a user in the management account or \n a delegated administrator account can run a cross-account analysis using resources \n from the member accounts.

" + } + }, + "com.amazonaws.ec2#EnableReachabilityAnalyzerOrganizationSharingRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#EnableReachabilityAnalyzerOrganizationSharingResult": { + "type": "structure", + "members": { + "ReturnValue": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "ReturnValue", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, returns an error.

", + "smithy.api#xmlName": "returnValue" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#EnableSerialConsoleAccess": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableSerialConsoleAccessRequest" + }, + "output": { + "target": "com.amazonaws.ec2#EnableSerialConsoleAccessResult" + }, + "traits": { + "smithy.api#documentation": "

Enables access to the EC2 serial console of all instances for your account. By default,\n\t\t\taccess to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console\n\t\t\tin the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#EnableSerialConsoleAccessRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#EnableSerialConsoleAccessResult": { + "type": "structure", + "members": { + "SerialConsoleAccessEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "SerialConsoleAccessEnabled", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

If true, access to the EC2 serial console of all instances is enabled for\n\t\t\tyour account. If false, access to the EC2 serial console of all instances\n\t\t\tis disabled for your account.

", + "smithy.api#xmlName": "serialConsoleAccessEnabled" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#EnableTransitGatewayRouteTablePropagation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableTransitGatewayRouteTablePropagationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#EnableTransitGatewayRouteTablePropagationResult" + }, + "traits": { + "smithy.api#documentation": "

Enables the specified attachment to propagate routes to the specified\n propagation route table.

" + } + }, + "com.amazonaws.ec2#EnableTransitGatewayRouteTablePropagationRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the propagation route table.

", + "smithy.api#required": {} + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#documentation": "

The ID of the attachment.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "TransitGatewayRouteTableAnnouncementId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementId", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway route table announcement.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#EnableTransitGatewayRouteTablePropagationResult": { + "type": "structure", + "members": { + "Propagation": { + "target": "com.amazonaws.ec2#TransitGatewayPropagation", + "traits": { + "aws.protocols#ec2QueryName": "Propagation", + "smithy.api#documentation": "

Information about route propagation.

", + "smithy.api#xmlName": "propagation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#EnableVgwRoutePropagation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableVgwRoutePropagationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Enables a virtual private gateway (VGW) to propagate routes to the specified route\n table of a VPC.

" + } + }, + "com.amazonaws.ec2#EnableVgwRoutePropagationRequest": { + "type": "structure", + "members": { + "GatewayId": { + "target": "com.amazonaws.ec2#VpnGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the virtual private gateway that is attached to a VPC. The virtual private\n gateway must be attached to the same VPC that the routing tables are associated with.\n

", + "smithy.api#required": {} + } + }, + "RouteTableId": { + "target": "com.amazonaws.ec2#RouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the route table. The routing table must be associated with the same VPC that\n the virtual private gateway is attached to.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for EnableVgwRoutePropagation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#EnableVolumeIO": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableVolumeIORequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Enables I/O operations for a volume that had I/O operations disabled because the data on\n the volume was potentially inconsistent.

" + } + }, + "com.amazonaws.ec2#EnableVolumeIORequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#VolumeId", + "traits": { + "aws.protocols#ec2QueryName": "VolumeId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the volume.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "volumeId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#EnableVpcClassicLink": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableVpcClassicLinkRequest" + }, + "output": { + "target": "com.amazonaws.ec2#EnableVpcClassicLinkResult" + }, + "traits": { + "smithy.api#documentation": "\n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n \n

Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your\n\t\t\tClassicLink-enabled VPC to allow communication over private IP addresses. You cannot\n\t\t\tenable your VPC for ClassicLink if any of your VPC route tables have existing routes for\n\t\t\taddress ranges within the 10.0.0.0/8 IP address range, excluding local\n\t\t\troutes for VPCs in the 10.0.0.0/16 and 10.1.0.0/16 IP address\n\t\t\tranges. For more information, see ClassicLink in the\n\t\t\t\tAmazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#EnableVpcClassicLinkDnsSupport": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableVpcClassicLinkDnsSupportRequest" + }, + "output": { + "target": "com.amazonaws.ec2#EnableVpcClassicLinkDnsSupportResult" + }, + "traits": { + "smithy.api#documentation": "\n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n \n

Enables a VPC to support DNS hostname resolution for ClassicLink. If enabled, the DNS\n\t\t\thostname of a linked EC2-Classic instance resolves to its private IP address when\n\t\t\taddressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname\n\t\t\tof an instance in a VPC resolves to its private IP address when addressed from a linked\n\t\t\tEC2-Classic instance. For more information, see ClassicLink in the\n\t\t\t\tAmazon Elastic Compute Cloud User Guide.

\n

You must specify a VPC ID in the request.

" + } + }, + "com.amazonaws.ec2#EnableVpcClassicLinkDnsSupportRequest": { + "type": "structure", + "members": { + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "VpcId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#EnableVpcClassicLinkDnsSupportResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#EnableVpcClassicLinkRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "vpcId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#EnableVpcClassicLinkResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#EnclaveOptions": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Enabled", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

If this parameter is set to true, the instance is enabled for Amazon Web Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro\n Enclaves.

", + "smithy.api#xmlName": "enabled" + } + } + }, + "traits": { + "smithy.api#documentation": "

Indicates whether the instance is enabled for Amazon Web Services Nitro\n Enclaves.

" + } + }, + "com.amazonaws.ec2#EnclaveOptionsRequest": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to\n true.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For\n more information, see What is Amazon Web Services Nitro\n Enclaves? in the Amazon Web Services Nitro Enclaves User\n Guide.

" + } + }, + "com.amazonaws.ec2#EncryptionInTransitSupported": { + "type": "boolean" + }, + "com.amazonaws.ec2#EndDateType": { + "type": "enum", + "members": { + "unlimited": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unlimited" + } + }, + "limited": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "limited" + } + } + } + }, + "com.amazonaws.ec2#EndpointSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ClientVpnEndpoint", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#EphemeralNvmeSupport": { + "type": "enum", + "members": { + "UNSUPPORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unsupported" + } + }, + "SUPPORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "supported" + } + }, + "REQUIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "required" + } + } + } + }, + "com.amazonaws.ec2#ErrorSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ValidationError", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#EventCode": { + "type": "enum", + "members": { + "instance_reboot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "instance-reboot" + } + }, + "system_reboot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "system-reboot" + } + }, + "system_maintenance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "system-maintenance" + } + }, + "instance_retirement": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "instance-retirement" + } + }, + "instance_stop": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "instance-stop" + } + } + } + }, + "com.amazonaws.ec2#EventInformation": { + "type": "structure", + "members": { + "EventDescription": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "EventDescription", + "smithy.api#documentation": "

The description of the event.

", + "smithy.api#xmlName": "eventDescription" + } + }, + "EventSubType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "EventSubType", + "smithy.api#documentation": "

The event.

\n

\n error events:

\n \n

\n fleetRequestChange events:

\n \n

\n instanceChange events:

\n \n

\n Information events:

\n ", + "smithy.api#xmlName": "eventSubType" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance. This information is available only for\n instanceChange events.

", + "smithy.api#xmlName": "instanceId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an EC2 Fleet or Spot Fleet event.

" + } + }, + "com.amazonaws.ec2#EventType": { + "type": "enum", + "members": { + "INSTANCE_CHANGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "instanceChange" + } + }, + "BATCH_CHANGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fleetRequestChange" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "error" + } + }, + "INFORMATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "information" + } + } + } + }, + "com.amazonaws.ec2#ExcessCapacityTerminationPolicy": { + "type": "enum", + "members": { + "NO_TERMINATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "noTermination" + } + }, + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "default" + } + } + } + }, + "com.amazonaws.ec2#ExcludedInstanceType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\.\\*]+$" + } + }, + "com.amazonaws.ec2#ExcludedInstanceTypeSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ExcludedInstanceType", + "traits": { + "smithy.api#xmlName": "item" + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 400 + } + } + }, + "com.amazonaws.ec2#ExecutableByStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "ExecutableBy" + } + } + }, + "com.amazonaws.ec2#Explanation": { + "type": "structure", + "members": { + "Acl": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "Acl", + "smithy.api#documentation": "

The network ACL.

", + "smithy.api#xmlName": "acl" + } + }, + "AclRule": { + "target": "com.amazonaws.ec2#AnalysisAclRule", + "traits": { + "aws.protocols#ec2QueryName": "AclRule", + "smithy.api#documentation": "

The network ACL rule.

", + "smithy.api#xmlName": "aclRule" + } + }, + "Address": { + "target": "com.amazonaws.ec2#IpAddress", + "traits": { + "aws.protocols#ec2QueryName": "Address", + "smithy.api#documentation": "

The IPv4 address, in CIDR notation.

", + "smithy.api#xmlName": "address" + } + }, + "Addresses": { + "target": "com.amazonaws.ec2#IpAddressList", + "traits": { + "aws.protocols#ec2QueryName": "AddressSet", + "smithy.api#documentation": "

The IPv4 addresses, in CIDR notation.

", + "smithy.api#xmlName": "addressSet" + } + }, + "AttachedTo": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "AttachedTo", + "smithy.api#documentation": "

The resource to which the component is attached.

", + "smithy.api#xmlName": "attachedTo" + } + }, + "AvailabilityZones": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneSet", + "smithy.api#documentation": "

The Availability Zones.

", + "smithy.api#xmlName": "availabilityZoneSet" + } + }, + "Cidrs": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "CidrSet", + "smithy.api#documentation": "

The CIDR ranges.

", + "smithy.api#xmlName": "cidrSet" + } + }, + "Component": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "Component", + "smithy.api#documentation": "

The component.

", + "smithy.api#xmlName": "component" + } + }, + "CustomerGateway": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "CustomerGateway", + "smithy.api#documentation": "

The customer gateway.

", + "smithy.api#xmlName": "customerGateway" + } + }, + "Destination": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "Destination", + "smithy.api#documentation": "

The destination.

", + "smithy.api#xmlName": "destination" + } + }, + "DestinationVpc": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "DestinationVpc", + "smithy.api#documentation": "

The destination VPC.

", + "smithy.api#xmlName": "destinationVpc" + } + }, + "Direction": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Direction", + "smithy.api#documentation": "

The direction. The following are the possible values:

\n ", + "smithy.api#xmlName": "direction" + } + }, + "ExplanationCode": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ExplanationCode", + "smithy.api#documentation": "

The explanation code.

", + "smithy.api#xmlName": "explanationCode" + } + }, + "IngressRouteTable": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "IngressRouteTable", + "smithy.api#documentation": "

The route table.

", + "smithy.api#xmlName": "ingressRouteTable" + } + }, + "InternetGateway": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "InternetGateway", + "smithy.api#documentation": "

The internet gateway.

", + "smithy.api#xmlName": "internetGateway" + } + }, + "LoadBalancerArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "LoadBalancerArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the load balancer.

", + "smithy.api#xmlName": "loadBalancerArn" + } + }, + "ClassicLoadBalancerListener": { + "target": "com.amazonaws.ec2#AnalysisLoadBalancerListener", + "traits": { + "aws.protocols#ec2QueryName": "ClassicLoadBalancerListener", + "smithy.api#documentation": "

The listener for a Classic Load Balancer.

", + "smithy.api#xmlName": "classicLoadBalancerListener" + } + }, + "LoadBalancerListenerPort": { + "target": "com.amazonaws.ec2#Port", + "traits": { + "aws.protocols#ec2QueryName": "LoadBalancerListenerPort", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The listener port of the load balancer.

", + "smithy.api#xmlName": "loadBalancerListenerPort" + } + }, + "LoadBalancerTarget": { + "target": "com.amazonaws.ec2#AnalysisLoadBalancerTarget", + "traits": { + "aws.protocols#ec2QueryName": "LoadBalancerTarget", + "smithy.api#documentation": "

The target.

", + "smithy.api#xmlName": "loadBalancerTarget" + } + }, + "LoadBalancerTargetGroup": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "LoadBalancerTargetGroup", + "smithy.api#documentation": "

The target group.

", + "smithy.api#xmlName": "loadBalancerTargetGroup" + } + }, + "LoadBalancerTargetGroups": { + "target": "com.amazonaws.ec2#AnalysisComponentList", + "traits": { + "aws.protocols#ec2QueryName": "LoadBalancerTargetGroupSet", + "smithy.api#documentation": "

The target groups.

", + "smithy.api#xmlName": "loadBalancerTargetGroupSet" + } + }, + "LoadBalancerTargetPort": { + "target": "com.amazonaws.ec2#Port", + "traits": { + "aws.protocols#ec2QueryName": "LoadBalancerTargetPort", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The target port.

", + "smithy.api#xmlName": "loadBalancerTargetPort" + } + }, + "ElasticLoadBalancerListener": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "ElasticLoadBalancerListener", + "smithy.api#documentation": "

The load balancer listener.

", + "smithy.api#xmlName": "elasticLoadBalancerListener" + } + }, + "MissingComponent": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "MissingComponent", + "smithy.api#documentation": "

The missing component.

", + "smithy.api#xmlName": "missingComponent" + } + }, + "NatGateway": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "NatGateway", + "smithy.api#documentation": "

The NAT gateway.

", + "smithy.api#xmlName": "natGateway" + } + }, + "NetworkInterface": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterface", + "smithy.api#documentation": "

The network interface.

", + "smithy.api#xmlName": "networkInterface" + } + }, + "PacketField": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PacketField", + "smithy.api#documentation": "

The packet field.

", + "smithy.api#xmlName": "packetField" + } + }, + "VpcPeeringConnection": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "VpcPeeringConnection", + "smithy.api#documentation": "

The VPC peering connection.

", + "smithy.api#xmlName": "vpcPeeringConnection" + } + }, + "Port": { + "target": "com.amazonaws.ec2#Port", + "traits": { + "aws.protocols#ec2QueryName": "Port", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The port.

", + "smithy.api#xmlName": "port" + } + }, + "PortRanges": { + "target": "com.amazonaws.ec2#PortRangeList", + "traits": { + "aws.protocols#ec2QueryName": "PortRangeSet", + "smithy.api#documentation": "

The port ranges.

", + "smithy.api#xmlName": "portRangeSet" + } + }, + "PrefixList": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "PrefixList", + "smithy.api#documentation": "

The prefix list.

", + "smithy.api#xmlName": "prefixList" + } + }, + "Protocols": { + "target": "com.amazonaws.ec2#StringList", + "traits": { + "aws.protocols#ec2QueryName": "ProtocolSet", + "smithy.api#documentation": "

The protocols.

", + "smithy.api#xmlName": "protocolSet" + } + }, + "RouteTableRoute": { + "target": "com.amazonaws.ec2#AnalysisRouteTableRoute", + "traits": { + "aws.protocols#ec2QueryName": "RouteTableRoute", + "smithy.api#documentation": "

The route table route.

", + "smithy.api#xmlName": "routeTableRoute" + } + }, + "RouteTable": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "RouteTable", + "smithy.api#documentation": "

The route table.

", + "smithy.api#xmlName": "routeTable" + } + }, + "SecurityGroup": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroup", + "smithy.api#documentation": "

The security group.

", + "smithy.api#xmlName": "securityGroup" + } + }, + "SecurityGroupRule": { + "target": "com.amazonaws.ec2#AnalysisSecurityGroupRule", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupRule", + "smithy.api#documentation": "

The security group rule.

", + "smithy.api#xmlName": "securityGroupRule" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.ec2#AnalysisComponentList", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupSet", + "smithy.api#documentation": "

The security groups.

", + "smithy.api#xmlName": "securityGroupSet" + } + }, + "SourceVpc": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "SourceVpc", + "smithy.api#documentation": "

The source VPC.

", + "smithy.api#xmlName": "sourceVpc" + } + }, + "State": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state.

", + "smithy.api#xmlName": "state" + } + }, + "Subnet": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "Subnet", + "smithy.api#documentation": "

The subnet.

", + "smithy.api#xmlName": "subnet" + } + }, + "SubnetRouteTable": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "SubnetRouteTable", + "smithy.api#documentation": "

The route table for the subnet.

", + "smithy.api#xmlName": "subnetRouteTable" + } + }, + "Vpc": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "Vpc", + "smithy.api#documentation": "

The component VPC.

", + "smithy.api#xmlName": "vpc" + } + }, + "VpcEndpoint": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "VpcEndpoint", + "smithy.api#documentation": "

The VPC endpoint.

", + "smithy.api#xmlName": "vpcEndpoint" + } + }, + "VpnConnection": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "VpnConnection", + "smithy.api#documentation": "

The VPN connection.

", + "smithy.api#xmlName": "vpnConnection" + } + }, + "VpnGateway": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "VpnGateway", + "smithy.api#documentation": "

The VPN gateway.

", + "smithy.api#xmlName": "vpnGateway" + } + }, + "TransitGateway": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "TransitGateway", + "smithy.api#documentation": "

The transit gateway.

", + "smithy.api#xmlName": "transitGateway" + } + }, + "TransitGatewayRouteTable": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTable", + "smithy.api#documentation": "

The transit gateway route table.

", + "smithy.api#xmlName": "transitGatewayRouteTable" + } + }, + "TransitGatewayRouteTableRoute": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableRoute", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableRoute", + "smithy.api#documentation": "

The transit gateway route table route.

", + "smithy.api#xmlName": "transitGatewayRouteTableRoute" + } + }, + "TransitGatewayAttachment": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachment", + "smithy.api#documentation": "

The transit gateway attachment.

", + "smithy.api#xmlName": "transitGatewayAttachment" + } + }, + "ComponentAccount": { + "target": "com.amazonaws.ec2#ComponentAccount", + "traits": { + "aws.protocols#ec2QueryName": "ComponentAccount", + "smithy.api#documentation": "

The Amazon Web Services account for the component.

", + "smithy.api#xmlName": "componentAccount" + } + }, + "ComponentRegion": { + "target": "com.amazonaws.ec2#ComponentRegion", + "traits": { + "aws.protocols#ec2QueryName": "ComponentRegion", + "smithy.api#documentation": "

The Region for the component.

", + "smithy.api#xmlName": "componentRegion" + } + }, + "FirewallStatelessRule": { + "target": "com.amazonaws.ec2#FirewallStatelessRule", + "traits": { + "aws.protocols#ec2QueryName": "FirewallStatelessRule", + "smithy.api#documentation": "

The Network Firewall stateless rule.

", + "smithy.api#xmlName": "firewallStatelessRule" + } + }, + "FirewallStatefulRule": { + "target": "com.amazonaws.ec2#FirewallStatefulRule", + "traits": { + "aws.protocols#ec2QueryName": "FirewallStatefulRule", + "smithy.api#documentation": "

The Network Firewall stateful rule.

", + "smithy.api#xmlName": "firewallStatefulRule" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an explanation code for an unreachable path. For more information, see Reachability Analyzer explanation codes.

" + } + }, + "com.amazonaws.ec2#ExplanationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Explanation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ExportClientVpnClientCertificateRevocationList": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ExportClientVpnClientCertificateRevocationListRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ExportClientVpnClientCertificateRevocationListResult" + }, + "traits": { + "smithy.api#documentation": "

Downloads the client certificate revocation list for the specified Client VPN endpoint.

" + } + }, + "com.amazonaws.ec2#ExportClientVpnClientCertificateRevocationListRequest": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ExportClientVpnClientCertificateRevocationListResult": { + "type": "structure", + "members": { + "CertificateRevocationList": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CertificateRevocationList", + "smithy.api#documentation": "

Information about the client certificate revocation list.

", + "smithy.api#xmlName": "certificateRevocationList" + } + }, + "Status": { + "target": "com.amazonaws.ec2#ClientCertificateRevocationListStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The current state of the client certificate revocation list.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ExportClientVpnClientConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ExportClientVpnClientConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ExportClientVpnClientConfigurationResult" + }, + "traits": { + "smithy.api#documentation": "

Downloads the contents of the Client VPN endpoint configuration file for the specified Client VPN endpoint. The Client VPN endpoint configuration \n\t\t\tfile includes the Client VPN endpoint and certificate information clients need to establish a connection \n\t\t\twith the Client VPN endpoint.

" + } + }, + "com.amazonaws.ec2#ExportClientVpnClientConfigurationRequest": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ExportClientVpnClientConfigurationResult": { + "type": "structure", + "members": { + "ClientConfiguration": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientConfiguration", + "smithy.api#documentation": "

The contents of the Client VPN endpoint configuration file.

", + "smithy.api#xmlName": "clientConfiguration" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ExportEnvironment": { + "type": "enum", + "members": { + "citrix": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "citrix" + } + }, + "vmware": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vmware" + } + }, + "microsoft": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "microsoft" + } + } + } + }, + "com.amazonaws.ec2#ExportImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ExportImageRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ExportImageResult" + }, + "traits": { + "smithy.api#documentation": "

Exports an Amazon Machine Image (AMI) to a VM file. For more information, see Exporting a VM\n directly from an Amazon Machine Image (AMI) in the\n VM Import/Export User Guide.

" + } + }, + "com.amazonaws.ec2#ExportImageRequest": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Token to enable idempotency for export image requests.

", + "smithy.api#idempotencyToken": {} + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description of the image being exported. The maximum length is 255 characters.

" + } + }, + "DiskImageFormat": { + "target": "com.amazonaws.ec2#DiskImageFormat", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The disk image format.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the image.

", + "smithy.api#required": {} + } + }, + "S3ExportLocation": { + "target": "com.amazonaws.ec2#ExportTaskS3LocationRequest", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon S3 bucket for the destination image. The destination bucket must exist.

", + "smithy.api#required": {} + } + }, + "RoleName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the role that grants VM Import/Export permission to export images to your Amazon\n S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the export image task during creation.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ExportImageResult": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the image being exported.

", + "smithy.api#xmlName": "description" + } + }, + "DiskImageFormat": { + "target": "com.amazonaws.ec2#DiskImageFormat", + "traits": { + "aws.protocols#ec2QueryName": "DiskImageFormat", + "smithy.api#documentation": "

The disk image format for the exported image.

", + "smithy.api#xmlName": "diskImageFormat" + } + }, + "ExportImageTaskId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ExportImageTaskId", + "smithy.api#documentation": "

The ID of the export image task.

", + "smithy.api#xmlName": "exportImageTaskId" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the image.

", + "smithy.api#xmlName": "imageId" + } + }, + "RoleName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RoleName", + "smithy.api#documentation": "

The name of the role that grants VM Import/Export permission to export images to your Amazon\n S3 bucket.

", + "smithy.api#xmlName": "roleName" + } + }, + "Progress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Progress", + "smithy.api#documentation": "

The percent complete of the export image task.

", + "smithy.api#xmlName": "progress" + } + }, + "S3ExportLocation": { + "target": "com.amazonaws.ec2#ExportTaskS3Location", + "traits": { + "aws.protocols#ec2QueryName": "S3ExportLocation", + "smithy.api#documentation": "

Information about the destination Amazon S3 bucket.

", + "smithy.api#xmlName": "s3ExportLocation" + } + }, + "Status": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status of the export image task. The possible values are active, completed,\n deleting, and deleted.

", + "smithy.api#xmlName": "status" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

The status message for the export image task.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the export image task.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ExportImageTask": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the image being exported.

", + "smithy.api#xmlName": "description" + } + }, + "ExportImageTaskId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ExportImageTaskId", + "smithy.api#documentation": "

The ID of the export image task.

", + "smithy.api#xmlName": "exportImageTaskId" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the image.

", + "smithy.api#xmlName": "imageId" + } + }, + "Progress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Progress", + "smithy.api#documentation": "

The percent complete of the export image task.

", + "smithy.api#xmlName": "progress" + } + }, + "S3ExportLocation": { + "target": "com.amazonaws.ec2#ExportTaskS3Location", + "traits": { + "aws.protocols#ec2QueryName": "S3ExportLocation", + "smithy.api#documentation": "

Information about the destination Amazon S3 bucket.

", + "smithy.api#xmlName": "s3ExportLocation" + } + }, + "Status": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status of the export image task. The possible values are active, completed,\n deleting, and deleted.

", + "smithy.api#xmlName": "status" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

The status message for the export image task.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the export image task.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an export image task.

" + } + }, + "com.amazonaws.ec2#ExportImageTaskId": { + "type": "string" + }, + "com.amazonaws.ec2#ExportImageTaskIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ExportImageTaskId", + "traits": { + "smithy.api#xmlName": "ExportImageTaskId" + } + } + }, + "com.amazonaws.ec2#ExportImageTaskList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ExportImageTask", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ExportTask": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the resource being exported.

", + "smithy.api#xmlName": "description" + } + }, + "ExportTaskId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ExportTaskId", + "smithy.api#documentation": "

The ID of the export task.

", + "smithy.api#xmlName": "exportTaskId" + } + }, + "ExportToS3Task": { + "target": "com.amazonaws.ec2#ExportToS3Task", + "traits": { + "aws.protocols#ec2QueryName": "ExportToS3", + "smithy.api#documentation": "

Information about the export task.

", + "smithy.api#xmlName": "exportToS3" + } + }, + "InstanceExportDetails": { + "target": "com.amazonaws.ec2#InstanceExportDetails", + "traits": { + "aws.protocols#ec2QueryName": "InstanceExport", + "smithy.api#documentation": "

Information about the instance to export.

", + "smithy.api#xmlName": "instanceExport" + } + }, + "State": { + "target": "com.amazonaws.ec2#ExportTaskState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the export task.

", + "smithy.api#xmlName": "state" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

The status message related to the export task.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for the export task.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an export instance task.

" + } + }, + "com.amazonaws.ec2#ExportTaskId": { + "type": "string" + }, + "com.amazonaws.ec2#ExportTaskIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ExportTaskId", + "traits": { + "smithy.api#xmlName": "ExportTaskId" + } + } + }, + "com.amazonaws.ec2#ExportTaskList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ExportTask", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ExportTaskS3Location": { + "type": "structure", + "members": { + "S3Bucket": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "S3Bucket", + "smithy.api#documentation": "

The destination Amazon S3 bucket.

", + "smithy.api#xmlName": "s3Bucket" + } + }, + "S3Prefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "S3Prefix", + "smithy.api#documentation": "

The prefix (logical hierarchy) in the bucket.

", + "smithy.api#xmlName": "s3Prefix" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the destination for an export image task.

" + } + }, + "com.amazonaws.ec2#ExportTaskS3LocationRequest": { + "type": "structure", + "members": { + "S3Bucket": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The destination Amazon S3 bucket.

", + "smithy.api#required": {} + } + }, + "S3Prefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The prefix (logical hierarchy) in the bucket.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the destination for an export image task.

" + } + }, + "com.amazonaws.ec2#ExportTaskState": { + "type": "enum", + "members": { + "active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "cancelling": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelling" + } + }, + "cancelled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelled" + } + }, + "completed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "completed" + } + } + } + }, + "com.amazonaws.ec2#ExportToS3Task": { + "type": "structure", + "members": { + "ContainerFormat": { + "target": "com.amazonaws.ec2#ContainerFormat", + "traits": { + "aws.protocols#ec2QueryName": "ContainerFormat", + "smithy.api#documentation": "

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is\n exported.

", + "smithy.api#xmlName": "containerFormat" + } + }, + "DiskImageFormat": { + "target": "com.amazonaws.ec2#DiskImageFormat", + "traits": { + "aws.protocols#ec2QueryName": "DiskImageFormat", + "smithy.api#documentation": "

The format for the exported image.

", + "smithy.api#xmlName": "diskImageFormat" + } + }, + "S3Bucket": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "S3Bucket", + "smithy.api#documentation": "

The Amazon S3 bucket for the destination image. The destination bucket must exist and have\n an access control list (ACL) attached that specifies the Region-specific canonical account ID for\n the Grantee. For more information about the ACL to your S3 bucket, see Prerequisites in the VM Import/Export User Guide.

", + "smithy.api#xmlName": "s3Bucket" + } + }, + "S3Key": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "S3Key", + "smithy.api#documentation": "

The encryption key for your S3 bucket.

", + "smithy.api#xmlName": "s3Key" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the format and location for the export task.

" + } + }, + "com.amazonaws.ec2#ExportToS3TaskSpecification": { + "type": "structure", + "members": { + "ContainerFormat": { + "target": "com.amazonaws.ec2#ContainerFormat", + "traits": { + "aws.protocols#ec2QueryName": "ContainerFormat", + "smithy.api#documentation": "

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is\n exported.

", + "smithy.api#xmlName": "containerFormat" + } + }, + "DiskImageFormat": { + "target": "com.amazonaws.ec2#DiskImageFormat", + "traits": { + "aws.protocols#ec2QueryName": "DiskImageFormat", + "smithy.api#documentation": "

The format for the exported image.

", + "smithy.api#xmlName": "diskImageFormat" + } + }, + "S3Bucket": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "S3Bucket", + "smithy.api#documentation": "

The Amazon S3 bucket for the destination image. The destination bucket must exist and have\n an access control list (ACL) attached that specifies the Region-specific canonical account ID for\n the Grantee. For more information about the ACL to your S3 bucket, see Prerequisites in the VM Import/Export User Guide.

", + "smithy.api#xmlName": "s3Bucket" + } + }, + "S3Prefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "S3Prefix", + "smithy.api#documentation": "

The image is written to a single object in the Amazon S3 bucket at the S3 key s3prefix +\n exportTaskId + '.' + diskImageFormat.

", + "smithy.api#xmlName": "s3Prefix" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an export instance task.

" + } + }, + "com.amazonaws.ec2#ExportTransitGatewayRoutes": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ExportTransitGatewayRoutesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ExportTransitGatewayRoutesResult" + }, + "traits": { + "smithy.api#documentation": "

Exports routes from the specified transit gateway route table to the specified S3 bucket.\n By default, all routes are exported. Alternatively, you can filter by CIDR range.

\n

The routes are saved to the specified bucket in a JSON file. For more information, see\n Export Route Tables\n to Amazon S3 in Transit Gateways.

" + } + }, + "com.amazonaws.ec2#ExportTransitGatewayRoutesRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the route table.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "S3Bucket": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the S3 bucket.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ExportTransitGatewayRoutesResult": { + "type": "structure", + "members": { + "S3Location": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "S3Location", + "smithy.api#documentation": "

The URL of the exported file in Amazon S3. For example, \n s3://bucket_name/VPCTransitGateway/TransitGatewayRouteTables/file_name.

", + "smithy.api#xmlName": "s3Location" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ExportVmTaskId": { + "type": "string" + }, + "com.amazonaws.ec2#FailedCapacityReservationFleetCancellationResult": { + "type": "structure", + "members": { + "CapacityReservationFleetId": { + "target": "com.amazonaws.ec2#CapacityReservationFleetId", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationFleetId", + "smithy.api#documentation": "

The ID of the Capacity Reservation Fleet that could not be cancelled.

", + "smithy.api#xmlName": "capacityReservationFleetId" + } + }, + "CancelCapacityReservationFleetError": { + "target": "com.amazonaws.ec2#CancelCapacityReservationFleetError", + "traits": { + "aws.protocols#ec2QueryName": "CancelCapacityReservationFleetError", + "smithy.api#documentation": "

Information about the Capacity Reservation Fleet cancellation error.

", + "smithy.api#xmlName": "cancelCapacityReservationFleetError" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Capacity Reservation Fleet that could not be cancelled.

" + } + }, + "com.amazonaws.ec2#FailedCapacityReservationFleetCancellationResultSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#FailedCapacityReservationFleetCancellationResult", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#FailedQueuedPurchaseDeletion": { + "type": "structure", + "members": { + "Error": { + "target": "com.amazonaws.ec2#DeleteQueuedReservedInstancesError", + "traits": { + "aws.protocols#ec2QueryName": "Error", + "smithy.api#documentation": "

The error.

", + "smithy.api#xmlName": "error" + } + }, + "ReservedInstancesId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesId", + "smithy.api#documentation": "

The ID of the Reserved Instance.

", + "smithy.api#xmlName": "reservedInstancesId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Reserved Instance whose queued purchase was not deleted.

" + } + }, + "com.amazonaws.ec2#FailedQueuedPurchaseDeletionSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#FailedQueuedPurchaseDeletion", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#FastLaunchImageIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#xmlName": "ImageId" + } + } + }, + "com.amazonaws.ec2#FastLaunchLaunchTemplateSpecificationRequest": { + "type": "structure", + "members": { + "LaunchTemplateId": { + "target": "com.amazonaws.ec2#LaunchTemplateId", + "traits": { + "smithy.api#documentation": "

The ID of the launch template to use for faster launching for a Windows AMI.

" + } + }, + "LaunchTemplateName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the launch template to use for faster launching for a Windows AMI.

" + } + }, + "Version": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The version of the launch template to use for faster launching for a Windows AMI.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Request to create a launch template for a fast-launch enabled Windows AMI.

\n \n

Note - You can specify either the LaunchTemplateName or the \n\t\t\t\tLaunchTemplateId, but not both.

\n " + } + }, + "com.amazonaws.ec2#FastLaunchLaunchTemplateSpecificationResponse": { + "type": "structure", + "members": { + "LaunchTemplateId": { + "target": "com.amazonaws.ec2#LaunchTemplateId", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateId", + "smithy.api#documentation": "

The ID of the launch template for faster launching of the associated Windows AMI.

", + "smithy.api#xmlName": "launchTemplateId" + } + }, + "LaunchTemplateName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateName", + "smithy.api#documentation": "

The name of the launch template for faster launching of the associated Windows AMI.

", + "smithy.api#xmlName": "launchTemplateName" + } + }, + "Version": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Version", + "smithy.api#documentation": "

The version of the launch template for faster launching of the associated Windows AMI.

", + "smithy.api#xmlName": "version" + } + } + }, + "traits": { + "smithy.api#documentation": "

Identifies the launch template to use for faster launching of the Windows AMI.

" + } + }, + "com.amazonaws.ec2#FastLaunchResourceType": { + "type": "enum", + "members": { + "SNAPSHOT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "snapshot" + } + } + } + }, + "com.amazonaws.ec2#FastLaunchSnapshotConfigurationRequest": { + "type": "structure", + "members": { + "TargetResourceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration settings for creating and managing pre-provisioned snapshots for a fast-launch enabled Windows AMI.

" + } + }, + "com.amazonaws.ec2#FastLaunchSnapshotConfigurationResponse": { + "type": "structure", + "members": { + "TargetResourceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TargetResourceCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of pre-provisioned snapshots requested to keep on hand for a fast-launch enabled Windows AMI.

", + "smithy.api#xmlName": "targetResourceCount" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration settings for creating and managing pre-provisioned snapshots for a fast-launch enabled Windows AMI.

" + } + }, + "com.amazonaws.ec2#FastLaunchStateCode": { + "type": "enum", + "members": { + "enabling": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabling" + } + }, + "enabling_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabling-failed" + } + }, + "enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + }, + "enabled_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled-failed" + } + }, + "disabling": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabling" + } + }, + "disabling_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabling-failed" + } + } + } + }, + "com.amazonaws.ec2#FastSnapshotRestoreStateCode": { + "type": "enum", + "members": { + "enabling": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabling" + } + }, + "optimizing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "optimizing" + } + }, + "enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + }, + "disabling": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabling" + } + }, + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + } + } + }, + "com.amazonaws.ec2#FederatedAuthentication": { + "type": "structure", + "members": { + "SamlProviderArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SamlProviderArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM SAML identity provider.

", + "smithy.api#xmlName": "samlProviderArn" + } + }, + "SelfServiceSamlProviderArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SelfServiceSamlProviderArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM SAML identity provider for the self-service portal.

", + "smithy.api#xmlName": "selfServiceSamlProviderArn" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the IAM SAML identity providers used for federated authentication.

" + } + }, + "com.amazonaws.ec2#FederatedAuthenticationRequest": { + "type": "structure", + "members": { + "SAMLProviderArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM SAML identity provider.

" + } + }, + "SelfServiceSAMLProviderArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM SAML identity provider for the self-service portal.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The IAM SAML identity provider used for federated authentication.

" + } + }, + "com.amazonaws.ec2#Filter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the filter. Filter names are case-sensitive.

" + } + }, + "Values": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The filter values. Filter values are case-sensitive. If you specify multiple values for a \n filter, the values are joined with an OR, and the request returns all results \n that match any of the specified values.

", + "smithy.api#xmlName": "Value" + } + } + }, + "traits": { + "smithy.api#documentation": "

A filter name and value pair that is used to return a more specific list of results from a describe operation. \n Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

\n

If you specify multiple filters, the filters are joined with an AND, and the request returns only \n results that match all of the specified filters.

" + } + }, + "com.amazonaws.ec2#FilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Filter", + "traits": { + "smithy.api#xmlName": "Filter" + } + } + }, + "com.amazonaws.ec2#FilterPortRange": { + "type": "structure", + "members": { + "FromPort": { + "target": "com.amazonaws.ec2#Port", + "traits": { + "aws.protocols#ec2QueryName": "FromPort", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The first port in the range.

", + "smithy.api#xmlName": "fromPort" + } + }, + "ToPort": { + "target": "com.amazonaws.ec2#Port", + "traits": { + "aws.protocols#ec2QueryName": "ToPort", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The last port in the range.

", + "smithy.api#xmlName": "toPort" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a port range.

" + } + }, + "com.amazonaws.ec2#FindingsFound": { + "type": "enum", + "members": { + "true": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "true" + } + }, + "false": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "false" + } + }, + "unknown": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unknown" + } + } + } + }, + "com.amazonaws.ec2#FirewallStatefulRule": { + "type": "structure", + "members": { + "RuleGroupArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "RuleGroupArn", + "smithy.api#documentation": "

The ARN of the stateful rule group.

", + "smithy.api#xmlName": "ruleGroupArn" + } + }, + "Sources": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "SourceSet", + "smithy.api#documentation": "

The source IP addresses, in CIDR notation.

", + "smithy.api#xmlName": "sourceSet" + } + }, + "Destinations": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "DestinationSet", + "smithy.api#documentation": "

The destination IP addresses, in CIDR notation.

", + "smithy.api#xmlName": "destinationSet" + } + }, + "SourcePorts": { + "target": "com.amazonaws.ec2#PortRangeList", + "traits": { + "aws.protocols#ec2QueryName": "SourcePortSet", + "smithy.api#documentation": "

The source ports.

", + "smithy.api#xmlName": "sourcePortSet" + } + }, + "DestinationPorts": { + "target": "com.amazonaws.ec2#PortRangeList", + "traits": { + "aws.protocols#ec2QueryName": "DestinationPortSet", + "smithy.api#documentation": "

The destination ports.

", + "smithy.api#xmlName": "destinationPortSet" + } + }, + "Protocol": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Protocol", + "smithy.api#documentation": "

The protocol.

", + "smithy.api#xmlName": "protocol" + } + }, + "RuleAction": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RuleAction", + "smithy.api#documentation": "

The rule action. The possible values are pass, drop, and \n alert.

", + "smithy.api#xmlName": "ruleAction" + } + }, + "Direction": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Direction", + "smithy.api#documentation": "

The direction. The possible values are FORWARD and ANY.

", + "smithy.api#xmlName": "direction" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a stateful rule.

" + } + }, + "com.amazonaws.ec2#FirewallStatelessRule": { + "type": "structure", + "members": { + "RuleGroupArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "RuleGroupArn", + "smithy.api#documentation": "

The ARN of the stateless rule group.

", + "smithy.api#xmlName": "ruleGroupArn" + } + }, + "Sources": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "SourceSet", + "smithy.api#documentation": "

The source IP addresses, in CIDR notation.

", + "smithy.api#xmlName": "sourceSet" + } + }, + "Destinations": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "DestinationSet", + "smithy.api#documentation": "

The destination IP addresses, in CIDR notation.

", + "smithy.api#xmlName": "destinationSet" + } + }, + "SourcePorts": { + "target": "com.amazonaws.ec2#PortRangeList", + "traits": { + "aws.protocols#ec2QueryName": "SourcePortSet", + "smithy.api#documentation": "

The source ports.

", + "smithy.api#xmlName": "sourcePortSet" + } + }, + "DestinationPorts": { + "target": "com.amazonaws.ec2#PortRangeList", + "traits": { + "aws.protocols#ec2QueryName": "DestinationPortSet", + "smithy.api#documentation": "

The destination ports.

", + "smithy.api#xmlName": "destinationPortSet" + } + }, + "Protocols": { + "target": "com.amazonaws.ec2#ProtocolIntList", + "traits": { + "aws.protocols#ec2QueryName": "ProtocolSet", + "smithy.api#documentation": "

The protocols.

", + "smithy.api#xmlName": "protocolSet" + } + }, + "RuleAction": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RuleAction", + "smithy.api#documentation": "

The rule action. The possible values are pass, drop, and \n forward_to_site.

", + "smithy.api#xmlName": "ruleAction" + } + }, + "Priority": { + "target": "com.amazonaws.ec2#Priority", + "traits": { + "aws.protocols#ec2QueryName": "Priority", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The rule priority.

", + "smithy.api#xmlName": "priority" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a stateless rule.

" + } + }, + "com.amazonaws.ec2#FleetActivityStatus": { + "type": "enum", + "members": { + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "error" + } + }, + "PENDING_FULFILLMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending_fulfillment" + } + }, + "PENDING_TERMINATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending_termination" + } + }, + "FULFILLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fulfilled" + } + } + } + }, + "com.amazonaws.ec2#FleetCapacityReservation": { + "type": "structure", + "members": { + "CapacityReservationId": { + "target": "com.amazonaws.ec2#CapacityReservationId", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationId", + "smithy.api#documentation": "

The ID of the Capacity Reservation.

", + "smithy.api#xmlName": "capacityReservationId" + } + }, + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneId", + "smithy.api#documentation": "

The ID of the Availability Zone in which the Capacity Reservation reserves capacity.

", + "smithy.api#xmlName": "availabilityZoneId" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type for which the Capacity Reservation reserves capacity.

", + "smithy.api#xmlName": "instanceType" + } + }, + "InstancePlatform": { + "target": "com.amazonaws.ec2#CapacityReservationInstancePlatform", + "traits": { + "aws.protocols#ec2QueryName": "InstancePlatform", + "smithy.api#documentation": "

The type of operating system for which the Capacity Reservation reserves capacity.

", + "smithy.api#xmlName": "instancePlatform" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone in which the Capacity Reservation reserves capacity.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "TotalInstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TotalInstanceCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of instances for which the Capacity Reservation reserves capacity.

", + "smithy.api#xmlName": "totalInstanceCount" + } + }, + "FulfilledCapacity": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "FulfilledCapacity", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of capacity units fulfilled by the Capacity Reservation. For more information, see \n\t\t\t\n\t\t\t\tTotal target capacity in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "fulfilledCapacity" + } + }, + "EbsOptimized": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EbsOptimized", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the Capacity Reservation reserves capacity for EBS-optimized instance types.

", + "smithy.api#xmlName": "ebsOptimized" + } + }, + "CreateDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreateDate", + "smithy.api#documentation": "

The date and time at which the Capacity Reservation was created.

", + "smithy.api#xmlName": "createDate" + } + }, + "Weight": { + "target": "com.amazonaws.ec2#DoubleWithConstraints", + "traits": { + "aws.protocols#ec2QueryName": "Weight", + "smithy.api#documentation": "

The weight of the instance type in the Capacity Reservation Fleet. For more information, \n\t\t\tsee \n\t\t\t\tInstance type weight in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "weight" + } + }, + "Priority": { + "target": "com.amazonaws.ec2#IntegerWithConstraints", + "traits": { + "aws.protocols#ec2QueryName": "Priority", + "smithy.api#documentation": "

The priority of the instance type in the Capacity Reservation Fleet. For more information, \n\t\t\tsee \n\t\t\t\tInstance type priority in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "priority" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a Capacity Reservation in a Capacity Reservation Fleet.

" + } + }, + "com.amazonaws.ec2#FleetCapacityReservationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#FleetCapacityReservation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#FleetCapacityReservationTenancy": { + "type": "enum", + "members": { + "default": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "default" + } + } + } + }, + "com.amazonaws.ec2#FleetCapacityReservationUsageStrategy": { + "type": "enum", + "members": { + "USE_CAPACITY_RESERVATIONS_FIRST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "use-capacity-reservations-first" + } + } + } + }, + "com.amazonaws.ec2#FleetData": { + "type": "structure", + "members": { + "ActivityStatus": { + "target": "com.amazonaws.ec2#FleetActivityStatus", + "traits": { + "aws.protocols#ec2QueryName": "ActivityStatus", + "smithy.api#documentation": "

The progress of the EC2 Fleet. If there is an error, the status is error. After\n all requests are placed, the status is pending_fulfillment. If the size of the\n EC2 Fleet is equal to or greater than its target capacity, the status is fulfilled.\n If the size of the EC2 Fleet is decreased, the status is pending_termination while\n instances are terminating.

", + "smithy.api#xmlName": "activityStatus" + } + }, + "CreateTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreateTime", + "smithy.api#documentation": "

The creation date and time of the EC2 Fleet.

", + "smithy.api#xmlName": "createTime" + } + }, + "FleetId": { + "target": "com.amazonaws.ec2#FleetId", + "traits": { + "aws.protocols#ec2QueryName": "FleetId", + "smithy.api#documentation": "

The ID of the EC2 Fleet.

", + "smithy.api#xmlName": "fleetId" + } + }, + "FleetState": { + "target": "com.amazonaws.ec2#FleetStateCode", + "traits": { + "aws.protocols#ec2QueryName": "FleetState", + "smithy.api#documentation": "

The state of the EC2 Fleet.

", + "smithy.api#xmlName": "fleetState" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.

\n

Constraints: Maximum 64 ASCII characters

", + "smithy.api#xmlName": "clientToken" + } + }, + "ExcessCapacityTerminationPolicy": { + "target": "com.amazonaws.ec2#FleetExcessCapacityTerminationPolicy", + "traits": { + "aws.protocols#ec2QueryName": "ExcessCapacityTerminationPolicy", + "smithy.api#documentation": "

Indicates whether running instances should be terminated if the target capacity of the\n EC2 Fleet is decreased below the current size of the EC2 Fleet.

\n

Supported only for fleets of type maintain.

", + "smithy.api#xmlName": "excessCapacityTerminationPolicy" + } + }, + "FulfilledCapacity": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "FulfilledCapacity", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of units fulfilled by this request compared to the set target\n capacity.

", + "smithy.api#xmlName": "fulfilledCapacity" + } + }, + "FulfilledOnDemandCapacity": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "FulfilledOnDemandCapacity", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of units fulfilled by this request compared to the set target On-Demand\n capacity.

", + "smithy.api#xmlName": "fulfilledOnDemandCapacity" + } + }, + "LaunchTemplateConfigs": { + "target": "com.amazonaws.ec2#FleetLaunchTemplateConfigList", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateConfigs", + "smithy.api#documentation": "

The launch template and overrides.

", + "smithy.api#xmlName": "launchTemplateConfigs" + } + }, + "TargetCapacitySpecification": { + "target": "com.amazonaws.ec2#TargetCapacitySpecification", + "traits": { + "aws.protocols#ec2QueryName": "TargetCapacitySpecification", + "smithy.api#documentation": "

The number of units to request. You can choose to set the target capacity in terms of\n instances or a performance characteristic that is important to your application workload,\n such as vCPUs, memory, or I/O. If the request type is maintain, you can\n specify a target capacity of 0 and add capacity later.

", + "smithy.api#xmlName": "targetCapacitySpecification" + } + }, + "TerminateInstancesWithExpiration": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "TerminateInstancesWithExpiration", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether running instances should be terminated when the EC2 Fleet expires.

", + "smithy.api#xmlName": "terminateInstancesWithExpiration" + } + }, + "Type": { + "target": "com.amazonaws.ec2#FleetType", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The type of request. Indicates whether the EC2 Fleet only requests the target\n capacity, or also attempts to maintain it. If you request a certain target\n capacity, EC2 Fleet only places the required requests; it does not attempt to replenish\n instances if capacity is diminished, and it does not submit requests in alternative\n capacity pools if capacity is unavailable. To maintain a certain target capacity, EC2 Fleet\n places the required requests to meet this target capacity. It also automatically\n replenishes any interrupted Spot Instances. Default: maintain.

", + "smithy.api#xmlName": "type" + } + }, + "ValidFrom": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "ValidFrom", + "smithy.api#documentation": "

The start date and time of the request, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).\n The default is to start fulfilling the request immediately.

", + "smithy.api#xmlName": "validFrom" + } + }, + "ValidUntil": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "ValidUntil", + "smithy.api#documentation": "

The end date and time of the request, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).\n At this point, no new instance requests are placed or able to fulfill the request. The\n default end date is 7 days from the current date.

", + "smithy.api#xmlName": "validUntil" + } + }, + "ReplaceUnhealthyInstances": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "ReplaceUnhealthyInstances", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for\n fleets of type maintain. For more information, see EC2 Fleet\n health checks in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "replaceUnhealthyInstances" + } + }, + "SpotOptions": { + "target": "com.amazonaws.ec2#SpotOptions", + "traits": { + "aws.protocols#ec2QueryName": "SpotOptions", + "smithy.api#documentation": "

The configuration of Spot Instances in an EC2 Fleet.

", + "smithy.api#xmlName": "spotOptions" + } + }, + "OnDemandOptions": { + "target": "com.amazonaws.ec2#OnDemandOptions", + "traits": { + "aws.protocols#ec2QueryName": "OnDemandOptions", + "smithy.api#documentation": "

The allocation strategy of On-Demand Instances in an EC2 Fleet.

", + "smithy.api#xmlName": "onDemandOptions" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for an EC2 Fleet resource.

", + "smithy.api#xmlName": "tagSet" + } + }, + "Errors": { + "target": "com.amazonaws.ec2#DescribeFleetsErrorSet", + "traits": { + "aws.protocols#ec2QueryName": "ErrorSet", + "smithy.api#documentation": "

Information about the instances that could not be launched by the fleet. Valid only when\n Type is set to instant.

", + "smithy.api#xmlName": "errorSet" + } + }, + "Instances": { + "target": "com.amazonaws.ec2#DescribeFleetsInstancesSet", + "traits": { + "aws.protocols#ec2QueryName": "FleetInstanceSet", + "smithy.api#documentation": "

Information about the instances that were launched by the fleet. Valid only when\n Type is set to instant.

", + "smithy.api#xmlName": "fleetInstanceSet" + } + }, + "Context": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Context", + "smithy.api#documentation": "

Reserved.

", + "smithy.api#xmlName": "context" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an EC2 Fleet.

" + } + }, + "com.amazonaws.ec2#FleetEventType": { + "type": "enum", + "members": { + "INSTANCE_CHANGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "instance-change" + } + }, + "FLEET_CHANGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fleet-change" + } + }, + "SERVICE_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "service-error" + } + } + } + }, + "com.amazonaws.ec2#FleetExcessCapacityTerminationPolicy": { + "type": "enum", + "members": { + "NO_TERMINATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "no-termination" + } + }, + "TERMINATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "termination" + } + } + } + }, + "com.amazonaws.ec2#FleetId": { + "type": "string" + }, + "com.amazonaws.ec2#FleetIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#FleetId" + } + }, + "com.amazonaws.ec2#FleetInstanceMatchCriteria": { + "type": "enum", + "members": { + "open": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "open" + } + } + } + }, + "com.amazonaws.ec2#FleetLaunchTemplateConfig": { + "type": "structure", + "members": { + "LaunchTemplateSpecification": { + "target": "com.amazonaws.ec2#FleetLaunchTemplateSpecification", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateSpecification", + "smithy.api#documentation": "

The launch template.

", + "smithy.api#xmlName": "launchTemplateSpecification" + } + }, + "Overrides": { + "target": "com.amazonaws.ec2#FleetLaunchTemplateOverridesList", + "traits": { + "aws.protocols#ec2QueryName": "Overrides", + "smithy.api#documentation": "

Any parameters that you specify override the same parameters in the launch\n template.

", + "smithy.api#xmlName": "overrides" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a launch template and overrides.

" + } + }, + "com.amazonaws.ec2#FleetLaunchTemplateConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#FleetLaunchTemplateConfig", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#FleetLaunchTemplateConfigListRequest": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#FleetLaunchTemplateConfigRequest", + "traits": { + "smithy.api#xmlName": "item" + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.ec2#FleetLaunchTemplateConfigRequest": { + "type": "structure", + "members": { + "LaunchTemplateSpecification": { + "target": "com.amazonaws.ec2#FleetLaunchTemplateSpecificationRequest", + "traits": { + "smithy.api#documentation": "

The launch template to use. You must specify either the launch template ID or launch\n template name in the request.

" + } + }, + "Overrides": { + "target": "com.amazonaws.ec2#FleetLaunchTemplateOverridesListRequest", + "traits": { + "smithy.api#documentation": "

Any parameters that you specify override the same parameters in the launch\n template.

\n

For fleets of type request and maintain, a maximum of 300\n items is allowed across all launch templates.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a launch template and overrides.

" + } + }, + "com.amazonaws.ec2#FleetLaunchTemplateOverrides": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type.

\n

\n mac1.metal is not supported as a launch template override.

\n \n

If you specify InstanceType, you can't specify\n InstanceRequirements.

\n ", + "smithy.api#xmlName": "instanceType" + } + }, + "MaxPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "MaxPrice", + "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.\n

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n ", + "smithy.api#xmlName": "maxPrice" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet in which to launch the instances.

", + "smithy.api#xmlName": "subnetId" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone in which to launch the instances.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "WeightedCapacity": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "WeightedCapacity", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of units provided by the specified instance type.

", + "smithy.api#xmlName": "weightedCapacity" + } + }, + "Priority": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "Priority", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The priority for the launch template override. The highest priority is launched\n first.

\n

If the On-Demand AllocationStrategy is set to prioritized,\n EC2 Fleet uses priority to determine which launch template override to use first in fulfilling\n On-Demand capacity.

\n

If the Spot AllocationStrategy is set to\n capacity-optimized-prioritized, EC2 Fleet uses priority on a best-effort basis\n to determine which launch template override to use in fulfilling Spot capacity, but\n optimizes for capacity first.

\n

Valid values are whole numbers starting at 0. The lower the number, the\n higher the priority. If no number is set, the override has the lowest priority. You can set\n the same priority for different launch template overrides.

", + "smithy.api#xmlName": "priority" + } + }, + "Placement": { + "target": "com.amazonaws.ec2#PlacementResponse", + "traits": { + "aws.protocols#ec2QueryName": "Placement", + "smithy.api#documentation": "

The location where the instance launched, if applicable.

", + "smithy.api#xmlName": "placement" + } + }, + "InstanceRequirements": { + "target": "com.amazonaws.ec2#InstanceRequirements", + "traits": { + "aws.protocols#ec2QueryName": "InstanceRequirements", + "smithy.api#documentation": "

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with those attributes.

\n \n

If you specify InstanceRequirements, you can't specify\n InstanceType.

\n ", + "smithy.api#xmlName": "instanceRequirements" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the AMI. An AMI is required to launch an instance. The AMI ID must be specified here or in the launch template.

", + "smithy.api#xmlName": "imageId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes overrides for a launch template.

" + } + }, + "com.amazonaws.ec2#FleetLaunchTemplateOverridesList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#FleetLaunchTemplateOverrides", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#FleetLaunchTemplateOverridesListRequest": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#FleetLaunchTemplateOverridesRequest", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#FleetLaunchTemplateOverridesRequest": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "smithy.api#documentation": "

The instance type.

\n

\n mac1.metal is not supported as a launch template override.

\n \n

If you specify InstanceType, you can't specify\n InstanceRequirements.

\n " + } + }, + "MaxPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.\n

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n " + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#documentation": "

The IDs of the subnets in which to launch the instances. Separate multiple subnet IDs using commas (for example, subnet-1234abcdeexample1, subnet-0987cdef6example2). A request of type instant can have only one subnet ID.

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone in which to launch the instances.

" + } + }, + "WeightedCapacity": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of units provided by the specified instance type.

" + } + }, + "Priority": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The priority for the launch template override. The highest priority is launched\n first.

\n

If the On-Demand AllocationStrategy is set to prioritized,\n EC2 Fleet uses priority to determine which launch template override to use first in fulfilling\n On-Demand capacity.

\n

If the Spot AllocationStrategy is set to\n capacity-optimized-prioritized, EC2 Fleet uses priority on a best-effort basis\n to determine which launch template override to use in fulfilling Spot capacity, but\n optimizes for capacity first.

\n

Valid values are whole numbers starting at 0. The lower the number, the\n higher the priority. If no number is set, the launch template override has the lowest\n priority. You can set the same priority for different launch template overrides.

" + } + }, + "Placement": { + "target": "com.amazonaws.ec2#Placement", + "traits": { + "smithy.api#documentation": "

The location where the instance launched, if applicable.

" + } + }, + "InstanceRequirements": { + "target": "com.amazonaws.ec2#InstanceRequirementsRequest", + "traits": { + "smithy.api#documentation": "

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with those attributes.

\n \n

If you specify InstanceRequirements, you can't specify\n InstanceType.

\n " + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#documentation": "

The ID of the AMI. An AMI is required to launch an instance. The AMI ID must be specified here or in the launch template.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes overrides for a launch template.

" + } + }, + "com.amazonaws.ec2#FleetLaunchTemplateSpecification": { + "type": "structure", + "members": { + "LaunchTemplateId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateId", + "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify the LaunchTemplateId or the LaunchTemplateName, but not both.

", + "smithy.api#xmlName": "launchTemplateId" + } + }, + "LaunchTemplateName": { + "target": "com.amazonaws.ec2#LaunchTemplateName", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateName", + "smithy.api#documentation": "

The name of the launch template.

\n

You must specify the LaunchTemplateName or the LaunchTemplateId, but not both.

", + "smithy.api#xmlName": "launchTemplateName" + } + }, + "Version": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Version", + "smithy.api#documentation": "

The launch template version number, $Latest, or $Default.\n You must specify a value, otherwise the request fails.

\n

If the value is $Latest, Amazon EC2 uses the latest version of the launch\n template.

\n

If the value is $Default, Amazon EC2 uses the default version of the launch\n template.

", + "smithy.api#xmlName": "version" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon EC2 launch template that can be used by\n a Spot Fleet to configure Amazon EC2 instances. You must specify either the ID or name of the launch template in the request, but not both.

\n

For information about launch templates,\n see Launch an instance from a launch template in the\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#FleetLaunchTemplateSpecificationRequest": { + "type": "structure", + "members": { + "LaunchTemplateId": { + "target": "com.amazonaws.ec2#LaunchTemplateId", + "traits": { + "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify the LaunchTemplateId or the LaunchTemplateName, but not both.

" + } + }, + "LaunchTemplateName": { + "target": "com.amazonaws.ec2#LaunchTemplateName", + "traits": { + "smithy.api#documentation": "

The name of the launch template.

\n

You must specify the LaunchTemplateName or the LaunchTemplateId, but not both.

" + } + }, + "Version": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The launch template version number, $Latest, or $Default. You must specify a value, otherwise the request fails.

\n

If the value is $Latest, Amazon EC2 uses the latest version of the launch template.

\n

If the value is $Default, Amazon EC2 uses the default version of the launch template.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon EC2 launch template that can be used by\n an EC2 Fleet to configure Amazon EC2 instances. You must specify either the ID or name of the launch template in the request, but not both.

\n

For information about launch templates, see Launch\n an instance from a launch template in the\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#FleetOnDemandAllocationStrategy": { + "type": "enum", + "members": { + "LOWEST_PRICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lowest-price" + } + }, + "PRIORITIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "prioritized" + } + } + } + }, + "com.amazonaws.ec2#FleetReplacementStrategy": { + "type": "enum", + "members": { + "LAUNCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "launch" + } + }, + "LAUNCH_BEFORE_TERMINATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "launch-before-terminate" + } + } + } + }, + "com.amazonaws.ec2#FleetSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#FleetData", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#FleetSpotCapacityRebalance": { + "type": "structure", + "members": { + "ReplacementStrategy": { + "target": "com.amazonaws.ec2#FleetReplacementStrategy", + "traits": { + "aws.protocols#ec2QueryName": "ReplacementStrategy", + "smithy.api#documentation": "

The replacement strategy to use. Only available for fleets of type\n maintain.

\n

\n launch - EC2 Fleet launches a new replacement Spot Instance when a\n rebalance notification is emitted for an existing Spot Instance in the fleet. EC2 Fleet\n does not terminate the instances that receive a rebalance notification. You can terminate\n the old instances, or you can leave them running. You are charged for all instances while\n they are running.

\n

\n launch-before-terminate - EC2 Fleet launches a new replacement Spot\n Instance when a rebalance notification is emitted for an existing Spot Instance in the\n fleet, and then, after a delay that you specify (in TerminationDelay),\n terminates the instances that received a rebalance notification.

", + "smithy.api#xmlName": "replacementStrategy" + } + }, + "TerminationDelay": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TerminationDelay", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot\n Instance after launching a new replacement Spot Instance.

\n

Required when ReplacementStrategy is set to launch-before-terminate.

\n

Not valid when ReplacementStrategy is set to launch.

\n

Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.

", + "smithy.api#xmlName": "terminationDelay" + } + } + }, + "traits": { + "smithy.api#documentation": "

The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an\n elevated risk of being interrupted.

" + } + }, + "com.amazonaws.ec2#FleetSpotCapacityRebalanceRequest": { + "type": "structure", + "members": { + "ReplacementStrategy": { + "target": "com.amazonaws.ec2#FleetReplacementStrategy", + "traits": { + "smithy.api#documentation": "

The replacement strategy to use. Only available for fleets of type\n maintain.

\n

\n launch - EC2 Fleet launches a replacement Spot Instance when a rebalance\n notification is emitted for an existing Spot Instance in the fleet. EC2 Fleet does not\n terminate the instances that receive a rebalance notification. You can terminate the old\n instances, or you can leave them running. You are charged for all instances while they are\n running.

\n

\n launch-before-terminate - EC2 Fleet launches a replacement Spot Instance\n when a rebalance notification is emitted for an existing Spot Instance in the fleet, and\n then, after a delay that you specify (in TerminationDelay), terminates the\n instances that received a rebalance notification.

" + } + }, + "TerminationDelay": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot\n Instance after launching a new replacement Spot Instance.

\n

Required when ReplacementStrategy is set to launch-before-terminate.

\n

Not valid when ReplacementStrategy is set to launch.

\n

Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Spot Instance replacement strategy to use when Amazon EC2 emits a rebalance\n notification signal that your Spot Instance is at an elevated risk of being interrupted.\n For more information, see Capacity rebalancing in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#FleetSpotMaintenanceStrategies": { + "type": "structure", + "members": { + "CapacityRebalance": { + "target": "com.amazonaws.ec2#FleetSpotCapacityRebalance", + "traits": { + "aws.protocols#ec2QueryName": "CapacityRebalance", + "smithy.api#documentation": "

The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an\n elevated risk of being interrupted.

", + "smithy.api#xmlName": "capacityRebalance" + } + } + }, + "traits": { + "smithy.api#documentation": "

The strategies for managing your Spot Instances that are at an elevated risk of being\n interrupted.

" + } + }, + "com.amazonaws.ec2#FleetSpotMaintenanceStrategiesRequest": { + "type": "structure", + "members": { + "CapacityRebalance": { + "target": "com.amazonaws.ec2#FleetSpotCapacityRebalanceRequest", + "traits": { + "smithy.api#documentation": "

The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an\n elevated risk of being interrupted.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.

" + } + }, + "com.amazonaws.ec2#FleetStateCode": { + "type": "enum", + "members": { + "SUBMITTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "submitted" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "DELETED_RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted_running" + } + }, + "DELETED_TERMINATING_INSTANCES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted_terminating" + } + }, + "MODIFYING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modifying" + } + } + } + }, + "com.amazonaws.ec2#FleetType": { + "type": "enum", + "members": { + "REQUEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "request" + } + }, + "MAINTAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "maintain" + } + }, + "INSTANT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "instant" + } + } + } + }, + "com.amazonaws.ec2#Float": { + "type": "float", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.ec2#FlowLog": { + "type": "structure", + "members": { + "CreationTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The date and time the flow log was created.

", + "smithy.api#xmlName": "creationTime" + } + }, + "DeliverLogsErrorMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DeliverLogsErrorMessage", + "smithy.api#documentation": "

Information about the error that occurred. Rate limited indicates that\n CloudWatch Logs throttling has been applied for one or more network interfaces, or that you've\n reached the limit on the number of log groups that you can create. Access\n error indicates that the IAM role associated with the flow log does not have\n sufficient permissions to publish to CloudWatch Logs. Unknown error indicates an\n internal error.

", + "smithy.api#xmlName": "deliverLogsErrorMessage" + } + }, + "DeliverLogsPermissionArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DeliverLogsPermissionArn", + "smithy.api#documentation": "

The ARN of the IAM role allows the service to publish logs to CloudWatch Logs.

", + "smithy.api#xmlName": "deliverLogsPermissionArn" + } + }, + "DeliverCrossAccountRole": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DeliverCrossAccountRole", + "smithy.api#documentation": "

The ARN of the IAM role that allows the service to publish flow logs across accounts.

", + "smithy.api#xmlName": "deliverCrossAccountRole" + } + }, + "DeliverLogsStatus": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DeliverLogsStatus", + "smithy.api#documentation": "

The status of the logs delivery (SUCCESS | FAILED).

", + "smithy.api#xmlName": "deliverLogsStatus" + } + }, + "FlowLogId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "FlowLogId", + "smithy.api#documentation": "

The ID of the flow log.

", + "smithy.api#xmlName": "flowLogId" + } + }, + "FlowLogStatus": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "FlowLogStatus", + "smithy.api#documentation": "

The status of the flow log (ACTIVE).

", + "smithy.api#xmlName": "flowLogStatus" + } + }, + "LogGroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LogGroupName", + "smithy.api#documentation": "

The name of the flow log group.

", + "smithy.api#xmlName": "logGroupName" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource being monitored.

", + "smithy.api#xmlName": "resourceId" + } + }, + "TrafficType": { + "target": "com.amazonaws.ec2#TrafficType", + "traits": { + "aws.protocols#ec2QueryName": "TrafficType", + "smithy.api#documentation": "

The type of traffic captured for the flow log.

", + "smithy.api#xmlName": "trafficType" + } + }, + "LogDestinationType": { + "target": "com.amazonaws.ec2#LogDestinationType", + "traits": { + "aws.protocols#ec2QueryName": "LogDestinationType", + "smithy.api#documentation": "

The type of destination for the flow log data.

", + "smithy.api#xmlName": "logDestinationType" + } + }, + "LogDestination": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LogDestination", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the destination for the flow log data.

", + "smithy.api#xmlName": "logDestination" + } + }, + "LogFormat": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LogFormat", + "smithy.api#documentation": "

The format of the flow log record.

", + "smithy.api#xmlName": "logFormat" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for the flow log.

", + "smithy.api#xmlName": "tagSet" + } + }, + "MaxAggregationInterval": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MaxAggregationInterval", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.

\n

When a network interface is attached to a Nitro-based\n instance, the aggregation interval is always 60 seconds (1 minute) or less,\n regardless of the specified value.

\n

Valid Values: 60 | 600\n

", + "smithy.api#xmlName": "maxAggregationInterval" + } + }, + "DestinationOptions": { + "target": "com.amazonaws.ec2#DestinationOptionsResponse", + "traits": { + "aws.protocols#ec2QueryName": "DestinationOptions", + "smithy.api#documentation": "

The destination options.

", + "smithy.api#xmlName": "destinationOptions" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a flow log.

" + } + }, + "com.amazonaws.ec2#FlowLogIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpcFlowLogId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#FlowLogResourceId": { + "type": "string" + }, + "com.amazonaws.ec2#FlowLogResourceIds": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#FlowLogResourceId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#FlowLogSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#FlowLog", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#FlowLogsResourceType": { + "type": "enum", + "members": { + "VPC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VPC" + } + }, + "Subnet": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Subnet" + } + }, + "NetworkInterface": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NetworkInterface" + } + }, + "TransitGateway": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TransitGateway" + } + }, + "TransitGatewayAttachment": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TransitGatewayAttachment" + } + } + } + }, + "com.amazonaws.ec2#FpgaDeviceCount": { + "type": "integer" + }, + "com.amazonaws.ec2#FpgaDeviceInfo": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.ec2#FpgaDeviceName", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The name of the FPGA accelerator.

", + "smithy.api#xmlName": "name" + } + }, + "Manufacturer": { + "target": "com.amazonaws.ec2#FpgaDeviceManufacturerName", + "traits": { + "aws.protocols#ec2QueryName": "Manufacturer", + "smithy.api#documentation": "

The manufacturer of the FPGA accelerator.

", + "smithy.api#xmlName": "manufacturer" + } + }, + "Count": { + "target": "com.amazonaws.ec2#FpgaDeviceCount", + "traits": { + "aws.protocols#ec2QueryName": "Count", + "smithy.api#documentation": "

The count of FPGA accelerators for the instance type.

", + "smithy.api#xmlName": "count" + } + }, + "MemoryInfo": { + "target": "com.amazonaws.ec2#FpgaDeviceMemoryInfo", + "traits": { + "aws.protocols#ec2QueryName": "MemoryInfo", + "smithy.api#documentation": "

Describes the memory for the FPGA accelerator for the instance type.

", + "smithy.api#xmlName": "memoryInfo" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the FPGA accelerator for the instance type.

" + } + }, + "com.amazonaws.ec2#FpgaDeviceInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#FpgaDeviceInfo", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#FpgaDeviceManufacturerName": { + "type": "string" + }, + "com.amazonaws.ec2#FpgaDeviceMemoryInfo": { + "type": "structure", + "members": { + "SizeInMiB": { + "target": "com.amazonaws.ec2#FpgaDeviceMemorySize", + "traits": { + "aws.protocols#ec2QueryName": "SizeInMiB", + "smithy.api#documentation": "

The size of the memory available to the FPGA accelerator, in MiB.

", + "smithy.api#xmlName": "sizeInMiB" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the memory for the FPGA accelerator for the instance type.

" + } + }, + "com.amazonaws.ec2#FpgaDeviceMemorySize": { + "type": "integer" + }, + "com.amazonaws.ec2#FpgaDeviceName": { + "type": "string" + }, + "com.amazonaws.ec2#FpgaImage": { + "type": "structure", + "members": { + "FpgaImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "FpgaImageId", + "smithy.api#documentation": "

The FPGA image identifier (AFI ID).

", + "smithy.api#xmlName": "fpgaImageId" + } + }, + "FpgaImageGlobalId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "FpgaImageGlobalId", + "smithy.api#documentation": "

The global FPGA image identifier (AGFI ID).

", + "smithy.api#xmlName": "fpgaImageGlobalId" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The name of the AFI.

", + "smithy.api#xmlName": "name" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of the AFI.

", + "smithy.api#xmlName": "description" + } + }, + "ShellVersion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ShellVersion", + "smithy.api#documentation": "

The version of the Amazon Web Services Shell that was used to create the bitstream.

", + "smithy.api#xmlName": "shellVersion" + } + }, + "PciId": { + "target": "com.amazonaws.ec2#PciId", + "traits": { + "aws.protocols#ec2QueryName": "PciId", + "smithy.api#documentation": "

Information about the PCI bus.

", + "smithy.api#xmlName": "pciId" + } + }, + "State": { + "target": "com.amazonaws.ec2#FpgaImageState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

Information about the state of the AFI.

", + "smithy.api#xmlName": "state" + } + }, + "CreateTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreateTime", + "smithy.api#documentation": "

The date and time the AFI was created.

", + "smithy.api#xmlName": "createTime" + } + }, + "UpdateTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "UpdateTime", + "smithy.api#documentation": "

The time of the most recent update to the AFI.

", + "smithy.api#xmlName": "updateTime" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the AFI.

", + "smithy.api#xmlName": "ownerId" + } + }, + "OwnerAlias": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerAlias", + "smithy.api#documentation": "

The alias of the AFI owner. Possible values include self, amazon, and aws-marketplace.

", + "smithy.api#xmlName": "ownerAlias" + } + }, + "ProductCodes": { + "target": "com.amazonaws.ec2#ProductCodeList", + "traits": { + "aws.protocols#ec2QueryName": "ProductCodes", + "smithy.api#documentation": "

The product codes for the AFI.

", + "smithy.api#xmlName": "productCodes" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "Tags", + "smithy.api#documentation": "

Any tags assigned to the AFI.

", + "smithy.api#xmlName": "tags" + } + }, + "Public": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Public", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the AFI is public.

", + "smithy.api#xmlName": "public" + } + }, + "DataRetentionSupport": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DataRetentionSupport", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether data retention support is enabled for the AFI.

", + "smithy.api#xmlName": "dataRetentionSupport" + } + }, + "InstanceTypes": { + "target": "com.amazonaws.ec2#InstanceTypesList", + "traits": { + "aws.protocols#ec2QueryName": "InstanceTypes", + "smithy.api#documentation": "

The instance types supported by the AFI.

", + "smithy.api#xmlName": "instanceTypes" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an Amazon FPGA image (AFI).

" + } + }, + "com.amazonaws.ec2#FpgaImageAttribute": { + "type": "structure", + "members": { + "FpgaImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "FpgaImageId", + "smithy.api#documentation": "

The ID of the AFI.

", + "smithy.api#xmlName": "fpgaImageId" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The name of the AFI.

", + "smithy.api#xmlName": "name" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of the AFI.

", + "smithy.api#xmlName": "description" + } + }, + "LoadPermissions": { + "target": "com.amazonaws.ec2#LoadPermissionList", + "traits": { + "aws.protocols#ec2QueryName": "LoadPermissions", + "smithy.api#documentation": "

The load permissions.

", + "smithy.api#xmlName": "loadPermissions" + } + }, + "ProductCodes": { + "target": "com.amazonaws.ec2#ProductCodeList", + "traits": { + "aws.protocols#ec2QueryName": "ProductCodes", + "smithy.api#documentation": "

The product codes.

", + "smithy.api#xmlName": "productCodes" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an Amazon FPGA image (AFI) attribute.

" + } + }, + "com.amazonaws.ec2#FpgaImageAttributeName": { + "type": "enum", + "members": { + "description": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "description" + } + }, + "name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "name" + } + }, + "loadPermission": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "loadPermission" + } + }, + "productCodes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "productCodes" + } + } + } + }, + "com.amazonaws.ec2#FpgaImageId": { + "type": "string" + }, + "com.amazonaws.ec2#FpgaImageIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#FpgaImageId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#FpgaImageList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#FpgaImage", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#FpgaImageState": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#FpgaImageStateCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The state. The following are the possible values:

\n ", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

If the state is failed, this is the error message.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the state of the bitstream generation process for an Amazon FPGA image (AFI).

" + } + }, + "com.amazonaws.ec2#FpgaImageStateCode": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "unavailable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unavailable" + } + } + } + }, + "com.amazonaws.ec2#FpgaInfo": { + "type": "structure", + "members": { + "Fpgas": { + "target": "com.amazonaws.ec2#FpgaDeviceInfoList", + "traits": { + "aws.protocols#ec2QueryName": "Fpgas", + "smithy.api#documentation": "

Describes the FPGAs for the instance type.

", + "smithy.api#xmlName": "fpgas" + } + }, + "TotalFpgaMemoryInMiB": { + "target": "com.amazonaws.ec2#totalFpgaMemory", + "traits": { + "aws.protocols#ec2QueryName": "TotalFpgaMemoryInMiB", + "smithy.api#documentation": "

The total memory of all FPGA accelerators for the instance type.

", + "smithy.api#xmlName": "totalFpgaMemoryInMiB" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the FPGAs for the instance type.

" + } + }, + "com.amazonaws.ec2#FreeTierEligibleFlag": { + "type": "boolean" + }, + "com.amazonaws.ec2#GVCDMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 200, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#GatewayAssociationState": { + "type": "enum", + "members": { + "associated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associated" + } + }, + "not_associated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "not-associated" + } + }, + "associating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associating" + } + }, + "disassociating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociating" + } + } + } + }, + "com.amazonaws.ec2#GatewayType": { + "type": "enum", + "members": { + "ipsec_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipsec.1" + } + } + } + }, + "com.amazonaws.ec2#GetAssociatedEnclaveCertificateIamRoles": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetAssociatedEnclaveCertificateIamRolesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetAssociatedEnclaveCertificateIamRolesResult" + }, + "traits": { + "smithy.api#documentation": "

Returns the IAM roles that are associated with the specified ACM (ACM) certificate. \n\t\t\tIt also returns the name of the Amazon S3 bucket and the Amazon S3 object key where the certificate, \n\t\t\tcertificate chain, and encrypted private key bundle are stored, and the ARN of the KMS key \n\t\t\tthat's used to encrypt the private key.

" + } + }, + "com.amazonaws.ec2#GetAssociatedEnclaveCertificateIamRolesRequest": { + "type": "structure", + "members": { + "CertificateArn": { + "target": "com.amazonaws.ec2#CertificateId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the ACM certificate for which to view the associated IAM roles, encryption keys, and Amazon \n\t\t\tS3 object information.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetAssociatedEnclaveCertificateIamRolesResult": { + "type": "structure", + "members": { + "AssociatedRoles": { + "target": "com.amazonaws.ec2#AssociatedRolesList", + "traits": { + "aws.protocols#ec2QueryName": "AssociatedRoleSet", + "smithy.api#documentation": "

Information about the associated IAM roles.

", + "smithy.api#xmlName": "associatedRoleSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetAssociatedIpv6PoolCidrs": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetAssociatedIpv6PoolCidrsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetAssociatedIpv6PoolCidrsResult" + }, + "traits": { + "smithy.api#documentation": "

Gets information about the IPv6 CIDR block associations for a specified IPv6 address pool.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Ipv6CidrAssociations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetAssociatedIpv6PoolCidrsRequest": { + "type": "structure", + "members": { + "PoolId": { + "target": "com.amazonaws.ec2#Ipv6PoolEc2Id", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the IPv6 address pool.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Ipv6PoolMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetAssociatedIpv6PoolCidrsResult": { + "type": "structure", + "members": { + "Ipv6CidrAssociations": { + "target": "com.amazonaws.ec2#Ipv6CidrAssociationSet", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrAssociationSet", + "smithy.api#documentation": "

Information about the IPv6 CIDR block associations.

", + "smithy.api#xmlName": "ipv6CidrAssociationSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetAwsNetworkPerformanceData": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetAwsNetworkPerformanceDataRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetAwsNetworkPerformanceDataResult" + }, + "traits": { + "smithy.api#documentation": "

Gets network performance data.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "DataResponses", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetAwsNetworkPerformanceDataRequest": { + "type": "structure", + "members": { + "DataQueries": { + "target": "com.amazonaws.ec2#DataQueries", + "traits": { + "smithy.api#documentation": "

A list of network performance data queries.

", + "smithy.api#xmlName": "DataQuery" + } + }, + "StartTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "smithy.api#documentation": "

The starting time for the performance data request. The starting time must be formatted\n as yyyy-mm-ddThh:mm:ss. For example, 2022-06-10T12:00:00.000Z.

" + } + }, + "EndTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "smithy.api#documentation": "

The ending time for the performance data request. The end time must be formatted as yyyy-mm-ddThh:mm:ss. For example, 2022-06-12T12:00:00.000Z.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetAwsNetworkPerformanceDataResult": { + "type": "structure", + "members": { + "DataResponses": { + "target": "com.amazonaws.ec2#DataResponses", + "traits": { + "aws.protocols#ec2QueryName": "DataResponseSet", + "smithy.api#documentation": "

The list of data responses.

", + "smithy.api#xmlName": "dataResponseSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetCapacityReservationUsage": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetCapacityReservationUsageRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetCapacityReservationUsageResult" + }, + "traits": { + "smithy.api#documentation": "

Gets usage information about a Capacity Reservation. If the Capacity Reservation is shared, it shows usage information for the Capacity Reservation owner \n\t\t\tand each Amazon Web Services account that is currently using the shared capacity. If the Capacity Reservation is not shared, it shows only \n\t\t\tthe Capacity Reservation owner's usage.

" + } + }, + "com.amazonaws.ec2#GetCapacityReservationUsageRequest": { + "type": "structure", + "members": { + "CapacityReservationId": { + "target": "com.amazonaws.ec2#CapacityReservationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Capacity Reservation.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#GetCapacityReservationUsageRequestMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#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.

\n

Valid range: Minimum value of 1. Maximum value of 1000.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetCapacityReservationUsageRequestMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#GetCapacityReservationUsageResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "CapacityReservationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationId", + "smithy.api#documentation": "

The ID of the Capacity Reservation.

", + "smithy.api#xmlName": "capacityReservationId" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The type of instance for which the Capacity Reservation reserves capacity.

", + "smithy.api#xmlName": "instanceType" + } + }, + "TotalInstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TotalInstanceCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of instances for which the Capacity Reservation reserves capacity.

", + "smithy.api#xmlName": "totalInstanceCount" + } + }, + "AvailableInstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "AvailableInstanceCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.

", + "smithy.api#xmlName": "availableInstanceCount" + } + }, + "State": { + "target": "com.amazonaws.ec2#CapacityReservationState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

\n ", + "smithy.api#xmlName": "state" + } + }, + "InstanceUsages": { + "target": "com.amazonaws.ec2#InstanceUsageSet", + "traits": { + "aws.protocols#ec2QueryName": "InstanceUsageSet", + "smithy.api#documentation": "

Information about the Capacity Reservation usage.

", + "smithy.api#xmlName": "instanceUsageSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetCoipPoolUsage": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetCoipPoolUsageRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetCoipPoolUsageResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the allocations from the specified customer-owned address pool.

" + } + }, + "com.amazonaws.ec2#GetCoipPoolUsageRequest": { + "type": "structure", + "members": { + "PoolId": { + "target": "com.amazonaws.ec2#Ipv4PoolCoipId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the address pool.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#CoipPoolMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetCoipPoolUsageResult": { + "type": "structure", + "members": { + "CoipPoolId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CoipPoolId", + "smithy.api#documentation": "

The ID of the customer-owned address pool.

", + "smithy.api#xmlName": "coipPoolId" + } + }, + "CoipAddressUsages": { + "target": "com.amazonaws.ec2#CoipAddressUsageSet", + "traits": { + "aws.protocols#ec2QueryName": "CoipAddressUsageSet", + "smithy.api#documentation": "

Information about the address usage.

", + "smithy.api#xmlName": "coipAddressUsageSet" + } + }, + "LocalGatewayRouteTableId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableId", + "smithy.api#documentation": "

The ID of the local gateway route table.

", + "smithy.api#xmlName": "localGatewayRouteTableId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetConsoleOutput": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetConsoleOutputRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetConsoleOutputResult" + }, + "traits": { + "smithy.api#documentation": "

Gets the console output for the specified instance. For Linux instances, the instance\n console output displays the exact console output that would normally be displayed on a\n physical monitor attached to a computer. For Windows instances, the instance console\n output includes the last three system event log errors.

\n

By default, the console output returns buffered information that was posted shortly\n after an instance transition state (start, stop, reboot, or terminate). This information\n is available for at least one hour after the most recent post. Only the most recent 64\n KB of console output is available.

\n

You can optionally retrieve the latest serial console output at any time during the\n instance lifecycle. This option is supported on instance types that use the Nitro\n hypervisor.

\n

For more information, see Instance\n console output in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#GetConsoleOutputRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Latest": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

When enabled, retrieves the latest console output for the instance.

\n

Default: disabled (false)

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetConsoleOutputResult": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "Output": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Output", + "smithy.api#documentation": "

The console output, base64-encoded. If you are using a command line tool, the tool\n decodes the output for you.

", + "smithy.api#xmlName": "output" + } + }, + "Timestamp": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "Timestamp", + "smithy.api#documentation": "

The time at which the output was last updated.

", + "smithy.api#xmlName": "timestamp" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetConsoleScreenshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetConsoleScreenshotRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetConsoleScreenshotResult" + }, + "traits": { + "smithy.api#documentation": "

Retrieve a JPG-format screenshot of a running instance to help with\n troubleshooting.

\n

The returned content is Base64-encoded.

" + } + }, + "com.amazonaws.ec2#GetConsoleScreenshotRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {} + } + }, + "WakeUp": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

When set to true, acts as keystroke input and wakes up an instance that's\n in standby or \"sleep\" mode.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetConsoleScreenshotResult": { + "type": "structure", + "members": { + "ImageData": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageData", + "smithy.api#documentation": "

The data that comprises the image.

", + "smithy.api#xmlName": "imageData" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetDefaultCreditSpecification": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetDefaultCreditSpecificationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetDefaultCreditSpecificationResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the default credit option for CPU usage of a burstable performance instance\n family.

\n

For more information, see Burstable\n performance instances in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#GetDefaultCreditSpecificationRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "InstanceFamily": { + "target": "com.amazonaws.ec2#UnlimitedSupportedInstanceFamily", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The instance family.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetDefaultCreditSpecificationResult": { + "type": "structure", + "members": { + "InstanceFamilyCreditSpecification": { + "target": "com.amazonaws.ec2#InstanceFamilyCreditSpecification", + "traits": { + "aws.protocols#ec2QueryName": "InstanceFamilyCreditSpecification", + "smithy.api#documentation": "

The default credit option for CPU usage of the instance family.

", + "smithy.api#xmlName": "instanceFamilyCreditSpecification" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetEbsDefaultKmsKeyId": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetEbsDefaultKmsKeyIdRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetEbsDefaultKmsKeyIdResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the default KMS key for EBS encryption by default for your account in this Region. \n \t\tYou can change the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId or\n ResetEbsDefaultKmsKeyId.

\n

For more information, see Amazon EBS encryption\n in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#GetEbsDefaultKmsKeyIdRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetEbsDefaultKmsKeyIdResult": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KmsKeyId", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the default KMS key for encryption by default.

", + "smithy.api#xmlName": "kmsKeyId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetEbsEncryptionByDefault": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetEbsEncryptionByDefaultRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetEbsEncryptionByDefaultResult" + }, + "traits": { + "smithy.api#documentation": "

Describes whether EBS encryption by default is enabled for your account in the current\n Region.

\n

For more information, see Amazon EBS encryption\n in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#GetEbsEncryptionByDefaultRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetEbsEncryptionByDefaultResult": { + "type": "structure", + "members": { + "EbsEncryptionByDefault": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EbsEncryptionByDefault", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether encryption by default is enabled.

", + "smithy.api#xmlName": "ebsEncryptionByDefault" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetFlowLogsIntegrationTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetFlowLogsIntegrationTemplateRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetFlowLogsIntegrationTemplateResult" + }, + "traits": { + "smithy.api#documentation": "

Generates a CloudFormation template that streamlines and automates the integration of VPC flow logs \n with Amazon Athena. This make it easier for you to query and gain insights from VPC flow logs data. \n Based on the information that you provide, we configure resources in the template to do the following:

\n " + } + }, + "com.amazonaws.ec2#GetFlowLogsIntegrationTemplateRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "FlowLogId": { + "target": "com.amazonaws.ec2#VpcFlowLogId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the flow log.

", + "smithy.api#required": {} + } + }, + "ConfigDeliveryS3DestinationArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

To store the CloudFormation template in Amazon S3, specify the location in Amazon S3.

", + "smithy.api#required": {} + } + }, + "IntegrateServices": { + "target": "com.amazonaws.ec2#IntegrateServices", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Information about the service integration.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "IntegrateService" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetFlowLogsIntegrationTemplateResult": { + "type": "structure", + "members": { + "Result": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Result", + "smithy.api#documentation": "

The generated CloudFormation template.

", + "smithy.api#xmlName": "result" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetGroupsForCapacityReservation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetGroupsForCapacityReservationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetGroupsForCapacityReservationResult" + }, + "traits": { + "smithy.api#documentation": "

Lists the resource groups to which a Capacity Reservation has been added.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CapacityReservationGroups", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetGroupsForCapacityReservationRequest": { + "type": "structure", + "members": { + "CapacityReservationId": { + "target": "com.amazonaws.ec2#CapacityReservationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Capacity Reservation. If you specify a Capacity Reservation that is shared \n\t\t\twith you, the operation returns only Capacity Reservation groups that you own.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#GetGroupsForCapacityReservationRequestMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#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.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetGroupsForCapacityReservationRequestMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#GetGroupsForCapacityReservationResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "CapacityReservationGroups": { + "target": "com.amazonaws.ec2#CapacityReservationGroupSet", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationGroupSet", + "smithy.api#documentation": "

Information about the resource groups to which the Capacity Reservation has been added.

", + "smithy.api#xmlName": "capacityReservationGroupSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetHostReservationPurchasePreview": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetHostReservationPurchasePreviewRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetHostReservationPurchasePreviewResult" + }, + "traits": { + "smithy.api#documentation": "

Preview a reservation purchase with configurations that match those of your Dedicated\n Host. You must have active Dedicated Hosts in your account before you purchase a\n reservation.

\n

This is a preview of the PurchaseHostReservation action and does not\n result in the offering being purchased.

" + } + }, + "com.amazonaws.ec2#GetHostReservationPurchasePreviewRequest": { + "type": "structure", + "members": { + "HostIdSet": { + "target": "com.amazonaws.ec2#RequestHostIdSet", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the Dedicated Hosts with which the reservation is associated.

", + "smithy.api#required": {} + } + }, + "OfferingId": { + "target": "com.amazonaws.ec2#OfferingId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The offering ID of the reservation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetHostReservationPurchasePreviewResult": { + "type": "structure", + "members": { + "CurrencyCode": { + "target": "com.amazonaws.ec2#CurrencyCodeValues", + "traits": { + "aws.protocols#ec2QueryName": "CurrencyCode", + "smithy.api#documentation": "

The currency in which the totalUpfrontPrice and\n totalHourlyPrice amounts are specified. At this time, the only\n supported currency is USD.

", + "smithy.api#xmlName": "currencyCode" + } + }, + "Purchase": { + "target": "com.amazonaws.ec2#PurchaseSet", + "traits": { + "aws.protocols#ec2QueryName": "Purchase", + "smithy.api#documentation": "

The purchase information of the Dedicated Host reservation and the Dedicated Hosts\n associated with it.

", + "smithy.api#xmlName": "purchase" + } + }, + "TotalHourlyPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TotalHourlyPrice", + "smithy.api#documentation": "

The potential total hourly price of the reservation per hour.

", + "smithy.api#xmlName": "totalHourlyPrice" + } + }, + "TotalUpfrontPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TotalUpfrontPrice", + "smithy.api#documentation": "

The potential total upfront price. This is billed immediately.

", + "smithy.api#xmlName": "totalUpfrontPrice" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetInstanceTypesFromInstanceRequirements": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetInstanceTypesFromInstanceRequirementsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetInstanceTypesFromInstanceRequirementsResult" + }, + "traits": { + "smithy.api#documentation": "

Returns a list of instance types with the specified instance attributes. You can\n use the response to preview the instance types without launching instances. Note\n that the response does not consider capacity.

\n

When you specify multiple parameters, you get instance types that satisfy all of the\n specified parameters. If you specify multiple values for a parameter, you get instance\n types that satisfy any of the specified values.

\n

For more information, see Preview instance types with specified attributes, Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot\n placement score in the Amazon EC2 User Guide, and Creating an\n Auto Scaling group using attribute-based instance type selection in the\n Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InstanceTypes", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetInstanceTypesFromInstanceRequirementsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ArchitectureTypes": { + "target": "com.amazonaws.ec2#ArchitectureTypeSet", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The processor architecture type.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "ArchitectureType" + } + }, + "VirtualizationTypes": { + "target": "com.amazonaws.ec2#VirtualizationTypeSet", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The virtualization type.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "VirtualizationType" + } + }, + "InstanceRequirements": { + "target": "com.amazonaws.ec2#InstanceRequirementsRequest", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The attributes required for the instance types.

", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetInstanceTypesFromInstanceRequirementsResult": { + "type": "structure", + "members": { + "InstanceTypes": { + "target": "com.amazonaws.ec2#InstanceTypeInfoFromInstanceRequirementsSet", + "traits": { + "aws.protocols#ec2QueryName": "InstanceTypeSet", + "smithy.api#documentation": "

The instance types with the specified instance attributes.

", + "smithy.api#xmlName": "instanceTypeSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetInstanceUefiData": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetInstanceUefiDataRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetInstanceUefiDataResult" + }, + "traits": { + "smithy.api#documentation": "

A binary representation of the UEFI variable store. Only non-volatile variables are\n stored. This is a base64 encoded and zlib compressed binary value that must be properly\n encoded.

\n

When you use register-image to create\n an AMI, you can create an exact copy of your variable store by passing the UEFI data in\n the UefiData parameter. You can modify the UEFI data by using the python-uefivars tool on\n GitHub. You can use the tool to convert the UEFI data into a human-readable format\n (JSON), which you can inspect and modify, and then convert back into the binary format\n to use with register-image.

\n

For more information, see UEFI Secure Boot in the\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#GetInstanceUefiDataRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance from which to retrieve the UEFI data.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "InstanceId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetInstanceUefiDataResult": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance from which to retrieve the UEFI data.

", + "smithy.api#xmlName": "instanceId" + } + }, + "UefiData": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UefiData", + "smithy.api#documentation": "

Base64 representation of the non-volatile UEFI variable store.

", + "smithy.api#xmlName": "uefiData" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetIpamAddressHistory": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetIpamAddressHistoryRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetIpamAddressHistoryResult" + }, + "traits": { + "smithy.api#documentation": "

Retrieve historical information about a CIDR within an IPAM scope. For more information, see View the history of IP addresses in the Amazon VPC IPAM User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "HistoryRecords", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetIpamAddressHistoryRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The CIDR you want the history of. The CIDR can be an IPv4 or IPv6 IP address range. \n If you enter a /16 IPv4 CIDR, you will get records that match it exactly. You will not get records for any subnets within the /16 CIDR.

", + "smithy.api#required": {} + } + }, + "IpamScopeId": { + "target": "com.amazonaws.ec2#IpamScopeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the IPAM scope that the CIDR is in.

", + "smithy.api#required": {} + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of the VPC you want your history records filtered by.

" + } + }, + "StartTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "smithy.api#documentation": "

The start of the time period for which you are looking for history. If you omit this option, it will default to the value of EndTime.

" + } + }, + "EndTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "smithy.api#documentation": "

The end of the time period for which you are looking for history. If you omit this option, it will default to the current time.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#IpamAddressHistoryMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of historical results you would like returned per page. Defaults to 100.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetIpamAddressHistoryResult": { + "type": "structure", + "members": { + "HistoryRecords": { + "target": "com.amazonaws.ec2#IpamAddressHistoryRecordSet", + "traits": { + "aws.protocols#ec2QueryName": "HistoryRecordSet", + "smithy.api#documentation": "

A historical record for a CIDR within an IPAM scope. If the CIDR is associated with an EC2 instance, you will see an object in the response for the instance and one for the network interface.

", + "smithy.api#xmlName": "historyRecordSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetIpamDiscoveredAccounts": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetIpamDiscoveredAccountsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetIpamDiscoveredAccountsResult" + }, + "traits": { + "smithy.api#documentation": "

Gets IPAM discovered accounts. A discovered account is an Amazon Web Services account that is monitored under a resource discovery. If you have integrated IPAM with Amazon Web Services Organizations, all accounts in the organization are discovered accounts. Only the IPAM account can get all discovered accounts in the organization.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "IpamDiscoveredAccounts", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetIpamDiscoveredAccountsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamResourceDiscoveryId": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A resource discovery ID.

", + "smithy.api#required": {} + } + }, + "DiscoveryRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Web Services Region that the account information is returned from.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

Discovered account filters.

", + "smithy.api#xmlName": "Filter" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#IpamMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of discovered accounts to return in one page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetIpamDiscoveredAccountsResult": { + "type": "structure", + "members": { + "IpamDiscoveredAccounts": { + "target": "com.amazonaws.ec2#IpamDiscoveredAccountSet", + "traits": { + "aws.protocols#ec2QueryName": "IpamDiscoveredAccountSet", + "smithy.api#documentation": "

Discovered accounts.

", + "smithy.api#xmlName": "ipamDiscoveredAccountSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetIpamDiscoveredResourceCidrs": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetIpamDiscoveredResourceCidrsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetIpamDiscoveredResourceCidrsResult" + }, + "traits": { + "smithy.api#documentation": "

Returns the resource CIDRs that are monitored as part of a resource discovery. A discovered resource is a resource CIDR monitored under a resource discovery. The following resources can be discovered: VPCs, Public IPv4 pools, VPC subnets, and Elastic IP addresses.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "IpamDiscoveredResourceCidrs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetIpamDiscoveredResourceCidrsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamResourceDiscoveryId": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A resource discovery ID.

", + "smithy.api#required": {} + } + }, + "ResourceRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A resource Region.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

Filters.

", + "smithy.api#xmlName": "Filter" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#IpamMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of discovered resource CIDRs to return in one page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetIpamDiscoveredResourceCidrsResult": { + "type": "structure", + "members": { + "IpamDiscoveredResourceCidrs": { + "target": "com.amazonaws.ec2#IpamDiscoveredResourceCidrSet", + "traits": { + "aws.protocols#ec2QueryName": "IpamDiscoveredResourceCidrSet", + "smithy.api#documentation": "

Discovered resource CIDRs.

", + "smithy.api#xmlName": "ipamDiscoveredResourceCidrSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetIpamPoolAllocations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetIpamPoolAllocationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetIpamPoolAllocationsResult" + }, + "traits": { + "smithy.api#documentation": "

Get a list of all the CIDR allocations in an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the Amazon Web Services Region where this IPAM pool is available for allocations.

\n \n

If you use this action after AllocateIpamPoolCidr or ReleaseIpamPoolAllocation, note that all EC2 API actions follow an eventual consistency model.

\n ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "IpamPoolAllocations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetIpamPoolAllocationsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1000, + "max": 100000 + } + } + }, + "com.amazonaws.ec2#GetIpamPoolAllocationsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the IPAM pool you want to see the allocations for.

", + "smithy.api#required": {} + } + }, + "IpamPoolAllocationId": { + "target": "com.amazonaws.ec2#IpamPoolAllocationId", + "traits": { + "smithy.api#documentation": "

The ID of the allocation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters for the request. For more information about filtering, see Filtering CLI output.

", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#GetIpamPoolAllocationsMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results you would like returned per page.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetIpamPoolAllocationsResult": { + "type": "structure", + "members": { + "IpamPoolAllocations": { + "target": "com.amazonaws.ec2#IpamPoolAllocationSet", + "traits": { + "aws.protocols#ec2QueryName": "IpamPoolAllocationSet", + "smithy.api#documentation": "

The IPAM pool allocations you want information on.

", + "smithy.api#xmlName": "ipamPoolAllocationSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetIpamPoolCidrs": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetIpamPoolCidrsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetIpamPoolCidrsResult" + }, + "traits": { + "smithy.api#documentation": "

Get the CIDRs provisioned to an IPAM pool.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "IpamPoolCidrs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetIpamPoolCidrsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the IPAM pool you want the CIDR for.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters for the request. For more information about filtering, see Filtering CLI output.

", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#IpamMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return in the request.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetIpamPoolCidrsResult": { + "type": "structure", + "members": { + "IpamPoolCidrs": { + "target": "com.amazonaws.ec2#IpamPoolCidrSet", + "traits": { + "aws.protocols#ec2QueryName": "IpamPoolCidrSet", + "smithy.api#documentation": "

Information about the CIDRs provisioned to an IPAM pool.

", + "smithy.api#xmlName": "ipamPoolCidrSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetIpamResourceCidrs": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetIpamResourceCidrsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetIpamResourceCidrsResult" + }, + "traits": { + "smithy.api#documentation": "

Returns resource CIDRs managed by IPAM in a given scope. If an IPAM is associated with more than one resource discovery, the resource CIDRs across all of the resource discoveries is returned. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "IpamResourceCidrs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetIpamResourceCidrsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters for the request. For more information about filtering, see Filtering CLI output.

", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#IpamMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return in the request.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "IpamScopeId": { + "target": "com.amazonaws.ec2#IpamScopeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the scope that the resource is in.

", + "smithy.api#required": {} + } + }, + "IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#documentation": "

The ID of the IPAM pool that the resource is in.

" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of the resource.

" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#IpamResourceType", + "traits": { + "smithy.api#documentation": "

The resource type.

" + } + }, + "ResourceTag": { + "target": "com.amazonaws.ec2#RequestIpamResourceTag", + "traits": { + "smithy.api#documentation": "

The resource tag.

" + } + }, + "ResourceOwner": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the resource.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetIpamResourceCidrsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "IpamResourceCidrs": { + "target": "com.amazonaws.ec2#IpamResourceCidrSet", + "traits": { + "aws.protocols#ec2QueryName": "IpamResourceCidrSet", + "smithy.api#documentation": "

The resource CIDRs.

", + "smithy.api#xmlName": "ipamResourceCidrSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetLaunchTemplateData": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetLaunchTemplateDataRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetLaunchTemplateDataResult" + }, + "traits": { + "smithy.api#documentation": "

Retrieves the configuration data of the specified instance. You can use this data to\n create a launch template.

\n

This action calls on other describe actions to get instance information. Depending on\n your instance configuration, you may need to allow the following actions in your IAM\n policy: DescribeSpotInstanceRequests,\n DescribeInstanceCreditSpecifications, DescribeVolumes,\n DescribeInstanceAttribute, and DescribeElasticGpus. Or,\n you can allow describe* depending on your instance requirements.

" + } + }, + "com.amazonaws.ec2#GetLaunchTemplateDataRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetLaunchTemplateDataResult": { + "type": "structure", + "members": { + "LaunchTemplateData": { + "target": "com.amazonaws.ec2#ResponseLaunchTemplateData", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateData", + "smithy.api#documentation": "

The instance data.

", + "smithy.api#xmlName": "launchTemplateData" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetManagedPrefixListAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetManagedPrefixListAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetManagedPrefixListAssociationsResult" + }, + "traits": { + "smithy.api#documentation": "

Gets information about the resources that are associated with the specified managed prefix list.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PrefixListAssociations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetManagedPrefixListAssociationsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 255 + } + } + }, + "com.amazonaws.ec2#GetManagedPrefixListAssociationsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "PrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the prefix list.

", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#GetManagedPrefixListAssociationsMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetManagedPrefixListAssociationsResult": { + "type": "structure", + "members": { + "PrefixListAssociations": { + "target": "com.amazonaws.ec2#PrefixListAssociationSet", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListAssociationSet", + "smithy.api#documentation": "

Information about the associations.

", + "smithy.api#xmlName": "prefixListAssociationSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetManagedPrefixListEntries": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetManagedPrefixListEntriesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetManagedPrefixListEntriesResult" + }, + "traits": { + "smithy.api#documentation": "

Gets information about the entries for a specified managed prefix list.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Entries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetManagedPrefixListEntriesRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "PrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the prefix list.

", + "smithy.api#required": {} + } + }, + "TargetVersion": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The version of the prefix list for which to return the entries. The default is the current version.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#PrefixListMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetManagedPrefixListEntriesResult": { + "type": "structure", + "members": { + "Entries": { + "target": "com.amazonaws.ec2#PrefixListEntrySet", + "traits": { + "aws.protocols#ec2QueryName": "EntrySet", + "smithy.api#documentation": "

Information about the prefix list entries.

", + "smithy.api#xmlName": "entrySet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetNetworkInsightsAccessScopeAnalysisFindings": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetNetworkInsightsAccessScopeAnalysisFindingsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetNetworkInsightsAccessScopeAnalysisFindingsResult" + }, + "traits": { + "smithy.api#documentation": "

Gets the findings for the specified Network Access Scope analysis.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AnalysisFindings", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetNetworkInsightsAccessScopeAnalysisFindingsRequest": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeAnalysisId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Network Access Scope analysis.

", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#NetworkInsightsMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetNetworkInsightsAccessScopeAnalysisFindingsResult": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeAnalysisId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeAnalysisId", + "smithy.api#documentation": "

The ID of the Network Access Scope analysis.

", + "smithy.api#xmlName": "networkInsightsAccessScopeAnalysisId" + } + }, + "AnalysisStatus": { + "target": "com.amazonaws.ec2#AnalysisStatus", + "traits": { + "aws.protocols#ec2QueryName": "AnalysisStatus", + "smithy.api#documentation": "

The status of Network Access Scope Analysis.

", + "smithy.api#xmlName": "analysisStatus" + } + }, + "AnalysisFindings": { + "target": "com.amazonaws.ec2#AccessScopeAnalysisFindingList", + "traits": { + "aws.protocols#ec2QueryName": "AnalysisFindingSet", + "smithy.api#documentation": "

The findings associated with Network Access Scope Analysis.

", + "smithy.api#xmlName": "analysisFindingSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetNetworkInsightsAccessScopeContent": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetNetworkInsightsAccessScopeContentRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetNetworkInsightsAccessScopeContentResult" + }, + "traits": { + "smithy.api#documentation": "

Gets the content for the specified Network Access Scope.

" + } + }, + "com.amazonaws.ec2#GetNetworkInsightsAccessScopeContentRequest": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Network Access Scope.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetNetworkInsightsAccessScopeContentResult": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeContent": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeContent", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeContent", + "smithy.api#documentation": "

The Network Access Scope content.

", + "smithy.api#xmlName": "networkInsightsAccessScopeContent" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetPasswordData": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetPasswordDataRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetPasswordDataResult" + }, + "traits": { + "smithy.api#documentation": "

Retrieves the encrypted administrator password for a running Windows instance.

\n

The Windows password is generated at boot by the EC2Config service or\n EC2Launch scripts (Windows Server 2016 and later). This usually only\n happens the first time an instance is launched. For more information, see EC2Config and EC2Launch in the\n Amazon EC2 User Guide.

\n

For the EC2Config service, the password is not generated for rebundled\n AMIs unless Ec2SetPassword is enabled before bundling.

\n

The password is encrypted using the key pair that you specified when you launched the\n instance. You must provide the corresponding key pair file.

\n

When you launch an instance, password generation and encryption may take a few\n minutes. If you try to retrieve the password before it's available, the output returns\n an empty string. We recommend that you wait up to 15 minutes after launching an instance\n before trying to retrieve the generated password.

", + "smithy.waiters#waitable": { + "PasswordDataAvailable": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "length(PasswordData) > `0`", + "expected": "true", + "comparator": "booleanEquals" + } + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.ec2#GetPasswordDataRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Windows instance.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetPasswordDataResult": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the Windows instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "PasswordData": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PasswordData", + "smithy.api#documentation": "

The password of the instance. Returns an empty string if the password is not\n available.

", + "smithy.api#xmlName": "passwordData" + } + }, + "Timestamp": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "Timestamp", + "smithy.api#documentation": "

The time the data was last updated.

", + "smithy.api#xmlName": "timestamp" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetReservedInstancesExchangeQuote": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetReservedInstancesExchangeQuoteRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetReservedInstancesExchangeQuoteResult" + }, + "traits": { + "smithy.api#documentation": "

Returns a quote and exchange information for exchanging one or more specified\n Convertible Reserved Instances for a new Convertible Reserved Instance. If the exchange\n cannot be performed, the reason is returned in the response. Use AcceptReservedInstancesExchangeQuote to perform the exchange.

" + } + }, + "com.amazonaws.ec2#GetReservedInstancesExchangeQuoteRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ReservedInstanceIds": { + "target": "com.amazonaws.ec2#ReservedInstanceIdSet", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the Convertible Reserved Instances to exchange.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "ReservedInstanceId" + } + }, + "TargetConfigurations": { + "target": "com.amazonaws.ec2#TargetConfigurationRequestSet", + "traits": { + "smithy.api#documentation": "

The configuration of the target Convertible Reserved Instance to exchange for your\n current Convertible Reserved Instances.

", + "smithy.api#xmlName": "TargetConfiguration" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for GetReservedInstanceExchangeQuote.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetReservedInstancesExchangeQuoteResult": { + "type": "structure", + "members": { + "CurrencyCode": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CurrencyCode", + "smithy.api#documentation": "

The currency of the transaction.

", + "smithy.api#xmlName": "currencyCode" + } + }, + "IsValidExchange": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "IsValidExchange", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

If true, the exchange is valid. If false, the exchange cannot be completed.

", + "smithy.api#xmlName": "isValidExchange" + } + }, + "OutputReservedInstancesWillExpireAt": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "OutputReservedInstancesWillExpireAt", + "smithy.api#documentation": "

The new end date of the reservation term.

", + "smithy.api#xmlName": "outputReservedInstancesWillExpireAt" + } + }, + "PaymentDue": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PaymentDue", + "smithy.api#documentation": "

The total true upfront charge for the exchange.

", + "smithy.api#xmlName": "paymentDue" + } + }, + "ReservedInstanceValueRollup": { + "target": "com.amazonaws.ec2#ReservationValue", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstanceValueRollup", + "smithy.api#documentation": "

The cost associated with the Reserved Instance.

", + "smithy.api#xmlName": "reservedInstanceValueRollup" + } + }, + "ReservedInstanceValueSet": { + "target": "com.amazonaws.ec2#ReservedInstanceReservationValueSet", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstanceValueSet", + "smithy.api#documentation": "

The configuration of your Convertible Reserved Instances.

", + "smithy.api#xmlName": "reservedInstanceValueSet" + } + }, + "TargetConfigurationValueRollup": { + "target": "com.amazonaws.ec2#ReservationValue", + "traits": { + "aws.protocols#ec2QueryName": "TargetConfigurationValueRollup", + "smithy.api#documentation": "

The cost associated with the Reserved Instance.

", + "smithy.api#xmlName": "targetConfigurationValueRollup" + } + }, + "TargetConfigurationValueSet": { + "target": "com.amazonaws.ec2#TargetReservationValueSet", + "traits": { + "aws.protocols#ec2QueryName": "TargetConfigurationValueSet", + "smithy.api#documentation": "

The values of the target Convertible Reserved Instances.

", + "smithy.api#xmlName": "targetConfigurationValueSet" + } + }, + "ValidationFailureReason": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ValidationFailureReason", + "smithy.api#documentation": "

Describes the reason why the exchange cannot be completed.

", + "smithy.api#xmlName": "validationFailureReason" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of GetReservedInstancesExchangeQuote.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetSerialConsoleAccessStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetSerialConsoleAccessStatusRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetSerialConsoleAccessStatusResult" + }, + "traits": { + "smithy.api#documentation": "

Retrieves the access status of your account to the EC2 serial console of all instances. By\n\t\t\tdefault, access to the EC2 serial console is disabled for your account. For more\n\t\t\tinformation, see Manage account access to the EC2 serial console in the Amazon EC2\n\t\t\t\tUser Guide.

" + } + }, + "com.amazonaws.ec2#GetSerialConsoleAccessStatusRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetSerialConsoleAccessStatusResult": { + "type": "structure", + "members": { + "SerialConsoleAccessEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "SerialConsoleAccessEnabled", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

If true, access to the EC2 serial console of all instances is enabled for\n\t\t\tyour account. If false, access to the EC2 serial console of all instances\n\t\t\tis disabled for your account.

", + "smithy.api#xmlName": "serialConsoleAccessEnabled" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetSpotPlacementScores": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetSpotPlacementScoresRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetSpotPlacementScoresResult" + }, + "traits": { + "smithy.api#documentation": "

Calculates the Spot placement score for a Region or Availability Zone based on the\n specified target capacity and compute requirements.

\n

You can specify your compute requirements either by using\n InstanceRequirementsWithMetadata and letting Amazon EC2 choose the optimal\n instance types to fulfill your Spot request, or you can specify the instance types by using\n InstanceTypes.

\n

For more information, see Spot placement score in\n the Amazon EC2 User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "SpotPlacementScores", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetSpotPlacementScoresRequest": { + "type": "structure", + "members": { + "InstanceTypes": { + "target": "com.amazonaws.ec2#InstanceTypes", + "traits": { + "smithy.api#documentation": "

The instance types. We recommend that you specify at least three instance types. If you\n specify one or two instance types, or specify variations of a single instance type (for\n example, an m3.xlarge with and without instance storage), the returned\n placement score will always be low.

\n

If you specify InstanceTypes, you can't specify\n InstanceRequirementsWithMetadata.

", + "smithy.api#xmlName": "InstanceType" + } + }, + "TargetCapacity": { + "target": "com.amazonaws.ec2#SpotPlacementScoresTargetCapacity", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The target capacity.

", + "smithy.api#required": {} + } + }, + "TargetCapacityUnitType": { + "target": "com.amazonaws.ec2#TargetCapacityUnitType", + "traits": { + "smithy.api#documentation": "

The unit for the target capacity.

\n

Default: units (translates to number of instances)

" + } + }, + "SingleAvailabilityZone": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Specify true so that the response returns a list of scored Availability Zones.\n Otherwise, the response returns a list of scored Regions.

\n

A list of scored Availability Zones is useful if you want to launch all of your Spot\n capacity into a single Availability Zone.

" + } + }, + "RegionNames": { + "target": "com.amazonaws.ec2#RegionNames", + "traits": { + "smithy.api#documentation": "

The Regions used to narrow down the list of Regions to be scored. Enter the Region code,\n for example, us-east-1.

", + "smithy.api#xmlName": "RegionName" + } + }, + "InstanceRequirementsWithMetadata": { + "target": "com.amazonaws.ec2#InstanceRequirementsWithMetadataRequest", + "traits": { + "smithy.api#documentation": "

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with those attributes.

\n

If you specify InstanceRequirementsWithMetadata, you can't specify\n InstanceTypes.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#SpotPlacementScoresMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetSpotPlacementScoresResult": { + "type": "structure", + "members": { + "SpotPlacementScores": { + "target": "com.amazonaws.ec2#SpotPlacementScores", + "traits": { + "aws.protocols#ec2QueryName": "SpotPlacementScoreSet", + "smithy.api#documentation": "

The Spot placement score for the top 10 Regions or Availability Zones, scored on a scale\n from 1 to 10. Each score\u2028 reflects how likely it is that each Region or Availability Zone\n will succeed at fulfilling the specified target capacity\u2028 at the time of the Spot\n placement score request. A score of 10 means that your Spot\n capacity request is highly likely to succeed in that Region or Availability Zone.

\n

If you request a Spot placement score for Regions, a high score assumes that your fleet\n request will be configured to use all Availability Zones and the\n capacity-optimized allocation strategy. If you request a Spot placement\n score for Availability Zones, a high score assumes that your fleet request will be\n configured to use a single Availability Zone and the capacity-optimized\n allocation strategy.

\n

Different\u2028 Regions or Availability Zones might return the same score.

\n \n

The Spot placement score serves as a recommendation only. No score guarantees that your\n Spot request will be fully or partially fulfilled.

\n ", + "smithy.api#xmlName": "spotPlacementScoreSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetSubnetCidrReservations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetSubnetCidrReservationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetSubnetCidrReservationsResult" + }, + "traits": { + "smithy.api#documentation": "

Gets information about the subnet CIDR reservations.

" + } + }, + "com.amazonaws.ec2#GetSubnetCidrReservationsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#GetSubnetCidrReservationsRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the subnet.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#GetSubnetCidrReservationsMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetSubnetCidrReservationsResult": { + "type": "structure", + "members": { + "SubnetIpv4CidrReservations": { + "target": "com.amazonaws.ec2#SubnetCidrReservationList", + "traits": { + "aws.protocols#ec2QueryName": "SubnetIpv4CidrReservationSet", + "smithy.api#documentation": "

Information about the IPv4 subnet CIDR reservations.

", + "smithy.api#xmlName": "subnetIpv4CidrReservationSet" + } + }, + "SubnetIpv6CidrReservations": { + "target": "com.amazonaws.ec2#SubnetCidrReservationList", + "traits": { + "aws.protocols#ec2QueryName": "SubnetIpv6CidrReservationSet", + "smithy.api#documentation": "

Information about the IPv6 subnet CIDR reservations.

", + "smithy.api#xmlName": "subnetIpv6CidrReservationSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetTransitGatewayAttachmentPropagations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetTransitGatewayAttachmentPropagationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetTransitGatewayAttachmentPropagationsResult" + }, + "traits": { + "smithy.api#documentation": "

Lists the route tables to which the specified resource attachment propagates routes.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransitGatewayAttachmentPropagations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetTransitGatewayAttachmentPropagationsRequest": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetTransitGatewayAttachmentPropagationsResult": { + "type": "structure", + "members": { + "TransitGatewayAttachmentPropagations": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentPropagationList", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentPropagations", + "smithy.api#documentation": "

Information about the propagation route tables.

", + "smithy.api#xmlName": "transitGatewayAttachmentPropagations" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetTransitGatewayMulticastDomainAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetTransitGatewayMulticastDomainAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetTransitGatewayMulticastDomainAssociationsResult" + }, + "traits": { + "smithy.api#documentation": "

Gets information about the associations for the transit gateway multicast domain.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "MulticastDomainAssociations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetTransitGatewayMulticastDomainAssociationsRequest": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetTransitGatewayMulticastDomainAssociationsResult": { + "type": "structure", + "members": { + "MulticastDomainAssociations": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainAssociationList", + "traits": { + "aws.protocols#ec2QueryName": "MulticastDomainAssociations", + "smithy.api#documentation": "

Information about the multicast domain associations.

", + "smithy.api#xmlName": "multicastDomainAssociations" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetTransitGatewayPolicyTableAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetTransitGatewayPolicyTableAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetTransitGatewayPolicyTableAssociationsResult" + }, + "traits": { + "smithy.api#documentation": "

Gets a list of the transit gateway policy table associations.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Associations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetTransitGatewayPolicyTableAssociationsRequest": { + "type": "structure", + "members": { + "TransitGatewayPolicyTableId": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway policy table.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters associated with the transit gateway policy table.

", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetTransitGatewayPolicyTableAssociationsResult": { + "type": "structure", + "members": { + "Associations": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableAssociationList", + "traits": { + "aws.protocols#ec2QueryName": "Associations", + "smithy.api#documentation": "

Returns details about the transit gateway policy table association.

", + "smithy.api#xmlName": "associations" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token for the next page of results.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetTransitGatewayPolicyTableEntries": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetTransitGatewayPolicyTableEntriesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetTransitGatewayPolicyTableEntriesResult" + }, + "traits": { + "smithy.api#documentation": "

Returns a list of transit gateway policy table entries.

" + } + }, + "com.amazonaws.ec2#GetTransitGatewayPolicyTableEntriesRequest": { + "type": "structure", + "members": { + "TransitGatewayPolicyTableId": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway policy table.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters associated with the transit gateway policy table.

", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetTransitGatewayPolicyTableEntriesResult": { + "type": "structure", + "members": { + "TransitGatewayPolicyTableEntries": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableEntryList", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayPolicyTableEntries", + "smithy.api#documentation": "

The entries for the transit gateway policy table.

", + "smithy.api#xmlName": "transitGatewayPolicyTableEntries" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetTransitGatewayPrefixListReferences": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetTransitGatewayPrefixListReferencesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetTransitGatewayPrefixListReferencesResult" + }, + "traits": { + "smithy.api#documentation": "

Gets information about the prefix list references in a specified transit gateway route table.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransitGatewayPrefixListReferences", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetTransitGatewayPrefixListReferencesRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetTransitGatewayPrefixListReferencesResult": { + "type": "structure", + "members": { + "TransitGatewayPrefixListReferences": { + "target": "com.amazonaws.ec2#TransitGatewayPrefixListReferenceSet", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayPrefixListReferenceSet", + "smithy.api#documentation": "

Information about the prefix list references.

", + "smithy.api#xmlName": "transitGatewayPrefixListReferenceSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetTransitGatewayRouteTableAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetTransitGatewayRouteTableAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetTransitGatewayRouteTableAssociationsResult" + }, + "traits": { + "smithy.api#documentation": "

Gets information about the associations for the specified transit gateway route table.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Associations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetTransitGatewayRouteTableAssociationsRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetTransitGatewayRouteTableAssociationsResult": { + "type": "structure", + "members": { + "Associations": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAssociationList", + "traits": { + "aws.protocols#ec2QueryName": "Associations", + "smithy.api#documentation": "

Information about the associations.

", + "smithy.api#xmlName": "associations" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetTransitGatewayRouteTablePropagations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetTransitGatewayRouteTablePropagationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetTransitGatewayRouteTablePropagationsResult" + }, + "traits": { + "smithy.api#documentation": "

Gets information about the route table propagations for the specified transit gateway route table.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransitGatewayRouteTablePropagations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetTransitGatewayRouteTablePropagationsRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetTransitGatewayRouteTablePropagationsResult": { + "type": "structure", + "members": { + "TransitGatewayRouteTablePropagations": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTablePropagationList", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTablePropagations", + "smithy.api#documentation": "

Information about the route table propagations.

", + "smithy.api#xmlName": "transitGatewayRouteTablePropagations" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetVerifiedAccessEndpointPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetVerifiedAccessEndpointPolicyRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetVerifiedAccessEndpointPolicyResult" + }, + "traits": { + "smithy.api#documentation": "

Get the Verified Access policy associated with the endpoint.

" + } + }, + "com.amazonaws.ec2#GetVerifiedAccessEndpointPolicyRequest": { + "type": "structure", + "members": { + "VerifiedAccessEndpointId": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access endpoint.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetVerifiedAccessEndpointPolicyResult": { + "type": "structure", + "members": { + "PolicyEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "PolicyEnabled", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

The status of the Verified Access policy.

", + "smithy.api#xmlName": "policyEnabled" + } + }, + "PolicyDocument": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PolicyDocument", + "smithy.api#documentation": "

The Verified Access policy document.

", + "smithy.api#xmlName": "policyDocument" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetVerifiedAccessGroupPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetVerifiedAccessGroupPolicyRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetVerifiedAccessGroupPolicyResult" + }, + "traits": { + "smithy.api#documentation": "

Shows the contents of the Verified Access policy associated with the group.

" + } + }, + "com.amazonaws.ec2#GetVerifiedAccessGroupPolicyRequest": { + "type": "structure", + "members": { + "VerifiedAccessGroupId": { + "target": "com.amazonaws.ec2#VerifiedAccessGroupId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access group.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetVerifiedAccessGroupPolicyResult": { + "type": "structure", + "members": { + "PolicyEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "PolicyEnabled", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

The status of the Verified Access policy.

", + "smithy.api#xmlName": "policyEnabled" + } + }, + "PolicyDocument": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PolicyDocument", + "smithy.api#documentation": "

The Verified Access policy document.

", + "smithy.api#xmlName": "policyDocument" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetVpnConnectionDeviceSampleConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetVpnConnectionDeviceSampleConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetVpnConnectionDeviceSampleConfigurationResult" + }, + "traits": { + "smithy.api#documentation": "

Download an Amazon Web Services-provided sample configuration file to be used with the customer\n gateway device specified for your Site-to-Site VPN connection.

" + } + }, + "com.amazonaws.ec2#GetVpnConnectionDeviceSampleConfigurationRequest": { + "type": "structure", + "members": { + "VpnConnectionId": { + "target": "com.amazonaws.ec2#VpnConnectionId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The VpnConnectionId specifies the Site-to-Site VPN connection used for the sample\n configuration.

", + "smithy.api#required": {} + } + }, + "VpnConnectionDeviceTypeId": { + "target": "com.amazonaws.ec2#VpnConnectionDeviceTypeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Device identifier provided by the GetVpnConnectionDeviceTypes API.

", + "smithy.api#required": {} + } + }, + "InternetKeyExchangeVersion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IKE version to be used in the sample configuration file for your customer gateway\n device. You can specify one of the following versions: ikev1 or\n ikev2.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetVpnConnectionDeviceSampleConfigurationResult": { + "type": "structure", + "members": { + "VpnConnectionDeviceSampleConfiguration": { + "target": "com.amazonaws.ec2#VpnConnectionDeviceSampleConfiguration", + "traits": { + "aws.protocols#ec2QueryName": "VpnConnectionDeviceSampleConfiguration", + "smithy.api#documentation": "

Sample configuration file for the specified customer gateway device.

", + "smithy.api#xmlName": "vpnConnectionDeviceSampleConfiguration" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetVpnConnectionDeviceTypes": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetVpnConnectionDeviceTypesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetVpnConnectionDeviceTypesResult" + }, + "traits": { + "smithy.api#documentation": "

Obtain a list of customer gateway devices for which sample configuration\n files can be provided. The request has no additional parameters. You can also see the\n list of device types with sample configuration files available under Your customer gateway\n device in the Amazon Web Services Site-to-Site VPN User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "VpnConnectionDeviceTypes", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetVpnConnectionDeviceTypesRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.ec2#GVCDMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results returned by GetVpnConnectionDeviceTypes in\n paginated output. When this parameter is used, GetVpnConnectionDeviceTypes\n only returns MaxResults results in a single page along with a\n NextToken response element. The remaining results of the initial\n request can be seen by sending another GetVpnConnectionDeviceTypes request\n with the returned NextToken value. This value can be between 200 and 1000.\n If this parameter is not used, then GetVpnConnectionDeviceTypes returns all\n results.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The NextToken value returned from a previous paginated\n GetVpnConnectionDeviceTypes request where MaxResults was\n used and the results exceeded the value of that parameter. Pagination continues from the\n end of the previous results that returned the NextToken value. This value\n is null when there are no more results to return.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetVpnConnectionDeviceTypesResult": { + "type": "structure", + "members": { + "VpnConnectionDeviceTypes": { + "target": "com.amazonaws.ec2#VpnConnectionDeviceTypeList", + "traits": { + "aws.protocols#ec2QueryName": "VpnConnectionDeviceTypeSet", + "smithy.api#documentation": "

List of customer gateway devices that have a sample configuration file available for\n use.

", + "smithy.api#xmlName": "vpnConnectionDeviceTypeSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The NextToken value to include in a future\n GetVpnConnectionDeviceTypes request. When the results of a\n GetVpnConnectionDeviceTypes request exceed MaxResults,\n this value can be used to retrieve the next page of results. This value is null when\n there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GetVpnTunnelReplacementStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetVpnTunnelReplacementStatusRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetVpnTunnelReplacementStatusResult" + }, + "traits": { + "smithy.api#documentation": "

Get details of available tunnel endpoint maintenance.

" + } + }, + "com.amazonaws.ec2#GetVpnTunnelReplacementStatusRequest": { + "type": "structure", + "members": { + "VpnConnectionId": { + "target": "com.amazonaws.ec2#VpnConnectionId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Site-to-Site VPN connection.

", + "smithy.api#required": {} + } + }, + "VpnTunnelOutsideIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The external IP address of the VPN tunnel.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#GetVpnTunnelReplacementStatusResult": { + "type": "structure", + "members": { + "VpnConnectionId": { + "target": "com.amazonaws.ec2#VpnConnectionId", + "traits": { + "aws.protocols#ec2QueryName": "VpnConnectionId", + "smithy.api#documentation": "

The ID of the Site-to-Site VPN connection.

", + "smithy.api#xmlName": "vpnConnectionId" + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayId", + "smithy.api#documentation": "

The ID of the transit gateway associated with the VPN connection.

", + "smithy.api#xmlName": "transitGatewayId" + } + }, + "CustomerGatewayId": { + "target": "com.amazonaws.ec2#CustomerGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "CustomerGatewayId", + "smithy.api#documentation": "

The ID of the customer gateway.

", + "smithy.api#xmlName": "customerGatewayId" + } + }, + "VpnGatewayId": { + "target": "com.amazonaws.ec2#VpnGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "VpnGatewayId", + "smithy.api#documentation": "

The ID of the virtual private gateway.

", + "smithy.api#xmlName": "vpnGatewayId" + } + }, + "VpnTunnelOutsideIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpnTunnelOutsideIpAddress", + "smithy.api#documentation": "

The external IP address of the VPN tunnel.

", + "smithy.api#xmlName": "vpnTunnelOutsideIpAddress" + } + }, + "MaintenanceDetails": { + "target": "com.amazonaws.ec2#MaintenanceDetails", + "traits": { + "aws.protocols#ec2QueryName": "MaintenanceDetails", + "smithy.api#documentation": "

Get details of pending tunnel endpoint maintenance.

", + "smithy.api#xmlName": "maintenanceDetails" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#GpuDeviceCount": { + "type": "integer" + }, + "com.amazonaws.ec2#GpuDeviceInfo": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.ec2#GpuDeviceName", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The name of the GPU accelerator.

", + "smithy.api#xmlName": "name" + } + }, + "Manufacturer": { + "target": "com.amazonaws.ec2#GpuDeviceManufacturerName", + "traits": { + "aws.protocols#ec2QueryName": "Manufacturer", + "smithy.api#documentation": "

The manufacturer of the GPU accelerator.

", + "smithy.api#xmlName": "manufacturer" + } + }, + "Count": { + "target": "com.amazonaws.ec2#GpuDeviceCount", + "traits": { + "aws.protocols#ec2QueryName": "Count", + "smithy.api#documentation": "

The number of GPUs for the instance type.

", + "smithy.api#xmlName": "count" + } + }, + "MemoryInfo": { + "target": "com.amazonaws.ec2#GpuDeviceMemoryInfo", + "traits": { + "aws.protocols#ec2QueryName": "MemoryInfo", + "smithy.api#documentation": "

Describes the memory available to the GPU accelerator.

", + "smithy.api#xmlName": "memoryInfo" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the GPU accelerators for the instance type.

" + } + }, + "com.amazonaws.ec2#GpuDeviceInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#GpuDeviceInfo", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#GpuDeviceManufacturerName": { + "type": "string" + }, + "com.amazonaws.ec2#GpuDeviceMemoryInfo": { + "type": "structure", + "members": { + "SizeInMiB": { + "target": "com.amazonaws.ec2#GpuDeviceMemorySize", + "traits": { + "aws.protocols#ec2QueryName": "SizeInMiB", + "smithy.api#documentation": "

The size of the memory available to the GPU accelerator, in MiB.

", + "smithy.api#xmlName": "sizeInMiB" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the memory available to the GPU accelerator.

" + } + }, + "com.amazonaws.ec2#GpuDeviceMemorySize": { + "type": "integer" + }, + "com.amazonaws.ec2#GpuDeviceName": { + "type": "string" + }, + "com.amazonaws.ec2#GpuInfo": { + "type": "structure", + "members": { + "Gpus": { + "target": "com.amazonaws.ec2#GpuDeviceInfoList", + "traits": { + "aws.protocols#ec2QueryName": "Gpus", + "smithy.api#documentation": "

Describes the GPU accelerators for the instance type.

", + "smithy.api#xmlName": "gpus" + } + }, + "TotalGpuMemoryInMiB": { + "target": "com.amazonaws.ec2#totalGpuMemory", + "traits": { + "aws.protocols#ec2QueryName": "TotalGpuMemoryInMiB", + "smithy.api#documentation": "

The total size of the memory for the GPU accelerators for the instance type, in MiB.

", + "smithy.api#xmlName": "totalGpuMemoryInMiB" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the GPU accelerators for the instance type.

" + } + }, + "com.amazonaws.ec2#GroupIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "smithy.api#xmlName": "groupId" + } + } + }, + "com.amazonaws.ec2#GroupIdentifier": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

The name of the security group.

", + "smithy.api#xmlName": "groupName" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The ID of the security group.

", + "smithy.api#xmlName": "groupId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a security group.

" + } + }, + "com.amazonaws.ec2#GroupIdentifierList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#GroupIdentifier", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#GroupIdentifierSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroupIdentifier", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#GroupIds": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#GroupNameStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroupName", + "traits": { + "smithy.api#xmlName": "GroupName" + } + } + }, + "com.amazonaws.ec2#HibernationFlag": { + "type": "boolean" + }, + "com.amazonaws.ec2#HibernationOptions": { + "type": "structure", + "members": { + "Configured": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Configured", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

If this parameter is set to true, your instance is enabled for\n hibernation; otherwise, it is not enabled for hibernation.

", + "smithy.api#xmlName": "configured" + } + } + }, + "traits": { + "smithy.api#documentation": "

Indicates whether your instance is configured for hibernation. This parameter is valid\n only if the instance meets the hibernation\n prerequisites. For more information, see Hibernate your instance in the\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#HibernationOptionsRequest": { + "type": "structure", + "members": { + "Configured": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

If you set this parameter to true, your instance is enabled for\n hibernation.

\n

Default: false\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Indicates whether your instance is configured for hibernation. This parameter is valid\n only if the instance meets the hibernation\n prerequisites. For more information, see Hibernate your instance in the\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#HistoryRecord": { + "type": "structure", + "members": { + "EventInformation": { + "target": "com.amazonaws.ec2#EventInformation", + "traits": { + "aws.protocols#ec2QueryName": "EventInformation", + "smithy.api#documentation": "

Information about the event.

", + "smithy.api#xmlName": "eventInformation" + } + }, + "EventType": { + "target": "com.amazonaws.ec2#EventType", + "traits": { + "aws.protocols#ec2QueryName": "EventType", + "smithy.api#documentation": "

The event type.

\n ", + "smithy.api#xmlName": "eventType" + } + }, + "Timestamp": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "Timestamp", + "smithy.api#documentation": "

The date and time of the event, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", + "smithy.api#xmlName": "timestamp" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an event in the history of the Spot Fleet request.

" + } + }, + "com.amazonaws.ec2#HistoryRecordEntry": { + "type": "structure", + "members": { + "EventInformation": { + "target": "com.amazonaws.ec2#EventInformation", + "traits": { + "aws.protocols#ec2QueryName": "EventInformation", + "smithy.api#documentation": "

Information about the event.

", + "smithy.api#xmlName": "eventInformation" + } + }, + "EventType": { + "target": "com.amazonaws.ec2#FleetEventType", + "traits": { + "aws.protocols#ec2QueryName": "EventType", + "smithy.api#documentation": "

The event type.

", + "smithy.api#xmlName": "eventType" + } + }, + "Timestamp": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "Timestamp", + "smithy.api#documentation": "

The date and time of the event, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", + "smithy.api#xmlName": "timestamp" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an event in the history of an EC2 Fleet.

" + } + }, + "com.amazonaws.ec2#HistoryRecordSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#HistoryRecordEntry", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#HistoryRecords": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#HistoryRecord", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Host": { + "type": "structure", + "members": { + "AutoPlacement": { + "target": "com.amazonaws.ec2#AutoPlacement", + "traits": { + "aws.protocols#ec2QueryName": "AutoPlacement", + "smithy.api#documentation": "

Whether auto-placement is on or off.

", + "smithy.api#xmlName": "autoPlacement" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone of the Dedicated Host.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "AvailableCapacity": { + "target": "com.amazonaws.ec2#AvailableCapacity", + "traits": { + "aws.protocols#ec2QueryName": "AvailableCapacity", + "smithy.api#documentation": "

Information about the instances running on the Dedicated Host.

", + "smithy.api#xmlName": "availableCapacity" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

", + "smithy.api#xmlName": "clientToken" + } + }, + "HostId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "HostId", + "smithy.api#documentation": "

The ID of the Dedicated Host.

", + "smithy.api#xmlName": "hostId" + } + }, + "HostProperties": { + "target": "com.amazonaws.ec2#HostProperties", + "traits": { + "aws.protocols#ec2QueryName": "HostProperties", + "smithy.api#documentation": "

The hardware specifications of the Dedicated Host.

", + "smithy.api#xmlName": "hostProperties" + } + }, + "HostReservationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "HostReservationId", + "smithy.api#documentation": "

The reservation ID of the Dedicated Host. This returns a null response if\n the Dedicated Host doesn't have an associated reservation.

", + "smithy.api#xmlName": "hostReservationId" + } + }, + "Instances": { + "target": "com.amazonaws.ec2#HostInstanceList", + "traits": { + "aws.protocols#ec2QueryName": "Instances", + "smithy.api#documentation": "

The IDs and instance type that are currently running on the Dedicated Host.

", + "smithy.api#xmlName": "instances" + } + }, + "State": { + "target": "com.amazonaws.ec2#AllocationState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The Dedicated Host's state.

", + "smithy.api#xmlName": "state" + } + }, + "AllocationTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "AllocationTime", + "smithy.api#documentation": "

The time that the Dedicated Host was allocated.

", + "smithy.api#xmlName": "allocationTime" + } + }, + "ReleaseTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "ReleaseTime", + "smithy.api#documentation": "

The time that the Dedicated Host was released.

", + "smithy.api#xmlName": "releaseTime" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the Dedicated Host.

", + "smithy.api#xmlName": "tagSet" + } + }, + "HostRecovery": { + "target": "com.amazonaws.ec2#HostRecovery", + "traits": { + "aws.protocols#ec2QueryName": "HostRecovery", + "smithy.api#documentation": "

Indicates whether host recovery is enabled or disabled for the Dedicated Host.

", + "smithy.api#xmlName": "hostRecovery" + } + }, + "AllowsMultipleInstanceTypes": { + "target": "com.amazonaws.ec2#AllowsMultipleInstanceTypes", + "traits": { + "aws.protocols#ec2QueryName": "AllowsMultipleInstanceTypes", + "smithy.api#documentation": "

Indicates whether the Dedicated Host supports multiple instance types of the same\n instance family. If the value is on, the Dedicated Host supports multiple\n instance types in the instance family. If the value is off, the Dedicated\n Host supports a single instance type only.

", + "smithy.api#xmlName": "allowsMultipleInstanceTypes" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the Dedicated Host.

", + "smithy.api#xmlName": "ownerId" + } + }, + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneId", + "smithy.api#documentation": "

The ID of the Availability Zone in which the Dedicated Host is allocated.

", + "smithy.api#xmlName": "availabilityZoneId" + } + }, + "MemberOfServiceLinkedResourceGroup": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "MemberOfServiceLinkedResourceGroup", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the Dedicated Host is in a host resource group. If memberOfServiceLinkedResourceGroup is true, the\n host is in a host resource group; otherwise, it is not.

", + "smithy.api#xmlName": "memberOfServiceLinkedResourceGroup" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutpostArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which the\n Dedicated Host is allocated.

", + "smithy.api#xmlName": "outpostArn" + } + }, + "HostMaintenance": { + "target": "com.amazonaws.ec2#HostMaintenance", + "traits": { + "aws.protocols#ec2QueryName": "HostMaintenance", + "smithy.api#documentation": "

Indicates whether host maintenance is enabled or disabled for the Dedicated\n Host.

", + "smithy.api#xmlName": "hostMaintenance" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the properties of the Dedicated Host.

" + } + }, + "com.amazonaws.ec2#HostInstance": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of instance that is running on the Dedicated Host.

", + "smithy.api#xmlName": "instanceId" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type (for example, m3.medium) of the running\n instance.

", + "smithy.api#xmlName": "instanceType" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the instance.

", + "smithy.api#xmlName": "ownerId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an instance running on a Dedicated Host.

" + } + }, + "com.amazonaws.ec2#HostInstanceList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#HostInstance", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#HostList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Host", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#HostMaintenance": { + "type": "enum", + "members": { + "on": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "on" + } + }, + "off": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "off" + } + } + } + }, + "com.amazonaws.ec2#HostOffering": { + "type": "structure", + "members": { + "CurrencyCode": { + "target": "com.amazonaws.ec2#CurrencyCodeValues", + "traits": { + "aws.protocols#ec2QueryName": "CurrencyCode", + "smithy.api#documentation": "

The currency of the offering.

", + "smithy.api#xmlName": "currencyCode" + } + }, + "Duration": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Duration", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The duration of the offering (in seconds).

", + "smithy.api#xmlName": "duration" + } + }, + "HourlyPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "HourlyPrice", + "smithy.api#documentation": "

The hourly price of the offering.

", + "smithy.api#xmlName": "hourlyPrice" + } + }, + "InstanceFamily": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceFamily", + "smithy.api#documentation": "

The instance family of the offering.

", + "smithy.api#xmlName": "instanceFamily" + } + }, + "OfferingId": { + "target": "com.amazonaws.ec2#OfferingId", + "traits": { + "aws.protocols#ec2QueryName": "OfferingId", + "smithy.api#documentation": "

The ID of the offering.

", + "smithy.api#xmlName": "offeringId" + } + }, + "PaymentOption": { + "target": "com.amazonaws.ec2#PaymentOption", + "traits": { + "aws.protocols#ec2QueryName": "PaymentOption", + "smithy.api#documentation": "

The available payment option.

", + "smithy.api#xmlName": "paymentOption" + } + }, + "UpfrontPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UpfrontPrice", + "smithy.api#documentation": "

The upfront price of the offering. Does not apply to No Upfront offerings.

", + "smithy.api#xmlName": "upfrontPrice" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the Dedicated Host Reservation offering.

" + } + }, + "com.amazonaws.ec2#HostOfferingSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#HostOffering", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#HostProperties": { + "type": "structure", + "members": { + "Cores": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Cores", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of cores on the Dedicated Host.

", + "smithy.api#xmlName": "cores" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type supported by the Dedicated Host. For example, m5.large.\n If the host supports multiple instance types, no instanceType is returned.

", + "smithy.api#xmlName": "instanceType" + } + }, + "InstanceFamily": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceFamily", + "smithy.api#documentation": "

The instance family supported by the Dedicated Host. For example,\n m5.

", + "smithy.api#xmlName": "instanceFamily" + } + }, + "Sockets": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Sockets", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of sockets on the Dedicated Host.

", + "smithy.api#xmlName": "sockets" + } + }, + "TotalVCpus": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TotalVCpus", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of vCPUs on the Dedicated Host.

", + "smithy.api#xmlName": "totalVCpus" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the properties of a Dedicated Host.

" + } + }, + "com.amazonaws.ec2#HostRecovery": { + "type": "enum", + "members": { + "on": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "on" + } + }, + "off": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "off" + } + } + } + }, + "com.amazonaws.ec2#HostReservation": { + "type": "structure", + "members": { + "Count": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Count", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of Dedicated Hosts the reservation is associated with.

", + "smithy.api#xmlName": "count" + } + }, + "CurrencyCode": { + "target": "com.amazonaws.ec2#CurrencyCodeValues", + "traits": { + "aws.protocols#ec2QueryName": "CurrencyCode", + "smithy.api#documentation": "

The currency in which the upfrontPrice and hourlyPrice\n amounts are specified. At this time, the only supported currency is\n USD.

", + "smithy.api#xmlName": "currencyCode" + } + }, + "Duration": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Duration", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The length of the reservation's term, specified in seconds. Can be 31536000 (1\n year) | 94608000 (3 years).

", + "smithy.api#xmlName": "duration" + } + }, + "End": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "End", + "smithy.api#documentation": "

The date and time that the reservation ends.

", + "smithy.api#xmlName": "end" + } + }, + "HostIdSet": { + "target": "com.amazonaws.ec2#ResponseHostIdSet", + "traits": { + "aws.protocols#ec2QueryName": "HostIdSet", + "smithy.api#documentation": "

The IDs of the Dedicated Hosts associated with the reservation.

", + "smithy.api#xmlName": "hostIdSet" + } + }, + "HostReservationId": { + "target": "com.amazonaws.ec2#HostReservationId", + "traits": { + "aws.protocols#ec2QueryName": "HostReservationId", + "smithy.api#documentation": "

The ID of the reservation that specifies the associated Dedicated Hosts.

", + "smithy.api#xmlName": "hostReservationId" + } + }, + "HourlyPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "HourlyPrice", + "smithy.api#documentation": "

The hourly price of the reservation.

", + "smithy.api#xmlName": "hourlyPrice" + } + }, + "InstanceFamily": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceFamily", + "smithy.api#documentation": "

The instance family of the Dedicated Host Reservation. The instance family on the\n Dedicated Host must be the same in order for it to benefit from the reservation.

", + "smithy.api#xmlName": "instanceFamily" + } + }, + "OfferingId": { + "target": "com.amazonaws.ec2#OfferingId", + "traits": { + "aws.protocols#ec2QueryName": "OfferingId", + "smithy.api#documentation": "

The ID of the reservation. This remains the same regardless of which Dedicated Hosts\n are associated with it.

", + "smithy.api#xmlName": "offeringId" + } + }, + "PaymentOption": { + "target": "com.amazonaws.ec2#PaymentOption", + "traits": { + "aws.protocols#ec2QueryName": "PaymentOption", + "smithy.api#documentation": "

The payment option selected for this reservation.

", + "smithy.api#xmlName": "paymentOption" + } + }, + "Start": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "Start", + "smithy.api#documentation": "

The date and time that the reservation started.

", + "smithy.api#xmlName": "start" + } + }, + "State": { + "target": "com.amazonaws.ec2#ReservationState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the reservation.

", + "smithy.api#xmlName": "state" + } + }, + "UpfrontPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UpfrontPrice", + "smithy.api#documentation": "

The upfront price of the reservation.

", + "smithy.api#xmlName": "upfrontPrice" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the Dedicated Host Reservation.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the Dedicated Host Reservation and associated Dedicated Hosts.

" + } + }, + "com.amazonaws.ec2#HostReservationId": { + "type": "string" + }, + "com.amazonaws.ec2#HostReservationIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#HostReservationId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#HostReservationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#HostReservation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#HostTenancy": { + "type": "enum", + "members": { + "dedicated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dedicated" + } + }, + "host": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "host" + } + } + } + }, + "com.amazonaws.ec2#HostnameType": { + "type": "enum", + "members": { + "ip_name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ip-name" + } + }, + "resource_name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "resource-name" + } + } + } + }, + "com.amazonaws.ec2#Hour": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 23 + } + } + }, + "com.amazonaws.ec2#HttpTokensState": { + "type": "enum", + "members": { + "optional": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "optional" + } + }, + "required": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "required" + } + } + } + }, + "com.amazonaws.ec2#HypervisorType": { + "type": "enum", + "members": { + "ovm": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ovm" + } + }, + "xen": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "xen" + } + } + } + }, + "com.amazonaws.ec2#IKEVersionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IKEVersionsListValue", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IKEVersionsListValue": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#documentation": "

The IKE version.

", + "smithy.api#xmlName": "value" + } + } + }, + "traits": { + "smithy.api#documentation": "

The internet key exchange (IKE) version permitted for the VPN tunnel.

" + } + }, + "com.amazonaws.ec2#IKEVersionsRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IKEVersionsRequestListValue", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IKEVersionsRequestListValue": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IKE version.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The IKE version that is permitted for the VPN tunnel.

" + } + }, + "com.amazonaws.ec2#IamInstanceProfile": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Arn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the instance profile.

", + "smithy.api#xmlName": "arn" + } + }, + "Id": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Id", + "smithy.api#documentation": "

The ID of the instance profile.

", + "smithy.api#xmlName": "id" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an IAM instance profile.

" + } + }, + "com.amazonaws.ec2#IamInstanceProfileAssociation": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#documentation": "

The ID of the association.

", + "smithy.api#xmlName": "associationId" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "IamInstanceProfile": { + "target": "com.amazonaws.ec2#IamInstanceProfile", + "traits": { + "aws.protocols#ec2QueryName": "IamInstanceProfile", + "smithy.api#documentation": "

The IAM instance profile.

", + "smithy.api#xmlName": "iamInstanceProfile" + } + }, + "State": { + "target": "com.amazonaws.ec2#IamInstanceProfileAssociationState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the association.

", + "smithy.api#xmlName": "state" + } + }, + "Timestamp": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "Timestamp", + "smithy.api#documentation": "

The time the IAM instance profile was associated with the instance.

", + "smithy.api#xmlName": "timestamp" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an association between an IAM instance profile and an instance.

" + } + }, + "com.amazonaws.ec2#IamInstanceProfileAssociationId": { + "type": "string" + }, + "com.amazonaws.ec2#IamInstanceProfileAssociationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IamInstanceProfileAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IamInstanceProfileAssociationState": { + "type": "enum", + "members": { + "ASSOCIATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associating" + } + }, + "ASSOCIATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associated" + } + }, + "DISASSOCIATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociating" + } + }, + "DISASSOCIATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociated" + } + } + } + }, + "com.amazonaws.ec2#IamInstanceProfileSpecification": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Arn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the instance profile.

", + "smithy.api#xmlName": "arn" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The name of the instance profile.

", + "smithy.api#xmlName": "name" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an IAM instance profile.

" + } + }, + "com.amazonaws.ec2#IcmpTypeCode": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The ICMP code. A value of -1 means all codes for the specified ICMP type.

", + "smithy.api#xmlName": "code" + } + }, + "Type": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The ICMP type. A value of -1 means all types.

", + "smithy.api#xmlName": "type" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the ICMP type and code.

" + } + }, + "com.amazonaws.ec2#IdFormat": { + "type": "structure", + "members": { + "Deadline": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "Deadline", + "smithy.api#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.

", + "smithy.api#xmlName": "deadline" + } + }, + "Resource": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Resource", + "smithy.api#documentation": "

The type of resource.

", + "smithy.api#xmlName": "resource" + } + }, + "UseLongIds": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "UseLongIds", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether longer IDs (17-character IDs) are enabled for the resource.

", + "smithy.api#xmlName": "useLongIds" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the ID format for a resource.

" + } + }, + "com.amazonaws.ec2#IdFormatList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IdFormat", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Igmpv2SupportValue": { + "type": "enum", + "members": { + "enable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enable" + } + }, + "disable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disable" + } + } + } + }, + "com.amazonaws.ec2#Image": { + "type": "structure", + "members": { + "Architecture": { + "target": "com.amazonaws.ec2#ArchitectureValues", + "traits": { + "aws.protocols#ec2QueryName": "Architecture", + "smithy.api#documentation": "

The architecture of the image.

", + "smithy.api#xmlName": "architecture" + } + }, + "CreationDate": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CreationDate", + "smithy.api#documentation": "

The date and time the image was created.

", + "smithy.api#xmlName": "creationDate" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#xmlName": "imageId" + } + }, + "ImageLocation": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageLocation", + "smithy.api#documentation": "

The location of the AMI.

", + "smithy.api#xmlName": "imageLocation" + } + }, + "ImageType": { + "target": "com.amazonaws.ec2#ImageTypeValues", + "traits": { + "aws.protocols#ec2QueryName": "ImageType", + "smithy.api#documentation": "

The type of image.

", + "smithy.api#xmlName": "imageType" + } + }, + "Public": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "IsPublic", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the image has public launch permissions. The value is true if\n\t\t\t\tthis image has public launch permissions or false\n\t\t\t\tif it has only implicit and explicit launch permissions.

", + "smithy.api#xmlName": "isPublic" + } + }, + "KernelId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KernelId", + "smithy.api#documentation": "

The kernel associated with the image, if any. Only applicable for machine images.

", + "smithy.api#xmlName": "kernelId" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageOwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the image.

", + "smithy.api#xmlName": "imageOwnerId" + } + }, + "Platform": { + "target": "com.amazonaws.ec2#PlatformValues", + "traits": { + "aws.protocols#ec2QueryName": "Platform", + "smithy.api#documentation": "

This value is set to windows for Windows AMIs; otherwise, it is blank.

", + "smithy.api#xmlName": "platform" + } + }, + "PlatformDetails": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PlatformDetails", + "smithy.api#documentation": "

The platform details associated with the billing code of the AMI. For more information,\n see Understand\n AMI billing information in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "platformDetails" + } + }, + "UsageOperation": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UsageOperation", + "smithy.api#documentation": "

The operation of the Amazon EC2 instance and the billing code that is associated with the AMI.\n usageOperation corresponds to the lineitem/Operation column on your Amazon Web Services Cost and Usage Report and in the Amazon Web Services Price\n \tList API. You can view these fields on the Instances or \n \tAMIs pages in the Amazon EC2 console, or in the responses that are \n \treturned by the DescribeImages \n \tcommand in the Amazon EC2 API, or the describe-images \n \tcommand in the CLI.

", + "smithy.api#xmlName": "usageOperation" + } + }, + "ProductCodes": { + "target": "com.amazonaws.ec2#ProductCodeList", + "traits": { + "aws.protocols#ec2QueryName": "ProductCodes", + "smithy.api#documentation": "

Any product codes associated with the AMI.

", + "smithy.api#xmlName": "productCodes" + } + }, + "RamdiskId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RamdiskId", + "smithy.api#documentation": "

The RAM disk associated with the image, if any. Only applicable for machine images.

", + "smithy.api#xmlName": "ramdiskId" + } + }, + "State": { + "target": "com.amazonaws.ec2#ImageState", + "traits": { + "aws.protocols#ec2QueryName": "ImageState", + "smithy.api#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.

", + "smithy.api#xmlName": "imageState" + } + }, + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#BlockDeviceMappingList", + "traits": { + "aws.protocols#ec2QueryName": "BlockDeviceMapping", + "smithy.api#documentation": "

Any block device mapping entries.

", + "smithy.api#xmlName": "blockDeviceMapping" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of the AMI that was provided during image creation.

", + "smithy.api#xmlName": "description" + } + }, + "EnaSupport": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnaSupport", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether enhanced networking with ENA is enabled.

", + "smithy.api#xmlName": "enaSupport" + } + }, + "Hypervisor": { + "target": "com.amazonaws.ec2#HypervisorType", + "traits": { + "aws.protocols#ec2QueryName": "Hypervisor", + "smithy.api#documentation": "

The hypervisor type of the image.

", + "smithy.api#xmlName": "hypervisor" + } + }, + "ImageOwnerAlias": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageOwnerAlias", + "smithy.api#documentation": "

The Amazon Web Services account alias (for example, amazon, self) or\n the Amazon Web Services account ID of the AMI owner.

", + "smithy.api#xmlName": "imageOwnerAlias" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The name of the AMI that was provided during image creation.

", + "smithy.api#xmlName": "name" + } + }, + "RootDeviceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RootDeviceName", + "smithy.api#documentation": "

The device name of the root device volume (for example, /dev/sda1).

", + "smithy.api#xmlName": "rootDeviceName" + } + }, + "RootDeviceType": { + "target": "com.amazonaws.ec2#DeviceType", + "traits": { + "aws.protocols#ec2QueryName": "RootDeviceType", + "smithy.api#documentation": "

The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.

", + "smithy.api#xmlName": "rootDeviceType" + } + }, + "SriovNetSupport": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SriovNetSupport", + "smithy.api#documentation": "

Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

", + "smithy.api#xmlName": "sriovNetSupport" + } + }, + "StateReason": { + "target": "com.amazonaws.ec2#StateReason", + "traits": { + "aws.protocols#ec2QueryName": "StateReason", + "smithy.api#documentation": "

The reason for the state change.

", + "smithy.api#xmlName": "stateReason" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the image.

", + "smithy.api#xmlName": "tagSet" + } + }, + "VirtualizationType": { + "target": "com.amazonaws.ec2#VirtualizationType", + "traits": { + "aws.protocols#ec2QueryName": "VirtualizationType", + "smithy.api#documentation": "

The type of virtualization of the AMI.

", + "smithy.api#xmlName": "virtualizationType" + } + }, + "BootMode": { + "target": "com.amazonaws.ec2#BootModeValues", + "traits": { + "aws.protocols#ec2QueryName": "BootMode", + "smithy.api#documentation": "

The boot mode of the image. For more information, see Boot modes in the\n Amazon EC2 User Guide.

", + "smithy.api#xmlName": "bootMode" + } + }, + "TpmSupport": { + "target": "com.amazonaws.ec2#TpmSupportValues", + "traits": { + "aws.protocols#ec2QueryName": "TpmSupport", + "smithy.api#documentation": "

If the image is configured for NitroTPM support, the value is v2.0. \n For more information, see NitroTPM in the\n Amazon EC2 User Guide.

", + "smithy.api#xmlName": "tpmSupport" + } + }, + "DeprecationTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DeprecationTime", + "smithy.api#documentation": "

The date and time to deprecate the AMI, in UTC, in the following format: \n YYYY-MM-DDTHH:MM:SSZ.\n If you specified a value for seconds, Amazon EC2 rounds the seconds to the\n nearest minute.

", + "smithy.api#xmlName": "deprecationTime" + } + }, + "ImdsSupport": { + "target": "com.amazonaws.ec2#ImdsSupportValues", + "traits": { + "aws.protocols#ec2QueryName": "ImdsSupport", + "smithy.api#documentation": "

If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched\n from this AMI will have HttpTokens automatically set to required so\n that, by default, the instance requires that IMDSv2 is used when requesting instance metadata.\n In addition, HttpPutResponseHopLimit is set to 2. For more\n information, see Configure\n the AMI in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "imdsSupport" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an image.

" + } + }, + "com.amazonaws.ec2#ImageAttribute": { + "type": "structure", + "members": { + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#BlockDeviceMappingList", + "traits": { + "aws.protocols#ec2QueryName": "BlockDeviceMapping", + "smithy.api#documentation": "

The block device mapping entries.

", + "smithy.api#xmlName": "blockDeviceMapping" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#xmlName": "imageId" + } + }, + "LaunchPermissions": { + "target": "com.amazonaws.ec2#LaunchPermissionList", + "traits": { + "aws.protocols#ec2QueryName": "LaunchPermission", + "smithy.api#documentation": "

The launch permissions.

", + "smithy.api#xmlName": "launchPermission" + } + }, + "ProductCodes": { + "target": "com.amazonaws.ec2#ProductCodeList", + "traits": { + "aws.protocols#ec2QueryName": "ProductCodes", + "smithy.api#documentation": "

The product codes.

", + "smithy.api#xmlName": "productCodes" + } + }, + "Description": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the AMI.

", + "smithy.api#xmlName": "description" + } + }, + "KernelId": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "Kernel", + "smithy.api#documentation": "

The kernel ID.

", + "smithy.api#xmlName": "kernel" + } + }, + "RamdiskId": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "Ramdisk", + "smithy.api#documentation": "

The RAM disk ID.

", + "smithy.api#xmlName": "ramdisk" + } + }, + "SriovNetSupport": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "SriovNetSupport", + "smithy.api#documentation": "

Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

", + "smithy.api#xmlName": "sriovNetSupport" + } + }, + "BootMode": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "BootMode", + "smithy.api#documentation": "

The boot mode.

", + "smithy.api#xmlName": "bootMode" + } + }, + "TpmSupport": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "TpmSupport", + "smithy.api#documentation": "

If the image is configured for NitroTPM support, the value is v2.0.

", + "smithy.api#xmlName": "tpmSupport" + } + }, + "UefiData": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "UefiData", + "smithy.api#documentation": "

Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data,\n use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the\n python-uefivars tool on\n GitHub. For more information, see UEFI Secure Boot in the\n Amazon EC2 User Guide.

", + "smithy.api#xmlName": "uefiData" + } + }, + "LastLaunchedTime": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "LastLaunchedTime", + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the AMI was last used to launch an EC2 instance. When the AMI is used\n to launch an instance, there is a 24-hour delay before that usage is reported.

\n \n

\n lastLaunchedTime data is available starting April 2017.

\n ", + "smithy.api#xmlName": "lastLaunchedTime" + } + }, + "ImdsSupport": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "ImdsSupport", + "smithy.api#documentation": "

If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched\n from this AMI will have HttpTokens automatically set to required so\n that, by default, the instance requires that IMDSv2 is used when requesting instance metadata.\n In addition, HttpPutResponseHopLimit is set to 2. For more\n information, see Configure\n the AMI in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "imdsSupport" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an image attribute.

" + } + }, + "com.amazonaws.ec2#ImageAttributeName": { + "type": "enum", + "members": { + "description": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "description" + } + }, + "kernel": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "kernel" + } + }, + "ramdisk": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ramdisk" + } + }, + "launchPermission": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "launchPermission" + } + }, + "productCodes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "productCodes" + } + }, + "blockDeviceMapping": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "blockDeviceMapping" + } + }, + "sriovNetSupport": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sriovNetSupport" + } + }, + "bootMode": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "bootMode" + } + }, + "tpmSupport": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tpmSupport" + } + }, + "uefiData": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "uefiData" + } + }, + "lastLaunchedTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lastLaunchedTime" + } + }, + "imdsSupport": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "imdsSupport" + } + } + } + }, + "com.amazonaws.ec2#ImageDiskContainer": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The description of the disk image.

" + } + }, + "DeviceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The block device mapping for the disk.

" + } + }, + "Format": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The format of the disk image being imported.

\n

Valid values: OVA | VHD | VHDX | VMDK | RAW\n

" + } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "smithy.api#documentation": "

The ID of the EBS snapshot to be used for importing the snapshot.

" + } + }, + "Url": { + "target": "com.amazonaws.ec2#SensitiveUrl", + "traits": { + "smithy.api#documentation": "

The URL to the Amazon S3-based disk image being imported. The URL can either be a https URL (https://..) or an\n Amazon S3 URL (s3://..)

" + } + }, + "UserBucket": { + "target": "com.amazonaws.ec2#UserBucket", + "traits": { + "smithy.api#documentation": "

The S3 bucket for the disk image.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the disk container object for an import image task.

" + } + }, + "com.amazonaws.ec2#ImageDiskContainerList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImageDiskContainer", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ImageId": { + "type": "string" + }, + "com.amazonaws.ec2#ImageIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ImageIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#xmlName": "ImageId" + } + } + }, + "com.amazonaws.ec2#ImageList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Image", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ImageRecycleBinInfo": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#xmlName": "imageId" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The name of the AMI.

", + "smithy.api#xmlName": "name" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of the AMI.

", + "smithy.api#xmlName": "description" + } + }, + "RecycleBinEnterTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "RecycleBinEnterTime", + "smithy.api#documentation": "

The date and time when the AMI entered the Recycle Bin.

", + "smithy.api#xmlName": "recycleBinEnterTime" + } + }, + "RecycleBinExitTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "RecycleBinExitTime", + "smithy.api#documentation": "

The date and time when the AMI is to be permanently deleted from the Recycle Bin.

", + "smithy.api#xmlName": "recycleBinExitTime" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an AMI that is currently in the Recycle Bin.

" + } + }, + "com.amazonaws.ec2#ImageRecycleBinInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImageRecycleBinInfo", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ImageState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "invalid": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "invalid" + } + }, + "deregistered": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deregistered" + } + }, + "transient": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "transient" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "error": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "error" + } + } + } + }, + "com.amazonaws.ec2#ImageTypeValues": { + "type": "enum", + "members": { + "machine": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "machine" + } + }, + "kernel": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "kernel" + } + }, + "ramdisk": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ramdisk" + } + } + } + }, + "com.amazonaws.ec2#ImdsSupportValues": { + "type": "enum", + "members": { + "v2_0": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "v2.0" + } + } + } + }, + "com.amazonaws.ec2#ImportClientVpnClientCertificateRevocationList": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ImportClientVpnClientCertificateRevocationListRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ImportClientVpnClientCertificateRevocationListResult" + }, + "traits": { + "smithy.api#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.

\n

Uploading a client certificate revocation list resets existing client connections.

" + } + }, + "com.amazonaws.ec2#ImportClientVpnClientCertificateRevocationListRequest": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Client VPN endpoint to which the client certificate revocation list applies.

", + "smithy.api#required": {} + } + }, + "CertificateRevocationList": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The client certificate revocation list file. For more information, see Generate a Client Certificate Revocation List in the\n\t\t\t\tClient VPN Administrator Guide.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ImportClientVpnClientCertificateRevocationListResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ImportImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ImportImageRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ImportImageResult" + }, + "traits": { + "smithy.api#documentation": "\n

To import your virtual machines (VMs) with a console-based experience, you can use the\n Import virtual machine images to Amazon Web Services template in the Migration Hub Orchestrator console. For more\n information, see the \n Migration Hub Orchestrator User Guide\n .

\n \n

Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).

\n \n

Amazon Web Services VM Import/Export strongly recommends specifying a value for either the\n --license-type or --usage-operation parameter when you create a new\n VM Import task. This ensures your operating system is licensed appropriately and your billing is\n optimized.

\n \n

For more information, see Importing a \n VM as an image using VM Import/Export in the VM Import/Export User Guide.

" + } + }, + "com.amazonaws.ec2#ImportImageLicenseConfigurationRequest": { + "type": "structure", + "members": { + "LicenseConfigurationArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ARN of a license configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The request information of license configurations.

" + } + }, + "com.amazonaws.ec2#ImportImageLicenseConfigurationResponse": { + "type": "structure", + "members": { + "LicenseConfigurationArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LicenseConfigurationArn", + "smithy.api#documentation": "

The ARN of a license configuration.

", + "smithy.api#xmlName": "licenseConfigurationArn" + } + } + }, + "traits": { + "smithy.api#documentation": "

The response information for license configurations.

" + } + }, + "com.amazonaws.ec2#ImportImageLicenseSpecificationListRequest": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImportImageLicenseConfigurationRequest", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ImportImageLicenseSpecificationListResponse": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImportImageLicenseConfigurationResponse", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ImportImageRequest": { + "type": "structure", + "members": { + "Architecture": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The architecture of the virtual machine.

\n

Valid values: i386 | x86_64\n

" + } + }, + "ClientData": { + "target": "com.amazonaws.ec2#ClientData", + "traits": { + "smithy.api#documentation": "

The client-specific data.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to enable idempotency for VM import requests.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description string for the import image task.

" + } + }, + "DiskContainers": { + "target": "com.amazonaws.ec2#ImageDiskContainerList", + "traits": { + "smithy.api#documentation": "

Information about the disk containers.

", + "smithy.api#xmlName": "DiskContainer" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether the destination AMI of the imported image should be encrypted. The default KMS key for EBS is used\n unless you specify a non-default KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the\n Amazon Elastic Compute Cloud User Guide.

" + } + }, + "Hypervisor": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The target hypervisor platform.

\n

Valid values: xen\n

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.ec2#KmsKeyId", + "traits": { + "smithy.api#documentation": "

An identifier for the symmetric KMS key to use when creating the\n encrypted AMI. This parameter is only required if you want to use a non-default KMS key; if this\n parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is\n specified, the Encrypted flag must also be set.

\n

The KMS key identifier may be provided in any of the following formats:

\n \n

Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even\n though you provided an invalid identifier. This action will eventually report failure.

\n

The specified KMS key must exist in the Region that the AMI is being copied to.

\n

Amazon EBS does not support asymmetric KMS keys.

" + } + }, + "LicenseType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The license type to be used for the Amazon Machine Image (AMI) after importing.

\n

Specify AWS to replace the source-system license with an Amazon Web Services\n license or BYOL to retain the source-system license. Leaving this parameter\n undefined is the same as choosing AWS when importing a Windows Server operating\n system, and the same as choosing BYOL when importing a Windows client operating\n system (such as Windows 10) or a Linux operating system.

\n

To use BYOL, you must have existing licenses with rights to use these licenses in a third party\n cloud, such as Amazon Web Services. For more information, see Prerequisites in the\n VM Import/Export User Guide.

" + } + }, + "Platform": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The operating system of the virtual machine.

\n

Valid values: Windows | Linux\n

" + } + }, + "RoleName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the role to use when not using the default role, 'vmimport'.

" + } + }, + "LicenseSpecifications": { + "target": "com.amazonaws.ec2#ImportImageLicenseSpecificationListRequest", + "traits": { + "smithy.api#documentation": "

The ARNs of the license configurations.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the import image task during creation.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "UsageOperation": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The usage operation value. For more information, see Licensing options in the VM Import/Export User Guide.

" + } + }, + "BootMode": { + "target": "com.amazonaws.ec2#BootModeValues", + "traits": { + "smithy.api#documentation": "

The boot mode of the virtual machine.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ImportImageResult": { + "type": "structure", + "members": { + "Architecture": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Architecture", + "smithy.api#documentation": "

The architecture of the virtual machine.

", + "smithy.api#xmlName": "architecture" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the import task.

", + "smithy.api#xmlName": "description" + } + }, + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Encrypted", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the AMI is encrypted.

", + "smithy.api#xmlName": "encrypted" + } + }, + "Hypervisor": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Hypervisor", + "smithy.api#documentation": "

The target hypervisor of the import task.

", + "smithy.api#xmlName": "hypervisor" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI) created by the import task.

", + "smithy.api#xmlName": "imageId" + } + }, + "ImportTaskId": { + "target": "com.amazonaws.ec2#ImportImageTaskId", + "traits": { + "aws.protocols#ec2QueryName": "ImportTaskId", + "smithy.api#documentation": "

The task ID of the import image task.

", + "smithy.api#xmlName": "importTaskId" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.ec2#KmsKeyId", + "traits": { + "aws.protocols#ec2QueryName": "KmsKeyId", + "smithy.api#documentation": "

The identifier for the symmetric KMS key that was used to create the encrypted AMI.

", + "smithy.api#xmlName": "kmsKeyId" + } + }, + "LicenseType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LicenseType", + "smithy.api#documentation": "

The license type of the virtual machine.

", + "smithy.api#xmlName": "licenseType" + } + }, + "Platform": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Platform", + "smithy.api#documentation": "

The operating system of the virtual machine.

", + "smithy.api#xmlName": "platform" + } + }, + "Progress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Progress", + "smithy.api#documentation": "

The progress of the task.

", + "smithy.api#xmlName": "progress" + } + }, + "SnapshotDetails": { + "target": "com.amazonaws.ec2#SnapshotDetailList", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotDetailSet", + "smithy.api#documentation": "

Information about the snapshots.

", + "smithy.api#xmlName": "snapshotDetailSet" + } + }, + "Status": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

A brief status of the task.

", + "smithy.api#xmlName": "status" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

A detailed status message of the import task.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "LicenseSpecifications": { + "target": "com.amazonaws.ec2#ImportImageLicenseSpecificationListResponse", + "traits": { + "aws.protocols#ec2QueryName": "LicenseSpecifications", + "smithy.api#documentation": "

The ARNs of the license configurations.

", + "smithy.api#xmlName": "licenseSpecifications" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the import image task.

", + "smithy.api#xmlName": "tagSet" + } + }, + "UsageOperation": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UsageOperation", + "smithy.api#documentation": "

The usage operation value.

", + "smithy.api#xmlName": "usageOperation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ImportImageTask": { + "type": "structure", + "members": { + "Architecture": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Architecture", + "smithy.api#documentation": "

The architecture of the virtual machine.

\n

Valid values: i386 | x86_64 | arm64\n

", + "smithy.api#xmlName": "architecture" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the import task.

", + "smithy.api#xmlName": "description" + } + }, + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Encrypted", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the image is encrypted.

", + "smithy.api#xmlName": "encrypted" + } + }, + "Hypervisor": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Hypervisor", + "smithy.api#documentation": "

The target hypervisor for the import task.

\n

Valid values: xen\n

", + "smithy.api#xmlName": "hypervisor" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI) of the imported virtual machine.

", + "smithy.api#xmlName": "imageId" + } + }, + "ImportTaskId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImportTaskId", + "smithy.api#documentation": "

The ID of the import image task.

", + "smithy.api#xmlName": "importTaskId" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KmsKeyId", + "smithy.api#documentation": "

The identifier for the KMS key that was used to create the encrypted image.

", + "smithy.api#xmlName": "kmsKeyId" + } + }, + "LicenseType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LicenseType", + "smithy.api#documentation": "

The license type of the virtual machine.

", + "smithy.api#xmlName": "licenseType" + } + }, + "Platform": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Platform", + "smithy.api#documentation": "

The description string for the import image task.

", + "smithy.api#xmlName": "platform" + } + }, + "Progress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Progress", + "smithy.api#documentation": "

The percentage of progress of the import image task.

", + "smithy.api#xmlName": "progress" + } + }, + "SnapshotDetails": { + "target": "com.amazonaws.ec2#SnapshotDetailList", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotDetailSet", + "smithy.api#documentation": "

Information about the snapshots.

", + "smithy.api#xmlName": "snapshotDetailSet" + } + }, + "Status": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

A brief status for the import image task.

", + "smithy.api#xmlName": "status" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

A descriptive status message for the import image task.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for the import image task.

", + "smithy.api#xmlName": "tagSet" + } + }, + "LicenseSpecifications": { + "target": "com.amazonaws.ec2#ImportImageLicenseSpecificationListResponse", + "traits": { + "aws.protocols#ec2QueryName": "LicenseSpecifications", + "smithy.api#documentation": "

The ARNs of the license configurations that are associated with the import image task.

", + "smithy.api#xmlName": "licenseSpecifications" + } + }, + "UsageOperation": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UsageOperation", + "smithy.api#documentation": "

The usage operation value.

", + "smithy.api#xmlName": "usageOperation" + } + }, + "BootMode": { + "target": "com.amazonaws.ec2#BootModeValues", + "traits": { + "aws.protocols#ec2QueryName": "BootMode", + "smithy.api#documentation": "

The boot mode of the virtual machine.

", + "smithy.api#xmlName": "bootMode" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an import image task.

" + } + }, + "com.amazonaws.ec2#ImportImageTaskId": { + "type": "string" + }, + "com.amazonaws.ec2#ImportImageTaskList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImportImageTask", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ImportInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ImportInstanceRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ImportInstanceResult" + }, + "traits": { + "smithy.api#documentation": "

Creates an import instance task using metadata from the specified disk image.

\n

This API action supports only single-volume VMs. To import multi-volume VMs, use ImportImage\n instead.

\n

This API action is not supported by the Command Line Interface (CLI). For \n information about using the Amazon EC2 CLI, which is deprecated, see\n Importing a VM to Amazon EC2 in the Amazon EC2 CLI Reference PDF file.

\n

For information about the import manifest referenced by this API action, see VM Import Manifest.

" + } + }, + "com.amazonaws.ec2#ImportInstanceLaunchSpecification": { + "type": "structure", + "members": { + "AdditionalInfo": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AdditionalInfo", + "smithy.api#documentation": "

Reserved.

", + "smithy.api#xmlName": "additionalInfo" + } + }, + "Architecture": { + "target": "com.amazonaws.ec2#ArchitectureValues", + "traits": { + "aws.protocols#ec2QueryName": "Architecture", + "smithy.api#documentation": "

The architecture of the instance.

", + "smithy.api#xmlName": "architecture" + } + }, + "GroupIds": { + "target": "com.amazonaws.ec2#SecurityGroupIdStringList", + "traits": { + "smithy.api#documentation": "

The security group IDs.

", + "smithy.api#xmlName": "GroupId" + } + }, + "GroupNames": { + "target": "com.amazonaws.ec2#SecurityGroupStringList", + "traits": { + "smithy.api#documentation": "

The security group names.

", + "smithy.api#xmlName": "GroupName" + } + }, + "InstanceInitiatedShutdownBehavior": { + "target": "com.amazonaws.ec2#ShutdownBehavior", + "traits": { + "aws.protocols#ec2QueryName": "InstanceInitiatedShutdownBehavior", + "smithy.api#documentation": "

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the\n operating system command for system shutdown).

", + "smithy.api#xmlName": "instanceInitiatedShutdownBehavior" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type. For more information about the instance types that you can import, see Instance Types in the\n VM Import/Export User Guide.

", + "smithy.api#xmlName": "instanceType" + } + }, + "Monitoring": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Monitoring", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether monitoring is enabled.

", + "smithy.api#xmlName": "monitoring" + } + }, + "Placement": { + "target": "com.amazonaws.ec2#Placement", + "traits": { + "aws.protocols#ec2QueryName": "Placement", + "smithy.api#documentation": "

The placement information for the instance.

", + "smithy.api#xmlName": "placement" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

[EC2-VPC] An available IP address from the IP address range of the subnet.

", + "smithy.api#xmlName": "privateIpAddress" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

[EC2-VPC] The ID of the subnet in which to launch the instance.

", + "smithy.api#xmlName": "subnetId" + } + }, + "UserData": { + "target": "com.amazonaws.ec2#UserData", + "traits": { + "aws.protocols#ec2QueryName": "UserData", + "smithy.api#documentation": "

The Base64-encoded user data to make available to the instance.

", + "smithy.api#xmlName": "userData" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the launch specification for VM import.

" + } + }, + "com.amazonaws.ec2#ImportInstanceRequest": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the instance being imported.

", + "smithy.api#xmlName": "description" + } + }, + "DiskImages": { + "target": "com.amazonaws.ec2#DiskImageList", + "traits": { + "aws.protocols#ec2QueryName": "DiskImage", + "smithy.api#documentation": "

The disk image.

", + "smithy.api#xmlName": "diskImage" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "LaunchSpecification": { + "target": "com.amazonaws.ec2#ImportInstanceLaunchSpecification", + "traits": { + "aws.protocols#ec2QueryName": "LaunchSpecification", + "smithy.api#documentation": "

The launch specification.

", + "smithy.api#xmlName": "launchSpecification" + } + }, + "Platform": { + "target": "com.amazonaws.ec2#PlatformValues", + "traits": { + "aws.protocols#ec2QueryName": "Platform", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The instance operating system.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "platform" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ImportInstanceResult": { + "type": "structure", + "members": { + "ConversionTask": { + "target": "com.amazonaws.ec2#ConversionTask", + "traits": { + "aws.protocols#ec2QueryName": "ConversionTask", + "smithy.api#documentation": "

Information about the conversion task.

", + "smithy.api#xmlName": "conversionTask" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ImportInstanceTaskDetails": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the task.

", + "smithy.api#xmlName": "description" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "Platform": { + "target": "com.amazonaws.ec2#PlatformValues", + "traits": { + "aws.protocols#ec2QueryName": "Platform", + "smithy.api#documentation": "

The instance operating system.

", + "smithy.api#xmlName": "platform" + } + }, + "Volumes": { + "target": "com.amazonaws.ec2#ImportInstanceVolumeDetailSet", + "traits": { + "aws.protocols#ec2QueryName": "Volumes", + "smithy.api#documentation": "

The volumes.

", + "smithy.api#xmlName": "volumes" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an import instance task.

" + } + }, + "com.amazonaws.ec2#ImportInstanceVolumeDetailItem": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone where the resulting instance will reside.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "BytesConverted": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "BytesConverted", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of bytes converted so far.

", + "smithy.api#xmlName": "bytesConverted" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the task.

", + "smithy.api#xmlName": "description" + } + }, + "Image": { + "target": "com.amazonaws.ec2#DiskImageDescription", + "traits": { + "aws.protocols#ec2QueryName": "Image", + "smithy.api#documentation": "

The image.

", + "smithy.api#xmlName": "image" + } + }, + "Status": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status of the import of this particular disk image.

", + "smithy.api#xmlName": "status" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

The status information or errors related to the disk image.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "Volume": { + "target": "com.amazonaws.ec2#DiskImageVolumeDescription", + "traits": { + "aws.protocols#ec2QueryName": "Volume", + "smithy.api#documentation": "

The volume.

", + "smithy.api#xmlName": "volume" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an import volume task.

" + } + }, + "com.amazonaws.ec2#ImportInstanceVolumeDetailSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImportInstanceVolumeDetailItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ImportKeyPair": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ImportKeyPairRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ImportKeyPairResult" + }, + "traits": { + "smithy.api#documentation": "

Imports the public key from an RSA or ED25519 key pair that you created with a third-party tool. \n Compare this with CreateKeyPair, in which Amazon Web Services creates the key pair and gives the keys to you \n (Amazon Web Services keeps a copy of the public key). With ImportKeyPair, you create the key pair and give Amazon Web Services just the public key. \n The private key is never transferred between you and Amazon Web Services.

\n

For more information about key pairs, see Amazon EC2 key pairs \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#ImportKeyPairRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "KeyName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KeyName", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A unique name for the key pair.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "keyName" + } + }, + "PublicKeyMaterial": { + "target": "com.amazonaws.ec2#Blob", + "traits": { + "aws.protocols#ec2QueryName": "PublicKeyMaterial", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "publicKeyMaterial" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the imported key pair.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ImportKeyPairResult": { + "type": "structure", + "members": { + "KeyFingerprint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KeyFingerprint", + "smithy.api#documentation": "", + "smithy.api#xmlName": "keyFingerprint" + } + }, + "KeyName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KeyName", + "smithy.api#documentation": "

The key pair name that you provided.

", + "smithy.api#xmlName": "keyName" + } + }, + "KeyPairId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KeyPairId", + "smithy.api#documentation": "

The ID of the resulting key pair.

", + "smithy.api#xmlName": "keyPairId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags applied to the imported key pair.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ImportManifestUrl": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.ec2#ImportSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ImportSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ImportSnapshotResult" + }, + "traits": { + "smithy.api#documentation": "

Imports a disk into an EBS snapshot.

\n

For more information, see Importing a disk as a snapshot using VM Import/Export in the \n VM Import/Export User Guide.

" + } + }, + "com.amazonaws.ec2#ImportSnapshotRequest": { + "type": "structure", + "members": { + "ClientData": { + "target": "com.amazonaws.ec2#ClientData", + "traits": { + "smithy.api#documentation": "

The client-specific data.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Token to enable idempotency for VM import requests.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The description string for the import snapshot task.

" + } + }, + "DiskContainer": { + "target": "com.amazonaws.ec2#SnapshotDiskContainer", + "traits": { + "smithy.api#documentation": "

Information about the disk container.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS is\n used unless you specify a non-default KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the\n Amazon Elastic Compute Cloud User Guide.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.ec2#KmsKeyId", + "traits": { + "smithy.api#documentation": "

An identifier for the symmetric KMS key to use when creating the\n encrypted snapshot. This parameter is only required if you want to use a non-default KMS key; if this\n parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is\n specified, the Encrypted flag must also be set.

\n

The KMS key identifier may be provided in any of the following formats:

\n \n

Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even\n though you provided an invalid identifier. This action will eventually report failure.

\n

The specified KMS key must exist in the Region that the snapshot is being copied to.

\n

Amazon EBS does not support asymmetric KMS keys.

" + } + }, + "RoleName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the role to use when not using the default role, 'vmimport'.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the import snapshot task during creation.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ImportSnapshotResult": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the import snapshot task.

", + "smithy.api#xmlName": "description" + } + }, + "ImportTaskId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImportTaskId", + "smithy.api#documentation": "

The ID of the import snapshot task.

", + "smithy.api#xmlName": "importTaskId" + } + }, + "SnapshotTaskDetail": { + "target": "com.amazonaws.ec2#SnapshotTaskDetail", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotTaskDetail", + "smithy.api#documentation": "

Information about the import snapshot task.

", + "smithy.api#xmlName": "snapshotTaskDetail" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the import snapshot task.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ImportSnapshotTask": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the import snapshot task.

", + "smithy.api#xmlName": "description" + } + }, + "ImportTaskId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImportTaskId", + "smithy.api#documentation": "

The ID of the import snapshot task.

", + "smithy.api#xmlName": "importTaskId" + } + }, + "SnapshotTaskDetail": { + "target": "com.amazonaws.ec2#SnapshotTaskDetail", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotTaskDetail", + "smithy.api#documentation": "

Describes an import snapshot task.

", + "smithy.api#xmlName": "snapshotTaskDetail" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for the import snapshot task.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an import snapshot task.

" + } + }, + "com.amazonaws.ec2#ImportSnapshotTaskId": { + "type": "string" + }, + "com.amazonaws.ec2#ImportSnapshotTaskIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImportSnapshotTaskId", + "traits": { + "smithy.api#xmlName": "ImportTaskId" + } + } + }, + "com.amazonaws.ec2#ImportSnapshotTaskList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImportSnapshotTask", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ImportTaskId": { + "type": "string" + }, + "com.amazonaws.ec2#ImportTaskIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImportImageTaskId", + "traits": { + "smithy.api#xmlName": "ImportTaskId" + } + } + }, + "com.amazonaws.ec2#ImportVolume": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ImportVolumeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ImportVolumeResult" + }, + "traits": { + "smithy.api#documentation": "

Creates an import volume task using metadata from the specified disk image.

\n

This API action supports only single-volume VMs. To import multi-volume VMs, use \n ImportImage instead. To import a disk to a snapshot, use\n ImportSnapshot instead.

\n

This API action is not supported by the Command Line Interface (CLI). For \n information about using the Amazon EC2 CLI, which is deprecated, see Importing Disks to Amazon EBS in the Amazon EC2 CLI Reference PDF file.

\n

For information about the import manifest referenced by this API action, see VM Import Manifest.

" + } + }, + "com.amazonaws.ec2#ImportVolumeRequest": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Availability Zone for the resulting EBS volume.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "availabilityZone" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the volume.

", + "smithy.api#xmlName": "description" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Image": { + "target": "com.amazonaws.ec2#DiskImageDetail", + "traits": { + "aws.protocols#ec2QueryName": "Image", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The disk image.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "image" + } + }, + "Volume": { + "target": "com.amazonaws.ec2#VolumeDetail", + "traits": { + "aws.protocols#ec2QueryName": "Volume", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The volume size.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "volume" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ImportVolumeResult": { + "type": "structure", + "members": { + "ConversionTask": { + "target": "com.amazonaws.ec2#ConversionTask", + "traits": { + "aws.protocols#ec2QueryName": "ConversionTask", + "smithy.api#documentation": "

Information about the conversion task.

", + "smithy.api#xmlName": "conversionTask" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ImportVolumeTaskDetails": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone where the resulting volume will reside.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "BytesConverted": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "BytesConverted", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of bytes converted so far.

", + "smithy.api#xmlName": "bytesConverted" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description you provided when starting the import volume task.

", + "smithy.api#xmlName": "description" + } + }, + "Image": { + "target": "com.amazonaws.ec2#DiskImageDescription", + "traits": { + "aws.protocols#ec2QueryName": "Image", + "smithy.api#documentation": "

The image.

", + "smithy.api#xmlName": "image" + } + }, + "Volume": { + "target": "com.amazonaws.ec2#DiskImageVolumeDescription", + "traits": { + "aws.protocols#ec2QueryName": "Volume", + "smithy.api#documentation": "

The volume.

", + "smithy.api#xmlName": "volume" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an import volume task.

" + } + }, + "com.amazonaws.ec2#InferenceAcceleratorInfo": { + "type": "structure", + "members": { + "Accelerators": { + "target": "com.amazonaws.ec2#InferenceDeviceInfoList", + "traits": { + "aws.protocols#ec2QueryName": "Accelerators", + "smithy.api#documentation": "

Describes the Inference accelerators for the instance type.

", + "smithy.api#xmlName": "accelerators" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the Inference accelerators for the instance type.

" + } + }, + "com.amazonaws.ec2#InferenceDeviceCount": { + "type": "integer" + }, + "com.amazonaws.ec2#InferenceDeviceInfo": { + "type": "structure", + "members": { + "Count": { + "target": "com.amazonaws.ec2#InferenceDeviceCount", + "traits": { + "aws.protocols#ec2QueryName": "Count", + "smithy.api#documentation": "

The number of Inference accelerators for the instance type.

", + "smithy.api#xmlName": "count" + } + }, + "Name": { + "target": "com.amazonaws.ec2#InferenceDeviceName", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The name of the Inference accelerator.

", + "smithy.api#xmlName": "name" + } + }, + "Manufacturer": { + "target": "com.amazonaws.ec2#InferenceDeviceManufacturerName", + "traits": { + "aws.protocols#ec2QueryName": "Manufacturer", + "smithy.api#documentation": "

The manufacturer of the Inference accelerator.

", + "smithy.api#xmlName": "manufacturer" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the Inference accelerators for the instance type.

" + } + }, + "com.amazonaws.ec2#InferenceDeviceInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InferenceDeviceInfo" + } + }, + "com.amazonaws.ec2#InferenceDeviceManufacturerName": { + "type": "string" + }, + "com.amazonaws.ec2#InferenceDeviceName": { + "type": "string" + }, + "com.amazonaws.ec2#InsideCidrBlocksStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Instance": { + "type": "structure", + "members": { + "AmiLaunchIndex": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "AmiLaunchIndex", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The AMI launch index, which can be used to find this instance in the launch\n group.

", + "smithy.api#xmlName": "amiLaunchIndex" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the AMI used to launch the instance.

", + "smithy.api#xmlName": "imageId" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type.

", + "smithy.api#xmlName": "instanceType" + } + }, + "KernelId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KernelId", + "smithy.api#documentation": "

The kernel associated with this instance, if applicable.

", + "smithy.api#xmlName": "kernelId" + } + }, + "KeyName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KeyName", + "smithy.api#documentation": "

The name of the key pair, if this instance was launched with an associated key\n pair.

", + "smithy.api#xmlName": "keyName" + } + }, + "LaunchTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTime", + "smithy.api#documentation": "

The time the instance was launched.

", + "smithy.api#xmlName": "launchTime" + } + }, + "Monitoring": { + "target": "com.amazonaws.ec2#Monitoring", + "traits": { + "aws.protocols#ec2QueryName": "Monitoring", + "smithy.api#documentation": "

The monitoring for the instance.

", + "smithy.api#xmlName": "monitoring" + } + }, + "Placement": { + "target": "com.amazonaws.ec2#Placement", + "traits": { + "aws.protocols#ec2QueryName": "Placement", + "smithy.api#documentation": "

The location where the instance launched, if applicable.

", + "smithy.api#xmlName": "placement" + } + }, + "Platform": { + "target": "com.amazonaws.ec2#PlatformValues", + "traits": { + "aws.protocols#ec2QueryName": "Platform", + "smithy.api#documentation": "

The value is Windows for Windows instances; otherwise blank.

", + "smithy.api#xmlName": "platform" + } + }, + "PrivateDnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDnsName", + "smithy.api#documentation": "

[IPv4 only] The private DNS hostname name assigned to the instance. This DNS hostname\n can only be used inside the Amazon EC2 network. This name is not available until the\n instance enters the running state.

\n

The Amazon-provided DNS server resolves Amazon-provided private DNS\n hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not\n using the Amazon-provided DNS server in your VPC, your custom domain name servers must\n resolve the hostname as appropriate.

", + "smithy.api#xmlName": "privateDnsName" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

The private IPv4 address assigned to the instance.

", + "smithy.api#xmlName": "privateIpAddress" + } + }, + "ProductCodes": { + "target": "com.amazonaws.ec2#ProductCodeList", + "traits": { + "aws.protocols#ec2QueryName": "ProductCodes", + "smithy.api#documentation": "

The product codes attached to this instance, if applicable.

", + "smithy.api#xmlName": "productCodes" + } + }, + "PublicDnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DnsName", + "smithy.api#documentation": "

[IPv4 only] The public DNS name assigned to the instance. This name is not available\n until the instance enters the running state. This name is only\n available if you've enabled DNS hostnames for your VPC.

", + "smithy.api#xmlName": "dnsName" + } + }, + "PublicIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpAddress", + "smithy.api#documentation": "

The public IPv4 address, or the Carrier IP address assigned to the instance, if\n applicable.

\n

A Carrier IP address only applies to an instance launched in a subnet associated with\n a Wavelength Zone.

", + "smithy.api#xmlName": "ipAddress" + } + }, + "RamdiskId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RamdiskId", + "smithy.api#documentation": "

The RAM disk associated with this instance, if applicable.

", + "smithy.api#xmlName": "ramdiskId" + } + }, + "State": { + "target": "com.amazonaws.ec2#InstanceState", + "traits": { + "aws.protocols#ec2QueryName": "InstanceState", + "smithy.api#documentation": "

The current state of the instance.

", + "smithy.api#xmlName": "instanceState" + } + }, + "StateTransitionReason": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Reason", + "smithy.api#documentation": "

The reason for the most recent state transition. This might be an empty string.

", + "smithy.api#xmlName": "reason" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet in which the instance is running.

", + "smithy.api#xmlName": "subnetId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC in which the instance is running.

", + "smithy.api#xmlName": "vpcId" + } + }, + "Architecture": { + "target": "com.amazonaws.ec2#ArchitectureValues", + "traits": { + "aws.protocols#ec2QueryName": "Architecture", + "smithy.api#documentation": "

The architecture of the image.

", + "smithy.api#xmlName": "architecture" + } + }, + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#InstanceBlockDeviceMappingList", + "traits": { + "aws.protocols#ec2QueryName": "BlockDeviceMapping", + "smithy.api#documentation": "

Any block device mapping entries for the instance.

", + "smithy.api#xmlName": "blockDeviceMapping" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

The idempotency token you provided when you launched the instance, if\n applicable.

", + "smithy.api#xmlName": "clientToken" + } + }, + "EbsOptimized": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EbsOptimized", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the instance is optimized for Amazon EBS I/O. This optimization\n provides dedicated throughput to Amazon EBS and an optimized configuration stack to\n provide optimal I/O performance. This optimization isn't available with all instance\n types. Additional usage charges apply when using an EBS Optimized instance.

", + "smithy.api#xmlName": "ebsOptimized" + } + }, + "EnaSupport": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnaSupport", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether enhanced networking with ENA is enabled.

", + "smithy.api#xmlName": "enaSupport" + } + }, + "Hypervisor": { + "target": "com.amazonaws.ec2#HypervisorType", + "traits": { + "aws.protocols#ec2QueryName": "Hypervisor", + "smithy.api#documentation": "

The hypervisor type of the instance. The value xen is used for both Xen\n and Nitro hypervisors.

", + "smithy.api#xmlName": "hypervisor" + } + }, + "IamInstanceProfile": { + "target": "com.amazonaws.ec2#IamInstanceProfile", + "traits": { + "aws.protocols#ec2QueryName": "IamInstanceProfile", + "smithy.api#documentation": "

The IAM instance profile associated with the instance, if\n applicable.

", + "smithy.api#xmlName": "iamInstanceProfile" + } + }, + "InstanceLifecycle": { + "target": "com.amazonaws.ec2#InstanceLifecycleType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceLifecycle", + "smithy.api#documentation": "

Indicates whether this is a Spot Instance or a Scheduled Instance.

", + "smithy.api#xmlName": "instanceLifecycle" + } + }, + "ElasticGpuAssociations": { + "target": "com.amazonaws.ec2#ElasticGpuAssociationList", + "traits": { + "aws.protocols#ec2QueryName": "ElasticGpuAssociationSet", + "smithy.api#documentation": "

The Elastic GPU associated with the instance.

", + "smithy.api#xmlName": "elasticGpuAssociationSet" + } + }, + "ElasticInferenceAcceleratorAssociations": { + "target": "com.amazonaws.ec2#ElasticInferenceAcceleratorAssociationList", + "traits": { + "aws.protocols#ec2QueryName": "ElasticInferenceAcceleratorAssociationSet", + "smithy.api#documentation": "

The elastic inference accelerator associated with the instance.

", + "smithy.api#xmlName": "elasticInferenceAcceleratorAssociationSet" + } + }, + "NetworkInterfaces": { + "target": "com.amazonaws.ec2#InstanceNetworkInterfaceList", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceSet", + "smithy.api#documentation": "

The network interfaces for the instance.

", + "smithy.api#xmlName": "networkInterfaceSet" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutpostArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

", + "smithy.api#xmlName": "outpostArn" + } + }, + "RootDeviceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RootDeviceName", + "smithy.api#documentation": "

The device name of the root device volume (for example,\n /dev/sda1).

", + "smithy.api#xmlName": "rootDeviceName" + } + }, + "RootDeviceType": { + "target": "com.amazonaws.ec2#DeviceType", + "traits": { + "aws.protocols#ec2QueryName": "RootDeviceType", + "smithy.api#documentation": "

The root device type used by the AMI. The AMI can use an EBS volume or an instance\n store volume.

", + "smithy.api#xmlName": "rootDeviceType" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.ec2#GroupIdentifierList", + "traits": { + "aws.protocols#ec2QueryName": "GroupSet", + "smithy.api#documentation": "

The security groups for the instance.

", + "smithy.api#xmlName": "groupSet" + } + }, + "SourceDestCheck": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "SourceDestCheck", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether source/destination checking is enabled.

", + "smithy.api#xmlName": "sourceDestCheck" + } + }, + "SpotInstanceRequestId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpotInstanceRequestId", + "smithy.api#documentation": "

If the request is a Spot Instance request, the ID of the request.

", + "smithy.api#xmlName": "spotInstanceRequestId" + } + }, + "SriovNetSupport": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SriovNetSupport", + "smithy.api#documentation": "

Specifies whether enhanced networking with the Intel 82599 Virtual Function interface\n is enabled.

", + "smithy.api#xmlName": "sriovNetSupport" + } + }, + "StateReason": { + "target": "com.amazonaws.ec2#StateReason", + "traits": { + "aws.protocols#ec2QueryName": "StateReason", + "smithy.api#documentation": "

The reason for the most recent state transition.

", + "smithy.api#xmlName": "stateReason" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the instance.

", + "smithy.api#xmlName": "tagSet" + } + }, + "VirtualizationType": { + "target": "com.amazonaws.ec2#VirtualizationType", + "traits": { + "aws.protocols#ec2QueryName": "VirtualizationType", + "smithy.api#documentation": "

The virtualization type of the instance.

", + "smithy.api#xmlName": "virtualizationType" + } + }, + "CpuOptions": { + "target": "com.amazonaws.ec2#CpuOptions", + "traits": { + "aws.protocols#ec2QueryName": "CpuOptions", + "smithy.api#documentation": "

The CPU options for the instance.

", + "smithy.api#xmlName": "cpuOptions" + } + }, + "CapacityReservationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationId", + "smithy.api#documentation": "

The ID of the Capacity Reservation.

", + "smithy.api#xmlName": "capacityReservationId" + } + }, + "CapacityReservationSpecification": { + "target": "com.amazonaws.ec2#CapacityReservationSpecificationResponse", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationSpecification", + "smithy.api#documentation": "

Information about the Capacity Reservation targeting option.

", + "smithy.api#xmlName": "capacityReservationSpecification" + } + }, + "HibernationOptions": { + "target": "com.amazonaws.ec2#HibernationOptions", + "traits": { + "aws.protocols#ec2QueryName": "HibernationOptions", + "smithy.api#documentation": "

Indicates whether the instance is enabled for hibernation.

", + "smithy.api#xmlName": "hibernationOptions" + } + }, + "Licenses": { + "target": "com.amazonaws.ec2#LicenseList", + "traits": { + "aws.protocols#ec2QueryName": "LicenseSet", + "smithy.api#documentation": "

The license configurations for the instance.

", + "smithy.api#xmlName": "licenseSet" + } + }, + "MetadataOptions": { + "target": "com.amazonaws.ec2#InstanceMetadataOptionsResponse", + "traits": { + "aws.protocols#ec2QueryName": "MetadataOptions", + "smithy.api#documentation": "

The metadata options for the instance.

", + "smithy.api#xmlName": "metadataOptions" + } + }, + "EnclaveOptions": { + "target": "com.amazonaws.ec2#EnclaveOptions", + "traits": { + "aws.protocols#ec2QueryName": "EnclaveOptions", + "smithy.api#documentation": "

Indicates whether the instance is enabled for Amazon Web Services Nitro\n Enclaves.

", + "smithy.api#xmlName": "enclaveOptions" + } + }, + "BootMode": { + "target": "com.amazonaws.ec2#BootModeValues", + "traits": { + "aws.protocols#ec2QueryName": "BootMode", + "smithy.api#documentation": "

The boot mode that was specified by the AMI. If the value is uefi-preferred, \n the AMI supports both UEFI and Legacy BIOS. The currentInstanceBootMode parameter \n is the boot mode that is used to boot the instance at launch or start.

\n \n

The operating system contained in the AMI must be configured to support the specified boot mode.

\n \n

For more information, see Boot modes in the\n Amazon EC2 User Guide.

", + "smithy.api#xmlName": "bootMode" + } + }, + "PlatformDetails": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PlatformDetails", + "smithy.api#documentation": "

The platform details value for the instance. For more information, see AMI\n billing information fields in the\n Amazon EC2 User Guide.

", + "smithy.api#xmlName": "platformDetails" + } + }, + "UsageOperation": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UsageOperation", + "smithy.api#documentation": "

The usage operation value for the instance. For more information, see AMI\n billing information fields in the\n Amazon EC2 User Guide.

", + "smithy.api#xmlName": "usageOperation" + } + }, + "UsageOperationUpdateTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "UsageOperationUpdateTime", + "smithy.api#documentation": "

The time that the usage operation was last updated.

", + "smithy.api#xmlName": "usageOperationUpdateTime" + } + }, + "PrivateDnsNameOptions": { + "target": "com.amazonaws.ec2#PrivateDnsNameOptionsResponse", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDnsNameOptions", + "smithy.api#documentation": "

The options for the instance hostname.

", + "smithy.api#xmlName": "privateDnsNameOptions" + } + }, + "Ipv6Address": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Address", + "smithy.api#documentation": "

The IPv6 address assigned to the instance.

", + "smithy.api#xmlName": "ipv6Address" + } + }, + "TpmSupport": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TpmSupport", + "smithy.api#documentation": "

If the instance is configured for NitroTPM support, the value is v2.0.\n For more information, see NitroTPM in the\n Amazon EC2 User Guide.

", + "smithy.api#xmlName": "tpmSupport" + } + }, + "MaintenanceOptions": { + "target": "com.amazonaws.ec2#InstanceMaintenanceOptions", + "traits": { + "aws.protocols#ec2QueryName": "MaintenanceOptions", + "smithy.api#documentation": "

Provides information on the recovery and maintenance options of your instance.

", + "smithy.api#xmlName": "maintenanceOptions" + } + }, + "CurrentInstanceBootMode": { + "target": "com.amazonaws.ec2#InstanceBootModeValues", + "traits": { + "aws.protocols#ec2QueryName": "CurrentInstanceBootMode", + "smithy.api#documentation": "

The boot mode that is used to boot the instance at launch or start. For more information, see Boot modes in the\n Amazon EC2 User Guide.

", + "smithy.api#xmlName": "currentInstanceBootMode" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an instance.

" + } + }, + "com.amazonaws.ec2#InstanceAttribute": { + "type": "structure", + "members": { + "Groups": { + "target": "com.amazonaws.ec2#GroupIdentifierList", + "traits": { + "aws.protocols#ec2QueryName": "GroupSet", + "smithy.api#documentation": "

The security groups associated with the instance.

", + "smithy.api#xmlName": "groupSet" + } + }, + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#InstanceBlockDeviceMappingList", + "traits": { + "aws.protocols#ec2QueryName": "BlockDeviceMapping", + "smithy.api#documentation": "

The block device mapping of the instance.

", + "smithy.api#xmlName": "blockDeviceMapping" + } + }, + "DisableApiTermination": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "aws.protocols#ec2QueryName": "DisableApiTermination", + "smithy.api#documentation": "

If the value is true, you can't terminate the instance through the Amazon\n EC2 console, CLI, or API; otherwise, you can.

", + "smithy.api#xmlName": "disableApiTermination" + } + }, + "EnaSupport": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "aws.protocols#ec2QueryName": "EnaSupport", + "smithy.api#documentation": "

Indicates whether enhanced networking with ENA is enabled.

", + "smithy.api#xmlName": "enaSupport" + } + }, + "EnclaveOptions": { + "target": "com.amazonaws.ec2#EnclaveOptions", + "traits": { + "aws.protocols#ec2QueryName": "EnclaveOptions", + "smithy.api#documentation": "

To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to\n true; otherwise, set it to false.

", + "smithy.api#xmlName": "enclaveOptions" + } + }, + "EbsOptimized": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "aws.protocols#ec2QueryName": "EbsOptimized", + "smithy.api#documentation": "

Indicates whether the instance is optimized for Amazon EBS I/O.

", + "smithy.api#xmlName": "ebsOptimized" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "InstanceInitiatedShutdownBehavior": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "InstanceInitiatedShutdownBehavior", + "smithy.api#documentation": "

Indicates whether an instance stops or terminates when you initiate shutdown from the\n instance (using the operating system command for system shutdown).

", + "smithy.api#xmlName": "instanceInitiatedShutdownBehavior" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type.

", + "smithy.api#xmlName": "instanceType" + } + }, + "KernelId": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "Kernel", + "smithy.api#documentation": "

The kernel ID.

", + "smithy.api#xmlName": "kernel" + } + }, + "ProductCodes": { + "target": "com.amazonaws.ec2#ProductCodeList", + "traits": { + "aws.protocols#ec2QueryName": "ProductCodes", + "smithy.api#documentation": "

A list of product codes.

", + "smithy.api#xmlName": "productCodes" + } + }, + "RamdiskId": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "Ramdisk", + "smithy.api#documentation": "

The RAM disk ID.

", + "smithy.api#xmlName": "ramdisk" + } + }, + "RootDeviceName": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "RootDeviceName", + "smithy.api#documentation": "

The device name of the root device volume (for example,\n /dev/sda1).

", + "smithy.api#xmlName": "rootDeviceName" + } + }, + "SourceDestCheck": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "aws.protocols#ec2QueryName": "SourceDestCheck", + "smithy.api#documentation": "

Enable or disable source/destination checks, which ensure that the instance is either\n the source or the destination of any traffic that it receives. If the value is\n true, source/destination checks are enabled; otherwise, they are\n disabled. The default value is true. You must disable source/destination\n checks if the instance runs services such as network address translation, routing, or\n firewalls.

", + "smithy.api#xmlName": "sourceDestCheck" + } + }, + "SriovNetSupport": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "SriovNetSupport", + "smithy.api#documentation": "

Indicates whether enhanced networking with the Intel 82599 Virtual Function interface\n is enabled.

", + "smithy.api#xmlName": "sriovNetSupport" + } + }, + "UserData": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "UserData", + "smithy.api#documentation": "

The user data.

", + "smithy.api#xmlName": "userData" + } + }, + "DisableApiStop": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "aws.protocols#ec2QueryName": "DisableApiStop", + "smithy.api#documentation": "

To enable the instance for Amazon Web Services Stop Protection, set this parameter to\n true; otherwise, set it to false.

", + "smithy.api#xmlName": "disableApiStop" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an instance attribute.

" + } + }, + "com.amazonaws.ec2#InstanceAttributeName": { + "type": "enum", + "members": { + "instanceType": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "instanceType" + } + }, + "kernel": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "kernel" + } + }, + "ramdisk": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ramdisk" + } + }, + "userData": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "userData" + } + }, + "disableApiTermination": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disableApiTermination" + } + }, + "instanceInitiatedShutdownBehavior": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "instanceInitiatedShutdownBehavior" + } + }, + "rootDeviceName": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rootDeviceName" + } + }, + "blockDeviceMapping": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "blockDeviceMapping" + } + }, + "productCodes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "productCodes" + } + }, + "sourceDestCheck": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sourceDestCheck" + } + }, + "groupSet": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "groupSet" + } + }, + "ebsOptimized": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ebsOptimized" + } + }, + "sriovNetSupport": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sriovNetSupport" + } + }, + "enaSupport": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enaSupport" + } + }, + "enclaveOptions": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enclaveOptions" + } + }, + "disableApiStop": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disableApiStop" + } + } + } + }, + "com.amazonaws.ec2#InstanceAutoRecoveryState": { + "type": "enum", + "members": { + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "default": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "default" + } + } + } + }, + "com.amazonaws.ec2#InstanceBlockDeviceMapping": { + "type": "structure", + "members": { + "DeviceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DeviceName", + "smithy.api#documentation": "

The device name (for example, /dev/sdh or xvdh).

", + "smithy.api#xmlName": "deviceName" + } + }, + "Ebs": { + "target": "com.amazonaws.ec2#EbsInstanceBlockDevice", + "traits": { + "aws.protocols#ec2QueryName": "Ebs", + "smithy.api#documentation": "

Parameters used to automatically set up EBS volumes when the instance is\n launched.

", + "smithy.api#xmlName": "ebs" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a block device mapping.

" + } + }, + "com.amazonaws.ec2#InstanceBlockDeviceMappingList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceBlockDeviceMapping", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceBlockDeviceMappingSpecification": { + "type": "structure", + "members": { + "DeviceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DeviceName", + "smithy.api#documentation": "

The device name (for example, /dev/sdh or xvdh).

", + "smithy.api#xmlName": "deviceName" + } + }, + "Ebs": { + "target": "com.amazonaws.ec2#EbsInstanceBlockDeviceSpecification", + "traits": { + "aws.protocols#ec2QueryName": "Ebs", + "smithy.api#documentation": "

Parameters used to automatically set up EBS volumes when the instance is\n launched.

", + "smithy.api#xmlName": "ebs" + } + }, + "NoDevice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NoDevice", + "smithy.api#documentation": "

suppress the specified device included in the block device mapping.

", + "smithy.api#xmlName": "noDevice" + } + }, + "VirtualName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VirtualName", + "smithy.api#documentation": "

The virtual device name.

", + "smithy.api#xmlName": "virtualName" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a block device mapping entry.

" + } + }, + "com.amazonaws.ec2#InstanceBlockDeviceMappingSpecificationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceBlockDeviceMappingSpecification", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceBootModeValues": { + "type": "enum", + "members": { + "legacy_bios": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "legacy-bios" + } + }, + "uefi": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "uefi" + } + } + } + }, + "com.amazonaws.ec2#InstanceCapacity": { + "type": "structure", + "members": { + "AvailableCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "AvailableCapacity", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of instances that can be launched onto the Dedicated Host based on the\n host's available capacity.

", + "smithy.api#xmlName": "availableCapacity" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type supported by the Dedicated Host.

", + "smithy.api#xmlName": "instanceType" + } + }, + "TotalCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TotalCapacity", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of instances that can be launched onto the Dedicated Host if there\n are no instances running on it.

", + "smithy.api#xmlName": "totalCapacity" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the number of instances that can be launched onto the Dedicated\n Host.

" + } + }, + "com.amazonaws.ec2#InstanceConnectEndpointId": { + "type": "string" + }, + "com.amazonaws.ec2#InstanceConnectEndpointMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.ec2#InstanceConnectEndpointSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Ec2InstanceConnectEndpoint", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceCount": { + "type": "structure", + "members": { + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "InstanceCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of listed Reserved Instances in the state specified by the state.

", + "smithy.api#xmlName": "instanceCount" + } + }, + "State": { + "target": "com.amazonaws.ec2#ListingState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The states of the listed Reserved Instances.

", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Reserved Instance listing state.

" + } + }, + "com.amazonaws.ec2#InstanceCountList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceCount", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceCreditSpecification": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "CpuCredits": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CpuCredits", + "smithy.api#documentation": "

The credit option for CPU usage of the instance.

\n

Valid values: standard | unlimited\n

", + "smithy.api#xmlName": "cpuCredits" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the credit option for CPU usage of a burstable performance instance.

" + } + }, + "com.amazonaws.ec2#InstanceCreditSpecificationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceCreditSpecification", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceCreditSpecificationListRequest": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceCreditSpecificationRequest", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceCreditSpecificationRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {} + } + }, + "CpuCredits": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The credit option for CPU usage of the instance.

\n

Valid values: standard | unlimited\n

\n

T3 instances with host tenancy do not support the unlimited\n CPU credit option.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the credit option for CPU usage of a burstable performance instance.

" + } + }, + "com.amazonaws.ec2#InstanceEventId": { + "type": "string" + }, + "com.amazonaws.ec2#InstanceEventWindow": { + "type": "structure", + "members": { + "InstanceEventWindowId": { + "target": "com.amazonaws.ec2#InstanceEventWindowId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceEventWindowId", + "smithy.api#documentation": "

The ID of the event window.

", + "smithy.api#xmlName": "instanceEventWindowId" + } + }, + "TimeRanges": { + "target": "com.amazonaws.ec2#InstanceEventWindowTimeRangeList", + "traits": { + "aws.protocols#ec2QueryName": "TimeRangeSet", + "smithy.api#documentation": "

One or more time ranges defined for the event window.

", + "smithy.api#xmlName": "timeRangeSet" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The name of the event window.

", + "smithy.api#xmlName": "name" + } + }, + "CronExpression": { + "target": "com.amazonaws.ec2#InstanceEventWindowCronExpression", + "traits": { + "aws.protocols#ec2QueryName": "CronExpression", + "smithy.api#documentation": "

The cron expression defined for the event window.

", + "smithy.api#xmlName": "cronExpression" + } + }, + "AssociationTarget": { + "target": "com.amazonaws.ec2#InstanceEventWindowAssociationTarget", + "traits": { + "aws.protocols#ec2QueryName": "AssociationTarget", + "smithy.api#documentation": "

One or more targets associated with the event window.

", + "smithy.api#xmlName": "associationTarget" + } + }, + "State": { + "target": "com.amazonaws.ec2#InstanceEventWindowState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the event window.

", + "smithy.api#xmlName": "state" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The instance tags associated with the event window.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

The event window.

" + } + }, + "com.amazonaws.ec2#InstanceEventWindowAssociationRequest": { + "type": "structure", + "members": { + "InstanceIds": { + "target": "com.amazonaws.ec2#InstanceIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the instances to associate with the event window. If the instance is on a\n Dedicated Host, you can't specify the Instance ID parameter; you must use the Dedicated\n Host ID parameter.

", + "smithy.api#xmlName": "InstanceId" + } + }, + "InstanceTags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "smithy.api#documentation": "

The instance tags to associate with the event window. Any instances associated with the\n tags will be associated with the event window.

", + "smithy.api#xmlName": "InstanceTag" + } + }, + "DedicatedHostIds": { + "target": "com.amazonaws.ec2#DedicatedHostIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the Dedicated Hosts to associate with the event window.

", + "smithy.api#xmlName": "DedicatedHostId" + } + } + }, + "traits": { + "smithy.api#documentation": "

One or more targets associated with the specified event window. Only one\n type of target (instance ID, instance tag, or Dedicated Host ID)\n can be associated with an event window.

" + } + }, + "com.amazonaws.ec2#InstanceEventWindowAssociationTarget": { + "type": "structure", + "members": { + "InstanceIds": { + "target": "com.amazonaws.ec2#InstanceIdList", + "traits": { + "aws.protocols#ec2QueryName": "InstanceIdSet", + "smithy.api#documentation": "

The IDs of the instances associated with the event window.

", + "smithy.api#xmlName": "instanceIdSet" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The instance tags associated with the event window. Any instances associated with the tags\n will be associated with the event window.

", + "smithy.api#xmlName": "tagSet" + } + }, + "DedicatedHostIds": { + "target": "com.amazonaws.ec2#DedicatedHostIdList", + "traits": { + "aws.protocols#ec2QueryName": "DedicatedHostIdSet", + "smithy.api#documentation": "

The IDs of the Dedicated Hosts associated with the event window.

", + "smithy.api#xmlName": "dedicatedHostIdSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

One or more targets associated with the event window.

" + } + }, + "com.amazonaws.ec2#InstanceEventWindowCronExpression": { + "type": "string" + }, + "com.amazonaws.ec2#InstanceEventWindowDisassociationRequest": { + "type": "structure", + "members": { + "InstanceIds": { + "target": "com.amazonaws.ec2#InstanceIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the instances to disassociate from the event window.

", + "smithy.api#xmlName": "InstanceId" + } + }, + "InstanceTags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "smithy.api#documentation": "

The instance tags to disassociate from the event window. Any instances associated with\n the tags will be disassociated from the event window.

", + "smithy.api#xmlName": "InstanceTag" + } + }, + "DedicatedHostIds": { + "target": "com.amazonaws.ec2#DedicatedHostIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the Dedicated Hosts to disassociate from the event window.

", + "smithy.api#xmlName": "DedicatedHostId" + } + } + }, + "traits": { + "smithy.api#documentation": "

The targets to disassociate from the specified event window.

" + } + }, + "com.amazonaws.ec2#InstanceEventWindowId": { + "type": "string" + }, + "com.amazonaws.ec2#InstanceEventWindowIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceEventWindowId", + "traits": { + "smithy.api#xmlName": "InstanceEventWindowId" + } + } + }, + "com.amazonaws.ec2#InstanceEventWindowSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceEventWindow", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceEventWindowState": { + "type": "enum", + "members": { + "creating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "creating" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + } + } + }, + "com.amazonaws.ec2#InstanceEventWindowStateChange": { + "type": "structure", + "members": { + "InstanceEventWindowId": { + "target": "com.amazonaws.ec2#InstanceEventWindowId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceEventWindowId", + "smithy.api#documentation": "

The ID of the event window.

", + "smithy.api#xmlName": "instanceEventWindowId" + } + }, + "State": { + "target": "com.amazonaws.ec2#InstanceEventWindowState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the event window.

", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#documentation": "

The state of the event window.

" + } + }, + "com.amazonaws.ec2#InstanceEventWindowTimeRange": { + "type": "structure", + "members": { + "StartWeekDay": { + "target": "com.amazonaws.ec2#WeekDay", + "traits": { + "aws.protocols#ec2QueryName": "StartWeekDay", + "smithy.api#documentation": "

The day on which the time range begins.

", + "smithy.api#xmlName": "startWeekDay" + } + }, + "StartHour": { + "target": "com.amazonaws.ec2#Hour", + "traits": { + "aws.protocols#ec2QueryName": "StartHour", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The hour when the time range begins.

", + "smithy.api#xmlName": "startHour" + } + }, + "EndWeekDay": { + "target": "com.amazonaws.ec2#WeekDay", + "traits": { + "aws.protocols#ec2QueryName": "EndWeekDay", + "smithy.api#documentation": "

The day on which the time range ends.

", + "smithy.api#xmlName": "endWeekDay" + } + }, + "EndHour": { + "target": "com.amazonaws.ec2#Hour", + "traits": { + "aws.protocols#ec2QueryName": "EndHour", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The hour when the time range ends.

", + "smithy.api#xmlName": "endHour" + } + } + }, + "traits": { + "smithy.api#documentation": "

The start day and time and the end day and time of the time range, in UTC.

" + } + }, + "com.amazonaws.ec2#InstanceEventWindowTimeRangeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceEventWindowTimeRange", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceEventWindowTimeRangeRequest": { + "type": "structure", + "members": { + "StartWeekDay": { + "target": "com.amazonaws.ec2#WeekDay", + "traits": { + "smithy.api#documentation": "

The day on which the time range begins.

" + } + }, + "StartHour": { + "target": "com.amazonaws.ec2#Hour", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The hour when the time range begins.

" + } + }, + "EndWeekDay": { + "target": "com.amazonaws.ec2#WeekDay", + "traits": { + "smithy.api#documentation": "

The day on which the time range ends.

" + } + }, + "EndHour": { + "target": "com.amazonaws.ec2#Hour", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The hour when the time range ends.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The start day and time and the end day and time of the time range, in UTC.

" + } + }, + "com.amazonaws.ec2#InstanceEventWindowTimeRangeRequestSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceEventWindowTimeRangeRequest" + } + }, + "com.amazonaws.ec2#InstanceExportDetails": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the resource being exported.

", + "smithy.api#xmlName": "instanceId" + } + }, + "TargetEnvironment": { + "target": "com.amazonaws.ec2#ExportEnvironment", + "traits": { + "aws.protocols#ec2QueryName": "TargetEnvironment", + "smithy.api#documentation": "

The target virtualization environment.

", + "smithy.api#xmlName": "targetEnvironment" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an instance to export.

" + } + }, + "com.amazonaws.ec2#InstanceFamilyCreditSpecification": { + "type": "structure", + "members": { + "InstanceFamily": { + "target": "com.amazonaws.ec2#UnlimitedSupportedInstanceFamily", + "traits": { + "aws.protocols#ec2QueryName": "InstanceFamily", + "smithy.api#documentation": "

The instance family.

", + "smithy.api#xmlName": "instanceFamily" + } + }, + "CpuCredits": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CpuCredits", + "smithy.api#documentation": "

The default credit option for CPU usage of the instance family. Valid values are\n standard and unlimited.

", + "smithy.api#xmlName": "cpuCredits" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the default credit option for CPU usage of a burstable performance instance\n family.

" + } + }, + "com.amazonaws.ec2#InstanceGeneration": { + "type": "enum", + "members": { + "CURRENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "current" + } + }, + "PREVIOUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "previous" + } + } + } + }, + "com.amazonaws.ec2#InstanceGenerationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceGeneration", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceHealthStatus": { + "type": "enum", + "members": { + "HEALTHY_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "healthy" + } + }, + "UNHEALTHY_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unhealthy" + } + } + } + }, + "com.amazonaws.ec2#InstanceId": { + "type": "string" + }, + "com.amazonaws.ec2#InstanceIdForResolver": { + "type": "string" + }, + "com.amazonaws.ec2#InstanceIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#xmlName": "InstanceId" + } + } + }, + "com.amazonaws.ec2#InstanceIdWithVolumeResolver": { + "type": "string" + }, + "com.amazonaws.ec2#InstanceIdsSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceInterruptionBehavior": { + "type": "enum", + "members": { + "hibernate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hibernate" + } + }, + "stop": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stop" + } + }, + "terminate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "terminate" + } + } + } + }, + "com.amazonaws.ec2#InstanceIpv4Prefix": { + "type": "structure", + "members": { + "Ipv4Prefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv4Prefix", + "smithy.api#documentation": "

One or more IPv4 prefixes assigned to the network interface.

", + "smithy.api#xmlName": "ipv4Prefix" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an IPv4 prefix.

" + } + }, + "com.amazonaws.ec2#InstanceIpv4PrefixList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceIpv4Prefix", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceIpv6Address": { + "type": "structure", + "members": { + "Ipv6Address": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Address", + "smithy.api#documentation": "

The IPv6 address.

", + "smithy.api#xmlName": "ipv6Address" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an IPv6 address.

" + } + }, + "com.amazonaws.ec2#InstanceIpv6AddressList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceIpv6Address", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceIpv6AddressListRequest": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceIpv6AddressRequest", + "traits": { + "smithy.api#xmlName": "InstanceIpv6Address" + } + } + }, + "com.amazonaws.ec2#InstanceIpv6AddressRequest": { + "type": "structure", + "members": { + "Ipv6Address": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv6 address.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an IPv6 address.

" + } + }, + "com.amazonaws.ec2#InstanceIpv6Prefix": { + "type": "structure", + "members": { + "Ipv6Prefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Prefix", + "smithy.api#documentation": "

One or more IPv6 prefixes assigned to the network interface.

", + "smithy.api#xmlName": "ipv6Prefix" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an IPv6 prefix.

" + } + }, + "com.amazonaws.ec2#InstanceIpv6PrefixList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceIpv6Prefix", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceLifecycle": { + "type": "enum", + "members": { + "SPOT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "spot" + } + }, + "ON_DEMAND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "on-demand" + } + } + } + }, + "com.amazonaws.ec2#InstanceLifecycleType": { + "type": "enum", + "members": { + "spot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "spot" + } + }, + "scheduled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scheduled" + } + } + } + }, + "com.amazonaws.ec2#InstanceList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Instance", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceMaintenanceOptions": { + "type": "structure", + "members": { + "AutoRecovery": { + "target": "com.amazonaws.ec2#InstanceAutoRecoveryState", + "traits": { + "aws.protocols#ec2QueryName": "AutoRecovery", + "smithy.api#documentation": "

Provides information on the current automatic recovery behavior of your\n instance.

", + "smithy.api#xmlName": "autoRecovery" + } + } + }, + "traits": { + "smithy.api#documentation": "

The maintenance options for the instance.

" + } + }, + "com.amazonaws.ec2#InstanceMaintenanceOptionsRequest": { + "type": "structure", + "members": { + "AutoRecovery": { + "target": "com.amazonaws.ec2#InstanceAutoRecoveryState", + "traits": { + "smithy.api#documentation": "

Disables the automatic recovery behavior of your instance or sets it to default. For\n more information, see Simplified automatic recovery.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The maintenance options for the instance.

" + } + }, + "com.amazonaws.ec2#InstanceMarketOptionsRequest": { + "type": "structure", + "members": { + "MarketType": { + "target": "com.amazonaws.ec2#MarketType", + "traits": { + "smithy.api#documentation": "

The market type.

" + } + }, + "SpotOptions": { + "target": "com.amazonaws.ec2#SpotMarketOptions", + "traits": { + "smithy.api#documentation": "

The options for Spot Instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the market (purchasing) option for the instances.

" + } + }, + "com.amazonaws.ec2#InstanceMatchCriteria": { + "type": "enum", + "members": { + "open": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "open" + } + }, + "targeted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "targeted" + } + } + } + }, + "com.amazonaws.ec2#InstanceMetadataEndpointState": { + "type": "enum", + "members": { + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + } + } + }, + "com.amazonaws.ec2#InstanceMetadataOptionsRequest": { + "type": "structure", + "members": { + "HttpTokens": { + "target": "com.amazonaws.ec2#HttpTokensState", + "traits": { + "smithy.api#documentation": "

IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to optional\n (in other words, set the use of IMDSv2 to optional) or\n required (in other words, set the use of IMDSv2 to\n required).

\n \n

Default: optional\n

" + } + }, + "HttpPutResponseHopLimit": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel.

\n

Default: 1

\n

Possible values: Integers from 1 to 64

" + } + }, + "HttpEndpoint": { + "target": "com.amazonaws.ec2#InstanceMetadataEndpointState", + "traits": { + "smithy.api#documentation": "

Enables or disables the HTTP metadata endpoint on your instances.

\n

If you specify a value of disabled, you cannot access your instance\n metadata.

\n

Default: enabled\n

" + } + }, + "HttpProtocolIpv6": { + "target": "com.amazonaws.ec2#InstanceMetadataProtocolState", + "traits": { + "smithy.api#documentation": "

Enables or disables the IPv6 endpoint for the instance metadata service.

" + } + }, + "InstanceMetadataTags": { + "target": "com.amazonaws.ec2#InstanceMetadataTagsState", + "traits": { + "smithy.api#documentation": "

Set to enabled to allow access to instance tags from the instance\n metadata. Set to disabled to turn off access to instance tags from the\n instance metadata. For more information, see Work with\n instance tags using the instance metadata.

\n

Default: disabled\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The metadata options for the instance.

" + } + }, + "com.amazonaws.ec2#InstanceMetadataOptionsResponse": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.ec2#InstanceMetadataOptionsState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the metadata option changes.

\n

\n pending - The metadata options are being updated and the instance is not\n ready to process metadata traffic with the new selection.

\n

\n applied - The metadata options have been successfully applied on the\n instance.

", + "smithy.api#xmlName": "state" + } + }, + "HttpTokens": { + "target": "com.amazonaws.ec2#HttpTokensState", + "traits": { + "aws.protocols#ec2QueryName": "HttpTokens", + "smithy.api#documentation": "

IMDSv2 uses token-backed sessions. Indicates whether the use of HTTP tokens is\n optional (in other words, indicates whether the use of IMDSv2 is\n optional) or required (in other words, indicates whether\n the use of IMDSv2 is required).

\n \n

Default: optional\n

", + "smithy.api#xmlName": "httpTokens" + } + }, + "HttpPutResponseHopLimit": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "HttpPutResponseHopLimit", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel.

\n

Default: 1

\n

Possible values: Integers from 1 to 64

", + "smithy.api#xmlName": "httpPutResponseHopLimit" + } + }, + "HttpEndpoint": { + "target": "com.amazonaws.ec2#InstanceMetadataEndpointState", + "traits": { + "aws.protocols#ec2QueryName": "HttpEndpoint", + "smithy.api#documentation": "

Indicates whether the HTTP metadata endpoint on your instances is enabled or\n disabled.

\n

If the value is disabled, you cannot access your instance\n metadata.

", + "smithy.api#xmlName": "httpEndpoint" + } + }, + "HttpProtocolIpv6": { + "target": "com.amazonaws.ec2#InstanceMetadataProtocolState", + "traits": { + "aws.protocols#ec2QueryName": "HttpProtocolIpv6", + "smithy.api#documentation": "

Indicates whether the IPv6 endpoint for the instance metadata service is enabled or\n disabled.

", + "smithy.api#xmlName": "httpProtocolIpv6" + } + }, + "InstanceMetadataTags": { + "target": "com.amazonaws.ec2#InstanceMetadataTagsState", + "traits": { + "aws.protocols#ec2QueryName": "InstanceMetadataTags", + "smithy.api#documentation": "

Indicates whether access to instance tags from the instance metadata is enabled or\n disabled. For more information, see Work with\n instance tags using the instance metadata.

", + "smithy.api#xmlName": "instanceMetadataTags" + } + } + }, + "traits": { + "smithy.api#documentation": "

The metadata options for the instance.

" + } + }, + "com.amazonaws.ec2#InstanceMetadataOptionsState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "applied": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "applied" + } + } + } + }, + "com.amazonaws.ec2#InstanceMetadataProtocolState": { + "type": "enum", + "members": { + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + } + } + }, + "com.amazonaws.ec2#InstanceMetadataTagsState": { + "type": "enum", + "members": { + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + } + } + }, + "com.amazonaws.ec2#InstanceMonitoring": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "Monitoring": { + "target": "com.amazonaws.ec2#Monitoring", + "traits": { + "aws.protocols#ec2QueryName": "Monitoring", + "smithy.api#documentation": "

The monitoring for the instance.

", + "smithy.api#xmlName": "monitoring" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the monitoring of an instance.

" + } + }, + "com.amazonaws.ec2#InstanceMonitoringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceMonitoring", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceNetworkInterface": { + "type": "structure", + "members": { + "Association": { + "target": "com.amazonaws.ec2#InstanceNetworkInterfaceAssociation", + "traits": { + "aws.protocols#ec2QueryName": "Association", + "smithy.api#documentation": "

The association information for an Elastic IPv4 associated with the network\n interface.

", + "smithy.api#xmlName": "association" + } + }, + "Attachment": { + "target": "com.amazonaws.ec2#InstanceNetworkInterfaceAttachment", + "traits": { + "aws.protocols#ec2QueryName": "Attachment", + "smithy.api#documentation": "

The network interface attachment.

", + "smithy.api#xmlName": "attachment" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description.

", + "smithy.api#xmlName": "description" + } + }, + "Groups": { + "target": "com.amazonaws.ec2#GroupIdentifierList", + "traits": { + "aws.protocols#ec2QueryName": "GroupSet", + "smithy.api#documentation": "

The security groups.

", + "smithy.api#xmlName": "groupSet" + } + }, + "Ipv6Addresses": { + "target": "com.amazonaws.ec2#InstanceIpv6AddressList", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6AddressesSet", + "smithy.api#documentation": "

The IPv6 addresses associated with the network interface.

", + "smithy.api#xmlName": "ipv6AddressesSet" + } + }, + "MacAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "MacAddress", + "smithy.api#documentation": "

The MAC address.

", + "smithy.api#xmlName": "macAddress" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that created the network interface.

", + "smithy.api#xmlName": "ownerId" + } + }, + "PrivateDnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDnsName", + "smithy.api#documentation": "

The private DNS name.

", + "smithy.api#xmlName": "privateDnsName" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

The IPv4 address of the network interface within the subnet.

", + "smithy.api#xmlName": "privateIpAddress" + } + }, + "PrivateIpAddresses": { + "target": "com.amazonaws.ec2#InstancePrivateIpAddressList", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddressesSet", + "smithy.api#documentation": "

The private IPv4 addresses associated with the network interface.

", + "smithy.api#xmlName": "privateIpAddressesSet" + } + }, + "SourceDestCheck": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "SourceDestCheck", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether source/destination checking is enabled.

", + "smithy.api#xmlName": "sourceDestCheck" + } + }, + "Status": { + "target": "com.amazonaws.ec2#NetworkInterfaceStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status of the network interface.

", + "smithy.api#xmlName": "status" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet.

", + "smithy.api#xmlName": "subnetId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } + }, + "InterfaceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InterfaceType", + "smithy.api#documentation": "

The type of network interface.

\n

Valid values: interface | efa | trunk\n

", + "smithy.api#xmlName": "interfaceType" + } + }, + "Ipv4Prefixes": { + "target": "com.amazonaws.ec2#InstanceIpv4PrefixList", + "traits": { + "aws.protocols#ec2QueryName": "Ipv4PrefixSet", + "smithy.api#documentation": "

The IPv4 delegated prefixes that are assigned to the network interface.

", + "smithy.api#xmlName": "ipv4PrefixSet" + } + }, + "Ipv6Prefixes": { + "target": "com.amazonaws.ec2#InstanceIpv6PrefixList", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6PrefixSet", + "smithy.api#documentation": "

The IPv6 delegated prefixes that are assigned to the network interface.

", + "smithy.api#xmlName": "ipv6PrefixSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a network interface.

" + } + }, + "com.amazonaws.ec2#InstanceNetworkInterfaceAssociation": { + "type": "structure", + "members": { + "CarrierIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CarrierIp", + "smithy.api#documentation": "

The carrier IP address associated with the network interface.

", + "smithy.api#xmlName": "carrierIp" + } + }, + "CustomerOwnedIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CustomerOwnedIp", + "smithy.api#documentation": "

The customer-owned IP address associated with the network interface.

", + "smithy.api#xmlName": "customerOwnedIp" + } + }, + "IpOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpOwnerId", + "smithy.api#documentation": "

The ID of the owner of the Elastic IP address.

", + "smithy.api#xmlName": "ipOwnerId" + } + }, + "PublicDnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicDnsName", + "smithy.api#documentation": "

The public DNS name.

", + "smithy.api#xmlName": "publicDnsName" + } + }, + "PublicIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicIp", + "smithy.api#documentation": "

The public IP address or Elastic IP address bound to the network interface.

", + "smithy.api#xmlName": "publicIp" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes association information for an Elastic IP address (IPv4).

" + } + }, + "com.amazonaws.ec2#InstanceNetworkInterfaceAttachment": { + "type": "structure", + "members": { + "AttachTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "AttachTime", + "smithy.api#documentation": "

The time stamp when the attachment initiated.

", + "smithy.api#xmlName": "attachTime" + } + }, + "AttachmentId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AttachmentId", + "smithy.api#documentation": "

The ID of the network interface attachment.

", + "smithy.api#xmlName": "attachmentId" + } + }, + "DeleteOnTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DeleteOnTermination", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the network interface is deleted when the instance is terminated.

", + "smithy.api#xmlName": "deleteOnTermination" + } + }, + "DeviceIndex": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "DeviceIndex", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The index of the device on the instance for the network interface attachment.

", + "smithy.api#xmlName": "deviceIndex" + } + }, + "Status": { + "target": "com.amazonaws.ec2#AttachmentStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The attachment state.

", + "smithy.api#xmlName": "status" + } + }, + "NetworkCardIndex": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "NetworkCardIndex", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The index of the network card.

", + "smithy.api#xmlName": "networkCardIndex" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a network interface attachment.

" + } + }, + "com.amazonaws.ec2#InstanceNetworkInterfaceList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceNetworkInterface", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceNetworkInterfaceSpecification": { + "type": "structure", + "members": { + "AssociatePublicIpAddress": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AssociatePublicIpAddress", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The\n public IP address can only be assigned to a network interface for eth0, and can only be\n assigned to a new network interface, not an existing one. You cannot specify more than one\n network interface in the request. If launching into a default subnet, the default value is\n true.

", + "smithy.api#xmlName": "associatePublicIpAddress" + } + }, + "DeleteOnTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DeleteOnTermination", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

If set to true, the interface is deleted when the instance is terminated. You can\n specify true only if creating a new network interface when launching an\n instance.

", + "smithy.api#xmlName": "deleteOnTermination" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of the network interface. Applies only if creating a network interface when launching an instance.

", + "smithy.api#xmlName": "description" + } + }, + "DeviceIndex": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "DeviceIndex", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The position of the network interface in the attachment order. \n A primary network interface has a device index of 0.

\n

If you specify a network interface when launching an instance, \n you must specify the device index.

", + "smithy.api#xmlName": "deviceIndex" + } + }, + "Groups": { + "target": "com.amazonaws.ec2#SecurityGroupIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

", + "smithy.api#xmlName": "SecurityGroupId" + } + }, + "Ipv6AddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6AddressCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses\n the IPv6 addresses from the range of the subnet. You cannot specify this option and the\n option to assign specific IPv6 addresses in the same request. You can specify this\n option if you've specified a minimum number of instances to launch.

", + "smithy.api#xmlName": "ipv6AddressCount" + } + }, + "Ipv6Addresses": { + "target": "com.amazonaws.ec2#InstanceIpv6AddressList", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Addresses", + "smithy.api#documentation": "

The IPv6 addresses to assign to the network interface. You cannot specify\n this option and the option to assign a number of IPv6 addresses in the same request. You\n cannot specify this option if you've specified a minimum number of instances to\n launch.

", + "smithy.api#xmlName": "ipv6AddressesSet" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface.

\n

If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#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\n \tmore than one instance in a RunInstances request.

", + "smithy.api#xmlName": "privateIpAddress" + } + }, + "PrivateIpAddresses": { + "target": "com.amazonaws.ec2#PrivateIpAddressSpecificationList", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddresses", + "smithy.api#documentation": "

The 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\n \tlaunching more than one instance in a RunInstances request.

", + "smithy.api#xmlName": "privateIpAddressesSet" + } + }, + "SecondaryPrivateIpAddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "SecondaryPrivateIpAddressCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#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\n \tlaunching more than one instance in a RunInstances request.

", + "smithy.api#xmlName": "secondaryPrivateIpAddressCount" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.

", + "smithy.api#xmlName": "subnetId" + } + }, + "AssociateCarrierIpAddress": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to assign a carrier IP address to the network interface.

\n

You can only assign a carrier IP address to a network interface that is in a subnet in\n a Wavelength Zone. For more information about carrier IP addresses, see Carrier IP address in the Amazon Web Services Wavelength Developer\n Guide.

" + } + }, + "InterfaceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The type of network interface.

\n

Valid values: interface | efa\n

" + } + }, + "NetworkCardIndex": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The index of the network card. Some instance types support multiple network cards. \n The primary network interface must be assigned to network card index 0. \n The default is network card index 0.

\n

If you are using RequestSpotInstances to create Spot Instances, omit this parameter because\n you can’t specify the network card index when using this API. To specify the network\n card index, use RunInstances.

" + } + }, + "Ipv4Prefixes": { + "target": "com.amazonaws.ec2#Ipv4PrefixList", + "traits": { + "smithy.api#documentation": "

The IPv4 delegated prefixes to be assigned to the network interface. You cannot \n use this option if you use the Ipv4PrefixCount option.

", + "smithy.api#xmlName": "Ipv4Prefix" + } + }, + "Ipv4PrefixCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of IPv4 delegated prefixes to be automatically assigned to the network interface. \n You cannot use this option if you use the Ipv4Prefix option.

" + } + }, + "Ipv6Prefixes": { + "target": "com.amazonaws.ec2#Ipv6PrefixList", + "traits": { + "smithy.api#documentation": "

The IPv6 delegated prefixes to be assigned to the network interface. You cannot \n use this option if you use the Ipv6PrefixCount option.

", + "smithy.api#xmlName": "Ipv6Prefix" + } + }, + "Ipv6PrefixCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of IPv6 delegated prefixes to be automatically assigned to the network interface. \n You cannot use this option if you use the Ipv6Prefix option.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a network interface.

" + } + }, + "com.amazonaws.ec2#InstanceNetworkInterfaceSpecificationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceNetworkInterfaceSpecification", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstancePrivateIpAddress": { + "type": "structure", + "members": { + "Association": { + "target": "com.amazonaws.ec2#InstanceNetworkInterfaceAssociation", + "traits": { + "aws.protocols#ec2QueryName": "Association", + "smithy.api#documentation": "

The association information for an Elastic IP address for the network interface.

", + "smithy.api#xmlName": "association" + } + }, + "Primary": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Primary", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether this IPv4 address is the primary private IP address of the network interface.

", + "smithy.api#xmlName": "primary" + } + }, + "PrivateDnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDnsName", + "smithy.api#documentation": "

The private IPv4 DNS name.

", + "smithy.api#xmlName": "privateDnsName" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

The private IPv4 address of the network interface.

", + "smithy.api#xmlName": "privateIpAddress" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a private IPv4 address.

" + } + }, + "com.amazonaws.ec2#InstancePrivateIpAddressList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstancePrivateIpAddress", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceRequirements": { + "type": "structure", + "members": { + "VCpuCount": { + "target": "com.amazonaws.ec2#VCpuCountRange", + "traits": { + "aws.protocols#ec2QueryName": "VCpuCount", + "smithy.api#documentation": "

The minimum and maximum number of vCPUs.

", + "smithy.api#xmlName": "vCpuCount" + } + }, + "MemoryMiB": { + "target": "com.amazonaws.ec2#MemoryMiB", + "traits": { + "aws.protocols#ec2QueryName": "MemoryMiB", + "smithy.api#documentation": "

The minimum and maximum amount of memory, in MiB.

", + "smithy.api#xmlName": "memoryMiB" + } + }, + "CpuManufacturers": { + "target": "com.amazonaws.ec2#CpuManufacturerSet", + "traits": { + "aws.protocols#ec2QueryName": "CpuManufacturerSet", + "smithy.api#documentation": "

The CPU manufacturers to include.

\n \n \n

Don't confuse the CPU manufacturer with the CPU architecture. Instances will \n be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you \n specify in your launch template.

\n \n

Default: Any manufacturer

", + "smithy.api#xmlName": "cpuManufacturerSet" + } + }, + "MemoryGiBPerVCpu": { + "target": "com.amazonaws.ec2#MemoryGiBPerVCpu", + "traits": { + "aws.protocols#ec2QueryName": "MemoryGiBPerVCpu", + "smithy.api#documentation": "

The minimum and maximum amount of memory per vCPU, in GiB.

\n

Default: No minimum or maximum limits

", + "smithy.api#xmlName": "memoryGiBPerVCpu" + } + }, + "ExcludedInstanceTypes": { + "target": "com.amazonaws.ec2#ExcludedInstanceTypeSet", + "traits": { + "aws.protocols#ec2QueryName": "ExcludedInstanceTypeSet", + "smithy.api#documentation": "

The instance types to exclude.

\n

You can use strings with one or more wild cards, represented by\n an asterisk (*), to exclude an instance type, size, or generation. The\n following are examples: m5.8xlarge, c5*.*, m5a.*,\n r*, *3*.

\n

For example, if you specify c5*,Amazon EC2 will exclude the entire C5 instance\n family, which includes all C5a and C5n instance types. If you specify\n m5a.*, Amazon EC2 will exclude all the M5a instance types, but not the M5n\n instance types.

\n \n

If you specify ExcludedInstanceTypes, you can't specify AllowedInstanceTypes.

\n \n

Default: No excluded instance types

", + "smithy.api#xmlName": "excludedInstanceTypeSet" + } + }, + "InstanceGenerations": { + "target": "com.amazonaws.ec2#InstanceGenerationSet", + "traits": { + "aws.protocols#ec2QueryName": "InstanceGenerationSet", + "smithy.api#documentation": "

Indicates whether current or previous generation instance types are included. The\n current generation instance types are recommended for use. Current generation instance types are\n typically the latest two to three generations in each instance family. For more\n information, see Instance types in the\n Amazon EC2 User Guide.

\n

For current generation instance types, specify current.

\n

For previous generation instance types, specify previous.

\n

Default: Current and previous generation instance types

", + "smithy.api#xmlName": "instanceGenerationSet" + } + }, + "SpotMaxPricePercentageOverLowestPrice": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "SpotMaxPricePercentageOverLowestPrice", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance,\n expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified\n attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance\n types priced above your threshold.

\n

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

\n

To turn off price protection, specify a high value, such as 999999.

\n

This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.

\n \n

If you set TargetCapacityUnitType to vcpu or\n memory-mib, the price protection threshold is applied based on the\n per-vCPU or per-memory price instead of the per-instance price.

\n \n

Default: 100\n

", + "smithy.api#xmlName": "spotMaxPricePercentageOverLowestPrice" + } + }, + "OnDemandMaxPricePercentageOverLowestPrice": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "OnDemandMaxPricePercentageOverLowestPrice", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance,\n expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified\n attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance\n types priced above your threshold.

\n

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

\n

To turn off price protection, specify a high value, such as 999999.

\n

This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.

\n \n

If you set TargetCapacityUnitType to vcpu or\n memory-mib, the price protection threshold is applied based on the\n per-vCPU or per-memory price instead of the per-instance price.

\n \n

Default: 20\n

", + "smithy.api#xmlName": "onDemandMaxPricePercentageOverLowestPrice" + } + }, + "BareMetal": { + "target": "com.amazonaws.ec2#BareMetal", + "traits": { + "aws.protocols#ec2QueryName": "BareMetal", + "smithy.api#documentation": "

Indicates whether bare metal instance types must be included, excluded, or required.

\n \n

Default: excluded\n

", + "smithy.api#xmlName": "bareMetal" + } + }, + "BurstablePerformance": { + "target": "com.amazonaws.ec2#BurstablePerformance", + "traits": { + "aws.protocols#ec2QueryName": "BurstablePerformance", + "smithy.api#documentation": "

Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see \n Burstable performance instances.

\n \n

Default: excluded\n

", + "smithy.api#xmlName": "burstablePerformance" + } + }, + "RequireHibernateSupport": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "RequireHibernateSupport", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether instance types must support hibernation for On-Demand\n Instances.

\n

This parameter is not supported for GetSpotPlacementScores.

\n

Default: false\n

", + "smithy.api#xmlName": "requireHibernateSupport" + } + }, + "NetworkInterfaceCount": { + "target": "com.amazonaws.ec2#NetworkInterfaceCount", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceCount", + "smithy.api#documentation": "

The minimum and maximum number of network interfaces.

\n

Default: No minimum or maximum limits

", + "smithy.api#xmlName": "networkInterfaceCount" + } + }, + "LocalStorage": { + "target": "com.amazonaws.ec2#LocalStorage", + "traits": { + "aws.protocols#ec2QueryName": "LocalStorage", + "smithy.api#documentation": "

Indicates whether instance types with instance store volumes are included, excluded, or required. For more information,\n Amazon\n EC2 instance store in the Amazon EC2 User Guide.

\n \n

Default: included\n

", + "smithy.api#xmlName": "localStorage" + } + }, + "LocalStorageTypes": { + "target": "com.amazonaws.ec2#LocalStorageTypeSet", + "traits": { + "aws.protocols#ec2QueryName": "LocalStorageTypeSet", + "smithy.api#documentation": "

The type of local storage that is required.

\n \n

Default: hdd and ssd\n

", + "smithy.api#xmlName": "localStorageTypeSet" + } + }, + "TotalLocalStorageGB": { + "target": "com.amazonaws.ec2#TotalLocalStorageGB", + "traits": { + "aws.protocols#ec2QueryName": "TotalLocalStorageGB", + "smithy.api#documentation": "

The minimum and maximum amount of total local storage, in GB.

\n

Default: No minimum or maximum limits

", + "smithy.api#xmlName": "totalLocalStorageGB" + } + }, + "BaselineEbsBandwidthMbps": { + "target": "com.amazonaws.ec2#BaselineEbsBandwidthMbps", + "traits": { + "aws.protocols#ec2QueryName": "BaselineEbsBandwidthMbps", + "smithy.api#documentation": "

The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see\n Amazon\n EBS–optimized instances in the Amazon EC2 User Guide.

\n

Default: No minimum or maximum limits

", + "smithy.api#xmlName": "baselineEbsBandwidthMbps" + } + }, + "AcceleratorTypes": { + "target": "com.amazonaws.ec2#AcceleratorTypeSet", + "traits": { + "aws.protocols#ec2QueryName": "AcceleratorTypeSet", + "smithy.api#documentation": "

The accelerator types that must be on the instance type.

\n \n

Default: Any accelerator type

", + "smithy.api#xmlName": "acceleratorTypeSet" + } + }, + "AcceleratorCount": { + "target": "com.amazonaws.ec2#AcceleratorCount", + "traits": { + "aws.protocols#ec2QueryName": "AcceleratorCount", + "smithy.api#documentation": "

The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on\n an instance.

\n

To exclude accelerator-enabled instance types, set Max to 0.

\n

Default: No minimum or maximum limits

", + "smithy.api#xmlName": "acceleratorCount" + } + }, + "AcceleratorManufacturers": { + "target": "com.amazonaws.ec2#AcceleratorManufacturerSet", + "traits": { + "aws.protocols#ec2QueryName": "AcceleratorManufacturerSet", + "smithy.api#documentation": "

Indicates whether instance types must have accelerators by specific manufacturers.

\n \n

Default: Any manufacturer

", + "smithy.api#xmlName": "acceleratorManufacturerSet" + } + }, + "AcceleratorNames": { + "target": "com.amazonaws.ec2#AcceleratorNameSet", + "traits": { + "aws.protocols#ec2QueryName": "AcceleratorNameSet", + "smithy.api#documentation": "

The accelerators that must be on the instance type.

\n \n

Default: Any accelerator

", + "smithy.api#xmlName": "acceleratorNameSet" + } + }, + "AcceleratorTotalMemoryMiB": { + "target": "com.amazonaws.ec2#AcceleratorTotalMemoryMiB", + "traits": { + "aws.protocols#ec2QueryName": "AcceleratorTotalMemoryMiB", + "smithy.api#documentation": "

The minimum and maximum amount of total accelerator memory, in MiB.

\n

Default: No minimum or maximum limits

", + "smithy.api#xmlName": "acceleratorTotalMemoryMiB" + } + }, + "NetworkBandwidthGbps": { + "target": "com.amazonaws.ec2#NetworkBandwidthGbps", + "traits": { + "aws.protocols#ec2QueryName": "NetworkBandwidthGbps", + "smithy.api#documentation": "

The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).

\n

Default: No minimum or maximum limits

", + "smithy.api#xmlName": "networkBandwidthGbps" + } + }, + "AllowedInstanceTypes": { + "target": "com.amazonaws.ec2#AllowedInstanceTypeSet", + "traits": { + "aws.protocols#ec2QueryName": "AllowedInstanceTypeSet", + "smithy.api#documentation": "

The instance types to apply your specified attributes against. All other instance types \n are ignored, even if they match your specified attributes.

\n

You can use strings with one or more wild cards, represented by\n an asterisk (*), to allow an instance type, size, or generation. The\n following are examples: m5.8xlarge, c5*.*, m5a.*,\n r*, *3*.

\n

For example, if you specify c5*,Amazon EC2 will allow the entire C5 instance\n family, which includes all C5a and C5n instance types. If you specify\n m5a.*, Amazon EC2 will allow all the M5a instance types, but not the M5n\n instance types.

\n \n

If you specify AllowedInstanceTypes, you can't specify ExcludedInstanceTypes.

\n \n

Default: All instance types

", + "smithy.api#xmlName": "allowedInstanceTypeSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with these attributes.

\n

When you specify multiple attributes, you get instance types that satisfy all of the\n specified attributes. If you specify multiple values for an attribute, you get instance\n types that satisfy any of the specified values.

\n

To limit the list of instance types from which Amazon EC2 can identify matching instance types, \n you can use one of the following parameters, but not both in the same request:

\n \n \n

You must specify VCpuCount and MemoryMiB. All other attributes\n are optional. Any unspecified optional attribute is set to its default.

\n \n

For more information, see Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot\n placement score in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#InstanceRequirementsRequest": { + "type": "structure", + "members": { + "VCpuCount": { + "target": "com.amazonaws.ec2#VCpuCountRangeRequest", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The minimum and maximum number of vCPUs.

", + "smithy.api#required": {} + } + }, + "MemoryMiB": { + "target": "com.amazonaws.ec2#MemoryMiBRequest", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The minimum and maximum amount of memory, in MiB.

", + "smithy.api#required": {} + } + }, + "CpuManufacturers": { + "target": "com.amazonaws.ec2#CpuManufacturerSet", + "traits": { + "smithy.api#documentation": "

The CPU manufacturers to include.

\n \n \n

Don't confuse the CPU manufacturer with the CPU architecture. Instances will \n be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you \n specify in your launch template.

\n \n

Default: Any manufacturer

", + "smithy.api#xmlName": "CpuManufacturer" + } + }, + "MemoryGiBPerVCpu": { + "target": "com.amazonaws.ec2#MemoryGiBPerVCpuRequest", + "traits": { + "smithy.api#documentation": "

The minimum and maximum amount of memory per vCPU, in GiB.

\n

Default: No minimum or maximum limits

" + } + }, + "ExcludedInstanceTypes": { + "target": "com.amazonaws.ec2#ExcludedInstanceTypeSet", + "traits": { + "smithy.api#documentation": "

The instance types to exclude.

\n

You can use strings with one or more wild cards, represented by\n an asterisk (*), to exclude an instance family, type, size, or generation. The\n following are examples: m5.8xlarge, c5*.*, m5a.*,\n r*, *3*.

\n

For example, if you specify c5*,Amazon EC2 will exclude the entire C5 instance\n family, which includes all C5a and C5n instance types. If you specify\n m5a.*, Amazon EC2 will exclude all the M5a instance types, but not the M5n\n instance types.

\n \n

If you specify ExcludedInstanceTypes, you can't specify AllowedInstanceTypes.

\n \n

Default: No excluded instance types

", + "smithy.api#xmlName": "ExcludedInstanceType" + } + }, + "InstanceGenerations": { + "target": "com.amazonaws.ec2#InstanceGenerationSet", + "traits": { + "smithy.api#documentation": "

Indicates whether current or previous generation instance types are included. The\n current generation instance types are recommended for use. Current generation instance types are\n typically the latest two to three generations in each instance family. For more\n information, see Instance types in the\n Amazon EC2 User Guide.

\n

For current generation instance types, specify current.

\n

For previous generation instance types, specify previous.

\n

Default: Current and previous generation instance types

", + "smithy.api#xmlName": "InstanceGeneration" + } + }, + "SpotMaxPricePercentageOverLowestPrice": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The price protection threshold for Spot Instance. This is the maximum you’ll pay for an Spot Instance,\n expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified\n attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance\n types priced above your threshold.

\n

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

\n

To turn off price protection, specify a high value, such as 999999.

\n

This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.

\n \n

If you set TargetCapacityUnitType to vcpu or\n memory-mib, the price protection threshold is applied based on the\n per-vCPU or per-memory price instead of the per-instance price.

\n \n

Default: 100\n

" + } + }, + "OnDemandMaxPricePercentageOverLowestPrice": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance,\n expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified\n attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance\n types priced above your threshold.

\n

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

\n

To turn off price protection, specify a high value, such as 999999.

\n

This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.

\n \n

If you set TargetCapacityUnitType to vcpu or\n memory-mib, the price protection threshold is applied based on the\n per-vCPU or per-memory price instead of the per-instance price.

\n \n

Default: 20\n

" + } + }, + "BareMetal": { + "target": "com.amazonaws.ec2#BareMetal", + "traits": { + "smithy.api#documentation": "

Indicates whether bare metal instance types must be included, excluded, or required.

\n \n

Default: excluded\n

" + } + }, + "BurstablePerformance": { + "target": "com.amazonaws.ec2#BurstablePerformance", + "traits": { + "smithy.api#documentation": "

Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see \n Burstable performance instances.

\n \n

Default: excluded\n

" + } + }, + "RequireHibernateSupport": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether instance types must support hibernation for On-Demand Instances.

\n

This parameter is not supported for GetSpotPlacementScores.

\n

Default: false\n

" + } + }, + "NetworkInterfaceCount": { + "target": "com.amazonaws.ec2#NetworkInterfaceCountRequest", + "traits": { + "smithy.api#documentation": "

The minimum and maximum number of network interfaces.

\n

Default: No minimum or maximum limits

" + } + }, + "LocalStorage": { + "target": "com.amazonaws.ec2#LocalStorage", + "traits": { + "smithy.api#documentation": "

Indicates whether instance types with instance store volumes are included, excluded, or required. For more information,\n Amazon\n EC2 instance store in the Amazon EC2 User Guide.

\n \n

Default: included\n

" + } + }, + "LocalStorageTypes": { + "target": "com.amazonaws.ec2#LocalStorageTypeSet", + "traits": { + "smithy.api#documentation": "

The type of local storage that is required.

\n \n

Default: hdd and ssd\n

", + "smithy.api#xmlName": "LocalStorageType" + } + }, + "TotalLocalStorageGB": { + "target": "com.amazonaws.ec2#TotalLocalStorageGBRequest", + "traits": { + "smithy.api#documentation": "

The minimum and maximum amount of total local storage, in GB.

\n

Default: No minimum or maximum limits

" + } + }, + "BaselineEbsBandwidthMbps": { + "target": "com.amazonaws.ec2#BaselineEbsBandwidthMbpsRequest", + "traits": { + "smithy.api#documentation": "

The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see\n Amazon\n EBS–optimized instances in the Amazon EC2 User Guide.

\n

Default: No minimum or maximum limits

" + } + }, + "AcceleratorTypes": { + "target": "com.amazonaws.ec2#AcceleratorTypeSet", + "traits": { + "smithy.api#documentation": "

The accelerator types that must be on the instance type.

\n \n

Default: Any accelerator type

", + "smithy.api#xmlName": "AcceleratorType" + } + }, + "AcceleratorCount": { + "target": "com.amazonaws.ec2#AcceleratorCountRequest", + "traits": { + "smithy.api#documentation": "

The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on\n an instance.

\n

To exclude accelerator-enabled instance types, set Max to 0.

\n

Default: No minimum or maximum limits

" + } + }, + "AcceleratorManufacturers": { + "target": "com.amazonaws.ec2#AcceleratorManufacturerSet", + "traits": { + "smithy.api#documentation": "

Indicates whether instance types must have accelerators by specific manufacturers.

\n \n

Default: Any manufacturer

", + "smithy.api#xmlName": "AcceleratorManufacturer" + } + }, + "AcceleratorNames": { + "target": "com.amazonaws.ec2#AcceleratorNameSet", + "traits": { + "smithy.api#documentation": "

The accelerators that must be on the instance type.

\n \n

Default: Any accelerator

", + "smithy.api#xmlName": "AcceleratorName" + } + }, + "AcceleratorTotalMemoryMiB": { + "target": "com.amazonaws.ec2#AcceleratorTotalMemoryMiBRequest", + "traits": { + "smithy.api#documentation": "

The minimum and maximum amount of total accelerator memory, in MiB.

\n

Default: No minimum or maximum limits

" + } + }, + "NetworkBandwidthGbps": { + "target": "com.amazonaws.ec2#NetworkBandwidthGbpsRequest", + "traits": { + "smithy.api#documentation": "

The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).

\n

Default: No minimum or maximum limits

" + } + }, + "AllowedInstanceTypes": { + "target": "com.amazonaws.ec2#AllowedInstanceTypeSet", + "traits": { + "smithy.api#documentation": "

The instance types to apply your specified attributes against. All other instance types \n are ignored, even if they match your specified attributes.

\n

You can use strings with one or more wild cards, represented by\n an asterisk (*), to allow an instance type, size, or generation. The\n following are examples: m5.8xlarge, c5*.*, m5a.*,\n r*, *3*.

\n

For example, if you specify c5*,Amazon EC2 will allow the entire C5 instance\n family, which includes all C5a and C5n instance types. If you specify\n m5a.*, Amazon EC2 will allow all the M5a instance types, but not the M5n\n instance types.

\n \n

If you specify AllowedInstanceTypes, you can't specify ExcludedInstanceTypes.

\n \n

Default: All instance types

", + "smithy.api#xmlName": "AllowedInstanceType" + } + } + }, + "traits": { + "smithy.api#documentation": "

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with these attributes.

\n

When you specify multiple attributes, you get instance types that satisfy all of the\n specified attributes. If you specify multiple values for an attribute, you get instance\n types that satisfy any of the specified values.

\n

To limit the list of instance types from which Amazon EC2 can identify matching instance types, \n you can use one of the following parameters, but not both in the same request:

\n \n \n

You must specify VCpuCount and MemoryMiB. All other attributes\n are optional. Any unspecified optional attribute is set to its default.

\n \n

For more information, see Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot\n placement score in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#InstanceRequirementsWithMetadataRequest": { + "type": "structure", + "members": { + "ArchitectureTypes": { + "target": "com.amazonaws.ec2#ArchitectureTypeSet", + "traits": { + "smithy.api#documentation": "

The architecture type.

", + "smithy.api#xmlName": "ArchitectureType" + } + }, + "VirtualizationTypes": { + "target": "com.amazonaws.ec2#VirtualizationTypeSet", + "traits": { + "smithy.api#documentation": "

The virtualization type.

", + "smithy.api#xmlName": "VirtualizationType" + } + }, + "InstanceRequirements": { + "target": "com.amazonaws.ec2#InstanceRequirementsRequest", + "traits": { + "smithy.api#documentation": "

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with those attributes.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The architecture type, virtualization type, and other attributes for the instance types.\n When you specify instance attributes, Amazon EC2 will identify instance types with those\n attributes.

\n

If you specify InstanceRequirementsWithMetadataRequest, you can't specify\n InstanceTypes.

" + } + }, + "com.amazonaws.ec2#InstanceSpecification": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceIdWithVolumeResolver", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The instance to specify which volumes should be snapshotted.

", + "smithy.api#required": {} + } + }, + "ExcludeBootVolume": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Excludes the root volume from being snapshotted.

" + } + }, + "ExcludeDataVolumeIds": { + "target": "com.amazonaws.ec2#VolumeIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the data (non-root) volumes to exclude from the multi-volume snapshot set. \n If you specify the ID of the root volume, the request fails. To exclude the root volume, \n use ExcludeBootVolume.

\n

You can specify up to 40 volume IDs per request.

", + "smithy.api#xmlName": "ExcludeDataVolumeId" + } + } + }, + "traits": { + "smithy.api#documentation": "

The instance details to specify which volumes should be snapshotted.

" + } + }, + "com.amazonaws.ec2#InstanceState": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The state of the instance as a 16-bit unsigned integer.

\n

The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values\n between 256 and 65,535. These numerical values are used for internal purposes and should\n be ignored.

\n

The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values\n between 0 and 255.

\n

The valid values for instance-state-code will all be in the range of the low byte and\n they are:

\n \n

You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in\n decimal.

", + "smithy.api#xmlName": "code" + } + }, + "Name": { + "target": "com.amazonaws.ec2#InstanceStateName", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The current state of the instance.

", + "smithy.api#xmlName": "name" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the current state of an instance.

" + } + }, + "com.amazonaws.ec2#InstanceStateChange": { + "type": "structure", + "members": { + "CurrentState": { + "target": "com.amazonaws.ec2#InstanceState", + "traits": { + "aws.protocols#ec2QueryName": "CurrentState", + "smithy.api#documentation": "

The current state of the instance.

", + "smithy.api#xmlName": "currentState" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "PreviousState": { + "target": "com.amazonaws.ec2#InstanceState", + "traits": { + "aws.protocols#ec2QueryName": "PreviousState", + "smithy.api#documentation": "

The previous state of the instance.

", + "smithy.api#xmlName": "previousState" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an instance state change.

" + } + }, + "com.amazonaws.ec2#InstanceStateChangeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceStateChange", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceStateName": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "running": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "running" + } + }, + "shutting_down": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "shutting-down" + } + }, + "terminated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "terminated" + } + }, + "stopping": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stopping" + } + }, + "stopped": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stopped" + } + } + } + }, + "com.amazonaws.ec2#InstanceStatus": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone of the instance.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutpostArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

", + "smithy.api#xmlName": "outpostArn" + } + }, + "Events": { + "target": "com.amazonaws.ec2#InstanceStatusEventList", + "traits": { + "aws.protocols#ec2QueryName": "EventsSet", + "smithy.api#documentation": "

Any scheduled events associated with the instance.

", + "smithy.api#xmlName": "eventsSet" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "InstanceState": { + "target": "com.amazonaws.ec2#InstanceState", + "traits": { + "aws.protocols#ec2QueryName": "InstanceState", + "smithy.api#documentation": "

The intended state of the instance. DescribeInstanceStatus requires\n that an instance be in the running state.

", + "smithy.api#xmlName": "instanceState" + } + }, + "InstanceStatus": { + "target": "com.amazonaws.ec2#InstanceStatusSummary", + "traits": { + "aws.protocols#ec2QueryName": "InstanceStatus", + "smithy.api#documentation": "

Reports impaired functionality that stems from issues internal to the instance, such\n as impaired reachability.

", + "smithy.api#xmlName": "instanceStatus" + } + }, + "SystemStatus": { + "target": "com.amazonaws.ec2#InstanceStatusSummary", + "traits": { + "aws.protocols#ec2QueryName": "SystemStatus", + "smithy.api#documentation": "

Reports impaired functionality that stems from issues related to the systems that\n support an instance, such as hardware failures and network connectivity problems.

", + "smithy.api#xmlName": "systemStatus" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the status of an instance.

" + } + }, + "com.amazonaws.ec2#InstanceStatusDetails": { + "type": "structure", + "members": { + "ImpairedSince": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "ImpairedSince", + "smithy.api#documentation": "

The time when a status check failed. For an instance that was launched and impaired,\n this is the time when the instance was launched.

", + "smithy.api#xmlName": "impairedSince" + } + }, + "Name": { + "target": "com.amazonaws.ec2#StatusName", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The type of instance status.

", + "smithy.api#xmlName": "name" + } + }, + "Status": { + "target": "com.amazonaws.ec2#StatusType", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the instance status.

" + } + }, + "com.amazonaws.ec2#InstanceStatusDetailsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceStatusDetails", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceStatusEvent": { + "type": "structure", + "members": { + "InstanceEventId": { + "target": "com.amazonaws.ec2#InstanceEventId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceEventId", + "smithy.api#documentation": "

The ID of the event.

", + "smithy.api#xmlName": "instanceEventId" + } + }, + "Code": { + "target": "com.amazonaws.ec2#EventCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The event code.

", + "smithy.api#xmlName": "code" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the event.

\n

After a scheduled event is completed, it can still be described for up to a week. If\n the event has been completed, this description starts with the following text:\n [Completed].

", + "smithy.api#xmlName": "description" + } + }, + "NotAfter": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "NotAfter", + "smithy.api#documentation": "

The latest scheduled end time for the event.

", + "smithy.api#xmlName": "notAfter" + } + }, + "NotBefore": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "NotBefore", + "smithy.api#documentation": "

The earliest scheduled start time for the event.

", + "smithy.api#xmlName": "notBefore" + } + }, + "NotBeforeDeadline": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "NotBeforeDeadline", + "smithy.api#documentation": "

The deadline for starting the event.

", + "smithy.api#xmlName": "notBeforeDeadline" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a scheduled event for an instance.

" + } + }, + "com.amazonaws.ec2#InstanceStatusEventList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceStatusEvent", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceStatus", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceStatusSummary": { + "type": "structure", + "members": { + "Details": { + "target": "com.amazonaws.ec2#InstanceStatusDetailsList", + "traits": { + "aws.protocols#ec2QueryName": "Details", + "smithy.api#documentation": "

The system instance health or application instance health.

", + "smithy.api#xmlName": "details" + } + }, + "Status": { + "target": "com.amazonaws.ec2#SummaryStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the status of an instance.

" + } + }, + "com.amazonaws.ec2#InstanceStorageEncryptionSupport": { + "type": "enum", + "members": { + "unsupported": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unsupported" + } + }, + "required": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "required" + } + } + } + }, + "com.amazonaws.ec2#InstanceStorageFlag": { + "type": "boolean" + }, + "com.amazonaws.ec2#InstanceStorageInfo": { + "type": "structure", + "members": { + "TotalSizeInGB": { + "target": "com.amazonaws.ec2#DiskSize", + "traits": { + "aws.protocols#ec2QueryName": "TotalSizeInGB", + "smithy.api#documentation": "

The total size of the disks, in GB.

", + "smithy.api#xmlName": "totalSizeInGB" + } + }, + "Disks": { + "target": "com.amazonaws.ec2#DiskInfoList", + "traits": { + "aws.protocols#ec2QueryName": "Disks", + "smithy.api#documentation": "

Describes the disks that are available for the instance type.

", + "smithy.api#xmlName": "disks" + } + }, + "NvmeSupport": { + "target": "com.amazonaws.ec2#EphemeralNvmeSupport", + "traits": { + "aws.protocols#ec2QueryName": "NvmeSupport", + "smithy.api#documentation": "

Indicates whether non-volatile memory express (NVMe) is supported.

", + "smithy.api#xmlName": "nvmeSupport" + } + }, + "EncryptionSupport": { + "target": "com.amazonaws.ec2#InstanceStorageEncryptionSupport", + "traits": { + "aws.protocols#ec2QueryName": "EncryptionSupport", + "smithy.api#documentation": "

Indicates whether data is encrypted at rest.

", + "smithy.api#xmlName": "encryptionSupport" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the instance store features that are supported by the instance type.

" + } + }, + "com.amazonaws.ec2#InstanceTagKeySet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceTagNotificationAttribute": { + "type": "structure", + "members": { + "InstanceTagKeys": { + "target": "com.amazonaws.ec2#InstanceTagKeySet", + "traits": { + "aws.protocols#ec2QueryName": "InstanceTagKeySet", + "smithy.api#documentation": "

The registered tag keys.

", + "smithy.api#xmlName": "instanceTagKeySet" + } + }, + "IncludeAllTagsOfInstance": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "IncludeAllTagsOfInstance", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates wheter all tag keys in the current Region are registered to appear in scheduled event notifications. \n \ttrue indicates that all tag keys in the current Region are registered.

", + "smithy.api#xmlName": "includeAllTagsOfInstance" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the registered tag keys for the current Region.

" + } + }, + "com.amazonaws.ec2#InstanceType": { + "type": "enum", + "members": { + "a1_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "a1.medium" + } + }, + "a1_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "a1.large" + } + }, + "a1_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "a1.xlarge" + } + }, + "a1_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "a1.2xlarge" + } + }, + "a1_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "a1.4xlarge" + } + }, + "a1_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "a1.metal" + } + }, + "c1_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c1.medium" + } + }, + "c1_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c1.xlarge" + } + }, + "c3_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c3.large" + } + }, + "c3_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c3.xlarge" + } + }, + "c3_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c3.2xlarge" + } + }, + "c3_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c3.4xlarge" + } + }, + "c3_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c3.8xlarge" + } + }, + "c4_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c4.large" + } + }, + "c4_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c4.xlarge" + } + }, + "c4_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c4.2xlarge" + } + }, + "c4_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c4.4xlarge" + } + }, + "c4_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c4.8xlarge" + } + }, + "c5_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5.large" + } + }, + "c5_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5.xlarge" + } + }, + "c5_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5.2xlarge" + } + }, + "c5_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5.4xlarge" + } + }, + "c5_9xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5.9xlarge" + } + }, + "c5_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5.12xlarge" + } + }, + "c5_18xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5.18xlarge" + } + }, + "c5_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5.24xlarge" + } + }, + "c5_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5.metal" + } + }, + "c5a_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5a.large" + } + }, + "c5a_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5a.xlarge" + } + }, + "c5a_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5a.2xlarge" + } + }, + "c5a_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5a.4xlarge" + } + }, + "c5a_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5a.8xlarge" + } + }, + "c5a_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5a.12xlarge" + } + }, + "c5a_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5a.16xlarge" + } + }, + "c5a_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5a.24xlarge" + } + }, + "c5ad_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5ad.large" + } + }, + "c5ad_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5ad.xlarge" + } + }, + "c5ad_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5ad.2xlarge" + } + }, + "c5ad_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5ad.4xlarge" + } + }, + "c5ad_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5ad.8xlarge" + } + }, + "c5ad_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5ad.12xlarge" + } + }, + "c5ad_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5ad.16xlarge" + } + }, + "c5ad_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5ad.24xlarge" + } + }, + "c5d_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5d.large" + } + }, + "c5d_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5d.xlarge" + } + }, + "c5d_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5d.2xlarge" + } + }, + "c5d_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5d.4xlarge" + } + }, + "c5d_9xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5d.9xlarge" + } + }, + "c5d_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5d.12xlarge" + } + }, + "c5d_18xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5d.18xlarge" + } + }, + "c5d_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5d.24xlarge" + } + }, + "c5d_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5d.metal" + } + }, + "c5n_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5n.large" + } + }, + "c5n_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5n.xlarge" + } + }, + "c5n_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5n.2xlarge" + } + }, + "c5n_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5n.4xlarge" + } + }, + "c5n_9xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5n.9xlarge" + } + }, + "c5n_18xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5n.18xlarge" + } + }, + "c5n_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c5n.metal" + } + }, + "c6g_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6g.medium" + } + }, + "c6g_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6g.large" + } + }, + "c6g_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6g.xlarge" + } + }, + "c6g_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6g.2xlarge" + } + }, + "c6g_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6g.4xlarge" + } + }, + "c6g_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6g.8xlarge" + } + }, + "c6g_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6g.12xlarge" + } + }, + "c6g_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6g.16xlarge" + } + }, + "c6g_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6g.metal" + } + }, + "c6gd_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6gd.medium" + } + }, + "c6gd_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6gd.large" + } + }, + "c6gd_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6gd.xlarge" + } + }, + "c6gd_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6gd.2xlarge" + } + }, + "c6gd_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6gd.4xlarge" + } + }, + "c6gd_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6gd.8xlarge" + } + }, + "c6gd_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6gd.12xlarge" + } + }, + "c6gd_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6gd.16xlarge" + } + }, + "c6gd_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6gd.metal" + } + }, + "c6gn_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6gn.medium" + } + }, + "c6gn_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6gn.large" + } + }, + "c6gn_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6gn.xlarge" + } + }, + "c6gn_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6gn.2xlarge" + } + }, + "c6gn_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6gn.4xlarge" + } + }, + "c6gn_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6gn.8xlarge" + } + }, + "c6gn_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6gn.12xlarge" + } + }, + "c6gn_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6gn.16xlarge" + } + }, + "c6i_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6i.large" + } + }, + "c6i_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6i.xlarge" + } + }, + "c6i_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6i.2xlarge" + } + }, + "c6i_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6i.4xlarge" + } + }, + "c6i_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6i.8xlarge" + } + }, + "c6i_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6i.12xlarge" + } + }, + "c6i_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6i.16xlarge" + } + }, + "c6i_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6i.24xlarge" + } + }, + "c6i_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6i.32xlarge" + } + }, + "c6i_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6i.metal" + } + }, + "cc1_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cc1.4xlarge" + } + }, + "cc2_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cc2.8xlarge" + } + }, + "cg1_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cg1.4xlarge" + } + }, + "cr1_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cr1.8xlarge" + } + }, + "d2_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "d2.xlarge" + } + }, + "d2_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "d2.2xlarge" + } + }, + "d2_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "d2.4xlarge" + } + }, + "d2_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "d2.8xlarge" + } + }, + "d3_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "d3.xlarge" + } + }, + "d3_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "d3.2xlarge" + } + }, + "d3_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "d3.4xlarge" + } + }, + "d3_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "d3.8xlarge" + } + }, + "d3en_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "d3en.xlarge" + } + }, + "d3en_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "d3en.2xlarge" + } + }, + "d3en_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "d3en.4xlarge" + } + }, + "d3en_6xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "d3en.6xlarge" + } + }, + "d3en_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "d3en.8xlarge" + } + }, + "d3en_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "d3en.12xlarge" + } + }, + "dl1_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dl1.24xlarge" + } + }, + "f1_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "f1.2xlarge" + } + }, + "f1_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "f1.4xlarge" + } + }, + "f1_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "f1.16xlarge" + } + }, + "g2_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g2.2xlarge" + } + }, + "g2_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g2.8xlarge" + } + }, + "g3_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g3.4xlarge" + } + }, + "g3_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g3.8xlarge" + } + }, + "g3_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g3.16xlarge" + } + }, + "g3s_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g3s.xlarge" + } + }, + "g4ad_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g4ad.xlarge" + } + }, + "g4ad_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g4ad.2xlarge" + } + }, + "g4ad_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g4ad.4xlarge" + } + }, + "g4ad_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g4ad.8xlarge" + } + }, + "g4ad_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g4ad.16xlarge" + } + }, + "g4dn_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g4dn.xlarge" + } + }, + "g4dn_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g4dn.2xlarge" + } + }, + "g4dn_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g4dn.4xlarge" + } + }, + "g4dn_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g4dn.8xlarge" + } + }, + "g4dn_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g4dn.12xlarge" + } + }, + "g4dn_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g4dn.16xlarge" + } + }, + "g4dn_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g4dn.metal" + } + }, + "g5_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g5.xlarge" + } + }, + "g5_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g5.2xlarge" + } + }, + "g5_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g5.4xlarge" + } + }, + "g5_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g5.8xlarge" + } + }, + "g5_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g5.12xlarge" + } + }, + "g5_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g5.16xlarge" + } + }, + "g5_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g5.24xlarge" + } + }, + "g5_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g5.48xlarge" + } + }, + "g5g_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g5g.xlarge" + } + }, + "g5g_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g5g.2xlarge" + } + }, + "g5g_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g5g.4xlarge" + } + }, + "g5g_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g5g.8xlarge" + } + }, + "g5g_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g5g.16xlarge" + } + }, + "g5g_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g5g.metal" + } + }, + "hi1_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hi1.4xlarge" + } + }, + "hpc6a_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hpc6a.48xlarge" + } + }, + "hs1_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hs1.8xlarge" + } + }, + "h1_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "h1.2xlarge" + } + }, + "h1_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "h1.4xlarge" + } + }, + "h1_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "h1.8xlarge" + } + }, + "h1_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "h1.16xlarge" + } + }, + "i2_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i2.xlarge" + } + }, + "i2_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i2.2xlarge" + } + }, + "i2_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i2.4xlarge" + } + }, + "i2_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i2.8xlarge" + } + }, + "i3_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i3.large" + } + }, + "i3_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i3.xlarge" + } + }, + "i3_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i3.2xlarge" + } + }, + "i3_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i3.4xlarge" + } + }, + "i3_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i3.8xlarge" + } + }, + "i3_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i3.16xlarge" + } + }, + "i3_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i3.metal" + } + }, + "i3en_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i3en.large" + } + }, + "i3en_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i3en.xlarge" + } + }, + "i3en_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i3en.2xlarge" + } + }, + "i3en_3xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i3en.3xlarge" + } + }, + "i3en_6xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i3en.6xlarge" + } + }, + "i3en_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i3en.12xlarge" + } + }, + "i3en_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i3en.24xlarge" + } + }, + "i3en_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i3en.metal" + } + }, + "im4gn_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "im4gn.large" + } + }, + "im4gn_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "im4gn.xlarge" + } + }, + "im4gn_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "im4gn.2xlarge" + } + }, + "im4gn_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "im4gn.4xlarge" + } + }, + "im4gn_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "im4gn.8xlarge" + } + }, + "im4gn_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "im4gn.16xlarge" + } + }, + "inf1_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inf1.xlarge" + } + }, + "inf1_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inf1.2xlarge" + } + }, + "inf1_6xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inf1.6xlarge" + } + }, + "inf1_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inf1.24xlarge" + } + }, + "is4gen_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "is4gen.medium" + } + }, + "is4gen_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "is4gen.large" + } + }, + "is4gen_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "is4gen.xlarge" + } + }, + "is4gen_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "is4gen.2xlarge" + } + }, + "is4gen_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "is4gen.4xlarge" + } + }, + "is4gen_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "is4gen.8xlarge" + } + }, + "m1_small": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m1.small" + } + }, + "m1_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m1.medium" + } + }, + "m1_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m1.large" + } + }, + "m1_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m1.xlarge" + } + }, + "m2_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m2.xlarge" + } + }, + "m2_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m2.2xlarge" + } + }, + "m2_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m2.4xlarge" + } + }, + "m3_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m3.medium" + } + }, + "m3_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m3.large" + } + }, + "m3_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m3.xlarge" + } + }, + "m3_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m3.2xlarge" + } + }, + "m4_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m4.large" + } + }, + "m4_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m4.xlarge" + } + }, + "m4_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m4.2xlarge" + } + }, + "m4_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m4.4xlarge" + } + }, + "m4_10xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m4.10xlarge" + } + }, + "m4_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m4.16xlarge" + } + }, + "m5_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5.large" + } + }, + "m5_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5.xlarge" + } + }, + "m5_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5.2xlarge" + } + }, + "m5_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5.4xlarge" + } + }, + "m5_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5.8xlarge" + } + }, + "m5_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5.12xlarge" + } + }, + "m5_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5.16xlarge" + } + }, + "m5_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5.24xlarge" + } + }, + "m5_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5.metal" + } + }, + "m5a_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5a.large" + } + }, + "m5a_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5a.xlarge" + } + }, + "m5a_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5a.2xlarge" + } + }, + "m5a_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5a.4xlarge" + } + }, + "m5a_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5a.8xlarge" + } + }, + "m5a_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5a.12xlarge" + } + }, + "m5a_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5a.16xlarge" + } + }, + "m5a_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5a.24xlarge" + } + }, + "m5ad_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5ad.large" + } + }, + "m5ad_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5ad.xlarge" + } + }, + "m5ad_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5ad.2xlarge" + } + }, + "m5ad_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5ad.4xlarge" + } + }, + "m5ad_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5ad.8xlarge" + } + }, + "m5ad_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5ad.12xlarge" + } + }, + "m5ad_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5ad.16xlarge" + } + }, + "m5ad_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5ad.24xlarge" + } + }, + "m5d_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5d.large" + } + }, + "m5d_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5d.xlarge" + } + }, + "m5d_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5d.2xlarge" + } + }, + "m5d_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5d.4xlarge" + } + }, + "m5d_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5d.8xlarge" + } + }, + "m5d_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5d.12xlarge" + } + }, + "m5d_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5d.16xlarge" + } + }, + "m5d_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5d.24xlarge" + } + }, + "m5d_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5d.metal" + } + }, + "m5dn_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5dn.large" + } + }, + "m5dn_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5dn.xlarge" + } + }, + "m5dn_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5dn.2xlarge" + } + }, + "m5dn_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5dn.4xlarge" + } + }, + "m5dn_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5dn.8xlarge" + } + }, + "m5dn_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5dn.12xlarge" + } + }, + "m5dn_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5dn.16xlarge" + } + }, + "m5dn_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5dn.24xlarge" + } + }, + "m5dn_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5dn.metal" + } + }, + "m5n_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5n.large" + } + }, + "m5n_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5n.xlarge" + } + }, + "m5n_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5n.2xlarge" + } + }, + "m5n_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5n.4xlarge" + } + }, + "m5n_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5n.8xlarge" + } + }, + "m5n_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5n.12xlarge" + } + }, + "m5n_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5n.16xlarge" + } + }, + "m5n_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5n.24xlarge" + } + }, + "m5n_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5n.metal" + } + }, + "m5zn_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5zn.large" + } + }, + "m5zn_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5zn.xlarge" + } + }, + "m5zn_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5zn.2xlarge" + } + }, + "m5zn_3xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5zn.3xlarge" + } + }, + "m5zn_6xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5zn.6xlarge" + } + }, + "m5zn_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5zn.12xlarge" + } + }, + "m5zn_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m5zn.metal" + } + }, + "m6a_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6a.large" + } + }, + "m6a_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6a.xlarge" + } + }, + "m6a_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6a.2xlarge" + } + }, + "m6a_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6a.4xlarge" + } + }, + "m6a_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6a.8xlarge" + } + }, + "m6a_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6a.12xlarge" + } + }, + "m6a_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6a.16xlarge" + } + }, + "m6a_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6a.24xlarge" + } + }, + "m6a_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6a.32xlarge" + } + }, + "m6a_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6a.48xlarge" + } + }, + "m6g_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6g.metal" + } + }, + "m6g_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6g.medium" + } + }, + "m6g_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6g.large" + } + }, + "m6g_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6g.xlarge" + } + }, + "m6g_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6g.2xlarge" + } + }, + "m6g_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6g.4xlarge" + } + }, + "m6g_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6g.8xlarge" + } + }, + "m6g_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6g.12xlarge" + } + }, + "m6g_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6g.16xlarge" + } + }, + "m6gd_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6gd.metal" + } + }, + "m6gd_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6gd.medium" + } + }, + "m6gd_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6gd.large" + } + }, + "m6gd_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6gd.xlarge" + } + }, + "m6gd_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6gd.2xlarge" + } + }, + "m6gd_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6gd.4xlarge" + } + }, + "m6gd_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6gd.8xlarge" + } + }, + "m6gd_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6gd.12xlarge" + } + }, + "m6gd_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6gd.16xlarge" + } + }, + "m6i_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6i.large" + } + }, + "m6i_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6i.xlarge" + } + }, + "m6i_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6i.2xlarge" + } + }, + "m6i_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6i.4xlarge" + } + }, + "m6i_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6i.8xlarge" + } + }, + "m6i_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6i.12xlarge" + } + }, + "m6i_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6i.16xlarge" + } + }, + "m6i_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6i.24xlarge" + } + }, + "m6i_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6i.32xlarge" + } + }, + "m6i_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6i.metal" + } + }, + "mac1_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mac1.metal" + } + }, + "p2_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "p2.xlarge" + } + }, + "p2_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "p2.8xlarge" + } + }, + "p2_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "p2.16xlarge" + } + }, + "p3_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "p3.2xlarge" + } + }, + "p3_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "p3.8xlarge" + } + }, + "p3_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "p3.16xlarge" + } + }, + "p3dn_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "p3dn.24xlarge" + } + }, + "p4d_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "p4d.24xlarge" + } + }, + "r3_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r3.large" + } + }, + "r3_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r3.xlarge" + } + }, + "r3_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r3.2xlarge" + } + }, + "r3_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r3.4xlarge" + } + }, + "r3_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r3.8xlarge" + } + }, + "r4_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r4.large" + } + }, + "r4_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r4.xlarge" + } + }, + "r4_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r4.2xlarge" + } + }, + "r4_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r4.4xlarge" + } + }, + "r4_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r4.8xlarge" + } + }, + "r4_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r4.16xlarge" + } + }, + "r5_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5.large" + } + }, + "r5_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5.xlarge" + } + }, + "r5_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5.2xlarge" + } + }, + "r5_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5.4xlarge" + } + }, + "r5_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5.8xlarge" + } + }, + "r5_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5.12xlarge" + } + }, + "r5_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5.16xlarge" + } + }, + "r5_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5.24xlarge" + } + }, + "r5_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5.metal" + } + }, + "r5a_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5a.large" + } + }, + "r5a_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5a.xlarge" + } + }, + "r5a_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5a.2xlarge" + } + }, + "r5a_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5a.4xlarge" + } + }, + "r5a_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5a.8xlarge" + } + }, + "r5a_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5a.12xlarge" + } + }, + "r5a_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5a.16xlarge" + } + }, + "r5a_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5a.24xlarge" + } + }, + "r5ad_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5ad.large" + } + }, + "r5ad_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5ad.xlarge" + } + }, + "r5ad_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5ad.2xlarge" + } + }, + "r5ad_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5ad.4xlarge" + } + }, + "r5ad_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5ad.8xlarge" + } + }, + "r5ad_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5ad.12xlarge" + } + }, + "r5ad_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5ad.16xlarge" + } + }, + "r5ad_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5ad.24xlarge" + } + }, + "r5b_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5b.large" + } + }, + "r5b_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5b.xlarge" + } + }, + "r5b_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5b.2xlarge" + } + }, + "r5b_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5b.4xlarge" + } + }, + "r5b_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5b.8xlarge" + } + }, + "r5b_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5b.12xlarge" + } + }, + "r5b_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5b.16xlarge" + } + }, + "r5b_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5b.24xlarge" + } + }, + "r5b_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5b.metal" + } + }, + "r5d_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5d.large" + } + }, + "r5d_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5d.xlarge" + } + }, + "r5d_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5d.2xlarge" + } + }, + "r5d_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5d.4xlarge" + } + }, + "r5d_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5d.8xlarge" + } + }, + "r5d_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5d.12xlarge" + } + }, + "r5d_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5d.16xlarge" + } + }, + "r5d_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5d.24xlarge" + } + }, + "r5d_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5d.metal" + } + }, + "r5dn_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5dn.large" + } + }, + "r5dn_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5dn.xlarge" + } + }, + "r5dn_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5dn.2xlarge" + } + }, + "r5dn_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5dn.4xlarge" + } + }, + "r5dn_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5dn.8xlarge" + } + }, + "r5dn_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5dn.12xlarge" + } + }, + "r5dn_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5dn.16xlarge" + } + }, + "r5dn_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5dn.24xlarge" + } + }, + "r5dn_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5dn.metal" + } + }, + "r5n_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5n.large" + } + }, + "r5n_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5n.xlarge" + } + }, + "r5n_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5n.2xlarge" + } + }, + "r5n_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5n.4xlarge" + } + }, + "r5n_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5n.8xlarge" + } + }, + "r5n_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5n.12xlarge" + } + }, + "r5n_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5n.16xlarge" + } + }, + "r5n_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5n.24xlarge" + } + }, + "r5n_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r5n.metal" + } + }, + "r6g_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6g.medium" + } + }, + "r6g_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6g.large" + } + }, + "r6g_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6g.xlarge" + } + }, + "r6g_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6g.2xlarge" + } + }, + "r6g_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6g.4xlarge" + } + }, + "r6g_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6g.8xlarge" + } + }, + "r6g_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6g.12xlarge" + } + }, + "r6g_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6g.16xlarge" + } + }, + "r6g_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6g.metal" + } + }, + "r6gd_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6gd.medium" + } + }, + "r6gd_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6gd.large" + } + }, + "r6gd_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6gd.xlarge" + } + }, + "r6gd_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6gd.2xlarge" + } + }, + "r6gd_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6gd.4xlarge" + } + }, + "r6gd_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6gd.8xlarge" + } + }, + "r6gd_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6gd.12xlarge" + } + }, + "r6gd_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6gd.16xlarge" + } + }, + "r6gd_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6gd.metal" + } + }, + "r6i_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6i.large" + } + }, + "r6i_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6i.xlarge" + } + }, + "r6i_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6i.2xlarge" + } + }, + "r6i_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6i.4xlarge" + } + }, + "r6i_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6i.8xlarge" + } + }, + "r6i_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6i.12xlarge" + } + }, + "r6i_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6i.16xlarge" + } + }, + "r6i_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6i.24xlarge" + } + }, + "r6i_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6i.32xlarge" + } + }, + "r6i_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6i.metal" + } + }, + "t1_micro": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t1.micro" + } + }, + "t2_nano": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t2.nano" + } + }, + "t2_micro": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t2.micro" + } + }, + "t2_small": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t2.small" + } + }, + "t2_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t2.medium" + } + }, + "t2_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t2.large" + } + }, + "t2_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t2.xlarge" + } + }, + "t2_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t2.2xlarge" + } + }, + "t3_nano": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t3.nano" + } + }, + "t3_micro": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t3.micro" + } + }, + "t3_small": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t3.small" + } + }, + "t3_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t3.medium" + } + }, + "t3_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t3.large" + } + }, + "t3_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t3.xlarge" + } + }, + "t3_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t3.2xlarge" + } + }, + "t3a_nano": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t3a.nano" + } + }, + "t3a_micro": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t3a.micro" + } + }, + "t3a_small": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t3a.small" + } + }, + "t3a_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t3a.medium" + } + }, + "t3a_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t3a.large" + } + }, + "t3a_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t3a.xlarge" + } + }, + "t3a_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t3a.2xlarge" + } + }, + "t4g_nano": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t4g.nano" + } + }, + "t4g_micro": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t4g.micro" + } + }, + "t4g_small": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t4g.small" + } + }, + "t4g_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t4g.medium" + } + }, + "t4g_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t4g.large" + } + }, + "t4g_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t4g.xlarge" + } + }, + "t4g_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t4g.2xlarge" + } + }, + "u_6tb1_56xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u-6tb1.56xlarge" + } + }, + "u_6tb1_112xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u-6tb1.112xlarge" + } + }, + "u_9tb1_112xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u-9tb1.112xlarge" + } + }, + "u_12tb1_112xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u-12tb1.112xlarge" + } + }, + "u_6tb1_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u-6tb1.metal" + } + }, + "u_9tb1_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u-9tb1.metal" + } + }, + "u_12tb1_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u-12tb1.metal" + } + }, + "u_18tb1_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u-18tb1.metal" + } + }, + "u_24tb1_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u-24tb1.metal" + } + }, + "vt1_3xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vt1.3xlarge" + } + }, + "vt1_6xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vt1.6xlarge" + } + }, + "vt1_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vt1.24xlarge" + } + }, + "x1_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x1.16xlarge" + } + }, + "x1_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x1.32xlarge" + } + }, + "x1e_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x1e.xlarge" + } + }, + "x1e_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x1e.2xlarge" + } + }, + "x1e_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x1e.4xlarge" + } + }, + "x1e_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x1e.8xlarge" + } + }, + "x1e_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x1e.16xlarge" + } + }, + "x1e_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x1e.32xlarge" + } + }, + "x2iezn_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2iezn.2xlarge" + } + }, + "x2iezn_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2iezn.4xlarge" + } + }, + "x2iezn_6xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2iezn.6xlarge" + } + }, + "x2iezn_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2iezn.8xlarge" + } + }, + "x2iezn_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2iezn.12xlarge" + } + }, + "x2iezn_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2iezn.metal" + } + }, + "x2gd_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2gd.medium" + } + }, + "x2gd_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2gd.large" + } + }, + "x2gd_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2gd.xlarge" + } + }, + "x2gd_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2gd.2xlarge" + } + }, + "x2gd_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2gd.4xlarge" + } + }, + "x2gd_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2gd.8xlarge" + } + }, + "x2gd_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2gd.12xlarge" + } + }, + "x2gd_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2gd.16xlarge" + } + }, + "x2gd_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2gd.metal" + } + }, + "z1d_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "z1d.large" + } + }, + "z1d_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "z1d.xlarge" + } + }, + "z1d_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "z1d.2xlarge" + } + }, + "z1d_3xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "z1d.3xlarge" + } + }, + "z1d_6xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "z1d.6xlarge" + } + }, + "z1d_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "z1d.12xlarge" + } + }, + "z1d_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "z1d.metal" + } + }, + "x2idn_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2idn.16xlarge" + } + }, + "x2idn_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2idn.24xlarge" + } + }, + "x2idn_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2idn.32xlarge" + } + }, + "x2iedn_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2iedn.xlarge" + } + }, + "x2iedn_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2iedn.2xlarge" + } + }, + "x2iedn_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2iedn.4xlarge" + } + }, + "x2iedn_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2iedn.8xlarge" + } + }, + "x2iedn_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2iedn.16xlarge" + } + }, + "x2iedn_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2iedn.24xlarge" + } + }, + "x2iedn_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2iedn.32xlarge" + } + }, + "c6a_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6a.large" + } + }, + "c6a_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6a.xlarge" + } + }, + "c6a_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6a.2xlarge" + } + }, + "c6a_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6a.4xlarge" + } + }, + "c6a_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6a.8xlarge" + } + }, + "c6a_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6a.12xlarge" + } + }, + "c6a_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6a.16xlarge" + } + }, + "c6a_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6a.24xlarge" + } + }, + "c6a_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6a.32xlarge" + } + }, + "c6a_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6a.48xlarge" + } + }, + "c6a_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6a.metal" + } + }, + "m6a_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6a.metal" + } + }, + "i4i_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i4i.large" + } + }, + "i4i_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i4i.xlarge" + } + }, + "i4i_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i4i.2xlarge" + } + }, + "i4i_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i4i.4xlarge" + } + }, + "i4i_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i4i.8xlarge" + } + }, + "i4i_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i4i.16xlarge" + } + }, + "i4i_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i4i.32xlarge" + } + }, + "i4i_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i4i.metal" + } + }, + "x2idn_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2idn.metal" + } + }, + "x2iedn_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x2iedn.metal" + } + }, + "c7g_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7g.medium" + } + }, + "c7g_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7g.large" + } + }, + "c7g_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7g.xlarge" + } + }, + "c7g_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7g.2xlarge" + } + }, + "c7g_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7g.4xlarge" + } + }, + "c7g_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7g.8xlarge" + } + }, + "c7g_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7g.12xlarge" + } + }, + "c7g_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7g.16xlarge" + } + }, + "mac2_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mac2.metal" + } + }, + "c6id_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6id.large" + } + }, + "c6id_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6id.xlarge" + } + }, + "c6id_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6id.2xlarge" + } + }, + "c6id_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6id.4xlarge" + } + }, + "c6id_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6id.8xlarge" + } + }, + "c6id_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6id.12xlarge" + } + }, + "c6id_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6id.16xlarge" + } + }, + "c6id_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6id.24xlarge" + } + }, + "c6id_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6id.32xlarge" + } + }, + "c6id_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6id.metal" + } + }, + "m6id_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6id.large" + } + }, + "m6id_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6id.xlarge" + } + }, + "m6id_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6id.2xlarge" + } + }, + "m6id_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6id.4xlarge" + } + }, + "m6id_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6id.8xlarge" + } + }, + "m6id_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6id.12xlarge" + } + }, + "m6id_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6id.16xlarge" + } + }, + "m6id_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6id.24xlarge" + } + }, + "m6id_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6id.32xlarge" + } + }, + "m6id_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6id.metal" + } + }, + "r6id_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6id.large" + } + }, + "r6id_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6id.xlarge" + } + }, + "r6id_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6id.2xlarge" + } + }, + "r6id_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6id.4xlarge" + } + }, + "r6id_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6id.8xlarge" + } + }, + "r6id_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6id.12xlarge" + } + }, + "r6id_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6id.16xlarge" + } + }, + "r6id_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6id.24xlarge" + } + }, + "r6id_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6id.32xlarge" + } + }, + "r6id_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6id.metal" + } + }, + "r6a_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6a.large" + } + }, + "r6a_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6a.xlarge" + } + }, + "r6a_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6a.2xlarge" + } + }, + "r6a_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6a.4xlarge" + } + }, + "r6a_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6a.8xlarge" + } + }, + "r6a_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6a.12xlarge" + } + }, + "r6a_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6a.16xlarge" + } + }, + "r6a_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6a.24xlarge" + } + }, + "r6a_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6a.32xlarge" + } + }, + "r6a_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6a.48xlarge" + } + }, + "r6a_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6a.metal" + } + }, + "p4de_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "p4de.24xlarge" + } + }, + "u_3tb1_56xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u-3tb1.56xlarge" + } + }, + "u_18tb1_112xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u-18tb1.112xlarge" + } + }, + "u_24tb1_112xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u-24tb1.112xlarge" + } + }, + "trn1_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "trn1.2xlarge" + } + }, + "trn1_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "trn1.32xlarge" + } + }, + "hpc6id_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hpc6id.32xlarge" + } + }, + "c6in_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6in.large" + } + }, + "c6in_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6in.xlarge" + } + }, + "c6in_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6in.2xlarge" + } + }, + "c6in_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6in.4xlarge" + } + }, + "c6in_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6in.8xlarge" + } + }, + "c6in_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6in.12xlarge" + } + }, + "c6in_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6in.16xlarge" + } + }, + "c6in_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6in.24xlarge" + } + }, + "c6in_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6in.32xlarge" + } + }, + "m6in_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6in.large" + } + }, + "m6in_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6in.xlarge" + } + }, + "m6in_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6in.2xlarge" + } + }, + "m6in_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6in.4xlarge" + } + }, + "m6in_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6in.8xlarge" + } + }, + "m6in_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6in.12xlarge" + } + }, + "m6in_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6in.16xlarge" + } + }, + "m6in_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6in.24xlarge" + } + }, + "m6in_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6in.32xlarge" + } + }, + "m6idn_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6idn.large" + } + }, + "m6idn_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6idn.xlarge" + } + }, + "m6idn_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6idn.2xlarge" + } + }, + "m6idn_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6idn.4xlarge" + } + }, + "m6idn_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6idn.8xlarge" + } + }, + "m6idn_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6idn.12xlarge" + } + }, + "m6idn_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6idn.16xlarge" + } + }, + "m6idn_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6idn.24xlarge" + } + }, + "m6idn_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6idn.32xlarge" + } + }, + "r6in_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6in.large" + } + }, + "r6in_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6in.xlarge" + } + }, + "r6in_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6in.2xlarge" + } + }, + "r6in_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6in.4xlarge" + } + }, + "r6in_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6in.8xlarge" + } + }, + "r6in_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6in.12xlarge" + } + }, + "r6in_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6in.16xlarge" + } + }, + "r6in_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6in.24xlarge" + } + }, + "r6in_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6in.32xlarge" + } + }, + "r6idn_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6idn.large" + } + }, + "r6idn_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6idn.xlarge" + } + }, + "r6idn_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6idn.2xlarge" + } + }, + "r6idn_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6idn.4xlarge" + } + }, + "r6idn_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6idn.8xlarge" + } + }, + "r6idn_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6idn.12xlarge" + } + }, + "r6idn_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6idn.16xlarge" + } + }, + "r6idn_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6idn.24xlarge" + } + }, + "r6idn_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6idn.32xlarge" + } + }, + "c7g_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7g.metal" + } + }, + "m7g_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7g.medium" + } + }, + "m7g_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7g.large" + } + }, + "m7g_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7g.xlarge" + } + }, + "m7g_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7g.2xlarge" + } + }, + "m7g_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7g.4xlarge" + } + }, + "m7g_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7g.8xlarge" + } + }, + "m7g_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7g.12xlarge" + } + }, + "m7g_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7g.16xlarge" + } + }, + "m7g_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7g.metal" + } + }, + "r7g_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7g.medium" + } + }, + "r7g_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7g.large" + } + }, + "r7g_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7g.xlarge" + } + }, + "r7g_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7g.2xlarge" + } + }, + "r7g_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7g.4xlarge" + } + }, + "r7g_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7g.8xlarge" + } + }, + "r7g_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7g.12xlarge" + } + }, + "r7g_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7g.16xlarge" + } + }, + "r7g_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r7g.metal" + } + }, + "c6in_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c6in.metal" + } + }, + "m6in_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6in.metal" + } + }, + "m6idn_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m6idn.metal" + } + }, + "r6in_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6in.metal" + } + }, + "r6idn_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "r6idn.metal" + } + }, + "inf2_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inf2.xlarge" + } + }, + "inf2_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inf2.8xlarge" + } + }, + "inf2_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inf2.24xlarge" + } + }, + "inf2_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inf2.48xlarge" + } + }, + "trn1n_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "trn1n.32xlarge" + } + }, + "i4g_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i4g.large" + } + }, + "i4g_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i4g.xlarge" + } + }, + "i4g_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i4g.2xlarge" + } + }, + "i4g_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i4g.4xlarge" + } + }, + "i4g_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i4g.8xlarge" + } + }, + "i4g_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i4g.16xlarge" + } + } + } + }, + "com.amazonaws.ec2#InstanceTypeHypervisor": { + "type": "enum", + "members": { + "NITRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nitro" + } + }, + "XEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "xen" + } + } + } + }, + "com.amazonaws.ec2#InstanceTypeInfo": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type. For more information, see Instance types in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "instanceType" + } + }, + "CurrentGeneration": { + "target": "com.amazonaws.ec2#CurrentGenerationFlag", + "traits": { + "aws.protocols#ec2QueryName": "CurrentGeneration", + "smithy.api#documentation": "

Indicates whether the instance type is current generation.

", + "smithy.api#xmlName": "currentGeneration" + } + }, + "FreeTierEligible": { + "target": "com.amazonaws.ec2#FreeTierEligibleFlag", + "traits": { + "aws.protocols#ec2QueryName": "FreeTierEligible", + "smithy.api#documentation": "

Indicates whether the instance type is eligible for the free tier.

", + "smithy.api#xmlName": "freeTierEligible" + } + }, + "SupportedUsageClasses": { + "target": "com.amazonaws.ec2#UsageClassTypeList", + "traits": { + "aws.protocols#ec2QueryName": "SupportedUsageClasses", + "smithy.api#documentation": "

Indicates whether the instance type is offered for spot or On-Demand.

", + "smithy.api#xmlName": "supportedUsageClasses" + } + }, + "SupportedRootDeviceTypes": { + "target": "com.amazonaws.ec2#RootDeviceTypeList", + "traits": { + "aws.protocols#ec2QueryName": "SupportedRootDeviceTypes", + "smithy.api#documentation": "

The supported root device types.

", + "smithy.api#xmlName": "supportedRootDeviceTypes" + } + }, + "SupportedVirtualizationTypes": { + "target": "com.amazonaws.ec2#VirtualizationTypeList", + "traits": { + "aws.protocols#ec2QueryName": "SupportedVirtualizationTypes", + "smithy.api#documentation": "

The supported virtualization types.

", + "smithy.api#xmlName": "supportedVirtualizationTypes" + } + }, + "BareMetal": { + "target": "com.amazonaws.ec2#BareMetalFlag", + "traits": { + "aws.protocols#ec2QueryName": "BareMetal", + "smithy.api#documentation": "

Indicates whether the instance is a bare metal instance type.

", + "smithy.api#xmlName": "bareMetal" + } + }, + "Hypervisor": { + "target": "com.amazonaws.ec2#InstanceTypeHypervisor", + "traits": { + "aws.protocols#ec2QueryName": "Hypervisor", + "smithy.api#documentation": "

The hypervisor for the instance type.

", + "smithy.api#xmlName": "hypervisor" + } + }, + "ProcessorInfo": { + "target": "com.amazonaws.ec2#ProcessorInfo", + "traits": { + "aws.protocols#ec2QueryName": "ProcessorInfo", + "smithy.api#documentation": "

Describes the processor.

", + "smithy.api#xmlName": "processorInfo" + } + }, + "VCpuInfo": { + "target": "com.amazonaws.ec2#VCpuInfo", + "traits": { + "aws.protocols#ec2QueryName": "VCpuInfo", + "smithy.api#documentation": "

Describes the vCPU configurations for the instance type.

", + "smithy.api#xmlName": "vCpuInfo" + } + }, + "MemoryInfo": { + "target": "com.amazonaws.ec2#MemoryInfo", + "traits": { + "aws.protocols#ec2QueryName": "MemoryInfo", + "smithy.api#documentation": "

Describes the memory for the instance type.

", + "smithy.api#xmlName": "memoryInfo" + } + }, + "InstanceStorageSupported": { + "target": "com.amazonaws.ec2#InstanceStorageFlag", + "traits": { + "aws.protocols#ec2QueryName": "InstanceStorageSupported", + "smithy.api#documentation": "

Indicates whether instance storage is supported.

", + "smithy.api#xmlName": "instanceStorageSupported" + } + }, + "InstanceStorageInfo": { + "target": "com.amazonaws.ec2#InstanceStorageInfo", + "traits": { + "aws.protocols#ec2QueryName": "InstanceStorageInfo", + "smithy.api#documentation": "

Describes the instance storage for the instance type.

", + "smithy.api#xmlName": "instanceStorageInfo" + } + }, + "EbsInfo": { + "target": "com.amazonaws.ec2#EbsInfo", + "traits": { + "aws.protocols#ec2QueryName": "EbsInfo", + "smithy.api#documentation": "

Describes the Amazon EBS settings for the instance type.

", + "smithy.api#xmlName": "ebsInfo" + } + }, + "NetworkInfo": { + "target": "com.amazonaws.ec2#NetworkInfo", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInfo", + "smithy.api#documentation": "

Describes the network settings for the instance type.

", + "smithy.api#xmlName": "networkInfo" + } + }, + "GpuInfo": { + "target": "com.amazonaws.ec2#GpuInfo", + "traits": { + "aws.protocols#ec2QueryName": "GpuInfo", + "smithy.api#documentation": "

Describes the GPU accelerator settings for the instance type.

", + "smithy.api#xmlName": "gpuInfo" + } + }, + "FpgaInfo": { + "target": "com.amazonaws.ec2#FpgaInfo", + "traits": { + "aws.protocols#ec2QueryName": "FpgaInfo", + "smithy.api#documentation": "

Describes the FPGA accelerator settings for the instance type.

", + "smithy.api#xmlName": "fpgaInfo" + } + }, + "PlacementGroupInfo": { + "target": "com.amazonaws.ec2#PlacementGroupInfo", + "traits": { + "aws.protocols#ec2QueryName": "PlacementGroupInfo", + "smithy.api#documentation": "

Describes the placement group settings for the instance type.

", + "smithy.api#xmlName": "placementGroupInfo" + } + }, + "InferenceAcceleratorInfo": { + "target": "com.amazonaws.ec2#InferenceAcceleratorInfo", + "traits": { + "aws.protocols#ec2QueryName": "InferenceAcceleratorInfo", + "smithy.api#documentation": "

Describes the Inference accelerator settings for the instance type.

", + "smithy.api#xmlName": "inferenceAcceleratorInfo" + } + }, + "HibernationSupported": { + "target": "com.amazonaws.ec2#HibernationFlag", + "traits": { + "aws.protocols#ec2QueryName": "HibernationSupported", + "smithy.api#documentation": "

Indicates whether On-Demand hibernation is supported.

", + "smithy.api#xmlName": "hibernationSupported" + } + }, + "BurstablePerformanceSupported": { + "target": "com.amazonaws.ec2#BurstablePerformanceFlag", + "traits": { + "aws.protocols#ec2QueryName": "BurstablePerformanceSupported", + "smithy.api#documentation": "

Indicates whether the instance type is a burstable performance instance type.

", + "smithy.api#xmlName": "burstablePerformanceSupported" + } + }, + "DedicatedHostsSupported": { + "target": "com.amazonaws.ec2#DedicatedHostFlag", + "traits": { + "aws.protocols#ec2QueryName": "DedicatedHostsSupported", + "smithy.api#documentation": "

Indicates whether Dedicated Hosts are supported on the instance type.

", + "smithy.api#xmlName": "dedicatedHostsSupported" + } + }, + "AutoRecoverySupported": { + "target": "com.amazonaws.ec2#AutoRecoveryFlag", + "traits": { + "aws.protocols#ec2QueryName": "AutoRecoverySupported", + "smithy.api#documentation": "

Indicates whether Amazon CloudWatch action based recovery is supported.

", + "smithy.api#xmlName": "autoRecoverySupported" + } + }, + "SupportedBootModes": { + "target": "com.amazonaws.ec2#BootModeTypeList", + "traits": { + "aws.protocols#ec2QueryName": "SupportedBootModes", + "smithy.api#documentation": "

The supported boot modes. For more information, see Boot modes in the\n Amazon EC2 User Guide.

", + "smithy.api#xmlName": "supportedBootModes" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the instance type.

" + } + }, + "com.amazonaws.ec2#InstanceTypeInfoFromInstanceRequirements": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The matching instance type.

", + "smithy.api#xmlName": "instanceType" + } + } + }, + "traits": { + "smithy.api#documentation": "

The list of instance types with the specified instance attributes.

" + } + }, + "com.amazonaws.ec2#InstanceTypeInfoFromInstanceRequirementsSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceTypeInfoFromInstanceRequirements", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceTypeInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceTypeInfo", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceType" + } + }, + "com.amazonaws.ec2#InstanceTypeOffering": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type. For more information, see Instance types in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "instanceType" + } + }, + "LocationType": { + "target": "com.amazonaws.ec2#LocationType", + "traits": { + "aws.protocols#ec2QueryName": "LocationType", + "smithy.api#documentation": "

The location type.

", + "smithy.api#xmlName": "locationType" + } + }, + "Location": { + "target": "com.amazonaws.ec2#Location", + "traits": { + "aws.protocols#ec2QueryName": "Location", + "smithy.api#documentation": "

The identifier for the location. This depends on the location type. For example, if the location type is\n region, the location is the Region code (for example, us-east-2.)

", + "smithy.api#xmlName": "location" + } + } + }, + "traits": { + "smithy.api#documentation": "

The instance types offered.

" + } + }, + "com.amazonaws.ec2#InstanceTypeOfferingsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceTypeOffering", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#InstanceTypesList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InstanceUsage": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AccountId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that is making use of the Capacity Reservation.

", + "smithy.api#xmlName": "accountId" + } + }, + "UsedInstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "UsedInstanceCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of instances the Amazon Web Services account currently has in the Capacity Reservation.

", + "smithy.api#xmlName": "usedInstanceCount" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the Capacity Reservation usage.

" + } + }, + "com.amazonaws.ec2#InstanceUsageSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceUsage", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Integer": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.ec2#IntegerWithConstraints": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.ec2#IntegrateServices": { + "type": "structure", + "members": { + "AthenaIntegrations": { + "target": "com.amazonaws.ec2#AthenaIntegrationsSet", + "traits": { + "smithy.api#documentation": "

Information about the integration with Amazon Athena.

", + "smithy.api#xmlName": "AthenaIntegration" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes service integrations with VPC Flow logs.

" + } + }, + "com.amazonaws.ec2#InterfacePermissionType": { + "type": "enum", + "members": { + "INSTANCE_ATTACH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTANCE-ATTACH" + } + }, + "EIP_ASSOCIATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EIP-ASSOCIATE" + } + } + } + }, + "com.amazonaws.ec2#InterfaceProtocolType": { + "type": "enum", + "members": { + "VLAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VLAN" + } + }, + "GRE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GRE" + } + } + } + }, + "com.amazonaws.ec2#InternetGateway": { + "type": "structure", + "members": { + "Attachments": { + "target": "com.amazonaws.ec2#InternetGatewayAttachmentList", + "traits": { + "aws.protocols#ec2QueryName": "AttachmentSet", + "smithy.api#documentation": "

Any VPCs attached to the internet gateway.

", + "smithy.api#xmlName": "attachmentSet" + } + }, + "InternetGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InternetGatewayId", + "smithy.api#documentation": "

The ID of the internet gateway.

", + "smithy.api#xmlName": "internetGatewayId" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the internet gateway.

", + "smithy.api#xmlName": "ownerId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the internet gateway.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an internet gateway.

" + } + }, + "com.amazonaws.ec2#InternetGatewayAttachment": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.ec2#AttachmentStatus", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the attachment. For an internet gateway, the state is\n\t\t\t\tavailable when attached to a VPC; otherwise, this value is not\n\t\t\treturned.

", + "smithy.api#xmlName": "state" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the attachment of a VPC to an internet gateway or an egress-only internet\n\t\t\tgateway.

" + } + }, + "com.amazonaws.ec2#InternetGatewayAttachmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InternetGatewayAttachment", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InternetGatewayId": { + "type": "string" + }, + "com.amazonaws.ec2#InternetGatewayIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InternetGatewayId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#InternetGatewayList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InternetGateway", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpAddress": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 15 + }, + "smithy.api#pattern": "^([0-9]{1,3}.){3}[0-9]{1,3}$" + } + }, + "com.amazonaws.ec2#IpAddressList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpAddress", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpAddressType": { + "type": "enum", + "members": { + "ipv4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv4" + } + }, + "dualstack": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dualstack" + } + }, + "ipv6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv6" + } + } + } + }, + "com.amazonaws.ec2#IpList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpPermission": { + "type": "structure", + "members": { + "FromPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "FromPort", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

If the protocol is TCP or UDP, this is the start of the port range.\n If the protocol is ICMP or ICMPv6, this is the type number. A value of -1 indicates all ICMP/ICMPv6 types. \n If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.

", + "smithy.api#xmlName": "fromPort" + } + }, + "IpProtocol": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpProtocol", + "smithy.api#documentation": "

The IP protocol name (tcp, udp, icmp, icmpv6) \n or number (see Protocol Numbers).

\n

[VPC only] Use -1 to specify all protocols. When authorizing\n security group rules, specifying -1 or a protocol number other than\n tcp, udp, icmp, or icmpv6 allows\n traffic on all ports, regardless of any port range you specify. For tcp,\n udp, and icmp, you must specify a port range. For icmpv6,\n the port range is optional; if you omit the port range, traffic for all types and codes is allowed.

", + "smithy.api#xmlName": "ipProtocol" + } + }, + "IpRanges": { + "target": "com.amazonaws.ec2#IpRangeList", + "traits": { + "aws.protocols#ec2QueryName": "IpRanges", + "smithy.api#documentation": "

The IPv4 ranges.

", + "smithy.api#xmlName": "ipRanges" + } + }, + "Ipv6Ranges": { + "target": "com.amazonaws.ec2#Ipv6RangeList", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Ranges", + "smithy.api#documentation": "

[VPC only] The IPv6 ranges.

", + "smithy.api#xmlName": "ipv6Ranges" + } + }, + "PrefixListIds": { + "target": "com.amazonaws.ec2#PrefixListIdList", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListIds", + "smithy.api#documentation": "

[VPC only] The prefix list IDs.

", + "smithy.api#xmlName": "prefixListIds" + } + }, + "ToPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "ToPort", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

If the protocol is TCP or UDP, this is the end of the port range.\n If the protocol is ICMP or ICMPv6, this is the code. A value of -1 indicates all ICMP/ICMPv6 codes. \n If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.

", + "smithy.api#xmlName": "toPort" + } + }, + "UserIdGroupPairs": { + "target": "com.amazonaws.ec2#UserIdGroupPairList", + "traits": { + "aws.protocols#ec2QueryName": "Groups", + "smithy.api#documentation": "

The security group and Amazon Web Services account ID pairs.

", + "smithy.api#xmlName": "groups" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a set of permissions for a security group rule.

" + } + }, + "com.amazonaws.ec2#IpPermissionList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpPermission", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpPrefixList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpRange": { + "type": "structure", + "members": { + "CidrIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrIp", + "smithy.api#documentation": "

The IPv4 CIDR range. You can either specify a CIDR range or a source security group,\n not both. To specify a single IPv4 address, use the /32 prefix length.

", + "smithy.api#xmlName": "cidrIp" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the security group rule that references this IPv4 address range.

\n

Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9,\n spaces, and ._-:/()#,@[]+=&;{}!$*

", + "smithy.api#xmlName": "description" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an IPv4 range.

" + } + }, + "com.amazonaws.ec2#IpRangeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpRange", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpRanges": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Ipam": { + "type": "structure", + "members": { + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the IPAM.

", + "smithy.api#xmlName": "ownerId" + } + }, + "IpamId": { + "target": "com.amazonaws.ec2#IpamId", + "traits": { + "aws.protocols#ec2QueryName": "IpamId", + "smithy.api#documentation": "

The ID of the IPAM.

", + "smithy.api#xmlName": "ipamId" + } + }, + "IpamArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "IpamArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IPAM.

", + "smithy.api#xmlName": "ipamArn" + } + }, + "IpamRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpamRegion", + "smithy.api#documentation": "

The Amazon Web Services Region of the IPAM.

", + "smithy.api#xmlName": "ipamRegion" + } + }, + "PublicDefaultScopeId": { + "target": "com.amazonaws.ec2#IpamScopeId", + "traits": { + "aws.protocols#ec2QueryName": "PublicDefaultScopeId", + "smithy.api#documentation": "

The ID of the IPAM's default public scope.

", + "smithy.api#xmlName": "publicDefaultScopeId" + } + }, + "PrivateDefaultScopeId": { + "target": "com.amazonaws.ec2#IpamScopeId", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDefaultScopeId", + "smithy.api#documentation": "

The ID of the IPAM's default private scope.

", + "smithy.api#xmlName": "privateDefaultScopeId" + } + }, + "ScopeCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "ScopeCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see Quotas in IPAM in the Amazon VPC IPAM User Guide.\n

", + "smithy.api#xmlName": "scopeCount" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description for the IPAM.

", + "smithy.api#xmlName": "description" + } + }, + "OperatingRegions": { + "target": "com.amazonaws.ec2#IpamOperatingRegionSet", + "traits": { + "aws.protocols#ec2QueryName": "OperatingRegionSet", + "smithy.api#documentation": "

The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

\n

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.

", + "smithy.api#xmlName": "operatingRegionSet" + } + }, + "State": { + "target": "com.amazonaws.ec2#IpamState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the IPAM.

", + "smithy.api#xmlName": "state" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

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.\n 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.

", + "smithy.api#xmlName": "tagSet" + } + }, + "DefaultResourceDiscoveryId": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryId", + "traits": { + "aws.protocols#ec2QueryName": "DefaultResourceDiscoveryId", + "smithy.api#documentation": "

The IPAM's default resource discovery ID.

", + "smithy.api#xmlName": "defaultResourceDiscoveryId" + } + }, + "DefaultResourceDiscoveryAssociationId": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryAssociationId", + "traits": { + "aws.protocols#ec2QueryName": "DefaultResourceDiscoveryAssociationId", + "smithy.api#documentation": "

The IPAM's default resource discovery association ID.

", + "smithy.api#xmlName": "defaultResourceDiscoveryAssociationId" + } + }, + "ResourceDiscoveryAssociationCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "ResourceDiscoveryAssociationCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The IPAM's resource discovery association count.

", + "smithy.api#xmlName": "resourceDiscoveryAssociationCount" + } + } + }, + "traits": { + "smithy.api#documentation": "

IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.

" + } + }, + "com.amazonaws.ec2#IpamAddressHistoryMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#IpamAddressHistoryRecord": { + "type": "structure", + "members": { + "ResourceOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceOwnerId", + "smithy.api#documentation": "

The ID of the resource owner.

", + "smithy.api#xmlName": "resourceOwnerId" + } + }, + "ResourceRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceRegion", + "smithy.api#documentation": "

The Amazon Web Services Region of the resource.

", + "smithy.api#xmlName": "resourceRegion" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#IpamAddressHistoryResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The type of the resource.

", + "smithy.api#xmlName": "resourceType" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource.

", + "smithy.api#xmlName": "resourceId" + } + }, + "ResourceCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceCidr", + "smithy.api#documentation": "

The CIDR of the resource.

", + "smithy.api#xmlName": "resourceCidr" + } + }, + "ResourceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceName", + "smithy.api#documentation": "

The name of the resource.

", + "smithy.api#xmlName": "resourceName" + } + }, + "ResourceComplianceStatus": { + "target": "com.amazonaws.ec2#IpamComplianceStatus", + "traits": { + "aws.protocols#ec2QueryName": "ResourceComplianceStatus", + "smithy.api#documentation": "

The compliance status of a resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.

", + "smithy.api#xmlName": "resourceComplianceStatus" + } + }, + "ResourceOverlapStatus": { + "target": "com.amazonaws.ec2#IpamOverlapStatus", + "traits": { + "aws.protocols#ec2QueryName": "ResourceOverlapStatus", + "smithy.api#documentation": "

The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.

", + "smithy.api#xmlName": "resourceOverlapStatus" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The VPC ID of the resource.

", + "smithy.api#xmlName": "vpcId" + } + }, + "SampledStartTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "SampledStartTime", + "smithy.api#documentation": "

Sampled start time of the resource-to-CIDR association within the IPAM scope. Changes are picked up in periodic snapshots, so the start time may have occurred before this specific time.

", + "smithy.api#xmlName": "sampledStartTime" + } + }, + "SampledEndTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "SampledEndTime", + "smithy.api#documentation": "

Sampled end time of the resource-to-CIDR association within the IPAM scope. Changes are picked up in periodic snapshots, so the end time may have occurred before this specific time.

", + "smithy.api#xmlName": "sampledEndTime" + } + } + }, + "traits": { + "smithy.api#documentation": "

The historical record of a CIDR within an IPAM scope. For more information, see View the history of IP addresses in the Amazon VPC IPAM User Guide.\n

" + } + }, + "com.amazonaws.ec2#IpamAddressHistoryRecordSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamAddressHistoryRecord", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamAddressHistoryResourceType": { + "type": "enum", + "members": { + "eip": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eip" + } + }, + "vpc": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc" + } + }, + "subnet": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "subnet" + } + }, + "network_interface": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "network-interface" + } + }, + "instance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "instance" + } + } + } + }, + "com.amazonaws.ec2#IpamAssociatedResourceDiscoveryStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "not-found" + } + } + } + }, + "com.amazonaws.ec2#IpamCidrAuthorizationContext": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The plain-text authorization message for the prefix and account.

" + } + }, + "Signature": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The signed authorization message for the prefix and account.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.

" + } + }, + "com.amazonaws.ec2#IpamComplianceStatus": { + "type": "enum", + "members": { + "compliant": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "compliant" + } + }, + "noncompliant": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "noncompliant" + } + }, + "unmanaged": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unmanaged" + } + }, + "ignored": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ignored" + } + } + } + }, + "com.amazonaws.ec2#IpamDiscoveredAccount": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AccountId", + "smithy.api#documentation": "

The account ID.

", + "smithy.api#xmlName": "accountId" + } + }, + "DiscoveryRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DiscoveryRegion", + "smithy.api#documentation": "

The Amazon Web Services Region that the account information is returned from. \n An account can be discovered in multiple regions and will have a separate discovered account for each Region.

", + "smithy.api#xmlName": "discoveryRegion" + } + }, + "FailureReason": { + "target": "com.amazonaws.ec2#IpamDiscoveryFailureReason", + "traits": { + "aws.protocols#ec2QueryName": "FailureReason", + "smithy.api#documentation": "

The resource discovery failure reason.

", + "smithy.api#xmlName": "failureReason" + } + }, + "LastAttemptedDiscoveryTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "LastAttemptedDiscoveryTime", + "smithy.api#documentation": "

The last attempted resource discovery time.

", + "smithy.api#xmlName": "lastAttemptedDiscoveryTime" + } + }, + "LastSuccessfulDiscoveryTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "LastSuccessfulDiscoveryTime", + "smithy.api#documentation": "

The last successful resource discovery time.

", + "smithy.api#xmlName": "lastSuccessfulDiscoveryTime" + } + } + }, + "traits": { + "smithy.api#documentation": "

An IPAM discovered account. A discovered account is an Amazon Web Services account that is monitored under a resource discovery. If you have integrated IPAM with Amazon Web Services Organizations, all accounts in the organization are discovered accounts.

" + } + }, + "com.amazonaws.ec2#IpamDiscoveredAccountSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamDiscoveredAccount", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamDiscoveredResourceCidr": { + "type": "structure", + "members": { + "IpamResourceDiscoveryId": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryId", + "traits": { + "aws.protocols#ec2QueryName": "IpamResourceDiscoveryId", + "smithy.api#documentation": "

The resource discovery ID.

", + "smithy.api#xmlName": "ipamResourceDiscoveryId" + } + }, + "ResourceRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceRegion", + "smithy.api#documentation": "

The resource Region.

", + "smithy.api#xmlName": "resourceRegion" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The resource ID.

", + "smithy.api#xmlName": "resourceId" + } + }, + "ResourceOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceOwnerId", + "smithy.api#documentation": "

The resource owner ID.

", + "smithy.api#xmlName": "resourceOwnerId" + } + }, + "ResourceCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceCidr", + "smithy.api#documentation": "

The resource CIDR.

", + "smithy.api#xmlName": "resourceCidr" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#IpamResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The resource type.

", + "smithy.api#xmlName": "resourceType" + } + }, + "ResourceTags": { + "target": "com.amazonaws.ec2#IpamResourceTagList", + "traits": { + "aws.protocols#ec2QueryName": "ResourceTagSet", + "smithy.api#documentation": "

The resource tags.

", + "smithy.api#xmlName": "resourceTagSet" + } + }, + "IpUsage": { + "target": "com.amazonaws.ec2#BoxedDouble", + "traits": { + "aws.protocols#ec2QueryName": "IpUsage", + "smithy.api#documentation": "

The percentage of IP address space in use. To convert the decimal to a percentage, multiply the decimal by 100. Note the following:

\n ", + "smithy.api#xmlName": "ipUsage" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The VPC ID.

", + "smithy.api#xmlName": "vpcId" + } + }, + "SampleTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "SampleTime", + "smithy.api#documentation": "

The last successful resource discovery time.

", + "smithy.api#xmlName": "sampleTime" + } + } + }, + "traits": { + "smithy.api#documentation": "

An IPAM discovered resource CIDR. A discovered resource is a resource CIDR monitored under a resource discovery. The following resources can be discovered: VPCs, Public IPv4 pools, VPC subnets, and Elastic IP addresses. The discovered resource CIDR is the IP address range in CIDR notation that is associated with the resource.

" + } + }, + "com.amazonaws.ec2#IpamDiscoveredResourceCidrSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamDiscoveredResourceCidr", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamDiscoveryFailureCode": { + "type": "enum", + "members": { + "assume_role_failure": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "assume-role-failure" + } + }, + "throttling_failure": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "throttling-failure" + } + }, + "unauthorized_failure": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unauthorized-failure" + } + } + } + }, + "com.amazonaws.ec2#IpamDiscoveryFailureReason": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#IpamDiscoveryFailureCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The discovery failure code.

\n ", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The discovery failure message.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

The discovery failure reason.

" + } + }, + "com.amazonaws.ec2#IpamId": { + "type": "string" + }, + "com.amazonaws.ec2#IpamManagementState": { + "type": "enum", + "members": { + "managed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "managed" + } + }, + "unmanaged": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unmanaged" + } + }, + "ignored": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ignored" + } + } + } + }, + "com.amazonaws.ec2#IpamMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#IpamNetmaskLength": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 128 + } + } + }, + "com.amazonaws.ec2#IpamOperatingRegion": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RegionName", + "smithy.api#documentation": "

The name of the operating Region.

", + "smithy.api#xmlName": "regionName" + } + } + }, + "traits": { + "smithy.api#documentation": "

The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

\n

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.

" + } + }, + "com.amazonaws.ec2#IpamOperatingRegionSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamOperatingRegion", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamOverlapStatus": { + "type": "enum", + "members": { + "overlapping": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "overlapping" + } + }, + "nonoverlapping": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nonoverlapping" + } + }, + "ignored": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ignored" + } + } + } + }, + "com.amazonaws.ec2#IpamPool": { + "type": "structure", + "members": { + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the IPAM pool.

", + "smithy.api#xmlName": "ownerId" + } + }, + "IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "aws.protocols#ec2QueryName": "IpamPoolId", + "smithy.api#documentation": "

The ID of the IPAM pool.

", + "smithy.api#xmlName": "ipamPoolId" + } + }, + "SourceIpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "aws.protocols#ec2QueryName": "SourceIpamPoolId", + "smithy.api#documentation": "

The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool.

", + "smithy.api#xmlName": "sourceIpamPoolId" + } + }, + "IpamPoolArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "IpamPoolArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IPAM pool.

", + "smithy.api#xmlName": "ipamPoolArn" + } + }, + "IpamScopeArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "IpamScopeArn", + "smithy.api#documentation": "

The ARN of the scope of the IPAM pool.

", + "smithy.api#xmlName": "ipamScopeArn" + } + }, + "IpamScopeType": { + "target": "com.amazonaws.ec2#IpamScopeType", + "traits": { + "aws.protocols#ec2QueryName": "IpamScopeType", + "smithy.api#documentation": "

In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.

", + "smithy.api#xmlName": "ipamScopeType" + } + }, + "IpamArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "IpamArn", + "smithy.api#documentation": "

The ARN of the IPAM.

", + "smithy.api#xmlName": "ipamArn" + } + }, + "IpamRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpamRegion", + "smithy.api#documentation": "

The Amazon Web Services Region of the IPAM pool.

", + "smithy.api#xmlName": "ipamRegion" + } + }, + "Locale": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Locale", + "smithy.api#documentation": "

The locale of the IPAM pool. In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you choose an Amazon Web Services Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.

", + "smithy.api#xmlName": "locale" + } + }, + "PoolDepth": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "PoolDepth", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The depth of pools in your IPAM pool. The pool depth quota is 10. For more information, see Quotas in IPAM in the Amazon VPC IPAM User Guide.\n

", + "smithy.api#xmlName": "poolDepth" + } + }, + "State": { + "target": "com.amazonaws.ec2#IpamPoolState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the IPAM pool.

", + "smithy.api#xmlName": "state" + } + }, + "StateMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StateMessage", + "smithy.api#documentation": "

A message related to the failed creation of an IPAM pool.

", + "smithy.api#xmlName": "stateMessage" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of the IPAM pool.

", + "smithy.api#xmlName": "description" + } + }, + "AutoImport": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AutoImport", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

If selected, IPAM will continuously look for resources within the CIDR range of this pool \n and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for\n these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import \n a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently \n marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM \n discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.\n

\n

A locale must be set on the pool for this feature to work.

", + "smithy.api#xmlName": "autoImport" + } + }, + "PubliclyAdvertisable": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "PubliclyAdvertisable", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4.

", + "smithy.api#xmlName": "publiclyAdvertisable" + } + }, + "AddressFamily": { + "target": "com.amazonaws.ec2#AddressFamily", + "traits": { + "aws.protocols#ec2QueryName": "AddressFamily", + "smithy.api#documentation": "

The address family of the pool.

", + "smithy.api#xmlName": "addressFamily" + } + }, + "AllocationMinNetmaskLength": { + "target": "com.amazonaws.ec2#IpamNetmaskLength", + "traits": { + "aws.protocols#ec2QueryName": "AllocationMinNetmaskLength", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

", + "smithy.api#xmlName": "allocationMinNetmaskLength" + } + }, + "AllocationMaxNetmaskLength": { + "target": "com.amazonaws.ec2#IpamNetmaskLength", + "traits": { + "aws.protocols#ec2QueryName": "AllocationMaxNetmaskLength", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

", + "smithy.api#xmlName": "allocationMaxNetmaskLength" + } + }, + "AllocationDefaultNetmaskLength": { + "target": "com.amazonaws.ec2#IpamNetmaskLength", + "traits": { + "aws.protocols#ec2QueryName": "AllocationDefaultNetmaskLength", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and \n you enter 16 here, new allocations will default to 10.0.0.0/16.

", + "smithy.api#xmlName": "allocationDefaultNetmaskLength" + } + }, + "AllocationResourceTags": { + "target": "com.amazonaws.ec2#IpamResourceTagList", + "traits": { + "aws.protocols#ec2QueryName": "AllocationResourceTagSet", + "smithy.api#documentation": "

Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.

", + "smithy.api#xmlName": "allocationResourceTagSet" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

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.\n 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.

", + "smithy.api#xmlName": "tagSet" + } + }, + "AwsService": { + "target": "com.amazonaws.ec2#IpamPoolAwsService", + "traits": { + "aws.protocols#ec2QueryName": "AwsService", + "smithy.api#documentation": "

Limits which service in Amazon Web Services that the pool can be used in. \"ec2\", for example, allows users to use space for Elastic IP addresses and VPCs.

", + "smithy.api#xmlName": "awsService" + } + }, + "PublicIpSource": { + "target": "com.amazonaws.ec2#IpamPoolPublicIpSource", + "traits": { + "aws.protocols#ec2QueryName": "PublicIpSource", + "smithy.api#documentation": "

The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is BYOIP. For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide. \n By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.

", + "smithy.api#xmlName": "publicIpSource" + } + } + }, + "traits": { + "smithy.api#documentation": "

In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.

" + } + }, + "com.amazonaws.ec2#IpamPoolAllocation": { + "type": "structure", + "members": { + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Cidr", + "smithy.api#documentation": "

The CIDR for the allocation. A CIDR is a representation of an IP address and its associated network mask (or netmask) and \n refers to a range of IP addresses. An IPv4 CIDR example is 10.24.34.0/23. An IPv6 CIDR example is 2001:DB8::/32.

", + "smithy.api#xmlName": "cidr" + } + }, + "IpamPoolAllocationId": { + "target": "com.amazonaws.ec2#IpamPoolAllocationId", + "traits": { + "aws.protocols#ec2QueryName": "IpamPoolAllocationId", + "smithy.api#documentation": "

The ID of an allocation.

", + "smithy.api#xmlName": "ipamPoolAllocationId" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the pool allocation.

", + "smithy.api#xmlName": "description" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource.

", + "smithy.api#xmlName": "resourceId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#IpamPoolAllocationResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The type of the resource.

", + "smithy.api#xmlName": "resourceType" + } + }, + "ResourceRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceRegion", + "smithy.api#documentation": "

The Amazon Web Services Region of the resource.

", + "smithy.api#xmlName": "resourceRegion" + } + }, + "ResourceOwner": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceOwner", + "smithy.api#documentation": "

The owner of the resource.

", + "smithy.api#xmlName": "resourceOwner" + } + } + }, + "traits": { + "smithy.api#documentation": "

In IPAM, an allocation is a CIDR assignment from an IPAM pool to another IPAM pool or to a resource.

" + } + }, + "com.amazonaws.ec2#IpamPoolAllocationDisallowedCidrs": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamPoolAllocationId": { + "type": "string" + }, + "com.amazonaws.ec2#IpamPoolAllocationResourceType": { + "type": "enum", + "members": { + "ipam_pool": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipam-pool" + } + }, + "vpc": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc" + } + }, + "ec2_public_ipv4_pool": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ec2-public-ipv4-pool" + } + }, + "custom": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "custom" + } + } + } + }, + "com.amazonaws.ec2#IpamPoolAllocationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamPoolAllocation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamPoolAwsService": { + "type": "enum", + "members": { + "ec2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ec2" + } + } + } + }, + "com.amazonaws.ec2#IpamPoolCidr": { + "type": "structure", + "members": { + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Cidr", + "smithy.api#documentation": "

The CIDR provisioned to the IPAM pool. A CIDR is a representation of an IP address and its associated network mask (or netmask) \n and refers to a range of IP addresses. An IPv4 CIDR example is 10.24.34.0/23. An IPv6 CIDR example is 2001:DB8::/32.

", + "smithy.api#xmlName": "cidr" + } + }, + "State": { + "target": "com.amazonaws.ec2#IpamPoolCidrState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the CIDR.

", + "smithy.api#xmlName": "state" + } + }, + "FailureReason": { + "target": "com.amazonaws.ec2#IpamPoolCidrFailureReason", + "traits": { + "aws.protocols#ec2QueryName": "FailureReason", + "smithy.api#documentation": "

Details related to why an IPAM pool CIDR failed to be provisioned.

", + "smithy.api#xmlName": "failureReason" + } + }, + "IpamPoolCidrId": { + "target": "com.amazonaws.ec2#IpamPoolCidrId", + "traits": { + "aws.protocols#ec2QueryName": "IpamPoolCidrId", + "smithy.api#documentation": "

The IPAM pool CIDR ID.

", + "smithy.api#xmlName": "ipamPoolCidrId" + } + }, + "NetmaskLength": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "NetmaskLength", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The netmask length of the CIDR you'd like to provision to a pool. Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. \"NetmaskLength\" or \"Cidr\" is required.

", + "smithy.api#xmlName": "netmaskLength" + } + } + }, + "traits": { + "smithy.api#documentation": "

A CIDR provisioned to an IPAM pool.

" + } + }, + "com.amazonaws.ec2#IpamPoolCidrFailureCode": { + "type": "enum", + "members": { + "cidr_not_available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cidr-not-available" + } + }, + "limit_exceeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "limit-exceeded" + } + } + } + }, + "com.amazonaws.ec2#IpamPoolCidrFailureReason": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#IpamPoolCidrFailureCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

An error code related to why an IPAM pool CIDR failed to be provisioned.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

A message related to why an IPAM pool CIDR failed to be provisioned.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details related to why an IPAM pool CIDR failed to be provisioned.

" + } + }, + "com.amazonaws.ec2#IpamPoolCidrId": { + "type": "string" + }, + "com.amazonaws.ec2#IpamPoolCidrSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamPoolCidr", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamPoolCidrState": { + "type": "enum", + "members": { + "pending_provision": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending-provision" + } + }, + "provisioned": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "provisioned" + } + }, + "failed_provision": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed-provision" + } + }, + "pending_deprovision": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending-deprovision" + } + }, + "deprovisioned": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deprovisioned" + } + }, + "failed_deprovision": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed-deprovision" + } + }, + "pending_import": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending-import" + } + }, + "failed_import": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed-import" + } + } + } + }, + "com.amazonaws.ec2#IpamPoolId": { + "type": "string" + }, + "com.amazonaws.ec2#IpamPoolPublicIpSource": { + "type": "enum", + "members": { + "amazon": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "amazon" + } + }, + "byoip": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "byoip" + } + } + } + }, + "com.amazonaws.ec2#IpamPoolSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamPool", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamPoolState": { + "type": "enum", + "members": { + "create_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-in-progress" + } + }, + "create_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-complete" + } + }, + "create_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-failed" + } + }, + "modify_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modify-in-progress" + } + }, + "modify_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modify-complete" + } + }, + "modify_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modify-failed" + } + }, + "delete_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-in-progress" + } + }, + "delete_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-complete" + } + }, + "delete_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-failed" + } + }, + "isolate_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "isolate-in-progress" + } + }, + "isolate_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "isolate-complete" + } + }, + "restore_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "restore-in-progress" + } + } + } + }, + "com.amazonaws.ec2#IpamResourceCidr": { + "type": "structure", + "members": { + "IpamId": { + "target": "com.amazonaws.ec2#IpamId", + "traits": { + "aws.protocols#ec2QueryName": "IpamId", + "smithy.api#documentation": "

The IPAM ID for an IPAM resource.

", + "smithy.api#xmlName": "ipamId" + } + }, + "IpamScopeId": { + "target": "com.amazonaws.ec2#IpamScopeId", + "traits": { + "aws.protocols#ec2QueryName": "IpamScopeId", + "smithy.api#documentation": "

The scope ID for an IPAM resource.

", + "smithy.api#xmlName": "ipamScopeId" + } + }, + "IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "aws.protocols#ec2QueryName": "IpamPoolId", + "smithy.api#documentation": "

The pool ID for an IPAM resource.

", + "smithy.api#xmlName": "ipamPoolId" + } + }, + "ResourceRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceRegion", + "smithy.api#documentation": "

The Amazon Web Services Region for an IPAM resource.

", + "smithy.api#xmlName": "resourceRegion" + } + }, + "ResourceOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceOwnerId", + "smithy.api#documentation": "

The Amazon Web Services account number of the owner of an IPAM resource.

", + "smithy.api#xmlName": "resourceOwnerId" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of an IPAM resource.

", + "smithy.api#xmlName": "resourceId" + } + }, + "ResourceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceName", + "smithy.api#documentation": "

The name of an IPAM resource.

", + "smithy.api#xmlName": "resourceName" + } + }, + "ResourceCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceCidr", + "smithy.api#documentation": "

The CIDR for an IPAM resource.

", + "smithy.api#xmlName": "resourceCidr" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#IpamResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The type of IPAM resource.

", + "smithy.api#xmlName": "resourceType" + } + }, + "ResourceTags": { + "target": "com.amazonaws.ec2#IpamResourceTagList", + "traits": { + "aws.protocols#ec2QueryName": "ResourceTagSet", + "smithy.api#documentation": "

The tags for an IPAM resource.

", + "smithy.api#xmlName": "resourceTagSet" + } + }, + "IpUsage": { + "target": "com.amazonaws.ec2#BoxedDouble", + "traits": { + "aws.protocols#ec2QueryName": "IpUsage", + "smithy.api#documentation": "

The percentage of IP address space in use. To convert the decimal to a percentage, multiply the decimal by 100. Note the following:

\n ", + "smithy.api#xmlName": "ipUsage" + } + }, + "ComplianceStatus": { + "target": "com.amazonaws.ec2#IpamComplianceStatus", + "traits": { + "aws.protocols#ec2QueryName": "ComplianceStatus", + "smithy.api#documentation": "

The compliance status of the IPAM resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.

", + "smithy.api#xmlName": "complianceStatus" + } + }, + "ManagementState": { + "target": "com.amazonaws.ec2#IpamManagementState", + "traits": { + "aws.protocols#ec2QueryName": "ManagementState", + "smithy.api#documentation": "

The management state of the resource. For more information about management states, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.

", + "smithy.api#xmlName": "managementState" + } + }, + "OverlapStatus": { + "target": "com.amazonaws.ec2#IpamOverlapStatus", + "traits": { + "aws.protocols#ec2QueryName": "OverlapStatus", + "smithy.api#documentation": "

The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.

", + "smithy.api#xmlName": "overlapStatus" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of a VPC.

", + "smithy.api#xmlName": "vpcId" + } + } + }, + "traits": { + "smithy.api#documentation": "

The CIDR for an IPAM resource.

" + } + }, + "com.amazonaws.ec2#IpamResourceCidrSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamResourceCidr", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamResourceDiscovery": { + "type": "structure", + "members": { + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the owner.

", + "smithy.api#xmlName": "ownerId" + } + }, + "IpamResourceDiscoveryId": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryId", + "traits": { + "aws.protocols#ec2QueryName": "IpamResourceDiscoveryId", + "smithy.api#documentation": "

The resource discovery ID.

", + "smithy.api#xmlName": "ipamResourceDiscoveryId" + } + }, + "IpamResourceDiscoveryArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpamResourceDiscoveryArn", + "smithy.api#documentation": "

The resource discovery Amazon Resource Name (ARN).

", + "smithy.api#xmlName": "ipamResourceDiscoveryArn" + } + }, + "IpamResourceDiscoveryRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpamResourceDiscoveryRegion", + "smithy.api#documentation": "

The resource discovery Region.

", + "smithy.api#xmlName": "ipamResourceDiscoveryRegion" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The resource discovery description.

", + "smithy.api#xmlName": "description" + } + }, + "OperatingRegions": { + "target": "com.amazonaws.ec2#IpamOperatingRegionSet", + "traits": { + "aws.protocols#ec2QueryName": "OperatingRegionSet", + "smithy.api#documentation": "

The operating Regions for the resource discovery. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

", + "smithy.api#xmlName": "operatingRegionSet" + } + }, + "IsDefault": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "IsDefault", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Defines if the resource discovery is the default. The default resource discovery is the resource discovery automatically created when you create an IPAM.

", + "smithy.api#xmlName": "isDefault" + } + }, + "State": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The lifecycle state of the resource discovery.

\n ", + "smithy.api#xmlName": "state" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

" + } + }, + "com.amazonaws.ec2#IpamResourceDiscoveryAssociation": { + "type": "structure", + "members": { + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The Amazon Web Services account ID of the resource discovery owner.

", + "smithy.api#xmlName": "ownerId" + } + }, + "IpamResourceDiscoveryAssociationId": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryAssociationId", + "traits": { + "aws.protocols#ec2QueryName": "IpamResourceDiscoveryAssociationId", + "smithy.api#documentation": "

The resource discovery association ID.

", + "smithy.api#xmlName": "ipamResourceDiscoveryAssociationId" + } + }, + "IpamResourceDiscoveryAssociationArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpamResourceDiscoveryAssociationArn", + "smithy.api#documentation": "

The resource discovery association Amazon Resource Name (ARN).

", + "smithy.api#xmlName": "ipamResourceDiscoveryAssociationArn" + } + }, + "IpamResourceDiscoveryId": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryId", + "traits": { + "aws.protocols#ec2QueryName": "IpamResourceDiscoveryId", + "smithy.api#documentation": "

The resource discovery ID.

", + "smithy.api#xmlName": "ipamResourceDiscoveryId" + } + }, + "IpamId": { + "target": "com.amazonaws.ec2#IpamId", + "traits": { + "aws.protocols#ec2QueryName": "IpamId", + "smithy.api#documentation": "

The IPAM ID.

", + "smithy.api#xmlName": "ipamId" + } + }, + "IpamArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "IpamArn", + "smithy.api#documentation": "

The IPAM ARN.

", + "smithy.api#xmlName": "ipamArn" + } + }, + "IpamRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpamRegion", + "smithy.api#documentation": "

The IPAM home Region.

", + "smithy.api#xmlName": "ipamRegion" + } + }, + "IsDefault": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "IsDefault", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Defines if the resource discovery is the default. When you create an IPAM, a default resource discovery is created for your IPAM and it's associated with your IPAM.

", + "smithy.api#xmlName": "isDefault" + } + }, + "ResourceDiscoveryStatus": { + "target": "com.amazonaws.ec2#IpamAssociatedResourceDiscoveryStatus", + "traits": { + "aws.protocols#ec2QueryName": "ResourceDiscoveryStatus", + "smithy.api#documentation": "

The resource discovery status.

\n ", + "smithy.api#xmlName": "resourceDiscoveryStatus" + } + }, + "State": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryAssociationState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The lifecycle state of the association when you associate or disassociate a resource discovery.

\n ", + "smithy.api#xmlName": "state" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

An IPAM resource discovery association. An associated resource discovery is a resource discovery that has been associated with an IPAM. IPAM aggregates the resource CIDRs discovered by the associated resource discovery.

" + } + }, + "com.amazonaws.ec2#IpamResourceDiscoveryAssociationId": { + "type": "string" + }, + "com.amazonaws.ec2#IpamResourceDiscoveryAssociationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamResourceDiscoveryAssociationState": { + "type": "enum", + "members": { + "ASSOCIATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associate-in-progress" + } + }, + "ASSOCIATE_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associate-complete" + } + }, + "ASSOCIATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associate-failed" + } + }, + "DISASSOCIATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociate-in-progress" + } + }, + "DISASSOCIATE_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociate-complete" + } + }, + "DISASSOCIATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociate-failed" + } + }, + "ISOLATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "isolate-in-progress" + } + }, + "ISOLATE_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "isolate-complete" + } + }, + "RESTORE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "restore-in-progress" + } + } + } + }, + "com.amazonaws.ec2#IpamResourceDiscoveryId": { + "type": "string" + }, + "com.amazonaws.ec2#IpamResourceDiscoverySet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamResourceDiscovery", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamResourceDiscoveryState": { + "type": "enum", + "members": { + "CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-in-progress" + } + }, + "CREATE_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-complete" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-failed" + } + }, + "MODIFY_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modify-in-progress" + } + }, + "MODIFY_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modify-complete" + } + }, + "MODIFY_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modify-failed" + } + }, + "DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-in-progress" + } + }, + "DELETE_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-complete" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-failed" + } + }, + "ISOLATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "isolate-in-progress" + } + }, + "ISOLATE_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "isolate-complete" + } + }, + "RESTORE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "restore-in-progress" + } + } + } + }, + "com.amazonaws.ec2#IpamResourceTag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Key", + "smithy.api#documentation": "

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.

", + "smithy.api#xmlName": "key" + } + }, + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#documentation": "

The value of the tag.

", + "smithy.api#xmlName": "value" + } + } + }, + "traits": { + "smithy.api#documentation": "

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.\n 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.

" + } + }, + "com.amazonaws.ec2#IpamResourceTagList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamResourceTag", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamResourceType": { + "type": "enum", + "members": { + "vpc": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc" + } + }, + "subnet": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "subnet" + } + }, + "eip": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eip" + } + }, + "public_ipv4_pool": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "public-ipv4-pool" + } + }, + "ipv6_pool": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv6-pool" + } + } + } + }, + "com.amazonaws.ec2#IpamScope": { + "type": "structure", + "members": { + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the scope.

", + "smithy.api#xmlName": "ownerId" + } + }, + "IpamScopeId": { + "target": "com.amazonaws.ec2#IpamScopeId", + "traits": { + "aws.protocols#ec2QueryName": "IpamScopeId", + "smithy.api#documentation": "

The ID of the scope.

", + "smithy.api#xmlName": "ipamScopeId" + } + }, + "IpamScopeArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "IpamScopeArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the scope.

", + "smithy.api#xmlName": "ipamScopeArn" + } + }, + "IpamArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "IpamArn", + "smithy.api#documentation": "

The ARN of the IPAM.

", + "smithy.api#xmlName": "ipamArn" + } + }, + "IpamRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpamRegion", + "smithy.api#documentation": "

The Amazon Web Services Region of the IPAM scope.

", + "smithy.api#xmlName": "ipamRegion" + } + }, + "IpamScopeType": { + "target": "com.amazonaws.ec2#IpamScopeType", + "traits": { + "aws.protocols#ec2QueryName": "IpamScopeType", + "smithy.api#documentation": "

The type of the scope.

", + "smithy.api#xmlName": "ipamScopeType" + } + }, + "IsDefault": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "IsDefault", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Defines if the scope is the default scope or not.

", + "smithy.api#xmlName": "isDefault" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of the scope.

", + "smithy.api#xmlName": "description" + } + }, + "PoolCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "PoolCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of pools in the scope.

", + "smithy.api#xmlName": "poolCount" + } + }, + "State": { + "target": "com.amazonaws.ec2#IpamScopeState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the IPAM scope.

", + "smithy.api#xmlName": "state" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

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.\n 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.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.

\n

For more information, see How IPAM works in the Amazon VPC IPAM User Guide.

" + } + }, + "com.amazonaws.ec2#IpamScopeId": { + "type": "string" + }, + "com.amazonaws.ec2#IpamScopeSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#IpamScope", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamScopeState": { + "type": "enum", + "members": { + "create_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-in-progress" + } + }, + "create_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-complete" + } + }, + "create_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-failed" + } + }, + "modify_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modify-in-progress" + } + }, + "modify_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modify-complete" + } + }, + "modify_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modify-failed" + } + }, + "delete_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-in-progress" + } + }, + "delete_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-complete" + } + }, + "delete_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-failed" + } + }, + "isolate_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "isolate-in-progress" + } + }, + "isolate_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "isolate-complete" + } + }, + "restore_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "restore-in-progress" + } + } + } + }, + "com.amazonaws.ec2#IpamScopeType": { + "type": "enum", + "members": { + "public": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "public" + } + }, + "private": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "private" + } + } + } + }, + "com.amazonaws.ec2#IpamSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Ipam", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#IpamState": { + "type": "enum", + "members": { + "create_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-in-progress" + } + }, + "create_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-complete" + } + }, + "create_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-failed" + } + }, + "modify_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modify-in-progress" + } + }, + "modify_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modify-complete" + } + }, + "modify_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modify-failed" + } + }, + "delete_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-in-progress" + } + }, + "delete_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-complete" + } + }, + "delete_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-failed" + } + }, + "isolate_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "isolate-in-progress" + } + }, + "isolate_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "isolate-complete" + } + }, + "restore_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "restore-in-progress" + } + } + } + }, + "com.amazonaws.ec2#Ipv4PoolCoipId": { + "type": "string" + }, + "com.amazonaws.ec2#Ipv4PoolEc2Id": { + "type": "string" + }, + "com.amazonaws.ec2#Ipv4PrefixList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Ipv4PrefixSpecificationRequest", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Ipv4PrefixListResponse": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Ipv4PrefixSpecificationResponse", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Ipv4PrefixSpecification": { + "type": "structure", + "members": { + "Ipv4Prefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv4Prefix", + "smithy.api#documentation": "

The IPv4 prefix. For information, see \n Assigning prefixes to Amazon EC2 network interfaces in the\n Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#xmlName": "ipv4Prefix" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an IPv4 prefix.

" + } + }, + "com.amazonaws.ec2#Ipv4PrefixSpecificationRequest": { + "type": "structure", + "members": { + "Ipv4Prefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv4 prefix. For information, see \n Assigning prefixes to Amazon EC2 network interfaces in the\n Amazon Elastic Compute Cloud User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the IPv4 prefix option for a network interface.

" + } + }, + "com.amazonaws.ec2#Ipv4PrefixSpecificationResponse": { + "type": "structure", + "members": { + "Ipv4Prefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv4Prefix", + "smithy.api#documentation": "

The IPv4 delegated prefixes assigned to the network interface.

", + "smithy.api#xmlName": "ipv4Prefix" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the IPv4 delegated prefixes assigned \n to a network interface.

" + } + }, + "com.amazonaws.ec2#Ipv4PrefixesList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Ipv4PrefixSpecification", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Ipv6Address": { + "type": "string" + }, + "com.amazonaws.ec2#Ipv6AddressList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Ipv6CidrAssociation": { + "type": "structure", + "members": { + "Ipv6Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Cidr", + "smithy.api#documentation": "

The IPv6 CIDR block.

", + "smithy.api#xmlName": "ipv6Cidr" + } + }, + "AssociatedResource": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AssociatedResource", + "smithy.api#documentation": "

The resource that's associated with the IPv6 CIDR block.

", + "smithy.api#xmlName": "associatedResource" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an IPv6 CIDR block association.

" + } + }, + "com.amazonaws.ec2#Ipv6CidrAssociationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Ipv6CidrAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Ipv6CidrBlock": { + "type": "structure", + "members": { + "Ipv6CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrBlock", + "smithy.api#documentation": "

The IPv6 CIDR block.

", + "smithy.api#xmlName": "ipv6CidrBlock" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an IPv6 CIDR block.

" + } + }, + "com.amazonaws.ec2#Ipv6CidrBlockSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Ipv6CidrBlock", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Ipv6Flag": { + "type": "boolean" + }, + "com.amazonaws.ec2#Ipv6Pool": { + "type": "structure", + "members": { + "PoolId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PoolId", + "smithy.api#documentation": "

The ID of the address pool.

", + "smithy.api#xmlName": "poolId" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description for the address pool.

", + "smithy.api#xmlName": "description" + } + }, + "PoolCidrBlocks": { + "target": "com.amazonaws.ec2#PoolCidrBlocksSet", + "traits": { + "aws.protocols#ec2QueryName": "PoolCidrBlockSet", + "smithy.api#documentation": "

The CIDR blocks for the address pool.

", + "smithy.api#xmlName": "poolCidrBlockSet" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags for the address pool.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an IPv6 address pool.

" + } + }, + "com.amazonaws.ec2#Ipv6PoolEc2Id": { + "type": "string" + }, + "com.amazonaws.ec2#Ipv6PoolIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Ipv6PoolEc2Id", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Ipv6PoolMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#Ipv6PoolSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Ipv6Pool", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Ipv6PrefixList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Ipv6PrefixSpecificationRequest", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Ipv6PrefixListResponse": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Ipv6PrefixSpecificationResponse", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Ipv6PrefixSpecification": { + "type": "structure", + "members": { + "Ipv6Prefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Prefix", + "smithy.api#documentation": "

The IPv6 prefix.

", + "smithy.api#xmlName": "ipv6Prefix" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the IPv6 prefix.

" + } + }, + "com.amazonaws.ec2#Ipv6PrefixSpecificationRequest": { + "type": "structure", + "members": { + "Ipv6Prefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv6 prefix.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the IPv4 prefix option for a network interface.

" + } + }, + "com.amazonaws.ec2#Ipv6PrefixSpecificationResponse": { + "type": "structure", + "members": { + "Ipv6Prefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Prefix", + "smithy.api#documentation": "

The IPv6 delegated prefixes assigned to the network interface.

", + "smithy.api#xmlName": "ipv6Prefix" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the IPv6 delegated prefixes assigned \n to a network interface.

" + } + }, + "com.amazonaws.ec2#Ipv6PrefixesList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Ipv6PrefixSpecification", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Ipv6Range": { + "type": "structure", + "members": { + "CidrIpv6": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrIpv6", + "smithy.api#documentation": "

The IPv6 CIDR range. You can either specify a CIDR range or a source security group,\n not both. To specify a single IPv6 address, use the /128 prefix length.

", + "smithy.api#xmlName": "cidrIpv6" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the security group rule that references this IPv6 address range.

\n

Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9,\n spaces, and ._-:/()#,@[]+=&;{}!$*

", + "smithy.api#xmlName": "description" + } + } + }, + "traits": { + "smithy.api#documentation": "

[EC2-VPC only] Describes an IPv6 range.

" + } + }, + "com.amazonaws.ec2#Ipv6RangeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Ipv6Range", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Ipv6SupportValue": { + "type": "enum", + "members": { + "enable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enable" + } + }, + "disable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disable" + } + } + } + }, + "com.amazonaws.ec2#KernelId": { + "type": "string" + }, + "com.amazonaws.ec2#KeyFormat": { + "type": "enum", + "members": { + "pem": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pem" + } + }, + "ppk": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ppk" + } + } + } + }, + "com.amazonaws.ec2#KeyNameStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#KeyPairName", + "traits": { + "smithy.api#xmlName": "KeyName" + } + } + }, + "com.amazonaws.ec2#KeyPair": { + "type": "structure", + "members": { + "KeyFingerprint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KeyFingerprint", + "smithy.api#documentation": "", + "smithy.api#xmlName": "keyFingerprint" + } + }, + "KeyMaterial": { + "target": "com.amazonaws.ec2#SensitiveUserData", + "traits": { + "aws.protocols#ec2QueryName": "KeyMaterial", + "smithy.api#documentation": "

An unencrypted PEM encoded RSA or ED25519 private key.

", + "smithy.api#xmlName": "keyMaterial" + } + }, + "KeyName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KeyName", + "smithy.api#documentation": "

The name of the key pair.

", + "smithy.api#xmlName": "keyName" + } + }, + "KeyPairId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KeyPairId", + "smithy.api#documentation": "

The ID of the key pair.

", + "smithy.api#xmlName": "keyPairId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags applied to the key pair.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a key pair.

" + } + }, + "com.amazonaws.ec2#KeyPairId": { + "type": "string" + }, + "com.amazonaws.ec2#KeyPairIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#KeyPairId", + "traits": { + "smithy.api#xmlName": "KeyPairId" + } + } + }, + "com.amazonaws.ec2#KeyPairInfo": { + "type": "structure", + "members": { + "KeyPairId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KeyPairId", + "smithy.api#documentation": "

The ID of the key pair.

", + "smithy.api#xmlName": "keyPairId" + } + }, + "KeyFingerprint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KeyFingerprint", + "smithy.api#documentation": "

If you used CreateKeyPair to create the key pair:

\n \n

If you used ImportKeyPair to provide Amazon Web Services the public key:

\n ", + "smithy.api#xmlName": "keyFingerprint" + } + }, + "KeyName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KeyName", + "smithy.api#documentation": "

The name of the key pair.

", + "smithy.api#xmlName": "keyName" + } + }, + "KeyType": { + "target": "com.amazonaws.ec2#KeyType", + "traits": { + "aws.protocols#ec2QueryName": "KeyType", + "smithy.api#documentation": "

The type of key pair.

", + "smithy.api#xmlName": "keyType" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags applied to the key pair.

", + "smithy.api#xmlName": "tagSet" + } + }, + "PublicKey": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicKey", + "smithy.api#documentation": "

The public key material.

", + "smithy.api#xmlName": "publicKey" + } + }, + "CreateTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreateTime", + "smithy.api#documentation": "

If you used Amazon EC2 to create the key pair, this is the date and time when the key\n was created, in ISO\n 8601 date-time format, in the UTC time zone.

\n

If you imported an existing key pair to Amazon EC2, this is the date and time the key\n was imported, in ISO\n 8601 date-time format, in the UTC time zone.

", + "smithy.api#xmlName": "createTime" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a key pair.

" + } + }, + "com.amazonaws.ec2#KeyPairList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#KeyPairInfo", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#KeyPairName": { + "type": "string" + }, + "com.amazonaws.ec2#KeyType": { + "type": "enum", + "members": { + "rsa": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rsa" + } + }, + "ed25519": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ed25519" + } + } + } + }, + "com.amazonaws.ec2#KmsKeyId": { + "type": "string" + }, + "com.amazonaws.ec2#LastError": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The error message for the VPC endpoint error.

", + "smithy.api#xmlName": "message" + } + }, + "Code": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The error code for the VPC endpoint error.

", + "smithy.api#xmlName": "code" + } + } + }, + "traits": { + "smithy.api#documentation": "

The last error that occurred for a VPC endpoint.

" + } + }, + "com.amazonaws.ec2#LaunchPermission": { + "type": "structure", + "members": { + "Group": { + "target": "com.amazonaws.ec2#PermissionGroup", + "traits": { + "aws.protocols#ec2QueryName": "Group", + "smithy.api#documentation": "

The name of the group.

", + "smithy.api#xmlName": "group" + } + }, + "UserId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UserId", + "smithy.api#documentation": "

The Amazon Web Services account ID.

\n

Constraints: Up to 10 000 account IDs can be specified in a single request.

", + "smithy.api#xmlName": "userId" + } + }, + "OrganizationArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OrganizationArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an organization.

", + "smithy.api#xmlName": "organizationArn" + } + }, + "OrganizationalUnitArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OrganizationalUnitArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an organizational unit (OU).

", + "smithy.api#xmlName": "organizationalUnitArn" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a launch permission.

" + } + }, + "com.amazonaws.ec2#LaunchPermissionList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LaunchPermission", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LaunchPermissionModifications": { + "type": "structure", + "members": { + "Add": { + "target": "com.amazonaws.ec2#LaunchPermissionList", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID, organization ARN, or OU ARN to add to the list of launch permissions for the AMI.

" + } + }, + "Remove": { + "target": "com.amazonaws.ec2#LaunchPermissionList", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID, organization ARN, or OU ARN to remove from the list of launch permissions for the AMI.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a launch permission modification.

" + } + }, + "com.amazonaws.ec2#LaunchSpecification": { + "type": "structure", + "members": { + "UserData": { + "target": "com.amazonaws.ec2#SensitiveUserData", + "traits": { + "aws.protocols#ec2QueryName": "UserData", + "smithy.api#documentation": "

The base64-encoded user data that instances use when starting up. User data is limited to 16 KB.

", + "smithy.api#xmlName": "userData" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.ec2#GroupIdentifierList", + "traits": { + "aws.protocols#ec2QueryName": "GroupSet", + "smithy.api#documentation": "

The IDs of the security groups.

", + "smithy.api#xmlName": "groupSet" + } + }, + "AddressingType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AddressingType", + "smithy.api#documentation": "

Deprecated.

", + "smithy.api#xmlName": "addressingType" + } + }, + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#BlockDeviceMappingList", + "traits": { + "aws.protocols#ec2QueryName": "BlockDeviceMapping", + "smithy.api#documentation": "

The block device mapping entries.

", + "smithy.api#xmlName": "blockDeviceMapping" + } + }, + "EbsOptimized": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EbsOptimized", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#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.

\n

Default: false\n

", + "smithy.api#xmlName": "ebsOptimized" + } + }, + "IamInstanceProfile": { + "target": "com.amazonaws.ec2#IamInstanceProfileSpecification", + "traits": { + "aws.protocols#ec2QueryName": "IamInstanceProfile", + "smithy.api#documentation": "

The IAM instance profile.

", + "smithy.api#xmlName": "iamInstanceProfile" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#xmlName": "imageId" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type. Only one instance type can be specified.

", + "smithy.api#xmlName": "instanceType" + } + }, + "KernelId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KernelId", + "smithy.api#documentation": "

The ID of the kernel.

", + "smithy.api#xmlName": "kernelId" + } + }, + "KeyName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KeyName", + "smithy.api#documentation": "

The name of the key pair.

", + "smithy.api#xmlName": "keyName" + } + }, + "NetworkInterfaces": { + "target": "com.amazonaws.ec2#InstanceNetworkInterfaceSpecificationList", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceSet", + "smithy.api#documentation": "

The network interfaces. If you specify a network interface, you must specify \n subnet IDs and security group IDs using the network interface.

", + "smithy.api#xmlName": "networkInterfaceSet" + } + }, + "Placement": { + "target": "com.amazonaws.ec2#SpotPlacement", + "traits": { + "aws.protocols#ec2QueryName": "Placement", + "smithy.api#documentation": "

The placement information for the instance.

", + "smithy.api#xmlName": "placement" + } + }, + "RamdiskId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RamdiskId", + "smithy.api#documentation": "

The ID of the RAM disk.

", + "smithy.api#xmlName": "ramdiskId" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet in which to launch the instance.

", + "smithy.api#xmlName": "subnetId" + } + }, + "Monitoring": { + "target": "com.amazonaws.ec2#RunInstancesMonitoringEnabled", + "traits": { + "aws.protocols#ec2QueryName": "Monitoring", + "smithy.api#xmlName": "monitoring" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the launch specification for an instance.

" + } + }, + "com.amazonaws.ec2#LaunchSpecsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SpotFleetLaunchSpecification", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LaunchTemplate": { + "type": "structure", + "members": { + "LaunchTemplateId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateId", + "smithy.api#documentation": "

The ID of the launch template.

", + "smithy.api#xmlName": "launchTemplateId" + } + }, + "LaunchTemplateName": { + "target": "com.amazonaws.ec2#LaunchTemplateName", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateName", + "smithy.api#documentation": "

The name of the launch template.

", + "smithy.api#xmlName": "launchTemplateName" + } + }, + "CreateTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreateTime", + "smithy.api#documentation": "

The time launch template was created.

", + "smithy.api#xmlName": "createTime" + } + }, + "CreatedBy": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CreatedBy", + "smithy.api#documentation": "

The principal that created the launch template.

", + "smithy.api#xmlName": "createdBy" + } + }, + "DefaultVersionNumber": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "DefaultVersionNumber", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The version number of the default version of the launch template.

", + "smithy.api#xmlName": "defaultVersionNumber" + } + }, + "LatestVersionNumber": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "LatestVersionNumber", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The version number of the latest version of the launch template.

", + "smithy.api#xmlName": "latestVersionNumber" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for the launch template.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a launch template.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateAndOverridesResponse": { + "type": "structure", + "members": { + "LaunchTemplateSpecification": { + "target": "com.amazonaws.ec2#FleetLaunchTemplateSpecification", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateSpecification", + "smithy.api#documentation": "

The launch template.

", + "smithy.api#xmlName": "launchTemplateSpecification" + } + }, + "Overrides": { + "target": "com.amazonaws.ec2#FleetLaunchTemplateOverrides", + "traits": { + "aws.protocols#ec2QueryName": "Overrides", + "smithy.api#documentation": "

Any parameters that you specify override the same parameters in the launch\n template.

", + "smithy.api#xmlName": "overrides" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a launch template and overrides.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateAutoRecoveryState": { + "type": "enum", + "members": { + "default": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "default" + } + }, + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + } + } + }, + "com.amazonaws.ec2#LaunchTemplateBlockDeviceMapping": { + "type": "structure", + "members": { + "DeviceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DeviceName", + "smithy.api#documentation": "

The device name.

", + "smithy.api#xmlName": "deviceName" + } + }, + "VirtualName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VirtualName", + "smithy.api#documentation": "

The virtual device name (ephemeralN).

", + "smithy.api#xmlName": "virtualName" + } + }, + "Ebs": { + "target": "com.amazonaws.ec2#LaunchTemplateEbsBlockDevice", + "traits": { + "aws.protocols#ec2QueryName": "Ebs", + "smithy.api#documentation": "

Information about the block device for an EBS volume.

", + "smithy.api#xmlName": "ebs" + } + }, + "NoDevice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NoDevice", + "smithy.api#documentation": "

To omit the device from the block device mapping, specify an empty string.

", + "smithy.api#xmlName": "noDevice" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a block device mapping.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateBlockDeviceMappingList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LaunchTemplateBlockDeviceMapping", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LaunchTemplateBlockDeviceMappingRequest": { + "type": "structure", + "members": { + "DeviceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The device name (for example, /dev/sdh or xvdh).

" + } + }, + "VirtualName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The virtual device name (ephemeralN). Instance store volumes are numbered starting\n from 0. An instance type with 2 available instance store volumes can specify mappings\n for ephemeral0 and ephemeral1. The number of available instance store volumes depends on\n the instance type. After you connect to the instance, you must mount the volume.

" + } + }, + "Ebs": { + "target": "com.amazonaws.ec2#LaunchTemplateEbsBlockDeviceRequest", + "traits": { + "smithy.api#documentation": "

Parameters used to automatically set up EBS volumes when the instance is\n launched.

" + } + }, + "NoDevice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

To omit the device from the block device mapping, specify an empty string.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a block device mapping.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateBlockDeviceMappingRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LaunchTemplateBlockDeviceMappingRequest", + "traits": { + "smithy.api#xmlName": "BlockDeviceMapping" + } + } + }, + "com.amazonaws.ec2#LaunchTemplateCapacityReservationSpecificationRequest": { + "type": "structure", + "members": { + "CapacityReservationPreference": { + "target": "com.amazonaws.ec2#CapacityReservationPreference", + "traits": { + "smithy.api#documentation": "

Indicates the instance's Capacity Reservation preferences. Possible preferences\n include:

\n " + } + }, + "CapacityReservationTarget": { + "target": "com.amazonaws.ec2#CapacityReservationTarget", + "traits": { + "smithy.api#documentation": "

Information about the target Capacity Reservation or Capacity Reservation\n group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an instance's Capacity Reservation targeting option. You can specify only\n one option at a time. Use the CapacityReservationPreference parameter to\n configure the instance to run in On-Demand capacity or to run in any open\n Capacity Reservation that has matching attributes (instance type, platform, Availability\n Zone). Use the CapacityReservationTarget parameter to explicitly target a\n specific Capacity Reservation or a Capacity Reservation group.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateCapacityReservationSpecificationResponse": { + "type": "structure", + "members": { + "CapacityReservationPreference": { + "target": "com.amazonaws.ec2#CapacityReservationPreference", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationPreference", + "smithy.api#documentation": "

Indicates the instance's Capacity Reservation preferences. Possible preferences\n include:

\n ", + "smithy.api#xmlName": "capacityReservationPreference" + } + }, + "CapacityReservationTarget": { + "target": "com.amazonaws.ec2#CapacityReservationTargetResponse", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationTarget", + "smithy.api#documentation": "

Information about the target Capacity Reservation or Capacity Reservation\n group.

", + "smithy.api#xmlName": "capacityReservationTarget" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the Capacity Reservation targeting option.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateConfig": { + "type": "structure", + "members": { + "LaunchTemplateSpecification": { + "target": "com.amazonaws.ec2#FleetLaunchTemplateSpecification", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateSpecification", + "smithy.api#documentation": "

The launch template.

", + "smithy.api#xmlName": "launchTemplateSpecification" + } + }, + "Overrides": { + "target": "com.amazonaws.ec2#LaunchTemplateOverridesList", + "traits": { + "aws.protocols#ec2QueryName": "Overrides", + "smithy.api#documentation": "

Any parameters that you specify override the same parameters in the launch\n template.

", + "smithy.api#xmlName": "overrides" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a launch template and overrides.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LaunchTemplateConfig", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LaunchTemplateCpuOptions": { + "type": "structure", + "members": { + "CoreCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "CoreCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of CPU cores for the instance.

", + "smithy.api#xmlName": "coreCount" + } + }, + "ThreadsPerCore": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "ThreadsPerCore", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of threads per CPU core.

", + "smithy.api#xmlName": "threadsPerCore" + } + }, + "AmdSevSnp": { + "target": "com.amazonaws.ec2#AmdSevSnpSpecification", + "traits": { + "aws.protocols#ec2QueryName": "AmdSevSnp", + "smithy.api#documentation": "

Indicates whether the instance is enabled for \n AMD SEV-SNP.

", + "smithy.api#xmlName": "amdSevSnp" + } + } + }, + "traits": { + "smithy.api#documentation": "

The CPU options for the instance.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateCpuOptionsRequest": { + "type": "structure", + "members": { + "CoreCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of CPU cores for the instance.

" + } + }, + "ThreadsPerCore": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of threads per CPU core. To disable multithreading for the instance,\n specify a value of 1. Otherwise, specify the default value of\n 2.

" + } + }, + "AmdSevSnp": { + "target": "com.amazonaws.ec2#AmdSevSnpSpecification", + "traits": { + "smithy.api#documentation": "

Indicates whether to enable the instance for AMD SEV-SNP. AMD SEV-SNP is supported \n with M6a, R6a, and C6a instance types only.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The CPU options for the instance. Both the core count and threads per core must be\n specified in the request.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateEbsBlockDevice": { + "type": "structure", + "members": { + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Encrypted", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the EBS volume is encrypted.

", + "smithy.api#xmlName": "encrypted" + } + }, + "DeleteOnTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DeleteOnTermination", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the EBS volume is deleted on instance termination.

", + "smithy.api#xmlName": "deleteOnTermination" + } + }, + "Iops": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Iops", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of I/O operations per second (IOPS) that the volume supports.

", + "smithy.api#xmlName": "iops" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.ec2#KmsKeyId", + "traits": { + "aws.protocols#ec2QueryName": "KmsKeyId", + "smithy.api#documentation": "

The ARN of the Key Management Service (KMS) CMK used for encryption.

", + "smithy.api#xmlName": "kmsKeyId" + } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the snapshot.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "VolumeSize": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "VolumeSize", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The size of the volume, in GiB.

", + "smithy.api#xmlName": "volumeSize" + } + }, + "VolumeType": { + "target": "com.amazonaws.ec2#VolumeType", + "traits": { + "aws.protocols#ec2QueryName": "VolumeType", + "smithy.api#documentation": "

The volume type.

", + "smithy.api#xmlName": "volumeType" + } + }, + "Throughput": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Throughput", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The throughput that the volume supports, in MiB/s.

", + "smithy.api#xmlName": "throughput" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a block device for an EBS volume.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateEbsBlockDeviceRequest": { + "type": "structure", + "members": { + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached\n to instances that support Amazon EBS encryption. If you are creating a volume from a\n snapshot, you can't specify an encryption value.

" + } + }, + "DeleteOnTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the EBS volume is deleted on instance termination.

" + } + }, + "Iops": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of I/O operations per second (IOPS). For gp3,\n io1, and io2 volumes, this represents the number of IOPS that\n are provisioned for the volume. For gp2 volumes, this represents the\n baseline performance of the volume and the rate at which the volume accumulates I/O\n credits for bursting.

\n

The following are the supported values for each volume type:

\n \n

For io1 and io2 volumes, we guarantee\n 64,000 IOPS only for Instances built on the\n Nitro System. Other instance families guarantee performance up to\n 32,000 IOPS.

\n

This parameter is supported for io1, io2, and gp3 volumes only. This parameter\n is not supported for gp2, st1, sc1, or standard volumes.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.ec2#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The ARN of the symmetric Key Management Service (KMS) CMK used for encryption.

" + } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "smithy.api#documentation": "

The ID of the snapshot.

" + } + }, + "VolumeSize": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume\n size. The following are the supported volumes sizes for each volume type:

\n " + } + }, + "VolumeType": { + "target": "com.amazonaws.ec2#VolumeType", + "traits": { + "smithy.api#documentation": "

The volume type. For more information, see Amazon EBS volume types in the\n Amazon Elastic Compute Cloud User Guide.

" + } + }, + "Throughput": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The throughput to provision for a gp3 volume, with a maximum of 1,000\n MiB/s.

\n

Valid Range: Minimum value of 125. Maximum value of 1000.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for a block device for an EBS volume.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateElasticInferenceAccelerator": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of elastic inference accelerator. The possible values are eia1.medium,\n eia1.large, and eia1.xlarge.

", + "smithy.api#required": {} + } + }, + "Count": { + "target": "com.amazonaws.ec2#LaunchTemplateElasticInferenceAcceleratorCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of elastic inference accelerators to attach to the instance.

\n

Default: 1

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an elastic inference accelerator.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateElasticInferenceAcceleratorCount": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.ec2#LaunchTemplateElasticInferenceAcceleratorList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LaunchTemplateElasticInferenceAccelerator", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LaunchTemplateElasticInferenceAcceleratorResponse": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The type of elastic inference accelerator. The possible values are eia1.medium,\n eia1.large, and eia1.xlarge.

", + "smithy.api#xmlName": "type" + } + }, + "Count": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Count", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of elastic inference accelerators to attach to the instance.

\n

Default: 1

", + "smithy.api#xmlName": "count" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an elastic inference accelerator.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateElasticInferenceAcceleratorResponseList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LaunchTemplateElasticInferenceAcceleratorResponse", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LaunchTemplateEnclaveOptions": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Enabled", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

If this parameter is set to true, the instance is enabled for Amazon Web Services Nitro\n Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro Enclaves.

", + "smithy.api#xmlName": "enabled" + } + } + }, + "traits": { + "smithy.api#documentation": "

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateEnclaveOptionsRequest": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to\n true.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more\n information, see What is Amazon Web Services Nitro Enclaves?\n in the Amazon Web Services Nitro Enclaves User Guide.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateErrorCode": { + "type": "enum", + "members": { + "LAUNCH_TEMPLATE_ID_DOES_NOT_EXIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "launchTemplateIdDoesNotExist" + } + }, + "LAUNCH_TEMPLATE_ID_MALFORMED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "launchTemplateIdMalformed" + } + }, + "LAUNCH_TEMPLATE_NAME_DOES_NOT_EXIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "launchTemplateNameDoesNotExist" + } + }, + "LAUNCH_TEMPLATE_NAME_MALFORMED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "launchTemplateNameMalformed" + } + }, + "LAUNCH_TEMPLATE_VERSION_DOES_NOT_EXIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "launchTemplateVersionDoesNotExist" + } + }, + "UNEXPECTED_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unexpectedError" + } + } + } + }, + "com.amazonaws.ec2#LaunchTemplateHibernationOptions": { + "type": "structure", + "members": { + "Configured": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Configured", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

If this parameter is set to true, the instance is enabled for\n hibernation; otherwise, it is not enabled for hibernation.

", + "smithy.api#xmlName": "configured" + } + } + }, + "traits": { + "smithy.api#documentation": "

Indicates whether an instance is configured for hibernation.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateHibernationOptionsRequest": { + "type": "structure", + "members": { + "Configured": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

If you set this parameter to true, the instance is enabled for\n hibernation.

\n

Default: false\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Indicates whether the instance is configured for hibernation. This parameter is valid\n only if the instance meets the hibernation\n prerequisites.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateHttpTokensState": { + "type": "enum", + "members": { + "optional": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "optional" + } + }, + "required": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "required" + } + } + } + }, + "com.amazonaws.ec2#LaunchTemplateIamInstanceProfileSpecification": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Arn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the instance profile.

", + "smithy.api#xmlName": "arn" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The name of the instance profile.

", + "smithy.api#xmlName": "name" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an IAM instance profile.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateIamInstanceProfileSpecificationRequest": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the instance profile.

" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the instance profile.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An IAM instance profile.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateId": { + "type": "string" + }, + "com.amazonaws.ec2#LaunchTemplateIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LaunchTemplateId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LaunchTemplateInstanceMaintenanceOptions": { + "type": "structure", + "members": { + "AutoRecovery": { + "target": "com.amazonaws.ec2#LaunchTemplateAutoRecoveryState", + "traits": { + "aws.protocols#ec2QueryName": "AutoRecovery", + "smithy.api#documentation": "

Disables the automatic recovery behavior of your instance or sets it to\n default.

", + "smithy.api#xmlName": "autoRecovery" + } + } + }, + "traits": { + "smithy.api#documentation": "

The maintenance options of your instance.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateInstanceMaintenanceOptionsRequest": { + "type": "structure", + "members": { + "AutoRecovery": { + "target": "com.amazonaws.ec2#LaunchTemplateAutoRecoveryState", + "traits": { + "smithy.api#documentation": "

Disables the automatic recovery behavior of your instance or sets it to default. For\n more information, see Simplified automatic recovery.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The maintenance options of your instance.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateInstanceMarketOptions": { + "type": "structure", + "members": { + "MarketType": { + "target": "com.amazonaws.ec2#MarketType", + "traits": { + "aws.protocols#ec2QueryName": "MarketType", + "smithy.api#documentation": "

The market type.

", + "smithy.api#xmlName": "marketType" + } + }, + "SpotOptions": { + "target": "com.amazonaws.ec2#LaunchTemplateSpotMarketOptions", + "traits": { + "aws.protocols#ec2QueryName": "SpotOptions", + "smithy.api#documentation": "

The options for Spot Instances.

", + "smithy.api#xmlName": "spotOptions" + } + } + }, + "traits": { + "smithy.api#documentation": "

The market (purchasing) option for the instances.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateInstanceMarketOptionsRequest": { + "type": "structure", + "members": { + "MarketType": { + "target": "com.amazonaws.ec2#MarketType", + "traits": { + "smithy.api#documentation": "

The market type.

" + } + }, + "SpotOptions": { + "target": "com.amazonaws.ec2#LaunchTemplateSpotMarketOptionsRequest", + "traits": { + "smithy.api#documentation": "

The options for Spot Instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The market (purchasing) option for the instances.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateInstanceMetadataEndpointState": { + "type": "enum", + "members": { + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + } + } + }, + "com.amazonaws.ec2#LaunchTemplateInstanceMetadataOptions": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataOptionsState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the metadata option changes.

\n

\n pending - The metadata options are being updated and the instance is not\n ready to process metadata traffic with the new selection.

\n

\n applied - The metadata options have been successfully applied on the\n instance.

", + "smithy.api#xmlName": "state" + } + }, + "HttpTokens": { + "target": "com.amazonaws.ec2#LaunchTemplateHttpTokensState", + "traits": { + "aws.protocols#ec2QueryName": "HttpTokens", + "smithy.api#documentation": "

Indicates whether IMDSv2 is optional or required.

\n

\n optional - When IMDSv2 is optional, you can choose to retrieve instance metadata with or without \n a session token in your request. If you retrieve the IAM role credentials \n without a token, the IMDSv1 role credentials are returned. If you retrieve the IAM role credentials \n using a valid session token, the IMDSv2 role credentials are returned.

\n

\n required - When IMDSv2 is required, you must send a session token \n with any instance metadata retrieval requests. In this state, retrieving the IAM role \n credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.

\n

Default: optional\n

", + "smithy.api#xmlName": "httpTokens" + } + }, + "HttpPutResponseHopLimit": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "HttpPutResponseHopLimit", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel.

\n

Default: 1

\n

Possible values: Integers from 1 to 64

", + "smithy.api#xmlName": "httpPutResponseHopLimit" + } + }, + "HttpEndpoint": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataEndpointState", + "traits": { + "aws.protocols#ec2QueryName": "HttpEndpoint", + "smithy.api#documentation": "

Enables or disables the HTTP metadata endpoint on your instances. If the parameter is\n not specified, the default state is enabled.

\n \n

If you specify a value of disabled, you will not be able to access\n your instance metadata.

\n ", + "smithy.api#xmlName": "httpEndpoint" + } + }, + "HttpProtocolIpv6": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataProtocolIpv6", + "traits": { + "aws.protocols#ec2QueryName": "HttpProtocolIpv6", + "smithy.api#documentation": "

Enables or disables the IPv6 endpoint for the instance metadata service.

\n

Default: disabled\n

", + "smithy.api#xmlName": "httpProtocolIpv6" + } + }, + "InstanceMetadataTags": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataTagsState", + "traits": { + "aws.protocols#ec2QueryName": "InstanceMetadataTags", + "smithy.api#documentation": "

Set to enabled to allow access to instance tags from the instance\n metadata. Set to disabled to turn off access to instance tags from the\n instance metadata. For more information, see Work with\n instance tags using the instance metadata.

\n

Default: disabled\n

", + "smithy.api#xmlName": "instanceMetadataTags" + } + } + }, + "traits": { + "smithy.api#documentation": "

The metadata options for the instance. For more information, see Instance metadata and user data in the\n Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateInstanceMetadataOptionsRequest": { + "type": "structure", + "members": { + "HttpTokens": { + "target": "com.amazonaws.ec2#LaunchTemplateHttpTokensState", + "traits": { + "smithy.api#documentation": "

IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to optional\n (in other words, set the use of IMDSv2 to optional) or\n required (in other words, set the use of IMDSv2 to\n required).

\n \n

Default: optional\n

" + } + }, + "HttpPutResponseHopLimit": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel.

\n

Default: 1\n

\n

Possible values: Integers from 1 to 64

" + } + }, + "HttpEndpoint": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataEndpointState", + "traits": { + "smithy.api#documentation": "

Enables or disables the HTTP metadata endpoint on your instances. If the parameter is\n not specified, the default state is enabled.

\n \n

If you specify a value of disabled, you will not be able to access\n your instance metadata.

\n " + } + }, + "HttpProtocolIpv6": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataProtocolIpv6", + "traits": { + "smithy.api#documentation": "

Enables or disables the IPv6 endpoint for the instance metadata service.

\n

Default: disabled\n

" + } + }, + "InstanceMetadataTags": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataTagsState", + "traits": { + "smithy.api#documentation": "

Set to enabled to allow access to instance tags from the instance\n metadata. Set to disabled to turn off access to instance tags from the\n instance metadata. For more information, see Work with\n instance tags using the instance metadata.

\n

Default: disabled\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The metadata options for the instance. For more information, see Instance metadata and user data in the\n Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateInstanceMetadataOptionsState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "applied": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "applied" + } + } + } + }, + "com.amazonaws.ec2#LaunchTemplateInstanceMetadataProtocolIpv6": { + "type": "enum", + "members": { + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + } + } + }, + "com.amazonaws.ec2#LaunchTemplateInstanceMetadataTagsState": { + "type": "enum", + "members": { + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + } + } + }, + "com.amazonaws.ec2#LaunchTemplateInstanceNetworkInterfaceSpecification": { + "type": "structure", + "members": { + "AssociateCarrierIpAddress": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AssociateCarrierIpAddress", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to associate a Carrier IP address with eth0 for a new network\n interface.

\n

Use this option when you launch an instance in a Wavelength Zone and want to associate\n a Carrier IP address with the network interface. For more information about Carrier IP\n addresses, see Carrier IP addresses in the Wavelength Developer\n Guide.

", + "smithy.api#xmlName": "associateCarrierIpAddress" + } + }, + "AssociatePublicIpAddress": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AssociatePublicIpAddress", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to associate a public IPv4 address with eth0 for a new network\n interface.

", + "smithy.api#xmlName": "associatePublicIpAddress" + } + }, + "DeleteOnTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DeleteOnTermination", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the network interface is deleted when the instance is\n terminated.

", + "smithy.api#xmlName": "deleteOnTermination" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the network interface.

", + "smithy.api#xmlName": "description" + } + }, + "DeviceIndex": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "DeviceIndex", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The device index for the network interface attachment.

", + "smithy.api#xmlName": "deviceIndex" + } + }, + "Groups": { + "target": "com.amazonaws.ec2#GroupIdStringList", + "traits": { + "aws.protocols#ec2QueryName": "GroupSet", + "smithy.api#documentation": "

The IDs of one or more security groups.

", + "smithy.api#xmlName": "groupSet" + } + }, + "InterfaceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InterfaceType", + "smithy.api#documentation": "

The type of network interface.

", + "smithy.api#xmlName": "interfaceType" + } + }, + "Ipv6AddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6AddressCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of IPv6 addresses for the network interface.

", + "smithy.api#xmlName": "ipv6AddressCount" + } + }, + "Ipv6Addresses": { + "target": "com.amazonaws.ec2#InstanceIpv6AddressList", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6AddressesSet", + "smithy.api#documentation": "

The IPv6 addresses for the network interface.

", + "smithy.api#xmlName": "ipv6AddressesSet" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

The primary private IPv4 address of the network interface.

", + "smithy.api#xmlName": "privateIpAddress" + } + }, + "PrivateIpAddresses": { + "target": "com.amazonaws.ec2#PrivateIpAddressSpecificationList", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddressesSet", + "smithy.api#documentation": "

One or more private IPv4 addresses.

", + "smithy.api#xmlName": "privateIpAddressesSet" + } + }, + "SecondaryPrivateIpAddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "SecondaryPrivateIpAddressCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of secondary private IPv4 addresses for the network interface.

", + "smithy.api#xmlName": "secondaryPrivateIpAddressCount" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet for the network interface.

", + "smithy.api#xmlName": "subnetId" + } + }, + "NetworkCardIndex": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "NetworkCardIndex", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The index of the network card.

", + "smithy.api#xmlName": "networkCardIndex" + } + }, + "Ipv4Prefixes": { + "target": "com.amazonaws.ec2#Ipv4PrefixListResponse", + "traits": { + "aws.protocols#ec2QueryName": "Ipv4PrefixSet", + "smithy.api#documentation": "

One or more IPv4 prefixes assigned to the network interface.

", + "smithy.api#xmlName": "ipv4PrefixSet" + } + }, + "Ipv4PrefixCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Ipv4PrefixCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of IPv4 prefixes that Amazon Web Services automatically assigned to the network\n interface.

", + "smithy.api#xmlName": "ipv4PrefixCount" + } + }, + "Ipv6Prefixes": { + "target": "com.amazonaws.ec2#Ipv6PrefixListResponse", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6PrefixSet", + "smithy.api#documentation": "

One or more IPv6 prefixes assigned to the network interface.

", + "smithy.api#xmlName": "ipv6PrefixSet" + } + }, + "Ipv6PrefixCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6PrefixCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of IPv6 prefixes that Amazon Web Services automatically assigned to the network\n interface.

", + "smithy.api#xmlName": "ipv6PrefixCount" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a network interface.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateInstanceNetworkInterfaceSpecificationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceNetworkInterfaceSpecification", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LaunchTemplateInstanceNetworkInterfaceSpecificationRequest": { + "type": "structure", + "members": { + "AssociateCarrierIpAddress": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Associates a Carrier IP address with eth0 for a new network interface.

\n

Use this option when you launch an instance in a Wavelength Zone and want to associate\n a Carrier IP address with the network interface. For more information about Carrier IP\n addresses, see Carrier IP addresses in the Wavelength Developer\n Guide.

" + } + }, + "AssociatePublicIpAddress": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Associates a public IPv4 address with eth0 for a new network interface.

" + } + }, + "DeleteOnTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the network interface is deleted when the instance is\n terminated.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the network interface.

" + } + }, + "DeviceIndex": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The device index for the network interface attachment.

" + } + }, + "Groups": { + "target": "com.amazonaws.ec2#SecurityGroupIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of one or more security groups.

", + "smithy.api#xmlName": "SecurityGroupId" + } + }, + "InterfaceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The type of network interface. To create an Elastic Fabric Adapter (EFA), specify\n efa. For more information, see Elastic Fabric Adapter in the\n Amazon Elastic Compute Cloud User Guide.

\n

If you are not creating an EFA, specify interface or omit this\n parameter.

\n

Valid values: interface | efa\n

" + } + }, + "Ipv6AddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of IPv6 addresses to assign to a network interface. Amazon EC2\n automatically selects the IPv6 addresses from the subnet range. You can't use this\n option if specifying specific IPv6 addresses.

" + } + }, + "Ipv6Addresses": { + "target": "com.amazonaws.ec2#InstanceIpv6AddressListRequest", + "traits": { + "smithy.api#documentation": "

One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You\n can't use this option if you're specifying a number of IPv6 addresses.

" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "smithy.api#documentation": "

The ID of the network interface.

" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The primary private IPv4 address of the network interface.

" + } + }, + "PrivateIpAddresses": { + "target": "com.amazonaws.ec2#PrivateIpAddressSpecificationList", + "traits": { + "smithy.api#documentation": "

One or more private IPv4 addresses.

" + } + }, + "SecondaryPrivateIpAddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of secondary private IPv4 addresses to assign to a network\n interface.

" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#documentation": "

The ID of the subnet for the network interface.

" + } + }, + "NetworkCardIndex": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The index of the network card. Some instance types support multiple network cards. The\n primary network interface must be assigned to network card index 0. The default is\n network card index 0.

" + } + }, + "Ipv4Prefixes": { + "target": "com.amazonaws.ec2#Ipv4PrefixList", + "traits": { + "smithy.api#documentation": "

One or more IPv4 prefixes to be assigned to the network interface. You cannot use this\n option if you use the Ipv4PrefixCount option.

", + "smithy.api#xmlName": "Ipv4Prefix" + } + }, + "Ipv4PrefixCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of IPv4 prefixes to be automatically assigned to the network interface. You\n cannot use this option if you use the Ipv4Prefix option.

" + } + }, + "Ipv6Prefixes": { + "target": "com.amazonaws.ec2#Ipv6PrefixList", + "traits": { + "smithy.api#documentation": "

One or more IPv6 prefixes to be assigned to the network interface. You cannot use this\n option if you use the Ipv6PrefixCount option.

", + "smithy.api#xmlName": "Ipv6Prefix" + } + }, + "Ipv6PrefixCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of IPv6 prefixes to be automatically assigned to the network interface. You\n cannot use this option if you use the Ipv6Prefix option.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for a network interface.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateInstanceNetworkInterfaceSpecificationRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceNetworkInterfaceSpecificationRequest", + "traits": { + "smithy.api#xmlName": "InstanceNetworkInterfaceSpecification" + } + } + }, + "com.amazonaws.ec2#LaunchTemplateLicenseConfiguration": { + "type": "structure", + "members": { + "LicenseConfigurationArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LicenseConfigurationArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the license configuration.

", + "smithy.api#xmlName": "licenseConfigurationArn" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a license configuration.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateLicenseConfigurationRequest": { + "type": "structure", + "members": { + "LicenseConfigurationArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the license configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a license configuration.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateLicenseList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LaunchTemplateLicenseConfiguration", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LaunchTemplateLicenseSpecificationListRequest": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LaunchTemplateLicenseConfigurationRequest", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LaunchTemplateName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\(\\)\\.\\-/_]+$" + } + }, + "com.amazonaws.ec2#LaunchTemplateNameStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LaunchTemplateName", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LaunchTemplateOverrides": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type.

", + "smithy.api#xmlName": "instanceType" + } + }, + "SpotPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpotPrice", + "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to \n increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n ", + "smithy.api#xmlName": "spotPrice" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet in which to launch the instances.

", + "smithy.api#xmlName": "subnetId" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone in which to launch the instances.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "WeightedCapacity": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "WeightedCapacity", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of units provided by the specified instance type.

", + "smithy.api#xmlName": "weightedCapacity" + } + }, + "Priority": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "Priority", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The priority for the launch template override. The highest priority is launched\n first.

\n

If OnDemandAllocationStrategy is set to prioritized, Spot Fleet\n uses priority to determine which launch template override to use first in fulfilling\n On-Demand capacity.

\n

If the Spot AllocationStrategy is set to\n capacityOptimizedPrioritized, Spot Fleet uses priority on a best-effort basis\n to determine which launch template override to use in fulfilling Spot capacity, but\n optimizes for capacity first.

\n

Valid values are whole numbers starting at 0. The lower the number, the\n higher the priority. If no number is set, the launch template override has the lowest\n priority. You can set the same priority for different launch template overrides.

", + "smithy.api#xmlName": "priority" + } + }, + "InstanceRequirements": { + "target": "com.amazonaws.ec2#InstanceRequirements", + "traits": { + "aws.protocols#ec2QueryName": "InstanceRequirements", + "smithy.api#documentation": "

The instance requirements. When you specify instance requirements, Amazon EC2 will identify\n instance types with the provided requirements, and then use your On-Demand and Spot\n allocation strategies to launch instances from these instance types, in the same way as\n when you specify a list of instance types.

\n \n

If you specify InstanceRequirements, you can't specify\n InstanceType.

\n ", + "smithy.api#xmlName": "instanceRequirements" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes overrides for a launch template.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateOverridesList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LaunchTemplateOverrides", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LaunchTemplatePlacement": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone of the instance.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "Affinity": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Affinity", + "smithy.api#documentation": "

The affinity setting for the instance on the Dedicated Host.

", + "smithy.api#xmlName": "affinity" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

The name of the placement group for the instance.

", + "smithy.api#xmlName": "groupName" + } + }, + "HostId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "HostId", + "smithy.api#documentation": "

The ID of the Dedicated Host for the instance.

", + "smithy.api#xmlName": "hostId" + } + }, + "Tenancy": { + "target": "com.amazonaws.ec2#Tenancy", + "traits": { + "aws.protocols#ec2QueryName": "Tenancy", + "smithy.api#documentation": "

The tenancy of the instance. An instance with a\n tenancy of dedicated runs on single-tenant hardware.

", + "smithy.api#xmlName": "tenancy" + } + }, + "SpreadDomain": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpreadDomain", + "smithy.api#documentation": "

Reserved for future use.

", + "smithy.api#xmlName": "spreadDomain" + } + }, + "HostResourceGroupArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "HostResourceGroupArn", + "smithy.api#documentation": "

The ARN of the host resource group in which to launch the instances.

", + "smithy.api#xmlName": "hostResourceGroupArn" + } + }, + "PartitionNumber": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "PartitionNumber", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of the partition the instance should launch in. Valid only if the placement\n group strategy is set to partition.

", + "smithy.api#xmlName": "partitionNumber" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#PlacementGroupId", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The Group ID of the placement group. You must specify the Placement Group Group ID to launch an instance in a shared placement\n group.

", + "smithy.api#xmlName": "groupId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the placement of an instance.

" + } + }, + "com.amazonaws.ec2#LaunchTemplatePlacementRequest": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone for the instance.

" + } + }, + "Affinity": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The affinity setting for an instance on a Dedicated Host.

" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#PlacementGroupName", + "traits": { + "smithy.api#documentation": "

The name of the placement group for the instance.

" + } + }, + "HostId": { + "target": "com.amazonaws.ec2#DedicatedHostId", + "traits": { + "smithy.api#documentation": "

The ID of the Dedicated Host for the instance.

" + } + }, + "Tenancy": { + "target": "com.amazonaws.ec2#Tenancy", + "traits": { + "smithy.api#documentation": "

The tenancy of the instance. An instance with a\n tenancy of dedicated runs on single-tenant hardware.

" + } + }, + "SpreadDomain": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } + }, + "HostResourceGroupArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ARN of the host resource group in which to launch the instances. If you specify a\n host resource group ARN, omit the Tenancy parameter or\n set it to host.

" + } + }, + "PartitionNumber": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of the partition the instance should launch in. Valid only if the placement\n group strategy is set to partition.

" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#PlacementGroupId", + "traits": { + "smithy.api#documentation": "

The Group Id of a placement group. You must specify the Placement Group Group Id to launch an instance in a shared placement\n group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the placement of an instance.

" + } + }, + "com.amazonaws.ec2#LaunchTemplatePrivateDnsNameOptions": { + "type": "structure", + "members": { + "HostnameType": { + "target": "com.amazonaws.ec2#HostnameType", + "traits": { + "aws.protocols#ec2QueryName": "HostnameType", + "smithy.api#documentation": "

The type of hostname to assign to an instance.

", + "smithy.api#xmlName": "hostnameType" + } + }, + "EnableResourceNameDnsARecord": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnableResourceNameDnsARecord", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS A\n records.

", + "smithy.api#xmlName": "enableResourceNameDnsARecord" + } + }, + "EnableResourceNameDnsAAAARecord": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnableResourceNameDnsAAAARecord", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA\n records.

", + "smithy.api#xmlName": "enableResourceNameDnsAAAARecord" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the options for instance hostnames.

" + } + }, + "com.amazonaws.ec2#LaunchTemplatePrivateDnsNameOptionsRequest": { + "type": "structure", + "members": { + "HostnameType": { + "target": "com.amazonaws.ec2#HostnameType", + "traits": { + "smithy.api#documentation": "

The type of hostname for Amazon EC2 instances. For IPv4 only subnets, an instance DNS name\n must be based on the instance IPv4 address. For IPv6 native subnets, an instance DNS\n name must be based on the instance ID. For dual-stack subnets, you can specify whether\n DNS names use the instance IPv4 address or the instance ID.

" + } + }, + "EnableResourceNameDnsARecord": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS A\n records.

" + } + }, + "EnableResourceNameDnsAAAARecord": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA\n records.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the options for instance hostnames.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LaunchTemplate", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LaunchTemplateSpecification": { + "type": "structure", + "members": { + "LaunchTemplateId": { + "target": "com.amazonaws.ec2#LaunchTemplateId", + "traits": { + "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify the LaunchTemplateId or the\n LaunchTemplateName, but not both.

" + } + }, + "LaunchTemplateName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the launch template.

\n

You must specify the LaunchTemplateName or the\n LaunchTemplateId, but not both.

" + } + }, + "Version": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The launch template version number, $Latest, or\n $Default.

\n

If the value is $Latest, Amazon EC2 uses the latest version of the launch\n template.

\n

If the value is $Default, Amazon EC2 uses the default version of the\n launch template.

\n

Default: The default version of the launch template.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The launch template to use. You must specify either the launch template ID or launch\n template name in the request, but not both.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateSpotMarketOptions": { + "type": "structure", + "members": { + "MaxPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "MaxPrice", + "smithy.api#documentation": "

The maximum hourly price you're willing to pay for the Spot Instances. We do not\n recommend using this parameter because it can lead to increased interruptions. If you do\n not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your Spot Instances will be interrupted more\n frequently than if you do not specify this parameter.

\n ", + "smithy.api#xmlName": "maxPrice" + } + }, + "SpotInstanceType": { + "target": "com.amazonaws.ec2#SpotInstanceType", + "traits": { + "aws.protocols#ec2QueryName": "SpotInstanceType", + "smithy.api#documentation": "

The Spot Instance request type.

", + "smithy.api#xmlName": "spotInstanceType" + } + }, + "BlockDurationMinutes": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "BlockDurationMinutes", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The required duration for the Spot Instances (also known as Spot blocks), in minutes.\n This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).

", + "smithy.api#xmlName": "blockDurationMinutes" + } + }, + "ValidUntil": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "ValidUntil", + "smithy.api#documentation": "

The end date of the request. For a one-time request, the request remains active until\n all instances launch, the request is canceled, or this date is reached. If the request\n is persistent, it remains active until it is canceled or this date and time is\n reached.

", + "smithy.api#xmlName": "validUntil" + } + }, + "InstanceInterruptionBehavior": { + "target": "com.amazonaws.ec2#InstanceInterruptionBehavior", + "traits": { + "aws.protocols#ec2QueryName": "InstanceInterruptionBehavior", + "smithy.api#documentation": "

The behavior when a Spot Instance is interrupted.

", + "smithy.api#xmlName": "instanceInterruptionBehavior" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options for Spot Instances.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateSpotMarketOptionsRequest": { + "type": "structure", + "members": { + "MaxPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The maximum hourly price you're willing to pay for the Spot Instances. We do not\n recommend using this parameter because it can lead to increased interruptions. If you do\n not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your Spot Instances will be interrupted more\n frequently than if you do not specify this parameter.

\n " + } + }, + "SpotInstanceType": { + "target": "com.amazonaws.ec2#SpotInstanceType", + "traits": { + "smithy.api#documentation": "

The Spot Instance request type.

" + } + }, + "BlockDurationMinutes": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

Deprecated.

" + } + }, + "ValidUntil": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "smithy.api#documentation": "

The end date of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ). Supported only for\n persistent requests.

\n \n

Default: 7 days from the current date

" + } + }, + "InstanceInterruptionBehavior": { + "target": "com.amazonaws.ec2#InstanceInterruptionBehavior", + "traits": { + "smithy.api#documentation": "

The behavior when a Spot Instance is interrupted. The default is\n terminate.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options for Spot Instances.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateTagSpecification": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.ec2#ResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The type of resource to tag.

", + "smithy.api#xmlName": "resourceType" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for the resource.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

The tags specification for the launch template.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateTagSpecificationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LaunchTemplateTagSpecification", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LaunchTemplateTagSpecificationRequest": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.ec2#ResourceType", + "traits": { + "smithy.api#documentation": "

The type of resource to tag.

\n

The Valid Values are all the resource types that can be tagged. However,\n when creating a launch template, you can specify tags for the following resource types\n only: instance | volume | elastic-gpu |\n network-interface | spot-instances-request\n

\n

To tag a resource after it has been created, see CreateTags.

" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the resource.

", + "smithy.api#xmlName": "Tag" + } + } + }, + "traits": { + "smithy.api#documentation": "

The tags specification for the resources that are created during instance\n launch.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateTagSpecificationRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LaunchTemplateTagSpecificationRequest", + "traits": { + "smithy.api#xmlName": "LaunchTemplateTagSpecificationRequest" + } + } + }, + "com.amazonaws.ec2#LaunchTemplateVersion": { + "type": "structure", + "members": { + "LaunchTemplateId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateId", + "smithy.api#documentation": "

The ID of the launch template.

", + "smithy.api#xmlName": "launchTemplateId" + } + }, + "LaunchTemplateName": { + "target": "com.amazonaws.ec2#LaunchTemplateName", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateName", + "smithy.api#documentation": "

The name of the launch template.

", + "smithy.api#xmlName": "launchTemplateName" + } + }, + "VersionNumber": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "VersionNumber", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The version number.

", + "smithy.api#xmlName": "versionNumber" + } + }, + "VersionDescription": { + "target": "com.amazonaws.ec2#VersionDescription", + "traits": { + "aws.protocols#ec2QueryName": "VersionDescription", + "smithy.api#documentation": "

The description for the version.

", + "smithy.api#xmlName": "versionDescription" + } + }, + "CreateTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreateTime", + "smithy.api#documentation": "

The time the version was created.

", + "smithy.api#xmlName": "createTime" + } + }, + "CreatedBy": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CreatedBy", + "smithy.api#documentation": "

The principal that created the version.

", + "smithy.api#xmlName": "createdBy" + } + }, + "DefaultVersion": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DefaultVersion", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the version is the default version.

", + "smithy.api#xmlName": "defaultVersion" + } + }, + "LaunchTemplateData": { + "target": "com.amazonaws.ec2#ResponseLaunchTemplateData", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateData", + "smithy.api#documentation": "

Information about the launch template.

", + "smithy.api#xmlName": "launchTemplateData" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a launch template version.

" + } + }, + "com.amazonaws.ec2#LaunchTemplateVersionSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LaunchTemplateVersion", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LaunchTemplatesMonitoring": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Enabled", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is\n enabled.

", + "smithy.api#xmlName": "enabled" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the monitoring for the instance.

" + } + }, + "com.amazonaws.ec2#LaunchTemplatesMonitoringRequest": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Specify true to enable detailed monitoring. Otherwise, basic monitoring\n is enabled.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the monitoring for the instance.

" + } + }, + "com.amazonaws.ec2#LicenseConfiguration": { + "type": "structure", + "members": { + "LicenseConfigurationArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LicenseConfigurationArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the license configuration.

", + "smithy.api#xmlName": "licenseConfigurationArn" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a license configuration.

" + } + }, + "com.amazonaws.ec2#LicenseConfigurationRequest": { + "type": "structure", + "members": { + "LicenseConfigurationArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the license configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a license configuration.

" + } + }, + "com.amazonaws.ec2#LicenseList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LicenseConfiguration", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LicenseSpecificationListRequest": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LicenseConfigurationRequest", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ListImagesInRecycleBin": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ListImagesInRecycleBinRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ListImagesInRecycleBinResult" + }, + "traits": { + "smithy.api#documentation": "

Lists one or more AMIs that are currently in the Recycle Bin. For more information, \n see Recycle\n Bin in the Amazon EC2 User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Images", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#ListImagesInRecycleBinMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#ListImagesInRecycleBinRequest": { + "type": "structure", + "members": { + "ImageIds": { + "target": "com.amazonaws.ec2#ImageIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the AMIs to list. Omit this parameter to list all of the AMIs that \n are in the Recycle Bin. You can specify up to 20 IDs in a single request.

", + "smithy.api#xmlName": "ImageId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#ListImagesInRecycleBinMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ListImagesInRecycleBinResult": { + "type": "structure", + "members": { + "Images": { + "target": "com.amazonaws.ec2#ImageRecycleBinInfoList", + "traits": { + "aws.protocols#ec2QueryName": "ImageSet", + "smithy.api#documentation": "

Information about the AMIs.

", + "smithy.api#xmlName": "imageSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ListSnapshotsInRecycleBin": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ListSnapshotsInRecycleBinRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ListSnapshotsInRecycleBinResult" + }, + "traits": { + "smithy.api#documentation": "

Lists one or more snapshots that are currently in the Recycle Bin.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Snapshots", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#ListSnapshotsInRecycleBinMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#ListSnapshotsInRecycleBinRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.ec2#ListSnapshotsInRecycleBinMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output. \n\tFor more information, see Pagination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.

" + } + }, + "SnapshotIds": { + "target": "com.amazonaws.ec2#SnapshotIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the snapshots to list. Omit this parameter to list all of the \n snapshots that are in the Recycle Bin.

", + "smithy.api#xmlName": "SnapshotId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ListSnapshotsInRecycleBinResult": { + "type": "structure", + "members": { + "Snapshots": { + "target": "com.amazonaws.ec2#SnapshotRecycleBinInfoList", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotSet", + "smithy.api#documentation": "

Information about the snapshots.

", + "smithy.api#xmlName": "snapshotSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n This value is null when there are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ListingState": { + "type": "enum", + "members": { + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "sold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sold" + } + }, + "cancelled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelled" + } + }, + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + } + } + }, + "com.amazonaws.ec2#ListingStatus": { + "type": "enum", + "members": { + "active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "cancelled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelled" + } + }, + "closed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "closed" + } + } + } + }, + "com.amazonaws.ec2#LoadBalancerArn": { + "type": "string" + }, + "com.amazonaws.ec2#LoadBalancersConfig": { + "type": "structure", + "members": { + "ClassicLoadBalancersConfig": { + "target": "com.amazonaws.ec2#ClassicLoadBalancersConfig", + "traits": { + "aws.protocols#ec2QueryName": "ClassicLoadBalancersConfig", + "smithy.api#documentation": "

The Classic Load Balancers.

", + "smithy.api#xmlName": "classicLoadBalancersConfig" + } + }, + "TargetGroupsConfig": { + "target": "com.amazonaws.ec2#TargetGroupsConfig", + "traits": { + "aws.protocols#ec2QueryName": "TargetGroupsConfig", + "smithy.api#documentation": "

The target groups.

", + "smithy.api#xmlName": "targetGroupsConfig" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the Classic Load Balancers and target groups to attach to a Spot Fleet\n request.

" + } + }, + "com.amazonaws.ec2#LoadPermission": { + "type": "structure", + "members": { + "UserId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UserId", + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#xmlName": "userId" + } + }, + "Group": { + "target": "com.amazonaws.ec2#PermissionGroup", + "traits": { + "aws.protocols#ec2QueryName": "Group", + "smithy.api#documentation": "

The name of the group.

", + "smithy.api#xmlName": "group" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a load permission.

" + } + }, + "com.amazonaws.ec2#LoadPermissionList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LoadPermission", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LoadPermissionListRequest": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LoadPermissionRequest", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LoadPermissionModifications": { + "type": "structure", + "members": { + "Add": { + "target": "com.amazonaws.ec2#LoadPermissionListRequest", + "traits": { + "smithy.api#documentation": "

The load permissions to add.

" + } + }, + "Remove": { + "target": "com.amazonaws.ec2#LoadPermissionListRequest", + "traits": { + "smithy.api#documentation": "

The load permissions to remove.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes modifications to the load permissions of an Amazon FPGA image (AFI).

" + } + }, + "com.amazonaws.ec2#LoadPermissionRequest": { + "type": "structure", + "members": { + "Group": { + "target": "com.amazonaws.ec2#PermissionGroup", + "traits": { + "smithy.api#documentation": "

The name of the group.

" + } + }, + "UserId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a load permission.

" + } + }, + "com.amazonaws.ec2#LocalGateway": { + "type": "structure", + "members": { + "LocalGatewayId": { + "target": "com.amazonaws.ec2#LocalGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayId", + "smithy.api#documentation": "

The ID of the local gateway.

", + "smithy.api#xmlName": "localGatewayId" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutpostArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

", + "smithy.api#xmlName": "outpostArn" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the local gateway.

", + "smithy.api#xmlName": "ownerId" + } + }, + "State": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the local gateway.

", + "smithy.api#xmlName": "state" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the local gateway.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a local gateway.

" + } + }, + "com.amazonaws.ec2#LocalGatewayId": { + "type": "string" + }, + "com.amazonaws.ec2#LocalGatewayIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LocalGatewayId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LocalGatewayMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#LocalGatewayRoute": { + "type": "structure", + "members": { + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationCidrBlock", + "smithy.api#documentation": "

The CIDR block used for destination matches.

", + "smithy.api#xmlName": "destinationCidrBlock" + } + }, + "LocalGatewayVirtualInterfaceGroupId": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupId", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayVirtualInterfaceGroupId", + "smithy.api#documentation": "

The ID of the virtual interface group.

", + "smithy.api#xmlName": "localGatewayVirtualInterfaceGroupId" + } + }, + "Type": { + "target": "com.amazonaws.ec2#LocalGatewayRouteType", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The route type.

", + "smithy.api#xmlName": "type" + } + }, + "State": { + "target": "com.amazonaws.ec2#LocalGatewayRouteState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the route.

", + "smithy.api#xmlName": "state" + } + }, + "LocalGatewayRouteTableId": { + "target": "com.amazonaws.ec2#LocalGatewayRoutetableId", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableId", + "smithy.api#documentation": "

The ID of the local gateway route table.

", + "smithy.api#xmlName": "localGatewayRouteTableId" + } + }, + "LocalGatewayRouteTableArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the local gateway route table.

", + "smithy.api#xmlName": "localGatewayRouteTableArn" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the local gateway route.

", + "smithy.api#xmlName": "ownerId" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet.

", + "smithy.api#xmlName": "subnetId" + } + }, + "CoipPoolId": { + "target": "com.amazonaws.ec2#CoipPoolId", + "traits": { + "aws.protocols#ec2QueryName": "CoipPoolId", + "smithy.api#documentation": "

The ID of the customer-owned address pool.

", + "smithy.api#xmlName": "coipPoolId" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "DestinationPrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "aws.protocols#ec2QueryName": "DestinationPrefixListId", + "smithy.api#documentation": "

\n The ID of the prefix list.\n

", + "smithy.api#xmlName": "destinationPrefixListId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a route for a local gateway route table.

" + } + }, + "com.amazonaws.ec2#LocalGatewayRouteList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LocalGatewayRoute", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LocalGatewayRouteState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "blackhole": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "blackhole" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + } + } + }, + "com.amazonaws.ec2#LocalGatewayRouteTable": { + "type": "structure", + "members": { + "LocalGatewayRouteTableId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableId", + "smithy.api#documentation": "

The ID of the local gateway route table.

", + "smithy.api#xmlName": "localGatewayRouteTableId" + } + }, + "LocalGatewayRouteTableArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the local gateway route table.

", + "smithy.api#xmlName": "localGatewayRouteTableArn" + } + }, + "LocalGatewayId": { + "target": "com.amazonaws.ec2#LocalGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayId", + "smithy.api#documentation": "

The ID of the local gateway.

", + "smithy.api#xmlName": "localGatewayId" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutpostArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

", + "smithy.api#xmlName": "outpostArn" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the local gateway route table.

", + "smithy.api#xmlName": "ownerId" + } + }, + "State": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the local gateway route table.

", + "smithy.api#xmlName": "state" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the local gateway route table.

", + "smithy.api#xmlName": "tagSet" + } + }, + "Mode": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableMode", + "traits": { + "aws.protocols#ec2QueryName": "Mode", + "smithy.api#documentation": "

The mode of the local gateway route table.

", + "smithy.api#xmlName": "mode" + } + }, + "StateReason": { + "target": "com.amazonaws.ec2#StateReason", + "traits": { + "aws.protocols#ec2QueryName": "StateReason", + "smithy.api#documentation": "

Information about the state change.

", + "smithy.api#xmlName": "stateReason" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a local gateway route table.

" + } + }, + "com.amazonaws.ec2#LocalGatewayRouteTableIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LocalGatewayRoutetableId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LocalGatewayRouteTableMode": { + "type": "enum", + "members": { + "direct_vpc_routing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "direct-vpc-routing" + } + }, + "coip": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "coip" + } + } + } + }, + "com.amazonaws.ec2#LocalGatewayRouteTableSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTable", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociation": { + "type": "structure", + "members": { + "LocalGatewayRouteTableVirtualInterfaceGroupAssociationId": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociationId", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableVirtualInterfaceGroupAssociationId", + "smithy.api#documentation": "

The ID of the association.

", + "smithy.api#xmlName": "localGatewayRouteTableVirtualInterfaceGroupAssociationId" + } + }, + "LocalGatewayVirtualInterfaceGroupId": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupId", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayVirtualInterfaceGroupId", + "smithy.api#documentation": "

The ID of the virtual interface group.

", + "smithy.api#xmlName": "localGatewayVirtualInterfaceGroupId" + } + }, + "LocalGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayId", + "smithy.api#documentation": "

The ID of the local gateway.

", + "smithy.api#xmlName": "localGatewayId" + } + }, + "LocalGatewayRouteTableId": { + "target": "com.amazonaws.ec2#LocalGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableId", + "smithy.api#documentation": "

The ID of the local gateway route table.

", + "smithy.api#xmlName": "localGatewayRouteTableId" + } + }, + "LocalGatewayRouteTableArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the local gateway route table for the virtual interface group.

", + "smithy.api#xmlName": "localGatewayRouteTableArn" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the local gateway virtual interface group association.

", + "smithy.api#xmlName": "ownerId" + } + }, + "State": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the association.

", + "smithy.api#xmlName": "state" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the association.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an association between a local gateway route table and a virtual interface group.

" + } + }, + "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociationId": { + "type": "string" + }, + "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociationIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociationId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociation": { + "type": "structure", + "members": { + "LocalGatewayRouteTableVpcAssociationId": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociationId", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableVpcAssociationId", + "smithy.api#documentation": "

The ID of the association.

", + "smithy.api#xmlName": "localGatewayRouteTableVpcAssociationId" + } + }, + "LocalGatewayRouteTableId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableId", + "smithy.api#documentation": "

The ID of the local gateway route table.

", + "smithy.api#xmlName": "localGatewayRouteTableId" + } + }, + "LocalGatewayRouteTableArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the local gateway route table for the association.

", + "smithy.api#xmlName": "localGatewayRouteTableArn" + } + }, + "LocalGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayId", + "smithy.api#documentation": "

The ID of the local gateway.

", + "smithy.api#xmlName": "localGatewayId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the local gateway route table for the association.

", + "smithy.api#xmlName": "ownerId" + } + }, + "State": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the association.

", + "smithy.api#xmlName": "state" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the association.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an association between a local gateway route table and a VPC.

" + } + }, + "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociationId": { + "type": "string" + }, + "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociationIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociationId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LocalGatewayRouteType": { + "type": "enum", + "members": { + "static": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "static" + } + }, + "propagated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "propagated" + } + } + } + }, + "com.amazonaws.ec2#LocalGatewayRoutetableId": { + "type": "string" + }, + "com.amazonaws.ec2#LocalGatewaySet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LocalGateway", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LocalGatewayVirtualInterface": { + "type": "structure", + "members": { + "LocalGatewayVirtualInterfaceId": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayVirtualInterfaceId", + "smithy.api#documentation": "

The ID of the virtual interface.

", + "smithy.api#xmlName": "localGatewayVirtualInterfaceId" + } + }, + "LocalGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayId", + "smithy.api#documentation": "

The ID of the local gateway.

", + "smithy.api#xmlName": "localGatewayId" + } + }, + "Vlan": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Vlan", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The ID of the VLAN.

", + "smithy.api#xmlName": "vlan" + } + }, + "LocalAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LocalAddress", + "smithy.api#documentation": "

The local address.

", + "smithy.api#xmlName": "localAddress" + } + }, + "PeerAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PeerAddress", + "smithy.api#documentation": "

The peer address.

", + "smithy.api#xmlName": "peerAddress" + } + }, + "LocalBgpAsn": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "LocalBgpAsn", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.

", + "smithy.api#xmlName": "localBgpAsn" + } + }, + "PeerBgpAsn": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "PeerBgpAsn", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The peer BGP ASN.

", + "smithy.api#xmlName": "peerBgpAsn" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the local gateway virtual interface.

", + "smithy.api#xmlName": "ownerId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the virtual interface.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a local gateway virtual interface.

" + } + }, + "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroup": { + "type": "structure", + "members": { + "LocalGatewayVirtualInterfaceGroupId": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupId", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayVirtualInterfaceGroupId", + "smithy.api#documentation": "

The ID of the virtual interface group.

", + "smithy.api#xmlName": "localGatewayVirtualInterfaceGroupId" + } + }, + "LocalGatewayVirtualInterfaceIds": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceIdSet", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayVirtualInterfaceIdSet", + "smithy.api#documentation": "

The IDs of the virtual interfaces.

", + "smithy.api#xmlName": "localGatewayVirtualInterfaceIdSet" + } + }, + "LocalGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayId", + "smithy.api#documentation": "

The ID of the local gateway.

", + "smithy.api#xmlName": "localGatewayId" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the local gateway virtual interface group.

", + "smithy.api#xmlName": "ownerId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the virtual interface group.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a local gateway virtual interface group.

" + } + }, + "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupId": { + "type": "string" + }, + "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroup", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LocalGatewayVirtualInterfaceId": { + "type": "string" + }, + "com.amazonaws.ec2#LocalGatewayVirtualInterfaceIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LocalGatewayVirtualInterfaceSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterface", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#LocalStorage": { + "type": "enum", + "members": { + "INCLUDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "included" + } + }, + "REQUIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "required" + } + }, + "EXCLUDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "excluded" + } + } + } + }, + "com.amazonaws.ec2#LocalStorageType": { + "type": "enum", + "members": { + "HDD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hdd" + } + }, + "SSD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ssd" + } + } + } + }, + "com.amazonaws.ec2#LocalStorageTypeSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LocalStorageType", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Location": { + "type": "string" + }, + "com.amazonaws.ec2#LocationType": { + "type": "enum", + "members": { + "region": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "region" + } + }, + "availability_zone": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "availability-zone" + } + }, + "availability_zone_id": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "availability-zone-id" + } + } + } + }, + "com.amazonaws.ec2#LogDestinationType": { + "type": "enum", + "members": { + "cloud_watch_logs": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cloud-watch-logs" + } + }, + "s3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "s3" + } + }, + "kinesis_data_firehose": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "kinesis-data-firehose" + } + } + } + }, + "com.amazonaws.ec2#Long": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.ec2#MaintenanceDetails": { + "type": "structure", + "members": { + "PendingMaintenance": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PendingMaintenance", + "smithy.api#documentation": "

Verify existence of a pending maintenance.

", + "smithy.api#xmlName": "pendingMaintenance" + } + }, + "MaintenanceAutoAppliedAfter": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "MaintenanceAutoAppliedAfter", + "smithy.api#documentation": "

The timestamp after which Amazon Web Services will automatically apply maintenance.

", + "smithy.api#xmlName": "maintenanceAutoAppliedAfter" + } + }, + "LastMaintenanceApplied": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "LastMaintenanceApplied", + "smithy.api#documentation": "

Timestamp of last applied maintenance.

", + "smithy.api#xmlName": "lastMaintenanceApplied" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details for Site-to-Site VPN tunnel endpoint maintenance events.

" + } + }, + "com.amazonaws.ec2#ManagedPrefixList": { + "type": "structure", + "members": { + "PrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListId", + "smithy.api#documentation": "

The ID of the prefix list.

", + "smithy.api#xmlName": "prefixListId" + } + }, + "AddressFamily": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AddressFamily", + "smithy.api#documentation": "

The IP address version.

", + "smithy.api#xmlName": "addressFamily" + } + }, + "State": { + "target": "com.amazonaws.ec2#PrefixListState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the prefix list.

", + "smithy.api#xmlName": "state" + } + }, + "StateMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StateMessage", + "smithy.api#documentation": "

The state message.

", + "smithy.api#xmlName": "stateMessage" + } + }, + "PrefixListArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the prefix list.

", + "smithy.api#xmlName": "prefixListArn" + } + }, + "PrefixListName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListName", + "smithy.api#documentation": "

The name of the prefix list.

", + "smithy.api#xmlName": "prefixListName" + } + }, + "MaxEntries": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MaxEntries", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of entries for the prefix list.

", + "smithy.api#xmlName": "maxEntries" + } + }, + "Version": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "Version", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The version of the prefix list.

", + "smithy.api#xmlName": "version" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for the prefix list.

", + "smithy.api#xmlName": "tagSet" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the owner of the prefix list.

", + "smithy.api#xmlName": "ownerId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a managed prefix list.

" + } + }, + "com.amazonaws.ec2#ManagedPrefixListSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ManagedPrefixList", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#MarketType": { + "type": "enum", + "members": { + "spot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "spot" + } + } + } + }, + "com.amazonaws.ec2#MaxIpv4AddrPerInterface": { + "type": "integer" + }, + "com.amazonaws.ec2#MaxIpv6AddrPerInterface": { + "type": "integer" + }, + "com.amazonaws.ec2#MaxNetworkInterfaces": { + "type": "integer" + }, + "com.amazonaws.ec2#MaxResults": { + "type": "integer" + }, + "com.amazonaws.ec2#MaxResultsParam": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.ec2#MaximumBandwidthInMbps": { + "type": "integer" + }, + "com.amazonaws.ec2#MaximumEfaInterfaces": { + "type": "integer" + }, + "com.amazonaws.ec2#MaximumIops": { + "type": "integer" + }, + "com.amazonaws.ec2#MaximumNetworkCards": { + "type": "integer" + }, + "com.amazonaws.ec2#MaximumThroughputInMBps": { + "type": "double" + }, + "com.amazonaws.ec2#MembershipType": { + "type": "enum", + "members": { + "static": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "static" + } + }, + "igmp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "igmp" + } + } + } + }, + "com.amazonaws.ec2#MemoryGiBPerVCpu": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "Min", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is\n no minimum limit.

", + "smithy.api#xmlName": "min" + } + }, + "Max": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "Max", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is\n no maximum limit.

", + "smithy.api#xmlName": "max" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum amount of memory per vCPU, in GiB.

\n

" + } + }, + "com.amazonaws.ec2#MemoryGiBPerVCpuRequest": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this\n parameter.

" + } + }, + "Max": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this\n parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum amount of memory per vCPU, in GiB.

" + } + }, + "com.amazonaws.ec2#MemoryInfo": { + "type": "structure", + "members": { + "SizeInMiB": { + "target": "com.amazonaws.ec2#MemorySize", + "traits": { + "aws.protocols#ec2QueryName": "SizeInMiB", + "smithy.api#documentation": "

The size of the memory, in MiB.

", + "smithy.api#xmlName": "sizeInMiB" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the memory for the instance type.

" + } + }, + "com.amazonaws.ec2#MemoryMiB": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Min", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum\n limit.

", + "smithy.api#xmlName": "min" + } + }, + "Max": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Max", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum amount of memory, in MiB. If this parameter is not specified, there is no\n maximum limit.

", + "smithy.api#xmlName": "max" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum amount of memory, in MiB.

" + } + }, + "com.amazonaws.ec2#MemoryMiBRequest": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum amount of memory, in MiB. To specify no minimum limit, specify\n 0.

", + "smithy.api#required": {} + } + }, + "Max": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum amount of memory, in MiB. To specify no maximum limit, omit this\n parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum amount of memory, in MiB.

" + } + }, + "com.amazonaws.ec2#MemorySize": { + "type": "long" + }, + "com.amazonaws.ec2#MetricPoint": { + "type": "structure", + "members": { + "StartDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "StartDate", + "smithy.api#documentation": "

The start date for the metric point. The starting date for the metric point. The starting time must be formatted\n as yyyy-mm-ddThh:mm:ss. For example, 2022-06-10T12:00:00.000Z.

", + "smithy.api#xmlName": "startDate" + } + }, + "EndDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "EndDate", + "smithy.api#documentation": "

The end date for the metric point. The ending time must be formatted as yyyy-mm-ddThh:mm:ss. For example, 2022-06-12T12:00:00.000Z.

", + "smithy.api#xmlName": "endDate" + } + }, + "Value": { + "target": "com.amazonaws.ec2#Float", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#xmlName": "value" + } + }, + "Status": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status of the metric point.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#documentation": "

Indicates whether the network was healthy or degraded at a particular point. The value is aggregated from the startDate to the endDate. Currently only five_minutes is supported.

" + } + }, + "com.amazonaws.ec2#MetricPoints": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#MetricPoint", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#MetricType": { + "type": "enum", + "members": { + "aggregate_latency": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "aggregate-latency" + } + } + } + }, + "com.amazonaws.ec2#MillisecondDateTime": { + "type": "timestamp" + }, + "com.amazonaws.ec2#ModifyAddressAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyAddressAttributeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyAddressAttributeResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies an attribute of the specified Elastic IP address. For requirements, see Using reverse DNS for email applications.

" + } + }, + "com.amazonaws.ec2#ModifyAddressAttributeRequest": { + "type": "structure", + "members": { + "AllocationId": { + "target": "com.amazonaws.ec2#AllocationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

[EC2-VPC] The allocation ID.

", + "smithy.api#required": {} + } + }, + "DomainName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The domain name to modify for the IP address.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyAddressAttributeResult": { + "type": "structure", + "members": { + "Address": { + "target": "com.amazonaws.ec2#AddressAttribute", + "traits": { + "aws.protocols#ec2QueryName": "Address", + "smithy.api#documentation": "

Information about the Elastic IP address.

", + "smithy.api#xmlName": "address" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyAvailabilityZoneGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyAvailabilityZoneGroupRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyAvailabilityZoneGroupResult" + }, + "traits": { + "smithy.api#documentation": "

Changes the opt-in status of the Local Zone and Wavelength Zone group for your\n account.

\n

Use \n \t\tDescribeAvailabilityZones to view the value for GroupName.

" + } + }, + "com.amazonaws.ec2#ModifyAvailabilityZoneGroupRequest": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Availability Zone group, Local Zone group, or Wavelength Zone\n group.

", + "smithy.api#required": {} + } + }, + "OptInStatus": { + "target": "com.amazonaws.ec2#ModifyAvailabilityZoneOptInStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Indicates whether you are opted in to the Local Zone group or Wavelength Zone group. The\n only valid value is opted-in. You must contact Amazon Web Services Support to opt out of a Local Zone or Wavelength Zone group.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyAvailabilityZoneGroupResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Is true if the request succeeds, and an error otherwise.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyAvailabilityZoneOptInStatus": { + "type": "enum", + "members": { + "opted_in": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "opted-in" + } + }, + "not_opted_in": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "not-opted-in" + } + } + } + }, + "com.amazonaws.ec2#ModifyCapacityReservation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyCapacityReservationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyCapacityReservationResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies a Capacity Reservation's capacity and the conditions under which it is to be released. You\n\t\t\tcannot change a Capacity Reservation's instance type, EBS optimization, instance store settings,\n\t\t\tplatform, Availability Zone, or instance eligibility. If you need to modify any of these\n\t\t\tattributes, we recommend that you cancel the Capacity Reservation, and then create a new one with\n\t\t\tthe required attributes.

" + } + }, + "com.amazonaws.ec2#ModifyCapacityReservationFleet": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyCapacityReservationFleetRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyCapacityReservationFleetResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies a Capacity Reservation Fleet.

\n

When you modify the total target capacity of a Capacity Reservation Fleet, the Fleet automatically \n\t\t\tcreates new Capacity Reservations, or modifies or cancels existing Capacity Reservations in the Fleet \n\t\t\tto meet the new total target capacity. When you modify the end date for the Fleet, the end dates for \n\t\t\tall of the individual Capacity Reservations in the Fleet are updated accordingly.

" + } + }, + "com.amazonaws.ec2#ModifyCapacityReservationFleetRequest": { + "type": "structure", + "members": { + "CapacityReservationFleetId": { + "target": "com.amazonaws.ec2#CapacityReservationFleetId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Capacity Reservation Fleet to modify.

", + "smithy.api#required": {} + } + }, + "TotalTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of capacity units to be reserved by the Capacity Reservation Fleet. This value, \n\t\t\ttogether with the instance type weights that you assign to each instance type used by the Fleet \n\t\t\tdetermine the number of instances for which the Fleet reserves capacity. Both values are based on \n\t\t\tunits that make sense for your workload. For more information, see Total target capacity \n\t\t\tin the Amazon EC2 User Guide.

" + } + }, + "EndDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "smithy.api#documentation": "

The date and time at which the Capacity Reservation Fleet expires. When the Capacity Reservation \n\t\t\tFleet expires, its state changes to expired and all of the Capacity Reservations in the \n\t\t\tFleet expire.

\n

The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you \n\t\t\tspecify 5/31/2019, 13:30:55, the Capacity Reservation Fleet is guaranteed \n\t\t\tto expire between 13:30:55 and 14:30:55 on 5/31/2019.

\n

You can't specify EndDate and \n\t\t\tRemoveEndDate in the same request.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "RemoveEndDate": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to remove the end date from the Capacity Reservation Fleet. If you remove the \n\t\t\tend date, the Capacity Reservation Fleet does not expire and it remains active until you explicitly \n\t\t\tcancel it using the CancelCapacityReservationFleet action.

\n

You can't specify RemoveEndDate and \n\t\t\tEndDate in the same request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyCapacityReservationFleetResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyCapacityReservationRequest": { + "type": "structure", + "members": { + "CapacityReservationId": { + "target": "com.amazonaws.ec2#CapacityReservationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Capacity Reservation.

", + "smithy.api#required": {} + } + }, + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of instances for which to reserve capacity. The number of instances can't be increased or \n\t\t \tdecreased by more than 1000 in a single request.

" + } + }, + "EndDate": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "smithy.api#documentation": "

The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity\n\t\t\tis released and you can no longer launch instances into it. The Capacity Reservation's state changes to\n\t\t\t\texpired when it reaches its end date and time.

\n

The Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify \n\t\t\t5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.

\n

You must provide an EndDate value if EndDateType is\n\t\t\t\tlimited. Omit EndDate if EndDateType is\n\t\t\t\tunlimited.

" + } + }, + "EndDateType": { + "target": "com.amazonaws.ec2#EndDateType", + "traits": { + "smithy.api#documentation": "

Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end\n\t\t\ttypes:

\n " + } + }, + "Accept": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Reserved. Capacity Reservations you have created are accepted by default.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "AdditionalInfo": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyCapacityReservationResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyClientVpnEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyClientVpnEndpointRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyClientVpnEndpointResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the specified Client VPN endpoint. Modifying the DNS server resets existing client connections.

" + } + }, + "com.amazonaws.ec2#ModifyClientVpnEndpointRequest": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Client VPN endpoint to modify.

", + "smithy.api#required": {} + } + }, + "ServerCertificateArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ARN of the server certificate to be used. The server certificate must be provisioned in \n\t\t\tCertificate Manager (ACM).

" + } + }, + "ConnectionLogOptions": { + "target": "com.amazonaws.ec2#ConnectionLogOptions", + "traits": { + "smithy.api#documentation": "

Information about the client connection logging options.

\n

If you enable client connection logging, data about client connections is sent to a\n\t\t\tCloudwatch Logs log stream. The following information is logged:

\n " + } + }, + "DnsServers": { + "target": "com.amazonaws.ec2#DnsServersOptionsModifyStructure", + "traits": { + "smithy.api#documentation": "

Information about the DNS servers to be used by Client VPN connections. A Client VPN endpoint can have \n\t\t\tup to two DNS servers.

" + } + }, + "VpnPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

\n

Valid Values: 443 | 1194\n

\n

Default Value: 443\n

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A brief description of the Client VPN endpoint.

" + } + }, + "SplitTunnel": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the VPN is split-tunnel.

\n

For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the \n \tClient VPN Administrator Guide.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#ClientVpnSecurityGroupIdSet", + "traits": { + "smithy.api#documentation": "

The IDs of one or more security groups to apply to the target network.

", + "smithy.api#xmlName": "SecurityGroupId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#documentation": "

The ID of the VPC to associate with the Client VPN endpoint.

" + } + }, + "SelfServicePortal": { + "target": "com.amazonaws.ec2#SelfServicePortal", + "traits": { + "smithy.api#documentation": "

Specify whether to enable the self-service portal for the Client VPN endpoint.

" + } + }, + "ClientConnectOptions": { + "target": "com.amazonaws.ec2#ClientConnectOptions", + "traits": { + "smithy.api#documentation": "

The options for managing connection authorization for new client connections.

" + } + }, + "SessionTimeoutHours": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum VPN session duration time in hours.

\n

Valid values: 8 | 10 | 12 | 24\n

\n

Default value: 24\n

" + } + }, + "ClientLoginBannerOptions": { + "target": "com.amazonaws.ec2#ClientLoginBannerOptions", + "traits": { + "smithy.api#documentation": "

Options for enabling a customizable text banner that will be displayed on\n\t\t\tAmazon Web Services provided clients when a VPN session is established.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyClientVpnEndpointResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyDefaultCreditSpecification": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyDefaultCreditSpecificationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyDefaultCreditSpecificationResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the default credit option for CPU usage of burstable performance instances.\n The default credit option is set at the account level per Amazon Web Services Region, and\n is specified per instance family. All new burstable performance instances in the account\n launch using the default credit option.

\n

\n ModifyDefaultCreditSpecification is an asynchronous operation, which\n works at an Amazon Web Services Region level and modifies the credit option for each\n Availability Zone. All zones in a Region are updated within five minutes. But if\n instances are launched during this operation, they might not get the new credit option\n until the zone is updated. To verify whether the update has occurred, you can call\n GetDefaultCreditSpecification and check\n DefaultCreditSpecification for updates.

\n

For more information, see Burstable\n performance instances in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#ModifyDefaultCreditSpecificationRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "InstanceFamily": { + "target": "com.amazonaws.ec2#UnlimitedSupportedInstanceFamily", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The instance family.

", + "smithy.api#required": {} + } + }, + "CpuCredits": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The credit option for CPU usage of the instance family.

\n

Valid Values: standard | unlimited\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyDefaultCreditSpecificationResult": { + "type": "structure", + "members": { + "InstanceFamilyCreditSpecification": { + "target": "com.amazonaws.ec2#InstanceFamilyCreditSpecification", + "traits": { + "aws.protocols#ec2QueryName": "InstanceFamilyCreditSpecification", + "smithy.api#documentation": "

The default credit option for CPU usage of the instance family.

", + "smithy.api#xmlName": "instanceFamilyCreditSpecification" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyEbsDefaultKmsKeyId": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyEbsDefaultKmsKeyIdRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyEbsDefaultKmsKeyIdResult" + }, + "traits": { + "smithy.api#documentation": "

Changes the default KMS key for EBS encryption by default for your account in this Region.

\n

Amazon Web Services creates a unique Amazon Web Services managed KMS key in each Region for use with encryption by default. If\n you change the default KMS key to a symmetric customer managed KMS key, it is used instead of the Amazon Web Services\n managed KMS key. To reset the default KMS key to the Amazon Web Services managed KMS key for EBS, use ResetEbsDefaultKmsKeyId. Amazon EBS does not support asymmetric KMS keys.

\n

If you delete or disable the customer managed KMS key that you specified for use with\n encryption by default, your instances will fail to launch.

\n

For more information, see Amazon EBS encryption\n in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#ModifyEbsDefaultKmsKeyIdRequest": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.ec2#KmsKeyId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption.\n If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is\n specified, the encrypted state must be true.

\n

You can specify the KMS key using any of the following:

\n \n

Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, \n the action can appear to complete, but eventually fails.

\n

Amazon EBS does not support asymmetric KMS keys.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyEbsDefaultKmsKeyIdResult": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KmsKeyId", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the default KMS key for encryption by default.

", + "smithy.api#xmlName": "kmsKeyId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyFleet": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyFleetRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyFleetResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the specified EC2 Fleet.

\n

You can only modify an EC2 Fleet request of type maintain.

\n

While the EC2 Fleet is being modified, it is in the modifying state.

\n

To scale up your EC2 Fleet, increase its target capacity. The EC2 Fleet launches the additional\n Spot Instances according to the allocation strategy for the EC2 Fleet request. If the allocation\n strategy is lowest-price, the EC2 Fleet launches instances using the Spot Instance\n pool with the lowest price. If the allocation strategy is diversified, the\n EC2 Fleet distributes the instances across the Spot Instance pools. If the allocation strategy\n is capacity-optimized, EC2 Fleet launches instances from Spot Instance pools with optimal\n capacity for the number of instances that are launching.

\n

To scale down your EC2 Fleet, decrease its target capacity. First, the EC2 Fleet cancels any open\n requests that exceed the new target capacity. You can request that the EC2 Fleet terminate Spot\n Instances until the size of the fleet no longer exceeds the new target capacity. If the\n allocation strategy is lowest-price, the EC2 Fleet terminates the instances with\n the highest price per unit. If the allocation strategy is capacity-optimized,\n the EC2 Fleet terminates the instances in the Spot Instance pools that have the least available\n Spot Instance capacity. If the allocation strategy is diversified, the EC2 Fleet terminates\n instances across the Spot Instance pools. Alternatively, you can request that the EC2 Fleet keep\n the fleet at its current size, but not replace any Spot Instances that are interrupted or\n that you terminate manually.

\n

If you are finished with your EC2 Fleet for now, but will use it again later, you can set the\n target capacity to 0.

" + } + }, + "com.amazonaws.ec2#ModifyFleetRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ExcessCapacityTerminationPolicy": { + "target": "com.amazonaws.ec2#FleetExcessCapacityTerminationPolicy", + "traits": { + "smithy.api#documentation": "

Indicates whether running instances should be terminated if the total target capacity of\n the EC2 Fleet is decreased below the current size of the EC2 Fleet.

\n

Supported only for fleets of type maintain.

" + } + }, + "LaunchTemplateConfigs": { + "target": "com.amazonaws.ec2#FleetLaunchTemplateConfigListRequest", + "traits": { + "smithy.api#documentation": "

The launch template and overrides.

", + "smithy.api#xmlName": "LaunchTemplateConfig" + } + }, + "FleetId": { + "target": "com.amazonaws.ec2#FleetId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the EC2 Fleet.

", + "smithy.api#required": {} + } + }, + "TargetCapacitySpecification": { + "target": "com.amazonaws.ec2#TargetCapacitySpecificationRequest", + "traits": { + "smithy.api#documentation": "

The size of the EC2 Fleet.

" + } + }, + "Context": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Reserved.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyFleetResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

If the request succeeds, the response returns true. If the request fails,\n no response is returned, and instead an error message is returned.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyFpgaImageAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyFpgaImageAttributeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyFpgaImageAttributeResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the specified attribute of the specified Amazon FPGA Image (AFI).

" + } + }, + "com.amazonaws.ec2#ModifyFpgaImageAttributeRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "FpgaImageId": { + "target": "com.amazonaws.ec2#FpgaImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the AFI.

", + "smithy.api#required": {} + } + }, + "Attribute": { + "target": "com.amazonaws.ec2#FpgaImageAttributeName", + "traits": { + "smithy.api#documentation": "

The name of the attribute.

" + } + }, + "OperationType": { + "target": "com.amazonaws.ec2#OperationType", + "traits": { + "smithy.api#documentation": "

The operation type.

" + } + }, + "UserIds": { + "target": "com.amazonaws.ec2#UserIdStringList", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account IDs. This parameter is valid only when modifying the loadPermission attribute.

", + "smithy.api#xmlName": "UserId" + } + }, + "UserGroups": { + "target": "com.amazonaws.ec2#UserGroupStringList", + "traits": { + "smithy.api#documentation": "

The user groups. This parameter is valid only when modifying the loadPermission attribute.

", + "smithy.api#xmlName": "UserGroup" + } + }, + "ProductCodes": { + "target": "com.amazonaws.ec2#ProductCodeStringList", + "traits": { + "smithy.api#documentation": "

The product codes. After you add a product code to an AFI, it can't be removed.\n\t\t This parameter is valid only when modifying the productCodes attribute.

", + "smithy.api#xmlName": "ProductCode" + } + }, + "LoadPermission": { + "target": "com.amazonaws.ec2#LoadPermissionModifications", + "traits": { + "smithy.api#documentation": "

The load permission for the AFI.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the AFI.

" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A name for the AFI.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyFpgaImageAttributeResult": { + "type": "structure", + "members": { + "FpgaImageAttribute": { + "target": "com.amazonaws.ec2#FpgaImageAttribute", + "traits": { + "aws.protocols#ec2QueryName": "FpgaImageAttribute", + "smithy.api#documentation": "

Information about the attribute.

", + "smithy.api#xmlName": "fpgaImageAttribute" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyHosts": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyHostsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyHostsResult" + }, + "traits": { + "smithy.api#documentation": "

Modify the auto-placement setting of a Dedicated Host. When auto-placement is enabled,\n any instances that you launch with a tenancy of host but without a specific\n host ID are placed onto any available Dedicated Host in your account that has\n auto-placement enabled. When auto-placement is disabled, you need to provide a host ID\n to have the instance launch onto a specific host. If no host ID is provided, the\n instance is launched onto a suitable host with auto-placement enabled.

\n

You can also use this API action to modify a Dedicated Host to support either multiple\n instance types in an instance family, or to support a specific instance type\n only.

" + } + }, + "com.amazonaws.ec2#ModifyHostsRequest": { + "type": "structure", + "members": { + "AutoPlacement": { + "target": "com.amazonaws.ec2#AutoPlacement", + "traits": { + "aws.protocols#ec2QueryName": "AutoPlacement", + "smithy.api#documentation": "

Specify whether to enable or disable auto-placement.

", + "smithy.api#xmlName": "autoPlacement" + } + }, + "HostIds": { + "target": "com.amazonaws.ec2#RequestHostIdList", + "traits": { + "aws.protocols#ec2QueryName": "HostId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the Dedicated Hosts to modify.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "hostId" + } + }, + "HostRecovery": { + "target": "com.amazonaws.ec2#HostRecovery", + "traits": { + "smithy.api#documentation": "

Indicates whether to enable or disable host recovery for the Dedicated Host. For more\n information, see Host recovery\n in the Amazon EC2 User Guide.

" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Specifies the instance type to be supported by the Dedicated Host. Specify this\n parameter to modify a Dedicated Host to support only a specific instance type.

\n

If you want to modify a Dedicated Host to support multiple instance types in its\n current instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the\n same request.

" + } + }, + "InstanceFamily": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Specifies the instance family to be supported by the Dedicated Host. Specify this\n parameter to modify a Dedicated Host to support multiple instance types within its\n current instance family.

\n

If you want to modify a Dedicated Host to support a specific instance type only, omit\n this parameter and specify InstanceType instead. You\n cannot specify InstanceFamily and InstanceType in the same request.

" + } + }, + "HostMaintenance": { + "target": "com.amazonaws.ec2#HostMaintenance", + "traits": { + "smithy.api#documentation": "

Indicates whether to enable or disable host maintenance for the Dedicated Host. For\n more information, see Host\n maintenance in the Amazon EC2 User Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyHostsResult": { + "type": "structure", + "members": { + "Successful": { + "target": "com.amazonaws.ec2#ResponseHostIdList", + "traits": { + "aws.protocols#ec2QueryName": "Successful", + "smithy.api#documentation": "

The IDs of the Dedicated Hosts that were successfully modified.

", + "smithy.api#xmlName": "successful" + } + }, + "Unsuccessful": { + "target": "com.amazonaws.ec2#UnsuccessfulItemList", + "traits": { + "aws.protocols#ec2QueryName": "Unsuccessful", + "smithy.api#documentation": "

The IDs of the Dedicated Hosts that could not be modified. Check whether the setting\n you requested can be used.

", + "smithy.api#xmlName": "unsuccessful" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyIdFormat": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyIdFormatRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Modifies the ID format for the specified resource on a per-Region basis. You can\n specify that resources should receive longer IDs (17-character IDs) when they are\n created.

\n

This request can only be used to modify longer ID settings for resource types that\n are within the opt-in period. Resources currently in their opt-in period include:\n bundle | conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | internet-gateway | network-acl\n | network-acl-association | network-interface |\n network-interface-attachment | prefix-list |\n route-table | route-table-association |\n security-group | subnet |\n subnet-cidr-block-association | vpc |\n vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

\n

This setting applies to the IAM user who makes the request; it does not apply to the\n entire Amazon Web Services account. By default, an IAM user defaults to the same settings as the root user. If\n you're using this action as the root user, then these settings apply to the entire account,\n unless an IAM user explicitly overrides these settings for themselves. For more information,\n see Resource IDs \n in the Amazon Elastic Compute Cloud User Guide.

\n

Resources created with longer IDs are visible to all IAM roles and users, regardless\n of these settings and provided that they have permission to use the relevant\n Describe command for the resource type.

" + } + }, + "com.amazonaws.ec2#ModifyIdFormatRequest": { + "type": "structure", + "members": { + "Resource": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of resource: bundle | conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | internet-gateway | network-acl\n | network-acl-association | network-interface |\n network-interface-attachment | prefix-list |\n route-table | route-table-association |\n security-group | subnet |\n subnet-cidr-block-association | vpc |\n vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

\n

Alternatively, use the all-current option to include all resource types that are\n currently within their opt-in period for longer IDs.

", + "smithy.api#required": {} + } + }, + "UseLongIds": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicate whether the resource should use longer IDs (17-character IDs).

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyIdentityIdFormat": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyIdentityIdFormatRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Modifies the ID format of a resource for a specified IAM user, IAM role, or the root\n user for an account; or all IAM users, IAM roles, and the root user for an account. You can\n specify that resources should receive longer IDs (17-character IDs) when they are created.

\n

This request can only be used to modify longer ID settings for resource types that are\n within the opt-in period. Resources currently in their opt-in period include:\n bundle | conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | internet-gateway | network-acl\n | network-acl-association | network-interface |\n network-interface-attachment | prefix-list |\n route-table | route-table-association |\n security-group | subnet |\n subnet-cidr-block-association | vpc |\n vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

\n

For more information, see Resource IDs in the\n Amazon Elastic Compute Cloud User Guide.

\n

This setting applies to the principal specified in the request; it does not apply to the\n principal that makes the request.

\n

Resources created with longer IDs are visible to all IAM roles and users, regardless of these\n settings and provided that they have permission to use the relevant Describe\n command for the resource type.

" + } + }, + "com.amazonaws.ec2#ModifyIdentityIdFormatRequest": { + "type": "structure", + "members": { + "PrincipalArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrincipalArn", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specify\n all to modify the ID format for all IAM users, IAM roles, and the root user of\n the account.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "principalArn" + } + }, + "Resource": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Resource", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of resource: bundle | conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | internet-gateway | network-acl\n | network-acl-association | network-interface |\n network-interface-attachment | prefix-list |\n route-table | route-table-association |\n security-group | subnet |\n subnet-cidr-block-association | vpc |\n vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

\n

Alternatively, use the all-current option to include all resource types that are\n currently within their opt-in period for longer IDs.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "resource" + } + }, + "UseLongIds": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "UseLongIds", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the resource should use longer IDs (17-character IDs)

", + "smithy.api#required": {}, + "smithy.api#xmlName": "useLongIds" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyImageAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyImageAttributeRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.

\n

To specify the attribute, you can use the Attribute parameter, or one of the following parameters: \n Description, ImdsSupport, or LaunchPermission.

\n

Images with an Amazon Web Services Marketplace product code cannot be made public.

\n

To enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance \n and create an AMI from the instance.

" + } + }, + "com.amazonaws.ec2#ModifyImageAttributeRequest": { + "type": "structure", + "members": { + "Attribute": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the attribute to modify.

\n

Valid values: description | imdsSupport | launchPermission\n

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "smithy.api#documentation": "

A new description for the AMI.

" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#required": {} + } + }, + "LaunchPermission": { + "target": "com.amazonaws.ec2#LaunchPermissionModifications", + "traits": { + "smithy.api#documentation": "

A new launch permission for the AMI.

" + } + }, + "OperationType": { + "target": "com.amazonaws.ec2#OperationType", + "traits": { + "smithy.api#documentation": "

The operation type. \n This parameter can be used only when the Attribute parameter is launchPermission.

" + } + }, + "ProductCodes": { + "target": "com.amazonaws.ec2#ProductCodeStringList", + "traits": { + "smithy.api#documentation": "

Not supported.

", + "smithy.api#xmlName": "ProductCode" + } + }, + "UserGroups": { + "target": "com.amazonaws.ec2#UserGroupStringList", + "traits": { + "smithy.api#documentation": "

The user groups. \n This parameter can be used only when the Attribute parameter is launchPermission.

", + "smithy.api#xmlName": "UserGroup" + } + }, + "UserIds": { + "target": "com.amazonaws.ec2#UserIdStringList", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account IDs. \n This parameter can be used only when the Attribute parameter is launchPermission.

", + "smithy.api#xmlName": "UserId" + } + }, + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The value of the attribute being modified. \n This parameter can be used only when the Attribute parameter is description or imdsSupport.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "OrganizationArns": { + "target": "com.amazonaws.ec2#OrganizationArnStringList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an organization. This parameter can be used only when the Attribute parameter is launchPermission.

", + "smithy.api#xmlName": "OrganizationArn" + } + }, + "OrganizationalUnitArns": { + "target": "com.amazonaws.ec2#OrganizationalUnitArnStringList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an organizational unit (OU). This parameter can be used only when the Attribute parameter is launchPermission.

", + "smithy.api#xmlName": "OrganizationalUnitArn" + } + }, + "ImdsSupport": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "smithy.api#documentation": "

Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances\n launched from this AMI will have HttpTokens automatically set to\n required so that, by default, the instance requires that IMDSv2 is used when\n requesting instance metadata. In addition, HttpPutResponseHopLimit is set to\n 2. For more information, see Configure\n the AMI in the Amazon EC2 User Guide.

\n \n

Do not use this parameter unless your AMI software supports IMDSv2. After you set the value to v2.0, \n you can't undo it. The only way to “reset” your AMI is to create a new AMI from the underlying snapshot.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for ModifyImageAttribute.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyInstanceAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyInstanceAttributeRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Modifies the specified attribute of the specified instance. You can specify only one\n attribute at a time.

\n

\n Note: Using this action to change the security groups\n associated with an elastic network interface (ENI) attached to an instance can\n result in an error if the instance has more than one ENI. To change the security groups\n associated with an ENI attached to an instance that has multiple ENIs, we recommend that\n you use the ModifyNetworkInterfaceAttribute action.

\n

To modify some attributes, the instance must be stopped. For more information, see\n Modify a stopped instance in the\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#ModifyInstanceAttributeRequest": { + "type": "structure", + "members": { + "SourceDestCheck": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "smithy.api#documentation": "

Enable or disable source/destination checks, which ensure that the instance is either\n the source or the destination of any traffic that it receives. If the value is\n true, source/destination checks are enabled; otherwise, they are\n disabled. The default value is true. You must disable source/destination\n checks if the instance runs services such as network address translation, routing, or\n firewalls.

" + } + }, + "Attribute": { + "target": "com.amazonaws.ec2#InstanceAttributeName", + "traits": { + "aws.protocols#ec2QueryName": "Attribute", + "smithy.api#documentation": "

The name of the attribute to modify.

\n \n

You can modify the following attributes only: disableApiTermination |\n instanceType | kernel | ramdisk |\n instanceInitiatedShutdownBehavior | blockDeviceMapping\n | userData | sourceDestCheck | groupSet |\n ebsOptimized | sriovNetSupport |\n enaSupport | nvmeSupport | disableApiStop\n | enclaveOptions\n

\n ", + "smithy.api#xmlName": "attribute" + } + }, + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#InstanceBlockDeviceMappingSpecificationList", + "traits": { + "aws.protocols#ec2QueryName": "BlockDeviceMapping", + "smithy.api#documentation": "

Modifies the DeleteOnTermination attribute for volumes that are currently\n attached. The volume must be owned by the caller. If no value is specified for\n DeleteOnTermination, the default is true and the volume is\n deleted when the instance is terminated.

\n

To add instance store volumes to an Amazon EBS-backed instance, you must add them when\n you launch the instance. For more information, see Update the block device mapping when launching an instance in the\n Amazon EC2 User Guide.

", + "smithy.api#xmlName": "blockDeviceMapping" + } + }, + "DisableApiTermination": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "aws.protocols#ec2QueryName": "DisableApiTermination", + "smithy.api#documentation": "

If the value is true, you can't terminate the instance using the Amazon\n EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot\n Instances.

", + "smithy.api#xmlName": "disableApiTermination" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "EbsOptimized": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "aws.protocols#ec2QueryName": "EbsOptimized", + "smithy.api#documentation": "

Specifies whether the instance is optimized for Amazon EBS I/O. This optimization\n provides dedicated throughput to Amazon EBS and an optimized configuration stack to\n provide optimal EBS I/O performance. This optimization isn't available with all instance\n types. Additional usage charges apply when using an EBS Optimized instance.

", + "smithy.api#xmlName": "ebsOptimized" + } + }, + "EnaSupport": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "aws.protocols#ec2QueryName": "EnaSupport", + "smithy.api#documentation": "

Set to true to enable enhanced networking with ENA for the\n instance.

\n

This option is supported only for HVM instances. Specifying this option with a PV\n instance can make it unreachable.

", + "smithy.api#xmlName": "enaSupport" + } + }, + "Groups": { + "target": "com.amazonaws.ec2#GroupIdStringList", + "traits": { + "smithy.api#documentation": "

Replaces the security groups of the instance with the specified security groups.\n You must specify the ID of at least one security group, even if it's just the default\n security group for the VPC.

", + "smithy.api#xmlName": "GroupId" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "instanceId" + } + }, + "InstanceInitiatedShutdownBehavior": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "InstanceInitiatedShutdownBehavior", + "smithy.api#documentation": "

Specifies whether an instance stops or terminates when you initiate shutdown from the\n instance (using the operating system command for system shutdown).

", + "smithy.api#xmlName": "instanceInitiatedShutdownBehavior" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

Changes the instance type to the specified value. For more information, see Instance\n types in the Amazon EC2 User Guide. If the instance type is\n not valid, the error returned is InvalidInstanceAttributeValue.

", + "smithy.api#xmlName": "instanceType" + } + }, + "Kernel": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "Kernel", + "smithy.api#documentation": "

Changes the instance's kernel to the specified value. We recommend that you use\n PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", + "smithy.api#xmlName": "kernel" + } + }, + "Ramdisk": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "Ramdisk", + "smithy.api#documentation": "

Changes the instance's RAM disk to the specified value. We recommend that you use\n PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", + "smithy.api#xmlName": "ramdisk" + } + }, + "SriovNetSupport": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "SriovNetSupport", + "smithy.api#documentation": "

Set to simple to enable enhanced networking with the Intel 82599 Virtual\n Function interface for the instance.

\n

There is no way to disable enhanced networking with the Intel 82599 Virtual Function\n interface at this time.

\n

This option is supported only for HVM instances. Specifying this option with a PV\n instance can make it unreachable.

", + "smithy.api#xmlName": "sriovNetSupport" + } + }, + "UserData": { + "target": "com.amazonaws.ec2#BlobAttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "UserData", + "smithy.api#documentation": "

Changes the instance's user data to the specified value. If you are using an Amazon Web Services SDK or command line tool, base64-encoding is performed for you, and you\n can load the text from a file. Otherwise, you must provide base64-encoded text.

", + "smithy.api#xmlName": "userData" + } + }, + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#documentation": "

A new value for the attribute. Use only with the kernel,\n ramdisk, userData, disableApiTermination, or\n instanceInitiatedShutdownBehavior attribute.

", + "smithy.api#xmlName": "value" + } + }, + "DisableApiStop": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "smithy.api#documentation": "

Indicates whether an instance is enabled for stop protection. For more information,\n see Stop\n Protection.

\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyInstanceCapacityReservationAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyInstanceCapacityReservationAttributesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyInstanceCapacityReservationAttributesResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the Capacity Reservation settings for a stopped instance. Use this action to configure an\n\t\t\tinstance to target a specific Capacity Reservation, run in any open Capacity Reservation with matching\n\t\t\tattributes, or run On-Demand Instance capacity.

" + } + }, + "com.amazonaws.ec2#ModifyInstanceCapacityReservationAttributesRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance to be modified.

", + "smithy.api#required": {} + } + }, + "CapacityReservationSpecification": { + "target": "com.amazonaws.ec2#CapacityReservationSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Information about the Capacity Reservation targeting option.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyInstanceCapacityReservationAttributesResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyInstanceCreditSpecification": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyInstanceCreditSpecificationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyInstanceCreditSpecificationResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the credit option for CPU usage on a running or stopped burstable performance\n instance. The credit options are standard and\n unlimited.

\n

For more information, see Burstable\n performance instances in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#ModifyInstanceCreditSpecificationRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring\n Idempotency.

" + } + }, + "InstanceCreditSpecifications": { + "target": "com.amazonaws.ec2#InstanceCreditSpecificationListRequest", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Information about the credit option for CPU usage.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "InstanceCreditSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyInstanceCreditSpecificationResult": { + "type": "structure", + "members": { + "SuccessfulInstanceCreditSpecifications": { + "target": "com.amazonaws.ec2#SuccessfulInstanceCreditSpecificationSet", + "traits": { + "aws.protocols#ec2QueryName": "SuccessfulInstanceCreditSpecificationSet", + "smithy.api#documentation": "

Information about the instances whose credit option for CPU usage was successfully\n modified.

", + "smithy.api#xmlName": "successfulInstanceCreditSpecificationSet" + } + }, + "UnsuccessfulInstanceCreditSpecifications": { + "target": "com.amazonaws.ec2#UnsuccessfulInstanceCreditSpecificationSet", + "traits": { + "aws.protocols#ec2QueryName": "UnsuccessfulInstanceCreditSpecificationSet", + "smithy.api#documentation": "

Information about the instances whose credit option for CPU usage was not\n modified.

", + "smithy.api#xmlName": "unsuccessfulInstanceCreditSpecificationSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyInstanceEventStartTime": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyInstanceEventStartTimeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyInstanceEventStartTimeResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the start time for a scheduled Amazon EC2 instance event.

" + } + }, + "com.amazonaws.ec2#ModifyInstanceEventStartTimeRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance with the scheduled event.

", + "smithy.api#required": {} + } + }, + "InstanceEventId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the event whose date and time you are modifying.

", + "smithy.api#required": {} + } + }, + "NotBefore": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The new date and time when the event will take place.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyInstanceEventStartTimeResult": { + "type": "structure", + "members": { + "Event": { + "target": "com.amazonaws.ec2#InstanceStatusEvent", + "traits": { + "aws.protocols#ec2QueryName": "Event", + "smithy.api#documentation": "

Information about the event.

", + "smithy.api#xmlName": "event" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyInstanceEventWindow": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyInstanceEventWindowRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyInstanceEventWindowResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the specified event window.

\n

You can define either a set of time ranges or a cron expression when modifying the event\n window, but not both.

\n

To modify the targets associated with the event window, use the AssociateInstanceEventWindow and DisassociateInstanceEventWindow API.

\n

If Amazon Web Services has already scheduled an event, modifying an event window won't change the time\n of the scheduled event.

\n

For more information, see Define event windows for scheduled\n events in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#ModifyInstanceEventWindowRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the event window.

" + } + }, + "InstanceEventWindowId": { + "target": "com.amazonaws.ec2#InstanceEventWindowId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the event window.

", + "smithy.api#required": {} + } + }, + "TimeRanges": { + "target": "com.amazonaws.ec2#InstanceEventWindowTimeRangeRequestSet", + "traits": { + "smithy.api#documentation": "

The time ranges of the event window.

", + "smithy.api#xmlName": "TimeRange" + } + }, + "CronExpression": { + "target": "com.amazonaws.ec2#InstanceEventWindowCronExpression", + "traits": { + "smithy.api#documentation": "

The cron expression of the event window, for example, * 0-4,20-23 * * 1,5.

\n

Constraints:

\n \n

For more information about cron expressions, see cron on the Wikipedia\n website.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyInstanceEventWindowResult": { + "type": "structure", + "members": { + "InstanceEventWindow": { + "target": "com.amazonaws.ec2#InstanceEventWindow", + "traits": { + "aws.protocols#ec2QueryName": "InstanceEventWindow", + "smithy.api#documentation": "

Information about the event window.

", + "smithy.api#xmlName": "instanceEventWindow" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyInstanceMaintenanceOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyInstanceMaintenanceOptionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyInstanceMaintenanceOptionsResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the recovery behavior of your instance to disable simplified automatic\n recovery or set the recovery behavior to default. The default configuration will not\n enable simplified automatic recovery for an unsupported instance type. For more\n information, see Simplified automatic recovery.

" + } + }, + "com.amazonaws.ec2#ModifyInstanceMaintenanceOptionsRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {} + } + }, + "AutoRecovery": { + "target": "com.amazonaws.ec2#InstanceAutoRecoveryState", + "traits": { + "smithy.api#documentation": "

Disables the automatic recovery behavior of your instance or sets it to\n default.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyInstanceMaintenanceOptionsResult": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "AutoRecovery": { + "target": "com.amazonaws.ec2#InstanceAutoRecoveryState", + "traits": { + "aws.protocols#ec2QueryName": "AutoRecovery", + "smithy.api#documentation": "

Provides information on the current automatic recovery behavior of your\n instance.

", + "smithy.api#xmlName": "autoRecovery" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyInstanceMetadataOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyInstanceMetadataOptionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyInstanceMetadataOptionsResult" + }, + "traits": { + "smithy.api#documentation": "

Modify the instance metadata parameters on a running or stopped instance. When you\n modify the parameters on a stopped instance, they are applied when the instance is\n started. When you modify the parameters on a running instance, the API responds with a\n state of “pending”. After the parameter modifications are successfully applied to the\n instance, the state of the modifications changes from “pending” to “applied” in\n subsequent describe-instances API calls. For more information, see Instance metadata and user data in the\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#ModifyInstanceMetadataOptionsRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {} + } + }, + "HttpTokens": { + "target": "com.amazonaws.ec2#HttpTokensState", + "traits": { + "smithy.api#documentation": "

IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to optional\n (in other words, set the use of IMDSv2 to optional) or\n required (in other words, set the use of IMDSv2 to\n required).

\n \n

Default: optional\n

" + } + }, + "HttpPutResponseHopLimit": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel. If no parameter is specified,\n the existing state is maintained.

\n

Possible values: Integers from 1 to 64

" + } + }, + "HttpEndpoint": { + "target": "com.amazonaws.ec2#InstanceMetadataEndpointState", + "traits": { + "smithy.api#documentation": "

Enables or disables the HTTP metadata endpoint on your instances. If this parameter is\n not specified, the existing state is maintained.

\n

If you specify a value of disabled, you cannot access your instance\n metadata.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + } + }, + "HttpProtocolIpv6": { + "target": "com.amazonaws.ec2#InstanceMetadataProtocolState", + "traits": { + "smithy.api#documentation": "

Enables or disables the IPv6 endpoint for the instance metadata service. This setting\n applies only if you have enabled the HTTP metadata endpoint.

" + } + }, + "InstanceMetadataTags": { + "target": "com.amazonaws.ec2#InstanceMetadataTagsState", + "traits": { + "smithy.api#documentation": "

Set to enabled to allow access to instance tags from the instance\n metadata. Set to disabled to turn off access to instance tags from the\n instance metadata. For more information, see Work with\n instance tags using the instance metadata.

\n

Default: disabled\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyInstanceMetadataOptionsResult": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "InstanceMetadataOptions": { + "target": "com.amazonaws.ec2#InstanceMetadataOptionsResponse", + "traits": { + "aws.protocols#ec2QueryName": "InstanceMetadataOptions", + "smithy.api#documentation": "

The metadata options for the instance.

", + "smithy.api#xmlName": "instanceMetadataOptions" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyInstancePlacement": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyInstancePlacementRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyInstancePlacementResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the placement attributes for a specified instance. You can do the\n following:

\n \n

At least one attribute for affinity, host ID, tenancy, or placement group name must be\n specified in the request. Affinity and tenancy can be modified in the same\n request.

\n

To modify the host ID, tenancy, placement group, or partition for an instance, the\n instance must be in the stopped state.

" + } + }, + "com.amazonaws.ec2#ModifyInstancePlacementRequest": { + "type": "structure", + "members": { + "Affinity": { + "target": "com.amazonaws.ec2#Affinity", + "traits": { + "aws.protocols#ec2QueryName": "Affinity", + "smithy.api#documentation": "

The affinity setting for the instance.

", + "smithy.api#xmlName": "affinity" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#PlacementGroupName", + "traits": { + "smithy.api#documentation": "

The name of the placement group in which to place the instance. For spread placement\n groups, the instance must have a tenancy of default. For cluster and\n partition placement groups, the instance must have a tenancy of default or\n dedicated.

\n

To remove an instance from a placement group, specify an empty string (\"\").

" + } + }, + "HostId": { + "target": "com.amazonaws.ec2#DedicatedHostId", + "traits": { + "aws.protocols#ec2QueryName": "HostId", + "smithy.api#documentation": "

The ID of the Dedicated Host with which to associate the instance.

", + "smithy.api#xmlName": "hostId" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance that you are modifying.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "instanceId" + } + }, + "Tenancy": { + "target": "com.amazonaws.ec2#HostTenancy", + "traits": { + "aws.protocols#ec2QueryName": "Tenancy", + "smithy.api#documentation": "

The tenancy for the instance.

\n \n

For T3 instances, you can't change the tenancy from dedicated to\n host, or from host to dedicated.\n Attempting to make one of these unsupported tenancy changes results in the\n InvalidTenancy error code.

\n ", + "smithy.api#xmlName": "tenancy" + } + }, + "PartitionNumber": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of the partition in which to place the instance. Valid only if the\n placement group strategy is set to partition.

" + } + }, + "HostResourceGroupArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ARN of the host resource group in which to place the instance.

" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#PlacementGroupId", + "traits": { + "smithy.api#documentation": "

The Group Id of a placement group. You must specify the Placement Group Group Id to launch an instance in a shared placement\n group.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyInstancePlacementResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Is true if the request succeeds, and an error otherwise.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyIpam": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyIpamRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyIpamResult" + }, + "traits": { + "smithy.api#documentation": "

Modify the configurations of an IPAM.\n

" + } + }, + "com.amazonaws.ec2#ModifyIpamPool": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyIpamPoolRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyIpamPoolResult" + }, + "traits": { + "smithy.api#documentation": "

Modify the configurations of an IPAM pool.

\n

For more information, see Modify a pool in the Amazon VPC IPAM User Guide.\n

" + } + }, + "com.amazonaws.ec2#ModifyIpamPoolRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the IPAM pool you want to modify.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The description of the IPAM pool you want to modify.

" + } + }, + "AutoImport": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

If true, IPAM will continuously look for resources within the CIDR range of this pool \n and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for\n these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import \n a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently \n marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM \n discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.\n

\n

A locale must be set on the pool for this feature to work.

" + } + }, + "AllocationMinNetmaskLength": { + "target": "com.amazonaws.ec2#IpamNetmaskLength", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. Possible \n netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. The minimum netmask \n length must be less than the maximum netmask length.

" + } + }, + "AllocationMaxNetmaskLength": { + "target": "com.amazonaws.ec2#IpamNetmaskLength", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. Possible \n netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.The maximum netmask \n length must be greater than the minimum netmask length.

" + } + }, + "AllocationDefaultNetmaskLength": { + "target": "com.amazonaws.ec2#IpamNetmaskLength", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.

" + } + }, + "ClearAllocationDefaultNetmaskLength": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Clear the default netmask length allocation rule for this pool.

" + } + }, + "AddAllocationResourceTags": { + "target": "com.amazonaws.ec2#RequestIpamResourceTagList", + "traits": { + "smithy.api#documentation": "

Add tag allocation rules to a pool. For more information about allocation rules, see Create a top-level pool in the Amazon VPC IPAM User Guide.

", + "smithy.api#xmlName": "AddAllocationResourceTag" + } + }, + "RemoveAllocationResourceTags": { + "target": "com.amazonaws.ec2#RequestIpamResourceTagList", + "traits": { + "smithy.api#documentation": "

Remove tag allocation rules from a pool.

", + "smithy.api#xmlName": "RemoveAllocationResourceTag" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyIpamPoolResult": { + "type": "structure", + "members": { + "IpamPool": { + "target": "com.amazonaws.ec2#IpamPool", + "traits": { + "aws.protocols#ec2QueryName": "IpamPool", + "smithy.api#documentation": "

The results of the modification.

", + "smithy.api#xmlName": "ipamPool" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyIpamRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamId": { + "target": "com.amazonaws.ec2#IpamId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the IPAM you want to modify.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The description of the IPAM you want to modify.

" + } + }, + "AddOperatingRegions": { + "target": "com.amazonaws.ec2#AddIpamOperatingRegionSet", + "traits": { + "smithy.api#documentation": "

Choose the operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

\n

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.

", + "smithy.api#xmlName": "AddOperatingRegion" + } + }, + "RemoveOperatingRegions": { + "target": "com.amazonaws.ec2#RemoveIpamOperatingRegionSet", + "traits": { + "smithy.api#documentation": "

The operating Regions to remove.

", + "smithy.api#xmlName": "RemoveOperatingRegion" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyIpamResourceCidr": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyIpamResourceCidrRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyIpamResourceCidrResult" + }, + "traits": { + "smithy.api#documentation": "

Modify a resource CIDR. You can use this action to transfer resource CIDRs between scopes and ignore resource CIDRs that you do not want to manage. If set to false, the resource will not be tracked for overlap, it cannot be auto-imported into a pool, and it will be removed from any pool it has an allocation in.

\n

For more information, see Move resource CIDRs between scopes and Change the monitoring state of resource CIDRs in the Amazon VPC IPAM User Guide.

" + } + }, + "com.amazonaws.ec2#ModifyIpamResourceCidrRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the resource you want to modify.

", + "smithy.api#required": {} + } + }, + "ResourceCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The CIDR of the resource you want to modify.

", + "smithy.api#required": {} + } + }, + "ResourceRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Web Services Region of the resource you want to modify.

", + "smithy.api#required": {} + } + }, + "CurrentIpamScopeId": { + "target": "com.amazonaws.ec2#IpamScopeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the current scope that the resource CIDR is in.

", + "smithy.api#required": {} + } + }, + "DestinationIpamScopeId": { + "target": "com.amazonaws.ec2#IpamScopeId", + "traits": { + "smithy.api#documentation": "

The ID of the scope you want to transfer the resource CIDR to.

" + } + }, + "Monitored": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Determines if the resource is monitored by IPAM. If a resource is monitored, the resource is discovered by IPAM and you can view details about the resource’s CIDR.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyIpamResourceCidrResult": { + "type": "structure", + "members": { + "IpamResourceCidr": { + "target": "com.amazonaws.ec2#IpamResourceCidr", + "traits": { + "aws.protocols#ec2QueryName": "IpamResourceCidr", + "smithy.api#documentation": "

The CIDR of the resource.

", + "smithy.api#xmlName": "ipamResourceCidr" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyIpamResourceDiscovery": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyIpamResourceDiscoveryRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyIpamResourceDiscoveryResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies a resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

" + } + }, + "com.amazonaws.ec2#ModifyIpamResourceDiscoveryRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamResourceDiscoveryId": { + "target": "com.amazonaws.ec2#IpamResourceDiscoveryId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A resource discovery ID.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A resource discovery description.

" + } + }, + "AddOperatingRegions": { + "target": "com.amazonaws.ec2#AddIpamOperatingRegionSet", + "traits": { + "smithy.api#documentation": "

Add operating Regions to the resource discovery. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

", + "smithy.api#xmlName": "AddOperatingRegion" + } + }, + "RemoveOperatingRegions": { + "target": "com.amazonaws.ec2#RemoveIpamOperatingRegionSet", + "traits": { + "smithy.api#documentation": "

Remove operating Regions.

", + "smithy.api#xmlName": "RemoveOperatingRegion" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyIpamResourceDiscoveryResult": { + "type": "structure", + "members": { + "IpamResourceDiscovery": { + "target": "com.amazonaws.ec2#IpamResourceDiscovery", + "traits": { + "aws.protocols#ec2QueryName": "IpamResourceDiscovery", + "smithy.api#documentation": "

A resource discovery.

", + "smithy.api#xmlName": "ipamResourceDiscovery" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyIpamResult": { + "type": "structure", + "members": { + "Ipam": { + "target": "com.amazonaws.ec2#Ipam", + "traits": { + "aws.protocols#ec2QueryName": "Ipam", + "smithy.api#documentation": "

The results of the modification.

", + "smithy.api#xmlName": "ipam" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyIpamScope": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyIpamScopeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyIpamScopeResult" + }, + "traits": { + "smithy.api#documentation": "

Modify an IPAM scope.

" + } + }, + "com.amazonaws.ec2#ModifyIpamScopeRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamScopeId": { + "target": "com.amazonaws.ec2#IpamScopeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the scope you want to modify.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The description of the scope you want to modify.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyIpamScopeResult": { + "type": "structure", + "members": { + "IpamScope": { + "target": "com.amazonaws.ec2#IpamScope", + "traits": { + "aws.protocols#ec2QueryName": "IpamScope", + "smithy.api#documentation": "

The results of the modification.

", + "smithy.api#xmlName": "ipamScope" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyLaunchTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyLaunchTemplateRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyLaunchTemplateResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies a launch template. You can specify which version of the launch template to\n set as the default version. When launching an instance, the default version applies when\n a launch template version is not specified.

" + } + }, + "com.amazonaws.ec2#ModifyLaunchTemplateRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.

\n

Constraint: Maximum 128 ASCII characters.

" + } + }, + "LaunchTemplateId": { + "target": "com.amazonaws.ec2#LaunchTemplateId", + "traits": { + "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify either the LaunchTemplateId or the\n LaunchTemplateName, but not both.

" + } + }, + "LaunchTemplateName": { + "target": "com.amazonaws.ec2#LaunchTemplateName", + "traits": { + "smithy.api#documentation": "

The name of the launch template.

\n

You must specify either the LaunchTemplateName or the\n LaunchTemplateId, but not both.

" + } + }, + "DefaultVersion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The version number of the launch template to set as the default version.

", + "smithy.api#xmlName": "SetDefaultVersion" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyLaunchTemplateResult": { + "type": "structure", + "members": { + "LaunchTemplate": { + "target": "com.amazonaws.ec2#LaunchTemplate", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplate", + "smithy.api#documentation": "

Information about the launch template.

", + "smithy.api#xmlName": "launchTemplate" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyLocalGatewayRoute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyLocalGatewayRouteRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyLocalGatewayRouteResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the specified local gateway route.

" + } + }, + "com.amazonaws.ec2#ModifyLocalGatewayRouteRequest": { + "type": "structure", + "members": { + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The CIDR block used for destination matches. The value that you provide must match the CIDR of an existing route in the table.

" + } + }, + "LocalGatewayRouteTableId": { + "target": "com.amazonaws.ec2#LocalGatewayRoutetableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the local gateway route table.

", + "smithy.api#required": {} + } + }, + "LocalGatewayVirtualInterfaceGroupId": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupId", + "traits": { + "smithy.api#documentation": "

\n The ID of the virtual interface group.\n

" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "smithy.api#documentation": "

The ID of the network interface.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "DestinationPrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "smithy.api#documentation": "

\n The ID of the prefix list. Use a prefix list in place of DestinationCidrBlock. You \n cannot use DestinationPrefixListId and DestinationCidrBlock in the same request.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyLocalGatewayRouteResult": { + "type": "structure", + "members": { + "Route": { + "target": "com.amazonaws.ec2#LocalGatewayRoute", + "traits": { + "aws.protocols#ec2QueryName": "Route", + "smithy.api#documentation": "

Information about the local gateway route table.

", + "smithy.api#xmlName": "route" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyManagedPrefixList": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyManagedPrefixListRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyManagedPrefixListResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the specified managed prefix list.

\n

Adding or removing entries in a prefix list creates a new version of the prefix list.\n Changing the name of the prefix list does not affect the version.

\n

If you specify a current version number that does not match the true current version\n number, the request fails.

" + } + }, + "com.amazonaws.ec2#ModifyManagedPrefixListRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "PrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the prefix list.

", + "smithy.api#required": {} + } + }, + "CurrentVersion": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The current version of the prefix list.

" + } + }, + "PrefixListName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A name for the prefix list.

" + } + }, + "AddEntries": { + "target": "com.amazonaws.ec2#AddPrefixListEntries", + "traits": { + "smithy.api#documentation": "

One or more entries to add to the prefix list.

", + "smithy.api#xmlName": "AddEntry" + } + }, + "RemoveEntries": { + "target": "com.amazonaws.ec2#RemovePrefixListEntries", + "traits": { + "smithy.api#documentation": "

One or more entries to remove from the prefix list.

", + "smithy.api#xmlName": "RemoveEntry" + } + }, + "MaxEntries": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of entries for the prefix list. You cannot modify the entries \n of a prefix list and modify the size of a prefix list at the same time.

\n

If any of the resources that reference the prefix list cannot support the new\n maximum size, the modify operation fails. Check the state message for the IDs of \n the first ten resources that do not support the new maximum size.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyManagedPrefixListResult": { + "type": "structure", + "members": { + "PrefixList": { + "target": "com.amazonaws.ec2#ManagedPrefixList", + "traits": { + "aws.protocols#ec2QueryName": "PrefixList", + "smithy.api#documentation": "

Information about the prefix list.

", + "smithy.api#xmlName": "prefixList" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyNetworkInterfaceAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyNetworkInterfaceAttributeRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Modifies the specified network interface attribute. You can specify only one\n attribute at a time. You can use this action to attach and detach security groups from\n an existing EC2 instance.

" + } + }, + "com.amazonaws.ec2#ModifyNetworkInterfaceAttributeRequest": { + "type": "structure", + "members": { + "Attachment": { + "target": "com.amazonaws.ec2#NetworkInterfaceAttachmentChanges", + "traits": { + "aws.protocols#ec2QueryName": "Attachment", + "smithy.api#documentation": "

Information about the interface attachment. If modifying the delete on\n\t\t\t\ttermination attribute, you must specify the ID of the interface\n\t\t\tattachment.

", + "smithy.api#xmlName": "attachment" + } + }, + "Description": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the network interface.

", + "smithy.api#xmlName": "description" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Groups": { + "target": "com.amazonaws.ec2#SecurityGroupIdStringList", + "traits": { + "smithy.api#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.

", + "smithy.api#xmlName": "SecurityGroupId" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "SourceDestCheck": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "aws.protocols#ec2QueryName": "SourceDestCheck", + "smithy.api#documentation": "

Enable or disable source/destination checks, which ensure that the instance\n is either the source or the destination of any traffic that it receives.\n If the value is true, source/destination checks are enabled;\n otherwise, they are disabled. The default value is true. \n You must disable source/destination checks if the instance runs services \n such as network address translation, routing, or firewalls.

", + "smithy.api#xmlName": "sourceDestCheck" + } + }, + "EnaSrdSpecification": { + "target": "com.amazonaws.ec2#EnaSrdSpecification", + "traits": { + "smithy.api#documentation": "

Updates the ENA Express configuration for the network interface that’s attached to the\n\t\t\tinstance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for ModifyNetworkInterfaceAttribute.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyPrivateDnsNameOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyPrivateDnsNameOptionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyPrivateDnsNameOptionsResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the options for instance hostnames for the specified instance.

" + } + }, + "com.amazonaws.ec2#ModifyPrivateDnsNameOptionsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {} + } + }, + "PrivateDnsHostnameType": { + "target": "com.amazonaws.ec2#HostnameType", + "traits": { + "smithy.api#documentation": "

The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name\n must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name\n must be based on the instance ID. For dual-stack subnets, you can specify whether DNS\n names use the instance IPv4 address or the instance ID.

" + } + }, + "EnableResourceNameDnsARecord": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS A\n records.

" + } + }, + "EnableResourceNameDnsAAAARecord": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA\n records.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyPrivateDnsNameOptionsResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an\n error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyReservedInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyReservedInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyReservedInstancesResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the configuration of your Reserved Instances, such as the Availability Zone, \n instance count, or instance type. The Reserved Instances to be modified must be identical, \n except for Availability Zone, network platform, and instance type.

\n

For more information, see Modifying Reserved\n\t\t\t\tInstances in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#ModifyReservedInstancesRequest": { + "type": "structure", + "members": { + "ReservedInstancesIds": { + "target": "com.amazonaws.ec2#ReservedInstancesIdStringList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the Reserved Instances to modify.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "ReservedInstancesId" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see \n \t\tEnsuring Idempotency.

", + "smithy.api#xmlName": "clientToken" + } + }, + "TargetConfigurations": { + "target": "com.amazonaws.ec2#ReservedInstancesConfigurationList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The configuration settings for the Reserved Instances to modify.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "ReservedInstancesConfigurationSetItemType" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for ModifyReservedInstances.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyReservedInstancesResult": { + "type": "structure", + "members": { + "ReservedInstancesModificationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesModificationId", + "smithy.api#documentation": "

The ID for the modification.

", + "smithy.api#xmlName": "reservedInstancesModificationId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of ModifyReservedInstances.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifySecurityGroupRules": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifySecurityGroupRulesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifySecurityGroupRulesResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the rules of a security group.

" + } + }, + "com.amazonaws.ec2#ModifySecurityGroupRulesRequest": { + "type": "structure", + "members": { + "GroupId": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the security group.

", + "smithy.api#required": {} + } + }, + "SecurityGroupRules": { + "target": "com.amazonaws.ec2#SecurityGroupRuleUpdateList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Information about the security group properties to update.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "SecurityGroupRule" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifySecurityGroupRulesResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifySnapshotAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifySnapshotAttributeRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Adds or removes permission settings for the specified snapshot. You may add or remove\n specified Amazon Web Services account IDs from a snapshot's list of create volume permissions, but you cannot\n do both in a single operation. If you need to both add and remove account IDs for a snapshot,\n you must use multiple operations. You can make up to 500 modifications to a snapshot in a single operation.

\n

Encrypted snapshots and snapshots with Amazon Web Services Marketplace product codes cannot be made\n public. Snapshots encrypted with your default KMS key cannot be shared with other accounts.

\n

For more information about modifying snapshot permissions, see Share a snapshot in the\n Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#ModifySnapshotAttributeRequest": { + "type": "structure", + "members": { + "Attribute": { + "target": "com.amazonaws.ec2#SnapshotAttributeName", + "traits": { + "smithy.api#documentation": "

The snapshot attribute to modify. Only volume creation permissions can be modified.

" + } + }, + "CreateVolumePermission": { + "target": "com.amazonaws.ec2#CreateVolumePermissionModifications", + "traits": { + "smithy.api#documentation": "

A JSON representation of the snapshot attribute modification.

" + } + }, + "GroupNames": { + "target": "com.amazonaws.ec2#GroupNameStringList", + "traits": { + "smithy.api#documentation": "

The group to modify for the snapshot.

", + "smithy.api#xmlName": "UserGroup" + } + }, + "OperationType": { + "target": "com.amazonaws.ec2#OperationType", + "traits": { + "smithy.api#documentation": "

The type of operation to perform to the attribute.

" + } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the snapshot.

", + "smithy.api#required": {} + } + }, + "UserIds": { + "target": "com.amazonaws.ec2#UserIdStringList", + "traits": { + "smithy.api#documentation": "

The account ID to modify for the snapshot.

", + "smithy.api#xmlName": "UserId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifySnapshotTier": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifySnapshotTierRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifySnapshotTierResult" + }, + "traits": { + "smithy.api#documentation": "

Archives an Amazon EBS snapshot. When you archive a snapshot, it is converted to a full \n snapshot that includes all of the blocks of data that were written to the volume at the \n time the snapshot was created, and moved from the standard tier to the archive \n tier. For more information, see Archive Amazon EBS snapshots \n in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#ModifySnapshotTierRequest": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the snapshot.

", + "smithy.api#required": {} + } + }, + "StorageTier": { + "target": "com.amazonaws.ec2#TargetStorageTier", + "traits": { + "smithy.api#documentation": "

The name of the storage tier. You must specify archive.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifySnapshotTierResult": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the snapshot.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "TieringStartTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "TieringStartTime", + "smithy.api#documentation": "

The date and time when the archive process was started.

", + "smithy.api#xmlName": "tieringStartTime" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifySpotFleetRequest": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifySpotFleetRequestRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifySpotFleetRequestResponse" + }, + "traits": { + "smithy.api#documentation": "

Modifies the specified Spot Fleet request.

\n

You can only modify a Spot Fleet request of type maintain.

\n

While the Spot Fleet request is being modified, it is in the modifying\n state.

\n

To scale up your Spot Fleet, increase its target capacity. The Spot Fleet launches the\n additional Spot Instances according to the allocation strategy for the Spot Fleet\n request. If the allocation strategy is lowestPrice, the Spot Fleet launches\n instances using the Spot Instance pool with the lowest price. If the allocation strategy\n is diversified, the Spot Fleet distributes the instances across the Spot\n Instance pools. If the allocation strategy is capacityOptimized, Spot Fleet\n launches instances from Spot Instance pools with optimal capacity for the number of instances\n that are launching.

\n

To scale down your Spot Fleet, decrease its target capacity. First, the Spot Fleet\n cancels any open requests that exceed the new target capacity. You can request that the\n Spot Fleet terminate Spot Instances until the size of the fleet no longer exceeds the\n new target capacity. If the allocation strategy is lowestPrice, the Spot\n Fleet terminates the instances with the highest price per unit. If the allocation\n strategy is capacityOptimized, the Spot Fleet terminates the instances in\n the Spot Instance pools that have the least available Spot Instance capacity. If the allocation\n strategy is diversified, the Spot Fleet terminates instances across the\n Spot Instance pools. Alternatively, you can request that the Spot Fleet keep the fleet\n at its current size, but not replace any Spot Instances that are interrupted or that you\n terminate manually.

\n

If you are finished with your Spot Fleet for now, but will use it again later, you can\n set the target capacity to 0.

" + } + }, + "com.amazonaws.ec2#ModifySpotFleetRequestRequest": { + "type": "structure", + "members": { + "ExcessCapacityTerminationPolicy": { + "target": "com.amazonaws.ec2#ExcessCapacityTerminationPolicy", + "traits": { + "aws.protocols#ec2QueryName": "ExcessCapacityTerminationPolicy", + "smithy.api#documentation": "

Indicates whether running instances should be terminated if the target capacity\n of the Spot Fleet request is decreased below the current size of the Spot Fleet.

\n

Supported only for fleets of type maintain.

", + "smithy.api#xmlName": "excessCapacityTerminationPolicy" + } + }, + "LaunchTemplateConfigs": { + "target": "com.amazonaws.ec2#LaunchTemplateConfigList", + "traits": { + "smithy.api#documentation": "

The launch template and overrides. You can only use this parameter if you specified a\n launch template (LaunchTemplateConfigs) in your Spot Fleet request. If you\n specified LaunchSpecifications in your Spot Fleet request, then omit this\n parameter.

", + "smithy.api#xmlName": "LaunchTemplateConfig" + } + }, + "SpotFleetRequestId": { + "target": "com.amazonaws.ec2#SpotFleetRequestId", + "traits": { + "aws.protocols#ec2QueryName": "SpotFleetRequestId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Spot Fleet request.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "spotFleetRequestId" + } + }, + "TargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TargetCapacity", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The size of the fleet.

", + "smithy.api#xmlName": "targetCapacity" + } + }, + "OnDemandTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of On-Demand Instances in the fleet.

" + } + }, + "Context": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Reserved.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for ModifySpotFleetRequest.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifySpotFleetRequestResponse": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

If the request succeeds, the response returns true. If the request fails,\n no response is returned, and instead an error message is returned.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of ModifySpotFleetRequest.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifySubnetAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifySubnetAttributeRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Modifies a subnet attribute. You can only modify one attribute at a time.

\n

Use this action to modify subnets on Amazon Web Services Outposts.

\n \n

For more information about Amazon Web Services Outposts, see the following:

\n " + } + }, + "com.amazonaws.ec2#ModifySubnetAttributeRequest": { + "type": "structure", + "members": { + "AssignIpv6AddressOnCreation": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "smithy.api#documentation": "

Specify true to indicate that network interfaces created in the\n specified subnet should be assigned an IPv6 address. This includes a network interface\n that's created when launching an instance into the subnet (the instance therefore\n receives an IPv6 address).

\n

If you enable the IPv6 addressing feature for your subnet, your network interface\n or instance only receives an IPv6 address if it's created using version\n 2016-11-15 or later of the Amazon EC2 API.

" + } + }, + "MapPublicIpOnLaunch": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "smithy.api#documentation": "

Specify true to indicate that network interfaces attached to instances created in the\n specified subnet should be assigned a public IPv4 address.

" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the subnet.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "subnetId" + } + }, + "MapCustomerOwnedIpOnLaunch": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "smithy.api#documentation": "

Specify true to indicate that network interfaces attached to instances created in the\n specified subnet should be assigned a customer-owned IPv4 address.

\n

When this value is true, you must specify the customer-owned IP pool using CustomerOwnedIpv4Pool.

" + } + }, + "CustomerOwnedIpv4Pool": { + "target": "com.amazonaws.ec2#CoipPoolId", + "traits": { + "smithy.api#documentation": "

The customer-owned IPv4 address pool associated with the subnet.

\n

You must set this value when you specify true for MapCustomerOwnedIpOnLaunch.

" + } + }, + "EnableDns64": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "smithy.api#documentation": "

Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet \n should return synthetic IPv6 addresses for IPv4-only destinations.

" + } + }, + "PrivateDnsHostnameTypeOnLaunch": { + "target": "com.amazonaws.ec2#HostnameType", + "traits": { + "smithy.api#documentation": "

The type of hostname to assign to instances in the subnet at launch. For IPv4-only and dual-stack (IPv4 and IPv6) subnets, an\n instance DNS name can be based on the instance IPv4 address (ip-name) or the instance ID (resource-name). For IPv6 only subnets, an instance\n DNS name must be based on the instance ID (resource-name).

" + } + }, + "EnableResourceNameDnsARecordOnLaunch": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS A records.

" + } + }, + "EnableResourceNameDnsAAAARecordOnLaunch": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.

" + } + }, + "EnableLniAtDeviceIndex": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

\n Indicates the device position for local network interfaces in this subnet. For example, \n 1 indicates local network interfaces in this subnet are the secondary \n network interface (eth1). A local network interface cannot be the primary network\n interface (eth0).\n

" + } + }, + "DisableLniAtDeviceIndex": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "smithy.api#documentation": "

\n Specify true to indicate that local network interfaces at the current \n position should be disabled. \n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyTrafficMirrorFilterNetworkServices": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyTrafficMirrorFilterNetworkServicesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyTrafficMirrorFilterNetworkServicesResult" + }, + "traits": { + "smithy.api#documentation": "

Allows or restricts mirroring network services.

\n

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.\n When you no longer want to mirror network services, use RemoveNetworkServices to remove the network services from the Traffic Mirror filter.\n

" + } + }, + "com.amazonaws.ec2#ModifyTrafficMirrorFilterNetworkServicesRequest": { + "type": "structure", + "members": { + "TrafficMirrorFilterId": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Traffic Mirror filter.

", + "smithy.api#required": {} + } + }, + "AddNetworkServices": { + "target": "com.amazonaws.ec2#TrafficMirrorNetworkServiceList", + "traits": { + "smithy.api#documentation": "

The network service, for example Amazon DNS, that you want to mirror.

", + "smithy.api#xmlName": "AddNetworkService" + } + }, + "RemoveNetworkServices": { + "target": "com.amazonaws.ec2#TrafficMirrorNetworkServiceList", + "traits": { + "smithy.api#documentation": "

The network service, for example Amazon DNS, that you no longer want to mirror.

", + "smithy.api#xmlName": "RemoveNetworkService" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyTrafficMirrorFilterNetworkServicesResult": { + "type": "structure", + "members": { + "TrafficMirrorFilter": { + "target": "com.amazonaws.ec2#TrafficMirrorFilter", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorFilter", + "smithy.api#documentation": "

The Traffic Mirror filter that the network service is associated with.

", + "smithy.api#xmlName": "trafficMirrorFilter" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyTrafficMirrorFilterRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyTrafficMirrorFilterRuleRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyTrafficMirrorFilterRuleResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the specified Traffic Mirror rule.

\n

\n DestinationCidrBlock and SourceCidrBlock must both be an IPv4\n range or an IPv6 range.

" + } + }, + "com.amazonaws.ec2#ModifyTrafficMirrorFilterRuleRequest": { + "type": "structure", + "members": { + "TrafficMirrorFilterRuleId": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterRuleIdWithResolver", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Traffic Mirror rule.

", + "smithy.api#required": {} + } + }, + "TrafficDirection": { + "target": "com.amazonaws.ec2#TrafficDirection", + "traits": { + "smithy.api#documentation": "

The type of traffic to assign to the rule.

" + } + }, + "RuleNumber": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given\n direction. The rules are processed in ascending order by rule number.

" + } + }, + "RuleAction": { + "target": "com.amazonaws.ec2#TrafficMirrorRuleAction", + "traits": { + "smithy.api#documentation": "

The action to assign to the rule.

" + } + }, + "DestinationPortRange": { + "target": "com.amazonaws.ec2#TrafficMirrorPortRangeRequest", + "traits": { + "smithy.api#documentation": "

The destination ports that are associated with the Traffic Mirror rule.

" + } + }, + "SourcePortRange": { + "target": "com.amazonaws.ec2#TrafficMirrorPortRangeRequest", + "traits": { + "smithy.api#documentation": "

The port range to assign to the Traffic Mirror rule.

" + } + }, + "Protocol": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The protocol, for example TCP, to assign to the Traffic Mirror rule.

" + } + }, + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The destination CIDR block to assign to the Traffic Mirror rule.

" + } + }, + "SourceCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The source CIDR block to assign to the Traffic Mirror rule.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The description to assign to the Traffic Mirror rule.

" + } + }, + "RemoveFields": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterRuleFieldList", + "traits": { + "smithy.api#documentation": "

The properties that you want to remove from the Traffic Mirror filter rule.

\n

When you remove a property from a Traffic Mirror filter rule, the property is set to the default.

", + "smithy.api#xmlName": "RemoveField" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyTrafficMirrorFilterRuleResult": { + "type": "structure", + "members": { + "TrafficMirrorFilterRule": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterRule", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorFilterRule", + "smithy.api#documentation": "

Modifies a Traffic Mirror rule.

", + "smithy.api#xmlName": "trafficMirrorFilterRule" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyTrafficMirrorSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyTrafficMirrorSessionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyTrafficMirrorSessionResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies a Traffic Mirror session.

" + } + }, + "com.amazonaws.ec2#ModifyTrafficMirrorSessionRequest": { + "type": "structure", + "members": { + "TrafficMirrorSessionId": { + "target": "com.amazonaws.ec2#TrafficMirrorSessionId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Traffic Mirror session.

", + "smithy.api#required": {} + } + }, + "TrafficMirrorTargetId": { + "target": "com.amazonaws.ec2#TrafficMirrorTargetId", + "traits": { + "smithy.api#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": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterId", + "traits": { + "smithy.api#documentation": "

The ID of the Traffic Mirror filter.

" + } + }, + "PacketLength": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#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": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#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.

\n

Valid values are 1-32766.

" + } + }, + "VirtualNetworkId": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The virtual network ID of the Traffic Mirror session.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The description to assign to the Traffic Mirror session.

" + } + }, + "RemoveFields": { + "target": "com.amazonaws.ec2#TrafficMirrorSessionFieldList", + "traits": { + "smithy.api#documentation": "

The properties that you want to remove from the Traffic Mirror session.

\n

When you remove a property from a Traffic Mirror session, the property is set to the default.

", + "smithy.api#xmlName": "RemoveField" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyTrafficMirrorSessionResult": { + "type": "structure", + "members": { + "TrafficMirrorSession": { + "target": "com.amazonaws.ec2#TrafficMirrorSession", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorSession", + "smithy.api#documentation": "

Information about the Traffic Mirror session.

", + "smithy.api#xmlName": "trafficMirrorSession" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyTransitGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyTransitGatewayRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyTransitGatewayResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the specified transit gateway. When you modify a transit gateway, the modified options are applied to new transit gateway attachments only. Your existing transit gateway attachments are not modified.

" + } + }, + "com.amazonaws.ec2#ModifyTransitGatewayOptions": { + "type": "structure", + "members": { + "AddTransitGatewayCidrBlocks": { + "target": "com.amazonaws.ec2#TransitGatewayCidrBlockStringList", + "traits": { + "smithy.api#documentation": "

Adds IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.

" + } + }, + "RemoveTransitGatewayCidrBlocks": { + "target": "com.amazonaws.ec2#TransitGatewayCidrBlockStringList", + "traits": { + "smithy.api#documentation": "

Removes CIDR blocks for the transit gateway.

" + } + }, + "VpnEcmpSupport": { + "target": "com.amazonaws.ec2#VpnEcmpSupportValue", + "traits": { + "smithy.api#documentation": "

Enable or disable Equal Cost Multipath Protocol support.

" + } + }, + "DnsSupport": { + "target": "com.amazonaws.ec2#DnsSupportValue", + "traits": { + "smithy.api#documentation": "

Enable or disable DNS support.

" + } + }, + "AutoAcceptSharedAttachments": { + "target": "com.amazonaws.ec2#AutoAcceptSharedAttachmentsValue", + "traits": { + "smithy.api#documentation": "

Enable or disable automatic acceptance of attachment requests.

" + } + }, + "DefaultRouteTableAssociation": { + "target": "com.amazonaws.ec2#DefaultRouteTableAssociationValue", + "traits": { + "smithy.api#documentation": "

Enable or disable automatic association with the default association route table.

" + } + }, + "AssociationDefaultRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#documentation": "

The ID of the default association route table.

" + } + }, + "DefaultRouteTablePropagation": { + "target": "com.amazonaws.ec2#DefaultRouteTablePropagationValue", + "traits": { + "smithy.api#documentation": "

Enable or disable automatic propagation of routes to the default propagation route table.

" + } + }, + "PropagationDefaultRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#documentation": "

The ID of the default propagation route table.

" + } + }, + "AmazonSideAsn": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

A private Autonomous System Number (ASN) for the Amazon side of a BGP session. \n The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.

\n

The modify ASN operation is not allowed on a transit gateway with active BGP sessions. You must first delete all transit gateway attachments that have BGP configured prior to modifying the ASN on the transit gateway.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The transit gateway options.

" + } + }, + "com.amazonaws.ec2#ModifyTransitGatewayPrefixListReference": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyTransitGatewayPrefixListReferenceRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyTransitGatewayPrefixListReferenceResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies a reference (route) to a prefix list in a specified transit gateway route table.

" + } + }, + "com.amazonaws.ec2#ModifyTransitGatewayPrefixListReferenceRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#required": {} + } + }, + "PrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the prefix list.

", + "smithy.api#required": {} + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#documentation": "

The ID of the attachment to which traffic is routed.

" + } + }, + "Blackhole": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to drop traffic that matches this route.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyTransitGatewayPrefixListReferenceResult": { + "type": "structure", + "members": { + "TransitGatewayPrefixListReference": { + "target": "com.amazonaws.ec2#TransitGatewayPrefixListReference", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayPrefixListReference", + "smithy.api#documentation": "

Information about the prefix list reference.

", + "smithy.api#xmlName": "transitGatewayPrefixListReference" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyTransitGatewayRequest": { + "type": "structure", + "members": { + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The description for the transit gateway.

" + } + }, + "Options": { + "target": "com.amazonaws.ec2#ModifyTransitGatewayOptions", + "traits": { + "smithy.api#documentation": "

The options to modify.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyTransitGatewayResult": { + "type": "structure", + "members": { + "TransitGateway": { + "target": "com.amazonaws.ec2#TransitGateway", + "traits": { + "aws.protocols#ec2QueryName": "TransitGateway", + "smithy.api#documentation": "

Information about the transit gateway.

", + "smithy.api#xmlName": "transitGateway" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyTransitGatewayVpcAttachment": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyTransitGatewayVpcAttachmentRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyTransitGatewayVpcAttachmentResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the specified VPC attachment.

" + } + }, + "com.amazonaws.ec2#ModifyTransitGatewayVpcAttachmentRequest": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#required": {} + } + }, + "AddSubnetIds": { + "target": "com.amazonaws.ec2#TransitGatewaySubnetIdList", + "traits": { + "smithy.api#documentation": "

The IDs of one or more subnets to add. You can specify at most one subnet per Availability Zone.

" + } + }, + "RemoveSubnetIds": { + "target": "com.amazonaws.ec2#TransitGatewaySubnetIdList", + "traits": { + "smithy.api#documentation": "

The IDs of one or more subnets to remove.

" + } + }, + "Options": { + "target": "com.amazonaws.ec2#ModifyTransitGatewayVpcAttachmentRequestOptions", + "traits": { + "smithy.api#documentation": "

The new VPC attachment options.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyTransitGatewayVpcAttachmentRequestOptions": { + "type": "structure", + "members": { + "DnsSupport": { + "target": "com.amazonaws.ec2#DnsSupportValue", + "traits": { + "smithy.api#documentation": "

Enable or disable DNS support. The default is enable.

" + } + }, + "Ipv6Support": { + "target": "com.amazonaws.ec2#Ipv6SupportValue", + "traits": { + "smithy.api#documentation": "

Enable or disable IPv6 support. The default is enable.

" + } + }, + "ApplianceModeSupport": { + "target": "com.amazonaws.ec2#ApplianceModeSupportValue", + "traits": { + "smithy.api#documentation": "

Enable or disable support for appliance mode. If enabled, a traffic flow between a source and destination uses the same Availability Zone for the VPC attachment for the lifetime of that flow. The default is disable.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the options for a VPC attachment.

" + } + }, + "com.amazonaws.ec2#ModifyTransitGatewayVpcAttachmentResult": { + "type": "structure", + "members": { + "TransitGatewayVpcAttachment": { + "target": "com.amazonaws.ec2#TransitGatewayVpcAttachment", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayVpcAttachment", + "smithy.api#documentation": "

Information about the modified attachment.

", + "smithy.api#xmlName": "transitGatewayVpcAttachment" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessEndpointRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessEndpointResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the configuration of the specified Amazon Web Services Verified Access endpoint.

" + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessEndpointEniOptions": { + "type": "structure", + "members": { + "Protocol": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointProtocol", + "traits": { + "smithy.api#documentation": "

The IP protocol.

" + } + }, + "Port": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointPortNumber", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The IP port number.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the options when modifying a Verified Access endpoint with the\n network-interface type.

" + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessEndpointLoadBalancerOptions": { + "type": "structure", + "members": { + "SubnetIds": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessEndpointSubnetIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the subnets.

", + "smithy.api#xmlName": "SubnetId" + } + }, + "Protocol": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointProtocol", + "traits": { + "smithy.api#documentation": "

The IP protocol.

" + } + }, + "Port": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointPortNumber", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The IP port number.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a load balancer when creating an Amazon Web Services Verified Access endpoint using the\n load-balancer type.

" + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessEndpointPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessEndpointPolicyRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessEndpointPolicyResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the specified Amazon Web Services Verified Access endpoint policy.

" + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessEndpointPolicyRequest": { + "type": "structure", + "members": { + "VerifiedAccessEndpointId": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access endpoint.

", + "smithy.api#required": {} + } + }, + "PolicyEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

The status of the Verified Access policy.

", + "smithy.api#required": {} + } + }, + "PolicyDocument": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Verified Access policy document.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessEndpointPolicyResult": { + "type": "structure", + "members": { + "PolicyEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "PolicyEnabled", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

The status of the Verified Access policy.

", + "smithy.api#xmlName": "policyEnabled" + } + }, + "PolicyDocument": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PolicyDocument", + "smithy.api#documentation": "

The Verified Access policy document.

", + "smithy.api#xmlName": "policyDocument" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessEndpointRequest": { + "type": "structure", + "members": { + "VerifiedAccessEndpointId": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access endpoint.

", + "smithy.api#required": {} + } + }, + "VerifiedAccessGroupId": { + "target": "com.amazonaws.ec2#VerifiedAccessGroupId", + "traits": { + "smithy.api#documentation": "

The ID of the Verified Access group.

" + } + }, + "LoadBalancerOptions": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessEndpointLoadBalancerOptions", + "traits": { + "smithy.api#documentation": "

The load balancer details if creating the Verified Access endpoint as\n load-balancertype.

" + } + }, + "NetworkInterfaceOptions": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessEndpointEniOptions", + "traits": { + "smithy.api#documentation": "

The network interface options.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the Verified Access endpoint.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessEndpointResult": { + "type": "structure", + "members": { + "VerifiedAccessEndpoint": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpoint", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessEndpoint", + "smithy.api#documentation": "

The Verified Access endpoint details.

", + "smithy.api#xmlName": "verifiedAccessEndpoint" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessEndpointSubnetIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessGroupRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessGroupResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the specified Amazon Web Services Verified Access group configuration.

" + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessGroupPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessGroupPolicyRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessGroupPolicyResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the specified Amazon Web Services Verified Access group policy.

" + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessGroupPolicyRequest": { + "type": "structure", + "members": { + "VerifiedAccessGroupId": { + "target": "com.amazonaws.ec2#VerifiedAccessGroupId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access group.

", + "smithy.api#required": {} + } + }, + "PolicyEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

The status of the Verified Access policy.

", + "smithy.api#required": {} + } + }, + "PolicyDocument": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Verified Access policy document.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessGroupPolicyResult": { + "type": "structure", + "members": { + "PolicyEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "PolicyEnabled", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

The status of the Verified Access policy.

", + "smithy.api#xmlName": "policyEnabled" + } + }, + "PolicyDocument": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PolicyDocument", + "smithy.api#documentation": "

The Verified Access policy document.

", + "smithy.api#xmlName": "policyDocument" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessGroupRequest": { + "type": "structure", + "members": { + "VerifiedAccessGroupId": { + "target": "com.amazonaws.ec2#VerifiedAccessGroupId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access group.

", + "smithy.api#required": {} + } + }, + "VerifiedAccessInstanceId": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceId", + "traits": { + "smithy.api#documentation": "

The ID of the Verified Access instance.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the Verified Access group.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessGroupResult": { + "type": "structure", + "members": { + "VerifiedAccessGroup": { + "target": "com.amazonaws.ec2#VerifiedAccessGroup", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessGroup", + "smithy.api#documentation": "

Details of Verified Access group.

", + "smithy.api#xmlName": "verifiedAccessGroup" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessInstanceRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessInstanceResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the configuration of the specified Amazon Web Services Verified Access instance.

" + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessInstanceLoggingConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessInstanceLoggingConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessInstanceLoggingConfigurationResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the logging configuration for the specified Amazon Web Services Verified Access instance.

" + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessInstanceLoggingConfigurationRequest": { + "type": "structure", + "members": { + "VerifiedAccessInstanceId": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access instance.

", + "smithy.api#required": {} + } + }, + "AccessLogs": { + "target": "com.amazonaws.ec2#VerifiedAccessLogOptions", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The configuration options for Verified Access instances.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessInstanceLoggingConfigurationResult": { + "type": "structure", + "members": { + "LoggingConfiguration": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceLoggingConfiguration", + "traits": { + "aws.protocols#ec2QueryName": "LoggingConfiguration", + "smithy.api#documentation": "

The logging configuration for the Verified Access instance.

", + "smithy.api#xmlName": "loggingConfiguration" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessInstanceRequest": { + "type": "structure", + "members": { + "VerifiedAccessInstanceId": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access instance.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the Verified Access instance.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessInstanceResult": { + "type": "structure", + "members": { + "VerifiedAccessInstance": { + "target": "com.amazonaws.ec2#VerifiedAccessInstance", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessInstance", + "smithy.api#documentation": "

The ID of the Verified Access instance.

", + "smithy.api#xmlName": "verifiedAccessInstance" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessTrustProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessTrustProviderRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessTrustProviderResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the configuration of the specified Amazon Web Services Verified Access trust provider.

" + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessTrustProviderOidcOptions": { + "type": "structure", + "members": { + "Issuer": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The OIDC issuer.

" + } + }, + "AuthorizationEndpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The OIDC authorization endpoint.

" + } + }, + "TokenEndpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The OIDC token endpoint.

" + } + }, + "UserInfoEndpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The OIDC user info endpoint.

" + } + }, + "ClientId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The client identifier.

" + } + }, + "ClientSecret": { + "target": "com.amazonaws.ec2#ClientSecretType", + "traits": { + "smithy.api#documentation": "

The client secret.

" + } + }, + "Scope": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

OpenID Connect (OIDC) scopes are used by an application during authentication to authorize access to a user's details. Each scope returns a specific set of user attributes.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Options for an OpenID Connect-compatible user-identity trust provider.

" + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessTrustProviderRequest": { + "type": "structure", + "members": { + "VerifiedAccessTrustProviderId": { + "target": "com.amazonaws.ec2#VerifiedAccessTrustProviderId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Verified Access trust provider.

", + "smithy.api#required": {} + } + }, + "OidcOptions": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessTrustProviderOidcOptions", + "traits": { + "smithy.api#documentation": "

The options for an OpenID Connect-compatible user-identity trust provider.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the Verified Access trust provider.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVerifiedAccessTrustProviderResult": { + "type": "structure", + "members": { + "VerifiedAccessTrustProvider": { + "target": "com.amazonaws.ec2#VerifiedAccessTrustProvider", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessTrustProvider", + "smithy.api#documentation": "

The ID of the Verified Access trust provider.

", + "smithy.api#xmlName": "verifiedAccessTrustProvider" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVolume": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVolumeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVolumeResult" + }, + "traits": { + "smithy.api#documentation": "

You can modify several parameters of an existing EBS volume, including volume size, volume\n type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance\n type, you might be able to apply these changes without stopping the instance or detaching the\n volume from it. For more information about modifying EBS volumes, see Amazon EBS Elastic Volumes (Linux instances) \n or Amazon EBS Elastic Volumes (Windows instances).

\n

When you complete a resize operation on your volume, you need to extend the volume's\n file-system size to take advantage of the new storage capacity. For more information, see Extend a Linux file system or \n Extend a Windows file system.

\n

You can use CloudWatch Events to check the status of a modification to an EBS volume. For\n information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. You can also track the status of a\n modification using DescribeVolumesModifications. For information\n about tracking status changes using either method, see Monitor the progress of volume modifications.

\n

With previous-generation instance types, resizing an EBS volume might require detaching and\n reattaching the volume or stopping and restarting the instance.

\n

After modifying a volume, you must wait at least six hours and ensure that the volume \n is in the in-use or available state before you can modify the same \n volume. This is sometimes referred to as a cooldown period.

" + } + }, + "com.amazonaws.ec2#ModifyVolumeAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVolumeAttributeRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Modifies a volume attribute.

\n

By default, all I/O operations for the volume are suspended when the data on the volume is\n determined to be potentially inconsistent, to prevent undetectable, latent data corruption.\n The I/O access to the volume can be resumed by first enabling I/O access and then checking the\n data consistency on your volume.

\n

You can change the default behavior to resume I/O operations. We recommend that you change\n this only for boot volumes or for volumes that are stateless or disposable.

" + } + }, + "com.amazonaws.ec2#ModifyVolumeAttributeRequest": { + "type": "structure", + "members": { + "AutoEnableIO": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "smithy.api#documentation": "

Indicates whether the volume should be auto-enabled for I/O operations.

" + } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#VolumeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the volume.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVolumeRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#VolumeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the volume.

", + "smithy.api#required": {} + } + }, + "Size": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The target size of the volume, in GiB. The target volume size must be greater than or\n equal to the existing size of the volume.

\n

The following are the supported volumes sizes for each volume type:

\n \n

Default: The existing size is retained.

" + } + }, + "VolumeType": { + "target": "com.amazonaws.ec2#VolumeType", + "traits": { + "smithy.api#documentation": "

The target EBS volume type of the volume. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.

\n

Default: The existing type is retained.

" + } + }, + "Iops": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The target IOPS rate of the volume. This parameter is valid only for gp3, io1, and io2 volumes.

\n

The following are the supported values for each volume type:

\n \n

Default: The existing value is retained if you keep the same volume type. If you change\n the volume type to io1, io2, or gp3, the default is 3,000.

" + } + }, + "Throughput": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The target throughput of the volume, in MiB/s. This parameter is valid only for gp3 volumes. \n The maximum value is 1,000.

\n

Default: The existing value is retained if the source and target volume type is gp3.\n Otherwise, the default value is 125.

\n

Valid Range: Minimum value of 125. Maximum value of 1000.

" + } + }, + "MultiAttachEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the \n\t\tvolume to up to 16 \n\t\t\tNitro-based instances in the same Availability Zone. This parameter is \n\t\tsupported with io1 and io2 volumes only. For more information, see \n\t\t\n\t\t\tAmazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVolumeResult": { + "type": "structure", + "members": { + "VolumeModification": { + "target": "com.amazonaws.ec2#VolumeModification", + "traits": { + "aws.protocols#ec2QueryName": "VolumeModification", + "smithy.api#documentation": "

Information about the volume modification.

", + "smithy.api#xmlName": "volumeModification" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVpcAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVpcAttributeRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Modifies the specified attribute of the specified VPC.

" + } + }, + "com.amazonaws.ec2#ModifyVpcAttributeRequest": { + "type": "structure", + "members": { + "EnableDnsHostnames": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "smithy.api#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.

\n

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": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "smithy.api#documentation": "

Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to\n\t\t\tthe Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP\n\t\t\taddress at the base of the VPC network range \"plus two\" succeed. If disabled, the Amazon\n\t\t\tprovided DNS service in the VPC that resolves public DNS hostnames to IP addresses is\n\t\t\tnot enabled.

\n

You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute.

" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "vpcId" + } + }, + "EnableNetworkAddressUsageMetrics": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "smithy.api#documentation": "

Indicates whether Network Address Usage metrics are enabled for your VPC.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVpcEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVpcEndpointRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVpcEndpointResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies attributes of a specified VPC endpoint. The attributes that you can modify\n depend on the type of VPC endpoint (interface, gateway, or Gateway Load Balancer). For more information, \n see the Amazon Web Services PrivateLink \n Guide.

" + } + }, + "com.amazonaws.ec2#ModifyVpcEndpointConnectionNotification": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVpcEndpointConnectionNotificationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVpcEndpointConnectionNotificationResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies a connection notification for VPC endpoint or VPC endpoint service. You\n can change the SNS topic for the notification, or the events for which to be notified.

" + } + }, + "com.amazonaws.ec2#ModifyVpcEndpointConnectionNotificationRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ConnectionNotificationId": { + "target": "com.amazonaws.ec2#ConnectionNotificationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the notification.

", + "smithy.api#required": {} + } + }, + "ConnectionNotificationArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ARN for the SNS topic for the notification.

" + } + }, + "ConnectionEvents": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The events for the endpoint. Valid values are Accept,\n Connect, Delete, and Reject.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVpcEndpointConnectionNotificationResult": { + "type": "structure", + "members": { + "ReturnValue": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVpcEndpointRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "VpcEndpointId": { + "target": "com.amazonaws.ec2#VpcEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the endpoint.

", + "smithy.api#required": {} + } + }, + "ResetPolicy": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

(Gateway endpoint) Specify true to reset the policy document to the\n default policy. The default policy allows full access to the service.

" + } + }, + "PolicyDocument": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must\n be in valid JSON format.

" + } + }, + "AddRouteTableIds": { + "target": "com.amazonaws.ec2#VpcEndpointRouteTableIdList", + "traits": { + "smithy.api#documentation": "

(Gateway endpoint) The IDs of the route tables to associate with the endpoint.

", + "smithy.api#xmlName": "AddRouteTableId" + } + }, + "RemoveRouteTableIds": { + "target": "com.amazonaws.ec2#VpcEndpointRouteTableIdList", + "traits": { + "smithy.api#documentation": "

(Gateway endpoint) The IDs of the route tables to disassociate from the endpoint.

", + "smithy.api#xmlName": "RemoveRouteTableId" + } + }, + "AddSubnetIds": { + "target": "com.amazonaws.ec2#VpcEndpointSubnetIdList", + "traits": { + "smithy.api#documentation": "

(Interface and Gateway Load Balancer endpoints) The IDs of the subnets in which to serve the endpoint. \n For a Gateway Load Balancer endpoint, you can specify only one subnet.

", + "smithy.api#xmlName": "AddSubnetId" + } + }, + "RemoveSubnetIds": { + "target": "com.amazonaws.ec2#VpcEndpointSubnetIdList", + "traits": { + "smithy.api#documentation": "

(Interface endpoint) The IDs of the subnets from which to remove the endpoint.

", + "smithy.api#xmlName": "RemoveSubnetId" + } + }, + "AddSecurityGroupIds": { + "target": "com.amazonaws.ec2#VpcEndpointSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

(Interface endpoint) The IDs of the security groups to associate with the network interface.

", + "smithy.api#xmlName": "AddSecurityGroupId" + } + }, + "RemoveSecurityGroupIds": { + "target": "com.amazonaws.ec2#VpcEndpointSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

(Interface endpoint) The IDs of the security groups to disassociate from the network interface.

", + "smithy.api#xmlName": "RemoveSecurityGroupId" + } + }, + "IpAddressType": { + "target": "com.amazonaws.ec2#IpAddressType", + "traits": { + "smithy.api#documentation": "

The IP address type for the endpoint.

" + } + }, + "DnsOptions": { + "target": "com.amazonaws.ec2#DnsOptionsSpecification", + "traits": { + "smithy.api#documentation": "

The DNS options for the endpoint.

" + } + }, + "PrivateDnsEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

(Interface endpoint) Indicates whether a private hosted zone is associated with the\n VPC.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVpcEndpointResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVpcEndpointServiceConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVpcEndpointServiceConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVpcEndpointServiceConfigurationResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the attributes of your VPC endpoint service configuration. You can change the\n Network Load Balancers or Gateway Load Balancers for your service, and you can specify whether acceptance is\n required for requests to connect to your endpoint service through an interface VPC\n endpoint.

\n

If you set or modify the private DNS name, you must prove that you own the private DNS\n domain name.

" + } + }, + "com.amazonaws.ec2#ModifyVpcEndpointServiceConfigurationRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ServiceId": { + "target": "com.amazonaws.ec2#VpcEndpointServiceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the service.

", + "smithy.api#required": {} + } + }, + "PrivateDnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

(Interface endpoint configuration) The private DNS name to assign to the endpoint service.

" + } + }, + "RemovePrivateDnsName": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

(Interface endpoint configuration) Removes the private DNS name of the endpoint service.

" + } + }, + "AcceptanceRequired": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether requests to create an endpoint to your service must be accepted.

" + } + }, + "AddNetworkLoadBalancerArns": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of Network Load Balancers to add to your service\n configuration.

", + "smithy.api#xmlName": "AddNetworkLoadBalancerArn" + } + }, + "RemoveNetworkLoadBalancerArns": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your service\n configuration.

", + "smithy.api#xmlName": "RemoveNetworkLoadBalancerArn" + } + }, + "AddGatewayLoadBalancerArns": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of Gateway Load Balancers to add to your service\n configuration.

", + "smithy.api#xmlName": "AddGatewayLoadBalancerArn" + } + }, + "RemoveGatewayLoadBalancerArns": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of Gateway Load Balancers to remove from your service\n configuration.

", + "smithy.api#xmlName": "RemoveGatewayLoadBalancerArn" + } + }, + "AddSupportedIpAddressTypes": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The IP address types to add to your service configuration.

", + "smithy.api#xmlName": "AddSupportedIpAddressType" + } + }, + "RemoveSupportedIpAddressTypes": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The IP address types to remove from your service configuration.

", + "smithy.api#xmlName": "RemoveSupportedIpAddressType" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVpcEndpointServiceConfigurationResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVpcEndpointServicePayerResponsibility": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVpcEndpointServicePayerResponsibilityRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVpcEndpointServicePayerResponsibilityResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the payer responsibility for your VPC endpoint service.

" + } + }, + "com.amazonaws.ec2#ModifyVpcEndpointServicePayerResponsibilityRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ServiceId": { + "target": "com.amazonaws.ec2#VpcEndpointServiceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the service.

", + "smithy.api#required": {} + } + }, + "PayerResponsibility": { + "target": "com.amazonaws.ec2#PayerResponsibility", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The entity that is responsible for the endpoint costs. The default is the endpoint owner.\n If you set the payer responsibility to the service owner, you cannot set it back to the\n endpoint owner.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVpcEndpointServicePayerResponsibilityResult": { + "type": "structure", + "members": { + "ReturnValue": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVpcEndpointServicePermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVpcEndpointServicePermissionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVpcEndpointServicePermissionsResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the permissions for your VPC endpoint service. You can add or remove permissions\n for service consumers (Amazon Web Services accounts, users, and IAM roles) to connect to\n your endpoint service.

\n

If you grant permissions to all principals, the service is public. Any users who know the name of a\n\t public service can send a request to attach an endpoint. If the service does not require manual approval,\n\t attachments are automatically approved.

" + } + }, + "com.amazonaws.ec2#ModifyVpcEndpointServicePermissionsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ServiceId": { + "target": "com.amazonaws.ec2#VpcEndpointServiceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the service.

", + "smithy.api#required": {} + } + }, + "AddAllowedPrincipals": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the principals.\n\t Permissions are granted to the principals in this list.\n\t To grant permissions to all principals, specify an asterisk (*).

" + } + }, + "RemoveAllowedPrincipals": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the principals.\n\t Permissions are revoked for principals in this list.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVpcEndpointServicePermissionsResult": { + "type": "structure", + "members": { + "AddedPrincipals": { + "target": "com.amazonaws.ec2#AddedPrincipalSet", + "traits": { + "aws.protocols#ec2QueryName": "AddedPrincipalSet", + "smithy.api#documentation": "

Information about the added principals.

", + "smithy.api#xmlName": "addedPrincipalSet" + } + }, + "ReturnValue": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVpcPeeringConnectionOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVpcPeeringConnectionOptionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVpcPeeringConnectionOptionsResult" + }, + "traits": { + "smithy.api#documentation": "\n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n \n

Modifies the VPC peering connection options on one side of a VPC peering connection. You can do the following:

\n \n

If the peered VPCs are in the same Amazon Web Services account, you can enable DNS\n resolution for queries from the local VPC. This ensures that queries from the local VPC\n resolve to private IP addresses in the peer VPC. This option is not available if the\n peered VPCs are in different Amazon Web Services accounts or different Regions. For\n peered VPCs in different Amazon Web Services accounts, each Amazon Web Services account\n owner must initiate a separate request to modify the peering connection options. For\n inter-region peering connections, you must use the Region for the requester VPC to\n modify the requester VPC peering options and the Region for the accepter VPC to modify\n the accepter VPC peering options. To verify which VPCs are the accepter and the\n requester for a VPC peering connection, use the DescribeVpcPeeringConnections command.

" + } + }, + "com.amazonaws.ec2#ModifyVpcPeeringConnectionOptionsRequest": { + "type": "structure", + "members": { + "AccepterPeeringConnectionOptions": { + "target": "com.amazonaws.ec2#PeeringConnectionOptionsRequest", + "traits": { + "smithy.api#documentation": "

The VPC peering connection options for the accepter VPC.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "RequesterPeeringConnectionOptions": { + "target": "com.amazonaws.ec2#PeeringConnectionOptionsRequest", + "traits": { + "smithy.api#documentation": "

The VPC peering connection options for the requester VPC.

" + } + }, + "VpcPeeringConnectionId": { + "target": "com.amazonaws.ec2#VpcPeeringConnectionId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC peering connection.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVpcPeeringConnectionOptionsResult": { + "type": "structure", + "members": { + "AccepterPeeringConnectionOptions": { + "target": "com.amazonaws.ec2#PeeringConnectionOptions", + "traits": { + "aws.protocols#ec2QueryName": "AccepterPeeringConnectionOptions", + "smithy.api#documentation": "

Information about the VPC peering connection options for the accepter VPC.

", + "smithy.api#xmlName": "accepterPeeringConnectionOptions" + } + }, + "RequesterPeeringConnectionOptions": { + "target": "com.amazonaws.ec2#PeeringConnectionOptions", + "traits": { + "aws.protocols#ec2QueryName": "RequesterPeeringConnectionOptions", + "smithy.api#documentation": "

Information about the VPC peering connection options for the requester VPC.

", + "smithy.api#xmlName": "requesterPeeringConnectionOptions" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVpcTenancy": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVpcTenancyRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVpcTenancyResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the instance tenancy attribute of the specified VPC. You can change the\n instance tenancy attribute of a VPC to default only. You cannot change the\n instance tenancy attribute to dedicated.

\n

After you modify the tenancy of the VPC, any new instances that you launch into the\n VPC have a tenancy of default, unless you specify otherwise during launch.\n The tenancy of any existing instances in the VPC is not affected.

\n

For more information, see Dedicated Instances in the\n\t\t\t\tAmazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#ModifyVpcTenancyRequest": { + "type": "structure", + "members": { + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {} + } + }, + "InstanceTenancy": { + "target": "com.amazonaws.ec2#VpcTenancy", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The instance tenancy attribute for the VPC.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVpcTenancyResult": { + "type": "structure", + "members": { + "ReturnValue": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, returns an\n error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVpnConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVpnConnectionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVpnConnectionResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the customer gateway or the target gateway of an Amazon Web Services Site-to-Site VPN connection. To\n modify the target gateway, the following migration options are available:

\n \n

Before you perform the migration to the new gateway, you must configure the new\n gateway. Use CreateVpnGateway to create a virtual private gateway, or\n CreateTransitGateway to create a transit gateway.

\n

This step is required when you migrate from a virtual private gateway with static\n routes to a transit gateway.

\n

You must delete the static routes before you migrate to the new gateway.

\n

Keep a copy of the static route before you delete it. You will need to add back these\n routes to the transit gateway after the VPN connection migration is complete.

\n

After you migrate to the new gateway, you might need to modify your VPC route table.\n Use CreateRoute and DeleteRoute to make the changes\n described in Update VPC route\n tables in the Amazon Web Services Site-to-Site VPN User Guide.

\n

When the new gateway is a transit gateway, modify the transit gateway route table to\n allow traffic between the VPC and the Amazon Web Services Site-to-Site VPN connection.\n Use CreateTransitGatewayRoute to add the routes.

\n

If you deleted VPN static routes, you must add the static routes to the transit\n gateway route table.

\n

After you perform this operation, the VPN endpoint's IP addresses on the Amazon Web Services side and the tunnel options remain intact. Your Amazon Web Services Site-to-Site VPN connection will\n be temporarily unavailable for a brief period while we provision the new\n endpoints.

" + } + }, + "com.amazonaws.ec2#ModifyVpnConnectionOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVpnConnectionOptionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVpnConnectionOptionsResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the connection options for your Site-to-Site VPN connection.

\n

When you modify the VPN connection options, the VPN endpoint IP addresses on the\n Amazon Web Services side do not change, and the tunnel options do not change. Your\n VPN connection will be temporarily unavailable for a brief period while the VPN\n connection is updated.

" + } + }, + "com.amazonaws.ec2#ModifyVpnConnectionOptionsRequest": { + "type": "structure", + "members": { + "VpnConnectionId": { + "target": "com.amazonaws.ec2#VpnConnectionId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Site-to-Site VPN connection.

", + "smithy.api#required": {} + } + }, + "LocalIpv4NetworkCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.

\n

Default: 0.0.0.0/0\n

" + } + }, + "RemoteIpv4NetworkCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv4 CIDR on the Amazon Web Services side of the VPN connection.

\n

Default: 0.0.0.0/0\n

" + } + }, + "LocalIpv6NetworkCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.

\n

Default: ::/0\n

" + } + }, + "RemoteIpv6NetworkCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv6 CIDR on the Amazon Web Services side of the VPN connection.

\n

Default: ::/0\n

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVpnConnectionOptionsResult": { + "type": "structure", + "members": { + "VpnConnection": { + "target": "com.amazonaws.ec2#VpnConnection", + "traits": { + "aws.protocols#ec2QueryName": "VpnConnection", + "smithy.api#documentation": "

Information about the VPN connection.

", + "smithy.api#xmlName": "vpnConnection" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVpnConnectionRequest": { + "type": "structure", + "members": { + "VpnConnectionId": { + "target": "com.amazonaws.ec2#VpnConnectionId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPN connection.

", + "smithy.api#required": {} + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway.

" + } + }, + "CustomerGatewayId": { + "target": "com.amazonaws.ec2#CustomerGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the customer gateway at your end of the VPN connection.

" + } + }, + "VpnGatewayId": { + "target": "com.amazonaws.ec2#VpnGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the virtual private gateway at the Amazon Web Services side of the VPN\n connection.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVpnConnectionResult": { + "type": "structure", + "members": { + "VpnConnection": { + "target": "com.amazonaws.ec2#VpnConnection", + "traits": { + "aws.protocols#ec2QueryName": "VpnConnection", + "smithy.api#documentation": "

Information about the VPN connection.

", + "smithy.api#xmlName": "vpnConnection" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVpnTunnelCertificate": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVpnTunnelCertificateRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVpnTunnelCertificateResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the VPN tunnel endpoint certificate.

" + } + }, + "com.amazonaws.ec2#ModifyVpnTunnelCertificateRequest": { + "type": "structure", + "members": { + "VpnConnectionId": { + "target": "com.amazonaws.ec2#VpnConnectionId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Amazon Web Services Site-to-Site VPN connection.

", + "smithy.api#required": {} + } + }, + "VpnTunnelOutsideIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The external IP address of the VPN tunnel.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVpnTunnelCertificateResult": { + "type": "structure", + "members": { + "VpnConnection": { + "target": "com.amazonaws.ec2#VpnConnection", + "traits": { + "aws.protocols#ec2QueryName": "VpnConnection", + "smithy.api#documentation": "

Information about the VPN connection.

", + "smithy.api#xmlName": "vpnConnection" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVpnTunnelOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVpnTunnelOptionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVpnTunnelOptionsResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the options for a VPN tunnel in an Amazon Web Services Site-to-Site VPN connection. You can modify\n multiple options for a tunnel in a single request, but you can only modify one tunnel at\n a time. For more information, see Site-to-Site VPN tunnel options for your Site-to-Site VPN\n connection in the Amazon Web Services Site-to-Site VPN User Guide.

" + } + }, + "com.amazonaws.ec2#ModifyVpnTunnelOptionsRequest": { + "type": "structure", + "members": { + "VpnConnectionId": { + "target": "com.amazonaws.ec2#VpnConnectionId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Amazon Web Services Site-to-Site VPN connection.

", + "smithy.api#required": {} + } + }, + "VpnTunnelOutsideIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The external IP address of the VPN tunnel.

", + "smithy.api#required": {} + } + }, + "TunnelOptions": { + "target": "com.amazonaws.ec2#ModifyVpnTunnelOptionsSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The tunnel options to modify.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + } + }, + "SkipTunnelReplacement": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Choose whether or not to trigger immediate tunnel replacement.

\n

Valid values: True | False\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyVpnTunnelOptionsResult": { + "type": "structure", + "members": { + "VpnConnection": { + "target": "com.amazonaws.ec2#VpnConnection", + "traits": { + "aws.protocols#ec2QueryName": "VpnConnection", + "smithy.api#documentation": "

Information about the VPN connection.

", + "smithy.api#xmlName": "vpnConnection" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ModifyVpnTunnelOptionsSpecification": { + "type": "structure", + "members": { + "TunnelInsideCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be\n unique across all VPN connections that use the same virtual private gateway.

\n

Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The\n following CIDR blocks are reserved and cannot be used:

\n " + } + }, + "TunnelInsideIpv6Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be\n unique across all VPN connections that use the same transit gateway.

\n

Constraints: A size /126 CIDR block from the local fd00::/8 range.

" + } + }, + "PreSharedKey": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The pre-shared key (PSK) to establish initial authentication between the virtual\n private gateway and the customer gateway.

\n

Constraints: Allowed characters are alphanumeric characters, periods (.), and\n underscores (_). Must be between 8 and 64 characters in length and cannot start with\n zero (0).

" + } + }, + "Phase1LifetimeSeconds": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The lifetime for phase 1 of the IKE negotiation, in seconds.

\n

Constraints: A value between 900 and 28,800.

\n

Default: 28800\n

" + } + }, + "Phase2LifetimeSeconds": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The lifetime for phase 2 of the IKE negotiation, in seconds.

\n

Constraints: A value between 900 and 3,600. The value must be less than the value for\n Phase1LifetimeSeconds.

\n

Default: 3600\n

" + } + }, + "RekeyMarginTimeSeconds": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The margin time, in seconds, before the phase 2 lifetime expires, during which the\n Amazon Web Services side of the VPN connection performs an IKE rekey. The exact time\n of the rekey is randomly selected based on the value for\n RekeyFuzzPercentage.

\n

Constraints: A value between 60 and half of Phase2LifetimeSeconds.

\n

Default: 540\n

" + } + }, + "RekeyFuzzPercentage": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The percentage of the rekey window (determined by RekeyMarginTimeSeconds)\n during which the rekey time is randomly selected.

\n

Constraints: A value between 0 and 100.

\n

Default: 100\n

" + } + }, + "ReplayWindowSize": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of packets in an IKE replay window.

\n

Constraints: A value between 64 and 2048.

\n

Default: 1024\n

" + } + }, + "DPDTimeoutSeconds": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of seconds after which a DPD timeout occurs.

\n

Constraints: A value greater than or equal to 30.

\n

Default: 30\n

" + } + }, + "DPDTimeoutAction": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The action to take after DPD timeout occurs. Specify restart to restart\n the IKE initiation. Specify clear to end the IKE session.

\n

Valid Values: clear | none | restart\n

\n

Default: clear\n

" + } + }, + "Phase1EncryptionAlgorithms": { + "target": "com.amazonaws.ec2#Phase1EncryptionAlgorithmsRequestList", + "traits": { + "smithy.api#documentation": "

One or more encryption algorithms that are permitted for the VPN tunnel for phase 1\n IKE negotiations.

\n

Valid values: AES128 | AES256 | AES128-GCM-16 |\n AES256-GCM-16\n

", + "smithy.api#xmlName": "Phase1EncryptionAlgorithm" + } + }, + "Phase2EncryptionAlgorithms": { + "target": "com.amazonaws.ec2#Phase2EncryptionAlgorithmsRequestList", + "traits": { + "smithy.api#documentation": "

One or more encryption algorithms that are permitted for the VPN tunnel for phase 2\n IKE negotiations.

\n

Valid values: AES128 | AES256 | AES128-GCM-16 |\n AES256-GCM-16\n

", + "smithy.api#xmlName": "Phase2EncryptionAlgorithm" + } + }, + "Phase1IntegrityAlgorithms": { + "target": "com.amazonaws.ec2#Phase1IntegrityAlgorithmsRequestList", + "traits": { + "smithy.api#documentation": "

One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE\n negotiations.

\n

Valid values: SHA1 | SHA2-256 | SHA2-384 |\n SHA2-512\n

", + "smithy.api#xmlName": "Phase1IntegrityAlgorithm" + } + }, + "Phase2IntegrityAlgorithms": { + "target": "com.amazonaws.ec2#Phase2IntegrityAlgorithmsRequestList", + "traits": { + "smithy.api#documentation": "

One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE\n negotiations.

\n

Valid values: SHA1 | SHA2-256 | SHA2-384 |\n SHA2-512\n

", + "smithy.api#xmlName": "Phase2IntegrityAlgorithm" + } + }, + "Phase1DHGroupNumbers": { + "target": "com.amazonaws.ec2#Phase1DHGroupNumbersRequestList", + "traits": { + "smithy.api#documentation": "

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for\n phase 1 IKE negotiations.

\n

Valid values: 2 | 14 | 15 | 16 |\n 17 | 18 | 19 | 20 |\n 21 | 22 | 23 | 24\n

", + "smithy.api#xmlName": "Phase1DHGroupNumber" + } + }, + "Phase2DHGroupNumbers": { + "target": "com.amazonaws.ec2#Phase2DHGroupNumbersRequestList", + "traits": { + "smithy.api#documentation": "

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for\n phase 2 IKE negotiations.

\n

Valid values: 2 | 5 | 14 | 15 |\n 16 | 17 | 18 | 19 |\n 20 | 21 | 22 | 23 |\n 24\n

", + "smithy.api#xmlName": "Phase2DHGroupNumber" + } + }, + "IKEVersions": { + "target": "com.amazonaws.ec2#IKEVersionsRequestList", + "traits": { + "smithy.api#documentation": "

The IKE versions that are permitted for the VPN tunnel.

\n

Valid values: ikev1 | ikev2\n

", + "smithy.api#xmlName": "IKEVersion" + } + }, + "StartupAction": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The action to take when the establishing the tunnel for the VPN connection. By\n default, your customer gateway device must initiate the IKE negotiation and bring up the\n tunnel. Specify start for Amazon Web Services to initiate the IKE\n negotiation.

\n

Valid Values: add | start\n

\n

Default: add\n

" + } + }, + "LogOptions": { + "target": "com.amazonaws.ec2#VpnTunnelLogOptionsSpecification", + "traits": { + "smithy.api#documentation": "

Options for logging VPN tunnel activity.

" + } + }, + "EnableTunnelLifecycleControl": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Turn on or off tunnel endpoint lifecycle control feature.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Site-to-Site VPN tunnel options to modify.

" + } + }, + "com.amazonaws.ec2#MonitorInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#MonitorInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#MonitorInstancesResult" + }, + "traits": { + "smithy.api#documentation": "

Enables detailed monitoring for a running instance. Otherwise, basic monitoring is\n enabled. For more information, see Monitor your instances using\n CloudWatch in the Amazon EC2 User Guide.

\n

To disable detailed monitoring, see UnmonitorInstances.

" + } + }, + "com.amazonaws.ec2#MonitorInstancesRequest": { + "type": "structure", + "members": { + "InstanceIds": { + "target": "com.amazonaws.ec2#InstanceIdStringList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the instances.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "InstanceId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#MonitorInstancesResult": { + "type": "structure", + "members": { + "InstanceMonitorings": { + "target": "com.amazonaws.ec2#InstanceMonitoringList", + "traits": { + "aws.protocols#ec2QueryName": "InstancesSet", + "smithy.api#documentation": "

The monitoring information.

", + "smithy.api#xmlName": "instancesSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#Monitoring": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.ec2#MonitoringState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is\n enabled.

", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the monitoring of an instance.

" + } + }, + "com.amazonaws.ec2#MonitoringState": { + "type": "enum", + "members": { + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "disabling": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabling" + } + }, + "enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + }, + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + } + } + }, + "com.amazonaws.ec2#MoveAddressToVpc": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#MoveAddressToVpcRequest" + }, + "output": { + "target": "com.amazonaws.ec2#MoveAddressToVpcResult" + }, + "traits": { + "smithy.api#documentation": "\n

This action is deprecated.

\n \n

Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The\n Elastic IP address must be allocated to your account for more than 24 hours, and it must not\n be associated with an instance. After the Elastic IP address is moved, it is no longer\n available for use in the EC2-Classic platform, unless you move it back using the\n RestoreAddressToClassic request. You cannot move an Elastic IP address that was\n originally allocated for use in the EC2-VPC platform to the EC2-Classic platform.

" + } + }, + "com.amazonaws.ec2#MoveAddressToVpcRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "PublicIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicIp", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Elastic IP address.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "publicIp" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#MoveAddressToVpcResult": { + "type": "structure", + "members": { + "AllocationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AllocationId", + "smithy.api#documentation": "

The allocation ID for the Elastic IP address.

", + "smithy.api#xmlName": "allocationId" + } + }, + "Status": { + "target": "com.amazonaws.ec2#Status", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status of the move of the IP address.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#MoveByoipCidrToIpam": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#MoveByoipCidrToIpamRequest" + }, + "output": { + "target": "com.amazonaws.ec2#MoveByoipCidrToIpamResult" + }, + "traits": { + "smithy.api#documentation": "

Move a BYOIPv4 CIDR to IPAM from a public IPv4 pool.

\n

If you already have a BYOIPv4 CIDR with Amazon Web Services, you can move the CIDR to IPAM from a public IPv4 pool. You cannot move an IPv6 CIDR to IPAM. If you are bringing a new IP address to Amazon Web Services for the first time, complete the steps in Tutorial: BYOIP address CIDRs to IPAM.

" + } + }, + "com.amazonaws.ec2#MoveByoipCidrToIpamRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The BYOIP CIDR.

", + "smithy.api#required": {} + } + }, + "IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IPAM pool ID.

", + "smithy.api#required": {} + } + }, + "IpamPoolOwner": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the IPAM pool.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#MoveByoipCidrToIpamResult": { + "type": "structure", + "members": { + "ByoipCidr": { + "target": "com.amazonaws.ec2#ByoipCidr", + "traits": { + "aws.protocols#ec2QueryName": "ByoipCidr", + "smithy.api#documentation": "

The BYOIP CIDR.

", + "smithy.api#xmlName": "byoipCidr" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#MoveStatus": { + "type": "enum", + "members": { + "movingToVpc": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "movingToVpc" + } + }, + "restoringToClassic": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "restoringToClassic" + } + } + } + }, + "com.amazonaws.ec2#MovingAddressStatus": { + "type": "structure", + "members": { + "MoveStatus": { + "target": "com.amazonaws.ec2#MoveStatus", + "traits": { + "aws.protocols#ec2QueryName": "MoveStatus", + "smithy.api#documentation": "

The status of the Elastic IP address that's being moved or restored.

", + "smithy.api#xmlName": "moveStatus" + } + }, + "PublicIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicIp", + "smithy.api#documentation": "

The Elastic IP address.

", + "smithy.api#xmlName": "publicIp" + } + } + }, + "traits": { + "smithy.api#documentation": "\n

This action is deprecated.

\n \n

Describes the status of a moving Elastic IP address.

" + } + }, + "com.amazonaws.ec2#MovingAddressStatusSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#MovingAddressStatus", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#MulticastSupportValue": { + "type": "enum", + "members": { + "enable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enable" + } + }, + "disable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disable" + } + } + } + }, + "com.amazonaws.ec2#NatGateway": { + "type": "structure", + "members": { + "CreateTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreateTime", + "smithy.api#documentation": "

The date and time the NAT gateway was created.

", + "smithy.api#xmlName": "createTime" + } + }, + "DeleteTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "DeleteTime", + "smithy.api#documentation": "

The date and time the NAT gateway was deleted, if applicable.

", + "smithy.api#xmlName": "deleteTime" + } + }, + "FailureCode": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "FailureCode", + "smithy.api#documentation": "

If the NAT gateway could not be created, specifies the error code for the failure.\n (InsufficientFreeAddressesInSubnet | Gateway.NotAttached |\n InvalidAllocationID.NotFound | Resource.AlreadyAssociated |\n InternalError | InvalidSubnetID.NotFound)

", + "smithy.api#xmlName": "failureCode" + } + }, + "FailureMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "FailureMessage", + "smithy.api#documentation": "

If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.

\n ", + "smithy.api#xmlName": "failureMessage" + } + }, + "NatGatewayAddresses": { + "target": "com.amazonaws.ec2#NatGatewayAddressList", + "traits": { + "aws.protocols#ec2QueryName": "NatGatewayAddressSet", + "smithy.api#documentation": "

Information about the IP addresses and network interface associated with the NAT gateway.

", + "smithy.api#xmlName": "natGatewayAddressSet" + } + }, + "NatGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NatGatewayId", + "smithy.api#documentation": "

The ID of the NAT gateway.

", + "smithy.api#xmlName": "natGatewayId" + } + }, + "ProvisionedBandwidth": { + "target": "com.amazonaws.ec2#ProvisionedBandwidth", + "traits": { + "aws.protocols#ec2QueryName": "ProvisionedBandwidth", + "smithy.api#documentation": "

Reserved. If you need to sustain traffic greater than the documented limits, contact us through \n the Support Center.

", + "smithy.api#xmlName": "provisionedBandwidth" + } + }, + "State": { + "target": "com.amazonaws.ec2#NatGatewayState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the NAT gateway.

\n ", + "smithy.api#xmlName": "state" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet in which the NAT gateway is located.

", + "smithy.api#xmlName": "subnetId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC in which the NAT gateway is located.

", + "smithy.api#xmlName": "vpcId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for the NAT gateway.

", + "smithy.api#xmlName": "tagSet" + } + }, + "ConnectivityType": { + "target": "com.amazonaws.ec2#ConnectivityType", + "traits": { + "aws.protocols#ec2QueryName": "ConnectivityType", + "smithy.api#documentation": "

Indicates whether the NAT gateway supports public or private connectivity.

", + "smithy.api#xmlName": "connectivityType" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a NAT gateway.

" + } + }, + "com.amazonaws.ec2#NatGatewayAddress": { + "type": "structure", + "members": { + "AllocationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AllocationId", + "smithy.api#documentation": "

[Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway.

", + "smithy.api#xmlName": "allocationId" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface associated with the NAT gateway.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "PrivateIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIp", + "smithy.api#documentation": "

The private IP address associated with the NAT gateway.

", + "smithy.api#xmlName": "privateIp" + } + }, + "PublicIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicIp", + "smithy.api#documentation": "

[Public NAT gateway only] The Elastic IP address associated with the NAT gateway.

", + "smithy.api#xmlName": "publicIp" + } + }, + "AssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#documentation": "

[Public NAT gateway only] The association ID of the Elastic IP address that's associated with the NAT gateway.

", + "smithy.api#xmlName": "associationId" + } + }, + "IsPrimary": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "IsPrimary", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Defines if the IP address is the primary address.

", + "smithy.api#xmlName": "isPrimary" + } + }, + "FailureMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "FailureMessage", + "smithy.api#documentation": "

The address failure message.

", + "smithy.api#xmlName": "failureMessage" + } + }, + "Status": { + "target": "com.amazonaws.ec2#NatGatewayAddressStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The address status.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the IP addresses and network interface associated with a NAT gateway.

" + } + }, + "com.amazonaws.ec2#NatGatewayAddressList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NatGatewayAddress", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NatGatewayAddressStatus": { + "type": "enum", + "members": { + "ASSIGNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "assigning" + } + }, + "UNASSIGNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unassigning" + } + }, + "ASSOCIATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associating" + } + }, + "DISASSOCIATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociating" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "succeeded" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + } + } + }, + "com.amazonaws.ec2#NatGatewayId": { + "type": "string" + }, + "com.amazonaws.ec2#NatGatewayIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NatGatewayId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NatGatewayList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NatGateway", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NatGatewayState": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + } + } + }, + "com.amazonaws.ec2#NetmaskLength": { + "type": "integer" + }, + "com.amazonaws.ec2#NetworkAcl": { + "type": "structure", + "members": { + "Associations": { + "target": "com.amazonaws.ec2#NetworkAclAssociationList", + "traits": { + "aws.protocols#ec2QueryName": "AssociationSet", + "smithy.api#documentation": "

Any associations between the network ACL and one or more subnets

", + "smithy.api#xmlName": "associationSet" + } + }, + "Entries": { + "target": "com.amazonaws.ec2#NetworkAclEntryList", + "traits": { + "aws.protocols#ec2QueryName": "EntrySet", + "smithy.api#documentation": "

One or more entries (rules) in the network ACL.

", + "smithy.api#xmlName": "entrySet" + } + }, + "IsDefault": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Default", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether this is the default network ACL for the VPC.

", + "smithy.api#xmlName": "default" + } + }, + "NetworkAclId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkAclId", + "smithy.api#documentation": "

The ID of the network ACL.

", + "smithy.api#xmlName": "networkAclId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the network ACL.

", + "smithy.api#xmlName": "tagSet" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC for the network ACL.

", + "smithy.api#xmlName": "vpcId" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the network ACL.

", + "smithy.api#xmlName": "ownerId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a network ACL.

" + } + }, + "com.amazonaws.ec2#NetworkAclAssociation": { + "type": "structure", + "members": { + "NetworkAclAssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkAclAssociationId", + "smithy.api#documentation": "

The ID of the association between a network ACL and a subnet.

", + "smithy.api#xmlName": "networkAclAssociationId" + } + }, + "NetworkAclId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkAclId", + "smithy.api#documentation": "

The ID of the network ACL.

", + "smithy.api#xmlName": "networkAclId" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet.

", + "smithy.api#xmlName": "subnetId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an association between a network ACL and a subnet.

" + } + }, + "com.amazonaws.ec2#NetworkAclAssociationId": { + "type": "string" + }, + "com.amazonaws.ec2#NetworkAclAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkAclAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkAclEntry": { + "type": "structure", + "members": { + "CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrBlock", + "smithy.api#documentation": "

The IPv4 network range to allow or deny, in CIDR notation.

", + "smithy.api#xmlName": "cidrBlock" + } + }, + "Egress": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Egress", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).

", + "smithy.api#xmlName": "egress" + } + }, + "IcmpTypeCode": { + "target": "com.amazonaws.ec2#IcmpTypeCode", + "traits": { + "aws.protocols#ec2QueryName": "IcmpTypeCode", + "smithy.api#documentation": "

ICMP protocol: The ICMP type and code.

", + "smithy.api#xmlName": "icmpTypeCode" + } + }, + "Ipv6CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrBlock", + "smithy.api#documentation": "

The IPv6 network range to allow or deny, in CIDR notation.

", + "smithy.api#xmlName": "ipv6CidrBlock" + } + }, + "PortRange": { + "target": "com.amazonaws.ec2#PortRange", + "traits": { + "aws.protocols#ec2QueryName": "PortRange", + "smithy.api#documentation": "

TCP or UDP protocols: The range of ports the rule applies to.

", + "smithy.api#xmlName": "portRange" + } + }, + "Protocol": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Protocol", + "smithy.api#documentation": "

The protocol number. A value of \"-1\" means all protocols.

", + "smithy.api#xmlName": "protocol" + } + }, + "RuleAction": { + "target": "com.amazonaws.ec2#RuleAction", + "traits": { + "aws.protocols#ec2QueryName": "RuleAction", + "smithy.api#documentation": "

Indicates whether to allow or deny the traffic that matches the rule.

", + "smithy.api#xmlName": "ruleAction" + } + }, + "RuleNumber": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "RuleNumber", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The rule number for the entry. ACL entries are processed in ascending order by rule number.

", + "smithy.api#xmlName": "ruleNumber" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an entry in a network ACL.

" + } + }, + "com.amazonaws.ec2#NetworkAclEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkAclEntry", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkAclId": { + "type": "string" + }, + "com.amazonaws.ec2#NetworkAclIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkAclId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkAclList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkAcl", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkBandwidthGbps": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "Min", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no minimum\n limit.

", + "smithy.api#xmlName": "min" + } + }, + "Max": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "Max", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no\n maximum limit.

", + "smithy.api#xmlName": "max" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).

\n \n

Setting the minimum bandwidth does not guarantee that your instance will achieve the \n minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum \n bandwidth, but the actual bandwidth of your instance might go below the specified minimum \n at times. For more information, see Available instance bandwidth in the\n Amazon EC2 User Guide.

\n " + } + }, + "com.amazonaws.ec2#NetworkBandwidthGbpsRequest": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum amount of network bandwidth, in Gbps. To specify no minimum limit, omit this\n parameter.

" + } + }, + "Max": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum amount of network bandwidth, in Gbps. To specify no maximum limit, omit this\n parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).

\n \n

Setting the minimum bandwidth does not guarantee that your instance will achieve the \n minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum \n bandwidth, but the actual bandwidth of your instance might go below the specified minimum \n at times. For more information, see Available instance bandwidth in the\n Amazon EC2 User Guide.

\n " + } + }, + "com.amazonaws.ec2#NetworkCardIndex": { + "type": "integer" + }, + "com.amazonaws.ec2#NetworkCardInfo": { + "type": "structure", + "members": { + "NetworkCardIndex": { + "target": "com.amazonaws.ec2#NetworkCardIndex", + "traits": { + "aws.protocols#ec2QueryName": "NetworkCardIndex", + "smithy.api#documentation": "

The index of the network card.

", + "smithy.api#xmlName": "networkCardIndex" + } + }, + "NetworkPerformance": { + "target": "com.amazonaws.ec2#NetworkPerformance", + "traits": { + "aws.protocols#ec2QueryName": "NetworkPerformance", + "smithy.api#documentation": "

The network performance of the network card.

", + "smithy.api#xmlName": "networkPerformance" + } + }, + "MaximumNetworkInterfaces": { + "target": "com.amazonaws.ec2#MaxNetworkInterfaces", + "traits": { + "aws.protocols#ec2QueryName": "MaximumNetworkInterfaces", + "smithy.api#documentation": "

The maximum number of network interfaces for the network card.

", + "smithy.api#xmlName": "maximumNetworkInterfaces" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the network card support of the instance type.

" + } + }, + "com.amazonaws.ec2#NetworkCardInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkCardInfo", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkInfo": { + "type": "structure", + "members": { + "NetworkPerformance": { + "target": "com.amazonaws.ec2#NetworkPerformance", + "traits": { + "aws.protocols#ec2QueryName": "NetworkPerformance", + "smithy.api#documentation": "

The network performance.

", + "smithy.api#xmlName": "networkPerformance" + } + }, + "MaximumNetworkInterfaces": { + "target": "com.amazonaws.ec2#MaxNetworkInterfaces", + "traits": { + "aws.protocols#ec2QueryName": "MaximumNetworkInterfaces", + "smithy.api#documentation": "

The maximum number of network interfaces for the instance type.

", + "smithy.api#xmlName": "maximumNetworkInterfaces" + } + }, + "MaximumNetworkCards": { + "target": "com.amazonaws.ec2#MaximumNetworkCards", + "traits": { + "aws.protocols#ec2QueryName": "MaximumNetworkCards", + "smithy.api#documentation": "

The maximum number of physical network cards that can be allocated to the instance.

", + "smithy.api#xmlName": "maximumNetworkCards" + } + }, + "DefaultNetworkCardIndex": { + "target": "com.amazonaws.ec2#DefaultNetworkCardIndex", + "traits": { + "aws.protocols#ec2QueryName": "DefaultNetworkCardIndex", + "smithy.api#documentation": "

The index of the default network card, starting at 0.

", + "smithy.api#xmlName": "defaultNetworkCardIndex" + } + }, + "NetworkCards": { + "target": "com.amazonaws.ec2#NetworkCardInfoList", + "traits": { + "aws.protocols#ec2QueryName": "NetworkCards", + "smithy.api#documentation": "

Describes the network cards for the instance type.

", + "smithy.api#xmlName": "networkCards" + } + }, + "Ipv4AddressesPerInterface": { + "target": "com.amazonaws.ec2#MaxIpv4AddrPerInterface", + "traits": { + "aws.protocols#ec2QueryName": "Ipv4AddressesPerInterface", + "smithy.api#documentation": "

The maximum number of IPv4 addresses per network interface.

", + "smithy.api#xmlName": "ipv4AddressesPerInterface" + } + }, + "Ipv6AddressesPerInterface": { + "target": "com.amazonaws.ec2#MaxIpv6AddrPerInterface", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6AddressesPerInterface", + "smithy.api#documentation": "

The maximum number of IPv6 addresses per network interface.

", + "smithy.api#xmlName": "ipv6AddressesPerInterface" + } + }, + "Ipv6Supported": { + "target": "com.amazonaws.ec2#Ipv6Flag", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Supported", + "smithy.api#documentation": "

Indicates whether IPv6 is supported.

", + "smithy.api#xmlName": "ipv6Supported" + } + }, + "EnaSupport": { + "target": "com.amazonaws.ec2#EnaSupport", + "traits": { + "aws.protocols#ec2QueryName": "EnaSupport", + "smithy.api#documentation": "

Indicates whether Elastic Network Adapter (ENA) is supported.

", + "smithy.api#xmlName": "enaSupport" + } + }, + "EfaSupported": { + "target": "com.amazonaws.ec2#EfaSupportedFlag", + "traits": { + "aws.protocols#ec2QueryName": "EfaSupported", + "smithy.api#documentation": "

Indicates whether Elastic Fabric Adapter (EFA) is supported.

", + "smithy.api#xmlName": "efaSupported" + } + }, + "EfaInfo": { + "target": "com.amazonaws.ec2#EfaInfo", + "traits": { + "aws.protocols#ec2QueryName": "EfaInfo", + "smithy.api#documentation": "

Describes the Elastic Fabric Adapters for the instance type.

", + "smithy.api#xmlName": "efaInfo" + } + }, + "EncryptionInTransitSupported": { + "target": "com.amazonaws.ec2#EncryptionInTransitSupported", + "traits": { + "aws.protocols#ec2QueryName": "EncryptionInTransitSupported", + "smithy.api#documentation": "

Indicates whether the instance type automatically encrypts in-transit traffic between instances.

", + "smithy.api#xmlName": "encryptionInTransitSupported" + } + }, + "EnaSrdSupported": { + "target": "com.amazonaws.ec2#EnaSrdSupported", + "traits": { + "aws.protocols#ec2QueryName": "EnaSrdSupported", + "smithy.api#documentation": "

Indicates whether the instance type supports ENA Express. ENA Express uses Amazon Web Services Scalable \n Reliable Datagram (SRD) technology to increase the maximum bandwidth used per stream and \n minimize tail latency of network traffic between EC2 instances.

", + "smithy.api#xmlName": "enaSrdSupported" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the networking features of the instance type.

" + } + }, + "com.amazonaws.ec2#NetworkInsightsAccessScope": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeId", + "smithy.api#documentation": "

The ID of the Network Access Scope.

", + "smithy.api#xmlName": "networkInsightsAccessScopeId" + } + }, + "NetworkInsightsAccessScopeArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Network Access Scope.

", + "smithy.api#xmlName": "networkInsightsAccessScopeArn" + } + }, + "CreatedDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreatedDate", + "smithy.api#documentation": "

The creation date.

", + "smithy.api#xmlName": "createdDate" + } + }, + "UpdatedDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "UpdatedDate", + "smithy.api#documentation": "

The last updated date.

", + "smithy.api#xmlName": "updatedDate" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Network Access Scope.

" + } + }, + "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysis": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeAnalysisId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeAnalysisId", + "smithy.api#documentation": "

The ID of the Network Access Scope analysis.

", + "smithy.api#xmlName": "networkInsightsAccessScopeAnalysisId" + } + }, + "NetworkInsightsAccessScopeAnalysisArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeAnalysisArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Network Access Scope analysis.

", + "smithy.api#xmlName": "networkInsightsAccessScopeAnalysisArn" + } + }, + "NetworkInsightsAccessScopeId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeId", + "smithy.api#documentation": "

The ID of the Network Access Scope.

", + "smithy.api#xmlName": "networkInsightsAccessScopeId" + } + }, + "Status": { + "target": "com.amazonaws.ec2#AnalysisStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status.

", + "smithy.api#xmlName": "status" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

The status message.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "WarningMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "WarningMessage", + "smithy.api#documentation": "

The warning message.

", + "smithy.api#xmlName": "warningMessage" + } + }, + "StartDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "StartDate", + "smithy.api#documentation": "

The analysis start date.

", + "smithy.api#xmlName": "startDate" + } + }, + "EndDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "EndDate", + "smithy.api#documentation": "

The analysis end date.

", + "smithy.api#xmlName": "endDate" + } + }, + "FindingsFound": { + "target": "com.amazonaws.ec2#FindingsFound", + "traits": { + "aws.protocols#ec2QueryName": "FindingsFound", + "smithy.api#documentation": "

Indicates whether there are findings.

", + "smithy.api#xmlName": "findingsFound" + } + }, + "AnalyzedEniCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "AnalyzedEniCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of network interfaces analyzed.

", + "smithy.api#xmlName": "analyzedEniCount" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Network Access Scope analysis.

" + } + }, + "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisId": { + "type": "string" + }, + "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysisList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysis", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkInsightsAccessScopeContent": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeId", + "smithy.api#documentation": "

The ID of the Network Access Scope.

", + "smithy.api#xmlName": "networkInsightsAccessScopeId" + } + }, + "MatchPaths": { + "target": "com.amazonaws.ec2#AccessScopePathList", + "traits": { + "aws.protocols#ec2QueryName": "MatchPathSet", + "smithy.api#documentation": "

The paths to match.

", + "smithy.api#xmlName": "matchPathSet" + } + }, + "ExcludePaths": { + "target": "com.amazonaws.ec2#AccessScopePathList", + "traits": { + "aws.protocols#ec2QueryName": "ExcludePathSet", + "smithy.api#documentation": "

The paths to exclude.

", + "smithy.api#xmlName": "excludePathSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the Network Access Scope content.

" + } + }, + "com.amazonaws.ec2#NetworkInsightsAccessScopeId": { + "type": "string" + }, + "com.amazonaws.ec2#NetworkInsightsAccessScopeIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkInsightsAccessScopeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScope", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkInsightsAnalysis": { + "type": "structure", + "members": { + "NetworkInsightsAnalysisId": { + "target": "com.amazonaws.ec2#NetworkInsightsAnalysisId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAnalysisId", + "smithy.api#documentation": "

The ID of the network insights analysis.

", + "smithy.api#xmlName": "networkInsightsAnalysisId" + } + }, + "NetworkInsightsAnalysisArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAnalysisArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network insights analysis.

", + "smithy.api#xmlName": "networkInsightsAnalysisArn" + } + }, + "NetworkInsightsPathId": { + "target": "com.amazonaws.ec2#NetworkInsightsPathId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsPathId", + "smithy.api#documentation": "

The ID of the path.

", + "smithy.api#xmlName": "networkInsightsPathId" + } + }, + "AdditionalAccounts": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "AdditionalAccountSet", + "smithy.api#documentation": "

The member accounts that contain resources that the path can traverse.

", + "smithy.api#xmlName": "additionalAccountSet" + } + }, + "FilterInArns": { + "target": "com.amazonaws.ec2#ArnList", + "traits": { + "aws.protocols#ec2QueryName": "FilterInArnSet", + "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the resources that the path must traverse.

", + "smithy.api#xmlName": "filterInArnSet" + } + }, + "StartDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "StartDate", + "smithy.api#documentation": "

The time the analysis started.

", + "smithy.api#xmlName": "startDate" + } + }, + "Status": { + "target": "com.amazonaws.ec2#AnalysisStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status of the network insights analysis.

", + "smithy.api#xmlName": "status" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

The status message, if the status is failed.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "WarningMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "WarningMessage", + "smithy.api#documentation": "

The warning message.

", + "smithy.api#xmlName": "warningMessage" + } + }, + "NetworkPathFound": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "NetworkPathFound", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the destination is reachable from the source.

", + "smithy.api#xmlName": "networkPathFound" + } + }, + "ForwardPathComponents": { + "target": "com.amazonaws.ec2#PathComponentList", + "traits": { + "aws.protocols#ec2QueryName": "ForwardPathComponentSet", + "smithy.api#documentation": "

The components in the path from source to destination.

", + "smithy.api#xmlName": "forwardPathComponentSet" + } + }, + "ReturnPathComponents": { + "target": "com.amazonaws.ec2#PathComponentList", + "traits": { + "aws.protocols#ec2QueryName": "ReturnPathComponentSet", + "smithy.api#documentation": "

The components in the path from destination to source.

", + "smithy.api#xmlName": "returnPathComponentSet" + } + }, + "Explanations": { + "target": "com.amazonaws.ec2#ExplanationList", + "traits": { + "aws.protocols#ec2QueryName": "ExplanationSet", + "smithy.api#documentation": "

The explanations. For more information, see Reachability Analyzer explanation codes.

", + "smithy.api#xmlName": "explanationSet" + } + }, + "AlternatePathHints": { + "target": "com.amazonaws.ec2#AlternatePathHintList", + "traits": { + "aws.protocols#ec2QueryName": "AlternatePathHintSet", + "smithy.api#documentation": "

Potential intermediate components.

", + "smithy.api#xmlName": "alternatePathHintSet" + } + }, + "SuggestedAccounts": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "SuggestedAccountSet", + "smithy.api#documentation": "

Potential intermediate accounts.

", + "smithy.api#xmlName": "suggestedAccountSet" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a network insights analysis.

" + } + }, + "com.amazonaws.ec2#NetworkInsightsAnalysisId": { + "type": "string" + }, + "com.amazonaws.ec2#NetworkInsightsAnalysisIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkInsightsAnalysisId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkInsightsAnalysisList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkInsightsAnalysis", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkInsightsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.ec2#NetworkInsightsPath": { + "type": "structure", + "members": { + "NetworkInsightsPathId": { + "target": "com.amazonaws.ec2#NetworkInsightsPathId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsPathId", + "smithy.api#documentation": "

The ID of the path.

", + "smithy.api#xmlName": "networkInsightsPathId" + } + }, + "NetworkInsightsPathArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsPathArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the path.

", + "smithy.api#xmlName": "networkInsightsPathArn" + } + }, + "CreatedDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreatedDate", + "smithy.api#documentation": "

The time stamp when the path was created.

", + "smithy.api#xmlName": "createdDate" + } + }, + "Source": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Source", + "smithy.api#documentation": "

The ID of the source.

", + "smithy.api#xmlName": "source" + } + }, + "Destination": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Destination", + "smithy.api#documentation": "

The ID of the destination.

", + "smithy.api#xmlName": "destination" + } + }, + "SourceArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "SourceArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source.

", + "smithy.api#xmlName": "sourceArn" + } + }, + "DestinationArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "DestinationArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the destination.

", + "smithy.api#xmlName": "destinationArn" + } + }, + "SourceIp": { + "target": "com.amazonaws.ec2#IpAddress", + "traits": { + "aws.protocols#ec2QueryName": "SourceIp", + "smithy.api#documentation": "

The IP address of the source.

", + "smithy.api#xmlName": "sourceIp" + } + }, + "DestinationIp": { + "target": "com.amazonaws.ec2#IpAddress", + "traits": { + "aws.protocols#ec2QueryName": "DestinationIp", + "smithy.api#documentation": "

The IP address of the destination.

", + "smithy.api#xmlName": "destinationIp" + } + }, + "Protocol": { + "target": "com.amazonaws.ec2#Protocol", + "traits": { + "aws.protocols#ec2QueryName": "Protocol", + "smithy.api#documentation": "

The protocol.

", + "smithy.api#xmlName": "protocol" + } + }, + "DestinationPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "DestinationPort", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The destination port.

", + "smithy.api#xmlName": "destinationPort" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags associated with the path.

", + "smithy.api#xmlName": "tagSet" + } + }, + "FilterAtSource": { + "target": "com.amazonaws.ec2#PathFilter", + "traits": { + "aws.protocols#ec2QueryName": "FilterAtSource", + "smithy.api#documentation": "

Scopes the analysis to network paths that match specific filters at the source.

", + "smithy.api#xmlName": "filterAtSource" + } + }, + "FilterAtDestination": { + "target": "com.amazonaws.ec2#PathFilter", + "traits": { + "aws.protocols#ec2QueryName": "FilterAtDestination", + "smithy.api#documentation": "

Scopes the analysis to network paths that match specific filters at the destination.

", + "smithy.api#xmlName": "filterAtDestination" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a path.

" + } + }, + "com.amazonaws.ec2#NetworkInsightsPathId": { + "type": "string" + }, + "com.amazonaws.ec2#NetworkInsightsPathIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkInsightsPathId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkInsightsPathList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkInsightsPath", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkInsightsResourceId": { + "type": "string" + }, + "com.amazonaws.ec2#NetworkInterface": { + "type": "structure", + "members": { + "Association": { + "target": "com.amazonaws.ec2#NetworkInterfaceAssociation", + "traits": { + "aws.protocols#ec2QueryName": "Association", + "smithy.api#documentation": "

The association information for an Elastic IP address (IPv4) associated with the network interface.

", + "smithy.api#xmlName": "association" + } + }, + "Attachment": { + "target": "com.amazonaws.ec2#NetworkInterfaceAttachment", + "traits": { + "aws.protocols#ec2QueryName": "Attachment", + "smithy.api#documentation": "

The network interface attachment.

", + "smithy.api#xmlName": "attachment" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description.

", + "smithy.api#xmlName": "description" + } + }, + "Groups": { + "target": "com.amazonaws.ec2#GroupIdentifierList", + "traits": { + "aws.protocols#ec2QueryName": "GroupSet", + "smithy.api#documentation": "

Any security groups for the network interface.

", + "smithy.api#xmlName": "groupSet" + } + }, + "InterfaceType": { + "target": "com.amazonaws.ec2#NetworkInterfaceType", + "traits": { + "aws.protocols#ec2QueryName": "InterfaceType", + "smithy.api#documentation": "

The type of network interface.

", + "smithy.api#xmlName": "interfaceType" + } + }, + "Ipv6Addresses": { + "target": "com.amazonaws.ec2#NetworkInterfaceIpv6AddressesList", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6AddressesSet", + "smithy.api#documentation": "

The IPv6 addresses associated with the network interface.

", + "smithy.api#xmlName": "ipv6AddressesSet" + } + }, + "MacAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "MacAddress", + "smithy.api#documentation": "

The MAC address.

", + "smithy.api#xmlName": "macAddress" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutpostArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

", + "smithy.api#xmlName": "outpostArn" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the network interface.

", + "smithy.api#xmlName": "ownerId" + } + }, + "PrivateDnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDnsName", + "smithy.api#documentation": "

The private DNS name.

", + "smithy.api#xmlName": "privateDnsName" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

The IPv4 address of the network interface within the subnet.

", + "smithy.api#xmlName": "privateIpAddress" + } + }, + "PrivateIpAddresses": { + "target": "com.amazonaws.ec2#NetworkInterfacePrivateIpAddressList", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddressesSet", + "smithy.api#documentation": "

The private IPv4 addresses associated with the network interface.

", + "smithy.api#xmlName": "privateIpAddressesSet" + } + }, + "Ipv4Prefixes": { + "target": "com.amazonaws.ec2#Ipv4PrefixesList", + "traits": { + "aws.protocols#ec2QueryName": "Ipv4PrefixSet", + "smithy.api#documentation": "

The IPv4 prefixes that are assigned to the network interface.

", + "smithy.api#xmlName": "ipv4PrefixSet" + } + }, + "Ipv6Prefixes": { + "target": "com.amazonaws.ec2#Ipv6PrefixesList", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6PrefixSet", + "smithy.api#documentation": "

The IPv6 prefixes that are assigned to the network interface.

", + "smithy.api#xmlName": "ipv6PrefixSet" + } + }, + "RequesterId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RequesterId", + "smithy.api#documentation": "

The alias or Amazon Web Services account ID of the principal or service that created the network interface.

", + "smithy.api#xmlName": "requesterId" + } + }, + "RequesterManaged": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "RequesterManaged", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the network interface is being managed by Amazon Web Services.

", + "smithy.api#xmlName": "requesterManaged" + } + }, + "SourceDestCheck": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "SourceDestCheck", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether source/destination checking is enabled.

", + "smithy.api#xmlName": "sourceDestCheck" + } + }, + "Status": { + "target": "com.amazonaws.ec2#NetworkInterfaceStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status of the network interface.

", + "smithy.api#xmlName": "status" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet.

", + "smithy.api#xmlName": "subnetId" + } + }, + "TagSet": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the network interface.

", + "smithy.api#xmlName": "tagSet" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } + }, + "DenyAllIgwTraffic": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DenyAllIgwTraffic", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether a network interface with an IPv6 address is unreachable from the \n public internet. If the value is true, inbound traffic from the internet \n is dropped and you cannot assign an elastic IP address to the network interface. The \n network interface is reachable from peered VPCs and resources connected through a \n transit gateway, including on-premises networks.

", + "smithy.api#xmlName": "denyAllIgwTraffic" + } + }, + "Ipv6Native": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Native", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether this is an IPv6 only network interface.

", + "smithy.api#xmlName": "ipv6Native" + } + }, + "Ipv6Address": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Address", + "smithy.api#documentation": "

The IPv6 globally unique address associated with the network interface.

", + "smithy.api#xmlName": "ipv6Address" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a network interface.

" + } + }, + "com.amazonaws.ec2#NetworkInterfaceAssociation": { + "type": "structure", + "members": { + "AllocationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AllocationId", + "smithy.api#documentation": "

The allocation ID.

", + "smithy.api#xmlName": "allocationId" + } + }, + "AssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#documentation": "

The association ID.

", + "smithy.api#xmlName": "associationId" + } + }, + "IpOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpOwnerId", + "smithy.api#documentation": "

The ID of the Elastic IP address owner.

", + "smithy.api#xmlName": "ipOwnerId" + } + }, + "PublicDnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicDnsName", + "smithy.api#documentation": "

The public DNS name.

", + "smithy.api#xmlName": "publicDnsName" + } + }, + "PublicIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicIp", + "smithy.api#documentation": "

The address of the Elastic IP address bound to the network\n interface.

", + "smithy.api#xmlName": "publicIp" + } + }, + "CustomerOwnedIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CustomerOwnedIp", + "smithy.api#documentation": "

The customer-owned IP address associated with the network interface.

", + "smithy.api#xmlName": "customerOwnedIp" + } + }, + "CarrierIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CarrierIp", + "smithy.api#documentation": "

The carrier IP address associated with the network interface.

\n

This option is only available when the network interface is in a subnet which is associated with a Wavelength Zone.

", + "smithy.api#xmlName": "carrierIp" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes association information for an Elastic IP address (IPv4 only), or a Carrier\n IP address (for a network interface which resides in a subnet in a Wavelength\n Zone).

" + } + }, + "com.amazonaws.ec2#NetworkInterfaceAttachment": { + "type": "structure", + "members": { + "AttachTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "AttachTime", + "smithy.api#documentation": "

The timestamp indicating when the attachment initiated.

", + "smithy.api#xmlName": "attachTime" + } + }, + "AttachmentId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AttachmentId", + "smithy.api#documentation": "

The ID of the network interface attachment.

", + "smithy.api#xmlName": "attachmentId" + } + }, + "DeleteOnTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DeleteOnTermination", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the network interface is deleted when the instance is terminated.

", + "smithy.api#xmlName": "deleteOnTermination" + } + }, + "DeviceIndex": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "DeviceIndex", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The device index of the network interface attachment on the instance.

", + "smithy.api#xmlName": "deviceIndex" + } + }, + "NetworkCardIndex": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "NetworkCardIndex", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The index of the network card.

", + "smithy.api#xmlName": "networkCardIndex" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "InstanceOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceOwnerId", + "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the instance.

", + "smithy.api#xmlName": "instanceOwnerId" + } + }, + "Status": { + "target": "com.amazonaws.ec2#AttachmentStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The attachment state.

", + "smithy.api#xmlName": "status" + } + }, + "EnaSrdSpecification": { + "target": "com.amazonaws.ec2#AttachmentEnaSrdSpecification", + "traits": { + "aws.protocols#ec2QueryName": "EnaSrdSpecification", + "smithy.api#documentation": "

Configures ENA Express for the network interface that this action attaches to the instance.

", + "smithy.api#xmlName": "enaSrdSpecification" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a network interface attachment.

" + } + }, + "com.amazonaws.ec2#NetworkInterfaceAttachmentChanges": { + "type": "structure", + "members": { + "AttachmentId": { + "target": "com.amazonaws.ec2#NetworkInterfaceAttachmentId", + "traits": { + "aws.protocols#ec2QueryName": "AttachmentId", + "smithy.api#documentation": "

The ID of the network interface attachment.

", + "smithy.api#xmlName": "attachmentId" + } + }, + "DeleteOnTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DeleteOnTermination", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the network interface is deleted when the instance is terminated.

", + "smithy.api#xmlName": "deleteOnTermination" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an attachment change.

" + } + }, + "com.amazonaws.ec2#NetworkInterfaceAttachmentId": { + "type": "string" + }, + "com.amazonaws.ec2#NetworkInterfaceAttribute": { + "type": "enum", + "members": { + "description": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "description" + } + }, + "groupSet": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "groupSet" + } + }, + "sourceDestCheck": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sourceDestCheck" + } + }, + "attachment": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "attachment" + } + } + } + }, + "com.amazonaws.ec2#NetworkInterfaceCount": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Min", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum number of network interfaces. If this parameter is not specified, there is no\n minimum limit.

", + "smithy.api#xmlName": "min" + } + }, + "Max": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Max", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of network interfaces. If this parameter is not specified, there is no\n maximum limit.

", + "smithy.api#xmlName": "max" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum number of network interfaces.

" + } + }, + "com.amazonaws.ec2#NetworkInterfaceCountRequest": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum number of network interfaces. To specify no minimum limit, omit this\n parameter.

" + } + }, + "Max": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of network interfaces. To specify no maximum limit, omit this\n parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum number of network interfaces.

" + } + }, + "com.amazonaws.ec2#NetworkInterfaceCreationType": { + "type": "enum", + "members": { + "efa": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "efa" + } + }, + "branch": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "branch" + } + }, + "trunk": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "trunk" + } + } + } + }, + "com.amazonaws.ec2#NetworkInterfaceId": { + "type": "string" + }, + "com.amazonaws.ec2#NetworkInterfaceIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkInterfaceIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkInterfaceIpv6Address": { + "type": "structure", + "members": { + "Ipv6Address": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Address", + "smithy.api#documentation": "

The IPv6 address.

", + "smithy.api#xmlName": "ipv6Address" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an IPv6 address associated with a network interface.

" + } + }, + "com.amazonaws.ec2#NetworkInterfaceIpv6AddressesList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkInterfaceIpv6Address", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkInterfaceList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkInterface", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkInterfacePermission": { + "type": "structure", + "members": { + "NetworkInterfacePermissionId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfacePermissionId", + "smithy.api#documentation": "

The ID of the network interface permission.

", + "smithy.api#xmlName": "networkInterfacePermissionId" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "AwsAccountId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AwsAccountId", + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#xmlName": "awsAccountId" + } + }, + "AwsService": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AwsService", + "smithy.api#documentation": "

The Amazon Web Service.

", + "smithy.api#xmlName": "awsService" + } + }, + "Permission": { + "target": "com.amazonaws.ec2#InterfacePermissionType", + "traits": { + "aws.protocols#ec2QueryName": "Permission", + "smithy.api#documentation": "

The type of permission.

", + "smithy.api#xmlName": "permission" + } + }, + "PermissionState": { + "target": "com.amazonaws.ec2#NetworkInterfacePermissionState", + "traits": { + "aws.protocols#ec2QueryName": "PermissionState", + "smithy.api#documentation": "

Information about the state of the permission.

", + "smithy.api#xmlName": "permissionState" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a permission for a network interface.

" + } + }, + "com.amazonaws.ec2#NetworkInterfacePermissionId": { + "type": "string" + }, + "com.amazonaws.ec2#NetworkInterfacePermissionIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkInterfacePermissionId" + } + }, + "com.amazonaws.ec2#NetworkInterfacePermissionList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkInterfacePermission", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkInterfacePermissionState": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.ec2#NetworkInterfacePermissionStateCode", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the permission.

", + "smithy.api#xmlName": "state" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

A status message, if applicable.

", + "smithy.api#xmlName": "statusMessage" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the state of a network interface permission.

" + } + }, + "com.amazonaws.ec2#NetworkInterfacePermissionStateCode": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "granted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "granted" + } + }, + "revoking": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "revoking" + } + }, + "revoked": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "revoked" + } + } + } + }, + "com.amazonaws.ec2#NetworkInterfacePrivateIpAddress": { + "type": "structure", + "members": { + "Association": { + "target": "com.amazonaws.ec2#NetworkInterfaceAssociation", + "traits": { + "aws.protocols#ec2QueryName": "Association", + "smithy.api#documentation": "

The association information for an Elastic IP address (IPv4) associated with the network interface.

", + "smithy.api#xmlName": "association" + } + }, + "Primary": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Primary", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether this IPv4 address is the primary private IPv4 address of the network interface.

", + "smithy.api#xmlName": "primary" + } + }, + "PrivateDnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDnsName", + "smithy.api#documentation": "

The private DNS name.

", + "smithy.api#xmlName": "privateDnsName" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

The private IPv4 address.

", + "smithy.api#xmlName": "privateIpAddress" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the private IPv4 address of a network interface.

" + } + }, + "com.amazonaws.ec2#NetworkInterfacePrivateIpAddressList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkInterfacePrivateIpAddress", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NetworkInterfaceStatus": { + "type": "enum", + "members": { + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "associated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associated" + } + }, + "attaching": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "attaching" + } + }, + "in_use": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "in-use" + } + }, + "detaching": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "detaching" + } + } + } + }, + "com.amazonaws.ec2#NetworkInterfaceType": { + "type": "enum", + "members": { + "interface": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "interface" + } + }, + "natGateway": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "natGateway" + } + }, + "efa": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "efa" + } + }, + "trunk": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "trunk" + } + }, + "load_balancer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "load_balancer" + } + }, + "network_load_balancer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "network_load_balancer" + } + }, + "vpc_endpoint": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc_endpoint" + } + }, + "branch": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "branch" + } + }, + "transit_gateway": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "transit_gateway" + } + }, + "lambda": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lambda" + } + }, + "quicksight": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "quicksight" + } + }, + "global_accelerator_managed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "global_accelerator_managed" + } + }, + "api_gateway_managed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "api_gateway_managed" + } + }, + "gateway_load_balancer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "gateway_load_balancer" + } + }, + "gateway_load_balancer_endpoint": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "gateway_load_balancer_endpoint" + } + }, + "iot_rules_managed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "iot_rules_managed" + } + }, + "aws_codestar_connections_managed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "aws_codestar_connections_managed" + } + } + } + }, + "com.amazonaws.ec2#NetworkPerformance": { + "type": "string" + }, + "com.amazonaws.ec2#NewDhcpConfiguration": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Key", + "smithy.api#documentation": "

The name of a DHCP option.

", + "smithy.api#xmlName": "key" + } + }, + "Values": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

One or more values for the DHCP option.

", + "smithy.api#xmlName": "Value" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a DHCP configuration option.

" + } + }, + "com.amazonaws.ec2#NewDhcpConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NewDhcpConfiguration", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#NextToken": { + "type": "string" + }, + "com.amazonaws.ec2#OccurrenceDayRequestSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#xmlName": "OccurenceDay" + } + } + }, + "com.amazonaws.ec2#OccurrenceDaySet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#OfferingClassType": { + "type": "enum", + "members": { + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "standard" + } + }, + "CONVERTIBLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "convertible" + } + } + } + }, + "com.amazonaws.ec2#OfferingId": { + "type": "string" + }, + "com.amazonaws.ec2#OfferingTypeValues": { + "type": "enum", + "members": { + "Heavy_Utilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Heavy Utilization" + } + }, + "Medium_Utilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Medium Utilization" + } + }, + "Light_Utilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Light Utilization" + } + }, + "No_Upfront": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "No Upfront" + } + }, + "Partial_Upfront": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Partial Upfront" + } + }, + "All_Upfront": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "All Upfront" + } + } + } + }, + "com.amazonaws.ec2#OidcOptions": { + "type": "structure", + "members": { + "Issuer": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Issuer", + "smithy.api#documentation": "

The OIDC issuer.

", + "smithy.api#xmlName": "issuer" + } + }, + "AuthorizationEndpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AuthorizationEndpoint", + "smithy.api#documentation": "

The OIDC authorization endpoint.

", + "smithy.api#xmlName": "authorizationEndpoint" + } + }, + "TokenEndpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TokenEndpoint", + "smithy.api#documentation": "

The OIDC token endpoint.

", + "smithy.api#xmlName": "tokenEndpoint" + } + }, + "UserInfoEndpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UserInfoEndpoint", + "smithy.api#documentation": "

The OIDC user info endpoint.

", + "smithy.api#xmlName": "userInfoEndpoint" + } + }, + "ClientId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientId", + "smithy.api#documentation": "

The client identifier.

", + "smithy.api#xmlName": "clientId" + } + }, + "ClientSecret": { + "target": "com.amazonaws.ec2#ClientSecretType", + "traits": { + "aws.protocols#ec2QueryName": "ClientSecret", + "smithy.api#documentation": "

The client secret.

", + "smithy.api#xmlName": "clientSecret" + } + }, + "Scope": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Scope", + "smithy.api#documentation": "

The OpenID Connect (OIDC) scope specified.

", + "smithy.api#xmlName": "scope" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the options for an OpenID Connect-compatible user-identity trust\n provider.

" + } + }, + "com.amazonaws.ec2#OnDemandAllocationStrategy": { + "type": "enum", + "members": { + "LOWEST_PRICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lowestPrice" + } + }, + "PRIORITIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "prioritized" + } + } + } + }, + "com.amazonaws.ec2#OnDemandOptions": { + "type": "structure", + "members": { + "AllocationStrategy": { + "target": "com.amazonaws.ec2#FleetOnDemandAllocationStrategy", + "traits": { + "aws.protocols#ec2QueryName": "AllocationStrategy", + "smithy.api#documentation": "

The strategy that determines the order of the launch template overrides to use in\n fulfilling On-Demand capacity.

\n

\n lowest-price - EC2 Fleet uses price to determine the order, launching the lowest\n price first.

\n

\n prioritized - EC2 Fleet uses the priority that you assigned to each launch\n template override, launching the highest priority first.

\n

Default: lowest-price\n

", + "smithy.api#xmlName": "allocationStrategy" + } + }, + "CapacityReservationOptions": { + "target": "com.amazonaws.ec2#CapacityReservationOptions", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationOptions", + "smithy.api#documentation": "

The strategy for using unused Capacity Reservations for fulfilling On-Demand\n capacity.

\n

Supported only for fleets of type instant.

", + "smithy.api#xmlName": "capacityReservationOptions" + } + }, + "SingleInstanceType": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "SingleInstanceType", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the\n fleet.

\n

Supported only for fleets of type instant.

", + "smithy.api#xmlName": "singleInstanceType" + } + }, + "SingleAvailabilityZone": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "SingleAvailabilityZone", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.

\n

Supported only for fleets of type instant.

", + "smithy.api#xmlName": "singleAvailabilityZone" + } + }, + "MinTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MinTargetCapacity", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is\n not reached, the fleet launches no instances.

\n

Supported only for fleets of type instant.

\n

At least one of the following must be specified: SingleAvailabilityZone |\n SingleInstanceType\n

", + "smithy.api#xmlName": "minTargetCapacity" + } + }, + "MaxTotalPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "MaxTotalPrice", + "smithy.api#documentation": "

The maximum amount per hour for On-Demand Instances that you're willing to pay.

", + "smithy.api#xmlName": "maxTotalPrice" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the configuration of On-Demand Instances in an EC2 Fleet.

" + } + }, + "com.amazonaws.ec2#OnDemandOptionsRequest": { + "type": "structure", + "members": { + "AllocationStrategy": { + "target": "com.amazonaws.ec2#FleetOnDemandAllocationStrategy", + "traits": { + "smithy.api#documentation": "

The strategy that determines the order of the launch template overrides to use in\n fulfilling On-Demand capacity.

\n

\n lowest-price - EC2 Fleet uses price to determine the order, launching the lowest\n price first.

\n

\n prioritized - EC2 Fleet uses the priority that you assigned to each launch\n template override, launching the highest priority first.

\n

Default: lowest-price\n

" + } + }, + "CapacityReservationOptions": { + "target": "com.amazonaws.ec2#CapacityReservationOptionsRequest", + "traits": { + "smithy.api#documentation": "

The strategy for using unused Capacity Reservations for fulfilling On-Demand\n capacity.

\n

Supported only for fleets of type instant.

" + } + }, + "SingleInstanceType": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the\n fleet.

\n

Supported only for fleets of type instant.

" + } + }, + "SingleAvailabilityZone": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.

\n

Supported only for fleets of type instant.

" + } + }, + "MinTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is\n not reached, the fleet launches no instances.

\n

Supported only for fleets of type instant.

\n

At least one of the following must be specified: SingleAvailabilityZone |\n SingleInstanceType\n

" + } + }, + "MaxTotalPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The maximum amount per hour for On-Demand Instances that you're willing to pay.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the configuration of On-Demand Instances in an EC2 Fleet.

" + } + }, + "com.amazonaws.ec2#OperationType": { + "type": "enum", + "members": { + "add": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "add" + } + }, + "remove": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "remove" + } + } + } + }, + "com.amazonaws.ec2#OrganizationArnStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "OrganizationArn" + } + } + }, + "com.amazonaws.ec2#OrganizationalUnitArnStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "OrganizationalUnitArn" + } + } + }, + "com.amazonaws.ec2#OutpostArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws([a-z-]+)?:outposts:[a-z\\d-]+:\\d{12}:outpost/op-[a-f0-9]{17}$" + } + }, + "com.amazonaws.ec2#OwnerStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "Owner" + } + } + }, + "com.amazonaws.ec2#PacketHeaderStatement": { + "type": "structure", + "members": { + "SourceAddresses": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "SourceAddressSet", + "smithy.api#documentation": "

The source addresses.

", + "smithy.api#xmlName": "sourceAddressSet" + } + }, + "DestinationAddresses": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "DestinationAddressSet", + "smithy.api#documentation": "

The destination addresses.

", + "smithy.api#xmlName": "destinationAddressSet" + } + }, + "SourcePorts": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "SourcePortSet", + "smithy.api#documentation": "

The source ports.

", + "smithy.api#xmlName": "sourcePortSet" + } + }, + "DestinationPorts": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "DestinationPortSet", + "smithy.api#documentation": "

The destination ports.

", + "smithy.api#xmlName": "destinationPortSet" + } + }, + "SourcePrefixLists": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "SourcePrefixListSet", + "smithy.api#documentation": "

The source prefix lists.

", + "smithy.api#xmlName": "sourcePrefixListSet" + } + }, + "DestinationPrefixLists": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "DestinationPrefixListSet", + "smithy.api#documentation": "

The destination prefix lists.

", + "smithy.api#xmlName": "destinationPrefixListSet" + } + }, + "Protocols": { + "target": "com.amazonaws.ec2#ProtocolList", + "traits": { + "aws.protocols#ec2QueryName": "ProtocolSet", + "smithy.api#documentation": "

The protocols.

", + "smithy.api#xmlName": "protocolSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a packet header statement.

" + } + }, + "com.amazonaws.ec2#PacketHeaderStatementRequest": { + "type": "structure", + "members": { + "SourceAddresses": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The source addresses.

", + "smithy.api#xmlName": "SourceAddress" + } + }, + "DestinationAddresses": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The destination addresses.

", + "smithy.api#xmlName": "DestinationAddress" + } + }, + "SourcePorts": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The source ports.

", + "smithy.api#xmlName": "SourcePort" + } + }, + "DestinationPorts": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The destination ports.

", + "smithy.api#xmlName": "DestinationPort" + } + }, + "SourcePrefixLists": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The source prefix lists.

", + "smithy.api#xmlName": "SourcePrefixList" + } + }, + "DestinationPrefixLists": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The destination prefix lists.

", + "smithy.api#xmlName": "DestinationPrefixList" + } + }, + "Protocols": { + "target": "com.amazonaws.ec2#ProtocolList", + "traits": { + "smithy.api#documentation": "

The protocols.

", + "smithy.api#xmlName": "Protocol" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a packet header statement.

" + } + }, + "com.amazonaws.ec2#PartitionLoadFrequency": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "none" + } + }, + "DAILY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "daily" + } + }, + "WEEKLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "weekly" + } + }, + "MONTHLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "monthly" + } + } + } + }, + "com.amazonaws.ec2#PathComponent": { + "type": "structure", + "members": { + "SequenceNumber": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "SequenceNumber", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The sequence number.

", + "smithy.api#xmlName": "sequenceNumber" + } + }, + "AclRule": { + "target": "com.amazonaws.ec2#AnalysisAclRule", + "traits": { + "aws.protocols#ec2QueryName": "AclRule", + "smithy.api#documentation": "

The network ACL rule.

", + "smithy.api#xmlName": "aclRule" + } + }, + "AttachedTo": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "AttachedTo", + "smithy.api#documentation": "

The resource to which the path component is attached.

", + "smithy.api#xmlName": "attachedTo" + } + }, + "Component": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "Component", + "smithy.api#documentation": "

The component.

", + "smithy.api#xmlName": "component" + } + }, + "DestinationVpc": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "DestinationVpc", + "smithy.api#documentation": "

The destination VPC.

", + "smithy.api#xmlName": "destinationVpc" + } + }, + "OutboundHeader": { + "target": "com.amazonaws.ec2#AnalysisPacketHeader", + "traits": { + "aws.protocols#ec2QueryName": "OutboundHeader", + "smithy.api#documentation": "

The outbound header.

", + "smithy.api#xmlName": "outboundHeader" + } + }, + "InboundHeader": { + "target": "com.amazonaws.ec2#AnalysisPacketHeader", + "traits": { + "aws.protocols#ec2QueryName": "InboundHeader", + "smithy.api#documentation": "

The inbound header.

", + "smithy.api#xmlName": "inboundHeader" + } + }, + "RouteTableRoute": { + "target": "com.amazonaws.ec2#AnalysisRouteTableRoute", + "traits": { + "aws.protocols#ec2QueryName": "RouteTableRoute", + "smithy.api#documentation": "

The route table route.

", + "smithy.api#xmlName": "routeTableRoute" + } + }, + "SecurityGroupRule": { + "target": "com.amazonaws.ec2#AnalysisSecurityGroupRule", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupRule", + "smithy.api#documentation": "

The security group rule.

", + "smithy.api#xmlName": "securityGroupRule" + } + }, + "SourceVpc": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "SourceVpc", + "smithy.api#documentation": "

The source VPC.

", + "smithy.api#xmlName": "sourceVpc" + } + }, + "Subnet": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "Subnet", + "smithy.api#documentation": "

The subnet.

", + "smithy.api#xmlName": "subnet" + } + }, + "Vpc": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "Vpc", + "smithy.api#documentation": "

The component VPC.

", + "smithy.api#xmlName": "vpc" + } + }, + "AdditionalDetails": { + "target": "com.amazonaws.ec2#AdditionalDetailList", + "traits": { + "aws.protocols#ec2QueryName": "AdditionalDetailSet", + "smithy.api#documentation": "

The additional details.

", + "smithy.api#xmlName": "additionalDetailSet" + } + }, + "TransitGateway": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "TransitGateway", + "smithy.api#documentation": "

The transit gateway.

", + "smithy.api#xmlName": "transitGateway" + } + }, + "TransitGatewayRouteTableRoute": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableRoute", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableRoute", + "smithy.api#documentation": "

The route in a transit gateway route table.

", + "smithy.api#xmlName": "transitGatewayRouteTableRoute" + } + }, + "Explanations": { + "target": "com.amazonaws.ec2#ExplanationList", + "traits": { + "aws.protocols#ec2QueryName": "ExplanationSet", + "smithy.api#documentation": "

The explanation codes.

", + "smithy.api#xmlName": "explanationSet" + } + }, + "ElasticLoadBalancerListener": { + "target": "com.amazonaws.ec2#AnalysisComponent", + "traits": { + "aws.protocols#ec2QueryName": "ElasticLoadBalancerListener", + "smithy.api#documentation": "

The load balancer listener.

", + "smithy.api#xmlName": "elasticLoadBalancerListener" + } + }, + "FirewallStatelessRule": { + "target": "com.amazonaws.ec2#FirewallStatelessRule", + "traits": { + "aws.protocols#ec2QueryName": "FirewallStatelessRule", + "smithy.api#documentation": "

The Network Firewall stateless rule.

", + "smithy.api#xmlName": "firewallStatelessRule" + } + }, + "FirewallStatefulRule": { + "target": "com.amazonaws.ec2#FirewallStatefulRule", + "traits": { + "aws.protocols#ec2QueryName": "FirewallStatefulRule", + "smithy.api#documentation": "

The Network Firewall stateful rule.

", + "smithy.api#xmlName": "firewallStatefulRule" + } + }, + "ServiceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ServiceName", + "smithy.api#documentation": "

The name of the VPC endpoint service.

", + "smithy.api#xmlName": "serviceName" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a path component.

" + } + }, + "com.amazonaws.ec2#PathComponentList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PathComponent", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PathFilter": { + "type": "structure", + "members": { + "SourceAddress": { + "target": "com.amazonaws.ec2#IpAddress", + "traits": { + "aws.protocols#ec2QueryName": "SourceAddress", + "smithy.api#documentation": "

The source IPv4 address.

", + "smithy.api#xmlName": "sourceAddress" + } + }, + "SourcePortRange": { + "target": "com.amazonaws.ec2#FilterPortRange", + "traits": { + "aws.protocols#ec2QueryName": "SourcePortRange", + "smithy.api#documentation": "

The source port range.

", + "smithy.api#xmlName": "sourcePortRange" + } + }, + "DestinationAddress": { + "target": "com.amazonaws.ec2#IpAddress", + "traits": { + "aws.protocols#ec2QueryName": "DestinationAddress", + "smithy.api#documentation": "

The destination IPv4 address.

", + "smithy.api#xmlName": "destinationAddress" + } + }, + "DestinationPortRange": { + "target": "com.amazonaws.ec2#FilterPortRange", + "traits": { + "aws.protocols#ec2QueryName": "DestinationPortRange", + "smithy.api#documentation": "

The destination port range.

", + "smithy.api#xmlName": "destinationPortRange" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a set of filters for a path analysis. Use path filters to scope the analysis when\n there can be multiple resulting paths.

" + } + }, + "com.amazonaws.ec2#PathRequestFilter": { + "type": "structure", + "members": { + "SourceAddress": { + "target": "com.amazonaws.ec2#IpAddress", + "traits": { + "smithy.api#documentation": "

The source IPv4 address.

" + } + }, + "SourcePortRange": { + "target": "com.amazonaws.ec2#RequestFilterPortRange", + "traits": { + "smithy.api#documentation": "

The source port range.

" + } + }, + "DestinationAddress": { + "target": "com.amazonaws.ec2#IpAddress", + "traits": { + "smithy.api#documentation": "

The destination IPv4 address.

" + } + }, + "DestinationPortRange": { + "target": "com.amazonaws.ec2#RequestFilterPortRange", + "traits": { + "smithy.api#documentation": "

The destination port range.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a set of filters for a path analysis. Use path filters to scope the analysis when\n there can be multiple resulting paths.

" + } + }, + "com.amazonaws.ec2#PathStatement": { + "type": "structure", + "members": { + "PacketHeaderStatement": { + "target": "com.amazonaws.ec2#PacketHeaderStatement", + "traits": { + "aws.protocols#ec2QueryName": "PacketHeaderStatement", + "smithy.api#documentation": "

The packet header statement.

", + "smithy.api#xmlName": "packetHeaderStatement" + } + }, + "ResourceStatement": { + "target": "com.amazonaws.ec2#ResourceStatement", + "traits": { + "aws.protocols#ec2QueryName": "ResourceStatement", + "smithy.api#documentation": "

The resource statement.

", + "smithy.api#xmlName": "resourceStatement" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a path statement.

" + } + }, + "com.amazonaws.ec2#PathStatementRequest": { + "type": "structure", + "members": { + "PacketHeaderStatement": { + "target": "com.amazonaws.ec2#PacketHeaderStatementRequest", + "traits": { + "smithy.api#documentation": "

The packet header statement.

" + } + }, + "ResourceStatement": { + "target": "com.amazonaws.ec2#ResourceStatementRequest", + "traits": { + "smithy.api#documentation": "

The resource statement.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a path statement.

" + } + }, + "com.amazonaws.ec2#PayerResponsibility": { + "type": "enum", + "members": { + "ServiceOwner": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ServiceOwner" + } + } + } + }, + "com.amazonaws.ec2#PaymentOption": { + "type": "enum", + "members": { + "ALL_UPFRONT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AllUpfront" + } + }, + "PARTIAL_UPFRONT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PartialUpfront" + } + }, + "NO_UPFRONT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NoUpfront" + } + } + } + }, + "com.amazonaws.ec2#PciId": { + "type": "structure", + "members": { + "DeviceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of the device.

" + } + }, + "VendorId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of the vendor.

" + } + }, + "SubsystemId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of the subsystem.

" + } + }, + "SubsystemVendorId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of the vendor for the subsystem.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the data that identifies an Amazon FPGA image (AFI) on the PCI bus.

" + } + }, + "com.amazonaws.ec2#PeeringAttachmentStatus": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The status code.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The status message, if applicable.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

The status of the transit gateway peering attachment.

" + } + }, + "com.amazonaws.ec2#PeeringConnectionOptions": { + "type": "structure", + "members": { + "AllowDnsResolutionFromRemoteVpc": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AllowDnsResolutionFromRemoteVpc", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

If true, the public DNS hostnames of instances in the specified VPC resolve to private\n IP addresses when queried from instances in the peer VPC.

", + "smithy.api#xmlName": "allowDnsResolutionFromRemoteVpc" + } + }, + "AllowEgressFromLocalClassicLinkToRemoteVpc": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AllowEgressFromLocalClassicLinkToRemoteVpc", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

If true, enables outbound communication from an EC2-Classic instance that's linked to\n a local VPC using ClassicLink to instances in a peer VPC.

", + "smithy.api#xmlName": "allowEgressFromLocalClassicLinkToRemoteVpc" + } + }, + "AllowEgressFromLocalVpcToRemoteClassicLink": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AllowEgressFromLocalVpcToRemoteClassicLink", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

If true, enables outbound communication from instances in a local VPC to an\n EC2-Classic instance that's linked to a peer VPC using ClassicLink.

", + "smithy.api#xmlName": "allowEgressFromLocalVpcToRemoteClassicLink" + } + } + }, + "traits": { + "smithy.api#documentation": "\n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n \n

Describes the VPC peering connection options.

" + } + }, + "com.amazonaws.ec2#PeeringConnectionOptionsRequest": { + "type": "structure", + "members": { + "AllowDnsResolutionFromRemoteVpc": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#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": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

If true, enables outbound communication from an EC2-Classic instance that's linked to\n a local VPC using ClassicLink to instances in a peer VPC.

" + } + }, + "AllowEgressFromLocalVpcToRemoteClassicLink": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

If true, enables outbound communication from instances in a local VPC to an\n EC2-Classic instance that's linked to a peer VPC using ClassicLink.

" + } + } + }, + "traits": { + "smithy.api#documentation": "\n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n \n

The VPC peering connection options.

" + } + }, + "com.amazonaws.ec2#PeeringTgwInfo": { + "type": "structure", + "members": { + "TransitGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayId", + "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#xmlName": "transitGatewayId" + } + }, + "CoreNetworkId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CoreNetworkId", + "smithy.api#documentation": "

The ID of the core network where the transit gateway peer is located.

", + "smithy.api#xmlName": "coreNetworkId" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the transit gateway.

", + "smithy.api#xmlName": "ownerId" + } + }, + "Region": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Region", + "smithy.api#documentation": "

The Region of the transit gateway.

", + "smithy.api#xmlName": "region" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the transit gateway in the peering attachment.

" + } + }, + "com.amazonaws.ec2#PeriodType": { + "type": "enum", + "members": { + "five_minutes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "five-minutes" + } + }, + "fifteen_minutes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fifteen-minutes" + } + }, + "one_hour": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "one-hour" + } + }, + "three_hours": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "three-hours" + } + }, + "one_day": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "one-day" + } + }, + "one_week": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "one-week" + } + } + } + }, + "com.amazonaws.ec2#PermissionGroup": { + "type": "enum", + "members": { + "all": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "all" + } + } + } + }, + "com.amazonaws.ec2#Phase1DHGroupNumbersList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Phase1DHGroupNumbersListValue", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Phase1DHGroupNumbersListValue": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The Diffie-Hellmann group number.

", + "smithy.api#xmlName": "value" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Diffie-Hellmann group number for phase 1 IKE negotiations.

" + } + }, + "com.amazonaws.ec2#Phase1DHGroupNumbersRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Phase1DHGroupNumbersRequestListValue", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Phase1DHGroupNumbersRequestListValue": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The Diffie-Hellmann group number.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a Diffie-Hellman group number for the VPN tunnel for phase 1 IKE\n negotiations.

" + } + }, + "com.amazonaws.ec2#Phase1EncryptionAlgorithmsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Phase1EncryptionAlgorithmsListValue", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Phase1EncryptionAlgorithmsListValue": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#documentation": "

The value for the encryption algorithm.

", + "smithy.api#xmlName": "value" + } + } + }, + "traits": { + "smithy.api#documentation": "

The encryption algorithm for phase 1 IKE negotiations.

" + } + }, + "com.amazonaws.ec2#Phase1EncryptionAlgorithmsRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Phase1EncryptionAlgorithmsRequestListValue", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Phase1EncryptionAlgorithmsRequestListValue": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The value for the encryption algorithm.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the encryption algorithm for the VPN tunnel for phase 1 IKE\n negotiations.

" + } + }, + "com.amazonaws.ec2#Phase1IntegrityAlgorithmsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Phase1IntegrityAlgorithmsListValue", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Phase1IntegrityAlgorithmsListValue": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#documentation": "

The value for the integrity algorithm.

", + "smithy.api#xmlName": "value" + } + } + }, + "traits": { + "smithy.api#documentation": "

The integrity algorithm for phase 1 IKE negotiations.

" + } + }, + "com.amazonaws.ec2#Phase1IntegrityAlgorithmsRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Phase1IntegrityAlgorithmsRequestListValue", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Phase1IntegrityAlgorithmsRequestListValue": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The value for the integrity algorithm.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the integrity algorithm for the VPN tunnel for phase 1 IKE\n negotiations.

" + } + }, + "com.amazonaws.ec2#Phase2DHGroupNumbersList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Phase2DHGroupNumbersListValue", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Phase2DHGroupNumbersListValue": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The Diffie-Hellmann group number.

", + "smithy.api#xmlName": "value" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Diffie-Hellmann group number for phase 2 IKE negotiations.

" + } + }, + "com.amazonaws.ec2#Phase2DHGroupNumbersRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Phase2DHGroupNumbersRequestListValue", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Phase2DHGroupNumbersRequestListValue": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The Diffie-Hellmann group number.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a Diffie-Hellman group number for the VPN tunnel for phase 2 IKE\n negotiations.

" + } + }, + "com.amazonaws.ec2#Phase2EncryptionAlgorithmsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Phase2EncryptionAlgorithmsListValue", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Phase2EncryptionAlgorithmsListValue": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#documentation": "

The encryption algorithm.

", + "smithy.api#xmlName": "value" + } + } + }, + "traits": { + "smithy.api#documentation": "

The encryption algorithm for phase 2 IKE negotiations.

" + } + }, + "com.amazonaws.ec2#Phase2EncryptionAlgorithmsRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Phase2EncryptionAlgorithmsRequestListValue", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Phase2EncryptionAlgorithmsRequestListValue": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The encryption algorithm.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the encryption algorithm for the VPN tunnel for phase 2 IKE\n negotiations.

" + } + }, + "com.amazonaws.ec2#Phase2IntegrityAlgorithmsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Phase2IntegrityAlgorithmsListValue", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Phase2IntegrityAlgorithmsListValue": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#documentation": "

The integrity algorithm.

", + "smithy.api#xmlName": "value" + } + } + }, + "traits": { + "smithy.api#documentation": "

The integrity algorithm for phase 2 IKE negotiations.

" + } + }, + "com.amazonaws.ec2#Phase2IntegrityAlgorithmsRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Phase2IntegrityAlgorithmsRequestListValue", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Phase2IntegrityAlgorithmsRequestListValue": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The integrity algorithm.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the integrity algorithm for the VPN tunnel for phase 2 IKE\n negotiations.

" + } + }, + "com.amazonaws.ec2#Placement": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone of the instance.

\n

If not specified, an Availability Zone will be automatically chosen for you based on\n the load balancing criteria for the Region.

\n

This parameter is not supported for CreateFleet.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "Affinity": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Affinity", + "smithy.api#documentation": "

The affinity setting for the instance on the Dedicated Host.

\n

This parameter is not supported for CreateFleet or ImportInstance.

", + "smithy.api#xmlName": "affinity" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#PlacementGroupName", + "traits": { + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

The name of the placement group that the instance is in. If you specify\n GroupName, you can't specify GroupId.

", + "smithy.api#xmlName": "groupName" + } + }, + "PartitionNumber": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "PartitionNumber", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of the partition that the instance is in. Valid only if the placement group\n strategy is set to partition.

\n

This parameter is not supported for CreateFleet.

", + "smithy.api#xmlName": "partitionNumber" + } + }, + "HostId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "HostId", + "smithy.api#documentation": "

The ID of the Dedicated Host on which the instance resides.

\n

This parameter is not supported for CreateFleet or ImportInstance.

", + "smithy.api#xmlName": "hostId" + } + }, + "Tenancy": { + "target": "com.amazonaws.ec2#Tenancy", + "traits": { + "aws.protocols#ec2QueryName": "Tenancy", + "smithy.api#documentation": "

The tenancy of the instance. An instance with a\n tenancy of dedicated runs on single-tenant hardware.

\n

This parameter is not supported for CreateFleet. The\n host tenancy is not supported for ImportInstance or\n for T3 instances that are configured for the unlimited CPU credit\n option.

", + "smithy.api#xmlName": "tenancy" + } + }, + "SpreadDomain": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpreadDomain", + "smithy.api#documentation": "

Reserved for future use.

", + "smithy.api#xmlName": "spreadDomain" + } + }, + "HostResourceGroupArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "HostResourceGroupArn", + "smithy.api#documentation": "

The ARN of the host resource group in which to launch the instances.

\n

If you specify this parameter, either omit the Tenancy parameter or set it to host.

\n

This parameter is not supported for CreateFleet.

", + "smithy.api#xmlName": "hostResourceGroupArn" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#PlacementGroupId", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The ID of the placement group that the instance is in. If you specify\n GroupId, you can't specify GroupName.

", + "smithy.api#xmlName": "groupId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the placement of an instance.

" + } + }, + "com.amazonaws.ec2#PlacementGroup": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

The name of the placement group.

", + "smithy.api#xmlName": "groupName" + } + }, + "State": { + "target": "com.amazonaws.ec2#PlacementGroupState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the placement group.

", + "smithy.api#xmlName": "state" + } + }, + "Strategy": { + "target": "com.amazonaws.ec2#PlacementStrategy", + "traits": { + "aws.protocols#ec2QueryName": "Strategy", + "smithy.api#documentation": "

The placement strategy.

", + "smithy.api#xmlName": "strategy" + } + }, + "PartitionCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "PartitionCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of partitions. Valid only if strategy is\n set to partition.

", + "smithy.api#xmlName": "partitionCount" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The ID of the placement group.

", + "smithy.api#xmlName": "groupId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags applied to the placement group.

", + "smithy.api#xmlName": "tagSet" + } + }, + "GroupArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the placement group.

", + "smithy.api#xmlName": "groupArn" + } + }, + "SpreadLevel": { + "target": "com.amazonaws.ec2#SpreadLevel", + "traits": { + "aws.protocols#ec2QueryName": "SpreadLevel", + "smithy.api#documentation": "

The spread level for the placement group. Only Outpost placement\n groups can be spread across hosts.

", + "smithy.api#xmlName": "spreadLevel" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a placement group.

" + } + }, + "com.amazonaws.ec2#PlacementGroupArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws([a-z-]+)?:ec2:[a-z\\d-]+:\\d{12}:placement-group/([^\\s].+[^\\s]){1,255}$" + } + }, + "com.amazonaws.ec2#PlacementGroupId": { + "type": "string" + }, + "com.amazonaws.ec2#PlacementGroupIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PlacementGroupId", + "traits": { + "smithy.api#xmlName": "GroupId" + } + } + }, + "com.amazonaws.ec2#PlacementGroupInfo": { + "type": "structure", + "members": { + "SupportedStrategies": { + "target": "com.amazonaws.ec2#PlacementGroupStrategyList", + "traits": { + "aws.protocols#ec2QueryName": "SupportedStrategies", + "smithy.api#documentation": "

The supported placement group types.

", + "smithy.api#xmlName": "supportedStrategies" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the placement group support of the instance type.

" + } + }, + "com.amazonaws.ec2#PlacementGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PlacementGroup", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PlacementGroupName": { + "type": "string" + }, + "com.amazonaws.ec2#PlacementGroupState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + } + } + }, + "com.amazonaws.ec2#PlacementGroupStrategy": { + "type": "enum", + "members": { + "cluster": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cluster" + } + }, + "partition": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "partition" + } + }, + "spread": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "spread" + } + } + } + }, + "com.amazonaws.ec2#PlacementGroupStrategyList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PlacementGroupStrategy", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PlacementGroupStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PlacementGroupName" + } + }, + "com.amazonaws.ec2#PlacementResponse": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.ec2#PlacementGroupName", + "traits": { + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

The name of the placement group that the instance is in.

", + "smithy.api#xmlName": "groupName" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the placement of an instance.

" + } + }, + "com.amazonaws.ec2#PlacementStrategy": { + "type": "enum", + "members": { + "cluster": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cluster" + } + }, + "spread": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "spread" + } + }, + "partition": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "partition" + } + } + } + }, + "com.amazonaws.ec2#PlatformValues": { + "type": "enum", + "members": { + "Windows": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Windows" + } + } + } + }, + "com.amazonaws.ec2#PoolCidrBlock": { + "type": "structure", + "members": { + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PoolCidrBlock", + "smithy.api#documentation": "

The CIDR block.

", + "smithy.api#xmlName": "poolCidrBlock" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a CIDR block for an address pool.

" + } + }, + "com.amazonaws.ec2#PoolCidrBlocksSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PoolCidrBlock", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PoolMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.ec2#Port": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 65535 + } + } + }, + "com.amazonaws.ec2#PortRange": { + "type": "structure", + "members": { + "From": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "From", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The first port in the range.

", + "smithy.api#xmlName": "from" + } + }, + "To": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "To", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The last port in the range.

", + "smithy.api#xmlName": "to" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a range of ports.

" + } + }, + "com.amazonaws.ec2#PortRangeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PortRange", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PrefixList": { + "type": "structure", + "members": { + "Cidrs": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "CidrSet", + "smithy.api#documentation": "

The IP address range of the Amazon Web Service.

", + "smithy.api#xmlName": "cidrSet" + } + }, + "PrefixListId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListId", + "smithy.api#documentation": "

The ID of the prefix.

", + "smithy.api#xmlName": "prefixListId" + } + }, + "PrefixListName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListName", + "smithy.api#documentation": "

The name of the prefix.

", + "smithy.api#xmlName": "prefixListName" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes prefixes for Amazon Web Services services.

" + } + }, + "com.amazonaws.ec2#PrefixListAssociation": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource.

", + "smithy.api#xmlName": "resourceId" + } + }, + "ResourceOwner": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceOwner", + "smithy.api#documentation": "

The owner of the resource.

", + "smithy.api#xmlName": "resourceOwner" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the resource with which a prefix list is associated.

" + } + }, + "com.amazonaws.ec2#PrefixListAssociationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PrefixListAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PrefixListEntry": { + "type": "structure", + "members": { + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Cidr", + "smithy.api#documentation": "

The CIDR block.

", + "smithy.api#xmlName": "cidr" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description.

", + "smithy.api#xmlName": "description" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a prefix list entry.

" + } + }, + "com.amazonaws.ec2#PrefixListEntrySet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PrefixListEntry", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PrefixListId": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the security group rule that references this prefix list ID.

\n

Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9,\n spaces, and ._-:/()#,@[]+=;{}!$*

", + "smithy.api#xmlName": "description" + } + }, + "PrefixListId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListId", + "smithy.api#documentation": "

The ID of the prefix.

", + "smithy.api#xmlName": "prefixListId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a prefix list ID.

" + } + }, + "com.amazonaws.ec2#PrefixListIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PrefixListId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PrefixListIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PrefixListMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.ec2#PrefixListResourceId": { + "type": "string" + }, + "com.amazonaws.ec2#PrefixListResourceIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PrefixListSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PrefixList", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PrefixListState": { + "type": "enum", + "members": { + "create_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-in-progress" + } + }, + "create_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-complete" + } + }, + "create_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-failed" + } + }, + "modify_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modify-in-progress" + } + }, + "modify_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modify-complete" + } + }, + "modify_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modify-failed" + } + }, + "restore_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "restore-in-progress" + } + }, + "restore_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "restore-complete" + } + }, + "restore_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "restore-failed" + } + }, + "delete_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-in-progress" + } + }, + "delete_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-complete" + } + }, + "delete_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-failed" + } + } + } + }, + "com.amazonaws.ec2#PriceSchedule": { + "type": "structure", + "members": { + "Active": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Active", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.

\n

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.

", + "smithy.api#xmlName": "active" + } + }, + "CurrencyCode": { + "target": "com.amazonaws.ec2#CurrencyCodeValues", + "traits": { + "aws.protocols#ec2QueryName": "CurrencyCode", + "smithy.api#documentation": "

The currency for transacting the Reserved Instance resale.\n\t\t\t\tAt this time, the only supported currency is USD.

", + "smithy.api#xmlName": "currencyCode" + } + }, + "Price": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "Price", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The fixed price for the term.

", + "smithy.api#xmlName": "price" + } + }, + "Term": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "Term", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", + "smithy.api#xmlName": "term" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the price for a Reserved Instance.

" + } + }, + "com.amazonaws.ec2#PriceScheduleList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PriceSchedule", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PriceScheduleSpecification": { + "type": "structure", + "members": { + "CurrencyCode": { + "target": "com.amazonaws.ec2#CurrencyCodeValues", + "traits": { + "aws.protocols#ec2QueryName": "CurrencyCode", + "smithy.api#documentation": "

The currency for transacting the Reserved Instance resale.\n\t\t\t\tAt this time, the only supported currency is USD.

", + "smithy.api#xmlName": "currencyCode" + } + }, + "Price": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "Price", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The fixed price for the term.

", + "smithy.api#xmlName": "price" + } + }, + "Term": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "Term", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", + "smithy.api#xmlName": "term" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the price for a Reserved Instance.

" + } + }, + "com.amazonaws.ec2#PriceScheduleSpecificationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PriceScheduleSpecification", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PricingDetail": { + "type": "structure", + "members": { + "Count": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Count", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of reservations available for the price.

", + "smithy.api#xmlName": "count" + } + }, + "Price": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "Price", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The price per instance.

", + "smithy.api#xmlName": "price" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Reserved Instance offering.

" + } + }, + "com.amazonaws.ec2#PricingDetailsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PricingDetail", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PrincipalIdFormat": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Arn", + "smithy.api#documentation": "

PrincipalIdFormatARN description

", + "smithy.api#xmlName": "arn" + } + }, + "Statuses": { + "target": "com.amazonaws.ec2#IdFormatList", + "traits": { + "aws.protocols#ec2QueryName": "StatusSet", + "smithy.api#documentation": "

PrincipalIdFormatStatuses description

", + "smithy.api#xmlName": "statusSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

PrincipalIdFormat description

" + } + }, + "com.amazonaws.ec2#PrincipalIdFormatList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PrincipalIdFormat", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PrincipalType": { + "type": "enum", + "members": { + "All": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "All" + } + }, + "Service": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Service" + } + }, + "OrganizationUnit": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OrganizationUnit" + } + }, + "Account": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Account" + } + }, + "User": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "User" + } + }, + "Role": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Role" + } + } + } + }, + "com.amazonaws.ec2#Priority": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": -1, + "max": 65535 + } + } + }, + "com.amazonaws.ec2#PrivateDnsDetails": { + "type": "structure", + "members": { + "PrivateDnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDnsName", + "smithy.api#documentation": "

The private DNS name assigned to the VPC endpoint service.

", + "smithy.api#xmlName": "privateDnsName" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the Private DNS name for interface endpoints.

" + } + }, + "com.amazonaws.ec2#PrivateDnsDetailsSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PrivateDnsDetails", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PrivateDnsNameConfiguration": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.ec2#DnsNameState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The verification state of the VPC endpoint service.

\n

>Consumers\n of the endpoint service can use the private name only when the state is\n verified.

", + "smithy.api#xmlName": "state" + } + }, + "Type": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The endpoint service verification type, for example TXT.

", + "smithy.api#xmlName": "type" + } + }, + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#documentation": "

The value the service provider adds to the private DNS name domain record before verification.

", + "smithy.api#xmlName": "value" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The name of the record subdomain the service provider needs to create. The service provider adds the value text to the name.

", + "smithy.api#xmlName": "name" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the private DNS name for the service endpoint.

" + } + }, + "com.amazonaws.ec2#PrivateDnsNameOptionsOnLaunch": { + "type": "structure", + "members": { + "HostnameType": { + "target": "com.amazonaws.ec2#HostnameType", + "traits": { + "aws.protocols#ec2QueryName": "HostnameType", + "smithy.api#documentation": "

The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name\n must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name\n must be based on the instance ID. For dual-stack subnets, you can specify whether DNS\n names use the instance IPv4 address or the instance ID.

", + "smithy.api#xmlName": "hostnameType" + } + }, + "EnableResourceNameDnsARecord": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnableResourceNameDnsARecord", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS A\n records.

", + "smithy.api#xmlName": "enableResourceNameDnsARecord" + } + }, + "EnableResourceNameDnsAAAARecord": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnableResourceNameDnsAAAARecord", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostname with DNS AAAA\n records.

", + "smithy.api#xmlName": "enableResourceNameDnsAAAARecord" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the options for instance hostnames.

" + } + }, + "com.amazonaws.ec2#PrivateDnsNameOptionsRequest": { + "type": "structure", + "members": { + "HostnameType": { + "target": "com.amazonaws.ec2#HostnameType", + "traits": { + "smithy.api#documentation": "

The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name\n must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name\n must be based on the instance ID. For dual-stack subnets, you can specify whether DNS\n names use the instance IPv4 address or the instance ID.

" + } + }, + "EnableResourceNameDnsARecord": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS A\n records.

" + } + }, + "EnableResourceNameDnsAAAARecord": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA\n records.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the options for instance hostnames.

" + } + }, + "com.amazonaws.ec2#PrivateDnsNameOptionsResponse": { + "type": "structure", + "members": { + "HostnameType": { + "target": "com.amazonaws.ec2#HostnameType", + "traits": { + "aws.protocols#ec2QueryName": "HostnameType", + "smithy.api#documentation": "

The type of hostname to assign to an instance.

", + "smithy.api#xmlName": "hostnameType" + } + }, + "EnableResourceNameDnsARecord": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnableResourceNameDnsARecord", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS A\n records.

", + "smithy.api#xmlName": "enableResourceNameDnsARecord" + } + }, + "EnableResourceNameDnsAAAARecord": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnableResourceNameDnsAAAARecord", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA\n records.

", + "smithy.api#xmlName": "enableResourceNameDnsAAAARecord" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the options for instance hostnames.

" + } + }, + "com.amazonaws.ec2#PrivateIpAddressConfigSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ScheduledInstancesPrivateIpAddressConfig", + "traits": { + "smithy.api#xmlName": "PrivateIpAddressConfigSet" + } + } + }, + "com.amazonaws.ec2#PrivateIpAddressCount": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 31 + } + } + }, + "com.amazonaws.ec2#PrivateIpAddressSpecification": { + "type": "structure", + "members": { + "Primary": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Primary", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the private IPv4 address is the primary private IPv4 address. Only\n one IPv4 address can be designated as primary.

", + "smithy.api#xmlName": "primary" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

The private IPv4 address.

", + "smithy.api#xmlName": "privateIpAddress" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a secondary private IPv4 address for a network interface.

" + } + }, + "com.amazonaws.ec2#PrivateIpAddressSpecificationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PrivateIpAddressSpecification", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PrivateIpAddressStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "PrivateIpAddress" + } + } + }, + "com.amazonaws.ec2#ProcessorInfo": { + "type": "structure", + "members": { + "SupportedArchitectures": { + "target": "com.amazonaws.ec2#ArchitectureTypeList", + "traits": { + "aws.protocols#ec2QueryName": "SupportedArchitectures", + "smithy.api#documentation": "

The architectures supported by the instance type.

", + "smithy.api#xmlName": "supportedArchitectures" + } + }, + "SustainedClockSpeedInGhz": { + "target": "com.amazonaws.ec2#ProcessorSustainedClockSpeed", + "traits": { + "aws.protocols#ec2QueryName": "SustainedClockSpeedInGhz", + "smithy.api#documentation": "

The speed of the processor, in GHz.

", + "smithy.api#xmlName": "sustainedClockSpeedInGhz" + } + }, + "SupportedFeatures": { + "target": "com.amazonaws.ec2#SupportedAdditionalProcessorFeatureList", + "traits": { + "aws.protocols#ec2QueryName": "SupportedFeatures", + "smithy.api#documentation": "

Indicates whether the instance type supports AMD SEV-SNP. If the request returns \n amd-sev-snp, AMD SEV-SNP is supported. Otherwise, it is not supported.

", + "smithy.api#xmlName": "supportedFeatures" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the processor used by the instance type.

" + } + }, + "com.amazonaws.ec2#ProcessorSustainedClockSpeed": { + "type": "double" + }, + "com.amazonaws.ec2#ProductCode": { + "type": "structure", + "members": { + "ProductCodeId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ProductCode", + "smithy.api#documentation": "

The product code.

", + "smithy.api#xmlName": "productCode" + } + }, + "ProductCodeType": { + "target": "com.amazonaws.ec2#ProductCodeValues", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The type of product code.

", + "smithy.api#xmlName": "type" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a product code.

" + } + }, + "com.amazonaws.ec2#ProductCodeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ProductCode", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ProductCodeStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "ProductCode" + } + } + }, + "com.amazonaws.ec2#ProductCodeValues": { + "type": "enum", + "members": { + "devpay": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "devpay" + } + }, + "marketplace": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "marketplace" + } + } + } + }, + "com.amazonaws.ec2#ProductDescriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String" + } + }, + "com.amazonaws.ec2#PropagatingVgw": { + "type": "structure", + "members": { + "GatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GatewayId", + "smithy.api#documentation": "

The ID of the virtual private gateway.

", + "smithy.api#xmlName": "gatewayId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a virtual private gateway propagating route.

" + } + }, + "com.amazonaws.ec2#PropagatingVgwList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PropagatingVgw", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Protocol": { + "type": "enum", + "members": { + "tcp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tcp" + } + }, + "udp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "udp" + } + } + } + }, + "com.amazonaws.ec2#ProtocolInt": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.ec2#ProtocolIntList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ProtocolInt", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ProtocolList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Protocol", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ProtocolValue": { + "type": "enum", + "members": { + "gre": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "gre" + } + } + } + }, + "com.amazonaws.ec2#ProvisionByoipCidr": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ProvisionByoipCidrRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ProvisionByoipCidrResult" + }, + "traits": { + "smithy.api#documentation": "

Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP \n addresses (BYOIP) and creates a corresponding address pool. After the address range is\n provisioned, it is ready to be advertised using AdvertiseByoipCidr.

\n

Amazon Web Services verifies that you own the address range and are authorized to advertise it. \n You must ensure that the address range is registered to you and that you created an \n RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. \n For more information, see Bring your own IP addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.

\n

Provisioning an address range is an asynchronous operation, so the call returns immediately,\n but the address range is not ready to use until its status changes from pending-provision\n to provisioned. To monitor the status of an address range, use DescribeByoipCidrs. \n To allocate an Elastic IP address from your IPv4 address pool, use AllocateAddress \n with either the specific address from the address pool or the ID of the address pool.

" + } + }, + "com.amazonaws.ec2#ProvisionByoipCidrRequest": { + "type": "structure", + "members": { + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 prefix that you can \n specify is /24. The most specific IPv6 prefix you can specify is /56. The address range cannot overlap with another address range that you've \n brought to this or another Region.

", + "smithy.api#required": {} + } + }, + "CidrAuthorizationContext": { + "target": "com.amazonaws.ec2#CidrAuthorizationContext", + "traits": { + "smithy.api#documentation": "

A signed document that proves that you are authorized to bring the specified IP address \n range to Amazon using BYOIP.

" + } + }, + "PubliclyAdvertisable": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

(IPv6 only) Indicate whether the address range will be publicly advertised to the\n internet.

\n

Default: true

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the address range and the address pool.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "PoolTagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the address pool.

", + "smithy.api#xmlName": "PoolTagSpecification" + } + }, + "MultiRegion": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Reserved.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ProvisionByoipCidrResult": { + "type": "structure", + "members": { + "ByoipCidr": { + "target": "com.amazonaws.ec2#ByoipCidr", + "traits": { + "aws.protocols#ec2QueryName": "ByoipCidr", + "smithy.api#documentation": "

Information about the address range.

", + "smithy.api#xmlName": "byoipCidr" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ProvisionIpamPoolCidr": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ProvisionIpamPoolCidrRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ProvisionIpamPoolCidrResult" + }, + "traits": { + "smithy.api#documentation": "

Provision a CIDR to an IPAM pool. You can use this action to provision new CIDRs to a top-level pool or to transfer a CIDR from a top-level pool to a pool within it.

\n

For more information, see Provision CIDRs to pools in the Amazon VPC IPAM User Guide.\n

" + } + }, + "com.amazonaws.ec2#ProvisionIpamPoolCidrRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the IPAM pool to which you want to assign a CIDR.

", + "smithy.api#required": {} + } + }, + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The CIDR you want to assign to the IPAM pool. Either \"NetmaskLength\" or \"Cidr\" is required. This value will be null if you specify \"NetmaskLength\" and will be filled in during the provisioning process.

" + } + }, + "CidrAuthorizationContext": { + "target": "com.amazonaws.ec2#IpamCidrAuthorizationContext", + "traits": { + "smithy.api#documentation": "

A signed document that proves that you are authorized to bring a specified IP address range to Amazon using BYOIP. This option applies to public pools only.

" + } + }, + "NetmaskLength": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The netmask length of the CIDR you'd like to provision to a pool. Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. Either \"NetmaskLength\" or \"Cidr\" is required.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ProvisionIpamPoolCidrResult": { + "type": "structure", + "members": { + "IpamPoolCidr": { + "target": "com.amazonaws.ec2#IpamPoolCidr", + "traits": { + "aws.protocols#ec2QueryName": "IpamPoolCidr", + "smithy.api#documentation": "

Information about the provisioned CIDR.

", + "smithy.api#xmlName": "ipamPoolCidr" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ProvisionPublicIpv4PoolCidr": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ProvisionPublicIpv4PoolCidrRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ProvisionPublicIpv4PoolCidrResult" + }, + "traits": { + "smithy.api#documentation": "

Provision a CIDR to a public IPv4 pool.

\n

For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.

" + } + }, + "com.amazonaws.ec2#ProvisionPublicIpv4PoolCidrRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the IPAM pool you would like to use to allocate this CIDR.

", + "smithy.api#required": {} + } + }, + "PoolId": { + "target": "com.amazonaws.ec2#Ipv4PoolEc2Id", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the public IPv4 pool you would like to use for this CIDR.

", + "smithy.api#required": {} + } + }, + "NetmaskLength": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The netmask length of the CIDR you would like to allocate to the public IPv4 pool.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ProvisionPublicIpv4PoolCidrResult": { + "type": "structure", + "members": { + "PoolId": { + "target": "com.amazonaws.ec2#Ipv4PoolEc2Id", + "traits": { + "aws.protocols#ec2QueryName": "PoolId", + "smithy.api#documentation": "

The ID of the pool that you want to provision the CIDR to.

", + "smithy.api#xmlName": "poolId" + } + }, + "PoolAddressRange": { + "target": "com.amazonaws.ec2#PublicIpv4PoolRange", + "traits": { + "aws.protocols#ec2QueryName": "PoolAddressRange", + "smithy.api#documentation": "

Information about the address range of the public IPv4 pool.

", + "smithy.api#xmlName": "poolAddressRange" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ProvisionedBandwidth": { + "type": "structure", + "members": { + "ProvisionTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "ProvisionTime", + "smithy.api#documentation": "

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", + "smithy.api#xmlName": "provisionTime" + } + }, + "Provisioned": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Provisioned", + "smithy.api#documentation": "

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", + "smithy.api#xmlName": "provisioned" + } + }, + "RequestTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "RequestTime", + "smithy.api#documentation": "

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", + "smithy.api#xmlName": "requestTime" + } + }, + "Requested": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Requested", + "smithy.api#documentation": "

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", + "smithy.api#xmlName": "requested" + } + }, + "Status": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#documentation": "

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

" + } + }, + "com.amazonaws.ec2#PtrUpdateStatus": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#documentation": "

The value for the PTR record update.

", + "smithy.api#xmlName": "value" + } + }, + "Status": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status of the PTR record update.

", + "smithy.api#xmlName": "status" + } + }, + "Reason": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Reason", + "smithy.api#documentation": "

The reason for the PTR record update.

", + "smithy.api#xmlName": "reason" + } + } + }, + "traits": { + "smithy.api#documentation": "

The status of an updated pointer (PTR) record for an Elastic IP address.

" + } + }, + "com.amazonaws.ec2#PublicIpAddress": { + "type": "string" + }, + "com.amazonaws.ec2#PublicIpStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "PublicIp" + } + } + }, + "com.amazonaws.ec2#PublicIpv4Pool": { + "type": "structure", + "members": { + "PoolId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PoolId", + "smithy.api#documentation": "

The ID of the address pool.

", + "smithy.api#xmlName": "poolId" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the address pool.

", + "smithy.api#xmlName": "description" + } + }, + "PoolAddressRanges": { + "target": "com.amazonaws.ec2#PublicIpv4PoolRangeSet", + "traits": { + "aws.protocols#ec2QueryName": "PoolAddressRangeSet", + "smithy.api#documentation": "

The address ranges.

", + "smithy.api#xmlName": "poolAddressRangeSet" + } + }, + "TotalAddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TotalAddressCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of addresses.

", + "smithy.api#xmlName": "totalAddressCount" + } + }, + "TotalAvailableAddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TotalAvailableAddressCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of available addresses.

", + "smithy.api#xmlName": "totalAvailableAddressCount" + } + }, + "NetworkBorderGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkBorderGroup", + "smithy.api#documentation": "

The name of the location from which the address pool is advertised. \n A network border group is a unique set of Availability Zones or Local Zones \n from where Amazon Web Services advertises public IP addresses.

", + "smithy.api#xmlName": "networkBorderGroup" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags for the address pool.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an IPv4 address pool.

" + } + }, + "com.amazonaws.ec2#PublicIpv4PoolIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Ipv4PoolEc2Id", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PublicIpv4PoolRange": { + "type": "structure", + "members": { + "FirstAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "FirstAddress", + "smithy.api#documentation": "

The first IP address in the range.

", + "smithy.api#xmlName": "firstAddress" + } + }, + "LastAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LastAddress", + "smithy.api#documentation": "

The last IP address in the range.

", + "smithy.api#xmlName": "lastAddress" + } + }, + "AddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "AddressCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of addresses in the range.

", + "smithy.api#xmlName": "addressCount" + } + }, + "AvailableAddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "AvailableAddressCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of available addresses in the range.

", + "smithy.api#xmlName": "availableAddressCount" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an address range of an IPv4 address pool.

" + } + }, + "com.amazonaws.ec2#PublicIpv4PoolRangeSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PublicIpv4PoolRange", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PublicIpv4PoolSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PublicIpv4Pool", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Purchase": { + "type": "structure", + "members": { + "CurrencyCode": { + "target": "com.amazonaws.ec2#CurrencyCodeValues", + "traits": { + "aws.protocols#ec2QueryName": "CurrencyCode", + "smithy.api#documentation": "

The currency in which the UpfrontPrice and HourlyPrice\n amounts are specified. At this time, the only supported currency is\n USD.

", + "smithy.api#xmlName": "currencyCode" + } + }, + "Duration": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Duration", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The duration of the reservation's term in seconds.

", + "smithy.api#xmlName": "duration" + } + }, + "HostIdSet": { + "target": "com.amazonaws.ec2#ResponseHostIdSet", + "traits": { + "aws.protocols#ec2QueryName": "HostIdSet", + "smithy.api#documentation": "

The IDs of the Dedicated Hosts associated with the reservation.

", + "smithy.api#xmlName": "hostIdSet" + } + }, + "HostReservationId": { + "target": "com.amazonaws.ec2#HostReservationId", + "traits": { + "aws.protocols#ec2QueryName": "HostReservationId", + "smithy.api#documentation": "

The ID of the reservation.

", + "smithy.api#xmlName": "hostReservationId" + } + }, + "HourlyPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "HourlyPrice", + "smithy.api#documentation": "

The hourly price of the reservation per hour.

", + "smithy.api#xmlName": "hourlyPrice" + } + }, + "InstanceFamily": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceFamily", + "smithy.api#documentation": "

The instance family on the Dedicated Host that the reservation can be associated\n with.

", + "smithy.api#xmlName": "instanceFamily" + } + }, + "PaymentOption": { + "target": "com.amazonaws.ec2#PaymentOption", + "traits": { + "aws.protocols#ec2QueryName": "PaymentOption", + "smithy.api#documentation": "

The payment option for the reservation.

", + "smithy.api#xmlName": "paymentOption" + } + }, + "UpfrontPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UpfrontPrice", + "smithy.api#documentation": "

The upfront price of the reservation.

", + "smithy.api#xmlName": "upfrontPrice" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the result of the purchase.

" + } + }, + "com.amazonaws.ec2#PurchaseHostReservation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#PurchaseHostReservationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#PurchaseHostReservationResult" + }, + "traits": { + "smithy.api#documentation": "

Purchase a reservation with configurations that match those of your Dedicated Host.\n You must have active Dedicated Hosts in your account before you purchase a reservation.\n This action results in the specified reservation being purchased and charged to your\n account.

" + } + }, + "com.amazonaws.ec2#PurchaseHostReservationRequest": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

" + } + }, + "CurrencyCode": { + "target": "com.amazonaws.ec2#CurrencyCodeValues", + "traits": { + "smithy.api#documentation": "

The currency in which the totalUpfrontPrice, LimitPrice, and\n totalHourlyPrice amounts are specified. At this time, the only\n supported currency is USD.

" + } + }, + "HostIdSet": { + "target": "com.amazonaws.ec2#RequestHostIdSet", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the Dedicated Hosts with which the reservation will be associated.

", + "smithy.api#required": {} + } + }, + "LimitPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The specified limit is checked against the total upfront cost of the reservation\n (calculated as the offering's upfront cost multiplied by the host count). If the total\n upfront cost is greater than the specified price limit, the request fails. This is used\n to ensure that the purchase does not exceed the expected upfront cost of the purchase.\n At this time, the only supported currency is USD. For example, to indicate\n a limit price of USD 100, specify 100.00.

" + } + }, + "OfferingId": { + "target": "com.amazonaws.ec2#OfferingId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the offering.

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the Dedicated Host Reservation during purchase.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#PurchaseHostReservationResult": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

", + "smithy.api#xmlName": "clientToken" + } + }, + "CurrencyCode": { + "target": "com.amazonaws.ec2#CurrencyCodeValues", + "traits": { + "aws.protocols#ec2QueryName": "CurrencyCode", + "smithy.api#documentation": "

The currency in which the totalUpfrontPrice and\n totalHourlyPrice amounts are specified. At this time, the only\n supported currency is USD.

", + "smithy.api#xmlName": "currencyCode" + } + }, + "Purchase": { + "target": "com.amazonaws.ec2#PurchaseSet", + "traits": { + "aws.protocols#ec2QueryName": "Purchase", + "smithy.api#documentation": "

Describes the details of the purchase.

", + "smithy.api#xmlName": "purchase" + } + }, + "TotalHourlyPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TotalHourlyPrice", + "smithy.api#documentation": "

The total hourly price of the reservation calculated per hour.

", + "smithy.api#xmlName": "totalHourlyPrice" + } + }, + "TotalUpfrontPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TotalUpfrontPrice", + "smithy.api#documentation": "

The total amount charged to your account when you purchase the reservation.

", + "smithy.api#xmlName": "totalUpfrontPrice" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#PurchaseRequest": { + "type": "structure", + "members": { + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of instances.

", + "smithy.api#required": {} + } + }, + "PurchaseToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The purchase token.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a request to purchase Scheduled Instances.

" + } + }, + "com.amazonaws.ec2#PurchaseRequestSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#PurchaseRequest", + "traits": { + "smithy.api#xmlName": "PurchaseRequest" + } + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.ec2#PurchaseReservedInstancesOffering": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#PurchaseReservedInstancesOfferingRequest" + }, + "output": { + "target": "com.amazonaws.ec2#PurchaseReservedInstancesOfferingResult" + }, + "traits": { + "smithy.api#documentation": "

Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower \n hourly rate compared to On-Demand instance pricing.

\n

Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings \n\t\t\tthat match your specifications. After you've purchased a Reserved Instance, you can check for your\n\t\t\tnew Reserved Instance with DescribeReservedInstances.

\n

To queue a purchase for a future date and time, specify a purchase time. If you do not specify a\n purchase time, the default is the current time.

\n

For more information, see Reserved Instances and \n \t Reserved Instance Marketplace \n \t in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#PurchaseReservedInstancesOfferingRequest": { + "type": "structure", + "members": { + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of Reserved Instances to purchase.

", + "smithy.api#required": {} + } + }, + "ReservedInstancesOfferingId": { + "target": "com.amazonaws.ec2#ReservedInstancesOfferingId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Reserved Instance offering to purchase.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "LimitPrice": { + "target": "com.amazonaws.ec2#ReservedInstanceLimitPrice", + "traits": { + "aws.protocols#ec2QueryName": "LimitPrice", + "smithy.api#documentation": "

Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.

", + "smithy.api#xmlName": "limitPrice" + } + }, + "PurchaseTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "smithy.api#documentation": "

The time at which to purchase the Reserved Instance, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for PurchaseReservedInstancesOffering.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#PurchaseReservedInstancesOfferingResult": { + "type": "structure", + "members": { + "ReservedInstancesId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesId", + "smithy.api#documentation": "

The IDs of the purchased Reserved Instances. If your purchase crosses into a discounted\n pricing tier, the final Reserved Instances IDs might change. For more information, see Crossing\n pricing tiers in the Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#xmlName": "reservedInstancesId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of PurchaseReservedInstancesOffering.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#PurchaseScheduledInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#PurchaseScheduledInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#PurchaseScheduledInstancesResult" + }, + "traits": { + "smithy.api#documentation": "\n

You can no longer purchase Scheduled Instances.

\n \n

Purchases the Scheduled Instances with the specified schedule.

\n

Scheduled Instances enable you to purchase Amazon EC2 compute capacity by the hour for a one-year term.\n Before you can purchase a Scheduled Instance, you must call DescribeScheduledInstanceAvailability\n to check for available schedules and obtain a purchase token. After you purchase a Scheduled Instance,\n you must call RunScheduledInstances during each scheduled time period.

\n

After you purchase a Scheduled Instance, you can't cancel, modify, or resell your purchase.

" + } + }, + "com.amazonaws.ec2#PurchaseScheduledInstancesRequest": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that ensures the idempotency of the request. \n For more information, see Ensuring Idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "PurchaseRequests": { + "target": "com.amazonaws.ec2#PurchaseRequestSet", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The purchase requests.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "PurchaseRequest" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for PurchaseScheduledInstances.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#PurchaseScheduledInstancesResult": { + "type": "structure", + "members": { + "ScheduledInstanceSet": { + "target": "com.amazonaws.ec2#PurchasedScheduledInstanceSet", + "traits": { + "aws.protocols#ec2QueryName": "ScheduledInstanceSet", + "smithy.api#documentation": "

Information about the Scheduled Instances.

", + "smithy.api#xmlName": "scheduledInstanceSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of PurchaseScheduledInstances.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#PurchaseSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Purchase", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#PurchasedScheduledInstanceSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ScheduledInstance", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#RIProductDescription": { + "type": "enum", + "members": { + "Linux_UNIX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Linux/UNIX" + } + }, + "Linux_UNIX_Amazon_VPC_": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Linux/UNIX (Amazon VPC)" + } + }, + "Windows": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Windows" + } + }, + "Windows_Amazon_VPC_": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Windows (Amazon VPC)" + } + } + } + }, + "com.amazonaws.ec2#RamdiskId": { + "type": "string" + }, + "com.amazonaws.ec2#ReasonCodesList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ReportInstanceReasonCodes", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#RebootInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RebootInstancesRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Requests a reboot of the specified instances. This operation is asynchronous; it only\n queues a request to reboot the specified instances. The operation succeeds if the\n instances are valid and belong to you. Requests to reboot terminated instances are\n ignored.

\n

If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a\n hard reboot.

\n

For more information about troubleshooting, see Troubleshoot an unreachable\n instance in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#RebootInstancesRequest": { + "type": "structure", + "members": { + "InstanceIds": { + "target": "com.amazonaws.ec2#InstanceIdStringList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The instance IDs.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "InstanceId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RecurringCharge": { + "type": "structure", + "members": { + "Amount": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "Amount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount of the recurring charge.

", + "smithy.api#xmlName": "amount" + } + }, + "Frequency": { + "target": "com.amazonaws.ec2#RecurringChargeFrequency", + "traits": { + "aws.protocols#ec2QueryName": "Frequency", + "smithy.api#documentation": "

The frequency of the recurring charge.

", + "smithy.api#xmlName": "frequency" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a recurring charge.

" + } + }, + "com.amazonaws.ec2#RecurringChargeFrequency": { + "type": "enum", + "members": { + "Hourly": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Hourly" + } + } + } + }, + "com.amazonaws.ec2#RecurringChargesList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RecurringCharge", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ReferencedSecurityGroup": { + "type": "structure", + "members": { + "GroupId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The ID of the security group.

", + "smithy.api#xmlName": "groupId" + } + }, + "PeeringStatus": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PeeringStatus", + "smithy.api#documentation": "

The status of a VPC peering connection, if applicable.

", + "smithy.api#xmlName": "peeringStatus" + } + }, + "UserId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UserId", + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#xmlName": "userId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } + }, + "VpcPeeringConnectionId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", + "smithy.api#documentation": "

The ID of the VPC peering connection.

", + "smithy.api#xmlName": "vpcPeeringConnectionId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the security group that is referenced in the security group rule.

" + } + }, + "com.amazonaws.ec2#Region": { + "type": "structure", + "members": { + "Endpoint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RegionEndpoint", + "smithy.api#documentation": "

The Region service endpoint.

", + "smithy.api#xmlName": "regionEndpoint" + } + }, + "RegionName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RegionName", + "smithy.api#documentation": "

The name of the Region.

", + "smithy.api#xmlName": "regionName" + } + }, + "OptInStatus": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OptInStatus", + "smithy.api#documentation": "

The Region opt-in status. The possible values are opt-in-not-required, opted-in, and \n not-opted-in.

", + "smithy.api#xmlName": "optInStatus" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Region.

" + } + }, + "com.amazonaws.ec2#RegionList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Region", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#RegionNameStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "RegionName" + } + } + }, + "com.amazonaws.ec2#RegionNames": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.ec2#RegisterImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RegisterImageRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RegisterImageResult" + }, + "traits": { + "smithy.api#documentation": "

Registers an AMI. When you're creating an AMI, this is the final step you must complete\n before you can launch an instance from the AMI. For more information about creating AMIs, see\n Create your\n own AMI in the Amazon Elastic Compute Cloud User Guide.

\n \n

For Amazon EBS-backed instances, CreateImage creates and registers the AMI\n in a single request, so you don't have to register the AMI yourself. We recommend that you\n always use CreateImage unless you have a specific reason to use\n RegisterImage.

\n \n

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. \n If you make changes to an image, deregister the previous image and register the new image.

\n

\n Register a snapshot of a root device volume\n

\n

You can use RegisterImage to create an Amazon EBS-backed Linux AMI from\n a snapshot of a root device volume. You specify the snapshot using a block device mapping.\n You can't set the encryption state of the volume using the block device mapping. If the \n snapshot is encrypted, or encryption by default is enabled, the root volume of an instance \n launched from the AMI is encrypted.

\n

For more information, see Create a Linux AMI from a snapshot and Use encryption with Amazon EBS-backed AMIs\n in the Amazon Elastic Compute Cloud User Guide.

\n

\n Amazon Web Services Marketplace product codes\n

\n

If any snapshots have Amazon Web Services Marketplace product codes, they are copied to the new\n AMI.

\n

Windows and some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE\n Linux Enterprise Server (SLES), use the Amazon EC2 billing product code associated with an AMI to\n verify the subscription status for package updates. To create a new AMI for operating systems\n that require a billing product code, instead of registering the AMI, do the following to\n preserve the billing product code association:

\n
    \n
  1. \n

    Launch an instance from an existing AMI with that billing product code.

    \n
    2. \n
  2. \n

    Customize the instance.

    \n
    3. \n
  3. \n

    Create an AMI from the instance using CreateImage.

    \n
    4. \n
\n

If you purchase a Reserved Instance to apply to an On-Demand Instance that was launched\n from an AMI with a billing product code, make sure that the Reserved Instance has the matching\n billing product code. If you purchase a Reserved Instance without the matching billing product\n code, the Reserved Instance will not be applied to the On-Demand Instance. For information\n about how to obtain the platform details and billing information of an AMI, see Understand AMI\n billing information in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#RegisterImageRequest": { + "type": "structure", + "members": { + "ImageLocation": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the \n \t\taws-exec-read canned access control list (ACL) to ensure that it can be accessed \n \t\tby Amazon EC2. For more information, see Canned ACLs in the \n \t\tAmazon S3 Service Developer Guide.

" + } + }, + "Architecture": { + "target": "com.amazonaws.ec2#ArchitectureValues", + "traits": { + "aws.protocols#ec2QueryName": "Architecture", + "smithy.api#documentation": "

The architecture of the AMI.

\n

Default: For Amazon EBS-backed AMIs, i386.\n For instance store-backed AMIs, the architecture specified in the manifest file.

", + "smithy.api#xmlName": "architecture" + } + }, + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#BlockDeviceMappingRequestList", + "traits": { + "smithy.api#documentation": "

The block device mapping entries.

\n

If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can't specify the encryption state of the volume.

\n

If you create an AMI on an Outpost, then all backing snapshots must be on the same\n Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can\n be used to launch instances on the same Outpost only. For more information, Amazon EBS local\n snapshots on Outposts in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "BlockDeviceMapping" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for your AMI.

", + "smithy.api#xmlName": "description" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "EnaSupport": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnaSupport", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.

\n

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

", + "smithy.api#xmlName": "enaSupport" + } + }, + "KernelId": { + "target": "com.amazonaws.ec2#KernelId", + "traits": { + "aws.protocols#ec2QueryName": "KernelId", + "smithy.api#documentation": "

The ID of the kernel.

", + "smithy.api#xmlName": "kernelId" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A name for your AMI.

\n

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", + "smithy.api#required": {}, + "smithy.api#xmlName": "name" + } + }, + "BillingProducts": { + "target": "com.amazonaws.ec2#BillingProductList", + "traits": { + "smithy.api#documentation": "

The billing product codes. Your account must be authorized to specify billing product codes.

\n

If your account is not authorized to specify billing product codes, you can publish AMIs\n that include billable software and list them on the Amazon Web Services Marketplace. You must first register as a seller\n on the Amazon Web Services Marketplace. For more information, see Getting started as a\n seller and AMI-based\n products in the Amazon Web Services Marketplace Seller Guide.

", + "smithy.api#xmlName": "BillingProduct" + } + }, + "RamdiskId": { + "target": "com.amazonaws.ec2#RamdiskId", + "traits": { + "aws.protocols#ec2QueryName": "RamdiskId", + "smithy.api#documentation": "

The ID of the RAM disk.

", + "smithy.api#xmlName": "ramdiskId" + } + }, + "RootDeviceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RootDeviceName", + "smithy.api#documentation": "

The device name of the root device volume (for example, /dev/sda1).

", + "smithy.api#xmlName": "rootDeviceName" + } + }, + "SriovNetSupport": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SriovNetSupport", + "smithy.api#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.

\n

There is no way to disable sriovNetSupport at this time.

\n

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

", + "smithy.api#xmlName": "sriovNetSupport" + } + }, + "VirtualizationType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VirtualizationType", + "smithy.api#documentation": "

The type of virtualization (hvm | paravirtual).

\n

Default: paravirtual\n

", + "smithy.api#xmlName": "virtualizationType" + } + }, + "BootMode": { + "target": "com.amazonaws.ec2#BootModeValues", + "traits": { + "smithy.api#documentation": "

The boot mode of the AMI. A value of uefi-preferred indicates that the AMI supports both UEFI and Legacy BIOS.

\n \n

The operating system contained in the AMI must be configured to support the specified boot mode.

\n \n

For more information, see Boot modes in the\n Amazon EC2 User Guide.

" + } + }, + "TpmSupport": { + "target": "com.amazonaws.ec2#TpmSupportValues", + "traits": { + "smithy.api#documentation": "

Set to v2.0 to enable Trusted Platform Module (TPM) support. For more\n information, see NitroTPM in the Amazon EC2 User Guide.

" + } + }, + "UefiData": { + "target": "com.amazonaws.ec2#StringType", + "traits": { + "smithy.api#documentation": "

Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data,\n use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the\n python-uefivars tool on\n GitHub. For more information, see UEFI Secure Boot in the\n Amazon EC2 User Guide.

" + } + }, + "ImdsSupport": { + "target": "com.amazonaws.ec2#ImdsSupportValues", + "traits": { + "smithy.api#documentation": "

Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances\n launched from this AMI will have HttpTokens automatically set to\n required so that, by default, the instance requires that IMDSv2 is used when\n requesting instance metadata. In addition, HttpPutResponseHopLimit is set to\n 2. For more information, see Configure\n the AMI in the Amazon EC2 User Guide.

\n \n

If you set the value to v2.0, make sure that your AMI software can support IMDSv2.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for RegisterImage.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RegisterImageResult": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the newly registered AMI.

", + "smithy.api#xmlName": "imageId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of RegisterImage.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#RegisterInstanceEventNotificationAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RegisterInstanceEventNotificationAttributesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RegisterInstanceEventNotificationAttributesResult" + }, + "traits": { + "smithy.api#documentation": "

Registers a set of tag keys to include in scheduled event notifications for your resources. \n \t\t

\n

To remove tags, use DeregisterInstanceEventNotificationAttributes.

" + } + }, + "com.amazonaws.ec2#RegisterInstanceEventNotificationAttributesRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "InstanceTagAttribute": { + "target": "com.amazonaws.ec2#RegisterInstanceTagAttributeRequest", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Information about the tag keys to register.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RegisterInstanceEventNotificationAttributesResult": { + "type": "structure", + "members": { + "InstanceTagAttribute": { + "target": "com.amazonaws.ec2#InstanceTagNotificationAttribute", + "traits": { + "aws.protocols#ec2QueryName": "InstanceTagAttribute", + "smithy.api#documentation": "

The resulting set of tag keys.

", + "smithy.api#xmlName": "instanceTagAttribute" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#RegisterInstanceTagAttributeRequest": { + "type": "structure", + "members": { + "IncludeAllTagsOfInstance": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to register all tag keys in the current Region. Specify true \n \tto register all tag keys.

" + } + }, + "InstanceTagKeys": { + "target": "com.amazonaws.ec2#InstanceTagKeySet", + "traits": { + "smithy.api#documentation": "

The tag keys to register.

", + "smithy.api#xmlName": "InstanceTagKey" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the tag keys to register for the current Region. You can either specify \n \tindividual tag keys or register all tag keys in the current Region. You must specify either\n \tIncludeAllTagsOfInstance or InstanceTagKeys in the request

" + } + }, + "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupMembers": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupMembersRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupMembersResult" + }, + "traits": { + "smithy.api#documentation": "

Registers members (network interfaces) with the transit gateway multicast group. A member is a network interface associated\n with a supported EC2 instance that receives multicast traffic. For information about\n supported instances, see Multicast\n Consideration in Amazon VPC Transit Gateways.

\n

After you add the members, use SearchTransitGatewayMulticastGroups to verify that the members were added\n to the transit gateway multicast group.

" + } + }, + "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupMembersRequest": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", + "smithy.api#required": {} + } + }, + "GroupIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

" + } + }, + "NetworkInterfaceIds": { + "target": "com.amazonaws.ec2#TransitGatewayNetworkInterfaceIdList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The group members' network interface IDs to register with the transit gateway multicast group.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupMembersResult": { + "type": "structure", + "members": { + "RegisteredMulticastGroupMembers": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastRegisteredGroupMembers", + "traits": { + "aws.protocols#ec2QueryName": "RegisteredMulticastGroupMembers", + "smithy.api#documentation": "

Information about the registered transit gateway multicast group members.

", + "smithy.api#xmlName": "registeredMulticastGroupMembers" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupSources": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupSourcesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupSourcesResult" + }, + "traits": { + "smithy.api#documentation": "

Registers sources (network interfaces) with the specified transit gateway multicast group.

\n

A multicast source is a network interface attached to a supported instance that sends\n multicast traffic. For information about supported instances, see Multicast\n Considerations in Amazon VPC Transit Gateways.

\n

After you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast\n group.

" + } + }, + "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupSourcesRequest": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", + "smithy.api#required": {} + } + }, + "GroupIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

" + } + }, + "NetworkInterfaceIds": { + "target": "com.amazonaws.ec2#TransitGatewayNetworkInterfaceIdList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The group sources' network interface IDs to register with the transit gateway multicast group.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupSourcesResult": { + "type": "structure", + "members": { + "RegisteredMulticastGroupSources": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastRegisteredGroupSources", + "traits": { + "aws.protocols#ec2QueryName": "RegisteredMulticastGroupSources", + "smithy.api#documentation": "

Information about the transit gateway multicast group sources.

", + "smithy.api#xmlName": "registeredMulticastGroupSources" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#RejectTransitGatewayMulticastDomainAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RejectTransitGatewayMulticastDomainAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RejectTransitGatewayMulticastDomainAssociationsResult" + }, + "traits": { + "smithy.api#documentation": "

Rejects a request to associate cross-account subnets with a transit gateway multicast domain.

" + } + }, + "com.amazonaws.ec2#RejectTransitGatewayMulticastDomainAssociationsRequest": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

" + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway attachment.

" + } + }, + "SubnetIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the subnets to associate with the transit gateway multicast domain.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RejectTransitGatewayMulticastDomainAssociationsResult": { + "type": "structure", + "members": { + "Associations": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainAssociations", + "traits": { + "aws.protocols#ec2QueryName": "Associations", + "smithy.api#documentation": "

Information about the multicast domain associations.

", + "smithy.api#xmlName": "associations" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#RejectTransitGatewayPeeringAttachment": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RejectTransitGatewayPeeringAttachmentRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RejectTransitGatewayPeeringAttachmentResult" + }, + "traits": { + "smithy.api#documentation": "

Rejects a transit gateway peering attachment request.

" + } + }, + "com.amazonaws.ec2#RejectTransitGatewayPeeringAttachmentRequest": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway peering attachment.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RejectTransitGatewayPeeringAttachmentResult": { + "type": "structure", + "members": { + "TransitGatewayPeeringAttachment": { + "target": "com.amazonaws.ec2#TransitGatewayPeeringAttachment", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayPeeringAttachment", + "smithy.api#documentation": "

The transit gateway peering attachment.

", + "smithy.api#xmlName": "transitGatewayPeeringAttachment" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#RejectTransitGatewayVpcAttachment": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RejectTransitGatewayVpcAttachmentRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RejectTransitGatewayVpcAttachmentResult" + }, + "traits": { + "smithy.api#documentation": "

Rejects a request to attach a VPC to a transit gateway.

\n

The VPC attachment must be in the pendingAcceptance state.\n Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests.\n Use AcceptTransitGatewayVpcAttachment to accept a VPC attachment request.

" + } + }, + "com.amazonaws.ec2#RejectTransitGatewayVpcAttachmentRequest": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RejectTransitGatewayVpcAttachmentResult": { + "type": "structure", + "members": { + "TransitGatewayVpcAttachment": { + "target": "com.amazonaws.ec2#TransitGatewayVpcAttachment", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayVpcAttachment", + "smithy.api#documentation": "

Information about the attachment.

", + "smithy.api#xmlName": "transitGatewayVpcAttachment" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#RejectVpcEndpointConnections": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RejectVpcEndpointConnectionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RejectVpcEndpointConnectionsResult" + }, + "traits": { + "smithy.api#documentation": "

Rejects VPC endpoint connection requests to your VPC endpoint service.

" + } + }, + "com.amazonaws.ec2#RejectVpcEndpointConnectionsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ServiceId": { + "target": "com.amazonaws.ec2#VpcEndpointServiceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the service.

", + "smithy.api#required": {} + } + }, + "VpcEndpointIds": { + "target": "com.amazonaws.ec2#VpcEndpointIdList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the VPC endpoints.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "VpcEndpointId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RejectVpcEndpointConnectionsResult": { + "type": "structure", + "members": { + "Unsuccessful": { + "target": "com.amazonaws.ec2#UnsuccessfulItemSet", + "traits": { + "aws.protocols#ec2QueryName": "Unsuccessful", + "smithy.api#documentation": "

Information about the endpoints that were not rejected, if applicable.

", + "smithy.api#xmlName": "unsuccessful" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#RejectVpcPeeringConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RejectVpcPeeringConnectionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RejectVpcPeeringConnectionResult" + }, + "traits": { + "smithy.api#documentation": "

Rejects a VPC peering connection request. The VPC peering connection must be in the\n\t\t\t\tpending-acceptance state. Use the DescribeVpcPeeringConnections request\n\t\t\tto view your outstanding VPC peering connection requests. To delete an active VPC peering\n\t\t\tconnection, or to delete a VPC peering connection request that you initiated, use\tDeleteVpcPeeringConnection.

" + } + }, + "com.amazonaws.ec2#RejectVpcPeeringConnectionRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "VpcPeeringConnectionId": { + "target": "com.amazonaws.ec2#VpcPeeringConnectionId", + "traits": { + "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC peering connection.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "vpcPeeringConnectionId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RejectVpcPeeringConnectionResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ReleaseAddress": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ReleaseAddressRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Releases the specified Elastic IP address.

\n

[Default VPC] Releasing an Elastic IP address automatically disassociates it\n\t\t\t\tfrom any instance that it's associated with. To disassociate an Elastic IP address without\n\t\t\t\treleasing it, use DisassociateAddress.

\n

[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address\n\t\t\t before you can release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).

\n

After releasing an Elastic IP address, it is released to the IP address pool. \n Be sure to update your DNS records and any servers or devices that communicate with the address. \n If you attempt to release an Elastic IP address that you already released, you'll get an\n AuthFailure error if the address is already allocated to another Amazon Web Services account.

\n

After you release an Elastic IP address, you might be able to recover it.\n For more information, see AllocateAddress.

" + } + }, + "com.amazonaws.ec2#ReleaseAddressRequest": { + "type": "structure", + "members": { + "AllocationId": { + "target": "com.amazonaws.ec2#AllocationId", + "traits": { + "smithy.api#documentation": "

The allocation ID. This parameter is required.

" + } + }, + "PublicIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Deprecated.

" + } + }, + "NetworkBorderGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises\n IP addresses.

\n

If you provide an incorrect network border group, you receive an InvalidAddress.NotFound error.

\n

You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you \n receive an InvalidParameterCombination error.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ReleaseHosts": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ReleaseHostsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ReleaseHostsResult" + }, + "traits": { + "smithy.api#documentation": "

When you no longer want to use an On-Demand Dedicated Host it can be released.\n On-Demand billing is stopped and the host goes into released state. The\n host ID of Dedicated Hosts that have been released can no longer be specified in another\n request, for example, to modify the host. You must stop or terminate all instances on a\n host before it can be released.

\n

When Dedicated Hosts are released, it may take some time for them to stop counting\n toward your limit and you may receive capacity errors when trying to allocate new\n Dedicated Hosts. Wait a few minutes and then try again.

\n

Released hosts still appear in a DescribeHosts response.

" + } + }, + "com.amazonaws.ec2#ReleaseHostsRequest": { + "type": "structure", + "members": { + "HostIds": { + "target": "com.amazonaws.ec2#RequestHostIdList", + "traits": { + "aws.protocols#ec2QueryName": "HostId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the Dedicated Hosts to release.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "hostId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ReleaseHostsResult": { + "type": "structure", + "members": { + "Successful": { + "target": "com.amazonaws.ec2#ResponseHostIdList", + "traits": { + "aws.protocols#ec2QueryName": "Successful", + "smithy.api#documentation": "

The IDs of the Dedicated Hosts that were successfully released.

", + "smithy.api#xmlName": "successful" + } + }, + "Unsuccessful": { + "target": "com.amazonaws.ec2#UnsuccessfulItemList", + "traits": { + "aws.protocols#ec2QueryName": "Unsuccessful", + "smithy.api#documentation": "

The IDs of the Dedicated Hosts that could not be released, including an error\n message.

", + "smithy.api#xmlName": "unsuccessful" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ReleaseIpamPoolAllocation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ReleaseIpamPoolAllocationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ReleaseIpamPoolAllocationResult" + }, + "traits": { + "smithy.api#documentation": "

Release an allocation within an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the Amazon Web Services Region where this IPAM pool is available for allocations. You can only use this action to release manual allocations. To remove an allocation for a resource without deleting the resource, set its monitored state to false using ModifyIpamResourceCidr. For more information, see Release an allocation in the Amazon VPC IPAM User Guide.\n

\n \n

All EC2 API actions follow an eventual consistency model.

\n " + } + }, + "com.amazonaws.ec2#ReleaseIpamPoolAllocationRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the IPAM pool which contains the allocation you want to release.

", + "smithy.api#required": {} + } + }, + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The CIDR of the allocation you want to release.

", + "smithy.api#required": {} + } + }, + "IpamPoolAllocationId": { + "target": "com.amazonaws.ec2#IpamPoolAllocationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the allocation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ReleaseIpamPoolAllocationResult": { + "type": "structure", + "members": { + "Success": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Success", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates if the release was successful.

", + "smithy.api#xmlName": "success" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#RemoveIpamOperatingRegion": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the operating Region you want to remove.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Remove an operating Region from an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

\n

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide\n

" + } + }, + "com.amazonaws.ec2#RemoveIpamOperatingRegionSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RemoveIpamOperatingRegion" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.ec2#RemovePrefixListEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RemovePrefixListEntry" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.ec2#RemovePrefixListEntry": { + "type": "structure", + "members": { + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The CIDR block.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An entry for a prefix list.

" + } + }, + "com.amazonaws.ec2#ReplaceIamInstanceProfileAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ReplaceIamInstanceProfileAssociationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ReplaceIamInstanceProfileAssociationResult" + }, + "traits": { + "smithy.api#documentation": "

Replaces an IAM instance profile for the specified running instance. You can use\n this action to change the IAM instance profile that's associated with an instance\n without having to disassociate the existing IAM instance profile first.

\n

Use DescribeIamInstanceProfileAssociations to get the association\n ID.

" + } + }, + "com.amazonaws.ec2#ReplaceIamInstanceProfileAssociationRequest": { + "type": "structure", + "members": { + "IamInstanceProfile": { + "target": "com.amazonaws.ec2#IamInstanceProfileSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IAM instance profile.

", + "smithy.api#required": {} + } + }, + "AssociationId": { + "target": "com.amazonaws.ec2#IamInstanceProfileAssociationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the existing IAM instance profile association.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ReplaceIamInstanceProfileAssociationResult": { + "type": "structure", + "members": { + "IamInstanceProfileAssociation": { + "target": "com.amazonaws.ec2#IamInstanceProfileAssociation", + "traits": { + "aws.protocols#ec2QueryName": "IamInstanceProfileAssociation", + "smithy.api#documentation": "

Information about the IAM instance profile association.

", + "smithy.api#xmlName": "iamInstanceProfileAssociation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ReplaceNetworkAclAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ReplaceNetworkAclAssociationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ReplaceNetworkAclAssociationResult" + }, + "traits": { + "smithy.api#documentation": "

Changes which network ACL a subnet is associated with. By default when you create a\n\t\t\tsubnet, it's automatically associated with the default network ACL. For more\n\t\t\tinformation, see Network\n\t\t\tACLs in the Amazon Virtual Private Cloud User Guide.

\n

This is an idempotent operation.

" + } + }, + "com.amazonaws.ec2#ReplaceNetworkAclAssociationRequest": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.ec2#NetworkAclAssociationId", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the current association between the original network ACL and the subnet.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "associationId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "NetworkAclId": { + "target": "com.amazonaws.ec2#NetworkAclId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkAclId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the new network ACL to associate with the subnet.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "networkAclId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ReplaceNetworkAclAssociationResult": { + "type": "structure", + "members": { + "NewAssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NewAssociationId", + "smithy.api#documentation": "

The ID of the new association.

", + "smithy.api#xmlName": "newAssociationId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ReplaceNetworkAclEntry": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ReplaceNetworkAclEntryRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#ReplaceNetworkAclEntryRequest": { + "type": "structure", + "members": { + "CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrBlock", + "smithy.api#documentation": "

The IPv4 network range to allow or deny, in CIDR notation (for example\n 172.16.0.0/24).

", + "smithy.api#xmlName": "cidrBlock" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Egress": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Egress", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to replace the egress rule.

\n

Default: If no value is specified, we replace the ingress rule.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "egress" + } + }, + "IcmpTypeCode": { + "target": "com.amazonaws.ec2#IcmpTypeCode", + "traits": { + "smithy.api#documentation": "

ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol\n\t\t 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.

", + "smithy.api#xmlName": "Icmp" + } + }, + "Ipv6CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrBlock", + "smithy.api#documentation": "

The IPv6 network range to allow or deny, in CIDR notation (for example\n 2001:bd8:1234:1a00::/64).

", + "smithy.api#xmlName": "ipv6CidrBlock" + } + }, + "NetworkAclId": { + "target": "com.amazonaws.ec2#NetworkAclId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkAclId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the ACL.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "networkAclId" + } + }, + "PortRange": { + "target": "com.amazonaws.ec2#PortRange", + "traits": { + "aws.protocols#ec2QueryName": "PortRange", + "smithy.api#documentation": "

TCP or UDP protocols: The range of ports the rule applies to. \n\t\t Required if specifying protocol 6 (TCP) or 17 (UDP).

", + "smithy.api#xmlName": "portRange" + } + }, + "Protocol": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Protocol", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The protocol number. A value of \"-1\" means all protocols. If you specify \"-1\" or a\n protocol number other than \"6\" (TCP), \"17\" (UDP), or \"1\" (ICMP), traffic on all ports is \n allowed, regardless of any ports or ICMP types or codes that you specify. If you specify \n protocol \"58\" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and \n codes allowed, regardless of any that you specify. If you specify protocol \"58\" (ICMPv6) \n and specify an IPv6 CIDR block, you must specify an ICMP type and code.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "protocol" + } + }, + "RuleAction": { + "target": "com.amazonaws.ec2#RuleAction", + "traits": { + "aws.protocols#ec2QueryName": "RuleAction", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Indicates whether to allow or deny the traffic that matches the rule.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "ruleAction" + } + }, + "RuleNumber": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "RuleNumber", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The rule number of the entry to replace.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "ruleNumber" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ReplaceRootVolumeTask": { + "type": "structure", + "members": { + "ReplaceRootVolumeTaskId": { + "target": "com.amazonaws.ec2#ReplaceRootVolumeTaskId", + "traits": { + "aws.protocols#ec2QueryName": "ReplaceRootVolumeTaskId", + "smithy.api#documentation": "

The ID of the root volume replacement task.

", + "smithy.api#xmlName": "replaceRootVolumeTaskId" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance for which the root volume replacement task was created.

", + "smithy.api#xmlName": "instanceId" + } + }, + "TaskState": { + "target": "com.amazonaws.ec2#ReplaceRootVolumeTaskState", + "traits": { + "aws.protocols#ec2QueryName": "TaskState", + "smithy.api#documentation": "

The state of the task. The task can be in one of the following states:

\n ", + "smithy.api#xmlName": "taskState" + } + }, + "StartTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StartTime", + "smithy.api#documentation": "

The time the task was started.

", + "smithy.api#xmlName": "startTime" + } + }, + "CompleteTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CompleteTime", + "smithy.api#documentation": "

The time the task completed.

", + "smithy.api#xmlName": "completeTime" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the task.

", + "smithy.api#xmlName": "tagSet" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the AMI used to create the replacement root volume.

", + "smithy.api#xmlName": "imageId" + } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the snapshot used to create the replacement root volume.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "DeleteReplacedRootVolume": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DeleteReplacedRootVolume", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the original root volume is to be deleted after the root volume \n replacement task completes.

", + "smithy.api#xmlName": "deleteReplacedRootVolume" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a root volume replacement task.

" + } + }, + "com.amazonaws.ec2#ReplaceRootVolumeTaskId": { + "type": "string" + }, + "com.amazonaws.ec2#ReplaceRootVolumeTaskIds": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ReplaceRootVolumeTaskId", + "traits": { + "smithy.api#xmlName": "ReplaceRootVolumeTaskId" + } + } + }, + "com.amazonaws.ec2#ReplaceRootVolumeTaskState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "in-progress" + } + }, + "failing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failing" + } + }, + "succeeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "succeeded" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "failed_detached": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed-detached" + } + } + } + }, + "com.amazonaws.ec2#ReplaceRootVolumeTasks": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ReplaceRootVolumeTask", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ReplaceRoute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ReplaceRouteRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Replaces an existing route within a route table in a VPC.

\n

You must specify either a destination CIDR block or a prefix list ID. You must also specify \n exactly one of the resources from the parameter list, or reset the local route to its default \n target.

\n

For more information, see Route tables in the\n Amazon Virtual Private Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#ReplaceRouteRequest": { + "type": "structure", + "members": { + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationCidrBlock", + "smithy.api#documentation": "

The IPv4 CIDR address block used for the destination match. The value that you\n\t\t\tprovide must match the CIDR of an existing route in the table.

", + "smithy.api#xmlName": "destinationCidrBlock" + } + }, + "DestinationIpv6CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationIpv6CidrBlock", + "smithy.api#documentation": "

The IPv6 CIDR address block used for the destination match. The value that you\n\t\t\tprovide must match the CIDR of an existing route in the table.

", + "smithy.api#xmlName": "destinationIpv6CidrBlock" + } + }, + "DestinationPrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the prefix list for the route.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "VpcEndpointId": { + "target": "com.amazonaws.ec2#VpcEndpointId", + "traits": { + "smithy.api#documentation": "

The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.

" + } + }, + "EgressOnlyInternetGatewayId": { + "target": "com.amazonaws.ec2#EgressOnlyInternetGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "EgressOnlyInternetGatewayId", + "smithy.api#documentation": "

[IPv6 traffic only] The ID of an egress-only internet gateway.

", + "smithy.api#xmlName": "egressOnlyInternetGatewayId" + } + }, + "GatewayId": { + "target": "com.amazonaws.ec2#RouteGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "GatewayId", + "smithy.api#documentation": "

The ID of an internet gateway or virtual private gateway.

", + "smithy.api#xmlName": "gatewayId" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of a NAT instance in your VPC.

", + "smithy.api#xmlName": "instanceId" + } + }, + "LocalTarget": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether to reset the local route to its default target (local).

" + } + }, + "NatGatewayId": { + "target": "com.amazonaws.ec2#NatGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "NatGatewayId", + "smithy.api#documentation": "

[IPv4 traffic only] The ID of a NAT gateway.

", + "smithy.api#xmlName": "natGatewayId" + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of a transit gateway.

" + } + }, + "LocalGatewayId": { + "target": "com.amazonaws.ec2#LocalGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the local gateway.

" + } + }, + "CarrierGatewayId": { + "target": "com.amazonaws.ec2#CarrierGatewayId", + "traits": { + "smithy.api#documentation": "

[IPv4 traffic only] The ID of a carrier gateway.

" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of a network interface.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "RouteTableId": { + "target": "com.amazonaws.ec2#RouteTableId", + "traits": { + "aws.protocols#ec2QueryName": "RouteTableId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the route table.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "routeTableId" + } + }, + "VpcPeeringConnectionId": { + "target": "com.amazonaws.ec2#VpcPeeringConnectionId", + "traits": { + "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", + "smithy.api#documentation": "

The ID of a VPC peering connection.

", + "smithy.api#xmlName": "vpcPeeringConnectionId" + } + }, + "CoreNetworkArn": { + "target": "com.amazonaws.ec2#CoreNetworkArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the core network.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ReplaceRouteTableAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ReplaceRouteTableAssociationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ReplaceRouteTableAssociationResult" + }, + "traits": { + "smithy.api#documentation": "

Changes the route table associated with a given subnet, internet gateway, or virtual private gateway in a VPC. After the operation\n completes, the subnet or gateway uses the routes in the new route table. For more\n information about route tables, see Route\n tables in the Amazon Virtual Private Cloud User Guide.

\n

You can also use this operation to change which table is the main route table in the VPC. Specify the main route table's association ID and the route table ID of the new main route table.

" + } + }, + "com.amazonaws.ec2#ReplaceRouteTableAssociationRequest": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.ec2#RouteTableAssociationId", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The association ID.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "associationId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "RouteTableId": { + "target": "com.amazonaws.ec2#RouteTableId", + "traits": { + "aws.protocols#ec2QueryName": "RouteTableId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the new route table to associate with the subnet.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "routeTableId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ReplaceRouteTableAssociationResult": { + "type": "structure", + "members": { + "NewAssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NewAssociationId", + "smithy.api#documentation": "

The ID of the new association.

", + "smithy.api#xmlName": "newAssociationId" + } + }, + "AssociationState": { + "target": "com.amazonaws.ec2#RouteTableAssociationState", + "traits": { + "aws.protocols#ec2QueryName": "AssociationState", + "smithy.api#documentation": "

The state of the association.

", + "smithy.api#xmlName": "associationState" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ReplaceTransitGatewayRoute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ReplaceTransitGatewayRouteRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ReplaceTransitGatewayRouteResult" + }, + "traits": { + "smithy.api#documentation": "

Replaces the specified route in the specified transit gateway route table.

" + } + }, + "com.amazonaws.ec2#ReplaceTransitGatewayRouteRequest": { + "type": "structure", + "members": { + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The CIDR range used for the destination match. Routing decisions are based on the most specific match.

", + "smithy.api#required": {} + } + }, + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the route table.

", + "smithy.api#required": {} + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#documentation": "

The ID of the attachment.

" + } + }, + "Blackhole": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether traffic matching this route is to be dropped.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ReplaceTransitGatewayRouteResult": { + "type": "structure", + "members": { + "Route": { + "target": "com.amazonaws.ec2#TransitGatewayRoute", + "traits": { + "aws.protocols#ec2QueryName": "Route", + "smithy.api#documentation": "

Information about the modified route.

", + "smithy.api#xmlName": "route" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ReplaceVpnTunnel": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ReplaceVpnTunnelRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ReplaceVpnTunnelResult" + }, + "traits": { + "smithy.api#documentation": "

Trigger replacement of specified VPN tunnel.

" + } + }, + "com.amazonaws.ec2#ReplaceVpnTunnelRequest": { + "type": "structure", + "members": { + "VpnConnectionId": { + "target": "com.amazonaws.ec2#VpnConnectionId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Site-to-Site VPN connection.

", + "smithy.api#required": {} + } + }, + "VpnTunnelOutsideIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The external IP address of the VPN tunnel.

", + "smithy.api#required": {} + } + }, + "ApplyPendingMaintenance": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Trigger pending tunnel endpoint maintenance.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ReplaceVpnTunnelResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Confirmation of replace tunnel operation.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ReplacementStrategy": { + "type": "enum", + "members": { + "LAUNCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "launch" + } + }, + "LAUNCH_BEFORE_TERMINATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "launch-before-terminate" + } + } + } + }, + "com.amazonaws.ec2#ReportInstanceReasonCodes": { + "type": "enum", + "members": { + "instance_stuck_in_state": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "instance-stuck-in-state" + } + }, + "unresponsive": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unresponsive" + } + }, + "not_accepting_credentials": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "not-accepting-credentials" + } + }, + "password_not_available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "password-not-available" + } + }, + "performance_network": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "performance-network" + } + }, + "performance_instance_store": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "performance-instance-store" + } + }, + "performance_ebs_volume": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "performance-ebs-volume" + } + }, + "performance_other": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "performance-other" + } + }, + "other": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "other" + } + } + } + }, + "com.amazonaws.ec2#ReportInstanceStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ReportInstanceStatusRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Submits feedback about the status of an instance. The instance must be in the\n running state. If your experience with the instance differs from the\n instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon\n EC2 collects this information to improve the accuracy of status checks.

\n

Use of this action does not change the value returned by DescribeInstanceStatus.

" + } + }, + "com.amazonaws.ec2#ReportInstanceStatusRequest": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

Descriptive text about the health state of your instance.

", + "smithy.api#xmlName": "description" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "EndTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "EndTime", + "smithy.api#documentation": "

The time at which the reported instance health state ended.

", + "smithy.api#xmlName": "endTime" + } + }, + "Instances": { + "target": "com.amazonaws.ec2#InstanceIdStringList", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The instances.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "instanceId" + } + }, + "ReasonCodes": { + "target": "com.amazonaws.ec2#ReasonCodesList", + "traits": { + "aws.protocols#ec2QueryName": "ReasonCode", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The reason codes that describe the health state of your instance.

\n ", + "smithy.api#required": {}, + "smithy.api#xmlName": "reasonCode" + } + }, + "StartTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "StartTime", + "smithy.api#documentation": "

The time at which the reported instance health state began.

", + "smithy.api#xmlName": "startTime" + } + }, + "Status": { + "target": "com.amazonaws.ec2#ReportStatusType", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of all instances listed.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ReportStatusType": { + "type": "enum", + "members": { + "ok": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ok" + } + }, + "impaired": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "impaired" + } + } + } + }, + "com.amazonaws.ec2#RequestFilterPortRange": { + "type": "structure", + "members": { + "FromPort": { + "target": "com.amazonaws.ec2#Port", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The first port in the range.

" + } + }, + "ToPort": { + "target": "com.amazonaws.ec2#Port", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The last port in the range.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a port range.

" + } + }, + "com.amazonaws.ec2#RequestHostIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DedicatedHostId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#RequestHostIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#DedicatedHostId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#RequestInstanceTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#InstanceType" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.ec2#RequestIpamResourceTag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

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.

" + } + }, + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The value for the tag.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A tag on an IPAM resource.

" + } + }, + "com.amazonaws.ec2#RequestIpamResourceTagList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RequestIpamResourceTag", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#RequestLaunchTemplateData": { + "type": "structure", + "members": { + "KernelId": { + "target": "com.amazonaws.ec2#KernelId", + "traits": { + "smithy.api#documentation": "

The ID of the kernel.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon Elastic Compute Cloud User Guide.

\n " + } + }, + "EbsOptimized": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the instance is optimized for Amazon EBS I/O. This optimization\n provides dedicated throughput to Amazon EBS and an optimized configuration stack to\n provide optimal Amazon EBS I/O performance. This optimization isn't available with all\n instance types. Additional usage charges apply when using an EBS-optimized\n instance.

" + } + }, + "IamInstanceProfile": { + "target": "com.amazonaws.ec2#LaunchTemplateIamInstanceProfileSpecificationRequest", + "traits": { + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of an IAM instance profile.

" + } + }, + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#LaunchTemplateBlockDeviceMappingRequestList", + "traits": { + "smithy.api#documentation": "

The block device mapping.

", + "smithy.api#xmlName": "BlockDeviceMapping" + } + }, + "NetworkInterfaces": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceNetworkInterfaceSpecificationRequestList", + "traits": { + "smithy.api#documentation": "

One or more network interfaces. If you specify a network interface, you must specify\n any security groups and subnets as part of the network interface.

", + "smithy.api#xmlName": "NetworkInterface" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#documentation": "

The ID of the AMI. Alternatively, you can specify a Systems Manager parameter, which\n will resolve to an AMI ID on launch.

\n

Valid formats:

\n \n \n

Currently, EC2 Fleet and Spot Fleet do not support specifying a Systems Manager parameter. \n If the launch template will be used by an EC2 Fleet or Spot Fleet, you must specify the AMI ID.

\n \n

For more information, see Use a Systems Manager parameter instead of an AMI ID in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "smithy.api#documentation": "

The instance type. For more information, see Instance types in the\n Amazon Elastic Compute Cloud User Guide.

\n

If you specify InstanceType, you can't specify\n InstanceRequirements.

" + } + }, + "KeyName": { + "target": "com.amazonaws.ec2#KeyPairName", + "traits": { + "smithy.api#documentation": "

The name of the key pair. You can create a key pair using CreateKeyPair or\n ImportKeyPair.

\n \n

If you do not specify a key pair, you can't connect to the instance unless you\n choose an AMI that is configured to allow users another way to log in.

\n " + } + }, + "Monitoring": { + "target": "com.amazonaws.ec2#LaunchTemplatesMonitoringRequest", + "traits": { + "smithy.api#documentation": "

The monitoring for the instance.

" + } + }, + "Placement": { + "target": "com.amazonaws.ec2#LaunchTemplatePlacementRequest", + "traits": { + "smithy.api#documentation": "

The placement for the instance.

" + } + }, + "RamDiskId": { + "target": "com.amazonaws.ec2#RamdiskId", + "traits": { + "smithy.api#documentation": "

The ID of the RAM disk.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon Elastic Compute Cloud User Guide.

\n " + } + }, + "DisableApiTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

If you set this parameter to true, you can't terminate the instance using\n the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after\n launch, use ModifyInstanceAttribute. Alternatively, if you set\n InstanceInitiatedShutdownBehavior to terminate, you can\n terminate the instance by running the shutdown command from the instance.

" + } + }, + "InstanceInitiatedShutdownBehavior": { + "target": "com.amazonaws.ec2#ShutdownBehavior", + "traits": { + "smithy.api#documentation": "

Indicates whether an instance stops or terminates when you initiate shutdown from the\n instance (using the operating system command for system shutdown).

\n

Default: stop\n

" + } + }, + "UserData": { + "target": "com.amazonaws.ec2#SensitiveUserData", + "traits": { + "smithy.api#documentation": "

The user data to make available to the instance. You must provide base64-encoded text.\n User data is limited to 16 KB. For more information, see Run commands on your Linux instance at\n launch (Linux) or Work with instance\n user data (Windows) in the Amazon Elastic Compute Cloud User Guide.

\n

If you are creating the launch template for use with Batch, the user\n data must be provided in the MIME multi-part archive format. For more information, see Amazon EC2 user data in launch templates in the Batch User Guide.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#LaunchTemplateTagSpecificationRequestList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the resources that are created during instance launch.

\n

You can specify tags for the following resources only:

\n \n

To tag a resource after it has been created, see CreateTags.

\n \n

To tag the launch template itself, you must use the TagSpecification parameter.

\n ", + "smithy.api#xmlName": "TagSpecification" + } + }, + "ElasticGpuSpecifications": { + "target": "com.amazonaws.ec2#ElasticGpuSpecificationList", + "traits": { + "smithy.api#documentation": "

An elastic GPU to associate with the instance.

", + "smithy.api#xmlName": "ElasticGpuSpecification" + } + }, + "ElasticInferenceAccelerators": { + "target": "com.amazonaws.ec2#LaunchTemplateElasticInferenceAcceleratorList", + "traits": { + "smithy.api#documentation": "

The elastic inference accelerator for the instance.

", + "smithy.api#xmlName": "ElasticInferenceAccelerator" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#SecurityGroupIdStringList", + "traits": { + "smithy.api#documentation": "

One or more security group IDs. You can create a security group using CreateSecurityGroup. You cannot specify both a security group ID and\n security name in the same request.

", + "smithy.api#xmlName": "SecurityGroupId" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.ec2#SecurityGroupStringList", + "traits": { + "smithy.api#documentation": "

One or more security group names. For a nondefault VPC, you must use security group\n IDs instead. You cannot specify both a security group ID and security name in the same\n request.

", + "smithy.api#xmlName": "SecurityGroup" + } + }, + "InstanceMarketOptions": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceMarketOptionsRequest", + "traits": { + "smithy.api#documentation": "

The market (purchasing) option for the instances.

" + } + }, + "CreditSpecification": { + "target": "com.amazonaws.ec2#CreditSpecificationRequest", + "traits": { + "smithy.api#documentation": "

The credit option for CPU usage of the instance. Valid only for T instances.

" + } + }, + "CpuOptions": { + "target": "com.amazonaws.ec2#LaunchTemplateCpuOptionsRequest", + "traits": { + "smithy.api#documentation": "

The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User\n Guide.

" + } + }, + "CapacityReservationSpecification": { + "target": "com.amazonaws.ec2#LaunchTemplateCapacityReservationSpecificationRequest", + "traits": { + "smithy.api#documentation": "

The Capacity Reservation targeting option. If you do not specify this parameter, the\n instance's Capacity Reservation preference defaults to open, which enables\n it to run in any open Capacity Reservation that has matching attributes (instance type,\n platform, Availability Zone).

" + } + }, + "LicenseSpecifications": { + "target": "com.amazonaws.ec2#LaunchTemplateLicenseSpecificationListRequest", + "traits": { + "smithy.api#documentation": "

The license configurations.

", + "smithy.api#xmlName": "LicenseSpecification" + } + }, + "HibernationOptions": { + "target": "com.amazonaws.ec2#LaunchTemplateHibernationOptionsRequest", + "traits": { + "smithy.api#documentation": "

Indicates whether an instance is enabled for hibernation. This parameter is valid only\n if the instance meets the hibernation\n prerequisites. For more information, see Hibernate your instance in the\n Amazon Elastic Compute Cloud User Guide.

" + } + }, + "MetadataOptions": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataOptionsRequest", + "traits": { + "smithy.api#documentation": "

The metadata options for the instance. For more information, see Instance metadata and user data in the\n Amazon Elastic Compute Cloud User Guide.

" + } + }, + "EnclaveOptions": { + "target": "com.amazonaws.ec2#LaunchTemplateEnclaveOptionsRequest", + "traits": { + "smithy.api#documentation": "

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more\n information, see What is Amazon Web Services Nitro Enclaves?\n in the Amazon Web Services Nitro Enclaves User Guide.

\n

You can't enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.

" + } + }, + "InstanceRequirements": { + "target": "com.amazonaws.ec2#InstanceRequirementsRequest", + "traits": { + "smithy.api#documentation": "

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with these attributes.

\n

If you specify InstanceRequirements, you can't specify\n InstanceType.

" + } + }, + "PrivateDnsNameOptions": { + "target": "com.amazonaws.ec2#LaunchTemplatePrivateDnsNameOptionsRequest", + "traits": { + "smithy.api#documentation": "

The options for the instance hostname. The default values are inherited from the\n subnet.

" + } + }, + "MaintenanceOptions": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceMaintenanceOptionsRequest", + "traits": { + "smithy.api#documentation": "

The maintenance options for the instance.

" + } + }, + "DisableApiStop": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to enable the instance for stop protection. For more information,\n see Stop\n protection in the Amazon Elastic Compute Cloud User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The information to include in the launch template.

\n \n

You must specify at least one parameter for the launch template data.

\n " + } + }, + "com.amazonaws.ec2#RequestSpotFleet": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RequestSpotFleetRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RequestSpotFleetResponse" + }, + "traits": { + "smithy.api#documentation": "

Creates a Spot Fleet request.

\n

The Spot Fleet request specifies the total target capacity and the On-Demand target\n capacity. Amazon EC2 calculates the difference between the total capacity and On-Demand\n capacity, and launches the difference as Spot capacity.

\n

You can submit a single request that includes multiple launch specifications that vary\n by instance type, AMI, Availability Zone, or subnet.

\n

By default, the Spot Fleet requests Spot Instances in the Spot Instance pool where the\n price per unit is the lowest. Each launch specification can include its own instance\n weighting that reflects the value of the instance type to your application\n workload.

\n

Alternatively, you can specify that the Spot Fleet distribute the target capacity\n across the Spot pools included in its launch specifications. By ensuring that the Spot\n Instances in your Spot Fleet are in different Spot pools, you can improve the\n availability of your fleet.

\n

You can specify tags for the Spot Fleet request and instances launched by the fleet.\n You cannot tag other resource types in a Spot Fleet request because only the\n spot-fleet-request and instance resource types are\n supported.

\n

For more information, see Spot Fleet requests\n in the Amazon EC2 User Guide.

\n \n

We strongly discourage using the RequestSpotFleet API because it is a legacy\n API with no planned investment. For options for requesting Spot Instances, see\n Which\n is the best Spot request method to use? in the\n Amazon EC2 User Guide.

\n " + } + }, + "com.amazonaws.ec2#RequestSpotFleetRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "SpotFleetRequestConfig": { + "target": "com.amazonaws.ec2#SpotFleetRequestConfigData", + "traits": { + "aws.protocols#ec2QueryName": "SpotFleetRequestConfig", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The configuration for the Spot Fleet request.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "spotFleetRequestConfig" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for RequestSpotFleet.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RequestSpotFleetResponse": { + "type": "structure", + "members": { + "SpotFleetRequestId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpotFleetRequestId", + "smithy.api#documentation": "

The ID of the Spot Fleet request.

", + "smithy.api#xmlName": "spotFleetRequestId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of RequestSpotFleet.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#RequestSpotInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RequestSpotInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RequestSpotInstancesResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a Spot Instance request.

\n

For more information, see Spot Instance requests in\n the Amazon EC2 User Guide for Linux Instances.

\n \n

We strongly discourage using the RequestSpotInstances API because it is a legacy\n API with no planned investment. For options for requesting Spot Instances, see\n Which\n is the best Spot request method to use? in the\n Amazon EC2 User Guide for Linux Instances.

\n " + } + }, + "com.amazonaws.ec2#RequestSpotInstancesRequest": { + "type": "structure", + "members": { + "AvailabilityZoneGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneGroup", + "smithy.api#documentation": "

The user-specified name for a logical grouping of requests.

\n

When you specify an Availability Zone group in a Spot Instance request, all Spot\n Instances in the request are launched in the same Availability Zone. Instance proximity\n is maintained with this parameter, but the choice of Availability Zone is not. The group\n applies only to requests for Spot Instances of the same instance type. Any additional\n Spot Instance requests that are specified with the same Availability Zone group name are\n launched in that same Availability Zone, as long as at least one instance from the group\n is still active.

\n

If there is no active instance running in the Availability Zone group that you specify\n for a new Spot Instance request (all instances are terminated, the request is expired,\n or the maximum price you specified falls below current Spot price), then Amazon EC2 launches\n the instance in any Availability Zone where the constraint can be met. Consequently, the\n subsequent set of Spot Instances could be placed in a different zone from the original\n request, even if you specified the same Availability Zone group.

\n

Default: Instances are launched in any available Availability Zone.

", + "smithy.api#xmlName": "availabilityZoneGroup" + } + }, + "BlockDurationMinutes": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "BlockDurationMinutes", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

Deprecated.

", + "smithy.api#xmlName": "blockDurationMinutes" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to Ensure\n Idempotency in the Amazon EC2 User Guide for Linux Instances.

", + "smithy.api#xmlName": "clientToken" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "InstanceCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of Spot Instances to launch.

\n

Default: 1

", + "smithy.api#xmlName": "instanceCount" + } + }, + "LaunchGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LaunchGroup", + "smithy.api#documentation": "

The instance launch group. Launch groups are Spot Instances that launch together and\n terminate together.

\n

Default: Instances are launched and terminated individually

", + "smithy.api#xmlName": "launchGroup" + } + }, + "LaunchSpecification": { + "target": "com.amazonaws.ec2#RequestSpotLaunchSpecification", + "traits": { + "smithy.api#documentation": "

The launch specification.

" + } + }, + "SpotPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpotPrice", + "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend \n using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n ", + "smithy.api#xmlName": "spotPrice" + } + }, + "Type": { + "target": "com.amazonaws.ec2#SpotInstanceType", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The Spot Instance request type.

\n

Default: one-time\n

", + "smithy.api#xmlName": "type" + } + }, + "ValidFrom": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "ValidFrom", + "smithy.api#documentation": "

The start date of the request. If this is a one-time request, the request becomes\n active at this date and time and remains active until all instances launch, the request\n expires, or the request is canceled. If the request is persistent, the request becomes\n active at this date and time and remains active until it expires or is canceled.

\n

The specified start date and time cannot be equal to the current date and time. You\n must specify a start date and time that occurs after the current date and time.

", + "smithy.api#xmlName": "validFrom" + } + }, + "ValidUntil": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "ValidUntil", + "smithy.api#documentation": "

The end date of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ).

\n ", + "smithy.api#xmlName": "validUntil" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The key-value pair for tagging the Spot Instance request on creation. The value for\n ResourceType must be spot-instances-request, otherwise the\n Spot Instance request fails. To tag the Spot Instance request after it has been created,\n see CreateTags.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "InstanceInterruptionBehavior": { + "target": "com.amazonaws.ec2#InstanceInterruptionBehavior", + "traits": { + "smithy.api#documentation": "

The behavior when a Spot Instance is interrupted. The default is terminate.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for RequestSpotInstances.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RequestSpotInstancesResult": { + "type": "structure", + "members": { + "SpotInstanceRequests": { + "target": "com.amazonaws.ec2#SpotInstanceRequestList", + "traits": { + "aws.protocols#ec2QueryName": "SpotInstanceRequestSet", + "smithy.api#documentation": "

The Spot Instance requests.

", + "smithy.api#xmlName": "spotInstanceRequestSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of RequestSpotInstances.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#RequestSpotLaunchSpecification": { + "type": "structure", + "members": { + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#RequestSpotLaunchSpecificationSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the security groups.

", + "smithy.api#xmlName": "SecurityGroupId" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.ec2#RequestSpotLaunchSpecificationSecurityGroupList", + "traits": { + "smithy.api#documentation": "

Not supported.

", + "smithy.api#xmlName": "SecurityGroup" + } + }, + "AddressingType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AddressingType", + "smithy.api#documentation": "

Deprecated.

", + "smithy.api#xmlName": "addressingType" + } + }, + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#BlockDeviceMappingList", + "traits": { + "aws.protocols#ec2QueryName": "BlockDeviceMapping", + "smithy.api#documentation": "

The block device mapping entries. You can't specify both a snapshot ID and an encryption value. \n This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, \n it is not blank and its encryption status is used for the volume encryption status.

", + "smithy.api#xmlName": "blockDeviceMapping" + } + }, + "EbsOptimized": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EbsOptimized", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#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.

\n

Default: false\n

", + "smithy.api#xmlName": "ebsOptimized" + } + }, + "IamInstanceProfile": { + "target": "com.amazonaws.ec2#IamInstanceProfileSpecification", + "traits": { + "aws.protocols#ec2QueryName": "IamInstanceProfile", + "smithy.api#documentation": "

The IAM instance profile.

", + "smithy.api#xmlName": "iamInstanceProfile" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#xmlName": "imageId" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type. Only one instance type can be specified.

", + "smithy.api#xmlName": "instanceType" + } + }, + "KernelId": { + "target": "com.amazonaws.ec2#KernelId", + "traits": { + "aws.protocols#ec2QueryName": "KernelId", + "smithy.api#documentation": "

The ID of the kernel.

", + "smithy.api#xmlName": "kernelId" + } + }, + "KeyName": { + "target": "com.amazonaws.ec2#KeyPairName", + "traits": { + "aws.protocols#ec2QueryName": "KeyName", + "smithy.api#documentation": "

The name of the key pair.

", + "smithy.api#xmlName": "keyName" + } + }, + "Monitoring": { + "target": "com.amazonaws.ec2#RunInstancesMonitoringEnabled", + "traits": { + "aws.protocols#ec2QueryName": "Monitoring", + "smithy.api#documentation": "

Indicates whether basic or detailed monitoring is enabled for the instance.

\n

Default: Disabled

", + "smithy.api#xmlName": "monitoring" + } + }, + "NetworkInterfaces": { + "target": "com.amazonaws.ec2#InstanceNetworkInterfaceSpecificationList", + "traits": { + "smithy.api#documentation": "

The network interfaces. If you specify a network interface, you must specify \n subnet IDs and security group IDs using the network interface.

", + "smithy.api#xmlName": "NetworkInterface" + } + }, + "Placement": { + "target": "com.amazonaws.ec2#SpotPlacement", + "traits": { + "aws.protocols#ec2QueryName": "Placement", + "smithy.api#documentation": "

The placement information for the instance.

", + "smithy.api#xmlName": "placement" + } + }, + "RamdiskId": { + "target": "com.amazonaws.ec2#RamdiskId", + "traits": { + "aws.protocols#ec2QueryName": "RamdiskId", + "smithy.api#documentation": "

The ID of the RAM disk.

", + "smithy.api#xmlName": "ramdiskId" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet in which to launch the instance.

", + "smithy.api#xmlName": "subnetId" + } + }, + "UserData": { + "target": "com.amazonaws.ec2#SensitiveUserData", + "traits": { + "aws.protocols#ec2QueryName": "UserData", + "smithy.api#documentation": "

The base64-encoded user data that instances use when starting up. User data is limited to 16 KB.

", + "smithy.api#xmlName": "userData" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the launch specification for an instance.

" + } + }, + "com.amazonaws.ec2#RequestSpotLaunchSpecificationSecurityGroupIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#RequestSpotLaunchSpecificationSecurityGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Reservation": { + "type": "structure", + "members": { + "Groups": { + "target": "com.amazonaws.ec2#GroupIdentifierList", + "traits": { + "aws.protocols#ec2QueryName": "GroupSet", + "smithy.api#documentation": "

Not supported.

", + "smithy.api#xmlName": "groupSet" + } + }, + "Instances": { + "target": "com.amazonaws.ec2#InstanceList", + "traits": { + "aws.protocols#ec2QueryName": "InstancesSet", + "smithy.api#documentation": "

The instances.

", + "smithy.api#xmlName": "instancesSet" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the reservation.

", + "smithy.api#xmlName": "ownerId" + } + }, + "RequesterId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RequesterId", + "smithy.api#documentation": "

The ID of the requester that launched the instances on your behalf (for example,\n Amazon Web Services Management Console or Auto Scaling).

", + "smithy.api#xmlName": "requesterId" + } + }, + "ReservationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ReservationId", + "smithy.api#documentation": "

The ID of the reservation.

", + "smithy.api#xmlName": "reservationId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a launch request for one or more instances, and includes owner, requester,\n and security group information that applies to all instances in the launch\n request.

" + } + }, + "com.amazonaws.ec2#ReservationFleetInstanceSpecification": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "smithy.api#documentation": "

The instance type for which the Capacity Reservation Fleet reserves capacity.

" + } + }, + "InstancePlatform": { + "target": "com.amazonaws.ec2#CapacityReservationInstancePlatform", + "traits": { + "smithy.api#documentation": "

The type of operating system for which the Capacity Reservation Fleet reserves capacity.

" + } + }, + "Weight": { + "target": "com.amazonaws.ec2#DoubleWithConstraints", + "traits": { + "smithy.api#documentation": "

The number of capacity units provided by the specified instance type. This value, together with the \n\t\t\ttotal target capacity that you specify for the Fleet determine the number of instances for which the \n\t\t\tFleet reserves capacity. Both values are based on units that make sense for your workload. For more \n\t\t\tinformation, see Total target capacity \n\t\t\tin the Amazon EC2 User Guide.

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone in which the Capacity Reservation Fleet reserves the capacity. A Capacity \n\t\t\tReservation Fleet can't span Availability Zones. All instance type specifications that you specify \n\t\t\tfor the Fleet must use the same Availability Zone.

" + } + }, + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of the Availability Zone in which the Capacity Reservation Fleet reserves the capacity. A \n\t\t\tCapacity Reservation Fleet can't span Availability Zones. All instance type specifications that you \n\t\t\tspecify for the Fleet must use the same Availability Zone.

" + } + }, + "EbsOptimized": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the Capacity Reservation Fleet supports EBS-optimized instances types. This \n\t\t\toptimization provides dedicated throughput to Amazon EBS and an optimized configuration stack \n\t\t\tto provide optimal I/O performance. This optimization isn't available with all instance types. Additional \n\t\t\tusage charges apply when using EBS-optimized instance types.

" + } + }, + "Priority": { + "target": "com.amazonaws.ec2#IntegerWithConstraints", + "traits": { + "smithy.api#documentation": "

The priority to assign to the instance type. This value is used to determine which of the instance types \n\t\t\tspecified for the Fleet should be prioritized for use. A lower value indicates a high priority. For more \n\t\t\tinformation, see Instance type priority \n\t\t\tin the Amazon EC2 User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an instance type to use in a Capacity Reservation Fleet.

" + } + }, + "com.amazonaws.ec2#ReservationFleetInstanceSpecificationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ReservationFleetInstanceSpecification" + } + }, + "com.amazonaws.ec2#ReservationId": { + "type": "string" + }, + "com.amazonaws.ec2#ReservationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Reservation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ReservationState": { + "type": "enum", + "members": { + "PAYMENT_PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "payment-pending" + } + }, + "PAYMENT_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "payment-failed" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "RETIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "retired" + } + } + } + }, + "com.amazonaws.ec2#ReservationValue": { + "type": "structure", + "members": { + "HourlyPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "HourlyPrice", + "smithy.api#documentation": "

The hourly rate of the reservation.

", + "smithy.api#xmlName": "hourlyPrice" + } + }, + "RemainingTotalValue": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RemainingTotalValue", + "smithy.api#documentation": "

The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * number of hours remaining).

", + "smithy.api#xmlName": "remainingTotalValue" + } + }, + "RemainingUpfrontValue": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RemainingUpfrontValue", + "smithy.api#documentation": "

The remaining upfront cost of the reservation.

", + "smithy.api#xmlName": "remainingUpfrontValue" + } + } + }, + "traits": { + "smithy.api#documentation": "

The cost associated with the Reserved Instance.

" + } + }, + "com.amazonaws.ec2#ReservedInstanceIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ReservationId", + "traits": { + "smithy.api#xmlName": "ReservedInstanceId" + } + } + }, + "com.amazonaws.ec2#ReservedInstanceLimitPrice": { + "type": "structure", + "members": { + "Amount": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "Amount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).

", + "smithy.api#xmlName": "amount" + } + }, + "CurrencyCode": { + "target": "com.amazonaws.ec2#CurrencyCodeValues", + "traits": { + "aws.protocols#ec2QueryName": "CurrencyCode", + "smithy.api#documentation": "

The currency in which the limitPrice amount is specified.\n\t\t\t\tAt this time, the only supported currency is USD.

", + "smithy.api#xmlName": "currencyCode" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the limit price of a Reserved Instance offering.

" + } + }, + "com.amazonaws.ec2#ReservedInstanceReservationValue": { + "type": "structure", + "members": { + "ReservationValue": { + "target": "com.amazonaws.ec2#ReservationValue", + "traits": { + "aws.protocols#ec2QueryName": "ReservationValue", + "smithy.api#documentation": "

The total value of the Convertible Reserved Instance that you are exchanging.

", + "smithy.api#xmlName": "reservationValue" + } + }, + "ReservedInstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstanceId", + "smithy.api#documentation": "

The ID of the Convertible Reserved Instance that you are exchanging.

", + "smithy.api#xmlName": "reservedInstanceId" + } + } + }, + "traits": { + "smithy.api#documentation": "

The total value of the Convertible Reserved Instance.

" + } + }, + "com.amazonaws.ec2#ReservedInstanceReservationValueSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ReservedInstanceReservationValue", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ReservedInstanceState": { + "type": "enum", + "members": { + "payment_pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "payment-pending" + } + }, + "active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "payment_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "payment-failed" + } + }, + "retired": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "retired" + } + }, + "queued": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "queued" + } + }, + "queued_deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "queued-deleted" + } + } + } + }, + "com.amazonaws.ec2#ReservedInstances": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone in which the Reserved Instance can be used.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "Duration": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "Duration", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The duration of the Reserved Instance, in seconds.

", + "smithy.api#xmlName": "duration" + } + }, + "End": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "End", + "smithy.api#documentation": "

The time when the Reserved Instance expires.

", + "smithy.api#xmlName": "end" + } + }, + "FixedPrice": { + "target": "com.amazonaws.ec2#Float", + "traits": { + "aws.protocols#ec2QueryName": "FixedPrice", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The purchase price of the Reserved Instance.

", + "smithy.api#xmlName": "fixedPrice" + } + }, + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "InstanceCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of reservations purchased.

", + "smithy.api#xmlName": "instanceCount" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type on which the Reserved Instance can be used.

", + "smithy.api#xmlName": "instanceType" + } + }, + "ProductDescription": { + "target": "com.amazonaws.ec2#RIProductDescription", + "traits": { + "aws.protocols#ec2QueryName": "ProductDescription", + "smithy.api#documentation": "

The Reserved Instance product platform description.

", + "smithy.api#xmlName": "productDescription" + } + }, + "ReservedInstancesId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesId", + "smithy.api#documentation": "

The ID of the Reserved Instance.

", + "smithy.api#xmlName": "reservedInstancesId" + } + }, + "Start": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "Start", + "smithy.api#documentation": "

The date and time the Reserved Instance started.

", + "smithy.api#xmlName": "start" + } + }, + "State": { + "target": "com.amazonaws.ec2#ReservedInstanceState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the Reserved Instance purchase.

", + "smithy.api#xmlName": "state" + } + }, + "UsagePrice": { + "target": "com.amazonaws.ec2#Float", + "traits": { + "aws.protocols#ec2QueryName": "UsagePrice", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The usage price of the Reserved Instance, per hour.

", + "smithy.api#xmlName": "usagePrice" + } + }, + "CurrencyCode": { + "target": "com.amazonaws.ec2#CurrencyCodeValues", + "traits": { + "aws.protocols#ec2QueryName": "CurrencyCode", + "smithy.api#documentation": "

The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes.\n\t\t\t\tAt this time, the only supported currency is USD.

", + "smithy.api#xmlName": "currencyCode" + } + }, + "InstanceTenancy": { + "target": "com.amazonaws.ec2#Tenancy", + "traits": { + "aws.protocols#ec2QueryName": "InstanceTenancy", + "smithy.api#documentation": "

The tenancy of the instance.

", + "smithy.api#xmlName": "instanceTenancy" + } + }, + "OfferingClass": { + "target": "com.amazonaws.ec2#OfferingClassType", + "traits": { + "aws.protocols#ec2QueryName": "OfferingClass", + "smithy.api#documentation": "

The offering class of the Reserved Instance.

", + "smithy.api#xmlName": "offeringClass" + } + }, + "OfferingType": { + "target": "com.amazonaws.ec2#OfferingTypeValues", + "traits": { + "aws.protocols#ec2QueryName": "OfferingType", + "smithy.api#documentation": "

The Reserved Instance offering type.

", + "smithy.api#xmlName": "offeringType" + } + }, + "RecurringCharges": { + "target": "com.amazonaws.ec2#RecurringChargesList", + "traits": { + "aws.protocols#ec2QueryName": "RecurringCharges", + "smithy.api#documentation": "

The recurring charge tag assigned to the resource.

", + "smithy.api#xmlName": "recurringCharges" + } + }, + "Scope": { + "target": "com.amazonaws.ec2#scope", + "traits": { + "aws.protocols#ec2QueryName": "Scope", + "smithy.api#documentation": "

The scope of the Reserved Instance.

", + "smithy.api#xmlName": "scope" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the resource.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Reserved Instance.

" + } + }, + "com.amazonaws.ec2#ReservedInstancesConfiguration": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone for the modified Reserved Instances.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "InstanceCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of modified Reserved Instances.

\n \n

This is a required field for a request.

\n ", + "smithy.api#xmlName": "instanceCount" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type for the modified Reserved Instances.

", + "smithy.api#xmlName": "instanceType" + } + }, + "Platform": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Platform", + "smithy.api#documentation": "

The network platform of the modified Reserved Instances.

", + "smithy.api#xmlName": "platform" + } + }, + "Scope": { + "target": "com.amazonaws.ec2#scope", + "traits": { + "aws.protocols#ec2QueryName": "Scope", + "smithy.api#documentation": "

Whether the Reserved Instance is applied to instances in a Region or instances in a specific Availability Zone.

", + "smithy.api#xmlName": "scope" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the configuration settings for the modified Reserved Instances.

" + } + }, + "com.amazonaws.ec2#ReservedInstancesConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ReservedInstancesConfiguration", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ReservedInstancesId": { + "type": "structure", + "members": { + "ReservedInstancesId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesId", + "smithy.api#documentation": "

The ID of the Reserved Instance.

", + "smithy.api#xmlName": "reservedInstancesId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the ID of a Reserved Instance.

" + } + }, + "com.amazonaws.ec2#ReservedInstancesIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ReservationId", + "traits": { + "smithy.api#xmlName": "ReservedInstancesId" + } + } + }, + "com.amazonaws.ec2#ReservedInstancesList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ReservedInstances", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ReservedInstancesListing": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

A unique, case-sensitive key supplied by the client to ensure that the request is\n\t\t\tidempotent. For more information, see Ensuring Idempotency.

", + "smithy.api#xmlName": "clientToken" + } + }, + "CreateDate": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreateDate", + "smithy.api#documentation": "

The time the listing was created.

", + "smithy.api#xmlName": "createDate" + } + }, + "InstanceCounts": { + "target": "com.amazonaws.ec2#InstanceCountList", + "traits": { + "aws.protocols#ec2QueryName": "InstanceCounts", + "smithy.api#documentation": "

The number of instances in this state.

", + "smithy.api#xmlName": "instanceCounts" + } + }, + "PriceSchedules": { + "target": "com.amazonaws.ec2#PriceScheduleList", + "traits": { + "aws.protocols#ec2QueryName": "PriceSchedules", + "smithy.api#documentation": "

The price of the Reserved Instance listing.

", + "smithy.api#xmlName": "priceSchedules" + } + }, + "ReservedInstancesId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesId", + "smithy.api#documentation": "

The ID of the Reserved Instance.

", + "smithy.api#xmlName": "reservedInstancesId" + } + }, + "ReservedInstancesListingId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesListingId", + "smithy.api#documentation": "

The ID of the Reserved Instance listing.

", + "smithy.api#xmlName": "reservedInstancesListingId" + } + }, + "Status": { + "target": "com.amazonaws.ec2#ListingStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status of the Reserved Instance listing.

", + "smithy.api#xmlName": "status" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

The reason for the current status of the Reserved Instance listing. The response can be blank.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the resource.

", + "smithy.api#xmlName": "tagSet" + } + }, + "UpdateDate": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "UpdateDate", + "smithy.api#documentation": "

The last modified timestamp of the listing.

", + "smithy.api#xmlName": "updateDate" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Reserved Instance listing.

" + } + }, + "com.amazonaws.ec2#ReservedInstancesListingId": { + "type": "string" + }, + "com.amazonaws.ec2#ReservedInstancesListingList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ReservedInstancesListing", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ReservedInstancesModification": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

A unique, case-sensitive key supplied by the client to ensure that the request is idempotent.\n\t\t\tFor more information, see Ensuring\n\t\t\t\tIdempotency.

", + "smithy.api#xmlName": "clientToken" + } + }, + "CreateDate": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreateDate", + "smithy.api#documentation": "

The time when the modification request was created.

", + "smithy.api#xmlName": "createDate" + } + }, + "EffectiveDate": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "EffectiveDate", + "smithy.api#documentation": "

The time for the modification to become effective.

", + "smithy.api#xmlName": "effectiveDate" + } + }, + "ModificationResults": { + "target": "com.amazonaws.ec2#ReservedInstancesModificationResultList", + "traits": { + "aws.protocols#ec2QueryName": "ModificationResultSet", + "smithy.api#documentation": "

Contains target configurations along with their corresponding new Reserved Instance IDs.

", + "smithy.api#xmlName": "modificationResultSet" + } + }, + "ReservedInstancesIds": { + "target": "com.amazonaws.ec2#ReservedIntancesIds", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesSet", + "smithy.api#documentation": "

The IDs of one or more Reserved Instances.

", + "smithy.api#xmlName": "reservedInstancesSet" + } + }, + "ReservedInstancesModificationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesModificationId", + "smithy.api#documentation": "

A unique ID for the Reserved Instance modification.

", + "smithy.api#xmlName": "reservedInstancesModificationId" + } + }, + "Status": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status of the Reserved Instances modification request.

", + "smithy.api#xmlName": "status" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

The reason for the status.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "UpdateDate": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "UpdateDate", + "smithy.api#documentation": "

The time when the modification request was last updated.

", + "smithy.api#xmlName": "updateDate" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Reserved Instance modification.

" + } + }, + "com.amazonaws.ec2#ReservedInstancesModificationId": { + "type": "string" + }, + "com.amazonaws.ec2#ReservedInstancesModificationIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ReservedInstancesModificationId", + "traits": { + "smithy.api#xmlName": "ReservedInstancesModificationId" + } + } + }, + "com.amazonaws.ec2#ReservedInstancesModificationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ReservedInstancesModification", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ReservedInstancesModificationResult": { + "type": "structure", + "members": { + "ReservedInstancesId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesId", + "smithy.api#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.

", + "smithy.api#xmlName": "reservedInstancesId" + } + }, + "TargetConfiguration": { + "target": "com.amazonaws.ec2#ReservedInstancesConfiguration", + "traits": { + "aws.protocols#ec2QueryName": "TargetConfiguration", + "smithy.api#documentation": "

The target Reserved Instances configurations supplied as part of the modification request.

", + "smithy.api#xmlName": "targetConfiguration" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the modification request/s.

" + } + }, + "com.amazonaws.ec2#ReservedInstancesModificationResultList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ReservedInstancesModificationResult", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ReservedInstancesOffering": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone in which the Reserved Instance can be used.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "Duration": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "Duration", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The duration of the Reserved Instance, in seconds.

", + "smithy.api#xmlName": "duration" + } + }, + "FixedPrice": { + "target": "com.amazonaws.ec2#Float", + "traits": { + "aws.protocols#ec2QueryName": "FixedPrice", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The purchase price of the Reserved Instance.

", + "smithy.api#xmlName": "fixedPrice" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type on which the Reserved Instance can be used.

", + "smithy.api#xmlName": "instanceType" + } + }, + "ProductDescription": { + "target": "com.amazonaws.ec2#RIProductDescription", + "traits": { + "aws.protocols#ec2QueryName": "ProductDescription", + "smithy.api#documentation": "

The Reserved Instance product platform description.

", + "smithy.api#xmlName": "productDescription" + } + }, + "ReservedInstancesOfferingId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesOfferingId", + "smithy.api#documentation": "

The ID of the Reserved Instance offering. This is the offering ID used in GetReservedInstancesExchangeQuote \n to confirm that an exchange can be made.

", + "smithy.api#xmlName": "reservedInstancesOfferingId" + } + }, + "UsagePrice": { + "target": "com.amazonaws.ec2#Float", + "traits": { + "aws.protocols#ec2QueryName": "UsagePrice", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The usage price of the Reserved Instance, per hour.

", + "smithy.api#xmlName": "usagePrice" + } + }, + "CurrencyCode": { + "target": "com.amazonaws.ec2#CurrencyCodeValues", + "traits": { + "aws.protocols#ec2QueryName": "CurrencyCode", + "smithy.api#documentation": "

The currency of the Reserved Instance offering you are purchasing. It's \n\t\t\t\tspecified using ISO 4217 standard currency codes. At this time, \n\t\t\t\tthe only supported currency is USD.

", + "smithy.api#xmlName": "currencyCode" + } + }, + "InstanceTenancy": { + "target": "com.amazonaws.ec2#Tenancy", + "traits": { + "aws.protocols#ec2QueryName": "InstanceTenancy", + "smithy.api#documentation": "

The tenancy of the instance.

", + "smithy.api#xmlName": "instanceTenancy" + } + }, + "Marketplace": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Marketplace", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or Amazon Web Services. \n If it's a Reserved Instance Marketplace offering, this is true.

", + "smithy.api#xmlName": "marketplace" + } + }, + "OfferingClass": { + "target": "com.amazonaws.ec2#OfferingClassType", + "traits": { + "aws.protocols#ec2QueryName": "OfferingClass", + "smithy.api#documentation": "

If convertible it can be exchanged for Reserved Instances of\n the same or higher monetary value, with different configurations. If standard, it is not \n possible to perform an exchange.

", + "smithy.api#xmlName": "offeringClass" + } + }, + "OfferingType": { + "target": "com.amazonaws.ec2#OfferingTypeValues", + "traits": { + "aws.protocols#ec2QueryName": "OfferingType", + "smithy.api#documentation": "

The Reserved Instance offering type.

", + "smithy.api#xmlName": "offeringType" + } + }, + "PricingDetails": { + "target": "com.amazonaws.ec2#PricingDetailsList", + "traits": { + "aws.protocols#ec2QueryName": "PricingDetailsSet", + "smithy.api#documentation": "

The pricing details of the Reserved Instance offering.

", + "smithy.api#xmlName": "pricingDetailsSet" + } + }, + "RecurringCharges": { + "target": "com.amazonaws.ec2#RecurringChargesList", + "traits": { + "aws.protocols#ec2QueryName": "RecurringCharges", + "smithy.api#documentation": "

The recurring charge tag assigned to the resource.

", + "smithy.api#xmlName": "recurringCharges" + } + }, + "Scope": { + "target": "com.amazonaws.ec2#scope", + "traits": { + "aws.protocols#ec2QueryName": "Scope", + "smithy.api#documentation": "

Whether the Reserved Instance is applied to instances in a Region or an Availability Zone.

", + "smithy.api#xmlName": "scope" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Reserved Instance offering.

" + } + }, + "com.amazonaws.ec2#ReservedInstancesOfferingId": { + "type": "string" + }, + "com.amazonaws.ec2#ReservedInstancesOfferingIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ReservedInstancesOfferingId" + } + }, + "com.amazonaws.ec2#ReservedInstancesOfferingList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ReservedInstancesOffering", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ReservedIntancesIds": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ReservedInstancesId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ResetAddressAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ResetAddressAttributeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ResetAddressAttributeResult" + }, + "traits": { + "smithy.api#documentation": "

Resets the attribute of the specified IP address. For requirements, see Using reverse DNS for email applications.

" + } + }, + "com.amazonaws.ec2#ResetAddressAttributeRequest": { + "type": "structure", + "members": { + "AllocationId": { + "target": "com.amazonaws.ec2#AllocationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

[EC2-VPC] The allocation ID.

", + "smithy.api#required": {} + } + }, + "Attribute": { + "target": "com.amazonaws.ec2#AddressAttributeName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The attribute of the IP address.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ResetAddressAttributeResult": { + "type": "structure", + "members": { + "Address": { + "target": "com.amazonaws.ec2#AddressAttribute", + "traits": { + "aws.protocols#ec2QueryName": "Address", + "smithy.api#documentation": "

Information about the IP address.

", + "smithy.api#xmlName": "address" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ResetEbsDefaultKmsKeyId": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ResetEbsDefaultKmsKeyIdRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ResetEbsDefaultKmsKeyIdResult" + }, + "traits": { + "smithy.api#documentation": "

Resets the default KMS key for EBS encryption for your account in this Region \n to the Amazon Web Services managed KMS key for EBS.

\n

After resetting the default KMS key to the Amazon Web Services managed KMS key, you can continue to encrypt by a \n customer managed KMS key by specifying it when you create the volume. For more information, see\n Amazon EBS encryption\n in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#ResetEbsDefaultKmsKeyIdRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ResetEbsDefaultKmsKeyIdResult": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KmsKeyId", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the default KMS key for EBS encryption by default.

", + "smithy.api#xmlName": "kmsKeyId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ResetFpgaImageAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ResetFpgaImageAttributeRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ResetFpgaImageAttributeResult" + }, + "traits": { + "smithy.api#documentation": "

Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default value.\n\t\t You can only reset the load permission attribute.

" + } + }, + "com.amazonaws.ec2#ResetFpgaImageAttributeName": { + "type": "enum", + "members": { + "loadPermission": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "loadPermission" + } + } + } + }, + "com.amazonaws.ec2#ResetFpgaImageAttributeRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "FpgaImageId": { + "target": "com.amazonaws.ec2#FpgaImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the AFI.

", + "smithy.api#required": {} + } + }, + "Attribute": { + "target": "com.amazonaws.ec2#ResetFpgaImageAttributeName", + "traits": { + "smithy.api#documentation": "

The attribute.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ResetFpgaImageAttributeResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Is true if the request succeeds, and an error otherwise.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ResetImageAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ResetImageAttributeRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Resets an attribute of an AMI to its default value.

" + } + }, + "com.amazonaws.ec2#ResetImageAttributeName": { + "type": "enum", + "members": { + "launchPermission": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "launchPermission" + } + } + } + }, + "com.amazonaws.ec2#ResetImageAttributeRequest": { + "type": "structure", + "members": { + "Attribute": { + "target": "com.amazonaws.ec2#ResetImageAttributeName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The attribute to reset (currently you can only reset the launch permission attribute).

", + "smithy.api#required": {} + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for ResetImageAttribute.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ResetInstanceAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ResetInstanceAttributeRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Resets an attribute of an instance to its default value. To reset the\n kernel or ramdisk, the instance must be in a stopped\n state. To reset the sourceDestCheck, the instance can be either running or\n stopped.

\n

The sourceDestCheck attribute controls whether source/destination\n checking is enabled. The default value is true, which means checking is\n enabled. This value must be false for a NAT instance to perform NAT. For\n more information, see NAT Instances in the\n Amazon VPC User Guide.

" + } + }, + "com.amazonaws.ec2#ResetInstanceAttributeRequest": { + "type": "structure", + "members": { + "Attribute": { + "target": "com.amazonaws.ec2#InstanceAttributeName", + "traits": { + "aws.protocols#ec2QueryName": "Attribute", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The attribute to reset.

\n \n

You can only reset the following attributes: kernel |\n ramdisk | sourceDestCheck.

\n ", + "smithy.api#required": {}, + "smithy.api#xmlName": "attribute" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "instanceId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ResetNetworkInterfaceAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ResetNetworkInterfaceAttributeRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Resets a network interface attribute. You can specify only one attribute at a time.

" + } + }, + "com.amazonaws.ec2#ResetNetworkInterfaceAttributeRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "SourceDestCheck": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SourceDestCheck", + "smithy.api#documentation": "

The source/destination checking attribute. Resets the value to true.

", + "smithy.api#xmlName": "sourceDestCheck" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for ResetNetworkInterfaceAttribute.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ResetSnapshotAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ResetSnapshotAttributeRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Resets permission settings for the specified snapshot.

\n

For more information about modifying snapshot permissions, see Share a snapshot in the\n Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#ResetSnapshotAttributeRequest": { + "type": "structure", + "members": { + "Attribute": { + "target": "com.amazonaws.ec2#SnapshotAttributeName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The attribute to reset. Currently, only the attribute for permission to create volumes can\n be reset.

", + "smithy.api#required": {} + } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the snapshot.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1283 + } + } + }, + "com.amazonaws.ec2#ResourceIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TaggableResourceId" + } + }, + "com.amazonaws.ec2#ResourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ResourceStatement": { + "type": "structure", + "members": { + "Resources": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "ResourceSet", + "smithy.api#documentation": "

The resources.

", + "smithy.api#xmlName": "resourceSet" + } + }, + "ResourceTypes": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "ResourceTypeSet", + "smithy.api#documentation": "

The resource types.

", + "smithy.api#xmlName": "resourceTypeSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a resource statement.

" + } + }, + "com.amazonaws.ec2#ResourceStatementRequest": { + "type": "structure", + "members": { + "Resources": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The resources.

", + "smithy.api#xmlName": "Resource" + } + }, + "ResourceTypes": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The resource types.

", + "smithy.api#xmlName": "ResourceType" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a resource statement.

" + } + }, + "com.amazonaws.ec2#ResourceType": { + "type": "enum", + "members": { + "capacity_reservation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "capacity-reservation" + } + }, + "client_vpn_endpoint": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "client-vpn-endpoint" + } + }, + "customer_gateway": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "customer-gateway" + } + }, + "carrier_gateway": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "carrier-gateway" + } + }, + "coip_pool": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "coip-pool" + } + }, + "dedicated_host": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dedicated-host" + } + }, + "dhcp_options": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dhcp-options" + } + }, + "egress_only_internet_gateway": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "egress-only-internet-gateway" + } + }, + "elastic_ip": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "elastic-ip" + } + }, + "elastic_gpu": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "elastic-gpu" + } + }, + "export_image_task": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "export-image-task" + } + }, + "export_instance_task": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "export-instance-task" + } + }, + "fleet": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fleet" + } + }, + "fpga_image": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fpga-image" + } + }, + "host_reservation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "host-reservation" + } + }, + "image": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "image" + } + }, + "import_image_task": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "import-image-task" + } + }, + "import_snapshot_task": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "import-snapshot-task" + } + }, + "instance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "instance" + } + }, + "instance_event_window": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "instance-event-window" + } + }, + "internet_gateway": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "internet-gateway" + } + }, + "ipam": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipam" + } + }, + "ipam_pool": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipam-pool" + } + }, + "ipam_scope": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipam-scope" + } + }, + "ipv4pool_ec2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv4pool-ec2" + } + }, + "ipv6pool_ec2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv6pool-ec2" + } + }, + "key_pair": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "key-pair" + } + }, + "launch_template": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "launch-template" + } + }, + "local_gateway": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "local-gateway" + } + }, + "local_gateway_route_table": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "local-gateway-route-table" + } + }, + "local_gateway_virtual_interface": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "local-gateway-virtual-interface" + } + }, + "local_gateway_virtual_interface_group": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "local-gateway-virtual-interface-group" + } + }, + "local_gateway_route_table_vpc_association": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "local-gateway-route-table-vpc-association" + } + }, + "local_gateway_route_table_virtual_interface_group_association": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "local-gateway-route-table-virtual-interface-group-association" + } + }, + "natgateway": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "natgateway" + } + }, + "network_acl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "network-acl" + } + }, + "network_interface": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "network-interface" + } + }, + "network_insights_analysis": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "network-insights-analysis" + } + }, + "network_insights_path": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "network-insights-path" + } + }, + "network_insights_access_scope": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "network-insights-access-scope" + } + }, + "network_insights_access_scope_analysis": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "network-insights-access-scope-analysis" + } + }, + "placement_group": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "placement-group" + } + }, + "prefix_list": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "prefix-list" + } + }, + "replace_root_volume_task": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "replace-root-volume-task" + } + }, + "reserved_instances": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "reserved-instances" + } + }, + "route_table": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "route-table" + } + }, + "security_group": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "security-group" + } + }, + "security_group_rule": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "security-group-rule" + } + }, + "snapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "snapshot" + } + }, + "spot_fleet_request": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "spot-fleet-request" + } + }, + "spot_instances_request": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "spot-instances-request" + } + }, + "subnet": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "subnet" + } + }, + "subnet_cidr_reservation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "subnet-cidr-reservation" + } + }, + "traffic_mirror_filter": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "traffic-mirror-filter" + } + }, + "traffic_mirror_session": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "traffic-mirror-session" + } + }, + "traffic_mirror_target": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "traffic-mirror-target" + } + }, + "transit_gateway": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "transit-gateway" + } + }, + "transit_gateway_attachment": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "transit-gateway-attachment" + } + }, + "transit_gateway_connect_peer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "transit-gateway-connect-peer" + } + }, + "transit_gateway_multicast_domain": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "transit-gateway-multicast-domain" + } + }, + "transit_gateway_policy_table": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "transit-gateway-policy-table" + } + }, + "transit_gateway_route_table": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "transit-gateway-route-table" + } + }, + "transit_gateway_route_table_announcement": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "transit-gateway-route-table-announcement" + } + }, + "volume": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "volume" + } + }, + "vpc": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc" + } + }, + "vpc_endpoint": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc-endpoint" + } + }, + "vpc_endpoint_connection": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc-endpoint-connection" + } + }, + "vpc_endpoint_service": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc-endpoint-service" + } + }, + "vpc_endpoint_service_permission": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc-endpoint-service-permission" + } + }, + "vpc_peering_connection": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc-peering-connection" + } + }, + "vpn_connection": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpn-connection" + } + }, + "vpn_gateway": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpn-gateway" + } + }, + "vpc_flow_log": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc-flow-log" + } + }, + "capacity_reservation_fleet": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "capacity-reservation-fleet" + } + }, + "traffic_mirror_filter_rule": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "traffic-mirror-filter-rule" + } + }, + "vpc_endpoint_connection_device_type": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc-endpoint-connection-device-type" + } + }, + "verified_access_instance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "verified-access-instance" + } + }, + "verified_access_group": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "verified-access-group" + } + }, + "verified_access_endpoint": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "verified-access-endpoint" + } + }, + "verified_access_policy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "verified-access-policy" + } + }, + "verified_access_trust_provider": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "verified-access-trust-provider" + } + }, + "vpn_connection_device_type": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpn-connection-device-type" + } + }, + "vpc_block_public_access_exclusion": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc-block-public-access-exclusion" + } + }, + "ipam_resource_discovery": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipam-resource-discovery" + } + }, + "ipam_resource_discovery_association": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipam-resource-discovery-association" + } + }, + "instance_connect_endpoint": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "instance-connect-endpoint" + } + } + } + }, + "com.amazonaws.ec2#ResponseError": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#LaunchTemplateErrorCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The error code.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The error message, if applicable.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the error that's returned when you cannot delete a launch template\n version.

" + } + }, + "com.amazonaws.ec2#ResponseHostIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ResponseHostIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ResponseLaunchTemplateData": { + "type": "structure", + "members": { + "KernelId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KernelId", + "smithy.api#documentation": "

The ID of the kernel, if applicable.

", + "smithy.api#xmlName": "kernelId" + } + }, + "EbsOptimized": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EbsOptimized", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the instance is optimized for Amazon EBS I/O.

", + "smithy.api#xmlName": "ebsOptimized" + } + }, + "IamInstanceProfile": { + "target": "com.amazonaws.ec2#LaunchTemplateIamInstanceProfileSpecification", + "traits": { + "aws.protocols#ec2QueryName": "IamInstanceProfile", + "smithy.api#documentation": "

The IAM instance profile.

", + "smithy.api#xmlName": "iamInstanceProfile" + } + }, + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#LaunchTemplateBlockDeviceMappingList", + "traits": { + "aws.protocols#ec2QueryName": "BlockDeviceMappingSet", + "smithy.api#documentation": "

The block device mappings.

", + "smithy.api#xmlName": "blockDeviceMappingSet" + } + }, + "NetworkInterfaces": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceNetworkInterfaceSpecificationList", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceSet", + "smithy.api#documentation": "

The network interfaces.

", + "smithy.api#xmlName": "networkInterfaceSet" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the AMI or a Systems Manager parameter. The Systems Manager parameter will\n resolve to the ID of the AMI at instance launch.

\n

The value depends on what you specified in the request. The possible values are:

\n \n

For more information, see Use a Systems \n Manager parameter instead of an AMI ID in the Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#xmlName": "imageId" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type.

", + "smithy.api#xmlName": "instanceType" + } + }, + "KeyName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KeyName", + "smithy.api#documentation": "

The name of the key pair.

", + "smithy.api#xmlName": "keyName" + } + }, + "Monitoring": { + "target": "com.amazonaws.ec2#LaunchTemplatesMonitoring", + "traits": { + "aws.protocols#ec2QueryName": "Monitoring", + "smithy.api#documentation": "

The monitoring for the instance.

", + "smithy.api#xmlName": "monitoring" + } + }, + "Placement": { + "target": "com.amazonaws.ec2#LaunchTemplatePlacement", + "traits": { + "aws.protocols#ec2QueryName": "Placement", + "smithy.api#documentation": "

The placement of the instance.

", + "smithy.api#xmlName": "placement" + } + }, + "RamDiskId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RamDiskId", + "smithy.api#documentation": "

The ID of the RAM disk, if applicable.

", + "smithy.api#xmlName": "ramDiskId" + } + }, + "DisableApiTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DisableApiTermination", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

If set to true, indicates that the instance cannot be terminated using\n the Amazon EC2 console, command line tool, or API.

", + "smithy.api#xmlName": "disableApiTermination" + } + }, + "InstanceInitiatedShutdownBehavior": { + "target": "com.amazonaws.ec2#ShutdownBehavior", + "traits": { + "aws.protocols#ec2QueryName": "InstanceInitiatedShutdownBehavior", + "smithy.api#documentation": "

Indicates whether an instance stops or terminates when you initiate shutdown from the\n instance (using the operating system command for system shutdown).

", + "smithy.api#xmlName": "instanceInitiatedShutdownBehavior" + } + }, + "UserData": { + "target": "com.amazonaws.ec2#SensitiveUserData", + "traits": { + "aws.protocols#ec2QueryName": "UserData", + "smithy.api#documentation": "

The user data for the instance.

", + "smithy.api#xmlName": "userData" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#LaunchTemplateTagSpecificationList", + "traits": { + "aws.protocols#ec2QueryName": "TagSpecificationSet", + "smithy.api#documentation": "

The tags that are applied to the resources that are created during instance\n launch.

", + "smithy.api#xmlName": "tagSpecificationSet" + } + }, + "ElasticGpuSpecifications": { + "target": "com.amazonaws.ec2#ElasticGpuSpecificationResponseList", + "traits": { + "aws.protocols#ec2QueryName": "ElasticGpuSpecificationSet", + "smithy.api#documentation": "

The elastic GPU specification.

", + "smithy.api#xmlName": "elasticGpuSpecificationSet" + } + }, + "ElasticInferenceAccelerators": { + "target": "com.amazonaws.ec2#LaunchTemplateElasticInferenceAcceleratorResponseList", + "traits": { + "aws.protocols#ec2QueryName": "ElasticInferenceAcceleratorSet", + "smithy.api#documentation": "

The elastic inference accelerator for the instance.

", + "smithy.api#xmlName": "elasticInferenceAcceleratorSet" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupIdSet", + "smithy.api#documentation": "

The security group IDs.

", + "smithy.api#xmlName": "securityGroupIdSet" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupSet", + "smithy.api#documentation": "

The security group names.

", + "smithy.api#xmlName": "securityGroupSet" + } + }, + "InstanceMarketOptions": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceMarketOptions", + "traits": { + "aws.protocols#ec2QueryName": "InstanceMarketOptions", + "smithy.api#documentation": "

The market (purchasing) option for the instances.

", + "smithy.api#xmlName": "instanceMarketOptions" + } + }, + "CreditSpecification": { + "target": "com.amazonaws.ec2#CreditSpecification", + "traits": { + "aws.protocols#ec2QueryName": "CreditSpecification", + "smithy.api#documentation": "

The credit option for CPU usage of the instance.

", + "smithy.api#xmlName": "creditSpecification" + } + }, + "CpuOptions": { + "target": "com.amazonaws.ec2#LaunchTemplateCpuOptions", + "traits": { + "aws.protocols#ec2QueryName": "CpuOptions", + "smithy.api#documentation": "

The CPU options for the instance. For more information, see Optimizing CPU options in the Amazon Elastic Compute Cloud User\n Guide.

", + "smithy.api#xmlName": "cpuOptions" + } + }, + "CapacityReservationSpecification": { + "target": "com.amazonaws.ec2#LaunchTemplateCapacityReservationSpecificationResponse", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationSpecification", + "smithy.api#documentation": "

Information about the Capacity Reservation targeting option.

", + "smithy.api#xmlName": "capacityReservationSpecification" + } + }, + "LicenseSpecifications": { + "target": "com.amazonaws.ec2#LaunchTemplateLicenseList", + "traits": { + "aws.protocols#ec2QueryName": "LicenseSet", + "smithy.api#documentation": "

The license configurations.

", + "smithy.api#xmlName": "licenseSet" + } + }, + "HibernationOptions": { + "target": "com.amazonaws.ec2#LaunchTemplateHibernationOptions", + "traits": { + "aws.protocols#ec2QueryName": "HibernationOptions", + "smithy.api#documentation": "

Indicates whether an instance is configured for hibernation. For more information, see\n Hibernate\n your instance in the Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#xmlName": "hibernationOptions" + } + }, + "MetadataOptions": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataOptions", + "traits": { + "aws.protocols#ec2QueryName": "MetadataOptions", + "smithy.api#documentation": "

The metadata options for the instance. For more information, see Instance metadata and user data in the\n Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#xmlName": "metadataOptions" + } + }, + "EnclaveOptions": { + "target": "com.amazonaws.ec2#LaunchTemplateEnclaveOptions", + "traits": { + "aws.protocols#ec2QueryName": "EnclaveOptions", + "smithy.api#documentation": "

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.

", + "smithy.api#xmlName": "enclaveOptions" + } + }, + "InstanceRequirements": { + "target": "com.amazonaws.ec2#InstanceRequirements", + "traits": { + "aws.protocols#ec2QueryName": "InstanceRequirements", + "smithy.api#documentation": "

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with these attributes.

\n

If you specify InstanceRequirements, you can't specify\n InstanceTypes.

", + "smithy.api#xmlName": "instanceRequirements" + } + }, + "PrivateDnsNameOptions": { + "target": "com.amazonaws.ec2#LaunchTemplatePrivateDnsNameOptions", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDnsNameOptions", + "smithy.api#documentation": "

The options for the instance hostname.

", + "smithy.api#xmlName": "privateDnsNameOptions" + } + }, + "MaintenanceOptions": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceMaintenanceOptions", + "traits": { + "aws.protocols#ec2QueryName": "MaintenanceOptions", + "smithy.api#documentation": "

The maintenance options for your instance.

", + "smithy.api#xmlName": "maintenanceOptions" + } + }, + "DisableApiStop": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DisableApiStop", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the instance is enabled for stop protection. For more information,\n see Stop\n protection in the Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#xmlName": "disableApiStop" + } + } + }, + "traits": { + "smithy.api#documentation": "

The information for a launch template.

" + } + }, + "com.amazonaws.ec2#RestorableByStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String" + } + }, + "com.amazonaws.ec2#RestoreAddressToClassic": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RestoreAddressToClassicRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RestoreAddressToClassicResult" + }, + "traits": { + "smithy.api#documentation": "\n

This action is deprecated.

\n \n

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.

" + } + }, + "com.amazonaws.ec2#RestoreAddressToClassicRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "PublicIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicIp", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Elastic IP address.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "publicIp" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RestoreAddressToClassicResult": { + "type": "structure", + "members": { + "PublicIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicIp", + "smithy.api#documentation": "

The Elastic IP address.

", + "smithy.api#xmlName": "publicIp" + } + }, + "Status": { + "target": "com.amazonaws.ec2#Status", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The move status for the IP address.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#RestoreImageFromRecycleBin": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RestoreImageFromRecycleBinRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RestoreImageFromRecycleBinResult" + }, + "traits": { + "smithy.api#documentation": "

Restores an AMI from the Recycle Bin. For more information, see Recycle Bin in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#RestoreImageFromRecycleBinRequest": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the AMI to restore.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RestoreImageFromRecycleBinResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#RestoreManagedPrefixListVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RestoreManagedPrefixListVersionRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RestoreManagedPrefixListVersionResult" + }, + "traits": { + "smithy.api#documentation": "

Restores the entries from a previous version of a managed prefix list to a new version of the prefix list.

" + } + }, + "com.amazonaws.ec2#RestoreManagedPrefixListVersionRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "PrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the prefix list.

", + "smithy.api#required": {} + } + }, + "PreviousVersion": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The version to restore.

", + "smithy.api#required": {} + } + }, + "CurrentVersion": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The current version number for the prefix list.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RestoreManagedPrefixListVersionResult": { + "type": "structure", + "members": { + "PrefixList": { + "target": "com.amazonaws.ec2#ManagedPrefixList", + "traits": { + "aws.protocols#ec2QueryName": "PrefixList", + "smithy.api#documentation": "

Information about the prefix list.

", + "smithy.api#xmlName": "prefixList" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#RestoreSnapshotFromRecycleBin": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RestoreSnapshotFromRecycleBinRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RestoreSnapshotFromRecycleBinResult" + }, + "traits": { + "smithy.api#documentation": "

Restores a snapshot from the Recycle Bin. For more information, see Restore \n snapshots from the Recycle Bin in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#RestoreSnapshotFromRecycleBinRequest": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the snapshot to restore.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RestoreSnapshotFromRecycleBinResult": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the snapshot.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutpostArn", + "smithy.api#documentation": "

The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the \n Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#xmlName": "outpostArn" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description for the snapshot.

", + "smithy.api#xmlName": "description" + } + }, + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Encrypted", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the snapshot is encrypted.

", + "smithy.api#xmlName": "encrypted" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the EBS snapshot.

", + "smithy.api#xmlName": "ownerId" + } + }, + "Progress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Progress", + "smithy.api#documentation": "

The progress of the snapshot, as a percentage.

", + "smithy.api#xmlName": "progress" + } + }, + "StartTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "StartTime", + "smithy.api#documentation": "

The time stamp when the snapshot was initiated.

", + "smithy.api#xmlName": "startTime" + } + }, + "State": { + "target": "com.amazonaws.ec2#SnapshotState", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The state of the snapshot.

", + "smithy.api#xmlName": "status" + } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VolumeId", + "smithy.api#documentation": "

The ID of the volume that was used to create the snapshot.

", + "smithy.api#xmlName": "volumeId" + } + }, + "VolumeSize": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "VolumeSize", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The size of the volume, in GiB.

", + "smithy.api#xmlName": "volumeSize" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#RestoreSnapshotTier": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RestoreSnapshotTierRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RestoreSnapshotTierResult" + }, + "traits": { + "smithy.api#documentation": "

Restores an archived Amazon EBS snapshot for use temporarily or permanently, or modifies the restore \n period or restore type for a snapshot that was previously temporarily restored.

\n

For more information see \n Restore an archived snapshot and \n modify the restore period or restore type for a temporarily restored snapshot in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#RestoreSnapshotTierRequest": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the snapshot to restore.

", + "smithy.api#required": {} + } + }, + "TemporaryRestoreDays": { + "target": "com.amazonaws.ec2#RestoreSnapshotTierRequestTemporaryRestoreDays", + "traits": { + "smithy.api#documentation": "

Specifies the number of days for which to temporarily restore an archived snapshot. \n Required for temporary restores only. The snapshot will be automatically re-archived \n after this period.

\n

To temporarily restore an archived snapshot, specify the number of days and omit \n the PermanentRestore parameter or set it to \n false.

" + } + }, + "PermanentRestore": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to permanently restore an archived snapshot. To permanently restore \n an archived snapshot, specify true and omit the \n RestoreSnapshotTierRequest$TemporaryRestoreDays parameter.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RestoreSnapshotTierRequestTemporaryRestoreDays": { + "type": "integer" + }, + "com.amazonaws.ec2#RestoreSnapshotTierResult": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the snapshot.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "RestoreStartTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "RestoreStartTime", + "smithy.api#documentation": "

The date and time when the snapshot restore process started.

", + "smithy.api#xmlName": "restoreStartTime" + } + }, + "RestoreDuration": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "RestoreDuration", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

For temporary restores only. The number of days for which the archived snapshot \n is temporarily restored.

", + "smithy.api#xmlName": "restoreDuration" + } + }, + "IsPermanentRestore": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "IsPermanentRestore", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the snapshot is permanently restored. true indicates a permanent \n restore. false indicates a temporary restore.

", + "smithy.api#xmlName": "isPermanentRestore" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ResultRange": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 20, + "max": 500 + } + } + }, + "com.amazonaws.ec2#RevokeClientVpnIngress": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RevokeClientVpnIngressRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RevokeClientVpnIngressResult" + }, + "traits": { + "smithy.api#documentation": "

Removes an ingress authorization rule from a Client VPN endpoint.

" + } + }, + "com.amazonaws.ec2#RevokeClientVpnIngressRequest": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Client VPN endpoint with which the authorization rule is associated.

", + "smithy.api#required": {} + } + }, + "TargetNetworkCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, of the network for which access is being removed.

", + "smithy.api#required": {} + } + }, + "AccessGroupId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of the Active Directory group for which to revoke access.

" + } + }, + "RevokeAllGroups": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether access should be revoked for all clients.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RevokeClientVpnIngressResult": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.ec2#ClientVpnAuthorizationRuleStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The current state of the authorization rule.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#RevokeSecurityGroupEgress": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RevokeSecurityGroupEgressRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RevokeSecurityGroupEgressResult" + }, + "traits": { + "smithy.api#documentation": "

[VPC only] Removes the specified outbound (egress) rules from a security group for EC2-VPC.\n This action does not apply to security groups for use in EC2-Classic.

\n

You can specify rules using either rule IDs or security group rule properties. If you use\n rule properties, the values that you specify (for example, ports) must match the existing rule's \n values exactly. Each rule has a protocol, from and to ports, and destination (CIDR range, \n security group, or prefix list). For the TCP and UDP protocols, you must also specify the \n destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type \n and code. If the security group rule has a description, you do not need to specify the description \n to revoke the rule.

\n

[Default VPC] If the values you specify do not match the existing rule's values, no error is\n returned, and the output describes the security group rules that were not revoked.

\n

Amazon Web Services recommends that you describe the security group to verify that the rules were removed.

\n

Rule changes are propagated to instances within the security group as quickly as possible. However, \n a small delay might occur.

" + } + }, + "com.amazonaws.ec2#RevokeSecurityGroupEgressRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the security group.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "groupId" + } + }, + "IpPermissions": { + "target": "com.amazonaws.ec2#IpPermissionList", + "traits": { + "aws.protocols#ec2QueryName": "IpPermissions", + "smithy.api#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.

", + "smithy.api#xmlName": "ipPermissions" + } + }, + "SecurityGroupRuleIds": { + "target": "com.amazonaws.ec2#SecurityGroupRuleIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the security group rules.

", + "smithy.api#xmlName": "SecurityGroupRuleId" + } + }, + "CidrIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrIp", + "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify the CIDR.

", + "smithy.api#xmlName": "cidrIp" + } + }, + "FromPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "FromPort", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify the port.

", + "smithy.api#xmlName": "fromPort" + } + }, + "IpProtocol": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpProtocol", + "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify the protocol name or\n number.

", + "smithy.api#xmlName": "ipProtocol" + } + }, + "ToPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "ToPort", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify the port.

", + "smithy.api#xmlName": "toPort" + } + }, + "SourceSecurityGroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SourceSecurityGroupName", + "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify a\n destination security group.

", + "smithy.api#xmlName": "sourceSecurityGroupName" + } + }, + "SourceSecurityGroupOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SourceSecurityGroupOwnerId", + "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify a destination security\n group.

", + "smithy.api#xmlName": "sourceSecurityGroupOwnerId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RevokeSecurityGroupEgressResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, returns an error.

", + "smithy.api#xmlName": "return" + } + }, + "UnknownIpPermissions": { + "target": "com.amazonaws.ec2#IpPermissionList", + "traits": { + "aws.protocols#ec2QueryName": "UnknownIpPermissionSet", + "smithy.api#documentation": "

The outbound rules that were unknown to the service. In some cases,\n unknownIpPermissionSet might be in a different format from the request\n parameter.

", + "smithy.api#xmlName": "unknownIpPermissionSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#RevokeSecurityGroupIngress": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RevokeSecurityGroupIngressRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RevokeSecurityGroupIngressResult" + }, + "traits": { + "smithy.api#documentation": "

Removes the specified inbound (ingress) rules from a security group.

\n

You can specify rules using either rule IDs or security group rule properties. If you use\n rule properties, the values that you specify (for example, ports) must match the existing rule's \n values exactly. Each rule has a protocol, from and to ports, and source (CIDR range, \n security group, or prefix list). For the TCP and UDP protocols, you must also specify the \n destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type \n and code. If the security group rule has a description, you do not need to specify the description \n to revoke the rule.

\n

[EC2-Classic, default VPC] If the values you specify do not match the existing rule's values, no error is\n returned, and the output describes the security group rules that were not revoked.

\n

Amazon Web Services recommends that you describe the security group to verify that the rules were removed.

\n

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " + } + }, + "com.amazonaws.ec2#RevokeSecurityGroupIngressRequest": { + "type": "structure", + "members": { + "CidrIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

" + } + }, + "FromPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

If the protocol is TCP or UDP, this is the start of the port range.\n If the protocol is ICMP, this is the type number. A value of -1 indicates all ICMP types.

" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "smithy.api#documentation": "

The ID of the security group. You must specify either the security group ID or the\n security group name in the request. For security groups in a nondefault VPC, you must\n specify the security group ID.

" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#SecurityGroupName", + "traits": { + "smithy.api#documentation": "

[EC2-Classic, default VPC] The name of the security group. You must specify either the\n security group ID or the security group name in the request. For security groups in a\n nondefault VPC, you must specify the security group ID.

" + } + }, + "IpPermissions": { + "target": "com.amazonaws.ec2#IpPermissionList", + "traits": { + "smithy.api#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": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IP protocol name (tcp, udp, icmp) or number \n (see Protocol Numbers). \n Use -1 to specify all.

" + } + }, + "SourceSecurityGroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#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": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

[EC2-Classic] The Amazon Web Services 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": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

If the protocol is TCP or UDP, this is the end of the port range.\n If the protocol is ICMP, this is the code. A value of -1 indicates all ICMP codes.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "SecurityGroupRuleIds": { + "target": "com.amazonaws.ec2#SecurityGroupRuleIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the security group rules.

", + "smithy.api#xmlName": "SecurityGroupRuleId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RevokeSecurityGroupIngressResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, returns an error.

", + "smithy.api#xmlName": "return" + } + }, + "UnknownIpPermissions": { + "target": "com.amazonaws.ec2#IpPermissionList", + "traits": { + "aws.protocols#ec2QueryName": "UnknownIpPermissionSet", + "smithy.api#documentation": "

The inbound rules that were unknown to the service. In some cases,\n unknownIpPermissionSet might be in a different format from the request\n parameter.

", + "smithy.api#xmlName": "unknownIpPermissionSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#RoleId": { + "type": "string" + }, + "com.amazonaws.ec2#RootDeviceType": { + "type": "enum", + "members": { + "ebs": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ebs" + } + }, + "instance_store": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "instance-store" + } + } + } + }, + "com.amazonaws.ec2#RootDeviceTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RootDeviceType", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#Route": { + "type": "structure", + "members": { + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationCidrBlock", + "smithy.api#documentation": "

The IPv4 CIDR block used for the destination match.

", + "smithy.api#xmlName": "destinationCidrBlock" + } + }, + "DestinationIpv6CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationIpv6CidrBlock", + "smithy.api#documentation": "

The IPv6 CIDR block used for the destination match.

", + "smithy.api#xmlName": "destinationIpv6CidrBlock" + } + }, + "DestinationPrefixListId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationPrefixListId", + "smithy.api#documentation": "

The prefix of the Amazon Web Service.

", + "smithy.api#xmlName": "destinationPrefixListId" + } + }, + "EgressOnlyInternetGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "EgressOnlyInternetGatewayId", + "smithy.api#documentation": "

The ID of the egress-only internet gateway.

", + "smithy.api#xmlName": "egressOnlyInternetGatewayId" + } + }, + "GatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GatewayId", + "smithy.api#documentation": "

The ID of a gateway attached to your VPC.

", + "smithy.api#xmlName": "gatewayId" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of a NAT instance in your VPC.

", + "smithy.api#xmlName": "instanceId" + } + }, + "InstanceOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceOwnerId", + "smithy.api#documentation": "

The ID of Amazon Web Services account that owns the instance.

", + "smithy.api#xmlName": "instanceOwnerId" + } + }, + "NatGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NatGatewayId", + "smithy.api#documentation": "

The ID of a NAT gateway.

", + "smithy.api#xmlName": "natGatewayId" + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayId", + "smithy.api#documentation": "

The ID of a transit gateway.

", + "smithy.api#xmlName": "transitGatewayId" + } + }, + "LocalGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayId", + "smithy.api#documentation": "

The ID of the local gateway.

", + "smithy.api#xmlName": "localGatewayId" + } + }, + "CarrierGatewayId": { + "target": "com.amazonaws.ec2#CarrierGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "CarrierGatewayId", + "smithy.api#documentation": "

The ID of the carrier gateway.

", + "smithy.api#xmlName": "carrierGatewayId" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "Origin": { + "target": "com.amazonaws.ec2#RouteOrigin", + "traits": { + "aws.protocols#ec2QueryName": "Origin", + "smithy.api#documentation": "

Describes how the route was created.

\n ", + "smithy.api#xmlName": "origin" + } + }, + "State": { + "target": "com.amazonaws.ec2#RouteState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the route. The blackhole state indicates that the\n\t\t\t\troute's target isn't available (for example, the specified gateway isn't attached to the\n\t\t\t\tVPC, or the specified NAT instance has been terminated).

", + "smithy.api#xmlName": "state" + } + }, + "VpcPeeringConnectionId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", + "smithy.api#documentation": "

The ID of a VPC peering connection.

", + "smithy.api#xmlName": "vpcPeeringConnectionId" + } + }, + "CoreNetworkArn": { + "target": "com.amazonaws.ec2#CoreNetworkArn", + "traits": { + "aws.protocols#ec2QueryName": "CoreNetworkArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the core network.

", + "smithy.api#xmlName": "coreNetworkArn" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a route in a route table.

" + } + }, + "com.amazonaws.ec2#RouteGatewayId": { + "type": "string" + }, + "com.amazonaws.ec2#RouteList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Route", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#RouteOrigin": { + "type": "enum", + "members": { + "CreateRouteTable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateRouteTable" + } + }, + "CreateRoute": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateRoute" + } + }, + "EnableVgwRoutePropagation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EnableVgwRoutePropagation" + } + } + } + }, + "com.amazonaws.ec2#RouteState": { + "type": "enum", + "members": { + "active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "blackhole": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "blackhole" + } + } + } + }, + "com.amazonaws.ec2#RouteTable": { + "type": "structure", + "members": { + "Associations": { + "target": "com.amazonaws.ec2#RouteTableAssociationList", + "traits": { + "aws.protocols#ec2QueryName": "AssociationSet", + "smithy.api#documentation": "

The associations between the route table and one or more subnets or a gateway.

", + "smithy.api#xmlName": "associationSet" + } + }, + "PropagatingVgws": { + "target": "com.amazonaws.ec2#PropagatingVgwList", + "traits": { + "aws.protocols#ec2QueryName": "PropagatingVgwSet", + "smithy.api#documentation": "

Any virtual private gateway (VGW) propagating routes.

", + "smithy.api#xmlName": "propagatingVgwSet" + } + }, + "RouteTableId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RouteTableId", + "smithy.api#documentation": "

The ID of the route table.

", + "smithy.api#xmlName": "routeTableId" + } + }, + "Routes": { + "target": "com.amazonaws.ec2#RouteList", + "traits": { + "aws.protocols#ec2QueryName": "RouteSet", + "smithy.api#documentation": "

The routes in the route table.

", + "smithy.api#xmlName": "routeSet" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the route table.

", + "smithy.api#xmlName": "tagSet" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the route table.

", + "smithy.api#xmlName": "ownerId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a route table.

" + } + }, + "com.amazonaws.ec2#RouteTableAssociation": { + "type": "structure", + "members": { + "Main": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Main", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether this is the main route table.

", + "smithy.api#xmlName": "main" + } + }, + "RouteTableAssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RouteTableAssociationId", + "smithy.api#documentation": "

The ID of the association.

", + "smithy.api#xmlName": "routeTableAssociationId" + } + }, + "RouteTableId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RouteTableId", + "smithy.api#documentation": "

The ID of the route table.

", + "smithy.api#xmlName": "routeTableId" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet. A subnet ID is not returned for an implicit association.

", + "smithy.api#xmlName": "subnetId" + } + }, + "GatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GatewayId", + "smithy.api#documentation": "

The ID of the internet gateway or virtual private gateway.

", + "smithy.api#xmlName": "gatewayId" + } + }, + "AssociationState": { + "target": "com.amazonaws.ec2#RouteTableAssociationState", + "traits": { + "aws.protocols#ec2QueryName": "AssociationState", + "smithy.api#documentation": "

The state of the association.

", + "smithy.api#xmlName": "associationState" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an association between a route table and a subnet or gateway.

" + } + }, + "com.amazonaws.ec2#RouteTableAssociationId": { + "type": "string" + }, + "com.amazonaws.ec2#RouteTableAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RouteTableAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#RouteTableAssociationState": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.ec2#RouteTableAssociationStateCode", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the association.

", + "smithy.api#xmlName": "state" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

The status message, if applicable.

", + "smithy.api#xmlName": "statusMessage" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the state of an association between a route table and a subnet or gateway.

" + } + }, + "com.amazonaws.ec2#RouteTableAssociationStateCode": { + "type": "enum", + "members": { + "associating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associating" + } + }, + "associated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associated" + } + }, + "disassociating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociating" + } + }, + "disassociated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociated" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + } + } + }, + "com.amazonaws.ec2#RouteTableId": { + "type": "string" + }, + "com.amazonaws.ec2#RouteTableIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RouteTableId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#RouteTableList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RouteTable", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#RuleAction": { + "type": "enum", + "members": { + "allow": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "allow" + } + }, + "deny": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deny" + } + } + } + }, + "com.amazonaws.ec2#RuleGroupRuleOptionsPair": { + "type": "structure", + "members": { + "RuleGroupArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "RuleGroupArn", + "smithy.api#documentation": "

The ARN of the rule group.

", + "smithy.api#xmlName": "ruleGroupArn" + } + }, + "RuleOptions": { + "target": "com.amazonaws.ec2#RuleOptionList", + "traits": { + "aws.protocols#ec2QueryName": "RuleOptionSet", + "smithy.api#documentation": "

The rule options.

", + "smithy.api#xmlName": "ruleOptionSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the rule options for a stateful rule group.

" + } + }, + "com.amazonaws.ec2#RuleGroupRuleOptionsPairList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RuleGroupRuleOptionsPair", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#RuleGroupTypePair": { + "type": "structure", + "members": { + "RuleGroupArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "RuleGroupArn", + "smithy.api#documentation": "

The ARN of the rule group.

", + "smithy.api#xmlName": "ruleGroupArn" + } + }, + "RuleGroupType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RuleGroupType", + "smithy.api#documentation": "

The rule group type. The possible values are Domain List and Suricata.

", + "smithy.api#xmlName": "ruleGroupType" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the type of a stateful rule group.

" + } + }, + "com.amazonaws.ec2#RuleGroupTypePairList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RuleGroupTypePair", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#RuleOption": { + "type": "structure", + "members": { + "Keyword": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Keyword", + "smithy.api#documentation": "

The Suricata keyword.

", + "smithy.api#xmlName": "keyword" + } + }, + "Settings": { + "target": "com.amazonaws.ec2#StringList", + "traits": { + "aws.protocols#ec2QueryName": "SettingSet", + "smithy.api#documentation": "

The settings for the keyword.

", + "smithy.api#xmlName": "settingSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes additional settings for a stateful rule.

" + } + }, + "com.amazonaws.ec2#RuleOptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RuleOption", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#RunInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RunInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#Reservation" + }, + "traits": { + "smithy.api#documentation": "

Launches the specified number of instances using an AMI for which you have\n permissions.

\n

You can specify a number of options, or leave the default options. The following rules\n apply:

\n \n

You can create a launch template,\n which is a resource that contains the parameters to launch an instance. When you launch\n an instance using RunInstances, you can specify the launch template\n instead of specifying the launch parameters.

\n

To ensure faster instance launches, break up large requests into smaller batches. For\n example, create five separate launch requests for 100 instances each instead of one\n launch request for 500 instances.

\n

An instance is ready for you to use when it's in the running state. You\n can check the state of your instance using DescribeInstances. You can\n tag instances and EBS volumes during launch, after launch, or both. For more\n information, see CreateTags and Tagging your Amazon EC2\n resources.

\n

Linux instances have access to the public key of the key pair at boot. You can use\n this key to provide secure access to the instance. Amazon EC2 public images use this\n feature to provide secure access without passwords. For more information, see Key\n pairs.

\n

For troubleshooting, see What to do if\n an instance immediately terminates, and Troubleshooting connecting to your instance.

" + } + }, + "com.amazonaws.ec2#RunInstancesMonitoringEnabled": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Enabled", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is\n enabled.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "enabled" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the monitoring of an instance.

" + } + }, + "com.amazonaws.ec2#RunInstancesRequest": { + "type": "structure", + "members": { + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#BlockDeviceMappingRequestList", + "traits": { + "smithy.api#documentation": "

The block device mapping, which defines the EBS volumes and instance store volumes to\n attach to the instance at launch. For more information, see Block device\n mappings in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "BlockDeviceMapping" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#documentation": "

The ID of the AMI. An AMI ID is required to launch an instance and must be specified\n here or in a launch template.

" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "smithy.api#documentation": "

The instance type. For more information, see Instance types in the\n Amazon EC2 User Guide.

\n

Default: m1.small\n

" + } + }, + "Ipv6AddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of IPv6 addresses to associate with the primary network\n interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You\n cannot specify this option and the option to assign specific IPv6 addresses in the same\n request. You can specify this option if you've specified a minimum number of instances\n to launch.

\n

You cannot specify this option and the network interfaces option in the same\n request.

" + } + }, + "Ipv6Addresses": { + "target": "com.amazonaws.ec2#InstanceIpv6AddressList", + "traits": { + "smithy.api#documentation": "

The IPv6 addresses from the range of the subnet to associate with the\n primary network interface. You cannot specify this option and the option to assign a\n number of IPv6 addresses in the same request. You cannot specify this option if you've\n specified a minimum number of instances to launch.

\n

You cannot specify this option and the network interfaces option in the same\n request.

", + "smithy.api#xmlName": "Ipv6Address" + } + }, + "KernelId": { + "target": "com.amazonaws.ec2#KernelId", + "traits": { + "smithy.api#documentation": "

The ID of the kernel.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see PV-GRUB in the\n Amazon EC2 User Guide.

\n " + } + }, + "KeyName": { + "target": "com.amazonaws.ec2#KeyPairName", + "traits": { + "smithy.api#documentation": "

The name of the key pair. You can create a key pair using CreateKeyPair or\n ImportKeyPair.

\n \n

If you do not specify a key pair, you can't connect to the instance unless you\n choose an AMI that is configured to allow users another way to log in.

\n " + } + }, + "MaxCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of instances to launch. If you specify more instances than Amazon\n EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible\n number of instances above MinCount.

\n

Constraints: Between 1 and the maximum number you're allowed for the specified\n instance type. For more information about the default limits, and how to request an\n increase, see How many instances can I\n run in Amazon EC2 in the Amazon EC2 FAQ.

", + "smithy.api#required": {} + } + }, + "MinCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum number of instances to launch. If you specify a minimum that is more\n instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2\n launches no instances.

\n

Constraints: Between 1 and the maximum number you're allowed for the specified\n instance type. For more information about the default limits, and how to request an\n increase, see How many instances can I\n run in Amazon EC2 in the Amazon EC2 General FAQ.

", + "smithy.api#required": {} + } + }, + "Monitoring": { + "target": "com.amazonaws.ec2#RunInstancesMonitoringEnabled", + "traits": { + "smithy.api#documentation": "

Specifies whether detailed monitoring is enabled for the instance.

" + } + }, + "Placement": { + "target": "com.amazonaws.ec2#Placement", + "traits": { + "smithy.api#documentation": "

The placement for the instance.

" + } + }, + "RamdiskId": { + "target": "com.amazonaws.ec2#RamdiskId", + "traits": { + "smithy.api#documentation": "

The ID of the RAM disk to select. Some kernels require additional drivers at launch.\n Check the kernel requirements for information about whether you need to specify a RAM\n disk. To find kernel requirements, go to the Amazon Web Services Resource Center and\n search for the kernel ID.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see PV-GRUB in the\n Amazon EC2 User Guide.

\n " + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#SecurityGroupIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the security groups. You can create a security group using CreateSecurityGroup.

\n

If you specify a network interface, you must specify any security groups as part of\n the network interface.

", + "smithy.api#xmlName": "SecurityGroupId" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.ec2#SecurityGroupStringList", + "traits": { + "smithy.api#documentation": "

[Default VPC] The names of the security groups.

\n

If you specify a network interface, you must specify any security groups as part of\n the network interface.

\n

Default: Amazon EC2 uses the default security group.

", + "smithy.api#xmlName": "SecurityGroup" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#documentation": "

The ID of the subnet to launch the instance into.

\n

If you specify a network interface, you must specify any subnets as part of the\n network interface.

" + } + }, + "UserData": { + "target": "com.amazonaws.ec2#RunInstancesUserData", + "traits": { + "smithy.api#documentation": "

The user data script to make available to the instance. For more information, see\n Run\n commands on your Linux instance at launch and Run commands on your\n Windows instance at launch. If you are using a command line tool,\n base64-encoding is performed for you, and you can load the text from a file. Otherwise,\n you must provide base64-encoded text. User data is limited to 16 KB.

" + } + }, + "AdditionalInfo": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AdditionalInfo", + "smithy.api#documentation": "

Reserved.

", + "smithy.api#xmlName": "additionalInfo" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. If you do not specify a client token, a randomly generated token is used for\n the request to ensure idempotency.

\n

For more information, see Ensuring\n Idempotency.

\n

Constraints: Maximum 64 ASCII characters

", + "smithy.api#idempotencyToken": {}, + "smithy.api#xmlName": "clientToken" + } + }, + "DisableApiTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DisableApiTermination", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

If you set this parameter to true, you can't terminate the instance using\n the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after\n launch, use ModifyInstanceAttribute. Alternatively, if you set\n InstanceInitiatedShutdownBehavior to terminate, you can\n terminate the instance by running the shutdown command from the instance.

\n

Default: false\n

", + "smithy.api#xmlName": "disableApiTermination" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "EbsOptimized": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EbsOptimized", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the instance is optimized for Amazon EBS I/O. This optimization\n provides dedicated throughput to Amazon EBS and an optimized configuration stack to\n provide optimal Amazon EBS I/O performance. This optimization isn't available with all\n instance types. Additional usage charges apply when using an EBS-optimized\n instance.

\n

Default: false\n

", + "smithy.api#xmlName": "ebsOptimized" + } + }, + "IamInstanceProfile": { + "target": "com.amazonaws.ec2#IamInstanceProfileSpecification", + "traits": { + "aws.protocols#ec2QueryName": "IamInstanceProfile", + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of an IAM instance\n profile.

", + "smithy.api#xmlName": "iamInstanceProfile" + } + }, + "InstanceInitiatedShutdownBehavior": { + "target": "com.amazonaws.ec2#ShutdownBehavior", + "traits": { + "aws.protocols#ec2QueryName": "InstanceInitiatedShutdownBehavior", + "smithy.api#documentation": "

Indicates whether an instance stops or terminates when you initiate shutdown from the\n instance (using the operating system command for system shutdown).

\n

Default: stop\n

", + "smithy.api#xmlName": "instanceInitiatedShutdownBehavior" + } + }, + "NetworkInterfaces": { + "target": "com.amazonaws.ec2#InstanceNetworkInterfaceSpecificationList", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterface", + "smithy.api#documentation": "

The network interfaces to associate with the instance. If you specify a network\n interface, you must specify any security groups and subnets as part of the network\n interface.

", + "smithy.api#xmlName": "networkInterface" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

The primary IPv4 address. You must specify a value from the IPv4 address\n range of the subnet.

\n

Only one private IP address can be designated as primary. You can't specify this\n option if you've specified the option to designate a private IP address as the primary\n IP address in a network interface specification. You cannot specify this option if\n you're launching more than one instance in the request.

\n

You cannot specify this option and the network interfaces option in the same\n request.

", + "smithy.api#xmlName": "privateIpAddress" + } + }, + "ElasticGpuSpecification": { + "target": "com.amazonaws.ec2#ElasticGpuSpecifications", + "traits": { + "smithy.api#documentation": "

An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that\n you can attach to your Windows instance to accelerate the graphics performance of your\n applications. For more information, see Amazon EC2 Elastic GPUs in\n the Amazon EC2 User Guide.

" + } + }, + "ElasticInferenceAccelerators": { + "target": "com.amazonaws.ec2#ElasticInferenceAccelerators", + "traits": { + "smithy.api#documentation": "

An elastic inference accelerator to associate with the instance. Elastic inference\n accelerators are a resource you can attach to your Amazon EC2 instances to accelerate\n your Deep Learning (DL) inference workloads.

\n

You cannot specify accelerators from different generations in the same request.

\n \n

Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon\n Elastic Inference (EI), and will help current customers migrate their workloads to\n options that offer better price and performance. After April 15, 2023, new customers\n will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker,\n Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during\n the past 30-day period are considered current customers and will be able to continue\n using the service.

\n ", + "smithy.api#xmlName": "ElasticInferenceAccelerator" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the resources that are created during instance launch.

\n

You can specify tags for the following resources only:

\n \n

To tag a resource after it has been created, see CreateTags.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "LaunchTemplate": { + "target": "com.amazonaws.ec2#LaunchTemplateSpecification", + "traits": { + "smithy.api#documentation": "

The launch template to use to launch the instances. Any parameters that you specify in\n RunInstances override the same parameters in the launch template.\n You can specify either the name or ID of a launch template, but not both.

" + } + }, + "InstanceMarketOptions": { + "target": "com.amazonaws.ec2#InstanceMarketOptionsRequest", + "traits": { + "smithy.api#documentation": "

The market (purchasing) option for the instances.

\n

For RunInstances, persistent Spot Instance requests are\n only supported when InstanceInterruptionBehavior is set\n to either hibernate or stop.

" + } + }, + "CreditSpecification": { + "target": "com.amazonaws.ec2#CreditSpecificationRequest", + "traits": { + "smithy.api#documentation": "

The credit option for CPU usage of the burstable performance instance. Valid values\n are standard and unlimited. To change this attribute after\n launch, use \n ModifyInstanceCreditSpecification. For more information, see Burstable\n performance instances in the Amazon EC2 User Guide.

\n

Default: standard (T2 instances) or unlimited (T3/T3a/T4g\n instances)

\n

For T3 instances with host tenancy, only standard is\n supported.

" + } + }, + "CpuOptions": { + "target": "com.amazonaws.ec2#CpuOptionsRequest", + "traits": { + "smithy.api#documentation": "

The CPU options for the instance. For more information, see Optimize CPU options in the Amazon EC2 User Guide.

" + } + }, + "CapacityReservationSpecification": { + "target": "com.amazonaws.ec2#CapacityReservationSpecification", + "traits": { + "smithy.api#documentation": "

Information about the Capacity Reservation targeting option. If you do not specify this parameter, the\n instance's Capacity Reservation preference defaults to open, which enables\n it to run in any open Capacity Reservation that has matching attributes (instance type,\n platform, Availability Zone).

" + } + }, + "HibernationOptions": { + "target": "com.amazonaws.ec2#HibernationOptionsRequest", + "traits": { + "smithy.api#documentation": "

Indicates whether an instance is enabled for hibernation. For more information, see\n Hibernate\n your instance in the Amazon EC2 User Guide.

\n

You can't enable hibernation and Amazon Web Services Nitro Enclaves on the same\n instance.

" + } + }, + "LicenseSpecifications": { + "target": "com.amazonaws.ec2#LicenseSpecificationListRequest", + "traits": { + "smithy.api#documentation": "

The license configurations.

", + "smithy.api#xmlName": "LicenseSpecification" + } + }, + "MetadataOptions": { + "target": "com.amazonaws.ec2#InstanceMetadataOptionsRequest", + "traits": { + "smithy.api#documentation": "

The metadata options for the instance. For more information, see Instance metadata and user data.

" + } + }, + "EnclaveOptions": { + "target": "com.amazonaws.ec2#EnclaveOptionsRequest", + "traits": { + "smithy.api#documentation": "

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For\n more information, see What is Amazon Web Services Nitro\n Enclaves? in the Amazon Web Services Nitro Enclaves User\n Guide.

\n

You can't enable Amazon Web Services Nitro Enclaves and hibernation on the same\n instance.

" + } + }, + "PrivateDnsNameOptions": { + "target": "com.amazonaws.ec2#PrivateDnsNameOptionsRequest", + "traits": { + "smithy.api#documentation": "

The options for the instance hostname. The default values are inherited from the\n subnet.

" + } + }, + "MaintenanceOptions": { + "target": "com.amazonaws.ec2#InstanceMaintenanceOptionsRequest", + "traits": { + "smithy.api#documentation": "

The maintenance and recovery options for the instance.

" + } + }, + "DisableApiStop": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether an instance is enabled for stop protection. For more information,\n see Stop\n protection.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RunInstancesUserData": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.ec2#RunScheduledInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RunScheduledInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RunScheduledInstancesResult" + }, + "traits": { + "smithy.api#documentation": "

Launches the specified Scheduled Instances.

\n

Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances.

\n

You must launch a Scheduled Instance during its scheduled time period. You can't stop or reboot a Scheduled Instance, \n but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, \n you can launch it again after a few minutes. For more information, see Scheduled Instances\n in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#RunScheduledInstancesRequest": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that ensures the idempotency of the request. \n For more information, see Ensuring Idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of instances.

\n

Default: 1

" + } + }, + "LaunchSpecification": { + "target": "com.amazonaws.ec2#ScheduledInstancesLaunchSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The launch specification. You must match the instance type, Availability Zone, \n network, and platform of the schedule that you purchased.

", + "smithy.api#required": {} + } + }, + "ScheduledInstanceId": { + "target": "com.amazonaws.ec2#ScheduledInstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Scheduled Instance ID.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for RunScheduledInstances.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RunScheduledInstancesResult": { + "type": "structure", + "members": { + "InstanceIdSet": { + "target": "com.amazonaws.ec2#InstanceIdSet", + "traits": { + "aws.protocols#ec2QueryName": "InstanceIdSet", + "smithy.api#documentation": "

The IDs of the newly launched instances.

", + "smithy.api#xmlName": "instanceIdSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of RunScheduledInstances.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#S3ObjectTag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and can be up to 128 Unicode characters in\n length. May not begin with aws:.

" + } + }, + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The value of the tag.

\n

Constraints: Tag values are case-sensitive and can be up to 256 Unicode characters in\n length.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The tags to apply to the AMI object that will be stored in the Amazon S3 bucket. For more\n information, see Categorizing your storage using\n tags in the Amazon Simple Storage Service User Guide.

" + } + }, + "com.amazonaws.ec2#S3ObjectTagList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#S3ObjectTag", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#S3Storage": { + "type": "structure", + "members": { + "AWSAccessKeyId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The access key ID of the owner of the bucket. Before you specify a value for your access\n key ID, review and follow the guidance in Best\n Practices for Amazon Web Services accounts in the Account ManagementReference\n Guide.

" + } + }, + "Bucket": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Bucket", + "smithy.api#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.

", + "smithy.api#xmlName": "bucket" + } + }, + "Prefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Prefix", + "smithy.api#documentation": "

The beginning of the file name of the AMI.

", + "smithy.api#xmlName": "prefix" + } + }, + "UploadPolicy": { + "target": "com.amazonaws.ec2#Blob", + "traits": { + "aws.protocols#ec2QueryName": "UploadPolicy", + "smithy.api#documentation": "

An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.

", + "smithy.api#xmlName": "uploadPolicy" + } + }, + "UploadPolicySignature": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UploadPolicySignature", + "smithy.api#documentation": "

The signature of the JSON document.

", + "smithy.api#xmlName": "uploadPolicySignature" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the storage parameters for Amazon S3 and Amazon S3 buckets for an instance store-backed AMI.

" + } + }, + "com.amazonaws.ec2#ScheduledInstance": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "CreateDate": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreateDate", + "smithy.api#documentation": "

The date when the Scheduled Instance was purchased.

", + "smithy.api#xmlName": "createDate" + } + }, + "HourlyPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "HourlyPrice", + "smithy.api#documentation": "

The hourly price for a single instance.

", + "smithy.api#xmlName": "hourlyPrice" + } + }, + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "InstanceCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of instances.

", + "smithy.api#xmlName": "instanceCount" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type.

", + "smithy.api#xmlName": "instanceType" + } + }, + "NetworkPlatform": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkPlatform", + "smithy.api#documentation": "

The network platform.

", + "smithy.api#xmlName": "networkPlatform" + } + }, + "NextSlotStartTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "NextSlotStartTime", + "smithy.api#documentation": "

The time for the next schedule to start.

", + "smithy.api#xmlName": "nextSlotStartTime" + } + }, + "Platform": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Platform", + "smithy.api#documentation": "

The platform (Linux/UNIX or Windows).

", + "smithy.api#xmlName": "platform" + } + }, + "PreviousSlotEndTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "PreviousSlotEndTime", + "smithy.api#documentation": "

The time that the previous schedule ended or will end.

", + "smithy.api#xmlName": "previousSlotEndTime" + } + }, + "Recurrence": { + "target": "com.amazonaws.ec2#ScheduledInstanceRecurrence", + "traits": { + "aws.protocols#ec2QueryName": "Recurrence", + "smithy.api#documentation": "

The schedule recurrence.

", + "smithy.api#xmlName": "recurrence" + } + }, + "ScheduledInstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ScheduledInstanceId", + "smithy.api#documentation": "

The Scheduled Instance ID.

", + "smithy.api#xmlName": "scheduledInstanceId" + } + }, + "SlotDurationInHours": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "SlotDurationInHours", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of hours in the schedule.

", + "smithy.api#xmlName": "slotDurationInHours" + } + }, + "TermEndDate": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "TermEndDate", + "smithy.api#documentation": "

The end date for the Scheduled Instance.

", + "smithy.api#xmlName": "termEndDate" + } + }, + "TermStartDate": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "TermStartDate", + "smithy.api#documentation": "

The start date for the Scheduled Instance.

", + "smithy.api#xmlName": "termStartDate" + } + }, + "TotalScheduledInstanceHours": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TotalScheduledInstanceHours", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of hours for a single instance for the entire term.

", + "smithy.api#xmlName": "totalScheduledInstanceHours" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Scheduled Instance.

" + } + }, + "com.amazonaws.ec2#ScheduledInstanceAvailability": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "AvailableInstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "AvailableInstanceCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of available instances.

", + "smithy.api#xmlName": "availableInstanceCount" + } + }, + "FirstSlotStartTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "FirstSlotStartTime", + "smithy.api#documentation": "

The time period for the first schedule to start.

", + "smithy.api#xmlName": "firstSlotStartTime" + } + }, + "HourlyPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "HourlyPrice", + "smithy.api#documentation": "

The hourly price for a single instance.

", + "smithy.api#xmlName": "hourlyPrice" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type. You can specify one of the C3, C4, M4, or R3 instance types.

", + "smithy.api#xmlName": "instanceType" + } + }, + "MaxTermDurationInDays": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MaxTermDurationInDays", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum term. The only possible value is 365 days.

", + "smithy.api#xmlName": "maxTermDurationInDays" + } + }, + "MinTermDurationInDays": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MinTermDurationInDays", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum term. The only possible value is 365 days.

", + "smithy.api#xmlName": "minTermDurationInDays" + } + }, + "NetworkPlatform": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkPlatform", + "smithy.api#documentation": "

The network platform.

", + "smithy.api#xmlName": "networkPlatform" + } + }, + "Platform": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Platform", + "smithy.api#documentation": "

The platform (Linux/UNIX or Windows).

", + "smithy.api#xmlName": "platform" + } + }, + "PurchaseToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PurchaseToken", + "smithy.api#documentation": "

The purchase token. This token expires in two hours.

", + "smithy.api#xmlName": "purchaseToken" + } + }, + "Recurrence": { + "target": "com.amazonaws.ec2#ScheduledInstanceRecurrence", + "traits": { + "aws.protocols#ec2QueryName": "Recurrence", + "smithy.api#documentation": "

The schedule recurrence.

", + "smithy.api#xmlName": "recurrence" + } + }, + "SlotDurationInHours": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "SlotDurationInHours", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of hours in the schedule.

", + "smithy.api#xmlName": "slotDurationInHours" + } + }, + "TotalScheduledInstanceHours": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TotalScheduledInstanceHours", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of hours for a single instance for the entire term.

", + "smithy.api#xmlName": "totalScheduledInstanceHours" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a schedule that is available for your Scheduled Instances.

" + } + }, + "com.amazonaws.ec2#ScheduledInstanceAvailabilitySet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ScheduledInstanceAvailability", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ScheduledInstanceId": { + "type": "string" + }, + "com.amazonaws.ec2#ScheduledInstanceIdRequestSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ScheduledInstanceId", + "traits": { + "smithy.api#xmlName": "ScheduledInstanceId" + } + } + }, + "com.amazonaws.ec2#ScheduledInstanceRecurrence": { + "type": "structure", + "members": { + "Frequency": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Frequency", + "smithy.api#documentation": "

The frequency (Daily, Weekly, or Monthly).

", + "smithy.api#xmlName": "frequency" + } + }, + "Interval": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Interval", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The interval quantity. The interval unit depends on the value of frequency. For example, every 2\n weeks or every 2 months.

", + "smithy.api#xmlName": "interval" + } + }, + "OccurrenceDaySet": { + "target": "com.amazonaws.ec2#OccurrenceDaySet", + "traits": { + "aws.protocols#ec2QueryName": "OccurrenceDaySet", + "smithy.api#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).

", + "smithy.api#xmlName": "occurrenceDaySet" + } + }, + "OccurrenceRelativeToEnd": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "OccurrenceRelativeToEnd", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the occurrence is relative to the end of the specified week or month.

", + "smithy.api#xmlName": "occurrenceRelativeToEnd" + } + }, + "OccurrenceUnit": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OccurrenceUnit", + "smithy.api#documentation": "

The unit for occurrenceDaySet (DayOfWeek or DayOfMonth).

", + "smithy.api#xmlName": "occurrenceUnit" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the recurring schedule for a Scheduled Instance.

" + } + }, + "com.amazonaws.ec2#ScheduledInstanceRecurrenceRequest": { + "type": "structure", + "members": { + "Frequency": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The frequency (Daily, Weekly, or Monthly).

" + } + }, + "Interval": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The interval quantity. The interval unit depends on the value of Frequency. For example, every 2 \n weeks or every 2 months.

" + } + }, + "OccurrenceDays": { + "target": "com.amazonaws.ec2#OccurrenceDayRequestSet", + "traits": { + "smithy.api#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.

", + "smithy.api#xmlName": "OccurrenceDay" + } + }, + "OccurrenceRelativeToEnd": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#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": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The unit for OccurrenceDays (DayOfWeek or DayOfMonth).\n This value is required for a monthly schedule.\n You can't specify DayOfWeek with a weekly schedule.\n You can't specify this value with a daily schedule.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the recurring schedule for a Scheduled Instance.

" + } + }, + "com.amazonaws.ec2#ScheduledInstanceSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ScheduledInstance", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ScheduledInstancesBlockDeviceMapping": { + "type": "structure", + "members": { + "DeviceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The device name (for example, /dev/sdh or xvdh).

" + } + }, + "Ebs": { + "target": "com.amazonaws.ec2#ScheduledInstancesEbs", + "traits": { + "smithy.api#documentation": "

Parameters used to set up EBS volumes automatically when the instance is launched.

" + } + }, + "NoDevice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

To omit the device from the block device mapping, specify an empty string.

" + } + }, + "VirtualName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The virtual device name (ephemeralN). Instance store volumes are numbered\n starting from 0. An instance type with two available instance store volumes can specify mappings\n for ephemeral0 and ephemeral1. The number of available instance store\n volumes depends on the instance type. After you connect to the instance, you must mount the\n volume.

\n

Constraints: For M3 instances, you must specify instance store volumes in the block device \n mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes \n specified in the block device mapping for the AMI.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a block device mapping for a Scheduled Instance.

" + } + }, + "com.amazonaws.ec2#ScheduledInstancesBlockDeviceMappingSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ScheduledInstancesBlockDeviceMapping", + "traits": { + "smithy.api#xmlName": "BlockDeviceMapping" + } + } + }, + "com.amazonaws.ec2#ScheduledInstancesEbs": { + "type": "structure", + "members": { + "DeleteOnTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the volume is deleted on instance termination.

" + } + }, + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the volume is encrypted. You can attached encrypted volumes only to instances that support them.

" + } + }, + "Iops": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of I/O operations per second (IOPS) to provision for an io1 or io2 volume, with a maximum\n \t\tratio of 50 IOPS/GiB for io1, and 500 IOPS/GiB for io2. Range is 100 to 64,000 IOPS for\n \t\tvolumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on\n \t\tinstances built on the Nitro System. Other instance families guarantee performance up to\n \t\t32,000 IOPS. For more information, see Amazon EBS volume types in the\n \t\tAmazon EC2 User Guide.

\n

This parameter is valid only for Provisioned IOPS SSD (io1 and io2) volumes.

" + } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "smithy.api#documentation": "

The ID of the snapshot.

" + } + }, + "VolumeSize": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The size of the volume, in GiB.

\n

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

" + } + }, + "VolumeType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The volume type. gp2 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, Throughput Optimized HDD\n for st1, Cold HDD for sc1, or standard for\n Magnetic.

\n

Default: gp2\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an EBS volume for a Scheduled Instance.

" + } + }, + "com.amazonaws.ec2#ScheduledInstancesIamInstanceProfile": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN).

" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an IAM instance profile for a Scheduled Instance.

" + } + }, + "com.amazonaws.ec2#ScheduledInstancesIpv6Address": { + "type": "structure", + "members": { + "Ipv6Address": { + "target": "com.amazonaws.ec2#Ipv6Address", + "traits": { + "smithy.api#documentation": "

The IPv6 address.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an IPv6 address.

" + } + }, + "com.amazonaws.ec2#ScheduledInstancesIpv6AddressList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ScheduledInstancesIpv6Address", + "traits": { + "smithy.api#xmlName": "Ipv6Address" + } + } + }, + "com.amazonaws.ec2#ScheduledInstancesLaunchSpecification": { + "type": "structure", + "members": { + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#ScheduledInstancesBlockDeviceMappingSet", + "traits": { + "smithy.api#documentation": "

The block device mapping entries.

", + "smithy.api#xmlName": "BlockDeviceMapping" + } + }, + "EbsOptimized": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#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.

\n

Default: false\n

" + } + }, + "IamInstanceProfile": { + "target": "com.amazonaws.ec2#ScheduledInstancesIamInstanceProfile", + "traits": { + "smithy.api#documentation": "

The IAM instance profile.

" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI).

", + "smithy.api#required": {} + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The instance type.

" + } + }, + "KernelId": { + "target": "com.amazonaws.ec2#KernelId", + "traits": { + "smithy.api#documentation": "

The ID of the kernel.

" + } + }, + "KeyName": { + "target": "com.amazonaws.ec2#KeyPairName", + "traits": { + "smithy.api#documentation": "

The name of the key pair.

" + } + }, + "Monitoring": { + "target": "com.amazonaws.ec2#ScheduledInstancesMonitoring", + "traits": { + "smithy.api#documentation": "

Enable or disable monitoring for the instances.

" + } + }, + "NetworkInterfaces": { + "target": "com.amazonaws.ec2#ScheduledInstancesNetworkInterfaceSet", + "traits": { + "smithy.api#documentation": "

The network interfaces.

", + "smithy.api#xmlName": "NetworkInterface" + } + }, + "Placement": { + "target": "com.amazonaws.ec2#ScheduledInstancesPlacement", + "traits": { + "smithy.api#documentation": "

The placement information.

" + } + }, + "RamdiskId": { + "target": "com.amazonaws.ec2#RamdiskId", + "traits": { + "smithy.api#documentation": "

The ID of the RAM disk.

" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#ScheduledInstancesSecurityGroupIdSet", + "traits": { + "smithy.api#documentation": "

The IDs of the security groups.

", + "smithy.api#xmlName": "SecurityGroupId" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#documentation": "

The ID of the subnet in which to launch the instances.

" + } + }, + "UserData": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The base64-encoded MIME user data.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the launch specification for a Scheduled Instance.

\n

If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet.\n You can specify the subnet using either SubnetId or NetworkInterface.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.ec2#ScheduledInstancesMonitoring": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether monitoring is enabled.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes whether monitoring is enabled for a Scheduled Instance.

" + } + }, + "com.amazonaws.ec2#ScheduledInstancesNetworkInterface": { + "type": "structure", + "members": { + "AssociatePublicIpAddress": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to assign a public IPv4 address to instances launched in a VPC. The\n public IPv4 address can only be assigned to a network interface for eth0, and can only be\n assigned to a new network interface, not an existing one. You cannot specify more than one\n network interface in the request. If launching into a default subnet, the default value is\n true.

" + } + }, + "DeleteOnTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to delete the interface when the instance is terminated.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The description.

" + } + }, + "DeviceIndex": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The index of the device for the network interface attachment.

" + } + }, + "Groups": { + "target": "com.amazonaws.ec2#ScheduledInstancesSecurityGroupIdSet", + "traits": { + "smithy.api#documentation": "

The IDs of the security groups.

", + "smithy.api#xmlName": "Group" + } + }, + "Ipv6AddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of IPv6 addresses to assign to the network interface. The IPv6 addresses are automatically selected from the subnet range.

" + } + }, + "Ipv6Addresses": { + "target": "com.amazonaws.ec2#ScheduledInstancesIpv6AddressList", + "traits": { + "smithy.api#documentation": "

The specific IPv6 addresses from the subnet range.

", + "smithy.api#xmlName": "Ipv6Address" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "smithy.api#documentation": "

The ID of the network interface.

" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv4 address of the network interface within the subnet.

" + } + }, + "PrivateIpAddressConfigs": { + "target": "com.amazonaws.ec2#PrivateIpAddressConfigSet", + "traits": { + "smithy.api#documentation": "

The private IPv4 addresses.

", + "smithy.api#xmlName": "PrivateIpAddressConfig" + } + }, + "SecondaryPrivateIpAddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of secondary private IPv4 addresses.

" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#documentation": "

The ID of the subnet.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a network interface for a Scheduled Instance.

" + } + }, + "com.amazonaws.ec2#ScheduledInstancesNetworkInterfaceSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ScheduledInstancesNetworkInterface", + "traits": { + "smithy.api#xmlName": "NetworkInterface" + } + } + }, + "com.amazonaws.ec2#ScheduledInstancesPlacement": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone.

" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#PlacementGroupName", + "traits": { + "smithy.api#documentation": "

The name of the placement group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the placement for a Scheduled Instance.

" + } + }, + "com.amazonaws.ec2#ScheduledInstancesPrivateIpAddressConfig": { + "type": "structure", + "members": { + "Primary": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether this is a primary IPv4 address. Otherwise, this is a secondary IPv4 address.

" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv4 address.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a private IPv4 address for a Scheduled Instance.

" + } + }, + "com.amazonaws.ec2#ScheduledInstancesSecurityGroupIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "smithy.api#xmlName": "SecurityGroupId" + } + } + }, + "com.amazonaws.ec2#SearchLocalGatewayRoutes": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#SearchLocalGatewayRoutesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#SearchLocalGatewayRoutesResult" + }, + "traits": { + "smithy.api#documentation": "

Searches for routes in the specified local gateway route table.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Routes", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#SearchLocalGatewayRoutesRequest": { + "type": "structure", + "members": { + "LocalGatewayRouteTableId": { + "target": "com.amazonaws.ec2#LocalGatewayRoutetableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the local gateway route table.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#SearchLocalGatewayRoutesResult": { + "type": "structure", + "members": { + "Routes": { + "target": "com.amazonaws.ec2#LocalGatewayRouteList", + "traits": { + "aws.protocols#ec2QueryName": "RouteSet", + "smithy.api#documentation": "

Information about the routes.

", + "smithy.api#xmlName": "routeSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#SearchTransitGatewayMulticastGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#SearchTransitGatewayMulticastGroupsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#SearchTransitGatewayMulticastGroupsResult" + }, + "traits": { + "smithy.api#documentation": "

Searches one or more transit gateway multicast groups and returns the group membership information.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "MulticastGroups", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#SearchTransitGatewayMulticastGroupsRequest": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#SearchTransitGatewayMulticastGroupsResult": { + "type": "structure", + "members": { + "MulticastGroups": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastGroupList", + "traits": { + "aws.protocols#ec2QueryName": "MulticastGroups", + "smithy.api#documentation": "

Information about the transit gateway multicast group.

", + "smithy.api#xmlName": "multicastGroups" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#SearchTransitGatewayRoutes": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#SearchTransitGatewayRoutesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#SearchTransitGatewayRoutesResult" + }, + "traits": { + "smithy.api#documentation": "

Searches for routes in the specified transit gateway route table.

" + } + }, + "com.amazonaws.ec2#SearchTransitGatewayRoutesRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#required": {}, + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of routes to return.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#SearchTransitGatewayRoutesResult": { + "type": "structure", + "members": { + "Routes": { + "target": "com.amazonaws.ec2#TransitGatewayRouteList", + "traits": { + "aws.protocols#ec2QueryName": "RouteSet", + "smithy.api#documentation": "

Information about the routes.

", + "smithy.api#xmlName": "routeSet" + } + }, + "AdditionalRoutesAvailable": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AdditionalRoutesAvailable", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether there are additional routes available.

", + "smithy.api#xmlName": "additionalRoutesAvailable" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#SecurityGroup": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupDescription", + "smithy.api#documentation": "

A description of the security group.

", + "smithy.api#xmlName": "groupDescription" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

The name of the security group.

", + "smithy.api#xmlName": "groupName" + } + }, + "IpPermissions": { + "target": "com.amazonaws.ec2#IpPermissionList", + "traits": { + "aws.protocols#ec2QueryName": "IpPermissions", + "smithy.api#documentation": "

The inbound rules associated with the security group.

", + "smithy.api#xmlName": "ipPermissions" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the security group.

", + "smithy.api#xmlName": "ownerId" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The ID of the security group.

", + "smithy.api#xmlName": "groupId" + } + }, + "IpPermissionsEgress": { + "target": "com.amazonaws.ec2#IpPermissionList", + "traits": { + "aws.protocols#ec2QueryName": "IpPermissionsEgress", + "smithy.api#documentation": "

[VPC only] The outbound rules associated with the security group.

", + "smithy.api#xmlName": "ipPermissionsEgress" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the security group.

", + "smithy.api#xmlName": "tagSet" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

[VPC only] The ID of the VPC for the security group.

", + "smithy.api#xmlName": "vpcId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a security group.

" + } + }, + "com.amazonaws.ec2#SecurityGroupId": { + "type": "string" + }, + "com.amazonaws.ec2#SecurityGroupIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SecurityGroupIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SecurityGroupIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "smithy.api#xmlName": "SecurityGroupId" + } + } + }, + "com.amazonaws.ec2#SecurityGroupIdStringListRequest": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "smithy.api#xmlName": "SecurityGroupId" + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 16 + } + } + }, + "com.amazonaws.ec2#SecurityGroupIdentifier": { + "type": "structure", + "members": { + "GroupId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The ID of the security group.

", + "smithy.api#xmlName": "groupId" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

The name of the security group.

", + "smithy.api#xmlName": "groupName" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a security group.

" + } + }, + "com.amazonaws.ec2#SecurityGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroup", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SecurityGroupName": { + "type": "string" + }, + "com.amazonaws.ec2#SecurityGroupReference": { + "type": "structure", + "members": { + "GroupId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The ID of your security group.

", + "smithy.api#xmlName": "groupId" + } + }, + "ReferencingVpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ReferencingVpcId", + "smithy.api#documentation": "

The ID of the VPC with the referencing security group.

", + "smithy.api#xmlName": "referencingVpcId" + } + }, + "VpcPeeringConnectionId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", + "smithy.api#documentation": "

The ID of the VPC peering connection.

", + "smithy.api#xmlName": "vpcPeeringConnectionId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a VPC with a security group that references your security group.

" + } + }, + "com.amazonaws.ec2#SecurityGroupReferences": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroupReference", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SecurityGroupRule": { + "type": "structure", + "members": { + "SecurityGroupRuleId": { + "target": "com.amazonaws.ec2#SecurityGroupRuleId", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupRuleId", + "smithy.api#documentation": "

The ID of the security group rule.

", + "smithy.api#xmlName": "securityGroupRuleId" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The ID of the security group.

", + "smithy.api#xmlName": "groupId" + } + }, + "GroupOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupOwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the security group.

", + "smithy.api#xmlName": "groupOwnerId" + } + }, + "IsEgress": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "IsEgress", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the security group rule is an outbound rule.

", + "smithy.api#xmlName": "isEgress" + } + }, + "IpProtocol": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpProtocol", + "smithy.api#documentation": "

The IP protocol name (tcp, udp, icmp,\n icmpv6) or number (see Protocol Numbers).

\n

Use -1 to specify all protocols.

", + "smithy.api#xmlName": "ipProtocol" + } + }, + "FromPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "FromPort", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

If the protocol is TCP or UDP, this is the start of the port range.\n If the protocol is ICMP or ICMPv6, this is the type number. A value of -1 indicates all ICMP/ICMPv6 types. \n If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.

", + "smithy.api#xmlName": "fromPort" + } + }, + "ToPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "ToPort", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

If the protocol is TCP or UDP, this is the end of the port range.\n If the protocol is ICMP or ICMPv6, this is the type number. A value of -1 indicates all ICMP/ICMPv6 codes. \n If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.

", + "smithy.api#xmlName": "toPort" + } + }, + "CidrIpv4": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrIpv4", + "smithy.api#documentation": "

The IPv4 CIDR range.

", + "smithy.api#xmlName": "cidrIpv4" + } + }, + "CidrIpv6": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrIpv6", + "smithy.api#documentation": "

The IPv6 CIDR range.

", + "smithy.api#xmlName": "cidrIpv6" + } + }, + "PrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListId", + "smithy.api#documentation": "

The ID of the prefix list.

", + "smithy.api#xmlName": "prefixListId" + } + }, + "ReferencedGroupInfo": { + "target": "com.amazonaws.ec2#ReferencedSecurityGroup", + "traits": { + "aws.protocols#ec2QueryName": "ReferencedGroupInfo", + "smithy.api#documentation": "

Describes the security group that is referenced in the rule.

", + "smithy.api#xmlName": "referencedGroupInfo" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The security group rule description.

", + "smithy.api#xmlName": "description" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags applied to the security group rule.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a security group rule.

" + } + }, + "com.amazonaws.ec2#SecurityGroupRuleDescription": { + "type": "structure", + "members": { + "SecurityGroupRuleId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of the security group rule.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The description of the security group rule.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the description of a security group rule.

\n

You can use this when you want to update the security group rule description for either an inbound or outbound rule.

" + } + }, + "com.amazonaws.ec2#SecurityGroupRuleDescriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroupRuleDescription", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SecurityGroupRuleId": { + "type": "string" + }, + "com.amazonaws.ec2#SecurityGroupRuleIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SecurityGroupRuleList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroupRule", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SecurityGroupRuleRequest": { + "type": "structure", + "members": { + "IpProtocol": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IP protocol name (tcp, udp, icmp,\n icmpv6) or number (see Protocol Numbers).

\n

Use -1 to specify all protocols.

" + } + }, + "FromPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

If the protocol is TCP or UDP, this is the start of the port range.\n If the protocol is ICMP or ICMPv6, this is the type number. A value of -1 indicates all ICMP/ICMPv6 types. \n If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.

" + } + }, + "ToPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

If the protocol is TCP or UDP, this is the end of the port range.\n If the protocol is ICMP or ICMPv6, this is the code. A value of -1 indicates all ICMP/ICMPv6 codes. \n If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.

" + } + }, + "CidrIpv4": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv4 CIDR range. To specify a single IPv4 address, use the /32 prefix length.

" + } + }, + "CidrIpv6": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv6 CIDR range. To specify a single IPv6 address, use the /128 prefix length.

" + } + }, + "PrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the prefix list.

" + } + }, + "ReferencedGroupId": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "smithy.api#documentation": "

The ID of the security group that is referenced in the security group rule.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The description of the security group rule.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a security group rule.

\n

You must specify exactly one of the following parameters, based on the rule type:

\n \n

When you modify a rule, you cannot change the rule type. For example, if the rule \n uses an IPv4 address range, you must use CidrIpv4 to specify a new IPv4 \n address range.

" + } + }, + "com.amazonaws.ec2#SecurityGroupRuleUpdate": { + "type": "structure", + "members": { + "SecurityGroupRuleId": { + "target": "com.amazonaws.ec2#SecurityGroupRuleId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the security group rule.

", + "smithy.api#required": {} + } + }, + "SecurityGroupRule": { + "target": "com.amazonaws.ec2#SecurityGroupRuleRequest", + "traits": { + "smithy.api#documentation": "

Information about the security group rule.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an update to a security group rule.

" + } + }, + "com.amazonaws.ec2#SecurityGroupRuleUpdateList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroupRuleUpdate", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SecurityGroupStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroupName", + "traits": { + "smithy.api#xmlName": "SecurityGroup" + } + } + }, + "com.amazonaws.ec2#SelfServicePortal": { + "type": "enum", + "members": { + "enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + }, + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + } + } + }, + "com.amazonaws.ec2#SendDiagnosticInterrupt": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#SendDiagnosticInterruptRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a\n kernel panic (on Linux instances), or a blue\n screen/stop error (on Windows instances). For\n instances based on Intel and AMD processors, the interrupt is received as a\n non-maskable interrupt (NMI).

\n

In general, the operating system crashes and reboots when a kernel panic or stop error\n is triggered. The operating system can also be configured to perform diagnostic tasks,\n such as generating a memory dump file, loading a secondary kernel, or obtaining a call\n trace.

\n

Before sending a diagnostic interrupt to your instance, ensure that its operating\n system is configured to perform the required diagnostic tasks.

\n

For more information about configuring your operating system to generate a crash dump\n when a kernel panic or stop error occurs, see Send a diagnostic interrupt\n (for advanced users) (Linux instances) or Send a diagnostic\n interrupt (for advanced users) (Windows instances).

" + } + }, + "com.amazonaws.ec2#SendDiagnosticInterruptRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#SensitiveUrl": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.ec2#SensitiveUserData": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.ec2#ServiceConfiguration": { + "type": "structure", + "members": { + "ServiceType": { + "target": "com.amazonaws.ec2#ServiceTypeDetailSet", + "traits": { + "aws.protocols#ec2QueryName": "ServiceType", + "smithy.api#documentation": "

The type of service.

", + "smithy.api#xmlName": "serviceType" + } + }, + "ServiceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ServiceId", + "smithy.api#documentation": "

The ID of the service.

", + "smithy.api#xmlName": "serviceId" + } + }, + "ServiceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ServiceName", + "smithy.api#documentation": "

The name of the service.

", + "smithy.api#xmlName": "serviceName" + } + }, + "ServiceState": { + "target": "com.amazonaws.ec2#ServiceState", + "traits": { + "aws.protocols#ec2QueryName": "ServiceState", + "smithy.api#documentation": "

The service state.

", + "smithy.api#xmlName": "serviceState" + } + }, + "AvailabilityZones": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneSet", + "smithy.api#documentation": "

The Availability Zones in which the service is available.

", + "smithy.api#xmlName": "availabilityZoneSet" + } + }, + "AcceptanceRequired": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AcceptanceRequired", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether requests from other Amazon Web Services accounts to create an endpoint to the service must first be accepted.

", + "smithy.api#xmlName": "acceptanceRequired" + } + }, + "ManagesVpcEndpoints": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "ManagesVpcEndpoints", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the service manages its VPC endpoints. Management of the service VPC\n endpoints using the VPC endpoint API is restricted.

", + "smithy.api#xmlName": "managesVpcEndpoints" + } + }, + "NetworkLoadBalancerArns": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "NetworkLoadBalancerArnSet", + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the Network Load Balancers for the service.

", + "smithy.api#xmlName": "networkLoadBalancerArnSet" + } + }, + "GatewayLoadBalancerArns": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "GatewayLoadBalancerArnSet", + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.

", + "smithy.api#xmlName": "gatewayLoadBalancerArnSet" + } + }, + "SupportedIpAddressTypes": { + "target": "com.amazonaws.ec2#SupportedIpAddressTypes", + "traits": { + "aws.protocols#ec2QueryName": "SupportedIpAddressTypeSet", + "smithy.api#documentation": "

The supported IP address types.

", + "smithy.api#xmlName": "supportedIpAddressTypeSet" + } + }, + "BaseEndpointDnsNames": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "BaseEndpointDnsNameSet", + "smithy.api#documentation": "

The DNS names for the service.

", + "smithy.api#xmlName": "baseEndpointDnsNameSet" + } + }, + "PrivateDnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDnsName", + "smithy.api#documentation": "

The private DNS name for the service.

", + "smithy.api#xmlName": "privateDnsName" + } + }, + "PrivateDnsNameConfiguration": { + "target": "com.amazonaws.ec2#PrivateDnsNameConfiguration", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDnsNameConfiguration", + "smithy.api#documentation": "

Information about the endpoint service private DNS name configuration.

", + "smithy.api#xmlName": "privateDnsNameConfiguration" + } + }, + "PayerResponsibility": { + "target": "com.amazonaws.ec2#PayerResponsibility", + "traits": { + "aws.protocols#ec2QueryName": "PayerResponsibility", + "smithy.api#documentation": "

The payer responsibility.

", + "smithy.api#xmlName": "payerResponsibility" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the service.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a service configuration for a VPC endpoint service.

" + } + }, + "com.amazonaws.ec2#ServiceConfigurationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ServiceConfiguration", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ServiceConnectivityType": { + "type": "enum", + "members": { + "ipv4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv4" + } + }, + "ipv6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv6" + } + } + } + }, + "com.amazonaws.ec2#ServiceDetail": { + "type": "structure", + "members": { + "ServiceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ServiceName", + "smithy.api#documentation": "

The name of the service.

", + "smithy.api#xmlName": "serviceName" + } + }, + "ServiceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ServiceId", + "smithy.api#documentation": "

The ID of the endpoint service.

", + "smithy.api#xmlName": "serviceId" + } + }, + "ServiceType": { + "target": "com.amazonaws.ec2#ServiceTypeDetailSet", + "traits": { + "aws.protocols#ec2QueryName": "ServiceType", + "smithy.api#documentation": "

The type of service.

", + "smithy.api#xmlName": "serviceType" + } + }, + "AvailabilityZones": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneSet", + "smithy.api#documentation": "

The Availability Zones in which the service is available.

", + "smithy.api#xmlName": "availabilityZoneSet" + } + }, + "Owner": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Owner", + "smithy.api#documentation": "

The Amazon Web Services account ID of the service owner.

", + "smithy.api#xmlName": "owner" + } + }, + "BaseEndpointDnsNames": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "BaseEndpointDnsNameSet", + "smithy.api#documentation": "

The DNS names for the service.

", + "smithy.api#xmlName": "baseEndpointDnsNameSet" + } + }, + "PrivateDnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDnsName", + "smithy.api#documentation": "

The private DNS name for the service.

", + "smithy.api#xmlName": "privateDnsName" + } + }, + "PrivateDnsNames": { + "target": "com.amazonaws.ec2#PrivateDnsDetailsSet", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDnsNameSet", + "smithy.api#documentation": "

The private DNS names assigned to the VPC endpoint service.

", + "smithy.api#xmlName": "privateDnsNameSet" + } + }, + "VpcEndpointPolicySupported": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "VpcEndpointPolicySupported", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the service supports endpoint policies.

", + "smithy.api#xmlName": "vpcEndpointPolicySupported" + } + }, + "AcceptanceRequired": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AcceptanceRequired", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether VPC endpoint connection requests to the service must be accepted by the service owner.

", + "smithy.api#xmlName": "acceptanceRequired" + } + }, + "ManagesVpcEndpoints": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "ManagesVpcEndpoints", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the service manages its VPC endpoints. Management of the service VPC\n endpoints using the VPC endpoint API is restricted.

", + "smithy.api#xmlName": "managesVpcEndpoints" + } + }, + "PayerResponsibility": { + "target": "com.amazonaws.ec2#PayerResponsibility", + "traits": { + "aws.protocols#ec2QueryName": "PayerResponsibility", + "smithy.api#documentation": "

The payer responsibility.

", + "smithy.api#xmlName": "payerResponsibility" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the service.

", + "smithy.api#xmlName": "tagSet" + } + }, + "PrivateDnsNameVerificationState": { + "target": "com.amazonaws.ec2#DnsNameState", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDnsNameVerificationState", + "smithy.api#documentation": "

The verification state of the VPC endpoint service.

\n

Consumers of the endpoint service cannot use the private name when the state is not verified.

", + "smithy.api#xmlName": "privateDnsNameVerificationState" + } + }, + "SupportedIpAddressTypes": { + "target": "com.amazonaws.ec2#SupportedIpAddressTypes", + "traits": { + "aws.protocols#ec2QueryName": "SupportedIpAddressTypeSet", + "smithy.api#documentation": "

The supported IP address types.

", + "smithy.api#xmlName": "supportedIpAddressTypeSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a VPC endpoint service.

" + } + }, + "com.amazonaws.ec2#ServiceDetailSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ServiceDetail", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ServiceState": { + "type": "enum", + "members": { + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "Available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Available" + } + }, + "Deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "Deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleted" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } + } + }, + "com.amazonaws.ec2#ServiceType": { + "type": "enum", + "members": { + "Interface": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Interface" + } + }, + "Gateway": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gateway" + } + }, + "GatewayLoadBalancer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GatewayLoadBalancer" + } + } + } + }, + "com.amazonaws.ec2#ServiceTypeDetail": { + "type": "structure", + "members": { + "ServiceType": { + "target": "com.amazonaws.ec2#ServiceType", + "traits": { + "aws.protocols#ec2QueryName": "ServiceType", + "smithy.api#documentation": "

The type of service.

", + "smithy.api#xmlName": "serviceType" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the type of service for a VPC endpoint.

" + } + }, + "com.amazonaws.ec2#ServiceTypeDetailSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ServiceTypeDetail", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ShutdownBehavior": { + "type": "enum", + "members": { + "stop": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stop" + } + }, + "terminate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "terminate" + } + } + } + }, + "com.amazonaws.ec2#SlotDateTimeRangeRequest": { + "type": "structure", + "members": { + "EarliestTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The earliest date and time, in UTC, for the Scheduled Instance to start.

", + "smithy.api#required": {} + } + }, + "LatestTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#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.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the time period for a Scheduled Instance to start its first schedule. The time period must span less than one day.

" + } + }, + "com.amazonaws.ec2#SlotStartTimeRangeRequest": { + "type": "structure", + "members": { + "EarliestTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "smithy.api#documentation": "

The earliest date and time, in UTC, for the Scheduled Instance to start.

" + } + }, + "LatestTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "smithy.api#documentation": "

The latest date and time, in UTC, for the Scheduled Instance to start.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the time period for a Scheduled Instance to start its first schedule.

" + } + }, + "com.amazonaws.ec2#Snapshot": { + "type": "structure", + "members": { + "DataEncryptionKeyId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DataEncryptionKeyId", + "smithy.api#documentation": "

The data encryption key identifier for the snapshot. This value is a unique identifier\n that corresponds to the data encryption key that was used to encrypt the original volume or\n snapshot copy. Because data encryption keys are inherited by volumes created from snapshots,\n and vice versa, if snapshots share the same data encryption key identifier, then they belong\n to the same volume/snapshot lineage. This parameter is only returned by DescribeSnapshots.

", + "smithy.api#xmlName": "dataEncryptionKeyId" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description for the snapshot.

", + "smithy.api#xmlName": "description" + } + }, + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Encrypted", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the snapshot is encrypted.

", + "smithy.api#xmlName": "encrypted" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KmsKeyId", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the\n volume encryption key for the parent volume.

", + "smithy.api#xmlName": "kmsKeyId" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the EBS snapshot.

", + "smithy.api#xmlName": "ownerId" + } + }, + "Progress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Progress", + "smithy.api#documentation": "

The progress of the snapshot, as a percentage.

", + "smithy.api#xmlName": "progress" + } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the snapshot. Each snapshot receives a unique identifier when it is\n created.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "StartTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "StartTime", + "smithy.api#documentation": "

The time stamp when the snapshot was initiated.

", + "smithy.api#xmlName": "startTime" + } + }, + "State": { + "target": "com.amazonaws.ec2#SnapshotState", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The snapshot state.

", + "smithy.api#xmlName": "status" + } + }, + "StateMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails\n (for example, if the proper Key Management Service (KMS) permissions are not obtained) this field displays error\n state details to help you diagnose why the error occurred. This parameter is only returned by\n DescribeSnapshots.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VolumeId", + "smithy.api#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\n purpose.

", + "smithy.api#xmlName": "volumeId" + } + }, + "VolumeSize": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "VolumeSize", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The size of the volume, in GiB.

", + "smithy.api#xmlName": "volumeSize" + } + }, + "OwnerAlias": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerAlias", + "smithy.api#documentation": "

The Amazon Web Services owner alias, from an Amazon-maintained list (amazon). This is not \n the user-configured Amazon Web Services account alias set using the IAM console.

", + "smithy.api#xmlName": "ownerAlias" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutpostArn", + "smithy.api#documentation": "

The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the \n \t\tAmazon Elastic Compute Cloud User Guide.

", + "smithy.api#xmlName": "outpostArn" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the snapshot.

", + "smithy.api#xmlName": "tagSet" + } + }, + "StorageTier": { + "target": "com.amazonaws.ec2#StorageTier", + "traits": { + "aws.protocols#ec2QueryName": "StorageTier", + "smithy.api#documentation": "

The storage tier in which the snapshot is stored. standard indicates \n that the snapshot is stored in the standard snapshot storage tier and that it is ready \n for use. archive indicates that the snapshot is currently archived and that \n it must be restored before it can be used.

", + "smithy.api#xmlName": "storageTier" + } + }, + "RestoreExpiryTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "RestoreExpiryTime", + "smithy.api#documentation": "

Only for archived snapshots that are temporarily restored. Indicates the date and \n time when a temporarily restored snapshot will be automatically re-archived.

", + "smithy.api#xmlName": "restoreExpiryTime" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a snapshot.

" + } + }, + "com.amazonaws.ec2#SnapshotAttributeName": { + "type": "enum", + "members": { + "productCodes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "productCodes" + } + }, + "createVolumePermission": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "createVolumePermission" + } + } + } + }, + "com.amazonaws.ec2#SnapshotDetail": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the snapshot.

", + "smithy.api#xmlName": "description" + } + }, + "DeviceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DeviceName", + "smithy.api#documentation": "

The block device mapping for the snapshot.

", + "smithy.api#xmlName": "deviceName" + } + }, + "DiskImageSize": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "DiskImageSize", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The size of the disk in the snapshot, in GiB.

", + "smithy.api#xmlName": "diskImageSize" + } + }, + "Format": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Format", + "smithy.api#documentation": "

The format of the disk image from which the snapshot is created.

", + "smithy.api#xmlName": "format" + } + }, + "Progress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Progress", + "smithy.api#documentation": "

The percentage of progress for the task.

", + "smithy.api#xmlName": "progress" + } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The snapshot ID of the disk being imported.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "Status": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

A brief status of the snapshot creation.

", + "smithy.api#xmlName": "status" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

A detailed status message for the snapshot creation.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "Url": { + "target": "com.amazonaws.ec2#SensitiveUrl", + "traits": { + "aws.protocols#ec2QueryName": "Url", + "smithy.api#documentation": "

The URL used to access the disk image.

", + "smithy.api#xmlName": "url" + } + }, + "UserBucket": { + "target": "com.amazonaws.ec2#UserBucketDetails", + "traits": { + "aws.protocols#ec2QueryName": "UserBucket", + "smithy.api#documentation": "

The Amazon S3 bucket for the disk image.

", + "smithy.api#xmlName": "userBucket" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the snapshot created from the imported disk.

" + } + }, + "com.amazonaws.ec2#SnapshotDetailList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SnapshotDetail", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SnapshotDiskContainer": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The description of the disk image being imported.

" + } + }, + "Format": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The format of the disk image being imported.

\n

Valid values: VHD | VMDK | RAW\n

" + } + }, + "Url": { + "target": "com.amazonaws.ec2#SensitiveUrl", + "traits": { + "smithy.api#documentation": "

The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon\n S3 URL (s3://..).

" + } + }, + "UserBucket": { + "target": "com.amazonaws.ec2#UserBucket", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket for the disk image.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The disk container object for the import snapshot request.

" + } + }, + "com.amazonaws.ec2#SnapshotId": { + "type": "string" + }, + "com.amazonaws.ec2#SnapshotIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "smithy.api#xmlName": "SnapshotId" + } + } + }, + "com.amazonaws.ec2#SnapshotInfo": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

Description specified by the CreateSnapshotRequest that has been applied to all \n snapshots.

", + "smithy.api#xmlName": "description" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Tags associated with this snapshot.

", + "smithy.api#xmlName": "tagSet" + } + }, + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Encrypted", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the snapshot is encrypted.

", + "smithy.api#xmlName": "encrypted" + } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VolumeId", + "smithy.api#documentation": "

Source volume from which this snapshot was created.

", + "smithy.api#xmlName": "volumeId" + } + }, + "State": { + "target": "com.amazonaws.ec2#SnapshotState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

Current state of the snapshot.

", + "smithy.api#xmlName": "state" + } + }, + "VolumeSize": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "VolumeSize", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

Size of the volume from which this snapshot was created.

", + "smithy.api#xmlName": "volumeSize" + } + }, + "StartTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "StartTime", + "smithy.api#documentation": "

Time this snapshot was started. This is the same for all snapshots initiated by the\n same request.

", + "smithy.api#xmlName": "startTime" + } + }, + "Progress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Progress", + "smithy.api#documentation": "

Progress this snapshot has made towards completing.

", + "smithy.api#xmlName": "progress" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

Account id used when creating this snapshot.

", + "smithy.api#xmlName": "ownerId" + } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

Snapshot id that can be used to describe this snapshot.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutpostArn", + "smithy.api#documentation": "

The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the \n \t\tAmazon Elastic Compute Cloud User Guide.

", + "smithy.api#xmlName": "outpostArn" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a snapshot.

" + } + }, + "com.amazonaws.ec2#SnapshotList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Snapshot", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SnapshotRecycleBinInfo": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the snapshot.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "RecycleBinEnterTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "RecycleBinEnterTime", + "smithy.api#documentation": "

The date and time when the snaphsot entered the Recycle Bin.

", + "smithy.api#xmlName": "recycleBinEnterTime" + } + }, + "RecycleBinExitTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "RecycleBinExitTime", + "smithy.api#documentation": "

The date and time when the snapshot is to be permanently deleted from the Recycle Bin.

", + "smithy.api#xmlName": "recycleBinExitTime" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description for the snapshot.

", + "smithy.api#xmlName": "description" + } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VolumeId", + "smithy.api#documentation": "

The ID of the volume from which the snapshot was created.

", + "smithy.api#xmlName": "volumeId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a snapshot that is currently in the Recycle Bin.

" + } + }, + "com.amazonaws.ec2#SnapshotRecycleBinInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SnapshotRecycleBinInfo", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SnapshotSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SnapshotInfo", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SnapshotState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "completed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "completed" + } + }, + "error": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "error" + } + }, + "recoverable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "recoverable" + } + }, + "recovering": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "recovering" + } + } + } + }, + "com.amazonaws.ec2#SnapshotTaskDetail": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of the snapshot.

", + "smithy.api#xmlName": "description" + } + }, + "DiskImageSize": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "DiskImageSize", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The size of the disk in the snapshot, in GiB.

", + "smithy.api#xmlName": "diskImageSize" + } + }, + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Encrypted", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the snapshot is encrypted.

", + "smithy.api#xmlName": "encrypted" + } + }, + "Format": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Format", + "smithy.api#documentation": "

The format of the disk image from which the snapshot is created.

", + "smithy.api#xmlName": "format" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KmsKeyId", + "smithy.api#documentation": "

The identifier for the KMS key that was used to create the encrypted snapshot.

", + "smithy.api#xmlName": "kmsKeyId" + } + }, + "Progress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Progress", + "smithy.api#documentation": "

The percentage of completion for the import snapshot task.

", + "smithy.api#xmlName": "progress" + } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The snapshot ID of the disk being imported.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "Status": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

A brief status for the import snapshot task.

", + "smithy.api#xmlName": "status" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

A detailed status message for the import snapshot task.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "Url": { + "target": "com.amazonaws.ec2#SensitiveUrl", + "traits": { + "aws.protocols#ec2QueryName": "Url", + "smithy.api#documentation": "

The URL of the disk image from which the snapshot is created.

", + "smithy.api#xmlName": "url" + } + }, + "UserBucket": { + "target": "com.amazonaws.ec2#UserBucketDetails", + "traits": { + "aws.protocols#ec2QueryName": "UserBucket", + "smithy.api#documentation": "

The Amazon S3 bucket for the disk image.

", + "smithy.api#xmlName": "userBucket" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the import snapshot task.

" + } + }, + "com.amazonaws.ec2#SnapshotTierStatus": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the snapshot.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#VolumeId", + "traits": { + "aws.protocols#ec2QueryName": "VolumeId", + "smithy.api#documentation": "

The ID of the volume from which the snapshot was created.

", + "smithy.api#xmlName": "volumeId" + } + }, + "Status": { + "target": "com.amazonaws.ec2#SnapshotState", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The state of the snapshot.

", + "smithy.api#xmlName": "status" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the snapshot.

", + "smithy.api#xmlName": "ownerId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags that are assigned to the snapshot.

", + "smithy.api#xmlName": "tagSet" + } + }, + "StorageTier": { + "target": "com.amazonaws.ec2#StorageTier", + "traits": { + "aws.protocols#ec2QueryName": "StorageTier", + "smithy.api#documentation": "

The storage tier in which the snapshot is stored. standard indicates \n that the snapshot is stored in the standard snapshot storage tier and that it is ready \n for use. archive indicates that the snapshot is currently archived and that \n it must be restored before it can be used.

", + "smithy.api#xmlName": "storageTier" + } + }, + "LastTieringStartTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "LastTieringStartTime", + "smithy.api#documentation": "

The date and time when the last archive or restore process was started.

", + "smithy.api#xmlName": "lastTieringStartTime" + } + }, + "LastTieringProgress": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "LastTieringProgress", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The progress of the last archive or restore process, as a percentage.

", + "smithy.api#xmlName": "lastTieringProgress" + } + }, + "LastTieringOperationStatus": { + "target": "com.amazonaws.ec2#TieringOperationStatus", + "traits": { + "aws.protocols#ec2QueryName": "LastTieringOperationStatus", + "smithy.api#documentation": "

The status of the last archive or restore process.

", + "smithy.api#xmlName": "lastTieringOperationStatus" + } + }, + "LastTieringOperationStatusDetail": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LastTieringOperationStatusDetail", + "smithy.api#documentation": "

A message describing the status of the last archive or restore process.

", + "smithy.api#xmlName": "lastTieringOperationStatusDetail" + } + }, + "ArchivalCompleteTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "ArchivalCompleteTime", + "smithy.api#documentation": "

The date and time when the last archive process was completed.

", + "smithy.api#xmlName": "archivalCompleteTime" + } + }, + "RestoreExpiryTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "RestoreExpiryTime", + "smithy.api#documentation": "

Only for archived snapshots that are temporarily restored. Indicates the date and \n time when a temporarily restored snapshot will be automatically re-archived.

", + "smithy.api#xmlName": "restoreExpiryTime" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about a snapshot's storage tier.

" + } + }, + "com.amazonaws.ec2#SpotAllocationStrategy": { + "type": "enum", + "members": { + "LOWEST_PRICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lowest-price" + } + }, + "DIVERSIFIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "diversified" + } + }, + "CAPACITY_OPTIMIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "capacity-optimized" + } + }, + "CAPACITY_OPTIMIZED_PRIORITIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "capacity-optimized-prioritized" + } + }, + "PRICE_CAPACITY_OPTIMIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "price-capacity-optimized" + } + } + } + }, + "com.amazonaws.ec2#SpotCapacityRebalance": { + "type": "structure", + "members": { + "ReplacementStrategy": { + "target": "com.amazonaws.ec2#ReplacementStrategy", + "traits": { + "aws.protocols#ec2QueryName": "ReplacementStrategy", + "smithy.api#documentation": "

The replacement strategy to use. Only available for fleets of type\n maintain.

\n

\n launch - Spot Fleet launches a new replacement Spot Instance when a\n rebalance notification is emitted for an existing Spot Instance in the fleet. Spot Fleet\n does not terminate the instances that receive a rebalance notification. You can\n terminate the old instances, or you can leave them running. You are charged for all\n instances while they are running.

\n

\n launch-before-terminate - Spot Fleet launches a new replacement Spot\n Instance when a rebalance notification is emitted for an existing Spot Instance in the\n fleet, and then, after a delay that you specify (in TerminationDelay),\n terminates the instances that received a rebalance notification.

", + "smithy.api#xmlName": "replacementStrategy" + } + }, + "TerminationDelay": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TerminationDelay", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot\n Instance after launching a new replacement Spot Instance.

\n

Required when ReplacementStrategy is set to launch-before-terminate.

\n

Not valid when ReplacementStrategy is set to launch.

\n

Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.

", + "smithy.api#xmlName": "terminationDelay" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your\n Spot Instance is at an elevated risk of being interrupted. For more information, see\n Capacity rebalancing in the Amazon EC2 User Guide for Linux Instances.

" + } + }, + "com.amazonaws.ec2#SpotDatafeedSubscription": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Bucket", + "smithy.api#documentation": "

The name of the Amazon S3 bucket where the Spot Instance data feed is located.

", + "smithy.api#xmlName": "bucket" + } + }, + "Fault": { + "target": "com.amazonaws.ec2#SpotInstanceStateFault", + "traits": { + "aws.protocols#ec2QueryName": "Fault", + "smithy.api#documentation": "

The fault codes for the Spot Instance request, if any.

", + "smithy.api#xmlName": "fault" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The Amazon Web Services account ID of the account.

", + "smithy.api#xmlName": "ownerId" + } + }, + "Prefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Prefix", + "smithy.api#documentation": "

The prefix for the data feed files.

", + "smithy.api#xmlName": "prefix" + } + }, + "State": { + "target": "com.amazonaws.ec2#DatafeedSubscriptionState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the Spot Instance data feed subscription.

", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the data feed for a Spot Instance.

" + } + }, + "com.amazonaws.ec2#SpotFleetLaunchSpecification": { + "type": "structure", + "members": { + "SecurityGroups": { + "target": "com.amazonaws.ec2#GroupIdentifierList", + "traits": { + "aws.protocols#ec2QueryName": "GroupSet", + "smithy.api#documentation": "

The security groups.

", + "smithy.api#xmlName": "groupSet" + } + }, + "AddressingType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AddressingType", + "smithy.api#documentation": "

Deprecated.

", + "smithy.api#xmlName": "addressingType" + } + }, + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#BlockDeviceMappingList", + "traits": { + "aws.protocols#ec2QueryName": "BlockDeviceMapping", + "smithy.api#documentation": "

One or more block devices that are mapped to the Spot Instances. You can't specify both\n a snapshot ID and an encryption value. This is because only blank volumes can be\n encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its\n encryption status is used for the volume encryption status.

", + "smithy.api#xmlName": "blockDeviceMapping" + } + }, + "EbsOptimized": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EbsOptimized", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#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.

\n

Default: false\n

", + "smithy.api#xmlName": "ebsOptimized" + } + }, + "IamInstanceProfile": { + "target": "com.amazonaws.ec2#IamInstanceProfileSpecification", + "traits": { + "aws.protocols#ec2QueryName": "IamInstanceProfile", + "smithy.api#documentation": "

The IAM instance profile.

", + "smithy.api#xmlName": "iamInstanceProfile" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#xmlName": "imageId" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type.

", + "smithy.api#xmlName": "instanceType" + } + }, + "KernelId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KernelId", + "smithy.api#documentation": "

The ID of the kernel.

", + "smithy.api#xmlName": "kernelId" + } + }, + "KeyName": { + "target": "com.amazonaws.ec2#KeyPairName", + "traits": { + "aws.protocols#ec2QueryName": "KeyName", + "smithy.api#documentation": "

The name of the key pair.

", + "smithy.api#xmlName": "keyName" + } + }, + "Monitoring": { + "target": "com.amazonaws.ec2#SpotFleetMonitoring", + "traits": { + "aws.protocols#ec2QueryName": "Monitoring", + "smithy.api#documentation": "

Enable or disable monitoring for the instances.

", + "smithy.api#xmlName": "monitoring" + } + }, + "NetworkInterfaces": { + "target": "com.amazonaws.ec2#InstanceNetworkInterfaceSpecificationList", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceSet", + "smithy.api#documentation": "

One or more network interfaces. If you specify a network interface, you must specify \n subnet IDs and security group IDs using the network interface.

\n \n

\n SpotFleetLaunchSpecification currently does not support Elastic Fabric Adapter (EFA). To specify an EFA, you must use LaunchTemplateConfig.

\n ", + "smithy.api#xmlName": "networkInterfaceSet" + } + }, + "Placement": { + "target": "com.amazonaws.ec2#SpotPlacement", + "traits": { + "aws.protocols#ec2QueryName": "Placement", + "smithy.api#documentation": "

The placement information.

", + "smithy.api#xmlName": "placement" + } + }, + "RamdiskId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RamdiskId", + "smithy.api#documentation": "

The ID of the RAM disk. Some kernels require additional drivers at launch. Check the kernel \n requirements for information about whether you need to specify a RAM disk. To find kernel \n requirements, refer to the Amazon Web Services Resource Center and search for the kernel ID.

", + "smithy.api#xmlName": "ramdiskId" + } + }, + "SpotPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpotPrice", + "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to \n increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n ", + "smithy.api#xmlName": "spotPrice" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate\n them using commas; for example, \"subnet-1234abcdeexample1, subnet-0987cdef6example2\".

", + "smithy.api#xmlName": "subnetId" + } + }, + "UserData": { + "target": "com.amazonaws.ec2#SensitiveUserData", + "traits": { + "aws.protocols#ec2QueryName": "UserData", + "smithy.api#documentation": "

The base64-encoded user data that instances use when starting up. User data is limited to 16 KB.

", + "smithy.api#xmlName": "userData" + } + }, + "WeightedCapacity": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "WeightedCapacity", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#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.

\n

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.

", + "smithy.api#xmlName": "weightedCapacity" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#SpotFleetTagSpecificationList", + "traits": { + "aws.protocols#ec2QueryName": "TagSpecificationSet", + "smithy.api#documentation": "

The tags to apply during creation.

", + "smithy.api#xmlName": "tagSpecificationSet" + } + }, + "InstanceRequirements": { + "target": "com.amazonaws.ec2#InstanceRequirements", + "traits": { + "aws.protocols#ec2QueryName": "InstanceRequirements", + "smithy.api#documentation": "

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with those attributes.

\n \n

If you specify InstanceRequirements, you can't specify\n InstanceType.

\n ", + "smithy.api#xmlName": "instanceRequirements" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the launch specification for one or more Spot Instances. If you include\n On-Demand capacity in your fleet request or want to specify an EFA network device, you\n can't use SpotFleetLaunchSpecification; you must use LaunchTemplateConfig.

" + } + }, + "com.amazonaws.ec2#SpotFleetMonitoring": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Enabled", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Enables monitoring for the instance.

\n

Default: false\n

", + "smithy.api#xmlName": "enabled" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes whether monitoring is enabled.

" + } + }, + "com.amazonaws.ec2#SpotFleetRequestConfig": { + "type": "structure", + "members": { + "ActivityStatus": { + "target": "com.amazonaws.ec2#ActivityStatus", + "traits": { + "aws.protocols#ec2QueryName": "ActivityStatus", + "smithy.api#documentation": "

The progress of the Spot Fleet request. \n If there is an error, the status is error.\n After all requests are placed, the status is pending_fulfillment.\n If the size of the fleet is equal to or greater than its target capacity, the status is fulfilled.\n If the size of the fleet is decreased, the status is pending_termination\n while Spot Instances are terminating.

", + "smithy.api#xmlName": "activityStatus" + } + }, + "CreateTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreateTime", + "smithy.api#documentation": "

The creation date and time of the request.

", + "smithy.api#xmlName": "createTime" + } + }, + "SpotFleetRequestConfig": { + "target": "com.amazonaws.ec2#SpotFleetRequestConfigData", + "traits": { + "aws.protocols#ec2QueryName": "SpotFleetRequestConfig", + "smithy.api#documentation": "

The configuration of the Spot Fleet request.

", + "smithy.api#xmlName": "spotFleetRequestConfig" + } + }, + "SpotFleetRequestId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpotFleetRequestId", + "smithy.api#documentation": "

The ID of the Spot Fleet request.

", + "smithy.api#xmlName": "spotFleetRequestId" + } + }, + "SpotFleetRequestState": { + "target": "com.amazonaws.ec2#BatchState", + "traits": { + "aws.protocols#ec2QueryName": "SpotFleetRequestState", + "smithy.api#documentation": "

The state of the Spot Fleet request.

", + "smithy.api#xmlName": "spotFleetRequestState" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for a Spot Fleet resource.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Spot Fleet request.

" + } + }, + "com.amazonaws.ec2#SpotFleetRequestConfigData": { + "type": "structure", + "members": { + "AllocationStrategy": { + "target": "com.amazonaws.ec2#AllocationStrategy", + "traits": { + "aws.protocols#ec2QueryName": "AllocationStrategy", + "smithy.api#documentation": "

The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\n pools specified by the Spot Fleet launch configuration. For more information, see Allocation\n strategies for Spot Instances in the Amazon EC2 User Guide.

\n
\n
priceCapacityOptimized (recommended)
\n
\n

Spot Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. Spot Fleet then requests Spot Instances from the lowest priced of these pools.

\n
\n
capacityOptimized
\n
\n

Spot Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. To give certain\n instance types a higher chance of launching first, use\n capacityOptimizedPrioritized. Set a priority for each instance type by\n using the Priority parameter for LaunchTemplateOverrides. You can\n assign the same priority to different LaunchTemplateOverrides. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacityOptimizedPrioritized is supported only if your Spot Fleet uses a\n launch template. Note that if the OnDemandAllocationStrategy is set to\n prioritized, the same priority is applied when fulfilling On-Demand\n capacity.

\n
\n
diversified
\n
\n

Spot Fleet requests instances from all of the Spot Instance pools that you\n specify.

\n
\n
lowestPrice
\n
\n

Spot Fleet requests instances from the lowest priced Spot Instance pool that\n has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances\n come from the next lowest priced pool that has available capacity. If a pool runs out of\n capacity before fulfilling your desired capacity, Spot Fleet will continue to fulfill your\n request by drawing from the next lowest priced pool. To ensure that your desired capacity is\n met, you might receive Spot Instances from several pools. Because this strategy only considers instance \n price and not capacity availability, it might lead to high interruption rates.

\n
\n
\n

Default: lowestPrice\n

", + "smithy.api#xmlName": "allocationStrategy" + } + }, + "OnDemandAllocationStrategy": { + "target": "com.amazonaws.ec2#OnDemandAllocationStrategy", + "traits": { + "aws.protocols#ec2QueryName": "OnDemandAllocationStrategy", + "smithy.api#documentation": "

The order of the launch template overrides to use in fulfilling On-Demand capacity. If\n you specify lowestPrice, Spot Fleet uses price to determine the order, launching\n the lowest price first. If you specify prioritized, Spot Fleet uses the priority\n that you assign to each Spot Fleet launch template override, launching the highest priority\n first. If you do not specify a value, Spot Fleet defaults to lowestPrice.

", + "smithy.api#xmlName": "onDemandAllocationStrategy" + } + }, + "SpotMaintenanceStrategies": { + "target": "com.amazonaws.ec2#SpotMaintenanceStrategies", + "traits": { + "aws.protocols#ec2QueryName": "SpotMaintenanceStrategies", + "smithy.api#documentation": "

The strategies for managing your Spot Instances that are at an elevated risk of being\n interrupted.

", + "smithy.api#xmlName": "spotMaintenanceStrategies" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of your\n listings. This helps to avoid duplicate listings. For more information, see Ensuring Idempotency.

", + "smithy.api#xmlName": "clientToken" + } + }, + "ExcessCapacityTerminationPolicy": { + "target": "com.amazonaws.ec2#ExcessCapacityTerminationPolicy", + "traits": { + "aws.protocols#ec2QueryName": "ExcessCapacityTerminationPolicy", + "smithy.api#documentation": "

Indicates whether running instances should be terminated if you decrease the\n target capacity of the Spot Fleet request below the current size of the Spot Fleet.

\n

Supported only for fleets of type maintain.

", + "smithy.api#xmlName": "excessCapacityTerminationPolicy" + } + }, + "FulfilledCapacity": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "FulfilledCapacity", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of units fulfilled by this request compared to the set target capacity. You\n cannot set this value.

", + "smithy.api#xmlName": "fulfilledCapacity" + } + }, + "OnDemandFulfilledCapacity": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "OnDemandFulfilledCapacity", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of On-Demand units fulfilled by this request compared to the set target\n On-Demand capacity.

", + "smithy.api#xmlName": "onDemandFulfilledCapacity" + } + }, + "IamFleetRole": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IamFleetRole", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that\n grants the Spot Fleet the permission to request, launch, terminate, and tag instances on\n your behalf. For more information, see Spot\n Fleet prerequisites in the Amazon EC2 User Guide. Spot Fleet\n can terminate Spot Instances on your behalf when you cancel its Spot Fleet request using\n CancelSpotFleetRequests or when the Spot Fleet request expires, if you set\n TerminateInstancesWithExpiration.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "iamFleetRole" + } + }, + "LaunchSpecifications": { + "target": "com.amazonaws.ec2#LaunchSpecsList", + "traits": { + "aws.protocols#ec2QueryName": "LaunchSpecifications", + "smithy.api#documentation": "

The launch specifications for the Spot Fleet request. If you specify\n LaunchSpecifications, you can't specify\n LaunchTemplateConfigs. If you include On-Demand capacity in your\n request, you must use LaunchTemplateConfigs.

", + "smithy.api#xmlName": "launchSpecifications" + } + }, + "LaunchTemplateConfigs": { + "target": "com.amazonaws.ec2#LaunchTemplateConfigList", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateConfigs", + "smithy.api#documentation": "

The launch template and overrides. If you specify LaunchTemplateConfigs,\n you can't specify LaunchSpecifications. If you include On-Demand capacity\n in your request, you must use LaunchTemplateConfigs.

", + "smithy.api#xmlName": "launchTemplateConfigs" + } + }, + "SpotPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpotPrice", + "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend \n using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n ", + "smithy.api#xmlName": "spotPrice" + } + }, + "TargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TargetCapacity", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of units to request for the Spot Fleet. You can choose to set the target\n capacity in terms of instances or a performance characteristic that is important to your\n application workload, such as vCPUs, memory, or I/O. If the request type is\n maintain, you can specify a target capacity of 0 and add capacity\n later.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "targetCapacity" + } + }, + "OnDemandTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "OnDemandTargetCapacity", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of On-Demand units to request. You can choose to set the target capacity in\n terms of instances or a performance characteristic that is important to your application\n workload, such as vCPUs, memory, or I/O. If the request type is maintain,\n you can specify a target capacity of 0 and add capacity later.

", + "smithy.api#xmlName": "onDemandTargetCapacity" + } + }, + "OnDemandMaxTotalPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OnDemandMaxTotalPrice", + "smithy.api#documentation": "

The maximum amount per hour for On-Demand Instances that you're willing to pay. You\n can use the onDemandMaxTotalPrice parameter, the\n spotMaxTotalPrice parameter, or both parameters to ensure that your\n fleet cost does not exceed your budget. If you set a maximum price per hour for the\n On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the\n maximum amount you're willing to pay. When the maximum amount you're willing to pay is\n reached, the fleet stops launching instances even if it hasn’t met the target\n capacity.

", + "smithy.api#xmlName": "onDemandMaxTotalPrice" + } + }, + "SpotMaxTotalPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpotMaxTotalPrice", + "smithy.api#documentation": "

The maximum amount per hour for Spot Instances that you're willing to pay. You can use\n the spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice\n parameter, or both parameters to ensure that your fleet cost does not exceed your\n budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request,\n Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay.\n When the maximum amount you're willing to pay is reached, the fleet stops launching\n instances even if it hasn’t met the target capacity.

", + "smithy.api#xmlName": "spotMaxTotalPrice" + } + }, + "TerminateInstancesWithExpiration": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "TerminateInstancesWithExpiration", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether running Spot Instances are terminated when the Spot Fleet request\n expires.

", + "smithy.api#xmlName": "terminateInstancesWithExpiration" + } + }, + "Type": { + "target": "com.amazonaws.ec2#FleetType", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The type of request. Indicates whether the Spot Fleet only requests the target\n capacity or also attempts to maintain it. When this value is request, the\n Spot Fleet only places the required requests. It does not attempt to replenish Spot\n Instances if capacity is diminished, nor does it submit requests in alternative Spot\n pools if capacity is not available. When this value is maintain, the Spot\n Fleet maintains the target capacity. The Spot Fleet places the required requests to meet\n capacity and automatically replenishes any interrupted instances. Default:\n maintain. instant is listed but is not used by Spot\n Fleet.

", + "smithy.api#xmlName": "type" + } + }, + "ValidFrom": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "ValidFrom", + "smithy.api#documentation": "

The start date and time of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ).\n By default, Amazon EC2 starts fulfilling the request immediately.

", + "smithy.api#xmlName": "validFrom" + } + }, + "ValidUntil": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "ValidUntil", + "smithy.api#documentation": "

The end date and time of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ).\n After the end date and time, no new Spot Instance requests are placed or able to fulfill\n the request. If no value is specified, the Spot Fleet request remains until you cancel\n it.

", + "smithy.api#xmlName": "validUntil" + } + }, + "ReplaceUnhealthyInstances": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "ReplaceUnhealthyInstances", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether Spot Fleet should replace unhealthy instances.

", + "smithy.api#xmlName": "replaceUnhealthyInstances" + } + }, + "InstanceInterruptionBehavior": { + "target": "com.amazonaws.ec2#InstanceInterruptionBehavior", + "traits": { + "aws.protocols#ec2QueryName": "InstanceInterruptionBehavior", + "smithy.api#documentation": "

The behavior when a Spot Instance is interrupted. The default is\n terminate.

", + "smithy.api#xmlName": "instanceInterruptionBehavior" + } + }, + "LoadBalancersConfig": { + "target": "com.amazonaws.ec2#LoadBalancersConfig", + "traits": { + "aws.protocols#ec2QueryName": "LoadBalancersConfig", + "smithy.api#documentation": "

One or more Classic Load Balancers and target groups to attach to the Spot Fleet\n request. Spot Fleet registers the running Spot Instances with the specified Classic Load\n Balancers and target groups.

\n

With Network Load Balancers, Spot Fleet cannot register instances that have the\n following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2,\n M3, and T1.

", + "smithy.api#xmlName": "loadBalancersConfig" + } + }, + "InstancePoolsToUseCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "InstancePoolsToUseCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of Spot pools across which to allocate your target Spot capacity. Valid\n only when Spot AllocationStrategy is set to\n lowest-price. Spot Fleet selects the cheapest Spot pools and evenly\n allocates your target Spot capacity across the number of Spot pools that you\n specify.

\n

Note that Spot Fleet attempts to draw Spot Instances from the number of pools that you specify on a\n best effort basis. If a pool runs out of Spot capacity before fulfilling your target\n capacity, Spot Fleet will continue to fulfill your request by drawing from the next cheapest\n pool. To ensure that your target capacity is met, you might receive Spot Instances from more than\n the number of pools that you specified. Similarly, if most of the pools have no Spot\n capacity, you might receive your full target capacity from fewer than the number of\n pools that you specified.

", + "smithy.api#xmlName": "instancePoolsToUseCount" + } + }, + "Context": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Context", + "smithy.api#documentation": "

Reserved.

", + "smithy.api#xmlName": "context" + } + }, + "TargetCapacityUnitType": { + "target": "com.amazonaws.ec2#TargetCapacityUnitType", + "traits": { + "aws.protocols#ec2QueryName": "TargetCapacityUnitType", + "smithy.api#documentation": "

The unit for the target capacity. TargetCapacityUnitType can only be specified when InstanceRequirements is specified.

\n

Default: units (translates to number of instances)

", + "smithy.api#xmlName": "targetCapacityUnitType" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The key-value pair for tagging the Spot Fleet request on creation. The value for\n ResourceType must be spot-fleet-request, otherwise the\n Spot Fleet request fails. To tag instances at launch, specify the tags in the launch\n template (valid only if you use LaunchTemplateConfigs) or in\n the \n SpotFleetTagSpecification\n (valid only if you use\n LaunchSpecifications). For information about tagging after launch, see\n Tagging Your Resources.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the configuration of a Spot Fleet request.

" + } + }, + "com.amazonaws.ec2#SpotFleetRequestConfigSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SpotFleetRequestConfig", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SpotFleetRequestId": { + "type": "string" + }, + "com.amazonaws.ec2#SpotFleetRequestIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SpotFleetRequestId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SpotFleetTagSpecification": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.ec2#ResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The type of resource. Currently, the only resource type that is supported is\n instance. To tag the Spot Fleet request on creation, use the\n TagSpecifications parameter in \n SpotFleetRequestConfigData\n .

", + "smithy.api#xmlName": "resourceType" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "Tag", + "smithy.api#documentation": "

The tags.

", + "smithy.api#xmlName": "tag" + } + } + }, + "traits": { + "smithy.api#documentation": "

The tags for a Spot Fleet resource.

" + } + }, + "com.amazonaws.ec2#SpotFleetTagSpecificationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SpotFleetTagSpecification", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SpotInstanceInterruptionBehavior": { + "type": "enum", + "members": { + "hibernate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hibernate" + } + }, + "stop": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stop" + } + }, + "terminate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "terminate" + } + } + } + }, + "com.amazonaws.ec2#SpotInstanceRequest": { + "type": "structure", + "members": { + "ActualBlockHourlyPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ActualBlockHourlyPrice", + "smithy.api#documentation": "

Deprecated.

", + "smithy.api#xmlName": "actualBlockHourlyPrice" + } + }, + "AvailabilityZoneGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneGroup", + "smithy.api#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.

", + "smithy.api#xmlName": "availabilityZoneGroup" + } + }, + "BlockDurationMinutes": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "BlockDurationMinutes", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

Deprecated.

", + "smithy.api#xmlName": "blockDurationMinutes" + } + }, + "CreateTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreateTime", + "smithy.api#documentation": "

The date and time when the Spot Instance request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "smithy.api#xmlName": "createTime" + } + }, + "Fault": { + "target": "com.amazonaws.ec2#SpotInstanceStateFault", + "traits": { + "aws.protocols#ec2QueryName": "Fault", + "smithy.api#documentation": "

The fault codes for the Spot Instance request, if any.

", + "smithy.api#xmlName": "fault" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The instance ID, if an instance has been launched to fulfill the Spot Instance request.

", + "smithy.api#xmlName": "instanceId" + } + }, + "LaunchGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LaunchGroup", + "smithy.api#documentation": "

The instance launch group. Launch groups are Spot Instances that launch together and terminate together.

", + "smithy.api#xmlName": "launchGroup" + } + }, + "LaunchSpecification": { + "target": "com.amazonaws.ec2#LaunchSpecification", + "traits": { + "aws.protocols#ec2QueryName": "LaunchSpecification", + "smithy.api#documentation": "

Additional information for launching instances.

", + "smithy.api#xmlName": "launchSpecification" + } + }, + "LaunchedAvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LaunchedAvailabilityZone", + "smithy.api#documentation": "

The Availability Zone in which the request is launched.

", + "smithy.api#xmlName": "launchedAvailabilityZone" + } + }, + "ProductDescription": { + "target": "com.amazonaws.ec2#RIProductDescription", + "traits": { + "aws.protocols#ec2QueryName": "ProductDescription", + "smithy.api#documentation": "

The product description associated with the Spot Instance.

", + "smithy.api#xmlName": "productDescription" + } + }, + "SpotInstanceRequestId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpotInstanceRequestId", + "smithy.api#documentation": "

The ID of the Spot Instance request.

", + "smithy.api#xmlName": "spotInstanceRequestId" + } + }, + "SpotPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpotPrice", + "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend \n using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n ", + "smithy.api#xmlName": "spotPrice" + } + }, + "State": { + "target": "com.amazonaws.ec2#SpotInstanceState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the Spot Instance request. Spot request status information helps track your Spot\n Instance requests. For more information, see Spot request status in the\n Amazon EC2 User Guide for Linux Instances.

", + "smithy.api#xmlName": "state" + } + }, + "Status": { + "target": "com.amazonaws.ec2#SpotInstanceStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status code and status message describing the Spot Instance request.

", + "smithy.api#xmlName": "status" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the resource.

", + "smithy.api#xmlName": "tagSet" + } + }, + "Type": { + "target": "com.amazonaws.ec2#SpotInstanceType", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The Spot Instance request type.

", + "smithy.api#xmlName": "type" + } + }, + "ValidFrom": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "ValidFrom", + "smithy.api#documentation": "

The start date of the request, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).\n The request becomes active at this date and time.

", + "smithy.api#xmlName": "validFrom" + } + }, + "ValidUntil": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "ValidUntil", + "smithy.api#documentation": "

The end date of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ).

\n ", + "smithy.api#xmlName": "validUntil" + } + }, + "InstanceInterruptionBehavior": { + "target": "com.amazonaws.ec2#InstanceInterruptionBehavior", + "traits": { + "aws.protocols#ec2QueryName": "InstanceInterruptionBehavior", + "smithy.api#documentation": "

The behavior when a Spot Instance is interrupted.

", + "smithy.api#xmlName": "instanceInterruptionBehavior" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Spot Instance request.

" + } + }, + "com.amazonaws.ec2#SpotInstanceRequestId": { + "type": "string" + }, + "com.amazonaws.ec2#SpotInstanceRequestIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SpotInstanceRequestId", + "traits": { + "smithy.api#xmlName": "SpotInstanceRequestId" + } + } + }, + "com.amazonaws.ec2#SpotInstanceRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SpotInstanceRequest", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SpotInstanceState": { + "type": "enum", + "members": { + "open": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "open" + } + }, + "active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "closed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "closed" + } + }, + "cancelled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelled" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + } + } + }, + "com.amazonaws.ec2#SpotInstanceStateFault": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The reason code for the Spot Instance state change.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The message for the Spot Instance state change.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Spot Instance state change.

" + } + }, + "com.amazonaws.ec2#SpotInstanceStatus": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The status code. For a list of status codes, see Spot request status codes in the Amazon EC2 User Guide for Linux Instances.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The description for the status code.

", + "smithy.api#xmlName": "message" + } + }, + "UpdateTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "UpdateTime", + "smithy.api#documentation": "

The date and time of the most recent status update, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", + "smithy.api#xmlName": "updateTime" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the status of a Spot Instance request.

" + } + }, + "com.amazonaws.ec2#SpotInstanceType": { + "type": "enum", + "members": { + "one_time": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "one-time" + } + }, + "persistent": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "persistent" + } + } + } + }, + "com.amazonaws.ec2#SpotMaintenanceStrategies": { + "type": "structure", + "members": { + "CapacityRebalance": { + "target": "com.amazonaws.ec2#SpotCapacityRebalance", + "traits": { + "aws.protocols#ec2QueryName": "CapacityRebalance", + "smithy.api#documentation": "

The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your\n Spot Instance is at an elevated risk of being interrupted. For more information, see\n Capacity rebalancing in the Amazon EC2 User Guide for Linux Instances.

", + "smithy.api#xmlName": "capacityRebalance" + } + } + }, + "traits": { + "smithy.api#documentation": "

The strategies for managing your Spot Instances that are at an elevated risk of being\n interrupted.

" + } + }, + "com.amazonaws.ec2#SpotMarketOptions": { + "type": "structure", + "members": { + "MaxPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The maximum hourly price that you're willing to pay for a Spot Instance. We do not\n recommend using this parameter because it can lead to increased interruptions. If you do\n not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your Spot Instances will be interrupted more\n frequently than if you do not specify this parameter.

\n " + } + }, + "SpotInstanceType": { + "target": "com.amazonaws.ec2#SpotInstanceType", + "traits": { + "smithy.api#documentation": "

The Spot Instance request type. For RunInstances, persistent\n Spot Instance requests are only supported when the instance interruption behavior is\n either hibernate or stop.

" + } + }, + "BlockDurationMinutes": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

Deprecated.

" + } + }, + "ValidUntil": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "smithy.api#documentation": "

The end date of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ).\n Supported only for persistent requests.

\n " + } + }, + "InstanceInterruptionBehavior": { + "target": "com.amazonaws.ec2#InstanceInterruptionBehavior", + "traits": { + "smithy.api#documentation": "

The behavior when a Spot Instance is interrupted. The default is\n terminate.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options for Spot Instances.

" + } + }, + "com.amazonaws.ec2#SpotOptions": { + "type": "structure", + "members": { + "AllocationStrategy": { + "target": "com.amazonaws.ec2#SpotAllocationStrategy", + "traits": { + "aws.protocols#ec2QueryName": "AllocationStrategy", + "smithy.api#documentation": "

The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\n pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the\n Amazon EC2 User Guide.

\n
\n
price-capacity-optimized (recommended)
\n
\n

EC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. EC2 Fleet then requests Spot Instances from the lowest priced of these pools.

\n
\n
capacity-optimized
\n
\n

EC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. To give certain\n instance types a higher chance of launching first, use\n capacity-optimized-prioritized. Set a priority for each instance type by\n using the Priority parameter for LaunchTemplateOverrides. You can\n assign the same priority to different LaunchTemplateOverrides. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacity-optimized-prioritized is supported only if your EC2 Fleet uses a\n launch template. Note that if the On-Demand AllocationStrategy is set to\n prioritized, the same priority is applied when fulfilling On-Demand\n capacity.

\n
\n
diversified
\n
\n

EC2 Fleet requests instances from all of the Spot Instance pools that you\n specify.

\n
\n
lowest-price
\n
\n

EC2 Fleet requests instances from the lowest priced Spot Instance pool that\n has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances\n come from the next lowest priced pool that has available capacity. If a pool runs out of\n capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your\n request by drawing from the next lowest priced pool. To ensure that your desired capacity is\n met, you might receive Spot Instances from several pools. Because this strategy only considers instance \n price and not capacity availability, it might lead to high interruption rates.

\n
\n
\n

Default: lowest-price\n

", + "smithy.api#xmlName": "allocationStrategy" + } + }, + "MaintenanceStrategies": { + "target": "com.amazonaws.ec2#FleetSpotMaintenanceStrategies", + "traits": { + "aws.protocols#ec2QueryName": "MaintenanceStrategies", + "smithy.api#documentation": "

The strategies for managing your workloads on your Spot Instances that will be\n interrupted. Currently only the capacity rebalance strategy is available.

", + "smithy.api#xmlName": "maintenanceStrategies" + } + }, + "InstanceInterruptionBehavior": { + "target": "com.amazonaws.ec2#SpotInstanceInterruptionBehavior", + "traits": { + "aws.protocols#ec2QueryName": "InstanceInterruptionBehavior", + "smithy.api#documentation": "

The behavior when a Spot Instance is interrupted.

\n

Default: terminate\n

", + "smithy.api#xmlName": "instanceInterruptionBehavior" + } + }, + "InstancePoolsToUseCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "InstancePoolsToUseCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of Spot pools across which to allocate your target Spot capacity. Supported\n only when AllocationStrategy is set to lowest-price. EC2 Fleet selects\n the cheapest Spot pools and evenly allocates your target Spot capacity across the number of\n Spot pools that you specify.

\n

Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a\n best effort basis. If a pool runs out of Spot capacity before fulfilling your target\n capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest\n pool. To ensure that your target capacity is met, you might receive Spot Instances from more than\n the number of pools that you specified. Similarly, if most of the pools have no Spot\n capacity, you might receive your full target capacity from fewer than the number of pools\n that you specified.

", + "smithy.api#xmlName": "instancePoolsToUseCount" + } + }, + "SingleInstanceType": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "SingleInstanceType", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates that the fleet uses a single instance type to launch all Spot Instances in the\n fleet.

\n

Supported only for fleets of type instant.

", + "smithy.api#xmlName": "singleInstanceType" + } + }, + "SingleAvailabilityZone": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "SingleAvailabilityZone", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates that the fleet launches all Spot Instances into a single Availability Zone.

\n

Supported only for fleets of type instant.

", + "smithy.api#xmlName": "singleAvailabilityZone" + } + }, + "MinTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MinTargetCapacity", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is\n not reached, the fleet launches no instances.

\n

Supported only for fleets of type instant.

\n

At least one of the following must be specified: SingleAvailabilityZone |\n SingleInstanceType\n

", + "smithy.api#xmlName": "minTargetCapacity" + } + }, + "MaxTotalPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "MaxTotalPrice", + "smithy.api#documentation": "

The maximum amount per hour for Spot Instances that you're willing to pay. We do not recommend\n using this parameter because it can lead to increased interruptions. If you do not specify\n this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.

\n ", + "smithy.api#xmlName": "maxTotalPrice" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the configuration of Spot Instances in an EC2 Fleet.

" + } + }, + "com.amazonaws.ec2#SpotOptionsRequest": { + "type": "structure", + "members": { + "AllocationStrategy": { + "target": "com.amazonaws.ec2#SpotAllocationStrategy", + "traits": { + "smithy.api#documentation": "

The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\n pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the\n Amazon EC2 User Guide.

\n
\n
price-capacity-optimized (recommended)
\n
\n

EC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. EC2 Fleet then requests Spot Instances from the lowest priced of these pools.

\n
\n
capacity-optimized
\n
\n

EC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. To give certain\n instance types a higher chance of launching first, use\n capacity-optimized-prioritized. Set a priority for each instance type by\n using the Priority parameter for LaunchTemplateOverrides. You can\n assign the same priority to different LaunchTemplateOverrides. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacity-optimized-prioritized is supported only if your EC2 Fleet uses a\n launch template. Note that if the On-Demand AllocationStrategy is set to\n prioritized, the same priority is applied when fulfilling On-Demand\n capacity.

\n
\n
diversified
\n
\n

EC2 Fleet requests instances from all of the Spot Instance pools that you\n specify.

\n
\n
lowest-price
\n
\n

EC2 Fleet requests instances from the lowest priced Spot Instance pool that\n has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances\n come from the next lowest priced pool that has available capacity. If a pool runs out of\n capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your\n request by drawing from the next lowest priced pool. To ensure that your desired capacity is\n met, you might receive Spot Instances from several pools. Because this strategy only considers instance \n price and not capacity availability, it might lead to high interruption rates.

\n
\n
\n

Default: lowest-price\n

" + } + }, + "MaintenanceStrategies": { + "target": "com.amazonaws.ec2#FleetSpotMaintenanceStrategiesRequest", + "traits": { + "smithy.api#documentation": "

The strategies for managing your Spot Instances that are at an elevated risk of being\n interrupted.

" + } + }, + "InstanceInterruptionBehavior": { + "target": "com.amazonaws.ec2#SpotInstanceInterruptionBehavior", + "traits": { + "smithy.api#documentation": "

The behavior when a Spot Instance is interrupted.

\n

Default: terminate\n

" + } + }, + "InstancePoolsToUseCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of Spot pools across which to allocate your target Spot capacity. Supported\n only when Spot AllocationStrategy is set to lowest-price. EC2 Fleet\n selects the cheapest Spot pools and evenly allocates your target Spot capacity across the\n number of Spot pools that you specify.

\n

Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a\n best effort basis. If a pool runs out of Spot capacity before fulfilling your target\n capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest\n pool. To ensure that your target capacity is met, you might receive Spot Instances from more than\n the number of pools that you specified. Similarly, if most of the pools have no Spot\n capacity, you might receive your full target capacity from fewer than the number of pools\n that you specified.

" + } + }, + "SingleInstanceType": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates that the fleet uses a single instance type to launch all Spot Instances in the\n fleet.

\n

Supported only for fleets of type instant.

" + } + }, + "SingleAvailabilityZone": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates that the fleet launches all Spot Instances into a single Availability Zone.

\n

Supported only for fleets of type instant.

" + } + }, + "MinTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is\n not reached, the fleet launches no instances.

\n

Supported only for fleets of type instant.

\n

At least one of the following must be specified: SingleAvailabilityZone |\n SingleInstanceType\n

" + } + }, + "MaxTotalPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The maximum amount per hour for Spot Instances that you're willing to pay. We do not recommend\n using this parameter because it can lead to increased interruptions. If you do not specify\n this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the configuration of Spot Instances in an EC2 Fleet request.

" + } + }, + "com.amazonaws.ec2#SpotPlacement": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone.

\n

[Spot Fleet only] To specify multiple Availability Zones, separate them using commas;\n for example, \"us-west-2a, us-west-2b\".

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#PlacementGroupName", + "traits": { + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

The name of the placement group.

", + "smithy.api#xmlName": "groupName" + } + }, + "Tenancy": { + "target": "com.amazonaws.ec2#Tenancy", + "traits": { + "aws.protocols#ec2QueryName": "Tenancy", + "smithy.api#documentation": "

The tenancy of the instance (if the instance is running in a VPC). An instance with a\n tenancy of dedicated runs on single-tenant hardware. The host\n tenancy is not supported for Spot Instances.

", + "smithy.api#xmlName": "tenancy" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes Spot Instance placement.

" + } + }, + "com.amazonaws.ec2#SpotPlacementScore": { + "type": "structure", + "members": { + "Region": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Region", + "smithy.api#documentation": "

The Region.

", + "smithy.api#xmlName": "region" + } + }, + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneId", + "smithy.api#documentation": "

The Availability Zone.

", + "smithy.api#xmlName": "availabilityZoneId" + } + }, + "Score": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Score", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The placement score, on a scale from 1 to 10. A score of\n 10 indicates that your Spot request is highly likely to succeed in this\n Region or Availability Zone. A score of 1 indicates that your Spot request is\n not likely to succeed.

", + "smithy.api#xmlName": "score" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Spot placement score for this Region or Availability Zone. The score is calculated\n based on the assumption that the capacity-optimized allocation strategy is\n used and that all of the Availability Zones in the Region can be used.

" + } + }, + "com.amazonaws.ec2#SpotPlacementScores": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SpotPlacementScore", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SpotPlacementScoresMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 10, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#SpotPlacementScoresTargetCapacity": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 2000000000 + } + } + }, + "com.amazonaws.ec2#SpotPrice": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type.

", + "smithy.api#xmlName": "instanceType" + } + }, + "ProductDescription": { + "target": "com.amazonaws.ec2#RIProductDescription", + "traits": { + "aws.protocols#ec2QueryName": "ProductDescription", + "smithy.api#documentation": "

A general description of the AMI.

", + "smithy.api#xmlName": "productDescription" + } + }, + "SpotPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpotPrice", + "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend \n using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n ", + "smithy.api#xmlName": "spotPrice" + } + }, + "Timestamp": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "Timestamp", + "smithy.api#documentation": "

The date and time the request was created, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", + "smithy.api#xmlName": "timestamp" + } + } + }, + "traits": { + "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend \n using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n " + } + }, + "com.amazonaws.ec2#SpotPriceHistoryList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SpotPrice", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SpreadLevel": { + "type": "enum", + "members": { + "host": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "host" + } + }, + "rack": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rack" + } + } + } + }, + "com.amazonaws.ec2#StaleIpPermission": { + "type": "structure", + "members": { + "FromPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "FromPort", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The start of the port range for the TCP and UDP protocols, or an ICMP type number. A value of\n -1 indicates all ICMP types.

", + "smithy.api#xmlName": "fromPort" + } + }, + "IpProtocol": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpProtocol", + "smithy.api#documentation": "

The IP protocol name (for tcp, udp, and icmp) or number (see Protocol Numbers).

", + "smithy.api#xmlName": "ipProtocol" + } + }, + "IpRanges": { + "target": "com.amazonaws.ec2#IpRanges", + "traits": { + "aws.protocols#ec2QueryName": "IpRanges", + "smithy.api#documentation": "

The IP ranges. Not applicable for stale security group rules.

", + "smithy.api#xmlName": "ipRanges" + } + }, + "PrefixListIds": { + "target": "com.amazonaws.ec2#PrefixListIdSet", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListIds", + "smithy.api#documentation": "

The prefix list IDs. Not applicable for stale security group rules.

", + "smithy.api#xmlName": "prefixListIds" + } + }, + "ToPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "ToPort", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The end of the port range for the TCP and UDP protocols, or an ICMP type number. A value of\n -1 indicates all ICMP types.

", + "smithy.api#xmlName": "toPort" + } + }, + "UserIdGroupPairs": { + "target": "com.amazonaws.ec2#UserIdGroupPairSet", + "traits": { + "aws.protocols#ec2QueryName": "Groups", + "smithy.api#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.

", + "smithy.api#xmlName": "groups" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a stale rule in a security group.

" + } + }, + "com.amazonaws.ec2#StaleIpPermissionSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#StaleIpPermission", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#StaleSecurityGroup": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of the security group.

", + "smithy.api#xmlName": "description" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The ID of the security group.

", + "smithy.api#xmlName": "groupId" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

The name of the security group.

", + "smithy.api#xmlName": "groupName" + } + }, + "StaleIpPermissions": { + "target": "com.amazonaws.ec2#StaleIpPermissionSet", + "traits": { + "aws.protocols#ec2QueryName": "StaleIpPermissions", + "smithy.api#documentation": "

Information about the stale inbound rules in the security group.

", + "smithy.api#xmlName": "staleIpPermissions" + } + }, + "StaleIpPermissionsEgress": { + "target": "com.amazonaws.ec2#StaleIpPermissionSet", + "traits": { + "aws.protocols#ec2QueryName": "StaleIpPermissionsEgress", + "smithy.api#documentation": "

Information about the stale outbound rules in the security group.

", + "smithy.api#xmlName": "staleIpPermissionsEgress" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC for the security group.

", + "smithy.api#xmlName": "vpcId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a stale security group (a security group that contains stale rules).

" + } + }, + "com.amazonaws.ec2#StaleSecurityGroupSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#StaleSecurityGroup", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#StartInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#StartInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#StartInstancesResult" + }, + "traits": { + "smithy.api#documentation": "

Starts an Amazon EBS-backed instance that you've previously stopped.

\n

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and\n started. When an instance is stopped, the compute resources are released and you are not\n billed for instance usage. However, your root partition Amazon EBS volume remains and\n continues to persist your data, and you are charged for Amazon EBS volume usage. You can\n restart your instance at any time. Every time you start your instance, Amazon EC2\n charges a one-minute minimum for instance usage, and thereafter charges per second for\n instance usage.

\n

Before stopping an instance, make sure it is in a state from which it can be\n restarted. Stopping an instance does not preserve data stored in RAM.

\n

Performing this operation on an instance that uses an instance store as its root\n device returns an error.

\n

If you attempt to start a T3 instance with host tenancy and the\n unlimted CPU credit option, the request fails. The\n unlimited CPU credit option is not supported on Dedicated Hosts. Before\n you start the instance, either change its CPU credit option to standard, or\n change its tenancy to default or dedicated.

\n

For more information, see Stop and start your instance\n in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#StartInstancesRequest": { + "type": "structure", + "members": { + "InstanceIds": { + "target": "com.amazonaws.ec2#InstanceIdStringList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the instances.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "InstanceId" + } + }, + "AdditionalInfo": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AdditionalInfo", + "smithy.api#documentation": "

Reserved.

", + "smithy.api#xmlName": "additionalInfo" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#StartInstancesResult": { + "type": "structure", + "members": { + "StartingInstances": { + "target": "com.amazonaws.ec2#InstanceStateChangeList", + "traits": { + "aws.protocols#ec2QueryName": "InstancesSet", + "smithy.api#documentation": "

Information about the started instances.

", + "smithy.api#xmlName": "instancesSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#StartNetworkInsightsAccessScopeAnalysis": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#StartNetworkInsightsAccessScopeAnalysisRequest" + }, + "output": { + "target": "com.amazonaws.ec2#StartNetworkInsightsAccessScopeAnalysisResult" + }, + "traits": { + "smithy.api#documentation": "

Starts analyzing the specified Network Access Scope.

" + } + }, + "com.amazonaws.ec2#StartNetworkInsightsAccessScopeAnalysisRequest": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeId": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Network Access Scope.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, \n see How to ensure idempotency.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#StartNetworkInsightsAccessScopeAnalysisResult": { + "type": "structure", + "members": { + "NetworkInsightsAccessScopeAnalysis": { + "target": "com.amazonaws.ec2#NetworkInsightsAccessScopeAnalysis", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAccessScopeAnalysis", + "smithy.api#documentation": "

The Network Access Scope analysis.

", + "smithy.api#xmlName": "networkInsightsAccessScopeAnalysis" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#StartNetworkInsightsAnalysis": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#StartNetworkInsightsAnalysisRequest" + }, + "output": { + "target": "com.amazonaws.ec2#StartNetworkInsightsAnalysisResult" + }, + "traits": { + "smithy.api#documentation": "

Starts analyzing the specified path. If the path is reachable, the\n operation returns the shortest feasible path.

" + } + }, + "com.amazonaws.ec2#StartNetworkInsightsAnalysisRequest": { + "type": "structure", + "members": { + "NetworkInsightsPathId": { + "target": "com.amazonaws.ec2#NetworkInsightsPathId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the path.

", + "smithy.api#required": {} + } + }, + "AdditionalAccounts": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The member accounts that contain resources that the path can traverse.

", + "smithy.api#xmlName": "AdditionalAccount" + } + }, + "FilterInArns": { + "target": "com.amazonaws.ec2#ArnList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the resources that the path must traverse.

", + "smithy.api#xmlName": "FilterInArn" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, \n see How to ensure idempotency.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#StartNetworkInsightsAnalysisResult": { + "type": "structure", + "members": { + "NetworkInsightsAnalysis": { + "target": "com.amazonaws.ec2#NetworkInsightsAnalysis", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInsightsAnalysis", + "smithy.api#documentation": "

Information about the network insights analysis.

", + "smithy.api#xmlName": "networkInsightsAnalysis" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#StartVpcEndpointServicePrivateDnsVerification": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#StartVpcEndpointServicePrivateDnsVerificationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#StartVpcEndpointServicePrivateDnsVerificationResult" + }, + "traits": { + "smithy.api#documentation": "

Initiates the verification process to prove that the service provider owns the private\n DNS name domain for the endpoint service.

\n

The service provider must successfully perform the verification before the consumer can use the name to access the service.

\n

Before the service provider runs this command, they must add a record to the DNS server.

" + } + }, + "com.amazonaws.ec2#StartVpcEndpointServicePrivateDnsVerificationRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ServiceId": { + "target": "com.amazonaws.ec2#VpcEndpointServiceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the endpoint service.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#StartVpcEndpointServicePrivateDnsVerificationResult": { + "type": "structure", + "members": { + "ReturnValue": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#State": { + "type": "enum", + "members": { + "PendingAcceptance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PendingAcceptance" + } + }, + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "Available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Available" + } + }, + "Deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "Deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleted" + } + }, + "Rejected": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Rejected" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "Expired": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Expired" + } + } + } + }, + "com.amazonaws.ec2#StateReason": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The reason code for the state change.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The message for the state change.

\n ", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a state change.

" + } + }, + "com.amazonaws.ec2#StaticSourcesSupportValue": { + "type": "enum", + "members": { + "enable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enable" + } + }, + "disable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disable" + } + } + } + }, + "com.amazonaws.ec2#StatisticType": { + "type": "enum", + "members": { + "p50": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "p50" + } + } + } + }, + "com.amazonaws.ec2#Status": { + "type": "enum", + "members": { + "moveInProgress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MoveInProgress" + } + }, + "inVpc": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InVpc" + } + }, + "inClassic": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InClassic" + } + } + } + }, + "com.amazonaws.ec2#StatusName": { + "type": "enum", + "members": { + "reachability": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "reachability" + } + } + } + }, + "com.amazonaws.ec2#StatusType": { + "type": "enum", + "members": { + "passed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "passed" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "insufficient_data": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "insufficient-data" + } + }, + "initializing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "initializing" + } + } + } + }, + "com.amazonaws.ec2#StopInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#StopInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#StopInstancesResult" + }, + "traits": { + "smithy.api#documentation": "

Stops an Amazon EBS-backed instance. For more information, see Stop and start\n your instance in the Amazon EC2 User Guide.

\n

You can use the Stop action to hibernate an instance if the instance is enabled for\n hibernation and it meets the hibernation\n prerequisites. For more information, see Hibernate your instance in the\n Amazon EC2 User Guide.

\n

We don't charge usage for a stopped instance, or data transfer fees; however, your\n root partition Amazon EBS volume remains and continues to persist your data, and you are\n charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2\n charges a one-minute minimum for instance usage, and thereafter charges per second for\n instance usage.

\n

You can't stop or hibernate instance store-backed instances. You can't use the Stop\n action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate\n Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the\n Amazon EC2 User Guide.

\n

When you stop or hibernate an instance, we shut it down. You can restart your instance\n at any time. Before stopping or hibernating an instance, make sure it is in a state from\n which it can be restarted. Stopping an instance does not preserve data stored in RAM,\n but hibernating an instance does preserve data stored in RAM. If an instance cannot\n hibernate successfully, a normal shutdown occurs.

\n

Stopping and hibernating an instance is different to rebooting or terminating it. For\n example, when you stop or hibernate an instance, the root device and any other devices\n attached to the instance persist. When you terminate an instance, the root device and\n any other devices attached during the instance launch are automatically deleted. For\n more information about the differences between rebooting, stopping, hibernating, and\n terminating instances, see Instance lifecycle\n in the Amazon EC2 User Guide.

\n

When you stop an instance, we attempt to shut it down forcibly after a short while. If\n your instance appears stuck in the stopping state after a period of time, there may be\n an issue with the underlying host computer. For more information, see Troubleshoot\n stopping your instance in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#StopInstancesRequest": { + "type": "structure", + "members": { + "InstanceIds": { + "target": "com.amazonaws.ec2#InstanceIdStringList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the instances.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "InstanceId" + } + }, + "Hibernate": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Hibernates the instance if the instance was enabled for hibernation at launch. If the\n instance cannot hibernate successfully, a normal shutdown occurs. For more information,\n see Hibernate\n your instance in the Amazon EC2 User Guide.

\n

Default: false\n

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Force": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Force", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Forces the instances to stop. The instances do not have an opportunity to flush file\n system caches or file system metadata. If you use this option, you must perform file\n system check and repair procedures. This option is not recommended for Windows\n instances.

\n

Default: false\n

", + "smithy.api#xmlName": "force" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#StopInstancesResult": { + "type": "structure", + "members": { + "StoppingInstances": { + "target": "com.amazonaws.ec2#InstanceStateChangeList", + "traits": { + "aws.protocols#ec2QueryName": "InstancesSet", + "smithy.api#documentation": "

Information about the stopped instances.

", + "smithy.api#xmlName": "instancesSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#Storage": { + "type": "structure", + "members": { + "S3": { + "target": "com.amazonaws.ec2#S3Storage", + "traits": { + "smithy.api#documentation": "

An Amazon S3 storage location.

", + "smithy.api#xmlName": "S3" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the storage location for an instance store-backed AMI.

" + } + }, + "com.amazonaws.ec2#StorageLocation": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the S3 bucket.

" + } + }, + "Key": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The key.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a storage location in Amazon S3.

" + } + }, + "com.amazonaws.ec2#StorageTier": { + "type": "enum", + "members": { + "archive": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "archive" + } + }, + "standard": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "standard" + } + } + } + }, + "com.amazonaws.ec2#StoreImageTaskResult": { + "type": "structure", + "members": { + "AmiId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AmiId", + "smithy.api#documentation": "

The ID of the AMI that is being stored.

", + "smithy.api#xmlName": "amiId" + } + }, + "TaskStartTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "TaskStartTime", + "smithy.api#documentation": "

The time the task started.

", + "smithy.api#xmlName": "taskStartTime" + } + }, + "Bucket": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Bucket", + "smithy.api#documentation": "

The name of the Amazon S3 bucket that contains the stored AMI object.

", + "smithy.api#xmlName": "bucket" + } + }, + "S3objectKey": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "S3objectKey", + "smithy.api#documentation": "

The name of the stored AMI object in the bucket.

", + "smithy.api#xmlName": "s3objectKey" + } + }, + "ProgressPercentage": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "ProgressPercentage", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The progress of the task as a percentage.

", + "smithy.api#xmlName": "progressPercentage" + } + }, + "StoreTaskState": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StoreTaskState", + "smithy.api#documentation": "

The state of the store task (InProgress, Completed, or\n Failed).

", + "smithy.api#xmlName": "storeTaskState" + } + }, + "StoreTaskFailureReason": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StoreTaskFailureReason", + "smithy.api#documentation": "

If the tasks fails, the reason for the failure is returned. If the task succeeds,\n null is returned.

", + "smithy.api#xmlName": "storeTaskFailureReason" + } + } + }, + "traits": { + "smithy.api#documentation": "

The information about the AMI store task, including the progress of the task.

" + } + }, + "com.amazonaws.ec2#StoreImageTaskResultSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#StoreImageTaskResult", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#String": { + "type": "string" + }, + "com.amazonaws.ec2#StringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#StringType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64000 + } + } + }, + "com.amazonaws.ec2#Subnet": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone of the subnet.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneId", + "smithy.api#documentation": "

The AZ ID of the subnet.

", + "smithy.api#xmlName": "availabilityZoneId" + } + }, + "AvailableIpAddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "AvailableIpAddressCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any\n\t\t\tstopped instances are considered unavailable.

", + "smithy.api#xmlName": "availableIpAddressCount" + } + }, + "CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrBlock", + "smithy.api#documentation": "

The IPv4 CIDR block assigned to the subnet.

", + "smithy.api#xmlName": "cidrBlock" + } + }, + "DefaultForAz": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DefaultForAz", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether this is the default subnet for the Availability Zone.

", + "smithy.api#xmlName": "defaultForAz" + } + }, + "EnableLniAtDeviceIndex": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "EnableLniAtDeviceIndex", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

\n Indicates the device position for local network interfaces in this subnet. For example, \n 1 indicates local network interfaces in this subnet are the secondary \n network interface (eth1). \n

", + "smithy.api#xmlName": "enableLniAtDeviceIndex" + } + }, + "MapPublicIpOnLaunch": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "MapPublicIpOnLaunch", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether instances launched in this subnet receive a public IPv4 address.

", + "smithy.api#xmlName": "mapPublicIpOnLaunch" + } + }, + "MapCustomerOwnedIpOnLaunch": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "MapCustomerOwnedIpOnLaunch", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether a network interface created in this subnet (including a network\n interface created by RunInstances) receives a customer-owned IPv4 address.

", + "smithy.api#xmlName": "mapCustomerOwnedIpOnLaunch" + } + }, + "CustomerOwnedIpv4Pool": { + "target": "com.amazonaws.ec2#CoipPoolId", + "traits": { + "aws.protocols#ec2QueryName": "CustomerOwnedIpv4Pool", + "smithy.api#documentation": "

The customer-owned IPv4 address pool associated with the subnet.

", + "smithy.api#xmlName": "customerOwnedIpv4Pool" + } + }, + "State": { + "target": "com.amazonaws.ec2#SubnetState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the subnet.

", + "smithy.api#xmlName": "state" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet.

", + "smithy.api#xmlName": "subnetId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC the subnet is in.

", + "smithy.api#xmlName": "vpcId" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the subnet.

", + "smithy.api#xmlName": "ownerId" + } + }, + "AssignIpv6AddressOnCreation": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AssignIpv6AddressOnCreation", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether a network interface created in this subnet (including a network\n interface created by RunInstances) receives an IPv6 address.

", + "smithy.api#xmlName": "assignIpv6AddressOnCreation" + } + }, + "Ipv6CidrBlockAssociationSet": { + "target": "com.amazonaws.ec2#SubnetIpv6CidrBlockAssociationSet", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrBlockAssociationSet", + "smithy.api#documentation": "

Information about the IPv6 CIDR blocks associated with the subnet.

", + "smithy.api#xmlName": "ipv6CidrBlockAssociationSet" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the subnet.

", + "smithy.api#xmlName": "tagSet" + } + }, + "SubnetArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the subnet.

", + "smithy.api#xmlName": "subnetArn" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutpostArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

", + "smithy.api#xmlName": "outpostArn" + } + }, + "EnableDns64": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnableDns64", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet \n should return synthetic IPv6 addresses for IPv4-only destinations.

", + "smithy.api#xmlName": "enableDns64" + } + }, + "Ipv6Native": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Native", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether this is an IPv6 only subnet.

", + "smithy.api#xmlName": "ipv6Native" + } + }, + "PrivateDnsNameOptionsOnLaunch": { + "target": "com.amazonaws.ec2#PrivateDnsNameOptionsOnLaunch", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDnsNameOptionsOnLaunch", + "smithy.api#documentation": "

The type of hostnames to assign to instances in the subnet at launch. An instance hostname\n is based on the IPv4 address or ID of the instance.

", + "smithy.api#xmlName": "privateDnsNameOptionsOnLaunch" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a subnet.

" + } + }, + "com.amazonaws.ec2#SubnetAssociation": { + "type": "structure", + "members": { + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet.

", + "smithy.api#xmlName": "subnetId" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayMulitcastDomainAssociationState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the subnet association.

", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the subnet association with the transit gateway multicast domain.

" + } + }, + "com.amazonaws.ec2#SubnetAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SubnetAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SubnetCidrAssociationId": { + "type": "string" + }, + "com.amazonaws.ec2#SubnetCidrBlockState": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.ec2#SubnetCidrBlockStateCode", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of a CIDR block.

", + "smithy.api#xmlName": "state" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

A message about the status of the CIDR block, if applicable.

", + "smithy.api#xmlName": "statusMessage" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the state of a CIDR block.

" + } + }, + "com.amazonaws.ec2#SubnetCidrBlockStateCode": { + "type": "enum", + "members": { + "associating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associating" + } + }, + "associated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associated" + } + }, + "disassociating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociating" + } + }, + "disassociated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociated" + } + }, + "failing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failing" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + } + } + }, + "com.amazonaws.ec2#SubnetCidrReservation": { + "type": "structure", + "members": { + "SubnetCidrReservationId": { + "target": "com.amazonaws.ec2#SubnetCidrReservationId", + "traits": { + "aws.protocols#ec2QueryName": "SubnetCidrReservationId", + "smithy.api#documentation": "

The ID of the subnet CIDR reservation.

", + "smithy.api#xmlName": "subnetCidrReservationId" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet.

", + "smithy.api#xmlName": "subnetId" + } + }, + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Cidr", + "smithy.api#documentation": "

The CIDR that has been reserved.

", + "smithy.api#xmlName": "cidr" + } + }, + "ReservationType": { + "target": "com.amazonaws.ec2#SubnetCidrReservationType", + "traits": { + "aws.protocols#ec2QueryName": "ReservationType", + "smithy.api#documentation": "

The type of reservation.

", + "smithy.api#xmlName": "reservationType" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the account that owns the subnet CIDR reservation.

", + "smithy.api#xmlName": "ownerId" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The\n description\n assigned to the subnet CIDR\n reservation.

", + "smithy.api#xmlName": "description" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the subnet CIDR reservation.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a subnet CIDR reservation.

" + } + }, + "com.amazonaws.ec2#SubnetCidrReservationId": { + "type": "string" + }, + "com.amazonaws.ec2#SubnetCidrReservationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SubnetCidrReservation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SubnetCidrReservationType": { + "type": "enum", + "members": { + "prefix": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "prefix" + } + }, + "explicit": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "explicit" + } + } + } + }, + "com.amazonaws.ec2#SubnetId": { + "type": "string" + }, + "com.amazonaws.ec2#SubnetIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#xmlName": "SubnetId" + } + } + }, + "com.amazonaws.ec2#SubnetIpv6CidrBlockAssociation": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.ec2#SubnetCidrAssociationId", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#documentation": "

The ID of the association.

", + "smithy.api#xmlName": "associationId" + } + }, + "Ipv6CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrBlock", + "smithy.api#documentation": "

The IPv6 CIDR block.

", + "smithy.api#xmlName": "ipv6CidrBlock" + } + }, + "Ipv6CidrBlockState": { + "target": "com.amazonaws.ec2#SubnetCidrBlockState", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrBlockState", + "smithy.api#documentation": "

The state of the CIDR block.

", + "smithy.api#xmlName": "ipv6CidrBlockState" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an association between a subnet and an IPv6 CIDR block.

" + } + }, + "com.amazonaws.ec2#SubnetIpv6CidrBlockAssociationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SubnetIpv6CidrBlockAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SubnetList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Subnet", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SubnetState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + } + } + }, + "com.amazonaws.ec2#Subscription": { + "type": "structure", + "members": { + "Source": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Source", + "smithy.api#documentation": "

The Region or Availability Zone that's the source for the subscription. For example, us-east-1.

", + "smithy.api#xmlName": "source" + } + }, + "Destination": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Destination", + "smithy.api#documentation": "

The Region or Availability Zone that's the target for the subscription. For example, eu-west-1.

", + "smithy.api#xmlName": "destination" + } + }, + "Metric": { + "target": "com.amazonaws.ec2#MetricType", + "traits": { + "aws.protocols#ec2QueryName": "Metric", + "smithy.api#documentation": "

The metric used for the subscription.

", + "smithy.api#xmlName": "metric" + } + }, + "Statistic": { + "target": "com.amazonaws.ec2#StatisticType", + "traits": { + "aws.protocols#ec2QueryName": "Statistic", + "smithy.api#documentation": "

The statistic used for the subscription.

", + "smithy.api#xmlName": "statistic" + } + }, + "Period": { + "target": "com.amazonaws.ec2#PeriodType", + "traits": { + "aws.protocols#ec2QueryName": "Period", + "smithy.api#documentation": "

The data aggregation time for the subscription.

", + "smithy.api#xmlName": "period" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an Infrastructure Performance subscription.

" + } + }, + "com.amazonaws.ec2#SubscriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Subscription", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SuccessfulInstanceCreditSpecificationItem": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the burstable performance instance whose credit option for CPU usage was\n successfully modified.

" + } + }, + "com.amazonaws.ec2#SuccessfulInstanceCreditSpecificationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SuccessfulInstanceCreditSpecificationItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SuccessfulQueuedPurchaseDeletion": { + "type": "structure", + "members": { + "ReservedInstancesId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesId", + "smithy.api#documentation": "

The ID of the Reserved Instance.

", + "smithy.api#xmlName": "reservedInstancesId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Reserved Instance whose queued purchase was successfully deleted.

" + } + }, + "com.amazonaws.ec2#SuccessfulQueuedPurchaseDeletionSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SuccessfulQueuedPurchaseDeletion", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SummaryStatus": { + "type": "enum", + "members": { + "ok": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ok" + } + }, + "impaired": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "impaired" + } + }, + "insufficient_data": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "insufficient-data" + } + }, + "not_applicable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "not-applicable" + } + }, + "initializing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "initializing" + } + } + } + }, + "com.amazonaws.ec2#SupportedAdditionalProcessorFeature": { + "type": "enum", + "members": { + "AMD_SEV_SNP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "amd-sev-snp" + } + } + } + }, + "com.amazonaws.ec2#SupportedAdditionalProcessorFeatureList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SupportedAdditionalProcessorFeature", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SupportedIpAddressTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ServiceConnectivityType", + "traits": { + "smithy.api#xmlName": "item" + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, + "com.amazonaws.ec2#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Key", + "smithy.api#documentation": "

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. \n May not begin with aws:.

", + "smithy.api#xmlName": "key" + } + }, + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#documentation": "

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

", + "smithy.api#xmlName": "value" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a tag.

" + } + }, + "com.amazonaws.ec2#TagDescription": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Key", + "smithy.api#documentation": "

The tag key.

", + "smithy.api#xmlName": "key" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource.

", + "smithy.api#xmlName": "resourceId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#ResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The resource type.

", + "smithy.api#xmlName": "resourceType" + } + }, + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#documentation": "

The tag value.

", + "smithy.api#xmlName": "value" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a tag.

" + } + }, + "com.amazonaws.ec2#TagDescriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TagDescription", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Tag", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TagSpecification": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.ec2#ResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The type of resource to tag on creation.

", + "smithy.api#xmlName": "resourceType" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the resource.

", + "smithy.api#xmlName": "Tag" + } + } + }, + "traits": { + "smithy.api#documentation": "

The tags to apply to a resource when the resource is being created. When you specify a tag, you must \n specify the resource type to tag, otherwise the request will fail.

\n \n

The Valid Values lists all the resource types that can be tagged.\n However, the action you're using might not support tagging all of these resource types.\n If you try to tag a resource type that is unsupported for the action you're using,\n you'll get an error.

\n " + } + }, + "com.amazonaws.ec2#TagSpecificationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TagSpecification", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TaggableResourceId": { + "type": "string" + }, + "com.amazonaws.ec2#TargetCapacitySpecification": { + "type": "structure", + "members": { + "TotalTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TotalTargetCapacity", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of units to request, filled using\n DefaultTargetCapacityType.

", + "smithy.api#xmlName": "totalTargetCapacity" + } + }, + "OnDemandTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "OnDemandTargetCapacity", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#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.

", + "smithy.api#xmlName": "onDemandTargetCapacity" + } + }, + "SpotTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "SpotTargetCapacity", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#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.

", + "smithy.api#xmlName": "spotTargetCapacity" + } + }, + "DefaultTargetCapacityType": { + "target": "com.amazonaws.ec2#DefaultTargetCapacityType", + "traits": { + "aws.protocols#ec2QueryName": "DefaultTargetCapacityType", + "smithy.api#documentation": "

The default TotalTargetCapacity, which is either Spot or\n On-Demand.

", + "smithy.api#xmlName": "defaultTargetCapacityType" + } + }, + "TargetCapacityUnitType": { + "target": "com.amazonaws.ec2#TargetCapacityUnitType", + "traits": { + "aws.protocols#ec2QueryName": "TargetCapacityUnitType", + "smithy.api#documentation": "

The unit for the target capacity. TargetCapacityUnitType can only be specified when InstanceRequirements is specified.

\n

Default: units (translates to number of instances)

", + "smithy.api#xmlName": "targetCapacityUnitType" + } + } + }, + "traits": { + "smithy.api#documentation": "

The number of units to request. You can choose to set the target capacity in terms of\n instances or a performance characteristic that is important to your application workload,\n such as vCPUs, memory, or I/O. If the request type is maintain, you can\n specify a target capacity of 0 and add capacity later.

\n

You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance\n MaxTotalPrice, or both to ensure that your fleet cost does not exceed your\n budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet\n will launch instances until it reaches the maximum amount that you're willing to pay. When\n the maximum amount you're willing to pay is reached, the fleet stops launching instances\n even if it hasn’t met the target capacity. The MaxTotalPrice parameters are\n located in OnDemandOptions \n and SpotOptions.

" + } + }, + "com.amazonaws.ec2#TargetCapacitySpecificationRequest": { + "type": "structure", + "members": { + "TotalTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of units to request, filled using\n DefaultTargetCapacityType.

", + "smithy.api#required": {} + } + }, + "OnDemandTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of On-Demand units to request.

" + } + }, + "SpotTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of Spot units to request.

" + } + }, + "DefaultTargetCapacityType": { + "target": "com.amazonaws.ec2#DefaultTargetCapacityType", + "traits": { + "smithy.api#documentation": "

The default TotalTargetCapacity, which is either Spot or\n On-Demand.

" + } + }, + "TargetCapacityUnitType": { + "target": "com.amazonaws.ec2#TargetCapacityUnitType", + "traits": { + "smithy.api#documentation": "

The unit for the target capacity. TargetCapacityUnitType can only be specified when InstanceRequirements is specified.

\n

Default: units (translates to number of instances)

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The number of units to request. You can choose to set the target capacity as the number of \n instances. Or you can set the target capacity to a performance characteristic that is important to your application workload,\n such as vCPUs, memory, or I/O. If the request type is maintain, you can\n specify a target capacity of 0 and add capacity later.

\n

You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance\n MaxTotalPrice parameter, or both parameters to ensure that your fleet cost\n does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances\n in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you're\n willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops\n launching instances even if it hasn’t met the target capacity. The\n MaxTotalPrice parameters are located in OnDemandOptionsRequest \n and SpotOptionsRequest.

" + } + }, + "com.amazonaws.ec2#TargetCapacityUnitType": { + "type": "enum", + "members": { + "VCPU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vcpu" + } + }, + "MEMORY_MIB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "memory-mib" + } + }, + "UNITS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "units" + } + } + } + }, + "com.amazonaws.ec2#TargetConfiguration": { + "type": "structure", + "members": { + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "InstanceCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of instances the Convertible Reserved Instance offering can be applied to. This parameter is \n reserved and cannot be specified in a request

", + "smithy.api#xmlName": "instanceCount" + } + }, + "OfferingId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OfferingId", + "smithy.api#documentation": "

The ID of the Convertible Reserved Instance offering.

", + "smithy.api#xmlName": "offeringId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the Convertible Reserved Instance offering.

" + } + }, + "com.amazonaws.ec2#TargetConfigurationRequest": { + "type": "structure", + "members": { + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of instances the Convertible Reserved Instance offering can be applied to. This parameter is reserved and cannot \n be specified in a request

" + } + }, + "OfferingId": { + "target": "com.amazonaws.ec2#ReservedInstancesOfferingId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Convertible Reserved Instance offering ID.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the target configuration.

" + } + }, + "com.amazonaws.ec2#TargetConfigurationRequestSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TargetConfigurationRequest", + "traits": { + "smithy.api#xmlName": "TargetConfigurationRequest" + } + } + }, + "com.amazonaws.ec2#TargetGroup": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Arn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target group.

", + "smithy.api#xmlName": "arn" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a load balancer target group.

" + } + }, + "com.amazonaws.ec2#TargetGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TargetGroup", + "traits": { + "smithy.api#xmlName": "item" + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.ec2#TargetGroupsConfig": { + "type": "structure", + "members": { + "TargetGroups": { + "target": "com.amazonaws.ec2#TargetGroups", + "traits": { + "aws.protocols#ec2QueryName": "TargetGroups", + "smithy.api#documentation": "

One or more target groups.

", + "smithy.api#xmlName": "targetGroups" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the target groups to attach to a Spot Fleet. Spot Fleet registers the\n running Spot Instances with these target groups.

" + } + }, + "com.amazonaws.ec2#TargetNetwork": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#documentation": "

The ID of the association.

", + "smithy.api#xmlName": "associationId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC in which the target network (subnet) is located.

", + "smithy.api#xmlName": "vpcId" + } + }, + "TargetNetworkId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TargetNetworkId", + "smithy.api#documentation": "

The ID of the subnet specified as the target network.

", + "smithy.api#xmlName": "targetNetworkId" + } + }, + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientVpnEndpointId", + "smithy.api#documentation": "

The ID of the Client VPN endpoint with which the target network is associated.

", + "smithy.api#xmlName": "clientVpnEndpointId" + } + }, + "Status": { + "target": "com.amazonaws.ec2#AssociationStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The current state of the target network association.

", + "smithy.api#xmlName": "status" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroups", + "smithy.api#documentation": "

The IDs of the security groups applied to the target network association.

", + "smithy.api#xmlName": "securityGroups" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a target network associated with a Client VPN endpoint.

" + } + }, + "com.amazonaws.ec2#TargetNetworkSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TargetNetwork", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TargetReservationValue": { + "type": "structure", + "members": { + "ReservationValue": { + "target": "com.amazonaws.ec2#ReservationValue", + "traits": { + "aws.protocols#ec2QueryName": "ReservationValue", + "smithy.api#documentation": "

The total value of the Convertible Reserved Instances that make up the exchange. This is the sum of\n the list value, remaining upfront price, and additional upfront cost of the exchange.

", + "smithy.api#xmlName": "reservationValue" + } + }, + "TargetConfiguration": { + "target": "com.amazonaws.ec2#TargetConfiguration", + "traits": { + "aws.protocols#ec2QueryName": "TargetConfiguration", + "smithy.api#documentation": "

The configuration of the Convertible Reserved Instances that make up the exchange.

", + "smithy.api#xmlName": "targetConfiguration" + } + } + }, + "traits": { + "smithy.api#documentation": "

The total value of the new Convertible Reserved Instances.

" + } + }, + "com.amazonaws.ec2#TargetReservationValueSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TargetReservationValue", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TargetStorageTier": { + "type": "enum", + "members": { + "archive": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "archive" + } + } + } + }, + "com.amazonaws.ec2#TelemetryStatus": { + "type": "enum", + "members": { + "UP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UP" + } + }, + "DOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOWN" + } + } + } + }, + "com.amazonaws.ec2#Tenancy": { + "type": "enum", + "members": { + "default": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "default" + } + }, + "dedicated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dedicated" + } + }, + "host": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "host" + } + } + } + }, + "com.amazonaws.ec2#TerminateClientVpnConnections": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#TerminateClientVpnConnectionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#TerminateClientVpnConnectionsResult" + }, + "traits": { + "smithy.api#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.

" + } + }, + "com.amazonaws.ec2#TerminateClientVpnConnectionsRequest": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Client VPN endpoint to which the client is connected.

", + "smithy.api#required": {} + } + }, + "ConnectionId": { + "target": "com.amazonaws.ec2#VpnConnectionId", + "traits": { + "smithy.api#documentation": "

The ID of the client connection to be terminated.

" + } + }, + "Username": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the user who initiated the connection. Use this option to terminate all active connections for \n\t\t\tthe specified user. This option can only be used if the user has established up to five connections.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#TerminateClientVpnConnectionsResult": { + "type": "structure", + "members": { + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientVpnEndpointId", + "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", + "smithy.api#xmlName": "clientVpnEndpointId" + } + }, + "Username": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Username", + "smithy.api#documentation": "

The user who established the terminated client connections.

", + "smithy.api#xmlName": "username" + } + }, + "ConnectionStatuses": { + "target": "com.amazonaws.ec2#TerminateConnectionStatusSet", + "traits": { + "aws.protocols#ec2QueryName": "ConnectionStatuses", + "smithy.api#documentation": "

The current state of the client connections.

", + "smithy.api#xmlName": "connectionStatuses" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#TerminateConnectionStatus": { + "type": "structure", + "members": { + "ConnectionId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ConnectionId", + "smithy.api#documentation": "

The ID of the client connection.

", + "smithy.api#xmlName": "connectionId" + } + }, + "PreviousStatus": { + "target": "com.amazonaws.ec2#ClientVpnConnectionStatus", + "traits": { + "aws.protocols#ec2QueryName": "PreviousStatus", + "smithy.api#documentation": "

The state of the client connection.

", + "smithy.api#xmlName": "previousStatus" + } + }, + "CurrentStatus": { + "target": "com.amazonaws.ec2#ClientVpnConnectionStatus", + "traits": { + "aws.protocols#ec2QueryName": "CurrentStatus", + "smithy.api#documentation": "

A message about the status of the client connection, if applicable.

", + "smithy.api#xmlName": "currentStatus" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a terminated Client VPN endpoint client connection.

" + } + }, + "com.amazonaws.ec2#TerminateConnectionStatusSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TerminateConnectionStatus", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TerminateInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#TerminateInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#TerminateInstancesResult" + }, + "traits": { + "smithy.api#documentation": "

Shuts down the specified instances. This operation is idempotent; if you terminate an\n instance more than once, each call succeeds.

\n

If you specify multiple instances and the request fails (for example, because of a\n single incorrect instance ID), none of the instances are terminated.

\n

If you terminate multiple instances across multiple Availability Zones, and one or\n more of the specified instances are enabled for termination protection, the request\n fails with the following results:

\n \n

For example, say you have the following instances:

\n \n

If you attempt to terminate all of these instances in the same request, the request\n reports failure with the following results:

\n \n

Terminated instances remain visible after termination (for approximately one\n hour).

\n

By default, Amazon EC2 deletes all EBS volumes that were attached when the instance\n launched. Volumes attached after instance launch continue running.

\n

You can stop, start, and terminate EBS-backed instances. You can only terminate\n instance store-backed instances. What happens to an instance differs if you stop it or\n terminate it. For example, when you stop an instance, the root device and any other\n devices attached to the instance persist. When you terminate an instance, any attached\n EBS volumes with the DeleteOnTermination block device mapping parameter set\n to true are automatically deleted. For more information about the\n differences between stopping and terminating instances, see Instance lifecycle\n in the Amazon EC2 User Guide.

\n

For more information about troubleshooting, see Troubleshooting terminating your instance in the\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#TerminateInstancesRequest": { + "type": "structure", + "members": { + "InstanceIds": { + "target": "com.amazonaws.ec2#InstanceIdStringList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the instances.

\n

Constraints: Up to 1000 instance IDs. We recommend breaking up this request into\n smaller batches.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "InstanceId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#TerminateInstancesResult": { + "type": "structure", + "members": { + "TerminatingInstances": { + "target": "com.amazonaws.ec2#InstanceStateChangeList", + "traits": { + "aws.protocols#ec2QueryName": "InstancesSet", + "smithy.api#documentation": "

Information about the terminated instances.

", + "smithy.api#xmlName": "instancesSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ThreadsPerCore": { + "type": "integer" + }, + "com.amazonaws.ec2#ThreadsPerCoreList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ThreadsPerCore", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ThroughResourcesStatement": { + "type": "structure", + "members": { + "ResourceStatement": { + "target": "com.amazonaws.ec2#ResourceStatement", + "traits": { + "aws.protocols#ec2QueryName": "ResourceStatement", + "smithy.api#documentation": "

The resource statement.

", + "smithy.api#xmlName": "resourceStatement" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a through resource statement.

" + } + }, + "com.amazonaws.ec2#ThroughResourcesStatementList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ThroughResourcesStatement", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ThroughResourcesStatementRequest": { + "type": "structure", + "members": { + "ResourceStatement": { + "target": "com.amazonaws.ec2#ResourceStatementRequest", + "traits": { + "smithy.api#documentation": "

The resource statement.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a through resource statement.

" + } + }, + "com.amazonaws.ec2#ThroughResourcesStatementRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ThroughResourcesStatementRequest", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TieringOperationStatus": { + "type": "enum", + "members": { + "archival_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "archival-in-progress" + } + }, + "archival_completed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "archival-completed" + } + }, + "archival_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "archival-failed" + } + }, + "temporary_restore_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "temporary-restore-in-progress" + } + }, + "temporary_restore_completed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "temporary-restore-completed" + } + }, + "temporary_restore_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "temporary-restore-failed" + } + }, + "permanent_restore_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "permanent-restore-in-progress" + } + }, + "permanent_restore_completed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "permanent-restore-completed" + } + }, + "permanent_restore_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "permanent-restore-failed" + } + } + } + }, + "com.amazonaws.ec2#TotalLocalStorageGB": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "Min", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum amount of total local storage, in GB. If this parameter is not specified, there is\n no minimum limit.

", + "smithy.api#xmlName": "min" + } + }, + "Max": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "Max", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum amount of total local storage, in GB. If this parameter is not specified, there is\n no maximum limit.

", + "smithy.api#xmlName": "max" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum amount of total local storage, in GB.

" + } + }, + "com.amazonaws.ec2#TotalLocalStorageGBRequest": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum amount of total local storage, in GB. To specify no minimum limit, omit this\n parameter.

" + } + }, + "Max": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum amount of total local storage, in GB. To specify no maximum limit, omit this\n parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum amount of total local storage, in GB.

" + } + }, + "com.amazonaws.ec2#TpmSupportValues": { + "type": "enum", + "members": { + "v2_0": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "v2.0" + } + } + } + }, + "com.amazonaws.ec2#TrafficDirection": { + "type": "enum", + "members": { + "ingress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ingress" + } + }, + "egress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "egress" + } + } + } + }, + "com.amazonaws.ec2#TrafficMirrorFilter": { + "type": "structure", + "members": { + "TrafficMirrorFilterId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorFilterId", + "smithy.api#documentation": "

The ID of the Traffic Mirror filter.

", + "smithy.api#xmlName": "trafficMirrorFilterId" + } + }, + "IngressFilterRules": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterRuleList", + "traits": { + "aws.protocols#ec2QueryName": "IngressFilterRuleSet", + "smithy.api#documentation": "

Information about the ingress rules that are associated with the Traffic Mirror filter.

", + "smithy.api#xmlName": "ingressFilterRuleSet" + } + }, + "EgressFilterRules": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterRuleList", + "traits": { + "aws.protocols#ec2QueryName": "EgressFilterRuleSet", + "smithy.api#documentation": "

Information about the egress rules that are associated with the Traffic Mirror filter.

", + "smithy.api#xmlName": "egressFilterRuleSet" + } + }, + "NetworkServices": { + "target": "com.amazonaws.ec2#TrafficMirrorNetworkServiceList", + "traits": { + "aws.protocols#ec2QueryName": "NetworkServiceSet", + "smithy.api#documentation": "

The network service traffic that is associated with the Traffic Mirror filter.

", + "smithy.api#xmlName": "networkServiceSet" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of the Traffic Mirror filter.

", + "smithy.api#xmlName": "description" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the Traffic Mirror filter.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the Traffic Mirror filter.

" + } + }, + "com.amazonaws.ec2#TrafficMirrorFilterId": { + "type": "string" + }, + "com.amazonaws.ec2#TrafficMirrorFilterIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TrafficMirrorFilterRule": { + "type": "structure", + "members": { + "TrafficMirrorFilterRuleId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorFilterRuleId", + "smithy.api#documentation": "

The ID of the Traffic Mirror rule.

", + "smithy.api#xmlName": "trafficMirrorFilterRuleId" + } + }, + "TrafficMirrorFilterId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorFilterId", + "smithy.api#documentation": "

The ID of the Traffic Mirror filter that the rule is associated with.

", + "smithy.api#xmlName": "trafficMirrorFilterId" + } + }, + "TrafficDirection": { + "target": "com.amazonaws.ec2#TrafficDirection", + "traits": { + "aws.protocols#ec2QueryName": "TrafficDirection", + "smithy.api#documentation": "

The traffic direction assigned to the Traffic Mirror rule.

", + "smithy.api#xmlName": "trafficDirection" + } + }, + "RuleNumber": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "RuleNumber", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The rule number of the Traffic Mirror rule.

", + "smithy.api#xmlName": "ruleNumber" + } + }, + "RuleAction": { + "target": "com.amazonaws.ec2#TrafficMirrorRuleAction", + "traits": { + "aws.protocols#ec2QueryName": "RuleAction", + "smithy.api#documentation": "

The action assigned to the Traffic Mirror rule.

", + "smithy.api#xmlName": "ruleAction" + } + }, + "Protocol": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Protocol", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The protocol assigned to the Traffic Mirror rule.

", + "smithy.api#xmlName": "protocol" + } + }, + "DestinationPortRange": { + "target": "com.amazonaws.ec2#TrafficMirrorPortRange", + "traits": { + "aws.protocols#ec2QueryName": "DestinationPortRange", + "smithy.api#documentation": "

The destination port range assigned to the Traffic Mirror rule.

", + "smithy.api#xmlName": "destinationPortRange" + } + }, + "SourcePortRange": { + "target": "com.amazonaws.ec2#TrafficMirrorPortRange", + "traits": { + "aws.protocols#ec2QueryName": "SourcePortRange", + "smithy.api#documentation": "

The source port range assigned to the Traffic Mirror rule.

", + "smithy.api#xmlName": "sourcePortRange" + } + }, + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationCidrBlock", + "smithy.api#documentation": "

The destination CIDR block assigned to the Traffic Mirror rule.

", + "smithy.api#xmlName": "destinationCidrBlock" + } + }, + "SourceCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SourceCidrBlock", + "smithy.api#documentation": "

The source CIDR block assigned to the Traffic Mirror rule.

", + "smithy.api#xmlName": "sourceCidrBlock" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of the Traffic Mirror rule.

", + "smithy.api#xmlName": "description" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the Traffic Mirror rule.

" + } + }, + "com.amazonaws.ec2#TrafficMirrorFilterRuleField": { + "type": "enum", + "members": { + "destination_port_range": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "destination-port-range" + } + }, + "source_port_range": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "source-port-range" + } + }, + "protocol": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "protocol" + } + }, + "description": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "description" + } + } + } + }, + "com.amazonaws.ec2#TrafficMirrorFilterRuleFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterRuleField" + } + }, + "com.amazonaws.ec2#TrafficMirrorFilterRuleIdWithResolver": { + "type": "string" + }, + "com.amazonaws.ec2#TrafficMirrorFilterRuleList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterRule", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TrafficMirrorFilterSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TrafficMirrorFilter", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TrafficMirrorNetworkService": { + "type": "enum", + "members": { + "amazon_dns": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "amazon-dns" + } + } + } + }, + "com.amazonaws.ec2#TrafficMirrorNetworkServiceList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TrafficMirrorNetworkService", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TrafficMirrorPortRange": { + "type": "structure", + "members": { + "FromPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "FromPort", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.

", + "smithy.api#xmlName": "fromPort" + } + }, + "ToPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "ToPort", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.

", + "smithy.api#xmlName": "toPort" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the Traffic Mirror port range.

" + } + }, + "com.amazonaws.ec2#TrafficMirrorPortRangeRequest": { + "type": "structure", + "members": { + "FromPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The first port in the Traffic Mirror port range. This applies to the TCP and UDP protocols.

" + } + }, + "ToPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The last port in the Traffic Mirror port range. This applies to the TCP and UDP protocols.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the Traffic Mirror filter rule port range.

" + } + }, + "com.amazonaws.ec2#TrafficMirrorRuleAction": { + "type": "enum", + "members": { + "accept": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "accept" + } + }, + "reject": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "reject" + } + } + } + }, + "com.amazonaws.ec2#TrafficMirrorSession": { + "type": "structure", + "members": { + "TrafficMirrorSessionId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorSessionId", + "smithy.api#documentation": "

The ID for the Traffic Mirror session.

", + "smithy.api#xmlName": "trafficMirrorSessionId" + } + }, + "TrafficMirrorTargetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorTargetId", + "smithy.api#documentation": "

The ID of the Traffic Mirror target.

", + "smithy.api#xmlName": "trafficMirrorTargetId" + } + }, + "TrafficMirrorFilterId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorFilterId", + "smithy.api#documentation": "

The ID of the Traffic Mirror filter.

", + "smithy.api#xmlName": "trafficMirrorFilterId" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the Traffic Mirror session's network interface.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the account that owns the Traffic Mirror session.

", + "smithy.api#xmlName": "ownerId" + } + }, + "PacketLength": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "PacketLength", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#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

", + "smithy.api#xmlName": "packetLength" + } + }, + "SessionNumber": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "SessionNumber", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#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.

\n

Valid values are 1-32766.

", + "smithy.api#xmlName": "sessionNumber" + } + }, + "VirtualNetworkId": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "VirtualNetworkId", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The virtual network ID associated with the Traffic Mirror session.

", + "smithy.api#xmlName": "virtualNetworkId" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of the Traffic Mirror session.

", + "smithy.api#xmlName": "description" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the Traffic Mirror session.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Traffic Mirror session.

" + } + }, + "com.amazonaws.ec2#TrafficMirrorSessionField": { + "type": "enum", + "members": { + "packet_length": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "packet-length" + } + }, + "description": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "description" + } + }, + "virtual_network_id": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "virtual-network-id" + } + } + } + }, + "com.amazonaws.ec2#TrafficMirrorSessionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TrafficMirrorSessionField" + } + }, + "com.amazonaws.ec2#TrafficMirrorSessionId": { + "type": "string" + }, + "com.amazonaws.ec2#TrafficMirrorSessionIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TrafficMirrorSessionId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TrafficMirrorSessionSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TrafficMirrorSession", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TrafficMirrorTarget": { + "type": "structure", + "members": { + "TrafficMirrorTargetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorTargetId", + "smithy.api#documentation": "

The ID of the Traffic Mirror target.

", + "smithy.api#xmlName": "trafficMirrorTargetId" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The network interface ID that is attached to the target.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "NetworkLoadBalancerArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkLoadBalancerArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Network Load Balancer.

", + "smithy.api#xmlName": "networkLoadBalancerArn" + } + }, + "Type": { + "target": "com.amazonaws.ec2#TrafficMirrorTargetType", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The type of Traffic Mirror target.

", + "smithy.api#xmlName": "type" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

Information about the Traffic Mirror target.

", + "smithy.api#xmlName": "description" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the account that owns the Traffic Mirror target.

", + "smithy.api#xmlName": "ownerId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the Traffic Mirror target.

", + "smithy.api#xmlName": "tagSet" + } + }, + "GatewayLoadBalancerEndpointId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GatewayLoadBalancerEndpointId", + "smithy.api#documentation": "

The ID of the Gateway Load Balancer endpoint.

", + "smithy.api#xmlName": "gatewayLoadBalancerEndpointId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Traffic Mirror target.

" + } + }, + "com.amazonaws.ec2#TrafficMirrorTargetId": { + "type": "string" + }, + "com.amazonaws.ec2#TrafficMirrorTargetIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TrafficMirrorTargetId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TrafficMirrorTargetSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TrafficMirrorTarget", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TrafficMirrorTargetType": { + "type": "enum", + "members": { + "network_interface": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "network-interface" + } + }, + "network_load_balancer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "network-load-balancer" + } + }, + "gateway_load_balancer_endpoint": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "gateway-load-balancer-endpoint" + } + } + } + }, + "com.amazonaws.ec2#TrafficMirroringMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#TrafficType": { + "type": "enum", + "members": { + "ACCEPT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCEPT" + } + }, + "REJECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REJECT" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + } + } + }, + "com.amazonaws.ec2#TransitAssociationGatewayId": { + "type": "string" + }, + "com.amazonaws.ec2#TransitGateway": { + "type": "structure", + "members": { + "TransitGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayId", + "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#xmlName": "transitGatewayId" + } + }, + "TransitGatewayArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the transit gateway.

", + "smithy.api#xmlName": "transitGatewayArn" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the transit gateway.

", + "smithy.api#xmlName": "state" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the transit gateway.

", + "smithy.api#xmlName": "ownerId" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of the transit gateway.

", + "smithy.api#xmlName": "description" + } + }, + "CreationTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The creation time.

", + "smithy.api#xmlName": "creationTime" + } + }, + "Options": { + "target": "com.amazonaws.ec2#TransitGatewayOptions", + "traits": { + "aws.protocols#ec2QueryName": "Options", + "smithy.api#documentation": "

The transit gateway options.

", + "smithy.api#xmlName": "options" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for the transit gateway.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a transit gateway.

" + } + }, + "com.amazonaws.ec2#TransitGatewayAssociation": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableId", + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#xmlName": "transitGatewayRouteTableId" + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#xmlName": "transitGatewayAttachmentId" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource.

", + "smithy.api#xmlName": "resourceId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The resource type. Note that the tgw-peering resource type has been deprecated.

", + "smithy.api#xmlName": "resourceType" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayAssociationState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the association.

", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an association between a resource attachment and a transit gateway route table.

" + } + }, + "com.amazonaws.ec2#TransitGatewayAssociationState": { + "type": "enum", + "members": { + "associating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associating" + } + }, + "associated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associated" + } + }, + "disassociating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociating" + } + }, + "disassociated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociated" + } + } + } + }, + "com.amazonaws.ec2#TransitGatewayAttachment": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#xmlName": "transitGatewayAttachmentId" + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayId", + "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#xmlName": "transitGatewayId" + } + }, + "TransitGatewayOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayOwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the transit gateway.

", + "smithy.api#xmlName": "transitGatewayOwnerId" + } + }, + "ResourceOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceOwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the resource.

", + "smithy.api#xmlName": "resourceOwnerId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The resource type. Note that the tgw-peering resource type has been deprecated.

", + "smithy.api#xmlName": "resourceType" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource.

", + "smithy.api#xmlName": "resourceId" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The attachment state. Note that the initiating state has been deprecated.

", + "smithy.api#xmlName": "state" + } + }, + "Association": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentAssociation", + "traits": { + "aws.protocols#ec2QueryName": "Association", + "smithy.api#documentation": "

The association.

", + "smithy.api#xmlName": "association" + } + }, + "CreationTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The creation time.

", + "smithy.api#xmlName": "creationTime" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for the attachment.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an attachment between a resource and a transit gateway.

" + } + }, + "com.amazonaws.ec2#TransitGatewayAttachmentAssociation": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableId", + "smithy.api#documentation": "

The ID of the route table for the transit gateway.

", + "smithy.api#xmlName": "transitGatewayRouteTableId" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayAssociationState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the association.

", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an association.

" + } + }, + "com.amazonaws.ec2#TransitGatewayAttachmentBgpConfiguration": { + "type": "structure", + "members": { + "TransitGatewayAsn": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAsn", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The transit gateway Autonomous System Number (ASN).

", + "smithy.api#xmlName": "transitGatewayAsn" + } + }, + "PeerAsn": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "PeerAsn", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The peer Autonomous System Number (ASN).

", + "smithy.api#xmlName": "peerAsn" + } + }, + "TransitGatewayAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAddress", + "smithy.api#documentation": "

The interior BGP peer IP address for the transit gateway.

", + "smithy.api#xmlName": "transitGatewayAddress" + } + }, + "PeerAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PeerAddress", + "smithy.api#documentation": "

The interior BGP peer IP address for the appliance.

", + "smithy.api#xmlName": "peerAddress" + } + }, + "BgpStatus": { + "target": "com.amazonaws.ec2#BgpStatus", + "traits": { + "aws.protocols#ec2QueryName": "BgpStatus", + "smithy.api#documentation": "

The BGP status.

", + "smithy.api#xmlName": "bgpStatus" + } + } + }, + "traits": { + "smithy.api#documentation": "

The BGP configuration information.

" + } + }, + "com.amazonaws.ec2#TransitGatewayAttachmentBgpConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentBgpConfiguration", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayAttachmentId": { + "type": "string" + }, + "com.amazonaws.ec2#TransitGatewayAttachmentIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId" + } + }, + "com.amazonaws.ec2#TransitGatewayAttachmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayAttachment", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayAttachmentPropagation": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableId", + "smithy.api#documentation": "

The ID of the propagation route table.

", + "smithy.api#xmlName": "transitGatewayRouteTableId" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayPropagationState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the propagation route table.

", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a propagation route table.

" + } + }, + "com.amazonaws.ec2#TransitGatewayAttachmentPropagationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentPropagation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayAttachmentResourceType": { + "type": "enum", + "members": { + "vpc": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc" + } + }, + "vpn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpn" + } + }, + "direct_connect_gateway": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "direct-connect-gateway" + } + }, + "connect": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "connect" + } + }, + "peering": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "peering" + } + }, + "tgw_peering": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tgw-peering" + } + } + } + }, + "com.amazonaws.ec2#TransitGatewayAttachmentState": { + "type": "enum", + "members": { + "initiating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "initiating" + } + }, + "initiatingRequest": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "initiatingRequest" + } + }, + "pendingAcceptance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pendingAcceptance" + } + }, + "rollingBack": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rollingBack" + } + }, + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "modifying": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modifying" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "rejected": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rejected" + } + }, + "rejecting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rejecting" + } + }, + "failing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failing" + } + } + } + }, + "com.amazonaws.ec2#TransitGatewayCidrBlockStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayConnect": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the Connect attachment.

", + "smithy.api#xmlName": "transitGatewayAttachmentId" + } + }, + "TransportTransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "aws.protocols#ec2QueryName": "TransportTransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the attachment from which the Connect attachment was created.

", + "smithy.api#xmlName": "transportTransitGatewayAttachmentId" + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayId", + "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#xmlName": "transitGatewayId" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the attachment.

", + "smithy.api#xmlName": "state" + } + }, + "CreationTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The creation time.

", + "smithy.api#xmlName": "creationTime" + } + }, + "Options": { + "target": "com.amazonaws.ec2#TransitGatewayConnectOptions", + "traits": { + "aws.protocols#ec2QueryName": "Options", + "smithy.api#documentation": "

The Connect attachment options.

", + "smithy.api#xmlName": "options" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for the attachment.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a transit gateway Connect attachment.

" + } + }, + "com.amazonaws.ec2#TransitGatewayConnectList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayConnect", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayConnectOptions": { + "type": "structure", + "members": { + "Protocol": { + "target": "com.amazonaws.ec2#ProtocolValue", + "traits": { + "aws.protocols#ec2QueryName": "Protocol", + "smithy.api#documentation": "

The tunnel protocol.

", + "smithy.api#xmlName": "protocol" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the Connect attachment options.

" + } + }, + "com.amazonaws.ec2#TransitGatewayConnectPeer": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the Connect attachment.

", + "smithy.api#xmlName": "transitGatewayAttachmentId" + } + }, + "TransitGatewayConnectPeerId": { + "target": "com.amazonaws.ec2#TransitGatewayConnectPeerId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayConnectPeerId", + "smithy.api#documentation": "

The ID of the Connect peer.

", + "smithy.api#xmlName": "transitGatewayConnectPeerId" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayConnectPeerState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the Connect peer.

", + "smithy.api#xmlName": "state" + } + }, + "CreationTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The creation time.

", + "smithy.api#xmlName": "creationTime" + } + }, + "ConnectPeerConfiguration": { + "target": "com.amazonaws.ec2#TransitGatewayConnectPeerConfiguration", + "traits": { + "aws.protocols#ec2QueryName": "ConnectPeerConfiguration", + "smithy.api#documentation": "

The Connect peer details.

", + "smithy.api#xmlName": "connectPeerConfiguration" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for the Connect peer.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a transit gateway Connect peer.

" + } + }, + "com.amazonaws.ec2#TransitGatewayConnectPeerConfiguration": { + "type": "structure", + "members": { + "TransitGatewayAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAddress", + "smithy.api#documentation": "

The Connect peer IP address on the transit gateway side of the tunnel.

", + "smithy.api#xmlName": "transitGatewayAddress" + } + }, + "PeerAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PeerAddress", + "smithy.api#documentation": "

The Connect peer IP address on the appliance side of the tunnel.

", + "smithy.api#xmlName": "peerAddress" + } + }, + "InsideCidrBlocks": { + "target": "com.amazonaws.ec2#InsideCidrBlocksStringList", + "traits": { + "aws.protocols#ec2QueryName": "InsideCidrBlocks", + "smithy.api#documentation": "

The range of interior BGP peer IP addresses.

", + "smithy.api#xmlName": "insideCidrBlocks" + } + }, + "Protocol": { + "target": "com.amazonaws.ec2#ProtocolValue", + "traits": { + "aws.protocols#ec2QueryName": "Protocol", + "smithy.api#documentation": "

The tunnel protocol.

", + "smithy.api#xmlName": "protocol" + } + }, + "BgpConfigurations": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentBgpConfigurationList", + "traits": { + "aws.protocols#ec2QueryName": "BgpConfigurations", + "smithy.api#documentation": "

The BGP configuration details.

", + "smithy.api#xmlName": "bgpConfigurations" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the Connect peer details.

" + } + }, + "com.amazonaws.ec2#TransitGatewayConnectPeerId": { + "type": "string" + }, + "com.amazonaws.ec2#TransitGatewayConnectPeerIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayConnectPeerId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayConnectPeerList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayConnectPeer", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayConnectPeerState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + } + } + }, + "com.amazonaws.ec2#TransitGatewayConnectRequestBgpOptions": { + "type": "structure", + "members": { + "PeerAsn": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The peer Autonomous System Number (ASN).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The BGP options for the Connect attachment.

" + } + }, + "com.amazonaws.ec2#TransitGatewayId": { + "type": "string" + }, + "com.amazonaws.ec2#TransitGatewayIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGateway", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#TransitGatewayMulitcastDomainAssociationState": { + "type": "enum", + "members": { + "pendingAcceptance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pendingAcceptance" + } + }, + "associating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associating" + } + }, + "associated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associated" + } + }, + "disassociating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociating" + } + }, + "disassociated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociated" + } + }, + "rejected": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rejected" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + } + } + }, + "com.amazonaws.ec2#TransitGatewayMulticastDeregisteredGroupMembers": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayMulticastDomainId", + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", + "smithy.api#xmlName": "transitGatewayMulticastDomainId" + } + }, + "DeregisteredNetworkInterfaceIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "DeregisteredNetworkInterfaceIds", + "smithy.api#documentation": "

The network interface IDs of the deregistered members.

", + "smithy.api#xmlName": "deregisteredNetworkInterfaceIds" + } + }, + "GroupIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupIpAddress", + "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

", + "smithy.api#xmlName": "groupIpAddress" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the deregistered transit gateway multicast group members.

" + } + }, + "com.amazonaws.ec2#TransitGatewayMulticastDeregisteredGroupSources": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayMulticastDomainId", + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", + "smithy.api#xmlName": "transitGatewayMulticastDomainId" + } + }, + "DeregisteredNetworkInterfaceIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "DeregisteredNetworkInterfaceIds", + "smithy.api#documentation": "

The network interface IDs of the non-registered members.

", + "smithy.api#xmlName": "deregisteredNetworkInterfaceIds" + } + }, + "GroupIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupIpAddress", + "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

", + "smithy.api#xmlName": "groupIpAddress" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the deregistered transit gateway multicast group sources.

" + } + }, + "com.amazonaws.ec2#TransitGatewayMulticastDomain": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayMulticastDomainId", + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", + "smithy.api#xmlName": "transitGatewayMulticastDomainId" + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayId", + "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#xmlName": "transitGatewayId" + } + }, + "TransitGatewayMulticastDomainArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayMulticastDomainArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the transit gateway multicast domain.

", + "smithy.api#xmlName": "transitGatewayMulticastDomainArn" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the transit gateway multicast domain.

", + "smithy.api#xmlName": "ownerId" + } + }, + "Options": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainOptions", + "traits": { + "aws.protocols#ec2QueryName": "Options", + "smithy.api#documentation": "

The options for the transit gateway multicast domain.

", + "smithy.api#xmlName": "options" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the transit gateway multicast domain.

", + "smithy.api#xmlName": "state" + } + }, + "CreationTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The time the transit gateway multicast domain was created.

", + "smithy.api#xmlName": "creationTime" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for the transit gateway multicast domain.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the transit gateway multicast domain.

" + } + }, + "com.amazonaws.ec2#TransitGatewayMulticastDomainAssociation": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the transit gateway attachment.

", + "smithy.api#xmlName": "transitGatewayAttachmentId" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource.

", + "smithy.api#xmlName": "resourceId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The type of resource, for example a VPC attachment.

", + "smithy.api#xmlName": "resourceType" + } + }, + "ResourceOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceOwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the transit gateway multicast domain association resource.

", + "smithy.api#xmlName": "resourceOwnerId" + } + }, + "Subnet": { + "target": "com.amazonaws.ec2#SubnetAssociation", + "traits": { + "aws.protocols#ec2QueryName": "Subnet", + "smithy.api#documentation": "

The subnet associated with the transit gateway multicast domain.

", + "smithy.api#xmlName": "subnet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the resources associated with the transit gateway multicast domain.

" + } + }, + "com.amazonaws.ec2#TransitGatewayMulticastDomainAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayMulticastDomainAssociations": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayMulticastDomainId", + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", + "smithy.api#xmlName": "transitGatewayMulticastDomainId" + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the transit gateway attachment.

", + "smithy.api#xmlName": "transitGatewayAttachmentId" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource.

", + "smithy.api#xmlName": "resourceId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The type of resource, for example a VPC attachment.

", + "smithy.api#xmlName": "resourceType" + } + }, + "ResourceOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceOwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the resource.

", + "smithy.api#xmlName": "resourceOwnerId" + } + }, + "Subnets": { + "target": "com.amazonaws.ec2#SubnetAssociationList", + "traits": { + "aws.protocols#ec2QueryName": "Subnets", + "smithy.api#documentation": "

The subnets associated with the multicast domain.

", + "smithy.api#xmlName": "subnets" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the multicast domain associations.

" + } + }, + "com.amazonaws.ec2#TransitGatewayMulticastDomainId": { + "type": "string" + }, + "com.amazonaws.ec2#TransitGatewayMulticastDomainIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayMulticastDomainList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomain", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayMulticastDomainOptions": { + "type": "structure", + "members": { + "Igmpv2Support": { + "target": "com.amazonaws.ec2#Igmpv2SupportValue", + "traits": { + "aws.protocols#ec2QueryName": "Igmpv2Support", + "smithy.api#documentation": "

Indicates whether Internet Group Management Protocol (IGMP) version 2 is turned on for the transit gateway multicast domain.

", + "smithy.api#xmlName": "igmpv2Support" + } + }, + "StaticSourcesSupport": { + "target": "com.amazonaws.ec2#StaticSourcesSupportValue", + "traits": { + "aws.protocols#ec2QueryName": "StaticSourcesSupport", + "smithy.api#documentation": "

Indicates whether support for statically configuring transit gateway multicast group sources is turned on.

", + "smithy.api#xmlName": "staticSourcesSupport" + } + }, + "AutoAcceptSharedAssociations": { + "target": "com.amazonaws.ec2#AutoAcceptSharedAssociationsValue", + "traits": { + "aws.protocols#ec2QueryName": "AutoAcceptSharedAssociations", + "smithy.api#documentation": "

Indicates whether to automatically cross-account subnet associations that are associated with the transit gateway multicast domain.

", + "smithy.api#xmlName": "autoAcceptSharedAssociations" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the options for a transit gateway multicast domain.

" + } + }, + "com.amazonaws.ec2#TransitGatewayMulticastDomainState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + } + } + }, + "com.amazonaws.ec2#TransitGatewayMulticastGroup": { + "type": "structure", + "members": { + "GroupIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupIpAddress", + "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

", + "smithy.api#xmlName": "groupIpAddress" + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the transit gateway attachment.

", + "smithy.api#xmlName": "transitGatewayAttachmentId" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet.

", + "smithy.api#xmlName": "subnetId" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource.

", + "smithy.api#xmlName": "resourceId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The type of resource, for example a VPC attachment.

", + "smithy.api#xmlName": "resourceType" + } + }, + "ResourceOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceOwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the transit gateway multicast domain group resource.

", + "smithy.api#xmlName": "resourceOwnerId" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the transit gateway attachment.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "GroupMember": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "GroupMember", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates that the resource is a transit gateway multicast group member.

", + "smithy.api#xmlName": "groupMember" + } + }, + "GroupSource": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "GroupSource", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates that the resource is a transit gateway multicast group member.

", + "smithy.api#xmlName": "groupSource" + } + }, + "MemberType": { + "target": "com.amazonaws.ec2#MembershipType", + "traits": { + "aws.protocols#ec2QueryName": "MemberType", + "smithy.api#documentation": "

The member type (for example, static).

", + "smithy.api#xmlName": "memberType" + } + }, + "SourceType": { + "target": "com.amazonaws.ec2#MembershipType", + "traits": { + "aws.protocols#ec2QueryName": "SourceType", + "smithy.api#documentation": "

The source type.

", + "smithy.api#xmlName": "sourceType" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the transit gateway multicast group resources.

" + } + }, + "com.amazonaws.ec2#TransitGatewayMulticastGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastGroup", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayMulticastRegisteredGroupMembers": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayMulticastDomainId", + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", + "smithy.api#xmlName": "transitGatewayMulticastDomainId" + } + }, + "RegisteredNetworkInterfaceIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "RegisteredNetworkInterfaceIds", + "smithy.api#documentation": "

The ID of the registered network interfaces.

", + "smithy.api#xmlName": "registeredNetworkInterfaceIds" + } + }, + "GroupIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupIpAddress", + "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

", + "smithy.api#xmlName": "groupIpAddress" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the registered transit gateway multicast group members.

" + } + }, + "com.amazonaws.ec2#TransitGatewayMulticastRegisteredGroupSources": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayMulticastDomainId", + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", + "smithy.api#xmlName": "transitGatewayMulticastDomainId" + } + }, + "RegisteredNetworkInterfaceIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "RegisteredNetworkInterfaceIds", + "smithy.api#documentation": "

The IDs of the network interfaces members registered with the transit gateway multicast group.

", + "smithy.api#xmlName": "registeredNetworkInterfaceIds" + } + }, + "GroupIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupIpAddress", + "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

", + "smithy.api#xmlName": "groupIpAddress" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the members registered with the transit gateway multicast group.

" + } + }, + "com.amazonaws.ec2#TransitGatewayNetworkInterfaceIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayOptions": { + "type": "structure", + "members": { + "AmazonSideAsn": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "AmazonSideAsn", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

A private Autonomous System Number (ASN) for the Amazon side of a BGP session. \n The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.

", + "smithy.api#xmlName": "amazonSideAsn" + } + }, + "TransitGatewayCidrBlocks": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayCidrBlocks", + "smithy.api#documentation": "

The transit gateway CIDR blocks.

", + "smithy.api#xmlName": "transitGatewayCidrBlocks" + } + }, + "AutoAcceptSharedAttachments": { + "target": "com.amazonaws.ec2#AutoAcceptSharedAttachmentsValue", + "traits": { + "aws.protocols#ec2QueryName": "AutoAcceptSharedAttachments", + "smithy.api#documentation": "

Indicates whether attachment requests are automatically accepted.

", + "smithy.api#xmlName": "autoAcceptSharedAttachments" + } + }, + "DefaultRouteTableAssociation": { + "target": "com.amazonaws.ec2#DefaultRouteTableAssociationValue", + "traits": { + "aws.protocols#ec2QueryName": "DefaultRouteTableAssociation", + "smithy.api#documentation": "

Indicates whether resource attachments are automatically associated with the default association route table.

", + "smithy.api#xmlName": "defaultRouteTableAssociation" + } + }, + "AssociationDefaultRouteTableId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AssociationDefaultRouteTableId", + "smithy.api#documentation": "

The ID of the default association route table.

", + "smithy.api#xmlName": "associationDefaultRouteTableId" + } + }, + "DefaultRouteTablePropagation": { + "target": "com.amazonaws.ec2#DefaultRouteTablePropagationValue", + "traits": { + "aws.protocols#ec2QueryName": "DefaultRouteTablePropagation", + "smithy.api#documentation": "

Indicates whether resource attachments automatically propagate routes to the default propagation route table.

", + "smithy.api#xmlName": "defaultRouteTablePropagation" + } + }, + "PropagationDefaultRouteTableId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PropagationDefaultRouteTableId", + "smithy.api#documentation": "

The ID of the default propagation route table.

", + "smithy.api#xmlName": "propagationDefaultRouteTableId" + } + }, + "VpnEcmpSupport": { + "target": "com.amazonaws.ec2#VpnEcmpSupportValue", + "traits": { + "aws.protocols#ec2QueryName": "VpnEcmpSupport", + "smithy.api#documentation": "

Indicates whether Equal Cost Multipath Protocol support is enabled.

", + "smithy.api#xmlName": "vpnEcmpSupport" + } + }, + "DnsSupport": { + "target": "com.amazonaws.ec2#DnsSupportValue", + "traits": { + "aws.protocols#ec2QueryName": "DnsSupport", + "smithy.api#documentation": "

Indicates whether DNS support is enabled.

", + "smithy.api#xmlName": "dnsSupport" + } + }, + "MulticastSupport": { + "target": "com.amazonaws.ec2#MulticastSupportValue", + "traits": { + "aws.protocols#ec2QueryName": "MulticastSupport", + "smithy.api#documentation": "

Indicates whether multicast is enabled on the transit gateway

", + "smithy.api#xmlName": "multicastSupport" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the options for a transit gateway.

" + } + }, + "com.amazonaws.ec2#TransitGatewayPeeringAttachment": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the transit gateway peering attachment.

", + "smithy.api#xmlName": "transitGatewayAttachmentId" + } + }, + "AccepterTransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AccepterTransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the accepter transit gateway attachment.

", + "smithy.api#xmlName": "accepterTransitGatewayAttachmentId" + } + }, + "RequesterTgwInfo": { + "target": "com.amazonaws.ec2#PeeringTgwInfo", + "traits": { + "aws.protocols#ec2QueryName": "RequesterTgwInfo", + "smithy.api#documentation": "

Information about the requester transit gateway.

", + "smithy.api#xmlName": "requesterTgwInfo" + } + }, + "AccepterTgwInfo": { + "target": "com.amazonaws.ec2#PeeringTgwInfo", + "traits": { + "aws.protocols#ec2QueryName": "AccepterTgwInfo", + "smithy.api#documentation": "

Information about the accepter transit gateway.

", + "smithy.api#xmlName": "accepterTgwInfo" + } + }, + "Options": { + "target": "com.amazonaws.ec2#TransitGatewayPeeringAttachmentOptions", + "traits": { + "aws.protocols#ec2QueryName": "Options", + "smithy.api#documentation": "

Details about the transit gateway peering attachment.

", + "smithy.api#xmlName": "options" + } + }, + "Status": { + "target": "com.amazonaws.ec2#PeeringAttachmentStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status of the transit gateway peering attachment.

", + "smithy.api#xmlName": "status" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the transit gateway peering attachment. Note that the initiating state has been deprecated.

", + "smithy.api#xmlName": "state" + } + }, + "CreationTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The time the transit gateway peering attachment was created.

", + "smithy.api#xmlName": "creationTime" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for the transit gateway peering attachment.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the transit gateway peering attachment.

" + } + }, + "com.amazonaws.ec2#TransitGatewayPeeringAttachmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayPeeringAttachment", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayPeeringAttachmentOptions": { + "type": "structure", + "members": { + "DynamicRouting": { + "target": "com.amazonaws.ec2#DynamicRoutingValue", + "traits": { + "aws.protocols#ec2QueryName": "DynamicRouting", + "smithy.api#documentation": "

Describes whether dynamic routing is enabled or disabled for the transit gateway peering attachment.

", + "smithy.api#xmlName": "dynamicRouting" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes dynamic routing for the transit gateway peering attachment.

" + } + }, + "com.amazonaws.ec2#TransitGatewayPolicyRule": { + "type": "structure", + "members": { + "SourceCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SourceCidrBlock", + "smithy.api#documentation": "

The source CIDR block for the transit gateway policy rule.

", + "smithy.api#xmlName": "sourceCidrBlock" + } + }, + "SourcePortRange": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SourcePortRange", + "smithy.api#documentation": "

The port range for the transit gateway policy rule. Currently this is set to * (all).

", + "smithy.api#xmlName": "sourcePortRange" + } + }, + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationCidrBlock", + "smithy.api#documentation": "

The destination CIDR block for the transit gateway policy rule.

", + "smithy.api#xmlName": "destinationCidrBlock" + } + }, + "DestinationPortRange": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationPortRange", + "smithy.api#documentation": "

The port range for the transit gateway policy rule. Currently this is set to * (all).

", + "smithy.api#xmlName": "destinationPortRange" + } + }, + "Protocol": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Protocol", + "smithy.api#documentation": "

The protocol used by the transit gateway policy rule.

", + "smithy.api#xmlName": "protocol" + } + }, + "MetaData": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyRuleMetaData", + "traits": { + "aws.protocols#ec2QueryName": "MetaData", + "smithy.api#documentation": "

The meta data tags used for the transit gateway policy rule.

", + "smithy.api#xmlName": "metaData" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a rule associated with a transit gateway policy.

" + } + }, + "com.amazonaws.ec2#TransitGatewayPolicyRuleMetaData": { + "type": "structure", + "members": { + "MetaDataKey": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "MetaDataKey", + "smithy.api#documentation": "

The key name for the transit gateway policy rule meta data tag.

", + "smithy.api#xmlName": "metaDataKey" + } + }, + "MetaDataValue": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "MetaDataValue", + "smithy.api#documentation": "

The value of the key for the transit gateway policy rule meta data tag.

", + "smithy.api#xmlName": "metaDataValue" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the meta data tags associated with a transit gateway policy rule.

" + } + }, + "com.amazonaws.ec2#TransitGatewayPolicyTable": { + "type": "structure", + "members": { + "TransitGatewayPolicyTableId": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayPolicyTableId", + "smithy.api#documentation": "

The ID of the transit gateway policy table.

", + "smithy.api#xmlName": "transitGatewayPolicyTableId" + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayId", + "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#xmlName": "transitGatewayId" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the transit gateway policy table

", + "smithy.api#xmlName": "state" + } + }, + "CreationTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The timestamp when the transit gateway policy table was created.

", + "smithy.api#xmlName": "creationTime" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

he key-value pairs associated with the transit gateway policy table.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a transit gateway policy table.

" + } + }, + "com.amazonaws.ec2#TransitGatewayPolicyTableAssociation": { + "type": "structure", + "members": { + "TransitGatewayPolicyTableId": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayPolicyTableId", + "smithy.api#documentation": "

The ID of the transit gateway policy table.

", + "smithy.api#xmlName": "transitGatewayPolicyTableId" + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the transit gateway attachment.

", + "smithy.api#xmlName": "transitGatewayAttachmentId" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The resource ID of the transit gateway attachment.

", + "smithy.api#xmlName": "resourceId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The resource type for the transit gateway policy table association.

", + "smithy.api#xmlName": "resourceType" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayAssociationState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the transit gateway policy table association.

", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a transit gateway policy table association.

" + } + }, + "com.amazonaws.ec2#TransitGatewayPolicyTableAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayPolicyTableEntry": { + "type": "structure", + "members": { + "PolicyRuleNumber": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PolicyRuleNumber", + "smithy.api#documentation": "

The rule number for the transit gateway policy table entry.

", + "smithy.api#xmlName": "policyRuleNumber" + } + }, + "PolicyRule": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyRule", + "traits": { + "aws.protocols#ec2QueryName": "PolicyRule", + "smithy.api#documentation": "

The policy rule associated with the transit gateway policy table.

", + "smithy.api#xmlName": "policyRule" + } + }, + "TargetRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "aws.protocols#ec2QueryName": "TargetRouteTableId", + "smithy.api#documentation": "

The ID of the target route table.

", + "smithy.api#xmlName": "targetRouteTableId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a transit gateway policy table entry

" + } + }, + "com.amazonaws.ec2#TransitGatewayPolicyTableEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableEntry", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayPolicyTableId": { + "type": "string" + }, + "com.amazonaws.ec2#TransitGatewayPolicyTableIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayPolicyTableList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTable", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayPolicyTableState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + } + } + }, + "com.amazonaws.ec2#TransitGatewayPrefixListAttachment": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#xmlName": "transitGatewayAttachmentId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The resource type. Note that the tgw-peering resource type has been deprecated.

", + "smithy.api#xmlName": "resourceType" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource.

", + "smithy.api#xmlName": "resourceId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a transit gateway prefix list attachment.

" + } + }, + "com.amazonaws.ec2#TransitGatewayPrefixListReference": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableId", + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#xmlName": "transitGatewayRouteTableId" + } + }, + "PrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListId", + "smithy.api#documentation": "

The ID of the prefix list.

", + "smithy.api#xmlName": "prefixListId" + } + }, + "PrefixListOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListOwnerId", + "smithy.api#documentation": "

The ID of the prefix list owner.

", + "smithy.api#xmlName": "prefixListOwnerId" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayPrefixListReferenceState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the prefix list reference.

", + "smithy.api#xmlName": "state" + } + }, + "Blackhole": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Blackhole", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether traffic that matches this route is dropped.

", + "smithy.api#xmlName": "blackhole" + } + }, + "TransitGatewayAttachment": { + "target": "com.amazonaws.ec2#TransitGatewayPrefixListAttachment", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachment", + "smithy.api#documentation": "

Information about the transit gateway attachment.

", + "smithy.api#xmlName": "transitGatewayAttachment" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a prefix list reference.

" + } + }, + "com.amazonaws.ec2#TransitGatewayPrefixListReferenceSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayPrefixListReference", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayPrefixListReferenceState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "modifying": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modifying" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + } + } + }, + "com.amazonaws.ec2#TransitGatewayPropagation": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#xmlName": "transitGatewayAttachmentId" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource.

", + "smithy.api#xmlName": "resourceId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The resource type. Note that the tgw-peering resource type has been deprecated.

", + "smithy.api#xmlName": "resourceType" + } + }, + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableId", + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#xmlName": "transitGatewayRouteTableId" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayPropagationState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state.

", + "smithy.api#xmlName": "state" + } + }, + "TransitGatewayRouteTableAnnouncementId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableAnnouncementId", + "smithy.api#documentation": "

The ID of the transit gateway route table announcement.

", + "smithy.api#xmlName": "transitGatewayRouteTableAnnouncementId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes route propagation.

" + } + }, + "com.amazonaws.ec2#TransitGatewayPropagationState": { + "type": "enum", + "members": { + "enabling": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabling" + } + }, + "enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + }, + "disabling": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabling" + } + }, + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + } + } + }, + "com.amazonaws.ec2#TransitGatewayRequestOptions": { + "type": "structure", + "members": { + "AmazonSideAsn": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

A private Autonomous System Number (ASN) for the Amazon side of a BGP session. \n The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. The default is 64512.

" + } + }, + "AutoAcceptSharedAttachments": { + "target": "com.amazonaws.ec2#AutoAcceptSharedAttachmentsValue", + "traits": { + "smithy.api#documentation": "

Enable or disable automatic acceptance of attachment requests. Disabled by default.

" + } + }, + "DefaultRouteTableAssociation": { + "target": "com.amazonaws.ec2#DefaultRouteTableAssociationValue", + "traits": { + "smithy.api#documentation": "

Enable or disable automatic association with the default association route table. Enabled by default.

" + } + }, + "DefaultRouteTablePropagation": { + "target": "com.amazonaws.ec2#DefaultRouteTablePropagationValue", + "traits": { + "smithy.api#documentation": "

Enable or disable automatic propagation of routes to the default propagation route table. Enabled by default.

" + } + }, + "VpnEcmpSupport": { + "target": "com.amazonaws.ec2#VpnEcmpSupportValue", + "traits": { + "smithy.api#documentation": "

Enable or disable Equal Cost Multipath Protocol support. Enabled by default.

" + } + }, + "DnsSupport": { + "target": "com.amazonaws.ec2#DnsSupportValue", + "traits": { + "smithy.api#documentation": "

Enable or disable DNS support. Enabled by default.

" + } + }, + "MulticastSupport": { + "target": "com.amazonaws.ec2#MulticastSupportValue", + "traits": { + "smithy.api#documentation": "

Indicates whether multicast is enabled on the transit gateway

" + } + }, + "TransitGatewayCidrBlocks": { + "target": "com.amazonaws.ec2#TransitGatewayCidrBlockStringList", + "traits": { + "smithy.api#documentation": "

One or more IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the options for a transit gateway.

" + } + }, + "com.amazonaws.ec2#TransitGatewayRoute": { + "type": "structure", + "members": { + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationCidrBlock", + "smithy.api#documentation": "

The CIDR block used for destination matches.

", + "smithy.api#xmlName": "destinationCidrBlock" + } + }, + "PrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListId", + "smithy.api#documentation": "

The ID of the prefix list used for destination matches.

", + "smithy.api#xmlName": "prefixListId" + } + }, + "TransitGatewayRouteTableAnnouncementId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableAnnouncementId", + "smithy.api#documentation": "

The ID of the transit gateway route table announcement.

", + "smithy.api#xmlName": "transitGatewayRouteTableAnnouncementId" + } + }, + "TransitGatewayAttachments": { + "target": "com.amazonaws.ec2#TransitGatewayRouteAttachmentList", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachments", + "smithy.api#documentation": "

The attachments.

", + "smithy.api#xmlName": "transitGatewayAttachments" + } + }, + "Type": { + "target": "com.amazonaws.ec2#TransitGatewayRouteType", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The route type.

", + "smithy.api#xmlName": "type" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayRouteState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the route.

", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a route for a transit gateway route table.

" + } + }, + "com.amazonaws.ec2#TransitGatewayRouteAttachment": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource.

", + "smithy.api#xmlName": "resourceId" + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#xmlName": "transitGatewayAttachmentId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The resource type. Note that the tgw-peering resource type has been deprecated.

", + "smithy.api#xmlName": "resourceType" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a route attachment.

" + } + }, + "com.amazonaws.ec2#TransitGatewayRouteAttachmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayRouteAttachment", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayRouteList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayRoute", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayRouteState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "blackhole": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "blackhole" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + } + } + }, + "com.amazonaws.ec2#TransitGatewayRouteTable": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableId", + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#xmlName": "transitGatewayRouteTableId" + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayId", + "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#xmlName": "transitGatewayId" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the transit gateway route table.

", + "smithy.api#xmlName": "state" + } + }, + "DefaultAssociationRouteTable": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DefaultAssociationRouteTable", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether this is the default association route table for the transit gateway.

", + "smithy.api#xmlName": "defaultAssociationRouteTable" + } + }, + "DefaultPropagationRouteTable": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DefaultPropagationRouteTable", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether this is the default propagation route table for the transit gateway.

", + "smithy.api#xmlName": "defaultPropagationRouteTable" + } + }, + "CreationTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The creation time.

", + "smithy.api#xmlName": "creationTime" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the route table.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a transit gateway route table.

" + } + }, + "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncement": { + "type": "structure", + "members": { + "TransitGatewayRouteTableAnnouncementId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableAnnouncementId", + "smithy.api#documentation": "

The ID of the transit gateway route table announcement.

", + "smithy.api#xmlName": "transitGatewayRouteTableAnnouncementId" + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayId", + "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#xmlName": "transitGatewayId" + } + }, + "CoreNetworkId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CoreNetworkId", + "smithy.api#documentation": "

The ID of the core network for the transit gateway route table announcement.

", + "smithy.api#xmlName": "coreNetworkId" + } + }, + "PeerTransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "PeerTransitGatewayId", + "smithy.api#documentation": "

The ID of the peer transit gateway.

", + "smithy.api#xmlName": "peerTransitGatewayId" + } + }, + "PeerCoreNetworkId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PeerCoreNetworkId", + "smithy.api#documentation": "

The ID of the core network ID for the peer.

", + "smithy.api#xmlName": "peerCoreNetworkId" + } + }, + "PeeringAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "aws.protocols#ec2QueryName": "PeeringAttachmentId", + "smithy.api#documentation": "

The ID of the peering attachment.

", + "smithy.api#xmlName": "peeringAttachmentId" + } + }, + "AnnouncementDirection": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementDirection", + "traits": { + "aws.protocols#ec2QueryName": "AnnouncementDirection", + "smithy.api#documentation": "

The direction for the route table announcement.

", + "smithy.api#xmlName": "announcementDirection" + } + }, + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableId", + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#xmlName": "transitGatewayRouteTableId" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the transit gateway announcement.

", + "smithy.api#xmlName": "state" + } + }, + "CreationTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The timestamp when the transit gateway route table announcement was created.

", + "smithy.api#xmlName": "creationTime" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The key-value pairs associated with the route table announcement.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a transit gateway route table announcement.

" + } + }, + "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementDirection": { + "type": "enum", + "members": { + "outgoing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "outgoing" + } + }, + "incoming": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "incoming" + } + } + } + }, + "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementId": { + "type": "string" + }, + "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncement", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementState": { + "type": "enum", + "members": { + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "failing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failing" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + } + } + }, + "com.amazonaws.ec2#TransitGatewayRouteTableAssociation": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#xmlName": "transitGatewayAttachmentId" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource.

", + "smithy.api#xmlName": "resourceId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The resource type. Note that the tgw-peering resource type has been deprecated.

", + "smithy.api#xmlName": "resourceType" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayAssociationState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the association.

", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an association between a route table and a resource attachment.

" + } + }, + "com.amazonaws.ec2#TransitGatewayRouteTableAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayRouteTableId": { + "type": "string" + }, + "com.amazonaws.ec2#TransitGatewayRouteTableIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayRouteTableList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTable", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayRouteTablePropagation": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#xmlName": "transitGatewayAttachmentId" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource.

", + "smithy.api#xmlName": "resourceId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The type of resource. Note that the tgw-peering resource type has been deprecated.

", + "smithy.api#xmlName": "resourceType" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayPropagationState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the resource.

", + "smithy.api#xmlName": "state" + } + }, + "TransitGatewayRouteTableAnnouncementId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableAnnouncementId", + "smithy.api#documentation": "

The ID of the transit gateway route table announcement.

", + "smithy.api#xmlName": "transitGatewayRouteTableAnnouncementId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a route table propagation.

" + } + }, + "com.amazonaws.ec2#TransitGatewayRouteTablePropagationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTablePropagation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayRouteTableRoute": { + "type": "structure", + "members": { + "DestinationCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationCidr", + "smithy.api#documentation": "

The CIDR block used for destination matches.

", + "smithy.api#xmlName": "destinationCidr" + } + }, + "State": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the route.

", + "smithy.api#xmlName": "state" + } + }, + "RouteOrigin": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RouteOrigin", + "smithy.api#documentation": "

The route origin. The following are the possible values:

\n ", + "smithy.api#xmlName": "routeOrigin" + } + }, + "PrefixListId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListId", + "smithy.api#documentation": "

The ID of the prefix list.

", + "smithy.api#xmlName": "prefixListId" + } + }, + "AttachmentId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AttachmentId", + "smithy.api#documentation": "

The ID of the route attachment.

", + "smithy.api#xmlName": "attachmentId" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource for the route attachment.

", + "smithy.api#xmlName": "resourceId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The resource type for the route attachment.

", + "smithy.api#xmlName": "resourceType" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a route in a transit gateway route table.

" + } + }, + "com.amazonaws.ec2#TransitGatewayRouteTableState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + } + } + }, + "com.amazonaws.ec2#TransitGatewayRouteType": { + "type": "enum", + "members": { + "static": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "static" + } + }, + "propagated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "propagated" + } + } + } + }, + "com.amazonaws.ec2#TransitGatewayState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "modifying": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modifying" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + } + } + }, + "com.amazonaws.ec2#TransitGatewaySubnetIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayVpcAttachment": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#xmlName": "transitGatewayAttachmentId" + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayId", + "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#xmlName": "transitGatewayId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } + }, + "VpcOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcOwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the VPC.

", + "smithy.api#xmlName": "vpcOwnerId" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the VPC attachment. Note that the initiating state has been deprecated.

", + "smithy.api#xmlName": "state" + } + }, + "SubnetIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "SubnetIds", + "smithy.api#documentation": "

The IDs of the subnets.

", + "smithy.api#xmlName": "subnetIds" + } + }, + "CreationTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The creation time.

", + "smithy.api#xmlName": "creationTime" + } + }, + "Options": { + "target": "com.amazonaws.ec2#TransitGatewayVpcAttachmentOptions", + "traits": { + "aws.protocols#ec2QueryName": "Options", + "smithy.api#documentation": "

The VPC attachment options.

", + "smithy.api#xmlName": "options" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for the VPC attachment.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a VPC attachment.

" + } + }, + "com.amazonaws.ec2#TransitGatewayVpcAttachmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayVpcAttachment", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayVpcAttachmentOptions": { + "type": "structure", + "members": { + "DnsSupport": { + "target": "com.amazonaws.ec2#DnsSupportValue", + "traits": { + "aws.protocols#ec2QueryName": "DnsSupport", + "smithy.api#documentation": "

Indicates whether DNS support is enabled.

", + "smithy.api#xmlName": "dnsSupport" + } + }, + "Ipv6Support": { + "target": "com.amazonaws.ec2#Ipv6SupportValue", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Support", + "smithy.api#documentation": "

Indicates whether IPv6 support is disabled.

", + "smithy.api#xmlName": "ipv6Support" + } + }, + "ApplianceModeSupport": { + "target": "com.amazonaws.ec2#ApplianceModeSupportValue", + "traits": { + "aws.protocols#ec2QueryName": "ApplianceModeSupport", + "smithy.api#documentation": "

Indicates whether appliance mode support is enabled.

", + "smithy.api#xmlName": "applianceModeSupport" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the VPC attachment options.

" + } + }, + "com.amazonaws.ec2#TransportProtocol": { + "type": "enum", + "members": { + "tcp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tcp" + } + }, + "udp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "udp" + } + } + } + }, + "com.amazonaws.ec2#TrunkInterfaceAssociation": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.ec2#TrunkInterfaceAssociationId", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#documentation": "

The ID of the association.

", + "smithy.api#xmlName": "associationId" + } + }, + "BranchInterfaceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "BranchInterfaceId", + "smithy.api#documentation": "

The ID of the branch network interface.

", + "smithy.api#xmlName": "branchInterfaceId" + } + }, + "TrunkInterfaceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TrunkInterfaceId", + "smithy.api#documentation": "

The ID of the trunk network interface.

", + "smithy.api#xmlName": "trunkInterfaceId" + } + }, + "InterfaceProtocol": { + "target": "com.amazonaws.ec2#InterfaceProtocolType", + "traits": { + "aws.protocols#ec2QueryName": "InterfaceProtocol", + "smithy.api#documentation": "

The interface protocol. Valid values are VLAN and GRE.

", + "smithy.api#xmlName": "interfaceProtocol" + } + }, + "VlanId": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "VlanId", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The ID of the VLAN when you use the VLAN protocol.

", + "smithy.api#xmlName": "vlanId" + } + }, + "GreKey": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "GreKey", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The application key when you use the GRE protocol.

", + "smithy.api#xmlName": "greKey" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for the trunk interface association.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "\n

Currently available in limited preview only. \n If you are interested in using this feature, contact your account manager.

\n \n

Information about an association between a branch network interface with a trunk network interface.

" + } + }, + "com.amazonaws.ec2#TrunkInterfaceAssociationId": { + "type": "string" + }, + "com.amazonaws.ec2#TrunkInterfaceAssociationIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TrunkInterfaceAssociationId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TrunkInterfaceAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TrunkInterfaceAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TrustProviderType": { + "type": "enum", + "members": { + "user": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "user" + } + }, + "device": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "device" + } + } + } + }, + "com.amazonaws.ec2#TunnelInsideIpVersion": { + "type": "enum", + "members": { + "ipv4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv4" + } + }, + "ipv6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv6" + } + } + } + }, + "com.amazonaws.ec2#TunnelOption": { + "type": "structure", + "members": { + "OutsideIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutsideIpAddress", + "smithy.api#documentation": "

The external IP address of the VPN tunnel.

", + "smithy.api#xmlName": "outsideIpAddress" + } + }, + "TunnelInsideCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TunnelInsideCidr", + "smithy.api#documentation": "

The range of inside IPv4 addresses for the tunnel.

", + "smithy.api#xmlName": "tunnelInsideCidr" + } + }, + "TunnelInsideIpv6Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TunnelInsideIpv6Cidr", + "smithy.api#documentation": "

The range of inside IPv6 addresses for the tunnel.

", + "smithy.api#xmlName": "tunnelInsideIpv6Cidr" + } + }, + "PreSharedKey": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PreSharedKey", + "smithy.api#documentation": "

The pre-shared key (PSK) to establish initial authentication between the virtual\n private gateway and the customer gateway.

", + "smithy.api#xmlName": "preSharedKey" + } + }, + "Phase1LifetimeSeconds": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Phase1LifetimeSeconds", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The lifetime for phase 1 of the IKE negotiation, in seconds.

", + "smithy.api#xmlName": "phase1LifetimeSeconds" + } + }, + "Phase2LifetimeSeconds": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Phase2LifetimeSeconds", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The lifetime for phase 2 of the IKE negotiation, in seconds.

", + "smithy.api#xmlName": "phase2LifetimeSeconds" + } + }, + "RekeyMarginTimeSeconds": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "RekeyMarginTimeSeconds", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The margin time, in seconds, before the phase 2 lifetime expires, during which the\n Amazon Web Services side of the VPN connection performs an IKE rekey.

", + "smithy.api#xmlName": "rekeyMarginTimeSeconds" + } + }, + "RekeyFuzzPercentage": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "RekeyFuzzPercentage", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The percentage of the rekey window determined by RekeyMarginTimeSeconds\n during which the rekey time is randomly selected.

", + "smithy.api#xmlName": "rekeyFuzzPercentage" + } + }, + "ReplayWindowSize": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "ReplayWindowSize", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of packets in an IKE replay window.

", + "smithy.api#xmlName": "replayWindowSize" + } + }, + "DpdTimeoutSeconds": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "DpdTimeoutSeconds", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of seconds after which a DPD timeout occurs.

", + "smithy.api#xmlName": "dpdTimeoutSeconds" + } + }, + "DpdTimeoutAction": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DpdTimeoutAction", + "smithy.api#documentation": "

The action to take after a DPD timeout occurs.

", + "smithy.api#xmlName": "dpdTimeoutAction" + } + }, + "Phase1EncryptionAlgorithms": { + "target": "com.amazonaws.ec2#Phase1EncryptionAlgorithmsList", + "traits": { + "aws.protocols#ec2QueryName": "Phase1EncryptionAlgorithmSet", + "smithy.api#documentation": "

The permitted encryption algorithms for the VPN tunnel for phase 1 IKE\n negotiations.

", + "smithy.api#xmlName": "phase1EncryptionAlgorithmSet" + } + }, + "Phase2EncryptionAlgorithms": { + "target": "com.amazonaws.ec2#Phase2EncryptionAlgorithmsList", + "traits": { + "aws.protocols#ec2QueryName": "Phase2EncryptionAlgorithmSet", + "smithy.api#documentation": "

The permitted encryption algorithms for the VPN tunnel for phase 2 IKE\n negotiations.

", + "smithy.api#xmlName": "phase2EncryptionAlgorithmSet" + } + }, + "Phase1IntegrityAlgorithms": { + "target": "com.amazonaws.ec2#Phase1IntegrityAlgorithmsList", + "traits": { + "aws.protocols#ec2QueryName": "Phase1IntegrityAlgorithmSet", + "smithy.api#documentation": "

The permitted integrity algorithms for the VPN tunnel for phase 1 IKE\n negotiations.

", + "smithy.api#xmlName": "phase1IntegrityAlgorithmSet" + } + }, + "Phase2IntegrityAlgorithms": { + "target": "com.amazonaws.ec2#Phase2IntegrityAlgorithmsList", + "traits": { + "aws.protocols#ec2QueryName": "Phase2IntegrityAlgorithmSet", + "smithy.api#documentation": "

The permitted integrity algorithms for the VPN tunnel for phase 2 IKE\n negotiations.

", + "smithy.api#xmlName": "phase2IntegrityAlgorithmSet" + } + }, + "Phase1DHGroupNumbers": { + "target": "com.amazonaws.ec2#Phase1DHGroupNumbersList", + "traits": { + "aws.protocols#ec2QueryName": "Phase1DHGroupNumberSet", + "smithy.api#documentation": "

The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE\n negotiations.

", + "smithy.api#xmlName": "phase1DHGroupNumberSet" + } + }, + "Phase2DHGroupNumbers": { + "target": "com.amazonaws.ec2#Phase2DHGroupNumbersList", + "traits": { + "aws.protocols#ec2QueryName": "Phase2DHGroupNumberSet", + "smithy.api#documentation": "

The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE\n negotiations.

", + "smithy.api#xmlName": "phase2DHGroupNumberSet" + } + }, + "IkeVersions": { + "target": "com.amazonaws.ec2#IKEVersionsList", + "traits": { + "aws.protocols#ec2QueryName": "IkeVersionSet", + "smithy.api#documentation": "

The IKE versions that are permitted for the VPN tunnel.

", + "smithy.api#xmlName": "ikeVersionSet" + } + }, + "StartupAction": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StartupAction", + "smithy.api#documentation": "

The action to take when the establishing the VPN tunnels for a VPN connection.

", + "smithy.api#xmlName": "startupAction" + } + }, + "LogOptions": { + "target": "com.amazonaws.ec2#VpnTunnelLogOptions", + "traits": { + "aws.protocols#ec2QueryName": "LogOptions", + "smithy.api#documentation": "

Options for logging VPN tunnel activity.

", + "smithy.api#xmlName": "logOptions" + } + }, + "EnableTunnelLifecycleControl": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnableTunnelLifecycleControl", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Status of tunnel endpoint lifecycle control feature.

", + "smithy.api#xmlName": "enableTunnelLifecycleControl" + } + } + }, + "traits": { + "smithy.api#documentation": "

The VPN tunnel options.

" + } + }, + "com.amazonaws.ec2#TunnelOptionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TunnelOption", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#UnassignIpv6Addresses": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#UnassignIpv6AddressesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#UnassignIpv6AddressesResult" + }, + "traits": { + "smithy.api#documentation": "

Unassigns one or more IPv6 addresses IPv4 Prefix Delegation prefixes from a network interface.

" + } + }, + "com.amazonaws.ec2#UnassignIpv6AddressesRequest": { + "type": "structure", + "members": { + "Ipv6Addresses": { + "target": "com.amazonaws.ec2#Ipv6AddressList", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Addresses", + "smithy.api#documentation": "

The IPv6 addresses to unassign from the network interface.

", + "smithy.api#xmlName": "ipv6Addresses" + } + }, + "Ipv6Prefixes": { + "target": "com.amazonaws.ec2#IpPrefixList", + "traits": { + "smithy.api#documentation": "

The IPv6 prefixes to unassign from the network interface.

", + "smithy.api#xmlName": "Ipv6Prefix" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "networkInterfaceId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#UnassignIpv6AddressesResult": { + "type": "structure", + "members": { + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "UnassignedIpv6Addresses": { + "target": "com.amazonaws.ec2#Ipv6AddressList", + "traits": { + "aws.protocols#ec2QueryName": "UnassignedIpv6Addresses", + "smithy.api#documentation": "

The IPv6 addresses that have been unassigned from the network interface.

", + "smithy.api#xmlName": "unassignedIpv6Addresses" + } + }, + "UnassignedIpv6Prefixes": { + "target": "com.amazonaws.ec2#IpPrefixList", + "traits": { + "aws.protocols#ec2QueryName": "UnassignedIpv6PrefixSet", + "smithy.api#documentation": "

The IPv4 prefixes that have been unassigned from the network interface.

", + "smithy.api#xmlName": "unassignedIpv6PrefixSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#UnassignPrivateIpAddresses": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#UnassignPrivateIpAddressesRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

Unassigns one or more secondary private IP addresses, or IPv4 Prefix Delegation prefixes from a \n \tnetwork interface.

" + } + }, + "com.amazonaws.ec2#UnassignPrivateIpAddressesRequest": { + "type": "structure", + "members": { + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "PrivateIpAddresses": { + "target": "com.amazonaws.ec2#PrivateIpAddressStringList", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

The secondary private IP addresses to unassign from the network interface. You can specify this \n \toption multiple times to unassign more than one IP address.

", + "smithy.api#xmlName": "privateIpAddress" + } + }, + "Ipv4Prefixes": { + "target": "com.amazonaws.ec2#IpPrefixList", + "traits": { + "smithy.api#documentation": "

The IPv4 prefixes to unassign from the network interface.

", + "smithy.api#xmlName": "Ipv4Prefix" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for UnassignPrivateIpAddresses.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#UnassignPrivateNatGatewayAddress": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#UnassignPrivateNatGatewayAddressRequest" + }, + "output": { + "target": "com.amazonaws.ec2#UnassignPrivateNatGatewayAddressResult" + }, + "traits": { + "smithy.api#documentation": "

Unassigns secondary private IPv4 addresses from a private NAT gateway. You cannot unassign your primary private IP. For more information, see Edit secondary IP address associations in the Amazon Virtual Private Cloud User Guide.

\n

While unassigning is in progress, you cannot assign/unassign additional IP addresses while the connections are being drained. You are, however, allowed to delete the NAT gateway.

\n

A private IP address will only be released at the end of MaxDrainDurationSeconds. The\n private IP addresses stay associated and support the existing connections but do not\n support any new connections (new connections are distributed across the remaining\n assigned private IP address). After the existing connections drain out, the private IP\n addresses get released.

\n

\n

" + } + }, + "com.amazonaws.ec2#UnassignPrivateNatGatewayAddressRequest": { + "type": "structure", + "members": { + "NatGatewayId": { + "target": "com.amazonaws.ec2#NatGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The NAT gateway ID.

", + "smithy.api#required": {} + } + }, + "PrivateIpAddresses": { + "target": "com.amazonaws.ec2#IpList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The private IPv4 addresses you want to unassign.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "PrivateIpAddress" + } + }, + "MaxDrainDurationSeconds": { + "target": "com.amazonaws.ec2#DrainSeconds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#UnassignPrivateNatGatewayAddressResult": { + "type": "structure", + "members": { + "NatGatewayId": { + "target": "com.amazonaws.ec2#NatGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "NatGatewayId", + "smithy.api#documentation": "

The NAT gateway ID.

", + "smithy.api#xmlName": "natGatewayId" + } + }, + "NatGatewayAddresses": { + "target": "com.amazonaws.ec2#NatGatewayAddressList", + "traits": { + "aws.protocols#ec2QueryName": "NatGatewayAddressSet", + "smithy.api#documentation": "

Information about the NAT gateway IP addresses.

", + "smithy.api#xmlName": "natGatewayAddressSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#UnlimitedSupportedInstanceFamily": { + "type": "enum", + "members": { + "t2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t2" + } + }, + "t3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t3" + } + }, + "t3a": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t3a" + } + }, + "t4g": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t4g" + } + } + } + }, + "com.amazonaws.ec2#UnmonitorInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#UnmonitorInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#UnmonitorInstancesResult" + }, + "traits": { + "smithy.api#documentation": "

Disables detailed monitoring for a running instance. For more information, see Monitoring\n your instances and volumes in the\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#UnmonitorInstancesRequest": { + "type": "structure", + "members": { + "InstanceIds": { + "target": "com.amazonaws.ec2#InstanceIdStringList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the instances.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "InstanceId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#UnmonitorInstancesResult": { + "type": "structure", + "members": { + "InstanceMonitorings": { + "target": "com.amazonaws.ec2#InstanceMonitoringList", + "traits": { + "aws.protocols#ec2QueryName": "InstancesSet", + "smithy.api#documentation": "

The monitoring information.

", + "smithy.api#xmlName": "instancesSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#UnsuccessfulInstanceCreditSpecificationErrorCode": { + "type": "enum", + "members": { + "INVALID_INSTANCE_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidInstanceID.Malformed" + } + }, + "INSTANCE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidInstanceID.NotFound" + } + }, + "INCORRECT_INSTANCE_STATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IncorrectInstanceState" + } + }, + "INSTANCE_CREDIT_SPECIFICATION_NOT_SUPPORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InstanceCreditSpecification.NotSupported" + } + } + } + }, + "com.amazonaws.ec2#UnsuccessfulInstanceCreditSpecificationItem": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "Error": { + "target": "com.amazonaws.ec2#UnsuccessfulInstanceCreditSpecificationItemError", + "traits": { + "aws.protocols#ec2QueryName": "Error", + "smithy.api#documentation": "

The applicable error for the burstable performance instance whose credit option for\n CPU usage was not modified.

", + "smithy.api#xmlName": "error" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the burstable performance instance whose credit option for CPU usage was not\n modified.

" + } + }, + "com.amazonaws.ec2#UnsuccessfulInstanceCreditSpecificationItemError": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#UnsuccessfulInstanceCreditSpecificationErrorCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The error code.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The applicable error message.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the error for the burstable performance instance whose credit option\n for CPU usage was not modified.

" + } + }, + "com.amazonaws.ec2#UnsuccessfulInstanceCreditSpecificationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#UnsuccessfulInstanceCreditSpecificationItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#UnsuccessfulItem": { + "type": "structure", + "members": { + "Error": { + "target": "com.amazonaws.ec2#UnsuccessfulItemError", + "traits": { + "aws.protocols#ec2QueryName": "Error", + "smithy.api#documentation": "

Information about the error.

", + "smithy.api#xmlName": "error" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource.

", + "smithy.api#xmlName": "resourceId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about items that were not successfully processed in a batch call.

" + } + }, + "com.amazonaws.ec2#UnsuccessfulItemError": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The error code.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The error message accompanying the error code.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the error that occurred. For more information about errors, see Error codes.

" + } + }, + "com.amazonaws.ec2#UnsuccessfulItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#UnsuccessfulItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#UnsuccessfulItemSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#UnsuccessfulItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsEgress": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsEgressRequest" + }, + "output": { + "target": "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsEgressResult" + }, + "traits": { + "smithy.api#documentation": "

[VPC only] Updates the description of an egress (outbound) security group rule. You\n\t\t\tcan replace an existing description, or add a description to a rule that did not have one\n\t\t\tpreviously. You can remove a description for a security group rule by omitting the \n\t\t\tdescription parameter in the request.

" + } + }, + "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsEgressRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "smithy.api#documentation": "

The ID of the security group. You must specify either the security group ID or the\n\t\t\tsecurity group name in the request. For security groups in a nondefault VPC, you must\n\t\t\tspecify the security group ID.

" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#SecurityGroupName", + "traits": { + "smithy.api#documentation": "

[Default VPC] The name of the security group. You must specify either the security group\n\t\t\tID or the security group name in the request.

" + } + }, + "IpPermissions": { + "target": "com.amazonaws.ec2#IpPermissionList", + "traits": { + "smithy.api#documentation": "

The IP permissions for the security group rule. You must specify either the IP permissions\n\t\t or the description.

" + } + }, + "SecurityGroupRuleDescriptions": { + "target": "com.amazonaws.ec2#SecurityGroupRuleDescriptionList", + "traits": { + "smithy.api#documentation": "

The description for the egress security group rules. You must specify either the\n description or the IP permissions.

", + "smithy.api#xmlName": "SecurityGroupRuleDescription" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsEgressResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsIngress": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsIngressRequest" + }, + "output": { + "target": "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsIngressResult" + }, + "traits": { + "smithy.api#documentation": "

Updates the description of an ingress (inbound) security group rule. You can replace an\n\t\t\texisting description, or add a description to a rule that did not have one previously.\n\t\t You can remove a description for a security group rule by omitting the description \n\t\t parameter in the request.

" + } + }, + "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsIngressRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "smithy.api#documentation": "

The ID of the security group. You must specify either the security group ID or the\n\t\t\tsecurity group name in the request. For security groups in a nondefault VPC, you must\n\t\t\tspecify the security group ID.

" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#SecurityGroupName", + "traits": { + "smithy.api#documentation": "

[EC2-Classic, default VPC] The name of the security group. You must specify either the\n security group ID or the security group name in the request. For security groups in a\n nondefault VPC, you must specify the security group ID.

" + } + }, + "IpPermissions": { + "target": "com.amazonaws.ec2#IpPermissionList", + "traits": { + "smithy.api#documentation": "

The IP permissions for the security group rule. You must specify either IP permissions\n\t\t or a description.

" + } + }, + "SecurityGroupRuleDescriptions": { + "target": "com.amazonaws.ec2#SecurityGroupRuleDescriptionList", + "traits": { + "smithy.api#documentation": "

[VPC only] The description for the ingress security group rules. You must specify either\n a description or IP permissions.

", + "smithy.api#xmlName": "SecurityGroupRuleDescription" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsIngressResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#UsageClassType": { + "type": "enum", + "members": { + "spot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "spot" + } + }, + "on_demand": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "on-demand" + } + } + } + }, + "com.amazonaws.ec2#UsageClassTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#UsageClassType", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#UserBucket": { + "type": "structure", + "members": { + "S3Bucket": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket where the disk image is located.

" + } + }, + "S3Key": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The file name of the disk image.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the Amazon S3 bucket for the disk image.

" + } + }, + "com.amazonaws.ec2#UserBucketDetails": { + "type": "structure", + "members": { + "S3Bucket": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "S3Bucket", + "smithy.api#documentation": "

The Amazon S3 bucket from which the disk image was created.

", + "smithy.api#xmlName": "s3Bucket" + } + }, + "S3Key": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "S3Key", + "smithy.api#documentation": "

The file name of the disk image.

", + "smithy.api#xmlName": "s3Key" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the Amazon S3 bucket for the disk image.

" + } + }, + "com.amazonaws.ec2#UserData": { + "type": "structure", + "members": { + "Data": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Data", + "smithy.api#documentation": "

The user data. If you are using an Amazon Web Services SDK or command line tool, Base64-encoding is performed for you, and you\n can load the text from a file. Otherwise, you must provide Base64-encoded text.

", + "smithy.api#xmlName": "data" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the user data for an instance.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.ec2#UserGroupStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "UserGroup" + } + } + }, + "com.amazonaws.ec2#UserIdGroupPair": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the security group rule that references this user ID group\n\t\t\tpair.

\n

Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9,\n spaces, and ._-:/()#,@[]+=;{}!$*

", + "smithy.api#xmlName": "description" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The ID of the security group.

", + "smithy.api#xmlName": "groupId" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

The name of the security group. In a request, use this parameter for a security group\n in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the\n security group ID.

\n

For a referenced security group in another VPC, this value is not returned if the\n referenced security group is deleted.

", + "smithy.api#xmlName": "groupName" + } + }, + "PeeringStatus": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PeeringStatus", + "smithy.api#documentation": "

The status of a VPC peering connection, if applicable.

", + "smithy.api#xmlName": "peeringStatus" + } + }, + "UserId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UserId", + "smithy.api#documentation": "

The ID of an Amazon Web Services account.

\n

For a referenced security group in another VPC, the account ID of the referenced\n security group is returned in the response. If the referenced security group is deleted,\n this value is not returned.

\n

[EC2-Classic] Required when adding or removing rules that reference a security group\n in another Amazon Web Services account.

", + "smithy.api#xmlName": "userId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC for the referenced security group, if applicable.

", + "smithy.api#xmlName": "vpcId" + } + }, + "VpcPeeringConnectionId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", + "smithy.api#documentation": "

The ID of the VPC peering connection, if applicable.

", + "smithy.api#xmlName": "vpcPeeringConnectionId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a security group and Amazon Web Services account ID pair.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " + } + }, + "com.amazonaws.ec2#UserIdGroupPairList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#UserIdGroupPair", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#UserIdGroupPairSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#UserIdGroupPair", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#UserIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "UserId" + } + } + }, + "com.amazonaws.ec2#UserTrustProviderType": { + "type": "enum", + "members": { + "iam_identity_center": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "iam-identity-center" + } + }, + "oidc": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "oidc" + } + } + } + }, + "com.amazonaws.ec2#VCpuCount": { + "type": "integer" + }, + "com.amazonaws.ec2#VCpuCountRange": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Min", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum number of vCPUs. If the value is 0, there is no minimum\n limit.

", + "smithy.api#xmlName": "min" + } + }, + "Max": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Max", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of vCPUs. If this parameter is not specified, there is no maximum\n limit.

", + "smithy.api#xmlName": "max" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum number of vCPUs.

" + } + }, + "com.amazonaws.ec2#VCpuCountRangeRequest": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum number of vCPUs. To specify no minimum limit, specify 0.

", + "smithy.api#required": {} + } + }, + "Max": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of vCPUs. To specify no maximum limit, omit this parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum number of vCPUs.

" + } + }, + "com.amazonaws.ec2#VCpuInfo": { + "type": "structure", + "members": { + "DefaultVCpus": { + "target": "com.amazonaws.ec2#VCpuCount", + "traits": { + "aws.protocols#ec2QueryName": "DefaultVCpus", + "smithy.api#documentation": "

The default number of vCPUs for the instance type.

", + "smithy.api#xmlName": "defaultVCpus" + } + }, + "DefaultCores": { + "target": "com.amazonaws.ec2#CoreCount", + "traits": { + "aws.protocols#ec2QueryName": "DefaultCores", + "smithy.api#documentation": "

The default number of cores for the instance type.

", + "smithy.api#xmlName": "defaultCores" + } + }, + "DefaultThreadsPerCore": { + "target": "com.amazonaws.ec2#ThreadsPerCore", + "traits": { + "aws.protocols#ec2QueryName": "DefaultThreadsPerCore", + "smithy.api#documentation": "

The default number of threads per core for the instance type.

", + "smithy.api#xmlName": "defaultThreadsPerCore" + } + }, + "ValidCores": { + "target": "com.amazonaws.ec2#CoreCountList", + "traits": { + "aws.protocols#ec2QueryName": "ValidCores", + "smithy.api#documentation": "

The valid number of cores that can be configured for the instance type.

", + "smithy.api#xmlName": "validCores" + } + }, + "ValidThreadsPerCore": { + "target": "com.amazonaws.ec2#ThreadsPerCoreList", + "traits": { + "aws.protocols#ec2QueryName": "ValidThreadsPerCore", + "smithy.api#documentation": "

The valid number of threads per core that can be configured for the instance type.

", + "smithy.api#xmlName": "validThreadsPerCore" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the vCPU configurations for the instance type.

" + } + }, + "com.amazonaws.ec2#ValidationError": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The error code that indicates why the parameter or parameter combination is not valid.\n For more information about error codes, see Error codes.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The error message that describes why the parameter or parameter combination is not\n valid. For more information about error messages, see Error codes.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

The error code and error message that is returned for a parameter or parameter\n combination that is not valid when a new launch template or new version of a launch\n template is created.

" + } + }, + "com.amazonaws.ec2#ValidationWarning": { + "type": "structure", + "members": { + "Errors": { + "target": "com.amazonaws.ec2#ErrorSet", + "traits": { + "aws.protocols#ec2QueryName": "ErrorSet", + "smithy.api#documentation": "

The error codes and error messages.

", + "smithy.api#xmlName": "errorSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

The error codes and error messages that are returned for the parameters or parameter\n combinations that are not valid when a new launch template or new version of a launch\n template is created.

" + } + }, + "com.amazonaws.ec2#ValueStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VerifiedAccessEndpoint": { + "type": "structure", + "members": { + "VerifiedAccessInstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessInstanceId", + "smithy.api#documentation": "

The ID of the Amazon Web Services Verified Access instance.

", + "smithy.api#xmlName": "verifiedAccessInstanceId" + } + }, + "VerifiedAccessGroupId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessGroupId", + "smithy.api#documentation": "

The ID of the Amazon Web Services Verified Access group.

", + "smithy.api#xmlName": "verifiedAccessGroupId" + } + }, + "VerifiedAccessEndpointId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessEndpointId", + "smithy.api#documentation": "

The ID of the Amazon Web Services Verified Access endpoint.

", + "smithy.api#xmlName": "verifiedAccessEndpointId" + } + }, + "ApplicationDomain": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ApplicationDomain", + "smithy.api#documentation": "

The DNS name for users to reach your application.

", + "smithy.api#xmlName": "applicationDomain" + } + }, + "EndpointType": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointType", + "traits": { + "aws.protocols#ec2QueryName": "EndpointType", + "smithy.api#documentation": "

The type of Amazon Web Services Verified Access endpoint. Incoming application requests will be sent to an IP\n address, load balancer or a network interface depending on the endpoint type\n specified.

", + "smithy.api#xmlName": "endpointType" + } + }, + "AttachmentType": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointAttachmentType", + "traits": { + "aws.protocols#ec2QueryName": "AttachmentType", + "smithy.api#documentation": "

The type of attachment used to provide connectivity between the Amazon Web Services Verified Access endpoint and the\n application.

", + "smithy.api#xmlName": "attachmentType" + } + }, + "DomainCertificateArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DomainCertificateArn", + "smithy.api#documentation": "

The ARN of a public TLS/SSL certificate imported into or created with ACM.

", + "smithy.api#xmlName": "domainCertificateArn" + } + }, + "EndpointDomain": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "EndpointDomain", + "smithy.api#documentation": "

A DNS name that is generated for the endpoint.

", + "smithy.api#xmlName": "endpointDomain" + } + }, + "DeviceValidationDomain": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DeviceValidationDomain", + "smithy.api#documentation": "

Returned if endpoint has a device trust provider attached.

", + "smithy.api#xmlName": "deviceValidationDomain" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#SecurityGroupIdList", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupIdSet", + "smithy.api#documentation": "

The IDs of the security groups for the endpoint.

", + "smithy.api#xmlName": "securityGroupIdSet" + } + }, + "LoadBalancerOptions": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointLoadBalancerOptions", + "traits": { + "aws.protocols#ec2QueryName": "LoadBalancerOptions", + "smithy.api#documentation": "

The load balancer details if creating the Amazon Web Services Verified Access endpoint as\n load-balancertype.

", + "smithy.api#xmlName": "loadBalancerOptions" + } + }, + "NetworkInterfaceOptions": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointEniOptions", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceOptions", + "smithy.api#documentation": "

The options for network-interface type endpoint.

", + "smithy.api#xmlName": "networkInterfaceOptions" + } + }, + "Status": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The endpoint status.

", + "smithy.api#xmlName": "status" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the Amazon Web Services Verified Access endpoint.

", + "smithy.api#xmlName": "description" + } + }, + "CreationTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The creation time.

", + "smithy.api#xmlName": "creationTime" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LastUpdatedTime", + "smithy.api#documentation": "

The last updated time.

", + "smithy.api#xmlName": "lastUpdatedTime" + } + }, + "DeletionTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DeletionTime", + "smithy.api#documentation": "

The deletion time.

", + "smithy.api#xmlName": "deletionTime" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

An Amazon Web Services Verified Access endpoint specifies the application that Amazon Web Services Verified Access provides access to. It must be\n attached to an Amazon Web Services Verified Access group. An Amazon Web Services Verified Access endpoint must also have an attached access policy\n before you attached it to a group.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessEndpointAttachmentType": { + "type": "enum", + "members": { + "vpc": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc" + } + } + } + }, + "com.amazonaws.ec2#VerifiedAccessEndpointEniOptions": { + "type": "structure", + "members": { + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "Protocol": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointProtocol", + "traits": { + "aws.protocols#ec2QueryName": "Protocol", + "smithy.api#documentation": "

The IP protocol.

", + "smithy.api#xmlName": "protocol" + } + }, + "Port": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointPortNumber", + "traits": { + "aws.protocols#ec2QueryName": "Port", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The IP port number.

", + "smithy.api#xmlName": "port" + } + } + }, + "traits": { + "smithy.api#documentation": "

Options for a network-interface type endpoint.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessEndpointId": { + "type": "string" + }, + "com.amazonaws.ec2#VerifiedAccessEndpointIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VerifiedAccessEndpointList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpoint", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VerifiedAccessEndpointLoadBalancerOptions": { + "type": "structure", + "members": { + "Protocol": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointProtocol", + "traits": { + "aws.protocols#ec2QueryName": "Protocol", + "smithy.api#documentation": "

The IP protocol.

", + "smithy.api#xmlName": "protocol" + } + }, + "Port": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointPortNumber", + "traits": { + "aws.protocols#ec2QueryName": "Port", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The IP port number.

", + "smithy.api#xmlName": "port" + } + }, + "LoadBalancerArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LoadBalancerArn", + "smithy.api#documentation": "

The ARN of the load balancer.

", + "smithy.api#xmlName": "loadBalancerArn" + } + }, + "SubnetIds": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointSubnetIdList", + "traits": { + "aws.protocols#ec2QueryName": "SubnetIdSet", + "smithy.api#documentation": "

The IDs of the subnets.

", + "smithy.api#xmlName": "subnetIdSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a load balancer when creating an Amazon Web Services Verified Access endpoint using the\n load-balancer type.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessEndpointPortNumber": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 65535 + } + } + }, + "com.amazonaws.ec2#VerifiedAccessEndpointProtocol": { + "type": "enum", + "members": { + "http": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "http" + } + }, + "https": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "https" + } + } + } + }, + "com.amazonaws.ec2#VerifiedAccessEndpointStatus": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#VerifiedAccessEndpointStatusCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The status code of the Verified Access endpoint.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The status message of the Verified Access endpoint.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the status of a Verified Access endpoint.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessEndpointStatusCode": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "updating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "updating" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + } + } + }, + "com.amazonaws.ec2#VerifiedAccessEndpointSubnetIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VerifiedAccessEndpointType": { + "type": "enum", + "members": { + "load_balancer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "load-balancer" + } + }, + "network_interface": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "network-interface" + } + } + } + }, + "com.amazonaws.ec2#VerifiedAccessGroup": { + "type": "structure", + "members": { + "VerifiedAccessGroupId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessGroupId", + "smithy.api#documentation": "

The ID of the Verified Access group.

", + "smithy.api#xmlName": "verifiedAccessGroupId" + } + }, + "VerifiedAccessInstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessInstanceId", + "smithy.api#documentation": "

The ID of the Amazon Web Services Verified Access instance.

", + "smithy.api#xmlName": "verifiedAccessInstanceId" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the Amazon Web Services Verified Access group.

", + "smithy.api#xmlName": "description" + } + }, + "Owner": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Owner", + "smithy.api#documentation": "

The Amazon Web Services account number that owns the group.

", + "smithy.api#xmlName": "owner" + } + }, + "VerifiedAccessGroupArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessGroupArn", + "smithy.api#documentation": "

The ARN of the Verified Access group.

", + "smithy.api#xmlName": "verifiedAccessGroupArn" + } + }, + "CreationTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The creation time.

", + "smithy.api#xmlName": "creationTime" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LastUpdatedTime", + "smithy.api#documentation": "

The last updated time.

", + "smithy.api#xmlName": "lastUpdatedTime" + } + }, + "DeletionTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DeletionTime", + "smithy.api#documentation": "

The deletion time.

", + "smithy.api#xmlName": "deletionTime" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Verified Access group.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessGroupId": { + "type": "string" + }, + "com.amazonaws.ec2#VerifiedAccessGroupIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VerifiedAccessGroupId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VerifiedAccessGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VerifiedAccessGroup", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VerifiedAccessInstance": { + "type": "structure", + "members": { + "VerifiedAccessInstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessInstanceId", + "smithy.api#documentation": "

The ID of the Amazon Web Services Verified Access instance.

", + "smithy.api#xmlName": "verifiedAccessInstanceId" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the Amazon Web Services Verified Access instance.

", + "smithy.api#xmlName": "description" + } + }, + "VerifiedAccessTrustProviders": { + "target": "com.amazonaws.ec2#VerifiedAccessTrustProviderCondensedList", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessTrustProviderSet", + "smithy.api#documentation": "

The IDs of the Amazon Web Services Verified Access trust providers.

", + "smithy.api#xmlName": "verifiedAccessTrustProviderSet" + } + }, + "CreationTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The creation time.

", + "smithy.api#xmlName": "creationTime" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LastUpdatedTime", + "smithy.api#documentation": "

The last updated time.

", + "smithy.api#xmlName": "lastUpdatedTime" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Verified Access instance.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessInstanceId": { + "type": "string" + }, + "com.amazonaws.ec2#VerifiedAccessInstanceIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VerifiedAccessInstanceList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VerifiedAccessInstance", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VerifiedAccessInstanceLoggingConfiguration": { + "type": "structure", + "members": { + "VerifiedAccessInstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessInstanceId", + "smithy.api#documentation": "

The ID of the Amazon Web Services Verified Access instance.

", + "smithy.api#xmlName": "verifiedAccessInstanceId" + } + }, + "AccessLogs": { + "target": "com.amazonaws.ec2#VerifiedAccessLogs", + "traits": { + "aws.protocols#ec2QueryName": "AccessLogs", + "smithy.api#documentation": "

Details about the logging options.

", + "smithy.api#xmlName": "accessLogs" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes logging options for an Amazon Web Services Verified Access instance.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessInstanceLoggingConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VerifiedAccessInstanceLoggingConfiguration", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VerifiedAccessLogCloudWatchLogsDestination": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Enabled", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether logging is enabled.

", + "smithy.api#xmlName": "enabled" + } + }, + "DeliveryStatus": { + "target": "com.amazonaws.ec2#VerifiedAccessLogDeliveryStatus", + "traits": { + "aws.protocols#ec2QueryName": "DeliveryStatus", + "smithy.api#documentation": "

The delivery status for access logs.

", + "smithy.api#xmlName": "deliveryStatus" + } + }, + "LogGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LogGroup", + "smithy.api#documentation": "

The ID of the CloudWatch Logs log group.

", + "smithy.api#xmlName": "logGroup" + } + } + }, + "traits": { + "smithy.api#documentation": "

Options for CloudWatch Logs as a logging destination.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessLogCloudWatchLogsDestinationOptions": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether logging is enabled.

", + "smithy.api#required": {} + } + }, + "LogGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of the CloudWatch Logs log group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Options for CloudWatch Logs as a logging destination.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessLogDeliveryStatus": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#VerifiedAccessLogDeliveryStatusCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The status code.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The status message.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a log delivery status.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessLogDeliveryStatusCode": { + "type": "enum", + "members": { + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "success" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + } + } + }, + "com.amazonaws.ec2#VerifiedAccessLogKinesisDataFirehoseDestination": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Enabled", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether logging is enabled.

", + "smithy.api#xmlName": "enabled" + } + }, + "DeliveryStatus": { + "target": "com.amazonaws.ec2#VerifiedAccessLogDeliveryStatus", + "traits": { + "aws.protocols#ec2QueryName": "DeliveryStatus", + "smithy.api#documentation": "

The delivery status.

", + "smithy.api#xmlName": "deliveryStatus" + } + }, + "DeliveryStream": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DeliveryStream", + "smithy.api#documentation": "

The ID of the delivery stream.

", + "smithy.api#xmlName": "deliveryStream" + } + } + }, + "traits": { + "smithy.api#documentation": "

Options for Kinesis as a logging destination.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessLogKinesisDataFirehoseDestinationOptions": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether logging is enabled.

", + "smithy.api#required": {} + } + }, + "DeliveryStream": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of the delivery stream.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes Amazon Kinesis Data Firehose logging options.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessLogOptions": { + "type": "structure", + "members": { + "S3": { + "target": "com.amazonaws.ec2#VerifiedAccessLogS3DestinationOptions", + "traits": { + "smithy.api#documentation": "

Sends Verified Access logs to Amazon S3.

" + } + }, + "CloudWatchLogs": { + "target": "com.amazonaws.ec2#VerifiedAccessLogCloudWatchLogsDestinationOptions", + "traits": { + "smithy.api#documentation": "

Sends Verified Access logs to CloudWatch Logs.

" + } + }, + "KinesisDataFirehose": { + "target": "com.amazonaws.ec2#VerifiedAccessLogKinesisDataFirehoseDestinationOptions", + "traits": { + "smithy.api#documentation": "

Sends Verified Access logs to Kinesis.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the destinations for Verified Access logs.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessLogS3Destination": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Enabled", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether logging is enabled.

", + "smithy.api#xmlName": "enabled" + } + }, + "DeliveryStatus": { + "target": "com.amazonaws.ec2#VerifiedAccessLogDeliveryStatus", + "traits": { + "aws.protocols#ec2QueryName": "DeliveryStatus", + "smithy.api#documentation": "

The delivery status.

", + "smithy.api#xmlName": "deliveryStatus" + } + }, + "BucketName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "BucketName", + "smithy.api#documentation": "

The bucket name.

", + "smithy.api#xmlName": "bucketName" + } + }, + "Prefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Prefix", + "smithy.api#documentation": "

The bucket prefix.

", + "smithy.api#xmlName": "prefix" + } + }, + "BucketOwner": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "BucketOwner", + "smithy.api#documentation": "

The Amazon Web Services account number that owns the bucket.

", + "smithy.api#xmlName": "bucketOwner" + } + } + }, + "traits": { + "smithy.api#documentation": "

Options for Amazon S3 as a logging destination.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessLogS3DestinationOptions": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether logging is enabled.

", + "smithy.api#required": {} + } + }, + "BucketName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The bucket name.

" + } + }, + "Prefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The bucket prefix.

" + } + }, + "BucketOwner": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the Amazon S3 bucket.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Options for Amazon S3 as a logging destination.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessLogs": { + "type": "structure", + "members": { + "S3": { + "target": "com.amazonaws.ec2#VerifiedAccessLogS3Destination", + "traits": { + "aws.protocols#ec2QueryName": "S3", + "smithy.api#documentation": "

Amazon S3 logging options.

", + "smithy.api#xmlName": "s3" + } + }, + "CloudWatchLogs": { + "target": "com.amazonaws.ec2#VerifiedAccessLogCloudWatchLogsDestination", + "traits": { + "aws.protocols#ec2QueryName": "CloudWatchLogs", + "smithy.api#documentation": "

CloudWatch Logs logging destination.

", + "smithy.api#xmlName": "cloudWatchLogs" + } + }, + "KinesisDataFirehose": { + "target": "com.amazonaws.ec2#VerifiedAccessLogKinesisDataFirehoseDestination", + "traits": { + "aws.protocols#ec2QueryName": "KinesisDataFirehose", + "smithy.api#documentation": "

Kinesis logging destination.

", + "smithy.api#xmlName": "kinesisDataFirehose" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the destinations for Verified Access logs.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessTrustProvider": { + "type": "structure", + "members": { + "VerifiedAccessTrustProviderId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessTrustProviderId", + "smithy.api#documentation": "

The ID of the Amazon Web Services Verified Access trust provider.

", + "smithy.api#xmlName": "verifiedAccessTrustProviderId" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the Amazon Web Services Verified Access trust provider.

", + "smithy.api#xmlName": "description" + } + }, + "TrustProviderType": { + "target": "com.amazonaws.ec2#TrustProviderType", + "traits": { + "aws.protocols#ec2QueryName": "TrustProviderType", + "smithy.api#documentation": "

The type of Verified Access trust provider.

", + "smithy.api#xmlName": "trustProviderType" + } + }, + "UserTrustProviderType": { + "target": "com.amazonaws.ec2#UserTrustProviderType", + "traits": { + "aws.protocols#ec2QueryName": "UserTrustProviderType", + "smithy.api#documentation": "

The type of user-based trust provider.

", + "smithy.api#xmlName": "userTrustProviderType" + } + }, + "DeviceTrustProviderType": { + "target": "com.amazonaws.ec2#DeviceTrustProviderType", + "traits": { + "aws.protocols#ec2QueryName": "DeviceTrustProviderType", + "smithy.api#documentation": "

The type of device-based trust provider.

", + "smithy.api#xmlName": "deviceTrustProviderType" + } + }, + "OidcOptions": { + "target": "com.amazonaws.ec2#OidcOptions", + "traits": { + "aws.protocols#ec2QueryName": "OidcOptions", + "smithy.api#documentation": "

The options for an OpenID Connect-compatible user-identity trust provider.

", + "smithy.api#xmlName": "oidcOptions" + } + }, + "DeviceOptions": { + "target": "com.amazonaws.ec2#DeviceOptions", + "traits": { + "aws.protocols#ec2QueryName": "DeviceOptions", + "smithy.api#documentation": "

The options for device-identity trust provider.

", + "smithy.api#xmlName": "deviceOptions" + } + }, + "PolicyReferenceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PolicyReferenceName", + "smithy.api#documentation": "

The identifier to be used when working with policy rules.

", + "smithy.api#xmlName": "policyReferenceName" + } + }, + "CreationTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The creation time.

", + "smithy.api#xmlName": "creationTime" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LastUpdatedTime", + "smithy.api#documentation": "

The last updated time.

", + "smithy.api#xmlName": "lastUpdatedTime" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Verified Access trust provider.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessTrustProviderCondensed": { + "type": "structure", + "members": { + "VerifiedAccessTrustProviderId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VerifiedAccessTrustProviderId", + "smithy.api#documentation": "

The ID of the trust provider.

", + "smithy.api#xmlName": "verifiedAccessTrustProviderId" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of trust provider.

", + "smithy.api#xmlName": "description" + } + }, + "TrustProviderType": { + "target": "com.amazonaws.ec2#TrustProviderType", + "traits": { + "aws.protocols#ec2QueryName": "TrustProviderType", + "smithy.api#documentation": "

The type of trust provider (user- or device-based).

", + "smithy.api#xmlName": "trustProviderType" + } + }, + "UserTrustProviderType": { + "target": "com.amazonaws.ec2#UserTrustProviderType", + "traits": { + "aws.protocols#ec2QueryName": "UserTrustProviderType", + "smithy.api#documentation": "

The type of user-based trust provider.

", + "smithy.api#xmlName": "userTrustProviderType" + } + }, + "DeviceTrustProviderType": { + "target": "com.amazonaws.ec2#DeviceTrustProviderType", + "traits": { + "aws.protocols#ec2QueryName": "DeviceTrustProviderType", + "smithy.api#documentation": "

The type of device-based trust provider.

", + "smithy.api#xmlName": "deviceTrustProviderType" + } + } + }, + "traits": { + "smithy.api#documentation": "

Condensed information about a trust provider.

" + } + }, + "com.amazonaws.ec2#VerifiedAccessTrustProviderCondensedList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VerifiedAccessTrustProviderCondensed", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VerifiedAccessTrustProviderId": { + "type": "string" + }, + "com.amazonaws.ec2#VerifiedAccessTrustProviderIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VerifiedAccessTrustProviderId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VerifiedAccessTrustProviderList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VerifiedAccessTrustProvider", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VersionDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.ec2#VersionStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VgwTelemetry": { + "type": "structure", + "members": { + "AcceptedRouteCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "AcceptedRouteCount", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of accepted routes.

", + "smithy.api#xmlName": "acceptedRouteCount" + } + }, + "LastStatusChange": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "LastStatusChange", + "smithy.api#documentation": "

The date and time of the last change in status.

", + "smithy.api#xmlName": "lastStatusChange" + } + }, + "OutsideIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutsideIpAddress", + "smithy.api#documentation": "

The Internet-routable IP address of the virtual private gateway's outside\n interface.

", + "smithy.api#xmlName": "outsideIpAddress" + } + }, + "Status": { + "target": "com.amazonaws.ec2#TelemetryStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status of the VPN tunnel.

", + "smithy.api#xmlName": "status" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

If an error occurs, a description of the error.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "CertificateArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CertificateArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate.

", + "smithy.api#xmlName": "certificateArn" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes telemetry for a VPN tunnel.

" + } + }, + "com.amazonaws.ec2#VgwTelemetryList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VgwTelemetry", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VirtualizationType": { + "type": "enum", + "members": { + "hvm": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hvm" + } + }, + "paravirtual": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "paravirtual" + } + } + } + }, + "com.amazonaws.ec2#VirtualizationTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VirtualizationType", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VirtualizationTypeSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VirtualizationType", + "traits": { + "smithy.api#xmlName": "item" + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, + "com.amazonaws.ec2#Volume": { + "type": "structure", + "members": { + "Attachments": { + "target": "com.amazonaws.ec2#VolumeAttachmentList", + "traits": { + "aws.protocols#ec2QueryName": "AttachmentSet", + "smithy.api#documentation": "

Information about the volume attachments.

", + "smithy.api#xmlName": "attachmentSet" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone for the volume.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "CreateTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreateTime", + "smithy.api#documentation": "

The time stamp when volume creation was initiated.

", + "smithy.api#xmlName": "createTime" + } + }, + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Encrypted", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the volume is encrypted.

", + "smithy.api#xmlName": "encrypted" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KmsKeyId", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the\n volume encryption key for the volume.

", + "smithy.api#xmlName": "kmsKeyId" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutpostArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

", + "smithy.api#xmlName": "outpostArn" + } + }, + "Size": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Size", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The size of the volume, in GiBs.

", + "smithy.api#xmlName": "size" + } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The snapshot from which the volume was created, if applicable.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "State": { + "target": "com.amazonaws.ec2#VolumeState", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The volume state.

", + "smithy.api#xmlName": "status" + } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VolumeId", + "smithy.api#documentation": "

The ID of the volume.

", + "smithy.api#xmlName": "volumeId" + } + }, + "Iops": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Iops", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents \n the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline \n performance of the volume and the rate at which the volume accumulates I/O credits for bursting.

", + "smithy.api#xmlName": "iops" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the volume.

", + "smithy.api#xmlName": "tagSet" + } + }, + "VolumeType": { + "target": "com.amazonaws.ec2#VolumeType", + "traits": { + "aws.protocols#ec2QueryName": "VolumeType", + "smithy.api#documentation": "

The volume type.

", + "smithy.api#xmlName": "volumeType" + } + }, + "FastRestored": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "FastRestored", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the volume was created using fast snapshot restore.

", + "smithy.api#xmlName": "fastRestored" + } + }, + "MultiAttachEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "MultiAttachEnabled", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether Amazon EBS Multi-Attach is enabled.

", + "smithy.api#xmlName": "multiAttachEnabled" + } + }, + "Throughput": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Throughput", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The throughput that the volume supports, in MiB/s.

", + "smithy.api#xmlName": "throughput" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a volume.

" + } + }, + "com.amazonaws.ec2#VolumeAttachment": { + "type": "structure", + "members": { + "AttachTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "AttachTime", + "smithy.api#documentation": "

The time stamp when the attachment initiated.

", + "smithy.api#xmlName": "attachTime" + } + }, + "Device": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Device", + "smithy.api#documentation": "

The device name.

", + "smithy.api#xmlName": "device" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "State": { + "target": "com.amazonaws.ec2#VolumeAttachmentState", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The attachment state of the volume.

", + "smithy.api#xmlName": "status" + } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VolumeId", + "smithy.api#documentation": "

The ID of the volume.

", + "smithy.api#xmlName": "volumeId" + } + }, + "DeleteOnTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DeleteOnTermination", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the EBS volume is deleted on instance termination.

", + "smithy.api#xmlName": "deleteOnTermination" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes volume attachment details.

" + } + }, + "com.amazonaws.ec2#VolumeAttachmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VolumeAttachment", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VolumeAttachmentState": { + "type": "enum", + "members": { + "attaching": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "attaching" + } + }, + "attached": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "attached" + } + }, + "detaching": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "detaching" + } + }, + "detached": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "detached" + } + }, + "busy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "busy" + } + } + } + }, + "com.amazonaws.ec2#VolumeAttributeName": { + "type": "enum", + "members": { + "autoEnableIO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "autoEnableIO" + } + }, + "productCodes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "productCodes" + } + } + } + }, + "com.amazonaws.ec2#VolumeDetail": { + "type": "structure", + "members": { + "Size": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "Size", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The size of the volume, in GiB.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "size" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an EBS volume.

" + } + }, + "com.amazonaws.ec2#VolumeId": { + "type": "string" + }, + "com.amazonaws.ec2#VolumeIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VolumeId", + "traits": { + "smithy.api#xmlName": "VolumeId" + } + } + }, + "com.amazonaws.ec2#VolumeIdWithResolver": { + "type": "string" + }, + "com.amazonaws.ec2#VolumeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Volume", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VolumeModification": { + "type": "structure", + "members": { + "VolumeId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VolumeId", + "smithy.api#documentation": "

The ID of the volume.

", + "smithy.api#xmlName": "volumeId" + } + }, + "ModificationState": { + "target": "com.amazonaws.ec2#VolumeModificationState", + "traits": { + "aws.protocols#ec2QueryName": "ModificationState", + "smithy.api#documentation": "

The current modification state. The modification state is null for unmodified\n volumes.

", + "smithy.api#xmlName": "modificationState" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

A status message about the modification progress or failure.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "TargetSize": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TargetSize", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The target size of the volume, in GiB.

", + "smithy.api#xmlName": "targetSize" + } + }, + "TargetIops": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TargetIops", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The target IOPS rate of the volume.

", + "smithy.api#xmlName": "targetIops" + } + }, + "TargetVolumeType": { + "target": "com.amazonaws.ec2#VolumeType", + "traits": { + "aws.protocols#ec2QueryName": "TargetVolumeType", + "smithy.api#documentation": "

The target EBS volume type of the volume.

", + "smithy.api#xmlName": "targetVolumeType" + } + }, + "TargetThroughput": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TargetThroughput", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The target throughput of the volume, in MiB/s.

", + "smithy.api#xmlName": "targetThroughput" + } + }, + "TargetMultiAttachEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "TargetMultiAttachEnabled", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

The target setting for Amazon EBS Multi-Attach.

", + "smithy.api#xmlName": "targetMultiAttachEnabled" + } + }, + "OriginalSize": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "OriginalSize", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The original size of the volume, in GiB.

", + "smithy.api#xmlName": "originalSize" + } + }, + "OriginalIops": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "OriginalIops", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The original IOPS rate of the volume.

", + "smithy.api#xmlName": "originalIops" + } + }, + "OriginalVolumeType": { + "target": "com.amazonaws.ec2#VolumeType", + "traits": { + "aws.protocols#ec2QueryName": "OriginalVolumeType", + "smithy.api#documentation": "

The original EBS volume type of the volume.

", + "smithy.api#xmlName": "originalVolumeType" + } + }, + "OriginalThroughput": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "OriginalThroughput", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The original throughput of the volume, in MiB/s.

", + "smithy.api#xmlName": "originalThroughput" + } + }, + "OriginalMultiAttachEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "OriginalMultiAttachEnabled", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

The original setting for Amazon EBS Multi-Attach.

", + "smithy.api#xmlName": "originalMultiAttachEnabled" + } + }, + "Progress": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "Progress", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The modification progress, from 0 to 100 percent complete.

", + "smithy.api#xmlName": "progress" + } + }, + "StartTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "StartTime", + "smithy.api#documentation": "

The modification start time.

", + "smithy.api#xmlName": "startTime" + } + }, + "EndTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "EndTime", + "smithy.api#documentation": "

The modification completion or failure time.

", + "smithy.api#xmlName": "endTime" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the modification status of an EBS volume.

\n

If the volume has never been modified, some element values will be null.

" + } + }, + "com.amazonaws.ec2#VolumeModificationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VolumeModification", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VolumeModificationState": { + "type": "enum", + "members": { + "modifying": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modifying" + } + }, + "optimizing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "optimizing" + } + }, + "completed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "completed" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + } + } + }, + "com.amazonaws.ec2#VolumeState": { + "type": "enum", + "members": { + "creating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "creating" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "in_use": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "in-use" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + }, + "error": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "error" + } + } + } + }, + "com.amazonaws.ec2#VolumeStatusAction": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The code identifying the operation, for example, enable-volume-io.

", + "smithy.api#xmlName": "code" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the operation.

", + "smithy.api#xmlName": "description" + } + }, + "EventId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "EventId", + "smithy.api#documentation": "

The ID of the event associated with this operation.

", + "smithy.api#xmlName": "eventId" + } + }, + "EventType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "EventType", + "smithy.api#documentation": "

The event type associated with this operation.

", + "smithy.api#xmlName": "eventType" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a volume status operation code.

" + } + }, + "com.amazonaws.ec2#VolumeStatusActionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VolumeStatusAction", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VolumeStatusAttachmentStatus": { + "type": "structure", + "members": { + "IoPerformance": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IoPerformance", + "smithy.api#documentation": "

The maximum IOPS supported by the attached instance.

", + "smithy.api#xmlName": "ioPerformance" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the attached instance.

", + "smithy.api#xmlName": "instanceId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the instances to which the volume is attached.

" + } + }, + "com.amazonaws.ec2#VolumeStatusAttachmentStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VolumeStatusAttachmentStatus", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VolumeStatusDetails": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.ec2#VolumeStatusName", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The name of the volume status.

", + "smithy.api#xmlName": "name" + } + }, + "Status": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The intended status of the volume status.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a volume status.

" + } + }, + "com.amazonaws.ec2#VolumeStatusDetailsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VolumeStatusDetails", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VolumeStatusEvent": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the event.

", + "smithy.api#xmlName": "description" + } + }, + "EventId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "EventId", + "smithy.api#documentation": "

The ID of this event.

", + "smithy.api#xmlName": "eventId" + } + }, + "EventType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "EventType", + "smithy.api#documentation": "

The type of this event.

", + "smithy.api#xmlName": "eventType" + } + }, + "NotAfter": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "NotAfter", + "smithy.api#documentation": "

The latest end time of the event.

", + "smithy.api#xmlName": "notAfter" + } + }, + "NotBefore": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "NotBefore", + "smithy.api#documentation": "

The earliest start time of the event.

", + "smithy.api#xmlName": "notBefore" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance associated with the event.

", + "smithy.api#xmlName": "instanceId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a volume status event.

" + } + }, + "com.amazonaws.ec2#VolumeStatusEventsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VolumeStatusEvent", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VolumeStatusInfo": { + "type": "structure", + "members": { + "Details": { + "target": "com.amazonaws.ec2#VolumeStatusDetailsList", + "traits": { + "aws.protocols#ec2QueryName": "Details", + "smithy.api#documentation": "

The details of the volume status.

", + "smithy.api#xmlName": "details" + } + }, + "Status": { + "target": "com.amazonaws.ec2#VolumeStatusInfoStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status of the volume.

", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the status of a volume.

" + } + }, + "com.amazonaws.ec2#VolumeStatusInfoStatus": { + "type": "enum", + "members": { + "ok": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ok" + } + }, + "impaired": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "impaired" + } + }, + "insufficient_data": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "insufficient-data" + } + } + } + }, + "com.amazonaws.ec2#VolumeStatusItem": { + "type": "structure", + "members": { + "Actions": { + "target": "com.amazonaws.ec2#VolumeStatusActionsList", + "traits": { + "aws.protocols#ec2QueryName": "ActionsSet", + "smithy.api#documentation": "

The details of the operation.

", + "smithy.api#xmlName": "actionsSet" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone of the volume.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutpostArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

", + "smithy.api#xmlName": "outpostArn" + } + }, + "Events": { + "target": "com.amazonaws.ec2#VolumeStatusEventsList", + "traits": { + "aws.protocols#ec2QueryName": "EventsSet", + "smithy.api#documentation": "

A list of events associated with the volume.

", + "smithy.api#xmlName": "eventsSet" + } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VolumeId", + "smithy.api#documentation": "

The volume ID.

", + "smithy.api#xmlName": "volumeId" + } + }, + "VolumeStatus": { + "target": "com.amazonaws.ec2#VolumeStatusInfo", + "traits": { + "aws.protocols#ec2QueryName": "VolumeStatus", + "smithy.api#documentation": "

The volume status.

", + "smithy.api#xmlName": "volumeStatus" + } + }, + "AttachmentStatuses": { + "target": "com.amazonaws.ec2#VolumeStatusAttachmentStatusList", + "traits": { + "aws.protocols#ec2QueryName": "AttachmentStatuses", + "smithy.api#documentation": "

Information about the instances to which the volume is attached.

", + "smithy.api#xmlName": "attachmentStatuses" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the volume status.

" + } + }, + "com.amazonaws.ec2#VolumeStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VolumeStatusItem", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VolumeStatusName": { + "type": "enum", + "members": { + "io_enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "io-enabled" + } + }, + "io_performance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "io-performance" + } + } + } + }, + "com.amazonaws.ec2#VolumeType": { + "type": "enum", + "members": { + "standard": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "standard" + } + }, + "io1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "io1" + } + }, + "io2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "io2" + } + }, + "gp2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "gp2" + } + }, + "sc1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sc1" + } + }, + "st1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "st1" + } + }, + "gp3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "gp3" + } + } + } + }, + "com.amazonaws.ec2#Vpc": { + "type": "structure", + "members": { + "CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrBlock", + "smithy.api#documentation": "

The primary IPv4 CIDR block for the VPC.

", + "smithy.api#xmlName": "cidrBlock" + } + }, + "DhcpOptionsId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DhcpOptionsId", + "smithy.api#documentation": "

The ID of the set of DHCP options you've associated with the VPC.

", + "smithy.api#xmlName": "dhcpOptionsId" + } + }, + "State": { + "target": "com.amazonaws.ec2#VpcState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the VPC.

", + "smithy.api#xmlName": "state" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the VPC.

", + "smithy.api#xmlName": "ownerId" + } + }, + "InstanceTenancy": { + "target": "com.amazonaws.ec2#Tenancy", + "traits": { + "aws.protocols#ec2QueryName": "InstanceTenancy", + "smithy.api#documentation": "

The allowed tenancy of instances launched into the VPC.

", + "smithy.api#xmlName": "instanceTenancy" + } + }, + "Ipv6CidrBlockAssociationSet": { + "target": "com.amazonaws.ec2#VpcIpv6CidrBlockAssociationSet", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrBlockAssociationSet", + "smithy.api#documentation": "

Information about the IPv6 CIDR blocks associated with the VPC.

", + "smithy.api#xmlName": "ipv6CidrBlockAssociationSet" + } + }, + "CidrBlockAssociationSet": { + "target": "com.amazonaws.ec2#VpcCidrBlockAssociationSet", + "traits": { + "aws.protocols#ec2QueryName": "CidrBlockAssociationSet", + "smithy.api#documentation": "

Information about the IPv4 CIDR blocks associated with the VPC.

", + "smithy.api#xmlName": "cidrBlockAssociationSet" + } + }, + "IsDefault": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "IsDefault", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the VPC is the default VPC.

", + "smithy.api#xmlName": "isDefault" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the VPC.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a VPC.

" + } + }, + "com.amazonaws.ec2#VpcAttachment": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.ec2#AttachmentStatus", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the attachment.

", + "smithy.api#xmlName": "state" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an attachment between a virtual private gateway and a VPC.

" + } + }, + "com.amazonaws.ec2#VpcAttachmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpcAttachment", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpcAttributeName": { + "type": "enum", + "members": { + "enableDnsSupport": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enableDnsSupport" + } + }, + "enableDnsHostnames": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enableDnsHostnames" + } + }, + "enableNetworkAddressUsageMetrics": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enableNetworkAddressUsageMetrics" + } + } + } + }, + "com.amazonaws.ec2#VpcCidrAssociationId": { + "type": "string" + }, + "com.amazonaws.ec2#VpcCidrBlockAssociation": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#documentation": "

The association ID for the IPv4 CIDR block.

", + "smithy.api#xmlName": "associationId" + } + }, + "CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrBlock", + "smithy.api#documentation": "

The IPv4 CIDR block.

", + "smithy.api#xmlName": "cidrBlock" + } + }, + "CidrBlockState": { + "target": "com.amazonaws.ec2#VpcCidrBlockState", + "traits": { + "aws.protocols#ec2QueryName": "CidrBlockState", + "smithy.api#documentation": "

Information about the state of the CIDR block.

", + "smithy.api#xmlName": "cidrBlockState" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an IPv4 CIDR block associated with a VPC.

" + } + }, + "com.amazonaws.ec2#VpcCidrBlockAssociationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpcCidrBlockAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpcCidrBlockState": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.ec2#VpcCidrBlockStateCode", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the CIDR block.

", + "smithy.api#xmlName": "state" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

A message about the status of the CIDR block, if applicable.

", + "smithy.api#xmlName": "statusMessage" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the state of a CIDR block.

" + } + }, + "com.amazonaws.ec2#VpcCidrBlockStateCode": { + "type": "enum", + "members": { + "associating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associating" + } + }, + "associated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associated" + } + }, + "disassociating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociating" + } + }, + "disassociated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociated" + } + }, + "failing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failing" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + } + } + }, + "com.amazonaws.ec2#VpcClassicLink": { + "type": "structure", + "members": { + "ClassicLinkEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "ClassicLinkEnabled", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the VPC is enabled for ClassicLink.

", + "smithy.api#xmlName": "classicLinkEnabled" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the VPC.

", + "smithy.api#xmlName": "tagSet" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } + } + }, + "traits": { + "smithy.api#documentation": "\n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n \n

Describes whether a VPC is enabled for ClassicLink.

" + } + }, + "com.amazonaws.ec2#VpcClassicLinkIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#xmlName": "VpcId" + } + } + }, + "com.amazonaws.ec2#VpcClassicLinkList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpcClassicLink", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpcEndpoint": { + "type": "structure", + "members": { + "VpcEndpointId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcEndpointId", + "smithy.api#documentation": "

The ID of the endpoint.

", + "smithy.api#xmlName": "vpcEndpointId" + } + }, + "VpcEndpointType": { + "target": "com.amazonaws.ec2#VpcEndpointType", + "traits": { + "aws.protocols#ec2QueryName": "VpcEndpointType", + "smithy.api#documentation": "

The type of endpoint.

", + "smithy.api#xmlName": "vpcEndpointType" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC to which the endpoint is associated.

", + "smithy.api#xmlName": "vpcId" + } + }, + "ServiceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ServiceName", + "smithy.api#documentation": "

The name of the service to which the endpoint is associated.

", + "smithy.api#xmlName": "serviceName" + } + }, + "State": { + "target": "com.amazonaws.ec2#State", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the endpoint.

", + "smithy.api#xmlName": "state" + } + }, + "PolicyDocument": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PolicyDocument", + "smithy.api#documentation": "

The policy document associated with the endpoint, if applicable.

", + "smithy.api#xmlName": "policyDocument" + } + }, + "RouteTableIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "RouteTableIdSet", + "smithy.api#documentation": "

(Gateway endpoint) The IDs of the route tables associated with the endpoint.

", + "smithy.api#xmlName": "routeTableIdSet" + } + }, + "SubnetIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "SubnetIdSet", + "smithy.api#documentation": "

(Interface endpoint) The subnets for the endpoint.

", + "smithy.api#xmlName": "subnetIdSet" + } + }, + "Groups": { + "target": "com.amazonaws.ec2#GroupIdentifierSet", + "traits": { + "aws.protocols#ec2QueryName": "GroupSet", + "smithy.api#documentation": "

(Interface endpoint) Information about the security groups that are associated with\n the network interface.

", + "smithy.api#xmlName": "groupSet" + } + }, + "IpAddressType": { + "target": "com.amazonaws.ec2#IpAddressType", + "traits": { + "aws.protocols#ec2QueryName": "IpAddressType", + "smithy.api#documentation": "

The IP address type for the endpoint.

", + "smithy.api#xmlName": "ipAddressType" + } + }, + "DnsOptions": { + "target": "com.amazonaws.ec2#DnsOptions", + "traits": { + "aws.protocols#ec2QueryName": "DnsOptions", + "smithy.api#documentation": "

The DNS options for the endpoint.

", + "smithy.api#xmlName": "dnsOptions" + } + }, + "PrivateDnsEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDnsEnabled", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

(Interface endpoint) Indicates whether the VPC is associated with a private hosted zone.

", + "smithy.api#xmlName": "privateDnsEnabled" + } + }, + "RequesterManaged": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "RequesterManaged", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the endpoint is being managed by its service.

", + "smithy.api#xmlName": "requesterManaged" + } + }, + "NetworkInterfaceIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceIdSet", + "smithy.api#documentation": "

(Interface endpoint) The network interfaces for the endpoint.

", + "smithy.api#xmlName": "networkInterfaceIdSet" + } + }, + "DnsEntries": { + "target": "com.amazonaws.ec2#DnsEntrySet", + "traits": { + "aws.protocols#ec2QueryName": "DnsEntrySet", + "smithy.api#documentation": "

(Interface endpoint) The DNS entries for the endpoint.

", + "smithy.api#xmlName": "dnsEntrySet" + } + }, + "CreationTimestamp": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreationTimestamp", + "smithy.api#documentation": "

The date and time that the endpoint was created.

", + "smithy.api#xmlName": "creationTimestamp" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the endpoint.

", + "smithy.api#xmlName": "tagSet" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the endpoint.

", + "smithy.api#xmlName": "ownerId" + } + }, + "LastError": { + "target": "com.amazonaws.ec2#LastError", + "traits": { + "aws.protocols#ec2QueryName": "LastError", + "smithy.api#documentation": "

The last error that occurred for endpoint.

", + "smithy.api#xmlName": "lastError" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a VPC endpoint.

" + } + }, + "com.amazonaws.ec2#VpcEndpointConnection": { + "type": "structure", + "members": { + "ServiceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ServiceId", + "smithy.api#documentation": "

The ID of the service to which the endpoint is connected.

", + "smithy.api#xmlName": "serviceId" + } + }, + "VpcEndpointId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcEndpointId", + "smithy.api#documentation": "

The ID of the VPC endpoint.

", + "smithy.api#xmlName": "vpcEndpointId" + } + }, + "VpcEndpointOwner": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcEndpointOwner", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the VPC endpoint.

", + "smithy.api#xmlName": "vpcEndpointOwner" + } + }, + "VpcEndpointState": { + "target": "com.amazonaws.ec2#State", + "traits": { + "aws.protocols#ec2QueryName": "VpcEndpointState", + "smithy.api#documentation": "

The state of the VPC endpoint.

", + "smithy.api#xmlName": "vpcEndpointState" + } + }, + "CreationTimestamp": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreationTimestamp", + "smithy.api#documentation": "

The date and time that the VPC endpoint was created.

", + "smithy.api#xmlName": "creationTimestamp" + } + }, + "DnsEntries": { + "target": "com.amazonaws.ec2#DnsEntrySet", + "traits": { + "aws.protocols#ec2QueryName": "DnsEntrySet", + "smithy.api#documentation": "

The DNS entries for the VPC endpoint.

", + "smithy.api#xmlName": "dnsEntrySet" + } + }, + "NetworkLoadBalancerArns": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "NetworkLoadBalancerArnSet", + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the network load balancers for the service.

", + "smithy.api#xmlName": "networkLoadBalancerArnSet" + } + }, + "GatewayLoadBalancerArns": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "GatewayLoadBalancerArnSet", + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.

", + "smithy.api#xmlName": "gatewayLoadBalancerArnSet" + } + }, + "IpAddressType": { + "target": "com.amazonaws.ec2#IpAddressType", + "traits": { + "aws.protocols#ec2QueryName": "IpAddressType", + "smithy.api#documentation": "

The IP address type for the endpoint.

", + "smithy.api#xmlName": "ipAddressType" + } + }, + "VpcEndpointConnectionId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcEndpointConnectionId", + "smithy.api#documentation": "

The ID of the VPC endpoint connection.

", + "smithy.api#xmlName": "vpcEndpointConnectionId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a VPC endpoint connection to a service.

" + } + }, + "com.amazonaws.ec2#VpcEndpointConnectionSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpcEndpointConnection", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpcEndpointId": { + "type": "string" + }, + "com.amazonaws.ec2#VpcEndpointIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpcEndpointId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpcEndpointRouteTableIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RouteTableId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpcEndpointSecurityGroupIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpcEndpointServiceId": { + "type": "string" + }, + "com.amazonaws.ec2#VpcEndpointServiceIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpcEndpointServiceId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpcEndpointSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpcEndpoint", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpcEndpointSubnetIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpcEndpointType": { + "type": "enum", + "members": { + "Interface": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Interface" + } + }, + "Gateway": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gateway" + } + }, + "GatewayLoadBalancer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GatewayLoadBalancer" + } + } + } + }, + "com.amazonaws.ec2#VpcFlowLogId": { + "type": "string" + }, + "com.amazonaws.ec2#VpcId": { + "type": "string" + }, + "com.amazonaws.ec2#VpcIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#xmlName": "VpcId" + } + } + }, + "com.amazonaws.ec2#VpcIpv6CidrBlockAssociation": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#documentation": "

The association ID for the IPv6 CIDR block.

", + "smithy.api#xmlName": "associationId" + } + }, + "Ipv6CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrBlock", + "smithy.api#documentation": "

The IPv6 CIDR block.

", + "smithy.api#xmlName": "ipv6CidrBlock" + } + }, + "Ipv6CidrBlockState": { + "target": "com.amazonaws.ec2#VpcCidrBlockState", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrBlockState", + "smithy.api#documentation": "

Information about the state of the CIDR block.

", + "smithy.api#xmlName": "ipv6CidrBlockState" + } + }, + "NetworkBorderGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkBorderGroup", + "smithy.api#documentation": "

The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from\n which Amazon Web Services advertises IP addresses, for example, us-east-1-wl1-bos-wlz-1.

", + "smithy.api#xmlName": "networkBorderGroup" + } + }, + "Ipv6Pool": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Pool", + "smithy.api#documentation": "

The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.

", + "smithy.api#xmlName": "ipv6Pool" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an IPv6 CIDR block associated with a VPC.

" + } + }, + "com.amazonaws.ec2#VpcIpv6CidrBlockAssociationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpcIpv6CidrBlockAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpcList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Vpc", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpcPeeringConnection": { + "type": "structure", + "members": { + "AccepterVpcInfo": { + "target": "com.amazonaws.ec2#VpcPeeringConnectionVpcInfo", + "traits": { + "aws.protocols#ec2QueryName": "AccepterVpcInfo", + "smithy.api#documentation": "

Information about the accepter VPC. CIDR block information is only returned when describing an active VPC peering connection.

", + "smithy.api#xmlName": "accepterVpcInfo" + } + }, + "ExpirationTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "ExpirationTime", + "smithy.api#documentation": "

The time that an unaccepted VPC peering connection will expire.

", + "smithy.api#xmlName": "expirationTime" + } + }, + "RequesterVpcInfo": { + "target": "com.amazonaws.ec2#VpcPeeringConnectionVpcInfo", + "traits": { + "aws.protocols#ec2QueryName": "RequesterVpcInfo", + "smithy.api#documentation": "

Information about the requester VPC. CIDR block information is only returned when describing an active VPC peering connection.

", + "smithy.api#xmlName": "requesterVpcInfo" + } + }, + "Status": { + "target": "com.amazonaws.ec2#VpcPeeringConnectionStateReason", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status of the VPC peering connection.

", + "smithy.api#xmlName": "status" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the resource.

", + "smithy.api#xmlName": "tagSet" + } + }, + "VpcPeeringConnectionId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", + "smithy.api#documentation": "

The ID of the VPC peering connection.

", + "smithy.api#xmlName": "vpcPeeringConnectionId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a VPC peering connection.

" + } + }, + "com.amazonaws.ec2#VpcPeeringConnectionId": { + "type": "string" + }, + "com.amazonaws.ec2#VpcPeeringConnectionIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpcPeeringConnectionId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpcPeeringConnectionIdWithResolver": { + "type": "string" + }, + "com.amazonaws.ec2#VpcPeeringConnectionList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpcPeeringConnection", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpcPeeringConnectionOptionsDescription": { + "type": "structure", + "members": { + "AllowDnsResolutionFromRemoteVpc": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AllowDnsResolutionFromRemoteVpc", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.

", + "smithy.api#xmlName": "allowDnsResolutionFromRemoteVpc" + } + }, + "AllowEgressFromLocalClassicLinkToRemoteVpc": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AllowEgressFromLocalClassicLinkToRemoteVpc", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.

", + "smithy.api#xmlName": "allowEgressFromLocalClassicLinkToRemoteVpc" + } + }, + "AllowEgressFromLocalVpcToRemoteClassicLink": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AllowEgressFromLocalVpcToRemoteClassicLink", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.

", + "smithy.api#xmlName": "allowEgressFromLocalVpcToRemoteClassicLink" + } + } + }, + "traits": { + "smithy.api#documentation": "\n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n \n

Describes the VPC peering connection options.

" + } + }, + "com.amazonaws.ec2#VpcPeeringConnectionStateReason": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.ec2#VpcPeeringConnectionStateReasonCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The status of the VPC peering connection.

", + "smithy.api#xmlName": "code" + } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

A message that provides more information about the status, if applicable.

", + "smithy.api#xmlName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the status of a VPC peering connection.

" + } + }, + "com.amazonaws.ec2#VpcPeeringConnectionStateReasonCode": { + "type": "enum", + "members": { + "initiating_request": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "initiating-request" + } + }, + "pending_acceptance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending-acceptance" + } + }, + "active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + }, + "rejected": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rejected" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "expired": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "expired" + } + }, + "provisioning": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "provisioning" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + } + } + }, + "com.amazonaws.ec2#VpcPeeringConnectionVpcInfo": { + "type": "structure", + "members": { + "CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrBlock", + "smithy.api#documentation": "

The IPv4 CIDR block for the VPC.

", + "smithy.api#xmlName": "cidrBlock" + } + }, + "Ipv6CidrBlockSet": { + "target": "com.amazonaws.ec2#Ipv6CidrBlockSet", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrBlockSet", + "smithy.api#documentation": "

The IPv6 CIDR block for the VPC.

", + "smithy.api#xmlName": "ipv6CidrBlockSet" + } + }, + "CidrBlockSet": { + "target": "com.amazonaws.ec2#CidrBlockSet", + "traits": { + "aws.protocols#ec2QueryName": "CidrBlockSet", + "smithy.api#documentation": "

Information about the IPv4 CIDR blocks for the VPC.

", + "smithy.api#xmlName": "cidrBlockSet" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the VPC.

", + "smithy.api#xmlName": "ownerId" + } + }, + "PeeringOptions": { + "target": "com.amazonaws.ec2#VpcPeeringConnectionOptionsDescription", + "traits": { + "aws.protocols#ec2QueryName": "PeeringOptions", + "smithy.api#documentation": "

Information about the VPC peering connection options for the accepter or requester VPC.

", + "smithy.api#xmlName": "peeringOptions" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } + }, + "Region": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Region", + "smithy.api#documentation": "

The Region in which the VPC is located.

", + "smithy.api#xmlName": "region" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a VPC in a VPC peering connection.

" + } + }, + "com.amazonaws.ec2#VpcState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + } + } + }, + "com.amazonaws.ec2#VpcTenancy": { + "type": "enum", + "members": { + "default": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "default" + } + } + } + }, + "com.amazonaws.ec2#VpnConnection": { + "type": "structure", + "members": { + "CustomerGatewayConfiguration": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CustomerGatewayConfiguration", + "smithy.api#documentation": "

The configuration information for the VPN connection's customer gateway (in the native\n XML format). This element is always present in the CreateVpnConnection\n response; however, it's present in the DescribeVpnConnections response\n only if the VPN connection is in the pending or available\n state.

", + "smithy.api#xmlName": "customerGatewayConfiguration" + } + }, + "CustomerGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CustomerGatewayId", + "smithy.api#documentation": "

The ID of the customer gateway at your end of the VPN connection.

", + "smithy.api#xmlName": "customerGatewayId" + } + }, + "Category": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Category", + "smithy.api#documentation": "

The category of the VPN connection. A value of VPN indicates an Amazon Web Services VPN connection. A value of VPN-Classic indicates an Amazon Web Services Classic VPN connection.

", + "smithy.api#xmlName": "category" + } + }, + "State": { + "target": "com.amazonaws.ec2#VpnState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the VPN connection.

", + "smithy.api#xmlName": "state" + } + }, + "Type": { + "target": "com.amazonaws.ec2#GatewayType", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The type of VPN connection.

", + "smithy.api#xmlName": "type" + } + }, + "VpnConnectionId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpnConnectionId", + "smithy.api#documentation": "

The ID of the VPN connection.

", + "smithy.api#xmlName": "vpnConnectionId" + } + }, + "VpnGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpnGatewayId", + "smithy.api#documentation": "

The ID of the virtual private gateway at the Amazon Web Services side of the VPN\n connection.

", + "smithy.api#xmlName": "vpnGatewayId" + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayId", + "smithy.api#documentation": "

The ID of the transit gateway associated with the VPN connection.

", + "smithy.api#xmlName": "transitGatewayId" + } + }, + "CoreNetworkArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CoreNetworkArn", + "smithy.api#documentation": "

The ARN of the core network.

", + "smithy.api#xmlName": "coreNetworkArn" + } + }, + "CoreNetworkAttachmentArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CoreNetworkAttachmentArn", + "smithy.api#documentation": "

The ARN of the core network attachment.

", + "smithy.api#xmlName": "coreNetworkAttachmentArn" + } + }, + "GatewayAssociationState": { + "target": "com.amazonaws.ec2#GatewayAssociationState", + "traits": { + "aws.protocols#ec2QueryName": "GatewayAssociationState", + "smithy.api#documentation": "

The current state of the gateway association.

", + "smithy.api#xmlName": "gatewayAssociationState" + } + }, + "Options": { + "target": "com.amazonaws.ec2#VpnConnectionOptions", + "traits": { + "aws.protocols#ec2QueryName": "Options", + "smithy.api#documentation": "

The VPN connection options.

", + "smithy.api#xmlName": "options" + } + }, + "Routes": { + "target": "com.amazonaws.ec2#VpnStaticRouteList", + "traits": { + "aws.protocols#ec2QueryName": "Routes", + "smithy.api#documentation": "

The static routes associated with the VPN connection.

", + "smithy.api#xmlName": "routes" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the VPN connection.

", + "smithy.api#xmlName": "tagSet" + } + }, + "VgwTelemetry": { + "target": "com.amazonaws.ec2#VgwTelemetryList", + "traits": { + "aws.protocols#ec2QueryName": "VgwTelemetry", + "smithy.api#documentation": "

Information about the VPN tunnel.

", + "smithy.api#xmlName": "vgwTelemetry" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a VPN connection.

" + } + }, + "com.amazonaws.ec2#VpnConnectionDeviceSampleConfiguration": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.ec2#VpnConnectionDeviceType": { + "type": "structure", + "members": { + "VpnConnectionDeviceTypeId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpnConnectionDeviceTypeId", + "smithy.api#documentation": "

Customer gateway device identifier.

", + "smithy.api#xmlName": "vpnConnectionDeviceTypeId" + } + }, + "Vendor": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Vendor", + "smithy.api#documentation": "

Customer gateway device vendor.

", + "smithy.api#xmlName": "vendor" + } + }, + "Platform": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Platform", + "smithy.api#documentation": "

Customer gateway device platform.

", + "smithy.api#xmlName": "platform" + } + }, + "Software": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Software", + "smithy.api#documentation": "

Customer gateway device software version.

", + "smithy.api#xmlName": "software" + } + } + }, + "traits": { + "smithy.api#documentation": "

List of customer gateway devices that have a sample configuration file available for\n use. You can also see the list of device types with sample configuration files available\n under Your customer\n gateway device in the Amazon Web Services Site-to-Site VPN User Guide.

" + } + }, + "com.amazonaws.ec2#VpnConnectionDeviceTypeId": { + "type": "string" + }, + "com.amazonaws.ec2#VpnConnectionDeviceTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpnConnectionDeviceType", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpnConnectionId": { + "type": "string" + }, + "com.amazonaws.ec2#VpnConnectionIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpnConnectionId", + "traits": { + "smithy.api#xmlName": "VpnConnectionId" + } + } + }, + "com.amazonaws.ec2#VpnConnectionList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpnConnection", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpnConnectionOptions": { + "type": "structure", + "members": { + "EnableAcceleration": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnableAcceleration", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether acceleration is enabled for the VPN connection.

", + "smithy.api#xmlName": "enableAcceleration" + } + }, + "StaticRoutesOnly": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "StaticRoutesOnly", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the VPN connection uses static routes only. Static routes must be\n used for devices that don't support BGP.

", + "smithy.api#xmlName": "staticRoutesOnly" + } + }, + "LocalIpv4NetworkCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LocalIpv4NetworkCidr", + "smithy.api#documentation": "

The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.

", + "smithy.api#xmlName": "localIpv4NetworkCidr" + } + }, + "RemoteIpv4NetworkCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RemoteIpv4NetworkCidr", + "smithy.api#documentation": "

The IPv4 CIDR on the Amazon Web Services side of the VPN connection.

", + "smithy.api#xmlName": "remoteIpv4NetworkCidr" + } + }, + "LocalIpv6NetworkCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LocalIpv6NetworkCidr", + "smithy.api#documentation": "

The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.

", + "smithy.api#xmlName": "localIpv6NetworkCidr" + } + }, + "RemoteIpv6NetworkCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RemoteIpv6NetworkCidr", + "smithy.api#documentation": "

The IPv6 CIDR on the Amazon Web Services side of the VPN connection.

", + "smithy.api#xmlName": "remoteIpv6NetworkCidr" + } + }, + "OutsideIpAddressType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutsideIpAddressType", + "smithy.api#documentation": "

The type of IPv4 address assigned to the outside interface of the customer gateway.

\n

Valid values: PrivateIpv4 | PublicIpv4\n

\n

Default: PublicIpv4\n

", + "smithy.api#xmlName": "outsideIpAddressType" + } + }, + "TransportTransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransportTransitGatewayAttachmentId", + "smithy.api#documentation": "

The transit gateway attachment ID in use for the VPN tunnel.

", + "smithy.api#xmlName": "transportTransitGatewayAttachmentId" + } + }, + "TunnelInsideIpVersion": { + "target": "com.amazonaws.ec2#TunnelInsideIpVersion", + "traits": { + "aws.protocols#ec2QueryName": "TunnelInsideIpVersion", + "smithy.api#documentation": "

Indicates whether the VPN tunnels process IPv4 or IPv6 traffic.

", + "smithy.api#xmlName": "tunnelInsideIpVersion" + } + }, + "TunnelOptions": { + "target": "com.amazonaws.ec2#TunnelOptionsList", + "traits": { + "aws.protocols#ec2QueryName": "TunnelOptionSet", + "smithy.api#documentation": "

Indicates the VPN tunnel options.

", + "smithy.api#xmlName": "tunnelOptionSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes VPN connection options.

" + } + }, + "com.amazonaws.ec2#VpnConnectionOptionsSpecification": { + "type": "structure", + "members": { + "EnableAcceleration": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicate whether to enable acceleration for the VPN connection.

\n

Default: false\n

" + } + }, + "StaticRoutesOnly": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "StaticRoutesOnly", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Indicate whether the VPN connection uses static routes only. If you are creating a VPN\n connection for a device that does not support BGP, you must specify true.\n Use CreateVpnConnectionRoute to create a static route.

\n

Default: false\n

", + "smithy.api#xmlName": "staticRoutesOnly" + } + }, + "TunnelInsideIpVersion": { + "target": "com.amazonaws.ec2#TunnelInsideIpVersion", + "traits": { + "smithy.api#documentation": "

Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.

\n

Default: ipv4\n

" + } + }, + "TunnelOptions": { + "target": "com.amazonaws.ec2#VpnTunnelOptionsSpecificationsList", + "traits": { + "smithy.api#documentation": "

The tunnel options for the VPN connection.

" + } + }, + "LocalIpv4NetworkCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.

\n

Default: 0.0.0.0/0\n

" + } + }, + "RemoteIpv4NetworkCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv4 CIDR on the Amazon Web Services side of the VPN connection.

\n

Default: 0.0.0.0/0\n

" + } + }, + "LocalIpv6NetworkCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.

\n

Default: ::/0\n

" + } + }, + "RemoteIpv6NetworkCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv6 CIDR on the Amazon Web Services side of the VPN connection.

\n

Default: ::/0\n

" + } + }, + "OutsideIpAddressType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The type of IPv4 address assigned to the outside interface of the customer gateway device.

\n

Valid values: PrivateIpv4 | PublicIpv4\n

\n

Default: PublicIpv4\n

" + } + }, + "TransportTransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#documentation": "

The transit gateway attachment ID to use for the VPN tunnel.

\n

Required if OutsideIpAddressType is set to PrivateIpv4.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes VPN connection options.

" + } + }, + "com.amazonaws.ec2#VpnEcmpSupportValue": { + "type": "enum", + "members": { + "enable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enable" + } + }, + "disable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disable" + } + } + } + }, + "com.amazonaws.ec2#VpnGateway": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone where the virtual private gateway was created, if applicable.\n This field may be empty or not returned.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "State": { + "target": "com.amazonaws.ec2#VpnState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the virtual private gateway.

", + "smithy.api#xmlName": "state" + } + }, + "Type": { + "target": "com.amazonaws.ec2#GatewayType", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The type of VPN connection the virtual private gateway supports.

", + "smithy.api#xmlName": "type" + } + }, + "VpcAttachments": { + "target": "com.amazonaws.ec2#VpcAttachmentList", + "traits": { + "aws.protocols#ec2QueryName": "Attachments", + "smithy.api#documentation": "

Any VPCs attached to the virtual private gateway.

", + "smithy.api#xmlName": "attachments" + } + }, + "VpnGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpnGatewayId", + "smithy.api#documentation": "

The ID of the virtual private gateway.

", + "smithy.api#xmlName": "vpnGatewayId" + } + }, + "AmazonSideAsn": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "AmazonSideAsn", + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The private Autonomous System Number (ASN) for the Amazon side of a BGP\n session.

", + "smithy.api#xmlName": "amazonSideAsn" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the virtual private gateway.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a virtual private gateway.

" + } + }, + "com.amazonaws.ec2#VpnGatewayId": { + "type": "string" + }, + "com.amazonaws.ec2#VpnGatewayIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpnGatewayId", + "traits": { + "smithy.api#xmlName": "VpnGatewayId" + } + } + }, + "com.amazonaws.ec2#VpnGatewayList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpnGateway", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpnProtocol": { + "type": "enum", + "members": { + "openvpn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "openvpn" + } + } + } + }, + "com.amazonaws.ec2#VpnState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + } + } + }, + "com.amazonaws.ec2#VpnStaticRoute": { + "type": "structure", + "members": { + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationCidrBlock", + "smithy.api#documentation": "

The CIDR block associated with the local subnet of the customer data center.

", + "smithy.api#xmlName": "destinationCidrBlock" + } + }, + "Source": { + "target": "com.amazonaws.ec2#VpnStaticRouteSource", + "traits": { + "aws.protocols#ec2QueryName": "Source", + "smithy.api#documentation": "

Indicates how the routes were provided.

", + "smithy.api#xmlName": "source" + } + }, + "State": { + "target": "com.amazonaws.ec2#VpnState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the static route.

", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a static route for a VPN connection.

" + } + }, + "com.amazonaws.ec2#VpnStaticRouteList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpnStaticRoute", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#VpnStaticRouteSource": { + "type": "enum", + "members": { + "Static": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Static" + } + } + } + }, + "com.amazonaws.ec2#VpnTunnelLogOptions": { + "type": "structure", + "members": { + "CloudWatchLogOptions": { + "target": "com.amazonaws.ec2#CloudWatchLogOptions", + "traits": { + "aws.protocols#ec2QueryName": "CloudWatchLogOptions", + "smithy.api#documentation": "

Options for sending VPN tunnel logs to CloudWatch.

", + "smithy.api#xmlName": "cloudWatchLogOptions" + } + } + }, + "traits": { + "smithy.api#documentation": "

Options for logging VPN tunnel activity.

" + } + }, + "com.amazonaws.ec2#VpnTunnelLogOptionsSpecification": { + "type": "structure", + "members": { + "CloudWatchLogOptions": { + "target": "com.amazonaws.ec2#CloudWatchLogOptionsSpecification", + "traits": { + "smithy.api#documentation": "

Options for sending VPN tunnel logs to CloudWatch.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Options for logging VPN tunnel activity.

" + } + }, + "com.amazonaws.ec2#VpnTunnelOptionsSpecification": { + "type": "structure", + "members": { + "TunnelInsideCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be\n unique across all VPN connections that use the same virtual private gateway.

\n

Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The\n following CIDR blocks are reserved and cannot be used:

\n " + } + }, + "TunnelInsideIpv6Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be\n unique across all VPN connections that use the same transit gateway.

\n

Constraints: A size /126 CIDR block from the local fd00::/8 range.

" + } + }, + "PreSharedKey": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The pre-shared key (PSK) to establish initial authentication between the virtual\n private gateway and customer gateway.

\n

Constraints: Allowed characters are alphanumeric characters, periods (.), and\n underscores (_). Must be between 8 and 64 characters in length and cannot start with\n zero (0).

" + } + }, + "Phase1LifetimeSeconds": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The lifetime for phase 1 of the IKE negotiation, in seconds.

\n

Constraints: A value between 900 and 28,800.

\n

Default: 28800\n

" + } + }, + "Phase2LifetimeSeconds": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The lifetime for phase 2 of the IKE negotiation, in seconds.

\n

Constraints: A value between 900 and 3,600. The value must be less than the value for\n Phase1LifetimeSeconds.

\n

Default: 3600\n

" + } + }, + "RekeyMarginTimeSeconds": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The margin time, in seconds, before the phase 2 lifetime expires, during which the\n Amazon Web Services side of the VPN connection performs an IKE rekey. The exact time\n of the rekey is randomly selected based on the value for\n RekeyFuzzPercentage.

\n

Constraints: A value between 60 and half of Phase2LifetimeSeconds.

\n

Default: 540\n

" + } + }, + "RekeyFuzzPercentage": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The percentage of the rekey window (determined by RekeyMarginTimeSeconds)\n during which the rekey time is randomly selected.

\n

Constraints: A value between 0 and 100.

\n

Default: 100\n

" + } + }, + "ReplayWindowSize": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of packets in an IKE replay window.

\n

Constraints: A value between 64 and 2048.

\n

Default: 1024\n

" + } + }, + "DPDTimeoutSeconds": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of seconds after which a DPD timeout occurs.

\n

Constraints: A value greater than or equal to 30.

\n

Default: 30\n

" + } + }, + "DPDTimeoutAction": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The action to take after DPD timeout occurs. Specify restart to restart\n the IKE initiation. Specify clear to end the IKE session.

\n

Valid Values: clear | none | restart\n

\n

Default: clear\n

" + } + }, + "Phase1EncryptionAlgorithms": { + "target": "com.amazonaws.ec2#Phase1EncryptionAlgorithmsRequestList", + "traits": { + "smithy.api#documentation": "

One or more encryption algorithms that are permitted for the VPN tunnel for phase 1\n IKE negotiations.

\n

Valid values: AES128 | AES256 | AES128-GCM-16 |\n AES256-GCM-16\n

", + "smithy.api#xmlName": "Phase1EncryptionAlgorithm" + } + }, + "Phase2EncryptionAlgorithms": { + "target": "com.amazonaws.ec2#Phase2EncryptionAlgorithmsRequestList", + "traits": { + "smithy.api#documentation": "

One or more encryption algorithms that are permitted for the VPN tunnel for phase 2\n IKE negotiations.

\n

Valid values: AES128 | AES256 | AES128-GCM-16 |\n AES256-GCM-16\n

", + "smithy.api#xmlName": "Phase2EncryptionAlgorithm" + } + }, + "Phase1IntegrityAlgorithms": { + "target": "com.amazonaws.ec2#Phase1IntegrityAlgorithmsRequestList", + "traits": { + "smithy.api#documentation": "

One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE\n negotiations.

\n

Valid values: SHA1 | SHA2-256 | SHA2-384 |\n SHA2-512\n

", + "smithy.api#xmlName": "Phase1IntegrityAlgorithm" + } + }, + "Phase2IntegrityAlgorithms": { + "target": "com.amazonaws.ec2#Phase2IntegrityAlgorithmsRequestList", + "traits": { + "smithy.api#documentation": "

One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE\n negotiations.

\n

Valid values: SHA1 | SHA2-256 | SHA2-384 |\n SHA2-512\n

", + "smithy.api#xmlName": "Phase2IntegrityAlgorithm" + } + }, + "Phase1DHGroupNumbers": { + "target": "com.amazonaws.ec2#Phase1DHGroupNumbersRequestList", + "traits": { + "smithy.api#documentation": "

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for\n phase 1 IKE negotiations.

\n

Valid values: 2 | 14 | 15 | 16 |\n 17 | 18 | 19 | 20 |\n 21 | 22 | 23 | 24\n

", + "smithy.api#xmlName": "Phase1DHGroupNumber" + } + }, + "Phase2DHGroupNumbers": { + "target": "com.amazonaws.ec2#Phase2DHGroupNumbersRequestList", + "traits": { + "smithy.api#documentation": "

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for\n phase 2 IKE negotiations.

\n

Valid values: 2 | 5 | 14 | 15 |\n 16 | 17 | 18 | 19 |\n 20 | 21 | 22 | 23 |\n 24\n

", + "smithy.api#xmlName": "Phase2DHGroupNumber" + } + }, + "IKEVersions": { + "target": "com.amazonaws.ec2#IKEVersionsRequestList", + "traits": { + "smithy.api#documentation": "

The IKE versions that are permitted for the VPN tunnel.

\n

Valid values: ikev1 | ikev2\n

", + "smithy.api#xmlName": "IKEVersion" + } + }, + "StartupAction": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The action to take when the establishing the tunnel for the VPN connection. By\n default, your customer gateway device must initiate the IKE negotiation and bring up the\n tunnel. Specify start for Amazon Web Services to initiate the IKE\n negotiation.

\n

Valid Values: add | start\n

\n

Default: add\n

" + } + }, + "LogOptions": { + "target": "com.amazonaws.ec2#VpnTunnelLogOptionsSpecification", + "traits": { + "smithy.api#documentation": "

Options for logging VPN tunnel activity.

" + } + }, + "EnableTunnelLifecycleControl": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Turn on or off tunnel endpoint lifecycle control feature.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The tunnel options for a single VPN tunnel.

" + } + }, + "com.amazonaws.ec2#VpnTunnelOptionsSpecificationsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#VpnTunnelOptionsSpecification" + } + }, + "com.amazonaws.ec2#WeekDay": { + "type": "enum", + "members": { + "sunday": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sunday" + } + }, + "monday": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "monday" + } + }, + "tuesday": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tuesday" + } + }, + "wednesday": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "wednesday" + } + }, + "thursday": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "thursday" + } + }, + "friday": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "friday" + } + }, + "saturday": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "saturday" + } + } + } + }, + "com.amazonaws.ec2#WithdrawByoipCidr": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#WithdrawByoipCidrRequest" + }, + "output": { + "target": "com.amazonaws.ec2#WithdrawByoipCidrResult" + }, + "traits": { + "smithy.api#documentation": "

Stops advertising an address range that is provisioned as an address pool.

\n

You can perform this operation at most once every 10 seconds, even if you specify different \n address ranges each time.

\n

It can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services\n because of BGP propagation delays.

" + } + }, + "com.amazonaws.ec2#WithdrawByoipCidrRequest": { + "type": "structure", + "members": { + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The address range, in CIDR notation.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#WithdrawByoipCidrResult": { + "type": "structure", + "members": { + "ByoipCidr": { + "target": "com.amazonaws.ec2#ByoipCidr", + "traits": { + "aws.protocols#ec2QueryName": "ByoipCidr", + "smithy.api#documentation": "

Information about the address pool.

", + "smithy.api#xmlName": "byoipCidr" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#ZoneIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "ZoneId" + } + } + }, + "com.amazonaws.ec2#ZoneNameStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "ZoneName" + } + } + }, + "com.amazonaws.ec2#scope": { + "type": "enum", + "members": { + "AVAILABILITY_ZONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Availability Zone" + } + }, + "REGIONAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Region" + } + } + } + }, + "com.amazonaws.ec2#snapshotTierStatusSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SnapshotTierStatus", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#totalFpgaMemory": { + "type": "integer" + }, + "com.amazonaws.ec2#totalGpuMemory": { + "type": "integer" } - } - }, - "com.amazonaws.ec2#totalFpgaMemory": { - "type": "integer" - }, - "com.amazonaws.ec2#totalGpuMemory": { - "type": "integer" } - } } diff --git a/codegen/sdk-codegen/aws-models/imagebuilder.json b/codegen/sdk-codegen/aws-models/imagebuilder.json index 3ec9726c289e..98d05828ce07 100644 --- a/codegen/sdk-codegen/aws-models/imagebuilder.json +++ b/codegen/sdk-codegen/aws-models/imagebuilder.json @@ -1,11139 +1,11139 @@ { - "smithy": "2.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] - }, - "shapes": { - "com.amazonaws.imagebuilder#AccountAggregation": { - "type": "structure", - "members": { - "accountId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Identifies the account that owns the aggregated resource findings.

" - } - }, - "severityCounts": { - "target": "com.amazonaws.imagebuilder#SeverityCounts", - "traits": { - "smithy.api#documentation": "

Counts by severity level for medium severity and higher level findings, plus a total\n\t\t\tfor all of the findings.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains counts of vulnerability findings from image scans that run when you create\n\t\t\tnew Image Builder images, or build new versions of existing images. The vulnerability counts are\n\t\t\tgrouped by severity level. The counts are aggregated across resources to create the\n\t\t\tfinal tally for the account that owns them.

" - } - }, - "com.amazonaws.imagebuilder#AccountId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[0-9]{12}$" - } - }, - "com.amazonaws.imagebuilder#AccountList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#AccountId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1536 - } - } - }, - "com.amazonaws.imagebuilder#AdditionalInstanceConfiguration": { - "type": "structure", - "members": { - "systemsManagerAgent": { - "target": "com.amazonaws.imagebuilder#SystemsManagerAgent", - "traits": { - "smithy.api#documentation": "

Contains settings for the Systems Manager agent on your build instance.

" - } - }, - "userDataOverride": { - "target": "com.amazonaws.imagebuilder#UserDataOverride", - "traits": { - "smithy.api#documentation": "

Use this property to provide commands or a command script to run when you launch your\n\t\t\tbuild instance.

\n

The userDataOverride property replaces any commands that Image Builder might have added to\n\t\t\tensure that Systems Manager is installed on your Linux build instance. If you override the user\n\t\t\tdata, make sure that you add commands to install Systems Manager, if it is not pre-installed on\n\t\t\tyour base image.

\n \n

The user data is always base 64 encoded. For example, the following commands are\n\t\t\t\tencoded as\n\t\t\t\tIyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$:

\n

\n #!/bin/bash\n

\n

mkdir -p /var/bb/

\n

touch /var

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

In addition to your infrastructure configuration, these settings provide an extra\n\t\t\tlayer of control over your build instances. You can also specify commands to run on\n\t\t\tlaunch for all of your build instances.

\n

Image Builder does not automatically install the Systems Manager agent on Windows instances. If your base\n\t\t\timage includes the Systems Manager agent, then the AMI that you create will also include the\n\t\t\tagent. For Linux instances, if the base image does not already include the Systems Manager agent,\n\t\t\tImage Builder installs it. For Linux instances where Image Builder installs the Systems Manager agent, you can\n\t\t\tchoose whether to keep it for the AMI that you create.

" - } - }, - "com.amazonaws.imagebuilder#Ami": { - "type": "structure", - "members": { - "region": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region of the Amazon EC2 AMI.

" - } - }, - "image": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The AMI ID of the Amazon EC2 AMI.

" - } - }, - "name": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the Amazon EC2 AMI.

" - } - }, - "description": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The description of the Amazon EC2 AMI. Minimum and maximum length are in characters.

" - } - }, - "state": { - "target": "com.amazonaws.imagebuilder#ImageState" - }, - "accountId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The account ID of the owner of the AMI.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details of an Amazon EC2 AMI.

" - } - }, - "com.amazonaws.imagebuilder#AmiDistributionConfiguration": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.imagebuilder#AmiNameString", - "traits": { - "smithy.api#documentation": "

The name of the output AMI.

" - } - }, - "description": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The description of the AMI distribution configuration. Minimum and maximum length are\n\t\t\tin characters.

" - } - }, - "targetAccountIds": { - "target": "com.amazonaws.imagebuilder#AccountList", - "traits": { - "smithy.api#documentation": "

The ID of an account to which you want to distribute an image.

" - } - }, - "amiTags": { - "target": "com.amazonaws.imagebuilder#TagMap", - "traits": { - "smithy.api#documentation": "

The tags to apply to AMIs distributed to this Region.

" - } - }, - "kmsKeyId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The KMS key identifier used to encrypt the distributed image.

" - } - }, - "launchPermission": { - "target": "com.amazonaws.imagebuilder#LaunchPermissionConfiguration", - "traits": { - "smithy.api#documentation": "

Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to\n\t\t\tlaunch instances.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Define and configure the output AMIs of the pipeline.

" - } - }, - "com.amazonaws.imagebuilder#AmiList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#Ami" - } - }, - "com.amazonaws.imagebuilder#AmiNameString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 127 - }, - "smithy.api#pattern": "^[-_A-Za-z0-9{][-_A-Za-z0-9\\s:{}\\.]+[-_A-Za-z0-9}]$" - } - }, - "com.amazonaws.imagebuilder#Arn": { - "type": "string" - }, - "com.amazonaws.imagebuilder#Boolean": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.imagebuilder#BuildType": { - "type": "enum", - "members": { - "USER_INITIATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "USER_INITIATED" - } - }, - "SCHEDULED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SCHEDULED" - } - }, - "IMPORT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IMPORT" - } - } - } - }, - "com.amazonaws.imagebuilder#CallRateLimitExceededException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.imagebuilder#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

You have exceeded the permitted request rate for the specific operation.

", - "smithy.api#error": "client", - "smithy.api#httpError": 429 - } - }, - "com.amazonaws.imagebuilder#CancelImageCreation": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#CancelImageCreationRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#CancelImageCreationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ResourceInUseException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

CancelImageCreation cancels the creation of Image. This operation can only be used on\n\t\t\timages in a non-terminal state.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/CancelImageCreation", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#CancelImageCreationRequest": { - "type": "structure", - "members": { - "imageBuildVersionArn": { - "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image that you want to cancel creation\n\t\t\tfor.

", - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure\n idempotency of the request. For more information, see Ensuring idempotency \n in the Amazon EC2 API Reference.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#CancelImageCreationResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", - "traits": { - "smithy.api#documentation": "

The idempotency token that was used for this request.

" - } - }, - "imageBuildVersionArn": { - "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", - "traits": { - "smithy.api#documentation": "

The ARN of the image whose creation this request canceled.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#ClientException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.imagebuilder#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

These errors are usually caused by a client action, such as using an action or\n\t\t\tresource on behalf of a user that doesn't have permissions to use the action or\n\t\t\tresource, or specifying an invalid resource identifier.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.imagebuilder#ClientToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 36 - } - } - }, - "com.amazonaws.imagebuilder#Component": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.imagebuilder#ImageBuilderArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component.

" - } - }, - "name": { - "target": "com.amazonaws.imagebuilder#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the component.

" - } - }, - "version": { - "target": "com.amazonaws.imagebuilder#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version of the component.

" - } - }, - "description": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The description of the component.

" - } - }, - "changeDescription": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The change description of the component.

" - } - }, - "type": { - "target": "com.amazonaws.imagebuilder#ComponentType", - "traits": { - "smithy.api#documentation": "

The component type specifies whether Image Builder uses the component to build the image or\n\t\t\tonly to test it.

" - } - }, - "platform": { - "target": "com.amazonaws.imagebuilder#Platform", - "traits": { - "smithy.api#documentation": "

The operating system platform of the component.

" - } - }, - "supportedOsVersions": { - "target": "com.amazonaws.imagebuilder#OsVersionList", - "traits": { - "smithy.api#documentation": "

The operating system (OS) version supported by the component. If the OS information is\n\t\t\tavailable, Image Builder performs a prefix match against the base image OS version during image\n\t\t\trecipe creation.

" - } - }, - "state": { - "target": "com.amazonaws.imagebuilder#ComponentState", - "traits": { - "smithy.api#documentation": "

Describes the current status of the component. This is used for components that are no\n\t\t\tlonger active.

" - } - }, - "parameters": { - "target": "com.amazonaws.imagebuilder#ComponentParameterDetailList", - "traits": { - "smithy.api#documentation": "

Contains parameter details for each of the parameters that the component document\n\t\t\tdefined for the component.

" - } - }, - "owner": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The owner of the component.

" - } - }, - "data": { - "target": "com.amazonaws.imagebuilder#ComponentData", - "traits": { - "smithy.api#documentation": "

Component data contains the YAML document content for the component.

" - } - }, - "kmsKeyId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The KMS key identifier used to encrypt the component.

" - } - }, - "encrypted": { - "target": "com.amazonaws.imagebuilder#NullableBoolean", - "traits": { - "smithy.api#documentation": "

The encryption status of the component.

" - } - }, - "dateCreated": { - "target": "com.amazonaws.imagebuilder#DateTime", - "traits": { - "smithy.api#documentation": "

The date that Image Builder created the component.

" - } - }, - "tags": { - "target": "com.amazonaws.imagebuilder#TagMap", - "traits": { - "smithy.api#documentation": "

The tags that apply to the component.

" - } - }, - "publisher": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Contains the name of the publisher if this is a third-party component. Otherwise, this\n\t\t\tproperty is empty.

" - } - }, - "obfuscate": { - "target": "com.amazonaws.imagebuilder#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether component source is hidden from view in the console, and from\n\t\t\tcomponent detail results for API, CLI, or SDK operations.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A detailed view of a component.

" - } - }, - "com.amazonaws.imagebuilder#ComponentBuildVersionArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):component/[a-z0-9-_]+/[0-9]+\\.[0-9]+\\.[0-9]+/[0-9]+$" - } - }, - "com.amazonaws.imagebuilder#ComponentConfiguration": { - "type": "structure", - "members": { - "componentArn": { - "target": "com.amazonaws.imagebuilder#ComponentVersionArnOrBuildVersionArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component.

", - "smithy.api#required": {} - } - }, - "parameters": { - "target": "com.amazonaws.imagebuilder#ComponentParameterList", - "traits": { - "smithy.api#documentation": "

A group of parameter settings that Image Builder uses to configure the component for a specific\n\t\t\trecipe.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Configuration details of the component.

" - } - }, - "com.amazonaws.imagebuilder#ComponentConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#ComponentConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.imagebuilder#ComponentData": { - "type": "string" - }, - "com.amazonaws.imagebuilder#ComponentFormat": { - "type": "enum", - "members": { - "SHELL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SHELL" - } - } - } - }, - "com.amazonaws.imagebuilder#ComponentParameter": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.imagebuilder#ComponentParameterName", - "traits": { - "smithy.api#documentation": "

The name of the component parameter to set.

", - "smithy.api#required": {} - } - }, - "value": { - "target": "com.amazonaws.imagebuilder#ComponentParameterValueList", - "traits": { - "smithy.api#documentation": "

Sets the value for the named component parameter.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains a key/value pair that sets the named component parameter.

" - } - }, - "com.amazonaws.imagebuilder#ComponentParameterDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^[^\\x00]+$" - } - }, - "com.amazonaws.imagebuilder#ComponentParameterDetail": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.imagebuilder#ComponentParameterName", - "traits": { - "smithy.api#documentation": "

The name of this input parameter.

", - "smithy.api#required": {} - } - }, - "type": { - "target": "com.amazonaws.imagebuilder#ComponentParameterType", - "traits": { - "smithy.api#documentation": "

The type of input this parameter provides. The currently supported value is\n\t\t\t\"string\".

", - "smithy.api#required": {} - } - }, - "defaultValue": { - "target": "com.amazonaws.imagebuilder#ComponentParameterValueList", - "traits": { - "smithy.api#documentation": "

The default value of this parameter if no input is provided.

" - } - }, - "description": { - "target": "com.amazonaws.imagebuilder#ComponentParameterDescription", - "traits": { - "smithy.api#documentation": "

Describes this parameter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Defines a parameter that is used to provide configuration details for the\n\t\t\tcomponent.

" - } - }, - "com.amazonaws.imagebuilder#ComponentParameterDetailList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#ComponentParameterDetail" - } - }, - "com.amazonaws.imagebuilder#ComponentParameterList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#ComponentParameter" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.imagebuilder#ComponentParameterName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[^\\x00]+$" - } - }, - "com.amazonaws.imagebuilder#ComponentParameterType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 20 - }, - "smithy.api#pattern": "^String|Integer|Boolean|StringList$" - } - }, - "com.amazonaws.imagebuilder#ComponentParameterValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0 - }, - "smithy.api#pattern": "^[^\\x00]*$" - } - }, - "com.amazonaws.imagebuilder#ComponentParameterValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#ComponentParameterValue" - } - }, - "com.amazonaws.imagebuilder#ComponentState": { - "type": "structure", - "members": { - "status": { - "target": "com.amazonaws.imagebuilder#ComponentStatus", - "traits": { - "smithy.api#documentation": "

The current state of the component.

" - } - }, - "reason": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Describes how or why the component changed state.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A group of fields that describe the current status of components that are no longer\n\t\t\tactive.

" - } - }, - "com.amazonaws.imagebuilder#ComponentStatus": { - "type": "enum", - "members": { - "DEPRECATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DEPRECATED" - } - } - } - }, - "com.amazonaws.imagebuilder#ComponentSummary": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.imagebuilder#ImageBuilderArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component.

" - } - }, - "name": { - "target": "com.amazonaws.imagebuilder#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the component.

" - } - }, - "version": { - "target": "com.amazonaws.imagebuilder#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version of the component.

" - } - }, - "platform": { - "target": "com.amazonaws.imagebuilder#Platform", - "traits": { - "smithy.api#documentation": "

The operating system platform of the component.

" - } - }, - "supportedOsVersions": { - "target": "com.amazonaws.imagebuilder#OsVersionList", - "traits": { - "smithy.api#documentation": "

The operating system (OS) version that the component supports. If the OS information\n\t\t\tis available, Image Builder performs a prefix match against the base image OS version during\n\t\t\timage recipe creation.

" - } - }, - "state": { - "target": "com.amazonaws.imagebuilder#ComponentState", - "traits": { - "smithy.api#documentation": "

Describes the current status of the component.

" - } - }, - "type": { - "target": "com.amazonaws.imagebuilder#ComponentType", - "traits": { - "smithy.api#documentation": "

The component type specifies whether Image Builder uses the component to build the image or\n\t\t\tonly to test it.

" - } - }, - "owner": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The owner of the component.

" - } - }, - "description": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The description of the component.

" - } - }, - "changeDescription": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The change description for the current version of the component.

" - } - }, - "dateCreated": { - "target": "com.amazonaws.imagebuilder#DateTime", - "traits": { - "smithy.api#documentation": "

The original creation date of the component.

" - } - }, - "tags": { - "target": "com.amazonaws.imagebuilder#TagMap", - "traits": { - "smithy.api#documentation": "

The tags that apply to the component.

" - } - }, - "publisher": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Contains the name of the publisher if this is a third-party component. Otherwise, this\n\t\t\tproperty is empty.

" - } - }, - "obfuscate": { - "target": "com.amazonaws.imagebuilder#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether component source is hidden from view in the console, and from\n\t\t\tcomponent detail results for API, CLI, or SDK operations.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A high-level summary of a component.

" - } - }, - "com.amazonaws.imagebuilder#ComponentSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#ComponentSummary" - } - }, - "com.amazonaws.imagebuilder#ComponentType": { - "type": "enum", - "members": { - "BUILD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BUILD" - } - }, - "TEST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TEST" - } - } - } - }, - "com.amazonaws.imagebuilder#ComponentVersion": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.imagebuilder#ImageBuilderArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component.

\n \n

Semantic versioning is included in each object's Amazon Resource Name (ARN), \n\tat the level that applies to that object as follows:

\n
    \n
  1. \n

    Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are \n\t\t\t\teither left off entirely, or they are specified as wildcards, for example: x.x.x.

    \n
    2. \n
  2. \n

    Version ARNs have only the first three nodes: ..

    \n
    3. \n
  3. \n

    Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

    \n
    4. \n
\n " - } - }, - "name": { - "target": "com.amazonaws.imagebuilder#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the component.

" - } - }, - "version": { - "target": "com.amazonaws.imagebuilder#VersionNumber", - "traits": { - "smithy.api#documentation": "

The semantic version of the component.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n

\n Assignment: For the first three nodes you can assign any positive integer value, including \n\tzero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the \n\tbuild number to the fourth node.

\n

\n Patterns: You can use any numeric pattern that adheres to the assignment requirements for \n\tthe nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or \n\ta date, such as 2021.01.01.

\n

\n Filtering: With semantic versioning, you have the flexibility to use wildcards (x) \n\tto specify the most recent versions or nodes when selecting the base image or components for your \n\trecipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be \n\twildcards.

\n " - } - }, - "description": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The description of the component.

" - } - }, - "platform": { - "target": "com.amazonaws.imagebuilder#Platform", - "traits": { - "smithy.api#documentation": "

The platform of the component.

" - } - }, - "supportedOsVersions": { - "target": "com.amazonaws.imagebuilder#OsVersionList", - "traits": { - "smithy.api#documentation": "

he operating system (OS) version supported by the component. If the OS information is\n\t\t\tavailable, a prefix match is performed against the base image OS version during image\n\t\t\trecipe creation.

" - } - }, - "type": { - "target": "com.amazonaws.imagebuilder#ComponentType", - "traits": { - "smithy.api#documentation": "

The type of the component denotes whether the component is used to build the image or\n\t\t\tonly to test it.

" - } - }, - "owner": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The owner of the component.

" - } - }, - "dateCreated": { - "target": "com.amazonaws.imagebuilder#DateTime", - "traits": { - "smithy.api#documentation": "

The date that the component was created.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The defining characteristics of a specific version of an Amazon Web Services TOE component.

" - } - }, - "com.amazonaws.imagebuilder#ComponentVersionArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):component/[a-z0-9-_]+/[0-9]+\\.[0-9]+\\.[0-9]+$" - } - }, - "com.amazonaws.imagebuilder#ComponentVersionArnOrBuildVersionArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):component/[a-z0-9-_]+/(?:(?:([0-9]+|x)\\.([0-9]+|x)\\.([0-9]+|x))|(?:[0-9]+\\.[0-9]+\\.[0-9]+/[0-9]+))$" - } - }, - "com.amazonaws.imagebuilder#ComponentVersionList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#ComponentVersion" - } - }, - "com.amazonaws.imagebuilder#Container": { - "type": "structure", - "members": { - "region": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Containers and container images are Region-specific. This is the Region context for\n\t\t\tthe container.

" - } - }, - "imageUris": { - "target": "com.amazonaws.imagebuilder#StringList", - "traits": { - "smithy.api#documentation": "

A list of URIs for containers created in the context Region.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A container encapsulates the runtime environment for an application.

" - } - }, - "com.amazonaws.imagebuilder#ContainerDistributionConfiguration": { - "type": "structure", - "members": { - "description": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The description of the container distribution configuration.

" - } - }, - "containerTags": { - "target": "com.amazonaws.imagebuilder#StringList", - "traits": { - "smithy.api#documentation": "

Tags that are attached to the container distribution configuration.

" - } - }, - "targetRepository": { - "target": "com.amazonaws.imagebuilder#TargetContainerRepository", - "traits": { - "smithy.api#documentation": "

The destination repository for the container distribution configuration.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Container distribution settings for encryption, licensing, and sharing in a specific\n\t\t\tRegion.

" - } - }, - "com.amazonaws.imagebuilder#ContainerList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#Container" - } - }, - "com.amazonaws.imagebuilder#ContainerRecipe": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.imagebuilder#ImageBuilderArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container recipe.

\n \n

Semantic versioning is included in each object's Amazon Resource Name (ARN), \n\tat the level that applies to that object as follows:

\n
    \n
  1. \n

    Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are \n\t\t\t\teither left off entirely, or they are specified as wildcards, for example: x.x.x.

    \n
    2. \n
  2. \n

    Version ARNs have only the first three nodes: ..

    \n
    3. \n
  3. \n

    Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

    \n
    4. \n
\n " - } - }, - "containerType": { - "target": "com.amazonaws.imagebuilder#ContainerType", - "traits": { - "smithy.api#documentation": "

Specifies the type of container, such as Docker.

" - } - }, - "name": { - "target": "com.amazonaws.imagebuilder#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the container recipe.

" - } - }, - "description": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The description of the container recipe.

" - } - }, - "platform": { - "target": "com.amazonaws.imagebuilder#Platform", - "traits": { - "smithy.api#documentation": "

The system platform for the container, such as Windows or Linux.

" - } - }, - "owner": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The owner of the container recipe.

" - } - }, - "version": { - "target": "com.amazonaws.imagebuilder#VersionNumber", - "traits": { - "smithy.api#documentation": "

The semantic version of the container recipe.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n

\n Assignment: For the first three nodes you can assign any positive integer value, including \n\tzero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the \n\tbuild number to the fourth node.

\n

\n Patterns: You can use any numeric pattern that adheres to the assignment requirements for \n\tthe nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or \n\ta date, such as 2021.01.01.

\n

\n Filtering: With semantic versioning, you have the flexibility to use wildcards (x) \n\tto specify the most recent versions or nodes when selecting the base image or components for your \n\trecipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be \n\twildcards.

\n " - } - }, - "components": { - "target": "com.amazonaws.imagebuilder#ComponentConfigurationList", - "traits": { - "smithy.api#documentation": "

Build and test components that are included in the container recipe.\n\t\t\tRecipes require a minimum of one build component, and can \n\t\t\thave a maximum of 20 build and test components in any combination.

" - } - }, - "instanceConfiguration": { - "target": "com.amazonaws.imagebuilder#InstanceConfiguration", - "traits": { - "smithy.api#documentation": "

A group of options that can be used to configure an instance for building and testing\n\t\t\tcontainer images.

" - } - }, - "dockerfileTemplateData": { - "target": "com.amazonaws.imagebuilder#DockerFileTemplate", - "traits": { - "smithy.api#documentation": "

Dockerfiles are text documents that are used to build Docker containers, and ensure\n\t\t\tthat they contain all of the elements required by the application running inside. The\n\t\t\ttemplate data consists of contextual variables where Image Builder places build information or\n\t\t\tscripts, based on your container image recipe.

" - } - }, - "kmsKeyId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Identifies which KMS key is used to encrypt the container image for distribution to\n\t\t\tthe target Region.

" - } - }, - "encrypted": { - "target": "com.amazonaws.imagebuilder#NullableBoolean", - "traits": { - "smithy.api#documentation": "

A flag that indicates if the target container is encrypted.

" - } - }, - "parentImage": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The base image for the container recipe.

" - } - }, - "dateCreated": { - "target": "com.amazonaws.imagebuilder#DateTime", - "traits": { - "smithy.api#documentation": "

The date when this container recipe was created.

" - } - }, - "tags": { - "target": "com.amazonaws.imagebuilder#TagMap", - "traits": { - "smithy.api#documentation": "

Tags that are attached to the container recipe.

" - } - }, - "workingDirectory": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The working directory for use during build and test workflows.

" - } - }, - "targetRepository": { - "target": "com.amazonaws.imagebuilder#TargetContainerRepository", - "traits": { - "smithy.api#documentation": "

The destination repository for the container image.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A container recipe.

" - } - }, - "com.amazonaws.imagebuilder#ContainerRecipeArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):container-recipe/[a-z0-9-_]+/[0-9]+\\.[0-9]+\\.[0-9]+$" - } - }, - "com.amazonaws.imagebuilder#ContainerRecipeSummary": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.imagebuilder#ImageBuilderArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container recipe.

" - } - }, - "containerType": { - "target": "com.amazonaws.imagebuilder#ContainerType", - "traits": { - "smithy.api#documentation": "

Specifies the type of container, such as \"Docker\".

" - } - }, - "name": { - "target": "com.amazonaws.imagebuilder#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the container recipe.

" - } - }, - "platform": { - "target": "com.amazonaws.imagebuilder#Platform", - "traits": { - "smithy.api#documentation": "

The system platform for the container, such as Windows or Linux.

" - } - }, - "owner": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The owner of the container recipe.

" - } - }, - "parentImage": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The base image for the container recipe.

" - } - }, - "dateCreated": { - "target": "com.amazonaws.imagebuilder#DateTime", - "traits": { - "smithy.api#documentation": "

The date when this container recipe was created.

" - } - }, - "tags": { - "target": "com.amazonaws.imagebuilder#TagMap", - "traits": { - "smithy.api#documentation": "

Tags that are attached to the container recipe.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A summary of a container recipe

" - } - }, - "com.amazonaws.imagebuilder#ContainerRecipeSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#ContainerRecipeSummary" - } - }, - "com.amazonaws.imagebuilder#ContainerRepositoryService": { - "type": "enum", - "members": { - "ECR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ECR" - } - } - } - }, - "com.amazonaws.imagebuilder#ContainerType": { - "type": "enum", - "members": { - "DOCKER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOCKER" - } - } - } - }, - "com.amazonaws.imagebuilder#CreateComponent": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#CreateComponentRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#CreateComponentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.imagebuilder#AccountAggregation": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Identifies the account that owns the aggregated resource findings.

" + } + }, + "severityCounts": { + "target": "com.amazonaws.imagebuilder#SeverityCounts", + "traits": { + "smithy.api#documentation": "

Counts by severity level for medium severity and higher level findings, plus a total\n\t\t\tfor all of the findings.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains counts of vulnerability findings from image scans that run when you create\n\t\t\tnew Image Builder images, or build new versions of existing images. The vulnerability counts are\n\t\t\tgrouped by severity level. The counts are aggregated across resources to create the\n\t\t\tfinal tally for the account that owns them.

" + } }, - { - "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" + "com.amazonaws.imagebuilder#AccountId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9]{12}$" + } }, - { - "target": "com.amazonaws.imagebuilder#InvalidParameterCombinationException" + "com.amazonaws.imagebuilder#AccountList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#AccountId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1536 + } + } }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" + "com.amazonaws.imagebuilder#AdditionalInstanceConfiguration": { + "type": "structure", + "members": { + "systemsManagerAgent": { + "target": "com.amazonaws.imagebuilder#SystemsManagerAgent", + "traits": { + "smithy.api#documentation": "

Contains settings for the Systems Manager agent on your build instance.

" + } + }, + "userDataOverride": { + "target": "com.amazonaws.imagebuilder#UserDataOverride", + "traits": { + "smithy.api#documentation": "

Use this property to provide commands or a command script to run when you launch your\n\t\t\tbuild instance.

\n

The userDataOverride property replaces any commands that Image Builder might have added to\n\t\t\tensure that Systems Manager is installed on your Linux build instance. If you override the user\n\t\t\tdata, make sure that you add commands to install Systems Manager, if it is not pre-installed on\n\t\t\tyour base image.

\n \n

The user data is always base 64 encoded. For example, the following commands are\n\t\t\t\tencoded as\n\t\t\t\tIyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$:

\n

\n #!/bin/bash\n

\n

mkdir -p /var/bb/

\n

touch /var

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

In addition to your infrastructure configuration, these settings provide an extra\n\t\t\tlayer of control over your build instances. You can also specify commands to run on\n\t\t\tlaunch for all of your build instances.

\n

Image Builder does not automatically install the Systems Manager agent on Windows instances. If your base\n\t\t\timage includes the Systems Manager agent, then the AMI that you create will also include the\n\t\t\tagent. For Linux instances, if the base image does not already include the Systems Manager agent,\n\t\t\tImage Builder installs it. For Linux instances where Image Builder installs the Systems Manager agent, you can\n\t\t\tchoose whether to keep it for the AMI that you create.

" + } }, - { - "target": "com.amazonaws.imagebuilder#InvalidVersionNumberException" + "com.amazonaws.imagebuilder#Ami": { + "type": "structure", + "members": { + "region": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region of the Amazon EC2 AMI.

" + } + }, + "image": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The AMI ID of the Amazon EC2 AMI.

" + } + }, + "name": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the Amazon EC2 AMI.

" + } + }, + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description of the Amazon EC2 AMI. Minimum and maximum length are in characters.

" + } + }, + "state": { + "target": "com.amazonaws.imagebuilder#ImageState" + }, + "accountId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The account ID of the owner of the AMI.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details of an Amazon EC2 AMI.

" + } }, - { - "target": "com.amazonaws.imagebuilder#ResourceInUseException" + "com.amazonaws.imagebuilder#AmiDistributionConfiguration": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.imagebuilder#AmiNameString", + "traits": { + "smithy.api#documentation": "

The name of the output AMI.

" + } + }, + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description of the AMI distribution configuration. Minimum and maximum length are\n\t\t\tin characters.

" + } + }, + "targetAccountIds": { + "target": "com.amazonaws.imagebuilder#AccountList", + "traits": { + "smithy.api#documentation": "

The ID of an account to which you want to distribute an image.

" + } + }, + "amiTags": { + "target": "com.amazonaws.imagebuilder#TagMap", + "traits": { + "smithy.api#documentation": "

The tags to apply to AMIs distributed to this Region.

" + } + }, + "kmsKeyId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The KMS key identifier used to encrypt the distributed image.

" + } + }, + "launchPermission": { + "target": "com.amazonaws.imagebuilder#LaunchPermissionConfiguration", + "traits": { + "smithy.api#documentation": "

Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to\n\t\t\tlaunch instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Define and configure the output AMIs of the pipeline.

" + } }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" + "com.amazonaws.imagebuilder#AmiList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#Ami" + } }, - { - "target": "com.amazonaws.imagebuilder#ServiceQuotaExceededException" + "com.amazonaws.imagebuilder#AmiNameString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 127 + }, + "smithy.api#pattern": "^[-_A-Za-z0-9{][-_A-Za-z0-9\\s:{}\\.]+[-_A-Za-z0-9}]$" + } }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new component that can be used to build, validate, test, and assess your\n\t\t\timage. The component is based on a YAML document that you specify using exactly one of\n\t\t\tthe following methods:

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/CreateComponent", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#CreateComponentRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.imagebuilder#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the component.

", - "smithy.api#required": {} - } - }, - "semanticVersion": { - "target": "com.amazonaws.imagebuilder#VersionNumber", - "traits": { - "smithy.api#documentation": "

The semantic version of the component. This version follows the semantic version\n\t\t\tsyntax.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n

\n Assignment: For the first three nodes you can assign any positive integer value, including \n\tzero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the \n\tbuild number to the fourth node.

\n

\n Patterns: You can use any numeric pattern that adheres to the assignment requirements for \n\tthe nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or \n\ta date, such as 2021.01.01.

\n ", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Describes the contents of the component.

" - } - }, - "changeDescription": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The change description of the component. Describes what change has been made in this\n\t\t\tversion, or what makes this version different from other versions of this\n\t\t\tcomponent.

" - } - }, - "platform": { - "target": "com.amazonaws.imagebuilder#Platform", - "traits": { - "smithy.api#documentation": "

The operating system platform of the component.

", - "smithy.api#required": {} - } - }, - "supportedOsVersions": { - "target": "com.amazonaws.imagebuilder#OsVersionList", - "traits": { - "smithy.api#documentation": "

The operating system (OS) version supported by the component. If the OS information is\n\t\t\tavailable, a prefix match is performed against the base image OS version during image\n\t\t\trecipe creation.

" - } - }, - "data": { - "target": "com.amazonaws.imagebuilder#InlineComponentData", - "traits": { - "smithy.api#documentation": "

Component data contains inline YAML document content for the component.\n\t\t\tAlternatively, you can specify the uri of a YAML document file stored in\n\t\t\tAmazon S3. However, you cannot specify both properties.

" - } - }, - "uri": { - "target": "com.amazonaws.imagebuilder#Uri", - "traits": { - "smithy.api#documentation": "

The uri of a YAML component document file. This must be an S3 URL\n\t\t\t\t(s3://bucket/key), and the requester must have permission to access the\n\t\t\tS3 bucket it points to. If you use Amazon S3, you can specify component content up to your\n\t\t\tservice quota.

\n

Alternatively, you can specify the YAML document inline, using the component\n\t\t\t\tdata property. You cannot specify both properties.

" - } - }, - "kmsKeyId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the KMS key that is used to encrypt this component.

" - } - }, - "tags": { - "target": "com.amazonaws.imagebuilder#TagMap", - "traits": { - "smithy.api#documentation": "

The tags that apply to the component.

" - } - }, - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", - "traits": { - "smithy.api#documentation": "

The idempotency token of the component.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#CreateComponentResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", - "traits": { - "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" - } - }, - "componentBuildVersionArn": { - "target": "com.amazonaws.imagebuilder#ComponentBuildVersionArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component that this request created.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#CreateContainerRecipe": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#CreateContainerRecipeRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#CreateContainerRecipeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + "com.amazonaws.imagebuilder#Arn": { + "type": "string" }, - { - "target": "com.amazonaws.imagebuilder#ClientException" + "com.amazonaws.imagebuilder#Boolean": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" + "com.amazonaws.imagebuilder#BuildType": { + "type": "enum", + "members": { + "USER_INITIATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER_INITIATED" + } + }, + "SCHEDULED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCHEDULED" + } + }, + "IMPORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPORT" + } + } + } }, - { - "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" + "com.amazonaws.imagebuilder#CallRateLimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.imagebuilder#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

You have exceeded the permitted request rate for the specific operation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" + "com.amazonaws.imagebuilder#CancelImageCreation": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#CancelImageCreationRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#CancelImageCreationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceInUseException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

CancelImageCreation cancels the creation of Image. This operation can only be used on\n\t\t\timages in a non-terminal state.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/CancelImageCreation", + "code": 200 + } + } }, - { - "target": "com.amazonaws.imagebuilder#InvalidVersionNumberException" + "com.amazonaws.imagebuilder#CancelImageCreationRequest": { + "type": "structure", + "members": { + "imageBuildVersionArn": { + "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image that you want to cancel creation\n\t\t\tfor.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure\n idempotency of the request. For more information, see Ensuring idempotency \n in the Amazon EC2 API Reference.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.imagebuilder#ResourceAlreadyExistsException" + "com.amazonaws.imagebuilder#CancelImageCreationResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token that was used for this request.

" + } + }, + "imageBuildVersionArn": { + "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the image whose creation this request canceled.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.imagebuilder#ResourceInUseException" + "com.amazonaws.imagebuilder#ClientException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.imagebuilder#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

These errors are usually caused by a client action, such as using an action or\n\t\t\tresource on behalf of a user that doesn't have permissions to use the action or\n\t\t\tresource, or specifying an invalid resource identifier.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" + "com.amazonaws.imagebuilder#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 36 + } + } }, - { - "target": "com.amazonaws.imagebuilder#ServiceQuotaExceededException" + "com.amazonaws.imagebuilder#Component": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.imagebuilder#ImageBuilderArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component.

" + } + }, + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the component.

" + } + }, + "version": { + "target": "com.amazonaws.imagebuilder#VersionNumber", + "traits": { + "smithy.api#documentation": "

The version of the component.

" + } + }, + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description of the component.

" + } + }, + "changeDescription": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The change description of the component.

" + } + }, + "type": { + "target": "com.amazonaws.imagebuilder#ComponentType", + "traits": { + "smithy.api#documentation": "

The component type specifies whether Image Builder uses the component to build the image or\n\t\t\tonly to test it.

" + } + }, + "platform": { + "target": "com.amazonaws.imagebuilder#Platform", + "traits": { + "smithy.api#documentation": "

The operating system platform of the component.

" + } + }, + "supportedOsVersions": { + "target": "com.amazonaws.imagebuilder#OsVersionList", + "traits": { + "smithy.api#documentation": "

The operating system (OS) version supported by the component. If the OS information is\n\t\t\tavailable, Image Builder performs a prefix match against the base image OS version during image\n\t\t\trecipe creation.

" + } + }, + "state": { + "target": "com.amazonaws.imagebuilder#ComponentState", + "traits": { + "smithy.api#documentation": "

Describes the current status of the component. This is used for components that are no\n\t\t\tlonger active.

" + } + }, + "parameters": { + "target": "com.amazonaws.imagebuilder#ComponentParameterDetailList", + "traits": { + "smithy.api#documentation": "

Contains parameter details for each of the parameters that the component document \n\t\t\tdefined for the component.

" + } + }, + "owner": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The owner of the component.

" + } + }, + "data": { + "target": "com.amazonaws.imagebuilder#ComponentData", + "traits": { + "smithy.api#documentation": "

Component data contains the YAML document content for the component.

" + } + }, + "kmsKeyId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The KMS key identifier used to encrypt the component.

" + } + }, + "encrypted": { + "target": "com.amazonaws.imagebuilder#NullableBoolean", + "traits": { + "smithy.api#documentation": "

The encryption status of the component.

" + } + }, + "dateCreated": { + "target": "com.amazonaws.imagebuilder#DateTime", + "traits": { + "smithy.api#documentation": "

The date that Image Builder created the component.

" + } + }, + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", + "traits": { + "smithy.api#documentation": "

The tags that apply to the component.

" + } + }, + "publisher": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Contains the name of the publisher if this is a third-party component. Otherwise, \n\t\t\tthis property is empty.

" + } + }, + "obfuscate": { + "target": "com.amazonaws.imagebuilder#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether component source is hidden from view in the console, and from \n\t\t\tcomponent detail results for API, CLI, or SDK operations.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A detailed view of a component.

" + } }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new container recipe. Container recipes define how images are configured,\n\t\t\ttested, and assessed.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/CreateContainerRecipe", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#CreateContainerRecipeRequest": { - "type": "structure", - "members": { - "containerType": { - "target": "com.amazonaws.imagebuilder#ContainerType", - "traits": { - "smithy.api#documentation": "

The type of container to create.

", - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.imagebuilder#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the container recipe.

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The description of the container recipe.

" - } - }, - "semanticVersion": { - "target": "com.amazonaws.imagebuilder#VersionNumber", - "traits": { - "smithy.api#documentation": "

The semantic version of the container recipe. This version follows the semantic\n\t\t\tversion syntax.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n

\n Assignment: For the first three nodes you can assign any positive integer value, including \n\tzero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the \n\tbuild number to the fourth node.

\n

\n Patterns: You can use any numeric pattern that adheres to the assignment requirements for \n\tthe nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or \n\ta date, such as 2021.01.01.

\n ", - "smithy.api#required": {} - } - }, - "components": { - "target": "com.amazonaws.imagebuilder#ComponentConfigurationList", - "traits": { - "smithy.api#documentation": "

Components for build and test that are included in the container recipe.\n\t\t\tRecipes require a minimum of one build component, and can \n\t\t\thave a maximum of 20 build and test components in any combination.

", - "smithy.api#required": {} - } - }, - "instanceConfiguration": { - "target": "com.amazonaws.imagebuilder#InstanceConfiguration", - "traits": { - "smithy.api#documentation": "

A group of options that can be used to configure an instance for building and testing\n\t\t\tcontainer images.

" - } - }, - "dockerfileTemplateData": { - "target": "com.amazonaws.imagebuilder#InlineDockerFileTemplate", - "traits": { - "smithy.api#documentation": "

The Dockerfile template used to build your image as an inline data blob.

" - } - }, - "dockerfileTemplateUri": { - "target": "com.amazonaws.imagebuilder#Uri", - "traits": { - "smithy.api#documentation": "

The Amazon S3 URI for the Dockerfile that will be used to build your container\n\t\t\timage.

" - } - }, - "platformOverride": { - "target": "com.amazonaws.imagebuilder#Platform", - "traits": { - "smithy.api#documentation": "

Specifies the operating system platform when you use a custom base image.

" - } - }, - "imageOsVersionOverride": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Specifies the operating system version for the base image.

" - } - }, - "parentImage": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The base image for the container recipe.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.imagebuilder#TagMap", - "traits": { - "smithy.api#documentation": "

Tags that are attached to the container recipe.

" - } - }, - "workingDirectory": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The working directory for use during build and test workflows.

" - } - }, - "targetRepository": { - "target": "com.amazonaws.imagebuilder#TargetContainerRepository", - "traits": { - "smithy.api#documentation": "

The destination repository for the container image.

", - "smithy.api#required": {} - } - }, - "kmsKeyId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Identifies which KMS key is used to encrypt the container image.

" - } - }, - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", - "traits": { - "smithy.api#documentation": "

The client token used to make this request idempotent.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#CreateContainerRecipeResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", - "traits": { - "smithy.api#documentation": "

The client token used to make this request idempotent.

" - } - }, - "containerRecipeArn": { - "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", - "traits": { - "smithy.api#documentation": "

Returns the Amazon Resource Name (ARN) of the container recipe that the request\n\t\t\tcreated.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#CreateDistributionConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#CreateDistributionConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#CreateDistributionConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + "com.amazonaws.imagebuilder#ComponentBuildVersionArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):component/[a-z0-9-_]+/[0-9]+\\.[0-9]+\\.[0-9]+/[0-9]+$" + } }, - { - "target": "com.amazonaws.imagebuilder#ClientException" + "com.amazonaws.imagebuilder#ComponentConfiguration": { + "type": "structure", + "members": { + "componentArn": { + "target": "com.amazonaws.imagebuilder#ComponentVersionArnOrBuildVersionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component.

", + "smithy.api#required": {} + } + }, + "parameters": { + "target": "com.amazonaws.imagebuilder#ComponentParameterList", + "traits": { + "smithy.api#documentation": "

A group of parameter settings that Image Builder uses to configure the component for a specific\n\t\t\trecipe.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration details of the component.

" + } }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" + "com.amazonaws.imagebuilder#ComponentConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#ComponentConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } }, - { - "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" + "com.amazonaws.imagebuilder#ComponentData": { + "type": "string" }, - { - "target": "com.amazonaws.imagebuilder#InvalidParameterCombinationException" + "com.amazonaws.imagebuilder#ComponentFormat": { + "type": "enum", + "members": { + "SHELL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHELL" + } + } + } }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.imagebuilder#ResourceInUseException" + "com.amazonaws.imagebuilder#ComponentParameter": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.imagebuilder#ComponentParameterName", + "traits": { + "smithy.api#documentation": "

The name of the component parameter to set.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.imagebuilder#ComponentParameterValueList", + "traits": { + "smithy.api#documentation": "

Sets the value for the named component parameter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains a key/value pair that sets the named component parameter.

" + } }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" + "com.amazonaws.imagebuilder#ComponentParameterDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[^\\x00]+$" + } }, - { - "target": "com.amazonaws.imagebuilder#ServiceQuotaExceededException" + "com.amazonaws.imagebuilder#ComponentParameterDetail": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.imagebuilder#ComponentParameterName", + "traits": { + "smithy.api#documentation": "

The name of this input parameter.

", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.imagebuilder#ComponentParameterType", + "traits": { + "smithy.api#documentation": "

The type of input this parameter provides. The currently supported value is\n\t\t\t\"string\".

", + "smithy.api#required": {} + } + }, + "defaultValue": { + "target": "com.amazonaws.imagebuilder#ComponentParameterValueList", + "traits": { + "smithy.api#documentation": "

The default value of this parameter if no input is provided.

" + } + }, + "description": { + "target": "com.amazonaws.imagebuilder#ComponentParameterDescription", + "traits": { + "smithy.api#documentation": "

Describes this parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines a parameter that is used to provide configuration details for the\n\t\t\tcomponent.

" + } }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new distribution configuration. Distribution configurations define and\n\t\t\tconfigure the outputs of your pipeline.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/CreateDistributionConfiguration", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#CreateDistributionConfigurationRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.imagebuilder#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the distribution configuration.

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The description of the distribution configuration.

" - } - }, - "distributions": { - "target": "com.amazonaws.imagebuilder#DistributionList", - "traits": { - "smithy.api#documentation": "

The distributions of the distribution configuration.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.imagebuilder#TagMap", - "traits": { - "smithy.api#documentation": "

The tags of the distribution configuration.

" - } - }, - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", - "traits": { - "smithy.api#documentation": "

The idempotency token of the distribution configuration.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#CreateDistributionConfigurationResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", - "traits": { - "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" - } - }, - "distributionConfigurationArn": { - "target": "com.amazonaws.imagebuilder#DistributionConfigurationArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration that was created by\n\t\t\tthis request.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#CreateImage": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#CreateImageRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#CreateImageResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + "com.amazonaws.imagebuilder#ComponentParameterDetailList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#ComponentParameterDetail" + } }, - { - "target": "com.amazonaws.imagebuilder#ClientException" + "com.amazonaws.imagebuilder#ComponentParameterList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#ComponentParameter" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" + "com.amazonaws.imagebuilder#ComponentParameterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[^\\x00]+$" + } }, - { - "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" + "com.amazonaws.imagebuilder#ComponentParameterType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + }, + "smithy.api#pattern": "^String|Integer|Boolean|StringList$" + } }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" + "com.amazonaws.imagebuilder#ComponentParameterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0 + }, + "smithy.api#pattern": "^[^\\x00]*$" + } }, - { - "target": "com.amazonaws.imagebuilder#ResourceInUseException" + "com.amazonaws.imagebuilder#ComponentParameterValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#ComponentParameterValue" + } }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" + "com.amazonaws.imagebuilder#ComponentState": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.imagebuilder#ComponentStatus", + "traits": { + "smithy.api#documentation": "

The current state of the component.

" + } + }, + "reason": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Describes how or why the component changed state.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A group of fields that describe the current status of components that are no longer\n\t\t\tactive.

" + } }, - { - "target": "com.amazonaws.imagebuilder#ServiceQuotaExceededException" + "com.amazonaws.imagebuilder#ComponentStatus": { + "type": "enum", + "members": { + "DEPRECATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPRECATED" + } + } + } }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new image. This request will create a new image along with all of the\n\t\t\tconfigured output resources defined in the distribution configuration. You must specify\n\t\t\texactly one recipe for your image, using either a ContainerRecipeArn or an\n\t\t\tImageRecipeArn.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/CreateImage", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#CreateImagePipeline": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#CreateImagePipelineRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#CreateImagePipelineResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + "com.amazonaws.imagebuilder#ComponentSummary": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.imagebuilder#ImageBuilderArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component.

" + } + }, + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the component.

" + } + }, + "version": { + "target": "com.amazonaws.imagebuilder#VersionNumber", + "traits": { + "smithy.api#documentation": "

The version of the component.

" + } + }, + "platform": { + "target": "com.amazonaws.imagebuilder#Platform", + "traits": { + "smithy.api#documentation": "

The operating system platform of the component.

" + } + }, + "supportedOsVersions": { + "target": "com.amazonaws.imagebuilder#OsVersionList", + "traits": { + "smithy.api#documentation": "

The operating system (OS) version that the component supports. If the OS information\n\t\t\tis available, Image Builder performs a prefix match against the base image OS version during\n\t\t\timage recipe creation.

" + } + }, + "state": { + "target": "com.amazonaws.imagebuilder#ComponentState", + "traits": { + "smithy.api#documentation": "

Describes the current status of the component.

" + } + }, + "type": { + "target": "com.amazonaws.imagebuilder#ComponentType", + "traits": { + "smithy.api#documentation": "

The component type specifies whether Image Builder uses the component to build the image or\n\t\t\tonly to test it.

" + } + }, + "owner": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The owner of the component.

" + } + }, + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description of the component.

" + } + }, + "changeDescription": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The change description for the current version of the component.

" + } + }, + "dateCreated": { + "target": "com.amazonaws.imagebuilder#DateTime", + "traits": { + "smithy.api#documentation": "

The original creation date of the component.

" + } + }, + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", + "traits": { + "smithy.api#documentation": "

The tags that apply to the component.

" + } + }, + "publisher": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Contains the name of the publisher if this is a third-party component. Otherwise, \n\t\t\tthis property is empty.

" + } + }, + "obfuscate": { + "target": "com.amazonaws.imagebuilder#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether component source is hidden from view in the console, \n\t\t\tand from component detail results for API, CLI, or SDK operations.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A high-level summary of a component.

" + } }, - { - "target": "com.amazonaws.imagebuilder#ClientException" + "com.amazonaws.imagebuilder#ComponentSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#ComponentSummary" + } }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" + "com.amazonaws.imagebuilder#ComponentType": { + "type": "enum", + "members": { + "BUILD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BUILD" + } + }, + "TEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEST" + } + } + } }, - { - "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" + "com.amazonaws.imagebuilder#ComponentVersion": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.imagebuilder#ImageBuilderArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component.

\n \n

Semantic versioning is included in each object's Amazon Resource Name (ARN), \n\tat the level that applies to that object as follows:

\n
    \n
  1. \n

    Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are \n\t\t\t\teither left off entirely, or they are specified as wildcards, for example: x.x.x.

    \n
    2. \n
  2. \n

    Version ARNs have only the first three nodes: ..

    \n
    3. \n
  3. \n

    Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

    \n
    4. \n
\n " + } + }, + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the component.

" + } + }, + "version": { + "target": "com.amazonaws.imagebuilder#VersionNumber", + "traits": { + "smithy.api#documentation": "

The semantic version of the component.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n

\n Assignment: For the first three nodes you can assign any positive integer value, including \n\tzero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the \n\tbuild number to the fourth node.

\n

\n Patterns: You can use any numeric pattern that adheres to the assignment requirements for \n\tthe nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or \n\ta date, such as 2021.01.01.

\n

\n Filtering: With semantic versioning, you have the flexibility to use wildcards (x) \n\tto specify the most recent versions or nodes when selecting the base image or components for your \n\trecipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be \n\twildcards.

\n " + } + }, + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description of the component.

" + } + }, + "platform": { + "target": "com.amazonaws.imagebuilder#Platform", + "traits": { + "smithy.api#documentation": "

The platform of the component.

" + } + }, + "supportedOsVersions": { + "target": "com.amazonaws.imagebuilder#OsVersionList", + "traits": { + "smithy.api#documentation": "

he operating system (OS) version supported by the component. If the OS information is\n\t\t\tavailable, a prefix match is performed against the base image OS version during image\n\t\t\trecipe creation.

" + } + }, + "type": { + "target": "com.amazonaws.imagebuilder#ComponentType", + "traits": { + "smithy.api#documentation": "

The type of the component denotes whether the component is used to build the image or\n\t\t\tonly to test it.

" + } + }, + "owner": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The owner of the component.

" + } + }, + "dateCreated": { + "target": "com.amazonaws.imagebuilder#DateTime", + "traits": { + "smithy.api#documentation": "

The date that the component was created.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The defining characteristics of a specific version of an Amazon Web Services TOE component.

" + } }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" + "com.amazonaws.imagebuilder#ComponentVersionArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):component/[a-z0-9-_]+/[0-9]+\\.[0-9]+\\.[0-9]+$" + } }, - { - "target": "com.amazonaws.imagebuilder#ResourceAlreadyExistsException" + "com.amazonaws.imagebuilder#ComponentVersionArnOrBuildVersionArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):component/[a-z0-9-_]+/(?:(?:([0-9]+|x)\\.([0-9]+|x)\\.([0-9]+|x))|(?:[0-9]+\\.[0-9]+\\.[0-9]+/[0-9]+))$" + } }, - { - "target": "com.amazonaws.imagebuilder#ResourceInUseException" + "com.amazonaws.imagebuilder#ComponentVersionList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#ComponentVersion" + } }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" + "com.amazonaws.imagebuilder#Container": { + "type": "structure", + "members": { + "region": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Containers and container images are Region-specific. This is the Region context for\n\t\t\tthe container.

" + } + }, + "imageUris": { + "target": "com.amazonaws.imagebuilder#StringList", + "traits": { + "smithy.api#documentation": "

A list of URIs for containers created in the context Region.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A container encapsulates the runtime environment for an application.

" + } }, - { - "target": "com.amazonaws.imagebuilder#ServiceQuotaExceededException" + "com.amazonaws.imagebuilder#ContainerDistributionConfiguration": { + "type": "structure", + "members": { + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description of the container distribution configuration.

" + } + }, + "containerTags": { + "target": "com.amazonaws.imagebuilder#StringList", + "traits": { + "smithy.api#documentation": "

Tags that are attached to the container distribution configuration.

" + } + }, + "targetRepository": { + "target": "com.amazonaws.imagebuilder#TargetContainerRepository", + "traits": { + "smithy.api#documentation": "

The destination repository for the container distribution configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Container distribution settings for encryption, licensing, and sharing in a specific\n\t\t\tRegion.

" + } }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new image pipeline. Image pipelines enable you to automate the creation and\n\t\t\tdistribution of images.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/CreateImagePipeline", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#CreateImagePipelineRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.imagebuilder#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the image pipeline.

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The description of the image pipeline.

" - } - }, - "imageRecipeArn": { - "target": "com.amazonaws.imagebuilder#ImageRecipeArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe that will be used to configure\n\t\t\timages created by this image pipeline.

" - } - }, - "containerRecipeArn": { - "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container recipe that is used to configure\n\t\t\timages created by this container pipeline.

" - } - }, - "infrastructureConfigurationArn": { - "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that will be used\n\t\t\tto build images created by this image pipeline.

", - "smithy.api#required": {} - } - }, - "distributionConfigurationArn": { - "target": "com.amazonaws.imagebuilder#DistributionConfigurationArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration that will be used to\n\t\t\tconfigure and distribute images created by this image pipeline.

" - } - }, - "imageTestsConfiguration": { - "target": "com.amazonaws.imagebuilder#ImageTestsConfiguration", - "traits": { - "smithy.api#documentation": "

The image test configuration of the image pipeline.

" - } - }, - "enhancedImageMetadataEnabled": { - "target": "com.amazonaws.imagebuilder#NullableBoolean", - "traits": { - "smithy.api#documentation": "

Collects additional information about the image being created, including the operating\n\t\t\tsystem (OS) version and package list. This information is used to enhance the overall\n\t\t\texperience of using EC2 Image Builder. Enabled by default.

" - } - }, - "schedule": { - "target": "com.amazonaws.imagebuilder#Schedule", - "traits": { - "smithy.api#documentation": "

The schedule of the image pipeline.

" - } - }, - "status": { - "target": "com.amazonaws.imagebuilder#PipelineStatus", - "traits": { - "smithy.api#documentation": "

The status of the image pipeline.

" - } - }, - "tags": { - "target": "com.amazonaws.imagebuilder#TagMap", - "traits": { - "smithy.api#documentation": "

The tags of the image pipeline.

" - } - }, - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", - "traits": { - "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "imageScanningConfiguration": { - "target": "com.amazonaws.imagebuilder#ImageScanningConfiguration", - "traits": { - "smithy.api#documentation": "

Contains settings for vulnerability scans.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#CreateImagePipelineResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", - "traits": { - "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" - } - }, - "imagePipelineArn": { - "target": "com.amazonaws.imagebuilder#ImagePipelineArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline that was created by this\n\t\t\trequest.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#CreateImageRecipe": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#CreateImageRecipeRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#CreateImageRecipeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + "com.amazonaws.imagebuilder#ContainerList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#Container" + } }, - { - "target": "com.amazonaws.imagebuilder#ClientException" + "com.amazonaws.imagebuilder#ContainerRecipe": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.imagebuilder#ImageBuilderArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container recipe.

\n \n

Semantic versioning is included in each object's Amazon Resource Name (ARN), \n\tat the level that applies to that object as follows:

\n
    \n
  1. \n

    Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are \n\t\t\t\teither left off entirely, or they are specified as wildcards, for example: x.x.x.

    \n
    2. \n
  2. \n

    Version ARNs have only the first three nodes: ..

    \n
    3. \n
  3. \n

    Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

    \n
    4. \n
\n " + } + }, + "containerType": { + "target": "com.amazonaws.imagebuilder#ContainerType", + "traits": { + "smithy.api#documentation": "

Specifies the type of container, such as Docker.

" + } + }, + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the container recipe.

" + } + }, + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description of the container recipe.

" + } + }, + "platform": { + "target": "com.amazonaws.imagebuilder#Platform", + "traits": { + "smithy.api#documentation": "

The system platform for the container, such as Windows or Linux.

" + } + }, + "owner": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The owner of the container recipe.

" + } + }, + "version": { + "target": "com.amazonaws.imagebuilder#VersionNumber", + "traits": { + "smithy.api#documentation": "

The semantic version of the container recipe.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n

\n Assignment: For the first three nodes you can assign any positive integer value, including \n\tzero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the \n\tbuild number to the fourth node.

\n

\n Patterns: You can use any numeric pattern that adheres to the assignment requirements for \n\tthe nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or \n\ta date, such as 2021.01.01.

\n

\n Filtering: With semantic versioning, you have the flexibility to use wildcards (x) \n\tto specify the most recent versions or nodes when selecting the base image or components for your \n\trecipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be \n\twildcards.

\n " + } + }, + "components": { + "target": "com.amazonaws.imagebuilder#ComponentConfigurationList", + "traits": { + "smithy.api#documentation": "

Build and test components that are included in the container recipe.\n\t\t\tRecipes require a minimum of one build component, and can \n\t\t\thave a maximum of 20 build and test components in any combination.

" + } + }, + "instanceConfiguration": { + "target": "com.amazonaws.imagebuilder#InstanceConfiguration", + "traits": { + "smithy.api#documentation": "

A group of options that can be used to configure an instance for building and testing\n\t\t\tcontainer images.

" + } + }, + "dockerfileTemplateData": { + "target": "com.amazonaws.imagebuilder#DockerFileTemplate", + "traits": { + "smithy.api#documentation": "

Dockerfiles are text documents that are used to build Docker containers, and ensure\n\t\t\tthat they contain all of the elements required by the application running inside. The\n\t\t\ttemplate data consists of contextual variables where Image Builder places build information or\n\t\t\tscripts, based on your container image recipe.

" + } + }, + "kmsKeyId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Identifies which KMS key is used to encrypt the container image for distribution to\n\t\t\tthe target Region.

" + } + }, + "encrypted": { + "target": "com.amazonaws.imagebuilder#NullableBoolean", + "traits": { + "smithy.api#documentation": "

A flag that indicates if the target container is encrypted.

" + } + }, + "parentImage": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The base image for the container recipe.

" + } + }, + "dateCreated": { + "target": "com.amazonaws.imagebuilder#DateTime", + "traits": { + "smithy.api#documentation": "

The date when this container recipe was created.

" + } + }, + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", + "traits": { + "smithy.api#documentation": "

Tags that are attached to the container recipe.

" + } + }, + "workingDirectory": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The working directory for use during build and test workflows.

" + } + }, + "targetRepository": { + "target": "com.amazonaws.imagebuilder#TargetContainerRepository", + "traits": { + "smithy.api#documentation": "

The destination repository for the container image.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A container recipe.

" + } }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" + "com.amazonaws.imagebuilder#ContainerRecipeArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):container-recipe/[a-z0-9-_]+/[0-9]+\\.[0-9]+\\.[0-9]+$" + } }, - { - "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" + "com.amazonaws.imagebuilder#ContainerRecipeSummary": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.imagebuilder#ImageBuilderArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container recipe.

" + } + }, + "containerType": { + "target": "com.amazonaws.imagebuilder#ContainerType", + "traits": { + "smithy.api#documentation": "

Specifies the type of container, such as \"Docker\".

" + } + }, + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the container recipe.

" + } + }, + "platform": { + "target": "com.amazonaws.imagebuilder#Platform", + "traits": { + "smithy.api#documentation": "

The system platform for the container, such as Windows or Linux.

" + } + }, + "owner": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The owner of the container recipe.

" + } + }, + "parentImage": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The base image for the container recipe.

" + } + }, + "dateCreated": { + "target": "com.amazonaws.imagebuilder#DateTime", + "traits": { + "smithy.api#documentation": "

The date when this container recipe was created.

" + } + }, + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", + "traits": { + "smithy.api#documentation": "

Tags that are attached to the container recipe.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary of a container recipe

" + } }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" + "com.amazonaws.imagebuilder#ContainerRecipeSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#ContainerRecipeSummary" + } }, - { - "target": "com.amazonaws.imagebuilder#InvalidVersionNumberException" + "com.amazonaws.imagebuilder#ContainerRepositoryService": { + "type": "enum", + "members": { + "ECR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ECR" + } + } + } }, - { - "target": "com.amazonaws.imagebuilder#ResourceAlreadyExistsException" + "com.amazonaws.imagebuilder#ContainerType": { + "type": "enum", + "members": { + "DOCKER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOCKER" + } + } + } }, - { - "target": "com.amazonaws.imagebuilder#ResourceInUseException" + "com.amazonaws.imagebuilder#CreateComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#CreateComponentRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#CreateComponentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidVersionNumberException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceInUseException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new component that can be used to build, validate, test, and assess your\n\t\t\timage. The component is based on a YAML document that you specify using exactly one of\n\t\t\tthe following methods:

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/CreateComponent", + "code": 200 + } + } }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" + "com.amazonaws.imagebuilder#CreateComponentRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the component.

", + "smithy.api#required": {} + } + }, + "semanticVersion": { + "target": "com.amazonaws.imagebuilder#VersionNumber", + "traits": { + "smithy.api#documentation": "

The semantic version of the component. This version follows the semantic version\n\t\t\tsyntax.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n

\n Assignment: For the first three nodes you can assign any positive integer value, including \n\tzero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the \n\tbuild number to the fourth node.

\n

\n Patterns: You can use any numeric pattern that adheres to the assignment requirements for \n\tthe nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or \n\ta date, such as 2021.01.01.

\n ", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Describes the contents of the component.

" + } + }, + "changeDescription": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The change description of the component. Describes what change has been made in this\n\t\t\tversion, or what makes this version different from other versions of this\n\t\t\tcomponent.

" + } + }, + "platform": { + "target": "com.amazonaws.imagebuilder#Platform", + "traits": { + "smithy.api#documentation": "

The operating system platform of the component.

", + "smithy.api#required": {} + } + }, + "supportedOsVersions": { + "target": "com.amazonaws.imagebuilder#OsVersionList", + "traits": { + "smithy.api#documentation": "

The operating system (OS) version supported by the component. If the OS information is\n\t\t\tavailable, a prefix match is performed against the base image OS version during image\n\t\t\trecipe creation.

" + } + }, + "data": { + "target": "com.amazonaws.imagebuilder#InlineComponentData", + "traits": { + "smithy.api#documentation": "

Component data contains inline YAML document content for the component.\n\t\t\tAlternatively, you can specify the uri of a YAML document file stored in\n\t\t\tAmazon S3. However, you cannot specify both properties.

" + } + }, + "uri": { + "target": "com.amazonaws.imagebuilder#Uri", + "traits": { + "smithy.api#documentation": "

The uri of a YAML component document file. This must be an S3 URL\n\t\t\t\t(s3://bucket/key), and the requester must have permission to access the\n\t\t\tS3 bucket it points to. If you use Amazon S3, you can specify component content up to your\n\t\t\tservice quota.

\n

Alternatively, you can specify the YAML document inline, using the component\n\t\t\t\tdata property. You cannot specify both properties.

" + } + }, + "kmsKeyId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the KMS key that is used to encrypt this component.

" + } + }, + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", + "traits": { + "smithy.api#documentation": "

The tags that apply to the component.

" + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token of the component.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.imagebuilder#ServiceQuotaExceededException" + "com.amazonaws.imagebuilder#CreateComponentResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" + } + }, + "componentBuildVersionArn": { + "target": "com.amazonaws.imagebuilder#ComponentBuildVersionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component that this request created.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new image recipe. Image recipes define how images are configured, tested,\n\t\t\tand assessed.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/CreateImageRecipe", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#CreateImageRecipeRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.imagebuilder#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the image recipe.

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The description of the image recipe.

" - } - }, - "semanticVersion": { - "target": "com.amazonaws.imagebuilder#VersionNumber", - "traits": { - "smithy.api#documentation": "

The semantic version of the image recipe. This version follows the semantic version\n\t\t\tsyntax.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n

\n Assignment: For the first three nodes you can assign any positive integer value, including \n\tzero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the \n\tbuild number to the fourth node.

\n

\n Patterns: You can use any numeric pattern that adheres to the assignment requirements for \n\tthe nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or \n\ta date, such as 2021.01.01.

\n ", - "smithy.api#required": {} - } - }, - "components": { - "target": "com.amazonaws.imagebuilder#ComponentConfigurationList", - "traits": { - "smithy.api#documentation": "

The components included in the image recipe.

", - "smithy.api#required": {} - } - }, - "parentImage": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The base image of the image recipe. The value of the string can be the ARN of the base\n\t\t\timage or an AMI ID. The format for the ARN follows this example:\n\t\t\t\tarn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x.\n\t\t\tYou can provide the specific version that you want to use, or you can use a wildcard in\n\t\t\tall of the fields. If you enter an AMI ID for the string value, you must have access to\n\t\t\tthe AMI, and the AMI must be in the same Region in which you are using Image Builder.

", - "smithy.api#required": {} - } - }, - "blockDeviceMappings": { - "target": "com.amazonaws.imagebuilder#InstanceBlockDeviceMappings", - "traits": { - "smithy.api#documentation": "

The block device mappings of the image recipe.

" - } - }, - "tags": { - "target": "com.amazonaws.imagebuilder#TagMap", - "traits": { - "smithy.api#documentation": "

The tags of the image recipe.

" - } - }, - "workingDirectory": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The working directory used during build and test workflows.

" - } - }, - "additionalInstanceConfiguration": { - "target": "com.amazonaws.imagebuilder#AdditionalInstanceConfiguration", - "traits": { - "smithy.api#documentation": "

Specify additional settings and launch scripts for your build instances.

" - } - }, - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", - "traits": { - "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#CreateImageRecipeResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", - "traits": { - "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" - } - }, - "imageRecipeArn": { - "target": "com.amazonaws.imagebuilder#ImageRecipeArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe that was created by this\n\t\t\trequest.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#CreateImageRequest": { - "type": "structure", - "members": { - "imageRecipeArn": { - "target": "com.amazonaws.imagebuilder#ImageRecipeArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe that defines how images are\n\t\t\tconfigured, tested, and assessed.

" - } - }, - "containerRecipeArn": { - "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container recipe that defines how images are\n\t\t\tconfigured and tested.

" - } - }, - "distributionConfigurationArn": { - "target": "com.amazonaws.imagebuilder#DistributionConfigurationArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration that defines and\n\t\t\tconfigures the outputs of your pipeline.

" - } - }, - "infrastructureConfigurationArn": { - "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that defines the\n\t\t\tenvironment in which your image will be built and tested.

", - "smithy.api#required": {} - } - }, - "imageTestsConfiguration": { - "target": "com.amazonaws.imagebuilder#ImageTestsConfiguration", - "traits": { - "smithy.api#documentation": "

The image tests configuration of the image.

" - } - }, - "enhancedImageMetadataEnabled": { - "target": "com.amazonaws.imagebuilder#NullableBoolean", - "traits": { - "smithy.api#documentation": "

Collects additional information about the image being created, including the operating\n\t\t\tsystem (OS) version and package list. This information is used to enhance the overall\n\t\t\texperience of using EC2 Image Builder. Enabled by default.

" - } - }, - "tags": { - "target": "com.amazonaws.imagebuilder#TagMap", - "traits": { - "smithy.api#documentation": "

The tags of the image.

" - } - }, - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", - "traits": { - "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "imageScanningConfiguration": { - "target": "com.amazonaws.imagebuilder#ImageScanningConfiguration", - "traits": { - "smithy.api#documentation": "

Contains settings for vulnerability scans.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#CreateImageResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", - "traits": { - "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" - } - }, - "imageBuildVersionArn": { - "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image that this request created.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#CreateInfrastructureConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#CreateInfrastructureConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#CreateInfrastructureConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + "com.amazonaws.imagebuilder#CreateContainerRecipe": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#CreateContainerRecipeRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#CreateContainerRecipeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidVersionNumberException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceInUseException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new container recipe. Container recipes define how images are configured,\n\t\t\ttested, and assessed.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/CreateContainerRecipe", + "code": 200 + } + } }, - { - "target": "com.amazonaws.imagebuilder#ClientException" + "com.amazonaws.imagebuilder#CreateContainerRecipeRequest": { + "type": "structure", + "members": { + "containerType": { + "target": "com.amazonaws.imagebuilder#ContainerType", + "traits": { + "smithy.api#documentation": "

The type of container to create.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the container recipe.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description of the container recipe.

" + } + }, + "semanticVersion": { + "target": "com.amazonaws.imagebuilder#VersionNumber", + "traits": { + "smithy.api#documentation": "

The semantic version of the container recipe. This version follows the semantic\n\t\t\tversion syntax.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n

\n Assignment: For the first three nodes you can assign any positive integer value, including \n\tzero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the \n\tbuild number to the fourth node.

\n

\n Patterns: You can use any numeric pattern that adheres to the assignment requirements for \n\tthe nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or \n\ta date, such as 2021.01.01.

\n ", + "smithy.api#required": {} + } + }, + "components": { + "target": "com.amazonaws.imagebuilder#ComponentConfigurationList", + "traits": { + "smithy.api#documentation": "

Components for build and test that are included in the container recipe.\n\t\t\tRecipes require a minimum of one build component, and can \n\t\t\thave a maximum of 20 build and test components in any combination.

", + "smithy.api#required": {} + } + }, + "instanceConfiguration": { + "target": "com.amazonaws.imagebuilder#InstanceConfiguration", + "traits": { + "smithy.api#documentation": "

A group of options that can be used to configure an instance for building and testing\n\t\t\tcontainer images.

" + } + }, + "dockerfileTemplateData": { + "target": "com.amazonaws.imagebuilder#InlineDockerFileTemplate", + "traits": { + "smithy.api#documentation": "

The Dockerfile template used to build your image as an inline data blob.

" + } + }, + "dockerfileTemplateUri": { + "target": "com.amazonaws.imagebuilder#Uri", + "traits": { + "smithy.api#documentation": "

The Amazon S3 URI for the Dockerfile that will be used to build your container\n\t\t\timage.

" + } + }, + "platformOverride": { + "target": "com.amazonaws.imagebuilder#Platform", + "traits": { + "smithy.api#documentation": "

Specifies the operating system platform when you use a custom base image.

" + } + }, + "imageOsVersionOverride": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Specifies the operating system version for the base image.

" + } + }, + "parentImage": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The base image for the container recipe.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", + "traits": { + "smithy.api#documentation": "

Tags that are attached to the container recipe.

" + } + }, + "workingDirectory": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The working directory for use during build and test workflows.

" + } + }, + "targetRepository": { + "target": "com.amazonaws.imagebuilder#TargetContainerRepository", + "traits": { + "smithy.api#documentation": "

The destination repository for the container image.

", + "smithy.api#required": {} + } + }, + "kmsKeyId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Identifies which KMS key is used to encrypt the container image.

" + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "

The client token used to make this request idempotent.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" + "com.amazonaws.imagebuilder#CreateContainerRecipeResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "

The client token used to make this request idempotent.

" + } + }, + "containerRecipeArn": { + "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", + "traits": { + "smithy.api#documentation": "

Returns the Amazon Resource Name (ARN) of the container recipe that the request\n\t\t\tcreated.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" + "com.amazonaws.imagebuilder#CreateDistributionConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#CreateDistributionConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#CreateDistributionConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceInUseException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new distribution configuration. Distribution configurations define and\n\t\t\tconfigure the outputs of your pipeline.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/CreateDistributionConfiguration", + "code": 200 + } + } }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" + "com.amazonaws.imagebuilder#CreateDistributionConfigurationRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the distribution configuration.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description of the distribution configuration.

" + } + }, + "distributions": { + "target": "com.amazonaws.imagebuilder#DistributionList", + "traits": { + "smithy.api#documentation": "

The distributions of the distribution configuration.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", + "traits": { + "smithy.api#documentation": "

The tags of the distribution configuration.

" + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token of the distribution configuration.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.imagebuilder#ResourceAlreadyExistsException" + "com.amazonaws.imagebuilder#CreateDistributionConfigurationResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" + } + }, + "distributionConfigurationArn": { + "target": "com.amazonaws.imagebuilder#DistributionConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration that was created by\n\t\t\tthis request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.imagebuilder#ResourceInUseException" + "com.amazonaws.imagebuilder#CreateImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#CreateImageRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#CreateImageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceInUseException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new image. This request will create a new image along with all of the\n\t\t\tconfigured output resources defined in the distribution configuration. You must specify\n\t\t\texactly one recipe for your image, using either a ContainerRecipeArn or an\n\t\t\tImageRecipeArn.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/CreateImage", + "code": 200 + } + } }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" + "com.amazonaws.imagebuilder#CreateImagePipeline": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#CreateImagePipelineRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#CreateImagePipelineResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceInUseException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new image pipeline. Image pipelines enable you to automate the creation and\n\t\t\tdistribution of images.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/CreateImagePipeline", + "code": 200 + } + } }, - { - "target": "com.amazonaws.imagebuilder#ServiceQuotaExceededException" + "com.amazonaws.imagebuilder#CreateImagePipelineRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the image pipeline.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description of the image pipeline.

" + } + }, + "imageRecipeArn": { + "target": "com.amazonaws.imagebuilder#ImageRecipeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe that will be used to configure\n\t\t\timages created by this image pipeline.

" + } + }, + "containerRecipeArn": { + "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container recipe that is used to configure\n\t\t\timages created by this container pipeline.

" + } + }, + "infrastructureConfigurationArn": { + "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that will be used\n\t\t\tto build images created by this image pipeline.

", + "smithy.api#required": {} + } + }, + "distributionConfigurationArn": { + "target": "com.amazonaws.imagebuilder#DistributionConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration that will be used to\n\t\t\tconfigure and distribute images created by this image pipeline.

" + } + }, + "imageTestsConfiguration": { + "target": "com.amazonaws.imagebuilder#ImageTestsConfiguration", + "traits": { + "smithy.api#documentation": "

The image test configuration of the image pipeline.

" + } + }, + "enhancedImageMetadataEnabled": { + "target": "com.amazonaws.imagebuilder#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Collects additional information about the image being created, including the operating\n\t\t\tsystem (OS) version and package list. This information is used to enhance the overall\n\t\t\texperience of using EC2 Image Builder. Enabled by default.

" + } + }, + "schedule": { + "target": "com.amazonaws.imagebuilder#Schedule", + "traits": { + "smithy.api#documentation": "

The schedule of the image pipeline.

" + } + }, + "status": { + "target": "com.amazonaws.imagebuilder#PipelineStatus", + "traits": { + "smithy.api#documentation": "

The status of the image pipeline.

" + } + }, + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", + "traits": { + "smithy.api#documentation": "

The tags of the image pipeline.

" + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "imageScanningConfiguration": { + "target": "com.amazonaws.imagebuilder#ImageScanningConfiguration", + "traits": { + "smithy.api#documentation": "

Contains settings for vulnerability scans.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new infrastructure configuration. An infrastructure configuration defines\n\t\t\tthe environment in which your image will be built and tested.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/CreateInfrastructureConfiguration", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#CreateInfrastructureConfigurationRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.imagebuilder#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the infrastructure configuration.

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The description of the infrastructure configuration.

" - } - }, - "instanceTypes": { - "target": "com.amazonaws.imagebuilder#InstanceTypeList", - "traits": { - "smithy.api#documentation": "

The instance types of the infrastructure configuration. You can specify one or more\n\t\t\tinstance types to use for this build. The service will pick one of these instance types\n\t\t\tbased on availability.

" - } - }, - "instanceProfileName": { - "target": "com.amazonaws.imagebuilder#InstanceProfileNameType", - "traits": { - "smithy.api#documentation": "

The instance profile to associate with the instance used to customize your Amazon EC2\n\t\t\tAMI.

", - "smithy.api#required": {} - } - }, - "securityGroupIds": { - "target": "com.amazonaws.imagebuilder#SecurityGroupIds", - "traits": { - "smithy.api#documentation": "

The security group IDs to associate with the instance used to customize your Amazon EC2\n\t\t\tAMI.

" - } - }, - "subnetId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The subnet ID in which to place the instance used to customize your Amazon EC2 AMI.

" - } - }, - "logging": { - "target": "com.amazonaws.imagebuilder#Logging", - "traits": { - "smithy.api#documentation": "

The logging configuration of the infrastructure configuration.

" - } - }, - "keyPair": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The key pair of the infrastructure configuration. You can use this to log on to and\n\t\t\tdebug the instance used to create your image.

" - } - }, - "terminateInstanceOnFailure": { - "target": "com.amazonaws.imagebuilder#NullableBoolean", - "traits": { - "smithy.api#documentation": "

The terminate instance on failure setting of the infrastructure configuration. Set to\n\t\t\tfalse if you want Image Builder to retain the instance used to configure your AMI if the build or\n\t\t\ttest phase of your workflow fails.

" - } - }, - "snsTopicArn": { - "target": "com.amazonaws.imagebuilder#SnsTopicArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the SNS topic to which we send image build event\n\t\t\tnotifications.

\n \n

EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys \n\t\t\t\tfrom other accounts. The key that is used to encrypt the SNS topic must reside in the \n\t\t\t\taccount that the Image Builder service runs under.

\n " - } - }, - "resourceTags": { - "target": "com.amazonaws.imagebuilder#ResourceTagMap", - "traits": { - "smithy.api#documentation": "

The tags attached to the resource created by Image Builder.

" - } - }, - "instanceMetadataOptions": { - "target": "com.amazonaws.imagebuilder#InstanceMetadataOptions", - "traits": { - "smithy.api#documentation": "

The instance metadata options that you can set for the HTTP requests that pipeline\n\t\t\tbuilds use to launch EC2 build and test instances.

" - } - }, - "tags": { - "target": "com.amazonaws.imagebuilder#TagMap", - "traits": { - "smithy.api#documentation": "

The tags of the infrastructure configuration.

" - } - }, - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", - "traits": { - "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#CreateInfrastructureConfigurationResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", - "traits": { - "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" - } - }, - "infrastructureConfigurationArn": { - "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that was created by\n\t\t\tthis request.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#CvssScore": { - "type": "structure", - "members": { - "baseScore": { - "target": "com.amazonaws.imagebuilder#NonNegativeDouble", - "traits": { - "smithy.api#documentation": "

The CVSS base score.

" - } - }, - "scoringVector": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The vector string of the CVSS score.

" - } - }, - "version": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The CVSS version that generated the score.

" - } - }, - "source": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The source of the CVSS score.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Amazon Inspector generates a risk score for each finding. This score helps you to prioritize\n\t\t\tfindings, to focus on the most critical findings and the most vulnerable resources. The\n\t\t\tscore uses the Common Vulnerability Scoring System (CVSS) format. This format is a\n\t\t\tmodification of the base CVSS score that the National Vulnerability Database (NVD)\n\t\t\tprovides. For more information about severity levels, see Severity levels for Amazon Inspector findings in the Amazon Inspector User\n\t\t\t\tGuide.

" - } - }, - "com.amazonaws.imagebuilder#CvssScoreAdjustment": { - "type": "structure", - "members": { - "metric": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The metric that Amazon Inspector used to adjust the CVSS score.

" - } - }, - "reason": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The reason for the CVSS score adjustment.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about an adjustment that Amazon Inspector made to the CVSS score for a finding.

" - } - }, - "com.amazonaws.imagebuilder#CvssScoreAdjustmentList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#CvssScoreAdjustment" - } - }, - "com.amazonaws.imagebuilder#CvssScoreDetails": { - "type": "structure", - "members": { - "scoreSource": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The source for the CVSS score.

" - } - }, - "cvssSource": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The source of the finding.

" - } - }, - "version": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The CVSS version that generated the score.

" - } - }, - "score": { - "target": "com.amazonaws.imagebuilder#NonNegativeDouble", - "traits": { - "smithy.api#documentation": "

The CVSS score.

" - } - }, - "scoringVector": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A vector that measures the severity of the vulnerability.

" - } - }, - "adjustments": { - "target": "com.amazonaws.imagebuilder#CvssScoreAdjustmentList", - "traits": { - "smithy.api#documentation": "

An object that contains details about an adjustment that Amazon Inspector made to the CVSS score\n\t\t\tfor the finding.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about the source of the score, and the factors that determined the adjustments\n\t\t\tto create the final score.

" - } - }, - "com.amazonaws.imagebuilder#CvssScoreList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#CvssScore" - } - }, - "com.amazonaws.imagebuilder#DateTime": { - "type": "string" - }, - "com.amazonaws.imagebuilder#DateTimeTimestamp": { - "type": "timestamp" - }, - "com.amazonaws.imagebuilder#DeleteComponent": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#DeleteComponentRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#DeleteComponentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ResourceDependencyException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a component build version.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/DeleteComponent", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#DeleteComponentRequest": { - "type": "structure", - "members": { - "componentBuildVersionArn": { - "target": "com.amazonaws.imagebuilder#ComponentBuildVersionArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component build version to delete.

", - "smithy.api#httpQuery": "componentBuildVersionArn", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#DeleteComponentResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "componentBuildVersionArn": { - "target": "com.amazonaws.imagebuilder#ComponentBuildVersionArn", - "traits": { - "smithy.api#documentation": "

The ARN of the component build version that this request deleted.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#DeleteContainerRecipe": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#DeleteContainerRecipeRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#DeleteContainerRecipeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ResourceDependencyException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a container recipe.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/DeleteContainerRecipe", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#DeleteContainerRecipeRequest": { - "type": "structure", - "members": { - "containerRecipeArn": { - "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container recipe to delete.

", - "smithy.api#httpQuery": "containerRecipeArn", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#DeleteContainerRecipeResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "containerRecipeArn": { - "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container recipe that was deleted.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#DeleteDistributionConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#DeleteDistributionConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#DeleteDistributionConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ResourceDependencyException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a distribution configuration.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/DeleteDistributionConfiguration", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#DeleteDistributionConfigurationRequest": { - "type": "structure", - "members": { - "distributionConfigurationArn": { - "target": "com.amazonaws.imagebuilder#DistributionConfigurationArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration to delete.

", - "smithy.api#httpQuery": "distributionConfigurationArn", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#DeleteDistributionConfigurationResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "distributionConfigurationArn": { - "target": "com.amazonaws.imagebuilder#DistributionConfigurationArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration that was\n\t\t\tdeleted.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#DeleteImage": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#DeleteImageRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#DeleteImageResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ResourceDependencyException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an Image Builder image resource. This does not delete any EC2 AMIs or ECR container\n\t\t\timages that are created during the image build process. You must clean those up\n\t\t\tseparately, using the appropriate Amazon EC2 or Amazon ECR console actions, or API or CLI\n\t\t\tcommands.

\n ", - "smithy.api#http": { - "method": "DELETE", - "uri": "/DeleteImage", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#DeleteImagePipeline": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#DeleteImagePipelineRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#DeleteImagePipelineResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ResourceDependencyException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an image pipeline.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/DeleteImagePipeline", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#DeleteImagePipelineRequest": { - "type": "structure", - "members": { - "imagePipelineArn": { - "target": "com.amazonaws.imagebuilder#ImagePipelineArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline to delete.

", - "smithy.api#httpQuery": "imagePipelineArn", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#DeleteImagePipelineResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "imagePipelineArn": { - "target": "com.amazonaws.imagebuilder#ImagePipelineArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline that was deleted.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#DeleteImageRecipe": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#DeleteImageRecipeRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#DeleteImageRecipeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ResourceDependencyException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an image recipe.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/DeleteImageRecipe", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#DeleteImageRecipeRequest": { - "type": "structure", - "members": { - "imageRecipeArn": { - "target": "com.amazonaws.imagebuilder#ImageRecipeArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe to delete.

", - "smithy.api#httpQuery": "imageRecipeArn", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#DeleteImageRecipeResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "imageRecipeArn": { - "target": "com.amazonaws.imagebuilder#ImageRecipeArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe that was deleted.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#DeleteImageRequest": { - "type": "structure", - "members": { - "imageBuildVersionArn": { - "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Image Builder image resource to delete.

", - "smithy.api#httpQuery": "imageBuildVersionArn", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#DeleteImageResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "imageBuildVersionArn": { - "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", - "traits": { - "smithy.api#documentation": "

The ARN of the Image Builder image resource that this request deleted.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#DeleteInfrastructureConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#DeleteInfrastructureConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#DeleteInfrastructureConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ResourceDependencyException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an infrastructure configuration.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/DeleteInfrastructureConfiguration", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#DeleteInfrastructureConfigurationRequest": { - "type": "structure", - "members": { - "infrastructureConfigurationArn": { - "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration to delete.

", - "smithy.api#httpQuery": "infrastructureConfigurationArn", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#DeleteInfrastructureConfigurationResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "infrastructureConfigurationArn": { - "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that was\n\t\t\tdeleted.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#DiskImageFormat": { - "type": "enum", - "members": { - "VMDK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VMDK" - } - }, - "RAW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RAW" - } - }, - "VHD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VHD" - } - } - } - }, - "com.amazonaws.imagebuilder#Distribution": { - "type": "structure", - "members": { - "region": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The target Region.

", - "smithy.api#required": {} - } - }, - "amiDistributionConfiguration": { - "target": "com.amazonaws.imagebuilder#AmiDistributionConfiguration", - "traits": { - "smithy.api#documentation": "

The specific AMI settings; for example, launch permissions or AMI tags.

" - } - }, - "containerDistributionConfiguration": { - "target": "com.amazonaws.imagebuilder#ContainerDistributionConfiguration", - "traits": { - "smithy.api#documentation": "

Container distribution settings for encryption, licensing, and sharing in a specific\n\t\t\tRegion.

" - } - }, - "licenseConfigurationArns": { - "target": "com.amazonaws.imagebuilder#LicenseConfigurationArnList", - "traits": { - "smithy.api#documentation": "

The License Manager Configuration to associate with the AMI in the specified\n\t\t\tRegion.

" - } - }, - "launchTemplateConfigurations": { - "target": "com.amazonaws.imagebuilder#LaunchTemplateConfigurationList", - "traits": { - "smithy.api#documentation": "

A group of launchTemplateConfiguration settings that apply to image distribution for\n\t\t\tspecified accounts.

" - } - }, - "s3ExportConfiguration": { - "target": "com.amazonaws.imagebuilder#S3ExportConfiguration", - "traits": { - "smithy.api#documentation": "

Configure export settings to deliver disk images created from your image build, using\n\t\t\ta file format that is compatible with your VMs in that Region.

" - } - }, - "fastLaunchConfigurations": { - "target": "com.amazonaws.imagebuilder#FastLaunchConfigurationList", - "traits": { - "smithy.api#documentation": "

The Windows faster-launching configurations to use for AMI distribution.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Defines the settings for a specific Region.

" - } - }, - "com.amazonaws.imagebuilder#DistributionConfiguration": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.imagebuilder#ImageBuilderArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration.

" - } - }, - "name": { - "target": "com.amazonaws.imagebuilder#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the distribution configuration.

" - } - }, - "description": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The description of the distribution configuration.

" - } - }, - "distributions": { - "target": "com.amazonaws.imagebuilder#DistributionList", - "traits": { - "smithy.api#documentation": "

The distribution objects that apply Region-specific settings for the deployment of the\n\t\t\timage to targeted Regions.

" - } - }, - "timeoutMinutes": { - "target": "com.amazonaws.imagebuilder#DistributionTimeoutMinutes", - "traits": { - "smithy.api#documentation": "

The maximum duration in minutes for this distribution configuration.

", - "smithy.api#required": {} - } - }, - "dateCreated": { - "target": "com.amazonaws.imagebuilder#DateTime", - "traits": { - "smithy.api#documentation": "

The date on which this distribution configuration was created.

" - } - }, - "dateUpdated": { - "target": "com.amazonaws.imagebuilder#DateTime", - "traits": { - "smithy.api#documentation": "

The date on which this distribution configuration was last updated.

" - } - }, - "tags": { - "target": "com.amazonaws.imagebuilder#TagMap", - "traits": { - "smithy.api#documentation": "

The tags of the distribution configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A distribution configuration.

" - } - }, - "com.amazonaws.imagebuilder#DistributionConfigurationArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):distribution-configuration/[a-z0-9-_]+$" - } - }, - "com.amazonaws.imagebuilder#DistributionConfigurationSummary": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.imagebuilder#ImageBuilderArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration.

" - } - }, - "name": { - "target": "com.amazonaws.imagebuilder#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the distribution configuration.

" - } - }, - "description": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The description of the distribution configuration.

" - } - }, - "dateCreated": { - "target": "com.amazonaws.imagebuilder#DateTime", - "traits": { - "smithy.api#documentation": "

The date on which the distribution configuration was created.

" - } - }, - "dateUpdated": { - "target": "com.amazonaws.imagebuilder#DateTime", - "traits": { - "smithy.api#documentation": "

The date on which the distribution configuration was updated.

" - } - }, - "tags": { - "target": "com.amazonaws.imagebuilder#TagMap", - "traits": { - "smithy.api#documentation": "

The tags associated with the distribution configuration.

" - } - }, - "regions": { - "target": "com.amazonaws.imagebuilder#RegionList", - "traits": { - "smithy.api#documentation": "

A list of Regions where the container image is distributed to.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A high-level overview of a distribution configuration.

" - } - }, - "com.amazonaws.imagebuilder#DistributionConfigurationSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#DistributionConfigurationSummary" - } - }, - "com.amazonaws.imagebuilder#DistributionList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#Distribution" - } - }, - "com.amazonaws.imagebuilder#DistributionTimeoutMinutes": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 30, - "max": 720 - } - } - }, - "com.amazonaws.imagebuilder#DockerFileTemplate": { - "type": "string" - }, - "com.amazonaws.imagebuilder#EbsInstanceBlockDeviceSpecification": { - "type": "structure", - "members": { - "encrypted": { - "target": "com.amazonaws.imagebuilder#NullableBoolean", - "traits": { - "smithy.api#documentation": "

Use to configure device encryption.

" - } - }, - "deleteOnTermination": { - "target": "com.amazonaws.imagebuilder#NullableBoolean", - "traits": { - "smithy.api#documentation": "

Use to configure delete on termination of the associated device.

" - } - }, - "iops": { - "target": "com.amazonaws.imagebuilder#EbsIopsInteger", - "traits": { - "smithy.api#documentation": "

Use to configure device IOPS.

" - } - }, - "kmsKeyId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Use to configure the KMS key to use when encrypting the device.

" - } - }, - "snapshotId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The snapshot that defines the device contents.

" - } - }, - "volumeSize": { - "target": "com.amazonaws.imagebuilder#EbsVolumeSizeInteger", - "traits": { - "smithy.api#documentation": "

Use to override the device's volume size.

" - } - }, - "volumeType": { - "target": "com.amazonaws.imagebuilder#EbsVolumeType", - "traits": { - "smithy.api#documentation": "

Use to override the device's volume type.

" - } - }, - "throughput": { - "target": "com.amazonaws.imagebuilder#EbsVolumeThroughput", - "traits": { - "smithy.api#documentation": "

\n For GP3 volumes only – The throughput in MiB/s\n\t\t\tthat the volume supports.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Amazon EBS-specific block device mapping specifications.

" - } - }, - "com.amazonaws.imagebuilder#EbsIopsInteger": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 100, - "max": 64000 - } - } - }, - "com.amazonaws.imagebuilder#EbsVolumeSizeInteger": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 16000 - } - } - }, - "com.amazonaws.imagebuilder#EbsVolumeThroughput": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 125, - "max": 1000 - } - } - }, - "com.amazonaws.imagebuilder#EbsVolumeType": { - "type": "enum", - "members": { - "STANDARD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "standard" - } - }, - "IO1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "io1" - } - }, - "IO2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "io2" - } - }, - "GP2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "gp2" - } - }, - "GP3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "gp3" - } - }, - "SC1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "sc1" - } - }, - "ST1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "st1" - } - } - } - }, - "com.amazonaws.imagebuilder#EcrConfiguration": { - "type": "structure", - "members": { - "repositoryName": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the container repository that Amazon Inspector scans to identify findings for your\n\t\t\tcontainer images. The name includes the path for the repository location. If you don’t\n\t\t\tprovide this information, Image Builder creates a repository in your account named\n\t\t\t\timage-builder-image-scanning-repository for vulnerability scans of your\n\t\t\toutput container images.

" - } - }, - "containerTags": { - "target": "com.amazonaws.imagebuilder#StringList", - "traits": { - "smithy.api#documentation": "

Tags for Image Builder to apply to the output container image that &INS; scans. Tags can\n\t\t\thelp you identify and manage your scanned images.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Settings that Image Builder uses to configure the ECR repository and the output container\n\t\t\timages that Amazon Inspector scans.

" - } - }, - "com.amazonaws.imagebuilder#EmptyString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 0 - } - } - }, - "com.amazonaws.imagebuilder#ErrorMessage": { - "type": "string" - }, - "com.amazonaws.imagebuilder#FastLaunchConfiguration": { - "type": "structure", - "members": { - "enabled": { - "target": "com.amazonaws.imagebuilder#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean that represents the current state of faster launching for the Windows AMI.\n\t\t\tSet to true to start using Windows faster launching, or false\n\t\t\tto stop using it.

", - "smithy.api#required": {} - } - }, - "snapshotConfiguration": { - "target": "com.amazonaws.imagebuilder#FastLaunchSnapshotConfiguration", - "traits": { - "smithy.api#documentation": "

Configuration settings for managing the number of snapshots that are created from\n\t\t\tpre-provisioned instances for the Windows AMI when faster launching is enabled.

" - } - }, - "maxParallelLaunches": { - "target": "com.amazonaws.imagebuilder#MaxParallelLaunches", - "traits": { - "smithy.api#documentation": "

The maximum number of parallel instances that are launched for creating\n\t\t\tresources.

" - } - }, - "launchTemplate": { - "target": "com.amazonaws.imagebuilder#FastLaunchLaunchTemplateSpecification", - "traits": { - "smithy.api#documentation": "

The launch template that the fast-launch enabled Windows AMI uses when it launches\n\t\t\tWindows instances to create pre-provisioned snapshots.

" - } - }, - "accountId": { - "target": "com.amazonaws.imagebuilder#AccountId", - "traits": { - "smithy.api#documentation": "

The owner account ID for the fast-launch enabled Windows AMI.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Define and configure faster launching for output Windows AMIs.

" - } - }, - "com.amazonaws.imagebuilder#FastLaunchConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#FastLaunchConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.imagebuilder#FastLaunchLaunchTemplateSpecification": { - "type": "structure", - "members": { - "launchTemplateId": { - "target": "com.amazonaws.imagebuilder#LaunchTemplateId", - "traits": { - "smithy.api#documentation": "

The ID of the launch template to use for faster launching for a Windows AMI.

" - } - }, - "launchTemplateName": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the launch template to use for faster launching for a Windows AMI.

" - } - }, - "launchTemplateVersion": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The version of the launch template to use for faster launching for a Windows\n\t\t\tAMI.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Identifies the launch template that the associated Windows AMI uses for launching an\n\t\t\tinstance when faster launching is enabled.

\n \n

You can specify either the launchTemplateName or the\n\t\t\t\t\tlaunchTemplateId, but not both.

\n " - } - }, - "com.amazonaws.imagebuilder#FastLaunchSnapshotConfiguration": { - "type": "structure", - "members": { - "targetResourceCount": { - "target": "com.amazonaws.imagebuilder#TargetResourceCount", - "traits": { - "smithy.api#documentation": "

The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled\n\t\t\tWindows AMI.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Configuration settings for creating and managing pre-provisioned snapshots for a\n\t\t\tfast-launch enabled Windows AMI.

" - } - }, - "com.amazonaws.imagebuilder#Filter": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.imagebuilder#FilterName", - "traits": { - "smithy.api#documentation": "

The name of the filter. Filter names are case-sensitive.

" - } - }, - "values": { - "target": "com.amazonaws.imagebuilder#FilterValues", - "traits": { - "smithy.api#documentation": "

The filter values. Filter values are case-sensitive.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A filter name and value pair that is used to return a more specific list of results\n\t\t\tfrom a list operation. Filters can be used to match a set of resources by specific\n\t\t\tcriteria, such as tags, attributes, or IDs.

" - } - }, - "com.amazonaws.imagebuilder#FilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#Filter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.imagebuilder#FilterName": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-zA-Z]{1,1024}$" - } - }, - "com.amazonaws.imagebuilder#FilterValue": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[0-9a-zA-Z./_ :-]{1,1024}$" - } - }, - "com.amazonaws.imagebuilder#FilterValues": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#FilterValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.imagebuilder#ForbiddenException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.imagebuilder#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

You are not authorized to perform the requested operation.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.imagebuilder#GetComponent": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#GetComponentRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#GetComponentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets a component object.

", - "smithy.api#http": { - "method": "GET", - "uri": "/GetComponent", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#GetComponentPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#GetComponentPolicyRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#GetComponentPolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets a component policy.

", - "smithy.api#http": { - "method": "GET", - "uri": "/GetComponentPolicy", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#GetComponentPolicyRequest": { - "type": "structure", - "members": { - "componentArn": { - "target": "com.amazonaws.imagebuilder#ComponentBuildVersionArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component whose policy you want to\n\t\t\tretrieve.

", - "smithy.api#httpQuery": "componentArn", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#GetComponentPolicyResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "policy": { - "target": "com.amazonaws.imagebuilder#ResourcePolicyDocument", - "traits": { - "smithy.api#documentation": "

The component policy.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#GetComponentRequest": { - "type": "structure", - "members": { - "componentBuildVersionArn": { - "target": "com.amazonaws.imagebuilder#ComponentVersionArnOrBuildVersionArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component that you want to get. Regex requires\n\t\t\tthe suffix /\\d+$.

", - "smithy.api#httpQuery": "componentBuildVersionArn", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#GetComponentResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "component": { - "target": "com.amazonaws.imagebuilder#Component", - "traits": { - "smithy.api#documentation": "

The component object associated with the specified ARN.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#GetContainerRecipe": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#GetContainerRecipeRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#GetContainerRecipeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves a container recipe.

", - "smithy.api#http": { - "method": "GET", - "uri": "/GetContainerRecipe", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#GetContainerRecipePolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#GetContainerRecipePolicyRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#GetContainerRecipePolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves the policy for a container recipe.

", - "smithy.api#http": { - "method": "GET", - "uri": "/GetContainerRecipePolicy", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#GetContainerRecipePolicyRequest": { - "type": "structure", - "members": { - "containerRecipeArn": { - "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container recipe for the policy being\n\t\t\trequested.

", - "smithy.api#httpQuery": "containerRecipeArn", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#GetContainerRecipePolicyResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "policy": { - "target": "com.amazonaws.imagebuilder#ResourcePolicyDocument", - "traits": { - "smithy.api#documentation": "

The container recipe policy object that is returned.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#GetContainerRecipeRequest": { - "type": "structure", - "members": { - "containerRecipeArn": { - "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container recipe to retrieve.

", - "smithy.api#httpQuery": "containerRecipeArn", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#GetContainerRecipeResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "containerRecipe": { - "target": "com.amazonaws.imagebuilder#ContainerRecipe", - "traits": { - "smithy.api#documentation": "

The container recipe object that is returned.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#GetDistributionConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#GetDistributionConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#GetDistributionConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets a distribution configuration.

", - "smithy.api#http": { - "method": "GET", - "uri": "/GetDistributionConfiguration", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#GetDistributionConfigurationRequest": { - "type": "structure", - "members": { - "distributionConfigurationArn": { - "target": "com.amazonaws.imagebuilder#DistributionConfigurationArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration that you want to\n\t\t\tretrieve.

", - "smithy.api#httpQuery": "distributionConfigurationArn", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#GetDistributionConfigurationResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "distributionConfiguration": { - "target": "com.amazonaws.imagebuilder#DistributionConfiguration", - "traits": { - "smithy.api#documentation": "

The distribution configuration object.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#GetImage": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#GetImageRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#GetImageResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets an image.

", - "smithy.api#http": { - "method": "GET", - "uri": "/GetImage", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#GetImagePipeline": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#GetImagePipelineRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#GetImagePipelineResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets an image pipeline.

", - "smithy.api#http": { - "method": "GET", - "uri": "/GetImagePipeline", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#GetImagePipelineRequest": { - "type": "structure", - "members": { - "imagePipelineArn": { - "target": "com.amazonaws.imagebuilder#ImagePipelineArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline that you want to retrieve.

", - "smithy.api#httpQuery": "imagePipelineArn", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#GetImagePipelineResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "imagePipeline": { - "target": "com.amazonaws.imagebuilder#ImagePipeline", - "traits": { - "smithy.api#documentation": "

The image pipeline object.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#GetImagePolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#GetImagePolicyRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#GetImagePolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets an image policy.

", - "smithy.api#http": { - "method": "GET", - "uri": "/GetImagePolicy", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#GetImagePolicyRequest": { - "type": "structure", - "members": { - "imageArn": { - "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image whose policy you want to retrieve.

", - "smithy.api#httpQuery": "imageArn", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#GetImagePolicyResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "policy": { - "target": "com.amazonaws.imagebuilder#ResourcePolicyDocument", - "traits": { - "smithy.api#documentation": "

The image policy object.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#GetImageRecipe": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#GetImageRecipeRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#GetImageRecipeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets an image recipe.

", - "smithy.api#http": { - "method": "GET", - "uri": "/GetImageRecipe", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#GetImageRecipePolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#GetImageRecipePolicyRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#GetImageRecipePolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets an image recipe policy.

", - "smithy.api#http": { - "method": "GET", - "uri": "/GetImageRecipePolicy", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#GetImageRecipePolicyRequest": { - "type": "structure", - "members": { - "imageRecipeArn": { - "target": "com.amazonaws.imagebuilder#ImageRecipeArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe whose policy you want to\n\t\t\tretrieve.

", - "smithy.api#httpQuery": "imageRecipeArn", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#GetImageRecipePolicyResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "policy": { - "target": "com.amazonaws.imagebuilder#ResourcePolicyDocument", - "traits": { - "smithy.api#documentation": "

The image recipe policy object.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#GetImageRecipeRequest": { - "type": "structure", - "members": { - "imageRecipeArn": { - "target": "com.amazonaws.imagebuilder#ImageRecipeArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe that you want to retrieve.

", - "smithy.api#httpQuery": "imageRecipeArn", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#GetImageRecipeResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "imageRecipe": { - "target": "com.amazonaws.imagebuilder#ImageRecipe", - "traits": { - "smithy.api#documentation": "

The image recipe object.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#GetImageRequest": { - "type": "structure", - "members": { - "imageBuildVersionArn": { - "target": "com.amazonaws.imagebuilder#ImageVersionArnOrBuildVersionArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image that you want to get.

", - "smithy.api#httpQuery": "imageBuildVersionArn", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#GetImageResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "image": { - "target": "com.amazonaws.imagebuilder#Image", - "traits": { - "smithy.api#documentation": "

The image object.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#GetInfrastructureConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#GetInfrastructureConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#GetInfrastructureConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets an infrastructure configuration.

", - "smithy.api#http": { - "method": "GET", - "uri": "/GetInfrastructureConfiguration", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#GetInfrastructureConfigurationRequest": { - "type": "structure", - "members": { - "infrastructureConfigurationArn": { - "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that you want to\n\t\t\tretrieve.

", - "smithy.api#httpQuery": "infrastructureConfigurationArn", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

GetInfrastructureConfiguration request object.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#GetInfrastructureConfigurationResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "infrastructureConfiguration": { - "target": "com.amazonaws.imagebuilder#InfrastructureConfiguration", - "traits": { - "smithy.api#documentation": "

The infrastructure configuration object.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

GetInfrastructureConfiguration response object.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#GetWorkflowExecution": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#GetWorkflowExecutionRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#GetWorkflowExecutionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Get the runtime information that was logged for a specific runtime instance \n\t\t\tof the workflow.

", - "smithy.api#http": { - "method": "GET", - "uri": "/GetWorkflowExecution", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#GetWorkflowExecutionRequest": { - "type": "structure", - "members": { - "workflowExecutionId": { - "target": "com.amazonaws.imagebuilder#WorkflowExecutionId", - "traits": { - "smithy.api#documentation": "

Use the unique identifier for a runtime instance of the workflow to get \n\t\t\truntime details.

", - "smithy.api#httpQuery": "workflowExecutionId", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#GetWorkflowExecutionResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "workflowBuildVersionArn": { - "target": "com.amazonaws.imagebuilder#WorkflowBuildVersionArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource \n\t\t\tthat defines the specified runtime instance of the workflow.

" - } - }, - "workflowExecutionId": { - "target": "com.amazonaws.imagebuilder#WorkflowExecutionId", - "traits": { - "smithy.api#documentation": "

The unique identifier that Image Builder assigned to keep track of runtime details\n\t\t\twhen it ran the workflow.

" - } - }, - "imageBuildVersionArn": { - "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image resource build version that the specified \n\t\t\truntime instance of the workflow created.

" - } - }, - "type": { - "target": "com.amazonaws.imagebuilder#WorkflowType", - "traits": { - "smithy.api#documentation": "

The type of workflow that Image Builder ran for the specified runtime instance of the workflow.

" - } - }, - "status": { - "target": "com.amazonaws.imagebuilder#WorkflowExecutionStatus", - "traits": { - "smithy.api#documentation": "

The current runtime status for the specified runtime instance of the workflow.

" - } - }, - "message": { - "target": "com.amazonaws.imagebuilder#WorkflowExecutionMessage", - "traits": { - "smithy.api#documentation": "

The output message from the specified runtime instance of the workflow, if applicable.

" - } - }, - "totalStepCount": { - "target": "com.amazonaws.imagebuilder#WorkflowStepCount", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The total number of steps in the specified runtime instance of the workflow that ran. \n\t\t\tThis number should equal the sum of the step counts for steps that succeeded, were skipped, \n\t\t\tand failed.

" - } - }, - "totalStepsSucceeded": { - "target": "com.amazonaws.imagebuilder#WorkflowStepCount", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

A runtime count for the number of steps that ran successfully in the specified runtime \n\t\t\tinstance of the workflow.

" - } - }, - "totalStepsFailed": { - "target": "com.amazonaws.imagebuilder#WorkflowStepCount", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

A runtime count for the number of steps that failed in the specified runtime instance \n\t\t\tof the workflow.

" - } - }, - "totalStepsSkipped": { - "target": "com.amazonaws.imagebuilder#WorkflowStepCount", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

A runtime count for the number of steps that were skipped in the specified runtime \n\t\t\tinstance of the workflow.

" - } - }, - "startTime": { - "target": "com.amazonaws.imagebuilder#DateTime", - "traits": { - "smithy.api#documentation": "

The timestamp when the specified runtime instance of the workflow started.

" - } - }, - "endTime": { - "target": "com.amazonaws.imagebuilder#DateTime", - "traits": { - "smithy.api#documentation": "

The timestamp when the specified runtime instance of the workflow finished.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#GetWorkflowStepExecution": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#GetWorkflowStepExecutionRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#GetWorkflowStepExecutionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Get the runtime information that was logged for a specific runtime instance of \n\t\t\tthe workflow step.

", - "smithy.api#http": { - "method": "GET", - "uri": "/GetWorkflowStepExecution", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#GetWorkflowStepExecutionRequest": { - "type": "structure", - "members": { - "stepExecutionId": { - "target": "com.amazonaws.imagebuilder#WorkflowStepExecutionId", - "traits": { - "smithy.api#documentation": "

Use the unique identifier for a specific runtime instance of the workflow step to \n\t\t\tget runtime details for that step.

", - "smithy.api#httpQuery": "stepExecutionId", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#GetWorkflowStepExecutionResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "stepExecutionId": { - "target": "com.amazonaws.imagebuilder#WorkflowStepExecutionId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the runtime version of the workflow step that you specified \n\t\t\tin the request.

" - } - }, - "workflowBuildVersionArn": { - "target": "com.amazonaws.imagebuilder#WorkflowBuildVersionArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource\n\t\t\tthat defines this workflow step.

" - } - }, - "workflowExecutionId": { - "target": "com.amazonaws.imagebuilder#WorkflowExecutionId", - "traits": { - "smithy.api#documentation": "

The unique identifier that Image Builder assigned to keep track of runtime details\n\t\t\twhen it ran the workflow.

" - } - }, - "imageBuildVersionArn": { - "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image resource build version that the specified \n\t\t\truntime instance of the workflow step creates.

" - } - }, - "name": { - "target": "com.amazonaws.imagebuilder#WorkflowStepName", - "traits": { - "smithy.api#documentation": "

The name of the specified runtime instance of the workflow step.

" - } - }, - "description": { - "target": "com.amazonaws.imagebuilder#WorkflowStepDescription", - "traits": { - "smithy.api#documentation": "

Describes the specified workflow step.

" - } - }, - "action": { - "target": "com.amazonaws.imagebuilder#WorkflowStepAction", - "traits": { - "smithy.api#documentation": "

The name of the action that the specified step performs.

" - } - }, - "status": { - "target": "com.amazonaws.imagebuilder#WorkflowStepExecutionStatus", - "traits": { - "smithy.api#documentation": "

The current status for the specified runtime version of the workflow step.

" - } - }, - "rollbackStatus": { - "target": "com.amazonaws.imagebuilder#WorkflowStepExecutionRollbackStatus", - "traits": { - "smithy.api#documentation": "

Reports on the rollback status of the specified runtime version of the workflow step, \n\t\t\tif applicable.

" - } - }, - "message": { - "target": "com.amazonaws.imagebuilder#WorkflowStepMessage", - "traits": { - "smithy.api#documentation": "

The output message from the specified runtime instance of the workflow step, if applicable.

" - } - }, - "inputs": { - "target": "com.amazonaws.imagebuilder#WorkflowStepInputs", - "traits": { - "smithy.api#documentation": "

Input parameters that Image Builder provided for the specified runtime instance of \n\t\t\tthe workflow step.

" - } - }, - "outputs": { - "target": "com.amazonaws.imagebuilder#WorkflowStepOutputs", - "traits": { - "smithy.api#documentation": "

The file names that the specified runtime version of the workflow step created as output.

" - } - }, - "startTime": { - "target": "com.amazonaws.imagebuilder#DateTime", - "traits": { - "smithy.api#documentation": "

The timestamp when the specified runtime version of the workflow step started.

" - } - }, - "endTime": { - "target": "com.amazonaws.imagebuilder#DateTime", - "traits": { - "smithy.api#documentation": "

The timestamp when the specified runtime instance of the workflow step finished.

" - } - }, - "onFailure": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The action to perform if the workflow step fails.

" - } - }, - "timeoutSeconds": { - "target": "com.amazonaws.imagebuilder#WorkflowStepTimeoutSecondsInteger", - "traits": { - "smithy.api#documentation": "

The maximum duration in seconds for this step to complete its action.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#HttpPutResponseHopLimit": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.imagebuilder#HttpTokens": { - "type": "string", - "traits": { - "smithy.api#pattern": "^optional|required$" - } - }, - "com.amazonaws.imagebuilder#IdempotentParameterMismatchException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.imagebuilder#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

You have specified a client token for an operation using parameter values that differ\n\t\t\tfrom a previous request that used the same client token.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.imagebuilder#Image": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.imagebuilder#ImageBuilderArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image.

\n \n

Semantic versioning is included in each object's Amazon Resource Name (ARN), \n\tat the level that applies to that object as follows:

\n
    \n
  1. \n

    Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are \n\t\t\t\teither left off entirely, or they are specified as wildcards, for example: x.x.x.

    \n
    2. \n
  2. \n

    Version ARNs have only the first three nodes: ..

    \n
    3. \n
  3. \n

    Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

    \n
    4. \n
\n " - } - }, - "type": { - "target": "com.amazonaws.imagebuilder#ImageType", - "traits": { - "smithy.api#documentation": "

Specifies whether this image produces an AMI or a container image.

" - } - }, - "name": { - "target": "com.amazonaws.imagebuilder#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the image.

" - } - }, - "version": { - "target": "com.amazonaws.imagebuilder#VersionNumber", - "traits": { - "smithy.api#documentation": "

The semantic version of the image.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n

\n Assignment: For the first three nodes you can assign any positive integer value, including \n\tzero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the \n\tbuild number to the fourth node.

\n

\n Patterns: You can use any numeric pattern that adheres to the assignment requirements for \n\tthe nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or \n\ta date, such as 2021.01.01.

\n

\n Filtering: With semantic versioning, you have the flexibility to use wildcards (x) \n\tto specify the most recent versions or nodes when selecting the base image or components for your \n\trecipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be \n\twildcards.

\n " - } - }, - "platform": { - "target": "com.amazonaws.imagebuilder#Platform", - "traits": { - "smithy.api#documentation": "

The image operating system platform, such as Linux or Windows.

" - } - }, - "enhancedImageMetadataEnabled": { - "target": "com.amazonaws.imagebuilder#NullableBoolean", - "traits": { - "smithy.api#documentation": "

Indicates whether Image Builder collects additional information about the image, such as the\n\t\t\toperating system (OS) version and package list.

" - } - }, - "osVersion": { - "target": "com.amazonaws.imagebuilder#OsVersion", - "traits": { - "smithy.api#documentation": "

The operating system version for instances that launch from this image. For example,\n\t\t\tAmazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

" - } - }, - "state": { - "target": "com.amazonaws.imagebuilder#ImageState", - "traits": { - "smithy.api#documentation": "

The state of the image.

" - } - }, - "imageRecipe": { - "target": "com.amazonaws.imagebuilder#ImageRecipe", - "traits": { - "smithy.api#documentation": "

For images that distribute an AMI, this is the image recipe that Image Builder used to create\n\t\t\tthe image. For container images, this is empty.

" - } - }, - "containerRecipe": { - "target": "com.amazonaws.imagebuilder#ContainerRecipe", - "traits": { - "smithy.api#documentation": "

For container images, this is the container recipe that Image Builder used to create the image.\n\t\t\tFor images that distribute an AMI, this is empty.

" - } - }, - "sourcePipelineName": { - "target": "com.amazonaws.imagebuilder#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the image pipeline that created this image.

" - } - }, - "sourcePipelineArn": { - "target": "com.amazonaws.imagebuilder#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline that created this image.

" - } - }, - "infrastructureConfiguration": { - "target": "com.amazonaws.imagebuilder#InfrastructureConfiguration", - "traits": { - "smithy.api#documentation": "

The infrastructure that Image Builder used to create this image.

" - } - }, - "distributionConfiguration": { - "target": "com.amazonaws.imagebuilder#DistributionConfiguration", - "traits": { - "smithy.api#documentation": "

The distribution configuration that Image Builder used to create this image.

" - } - }, - "imageTestsConfiguration": { - "target": "com.amazonaws.imagebuilder#ImageTestsConfiguration", - "traits": { - "smithy.api#documentation": "

The image tests that ran when that Image Builder created this image.

" - } - }, - "dateCreated": { - "target": "com.amazonaws.imagebuilder#DateTime", - "traits": { - "smithy.api#documentation": "

The date on which Image Builder created this image.

" - } - }, - "outputResources": { - "target": "com.amazonaws.imagebuilder#OutputResources", - "traits": { - "smithy.api#documentation": "

The output resources that Image Builder produces for this image.

" - } - }, - "tags": { - "target": "com.amazonaws.imagebuilder#TagMap", - "traits": { - "smithy.api#documentation": "

The tags that apply to this image.

" - } - }, - "buildType": { - "target": "com.amazonaws.imagebuilder#BuildType", - "traits": { - "smithy.api#documentation": "

Indicates the type of build that created this image. The build can be initiated in the\n\t\t\tfollowing ways:

\n " - } - }, - "imageSource": { - "target": "com.amazonaws.imagebuilder#ImageSource", - "traits": { - "smithy.api#documentation": "

The origin of the base image that Image Builder used to build this image.

" - } - }, - "scanState": { - "target": "com.amazonaws.imagebuilder#ImageScanState", - "traits": { - "smithy.api#documentation": "

Contains information about the current state of scans for this image.

" - } - }, - "imageScanningConfiguration": { - "target": "com.amazonaws.imagebuilder#ImageScanningConfiguration", - "traits": { - "smithy.api#documentation": "

Contains settings for vulnerability scans.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An Image Builder image. You must specify exactly one recipe for the image – either a\n\t\t\tcontainer recipe (containerRecipe), which creates a container image, or an\n\t\t\timage recipe (imageRecipe), which creates an AMI.

" - } - }, - "com.amazonaws.imagebuilder#ImageAggregation": { - "type": "structure", - "members": { - "imageBuildVersionArn": { - "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the image for this aggregation.

" - } - }, - "severityCounts": { - "target": "com.amazonaws.imagebuilder#SeverityCounts", - "traits": { - "smithy.api#documentation": "

Counts by severity level for medium severity and higher level findings, plus a total\n\t\t\tfor all of the findings for the specified image.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains vulnerability counts for a specific image.

" - } - }, - "com.amazonaws.imagebuilder#ImageBuildMessage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 500 - } - } - }, - "com.amazonaws.imagebuilder#ImageBuildVersionArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):image/[a-z0-9-_]+/[0-9]+\\.[0-9]+\\.[0-9]+/[0-9]+$" - } - }, - "com.amazonaws.imagebuilder#ImageBuilderArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|workflow\\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\\.(?:x|[0-9]+)\\.(?:x|[0-9]+))(?:/[0-9]+)?)?$" - } - }, - "com.amazonaws.imagebuilder#ImagePackage": { - "type": "structure", - "members": { - "packageName": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the package as reported to the operating system package manager.

" - } - }, - "packageVersion": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The version of the package as reported to the operating system package manager.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents a package installed on an Image Builder image.

" - } - }, - "com.amazonaws.imagebuilder#ImagePackageList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#ImagePackage" - } - }, - "com.amazonaws.imagebuilder#ImagePipeline": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.imagebuilder#ImageBuilderArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline.

" - } - }, - "name": { - "target": "com.amazonaws.imagebuilder#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the image pipeline.

" - } - }, - "description": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The description of the image pipeline.

" - } - }, - "platform": { - "target": "com.amazonaws.imagebuilder#Platform", - "traits": { - "smithy.api#documentation": "

The platform of the image pipeline.

" - } - }, - "enhancedImageMetadataEnabled": { - "target": "com.amazonaws.imagebuilder#NullableBoolean", - "traits": { - "smithy.api#documentation": "

Collects additional information about the image being created, including the operating\n\t\t\tsystem (OS) version and package list. This information is used to enhance the overall\n\t\t\texperience of using EC2 Image Builder. Enabled by default.

" - } - }, - "imageRecipeArn": { - "target": "com.amazonaws.imagebuilder#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe associated with this image\n\t\t\tpipeline.

" - } - }, - "containerRecipeArn": { - "target": "com.amazonaws.imagebuilder#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container recipe that is used for this\n\t\t\tpipeline.

" - } - }, - "infrastructureConfigurationArn": { - "target": "com.amazonaws.imagebuilder#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration associated with\n\t\t\tthis image pipeline.

" - } - }, - "distributionConfigurationArn": { - "target": "com.amazonaws.imagebuilder#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration associated with this\n\t\t\timage pipeline.

" - } - }, - "imageTestsConfiguration": { - "target": "com.amazonaws.imagebuilder#ImageTestsConfiguration", - "traits": { - "smithy.api#documentation": "

The image tests configuration of the image pipeline.

" - } - }, - "schedule": { - "target": "com.amazonaws.imagebuilder#Schedule", - "traits": { - "smithy.api#documentation": "

The schedule of the image pipeline.

" - } - }, - "status": { - "target": "com.amazonaws.imagebuilder#PipelineStatus", - "traits": { - "smithy.api#documentation": "

The status of the image pipeline.

" - } - }, - "dateCreated": { - "target": "com.amazonaws.imagebuilder#DateTime", - "traits": { - "smithy.api#documentation": "

The date on which this image pipeline was created.

" - } - }, - "dateUpdated": { - "target": "com.amazonaws.imagebuilder#DateTime", - "traits": { - "smithy.api#documentation": "

The date on which this image pipeline was last updated.

" - } - }, - "dateLastRun": { - "target": "com.amazonaws.imagebuilder#DateTime", - "traits": { - "smithy.api#documentation": "

This is no longer supported, and does not return a value.

" - } - }, - "dateNextRun": { - "target": "com.amazonaws.imagebuilder#DateTime", - "traits": { - "smithy.api#documentation": "

This is no longer supported, and does not return a value.

" - } - }, - "tags": { - "target": "com.amazonaws.imagebuilder#TagMap", - "traits": { - "smithy.api#documentation": "

The tags of this image pipeline.

" - } - }, - "imageScanningConfiguration": { - "target": "com.amazonaws.imagebuilder#ImageScanningConfiguration", - "traits": { - "smithy.api#documentation": "

Contains settings for vulnerability scans.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details of an image pipeline.

" - } - }, - "com.amazonaws.imagebuilder#ImagePipelineAggregation": { - "type": "structure", - "members": { - "imagePipelineArn": { - "target": "com.amazonaws.imagebuilder#ImagePipelineArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the image pipeline for this\n\t\t\taggregation.

" - } - }, - "severityCounts": { - "target": "com.amazonaws.imagebuilder#SeverityCounts", - "traits": { - "smithy.api#documentation": "

Counts by severity level for medium severity and higher level findings, plus a total\n\t\t\tfor all of the findings for the specified image pipeline.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains vulnerability counts for a specific image pipeline.

" - } - }, - "com.amazonaws.imagebuilder#ImagePipelineArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):image-pipeline/[a-z0-9-_]+$" - } - }, - "com.amazonaws.imagebuilder#ImagePipelineList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#ImagePipeline" - } - }, - "com.amazonaws.imagebuilder#ImageRecipe": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.imagebuilder#ImageBuilderArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe.

" - } - }, - "type": { - "target": "com.amazonaws.imagebuilder#ImageType", - "traits": { - "smithy.api#documentation": "

Specifies which type of image is created by the recipe - an AMI or a container\n\t\t\timage.

" - } - }, - "name": { - "target": "com.amazonaws.imagebuilder#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the image recipe.

" - } - }, - "description": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The description of the image recipe.

" - } - }, - "platform": { - "target": "com.amazonaws.imagebuilder#Platform", - "traits": { - "smithy.api#documentation": "

The platform of the image recipe.

" - } - }, - "owner": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The owner of the image recipe.

" - } - }, - "version": { - "target": "com.amazonaws.imagebuilder#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version of the image recipe.

" - } - }, - "components": { - "target": "com.amazonaws.imagebuilder#ComponentConfigurationList", - "traits": { - "smithy.api#documentation": "

The components that are included in the image recipe. Recipes require a minimum of one build component, and can \n\t\t\thave a maximum of 20 build and test components in any combination.

" - } - }, - "parentImage": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The base image of the image recipe.

" - } - }, - "blockDeviceMappings": { - "target": "com.amazonaws.imagebuilder#InstanceBlockDeviceMappings", - "traits": { - "smithy.api#documentation": "

The block device mappings to apply when creating images from this recipe.

" - } - }, - "dateCreated": { - "target": "com.amazonaws.imagebuilder#DateTime", - "traits": { - "smithy.api#documentation": "

The date on which this image recipe was created.

" - } - }, - "tags": { - "target": "com.amazonaws.imagebuilder#TagMap", - "traits": { - "smithy.api#documentation": "

The tags of the image recipe.

" - } - }, - "workingDirectory": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The working directory to be used during build and test workflows.

" - } - }, - "additionalInstanceConfiguration": { - "target": "com.amazonaws.imagebuilder#AdditionalInstanceConfiguration", - "traits": { - "smithy.api#documentation": "

Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test\n\t\t\tyour image configuration. Instance configuration adds a layer of control over those\n\t\t\tinstances. You can define settings and add scripts to run when an instance is launched\n\t\t\tfrom your AMI.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An image recipe.

" - } - }, - "com.amazonaws.imagebuilder#ImageRecipeArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):image-recipe/[a-z0-9-_]+/[0-9]+\\.[0-9]+\\.[0-9]+$" - } - }, - "com.amazonaws.imagebuilder#ImageRecipeSummary": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.imagebuilder#ImageBuilderArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe.

" - } - }, - "name": { - "target": "com.amazonaws.imagebuilder#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the image recipe.

" - } - }, - "platform": { - "target": "com.amazonaws.imagebuilder#Platform", - "traits": { - "smithy.api#documentation": "

The platform of the image recipe.

" - } - }, - "owner": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The owner of the image recipe.

" - } - }, - "parentImage": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The base image of the image recipe.

" - } - }, - "dateCreated": { - "target": "com.amazonaws.imagebuilder#DateTime", - "traits": { - "smithy.api#documentation": "

The date on which this image recipe was created.

" - } - }, - "tags": { - "target": "com.amazonaws.imagebuilder#TagMap", - "traits": { - "smithy.api#documentation": "

The tags of the image recipe.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A summary of an image recipe.

" - } - }, - "com.amazonaws.imagebuilder#ImageRecipeSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#ImageRecipeSummary" - } - }, - "com.amazonaws.imagebuilder#ImageScanFinding": { - "type": "structure", - "members": { - "awsAccountId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID that's associated with the finding.

" - } - }, - "imageBuildVersionArn": { - "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image build version that's associated with the\n\t\t\tfinding.

" - } - }, - "imagePipelineArn": { - "target": "com.amazonaws.imagebuilder#ImagePipelineArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline that's associated with the\n\t\t\tfinding.

" - } - }, - "type": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of the finding. Image Builder looks for findings of the type\n\t\t\t\tPACKAGE_VULNERABILITY that apply to output images, and excludes other\n\t\t\ttypes.

" - } - }, - "description": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The description of the finding.

" - } - }, - "title": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The title of the finding.

" - } - }, - "remediation": { - "target": "com.amazonaws.imagebuilder#Remediation", - "traits": { - "smithy.api#documentation": "

An object that contains the details about how to remediate the finding.

" - } - }, - "severity": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The severity of the finding.

" - } - }, - "firstObservedAt": { - "target": "com.amazonaws.imagebuilder#DateTimeTimestamp", - "traits": { - "smithy.api#documentation": "

The date and time when the finding was first observed.

" - } - }, - "updatedAt": { - "target": "com.amazonaws.imagebuilder#DateTimeTimestamp", - "traits": { - "smithy.api#documentation": "

The timestamp when the finding was last updated.

" - } - }, - "inspectorScore": { - "target": "com.amazonaws.imagebuilder#NonNegativeDouble", - "traits": { - "smithy.api#documentation": "

The score that Amazon Inspector assigned for the finding.

" - } - }, - "inspectorScoreDetails": { - "target": "com.amazonaws.imagebuilder#InspectorScoreDetails", - "traits": { - "smithy.api#documentation": "

An object that contains details of the Amazon Inspector score.

" - } - }, - "packageVulnerabilityDetails": { - "target": "com.amazonaws.imagebuilder#PackageVulnerabilityDetails", - "traits": { - "smithy.api#documentation": "

An object that contains the details of a package vulnerability finding.

" - } - }, - "fixAvailable": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Details about whether a fix is available for any of the packages that are identified\n\t\t\tin the finding through a version update.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains details about a vulnerability scan finding.

" - } - }, - "com.amazonaws.imagebuilder#ImageScanFindingAggregation": { - "type": "structure", - "members": { - "accountAggregation": { - "target": "com.amazonaws.imagebuilder#AccountAggregation", - "traits": { - "smithy.api#documentation": "

Returns an object that contains severity counts based on an account ID.

" - } - }, - "imageAggregation": { - "target": "com.amazonaws.imagebuilder#ImageAggregation", - "traits": { - "smithy.api#documentation": "

Returns an object that contains severity counts based on the Amazon Resource Name\n\t\t\t(ARN) for a specific image.

" - } - }, - "imagePipelineAggregation": { - "target": "com.amazonaws.imagebuilder#ImagePipelineAggregation", - "traits": { - "smithy.api#documentation": "

Returns an object that contains severity counts based on an image pipeline ARN.

" - } - }, - "vulnerabilityIdAggregation": { - "target": "com.amazonaws.imagebuilder#VulnerabilityIdAggregation", - "traits": { - "smithy.api#documentation": "

Returns an object that contains severity counts based on vulnerability ID.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This returns exactly one type of aggregation, based on the filter that Image Builder applies in\n\t\t\tits API action.

" - } - }, - "com.amazonaws.imagebuilder#ImageScanFindingAggregationsList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#ImageScanFindingAggregation" - } - }, - "com.amazonaws.imagebuilder#ImageScanFindingsFilter": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.imagebuilder#FilterName", - "traits": { - "smithy.api#documentation": "

The name of the image scan finding filter. Filter names are case-sensitive.

" - } - }, - "values": { - "target": "com.amazonaws.imagebuilder#ImageScanFindingsFilterValues", - "traits": { - "smithy.api#documentation": "

The filter values. Filter values are case-sensitive.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A name value pair that Image Builder applies to streamline results from the\n\t\t\tvulnerability scan findings list action.

" - } - }, - "com.amazonaws.imagebuilder#ImageScanFindingsFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#ImageScanFindingsFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.imagebuilder#ImageScanFindingsFilterValues": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#FilterValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.imagebuilder#ImageScanFindingsList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#ImageScanFinding" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 25 - } - } - }, - "com.amazonaws.imagebuilder#ImageScanState": { - "type": "structure", - "members": { - "status": { - "target": "com.amazonaws.imagebuilder#ImageScanStatus", - "traits": { - "smithy.api#documentation": "

The current state of vulnerability scans for the image.

" - } - }, - "reason": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The reason for the scan status for the image.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Shows the vulnerability scan status for a specific image, and the reason for that\n\t\t\tstatus.

" - } - }, - "com.amazonaws.imagebuilder#ImageScanStatus": { - "type": "enum", - "members": { - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "SCANNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SCANNING" - } - }, - "COLLECTING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COLLECTING" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - }, - "ABANDONED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ABANDONED" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "TIMED_OUT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TIMED_OUT" - } - } - } - }, - "com.amazonaws.imagebuilder#ImageScanningConfiguration": { - "type": "structure", - "members": { - "imageScanningEnabled": { - "target": "com.amazonaws.imagebuilder#NullableBoolean", - "traits": { - "smithy.api#documentation": "

A setting that indicates whether Image Builder keeps a snapshot of the vulnerability scans that\n\t\t\tAmazon Inspector runs against the build instance when you create a new image.

" - } - }, - "ecrConfiguration": { - "target": "com.amazonaws.imagebuilder#EcrConfiguration", - "traits": { - "smithy.api#documentation": "

Contains Amazon ECR settings for vulnerability scans.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains settings for Image Builder image resource and container image scans.

" - } - }, - "com.amazonaws.imagebuilder#ImageSource": { - "type": "enum", - "members": { - "AMAZON_MANAGED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AMAZON_MANAGED" - } - }, - "AWS_MARKETPLACE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AWS_MARKETPLACE" - } - }, - "IMPORTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IMPORTED" - } - }, - "CUSTOM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CUSTOM" - } - } - } - }, - "com.amazonaws.imagebuilder#ImageState": { - "type": "structure", - "members": { - "status": { - "target": "com.amazonaws.imagebuilder#ImageStatus", - "traits": { - "smithy.api#documentation": "

The status of the image.

" - } - }, - "reason": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The reason for the status of the image.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Image status and the reason for that status.

" - } - }, - "com.amazonaws.imagebuilder#ImageStatus": { - "type": "enum", - "members": { - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "BUILDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BUILDING" - } - }, - "TESTING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TESTING" - } - }, - "DISTRIBUTING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISTRIBUTING" - } - }, - "INTEGRATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTEGRATING" - } - }, - "AVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AVAILABLE" - } - }, - "CANCELLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CANCELLED" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "DEPRECATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DEPRECATED" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETED" - } - } - } - }, - "com.amazonaws.imagebuilder#ImageSummary": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.imagebuilder#ImageBuilderArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image.

" - } - }, - "name": { - "target": "com.amazonaws.imagebuilder#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the image.

" - } - }, - "type": { - "target": "com.amazonaws.imagebuilder#ImageType", - "traits": { - "smithy.api#documentation": "

Specifies whether this image produces an AMI or a container image.

" - } - }, - "version": { - "target": "com.amazonaws.imagebuilder#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version of the image.

" - } - }, - "platform": { - "target": "com.amazonaws.imagebuilder#Platform", - "traits": { - "smithy.api#documentation": "

The image operating system platform, such as Linux or Windows.

" - } - }, - "osVersion": { - "target": "com.amazonaws.imagebuilder#OsVersion", - "traits": { - "smithy.api#documentation": "

The operating system version of the instances that launch from this image. For\n\t\t\texample, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

" - } - }, - "state": { - "target": "com.amazonaws.imagebuilder#ImageState", - "traits": { - "smithy.api#documentation": "

The state of the image.

" - } - }, - "owner": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The owner of the image.

" - } - }, - "dateCreated": { - "target": "com.amazonaws.imagebuilder#DateTime", - "traits": { - "smithy.api#documentation": "

The date on which Image Builder created this image.

" - } - }, - "outputResources": { - "target": "com.amazonaws.imagebuilder#OutputResources", - "traits": { - "smithy.api#documentation": "

The output resources that Image Builder produced when it created this image.

" - } - }, - "tags": { - "target": "com.amazonaws.imagebuilder#TagMap", - "traits": { - "smithy.api#documentation": "

The tags that apply to this image.

" - } - }, - "buildType": { - "target": "com.amazonaws.imagebuilder#BuildType", - "traits": { - "smithy.api#documentation": "

Indicates the type of build that created this image. The build can be initiated in the\n\t\t\tfollowing ways:

\n " - } - }, - "imageSource": { - "target": "com.amazonaws.imagebuilder#ImageSource", - "traits": { - "smithy.api#documentation": "

The origin of the base image that Image Builder used to build this image.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An image summary.

" - } - }, - "com.amazonaws.imagebuilder#ImageSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#ImageSummary" - } - }, - "com.amazonaws.imagebuilder#ImageTestsConfiguration": { - "type": "structure", - "members": { - "imageTestsEnabled": { - "target": "com.amazonaws.imagebuilder#NullableBoolean", - "traits": { - "smithy.api#documentation": "

Determines if tests should run after building the image. Image Builder defaults to enable tests\n\t\t\tto run following the image build, before image distribution.

" - } - }, - "timeoutMinutes": { - "target": "com.amazonaws.imagebuilder#ImageTestsTimeoutMinutes", - "traits": { - "smithy.api#documentation": "

The maximum time in minutes that tests are permitted to run.

\n \n

The timeoutMinutes attribute is not currently active. This value is\n\t\t\t\tignored.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Configure image tests for your pipeline build. Tests run after building the image, to\n\t\t\tverify that the AMI or container image is valid before distributing it.

" - } - }, - "com.amazonaws.imagebuilder#ImageTestsTimeoutMinutes": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 60, - "max": 1440 - } - } - }, - "com.amazonaws.imagebuilder#ImageType": { - "type": "enum", - "members": { - "AMI": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AMI" - } - }, - "DOCKER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOCKER" - } - } - } - }, - "com.amazonaws.imagebuilder#ImageVersion": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.imagebuilder#ImageBuilderArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a specific version of an Image Builder image.

\n \n

Semantic versioning is included in each object's Amazon Resource Name (ARN), \n\tat the level that applies to that object as follows:

\n
    \n
  1. \n

    Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are \n\t\t\t\teither left off entirely, or they are specified as wildcards, for example: x.x.x.

    \n
    2. \n
  2. \n

    Version ARNs have only the first three nodes: ..

    \n
    3. \n
  3. \n

    Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

    \n
    4. \n
\n " - } - }, - "name": { - "target": "com.amazonaws.imagebuilder#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of this specific version of an Image Builder image.

" - } - }, - "type": { - "target": "com.amazonaws.imagebuilder#ImageType", - "traits": { - "smithy.api#documentation": "

Specifies whether this image produces an AMI or a container image.

" - } - }, - "version": { - "target": "com.amazonaws.imagebuilder#VersionNumber", - "traits": { - "smithy.api#documentation": "

Details for a specific version of an Image Builder image. This version follows the semantic\n\t\t\tversion syntax.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n

\n Assignment: For the first three nodes you can assign any positive integer value, including \n\tzero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the \n\tbuild number to the fourth node.

\n

\n Patterns: You can use any numeric pattern that adheres to the assignment requirements for \n\tthe nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or \n\ta date, such as 2021.01.01.

\n

\n Filtering: With semantic versioning, you have the flexibility to use wildcards (x) \n\tto specify the most recent versions or nodes when selecting the base image or components for your \n\trecipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be \n\twildcards.

\n " - } - }, - "platform": { - "target": "com.amazonaws.imagebuilder#Platform", - "traits": { - "smithy.api#documentation": "

The operating system platform of the image version, for example \"Windows\" or\n\t\t\t\"Linux\".

" - } - }, - "osVersion": { - "target": "com.amazonaws.imagebuilder#OsVersion", - "traits": { - "smithy.api#documentation": "

The operating system version of the Amazon EC2 build instance. For example, Amazon Linux 2,\n\t\t\tUbuntu 18, or Microsoft Windows Server 2019.

" - } - }, - "owner": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The owner of the image version.

" - } - }, - "dateCreated": { - "target": "com.amazonaws.imagebuilder#DateTime", - "traits": { - "smithy.api#documentation": "

The date on which this specific version of the Image Builder image was created.

" - } - }, - "buildType": { - "target": "com.amazonaws.imagebuilder#BuildType", - "traits": { - "smithy.api#documentation": "

Indicates the type of build that created this image. The build can be initiated in the\n\t\t\tfollowing ways:

\n " - } - }, - "imageSource": { - "target": "com.amazonaws.imagebuilder#ImageSource", - "traits": { - "smithy.api#documentation": "

The origin of the base image that Image Builder used to build this image.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The defining characteristics of a specific version of an Image Builder image.

" - } - }, - "com.amazonaws.imagebuilder#ImageVersionArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):image/[a-z0-9-_]+/[0-9]+\\.[0-9]+\\.[0-9]+$" - } - }, - "com.amazonaws.imagebuilder#ImageVersionArnOrBuildVersionArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):image/[a-z0-9-_]+/(?:(?:([0-9]+|x)\\.([0-9]+|x)\\.([0-9]+|x))|(?:[0-9]+\\.[0-9]+\\.[0-9]+/[0-9]+))$" - } - }, - "com.amazonaws.imagebuilder#ImageVersionList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#ImageVersion" - } - }, - "com.amazonaws.imagebuilder#ImportComponent": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#ImportComponentRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#ImportComponentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidParameterCombinationException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidVersionNumberException" - }, - { - "target": "com.amazonaws.imagebuilder#ResourceInUseException" + "com.amazonaws.imagebuilder#CreateImagePipelineResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" + } + }, + "imagePipelineArn": { + "target": "com.amazonaws.imagebuilder#ImagePipelineArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline that was created by this\n\t\t\trequest.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" + "com.amazonaws.imagebuilder#CreateImageRecipe": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#CreateImageRecipeRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#CreateImageRecipeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidVersionNumberException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceInUseException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new image recipe. Image recipes define how images are configured, tested,\n\t\t\tand assessed.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/CreateImageRecipe", + "code": 200 + } + } }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Imports a component and transforms its data into a component document.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/ImportComponent", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#ImportComponentRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.imagebuilder#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the component.

", - "smithy.api#required": {} - } - }, - "semanticVersion": { - "target": "com.amazonaws.imagebuilder#VersionNumber", - "traits": { - "smithy.api#documentation": "

The semantic version of the component. This version follows the semantic version\n\t\t\tsyntax.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n

\n Filtering: With semantic versioning, you have the flexibility to use wildcards (x) \n\tto specify the most recent versions or nodes when selecting the base image or components for your \n\trecipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be \n\twildcards.

\n ", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The description of the component. Describes the contents of the component.

" - } - }, - "changeDescription": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The change description of the component. This description indicates the change that\n\t\t\thas been made in this version, or what makes this version different from other versions\n\t\t\tof this component.

" - } - }, - "type": { - "target": "com.amazonaws.imagebuilder#ComponentType", - "traits": { - "smithy.api#documentation": "

The type of the component denotes whether the component is used to build the image, or\n\t\t\tonly to test it.

", - "smithy.api#required": {} - } - }, - "format": { - "target": "com.amazonaws.imagebuilder#ComponentFormat", - "traits": { - "smithy.api#documentation": "

The format of the resource that you want to import as a component.

", - "smithy.api#required": {} - } - }, - "platform": { - "target": "com.amazonaws.imagebuilder#Platform", - "traits": { - "smithy.api#documentation": "

The platform of the component.

", - "smithy.api#required": {} - } - }, - "data": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The data of the component. Used to specify the data inline. Either data\n\t\t\tor uri can be used to specify the data within the component.

" - } - }, - "uri": { - "target": "com.amazonaws.imagebuilder#Uri", - "traits": { - "smithy.api#documentation": "

The uri of the component. Must be an Amazon S3 URL and the requester must have permission\n\t\t\tto access the Amazon S3 bucket. If you use Amazon S3, you can specify component content up to your\n\t\t\tservice quota. Either data or uri can be used to specify the\n\t\t\tdata within the component.

" - } - }, - "kmsKeyId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the KMS key that should be used to encrypt this component.

" - } - }, - "tags": { - "target": "com.amazonaws.imagebuilder#TagMap", - "traits": { - "smithy.api#documentation": "

The tags of the component.

" - } - }, - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", - "traits": { - "smithy.api#documentation": "

The idempotency token of the component.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#ImportComponentResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", - "traits": { - "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" - } - }, - "componentBuildVersionArn": { - "target": "com.amazonaws.imagebuilder#ComponentBuildVersionArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the imported component.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#ImportVmImage": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#ImportVmImageRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#ImportVmImageResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

When you export your virtual machine (VM) from its virtualization environment, that\n\t\t\tprocess creates a set of one or more disk container files that act as snapshots of your\n\t\t\tVM’s environment, settings, and data. The Amazon EC2 API ImportImage\n\t\t\taction uses those files to import your VM and create an AMI. To import using the CLI\n\t\t\tcommand, see import-image\n

\n

You can reference the task ID from the VM import to pull in the AMI that the import\n\t\t\tcreated as the base image for your Image Builder recipe.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/ImportVmImage", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#ImportVmImageRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the base image that is created by the import process.

", - "smithy.api#required": {} - } - }, - "semanticVersion": { - "target": "com.amazonaws.imagebuilder#VersionNumber", - "traits": { - "smithy.api#documentation": "

The semantic version to attach to the base image that was created during the import\n\t\t\tprocess. This version follows the semantic version syntax.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n

\n Assignment: For the first three nodes you can assign any positive integer value, including \n\tzero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the \n\tbuild number to the fourth node.

\n

\n Patterns: You can use any numeric pattern that adheres to the assignment requirements for \n\tthe nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or \n\ta date, such as 2021.01.01.

\n ", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The description for the base image that is created by the import process.

" - } - }, - "platform": { - "target": "com.amazonaws.imagebuilder#Platform", - "traits": { - "smithy.api#documentation": "

The operating system platform for the imported VM.

", - "smithy.api#required": {} - } - }, - "osVersion": { - "target": "com.amazonaws.imagebuilder#OsVersion", - "traits": { - "smithy.api#documentation": "

The operating system version for the imported VM.

" - } - }, - "vmImportTaskId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The importTaskId (API) or ImportTaskId (CLI) from the\n\t\t\tAmazon EC2 VM import process. Image Builder retrieves information from the import process to pull in\n\t\t\tthe AMI that is created from the VM source as the base image for your recipe.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.imagebuilder#TagMap", - "traits": { - "smithy.api#documentation": "

Tags that are attached to the import resources.

" - } - }, - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure\n idempotency of the request. For more information, see Ensuring idempotency \n in the Amazon EC2 API Reference.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#ImportVmImageResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "imageArn": { - "target": "com.amazonaws.imagebuilder#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AMI that was created during the VM import\n\t\t\tprocess. This AMI is used as the base image for the recipe that imported the VM.

" - } - }, - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", - "traits": { - "smithy.api#documentation": "

The idempotency token that was used for this request.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#InfrastructureConfiguration": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.imagebuilder#ImageBuilderArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration.

" - } - }, - "name": { - "target": "com.amazonaws.imagebuilder#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the infrastructure configuration.

" - } - }, - "description": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The description of the infrastructure configuration.

" - } - }, - "instanceTypes": { - "target": "com.amazonaws.imagebuilder#InstanceTypeList", - "traits": { - "smithy.api#documentation": "

The instance types of the infrastructure configuration.

" - } - }, - "instanceProfileName": { - "target": "com.amazonaws.imagebuilder#InstanceProfileNameType", - "traits": { - "smithy.api#documentation": "

The instance profile of the infrastructure configuration.

" - } - }, - "securityGroupIds": { - "target": "com.amazonaws.imagebuilder#SecurityGroupIds", - "traits": { - "smithy.api#documentation": "

The security group IDs of the infrastructure configuration.

" - } - }, - "subnetId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The subnet ID of the infrastructure configuration.

" - } - }, - "logging": { - "target": "com.amazonaws.imagebuilder#Logging", - "traits": { - "smithy.api#documentation": "

The logging configuration of the infrastructure configuration.

" - } - }, - "keyPair": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon EC2 key pair of the infrastructure configuration.

" - } - }, - "terminateInstanceOnFailure": { - "target": "com.amazonaws.imagebuilder#NullableBoolean", - "traits": { - "smithy.api#documentation": "

The terminate instance on failure configuration of the infrastructure\n\t\t\tconfiguration.

" - } - }, - "snsTopicArn": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the SNS topic to which we send image build event\n\t\t\tnotifications.

\n \n

EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys \n\t\t\t\tfrom other accounts. The key that is used to encrypt the SNS topic must reside in the \n\t\t\t\taccount that the Image Builder service runs under.

\n " - } - }, - "dateCreated": { - "target": "com.amazonaws.imagebuilder#DateTime", - "traits": { - "smithy.api#documentation": "

The date on which the infrastructure configuration was created.

" - } - }, - "dateUpdated": { - "target": "com.amazonaws.imagebuilder#DateTime", - "traits": { - "smithy.api#documentation": "

The date on which the infrastructure configuration was last updated.

" - } - }, - "resourceTags": { - "target": "com.amazonaws.imagebuilder#ResourceTagMap", - "traits": { - "smithy.api#documentation": "

The tags attached to the resource created by Image Builder.

" - } - }, - "instanceMetadataOptions": { - "target": "com.amazonaws.imagebuilder#InstanceMetadataOptions", - "traits": { - "smithy.api#documentation": "

The instance metadata option settings for the infrastructure configuration.

" - } - }, - "tags": { - "target": "com.amazonaws.imagebuilder#TagMap", - "traits": { - "smithy.api#documentation": "

The tags of the infrastructure configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details of the infrastructure configuration.

" - } - }, - "com.amazonaws.imagebuilder#InfrastructureConfigurationArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):infrastructure-configuration/[a-z0-9-_]+$" - } - }, - "com.amazonaws.imagebuilder#InfrastructureConfigurationSummary": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.imagebuilder#ImageBuilderArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration.

" - } - }, - "name": { - "target": "com.amazonaws.imagebuilder#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the infrastructure configuration.

" - } - }, - "description": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The description of the infrastructure configuration.

" - } - }, - "dateCreated": { - "target": "com.amazonaws.imagebuilder#DateTime", - "traits": { - "smithy.api#documentation": "

The date on which the infrastructure configuration was created.

" - } - }, - "dateUpdated": { - "target": "com.amazonaws.imagebuilder#DateTime", - "traits": { - "smithy.api#documentation": "

The date on which the infrastructure configuration was last updated.

" - } - }, - "resourceTags": { - "target": "com.amazonaws.imagebuilder#ResourceTagMap", - "traits": { - "smithy.api#documentation": "

The tags attached to the image created by Image Builder.

" - } - }, - "tags": { - "target": "com.amazonaws.imagebuilder#TagMap", - "traits": { - "smithy.api#documentation": "

The tags of the infrastructure configuration.

" - } - }, - "instanceTypes": { - "target": "com.amazonaws.imagebuilder#InstanceTypeList", - "traits": { - "smithy.api#documentation": "

The instance types of the infrastructure configuration.

" - } - }, - "instanceProfileName": { - "target": "com.amazonaws.imagebuilder#InstanceProfileNameType", - "traits": { - "smithy.api#documentation": "

The instance profile of the infrastructure configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The infrastructure used when building Amazon EC2 AMIs.

" - } - }, - "com.amazonaws.imagebuilder#InfrastructureConfigurationSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationSummary" - } - }, - "com.amazonaws.imagebuilder#InlineComponentData": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 16000 - }, - "smithy.api#pattern": "^[^\\x00]+$" - } - }, - "com.amazonaws.imagebuilder#InlineDockerFileTemplate": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 16000 - }, - "smithy.api#pattern": "^[^\\x00]+$" - } - }, - "com.amazonaws.imagebuilder#InspectorScoreDetails": { - "type": "structure", - "members": { - "adjustedCvss": { - "target": "com.amazonaws.imagebuilder#CvssScoreDetails", - "traits": { - "smithy.api#documentation": "

An object that contains details about an adjustment that Amazon Inspector made to the CVSS score\n\t\t\tfor the finding.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the factors that influenced the score that Amazon Inspector assigned for a\n\t\t\tfinding.

" - } - }, - "com.amazonaws.imagebuilder#InstanceBlockDeviceMapping": { - "type": "structure", - "members": { - "deviceName": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The device to which these mappings apply.

" - } - }, - "ebs": { - "target": "com.amazonaws.imagebuilder#EbsInstanceBlockDeviceSpecification", - "traits": { - "smithy.api#documentation": "

Use to manage Amazon EBS-specific configuration for this mapping.

" - } - }, - "virtualName": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Use to manage instance ephemeral devices.

" - } - }, - "noDevice": { - "target": "com.amazonaws.imagebuilder#EmptyString", - "traits": { - "smithy.api#documentation": "

Use to remove a mapping from the base image.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Defines block device mappings for the instance used to configure your image.

" - } - }, - "com.amazonaws.imagebuilder#InstanceBlockDeviceMappings": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#InstanceBlockDeviceMapping" - } - }, - "com.amazonaws.imagebuilder#InstanceConfiguration": { - "type": "structure", - "members": { - "image": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The AMI ID to use as the base image for a container build and test instance. If not\n\t\t\tspecified, Image Builder will use the appropriate ECS-optimized AMI as a base image.

" - } - }, - "blockDeviceMappings": { - "target": "com.amazonaws.imagebuilder#InstanceBlockDeviceMappings", - "traits": { - "smithy.api#documentation": "

Defines the block devices to attach for building an instance from this Image Builder\n\t\t\tAMI.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Defines a custom base AMI and block device mapping configurations of an instance used\n\t\t\tfor building and testing container images.

" - } - }, - "com.amazonaws.imagebuilder#InstanceMetadataOptions": { - "type": "structure", - "members": { - "httpTokens": { - "target": "com.amazonaws.imagebuilder#HttpTokens", - "traits": { - "smithy.api#documentation": "

Indicates whether a signed token header is required for instance metadata retrieval\n\t\t\trequests. The values affect the response as follows:

\n \n

The default setting is optional.

" - } - }, - "httpPutResponseHopLimit": { - "target": "com.amazonaws.imagebuilder#HttpPutResponseHopLimit", - "traits": { - "smithy.api#documentation": "

Limit the number of hops that an instance metadata request can traverse to reach its\n\t\t\tdestination. The default is one hop. However, if HTTP tokens are required, container\n\t\t\timage builds need a minimum of two hops.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The instance metadata options that apply to the HTTP requests that pipeline builds use\n\t\t\tto launch EC2 build and test instances. For more information about instance metadata\n\t\t\toptions, see Configure the instance metadata options in the\n\t\t\t\t\n Amazon EC2 User Guide\n for Linux instances, or Configure the instance metadata options in the\n\t\t\t\t\n Amazon EC2 Windows Guide\n for Windows instances.

" - } - }, - "com.amazonaws.imagebuilder#InstanceProfileNameType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[\\w+=,.@-]+$" - } - }, - "com.amazonaws.imagebuilder#InstanceType": { - "type": "string" - }, - "com.amazonaws.imagebuilder#InstanceTypeList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#InstanceType" - } - }, - "com.amazonaws.imagebuilder#InvalidPaginationTokenException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.imagebuilder#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

You have provided an invalid pagination token in your request.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.imagebuilder#InvalidParameterCombinationException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.imagebuilder#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

You have specified two or more mutually exclusive parameters. Review the error message\n\t\t\tfor details.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.imagebuilder#InvalidParameterException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.imagebuilder#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The specified parameter is invalid. Review the available parameters for the API\n\t\t\trequest.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.imagebuilder#InvalidParameterValueException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.imagebuilder#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The value that you provided for the specified parameter is invalid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.imagebuilder#InvalidRequestException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.imagebuilder#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

You have requested an action that that the service doesn't support.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.imagebuilder#InvalidVersionNumberException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.imagebuilder#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

Your version number is out of bounds or does not follow the required syntax.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.imagebuilder#LaunchPermissionConfiguration": { - "type": "structure", - "members": { - "userIds": { - "target": "com.amazonaws.imagebuilder#AccountList", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

" - } - }, - "userGroups": { - "target": "com.amazonaws.imagebuilder#StringList", - "traits": { - "smithy.api#documentation": "

The name of the group.

" - } - }, - "organizationArns": { - "target": "com.amazonaws.imagebuilder#OrganizationArnList", - "traits": { - "smithy.api#documentation": "

The ARN for an Amazon Web Services Organization that you want to share your AMI with. For more\n\t\t\tinformation, see What is\n\t\t\t\tOrganizations?.

" - } - }, - "organizationalUnitArns": { - "target": "com.amazonaws.imagebuilder#OrganizationalUnitArnList", - "traits": { - "smithy.api#documentation": "

The ARN for an Organizations organizational unit (OU) that you want to share your AMI with.\n\t\t\tFor more information about key concepts for Organizations, see Organizations\n\t\t\t\tterminology and concepts.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the configuration for a launch permission. The launch permission\n\t\t\tmodification request is sent to the Amazon EC2\n\t\t\t\tModifyImageAttribute API on behalf of the user for each Region they have\n\t\t\tselected to distribute the AMI. To make an AMI public, set the launch permission\n\t\t\tauthorized accounts to all. See the examples for making an AMI public at\n\t\t\t\tAmazon EC2\n\t\t\t\tModifyImageAttribute.

" - } - }, - "com.amazonaws.imagebuilder#LaunchTemplateConfiguration": { - "type": "structure", - "members": { - "launchTemplateId": { - "target": "com.amazonaws.imagebuilder#LaunchTemplateId", - "traits": { - "smithy.api#documentation": "

Identifies the Amazon EC2 launch template to use.

", - "smithy.api#required": {} - } - }, - "accountId": { - "target": "com.amazonaws.imagebuilder#AccountId", - "traits": { - "smithy.api#documentation": "

The account ID that this configuration applies to.

" - } - }, - "setDefaultVersion": { - "target": "com.amazonaws.imagebuilder#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Set the specified Amazon EC2 launch template as the default launch template for the\n\t\t\tspecified account.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Identifies an Amazon EC2 launch template to use for a specific account.

" - } - }, - "com.amazonaws.imagebuilder#LaunchTemplateConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#LaunchTemplateConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.imagebuilder#LaunchTemplateId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^lt-[a-z0-9-_]{17}$" - } - }, - "com.amazonaws.imagebuilder#LicenseConfigurationArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws[^:]*:license-manager:[^:]+:[0-9]{12}:license-configuration:lic-[a-z0-9-_]{32}$" - } - }, - "com.amazonaws.imagebuilder#LicenseConfigurationArnList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#LicenseConfigurationArn" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.imagebuilder#ListComponentBuildVersions": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#ListComponentBuildVersionsRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#ListComponentBuildVersionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the list of component build versions for the specified semantic\n\t\t\tversion.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n

\n Filtering: With semantic versioning, you have the flexibility to use wildcards (x) \n\tto specify the most recent versions or nodes when selecting the base image or components for your \n\trecipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be \n\twildcards.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/ListComponentBuildVersions", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "componentSummaryList", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.imagebuilder#ListComponentBuildVersionsRequest": { - "type": "structure", - "members": { - "componentVersionArn": { - "target": "com.amazonaws.imagebuilder#ComponentVersionArn", - "traits": { - "smithy.api#documentation": "

The component version Amazon Resource Name (ARN) whose versions you want to\n\t\t\tlist.

", - "smithy.api#required": {} - } - }, - "maxResults": { - "target": "com.amazonaws.imagebuilder#RestrictedInteger", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum items to return in a request.

" - } - }, - "nextToken": { - "target": "com.amazonaws.imagebuilder#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#ListComponentBuildVersionsResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "componentSummaryList": { - "target": "com.amazonaws.imagebuilder#ComponentSummaryList", - "traits": { - "smithy.api#documentation": "

The list of component summaries for the specified semantic version.

" - } - }, - "nextToken": { - "target": "com.amazonaws.imagebuilder#PaginationToken", - "traits": { - "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#ListComponents": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#ListComponentsRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#ListComponentsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the list of components that can be filtered by name, or by using the listed\n\t\t\t\tfilters to streamline results. Newly created components can take up to\n\t\t\ttwo minutes to appear in the ListComponents API Results.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n

\n Filtering: With semantic versioning, you have the flexibility to use wildcards (x) \n\tto specify the most recent versions or nodes when selecting the base image or components for your \n\trecipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be \n\twildcards.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/ListComponents", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "componentVersionList", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.imagebuilder#ListComponentsRequest": { - "type": "structure", - "members": { - "owner": { - "target": "com.amazonaws.imagebuilder#Ownership", - "traits": { - "smithy.api#documentation": "

Filters results based on the type of owner for the component. By default, this request\n\t\t\treturns a list of components that your account owns. To see results for other types of\n\t\t\towners, you can specify components that Amazon manages, third party components, or\n\t\t\tcomponents that other accounts have shared with you.

" - } - }, - "filters": { - "target": "com.amazonaws.imagebuilder#FilterList", - "traits": { - "smithy.api#documentation": "

Use the following filters to streamline results:

\n " - } - }, - "byName": { - "target": "com.amazonaws.imagebuilder#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Returns the list of components for the specified name.

" - } - }, - "maxResults": { - "target": "com.amazonaws.imagebuilder#RestrictedInteger", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum items to return in a request.

" - } - }, - "nextToken": { - "target": "com.amazonaws.imagebuilder#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#ListComponentsResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "componentVersionList": { - "target": "com.amazonaws.imagebuilder#ComponentVersionList", - "traits": { - "smithy.api#documentation": "

The list of component semantic versions.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n " - } - }, - "nextToken": { - "target": "com.amazonaws.imagebuilder#PaginationToken", - "traits": { - "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#ListContainerRecipes": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#ListContainerRecipesRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#ListContainerRecipesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of container recipes.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ListContainerRecipes", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "containerRecipeSummaryList", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.imagebuilder#ListContainerRecipesRequest": { - "type": "structure", - "members": { - "owner": { - "target": "com.amazonaws.imagebuilder#Ownership", - "traits": { - "smithy.api#documentation": "

Returns container recipes belonging to the specified owner, that have been shared with\n\t\t\tyou. You can omit this field to return container recipes belonging to your\n\t\t\taccount.

" - } - }, - "filters": { - "target": "com.amazonaws.imagebuilder#FilterList", - "traits": { - "smithy.api#documentation": "

Use the following filters to streamline results:

\n " - } - }, - "maxResults": { - "target": "com.amazonaws.imagebuilder#RestrictedInteger", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum items to return in a request.

" - } - }, - "nextToken": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#ListContainerRecipesResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "containerRecipeSummaryList": { - "target": "com.amazonaws.imagebuilder#ContainerRecipeSummaryList", - "traits": { - "smithy.api#documentation": "

The list of container recipes returned for the request.

" - } - }, - "nextToken": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#ListDistributionConfigurations": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#ListDistributionConfigurationsRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#ListDistributionConfigurationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of distribution configurations.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ListDistributionConfigurations", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "distributionConfigurationSummaryList", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.imagebuilder#ListDistributionConfigurationsRequest": { - "type": "structure", - "members": { - "filters": { - "target": "com.amazonaws.imagebuilder#FilterList", - "traits": { - "smithy.api#documentation": "

You can filter on name to streamline results.

" - } - }, - "maxResults": { - "target": "com.amazonaws.imagebuilder#RestrictedInteger", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum items to return in a request.

" - } - }, - "nextToken": { - "target": "com.amazonaws.imagebuilder#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#ListDistributionConfigurationsResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "distributionConfigurationSummaryList": { - "target": "com.amazonaws.imagebuilder#DistributionConfigurationSummaryList", - "traits": { - "smithy.api#documentation": "

The list of distributions.

" - } - }, - "nextToken": { - "target": "com.amazonaws.imagebuilder#PaginationToken", - "traits": { - "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#ListImageBuildVersions": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#ListImageBuildVersionsRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#ListImageBuildVersionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of image build versions.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ListImageBuildVersions", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "imageSummaryList", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.imagebuilder#ListImageBuildVersionsRequest": { - "type": "structure", - "members": { - "imageVersionArn": { - "target": "com.amazonaws.imagebuilder#ImageVersionArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image whose build versions you want to\n\t\t\tretrieve.

", - "smithy.api#required": {} - } - }, - "filters": { - "target": "com.amazonaws.imagebuilder#FilterList", - "traits": { - "smithy.api#documentation": "

Use the following filters to streamline results:

\n " - } - }, - "maxResults": { - "target": "com.amazonaws.imagebuilder#RestrictedInteger", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum items to return in a request.

" - } - }, - "nextToken": { - "target": "com.amazonaws.imagebuilder#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#ListImageBuildVersionsResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "imageSummaryList": { - "target": "com.amazonaws.imagebuilder#ImageSummaryList", - "traits": { - "smithy.api#documentation": "

The list of image build versions.

" - } - }, - "nextToken": { - "target": "com.amazonaws.imagebuilder#PaginationToken", - "traits": { - "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#ListImagePackages": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#ListImagePackagesRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#ListImagePackagesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

List the Packages that are associated with an Image Build Version, as determined by\n\t\t\tAmazon Web Services Systems Manager Inventory at build time.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ListImagePackages", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "imagePackageList", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.imagebuilder#ListImagePackagesRequest": { - "type": "structure", - "members": { - "imageBuildVersionArn": { - "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", - "traits": { - "smithy.api#documentation": "

Filter results for the ListImagePackages request by the Image Build Version ARN

", - "smithy.api#required": {} - } - }, - "maxResults": { - "target": "com.amazonaws.imagebuilder#RestrictedInteger", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum items to return in a request.

" - } - }, - "nextToken": { - "target": "com.amazonaws.imagebuilder#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#ListImagePackagesResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "imagePackageList": { - "target": "com.amazonaws.imagebuilder#ImagePackageList", - "traits": { - "smithy.api#documentation": "

The list of Image Packages returned in the response.

" - } - }, - "nextToken": { - "target": "com.amazonaws.imagebuilder#PaginationToken", - "traits": { - "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#ListImagePipelineImages": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#ListImagePipelineImagesRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#ListImagePipelineImagesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of images created by the specified pipeline.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ListImagePipelineImages", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "imageSummaryList", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.imagebuilder#ListImagePipelineImagesRequest": { - "type": "structure", - "members": { - "imagePipelineArn": { - "target": "com.amazonaws.imagebuilder#ImagePipelineArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline whose images you want to\n\t\t\tview.

", - "smithy.api#required": {} - } - }, - "filters": { - "target": "com.amazonaws.imagebuilder#FilterList", - "traits": { - "smithy.api#documentation": "

Use the following filters to streamline results:

\n " - } - }, - "maxResults": { - "target": "com.amazonaws.imagebuilder#RestrictedInteger", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum items to return in a request.

" - } - }, - "nextToken": { - "target": "com.amazonaws.imagebuilder#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#ListImagePipelineImagesResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "imageSummaryList": { - "target": "com.amazonaws.imagebuilder#ImageSummaryList", - "traits": { - "smithy.api#documentation": "

The list of images built by this pipeline.

" - } - }, - "nextToken": { - "target": "com.amazonaws.imagebuilder#PaginationToken", - "traits": { - "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#ListImagePipelines": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#ListImagePipelinesRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#ListImagePipelinesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of image pipelines.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ListImagePipelines", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "imagePipelineList", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.imagebuilder#ListImagePipelinesRequest": { - "type": "structure", - "members": { - "filters": { - "target": "com.amazonaws.imagebuilder#FilterList", - "traits": { - "smithy.api#documentation": "

Use the following filters to streamline results:

\n " - } - }, - "maxResults": { - "target": "com.amazonaws.imagebuilder#RestrictedInteger", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum items to return in a request.

" - } - }, - "nextToken": { - "target": "com.amazonaws.imagebuilder#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#ListImagePipelinesResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "imagePipelineList": { - "target": "com.amazonaws.imagebuilder#ImagePipelineList", - "traits": { - "smithy.api#documentation": "

The list of image pipelines.

" - } - }, - "nextToken": { - "target": "com.amazonaws.imagebuilder#PaginationToken", - "traits": { - "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#ListImageRecipes": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#ListImageRecipesRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#ListImageRecipesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of image recipes.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ListImageRecipes", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "imageRecipeSummaryList", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.imagebuilder#ListImageRecipesRequest": { - "type": "structure", - "members": { - "owner": { - "target": "com.amazonaws.imagebuilder#Ownership", - "traits": { - "smithy.api#documentation": "

The owner defines which image recipes you want to list. By default, this request will\n\t\t\tonly show image recipes owned by your account. You can use this field to specify if you\n\t\t\twant to view image recipes owned by yourself, by Amazon, or those image recipes that\n\t\t\thave been shared with you by other customers.

" - } - }, - "filters": { - "target": "com.amazonaws.imagebuilder#FilterList", - "traits": { - "smithy.api#documentation": "

Use the following filters to streamline results:

\n " - } - }, - "maxResults": { - "target": "com.amazonaws.imagebuilder#RestrictedInteger", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum items to return in a request.

" - } - }, - "nextToken": { - "target": "com.amazonaws.imagebuilder#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#ListImageRecipesResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "imageRecipeSummaryList": { - "target": "com.amazonaws.imagebuilder#ImageRecipeSummaryList", - "traits": { - "smithy.api#documentation": "

The list of image pipelines.

" - } - }, - "nextToken": { - "target": "com.amazonaws.imagebuilder#PaginationToken", - "traits": { - "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#ListImageScanFindingAggregations": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#ListImageScanFindingAggregationsRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#ListImageScanFindingAggregationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of image scan aggregations for your account. You can filter by the type\n\t\t\tof key that Image Builder uses to group results. For example, if you want to get a list of\n\t\t\tfindings by severity level for one of your pipelines, you might specify your pipeline\n\t\t\twith the imagePipelineArn filter. If you don't specify a filter, Image Builder\n\t\t\treturns an aggregation for your account.

\n

To streamline results, you can use the following filters in your request:

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/ListImageScanFindingAggregations", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "responses" - } - } - }, - "com.amazonaws.imagebuilder#ListImageScanFindingAggregationsRequest": { - "type": "structure", - "members": { - "filter": { - "target": "com.amazonaws.imagebuilder#Filter" - }, - "nextToken": { - "target": "com.amazonaws.imagebuilder#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#ListImageScanFindingAggregationsResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "aggregationType": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The aggregation type specifies what type of key is used to group the image scan\n\t\t\tfindings. Image Builder returns results based on the request filter. If you didn't specify a\n\t\t\tfilter in the request, the type defaults to accountId.

\n

\n Aggregation types\n

\n \n

Each aggregation includes counts by severity level for medium severity and higher\n\t\t\tlevel findings, plus a total for all of the findings for each key value.

" - } - }, - "responses": { - "target": "com.amazonaws.imagebuilder#ImageScanFindingAggregationsList", - "traits": { - "smithy.api#documentation": "

An array of image scan finding aggregations that match the filter criteria.

" - } - }, - "nextToken": { - "target": "com.amazonaws.imagebuilder#PaginationToken", - "traits": { - "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#ListImageScanFindings": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#ListImageScanFindingsRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#ListImageScanFindingsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of image scan findings for your account.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ListImageScanFindings", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "findings", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.imagebuilder#ListImageScanFindingsRequest": { - "type": "structure", - "members": { - "filters": { - "target": "com.amazonaws.imagebuilder#ImageScanFindingsFilterList", - "traits": { - "smithy.api#documentation": "

An array of name value pairs that you can use to filter your results. You can use the\n\t\t\tfollowing filters to streamline results:

\n \n

If you don't request a filter, then all findings in your account are listed.

" - } - }, - "maxResults": { - "target": "com.amazonaws.imagebuilder#RestrictedInteger", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum items to return in a request.

" - } - }, - "nextToken": { - "target": "com.amazonaws.imagebuilder#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#ListImageScanFindingsResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "findings": { - "target": "com.amazonaws.imagebuilder#ImageScanFindingsList", - "traits": { - "smithy.api#documentation": "

The image scan findings for your account that meet your request filter\n\t\t\tcriteria.

" - } - }, - "nextToken": { - "target": "com.amazonaws.imagebuilder#PaginationToken", - "traits": { - "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#ListImages": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#ListImagesRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#ListImagesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the list of images that you have access to. Newly created images can take up\n\t\t\tto two minutes to appear in the ListImages API Results.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ListImages", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "imageVersionList", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.imagebuilder#ListImagesRequest": { - "type": "structure", - "members": { - "owner": { - "target": "com.amazonaws.imagebuilder#Ownership", - "traits": { - "smithy.api#documentation": "

The owner defines which images you want to list. By default, this request will only\n\t\t\tshow images owned by your account. You can use this field to specify if you want to view\n\t\t\timages owned by yourself, by Amazon, or those images that have been shared with you by\n\t\t\tother customers.

" - } - }, - "filters": { - "target": "com.amazonaws.imagebuilder#FilterList", - "traits": { - "smithy.api#documentation": "

Use the following filters to streamline results:

\n " - } - }, - "byName": { - "target": "com.amazonaws.imagebuilder#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Requests a list of images with a specific recipe name.

" - } - }, - "maxResults": { - "target": "com.amazonaws.imagebuilder#RestrictedInteger", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum items to return in a request.

" - } - }, - "nextToken": { - "target": "com.amazonaws.imagebuilder#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.

" - } - }, - "includeDeprecated": { - "target": "com.amazonaws.imagebuilder#NullableBoolean", - "traits": { - "smithy.api#documentation": "

Includes deprecated images in the response list.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#ListImagesResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "imageVersionList": { - "target": "com.amazonaws.imagebuilder#ImageVersionList", - "traits": { - "smithy.api#documentation": "

The list of image semantic versions.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n

\n Filtering: With semantic versioning, you have the flexibility to use wildcards (x) \n\tto specify the most recent versions or nodes when selecting the base image or components for your \n\trecipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be \n\twildcards.

\n " - } - }, - "nextToken": { - "target": "com.amazonaws.imagebuilder#PaginationToken", - "traits": { - "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#ListInfrastructureConfigurations": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#ListInfrastructureConfigurationsRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#ListInfrastructureConfigurationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of infrastructure configurations.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ListInfrastructureConfigurations", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "infrastructureConfigurationSummaryList", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.imagebuilder#ListInfrastructureConfigurationsRequest": { - "type": "structure", - "members": { - "filters": { - "target": "com.amazonaws.imagebuilder#FilterList", - "traits": { - "smithy.api#documentation": "

You can filter on name to streamline results.

" - } - }, - "maxResults": { - "target": "com.amazonaws.imagebuilder#RestrictedInteger", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum items to return in a request.

" - } - }, - "nextToken": { - "target": "com.amazonaws.imagebuilder#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#ListInfrastructureConfigurationsResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "infrastructureConfigurationSummaryList": { - "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationSummaryList", - "traits": { - "smithy.api#documentation": "

The list of infrastructure configurations.

" - } - }, - "nextToken": { - "target": "com.amazonaws.imagebuilder#PaginationToken", - "traits": { - "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#ListTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#InvalidParameterException" - }, - { - "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the list of tags for the specified resource.

", - "smithy.api#http": { - "method": "GET", - "uri": "/tags/{resourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.imagebuilder#ImageBuilderArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "tags": { - "target": "com.amazonaws.imagebuilder#TagMap", - "traits": { - "smithy.api#documentation": "

The tags for the specified resource.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#ListWorkflowExecutions": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#ListWorkflowExecutionsRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#ListWorkflowExecutionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of workflow runtime instance metadata objects for a specific image build\n\t\t\tversion.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ListWorkflowExecutions", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "workflowExecutions", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.imagebuilder#ListWorkflowExecutionsRequest": { - "type": "structure", - "members": { - "maxResults": { - "target": "com.amazonaws.imagebuilder#RestrictedInteger", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum items to return in a request.

" - } - }, - "nextToken": { - "target": "com.amazonaws.imagebuilder#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.

" - } - }, - "imageBuildVersionArn": { - "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", - "traits": { - "smithy.api#documentation": "

List all workflow runtime instances for the specified image build version \n\t\t\tresource ARN.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#ListWorkflowExecutionsResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "workflowExecutions": { - "target": "com.amazonaws.imagebuilder#WorkflowExecutionsList", - "traits": { - "smithy.api#documentation": "

Contains an array of runtime details that represents each time a workflow ran for \n\t\t\tthe requested image build version.

" - } - }, - "imageBuildVersionArn": { - "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", - "traits": { - "smithy.api#documentation": "

The resource ARN of the image build version for which you requested a list of \n\t\t\tworkflow runtime details.

" - } - }, - "message": { - "target": "com.amazonaws.imagebuilder#ImageBuildMessage", - "traits": { - "smithy.api#documentation": "

The output message from the list action, if applicable.

" - } - }, - "nextToken": { - "target": "com.amazonaws.imagebuilder#PaginationToken", - "traits": { - "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#ListWorkflowStepExecutions": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#ListWorkflowStepExecutionsRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#ListWorkflowStepExecutionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Shows runtime data for each step in a runtime instance of the workflow \n\t\t\tthat you specify in the request.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ListWorkflowStepExecutions", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "steps", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.imagebuilder#ListWorkflowStepExecutionsRequest": { - "type": "structure", - "members": { - "maxResults": { - "target": "com.amazonaws.imagebuilder#RestrictedInteger", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum items to return in a request.

" - } - }, - "nextToken": { - "target": "com.amazonaws.imagebuilder#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.

" - } - }, - "workflowExecutionId": { - "target": "com.amazonaws.imagebuilder#WorkflowExecutionId", - "traits": { - "smithy.api#documentation": "

The unique identifier that Image Builder assigned to keep track of runtime details\n\t\t\twhen it ran the workflow.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#ListWorkflowStepExecutionsResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "steps": { - "target": "com.amazonaws.imagebuilder#WorkflowStepExecutionsList", - "traits": { - "smithy.api#documentation": "

Contains an array of runtime details that represents each step in this runtime \n\t\t\tinstance of the workflow.

" - } - }, - "workflowBuildVersionArn": { - "target": "com.amazonaws.imagebuilder#WorkflowBuildVersionArn", - "traits": { - "smithy.api#documentation": "

The build version ARN for the Image Builder workflow resource that defines the steps for \n\t\t\tthis runtime instance of the workflow.

" - } - }, - "workflowExecutionId": { - "target": "com.amazonaws.imagebuilder#WorkflowExecutionId", - "traits": { - "smithy.api#documentation": "

The unique identifier that Image Builder assigned to keep track of runtime details\n\t\t\twhen it ran the workflow.

" - } - }, - "imageBuildVersionArn": { - "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", - "traits": { - "smithy.api#documentation": "

The image build version resource ARN that's associated with the specified runtime \n\t\t\tinstance of the workflow.

" - } - }, - "message": { - "target": "com.amazonaws.imagebuilder#ImageBuildMessage", - "traits": { - "smithy.api#documentation": "

The output message from the list action, if applicable.

" - } - }, - "nextToken": { - "target": "com.amazonaws.imagebuilder#PaginationToken", - "traits": { - "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#Logging": { - "type": "structure", - "members": { - "s3Logs": { - "target": "com.amazonaws.imagebuilder#S3Logs", - "traits": { - "smithy.api#documentation": "

The Amazon S3 logging configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Logging configuration defines where Image Builder uploads your logs.

" - } - }, - "com.amazonaws.imagebuilder#MaxParallelLaunches": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 10000 - } - } - }, - "com.amazonaws.imagebuilder#NonEmptyString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.imagebuilder#NonEmptyStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#NonEmptyString" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.imagebuilder#NonNegativeDouble": { - "type": "double", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.imagebuilder#NullableBoolean": { - "type": "boolean" - }, - "com.amazonaws.imagebuilder#OrganizationArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws[^:]*:organizations::[0-9]{12}:organization/o-[a-z0-9]{10,32}$" - } - }, - "com.amazonaws.imagebuilder#OrganizationArnList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#OrganizationArn" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 25 - } - } - }, - "com.amazonaws.imagebuilder#OrganizationalUnitArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws[^:]*:organizations::[0-9]{12}:ou/o-[a-z0-9]{10,32}/ou-[0-9a-z]{4,32}-[0-9a-z]{8,32}$" - } - }, - "com.amazonaws.imagebuilder#OrganizationalUnitArnList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#OrganizationalUnitArn" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 25 - } - } - }, - "com.amazonaws.imagebuilder#OsVersion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.imagebuilder#OsVersionList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#OsVersion" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 25 - } - } - }, - "com.amazonaws.imagebuilder#OutputResources": { - "type": "structure", - "members": { - "amis": { - "target": "com.amazonaws.imagebuilder#AmiList", - "traits": { - "smithy.api#documentation": "

The Amazon EC2 AMIs created by this image.

" - } - }, - "containers": { - "target": "com.amazonaws.imagebuilder#ContainerList", - "traits": { - "smithy.api#documentation": "

Container images that the pipeline has generated and stored in the output\n\t\t\trepository.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The resources produced by this image.

" - } - }, - "com.amazonaws.imagebuilder#Ownership": { - "type": "enum", - "members": { - "SELF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Self" - } - }, - "SHARED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Shared" - } - }, - "AMAZON": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Amazon" - } - }, - "THIRDPARTY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ThirdParty" - } - } - } - }, - "com.amazonaws.imagebuilder#PackageArchitecture": { - "type": "string" - }, - "com.amazonaws.imagebuilder#PackageEpoch": { - "type": "integer" - }, - "com.amazonaws.imagebuilder#PackageVulnerabilityDetails": { - "type": "structure", - "members": { - "vulnerabilityId": { - "target": "com.amazonaws.imagebuilder#VulnerabilityId", - "traits": { - "smithy.api#documentation": "

A unique identifier for this vulnerability.

", - "smithy.api#required": {} - } - }, - "vulnerablePackages": { - "target": "com.amazonaws.imagebuilder#VulnerablePackageList", - "traits": { - "smithy.api#documentation": "

The packages that this vulnerability impacts.

" - } - }, - "source": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The source of the vulnerability information.

" - } - }, - "cvss": { - "target": "com.amazonaws.imagebuilder#CvssScoreList", - "traits": { - "smithy.api#documentation": "

CVSS scores for one or more vulnerabilities that Amazon Inspector identified for a\n\t\t\tpackage.

" - } - }, - "relatedVulnerabilities": { - "target": "com.amazonaws.imagebuilder#VulnerabilityIdList", - "traits": { - "smithy.api#documentation": "

Vulnerabilities that are often related to the findings for the package.

" - } - }, - "sourceUrl": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A link to the source of the vulnerability information.

" - } - }, - "vendorSeverity": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The severity that the vendor assigned to this vulnerability type.

" - } - }, - "vendorCreatedAt": { - "target": "com.amazonaws.imagebuilder#DateTimeTimestamp", - "traits": { - "smithy.api#documentation": "

The date and time when this vulnerability was first added to the vendor's\n\t\t\tdatabase.

" - } - }, - "vendorUpdatedAt": { - "target": "com.amazonaws.imagebuilder#DateTimeTimestamp", - "traits": { - "smithy.api#documentation": "

The date and time when the vendor last updated this vulnerability in their\n\t\t\tdatabase.

" - } - }, - "referenceUrls": { - "target": "com.amazonaws.imagebuilder#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

Links to web pages that contain details about the vulnerabilities that Amazon Inspector\n\t\t\tidentified for the package.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about package vulnerability findings.

" - } - }, - "com.amazonaws.imagebuilder#PaginationToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 65535 - } - } - }, - "com.amazonaws.imagebuilder#PipelineExecutionStartCondition": { - "type": "enum", - "members": { - "EXPRESSION_MATCH_ONLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXPRESSION_MATCH_ONLY" - } - }, - "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE" - } - } - } - }, - "com.amazonaws.imagebuilder#PipelineStatus": { - "type": "enum", - "members": { - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - }, - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - } - } - }, - "com.amazonaws.imagebuilder#Platform": { - "type": "enum", - "members": { - "WINDOWS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Windows" - } - }, - "LINUX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Linux" - } - } - } - }, - "com.amazonaws.imagebuilder#PutComponentPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#PutComponentPolicyRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#PutComponentPolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Applies a policy to a component. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API\n\t\t\t\tPutComponentPolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be\n\t\t\tvisible to all principals with whom the resource is shared.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/PutComponentPolicy", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#PutComponentPolicyRequest": { - "type": "structure", - "members": { - "componentArn": { - "target": "com.amazonaws.imagebuilder#ComponentBuildVersionArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component that this policy should be applied\n\t\t\tto.

", - "smithy.api#required": {} - } - }, - "policy": { - "target": "com.amazonaws.imagebuilder#ResourcePolicyDocument", - "traits": { - "smithy.api#documentation": "

The policy to apply.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#PutComponentPolicyResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "componentArn": { - "target": "com.amazonaws.imagebuilder#ComponentBuildVersionArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component that this policy was applied\n\t\t\tto.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#PutContainerRecipePolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#PutContainerRecipePolicyRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#PutContainerRecipePolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Applies a policy to a container image. We recommend that you call the RAM API\n\t\t\tCreateResourceShare\n\t\t\t(https://docs.aws.amazon.com//ram/latest/APIReference/API_CreateResourceShare.html) to share\n\t\t\tresources. If you call the Image Builder API PutContainerImagePolicy, you must also\n\t\t\tcall the RAM API PromoteResourceShareCreatedFromPolicy\n\t\t\t(https://docs.aws.amazon.com//ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html)\n\t\t\tin order for the resource to be visible to all principals with whom the resource is\n\t\t\tshared.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/PutContainerRecipePolicy", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#PutContainerRecipePolicyRequest": { - "type": "structure", - "members": { - "containerRecipeArn": { - "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container recipe that this policy should be\n\t\t\tapplied to.

", - "smithy.api#required": {} - } - }, - "policy": { - "target": "com.amazonaws.imagebuilder#ResourcePolicyDocument", - "traits": { - "smithy.api#documentation": "

The policy to apply to the container recipe.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#PutContainerRecipePolicyResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "containerRecipeArn": { - "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container recipe that this policy was applied\n\t\t\tto.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#PutImagePolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#PutImagePolicyRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#PutImagePolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Applies a policy to an image. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API\n\t\t\t\tPutImagePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be\n\t\t\tvisible to all principals with whom the resource is shared.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/PutImagePolicy", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#PutImagePolicyRequest": { - "type": "structure", - "members": { - "imageArn": { - "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image that this policy should be applied\n\t\t\tto.

", - "smithy.api#required": {} - } - }, - "policy": { - "target": "com.amazonaws.imagebuilder#ResourcePolicyDocument", - "traits": { - "smithy.api#documentation": "

The policy to apply.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#PutImagePolicyResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "imageArn": { - "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image that this policy was applied to.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#PutImageRecipePolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#PutImageRecipePolicyRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#PutImageRecipePolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Applies a policy to an image recipe. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API\n\t\t\t\tPutImageRecipePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be\n\t\t\tvisible to all principals with whom the resource is shared.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/PutImageRecipePolicy", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#PutImageRecipePolicyRequest": { - "type": "structure", - "members": { - "imageRecipeArn": { - "target": "com.amazonaws.imagebuilder#ImageRecipeArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe that this policy should be applied\n\t\t\tto.

", - "smithy.api#required": {} - } - }, - "policy": { - "target": "com.amazonaws.imagebuilder#ResourcePolicyDocument", - "traits": { - "smithy.api#documentation": "

The policy to apply.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#PutImageRecipePolicyResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "imageRecipeArn": { - "target": "com.amazonaws.imagebuilder#ImageRecipeArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe that this policy was applied\n\t\t\tto.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#RegionList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#NonEmptyString" - } - }, - "com.amazonaws.imagebuilder#Remediation": { - "type": "structure", - "members": { - "recommendation": { - "target": "com.amazonaws.imagebuilder#RemediationRecommendation", - "traits": { - "smithy.api#documentation": "

An object that contains information about the recommended course of action to\n\t\t\tremediate the finding.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about how to remediate a finding.

" - } - }, - "com.amazonaws.imagebuilder#RemediationRecommendation": { - "type": "structure", - "members": { - "text": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The recommended course of action to remediate the finding.

" - } - }, - "url": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A link to more information about the recommended remediation for this\n\t\t\tvulnerability.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about the recommended course of action to remediate the finding.

" - } - }, - "com.amazonaws.imagebuilder#ResourceAlreadyExistsException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.imagebuilder#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The resource that you are trying to create already exists.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.imagebuilder#ResourceDependencyException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.imagebuilder#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

You have attempted to mutate or delete a resource with a dependency that prohibits\n\t\t\tthis action. See the error message for more details.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.imagebuilder#ResourceInUseException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.imagebuilder#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The resource that you are trying to operate on is currently in use. Review the message\n\t\t\tdetails and retry later.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.imagebuilder#ResourceName": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[-_A-Za-z-0-9][-_A-Za-z0-9 ]{1,126}[-_A-Za-z-0-9]$" - } - }, - "com.amazonaws.imagebuilder#ResourceNotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.imagebuilder#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

At least one of the resources referenced by your request does not exist.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.imagebuilder#ResourcePolicyDocument": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 30000 - } - } - }, - "com.amazonaws.imagebuilder#ResourceTagMap": { - "type": "map", - "key": { - "target": "com.amazonaws.imagebuilder#TagKey" - }, - "value": { - "target": "com.amazonaws.imagebuilder#TagValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 30 - } - } - }, - "com.amazonaws.imagebuilder#RestrictedInteger": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 25 - } - } - }, - "com.amazonaws.imagebuilder#S3ExportConfiguration": { - "type": "structure", - "members": { - "roleName": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the role that grants VM Import/Export permission to export images to your\n\t\t\tS3 bucket.

", - "smithy.api#required": {} - } - }, - "diskImageFormat": { - "target": "com.amazonaws.imagebuilder#DiskImageFormat", - "traits": { - "smithy.api#documentation": "

Export the updated image to one of the following supported disk image formats:

\n ", - "smithy.api#required": {} - } - }, - "s3Bucket": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The S3 bucket in which to store the output disk images for your VM.

", - "smithy.api#required": {} - } - }, - "s3Prefix": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon S3 path for the bucket where the output disk images for your VM are\n\t\t\tstored.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Properties that configure export from your build instance to a compatible file format\n\t\t\tfor your VM.

" - } - }, - "com.amazonaws.imagebuilder#S3Logs": { - "type": "structure", - "members": { - "s3BucketName": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The S3 bucket in which to store the logs.

" - } - }, - "s3KeyPrefix": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon S3 path to the bucket where the logs are stored.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Amazon S3 logging configuration.

" - } - }, - "com.amazonaws.imagebuilder#Schedule": { - "type": "structure", - "members": { - "scheduleExpression": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The cron expression determines how often EC2 Image Builder evaluates your\n\t\t\t\tpipelineExecutionStartCondition.

\n

For information on how to format a cron expression in Image Builder, see Use\n\t\t\t\tcron expressions in EC2 Image Builder.

" - } - }, - "timezone": { - "target": "com.amazonaws.imagebuilder#Timezone", - "traits": { - "smithy.api#documentation": "

The timezone that applies to the scheduling expression. For example, \"Etc/UTC\",\n\t\t\t\"America/Los_Angeles\" in the IANA timezone format. If not specified this defaults to UTC.

" - } - }, - "pipelineExecutionStartCondition": { - "target": "com.amazonaws.imagebuilder#PipelineExecutionStartCondition", - "traits": { - "smithy.api#documentation": "

The condition configures when the pipeline should trigger a new image build. When the\n\t\t\t\tpipelineExecutionStartCondition is set to\n\t\t\t\tEXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE, and you use semantic\n\t\t\tversion filters on the base image or components in your image recipe, EC2 Image Builder will\n\t\t\tbuild a new image only when there are new versions of the image or components in your\n\t\t\trecipe that match the semantic version filter. When it is set to\n\t\t\t\tEXPRESSION_MATCH_ONLY, it will build a new image every time the CRON\n\t\t\texpression matches the current time. For semantic version syntax, see CreateComponent in the EC2 Image Builder API Reference.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A schedule configures how often and when a pipeline will automatically create a new\n\t\t\timage.

" - } - }, - "com.amazonaws.imagebuilder#SecurityGroupIds": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#NonEmptyString" - } - }, - "com.amazonaws.imagebuilder#ServiceException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.imagebuilder#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

This exception is thrown when the service encounters an unrecoverable\n\t\t\texception.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.imagebuilder#ServiceQuotaExceededException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.imagebuilder#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

You have exceeded the number of permitted resources or operations for this service.\n\t\t\tFor service quotas, see EC2 Image Builder endpoints and\n\t\t\t\tquotas.

", - "smithy.api#error": "client", - "smithy.api#httpError": 402 - } - }, - "com.amazonaws.imagebuilder#ServiceUnavailableException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.imagebuilder#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The service is unable to process your request at this time.

", - "smithy.api#error": "server", - "smithy.api#httpError": 503 - } - }, - "com.amazonaws.imagebuilder#SeverityCountNumber": { - "type": "long" - }, - "com.amazonaws.imagebuilder#SeverityCounts": { - "type": "structure", - "members": { - "all": { - "target": "com.amazonaws.imagebuilder#SeverityCountNumber", - "traits": { - "smithy.api#documentation": "

The total number of findings across all severity levels for the specified filter.

" - } - }, - "critical": { - "target": "com.amazonaws.imagebuilder#SeverityCountNumber", - "traits": { - "smithy.api#documentation": "

The number of critical severity findings for the specified filter.

" - } - }, - "high": { - "target": "com.amazonaws.imagebuilder#SeverityCountNumber", - "traits": { - "smithy.api#documentation": "

The number of high severity findings for the specified filter.

" - } - }, - "medium": { - "target": "com.amazonaws.imagebuilder#SeverityCountNumber", - "traits": { - "smithy.api#documentation": "

The number of medium severity findings for the specified filter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Includes counts by severity level for medium severity and higher level findings, plus a total\n\t\t\tfor all of the findings for the specified filter.

" - } - }, - "com.amazonaws.imagebuilder#SnsTopicArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws[^:]*:sns:[^:]+:[0-9]{12}:[a-zA-Z0-9-_]{1,256}$" - } - }, - "com.amazonaws.imagebuilder#SourceLayerHash": { - "type": "string" - }, - "com.amazonaws.imagebuilder#StartImagePipelineExecution": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#StartImagePipelineExecutionRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#StartImagePipelineExecutionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + "com.amazonaws.imagebuilder#CreateImageRecipeRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the image recipe.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description of the image recipe.

" + } + }, + "semanticVersion": { + "target": "com.amazonaws.imagebuilder#VersionNumber", + "traits": { + "smithy.api#documentation": "

The semantic version of the image recipe. This version follows the semantic version\n\t\t\tsyntax.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n

\n Assignment: For the first three nodes you can assign any positive integer value, including \n\tzero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the \n\tbuild number to the fourth node.

\n

\n Patterns: You can use any numeric pattern that adheres to the assignment requirements for \n\tthe nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or \n\ta date, such as 2021.01.01.

\n ", + "smithy.api#required": {} + } + }, + "components": { + "target": "com.amazonaws.imagebuilder#ComponentConfigurationList", + "traits": { + "smithy.api#documentation": "

The components included in the image recipe.

", + "smithy.api#required": {} + } + }, + "parentImage": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The base image of the image recipe. The value of the string can be the ARN of the base\n\t\t\timage or an AMI ID. The format for the ARN follows this example:\n\t\t\t\tarn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x.\n\t\t\tYou can provide the specific version that you want to use, or you can use a wildcard in\n\t\t\tall of the fields. If you enter an AMI ID for the string value, you must have access to\n\t\t\tthe AMI, and the AMI must be in the same Region in which you are using Image Builder.

", + "smithy.api#required": {} + } + }, + "blockDeviceMappings": { + "target": "com.amazonaws.imagebuilder#InstanceBlockDeviceMappings", + "traits": { + "smithy.api#documentation": "

The block device mappings of the image recipe.

" + } + }, + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", + "traits": { + "smithy.api#documentation": "

The tags of the image recipe.

" + } + }, + "workingDirectory": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The working directory used during build and test workflows.

" + } + }, + "additionalInstanceConfiguration": { + "target": "com.amazonaws.imagebuilder#AdditionalInstanceConfiguration", + "traits": { + "smithy.api#documentation": "

Specify additional settings and launch scripts for your build instances.

" + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#CreateImageRecipeResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" + } + }, + "imageRecipeArn": { + "target": "com.amazonaws.imagebuilder#ImageRecipeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe that was created by this\n\t\t\trequest.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#CreateImageRequest": { + "type": "structure", + "members": { + "imageRecipeArn": { + "target": "com.amazonaws.imagebuilder#ImageRecipeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe that defines how images are\n\t\t\tconfigured, tested, and assessed.

" + } + }, + "containerRecipeArn": { + "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container recipe that defines how images are\n\t\t\tconfigured and tested.

" + } + }, + "distributionConfigurationArn": { + "target": "com.amazonaws.imagebuilder#DistributionConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration that defines and\n\t\t\tconfigures the outputs of your pipeline.

" + } + }, + "infrastructureConfigurationArn": { + "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that defines the\n\t\t\tenvironment in which your image will be built and tested.

", + "smithy.api#required": {} + } + }, + "imageTestsConfiguration": { + "target": "com.amazonaws.imagebuilder#ImageTestsConfiguration", + "traits": { + "smithy.api#documentation": "

The image tests configuration of the image.

" + } + }, + "enhancedImageMetadataEnabled": { + "target": "com.amazonaws.imagebuilder#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Collects additional information about the image being created, including the operating\n\t\t\tsystem (OS) version and package list. This information is used to enhance the overall\n\t\t\texperience of using EC2 Image Builder. Enabled by default.

" + } + }, + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", + "traits": { + "smithy.api#documentation": "

The tags of the image.

" + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "imageScanningConfiguration": { + "target": "com.amazonaws.imagebuilder#ImageScanningConfiguration", + "traits": { + "smithy.api#documentation": "

Contains settings for vulnerability scans.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#CreateImageResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" + } + }, + "imageBuildVersionArn": { + "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image that this request created.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#CreateInfrastructureConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#CreateInfrastructureConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#CreateInfrastructureConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceInUseException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new infrastructure configuration. An infrastructure configuration defines\n\t\t\tthe environment in which your image will be built and tested.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/CreateInfrastructureConfiguration", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#CreateInfrastructureConfigurationRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the infrastructure configuration.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description of the infrastructure configuration.

" + } + }, + "instanceTypes": { + "target": "com.amazonaws.imagebuilder#InstanceTypeList", + "traits": { + "smithy.api#documentation": "

The instance types of the infrastructure configuration. You can specify one or more\n\t\t\tinstance types to use for this build. The service will pick one of these instance types\n\t\t\tbased on availability.

" + } + }, + "instanceProfileName": { + "target": "com.amazonaws.imagebuilder#InstanceProfileNameType", + "traits": { + "smithy.api#documentation": "

The instance profile to associate with the instance used to customize your Amazon EC2\n\t\t\tAMI.

", + "smithy.api#required": {} + } + }, + "securityGroupIds": { + "target": "com.amazonaws.imagebuilder#SecurityGroupIds", + "traits": { + "smithy.api#documentation": "

The security group IDs to associate with the instance used to customize your Amazon EC2\n\t\t\tAMI.

" + } + }, + "subnetId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The subnet ID in which to place the instance used to customize your Amazon EC2 AMI.

" + } + }, + "logging": { + "target": "com.amazonaws.imagebuilder#Logging", + "traits": { + "smithy.api#documentation": "

The logging configuration of the infrastructure configuration.

" + } + }, + "keyPair": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The key pair of the infrastructure configuration. You can use this to log on to and\n\t\t\tdebug the instance used to create your image.

" + } + }, + "terminateInstanceOnFailure": { + "target": "com.amazonaws.imagebuilder#NullableBoolean", + "traits": { + "smithy.api#documentation": "

The terminate instance on failure setting of the infrastructure configuration. Set to\n\t\t\tfalse if you want Image Builder to retain the instance used to configure your AMI if the build or\n\t\t\ttest phase of your workflow fails.

" + } + }, + "snsTopicArn": { + "target": "com.amazonaws.imagebuilder#SnsTopicArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the SNS topic to which we send image build event\n\t\t\tnotifications.

\n \n

EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys \n\t\t\t\tfrom other accounts. The key that is used to encrypt the SNS topic must reside in the \n\t\t\t\taccount that the Image Builder service runs under.

\n " + } + }, + "resourceTags": { + "target": "com.amazonaws.imagebuilder#ResourceTagMap", + "traits": { + "smithy.api#documentation": "

The tags attached to the resource created by Image Builder.

" + } + }, + "instanceMetadataOptions": { + "target": "com.amazonaws.imagebuilder#InstanceMetadataOptions", + "traits": { + "smithy.api#documentation": "

The instance metadata options that you can set for the HTTP requests that pipeline\n\t\t\tbuilds use to launch EC2 build and test instances.

" + } + }, + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", + "traits": { + "smithy.api#documentation": "

The tags of the infrastructure configuration.

" + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#CreateInfrastructureConfigurationResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" + } + }, + "infrastructureConfigurationArn": { + "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that was created by\n\t\t\tthis request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#CvssScore": { + "type": "structure", + "members": { + "baseScore": { + "target": "com.amazonaws.imagebuilder#NonNegativeDouble", + "traits": { + "smithy.api#documentation": "

The CVSS base score.

" + } + }, + "scoringVector": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The vector string of the CVSS score.

" + } + }, + "version": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The CVSS version that generated the score.

" + } + }, + "source": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The source of the CVSS score.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Amazon Inspector generates a risk score for each finding. This score helps you to prioritize\n\t\t\tfindings, to focus on the most critical findings and the most vulnerable resources. The\n\t\t\tscore uses the Common Vulnerability Scoring System (CVSS) format. This format is a\n\t\t\tmodification of the base CVSS score that the National Vulnerability Database (NVD)\n\t\t\tprovides. For more information about severity levels, see Severity levels for Amazon Inspector findings in the Amazon Inspector User\n\t\t\t\tGuide.

" + } + }, + "com.amazonaws.imagebuilder#CvssScoreAdjustment": { + "type": "structure", + "members": { + "metric": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The metric that Amazon Inspector used to adjust the CVSS score.

" + } + }, + "reason": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The reason for the CVSS score adjustment.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about an adjustment that Amazon Inspector made to the CVSS score for a finding.

" + } + }, + "com.amazonaws.imagebuilder#CvssScoreAdjustmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#CvssScoreAdjustment" + } + }, + "com.amazonaws.imagebuilder#CvssScoreDetails": { + "type": "structure", + "members": { + "scoreSource": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The source for the CVSS score.

" + } + }, + "cvssSource": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The source of the finding.

" + } + }, + "version": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The CVSS version that generated the score.

" + } + }, + "score": { + "target": "com.amazonaws.imagebuilder#NonNegativeDouble", + "traits": { + "smithy.api#documentation": "

The CVSS score.

" + } + }, + "scoringVector": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A vector that measures the severity of the vulnerability.

" + } + }, + "adjustments": { + "target": "com.amazonaws.imagebuilder#CvssScoreAdjustmentList", + "traits": { + "smithy.api#documentation": "

An object that contains details about an adjustment that Amazon Inspector made to the CVSS score\n\t\t\tfor the finding.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the source of the score, and the factors that determined the adjustments\n\t\t\tto create the final score.

" + } + }, + "com.amazonaws.imagebuilder#CvssScoreList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#CvssScore" + } + }, + "com.amazonaws.imagebuilder#DateTime": { + "type": "string" + }, + "com.amazonaws.imagebuilder#DateTimeTimestamp": { + "type": "timestamp" + }, + "com.amazonaws.imagebuilder#DeleteComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#DeleteComponentRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#DeleteComponentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceDependencyException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a component build version.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/DeleteComponent", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#DeleteComponentRequest": { + "type": "structure", + "members": { + "componentBuildVersionArn": { + "target": "com.amazonaws.imagebuilder#ComponentBuildVersionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component build version to delete.

", + "smithy.api#httpQuery": "componentBuildVersionArn", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#DeleteComponentResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "componentBuildVersionArn": { + "target": "com.amazonaws.imagebuilder#ComponentBuildVersionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the component build version that this request deleted.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#DeleteContainerRecipe": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#DeleteContainerRecipeRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#DeleteContainerRecipeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceDependencyException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a container recipe.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/DeleteContainerRecipe", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#DeleteContainerRecipeRequest": { + "type": "structure", + "members": { + "containerRecipeArn": { + "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container recipe to delete.

", + "smithy.api#httpQuery": "containerRecipeArn", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#DeleteContainerRecipeResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "containerRecipeArn": { + "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container recipe that was deleted.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#DeleteDistributionConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#DeleteDistributionConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#DeleteDistributionConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceDependencyException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a distribution configuration.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/DeleteDistributionConfiguration", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#DeleteDistributionConfigurationRequest": { + "type": "structure", + "members": { + "distributionConfigurationArn": { + "target": "com.amazonaws.imagebuilder#DistributionConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration to delete.

", + "smithy.api#httpQuery": "distributionConfigurationArn", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#DeleteDistributionConfigurationResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "distributionConfigurationArn": { + "target": "com.amazonaws.imagebuilder#DistributionConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration that was\n\t\t\tdeleted.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#DeleteImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#DeleteImageRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#DeleteImageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceDependencyException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an Image Builder image resource. This does not delete any EC2 AMIs or ECR container\n\t\t\timages that are created during the image build process. You must clean those up\n\t\t\tseparately, using the appropriate Amazon EC2 or Amazon ECR console actions, or API or CLI\n\t\t\tcommands.

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/DeleteImage", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#DeleteImagePipeline": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#DeleteImagePipelineRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#DeleteImagePipelineResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceDependencyException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an image pipeline.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/DeleteImagePipeline", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#DeleteImagePipelineRequest": { + "type": "structure", + "members": { + "imagePipelineArn": { + "target": "com.amazonaws.imagebuilder#ImagePipelineArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline to delete.

", + "smithy.api#httpQuery": "imagePipelineArn", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#DeleteImagePipelineResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "imagePipelineArn": { + "target": "com.amazonaws.imagebuilder#ImagePipelineArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline that was deleted.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#DeleteImageRecipe": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#DeleteImageRecipeRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#DeleteImageRecipeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceDependencyException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an image recipe.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/DeleteImageRecipe", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#DeleteImageRecipeRequest": { + "type": "structure", + "members": { + "imageRecipeArn": { + "target": "com.amazonaws.imagebuilder#ImageRecipeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe to delete.

", + "smithy.api#httpQuery": "imageRecipeArn", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#DeleteImageRecipeResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "imageRecipeArn": { + "target": "com.amazonaws.imagebuilder#ImageRecipeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe that was deleted.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#DeleteImageRequest": { + "type": "structure", + "members": { + "imageBuildVersionArn": { + "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Image Builder image resource to delete.

", + "smithy.api#httpQuery": "imageBuildVersionArn", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#DeleteImageResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "imageBuildVersionArn": { + "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the Image Builder image resource that this request deleted.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#DeleteInfrastructureConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#DeleteInfrastructureConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#DeleteInfrastructureConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceDependencyException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an infrastructure configuration.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/DeleteInfrastructureConfiguration", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#DeleteInfrastructureConfigurationRequest": { + "type": "structure", + "members": { + "infrastructureConfigurationArn": { + "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration to delete.

", + "smithy.api#httpQuery": "infrastructureConfigurationArn", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#DeleteInfrastructureConfigurationResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "infrastructureConfigurationArn": { + "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that was\n\t\t\tdeleted.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#DiskImageFormat": { + "type": "enum", + "members": { + "VMDK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VMDK" + } + }, + "RAW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RAW" + } + }, + "VHD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VHD" + } + } + } + }, + "com.amazonaws.imagebuilder#Distribution": { + "type": "structure", + "members": { + "region": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The target Region.

", + "smithy.api#required": {} + } + }, + "amiDistributionConfiguration": { + "target": "com.amazonaws.imagebuilder#AmiDistributionConfiguration", + "traits": { + "smithy.api#documentation": "

The specific AMI settings; for example, launch permissions or AMI tags.

" + } + }, + "containerDistributionConfiguration": { + "target": "com.amazonaws.imagebuilder#ContainerDistributionConfiguration", + "traits": { + "smithy.api#documentation": "

Container distribution settings for encryption, licensing, and sharing in a specific\n\t\t\tRegion.

" + } + }, + "licenseConfigurationArns": { + "target": "com.amazonaws.imagebuilder#LicenseConfigurationArnList", + "traits": { + "smithy.api#documentation": "

The License Manager Configuration to associate with the AMI in the specified\n\t\t\tRegion.

" + } + }, + "launchTemplateConfigurations": { + "target": "com.amazonaws.imagebuilder#LaunchTemplateConfigurationList", + "traits": { + "smithy.api#documentation": "

A group of launchTemplateConfiguration settings that apply to image distribution for\n\t\t\tspecified accounts.

" + } + }, + "s3ExportConfiguration": { + "target": "com.amazonaws.imagebuilder#S3ExportConfiguration", + "traits": { + "smithy.api#documentation": "

Configure export settings to deliver disk images created from your image build, using\n\t\t\ta file format that is compatible with your VMs in that Region.

" + } + }, + "fastLaunchConfigurations": { + "target": "com.amazonaws.imagebuilder#FastLaunchConfigurationList", + "traits": { + "smithy.api#documentation": "

The Windows faster-launching configurations to use for AMI distribution.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the settings for a specific Region.

" + } + }, + "com.amazonaws.imagebuilder#DistributionConfiguration": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.imagebuilder#ImageBuilderArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration.

" + } + }, + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the distribution configuration.

" + } + }, + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description of the distribution configuration.

" + } + }, + "distributions": { + "target": "com.amazonaws.imagebuilder#DistributionList", + "traits": { + "smithy.api#documentation": "

The distribution objects that apply Region-specific settings for the deployment of the\n\t\t\timage to targeted Regions.

" + } + }, + "timeoutMinutes": { + "target": "com.amazonaws.imagebuilder#DistributionTimeoutMinutes", + "traits": { + "smithy.api#documentation": "

The maximum duration in minutes for this distribution configuration.

", + "smithy.api#required": {} + } + }, + "dateCreated": { + "target": "com.amazonaws.imagebuilder#DateTime", + "traits": { + "smithy.api#documentation": "

The date on which this distribution configuration was created.

" + } + }, + "dateUpdated": { + "target": "com.amazonaws.imagebuilder#DateTime", + "traits": { + "smithy.api#documentation": "

The date on which this distribution configuration was last updated.

" + } + }, + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", + "traits": { + "smithy.api#documentation": "

The tags of the distribution configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A distribution configuration.

" + } + }, + "com.amazonaws.imagebuilder#DistributionConfigurationArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):distribution-configuration/[a-z0-9-_]+$" + } + }, + "com.amazonaws.imagebuilder#DistributionConfigurationSummary": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.imagebuilder#ImageBuilderArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration.

" + } + }, + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the distribution configuration.

" + } + }, + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description of the distribution configuration.

" + } + }, + "dateCreated": { + "target": "com.amazonaws.imagebuilder#DateTime", + "traits": { + "smithy.api#documentation": "

The date on which the distribution configuration was created.

" + } + }, + "dateUpdated": { + "target": "com.amazonaws.imagebuilder#DateTime", + "traits": { + "smithy.api#documentation": "

The date on which the distribution configuration was updated.

" + } + }, + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", + "traits": { + "smithy.api#documentation": "

The tags associated with the distribution configuration.

" + } + }, + "regions": { + "target": "com.amazonaws.imagebuilder#RegionList", + "traits": { + "smithy.api#documentation": "

A list of Regions where the container image is distributed to.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A high-level overview of a distribution configuration.

" + } + }, + "com.amazonaws.imagebuilder#DistributionConfigurationSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#DistributionConfigurationSummary" + } + }, + "com.amazonaws.imagebuilder#DistributionList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#Distribution" + } + }, + "com.amazonaws.imagebuilder#DistributionTimeoutMinutes": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 30, + "max": 720 + } + } + }, + "com.amazonaws.imagebuilder#DockerFileTemplate": { + "type": "string" + }, + "com.amazonaws.imagebuilder#EbsInstanceBlockDeviceSpecification": { + "type": "structure", + "members": { + "encrypted": { + "target": "com.amazonaws.imagebuilder#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Use to configure device encryption.

" + } + }, + "deleteOnTermination": { + "target": "com.amazonaws.imagebuilder#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Use to configure delete on termination of the associated device.

" + } + }, + "iops": { + "target": "com.amazonaws.imagebuilder#EbsIopsInteger", + "traits": { + "smithy.api#documentation": "

Use to configure device IOPS.

" + } + }, + "kmsKeyId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Use to configure the KMS key to use when encrypting the device.

" + } + }, + "snapshotId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The snapshot that defines the device contents.

" + } + }, + "volumeSize": { + "target": "com.amazonaws.imagebuilder#EbsVolumeSizeInteger", + "traits": { + "smithy.api#documentation": "

Use to override the device's volume size.

" + } + }, + "volumeType": { + "target": "com.amazonaws.imagebuilder#EbsVolumeType", + "traits": { + "smithy.api#documentation": "

Use to override the device's volume type.

" + } + }, + "throughput": { + "target": "com.amazonaws.imagebuilder#EbsVolumeThroughput", + "traits": { + "smithy.api#documentation": "

\n For GP3 volumes only – The throughput in MiB/s\n\t\t\tthat the volume supports.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Amazon EBS-specific block device mapping specifications.

" + } + }, + "com.amazonaws.imagebuilder#EbsIopsInteger": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 100, + "max": 64000 + } + } + }, + "com.amazonaws.imagebuilder#EbsVolumeSizeInteger": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 16000 + } + } + }, + "com.amazonaws.imagebuilder#EbsVolumeThroughput": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 125, + "max": 1000 + } + } + }, + "com.amazonaws.imagebuilder#EbsVolumeType": { + "type": "enum", + "members": { + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "standard" + } + }, + "IO1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "io1" + } + }, + "IO2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "io2" + } + }, + "GP2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "gp2" + } + }, + "GP3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "gp3" + } + }, + "SC1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sc1" + } + }, + "ST1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "st1" + } + } + } + }, + "com.amazonaws.imagebuilder#EcrConfiguration": { + "type": "structure", + "members": { + "repositoryName": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the container repository that Amazon Inspector scans to identify findings for your\n\t\t\tcontainer images. The name includes the path for the repository location. If you don’t\n\t\t\tprovide this information, Image Builder creates a repository in your account named\n\t\t\t\timage-builder-image-scanning-repository for vulnerability scans of your\n\t\t\toutput container images.

" + } + }, + "containerTags": { + "target": "com.amazonaws.imagebuilder#StringList", + "traits": { + "smithy.api#documentation": "

Tags for Image Builder to apply to the output container image that &INS; scans. Tags can\n\t\t\thelp you identify and manage your scanned images.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Settings that Image Builder uses to configure the ECR repository and the output container\n\t\t\timages that Amazon Inspector scans.

" + } + }, + "com.amazonaws.imagebuilder#EmptyString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 0 + } + } + }, + "com.amazonaws.imagebuilder#ErrorMessage": { + "type": "string" + }, + "com.amazonaws.imagebuilder#FastLaunchConfiguration": { + "type": "structure", + "members": { + "enabled": { + "target": "com.amazonaws.imagebuilder#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean that represents the current state of faster launching for the Windows AMI.\n\t\t\tSet to true to start using Windows faster launching, or false\n\t\t\tto stop using it.

", + "smithy.api#required": {} + } + }, + "snapshotConfiguration": { + "target": "com.amazonaws.imagebuilder#FastLaunchSnapshotConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration settings for managing the number of snapshots that are created from\n\t\t\tpre-provisioned instances for the Windows AMI when faster launching is enabled.

" + } + }, + "maxParallelLaunches": { + "target": "com.amazonaws.imagebuilder#MaxParallelLaunches", + "traits": { + "smithy.api#documentation": "

The maximum number of parallel instances that are launched for creating\n\t\t\tresources.

" + } + }, + "launchTemplate": { + "target": "com.amazonaws.imagebuilder#FastLaunchLaunchTemplateSpecification", + "traits": { + "smithy.api#documentation": "

The launch template that the fast-launch enabled Windows AMI uses when it launches\n\t\t\tWindows instances to create pre-provisioned snapshots.

" + } + }, + "accountId": { + "target": "com.amazonaws.imagebuilder#AccountId", + "traits": { + "smithy.api#documentation": "

The owner account ID for the fast-launch enabled Windows AMI.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Define and configure faster launching for output Windows AMIs.

" + } + }, + "com.amazonaws.imagebuilder#FastLaunchConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#FastLaunchConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.imagebuilder#FastLaunchLaunchTemplateSpecification": { + "type": "structure", + "members": { + "launchTemplateId": { + "target": "com.amazonaws.imagebuilder#LaunchTemplateId", + "traits": { + "smithy.api#documentation": "

The ID of the launch template to use for faster launching for a Windows AMI.

" + } + }, + "launchTemplateName": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the launch template to use for faster launching for a Windows AMI.

" + } + }, + "launchTemplateVersion": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The version of the launch template to use for faster launching for a Windows\n\t\t\tAMI.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Identifies the launch template that the associated Windows AMI uses for launching an\n\t\t\tinstance when faster launching is enabled.

\n \n

You can specify either the launchTemplateName or the\n\t\t\t\t\tlaunchTemplateId, but not both.

\n " + } + }, + "com.amazonaws.imagebuilder#FastLaunchSnapshotConfiguration": { + "type": "structure", + "members": { + "targetResourceCount": { + "target": "com.amazonaws.imagebuilder#TargetResourceCount", + "traits": { + "smithy.api#documentation": "

The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled\n\t\t\tWindows AMI.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration settings for creating and managing pre-provisioned snapshots for a\n\t\t\tfast-launch enabled Windows AMI.

" + } + }, + "com.amazonaws.imagebuilder#Filter": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.imagebuilder#FilterName", + "traits": { + "smithy.api#documentation": "

The name of the filter. Filter names are case-sensitive.

" + } + }, + "values": { + "target": "com.amazonaws.imagebuilder#FilterValues", + "traits": { + "smithy.api#documentation": "

The filter values. Filter values are case-sensitive.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A filter name and value pair that is used to return a more specific list of results\n\t\t\tfrom a list operation. Filters can be used to match a set of resources by specific\n\t\t\tcriteria, such as tags, attributes, or IDs.

" + } + }, + "com.amazonaws.imagebuilder#FilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#Filter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.imagebuilder#FilterName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z]{1,1024}$" + } + }, + "com.amazonaws.imagebuilder#FilterValue": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9a-zA-Z./_ :-]{1,1024}$" + } + }, + "com.amazonaws.imagebuilder#FilterValues": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#FilterValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.imagebuilder#ForbiddenException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.imagebuilder#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

You are not authorized to perform the requested operation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.imagebuilder#GetComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#GetComponentRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#GetComponentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a component object.

", + "smithy.api#http": { + "method": "GET", + "uri": "/GetComponent", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#GetComponentPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#GetComponentPolicyRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#GetComponentPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a component policy.

", + "smithy.api#http": { + "method": "GET", + "uri": "/GetComponentPolicy", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#GetComponentPolicyRequest": { + "type": "structure", + "members": { + "componentArn": { + "target": "com.amazonaws.imagebuilder#ComponentBuildVersionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component whose policy you want to\n\t\t\tretrieve.

", + "smithy.api#httpQuery": "componentArn", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#GetComponentPolicyResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "policy": { + "target": "com.amazonaws.imagebuilder#ResourcePolicyDocument", + "traits": { + "smithy.api#documentation": "

The component policy.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#GetComponentRequest": { + "type": "structure", + "members": { + "componentBuildVersionArn": { + "target": "com.amazonaws.imagebuilder#ComponentVersionArnOrBuildVersionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component that you want to get. Regex requires\n\t\t\tthe suffix /\\d+$.

", + "smithy.api#httpQuery": "componentBuildVersionArn", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#GetComponentResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "component": { + "target": "com.amazonaws.imagebuilder#Component", + "traits": { + "smithy.api#documentation": "

The component object associated with the specified ARN.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#GetContainerRecipe": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#GetContainerRecipeRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#GetContainerRecipeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a container recipe.

", + "smithy.api#http": { + "method": "GET", + "uri": "/GetContainerRecipe", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#GetContainerRecipePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#GetContainerRecipePolicyRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#GetContainerRecipePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the policy for a container recipe.

", + "smithy.api#http": { + "method": "GET", + "uri": "/GetContainerRecipePolicy", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#GetContainerRecipePolicyRequest": { + "type": "structure", + "members": { + "containerRecipeArn": { + "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container recipe for the policy being\n\t\t\trequested.

", + "smithy.api#httpQuery": "containerRecipeArn", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#GetContainerRecipePolicyResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "policy": { + "target": "com.amazonaws.imagebuilder#ResourcePolicyDocument", + "traits": { + "smithy.api#documentation": "

The container recipe policy object that is returned.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#GetContainerRecipeRequest": { + "type": "structure", + "members": { + "containerRecipeArn": { + "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container recipe to retrieve.

", + "smithy.api#httpQuery": "containerRecipeArn", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#GetContainerRecipeResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "containerRecipe": { + "target": "com.amazonaws.imagebuilder#ContainerRecipe", + "traits": { + "smithy.api#documentation": "

The container recipe object that is returned.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#GetDistributionConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#GetDistributionConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#GetDistributionConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a distribution configuration.

", + "smithy.api#http": { + "method": "GET", + "uri": "/GetDistributionConfiguration", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#GetDistributionConfigurationRequest": { + "type": "structure", + "members": { + "distributionConfigurationArn": { + "target": "com.amazonaws.imagebuilder#DistributionConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration that you want to\n\t\t\tretrieve.

", + "smithy.api#httpQuery": "distributionConfigurationArn", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#GetDistributionConfigurationResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "distributionConfiguration": { + "target": "com.amazonaws.imagebuilder#DistributionConfiguration", + "traits": { + "smithy.api#documentation": "

The distribution configuration object.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#GetImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#GetImageRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#GetImageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets an image.

", + "smithy.api#http": { + "method": "GET", + "uri": "/GetImage", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#GetImagePipeline": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#GetImagePipelineRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#GetImagePipelineResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets an image pipeline.

", + "smithy.api#http": { + "method": "GET", + "uri": "/GetImagePipeline", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#GetImagePipelineRequest": { + "type": "structure", + "members": { + "imagePipelineArn": { + "target": "com.amazonaws.imagebuilder#ImagePipelineArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline that you want to retrieve.

", + "smithy.api#httpQuery": "imagePipelineArn", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#GetImagePipelineResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "imagePipeline": { + "target": "com.amazonaws.imagebuilder#ImagePipeline", + "traits": { + "smithy.api#documentation": "

The image pipeline object.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#GetImagePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#GetImagePolicyRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#GetImagePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets an image policy.

", + "smithy.api#http": { + "method": "GET", + "uri": "/GetImagePolicy", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#GetImagePolicyRequest": { + "type": "structure", + "members": { + "imageArn": { + "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image whose policy you want to retrieve.

", + "smithy.api#httpQuery": "imageArn", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#GetImagePolicyResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "policy": { + "target": "com.amazonaws.imagebuilder#ResourcePolicyDocument", + "traits": { + "smithy.api#documentation": "

The image policy object.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#GetImageRecipe": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#GetImageRecipeRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#GetImageRecipeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets an image recipe.

", + "smithy.api#http": { + "method": "GET", + "uri": "/GetImageRecipe", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#GetImageRecipePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#GetImageRecipePolicyRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#GetImageRecipePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets an image recipe policy.

", + "smithy.api#http": { + "method": "GET", + "uri": "/GetImageRecipePolicy", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#GetImageRecipePolicyRequest": { + "type": "structure", + "members": { + "imageRecipeArn": { + "target": "com.amazonaws.imagebuilder#ImageRecipeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe whose policy you want to\n\t\t\tretrieve.

", + "smithy.api#httpQuery": "imageRecipeArn", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#GetImageRecipePolicyResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "policy": { + "target": "com.amazonaws.imagebuilder#ResourcePolicyDocument", + "traits": { + "smithy.api#documentation": "

The image recipe policy object.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#GetImageRecipeRequest": { + "type": "structure", + "members": { + "imageRecipeArn": { + "target": "com.amazonaws.imagebuilder#ImageRecipeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe that you want to retrieve.

", + "smithy.api#httpQuery": "imageRecipeArn", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#GetImageRecipeResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "imageRecipe": { + "target": "com.amazonaws.imagebuilder#ImageRecipe", + "traits": { + "smithy.api#documentation": "

The image recipe object.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#GetImageRequest": { + "type": "structure", + "members": { + "imageBuildVersionArn": { + "target": "com.amazonaws.imagebuilder#ImageVersionArnOrBuildVersionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image that you want to get.

", + "smithy.api#httpQuery": "imageBuildVersionArn", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#GetImageResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "image": { + "target": "com.amazonaws.imagebuilder#Image", + "traits": { + "smithy.api#documentation": "

The image object.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#GetInfrastructureConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#GetInfrastructureConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#GetInfrastructureConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets an infrastructure configuration.

", + "smithy.api#http": { + "method": "GET", + "uri": "/GetInfrastructureConfiguration", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#GetInfrastructureConfigurationRequest": { + "type": "structure", + "members": { + "infrastructureConfigurationArn": { + "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that you want to\n\t\t\tretrieve.

", + "smithy.api#httpQuery": "infrastructureConfigurationArn", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

GetInfrastructureConfiguration request object.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#GetInfrastructureConfigurationResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "infrastructureConfiguration": { + "target": "com.amazonaws.imagebuilder#InfrastructureConfiguration", + "traits": { + "smithy.api#documentation": "

The infrastructure configuration object.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

GetInfrastructureConfiguration response object.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#GetWorkflowExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#GetWorkflowExecutionRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#GetWorkflowExecutionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Get the runtime information that was logged for a specific runtime instance \n\t\t\tof the workflow.

", + "smithy.api#http": { + "method": "GET", + "uri": "/GetWorkflowExecution", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#GetWorkflowExecutionRequest": { + "type": "structure", + "members": { + "workflowExecutionId": { + "target": "com.amazonaws.imagebuilder#WorkflowExecutionId", + "traits": { + "smithy.api#documentation": "

Use the unique identifier for a runtime instance of the workflow to get \n\t\t\truntime details.

", + "smithy.api#httpQuery": "workflowExecutionId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#GetWorkflowExecutionResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "workflowBuildVersionArn": { + "target": "com.amazonaws.imagebuilder#WorkflowBuildVersionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource \n\t\t\tthat defines the specified runtime instance of the workflow.

" + } + }, + "workflowExecutionId": { + "target": "com.amazonaws.imagebuilder#WorkflowExecutionId", + "traits": { + "smithy.api#documentation": "

The unique identifier that Image Builder assigned to keep track of runtime details\n\t\t\twhen it ran the workflow.

" + } + }, + "imageBuildVersionArn": { + "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image resource build version that the specified \n\t\t\truntime instance of the workflow created.

" + } + }, + "type": { + "target": "com.amazonaws.imagebuilder#WorkflowType", + "traits": { + "smithy.api#documentation": "

The type of workflow that Image Builder ran for the specified runtime instance of the workflow.

" + } + }, + "status": { + "target": "com.amazonaws.imagebuilder#WorkflowExecutionStatus", + "traits": { + "smithy.api#documentation": "

The current runtime status for the specified runtime instance of the workflow.

" + } + }, + "message": { + "target": "com.amazonaws.imagebuilder#WorkflowExecutionMessage", + "traits": { + "smithy.api#documentation": "

The output message from the specified runtime instance of the workflow, if applicable.

" + } + }, + "totalStepCount": { + "target": "com.amazonaws.imagebuilder#WorkflowStepCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of steps in the specified runtime instance of the workflow that ran. \n\t\t\tThis number should equal the sum of the step counts for steps that succeeded, were skipped, \n\t\t\tand failed.

" + } + }, + "totalStepsSucceeded": { + "target": "com.amazonaws.imagebuilder#WorkflowStepCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

A runtime count for the number of steps that ran successfully in the specified runtime \n\t\t\tinstance of the workflow.

" + } + }, + "totalStepsFailed": { + "target": "com.amazonaws.imagebuilder#WorkflowStepCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

A runtime count for the number of steps that failed in the specified runtime instance \n\t\t\tof the workflow.

" + } + }, + "totalStepsSkipped": { + "target": "com.amazonaws.imagebuilder#WorkflowStepCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

A runtime count for the number of steps that were skipped in the specified runtime \n\t\t\tinstance of the workflow.

" + } + }, + "startTime": { + "target": "com.amazonaws.imagebuilder#DateTime", + "traits": { + "smithy.api#documentation": "

The timestamp when the specified runtime instance of the workflow started.

" + } + }, + "endTime": { + "target": "com.amazonaws.imagebuilder#DateTime", + "traits": { + "smithy.api#documentation": "

The timestamp when the specified runtime instance of the workflow finished.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#GetWorkflowStepExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#GetWorkflowStepExecutionRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#GetWorkflowStepExecutionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Get the runtime information that was logged for a specific runtime instance of \n\t\t\tthe workflow step.

", + "smithy.api#http": { + "method": "GET", + "uri": "/GetWorkflowStepExecution", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#GetWorkflowStepExecutionRequest": { + "type": "structure", + "members": { + "stepExecutionId": { + "target": "com.amazonaws.imagebuilder#WorkflowStepExecutionId", + "traits": { + "smithy.api#documentation": "

Use the unique identifier for a specific runtime instance of the workflow step to \n\t\t\tget runtime details for that step.

", + "smithy.api#httpQuery": "stepExecutionId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#GetWorkflowStepExecutionResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "stepExecutionId": { + "target": "com.amazonaws.imagebuilder#WorkflowStepExecutionId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the runtime version of the workflow step that you specified \n\t\t\tin the request.

" + } + }, + "workflowBuildVersionArn": { + "target": "com.amazonaws.imagebuilder#WorkflowBuildVersionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource\n\t\t\tthat defines this workflow step.

" + } + }, + "workflowExecutionId": { + "target": "com.amazonaws.imagebuilder#WorkflowExecutionId", + "traits": { + "smithy.api#documentation": "

The unique identifier that Image Builder assigned to keep track of runtime details\n\t\t\twhen it ran the workflow.

" + } + }, + "imageBuildVersionArn": { + "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image resource build version that the specified \n\t\t\truntime instance of the workflow step creates.

" + } + }, + "name": { + "target": "com.amazonaws.imagebuilder#WorkflowStepName", + "traits": { + "smithy.api#documentation": "

The name of the specified runtime instance of the workflow step.

" + } + }, + "description": { + "target": "com.amazonaws.imagebuilder#WorkflowStepDescription", + "traits": { + "smithy.api#documentation": "

Describes the specified workflow step.

" + } + }, + "action": { + "target": "com.amazonaws.imagebuilder#WorkflowStepAction", + "traits": { + "smithy.api#documentation": "

The name of the action that the specified step performs.

" + } + }, + "status": { + "target": "com.amazonaws.imagebuilder#WorkflowStepExecutionStatus", + "traits": { + "smithy.api#documentation": "

The current status for the specified runtime version of the workflow step.

" + } + }, + "rollbackStatus": { + "target": "com.amazonaws.imagebuilder#WorkflowStepExecutionRollbackStatus", + "traits": { + "smithy.api#documentation": "

Reports on the rollback status of the specified runtime version of the workflow step, \n\t\t\tif applicable.

" + } + }, + "message": { + "target": "com.amazonaws.imagebuilder#WorkflowStepMessage", + "traits": { + "smithy.api#documentation": "

The output message from the specified runtime instance of the workflow step, if applicable.

" + } + }, + "inputs": { + "target": "com.amazonaws.imagebuilder#WorkflowStepInputs", + "traits": { + "smithy.api#documentation": "

Input parameters that Image Builder provided for the specified runtime instance of \n\t\t\tthe workflow step.

" + } + }, + "outputs": { + "target": "com.amazonaws.imagebuilder#WorkflowStepOutputs", + "traits": { + "smithy.api#documentation": "

The file names that the specified runtime version of the workflow step created as output.

" + } + }, + "startTime": { + "target": "com.amazonaws.imagebuilder#DateTime", + "traits": { + "smithy.api#documentation": "

The timestamp when the specified runtime version of the workflow step started.

" + } + }, + "endTime": { + "target": "com.amazonaws.imagebuilder#DateTime", + "traits": { + "smithy.api#documentation": "

The timestamp when the specified runtime instance of the workflow step finished.

" + } + }, + "onFailure": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The action to perform if the workflow step fails.

" + } + }, + "timeoutSeconds": { + "target": "com.amazonaws.imagebuilder#WorkflowStepTimeoutSecondsInteger", + "traits": { + "smithy.api#documentation": "

The maximum duration in seconds for this step to complete its action.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#HttpPutResponseHopLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.imagebuilder#HttpTokens": { + "type": "string", + "traits": { + "smithy.api#pattern": "^optional|required$" + } + }, + "com.amazonaws.imagebuilder#IdempotentParameterMismatchException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.imagebuilder#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

You have specified a client token for an operation using parameter values that differ\n\t\t\tfrom a previous request that used the same client token.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.imagebuilder#Image": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.imagebuilder#ImageBuilderArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image.

\n \n

Semantic versioning is included in each object's Amazon Resource Name (ARN), \n\tat the level that applies to that object as follows:

\n
    \n
  1. \n

    Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are \n\t\t\t\teither left off entirely, or they are specified as wildcards, for example: x.x.x.

    \n
    2. \n
  2. \n

    Version ARNs have only the first three nodes: ..

    \n
    3. \n
  3. \n

    Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

    \n
    4. \n
\n " + } + }, + "type": { + "target": "com.amazonaws.imagebuilder#ImageType", + "traits": { + "smithy.api#documentation": "

Specifies whether this image produces an AMI or a container image.

" + } + }, + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the image.

" + } + }, + "version": { + "target": "com.amazonaws.imagebuilder#VersionNumber", + "traits": { + "smithy.api#documentation": "

The semantic version of the image.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n

\n Assignment: For the first three nodes you can assign any positive integer value, including \n\tzero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the \n\tbuild number to the fourth node.

\n

\n Patterns: You can use any numeric pattern that adheres to the assignment requirements for \n\tthe nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or \n\ta date, such as 2021.01.01.

\n

\n Filtering: With semantic versioning, you have the flexibility to use wildcards (x) \n\tto specify the most recent versions or nodes when selecting the base image or components for your \n\trecipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be \n\twildcards.

\n " + } + }, + "platform": { + "target": "com.amazonaws.imagebuilder#Platform", + "traits": { + "smithy.api#documentation": "

The image operating system platform, such as Linux or Windows.

" + } + }, + "enhancedImageMetadataEnabled": { + "target": "com.amazonaws.imagebuilder#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Indicates whether Image Builder collects additional information about the image, such as \n\t\t\tthe operating system (OS) version and package list.

" + } + }, + "osVersion": { + "target": "com.amazonaws.imagebuilder#OsVersion", + "traits": { + "smithy.api#documentation": "

The operating system version for instances that launch from this image. For example, \n\t\t\tAmazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

" + } + }, + "state": { + "target": "com.amazonaws.imagebuilder#ImageState", + "traits": { + "smithy.api#documentation": "

The state of the image.

" + } + }, + "imageRecipe": { + "target": "com.amazonaws.imagebuilder#ImageRecipe", + "traits": { + "smithy.api#documentation": "

For images that distribute an AMI, this is the image recipe that Image Builder used to \n\t\t\tcreate the image. For container images, this is empty.

" + } + }, + "containerRecipe": { + "target": "com.amazonaws.imagebuilder#ContainerRecipe", + "traits": { + "smithy.api#documentation": "

For container images, this is the container recipe that Image Builder used to create the \n\t\t\timage. For images that distribute an AMI, this is empty.

" + } + }, + "sourcePipelineName": { + "target": "com.amazonaws.imagebuilder#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the image pipeline that created this image.

" + } + }, + "sourcePipelineArn": { + "target": "com.amazonaws.imagebuilder#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline that created this image.

" + } + }, + "infrastructureConfiguration": { + "target": "com.amazonaws.imagebuilder#InfrastructureConfiguration", + "traits": { + "smithy.api#documentation": "

The infrastructure that Image Builder used to create this image.

" + } + }, + "distributionConfiguration": { + "target": "com.amazonaws.imagebuilder#DistributionConfiguration", + "traits": { + "smithy.api#documentation": "

The distribution configuration that Image Builder used to create this image.

" + } + }, + "imageTestsConfiguration": { + "target": "com.amazonaws.imagebuilder#ImageTestsConfiguration", + "traits": { + "smithy.api#documentation": "

The image tests that ran when that Image Builder created this image.

" + } + }, + "dateCreated": { + "target": "com.amazonaws.imagebuilder#DateTime", + "traits": { + "smithy.api#documentation": "

The date on which Image Builder created this image.

" + } + }, + "outputResources": { + "target": "com.amazonaws.imagebuilder#OutputResources", + "traits": { + "smithy.api#documentation": "

The output resources that Image Builder produces for this image.

" + } + }, + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", + "traits": { + "smithy.api#documentation": "

The tags that apply to this image.

" + } + }, + "buildType": { + "target": "com.amazonaws.imagebuilder#BuildType", + "traits": { + "smithy.api#documentation": "

Indicates the type of build that created this image. The build can be initiated in the\n\t\t\tfollowing ways:

\n " + } + }, + "imageSource": { + "target": "com.amazonaws.imagebuilder#ImageSource", + "traits": { + "smithy.api#documentation": "

The origin of the base image that Image Builder used to build this image.

" + } + }, + "scanState": { + "target": "com.amazonaws.imagebuilder#ImageScanState", + "traits": { + "smithy.api#documentation": "

Contains information about the current state of scans for this image.

" + } + }, + "imageScanningConfiguration": { + "target": "com.amazonaws.imagebuilder#ImageScanningConfiguration", + "traits": { + "smithy.api#documentation": "

Contains settings for vulnerability scans.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An Image Builder image. You must specify exactly one recipe for the image – either a\n\t\t\tcontainer recipe (containerRecipe), which creates a container image, or an\n\t\t\timage recipe (imageRecipe), which creates an AMI.

" + } + }, + "com.amazonaws.imagebuilder#ImageAggregation": { + "type": "structure", + "members": { + "imageBuildVersionArn": { + "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the image for this aggregation.

" + } + }, + "severityCounts": { + "target": "com.amazonaws.imagebuilder#SeverityCounts", + "traits": { + "smithy.api#documentation": "

Counts by severity level for medium severity and higher level findings, plus a total\n\t\t\tfor all of the findings for the specified image.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains vulnerability counts for a specific image.

" + } + }, + "com.amazonaws.imagebuilder#ImageBuildMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.imagebuilder#ImageBuildVersionArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):image/[a-z0-9-_]+/[0-9]+\\.[0-9]+\\.[0-9]+/[0-9]+$" + } + }, + "com.amazonaws.imagebuilder#ImageBuilderArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|workflow\\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\\.(?:x|[0-9]+)\\.(?:x|[0-9]+))(?:/[0-9]+)?)?$" + } + }, + "com.amazonaws.imagebuilder#ImagePackage": { + "type": "structure", + "members": { + "packageName": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the package as reported to the operating system package manager.

" + } + }, + "packageVersion": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The version of the package as reported to the operating system package manager.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a package installed on an Image Builder image.

" + } + }, + "com.amazonaws.imagebuilder#ImagePackageList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#ImagePackage" + } + }, + "com.amazonaws.imagebuilder#ImagePipeline": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.imagebuilder#ImageBuilderArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline.

" + } + }, + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the image pipeline.

" + } + }, + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description of the image pipeline.

" + } + }, + "platform": { + "target": "com.amazonaws.imagebuilder#Platform", + "traits": { + "smithy.api#documentation": "

The platform of the image pipeline.

" + } + }, + "enhancedImageMetadataEnabled": { + "target": "com.amazonaws.imagebuilder#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Collects additional information about the image being created, including the operating\n\t\t\tsystem (OS) version and package list. This information is used to enhance the overall\n\t\t\texperience of using EC2 Image Builder. Enabled by default.

" + } + }, + "imageRecipeArn": { + "target": "com.amazonaws.imagebuilder#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe associated with this image\n\t\t\tpipeline.

" + } + }, + "containerRecipeArn": { + "target": "com.amazonaws.imagebuilder#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container recipe that is used for this\n\t\t\tpipeline.

" + } + }, + "infrastructureConfigurationArn": { + "target": "com.amazonaws.imagebuilder#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration associated with\n\t\t\tthis image pipeline.

" + } + }, + "distributionConfigurationArn": { + "target": "com.amazonaws.imagebuilder#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration associated with this\n\t\t\timage pipeline.

" + } + }, + "imageTestsConfiguration": { + "target": "com.amazonaws.imagebuilder#ImageTestsConfiguration", + "traits": { + "smithy.api#documentation": "

The image tests configuration of the image pipeline.

" + } + }, + "schedule": { + "target": "com.amazonaws.imagebuilder#Schedule", + "traits": { + "smithy.api#documentation": "

The schedule of the image pipeline.

" + } + }, + "status": { + "target": "com.amazonaws.imagebuilder#PipelineStatus", + "traits": { + "smithy.api#documentation": "

The status of the image pipeline.

" + } + }, + "dateCreated": { + "target": "com.amazonaws.imagebuilder#DateTime", + "traits": { + "smithy.api#documentation": "

The date on which this image pipeline was created.

" + } + }, + "dateUpdated": { + "target": "com.amazonaws.imagebuilder#DateTime", + "traits": { + "smithy.api#documentation": "

The date on which this image pipeline was last updated.

" + } + }, + "dateLastRun": { + "target": "com.amazonaws.imagebuilder#DateTime", + "traits": { + "smithy.api#documentation": "

This is no longer supported, and does not return a value.

" + } + }, + "dateNextRun": { + "target": "com.amazonaws.imagebuilder#DateTime", + "traits": { + "smithy.api#documentation": "

The next date when the pipeline is scheduled to run.

" + } + }, + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", + "traits": { + "smithy.api#documentation": "

The tags of this image pipeline.

" + } + }, + "imageScanningConfiguration": { + "target": "com.amazonaws.imagebuilder#ImageScanningConfiguration", + "traits": { + "smithy.api#documentation": "

Contains settings for vulnerability scans.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details of an image pipeline.

" + } + }, + "com.amazonaws.imagebuilder#ImagePipelineAggregation": { + "type": "structure", + "members": { + "imagePipelineArn": { + "target": "com.amazonaws.imagebuilder#ImagePipelineArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the image pipeline for this\n\t\t\taggregation.

" + } + }, + "severityCounts": { + "target": "com.amazonaws.imagebuilder#SeverityCounts", + "traits": { + "smithy.api#documentation": "

Counts by severity level for medium severity and higher level findings, plus a total\n\t\t\tfor all of the findings for the specified image pipeline.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains vulnerability counts for a specific image pipeline.

" + } + }, + "com.amazonaws.imagebuilder#ImagePipelineArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):image-pipeline/[a-z0-9-_]+$" + } + }, + "com.amazonaws.imagebuilder#ImagePipelineList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#ImagePipeline" + } + }, + "com.amazonaws.imagebuilder#ImageRecipe": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.imagebuilder#ImageBuilderArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe.

" + } + }, + "type": { + "target": "com.amazonaws.imagebuilder#ImageType", + "traits": { + "smithy.api#documentation": "

Specifies which type of image is created by the recipe - an AMI or a container\n\t\t\timage.

" + } + }, + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the image recipe.

" + } + }, + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description of the image recipe.

" + } + }, + "platform": { + "target": "com.amazonaws.imagebuilder#Platform", + "traits": { + "smithy.api#documentation": "

The platform of the image recipe.

" + } + }, + "owner": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The owner of the image recipe.

" + } + }, + "version": { + "target": "com.amazonaws.imagebuilder#VersionNumber", + "traits": { + "smithy.api#documentation": "

The version of the image recipe.

" + } + }, + "components": { + "target": "com.amazonaws.imagebuilder#ComponentConfigurationList", + "traits": { + "smithy.api#documentation": "

The components that are included in the image recipe. Recipes require a minimum of one build component, and can \n\t\t\thave a maximum of 20 build and test components in any combination.

" + } + }, + "parentImage": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The base image of the image recipe.

" + } + }, + "blockDeviceMappings": { + "target": "com.amazonaws.imagebuilder#InstanceBlockDeviceMappings", + "traits": { + "smithy.api#documentation": "

The block device mappings to apply when creating images from this recipe.

" + } + }, + "dateCreated": { + "target": "com.amazonaws.imagebuilder#DateTime", + "traits": { + "smithy.api#documentation": "

The date on which this image recipe was created.

" + } + }, + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", + "traits": { + "smithy.api#documentation": "

The tags of the image recipe.

" + } + }, + "workingDirectory": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The working directory to be used during build and test workflows.

" + } + }, + "additionalInstanceConfiguration": { + "target": "com.amazonaws.imagebuilder#AdditionalInstanceConfiguration", + "traits": { + "smithy.api#documentation": "

Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test\n\t\t\tyour image configuration. Instance configuration adds a layer of control over those\n\t\t\tinstances. You can define settings and add scripts to run when an instance is launched\n\t\t\tfrom your AMI.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An image recipe.

" + } + }, + "com.amazonaws.imagebuilder#ImageRecipeArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):image-recipe/[a-z0-9-_]+/[0-9]+\\.[0-9]+\\.[0-9]+$" + } + }, + "com.amazonaws.imagebuilder#ImageRecipeSummary": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.imagebuilder#ImageBuilderArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe.

" + } + }, + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the image recipe.

" + } + }, + "platform": { + "target": "com.amazonaws.imagebuilder#Platform", + "traits": { + "smithy.api#documentation": "

The platform of the image recipe.

" + } + }, + "owner": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The owner of the image recipe.

" + } + }, + "parentImage": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The base image of the image recipe.

" + } + }, + "dateCreated": { + "target": "com.amazonaws.imagebuilder#DateTime", + "traits": { + "smithy.api#documentation": "

The date on which this image recipe was created.

" + } + }, + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", + "traits": { + "smithy.api#documentation": "

The tags of the image recipe.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary of an image recipe.

" + } + }, + "com.amazonaws.imagebuilder#ImageRecipeSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#ImageRecipeSummary" + } + }, + "com.amazonaws.imagebuilder#ImageScanFinding": { + "type": "structure", + "members": { + "awsAccountId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID that's associated with the finding.

" + } + }, + "imageBuildVersionArn": { + "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image build version that's associated with the\n\t\t\tfinding.

" + } + }, + "imagePipelineArn": { + "target": "com.amazonaws.imagebuilder#ImagePipelineArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline that's associated with the\n\t\t\tfinding.

" + } + }, + "type": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of the finding. Image Builder looks for findings of the type\n\t\t\t\tPACKAGE_VULNERABILITY that apply to output images, and excludes other\n\t\t\ttypes.

" + } + }, + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description of the finding.

" + } + }, + "title": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The title of the finding.

" + } + }, + "remediation": { + "target": "com.amazonaws.imagebuilder#Remediation", + "traits": { + "smithy.api#documentation": "

An object that contains the details about how to remediate the finding.

" + } + }, + "severity": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The severity of the finding.

" + } + }, + "firstObservedAt": { + "target": "com.amazonaws.imagebuilder#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "

The date and time when the finding was first observed.

" + } + }, + "updatedAt": { + "target": "com.amazonaws.imagebuilder#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the finding was last updated.

" + } + }, + "inspectorScore": { + "target": "com.amazonaws.imagebuilder#NonNegativeDouble", + "traits": { + "smithy.api#documentation": "

The score that Amazon Inspector assigned for the finding.

" + } + }, + "inspectorScoreDetails": { + "target": "com.amazonaws.imagebuilder#InspectorScoreDetails", + "traits": { + "smithy.api#documentation": "

An object that contains details of the Amazon Inspector score.

" + } + }, + "packageVulnerabilityDetails": { + "target": "com.amazonaws.imagebuilder#PackageVulnerabilityDetails", + "traits": { + "smithy.api#documentation": "

An object that contains the details of a package vulnerability finding.

" + } + }, + "fixAvailable": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Details about whether a fix is available for any of the packages that are identified\n\t\t\tin the finding through a version update.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about a vulnerability scan finding.

" + } + }, + "com.amazonaws.imagebuilder#ImageScanFindingAggregation": { + "type": "structure", + "members": { + "accountAggregation": { + "target": "com.amazonaws.imagebuilder#AccountAggregation", + "traits": { + "smithy.api#documentation": "

Returns an object that contains severity counts based on an account ID.

" + } + }, + "imageAggregation": { + "target": "com.amazonaws.imagebuilder#ImageAggregation", + "traits": { + "smithy.api#documentation": "

Returns an object that contains severity counts based on the Amazon Resource Name\n\t\t\t(ARN) for a specific image.

" + } + }, + "imagePipelineAggregation": { + "target": "com.amazonaws.imagebuilder#ImagePipelineAggregation", + "traits": { + "smithy.api#documentation": "

Returns an object that contains severity counts based on an image pipeline ARN.

" + } + }, + "vulnerabilityIdAggregation": { + "target": "com.amazonaws.imagebuilder#VulnerabilityIdAggregation", + "traits": { + "smithy.api#documentation": "

Returns an object that contains severity counts based on vulnerability ID.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This returns exactly one type of aggregation, based on the filter that Image Builder applies in\n\t\t\tits API action.

" + } + }, + "com.amazonaws.imagebuilder#ImageScanFindingAggregationsList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#ImageScanFindingAggregation" + } + }, + "com.amazonaws.imagebuilder#ImageScanFindingsFilter": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.imagebuilder#FilterName", + "traits": { + "smithy.api#documentation": "

The name of the image scan finding filter. Filter names are case-sensitive.

" + } + }, + "values": { + "target": "com.amazonaws.imagebuilder#ImageScanFindingsFilterValues", + "traits": { + "smithy.api#documentation": "

The filter values. Filter values are case-sensitive.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A name value pair that Image Builder applies to streamline results from the\n\t\t\tvulnerability scan findings list action.

" + } + }, + "com.amazonaws.imagebuilder#ImageScanFindingsFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#ImageScanFindingsFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.imagebuilder#ImageScanFindingsFilterValues": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#FilterValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.imagebuilder#ImageScanFindingsList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#ImageScanFinding" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 25 + } + } + }, + "com.amazonaws.imagebuilder#ImageScanState": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.imagebuilder#ImageScanStatus", + "traits": { + "smithy.api#documentation": "

The current state of vulnerability scans for the image.

" + } + }, + "reason": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The reason for the scan status for the image.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Shows the vulnerability scan status for a specific image, and the reason for that\n\t\t\tstatus.

" + } + }, + "com.amazonaws.imagebuilder#ImageScanStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "SCANNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCANNING" + } + }, + "COLLECTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COLLECTING" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "ABANDONED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ABANDONED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "TIMED_OUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMED_OUT" + } + } + } + }, + "com.amazonaws.imagebuilder#ImageScanningConfiguration": { + "type": "structure", + "members": { + "imageScanningEnabled": { + "target": "com.amazonaws.imagebuilder#NullableBoolean", + "traits": { + "smithy.api#documentation": "

A setting that indicates whether Image Builder keeps a snapshot of the vulnerability scans that\n\t\t\tAmazon Inspector runs against the build instance when you create a new image.

" + } + }, + "ecrConfiguration": { + "target": "com.amazonaws.imagebuilder#EcrConfiguration", + "traits": { + "smithy.api#documentation": "

Contains Amazon ECR settings for vulnerability scans.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains settings for Image Builder image resource and container image scans.

" + } + }, + "com.amazonaws.imagebuilder#ImageSource": { + "type": "enum", + "members": { + "AMAZON_MANAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMAZON_MANAGED" + } + }, + "AWS_MARKETPLACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_MARKETPLACE" + } + }, + "IMPORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPORTED" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + } + } + }, + "com.amazonaws.imagebuilder#ImageState": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.imagebuilder#ImageStatus", + "traits": { + "smithy.api#documentation": "

The status of the image.

" + } + }, + "reason": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The reason for the status of the image.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Image status and the reason for that status.

" + } + }, + "com.amazonaws.imagebuilder#ImageStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "BUILDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BUILDING" + } + }, + "TESTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TESTING" + } + }, + "DISTRIBUTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISTRIBUTING" + } + }, + "INTEGRATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTEGRATING" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "DEPRECATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPRECATED" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } + } + }, + "com.amazonaws.imagebuilder#ImageSummary": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.imagebuilder#ImageBuilderArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image.

" + } + }, + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the image.

" + } + }, + "type": { + "target": "com.amazonaws.imagebuilder#ImageType", + "traits": { + "smithy.api#documentation": "

Specifies whether this image produces an AMI or a container image.

" + } + }, + "version": { + "target": "com.amazonaws.imagebuilder#VersionNumber", + "traits": { + "smithy.api#documentation": "

The version of the image.

" + } + }, + "platform": { + "target": "com.amazonaws.imagebuilder#Platform", + "traits": { + "smithy.api#documentation": "

The image operating system platform, such as Linux or Windows.

" + } + }, + "osVersion": { + "target": "com.amazonaws.imagebuilder#OsVersion", + "traits": { + "smithy.api#documentation": "

The operating system version of the instances that launch from this image. For \n\t\t\texample, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

" + } + }, + "state": { + "target": "com.amazonaws.imagebuilder#ImageState", + "traits": { + "smithy.api#documentation": "

The state of the image.

" + } + }, + "owner": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The owner of the image.

" + } + }, + "dateCreated": { + "target": "com.amazonaws.imagebuilder#DateTime", + "traits": { + "smithy.api#documentation": "

The date on which Image Builder created this image.

" + } + }, + "outputResources": { + "target": "com.amazonaws.imagebuilder#OutputResources", + "traits": { + "smithy.api#documentation": "

The output resources that Image Builder produced when it created this image.

" + } + }, + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", + "traits": { + "smithy.api#documentation": "

The tags that apply to this image.

" + } + }, + "buildType": { + "target": "com.amazonaws.imagebuilder#BuildType", + "traits": { + "smithy.api#documentation": "

Indicates the type of build that created this image. The build can be initiated in the\n\t\t\tfollowing ways:

\n " + } + }, + "imageSource": { + "target": "com.amazonaws.imagebuilder#ImageSource", + "traits": { + "smithy.api#documentation": "

The origin of the base image that Image Builder used to build this image.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An image summary.

" + } + }, + "com.amazonaws.imagebuilder#ImageSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#ImageSummary" + } + }, + "com.amazonaws.imagebuilder#ImageTestsConfiguration": { + "type": "structure", + "members": { + "imageTestsEnabled": { + "target": "com.amazonaws.imagebuilder#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Determines if tests should run after building the image. Image Builder defaults to enable tests\n\t\t\tto run following the image build, before image distribution.

" + } + }, + "timeoutMinutes": { + "target": "com.amazonaws.imagebuilder#ImageTestsTimeoutMinutes", + "traits": { + "smithy.api#documentation": "

The maximum time in minutes that tests are permitted to run.

\n \n

The timeoutMinutes attribute is not currently active. This value is\n\t\t\t\tignored.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Configure image tests for your pipeline build. Tests run after building the image, to\n\t\t\tverify that the AMI or container image is valid before distributing it.

" + } + }, + "com.amazonaws.imagebuilder#ImageTestsTimeoutMinutes": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 60, + "max": 1440 + } + } + }, + "com.amazonaws.imagebuilder#ImageType": { + "type": "enum", + "members": { + "AMI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMI" + } + }, + "DOCKER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOCKER" + } + } + } + }, + "com.amazonaws.imagebuilder#ImageVersion": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.imagebuilder#ImageBuilderArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a specific version of an Image Builder image.

\n \n

Semantic versioning is included in each object's Amazon Resource Name (ARN), \n\tat the level that applies to that object as follows:

\n
    \n
  1. \n

    Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are \n\t\t\t\teither left off entirely, or they are specified as wildcards, for example: x.x.x.

    \n
    2. \n
  2. \n

    Version ARNs have only the first three nodes: ..

    \n
    3. \n
  3. \n

    Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

    \n
    4. \n
\n " + } + }, + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of this specific version of an Image Builder image.

" + } + }, + "type": { + "target": "com.amazonaws.imagebuilder#ImageType", + "traits": { + "smithy.api#documentation": "

Specifies whether this image produces an AMI or a container image.

" + } + }, + "version": { + "target": "com.amazonaws.imagebuilder#VersionNumber", + "traits": { + "smithy.api#documentation": "

Details for a specific version of an Image Builder image. This version follows the semantic\n\t\t\tversion syntax.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n

\n Assignment: For the first three nodes you can assign any positive integer value, including \n\tzero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the \n\tbuild number to the fourth node.

\n

\n Patterns: You can use any numeric pattern that adheres to the assignment requirements for \n\tthe nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or \n\ta date, such as 2021.01.01.

\n

\n Filtering: With semantic versioning, you have the flexibility to use wildcards (x) \n\tto specify the most recent versions or nodes when selecting the base image or components for your \n\trecipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be \n\twildcards.

\n " + } + }, + "platform": { + "target": "com.amazonaws.imagebuilder#Platform", + "traits": { + "smithy.api#documentation": "

The operating system platform of the image version, for example \"Windows\" or \n\t\t\t\"Linux\".

" + } + }, + "osVersion": { + "target": "com.amazonaws.imagebuilder#OsVersion", + "traits": { + "smithy.api#documentation": "

The operating system version of the Amazon EC2 build instance. For example, Amazon Linux 2,\n\t\t\tUbuntu 18, or Microsoft Windows Server 2019.

" + } + }, + "owner": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The owner of the image version.

" + } + }, + "dateCreated": { + "target": "com.amazonaws.imagebuilder#DateTime", + "traits": { + "smithy.api#documentation": "

The date on which this specific version of the Image Builder image was created.

" + } + }, + "buildType": { + "target": "com.amazonaws.imagebuilder#BuildType", + "traits": { + "smithy.api#documentation": "

Indicates the type of build that created this image. The build can be initiated in the\n\t\t\tfollowing ways:

\n " + } + }, + "imageSource": { + "target": "com.amazonaws.imagebuilder#ImageSource", + "traits": { + "smithy.api#documentation": "

The origin of the base image that Image Builder used to build this image.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The defining characteristics of a specific version of an Image Builder image.

" + } + }, + "com.amazonaws.imagebuilder#ImageVersionArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):image/[a-z0-9-_]+/[0-9]+\\.[0-9]+\\.[0-9]+$" + } + }, + "com.amazonaws.imagebuilder#ImageVersionArnOrBuildVersionArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):image/[a-z0-9-_]+/(?:(?:([0-9]+|x)\\.([0-9]+|x)\\.([0-9]+|x))|(?:[0-9]+\\.[0-9]+\\.[0-9]+/[0-9]+))$" + } + }, + "com.amazonaws.imagebuilder#ImageVersionList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#ImageVersion" + } + }, + "com.amazonaws.imagebuilder#ImportComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#ImportComponentRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#ImportComponentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidVersionNumberException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceInUseException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Imports a component and transforms its data into a component document.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/ImportComponent", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#ImportComponentRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the component.

", + "smithy.api#required": {} + } + }, + "semanticVersion": { + "target": "com.amazonaws.imagebuilder#VersionNumber", + "traits": { + "smithy.api#documentation": "

The semantic version of the component. This version follows the semantic version\n\t\t\tsyntax.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n

\n Filtering: With semantic versioning, you have the flexibility to use wildcards (x) \n\tto specify the most recent versions or nodes when selecting the base image or components for your \n\trecipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be \n\twildcards.

\n ", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description of the component. Describes the contents of the component.

" + } + }, + "changeDescription": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The change description of the component. This description indicates the change that\n\t\t\thas been made in this version, or what makes this version different from other versions\n\t\t\tof this component.

" + } + }, + "type": { + "target": "com.amazonaws.imagebuilder#ComponentType", + "traits": { + "smithy.api#documentation": "

The type of the component denotes whether the component is used to build the image, or\n\t\t\tonly to test it.

", + "smithy.api#required": {} + } + }, + "format": { + "target": "com.amazonaws.imagebuilder#ComponentFormat", + "traits": { + "smithy.api#documentation": "

The format of the resource that you want to import as a component.

", + "smithy.api#required": {} + } + }, + "platform": { + "target": "com.amazonaws.imagebuilder#Platform", + "traits": { + "smithy.api#documentation": "

The platform of the component.

", + "smithy.api#required": {} + } + }, + "data": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The data of the component. Used to specify the data inline. Either data\n\t\t\tor uri can be used to specify the data within the component.

" + } + }, + "uri": { + "target": "com.amazonaws.imagebuilder#Uri", + "traits": { + "smithy.api#documentation": "

The uri of the component. Must be an Amazon S3 URL and the requester must have permission\n\t\t\tto access the Amazon S3 bucket. If you use Amazon S3, you can specify component content up to your\n\t\t\tservice quota. Either data or uri can be used to specify the\n\t\t\tdata within the component.

" + } + }, + "kmsKeyId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the KMS key that should be used to encrypt this component.

" + } + }, + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", + "traits": { + "smithy.api#documentation": "

The tags of the component.

" + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token of the component.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#ImportComponentResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" + } + }, + "componentBuildVersionArn": { + "target": "com.amazonaws.imagebuilder#ComponentBuildVersionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the imported component.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#ImportVmImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#ImportVmImageRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#ImportVmImageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

When you export your virtual machine (VM) from its virtualization environment, that\n\t\t\tprocess creates a set of one or more disk container files that act as snapshots of your\n\t\t\tVM’s environment, settings, and data. The Amazon EC2 API ImportImage\n\t\t\taction uses those files to import your VM and create an AMI. To import using the CLI\n\t\t\tcommand, see import-image\n

\n

You can reference the task ID from the VM import to pull in the AMI that the import\n\t\t\tcreated as the base image for your Image Builder recipe.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/ImportVmImage", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#ImportVmImageRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the base image that is created by the import process.

", + "smithy.api#required": {} + } + }, + "semanticVersion": { + "target": "com.amazonaws.imagebuilder#VersionNumber", + "traits": { + "smithy.api#documentation": "

The semantic version to attach to the base image that was created during the import\n\t\t\tprocess. This version follows the semantic version syntax.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n

\n Assignment: For the first three nodes you can assign any positive integer value, including \n\tzero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the \n\tbuild number to the fourth node.

\n

\n Patterns: You can use any numeric pattern that adheres to the assignment requirements for \n\tthe nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or \n\ta date, such as 2021.01.01.

\n ", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description for the base image that is created by the import process.

" + } + }, + "platform": { + "target": "com.amazonaws.imagebuilder#Platform", + "traits": { + "smithy.api#documentation": "

The operating system platform for the imported VM.

", + "smithy.api#required": {} + } + }, + "osVersion": { + "target": "com.amazonaws.imagebuilder#OsVersion", + "traits": { + "smithy.api#documentation": "

The operating system version for the imported VM.

" + } + }, + "vmImportTaskId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The importTaskId (API) or ImportTaskId (CLI) from the\n\t\t\tAmazon EC2 VM import process. Image Builder retrieves information from the import process to pull in\n\t\t\tthe AMI that is created from the VM source as the base image for your recipe.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", + "traits": { + "smithy.api#documentation": "

Tags that are attached to the import resources.

" + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure\n idempotency of the request. For more information, see Ensuring idempotency \n in the Amazon EC2 API Reference.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#ImportVmImageResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "imageArn": { + "target": "com.amazonaws.imagebuilder#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AMI that was created during the VM import\n\t\t\tprocess. This AMI is used as the base image for the recipe that imported the VM.

" + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token that was used for this request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#InfrastructureConfiguration": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.imagebuilder#ImageBuilderArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration.

" + } + }, + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the infrastructure configuration.

" + } + }, + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description of the infrastructure configuration.

" + } + }, + "instanceTypes": { + "target": "com.amazonaws.imagebuilder#InstanceTypeList", + "traits": { + "smithy.api#documentation": "

The instance types of the infrastructure configuration.

" + } + }, + "instanceProfileName": { + "target": "com.amazonaws.imagebuilder#InstanceProfileNameType", + "traits": { + "smithy.api#documentation": "

The instance profile of the infrastructure configuration.

" + } + }, + "securityGroupIds": { + "target": "com.amazonaws.imagebuilder#SecurityGroupIds", + "traits": { + "smithy.api#documentation": "

The security group IDs of the infrastructure configuration.

" + } + }, + "subnetId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The subnet ID of the infrastructure configuration.

" + } + }, + "logging": { + "target": "com.amazonaws.imagebuilder#Logging", + "traits": { + "smithy.api#documentation": "

The logging configuration of the infrastructure configuration.

" + } + }, + "keyPair": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon EC2 key pair of the infrastructure configuration.

" + } + }, + "terminateInstanceOnFailure": { + "target": "com.amazonaws.imagebuilder#NullableBoolean", + "traits": { + "smithy.api#documentation": "

The terminate instance on failure configuration of the infrastructure\n\t\t\tconfiguration.

" + } + }, + "snsTopicArn": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the SNS topic to which we send image build event\n\t\t\tnotifications.

\n \n

EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys \n\t\t\t\tfrom other accounts. The key that is used to encrypt the SNS topic must reside in the \n\t\t\t\taccount that the Image Builder service runs under.

\n " + } + }, + "dateCreated": { + "target": "com.amazonaws.imagebuilder#DateTime", + "traits": { + "smithy.api#documentation": "

The date on which the infrastructure configuration was created.

" + } + }, + "dateUpdated": { + "target": "com.amazonaws.imagebuilder#DateTime", + "traits": { + "smithy.api#documentation": "

The date on which the infrastructure configuration was last updated.

" + } + }, + "resourceTags": { + "target": "com.amazonaws.imagebuilder#ResourceTagMap", + "traits": { + "smithy.api#documentation": "

The tags attached to the resource created by Image Builder.

" + } + }, + "instanceMetadataOptions": { + "target": "com.amazonaws.imagebuilder#InstanceMetadataOptions", + "traits": { + "smithy.api#documentation": "

The instance metadata option settings for the infrastructure configuration.

" + } + }, + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", + "traits": { + "smithy.api#documentation": "

The tags of the infrastructure configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details of the infrastructure configuration.

" + } + }, + "com.amazonaws.imagebuilder#InfrastructureConfigurationArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):infrastructure-configuration/[a-z0-9-_]+$" + } + }, + "com.amazonaws.imagebuilder#InfrastructureConfigurationSummary": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.imagebuilder#ImageBuilderArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration.

" + } + }, + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the infrastructure configuration.

" + } + }, + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description of the infrastructure configuration.

" + } + }, + "dateCreated": { + "target": "com.amazonaws.imagebuilder#DateTime", + "traits": { + "smithy.api#documentation": "

The date on which the infrastructure configuration was created.

" + } + }, + "dateUpdated": { + "target": "com.amazonaws.imagebuilder#DateTime", + "traits": { + "smithy.api#documentation": "

The date on which the infrastructure configuration was last updated.

" + } + }, + "resourceTags": { + "target": "com.amazonaws.imagebuilder#ResourceTagMap", + "traits": { + "smithy.api#documentation": "

The tags attached to the image created by Image Builder.

" + } + }, + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", + "traits": { + "smithy.api#documentation": "

The tags of the infrastructure configuration.

" + } + }, + "instanceTypes": { + "target": "com.amazonaws.imagebuilder#InstanceTypeList", + "traits": { + "smithy.api#documentation": "

The instance types of the infrastructure configuration.

" + } + }, + "instanceProfileName": { + "target": "com.amazonaws.imagebuilder#InstanceProfileNameType", + "traits": { + "smithy.api#documentation": "

The instance profile of the infrastructure configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The infrastructure used when building Amazon EC2 AMIs.

" + } + }, + "com.amazonaws.imagebuilder#InfrastructureConfigurationSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationSummary" + } + }, + "com.amazonaws.imagebuilder#InlineComponentData": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16000 + }, + "smithy.api#pattern": "^[^\\x00]+$" + } + }, + "com.amazonaws.imagebuilder#InlineDockerFileTemplate": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16000 + }, + "smithy.api#pattern": "^[^\\x00]+$" + } + }, + "com.amazonaws.imagebuilder#InspectorScoreDetails": { + "type": "structure", + "members": { + "adjustedCvss": { + "target": "com.amazonaws.imagebuilder#CvssScoreDetails", + "traits": { + "smithy.api#documentation": "

An object that contains details about an adjustment that Amazon Inspector made to the CVSS score\n\t\t\tfor the finding.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the factors that influenced the score that Amazon Inspector assigned for a\n\t\t\tfinding.

" + } + }, + "com.amazonaws.imagebuilder#InstanceBlockDeviceMapping": { + "type": "structure", + "members": { + "deviceName": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The device to which these mappings apply.

" + } + }, + "ebs": { + "target": "com.amazonaws.imagebuilder#EbsInstanceBlockDeviceSpecification", + "traits": { + "smithy.api#documentation": "

Use to manage Amazon EBS-specific configuration for this mapping.

" + } + }, + "virtualName": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Use to manage instance ephemeral devices.

" + } + }, + "noDevice": { + "target": "com.amazonaws.imagebuilder#EmptyString", + "traits": { + "smithy.api#documentation": "

Use to remove a mapping from the base image.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines block device mappings for the instance used to configure your image.

" + } + }, + "com.amazonaws.imagebuilder#InstanceBlockDeviceMappings": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#InstanceBlockDeviceMapping" + } + }, + "com.amazonaws.imagebuilder#InstanceConfiguration": { + "type": "structure", + "members": { + "image": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The AMI ID to use as the base image for a container build and test instance. If not\n\t\t\tspecified, Image Builder will use the appropriate ECS-optimized AMI as a base image.

" + } + }, + "blockDeviceMappings": { + "target": "com.amazonaws.imagebuilder#InstanceBlockDeviceMappings", + "traits": { + "smithy.api#documentation": "

Defines the block devices to attach for building an instance from this Image Builder\n\t\t\tAMI.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines a custom base AMI and block device mapping configurations of an instance used\n\t\t\tfor building and testing container images.

" + } + }, + "com.amazonaws.imagebuilder#InstanceMetadataOptions": { + "type": "structure", + "members": { + "httpTokens": { + "target": "com.amazonaws.imagebuilder#HttpTokens", + "traits": { + "smithy.api#documentation": "

Indicates whether a signed token header is required for instance metadata retrieval\n\t\t\trequests. The values affect the response as follows:

\n \n

The default setting is optional.

" + } + }, + "httpPutResponseHopLimit": { + "target": "com.amazonaws.imagebuilder#HttpPutResponseHopLimit", + "traits": { + "smithy.api#documentation": "

Limit the number of hops that an instance metadata request can traverse to reach its\n\t\t\tdestination. The default is one hop. However, if HTTP tokens are required, container\n\t\t\timage builds need a minimum of two hops.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The instance metadata options that apply to the HTTP requests that pipeline builds use\n\t\t\tto launch EC2 build and test instances. For more information about instance metadata\n\t\t\toptions, see Configure the instance metadata options in the\n\t\t\t\t\n Amazon EC2 User Guide\n for Linux instances, or Configure the instance metadata options in the\n\t\t\t\t\n Amazon EC2 Windows Guide\n for Windows instances.

" + } + }, + "com.amazonaws.imagebuilder#InstanceProfileNameType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[\\w+=,.@-]+$" + } + }, + "com.amazonaws.imagebuilder#InstanceType": { + "type": "string" + }, + "com.amazonaws.imagebuilder#InstanceTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#InstanceType" + } + }, + "com.amazonaws.imagebuilder#InvalidPaginationTokenException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.imagebuilder#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

You have provided an invalid pagination token in your request.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.imagebuilder#InvalidParameterCombinationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.imagebuilder#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

You have specified two or more mutually exclusive parameters. Review the error message\n\t\t\tfor details.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.imagebuilder#InvalidParameterException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.imagebuilder#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The specified parameter is invalid. Review the available parameters for the API\n\t\t\trequest.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.imagebuilder#InvalidParameterValueException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.imagebuilder#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The value that you provided for the specified parameter is invalid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.imagebuilder#InvalidRequestException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.imagebuilder#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

You have requested an action that that the service doesn't support.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.imagebuilder#InvalidVersionNumberException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.imagebuilder#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

Your version number is out of bounds or does not follow the required syntax.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.imagebuilder#LaunchPermissionConfiguration": { + "type": "structure", + "members": { + "userIds": { + "target": "com.amazonaws.imagebuilder#AccountList", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

" + } + }, + "userGroups": { + "target": "com.amazonaws.imagebuilder#StringList", + "traits": { + "smithy.api#documentation": "

The name of the group.

" + } + }, + "organizationArns": { + "target": "com.amazonaws.imagebuilder#OrganizationArnList", + "traits": { + "smithy.api#documentation": "

The ARN for an Amazon Web Services Organization that you want to share your AMI with. For more\n\t\t\tinformation, see What is\n\t\t\t\tOrganizations?.

" + } + }, + "organizationalUnitArns": { + "target": "com.amazonaws.imagebuilder#OrganizationalUnitArnList", + "traits": { + "smithy.api#documentation": "

The ARN for an Organizations organizational unit (OU) that you want to share your AMI with.\n\t\t\tFor more information about key concepts for Organizations, see Organizations\n\t\t\t\tterminology and concepts.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the configuration for a launch permission. The launch permission\n\t\t\tmodification request is sent to the Amazon EC2\n\t\t\t\tModifyImageAttribute API on behalf of the user for each Region they have\n\t\t\tselected to distribute the AMI. To make an AMI public, set the launch permission\n\t\t\tauthorized accounts to all. See the examples for making an AMI public at\n\t\t\t\tAmazon EC2\n\t\t\t\tModifyImageAttribute.

" + } + }, + "com.amazonaws.imagebuilder#LaunchTemplateConfiguration": { + "type": "structure", + "members": { + "launchTemplateId": { + "target": "com.amazonaws.imagebuilder#LaunchTemplateId", + "traits": { + "smithy.api#documentation": "

Identifies the Amazon EC2 launch template to use.

", + "smithy.api#required": {} + } + }, + "accountId": { + "target": "com.amazonaws.imagebuilder#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID that this configuration applies to.

" + } + }, + "setDefaultVersion": { + "target": "com.amazonaws.imagebuilder#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Set the specified Amazon EC2 launch template as the default launch template for the\n\t\t\tspecified account.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Identifies an Amazon EC2 launch template to use for a specific account.

" + } + }, + "com.amazonaws.imagebuilder#LaunchTemplateConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#LaunchTemplateConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.imagebuilder#LaunchTemplateId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^lt-[a-z0-9-_]{17}$" + } + }, + "com.amazonaws.imagebuilder#LicenseConfigurationArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[^:]*:license-manager:[^:]+:[0-9]{12}:license-configuration:lic-[a-z0-9-_]{32}$" + } + }, + "com.amazonaws.imagebuilder#LicenseConfigurationArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#LicenseConfigurationArn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.imagebuilder#ListComponentBuildVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#ListComponentBuildVersionsRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#ListComponentBuildVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the list of component build versions for the specified semantic\n\t\t\tversion.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n

\n Filtering: With semantic versioning, you have the flexibility to use wildcards (x) \n\tto specify the most recent versions or nodes when selecting the base image or components for your \n\trecipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be \n\twildcards.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/ListComponentBuildVersions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "componentSummaryList", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.imagebuilder#ListComponentBuildVersionsRequest": { + "type": "structure", + "members": { + "componentVersionArn": { + "target": "com.amazonaws.imagebuilder#ComponentVersionArn", + "traits": { + "smithy.api#documentation": "

The component version Amazon Resource Name (ARN) whose versions you want to\n\t\t\tlist.

", + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.imagebuilder#RestrictedInteger", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum items to return in a request.

" + } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#ListComponentBuildVersionsResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "componentSummaryList": { + "target": "com.amazonaws.imagebuilder#ComponentSummaryList", + "traits": { + "smithy.api#documentation": "

The list of component summaries for the specified semantic version.

" + } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#PaginationToken", + "traits": { + "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#ListComponents": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#ListComponentsRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#ListComponentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the list of components that can be filtered by name, or by using the listed\n\t\t\t\tfilters to streamline results. Newly created components can take up to\n\t\t\ttwo minutes to appear in the ListComponents API Results.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n

\n Filtering: With semantic versioning, you have the flexibility to use wildcards (x) \n\tto specify the most recent versions or nodes when selecting the base image or components for your \n\trecipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be \n\twildcards.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/ListComponents", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "componentVersionList", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.imagebuilder#ListComponentsRequest": { + "type": "structure", + "members": { + "owner": { + "target": "com.amazonaws.imagebuilder#Ownership", + "traits": { + "smithy.api#documentation": "

Filters results based on the type of owner for the component. By default, this request\n\t\t\treturns a list of components that your account owns. To see results for other types of\n\t\t\towners, you can specify components that Amazon manages, third party components, or\n\t\t\tcomponents that other accounts have shared with you.

" + } + }, + "filters": { + "target": "com.amazonaws.imagebuilder#FilterList", + "traits": { + "smithy.api#documentation": "

Use the following filters to streamline results:

\n " + } + }, + "byName": { + "target": "com.amazonaws.imagebuilder#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Returns the list of components for the specified name.

" + } + }, + "maxResults": { + "target": "com.amazonaws.imagebuilder#RestrictedInteger", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum items to return in a request.

" + } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#ListComponentsResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "componentVersionList": { + "target": "com.amazonaws.imagebuilder#ComponentVersionList", + "traits": { + "smithy.api#documentation": "

The list of component semantic versions.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n " + } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#PaginationToken", + "traits": { + "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#ListContainerRecipes": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#ListContainerRecipesRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#ListContainerRecipesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of container recipes.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ListContainerRecipes", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "containerRecipeSummaryList", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.imagebuilder#ListContainerRecipesRequest": { + "type": "structure", + "members": { + "owner": { + "target": "com.amazonaws.imagebuilder#Ownership", + "traits": { + "smithy.api#documentation": "

Returns container recipes belonging to the specified owner, that have been shared with\n\t\t\tyou. You can omit this field to return container recipes belonging to your\n\t\t\taccount.

" + } + }, + "filters": { + "target": "com.amazonaws.imagebuilder#FilterList", + "traits": { + "smithy.api#documentation": "

Use the following filters to streamline results:

\n " + } + }, + "maxResults": { + "target": "com.amazonaws.imagebuilder#RestrictedInteger", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum items to return in a request.

" + } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#ListContainerRecipesResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "containerRecipeSummaryList": { + "target": "com.amazonaws.imagebuilder#ContainerRecipeSummaryList", + "traits": { + "smithy.api#documentation": "

The list of container recipes returned for the request.

" + } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#ListDistributionConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#ListDistributionConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#ListDistributionConfigurationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of distribution configurations.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ListDistributionConfigurations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "distributionConfigurationSummaryList", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.imagebuilder#ListDistributionConfigurationsRequest": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.imagebuilder#FilterList", + "traits": { + "smithy.api#documentation": "

You can filter on name to streamline results.

" + } + }, + "maxResults": { + "target": "com.amazonaws.imagebuilder#RestrictedInteger", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum items to return in a request.

" + } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#ListDistributionConfigurationsResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "distributionConfigurationSummaryList": { + "target": "com.amazonaws.imagebuilder#DistributionConfigurationSummaryList", + "traits": { + "smithy.api#documentation": "

The list of distributions.

" + } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#PaginationToken", + "traits": { + "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#ListImageBuildVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#ListImageBuildVersionsRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#ListImageBuildVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of image build versions.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ListImageBuildVersions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "imageSummaryList", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.imagebuilder#ListImageBuildVersionsRequest": { + "type": "structure", + "members": { + "imageVersionArn": { + "target": "com.amazonaws.imagebuilder#ImageVersionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image whose build versions you want to\n\t\t\tretrieve.

", + "smithy.api#required": {} + } + }, + "filters": { + "target": "com.amazonaws.imagebuilder#FilterList", + "traits": { + "smithy.api#documentation": "

Use the following filters to streamline results:

\n " + } + }, + "maxResults": { + "target": "com.amazonaws.imagebuilder#RestrictedInteger", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum items to return in a request.

" + } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#ListImageBuildVersionsResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "imageSummaryList": { + "target": "com.amazonaws.imagebuilder#ImageSummaryList", + "traits": { + "smithy.api#documentation": "

The list of image build versions.

" + } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#PaginationToken", + "traits": { + "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#ListImagePackages": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#ListImagePackagesRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#ListImagePackagesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

List the Packages that are associated with an Image Build Version, as determined by\n\t\t\tAmazon Web Services Systems Manager Inventory at build time.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ListImagePackages", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "imagePackageList", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.imagebuilder#ListImagePackagesRequest": { + "type": "structure", + "members": { + "imageBuildVersionArn": { + "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", + "traits": { + "smithy.api#documentation": "

Filter results for the ListImagePackages request by the Image Build Version ARN

", + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.imagebuilder#RestrictedInteger", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum items to return in a request.

" + } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#ListImagePackagesResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "imagePackageList": { + "target": "com.amazonaws.imagebuilder#ImagePackageList", + "traits": { + "smithy.api#documentation": "

The list of Image Packages returned in the response.

" + } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#PaginationToken", + "traits": { + "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#ListImagePipelineImages": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#ListImagePipelineImagesRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#ListImagePipelineImagesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of images created by the specified pipeline.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ListImagePipelineImages", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "imageSummaryList", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.imagebuilder#ListImagePipelineImagesRequest": { + "type": "structure", + "members": { + "imagePipelineArn": { + "target": "com.amazonaws.imagebuilder#ImagePipelineArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline whose images you want to\n\t\t\tview.

", + "smithy.api#required": {} + } + }, + "filters": { + "target": "com.amazonaws.imagebuilder#FilterList", + "traits": { + "smithy.api#documentation": "

Use the following filters to streamline results:

\n " + } + }, + "maxResults": { + "target": "com.amazonaws.imagebuilder#RestrictedInteger", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum items to return in a request.

" + } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#ListImagePipelineImagesResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "imageSummaryList": { + "target": "com.amazonaws.imagebuilder#ImageSummaryList", + "traits": { + "smithy.api#documentation": "

The list of images built by this pipeline.

" + } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#PaginationToken", + "traits": { + "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#ListImagePipelines": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#ListImagePipelinesRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#ListImagePipelinesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of image pipelines.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ListImagePipelines", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "imagePipelineList", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.imagebuilder#ListImagePipelinesRequest": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.imagebuilder#FilterList", + "traits": { + "smithy.api#documentation": "

Use the following filters to streamline results:

\n " + } + }, + "maxResults": { + "target": "com.amazonaws.imagebuilder#RestrictedInteger", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum items to return in a request.

" + } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#ListImagePipelinesResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "imagePipelineList": { + "target": "com.amazonaws.imagebuilder#ImagePipelineList", + "traits": { + "smithy.api#documentation": "

The list of image pipelines.

" + } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#PaginationToken", + "traits": { + "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#ListImageRecipes": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#ListImageRecipesRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#ListImageRecipesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of image recipes.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ListImageRecipes", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "imageRecipeSummaryList", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.imagebuilder#ListImageRecipesRequest": { + "type": "structure", + "members": { + "owner": { + "target": "com.amazonaws.imagebuilder#Ownership", + "traits": { + "smithy.api#documentation": "

The owner defines which image recipes you want to list. By default, this request will\n\t\t\tonly show image recipes owned by your account. You can use this field to specify if you\n\t\t\twant to view image recipes owned by yourself, by Amazon, or those image recipes that\n\t\t\thave been shared with you by other customers.

" + } + }, + "filters": { + "target": "com.amazonaws.imagebuilder#FilterList", + "traits": { + "smithy.api#documentation": "

Use the following filters to streamline results:

\n " + } + }, + "maxResults": { + "target": "com.amazonaws.imagebuilder#RestrictedInteger", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum items to return in a request.

" + } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#ListImageRecipesResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "imageRecipeSummaryList": { + "target": "com.amazonaws.imagebuilder#ImageRecipeSummaryList", + "traits": { + "smithy.api#documentation": "

The list of image pipelines.

" + } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#PaginationToken", + "traits": { + "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#ListImageScanFindingAggregations": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#ListImageScanFindingAggregationsRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#ListImageScanFindingAggregationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of image scan aggregations for your account. You can filter by the type\n\t\t\tof key that Image Builder uses to group results. For example, if you want to get a list of\n\t\t\tfindings by severity level for one of your pipelines, you might specify your pipeline\n\t\t\twith the imagePipelineArn filter. If you don't specify a filter, Image Builder\n\t\t\treturns an aggregation for your account.

\n

To streamline results, you can use the following filters in your request:

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/ListImageScanFindingAggregations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "responses" + } + } + }, + "com.amazonaws.imagebuilder#ListImageScanFindingAggregationsRequest": { + "type": "structure", + "members": { + "filter": { + "target": "com.amazonaws.imagebuilder#Filter" + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#ListImageScanFindingAggregationsResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "aggregationType": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The aggregation type specifies what type of key is used to group the image scan\n\t\t\tfindings. Image Builder returns results based on the request filter. If you didn't specify a\n\t\t\tfilter in the request, the type defaults to accountId.

\n

\n Aggregation types\n

\n \n

Each aggregation includes counts by severity level for medium severity and higher\n\t\t\tlevel findings, plus a total for all of the findings for each key value.

" + } + }, + "responses": { + "target": "com.amazonaws.imagebuilder#ImageScanFindingAggregationsList", + "traits": { + "smithy.api#documentation": "

An array of image scan finding aggregations that match the filter criteria.

" + } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#PaginationToken", + "traits": { + "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#ListImageScanFindings": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#ListImageScanFindingsRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#ListImageScanFindingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of image scan findings for your account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ListImageScanFindings", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "findings", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.imagebuilder#ListImageScanFindingsRequest": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.imagebuilder#ImageScanFindingsFilterList", + "traits": { + "smithy.api#documentation": "

An array of name value pairs that you can use to filter your results. You can use the\n\t\t\tfollowing filters to streamline results:

\n \n

If you don't request a filter, then all findings in your account are listed.

" + } + }, + "maxResults": { + "target": "com.amazonaws.imagebuilder#RestrictedInteger", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum items to return in a request.

" + } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#ListImageScanFindingsResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "findings": { + "target": "com.amazonaws.imagebuilder#ImageScanFindingsList", + "traits": { + "smithy.api#documentation": "

The image scan findings for your account that meet your request filter\n\t\t\tcriteria.

" + } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#PaginationToken", + "traits": { + "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#ListImages": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#ListImagesRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#ListImagesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the list of images that you have access to. Newly created images can take up\n\t\t\tto two minutes to appear in the ListImages API Results.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ListImages", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "imageVersionList", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.imagebuilder#ListImagesRequest": { + "type": "structure", + "members": { + "owner": { + "target": "com.amazonaws.imagebuilder#Ownership", + "traits": { + "smithy.api#documentation": "

The owner defines which images you want to list. By default, this request will only\n\t\t\tshow images owned by your account. You can use this field to specify if you want to view\n\t\t\timages owned by yourself, by Amazon, or those images that have been shared with you by\n\t\t\tother customers.

" + } + }, + "filters": { + "target": "com.amazonaws.imagebuilder#FilterList", + "traits": { + "smithy.api#documentation": "

Use the following filters to streamline results:

\n " + } + }, + "byName": { + "target": "com.amazonaws.imagebuilder#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Requests a list of images with a specific recipe name.

" + } + }, + "maxResults": { + "target": "com.amazonaws.imagebuilder#RestrictedInteger", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum items to return in a request.

" + } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.

" + } + }, + "includeDeprecated": { + "target": "com.amazonaws.imagebuilder#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Includes deprecated images in the response list.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#ListImagesResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "imageVersionList": { + "target": "com.amazonaws.imagebuilder#ImageVersionList", + "traits": { + "smithy.api#documentation": "

The list of image semantic versions.

\n \n

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n

\n Filtering: With semantic versioning, you have the flexibility to use wildcards (x) \n\tto specify the most recent versions or nodes when selecting the base image or components for your \n\trecipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be \n\twildcards.

\n " + } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#PaginationToken", + "traits": { + "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#ListInfrastructureConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#ListInfrastructureConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#ListInfrastructureConfigurationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of infrastructure configurations.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ListInfrastructureConfigurations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "infrastructureConfigurationSummaryList", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.imagebuilder#ListInfrastructureConfigurationsRequest": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.imagebuilder#FilterList", + "traits": { + "smithy.api#documentation": "

You can filter on name to streamline results.

" + } + }, + "maxResults": { + "target": "com.amazonaws.imagebuilder#RestrictedInteger", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum items to return in a request.

" + } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#ListInfrastructureConfigurationsResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "infrastructureConfigurationSummaryList": { + "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationSummaryList", + "traits": { + "smithy.api#documentation": "

The list of infrastructure configurations.

" + } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#PaginationToken", + "traits": { + "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#InvalidParameterException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the list of tags for the specified resource.

", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.imagebuilder#ImageBuilderArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", + "traits": { + "smithy.api#documentation": "

The tags for the specified resource.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#ListWorkflowExecutions": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#ListWorkflowExecutionsRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#ListWorkflowExecutionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of workflow runtime instance metadata objects for a specific image build\n\t\t\tversion.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ListWorkflowExecutions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "workflowExecutions", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.imagebuilder#ListWorkflowExecutionsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.imagebuilder#RestrictedInteger", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum items to return in a request.

" + } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.

" + } + }, + "imageBuildVersionArn": { + "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", + "traits": { + "smithy.api#documentation": "

List all workflow runtime instances for the specified image build version \n\t\t\tresource ARN.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#ListWorkflowExecutionsResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "workflowExecutions": { + "target": "com.amazonaws.imagebuilder#WorkflowExecutionsList", + "traits": { + "smithy.api#documentation": "

Contains an array of runtime details that represents each time a workflow ran for \n\t\t\tthe requested image build version.

" + } + }, + "imageBuildVersionArn": { + "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", + "traits": { + "smithy.api#documentation": "

The resource ARN of the image build version for which you requested a list of \n\t\t\tworkflow runtime details.

" + } + }, + "message": { + "target": "com.amazonaws.imagebuilder#ImageBuildMessage", + "traits": { + "smithy.api#documentation": "

The output message from the list action, if applicable.

" + } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#PaginationToken", + "traits": { + "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#ListWorkflowStepExecutions": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#ListWorkflowStepExecutionsRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#ListWorkflowStepExecutionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Shows runtime data for each step in a runtime instance of the workflow \n\t\t\tthat you specify in the request.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ListWorkflowStepExecutions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "steps", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.imagebuilder#ListWorkflowStepExecutionsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.imagebuilder#RestrictedInteger", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum items to return in a request.

" + } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.

" + } + }, + "workflowExecutionId": { + "target": "com.amazonaws.imagebuilder#WorkflowExecutionId", + "traits": { + "smithy.api#documentation": "

The unique identifier that Image Builder assigned to keep track of runtime details\n\t\t\twhen it ran the workflow.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#ListWorkflowStepExecutionsResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "steps": { + "target": "com.amazonaws.imagebuilder#WorkflowStepExecutionsList", + "traits": { + "smithy.api#documentation": "

Contains an array of runtime details that represents each step in this runtime \n\t\t\tinstance of the workflow.

" + } + }, + "workflowBuildVersionArn": { + "target": "com.amazonaws.imagebuilder#WorkflowBuildVersionArn", + "traits": { + "smithy.api#documentation": "

The build version ARN for the Image Builder workflow resource that defines the steps for \n\t\t\tthis runtime instance of the workflow.

" + } + }, + "workflowExecutionId": { + "target": "com.amazonaws.imagebuilder#WorkflowExecutionId", + "traits": { + "smithy.api#documentation": "

The unique identifier that Image Builder assigned to keep track of runtime details\n\t\t\twhen it ran the workflow.

" + } + }, + "imageBuildVersionArn": { + "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", + "traits": { + "smithy.api#documentation": "

The image build version resource ARN that's associated with the specified runtime \n\t\t\tinstance of the workflow.

" + } + }, + "message": { + "target": "com.amazonaws.imagebuilder#ImageBuildMessage", + "traits": { + "smithy.api#documentation": "

The output message from the list action, if applicable.

" + } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#PaginationToken", + "traits": { + "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#Logging": { + "type": "structure", + "members": { + "s3Logs": { + "target": "com.amazonaws.imagebuilder#S3Logs", + "traits": { + "smithy.api#documentation": "

The Amazon S3 logging configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Logging configuration defines where Image Builder uploads your logs.

" + } + }, + "com.amazonaws.imagebuilder#MaxParallelLaunches": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10000 + } + } + }, + "com.amazonaws.imagebuilder#NonEmptyString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.imagebuilder#NonEmptyStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#NonEmptyString" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.imagebuilder#NonNegativeDouble": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.imagebuilder#NullableBoolean": { + "type": "boolean" + }, + "com.amazonaws.imagebuilder#OrganizationArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[^:]*:organizations::[0-9]{12}:organization/o-[a-z0-9]{10,32}$" + } + }, + "com.amazonaws.imagebuilder#OrganizationArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#OrganizationArn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.imagebuilder#OrganizationalUnitArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[^:]*:organizations::[0-9]{12}:ou/o-[a-z0-9]{10,32}/ou-[0-9a-z]{4,32}-[0-9a-z]{8,32}$" + } + }, + "com.amazonaws.imagebuilder#OrganizationalUnitArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#OrganizationalUnitArn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.imagebuilder#OsVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.imagebuilder#OsVersionList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#OsVersion" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.imagebuilder#OutputResources": { + "type": "structure", + "members": { + "amis": { + "target": "com.amazonaws.imagebuilder#AmiList", + "traits": { + "smithy.api#documentation": "

The Amazon EC2 AMIs created by this image.

" + } + }, + "containers": { + "target": "com.amazonaws.imagebuilder#ContainerList", + "traits": { + "smithy.api#documentation": "

Container images that the pipeline has generated and stored in the output\n\t\t\trepository.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The resources produced by this image.

" + } + }, + "com.amazonaws.imagebuilder#Ownership": { + "type": "enum", + "members": { + "SELF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Self" + } + }, + "SHARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Shared" + } + }, + "AMAZON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Amazon" + } + }, + "THIRDPARTY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ThirdParty" + } + } + } + }, + "com.amazonaws.imagebuilder#PackageArchitecture": { + "type": "string" + }, + "com.amazonaws.imagebuilder#PackageEpoch": { + "type": "integer" + }, + "com.amazonaws.imagebuilder#PackageVulnerabilityDetails": { + "type": "structure", + "members": { + "vulnerabilityId": { + "target": "com.amazonaws.imagebuilder#VulnerabilityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for this vulnerability.

", + "smithy.api#required": {} + } + }, + "vulnerablePackages": { + "target": "com.amazonaws.imagebuilder#VulnerablePackageList", + "traits": { + "smithy.api#documentation": "

The packages that this vulnerability impacts.

" + } + }, + "source": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The source of the vulnerability information.

" + } + }, + "cvss": { + "target": "com.amazonaws.imagebuilder#CvssScoreList", + "traits": { + "smithy.api#documentation": "

CVSS scores for one or more vulnerabilities that Amazon Inspector identified for a\n\t\t\tpackage.

" + } + }, + "relatedVulnerabilities": { + "target": "com.amazonaws.imagebuilder#VulnerabilityIdList", + "traits": { + "smithy.api#documentation": "

Vulnerabilities that are often related to the findings for the package.

" + } + }, + "sourceUrl": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A link to the source of the vulnerability information.

" + } + }, + "vendorSeverity": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The severity that the vendor assigned to this vulnerability type.

" + } + }, + "vendorCreatedAt": { + "target": "com.amazonaws.imagebuilder#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "

The date and time when this vulnerability was first added to the vendor's\n\t\t\tdatabase.

" + } + }, + "vendorUpdatedAt": { + "target": "com.amazonaws.imagebuilder#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "

The date and time when the vendor last updated this vulnerability in their\n\t\t\tdatabase.

" + } + }, + "referenceUrls": { + "target": "com.amazonaws.imagebuilder#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

Links to web pages that contain details about the vulnerabilities that Amazon Inspector\n\t\t\tidentified for the package.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about package vulnerability findings.

" + } + }, + "com.amazonaws.imagebuilder#PaginationToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 65535 + } + } + }, + "com.amazonaws.imagebuilder#PipelineExecutionStartCondition": { + "type": "enum", + "members": { + "EXPRESSION_MATCH_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPRESSION_MATCH_ONLY" + } + }, + "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE" + } + } + } + }, + "com.amazonaws.imagebuilder#PipelineStatus": { + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + } + } + }, + "com.amazonaws.imagebuilder#Platform": { + "type": "enum", + "members": { + "WINDOWS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Windows" + } + }, + "LINUX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Linux" + } + } + } + }, + "com.amazonaws.imagebuilder#PutComponentPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#PutComponentPolicyRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#PutComponentPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Applies a policy to a component. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API\n\t\t\t\tPutComponentPolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be\n\t\t\tvisible to all principals with whom the resource is shared.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/PutComponentPolicy", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#PutComponentPolicyRequest": { + "type": "structure", + "members": { + "componentArn": { + "target": "com.amazonaws.imagebuilder#ComponentBuildVersionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component that this policy should be applied\n\t\t\tto.

", + "smithy.api#required": {} + } + }, + "policy": { + "target": "com.amazonaws.imagebuilder#ResourcePolicyDocument", + "traits": { + "smithy.api#documentation": "

The policy to apply.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#PutComponentPolicyResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "componentArn": { + "target": "com.amazonaws.imagebuilder#ComponentBuildVersionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component that this policy was applied\n\t\t\tto.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.imagebuilder#ClientException" + "com.amazonaws.imagebuilder#PutContainerRecipePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#PutContainerRecipePolicyRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#PutContainerRecipePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Applies a policy to a container image. We recommend that you call the RAM API\n\t\t\tCreateResourceShare\n\t\t\t(https://docs.aws.amazon.com//ram/latest/APIReference/API_CreateResourceShare.html) to share\n\t\t\tresources. If you call the Image Builder API PutContainerImagePolicy, you must also\n\t\t\tcall the RAM API PromoteResourceShareCreatedFromPolicy\n\t\t\t(https://docs.aws.amazon.com//ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html)\n\t\t\tin order for the resource to be visible to all principals with whom the resource is\n\t\t\tshared.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/PutContainerRecipePolicy", + "code": 200 + } + } }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" + "com.amazonaws.imagebuilder#PutContainerRecipePolicyRequest": { + "type": "structure", + "members": { + "containerRecipeArn": { + "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container recipe that this policy should be\n\t\t\tapplied to.

", + "smithy.api#required": {} + } + }, + "policy": { + "target": "com.amazonaws.imagebuilder#ResourcePolicyDocument", + "traits": { + "smithy.api#documentation": "

The policy to apply to the container recipe.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" + "com.amazonaws.imagebuilder#PutContainerRecipePolicyResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "containerRecipeArn": { + "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container recipe that this policy was applied\n\t\t\tto.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" + "com.amazonaws.imagebuilder#PutImagePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#PutImagePolicyRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#PutImagePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Applies a policy to an image. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API\n\t\t\t\tPutImagePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be\n\t\t\tvisible to all principals with whom the resource is shared.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/PutImagePolicy", + "code": 200 + } + } }, - { - "target": "com.amazonaws.imagebuilder#ResourceInUseException" + "com.amazonaws.imagebuilder#PutImagePolicyRequest": { + "type": "structure", + "members": { + "imageArn": { + "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image that this policy should be applied\n\t\t\tto.

", + "smithy.api#required": {} + } + }, + "policy": { + "target": "com.amazonaws.imagebuilder#ResourcePolicyDocument", + "traits": { + "smithy.api#documentation": "

The policy to apply.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" + "com.amazonaws.imagebuilder#PutImagePolicyResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "imageArn": { + "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image that this policy was applied to.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" + "com.amazonaws.imagebuilder#PutImageRecipePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#PutImageRecipePolicyRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#PutImageRecipePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Applies a policy to an image recipe. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API\n\t\t\t\tPutImageRecipePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be\n\t\t\tvisible to all principals with whom the resource is shared.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/PutImageRecipePolicy", + "code": 200 + } + } }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Manually triggers a pipeline to create an image.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/StartImagePipelineExecution", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#StartImagePipelineExecutionRequest": { - "type": "structure", - "members": { - "imagePipelineArn": { - "target": "com.amazonaws.imagebuilder#ImagePipelineArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline that you want to manually\n\t\t\tinvoke.

", - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", - "traits": { - "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#StartImagePipelineExecutionResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", - "traits": { - "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" - } - }, - "imageBuildVersionArn": { - "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image that was created by this request.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#StringList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#NonEmptyString" - } - }, - "com.amazonaws.imagebuilder#SystemsManagerAgent": { - "type": "structure", - "members": { - "uninstallAfterBuild": { - "target": "com.amazonaws.imagebuilder#NullableBoolean", - "traits": { - "smithy.api#documentation": "

Controls whether the Systems Manager agent is removed from your final build image, prior to\n\t\t\tcreating the new AMI. If this is set to true, then the agent is removed from the final\n\t\t\timage. If it's set to false, then the agent is left in, so that it is included in the\n\t\t\tnew AMI. The default value is false.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains settings for the Systems Manager agent on your build instance.

" - } - }, - "com.amazonaws.imagebuilder#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" - } - }, - "com.amazonaws.imagebuilder#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.imagebuilder#TagMap": { - "type": "map", - "key": { - "target": "com.amazonaws.imagebuilder#TagKey" - }, - "value": { - "target": "com.amazonaws.imagebuilder#TagValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.imagebuilder#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#TagResourceRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#TagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#InvalidParameterException" - }, - { - "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - } - ], - "traits": { - "smithy.api#documentation": "

Adds a tag to a resource.

", - "smithy.api#http": { - "method": "POST", - "uri": "/tags/{resourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#TagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.imagebuilder#ImageBuilderArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to tag.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.imagebuilder#TagMap", - "traits": { - "smithy.api#documentation": "

The tags to apply to the resource.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#TagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.imagebuilder#TargetContainerRepository": { - "type": "structure", - "members": { - "service": { - "target": "com.amazonaws.imagebuilder#ContainerRepositoryService", - "traits": { - "smithy.api#documentation": "

Specifies the service in which this image was registered.

", - "smithy.api#required": {} - } - }, - "repositoryName": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the container repository where the output container image is stored. This\n\t\t\tname is prefixed by the repository location.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The container repository where the output container image is stored.

" - } - }, - "com.amazonaws.imagebuilder#TargetResourceCount": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 10000 - } - } - }, - "com.amazonaws.imagebuilder#Timezone": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 100 - }, - "smithy.api#pattern": "^[a-zA-Z0-9]{2,}(?:\\/[a-zA-z0-9-_+]+)*$" - } - }, - "com.amazonaws.imagebuilder#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#UntagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#InvalidParameterException" - }, - { - "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes a tag from a resource.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/tags/{resourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#UntagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.imagebuilder#ImageBuilderArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to untag.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tagKeys": { - "target": "com.amazonaws.imagebuilder#TagKeyList", - "traits": { - "smithy.api#documentation": "

The tag keys to remove from the resource.

", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#UntagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#UpdateDistributionConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#UpdateDistributionConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#UpdateDistributionConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + "com.amazonaws.imagebuilder#PutImageRecipePolicyRequest": { + "type": "structure", + "members": { + "imageRecipeArn": { + "target": "com.amazonaws.imagebuilder#ImageRecipeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe that this policy should be applied\n\t\t\tto.

", + "smithy.api#required": {} + } + }, + "policy": { + "target": "com.amazonaws.imagebuilder#ResourcePolicyDocument", + "traits": { + "smithy.api#documentation": "

The policy to apply.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.imagebuilder#ClientException" + "com.amazonaws.imagebuilder#PutImageRecipePolicyResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "imageRecipeArn": { + "target": "com.amazonaws.imagebuilder#ImageRecipeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe that this policy was applied\n\t\t\tto.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" + "com.amazonaws.imagebuilder#RegionList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#NonEmptyString" + } }, - { - "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" + "com.amazonaws.imagebuilder#Remediation": { + "type": "structure", + "members": { + "recommendation": { + "target": "com.amazonaws.imagebuilder#RemediationRecommendation", + "traits": { + "smithy.api#documentation": "

An object that contains information about the recommended course of action to\n\t\t\tremediate the finding.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about how to remediate a finding.

" + } }, - { - "target": "com.amazonaws.imagebuilder#InvalidParameterCombinationException" + "com.amazonaws.imagebuilder#RemediationRecommendation": { + "type": "structure", + "members": { + "text": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The recommended course of action to remediate the finding.

" + } + }, + "url": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A link to more information about the recommended remediation for this\n\t\t\tvulnerability.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the recommended course of action to remediate the finding.

" + } }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" + "com.amazonaws.imagebuilder#ResourceAlreadyExistsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.imagebuilder#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The resource that you are trying to create already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.imagebuilder#ResourceInUseException" + "com.amazonaws.imagebuilder#ResourceDependencyException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.imagebuilder#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

You have attempted to mutate or delete a resource with a dependency that prohibits\n\t\t\tthis action. See the error message for more details.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" + "com.amazonaws.imagebuilder#ResourceInUseException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.imagebuilder#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The resource that you are trying to operate on is currently in use. Review the message\n\t\t\tdetails and retry later.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a new distribution configuration. Distribution configurations define and\n\t\t\tconfigure the outputs of your pipeline.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/UpdateDistributionConfiguration", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#UpdateDistributionConfigurationRequest": { - "type": "structure", - "members": { - "distributionConfigurationArn": { - "target": "com.amazonaws.imagebuilder#DistributionConfigurationArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration that you want to\n\t\t\tupdate.

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The description of the distribution configuration.

" - } - }, - "distributions": { - "target": "com.amazonaws.imagebuilder#DistributionList", - "traits": { - "smithy.api#documentation": "

The distributions of the distribution configuration.

", - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", - "traits": { - "smithy.api#documentation": "

The idempotency token of the distribution configuration.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#UpdateDistributionConfigurationResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", - "traits": { - "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" - } - }, - "distributionConfigurationArn": { - "target": "com.amazonaws.imagebuilder#DistributionConfigurationArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration that was updated by\n\t\t\tthis request.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#UpdateImagePipeline": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#UpdateImagePipelineRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#UpdateImagePipelineResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ResourceInUseException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates an image pipeline. Image pipelines enable you to automate the creation and\n\t\t\tdistribution of images.

\n \n

UpdateImagePipeline does not support selective updates for the pipeline. You must\n\t\t\t\tspecify all of the required properties in the update request, not just the\n\t\t\t\tproperties that have changed.

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/UpdateImagePipeline", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#UpdateImagePipelineRequest": { - "type": "structure", - "members": { - "imagePipelineArn": { - "target": "com.amazonaws.imagebuilder#ImagePipelineArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline that you want to update.

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The description of the image pipeline.

" - } - }, - "imageRecipeArn": { - "target": "com.amazonaws.imagebuilder#ImageRecipeArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe that will be used to configure\n\t\t\timages updated by this image pipeline.

" - } - }, - "containerRecipeArn": { - "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container pipeline to update.

" - } - }, - "infrastructureConfigurationArn": { - "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that Image Builder uses to\n\t\t\tbuild images that this image pipeline has updated.

", - "smithy.api#required": {} - } - }, - "distributionConfigurationArn": { - "target": "com.amazonaws.imagebuilder#DistributionConfigurationArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration that Image Builder uses to\n\t\t\tconfigure and distribute images that this image pipeline has updated.

" - } - }, - "imageTestsConfiguration": { - "target": "com.amazonaws.imagebuilder#ImageTestsConfiguration", - "traits": { - "smithy.api#documentation": "

The image test configuration of the image pipeline.

" - } - }, - "enhancedImageMetadataEnabled": { - "target": "com.amazonaws.imagebuilder#NullableBoolean", - "traits": { - "smithy.api#documentation": "

Collects additional information about the image being created, including the operating\n\t\t\tsystem (OS) version and package list. This information is used to enhance the overall\n\t\t\texperience of using EC2 Image Builder. Enabled by default.

" - } - }, - "schedule": { - "target": "com.amazonaws.imagebuilder#Schedule", - "traits": { - "smithy.api#documentation": "

The schedule of the image pipeline.

" - } - }, - "status": { - "target": "com.amazonaws.imagebuilder#PipelineStatus", - "traits": { - "smithy.api#documentation": "

The status of the image pipeline.

" - } - }, - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", - "traits": { - "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "imageScanningConfiguration": { - "target": "com.amazonaws.imagebuilder#ImageScanningConfiguration", - "traits": { - "smithy.api#documentation": "

Contains settings for vulnerability scans.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#UpdateImagePipelineResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", - "traits": { - "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" - } - }, - "imagePipelineArn": { - "target": "com.amazonaws.imagebuilder#ImagePipelineArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline that was updated by this\n\t\t\trequest.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#UpdateInfrastructureConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#UpdateInfrastructureConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#UpdateInfrastructureConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" - }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" - }, - { - "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" - }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" - }, - { - "target": "com.amazonaws.imagebuilder#ResourceInUseException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" - }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a new infrastructure configuration. An infrastructure configuration defines\n\t\t\tthe environment in which your image will be built and tested.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/UpdateInfrastructureConfiguration", - "code": 200 - } - } - }, - "com.amazonaws.imagebuilder#UpdateInfrastructureConfigurationRequest": { - "type": "structure", - "members": { - "infrastructureConfigurationArn": { - "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that you want to\n\t\t\tupdate.

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The description of the infrastructure configuration.

" - } - }, - "instanceTypes": { - "target": "com.amazonaws.imagebuilder#InstanceTypeList", - "traits": { - "smithy.api#documentation": "

The instance types of the infrastructure configuration. You can specify one or more\n\t\t\tinstance types to use for this build. The service will pick one of these instance types\n\t\t\tbased on availability.

" - } - }, - "instanceProfileName": { - "target": "com.amazonaws.imagebuilder#InstanceProfileNameType", - "traits": { - "smithy.api#documentation": "

The instance profile to associate with the instance used to customize your Amazon EC2\n\t\t\tAMI.

", - "smithy.api#required": {} - } - }, - "securityGroupIds": { - "target": "com.amazonaws.imagebuilder#SecurityGroupIds", - "traits": { - "smithy.api#documentation": "

The security group IDs to associate with the instance used to customize your Amazon EC2\n\t\t\tAMI.

" - } - }, - "subnetId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The subnet ID to place the instance used to customize your Amazon EC2 AMI in.

" - } - }, - "logging": { - "target": "com.amazonaws.imagebuilder#Logging", - "traits": { - "smithy.api#documentation": "

The logging configuration of the infrastructure configuration.

" - } - }, - "keyPair": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The key pair of the infrastructure configuration. You can use this to log on to and\n\t\t\tdebug the instance used to create your image.

" - } - }, - "terminateInstanceOnFailure": { - "target": "com.amazonaws.imagebuilder#NullableBoolean", - "traits": { - "smithy.api#documentation": "

The terminate instance on failure setting of the infrastructure configuration. Set to\n\t\t\tfalse if you want Image Builder to retain the instance used to configure your AMI if the build or\n\t\t\ttest phase of your workflow fails.

" - } - }, - "snsTopicArn": { - "target": "com.amazonaws.imagebuilder#SnsTopicArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the SNS topic to which we send image build event\n\t\t\tnotifications.

\n \n

EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys \n\t\t\t\tfrom other accounts. The key that is used to encrypt the SNS topic must reside in the \n\t\t\t\taccount that the Image Builder service runs under.

\n " - } - }, - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", - "traits": { - "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "resourceTags": { - "target": "com.amazonaws.imagebuilder#ResourceTagMap", - "traits": { - "smithy.api#documentation": "

The tags attached to the resource created by Image Builder.

" - } - }, - "instanceMetadataOptions": { - "target": "com.amazonaws.imagebuilder#InstanceMetadataOptions", - "traits": { - "smithy.api#documentation": "

The instance metadata options that you can set for the HTTP requests that pipeline\n\t\t\tbuilds use to launch EC2 build and test instances. For more information about instance\n\t\t\tmetadata options, see one of the following links:

\n " - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.imagebuilder#UpdateInfrastructureConfigurationResponse": { - "type": "structure", - "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", - "traits": { - "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" - } - }, - "infrastructureConfigurationArn": { - "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that was updated by\n\t\t\tthis request.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.imagebuilder#Uri": { - "type": "string" - }, - "com.amazonaws.imagebuilder#UserDataOverride": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 21847 - }, - "smithy.api#pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$" - } - }, - "com.amazonaws.imagebuilder#VersionNumber": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+$" - } - }, - "com.amazonaws.imagebuilder#VulnerabilityId": { - "type": "string" - }, - "com.amazonaws.imagebuilder#VulnerabilityIdAggregation": { - "type": "structure", - "members": { - "vulnerabilityId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The vulnerability Id for this set of counts.

" - } - }, - "severityCounts": { - "target": "com.amazonaws.imagebuilder#SeverityCounts", - "traits": { - "smithy.api#documentation": "

Counts by severity level for medium severity and higher level findings, plus a total\n\t\t\tfor all of the findings for the specified vulnerability.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Includes counts of image and pipeline resource findings by vulnerability.

" - } - }, - "com.amazonaws.imagebuilder#VulnerabilityIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#VulnerabilityId" - } - }, - "com.amazonaws.imagebuilder#VulnerablePackage": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the vulnerable package.

" - } - }, - "version": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The version of the vulnerable package.

" - } - }, - "sourceLayerHash": { - "target": "com.amazonaws.imagebuilder#SourceLayerHash", - "traits": { - "smithy.api#documentation": "

The source layer hash of the vulnerable package.

" - } - }, - "epoch": { - "target": "com.amazonaws.imagebuilder#PackageEpoch", - "traits": { - "smithy.api#documentation": "

The epoch of the vulnerable package.

" - } - }, - "release": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The release of the vulnerable package.

" - } - }, - "arch": { - "target": "com.amazonaws.imagebuilder#PackageArchitecture", - "traits": { - "smithy.api#documentation": "

The architecture of the vulnerable package.

" - } - }, - "packageManager": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The package manager of the vulnerable package.

" - } - }, - "filePath": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The file path of the vulnerable package.

" - } - }, - "fixedInVersion": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The version of the package that contains the vulnerability fix.

" - } - }, - "remediation": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The code to run in your environment to update packages with a fix available.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a vulnerable package that Amazon Inspector identifies in a finding.

" - } - }, - "com.amazonaws.imagebuilder#VulnerablePackageList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#VulnerablePackage" - } - }, - "com.amazonaws.imagebuilder#WorkflowBuildVersionArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^arn:aws(?:-[a-z]+)*:imagebuilder:[a-z]{2,}(?:-[a-z]+)+-[0-9]+:(?:[0-9]{12}|aws):workflow/(build|test|distribution)/[a-z0-9-_]+/[0-9]+\\.[0-9]+\\.[0-9]+/[0-9]+$" - } - }, - "com.amazonaws.imagebuilder#WorkflowExecutionId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^wf-[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}$" - } - }, - "com.amazonaws.imagebuilder#WorkflowExecutionMessage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 500 - } - } - }, - "com.amazonaws.imagebuilder#WorkflowExecutionMetadata": { - "type": "structure", - "members": { - "workflowBuildVersionArn": { - "target": "com.amazonaws.imagebuilder#WorkflowBuildVersionArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the workflow resource build version that ran.

" - } - }, - "workflowExecutionId": { - "target": "com.amazonaws.imagebuilder#WorkflowExecutionId", - "traits": { - "smithy.api#documentation": "

Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a\n\t\t\tworkflow.

" - } - }, - "type": { - "target": "com.amazonaws.imagebuilder#WorkflowType", - "traits": { - "smithy.api#documentation": "

Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.

" - } - }, - "status": { - "target": "com.amazonaws.imagebuilder#WorkflowExecutionStatus", - "traits": { - "smithy.api#documentation": "

The current runtime status for this workflow.

" - } - }, - "message": { - "target": "com.amazonaws.imagebuilder#WorkflowExecutionMessage", - "traits": { - "smithy.api#documentation": "

The runtime output message from the workflow, if applicable.

" - } - }, - "totalStepCount": { - "target": "com.amazonaws.imagebuilder#WorkflowStepCount", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The total number of steps in the workflow. This should equal the sum of the step\n\t\t\tcounts for steps that succeeded, were skipped, and failed.

" - } - }, - "totalStepsSucceeded": { - "target": "com.amazonaws.imagebuilder#WorkflowStepCount", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

A runtime count for the number of steps in the workflow that ran successfully.

" - } - }, - "totalStepsFailed": { - "target": "com.amazonaws.imagebuilder#WorkflowStepCount", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

A runtime count for the number of steps in the workflow that failed.

" - } - }, - "totalStepsSkipped": { - "target": "com.amazonaws.imagebuilder#WorkflowStepCount", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

A runtime count for the number of steps in the workflow that were skipped.

" - } - }, - "startTime": { - "target": "com.amazonaws.imagebuilder#DateTime", - "traits": { - "smithy.api#documentation": "

The timestamp when the runtime instance of this workflow started.

" - } - }, - "endTime": { - "target": "com.amazonaws.imagebuilder#DateTime", - "traits": { - "smithy.api#documentation": "

The timestamp when this runtime instance of the workflow finished.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Metadata that includes details and status from this runtime instance of the workflow.

" - } - }, - "com.amazonaws.imagebuilder#WorkflowExecutionStatus": { - "type": "enum", - "members": { - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "SKIPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SKIPPED" - } - }, - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "ROLLBACK_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ROLLBACK_IN_PROGRESS" - } - }, - "ROLLBACK_COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ROLLBACK_COMPLETED" - } - } - } - }, - "com.amazonaws.imagebuilder#WorkflowExecutionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#WorkflowExecutionMetadata" - } - }, - "com.amazonaws.imagebuilder#WorkflowStepAction": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[A-Za-z][A-Za-z0-9-_]{1,99}$" - } - }, - "com.amazonaws.imagebuilder#WorkflowStepCount": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.imagebuilder#WorkflowStepDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 500 - } - } - }, - "com.amazonaws.imagebuilder#WorkflowStepExecutionId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^step-[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}$" - } - }, - "com.amazonaws.imagebuilder#WorkflowStepExecutionRollbackStatus": { - "type": "enum", - "members": { - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - }, - "SKIPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SKIPPED" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - } - } - }, - "com.amazonaws.imagebuilder#WorkflowStepExecutionStatus": { - "type": "enum", - "members": { - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "SKIPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SKIPPED" - } - }, - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - } - } - }, - "com.amazonaws.imagebuilder#WorkflowStepExecutionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#WorkflowStepMetadata" - } - }, - "com.amazonaws.imagebuilder#WorkflowStepInputs": { - "type": "string" - }, - "com.amazonaws.imagebuilder#WorkflowStepMessage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 500 - } - } - }, - "com.amazonaws.imagebuilder#WorkflowStepMetadata": { - "type": "structure", - "members": { - "stepExecutionId": { - "target": "com.amazonaws.imagebuilder#WorkflowStepExecutionId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the workflow step, assigned at runtime.

" - } - }, - "name": { - "target": "com.amazonaws.imagebuilder#WorkflowStepName", - "traits": { - "smithy.api#documentation": "

The name of the workflow step.

" - } - }, - "description": { - "target": "com.amazonaws.imagebuilder#WorkflowStepDescription", - "traits": { - "smithy.api#documentation": "

Description of the workflow step.

" - } - }, - "action": { - "target": "com.amazonaws.imagebuilder#WorkflowStepAction", - "traits": { - "smithy.api#documentation": "

The step action name.

" - } - }, - "status": { - "target": "com.amazonaws.imagebuilder#WorkflowStepExecutionStatus", - "traits": { - "smithy.api#documentation": "

Runtime status for the workflow step.

" - } - }, - "rollbackStatus": { - "target": "com.amazonaws.imagebuilder#WorkflowStepExecutionRollbackStatus", - "traits": { - "smithy.api#documentation": "

Reports on the rollback status of the step, if applicable.

" - } - }, - "message": { - "target": "com.amazonaws.imagebuilder#WorkflowStepMessage", - "traits": { - "smithy.api#documentation": "

Detailed output message that the workflow step provides at runtime.

" - } - }, - "inputs": { - "target": "com.amazonaws.imagebuilder#WorkflowStepInputs", - "traits": { - "smithy.api#documentation": "

Input parameters that Image Builder provides for the workflow step.

" - } - }, - "outputs": { - "target": "com.amazonaws.imagebuilder#WorkflowStepOutputs", - "traits": { - "smithy.api#documentation": "

The file names that the workflow step created as output for this runtime instance of the workflow.

" - } - }, - "startTime": { - "target": "com.amazonaws.imagebuilder#DateTime", - "traits": { - "smithy.api#documentation": "

The timestamp when the workflow step started.

" - } - }, - "endTime": { - "target": "com.amazonaws.imagebuilder#DateTime", - "traits": { - "smithy.api#documentation": "

The timestamp when the workflow step finished.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Runtime details and status for the workflow step.

" - } - }, - "com.amazonaws.imagebuilder#WorkflowStepName": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[A-Za-z][A-Za-z0-9-_]{1,99}$" - } - }, - "com.amazonaws.imagebuilder#WorkflowStepOutputs": { - "type": "string" - }, - "com.amazonaws.imagebuilder#WorkflowStepTimeoutSecondsInteger": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 43200 - } - } - }, - "com.amazonaws.imagebuilder#WorkflowType": { - "type": "enum", - "members": { - "BUILD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BUILD" - } - }, - "TEST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TEST" - } - }, - "DISTRIBUTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISTRIBUTION" - } - } - } - }, - "com.amazonaws.imagebuilder#imagebuilder": { - "type": "service", - "version": "2019-12-02", - "operations": [ - { - "target": "com.amazonaws.imagebuilder#CancelImageCreation" + "com.amazonaws.imagebuilder#ResourceName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[-_A-Za-z-0-9][-_A-Za-z0-9 ]{1,126}[-_A-Za-z-0-9]$" + } + }, + "com.amazonaws.imagebuilder#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.imagebuilder#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

At least one of the resources referenced by your request does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.imagebuilder#ResourcePolicyDocument": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30000 + } + } + }, + "com.amazonaws.imagebuilder#ResourceTagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.imagebuilder#TagKey" + }, + "value": { + "target": "com.amazonaws.imagebuilder#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + } + } + }, + "com.amazonaws.imagebuilder#RestrictedInteger": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.imagebuilder#S3ExportConfiguration": { + "type": "structure", + "members": { + "roleName": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the role that grants VM Import/Export permission to export images to your\n\t\t\tS3 bucket.

", + "smithy.api#required": {} + } + }, + "diskImageFormat": { + "target": "com.amazonaws.imagebuilder#DiskImageFormat", + "traits": { + "smithy.api#documentation": "

Export the updated image to one of the following supported disk image formats:

\n ", + "smithy.api#required": {} + } + }, + "s3Bucket": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The S3 bucket in which to store the output disk images for your VM.

", + "smithy.api#required": {} + } + }, + "s3Prefix": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon S3 path for the bucket where the output disk images for your VM are\n\t\t\tstored.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Properties that configure export from your build instance to a compatible file format\n\t\t\tfor your VM.

" + } + }, + "com.amazonaws.imagebuilder#S3Logs": { + "type": "structure", + "members": { + "s3BucketName": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The S3 bucket in which to store the logs.

" + } + }, + "s3KeyPrefix": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon S3 path to the bucket where the logs are stored.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Amazon S3 logging configuration.

" + } + }, + "com.amazonaws.imagebuilder#Schedule": { + "type": "structure", + "members": { + "scheduleExpression": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The cron expression determines how often EC2 Image Builder evaluates your\n\t\t\t\tpipelineExecutionStartCondition.

\n

For information on how to format a cron expression in Image Builder, see Use\n\t\t\t\tcron expressions in EC2 Image Builder.

" + } + }, + "timezone": { + "target": "com.amazonaws.imagebuilder#Timezone", + "traits": { + "smithy.api#documentation": "

The timezone that applies to the scheduling expression. For example, \"Etc/UTC\",\n\t\t\t\"America/Los_Angeles\" in the IANA timezone format. If not specified this defaults to UTC.

" + } + }, + "pipelineExecutionStartCondition": { + "target": "com.amazonaws.imagebuilder#PipelineExecutionStartCondition", + "traits": { + "smithy.api#documentation": "

The condition configures when the pipeline should trigger a new image build. When the\n\t\t\t\tpipelineExecutionStartCondition is set to\n\t\t\t\tEXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE, and you use semantic\n\t\t\tversion filters on the base image or components in your image recipe, EC2 Image Builder will\n\t\t\tbuild a new image only when there are new versions of the image or components in your\n\t\t\trecipe that match the semantic version filter. When it is set to\n\t\t\t\tEXPRESSION_MATCH_ONLY, it will build a new image every time the CRON\n\t\t\texpression matches the current time. For semantic version syntax, see CreateComponent in the EC2 Image Builder API Reference.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A schedule configures how often and when a pipeline will automatically create a new\n\t\t\timage.

" + } + }, + "com.amazonaws.imagebuilder#SecurityGroupIds": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#NonEmptyString" + } + }, + "com.amazonaws.imagebuilder#ServiceException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.imagebuilder#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

This exception is thrown when the service encounters an unrecoverable\n\t\t\texception.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.imagebuilder#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.imagebuilder#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

You have exceeded the number of permitted resources or operations for this service.\n\t\t\tFor service quotas, see EC2 Image Builder endpoints and\n\t\t\t\tquotas.

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.imagebuilder#ServiceUnavailableException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.imagebuilder#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The service is unable to process your request at this time.

", + "smithy.api#error": "server", + "smithy.api#httpError": 503 + } + }, + "com.amazonaws.imagebuilder#SeverityCountNumber": { + "type": "long" + }, + "com.amazonaws.imagebuilder#SeverityCounts": { + "type": "structure", + "members": { + "all": { + "target": "com.amazonaws.imagebuilder#SeverityCountNumber", + "traits": { + "smithy.api#documentation": "

The total number of findings across all severity levels for the specified filter.

" + } + }, + "critical": { + "target": "com.amazonaws.imagebuilder#SeverityCountNumber", + "traits": { + "smithy.api#documentation": "

The number of critical severity findings for the specified filter.

" + } + }, + "high": { + "target": "com.amazonaws.imagebuilder#SeverityCountNumber", + "traits": { + "smithy.api#documentation": "

The number of high severity findings for the specified filter.

" + } + }, + "medium": { + "target": "com.amazonaws.imagebuilder#SeverityCountNumber", + "traits": { + "smithy.api#documentation": "

The number of medium severity findings for the specified filter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Includes counts by severity level for medium severity and higher level findings, plus a total\n\t\t\tfor all of the findings for the specified filter.

" + } + }, + "com.amazonaws.imagebuilder#SnsTopicArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[^:]*:sns:[^:]+:[0-9]{12}:[a-zA-Z0-9-_]{1,256}$" + } + }, + "com.amazonaws.imagebuilder#SourceLayerHash": { + "type": "string" }, - { - "target": "com.amazonaws.imagebuilder#CreateComponent" + "com.amazonaws.imagebuilder#StartImagePipelineExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#StartImagePipelineExecutionRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#StartImagePipelineExecutionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceInUseException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Manually triggers a pipeline to create an image.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/StartImagePipelineExecution", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#StartImagePipelineExecutionRequest": { + "type": "structure", + "members": { + "imagePipelineArn": { + "target": "com.amazonaws.imagebuilder#ImagePipelineArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline that you want to manually\n\t\t\tinvoke.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.imagebuilder#CreateContainerRecipe" + "com.amazonaws.imagebuilder#StartImagePipelineExecutionResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" + } + }, + "imageBuildVersionArn": { + "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image that was created by this request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.imagebuilder#CreateDistributionConfiguration" + "com.amazonaws.imagebuilder#StringList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#NonEmptyString" + } }, - { - "target": "com.amazonaws.imagebuilder#CreateImage" + "com.amazonaws.imagebuilder#SystemsManagerAgent": { + "type": "structure", + "members": { + "uninstallAfterBuild": { + "target": "com.amazonaws.imagebuilder#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Controls whether the Systems Manager agent is removed from your final build image, prior to\n\t\t\tcreating the new AMI. If this is set to true, then the agent is removed from the final\n\t\t\timage. If it's set to false, then the agent is left in, so that it is included in the\n\t\t\tnew AMI. The default value is false.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains settings for the Systems Manager agent on your build instance.

" + } }, - { - "target": "com.amazonaws.imagebuilder#CreateImagePipeline" + "com.amazonaws.imagebuilder#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" + } }, - { - "target": "com.amazonaws.imagebuilder#CreateImageRecipe" + "com.amazonaws.imagebuilder#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } }, - { - "target": "com.amazonaws.imagebuilder#CreateInfrastructureConfiguration" + "com.amazonaws.imagebuilder#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.imagebuilder#TagKey" + }, + "value": { + "target": "com.amazonaws.imagebuilder#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } }, - { - "target": "com.amazonaws.imagebuilder#DeleteComponent" + "com.amazonaws.imagebuilder#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#InvalidParameterException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds a tag to a resource.

", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } }, - { - "target": "com.amazonaws.imagebuilder#DeleteContainerRecipe" + "com.amazonaws.imagebuilder#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.imagebuilder#ImageBuilderArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to tag.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", + "traits": { + "smithy.api#documentation": "

The tags to apply to the resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.imagebuilder#DeleteDistributionConfiguration" + "com.amazonaws.imagebuilder#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.imagebuilder#DeleteImage" + "com.amazonaws.imagebuilder#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } }, - { - "target": "com.amazonaws.imagebuilder#DeleteImagePipeline" + "com.amazonaws.imagebuilder#TargetContainerRepository": { + "type": "structure", + "members": { + "service": { + "target": "com.amazonaws.imagebuilder#ContainerRepositoryService", + "traits": { + "smithy.api#documentation": "

Specifies the service in which this image was registered.

", + "smithy.api#required": {} + } + }, + "repositoryName": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the container repository where the output container image is stored. This\n\t\t\tname is prefixed by the repository location.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The container repository where the output container image is stored.

" + } }, - { - "target": "com.amazonaws.imagebuilder#DeleteImageRecipe" + "com.amazonaws.imagebuilder#TargetResourceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10000 + } + } }, - { - "target": "com.amazonaws.imagebuilder#DeleteInfrastructureConfiguration" + "com.amazonaws.imagebuilder#Timezone": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 100 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]{2,}(?:\\/[a-zA-z0-9-_+]+)*$" + } }, - { - "target": "com.amazonaws.imagebuilder#GetComponent" + "com.amazonaws.imagebuilder#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#InvalidParameterException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes a tag from a resource.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } }, - { - "target": "com.amazonaws.imagebuilder#GetComponentPolicy" + "com.amazonaws.imagebuilder#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.imagebuilder#ImageBuilderArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to untag.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.imagebuilder#TagKeyList", + "traits": { + "smithy.api#documentation": "

The tag keys to remove from the resource.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.imagebuilder#GetContainerRecipe" + "com.amazonaws.imagebuilder#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.imagebuilder#GetContainerRecipePolicy" + "com.amazonaws.imagebuilder#UpdateDistributionConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#UpdateDistributionConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#UpdateDistributionConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceInUseException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a new distribution configuration. Distribution configurations define and\n\t\t\tconfigure the outputs of your pipeline.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/UpdateDistributionConfiguration", + "code": 200 + } + } }, - { - "target": "com.amazonaws.imagebuilder#GetDistributionConfiguration" + "com.amazonaws.imagebuilder#UpdateDistributionConfigurationRequest": { + "type": "structure", + "members": { + "distributionConfigurationArn": { + "target": "com.amazonaws.imagebuilder#DistributionConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration that you want to\n\t\t\tupdate.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description of the distribution configuration.

" + } + }, + "distributions": { + "target": "com.amazonaws.imagebuilder#DistributionList", + "traits": { + "smithy.api#documentation": "

The distributions of the distribution configuration.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token of the distribution configuration.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.imagebuilder#GetImage" + "com.amazonaws.imagebuilder#UpdateDistributionConfigurationResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" + } + }, + "distributionConfigurationArn": { + "target": "com.amazonaws.imagebuilder#DistributionConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration that was updated by\n\t\t\tthis request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.imagebuilder#GetImagePipeline" + "com.amazonaws.imagebuilder#UpdateImagePipeline": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#UpdateImagePipelineRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#UpdateImagePipelineResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceInUseException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an image pipeline. Image pipelines enable you to automate the creation and\n\t\t\tdistribution of images.

\n \n

UpdateImagePipeline does not support selective updates for the pipeline. You must\n\t\t\t\tspecify all of the required properties in the update request, not just the\n\t\t\t\tproperties that have changed.

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/UpdateImagePipeline", + "code": 200 + } + } }, - { - "target": "com.amazonaws.imagebuilder#GetImagePolicy" + "com.amazonaws.imagebuilder#UpdateImagePipelineRequest": { + "type": "structure", + "members": { + "imagePipelineArn": { + "target": "com.amazonaws.imagebuilder#ImagePipelineArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline that you want to update.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description of the image pipeline.

" + } + }, + "imageRecipeArn": { + "target": "com.amazonaws.imagebuilder#ImageRecipeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe that will be used to configure\n\t\t\timages updated by this image pipeline.

" + } + }, + "containerRecipeArn": { + "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container pipeline to update.

" + } + }, + "infrastructureConfigurationArn": { + "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that Image Builder uses to\n\t\t\tbuild images that this image pipeline has updated.

", + "smithy.api#required": {} + } + }, + "distributionConfigurationArn": { + "target": "com.amazonaws.imagebuilder#DistributionConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration that Image Builder uses to\n\t\t\tconfigure and distribute images that this image pipeline has updated.

" + } + }, + "imageTestsConfiguration": { + "target": "com.amazonaws.imagebuilder#ImageTestsConfiguration", + "traits": { + "smithy.api#documentation": "

The image test configuration of the image pipeline.

" + } + }, + "enhancedImageMetadataEnabled": { + "target": "com.amazonaws.imagebuilder#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Collects additional information about the image being created, including the operating\n\t\t\tsystem (OS) version and package list. This information is used to enhance the overall\n\t\t\texperience of using EC2 Image Builder. Enabled by default.

" + } + }, + "schedule": { + "target": "com.amazonaws.imagebuilder#Schedule", + "traits": { + "smithy.api#documentation": "

The schedule of the image pipeline.

" + } + }, + "status": { + "target": "com.amazonaws.imagebuilder#PipelineStatus", + "traits": { + "smithy.api#documentation": "

The status of the image pipeline.

" + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "imageScanningConfiguration": { + "target": "com.amazonaws.imagebuilder#ImageScanningConfiguration", + "traits": { + "smithy.api#documentation": "

Contains settings for vulnerability scans.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.imagebuilder#GetImageRecipe" + "com.amazonaws.imagebuilder#UpdateImagePipelineResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" + } + }, + "imagePipelineArn": { + "target": "com.amazonaws.imagebuilder#ImagePipelineArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline that was updated by this\n\t\t\trequest.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.imagebuilder#GetImageRecipePolicy" + "com.amazonaws.imagebuilder#UpdateInfrastructureConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#UpdateInfrastructureConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#UpdateInfrastructureConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceInUseException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a new infrastructure configuration. An infrastructure configuration defines\n\t\t\tthe environment in which your image will be built and tested.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/UpdateInfrastructureConfiguration", + "code": 200 + } + } }, - { - "target": "com.amazonaws.imagebuilder#GetInfrastructureConfiguration" + "com.amazonaws.imagebuilder#UpdateInfrastructureConfigurationRequest": { + "type": "structure", + "members": { + "infrastructureConfigurationArn": { + "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that you want to\n\t\t\tupdate.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description of the infrastructure configuration.

" + } + }, + "instanceTypes": { + "target": "com.amazonaws.imagebuilder#InstanceTypeList", + "traits": { + "smithy.api#documentation": "

The instance types of the infrastructure configuration. You can specify one or more\n\t\t\tinstance types to use for this build. The service will pick one of these instance types\n\t\t\tbased on availability.

" + } + }, + "instanceProfileName": { + "target": "com.amazonaws.imagebuilder#InstanceProfileNameType", + "traits": { + "smithy.api#documentation": "

The instance profile to associate with the instance used to customize your Amazon EC2\n\t\t\tAMI.

", + "smithy.api#required": {} + } + }, + "securityGroupIds": { + "target": "com.amazonaws.imagebuilder#SecurityGroupIds", + "traits": { + "smithy.api#documentation": "

The security group IDs to associate with the instance used to customize your Amazon EC2\n\t\t\tAMI.

" + } + }, + "subnetId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The subnet ID to place the instance used to customize your Amazon EC2 AMI in.

" + } + }, + "logging": { + "target": "com.amazonaws.imagebuilder#Logging", + "traits": { + "smithy.api#documentation": "

The logging configuration of the infrastructure configuration.

" + } + }, + "keyPair": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The key pair of the infrastructure configuration. You can use this to log on to and\n\t\t\tdebug the instance used to create your image.

" + } + }, + "terminateInstanceOnFailure": { + "target": "com.amazonaws.imagebuilder#NullableBoolean", + "traits": { + "smithy.api#documentation": "

The terminate instance on failure setting of the infrastructure configuration. Set to\n\t\t\tfalse if you want Image Builder to retain the instance used to configure your AMI if the build or\n\t\t\ttest phase of your workflow fails.

" + } + }, + "snsTopicArn": { + "target": "com.amazonaws.imagebuilder#SnsTopicArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the SNS topic to which we send image build event\n\t\t\tnotifications.

\n \n

EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys \n\t\t\t\tfrom other accounts. The key that is used to encrypt the SNS topic must reside in the \n\t\t\t\taccount that the Image Builder service runs under.

\n " + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "resourceTags": { + "target": "com.amazonaws.imagebuilder#ResourceTagMap", + "traits": { + "smithy.api#documentation": "

The tags attached to the resource created by Image Builder.

" + } + }, + "instanceMetadataOptions": { + "target": "com.amazonaws.imagebuilder#InstanceMetadataOptions", + "traits": { + "smithy.api#documentation": "

The instance metadata options that you can set for the HTTP requests that pipeline\n\t\t\tbuilds use to launch EC2 build and test instances. For more information about instance\n\t\t\tmetadata options, see one of the following links:

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.imagebuilder#GetWorkflowExecution" + "com.amazonaws.imagebuilder#UpdateInfrastructureConfigurationResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" + } + }, + "infrastructureConfigurationArn": { + "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that was updated by\n\t\t\tthis request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.imagebuilder#GetWorkflowStepExecution" + "com.amazonaws.imagebuilder#Uri": { + "type": "string" }, - { - "target": "com.amazonaws.imagebuilder#ImportComponent" + "com.amazonaws.imagebuilder#UserDataOverride": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 21847 + }, + "smithy.api#pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$" + } }, - { - "target": "com.amazonaws.imagebuilder#ImportVmImage" + "com.amazonaws.imagebuilder#VersionNumber": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+$" + } }, - { - "target": "com.amazonaws.imagebuilder#ListComponentBuildVersions" + "com.amazonaws.imagebuilder#VulnerabilityId": { + "type": "string" }, - { - "target": "com.amazonaws.imagebuilder#ListComponents" + "com.amazonaws.imagebuilder#VulnerabilityIdAggregation": { + "type": "structure", + "members": { + "vulnerabilityId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The vulnerability Id for this set of counts.

" + } + }, + "severityCounts": { + "target": "com.amazonaws.imagebuilder#SeverityCounts", + "traits": { + "smithy.api#documentation": "

Counts by severity level for medium severity and higher level findings, plus a total\n\t\t\tfor all of the findings for the specified vulnerability.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Includes counts of image and pipeline resource findings by vulnerability.

" + } }, - { - "target": "com.amazonaws.imagebuilder#ListContainerRecipes" + "com.amazonaws.imagebuilder#VulnerabilityIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#VulnerabilityId" + } }, - { - "target": "com.amazonaws.imagebuilder#ListDistributionConfigurations" + "com.amazonaws.imagebuilder#VulnerablePackage": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the vulnerable package.

" + } + }, + "version": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The version of the vulnerable package.

" + } + }, + "sourceLayerHash": { + "target": "com.amazonaws.imagebuilder#SourceLayerHash", + "traits": { + "smithy.api#documentation": "

The source layer hash of the vulnerable package.

" + } + }, + "epoch": { + "target": "com.amazonaws.imagebuilder#PackageEpoch", + "traits": { + "smithy.api#documentation": "

The epoch of the vulnerable package.

" + } + }, + "release": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The release of the vulnerable package.

" + } + }, + "arch": { + "target": "com.amazonaws.imagebuilder#PackageArchitecture", + "traits": { + "smithy.api#documentation": "

The architecture of the vulnerable package.

" + } + }, + "packageManager": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The package manager of the vulnerable package.

" + } + }, + "filePath": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The file path of the vulnerable package.

" + } + }, + "fixedInVersion": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The version of the package that contains the vulnerability fix.

" + } + }, + "remediation": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The code to run in your environment to update packages with a fix available.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a vulnerable package that Amazon Inspector identifies in a finding.

" + } }, - { - "target": "com.amazonaws.imagebuilder#ListImageBuildVersions" + "com.amazonaws.imagebuilder#VulnerablePackageList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#VulnerablePackage" + } }, - { - "target": "com.amazonaws.imagebuilder#ListImagePackages" + "com.amazonaws.imagebuilder#WorkflowBuildVersionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^arn:aws(?:-[a-z]+)*:imagebuilder:[a-z]{2,}(?:-[a-z]+)+-[0-9]+:(?:[0-9]{12}|aws):workflow/(build|test|distribution)/[a-z0-9-_]+/[0-9]+\\.[0-9]+\\.[0-9]+/[0-9]+$" + } }, - { - "target": "com.amazonaws.imagebuilder#ListImagePipelineImages" + "com.amazonaws.imagebuilder#WorkflowExecutionId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^wf-[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}$" + } }, - { - "target": "com.amazonaws.imagebuilder#ListImagePipelines" + "com.amazonaws.imagebuilder#WorkflowExecutionMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } }, - { - "target": "com.amazonaws.imagebuilder#ListImageRecipes" + "com.amazonaws.imagebuilder#WorkflowExecutionMetadata": { + "type": "structure", + "members": { + "workflowBuildVersionArn": { + "target": "com.amazonaws.imagebuilder#WorkflowBuildVersionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the workflow resource build version that ran.

" + } + }, + "workflowExecutionId": { + "target": "com.amazonaws.imagebuilder#WorkflowExecutionId", + "traits": { + "smithy.api#documentation": "

Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a\n\t\t\tworkflow.

" + } + }, + "type": { + "target": "com.amazonaws.imagebuilder#WorkflowType", + "traits": { + "smithy.api#documentation": "

Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.

" + } + }, + "status": { + "target": "com.amazonaws.imagebuilder#WorkflowExecutionStatus", + "traits": { + "smithy.api#documentation": "

The current runtime status for this workflow.

" + } + }, + "message": { + "target": "com.amazonaws.imagebuilder#WorkflowExecutionMessage", + "traits": { + "smithy.api#documentation": "

The runtime output message from the workflow, if applicable.

" + } + }, + "totalStepCount": { + "target": "com.amazonaws.imagebuilder#WorkflowStepCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of steps in the workflow. This should equal the sum of the step\n\t\t\tcounts for steps that succeeded, were skipped, and failed.

" + } + }, + "totalStepsSucceeded": { + "target": "com.amazonaws.imagebuilder#WorkflowStepCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

A runtime count for the number of steps in the workflow that ran successfully.

" + } + }, + "totalStepsFailed": { + "target": "com.amazonaws.imagebuilder#WorkflowStepCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

A runtime count for the number of steps in the workflow that failed.

" + } + }, + "totalStepsSkipped": { + "target": "com.amazonaws.imagebuilder#WorkflowStepCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

A runtime count for the number of steps in the workflow that were skipped.

" + } + }, + "startTime": { + "target": "com.amazonaws.imagebuilder#DateTime", + "traits": { + "smithy.api#documentation": "

The timestamp when the runtime instance of this workflow started.

" + } + }, + "endTime": { + "target": "com.amazonaws.imagebuilder#DateTime", + "traits": { + "smithy.api#documentation": "

The timestamp when this runtime instance of the workflow finished.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Metadata that includes details and status from this runtime instance of the workflow.

" + } }, - { - "target": "com.amazonaws.imagebuilder#ListImages" + "com.amazonaws.imagebuilder#WorkflowExecutionStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "SKIPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SKIPPED" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "ROLLBACK_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLLBACK_IN_PROGRESS" + } + }, + "ROLLBACK_COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLLBACK_COMPLETED" + } + } + } }, - { - "target": "com.amazonaws.imagebuilder#ListImageScanFindingAggregations" + "com.amazonaws.imagebuilder#WorkflowExecutionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#WorkflowExecutionMetadata" + } }, - { - "target": "com.amazonaws.imagebuilder#ListImageScanFindings" + "com.amazonaws.imagebuilder#WorkflowStepAction": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[A-Za-z][A-Za-z0-9-_]{1,99}$" + } }, - { - "target": "com.amazonaws.imagebuilder#ListInfrastructureConfigurations" + "com.amazonaws.imagebuilder#WorkflowStepCount": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } }, - { - "target": "com.amazonaws.imagebuilder#ListTagsForResource" + "com.amazonaws.imagebuilder#WorkflowStepDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } }, - { - "target": "com.amazonaws.imagebuilder#ListWorkflowExecutions" + "com.amazonaws.imagebuilder#WorkflowStepExecutionId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^step-[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}$" + } }, - { - "target": "com.amazonaws.imagebuilder#ListWorkflowStepExecutions" + "com.amazonaws.imagebuilder#WorkflowStepExecutionRollbackStatus": { + "type": "enum", + "members": { + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "SKIPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SKIPPED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } }, - { - "target": "com.amazonaws.imagebuilder#PutComponentPolicy" + "com.amazonaws.imagebuilder#WorkflowStepExecutionStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "SKIPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SKIPPED" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } }, - { - "target": "com.amazonaws.imagebuilder#PutContainerRecipePolicy" + "com.amazonaws.imagebuilder#WorkflowStepExecutionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#WorkflowStepMetadata" + } }, - { - "target": "com.amazonaws.imagebuilder#PutImagePolicy" + "com.amazonaws.imagebuilder#WorkflowStepInputs": { + "type": "string" }, - { - "target": "com.amazonaws.imagebuilder#PutImageRecipePolicy" + "com.amazonaws.imagebuilder#WorkflowStepMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } }, - { - "target": "com.amazonaws.imagebuilder#StartImagePipelineExecution" + "com.amazonaws.imagebuilder#WorkflowStepMetadata": { + "type": "structure", + "members": { + "stepExecutionId": { + "target": "com.amazonaws.imagebuilder#WorkflowStepExecutionId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the workflow step, assigned at runtime.

" + } + }, + "name": { + "target": "com.amazonaws.imagebuilder#WorkflowStepName", + "traits": { + "smithy.api#documentation": "

The name of the workflow step.

" + } + }, + "description": { + "target": "com.amazonaws.imagebuilder#WorkflowStepDescription", + "traits": { + "smithy.api#documentation": "

Description of the workflow step.

" + } + }, + "action": { + "target": "com.amazonaws.imagebuilder#WorkflowStepAction", + "traits": { + "smithy.api#documentation": "

The step action name.

" + } + }, + "status": { + "target": "com.amazonaws.imagebuilder#WorkflowStepExecutionStatus", + "traits": { + "smithy.api#documentation": "

Runtime status for the workflow step.

" + } + }, + "rollbackStatus": { + "target": "com.amazonaws.imagebuilder#WorkflowStepExecutionRollbackStatus", + "traits": { + "smithy.api#documentation": "

Reports on the rollback status of the step, if applicable.

" + } + }, + "message": { + "target": "com.amazonaws.imagebuilder#WorkflowStepMessage", + "traits": { + "smithy.api#documentation": "

Detailed output message that the workflow step provides at runtime.

" + } + }, + "inputs": { + "target": "com.amazonaws.imagebuilder#WorkflowStepInputs", + "traits": { + "smithy.api#documentation": "

Input parameters that Image Builder provides for the workflow step.

" + } + }, + "outputs": { + "target": "com.amazonaws.imagebuilder#WorkflowStepOutputs", + "traits": { + "smithy.api#documentation": "

The file names that the workflow step created as output for this runtime instance of the workflow.

" + } + }, + "startTime": { + "target": "com.amazonaws.imagebuilder#DateTime", + "traits": { + "smithy.api#documentation": "

The timestamp when the workflow step started.

" + } + }, + "endTime": { + "target": "com.amazonaws.imagebuilder#DateTime", + "traits": { + "smithy.api#documentation": "

The timestamp when the workflow step finished.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Runtime details and status for the workflow step.

" + } }, - { - "target": "com.amazonaws.imagebuilder#TagResource" + "com.amazonaws.imagebuilder#WorkflowStepName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[A-Za-z][A-Za-z0-9-_]{1,99}$" + } }, - { - "target": "com.amazonaws.imagebuilder#UntagResource" + "com.amazonaws.imagebuilder#WorkflowStepOutputs": { + "type": "string" }, - { - "target": "com.amazonaws.imagebuilder#UpdateDistributionConfiguration" + "com.amazonaws.imagebuilder#WorkflowStepTimeoutSecondsInteger": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 43200 + } + } }, - { - "target": "com.amazonaws.imagebuilder#UpdateImagePipeline" + "com.amazonaws.imagebuilder#WorkflowType": { + "type": "enum", + "members": { + "BUILD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BUILD" + } + }, + "TEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEST" + } + }, + "DISTRIBUTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISTRIBUTION" + } + } + } }, - { - "target": "com.amazonaws.imagebuilder#UpdateInfrastructureConfiguration" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "imagebuilder", - "arnNamespace": "imagebuilder", - "cloudFormationName": "Imagebuilder", - "cloudTrailEventSource": "imagebuilder.amazonaws.com", - "endpointPrefix": "imagebuilder" - }, - "aws.auth#sigv4": { - "name": "imagebuilder" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

EC2 Image Builder is a fully managed Amazon Web Services service that makes it easier to automate the\n\t\t\tcreation, management, and deployment of customized, secure, and up-to-date\n\t\t\t\"golden\" server images that are pre-installed and pre-configured with software\n\t\t\tand settings to meet specific IT standards.

", - "smithy.api#title": "EC2 Image Builder", - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ + "com.amazonaws.imagebuilder#imagebuilder": { + "type": "service", + "version": "2019-12-02", + "operations": [ + { + "target": "com.amazonaws.imagebuilder#CancelImageCreation" + }, + { + "target": "com.amazonaws.imagebuilder#CreateComponent" + }, + { + "target": "com.amazonaws.imagebuilder#CreateContainerRecipe" + }, + { + "target": "com.amazonaws.imagebuilder#CreateDistributionConfiguration" + }, + { + "target": "com.amazonaws.imagebuilder#CreateImage" + }, + { + "target": "com.amazonaws.imagebuilder#CreateImagePipeline" + }, + { + "target": "com.amazonaws.imagebuilder#CreateImageRecipe" + }, + { + "target": "com.amazonaws.imagebuilder#CreateInfrastructureConfiguration" + }, + { + "target": "com.amazonaws.imagebuilder#DeleteComponent" + }, + { + "target": "com.amazonaws.imagebuilder#DeleteContainerRecipe" + }, + { + "target": "com.amazonaws.imagebuilder#DeleteDistributionConfiguration" + }, + { + "target": "com.amazonaws.imagebuilder#DeleteImage" + }, + { + "target": "com.amazonaws.imagebuilder#DeleteImagePipeline" + }, + { + "target": "com.amazonaws.imagebuilder#DeleteImageRecipe" + }, + { + "target": "com.amazonaws.imagebuilder#DeleteInfrastructureConfiguration" + }, + { + "target": "com.amazonaws.imagebuilder#GetComponent" + }, + { + "target": "com.amazonaws.imagebuilder#GetComponentPolicy" + }, + { + "target": "com.amazonaws.imagebuilder#GetContainerRecipe" + }, + { + "target": "com.amazonaws.imagebuilder#GetContainerRecipePolicy" + }, + { + "target": "com.amazonaws.imagebuilder#GetDistributionConfiguration" + }, + { + "target": "com.amazonaws.imagebuilder#GetImage" + }, + { + "target": "com.amazonaws.imagebuilder#GetImagePipeline" + }, + { + "target": "com.amazonaws.imagebuilder#GetImagePolicy" + }, + { + "target": "com.amazonaws.imagebuilder#GetImageRecipe" + }, + { + "target": "com.amazonaws.imagebuilder#GetImageRecipePolicy" + }, + { + "target": "com.amazonaws.imagebuilder#GetInfrastructureConfiguration" + }, + { + "target": "com.amazonaws.imagebuilder#GetWorkflowExecution" + }, + { + "target": "com.amazonaws.imagebuilder#GetWorkflowStepExecution" + }, + { + "target": "com.amazonaws.imagebuilder#ImportComponent" + }, + { + "target": "com.amazonaws.imagebuilder#ImportVmImage" + }, + { + "target": "com.amazonaws.imagebuilder#ListComponentBuildVersions" + }, + { + "target": "com.amazonaws.imagebuilder#ListComponents" + }, + { + "target": "com.amazonaws.imagebuilder#ListContainerRecipes" + }, + { + "target": "com.amazonaws.imagebuilder#ListDistributionConfigurations" + }, + { + "target": "com.amazonaws.imagebuilder#ListImageBuildVersions" + }, + { + "target": "com.amazonaws.imagebuilder#ListImagePackages" + }, + { + "target": "com.amazonaws.imagebuilder#ListImagePipelineImages" + }, + { + "target": "com.amazonaws.imagebuilder#ListImagePipelines" + }, + { + "target": "com.amazonaws.imagebuilder#ListImageRecipes" + }, + { + "target": "com.amazonaws.imagebuilder#ListImages" + }, + { + "target": "com.amazonaws.imagebuilder#ListImageScanFindingAggregations" + }, + { + "target": "com.amazonaws.imagebuilder#ListImageScanFindings" + }, + { + "target": "com.amazonaws.imagebuilder#ListInfrastructureConfigurations" + }, + { + "target": "com.amazonaws.imagebuilder#ListTagsForResource" + }, + { + "target": "com.amazonaws.imagebuilder#ListWorkflowExecutions" + }, + { + "target": "com.amazonaws.imagebuilder#ListWorkflowStepExecutions" + }, { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "type": "tree", - "rules": [ + "target": "com.amazonaws.imagebuilder#PutComponentPolicy" + }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" + "target": "com.amazonaws.imagebuilder#PutContainerRecipePolicy" }, { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + "target": "com.amazonaws.imagebuilder#PutImagePolicy" + }, + { + "target": "com.amazonaws.imagebuilder#PutImageRecipePolicy" + }, + { + "target": "com.amazonaws.imagebuilder#StartImagePipelineExecution" + }, + { + "target": "com.amazonaws.imagebuilder#TagResource" + }, + { + "target": "com.amazonaws.imagebuilder#UntagResource" + }, + { + "target": "com.amazonaws.imagebuilder#UpdateDistributionConfiguration" + }, + { + "target": "com.amazonaws.imagebuilder#UpdateImagePipeline" + }, + { + "target": "com.amazonaws.imagebuilder#UpdateInfrastructureConfiguration" } - ] - }, - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" + ], + "traits": { + "aws.api#service": { + "sdkId": "imagebuilder", + "arnNamespace": "imagebuilder", + "cloudFormationName": "Imagebuilder", + "cloudTrailEventSource": "imagebuilder.amazonaws.com", + "endpointPrefix": "imagebuilder" + }, + "aws.auth#sigv4": { + "name": "imagebuilder" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

EC2 Image Builder is a fully managed Amazon Web Services service that makes it easier to automate the\n\t\t\tcreation, management, and deployment of customized, secure, and up-to-date\n\t\t\t\"golden\" server images that are pre-installed and pre-configured with software\n\t\t\tand settings to meet specific IT standards.

", + "smithy.api#title": "EC2 Image Builder", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" } - ], - "type": "tree", - "rules": [ + }, + "rules": [ { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ + "conditions": [ { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ + "conditions": [ { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" }, { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ + "conditions": [], + "type": "tree", + "rules": [ { - "ref": "PartitionResult" + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://imagebuilder-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] + ] }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ + "conditions": [], + "type": "tree", + "rules": [ { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ + "conditions": [ { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ { - "fn": "stringEquals", - "argv": [ - "aws-us-gov", - { - "fn": "getAttr", - "argv": [ + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://imagebuilder-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws-us-gov", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://imagebuilder.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://imagebuilder-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, { - "ref": "PartitionResult" + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://imagebuilder.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] }, - "name" - ] - } - ] + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://imagebuilder.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] } - ], - "endpoint": { - "url": "https://imagebuilder.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://imagebuilder-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://imagebuilder-fips.us-east-1.api.aws" } - ] }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true } - ] }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://imagebuilder-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://imagebuilder.us-east-1.api.aws" } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://imagebuilder.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://imagebuilder.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://imagebuilder-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://imagebuilder-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://imagebuilder.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://imagebuilder.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://imagebuilder.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://imagebuilder.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://imagebuilder.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://imagebuilder.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://imagebuilder-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://imagebuilder.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://imagebuilder-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://imagebuilder.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://imagebuilder-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://imagebuilder.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" } - ] }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" } - ] }, { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://imagebuilder.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" } - ] } - ] - } - ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" + ], + "version": "1.0" } - ] - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://imagebuilder-fips.us-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "us-east-1" - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://imagebuilder-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "us-east-1" - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://imagebuilder.us-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "us-east-1" - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://imagebuilder.us-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "us-east-1" - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://imagebuilder-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "cn-north-1" - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://imagebuilder-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "cn-north-1" - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://imagebuilder.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "cn-north-1" - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://imagebuilder.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "cn-north-1" - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://imagebuilder.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "us-gov-east-1" - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://imagebuilder.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "us-gov-east-1" - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://imagebuilder.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "us-gov-west-1" - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://imagebuilder.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "us-gov-west-1" - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://imagebuilder-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "us-gov-east-1" - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://imagebuilder.us-gov-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "us-gov-east-1" - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "us-iso-east-1" - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://imagebuilder-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "us-iso-east-1" - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "us-iso-east-1" - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://imagebuilder.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "us-iso-east-1" - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "us-isob-east-1" - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://imagebuilder-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "us-isob-east-1" - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "us-isob-east-1" - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://imagebuilder.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "us-isob-east-1" - } - }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "us-east-1", - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "us-east-1", - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "us-east-1", - "Endpoint": "https://example.com" - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } } - ], - "version": "1.0" } - } } - } } diff --git a/codegen/sdk-codegen/aws-models/lightsail.json b/codegen/sdk-codegen/aws-models/lightsail.json index cabb62c27c45..6aa25950b36a 100644 --- a/codegen/sdk-codegen/aws-models/lightsail.json +++ b/codegen/sdk-codegen/aws-models/lightsail.json @@ -1,22492 +1,23031 @@ { - "smithy": "2.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] - }, - "shapes": { - "com.amazonaws.lightsail#AccessDeniedException": { - "type": "structure", - "members": { - "code": { - "target": "com.amazonaws.lightsail#string" - }, - "docs": { - "target": "com.amazonaws.lightsail#string" - }, - "message": { - "target": "com.amazonaws.lightsail#string" - }, - "tip": { - "target": "com.amazonaws.lightsail#string" - } - }, - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.lightsail#AccessDirection": { - "type": "enum", - "members": { - "inbound": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "inbound" - } - }, - "outbound": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "outbound" - } - } - } - }, - "com.amazonaws.lightsail#AccessKey": { - "type": "structure", - "members": { - "accessKeyId": { - "target": "com.amazonaws.lightsail#IAMAccessKeyId", - "traits": { - "smithy.api#documentation": "

The ID of the access key.

" - } - }, - "secretAccessKey": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The secret access key used to sign requests.

\n

You should store the secret access key in a safe location. We recommend that you delete\n the access key if the secret access key is compromised.

" - } - }, - "status": { - "target": "com.amazonaws.lightsail#StatusType", - "traits": { - "smithy.api#documentation": "

The status of the access key.

\n

A status of Active means that the key is valid, while Inactive\n means it is not.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the access key was created.

" - } - }, - "lastUsed": { - "target": "com.amazonaws.lightsail#AccessKeyLastUsed", - "traits": { - "smithy.api#documentation": "

An object that describes the last time the access key was used.

\n \n

This object does not include data in the response of a CreateBucketAccessKey action. If the access key has not been used, the\n region and serviceName values are N/A, and the\n lastUsedDate value is null.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an access key for an Amazon Lightsail bucket.

\n

Access keys grant full programmatic access to the specified bucket and its objects. You\n can have a maximum of two access keys per bucket. Use the CreateBucketAccessKey action to create an access key for a specific bucket. For\n more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

\n \n

The secretAccessKey value is returned only in response to the\n CreateBucketAccessKey action. You can get a secret access key only when you\n first create an access key; you cannot get the secret access key later. If you lose the\n secret access key, you must create a new access key.

\n " - } - }, - "com.amazonaws.lightsail#AccessKeyLastUsed": { - "type": "structure", - "members": { - "lastUsedDate": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The date and time when the access key was most recently used.

\n

This value is null if the access key has not been used.

" - } - }, - "region": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region where this access key was most recently used.

\n

This value is N/A if the access key has not been used.

" - } - }, - "serviceName": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The name of the Amazon Web Services service with which this access key was most recently\n used.

\n

This value is N/A if the access key has not been used.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the last time an access key was used.

\n \n

This object does not include data in the response of a CreateBucketAccessKey action.

\n " - } - }, - "com.amazonaws.lightsail#AccessKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#AccessKey" - } - }, - "com.amazonaws.lightsail#AccessReceiverList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#ResourceReceivingAccess" - } - }, - "com.amazonaws.lightsail#AccessRules": { - "type": "structure", - "members": { - "getObject": { - "target": "com.amazonaws.lightsail#AccessType", - "traits": { - "smithy.api#documentation": "

Specifies the anonymous access to all objects in a bucket.

\n

The following options can be specified:

\n " - } - }, - "allowPublicOverrides": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value that indicates whether the access control list (ACL) permissions that are\n applied to individual objects override the getObject option that is currently\n specified.

\n

When this is true, you can use the PutObjectAcl Amazon S3 API action to set\n individual objects to public (read-only) using the public-read ACL, or to private\n using the private ACL.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the anonymous access permissions for an Amazon Lightsail bucket and its\n objects.

\n

For more information about bucket access permissions, see Understanding bucket permissions in Amazon Lightsail in the

\n

\n Amazon Lightsail Developer Guide.

" - } - }, - "com.amazonaws.lightsail#AccessType": { - "type": "enum", - "members": { - "Public": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "public" - } - }, - "Private": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "private" - } - } - } - }, - "com.amazonaws.lightsail#AccountLevelBpaSync": { - "type": "structure", - "members": { - "status": { - "target": "com.amazonaws.lightsail#AccountLevelBpaSyncStatus", - "traits": { - "smithy.api#documentation": "

The status of the account-level BPA synchronization.

\n

The following statuses are possible:

\n \n \n

You might need to complete further actions if the status is Failed or\n Defaulted. The message parameter provides more information for\n those statuses.

\n " - } - }, - "lastSyncedAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp of when the account-level BPA configuration was last synchronized. This\n value is null when the account-level BPA configuration has not been synchronized.

" - } - }, - "message": { - "target": "com.amazonaws.lightsail#BPAStatusMessage", - "traits": { - "smithy.api#documentation": "

A message that provides a reason for a Failed or Defaulted\n synchronization status.

\n

The following messages are possible:

\n " - } - }, - "bpaImpactsLightsail": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value that indicates whether account-level block public access is affecting your\n Lightsail buckets.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the synchronization status of the Amazon Simple Storage Service (Amazon S3)\n account-level block public access (BPA) feature for your Lightsail buckets.

\n

The account-level BPA feature of Amazon S3 provides centralized controls to limit\n public access to all Amazon S3 buckets in an account. BPA can make all Amazon S3 buckets in an Amazon Web Services account private regardless of the individual bucket and\n object permissions that are configured. Lightsail buckets take into account the\n Amazon S3 account-level BPA configuration when allowing or denying public access. To\n do this, Lightsail periodically fetches the account-level BPA configuration\n from Amazon S3. When the account-level BPA status is InSync, the Amazon S3 account-level BPA configuration is synchronized and it applies to your Lightsail\n buckets. For more information about Amazon Simple Storage Service account-level BPA and how it affects\n Lightsail buckets, see Block public access for buckets in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

" - } - }, - "com.amazonaws.lightsail#AccountLevelBpaSyncStatus": { - "type": "enum", - "members": { - "InSync": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InSync" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "NeverSynced": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NeverSynced" - } - }, - "Defaulted": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Defaulted" - } - } - } - }, - "com.amazonaws.lightsail#AccountSetupInProgressException": { - "type": "structure", - "members": { - "code": { - "target": "com.amazonaws.lightsail#string" + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.lightsail#AccessDeniedException": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.lightsail#string" + }, + "docs": { + "target": "com.amazonaws.lightsail#string" + }, + "message": { + "target": "com.amazonaws.lightsail#string" + }, + "tip": { + "target": "com.amazonaws.lightsail#string" + } + }, + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } }, - "docs": { - "target": "com.amazonaws.lightsail#string" + "com.amazonaws.lightsail#AccessDirection": { + "type": "enum", + "members": { + "inbound": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inbound" + } + }, + "outbound": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "outbound" + } + } + } }, - "message": { - "target": "com.amazonaws.lightsail#string" + "com.amazonaws.lightsail#AccessKey": { + "type": "structure", + "members": { + "accessKeyId": { + "target": "com.amazonaws.lightsail#IAMAccessKeyId", + "traits": { + "smithy.api#documentation": "

The ID of the access key.

" + } + }, + "secretAccessKey": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The secret access key used to sign requests.

\n

You should store the secret access key in a safe location. We recommend that you delete\n the access key if the secret access key is compromised.

" + } + }, + "status": { + "target": "com.amazonaws.lightsail#StatusType", + "traits": { + "smithy.api#documentation": "

The status of the access key.

\n

A status of Active means that the key is valid, while Inactive\n means it is not.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the access key was created.

" + } + }, + "lastUsed": { + "target": "com.amazonaws.lightsail#AccessKeyLastUsed", + "traits": { + "smithy.api#documentation": "

An object that describes the last time the access key was used.

\n \n

This object does not include data in the response of a CreateBucketAccessKey action. If the access key has not been used, the\n region and serviceName values are N/A, and the\n lastUsedDate value is null.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an access key for an Amazon Lightsail bucket.

\n

Access keys grant full programmatic access to the specified bucket and its objects. You\n can have a maximum of two access keys per bucket. Use the CreateBucketAccessKey action to create an access key for a specific bucket. For\n more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

\n \n

The secretAccessKey value is returned only in response to the\n CreateBucketAccessKey action. You can get a secret access key only when you\n first create an access key; you cannot get the secret access key later. If you lose the\n secret access key, you must create a new access key.

\n " + } }, - "tip": { - "target": "com.amazonaws.lightsail#string" - } - }, - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#error": "client", - "smithy.api#httpError": 428 - } - }, - "com.amazonaws.lightsail#AddOn": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The name of the add-on.

" - } - }, - "status": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The status of the add-on.

" - } - }, - "snapshotTimeOfDay": { - "target": "com.amazonaws.lightsail#TimeOfDay", - "traits": { - "smithy.api#documentation": "

The daily time when an automatic snapshot is created.

\n

The time shown is in HH:00 format, and in Coordinated Universal Time\n (UTC).

\n

The snapshot is automatically created between the time shown and up to 45 minutes\n after.

" - } - }, - "nextSnapshotTimeOfDay": { - "target": "com.amazonaws.lightsail#TimeOfDay", - "traits": { - "smithy.api#documentation": "

The next daily time an automatic snapshot will be created.

\n

The time shown is in HH:00 format, and in Coordinated Universal Time\n (UTC).

\n

The snapshot is automatically created between the time shown and up to 45 minutes\n after.

" - } - }, - "threshold": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The trigger threshold of the action.

\n \n

This add-on only applies to Lightsail for Research resources.

\n " - } - }, - "duration": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The amount of idle time in minutes after which your virtual computer will automatically stop.

\n \n

This add-on only applies to Lightsail for Research resources.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an add-on that is enabled for an Amazon Lightsail resource.

" - } - }, - "com.amazonaws.lightsail#AddOnList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#AddOn" - } - }, - "com.amazonaws.lightsail#AddOnRequest": { - "type": "structure", - "members": { - "addOnType": { - "target": "com.amazonaws.lightsail#AddOnType", - "traits": { - "smithy.api#documentation": "

The add-on type.

", - "smithy.api#required": {} - } - }, - "autoSnapshotAddOnRequest": { - "target": "com.amazonaws.lightsail#AutoSnapshotAddOnRequest", - "traits": { - "smithy.api#documentation": "

An object that represents additional parameters when enabling or modifying the automatic\n snapshot add-on.

" - } - }, - "stopInstanceOnIdleRequest": { - "target": "com.amazonaws.lightsail#StopInstanceOnIdleRequest", - "traits": { - "smithy.api#documentation": "

An object that represents additional parameters when enabling or modifying the\n StopInstanceOnIdle add-on.

\n \n

This object only applies to Lightsail for Research resources.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a request to enable, modify, or disable an add-on for an Amazon Lightsail\n resource.

\n \n

An additional cost may be associated with enabling add-ons. For more information, see\n the Lightsail pricing\n page.

\n " - } - }, - "com.amazonaws.lightsail#AddOnRequestList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#AddOnRequest" - } - }, - "com.amazonaws.lightsail#AddOnType": { - "type": "enum", - "members": { - "AutoSnapshot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AutoSnapshot" - } - }, - "StopInstanceOnIdle": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "StopInstanceOnIdle" - } - } - } - }, - "com.amazonaws.lightsail#Alarm": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the alarm.

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the alarm.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the alarm was created.

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

An object that lists information about the location of the alarm.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The Lightsail resource type (e.g., Alarm).

" - } - }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail alarm. This code enables our support team to look up your Lightsail\n information more easily.

" - } - }, - "monitoredResourceInfo": { - "target": "com.amazonaws.lightsail#MonitoredResourceInfo", - "traits": { - "smithy.api#documentation": "

An object that lists information about the resource monitored by the alarm.

" - } - }, - "comparisonOperator": { - "target": "com.amazonaws.lightsail#ComparisonOperator", - "traits": { - "smithy.api#documentation": "

The arithmetic operation used when comparing the specified statistic and threshold.

" - } - }, - "evaluationPeriods": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The number of periods over which data is compared to the specified threshold.

" - } - }, - "period": { - "target": "com.amazonaws.lightsail#MetricPeriod", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The period, in seconds, over which the statistic is applied.

" - } - }, - "threshold": { - "target": "com.amazonaws.lightsail#double", - "traits": { - "smithy.api#documentation": "

The value against which the specified statistic is compared.

" - } - }, - "datapointsToAlarm": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The number of data points that must not within the specified threshold to trigger the\n alarm.

" - } - }, - "treatMissingData": { - "target": "com.amazonaws.lightsail#TreatMissingData", - "traits": { - "smithy.api#documentation": "

Specifies how the alarm handles missing data points.

\n

An alarm can treat missing data in the following ways:

\n " - } - }, - "statistic": { - "target": "com.amazonaws.lightsail#MetricStatistic", - "traits": { - "smithy.api#documentation": "

The statistic for the metric associated with the alarm.

\n

The following statistics are available:

\n " - } - }, - "metricName": { - "target": "com.amazonaws.lightsail#MetricName", - "traits": { - "smithy.api#documentation": "

The name of the metric associated with the alarm.

" - } - }, - "state": { - "target": "com.amazonaws.lightsail#AlarmState", - "traits": { - "smithy.api#documentation": "

The current state of the alarm.

\n

An alarm has the following possible states:

\n " - } - }, - "unit": { - "target": "com.amazonaws.lightsail#MetricUnit", - "traits": { - "smithy.api#documentation": "

The unit of the metric associated with the alarm.

" - } - }, - "contactProtocols": { - "target": "com.amazonaws.lightsail#ContactProtocolsList", - "traits": { - "smithy.api#documentation": "

The contact protocols for the alarm, such as Email, SMS (text\n messaging), or both.

" - } - }, - "notificationTriggers": { - "target": "com.amazonaws.lightsail#NotificationTriggerList", - "traits": { - "smithy.api#documentation": "

The alarm states that trigger a notification.

" - } - }, - "notificationEnabled": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether the alarm is enabled.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an alarm.

\n

An alarm is a way to monitor your Lightsail resource metrics. For more information, see\n Alarms in Amazon Lightsail.

" - } - }, - "com.amazonaws.lightsail#AlarmState": { - "type": "enum", - "members": { - "OK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OK" - } - }, - "ALARM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALARM" - } - }, - "INSUFFICIENT_DATA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INSUFFICIENT_DATA" - } - } - } - }, - "com.amazonaws.lightsail#AlarmsList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#Alarm" - } - }, - "com.amazonaws.lightsail#AllocateStaticIp": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#AllocateStaticIpRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#AllocateStaticIpResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Allocates a static IP address.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/AllocateStaticIp", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#AllocateStaticIpRequest": { - "type": "structure", - "members": { - "staticIpName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the static IP address.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#AllocateStaticIpResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#AppCategory": { - "type": "enum", - "members": { - "LfR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LfR" - } - } - } - }, - "com.amazonaws.lightsail#AppCategoryList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#AppCategory" - } - }, - "com.amazonaws.lightsail#AttachCertificateToDistribution": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#AttachCertificateToDistributionRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#AttachCertificateToDistributionResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN)\n distribution.

\n

After the certificate is attached, your distribution accepts HTTPS traffic for all of the\n domains that are associated with the certificate.

\n

Use the CreateCertificate action to create a certificate that you can attach\n to your distribution.

\n \n

Only certificates created in the us-east-1\n Amazon Web Services Region can be attached to Lightsail distributions. Lightsail\n distributions are global resources that can reference an origin in any Amazon Web Services\n Region, and distribute its content globally. However, all distributions are located in the\n us-east-1 Region.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/AttachCertificateToDistribution", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#AttachCertificateToDistributionRequest": { - "type": "structure", - "members": { - "distributionName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the distribution that the certificate will be attached to.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

", - "smithy.api#required": {} - } - }, - "certificateName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the certificate to attach to a distribution.

\n

Only certificates with a status of ISSUED can be attached to a\n distribution.

\n

Use the GetCertificates action to get a list of certificate names that you\n can specify.

\n \n

This is the name of the certificate resource type and is used only to reference the\n certificate in other API actions. It can be different than the domain name of the\n certificate. For example, your certificate name might be\n WordPress-Blog-Certificate and the domain name of the certificate might be\n example.com.

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#AttachCertificateToDistributionResult": { - "type": "structure", - "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An object that describes the result of the action, such as the status of the request, the\n timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#AttachDisk": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#AttachDiskRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#AttachDiskResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Attaches a block storage disk to a running or stopped Lightsail instance and exposes it\n to the instance with the specified disk name.

\n

The attach disk operation supports tag-based access control via resource tags\n applied to the resource identified by disk name. For more information, see the\n Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/AttachDisk", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#AttachDiskRequest": { - "type": "structure", - "members": { - "diskName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The unique Lightsail disk name (e.g., my-disk).

", - "smithy.api#required": {} - } - }, - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the Lightsail instance where you want to utilize the storage disk.

", - "smithy.api#required": {} - } - }, - "diskPath": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The disk path to expose to the instance (e.g., /dev/xvdf).

", - "smithy.api#required": {} - } - }, - "autoMounting": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value used to determine the automatic mounting of a storage volume to a virtual\n computer. The default value is False.

\n \n

This value only applies to Lightsail for Research resources.

\n " - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#AttachDiskResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#AttachInstancesToLoadBalancer": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#AttachInstancesToLoadBalancerRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#AttachInstancesToLoadBalancerResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Attaches one or more Lightsail instances to a load balancer.

\n

After some time, the instances are attached to the load balancer and the health check\n status is available.

\n

The attach instances to load balancer operation supports tag-based access\n control via resource tags applied to the resource identified by load balancer\n name. For more information, see the Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/AttachInstancesToLoadBalancer", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#AttachInstancesToLoadBalancerRequest": { - "type": "structure", - "members": { - "loadBalancerName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the load balancer.

", - "smithy.api#required": {} - } - }, - "instanceNames": { - "target": "com.amazonaws.lightsail#ResourceNameList", - "traits": { - "smithy.api#documentation": "

An array of strings representing the instance name(s) you want to attach to your load\n balancer.

\n

An instance must be running before you can attach it to your load\n balancer.

\n

There are no additional limits on the number of instances you can attach to your load\n balancer, aside from the limit of Lightsail instances you can create in your account\n (20).

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#AttachInstancesToLoadBalancerResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#AttachLoadBalancerTlsCertificate": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#AttachLoadBalancerTlsCertificateRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#AttachLoadBalancerTlsCertificateResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just\n an updated, more secure version of Secure Socket Layer (SSL).

\n

Once you create and validate your certificate, you can attach it to your load balancer.\n You can also use this API to rotate the certificates on your account. Use the\n AttachLoadBalancerTlsCertificate action with the non-attached certificate, and\n it will replace the existing one and become the attached certificate.

\n

The AttachLoadBalancerTlsCertificate operation supports tag-based access\n control via resource tags applied to the resource identified by load balancer\n name. For more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/AttachLoadBalancerTlsCertificate", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#AttachLoadBalancerTlsCertificateRequest": { - "type": "structure", - "members": { - "loadBalancerName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the load balancer to which you want to associate the SSL/TLS\n certificate.

", - "smithy.api#required": {} - } - }, - "certificateName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of your SSL/TLS certificate.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#AttachLoadBalancerTlsCertificateResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

\n

These SSL/TLS certificates are only usable by Lightsail load balancers. You can't get\n the certificate and use it for another purpose.

" - } - } - } - }, - "com.amazonaws.lightsail#AttachStaticIp": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#AttachStaticIpRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#AttachStaticIpResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/AttachStaticIp", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#AttachStaticIpRequest": { - "type": "structure", - "members": { - "staticIpName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the static IP.

", - "smithy.api#required": {} - } - }, - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#AttachStaticIpResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#AttachedDisk": { - "type": "structure", - "members": { - "path": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The path of the disk (e.g., /dev/xvdf).

" - } - }, - "sizeInGb": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The size of the disk in GB.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a block storage disk that is attached to an instance, and is included in an\n automatic snapshot.

" - } - }, - "com.amazonaws.lightsail#AttachedDiskList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#AttachedDisk" - } - }, - "com.amazonaws.lightsail#AttachedDiskMap": { - "type": "map", - "key": { - "target": "com.amazonaws.lightsail#ResourceName" - }, - "value": { - "target": "com.amazonaws.lightsail#DiskMapList" - } - }, - "com.amazonaws.lightsail#AutoMountStatus": { - "type": "enum", - "members": { - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "Pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Pending" - } - }, - "Mounted": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Mounted" - } - }, - "NotMounted": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NotMounted" - } - } - } - }, - "com.amazonaws.lightsail#AutoSnapshotAddOnRequest": { - "type": "structure", - "members": { - "snapshotTimeOfDay": { - "target": "com.amazonaws.lightsail#TimeOfDay", - "traits": { - "smithy.api#documentation": "

The daily time when an automatic snapshot will be created.

\n

Constraints:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a request to enable or modify the automatic snapshot add-on for an\n Amazon Lightsail instance or disk.

\n

When you modify the automatic snapshot time for a resource, it is typically effective\n immediately except under the following conditions:

\n " - } - }, - "com.amazonaws.lightsail#AutoSnapshotDate": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" - } - }, - "com.amazonaws.lightsail#AutoSnapshotDetails": { - "type": "structure", - "members": { - "date": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The date of the automatic snapshot in YYYY-MM-DD format.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the automatic snapshot was created.

" - } - }, - "status": { - "target": "com.amazonaws.lightsail#AutoSnapshotStatus", - "traits": { - "smithy.api#documentation": "

The status of the automatic snapshot.

" - } - }, - "fromAttachedDisks": { - "target": "com.amazonaws.lightsail#AttachedDiskList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the block storage disks attached to the instance when\n the automatic snapshot was created.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an automatic snapshot.

" - } - }, - "com.amazonaws.lightsail#AutoSnapshotDetailsList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#AutoSnapshotDetails" - } - }, - "com.amazonaws.lightsail#AutoSnapshotStatus": { - "type": "enum", - "members": { - "SUCCESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Success" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InProgress" - } - }, - "NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NotFound" - } - } - } - }, - "com.amazonaws.lightsail#AvailabilityZone": { - "type": "structure", - "members": { - "zoneName": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the Availability Zone. The format is us-east-2a\n (case-sensitive).

" - } - }, - "state": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The state of the Availability Zone.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an Availability Zone. This is returned only as part of a GetRegions\n request.

" - } - }, - "com.amazonaws.lightsail#AvailabilityZoneList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#AvailabilityZone" - } - }, - "com.amazonaws.lightsail#BPAStatusMessage": { - "type": "enum", - "members": { - "DEFAULTED_FOR_SLR_MISSING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DEFAULTED_FOR_SLR_MISSING" - } - }, - "SYNC_ON_HOLD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SYNC_ON_HOLD" - } - }, - "DEFAULTED_FOR_SLR_MISSING_ON_HOLD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DEFAULTED_FOR_SLR_MISSING_ON_HOLD" - } - }, - "Unknown": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Unknown" - } - } - } - }, - "com.amazonaws.lightsail#Base64": { - "type": "string" - }, - "com.amazonaws.lightsail#BehaviorEnum": { - "type": "enum", - "members": { - "DontCacheSetting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "dont-cache" - } - }, - "CacheSetting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cache" - } - } - } - }, - "com.amazonaws.lightsail#Blueprint": { - "type": "structure", - "members": { - "blueprintId": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "group": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "type": { - "target": "com.amazonaws.lightsail#BlueprintType", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "description": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The description of the blueprint.

" - } - }, - "isActive": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the blueprint is active. Inactive blueprints are listed\n to support customers with existing instances but are not necessarily available for launch of\n new instances. Blueprints are marked inactive when they become outdated due to operating\n system updates or new application releases.

" - } - }, - "minPower": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The minimum bundle power required to run this blueprint. For example, you need a bundle\n with a power value of 500 or more to create an instance that uses a blueprint with a minimum\n power value of 500. 0 indicates that the blueprint runs on all instance sizes.\n

" - } - }, - "version": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "versionCode": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The version code.

" - } - }, - "productUrl": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "licenseUrl": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "platform": { - "target": "com.amazonaws.lightsail#InstancePlatform", - "traits": { - "smithy.api#documentation": "

The operating system platform (either Linux/Unix-based or Windows Server-based) of the\n blueprint.

" - } - }, - "appCategory": { - "target": "com.amazonaws.lightsail#AppCategory", - "traits": { - "smithy.api#documentation": "

Virtual computer blueprints that are supported by Lightsail for Research.

\n \n

This parameter only applies to Lightsail for Research resources.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a blueprint (a virtual private server image).

" - } - }, - "com.amazonaws.lightsail#BlueprintList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#Blueprint" - } - }, - "com.amazonaws.lightsail#BlueprintType": { - "type": "enum", - "members": { - "os": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "os" - } - }, - "app": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "app" - } - } - } - }, - "com.amazonaws.lightsail#Bucket": { - "type": "structure", - "members": { - "resourceType": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Lightsail resource type of the bucket (for example, Bucket).

" - } - }, - "accessRules": { - "target": "com.amazonaws.lightsail#AccessRules", - "traits": { - "smithy.api#documentation": "

An object that describes the access rules of the bucket.

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the bucket.

" - } - }, - "bundleId": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the bundle currently applied to the bucket.

\n

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a\n bucket.

\n

Use the UpdateBucketBundle action to change the\n bundle of a bucket.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the distribution was created.

" - } - }, - "url": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The URL of the bucket.

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

An object that describes the location of the bucket, such as the Amazon Web Services Region\n and Availability Zone.

" - } - }, - "name": { - "target": "com.amazonaws.lightsail#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket.

" - } - }, - "supportCode": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The support code for a bucket. Include this code in your email to support when you have\n questions about a Lightsail bucket. This code enables our support team to look up your\n Lightsail information more easily.

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the bucket. For more information, see Tags in\n Amazon Lightsail in the Amazon Lightsail Developer Guide.

" - } - }, - "objectVersioning": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates whether object versioning is enabled for the bucket.

\n

The following options can be configured:

\n " - } - }, - "ableToUpdateBundle": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether the bundle that is currently applied to a bucket can be changed to\n another bundle.

\n

You can update a bucket's bundle only one time within a monthly Amazon Web Services billing\n cycle.

\n

Use the UpdateBucketBundle action to change a\n bucket's bundle.

" - } - }, - "readonlyAccessAccounts": { - "target": "com.amazonaws.lightsail#PartnerIdList", - "traits": { - "smithy.api#documentation": "

An array of strings that specify the Amazon Web Services account IDs that have read-only\n access to the bucket.

" - } - }, - "resourcesReceivingAccess": { - "target": "com.amazonaws.lightsail#AccessReceiverList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe Lightsail instances that have access to the\n bucket.

\n

Use the SetResourceAccessForBucket\n action to update the instances that have access to a bucket.

" - } - }, - "state": { - "target": "com.amazonaws.lightsail#BucketState", - "traits": { - "smithy.api#documentation": "

An object that describes the state of the bucket.

" - } - }, - "accessLogConfig": { - "target": "com.amazonaws.lightsail#BucketAccessLogConfig", - "traits": { - "smithy.api#documentation": "

An object that describes the access log configuration for the bucket.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an Amazon Lightsail bucket.

" - } - }, - "com.amazonaws.lightsail#BucketAccessLogConfig": { - "type": "structure", - "members": { - "enabled": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value that indicates whether bucket access logging is enabled for the\n bucket.

", - "smithy.api#required": {} - } - }, - "destination": { - "target": "com.amazonaws.lightsail#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket where the access logs are saved. The destination can be a\n Lightsail bucket in the same account, and in the same Amazon Web Services Region as the\n source bucket.

\n \n

This parameter is required when enabling the access log for a bucket, and should be\n omitted when disabling the access log.

\n " - } - }, - "prefix": { - "target": "com.amazonaws.lightsail#BucketAccessLogPrefix", - "traits": { - "smithy.api#documentation": "

The optional object prefix for the bucket access log.

\n

The prefix is an optional addition to the object key that organizes your access log files\n in the destination bucket. For example, if you specify a logs/ prefix, then each\n log object will begin with the logs/ prefix in its key (for example,\n logs/2021-11-01-21-32-16-E568B2907131C0C0).

\n \n

This parameter can be optionally specified when enabling the access log for a bucket,\n and should be omitted when disabling the access log.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the access log configuration for a bucket in the Amazon Lightsail object storage\n service.

\n

For more information about bucket access logs, see Logging bucket requests using access logging in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

" - } - }, - "com.amazonaws.lightsail#BucketAccessLogPrefix": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#pattern": "^[\\w/!.*')(-]+$" - } - }, - "com.amazonaws.lightsail#BucketBundle": { - "type": "structure", - "members": { - "bundleId": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the bundle.

" - } - }, - "name": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the bundle.

" - } - }, - "price": { - "target": "com.amazonaws.lightsail#float", - "traits": { - "smithy.api#documentation": "

The monthly price of the bundle, in US dollars.

" - } - }, - "storagePerMonthInGb": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The storage size of the bundle, in GB.

" - } - }, - "transferPerMonthInGb": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The monthly network transfer quota of the bundle.

" - } - }, - "isActive": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether the bundle is active. Use for a new or existing bucket.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the specifications of a bundle that can be applied to an Amazon Lightsail\n bucket.

\n

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a\n bucket.

" - } - }, - "com.amazonaws.lightsail#BucketBundleList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#BucketBundle" - } - }, - "com.amazonaws.lightsail#BucketList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#Bucket" - } - }, - "com.amazonaws.lightsail#BucketMetricName": { - "type": "enum", - "members": { - "BucketSizeBytes": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BucketSizeBytes" - } - }, - "NumberOfObjects": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NumberOfObjects" - } - } - } - }, - "com.amazonaws.lightsail#BucketName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 54 - }, - "smithy.api#pattern": "^[a-z0-9][a-z0-9-]{1,52}[a-z0-9]$" - } - }, - "com.amazonaws.lightsail#BucketState": { - "type": "structure", - "members": { - "code": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The state code of the bucket.

\n

The following codes are possible:

\n " - } - }, - "message": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

A message that describes the state of the bucket.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the state of an Amazon Lightsail bucket.

" - } - }, - "com.amazonaws.lightsail#Bundle": { - "type": "structure", - "members": { - "price": { - "target": "com.amazonaws.lightsail#float", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "cpuCount": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "diskSizeInGb": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "bundleId": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "instanceType": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "isActive": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the bundle is active.

" - } - }, - "name": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "power": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

A numeric value that represents the power of the bundle (e.g., 500). You can\n use the bundle's power value in conjunction with a blueprint's minimum power value to\n determine whether the blueprint will run on the bundle. For example, you need a bundle with a\n power value of 500 or more to create an instance that uses a blueprint with a minimum power\n value of 500.

" - } - }, - "ramSizeInGb": { - "target": "com.amazonaws.lightsail#float", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "transferPerMonthInGb": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "supportedPlatforms": { - "target": "com.amazonaws.lightsail#InstancePlatformList", - "traits": { - "smithy.api#documentation": "

The operating system platform (Linux/Unix-based or Windows Server-based) that the bundle\n supports. You can only launch a WINDOWS bundle on a blueprint that supports the\n WINDOWS platform. LINUX_UNIX blueprints require a\n LINUX_UNIX bundle.

" - } - }, - "supportedAppCategories": { - "target": "com.amazonaws.lightsail#AppCategoryList", - "traits": { - "smithy.api#documentation": "

Virtual computer blueprints that are supported by a Lightsail for Research bundle.

\n \n

This parameter only applies to Lightsail for Research resources.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "com.amazonaws.lightsail#BundleList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#Bundle" - } - }, - "com.amazonaws.lightsail#CacheBehavior": { - "type": "structure", - "members": { - "behavior": { - "target": "com.amazonaws.lightsail#BehaviorEnum", - "traits": { - "smithy.api#documentation": "

The cache behavior of the distribution.

\n

The following cache behaviors can be specified:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the default cache behavior of an Amazon Lightsail content delivery network (CDN)\n distribution.

" - } - }, - "com.amazonaws.lightsail#CacheBehaviorList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#CacheBehaviorPerPath" - } - }, - "com.amazonaws.lightsail#CacheBehaviorPerPath": { - "type": "structure", - "members": { - "path": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify\n wildcard directories (path/to/assets/*), and file types (*.html, *jpg,\n *js). Directories and file paths are case-sensitive.

\n

Examples:

\n " - } - }, - "behavior": { - "target": "com.amazonaws.lightsail#BehaviorEnum", - "traits": { - "smithy.api#documentation": "

The cache behavior for the specified path.

\n

You can specify one of the following per-path cache behaviors:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the per-path cache behavior of an Amazon Lightsail content delivery network (CDN)\n distribution.

\n

A per-path cache behavior is used to override, or add an exception to, the default cache\n behavior of a distribution. For example, if the cacheBehavior is set to\n cache, then a per-path cache behavior can be used to specify a directory, file,\n or file type that your distribution will cache. Alternately, if the distribution's\n cacheBehavior is dont-cache, then a per-path cache behavior can be\n used to specify a directory, file, or file type that your distribution will not cache.

" - } - }, - "com.amazonaws.lightsail#CacheSettings": { - "type": "structure", - "members": { - "defaultTTL": { - "target": "com.amazonaws.lightsail#long", - "traits": { - "smithy.api#documentation": "

The default amount of time that objects stay in the distribution's cache before the\n distribution forwards another request to the origin to determine whether the content has been\n updated.

\n \n

The value specified applies only when the origin does not add HTTP headers such as\n Cache-Control max-age, Cache-Control s-maxage, and\n Expires to objects.

\n " - } - }, - "minimumTTL": { - "target": "com.amazonaws.lightsail#long", - "traits": { - "smithy.api#documentation": "

The minimum amount of time that objects stay in the distribution's cache before the\n distribution forwards another request to the origin to determine whether the object has been\n updated.

\n

A value of 0 must be specified for minimumTTL if the\n distribution is configured to forward all headers to the origin.

" - } - }, - "maximumTTL": { - "target": "com.amazonaws.lightsail#long", - "traits": { - "smithy.api#documentation": "

The maximum amount of time that objects stay in the distribution's cache before the\n distribution forwards another request to the origin to determine whether the object has been\n updated.

\n

The value specified applies only when the origin adds HTTP headers such as\n Cache-Control max-age, Cache-Control s-maxage, and\n Expires to objects.

" - } - }, - "allowedHTTPMethods": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The HTTP methods that are processed and forwarded to the distribution's origin.

\n

You can specify the following options:

\n \n

If you specify the third option, you might need to restrict access to your distribution's\n origin so users can't perform operations that you don't want them to. For example, you might\n not want users to have permission to delete objects from your origin.

" - } - }, - "cachedHTTPMethods": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The HTTP method responses that are cached by your distribution.

\n

You can specify the following options:

\n " - } - }, - "forwardedCookies": { - "target": "com.amazonaws.lightsail#CookieObject", - "traits": { - "smithy.api#documentation": "

An object that describes the cookies that are forwarded to the origin. Your content is\n cached based on the cookies that are forwarded.

" - } - }, - "forwardedHeaders": { - "target": "com.amazonaws.lightsail#HeaderObject", - "traits": { - "smithy.api#documentation": "

An object that describes the headers that are forwarded to the origin. Your content is\n cached based on the headers that are forwarded.

" - } - }, - "forwardedQueryStrings": { - "target": "com.amazonaws.lightsail#QueryStringObject", - "traits": { - "smithy.api#documentation": "

An object that describes the query strings that are forwarded to the origin. Your content\n is cached based on the query strings that are forwarded.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the cache settings of an Amazon Lightsail content delivery network (CDN)\n distribution.

\n

These settings apply only to your distribution's cacheBehaviors (including\n the defaultCacheBehavior) that have a behavior of\n cache.

" - } - }, - "com.amazonaws.lightsail#Certificate": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the certificate.

" - } - }, - "name": { - "target": "com.amazonaws.lightsail#CertificateName", - "traits": { - "smithy.api#documentation": "

The name of the certificate (e.g., my-certificate).

" - } - }, - "domainName": { - "target": "com.amazonaws.lightsail#DomainName", - "traits": { - "smithy.api#documentation": "

The domain name of the certificate.

" - } - }, - "status": { - "target": "com.amazonaws.lightsail#CertificateStatus", - "traits": { - "smithy.api#documentation": "

The validation status of the certificate.

" - } - }, - "serialNumber": { - "target": "com.amazonaws.lightsail#SerialNumber", - "traits": { - "smithy.api#documentation": "

The serial number of the certificate.

" - } - }, - "subjectAlternativeNames": { - "target": "com.amazonaws.lightsail#SubjectAlternativeNameList", - "traits": { - "smithy.api#documentation": "

An array of strings that specify the alternate domains (e.g., example2.com)\n and subdomains (e.g., blog.example.com) of the certificate.

" - } - }, - "domainValidationRecords": { - "target": "com.amazonaws.lightsail#DomainValidationRecordList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the domain validation records of the certificate.

" - } - }, - "requestFailureReason": { - "target": "com.amazonaws.lightsail#RequestFailureReason", - "traits": { - "smithy.api#documentation": "

The validation failure reason, if any, of the certificate.

\n

The following failure reasons are possible:

\n " - } - }, - "inUseResourceCount": { - "target": "com.amazonaws.lightsail#InUseResourceCount", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of Lightsail resources that the certificate is attached to.

" - } - }, - "keyAlgorithm": { - "target": "com.amazonaws.lightsail#KeyAlgorithm", - "traits": { - "smithy.api#documentation": "

The algorithm used to generate the key pair (the public and private key) of the\n certificate.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the certificate was created.

" - } - }, - "issuedAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the certificate was issued.

" - } - }, - "issuerCA": { - "target": "com.amazonaws.lightsail#IssuerCA", - "traits": { - "smithy.api#documentation": "

The certificate authority that issued the certificate.

" - } - }, - "notBefore": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the certificate is first valid.

" - } - }, - "notAfter": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the certificate expires.

" - } - }, - "eligibleToRenew": { - "target": "com.amazonaws.lightsail#EligibleToRenew", - "traits": { - "smithy.api#documentation": "

The renewal eligibility of the certificate.

" - } - }, - "renewalSummary": { - "target": "com.amazonaws.lightsail#RenewalSummary", - "traits": { - "smithy.api#documentation": "

An object that describes the status of the certificate renewal managed by\n Lightsail.

" - } - }, - "revokedAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the certificate was revoked. This value is present only when the\n certificate status is REVOKED.

" - } - }, - "revocationReason": { - "target": "com.amazonaws.lightsail#RevocationReason", - "traits": { - "smithy.api#documentation": "

The reason the certificate was revoked. This value is present only when the certificate\n status is REVOKED.

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" - } - }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail certificate. This code enables our support team to look up your Lightsail\n information more easily.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the full details of an Amazon Lightsail SSL/TLS certificate.

\n \n

To get a summary of a certificate, use the GetCertificates action and ommit\n includeCertificateDetails from your request. The response will include only\n the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags.

\n " - } - }, - "com.amazonaws.lightsail#CertificateDomainValidationStatus": { - "type": "enum", - "members": { - "PendingValidation": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING_VALIDATION" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "Success": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCESS" - } - } - } - }, - "com.amazonaws.lightsail#CertificateName": { - "type": "string" - }, - "com.amazonaws.lightsail#CertificateStatus": { - "type": "enum", - "members": { - "PendingValidation": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING_VALIDATION" - } - }, - "Issued": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ISSUED" - } - }, - "Inactive": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INACTIVE" - } - }, - "Expired": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXPIRED" - } - }, - "ValidationTimedOut": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VALIDATION_TIMED_OUT" - } - }, - "Revoked": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REVOKED" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - } - } - }, - "com.amazonaws.lightsail#CertificateStatusList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#CertificateStatus" - } - }, - "com.amazonaws.lightsail#CertificateSummary": { - "type": "structure", - "members": { - "certificateArn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the certificate.

" - } - }, - "certificateName": { - "target": "com.amazonaws.lightsail#CertificateName", - "traits": { - "smithy.api#documentation": "

The name of the certificate.

" - } - }, - "domainName": { - "target": "com.amazonaws.lightsail#DomainName", - "traits": { - "smithy.api#documentation": "

The domain name of the certificate.

" - } - }, - "certificateDetail": { - "target": "com.amazonaws.lightsail#Certificate", - "traits": { - "smithy.api#documentation": "

An object that describes a certificate in detail.

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an Amazon Lightsail SSL/TLS certificate.

" - } - }, - "com.amazonaws.lightsail#CertificateSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#CertificateSummary" - } - }, - "com.amazonaws.lightsail#CloseInstancePublicPorts": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CloseInstancePublicPortsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CloseInstancePublicPortsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Closes ports for a specific Amazon Lightsail instance.

\n

The CloseInstancePublicPorts action supports tag-based access control via\n resource tags applied to the resource identified by instanceName. For more\n information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CloseInstancePublicPorts", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CloseInstancePublicPortsRequest": { - "type": "structure", - "members": { - "portInfo": { - "target": "com.amazonaws.lightsail#PortInfo", - "traits": { - "smithy.api#documentation": "

An object to describe the ports to close for the specified instance.

", - "smithy.api#required": {} - } - }, - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the instance for which to close ports.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#CloseInstancePublicPortsResult": { - "type": "structure", - "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An object that describes the result of the action, such as the status of the request, the\n timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CloudFormationStackRecord": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the CloudFormation stack record. It starts with\n CloudFormationStackRecord followed by a GUID.

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudFormation stack record.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The date when the CloudFormation stack record was created.

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

A list of objects describing the Availability Zone and Amazon Web Services Region of the\n CloudFormation stack record.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The Lightsail resource type (e.g., CloudFormationStackRecord).

" - } - }, - "state": { - "target": "com.amazonaws.lightsail#RecordState", - "traits": { - "smithy.api#documentation": "

The current state of the CloudFormation stack record.

" - } - }, - "sourceInfo": { - "target": "com.amazonaws.lightsail#CloudFormationStackRecordSourceInfoList", - "traits": { - "smithy.api#documentation": "

A list of objects describing the source of the CloudFormation stack record.

" - } - }, - "destinationInfo": { - "target": "com.amazonaws.lightsail#DestinationInfo", - "traits": { - "smithy.api#documentation": "

A list of objects describing the destination service, which is AWS CloudFormation, and the Amazon\n Resource Name (ARN) of the AWS CloudFormation stack.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a CloudFormation stack record created as a result of the create cloud\n formation stack action.

\n

A CloudFormation stack record provides information about the AWS CloudFormation stack used to\n create a new Amazon Elastic Compute Cloud instance from an exported Lightsail instance snapshot.

" - } - }, - "com.amazonaws.lightsail#CloudFormationStackRecordList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#CloudFormationStackRecord" - } - }, - "com.amazonaws.lightsail#CloudFormationStackRecordSourceInfo": { - "type": "structure", - "members": { - "resourceType": { - "target": "com.amazonaws.lightsail#CloudFormationStackRecordSourceType", - "traits": { - "smithy.api#documentation": "

The Lightsail resource type (e.g., ExportSnapshotRecord).

" - } - }, - "name": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the record.

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the export snapshot record.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the source of a CloudFormation stack record (i.e., the export snapshot\n record).

" - } - }, - "com.amazonaws.lightsail#CloudFormationStackRecordSourceInfoList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#CloudFormationStackRecordSourceInfo" - } - }, - "com.amazonaws.lightsail#CloudFormationStackRecordSourceType": { - "type": "enum", - "members": { - "ExportSnapshotRecord": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ExportSnapshotRecord" - } - } - } - }, - "com.amazonaws.lightsail#ComparisonOperator": { - "type": "enum", - "members": { - "GreaterThanOrEqualToThreshold": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GreaterThanOrEqualToThreshold" - } - }, - "GreaterThanThreshold": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GreaterThanThreshold" - } - }, - "LessThanThreshold": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LessThanThreshold" - } - }, - "LessThanOrEqualToThreshold": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LessThanOrEqualToThreshold" - } - } - } - }, - "com.amazonaws.lightsail#ContactMethod": { - "type": "structure", - "members": { - "contactEndpoint": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The destination of the contact method, such as an email address or a mobile phone\n number.

" - } - }, - "status": { - "target": "com.amazonaws.lightsail#ContactMethodStatus", - "traits": { - "smithy.api#documentation": "

The current status of the contact method.

\n

A contact method has the following possible status:

\n " - } - }, - "protocol": { - "target": "com.amazonaws.lightsail#ContactProtocol", - "traits": { - "smithy.api#documentation": "

The protocol of the contact method, such as email or SMS (text messaging).

" - } - }, - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the contact method.

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the contact method.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the contact method was created.

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

An object that describes the location of the contact method, such as the Amazon Web Services Region and Availability Zone.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The Lightsail resource type (e.g., ContactMethod).

" - } - }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail contact method. This code enables our support team to look up your\n Lightsail information more easily.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a contact method.

\n

A contact method is a way to send you notifications. For more information, see Notifications in Amazon Lightsail.

" - } - }, - "com.amazonaws.lightsail#ContactMethodStatus": { - "type": "enum", - "members": { - "PendingVerification": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PendingVerification" - } - }, - "Valid": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Valid" - } - }, - "Invalid": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Invalid" - } - } - } - }, - "com.amazonaws.lightsail#ContactMethodVerificationProtocol": { - "type": "enum", - "members": { - "Email": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Email" - } - } - } - }, - "com.amazonaws.lightsail#ContactMethodsList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#ContactMethod" - } - }, - "com.amazonaws.lightsail#ContactProtocol": { - "type": "enum", - "members": { - "Email": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Email" - } - }, - "SMS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SMS" - } - } - } - }, - "com.amazonaws.lightsail#ContactProtocolsList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#ContactProtocol" - } - }, - "com.amazonaws.lightsail#Container": { - "type": "structure", - "members": { - "image": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The name of the image used for the container.

\n

Container images sourced from your Lightsail container service, that are registered and\n stored on your service, start with a colon (:). For example, if your container\n service name is container-service-1, the container image label is\n mystaticsite, and you want to use the third (3) version of the\n registered container image, then you should specify\n :container-service-1.mystaticsite.3. To use the latest version of a container\n image, specify latest instead of a version number (for example,\n :container-service-1.mystaticsite.latest). Lightsail will automatically use\n the highest numbered version of the registered container image.

\n

Container images sourced from a public registry like Docker Hub don't start with a colon.\n For example, nginx:latest or nginx.

" - } - }, - "command": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

The launch command for the container.

" - } - }, - "environment": { - "target": "com.amazonaws.lightsail#Environment", - "traits": { - "smithy.api#documentation": "

The environment variables of the container.

" - } - }, - "ports": { - "target": "com.amazonaws.lightsail#PortMap", - "traits": { - "smithy.api#documentation": "

The open firewall ports of the container.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the settings of a container that will be launched, or that is launched, to an\n Amazon Lightsail container service.

" - } - }, - "com.amazonaws.lightsail#ContainerImage": { - "type": "structure", - "members": { - "image": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The name of the container image.

" - } - }, - "digest": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The digest of the container image.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the container image was created.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a container image that is registered to an Amazon Lightsail container\n service.

" - } - }, - "com.amazonaws.lightsail#ContainerImageList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#ContainerImage" - } - }, - "com.amazonaws.lightsail#ContainerLabel": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 53 - }, - "smithy.api#pattern": "^[a-z0-9]{1,2}|[a-z0-9][a-z0-9-]+[a-z0-9]$" - } - }, - "com.amazonaws.lightsail#ContainerMap": { - "type": "map", - "key": { - "target": "com.amazonaws.lightsail#ContainerName" - }, - "value": { - "target": "com.amazonaws.lightsail#Container" - } - }, - "com.amazonaws.lightsail#ContainerName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 53 - }, - "smithy.api#pattern": "^[a-z0-9]{1,2}|[a-z0-9][a-z0-9-]+[a-z0-9]$" - } - }, - "com.amazonaws.lightsail#ContainerService": { - "type": "structure", - "members": { - "containerServiceName": { - "target": "com.amazonaws.lightsail#ContainerServiceName", - "traits": { - "smithy.api#documentation": "

The name of the container service.

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container service.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the container service was created.

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

An object that describes the location of the container service, such as the Amazon Web Services Region and Availability Zone.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The Lightsail resource type of the container service (i.e.,\n ContainerService).

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" - } - }, - "power": { - "target": "com.amazonaws.lightsail#ContainerServicePowerName", - "traits": { - "smithy.api#documentation": "

The power specification of the container service.

\n

The power specifies the amount of RAM, the number of vCPUs, and the base price of the\n container service.

" - } - }, - "powerId": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The ID of the power of the container service.

" - } - }, - "state": { - "target": "com.amazonaws.lightsail#ContainerServiceState", - "traits": { - "smithy.api#documentation": "

The current state of the container service.

\n

The following container service states are possible:

\n " - } - }, - "stateDetail": { - "target": "com.amazonaws.lightsail#ContainerServiceStateDetail", - "traits": { - "smithy.api#documentation": "

An object that describes the current state of the container service.

\n \n

The state detail is populated only when a container service is in a\n PENDING, DEPLOYING, or UPDATING state.

\n " - } - }, - "scale": { - "target": "com.amazonaws.lightsail#ContainerServiceScale", - "traits": { - "smithy.api#documentation": "

The scale specification of the container service.

\n

The scale specifies the allocated compute nodes of the container service.

" - } - }, - "currentDeployment": { - "target": "com.amazonaws.lightsail#ContainerServiceDeployment", - "traits": { - "smithy.api#documentation": "

An object that describes the current container deployment of the container service.

" - } - }, - "nextDeployment": { - "target": "com.amazonaws.lightsail#ContainerServiceDeployment", - "traits": { - "smithy.api#documentation": "

An object that describes the next deployment of the container service.

\n

This value is null when there is no deployment in a pending\n state.

" - } - }, - "isDisabled": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the container service is disabled.

" - } - }, - "principalArn": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The principal ARN of the container service.

\n

The principal ARN can be used to create a trust relationship between your standard Amazon Web Services account and your Lightsail container service. This allows you to give your\n service permission to access resources in your standard Amazon Web Services account.

" - } - }, - "privateDomainName": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The private domain name of the container service.

\n

The private domain name is accessible only by other resources within the default virtual\n private cloud (VPC) of your Lightsail account.

" - } - }, - "publicDomainNames": { - "target": "com.amazonaws.lightsail#ContainerServicePublicDomains", - "traits": { - "smithy.api#documentation": "

The public domain name of the container service, such as example.com and\n www.example.com.

\n

You can specify up to four public domain names for a container service. The domain names\n that you specify are used when you create a deployment with a container configured as the\n public endpoint of your container service.

\n

If you don't specify public domain names, then you can use the default domain of the\n container service.

\n \n

You must create and validate an SSL/TLS certificate before you can use public domain\n names with your container service. Use the CreateCertificate action to create a\n certificate for the public domain names you want to use with your container service.

\n \n

See CreateContainerService or UpdateContainerService for\n information about how to specify public domain names for your Lightsail container\n service.

" - } - }, - "url": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The publicly accessible URL of the container service.

\n

If no public endpoint is specified in the currentDeployment, this URL returns\n a 404 response.

" - } - }, - "privateRegistryAccess": { - "target": "com.amazonaws.lightsail#PrivateRegistryAccess", - "traits": { - "smithy.api#documentation": "

An object that describes the configuration for the container service to access private\n container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private\n repositories.

\n

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an Amazon Lightsail container service.

" - } - }, - "com.amazonaws.lightsail#ContainerServiceDeployment": { - "type": "structure", - "members": { - "version": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The version number of the deployment.

" - } - }, - "state": { - "target": "com.amazonaws.lightsail#ContainerServiceDeploymentState", - "traits": { - "smithy.api#documentation": "

The state of the deployment.

\n

A deployment can be in one of the following states:

\n " - } - }, - "containers": { - "target": "com.amazonaws.lightsail#ContainerMap", - "traits": { - "smithy.api#documentation": "

An object that describes the configuration for the containers of the deployment.

" - } - }, - "publicEndpoint": { - "target": "com.amazonaws.lightsail#ContainerServiceEndpoint", - "traits": { - "smithy.api#documentation": "

An object that describes the endpoint of the deployment.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the deployment was created.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a container deployment configuration of an Amazon Lightsail container\n service.

\n

A deployment specifies the settings, such as the ports and launch command, of containers\n that are deployed to your container service.

" - } - }, - "com.amazonaws.lightsail#ContainerServiceDeploymentList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#ContainerServiceDeployment" - } - }, - "com.amazonaws.lightsail#ContainerServiceDeploymentRequest": { - "type": "structure", - "members": { - "containers": { - "target": "com.amazonaws.lightsail#ContainerMap", - "traits": { - "smithy.api#documentation": "

An object that describes the configuration for the containers of the deployment.

" - } - }, - "publicEndpoint": { - "target": "com.amazonaws.lightsail#EndpointRequest", - "traits": { - "smithy.api#documentation": "

An object that describes the endpoint of the deployment.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a container deployment configuration of an Amazon Lightsail container\n service.

\n

A deployment specifies the settings, such as the ports and launch command, of containers\n that are deployed to your container service.

" - } - }, - "com.amazonaws.lightsail#ContainerServiceDeploymentState": { - "type": "enum", - "members": { - "ACTIVATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVATING" - } - }, - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "INACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INACTIVE" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - } - } - }, - "com.amazonaws.lightsail#ContainerServiceECRImagePullerRole": { - "type": "structure", - "members": { - "isActive": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value that indicates whether the role is activated.

" - } - }, - "principalArn": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role, if it is activated.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the activation status of the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR)\n private repositories.

\n

When activated, Lightsail creates an Identity and Access Management (IAM) role\n for the specified Lightsail container service. You can use the ARN of the role to create a\n trust relationship between your Lightsail container service and an Amazon ECR private repository in your Amazon Web Services account. This allows your container\n service to pull images from Amazon ECR private repositories. For more information, see\n Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

" - } - }, - "com.amazonaws.lightsail#ContainerServiceECRImagePullerRoleRequest": { - "type": "structure", - "members": { - "isActive": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value that indicates whether to activate the role.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a request to activate or deactivate the role that you can use to grant an\n Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories.

\n

When activated, Lightsail creates an Identity and Access Management (IAM) role\n for the specified Lightsail container service. You can use the ARN of the role to create a\n trust relationship between your Lightsail container service and an Amazon ECR private repository in your Amazon Web Services account. This allows your container\n service to pull images from Amazon ECR private repositories. For more information, see\n Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

" - } - }, - "com.amazonaws.lightsail#ContainerServiceEndpoint": { - "type": "structure", - "members": { - "containerName": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The name of the container entry of the deployment that the endpoint configuration applies\n to.

" - } - }, - "containerPort": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The port of the specified container to which traffic is forwarded to.

" - } - }, - "healthCheck": { - "target": "com.amazonaws.lightsail#ContainerServiceHealthCheckConfig", - "traits": { - "smithy.api#documentation": "

An object that describes the health check configuration of the container.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the public endpoint configuration of a deployment of an Amazon Lightsail\n container service.

" - } - }, - "com.amazonaws.lightsail#ContainerServiceHealthCheckConfig": { - "type": "structure", - "members": { - "healthyThreshold": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The number of consecutive health checks successes required before moving the container to\n the Healthy state. The default value is 2.

" - } - }, - "unhealthyThreshold": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The number of consecutive health check failures required before moving the container to\n the Unhealthy state. The default value is 2.

" - } - }, - "timeoutSeconds": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, during which no response means a failed health check. You\n can specify between 2 and 60 seconds. The default value is 2.

" - } - }, - "intervalSeconds": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The approximate interval, in seconds, between health checks of an individual container.\n You can specify between 5 and 300 seconds. The default value is 5.

" - } - }, - "path": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The path on the container on which to perform the health check. The default value is\n /.

" - } - }, - "successCodes": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The HTTP codes to use when checking for a successful response from a container. You can\n specify values between 200 and 499. You can specify multiple values\n (for example, 200,202) or a range of values (for example,\n 200-299).

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the health check configuration of an Amazon Lightsail container service.

" - } - }, - "com.amazonaws.lightsail#ContainerServiceList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#ContainerService" - } - }, - "com.amazonaws.lightsail#ContainerServiceLogEvent": { - "type": "structure", - "members": { - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the container service log event was created.

" - } - }, - "message": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The message of the container service log event.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the log events of a container of an Amazon Lightsail container service.

" - } - }, - "com.amazonaws.lightsail#ContainerServiceLogEventList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#ContainerServiceLogEvent" - } - }, - "com.amazonaws.lightsail#ContainerServiceMetadataEntry": { - "type": "map", - "key": { - "target": "com.amazonaws.lightsail#string" - }, - "value": { - "target": "com.amazonaws.lightsail#string" - } - }, - "com.amazonaws.lightsail#ContainerServiceMetadataEntryList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#ContainerServiceMetadataEntry" - } - }, - "com.amazonaws.lightsail#ContainerServiceMetricName": { - "type": "enum", - "members": { - "CPUUtilization": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CPUUtilization" - } - }, - "MemoryUtilization": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MemoryUtilization" - } - } - } - }, - "com.amazonaws.lightsail#ContainerServiceName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[a-z0-9]{1,2}|[a-z0-9][a-z0-9-]+[a-z0-9]$" - } - }, - "com.amazonaws.lightsail#ContainerServicePower": { - "type": "structure", - "members": { - "powerId": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The ID of the power (e.g., nano-1).

" - } - }, - "price": { - "target": "com.amazonaws.lightsail#float", - "traits": { - "smithy.api#documentation": "

The monthly price of the power in USD.

" - } - }, - "cpuCount": { - "target": "com.amazonaws.lightsail#float", - "traits": { - "smithy.api#documentation": "

The number of vCPUs included in the power.

" - } - }, - "ramSizeInGb": { - "target": "com.amazonaws.lightsail#float", - "traits": { - "smithy.api#documentation": "

The amount of RAM (in GB) of the power.

" - } - }, - "name": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The friendly name of the power (e.g., nano).

" - } - }, - "isActive": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the power is active and can be specified for container\n services.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the powers that can be specified for an Amazon Lightsail container\n service.

\n

The power specifies the amount of RAM, the number of vCPUs, and the base price of the\n container service.

" - } - }, - "com.amazonaws.lightsail#ContainerServicePowerList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#ContainerServicePower" - } - }, - "com.amazonaws.lightsail#ContainerServicePowerName": { - "type": "enum", - "members": { - "nano": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "nano" - } - }, - "micro": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "micro" - } - }, - "small": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "small" - } - }, - "medium": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "medium" - } - }, - "large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "large" - } - }, - "xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "xlarge" - } - } - } - }, - "com.amazonaws.lightsail#ContainerServiceProtocol": { - "type": "enum", - "members": { - "HTTP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTP" - } - }, - "HTTPS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTPS" - } - }, - "TCP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TCP" - } - }, - "UDP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UDP" - } - } - } - }, - "com.amazonaws.lightsail#ContainerServicePublicDomains": { - "type": "map", - "key": { - "target": "com.amazonaws.lightsail#string" - }, - "value": { - "target": "com.amazonaws.lightsail#ContainerServicePublicDomainsList" - } - }, - "com.amazonaws.lightsail#ContainerServicePublicDomainsList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#string" - } - }, - "com.amazonaws.lightsail#ContainerServiceRegistryLogin": { - "type": "structure", - "members": { - "username": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The container service registry username to use to push container images to the container\n image registry of a Lightsail account.

" - } - }, - "password": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The container service registry password to use to push container images to the container\n image registry of a Lightsail account

" - } - }, - "expiresAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp of when the container image registry sign-in credentials expire.

\n

The log in credentials expire 12 hours after they are created, at which point you will\n need to create a new set of log in credentials using the\n CreateContainerServiceRegistryLogin action.

" - } - }, - "registry": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The address to use to push container images to the container image registry of a\n Lightsail account.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the sign-in credentials for the container image registry of an Amazon Lightsail\n account.

" - } - }, - "com.amazonaws.lightsail#ContainerServiceScale": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 20 - } - } - }, - "com.amazonaws.lightsail#ContainerServiceState": { - "type": "enum", - "members": { - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "READY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "READY" - } - }, - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATING" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - }, - "DEPLOYING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DEPLOYING" - } - } - } - }, - "com.amazonaws.lightsail#ContainerServiceStateDetail": { - "type": "structure", - "members": { - "code": { - "target": "com.amazonaws.lightsail#ContainerServiceStateDetailCode", - "traits": { - "smithy.api#documentation": "

The state code of the container service.

\n

The following state codes are possible:

\n " - } - }, - "message": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

A message that provides more information for the state code.

\n \n

The state detail is populated only when a container service is in a\n PENDING, DEPLOYING, or UPDATING state.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the current state of a container service.

" - } - }, - "com.amazonaws.lightsail#ContainerServiceStateDetailCode": { - "type": "enum", - "members": { - "CREATING_SYSTEM_RESOURCES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING_SYSTEM_RESOURCES" - } - }, - "CREATING_NETWORK_INFRASTRUCTURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING_NETWORK_INFRASTRUCTURE" - } - }, - "PROVISIONING_CERTIFICATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PROVISIONING_CERTIFICATE" - } - }, - "PROVISIONING_SERVICE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PROVISIONING_SERVICE" - } - }, - "CREATING_DEPLOYMENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING_DEPLOYMENT" - } - }, - "EVALUATING_HEALTH_CHECK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EVALUATING_HEALTH_CHECK" - } - }, - "ACTIVATING_DEPLOYMENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVATING_DEPLOYMENT" - } - }, - "CERTIFICATE_LIMIT_EXCEEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CERTIFICATE_LIMIT_EXCEEDED" - } - }, - "UNKNOWN_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNKNOWN_ERROR" - } - } - } - }, - "com.amazonaws.lightsail#ContainerServicesListResult": { - "type": "structure", - "members": { - "containerServices": { - "target": "com.amazonaws.lightsail#ContainerServiceList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe one or more container services.

" - } - } - } - }, - "com.amazonaws.lightsail#CookieObject": { - "type": "structure", - "members": { - "option": { - "target": "com.amazonaws.lightsail#ForwardValues", - "traits": { - "smithy.api#documentation": "

Specifies which cookies to forward to the distribution's origin for a cache behavior:\n all, none, or allow-list to forward only the cookies\n specified in the cookiesAllowList parameter.

" - } - }, - "cookiesAllowList": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

The specific cookies to forward to your distribution's origin.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes whether an Amazon Lightsail content delivery network (CDN) distribution forwards\n cookies to the origin and, if so, which ones.

\n

For the cookies that you specify, your distribution caches separate versions of the\n specified content based on the cookie values in viewer\n requests.

" - } - }, - "com.amazonaws.lightsail#CopySnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CopySnapshotRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CopySnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an\n automatic snapshot of an instance or disk as a manual snapshot. This operation can also be\n used to copy a manual or automatic snapshot of an instance or a disk from one Amazon Web Services Region to another in Amazon Lightsail.

\n

When copying a manual snapshot, be sure to define the source\n region, source snapshot name, and target snapshot name\n parameters.

\n

When copying an automatic snapshot, be sure to define the\n source region, source resource name, target snapshot\n name, and either the restore date or the use latest restorable\n auto snapshot parameters.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CopySnapshot", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CopySnapshotRequest": { - "type": "structure", - "members": { - "sourceSnapshotName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the source manual snapshot to copy.

\n

Constraint:

\n " - } - }, - "sourceResourceName": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The name of the source instance or disk from which the source automatic snapshot was\n created.

\n

Constraint:

\n " - } - }, - "restoreDate": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The date of the source automatic snapshot to copy. Use the get auto snapshots\n operation to identify the dates of the available automatic snapshots.

\n

Constraints:

\n " - } - }, - "useLatestRestorableAutoSnapshot": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value to indicate whether to use the latest available automatic snapshot of the\n specified source instance or disk.

\n

Constraints:

\n " - } - }, - "targetSnapshotName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the new manual snapshot to be created as a copy.

", - "smithy.api#required": {} - } - }, - "sourceRegion": { - "target": "com.amazonaws.lightsail#RegionName", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region where the source manual or automatic snapshot is\n located.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#CopySnapshotResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CostEstimate": { - "type": "structure", - "members": { - "usageType": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The types of usage that are included in the estimate, such as costs, usage, or data\n transfer.

" - } - }, - "resultsByTime": { - "target": "com.amazonaws.lightsail#EstimatesByTime", - "traits": { - "smithy.api#documentation": "

The cost estimate result that's associated with a time period.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the estimated cost for resources in your Lightsail for Research account.

" - } - }, - "com.amazonaws.lightsail#CostEstimates": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#CostEstimate" - } - }, - "com.amazonaws.lightsail#CreateBucket": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateBucketRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateBucketResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an Amazon Lightsail bucket.

\n

A bucket is a cloud storage resource available in the Lightsail object storage service.\n Use buckets to store objects such as data and its descriptive metadata. For more information\n about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer\n Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateBucket", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateBucketAccessKey": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateBucketAccessKeyRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateBucketAccessKeyResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new access key for the specified Amazon Lightsail bucket. Access keys consist of\n an access key ID and corresponding secret access key.

\n

Access keys grant full programmatic access to the specified bucket and its objects. You\n can have a maximum of two access keys per bucket. Use the GetBucketAccessKeys action to get a list of current access keys for a specific bucket. For more\n information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

\n \n

The secretAccessKey value is returned only in response to the\n CreateBucketAccessKey action. You can get a secret access key only when you\n first create an access key; you cannot get the secret access key later. If you lose the\n secret access key, you must create a new access key.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateBucketAccessKey", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateBucketAccessKeyRequest": { - "type": "structure", - "members": { - "bucketName": { - "target": "com.amazonaws.lightsail#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket that the new access key will belong to, and grant access to.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#CreateBucketAccessKeyResult": { - "type": "structure", - "members": { - "accessKey": { - "target": "com.amazonaws.lightsail#AccessKey", - "traits": { - "smithy.api#documentation": "

An object that describes the access key that is created.

" - } - }, - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateBucketRequest": { - "type": "structure", - "members": { - "bucketName": { - "target": "com.amazonaws.lightsail#BucketName", - "traits": { - "smithy.api#documentation": "

The name for the bucket.

\n

For more information about bucket names, see Bucket naming rules in Amazon Lightsail in the Amazon Lightsail Developer\n Guide.

", - "smithy.api#required": {} - } - }, - "bundleId": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the bundle to use for the bucket.

\n

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a\n bucket.

\n

Use the GetBucketBundles action to get a list of\n bundle IDs that you can specify.

\n

Use the UpdateBucketBundle action to change the\n bundle after the bucket is created.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the bucket during creation.

\n

Use the TagResource action to tag the bucket after it's\n created.

" - } - }, - "enableObjectVersioning": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value that indicates whether to enable versioning of objects in the\n bucket.

\n

For more information about versioning, see Enabling and suspending object versioning in a bucket in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#CreateBucketResult": { - "type": "structure", - "members": { - "bucket": { - "target": "com.amazonaws.lightsail#Bucket", - "traits": { - "smithy.api#documentation": "

An object that describes the bucket that is created.

" - } - }, - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateCertificate": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateCertificateRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateCertificateResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN)\n distribution and a container service.

\n

After the certificate is valid, use the AttachCertificateToDistribution\n action to use the certificate and its domains with your distribution. Or use the\n UpdateContainerService action to use the certificate and its domains with your\n container service.

\n \n

Only certificates created in the us-east-1\n Amazon Web Services Region can be attached to Lightsail distributions. Lightsail\n distributions are global resources that can reference an origin in any Amazon Web Services\n Region, and distribute its content globally. However, all distributions are located in the\n us-east-1 Region.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateCertificate", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateCertificateRequest": { - "type": "structure", - "members": { - "certificateName": { - "target": "com.amazonaws.lightsail#CertificateName", - "traits": { - "smithy.api#documentation": "

The name for the certificate.

", - "smithy.api#required": {} - } - }, - "domainName": { - "target": "com.amazonaws.lightsail#DomainName", - "traits": { - "smithy.api#documentation": "

The domain name (e.g., example.com) for the certificate.

", - "smithy.api#required": {} - } - }, - "subjectAlternativeNames": { - "target": "com.amazonaws.lightsail#SubjectAlternativeNameList", - "traits": { - "smithy.api#documentation": "

An array of strings that specify the alternate domains (e.g., example2.com)\n and subdomains (e.g., blog.example.com) for the certificate.

\n

You can specify a maximum of nine alternate domains (in addition to the primary domain\n name).

\n

Wildcard domain entries (e.g., *.example.com) are not supported.

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the certificate during create.

\n

Use the TagResource action to tag a resource after it's created.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#CreateCertificateResult": { - "type": "structure", - "members": { - "certificate": { - "target": "com.amazonaws.lightsail#CertificateSummary", - "traits": { - "smithy.api#documentation": "

An object that describes the certificate created.

" - } - }, - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateCloudFormationStack": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateCloudFormationStackRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateCloudFormationStackResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported\n Amazon Lightsail snapshot. This operation results in a CloudFormation stack record that can be\n used to track the AWS CloudFormation stack created. Use the get cloud formation stack\n records operation to get a list of the CloudFormation stacks created.

\n \n

Wait until after your new Amazon EC2 instance is created before running the create\n cloud formation stack operation again with the same export snapshot record.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateCloudFormationStack", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateCloudFormationStackRequest": { - "type": "structure", - "members": { - "instances": { - "target": "com.amazonaws.lightsail#InstanceEntryList", - "traits": { - "smithy.api#documentation": "

An array of parameters that will be used to create the new Amazon EC2 instance. You can only\n pass one instance entry at a time in this array. You will get an invalid parameter error if\n you pass more than one instance entry in this array.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#CreateCloudFormationStackResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateContactMethod": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateContactMethodRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateContactMethodResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an email or SMS text message contact method.

\n

A contact method is used to send you notifications about your Amazon Lightsail resources.\n You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services\n Regions, and SMS text messages cannot be sent to some countries/regions. For more information,\n see Notifications in Amazon Lightsail.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateContactMethod", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateContactMethodRequest": { - "type": "structure", - "members": { - "protocol": { - "target": "com.amazonaws.lightsail#ContactProtocol", - "traits": { - "smithy.api#documentation": "

The protocol of the contact method, such as Email or SMS (text\n messaging).

\n

The SMS protocol is supported only in the following Amazon Web Services\n Regions.

\n \n

For a list of countries/regions where SMS text messages can be sent, and the latest\n Amazon Web Services Regions where SMS text messaging is supported, see Supported Regions and Countries in the Amazon SNS Developer\n Guide.

\n

For more information about notifications in Amazon Lightsail, see Notifications in Amazon Lightsail.

", - "smithy.api#required": {} - } - }, - "contactEndpoint": { - "target": "com.amazonaws.lightsail#StringMax256", - "traits": { - "smithy.api#documentation": "

The destination of the contact method, such as an email address or a mobile phone\n number.

\n

Use the E.164 format when specifying a mobile phone number. E.164 is a standard for the\n phone number structure used for international telecommunication. Phone numbers that follow\n this format can have a maximum of 15 digits, and they are prefixed with the plus character (+)\n and the country code. For example, a U.S. phone number in E.164 format would be specified as\n +1XXX5550100. For more information, see E.164 on Wikipedia.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#CreateContactMethodResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateContainerService": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateContainerServiceRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateContainerServiceResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an Amazon Lightsail container service.

\n

A Lightsail container service is a compute resource to which you can deploy containers.\n For more information, see Container services in Amazon Lightsail in the Lightsail Dev\n Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/container-services", - "code": 201 - } - } - }, - "com.amazonaws.lightsail#CreateContainerServiceDeployment": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateContainerServiceDeploymentRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateContainerServiceDeploymentResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a deployment for your Amazon Lightsail container service.

\n

A deployment specifies the containers that will be launched on the container service and\n their settings, such as the ports to open, the environment variables to apply, and the launch\n command to run. It also specifies the container that will serve as the public endpoint of the\n deployment and its settings, such as the HTTP or HTTPS port to use, and the health check\n configuration.

\n

You can deploy containers to your container service using container images from a public\n registry such as Amazon ECR Public, or from your local machine. For more information, see\n Creating container images for your Amazon Lightsail container services in the\n Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/container-services/{serviceName}/deployments", - "code": 201 - } - } - }, - "com.amazonaws.lightsail#CreateContainerServiceDeploymentRequest": { - "type": "structure", - "members": { - "serviceName": { - "target": "com.amazonaws.lightsail#ContainerServiceName", - "traits": { - "smithy.api#documentation": "

The name of the container service for which to create the deployment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "containers": { - "target": "com.amazonaws.lightsail#ContainerMap", - "traits": { - "smithy.api#documentation": "

An object that describes the settings of the containers that will be launched on the\n container service.

" - } - }, - "publicEndpoint": { - "target": "com.amazonaws.lightsail#EndpointRequest", - "traits": { - "smithy.api#documentation": "

An object that describes the settings of the public endpoint for the container\n service.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#CreateContainerServiceDeploymentResult": { - "type": "structure", - "members": { - "containerService": { - "target": "com.amazonaws.lightsail#ContainerService", - "traits": { - "smithy.api#documentation": "

An object that describes a container service.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateContainerServiceRegistryLogin": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateContainerServiceRegistryLoginRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateContainerServiceRegistryLoginResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a temporary set of log in credentials that you can use to log in to the Docker\n process on your local machine. After you're logged in, you can use the native Docker commands\n to push your local container images to the container image registry of your Amazon Lightsail\n account so that you can use them with your Lightsail container service. The log in\n credentials expire 12 hours after they are created, at which point you will need to create a\n new set of log in credentials.

\n \n

You can only push container images to the container service registry of your Lightsail\n account. You cannot pull container images or perform any other container image management\n actions on the container service registry.

\n \n

After you push your container images to the container image registry of your Lightsail\n account, use the RegisterContainerImage action to register the pushed images to a\n specific Lightsail container service.

\n \n

This action is not required if you install and use the Lightsail Control\n (lightsailctl) plugin to push container images to your Lightsail container service. For\n more information, see Pushing and managing container images on your Amazon Lightsail container services\n in the Amazon Lightsail Developer Guide.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/container-registry-login", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateContainerServiceRegistryLoginRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#CreateContainerServiceRegistryLoginResult": { - "type": "structure", - "members": { - "registryLogin": { - "target": "com.amazonaws.lightsail#ContainerServiceRegistryLogin", - "traits": { - "smithy.api#documentation": "

An object that describes the log in information for the container service registry of your\n Lightsail account.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateContainerServiceRequest": { - "type": "structure", - "members": { - "serviceName": { - "target": "com.amazonaws.lightsail#ContainerServiceName", - "traits": { - "smithy.api#documentation": "

The name for the container service.

\n

The name that you specify for your container service will make up part of its default\n domain. The default domain of a container service is typically\n https://...cs.amazonlightsail.com.\n If the name of your container service is container-service-1, and it's located in\n the US East (Ohio) Amazon Web Services Region (us-east-2), then the domain for\n your container service will be like the following example:\n https://container-service-1.ur4EXAMPLE2uq.us-east-2.cs.amazonlightsail.com\n

\n

The following are the requirements for container service names:

\n ", - "smithy.api#required": {} - } - }, - "power": { - "target": "com.amazonaws.lightsail#ContainerServicePowerName", - "traits": { - "smithy.api#documentation": "

The power specification for the container service.

\n

The power specifies the amount of memory, vCPUs, and base monthly cost of each node of the\n container service. The power and scale of a container service makes\n up its configured capacity. To determine the monthly price of your container service, multiply\n the base price of the power with the scale (the number of nodes) of\n the service.

\n

Use the GetContainerServicePowers action to get a list of power options that\n you can specify using this parameter, and their base monthly cost.

", - "smithy.api#required": {} - } - }, - "scale": { - "target": "com.amazonaws.lightsail#ContainerServiceScale", - "traits": { - "smithy.api#documentation": "

The scale specification for the container service.

\n

The scale specifies the allocated compute nodes of the container service. The\n power and scale of a container service makes up its configured\n capacity. To determine the monthly price of your container service, multiply the base price of\n the power with the scale (the number of nodes) of the\n service.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the container service during create.

\n

Use the TagResource action to tag a resource after it's created.

\n

For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

" - } - }, - "publicDomainNames": { - "target": "com.amazonaws.lightsail#ContainerServicePublicDomains", - "traits": { - "smithy.api#documentation": "

The public domain names to use with the container service, such as\n example.com and www.example.com.

\n

You can specify up to four public domain names for a container service. The domain names\n that you specify are used when you create a deployment with a container configured as the\n public endpoint of your container service.

\n

If you don't specify public domain names, then you can use the default domain of the\n container service.

\n \n

You must create and validate an SSL/TLS certificate before you can use public domain\n names with your container service. Use the CreateCertificate action to create a\n certificate for the public domain names you want to use with your container service.

\n \n

You can specify public domain names using a string to array map as shown in the example\n later on this page.

" - } - }, - "deployment": { - "target": "com.amazonaws.lightsail#ContainerServiceDeploymentRequest", - "traits": { - "smithy.api#documentation": "

An object that describes a deployment for the container service.

\n

A deployment specifies the containers that will be launched on the container service and\n their settings, such as the ports to open, the environment variables to apply, and the launch\n command to run. It also specifies the container that will serve as the public endpoint of the\n deployment and its settings, such as the HTTP or HTTPS port to use, and the health check\n configuration.

" - } - }, - "privateRegistryAccess": { - "target": "com.amazonaws.lightsail#PrivateRegistryAccessRequest", - "traits": { - "smithy.api#documentation": "

An object to describe the configuration for the container service to access private\n container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private\n repositories.

\n

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#CreateContainerServiceResult": { - "type": "structure", - "members": { - "containerService": { - "target": "com.amazonaws.lightsail#ContainerService", - "traits": { - "smithy.api#documentation": "

An object that describes a container service.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateDisk": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateDiskRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateDiskResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a block storage disk that can be attached to an Amazon Lightsail instance in the\n same Availability Zone (e.g., us-east-2a).

\n

The create disk operation supports tag-based access control via request tags.\n For more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateDisk", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateDiskFromSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateDiskFromSnapshotRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateDiskFromSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting\n disk can be attached to an Amazon Lightsail instance in the same Availability Zone (e.g.,\n us-east-2a).

\n

The create disk from snapshot operation supports tag-based access control via\n request tags and resource tags applied to the resource identified by disk snapshot\n name. For more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateDiskFromSnapshot", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateDiskFromSnapshotRequest": { - "type": "structure", - "members": { - "diskName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The unique Lightsail disk name (e.g., my-disk).

", - "smithy.api#required": {} - } - }, - "diskSnapshotName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the disk snapshot (e.g., my-snapshot) from which to create the\n new storage disk.

\n

Constraint:

\n " - } - }, - "availabilityZone": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Availability Zone where you want to create the disk (e.g., us-east-2a).\n Choose the same Availability Zone as the Lightsail instance where you want to create the\n disk.

\n

Use the GetRegions operation to list the Availability Zones where Lightsail is currently\n available.

", - "smithy.api#required": {} - } - }, - "sizeInGb": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The size of the disk in GB (e.g., 32).

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" - } - }, - "addOns": { - "target": "com.amazonaws.lightsail#AddOnRequestList", - "traits": { - "smithy.api#documentation": "

An array of objects that represent the add-ons to enable for the new disk.

" - } - }, - "sourceDiskName": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The name of the source disk from which the source automatic snapshot was created.

\n

Constraints:

\n " - } - }, - "restoreDate": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The date of the automatic snapshot to use for the new disk. Use the get auto\n snapshots operation to identify the dates of the available automatic\n snapshots.

\n

Constraints:

\n " - } - }, - "useLatestRestorableAutoSnapshot": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value to indicate whether to use the latest available automatic snapshot.

\n

Constraints:

\n " - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#CreateDiskFromSnapshotResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateDiskRequest": { - "type": "structure", - "members": { - "diskName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The unique Lightsail disk name (e.g., my-disk).

", - "smithy.api#required": {} - } - }, - "availabilityZone": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Availability Zone where you want to create the disk (e.g., us-east-2a).\n Use the same Availability Zone as the Lightsail instance to which you want to attach the\n disk.

\n

Use the get regions operation to list the Availability Zones where\n Lightsail is currently available.

", - "smithy.api#required": {} - } - }, - "sizeInGb": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The size of the disk in GB (e.g., 32).

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" - } - }, - "addOns": { - "target": "com.amazonaws.lightsail#AddOnRequestList", - "traits": { - "smithy.api#documentation": "

An array of objects that represent the add-ons to enable for the new disk.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#CreateDiskResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateDiskSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateDiskSnapshotRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateDiskSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a snapshot of a block storage disk. You can use snapshots for backups, to make\n copies of disks, and to save data before shutting down a Lightsail instance.

\n

You can take a snapshot of an attached disk that is in use; however, snapshots only\n capture data that has been written to your disk at the time the snapshot command is issued.\n This may exclude any data that has been cached by any applications or the operating system. If\n you can pause any file systems on the disk long enough to take a snapshot, your snapshot\n should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should\n unmount the disk from within the Lightsail instance, issue the create disk snapshot command,\n and then remount the disk to ensure a consistent and complete snapshot. You may remount and\n use your disk while the snapshot status is pending.

\n

You can also use this operation to create a snapshot of an instance's system volume. You\n might want to do this, for example, to recover data from the system volume of a botched\n instance or to create a backup of the system volume like you would for a block storage disk.\n To create a snapshot of a system volume, just define the instance name parameter\n when issuing the snapshot command, and a snapshot of the defined instance's system volume will\n be created. After the snapshot is available, you can create a block storage disk from the\n snapshot and attach it to a running instance to access the data on the disk.

\n

The create disk snapshot operation supports tag-based access control via\n request tags. For more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateDiskSnapshot", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateDiskSnapshotRequest": { - "type": "structure", - "members": { - "diskName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The unique name of the source disk (e.g., Disk-Virginia-1).

\n \n

This parameter cannot be defined together with the instance name parameter.\n The disk name and instance name parameters are mutually\n exclusive.

\n " - } - }, - "diskSnapshotName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the destination disk snapshot (e.g., my-disk-snapshot) based on\n the source disk.

", - "smithy.api#required": {} - } - }, - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The unique name of the source instance (e.g., Amazon_Linux-512MB-Virginia-1).\n When this is defined, a snapshot of the instance's system volume is created.

\n \n

This parameter cannot be defined together with the disk name parameter. The\n instance name and disk name parameters are mutually\n exclusive.

\n " - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#CreateDiskSnapshotResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateDistribution": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateDistributionRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateDistributionResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an Amazon Lightsail content delivery network (CDN) distribution.

\n

A distribution is a globally distributed network of caching servers that improve the\n performance of your website or web application hosted on a Lightsail instance. For more\n information, see Content delivery networks in Amazon Lightsail.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateDistribution", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateDistributionRequest": { - "type": "structure", - "members": { - "distributionName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name for the distribution.

", - "smithy.api#required": {} - } - }, - "origin": { - "target": "com.amazonaws.lightsail#InputOrigin", - "traits": { - "smithy.api#documentation": "

An object that describes the origin resource for the distribution, such as a Lightsail\n instance, bucket, or load balancer.

\n

The distribution pulls, caches, and serves content from the origin.

", - "smithy.api#required": {} - } - }, - "defaultCacheBehavior": { - "target": "com.amazonaws.lightsail#CacheBehavior", - "traits": { - "smithy.api#documentation": "

An object that describes the default cache behavior for the distribution.

", - "smithy.api#required": {} - } - }, - "cacheBehaviorSettings": { - "target": "com.amazonaws.lightsail#CacheSettings", - "traits": { - "smithy.api#documentation": "

An object that describes the cache behavior settings for the distribution.

" - } - }, - "cacheBehaviors": { - "target": "com.amazonaws.lightsail#CacheBehaviorList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the per-path cache behavior for the distribution.

" - } - }, - "bundleId": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The bundle ID to use for the distribution.

\n

A distribution bundle describes the specifications of your distribution, such as the\n monthly cost and monthly network transfer quota.

\n

Use the GetDistributionBundles action to get a list of distribution bundle\n IDs that you can specify.

", - "smithy.api#required": {} - } - }, - "ipAddressType": { - "target": "com.amazonaws.lightsail#IpAddressType", - "traits": { - "smithy.api#documentation": "

The IP address type for the distribution.

\n

The possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.

\n

The default value is dualstack.

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the distribution during create.

\n

Use the TagResource action to tag a resource after it's created.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#CreateDistributionResult": { - "type": "structure", - "members": { - "distribution": { - "target": "com.amazonaws.lightsail#LightsailDistribution", - "traits": { - "smithy.api#documentation": "

An object that describes the distribution created.

" - } - }, - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateDomain": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateDomainRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateDomainResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

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

\n

The create domain operation supports tag-based access control via request\n tags. For more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateDomain", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateDomainEntry": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateDomainEntryRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateDomainEntryResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates one of the following domain name system (DNS) records in a domain DNS zone:\n Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority\n (SOA), service locator (SRV), or text (TXT).

\n

The create domain entry operation supports tag-based access control via\n resource tags applied to the resource identified by domain name. For more\n information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateDomainEntry", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateDomainEntryRequest": { - "type": "structure", - "members": { - "domainName": { - "target": "com.amazonaws.lightsail#DomainName", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - }, - "domainEntry": { - "target": "com.amazonaws.lightsail#DomainEntry", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#CreateDomainEntryResult": { - "type": "structure", - "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateDomainRequest": { - "type": "structure", - "members": { - "domainName": { - "target": "com.amazonaws.lightsail#DomainName", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#CreateDomainResult": { - "type": "structure", - "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateGUISessionAccessDetails": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateGUISessionAccessDetailsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateGUISessionAccessDetailsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates two URLs that are used to access a virtual computer’s graphical user interface (GUI)\n session. The primary URL initiates a web-based NICE DCV session to the virtual computer's application. The secondary URL initiates a web-based NICE DCV session to the virtual computer's operating session.

\n

Use StartGUISession to open the session.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/create-gui-session-access-details", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateGUISessionAccessDetailsRequest": { - "type": "structure", - "members": { - "resourceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The resource name.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#CreateGUISessionAccessDetailsResult": { - "type": "structure", - "members": { - "resourceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The resource name.

" - } - }, - "status": { - "target": "com.amazonaws.lightsail#Status", - "traits": { - "smithy.api#documentation": "

The status of the operation.

" - } - }, - "percentageComplete": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The percentage of completion for the operation.

" - } - }, - "failureReason": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The reason the operation failed.

" - } - }, - "sessions": { - "target": "com.amazonaws.lightsail#Sessions", - "traits": { - "smithy.api#documentation": "

Returns information about the specified NICE DCV GUI session.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateInstanceSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateInstanceSnapshotRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateInstanceSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

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

\n

The create instance snapshot operation supports tag-based access control via\n request tags. For more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateInstanceSnapshot", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateInstanceSnapshotRequest": { - "type": "structure", - "members": { - "instanceSnapshotName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name for your new snapshot.

", - "smithy.api#required": {} - } - }, - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The Lightsail instance on which to base your snapshot.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#CreateInstanceSnapshotResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateInstancesRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateInstancesResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates one or more Amazon Lightsail instances.

\n

The create instances operation supports tag-based access control via request\n tags. For more information, see the Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateInstances", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateInstancesFromSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateInstancesFromSnapshotRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateInstancesFromSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates one or more new instances from a manual or automatic snapshot of an\n instance.

\n

The create instances from snapshot operation supports tag-based access\n control via request tags and resource tags applied to the resource identified by\n instance snapshot name. For more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateInstancesFromSnapshot", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateInstancesFromSnapshotRequest": { - "type": "structure", - "members": { - "instanceNames": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

The names for your new instances.

", - "smithy.api#required": {} - } - }, - "attachedDiskMapping": { - "target": "com.amazonaws.lightsail#AttachedDiskMap", - "traits": { - "smithy.api#documentation": "

An object containing information about one or more disk mappings.

" - } - }, - "availabilityZone": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The Availability Zone where you want to create your instances. Use the following\n formatting: us-east-2a (case sensitive). You can get a list of Availability Zones\n by using the get\n regions operation. Be sure to add the include Availability Zones\n parameter to your request.

", - "smithy.api#required": {} - } - }, - "instanceSnapshotName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

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

\n

Constraint:

\n " - } - }, - "bundleId": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - }, - "userData": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

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

\n \n

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

\n " - } - }, - "keyPairName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name for your key pair.

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" - } - }, - "addOns": { - "target": "com.amazonaws.lightsail#AddOnRequestList", - "traits": { - "smithy.api#documentation": "

An array of objects representing the add-ons to enable for the new instance.

" - } - }, - "ipAddressType": { - "target": "com.amazonaws.lightsail#IpAddressType", - "traits": { - "smithy.api#documentation": "

The IP address type for the instance.

\n

The possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.

\n

The default value is dualstack.

" - } - }, - "sourceInstanceName": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The name of the source instance from which the source automatic snapshot was\n created.

\n

Constraints:

\n " - } - }, - "restoreDate": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The date of the automatic snapshot to use for the new instance. Use the get auto\n snapshots operation to identify the dates of the available automatic\n snapshots.

\n

Constraints:

\n " - } - }, - "useLatestRestorableAutoSnapshot": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value to indicate whether to use the latest available automatic snapshot.

\n

Constraints:

\n " - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#CreateInstancesFromSnapshotResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateInstancesRequest": { - "type": "structure", - "members": { - "instanceNames": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - }, - "availabilityZone": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The Availability Zone in which to create your instance. Use the following format:\n us-east-2a (case sensitive). You can get a list of Availability Zones by using\n the get\n regions operation. Be sure to add the include Availability Zones\n parameter to your request.

", - "smithy.api#required": {} - } - }, - "customImageName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

(Deprecated) The name for your custom image.

\n \n

In releases prior to June 12, 2017, this parameter was ignored by the API. It is now\n deprecated.

\n " - } - }, - "blueprintId": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

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

\n \n

Use active blueprints when creating new instances. Inactive blueprints are listed to\n support customers with existing instances and are not necessarily available to create new\n instances. Blueprints are marked inactive when they become outdated due to operating system\n updates or new application releases.

\n ", - "smithy.api#required": {} - } - }, - "bundleId": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - }, - "userData": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

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

\n \n

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

\n " - } - }, - "keyPairName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of your key pair.

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" - } - }, - "addOns": { - "target": "com.amazonaws.lightsail#AddOnRequestList", - "traits": { - "smithy.api#documentation": "

An array of objects representing the add-ons to enable for the new instance.

" - } - }, - "ipAddressType": { - "target": "com.amazonaws.lightsail#IpAddressType", - "traits": { - "smithy.api#documentation": "

The IP address type for the instance.

\n

The possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.

\n

The default value is dualstack.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#CreateInstancesResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateKeyPair": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateKeyPairRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateKeyPairResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a custom SSH key pair that you can use with an Amazon Lightsail\n instance.

\n \n

Use the DownloadDefaultKeyPair action to create a Lightsail default key\n pair in an Amazon Web Services Region where a default key pair does not currently\n exist.

\n \n

The create key pair operation supports tag-based access control via request\n tags. For more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateKeyPair", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateKeyPairRequest": { - "type": "structure", - "members": { - "keyPairName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name for your new key pair.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#CreateKeyPairResult": { - "type": "structure", - "members": { - "keyPair": { - "target": "com.amazonaws.lightsail#KeyPair", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "publicKeyBase64": { - "target": "com.amazonaws.lightsail#Base64", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "privateKeyBase64": { - "target": "com.amazonaws.lightsail#Base64", - "traits": { - "smithy.api#documentation": "

A base64-encoded RSA private key.

" - } - }, - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateLoadBalancer": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateLoadBalancerRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateLoadBalancerResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a Lightsail load balancer. To learn more about deciding whether to load balance\n your application, see Configure your Lightsail instances for load balancing. You can create up to 5\n load balancers per AWS Region in your account.

\n

When you create a load balancer, you can specify a unique name and port settings. To\n change additional load balancer settings, use the UpdateLoadBalancerAttribute\n operation.

\n

The create load balancer operation supports tag-based access control via\n request tags. For more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateLoadBalancer", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateLoadBalancerRequest": { - "type": "structure", - "members": { - "loadBalancerName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of your load balancer.

", - "smithy.api#required": {} - } - }, - "instancePort": { - "target": "com.amazonaws.lightsail#Port", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The instance port where you're creating your load balancer.

", - "smithy.api#required": {} - } - }, - "healthCheckPath": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The path you provided to perform the load balancer health check. If you didn't specify a\n health check path, Lightsail uses the root path of your website (e.g.,\n \"/\").

\n

You may want to specify a custom health check path other than the root of your application\n if your home page loads slowly or has a lot of media or scripting on it.

" - } - }, - "certificateName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the SSL/TLS certificate.

\n

If you specify certificateName, then certificateDomainName is\n required (and vice-versa).

" - } - }, - "certificateDomainName": { - "target": "com.amazonaws.lightsail#DomainName", - "traits": { - "smithy.api#documentation": "

The domain name with which your certificate is associated (e.g.,\n example.com).

\n

If you specify certificateDomainName, then certificateName is\n required (and vice-versa).

" - } - }, - "certificateAlternativeNames": { - "target": "com.amazonaws.lightsail#DomainNameList", - "traits": { - "smithy.api#documentation": "

The optional alternative domains and subdomains to use with your SSL/TLS certificate\n (e.g., www.example.com, example.com, m.example.com,\n blog.example.com).

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" - } - }, - "ipAddressType": { - "target": "com.amazonaws.lightsail#IpAddressType", - "traits": { - "smithy.api#documentation": "

The IP address type for the load balancer.

\n

The possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.

\n

The default value is dualstack.

" - } - }, - "tlsPolicyName": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The name of the TLS policy to apply to the load balancer.

\n

Use the GetLoadBalancerTlsPolicies action to get a list of TLS policy names that you can\n specify.

\n

For more information about load balancer TLS policies, see Configuring TLS security policies on your Amazon Lightsail load\n balancers in the Amazon Lightsail Developer Guide.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#CreateLoadBalancerResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateLoadBalancerTlsCertificate": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateLoadBalancerTlsCertificateRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateLoadBalancerTlsCertificateResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.

\n

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

\n

The CreateLoadBalancerTlsCertificate operation supports tag-based access\n control via resource tags applied to the resource identified by load balancer\n name. For more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateLoadBalancerTlsCertificate", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateLoadBalancerTlsCertificateRequest": { - "type": "structure", - "members": { - "loadBalancerName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The load balancer name where you want to create the SSL/TLS certificate.

", - "smithy.api#required": {} - } - }, - "certificateName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The SSL/TLS certificate name.

\n

You can have up to 10 certificates in your account at one time. Each Lightsail load\n balancer can have up to 2 certificates associated with it at one time. There is also an\n overall limit to the number of certificates that can be issue in a 365-day period. For more\n information, see Limits.

", - "smithy.api#required": {} - } - }, - "certificateDomainName": { - "target": "com.amazonaws.lightsail#DomainName", - "traits": { - "smithy.api#documentation": "

The domain name (e.g., example.com) for your SSL/TLS certificate.

", - "smithy.api#required": {} - } - }, - "certificateAlternativeNames": { - "target": "com.amazonaws.lightsail#DomainNameList", - "traits": { - "smithy.api#documentation": "

An array of strings listing alternative domains and subdomains for your SSL/TLS\n certificate. Lightsail will de-dupe the names for you. You can have a maximum of 9\n alternative names (in addition to the 1 primary domain). We do not support wildcards (e.g.,\n *.example.com).

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#CreateLoadBalancerTlsCertificateResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateRelationalDatabase": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateRelationalDatabaseRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateRelationalDatabaseResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new database in Amazon Lightsail.

\n

The create relational database operation supports tag-based access control\n via request tags. For more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateRelationalDatabase", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateRelationalDatabaseFromSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateRelationalDatabaseFromSnapshotRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateRelationalDatabaseFromSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new database from an existing database snapshot in Amazon Lightsail.

\n

You can create a new database from a snapshot in if something goes wrong with your\n original database, or to change it to a different plan, such as a high availability or\n standard plan.

\n

The create relational database from snapshot operation supports tag-based\n access control via request tags and resource tags applied to the resource identified by\n relationalDatabaseSnapshotName. For more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateRelationalDatabaseFromSnapshot", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateRelationalDatabaseFromSnapshotRequest": { - "type": "structure", - "members": { - "relationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name to use for your new Lightsail database resource.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - }, - "availabilityZone": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The Availability Zone in which to create your new database. Use the\n us-east-2a case-sensitive format.

\n

You can get a list of Availability Zones by using the get regions operation.\n Be sure to add the include relational database Availability Zones parameter to\n your request.

" - } - }, - "publiclyAccessible": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

Specifies the accessibility options for your new database. A value of true\n specifies a database that is available to resources outside of your Lightsail account. A\n value of false specifies a database that is available only to your Lightsail\n resources in the same region as your database.

" - } - }, - "relationalDatabaseSnapshotName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the database snapshot from which to create your new database.

" - } - }, - "relationalDatabaseBundleId": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The bundle ID for your new database. A bundle describes the performance specifications for\n your database.

\n

You can get a list of database bundle IDs by using the get relational database\n bundles operation.

\n

When creating a new database from a snapshot, you cannot choose a bundle that is smaller\n than the bundle of the source database.

" - } - }, - "sourceRelationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the source database.

" - } - }, - "restoreTime": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The date and time to restore your database from.

\n

Constraints:

\n " - } - }, - "useLatestRestorableTime": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether your database is restored from the latest backup time. A value of\n true restores from the latest backup time.

\n

Default: false\n

\n

Constraints: Cannot be specified if the restore time parameter is\n provided.

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#CreateRelationalDatabaseFromSnapshotResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateRelationalDatabaseRequest": { - "type": "structure", - "members": { - "relationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name to use for your new Lightsail database resource.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - }, - "availabilityZone": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The Availability Zone in which to create your new database. Use the\n us-east-2a case-sensitive format.

\n

You can get a list of Availability Zones by using the get regions operation.\n Be sure to add the include relational database Availability Zones parameter to\n your request.

" - } - }, - "relationalDatabaseBlueprintId": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The blueprint ID for your new database. A blueprint describes the major engine version of\n a database.

\n

You can get a list of database blueprints IDs by using the get relational database\n blueprints operation.

", - "smithy.api#required": {} - } - }, - "relationalDatabaseBundleId": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The bundle ID for your new database. A bundle describes the performance specifications for\n your database.

\n

You can get a list of database bundle IDs by using the get relational database\n bundles operation.

", - "smithy.api#required": {} - } - }, - "masterDatabaseName": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The meaning of this parameter differs according to the database engine you use.

\n

\n MySQL\n

\n

The name of the database to create when the Lightsail database resource is created. If\n this parameter isn't specified, no database is created in the database resource.

\n

Constraints:

\n \n

\n PostgreSQL\n

\n

The name of the database to create when the Lightsail database resource is created. If\n this parameter isn't specified, a database named postgres is created in the\n database resource.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - }, - "masterUsername": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The name for the master user.

\n

\n MySQL\n

\n

Constraints:

\n \n

\n PostgreSQL\n

\n

Constraints:

\n ", - "smithy.api#required": {} - } - }, - "masterUserPassword": { - "target": "com.amazonaws.lightsail#SensitiveString", - "traits": { - "smithy.api#documentation": "

The password for the master user. The password can include any printable ASCII character\n except \"/\", \"\"\", or \"@\". It cannot contain spaces.

\n

\n MySQL\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n PostgreSQL\n

\n

Constraints: Must contain from 8 to 128 characters.

" - } - }, - "preferredBackupWindow": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The daily time range during which automated backups are created for your new database if\n automated backups are enabled.

\n

The default is a 30-minute window selected at random from an 8-hour block of time for each\n AWS Region. For more information about the preferred backup window time blocks for each\n region, see the Working With Backups guide in the Amazon Relational Database Service documentation.

\n

Constraints:

\n " - } - }, - "preferredMaintenanceWindow": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The weekly time range during which system maintenance can occur on your new\n database.

\n

The default is a 30-minute window selected at random from an 8-hour block of time for each\n AWS Region, occurring on a random day of the week.

\n

Constraints:

\n " - } - }, - "publiclyAccessible": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

Specifies the accessibility options for your new database. A value of true\n specifies a database that is available to resources outside of your Lightsail account. A\n value of false specifies a database that is available only to your Lightsail\n resources in the same region as your database.

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#CreateRelationalDatabaseResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateRelationalDatabaseSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateRelationalDatabaseSnapshotRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateRelationalDatabaseSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups,\n to make copies of a database, and to save data before deleting a database.

\n

The create relational database snapshot operation supports tag-based access\n control via request tags. For more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateRelationalDatabaseSnapshot", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateRelationalDatabaseSnapshotRequest": { - "type": "structure", - "members": { - "relationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the database on which to base your new snapshot.

", - "smithy.api#required": {} - } - }, - "relationalDatabaseSnapshotName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name for your new database snapshot.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#CreateRelationalDatabaseSnapshotResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#Currency": { - "type": "enum", - "members": { - "USD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "USD" - } - } - } - }, - "com.amazonaws.lightsail#DeleteAlarm": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteAlarmRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteAlarmResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an alarm.

\n

An alarm is used to monitor a single metric for one of your resources. When a metric\n condition is met, the alarm can notify you by email, SMS text message, and a banner displayed\n on the Amazon Lightsail console. For more information, see Alarms\n in Amazon Lightsail.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/ls/api/2016-11-28/DeleteAlarm", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DeleteAlarmRequest": { - "type": "structure", - "members": { - "alarmName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the alarm to delete.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#DeleteAlarmResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteAutoSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteAutoSnapshotRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteAutoSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an automatic snapshot of an instance or disk. For more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DeleteAutoSnapshot", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DeleteAutoSnapshotRequest": { - "type": "structure", - "members": { - "resourceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the source instance or disk from which to delete the automatic\n snapshot.

", - "smithy.api#required": {} - } - }, - "date": { - "target": "com.amazonaws.lightsail#AutoSnapshotDate", - "traits": { - "smithy.api#documentation": "

The date of the automatic snapshot to delete in YYYY-MM-DD format. Use the\n get auto snapshots operation to get the available automatic snapshots for a\n resource.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#DeleteAutoSnapshotResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteBucket": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteBucketRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteBucketResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a Amazon Lightsail bucket.

\n \n

When you delete your bucket, the bucket name is released and can be reused for a new\n bucket in your account or another Amazon Web Services account.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DeleteBucket", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DeleteBucketAccessKey": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteBucketAccessKeyRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteBucketAccessKeyResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an access key for the specified Amazon Lightsail bucket.

\n

We recommend that you delete an access key if the secret access key is compromised.

\n

For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DeleteBucketAccessKey", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DeleteBucketAccessKeyRequest": { - "type": "structure", - "members": { - "bucketName": { - "target": "com.amazonaws.lightsail#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket that the access key belongs to.

", - "smithy.api#required": {} - } - }, - "accessKeyId": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the access key to delete.

\n

Use the GetBucketAccessKeys action to get a\n list of access key IDs that you can specify.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#DeleteBucketAccessKeyResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteBucketRequest": { - "type": "structure", - "members": { - "bucketName": { - "target": "com.amazonaws.lightsail#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket to delete.

\n

Use the GetBuckets action to get a list of bucket names\n that you can specify.

", - "smithy.api#required": {} - } - }, - "forceDelete": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value that indicates whether to force delete the bucket.

\n

You must force delete the bucket if it has one of the following conditions:

\n \n \n

Force deleting a bucket might impact other resources that rely on the bucket, such as\n instances, distributions, or software that use the issued access keys.

\n " - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#DeleteBucketResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteCertificate": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteCertificateRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteCertificateResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN)\n distribution.

\n

Certificates that are currently attached to a distribution cannot be deleted. Use the\n DetachCertificateFromDistribution action to detach a certificate from a\n distribution.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DeleteCertificate", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DeleteCertificateRequest": { - "type": "structure", - "members": { - "certificateName": { - "target": "com.amazonaws.lightsail#CertificateName", - "traits": { - "smithy.api#documentation": "

The name of the certificate to delete.

\n

Use the GetCertificates action to get a list of certificate names that you\n can specify.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#DeleteCertificateResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteContactMethod": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteContactMethodRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteContactMethodResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a contact method.

\n

A contact method is used to send you notifications about your Amazon Lightsail resources.\n You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services\n Regions, and SMS text messages cannot be sent to some countries/regions. For more information,\n see Notifications in Amazon Lightsail.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DeleteContactMethod", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DeleteContactMethodRequest": { - "type": "structure", - "members": { - "protocol": { - "target": "com.amazonaws.lightsail#ContactProtocol", - "traits": { - "smithy.api#documentation": "

The protocol that will be deleted, such as Email or SMS (text\n messaging).

\n \n

To delete an Email and an SMS contact method if you added\n both, you must run separate DeleteContactMethod actions to delete each\n protocol.

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#DeleteContactMethodResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteContainerImage": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteContainerImageRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteContainerImageResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a container image that is registered to your Amazon Lightsail container\n service.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/ls/api/2016-11-28/container-services/{serviceName}/images/{image}", - "code": 204 - } - } - }, - "com.amazonaws.lightsail#DeleteContainerImageRequest": { - "type": "structure", - "members": { - "serviceName": { - "target": "com.amazonaws.lightsail#ContainerServiceName", - "traits": { - "smithy.api#documentation": "

The name of the container service for which to delete a registered container image.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "image": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The name of the container image to delete from the container service.

\n

Use the GetContainerImages action to get the name of the container images\n that are registered to a container service.

\n \n

Container images sourced from your Lightsail container service, that are registered\n and stored on your service, start with a colon (:). For example,\n :container-service-1.mystaticwebsite.1. Container images sourced from a\n public registry like Docker Hub don't start with a colon. For example,\n nginx:latest or nginx.

\n ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#DeleteContainerImageResult": { - "type": "structure", - "members": {} - }, - "com.amazonaws.lightsail#DeleteContainerService": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteContainerServiceRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteContainerServiceResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes your Amazon Lightsail container service.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/ls/api/2016-11-28/container-services/{serviceName}", - "code": 204 - } - } - }, - "com.amazonaws.lightsail#DeleteContainerServiceRequest": { - "type": "structure", - "members": { - "serviceName": { - "target": "com.amazonaws.lightsail#ContainerServiceName", - "traits": { - "smithy.api#documentation": "

The name of the container service to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#DeleteContainerServiceResult": { - "type": "structure", - "members": {} - }, - "com.amazonaws.lightsail#DeleteDisk": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteDiskRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteDiskResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the specified block storage disk. The disk must be in the available\n state (not attached to a Lightsail instance).

\n \n

The disk may remain in the deleting state for several minutes.

\n \n

The delete disk operation supports tag-based access control via resource tags\n applied to the resource identified by disk name. For more information, see the\n Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DeleteDisk", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DeleteDiskRequest": { - "type": "structure", - "members": { - "diskName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The unique name of the disk you want to delete (e.g., my-disk).

", - "smithy.api#required": {} - } - }, - "forceDeleteAddOns": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value to indicate whether to delete all add-ons for the disk.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#DeleteDiskResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteDiskSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteDiskSnapshotRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteDiskSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the specified disk snapshot.

\n

When you make periodic snapshots of a disk, the snapshots are incremental, and only the\n blocks on the device that have changed since your last snapshot are saved in the new snapshot.\n When you delete a snapshot, only the data not needed for any other snapshot is removed. So\n regardless of which prior snapshots have been deleted, all active snapshots will have access\n to all the information needed to restore the disk.

\n

The delete disk snapshot operation supports tag-based access control via\n resource tags applied to the resource identified by disk snapshot name. For more\n information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DeleteDiskSnapshot", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DeleteDiskSnapshotRequest": { - "type": "structure", - "members": { - "diskSnapshotName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the disk snapshot you want to delete (e.g.,\n my-disk-snapshot).

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#DeleteDiskSnapshotResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteDistribution": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteDistributionRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteDistributionResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes your Amazon Lightsail content delivery network (CDN) distribution.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DeleteDistribution", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DeleteDistributionRequest": { - "type": "structure", - "members": { - "distributionName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the distribution to delete.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#DeleteDistributionResult": { - "type": "structure", - "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An object that describes the result of the action, such as the status of the request, the\n timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteDomain": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteDomainRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteDomainResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

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

\n

The delete domain operation supports tag-based access control via resource\n tags applied to the resource identified by domain name. For more information, see\n the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DeleteDomain", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DeleteDomainEntry": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteDomainEntryRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteDomainEntryResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a specific domain entry.

\n

The delete domain entry operation supports tag-based access control via\n resource tags applied to the resource identified by domain name. For more\n information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DeleteDomainEntry", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DeleteDomainEntryRequest": { - "type": "structure", - "members": { - "domainName": { - "target": "com.amazonaws.lightsail#DomainName", - "traits": { - "smithy.api#documentation": "

The name of the domain entry to delete.

", - "smithy.api#required": {} - } - }, - "domainEntry": { - "target": "com.amazonaws.lightsail#DomainEntry", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#DeleteDomainEntryResult": { - "type": "structure", - "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteDomainRequest": { - "type": "structure", - "members": { - "domainName": { - "target": "com.amazonaws.lightsail#DomainName", - "traits": { - "smithy.api#documentation": "

The specific domain name to delete.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#DeleteDomainResult": { - "type": "structure", - "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteInstanceRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteInstanceResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an Amazon Lightsail instance.

\n

The delete instance operation supports tag-based access control via resource\n tags applied to the resource identified by instance name. For more information,\n see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DeleteInstance", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DeleteInstanceRequest": { - "type": "structure", - "members": { - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the instance to delete.

", - "smithy.api#required": {} - } - }, - "forceDeleteAddOns": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value to indicate whether to delete all add-ons for the instance.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#DeleteInstanceResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteInstanceSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteInstanceSnapshotRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteInstanceSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

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

\n

The delete instance snapshot operation supports tag-based access control via\n resource tags applied to the resource identified by instance snapshot name. For\n more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DeleteInstanceSnapshot", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DeleteInstanceSnapshotRequest": { - "type": "structure", - "members": { - "instanceSnapshotName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the snapshot to delete.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#DeleteInstanceSnapshotResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteKeyPair": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteKeyPairRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteKeyPairResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the specified key pair by removing the public key from Amazon Lightsail.

\n

You can delete key pairs that were created using the ImportKeyPair and\n CreateKeyPair actions, as well as the Lightsail default key pair. A new default\n key pair will not be created unless you launch an instance without specifying a custom key\n pair, or you call the DownloadDefaultKeyPair API.

\n

The delete key pair operation supports tag-based access control via resource\n tags applied to the resource identified by key pair name. For more information,\n see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DeleteKeyPair", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DeleteKeyPairRequest": { - "type": "structure", - "members": { - "keyPairName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the key pair to delete.

", - "smithy.api#required": {} - } - }, - "expectedFingerprint": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The RSA fingerprint of the Lightsail default key pair to delete.

\n \n

The expectedFingerprint parameter is required only when specifying to\n delete a Lightsail default key pair.

\n " - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#DeleteKeyPairResult": { - "type": "structure", - "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteKnownHostKeys": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteKnownHostKeysRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteKnownHostKeysResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or\n RDP clients to authenticate an instance. This operation enables the Lightsail browser-based\n SSH or RDP clients to connect to the instance after a host key mismatch.

\n \n

Perform this operation only if you were expecting the host key or certificate mismatch\n or if you are familiar with the new host key or certificate on the instance. For more\n information, see Troubleshooting connection issues when using the Amazon Lightsail browser-based SSH or RDP\n client.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DeleteKnownHostKeys", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DeleteKnownHostKeysRequest": { - "type": "structure", - "members": { - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the instance for which you want to reset the host key or certificate.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#DeleteKnownHostKeysResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteLoadBalancer": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteLoadBalancerRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteLoadBalancerResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a Lightsail load balancer and all its associated SSL/TLS certificates. Once the\n load balancer is deleted, you will need to create a new load balancer, create a new\n certificate, and verify domain ownership again.

\n

The delete load balancer operation supports tag-based access control via\n resource tags applied to the resource identified by load balancer name. For more\n information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DeleteLoadBalancer", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DeleteLoadBalancerRequest": { - "type": "structure", - "members": { - "loadBalancerName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the load balancer you want to delete.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#DeleteLoadBalancerResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteLoadBalancerTlsCertificate": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteLoadBalancerTlsCertificateRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteLoadBalancerTlsCertificateResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an SSL/TLS certificate associated with a Lightsail load balancer.

\n

The DeleteLoadBalancerTlsCertificate operation supports tag-based access\n control via resource tags applied to the resource identified by load balancer\n name. For more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DeleteLoadBalancerTlsCertificate", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DeleteLoadBalancerTlsCertificateRequest": { - "type": "structure", - "members": { - "loadBalancerName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The load balancer name.

", - "smithy.api#required": {} - } - }, - "certificateName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The SSL/TLS certificate name.

", - "smithy.api#required": {} - } - }, - "force": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

When true, forces the deletion of an SSL/TLS certificate.

\n

There can be two certificates associated with a Lightsail load balancer: the primary and\n the backup. The force parameter is required when the primary SSL/TLS certificate\n is in use by an instance attached to the load balancer.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#DeleteLoadBalancerTlsCertificateResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteRelationalDatabase": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteRelationalDatabaseRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteRelationalDatabaseResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a database in Amazon Lightsail.

\n

The delete relational database operation supports tag-based access control\n via resource tags applied to the resource identified by relationalDatabaseName. For more\n information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DeleteRelationalDatabase", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DeleteRelationalDatabaseRequest": { - "type": "structure", - "members": { - "relationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the database that you are deleting.

", - "smithy.api#required": {} - } - }, - "skipFinalSnapshot": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

Determines whether a final database snapshot is created before your database is deleted.\n If true is specified, no database snapshot is created. If false is\n specified, a database snapshot is created before your database is deleted.

\n

You must specify the final relational database snapshot name parameter if the\n skip final snapshot parameter is false.

\n

Default: false\n

" - } - }, - "finalRelationalDatabaseSnapshotName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the database snapshot created if skip final snapshot is\n false, which is the default value for that parameter.

\n \n

Specifying this parameter and also specifying the skip final snapshot\n parameter to true results in an error.

\n \n

Constraints:

\n " - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#DeleteRelationalDatabaseResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteRelationalDatabaseSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteRelationalDatabaseSnapshotRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteRelationalDatabaseSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a database snapshot in Amazon Lightsail.

\n

The delete relational database snapshot operation supports tag-based access\n control via resource tags applied to the resource identified by relationalDatabaseName. For\n more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DeleteRelationalDatabaseSnapshot", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DeleteRelationalDatabaseSnapshotRequest": { - "type": "structure", - "members": { - "relationalDatabaseSnapshotName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the database snapshot that you are deleting.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#DeleteRelationalDatabaseSnapshotResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DestinationInfo": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the resource created at the destination.

" - } - }, - "service": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The destination service of the record.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the destination of a record.

" - } - }, - "com.amazonaws.lightsail#DetachCertificateFromDistribution": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DetachCertificateFromDistributionRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DetachCertificateFromDistributionResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN)\n distribution.

\n

After the certificate is detached, your distribution stops accepting traffic for all of\n the domains that are associated with the certificate.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DetachCertificateFromDistribution", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DetachCertificateFromDistributionRequest": { - "type": "structure", - "members": { - "distributionName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the distribution from which to detach the certificate.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#DetachCertificateFromDistributionResult": { - "type": "structure", - "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An object that describes the result of the action, such as the status of the request, the\n timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DetachDisk": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DetachDiskRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DetachDiskResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount\n any file systems on the device within your operating system before stopping the instance and\n detaching the disk.

\n

The detach disk operation supports tag-based access control via resource tags\n applied to the resource identified by disk name. For more information, see the\n Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DetachDisk", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DetachDiskRequest": { - "type": "structure", - "members": { - "diskName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The unique name of the disk you want to detach from your instance (e.g.,\n my-disk).

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#DetachDiskResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DetachInstancesFromLoadBalancer": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DetachInstancesFromLoadBalancerRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DetachInstancesFromLoadBalancerResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Detaches the specified instances from a Lightsail load balancer.

\n

This operation waits until the instances are no longer needed before they are detached\n from the load balancer.

\n

The detach instances from load balancer operation supports tag-based access\n control via resource tags applied to the resource identified by load balancer\n name. For more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DetachInstancesFromLoadBalancer", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DetachInstancesFromLoadBalancerRequest": { - "type": "structure", - "members": { - "loadBalancerName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the Lightsail load balancer.

", - "smithy.api#required": {} - } - }, - "instanceNames": { - "target": "com.amazonaws.lightsail#ResourceNameList", - "traits": { - "smithy.api#documentation": "

An array of strings containing the names of the instances you want to detach from the load\n balancer.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#DetachInstancesFromLoadBalancerResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DetachStaticIp": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DetachStaticIpRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DetachStaticIpResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DetachStaticIp", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DetachStaticIpRequest": { - "type": "structure", - "members": { - "staticIpName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#DetachStaticIpResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DisableAddOn": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DisableAddOnRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DisableAddOnResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Disables an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DisableAddOn", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DisableAddOnRequest": { - "type": "structure", - "members": { - "addOnType": { - "target": "com.amazonaws.lightsail#AddOnType", - "traits": { - "smithy.api#documentation": "

The add-on type to disable.

", - "smithy.api#required": {} - } - }, - "resourceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the source resource for which to disable the add-on.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#DisableAddOnResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#Disk": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The unique name of the disk.

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the disk.

" - } - }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The date when the disk was created.

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

The AWS Region and Availability Zone where the disk is located.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The Lightsail resource type (e.g., Disk).

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" - } - }, - "addOns": { - "target": "com.amazonaws.lightsail#AddOnList", - "traits": { - "smithy.api#documentation": "

An array of objects representing the add-ons enabled on the disk.

" - } - }, - "sizeInGb": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The size of the disk in GB.

" - } - }, - "isSystemDisk": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "iops": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "path": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The disk path.

" - } - }, - "state": { - "target": "com.amazonaws.lightsail#DiskState", - "traits": { - "smithy.api#documentation": "

Describes the status of the disk.

" - } - }, - "attachedTo": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The resources to which the disk is attached.

" - } - }, - "isAttached": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the disk is attached.

" - } - }, - "attachmentState": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

(Deprecated) The attachment state of the disk.

\n \n

In releases prior to November 14, 2017, this parameter returned attached\n for system disks in the API response. It is now deprecated, but still included in the\n response. Use isAttached instead.

\n " - } - }, - "gbInUse": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

(Deprecated) The number of GB in use by the disk.

\n \n

In releases prior to November 14, 2017, this parameter was not included in the API\n response. It is now deprecated.

\n " - } - }, - "autoMountStatus": { - "target": "com.amazonaws.lightsail#AutoMountStatus", - "traits": { - "smithy.api#documentation": "

The status of automatically mounting a storage disk to a virtual computer.

\n \n

This parameter only applies to Lightsail for Research resources.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a block storage disk.

" - } - }, - "com.amazonaws.lightsail#DiskInfo": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The disk name.

" - } - }, - "path": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The disk path.

" - } - }, - "sizeInGb": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The size of the disk in GB (e.g., 32).

" - } - }, - "isSystemDisk": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

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

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a disk.

" - } - }, - "com.amazonaws.lightsail#DiskInfoList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#DiskInfo" - } - }, - "com.amazonaws.lightsail#DiskList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#Disk" - } - }, - "com.amazonaws.lightsail#DiskMap": { - "type": "structure", - "members": { - "originalDiskPath": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The original disk path exposed to the instance (for example,\n /dev/sdh).

" - } - }, - "newDiskName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The new disk name (e.g., my-new-disk).

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a block storage disk mapping.

" - } - }, - "com.amazonaws.lightsail#DiskMapList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#DiskMap" - } - }, - "com.amazonaws.lightsail#DiskSnapshot": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the disk snapshot (e.g., my-disk-snapshot).

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the disk snapshot.

" - } - }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The date when the disk snapshot was created.

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

The AWS Region and Availability Zone where the disk snapshot was created.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The Lightsail resource type (e.g., DiskSnapshot).

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" - } - }, - "sizeInGb": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The size of the disk in GB.

" - } - }, - "state": { - "target": "com.amazonaws.lightsail#DiskSnapshotState", - "traits": { - "smithy.api#documentation": "

The status of the disk snapshot operation.

" - } - }, - "progress": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The progress of the snapshot.

" - } - }, - "fromDiskName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The unique name of the source disk from which the disk snapshot was created.

" - } - }, - "fromDiskArn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was\n created.

" - } - }, - "fromInstanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The unique name of the source instance from which the disk (system volume) snapshot was\n created.

" - } - }, - "fromInstanceArn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source instance from which the disk (system volume)\n snapshot was created.

" - } - }, - "isFromAutoSnapshot": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the snapshot was created from an automatic\n snapshot.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a block storage disk snapshot.

" - } - }, - "com.amazonaws.lightsail#DiskSnapshotInfo": { - "type": "structure", - "members": { - "sizeInGb": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The size of the disk in GB (e.g., 32).

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a disk snapshot.

" - } - }, - "com.amazonaws.lightsail#DiskSnapshotList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#DiskSnapshot" - } - }, - "com.amazonaws.lightsail#DiskSnapshotState": { - "type": "enum", - "members": { - "Pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "Completed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "completed" - } - }, - "Error": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "error" - } - }, - "Unknown": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unknown" - } - } - } - }, - "com.amazonaws.lightsail#DiskState": { - "type": "enum", - "members": { - "Pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "Error": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "error" - } - }, - "Available": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "available" - } - }, - "InUse": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "in-use" - } - }, - "Unknown": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unknown" - } - } - } - }, - "com.amazonaws.lightsail#DistributionBundle": { - "type": "structure", - "members": { - "bundleId": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The ID of the bundle.

" - } - }, - "name": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The name of the distribution bundle.

" - } - }, - "price": { - "target": "com.amazonaws.lightsail#float", - "traits": { - "smithy.api#documentation": "

The monthly price, in US dollars, of the bundle.

" - } - }, - "transferPerMonthInGb": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The monthly network transfer quota of the bundle.

" - } - }, - "isActive": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether the bundle is active, and can be specified for a new or existing\n distribution.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the specifications of a distribution bundle.

" - } - }, - "com.amazonaws.lightsail#DistributionBundleList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#DistributionBundle" - } - }, - "com.amazonaws.lightsail#DistributionList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#LightsailDistribution" - } - }, - "com.amazonaws.lightsail#DistributionMetricName": { - "type": "enum", - "members": { - "Requests": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Requests" - } - }, - "BytesDownloaded": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BytesDownloaded" - } - }, - "BytesUploaded": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BytesUploaded" - } - }, - "TotalErrorRate": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TotalErrorRate" - } - }, - "Http4xxErrorRate": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Http4xxErrorRate" - } - }, - "Http5xxErrorRate": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Http5xxErrorRate" - } - } - } - }, - "com.amazonaws.lightsail#DnsRecordCreationState": { - "type": "structure", - "members": { - "code": { - "target": "com.amazonaws.lightsail#DnsRecordCreationStateCode", - "traits": { - "smithy.api#documentation": "

The status code for the automated DNS record creation.

\n

Following are the possible values:

\n " - } - }, - "message": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The message that describes the reason for the status code.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the creation state of the canonical name (CNAME) records that are automatically\n added by Amazon Lightsail to the DNS of a domain to validate domain ownership for\n an SSL/TLS certificate.

\n

When you create an SSL/TLS certificate for a Lightsail resource, you must\n add a set of CNAME records to the DNS of the domains for the certificate to validate that you\n own the domains. Lightsail can automatically add the CNAME records to the DNS\n of the domain if the DNS zone for the domain exists within your Lightsail\n account. If automatic record addition fails, or if you manage the DNS of your domain using a\n third-party service, then you must manually add the CNAME records to the DNS of your domain.\n For more information, see Verify an SSL/TLS certificate in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

" - } - }, - "com.amazonaws.lightsail#DnsRecordCreationStateCode": { - "type": "enum", - "members": { - "Succeeded": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCEEDED" - } - }, - "Started": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STARTED" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - } - } - }, - "com.amazonaws.lightsail#Domain": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the domain.

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The date when the domain recordset was created.

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The resource type.

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" - } - }, - "domainEntries": { - "target": "com.amazonaws.lightsail#DomainEntryList", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "registeredDomainDelegationInfo": { - "target": "com.amazonaws.lightsail#RegisteredDomainDelegationInfo", - "traits": { - "smithy.api#documentation": "

An object that describes the state of the Route 53 domain delegation to a\n Lightsail DNS zone.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a domain where you are storing recordsets.

" - } - }, - "com.amazonaws.lightsail#DomainEntry": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the domain recordset entry.

" - } - }, - "name": { - "target": "com.amazonaws.lightsail#DomainName", - "traits": { - "smithy.api#documentation": "

The name of the domain.

" - } - }, - "target": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The target IP address (e.g., 192.0.2.0), or AWS name server (e.g.,\n ns-111.awsdns-22.com.).

\n

For Lightsail load balancers, the value looks like\n ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com. For\n Lightsail distributions, the value looks like exampled1182ne.cloudfront.net.\n For Lightsail container services, the value looks like\n container-service-1.example23scljs.us-west-2.cs.amazonlightsail.com. Be sure to\n also set isAlias to true when setting up an A record for a\n Lightsail load balancer, distribution, or container service.

" - } - }, - "isAlias": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

When true, specifies whether the domain entry is an alias used by the Lightsail load balancer, Lightsail container service, Lightsail content delivery network (CDN) distribution, or another Amazon Web Services\n resource. You can include an alias (A type) record in your request, which points to the DNS\n name of a load balancer, container service, CDN distribution, or other Amazon Web Services\n resource and routes traffic to that resource.

" - } - }, - "type": { - "target": "com.amazonaws.lightsail#DomainEntryType", - "traits": { - "smithy.api#documentation": "

The type of domain entry, such as address for IPv4 (A), address for IPv6 (AAAA), canonical\n name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator\n (SRV), or text (TXT).

\n

The following domain entry types can be used:

\n " - } - }, - "options": { - "target": "com.amazonaws.lightsail#DomainEntryOptions", - "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

(Deprecated) The options for the domain entry.

\n \n

In releases prior to November 29, 2017, this parameter was not included in the API\n response. It is now deprecated.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a domain recordset entry.

" - } - }, - "com.amazonaws.lightsail#DomainEntryList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#DomainEntry" - } - }, - "com.amazonaws.lightsail#DomainEntryOptions": { - "type": "map", - "key": { - "target": "com.amazonaws.lightsail#DomainEntryOptionsKeys" - }, - "value": { - "target": "com.amazonaws.lightsail#string" - } - }, - "com.amazonaws.lightsail#DomainEntryOptionsKeys": { - "type": "string" - }, - "com.amazonaws.lightsail#DomainEntryType": { - "type": "string" - }, - "com.amazonaws.lightsail#DomainList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#Domain" - } - }, - "com.amazonaws.lightsail#DomainName": { - "type": "string" - }, - "com.amazonaws.lightsail#DomainNameList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#DomainName" - } - }, - "com.amazonaws.lightsail#DomainValidationRecord": { - "type": "structure", - "members": { - "domainName": { - "target": "com.amazonaws.lightsail#DomainName", - "traits": { - "smithy.api#documentation": "

The domain name of the certificate validation record. For example,\n example.com or www.example.com.

" - } - }, - "resourceRecord": { - "target": "com.amazonaws.lightsail#ResourceRecord", - "traits": { - "smithy.api#documentation": "

An object that describes the DNS records to add to your domain's DNS to validate it for\n the certificate.

" - } - }, - "dnsRecordCreationState": { - "target": "com.amazonaws.lightsail#DnsRecordCreationState", - "traits": { - "smithy.api#documentation": "

An object that describes the state of the canonical name (CNAME) records that are\n automatically added by Lightsail to the DNS of the domain to validate domain\n ownership.

" - } - }, - "validationStatus": { - "target": "com.amazonaws.lightsail#CertificateDomainValidationStatus", - "traits": { - "smithy.api#documentation": "

The validation status of the record.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the domain name system (DNS) records that you must add to the DNS of your\n registered domain to validate ownership for an Amazon Lightsail SSL/TLS certificate.

" - } - }, - "com.amazonaws.lightsail#DomainValidationRecordList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#DomainValidationRecord" - } - }, - "com.amazonaws.lightsail#DownloadDefaultKeyPair": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DownloadDefaultKeyPairRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DownloadDefaultKeyPairResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Downloads the regional Amazon Lightsail default key pair.

\n

This action also creates a Lightsail default key pair if a default key pair\n does not currently exist in the Amazon Web Services Region.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DownloadDefaultKeyPair", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DownloadDefaultKeyPairRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#DownloadDefaultKeyPairResult": { - "type": "structure", - "members": { - "publicKeyBase64": { - "target": "com.amazonaws.lightsail#Base64", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "privateKeyBase64": { - "target": "com.amazonaws.lightsail#Base64", - "traits": { - "smithy.api#documentation": "

A base64-encoded RSA private key.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the default key pair was created.

" - } - } - } - }, - "com.amazonaws.lightsail#EligibleToRenew": { - "type": "string" - }, - "com.amazonaws.lightsail#EnableAddOn": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#EnableAddOnRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#EnableAddOnResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see\n the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/EnableAddOn", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#EnableAddOnRequest": { - "type": "structure", - "members": { - "resourceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the source resource for which to enable or modify the add-on.

", - "smithy.api#required": {} - } - }, - "addOnRequest": { - "target": "com.amazonaws.lightsail#AddOnRequest", - "traits": { - "smithy.api#documentation": "

An array of strings representing the add-on to enable or modify.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#EnableAddOnResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#EndpointRequest": { - "type": "structure", - "members": { - "containerName": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The name of the container for the endpoint.

", - "smithy.api#required": {} - } - }, - "containerPort": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The port of the container to which traffic is forwarded to.

", - "smithy.api#required": {} - } - }, - "healthCheck": { - "target": "com.amazonaws.lightsail#ContainerServiceHealthCheckConfig", - "traits": { - "smithy.api#documentation": "

An object that describes the health check configuration of the container.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the settings of a public endpoint for an Amazon Lightsail container\n service.

" - } - }, - "com.amazonaws.lightsail#Environment": { - "type": "map", - "key": { - "target": "com.amazonaws.lightsail#string" - }, - "value": { - "target": "com.amazonaws.lightsail#string" - } - }, - "com.amazonaws.lightsail#EstimateByTime": { - "type": "structure", - "members": { - "usageCost": { - "target": "com.amazonaws.lightsail#double", - "traits": { - "smithy.api#documentation": "

The amount of cost or usage that's measured for the cost estimate.

" - } - }, - "pricingUnit": { - "target": "com.amazonaws.lightsail#PricingUnit", - "traits": { - "smithy.api#documentation": "

The unit of measurement that's used for the cost estimate.

" - } - }, - "unit": { - "target": "com.amazonaws.lightsail#double", - "traits": { - "smithy.api#documentation": "

The number of pricing units used to calculate the total number of hours. For example, 1\n unit equals 1 hour.

" - } - }, - "currency": { - "target": "com.amazonaws.lightsail#Currency", - "traits": { - "smithy.api#documentation": "

The currency of the estimate in USD.

" - } - }, - "timePeriod": { - "target": "com.amazonaws.lightsail#TimePeriod", - "traits": { - "smithy.api#documentation": "

The period of time, in days, that an estimate covers. The period has a start date and an end date. The start date must come before the end date.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An estimate that's associated with a time period.

" - } - }, - "com.amazonaws.lightsail#EstimatesByTime": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#EstimateByTime" - } - }, - "com.amazonaws.lightsail#ExportSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#ExportSnapshotRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#ExportSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2).\n This operation results in an export snapshot record that can be used with the create\n cloud formation stack operation to create new Amazon EC2 instances.

\n

Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the\n instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in\n Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in\n Amazon EC2 as the source Lightsail snapshot.

\n

\n

The export snapshot operation supports tag-based access control via resource\n tags applied to the resource identified by source snapshot name. For more\n information, see the Amazon Lightsail Developer Guide.

\n \n

Use the get instance snapshots or get disk snapshots\n operations to get a list of snapshots that you can export to Amazon EC2.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/ExportSnapshot", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#ExportSnapshotRecord": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The export snapshot record name.

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the export snapshot record.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The date when the export snapshot record was created.

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

The AWS Region and Availability Zone where the export snapshot record is located.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The Lightsail resource type (e.g., ExportSnapshotRecord).

" - } - }, - "state": { - "target": "com.amazonaws.lightsail#RecordState", - "traits": { - "smithy.api#documentation": "

The state of the export snapshot record.

" - } - }, - "sourceInfo": { - "target": "com.amazonaws.lightsail#ExportSnapshotRecordSourceInfo", - "traits": { - "smithy.api#documentation": "

A list of objects describing the source of the export snapshot record.

" - } - }, - "destinationInfo": { - "target": "com.amazonaws.lightsail#DestinationInfo", - "traits": { - "smithy.api#documentation": "

A list of objects describing the destination of the export snapshot record.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an export snapshot record.

" - } - }, - "com.amazonaws.lightsail#ExportSnapshotRecordList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#ExportSnapshotRecord" - } - }, - "com.amazonaws.lightsail#ExportSnapshotRecordSourceInfo": { - "type": "structure", - "members": { - "resourceType": { - "target": "com.amazonaws.lightsail#ExportSnapshotRecordSourceType", - "traits": { - "smithy.api#documentation": "

The Lightsail resource type (e.g., InstanceSnapshot or\n DiskSnapshot).

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The date when the source instance or disk snapshot was created.

" - } - }, - "name": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the source instance or disk snapshot.

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source instance or disk snapshot.

" - } - }, - "fromResourceName": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the snapshot's source instance or disk.

" - } - }, - "fromResourceArn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the snapshot's source instance or disk.

" - } - }, - "instanceSnapshotInfo": { - "target": "com.amazonaws.lightsail#InstanceSnapshotInfo", - "traits": { - "smithy.api#documentation": "

A list of objects describing an instance snapshot.

" - } - }, - "diskSnapshotInfo": { - "target": "com.amazonaws.lightsail#DiskSnapshotInfo", - "traits": { - "smithy.api#documentation": "

A list of objects describing a disk snapshot.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the source of an export snapshot record.

" - } - }, - "com.amazonaws.lightsail#ExportSnapshotRecordSourceType": { - "type": "enum", - "members": { - "InstanceSnapshot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InstanceSnapshot" - } - }, - "DiskSnapshot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DiskSnapshot" - } - } - } - }, - "com.amazonaws.lightsail#ExportSnapshotRequest": { - "type": "structure", - "members": { - "sourceSnapshotName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the instance or disk snapshot to be exported to Amazon EC2.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#ExportSnapshotResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#ForwardValues": { - "type": "enum", - "members": { - "none": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "none" - } - }, - "allowList": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "allow-list" - } - }, - "all": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "all" - } - } - } - }, - "com.amazonaws.lightsail#GetActiveNames": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetActiveNamesRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetActiveNamesResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetActiveNames", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetActiveNamesRequest": { - "type": "structure", - "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetActiveNames request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetActiveNamesResult": { - "type": "structure", - "members": { - "activeNames": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetActiveNames request and\n specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetAlarms": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetAlarmsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetAlarmsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about the configured alarms. Specify an alarm name in your request to\n return information about a specific alarm, or specify a monitored resource name to return\n information about all alarms for a specific resource.

\n

An alarm is used to monitor a single metric for one of your resources. When a metric\n condition is met, the alarm can notify you by email, SMS text message, and a banner displayed\n on the Amazon Lightsail console. For more information, see Alarms\n in Amazon Lightsail.

", - "smithy.api#http": { - "method": "GET", - "uri": "/ls/api/2016-11-28/GetAlarms", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetAlarmsRequest": { - "type": "structure", - "members": { - "alarmName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the alarm.

\n

Specify an alarm name to return information about a specific alarm.

" - } - }, - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetAlarms request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

" - } - }, - "monitoredResourceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the Lightsail resource being monitored by the alarm.

\n

Specify a monitored resource name to return information about all alarms for a specific\n resource.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetAlarmsResult": { - "type": "structure", - "members": { - "alarms": { - "target": "com.amazonaws.lightsail#AlarmsList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the alarms.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetAlarms request and\n specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetAutoSnapshots": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetAutoSnapshotsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetAutoSnapshotsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the available automatic snapshots for an instance or disk. For more information,\n see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetAutoSnapshots", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetAutoSnapshotsRequest": { - "type": "structure", - "members": { - "resourceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the source instance or disk from which to get automatic snapshot\n information.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetAutoSnapshotsResult": { - "type": "structure", - "members": { - "resourceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the source instance or disk for the automatic snapshots.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The resource type (e.g., Instance or Disk).

" - } - }, - "autoSnapshots": { - "target": "com.amazonaws.lightsail#AutoSnapshotDetailsList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the automatic snapshots that are available for the\n specified source instance or disk.

" - } - } - } - }, - "com.amazonaws.lightsail#GetBlueprints": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetBlueprintsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetBlueprintsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

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

\n \n

Use active blueprints when creating new instances. Inactive blueprints are listed to\n support customers with existing instances and are not necessarily available to create new\n instances. Blueprints are marked inactive when they become outdated due to operating system\n updates or new application releases.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetBlueprints", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetBlueprintsRequest": { - "type": "structure", - "members": { - "includeInactive": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value that indicates whether to include inactive (unavailable) blueprints in the\n response of your request.

" - } - }, - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetBlueprints request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" - } - }, - "appCategory": { - "target": "com.amazonaws.lightsail#AppCategory", - "traits": { - "smithy.api#documentation": "

Returns a list of blueprints that are specific to Lightsail for Research.

\n \n

You must use this parameter to view Lightsail for Research blueprints.

\n " - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetBlueprintsResult": { - "type": "structure", - "members": { - "blueprints": { - "target": "com.amazonaws.lightsail#BlueprintList", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetBlueprints request and\n specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetBucketAccessKeys": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetBucketAccessKeysRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetBucketAccessKeysResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the existing access key IDs for the specified Amazon Lightsail bucket.

\n \n

This action does not return the secret access key value of an access key. You can get a\n secret access key only when you create it from the response of the CreateBucketAccessKey action. If you lose the secret access key, you must create\n a new access key.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetBucketAccessKeys", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetBucketAccessKeysRequest": { - "type": "structure", - "members": { - "bucketName": { - "target": "com.amazonaws.lightsail#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket for which to return access keys.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetBucketAccessKeysResult": { - "type": "structure", - "members": { - "accessKeys": { - "target": "com.amazonaws.lightsail#AccessKeyList", - "traits": { - "smithy.api#documentation": "

An object that describes the access keys for the specified bucket.

" - } - } - } - }, - "com.amazonaws.lightsail#GetBucketBundles": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetBucketBundlesRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetBucketBundlesResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the bundles that you can apply to a Amazon Lightsail bucket.

\n

The bucket bundle specifies the monthly cost, storage quota, and data transfer quota for a\n bucket.

\n

Use the UpdateBucketBundle action to update the\n bundle for a bucket.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetBucketBundles", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetBucketBundlesRequest": { - "type": "structure", - "members": { - "includeInactive": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value that indicates whether to include inactive (unavailable) bundles in the\n response of your request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetBucketBundlesResult": { - "type": "structure", - "members": { - "bundles": { - "target": "com.amazonaws.lightsail#BucketBundleList", - "traits": { - "smithy.api#documentation": "

An object that describes bucket bundles.

" - } - } - } - }, - "com.amazonaws.lightsail#GetBucketMetricData": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetBucketMetricDataRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetBucketMetricDataResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the data points of a specific metric for an Amazon Lightsail bucket.

\n

Metrics report the utilization of a bucket. View and collect metric data regularly to\n monitor the number of objects stored in a bucket (including object versions) and the storage\n space used by those objects.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetBucketMetricData", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetBucketMetricDataRequest": { - "type": "structure", - "members": { - "bucketName": { - "target": "com.amazonaws.lightsail#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket for which to get metric data.

", - "smithy.api#required": {} - } - }, - "metricName": { - "target": "com.amazonaws.lightsail#BucketMetricName", - "traits": { - "smithy.api#documentation": "

The metric for which you want to return information.

\n

Valid bucket metric names are listed below, along with the most useful statistics to\n include in your request, and the published unit value.

\n \n

These bucket metrics are reported once per day.

\n \n ", - "smithy.api#required": {} - } - }, - "startTime": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp indicating the earliest data to be returned.

", - "smithy.api#required": {} - } - }, - "endTime": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp indicating the latest data to be returned.

", - "smithy.api#required": {} - } - }, - "period": { - "target": "com.amazonaws.lightsail#MetricPeriod", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The granularity, in seconds, of the returned data points.

\n \n

Bucket storage metrics are reported once per day. Therefore, you should specify a period\n of 86400 seconds, which is the number of seconds in a day.

\n ", - "smithy.api#required": {} - } - }, - "statistics": { - "target": "com.amazonaws.lightsail#MetricStatisticList", - "traits": { - "smithy.api#documentation": "

The statistic for the metric.

\n

The following statistics are available:

\n ", - "smithy.api#required": {} - } - }, - "unit": { - "target": "com.amazonaws.lightsail#MetricUnit", - "traits": { - "smithy.api#documentation": "

The unit for the metric data request.

\n

Valid units depend on the metric data being requested. For the valid units with each\n available metric, see the metricName parameter.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetBucketMetricDataResult": { - "type": "structure", - "members": { - "metricName": { - "target": "com.amazonaws.lightsail#BucketMetricName", - "traits": { - "smithy.api#documentation": "

The name of the metric returned.

" - } - }, - "metricData": { - "target": "com.amazonaws.lightsail#MetricDatapointList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the metric data returned.

" - } - } - } - }, - "com.amazonaws.lightsail#GetBuckets": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetBucketsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetBucketsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about one or more Amazon Lightsail buckets. The information returned\n includes the synchronization status of the Amazon Simple Storage Service (Amazon S3)\n account-level block public access feature for your Lightsail buckets.

\n

For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer\n Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetBuckets", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetBucketsRequest": { - "type": "structure", - "members": { - "bucketName": { - "target": "com.amazonaws.lightsail#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket for which to return information.

\n

When omitted, the response includes all of your buckets in the Amazon Web Services Region\n where the request is made.

" - } - }, - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetBuckets request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

" - } - }, - "includeConnectedResources": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value that indicates whether to include Lightsail instances that were given\n access to the bucket using the SetResourceAccessForBucket\n action.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetBucketsResult": { - "type": "structure", - "members": { - "buckets": { - "target": "com.amazonaws.lightsail#BucketList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe buckets.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetBuckets request and\n specify the next page token using the pageToken parameter.

" - } - }, - "accountLevelBpaSync": { - "target": "com.amazonaws.lightsail#AccountLevelBpaSync", - "traits": { - "smithy.api#documentation": "

An object that describes the synchronization status of the Amazon S3 account-level\n block public access feature for your Lightsail buckets.

\n

For more information about this feature and how it affects Lightsail buckets, see Block public access for buckets in Amazon Lightsail.

" - } - } - } - }, - "com.amazonaws.lightsail#GetBundles": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetBundlesRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetBundlesResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the bundles that you can apply to an Amazon Lightsail instance when you create\n it.

\n

A bundle describes the specifications of an instance, such as the monthly cost, amount of\n memory, the number of vCPUs, amount of storage space, and monthly network data transfer\n quota.

\n \n

Bundles are referred to as instance plans in the Lightsail\n console.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetBundles", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetBundlesRequest": { - "type": "structure", - "members": { - "includeInactive": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value that indicates whether to include inactive (unavailable) bundles in the\n response of your request.

" - } - }, - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetBundles request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

" - } - }, - "appCategory": { - "target": "com.amazonaws.lightsail#AppCategory", - "traits": { - "smithy.api#documentation": "

Returns a list of bundles that are specific to Lightsail for Research.

\n \n

You must use this parameter to view Lightsail for Research bundles.

\n " - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetBundlesResult": { - "type": "structure", - "members": { - "bundles": { - "target": "com.amazonaws.lightsail#BundleList", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetBundles request and\n specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetCertificates": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetCertificatesRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetCertificatesResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about one or more Amazon Lightsail SSL/TLS certificates.

\n \n

To get a summary of a certificate, ommit includeCertificateDetails from\n your request. The response will include only the certificate Amazon Resource Name (ARN),\n certificate name, domain name, and tags.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetCertificates", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetCertificatesRequest": { - "type": "structure", - "members": { - "certificateStatuses": { - "target": "com.amazonaws.lightsail#CertificateStatusList", - "traits": { - "smithy.api#documentation": "

The status of the certificates for which to return information.

\n

For example, specify ISSUED to return only certificates with an\n ISSUED status.

\n

When omitted, the response includes all of your certificates in the Amazon Web Services\n Region where the request is made, regardless of their current status.

" - } - }, - "includeCertificateDetails": { - "target": "com.amazonaws.lightsail#IncludeCertificateDetails", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to include detailed information about the certificates in the\n response.

\n

When omitted, the response includes only the certificate names, Amazon Resource Names\n (ARNs), domain names, and tags.

" - } - }, - "certificateName": { - "target": "com.amazonaws.lightsail#CertificateName", - "traits": { - "smithy.api#documentation": "

The name for the certificate for which to return information.

\n

When omitted, the response includes all of your certificates in the Amazon Web Services\n Region where the request is made.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetCertificatesResult": { - "type": "structure", - "members": { - "certificates": { - "target": "com.amazonaws.lightsail#CertificateSummaryList", - "traits": { - "smithy.api#documentation": "

An object that describes certificates.

" - } - } - } - }, - "com.amazonaws.lightsail#GetCloudFormationStackRecords": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetCloudFormationStackRecordsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetCloudFormationStackRecordsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the CloudFormation stack record created as a result of the create cloud\n formation stack operation.

\n

An AWS CloudFormation stack is used to create a new Amazon EC2 instance from an exported Lightsail\n snapshot.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetCloudFormationStackRecords", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetCloudFormationStackRecordsRequest": { - "type": "structure", - "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetClouFormationStackRecords request.\n If your results are paginated, the response will return a next page token that you can specify\n as the page token in a subsequent request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetCloudFormationStackRecordsResult": { - "type": "structure", - "members": { - "cloudFormationStackRecords": { - "target": "com.amazonaws.lightsail#CloudFormationStackRecordList", - "traits": { - "smithy.api#documentation": "

A list of objects describing the CloudFormation stack records.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another\n GetCloudFormationStackRecords request and specify the next page token using the\n pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetContactMethods": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetContactMethodsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetContactMethodsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about the configured contact methods. Specify a protocol in your\n request to return information about a specific contact method.

\n

A contact method is used to send you notifications about your Amazon Lightsail resources.\n You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services\n Regions, and SMS text messages cannot be sent to some countries/regions. For more information,\n see Notifications in Amazon Lightsail.

", - "smithy.api#http": { - "method": "GET", - "uri": "/ls/api/2016-11-28/GetContactMethods", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetContactMethodsRequest": { - "type": "structure", - "members": { - "protocols": { - "target": "com.amazonaws.lightsail#ContactProtocolsList", - "traits": { - "smithy.api#documentation": "

The protocols used to send notifications, such as Email, or SMS\n (text messaging).

\n

Specify a protocol in your request to return information about a specific contact method\n protocol.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetContactMethodsResult": { - "type": "structure", - "members": { - "contactMethods": { - "target": "com.amazonaws.lightsail#ContactMethodsList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the contact methods.

" - } - } - } - }, - "com.amazonaws.lightsail#GetContainerAPIMetadata": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetContainerAPIMetadataRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetContainerAPIMetadataResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about Amazon Lightsail containers, such as the current version of the\n Lightsail Control (lightsailctl) plugin.

", - "smithy.api#http": { - "method": "GET", - "uri": "/ls/api/2016-11-28/container-api-metadata", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetContainerAPIMetadataRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetContainerAPIMetadataResult": { - "type": "structure", - "members": { - "metadata": { - "target": "com.amazonaws.lightsail#ContainerServiceMetadataEntryList", - "traits": { - "smithy.api#documentation": "

Metadata about Lightsail containers, such as the current version of the Lightsail\n Control (lightsailctl) plugin.

" - } - } - } - }, - "com.amazonaws.lightsail#GetContainerImages": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetContainerImagesRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetContainerImagesResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the container images that are registered to your Amazon Lightsail container\n service.

\n \n

If you created a deployment on your Lightsail container service that uses container\n images from a public registry like Docker Hub, those images are not returned as part of this\n action. Those images are not registered to your Lightsail container service.

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/ls/api/2016-11-28/container-services/{serviceName}/images", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetContainerImagesRequest": { - "type": "structure", - "members": { - "serviceName": { - "target": "com.amazonaws.lightsail#ContainerServiceName", - "traits": { - "smithy.api#documentation": "

The name of the container service for which to return registered container images.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetContainerImagesResult": { - "type": "structure", - "members": { - "containerImages": { - "target": "com.amazonaws.lightsail#ContainerImageList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe container images that are registered to the container\n service.

" - } - } - } - }, - "com.amazonaws.lightsail#GetContainerLog": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetContainerLogRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetContainerLogResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the log events of a container of your Amazon Lightsail container service.

\n

If your container service has more than one node (i.e., a scale greater than 1), then the\n log events that are returned for the specified container are merged from all nodes on your\n container service.

\n \n

Container logs are retained for a certain amount of time. For more information, see\n Amazon Lightsail\n endpoints and quotas in the Amazon Web Services General\n Reference.

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/ls/api/2016-11-28/container-services/{serviceName}/containers/{containerName}/log", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetContainerLogRequest": { - "type": "structure", - "members": { - "serviceName": { - "target": "com.amazonaws.lightsail#ContainerServiceName", - "traits": { - "smithy.api#documentation": "

The name of the container service for which to get a container log.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "containerName": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The name of the container that is either running or previously ran on the container\n service for which to return a log.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "startTime": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The start of the time interval for which to get log data.

\n

Constraints:

\n \n

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

", - "smithy.api#httpQuery": "startTime" - } - }, - "endTime": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The end of the time interval for which to get log data.

\n

Constraints:

\n \n

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

", - "smithy.api#httpQuery": "endTime" - } - }, - "filterPattern": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The pattern to use to filter the returned log events to a specific term.

\n

The following are a few examples of filter patterns that you can specify:

\n ", - "smithy.api#httpQuery": "filterPattern" - } - }, - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetContainerLog request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

", - "smithy.api#httpQuery": "pageToken" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetContainerLogResult": { - "type": "structure", - "members": { - "logEvents": { - "target": "com.amazonaws.lightsail#ContainerServiceLogEventList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the log events of a container.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetContainerLog request and\n specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetContainerServiceDeployments": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetContainerServiceDeploymentsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetContainerServiceDeploymentsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the deployments for your Amazon Lightsail container service

\n

A deployment specifies the settings, such as the ports and launch command, of containers\n that are deployed to your container service.

\n

The deployments are ordered by version in ascending order. The newest version is listed at\n the top of the response.

\n \n

A set number of deployments are kept before the oldest one is replaced with the newest\n one. For more information, see Amazon Lightsail\n endpoints and quotas in the Amazon Web Services General\n Reference.

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/ls/api/2016-11-28/container-services/{serviceName}/deployments", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetContainerServiceDeploymentsRequest": { - "type": "structure", - "members": { - "serviceName": { - "target": "com.amazonaws.lightsail#ContainerServiceName", - "traits": { - "smithy.api#documentation": "

The name of the container service for which to return deployments.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetContainerServiceDeploymentsResult": { - "type": "structure", - "members": { - "deployments": { - "target": "com.amazonaws.lightsail#ContainerServiceDeploymentList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe deployments for a container service.

" - } - } - } - }, - "com.amazonaws.lightsail#GetContainerServiceMetricData": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetContainerServiceMetricDataRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetContainerServiceMetricDataResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the data points of a specific metric of your Amazon Lightsail container\n service.

\n

Metrics report the utilization of your resources. Monitor and collect metric data\n regularly to maintain the reliability, availability, and performance of your resources.

", - "smithy.api#http": { - "method": "GET", - "uri": "/ls/api/2016-11-28/container-services/{serviceName}/metrics", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetContainerServiceMetricDataRequest": { - "type": "structure", - "members": { - "serviceName": { - "target": "com.amazonaws.lightsail#ContainerServiceName", - "traits": { - "smithy.api#documentation": "

The name of the container service for which to get metric data.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "metricName": { - "target": "com.amazonaws.lightsail#ContainerServiceMetricName", - "traits": { - "smithy.api#documentation": "

The metric for which you want to return information.

\n

Valid container service metric names are listed below, along with the most useful\n statistics to include in your request, and the published unit value.

\n ", - "smithy.api#httpQuery": "metricName", - "smithy.api#required": {} - } - }, - "startTime": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The start time of the time period.

", - "smithy.api#httpQuery": "startTime", - "smithy.api#required": {} - } - }, - "endTime": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The end time of the time period.

", - "smithy.api#httpQuery": "endTime", - "smithy.api#required": {} - } - }, - "period": { - "target": "com.amazonaws.lightsail#MetricPeriod", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The granularity, in seconds, of the returned data points.

\n

All container service metric data is available in 5-minute (300 seconds)\n granularity.

", - "smithy.api#httpQuery": "period", - "smithy.api#required": {} - } - }, - "statistics": { - "target": "com.amazonaws.lightsail#MetricStatisticList", - "traits": { - "smithy.api#documentation": "

The statistic for the metric.

\n

The following statistics are available:

\n ", - "smithy.api#httpQuery": "statistics", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetContainerServiceMetricDataResult": { - "type": "structure", - "members": { - "metricName": { - "target": "com.amazonaws.lightsail#ContainerServiceMetricName", - "traits": { - "smithy.api#documentation": "

The name of the metric returned.

" - } - }, - "metricData": { - "target": "com.amazonaws.lightsail#MetricDatapointList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the metric data returned.

" - } - } - } - }, - "com.amazonaws.lightsail#GetContainerServicePowers": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetContainerServicePowersRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetContainerServicePowersResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the list of powers that can be specified for your Amazon Lightsail container\n services.

\n

The power specifies the amount of memory, the number of vCPUs, and the base price of the\n container service.

", - "smithy.api#http": { - "method": "GET", - "uri": "/ls/api/2016-11-28/container-service-powers", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetContainerServicePowersRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetContainerServicePowersResult": { - "type": "structure", - "members": { - "powers": { - "target": "com.amazonaws.lightsail#ContainerServicePowerList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the powers that can be specified for a container\n service.

" - } - } - } - }, - "com.amazonaws.lightsail#GetContainerServices": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetContainerServicesRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#ContainerServicesListResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about one or more of your Amazon Lightsail container services.

", - "smithy.api#http": { - "method": "GET", - "uri": "/ls/api/2016-11-28/container-services", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetContainerServicesRequest": { - "type": "structure", - "members": { - "serviceName": { - "target": "com.amazonaws.lightsail#ContainerServiceName", - "traits": { - "smithy.api#documentation": "

The name of the container service for which to return information.

\n

When omitted, the response includes all of your container services in the Amazon Web Services Region where the request is made.

", - "smithy.api#httpQuery": "serviceName" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetCostEstimate": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetCostEstimateRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetCostEstimateResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves information about the cost estimate for a specified resource. A cost estimate will not generate for a resource that has been deleted.

", - "smithy.api#http": { - "method": "POST", - "uri": "/budgettracker/getCostEstimate", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetCostEstimateRequest": { - "type": "structure", - "members": { - "resourceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The resource name.

", - "smithy.api#required": {} - } - }, - "startTime": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The cost estimate start time.

\n

Constraints:

\n \n

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

", - "smithy.api#required": {} - } - }, - "endTime": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The cost estimate end time.

\n

Constraints:

\n \n

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetCostEstimateResult": { - "type": "structure", - "members": { - "resourcesBudgetEstimate": { - "target": "com.amazonaws.lightsail#ResourcesBudgetEstimate", - "traits": { - "smithy.api#documentation": "

Returns the estimate's forecasted cost or usage.

" - } - } - } - }, - "com.amazonaws.lightsail#GetDisk": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetDiskRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetDiskResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about a specific block storage disk.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetDisk", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetDiskRequest": { - "type": "structure", - "members": { - "diskName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the disk (e.g., my-disk).

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetDiskResult": { - "type": "structure", - "members": { - "disk": { - "target": "com.amazonaws.lightsail#Disk", - "traits": { - "smithy.api#documentation": "

An object containing information about the disk.

" - } - } - } - }, - "com.amazonaws.lightsail#GetDiskSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetDiskSnapshotRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetDiskSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about a specific block storage disk snapshot.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetDiskSnapshot", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetDiskSnapshotRequest": { - "type": "structure", - "members": { - "diskSnapshotName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the disk snapshot (e.g., my-disk-snapshot).

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetDiskSnapshotResult": { - "type": "structure", - "members": { - "diskSnapshot": { - "target": "com.amazonaws.lightsail#DiskSnapshot", - "traits": { - "smithy.api#documentation": "

An object containing information about the disk snapshot.

" - } - } - } - }, - "com.amazonaws.lightsail#GetDiskSnapshots": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetDiskSnapshotsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetDiskSnapshotsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about all block storage disk snapshots in your AWS account and\n region.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetDiskSnapshots", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetDiskSnapshotsRequest": { - "type": "structure", - "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetDiskSnapshots request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetDiskSnapshotsResult": { - "type": "structure", - "members": { - "diskSnapshots": { - "target": "com.amazonaws.lightsail#DiskSnapshotList", - "traits": { - "smithy.api#documentation": "

An array of objects containing information about all block storage disk snapshots.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetDiskSnapshots request and\n specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetDisks": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetDisksRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetDisksResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about all block storage disks in your AWS account and region.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetDisks", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetDisksRequest": { - "type": "structure", - "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetDisks request. If your results are\n paginated, the response will return a next page token that you can specify as the page token\n in a subsequent request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetDisksResult": { - "type": "structure", - "members": { - "disks": { - "target": "com.amazonaws.lightsail#DiskList", - "traits": { - "smithy.api#documentation": "

An array of objects containing information about all block storage disks.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetDisks request and specify\n the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetDistributionBundles": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetDistributionBundlesRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetDistributionBundlesResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the bundles that can be applied to your Amazon Lightsail content delivery network\n (CDN) distributions.

\n

A distribution bundle specifies the monthly network transfer quota and monthly cost of\n your distribution.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetDistributionBundles", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetDistributionBundlesRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetDistributionBundlesResult": { - "type": "structure", - "members": { - "bundles": { - "target": "com.amazonaws.lightsail#DistributionBundleList", - "traits": { - "smithy.api#documentation": "

An object that describes a distribution bundle.

" - } - } - } - }, - "com.amazonaws.lightsail#GetDistributionLatestCacheReset": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetDistributionLatestCacheResetRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetDistributionLatestCacheResetResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail\n content delivery network (CDN) distribution.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetDistributionLatestCacheReset", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetDistributionLatestCacheResetRequest": { - "type": "structure", - "members": { - "distributionName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the distribution for which to return the timestamp of the last cache\n reset.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

\n

When omitted, the response includes the latest cache reset timestamp of all your\n distributions.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetDistributionLatestCacheResetResult": { - "type": "structure", - "members": { - "status": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The status of the last cache reset.

" - } - }, - "createTime": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp of the last cache reset (e.g., 1479734909.17) in Unix time\n format.

" - } - } - } - }, - "com.amazonaws.lightsail#GetDistributionMetricData": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetDistributionMetricDataRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetDistributionMetricDataResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the data points of a specific metric for an Amazon Lightsail content delivery\n network (CDN) distribution.

\n

Metrics report the utilization of your resources, and the error counts generated by them.\n Monitor and collect metric data regularly to maintain the reliability, availability, and\n performance of your resources.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetDistributionMetricData", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetDistributionMetricDataRequest": { - "type": "structure", - "members": { - "distributionName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the distribution for which to get metric data.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

", - "smithy.api#required": {} - } - }, - "metricName": { - "target": "com.amazonaws.lightsail#DistributionMetricName", - "traits": { - "smithy.api#documentation": "

The metric for which you want to return information.

\n

Valid distribution metric names are listed below, along with the most useful\n statistics to include in your request, and the published unit\n value.

\n ", - "smithy.api#required": {} - } - }, - "startTime": { - "target": "com.amazonaws.lightsail#timestamp", - "traits": { - "smithy.api#documentation": "

The start of the time interval for which to get metric data.

\n

Constraints:

\n \n

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

", - "smithy.api#required": {} - } - }, - "endTime": { - "target": "com.amazonaws.lightsail#timestamp", - "traits": { - "smithy.api#documentation": "

The end of the time interval for which to get metric data.

\n

Constraints:

\n \n

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

", - "smithy.api#required": {} - } - }, - "period": { - "target": "com.amazonaws.lightsail#MetricPeriod", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The granularity, in seconds, for the metric data points that will be returned.

", - "smithy.api#required": {} - } - }, - "unit": { - "target": "com.amazonaws.lightsail#MetricUnit", - "traits": { - "smithy.api#documentation": "

The unit for the metric data request.

\n

Valid units depend on the metric data being requested. For the valid units with each\n available metric, see the metricName parameter.

", - "smithy.api#required": {} - } - }, - "statistics": { - "target": "com.amazonaws.lightsail#MetricStatisticList", - "traits": { - "smithy.api#documentation": "

The statistic for the metric.

\n

The following statistics are available:

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetDistributionMetricDataResult": { - "type": "structure", - "members": { - "metricName": { - "target": "com.amazonaws.lightsail#DistributionMetricName", - "traits": { - "smithy.api#documentation": "

The name of the metric returned.

" - } - }, - "metricData": { - "target": "com.amazonaws.lightsail#MetricDatapointList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the metric data returned.

" - } - } - } - }, - "com.amazonaws.lightsail#GetDistributions": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetDistributionsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetDistributionsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about one or more of your Amazon Lightsail content delivery network\n (CDN) distributions.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetDistributions", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetDistributionsRequest": { - "type": "structure", - "members": { - "distributionName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the distribution for which to return information.

\n

When omitted, the response includes all of your distributions in the Amazon Web Services\n Region where the request is made.

" - } - }, - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetDistributions request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetDistributionsResult": { - "type": "structure", - "members": { - "distributions": { - "target": "com.amazonaws.lightsail#DistributionList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe your distributions.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetDistributions request and\n specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetDomain": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetDomainRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetDomainResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about a specific domain recordset.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetDomain", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetDomainRequest": { - "type": "structure", - "members": { - "domainName": { - "target": "com.amazonaws.lightsail#DomainName", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetDomainResult": { - "type": "structure", - "members": { - "domain": { - "target": "com.amazonaws.lightsail#Domain", - "traits": { - "smithy.api#documentation": "

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

" - } - } - } - }, - "com.amazonaws.lightsail#GetDomains": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetDomainsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetDomainsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetDomains", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetDomainsRequest": { - "type": "structure", - "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetDomains request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetDomainsResult": { - "type": "structure", - "members": { - "domains": { - "target": "com.amazonaws.lightsail#DomainList", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetDomains request and\n specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetExportSnapshotRecords": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetExportSnapshotRecordsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetExportSnapshotRecordsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns all export snapshot records created as a result of the export\n snapshot operation.

\n

An export snapshot record can be used to create a new Amazon EC2 instance and its related\n resources with the CreateCloudFormationStack\n action.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetExportSnapshotRecords", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetExportSnapshotRecordsRequest": { - "type": "structure", - "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetExportSnapshotRecords request. If\n your results are paginated, the response will return a next page token that you can specify as\n the page token in a subsequent request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetExportSnapshotRecordsResult": { - "type": "structure", - "members": { - "exportSnapshotRecords": { - "target": "com.amazonaws.lightsail#ExportSnapshotRecordList", - "traits": { - "smithy.api#documentation": "

A list of objects describing the export snapshot records.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetExportSnapshotRecords\n request and specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetInstanceRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetInstanceResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetInstance", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetInstanceAccessDetails": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetInstanceAccessDetailsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetInstanceAccessDetailsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

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

\n

The get instance access details operation supports tag-based access control\n via resource tags applied to the resource identified by instance name. For more\n information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetInstanceAccessDetails", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetInstanceAccessDetailsRequest": { - "type": "structure", - "members": { - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the instance to access.

", - "smithy.api#required": {} - } - }, - "protocol": { - "target": "com.amazonaws.lightsail#InstanceAccessProtocol", - "traits": { - "smithy.api#documentation": "

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

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetInstanceAccessDetailsResult": { - "type": "structure", - "members": { - "accessDetails": { - "target": "com.amazonaws.lightsail#InstanceAccessDetails", - "traits": { - "smithy.api#documentation": "

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

" - } - } - } - }, - "com.amazonaws.lightsail#GetInstanceMetricData": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetInstanceMetricDataRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetInstanceMetricDataResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

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

\n

Metrics report the utilization of your resources, and the error counts generated by them.\n Monitor and collect metric data regularly to maintain the reliability, availability, and\n performance of your resources.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetInstanceMetricData", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetInstanceMetricDataRequest": { - "type": "structure", - "members": { - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - }, - "metricName": { - "target": "com.amazonaws.lightsail#InstanceMetricName", - "traits": { - "smithy.api#documentation": "

The metric for which you want to return information.

\n

Valid instance metric names are listed below, along with the most useful\n statistics to include in your request, and the published unit\n value.

\n ", - "smithy.api#required": {} - } - }, - "period": { - "target": "com.amazonaws.lightsail#MetricPeriod", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The granularity, in seconds, of the returned data points.

\n

The StatusCheckFailed, StatusCheckFailed_Instance, and\n StatusCheckFailed_System instance metric data is available in 1-minute (60\n seconds) granularity. All other instance metric data is available in 5-minute (300 seconds)\n granularity.

", - "smithy.api#required": {} - } - }, - "startTime": { - "target": "com.amazonaws.lightsail#timestamp", - "traits": { - "smithy.api#documentation": "

The start time of the time period.

", - "smithy.api#required": {} - } - }, - "endTime": { - "target": "com.amazonaws.lightsail#timestamp", - "traits": { - "smithy.api#documentation": "

The end time of the time period.

", - "smithy.api#required": {} - } - }, - "unit": { - "target": "com.amazonaws.lightsail#MetricUnit", - "traits": { - "smithy.api#documentation": "

The unit for the metric data request. Valid units depend on the metric data being\n requested. For the valid units to specify with each available metric, see the\n metricName parameter.

", - "smithy.api#required": {} - } - }, - "statistics": { - "target": "com.amazonaws.lightsail#MetricStatisticList", - "traits": { - "smithy.api#documentation": "

The statistic for the metric.

\n

The following statistics are available:

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetInstanceMetricDataResult": { - "type": "structure", - "members": { - "metricName": { - "target": "com.amazonaws.lightsail#InstanceMetricName", - "traits": { - "smithy.api#documentation": "

The name of the metric returned.

" - } - }, - "metricData": { - "target": "com.amazonaws.lightsail#MetricDatapointList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the metric data returned.

" - } - } - } - }, - "com.amazonaws.lightsail#GetInstancePortStates": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetInstancePortStatesRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetInstancePortStatesResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the firewall port states for a specific Amazon Lightsail instance, the IP addresses\n allowed to connect to the instance through the ports, and the protocol.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetInstancePortStates", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetInstancePortStatesRequest": { - "type": "structure", - "members": { - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the instance for which to return firewall port states.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetInstancePortStatesResult": { - "type": "structure", - "members": { - "portStates": { - "target": "com.amazonaws.lightsail#InstancePortStateList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the firewall port states for the specified\n instance.

" - } - } - } - }, - "com.amazonaws.lightsail#GetInstanceRequest": { - "type": "structure", - "members": { - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the instance.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetInstanceResult": { - "type": "structure", - "members": { - "instance": { - "target": "com.amazonaws.lightsail#Instance", - "traits": { - "smithy.api#documentation": "

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

" - } - } - } - }, - "com.amazonaws.lightsail#GetInstanceSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetInstanceSnapshotRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetInstanceSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about a specific instance snapshot.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetInstanceSnapshot", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetInstanceSnapshotRequest": { - "type": "structure", - "members": { - "instanceSnapshotName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetInstanceSnapshotResult": { - "type": "structure", - "members": { - "instanceSnapshot": { - "target": "com.amazonaws.lightsail#InstanceSnapshot", - "traits": { - "smithy.api#documentation": "

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

" - } - } - } - }, - "com.amazonaws.lightsail#GetInstanceSnapshots": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetInstanceSnapshotsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetInstanceSnapshotsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns all instance snapshots for the user's account.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetInstanceSnapshots", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetInstanceSnapshotsRequest": { - "type": "structure", - "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetInstanceSnapshots request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetInstanceSnapshotsResult": { - "type": "structure", - "members": { - "instanceSnapshots": { - "target": "com.amazonaws.lightsail#InstanceSnapshotList", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetInstanceSnapshots request\n and specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetInstanceState": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetInstanceStateRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetInstanceStateResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetInstanceState", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetInstanceStateRequest": { - "type": "structure", - "members": { - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the instance to get state information about.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetInstanceStateResult": { - "type": "structure", - "members": { - "state": { - "target": "com.amazonaws.lightsail#InstanceState", - "traits": { - "smithy.api#documentation": "

The state of the instance.

" - } - } - } - }, - "com.amazonaws.lightsail#GetInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetInstancesRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetInstancesResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetInstances", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetInstancesRequest": { - "type": "structure", - "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetInstances request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetInstancesResult": { - "type": "structure", - "members": { - "instances": { - "target": "com.amazonaws.lightsail#InstanceList", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetInstances request and\n specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetKeyPair": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetKeyPairRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetKeyPairResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about a specific key pair.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetKeyPair", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetKeyPairRequest": { - "type": "structure", - "members": { - "keyPairName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetKeyPairResult": { - "type": "structure", - "members": { - "keyPair": { - "target": "com.amazonaws.lightsail#KeyPair", - "traits": { - "smithy.api#documentation": "

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

" - } - } - } - }, - "com.amazonaws.lightsail#GetKeyPairs": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetKeyPairsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetKeyPairsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetKeyPairs", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetKeyPairsRequest": { - "type": "structure", - "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetKeyPairs request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

" - } - }, - "includeDefaultKeyPair": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value that indicates whether to include the default key pair in the response of\n your request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetKeyPairsResult": { - "type": "structure", - "members": { - "keyPairs": { - "target": "com.amazonaws.lightsail#KeyPairList", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetKeyPairs request and\n specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetLoadBalancer": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetLoadBalancerRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetLoadBalancerResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about the specified Lightsail load balancer.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetLoadBalancer", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetLoadBalancerMetricData": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetLoadBalancerMetricDataRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetLoadBalancerMetricDataResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about health metrics for your Lightsail load balancer.

\n

Metrics report the utilization of your resources, and the error counts generated by them.\n Monitor and collect metric data regularly to maintain the reliability, availability, and\n performance of your resources.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetLoadBalancerMetricData", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetLoadBalancerMetricDataRequest": { - "type": "structure", - "members": { - "loadBalancerName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the load balancer.

", - "smithy.api#required": {} - } - }, - "metricName": { - "target": "com.amazonaws.lightsail#LoadBalancerMetricName", - "traits": { - "smithy.api#documentation": "

The metric for which you want to return information.

\n

Valid load balancer metric names are listed below, along with the most useful\n statistics to include in your request, and the published unit\n value.

\n ", - "smithy.api#required": {} - } - }, - "period": { - "target": "com.amazonaws.lightsail#MetricPeriod", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The granularity, in seconds, of the returned data points.

", - "smithy.api#required": {} - } - }, - "startTime": { - "target": "com.amazonaws.lightsail#timestamp", - "traits": { - "smithy.api#documentation": "

The start time of the period.

", - "smithy.api#required": {} - } - }, - "endTime": { - "target": "com.amazonaws.lightsail#timestamp", - "traits": { - "smithy.api#documentation": "

The end time of the period.

", - "smithy.api#required": {} - } - }, - "unit": { - "target": "com.amazonaws.lightsail#MetricUnit", - "traits": { - "smithy.api#documentation": "

The unit for the metric data request. Valid units depend on the metric data being\n requested. For the valid units with each available metric, see the metricName\n parameter.

", - "smithy.api#required": {} - } - }, - "statistics": { - "target": "com.amazonaws.lightsail#MetricStatisticList", - "traits": { - "smithy.api#documentation": "

The statistic for the metric.

\n

The following statistics are available:

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetLoadBalancerMetricDataResult": { - "type": "structure", - "members": { - "metricName": { - "target": "com.amazonaws.lightsail#LoadBalancerMetricName", - "traits": { - "smithy.api#documentation": "

The name of the metric returned.

" - } - }, - "metricData": { - "target": "com.amazonaws.lightsail#MetricDatapointList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the metric data returned.

" - } - } - } - }, - "com.amazonaws.lightsail#GetLoadBalancerRequest": { - "type": "structure", - "members": { - "loadBalancerName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the load balancer.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetLoadBalancerResult": { - "type": "structure", - "members": { - "loadBalancer": { - "target": "com.amazonaws.lightsail#LoadBalancer", - "traits": { - "smithy.api#documentation": "

An object containing information about your load balancer.

" - } - } - } - }, - "com.amazonaws.lightsail#GetLoadBalancerTlsCertificates": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetLoadBalancerTlsCertificatesRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetLoadBalancerTlsCertificatesResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about the TLS certificates that are associated with the specified\n Lightsail load balancer.

\n

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

\n

You can have a maximum of 2 certificates associated with a Lightsail load balancer. One\n is active and the other is inactive.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetLoadBalancerTlsCertificates", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetLoadBalancerTlsCertificatesRequest": { - "type": "structure", - "members": { - "loadBalancerName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the load balancer you associated with your SSL/TLS certificate.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetLoadBalancerTlsCertificatesResult": { - "type": "structure", - "members": { - "tlsCertificates": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateList", - "traits": { - "smithy.api#documentation": "

An array of LoadBalancerTlsCertificate objects describing your SSL/TLS\n certificates.

" - } - } - } - }, - "com.amazonaws.lightsail#GetLoadBalancerTlsPolicies": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetLoadBalancerTlsPoliciesRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetLoadBalancerTlsPoliciesResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of TLS security policies that you can apply to Lightsail load\n balancers.

\n

For more information about load balancer TLS security policies, see Configuring TLS security policies on your Amazon Lightsail load\n balancers in the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetLoadBalancerTlsPolicies", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetLoadBalancerTlsPoliciesRequest": { - "type": "structure", - "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetLoadBalancerTlsPolicies request.\n If your results are paginated, the response will return a next page token that you can specify\n as the page token in a subsequent request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetLoadBalancerTlsPoliciesResult": { - "type": "structure", - "members": { - "tlsPolicies": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsPolicyList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the TLS security policies that are available.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetLoadBalancerTlsPolicies\n request and specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetLoadBalancers": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetLoadBalancersRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetLoadBalancersResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about all load balancers in an account.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetLoadBalancers", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetLoadBalancersRequest": { - "type": "structure", - "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetLoadBalancers request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetLoadBalancersResult": { - "type": "structure", - "members": { - "loadBalancers": { - "target": "com.amazonaws.lightsail#LoadBalancerList", - "traits": { - "smithy.api#documentation": "

An array of LoadBalancer objects describing your load balancers.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetLoadBalancers request and\n specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetOperation": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetOperationRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetOperationResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetOperation", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetOperationRequest": { - "type": "structure", - "members": { - "operationId": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A GUID used to identify the operation.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetOperationResult": { - "type": "structure", - "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#GetOperations": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetOperationsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetOperationsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about all operations.

\n

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

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetOperations", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetOperationsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetOperationsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetOperationsForResourceResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetOperationsForResource", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetOperationsForResourceRequest": { - "type": "structure", - "members": { - "resourceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - }, - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetOperationsForResource request. If\n your results are paginated, the response will return a next page token that you can specify as\n the page token in a subsequent request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetOperationsForResourceResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - }, - "nextPageCount": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

(Deprecated) Returns the number of pages of results that remain.

\n \n

In releases prior to June 12, 2017, this parameter returned null by the\n API. It is now deprecated, and the API returns the next page token parameter\n instead.

\n " - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetOperationsForResource\n request and specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetOperationsRequest": { - "type": "structure", - "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetOperations request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetOperationsResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetOperations request and\n specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetRegions": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetRegionsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetRegionsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of all valid regions for Amazon Lightsail. Use the include\n availability zones parameter to also return the Availability Zones in a\n region.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetRegions", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetRegionsRequest": { - "type": "structure", - "members": { - "includeAvailabilityZones": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "includeRelationalDatabaseAvailabilityZones": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether to also include Availability Zones for databases in\n your get regions request. Availability Zones are indicated with a letter (e.g.,\n us-east-2a).

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetRegionsResult": { - "type": "structure", - "members": { - "regions": { - "target": "com.amazonaws.lightsail#RegionList", - "traits": { - "smithy.api#documentation": "

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

" - } - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabase": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about a specific database in Amazon Lightsail.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetRelationalDatabase", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseBlueprints": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseBlueprintsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseBlueprintsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of available database blueprints in Amazon Lightsail. A blueprint describes\n the major engine version of a database.

\n

You can use a blueprint ID to create a new database that runs a specific database\n engine.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetRelationalDatabaseBlueprints", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseBlueprintsRequest": { - "type": "structure", - "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabaseBlueprints\n request. If your results are paginated, the response will return a next page token that you\n can specify as the page token in a subsequent request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseBlueprintsResult": { - "type": "structure", - "members": { - "blueprints": { - "target": "com.amazonaws.lightsail#RelationalDatabaseBlueprintList", - "traits": { - "smithy.api#documentation": "

An object describing the result of your get relational database blueprints request.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another\n GetRelationalDatabaseBlueprints request and specify the next page token using\n the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseBundles": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseBundlesRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseBundlesResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the list of bundles that are available in Amazon Lightsail. A bundle describes the\n performance specifications for a database.

\n

You can use a bundle ID to create a new database with explicit performance\n specifications.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetRelationalDatabaseBundles", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseBundlesRequest": { - "type": "structure", - "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabaseBundles request.\n If your results are paginated, the response will return a next page token that you can specify\n as the page token in a subsequent request.

" - } - }, - "includeInactive": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value that indicates whether to include inactive (unavailable) bundles in the\n response of your request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseBundlesResult": { - "type": "structure", - "members": { - "bundles": { - "target": "com.amazonaws.lightsail#RelationalDatabaseBundleList", - "traits": { - "smithy.api#documentation": "

An object describing the result of your get relational database bundles request.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetRelationalDatabaseBundles\n request and specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseEvents": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseEventsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseEventsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of events for a specific database in Amazon Lightsail.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetRelationalDatabaseEvents", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseEventsRequest": { - "type": "structure", - "members": { - "relationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the database from which to get events.

", - "smithy.api#required": {} - } - }, - "durationInMinutes": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The number of minutes in the past from which to retrieve events. For example, to get all\n events from the past 2 hours, enter 120.

\n

Default: 60\n

\n

The minimum is 1 and the maximum is 14 days (20160 minutes).

" - } - }, - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabaseEvents request.\n If your results are paginated, the response will return a next page token that you can specify\n as the page token in a subsequent request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseEventsResult": { - "type": "structure", - "members": { - "relationalDatabaseEvents": { - "target": "com.amazonaws.lightsail#RelationalDatabaseEventList", - "traits": { - "smithy.api#documentation": "

An object describing the result of your get relational database events request.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetRelationalDatabaseEvents\n request and specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseLogEvents": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseLogEventsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseLogEventsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of log events for a database in Amazon Lightsail.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetRelationalDatabaseLogEvents", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseLogEventsRequest": { - "type": "structure", - "members": { - "relationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of your database for which to get log events.

", - "smithy.api#required": {} - } - }, - "logStreamName": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The name of the log stream.

\n

Use the get relational database log streams operation to get a list of\n available log streams.

", - "smithy.api#required": {} - } - }, - "startTime": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The start of the time interval from which to get log events.

\n

Constraints:

\n " - } - }, - "endTime": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The end of the time interval from which to get log events.

\n

Constraints:

\n " - } - }, - "startFromHead": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

Parameter to specify if the log should start from head or tail. If true is\n specified, the log event starts from the head of the log. If false is specified,\n the log event starts from the tail of the log.

\n \n

For PostgreSQL, the default value of false is the only option\n available.

\n " - } - }, - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next or previous page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabaseLogEvents\n request. If your results are paginated, the response will return a next forward token and/or\n next backward token that you can specify as the page token in a subsequent request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseLogEventsResult": { - "type": "structure", - "members": { - "resourceLogEvents": { - "target": "com.amazonaws.lightsail#LogEventList", - "traits": { - "smithy.api#documentation": "

An object describing the result of your get relational database log events request.

" - } - }, - "nextBackwardToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

A token used for advancing to the previous page of results from your get relational\n database log events request.

" - } - }, - "nextForwardToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

A token used for advancing to the next page of results from your get relational database\n log events request.

" - } - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseLogStreams": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseLogStreamsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseLogStreamsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of available log streams for a specific database in Amazon Lightsail.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetRelationalDatabaseLogStreams", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseLogStreamsRequest": { - "type": "structure", - "members": { - "relationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of your database for which to get log streams.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseLogStreamsResult": { - "type": "structure", - "members": { - "logStreams": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

An object describing the result of your get relational database log streams\n request.

" - } - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseMasterUserPassword": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseMasterUserPasswordRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseMasterUserPasswordResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the current, previous, or pending versions of the master user password for a\n Lightsail database.

\n

The GetRelationalDatabaseMasterUserPassword operation supports tag-based\n access control via resource tags applied to the resource identified by\n relationalDatabaseName.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetRelationalDatabaseMasterUserPassword", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseMasterUserPasswordRequest": { - "type": "structure", - "members": { - "relationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of your database for which to get the master user password.

", - "smithy.api#required": {} - } - }, - "passwordVersion": { - "target": "com.amazonaws.lightsail#RelationalDatabasePasswordVersion", - "traits": { - "smithy.api#documentation": "

The password version to return.

\n

Specifying CURRENT or PREVIOUS returns the current or previous\n passwords respectively. Specifying PENDING returns the newest version of the\n password that will rotate to CURRENT. After the PENDING password\n rotates to CURRENT, the PENDING password is no longer\n available.

\n

Default: CURRENT\n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseMasterUserPasswordResult": { - "type": "structure", - "members": { - "masterUserPassword": { - "target": "com.amazonaws.lightsail#SensitiveString", - "traits": { - "smithy.api#documentation": "

The master user password for the password version specified.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the specified version of the master user password was created.

" - } - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseMetricData": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseMetricDataRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseMetricDataResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the data points of the specified metric for a database in Amazon Lightsail.

\n

Metrics report the utilization of your resources, and the error counts generated by them.\n Monitor and collect metric data regularly to maintain the reliability, availability, and\n performance of your resources.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetRelationalDatabaseMetricData", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseMetricDataRequest": { - "type": "structure", - "members": { - "relationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of your database from which to get metric data.

", - "smithy.api#required": {} - } - }, - "metricName": { - "target": "com.amazonaws.lightsail#RelationalDatabaseMetricName", - "traits": { - "smithy.api#documentation": "

The metric for which you want to return information.

\n

Valid relational database metric names are listed below, along with the most useful\n statistics to include in your request, and the published unit\n value. All relational database metric data is available in 1-minute (60 seconds)\n granularity.

\n ", - "smithy.api#required": {} - } - }, - "period": { - "target": "com.amazonaws.lightsail#MetricPeriod", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The granularity, in seconds, of the returned data points.

\n

All relational database metric data is available in 1-minute (60 seconds)\n granularity.

", - "smithy.api#required": {} - } - }, - "startTime": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The start of the time interval from which to get metric data.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - }, - "endTime": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The end of the time interval from which to get metric data.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - }, - "unit": { - "target": "com.amazonaws.lightsail#MetricUnit", - "traits": { - "smithy.api#documentation": "

The unit for the metric data request. Valid units depend on the metric data being\n requested. For the valid units with each available metric, see the metricName\n parameter.

", - "smithy.api#required": {} - } - }, - "statistics": { - "target": "com.amazonaws.lightsail#MetricStatisticList", - "traits": { - "smithy.api#documentation": "

The statistic for the metric.

\n

The following statistics are available:

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseMetricDataResult": { - "type": "structure", - "members": { - "metricName": { - "target": "com.amazonaws.lightsail#RelationalDatabaseMetricName", - "traits": { - "smithy.api#documentation": "

The name of the metric returned.

" - } - }, - "metricData": { - "target": "com.amazonaws.lightsail#MetricDatapointList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the metric data returned.

" - } - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseParameters": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseParametersRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseParametersResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns all of the runtime parameters offered by the underlying database software, or\n engine, for a specific database in Amazon Lightsail.

\n

In addition to the parameter names and values, this operation returns other information\n about each parameter. This information includes whether changes require a reboot, whether the\n parameter is modifiable, the allowed values, and the data types.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetRelationalDatabaseParameters", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseParametersRequest": { - "type": "structure", - "members": { - "relationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of your database for which to get parameters.

", - "smithy.api#required": {} - } - }, - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabaseParameters\n request. If your results are paginated, the response will return a next page token that you\n can specify as the page token in a subsequent request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseParametersResult": { - "type": "structure", - "members": { - "parameters": { - "target": "com.amazonaws.lightsail#RelationalDatabaseParameterList", - "traits": { - "smithy.api#documentation": "

An object describing the result of your get relational database parameters request.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another\n GetRelationalDatabaseParameters request and specify the next page token using\n the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseRequest": { - "type": "structure", - "members": { - "relationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the database that you are looking up.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseResult": { - "type": "structure", - "members": { - "relationalDatabase": { - "target": "com.amazonaws.lightsail#RelationalDatabase", - "traits": { - "smithy.api#documentation": "

An object describing the specified database.

" - } - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about a specific database snapshot in Amazon Lightsail.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetRelationalDatabaseSnapshot", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotRequest": { - "type": "structure", - "members": { - "relationalDatabaseSnapshotName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the database snapshot for which to get information.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotResult": { - "type": "structure", - "members": { - "relationalDatabaseSnapshot": { - "target": "com.amazonaws.lightsail#RelationalDatabaseSnapshot", - "traits": { - "smithy.api#documentation": "

An object describing the specified database snapshot.

" - } - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseSnapshots": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about all of your database snapshots in Amazon Lightsail.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetRelationalDatabaseSnapshots", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotsRequest": { - "type": "structure", - "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabaseSnapshots\n request. If your results are paginated, the response will return a next page token that you\n can specify as the page token in a subsequent request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotsResult": { - "type": "structure", - "members": { - "relationalDatabaseSnapshots": { - "target": "com.amazonaws.lightsail#RelationalDatabaseSnapshotList", - "traits": { - "smithy.api#documentation": "

An object describing the result of your get relational database snapshots request.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another\n GetRelationalDatabaseSnapshots request and specify the next page token using\n the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabases": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetRelationalDatabasesRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetRelationalDatabasesResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about all of your databases in Amazon Lightsail.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetRelationalDatabases", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabasesRequest": { - "type": "structure", - "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabases request. If\n your results are paginated, the response will return a next page token that you can specify as\n the page token in a subsequent request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetRelationalDatabasesResult": { - "type": "structure", - "members": { - "relationalDatabases": { - "target": "com.amazonaws.lightsail#RelationalDatabaseList", - "traits": { - "smithy.api#documentation": "

An object describing the result of your get relational databases request.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetRelationalDatabases\n request and specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetStaticIp": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetStaticIpRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetStaticIpResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about an Amazon Lightsail static IP.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetStaticIp", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetStaticIpRequest": { - "type": "structure", - "members": { - "staticIpName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the static IP in Lightsail.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetStaticIpResult": { - "type": "structure", - "members": { - "staticIp": { - "target": "com.amazonaws.lightsail#StaticIp", - "traits": { - "smithy.api#documentation": "

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

" - } - } - } - }, - "com.amazonaws.lightsail#GetStaticIps": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetStaticIpsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetStaticIpsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetStaticIps", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetStaticIpsRequest": { - "type": "structure", - "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetStaticIps request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#GetStaticIpsResult": { - "type": "structure", - "members": { - "staticIps": { - "target": "com.amazonaws.lightsail#StaticIpList", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetStaticIps request and\n specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#HeaderEnum": { - "type": "enum", - "members": { - "accept": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Accept" - } - }, - "acceptCharset": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Accept-Charset" - } - }, - "acceptDatetime": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Accept-Datetime" - } - }, - "acceptEncoding": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Accept-Encoding" - } - }, - "acceptLanguage": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Accept-Language" - } - }, - "authorization": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Authorization" - } - }, - "cloudFrontForwardedProto": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CloudFront-Forwarded-Proto" - } - }, - "cloudFrontIsDesktopViewer": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CloudFront-Is-Desktop-Viewer" - } - }, - "cloudFrontIsMobileViewer": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CloudFront-Is-Mobile-Viewer" - } - }, - "cloudFrontIsSmartTVViewer": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CloudFront-Is-SmartTV-Viewer" - } - }, - "cloudFrontIsTabletViewer": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CloudFront-Is-Tablet-Viewer" - } - }, - "cloudFrontViewerCountry": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CloudFront-Viewer-Country" - } - }, - "host": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Host" - } - }, - "origin": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Origin" - } - }, - "referer": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Referer" - } - } - } - }, - "com.amazonaws.lightsail#HeaderForwardList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#HeaderEnum" - } - }, - "com.amazonaws.lightsail#HeaderObject": { - "type": "structure", - "members": { - "option": { - "target": "com.amazonaws.lightsail#ForwardValues", - "traits": { - "smithy.api#documentation": "

The headers that you want your distribution to forward to your origin and base caching\n on.

\n

You can configure your distribution to do one of the following:

\n " - } - }, - "headersAllowList": { - "target": "com.amazonaws.lightsail#HeaderForwardList", - "traits": { - "smithy.api#documentation": "

The specific headers to forward to your distribution's origin.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the request headers that a Lightsail distribution bases caching on.

\n

For the headers that you specify, your distribution caches separate versions of the\n specified content based on the header values in viewer requests. For example, suppose viewer\n requests for logo.jpg contain a custom product header that has a\n value of either acme or apex, and you configure your distribution to\n cache your content based on values in the product header. Your distribution\n forwards the product header to the origin and caches the response from the origin\n once for each header value.\n

" - } - }, - "com.amazonaws.lightsail#HostKeyAttributes": { - "type": "structure", - "members": { - "algorithm": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The SSH host key algorithm or the RDP certificate format.

\n

For SSH host keys, the algorithm may be ssh-rsa,\n ecdsa-sha2-nistp256, ssh-ed25519, etc. For RDP certificates, the\n algorithm is always x509-cert.

" - } - }, - "publicKey": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The public SSH host key or the RDP certificate.

" - } - }, - "witnessedAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The time that the SSH host key or RDP certificate was recorded by Lightsail.

" - } - }, - "fingerprintSHA1": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The SHA-1 fingerprint of the returned SSH host key or RDP certificate.

\n " - } - }, - "fingerprintSHA256": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The SHA-256 fingerprint of the returned SSH host key or RDP certificate.

\n " - } - }, - "notValidBefore": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The returned RDP certificate is valid after this point in time.

\n

This value is listed only for RDP certificates.

" - } - }, - "notValidAfter": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The returned RDP certificate is not valid after this point in time.

\n

This value is listed only for RDP certificates.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the public SSH host keys or the RDP certificate.

" - } - }, - "com.amazonaws.lightsail#HostKeysList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#HostKeyAttributes" - } - }, - "com.amazonaws.lightsail#HttpEndpoint": { - "type": "enum", - "members": { - "disabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disabled" - } - }, - "enabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enabled" - } - } - } - }, - "com.amazonaws.lightsail#HttpProtocolIpv6": { - "type": "enum", - "members": { - "disabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disabled" - } - }, - "enabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enabled" - } - } - } - }, - "com.amazonaws.lightsail#HttpTokens": { - "type": "enum", - "members": { - "optional": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "optional" - } - }, - "required": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "required" - } - } - } - }, - "com.amazonaws.lightsail#IAMAccessKeyId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 20 - }, - "smithy.api#pattern": "^[A-Z0-9]{20}$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.lightsail#ImportKeyPair": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#ImportKeyPairRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#ImportKeyPairResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Imports a public SSH key from a specific key pair.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/ImportKeyPair", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#ImportKeyPairRequest": { - "type": "structure", - "members": { - "keyPairName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - }, - "publicKeyBase64": { - "target": "com.amazonaws.lightsail#Base64", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#ImportKeyPairResult": { - "type": "structure", - "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#InUseResourceCount": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.lightsail#IncludeCertificateDetails": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.lightsail#InputOrigin": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the origin resource.

" - } - }, - "regionName": { - "target": "com.amazonaws.lightsail#RegionName", - "traits": { - "smithy.api#documentation": "

The AWS Region name of the origin resource.

" - } - }, - "protocolPolicy": { - "target": "com.amazonaws.lightsail#OriginProtocolPolicyEnum", - "traits": { - "smithy.api#documentation": "

The protocol that your Amazon Lightsail distribution uses when establishing a connection\n with your origin to pull content.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the origin resource of an Amazon Lightsail content delivery network (CDN)\n distribution.

\n

An origin can be a Lightsail instance, bucket, or load balancer. A distribution pulls\n content from an origin, caches it, and serves it to viewers via a worldwide network of edge\n servers.

" - } - }, - "com.amazonaws.lightsail#Instance": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the instance was created (e.g., 1479734909.17) in Unix\n time format.

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

The region name and Availability Zone where the instance is located.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The type of resource (usually Instance).

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" - } - }, - "blueprintId": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "blueprintName": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "bundleId": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "addOns": { - "target": "com.amazonaws.lightsail#AddOnList", - "traits": { - "smithy.api#documentation": "

An array of objects representing the add-ons enabled on the instance.

" - } - }, - "isStaticIp": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "privateIpAddress": { - "target": "com.amazonaws.lightsail#IpAddress", - "traits": { - "smithy.api#documentation": "

The private IP address of the instance.

" - } - }, - "publicIpAddress": { - "target": "com.amazonaws.lightsail#IpAddress", - "traits": { - "smithy.api#documentation": "

The public IP address of the instance.

" - } - }, - "ipv6Addresses": { - "target": "com.amazonaws.lightsail#Ipv6AddressList", - "traits": { - "smithy.api#documentation": "

The IPv6 addresses of the instance.

" - } - }, - "ipAddressType": { - "target": "com.amazonaws.lightsail#IpAddressType", - "traits": { - "smithy.api#documentation": "

The IP address type of the instance.

\n

The possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.

" - } - }, - "hardware": { - "target": "com.amazonaws.lightsail#InstanceHardware", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "networking": { - "target": "com.amazonaws.lightsail#InstanceNetworking", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "state": { - "target": "com.amazonaws.lightsail#InstanceState", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "username": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "sshKeyName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "metadataOptions": { - "target": "com.amazonaws.lightsail#InstanceMetadataOptions", - "traits": { - "smithy.api#documentation": "

The metadata options for the Amazon Lightsail instance.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an instance (a virtual private server).

" - } - }, - "com.amazonaws.lightsail#InstanceAccessDetails": { - "type": "structure", - "members": { - "certKey": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "expiresAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "ipAddress": { - "target": "com.amazonaws.lightsail#IpAddress", - "traits": { - "smithy.api#documentation": "

The public IP address of the Amazon Lightsail instance.

" - } - }, - "password": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

For RDP access, the password for your Amazon Lightsail instance. Password will be an empty\n string if the password for your new instance is not ready yet. When you create an instance, it\n can take up to 15 minutes for the instance to be ready.

\n \n

If you create an instance using any key pair other than the default\n (LightsailDefaultKeyPair), password will always be an empty\n string.

\n

If you change the Administrator password on the instance, Lightsail will continue to\n return the original password value. When accessing the instance using RDP, you need to\n manually enter the Administrator password after changing it from the default.

\n " - } - }, - "passwordData": { - "target": "com.amazonaws.lightsail#PasswordData", - "traits": { - "smithy.api#documentation": "

For a Windows Server-based instance, an object with the data you can use to retrieve your\n password. This is only needed if password is empty and the instance is not new\n (and therefore the password is not ready yet). When you create an instance, it can take up to\n 15 minutes for the instance to be ready.

" - } - }, - "privateKey": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "protocol": { - "target": "com.amazonaws.lightsail#InstanceAccessProtocol", - "traits": { - "smithy.api#documentation": "

The protocol for these Amazon Lightsail instance access details.

" - } - }, - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of this Amazon Lightsail instance.

" - } - }, - "username": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "hostKeys": { - "target": "com.amazonaws.lightsail#HostKeysList", - "traits": { - "smithy.api#documentation": "

Describes the public SSH host keys or the RDP certificate.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "com.amazonaws.lightsail#InstanceAccessProtocol": { - "type": "enum", - "members": { - "ssh": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ssh" - } - }, - "rdp": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "rdp" - } - } - } - }, - "com.amazonaws.lightsail#InstanceEntry": { - "type": "structure", - "members": { - "sourceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the export snapshot record, which contains the exported Lightsail instance\n snapshot that will be used as the source of the new Amazon EC2 instance.

\n

Use the get export snapshot records operation to get a list of export\n snapshot records that you can use to create a CloudFormation stack.

", - "smithy.api#required": {} - } - }, - "instanceType": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The instance type (e.g., t2.micro) to use for the new Amazon EC2 instance.

", - "smithy.api#required": {} - } - }, - "portInfoSource": { - "target": "com.amazonaws.lightsail#PortInfoSourceType", - "traits": { - "smithy.api#documentation": "

The port configuration to use for the new Amazon EC2 instance.

\n

The following configuration options are available:

\n \n \n

If you configured lightsail-connect as a cidrListAliases on\n your instance, or if you chose to allow the Lightsail browser-based SSH or RDP clients to\n connect to your instance, that configuration is not carried over to your new Amazon EC2\n instance.

\n ", - "smithy.api#required": {} - } - }, - "userData": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

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

\n \n

Depending on the machine image you choose, the command to get software on your instance\n varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use\n apt-get, and FreeBSD uses pkg.

\n " - } - }, - "availabilityZone": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The Availability Zone for the new Amazon EC2 instance.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the Amazon Elastic Compute Cloud instance and related resources to be created using the\n create cloud formation stack operation.

" - } - }, - "com.amazonaws.lightsail#InstanceEntryList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#InstanceEntry" - } - }, - "com.amazonaws.lightsail#InstanceHardware": { - "type": "structure", - "members": { - "cpuCount": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The number of vCPUs the instance has.

" - } - }, - "disks": { - "target": "com.amazonaws.lightsail#DiskList", - "traits": { - "smithy.api#documentation": "

The disks attached to the instance.

" - } - }, - "ramSizeInGb": { - "target": "com.amazonaws.lightsail#float", - "traits": { - "smithy.api#documentation": "

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

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the hardware for the instance.

" - } - }, - "com.amazonaws.lightsail#InstanceHealthReason": { - "type": "enum", - "members": { - "LbRegistrationInProgress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Lb.RegistrationInProgress" - } - }, - "LbInitialHealthChecking": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Lb.InitialHealthChecking" - } - }, - "LbInternalError": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Lb.InternalError" - } - }, - "InstanceResponseCodeMismatch": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Instance.ResponseCodeMismatch" - } - }, - "InstanceTimeout": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Instance.Timeout" - } - }, - "InstanceFailedHealthChecks": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Instance.FailedHealthChecks" - } - }, - "InstanceNotRegistered": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Instance.NotRegistered" - } - }, - "InstanceNotInUse": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Instance.NotInUse" - } - }, - "InstanceDeregistrationInProgress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Instance.DeregistrationInProgress" - } - }, - "InstanceInvalidState": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Instance.InvalidState" - } - }, - "InstanceIpUnusable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Instance.IpUnusable" - } - } - } - }, - "com.amazonaws.lightsail#InstanceHealthState": { - "type": "enum", - "members": { - "Initial": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "initial" - } - }, - "Healthy": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "healthy" - } - }, - "Unhealthy": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unhealthy" - } - }, - "Unused": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unused" - } - }, - "Draining": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "draining" - } - }, - "Unavailable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unavailable" - } - } - } - }, - "com.amazonaws.lightsail#InstanceHealthSummary": { - "type": "structure", - "members": { - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the Lightsail instance for which you are requesting health check\n data.

" - } - }, - "instanceHealth": { - "target": "com.amazonaws.lightsail#InstanceHealthState", - "traits": { - "smithy.api#documentation": "

Describes the overall instance health. Valid values are below.

" - } - }, - "instanceHealthReason": { - "target": "com.amazonaws.lightsail#InstanceHealthReason", - "traits": { - "smithy.api#documentation": "

More information about the instance health. If the instanceHealth is\n healthy, then an instanceHealthReason value is not\n provided.

\n

If \n instanceHealth\n is initial,\n the \n instanceHealthReason\n value can be one of the\n following:

\n \n

If \n instanceHealth\n is unhealthy,\n the \n instanceHealthReason\n value can be one of the\n following:

\n \n

If \n instanceHealth\n is unused,\n the \n instanceHealthReason\n value can be one of the\n following:

\n \n

If \n instanceHealth\n is draining,\n the \n instanceHealthReason\n value can be one of the\n following:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes information about the health of the instance.

" - } - }, - "com.amazonaws.lightsail#InstanceHealthSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#InstanceHealthSummary" - } - }, - "com.amazonaws.lightsail#InstanceList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#Instance" - } - }, - "com.amazonaws.lightsail#InstanceMetadataOptions": { - "type": "structure", - "members": { - "state": { - "target": "com.amazonaws.lightsail#InstanceMetadataState", - "traits": { - "smithy.api#documentation": "

The state of the metadata option changes.

\n

The following states are possible:

\n " - } - }, - "httpTokens": { - "target": "com.amazonaws.lightsail#HttpTokens", - "traits": { - "smithy.api#documentation": "

The state of token usage for your instance metadata requests.

\n

If the state is optional, you can choose whether to retrieve instance\n metadata with a signed token header on your request. If you retrieve the IAM role credentials\n without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role\n credentials by using a valid signed token, the version 2.0 role credentials are\n returned.

\n

If the state is required, you must send a signed token header with all\n instance metadata retrieval requests. In this state, retrieving the IAM role credential always\n returns the version 2.0 credentials. The version 1.0 credentials are not available.

\n \n

Not all instance blueprints in Lightsail support version 2.0 credentials.\n Use the MetadataNoToken instance metric to track the number of calls to the\n instance metadata service that are using version 1.0 credentials. For more information, see\n Viewing instance metrics in Amazon Lightsail in the Amazon Lightsail Developer Guide.

\n " - } - }, - "httpEndpoint": { - "target": "com.amazonaws.lightsail#HttpEndpoint", - "traits": { - "smithy.api#documentation": "

Indicates whether the HTTP metadata endpoint on your instances is enabled or\n disabled.

\n

If the value is disabled, you cannot access your instance metadata.

" - } - }, - "httpPutResponseHopLimit": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. A larger number\n means that the instance metadata requests can travel farther.

" - } - }, - "httpProtocolIpv6": { - "target": "com.amazonaws.lightsail#HttpProtocolIpv6", - "traits": { - "smithy.api#documentation": "

Indicates whether the IPv6 endpoint for the instance metadata service is enabled or\n disabled.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The metadata options for the instance.

" - } - }, - "com.amazonaws.lightsail#InstanceMetadataState": { - "type": "enum", - "members": { - "pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "applied": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "applied" - } - } - } - }, - "com.amazonaws.lightsail#InstanceMetricName": { - "type": "enum", - "members": { - "CPUUtilization": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CPUUtilization" - } - }, - "NetworkIn": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NetworkIn" - } - }, - "NetworkOut": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NetworkOut" - } - }, - "StatusCheckFailed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "StatusCheckFailed" - } - }, - "StatusCheckFailed_Instance": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "StatusCheckFailed_Instance" - } - }, - "StatusCheckFailed_System": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "StatusCheckFailed_System" - } - }, - "BurstCapacityTime": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BurstCapacityTime" - } - }, - "BurstCapacityPercentage": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BurstCapacityPercentage" - } - }, - "MetadataNoToken": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MetadataNoToken" - } - } - } - }, - "com.amazonaws.lightsail#InstanceNetworking": { - "type": "structure", - "members": { - "monthlyTransfer": { - "target": "com.amazonaws.lightsail#MonthlyTransfer", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "ports": { - "target": "com.amazonaws.lightsail#InstancePortInfoList", - "traits": { - "smithy.api#documentation": "

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

" - } - } - }, - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "com.amazonaws.lightsail#InstancePlatform": { - "type": "enum", - "members": { - "LinuxUnix": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LINUX_UNIX" - } - }, - "Windows": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WINDOWS" - } - } - } - }, - "com.amazonaws.lightsail#InstancePlatformList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#InstancePlatform" - } - }, - "com.amazonaws.lightsail#InstancePortInfo": { - "type": "structure", - "members": { - "fromPort": { - "target": "com.amazonaws.lightsail#Port", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The first port in a range of open ports on an instance.

\n

Allowed ports:

\n " - } - }, - "toPort": { - "target": "com.amazonaws.lightsail#Port", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The last port in a range of open ports on an instance.

\n

Allowed ports:

\n " - } - }, - "protocol": { - "target": "com.amazonaws.lightsail#NetworkProtocol", - "traits": { - "smithy.api#documentation": "

The IP protocol name.

\n

The name can be one of the following:

\n " - } - }, - "accessFrom": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The location from which access is allowed. For example, Anywhere (0.0.0.0/0),\n or Custom if a specific IP address or range of IP addresses is allowed.

" - } - }, - "accessType": { - "target": "com.amazonaws.lightsail#PortAccessType", - "traits": { - "smithy.api#documentation": "

The type of access (Public or Private).

" - } - }, - "commonName": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The common name of the port information.

" - } - }, - "accessDirection": { - "target": "com.amazonaws.lightsail#AccessDirection", - "traits": { - "smithy.api#documentation": "

The access direction (inbound or outbound).

\n \n

Lightsail currently supports only inbound access direction.

\n " - } - }, - "cidrs": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to\n connect to an instance through the ports, and the protocol.

\n \n

The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to\n connect to an instance.

\n \n

For more information about CIDR block notation, see Classless\n Inter-Domain Routing on Wikipedia.

" - } - }, - "ipv6Cidrs": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to\n connect to an instance through the ports, and the protocol. Only devices with an IPv6 address\n can connect to an instance through IPv6; otherwise, IPv4 should be used.

\n \n

The cidrs parameter lists the IPv4 addresses that are allowed to connect to\n an instance.

\n \n

For more information about CIDR block notation, see Classless\n Inter-Domain Routing on Wikipedia.

" - } - }, - "cidrListAliases": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

An alias that defines access for a preconfigured range of IP addresses.

\n

The only alias currently supported is lightsail-connect, which allows IP\n addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your\n instance.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes information about ports for an Amazon Lightsail instance.

" - } - }, - "com.amazonaws.lightsail#InstancePortInfoList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#InstancePortInfo" - } - }, - "com.amazonaws.lightsail#InstancePortState": { - "type": "structure", - "members": { - "fromPort": { - "target": "com.amazonaws.lightsail#Port", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The first port in a range of open ports on an instance.

\n

Allowed ports:

\n " - } - }, - "toPort": { - "target": "com.amazonaws.lightsail#Port", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The last port in a range of open ports on an instance.

\n

Allowed ports:

\n " - } - }, - "protocol": { - "target": "com.amazonaws.lightsail#NetworkProtocol", - "traits": { - "smithy.api#documentation": "

The IP protocol name.

\n

The name can be one of the following:

\n " - } - }, - "state": { - "target": "com.amazonaws.lightsail#PortState", - "traits": { - "smithy.api#documentation": "

Specifies whether the instance port is open or closed.

\n \n

The port state for Lightsail instances is always open.

\n " - } - }, - "cidrs": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to\n connect to an instance through the ports, and the protocol.

\n \n

The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to\n connect to an instance.

\n \n

For more information about CIDR block notation, see Classless\n Inter-Domain Routing on Wikipedia.

" - } - }, - "ipv6Cidrs": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to\n connect to an instance through the ports, and the protocol. Only devices with an IPv6 address\n can connect to an instance through IPv6; otherwise, IPv4 should be used.

\n \n

The cidrs parameter lists the IPv4 addresses that are allowed to connect to\n an instance.

\n \n

For more information about CIDR block notation, see Classless\n Inter-Domain Routing on Wikipedia.

" - } - }, - "cidrListAliases": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

An alias that defines access for a preconfigured range of IP addresses.

\n

The only alias currently supported is lightsail-connect, which allows IP\n addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your\n instance.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes open ports on an instance, the IP addresses allowed to connect to the instance\n through the ports, and the protocol.

" - } - }, - "com.amazonaws.lightsail#InstancePortStateList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#InstancePortState" - } - }, - "com.amazonaws.lightsail#InstanceSnapshot": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the snapshot.

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

The region name and Availability Zone where you created the snapshot.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The type of resource (usually InstanceSnapshot).

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" - } - }, - "state": { - "target": "com.amazonaws.lightsail#InstanceSnapshotState", - "traits": { - "smithy.api#documentation": "

The state the snapshot is in.

" - } - }, - "progress": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The progress of the snapshot.

\n \n

This is populated only for disk snapshots, and is null for instance\n snapshots.

\n " - } - }, - "fromAttachedDisks": { - "target": "com.amazonaws.lightsail#DiskList", - "traits": { - "smithy.api#documentation": "

An array of disk objects containing information about all block storage disks.

" - } - }, - "fromInstanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The instance from which the snapshot was created.

" - } - }, - "fromInstanceArn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "fromBlueprintId": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "fromBundleId": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "isFromAutoSnapshot": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the snapshot was created from an automatic\n snapshot.

" - } - }, - "sizeInGb": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The size in GB of the SSD.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an instance snapshot.

" - } - }, - "com.amazonaws.lightsail#InstanceSnapshotInfo": { - "type": "structure", - "members": { - "fromBundleId": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The bundle ID from which the source instance was created (e.g.,\n micro_1_0).

" - } - }, - "fromBlueprintId": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The blueprint ID from which the source instance (e.g., os_debian_8_3).

" - } - }, - "fromDiskInfo": { - "target": "com.amazonaws.lightsail#DiskInfoList", - "traits": { - "smithy.api#documentation": "

A list of objects describing the disks that were attached to the source instance.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an instance snapshot.

" - } - }, - "com.amazonaws.lightsail#InstanceSnapshotList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#InstanceSnapshot" - } - }, - "com.amazonaws.lightsail#InstanceSnapshotState": { - "type": "enum", - "members": { - "Pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "Error": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "error" - } - }, - "Available": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "available" - } - } - } - }, - "com.amazonaws.lightsail#InstanceState": { - "type": "structure", - "members": { - "code": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The status code for the instance.

" - } - }, - "name": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

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

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the virtual private server (or instance) status.

" - } - }, - "com.amazonaws.lightsail#InvalidInputException": { - "type": "structure", - "members": { - "code": { - "target": "com.amazonaws.lightsail#string" + "com.amazonaws.lightsail#AccessKeyLastUsed": { + "type": "structure", + "members": { + "lastUsedDate": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The date and time when the access key was most recently used.

\n

This value is null if the access key has not been used.

" + } + }, + "region": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region where this access key was most recently used.

\n

This value is N/A if the access key has not been used.

" + } + }, + "serviceName": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Web Services service with which this access key was most recently\n used.

\n

This value is N/A if the access key has not been used.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the last time an access key was used.

\n \n

This object does not include data in the response of a CreateBucketAccessKey action.

\n " + } + }, + "com.amazonaws.lightsail#AccessKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#AccessKey" + } + }, + "com.amazonaws.lightsail#AccessReceiverList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#ResourceReceivingAccess" + } + }, + "com.amazonaws.lightsail#AccessRules": { + "type": "structure", + "members": { + "getObject": { + "target": "com.amazonaws.lightsail#AccessType", + "traits": { + "smithy.api#documentation": "

Specifies the anonymous access to all objects in a bucket.

\n

The following options can be specified:

\n " + } + }, + "allowPublicOverrides": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether the access control list (ACL) permissions that are\n applied to individual objects override the getObject option that is currently\n specified.

\n

When this is true, you can use the PutObjectAcl Amazon S3 API action to set\n individual objects to public (read-only) using the public-read ACL, or to private\n using the private ACL.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the anonymous access permissions for an Amazon Lightsail bucket and its\n objects.

\n

For more information about bucket access permissions, see Understanding bucket permissions in Amazon Lightsail in the

\n

\n Amazon Lightsail Developer Guide.

" + } + }, + "com.amazonaws.lightsail#AccessType": { + "type": "enum", + "members": { + "Public": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "public" + } + }, + "Private": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "private" + } + } + } + }, + "com.amazonaws.lightsail#AccountLevelBpaSync": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.lightsail#AccountLevelBpaSyncStatus", + "traits": { + "smithy.api#documentation": "

The status of the account-level BPA synchronization.

\n

The following statuses are possible:

\n \n \n

You might need to complete further actions if the status is Failed or\n Defaulted. The message parameter provides more information for\n those statuses.

\n " + } + }, + "lastSyncedAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp of when the account-level BPA configuration was last synchronized. This\n value is null when the account-level BPA configuration has not been synchronized.

" + } + }, + "message": { + "target": "com.amazonaws.lightsail#BPAStatusMessage", + "traits": { + "smithy.api#documentation": "

A message that provides a reason for a Failed or Defaulted\n synchronization status.

\n

The following messages are possible:

\n " + } + }, + "bpaImpactsLightsail": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether account-level block public access is affecting your\n Lightsail buckets.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the synchronization status of the Amazon Simple Storage Service (Amazon S3)\n account-level block public access (BPA) feature for your Lightsail buckets.

\n

The account-level BPA feature of Amazon S3 provides centralized controls to limit\n public access to all Amazon S3 buckets in an account. BPA can make all Amazon S3 buckets in an Amazon Web Services account private regardless of the individual bucket and\n object permissions that are configured. Lightsail buckets take into account the\n Amazon S3 account-level BPA configuration when allowing or denying public access. To\n do this, Lightsail periodically fetches the account-level BPA configuration\n from Amazon S3. When the account-level BPA status is InSync, the Amazon S3 account-level BPA configuration is synchronized and it applies to your Lightsail\n buckets. For more information about Amazon Simple Storage Service account-level BPA and how it affects\n Lightsail buckets, see Block public access for buckets in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

" + } + }, + "com.amazonaws.lightsail#AccountLevelBpaSyncStatus": { + "type": "enum", + "members": { + "InSync": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InSync" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "NeverSynced": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NeverSynced" + } + }, + "Defaulted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Defaulted" + } + } + } + }, + "com.amazonaws.lightsail#AccountSetupInProgressException": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.lightsail#string" + }, + "docs": { + "target": "com.amazonaws.lightsail#string" + }, + "message": { + "target": "com.amazonaws.lightsail#string" + }, + "tip": { + "target": "com.amazonaws.lightsail#string" + } + }, + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#error": "client", + "smithy.api#httpError": 428 + } + }, + "com.amazonaws.lightsail#AddOn": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The name of the add-on.

" + } + }, + "status": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The status of the add-on.

" + } + }, + "snapshotTimeOfDay": { + "target": "com.amazonaws.lightsail#TimeOfDay", + "traits": { + "smithy.api#documentation": "

The daily time when an automatic snapshot is created.

\n

The time shown is in HH:00 format, and in Coordinated Universal Time\n (UTC).

\n

The snapshot is automatically created between the time shown and up to 45 minutes\n after.

" + } + }, + "nextSnapshotTimeOfDay": { + "target": "com.amazonaws.lightsail#TimeOfDay", + "traits": { + "smithy.api#documentation": "

The next daily time an automatic snapshot will be created.

\n

The time shown is in HH:00 format, and in Coordinated Universal Time\n (UTC).

\n

The snapshot is automatically created between the time shown and up to 45 minutes\n after.

" + } + }, + "threshold": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The trigger threshold of the action.

\n \n

This add-on only applies to Lightsail for Research resources.

\n " + } + }, + "duration": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The amount of idle time in minutes after which your virtual computer will automatically stop.

\n \n

This add-on only applies to Lightsail for Research resources.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an add-on that is enabled for an Amazon Lightsail resource.

" + } + }, + "com.amazonaws.lightsail#AddOnList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#AddOn" + } + }, + "com.amazonaws.lightsail#AddOnRequest": { + "type": "structure", + "members": { + "addOnType": { + "target": "com.amazonaws.lightsail#AddOnType", + "traits": { + "smithy.api#documentation": "

The add-on type.

", + "smithy.api#required": {} + } + }, + "autoSnapshotAddOnRequest": { + "target": "com.amazonaws.lightsail#AutoSnapshotAddOnRequest", + "traits": { + "smithy.api#documentation": "

An object that represents additional parameters when enabling or modifying the automatic\n snapshot add-on.

" + } + }, + "stopInstanceOnIdleRequest": { + "target": "com.amazonaws.lightsail#StopInstanceOnIdleRequest", + "traits": { + "smithy.api#documentation": "

An object that represents additional parameters when enabling or modifying the\n StopInstanceOnIdle add-on.

\n \n

This object only applies to Lightsail for Research resources.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a request to enable, modify, or disable an add-on for an Amazon Lightsail\n resource.

\n \n

An additional cost may be associated with enabling add-ons. For more information, see\n the Lightsail pricing\n page.

\n " + } + }, + "com.amazonaws.lightsail#AddOnRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#AddOnRequest" + } + }, + "com.amazonaws.lightsail#AddOnType": { + "type": "enum", + "members": { + "AutoSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AutoSnapshot" + } + }, + "StopInstanceOnIdle": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StopInstanceOnIdle" + } + } + } + }, + "com.amazonaws.lightsail#Alarm": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the alarm.

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the alarm.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the alarm was created.

" + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

An object that lists information about the location of the alarm.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The Lightsail resource type (e.g., Alarm).

" + } + }, + "supportCode": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail alarm. This code enables our support team to look up your Lightsail\n information more easily.

" + } + }, + "monitoredResourceInfo": { + "target": "com.amazonaws.lightsail#MonitoredResourceInfo", + "traits": { + "smithy.api#documentation": "

An object that lists information about the resource monitored by the alarm.

" + } + }, + "comparisonOperator": { + "target": "com.amazonaws.lightsail#ComparisonOperator", + "traits": { + "smithy.api#documentation": "

The arithmetic operation used when comparing the specified statistic and threshold.

" + } + }, + "evaluationPeriods": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The number of periods over which data is compared to the specified threshold.

" + } + }, + "period": { + "target": "com.amazonaws.lightsail#MetricPeriod", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The period, in seconds, over which the statistic is applied.

" + } + }, + "threshold": { + "target": "com.amazonaws.lightsail#double", + "traits": { + "smithy.api#documentation": "

The value against which the specified statistic is compared.

" + } + }, + "datapointsToAlarm": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The number of data points that must not within the specified threshold to trigger the\n alarm.

" + } + }, + "treatMissingData": { + "target": "com.amazonaws.lightsail#TreatMissingData", + "traits": { + "smithy.api#documentation": "

Specifies how the alarm handles missing data points.

\n

An alarm can treat missing data in the following ways:

\n " + } + }, + "statistic": { + "target": "com.amazonaws.lightsail#MetricStatistic", + "traits": { + "smithy.api#documentation": "

The statistic for the metric associated with the alarm.

\n

The following statistics are available:

\n " + } + }, + "metricName": { + "target": "com.amazonaws.lightsail#MetricName", + "traits": { + "smithy.api#documentation": "

The name of the metric associated with the alarm.

" + } + }, + "state": { + "target": "com.amazonaws.lightsail#AlarmState", + "traits": { + "smithy.api#documentation": "

The current state of the alarm.

\n

An alarm has the following possible states:

\n " + } + }, + "unit": { + "target": "com.amazonaws.lightsail#MetricUnit", + "traits": { + "smithy.api#documentation": "

The unit of the metric associated with the alarm.

" + } + }, + "contactProtocols": { + "target": "com.amazonaws.lightsail#ContactProtocolsList", + "traits": { + "smithy.api#documentation": "

The contact protocols for the alarm, such as Email, SMS (text\n messaging), or both.

" + } + }, + "notificationTriggers": { + "target": "com.amazonaws.lightsail#NotificationTriggerList", + "traits": { + "smithy.api#documentation": "

The alarm states that trigger a notification.

" + } + }, + "notificationEnabled": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the alarm is enabled.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an alarm.

\n

An alarm is a way to monitor your Lightsail resource metrics. For more information, see\n Alarms in Amazon Lightsail.

" + } + }, + "com.amazonaws.lightsail#AlarmState": { + "type": "enum", + "members": { + "OK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OK" + } + }, + "ALARM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALARM" + } + }, + "INSUFFICIENT_DATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSUFFICIENT_DATA" + } + } + } + }, + "com.amazonaws.lightsail#AlarmsList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#Alarm" + } + }, + "com.amazonaws.lightsail#AllocateStaticIp": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#AllocateStaticIpRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#AllocateStaticIpResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Allocates a static IP address.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/AllocateStaticIp", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#AllocateStaticIpRequest": { + "type": "structure", + "members": { + "staticIpName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the static IP address.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#AllocateStaticIpResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#AppCategory": { + "type": "enum", + "members": { + "LfR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LfR" + } + } + } + }, + "com.amazonaws.lightsail#AppCategoryList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#AppCategory" + } + }, + "com.amazonaws.lightsail#AttachCertificateToDistribution": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#AttachCertificateToDistributionRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#AttachCertificateToDistributionResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN)\n distribution.

\n

After the certificate is attached, your distribution accepts HTTPS traffic for all of the\n domains that are associated with the certificate.

\n

Use the CreateCertificate action to create a certificate that you can attach\n to your distribution.

\n \n

Only certificates created in the us-east-1\n Amazon Web Services Region can be attached to Lightsail distributions. Lightsail\n distributions are global resources that can reference an origin in any Amazon Web Services\n Region, and distribute its content globally. However, all distributions are located in the\n us-east-1 Region.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/AttachCertificateToDistribution", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#AttachCertificateToDistributionRequest": { + "type": "structure", + "members": { + "distributionName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the distribution that the certificate will be attached to.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

", + "smithy.api#required": {} + } + }, + "certificateName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the certificate to attach to a distribution.

\n

Only certificates with a status of ISSUED can be attached to a\n distribution.

\n

Use the GetCertificates action to get a list of certificate names that you\n can specify.

\n \n

This is the name of the certificate resource type and is used only to reference the\n certificate in other API actions. It can be different than the domain name of the\n certificate. For example, your certificate name might be\n WordPress-Blog-Certificate and the domain name of the certificate might be\n example.com.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#AttachCertificateToDistributionResult": { + "type": "structure", + "members": { + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An object that describes the result of the action, such as the status of the request, the\n timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#AttachDisk": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#AttachDiskRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#AttachDiskResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Attaches a block storage disk to a running or stopped Lightsail instance and exposes it\n to the instance with the specified disk name.

\n

The attach disk operation supports tag-based access control via resource tags\n applied to the resource identified by disk name. For more information, see the\n Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/AttachDisk", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#AttachDiskRequest": { + "type": "structure", + "members": { + "diskName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The unique Lightsail disk name (e.g., my-disk).

", + "smithy.api#required": {} + } + }, + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the Lightsail instance where you want to utilize the storage disk.

", + "smithy.api#required": {} + } + }, + "diskPath": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The disk path to expose to the instance (e.g., /dev/xvdf).

", + "smithy.api#required": {} + } + }, + "autoMounting": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value used to determine the automatic mounting of a storage volume to a virtual\n computer. The default value is False.

\n \n

This value only applies to Lightsail for Research resources.

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#AttachDiskResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#AttachInstancesToLoadBalancer": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#AttachInstancesToLoadBalancerRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#AttachInstancesToLoadBalancerResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Attaches one or more Lightsail instances to a load balancer.

\n

After some time, the instances are attached to the load balancer and the health check\n status is available.

\n

The attach instances to load balancer operation supports tag-based access\n control via resource tags applied to the resource identified by load balancer\n name. For more information, see the Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/AttachInstancesToLoadBalancer", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#AttachInstancesToLoadBalancerRequest": { + "type": "structure", + "members": { + "loadBalancerName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the load balancer.

", + "smithy.api#required": {} + } + }, + "instanceNames": { + "target": "com.amazonaws.lightsail#ResourceNameList", + "traits": { + "smithy.api#documentation": "

An array of strings representing the instance name(s) you want to attach to your load\n balancer.

\n

An instance must be running before you can attach it to your load\n balancer.

\n

There are no additional limits on the number of instances you can attach to your load\n balancer, aside from the limit of Lightsail instances you can create in your account\n (20).

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#AttachInstancesToLoadBalancerResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#AttachLoadBalancerTlsCertificate": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#AttachLoadBalancerTlsCertificateRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#AttachLoadBalancerTlsCertificateResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just\n an updated, more secure version of Secure Socket Layer (SSL).

\n

Once you create and validate your certificate, you can attach it to your load balancer.\n You can also use this API to rotate the certificates on your account. Use the\n AttachLoadBalancerTlsCertificate action with the non-attached certificate, and\n it will replace the existing one and become the attached certificate.

\n

The AttachLoadBalancerTlsCertificate operation supports tag-based access\n control via resource tags applied to the resource identified by load balancer\n name. For more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/AttachLoadBalancerTlsCertificate", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#AttachLoadBalancerTlsCertificateRequest": { + "type": "structure", + "members": { + "loadBalancerName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the load balancer to which you want to associate the SSL/TLS\n certificate.

", + "smithy.api#required": {} + } + }, + "certificateName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of your SSL/TLS certificate.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#AttachLoadBalancerTlsCertificateResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

\n

These SSL/TLS certificates are only usable by Lightsail load balancers. You can't get\n the certificate and use it for another purpose.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#AttachStaticIp": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#AttachStaticIpRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#AttachStaticIpResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/AttachStaticIp", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#AttachStaticIpRequest": { + "type": "structure", + "members": { + "staticIpName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the static IP.

", + "smithy.api#required": {} + } + }, + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#AttachStaticIpResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#AttachedDisk": { + "type": "structure", + "members": { + "path": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The path of the disk (e.g., /dev/xvdf).

" + } + }, + "sizeInGb": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The size of the disk in GB.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a block storage disk that is attached to an instance, and is included in an\n automatic snapshot.

" + } + }, + "com.amazonaws.lightsail#AttachedDiskList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#AttachedDisk" + } + }, + "com.amazonaws.lightsail#AttachedDiskMap": { + "type": "map", + "key": { + "target": "com.amazonaws.lightsail#ResourceName" + }, + "value": { + "target": "com.amazonaws.lightsail#DiskMapList" + } + }, + "com.amazonaws.lightsail#AutoMountStatus": { + "type": "enum", + "members": { + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "Mounted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Mounted" + } + }, + "NotMounted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotMounted" + } + } + } + }, + "com.amazonaws.lightsail#AutoSnapshotAddOnRequest": { + "type": "structure", + "members": { + "snapshotTimeOfDay": { + "target": "com.amazonaws.lightsail#TimeOfDay", + "traits": { + "smithy.api#documentation": "

The daily time when an automatic snapshot will be created.

\n

Constraints:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a request to enable or modify the automatic snapshot add-on for an\n Amazon Lightsail instance or disk.

\n

When you modify the automatic snapshot time for a resource, it is typically effective\n immediately except under the following conditions:

\n " + } + }, + "com.amazonaws.lightsail#AutoSnapshotDate": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + } + }, + "com.amazonaws.lightsail#AutoSnapshotDetails": { + "type": "structure", + "members": { + "date": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The date of the automatic snapshot in YYYY-MM-DD format.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the automatic snapshot was created.

" + } + }, + "status": { + "target": "com.amazonaws.lightsail#AutoSnapshotStatus", + "traits": { + "smithy.api#documentation": "

The status of the automatic snapshot.

" + } + }, + "fromAttachedDisks": { + "target": "com.amazonaws.lightsail#AttachedDiskList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the block storage disks attached to the instance when\n the automatic snapshot was created.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an automatic snapshot.

" + } + }, + "com.amazonaws.lightsail#AutoSnapshotDetailsList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#AutoSnapshotDetails" + } + }, + "com.amazonaws.lightsail#AutoSnapshotStatus": { + "type": "enum", + "members": { + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Success" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotFound" + } + } + } + }, + "com.amazonaws.lightsail#AvailabilityZone": { + "type": "structure", + "members": { + "zoneName": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the Availability Zone. The format is us-east-2a\n (case-sensitive).

" + } + }, + "state": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The state of the Availability Zone.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an Availability Zone. This is returned only as part of a GetRegions\n request.

" + } + }, + "com.amazonaws.lightsail#AvailabilityZoneList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#AvailabilityZone" + } + }, + "com.amazonaws.lightsail#BPAStatusMessage": { + "type": "enum", + "members": { + "DEFAULTED_FOR_SLR_MISSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULTED_FOR_SLR_MISSING" + } + }, + "SYNC_ON_HOLD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYNC_ON_HOLD" + } + }, + "DEFAULTED_FOR_SLR_MISSING_ON_HOLD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULTED_FOR_SLR_MISSING_ON_HOLD" + } + }, + "Unknown": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Unknown" + } + } + } + }, + "com.amazonaws.lightsail#Base64": { + "type": "string" + }, + "com.amazonaws.lightsail#BehaviorEnum": { + "type": "enum", + "members": { + "DontCacheSetting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dont-cache" + } + }, + "CacheSetting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cache" + } + } + } + }, + "com.amazonaws.lightsail#Blueprint": { + "type": "structure", + "members": { + "blueprintId": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "group": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "type": { + "target": "com.amazonaws.lightsail#BlueprintType", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "description": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The description of the blueprint.

" + } + }, + "isActive": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether the blueprint is active. Inactive blueprints are listed\n to support customers with existing instances but are not necessarily available for launch of\n new instances. Blueprints are marked inactive when they become outdated due to operating\n system updates or new application releases.

" + } + }, + "minPower": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The minimum bundle power required to run this blueprint. For example, you need a bundle\n with a power value of 500 or more to create an instance that uses a blueprint with a minimum\n power value of 500. 0 indicates that the blueprint runs on all instance sizes.\n

" + } + }, + "version": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "versionCode": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The version code.

" + } + }, + "productUrl": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "licenseUrl": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "platform": { + "target": "com.amazonaws.lightsail#InstancePlatform", + "traits": { + "smithy.api#documentation": "

The operating system platform (either Linux/Unix-based or Windows Server-based) of the\n blueprint.

" + } + }, + "appCategory": { + "target": "com.amazonaws.lightsail#AppCategory", + "traits": { + "smithy.api#documentation": "

Virtual computer blueprints that are supported by Lightsail for Research.

\n \n

This parameter only applies to Lightsail for Research resources.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a blueprint (a virtual private server image).

" + } + }, + "com.amazonaws.lightsail#BlueprintList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#Blueprint" + } + }, + "com.amazonaws.lightsail#BlueprintType": { + "type": "enum", + "members": { + "os": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "os" + } + }, + "app": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "app" + } + } + } + }, + "com.amazonaws.lightsail#Bucket": { + "type": "structure", + "members": { + "resourceType": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Lightsail resource type of the bucket (for example, Bucket).

" + } + }, + "accessRules": { + "target": "com.amazonaws.lightsail#AccessRules", + "traits": { + "smithy.api#documentation": "

An object that describes the access rules of the bucket.

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the bucket.

" + } + }, + "bundleId": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the bundle currently applied to the bucket.

\n

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a\n bucket.

\n

Use the UpdateBucketBundle action to change the\n bundle of a bucket.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the distribution was created.

" + } + }, + "url": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The URL of the bucket.

" + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

An object that describes the location of the bucket, such as the Amazon Web Services Region\n and Availability Zone.

" + } + }, + "name": { + "target": "com.amazonaws.lightsail#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket.

" + } + }, + "supportCode": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The support code for a bucket. Include this code in your email to support when you have\n questions about a Lightsail bucket. This code enables our support team to look up your\n Lightsail information more easily.

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values for the bucket. For more information, see Tags in\n Amazon Lightsail in the Amazon Lightsail Developer Guide.

" + } + }, + "objectVersioning": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates whether object versioning is enabled for the bucket.

\n

The following options can be configured:

\n " + } + }, + "ableToUpdateBundle": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the bundle that is currently applied to a bucket can be changed to\n another bundle.

\n

You can update a bucket's bundle only one time within a monthly Amazon Web Services billing\n cycle.

\n

Use the UpdateBucketBundle action to change a\n bucket's bundle.

" + } + }, + "readonlyAccessAccounts": { + "target": "com.amazonaws.lightsail#PartnerIdList", + "traits": { + "smithy.api#documentation": "

An array of strings that specify the Amazon Web Services account IDs that have read-only\n access to the bucket.

" + } + }, + "resourcesReceivingAccess": { + "target": "com.amazonaws.lightsail#AccessReceiverList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe Lightsail instances that have access to the\n bucket.

\n

Use the SetResourceAccessForBucket\n action to update the instances that have access to a bucket.

" + } + }, + "state": { + "target": "com.amazonaws.lightsail#BucketState", + "traits": { + "smithy.api#documentation": "

An object that describes the state of the bucket.

" + } + }, + "accessLogConfig": { + "target": "com.amazonaws.lightsail#BucketAccessLogConfig", + "traits": { + "smithy.api#documentation": "

An object that describes the access log configuration for the bucket.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an Amazon Lightsail bucket.

" + } + }, + "com.amazonaws.lightsail#BucketAccessLogConfig": { + "type": "structure", + "members": { + "enabled": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether bucket access logging is enabled for the\n bucket.

", + "smithy.api#required": {} + } + }, + "destination": { + "target": "com.amazonaws.lightsail#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket where the access logs are saved. The destination can be a\n Lightsail bucket in the same account, and in the same Amazon Web Services Region as the\n source bucket.

\n \n

This parameter is required when enabling the access log for a bucket, and should be\n omitted when disabling the access log.

\n " + } + }, + "prefix": { + "target": "com.amazonaws.lightsail#BucketAccessLogPrefix", + "traits": { + "smithy.api#documentation": "

The optional object prefix for the bucket access log.

\n

The prefix is an optional addition to the object key that organizes your access log files\n in the destination bucket. For example, if you specify a logs/ prefix, then each\n log object will begin with the logs/ prefix in its key (for example,\n logs/2021-11-01-21-32-16-E568B2907131C0C0).

\n \n

This parameter can be optionally specified when enabling the access log for a bucket,\n and should be omitted when disabling the access log.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the access log configuration for a bucket in the Amazon Lightsail object storage\n service.

\n

For more information about bucket access logs, see Logging bucket requests using access logging in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

" + } + }, + "com.amazonaws.lightsail#BucketAccessLogPrefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[\\w/!.*')(-]+$" + } + }, + "com.amazonaws.lightsail#BucketBundle": { + "type": "structure", + "members": { + "bundleId": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the bundle.

" + } + }, + "name": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the bundle.

" + } + }, + "price": { + "target": "com.amazonaws.lightsail#float", + "traits": { + "smithy.api#documentation": "

The monthly price of the bundle, in US dollars.

" + } + }, + "storagePerMonthInGb": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The storage size of the bundle, in GB.

" + } + }, + "transferPerMonthInGb": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The monthly network transfer quota of the bundle.

" + } + }, + "isActive": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the bundle is active. Use for a new or existing bucket.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the specifications of a bundle that can be applied to an Amazon Lightsail\n bucket.

\n

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a\n bucket.

" + } + }, + "com.amazonaws.lightsail#BucketBundleList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#BucketBundle" + } + }, + "com.amazonaws.lightsail#BucketList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#Bucket" + } + }, + "com.amazonaws.lightsail#BucketMetricName": { + "type": "enum", + "members": { + "BucketSizeBytes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BucketSizeBytes" + } + }, + "NumberOfObjects": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NumberOfObjects" + } + } + } + }, + "com.amazonaws.lightsail#BucketName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 54 + }, + "smithy.api#pattern": "^[a-z0-9][a-z0-9-]{1,52}[a-z0-9]$" + } + }, + "com.amazonaws.lightsail#BucketState": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The state code of the bucket.

\n

The following codes are possible:

\n " + } + }, + "message": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

A message that describes the state of the bucket.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the state of an Amazon Lightsail bucket.

" + } + }, + "com.amazonaws.lightsail#Bundle": { + "type": "structure", + "members": { + "price": { + "target": "com.amazonaws.lightsail#float", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "cpuCount": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "diskSizeInGb": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "bundleId": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "instanceType": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "isActive": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether the bundle is active.

" + } + }, + "name": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "power": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

A numeric value that represents the power of the bundle (e.g., 500). You can\n use the bundle's power value in conjunction with a blueprint's minimum power value to\n determine whether the blueprint will run on the bundle. For example, you need a bundle with a\n power value of 500 or more to create an instance that uses a blueprint with a minimum power\n value of 500.

" + } + }, + "ramSizeInGb": { + "target": "com.amazonaws.lightsail#float", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "transferPerMonthInGb": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "supportedPlatforms": { + "target": "com.amazonaws.lightsail#InstancePlatformList", + "traits": { + "smithy.api#documentation": "

The operating system platform (Linux/Unix-based or Windows Server-based) that the bundle\n supports. You can only launch a WINDOWS bundle on a blueprint that supports the\n WINDOWS platform. LINUX_UNIX blueprints require a\n LINUX_UNIX bundle.

" + } + }, + "supportedAppCategories": { + "target": "com.amazonaws.lightsail#AppCategoryList", + "traits": { + "smithy.api#documentation": "

Virtual computer blueprints that are supported by a Lightsail for Research bundle.

\n \n

This parameter only applies to Lightsail for Research resources.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "com.amazonaws.lightsail#BundleList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#Bundle" + } + }, + "com.amazonaws.lightsail#CacheBehavior": { + "type": "structure", + "members": { + "behavior": { + "target": "com.amazonaws.lightsail#BehaviorEnum", + "traits": { + "smithy.api#documentation": "

The cache behavior of the distribution.

\n

The following cache behaviors can be specified:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the default cache behavior of an Amazon Lightsail content delivery network (CDN)\n distribution.

" + } + }, + "com.amazonaws.lightsail#CacheBehaviorList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#CacheBehaviorPerPath" + } + }, + "com.amazonaws.lightsail#CacheBehaviorPerPath": { + "type": "structure", + "members": { + "path": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify\n wildcard directories (path/to/assets/*), and file types (*.html, *jpg,\n *js). Directories and file paths are case-sensitive.

\n

Examples:

\n " + } + }, + "behavior": { + "target": "com.amazonaws.lightsail#BehaviorEnum", + "traits": { + "smithy.api#documentation": "

The cache behavior for the specified path.

\n

You can specify one of the following per-path cache behaviors:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the per-path cache behavior of an Amazon Lightsail content delivery network (CDN)\n distribution.

\n

A per-path cache behavior is used to override, or add an exception to, the default cache\n behavior of a distribution. For example, if the cacheBehavior is set to\n cache, then a per-path cache behavior can be used to specify a directory, file,\n or file type that your distribution will cache. Alternately, if the distribution's\n cacheBehavior is dont-cache, then a per-path cache behavior can be\n used to specify a directory, file, or file type that your distribution will not cache.

" + } + }, + "com.amazonaws.lightsail#CacheSettings": { + "type": "structure", + "members": { + "defaultTTL": { + "target": "com.amazonaws.lightsail#long", + "traits": { + "smithy.api#documentation": "

The default amount of time that objects stay in the distribution's cache before the\n distribution forwards another request to the origin to determine whether the content has been\n updated.

\n \n

The value specified applies only when the origin does not add HTTP headers such as\n Cache-Control max-age, Cache-Control s-maxage, and\n Expires to objects.

\n " + } + }, + "minimumTTL": { + "target": "com.amazonaws.lightsail#long", + "traits": { + "smithy.api#documentation": "

The minimum amount of time that objects stay in the distribution's cache before the\n distribution forwards another request to the origin to determine whether the object has been\n updated.

\n

A value of 0 must be specified for minimumTTL if the\n distribution is configured to forward all headers to the origin.

" + } + }, + "maximumTTL": { + "target": "com.amazonaws.lightsail#long", + "traits": { + "smithy.api#documentation": "

The maximum amount of time that objects stay in the distribution's cache before the\n distribution forwards another request to the origin to determine whether the object has been\n updated.

\n

The value specified applies only when the origin adds HTTP headers such as\n Cache-Control max-age, Cache-Control s-maxage, and\n Expires to objects.

" + } + }, + "allowedHTTPMethods": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The HTTP methods that are processed and forwarded to the distribution's origin.

\n

You can specify the following options:

\n \n

If you specify the third option, you might need to restrict access to your distribution's\n origin so users can't perform operations that you don't want them to. For example, you might\n not want users to have permission to delete objects from your origin.

" + } + }, + "cachedHTTPMethods": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The HTTP method responses that are cached by your distribution.

\n

You can specify the following options:

\n " + } + }, + "forwardedCookies": { + "target": "com.amazonaws.lightsail#CookieObject", + "traits": { + "smithy.api#documentation": "

An object that describes the cookies that are forwarded to the origin. Your content is\n cached based on the cookies that are forwarded.

" + } + }, + "forwardedHeaders": { + "target": "com.amazonaws.lightsail#HeaderObject", + "traits": { + "smithy.api#documentation": "

An object that describes the headers that are forwarded to the origin. Your content is\n cached based on the headers that are forwarded.

" + } + }, + "forwardedQueryStrings": { + "target": "com.amazonaws.lightsail#QueryStringObject", + "traits": { + "smithy.api#documentation": "

An object that describes the query strings that are forwarded to the origin. Your content\n is cached based on the query strings that are forwarded.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the cache settings of an Amazon Lightsail content delivery network (CDN)\n distribution.

\n

These settings apply only to your distribution's cacheBehaviors (including\n the defaultCacheBehavior) that have a behavior of\n cache.

" + } + }, + "com.amazonaws.lightsail#Certificate": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the certificate.

" + } + }, + "name": { + "target": "com.amazonaws.lightsail#CertificateName", + "traits": { + "smithy.api#documentation": "

The name of the certificate (e.g., my-certificate).

" + } + }, + "domainName": { + "target": "com.amazonaws.lightsail#DomainName", + "traits": { + "smithy.api#documentation": "

The domain name of the certificate.

" + } + }, + "status": { + "target": "com.amazonaws.lightsail#CertificateStatus", + "traits": { + "smithy.api#documentation": "

The validation status of the certificate.

" + } + }, + "serialNumber": { + "target": "com.amazonaws.lightsail#SerialNumber", + "traits": { + "smithy.api#documentation": "

The serial number of the certificate.

" + } + }, + "subjectAlternativeNames": { + "target": "com.amazonaws.lightsail#SubjectAlternativeNameList", + "traits": { + "smithy.api#documentation": "

An array of strings that specify the alternate domains (e.g., example2.com)\n and subdomains (e.g., blog.example.com) of the certificate.

" + } + }, + "domainValidationRecords": { + "target": "com.amazonaws.lightsail#DomainValidationRecordList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the domain validation records of the certificate.

" + } + }, + "requestFailureReason": { + "target": "com.amazonaws.lightsail#RequestFailureReason", + "traits": { + "smithy.api#documentation": "

The validation failure reason, if any, of the certificate.

\n

The following failure reasons are possible:

\n " + } + }, + "inUseResourceCount": { + "target": "com.amazonaws.lightsail#InUseResourceCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of Lightsail resources that the certificate is attached to.

" + } + }, + "keyAlgorithm": { + "target": "com.amazonaws.lightsail#KeyAlgorithm", + "traits": { + "smithy.api#documentation": "

The algorithm used to generate the key pair (the public and private key) of the\n certificate.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the certificate was created.

" + } + }, + "issuedAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the certificate was issued.

" + } + }, + "issuerCA": { + "target": "com.amazonaws.lightsail#IssuerCA", + "traits": { + "smithy.api#documentation": "

The certificate authority that issued the certificate.

" + } + }, + "notBefore": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the certificate is first valid.

" + } + }, + "notAfter": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the certificate expires.

" + } + }, + "eligibleToRenew": { + "target": "com.amazonaws.lightsail#EligibleToRenew", + "traits": { + "smithy.api#documentation": "

The renewal eligibility of the certificate.

" + } + }, + "renewalSummary": { + "target": "com.amazonaws.lightsail#RenewalSummary", + "traits": { + "smithy.api#documentation": "

An object that describes the status of the certificate renewal managed by\n Lightsail.

" + } + }, + "revokedAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the certificate was revoked. This value is present only when the\n certificate status is REVOKED.

" + } + }, + "revocationReason": { + "target": "com.amazonaws.lightsail#RevocationReason", + "traits": { + "smithy.api#documentation": "

The reason the certificate was revoked. This value is present only when the certificate\n status is REVOKED.

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" + } + }, + "supportCode": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail certificate. This code enables our support team to look up your Lightsail\n information more easily.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the full details of an Amazon Lightsail SSL/TLS certificate.

\n \n

To get a summary of a certificate, use the GetCertificates action and omit\n includeCertificateDetails from your request. The response will include only\n the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags.

\n " + } + }, + "com.amazonaws.lightsail#CertificateDomainValidationStatus": { + "type": "enum", + "members": { + "PendingValidation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_VALIDATION" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "Success": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + } + } + }, + "com.amazonaws.lightsail#CertificateName": { + "type": "string" + }, + "com.amazonaws.lightsail#CertificateStatus": { + "type": "enum", + "members": { + "PendingValidation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_VALIDATION" + } + }, + "Issued": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ISSUED" + } + }, + "Inactive": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + }, + "Expired": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPIRED" + } + }, + "ValidationTimedOut": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATION_TIMED_OUT" + } + }, + "Revoked": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REVOKED" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.lightsail#CertificateStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#CertificateStatus" + } + }, + "com.amazonaws.lightsail#CertificateSummary": { + "type": "structure", + "members": { + "certificateArn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the certificate.

" + } + }, + "certificateName": { + "target": "com.amazonaws.lightsail#CertificateName", + "traits": { + "smithy.api#documentation": "

The name of the certificate.

" + } + }, + "domainName": { + "target": "com.amazonaws.lightsail#DomainName", + "traits": { + "smithy.api#documentation": "

The domain name of the certificate.

" + } + }, + "certificateDetail": { + "target": "com.amazonaws.lightsail#Certificate", + "traits": { + "smithy.api#documentation": "

An object that describes a certificate in detail.

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an Amazon Lightsail SSL/TLS certificate.

" + } + }, + "com.amazonaws.lightsail#CertificateSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#CertificateSummary" + } + }, + "com.amazonaws.lightsail#CloseInstancePublicPorts": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CloseInstancePublicPortsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CloseInstancePublicPortsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Closes ports for a specific Amazon Lightsail instance.

\n

The CloseInstancePublicPorts action supports tag-based access control via\n resource tags applied to the resource identified by instanceName. For more\n information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CloseInstancePublicPorts", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CloseInstancePublicPortsRequest": { + "type": "structure", + "members": { + "portInfo": { + "target": "com.amazonaws.lightsail#PortInfo", + "traits": { + "smithy.api#documentation": "

An object to describe the ports to close for the specified instance.

", + "smithy.api#required": {} + } + }, + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the instance for which to close ports.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#CloseInstancePublicPortsResult": { + "type": "structure", + "members": { + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An object that describes the result of the action, such as the status of the request, the\n timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#CloudFormationStackRecord": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the CloudFormation stack record. It starts with\n CloudFormationStackRecord followed by a GUID.

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudFormation stack record.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The date when the CloudFormation stack record was created.

" + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

A list of objects describing the Availability Zone and Amazon Web Services Region of the\n CloudFormation stack record.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The Lightsail resource type (e.g., CloudFormationStackRecord).

" + } + }, + "state": { + "target": "com.amazonaws.lightsail#RecordState", + "traits": { + "smithy.api#documentation": "

The current state of the CloudFormation stack record.

" + } + }, + "sourceInfo": { + "target": "com.amazonaws.lightsail#CloudFormationStackRecordSourceInfoList", + "traits": { + "smithy.api#documentation": "

A list of objects describing the source of the CloudFormation stack record.

" + } + }, + "destinationInfo": { + "target": "com.amazonaws.lightsail#DestinationInfo", + "traits": { + "smithy.api#documentation": "

A list of objects describing the destination service, which is AWS CloudFormation, and the Amazon\n Resource Name (ARN) of the AWS CloudFormation stack.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a CloudFormation stack record created as a result of the create cloud\n formation stack action.

\n

A CloudFormation stack record provides information about the AWS CloudFormation stack used to\n create a new Amazon Elastic Compute Cloud instance from an exported Lightsail instance snapshot.

" + } + }, + "com.amazonaws.lightsail#CloudFormationStackRecordList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#CloudFormationStackRecord" + } + }, + "com.amazonaws.lightsail#CloudFormationStackRecordSourceInfo": { + "type": "structure", + "members": { + "resourceType": { + "target": "com.amazonaws.lightsail#CloudFormationStackRecordSourceType", + "traits": { + "smithy.api#documentation": "

The Lightsail resource type (e.g., ExportSnapshotRecord).

" + } + }, + "name": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the record.

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the export snapshot record.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the source of a CloudFormation stack record (i.e., the export snapshot\n record).

" + } + }, + "com.amazonaws.lightsail#CloudFormationStackRecordSourceInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#CloudFormationStackRecordSourceInfo" + } + }, + "com.amazonaws.lightsail#CloudFormationStackRecordSourceType": { + "type": "enum", + "members": { + "ExportSnapshotRecord": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExportSnapshotRecord" + } + } + } + }, + "com.amazonaws.lightsail#ComparisonOperator": { + "type": "enum", + "members": { + "GreaterThanOrEqualToThreshold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GreaterThanOrEqualToThreshold" + } + }, + "GreaterThanThreshold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GreaterThanThreshold" + } + }, + "LessThanThreshold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LessThanThreshold" + } + }, + "LessThanOrEqualToThreshold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LessThanOrEqualToThreshold" + } + } + } + }, + "com.amazonaws.lightsail#ContactMethod": { + "type": "structure", + "members": { + "contactEndpoint": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The destination of the contact method, such as an email address or a mobile phone\n number.

" + } + }, + "status": { + "target": "com.amazonaws.lightsail#ContactMethodStatus", + "traits": { + "smithy.api#documentation": "

The current status of the contact method.

\n

A contact method has the following possible status:

\n " + } + }, + "protocol": { + "target": "com.amazonaws.lightsail#ContactProtocol", + "traits": { + "smithy.api#documentation": "

The protocol of the contact method, such as email or SMS (text messaging).

" + } + }, + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the contact method.

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the contact method.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the contact method was created.

" + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

An object that describes the location of the contact method, such as the Amazon Web Services Region and Availability Zone.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The Lightsail resource type (e.g., ContactMethod).

" + } + }, + "supportCode": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail contact method. This code enables our support team to look up your\n Lightsail information more easily.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a contact method.

\n

A contact method is a way to send you notifications. For more information, see Notifications in Amazon Lightsail.

" + } + }, + "com.amazonaws.lightsail#ContactMethodStatus": { + "type": "enum", + "members": { + "PendingVerification": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PendingVerification" + } + }, + "Valid": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Valid" + } + }, + "Invalid": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Invalid" + } + } + } + }, + "com.amazonaws.lightsail#ContactMethodVerificationProtocol": { + "type": "enum", + "members": { + "Email": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Email" + } + } + } + }, + "com.amazonaws.lightsail#ContactMethodsList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#ContactMethod" + } + }, + "com.amazonaws.lightsail#ContactProtocol": { + "type": "enum", + "members": { + "Email": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Email" + } + }, + "SMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SMS" + } + } + } + }, + "com.amazonaws.lightsail#ContactProtocolsList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#ContactProtocol" + } + }, + "com.amazonaws.lightsail#Container": { + "type": "structure", + "members": { + "image": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The name of the image used for the container.

\n

Container images sourced from your Lightsail container service, that are registered and\n stored on your service, start with a colon (:). For example, if your container\n service name is container-service-1, the container image label is\n mystaticsite, and you want to use the third (3) version of the\n registered container image, then you should specify\n :container-service-1.mystaticsite.3. To use the latest version of a container\n image, specify latest instead of a version number (for example,\n :container-service-1.mystaticsite.latest). Lightsail will automatically use\n the highest numbered version of the registered container image.

\n

Container images sourced from a public registry like Docker Hub don't start with a colon.\n For example, nginx:latest or nginx.

" + } + }, + "command": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

The launch command for the container.

" + } + }, + "environment": { + "target": "com.amazonaws.lightsail#Environment", + "traits": { + "smithy.api#documentation": "

The environment variables of the container.

" + } + }, + "ports": { + "target": "com.amazonaws.lightsail#PortMap", + "traits": { + "smithy.api#documentation": "

The open firewall ports of the container.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the settings of a container that will be launched, or that is launched, to an\n Amazon Lightsail container service.

" + } + }, + "com.amazonaws.lightsail#ContainerImage": { + "type": "structure", + "members": { + "image": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The name of the container image.

" + } + }, + "digest": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The digest of the container image.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the container image was created.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a container image that is registered to an Amazon Lightsail container\n service.

" + } + }, + "com.amazonaws.lightsail#ContainerImageList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#ContainerImage" + } + }, + "com.amazonaws.lightsail#ContainerLabel": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 53 + }, + "smithy.api#pattern": "^[a-z0-9]{1,2}|[a-z0-9][a-z0-9-]+[a-z0-9]$" + } + }, + "com.amazonaws.lightsail#ContainerMap": { + "type": "map", + "key": { + "target": "com.amazonaws.lightsail#ContainerName" + }, + "value": { + "target": "com.amazonaws.lightsail#Container" + } + }, + "com.amazonaws.lightsail#ContainerName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 53 + }, + "smithy.api#pattern": "^[a-z0-9]{1,2}|[a-z0-9][a-z0-9-]+[a-z0-9]$" + } + }, + "com.amazonaws.lightsail#ContainerService": { + "type": "structure", + "members": { + "containerServiceName": { + "target": "com.amazonaws.lightsail#ContainerServiceName", + "traits": { + "smithy.api#documentation": "

The name of the container service.

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container service.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the container service was created.

" + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

An object that describes the location of the container service, such as the Amazon Web Services Region and Availability Zone.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The Lightsail resource type of the container service (i.e.,\n ContainerService).

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" + } + }, + "power": { + "target": "com.amazonaws.lightsail#ContainerServicePowerName", + "traits": { + "smithy.api#documentation": "

The power specification of the container service.

\n

The power specifies the amount of RAM, the number of vCPUs, and the base price of the\n container service.

" + } + }, + "powerId": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The ID of the power of the container service.

" + } + }, + "state": { + "target": "com.amazonaws.lightsail#ContainerServiceState", + "traits": { + "smithy.api#documentation": "

The current state of the container service.

\n

The following container service states are possible:

\n " + } + }, + "stateDetail": { + "target": "com.amazonaws.lightsail#ContainerServiceStateDetail", + "traits": { + "smithy.api#documentation": "

An object that describes the current state of the container service.

\n \n

The state detail is populated only when a container service is in a\n PENDING, DEPLOYING, or UPDATING state.

\n " + } + }, + "scale": { + "target": "com.amazonaws.lightsail#ContainerServiceScale", + "traits": { + "smithy.api#documentation": "

The scale specification of the container service.

\n

The scale specifies the allocated compute nodes of the container service.

" + } + }, + "currentDeployment": { + "target": "com.amazonaws.lightsail#ContainerServiceDeployment", + "traits": { + "smithy.api#documentation": "

An object that describes the current container deployment of the container service.

" + } + }, + "nextDeployment": { + "target": "com.amazonaws.lightsail#ContainerServiceDeployment", + "traits": { + "smithy.api#documentation": "

An object that describes the next deployment of the container service.

\n

This value is null when there is no deployment in a pending\n state.

" + } + }, + "isDisabled": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether the container service is disabled.

" + } + }, + "principalArn": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The principal ARN of the container service.

\n

The principal ARN can be used to create a trust relationship between your standard Amazon Web Services account and your Lightsail container service. This allows you to give your\n service permission to access resources in your standard Amazon Web Services account.

" + } + }, + "privateDomainName": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The private domain name of the container service.

\n

The private domain name is accessible only by other resources within the default virtual\n private cloud (VPC) of your Lightsail account.

" + } + }, + "publicDomainNames": { + "target": "com.amazonaws.lightsail#ContainerServicePublicDomains", + "traits": { + "smithy.api#documentation": "

The public domain name of the container service, such as example.com and\n www.example.com.

\n

You can specify up to four public domain names for a container service. The domain names\n that you specify are used when you create a deployment with a container configured as the\n public endpoint of your container service.

\n

If you don't specify public domain names, then you can use the default domain of the\n container service.

\n \n

You must create and validate an SSL/TLS certificate before you can use public domain\n names with your container service. Use the CreateCertificate action to create a\n certificate for the public domain names you want to use with your container service.

\n \n

See CreateContainerService or UpdateContainerService for\n information about how to specify public domain names for your Lightsail container\n service.

" + } + }, + "url": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The publicly accessible URL of the container service.

\n

If no public endpoint is specified in the currentDeployment, this URL returns\n a 404 response.

" + } + }, + "privateRegistryAccess": { + "target": "com.amazonaws.lightsail#PrivateRegistryAccess", + "traits": { + "smithy.api#documentation": "

An object that describes the configuration for the container service to access private\n container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private\n repositories.

\n

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an Amazon Lightsail container service.

" + } + }, + "com.amazonaws.lightsail#ContainerServiceDeployment": { + "type": "structure", + "members": { + "version": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The version number of the deployment.

" + } + }, + "state": { + "target": "com.amazonaws.lightsail#ContainerServiceDeploymentState", + "traits": { + "smithy.api#documentation": "

The state of the deployment.

\n

A deployment can be in one of the following states:

\n " + } + }, + "containers": { + "target": "com.amazonaws.lightsail#ContainerMap", + "traits": { + "smithy.api#documentation": "

An object that describes the configuration for the containers of the deployment.

" + } + }, + "publicEndpoint": { + "target": "com.amazonaws.lightsail#ContainerServiceEndpoint", + "traits": { + "smithy.api#documentation": "

An object that describes the endpoint of the deployment.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the deployment was created.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a container deployment configuration of an Amazon Lightsail container\n service.

\n

A deployment specifies the settings, such as the ports and launch command, of containers\n that are deployed to your container service.

" + } + }, + "com.amazonaws.lightsail#ContainerServiceDeploymentList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#ContainerServiceDeployment" + } + }, + "com.amazonaws.lightsail#ContainerServiceDeploymentRequest": { + "type": "structure", + "members": { + "containers": { + "target": "com.amazonaws.lightsail#ContainerMap", + "traits": { + "smithy.api#documentation": "

An object that describes the configuration for the containers of the deployment.

" + } + }, + "publicEndpoint": { + "target": "com.amazonaws.lightsail#EndpointRequest", + "traits": { + "smithy.api#documentation": "

An object that describes the endpoint of the deployment.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a container deployment configuration of an Amazon Lightsail container\n service.

\n

A deployment specifies the settings, such as the ports and launch command, of containers\n that are deployed to your container service.

" + } + }, + "com.amazonaws.lightsail#ContainerServiceDeploymentState": { + "type": "enum", + "members": { + "ACTIVATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.lightsail#ContainerServiceECRImagePullerRole": { + "type": "structure", + "members": { + "isActive": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether the role is activated.

" + } + }, + "principalArn": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role, if it is activated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the activation status of the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR)\n private repositories.

\n

When activated, Lightsail creates an Identity and Access Management (IAM) role\n for the specified Lightsail container service. You can use the ARN of the role to create a\n trust relationship between your Lightsail container service and an Amazon ECR private repository in your Amazon Web Services account. This allows your container\n service to pull images from Amazon ECR private repositories. For more information, see\n Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

" + } + }, + "com.amazonaws.lightsail#ContainerServiceECRImagePullerRoleRequest": { + "type": "structure", + "members": { + "isActive": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether to activate the role.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a request to activate or deactivate the role that you can use to grant an\n Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories.

\n

When activated, Lightsail creates an Identity and Access Management (IAM) role\n for the specified Lightsail container service. You can use the ARN of the role to create a\n trust relationship between your Lightsail container service and an Amazon ECR private repository in your Amazon Web Services account. This allows your container\n service to pull images from Amazon ECR private repositories. For more information, see\n Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

" + } + }, + "com.amazonaws.lightsail#ContainerServiceEndpoint": { + "type": "structure", + "members": { + "containerName": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The name of the container entry of the deployment that the endpoint configuration applies\n to.

" + } + }, + "containerPort": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The port of the specified container to which traffic is forwarded to.

" + } + }, + "healthCheck": { + "target": "com.amazonaws.lightsail#ContainerServiceHealthCheckConfig", + "traits": { + "smithy.api#documentation": "

An object that describes the health check configuration of the container.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the public endpoint configuration of a deployment of an Amazon Lightsail\n container service.

" + } + }, + "com.amazonaws.lightsail#ContainerServiceHealthCheckConfig": { + "type": "structure", + "members": { + "healthyThreshold": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The number of consecutive health checks successes required before moving the container to\n the Healthy state. The default value is 2.

" + } + }, + "unhealthyThreshold": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The number of consecutive health check failures required before moving the container to\n the Unhealthy state. The default value is 2.

" + } + }, + "timeoutSeconds": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The amount of time, in seconds, during which no response means a failed health check. You\n can specify between 2 and 60 seconds. The default value is 2.

" + } + }, + "intervalSeconds": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The approximate interval, in seconds, between health checks of an individual container.\n You can specify between 5 and 300 seconds. The default value is 5.

" + } + }, + "path": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The path on the container on which to perform the health check. The default value is\n /.

" + } + }, + "successCodes": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The HTTP codes to use when checking for a successful response from a container. You can\n specify values between 200 and 499. You can specify multiple values\n (for example, 200,202) or a range of values (for example,\n 200-299).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the health check configuration of an Amazon Lightsail container service.

" + } + }, + "com.amazonaws.lightsail#ContainerServiceList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#ContainerService" + } + }, + "com.amazonaws.lightsail#ContainerServiceLogEvent": { + "type": "structure", + "members": { + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the container service log event was created.

" + } + }, + "message": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The message of the container service log event.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the log events of a container of an Amazon Lightsail container service.

" + } + }, + "com.amazonaws.lightsail#ContainerServiceLogEventList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#ContainerServiceLogEvent" + } + }, + "com.amazonaws.lightsail#ContainerServiceMetadataEntry": { + "type": "map", + "key": { + "target": "com.amazonaws.lightsail#string" + }, + "value": { + "target": "com.amazonaws.lightsail#string" + } + }, + "com.amazonaws.lightsail#ContainerServiceMetadataEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#ContainerServiceMetadataEntry" + } + }, + "com.amazonaws.lightsail#ContainerServiceMetricName": { + "type": "enum", + "members": { + "CPUUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CPUUtilization" + } + }, + "MemoryUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MemoryUtilization" + } + } + } + }, + "com.amazonaws.lightsail#ContainerServiceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-z0-9]{1,2}|[a-z0-9][a-z0-9-]+[a-z0-9]$" + } + }, + "com.amazonaws.lightsail#ContainerServicePower": { + "type": "structure", + "members": { + "powerId": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The ID of the power (e.g., nano-1).

" + } + }, + "price": { + "target": "com.amazonaws.lightsail#float", + "traits": { + "smithy.api#documentation": "

The monthly price of the power in USD.

" + } + }, + "cpuCount": { + "target": "com.amazonaws.lightsail#float", + "traits": { + "smithy.api#documentation": "

The number of vCPUs included in the power.

" + } + }, + "ramSizeInGb": { + "target": "com.amazonaws.lightsail#float", + "traits": { + "smithy.api#documentation": "

The amount of RAM (in GB) of the power.

" + } + }, + "name": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The friendly name of the power (e.g., nano).

" + } + }, + "isActive": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether the power is active and can be specified for container\n services.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the powers that can be specified for an Amazon Lightsail container\n service.

\n

The power specifies the amount of RAM, the number of vCPUs, and the base price of the\n container service.

" + } + }, + "com.amazonaws.lightsail#ContainerServicePowerList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#ContainerServicePower" + } + }, + "com.amazonaws.lightsail#ContainerServicePowerName": { + "type": "enum", + "members": { + "nano": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nano" + } + }, + "micro": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "micro" + } + }, + "small": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "small" + } + }, + "medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "medium" + } + }, + "large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "large" + } + }, + "xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "xlarge" + } + } + } + }, + "com.amazonaws.lightsail#ContainerServiceProtocol": { + "type": "enum", + "members": { + "HTTP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTP" + } + }, + "HTTPS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPS" + } + }, + "TCP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TCP" + } + }, + "UDP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UDP" + } + } + } + }, + "com.amazonaws.lightsail#ContainerServicePublicDomains": { + "type": "map", + "key": { + "target": "com.amazonaws.lightsail#string" + }, + "value": { + "target": "com.amazonaws.lightsail#ContainerServicePublicDomainsList" + } + }, + "com.amazonaws.lightsail#ContainerServicePublicDomainsList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#string" + } + }, + "com.amazonaws.lightsail#ContainerServiceRegistryLogin": { + "type": "structure", + "members": { + "username": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The container service registry username to use to push container images to the container\n image registry of a Lightsail account.

" + } + }, + "password": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The container service registry password to use to push container images to the container\n image registry of a Lightsail account

" + } + }, + "expiresAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp of when the container image registry sign-in credentials expire.

\n

The log in credentials expire 12 hours after they are created, at which point you will\n need to create a new set of log in credentials using the\n CreateContainerServiceRegistryLogin action.

" + } + }, + "registry": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The address to use to push container images to the container image registry of a\n Lightsail account.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the sign-in credentials for the container image registry of an Amazon Lightsail\n account.

" + } + }, + "com.amazonaws.lightsail#ContainerServiceScale": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.lightsail#ContainerServiceState": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "DEPLOYING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPLOYING" + } + } + } + }, + "com.amazonaws.lightsail#ContainerServiceStateDetail": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.lightsail#ContainerServiceStateDetailCode", + "traits": { + "smithy.api#documentation": "

The state code of the container service.

\n

The following state codes are possible:

\n " + } + }, + "message": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

A message that provides more information for the state code.

\n \n

The state detail is populated only when a container service is in a\n PENDING, DEPLOYING, or UPDATING state.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the current state of a container service.

" + } + }, + "com.amazonaws.lightsail#ContainerServiceStateDetailCode": { + "type": "enum", + "members": { + "CREATING_SYSTEM_RESOURCES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING_SYSTEM_RESOURCES" + } + }, + "CREATING_NETWORK_INFRASTRUCTURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING_NETWORK_INFRASTRUCTURE" + } + }, + "PROVISIONING_CERTIFICATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROVISIONING_CERTIFICATE" + } + }, + "PROVISIONING_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROVISIONING_SERVICE" + } + }, + "CREATING_DEPLOYMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING_DEPLOYMENT" + } + }, + "EVALUATING_HEALTH_CHECK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EVALUATING_HEALTH_CHECK" + } + }, + "ACTIVATING_DEPLOYMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVATING_DEPLOYMENT" + } + }, + "CERTIFICATE_LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CERTIFICATE_LIMIT_EXCEEDED" + } + }, + "UNKNOWN_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNKNOWN_ERROR" + } + } + } + }, + "com.amazonaws.lightsail#ContainerServicesListResult": { + "type": "structure", + "members": { + "containerServices": { + "target": "com.amazonaws.lightsail#ContainerServiceList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe one or more container services.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#CookieObject": { + "type": "structure", + "members": { + "option": { + "target": "com.amazonaws.lightsail#ForwardValues", + "traits": { + "smithy.api#documentation": "

Specifies which cookies to forward to the distribution's origin for a cache behavior:\n all, none, or allow-list to forward only the cookies\n specified in the cookiesAllowList parameter.

" + } + }, + "cookiesAllowList": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

The specific cookies to forward to your distribution's origin.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes whether an Amazon Lightsail content delivery network (CDN) distribution forwards\n cookies to the origin and, if so, which ones.

\n

For the cookies that you specify, your distribution caches separate versions of the\n specified content based on the cookie values in viewer\n requests.

" + } + }, + "com.amazonaws.lightsail#CopySnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CopySnapshotRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CopySnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an\n automatic snapshot of an instance or disk as a manual snapshot. This operation can also be\n used to copy a manual or automatic snapshot of an instance or a disk from one Amazon Web Services Region to another in Amazon Lightsail.

\n

When copying a manual snapshot, be sure to define the source\n region, source snapshot name, and target snapshot name\n parameters.

\n

When copying an automatic snapshot, be sure to define the\n source region, source resource name, target snapshot\n name, and either the restore date or the use latest restorable\n auto snapshot parameters.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CopySnapshot", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CopySnapshotRequest": { + "type": "structure", + "members": { + "sourceSnapshotName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the source manual snapshot to copy.

\n

Constraint:

\n " + } + }, + "sourceResourceName": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The name of the source instance or disk from which the source automatic snapshot was\n created.

\n

Constraint:

\n " + } + }, + "restoreDate": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The date of the source automatic snapshot to copy. Use the get auto snapshots\n operation to identify the dates of the available automatic snapshots.

\n

Constraints:

\n " + } + }, + "useLatestRestorableAutoSnapshot": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value to indicate whether to use the latest available automatic snapshot of the\n specified source instance or disk.

\n

Constraints:

\n " + } + }, + "targetSnapshotName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the new manual snapshot to be created as a copy.

", + "smithy.api#required": {} + } + }, + "sourceRegion": { + "target": "com.amazonaws.lightsail#RegionName", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region where the source manual or automatic snapshot is\n located.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#CopySnapshotResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#CostEstimate": { + "type": "structure", + "members": { + "usageType": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The types of usage that are included in the estimate, such as costs, usage, or data\n transfer.

" + } + }, + "resultsByTime": { + "target": "com.amazonaws.lightsail#EstimatesByTime", + "traits": { + "smithy.api#documentation": "

The cost estimate result that's associated with a time period.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the estimated cost for resources in your Lightsail for Research account.

" + } + }, + "com.amazonaws.lightsail#CostEstimates": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#CostEstimate" + } + }, + "com.amazonaws.lightsail#CreateBucket": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateBucketRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateBucketResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Amazon Lightsail bucket.

\n

A bucket is a cloud storage resource available in the Lightsail object storage service.\n Use buckets to store objects such as data and its descriptive metadata. For more information\n about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer\n Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateBucket", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateBucketAccessKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateBucketAccessKeyRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateBucketAccessKeyResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new access key for the specified Amazon Lightsail bucket. Access keys consist of\n an access key ID and corresponding secret access key.

\n

Access keys grant full programmatic access to the specified bucket and its objects. You\n can have a maximum of two access keys per bucket. Use the GetBucketAccessKeys action to get a list of current access keys for a specific bucket. For more\n information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

\n \n

The secretAccessKey value is returned only in response to the\n CreateBucketAccessKey action. You can get a secret access key only when you\n first create an access key; you cannot get the secret access key later. If you lose the\n secret access key, you must create a new access key.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateBucketAccessKey", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateBucketAccessKeyRequest": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.lightsail#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket that the new access key will belong to, and grant access to.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#CreateBucketAccessKeyResult": { + "type": "structure", + "members": { + "accessKey": { + "target": "com.amazonaws.lightsail#AccessKey", + "traits": { + "smithy.api#documentation": "

An object that describes the access key that is created.

" + } + }, + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#CreateBucketRequest": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.lightsail#BucketName", + "traits": { + "smithy.api#documentation": "

The name for the bucket.

\n

For more information about bucket names, see Bucket naming rules in Amazon Lightsail in the Amazon Lightsail Developer\n Guide.

", + "smithy.api#required": {} + } + }, + "bundleId": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the bundle to use for the bucket.

\n

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a\n bucket.

\n

Use the GetBucketBundles action to get a list of\n bundle IDs that you can specify.

\n

Use the UpdateBucketBundle action to change the\n bundle after the bucket is created.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the bucket during creation.

\n

Use the TagResource action to tag the bucket after it's\n created.

" + } + }, + "enableObjectVersioning": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether to enable versioning of objects in the\n bucket.

\n

For more information about versioning, see Enabling and suspending object versioning in a bucket in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#CreateBucketResult": { + "type": "structure", + "members": { + "bucket": { + "target": "com.amazonaws.lightsail#Bucket", + "traits": { + "smithy.api#documentation": "

An object that describes the bucket that is created.

" + } + }, + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#CreateCertificate": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateCertificateRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateCertificateResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN)\n distribution and a container service.

\n

After the certificate is valid, use the AttachCertificateToDistribution\n action to use the certificate and its domains with your distribution. Or use the\n UpdateContainerService action to use the certificate and its domains with your\n container service.

\n \n

Only certificates created in the us-east-1\n Amazon Web Services Region can be attached to Lightsail distributions. Lightsail\n distributions are global resources that can reference an origin in any Amazon Web Services\n Region, and distribute its content globally. However, all distributions are located in the\n us-east-1 Region.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateCertificate", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateCertificateRequest": { + "type": "structure", + "members": { + "certificateName": { + "target": "com.amazonaws.lightsail#CertificateName", + "traits": { + "smithy.api#documentation": "

The name for the certificate.

", + "smithy.api#required": {} + } + }, + "domainName": { + "target": "com.amazonaws.lightsail#DomainName", + "traits": { + "smithy.api#documentation": "

The domain name (e.g., example.com) for the certificate.

", + "smithy.api#required": {} + } + }, + "subjectAlternativeNames": { + "target": "com.amazonaws.lightsail#SubjectAlternativeNameList", + "traits": { + "smithy.api#documentation": "

An array of strings that specify the alternate domains (e.g., example2.com)\n and subdomains (e.g., blog.example.com) for the certificate.

\n

You can specify a maximum of nine alternate domains (in addition to the primary domain\n name).

\n

Wildcard domain entries (e.g., *.example.com) are not supported.

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the certificate during create.

\n

Use the TagResource action to tag a resource after it's created.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#CreateCertificateResult": { + "type": "structure", + "members": { + "certificate": { + "target": "com.amazonaws.lightsail#CertificateSummary", + "traits": { + "smithy.api#documentation": "

An object that describes the certificate created.

" + } + }, + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#CreateCloudFormationStack": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateCloudFormationStackRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateCloudFormationStackResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported\n Amazon Lightsail snapshot. This operation results in a CloudFormation stack record that can be\n used to track the AWS CloudFormation stack created. Use the get cloud formation stack\n records operation to get a list of the CloudFormation stacks created.

\n \n

Wait until after your new Amazon EC2 instance is created before running the create\n cloud formation stack operation again with the same export snapshot record.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateCloudFormationStack", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateCloudFormationStackRequest": { + "type": "structure", + "members": { + "instances": { + "target": "com.amazonaws.lightsail#InstanceEntryList", + "traits": { + "smithy.api#documentation": "

An array of parameters that will be used to create the new Amazon EC2 instance. You can only\n pass one instance entry at a time in this array. You will get an invalid parameter error if\n you pass more than one instance entry in this array.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#CreateCloudFormationStackResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#CreateContactMethod": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateContactMethodRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateContactMethodResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an email or SMS text message contact method.

\n

A contact method is used to send you notifications about your Amazon Lightsail resources.\n You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services\n Regions, and SMS text messages cannot be sent to some countries/regions. For more information,\n see Notifications in Amazon Lightsail.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateContactMethod", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateContactMethodRequest": { + "type": "structure", + "members": { + "protocol": { + "target": "com.amazonaws.lightsail#ContactProtocol", + "traits": { + "smithy.api#documentation": "

The protocol of the contact method, such as Email or SMS (text\n messaging).

\n

The SMS protocol is supported only in the following Amazon Web Services\n Regions.

\n \n

For a list of countries/regions where SMS text messages can be sent, and the latest\n Amazon Web Services Regions where SMS text messaging is supported, see Supported Regions and Countries in the Amazon SNS Developer\n Guide.

\n

For more information about notifications in Amazon Lightsail, see Notifications in Amazon Lightsail.

", + "smithy.api#required": {} + } + }, + "contactEndpoint": { + "target": "com.amazonaws.lightsail#StringMax256", + "traits": { + "smithy.api#documentation": "

The destination of the contact method, such as an email address or a mobile phone\n number.

\n

Use the E.164 format when specifying a mobile phone number. E.164 is a standard for the\n phone number structure used for international telecommunication. Phone numbers that follow\n this format can have a maximum of 15 digits, and they are prefixed with the plus character (+)\n and the country code. For example, a U.S. phone number in E.164 format would be specified as\n +1XXX5550100. For more information, see E.164 on Wikipedia.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#CreateContactMethodResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#CreateContainerService": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateContainerServiceRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateContainerServiceResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Amazon Lightsail container service.

\n

A Lightsail container service is a compute resource to which you can deploy containers.\n For more information, see Container services in Amazon Lightsail in the Lightsail Dev\n Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/container-services", + "code": 201 + } + } + }, + "com.amazonaws.lightsail#CreateContainerServiceDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateContainerServiceDeploymentRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateContainerServiceDeploymentResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a deployment for your Amazon Lightsail container service.

\n

A deployment specifies the containers that will be launched on the container service and\n their settings, such as the ports to open, the environment variables to apply, and the launch\n command to run. It also specifies the container that will serve as the public endpoint of the\n deployment and its settings, such as the HTTP or HTTPS port to use, and the health check\n configuration.

\n

You can deploy containers to your container service using container images from a public\n registry such as Amazon ECR Public, or from your local machine. For more information, see\n Creating container images for your Amazon Lightsail container services in the\n Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/container-services/{serviceName}/deployments", + "code": 201 + } + } + }, + "com.amazonaws.lightsail#CreateContainerServiceDeploymentRequest": { + "type": "structure", + "members": { + "serviceName": { + "target": "com.amazonaws.lightsail#ContainerServiceName", + "traits": { + "smithy.api#documentation": "

The name of the container service for which to create the deployment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "containers": { + "target": "com.amazonaws.lightsail#ContainerMap", + "traits": { + "smithy.api#documentation": "

An object that describes the settings of the containers that will be launched on the\n container service.

" + } + }, + "publicEndpoint": { + "target": "com.amazonaws.lightsail#EndpointRequest", + "traits": { + "smithy.api#documentation": "

An object that describes the settings of the public endpoint for the container\n service.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#CreateContainerServiceDeploymentResult": { + "type": "structure", + "members": { + "containerService": { + "target": "com.amazonaws.lightsail#ContainerService", + "traits": { + "smithy.api#documentation": "

An object that describes a container service.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#CreateContainerServiceRegistryLogin": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateContainerServiceRegistryLoginRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateContainerServiceRegistryLoginResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a temporary set of log in credentials that you can use to log in to the Docker\n process on your local machine. After you're logged in, you can use the native Docker commands\n to push your local container images to the container image registry of your Amazon Lightsail\n account so that you can use them with your Lightsail container service. The log in\n credentials expire 12 hours after they are created, at which point you will need to create a\n new set of log in credentials.

\n \n

You can only push container images to the container service registry of your Lightsail\n account. You cannot pull container images or perform any other container image management\n actions on the container service registry.

\n \n

After you push your container images to the container image registry of your Lightsail\n account, use the RegisterContainerImage action to register the pushed images to a\n specific Lightsail container service.

\n \n

This action is not required if you install and use the Lightsail Control\n (lightsailctl) plugin to push container images to your Lightsail container service. For\n more information, see Pushing and managing container images on your Amazon Lightsail container services\n in the Amazon Lightsail Developer Guide.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/container-registry-login", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateContainerServiceRegistryLoginRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#CreateContainerServiceRegistryLoginResult": { + "type": "structure", + "members": { + "registryLogin": { + "target": "com.amazonaws.lightsail#ContainerServiceRegistryLogin", + "traits": { + "smithy.api#documentation": "

An object that describes the log in information for the container service registry of your\n Lightsail account.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#CreateContainerServiceRequest": { + "type": "structure", + "members": { + "serviceName": { + "target": "com.amazonaws.lightsail#ContainerServiceName", + "traits": { + "smithy.api#documentation": "

The name for the container service.

\n

The name that you specify for your container service will make up part of its default\n domain. The default domain of a container service is typically\n https://...cs.amazonlightsail.com.\n If the name of your container service is container-service-1, and it's located in\n the US East (Ohio) Amazon Web Services Region (us-east-2), then the domain for\n your container service will be like the following example:\n https://container-service-1.ur4EXAMPLE2uq.us-east-2.cs.amazonlightsail.com\n

\n

The following are the requirements for container service names:

\n ", + "smithy.api#required": {} + } + }, + "power": { + "target": "com.amazonaws.lightsail#ContainerServicePowerName", + "traits": { + "smithy.api#documentation": "

The power specification for the container service.

\n

The power specifies the amount of memory, vCPUs, and base monthly cost of each node of the\n container service. The power and scale of a container service makes\n up its configured capacity. To determine the monthly price of your container service, multiply\n the base price of the power with the scale (the number of nodes) of\n the service.

\n

Use the GetContainerServicePowers action to get a list of power options that\n you can specify using this parameter, and their base monthly cost.

", + "smithy.api#required": {} + } + }, + "scale": { + "target": "com.amazonaws.lightsail#ContainerServiceScale", + "traits": { + "smithy.api#documentation": "

The scale specification for the container service.

\n

The scale specifies the allocated compute nodes of the container service. The\n power and scale of a container service makes up its configured\n capacity. To determine the monthly price of your container service, multiply the base price of\n the power with the scale (the number of nodes) of the\n service.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the container service during create.

\n

Use the TagResource action to tag a resource after it's created.

\n

For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

" + } + }, + "publicDomainNames": { + "target": "com.amazonaws.lightsail#ContainerServicePublicDomains", + "traits": { + "smithy.api#documentation": "

The public domain names to use with the container service, such as\n example.com and www.example.com.

\n

You can specify up to four public domain names for a container service. The domain names\n that you specify are used when you create a deployment with a container configured as the\n public endpoint of your container service.

\n

If you don't specify public domain names, then you can use the default domain of the\n container service.

\n \n

You must create and validate an SSL/TLS certificate before you can use public domain\n names with your container service. Use the CreateCertificate action to create a\n certificate for the public domain names you want to use with your container service.

\n \n

You can specify public domain names using a string to array map as shown in the example\n later on this page.

" + } + }, + "deployment": { + "target": "com.amazonaws.lightsail#ContainerServiceDeploymentRequest", + "traits": { + "smithy.api#documentation": "

An object that describes a deployment for the container service.

\n

A deployment specifies the containers that will be launched on the container service and\n their settings, such as the ports to open, the environment variables to apply, and the launch\n command to run. It also specifies the container that will serve as the public endpoint of the\n deployment and its settings, such as the HTTP or HTTPS port to use, and the health check\n configuration.

" + } + }, + "privateRegistryAccess": { + "target": "com.amazonaws.lightsail#PrivateRegistryAccessRequest", + "traits": { + "smithy.api#documentation": "

An object to describe the configuration for the container service to access private\n container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private\n repositories.

\n

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#CreateContainerServiceResult": { + "type": "structure", + "members": { + "containerService": { + "target": "com.amazonaws.lightsail#ContainerService", + "traits": { + "smithy.api#documentation": "

An object that describes a container service.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#CreateDisk": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateDiskRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateDiskResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a block storage disk that can be attached to an Amazon Lightsail instance in the\n same Availability Zone (e.g., us-east-2a).

\n

The create disk operation supports tag-based access control via request tags.\n For more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateDisk", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateDiskFromSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateDiskFromSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateDiskFromSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting\n disk can be attached to an Amazon Lightsail instance in the same Availability Zone (e.g.,\n us-east-2a).

\n

The create disk from snapshot operation supports tag-based access control via\n request tags and resource tags applied to the resource identified by disk snapshot\n name. For more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateDiskFromSnapshot", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateDiskFromSnapshotRequest": { + "type": "structure", + "members": { + "diskName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The unique Lightsail disk name (e.g., my-disk).

", + "smithy.api#required": {} + } + }, + "diskSnapshotName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the disk snapshot (e.g., my-snapshot) from which to create the\n new storage disk.

\n

Constraint:

\n " + } + }, + "availabilityZone": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Availability Zone where you want to create the disk (e.g., us-east-2a).\n Choose the same Availability Zone as the Lightsail instance where you want to create the\n disk.

\n

Use the GetRegions operation to list the Availability Zones where Lightsail is currently\n available.

", + "smithy.api#required": {} + } + }, + "sizeInGb": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The size of the disk in GB (e.g., 32).

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" + } + }, + "addOns": { + "target": "com.amazonaws.lightsail#AddOnRequestList", + "traits": { + "smithy.api#documentation": "

An array of objects that represent the add-ons to enable for the new disk.

" + } + }, + "sourceDiskName": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The name of the source disk from which the source automatic snapshot was created.

\n

Constraints:

\n " + } + }, + "restoreDate": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The date of the automatic snapshot to use for the new disk. Use the get auto\n snapshots operation to identify the dates of the available automatic\n snapshots.

\n

Constraints:

\n " + } + }, + "useLatestRestorableAutoSnapshot": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value to indicate whether to use the latest available automatic snapshot.

\n

Constraints:

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#CreateDiskFromSnapshotResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#CreateDiskRequest": { + "type": "structure", + "members": { + "diskName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The unique Lightsail disk name (e.g., my-disk).

", + "smithy.api#required": {} + } + }, + "availabilityZone": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Availability Zone where you want to create the disk (e.g., us-east-2a).\n Use the same Availability Zone as the Lightsail instance to which you want to attach the\n disk.

\n

Use the get regions operation to list the Availability Zones where\n Lightsail is currently available.

", + "smithy.api#required": {} + } + }, + "sizeInGb": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The size of the disk in GB (e.g., 32).

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" + } + }, + "addOns": { + "target": "com.amazonaws.lightsail#AddOnRequestList", + "traits": { + "smithy.api#documentation": "

An array of objects that represent the add-ons to enable for the new disk.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#CreateDiskResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#CreateDiskSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateDiskSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateDiskSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a snapshot of a block storage disk. You can use snapshots for backups, to make\n copies of disks, and to save data before shutting down a Lightsail instance.

\n

You can take a snapshot of an attached disk that is in use; however, snapshots only\n capture data that has been written to your disk at the time the snapshot command is issued.\n This may exclude any data that has been cached by any applications or the operating system. If\n you can pause any file systems on the disk long enough to take a snapshot, your snapshot\n should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should\n unmount the disk from within the Lightsail instance, issue the create disk snapshot command,\n and then remount the disk to ensure a consistent and complete snapshot. You may remount and\n use your disk while the snapshot status is pending.

\n

You can also use this operation to create a snapshot of an instance's system volume. You\n might want to do this, for example, to recover data from the system volume of a botched\n instance or to create a backup of the system volume like you would for a block storage disk.\n To create a snapshot of a system volume, just define the instance name parameter\n when issuing the snapshot command, and a snapshot of the defined instance's system volume will\n be created. After the snapshot is available, you can create a block storage disk from the\n snapshot and attach it to a running instance to access the data on the disk.

\n

The create disk snapshot operation supports tag-based access control via\n request tags. For more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateDiskSnapshot", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateDiskSnapshotRequest": { + "type": "structure", + "members": { + "diskName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The unique name of the source disk (e.g., Disk-Virginia-1).

\n \n

This parameter cannot be defined together with the instance name parameter.\n The disk name and instance name parameters are mutually\n exclusive.

\n " + } + }, + "diskSnapshotName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the destination disk snapshot (e.g., my-disk-snapshot) based on\n the source disk.

", + "smithy.api#required": {} + } + }, + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The unique name of the source instance (e.g., Amazon_Linux-512MB-Virginia-1).\n When this is defined, a snapshot of the instance's system volume is created.

\n \n

This parameter cannot be defined together with the disk name parameter. The\n instance name and disk name parameters are mutually\n exclusive.

\n " + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#CreateDiskSnapshotResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#CreateDistribution": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateDistributionRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateDistributionResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Amazon Lightsail content delivery network (CDN) distribution.

\n

A distribution is a globally distributed network of caching servers that improve the\n performance of your website or web application hosted on a Lightsail instance. For more\n information, see Content delivery networks in Amazon Lightsail.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateDistribution", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateDistributionRequest": { + "type": "structure", + "members": { + "distributionName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name for the distribution.

", + "smithy.api#required": {} + } + }, + "origin": { + "target": "com.amazonaws.lightsail#InputOrigin", + "traits": { + "smithy.api#documentation": "

An object that describes the origin resource for the distribution, such as a Lightsail\n instance, bucket, or load balancer.

\n

The distribution pulls, caches, and serves content from the origin.

", + "smithy.api#required": {} + } + }, + "defaultCacheBehavior": { + "target": "com.amazonaws.lightsail#CacheBehavior", + "traits": { + "smithy.api#documentation": "

An object that describes the default cache behavior for the distribution.

", + "smithy.api#required": {} + } + }, + "cacheBehaviorSettings": { + "target": "com.amazonaws.lightsail#CacheSettings", + "traits": { + "smithy.api#documentation": "

An object that describes the cache behavior settings for the distribution.

" + } + }, + "cacheBehaviors": { + "target": "com.amazonaws.lightsail#CacheBehaviorList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the per-path cache behavior for the distribution.

" + } + }, + "bundleId": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The bundle ID to use for the distribution.

\n

A distribution bundle describes the specifications of your distribution, such as the\n monthly cost and monthly network transfer quota.

\n

Use the GetDistributionBundles action to get a list of distribution bundle\n IDs that you can specify.

", + "smithy.api#required": {} + } + }, + "ipAddressType": { + "target": "com.amazonaws.lightsail#IpAddressType", + "traits": { + "smithy.api#documentation": "

The IP address type for the distribution.

\n

The possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.

\n

The default value is dualstack.

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the distribution during create.

\n

Use the TagResource action to tag a resource after it's created.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#CreateDistributionResult": { + "type": "structure", + "members": { + "distribution": { + "target": "com.amazonaws.lightsail#LightsailDistribution", + "traits": { + "smithy.api#documentation": "

An object that describes the distribution created.

" + } + }, + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#CreateDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateDomainRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateDomainResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

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

\n

The create domain operation supports tag-based access control via request\n tags. For more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateDomain", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateDomainEntry": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateDomainEntryRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateDomainEntryResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates one of the following domain name system (DNS) records in a domain DNS zone:\n Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority\n (SOA), service locator (SRV), or text (TXT).

\n

The create domain entry operation supports tag-based access control via\n resource tags applied to the resource identified by domain name. For more\n information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateDomainEntry", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateDomainEntryRequest": { + "type": "structure", + "members": { + "domainName": { + "target": "com.amazonaws.lightsail#DomainName", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + }, + "domainEntry": { + "target": "com.amazonaws.lightsail#DomainEntry", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#CreateDomainEntryResult": { + "type": "structure", + "members": { + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#CreateDomainRequest": { + "type": "structure", + "members": { + "domainName": { + "target": "com.amazonaws.lightsail#DomainName", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#CreateDomainResult": { + "type": "structure", + "members": { + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#CreateGUISessionAccessDetails": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateGUISessionAccessDetailsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateGUISessionAccessDetailsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates two URLs that are used to access a virtual computer’s graphical user interface (GUI)\n session. The primary URL initiates a web-based NICE DCV session to the virtual computer's application. The secondary URL initiates a web-based NICE DCV session to the virtual computer's operating session.

\n

Use StartGUISession to open the session.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/create-gui-session-access-details", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateGUISessionAccessDetailsRequest": { + "type": "structure", + "members": { + "resourceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The resource name.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#CreateGUISessionAccessDetailsResult": { + "type": "structure", + "members": { + "resourceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The resource name.

" + } + }, + "status": { + "target": "com.amazonaws.lightsail#Status", + "traits": { + "smithy.api#documentation": "

The status of the operation.

" + } + }, + "percentageComplete": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The percentage of completion for the operation.

" + } + }, + "failureReason": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The reason the operation failed.

" + } + }, + "sessions": { + "target": "com.amazonaws.lightsail#Sessions", + "traits": { + "smithy.api#documentation": "

Returns information about the specified NICE DCV GUI session.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#CreateInstanceSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateInstanceSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateInstanceSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

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

\n

The create instance snapshot operation supports tag-based access control via\n request tags. For more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateInstanceSnapshot", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateInstanceSnapshotRequest": { + "type": "structure", + "members": { + "instanceSnapshotName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name for your new snapshot.

", + "smithy.api#required": {} + } + }, + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The Lightsail instance on which to base your snapshot.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#CreateInstanceSnapshotResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#CreateInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateInstancesRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateInstancesResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates one or more Amazon Lightsail instances.

\n

The create instances operation supports tag-based access control via request\n tags. For more information, see the Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateInstances", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateInstancesFromSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateInstancesFromSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateInstancesFromSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates one or more new instances from a manual or automatic snapshot of an\n instance.

\n

The create instances from snapshot operation supports tag-based access\n control via request tags and resource tags applied to the resource identified by\n instance snapshot name. For more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateInstancesFromSnapshot", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateInstancesFromSnapshotRequest": { + "type": "structure", + "members": { + "instanceNames": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

The names for your new instances.

", + "smithy.api#required": {} + } + }, + "attachedDiskMapping": { + "target": "com.amazonaws.lightsail#AttachedDiskMap", + "traits": { + "smithy.api#documentation": "

An object containing information about one or more disk mappings.

" + } + }, + "availabilityZone": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The Availability Zone where you want to create your instances. Use the following\n formatting: us-east-2a (case sensitive). You can get a list of Availability Zones\n by using the get\n regions operation. Be sure to add the include Availability Zones\n parameter to your request.

", + "smithy.api#required": {} + } + }, + "instanceSnapshotName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

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

\n

Constraint:

\n " + } + }, + "bundleId": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + }, + "userData": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

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

\n \n

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

\n " + } + }, + "keyPairName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name for your key pair.

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" + } + }, + "addOns": { + "target": "com.amazonaws.lightsail#AddOnRequestList", + "traits": { + "smithy.api#documentation": "

An array of objects representing the add-ons to enable for the new instance.

" + } + }, + "ipAddressType": { + "target": "com.amazonaws.lightsail#IpAddressType", + "traits": { + "smithy.api#documentation": "

The IP address type for the instance.

\n

The possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.

\n

The default value is dualstack.

" + } + }, + "sourceInstanceName": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The name of the source instance from which the source automatic snapshot was\n created.

\n

Constraints:

\n " + } + }, + "restoreDate": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The date of the automatic snapshot to use for the new instance. Use the get auto\n snapshots operation to identify the dates of the available automatic\n snapshots.

\n

Constraints:

\n " + } + }, + "useLatestRestorableAutoSnapshot": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value to indicate whether to use the latest available automatic snapshot.

\n

Constraints:

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#CreateInstancesFromSnapshotResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#CreateInstancesRequest": { + "type": "structure", + "members": { + "instanceNames": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + }, + "availabilityZone": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The Availability Zone in which to create your instance. Use the following format:\n us-east-2a (case sensitive). You can get a list of Availability Zones by using\n the get\n regions operation. Be sure to add the include Availability Zones\n parameter to your request.

", + "smithy.api#required": {} + } + }, + "customImageName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

(Deprecated) The name for your custom image.

\n \n

In releases prior to June 12, 2017, this parameter was ignored by the API. It is now\n deprecated.

\n " + } + }, + "blueprintId": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

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

\n \n

Use active blueprints when creating new instances. Inactive blueprints are listed to\n support customers with existing instances and are not necessarily available to create new\n instances. Blueprints are marked inactive when they become outdated due to operating system\n updates or new application releases.

\n ", + "smithy.api#required": {} + } + }, + "bundleId": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + }, + "userData": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

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

\n \n

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

\n " + } + }, + "keyPairName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of your key pair.

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" + } + }, + "addOns": { + "target": "com.amazonaws.lightsail#AddOnRequestList", + "traits": { + "smithy.api#documentation": "

An array of objects representing the add-ons to enable for the new instance.

" + } + }, + "ipAddressType": { + "target": "com.amazonaws.lightsail#IpAddressType", + "traits": { + "smithy.api#documentation": "

The IP address type for the instance.

\n

The possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.

\n

The default value is dualstack.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#CreateInstancesResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#CreateKeyPair": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateKeyPairRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateKeyPairResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a custom SSH key pair that you can use with an Amazon Lightsail\n instance.

\n \n

Use the DownloadDefaultKeyPair action to create a Lightsail default key\n pair in an Amazon Web Services Region where a default key pair does not currently\n exist.

\n \n

The create key pair operation supports tag-based access control via request\n tags. For more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateKeyPair", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateKeyPairRequest": { + "type": "structure", + "members": { + "keyPairName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name for your new key pair.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#CreateKeyPairResult": { + "type": "structure", + "members": { + "keyPair": { + "target": "com.amazonaws.lightsail#KeyPair", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "publicKeyBase64": { + "target": "com.amazonaws.lightsail#Base64", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "privateKeyBase64": { + "target": "com.amazonaws.lightsail#Base64", + "traits": { + "smithy.api#documentation": "

A base64-encoded RSA private key.

" + } + }, + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#CreateLoadBalancer": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateLoadBalancerRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateLoadBalancerResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a Lightsail load balancer. To learn more about deciding whether to load balance\n your application, see Configure your Lightsail instances for load balancing. You can create up to 5\n load balancers per AWS Region in your account.

\n

When you create a load balancer, you can specify a unique name and port settings. To\n change additional load balancer settings, use the UpdateLoadBalancerAttribute\n operation.

\n

The create load balancer operation supports tag-based access control via\n request tags. For more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateLoadBalancer", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateLoadBalancerRequest": { + "type": "structure", + "members": { + "loadBalancerName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of your load balancer.

", + "smithy.api#required": {} + } + }, + "instancePort": { + "target": "com.amazonaws.lightsail#Port", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The instance port where you're creating your load balancer.

", + "smithy.api#required": {} + } + }, + "healthCheckPath": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The path you provided to perform the load balancer health check. If you didn't specify a\n health check path, Lightsail uses the root path of your website (e.g.,\n \"/\").

\n

You may want to specify a custom health check path other than the root of your application\n if your home page loads slowly or has a lot of media or scripting on it.

" + } + }, + "certificateName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the SSL/TLS certificate.

\n

If you specify certificateName, then certificateDomainName is\n required (and vice-versa).

" + } + }, + "certificateDomainName": { + "target": "com.amazonaws.lightsail#DomainName", + "traits": { + "smithy.api#documentation": "

The domain name with which your certificate is associated (e.g.,\n example.com).

\n

If you specify certificateDomainName, then certificateName is\n required (and vice-versa).

" + } + }, + "certificateAlternativeNames": { + "target": "com.amazonaws.lightsail#DomainNameList", + "traits": { + "smithy.api#documentation": "

The optional alternative domains and subdomains to use with your SSL/TLS certificate\n (e.g., www.example.com, example.com, m.example.com,\n blog.example.com).

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" + } + }, + "ipAddressType": { + "target": "com.amazonaws.lightsail#IpAddressType", + "traits": { + "smithy.api#documentation": "

The IP address type for the load balancer.

\n

The possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.

\n

The default value is dualstack.

" + } + }, + "tlsPolicyName": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The name of the TLS policy to apply to the load balancer.

\n

Use the GetLoadBalancerTlsPolicies action to get a list of TLS policy names that you can\n specify.

\n

For more information about load balancer TLS policies, see Configuring TLS security policies on your Amazon Lightsail load\n balancers in the Amazon Lightsail Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#CreateLoadBalancerResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#CreateLoadBalancerTlsCertificate": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateLoadBalancerTlsCertificateRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateLoadBalancerTlsCertificateResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.

\n

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

\n

The CreateLoadBalancerTlsCertificate operation supports tag-based access\n control via resource tags applied to the resource identified by load balancer\n name. For more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateLoadBalancerTlsCertificate", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateLoadBalancerTlsCertificateRequest": { + "type": "structure", + "members": { + "loadBalancerName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The load balancer name where you want to create the SSL/TLS certificate.

", + "smithy.api#required": {} + } + }, + "certificateName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The SSL/TLS certificate name.

\n

You can have up to 10 certificates in your account at one time. Each Lightsail load\n balancer can have up to 2 certificates associated with it at one time. There is also an\n overall limit to the number of certificates that can be issue in a 365-day period. For more\n information, see Limits.

", + "smithy.api#required": {} + } + }, + "certificateDomainName": { + "target": "com.amazonaws.lightsail#DomainName", + "traits": { + "smithy.api#documentation": "

The domain name (e.g., example.com) for your SSL/TLS certificate.

", + "smithy.api#required": {} + } + }, + "certificateAlternativeNames": { + "target": "com.amazonaws.lightsail#DomainNameList", + "traits": { + "smithy.api#documentation": "

An array of strings listing alternative domains and subdomains for your SSL/TLS\n certificate. Lightsail will de-dupe the names for you. You can have a maximum of 9\n alternative names (in addition to the 1 primary domain). We do not support wildcards (e.g.,\n *.example.com).

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#CreateLoadBalancerTlsCertificateResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#CreateRelationalDatabase": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateRelationalDatabaseRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateRelationalDatabaseResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new database in Amazon Lightsail.

\n

The create relational database operation supports tag-based access control\n via request tags. For more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateRelationalDatabase", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateRelationalDatabaseFromSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateRelationalDatabaseFromSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateRelationalDatabaseFromSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new database from an existing database snapshot in Amazon Lightsail.

\n

You can create a new database from a snapshot in if something goes wrong with your\n original database, or to change it to a different plan, such as a high availability or\n standard plan.

\n

The create relational database from snapshot operation supports tag-based\n access control via request tags and resource tags applied to the resource identified by\n relationalDatabaseSnapshotName. For more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateRelationalDatabaseFromSnapshot", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateRelationalDatabaseFromSnapshotRequest": { + "type": "structure", + "members": { + "relationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name to use for your new Lightsail database resource.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + }, + "availabilityZone": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The Availability Zone in which to create your new database. Use the\n us-east-2a case-sensitive format.

\n

You can get a list of Availability Zones by using the get regions operation.\n Be sure to add the include relational database Availability Zones parameter to\n your request.

" + } + }, + "publiclyAccessible": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

Specifies the accessibility options for your new database. A value of true\n specifies a database that is available to resources outside of your Lightsail account. A\n value of false specifies a database that is available only to your Lightsail\n resources in the same region as your database.

" + } + }, + "relationalDatabaseSnapshotName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the database snapshot from which to create your new database.

" + } + }, + "relationalDatabaseBundleId": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The bundle ID for your new database. A bundle describes the performance specifications for\n your database.

\n

You can get a list of database bundle IDs by using the get relational database\n bundles operation.

\n

When creating a new database from a snapshot, you cannot choose a bundle that is smaller\n than the bundle of the source database.

" + } + }, + "sourceRelationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the source database.

" + } + }, + "restoreTime": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The date and time to restore your database from.

\n

Constraints:

\n " + } + }, + "useLatestRestorableTime": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether your database is restored from the latest backup time. A value of\n true restores from the latest backup time.

\n

Default: false\n

\n

Constraints: Cannot be specified if the restore time parameter is\n provided.

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#CreateRelationalDatabaseFromSnapshotResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#CreateRelationalDatabaseRequest": { + "type": "structure", + "members": { + "relationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name to use for your new Lightsail database resource.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + }, + "availabilityZone": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The Availability Zone in which to create your new database. Use the\n us-east-2a case-sensitive format.

\n

You can get a list of Availability Zones by using the get regions operation.\n Be sure to add the include relational database Availability Zones parameter to\n your request.

" + } + }, + "relationalDatabaseBlueprintId": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The blueprint ID for your new database. A blueprint describes the major engine version of\n a database.

\n

You can get a list of database blueprints IDs by using the get relational database\n blueprints operation.

", + "smithy.api#required": {} + } + }, + "relationalDatabaseBundleId": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The bundle ID for your new database. A bundle describes the performance specifications for\n your database.

\n

You can get a list of database bundle IDs by using the get relational database\n bundles operation.

", + "smithy.api#required": {} + } + }, + "masterDatabaseName": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The meaning of this parameter differs according to the database engine you use.

\n

\n MySQL\n

\n

The name of the database to create when the Lightsail database resource is created. If\n this parameter isn't specified, no database is created in the database resource.

\n

Constraints:

\n \n

\n PostgreSQL\n

\n

The name of the database to create when the Lightsail database resource is created. If\n this parameter isn't specified, a database named postgres is created in the\n database resource.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + }, + "masterUsername": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The name for the master user.

\n

\n MySQL\n

\n

Constraints:

\n \n

\n PostgreSQL\n

\n

Constraints:

\n ", + "smithy.api#required": {} + } + }, + "masterUserPassword": { + "target": "com.amazonaws.lightsail#SensitiveString", + "traits": { + "smithy.api#documentation": "

The password for the master user. The password can include any printable ASCII character\n except \"/\", \"\"\", or \"@\". It cannot contain spaces.

\n

\n MySQL\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n PostgreSQL\n

\n

Constraints: Must contain from 8 to 128 characters.

" + } + }, + "preferredBackupWindow": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The daily time range during which automated backups are created for your new database if\n automated backups are enabled.

\n

The default is a 30-minute window selected at random from an 8-hour block of time for each\n AWS Region. For more information about the preferred backup window time blocks for each\n region, see the Working With Backups guide in the Amazon Relational Database Service documentation.

\n

Constraints:

\n " + } + }, + "preferredMaintenanceWindow": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur on your new\n database.

\n

The default is a 30-minute window selected at random from an 8-hour block of time for each\n AWS Region, occurring on a random day of the week.

\n

Constraints:

\n " + } + }, + "publiclyAccessible": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

Specifies the accessibility options for your new database. A value of true\n specifies a database that is available to resources outside of your Lightsail account. A\n value of false specifies a database that is available only to your Lightsail\n resources in the same region as your database.

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#CreateRelationalDatabaseResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#CreateRelationalDatabaseSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateRelationalDatabaseSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateRelationalDatabaseSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups,\n to make copies of a database, and to save data before deleting a database.

\n

The create relational database snapshot operation supports tag-based access\n control via request tags. For more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateRelationalDatabaseSnapshot", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateRelationalDatabaseSnapshotRequest": { + "type": "structure", + "members": { + "relationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the database on which to base your new snapshot.

", + "smithy.api#required": {} + } + }, + "relationalDatabaseSnapshotName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name for your new database snapshot.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#CreateRelationalDatabaseSnapshotResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#Currency": { + "type": "enum", + "members": { + "USD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USD" + } + } + } + }, + "com.amazonaws.lightsail#DeleteAlarm": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteAlarmRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteAlarmResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an alarm.

\n

An alarm is used to monitor a single metric for one of your resources. When a metric\n condition is met, the alarm can notify you by email, SMS text message, and a banner displayed\n on the Amazon Lightsail console. For more information, see Alarms\n in Amazon Lightsail.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/ls/api/2016-11-28/DeleteAlarm", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DeleteAlarmRequest": { + "type": "structure", + "members": { + "alarmName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the alarm to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#DeleteAlarmResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#DeleteAutoSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteAutoSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteAutoSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an automatic snapshot of an instance or disk. For more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DeleteAutoSnapshot", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DeleteAutoSnapshotRequest": { + "type": "structure", + "members": { + "resourceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the source instance or disk from which to delete the automatic\n snapshot.

", + "smithy.api#required": {} + } + }, + "date": { + "target": "com.amazonaws.lightsail#AutoSnapshotDate", + "traits": { + "smithy.api#documentation": "

The date of the automatic snapshot to delete in YYYY-MM-DD format. Use the\n get auto snapshots operation to get the available automatic snapshots for a\n resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#DeleteAutoSnapshotResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#DeleteBucket": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteBucketRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteBucketResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a Amazon Lightsail bucket.

\n \n

When you delete your bucket, the bucket name is released and can be reused for a new\n bucket in your account or another Amazon Web Services account.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DeleteBucket", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DeleteBucketAccessKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteBucketAccessKeyRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteBucketAccessKeyResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an access key for the specified Amazon Lightsail bucket.

\n

We recommend that you delete an access key if the secret access key is compromised.

\n

For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DeleteBucketAccessKey", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DeleteBucketAccessKeyRequest": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.lightsail#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket that the access key belongs to.

", + "smithy.api#required": {} + } + }, + "accessKeyId": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the access key to delete.

\n

Use the GetBucketAccessKeys action to get a\n list of access key IDs that you can specify.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#DeleteBucketAccessKeyResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#DeleteBucketRequest": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.lightsail#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket to delete.

\n

Use the GetBuckets action to get a list of bucket names\n that you can specify.

", + "smithy.api#required": {} + } + }, + "forceDelete": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether to force delete the bucket.

\n

You must force delete the bucket if it has one of the following conditions:

\n \n \n

Force deleting a bucket might impact other resources that rely on the bucket, such as\n instances, distributions, or software that use the issued access keys.

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#DeleteBucketResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#DeleteCertificate": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteCertificateRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteCertificateResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN)\n distribution.

\n

Certificates that are currently attached to a distribution cannot be deleted. Use the\n DetachCertificateFromDistribution action to detach a certificate from a\n distribution.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DeleteCertificate", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DeleteCertificateRequest": { + "type": "structure", + "members": { + "certificateName": { + "target": "com.amazonaws.lightsail#CertificateName", + "traits": { + "smithy.api#documentation": "

The name of the certificate to delete.

\n

Use the GetCertificates action to get a list of certificate names that you\n can specify.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#DeleteCertificateResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#DeleteContactMethod": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteContactMethodRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteContactMethodResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a contact method.

\n

A contact method is used to send you notifications about your Amazon Lightsail resources.\n You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services\n Regions, and SMS text messages cannot be sent to some countries/regions. For more information,\n see Notifications in Amazon Lightsail.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DeleteContactMethod", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DeleteContactMethodRequest": { + "type": "structure", + "members": { + "protocol": { + "target": "com.amazonaws.lightsail#ContactProtocol", + "traits": { + "smithy.api#documentation": "

The protocol that will be deleted, such as Email or SMS (text\n messaging).

\n \n

To delete an Email and an SMS contact method if you added\n both, you must run separate DeleteContactMethod actions to delete each\n protocol.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#DeleteContactMethodResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#DeleteContainerImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteContainerImageRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteContainerImageResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a container image that is registered to your Amazon Lightsail container\n service.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/ls/api/2016-11-28/container-services/{serviceName}/images/{image}", + "code": 204 + } + } + }, + "com.amazonaws.lightsail#DeleteContainerImageRequest": { + "type": "structure", + "members": { + "serviceName": { + "target": "com.amazonaws.lightsail#ContainerServiceName", + "traits": { + "smithy.api#documentation": "

The name of the container service for which to delete a registered container image.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "image": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The name of the container image to delete from the container service.

\n

Use the GetContainerImages action to get the name of the container images\n that are registered to a container service.

\n \n

Container images sourced from your Lightsail container service, that are registered\n and stored on your service, start with a colon (:). For example,\n :container-service-1.mystaticwebsite.1. Container images sourced from a\n public registry like Docker Hub don't start with a colon. For example,\n nginx:latest or nginx.

\n ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#DeleteContainerImageResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#DeleteContainerService": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteContainerServiceRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteContainerServiceResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes your Amazon Lightsail container service.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/ls/api/2016-11-28/container-services/{serviceName}", + "code": 204 + } + } + }, + "com.amazonaws.lightsail#DeleteContainerServiceRequest": { + "type": "structure", + "members": { + "serviceName": { + "target": "com.amazonaws.lightsail#ContainerServiceName", + "traits": { + "smithy.api#documentation": "

The name of the container service to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#DeleteContainerServiceResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#DeleteDisk": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteDiskRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteDiskResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified block storage disk. The disk must be in the available\n state (not attached to a Lightsail instance).

\n \n

The disk may remain in the deleting state for several minutes.

\n \n

The delete disk operation supports tag-based access control via resource tags\n applied to the resource identified by disk name. For more information, see the\n Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DeleteDisk", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DeleteDiskRequest": { + "type": "structure", + "members": { + "diskName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The unique name of the disk you want to delete (e.g., my-disk).

", + "smithy.api#required": {} + } + }, + "forceDeleteAddOns": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value to indicate whether to delete all add-ons for the disk.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#DeleteDiskResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#DeleteDiskSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteDiskSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteDiskSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified disk snapshot.

\n

When you make periodic snapshots of a disk, the snapshots are incremental, and only the\n blocks on the device that have changed since your last snapshot are saved in the new snapshot.\n When you delete a snapshot, only the data not needed for any other snapshot is removed. So\n regardless of which prior snapshots have been deleted, all active snapshots will have access\n to all the information needed to restore the disk.

\n

The delete disk snapshot operation supports tag-based access control via\n resource tags applied to the resource identified by disk snapshot name. For more\n information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DeleteDiskSnapshot", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DeleteDiskSnapshotRequest": { + "type": "structure", + "members": { + "diskSnapshotName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the disk snapshot you want to delete (e.g.,\n my-disk-snapshot).

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#DeleteDiskSnapshotResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#DeleteDistribution": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteDistributionRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteDistributionResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes your Amazon Lightsail content delivery network (CDN) distribution.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DeleteDistribution", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DeleteDistributionRequest": { + "type": "structure", + "members": { + "distributionName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the distribution to delete.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#DeleteDistributionResult": { + "type": "structure", + "members": { + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An object that describes the result of the action, such as the status of the request, the\n timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#DeleteDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteDomainRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteDomainResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

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

\n

The delete domain operation supports tag-based access control via resource\n tags applied to the resource identified by domain name. For more information, see\n the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DeleteDomain", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DeleteDomainEntry": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteDomainEntryRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteDomainEntryResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a specific domain entry.

\n

The delete domain entry operation supports tag-based access control via\n resource tags applied to the resource identified by domain name. For more\n information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DeleteDomainEntry", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DeleteDomainEntryRequest": { + "type": "structure", + "members": { + "domainName": { + "target": "com.amazonaws.lightsail#DomainName", + "traits": { + "smithy.api#documentation": "

The name of the domain entry to delete.

", + "smithy.api#required": {} + } + }, + "domainEntry": { + "target": "com.amazonaws.lightsail#DomainEntry", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#DeleteDomainEntryResult": { + "type": "structure", + "members": { + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#DeleteDomainRequest": { + "type": "structure", + "members": { + "domainName": { + "target": "com.amazonaws.lightsail#DomainName", + "traits": { + "smithy.api#documentation": "

The specific domain name to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#DeleteDomainResult": { + "type": "structure", + "members": { + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#DeleteInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteInstanceRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteInstanceResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an Amazon Lightsail instance.

\n

The delete instance operation supports tag-based access control via resource\n tags applied to the resource identified by instance name. For more information,\n see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DeleteInstance", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DeleteInstanceRequest": { + "type": "structure", + "members": { + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the instance to delete.

", + "smithy.api#required": {} + } + }, + "forceDeleteAddOns": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value to indicate whether to delete all add-ons for the instance.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#DeleteInstanceResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#DeleteInstanceSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteInstanceSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteInstanceSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

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

\n

The delete instance snapshot operation supports tag-based access control via\n resource tags applied to the resource identified by instance snapshot name. For\n more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DeleteInstanceSnapshot", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DeleteInstanceSnapshotRequest": { + "type": "structure", + "members": { + "instanceSnapshotName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the snapshot to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#DeleteInstanceSnapshotResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#DeleteKeyPair": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteKeyPairRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteKeyPairResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified key pair by removing the public key from Amazon Lightsail.

\n

You can delete key pairs that were created using the ImportKeyPair and\n CreateKeyPair actions, as well as the Lightsail default key pair. A new default\n key pair will not be created unless you launch an instance without specifying a custom key\n pair, or you call the DownloadDefaultKeyPair API.

\n

The delete key pair operation supports tag-based access control via resource\n tags applied to the resource identified by key pair name. For more information,\n see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DeleteKeyPair", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DeleteKeyPairRequest": { + "type": "structure", + "members": { + "keyPairName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the key pair to delete.

", + "smithy.api#required": {} + } + }, + "expectedFingerprint": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The RSA fingerprint of the Lightsail default key pair to delete.

\n \n

The expectedFingerprint parameter is required only when specifying to\n delete a Lightsail default key pair.

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#DeleteKeyPairResult": { + "type": "structure", + "members": { + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#DeleteKnownHostKeys": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteKnownHostKeysRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteKnownHostKeysResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or\n RDP clients to authenticate an instance. This operation enables the Lightsail browser-based\n SSH or RDP clients to connect to the instance after a host key mismatch.

\n \n

Perform this operation only if you were expecting the host key or certificate mismatch\n or if you are familiar with the new host key or certificate on the instance. For more\n information, see Troubleshooting connection issues when using the Amazon Lightsail browser-based SSH or RDP\n client.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DeleteKnownHostKeys", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DeleteKnownHostKeysRequest": { + "type": "structure", + "members": { + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the instance for which you want to reset the host key or certificate.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#DeleteKnownHostKeysResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#DeleteLoadBalancer": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteLoadBalancerRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteLoadBalancerResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a Lightsail load balancer and all its associated SSL/TLS certificates. Once the\n load balancer is deleted, you will need to create a new load balancer, create a new\n certificate, and verify domain ownership again.

\n

The delete load balancer operation supports tag-based access control via\n resource tags applied to the resource identified by load balancer name. For more\n information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DeleteLoadBalancer", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DeleteLoadBalancerRequest": { + "type": "structure", + "members": { + "loadBalancerName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the load balancer you want to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#DeleteLoadBalancerResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#DeleteLoadBalancerTlsCertificate": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteLoadBalancerTlsCertificateRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteLoadBalancerTlsCertificateResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an SSL/TLS certificate associated with a Lightsail load balancer.

\n

The DeleteLoadBalancerTlsCertificate operation supports tag-based access\n control via resource tags applied to the resource identified by load balancer\n name. For more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DeleteLoadBalancerTlsCertificate", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DeleteLoadBalancerTlsCertificateRequest": { + "type": "structure", + "members": { + "loadBalancerName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The load balancer name.

", + "smithy.api#required": {} + } + }, + "certificateName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The SSL/TLS certificate name.

", + "smithy.api#required": {} + } + }, + "force": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

When true, forces the deletion of an SSL/TLS certificate.

\n

There can be two certificates associated with a Lightsail load balancer: the primary and\n the backup. The force parameter is required when the primary SSL/TLS certificate\n is in use by an instance attached to the load balancer.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#DeleteLoadBalancerTlsCertificateResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#DeleteRelationalDatabase": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteRelationalDatabaseRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteRelationalDatabaseResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a database in Amazon Lightsail.

\n

The delete relational database operation supports tag-based access control\n via resource tags applied to the resource identified by relationalDatabaseName. For more\n information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DeleteRelationalDatabase", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DeleteRelationalDatabaseRequest": { + "type": "structure", + "members": { + "relationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the database that you are deleting.

", + "smithy.api#required": {} + } + }, + "skipFinalSnapshot": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

Determines whether a final database snapshot is created before your database is deleted.\n If true is specified, no database snapshot is created. If false is\n specified, a database snapshot is created before your database is deleted.

\n

You must specify the final relational database snapshot name parameter if the\n skip final snapshot parameter is false.

\n

Default: false\n

" + } + }, + "finalRelationalDatabaseSnapshotName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the database snapshot created if skip final snapshot is\n false, which is the default value for that parameter.

\n \n

Specifying this parameter and also specifying the skip final snapshot\n parameter to true results in an error.

\n \n

Constraints:

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#DeleteRelationalDatabaseResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#DeleteRelationalDatabaseSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteRelationalDatabaseSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteRelationalDatabaseSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a database snapshot in Amazon Lightsail.

\n

The delete relational database snapshot operation supports tag-based access\n control via resource tags applied to the resource identified by relationalDatabaseName. For\n more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DeleteRelationalDatabaseSnapshot", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DeleteRelationalDatabaseSnapshotRequest": { + "type": "structure", + "members": { + "relationalDatabaseSnapshotName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the database snapshot that you are deleting.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#DeleteRelationalDatabaseSnapshotResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#DestinationInfo": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the resource created at the destination.

" + } + }, + "service": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The destination service of the record.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the destination of a record.

" + } + }, + "com.amazonaws.lightsail#DetachCertificateFromDistribution": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DetachCertificateFromDistributionRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DetachCertificateFromDistributionResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN)\n distribution.

\n

After the certificate is detached, your distribution stops accepting traffic for all of\n the domains that are associated with the certificate.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DetachCertificateFromDistribution", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DetachCertificateFromDistributionRequest": { + "type": "structure", + "members": { + "distributionName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the distribution from which to detach the certificate.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#DetachCertificateFromDistributionResult": { + "type": "structure", + "members": { + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An object that describes the result of the action, such as the status of the request, the\n timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#DetachDisk": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DetachDiskRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DetachDiskResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount\n any file systems on the device within your operating system before stopping the instance and\n detaching the disk.

\n

The detach disk operation supports tag-based access control via resource tags\n applied to the resource identified by disk name. For more information, see the\n Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DetachDisk", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DetachDiskRequest": { + "type": "structure", + "members": { + "diskName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The unique name of the disk you want to detach from your instance (e.g.,\n my-disk).

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#DetachDiskResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#DetachInstancesFromLoadBalancer": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DetachInstancesFromLoadBalancerRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DetachInstancesFromLoadBalancerResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Detaches the specified instances from a Lightsail load balancer.

\n

This operation waits until the instances are no longer needed before they are detached\n from the load balancer.

\n

The detach instances from load balancer operation supports tag-based access\n control via resource tags applied to the resource identified by load balancer\n name. For more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DetachInstancesFromLoadBalancer", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DetachInstancesFromLoadBalancerRequest": { + "type": "structure", + "members": { + "loadBalancerName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the Lightsail load balancer.

", + "smithy.api#required": {} + } + }, + "instanceNames": { + "target": "com.amazonaws.lightsail#ResourceNameList", + "traits": { + "smithy.api#documentation": "

An array of strings containing the names of the instances you want to detach from the load\n balancer.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#DetachInstancesFromLoadBalancerResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#DetachStaticIp": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DetachStaticIpRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DetachStaticIpResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DetachStaticIp", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DetachStaticIpRequest": { + "type": "structure", + "members": { + "staticIpName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#DetachStaticIpResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#DisableAddOn": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DisableAddOnRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DisableAddOnResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Disables an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DisableAddOn", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DisableAddOnRequest": { + "type": "structure", + "members": { + "addOnType": { + "target": "com.amazonaws.lightsail#AddOnType", + "traits": { + "smithy.api#documentation": "

The add-on type to disable.

", + "smithy.api#required": {} + } + }, + "resourceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the source resource for which to disable the add-on.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#DisableAddOnResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#Disk": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The unique name of the disk.

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the disk.

" + } + }, + "supportCode": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The date when the disk was created.

" + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

The AWS Region and Availability Zone where the disk is located.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The Lightsail resource type (e.g., Disk).

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" + } + }, + "addOns": { + "target": "com.amazonaws.lightsail#AddOnList", + "traits": { + "smithy.api#documentation": "

An array of objects representing the add-ons enabled on the disk.

" + } + }, + "sizeInGb": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The size of the disk in GB.

" + } + }, + "isSystemDisk": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "iops": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "path": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The disk path.

" + } + }, + "state": { + "target": "com.amazonaws.lightsail#DiskState", + "traits": { + "smithy.api#documentation": "

Describes the status of the disk.

" + } + }, + "attachedTo": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The resources to which the disk is attached.

" + } + }, + "isAttached": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether the disk is attached.

" + } + }, + "attachmentState": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

(Deprecated) The attachment state of the disk.

\n \n

In releases prior to November 14, 2017, this parameter returned attached\n for system disks in the API response. It is now deprecated, but still included in the\n response. Use isAttached instead.

\n " + } + }, + "gbInUse": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

(Deprecated) The number of GB in use by the disk.

\n \n

In releases prior to November 14, 2017, this parameter was not included in the API\n response. It is now deprecated.

\n " + } + }, + "autoMountStatus": { + "target": "com.amazonaws.lightsail#AutoMountStatus", + "traits": { + "smithy.api#documentation": "

The status of automatically mounting a storage disk to a virtual computer.

\n \n

This parameter only applies to Lightsail for Research resources.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a block storage disk.

" + } + }, + "com.amazonaws.lightsail#DiskInfo": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The disk name.

" + } + }, + "path": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The disk path.

" + } + }, + "sizeInGb": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The size of the disk in GB (e.g., 32).

" + } + }, + "isSystemDisk": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

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

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a disk.

" + } + }, + "com.amazonaws.lightsail#DiskInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#DiskInfo" + } + }, + "com.amazonaws.lightsail#DiskList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#Disk" + } + }, + "com.amazonaws.lightsail#DiskMap": { + "type": "structure", + "members": { + "originalDiskPath": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The original disk path exposed to the instance (for example,\n /dev/sdh).

" + } + }, + "newDiskName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The new disk name (e.g., my-new-disk).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a block storage disk mapping.

" + } + }, + "com.amazonaws.lightsail#DiskMapList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#DiskMap" + } + }, + "com.amazonaws.lightsail#DiskSnapshot": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the disk snapshot (e.g., my-disk-snapshot).

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the disk snapshot.

" + } + }, + "supportCode": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The date when the disk snapshot was created.

" + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

The AWS Region and Availability Zone where the disk snapshot was created.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The Lightsail resource type (e.g., DiskSnapshot).

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" + } + }, + "sizeInGb": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The size of the disk in GB.

" + } + }, + "state": { + "target": "com.amazonaws.lightsail#DiskSnapshotState", + "traits": { + "smithy.api#documentation": "

The status of the disk snapshot operation.

" + } + }, + "progress": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The progress of the snapshot.

" + } + }, + "fromDiskName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The unique name of the source disk from which the disk snapshot was created.

" + } + }, + "fromDiskArn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was\n created.

" + } + }, + "fromInstanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The unique name of the source instance from which the disk (system volume) snapshot was\n created.

" + } + }, + "fromInstanceArn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source instance from which the disk (system volume)\n snapshot was created.

" + } + }, + "isFromAutoSnapshot": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether the snapshot was created from an automatic\n snapshot.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a block storage disk snapshot.

" + } + }, + "com.amazonaws.lightsail#DiskSnapshotInfo": { + "type": "structure", + "members": { + "sizeInGb": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The size of the disk in GB (e.g., 32).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a disk snapshot.

" + } + }, + "com.amazonaws.lightsail#DiskSnapshotList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#DiskSnapshot" + } + }, + "com.amazonaws.lightsail#DiskSnapshotState": { + "type": "enum", + "members": { + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "Completed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "completed" + } + }, + "Error": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "error" + } + }, + "Unknown": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unknown" + } + } + } + }, + "com.amazonaws.lightsail#DiskState": { + "type": "enum", + "members": { + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "Error": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "error" + } + }, + "Available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "InUse": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "in-use" + } + }, + "Unknown": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unknown" + } + } + } + }, + "com.amazonaws.lightsail#DistributionBundle": { + "type": "structure", + "members": { + "bundleId": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The ID of the bundle.

" + } + }, + "name": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The name of the distribution bundle.

" + } + }, + "price": { + "target": "com.amazonaws.lightsail#float", + "traits": { + "smithy.api#documentation": "

The monthly price, in US dollars, of the bundle.

" + } + }, + "transferPerMonthInGb": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The monthly network transfer quota of the bundle.

" + } + }, + "isActive": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the bundle is active, and can be specified for a new or existing\n distribution.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the specifications of a distribution bundle.

" + } + }, + "com.amazonaws.lightsail#DistributionBundleList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#DistributionBundle" + } + }, + "com.amazonaws.lightsail#DistributionList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#LightsailDistribution" + } + }, + "com.amazonaws.lightsail#DistributionMetricName": { + "type": "enum", + "members": { + "Requests": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Requests" + } + }, + "BytesDownloaded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BytesDownloaded" + } + }, + "BytesUploaded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BytesUploaded" + } + }, + "TotalErrorRate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TotalErrorRate" + } + }, + "Http4xxErrorRate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Http4xxErrorRate" + } + }, + "Http5xxErrorRate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Http5xxErrorRate" + } + } + } + }, + "com.amazonaws.lightsail#DnsRecordCreationState": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.lightsail#DnsRecordCreationStateCode", + "traits": { + "smithy.api#documentation": "

The status code for the automated DNS record creation.

\n

Following are the possible values:

\n " + } + }, + "message": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The message that describes the reason for the status code.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the creation state of the canonical name (CNAME) records that are automatically\n added by Amazon Lightsail to the DNS of a domain to validate domain ownership for\n an SSL/TLS certificate.

\n

When you create an SSL/TLS certificate for a Lightsail resource, you must\n add a set of CNAME records to the DNS of the domains for the certificate to validate that you\n own the domains. Lightsail can automatically add the CNAME records to the DNS\n of the domain if the DNS zone for the domain exists within your Lightsail\n account. If automatic record addition fails, or if you manage the DNS of your domain using a\n third-party service, then you must manually add the CNAME records to the DNS of your domain.\n For more information, see Verify an SSL/TLS certificate in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

" + } + }, + "com.amazonaws.lightsail#DnsRecordCreationStateCode": { + "type": "enum", + "members": { + "Succeeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "Started": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTED" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.lightsail#Domain": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the domain.

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "supportCode": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The date when the domain recordset was created.

" + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The resource type.

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" + } + }, + "domainEntries": { + "target": "com.amazonaws.lightsail#DomainEntryList", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "registeredDomainDelegationInfo": { + "target": "com.amazonaws.lightsail#RegisteredDomainDelegationInfo", + "traits": { + "smithy.api#documentation": "

An object that describes the state of the Route 53 domain delegation to a\n Lightsail DNS zone.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a domain where you are storing recordsets.

" + } + }, + "com.amazonaws.lightsail#DomainEntry": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the domain recordset entry.

" + } + }, + "name": { + "target": "com.amazonaws.lightsail#DomainName", + "traits": { + "smithy.api#documentation": "

The name of the domain.

" + } + }, + "target": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The target IP address (e.g., 192.0.2.0), or AWS name server (e.g.,\n ns-111.awsdns-22.com.).

\n

For Lightsail load balancers, the value looks like\n ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com. For\n Lightsail distributions, the value looks like exampled1182ne.cloudfront.net.\n For Lightsail container services, the value looks like\n container-service-1.example23scljs.us-west-2.cs.amazonlightsail.com. Be sure to\n also set isAlias to true when setting up an A record for a\n Lightsail load balancer, distribution, or container service.

" + } + }, + "isAlias": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

When true, specifies whether the domain entry is an alias used by the Lightsail load balancer, Lightsail container service, Lightsail content delivery network (CDN) distribution, or another Amazon Web Services\n resource. You can include an alias (A type) record in your request, which points to the DNS\n name of a load balancer, container service, CDN distribution, or other Amazon Web Services\n resource and routes traffic to that resource.

" + } + }, + "type": { + "target": "com.amazonaws.lightsail#DomainEntryType", + "traits": { + "smithy.api#documentation": "

The type of domain entry, such as address for IPv4 (A), address for IPv6 (AAAA), canonical\n name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator\n (SRV), or text (TXT).

\n

The following domain entry types can be used:

\n " + } + }, + "options": { + "target": "com.amazonaws.lightsail#DomainEntryOptions", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

(Deprecated) The options for the domain entry.

\n \n

In releases prior to November 29, 2017, this parameter was not included in the API\n response. It is now deprecated.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a domain recordset entry.

" + } + }, + "com.amazonaws.lightsail#DomainEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#DomainEntry" + } + }, + "com.amazonaws.lightsail#DomainEntryOptions": { + "type": "map", + "key": { + "target": "com.amazonaws.lightsail#DomainEntryOptionsKeys" + }, + "value": { + "target": "com.amazonaws.lightsail#string" + } + }, + "com.amazonaws.lightsail#DomainEntryOptionsKeys": { + "type": "string" + }, + "com.amazonaws.lightsail#DomainEntryType": { + "type": "string" + }, + "com.amazonaws.lightsail#DomainList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#Domain" + } + }, + "com.amazonaws.lightsail#DomainName": { + "type": "string" + }, + "com.amazonaws.lightsail#DomainNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#DomainName" + } + }, + "com.amazonaws.lightsail#DomainValidationRecord": { + "type": "structure", + "members": { + "domainName": { + "target": "com.amazonaws.lightsail#DomainName", + "traits": { + "smithy.api#documentation": "

The domain name of the certificate validation record. For example,\n example.com or www.example.com.

" + } + }, + "resourceRecord": { + "target": "com.amazonaws.lightsail#ResourceRecord", + "traits": { + "smithy.api#documentation": "

An object that describes the DNS records to add to your domain's DNS to validate it for\n the certificate.

" + } + }, + "dnsRecordCreationState": { + "target": "com.amazonaws.lightsail#DnsRecordCreationState", + "traits": { + "smithy.api#documentation": "

An object that describes the state of the canonical name (CNAME) records that are\n automatically added by Lightsail to the DNS of the domain to validate domain\n ownership.

" + } + }, + "validationStatus": { + "target": "com.amazonaws.lightsail#CertificateDomainValidationStatus", + "traits": { + "smithy.api#documentation": "

The validation status of the record.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the domain name system (DNS) records that you must add to the DNS of your\n registered domain to validate ownership for an Amazon Lightsail SSL/TLS certificate.

" + } + }, + "com.amazonaws.lightsail#DomainValidationRecordList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#DomainValidationRecord" + } + }, + "com.amazonaws.lightsail#DownloadDefaultKeyPair": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DownloadDefaultKeyPairRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DownloadDefaultKeyPairResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Downloads the regional Amazon Lightsail default key pair.

\n

This action also creates a Lightsail default key pair if a default key pair\n does not currently exist in the Amazon Web Services Region.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DownloadDefaultKeyPair", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DownloadDefaultKeyPairRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#DownloadDefaultKeyPairResult": { + "type": "structure", + "members": { + "publicKeyBase64": { + "target": "com.amazonaws.lightsail#Base64", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "privateKeyBase64": { + "target": "com.amazonaws.lightsail#Base64", + "traits": { + "smithy.api#documentation": "

A base64-encoded RSA private key.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the default key pair was created.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#EligibleToRenew": { + "type": "string" + }, + "com.amazonaws.lightsail#EnableAddOn": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#EnableAddOnRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#EnableAddOnResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see\n the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/EnableAddOn", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#EnableAddOnRequest": { + "type": "structure", + "members": { + "resourceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the source resource for which to enable or modify the add-on.

", + "smithy.api#required": {} + } + }, + "addOnRequest": { + "target": "com.amazonaws.lightsail#AddOnRequest", + "traits": { + "smithy.api#documentation": "

An array of strings representing the add-on to enable or modify.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#EnableAddOnResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#EndpointRequest": { + "type": "structure", + "members": { + "containerName": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The name of the container for the endpoint.

", + "smithy.api#required": {} + } + }, + "containerPort": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The port of the container to which traffic is forwarded to.

", + "smithy.api#required": {} + } + }, + "healthCheck": { + "target": "com.amazonaws.lightsail#ContainerServiceHealthCheckConfig", + "traits": { + "smithy.api#documentation": "

An object that describes the health check configuration of the container.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the settings of a public endpoint for an Amazon Lightsail container\n service.

" + } + }, + "com.amazonaws.lightsail#Environment": { + "type": "map", + "key": { + "target": "com.amazonaws.lightsail#string" + }, + "value": { + "target": "com.amazonaws.lightsail#string" + } + }, + "com.amazonaws.lightsail#EstimateByTime": { + "type": "structure", + "members": { + "usageCost": { + "target": "com.amazonaws.lightsail#double", + "traits": { + "smithy.api#documentation": "

The amount of cost or usage that's measured for the cost estimate.

" + } + }, + "pricingUnit": { + "target": "com.amazonaws.lightsail#PricingUnit", + "traits": { + "smithy.api#documentation": "

The unit of measurement that's used for the cost estimate.

" + } + }, + "unit": { + "target": "com.amazonaws.lightsail#double", + "traits": { + "smithy.api#documentation": "

The number of pricing units used to calculate the total number of hours. For example, 1\n unit equals 1 hour.

" + } + }, + "currency": { + "target": "com.amazonaws.lightsail#Currency", + "traits": { + "smithy.api#documentation": "

The currency of the estimate in USD.

" + } + }, + "timePeriod": { + "target": "com.amazonaws.lightsail#TimePeriod", + "traits": { + "smithy.api#documentation": "

The period of time, in days, that an estimate covers. The period has a start date and an end date. The start date must come before the end date.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An estimate that's associated with a time period.

" + } + }, + "com.amazonaws.lightsail#EstimatesByTime": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#EstimateByTime" + } + }, + "com.amazonaws.lightsail#ExportSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#ExportSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#ExportSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2).\n This operation results in an export snapshot record that can be used with the create\n cloud formation stack operation to create new Amazon EC2 instances.

\n

Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the\n instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in\n Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in\n Amazon EC2 as the source Lightsail snapshot.

\n

\n

The export snapshot operation supports tag-based access control via resource\n tags applied to the resource identified by source snapshot name. For more\n information, see the Amazon Lightsail Developer Guide.

\n \n

Use the get instance snapshots or get disk snapshots\n operations to get a list of snapshots that you can export to Amazon EC2.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/ExportSnapshot", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#ExportSnapshotRecord": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The export snapshot record name.

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the export snapshot record.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The date when the export snapshot record was created.

" + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

The AWS Region and Availability Zone where the export snapshot record is located.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The Lightsail resource type (e.g., ExportSnapshotRecord).

" + } + }, + "state": { + "target": "com.amazonaws.lightsail#RecordState", + "traits": { + "smithy.api#documentation": "

The state of the export snapshot record.

" + } + }, + "sourceInfo": { + "target": "com.amazonaws.lightsail#ExportSnapshotRecordSourceInfo", + "traits": { + "smithy.api#documentation": "

A list of objects describing the source of the export snapshot record.

" + } + }, + "destinationInfo": { + "target": "com.amazonaws.lightsail#DestinationInfo", + "traits": { + "smithy.api#documentation": "

A list of objects describing the destination of the export snapshot record.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an export snapshot record.

" + } + }, + "com.amazonaws.lightsail#ExportSnapshotRecordList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#ExportSnapshotRecord" + } + }, + "com.amazonaws.lightsail#ExportSnapshotRecordSourceInfo": { + "type": "structure", + "members": { + "resourceType": { + "target": "com.amazonaws.lightsail#ExportSnapshotRecordSourceType", + "traits": { + "smithy.api#documentation": "

The Lightsail resource type (e.g., InstanceSnapshot or\n DiskSnapshot).

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The date when the source instance or disk snapshot was created.

" + } + }, + "name": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the source instance or disk snapshot.

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source instance or disk snapshot.

" + } + }, + "fromResourceName": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the snapshot's source instance or disk.

" + } + }, + "fromResourceArn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the snapshot's source instance or disk.

" + } + }, + "instanceSnapshotInfo": { + "target": "com.amazonaws.lightsail#InstanceSnapshotInfo", + "traits": { + "smithy.api#documentation": "

A list of objects describing an instance snapshot.

" + } + }, + "diskSnapshotInfo": { + "target": "com.amazonaws.lightsail#DiskSnapshotInfo", + "traits": { + "smithy.api#documentation": "

A list of objects describing a disk snapshot.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the source of an export snapshot record.

" + } + }, + "com.amazonaws.lightsail#ExportSnapshotRecordSourceType": { + "type": "enum", + "members": { + "InstanceSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InstanceSnapshot" + } + }, + "DiskSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DiskSnapshot" + } + } + } + }, + "com.amazonaws.lightsail#ExportSnapshotRequest": { + "type": "structure", + "members": { + "sourceSnapshotName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the instance or disk snapshot to be exported to Amazon EC2.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#ExportSnapshotResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#ForwardValues": { + "type": "enum", + "members": { + "none": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "none" + } + }, + "allowList": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "allow-list" + } + }, + "all": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "all" + } + } + } + }, + "com.amazonaws.lightsail#GetActiveNames": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetActiveNamesRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetActiveNamesResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetActiveNames", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetActiveNamesRequest": { + "type": "structure", + "members": { + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetActiveNames request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetActiveNamesResult": { + "type": "structure", + "members": { + "activeNames": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetActiveNames request and\n specify the next page token using the pageToken parameter.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetAlarms": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetAlarmsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetAlarmsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about the configured alarms. Specify an alarm name in your request to\n return information about a specific alarm, or specify a monitored resource name to return\n information about all alarms for a specific resource.

\n

An alarm is used to monitor a single metric for one of your resources. When a metric\n condition is met, the alarm can notify you by email, SMS text message, and a banner displayed\n on the Amazon Lightsail console. For more information, see Alarms\n in Amazon Lightsail.

", + "smithy.api#http": { + "method": "GET", + "uri": "/ls/api/2016-11-28/GetAlarms", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetAlarmsRequest": { + "type": "structure", + "members": { + "alarmName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the alarm.

\n

Specify an alarm name to return information about a specific alarm.

" + } + }, + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetAlarms request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

" + } + }, + "monitoredResourceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the Lightsail resource being monitored by the alarm.

\n

Specify a monitored resource name to return information about all alarms for a specific\n resource.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetAlarmsResult": { + "type": "structure", + "members": { + "alarms": { + "target": "com.amazonaws.lightsail#AlarmsList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the alarms.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetAlarms request and\n specify the next page token using the pageToken parameter.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetAutoSnapshots": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetAutoSnapshotsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetAutoSnapshotsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the available automatic snapshots for an instance or disk. For more information,\n see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetAutoSnapshots", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetAutoSnapshotsRequest": { + "type": "structure", + "members": { + "resourceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the source instance or disk from which to get automatic snapshot\n information.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetAutoSnapshotsResult": { + "type": "structure", + "members": { + "resourceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the source instance or disk for the automatic snapshots.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The resource type (e.g., Instance or Disk).

" + } + }, + "autoSnapshots": { + "target": "com.amazonaws.lightsail#AutoSnapshotDetailsList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the automatic snapshots that are available for the\n specified source instance or disk.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetBlueprints": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetBlueprintsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetBlueprintsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

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

\n \n

Use active blueprints when creating new instances. Inactive blueprints are listed to\n support customers with existing instances and are not necessarily available to create new\n instances. Blueprints are marked inactive when they become outdated due to operating system\n updates or new application releases.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetBlueprints", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetBlueprintsRequest": { + "type": "structure", + "members": { + "includeInactive": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether to include inactive (unavailable) blueprints in the\n response of your request.

" + } + }, + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetBlueprints request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" + } + }, + "appCategory": { + "target": "com.amazonaws.lightsail#AppCategory", + "traits": { + "smithy.api#documentation": "

Returns a list of blueprints that are specific to Lightsail for Research.

\n \n

You must use this parameter to view Lightsail for Research blueprints.

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetBlueprintsResult": { + "type": "structure", + "members": { + "blueprints": { + "target": "com.amazonaws.lightsail#BlueprintList", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetBlueprints request and\n specify the next page token using the pageToken parameter.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetBucketAccessKeys": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetBucketAccessKeysRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetBucketAccessKeysResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the existing access key IDs for the specified Amazon Lightsail bucket.

\n \n

This action does not return the secret access key value of an access key. You can get a\n secret access key only when you create it from the response of the CreateBucketAccessKey action. If you lose the secret access key, you must create\n a new access key.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetBucketAccessKeys", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetBucketAccessKeysRequest": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.lightsail#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket for which to return access keys.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetBucketAccessKeysResult": { + "type": "structure", + "members": { + "accessKeys": { + "target": "com.amazonaws.lightsail#AccessKeyList", + "traits": { + "smithy.api#documentation": "

An object that describes the access keys for the specified bucket.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetBucketBundles": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetBucketBundlesRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetBucketBundlesResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the bundles that you can apply to a Amazon Lightsail bucket.

\n

The bucket bundle specifies the monthly cost, storage quota, and data transfer quota for a\n bucket.

\n

Use the UpdateBucketBundle action to update the\n bundle for a bucket.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetBucketBundles", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetBucketBundlesRequest": { + "type": "structure", + "members": { + "includeInactive": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether to include inactive (unavailable) bundles in the\n response of your request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetBucketBundlesResult": { + "type": "structure", + "members": { + "bundles": { + "target": "com.amazonaws.lightsail#BucketBundleList", + "traits": { + "smithy.api#documentation": "

An object that describes bucket bundles.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetBucketMetricData": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetBucketMetricDataRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetBucketMetricDataResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the data points of a specific metric for an Amazon Lightsail bucket.

\n

Metrics report the utilization of a bucket. View and collect metric data regularly to\n monitor the number of objects stored in a bucket (including object versions) and the storage\n space used by those objects.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetBucketMetricData", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetBucketMetricDataRequest": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.lightsail#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket for which to get metric data.

", + "smithy.api#required": {} + } + }, + "metricName": { + "target": "com.amazonaws.lightsail#BucketMetricName", + "traits": { + "smithy.api#documentation": "

The metric for which you want to return information.

\n

Valid bucket metric names are listed below, along with the most useful statistics to\n include in your request, and the published unit value.

\n \n

These bucket metrics are reported once per day.

\n \n ", + "smithy.api#required": {} + } + }, + "startTime": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp indicating the earliest data to be returned.

", + "smithy.api#required": {} + } + }, + "endTime": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp indicating the latest data to be returned.

", + "smithy.api#required": {} + } + }, + "period": { + "target": "com.amazonaws.lightsail#MetricPeriod", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The granularity, in seconds, of the returned data points.

\n \n

Bucket storage metrics are reported once per day. Therefore, you should specify a period\n of 86400 seconds, which is the number of seconds in a day.

\n ", + "smithy.api#required": {} + } + }, + "statistics": { + "target": "com.amazonaws.lightsail#MetricStatisticList", + "traits": { + "smithy.api#documentation": "

The statistic for the metric.

\n

The following statistics are available:

\n ", + "smithy.api#required": {} + } + }, + "unit": { + "target": "com.amazonaws.lightsail#MetricUnit", + "traits": { + "smithy.api#documentation": "

The unit for the metric data request.

\n

Valid units depend on the metric data being requested. For the valid units with each\n available metric, see the metricName parameter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetBucketMetricDataResult": { + "type": "structure", + "members": { + "metricName": { + "target": "com.amazonaws.lightsail#BucketMetricName", + "traits": { + "smithy.api#documentation": "

The name of the metric returned.

" + } + }, + "metricData": { + "target": "com.amazonaws.lightsail#MetricDatapointList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the metric data returned.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetBuckets": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetBucketsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetBucketsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about one or more Amazon Lightsail buckets. The information returned\n includes the synchronization status of the Amazon Simple Storage Service (Amazon S3)\n account-level block public access feature for your Lightsail buckets.

\n

For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer\n Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetBuckets", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetBucketsRequest": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.lightsail#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket for which to return information.

\n

When omitted, the response includes all of your buckets in the Amazon Web Services Region\n where the request is made.

" + } + }, + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetBuckets request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

" + } + }, + "includeConnectedResources": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether to include Lightsail instances that were given\n access to the bucket using the SetResourceAccessForBucket\n action.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetBucketsResult": { + "type": "structure", + "members": { + "buckets": { + "target": "com.amazonaws.lightsail#BucketList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe buckets.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetBuckets request and\n specify the next page token using the pageToken parameter.

" + } + }, + "accountLevelBpaSync": { + "target": "com.amazonaws.lightsail#AccountLevelBpaSync", + "traits": { + "smithy.api#documentation": "

An object that describes the synchronization status of the Amazon S3 account-level\n block public access feature for your Lightsail buckets.

\n

For more information about this feature and how it affects Lightsail buckets, see Block public access for buckets in Amazon Lightsail.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetBundles": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetBundlesRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetBundlesResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the bundles that you can apply to an Amazon Lightsail instance when you create\n it.

\n

A bundle describes the specifications of an instance, such as the monthly cost, amount of\n memory, the number of vCPUs, amount of storage space, and monthly network data transfer\n quota.

\n \n

Bundles are referred to as instance plans in the Lightsail\n console.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetBundles", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetBundlesRequest": { + "type": "structure", + "members": { + "includeInactive": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether to include inactive (unavailable) bundles in the\n response of your request.

" + } + }, + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetBundles request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

" + } + }, + "appCategory": { + "target": "com.amazonaws.lightsail#AppCategory", + "traits": { + "smithy.api#documentation": "

Returns a list of bundles that are specific to Lightsail for Research.

\n \n

You must use this parameter to view Lightsail for Research bundles.

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetBundlesResult": { + "type": "structure", + "members": { + "bundles": { + "target": "com.amazonaws.lightsail#BundleList", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetBundles request and\n specify the next page token using the pageToken parameter.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetCertificates": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetCertificatesRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetCertificatesResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about one or more Amazon Lightsail SSL/TLS certificates.

\n \n

To get a summary of a certificate, omit includeCertificateDetails from\n your request. The response will include only the certificate Amazon Resource Name (ARN),\n certificate name, domain name, and tags.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetCertificates", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetCertificatesRequest": { + "type": "structure", + "members": { + "certificateStatuses": { + "target": "com.amazonaws.lightsail#CertificateStatusList", + "traits": { + "smithy.api#documentation": "

The status of the certificates for which to return information.

\n

For example, specify ISSUED to return only certificates with an\n ISSUED status.

\n

When omitted, the response includes all of your certificates in the Amazon Web Services\n Region where the request is made, regardless of their current status.

" + } + }, + "includeCertificateDetails": { + "target": "com.amazonaws.lightsail#IncludeCertificateDetails", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to include detailed information about the certificates in the\n response.

\n

When omitted, the response includes only the certificate names, Amazon Resource Names\n (ARNs), domain names, and tags.

" + } + }, + "certificateName": { + "target": "com.amazonaws.lightsail#CertificateName", + "traits": { + "smithy.api#documentation": "

The name for the certificate for which to return information.

\n

When omitted, the response includes all of your certificates in the Amazon Web Services\n Region where the request is made.

" + } + }, + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetCertificates request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetCertificatesResult": { + "type": "structure", + "members": { + "certificates": { + "target": "com.amazonaws.lightsail#CertificateSummaryList", + "traits": { + "smithy.api#documentation": "

An object that describes certificates.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#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.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetCloudFormationStackRecords": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetCloudFormationStackRecordsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetCloudFormationStackRecordsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the CloudFormation stack record created as a result of the create cloud\n formation stack operation.

\n

An AWS CloudFormation stack is used to create a new Amazon EC2 instance from an exported Lightsail\n snapshot.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetCloudFormationStackRecords", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetCloudFormationStackRecordsRequest": { + "type": "structure", + "members": { + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetClouFormationStackRecords request.\n If your results are paginated, the response will return a next page token that you can specify\n as the page token in a subsequent request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetCloudFormationStackRecordsResult": { + "type": "structure", + "members": { + "cloudFormationStackRecords": { + "target": "com.amazonaws.lightsail#CloudFormationStackRecordList", + "traits": { + "smithy.api#documentation": "

A list of objects describing the CloudFormation stack records.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another\n GetCloudFormationStackRecords request and specify the next page token using the\n pageToken parameter.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetContactMethods": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetContactMethodsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetContactMethodsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about the configured contact methods. Specify a protocol in your\n request to return information about a specific contact method.

\n

A contact method is used to send you notifications about your Amazon Lightsail resources.\n You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services\n Regions, and SMS text messages cannot be sent to some countries/regions. For more information,\n see Notifications in Amazon Lightsail.

", + "smithy.api#http": { + "method": "GET", + "uri": "/ls/api/2016-11-28/GetContactMethods", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetContactMethodsRequest": { + "type": "structure", + "members": { + "protocols": { + "target": "com.amazonaws.lightsail#ContactProtocolsList", + "traits": { + "smithy.api#documentation": "

The protocols used to send notifications, such as Email, or SMS\n (text messaging).

\n

Specify a protocol in your request to return information about a specific contact method\n protocol.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetContactMethodsResult": { + "type": "structure", + "members": { + "contactMethods": { + "target": "com.amazonaws.lightsail#ContactMethodsList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the contact methods.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetContainerAPIMetadata": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetContainerAPIMetadataRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetContainerAPIMetadataResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about Amazon Lightsail containers, such as the current version of the\n Lightsail Control (lightsailctl) plugin.

", + "smithy.api#http": { + "method": "GET", + "uri": "/ls/api/2016-11-28/container-api-metadata", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetContainerAPIMetadataRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetContainerAPIMetadataResult": { + "type": "structure", + "members": { + "metadata": { + "target": "com.amazonaws.lightsail#ContainerServiceMetadataEntryList", + "traits": { + "smithy.api#documentation": "

Metadata about Lightsail containers, such as the current version of the Lightsail\n Control (lightsailctl) plugin.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetContainerImages": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetContainerImagesRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetContainerImagesResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the container images that are registered to your Amazon Lightsail container\n service.

\n \n

If you created a deployment on your Lightsail container service that uses container\n images from a public registry like Docker Hub, those images are not returned as part of this\n action. Those images are not registered to your Lightsail container service.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/ls/api/2016-11-28/container-services/{serviceName}/images", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetContainerImagesRequest": { + "type": "structure", + "members": { + "serviceName": { + "target": "com.amazonaws.lightsail#ContainerServiceName", + "traits": { + "smithy.api#documentation": "

The name of the container service for which to return registered container images.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetContainerImagesResult": { + "type": "structure", + "members": { + "containerImages": { + "target": "com.amazonaws.lightsail#ContainerImageList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe container images that are registered to the container\n service.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetContainerLog": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetContainerLogRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetContainerLogResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the log events of a container of your Amazon Lightsail container service.

\n

If your container service has more than one node (i.e., a scale greater than 1), then the\n log events that are returned for the specified container are merged from all nodes on your\n container service.

\n \n

Container logs are retained for a certain amount of time. For more information, see\n Amazon Lightsail\n endpoints and quotas in the Amazon Web Services General\n Reference.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/ls/api/2016-11-28/container-services/{serviceName}/containers/{containerName}/log", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetContainerLogRequest": { + "type": "structure", + "members": { + "serviceName": { + "target": "com.amazonaws.lightsail#ContainerServiceName", + "traits": { + "smithy.api#documentation": "

The name of the container service for which to get a container log.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "containerName": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The name of the container that is either running or previously ran on the container\n service for which to return a log.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "startTime": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The start of the time interval for which to get log data.

\n

Constraints:

\n \n

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

", + "smithy.api#httpQuery": "startTime" + } + }, + "endTime": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The end of the time interval for which to get log data.

\n

Constraints:

\n \n

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

", + "smithy.api#httpQuery": "endTime" + } + }, + "filterPattern": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The pattern to use to filter the returned log events to a specific term.

\n

The following are a few examples of filter patterns that you can specify:

\n ", + "smithy.api#httpQuery": "filterPattern" + } + }, + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetContainerLog request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

", + "smithy.api#httpQuery": "pageToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetContainerLogResult": { + "type": "structure", + "members": { + "logEvents": { + "target": "com.amazonaws.lightsail#ContainerServiceLogEventList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the log events of a container.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetContainerLog request and\n specify the next page token using the pageToken parameter.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetContainerServiceDeployments": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetContainerServiceDeploymentsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetContainerServiceDeploymentsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the deployments for your Amazon Lightsail container service

\n

A deployment specifies the settings, such as the ports and launch command, of containers\n that are deployed to your container service.

\n

The deployments are ordered by version in ascending order. The newest version is listed at\n the top of the response.

\n \n

A set number of deployments are kept before the oldest one is replaced with the newest\n one. For more information, see Amazon Lightsail\n endpoints and quotas in the Amazon Web Services General\n Reference.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/ls/api/2016-11-28/container-services/{serviceName}/deployments", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetContainerServiceDeploymentsRequest": { + "type": "structure", + "members": { + "serviceName": { + "target": "com.amazonaws.lightsail#ContainerServiceName", + "traits": { + "smithy.api#documentation": "

The name of the container service for which to return deployments.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetContainerServiceDeploymentsResult": { + "type": "structure", + "members": { + "deployments": { + "target": "com.amazonaws.lightsail#ContainerServiceDeploymentList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe deployments for a container service.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetContainerServiceMetricData": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetContainerServiceMetricDataRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetContainerServiceMetricDataResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the data points of a specific metric of your Amazon Lightsail container\n service.

\n

Metrics report the utilization of your resources. Monitor and collect metric data\n regularly to maintain the reliability, availability, and performance of your resources.

", + "smithy.api#http": { + "method": "GET", + "uri": "/ls/api/2016-11-28/container-services/{serviceName}/metrics", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetContainerServiceMetricDataRequest": { + "type": "structure", + "members": { + "serviceName": { + "target": "com.amazonaws.lightsail#ContainerServiceName", + "traits": { + "smithy.api#documentation": "

The name of the container service for which to get metric data.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "metricName": { + "target": "com.amazonaws.lightsail#ContainerServiceMetricName", + "traits": { + "smithy.api#documentation": "

The metric for which you want to return information.

\n

Valid container service metric names are listed below, along with the most useful\n statistics to include in your request, and the published unit value.

\n ", + "smithy.api#httpQuery": "metricName", + "smithy.api#required": {} + } + }, + "startTime": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The start time of the time period.

", + "smithy.api#httpQuery": "startTime", + "smithy.api#required": {} + } + }, + "endTime": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The end time of the time period.

", + "smithy.api#httpQuery": "endTime", + "smithy.api#required": {} + } + }, + "period": { + "target": "com.amazonaws.lightsail#MetricPeriod", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The granularity, in seconds, of the returned data points.

\n

All container service metric data is available in 5-minute (300 seconds)\n granularity.

", + "smithy.api#httpQuery": "period", + "smithy.api#required": {} + } + }, + "statistics": { + "target": "com.amazonaws.lightsail#MetricStatisticList", + "traits": { + "smithy.api#documentation": "

The statistic for the metric.

\n

The following statistics are available:

\n ", + "smithy.api#httpQuery": "statistics", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetContainerServiceMetricDataResult": { + "type": "structure", + "members": { + "metricName": { + "target": "com.amazonaws.lightsail#ContainerServiceMetricName", + "traits": { + "smithy.api#documentation": "

The name of the metric returned.

" + } + }, + "metricData": { + "target": "com.amazonaws.lightsail#MetricDatapointList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the metric data returned.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetContainerServicePowers": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetContainerServicePowersRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetContainerServicePowersResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the list of powers that can be specified for your Amazon Lightsail container\n services.

\n

The power specifies the amount of memory, the number of vCPUs, and the base price of the\n container service.

", + "smithy.api#http": { + "method": "GET", + "uri": "/ls/api/2016-11-28/container-service-powers", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetContainerServicePowersRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetContainerServicePowersResult": { + "type": "structure", + "members": { + "powers": { + "target": "com.amazonaws.lightsail#ContainerServicePowerList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the powers that can be specified for a container\n service.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetContainerServices": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetContainerServicesRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#ContainerServicesListResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about one or more of your Amazon Lightsail container services.

", + "smithy.api#http": { + "method": "GET", + "uri": "/ls/api/2016-11-28/container-services", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetContainerServicesRequest": { + "type": "structure", + "members": { + "serviceName": { + "target": "com.amazonaws.lightsail#ContainerServiceName", + "traits": { + "smithy.api#documentation": "

The name of the container service for which to return information.

\n

When omitted, the response includes all of your container services in the Amazon Web Services Region where the request is made.

", + "smithy.api#httpQuery": "serviceName" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetCostEstimate": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetCostEstimateRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetCostEstimateResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about the cost estimate for a specified resource. A cost estimate will not generate for a resource that has been deleted.

", + "smithy.api#http": { + "method": "POST", + "uri": "/budgettracker/getCostEstimate", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetCostEstimateRequest": { + "type": "structure", + "members": { + "resourceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The resource name.

", + "smithy.api#required": {} + } + }, + "startTime": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The cost estimate start time.

\n

Constraints:

\n \n

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

", + "smithy.api#required": {} + } + }, + "endTime": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The cost estimate end time.

\n

Constraints:

\n \n

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetCostEstimateResult": { + "type": "structure", + "members": { + "resourcesBudgetEstimate": { + "target": "com.amazonaws.lightsail#ResourcesBudgetEstimate", + "traits": { + "smithy.api#documentation": "

Returns the estimate's forecasted cost or usage.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetDisk": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetDiskRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetDiskResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a specific block storage disk.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetDisk", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetDiskRequest": { + "type": "structure", + "members": { + "diskName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the disk (e.g., my-disk).

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetDiskResult": { + "type": "structure", + "members": { + "disk": { + "target": "com.amazonaws.lightsail#Disk", + "traits": { + "smithy.api#documentation": "

An object containing information about the disk.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetDiskSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetDiskSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetDiskSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a specific block storage disk snapshot.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetDiskSnapshot", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetDiskSnapshotRequest": { + "type": "structure", + "members": { + "diskSnapshotName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the disk snapshot (e.g., my-disk-snapshot).

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetDiskSnapshotResult": { + "type": "structure", + "members": { + "diskSnapshot": { + "target": "com.amazonaws.lightsail#DiskSnapshot", + "traits": { + "smithy.api#documentation": "

An object containing information about the disk snapshot.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetDiskSnapshots": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetDiskSnapshotsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetDiskSnapshotsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about all block storage disk snapshots in your AWS account and\n region.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetDiskSnapshots", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetDiskSnapshotsRequest": { + "type": "structure", + "members": { + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetDiskSnapshots request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetDiskSnapshotsResult": { + "type": "structure", + "members": { + "diskSnapshots": { + "target": "com.amazonaws.lightsail#DiskSnapshotList", + "traits": { + "smithy.api#documentation": "

An array of objects containing information about all block storage disk snapshots.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetDiskSnapshots request and\n specify the next page token using the pageToken parameter.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetDisks": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetDisksRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetDisksResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about all block storage disks in your AWS account and region.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetDisks", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetDisksRequest": { + "type": "structure", + "members": { + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetDisks request. If your results are\n paginated, the response will return a next page token that you can specify as the page token\n in a subsequent request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetDisksResult": { + "type": "structure", + "members": { + "disks": { + "target": "com.amazonaws.lightsail#DiskList", + "traits": { + "smithy.api#documentation": "

An array of objects containing information about all block storage disks.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetDisks request and specify\n the next page token using the pageToken parameter.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetDistributionBundles": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetDistributionBundlesRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetDistributionBundlesResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the bundles that can be applied to your Amazon Lightsail content delivery network\n (CDN) distributions.

\n

A distribution bundle specifies the monthly network transfer quota and monthly cost of\n your distribution.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetDistributionBundles", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetDistributionBundlesRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetDistributionBundlesResult": { + "type": "structure", + "members": { + "bundles": { + "target": "com.amazonaws.lightsail#DistributionBundleList", + "traits": { + "smithy.api#documentation": "

An object that describes a distribution bundle.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetDistributionLatestCacheReset": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetDistributionLatestCacheResetRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetDistributionLatestCacheResetResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail\n content delivery network (CDN) distribution.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetDistributionLatestCacheReset", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetDistributionLatestCacheResetRequest": { + "type": "structure", + "members": { + "distributionName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the distribution for which to return the timestamp of the last cache\n reset.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

\n

When omitted, the response includes the latest cache reset timestamp of all your\n distributions.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetDistributionLatestCacheResetResult": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The status of the last cache reset.

" + } + }, + "createTime": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp of the last cache reset (e.g., 1479734909.17) in Unix time\n format.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetDistributionMetricData": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetDistributionMetricDataRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetDistributionMetricDataResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the data points of a specific metric for an Amazon Lightsail content delivery\n network (CDN) distribution.

\n

Metrics report the utilization of your resources, and the error counts generated by them.\n Monitor and collect metric data regularly to maintain the reliability, availability, and\n performance of your resources.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetDistributionMetricData", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetDistributionMetricDataRequest": { + "type": "structure", + "members": { + "distributionName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the distribution for which to get metric data.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

", + "smithy.api#required": {} + } + }, + "metricName": { + "target": "com.amazonaws.lightsail#DistributionMetricName", + "traits": { + "smithy.api#documentation": "

The metric for which you want to return information.

\n

Valid distribution metric names are listed below, along with the most useful\n statistics to include in your request, and the published unit\n value.

\n ", + "smithy.api#required": {} + } + }, + "startTime": { + "target": "com.amazonaws.lightsail#timestamp", + "traits": { + "smithy.api#documentation": "

The start of the time interval for which to get metric data.

\n

Constraints:

\n \n

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

", + "smithy.api#required": {} + } + }, + "endTime": { + "target": "com.amazonaws.lightsail#timestamp", + "traits": { + "smithy.api#documentation": "

The end of the time interval for which to get metric data.

\n

Constraints:

\n \n

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

", + "smithy.api#required": {} + } + }, + "period": { + "target": "com.amazonaws.lightsail#MetricPeriod", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The granularity, in seconds, for the metric data points that will be returned.

", + "smithy.api#required": {} + } + }, + "unit": { + "target": "com.amazonaws.lightsail#MetricUnit", + "traits": { + "smithy.api#documentation": "

The unit for the metric data request.

\n

Valid units depend on the metric data being requested. For the valid units with each\n available metric, see the metricName parameter.

", + "smithy.api#required": {} + } + }, + "statistics": { + "target": "com.amazonaws.lightsail#MetricStatisticList", + "traits": { + "smithy.api#documentation": "

The statistic for the metric.

\n

The following statistics are available:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetDistributionMetricDataResult": { + "type": "structure", + "members": { + "metricName": { + "target": "com.amazonaws.lightsail#DistributionMetricName", + "traits": { + "smithy.api#documentation": "

The name of the metric returned.

" + } + }, + "metricData": { + "target": "com.amazonaws.lightsail#MetricDatapointList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the metric data returned.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetDistributions": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetDistributionsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetDistributionsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about one or more of your Amazon Lightsail content delivery network\n (CDN) distributions.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetDistributions", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetDistributionsRequest": { + "type": "structure", + "members": { + "distributionName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the distribution for which to return information.

\n

When omitted, the response includes all of your distributions in the Amazon Web Services\n Region where the request is made.

" + } + }, + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetDistributions request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetDistributionsResult": { + "type": "structure", + "members": { + "distributions": { + "target": "com.amazonaws.lightsail#DistributionList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe your distributions.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetDistributions request and\n specify the next page token using the pageToken parameter.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetDomainRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetDomainResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a specific domain recordset.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetDomain", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetDomainRequest": { + "type": "structure", + "members": { + "domainName": { + "target": "com.amazonaws.lightsail#DomainName", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetDomainResult": { + "type": "structure", + "members": { + "domain": { + "target": "com.amazonaws.lightsail#Domain", + "traits": { + "smithy.api#documentation": "

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

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetDomains": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetDomainsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetDomainsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetDomains", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetDomainsRequest": { + "type": "structure", + "members": { + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetDomains request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetDomainsResult": { + "type": "structure", + "members": { + "domains": { + "target": "com.amazonaws.lightsail#DomainList", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetDomains request and\n specify the next page token using the pageToken parameter.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetExportSnapshotRecords": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetExportSnapshotRecordsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetExportSnapshotRecordsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns all export snapshot records created as a result of the export\n snapshot operation.

\n

An export snapshot record can be used to create a new Amazon EC2 instance and its related\n resources with the CreateCloudFormationStack\n action.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetExportSnapshotRecords", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetExportSnapshotRecordsRequest": { + "type": "structure", + "members": { + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetExportSnapshotRecords request. If\n your results are paginated, the response will return a next page token that you can specify as\n the page token in a subsequent request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetExportSnapshotRecordsResult": { + "type": "structure", + "members": { + "exportSnapshotRecords": { + "target": "com.amazonaws.lightsail#ExportSnapshotRecordList", + "traits": { + "smithy.api#documentation": "

A list of objects describing the export snapshot records.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetExportSnapshotRecords\n request and specify the next page token using the pageToken parameter.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetInstanceRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetInstanceResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetInstance", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetInstanceAccessDetails": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetInstanceAccessDetailsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetInstanceAccessDetailsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

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

\n

The get instance access details operation supports tag-based access control\n via resource tags applied to the resource identified by instance name. For more\n information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetInstanceAccessDetails", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetInstanceAccessDetailsRequest": { + "type": "structure", + "members": { + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the instance to access.

", + "smithy.api#required": {} + } + }, + "protocol": { + "target": "com.amazonaws.lightsail#InstanceAccessProtocol", + "traits": { + "smithy.api#documentation": "

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

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetInstanceAccessDetailsResult": { + "type": "structure", + "members": { + "accessDetails": { + "target": "com.amazonaws.lightsail#InstanceAccessDetails", + "traits": { + "smithy.api#documentation": "

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

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetInstanceMetricData": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetInstanceMetricDataRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetInstanceMetricDataResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

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

\n

Metrics report the utilization of your resources, and the error counts generated by them.\n Monitor and collect metric data regularly to maintain the reliability, availability, and\n performance of your resources.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetInstanceMetricData", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetInstanceMetricDataRequest": { + "type": "structure", + "members": { + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + }, + "metricName": { + "target": "com.amazonaws.lightsail#InstanceMetricName", + "traits": { + "smithy.api#documentation": "

The metric for which you want to return information.

\n

Valid instance metric names are listed below, along with the most useful\n statistics to include in your request, and the published unit\n value.

\n ", + "smithy.api#required": {} + } + }, + "period": { + "target": "com.amazonaws.lightsail#MetricPeriod", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The granularity, in seconds, of the returned data points.

\n

The StatusCheckFailed, StatusCheckFailed_Instance, and\n StatusCheckFailed_System instance metric data is available in 1-minute (60\n seconds) granularity. All other instance metric data is available in 5-minute (300 seconds)\n granularity.

", + "smithy.api#required": {} + } + }, + "startTime": { + "target": "com.amazonaws.lightsail#timestamp", + "traits": { + "smithy.api#documentation": "

The start time of the time period.

", + "smithy.api#required": {} + } + }, + "endTime": { + "target": "com.amazonaws.lightsail#timestamp", + "traits": { + "smithy.api#documentation": "

The end time of the time period.

", + "smithy.api#required": {} + } + }, + "unit": { + "target": "com.amazonaws.lightsail#MetricUnit", + "traits": { + "smithy.api#documentation": "

The unit for the metric data request. Valid units depend on the metric data being\n requested. For the valid units to specify with each available metric, see the\n metricName parameter.

", + "smithy.api#required": {} + } + }, + "statistics": { + "target": "com.amazonaws.lightsail#MetricStatisticList", + "traits": { + "smithy.api#documentation": "

The statistic for the metric.

\n

The following statistics are available:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetInstanceMetricDataResult": { + "type": "structure", + "members": { + "metricName": { + "target": "com.amazonaws.lightsail#InstanceMetricName", + "traits": { + "smithy.api#documentation": "

The name of the metric returned.

" + } + }, + "metricData": { + "target": "com.amazonaws.lightsail#MetricDatapointList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the metric data returned.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetInstancePortStates": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetInstancePortStatesRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetInstancePortStatesResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the firewall port states for a specific Amazon Lightsail instance, the IP addresses\n allowed to connect to the instance through the ports, and the protocol.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetInstancePortStates", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetInstancePortStatesRequest": { + "type": "structure", + "members": { + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the instance for which to return firewall port states.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetInstancePortStatesResult": { + "type": "structure", + "members": { + "portStates": { + "target": "com.amazonaws.lightsail#InstancePortStateList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the firewall port states for the specified\n instance.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetInstanceRequest": { + "type": "structure", + "members": { + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the instance.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetInstanceResult": { + "type": "structure", + "members": { + "instance": { + "target": "com.amazonaws.lightsail#Instance", + "traits": { + "smithy.api#documentation": "

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

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetInstanceSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetInstanceSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetInstanceSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a specific instance snapshot.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetInstanceSnapshot", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetInstanceSnapshotRequest": { + "type": "structure", + "members": { + "instanceSnapshotName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetInstanceSnapshotResult": { + "type": "structure", + "members": { + "instanceSnapshot": { + "target": "com.amazonaws.lightsail#InstanceSnapshot", + "traits": { + "smithy.api#documentation": "

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

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetInstanceSnapshots": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetInstanceSnapshotsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetInstanceSnapshotsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns all instance snapshots for the user's account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetInstanceSnapshots", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetInstanceSnapshotsRequest": { + "type": "structure", + "members": { + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetInstanceSnapshots request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetInstanceSnapshotsResult": { + "type": "structure", + "members": { + "instanceSnapshots": { + "target": "com.amazonaws.lightsail#InstanceSnapshotList", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetInstanceSnapshots request\n and specify the next page token using the pageToken parameter.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetInstanceState": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetInstanceStateRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetInstanceStateResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetInstanceState", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetInstanceStateRequest": { + "type": "structure", + "members": { + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the instance to get state information about.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetInstanceStateResult": { + "type": "structure", + "members": { + "state": { + "target": "com.amazonaws.lightsail#InstanceState", + "traits": { + "smithy.api#documentation": "

The state of the instance.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetInstancesRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetInstancesResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetInstances", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetInstancesRequest": { + "type": "structure", + "members": { + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetInstances request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetInstancesResult": { + "type": "structure", + "members": { + "instances": { + "target": "com.amazonaws.lightsail#InstanceList", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetInstances request and\n specify the next page token using the pageToken parameter.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetKeyPair": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetKeyPairRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetKeyPairResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a specific key pair.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetKeyPair", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetKeyPairRequest": { + "type": "structure", + "members": { + "keyPairName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetKeyPairResult": { + "type": "structure", + "members": { + "keyPair": { + "target": "com.amazonaws.lightsail#KeyPair", + "traits": { + "smithy.api#documentation": "

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

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetKeyPairs": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetKeyPairsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetKeyPairsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetKeyPairs", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetKeyPairsRequest": { + "type": "structure", + "members": { + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetKeyPairs request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

" + } + }, + "includeDefaultKeyPair": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether to include the default key pair in the response of\n your request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetKeyPairsResult": { + "type": "structure", + "members": { + "keyPairs": { + "target": "com.amazonaws.lightsail#KeyPairList", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetKeyPairs request and\n specify the next page token using the pageToken parameter.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetLoadBalancer": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetLoadBalancerRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetLoadBalancerResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about the specified Lightsail load balancer.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetLoadBalancer", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetLoadBalancerMetricData": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetLoadBalancerMetricDataRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetLoadBalancerMetricDataResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about health metrics for your Lightsail load balancer.

\n

Metrics report the utilization of your resources, and the error counts generated by them.\n Monitor and collect metric data regularly to maintain the reliability, availability, and\n performance of your resources.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetLoadBalancerMetricData", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetLoadBalancerMetricDataRequest": { + "type": "structure", + "members": { + "loadBalancerName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the load balancer.

", + "smithy.api#required": {} + } + }, + "metricName": { + "target": "com.amazonaws.lightsail#LoadBalancerMetricName", + "traits": { + "smithy.api#documentation": "

The metric for which you want to return information.

\n

Valid load balancer metric names are listed below, along with the most useful\n statistics to include in your request, and the published unit\n value.

\n ", + "smithy.api#required": {} + } + }, + "period": { + "target": "com.amazonaws.lightsail#MetricPeriod", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The granularity, in seconds, of the returned data points.

", + "smithy.api#required": {} + } + }, + "startTime": { + "target": "com.amazonaws.lightsail#timestamp", + "traits": { + "smithy.api#documentation": "

The start time of the period.

", + "smithy.api#required": {} + } + }, + "endTime": { + "target": "com.amazonaws.lightsail#timestamp", + "traits": { + "smithy.api#documentation": "

The end time of the period.

", + "smithy.api#required": {} + } + }, + "unit": { + "target": "com.amazonaws.lightsail#MetricUnit", + "traits": { + "smithy.api#documentation": "

The unit for the metric data request. Valid units depend on the metric data being\n requested. For the valid units with each available metric, see the metricName\n parameter.

", + "smithy.api#required": {} + } + }, + "statistics": { + "target": "com.amazonaws.lightsail#MetricStatisticList", + "traits": { + "smithy.api#documentation": "

The statistic for the metric.

\n

The following statistics are available:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetLoadBalancerMetricDataResult": { + "type": "structure", + "members": { + "metricName": { + "target": "com.amazonaws.lightsail#LoadBalancerMetricName", + "traits": { + "smithy.api#documentation": "

The name of the metric returned.

" + } + }, + "metricData": { + "target": "com.amazonaws.lightsail#MetricDatapointList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the metric data returned.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetLoadBalancerRequest": { + "type": "structure", + "members": { + "loadBalancerName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the load balancer.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetLoadBalancerResult": { + "type": "structure", + "members": { + "loadBalancer": { + "target": "com.amazonaws.lightsail#LoadBalancer", + "traits": { + "smithy.api#documentation": "

An object containing information about your load balancer.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetLoadBalancerTlsCertificates": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetLoadBalancerTlsCertificatesRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetLoadBalancerTlsCertificatesResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about the TLS certificates that are associated with the specified\n Lightsail load balancer.

\n

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

\n

You can have a maximum of 2 certificates associated with a Lightsail load balancer. One\n is active and the other is inactive.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetLoadBalancerTlsCertificates", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetLoadBalancerTlsCertificatesRequest": { + "type": "structure", + "members": { + "loadBalancerName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the load balancer you associated with your SSL/TLS certificate.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetLoadBalancerTlsCertificatesResult": { + "type": "structure", + "members": { + "tlsCertificates": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateList", + "traits": { + "smithy.api#documentation": "

An array of LoadBalancerTlsCertificate objects describing your SSL/TLS\n certificates.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetLoadBalancerTlsPolicies": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetLoadBalancerTlsPoliciesRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetLoadBalancerTlsPoliciesResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of TLS security policies that you can apply to Lightsail load\n balancers.

\n

For more information about load balancer TLS security policies, see Configuring TLS security policies on your Amazon Lightsail load\n balancers in the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetLoadBalancerTlsPolicies", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetLoadBalancerTlsPoliciesRequest": { + "type": "structure", + "members": { + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetLoadBalancerTlsPolicies request.\n If your results are paginated, the response will return a next page token that you can specify\n as the page token in a subsequent request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetLoadBalancerTlsPoliciesResult": { + "type": "structure", + "members": { + "tlsPolicies": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsPolicyList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the TLS security policies that are available.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetLoadBalancerTlsPolicies\n request and specify the next page token using the pageToken parameter.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetLoadBalancers": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetLoadBalancersRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetLoadBalancersResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about all load balancers in an account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetLoadBalancers", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetLoadBalancersRequest": { + "type": "structure", + "members": { + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetLoadBalancers request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetLoadBalancersResult": { + "type": "structure", + "members": { + "loadBalancers": { + "target": "com.amazonaws.lightsail#LoadBalancerList", + "traits": { + "smithy.api#documentation": "

An array of LoadBalancer objects describing your load balancers.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetLoadBalancers request and\n specify the next page token using the pageToken parameter.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetOperation": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetOperationRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetOperationResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetOperation", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetOperationRequest": { + "type": "structure", + "members": { + "operationId": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A GUID used to identify the operation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetOperationResult": { + "type": "structure", + "members": { + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetOperations": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetOperationsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetOperationsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about all operations.

\n

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

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetOperations", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetOperationsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetOperationsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetOperationsForResourceResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetOperationsForResource", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetOperationsForResourceRequest": { + "type": "structure", + "members": { + "resourceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + }, + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetOperationsForResource request. If\n your results are paginated, the response will return a next page token that you can specify as\n the page token in a subsequent request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetOperationsForResourceResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + }, + "nextPageCount": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

(Deprecated) Returns the number of pages of results that remain.

\n \n

In releases prior to June 12, 2017, this parameter returned null by the\n API. It is now deprecated, and the API returns the next page token parameter\n instead.

\n " + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetOperationsForResource\n request and specify the next page token using the pageToken parameter.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetOperationsRequest": { + "type": "structure", + "members": { + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetOperations request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetOperationsResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetOperations request and\n specify the next page token using the pageToken parameter.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetRegions": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetRegionsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetRegionsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of all valid regions for Amazon Lightsail. Use the include\n availability zones parameter to also return the Availability Zones in a\n region.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetRegions", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetRegionsRequest": { + "type": "structure", + "members": { + "includeAvailabilityZones": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "includeRelationalDatabaseAvailabilityZones": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether to also include Availability Zones for databases in\n your get regions request. Availability Zones are indicated with a letter (e.g.,\n us-east-2a).

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetRegionsResult": { + "type": "structure", + "members": { + "regions": { + "target": "com.amazonaws.lightsail#RegionList", + "traits": { + "smithy.api#documentation": "

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

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetRelationalDatabase": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a specific database in Amazon Lightsail.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetRelationalDatabase", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseBlueprints": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseBlueprintsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseBlueprintsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of available database blueprints in Amazon Lightsail. A blueprint describes\n the major engine version of a database.

\n

You can use a blueprint ID to create a new database that runs a specific database\n engine.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetRelationalDatabaseBlueprints", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseBlueprintsRequest": { + "type": "structure", + "members": { + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabaseBlueprints\n request. If your results are paginated, the response will return a next page token that you\n can specify as the page token in a subsequent request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseBlueprintsResult": { + "type": "structure", + "members": { + "blueprints": { + "target": "com.amazonaws.lightsail#RelationalDatabaseBlueprintList", + "traits": { + "smithy.api#documentation": "

An object describing the result of your get relational database blueprints request.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another\n GetRelationalDatabaseBlueprints request and specify the next page token using\n the pageToken parameter.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseBundles": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseBundlesRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseBundlesResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the list of bundles that are available in Amazon Lightsail. A bundle describes the\n performance specifications for a database.

\n

You can use a bundle ID to create a new database with explicit performance\n specifications.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetRelationalDatabaseBundles", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseBundlesRequest": { + "type": "structure", + "members": { + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabaseBundles request.\n If your results are paginated, the response will return a next page token that you can specify\n as the page token in a subsequent request.

" + } + }, + "includeInactive": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether to include inactive (unavailable) bundles in the\n response of your request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseBundlesResult": { + "type": "structure", + "members": { + "bundles": { + "target": "com.amazonaws.lightsail#RelationalDatabaseBundleList", + "traits": { + "smithy.api#documentation": "

An object describing the result of your get relational database bundles request.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetRelationalDatabaseBundles\n request and specify the next page token using the pageToken parameter.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseEvents": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseEventsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseEventsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of events for a specific database in Amazon Lightsail.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetRelationalDatabaseEvents", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseEventsRequest": { + "type": "structure", + "members": { + "relationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the database from which to get events.

", + "smithy.api#required": {} + } + }, + "durationInMinutes": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The number of minutes in the past from which to retrieve events. For example, to get all\n events from the past 2 hours, enter 120.

\n

Default: 60\n

\n

The minimum is 1 and the maximum is 14 days (20160 minutes).

" + } + }, + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabaseEvents request.\n If your results are paginated, the response will return a next page token that you can specify\n as the page token in a subsequent request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseEventsResult": { + "type": "structure", + "members": { + "relationalDatabaseEvents": { + "target": "com.amazonaws.lightsail#RelationalDatabaseEventList", + "traits": { + "smithy.api#documentation": "

An object describing the result of your get relational database events request.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetRelationalDatabaseEvents\n request and specify the next page token using the pageToken parameter.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseLogEvents": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseLogEventsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseLogEventsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of log events for a database in Amazon Lightsail.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetRelationalDatabaseLogEvents", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseLogEventsRequest": { + "type": "structure", + "members": { + "relationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of your database for which to get log events.

", + "smithy.api#required": {} + } + }, + "logStreamName": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The name of the log stream.

\n

Use the get relational database log streams operation to get a list of\n available log streams.

", + "smithy.api#required": {} + } + }, + "startTime": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The start of the time interval from which to get log events.

\n

Constraints:

\n " + } + }, + "endTime": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The end of the time interval from which to get log events.

\n

Constraints:

\n " + } + }, + "startFromHead": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

Parameter to specify if the log should start from head or tail. If true is\n specified, the log event starts from the head of the log. If false is specified,\n the log event starts from the tail of the log.

\n \n

For PostgreSQL, the default value of false is the only option\n available.

\n " + } + }, + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next or previous page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabaseLogEvents\n request. If your results are paginated, the response will return a next forward token and/or\n next backward token that you can specify as the page token in a subsequent request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseLogEventsResult": { + "type": "structure", + "members": { + "resourceLogEvents": { + "target": "com.amazonaws.lightsail#LogEventList", + "traits": { + "smithy.api#documentation": "

An object describing the result of your get relational database log events request.

" + } + }, + "nextBackwardToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

A token used for advancing to the previous page of results from your get relational\n database log events request.

" + } + }, + "nextForwardToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

A token used for advancing to the next page of results from your get relational database\n log events request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseLogStreams": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseLogStreamsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseLogStreamsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of available log streams for a specific database in Amazon Lightsail.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetRelationalDatabaseLogStreams", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseLogStreamsRequest": { + "type": "structure", + "members": { + "relationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of your database for which to get log streams.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseLogStreamsResult": { + "type": "structure", + "members": { + "logStreams": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

An object describing the result of your get relational database log streams\n request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseMasterUserPassword": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseMasterUserPasswordRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseMasterUserPasswordResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the current, previous, or pending versions of the master user password for a\n Lightsail database.

\n

The GetRelationalDatabaseMasterUserPassword operation supports tag-based\n access control via resource tags applied to the resource identified by\n relationalDatabaseName.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetRelationalDatabaseMasterUserPassword", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseMasterUserPasswordRequest": { + "type": "structure", + "members": { + "relationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of your database for which to get the master user password.

", + "smithy.api#required": {} + } + }, + "passwordVersion": { + "target": "com.amazonaws.lightsail#RelationalDatabasePasswordVersion", + "traits": { + "smithy.api#documentation": "

The password version to return.

\n

Specifying CURRENT or PREVIOUS returns the current or previous\n passwords respectively. Specifying PENDING returns the newest version of the\n password that will rotate to CURRENT. After the PENDING password\n rotates to CURRENT, the PENDING password is no longer\n available.

\n

Default: CURRENT\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseMasterUserPasswordResult": { + "type": "structure", + "members": { + "masterUserPassword": { + "target": "com.amazonaws.lightsail#SensitiveString", + "traits": { + "smithy.api#documentation": "

The master user password for the password version specified.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the specified version of the master user password was created.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseMetricData": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseMetricDataRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseMetricDataResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the data points of the specified metric for a database in Amazon Lightsail.

\n

Metrics report the utilization of your resources, and the error counts generated by them.\n Monitor and collect metric data regularly to maintain the reliability, availability, and\n performance of your resources.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetRelationalDatabaseMetricData", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseMetricDataRequest": { + "type": "structure", + "members": { + "relationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of your database from which to get metric data.

", + "smithy.api#required": {} + } + }, + "metricName": { + "target": "com.amazonaws.lightsail#RelationalDatabaseMetricName", + "traits": { + "smithy.api#documentation": "

The metric for which you want to return information.

\n

Valid relational database metric names are listed below, along with the most useful\n statistics to include in your request, and the published unit\n value. All relational database metric data is available in 1-minute (60 seconds)\n granularity.

\n ", + "smithy.api#required": {} + } + }, + "period": { + "target": "com.amazonaws.lightsail#MetricPeriod", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The granularity, in seconds, of the returned data points.

\n

All relational database metric data is available in 1-minute (60 seconds)\n granularity.

", + "smithy.api#required": {} + } + }, + "startTime": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The start of the time interval from which to get metric data.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + }, + "endTime": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The end of the time interval from which to get metric data.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + }, + "unit": { + "target": "com.amazonaws.lightsail#MetricUnit", + "traits": { + "smithy.api#documentation": "

The unit for the metric data request. Valid units depend on the metric data being\n requested. For the valid units with each available metric, see the metricName\n parameter.

", + "smithy.api#required": {} + } + }, + "statistics": { + "target": "com.amazonaws.lightsail#MetricStatisticList", + "traits": { + "smithy.api#documentation": "

The statistic for the metric.

\n

The following statistics are available:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseMetricDataResult": { + "type": "structure", + "members": { + "metricName": { + "target": "com.amazonaws.lightsail#RelationalDatabaseMetricName", + "traits": { + "smithy.api#documentation": "

The name of the metric returned.

" + } + }, + "metricData": { + "target": "com.amazonaws.lightsail#MetricDatapointList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the metric data returned.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseParameters": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseParametersRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseParametersResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns all of the runtime parameters offered by the underlying database software, or\n engine, for a specific database in Amazon Lightsail.

\n

In addition to the parameter names and values, this operation returns other information\n about each parameter. This information includes whether changes require a reboot, whether the\n parameter is modifiable, the allowed values, and the data types.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetRelationalDatabaseParameters", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseParametersRequest": { + "type": "structure", + "members": { + "relationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of your database for which to get parameters.

", + "smithy.api#required": {} + } + }, + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabaseParameters\n request. If your results are paginated, the response will return a next page token that you\n can specify as the page token in a subsequent request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseParametersResult": { + "type": "structure", + "members": { + "parameters": { + "target": "com.amazonaws.lightsail#RelationalDatabaseParameterList", + "traits": { + "smithy.api#documentation": "

An object describing the result of your get relational database parameters request.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another\n GetRelationalDatabaseParameters request and specify the next page token using\n the pageToken parameter.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseRequest": { + "type": "structure", + "members": { + "relationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the database that you are looking up.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseResult": { + "type": "structure", + "members": { + "relationalDatabase": { + "target": "com.amazonaws.lightsail#RelationalDatabase", + "traits": { + "smithy.api#documentation": "

An object describing the specified database.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a specific database snapshot in Amazon Lightsail.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetRelationalDatabaseSnapshot", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotRequest": { + "type": "structure", + "members": { + "relationalDatabaseSnapshotName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the database snapshot for which to get information.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotResult": { + "type": "structure", + "members": { + "relationalDatabaseSnapshot": { + "target": "com.amazonaws.lightsail#RelationalDatabaseSnapshot", + "traits": { + "smithy.api#documentation": "

An object describing the specified database snapshot.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseSnapshots": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about all of your database snapshots in Amazon Lightsail.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetRelationalDatabaseSnapshots", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotsRequest": { + "type": "structure", + "members": { + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabaseSnapshots\n request. If your results are paginated, the response will return a next page token that you\n can specify as the page token in a subsequent request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotsResult": { + "type": "structure", + "members": { + "relationalDatabaseSnapshots": { + "target": "com.amazonaws.lightsail#RelationalDatabaseSnapshotList", + "traits": { + "smithy.api#documentation": "

An object describing the result of your get relational database snapshots request.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another\n GetRelationalDatabaseSnapshots request and specify the next page token using\n the pageToken parameter.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetRelationalDatabases": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetRelationalDatabasesRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetRelationalDatabasesResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about all of your databases in Amazon Lightsail.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetRelationalDatabases", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabasesRequest": { + "type": "structure", + "members": { + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabases request. If\n your results are paginated, the response will return a next page token that you can specify as\n the page token in a subsequent request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetRelationalDatabasesResult": { + "type": "structure", + "members": { + "relationalDatabases": { + "target": "com.amazonaws.lightsail#RelationalDatabaseList", + "traits": { + "smithy.api#documentation": "

An object describing the result of your get relational databases request.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetRelationalDatabases\n request and specify the next page token using the pageToken parameter.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetStaticIp": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetStaticIpRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetStaticIpResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about an Amazon Lightsail static IP.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetStaticIp", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetStaticIpRequest": { + "type": "structure", + "members": { + "staticIpName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the static IP in Lightsail.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetStaticIpResult": { + "type": "structure", + "members": { + "staticIp": { + "target": "com.amazonaws.lightsail#StaticIp", + "traits": { + "smithy.api#documentation": "

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

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#GetStaticIps": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetStaticIpsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetStaticIpsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetStaticIps", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetStaticIpsRequest": { + "type": "structure", + "members": { + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetStaticIps request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#GetStaticIpsResult": { + "type": "structure", + "members": { + "staticIps": { + "target": "com.amazonaws.lightsail#StaticIpList", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetStaticIps request and\n specify the next page token using the pageToken parameter.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#HeaderEnum": { + "type": "enum", + "members": { + "accept": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Accept" + } + }, + "acceptCharset": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Accept-Charset" + } + }, + "acceptDatetime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Accept-Datetime" + } + }, + "acceptEncoding": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Accept-Encoding" + } + }, + "acceptLanguage": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Accept-Language" + } + }, + "authorization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Authorization" + } + }, + "cloudFrontForwardedProto": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CloudFront-Forwarded-Proto" + } + }, + "cloudFrontIsDesktopViewer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CloudFront-Is-Desktop-Viewer" + } + }, + "cloudFrontIsMobileViewer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CloudFront-Is-Mobile-Viewer" + } + }, + "cloudFrontIsSmartTVViewer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CloudFront-Is-SmartTV-Viewer" + } + }, + "cloudFrontIsTabletViewer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CloudFront-Is-Tablet-Viewer" + } + }, + "cloudFrontViewerCountry": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CloudFront-Viewer-Country" + } + }, + "host": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Host" + } + }, + "origin": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Origin" + } + }, + "referer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Referer" + } + } + } + }, + "com.amazonaws.lightsail#HeaderForwardList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#HeaderEnum" + } + }, + "com.amazonaws.lightsail#HeaderObject": { + "type": "structure", + "members": { + "option": { + "target": "com.amazonaws.lightsail#ForwardValues", + "traits": { + "smithy.api#documentation": "

The headers that you want your distribution to forward to your origin and base caching\n on.

\n

You can configure your distribution to do one of the following:

\n " + } + }, + "headersAllowList": { + "target": "com.amazonaws.lightsail#HeaderForwardList", + "traits": { + "smithy.api#documentation": "

The specific headers to forward to your distribution's origin.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the request headers that a Lightsail distribution bases caching on.

\n

For the headers that you specify, your distribution caches separate versions of the\n specified content based on the header values in viewer requests. For example, suppose viewer\n requests for logo.jpg contain a custom product header that has a\n value of either acme or apex, and you configure your distribution to\n cache your content based on values in the product header. Your distribution\n forwards the product header to the origin and caches the response from the origin\n once for each header value.\n

" + } + }, + "com.amazonaws.lightsail#HostKeyAttributes": { + "type": "structure", + "members": { + "algorithm": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The SSH host key algorithm or the RDP certificate format.

\n

For SSH host keys, the algorithm may be ssh-rsa,\n ecdsa-sha2-nistp256, ssh-ed25519, etc. For RDP certificates, the\n algorithm is always x509-cert.

" + } + }, + "publicKey": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The public SSH host key or the RDP certificate.

" + } + }, + "witnessedAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The time that the SSH host key or RDP certificate was recorded by Lightsail.

" + } + }, + "fingerprintSHA1": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The SHA-1 fingerprint of the returned SSH host key or RDP certificate.

\n " + } + }, + "fingerprintSHA256": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The SHA-256 fingerprint of the returned SSH host key or RDP certificate.

\n " + } + }, + "notValidBefore": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The returned RDP certificate is valid after this point in time.

\n

This value is listed only for RDP certificates.

" + } + }, + "notValidAfter": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The returned RDP certificate is not valid after this point in time.

\n

This value is listed only for RDP certificates.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the public SSH host keys or the RDP certificate.

" + } + }, + "com.amazonaws.lightsail#HostKeysList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#HostKeyAttributes" + } + }, + "com.amazonaws.lightsail#HttpEndpoint": { + "type": "enum", + "members": { + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + } + } + }, + "com.amazonaws.lightsail#HttpProtocolIpv6": { + "type": "enum", + "members": { + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + } + } + }, + "com.amazonaws.lightsail#HttpTokens": { + "type": "enum", + "members": { + "optional": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "optional" + } + }, + "required": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "required" + } + } + } + }, + "com.amazonaws.lightsail#IAMAccessKeyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 20 + }, + "smithy.api#pattern": "^[A-Z0-9]{20}$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.lightsail#ImportKeyPair": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#ImportKeyPairRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#ImportKeyPairResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Imports a public SSH key from a specific key pair.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/ImportKeyPair", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#ImportKeyPairRequest": { + "type": "structure", + "members": { + "keyPairName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + }, + "publicKeyBase64": { + "target": "com.amazonaws.lightsail#Base64", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#ImportKeyPairResult": { + "type": "structure", + "members": { + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#InUseResourceCount": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.lightsail#IncludeCertificateDetails": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.lightsail#InputOrigin": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the origin resource.

" + } + }, + "regionName": { + "target": "com.amazonaws.lightsail#RegionName", + "traits": { + "smithy.api#documentation": "

The AWS Region name of the origin resource.

" + } + }, + "protocolPolicy": { + "target": "com.amazonaws.lightsail#OriginProtocolPolicyEnum", + "traits": { + "smithy.api#documentation": "

The protocol that your Amazon Lightsail distribution uses when establishing a connection\n with your origin to pull content.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the origin resource of an Amazon Lightsail content delivery network (CDN)\n distribution.

\n

An origin can be a Lightsail instance, bucket, or load balancer. A distribution pulls\n content from an origin, caches it, and serves it to viewers via a worldwide network of edge\n servers.

" + } + }, + "com.amazonaws.lightsail#Instance": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "supportCode": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the instance was created (e.g., 1479734909.17) in Unix\n time format.

" + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

The region name and Availability Zone where the instance is located.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The type of resource (usually Instance).

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" + } + }, + "blueprintId": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "blueprintName": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "bundleId": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "addOns": { + "target": "com.amazonaws.lightsail#AddOnList", + "traits": { + "smithy.api#documentation": "

An array of objects representing the add-ons enabled on the instance.

" + } + }, + "isStaticIp": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "privateIpAddress": { + "target": "com.amazonaws.lightsail#IpAddress", + "traits": { + "smithy.api#documentation": "

The private IP address of the instance.

" + } + }, + "publicIpAddress": { + "target": "com.amazonaws.lightsail#IpAddress", + "traits": { + "smithy.api#documentation": "

The public IP address of the instance.

" + } + }, + "ipv6Addresses": { + "target": "com.amazonaws.lightsail#Ipv6AddressList", + "traits": { + "smithy.api#documentation": "

The IPv6 addresses of the instance.

" + } + }, + "ipAddressType": { + "target": "com.amazonaws.lightsail#IpAddressType", + "traits": { + "smithy.api#documentation": "

The IP address type of the instance.

\n

The possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.

" + } + }, + "hardware": { + "target": "com.amazonaws.lightsail#InstanceHardware", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "networking": { + "target": "com.amazonaws.lightsail#InstanceNetworking", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "state": { + "target": "com.amazonaws.lightsail#InstanceState", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "username": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "sshKeyName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "metadataOptions": { + "target": "com.amazonaws.lightsail#InstanceMetadataOptions", + "traits": { + "smithy.api#documentation": "

The metadata options for the Amazon Lightsail instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an instance (a virtual private server).

" + } + }, + "com.amazonaws.lightsail#InstanceAccessDetails": { + "type": "structure", + "members": { + "certKey": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "expiresAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "ipAddress": { + "target": "com.amazonaws.lightsail#IpAddress", + "traits": { + "smithy.api#documentation": "

The public IP address of the Amazon Lightsail instance.

" + } + }, + "password": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

For RDP access, the password for your Amazon Lightsail instance. Password will be an empty\n string if the password for your new instance is not ready yet. When you create an instance, it\n can take up to 15 minutes for the instance to be ready.

\n \n

If you create an instance using any key pair other than the default\n (LightsailDefaultKeyPair), password will always be an empty\n string.

\n

If you change the Administrator password on the instance, Lightsail will continue to\n return the original password value. When accessing the instance using RDP, you need to\n manually enter the Administrator password after changing it from the default.

\n " + } + }, + "passwordData": { + "target": "com.amazonaws.lightsail#PasswordData", + "traits": { + "smithy.api#documentation": "

For a Windows Server-based instance, an object with the data you can use to retrieve your\n password. This is only needed if password is empty and the instance is not new\n (and therefore the password is not ready yet). When you create an instance, it can take up to\n 15 minutes for the instance to be ready.

" + } + }, + "privateKey": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "protocol": { + "target": "com.amazonaws.lightsail#InstanceAccessProtocol", + "traits": { + "smithy.api#documentation": "

The protocol for these Amazon Lightsail instance access details.

" + } + }, + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of this Amazon Lightsail instance.

" + } + }, + "username": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "hostKeys": { + "target": "com.amazonaws.lightsail#HostKeysList", + "traits": { + "smithy.api#documentation": "

Describes the public SSH host keys or the RDP certificate.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "com.amazonaws.lightsail#InstanceAccessProtocol": { + "type": "enum", + "members": { + "ssh": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ssh" + } + }, + "rdp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rdp" + } + } + } + }, + "com.amazonaws.lightsail#InstanceEntry": { + "type": "structure", + "members": { + "sourceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the export snapshot record, which contains the exported Lightsail instance\n snapshot that will be used as the source of the new Amazon EC2 instance.

\n

Use the get export snapshot records operation to get a list of export\n snapshot records that you can use to create a CloudFormation stack.

", + "smithy.api#required": {} + } + }, + "instanceType": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The instance type (e.g., t2.micro) to use for the new Amazon EC2 instance.

", + "smithy.api#required": {} + } + }, + "portInfoSource": { + "target": "com.amazonaws.lightsail#PortInfoSourceType", + "traits": { + "smithy.api#documentation": "

The port configuration to use for the new Amazon EC2 instance.

\n

The following configuration options are available:

\n \n \n

If you configured lightsail-connect as a cidrListAliases on\n your instance, or if you chose to allow the Lightsail browser-based SSH or RDP clients to\n connect to your instance, that configuration is not carried over to your new Amazon EC2\n instance.

\n ", + "smithy.api#required": {} + } + }, + "userData": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

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

\n \n

Depending on the machine image you choose, the command to get software on your instance\n varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use\n apt-get, and FreeBSD uses pkg.

\n " + } + }, + "availabilityZone": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The Availability Zone for the new Amazon EC2 instance.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the Amazon Elastic Compute Cloud instance and related resources to be created using the\n create cloud formation stack operation.

" + } + }, + "com.amazonaws.lightsail#InstanceEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#InstanceEntry" + } + }, + "com.amazonaws.lightsail#InstanceHardware": { + "type": "structure", + "members": { + "cpuCount": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The number of vCPUs the instance has.

" + } + }, + "disks": { + "target": "com.amazonaws.lightsail#DiskList", + "traits": { + "smithy.api#documentation": "

The disks attached to the instance.

" + } + }, + "ramSizeInGb": { + "target": "com.amazonaws.lightsail#float", + "traits": { + "smithy.api#documentation": "

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

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the hardware for the instance.

" + } + }, + "com.amazonaws.lightsail#InstanceHealthReason": { + "type": "enum", + "members": { + "LbRegistrationInProgress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Lb.RegistrationInProgress" + } + }, + "LbInitialHealthChecking": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Lb.InitialHealthChecking" + } + }, + "LbInternalError": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Lb.InternalError" + } + }, + "InstanceResponseCodeMismatch": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Instance.ResponseCodeMismatch" + } + }, + "InstanceTimeout": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Instance.Timeout" + } + }, + "InstanceFailedHealthChecks": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Instance.FailedHealthChecks" + } + }, + "InstanceNotRegistered": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Instance.NotRegistered" + } + }, + "InstanceNotInUse": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Instance.NotInUse" + } + }, + "InstanceDeregistrationInProgress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Instance.DeregistrationInProgress" + } + }, + "InstanceInvalidState": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Instance.InvalidState" + } + }, + "InstanceIpUnusable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Instance.IpUnusable" + } + } + } + }, + "com.amazonaws.lightsail#InstanceHealthState": { + "type": "enum", + "members": { + "Initial": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "initial" + } + }, + "Healthy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "healthy" + } + }, + "Unhealthy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unhealthy" + } + }, + "Unused": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unused" + } + }, + "Draining": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "draining" + } + }, + "Unavailable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unavailable" + } + } + } + }, + "com.amazonaws.lightsail#InstanceHealthSummary": { + "type": "structure", + "members": { + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the Lightsail instance for which you are requesting health check\n data.

" + } + }, + "instanceHealth": { + "target": "com.amazonaws.lightsail#InstanceHealthState", + "traits": { + "smithy.api#documentation": "

Describes the overall instance health. Valid values are below.

" + } + }, + "instanceHealthReason": { + "target": "com.amazonaws.lightsail#InstanceHealthReason", + "traits": { + "smithy.api#documentation": "

More information about the instance health. If the instanceHealth is\n healthy, then an instanceHealthReason value is not\n provided.

\n

If \n instanceHealth\n is initial,\n the \n instanceHealthReason\n value can be one of the\n following:

\n \n

If \n instanceHealth\n is unhealthy,\n the \n instanceHealthReason\n value can be one of the\n following:

\n \n

If \n instanceHealth\n is unused,\n the \n instanceHealthReason\n value can be one of the\n following:

\n \n

If \n instanceHealth\n is draining,\n the \n instanceHealthReason\n value can be one of the\n following:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes information about the health of the instance.

" + } + }, + "com.amazonaws.lightsail#InstanceHealthSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#InstanceHealthSummary" + } + }, + "com.amazonaws.lightsail#InstanceList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#Instance" + } + }, + "com.amazonaws.lightsail#InstanceMetadataOptions": { + "type": "structure", + "members": { + "state": { + "target": "com.amazonaws.lightsail#InstanceMetadataState", + "traits": { + "smithy.api#documentation": "

The state of the metadata option changes.

\n

The following states are possible:

\n " + } + }, + "httpTokens": { + "target": "com.amazonaws.lightsail#HttpTokens", + "traits": { + "smithy.api#documentation": "

The state of token usage for your instance metadata requests.

\n

If the state is optional, you can choose whether to retrieve instance\n metadata with a signed token header on your request. If you retrieve the IAM role credentials\n without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role\n credentials by using a valid signed token, the version 2.0 role credentials are\n returned.

\n

If the state is required, you must send a signed token header with all\n instance metadata retrieval requests. In this state, retrieving the IAM role credential always\n returns the version 2.0 credentials. The version 1.0 credentials are not available.

\n \n

Not all instance blueprints in Lightsail support version 2.0 credentials.\n Use the MetadataNoToken instance metric to track the number of calls to the\n instance metadata service that are using version 1.0 credentials. For more information, see\n Viewing instance metrics in Amazon Lightsail in the Amazon Lightsail Developer Guide.

\n " + } + }, + "httpEndpoint": { + "target": "com.amazonaws.lightsail#HttpEndpoint", + "traits": { + "smithy.api#documentation": "

Indicates whether the HTTP metadata endpoint on your instances is enabled or\n disabled.

\n

If the value is disabled, you cannot access your instance metadata.

" + } + }, + "httpPutResponseHopLimit": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. A larger number\n means that the instance metadata requests can travel farther.

" + } + }, + "httpProtocolIpv6": { + "target": "com.amazonaws.lightsail#HttpProtocolIpv6", + "traits": { + "smithy.api#documentation": "

Indicates whether the IPv6 endpoint for the instance metadata service is enabled or\n disabled.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The metadata options for the instance.

" + } + }, + "com.amazonaws.lightsail#InstanceMetadataState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "applied": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "applied" + } + } + } + }, + "com.amazonaws.lightsail#InstanceMetricName": { + "type": "enum", + "members": { + "CPUUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CPUUtilization" + } + }, + "NetworkIn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NetworkIn" + } + }, + "NetworkOut": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NetworkOut" + } + }, + "StatusCheckFailed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StatusCheckFailed" + } + }, + "StatusCheckFailed_Instance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StatusCheckFailed_Instance" + } + }, + "StatusCheckFailed_System": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StatusCheckFailed_System" + } + }, + "BurstCapacityTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BurstCapacityTime" + } + }, + "BurstCapacityPercentage": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BurstCapacityPercentage" + } + }, + "MetadataNoToken": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MetadataNoToken" + } + } + } + }, + "com.amazonaws.lightsail#InstanceNetworking": { + "type": "structure", + "members": { + "monthlyTransfer": { + "target": "com.amazonaws.lightsail#MonthlyTransfer", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "ports": { + "target": "com.amazonaws.lightsail#InstancePortInfoList", + "traits": { + "smithy.api#documentation": "

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

" + } + } + }, + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "com.amazonaws.lightsail#InstancePlatform": { + "type": "enum", + "members": { + "LinuxUnix": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINUX_UNIX" + } + }, + "Windows": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS" + } + } + } + }, + "com.amazonaws.lightsail#InstancePlatformList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#InstancePlatform" + } + }, + "com.amazonaws.lightsail#InstancePortInfo": { + "type": "structure", + "members": { + "fromPort": { + "target": "com.amazonaws.lightsail#Port", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The first port in a range of open ports on an instance.

\n

Allowed ports:

\n " + } + }, + "toPort": { + "target": "com.amazonaws.lightsail#Port", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The last port in a range of open ports on an instance.

\n

Allowed ports:

\n " + } + }, + "protocol": { + "target": "com.amazonaws.lightsail#NetworkProtocol", + "traits": { + "smithy.api#documentation": "

The IP protocol name.

\n

The name can be one of the following:

\n " + } + }, + "accessFrom": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The location from which access is allowed. For example, Anywhere (0.0.0.0/0),\n or Custom if a specific IP address or range of IP addresses is allowed.

" + } + }, + "accessType": { + "target": "com.amazonaws.lightsail#PortAccessType", + "traits": { + "smithy.api#documentation": "

The type of access (Public or Private).

" + } + }, + "commonName": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The common name of the port information.

" + } + }, + "accessDirection": { + "target": "com.amazonaws.lightsail#AccessDirection", + "traits": { + "smithy.api#documentation": "

The access direction (inbound or outbound).

\n \n

Lightsail currently supports only inbound access direction.

\n " + } + }, + "cidrs": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to\n connect to an instance through the ports, and the protocol.

\n \n

The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to\n connect to an instance.

\n \n

For more information about CIDR block notation, see Classless\n Inter-Domain Routing on Wikipedia.

" + } + }, + "ipv6Cidrs": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to\n connect to an instance through the ports, and the protocol. Only devices with an IPv6 address\n can connect to an instance through IPv6; otherwise, IPv4 should be used.

\n \n

The cidrs parameter lists the IPv4 addresses that are allowed to connect to\n an instance.

\n \n

For more information about CIDR block notation, see Classless\n Inter-Domain Routing on Wikipedia.

" + } + }, + "cidrListAliases": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

An alias that defines access for a preconfigured range of IP addresses.

\n

The only alias currently supported is lightsail-connect, which allows IP\n addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your\n instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes information about ports for an Amazon Lightsail instance.

" + } + }, + "com.amazonaws.lightsail#InstancePortInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#InstancePortInfo" + } + }, + "com.amazonaws.lightsail#InstancePortState": { + "type": "structure", + "members": { + "fromPort": { + "target": "com.amazonaws.lightsail#Port", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The first port in a range of open ports on an instance.

\n

Allowed ports:

\n " + } + }, + "toPort": { + "target": "com.amazonaws.lightsail#Port", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The last port in a range of open ports on an instance.

\n

Allowed ports:

\n " + } + }, + "protocol": { + "target": "com.amazonaws.lightsail#NetworkProtocol", + "traits": { + "smithy.api#documentation": "

The IP protocol name.

\n

The name can be one of the following:

\n " + } + }, + "state": { + "target": "com.amazonaws.lightsail#PortState", + "traits": { + "smithy.api#documentation": "

Specifies whether the instance port is open or closed.

\n \n

The port state for Lightsail instances is always open.

\n " + } + }, + "cidrs": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to\n connect to an instance through the ports, and the protocol.

\n \n

The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to\n connect to an instance.

\n \n

For more information about CIDR block notation, see Classless\n Inter-Domain Routing on Wikipedia.

" + } + }, + "ipv6Cidrs": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to\n connect to an instance through the ports, and the protocol. Only devices with an IPv6 address\n can connect to an instance through IPv6; otherwise, IPv4 should be used.

\n \n

The cidrs parameter lists the IPv4 addresses that are allowed to connect to\n an instance.

\n \n

For more information about CIDR block notation, see Classless\n Inter-Domain Routing on Wikipedia.

" + } + }, + "cidrListAliases": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

An alias that defines access for a preconfigured range of IP addresses.

\n

The only alias currently supported is lightsail-connect, which allows IP\n addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your\n instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes open ports on an instance, the IP addresses allowed to connect to the instance\n through the ports, and the protocol.

" + } + }, + "com.amazonaws.lightsail#InstancePortStateList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#InstancePortState" + } + }, + "com.amazonaws.lightsail#InstanceSnapshot": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the snapshot.

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "supportCode": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

The region name and Availability Zone where you created the snapshot.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The type of resource (usually InstanceSnapshot).

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" + } + }, + "state": { + "target": "com.amazonaws.lightsail#InstanceSnapshotState", + "traits": { + "smithy.api#documentation": "

The state the snapshot is in.

" + } + }, + "progress": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The progress of the snapshot.

\n \n

This is populated only for disk snapshots, and is null for instance\n snapshots.

\n " + } + }, + "fromAttachedDisks": { + "target": "com.amazonaws.lightsail#DiskList", + "traits": { + "smithy.api#documentation": "

An array of disk objects containing information about all block storage disks.

" + } + }, + "fromInstanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The instance from which the snapshot was created.

" + } + }, + "fromInstanceArn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "fromBlueprintId": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "fromBundleId": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "isFromAutoSnapshot": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether the snapshot was created from an automatic\n snapshot.

" + } + }, + "sizeInGb": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The size in GB of the SSD.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an instance snapshot.

" + } + }, + "com.amazonaws.lightsail#InstanceSnapshotInfo": { + "type": "structure", + "members": { + "fromBundleId": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The bundle ID from which the source instance was created (e.g.,\n micro_1_0).

" + } + }, + "fromBlueprintId": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The blueprint ID from which the source instance (e.g., os_debian_8_3).

" + } + }, + "fromDiskInfo": { + "target": "com.amazonaws.lightsail#DiskInfoList", + "traits": { + "smithy.api#documentation": "

A list of objects describing the disks that were attached to the source instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an instance snapshot.

" + } + }, + "com.amazonaws.lightsail#InstanceSnapshotList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#InstanceSnapshot" + } + }, + "com.amazonaws.lightsail#InstanceSnapshotState": { + "type": "enum", + "members": { + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "Error": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "error" + } + }, + "Available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + } + } + }, + "com.amazonaws.lightsail#InstanceState": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The status code for the instance.

" + } + }, + "name": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

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

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the virtual private server (or instance) status.

" + } + }, + "com.amazonaws.lightsail#InvalidInputException": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.lightsail#string" + }, + "docs": { + "target": "com.amazonaws.lightsail#string" + }, + "message": { + "target": "com.amazonaws.lightsail#string" + }, + "tip": { + "target": "com.amazonaws.lightsail#string" + } + }, + "traits": { + "smithy.api#documentation": "

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

\n \n

Domain and distribution APIs are only available in the N. Virginia\n (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services\n Region configuration to us-east-1 to create, view, or edit these\n resources.

\n ", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.lightsail#IpAddress": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}$" + } + }, + "com.amazonaws.lightsail#IpAddressType": { + "type": "enum", + "members": { + "DUALSTACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dualstack" + } + }, + "IPV4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv4" + } + } + } + }, + "com.amazonaws.lightsail#Ipv6Address": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([A-F0-9]{1,4}:){7}[A-F0-9]{1,4}$" + } + }, + "com.amazonaws.lightsail#Ipv6AddressList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#Ipv6Address" + } + }, + "com.amazonaws.lightsail#IsVpcPeered": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#IsVpcPeeredRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#IsVpcPeeredResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/IsVpcPeered", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#IsVpcPeeredRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#IsVpcPeeredResult": { + "type": "structure", + "members": { + "isPeered": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

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

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#IsoDate": { + "type": "timestamp" + }, + "com.amazonaws.lightsail#IssuerCA": { + "type": "string" + }, + "com.amazonaws.lightsail#KeyAlgorithm": { + "type": "string" + }, + "com.amazonaws.lightsail#KeyPair": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The friendly name of the SSH key pair.

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "supportCode": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The resource type (usually KeyPair).

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" + } + }, + "fingerprint": { + "target": "com.amazonaws.lightsail#Base64", + "traits": { + "smithy.api#documentation": "

The RSA fingerprint of the key pair.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an SSH key pair.

" + } + }, + "com.amazonaws.lightsail#KeyPairList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#KeyPair" + } + }, + "com.amazonaws.lightsail#LightsailDistribution": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the distribution.

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution.

" + } + }, + "supportCode": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail distribution. This code enables our support team to look up your Lightsail\n information more easily.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the distribution was created.

" + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

An object that describes the location of the distribution, such as the Amazon Web Services\n Region and Availability Zone.

\n \n

Lightsail distributions are global resources that can reference an origin in any\n Amazon Web Services Region, and distribute its content globally. However, all distributions\n are located in the us-east-1 Region.

\n " + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The Lightsail resource type (e.g., Distribution).

" + } + }, + "alternativeDomainNames": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

The alternate domain names of the distribution.

" + } + }, + "status": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The status of the distribution.

" + } + }, + "isEnabled": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the distribution is enabled.

" + } + }, + "domainName": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The domain name of the distribution.

" + } + }, + "bundleId": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The ID of the bundle currently applied to the distribution.

" + } + }, + "certificateName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the SSL/TLS certificate attached to the distribution, if any.

" + } + }, + "origin": { + "target": "com.amazonaws.lightsail#Origin", + "traits": { + "smithy.api#documentation": "

An object that describes the origin resource of the distribution, such as a Lightsail\n instance, bucket, or load balancer.

\n

The distribution pulls, caches, and serves content from the origin.

" + } + }, + "originPublicDNS": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The public DNS of the origin.

" + } + }, + "defaultCacheBehavior": { + "target": "com.amazonaws.lightsail#CacheBehavior", + "traits": { + "smithy.api#documentation": "

An object that describes the default cache behavior of the distribution.

" + } + }, + "cacheBehaviorSettings": { + "target": "com.amazonaws.lightsail#CacheSettings", + "traits": { + "smithy.api#documentation": "

An object that describes the cache behavior settings of the distribution.

" + } + }, + "cacheBehaviors": { + "target": "com.amazonaws.lightsail#CacheBehaviorList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the per-path cache behavior of the distribution.

" + } + }, + "ableToUpdateBundle": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the bundle that is currently applied to your distribution, specified\n using the distributionName parameter, can be changed to another bundle.

\n

Use the UpdateDistributionBundle action to change your distribution's\n bundle.

" + } + }, + "ipAddressType": { + "target": "com.amazonaws.lightsail#IpAddressType", + "traits": { + "smithy.api#documentation": "

The IP address type of the distribution.

\n

The possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an Amazon Lightsail content delivery network (CDN) distribution.

" + } + }, + "com.amazonaws.lightsail#Lightsail_20161128": { + "type": "service", + "version": "2016-11-28", + "operations": [ + { + "target": "com.amazonaws.lightsail#AllocateStaticIp" + }, + { + "target": "com.amazonaws.lightsail#AttachCertificateToDistribution" + }, + { + "target": "com.amazonaws.lightsail#AttachDisk" + }, + { + "target": "com.amazonaws.lightsail#AttachInstancesToLoadBalancer" + }, + { + "target": "com.amazonaws.lightsail#AttachLoadBalancerTlsCertificate" + }, + { + "target": "com.amazonaws.lightsail#AttachStaticIp" + }, + { + "target": "com.amazonaws.lightsail#CloseInstancePublicPorts" + }, + { + "target": "com.amazonaws.lightsail#CopySnapshot" + }, + { + "target": "com.amazonaws.lightsail#CreateBucket" + }, + { + "target": "com.amazonaws.lightsail#CreateBucketAccessKey" + }, + { + "target": "com.amazonaws.lightsail#CreateCertificate" + }, + { + "target": "com.amazonaws.lightsail#CreateCloudFormationStack" + }, + { + "target": "com.amazonaws.lightsail#CreateContactMethod" + }, + { + "target": "com.amazonaws.lightsail#CreateContainerService" + }, + { + "target": "com.amazonaws.lightsail#CreateContainerServiceDeployment" + }, + { + "target": "com.amazonaws.lightsail#CreateContainerServiceRegistryLogin" + }, + { + "target": "com.amazonaws.lightsail#CreateDisk" + }, + { + "target": "com.amazonaws.lightsail#CreateDiskFromSnapshot" + }, + { + "target": "com.amazonaws.lightsail#CreateDiskSnapshot" + }, + { + "target": "com.amazonaws.lightsail#CreateDistribution" + }, + { + "target": "com.amazonaws.lightsail#CreateDomain" + }, + { + "target": "com.amazonaws.lightsail#CreateDomainEntry" + }, + { + "target": "com.amazonaws.lightsail#CreateGUISessionAccessDetails" + }, + { + "target": "com.amazonaws.lightsail#CreateInstances" + }, + { + "target": "com.amazonaws.lightsail#CreateInstancesFromSnapshot" + }, + { + "target": "com.amazonaws.lightsail#CreateInstanceSnapshot" + }, + { + "target": "com.amazonaws.lightsail#CreateKeyPair" + }, + { + "target": "com.amazonaws.lightsail#CreateLoadBalancer" + }, + { + "target": "com.amazonaws.lightsail#CreateLoadBalancerTlsCertificate" + }, + { + "target": "com.amazonaws.lightsail#CreateRelationalDatabase" + }, + { + "target": "com.amazonaws.lightsail#CreateRelationalDatabaseFromSnapshot" + }, + { + "target": "com.amazonaws.lightsail#CreateRelationalDatabaseSnapshot" + }, + { + "target": "com.amazonaws.lightsail#DeleteAlarm" + }, + { + "target": "com.amazonaws.lightsail#DeleteAutoSnapshot" + }, + { + "target": "com.amazonaws.lightsail#DeleteBucket" + }, + { + "target": "com.amazonaws.lightsail#DeleteBucketAccessKey" + }, + { + "target": "com.amazonaws.lightsail#DeleteCertificate" + }, + { + "target": "com.amazonaws.lightsail#DeleteContactMethod" + }, + { + "target": "com.amazonaws.lightsail#DeleteContainerImage" + }, + { + "target": "com.amazonaws.lightsail#DeleteContainerService" + }, + { + "target": "com.amazonaws.lightsail#DeleteDisk" + }, + { + "target": "com.amazonaws.lightsail#DeleteDiskSnapshot" + }, + { + "target": "com.amazonaws.lightsail#DeleteDistribution" + }, + { + "target": "com.amazonaws.lightsail#DeleteDomain" + }, + { + "target": "com.amazonaws.lightsail#DeleteDomainEntry" + }, + { + "target": "com.amazonaws.lightsail#DeleteInstance" + }, + { + "target": "com.amazonaws.lightsail#DeleteInstanceSnapshot" + }, + { + "target": "com.amazonaws.lightsail#DeleteKeyPair" + }, + { + "target": "com.amazonaws.lightsail#DeleteKnownHostKeys" + }, + { + "target": "com.amazonaws.lightsail#DeleteLoadBalancer" + }, + { + "target": "com.amazonaws.lightsail#DeleteLoadBalancerTlsCertificate" + }, + { + "target": "com.amazonaws.lightsail#DeleteRelationalDatabase" + }, + { + "target": "com.amazonaws.lightsail#DeleteRelationalDatabaseSnapshot" + }, + { + "target": "com.amazonaws.lightsail#DetachCertificateFromDistribution" + }, + { + "target": "com.amazonaws.lightsail#DetachDisk" + }, + { + "target": "com.amazonaws.lightsail#DetachInstancesFromLoadBalancer" + }, + { + "target": "com.amazonaws.lightsail#DetachStaticIp" + }, + { + "target": "com.amazonaws.lightsail#DisableAddOn" + }, + { + "target": "com.amazonaws.lightsail#DownloadDefaultKeyPair" + }, + { + "target": "com.amazonaws.lightsail#EnableAddOn" + }, + { + "target": "com.amazonaws.lightsail#ExportSnapshot" + }, + { + "target": "com.amazonaws.lightsail#GetActiveNames" + }, + { + "target": "com.amazonaws.lightsail#GetAlarms" + }, + { + "target": "com.amazonaws.lightsail#GetAutoSnapshots" + }, + { + "target": "com.amazonaws.lightsail#GetBlueprints" + }, + { + "target": "com.amazonaws.lightsail#GetBucketAccessKeys" + }, + { + "target": "com.amazonaws.lightsail#GetBucketBundles" + }, + { + "target": "com.amazonaws.lightsail#GetBucketMetricData" + }, + { + "target": "com.amazonaws.lightsail#GetBuckets" + }, + { + "target": "com.amazonaws.lightsail#GetBundles" + }, + { + "target": "com.amazonaws.lightsail#GetCertificates" + }, + { + "target": "com.amazonaws.lightsail#GetCloudFormationStackRecords" + }, + { + "target": "com.amazonaws.lightsail#GetContactMethods" + }, + { + "target": "com.amazonaws.lightsail#GetContainerAPIMetadata" + }, + { + "target": "com.amazonaws.lightsail#GetContainerImages" + }, + { + "target": "com.amazonaws.lightsail#GetContainerLog" + }, + { + "target": "com.amazonaws.lightsail#GetContainerServiceDeployments" + }, + { + "target": "com.amazonaws.lightsail#GetContainerServiceMetricData" + }, + { + "target": "com.amazonaws.lightsail#GetContainerServicePowers" + }, + { + "target": "com.amazonaws.lightsail#GetContainerServices" + }, + { + "target": "com.amazonaws.lightsail#GetCostEstimate" + }, + { + "target": "com.amazonaws.lightsail#GetDisk" + }, + { + "target": "com.amazonaws.lightsail#GetDisks" + }, + { + "target": "com.amazonaws.lightsail#GetDiskSnapshot" + }, + { + "target": "com.amazonaws.lightsail#GetDiskSnapshots" + }, + { + "target": "com.amazonaws.lightsail#GetDistributionBundles" + }, + { + "target": "com.amazonaws.lightsail#GetDistributionLatestCacheReset" + }, + { + "target": "com.amazonaws.lightsail#GetDistributionMetricData" + }, + { + "target": "com.amazonaws.lightsail#GetDistributions" + }, + { + "target": "com.amazonaws.lightsail#GetDomain" + }, + { + "target": "com.amazonaws.lightsail#GetDomains" + }, + { + "target": "com.amazonaws.lightsail#GetExportSnapshotRecords" + }, + { + "target": "com.amazonaws.lightsail#GetInstance" + }, + { + "target": "com.amazonaws.lightsail#GetInstanceAccessDetails" + }, + { + "target": "com.amazonaws.lightsail#GetInstanceMetricData" + }, + { + "target": "com.amazonaws.lightsail#GetInstancePortStates" + }, + { + "target": "com.amazonaws.lightsail#GetInstances" + }, + { + "target": "com.amazonaws.lightsail#GetInstanceSnapshot" + }, + { + "target": "com.amazonaws.lightsail#GetInstanceSnapshots" + }, + { + "target": "com.amazonaws.lightsail#GetInstanceState" + }, + { + "target": "com.amazonaws.lightsail#GetKeyPair" + }, + { + "target": "com.amazonaws.lightsail#GetKeyPairs" + }, + { + "target": "com.amazonaws.lightsail#GetLoadBalancer" + }, + { + "target": "com.amazonaws.lightsail#GetLoadBalancerMetricData" + }, + { + "target": "com.amazonaws.lightsail#GetLoadBalancers" + }, + { + "target": "com.amazonaws.lightsail#GetLoadBalancerTlsCertificates" + }, + { + "target": "com.amazonaws.lightsail#GetLoadBalancerTlsPolicies" + }, + { + "target": "com.amazonaws.lightsail#GetOperation" + }, + { + "target": "com.amazonaws.lightsail#GetOperations" + }, + { + "target": "com.amazonaws.lightsail#GetOperationsForResource" + }, + { + "target": "com.amazonaws.lightsail#GetRegions" + }, + { + "target": "com.amazonaws.lightsail#GetRelationalDatabase" + }, + { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseBlueprints" + }, + { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseBundles" + }, + { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseEvents" + }, + { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseLogEvents" + }, + { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseLogStreams" + }, + { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseMasterUserPassword" + }, + { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseMetricData" + }, + { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseParameters" + }, + { + "target": "com.amazonaws.lightsail#GetRelationalDatabases" + }, + { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseSnapshot" + }, + { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseSnapshots" + }, + { + "target": "com.amazonaws.lightsail#GetStaticIp" + }, + { + "target": "com.amazonaws.lightsail#GetStaticIps" + }, + { + "target": "com.amazonaws.lightsail#ImportKeyPair" + }, + { + "target": "com.amazonaws.lightsail#IsVpcPeered" + }, + { + "target": "com.amazonaws.lightsail#OpenInstancePublicPorts" + }, + { + "target": "com.amazonaws.lightsail#PeerVpc" + }, + { + "target": "com.amazonaws.lightsail#PutAlarm" + }, + { + "target": "com.amazonaws.lightsail#PutInstancePublicPorts" + }, + { + "target": "com.amazonaws.lightsail#RebootInstance" + }, + { + "target": "com.amazonaws.lightsail#RebootRelationalDatabase" + }, + { + "target": "com.amazonaws.lightsail#RegisterContainerImage" + }, + { + "target": "com.amazonaws.lightsail#ReleaseStaticIp" + }, + { + "target": "com.amazonaws.lightsail#ResetDistributionCache" + }, + { + "target": "com.amazonaws.lightsail#SendContactMethodVerification" + }, + { + "target": "com.amazonaws.lightsail#SetIpAddressType" + }, + { + "target": "com.amazonaws.lightsail#SetResourceAccessForBucket" + }, + { + "target": "com.amazonaws.lightsail#StartGUISession" + }, + { + "target": "com.amazonaws.lightsail#StartInstance" + }, + { + "target": "com.amazonaws.lightsail#StartRelationalDatabase" + }, + { + "target": "com.amazonaws.lightsail#StopGUISession" + }, + { + "target": "com.amazonaws.lightsail#StopInstance" + }, + { + "target": "com.amazonaws.lightsail#StopRelationalDatabase" + }, + { + "target": "com.amazonaws.lightsail#TagResource" + }, + { + "target": "com.amazonaws.lightsail#TestAlarm" + }, + { + "target": "com.amazonaws.lightsail#UnpeerVpc" + }, + { + "target": "com.amazonaws.lightsail#UntagResource" + }, + { + "target": "com.amazonaws.lightsail#UpdateBucket" + }, + { + "target": "com.amazonaws.lightsail#UpdateBucketBundle" + }, + { + "target": "com.amazonaws.lightsail#UpdateContainerService" + }, + { + "target": "com.amazonaws.lightsail#UpdateDistribution" + }, + { + "target": "com.amazonaws.lightsail#UpdateDistributionBundle" + }, + { + "target": "com.amazonaws.lightsail#UpdateDomainEntry" + }, + { + "target": "com.amazonaws.lightsail#UpdateInstanceMetadataOptions" + }, + { + "target": "com.amazonaws.lightsail#UpdateLoadBalancerAttribute" + }, + { + "target": "com.amazonaws.lightsail#UpdateRelationalDatabase" + }, + { + "target": "com.amazonaws.lightsail#UpdateRelationalDatabaseParameters" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Lightsail", + "arnNamespace": "lightsail", + "cloudFormationName": "Lightsail", + "cloudTrailEventSource": "lightsail.amazonaws.com", + "endpointPrefix": "lightsail" + }, + "aws.auth#sigv4": { + "name": "lightsail" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "

Amazon Lightsail is the easiest way to get started with Amazon Web Services (Amazon Web Services) for developers who need to build websites or web applications. It includes\n everything you need to launch your project quickly - instances (virtual private servers),\n container services, storage buckets, managed databases, SSD-based block storage, static IP\n addresses, load balancers, content delivery network (CDN) distributions, DNS management of\n registered domains, and resource snapshots (backups) - for a low, predictable monthly\n price.

\n

You can manage your Lightsail resources using the Lightsail console, Lightsail API,\n Command Line Interface (CLI), or SDKs. For more information about Lightsail\n concepts and tasks, see the Amazon Lightsail Developer Guide.

\n

This API Reference provides detailed information about the actions, data types,\n parameters, and errors of the Lightsail service. For more information about the supported\n Amazon Web Services Regions, endpoints, and service quotas of the Lightsail service, see\n Amazon Lightsail Endpoints\n and Quotas in the Amazon Web Services General Reference.

", + "smithy.api#title": "Amazon Lightsail", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://lightsail-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://lightsail-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://lightsail.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://lightsail.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lightsail-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lightsail.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lightsail-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lightsail.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lightsail-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lightsail.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.lightsail#LoadBalancer": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the load balancer (e.g., my-load-balancer).

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the load balancer.

" + } + }, + "supportCode": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail load balancer. This code enables our support team to look up your Lightsail\n information more easily.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The date when your load balancer was created.

" + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

The AWS Region where your load balancer was created (e.g., us-east-2a).\n Lightsail automatically creates your load balancer across Availability Zones.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The resource type (e.g., LoadBalancer.

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" + } + }, + "dnsName": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The DNS name of your Lightsail load balancer.

" + } + }, + "state": { + "target": "com.amazonaws.lightsail#LoadBalancerState", + "traits": { + "smithy.api#documentation": "

The status of your load balancer. Valid values are below.

" + } + }, + "protocol": { + "target": "com.amazonaws.lightsail#LoadBalancerProtocol", + "traits": { + "smithy.api#documentation": "

The protocol you have enabled for your load balancer. Valid values are below.

\n

You can't just have HTTP_HTTPS, but you can have just\n HTTP.

" + } + }, + "publicPorts": { + "target": "com.amazonaws.lightsail#PortList", + "traits": { + "smithy.api#documentation": "

An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS,\n use port 443.

" + } + }, + "healthCheckPath": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The path you specified to perform your health checks. If no path is specified, the load\n balancer tries to make a request to the default (root) page.

" + } + }, + "instancePort": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The port where the load balancer will direct traffic to your Lightsail instances. For\n HTTP traffic, it's port 80. For HTTPS traffic, it's port 443.

" + } + }, + "instanceHealthSummary": { + "target": "com.amazonaws.lightsail#InstanceHealthSummaryList", + "traits": { + "smithy.api#documentation": "

An array of InstanceHealthSummary objects describing the health of the load\n balancer.

" + } + }, + "tlsCertificateSummaries": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateSummaryList", + "traits": { + "smithy.api#documentation": "

An array of LoadBalancerTlsCertificateSummary objects that provide additional information\n about the SSL/TLS certificates. For example, if true, the certificate is attached\n to the load balancer.

" + } + }, + "configurationOptions": { + "target": "com.amazonaws.lightsail#LoadBalancerConfigurationOptions", + "traits": { + "smithy.api#documentation": "

A string to string map of the configuration options for your load balancer. Valid values\n are listed below.

" + } + }, + "ipAddressType": { + "target": "com.amazonaws.lightsail#IpAddressType", + "traits": { + "smithy.api#documentation": "

The IP address type of the load balancer.

\n

The possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.

" + } + }, + "httpsRedirectionEnabled": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether HTTPS redirection is enabled for the load\n balancer.

" + } + }, + "tlsPolicyName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the TLS security policy for the load balancer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a load balancer.

" + } + }, + "com.amazonaws.lightsail#LoadBalancerAttributeName": { + "type": "enum", + "members": { + "HealthCheckPath": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HealthCheckPath" + } + }, + "SessionStickinessEnabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SessionStickinessEnabled" + } + }, + "SessionStickiness_LB_CookieDurationSeconds": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SessionStickiness_LB_CookieDurationSeconds" + } + }, + "HttpsRedirectionEnabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HttpsRedirectionEnabled" + } + }, + "TlsPolicyName": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TlsPolicyName" + } + } + } + }, + "com.amazonaws.lightsail#LoadBalancerConfigurationOptions": { + "type": "map", + "key": { + "target": "com.amazonaws.lightsail#LoadBalancerAttributeName" + }, + "value": { + "target": "com.amazonaws.lightsail#string" + } + }, + "com.amazonaws.lightsail#LoadBalancerList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#LoadBalancer" + } + }, + "com.amazonaws.lightsail#LoadBalancerMetricName": { + "type": "enum", + "members": { + "ClientTLSNegotiationErrorCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ClientTLSNegotiationErrorCount" + } + }, + "HealthyHostCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HealthyHostCount" + } + }, + "UnhealthyHostCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UnhealthyHostCount" + } + }, + "HTTPCode_LB_4XX_Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPCode_LB_4XX_Count" + } + }, + "HTTPCode_LB_5XX_Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPCode_LB_5XX_Count" + } + }, + "HTTPCode_Instance_2XX_Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPCode_Instance_2XX_Count" + } + }, + "HTTPCode_Instance_3XX_Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPCode_Instance_3XX_Count" + } + }, + "HTTPCode_Instance_4XX_Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPCode_Instance_4XX_Count" + } + }, + "HTTPCode_Instance_5XX_Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPCode_Instance_5XX_Count" + } + }, + "InstanceResponseTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InstanceResponseTime" + } + }, + "RejectedConnectionCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RejectedConnectionCount" + } + }, + "RequestCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RequestCount" + } + } + } + }, + "com.amazonaws.lightsail#LoadBalancerProtocol": { + "type": "enum", + "members": { + "HTTP_HTTPS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTP_HTTPS" + } + }, + "HTTP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTP" + } + } + } + }, + "com.amazonaws.lightsail#LoadBalancerState": { + "type": "enum", + "members": { + "Active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "Provisioning": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "provisioning" + } + }, + "ActiveImpaired": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active_impaired" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "Unknown": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unknown" + } + } + } + }, + "com.amazonaws.lightsail#LoadBalancerTlsCertificate": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the SSL/TLS certificate (e.g., my-certificate).

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SSL/TLS certificate.

" + } + }, + "supportCode": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail load balancer or SSL/TLS certificate. This code enables our support team to\n look up your Lightsail information more easily.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The time when you created your SSL/TLS certificate.

" + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region and Availability Zone where you created your\n certificate.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The resource type (e.g., LoadBalancerTlsCertificate).

\n " + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" + } + }, + "loadBalancerName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The load balancer name where your SSL/TLS certificate is attached.

" + } + }, + "isAttached": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

When true, the SSL/TLS certificate is attached to the Lightsail load\n balancer.

" + } + }, + "status": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateStatus", + "traits": { + "smithy.api#documentation": "

The validation status of the SSL/TLS certificate. Valid values are below.

" + } + }, + "domainName": { + "target": "com.amazonaws.lightsail#DomainName", + "traits": { + "smithy.api#documentation": "

The domain name for your SSL/TLS certificate.

" + } + }, + "domainValidationRecords": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationRecordList", + "traits": { + "smithy.api#documentation": "

An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the\n records.

" + } + }, + "failureReason": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateFailureReason", + "traits": { + "smithy.api#documentation": "

The validation failure reason, if any, of the certificate.

\n

The following failure reasons are possible:

\n " + } + }, + "issuedAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The time when the SSL/TLS certificate was issued.

" + } + }, + "issuer": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The issuer of the certificate.

" + } + }, + "keyAlgorithm": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The algorithm used to generate the key pair (the public and private key).

" + } + }, + "notAfter": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the SSL/TLS certificate expires.

" + } + }, + "notBefore": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the SSL/TLS certificate is first valid.

" + } + }, + "renewalSummary": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateRenewalSummary", + "traits": { + "smithy.api#documentation": "

An object that describes the status of the certificate renewal managed by\n Lightsail.

" + } + }, + "revocationReason": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateRevocationReason", + "traits": { + "smithy.api#documentation": "

The reason the certificate was revoked. This value is present only when the certificate\n status is REVOKED.

" + } + }, + "revokedAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the certificate was revoked. This value is present only when the\n certificate status is REVOKED.

" + } + }, + "serial": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The serial number of the certificate.

" + } + }, + "signatureAlgorithm": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The algorithm that was used to sign the certificate.

" + } + }, + "subject": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the entity that is associated with the public key contained in the\n certificate.

" + } + }, + "subjectAlternativeNames": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

An array of strings that specify the alternate domains (e.g., example2.com)\n and subdomains (e.g., blog.example.com) for the certificate.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a load balancer SSL/TLS certificate.

\n

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

" + } + }, + "com.amazonaws.lightsail#LoadBalancerTlsCertificateDnsRecordCreationState": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDnsRecordCreationStateCode", + "traits": { + "smithy.api#documentation": "

The status code for the automated DNS record creation.

\n

Following are the possible values:

\n " + } + }, + "message": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The message that describes the reason for the status code.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that describes the state of the canonical name (CNAME) records that are\n automatically added by Lightsail to the DNS of the domain to validate domain\n ownership.

" + } + }, + "com.amazonaws.lightsail#LoadBalancerTlsCertificateDnsRecordCreationStateCode": { + "type": "enum", + "members": { + "Succeeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "Started": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTED" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainStatus": { + "type": "enum", + "members": { + "PendingValidation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_VALIDATION" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "Success": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + } + } }, - "docs": { - "target": "com.amazonaws.lightsail#string" + "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationOption": { + "type": "structure", + "members": { + "domainName": { + "target": "com.amazonaws.lightsail#DomainName", + "traits": { + "smithy.api#documentation": "

The fully qualified domain name in the certificate request.

" + } + }, + "validationStatus": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainStatus", + "traits": { + "smithy.api#documentation": "

The status of the domain validation. Valid values are listed below.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the domain names on an SSL/TLS certificate that you will use to\n validate domain ownership.

" + } }, - "message": { - "target": "com.amazonaws.lightsail#string" + "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationOptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationOption" + } }, - "tip": { - "target": "com.amazonaws.lightsail#string" - } - }, - "traits": { - "smithy.api#documentation": "

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

\n \n

Domain and distribution APIs are only available in the N. Virginia\n (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services\n Region configuration to us-east-1 to create, view, or edit these\n resources.

\n ", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.lightsail#IpAddress": { - "type": "string", - "traits": { - "smithy.api#pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}$" - } - }, - "com.amazonaws.lightsail#IpAddressType": { - "type": "enum", - "members": { - "DUALSTACK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "dualstack" - } - }, - "IPV4": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ipv4" - } - } - } - }, - "com.amazonaws.lightsail#Ipv6Address": { - "type": "string", - "traits": { - "smithy.api#pattern": "^([A-F0-9]{1,4}:){7}[A-F0-9]{1,4}$" - } - }, - "com.amazonaws.lightsail#Ipv6AddressList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#Ipv6Address" - } - }, - "com.amazonaws.lightsail#IsVpcPeered": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#IsVpcPeeredRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#IsVpcPeeredResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/IsVpcPeered", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#IsVpcPeeredRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#IsVpcPeeredResult": { - "type": "structure", - "members": { - "isPeered": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

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

" - } - } - } - }, - "com.amazonaws.lightsail#IsoDate": { - "type": "timestamp" - }, - "com.amazonaws.lightsail#IssuerCA": { - "type": "string" - }, - "com.amazonaws.lightsail#KeyAlgorithm": { - "type": "string" - }, - "com.amazonaws.lightsail#KeyPair": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The friendly name of the SSH key pair.

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The resource type (usually KeyPair).

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" - } - }, - "fingerprint": { - "target": "com.amazonaws.lightsail#Base64", - "traits": { - "smithy.api#documentation": "

The RSA fingerprint of the key pair.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an SSH key pair.

" - } - }, - "com.amazonaws.lightsail#KeyPairList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#KeyPair" - } - }, - "com.amazonaws.lightsail#LightsailDistribution": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the distribution.

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution.

" - } - }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail distribution. This code enables our support team to look up your Lightsail\n information more easily.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the distribution was created.

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

An object that describes the location of the distribution, such as the Amazon Web Services\n Region and Availability Zone.

\n \n

Lightsail distributions are global resources that can reference an origin in any\n Amazon Web Services Region, and distribute its content globally. However, all distributions\n are located in the us-east-1 Region.

\n " - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The Lightsail resource type (e.g., Distribution).

" - } - }, - "alternativeDomainNames": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

The alternate domain names of the distribution.

" - } - }, - "status": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The status of the distribution.

" - } - }, - "isEnabled": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether the distribution is enabled.

" - } - }, - "domainName": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The domain name of the distribution.

" - } - }, - "bundleId": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The ID of the bundle currently applied to the distribution.

" - } - }, - "certificateName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the SSL/TLS certificate attached to the distribution, if any.

" - } - }, - "origin": { - "target": "com.amazonaws.lightsail#Origin", - "traits": { - "smithy.api#documentation": "

An object that describes the origin resource of the distribution, such as a Lightsail\n instance, bucket, or load balancer.

\n

The distribution pulls, caches, and serves content from the origin.

" - } - }, - "originPublicDNS": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The public DNS of the origin.

" - } - }, - "defaultCacheBehavior": { - "target": "com.amazonaws.lightsail#CacheBehavior", - "traits": { - "smithy.api#documentation": "

An object that describes the default cache behavior of the distribution.

" - } - }, - "cacheBehaviorSettings": { - "target": "com.amazonaws.lightsail#CacheSettings", - "traits": { - "smithy.api#documentation": "

An object that describes the cache behavior settings of the distribution.

" - } - }, - "cacheBehaviors": { - "target": "com.amazonaws.lightsail#CacheBehaviorList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the per-path cache behavior of the distribution.

" - } - }, - "ableToUpdateBundle": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether the bundle that is currently applied to your distribution, specified\n using the distributionName parameter, can be changed to another bundle.

\n

Use the UpdateDistributionBundle action to change your distribution's\n bundle.

" - } - }, - "ipAddressType": { - "target": "com.amazonaws.lightsail#IpAddressType", - "traits": { - "smithy.api#documentation": "

The IP address type of the distribution.

\n

The possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an Amazon Lightsail content delivery network (CDN) distribution.

" - } - }, - "com.amazonaws.lightsail#Lightsail_20161128": { - "type": "service", - "version": "2016-11-28", - "operations": [ - { - "target": "com.amazonaws.lightsail#AllocateStaticIp" + "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationRecord": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A fully qualified domain name in the certificate. For example,\n example.com.

" + } + }, + "type": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of validation record. For example, CNAME for domain\n validation.

" + } + }, + "value": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The value for that type.

" + } + }, + "validationStatus": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainStatus", + "traits": { + "smithy.api#documentation": "

The validation status. Valid values are listed below.

" + } + }, + "domainName": { + "target": "com.amazonaws.lightsail#DomainName", + "traits": { + "smithy.api#documentation": "

The domain name against which your SSL/TLS certificate was validated.

" + } + }, + "dnsRecordCreationState": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDnsRecordCreationState", + "traits": { + "smithy.api#documentation": "

An object that describes the state of the canonical name (CNAME) records that are\n automatically added by Lightsail to the DNS of a domain to validate domain\n ownership.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the validation record of each domain name in the SSL/TLS certificate.

" + } + }, + "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationRecordList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationRecord" + } + }, + "com.amazonaws.lightsail#LoadBalancerTlsCertificateFailureReason": { + "type": "enum", + "members": { + "NoAvailableContacts": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_AVAILABLE_CONTACTS" + } + }, + "AdditionalVerificationRequired": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADDITIONAL_VERIFICATION_REQUIRED" + } + }, + "DomainNotAllowed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_NOT_ALLOWED" + } + }, + "InvalidPublicDomain": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_PUBLIC_DOMAIN" + } + }, + "Other": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OTHER" + } + } + } + }, + "com.amazonaws.lightsail#LoadBalancerTlsCertificateList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificate" + } + }, + "com.amazonaws.lightsail#LoadBalancerTlsCertificateRenewalStatus": { + "type": "enum", + "members": { + "PendingAutoRenewal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_AUTO_RENEWAL" + } + }, + "PendingValidation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_VALIDATION" + } + }, + "Success": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.lightsail#LoadBalancerTlsCertificateRenewalSummary": { + "type": "structure", + "members": { + "renewalStatus": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateRenewalStatus", + "traits": { + "smithy.api#documentation": "

The renewal status of the certificate.

\n

The following renewal status are possible:

\n " + } + }, + "domainValidationOptions": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationOptionList", + "traits": { + "smithy.api#documentation": "

Contains information about the validation of each domain name in the certificate, as it\n pertains to Lightsail's managed renewal. This is different from the initial validation that\n occurs as a result of the RequestCertificate request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the status of Lightsail's managed renewal for the\n certificate.

\n

The renewal status of the certificate.

\n

The following renewal status are possible:

\n " + } + }, + "com.amazonaws.lightsail#LoadBalancerTlsCertificateRevocationReason": { + "type": "enum", + "members": { + "Unspecified": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNSPECIFIED" + } + }, + "KeyCompromise": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KEY_COMPROMISE" + } + }, + "CaCompromise": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CA_COMPROMISE" + } + }, + "AffiliationChanged": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AFFILIATION_CHANGED" + } + }, + "Superceded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUPERCEDED" + } + }, + "CessationOfOperation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CESSATION_OF_OPERATION" + } + }, + "CertificateHold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CERTIFICATE_HOLD" + } + }, + "RemoveFromCrl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REMOVE_FROM_CRL" + } + }, + "PrivilegeWithdrawn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIVILEGE_WITHDRAWN" + } + }, + "AACompromise": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "A_A_COMPROMISE" + } + } + } + }, + "com.amazonaws.lightsail#LoadBalancerTlsCertificateStatus": { + "type": "enum", + "members": { + "PendingValidation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_VALIDATION" + } + }, + "Issued": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ISSUED" + } + }, + "Inactive": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + }, + "Expired": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPIRED" + } + }, + "ValidationTimedOut": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATION_TIMED_OUT" + } + }, + "Revoked": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REVOKED" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "Unknown": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNKNOWN" + } + } + } + }, + "com.amazonaws.lightsail#LoadBalancerTlsCertificateSummary": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the SSL/TLS certificate.

" + } + }, + "isAttached": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

When true, the SSL/TLS certificate is attached to the Lightsail load\n balancer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides a summary of SSL/TLS certificate metadata.

" + } + }, + "com.amazonaws.lightsail#LoadBalancerTlsCertificateSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateSummary" + } + }, + "com.amazonaws.lightsail#LoadBalancerTlsPolicy": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the TLS security policy.

" + } + }, + "isDefault": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether the TLS security policy is the default.

" + } + }, + "description": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The description of the TLS security policy.

" + } + }, + "protocols": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

The protocols used in a given TLS security policy.

" + } + }, + "ciphers": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

The ciphers used by the TLS security policy.

\n

The ciphers are listed in order of preference.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the TLS security policies that are available for Lightsail load\n balancers.

\n

For more information about load balancer TLS security policies, see Configuring TLS security policies on your Amazon Lightsail load\n balancers in the Amazon Lightsail Developer\n Guide.

" + } }, - { - "target": "com.amazonaws.lightsail#AttachCertificateToDistribution" + "com.amazonaws.lightsail#LoadBalancerTlsPolicyList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsPolicy" + } + }, + "com.amazonaws.lightsail#LogEvent": { + "type": "structure", + "members": { + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the database log event was created.

" + } + }, + "message": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The message of the database log event.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a database log event.

" + } }, - { - "target": "com.amazonaws.lightsail#AttachDisk" + "com.amazonaws.lightsail#LogEventList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#LogEvent" + } + }, + "com.amazonaws.lightsail#MetricDatapoint": { + "type": "structure", + "members": { + "average": { + "target": "com.amazonaws.lightsail#double", + "traits": { + "smithy.api#documentation": "

The average.

" + } + }, + "maximum": { + "target": "com.amazonaws.lightsail#double", + "traits": { + "smithy.api#documentation": "

The maximum.

" + } + }, + "minimum": { + "target": "com.amazonaws.lightsail#double", + "traits": { + "smithy.api#documentation": "

The minimum.

" + } + }, + "sampleCount": { + "target": "com.amazonaws.lightsail#double", + "traits": { + "smithy.api#documentation": "

The sample count.

" + } + }, + "sum": { + "target": "com.amazonaws.lightsail#double", + "traits": { + "smithy.api#documentation": "

The sum.

" + } + }, + "timestamp": { + "target": "com.amazonaws.lightsail#timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp (e.g., 1479816991.349).

" + } + }, + "unit": { + "target": "com.amazonaws.lightsail#MetricUnit", + "traits": { + "smithy.api#documentation": "

The unit.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the metric data point.

" + } }, - { - "target": "com.amazonaws.lightsail#AttachInstancesToLoadBalancer" + "com.amazonaws.lightsail#MetricDatapointList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#MetricDatapoint" + } }, - { - "target": "com.amazonaws.lightsail#AttachLoadBalancerTlsCertificate" + "com.amazonaws.lightsail#MetricName": { + "type": "enum", + "members": { + "CPUUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CPUUtilization" + } + }, + "NetworkIn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NetworkIn" + } + }, + "NetworkOut": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NetworkOut" + } + }, + "StatusCheckFailed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StatusCheckFailed" + } + }, + "StatusCheckFailed_Instance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StatusCheckFailed_Instance" + } + }, + "StatusCheckFailed_System": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StatusCheckFailed_System" + } + }, + "ClientTLSNegotiationErrorCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ClientTLSNegotiationErrorCount" + } + }, + "HealthyHostCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HealthyHostCount" + } + }, + "UnhealthyHostCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UnhealthyHostCount" + } + }, + "HTTPCode_LB_4XX_Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPCode_LB_4XX_Count" + } + }, + "HTTPCode_LB_5XX_Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPCode_LB_5XX_Count" + } + }, + "HTTPCode_Instance_2XX_Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPCode_Instance_2XX_Count" + } + }, + "HTTPCode_Instance_3XX_Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPCode_Instance_3XX_Count" + } + }, + "HTTPCode_Instance_4XX_Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPCode_Instance_4XX_Count" + } + }, + "HTTPCode_Instance_5XX_Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPCode_Instance_5XX_Count" + } + }, + "InstanceResponseTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InstanceResponseTime" + } + }, + "RejectedConnectionCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RejectedConnectionCount" + } + }, + "RequestCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RequestCount" + } + }, + "DatabaseConnections": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DatabaseConnections" + } + }, + "DiskQueueDepth": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DiskQueueDepth" + } + }, + "FreeStorageSpace": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FreeStorageSpace" + } + }, + "NetworkReceiveThroughput": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NetworkReceiveThroughput" + } + }, + "NetworkTransmitThroughput": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NetworkTransmitThroughput" + } + }, + "BurstCapacityTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BurstCapacityTime" + } + }, + "BurstCapacityPercentage": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BurstCapacityPercentage" + } + } + } }, - { - "target": "com.amazonaws.lightsail#AttachStaticIp" + "com.amazonaws.lightsail#MetricPeriod": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 60, + "max": 86400 + } + } }, - { - "target": "com.amazonaws.lightsail#CloseInstancePublicPorts" + "com.amazonaws.lightsail#MetricStatistic": { + "type": "enum", + "members": { + "Minimum": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Minimum" + } + }, + "Maximum": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Maximum" + } + }, + "Sum": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Sum" + } + }, + "Average": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Average" + } + }, + "SampleCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SampleCount" + } + } + } }, - { - "target": "com.amazonaws.lightsail#CopySnapshot" + "com.amazonaws.lightsail#MetricStatisticList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#MetricStatistic" + } }, - { - "target": "com.amazonaws.lightsail#CreateBucket" + "com.amazonaws.lightsail#MetricUnit": { + "type": "enum", + "members": { + "Seconds": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Seconds" + } + }, + "Microseconds": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Microseconds" + } + }, + "Milliseconds": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Milliseconds" + } + }, + "Bytes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bytes" + } + }, + "Kilobytes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kilobytes" + } + }, + "Megabytes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Megabytes" + } + }, + "Gigabytes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gigabytes" + } + }, + "Terabytes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terabytes" + } + }, + "Bits": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bits" + } + }, + "Kilobits": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kilobits" + } + }, + "Megabits": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Megabits" + } + }, + "Gigabits": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gigabits" + } + }, + "Terabits": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terabits" + } + }, + "Percent": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Percent" + } + }, + "Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Count" + } + }, + "BytesSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bytes/Second" + } + }, + "KilobytesSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kilobytes/Second" + } + }, + "MegabytesSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Megabytes/Second" + } + }, + "GigabytesSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gigabytes/Second" + } + }, + "TerabytesSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terabytes/Second" + } + }, + "BitsSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bits/Second" + } + }, + "KilobitsSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kilobits/Second" + } + }, + "MegabitsSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Megabits/Second" + } + }, + "GigabitsSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gigabits/Second" + } + }, + "TerabitsSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terabits/Second" + } + }, + "CountSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Count/Second" + } + }, + "None": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "None" + } + } + } }, - { - "target": "com.amazonaws.lightsail#CreateBucketAccessKey" + "com.amazonaws.lightsail#MonitoredResourceInfo": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.lightsail#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource being monitored.

" + } + }, + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the Lightsail resource being monitored.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The Lightsail resource type of the resource being monitored.

\n

Instances, load balancers, and relational databases are the only Lightsail resources\n that can currently be monitored by alarms.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes resource being monitored by an alarm.

\n

An alarm is a way to monitor your Amazon Lightsail resource metrics. For more information,\n see Alarms\n in Amazon Lightsail.

" + } }, - { - "target": "com.amazonaws.lightsail#CreateCertificate" + "com.amazonaws.lightsail#MonthlyTransfer": { + "type": "structure", + "members": { + "gbPerMonthAllocated": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The amount allocated per month (in GB).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

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

" + } }, - { - "target": "com.amazonaws.lightsail#CreateCloudFormationStack" + "com.amazonaws.lightsail#NameServersUpdateState": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.lightsail#NameServersUpdateStateCode", + "traits": { + "smithy.api#documentation": "

The status code for the name servers update.

\n

Following are the possible values:

\n " + } + }, + "message": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The message that describes the reason for the status code.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the state of the name server records update made by Amazon Lightsail\n to an Amazon Route 53 registered domain.

\n

For more information, see DNS in Amazon Lightsail in the Amazon Lightsail\n Developer Guide.

" + } }, - { - "target": "com.amazonaws.lightsail#CreateContactMethod" + "com.amazonaws.lightsail#NameServersUpdateStateCode": { + "type": "enum", + "members": { + "Succeeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "Started": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTED" + } + } + } }, - { - "target": "com.amazonaws.lightsail#CreateContainerService" + "com.amazonaws.lightsail#NetworkProtocol": { + "type": "enum", + "members": { + "TCP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tcp" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "all" + } + }, + "UDP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "udp" + } + }, + "ICMP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "icmp" + } + } + } }, - { - "target": "com.amazonaws.lightsail#CreateContainerServiceDeployment" + "com.amazonaws.lightsail#NonEmptyString": { + "type": "string", + "traits": { + "smithy.api#pattern": "\\S" + } }, - { - "target": "com.amazonaws.lightsail#CreateContainerServiceRegistryLogin" + "com.amazonaws.lightsail#NotFoundException": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.lightsail#string" + }, + "docs": { + "target": "com.amazonaws.lightsail#string" + }, + "message": { + "target": "com.amazonaws.lightsail#string" + }, + "tip": { + "target": "com.amazonaws.lightsail#string" + } + }, + "traits": { + "smithy.api#documentation": "

Lightsail throws this exception when it cannot find a resource.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } }, - { - "target": "com.amazonaws.lightsail#CreateDisk" + "com.amazonaws.lightsail#NotificationTriggerList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#AlarmState" + } }, - { - "target": "com.amazonaws.lightsail#CreateDiskFromSnapshot" + "com.amazonaws.lightsail#OpenInstancePublicPorts": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#OpenInstancePublicPortsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#OpenInstancePublicPortsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses\n allowed to connect to the instance through the ports, and the protocol.

\n

The OpenInstancePublicPorts action supports tag-based access control via\n resource tags applied to the resource identified by instanceName. For more\n information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/OpenInstancePublicPorts", + "code": 200 + } + } }, - { - "target": "com.amazonaws.lightsail#CreateDiskSnapshot" + "com.amazonaws.lightsail#OpenInstancePublicPortsRequest": { + "type": "structure", + "members": { + "portInfo": { + "target": "com.amazonaws.lightsail#PortInfo", + "traits": { + "smithy.api#documentation": "

An object to describe the ports to open for the specified instance.

", + "smithy.api#required": {} + } + }, + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the instance for which to open ports.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.lightsail#CreateDistribution" + "com.amazonaws.lightsail#OpenInstancePublicPortsResult": { + "type": "structure", + "members": { + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.lightsail#CreateDomain" + "com.amazonaws.lightsail#Operation": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the operation.

" + } + }, + "resourceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The resource name.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The resource type.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region and Availability Zone.

" + } + }, + "isTerminal": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether the operation is terminal.

" + } + }, + "operationDetails": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "operationType": { + "target": "com.amazonaws.lightsail#OperationType", + "traits": { + "smithy.api#documentation": "

The type of operation.

" + } + }, + "status": { + "target": "com.amazonaws.lightsail#OperationStatus", + "traits": { + "smithy.api#documentation": "

The status of the operation.

" + } + }, + "statusChangedAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "errorCode": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The error code.

" + } + }, + "errorDetails": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The error details.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the API operation.

" + } }, - { - "target": "com.amazonaws.lightsail#CreateDomainEntry" + "com.amazonaws.lightsail#OperationFailureException": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.lightsail#string" + }, + "docs": { + "target": "com.amazonaws.lightsail#string" + }, + "message": { + "target": "com.amazonaws.lightsail#string" + }, + "tip": { + "target": "com.amazonaws.lightsail#string" + } + }, + "traits": { + "smithy.api#documentation": "

Lightsail throws this exception when an operation fails to execute.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.lightsail#CreateGUISessionAccessDetails" + "com.amazonaws.lightsail#OperationList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#Operation" + } }, - { - "target": "com.amazonaws.lightsail#CreateInstances" + "com.amazonaws.lightsail#OperationStatus": { + "type": "enum", + "members": { + "NotStarted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotStarted" + } + }, + "Started": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Started" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "Completed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "Succeeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Succeeded" + } + } + } }, - { - "target": "com.amazonaws.lightsail#CreateInstancesFromSnapshot" + "com.amazonaws.lightsail#OperationType": { + "type": "enum", + "members": { + "DeleteKnownHostKeys": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteKnownHostKeys" + } + }, + "DeleteInstance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteInstance" + } + }, + "CreateInstance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateInstance" + } + }, + "StopInstance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StopInstance" + } + }, + "StartInstance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StartInstance" + } + }, + "RebootInstance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RebootInstance" + } + }, + "OpenInstancePublicPorts": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OpenInstancePublicPorts" + } + }, + "PutInstancePublicPorts": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PutInstancePublicPorts" + } + }, + "CloseInstancePublicPorts": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CloseInstancePublicPorts" + } + }, + "AllocateStaticIp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AllocateStaticIp" + } + }, + "ReleaseStaticIp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ReleaseStaticIp" + } + }, + "AttachStaticIp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AttachStaticIp" + } + }, + "DetachStaticIp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DetachStaticIp" + } + }, + "UpdateDomainEntry": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateDomainEntry" + } + }, + "DeleteDomainEntry": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteDomainEntry" + } + }, + "CreateDomain": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateDomain" + } + }, + "DeleteDomain": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteDomain" + } + }, + "CreateInstanceSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateInstanceSnapshot" + } + }, + "DeleteInstanceSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteInstanceSnapshot" + } + }, + "CreateInstancesFromSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateInstancesFromSnapshot" + } + }, + "CreateLoadBalancer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateLoadBalancer" + } + }, + "DeleteLoadBalancer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteLoadBalancer" + } + }, + "AttachInstancesToLoadBalancer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AttachInstancesToLoadBalancer" + } + }, + "DetachInstancesFromLoadBalancer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DetachInstancesFromLoadBalancer" + } + }, + "UpdateLoadBalancerAttribute": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateLoadBalancerAttribute" + } + }, + "CreateLoadBalancerTlsCertificate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateLoadBalancerTlsCertificate" + } + }, + "DeleteLoadBalancerTlsCertificate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteLoadBalancerTlsCertificate" + } + }, + "AttachLoadBalancerTlsCertificate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AttachLoadBalancerTlsCertificate" + } + }, + "CreateDisk": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateDisk" + } + }, + "DeleteDisk": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteDisk" + } + }, + "AttachDisk": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AttachDisk" + } + }, + "DetachDisk": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DetachDisk" + } + }, + "CreateDiskSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateDiskSnapshot" + } + }, + "DeleteDiskSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteDiskSnapshot" + } + }, + "CreateDiskFromSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateDiskFromSnapshot" + } + }, + "CreateRelationalDatabase": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateRelationalDatabase" + } + }, + "UpdateRelationalDatabase": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateRelationalDatabase" + } + }, + "DeleteRelationalDatabase": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteRelationalDatabase" + } + }, + "CreateRelationalDatabaseFromSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateRelationalDatabaseFromSnapshot" + } + }, + "CreateRelationalDatabaseSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateRelationalDatabaseSnapshot" + } + }, + "DeleteRelationalDatabaseSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteRelationalDatabaseSnapshot" + } + }, + "UpdateRelationalDatabaseParameters": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateRelationalDatabaseParameters" + } + }, + "StartRelationalDatabase": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StartRelationalDatabase" + } + }, + "RebootRelationalDatabase": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RebootRelationalDatabase" + } + }, + "StopRelationalDatabase": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StopRelationalDatabase" + } + }, + "EnableAddOn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EnableAddOn" + } + }, + "DisableAddOn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DisableAddOn" + } + }, + "PutAlarm": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PutAlarm" + } + }, + "GetAlarms": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GetAlarms" + } + }, + "DeleteAlarm": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteAlarm" + } + }, + "TestAlarm": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TestAlarm" + } + }, + "CreateContactMethod": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateContactMethod" + } + }, + "GetContactMethods": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GetContactMethods" + } + }, + "SendContactMethodVerification": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SendContactMethodVerification" + } + }, + "DeleteContactMethod": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteContactMethod" + } + }, + "CreateDistribution": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateDistribution" + } + }, + "UpdateDistribution": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateDistribution" + } + }, + "DeleteDistribution": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteDistribution" + } + }, + "ResetDistributionCache": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ResetDistributionCache" + } + }, + "AttachCertificateToDistribution": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AttachCertificateToDistribution" + } + }, + "DetachCertificateFromDistribution": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DetachCertificateFromDistribution" + } + }, + "UpdateDistributionBundle": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateDistributionBundle" + } + }, + "SetIpAddressType": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SetIpAddressType" + } + }, + "CreateCertificate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateCertificate" + } + }, + "DeleteCertificate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteCertificate" + } + }, + "CreateContainerService": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateContainerService" + } + }, + "UpdateContainerService": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateContainerService" + } + }, + "DeleteContainerService": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteContainerService" + } + }, + "CreateContainerServiceDeployment": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateContainerServiceDeployment" + } + }, + "CreateContainerServiceRegistryLogin": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateContainerServiceRegistryLogin" + } + }, + "RegisterContainerImage": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RegisterContainerImage" + } + }, + "DeleteContainerImage": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteContainerImage" + } + }, + "CreateBucket": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateBucket" + } + }, + "DeleteBucket": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteBucket" + } + }, + "CreateBucketAccessKey": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateBucketAccessKey" + } + }, + "DeleteBucketAccessKey": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteBucketAccessKey" + } + }, + "UpdateBucketBundle": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateBucketBundle" + } + }, + "UpdateBucket": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateBucket" + } + }, + "SetResourceAccessForBucket": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SetResourceAccessForBucket" + } + }, + "UpdateInstanceMetadataOptions": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateInstanceMetadataOptions" + } + }, + "StartGUISession": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StartGUISession" + } + }, + "StopGUISession": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StopGUISession" + } + } + } }, - { - "target": "com.amazonaws.lightsail#CreateInstanceSnapshot" + "com.amazonaws.lightsail#Origin": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the origin resource.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The resource type of the origin resource (e.g., Instance).

" + } + }, + "regionName": { + "target": "com.amazonaws.lightsail#RegionName", + "traits": { + "smithy.api#documentation": "

The AWS Region name of the origin resource.

" + } + }, + "protocolPolicy": { + "target": "com.amazonaws.lightsail#OriginProtocolPolicyEnum", + "traits": { + "smithy.api#documentation": "

The protocol that your Amazon Lightsail distribution uses when establishing a connection\n with your origin to pull content.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the origin resource of an Amazon Lightsail content delivery network (CDN)\n distribution.

\n

An origin can be a Lightsail instance, bucket, or load balancer. A distribution pulls\n content from an origin, caches it, and serves it to viewers via a worldwide network of edge\n servers.

" + } }, - { - "target": "com.amazonaws.lightsail#CreateKeyPair" + "com.amazonaws.lightsail#OriginProtocolPolicyEnum": { + "type": "enum", + "members": { + "HTTPOnly": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "http-only" + } + }, + "HTTPSOnly": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "https-only" + } + } + } }, - { - "target": "com.amazonaws.lightsail#CreateLoadBalancer" + "com.amazonaws.lightsail#PartnerIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#NonEmptyString" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } }, - { - "target": "com.amazonaws.lightsail#CreateLoadBalancerTlsCertificate" + "com.amazonaws.lightsail#PasswordData": { + "type": "structure", + "members": { + "ciphertext": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The encrypted password. Ciphertext will be an empty string if access to your new instance\n is not ready yet. When you create an instance, it can take up to 15 minutes for the instance\n to be ready.

\n \n

If you use the default key pair (LightsailDefaultKeyPair), the decrypted\n password will be available in the password field.

\n

If you are using a custom key pair, you need to use your own means of decryption.

\n

If you change the Administrator password on the instance, Lightsail will continue to\n return the original ciphertext value. When accessing the instance using RDP, you need to\n manually enter the Administrator password after changing it from the default.

\n " + } + }, + "keyPairName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the key pair that you used when creating your instance. If no key pair name\n was specified when creating the instance, Lightsail uses the default key pair\n (LightsailDefaultKeyPair).

\n

If you are using a custom key pair, you need to use your own means of decrypting your\n password using the ciphertext. Lightsail creates the ciphertext by encrypting\n your password with the public key part of this key pair.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The password data for the Windows Server-based instance, including the ciphertext and the\n key pair name.

" + } }, - { - "target": "com.amazonaws.lightsail#CreateRelationalDatabase" + "com.amazonaws.lightsail#PeerVpc": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#PeerVpcRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#PeerVpcResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Peers the Lightsail VPC with the user's default VPC.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/PeerVpc", + "code": 200 + } + } }, - { - "target": "com.amazonaws.lightsail#CreateRelationalDatabaseFromSnapshot" + "com.amazonaws.lightsail#PeerVpcRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.lightsail#CreateRelationalDatabaseSnapshot" + "com.amazonaws.lightsail#PeerVpcResult": { + "type": "structure", + "members": { + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.lightsail#DeleteAlarm" + "com.amazonaws.lightsail#PendingMaintenanceAction": { + "type": "structure", + "members": { + "action": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of pending database maintenance action.

" + } + }, + "description": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Additional detail about the pending database maintenance action.

" + } + }, + "currentApplyDate": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The effective date of the pending database maintenance action.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a pending database maintenance action.

" + } }, - { - "target": "com.amazonaws.lightsail#DeleteAutoSnapshot" + "com.amazonaws.lightsail#PendingMaintenanceActionList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#PendingMaintenanceAction" + } }, - { - "target": "com.amazonaws.lightsail#DeleteBucket" + "com.amazonaws.lightsail#PendingModifiedRelationalDatabaseValues": { + "type": "structure", + "members": { + "masterUserPassword": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The password for the master user of the database.

" + } + }, + "engineVersion": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The database engine version.

" + } + }, + "backupRetentionEnabled": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether automated backup retention is enabled.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a pending database value modification.

" + } }, - { - "target": "com.amazonaws.lightsail#DeleteBucketAccessKey" + "com.amazonaws.lightsail#Port": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": -1, + "max": 65535 + } + } }, - { - "target": "com.amazonaws.lightsail#DeleteCertificate" + "com.amazonaws.lightsail#PortAccessType": { + "type": "enum", + "members": { + "Public": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Public" + } + }, + "Private": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Private" + } + } + } }, - { - "target": "com.amazonaws.lightsail#DeleteContactMethod" + "com.amazonaws.lightsail#PortInfo": { + "type": "structure", + "members": { + "fromPort": { + "target": "com.amazonaws.lightsail#Port", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The first port in a range of open ports on an instance.

\n

Allowed ports:

\n " + } + }, + "toPort": { + "target": "com.amazonaws.lightsail#Port", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The last port in a range of open ports on an instance.

\n

Allowed ports:

\n " + } + }, + "protocol": { + "target": "com.amazonaws.lightsail#NetworkProtocol", + "traits": { + "smithy.api#documentation": "

The IP protocol name.

\n

The name can be one of the following:

\n " + } + }, + "cidrs": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to\n connect to an instance through the ports, and the protocol.

\n \n

The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to\n connect to an instance.

\n \n

Examples:

\n \n

For more information about CIDR block notation, see Classless\n Inter-Domain Routing on Wikipedia.

" + } + }, + "ipv6Cidrs": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to\n connect to an instance through the ports, and the protocol. Only devices with an IPv6 address\n can connect to an instance through IPv6; otherwise, IPv4 should be used.

\n \n

The cidrs parameter lists the IPv4 addresses that are allowed to connect to\n an instance.

\n \n

For more information about CIDR block notation, see Classless\n Inter-Domain Routing on Wikipedia.

" + } + }, + "cidrListAliases": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

An alias that defines access for a preconfigured range of IP addresses.

\n

The only alias currently supported is lightsail-connect, which allows IP\n addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your\n instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes ports to open on an instance, the IP addresses allowed to connect to the\n instance through the ports, and the protocol.

" + } }, - { - "target": "com.amazonaws.lightsail#DeleteContainerImage" + "com.amazonaws.lightsail#PortInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#PortInfo" + } }, - { - "target": "com.amazonaws.lightsail#DeleteContainerService" + "com.amazonaws.lightsail#PortInfoSourceType": { + "type": "enum", + "members": { + "Default": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULT" + } + }, + "Instance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTANCE" + } + }, + "None": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "Closed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOSED" + } + } + } }, - { - "target": "com.amazonaws.lightsail#DeleteDisk" + "com.amazonaws.lightsail#PortList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#Port" + } }, - { - "target": "com.amazonaws.lightsail#DeleteDiskSnapshot" + "com.amazonaws.lightsail#PortMap": { + "type": "map", + "key": { + "target": "com.amazonaws.lightsail#string" + }, + "value": { + "target": "com.amazonaws.lightsail#ContainerServiceProtocol" + } }, - { - "target": "com.amazonaws.lightsail#DeleteDistribution" + "com.amazonaws.lightsail#PortState": { + "type": "enum", + "members": { + "Open": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "open" + } + }, + "Closed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "closed" + } + } + } }, - { - "target": "com.amazonaws.lightsail#DeleteDomain" + "com.amazonaws.lightsail#PricingUnit": { + "type": "enum", + "members": { + "GB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GB" + } + }, + "Hrs": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Hrs" + } + }, + "GBMo": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GB-Mo" + } + }, + "Bundles": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bundles" + } + }, + "Queries": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Queries" + } + } + } }, - { - "target": "com.amazonaws.lightsail#DeleteDomainEntry" + "com.amazonaws.lightsail#PrivateRegistryAccess": { + "type": "structure", + "members": { + "ecrImagePullerRole": { + "target": "com.amazonaws.lightsail#ContainerServiceECRImagePullerRole", + "traits": { + "smithy.api#documentation": "

An object that describes the activation status of the role that you can use to grant a\n Lightsail container service access to Amazon ECR private\n repositories. If the role is activated, the Amazon Resource Name (ARN) of the role is also\n listed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the configuration for an Amazon Lightsail container service to\n access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.

\n

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

" + } }, - { - "target": "com.amazonaws.lightsail#DeleteInstance" + "com.amazonaws.lightsail#PrivateRegistryAccessRequest": { + "type": "structure", + "members": { + "ecrImagePullerRole": { + "target": "com.amazonaws.lightsail#ContainerServiceECRImagePullerRoleRequest", + "traits": { + "smithy.api#documentation": "

An object to describe a request to activate or deactivate the role that you can use to\n grant an Amazon Lightsail container service access to Amazon Elastic Container Registry\n (Amazon ECR) private repositories.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a request to configure an Amazon Lightsail container service to\n access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.

\n

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

" + } }, - { - "target": "com.amazonaws.lightsail#DeleteInstanceSnapshot" + "com.amazonaws.lightsail#PutAlarm": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#PutAlarmRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#PutAlarmResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates an alarm, and associates it with the specified metric.

\n

An alarm is used to monitor a single metric for one of your resources. When a metric\n condition is met, the alarm can notify you by email, SMS text message, and a banner displayed\n on the Amazon Lightsail console. For more information, see Alarms\n in Amazon Lightsail.

\n

When this action creates an alarm, the alarm state is immediately set to\n INSUFFICIENT_DATA. The alarm is then evaluated and its state is set\n appropriately. Any actions associated with the new state are then executed.

\n

When you update an existing alarm, its state is left unchanged, but the update completely\n overwrites the previous configuration of the alarm. The alarm is then evaluated with the\n updated configuration.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/PutAlarm", + "code": 200 + } + } }, - { - "target": "com.amazonaws.lightsail#DeleteKeyPair" + "com.amazonaws.lightsail#PutAlarmRequest": { + "type": "structure", + "members": { + "alarmName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name for the alarm. Specify the name of an existing alarm to update, and overwrite the\n previous configuration of the alarm.

", + "smithy.api#required": {} + } + }, + "metricName": { + "target": "com.amazonaws.lightsail#MetricName", + "traits": { + "smithy.api#documentation": "

The name of the metric to associate with the alarm.

\n

You can configure up to two alarms per metric.

\n

The following metrics are available for each resource type:

\n \n

For more information about these metrics, see Metrics available in Lightsail.

", + "smithy.api#required": {} + } + }, + "monitoredResourceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the Lightsail resource that will be monitored.

\n

Instances, load balancers, and relational databases are the only Lightsail resources\n that can currently be monitored by alarms.

", + "smithy.api#required": {} + } + }, + "comparisonOperator": { + "target": "com.amazonaws.lightsail#ComparisonOperator", + "traits": { + "smithy.api#documentation": "

The arithmetic operation to use when comparing the specified statistic to the threshold.\n The specified statistic value is used as the first operand.

", + "smithy.api#required": {} + } + }, + "threshold": { + "target": "com.amazonaws.lightsail#double", + "traits": { + "smithy.api#documentation": "

The value against which the specified statistic is compared.

", + "smithy.api#required": {} + } + }, + "evaluationPeriods": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The number of most recent periods over which data is compared to the specified threshold.\n If you are setting an \"M out of N\" alarm, this value (evaluationPeriods) is the\n N.

\n

If you are setting an alarm that requires that a number of consecutive data points be\n breaching to trigger the alarm, this value specifies the rolling period of time in which data\n points are evaluated.

\n

Each evaluation period is five minutes long. For example, specify an evaluation period of\n 24 to evaluate a metric over a rolling period of two hours.

\n

You can specify a minimum valuation period of 1 (5 minutes), and a maximum evaluation\n period of 288 (24 hours).

", + "smithy.api#required": {} + } + }, + "datapointsToAlarm": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The number of data points that must be not within the specified threshold to trigger the\n alarm. If you are setting an \"M out of N\" alarm, this value (datapointsToAlarm)\n is the M.

" + } + }, + "treatMissingData": { + "target": "com.amazonaws.lightsail#TreatMissingData", + "traits": { + "smithy.api#documentation": "

Sets how this alarm will handle missing data points.

\n

An alarm can treat missing data in the following ways:

\n \n

If treatMissingData is not specified, the default behavior of\n missing is used.

" + } + }, + "contactProtocols": { + "target": "com.amazonaws.lightsail#ContactProtocolsList", + "traits": { + "smithy.api#documentation": "

The contact protocols to use for the alarm, such as Email, SMS\n (text messaging), or both.

\n

A notification is sent via the specified contact protocol if notifications are enabled for\n the alarm, and when the alarm is triggered.

\n

A notification is not sent if a contact protocol is not specified, if the specified\n contact protocol is not configured in the Amazon Web Services Region, or if notifications are\n not enabled for the alarm using the notificationEnabled paramater.

\n

Use the CreateContactMethod action to configure a contact protocol in an\n Amazon Web Services Region.

" + } + }, + "notificationTriggers": { + "target": "com.amazonaws.lightsail#NotificationTriggerList", + "traits": { + "smithy.api#documentation": "

The alarm states that trigger a notification.

\n

An alarm has the following possible states:

\n \n

When you specify a notification trigger, the ALARM state must be specified.\n The INSUFFICIENT_DATA and OK states can be specified in addition to\n the ALARM state.

\n \n

The notification trigger defaults to ALARM if you don't specify this\n parameter.

" + } + }, + "notificationEnabled": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the alarm is enabled.

\n

Notifications are enabled by default if you don't specify this parameter.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.lightsail#DeleteKnownHostKeys" + "com.amazonaws.lightsail#PutAlarmResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.lightsail#DeleteLoadBalancer" + "com.amazonaws.lightsail#PutInstancePublicPorts": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#PutInstancePublicPortsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#PutInstancePublicPortsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses\n allowed to connect to the instance through the ports, and the protocol. This action also\n closes all currently open ports that are not included in the request. Include all of the ports\n and the protocols you want to open in your PutInstancePublicPortsrequest. Or use\n the OpenInstancePublicPorts action to open ports without closing currently open\n ports.

\n

The PutInstancePublicPorts action supports tag-based access control via\n resource tags applied to the resource identified by instanceName. For more\n information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/PutInstancePublicPorts", + "code": 200 + } + } }, - { - "target": "com.amazonaws.lightsail#DeleteLoadBalancerTlsCertificate" + "com.amazonaws.lightsail#PutInstancePublicPortsRequest": { + "type": "structure", + "members": { + "portInfos": { + "target": "com.amazonaws.lightsail#PortInfoList", + "traits": { + "smithy.api#documentation": "

An array of objects to describe the ports to open for the specified instance.

", + "smithy.api#required": {} + } + }, + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the instance for which to open ports.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.lightsail#DeleteRelationalDatabase" + "com.amazonaws.lightsail#PutInstancePublicPortsResult": { + "type": "structure", + "members": { + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.lightsail#DeleteRelationalDatabaseSnapshot" + "com.amazonaws.lightsail#QueryStringObject": { + "type": "structure", + "members": { + "option": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the distribution forwards and caches based on query strings.

" + } + }, + "queryStringsAllowList": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

The specific query strings that the distribution forwards to the origin.

\n

Your distribution will cache content based on the specified query strings.

\n

If the option parameter is true, then your distribution forwards all query\n strings, regardless of what you specify using the queryStringsAllowList\n parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the query string parameters that an Amazon Lightsail content delivery network\n (CDN) distribution to bases caching on.

\n

For the query strings that you specify, your distribution caches separate versions of the\n specified content based on the query string values in viewer\n requests.

" + } }, - { - "target": "com.amazonaws.lightsail#DetachCertificateFromDistribution" + "com.amazonaws.lightsail#R53HostedZoneDeletionState": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.lightsail#R53HostedZoneDeletionStateCode", + "traits": { + "smithy.api#documentation": "

The status code for the deletion state.

\n

Following are the possible values:

\n " + } + }, + "message": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The message that describes the reason for the status code.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the deletion state of an Amazon Route 53 hosted zone for a domain that is\n being automatically delegated to an Amazon Lightsail DNS zone.

" + } }, - { - "target": "com.amazonaws.lightsail#DetachDisk" + "com.amazonaws.lightsail#R53HostedZoneDeletionStateCode": { + "type": "enum", + "members": { + "Succeeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "Started": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTED" + } + } + } }, - { - "target": "com.amazonaws.lightsail#DetachInstancesFromLoadBalancer" + "com.amazonaws.lightsail#RebootInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#RebootInstanceRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#RebootInstanceResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Restarts a specific instance.

\n

The reboot instance operation supports tag-based access control via resource\n tags applied to the resource identified by instance name. For more information,\n see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/RebootInstance", + "code": 200 + } + } }, - { - "target": "com.amazonaws.lightsail#DetachStaticIp" + "com.amazonaws.lightsail#RebootInstanceRequest": { + "type": "structure", + "members": { + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the instance to reboot.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.lightsail#DisableAddOn" + "com.amazonaws.lightsail#RebootInstanceResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.lightsail#DownloadDefaultKeyPair" + "com.amazonaws.lightsail#RebootRelationalDatabase": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#RebootRelationalDatabaseRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#RebootRelationalDatabaseResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Restarts a specific database in Amazon Lightsail.

\n

The reboot relational database operation supports tag-based access control\n via resource tags applied to the resource identified by relationalDatabaseName. For more\n information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/RebootRelationalDatabase", + "code": 200 + } + } }, - { - "target": "com.amazonaws.lightsail#EnableAddOn" + "com.amazonaws.lightsail#RebootRelationalDatabaseRequest": { + "type": "structure", + "members": { + "relationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of your database to reboot.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.lightsail#ExportSnapshot" + "com.amazonaws.lightsail#RebootRelationalDatabaseResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.lightsail#GetActiveNames" + "com.amazonaws.lightsail#RecordState": { + "type": "enum", + "members": { + "Started": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Started" + } + }, + "Succeeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Succeeded" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } + } }, - { - "target": "com.amazonaws.lightsail#GetAlarms" + "com.amazonaws.lightsail#Region": { + "type": "structure", + "members": { + "continentCode": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "description": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "displayName": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "name": { + "target": "com.amazonaws.lightsail#RegionName", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "availabilityZones": { + "target": "com.amazonaws.lightsail#AvailabilityZoneList", + "traits": { + "smithy.api#documentation": "

The Availability Zones. Follows the format us-east-2a\n (case-sensitive).

" + } + }, + "relationalDatabaseAvailabilityZones": { + "target": "com.amazonaws.lightsail#AvailabilityZoneList", + "traits": { + "smithy.api#documentation": "

The Availability Zones for databases. Follows the format us-east-2a\n (case-sensitive).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the Amazon Web Services Region.

" + } }, - { - "target": "com.amazonaws.lightsail#GetAutoSnapshots" + "com.amazonaws.lightsail#RegionList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#Region" + } }, - { - "target": "com.amazonaws.lightsail#GetBlueprints" + "com.amazonaws.lightsail#RegionName": { + "type": "enum", + "members": { + "US_EAST_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-east-1" + } + }, + "US_EAST_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-east-2" + } + }, + "US_WEST_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-west-1" + } + }, + "US_WEST_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-west-2" + } + }, + "EU_WEST_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-1" + } + }, + "EU_WEST_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-2" + } + }, + "EU_WEST_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-3" + } + }, + "EU_CENTRAL_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-central-1" + } + }, + "CA_CENTRAL_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ca-central-1" + } + }, + "AP_SOUTH_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-south-1" + } + }, + "AP_SOUTHEAST_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-1" + } + }, + "AP_SOUTHEAST_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-2" + } + }, + "AP_NORTHEAST_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-1" + } + }, + "AP_NORTHEAST_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-2" + } + }, + "EU_NORTH_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-north-1" + } + } + } }, - { - "target": "com.amazonaws.lightsail#GetBucketAccessKeys" + "com.amazonaws.lightsail#RegisterContainerImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#RegisterContainerImageRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#RegisterContainerImageResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Registers a container image to your Amazon Lightsail container service.

\n \n

This action is not required if you install and use the Lightsail Control\n (lightsailctl) plugin to push container images to your Lightsail container service. For\n more information, see Pushing and managing container images on your Amazon Lightsail container services\n in the Amazon Lightsail Developer Guide.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/container-services/{serviceName}/images", + "code": 200 + } + } }, - { - "target": "com.amazonaws.lightsail#GetBucketBundles" + "com.amazonaws.lightsail#RegisterContainerImageRequest": { + "type": "structure", + "members": { + "serviceName": { + "target": "com.amazonaws.lightsail#ContainerServiceName", + "traits": { + "smithy.api#documentation": "

The name of the container service for which to register a container image.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "label": { + "target": "com.amazonaws.lightsail#ContainerLabel", + "traits": { + "smithy.api#documentation": "

The label for the container image when it's registered to the container service.

\n

Use a descriptive label that you can use to track the different versions of your\n registered container images.

\n

Use the GetContainerImages action to return the container images registered\n to a Lightsail container service. The label is the portion\n of the following image name example:

\n \n

If the name of your container service is mycontainerservice, and the label\n that you specify is mystaticwebsite, then the name of the registered container\n image will be :mycontainerservice.mystaticwebsite.1.

\n

The number at the end of these image name examples represents the version of the\n registered container image. If you push and register another container image to the same\n Lightsail container service, with the same label, then the version number for the new\n registered container image will be 2. If you push and register another container\n image, the version number will be 3, and so on.

", + "smithy.api#required": {} + } + }, + "digest": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The digest of the container image to be registered.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.lightsail#GetBucketMetricData" + "com.amazonaws.lightsail#RegisterContainerImageResult": { + "type": "structure", + "members": { + "containerImage": { + "target": "com.amazonaws.lightsail#ContainerImage", + "traits": { + "smithy.api#documentation": "

An object that describes a container image that is registered to a Lightsail container\n service

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.lightsail#GetBuckets" + "com.amazonaws.lightsail#RegisteredDomainDelegationInfo": { + "type": "structure", + "members": { + "nameServersUpdateState": { + "target": "com.amazonaws.lightsail#NameServersUpdateState", + "traits": { + "smithy.api#documentation": "

An object that describes the state of the name server records that are automatically added\n to the Route 53 domain by Lightsail.

" + } + }, + "r53HostedZoneDeletionState": { + "target": "com.amazonaws.lightsail#R53HostedZoneDeletionState", + "traits": { + "smithy.api#documentation": "

Describes the deletion state of an Amazon Route 53 hosted zone for a domain that is\n being automatically delegated to an Amazon Lightsail DNS zone.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the delegation state of an Amazon Route 53 registered domain to Amazon Lightsail.

\n

When you delegate an Amazon Route 53 registered domain to Lightsail,\n you can manage the DNS of the domain using a Lightsail DNS zone. You no longer\n use the Route 53 hosted zone to manage the DNS of the domain. To delegate the\n domain, Lightsail automatically updates the domain's name servers in Route 53 to the name servers of the Lightsail DNS zone. Then, Lightsail automatically deletes the Route 53 hosted zone for the\n domain.

\n

All of the following conditions must be true for automatic domain delegation to be\n successful:

\n \n

If automatic domain delegation fails, or if you manage the DNS of your domain using a\n service other than Route 53, then you must manually add the Lightsail\n DNS zone name servers to your domain in order to delegate management of its DNS to Lightsail. For more information, see Creating a DNS zone to manage your domain’s records in Amazon Lightsail\n in the Amazon Lightsail Developer Guide.

" + } }, - { - "target": "com.amazonaws.lightsail#GetBundles" + "com.amazonaws.lightsail#RelationalDatabase": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The unique name of the database resource in Lightsail.

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the database.

" + } + }, + "supportCode": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The support code for the database. Include this code in your email to support when you\n have questions about a database in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the database was created. Formatted in Unix time.

" + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

The Region name and Availability Zone where the database is located.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The Lightsail resource type for the database (for example,\n RelationalDatabase).

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" + } + }, + "relationalDatabaseBlueprintId": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The blueprint ID for the database. A blueprint describes the major engine version of a\n database.

" + } + }, + "relationalDatabaseBundleId": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The bundle ID for the database. A bundle describes the performance specifications for your\n database.

" + } + }, + "masterDatabaseName": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The name of the master database created when the Lightsail database resource is\n created.

" + } + }, + "hardware": { + "target": "com.amazonaws.lightsail#RelationalDatabaseHardware", + "traits": { + "smithy.api#documentation": "

Describes the hardware of the database.

" + } + }, + "state": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Describes the current state of the database.

" + } + }, + "secondaryAvailabilityZone": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

Describes the secondary Availability Zone of a high availability database.

\n

The secondary database is used for failover support of a high availability\n database.

" + } + }, + "backupRetentionEnabled": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether automated backup retention is enabled for the\n database.

" + } + }, + "pendingModifiedValues": { + "target": "com.amazonaws.lightsail#PendingModifiedRelationalDatabaseValues", + "traits": { + "smithy.api#documentation": "

Describes pending database value modifications.

" + } + }, + "engine": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The database software (for example, MySQL).

" + } + }, + "engineVersion": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The database engine version (for example, 5.7.23).

" + } + }, + "latestRestorableTime": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The latest point in time to which the database can be restored. Formatted in Unix\n time.

" + } + }, + "masterUsername": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The master user name of the database.

" + } + }, + "parameterApplyStatus": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of parameter updates for the database.

" + } + }, + "preferredBackupWindow": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The daily time range during which automated backups are created for the database (for\n example, 16:00-16:30).

" + } + }, + "preferredMaintenanceWindow": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur on the database.

\n

In the format ddd:hh24:mi-ddd:hh24:mi. For example,\n Tue:17:00-Tue:17:30.

" + } + }, + "publiclyAccessible": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether the database is publicly accessible.

" + } + }, + "masterEndpoint": { + "target": "com.amazonaws.lightsail#RelationalDatabaseEndpoint", + "traits": { + "smithy.api#documentation": "

The master endpoint for the database.

" + } + }, + "pendingMaintenanceActions": { + "target": "com.amazonaws.lightsail#PendingMaintenanceActionList", + "traits": { + "smithy.api#documentation": "

Describes the pending maintenance actions for the database.

" + } + }, + "caCertificateIdentifier": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The certificate associated with the database.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a database.

" + } }, - { - "target": "com.amazonaws.lightsail#GetCertificates" + "com.amazonaws.lightsail#RelationalDatabaseBlueprint": { + "type": "structure", + "members": { + "blueprintId": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The ID for the database blueprint.

" + } + }, + "engine": { + "target": "com.amazonaws.lightsail#RelationalDatabaseEngine", + "traits": { + "smithy.api#documentation": "

The database software of the database blueprint (for example, MySQL).

" + } + }, + "engineVersion": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The database engine version for the database blueprint (for example,\n 5.7.23).

" + } + }, + "engineDescription": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The description of the database engine for the database blueprint.

" + } + }, + "engineVersionDescription": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The description of the database engine version for the database blueprint.

" + } + }, + "isEngineDefault": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether the engine version is the default for the database\n blueprint.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a database image, or blueprint. A blueprint describes the major engine version\n of a database.

" + } }, - { - "target": "com.amazonaws.lightsail#GetCloudFormationStackRecords" + "com.amazonaws.lightsail#RelationalDatabaseBlueprintList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#RelationalDatabaseBlueprint" + } }, - { - "target": "com.amazonaws.lightsail#GetContactMethods" + "com.amazonaws.lightsail#RelationalDatabaseBundle": { + "type": "structure", + "members": { + "bundleId": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The ID for the database bundle.

" + } + }, + "name": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The name for the database bundle.

" + } + }, + "price": { + "target": "com.amazonaws.lightsail#float", + "traits": { + "smithy.api#documentation": "

The cost of the database bundle in US currency.

" + } + }, + "ramSizeInGb": { + "target": "com.amazonaws.lightsail#float", + "traits": { + "smithy.api#documentation": "

The amount of RAM in GB (for example, 2.0) for the database bundle.

" + } + }, + "diskSizeInGb": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The size of the disk for the database bundle.

" + } + }, + "transferPerMonthInGb": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The data transfer rate per month in GB for the database bundle.

" + } + }, + "cpuCount": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The number of virtual CPUs (vCPUs) for the database bundle.

" + } + }, + "isEncrypted": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether the database bundle is encrypted.

" + } + }, + "isActive": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether the database bundle is active.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a database bundle. A bundle describes the performance specifications of the\n database.

" + } }, - { - "target": "com.amazonaws.lightsail#GetContainerAPIMetadata" + "com.amazonaws.lightsail#RelationalDatabaseBundleList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#RelationalDatabaseBundle" + } }, - { - "target": "com.amazonaws.lightsail#GetContainerImages" + "com.amazonaws.lightsail#RelationalDatabaseEndpoint": { + "type": "structure", + "members": { + "port": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

Specifies the port that the database is listening on.

" + } + }, + "address": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Specifies the DNS address of the database.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an endpoint for a database.

" + } }, - { - "target": "com.amazonaws.lightsail#GetContainerLog" + "com.amazonaws.lightsail#RelationalDatabaseEngine": { + "type": "enum", + "members": { + "MYSQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mysql" + } + } + } }, - { - "target": "com.amazonaws.lightsail#GetContainerServiceDeployments" + "com.amazonaws.lightsail#RelationalDatabaseEvent": { + "type": "structure", + "members": { + "resource": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The database that the database event relates to.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the database event was created.

" + } + }, + "message": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The message of the database event.

" + } + }, + "eventCategories": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

The category that the database event belongs to.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an event for a database.

" + } }, - { - "target": "com.amazonaws.lightsail#GetContainerServiceMetricData" + "com.amazonaws.lightsail#RelationalDatabaseEventList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#RelationalDatabaseEvent" + } }, - { - "target": "com.amazonaws.lightsail#GetContainerServicePowers" + "com.amazonaws.lightsail#RelationalDatabaseHardware": { + "type": "structure", + "members": { + "cpuCount": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The number of vCPUs for the database.

" + } + }, + "diskSizeInGb": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The size of the disk for the database.

" + } + }, + "ramSizeInGb": { + "target": "com.amazonaws.lightsail#float", + "traits": { + "smithy.api#documentation": "

The amount of RAM in GB for the database.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the hardware of a database.

" + } }, - { - "target": "com.amazonaws.lightsail#GetContainerServices" + "com.amazonaws.lightsail#RelationalDatabaseList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#RelationalDatabase" + } }, - { - "target": "com.amazonaws.lightsail#GetCostEstimate" + "com.amazonaws.lightsail#RelationalDatabaseMetricName": { + "type": "enum", + "members": { + "CPUUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CPUUtilization" + } + }, + "DatabaseConnections": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DatabaseConnections" + } + }, + "DiskQueueDepth": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DiskQueueDepth" + } + }, + "FreeStorageSpace": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FreeStorageSpace" + } + }, + "NetworkReceiveThroughput": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NetworkReceiveThroughput" + } + }, + "NetworkTransmitThroughput": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NetworkTransmitThroughput" + } + } + } }, - { - "target": "com.amazonaws.lightsail#GetDisk" + "com.amazonaws.lightsail#RelationalDatabaseParameter": { + "type": "structure", + "members": { + "allowedValues": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

Specifies the valid range of values for the parameter.

" + } + }, + "applyMethod": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

Indicates when parameter updates are applied.

\n

Can be immediate or pending-reboot.

" + } + }, + "applyType": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

Specifies the engine-specific parameter type.

" + } + }, + "dataType": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

Specifies the valid data type for the parameter.

" + } + }, + "description": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

Provides a description of the parameter.

" + } + }, + "isModifiable": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether the parameter can be modified.

" + } + }, + "parameterName": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

Specifies the name of the parameter.

" + } + }, + "parameterValue": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

Specifies the value of the parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the parameters of a database.

" + } }, - { - "target": "com.amazonaws.lightsail#GetDisks" + "com.amazonaws.lightsail#RelationalDatabaseParameterList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#RelationalDatabaseParameter" + } }, - { - "target": "com.amazonaws.lightsail#GetDiskSnapshot" + "com.amazonaws.lightsail#RelationalDatabasePasswordVersion": { + "type": "enum", + "members": { + "CURRENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CURRENT" + } + }, + "PREVIOUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREVIOUS" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + } + } }, - { - "target": "com.amazonaws.lightsail#GetDiskSnapshots" + "com.amazonaws.lightsail#RelationalDatabaseSnapshot": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the database snapshot.

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the database snapshot.

" + } + }, + "supportCode": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The support code for the database snapshot. Include this code in your email to support\n when you have questions about a database snapshot in Lightsail. This code enables our\n support team to look up your Lightsail information more easily.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the database snapshot was created.

" + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

The Region name and Availability Zone where the database snapshot is located.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The Lightsail resource type.

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" + } + }, + "engine": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The software of the database snapshot (for example, MySQL)

" + } + }, + "engineVersion": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The database engine version for the database snapshot (for example,\n 5.7.23).

" + } + }, + "sizeInGb": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The size of the disk in GB (for example, 32) for the database\n snapshot.

" + } + }, + "state": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The state of the database snapshot.

" + } + }, + "fromRelationalDatabaseName": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the source database from which the database snapshot was created.

" + } + }, + "fromRelationalDatabaseArn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the database from which the database snapshot was\n created.

" + } + }, + "fromRelationalDatabaseBundleId": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The bundle ID of the database from which the database snapshot was created.

" + } + }, + "fromRelationalDatabaseBlueprintId": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The blueprint ID of the database from which the database snapshot was created. A blueprint\n describes the major engine version of a database.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a database snapshot.

" + } }, - { - "target": "com.amazonaws.lightsail#GetDistributionBundles" + "com.amazonaws.lightsail#RelationalDatabaseSnapshotList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#RelationalDatabaseSnapshot" + } }, - { - "target": "com.amazonaws.lightsail#GetDistributionLatestCacheReset" + "com.amazonaws.lightsail#ReleaseStaticIp": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#ReleaseStaticIpRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#ReleaseStaticIpResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a specific static IP from your account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/ReleaseStaticIp", + "code": 200 + } + } }, - { - "target": "com.amazonaws.lightsail#GetDistributionMetricData" + "com.amazonaws.lightsail#ReleaseStaticIpRequest": { + "type": "structure", + "members": { + "staticIpName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the static IP to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.lightsail#GetDistributions" + "com.amazonaws.lightsail#ReleaseStaticIpResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.lightsail#GetDomain" + "com.amazonaws.lightsail#RenewalStatus": { + "type": "enum", + "members": { + "PendingAutoRenewal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PendingAutoRenewal" + } + }, + "PendingValidation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PendingValidation" + } + }, + "Success": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Success" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } + } }, - { - "target": "com.amazonaws.lightsail#GetDomains" + "com.amazonaws.lightsail#RenewalStatusReason": { + "type": "string" }, - { - "target": "com.amazonaws.lightsail#GetExportSnapshotRecords" + "com.amazonaws.lightsail#RenewalSummary": { + "type": "structure", + "members": { + "domainValidationRecords": { + "target": "com.amazonaws.lightsail#DomainValidationRecordList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the domain validation records of the certificate.

" + } + }, + "renewalStatus": { + "target": "com.amazonaws.lightsail#RenewalStatus", + "traits": { + "smithy.api#documentation": "

The renewal status of the certificate.

\n

The following renewal status are possible:

\n " + } + }, + "renewalStatusReason": { + "target": "com.amazonaws.lightsail#RenewalStatusReason", + "traits": { + "smithy.api#documentation": "

The reason for the renewal status of the certificate.

" + } + }, + "updatedAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the certificate was last updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the status of a SSL/TLS certificate renewal managed by Amazon Lightsail.

" + } }, - { - "target": "com.amazonaws.lightsail#GetInstance" + "com.amazonaws.lightsail#RequestFailureReason": { + "type": "string" }, - { - "target": "com.amazonaws.lightsail#GetInstanceAccessDetails" + "com.amazonaws.lightsail#ResetDistributionCache": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#ResetDistributionCacheRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#ResetDistributionCacheResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes currently cached content from your Amazon Lightsail content delivery network (CDN)\n distribution.

\n

After resetting the cache, the next time a content request is made, your distribution\n pulls, serves, and caches it from the origin.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/ResetDistributionCache", + "code": 200 + } + } }, - { - "target": "com.amazonaws.lightsail#GetInstanceMetricData" + "com.amazonaws.lightsail#ResetDistributionCacheRequest": { + "type": "structure", + "members": { + "distributionName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the distribution for which to reset cache.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.lightsail#GetInstancePortStates" + "com.amazonaws.lightsail#ResetDistributionCacheResult": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The status of the reset cache request.

" + } + }, + "createTime": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp of the reset cache request (e.g., 1479734909.17) in Unix time\n format.

" + } + }, + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.lightsail#GetInstances" + "com.amazonaws.lightsail#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:(aws[^:]*):([a-zA-Z0-9-]+):([a-z0-9-]+):([0-9]+):([a-zA-Z]+)/([a-zA-Z0-9-]+)$" + } }, - { - "target": "com.amazonaws.lightsail#GetInstanceSnapshot" + "com.amazonaws.lightsail#ResourceBucketAccess": { + "type": "enum", + "members": { + "Allow": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "allow" + } + }, + "Deny": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deny" + } + } + } }, - { - "target": "com.amazonaws.lightsail#GetInstanceSnapshots" + "com.amazonaws.lightsail#ResourceBudgetEstimate": { + "type": "structure", + "members": { + "resourceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The resource name.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The type of resource the budget will track.

" + } + }, + "costEstimates": { + "target": "com.amazonaws.lightsail#CostEstimates", + "traits": { + "smithy.api#documentation": "

The cost estimate for the specified budget.

" + } + }, + "startTime": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The estimate start time.

" + } + }, + "endTime": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The estimate end time.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the estimated cost or usage that a budget tracks.

" + } }, - { - "target": "com.amazonaws.lightsail#GetInstanceState" + "com.amazonaws.lightsail#ResourceLocation": { + "type": "structure", + "members": { + "availabilityZone": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The Availability Zone. Follows the format us-east-2a (case-sensitive).

" + } + }, + "regionName": { + "target": "com.amazonaws.lightsail#RegionName", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region name.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the resource location.

" + } }, - { - "target": "com.amazonaws.lightsail#GetKeyPair" + "com.amazonaws.lightsail#ResourceName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\w[\\w\\-]*\\w$" + } }, - { - "target": "com.amazonaws.lightsail#GetKeyPairs" + "com.amazonaws.lightsail#ResourceNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#ResourceName" + } }, - { - "target": "com.amazonaws.lightsail#GetLoadBalancer" + "com.amazonaws.lightsail#ResourceReceivingAccess": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the Lightsail instance.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Lightsail resource type (for example, Instance).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an Amazon Lightsail instance that has access to a Lightsail bucket.

" + } }, - { - "target": "com.amazonaws.lightsail#GetLoadBalancerMetricData" + "com.amazonaws.lightsail#ResourceRecord": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The name of the record.

" + } + }, + "type": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The DNS record type.

" + } + }, + "value": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The value for the DNS record.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the domain name system (DNS) records to add to your domain's DNS to validate it\n for an Amazon Lightsail certificate.

" + } }, - { - "target": "com.amazonaws.lightsail#GetLoadBalancers" + "com.amazonaws.lightsail#ResourceType": { + "type": "enum", + "members": { + "ContainerService": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ContainerService" + } + }, + "Instance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Instance" + } + }, + "StaticIp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StaticIp" + } + }, + "KeyPair": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KeyPair" + } + }, + "InstanceSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InstanceSnapshot" + } + }, + "Domain": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Domain" + } + }, + "PeeredVpc": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PeeredVpc" + } + }, + "LoadBalancer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LoadBalancer" + } + }, + "LoadBalancerTlsCertificate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LoadBalancerTlsCertificate" + } + }, + "Disk": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disk" + } + }, + "DiskSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DiskSnapshot" + } + }, + "RelationalDatabase": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RelationalDatabase" + } + }, + "RelationalDatabaseSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RelationalDatabaseSnapshot" + } + }, + "ExportSnapshotRecord": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExportSnapshotRecord" + } + }, + "CloudFormationStackRecord": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CloudFormationStackRecord" + } + }, + "Alarm": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Alarm" + } + }, + "ContactMethod": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ContactMethod" + } + }, + "Distribution": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Distribution" + } + }, + "Certificate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Certificate" + } + }, + "Bucket": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bucket" + } + } + } }, - { - "target": "com.amazonaws.lightsail#GetLoadBalancerTlsCertificates" + "com.amazonaws.lightsail#ResourcesBudgetEstimate": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#ResourceBudgetEstimate" + } }, - { - "target": "com.amazonaws.lightsail#GetLoadBalancerTlsPolicies" + "com.amazonaws.lightsail#RevocationReason": { + "type": "string" }, - { - "target": "com.amazonaws.lightsail#GetOperation" + "com.amazonaws.lightsail#SendContactMethodVerification": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#SendContactMethodVerificationRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#SendContactMethodVerificationResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Sends a verification request to an email contact method to ensure it's owned by the\n requester. SMS contact methods don't need to be verified.

\n

A contact method is used to send you notifications about your Amazon Lightsail resources.\n You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services\n Regions, and SMS text messages cannot be sent to some countries/regions. For more information,\n see Notifications in Amazon Lightsail.

\n

A verification request is sent to the contact method when you initially create it. Use\n this action to send another verification request if a previous verification request was\n deleted, or has expired.

\n \n

Notifications are not sent to an email contact method until after it is verified, and\n confirmed as valid.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/SendContactMethodVerification", + "code": 200 + } + } }, - { - "target": "com.amazonaws.lightsail#GetOperations" + "com.amazonaws.lightsail#SendContactMethodVerificationRequest": { + "type": "structure", + "members": { + "protocol": { + "target": "com.amazonaws.lightsail#ContactMethodVerificationProtocol", + "traits": { + "smithy.api#documentation": "

The protocol to verify, such as Email or SMS (text\n messaging).

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.lightsail#GetOperationsForResource" + "com.amazonaws.lightsail#SendContactMethodVerificationResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.lightsail#GetRegions" + "com.amazonaws.lightsail#SensitiveNonEmptyString": { + "type": "string", + "traits": { + "smithy.api#pattern": "\\S", + "smithy.api#sensitive": {} + } }, - { - "target": "com.amazonaws.lightsail#GetRelationalDatabase" + "com.amazonaws.lightsail#SensitiveString": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } }, - { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseBlueprints" + "com.amazonaws.lightsail#SerialNumber": { + "type": "string" }, - { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseBundles" + "com.amazonaws.lightsail#ServiceException": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.lightsail#string" + }, + "docs": { + "target": "com.amazonaws.lightsail#string" + }, + "message": { + "target": "com.amazonaws.lightsail#string" + }, + "tip": { + "target": "com.amazonaws.lightsail#string" + } + }, + "traits": { + "smithy.api#documentation": "

A general service exception.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } }, - { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseEvents" + "com.amazonaws.lightsail#Session": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The session name.

" + } + }, + "url": { + "target": "com.amazonaws.lightsail#SensitiveNonEmptyString", + "traits": { + "smithy.api#documentation": "

The session URL.

" + } + }, + "isPrimary": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

When true, this Boolean value indicates the primary session for the specified\n resource.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a web-based, remote graphical user interface (GUI), NICE DCV session. The session is used to access a virtual\n computer’s operating system or application.

" + } }, - { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseLogEvents" + "com.amazonaws.lightsail#Sessions": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#Session" + } }, - { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseLogStreams" + "com.amazonaws.lightsail#SetIpAddressType": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#SetIpAddressTypeRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#SetIpAddressTypeResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Sets the IP address type for an Amazon Lightsail resource.

\n

Use this action to enable dual-stack for a resource, which enables IPv4 and IPv6 for the\n specified resource. Alternately, you can use this action to disable dual-stack, and enable\n IPv4 only.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/SetIpAddressType", + "code": 200 + } + } }, - { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseMasterUserPassword" + "com.amazonaws.lightsail#SetIpAddressTypeRequest": { + "type": "structure", + "members": { + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The resource type.

\n

The possible values are Distribution, Instance, and\n LoadBalancer.

\n \n

Distribution-related APIs are available only in the N. Virginia (us-east-1)\n Amazon Web Services Region. Set your Amazon Web Services Region configuration to\n us-east-1 to create, view, or edit distributions.

\n ", + "smithy.api#required": {} + } + }, + "resourceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the resource for which to set the IP address type.

", + "smithy.api#required": {} + } + }, + "ipAddressType": { + "target": "com.amazonaws.lightsail#IpAddressType", + "traits": { + "smithy.api#documentation": "

The IP address type to set for the specified resource.

\n

The possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseMetricData" + "com.amazonaws.lightsail#SetIpAddressTypeResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseParameters" + "com.amazonaws.lightsail#SetResourceAccessForBucket": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#SetResourceAccessForBucketRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#SetResourceAccessForBucketResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Sets the Amazon Lightsail resources that can access the specified Lightsail\n bucket.

\n

Lightsail buckets currently support setting access for Lightsail instances in the same\n Amazon Web Services Region.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/SetResourceAccessForBucket", + "code": 200 + } + } }, - { - "target": "com.amazonaws.lightsail#GetRelationalDatabases" + "com.amazonaws.lightsail#SetResourceAccessForBucketRequest": { + "type": "structure", + "members": { + "resourceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the Lightsail instance for which to set bucket access. The instance must be\n in a running or stopped state.

", + "smithy.api#required": {} + } + }, + "bucketName": { + "target": "com.amazonaws.lightsail#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket for which to set access to another Lightsail resource.

", + "smithy.api#required": {} + } + }, + "access": { + "target": "com.amazonaws.lightsail#ResourceBucketAccess", + "traits": { + "smithy.api#documentation": "

The access setting.

\n

The following access settings are available:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseSnapshot" + "com.amazonaws.lightsail#SetResourceAccessForBucketResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseSnapshots" + "com.amazonaws.lightsail#StartGUISession": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#StartGUISessionRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#StartGUISessionResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Initiates a graphical user interface (GUI) session that’s used to access a virtual\n computer’s operating system and application. The session will be active for 1 hour. Use this action to resume the session after it expires.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/start-gui-session", + "code": 200 + } + } }, - { - "target": "com.amazonaws.lightsail#GetStaticIp" + "com.amazonaws.lightsail#StartGUISessionRequest": { + "type": "structure", + "members": { + "resourceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The resource name.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.lightsail#GetStaticIps" + "com.amazonaws.lightsail#StartGUISessionResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

The available API operations.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.lightsail#ImportKeyPair" + "com.amazonaws.lightsail#StartInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#StartInstanceRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#StartInstanceResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

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

\n \n

When you start a stopped instance, Lightsail assigns a new public IP address to the\n instance. To use the same IP address after stopping and starting an instance, create a\n static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide.

\n \n

The start instance operation supports tag-based access control via resource\n tags applied to the resource identified by instance name. For more information,\n see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/StartInstance", + "code": 200 + } + } }, - { - "target": "com.amazonaws.lightsail#IsVpcPeered" + "com.amazonaws.lightsail#StartInstanceRequest": { + "type": "structure", + "members": { + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.lightsail#OpenInstancePublicPorts" + "com.amazonaws.lightsail#StartInstanceResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.lightsail#PeerVpc" + "com.amazonaws.lightsail#StartRelationalDatabase": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#StartRelationalDatabaseRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#StartRelationalDatabaseResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a specific database from a stopped state in Amazon Lightsail. To restart a database,\n use the reboot relational database operation.

\n

The start relational database operation supports tag-based access control via\n resource tags applied to the resource identified by relationalDatabaseName. For more\n information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/StartRelationalDatabase", + "code": 200 + } + } }, - { - "target": "com.amazonaws.lightsail#PutAlarm" + "com.amazonaws.lightsail#StartRelationalDatabaseRequest": { + "type": "structure", + "members": { + "relationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of your database to start.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.lightsail#PutInstancePublicPorts" + "com.amazonaws.lightsail#StartRelationalDatabaseResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.lightsail#RebootInstance" + "com.amazonaws.lightsail#StaticIp": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "supportCode": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The resource type (usually StaticIp).

" + } + }, + "ipAddress": { + "target": "com.amazonaws.lightsail#IpAddress", + "traits": { + "smithy.api#documentation": "

The static IP address.

" + } + }, + "attachedTo": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "isAttached": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether the static IP is attached.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a static IP.

" + } }, - { - "target": "com.amazonaws.lightsail#RebootRelationalDatabase" + "com.amazonaws.lightsail#StaticIpList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#StaticIp" + } }, - { - "target": "com.amazonaws.lightsail#RegisterContainerImage" + "com.amazonaws.lightsail#Status": { + "type": "enum", + "members": { + "StartExpired": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "startExpired" + } + }, + "NotStarted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "notStarted" + } + }, + "Started": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "started" + } + }, + "Starting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "starting" + } + }, + "Stopped": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stopped" + } + }, + "Stopping": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stopping" + } + }, + "SettingUpInstance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "settingUpInstance" + } + }, + "FailedInstanceCreation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failedInstanceCreation" + } + }, + "FailedStartingGUISession": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failedStartingGUISession" + } + }, + "FailedStoppingGUISession": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failedStoppingGUISession" + } + } + } }, - { - "target": "com.amazonaws.lightsail#ReleaseStaticIp" + "com.amazonaws.lightsail#StatusType": { + "type": "enum", + "members": { + "Active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + }, + "Inactive": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Inactive" + } + } + } }, - { - "target": "com.amazonaws.lightsail#ResetDistributionCache" + "com.amazonaws.lightsail#StopGUISession": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#StopGUISessionRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#StopGUISessionResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Terminates a web-based NICE DCV session that’s used to access a virtual computer’s\n operating system or application. The session will close and any unsaved data will be lost.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/stop-gui-session", + "code": 200 + } + } }, - { - "target": "com.amazonaws.lightsail#SendContactMethodVerification" + "com.amazonaws.lightsail#StopGUISessionRequest": { + "type": "structure", + "members": { + "resourceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The resource name.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.lightsail#SetIpAddressType" + "com.amazonaws.lightsail#StopGUISessionResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

The available API operations.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.lightsail#SetResourceAccessForBucket" + "com.amazonaws.lightsail#StopInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#StopInstanceRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#StopInstanceResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops a specific Amazon Lightsail instance that is currently running.

\n \n

When you start a stopped instance, Lightsail assigns a new public IP address to the\n instance. To use the same IP address after stopping and starting an instance, create a\n static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide.

\n \n

The stop instance operation supports tag-based access control via resource\n tags applied to the resource identified by instance name. For more information,\n see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/StopInstance", + "code": 200 + } + } }, - { - "target": "com.amazonaws.lightsail#StartGUISession" + "com.amazonaws.lightsail#StopInstanceOnIdleRequest": { + "type": "structure", + "members": { + "threshold": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The value to compare with the duration.

" + } + }, + "duration": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The amount of idle time in minutes after which your virtual computer will automatically stop.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a request to create or edit the StopInstanceOnIdle add-on.

\n \n

This add-on only applies to Lightsail for Research resources.

\n " + } }, - { - "target": "com.amazonaws.lightsail#StartInstance" + "com.amazonaws.lightsail#StopInstanceRequest": { + "type": "structure", + "members": { + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + }, + "force": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

When set to True, forces a Lightsail instance that is stuck in a\n stopping state to stop.

\n \n

Only use the force parameter if your instance is stuck in the\n stopping state. In any other state, your instance should stop normally\n without adding this parameter to your API request.

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.lightsail#StartRelationalDatabase" + "com.amazonaws.lightsail#StopInstanceResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.lightsail#StopGUISession" + "com.amazonaws.lightsail#StopRelationalDatabase": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#StopRelationalDatabaseRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#StopRelationalDatabaseResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops a specific database that is currently running in Amazon Lightsail.

\n

The stop relational database operation supports tag-based access control via\n resource tags applied to the resource identified by relationalDatabaseName. For more\n information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/StopRelationalDatabase", + "code": 200 + } + } }, - { - "target": "com.amazonaws.lightsail#StopInstance" + "com.amazonaws.lightsail#StopRelationalDatabaseRequest": { + "type": "structure", + "members": { + "relationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of your database to stop.

", + "smithy.api#required": {} + } + }, + "relationalDatabaseSnapshotName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of your new database snapshot to be created before stopping your database.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.lightsail#StopRelationalDatabase" + "com.amazonaws.lightsail#StopRelationalDatabaseResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.lightsail#TagResource" + "com.amazonaws.lightsail#StringList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#string" + } }, - { - "target": "com.amazonaws.lightsail#TestAlarm" + "com.amazonaws.lightsail#StringMax256": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } }, - { - "target": "com.amazonaws.lightsail#UnpeerVpc" + "com.amazonaws.lightsail#SubjectAlternativeNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#DomainName" + } }, - { - "target": "com.amazonaws.lightsail#UntagResource" + "com.amazonaws.lightsail#Tag": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.lightsail#TagKey", + "traits": { + "smithy.api#documentation": "

The key of the tag.

\n

Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the\n following characters: + - = . _ : / @

" + } + }, + "value": { + "target": "com.amazonaws.lightsail#TagValue", + "traits": { + "smithy.api#documentation": "

The value of the tag.

\n

Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the\n following characters: + - = . _ : / @

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a tag key and optional value assigned to an Amazon Lightsail resource.

\n

For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

" + } }, - { - "target": "com.amazonaws.lightsail#UpdateBucket" + "com.amazonaws.lightsail#TagKey": { + "type": "string" }, - { - "target": "com.amazonaws.lightsail#UpdateBucketBundle" + "com.amazonaws.lightsail#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#TagKey" + } }, - { - "target": "com.amazonaws.lightsail#UpdateContainerService" + "com.amazonaws.lightsail#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#Tag" + } }, - { - "target": "com.amazonaws.lightsail#UpdateDistribution" + "com.amazonaws.lightsail#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#TagResourceResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a\n maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique\n per resource. For more information about tags, see the Amazon Lightsail Developer Guide.

\n

The tag resource operation supports tag-based access control via request tags\n and resource tags applied to the resource identified by resource name. For more\n information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/TagResource", + "code": 200 + } + } }, - { - "target": "com.amazonaws.lightsail#UpdateDistributionBundle" + "com.amazonaws.lightsail#TagResourceRequest": { + "type": "structure", + "members": { + "resourceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the resource to which you are adding tags.

", + "smithy.api#required": {} + } + }, + "resourceArn": { + "target": "com.amazonaws.lightsail#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to which you want to add a tag.

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag key and optional value.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.lightsail#UpdateDomainEntry" + "com.amazonaws.lightsail#TagResourceResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.lightsail#UpdateInstanceMetadataOptions" + "com.amazonaws.lightsail#TagValue": { + "type": "string" }, - { - "target": "com.amazonaws.lightsail#UpdateLoadBalancerAttribute" + "com.amazonaws.lightsail#TestAlarm": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#TestAlarmRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#TestAlarmResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Tests an alarm by displaying a banner on the Amazon Lightsail console. If a notification\n trigger is configured for the specified alarm, the test also sends a notification to the\n notification protocol (Email and/or SMS) configured for the\n alarm.

\n

An alarm is used to monitor a single metric for one of your resources. When a metric\n condition is met, the alarm can notify you by email, SMS text message, and a banner displayed\n on the Amazon Lightsail console. For more information, see Alarms\n in Amazon Lightsail.

", + "smithy.api#http": { + "method": "GET", + "uri": "/ls/api/2016-11-28/TestAlarm", + "code": 200 + } + } }, - { - "target": "com.amazonaws.lightsail#UpdateRelationalDatabase" + "com.amazonaws.lightsail#TestAlarmRequest": { + "type": "structure", + "members": { + "alarmName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the alarm to test.

", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.lightsail#AlarmState", + "traits": { + "smithy.api#documentation": "

The alarm state to test.

\n

An alarm has the following possible states that can be tested:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.lightsail#UpdateRelationalDatabaseParameters" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "Lightsail", - "arnNamespace": "lightsail", - "cloudFormationName": "Lightsail", - "cloudTrailEventSource": "lightsail.amazonaws.com", - "endpointPrefix": "lightsail" - }, - "aws.auth#sigv4": { - "name": "lightsail" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

Amazon Lightsail is the easiest way to get started with Amazon Web Services (Amazon Web Services) for developers who need to build websites or web applications. It includes\n everything you need to launch your project quickly - instances (virtual private servers),\n container services, storage buckets, managed databases, SSD-based block storage, static IP\n addresses, load balancers, content delivery network (CDN) distributions, DNS management of\n registered domains, and resource snapshots (backups) - for a low, predictable monthly\n price.

\n

You can manage your Lightsail resources using the Lightsail console, Lightsail API,\n Command Line Interface (CLI), or SDKs. For more information about Lightsail\n concepts and tasks, see the Amazon Lightsail Developer Guide.

\n

This API Reference provides detailed information about the actions, data types,\n parameters, and errors of the Lightsail service. For more information about the supported\n Amazon Web Services Regions, endpoints, and service quotas of the Lightsail service, see\n Amazon Lightsail Endpoints\n and Quotas in the Amazon Web Services General Reference.

", - "smithy.api#title": "Amazon Lightsail", - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" + "com.amazonaws.lightsail#TestAlarmResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } - ] } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#TimeOfDay": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$" + } + }, + "com.amazonaws.lightsail#TimePeriod": { + "type": "structure", + "members": { + "start": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The beginning of the time period. The start date is inclusive. For example, if start is 2017-01-01, Lightsail for Research retrieves cost and usage data starting at 2017-01-01 up to the end date. The start date must be equal to or no later than the current date to avoid a validation error.

" } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" }, - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "end": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The end of the time period. The end date is exclusive. For example, if end is 2017-05-01, Lightsail for Research retrieves cost and usage data from the start date up to, but not including, 2017-05-01.

" } - ] } - ] }, - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] + "traits": { + "smithy.api#documentation": "

Sets the start date and end date for retrieving a cost estimate. 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.

" + } + }, + "com.amazonaws.lightsail#TreatMissingData": { + "type": "enum", + "members": { + "Breaching": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "breaching" } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://lightsail-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://lightsail-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://lightsail.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ] - }, - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://lightsail.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] + }, + "NotBreaching": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "notBreaching" } - ] }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" + "Ignore": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ignore" + } + }, + "Missing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "missing" + } } - ] } - ] }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": false, - "UseDualStack": false - } + "com.amazonaws.lightsail#UnauthenticatedException": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.lightsail#string" + }, + "docs": { + "target": "com.amazonaws.lightsail#string" + }, + "message": { + "target": "com.amazonaws.lightsail#string" + }, + "tip": { + "target": "com.amazonaws.lightsail#string" + } }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseFIPS": false, - "UseDualStack": false - } + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#error": "client", + "smithy.api#httpError": 401 + } + }, + "com.amazonaws.lightsail#UnpeerVpc": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#UnpeerVpcRequest" }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail.ap-south-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-south-1", - "UseFIPS": false, - "UseDualStack": false - } + "output": { + "target": "com.amazonaws.lightsail#UnpeerVpcResult" }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseFIPS": false, - "UseDualStack": false - } + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Unpeers the Lightsail VPC from the user's default VPC.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/UnpeerVpc", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#UnpeerVpcRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#UnpeerVpcResult": { + "type": "structure", + "members": { + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseFIPS": false, - "UseDualStack": false - } + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#UntagResourceRequest" }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": false, - "UseDualStack": false - } + "output": { + "target": "com.amazonaws.lightsail#UntagResourceResult" }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": false, - "UseDualStack": false - } + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified set of tag keys and their values from the specified Amazon Lightsail\n resource.

\n

The untag resource operation supports tag-based access control via request\n tags and resource tags applied to the resource identified by resource name. For\n more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/UntagResource", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the resource from which you are removing a tag.

", + "smithy.api#required": {} + } + }, + "resourceArn": { + "target": "com.amazonaws.lightsail#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource from which you want to remove a tag.

" + } + }, + "tagKeys": { + "target": "com.amazonaws.lightsail#TagKeyList", + "traits": { + "smithy.api#documentation": "

The tag keys to delete from the specified resource.

", + "smithy.api#required": {} + } + } }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail.eu-north-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-north-1", - "UseFIPS": false, - "UseDualStack": false - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#UntagResourceResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": false - } + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#UpdateBucket": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#UpdateBucketRequest" }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail.eu-west-2.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-2", - "UseFIPS": false, - "UseDualStack": false - } + "output": { + "target": "com.amazonaws.lightsail#UpdateBucketResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an existing Amazon Lightsail bucket.

\n

Use this action to update the configuration of an existing bucket, such as versioning,\n public accessibility, and the Amazon Web Services accounts that can access the bucket.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/UpdateBucket", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#UpdateBucketBundle": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#UpdateBucketBundleRequest" }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail.eu-west-3.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-3", - "UseFIPS": false, - "UseDualStack": false - } + "output": { + "target": "com.amazonaws.lightsail#UpdateBucketBundleResult" }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.

\n

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a\n bucket. You can update a bucket's bundle only one time within a monthly Amazon Web Services\n billing cycle. To determine if you can update a bucket's bundle, use the GetBuckets action. The\n ableToUpdateBundle parameter in the response will indicate whether you can\n currently update a bucket's bundle.

\n

Update a bucket's bundle if it's consistently going over its storage space or data\n transfer quota, or if a bucket's usage is consistently in the lower range of its storage space\n or data transfer quota. Due to the unpredictable usage fluctuations that a bucket might\n experience, we strongly recommend that you update a bucket's bundle only as a long-term\n strategy, instead of as a short-term, monthly cost-cutting measure. Choose a bucket bundle\n that will provide the bucket with ample storage space and data transfer for a long time to\n come.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/UpdateBucketBundle", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#UpdateBucketBundleRequest": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.lightsail#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket for which to update the bundle.

", + "smithy.api#required": {} + } + }, + "bundleId": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the new bundle to apply to the bucket.

\n

Use the GetBucketBundles action to get a list of\n bundle IDs that you can specify.

", + "smithy.api#required": {} + } + } }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#UpdateBucketBundleResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#UpdateBucketRequest": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.lightsail#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket to update.

", + "smithy.api#required": {} + } + }, + "accessRules": { + "target": "com.amazonaws.lightsail#AccessRules", + "traits": { + "smithy.api#documentation": "

An object that sets the public accessibility of objects in the specified bucket.

" + } + }, + "versioning": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable or suspend versioning of objects in the bucket.

\n

The following options can be specified:

\n " + } + }, + "readonlyAccessAccounts": { + "target": "com.amazonaws.lightsail#PartnerIdList", + "traits": { + "smithy.api#documentation": "

An array of strings to specify the Amazon Web Services account IDs that can access the\n bucket.

\n

You can give a maximum of 10 Amazon Web Services accounts access to a bucket.

" + } + }, + "accessLogConfig": { + "target": "com.amazonaws.lightsail#BucketAccessLogConfig", + "traits": { + "smithy.api#documentation": "

An object that describes the access log configuration for the bucket.

" + } + } }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lightsail-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#UpdateBucketResult": { + "type": "structure", + "members": { + "bucket": { + "target": "com.amazonaws.lightsail#Bucket", + "traits": { + "smithy.api#documentation": "

An object that describes the bucket that is updated.

" + } + }, + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#UpdateContainerService": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#UpdateContainerServiceRequest" }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lightsail.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } + "output": { + "target": "com.amazonaws.lightsail#UpdateContainerServiceResult" }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lightsail-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the configuration of your Amazon Lightsail container service, such as its power,\n scale, and public domain names.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/ls/api/2016-11-28/container-services/{serviceName}", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#UpdateContainerServiceRequest": { + "type": "structure", + "members": { + "serviceName": { + "target": "com.amazonaws.lightsail#ContainerServiceName", + "traits": { + "smithy.api#documentation": "

The name of the container service to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "power": { + "target": "com.amazonaws.lightsail#ContainerServicePowerName", + "traits": { + "smithy.api#documentation": "

The power for the container service.

\n

The power specifies the amount of memory, vCPUs, and base monthly cost of each node of the\n container service. The power and scale of a container service makes\n up its configured capacity. To determine the monthly price of your container service, multiply\n the base price of the power with the scale (the number of nodes) of\n the service.

\n

Use the GetContainerServicePowers action to view the specifications of each\n power option.

" + } + }, + "scale": { + "target": "com.amazonaws.lightsail#ContainerServiceScale", + "traits": { + "smithy.api#documentation": "

The scale for the container service.

\n

The scale specifies the allocated compute nodes of the container service. The\n power and scale of a container service makes up its configured\n capacity. To determine the monthly price of your container service, multiply the base price of\n the power with the scale (the number of nodes) of the\n service.

" + } + }, + "isDisabled": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value to indicate whether the container service is disabled.

" + } + }, + "publicDomainNames": { + "target": "com.amazonaws.lightsail#ContainerServicePublicDomains", + "traits": { + "smithy.api#documentation": "

The public domain names to use with the container service, such as\n example.com and www.example.com.

\n

You can specify up to four public domain names for a container service. The domain names\n that you specify are used when you create a deployment with a container configured as the\n public endpoint of your container service.

\n

If you don't specify public domain names, then you can use the default domain of the\n container service.

\n \n

You must create and validate an SSL/TLS certificate before you can use public domain\n names with your container service. Use the CreateCertificate action to create a\n certificate for the public domain names you want to use with your container service.

\n \n

You can specify public domain names using a string to array map as shown in the example\n later on this page.

" + } + }, + "privateRegistryAccess": { + "target": "com.amazonaws.lightsail#PrivateRegistryAccessRequest", + "traits": { + "smithy.api#documentation": "

An object to describe the configuration for the container service to access private\n container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private\n repositories.

\n

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

" + } + } }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#UpdateContainerServiceResult": { + "type": "structure", + "members": { + "containerService": { + "target": "com.amazonaws.lightsail#ContainerService", + "traits": { + "smithy.api#documentation": "

An object that describes a container service.

" + } + } }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lightsail.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#UpdateDistribution": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#UpdateDistributionRequest" }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } + "output": { + "target": "com.amazonaws.lightsail#UpdateDistributionResult" }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lightsail-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an existing Amazon Lightsail content delivery network (CDN) distribution.

\n

Use this action to update the configuration of your existing distribution.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/UpdateDistribution", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#UpdateDistributionBundle": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#UpdateDistributionBundleRequest" }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } + "output": { + "target": "com.amazonaws.lightsail#UpdateDistributionBundleResult" }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lightsail.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the bundle of your Amazon Lightsail content delivery network (CDN)\n distribution.

\n

A distribution bundle specifies the monthly network transfer quota and monthly cost of\n your distribution.

\n

Update your distribution's bundle if your distribution is going over its monthly network\n transfer quota and is incurring an overage fee.

\n

You can update your distribution's bundle only one time within your monthly Amazon Web Services billing cycle. To determine if you can update your distribution's bundle, use the\n GetDistributions action. The ableToUpdateBundle parameter in the\n result will indicate whether you can currently update your distribution's bundle.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/UpdateDistributionBundle", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#UpdateDistributionBundleRequest": { + "type": "structure", + "members": { + "distributionName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the distribution for which to update the bundle.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

" + } + }, + "bundleId": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The bundle ID of the new bundle to apply to your distribution.

\n

Use the GetDistributionBundles action to get a list of distribution bundle\n IDs that you can specify.

" + } + } }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#UpdateDistributionBundleResult": { + "type": "structure", + "members": { + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An object that describes the result of the action, such as the status of the request, the\n timestamp of the request, and the resources affected by the request.

" + } + } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#UpdateDistributionRequest": { + "type": "structure", + "members": { + "distributionName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the distribution to update.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

", + "smithy.api#required": {} + } + }, + "origin": { + "target": "com.amazonaws.lightsail#InputOrigin", + "traits": { + "smithy.api#documentation": "

An object that describes the origin resource for the distribution, such as a Lightsail\n instance, bucket, or load balancer.

\n

The distribution pulls, caches, and serves content from the origin.

" + } + }, + "defaultCacheBehavior": { + "target": "com.amazonaws.lightsail#CacheBehavior", + "traits": { + "smithy.api#documentation": "

An object that describes the default cache behavior for the distribution.

" + } + }, + "cacheBehaviorSettings": { + "target": "com.amazonaws.lightsail#CacheSettings", + "traits": { + "smithy.api#documentation": "

An object that describes the cache behavior settings for the distribution.

\n \n

The cacheBehaviorSettings specified in your\n UpdateDistributionRequest will replace your distribution's existing\n settings.

\n " + } + }, + "cacheBehaviors": { + "target": "com.amazonaws.lightsail#CacheBehaviorList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the per-path cache behavior for the distribution.

" + } + }, + "isEnabled": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to enable the distribution.

" + } + } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#UpdateDistributionResult": { + "type": "structure", + "members": { + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#UpdateDomainEntry": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#UpdateDomainEntryRequest" }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } + "output": { + "target": "com.amazonaws.lightsail#UpdateDomainEntryResult" }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a domain recordset after it is created.

\n

The update domain entry operation supports tag-based access control via\n resource tags applied to the resource identified by domain name. For more\n information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/UpdateDomainEntry", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#UpdateDomainEntryRequest": { + "type": "structure", + "members": { + "domainName": { + "target": "com.amazonaws.lightsail#DomainName", + "traits": { + "smithy.api#documentation": "

The name of the domain recordset to update.

", + "smithy.api#required": {} + } + }, + "domainEntry": { + "target": "com.amazonaws.lightsail#DomainEntry", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + } }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lightsail#UpdateDomainEntryResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lightsail#UpdateInstanceMetadataOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#UpdateInstanceMetadataOptionsRequest" }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.lightsail#LoadBalancer": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the load balancer (e.g., my-load-balancer).

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the load balancer.

" - } - }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail load balancer. This code enables our support team to look up your Lightsail\n information more easily.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The date when your load balancer was created.

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

The AWS Region where your load balancer was created (e.g., us-east-2a).\n Lightsail automatically creates your load balancer across Availability Zones.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The resource type (e.g., LoadBalancer.

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" - } - }, - "dnsName": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The DNS name of your Lightsail load balancer.

" - } - }, - "state": { - "target": "com.amazonaws.lightsail#LoadBalancerState", - "traits": { - "smithy.api#documentation": "

The status of your load balancer. Valid values are below.

" - } - }, - "protocol": { - "target": "com.amazonaws.lightsail#LoadBalancerProtocol", - "traits": { - "smithy.api#documentation": "

The protocol you have enabled for your load balancer. Valid values are below.

\n

You can't just have HTTP_HTTPS, but you can have just\n HTTP.

" - } - }, - "publicPorts": { - "target": "com.amazonaws.lightsail#PortList", - "traits": { - "smithy.api#documentation": "

An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS,\n use port 443.

" - } - }, - "healthCheckPath": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The path you specified to perform your health checks. If no path is specified, the load\n balancer tries to make a request to the default (root) page.

" - } - }, - "instancePort": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The port where the load balancer will direct traffic to your Lightsail instances. For\n HTTP traffic, it's port 80. For HTTPS traffic, it's port 443.

" - } - }, - "instanceHealthSummary": { - "target": "com.amazonaws.lightsail#InstanceHealthSummaryList", - "traits": { - "smithy.api#documentation": "

An array of InstanceHealthSummary objects describing the health of the load\n balancer.

" - } - }, - "tlsCertificateSummaries": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateSummaryList", - "traits": { - "smithy.api#documentation": "

An array of LoadBalancerTlsCertificateSummary objects that provide additional information\n about the SSL/TLS certificates. For example, if true, the certificate is attached\n to the load balancer.

" - } - }, - "configurationOptions": { - "target": "com.amazonaws.lightsail#LoadBalancerConfigurationOptions", - "traits": { - "smithy.api#documentation": "

A string to string map of the configuration options for your load balancer. Valid values\n are listed below.

" - } - }, - "ipAddressType": { - "target": "com.amazonaws.lightsail#IpAddressType", - "traits": { - "smithy.api#documentation": "

The IP address type of the load balancer.

\n

The possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.

" - } - }, - "httpsRedirectionEnabled": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value that indicates whether HTTPS redirection is enabled for the load\n balancer.

" - } - }, - "tlsPolicyName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the TLS security policy for the load balancer.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a load balancer.

" - } - }, - "com.amazonaws.lightsail#LoadBalancerAttributeName": { - "type": "enum", - "members": { - "HealthCheckPath": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HealthCheckPath" - } - }, - "SessionStickinessEnabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SessionStickinessEnabled" - } - }, - "SessionStickiness_LB_CookieDurationSeconds": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SessionStickiness_LB_CookieDurationSeconds" - } - }, - "HttpsRedirectionEnabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HttpsRedirectionEnabled" - } - }, - "TlsPolicyName": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TlsPolicyName" - } - } - } - }, - "com.amazonaws.lightsail#LoadBalancerConfigurationOptions": { - "type": "map", - "key": { - "target": "com.amazonaws.lightsail#LoadBalancerAttributeName" - }, - "value": { - "target": "com.amazonaws.lightsail#string" - } - }, - "com.amazonaws.lightsail#LoadBalancerList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#LoadBalancer" - } - }, - "com.amazonaws.lightsail#LoadBalancerMetricName": { - "type": "enum", - "members": { - "ClientTLSNegotiationErrorCount": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ClientTLSNegotiationErrorCount" - } - }, - "HealthyHostCount": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HealthyHostCount" - } - }, - "UnhealthyHostCount": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UnhealthyHostCount" - } - }, - "HTTPCode_LB_4XX_Count": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTPCode_LB_4XX_Count" - } - }, - "HTTPCode_LB_5XX_Count": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTPCode_LB_5XX_Count" - } - }, - "HTTPCode_Instance_2XX_Count": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTPCode_Instance_2XX_Count" - } - }, - "HTTPCode_Instance_3XX_Count": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTPCode_Instance_3XX_Count" - } - }, - "HTTPCode_Instance_4XX_Count": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTPCode_Instance_4XX_Count" - } - }, - "HTTPCode_Instance_5XX_Count": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTPCode_Instance_5XX_Count" - } - }, - "InstanceResponseTime": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InstanceResponseTime" - } - }, - "RejectedConnectionCount": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RejectedConnectionCount" - } - }, - "RequestCount": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RequestCount" - } - } - } - }, - "com.amazonaws.lightsail#LoadBalancerProtocol": { - "type": "enum", - "members": { - "HTTP_HTTPS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTP_HTTPS" - } - }, - "HTTP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTP" - } - } - } - }, - "com.amazonaws.lightsail#LoadBalancerState": { - "type": "enum", - "members": { - "Active": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "active" - } - }, - "Provisioning": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "provisioning" - } - }, - "ActiveImpaired": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "active_impaired" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failed" - } - }, - "Unknown": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unknown" - } - } - } - }, - "com.amazonaws.lightsail#LoadBalancerTlsCertificate": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the SSL/TLS certificate (e.g., my-certificate).

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SSL/TLS certificate.

" - } - }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail load balancer or SSL/TLS certificate. This code enables our support team to\n look up your Lightsail information more easily.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The time when you created your SSL/TLS certificate.

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region and Availability Zone where you created your\n certificate.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The resource type (e.g., LoadBalancerTlsCertificate).

\n " - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" - } - }, - "loadBalancerName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The load balancer name where your SSL/TLS certificate is attached.

" - } - }, - "isAttached": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

When true, the SSL/TLS certificate is attached to the Lightsail load\n balancer.

" - } - }, - "status": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateStatus", - "traits": { - "smithy.api#documentation": "

The validation status of the SSL/TLS certificate. Valid values are below.

" - } - }, - "domainName": { - "target": "com.amazonaws.lightsail#DomainName", - "traits": { - "smithy.api#documentation": "

The domain name for your SSL/TLS certificate.

" - } - }, - "domainValidationRecords": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationRecordList", - "traits": { - "smithy.api#documentation": "

An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the\n records.

" - } - }, - "failureReason": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateFailureReason", - "traits": { - "smithy.api#documentation": "

The validation failure reason, if any, of the certificate.

\n

The following failure reasons are possible:

\n " - } - }, - "issuedAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The time when the SSL/TLS certificate was issued.

" - } - }, - "issuer": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The issuer of the certificate.

" - } - }, - "keyAlgorithm": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The algorithm used to generate the key pair (the public and private key).

" - } - }, - "notAfter": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the SSL/TLS certificate expires.

" - } - }, - "notBefore": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the SSL/TLS certificate is first valid.

" - } - }, - "renewalSummary": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateRenewalSummary", - "traits": { - "smithy.api#documentation": "

An object that describes the status of the certificate renewal managed by\n Lightsail.

" - } - }, - "revocationReason": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateRevocationReason", - "traits": { - "smithy.api#documentation": "

The reason the certificate was revoked. This value is present only when the certificate\n status is REVOKED.

" - } - }, - "revokedAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the certificate was revoked. This value is present only when the\n certificate status is REVOKED.

" - } - }, - "serial": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The serial number of the certificate.

" - } - }, - "signatureAlgorithm": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The algorithm that was used to sign the certificate.

" - } - }, - "subject": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the entity that is associated with the public key contained in the\n certificate.

" - } - }, - "subjectAlternativeNames": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

An array of strings that specify the alternate domains (e.g., example2.com)\n and subdomains (e.g., blog.example.com) for the certificate.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a load balancer SSL/TLS certificate.

\n

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

" - } - }, - "com.amazonaws.lightsail#LoadBalancerTlsCertificateDnsRecordCreationState": { - "type": "structure", - "members": { - "code": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDnsRecordCreationStateCode", - "traits": { - "smithy.api#documentation": "

The status code for the automated DNS record creation.

\n

Following are the possible values:

\n " - } - }, - "message": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The message that describes the reason for the status code.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that describes the state of the canonical name (CNAME) records that are\n automatically added by Lightsail to the DNS of the domain to validate domain\n ownership.

" - } - }, - "com.amazonaws.lightsail#LoadBalancerTlsCertificateDnsRecordCreationStateCode": { - "type": "enum", - "members": { - "Succeeded": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCEEDED" - } - }, - "Started": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STARTED" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - } - } - }, - "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainStatus": { - "type": "enum", - "members": { - "PendingValidation": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING_VALIDATION" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "Success": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCESS" - } - } - } - }, - "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationOption": { - "type": "structure", - "members": { - "domainName": { - "target": "com.amazonaws.lightsail#DomainName", - "traits": { - "smithy.api#documentation": "

The fully qualified domain name in the certificate request.

" - } - }, - "validationStatus": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainStatus", - "traits": { - "smithy.api#documentation": "

The status of the domain validation. Valid values are listed below.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about the domain names on an SSL/TLS certificate that you will use to\n validate domain ownership.

" - } - }, - "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationOptionList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationOption" - } - }, - "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationRecord": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A fully qualified domain name in the certificate. For example,\n example.com.

" - } - }, - "type": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of validation record. For example, CNAME for domain\n validation.

" - } - }, - "value": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The value for that type.

" - } - }, - "validationStatus": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainStatus", - "traits": { - "smithy.api#documentation": "

The validation status. Valid values are listed below.

" - } - }, - "domainName": { - "target": "com.amazonaws.lightsail#DomainName", - "traits": { - "smithy.api#documentation": "

The domain name against which your SSL/TLS certificate was validated.

" - } - }, - "dnsRecordCreationState": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDnsRecordCreationState", - "traits": { - "smithy.api#documentation": "

An object that describes the state of the canonical name (CNAME) records that are\n automatically added by Lightsail to the DNS of a domain to validate domain\n ownership.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the validation record of each domain name in the SSL/TLS certificate.

" - } - }, - "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationRecordList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationRecord" - } - }, - "com.amazonaws.lightsail#LoadBalancerTlsCertificateFailureReason": { - "type": "enum", - "members": { - "NoAvailableContacts": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NO_AVAILABLE_CONTACTS" - } - }, - "AdditionalVerificationRequired": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ADDITIONAL_VERIFICATION_REQUIRED" - } - }, - "DomainNotAllowed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOMAIN_NOT_ALLOWED" - } - }, - "InvalidPublicDomain": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INVALID_PUBLIC_DOMAIN" - } - }, - "Other": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OTHER" - } - } - } - }, - "com.amazonaws.lightsail#LoadBalancerTlsCertificateList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificate" - } - }, - "com.amazonaws.lightsail#LoadBalancerTlsCertificateRenewalStatus": { - "type": "enum", - "members": { - "PendingAutoRenewal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING_AUTO_RENEWAL" - } - }, - "PendingValidation": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING_VALIDATION" - } - }, - "Success": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCESS" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - } - } - }, - "com.amazonaws.lightsail#LoadBalancerTlsCertificateRenewalSummary": { - "type": "structure", - "members": { - "renewalStatus": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateRenewalStatus", - "traits": { - "smithy.api#documentation": "

The renewal status of the certificate.

\n

The following renewal status are possible:

\n " - } - }, - "domainValidationOptions": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationOptionList", - "traits": { - "smithy.api#documentation": "

Contains information about the validation of each domain name in the certificate, as it\n pertains to Lightsail's managed renewal. This is different from the initial validation that\n occurs as a result of the RequestCertificate request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about the status of Lightsail's managed renewal for the\n certificate.

\n

The renewal status of the certificate.

\n

The following renewal status are possible:

\n " - } - }, - "com.amazonaws.lightsail#LoadBalancerTlsCertificateRevocationReason": { - "type": "enum", - "members": { - "Unspecified": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNSPECIFIED" - } - }, - "KeyCompromise": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KEY_COMPROMISE" - } - }, - "CaCompromise": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CA_COMPROMISE" - } - }, - "AffiliationChanged": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AFFILIATION_CHANGED" - } - }, - "Superceded": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUPERCEDED" - } - }, - "CessationOfOperation": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CESSATION_OF_OPERATION" - } - }, - "CertificateHold": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CERTIFICATE_HOLD" - } - }, - "RemoveFromCrl": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REMOVE_FROM_CRL" - } - }, - "PrivilegeWithdrawn": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PRIVILEGE_WITHDRAWN" - } - }, - "AACompromise": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "A_A_COMPROMISE" - } - } - } - }, - "com.amazonaws.lightsail#LoadBalancerTlsCertificateStatus": { - "type": "enum", - "members": { - "PendingValidation": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING_VALIDATION" - } - }, - "Issued": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ISSUED" - } - }, - "Inactive": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INACTIVE" - } - }, - "Expired": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXPIRED" - } - }, - "ValidationTimedOut": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VALIDATION_TIMED_OUT" - } - }, - "Revoked": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REVOKED" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "Unknown": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNKNOWN" - } - } - } - }, - "com.amazonaws.lightsail#LoadBalancerTlsCertificateSummary": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the SSL/TLS certificate.

" - } - }, - "isAttached": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

When true, the SSL/TLS certificate is attached to the Lightsail load\n balancer.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides a summary of SSL/TLS certificate metadata.

" - } - }, - "com.amazonaws.lightsail#LoadBalancerTlsCertificateSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateSummary" - } - }, - "com.amazonaws.lightsail#LoadBalancerTlsPolicy": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the TLS security policy.

" - } - }, - "isDefault": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value that indicates whether the TLS security policy is the default.

" - } - }, - "description": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The description of the TLS security policy.

" - } - }, - "protocols": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

The protocols used in a given TLS security policy.

" - } - }, - "ciphers": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

The ciphers used by the TLS security policy.

\n

The ciphers are listed in order of preference.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the TLS security policies that are available for Lightsail load\n balancers.

\n

For more information about load balancer TLS security policies, see Configuring TLS security policies on your Amazon Lightsail load\n balancers in the Amazon Lightsail Developer\n Guide.

" - } - }, - "com.amazonaws.lightsail#LoadBalancerTlsPolicyList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsPolicy" - } - }, - "com.amazonaws.lightsail#LogEvent": { - "type": "structure", - "members": { - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the database log event was created.

" - } - }, - "message": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The message of the database log event.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a database log event.

" - } - }, - "com.amazonaws.lightsail#LogEventList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#LogEvent" - } - }, - "com.amazonaws.lightsail#MetricDatapoint": { - "type": "structure", - "members": { - "average": { - "target": "com.amazonaws.lightsail#double", - "traits": { - "smithy.api#documentation": "

The average.

" - } - }, - "maximum": { - "target": "com.amazonaws.lightsail#double", - "traits": { - "smithy.api#documentation": "

The maximum.

" - } - }, - "minimum": { - "target": "com.amazonaws.lightsail#double", - "traits": { - "smithy.api#documentation": "

The minimum.

" - } - }, - "sampleCount": { - "target": "com.amazonaws.lightsail#double", - "traits": { - "smithy.api#documentation": "

The sample count.

" - } - }, - "sum": { - "target": "com.amazonaws.lightsail#double", - "traits": { - "smithy.api#documentation": "

The sum.

" - } - }, - "timestamp": { - "target": "com.amazonaws.lightsail#timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp (e.g., 1479816991.349).

" - } - }, - "unit": { - "target": "com.amazonaws.lightsail#MetricUnit", - "traits": { - "smithy.api#documentation": "

The unit.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the metric data point.

" - } - }, - "com.amazonaws.lightsail#MetricDatapointList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#MetricDatapoint" - } - }, - "com.amazonaws.lightsail#MetricName": { - "type": "enum", - "members": { - "CPUUtilization": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CPUUtilization" - } - }, - "NetworkIn": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NetworkIn" - } - }, - "NetworkOut": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NetworkOut" - } - }, - "StatusCheckFailed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "StatusCheckFailed" - } - }, - "StatusCheckFailed_Instance": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "StatusCheckFailed_Instance" - } - }, - "StatusCheckFailed_System": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "StatusCheckFailed_System" - } - }, - "ClientTLSNegotiationErrorCount": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ClientTLSNegotiationErrorCount" - } - }, - "HealthyHostCount": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HealthyHostCount" - } - }, - "UnhealthyHostCount": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UnhealthyHostCount" - } - }, - "HTTPCode_LB_4XX_Count": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTPCode_LB_4XX_Count" - } - }, - "HTTPCode_LB_5XX_Count": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTPCode_LB_5XX_Count" - } - }, - "HTTPCode_Instance_2XX_Count": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTPCode_Instance_2XX_Count" - } - }, - "HTTPCode_Instance_3XX_Count": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTPCode_Instance_3XX_Count" - } - }, - "HTTPCode_Instance_4XX_Count": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTPCode_Instance_4XX_Count" - } - }, - "HTTPCode_Instance_5XX_Count": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTPCode_Instance_5XX_Count" - } - }, - "InstanceResponseTime": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InstanceResponseTime" - } - }, - "RejectedConnectionCount": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RejectedConnectionCount" - } - }, - "RequestCount": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RequestCount" - } - }, - "DatabaseConnections": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DatabaseConnections" - } - }, - "DiskQueueDepth": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DiskQueueDepth" - } - }, - "FreeStorageSpace": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FreeStorageSpace" - } - }, - "NetworkReceiveThroughput": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NetworkReceiveThroughput" - } - }, - "NetworkTransmitThroughput": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NetworkTransmitThroughput" - } - }, - "BurstCapacityTime": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BurstCapacityTime" - } - }, - "BurstCapacityPercentage": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BurstCapacityPercentage" - } - } - } - }, - "com.amazonaws.lightsail#MetricPeriod": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 60, - "max": 86400 - } - } - }, - "com.amazonaws.lightsail#MetricStatistic": { - "type": "enum", - "members": { - "Minimum": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Minimum" - } - }, - "Maximum": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Maximum" - } - }, - "Sum": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Sum" - } - }, - "Average": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Average" - } - }, - "SampleCount": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SampleCount" - } - } - } - }, - "com.amazonaws.lightsail#MetricStatisticList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#MetricStatistic" - } - }, - "com.amazonaws.lightsail#MetricUnit": { - "type": "enum", - "members": { - "Seconds": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Seconds" - } - }, - "Microseconds": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Microseconds" - } - }, - "Milliseconds": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Milliseconds" - } - }, - "Bytes": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Bytes" - } - }, - "Kilobytes": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Kilobytes" - } - }, - "Megabytes": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Megabytes" - } - }, - "Gigabytes": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Gigabytes" - } - }, - "Terabytes": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Terabytes" - } - }, - "Bits": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Bits" - } - }, - "Kilobits": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Kilobits" - } - }, - "Megabits": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Megabits" - } - }, - "Gigabits": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Gigabits" - } - }, - "Terabits": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Terabits" - } - }, - "Percent": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Percent" - } - }, - "Count": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Count" - } - }, - "BytesSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Bytes/Second" - } - }, - "KilobytesSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Kilobytes/Second" - } - }, - "MegabytesSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Megabytes/Second" - } - }, - "GigabytesSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Gigabytes/Second" - } - }, - "TerabytesSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Terabytes/Second" - } - }, - "BitsSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Bits/Second" - } - }, - "KilobitsSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Kilobits/Second" - } - }, - "MegabitsSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Megabits/Second" - } - }, - "GigabitsSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Gigabits/Second" - } - }, - "TerabitsSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Terabits/Second" - } - }, - "CountSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Count/Second" - } - }, - "None": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "None" - } - } - } - }, - "com.amazonaws.lightsail#MonitoredResourceInfo": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.lightsail#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource being monitored.

" - } - }, - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the Lightsail resource being monitored.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The Lightsail resource type of the resource being monitored.

\n

Instances, load balancers, and relational databases are the only Lightsail resources\n that can currently be monitored by alarms.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes resource being monitored by an alarm.

\n

An alarm is a way to monitor your Amazon Lightsail resource metrics. For more information,\n see Alarms\n in Amazon Lightsail.

" - } - }, - "com.amazonaws.lightsail#MonthlyTransfer": { - "type": "structure", - "members": { - "gbPerMonthAllocated": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The amount allocated per month (in GB).

" - } - } - }, - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "com.amazonaws.lightsail#NameServersUpdateState": { - "type": "structure", - "members": { - "code": { - "target": "com.amazonaws.lightsail#NameServersUpdateStateCode", - "traits": { - "smithy.api#documentation": "

The status code for the name servers update.

\n

Following are the possible values:

\n " - } - }, - "message": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The message that describes the reason for the status code.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the state of the name server records update made by Amazon Lightsail\n to an Amazon Route 53 registered domain.

\n

For more information, see DNS in Amazon Lightsail in the Amazon Lightsail\n Developer Guide.

" - } - }, - "com.amazonaws.lightsail#NameServersUpdateStateCode": { - "type": "enum", - "members": { - "Succeeded": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCEEDED" - } - }, - "Pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "Started": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STARTED" - } - } - } - }, - "com.amazonaws.lightsail#NetworkProtocol": { - "type": "enum", - "members": { - "TCP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "tcp" - } - }, - "ALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "all" - } - }, - "UDP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "udp" - } - }, - "ICMP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "icmp" - } - } - } - }, - "com.amazonaws.lightsail#NonEmptyString": { - "type": "string", - "traits": { - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.lightsail#NotFoundException": { - "type": "structure", - "members": { - "code": { - "target": "com.amazonaws.lightsail#string" + "output": { + "target": "com.amazonaws.lightsail#UpdateInstanceMetadataOptionsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the Amazon Lightsail instance metadata parameters on a running or stopped\n instance. When you modify the parameters on a running instance, the GetInstance\n or GetInstances API operation initially responds with a state of\n pending. After the parameter modifications are successfully applied, the state\n changes to applied in subsequent GetInstance or\n GetInstances API calls. For more information, see Use IMDSv2 with an Amazon Lightsail instance in the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/UpdateInstanceMetadataOptions", + "code": 200 + } + } }, - "docs": { - "target": "com.amazonaws.lightsail#string" + "com.amazonaws.lightsail#UpdateInstanceMetadataOptionsRequest": { + "type": "structure", + "members": { + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the instance for which to update metadata parameters.

", + "smithy.api#required": {} + } + }, + "httpTokens": { + "target": "com.amazonaws.lightsail#HttpTokens", + "traits": { + "smithy.api#documentation": "

The state of token usage for your instance metadata requests. If the parameter is not\n specified in the request, the default state is optional.

\n

If the state is optional, you can choose whether to retrieve instance\n metadata with a signed token header on your request. If you retrieve the IAM role credentials\n without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role\n credentials by using a valid signed token, the version 2.0 role credentials are\n returned.

\n

If the state is required, you must send a signed token header with all\n instance metadata retrieval requests. In this state, retrieving the IAM role credential always\n returns the version 2.0 credentials. The version 1.0 credentials are not available.

" + } + }, + "httpEndpoint": { + "target": "com.amazonaws.lightsail#HttpEndpoint", + "traits": { + "smithy.api#documentation": "

Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not\n specified, the existing state is maintained.

\n

If you specify a value of disabled, you cannot access your instance\n metadata.

" + } + }, + "httpPutResponseHopLimit": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. A larger number\n means that the instance metadata requests can travel farther. If no parameter is specified,\n the existing state is maintained.

" + } + }, + "httpProtocolIpv6": { + "target": "com.amazonaws.lightsail#HttpProtocolIpv6", + "traits": { + "smithy.api#documentation": "

Enables or disables the IPv6 endpoint for the instance metadata service. This setting\n applies only when the HTTP metadata endpoint is enabled.

\n \n

This parameter is available only for instances in the Europe (Stockholm) Amazon Web Services Region (eu-north-1).

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - "message": { - "target": "com.amazonaws.lightsail#string" + "com.amazonaws.lightsail#UpdateInstanceMetadataOptionsResult": { + "type": "structure", + "members": { + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - "tip": { - "target": "com.amazonaws.lightsail#string" - } - }, - "traits": { - "smithy.api#documentation": "

Lightsail throws this exception when it cannot find a resource.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.lightsail#NotificationTriggerList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#AlarmState" - } - }, - "com.amazonaws.lightsail#OpenInstancePublicPorts": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#OpenInstancePublicPortsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#OpenInstancePublicPortsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses\n allowed to connect to the instance through the ports, and the protocol.

\n

The OpenInstancePublicPorts action supports tag-based access control via\n resource tags applied to the resource identified by instanceName. For more\n information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/OpenInstancePublicPorts", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#OpenInstancePublicPortsRequest": { - "type": "structure", - "members": { - "portInfo": { - "target": "com.amazonaws.lightsail#PortInfo", - "traits": { - "smithy.api#documentation": "

An object to describe the ports to open for the specified instance.

", - "smithy.api#required": {} - } - }, - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the instance for which to open ports.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#OpenInstancePublicPortsResult": { - "type": "structure", - "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#Operation": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the operation.

" - } - }, - "resourceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The resource name.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The resource type.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region and Availability Zone.

" - } - }, - "isTerminal": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the operation is terminal.

" - } - }, - "operationDetails": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "operationType": { - "target": "com.amazonaws.lightsail#OperationType", - "traits": { - "smithy.api#documentation": "

The type of operation.

" - } - }, - "status": { - "target": "com.amazonaws.lightsail#OperationStatus", - "traits": { - "smithy.api#documentation": "

The status of the operation.

" - } - }, - "statusChangedAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "errorCode": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The error code.

" - } - }, - "errorDetails": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The error details.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the API operation.

" - } - }, - "com.amazonaws.lightsail#OperationFailureException": { - "type": "structure", - "members": { - "code": { - "target": "com.amazonaws.lightsail#string" + "com.amazonaws.lightsail#UpdateLoadBalancerAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#UpdateLoadBalancerAttributeRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#UpdateLoadBalancerAttributeResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the specified attribute for a load balancer. You can only update one attribute at\n a time.

\n

The update load balancer attribute operation supports tag-based access\n control via resource tags applied to the resource identified by load balancer\n name. For more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/UpdateLoadBalancerAttribute", + "code": 200 + } + } }, - "docs": { - "target": "com.amazonaws.lightsail#string" + "com.amazonaws.lightsail#UpdateLoadBalancerAttributeRequest": { + "type": "structure", + "members": { + "loadBalancerName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the load balancer that you want to modify (e.g.,\n my-load-balancer.

", + "smithy.api#required": {} + } + }, + "attributeName": { + "target": "com.amazonaws.lightsail#LoadBalancerAttributeName", + "traits": { + "smithy.api#documentation": "

The name of the attribute you want to update.

", + "smithy.api#required": {} + } + }, + "attributeValue": { + "target": "com.amazonaws.lightsail#StringMax256", + "traits": { + "smithy.api#documentation": "

The value that you want to specify for the attribute name.

\n

The following values are supported depending on what you specify for the\n attributeName request parameter:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - "message": { - "target": "com.amazonaws.lightsail#string" + "com.amazonaws.lightsail#UpdateLoadBalancerAttributeResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - "tip": { - "target": "com.amazonaws.lightsail#string" - } - }, - "traits": { - "smithy.api#documentation": "

Lightsail throws this exception when an operation fails to execute.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.lightsail#OperationList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#Operation" - } - }, - "com.amazonaws.lightsail#OperationStatus": { - "type": "enum", - "members": { - "NotStarted": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NotStarted" - } - }, - "Started": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Started" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "Completed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Completed" - } - }, - "Succeeded": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Succeeded" - } - } - } - }, - "com.amazonaws.lightsail#OperationType": { - "type": "enum", - "members": { - "DeleteKnownHostKeys": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteKnownHostKeys" - } - }, - "DeleteInstance": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteInstance" - } - }, - "CreateInstance": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateInstance" - } - }, - "StopInstance": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "StopInstance" - } - }, - "StartInstance": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "StartInstance" - } - }, - "RebootInstance": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RebootInstance" - } - }, - "OpenInstancePublicPorts": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OpenInstancePublicPorts" - } - }, - "PutInstancePublicPorts": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PutInstancePublicPorts" - } - }, - "CloseInstancePublicPorts": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CloseInstancePublicPorts" - } - }, - "AllocateStaticIp": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AllocateStaticIp" - } - }, - "ReleaseStaticIp": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ReleaseStaticIp" - } - }, - "AttachStaticIp": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AttachStaticIp" - } - }, - "DetachStaticIp": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DetachStaticIp" - } - }, - "UpdateDomainEntry": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UpdateDomainEntry" - } - }, - "DeleteDomainEntry": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteDomainEntry" - } - }, - "CreateDomain": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateDomain" - } - }, - "DeleteDomain": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteDomain" - } - }, - "CreateInstanceSnapshot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateInstanceSnapshot" - } - }, - "DeleteInstanceSnapshot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteInstanceSnapshot" - } - }, - "CreateInstancesFromSnapshot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateInstancesFromSnapshot" - } - }, - "CreateLoadBalancer": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateLoadBalancer" - } - }, - "DeleteLoadBalancer": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteLoadBalancer" - } - }, - "AttachInstancesToLoadBalancer": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AttachInstancesToLoadBalancer" - } - }, - "DetachInstancesFromLoadBalancer": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DetachInstancesFromLoadBalancer" - } - }, - "UpdateLoadBalancerAttribute": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UpdateLoadBalancerAttribute" - } - }, - "CreateLoadBalancerTlsCertificate": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateLoadBalancerTlsCertificate" - } - }, - "DeleteLoadBalancerTlsCertificate": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteLoadBalancerTlsCertificate" - } - }, - "AttachLoadBalancerTlsCertificate": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AttachLoadBalancerTlsCertificate" - } - }, - "CreateDisk": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateDisk" - } - }, - "DeleteDisk": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteDisk" - } - }, - "AttachDisk": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AttachDisk" - } - }, - "DetachDisk": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DetachDisk" - } - }, - "CreateDiskSnapshot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateDiskSnapshot" - } - }, - "DeleteDiskSnapshot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteDiskSnapshot" - } - }, - "CreateDiskFromSnapshot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateDiskFromSnapshot" - } - }, - "CreateRelationalDatabase": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateRelationalDatabase" - } - }, - "UpdateRelationalDatabase": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UpdateRelationalDatabase" - } - }, - "DeleteRelationalDatabase": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteRelationalDatabase" - } - }, - "CreateRelationalDatabaseFromSnapshot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateRelationalDatabaseFromSnapshot" - } - }, - "CreateRelationalDatabaseSnapshot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateRelationalDatabaseSnapshot" - } - }, - "DeleteRelationalDatabaseSnapshot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteRelationalDatabaseSnapshot" - } - }, - "UpdateRelationalDatabaseParameters": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UpdateRelationalDatabaseParameters" - } - }, - "StartRelationalDatabase": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "StartRelationalDatabase" - } - }, - "RebootRelationalDatabase": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RebootRelationalDatabase" - } - }, - "StopRelationalDatabase": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "StopRelationalDatabase" - } - }, - "EnableAddOn": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EnableAddOn" - } - }, - "DisableAddOn": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DisableAddOn" - } - }, - "PutAlarm": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PutAlarm" - } - }, - "GetAlarms": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GetAlarms" - } - }, - "DeleteAlarm": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteAlarm" - } - }, - "TestAlarm": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TestAlarm" - } - }, - "CreateContactMethod": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateContactMethod" - } - }, - "GetContactMethods": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GetContactMethods" - } - }, - "SendContactMethodVerification": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SendContactMethodVerification" - } - }, - "DeleteContactMethod": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteContactMethod" - } - }, - "CreateDistribution": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateDistribution" - } - }, - "UpdateDistribution": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UpdateDistribution" - } - }, - "DeleteDistribution": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteDistribution" - } - }, - "ResetDistributionCache": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ResetDistributionCache" - } - }, - "AttachCertificateToDistribution": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AttachCertificateToDistribution" - } - }, - "DetachCertificateFromDistribution": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DetachCertificateFromDistribution" - } - }, - "UpdateDistributionBundle": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UpdateDistributionBundle" - } - }, - "SetIpAddressType": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SetIpAddressType" - } - }, - "CreateCertificate": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateCertificate" - } - }, - "DeleteCertificate": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteCertificate" - } - }, - "CreateContainerService": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateContainerService" - } - }, - "UpdateContainerService": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UpdateContainerService" - } - }, - "DeleteContainerService": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteContainerService" - } - }, - "CreateContainerServiceDeployment": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateContainerServiceDeployment" - } - }, - "CreateContainerServiceRegistryLogin": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateContainerServiceRegistryLogin" - } - }, - "RegisterContainerImage": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RegisterContainerImage" - } - }, - "DeleteContainerImage": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteContainerImage" - } - }, - "CreateBucket": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateBucket" - } - }, - "DeleteBucket": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteBucket" - } - }, - "CreateBucketAccessKey": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateBucketAccessKey" - } - }, - "DeleteBucketAccessKey": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteBucketAccessKey" - } - }, - "UpdateBucketBundle": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UpdateBucketBundle" - } - }, - "UpdateBucket": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UpdateBucket" - } - }, - "SetResourceAccessForBucket": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SetResourceAccessForBucket" - } - }, - "UpdateInstanceMetadataOptions": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UpdateInstanceMetadataOptions" - } - }, - "StartGUISession": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "StartGUISession" - } - }, - "StopGUISession": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "StopGUISession" - } - } - } - }, - "com.amazonaws.lightsail#Origin": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the origin resource.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The resource type of the origin resource (e.g., Instance).

" - } - }, - "regionName": { - "target": "com.amazonaws.lightsail#RegionName", - "traits": { - "smithy.api#documentation": "

The AWS Region name of the origin resource.

" - } - }, - "protocolPolicy": { - "target": "com.amazonaws.lightsail#OriginProtocolPolicyEnum", - "traits": { - "smithy.api#documentation": "

The protocol that your Amazon Lightsail distribution uses when establishing a connection\n with your origin to pull content.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the origin resource of an Amazon Lightsail content delivery network (CDN)\n distribution.

\n

An origin can be a Lightsail instance, bucket, or load balancer. A distribution pulls\n content from an origin, caches it, and serves it to viewers via a worldwide network of edge\n servers.

" - } - }, - "com.amazonaws.lightsail#OriginProtocolPolicyEnum": { - "type": "enum", - "members": { - "HTTPOnly": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "http-only" - } - }, - "HTTPSOnly": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "https-only" - } - } - } - }, - "com.amazonaws.lightsail#PartnerIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#NonEmptyString" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.lightsail#PasswordData": { - "type": "structure", - "members": { - "ciphertext": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The encrypted password. Ciphertext will be an empty string if access to your new instance\n is not ready yet. When you create an instance, it can take up to 15 minutes for the instance\n to be ready.

\n \n

If you use the default key pair (LightsailDefaultKeyPair), the decrypted\n password will be available in the password field.

\n

If you are using a custom key pair, you need to use your own means of decryption.

\n

If you change the Administrator password on the instance, Lightsail will continue to\n return the original ciphertext value. When accessing the instance using RDP, you need to\n manually enter the Administrator password after changing it from the default.

\n " - } - }, - "keyPairName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the key pair that you used when creating your instance. If no key pair name\n was specified when creating the instance, Lightsail uses the default key pair\n (LightsailDefaultKeyPair).

\n

If you are using a custom key pair, you need to use your own means of decrypting your\n password using the ciphertext. Lightsail creates the ciphertext by encrypting\n your password with the public key part of this key pair.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The password data for the Windows Server-based instance, including the ciphertext and the\n key pair name.

" - } - }, - "com.amazonaws.lightsail#PeerVpc": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#PeerVpcRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#PeerVpcResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Peers the Lightsail VPC with the user's default VPC.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/PeerVpc", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#PeerVpcRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#PeerVpcResult": { - "type": "structure", - "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#PendingMaintenanceAction": { - "type": "structure", - "members": { - "action": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of pending database maintenance action.

" - } - }, - "description": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Additional detail about the pending database maintenance action.

" - } - }, - "currentApplyDate": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The effective date of the pending database maintenance action.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a pending database maintenance action.

" - } - }, - "com.amazonaws.lightsail#PendingMaintenanceActionList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#PendingMaintenanceAction" - } - }, - "com.amazonaws.lightsail#PendingModifiedRelationalDatabaseValues": { - "type": "structure", - "members": { - "masterUserPassword": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The password for the master user of the database.

" - } - }, - "engineVersion": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The database engine version.

" - } - }, - "backupRetentionEnabled": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether automated backup retention is enabled.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a pending database value modification.

" - } - }, - "com.amazonaws.lightsail#Port": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": -1, - "max": 65535 - } - } - }, - "com.amazonaws.lightsail#PortAccessType": { - "type": "enum", - "members": { - "Public": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Public" - } - }, - "Private": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Private" - } - } - } - }, - "com.amazonaws.lightsail#PortInfo": { - "type": "structure", - "members": { - "fromPort": { - "target": "com.amazonaws.lightsail#Port", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The first port in a range of open ports on an instance.

\n

Allowed ports:

\n " - } - }, - "toPort": { - "target": "com.amazonaws.lightsail#Port", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The last port in a range of open ports on an instance.

\n

Allowed ports:

\n " - } - }, - "protocol": { - "target": "com.amazonaws.lightsail#NetworkProtocol", - "traits": { - "smithy.api#documentation": "

The IP protocol name.

\n

The name can be one of the following:

\n " - } - }, - "cidrs": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to\n connect to an instance through the ports, and the protocol.

\n \n

The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to\n connect to an instance.

\n \n

Examples:

\n \n

For more information about CIDR block notation, see Classless\n Inter-Domain Routing on Wikipedia.

" - } - }, - "ipv6Cidrs": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to\n connect to an instance through the ports, and the protocol. Only devices with an IPv6 address\n can connect to an instance through IPv6; otherwise, IPv4 should be used.

\n \n

The cidrs parameter lists the IPv4 addresses that are allowed to connect to\n an instance.

\n \n

For more information about CIDR block notation, see Classless\n Inter-Domain Routing on Wikipedia.

" - } - }, - "cidrListAliases": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

An alias that defines access for a preconfigured range of IP addresses.

\n

The only alias currently supported is lightsail-connect, which allows IP\n addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your\n instance.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes ports to open on an instance, the IP addresses allowed to connect to the\n instance through the ports, and the protocol.

" - } - }, - "com.amazonaws.lightsail#PortInfoList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#PortInfo" - } - }, - "com.amazonaws.lightsail#PortInfoSourceType": { - "type": "enum", - "members": { - "Default": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DEFAULT" - } - }, - "Instance": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INSTANCE" - } - }, - "None": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - }, - "Closed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CLOSED" - } - } - } - }, - "com.amazonaws.lightsail#PortList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#Port" - } - }, - "com.amazonaws.lightsail#PortMap": { - "type": "map", - "key": { - "target": "com.amazonaws.lightsail#string" - }, - "value": { - "target": "com.amazonaws.lightsail#ContainerServiceProtocol" - } - }, - "com.amazonaws.lightsail#PortState": { - "type": "enum", - "members": { - "Open": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "open" - } - }, - "Closed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "closed" - } - } - } - }, - "com.amazonaws.lightsail#PricingUnit": { - "type": "enum", - "members": { - "GB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GB" - } - }, - "Hrs": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Hrs" - } - }, - "GBMo": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GB-Mo" - } - }, - "Bundles": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Bundles" - } - }, - "Queries": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Queries" - } - } - } - }, - "com.amazonaws.lightsail#PrivateRegistryAccess": { - "type": "structure", - "members": { - "ecrImagePullerRole": { - "target": "com.amazonaws.lightsail#ContainerServiceECRImagePullerRole", - "traits": { - "smithy.api#documentation": "

An object that describes the activation status of the role that you can use to grant a\n Lightsail container service access to Amazon ECR private\n repositories. If the role is activated, the Amazon Resource Name (ARN) of the role is also\n listed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the configuration for an Amazon Lightsail container service to\n access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.

\n

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

" - } - }, - "com.amazonaws.lightsail#PrivateRegistryAccessRequest": { - "type": "structure", - "members": { - "ecrImagePullerRole": { - "target": "com.amazonaws.lightsail#ContainerServiceECRImagePullerRoleRequest", - "traits": { - "smithy.api#documentation": "

An object to describe a request to activate or deactivate the role that you can use to\n grant an Amazon Lightsail container service access to Amazon Elastic Container Registry\n (Amazon ECR) private repositories.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a request to configure an Amazon Lightsail container service to\n access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.

\n

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

" - } - }, - "com.amazonaws.lightsail#PutAlarm": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#PutAlarmRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#PutAlarmResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates or updates an alarm, and associates it with the specified metric.

\n

An alarm is used to monitor a single metric for one of your resources. When a metric\n condition is met, the alarm can notify you by email, SMS text message, and a banner displayed\n on the Amazon Lightsail console. For more information, see Alarms\n in Amazon Lightsail.

\n

When this action creates an alarm, the alarm state is immediately set to\n INSUFFICIENT_DATA. The alarm is then evaluated and its state is set\n appropriately. Any actions associated with the new state are then executed.

\n

When you update an existing alarm, its state is left unchanged, but the update completely\n overwrites the previous configuration of the alarm. The alarm is then evaluated with the\n updated configuration.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/PutAlarm", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#PutAlarmRequest": { - "type": "structure", - "members": { - "alarmName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name for the alarm. Specify the name of an existing alarm to update, and overwrite the\n previous configuration of the alarm.

", - "smithy.api#required": {} - } - }, - "metricName": { - "target": "com.amazonaws.lightsail#MetricName", - "traits": { - "smithy.api#documentation": "

The name of the metric to associate with the alarm.

\n

You can configure up to two alarms per metric.

\n

The following metrics are available for each resource type:

\n \n

For more information about these metrics, see Metrics available in Lightsail.

", - "smithy.api#required": {} - } - }, - "monitoredResourceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the Lightsail resource that will be monitored.

\n

Instances, load balancers, and relational databases are the only Lightsail resources\n that can currently be monitored by alarms.

", - "smithy.api#required": {} - } - }, - "comparisonOperator": { - "target": "com.amazonaws.lightsail#ComparisonOperator", - "traits": { - "smithy.api#documentation": "

The arithmetic operation to use when comparing the specified statistic to the threshold.\n The specified statistic value is used as the first operand.

", - "smithy.api#required": {} - } - }, - "threshold": { - "target": "com.amazonaws.lightsail#double", - "traits": { - "smithy.api#documentation": "

The value against which the specified statistic is compared.

", - "smithy.api#required": {} - } - }, - "evaluationPeriods": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The number of most recent periods over which data is compared to the specified threshold.\n If you are setting an \"M out of N\" alarm, this value (evaluationPeriods) is the\n N.

\n

If you are setting an alarm that requires that a number of consecutive data points be\n breaching to trigger the alarm, this value specifies the rolling period of time in which data\n points are evaluated.

\n

Each evaluation period is five minutes long. For example, specify an evaluation period of\n 24 to evaluate a metric over a rolling period of two hours.

\n

You can specify a minimum valuation period of 1 (5 minutes), and a maximum evaluation\n period of 288 (24 hours).

", - "smithy.api#required": {} - } - }, - "datapointsToAlarm": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The number of data points that must be not within the specified threshold to trigger the\n alarm. If you are setting an \"M out of N\" alarm, this value (datapointsToAlarm)\n is the M.

" - } - }, - "treatMissingData": { - "target": "com.amazonaws.lightsail#TreatMissingData", - "traits": { - "smithy.api#documentation": "

Sets how this alarm will handle missing data points.

\n

An alarm can treat missing data in the following ways:

\n \n

If treatMissingData is not specified, the default behavior of\n missing is used.

" - } - }, - "contactProtocols": { - "target": "com.amazonaws.lightsail#ContactProtocolsList", - "traits": { - "smithy.api#documentation": "

The contact protocols to use for the alarm, such as Email, SMS\n (text messaging), or both.

\n

A notification is sent via the specified contact protocol if notifications are enabled for\n the alarm, and when the alarm is triggered.

\n

A notification is not sent if a contact protocol is not specified, if the specified\n contact protocol is not configured in the Amazon Web Services Region, or if notifications are\n not enabled for the alarm using the notificationEnabled paramater.

\n

Use the CreateContactMethod action to configure a contact protocol in an\n Amazon Web Services Region.

" - } - }, - "notificationTriggers": { - "target": "com.amazonaws.lightsail#NotificationTriggerList", - "traits": { - "smithy.api#documentation": "

The alarm states that trigger a notification.

\n

An alarm has the following possible states:

\n \n

When you specify a notification trigger, the ALARM state must be specified.\n The INSUFFICIENT_DATA and OK states can be specified in addition to\n the ALARM state.

\n \n

The notification trigger defaults to ALARM if you don't specify this\n parameter.

" - } - }, - "notificationEnabled": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether the alarm is enabled.

\n

Notifications are enabled by default if you don't specify this parameter.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#PutAlarmResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#PutInstancePublicPorts": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#PutInstancePublicPortsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#PutInstancePublicPortsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses\n allowed to connect to the instance through the ports, and the protocol. This action also\n closes all currently open ports that are not included in the request. Include all of the ports\n and the protocols you want to open in your PutInstancePublicPortsrequest. Or use\n the OpenInstancePublicPorts action to open ports without closing currently open\n ports.

\n

The PutInstancePublicPorts action supports tag-based access control via\n resource tags applied to the resource identified by instanceName. For more\n information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/PutInstancePublicPorts", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#PutInstancePublicPortsRequest": { - "type": "structure", - "members": { - "portInfos": { - "target": "com.amazonaws.lightsail#PortInfoList", - "traits": { - "smithy.api#documentation": "

An array of objects to describe the ports to open for the specified instance.

", - "smithy.api#required": {} - } - }, - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the instance for which to open ports.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#PutInstancePublicPortsResult": { - "type": "structure", - "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#QueryStringObject": { - "type": "structure", - "members": { - "option": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether the distribution forwards and caches based on query strings.

" - } - }, - "queryStringsAllowList": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

The specific query strings that the distribution forwards to the origin.

\n

Your distribution will cache content based on the specified query strings.

\n

If the option parameter is true, then your distribution forwards all query\n strings, regardless of what you specify using the queryStringsAllowList\n parameter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the query string parameters that an Amazon Lightsail content delivery network\n (CDN) distribution to bases caching on.

\n

For the query strings that you specify, your distribution caches separate versions of the\n specified content based on the query string values in viewer\n requests.

" - } - }, - "com.amazonaws.lightsail#R53HostedZoneDeletionState": { - "type": "structure", - "members": { - "code": { - "target": "com.amazonaws.lightsail#R53HostedZoneDeletionStateCode", - "traits": { - "smithy.api#documentation": "

The status code for the deletion state.

\n

Following are the possible values:

\n " - } - }, - "message": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The message that describes the reason for the status code.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the deletion state of an Amazon Route 53 hosted zone for a domain that is\n being automatically delegated to an Amazon Lightsail DNS zone.

" - } - }, - "com.amazonaws.lightsail#R53HostedZoneDeletionStateCode": { - "type": "enum", - "members": { - "Succeeded": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCEEDED" - } - }, - "Pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "Started": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STARTED" - } - } - } - }, - "com.amazonaws.lightsail#RebootInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#RebootInstanceRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#RebootInstanceResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Restarts a specific instance.

\n

The reboot instance operation supports tag-based access control via resource\n tags applied to the resource identified by instance name. For more information,\n see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/RebootInstance", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#RebootInstanceRequest": { - "type": "structure", - "members": { - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the instance to reboot.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#RebootInstanceResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#RebootRelationalDatabase": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#RebootRelationalDatabaseRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#RebootRelationalDatabaseResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Restarts a specific database in Amazon Lightsail.

\n

The reboot relational database operation supports tag-based access control\n via resource tags applied to the resource identified by relationalDatabaseName. For more\n information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/RebootRelationalDatabase", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#RebootRelationalDatabaseRequest": { - "type": "structure", - "members": { - "relationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of your database to reboot.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#RebootRelationalDatabaseResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#RecordState": { - "type": "enum", - "members": { - "Started": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Started" - } - }, - "Succeeded": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Succeeded" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - } - } - }, - "com.amazonaws.lightsail#Region": { - "type": "structure", - "members": { - "continentCode": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "description": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "displayName": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "name": { - "target": "com.amazonaws.lightsail#RegionName", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "availabilityZones": { - "target": "com.amazonaws.lightsail#AvailabilityZoneList", - "traits": { - "smithy.api#documentation": "

The Availability Zones. Follows the format us-east-2a\n (case-sensitive).

" - } - }, - "relationalDatabaseAvailabilityZones": { - "target": "com.amazonaws.lightsail#AvailabilityZoneList", - "traits": { - "smithy.api#documentation": "

The Availability Zones for databases. Follows the format us-east-2a\n (case-sensitive).

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the Amazon Web Services Region.

" - } - }, - "com.amazonaws.lightsail#RegionList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#Region" - } - }, - "com.amazonaws.lightsail#RegionName": { - "type": "enum", - "members": { - "US_EAST_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-east-1" - } - }, - "US_EAST_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-east-2" - } - }, - "US_WEST_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-west-1" - } - }, - "US_WEST_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-west-2" - } - }, - "EU_WEST_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-west-1" - } - }, - "EU_WEST_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-west-2" - } - }, - "EU_WEST_3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-west-3" - } - }, - "EU_CENTRAL_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-central-1" - } - }, - "CA_CENTRAL_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ca-central-1" - } - }, - "AP_SOUTH_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-south-1" - } - }, - "AP_SOUTHEAST_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-1" - } - }, - "AP_SOUTHEAST_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-2" - } - }, - "AP_NORTHEAST_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-northeast-1" - } - }, - "AP_NORTHEAST_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-northeast-2" - } - }, - "EU_NORTH_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-north-1" - } - } - } - }, - "com.amazonaws.lightsail#RegisterContainerImage": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#RegisterContainerImageRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#RegisterContainerImageResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Registers a container image to your Amazon Lightsail container service.

\n \n

This action is not required if you install and use the Lightsail Control\n (lightsailctl) plugin to push container images to your Lightsail container service. For\n more information, see Pushing and managing container images on your Amazon Lightsail container services\n in the Amazon Lightsail Developer Guide.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/container-services/{serviceName}/images", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#RegisterContainerImageRequest": { - "type": "structure", - "members": { - "serviceName": { - "target": "com.amazonaws.lightsail#ContainerServiceName", - "traits": { - "smithy.api#documentation": "

The name of the container service for which to register a container image.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "label": { - "target": "com.amazonaws.lightsail#ContainerLabel", - "traits": { - "smithy.api#documentation": "

The label for the container image when it's registered to the container service.

\n

Use a descriptive label that you can use to track the different versions of your\n registered container images.

\n

Use the GetContainerImages action to return the container images registered\n to a Lightsail container service. The label is the portion\n of the following image name example:

\n \n

If the name of your container service is mycontainerservice, and the label\n that you specify is mystaticwebsite, then the name of the registered container\n image will be :mycontainerservice.mystaticwebsite.1.

\n

The number at the end of these image name examples represents the version of the\n registered container image. If you push and register another container image to the same\n Lightsail container service, with the same label, then the version number for the new\n registered container image will be 2. If you push and register another container\n image, the version number will be 3, and so on.

", - "smithy.api#required": {} - } - }, - "digest": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The digest of the container image to be registered.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#RegisterContainerImageResult": { - "type": "structure", - "members": { - "containerImage": { - "target": "com.amazonaws.lightsail#ContainerImage", - "traits": { - "smithy.api#documentation": "

An object that describes a container image that is registered to a Lightsail container\n service

" - } - } - } - }, - "com.amazonaws.lightsail#RegisteredDomainDelegationInfo": { - "type": "structure", - "members": { - "nameServersUpdateState": { - "target": "com.amazonaws.lightsail#NameServersUpdateState", - "traits": { - "smithy.api#documentation": "

An object that describes the state of the name server records that are automatically added\n to the Route 53 domain by Lightsail.

" - } - }, - "r53HostedZoneDeletionState": { - "target": "com.amazonaws.lightsail#R53HostedZoneDeletionState", - "traits": { - "smithy.api#documentation": "

Describes the deletion state of an Amazon Route 53 hosted zone for a domain that is\n being automatically delegated to an Amazon Lightsail DNS zone.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the delegation state of an Amazon Route 53 registered domain to Amazon Lightsail.

\n

When you delegate an Amazon Route 53 registered domain to Lightsail,\n you can manage the DNS of the domain using a Lightsail DNS zone. You no longer\n use the Route 53 hosted zone to manage the DNS of the domain. To delegate the\n domain, Lightsail automatically updates the domain's name servers in Route 53 to the name servers of the Lightsail DNS zone. Then, Lightsail automatically deletes the Route 53 hosted zone for the\n domain.

\n

All of the following conditions must be true for automatic domain delegation to be\n successful:

\n \n

If automatic domain delegation fails, or if you manage the DNS of your domain using a\n service other than Route 53, then you must manually add the Lightsail\n DNS zone name servers to your domain in order to delegate management of its DNS to Lightsail. For more information, see Creating a DNS zone to manage your domain’s records in Amazon Lightsail\n in the Amazon Lightsail Developer Guide.

" - } - }, - "com.amazonaws.lightsail#RelationalDatabase": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The unique name of the database resource in Lightsail.

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the database.

" - } - }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The support code for the database. Include this code in your email to support when you\n have questions about a database in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the database was created. Formatted in Unix time.

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

The Region name and Availability Zone where the database is located.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The Lightsail resource type for the database (for example,\n RelationalDatabase).

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" - } - }, - "relationalDatabaseBlueprintId": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The blueprint ID for the database. A blueprint describes the major engine version of a\n database.

" - } - }, - "relationalDatabaseBundleId": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The bundle ID for the database. A bundle describes the performance specifications for your\n database.

" - } - }, - "masterDatabaseName": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The name of the master database created when the Lightsail database resource is\n created.

" - } - }, - "hardware": { - "target": "com.amazonaws.lightsail#RelationalDatabaseHardware", - "traits": { - "smithy.api#documentation": "

Describes the hardware of the database.

" - } - }, - "state": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Describes the current state of the database.

" - } - }, - "secondaryAvailabilityZone": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

Describes the secondary Availability Zone of a high availability database.

\n

The secondary database is used for failover support of a high availability\n database.

" - } - }, - "backupRetentionEnabled": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether automated backup retention is enabled for the\n database.

" - } - }, - "pendingModifiedValues": { - "target": "com.amazonaws.lightsail#PendingModifiedRelationalDatabaseValues", - "traits": { - "smithy.api#documentation": "

Describes pending database value modifications.

" - } - }, - "engine": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The database software (for example, MySQL).

" - } - }, - "engineVersion": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The database engine version (for example, 5.7.23).

" - } - }, - "latestRestorableTime": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The latest point in time to which the database can be restored. Formatted in Unix\n time.

" - } - }, - "masterUsername": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The master user name of the database.

" - } - }, - "parameterApplyStatus": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The status of parameter updates for the database.

" - } - }, - "preferredBackupWindow": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The daily time range during which automated backups are created for the database (for\n example, 16:00-16:30).

" - } - }, - "preferredMaintenanceWindow": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The weekly time range during which system maintenance can occur on the database.

\n

In the format ddd:hh24:mi-ddd:hh24:mi. For example,\n Tue:17:00-Tue:17:30.

" - } - }, - "publiclyAccessible": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the database is publicly accessible.

" - } - }, - "masterEndpoint": { - "target": "com.amazonaws.lightsail#RelationalDatabaseEndpoint", - "traits": { - "smithy.api#documentation": "

The master endpoint for the database.

" - } - }, - "pendingMaintenanceActions": { - "target": "com.amazonaws.lightsail#PendingMaintenanceActionList", - "traits": { - "smithy.api#documentation": "

Describes the pending maintenance actions for the database.

" - } - }, - "caCertificateIdentifier": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The certificate associated with the database.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a database.

" - } - }, - "com.amazonaws.lightsail#RelationalDatabaseBlueprint": { - "type": "structure", - "members": { - "blueprintId": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The ID for the database blueprint.

" - } - }, - "engine": { - "target": "com.amazonaws.lightsail#RelationalDatabaseEngine", - "traits": { - "smithy.api#documentation": "

The database software of the database blueprint (for example, MySQL).

" - } - }, - "engineVersion": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The database engine version for the database blueprint (for example,\n 5.7.23).

" - } - }, - "engineDescription": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The description of the database engine for the database blueprint.

" - } - }, - "engineVersionDescription": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The description of the database engine version for the database blueprint.

" - } - }, - "isEngineDefault": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the engine version is the default for the database\n blueprint.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a database image, or blueprint. A blueprint describes the major engine version\n of a database.

" - } - }, - "com.amazonaws.lightsail#RelationalDatabaseBlueprintList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#RelationalDatabaseBlueprint" - } - }, - "com.amazonaws.lightsail#RelationalDatabaseBundle": { - "type": "structure", - "members": { - "bundleId": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The ID for the database bundle.

" - } - }, - "name": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The name for the database bundle.

" - } - }, - "price": { - "target": "com.amazonaws.lightsail#float", - "traits": { - "smithy.api#documentation": "

The cost of the database bundle in US currency.

" - } - }, - "ramSizeInGb": { - "target": "com.amazonaws.lightsail#float", - "traits": { - "smithy.api#documentation": "

The amount of RAM in GB (for example, 2.0) for the database bundle.

" - } - }, - "diskSizeInGb": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The size of the disk for the database bundle.

" - } - }, - "transferPerMonthInGb": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The data transfer rate per month in GB for the database bundle.

" - } - }, - "cpuCount": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The number of virtual CPUs (vCPUs) for the database bundle.

" - } - }, - "isEncrypted": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the database bundle is encrypted.

" - } - }, - "isActive": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the database bundle is active.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a database bundle. A bundle describes the performance specifications of the\n database.

" - } - }, - "com.amazonaws.lightsail#RelationalDatabaseBundleList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#RelationalDatabaseBundle" - } - }, - "com.amazonaws.lightsail#RelationalDatabaseEndpoint": { - "type": "structure", - "members": { - "port": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

Specifies the port that the database is listening on.

" - } - }, - "address": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Specifies the DNS address of the database.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an endpoint for a database.

" - } - }, - "com.amazonaws.lightsail#RelationalDatabaseEngine": { - "type": "enum", - "members": { - "MYSQL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "mysql" - } - } - } - }, - "com.amazonaws.lightsail#RelationalDatabaseEvent": { - "type": "structure", - "members": { - "resource": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The database that the database event relates to.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the database event was created.

" - } - }, - "message": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The message of the database event.

" - } - }, - "eventCategories": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

The category that the database event belongs to.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an event for a database.

" - } - }, - "com.amazonaws.lightsail#RelationalDatabaseEventList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#RelationalDatabaseEvent" - } - }, - "com.amazonaws.lightsail#RelationalDatabaseHardware": { - "type": "structure", - "members": { - "cpuCount": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The number of vCPUs for the database.

" - } - }, - "diskSizeInGb": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The size of the disk for the database.

" - } - }, - "ramSizeInGb": { - "target": "com.amazonaws.lightsail#float", - "traits": { - "smithy.api#documentation": "

The amount of RAM in GB for the database.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the hardware of a database.

" - } - }, - "com.amazonaws.lightsail#RelationalDatabaseList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#RelationalDatabase" - } - }, - "com.amazonaws.lightsail#RelationalDatabaseMetricName": { - "type": "enum", - "members": { - "CPUUtilization": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CPUUtilization" - } - }, - "DatabaseConnections": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DatabaseConnections" - } - }, - "DiskQueueDepth": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DiskQueueDepth" - } - }, - "FreeStorageSpace": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FreeStorageSpace" - } - }, - "NetworkReceiveThroughput": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NetworkReceiveThroughput" - } - }, - "NetworkTransmitThroughput": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NetworkTransmitThroughput" - } - } - } - }, - "com.amazonaws.lightsail#RelationalDatabaseParameter": { - "type": "structure", - "members": { - "allowedValues": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

Specifies the valid range of values for the parameter.

" - } - }, - "applyMethod": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

Indicates when parameter updates are applied.

\n

Can be immediate or pending-reboot.

" - } - }, - "applyType": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

Specifies the engine-specific parameter type.

" - } - }, - "dataType": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

Specifies the valid data type for the parameter.

" - } - }, - "description": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

Provides a description of the parameter.

" - } - }, - "isModifiable": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the parameter can be modified.

" - } - }, - "parameterName": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

Specifies the name of the parameter.

" - } - }, - "parameterValue": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

Specifies the value of the parameter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the parameters of a database.

" - } - }, - "com.amazonaws.lightsail#RelationalDatabaseParameterList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#RelationalDatabaseParameter" - } - }, - "com.amazonaws.lightsail#RelationalDatabasePasswordVersion": { - "type": "enum", - "members": { - "CURRENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CURRENT" - } - }, - "PREVIOUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PREVIOUS" - } - }, - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - } - } - }, - "com.amazonaws.lightsail#RelationalDatabaseSnapshot": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the database snapshot.

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the database snapshot.

" - } - }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The support code for the database snapshot. Include this code in your email to support\n when you have questions about a database snapshot in Lightsail. This code enables our\n support team to look up your Lightsail information more easily.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the database snapshot was created.

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

The Region name and Availability Zone where the database snapshot is located.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The Lightsail resource type.

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" - } - }, - "engine": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The software of the database snapshot (for example, MySQL)

" - } - }, - "engineVersion": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The database engine version for the database snapshot (for example,\n 5.7.23).

" - } - }, - "sizeInGb": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The size of the disk in GB (for example, 32) for the database\n snapshot.

" - } - }, - "state": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The state of the database snapshot.

" - } - }, - "fromRelationalDatabaseName": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the source database from which the database snapshot was created.

" - } - }, - "fromRelationalDatabaseArn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the database from which the database snapshot was\n created.

" - } - }, - "fromRelationalDatabaseBundleId": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The bundle ID of the database from which the database snapshot was created.

" - } - }, - "fromRelationalDatabaseBlueprintId": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The blueprint ID of the database from which the database snapshot was created. A blueprint\n describes the major engine version of a database.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a database snapshot.

" - } - }, - "com.amazonaws.lightsail#RelationalDatabaseSnapshotList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#RelationalDatabaseSnapshot" - } - }, - "com.amazonaws.lightsail#ReleaseStaticIp": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#ReleaseStaticIpRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#ReleaseStaticIpResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a specific static IP from your account.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/ReleaseStaticIp", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#ReleaseStaticIpRequest": { - "type": "structure", - "members": { - "staticIpName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the static IP to delete.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#ReleaseStaticIpResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#RenewalStatus": { - "type": "enum", - "members": { - "PendingAutoRenewal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PendingAutoRenewal" - } - }, - "PendingValidation": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PendingValidation" - } - }, - "Success": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Success" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - } - } - }, - "com.amazonaws.lightsail#RenewalStatusReason": { - "type": "string" - }, - "com.amazonaws.lightsail#RenewalSummary": { - "type": "structure", - "members": { - "domainValidationRecords": { - "target": "com.amazonaws.lightsail#DomainValidationRecordList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the domain validation records of the certificate.

" - } - }, - "renewalStatus": { - "target": "com.amazonaws.lightsail#RenewalStatus", - "traits": { - "smithy.api#documentation": "

The renewal status of the certificate.

\n

The following renewal status are possible:

\n " - } - }, - "renewalStatusReason": { - "target": "com.amazonaws.lightsail#RenewalStatusReason", - "traits": { - "smithy.api#documentation": "

The reason for the renewal status of the certificate.

" - } - }, - "updatedAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the certificate was last updated.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the status of a SSL/TLS certificate renewal managed by Amazon Lightsail.

" - } - }, - "com.amazonaws.lightsail#RequestFailureReason": { - "type": "string" - }, - "com.amazonaws.lightsail#ResetDistributionCache": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#ResetDistributionCacheRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#ResetDistributionCacheResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes currently cached content from your Amazon Lightsail content delivery network (CDN)\n distribution.

\n

After resetting the cache, the next time a content request is made, your distribution\n pulls, serves, and caches it from the origin.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/ResetDistributionCache", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#ResetDistributionCacheRequest": { - "type": "structure", - "members": { - "distributionName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the distribution for which to reset cache.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#ResetDistributionCacheResult": { - "type": "structure", - "members": { - "status": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The status of the reset cache request.

" - } - }, - "createTime": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp of the reset cache request (e.g., 1479734909.17) in Unix time\n format.

" - } - }, - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#ResourceArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:(aws[^:]*):([a-zA-Z0-9-]+):([a-z0-9-]+):([0-9]+):([a-zA-Z]+)/([a-zA-Z0-9-]+)$" - } - }, - "com.amazonaws.lightsail#ResourceBucketAccess": { - "type": "enum", - "members": { - "Allow": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "allow" - } - }, - "Deny": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deny" - } - } - } - }, - "com.amazonaws.lightsail#ResourceBudgetEstimate": { - "type": "structure", - "members": { - "resourceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The resource name.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The type of resource the budget will track.

" - } - }, - "costEstimates": { - "target": "com.amazonaws.lightsail#CostEstimates", - "traits": { - "smithy.api#documentation": "

The cost estimate for the specified budget.

" - } - }, - "startTime": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The estimate start time.

" - } - }, - "endTime": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The estimate end time.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the estimated cost or usage that a budget tracks.

" - } - }, - "com.amazonaws.lightsail#ResourceLocation": { - "type": "structure", - "members": { - "availabilityZone": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The Availability Zone. Follows the format us-east-2a (case-sensitive).

" - } - }, - "regionName": { - "target": "com.amazonaws.lightsail#RegionName", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region name.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the resource location.

" - } - }, - "com.amazonaws.lightsail#ResourceName": { - "type": "string", - "traits": { - "smithy.api#pattern": "^\\w[\\w\\-]*\\w$" - } - }, - "com.amazonaws.lightsail#ResourceNameList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#ResourceName" - } - }, - "com.amazonaws.lightsail#ResourceReceivingAccess": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the Lightsail instance.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Lightsail resource type (for example, Instance).

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an Amazon Lightsail instance that has access to a Lightsail bucket.

" - } - }, - "com.amazonaws.lightsail#ResourceRecord": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The name of the record.

" - } - }, - "type": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The DNS record type.

" - } - }, - "value": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The value for the DNS record.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the domain name system (DNS) records to add to your domain's DNS to validate it\n for an Amazon Lightsail certificate.

" - } - }, - "com.amazonaws.lightsail#ResourceType": { - "type": "enum", - "members": { - "ContainerService": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ContainerService" - } - }, - "Instance": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Instance" - } - }, - "StaticIp": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "StaticIp" - } - }, - "KeyPair": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KeyPair" - } - }, - "InstanceSnapshot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InstanceSnapshot" - } - }, - "Domain": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Domain" - } - }, - "PeeredVpc": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PeeredVpc" - } - }, - "LoadBalancer": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LoadBalancer" - } - }, - "LoadBalancerTlsCertificate": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LoadBalancerTlsCertificate" - } - }, - "Disk": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Disk" - } - }, - "DiskSnapshot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DiskSnapshot" - } - }, - "RelationalDatabase": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RelationalDatabase" - } - }, - "RelationalDatabaseSnapshot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RelationalDatabaseSnapshot" - } - }, - "ExportSnapshotRecord": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ExportSnapshotRecord" - } - }, - "CloudFormationStackRecord": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CloudFormationStackRecord" - } - }, - "Alarm": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Alarm" - } - }, - "ContactMethod": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ContactMethod" - } - }, - "Distribution": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Distribution" - } - }, - "Certificate": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Certificate" - } - }, - "Bucket": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Bucket" - } - } - } - }, - "com.amazonaws.lightsail#ResourcesBudgetEstimate": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#ResourceBudgetEstimate" - } - }, - "com.amazonaws.lightsail#RevocationReason": { - "type": "string" - }, - "com.amazonaws.lightsail#SendContactMethodVerification": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#SendContactMethodVerificationRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#SendContactMethodVerificationResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Sends a verification request to an email contact method to ensure it's owned by the\n requester. SMS contact methods don't need to be verified.

\n

A contact method is used to send you notifications about your Amazon Lightsail resources.\n You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services\n Regions, and SMS text messages cannot be sent to some countries/regions. For more information,\n see Notifications in Amazon Lightsail.

\n

A verification request is sent to the contact method when you initially create it. Use\n this action to send another verification request if a previous verification request was\n deleted, or has expired.

\n \n

Notifications are not sent to an email contact method until after it is verified, and\n confirmed as valid.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/SendContactMethodVerification", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#SendContactMethodVerificationRequest": { - "type": "structure", - "members": { - "protocol": { - "target": "com.amazonaws.lightsail#ContactMethodVerificationProtocol", - "traits": { - "smithy.api#documentation": "

The protocol to verify, such as Email or SMS (text\n messaging).

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#SendContactMethodVerificationResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#SensitiveNonEmptyString": { - "type": "string", - "traits": { - "smithy.api#pattern": "\\S", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.lightsail#SensitiveString": { - "type": "string", - "traits": { - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.lightsail#SerialNumber": { - "type": "string" - }, - "com.amazonaws.lightsail#ServiceException": { - "type": "structure", - "members": { - "code": { - "target": "com.amazonaws.lightsail#string" + "com.amazonaws.lightsail#UpdateRelationalDatabase": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#UpdateRelationalDatabaseRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#UpdateRelationalDatabaseResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Allows the update of one or more attributes of a database in Amazon Lightsail.

\n

Updates are applied immediately, or in cases where the updates could result in an outage,\n are applied during the database's predefined maintenance window.

\n

The update relational database operation supports tag-based access control\n via resource tags applied to the resource identified by relationalDatabaseName. For more\n information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/UpdateRelationalDatabase", + "code": 200 + } + } }, - "docs": { - "target": "com.amazonaws.lightsail#string" + "com.amazonaws.lightsail#UpdateRelationalDatabaseParameters": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#UpdateRelationalDatabaseParametersRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#UpdateRelationalDatabaseParametersResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Allows the update of one or more parameters of a database in Amazon Lightsail.

\n

Parameter updates don't cause outages; therefore, their application is not subject to the\n preferred maintenance window. However, there are two ways in which parameter updates are\n applied: dynamic or pending-reboot. Parameters marked with a\n dynamic apply type are applied immediately. Parameters marked with a\n pending-reboot apply type are applied only after the database is rebooted using\n the reboot relational database operation.

\n

The update relational database parameters operation supports tag-based access\n control via resource tags applied to the resource identified by relationalDatabaseName. For\n more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/UpdateRelationalDatabaseParameters", + "code": 200 + } + } }, - "message": { - "target": "com.amazonaws.lightsail#string" + "com.amazonaws.lightsail#UpdateRelationalDatabaseParametersRequest": { + "type": "structure", + "members": { + "relationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of your database for which to update parameters.

", + "smithy.api#required": {} + } + }, + "parameters": { + "target": "com.amazonaws.lightsail#RelationalDatabaseParameterList", + "traits": { + "smithy.api#documentation": "

The database parameters to update.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - "tip": { - "target": "com.amazonaws.lightsail#string" - } - }, - "traits": { - "smithy.api#documentation": "

A general service exception.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.lightsail#Session": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The session name.

" - } - }, - "url": { - "target": "com.amazonaws.lightsail#SensitiveNonEmptyString", - "traits": { - "smithy.api#documentation": "

The session URL.

" - } - }, - "isPrimary": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

When true, this Boolean value indicates the primary session for the specified\n resource.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a web-based, remote graphical user interface (GUI), NICE DCV session. The session is used to access a virtual\n computer’s operating system or application.

" - } - }, - "com.amazonaws.lightsail#Sessions": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#Session" - } - }, - "com.amazonaws.lightsail#SetIpAddressType": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#SetIpAddressTypeRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#SetIpAddressTypeResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Sets the IP address type for an Amazon Lightsail resource.

\n

Use this action to enable dual-stack for a resource, which enables IPv4 and IPv6 for the\n specified resource. Alternately, you can use this action to disable dual-stack, and enable\n IPv4 only.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/SetIpAddressType", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#SetIpAddressTypeRequest": { - "type": "structure", - "members": { - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The resource type.

\n

The possible values are Distribution, Instance, and\n LoadBalancer.

\n \n

Distribution-related APIs are available only in the N. Virginia (us-east-1)\n Amazon Web Services Region. Set your Amazon Web Services Region configuration to\n us-east-1 to create, view, or edit distributions.

\n ", - "smithy.api#required": {} - } - }, - "resourceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the resource for which to set the IP address type.

", - "smithy.api#required": {} - } - }, - "ipAddressType": { - "target": "com.amazonaws.lightsail#IpAddressType", - "traits": { - "smithy.api#documentation": "

The IP address type to set for the specified resource.

\n

The possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#SetIpAddressTypeResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#SetResourceAccessForBucket": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#SetResourceAccessForBucketRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#SetResourceAccessForBucketResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Sets the Amazon Lightsail resources that can access the specified Lightsail\n bucket.

\n

Lightsail buckets currently support setting access for Lightsail instances in the same\n Amazon Web Services Region.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/SetResourceAccessForBucket", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#SetResourceAccessForBucketRequest": { - "type": "structure", - "members": { - "resourceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the Lightsail instance for which to set bucket access. The instance must be\n in a running or stopped state.

", - "smithy.api#required": {} - } - }, - "bucketName": { - "target": "com.amazonaws.lightsail#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket for which to set access to another Lightsail resource.

", - "smithy.api#required": {} - } - }, - "access": { - "target": "com.amazonaws.lightsail#ResourceBucketAccess", - "traits": { - "smithy.api#documentation": "

The access setting.

\n

The following access settings are available:

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#SetResourceAccessForBucketResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#StartGUISession": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#StartGUISessionRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#StartGUISessionResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Initiates a graphical user interface (GUI) session that’s used to access a virtual\n computer’s operating system and application. The session will be active for 1 hour. Use this action to resume the session after it expires.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/start-gui-session", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#StartGUISessionRequest": { - "type": "structure", - "members": { - "resourceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The resource name.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#StartGUISessionResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

The available API operations.

" - } - } - } - }, - "com.amazonaws.lightsail#StartInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#StartInstanceRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#StartInstanceResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

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

\n \n

When you start a stopped instance, Lightsail assigns a new public IP address to the\n instance. To use the same IP address after stopping and starting an instance, create a\n static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide.

\n \n

The start instance operation supports tag-based access control via resource\n tags applied to the resource identified by instance name. For more information,\n see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/StartInstance", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#StartInstanceRequest": { - "type": "structure", - "members": { - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#StartInstanceResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#StartRelationalDatabase": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#StartRelationalDatabaseRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#StartRelationalDatabaseResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Starts a specific database from a stopped state in Amazon Lightsail. To restart a database,\n use the reboot relational database operation.

\n

The start relational database operation supports tag-based access control via\n resource tags applied to the resource identified by relationalDatabaseName. For more\n information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/StartRelationalDatabase", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#StartRelationalDatabaseRequest": { - "type": "structure", - "members": { - "relationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of your database to start.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#StartRelationalDatabaseResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#StaticIp": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The resource type (usually StaticIp).

" - } - }, - "ipAddress": { - "target": "com.amazonaws.lightsail#IpAddress", - "traits": { - "smithy.api#documentation": "

The static IP address.

" - } - }, - "attachedTo": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "isAttached": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the static IP is attached.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a static IP.

" - } - }, - "com.amazonaws.lightsail#StaticIpList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#StaticIp" - } - }, - "com.amazonaws.lightsail#Status": { - "type": "enum", - "members": { - "StartExpired": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "startExpired" - } - }, - "NotStarted": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "notStarted" - } - }, - "Started": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "started" - } - }, - "Starting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "starting" - } - }, - "Stopped": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "stopped" - } - }, - "Stopping": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "stopping" - } - }, - "SettingUpInstance": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "settingUpInstance" - } - }, - "FailedInstanceCreation": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failedInstanceCreation" - } - }, - "FailedStartingGUISession": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failedStartingGUISession" - } - }, - "FailedStoppingGUISession": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failedStoppingGUISession" - } - } - } - }, - "com.amazonaws.lightsail#StatusType": { - "type": "enum", - "members": { - "Active": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Active" - } - }, - "Inactive": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Inactive" - } - } - } - }, - "com.amazonaws.lightsail#StopGUISession": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#StopGUISessionRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#StopGUISessionResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Terminates a web-based NICE DCV session that’s used to access a virtual computer’s\n operating system or application. The session will close and any unsaved data will be lost.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/stop-gui-session", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#StopGUISessionRequest": { - "type": "structure", - "members": { - "resourceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The resource name.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#StopGUISessionResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

The available API operations.

" - } - } - } - }, - "com.amazonaws.lightsail#StopInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#StopInstanceRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#StopInstanceResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Stops a specific Amazon Lightsail instance that is currently running.

\n \n

When you start a stopped instance, Lightsail assigns a new public IP address to the\n instance. To use the same IP address after stopping and starting an instance, create a\n static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide.

\n \n

The stop instance operation supports tag-based access control via resource\n tags applied to the resource identified by instance name. For more information,\n see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/StopInstance", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#StopInstanceOnIdleRequest": { - "type": "structure", - "members": { - "threshold": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The value to compare with the duration.

" - } - }, - "duration": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The amount of idle time in minutes after which your virtual computer will automatically stop.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a request to create or edit the StopInstanceOnIdle add-on.

\n \n

This add-on only applies to Lightsail for Research resources.

\n " - } - }, - "com.amazonaws.lightsail#StopInstanceRequest": { - "type": "structure", - "members": { - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - }, - "force": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

When set to True, forces a Lightsail instance that is stuck in a\n stopping state to stop.

\n \n

Only use the force parameter if your instance is stuck in the\n stopping state. In any other state, your instance should stop normally\n without adding this parameter to your API request.

\n " - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#StopInstanceResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#StopRelationalDatabase": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#StopRelationalDatabaseRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#StopRelationalDatabaseResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Stops a specific database that is currently running in Amazon Lightsail.

\n

The stop relational database operation supports tag-based access control via\n resource tags applied to the resource identified by relationalDatabaseName. For more\n information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/StopRelationalDatabase", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#StopRelationalDatabaseRequest": { - "type": "structure", - "members": { - "relationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of your database to stop.

", - "smithy.api#required": {} - } - }, - "relationalDatabaseSnapshotName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of your new database snapshot to be created before stopping your database.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#StopRelationalDatabaseResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#StringList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#string" - } - }, - "com.amazonaws.lightsail#StringMax256": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.lightsail#SubjectAlternativeNameList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#DomainName" - } - }, - "com.amazonaws.lightsail#Tag": { - "type": "structure", - "members": { - "key": { - "target": "com.amazonaws.lightsail#TagKey", - "traits": { - "smithy.api#documentation": "

The key of the tag.

\n

Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the\n following characters: + - = . _ : / @

" - } - }, - "value": { - "target": "com.amazonaws.lightsail#TagValue", - "traits": { - "smithy.api#documentation": "

The value of the tag.

\n

Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the\n following characters: + - = . _ : / @

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a tag key and optional value assigned to an Amazon Lightsail resource.

\n

For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

" - } - }, - "com.amazonaws.lightsail#TagKey": { - "type": "string" - }, - "com.amazonaws.lightsail#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#TagKey" - } - }, - "com.amazonaws.lightsail#TagList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#Tag" - } - }, - "com.amazonaws.lightsail#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#TagResourceRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#TagResourceResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a\n maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique\n per resource. For more information about tags, see the Amazon Lightsail Developer Guide.

\n

The tag resource operation supports tag-based access control via request tags\n and resource tags applied to the resource identified by resource name. For more\n information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/TagResource", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#TagResourceRequest": { - "type": "structure", - "members": { - "resourceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the resource to which you are adding tags.

", - "smithy.api#required": {} - } - }, - "resourceArn": { - "target": "com.amazonaws.lightsail#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to which you want to add a tag.

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag key and optional value.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#TagResourceResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#TagValue": { - "type": "string" - }, - "com.amazonaws.lightsail#TestAlarm": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#TestAlarmRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#TestAlarmResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Tests an alarm by displaying a banner on the Amazon Lightsail console. If a notification\n trigger is configured for the specified alarm, the test also sends a notification to the\n notification protocol (Email and/or SMS) configured for the\n alarm.

\n

An alarm is used to monitor a single metric for one of your resources. When a metric\n condition is met, the alarm can notify you by email, SMS text message, and a banner displayed\n on the Amazon Lightsail console. For more information, see Alarms\n in Amazon Lightsail.

", - "smithy.api#http": { - "method": "GET", - "uri": "/ls/api/2016-11-28/TestAlarm", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#TestAlarmRequest": { - "type": "structure", - "members": { - "alarmName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the alarm to test.

", - "smithy.api#required": {} - } - }, - "state": { - "target": "com.amazonaws.lightsail#AlarmState", - "traits": { - "smithy.api#documentation": "

The alarm state to test.

\n

An alarm has the following possible states that can be tested:

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#TestAlarmResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#TimeOfDay": { - "type": "string", - "traits": { - "smithy.api#pattern": "^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$" - } - }, - "com.amazonaws.lightsail#TimePeriod": { - "type": "structure", - "members": { - "start": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The beginning of the time period. The start date is inclusive. For example, if start is 2017-01-01, Lightsail for Research retrieves cost and usage data starting at 2017-01-01 up to the end date. The start date must be equal to or no later than the current date to avoid a validation error.

" - } - }, - "end": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The end of the time period. The end date is exclusive. For example, if end is 2017-05-01, Lightsail for Research retrieves cost and usage data from the start date up to, but not including, 2017-05-01.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Sets the start date and end date for retrieving a cost estimate. 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.

" - } - }, - "com.amazonaws.lightsail#TreatMissingData": { - "type": "enum", - "members": { - "Breaching": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "breaching" - } - }, - "NotBreaching": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "notBreaching" - } - }, - "Ignore": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ignore" - } - }, - "Missing": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "missing" - } - } - } - }, - "com.amazonaws.lightsail#UnauthenticatedException": { - "type": "structure", - "members": { - "code": { - "target": "com.amazonaws.lightsail#string" + "com.amazonaws.lightsail#UpdateRelationalDatabaseParametersResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - "docs": { - "target": "com.amazonaws.lightsail#string" + "com.amazonaws.lightsail#UpdateRelationalDatabaseRequest": { + "type": "structure", + "members": { + "relationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of your Lightsail database resource to update.

", + "smithy.api#required": {} + } + }, + "masterUserPassword": { + "target": "com.amazonaws.lightsail#SensitiveString", + "traits": { + "smithy.api#documentation": "

The password for the master user. The password can include any printable ASCII character\n except \"/\", \"\"\", or \"@\".

\n

MySQL\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n PostgreSQL\n

\n

Constraints: Must contain from 8 to 128 characters.

" + } + }, + "rotateMasterUserPassword": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

When true, the master user password is changed to a new strong password\n generated by Lightsail.

\n

Use the get relational database master user password operation to get the new\n password.

" + } + }, + "preferredBackupWindow": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The daily time range during which automated backups are created for your database if\n automated backups are enabled.

\n

Constraints:

\n " + } + }, + "preferredMaintenanceWindow": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur on your database.

\n

The default is a 30-minute window selected at random from an 8-hour block of time for each\n Amazon Web Services Region, occurring on a random day of the week.

\n

Constraints:

\n " + } + }, + "enableBackupRetention": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

When true, enables automated backup retention for your database.

\n

Updates are applied during the next maintenance window because this can result in an\n outage.

" + } + }, + "disableBackupRetention": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

When true, disables automated backup retention for your database.

\n

Disabling backup retention deletes all automated database backups. Before disabling this,\n you may want to create a snapshot of your database using the create relational database\n snapshot operation.

\n

Updates are applied during the next maintenance window because this can result in an\n outage.

" + } + }, + "publiclyAccessible": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

Specifies the accessibility options for your database. A value of true\n specifies a database that is available to resources outside of your Lightsail account. A\n value of false specifies a database that is available only to your Lightsail\n resources in the same region as your database.

" + } + }, + "applyImmediately": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

When true, applies changes immediately. When false, applies\n changes during the preferred maintenance window. Some changes may cause an outage.

\n

Default: false\n

" + } + }, + "caCertificateIdentifier": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

Indicates the certificate that needs to be associated with the database.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - "message": { - "target": "com.amazonaws.lightsail#string" + "com.amazonaws.lightsail#UpdateRelationalDatabaseResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - "tip": { - "target": "com.amazonaws.lightsail#string" - } - }, - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#error": "client", - "smithy.api#httpError": 401 - } - }, - "com.amazonaws.lightsail#UnpeerVpc": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#UnpeerVpcRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#UnpeerVpcResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Unpeers the Lightsail VPC from the user's default VPC.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/UnpeerVpc", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#UnpeerVpcRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#UnpeerVpcResult": { - "type": "structure", - "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#UntagResourceResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the specified set of tag keys and their values from the specified Amazon Lightsail\n resource.

\n

The untag resource operation supports tag-based access control via request\n tags and resource tags applied to the resource identified by resource name. For\n more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/UntagResource", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#UntagResourceRequest": { - "type": "structure", - "members": { - "resourceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the resource from which you are removing a tag.

", - "smithy.api#required": {} - } - }, - "resourceArn": { - "target": "com.amazonaws.lightsail#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource from which you want to remove a tag.

" - } - }, - "tagKeys": { - "target": "com.amazonaws.lightsail#TagKeyList", - "traits": { - "smithy.api#documentation": "

The tag keys to delete from the specified resource.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#UntagResourceResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#UpdateBucket": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#UpdateBucketRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#UpdateBucketResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates an existing Amazon Lightsail bucket.

\n

Use this action to update the configuration of an existing bucket, such as versioning,\n public accessibility, and the Amazon Web Services accounts that can access the bucket.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/UpdateBucket", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#UpdateBucketBundle": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#UpdateBucketBundleRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#UpdateBucketBundleResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.

\n

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a\n bucket. You can update a bucket's bundle only one time within a monthly Amazon Web Services\n billing cycle. To determine if you can update a bucket's bundle, use the GetBuckets action. The\n ableToUpdateBundle parameter in the response will indicate whether you can\n currently update a bucket's bundle.

\n

Update a bucket's bundle if it's consistently going over its storage space or data\n transfer quota, or if a bucket's usage is consistently in the lower range of its storage space\n or data transfer quota. Due to the unpredictable usage fluctuations that a bucket might\n experience, we strongly recommend that you update a bucket's bundle only as a long-term\n strategy, instead of as a short-term, monthly cost-cutting measure. Choose a bucket bundle\n that will provide the bucket with ample storage space and data transfer for a long time to\n come.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/UpdateBucketBundle", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#UpdateBucketBundleRequest": { - "type": "structure", - "members": { - "bucketName": { - "target": "com.amazonaws.lightsail#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket for which to update the bundle.

", - "smithy.api#required": {} - } - }, - "bundleId": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the new bundle to apply to the bucket.

\n

Use the GetBucketBundles action to get a list of\n bundle IDs that you can specify.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#UpdateBucketBundleResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#UpdateBucketRequest": { - "type": "structure", - "members": { - "bucketName": { - "target": "com.amazonaws.lightsail#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket to update.

", - "smithy.api#required": {} - } - }, - "accessRules": { - "target": "com.amazonaws.lightsail#AccessRules", - "traits": { - "smithy.api#documentation": "

An object that sets the public accessibility of objects in the specified bucket.

" - } - }, - "versioning": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Specifies whether to enable or suspend versioning of objects in the bucket.

\n

The following options can be specified:

\n " - } - }, - "readonlyAccessAccounts": { - "target": "com.amazonaws.lightsail#PartnerIdList", - "traits": { - "smithy.api#documentation": "

An array of strings to specify the Amazon Web Services account IDs that can access the\n bucket.

\n

You can give a maximum of 10 Amazon Web Services accounts access to a bucket.

" - } - }, - "accessLogConfig": { - "target": "com.amazonaws.lightsail#BucketAccessLogConfig", - "traits": { - "smithy.api#documentation": "

An object that describes the access log configuration for the bucket.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#UpdateBucketResult": { - "type": "structure", - "members": { - "bucket": { - "target": "com.amazonaws.lightsail#Bucket", - "traits": { - "smithy.api#documentation": "

An object that describes the bucket that is updated.

" - } - }, - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#UpdateContainerService": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#UpdateContainerServiceRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#UpdateContainerServiceResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the configuration of your Amazon Lightsail container service, such as its power,\n scale, and public domain names.

", - "smithy.api#http": { - "method": "PATCH", - "uri": "/ls/api/2016-11-28/container-services/{serviceName}", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#UpdateContainerServiceRequest": { - "type": "structure", - "members": { - "serviceName": { - "target": "com.amazonaws.lightsail#ContainerServiceName", - "traits": { - "smithy.api#documentation": "

The name of the container service to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "power": { - "target": "com.amazonaws.lightsail#ContainerServicePowerName", - "traits": { - "smithy.api#documentation": "

The power for the container service.

\n

The power specifies the amount of memory, vCPUs, and base monthly cost of each node of the\n container service. The power and scale of a container service makes\n up its configured capacity. To determine the monthly price of your container service, multiply\n the base price of the power with the scale (the number of nodes) of\n the service.

\n

Use the GetContainerServicePowers action to view the specifications of each\n power option.

" - } - }, - "scale": { - "target": "com.amazonaws.lightsail#ContainerServiceScale", - "traits": { - "smithy.api#documentation": "

The scale for the container service.

\n

The scale specifies the allocated compute nodes of the container service. The\n power and scale of a container service makes up its configured\n capacity. To determine the monthly price of your container service, multiply the base price of\n the power with the scale (the number of nodes) of the\n service.

" - } - }, - "isDisabled": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value to indicate whether the container service is disabled.

" - } - }, - "publicDomainNames": { - "target": "com.amazonaws.lightsail#ContainerServicePublicDomains", - "traits": { - "smithy.api#documentation": "

The public domain names to use with the container service, such as\n example.com and www.example.com.

\n

You can specify up to four public domain names for a container service. The domain names\n that you specify are used when you create a deployment with a container configured as the\n public endpoint of your container service.

\n

If you don't specify public domain names, then you can use the default domain of the\n container service.

\n \n

You must create and validate an SSL/TLS certificate before you can use public domain\n names with your container service. Use the CreateCertificate action to create a\n certificate for the public domain names you want to use with your container service.

\n \n

You can specify public domain names using a string to array map as shown in the example\n later on this page.

" - } - }, - "privateRegistryAccess": { - "target": "com.amazonaws.lightsail#PrivateRegistryAccessRequest", - "traits": { - "smithy.api#documentation": "

An object to describe the configuration for the container service to access private\n container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private\n repositories.

\n

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#UpdateContainerServiceResult": { - "type": "structure", - "members": { - "containerService": { - "target": "com.amazonaws.lightsail#ContainerService", - "traits": { - "smithy.api#documentation": "

An object that describes a container service.

" - } - } - } - }, - "com.amazonaws.lightsail#UpdateDistribution": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#UpdateDistributionRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#UpdateDistributionResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates an existing Amazon Lightsail content delivery network (CDN) distribution.

\n

Use this action to update the configuration of your existing distribution.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/UpdateDistribution", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#UpdateDistributionBundle": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#UpdateDistributionBundleRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#UpdateDistributionBundleResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the bundle of your Amazon Lightsail content delivery network (CDN)\n distribution.

\n

A distribution bundle specifies the monthly network transfer quota and monthly cost of\n your distribution.

\n

Update your distribution's bundle if your distribution is going over its monthly network\n transfer quota and is incurring an overage fee.

\n

You can update your distribution's bundle only one time within your monthly Amazon Web Services billing cycle. To determine if you can update your distribution's bundle, use the\n GetDistributions action. The ableToUpdateBundle parameter in the\n result will indicate whether you can currently update your distribution's bundle.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/UpdateDistributionBundle", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#UpdateDistributionBundleRequest": { - "type": "structure", - "members": { - "distributionName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the distribution for which to update the bundle.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

" - } - }, - "bundleId": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The bundle ID of the new bundle to apply to your distribution.

\n

Use the GetDistributionBundles action to get a list of distribution bundle\n IDs that you can specify.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#UpdateDistributionBundleResult": { - "type": "structure", - "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An object that describes the result of the action, such as the status of the request, the\n timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#UpdateDistributionRequest": { - "type": "structure", - "members": { - "distributionName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the distribution to update.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

", - "smithy.api#required": {} - } - }, - "origin": { - "target": "com.amazonaws.lightsail#InputOrigin", - "traits": { - "smithy.api#documentation": "

An object that describes the origin resource for the distribution, such as a Lightsail\n instance, bucket, or load balancer.

\n

The distribution pulls, caches, and serves content from the origin.

" - } - }, - "defaultCacheBehavior": { - "target": "com.amazonaws.lightsail#CacheBehavior", - "traits": { - "smithy.api#documentation": "

An object that describes the default cache behavior for the distribution.

" - } - }, - "cacheBehaviorSettings": { - "target": "com.amazonaws.lightsail#CacheSettings", - "traits": { - "smithy.api#documentation": "

An object that describes the cache behavior settings for the distribution.

\n \n

The cacheBehaviorSettings specified in your\n UpdateDistributionRequest will replace your distribution's existing\n settings.

\n " - } - }, - "cacheBehaviors": { - "target": "com.amazonaws.lightsail#CacheBehaviorList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the per-path cache behavior for the distribution.

" - } - }, - "isEnabled": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether to enable the distribution.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#UpdateDistributionResult": { - "type": "structure", - "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#UpdateDomainEntry": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#UpdateDomainEntryRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#UpdateDomainEntryResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a domain recordset after it is created.

\n

The update domain entry operation supports tag-based access control via\n resource tags applied to the resource identified by domain name. For more\n information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/UpdateDomainEntry", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#UpdateDomainEntryRequest": { - "type": "structure", - "members": { - "domainName": { - "target": "com.amazonaws.lightsail#DomainName", - "traits": { - "smithy.api#documentation": "

The name of the domain recordset to update.

", - "smithy.api#required": {} - } - }, - "domainEntry": { - "target": "com.amazonaws.lightsail#DomainEntry", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#UpdateDomainEntryResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#UpdateInstanceMetadataOptions": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#UpdateInstanceMetadataOptionsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#UpdateInstanceMetadataOptionsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Modifies the Amazon Lightsail instance metadata parameters on a running or stopped\n instance. When you modify the parameters on a running instance, the GetInstance\n or GetInstances API operation initially responds with a state of\n pending. After the parameter modifications are successfully applied, the state\n changes to applied in subsequent GetInstance or\n GetInstances API calls. For more information, see Use IMDSv2 with an Amazon Lightsail instance in the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/UpdateInstanceMetadataOptions", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#UpdateInstanceMetadataOptionsRequest": { - "type": "structure", - "members": { - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the instance for which to update metadata parameters.

", - "smithy.api#required": {} - } - }, - "httpTokens": { - "target": "com.amazonaws.lightsail#HttpTokens", - "traits": { - "smithy.api#documentation": "

The state of token usage for your instance metadata requests. If the parameter is not\n specified in the request, the default state is optional.

\n

If the state is optional, you can choose whether to retrieve instance\n metadata with a signed token header on your request. If you retrieve the IAM role credentials\n without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role\n credentials by using a valid signed token, the version 2.0 role credentials are\n returned.

\n

If the state is required, you must send a signed token header with all\n instance metadata retrieval requests. In this state, retrieving the IAM role credential always\n returns the version 2.0 credentials. The version 1.0 credentials are not available.

" - } - }, - "httpEndpoint": { - "target": "com.amazonaws.lightsail#HttpEndpoint", - "traits": { - "smithy.api#documentation": "

Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not\n specified, the existing state is maintained.

\n

If you specify a value of disabled, you cannot access your instance\n metadata.

" - } - }, - "httpPutResponseHopLimit": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. A larger number\n means that the instance metadata requests can travel farther. If no parameter is specified,\n the existing state is maintained.

" - } - }, - "httpProtocolIpv6": { - "target": "com.amazonaws.lightsail#HttpProtocolIpv6", - "traits": { - "smithy.api#documentation": "

Enables or disables the IPv6 endpoint for the instance metadata service. This setting\n applies only when the HTTP metadata endpoint is enabled.

\n \n

This parameter is available only for instances in the Europe (Stockholm) Amazon Web Services Region (eu-north-1).

\n " - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#UpdateInstanceMetadataOptionsResult": { - "type": "structure", - "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#UpdateLoadBalancerAttribute": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#UpdateLoadBalancerAttributeRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#UpdateLoadBalancerAttributeResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the specified attribute for a load balancer. You can only update one attribute at\n a time.

\n

The update load balancer attribute operation supports tag-based access\n control via resource tags applied to the resource identified by load balancer\n name. For more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/UpdateLoadBalancerAttribute", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#UpdateLoadBalancerAttributeRequest": { - "type": "structure", - "members": { - "loadBalancerName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the load balancer that you want to modify (e.g.,\n my-load-balancer.

", - "smithy.api#required": {} - } - }, - "attributeName": { - "target": "com.amazonaws.lightsail#LoadBalancerAttributeName", - "traits": { - "smithy.api#documentation": "

The name of the attribute you want to update.

", - "smithy.api#required": {} - } - }, - "attributeValue": { - "target": "com.amazonaws.lightsail#StringMax256", - "traits": { - "smithy.api#documentation": "

The value that you want to specify for the attribute name.

\n

The following values are supported depending on what you specify for the\n attributeName request parameter:

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#UpdateLoadBalancerAttributeResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#UpdateRelationalDatabase": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#UpdateRelationalDatabaseRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#UpdateRelationalDatabaseResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Allows the update of one or more attributes of a database in Amazon Lightsail.

\n

Updates are applied immediately, or in cases where the updates could result in an outage,\n are applied during the database's predefined maintenance window.

\n

The update relational database operation supports tag-based access control\n via resource tags applied to the resource identified by relationalDatabaseName. For more\n information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/UpdateRelationalDatabase", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#UpdateRelationalDatabaseParameters": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#UpdateRelationalDatabaseParametersRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#UpdateRelationalDatabaseParametersResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Allows the update of one or more parameters of a database in Amazon Lightsail.

\n

Parameter updates don't cause outages; therefore, their application is not subject to the\n preferred maintenance window. However, there are two ways in which parameter updates are\n applied: dynamic or pending-reboot. Parameters marked with a\n dynamic apply type are applied immediately. Parameters marked with a\n pending-reboot apply type are applied only after the database is rebooted using\n the reboot relational database operation.

\n

The update relational database parameters operation supports tag-based access\n control via resource tags applied to the resource identified by relationalDatabaseName. For\n more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/UpdateRelationalDatabaseParameters", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#UpdateRelationalDatabaseParametersRequest": { - "type": "structure", - "members": { - "relationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of your database for which to update parameters.

", - "smithy.api#required": {} - } - }, - "parameters": { - "target": "com.amazonaws.lightsail#RelationalDatabaseParameterList", - "traits": { - "smithy.api#documentation": "

The database parameters to update.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#UpdateRelationalDatabaseParametersResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#UpdateRelationalDatabaseRequest": { - "type": "structure", - "members": { - "relationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of your Lightsail database resource to update.

", - "smithy.api#required": {} - } - }, - "masterUserPassword": { - "target": "com.amazonaws.lightsail#SensitiveString", - "traits": { - "smithy.api#documentation": "

The password for the master user. The password can include any printable ASCII character\n except \"/\", \"\"\", or \"@\".

\n

MySQL\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n PostgreSQL\n

\n

Constraints: Must contain from 8 to 128 characters.

" - } - }, - "rotateMasterUserPassword": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

When true, the master user password is changed to a new strong password\n generated by Lightsail.

\n

Use the get relational database master user password operation to get the new\n password.

" - } - }, - "preferredBackupWindow": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The daily time range during which automated backups are created for your database if\n automated backups are enabled.

\n

Constraints:

\n " - } - }, - "preferredMaintenanceWindow": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The weekly time range during which system maintenance can occur on your database.

\n

The default is a 30-minute window selected at random from an 8-hour block of time for each\n Amazon Web Services Region, occurring on a random day of the week.

\n

Constraints:

\n " - } - }, - "enableBackupRetention": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

When true, enables automated backup retention for your database.

\n

Updates are applied during the next maintenance window because this can result in an\n outage.

" - } - }, - "disableBackupRetention": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

When true, disables automated backup retention for your database.

\n

Disabling backup retention deletes all automated database backups. Before disabling this,\n you may want to create a snapshot of your database using the create relational database\n snapshot operation.

\n

Updates are applied during the next maintenance window because this can result in an\n outage.

" - } - }, - "publiclyAccessible": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

Specifies the accessibility options for your database. A value of true\n specifies a database that is available to resources outside of your Lightsail account. A\n value of false specifies a database that is available only to your Lightsail\n resources in the same region as your database.

" - } - }, - "applyImmediately": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

When true, applies changes immediately. When false, applies\n changes during the preferred maintenance window. Some changes may cause an outage.

\n

Default: false\n

" - } - }, - "caCertificateIdentifier": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

Indicates the certificate that needs to be associated with the database.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lightsail#UpdateRelationalDatabaseResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } + "com.amazonaws.lightsail#boolean": { + "type": "boolean" + }, + "com.amazonaws.lightsail#double": { + "type": "double" + }, + "com.amazonaws.lightsail#float": { + "type": "float" + }, + "com.amazonaws.lightsail#integer": { + "type": "integer" + }, + "com.amazonaws.lightsail#long": { + "type": "long" + }, + "com.amazonaws.lightsail#string": { + "type": "string" + }, + "com.amazonaws.lightsail#timestamp": { + "type": "timestamp" } - } - }, - "com.amazonaws.lightsail#boolean": { - "type": "boolean" - }, - "com.amazonaws.lightsail#double": { - "type": "double" - }, - "com.amazonaws.lightsail#float": { - "type": "float" - }, - "com.amazonaws.lightsail#integer": { - "type": "integer" - }, - "com.amazonaws.lightsail#long": { - "type": "long" - }, - "com.amazonaws.lightsail#string": { - "type": "string" - }, - "com.amazonaws.lightsail#timestamp": { - "type": "timestamp" } - } } diff --git a/codegen/sdk-codegen/aws-models/s3.json b/codegen/sdk-codegen/aws-models/s3.json index a08417723f52..40f72b9eb142 100644 --- a/codegen/sdk-codegen/aws-models/s3.json +++ b/codegen/sdk-codegen/aws-models/s3.json @@ -33016,6 +33016,12 @@ "traits": { "smithy.api#enumValue": "aws:kms" } + }, + "aws_kms_dsse": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "aws:kms:dsse" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/securityhub.json b/codegen/sdk-codegen/aws-models/securityhub.json index 885b6f554018..bc075c772e40 100644 --- a/codegen/sdk-codegen/aws-models/securityhub.json +++ b/codegen/sdk-codegen/aws-models/securityhub.json @@ -1,30370 +1,31394 @@ { - "smithy": "2.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] - }, - "shapes": { - "com.amazonaws.securityhub#AcceptAdministratorInvitation": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#AcceptAdministratorInvitationRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#AcceptAdministratorInvitationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - }, - { - "target": "com.amazonaws.securityhub#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Accepts the invitation to be a member account and be monitored by the Security Hub administrator\n account that the invitation was sent from.

\n

This operation is only used by member accounts that are not added through\n Organizations.

\n

When the member account accepts the invitation, permission is granted to the administrator\n account to view findings generated in the member account.

", - "smithy.api#http": { - "method": "POST", - "uri": "/administrator", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#AcceptAdministratorInvitationRequest": { - "type": "structure", - "members": { - "AdministratorId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The account ID of the Security Hub administrator account that sent the invitation.

", - "smithy.api#required": {} - } - }, - "InvitationId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the invitation sent from the Security Hub administrator account.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#AcceptAdministratorInvitationResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#AcceptInvitation": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#AcceptInvitationRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#AcceptInvitationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - }, - { - "target": "com.amazonaws.securityhub#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This API has been deprecated, use AcceptAdministratorInvitation API instead." - }, - "smithy.api#documentation": "

This method is deprecated. Instead, use AcceptAdministratorInvitation.

\n

The Security Hub console continues to use AcceptInvitation. It will eventually change to use AcceptAdministratorInvitation. Any IAM policies that specifically control access to this function must continue to use AcceptInvitation. You should also add AcceptAdministratorInvitation to your policies to ensure that the correct permissions are in place after the console begins to use AcceptAdministratorInvitation.

\n

Accepts the invitation to be a member account and be monitored by the Security Hub administrator\n account that the invitation was sent from.

\n

This operation is only used by member accounts that are not added through\n Organizations.

\n

When the member account accepts the invitation, permission is granted to the administrator\n account to view findings generated in the member account.

", - "smithy.api#http": { - "method": "POST", - "uri": "/master", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#AcceptInvitationRequest": { - "type": "structure", - "members": { - "MasterId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The account ID of the Security Hub administrator account that sent the invitation.

", - "smithy.api#required": {} - } - }, - "InvitationId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the invitation sent from the Security Hub administrator account.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#AcceptInvitationResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#AccessDeniedException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.securityhub#NonEmptyString" - }, - "Code": { - "target": "com.amazonaws.securityhub#NonEmptyString" - } - }, - "traits": { - "smithy.api#documentation": "

You don't have permission to perform the action specified in the request.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.securityhub#AccountDetails": { - "type": "structure", - "members": { - "AccountId": { - "target": "com.amazonaws.securityhub#AccountId", - "traits": { - "smithy.api#documentation": "

The ID of an Amazon Web Services account.

", - "smithy.api#required": {} - } - }, - "Email": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The email of an Amazon Web Services account.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The details of an Amazon Web Services account.

" - } - }, - "com.amazonaws.securityhub#AccountDetailsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AccountDetails" - } - }, - "com.amazonaws.securityhub#AccountId": { - "type": "string" - }, - "com.amazonaws.securityhub#AccountIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#NonEmptyString" - } - }, - "com.amazonaws.securityhub#Action": { - "type": "structure", - "members": { - "ActionType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of action that was detected. The possible action types are:

\n " - } - }, - "NetworkConnectionAction": { - "target": "com.amazonaws.securityhub#NetworkConnectionAction", - "traits": { - "smithy.api#documentation": "

Included if ActionType is NETWORK_CONNECTION. Provides details\n about the network connection that was detected.

" - } - }, - "AwsApiCallAction": { - "target": "com.amazonaws.securityhub#AwsApiCallAction", - "traits": { - "smithy.api#documentation": "

Included if ActionType is AWS_API_CALL. Provides details about\n the API call that was detected.

" - } - }, - "DnsRequestAction": { - "target": "com.amazonaws.securityhub#DnsRequestAction", - "traits": { - "smithy.api#documentation": "

Included if ActionType is DNS_REQUEST. Provides details about\n the DNS request that was detected.

" - } - }, - "PortProbeAction": { - "target": "com.amazonaws.securityhub#PortProbeAction", - "traits": { - "smithy.api#documentation": "

Included if ActionType is PORT_PROBE. Provides details about\n the port probe that was detected.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides details about one of the following actions that affects or that was taken on a resource:

\n " - } - }, - "com.amazonaws.securityhub#ActionLocalIpDetails": { - "type": "structure", - "members": { - "IpAddressV4": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The IP address.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about the IP address where the scanned port is located.

" - } - }, - "com.amazonaws.securityhub#ActionLocalPortDetails": { - "type": "structure", - "members": { - "Port": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of the port.

" - } - }, - "PortName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The port name of the local connection.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

For NetworkConnectionAction and PortProbeDetails,\n LocalPortDetails provides information about the local port that was\n involved in the action.

" - } - }, - "com.amazonaws.securityhub#ActionRemoteIpDetails": { - "type": "structure", - "members": { - "IpAddressV4": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The IP address.

" - } - }, - "Organization": { - "target": "com.amazonaws.securityhub#IpOrganizationDetails", - "traits": { - "smithy.api#documentation": "

The internet service provider (ISP) organization associated with the remote IP\n address.

" - } - }, - "Country": { - "target": "com.amazonaws.securityhub#Country", - "traits": { - "smithy.api#documentation": "

The country where the remote IP address is located.

" - } - }, - "City": { - "target": "com.amazonaws.securityhub#City", - "traits": { - "smithy.api#documentation": "

The city where the remote IP address is located.

" - } - }, - "GeoLocation": { - "target": "com.amazonaws.securityhub#GeoLocation", - "traits": { - "smithy.api#documentation": "

The coordinates of the location of the remote IP address.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

For AwsApiAction, NetworkConnectionAction, and\n PortProbeAction, RemoteIpDetails provides information about\n the remote IP address that was involved in the action.

" - } - }, - "com.amazonaws.securityhub#ActionRemotePortDetails": { - "type": "structure", - "members": { - "Port": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of the port.

" - } - }, - "PortName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The port name of the remote connection.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about the remote port that was involved in an attempted network\n connection.

" - } - }, - "com.amazonaws.securityhub#ActionTarget": { - "type": "structure", - "members": { - "ActionTargetArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN for the target action.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the action target.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The description of the target action.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An ActionTarget object.

" - } - }, - "com.amazonaws.securityhub#ActionTargetList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#ActionTarget" - } - }, - "com.amazonaws.securityhub#Adjustment": { - "type": "structure", - "members": { - "Metric": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The metric to adjust.

" - } - }, - "Reason": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The reason for the adjustment.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An adjustment to the CVSS metric.

" - } - }, - "com.amazonaws.securityhub#AdjustmentList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#Adjustment" - } - }, - "com.amazonaws.securityhub#AdminAccount": { - "type": "structure", - "members": { - "AccountId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account identifier of the Security Hub administrator account.

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#AdminStatus", - "traits": { - "smithy.api#documentation": "

The current status of the Security Hub administrator account. Indicates whether the account is\n currently enabled as a Security Hub administrator.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents a Security Hub administrator account designated by an organization management\n account.

" - } - }, - "com.amazonaws.securityhub#AdminAccounts": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AdminAccount" - } - }, - "com.amazonaws.securityhub#AdminStatus": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DISABLE_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLE_IN_PROGRESS" - } - } - } - }, - "com.amazonaws.securityhub#AdminsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.securityhub#ArnList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#NonEmptyString" - } - }, - "com.amazonaws.securityhub#AssociatedStandard": { - "type": "structure", - "members": { - "StandardsId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The unique identifier of a standard in which a control is enabled. This field consists of the resource portion of the \n Amazon Resource Name (ARN) returned for a standard in the DescribeStandards API response.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Information about an enabled security standard in which a security control is enabled.\n

" - } - }, - "com.amazonaws.securityhub#AssociatedStandardsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AssociatedStandard" - } - }, - "com.amazonaws.securityhub#AssociationSetDetails": { - "type": "structure", - "members": { - "AssociationState": { - "target": "com.amazonaws.securityhub#AssociationStateDetails", - "traits": { - "smithy.api#documentation": "

\n The state of the association between a route table and a subnet or gateway.\n

" - } - }, - "GatewayId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The ID of the internet gateway or virtual private gateway.\n

" - } - }, - "Main": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

\n Indicates whether this is the main route table.\n

" - } - }, - "RouteTableAssociationId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The ID of the association.\n

" - } - }, - "RouteTableId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The ID of the route table.\n

" - } - }, - "SubnetId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The ID of the subnet. A subnet ID is not returned for an implicit association.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n The associations between a route table and one or more subnets or a gateway.\n

" - } - }, - "com.amazonaws.securityhub#AssociationSetList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AssociationSetDetails" - } - }, - "com.amazonaws.securityhub#AssociationStateDetails": { - "type": "structure", - "members": { - "State": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The state of the association.\n

" - } - }, - "StatusMessage": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The status message, if applicable.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Describes the state of an association between a route table and a subnet or gateway.\n

" - } - }, - "com.amazonaws.securityhub#AssociationStatus": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.securityhub#AutoEnableStandards": { - "type": "enum", - "members": { - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - }, - "DEFAULT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DEFAULT" - } - } - } - }, - "com.amazonaws.securityhub#AvailabilityZone": { - "type": "structure", - "members": { - "ZoneName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the Availability Zone.

" - } - }, - "SubnetId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the subnet. You can specify one subnet per Availability Zone.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about an Availability Zone.

" - } - }, - "com.amazonaws.securityhub#AvailabilityZones": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AvailabilityZone" - } - }, - "com.amazonaws.securityhub#AwsAmazonMqBrokerDetails": { - "type": "structure", - "members": { - "AuthenticationStrategy": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The authentication strategy used to secure the broker. The default is SIMPLE.\n

" - } - }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

\n Whether automatically upgrade new minor versions for brokers, as new versions are released and supported by Amazon MQ. \n Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.\n

" - } - }, - "BrokerArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the broker.\n

" - } - }, - "BrokerName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The broker's name.\n

" - } - }, - "DeploymentMode": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The broker's deployment mode. \n

" - } - }, - "EncryptionOptions": { - "target": "com.amazonaws.securityhub#AwsAmazonMqBrokerEncryptionOptionsDetails", - "traits": { - "smithy.api#documentation": "

\n Encryption options for the broker. Doesn’t apply to RabbitMQ brokers.\n

" - } - }, - "EngineType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The type of broker engine.\n

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The version of the broker engine.\n

" - } - }, - "HostInstanceType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The broker's instance type.\n

" - } - }, - "BrokerId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The unique ID that Amazon MQ generates for the broker.\n

" - } - }, - "LdapServerMetadata": { - "target": "com.amazonaws.securityhub#AwsAmazonMqBrokerLdapServerMetadataDetails", - "traits": { - "smithy.api#documentation": "

\n The metadata of the Lightweight Directory Access Protocol (LDAP) server used to authenticate and authorize connections to the broker. This is an optional failover server.\n

" - } - }, - "Logs": { - "target": "com.amazonaws.securityhub#AwsAmazonMqBrokerLogsDetails", - "traits": { - "smithy.api#documentation": "

\n Turns on Amazon CloudWatch logging for brokers.\n

" - } - }, - "MaintenanceWindowStartTime": { - "target": "com.amazonaws.securityhub#AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails", - "traits": { - "smithy.api#documentation": "

\n The scheduled time period (UTC) during which Amazon MQ begins to apply pending updates or patches to the broker.\n

" - } - }, - "PubliclyAccessible": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

\n Permits connections from applications outside of the VPC that hosts the broker's subnets.\n

" - } - }, - "SecurityGroups": { - "target": "com.amazonaws.securityhub#StringList", - "traits": { - "smithy.api#documentation": "

\n The list of rules (one minimum, 125 maximum) that authorize connections to brokers.\n

" - } - }, - "StorageType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The broker's storage type.\n

" - } - }, - "SubnetIds": { - "target": "com.amazonaws.securityhub#StringList", - "traits": { - "smithy.api#documentation": "

\n The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.\n

" - } - }, - "Users": { - "target": "com.amazonaws.securityhub#AwsAmazonMqBrokerUsersList", - "traits": { - "smithy.api#documentation": "

\n The list of all broker usernames for the specified broker. Doesn't apply to RabbitMQ brokers.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Provides details about an Amazon MQ message broker. A message broker allows software applications and \n components to communicate using various programming languages, operating systems, and formal messaging protocols.\n

" - } - }, - "com.amazonaws.securityhub#AwsAmazonMqBrokerEncryptionOptionsDetails": { - "type": "structure", - "members": { - "KmsKeyId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The KMS key that’s used to encrypt your data at rest. If not provided, Amazon MQ will use a \n default KMS key to encrypt your data.\n

" - } - }, - "UseAwsOwnedKey": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

\n Specifies that an KMS key should be used for at-rest encryption. Set to true by default \n if no value is provided (for example, for RabbitMQ brokers).\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Provides details about broker encryption options.\n

" - } - }, - "com.amazonaws.securityhub#AwsAmazonMqBrokerLdapServerMetadataDetails": { - "type": "structure", - "members": { - "Hosts": { - "target": "com.amazonaws.securityhub#StringList", - "traits": { - "smithy.api#documentation": "

\n Specifies the location of the LDAP server, such as Amazon Web Services Directory Service for Microsoft Active Directory. \n

" - } - }, - "RoleBase": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The distinguished name of the node in the directory information tree (DIT) to search for roles or groups.\n

" - } - }, - "RoleName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The group name attribute in a role entry whose value is the name of that role.\n

" - } - }, - "RoleSearchMatching": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The LDAP search filter used to find roles within the roleBase.\n

" - } - }, - "RoleSearchSubtree": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

\n The directory search scope for the role. If set to true, the scope is to search the entire subtree.\n

" - } - }, - "ServiceAccountUsername": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n A username for the service account, which is an account in your LDAP server that has access to initiate a connection.\n

" - } - }, - "UserBase": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n Selects a particular subtree of the directory information tree (DIT) to search for user entries.\n

" - } - }, - "UserRoleName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The name of the LDAP attribute in the user's directory entry for the user's group membership.

" - } - }, - "UserSearchMatching": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The LDAP search filter used to find users within the userBase. \n

" - } - }, - "UserSearchSubtree": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

\n The directory search scope for the user. If set to true, the scope is to search the entire subtree.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n The metadata of the Lightweight Directory Access Protocol (LDAP) server used to authenticate and authorize \n connections to the broker. This is an optional failover server.\n

" - } - }, - "com.amazonaws.securityhub#AwsAmazonMqBrokerLogsDetails": { - "type": "structure", - "members": { - "Audit": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

\n Activates audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Doesn't apply to RabbitMQ brokers.\n

" - } - }, - "General": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

\n Activates general logging.\n

" - } - }, - "AuditLogGroup": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The location of the CloudWatch Logs log group where audit logs are sent.\n

" - } - }, - "GeneralLogGroup": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The location of the CloudWatch Logs log group where general logs are sent.\n

" - } - }, - "Pending": { - "target": "com.amazonaws.securityhub#AwsAmazonMqBrokerLogsPendingDetails", - "traits": { - "smithy.api#documentation": "

\n The list of information about logs that are to be turned on for the specified broker.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Provides information about logs to be activated for the specified broker.\n

" - } - }, - "com.amazonaws.securityhub#AwsAmazonMqBrokerLogsPendingDetails": { - "type": "structure", - "members": { - "Audit": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

\n Activates audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Doesn't apply \n to RabbitMQ brokers.\n

" - } - }, - "General": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

\n Activates general logging.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Provides information about logs to be activated for the specified broker.\n

" - } - }, - "com.amazonaws.securityhub#AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails": { - "type": "structure", - "members": { - "DayOfWeek": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The day of the week on which the maintenance window falls.\n

" - } - }, - "TimeOfDay": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The time, in 24-hour format, on which the maintenance window falls.\n

" - } - }, - "TimeZone": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The time zone in either the Country/City format or the UTC offset format. UTC is the default format.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n The scheduled time period (UTC) during which Amazon MQ begins to apply pending updates or patches to the broker.\n

" - } - }, - "com.amazonaws.securityhub#AwsAmazonMqBrokerUsersDetails": { - "type": "structure", - "members": { - "PendingChange": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The type of change pending for the broker user.\n

" - } - }, - "Username": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The username of the broker user. \n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Provides details about the broker usernames for the specified broker. Doesn't apply to RabbitMQ brokers.\n

" - } - }, - "com.amazonaws.securityhub#AwsAmazonMqBrokerUsersList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsAmazonMqBrokerUsersDetails" - } - }, - "com.amazonaws.securityhub#AwsApiCallAction": { - "type": "structure", - "members": { - "Api": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the API method that was issued.

" - } - }, - "ServiceName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the Amazon Web Services service that the API method belongs to.

" - } - }, - "CallerType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates whether the API call originated from a remote IP address\n (remoteip) or from a DNS domain (domain).

" - } - }, - "RemoteIpDetails": { - "target": "com.amazonaws.securityhub#ActionRemoteIpDetails", - "traits": { - "smithy.api#documentation": "

Provided if CallerType is remoteIp. Provides information about\n the remote IP address that the API call originated from.

" - } - }, - "DomainDetails": { - "target": "com.amazonaws.securityhub#AwsApiCallActionDomainDetails", - "traits": { - "smithy.api#documentation": "

Provided if CallerType is domain. Provides information about\n the DNS domain that the API call originated from.

" - } - }, - "AffectedResources": { - "target": "com.amazonaws.securityhub#FieldMap", - "traits": { - "smithy.api#documentation": "

Identifies the resources that were affected by the API call.

" - } - }, - "FirstSeen": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

An ISO8601-formatted timestamp that indicates when the API call was first\n observed.

\n

A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.

" - } - }, - "LastSeen": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

An ISO8601-formatted timestamp that indicates when the API call was most recently\n observed.

\n

A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provided if ActionType is AWS_API_CALL. It provides details\n about the API call that was detected.

" - } - }, - "com.amazonaws.securityhub#AwsApiCallActionDomainDetails": { - "type": "structure", - "members": { - "Domain": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the DNS domain that issued the API call.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provided if CallerType is domain. It provides information\n about the DNS domain that issued the API call.

" - } - }, - "com.amazonaws.securityhub#AwsApiGatewayAccessLogSettings": { - "type": "structure", - "members": { - "Format": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A single-line format of the access logs of data, as specified by selected\n $context variables. The format must include at least\n $context.requestId.

" - } - }, - "DestinationArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the CloudWatch Logs log group that receives the access logs.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about settings for logging access for the stage.

" - } - }, - "com.amazonaws.securityhub#AwsApiGatewayCanarySettings": { - "type": "structure", - "members": { - "PercentTraffic": { - "target": "com.amazonaws.securityhub#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The percentage of traffic that is diverted to a canary deployment.

" - } - }, - "DeploymentId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The deployment identifier for the canary deployment.

" - } - }, - "StageVariableOverrides": { - "target": "com.amazonaws.securityhub#FieldMap", - "traits": { - "smithy.api#documentation": "

Stage variables that are overridden in the canary release deployment. The variables\n include new stage variables that are introduced in the canary.

\n

Each variable is represented as a string-to-string map between the stage variable name\n and the variable value.

" - } - }, - "UseStageCache": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the canary deployment uses the stage cache.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about settings for canary deployment in the stage.

" - } - }, - "com.amazonaws.securityhub#AwsApiGatewayEndpointConfiguration": { - "type": "structure", - "members": { - "Types": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

A list of endpoint types for the REST API.

\n

For an edge-optimized API, the endpoint type is EDGE. For a Regional API,\n the endpoint type is REGIONAL. For a private API, the endpoint type is\n PRIVATE.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about the endpoints for the API.

" - } - }, - "com.amazonaws.securityhub#AwsApiGatewayMethodSettings": { - "type": "structure", - "members": { - "MetricsEnabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether CloudWatch metrics are enabled for the method.

" - } - }, - "LoggingLevel": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The logging level for this method. The logging level affects the log entries that are\n pushed to CloudWatch Logs.

\n

If the logging level is ERROR, then the logs only include error-level\n entries.

\n

If the logging level is INFO, then the logs include both ERROR\n events and extra informational events.

\n

Valid values: OFF | ERROR | INFO\n

" - } - }, - "DataTraceEnabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether data trace logging is enabled for the method. Data trace logging\n affects the log entries that are pushed to CloudWatch Logs.

" - } - }, - "ThrottlingBurstLimit": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The throttling burst limit for the method.

" - } - }, - "ThrottlingRateLimit": { - "target": "com.amazonaws.securityhub#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The throttling rate limit for the method.

" - } - }, - "CachingEnabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether responses are cached and returned for requests. For responses to be\n cached, a cache cluster must be enabled on the stage.

" - } - }, - "CacheTtlInSeconds": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL,\n the longer the response is cached.

" - } - }, - "CacheDataEncrypted": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the cached responses are encrypted.

" - } - }, - "RequireAuthorizationForCacheControl": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether authorization is required for a cache invalidation request.

" - } - }, - "UnauthorizedCacheControlHeaderStrategy": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates how to handle unauthorized requests for cache invalidation.

\n

Valid values: FAIL_WITH_403 | SUCCEED_WITH_RESPONSE_HEADER |\n SUCCEED_WITHOUT_RESPONSE_HEADER\n

" - } - }, - "HttpMethod": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to\n multiple methods.

" - } - }, - "ResourcePath": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The resource path for this method. Forward slashes (/) are encoded as ~1 . The initial\n slash must include a forward slash.

\n

For example, the path value /resource/subresource must be encoded as\n /~1resource~1subresource.

\n

To specify the root path, use only a slash (/). You can use an asterisk (*) as a\n wildcard to apply method settings to multiple methods.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Defines settings for a method for the stage.

" - } - }, - "com.amazonaws.securityhub#AwsApiGatewayMethodSettingsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsApiGatewayMethodSettings" - } - }, - "com.amazonaws.securityhub#AwsApiGatewayRestApiDetails": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the REST API.

" - } - }, - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the REST API.

" - } - }, - "Description": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A description of the REST API.

" - } - }, - "CreatedDate": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the API was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "Version": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The version identifier for the REST API.

" - } - }, - "BinaryMediaTypes": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The list of binary media types supported by the REST API.

" - } - }, - "MinimumCompressionSize": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum size in bytes of a payload before compression is enabled.

\n

If null, then compression is disabled.

\n

If 0, then all payloads are compressed.

" - } - }, - "ApiKeySource": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The source of the API key for metering requests according to a usage plan.

\n

\n HEADER indicates whether to read the API key from the X-API-Key header of a\n request.

\n

\n AUTHORIZER indicates whether to read the API key from the\n UsageIdentifierKey from a custom authorizer.

" - } - }, - "EndpointConfiguration": { - "target": "com.amazonaws.securityhub#AwsApiGatewayEndpointConfiguration", - "traits": { - "smithy.api#documentation": "

The endpoint configuration of the REST API.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about a REST API in version 1 of Amazon API Gateway.

" - } - }, - "com.amazonaws.securityhub#AwsApiGatewayStageDetails": { - "type": "structure", - "members": { - "DeploymentId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the deployment that the stage points to.

" - } - }, - "ClientCertificateId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the client certificate for the stage.

" - } - }, - "StageName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the stage.

" - } - }, - "Description": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A description of the stage.

" - } - }, - "CacheClusterEnabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether a cache cluster is enabled for the stage.

" - } - }, - "CacheClusterSize": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

If a cache cluster is enabled, the size of the cache cluster.

" - } - }, - "CacheClusterStatus": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

If a cache cluster is enabled, the status of the cache cluster.

" - } - }, - "MethodSettings": { - "target": "com.amazonaws.securityhub#AwsApiGatewayMethodSettingsList", - "traits": { - "smithy.api#documentation": "

Defines the method settings for the stage.

" - } - }, - "Variables": { - "target": "com.amazonaws.securityhub#FieldMap", - "traits": { - "smithy.api#documentation": "

A map that defines the stage variables for the stage.

\n

Variable names can have alphanumeric and underscore characters.

\n

Variable values can contain the following characters:

\n " - } - }, - "DocumentationVersion": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The version of the API documentation that is associated with the stage.

" - } - }, - "AccessLogSettings": { - "target": "com.amazonaws.securityhub#AwsApiGatewayAccessLogSettings", - "traits": { - "smithy.api#documentation": "

Settings for logging access for the stage.

" - } - }, - "CanarySettings": { - "target": "com.amazonaws.securityhub#AwsApiGatewayCanarySettings", - "traits": { - "smithy.api#documentation": "

Information about settings for canary deployment in the stage.

" - } - }, - "TracingEnabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether active tracing with X-Ray is enabled for the stage.

" - } - }, - "CreatedDate": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the stage was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "LastUpdatedDate": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the stage was most recently updated.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "WebAclArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the web ACL associated with the stage.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about a version 1 Amazon API Gateway stage.

" - } - }, - "com.amazonaws.securityhub#AwsApiGatewayV2ApiDetails": { - "type": "structure", - "members": { - "ApiEndpoint": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The URI of the API.

\n

Uses the format\n \n .execute-api..amazonaws.com\n

\n

The stage name is typically appended to the URI to form a complete path to a deployed\n API stage.

" - } - }, - "ApiId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the API.

" - } - }, - "ApiKeySelectionExpression": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

An API key selection expression. Supported only for WebSocket APIs.

" - } - }, - "CreatedDate": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the API was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "Description": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A description of the API.

" - } - }, - "Version": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The version identifier for the API.

" - } - }, - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the API.

" - } - }, - "ProtocolType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The API protocol for the API.

\n

Valid values: WEBSOCKET | HTTP\n

" - } - }, - "RouteSelectionExpression": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The route selection expression for the API.

\n

For HTTP APIs, must be ${request.method} ${request.path}. This is the\n default value for HTTP APIs.

\n

For WebSocket APIs, there is no default value.

" - } - }, - "CorsConfiguration": { - "target": "com.amazonaws.securityhub#AwsCorsConfiguration", - "traits": { - "smithy.api#documentation": "

A cross-origin resource sharing (CORS) configuration. Supported only for HTTP\n APIs.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about a version 2 API in Amazon API Gateway.

" - } - }, - "com.amazonaws.securityhub#AwsApiGatewayV2RouteSettings": { - "type": "structure", - "members": { - "DetailedMetricsEnabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether detailed metrics are enabled.

" - } - }, - "LoggingLevel": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The logging level. The logging level affects the log entries that are pushed to\n CloudWatch Logs. Supported only for WebSocket APIs.

\n

If the logging level is ERROR, then the logs only include error-level\n entries.

\n

If the logging level is INFO, then the logs include both ERROR\n events and extra informational events.

\n

Valid values: OFF | ERROR | INFO\n

" - } - }, - "DataTraceEnabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether data trace logging is enabled. Data trace logging affects the log\n entries that are pushed to CloudWatch Logs. Supported only for WebSocket APIs.

" - } - }, - "ThrottlingBurstLimit": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The throttling burst limit.

" - } - }, - "ThrottlingRateLimit": { - "target": "com.amazonaws.securityhub#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The throttling rate limit.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains route settings for a stage.

" - } - }, - "com.amazonaws.securityhub#AwsApiGatewayV2StageDetails": { - "type": "structure", - "members": { - "ClientCertificateId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of a client certificate for a stage. Supported only for WebSocket API calls.

" - } - }, - "CreatedDate": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the stage was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "Description": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The description of the stage.

" - } - }, - "DefaultRouteSettings": { - "target": "com.amazonaws.securityhub#AwsApiGatewayV2RouteSettings", - "traits": { - "smithy.api#documentation": "

Default route settings for the stage.

" - } - }, - "DeploymentId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the deployment that the stage is associated with.

" - } - }, - "LastUpdatedDate": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the stage was most recently updated.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "RouteSettings": { - "target": "com.amazonaws.securityhub#AwsApiGatewayV2RouteSettings", - "traits": { - "smithy.api#documentation": "

The route settings for the stage.

" - } - }, - "StageName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the stage.

" - } - }, - "StageVariables": { - "target": "com.amazonaws.securityhub#FieldMap", - "traits": { - "smithy.api#documentation": "

A map that defines the stage variables for the stage.

\n

Variable names can have alphanumeric and underscore characters.

\n

Variable values can contain the following characters:

\n " - } - }, - "AccessLogSettings": { - "target": "com.amazonaws.securityhub#AwsApiGatewayAccessLogSettings", - "traits": { - "smithy.api#documentation": "

Information about settings for logging access for the stage.

" - } - }, - "AutoDeploy": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether updates to an API automatically trigger a new deployment.

" - } - }, - "LastDeploymentStatusMessage": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The status of the last deployment of a stage. Supported only if the stage has automatic\n deployment enabled.

" - } - }, - "ApiGatewayManaged": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the stage is managed by API Gateway.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about a version 2 stage for Amazon API Gateway.

" - } - }, - "com.amazonaws.securityhub#AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails": { - "type": "structure", - "members": { - "AuthenticationType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The type of security configuration for your GraphQL API: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.\n

" - } - }, - "LambdaAuthorizerConfig": { - "target": "com.amazonaws.securityhub#AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails", - "traits": { - "smithy.api#documentation": "

\n The configuration for Lambda function authorization.\n

" - } - }, - "OpenIdConnectConfig": { - "target": "com.amazonaws.securityhub#AwsAppSyncGraphQlApiOpenIdConnectConfigDetails", - "traits": { - "smithy.api#documentation": "

\n The OpenID Connect configuration.\n

" - } - }, - "UserPoolConfig": { - "target": "com.amazonaws.securityhub#AwsAppSyncGraphQlApiUserPoolConfigDetails", - "traits": { - "smithy.api#documentation": "

\n The Amazon Cognito user pools configuration.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n A list of additional authentication providers for the GraphqlApi API.\n

" - } - }, - "com.amazonaws.securityhub#AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails" - } - }, - "com.amazonaws.securityhub#AwsAppSyncGraphQlApiDetails": { - "type": "structure", - "members": { - "ApiId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The unique identifier for the API.\n

" - } - }, - "Id": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The unique identifier for the API.

" - } - }, - "OpenIdConnectConfig": { - "target": "com.amazonaws.securityhub#AwsAppSyncGraphQlApiOpenIdConnectConfigDetails", - "traits": { - "smithy.api#documentation": "

\nSpecifies the authorization configuration for using an OpenID Connect compliant service with an AppSync GraphQL API endpoint. \n

" - } - }, - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\nThe API name.\n

" - } - }, - "LambdaAuthorizerConfig": { - "target": "com.amazonaws.securityhub#AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails", - "traits": { - "smithy.api#documentation": "

\nSpecifies the configuration for Lambda function authorization.\n

" - } - }, - "XrayEnabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

\nIndicates whether to use X-Ray tracing for the GraphQL API.\n

" - } - }, - "Arn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\nThe Amazon Resource Name (ARN) of the API.\n

" - } - }, - "UserPoolConfig": { - "target": "com.amazonaws.securityhub#AwsAppSyncGraphQlApiUserPoolConfigDetails", - "traits": { - "smithy.api#documentation": "

\nThe Amazon Cognito user pools configuration.\n

" - } - }, - "AuthenticationType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\nThe type of security configuration for your GraphQL API: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.\n

" - } - }, - "LogConfig": { - "target": "com.amazonaws.securityhub#AwsAppSyncGraphQlApiLogConfigDetails", - "traits": { - "smithy.api#documentation": "

\n The Amazon CloudWatch Logs configuration.\n

" - } - }, - "AdditionalAuthenticationProviders": { - "target": "com.amazonaws.securityhub#AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersList", - "traits": { - "smithy.api#documentation": "

\n A list of additional authentication providers for the GraphQL API.\n

" - } - }, - "WafWebAclArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with this \n GraphQL API, if one exists.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Provides details about an AppSync Graph QL API, which lets you query multiple databases, microservices, and APIs from a single GraphQL endpoint.\n

" - } - }, - "com.amazonaws.securityhub#AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails": { - "type": "structure", - "members": { - "AuthorizerResultTtlInSeconds": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The number of seconds a response should be cached for. The default is 5 minutes (300 seconds).\n

" - } - }, - "AuthorizerUri": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can be a \n standard Lambda ARN, a version ARN (.../v3), or an alias ARN.\n

" - } - }, - "IdentityValidationExpression": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n A regular expression for validation of tokens before the Lambda function is called.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Specifies the authorization configuration for using an Lambda function with your AppSync \n GraphQL API endpoint.\n

" - } - }, - "com.amazonaws.securityhub#AwsAppSyncGraphQlApiLogConfigDetails": { - "type": "structure", - "members": { - "CloudWatchLogsRoleArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the service role that AppSync assumes to publish to CloudWatch Logs \n in your account.\n

" - } - }, - "ExcludeVerboseContent": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

\n Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, \n regardless of logging level.\n

" - } - }, - "FieldLogLevel": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The field logging level.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Specifies the logging configuration when writing GraphQL operations and tracing to Amazon CloudWatch for an \n AppSync GraphQL API.\n

" - } - }, - "com.amazonaws.securityhub#AwsAppSyncGraphQlApiOpenIdConnectConfigDetails": { - "type": "structure", - "members": { - "AuthTtL": { - "target": "com.amazonaws.securityhub#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The number of milliseconds that a token is valid after being authenticated.\n

" - } - }, - "ClientId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The client identifier of the relying party at the OpenID identity provider. This identifier is typically obtained \n when the relying party is registered with the OpenID identity provider. You can specify a regular expression so that \n AppSync can validate against multiple client identifiers at a time.\n

" - } - }, - "IatTtL": { - "target": "com.amazonaws.securityhub#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The number of milliseconds that a token is valid after it's issued to a user.\n

" - } - }, - "Issuer": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of iss \n in the ID token.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Specifies the authorization configuration for using an OpenID Connect compliant service with your AppSync GraphQL \n API endpoint.\n

" - } - }, - "com.amazonaws.securityhub#AwsAppSyncGraphQlApiUserPoolConfigDetails": { - "type": "structure", - "members": { - "AppIdClientRegex": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n A regular expression for validating the incoming Amazon Cognito user pools app client ID. If this value isn't set, no \n filtering is applied.\n

" - } - }, - "AwsRegion": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The Amazon Web Services Region in which the user pool was created.\n

" - } - }, - "DefaultAction": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pools \n authentication doesn't match the Amazon Cognito user pools configuration.\n

" - } - }, - "UserPoolId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The user pool ID.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Specifies the authorization configuration for using Amazon Cognito user pools with your AppSync GraphQL API \n endpoint.\n

" - } - }, - "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupAvailabilityZonesList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupAvailabilityZonesListDetails" - } - }, - "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupAvailabilityZonesListDetails": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the Availability Zone.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An Availability Zone for the automatic scaling group.

" - } - }, - "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupDetails": { - "type": "structure", - "members": { - "LaunchConfigurationName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the launch configuration.

" - } - }, - "LoadBalancerNames": { - "target": "com.amazonaws.securityhub#StringList", - "traits": { - "smithy.api#documentation": "

The list of load balancers associated with the group.

" - } - }, - "HealthCheckType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The service to use for the health checks. Valid values are EC2 or ELB.

" - } - }, - "HealthCheckGracePeriod": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before it checks the\n health status of an EC2 instance that has come into service.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the auto scaling group was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "MixedInstancesPolicy": { - "target": "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyDetails", - "traits": { - "smithy.api#documentation": "

The mixed instances policy for the automatic scaling group.

" - } - }, - "AvailabilityZones": { - "target": "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupAvailabilityZonesList", - "traits": { - "smithy.api#documentation": "

The list of Availability Zones for the automatic scaling group.

" - } - }, - "LaunchTemplate": { - "target": "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupLaunchTemplateLaunchTemplateSpecification", - "traits": { - "smithy.api#documentation": "

The launch template to use.

" - } - }, - "CapacityRebalance": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether capacity rebalancing is enabled.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides details about an auto scaling group.

" - } - }, - "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupLaunchTemplateLaunchTemplateSpecification": { - "type": "structure", - "members": { - "LaunchTemplateId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the launch template. You must specify either LaunchTemplateId or LaunchTemplateName.

" - } - }, - "LaunchTemplateName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the launch template. You must specify either LaunchTemplateId or LaunchTemplateName.

" - } - }, - "Version": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Identifies the version of the launch template. You can specify a version identifier, or use the values $Latest or $Default.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about the launch template to use.

" - } - }, - "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyDetails": { - "type": "structure", - "members": { - "InstancesDistribution": { - "target": "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails", - "traits": { - "smithy.api#documentation": "

The instances distribution. 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.

" - } - }, - "LaunchTemplate": { - "target": "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateDetails", - "traits": { - "smithy.api#documentation": "

The launch template to use and the instance types (overrides) to use to provision EC2 instances to fulfill On-Demand and Spot capacities.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The mixed instances policy for the automatic scaling group.

" - } - }, - "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails": { - "type": "structure", - "members": { - "OnDemandAllocationStrategy": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

How to allocate instance types to fulfill On-Demand capacity. The valid value is prioritized.

" - } - }, - "OnDemandBaseCapacity": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances.

" - } - }, - "OnDemandPercentageAboveBaseCapacity": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The percentage of On-Demand Instances and Spot Instances for additional capacity beyond OnDemandBaseCapacity.

" - } - }, - "SpotAllocationStrategy": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

How to allocate instances across Spot Instance pools. Valid values are as follows:

\n " - } - }, - "SpotInstancePools": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of Spot Instance pools across which to allocate your Spot Instances.

" - } - }, - "SpotMaxPrice": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the instances distribution.

" - } - }, - "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateDetails": { - "type": "structure", - "members": { - "LaunchTemplateSpecification": { - "target": "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification", - "traits": { - "smithy.api#documentation": "

The launch template to use for a mixed instances policy.

" - } - }, - "Overrides": { - "target": "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesList", - "traits": { - "smithy.api#documentation": "

Property values to use to override the values in the launch template.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a launch template and overrides for a mixed instances policy.

" - } - }, - "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification": { - "type": "structure", - "members": { - "LaunchTemplateId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the launch template. You must specify either LaunchTemplateId or LaunchTemplateName.

" - } - }, - "LaunchTemplateName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the launch template. You must specify either LaunchTemplateId or LaunchTemplateName.

" - } - }, - "Version": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Identifies the version of the launch template. You can specify a version identifier, or use the values $Latest or $Default.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about the launch template to use for a mixed instances policy.

" - } - }, - "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesListDetails" - } - }, - "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesListDetails": { - "type": "structure", - "members": { - "InstanceType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The instance type. For example, m3.xlarge.

" - } - }, - "WeightedCapacity": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The number of capacity units provided by the specified instance type in terms of virtual CPUs, memory, storage, throughput, or other relative performance characteristic.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Property values to use to override the values in the launch template.

" - } - }, - "com.amazonaws.securityhub#AwsAutoScalingLaunchConfigurationBlockDeviceMappingsDetails": { - "type": "structure", - "members": { - "DeviceName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The device name that is exposed to the EC2 instance. For example, /dev/sdh or xvdh.

" - } - }, - "Ebs": { - "target": "com.amazonaws.securityhub#AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails", - "traits": { - "smithy.api#documentation": "

Parameters that are used to automatically set up Amazon EBS volumes when an instance is launched.

" - } - }, - "NoDevice": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether to suppress the device that is included in the block device mapping of the Amazon Machine Image (AMI).

\n

If NoDevice is true, then you cannot specify Ebs.>

" - } - }, - "VirtualName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the virtual device (for example, ephemeral0).

\n

You can provide either VirtualName or Ebs, but not both.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A block device for the instance.

" - } - }, - "com.amazonaws.securityhub#AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails": { - "type": "structure", - "members": { - "DeleteOnTermination": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether to delete the volume when the instance is terminated.

" - } - }, - "Encrypted": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether to encrypt the volume.

" - } - }, - "Iops": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of input/output (I/O) operations per second (IOPS) to provision for the volume.

\n

Only supported for gp3 or io1 volumes. Required for io1 volumes. Not used with standard, gp2, st1, or sc1 volumes.

" - } - }, - "SnapshotId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The snapshot ID of the volume to use.

\n

You must specify either VolumeSize or SnapshotId.

" - } - }, - "VolumeSize": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The volume size, in GiBs. The following are the supported volumes sizes for each volume type:

\n \n

You must specify either SnapshotId or VolumeSize. If you specify both SnapshotId and VolumeSize, the volume size must be equal or greater than the size of the snapshot.

" - } - }, - "VolumeType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The volume type. Valid values are as follows:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Parameters that are used to automatically set up EBS volumes when an instance is launched.

" - } - }, - "com.amazonaws.securityhub#AwsAutoScalingLaunchConfigurationBlockDeviceMappingsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsAutoScalingLaunchConfigurationBlockDeviceMappingsDetails" - } - }, - "com.amazonaws.securityhub#AwsAutoScalingLaunchConfigurationDetails": { - "type": "structure", - "members": { - "AssociatePublicIpAddress": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

For Auto Scaling groups that run in a VPC, specifies whether to assign a public IP address to the group's instances.

" - } - }, - "BlockDeviceMappings": { - "target": "com.amazonaws.securityhub#AwsAutoScalingLaunchConfigurationBlockDeviceMappingsList", - "traits": { - "smithy.api#documentation": "

Specifies the block devices for the instance.

" - } - }, - "ClassicLinkVpcId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of a ClassicLink-enabled VPC that EC2-Classic instances are linked to.

" - } - }, - "ClassicLinkVpcSecurityGroups": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The identifiers of one or more security groups for the VPC that is specified in ClassicLinkVPCId.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The creation date and time for the launch configuration.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "EbsOptimized": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the launch configuration is optimized for Amazon EBS I/O.

" - } - }, - "IamInstanceProfile": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name or the ARN of the instance profile associated with the IAM role for the\n instance. The instance profile contains the IAM role.

" - } - }, - "ImageId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Machine Image (AMI) that is used to launch EC2\n instances.

" - } - }, - "InstanceMonitoring": { - "target": "com.amazonaws.securityhub#AwsAutoScalingLaunchConfigurationInstanceMonitoringDetails", - "traits": { - "smithy.api#documentation": "

Indicates the type of monitoring for instances in the group.

" - } - }, - "InstanceType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The instance type for the instances.

" - } - }, - "KernelId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the kernel associated with the AMI.

" - } - }, - "KeyName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the key pair.

" - } - }, - "LaunchConfigurationName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the launch configuration.

" - } - }, - "PlacementTenancy": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The tenancy of the instance. An instance with dedicated tenancy runs on\n isolated, single-tenant hardware and can only be launched into a VPC.

" - } - }, - "RamdiskId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the RAM disk associated with the AMI.

" - } - }, - "SecurityGroups": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The security groups to assign to the instances in the Auto Scaling group.

" - } - }, - "SpotPrice": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The maximum hourly price to be paid for any Spot Instance that is launched to fulfill the\n request.

" - } - }, - "UserData": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The user data to make available to the launched EC2 instances. Must be base64-encoded\n text.

" - } - }, - "MetadataOptions": { - "target": "com.amazonaws.securityhub#AwsAutoScalingLaunchConfigurationMetadataOptions", - "traits": { - "smithy.api#documentation": "

The metadata options for the instances.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about a launch configuration.

" - } - }, - "com.amazonaws.securityhub#AwsAutoScalingLaunchConfigurationInstanceMonitoringDetails": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

If set to true, then instances in the group launch with detailed\n monitoring.

\n

If set to false, then instances in the group launch with basic\n monitoring.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the type of monitoring for instances in the group.

" - } - }, - "com.amazonaws.securityhub#AwsAutoScalingLaunchConfigurationMetadataOptions": { - "type": "structure", - "members": { - "HttpEndpoint": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Enables or disables the HTTP metadata endpoint on your instances. By default, the metadata endpoint is enabled.

" - } - }, - "HttpPutResponseHopLimit": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.

" - } - }, - "HttpTokens": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates whether token usage is required or optional for metadata requests. By default, token usage is optional.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The metadata options for the instances.

" - } - }, - "com.amazonaws.securityhub#AwsBackupBackupPlanAdvancedBackupSettingsDetails": { - "type": "structure", - "members": { - "BackupOptions": { - "target": "com.amazonaws.securityhub#FieldMap", - "traits": { - "smithy.api#documentation": "

Specifies the backup option for a selected resource. This option is only available for Windows \nVolume Shadow Copy Service (VSS) backup jobs. Valid values are as follows:

\n " - } - }, - "ResourceType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of a resource type. The only supported resource type is Amazon EC2 instances with Windows VSS.

\n

The only valid value is EC2.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides a list of backup options for each resource type.\n

" - } - }, - "com.amazonaws.securityhub#AwsBackupBackupPlanAdvancedBackupSettingsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsBackupBackupPlanAdvancedBackupSettingsDetails" - } - }, - "com.amazonaws.securityhub#AwsBackupBackupPlanBackupPlanDetails": { - "type": "structure", - "members": { - "BackupPlanName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The display name of a backup plan.\n

" - } - }, - "AdvancedBackupSettings": { - "target": "com.amazonaws.securityhub#AwsBackupBackupPlanAdvancedBackupSettingsList", - "traits": { - "smithy.api#documentation": "

A list of backup options for each resource type.\n

" - } - }, - "BackupPlanRule": { - "target": "com.amazonaws.securityhub#AwsBackupBackupPlanRuleList", - "traits": { - "smithy.api#documentation": "

An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides details about an Backup backup plan and an array of BackupRule objects, each of which specifies a backup rule.\n

" - } - }, - "com.amazonaws.securityhub#AwsBackupBackupPlanDetails": { - "type": "structure", - "members": { - "BackupPlan": { - "target": "com.amazonaws.securityhub#AwsBackupBackupPlanBackupPlanDetails", - "traits": { - "smithy.api#documentation": "

Uniquely identifies the backup plan to be associated with the selection of resources.\n

" - } - }, - "BackupPlanArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies the backup plan.\n

" - } - }, - "BackupPlanId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A unique ID for the backup plan.\n

" - } - }, - "VersionId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Unique, randomly generated, Unicode, UTF-8 encoded strings. Version IDs cannot be edited.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides details about an Backup backup plan and an array of BackupRule objects, each of which specifies a backup rule.\n

" - } - }, - "com.amazonaws.securityhub#AwsBackupBackupPlanLifecycleDetails": { - "type": "structure", - "members": { - "DeleteAfterDays": { - "target": "com.amazonaws.securityhub#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.\n

" - } - }, - "MoveToColdStorageAfterDays": { - "target": "com.amazonaws.securityhub#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies the number of days after creation that a recovery point is moved to cold storage.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides lifecycle details for the backup plan. A lifecycle defines when a backup is transitioned to cold storage and when it expires.\n

" - } - }, - "com.amazonaws.securityhub#AwsBackupBackupPlanRuleCopyActionsDetails": { - "type": "structure", - "members": { - "DestinationBackupVaultArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for the copied backup.\n

" - } - }, - "Lifecycle": { - "target": "com.amazonaws.securityhub#AwsBackupBackupPlanLifecycleDetails", - "traits": { - "smithy.api#documentation": "

Defines when a protected resource is transitioned to cold storage and when it expires.\n Backup transitions and expires backups automatically according to the\n lifecycle that you define. If you do not specify a lifecycle, Backup applies\n the lifecycle policy of the source backup to the destination backup.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An array of CopyAction objects, each of which contains details of the copy operation.\n

" - } - }, - "com.amazonaws.securityhub#AwsBackupBackupPlanRuleCopyActionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsBackupBackupPlanRuleCopyActionsDetails" - } - }, - "com.amazonaws.securityhub#AwsBackupBackupPlanRuleDetails": { - "type": "structure", - "members": { - "TargetBackupVault": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the Amazon Web Services account used to create them and the Amazon Web Services Region where they are created. They consist of letters, numbers, and hyphens.\n

" - } - }, - "StartWindowMinutes": { - "target": "com.amazonaws.securityhub#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully.\n

" - } - }, - "ScheduleExpression": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A cron expression in UTC specifying when Backup initiates a backup job.\n

" - } - }, - "RuleName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.

" - } - }, - "RuleId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Uniquely identifies a rule that is used to schedule the backup of a selection of resources.\n

" - } - }, - "EnableContinuousBackup": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether Backup creates continuous backups capable of point-in-time restore (PITR).\n

" - } - }, - "CompletionWindowMinutes": { - "target": "com.amazonaws.securityhub#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

A value in minutes after a backup job is successfully started before it must be completed, or it is canceled by Backup.\n

" - } - }, - "CopyActions": { - "target": "com.amazonaws.securityhub#AwsBackupBackupPlanRuleCopyActionsList", - "traits": { - "smithy.api#documentation": "

An array of CopyAction objects, each of which contains details of the\n copy operation.

" - } - }, - "Lifecycle": { - "target": "com.amazonaws.securityhub#AwsBackupBackupPlanLifecycleDetails", - "traits": { - "smithy.api#documentation": "

Defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. If you do not specify a lifecycle, Backup applies the lifecycle policy of the source backup to the destination backup.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides details about an array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.\n

" - } - }, - "com.amazonaws.securityhub#AwsBackupBackupPlanRuleList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsBackupBackupPlanRuleDetails" - } - }, - "com.amazonaws.securityhub#AwsBackupBackupVaultDetails": { - "type": "structure", - "members": { - "BackupVaultArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup vault.\n

" - } - }, - "BackupVaultName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the \nAmazon Web Services account used to create them and the Amazon Web Services Region where they are created. \nThey consist of lowercase letters, numbers, and hyphens.\n

" - } - }, - "EncryptionKeyArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The unique ARN associated with the server-side encryption key. You can specify a key to encrypt your backups from services that support \nfull Backup management. If you do not specify a key, Backup creates an KMS key for you by default.\n

" - } - }, - "Notifications": { - "target": "com.amazonaws.securityhub#AwsBackupBackupVaultNotificationsDetails", - "traits": { - "smithy.api#documentation": "

The Amazon SNS event notifications for the specified backup vault.\n

" - } - }, - "AccessPolicy": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A resource-based policy that is used to manage access permissions on the target backup vault.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides details about an Backup backup vault. In Backup, a backup vault is \na container that stores and organizes your backups.\n

" - } - }, - "com.amazonaws.securityhub#AwsBackupBackupVaultNotificationsDetails": { - "type": "structure", - "members": { - "BackupVaultEvents": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

An array of events that indicate the status of jobs to back up resources to the backup vault. \nThe following events are supported:

\n " - } - }, - "SnsTopicArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the Amazon SNS topic for\n a backup vault's events.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides details about the Amazon SNS event notifications for the specified backup vault.\n

" - } - }, - "com.amazonaws.securityhub#AwsBackupRecoveryPointCalculatedLifecycleDetails": { - "type": "structure", - "members": { - "DeleteAt": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Specifies the number of days after creation that a recovery point is deleted. Must be greater \nthan 90 days plus MoveToColdStorageAfterDays.\n

" - } - }, - "MoveToColdStorageAt": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Specifies the number of days after creation that a recovery point is moved to cold storage.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies how long in days before a recovery point transitions to cold storage or is deleted.\n

" - } - }, - "com.amazonaws.securityhub#AwsBackupRecoveryPointCreatedByDetails": { - "type": "structure", - "members": { - "BackupPlanArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup plan.\n

" - } - }, - "BackupPlanId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Uniquely identifies a backup plan.\n

" - } - }, - "BackupPlanVersion": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most \n1,024 bytes long. Version IDs cannot be edited.\n

" - } - }, - "BackupRuleId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Uniquely identifies a rule used to schedule the backup of a selection of resources.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about the backup plan and rule that Backup used to initiate the recovery point backup.\n

" - } - }, - "com.amazonaws.securityhub#AwsBackupRecoveryPointDetails": { - "type": "structure", - "members": { - "BackupSizeInBytes": { - "target": "com.amazonaws.securityhub#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The size, in bytes, of a backup.\n

" - } - }, - "BackupVaultArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup vault.\n

" - } - }, - "BackupVaultName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified by names \nthat are unique to the Amazon Web Services account used to create them and the Amazon Web Services Region \nwhere they are created. They consist of lowercase letters, numbers, and hyphens.\n

" - } - }, - "CalculatedLifecycle": { - "target": "com.amazonaws.securityhub#AwsBackupRecoveryPointCalculatedLifecycleDetails", - "traits": { - "smithy.api#documentation": "

A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.\n

" - } - }, - "CompletionDate": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The date and time that a job to create a recovery point is completed, in Unix format and UTC. \nThe value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 \nrepresents Friday, January 26, 2018 12:11:30.087 AM.\n

" - } - }, - "CreatedBy": { - "target": "com.amazonaws.securityhub#AwsBackupRecoveryPointCreatedByDetails", - "traits": { - "smithy.api#documentation": "

Contains identifying information about the creation of a recovery point, including the \nBackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId \nof the backup plan that is used to create it.\n

" - } - }, - "CreationDate": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The date and time a recovery point is created, in Unix format and UTC. The value of CreationDate \nis accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.\n

" - } - }, - "EncryptionKeyArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN for the server-side encryption key that is used to protect your backups.\n

" - } - }, - "IamRoleArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Specifies the IAM role ARN used to create the target recovery point\n

" - } - }, - "IsEncrypted": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean value that is returned as TRUE if the specified recovery point is \nencrypted, or FALSE if the recovery point is not encrypted.\n

" - } - }, - "LastRestoreTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The date and time that a recovery point was last restored, in Unix format and UTC. The value of \nLastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087 represents \nFriday, January 26, 2018 12:11:30.087 AM.\n

" - } - }, - "Lifecycle": { - "target": "com.amazonaws.securityhub#AwsBackupRecoveryPointLifecycleDetails", - "traits": { - "smithy.api#documentation": "

The lifecycle defines when a protected resource is transitioned to cold storage and when it \nexpires. Backup transitions and expires backups automatically according to the lifecycle that \nyou define\n

" - } - }, - "RecoveryPointArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

An ARN that uniquely identifies a recovery point.\n

" - } - }, - "ResourceArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.\n

" - } - }, - "ResourceType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of Amazon Web Services resource saved as a recovery point, such as an Amazon EBS volume or an Amazon RDS database.\n

" - } - }, - "SourceBackupVaultArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN for the backup vault where the recovery point was originally copied from. If the recovery \npoint is restored to the same account, this value will be null.\n

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A status code specifying the state of the recovery point. Valid values are as follows:

\n " - } - }, - "StatusMessage": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A message explaining the reason of the recovery point deletion failure.\n

" - } - }, - "StorageClass": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Specifies the storage class of the recovery point. Valid values are as follows:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains detailed information about the recovery points stored in an Backup backup vault. \nA backup, or recovery point, represents the content of a resource at a specified time.\n

" - } - }, - "com.amazonaws.securityhub#AwsBackupRecoveryPointLifecycleDetails": { - "type": "structure", - "members": { - "DeleteAfterDays": { - "target": "com.amazonaws.securityhub#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies the number of days after creation that a recovery point is deleted. Must be greater \nthan 90 days plus MoveToColdStorageAfterDays.\n

" - } - }, - "MoveToColdStorageAfterDays": { - "target": "com.amazonaws.securityhub#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies the number of days after creation that a recovery point is moved to cold storage.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains an array of Transition objects specifying how long in days before a recovery point transitions to cold storage or is deleted.\n

" - } - }, - "com.amazonaws.securityhub#AwsCertificateManagerCertificateDetails": { - "type": "structure", - "members": { - "CertificateAuthorityArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the private certificate authority (CA) that will be used to issue the\n certificate.

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the certificate was requested.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "DomainName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The fully qualified domain name (FQDN), such as www.example.com, that is secured by the\n certificate.

" - } - }, - "DomainValidationOptions": { - "target": "com.amazonaws.securityhub#AwsCertificateManagerCertificateDomainValidationOptions", - "traits": { - "smithy.api#documentation": "

Contains information about the initial validation of each domain name that occurs as a\n result of the RequestCertificate request.

\n

Only provided if the certificate type is AMAZON_ISSUED.

" - } - }, - "ExtendedKeyUsages": { - "target": "com.amazonaws.securityhub#AwsCertificateManagerCertificateExtendedKeyUsages", - "traits": { - "smithy.api#documentation": "

Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies\n a purpose for which the certificate public key can be used and consists of a name and an\n object identifier (OID).

" - } - }, - "FailureReason": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

For a failed certificate request, the reason for the failure.

\n

Valid values: NO_AVAILABLE_CONTACTS |\n ADDITIONAL_VERIFICATION_REQUIRED | DOMAIN_NOT_ALLOWED |\n INVALID_PUBLIC_DOMAIN | DOMAIN_VALIDATION_DENIED |\n CAA_ERROR | PCA_LIMIT_EXCEEDED | PCA_INVALID_ARN\n | PCA_INVALID_STATE | PCA_REQUEST_FAILED |\n PCA_NAME_CONSTRAINTS_VALIDATION | PCA_RESOURCE_NOT_FOUND |\n PCA_INVALID_ARGS | PCA_INVALID_DURATION |\n PCA_ACCESS_DENIED | SLR_NOT_FOUND | OTHER\n

" - } - }, - "ImportedAt": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the certificate was imported. Provided if the certificate type is\n IMPORTED.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "InUseBy": { - "target": "com.amazonaws.securityhub#StringList", - "traits": { - "smithy.api#documentation": "

The list of ARNs for the Amazon Web Services resources that use the certificate.

" - } - }, - "IssuedAt": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the certificate was issued. Provided if the certificate type is\n AMAZON_ISSUED.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "Issuer": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the certificate authority that issued and signed the certificate.

" - } - }, - "KeyAlgorithm": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The algorithm that was used to generate the public-private key pair.

\n

Valid values: RSA_2048 | RSA_1024 | RSA_4096 |\n EC_prime256v1 | EC_secp384r1 |\n EC_secp521r1\n

" - } - }, - "KeyUsages": { - "target": "com.amazonaws.securityhub#AwsCertificateManagerCertificateKeyUsages", - "traits": { - "smithy.api#documentation": "

A list of key usage X.509 v3 extension objects.

" - } - }, - "NotAfter": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The time after which the certificate becomes invalid.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "NotBefore": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The time before which the certificate is not valid.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "Options": { - "target": "com.amazonaws.securityhub#AwsCertificateManagerCertificateOptions", - "traits": { - "smithy.api#documentation": "

Provides a value that specifies whether to add the certificate to a transparency\n log.

" - } - }, - "RenewalEligibility": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Whether the certificate is eligible for renewal.

\n

Valid values: ELIGIBLE | INELIGIBLE\n

" - } - }, - "RenewalSummary": { - "target": "com.amazonaws.securityhub#AwsCertificateManagerCertificateRenewalSummary", - "traits": { - "smithy.api#documentation": "

Information about the status of the Certificate Manager managed renewal for the\n certificate. Provided only when the certificate type is AMAZON_ISSUED.

" - } - }, - "Serial": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The serial number of the certificate.

" - } - }, - "SignatureAlgorithm": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The algorithm that was used to sign the certificate.

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The status of the certificate.

\n

Valid values: PENDING_VALIDATION | ISSUED |\n INACTIVE | EXPIRED | VALIDATION_TIMED_OUT |\n REVOKED | FAILED\n

" - } - }, - "Subject": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the entity that is associated with the public key contained in the\n certificate.

" - } - }, - "SubjectAlternativeNames": { - "target": "com.amazonaws.securityhub#StringList", - "traits": { - "smithy.api#documentation": "

One or more domain names (subject alternative names) included in the certificate. This\n list contains the domain names that are bound to the public key that is contained in the\n certificate.

\n

The subject alternative names include the canonical domain name (CN) of the certificate\n and additional domain names that can be used to connect to the website.

" - } - }, - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The source of the certificate. For certificates that Certificate Manager provides,\n Type is AMAZON_ISSUED. For certificates that are imported with\n ImportCertificate, Type is IMPORTED.

\n

Valid values: IMPORTED | AMAZON_ISSUED |\n PRIVATE\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides details about an Certificate Manager certificate.

" - } - }, - "com.amazonaws.securityhub#AwsCertificateManagerCertificateDomainValidationOption": { - "type": "structure", - "members": { - "DomainName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A fully qualified domain name (FQDN) in the certificate.

" - } - }, - "ResourceRecord": { - "target": "com.amazonaws.securityhub#AwsCertificateManagerCertificateResourceRecord", - "traits": { - "smithy.api#documentation": "

The CNAME record that is added to the DNS database for domain validation.

" - } - }, - "ValidationDomain": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The domain name that Certificate Manager uses to send domain validation\n emails.

" - } - }, - "ValidationEmails": { - "target": "com.amazonaws.securityhub#StringList", - "traits": { - "smithy.api#documentation": "

A list of email addresses that Certificate Manager uses to send domain validation\n emails.

" - } - }, - "ValidationMethod": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The method used to validate the domain name.

" - } - }, - "ValidationStatus": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The validation status of the domain name.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about one of the following:

\n " - } - }, - "com.amazonaws.securityhub#AwsCertificateManagerCertificateDomainValidationOptions": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsCertificateManagerCertificateDomainValidationOption" - } - }, - "com.amazonaws.securityhub#AwsCertificateManagerCertificateExtendedKeyUsage": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of an extension value. Indicates the purpose for which the certificate public\n key can be used.

" - } - }, - "OId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

An object identifier (OID) for the extension value.

\n

The format is numbers separated by periods.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about an extended key usage X.509 v3 extension object.

" - } - }, - "com.amazonaws.securityhub#AwsCertificateManagerCertificateExtendedKeyUsages": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsCertificateManagerCertificateExtendedKeyUsage" - } - }, - "com.amazonaws.securityhub#AwsCertificateManagerCertificateKeyUsage": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The key usage extension name.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about a key usage X.509 v3 extension object.

" - } - }, - "com.amazonaws.securityhub#AwsCertificateManagerCertificateKeyUsages": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsCertificateManagerCertificateKeyUsage" - } - }, - "com.amazonaws.securityhub#AwsCertificateManagerCertificateOptions": { - "type": "structure", - "members": { - "CertificateTransparencyLoggingPreference": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Whether to add the certificate to a transparency log.

\n

Valid values: DISABLED | ENABLED\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains other options for the certificate.

" - } - }, - "com.amazonaws.securityhub#AwsCertificateManagerCertificateRenewalSummary": { - "type": "structure", - "members": { - "DomainValidationOptions": { - "target": "com.amazonaws.securityhub#AwsCertificateManagerCertificateDomainValidationOptions", - "traits": { - "smithy.api#documentation": "

Information about the validation of each domain name in the certificate, as it pertains\n to Certificate Manager managed renewal. Provided only when the certificate type is\n AMAZON_ISSUED.

" - } - }, - "RenewalStatus": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The status of the Certificate Manager managed renewal of the certificate.

\n

Valid values: PENDING_AUTO_RENEWAL | PENDING_VALIDATION |\n SUCCESS | FAILED\n

" - } - }, - "RenewalStatusReason": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The reason that a renewal request was unsuccessful. This attribute is used only when RenewalStatus is FAILED.

\n

Valid values: NO_AVAILABLE_CONTACTS |\n ADDITIONAL_VERIFICATION_REQUIRED | DOMAIN_NOT_ALLOWED |\n INVALID_PUBLIC_DOMAIN | DOMAIN_VALIDATION_DENIED |\n CAA_ERROR | PCA_LIMIT_EXCEEDED | PCA_INVALID_ARN\n | PCA_INVALID_STATE | PCA_REQUEST_FAILED |\n PCA_NAME_CONSTRAINTS_VALIDATION | PCA_RESOURCE_NOT_FOUND |\n PCA_INVALID_ARGS | PCA_INVALID_DURATION |\n PCA_ACCESS_DENIED | SLR_NOT_FOUND | OTHER\n

" - } - }, - "UpdatedAt": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the renewal summary was last updated.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about the Certificate Manager managed renewal for an\n AMAZON_ISSUED certificate.

" - } - }, - "com.amazonaws.securityhub#AwsCertificateManagerCertificateResourceRecord": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the resource.

" - } - }, - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of resource.

" - } - }, - "Value": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The value of the resource.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides details about the CNAME record that is added to the DNS database for domain\n validation.

" - } - }, - "com.amazonaws.securityhub#AwsCloudFormationStackDetails": { - "type": "structure", - "members": { - "Capabilities": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The capabilities allowed in the stack.\n

" - } - }, - "CreationTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The time at which the stack was created.

" - } - }, - "Description": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A user-defined description associated with the stack.\n

" - } - }, - "DisableRollback": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Boolean to enable or disable rollback on stack creation failures. \n

" - } - }, - "DriftInformation": { - "target": "com.amazonaws.securityhub#AwsCloudFormationStackDriftInformationDetails", - "traits": { - "smithy.api#documentation": "

Information about whether a stack's actual configuration differs, or has drifted, from its expected \nconfiguration, as defined in the stack template and any values specified as template parameters. \n

" - } - }, - "EnableTerminationProtection": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether termination protection is enabled for the stack.\n

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The time the nested stack was last updated. This field will only be returned if the stack has been \nupdated at least once.

" - } - }, - "NotificationArns": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the Amazon SNS topic to which stack-related events are published.\n

" - } - }, - "Outputs": { - "target": "com.amazonaws.securityhub#AwsCloudFormationStackOutputsList", - "traits": { - "smithy.api#documentation": "

A list of output structures.\n

" - } - }, - "RoleArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of an IAM role that's associated with the stack. \n

" - } - }, - "StackId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Unique identifier of the stack.\n

" - } - }, - "StackName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name associated with the stack.\n

" - } - }, - "StackStatus": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Current status of the stack.\n

" - } - }, - "StackStatusReason": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Success or failure message associated with the stack status.\n

" - } - }, - "TimeoutInMinutes": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The length of time, in minutes, that CloudFormation waits for the nested stack to reach \nthe CREATE_COMPLETE state.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Nests a stack as a resource in a top-level template. Nested stacks are stacks created as resources for \nanother stack.

" - } - }, - "com.amazonaws.securityhub#AwsCloudFormationStackDriftInformationDetails": { - "type": "structure", - "members": { - "StackDriftStatus": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Status of the stack's actual configuration compared to its expected template configuration.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about the stack's conformity to its expected template configuration.\n

" - } - }, - "com.amazonaws.securityhub#AwsCloudFormationStackOutputsDetails": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A user-defined description associated with the output.\n

" - } - }, - "OutputKey": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The key associated with the output.\n

" - } - }, - "OutputValue": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The value associated with the output.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about the CloudFormation stack output.\n

" - } - }, - "com.amazonaws.securityhub#AwsCloudFormationStackOutputsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsCloudFormationStackOutputsDetails" - } - }, - "com.amazonaws.securityhub#AwsCloudFrontDistributionCacheBehavior": { - "type": "structure", - "members": { - "ViewerProtocolPolicy": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The protocol that viewers can use to access the files in an origin. You can specify the\n following options:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a cache behavior for the distribution.

" - } - }, - "com.amazonaws.securityhub#AwsCloudFrontDistributionCacheBehaviors": { - "type": "structure", - "members": { - "Items": { - "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionCacheBehaviorsItemList", - "traits": { - "smithy.api#documentation": "

The cache behaviors for the distribution.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about caching for the CloudFront distribution.

" - } - }, - "com.amazonaws.securityhub#AwsCloudFrontDistributionCacheBehaviorsItemList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionCacheBehavior" - } - }, - "com.amazonaws.securityhub#AwsCloudFrontDistributionDefaultCacheBehavior": { - "type": "structure", - "members": { - "ViewerProtocolPolicy": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The protocol that viewers can use to access the files in an origin. You can specify the\n following options:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about the default cache configuration for the CloudFront distribution.

" - } - }, - "com.amazonaws.securityhub#AwsCloudFrontDistributionDetails": { - "type": "structure", - "members": { - "CacheBehaviors": { - "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionCacheBehaviors", - "traits": { - "smithy.api#documentation": "

Provides information about the cache configuration for the distribution.

" - } - }, - "DefaultCacheBehavior": { - "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionDefaultCacheBehavior", - "traits": { - "smithy.api#documentation": "

The default cache behavior for the configuration.

" - } - }, - "DefaultRootObject": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The object that CloudFront sends in response to requests from the origin (for example,\n index.html) when a viewer requests the root URL for the distribution\n (http://www.example.com) instead of an object in your distribution\n (http://www.example.com/product-description.html).

" - } - }, - "DomainName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The domain name corresponding to the distribution.

" - } - }, - "ETag": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The entity tag is a hash of the object.

" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when that the distribution was last modified.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "Logging": { - "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionLogging", - "traits": { - "smithy.api#documentation": "

A complex type that controls whether access logs are written for the distribution.

" - } - }, - "Origins": { - "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOrigins", - "traits": { - "smithy.api#documentation": "

A complex type that contains information about origins for this distribution.

" - } - }, - "OriginGroups": { - "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroups", - "traits": { - "smithy.api#documentation": "

Provides information about the origin groups in the distribution.

" - } - }, - "ViewerCertificate": { - "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionViewerCertificate", - "traits": { - "smithy.api#documentation": "

Provides information about the TLS/SSL configuration that the distribution uses to communicate with viewers.

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates the current status of the distribution.

" - } - }, - "WebAclId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A CloudFront distribution configuration.

" - } - }, - "com.amazonaws.securityhub#AwsCloudFrontDistributionLogging": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The S3 bucket to store the access logs in.

" - } - }, - "Enabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

With this field, you can enable or disable the selected distribution.

" - } - }, - "IncludeCookies": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether you want CloudFront to include cookies in access logs.

" - } - }, - "Prefix": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

An optional string that you want CloudFront to use as a prefix to the access log\n filenames for this distribution.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that controls whether access logs are written for the CloudFront distribution.

" - } - }, - "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginCustomOriginConfig": { - "type": "structure", - "members": { - "HttpPort": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP port that CloudFront uses to connect to the origin.\n

" - } - }, - "HttpsPort": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTPS port that CloudFront uses to connect to the origin.\n

" - } - }, - "OriginKeepaliveTimeout": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies how long, in seconds, CloudFront persists its connection to the origin.\n

" - } - }, - "OriginProtocolPolicy": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. \n

" - } - }, - "OriginReadTimeout": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies how long, in seconds, CloudFront waits for a response from the origin.\n

" - } - }, - "OriginSslProtocols": { - "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginSslProtocols", - "traits": { - "smithy.api#documentation": "

Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A custom origin. A custom origin is any origin that is not an Amazon S3 bucket, with one exception. An Amazon S3 bucket that is configured with\n static website hosting is a custom origin.

" - } - }, - "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroup": { - "type": "structure", - "members": { - "FailoverCriteria": { - "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroupFailover", - "traits": { - "smithy.api#documentation": "

Provides the criteria for an origin group to fail over.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about an origin group for the CloudFront distribution.

" - } - }, - "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroupFailover": { - "type": "structure", - "members": { - "StatusCodes": { - "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroupFailoverStatusCodes", - "traits": { - "smithy.api#documentation": "

Information about the status codes that cause an origin group to fail over.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about when an origin group fails over.

" - } - }, - "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroupFailoverStatusCodes": { - "type": "structure", - "members": { - "Items": { - "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroupFailoverStatusCodesItemList", - "traits": { - "smithy.api#documentation": "

The list of status code values that can cause a failover to the next origin.

" - } - }, - "Quantity": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of status codes that can cause a failover.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The status codes that cause an origin group to fail over.

" - } - }, - "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroupFailoverStatusCodesItemList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#Integer" - } - }, - "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroups": { - "type": "structure", - "members": { - "Items": { - "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroupsItemList", - "traits": { - "smithy.api#documentation": "

The list of origin groups.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about origin groups that are associated with the CloudFront distribution.

" - } - }, - "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroupsItemList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroup" - } - }, - "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginItem": { - "type": "structure", - "members": { - "DomainName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Amazon S3 origins: The DNS name of the S3 bucket from which you want\n CloudFront to get objects for this origin.

" - } - }, - "Id": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A unique identifier for the origin or origin group.

" - } - }, - "OriginPath": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

An optional element that causes CloudFront to request your content from a\n directory in your Amazon S3 bucket or your custom origin.

" - } - }, - "S3OriginConfig": { - "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginS3OriginConfig", - "traits": { - "smithy.api#documentation": "

An origin that is an S3 bucket that is not configured with static website\n hosting.

" - } - }, - "CustomOriginConfig": { - "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginCustomOriginConfig", - "traits": { - "smithy.api#documentation": "

An origin that is not an Amazon S3 bucket, with one exception. \nIf the Amazon S3 bucket is configured with static website hosting, use this attribute. \nIf the Amazon S3 bucket is not configured with static website hosting, use the S3OriginConfig type instead.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that describes the\n Amazon S3 bucket, HTTP server (for example, a web server), AWS Elemental MediaStore, or other server from which CloudFront gets your files.

" - } - }, - "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginItemList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginItem" - } - }, - "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginS3OriginConfig": { - "type": "structure", - "members": { - "OriginAccessIdentity": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The CloudFront origin access identity to associate with the origin.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about an origin that is an Amazon S3 bucket that is not configured with static website\n hosting.

" - } - }, - "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginSslProtocols": { - "type": "structure", - "members": { - "Items": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

A list that contains allowed SSL/TLS protocols for this distribution.\n

" - } - }, - "Quantity": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing \nan HTTPS connection with this origin.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the SSL/TLS protocols that CloudFront can use \nwhen establishing an HTTPS connection with your origin.\n

" - } - }, - "com.amazonaws.securityhub#AwsCloudFrontDistributionOrigins": { - "type": "structure", - "members": { - "Items": { - "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginItemList", - "traits": { - "smithy.api#documentation": "

A complex type that contains origins or origin groups for this distribution.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains information about origins and origin groups for this CloudFront distribution.

" - } - }, - "com.amazonaws.securityhub#AwsCloudFrontDistributionViewerCertificate": { - "type": "structure", - "members": { - "AcmCertificateArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the ACM certificate. Used if the certificate is stored in ACM. If you provide an ACM certificate ARN, you must also provide MinimumCertificateVersion and SslSupportMethod.

" - } - }, - "Certificate": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the certificate. Note that in CloudFront, this attribute is deprecated.

" - } - }, - "CertificateSource": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The source of the certificate identified by Certificate. Note that in CloudFront, this attribute is deprecated.

" - } - }, - "CloudFrontDefaultCertificate": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the distribution uses the CloudFront domain name. If set to false, then you provide either AcmCertificateArn or IamCertificateId.

" - } - }, - "IamCertificateId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the IAM certificate. Used if the certificate is stored in IAM. If you provide IamCertificateId, then you also must provide MinimumProtocolVersion and SslSupportMethod.

" - } - }, - "MinimumProtocolVersion": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The security policy that CloudFront uses for HTTPS connections with viewers. If SslSupportMethod is sni-only, then MinimumProtocolVersion must be TLSv1 or higher.

" - } - }, - "SslSupportMethod": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The viewers that the distribution accepts HTTPS connections from.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about the TLS/SSL configuration that the CloudFront distribution uses to communicate with viewers.

" - } - }, - "com.amazonaws.securityhub#AwsCloudTrailTrailDetails": { - "type": "structure", - "members": { - "CloudWatchLogsLogGroupArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the log group that CloudTrail logs are delivered to.

" - } - }, - "CloudWatchLogsRoleArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the role that the CloudWatch Events endpoint assumes when it writes to the log\n group.

" - } - }, - "HasCustomEventSelectors": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the trail has custom event selectors.

" - } - }, - "HomeRegion": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Region where the trail was created.

" - } - }, - "IncludeGlobalServiceEvents": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the trail publishes events from global services such as IAM to the log\n files.

" - } - }, - "IsMultiRegionTrail": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the trail applies only to the current Region or to all Regions.

" - } - }, - "IsOrganizationTrail": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the trail is created for all accounts in an organization in Organizations,\n or only for the current Amazon Web Services account.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The KMS key ID to use to encrypt the logs.

" - } - }, - "LogFileValidationEnabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether CloudTrail log file validation is enabled.

" - } - }, - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the trail.

" - } - }, - "S3BucketName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the S3 bucket where the log files are published.

" - } - }, - "S3KeyPrefix": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The S3 key prefix. The key prefix is added after the name of the S3 bucket where the log\n files are published.

" - } - }, - "SnsTopicArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the SNS topic that is used for notifications of log file delivery.

" - } - }, - "SnsTopicName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the SNS topic that is used for notifications of log file delivery.

" - } - }, - "TrailArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the trail.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides details about a CloudTrail trail.

" - } - }, - "com.amazonaws.securityhub#AwsCloudWatchAlarmDetails": { - "type": "structure", - "members": { - "ActionsEnabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether actions should be executed during any changes to the alarm state. \n

" - } - }, - "AlarmActions": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The list of actions, specified as Amazon Resource Names (ARNs) to execute when this alarm transitions into an ALARM state from any other\n state.

" - } - }, - "AlarmArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the alarm.\n

" - } - }, - "AlarmConfigurationUpdatedTimestamp": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The time stamp of the last update to the alarm configuration.\n

" - } - }, - "AlarmDescription": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The description of the alarm.\n

" - } - }, - "AlarmName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the alarm. If you don't specify a name, CloudFront generates a unique physical ID \nand uses that ID for the alarm name. \n

" - } - }, - "ComparisonOperator": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The arithmetic operation to use when comparing the specified statistic and threshold. The specified \nstatistic value is used as the first operand.\n

" - } - }, - "DatapointsToAlarm": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of datapoints that must be breaching to trigger the alarm. \n

" - } - }, - "Dimensions": { - "target": "com.amazonaws.securityhub#AwsCloudWatchAlarmDimensionsList", - "traits": { - "smithy.api#documentation": "

The dimensions for the metric associated with the alarm. \n

" - } - }, - "EvaluateLowSampleCountPercentile": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Used only for alarms based on percentiles. If ignore, the alarm state does not change during \nperiods with too few data points to be statistically significant. If evaluate or this parameter is not used, \nthe alarm is always evaluated and possibly changes state no matter how many data points are available.\n

" - } - }, - "EvaluationPeriods": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of periods over which data is compared to the specified threshold.\n

" - } - }, - "ExtendedStatistic": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The percentile statistic for the metric associated with the alarm. \n

" - } - }, - "InsufficientDataActions": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from \nany other state. Each action is specified as an ARN.\n

" - } - }, - "MetricName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the metric associated with the alarm. This is required for an alarm based on a metric. \nFor an alarm based on a math expression, you use Metrics instead and you can't specify MetricName.\n

" - } - }, - "Namespace": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The namespace of the metric associated with the alarm. This is required for an alarm based on a \nmetric. For an alarm based on a math expression, you can't specify Namespace and you use \nMetrics instead.\n

" - } - }, - "OkActions": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The actions to execute when this alarm transitions to the OK state from any other state. \nEach action is specified as an ARN.\n

" - } - }, - "Period": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The period, in seconds, over which the statistic is applied. This is required for an alarm based on a \nmetric.\n

" - } - }, - "Statistic": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.

\n

For an alarm based on a metric, you must specify either Statistic or ExtendedStatistic but not both.

\n

For an alarm based on a math expression, you can't specify Statistic. Instead, you use Metrics.

" - } - }, - "Threshold": { - "target": "com.amazonaws.securityhub#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The value to compare with the specified statistic.\n

" - } - }, - "ThresholdMetricId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

n 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.\n

" - } - }, - "TreatMissingData": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Sets how this alarm is to handle missing data points. \n

" - } - }, - "Unit": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The unit of the metric associated with the alarm.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies an alarm and associates it with the specified metric or metric math expression.\n

" - } - }, - "com.amazonaws.securityhub#AwsCloudWatchAlarmDimensionsDetails": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of a dimension.\n

" - } - }, - "Value": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The value of a dimension.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about the dimensions for the metric associated with the alarm.\n

" - } - }, - "com.amazonaws.securityhub#AwsCloudWatchAlarmDimensionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsCloudWatchAlarmDimensionsDetails" - } - }, - "com.amazonaws.securityhub#AwsCodeBuildProjectArtifactsDetails": { - "type": "structure", - "members": { - "ArtifactIdentifier": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

An identifier for the artifact definition.

" - } - }, - "EncryptionDisabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to disable encryption on the artifact. Only valid when Type is S3.

" - } - }, - "Location": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Only used when Type is S3. The name of the S3 bucket where the artifact is located.

" - } - }, - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Only used when Type is S3. The name of the artifact. Used with NamepaceType and Path to determine the pattern for storing the artifact.

" - } - }, - "NamespaceType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Only used when Type is S3. The value to use for the namespace. Used with Name and Path to determine the pattern for storing the artifact.

" - } - }, - "OverrideArtifactName": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the name specified in the buildspec file overrides the artifact name.

" - } - }, - "Packaging": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Only used when Type is S3. The type of output artifact to create.

" - } - }, - "Path": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Only used when Type is S3. The path to the artifact. Used with Name and NamespaceType to determine the pattern for storing the artifact.

" - } - }, - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of build artifact.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the build artifacts for the CodeBuild project.

" - } - }, - "com.amazonaws.securityhub#AwsCodeBuildProjectArtifactsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsCodeBuildProjectArtifactsDetails" - } - }, - "com.amazonaws.securityhub#AwsCodeBuildProjectDetails": { - "type": "structure", - "members": { - "EncryptionKey": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The KMS key used to encrypt the\n build output artifacts.

\n

You can specify either the ARN of the KMS key or, if available, the\n KMS key alias (using the format alias/alias-name).

" - } - }, - "Artifacts": { - "target": "com.amazonaws.securityhub#AwsCodeBuildProjectArtifactsList", - "traits": { - "smithy.api#documentation": "

Information about the build artifacts for the CodeBuild project.

" - } - }, - "Environment": { - "target": "com.amazonaws.securityhub#AwsCodeBuildProjectEnvironment", - "traits": { - "smithy.api#documentation": "

Information about the build environment for this build project.

" - } - }, - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the build project.

" - } - }, - "Source": { - "target": "com.amazonaws.securityhub#AwsCodeBuildProjectSource", - "traits": { - "smithy.api#documentation": "

Information about the build input source code for this build project.

" - } - }, - "ServiceRole": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services\n services on behalf of the Amazon Web Services account.

" - } - }, - "LogsConfig": { - "target": "com.amazonaws.securityhub#AwsCodeBuildProjectLogsConfigDetails", - "traits": { - "smithy.api#documentation": "

Information about logs for the build project.

" - } - }, - "VpcConfig": { - "target": "com.amazonaws.securityhub#AwsCodeBuildProjectVpcConfig", - "traits": { - "smithy.api#documentation": "

Information about the VPC configuration that CodeBuild accesses.

" - } - }, - "SecondaryArtifacts": { - "target": "com.amazonaws.securityhub#AwsCodeBuildProjectArtifactsList", - "traits": { - "smithy.api#documentation": "

Information about the secondary artifacts for the CodeBuild project.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about an CodeBuild project.

" - } - }, - "com.amazonaws.securityhub#AwsCodeBuildProjectEnvironment": { - "type": "structure", - "members": { - "Certificate": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The certificate to use with this build project.

" - } - }, - "EnvironmentVariables": { - "target": "com.amazonaws.securityhub#AwsCodeBuildProjectEnvironmentEnvironmentVariablesList", - "traits": { - "smithy.api#documentation": "

A set of environment variables to make available to builds for the build project.

" - } - }, - "PrivilegedMode": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether to allow the Docker daemon to run inside a Docker container. Set to true if the build project is used to build Docker images.

" - } - }, - "ImagePullCredentialsType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of credentials CodeBuild uses to pull images in your build.

\n

Valid values:

\n \n

When you use a cross-account or private registry image, you must use\n SERVICE_ROLE credentials. When you use an CodeBuild curated image, you\n must use CODEBUILD credentials.

" - } - }, - "RegistryCredential": { - "target": "com.amazonaws.securityhub#AwsCodeBuildProjectEnvironmentRegistryCredential", - "traits": { - "smithy.api#documentation": "

The credentials for access to a private registry.

" - } - }, - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of build environment to use for related builds.

\n

The environment type ARM_CONTAINER is available only in Regions US East (N.\n Virginia), US East (Ohio), US West (Oregon), Europe (Ireland), Asia Pacific (Mumbai), Asia\n Pacific (Tokyo), Asia Pacific (Sydney), and Europe (Frankfurt).

\n

The environment type LINUX_CONTAINER with compute type\n build.general1.2xlarge is available only in Regions US East (N. Virginia), US East (N.\n Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe\n (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia\n Pacific (Sydney), China (Beijing), and China (Ningxia).

\n

The environment type LINUX_GPU_CONTAINER is available only in Regions US\n East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), Europe\n (Ireland), Europe (London), Europe (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul),\n Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China\n (Ningxia).

\n

Valid values: WINDOWS_CONTAINER | LINUX_CONTAINER |\n LINUX_GPU_CONTAINER | ARM_CONTAINER\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the build environment for this build project.

" - } - }, - "com.amazonaws.securityhub#AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the environment variable.

" - } - }, - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of environment variable.

" - } - }, - "Value": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The value of the environment variable.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about an environment variable that is available to builds for the build project.

" - } - }, - "com.amazonaws.securityhub#AwsCodeBuildProjectEnvironmentEnvironmentVariablesList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails" - } - }, - "com.amazonaws.securityhub#AwsCodeBuildProjectEnvironmentRegistryCredential": { - "type": "structure", - "members": { - "Credential": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN or name of credentials created using Secrets Manager.

\n \n

The credential can use the name of the credentials only if they exist in your current\n Amazon Web Services Region.

\n " - } - }, - "CredentialProvider": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The service that created the credentials to access a private Docker registry.

\n

The valid value, SECRETS_MANAGER, is for Secrets Manager.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The credentials for access to a private registry.

" - } - }, - "com.amazonaws.securityhub#AwsCodeBuildProjectLogsConfigCloudWatchLogsDetails": { - "type": "structure", - "members": { - "GroupName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The group name of the logs in CloudWatch Logs.

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The current status of the logs in CloudWatch Logs for a build project.

" - } - }, - "StreamName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The prefix of the stream name of the CloudWatch Logs.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about CloudWatch Logs for the build project.

" - } + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] }, - "com.amazonaws.securityhub#AwsCodeBuildProjectLogsConfigDetails": { - "type": "structure", - "members": { - "CloudWatchLogs": { - "target": "com.amazonaws.securityhub#AwsCodeBuildProjectLogsConfigCloudWatchLogsDetails", - "traits": { - "smithy.api#documentation": "

Information about CloudWatch Logs for the build project.

" - } - }, - "S3Logs": { - "target": "com.amazonaws.securityhub#AwsCodeBuildProjectLogsConfigS3LogsDetails", - "traits": { - "smithy.api#documentation": "

Information about logs built to an S3 bucket for a build project.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about logs for the build project.

" - } - }, - "com.amazonaws.securityhub#AwsCodeBuildProjectLogsConfigS3LogsDetails": { - "type": "structure", - "members": { - "EncryptionDisabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether to disable encryption of the S3 build log output.

" - } - }, - "Location": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the S3 bucket and the path prefix for S3 logs.

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The current status of the S3 build logs.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about logs built to an S3 bucket for a build project.

" - } - }, - "com.amazonaws.securityhub#AwsCodeBuildProjectSource": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of repository that contains the source code to be built. Valid values\n are:

\n " - } - }, - "Location": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Information about the location of the source code to be built.

\n

Valid values include:

\n " - } - }, - "GitCloneDepth": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Information about the Git clone depth for the build project.

" - } - }, - "InsecureSsl": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether to ignore SSL warnings while connecting to the project source code.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the build input source code for this build project.

" - } - }, - "com.amazonaws.securityhub#AwsCodeBuildProjectVpcConfig": { - "type": "structure", - "members": { - "VpcId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the VPC.

" - } - }, - "Subnets": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

A list of one or more subnet IDs in your VPC.

" - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

A list of one or more security group IDs in your VPC.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the VPC configuration that CodeBuild accesses.

" - } - }, - "com.amazonaws.securityhub#AwsCorsConfiguration": { - "type": "structure", - "members": { - "AllowOrigins": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The allowed origins for CORS requests.

" - } - }, - "AllowCredentials": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the CORS request includes credentials.

" - } - }, - "ExposeHeaders": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The exposed headers for CORS requests.

" - } - }, - "MaxAge": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of seconds for which the browser caches preflight request results.

" - } - }, - "AllowMethods": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The allowed methods for CORS requests.

" - } - }, - "AllowHeaders": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The allowed headers for CORS requests.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the cross-origin resource sharing (CORS) configuration for the API. CORS is\n only supported for HTTP APIs.

" - } - }, - "com.amazonaws.securityhub#AwsDynamoDbTableAttributeDefinition": { - "type": "structure", - "members": { - "AttributeName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the attribute.

" - } - }, - "AttributeType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of the attribute.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains a definition of an attribute for the table.

" - } - }, - "com.amazonaws.securityhub#AwsDynamoDbTableAttributeDefinitionList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsDynamoDbTableAttributeDefinition" - } - }, - "com.amazonaws.securityhub#AwsDynamoDbTableBillingModeSummary": { - "type": "structure", - "members": { - "BillingMode": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The method used to charge for read and write throughput and to manage capacity.

" - } - }, - "LastUpdateToPayPerRequestDateTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

If the billing mode is PAY_PER_REQUEST, indicates when the billing mode was\n set to that value.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about the billing for read/write capacity on the table.

" - } - }, - "com.amazonaws.securityhub#AwsDynamoDbTableDetails": { - "type": "structure", - "members": { - "AttributeDefinitions": { - "target": "com.amazonaws.securityhub#AwsDynamoDbTableAttributeDefinitionList", - "traits": { - "smithy.api#documentation": "

A list of attribute definitions for the table.

" - } - }, - "BillingModeSummary": { - "target": "com.amazonaws.securityhub#AwsDynamoDbTableBillingModeSummary", - "traits": { - "smithy.api#documentation": "

Information about the billing for read/write capacity on the table.

" - } - }, - "CreationDateTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the table was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "GlobalSecondaryIndexes": { - "target": "com.amazonaws.securityhub#AwsDynamoDbTableGlobalSecondaryIndexList", - "traits": { - "smithy.api#documentation": "

List of global secondary indexes for the table.

" - } - }, - "GlobalTableVersion": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The version of global tables being used.

" - } - }, - "ItemCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of items in the table.

" - } - }, - "KeySchema": { - "target": "com.amazonaws.securityhub#AwsDynamoDbTableKeySchemaList", - "traits": { - "smithy.api#documentation": "

The primary key structure for the table.

" - } - }, - "LatestStreamArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the latest stream for the table.

" - } - }, - "LatestStreamLabel": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The label of the latest stream. The label is not a unique identifier.

" - } - }, - "LocalSecondaryIndexes": { - "target": "com.amazonaws.securityhub#AwsDynamoDbTableLocalSecondaryIndexList", - "traits": { - "smithy.api#documentation": "

The list of local secondary indexes for the table.

" - } - }, - "ProvisionedThroughput": { - "target": "com.amazonaws.securityhub#AwsDynamoDbTableProvisionedThroughput", - "traits": { - "smithy.api#documentation": "

Information about the provisioned throughput for the table.

" - } - }, - "Replicas": { - "target": "com.amazonaws.securityhub#AwsDynamoDbTableReplicaList", - "traits": { - "smithy.api#documentation": "

The list of replicas of this table.

" - } - }, - "RestoreSummary": { - "target": "com.amazonaws.securityhub#AwsDynamoDbTableRestoreSummary", - "traits": { - "smithy.api#documentation": "

Information about the restore for the table.

" - } - }, - "SseDescription": { - "target": "com.amazonaws.securityhub#AwsDynamoDbTableSseDescription", - "traits": { - "smithy.api#documentation": "

Information about the server-side encryption for the table.

" - } - }, - "StreamSpecification": { - "target": "com.amazonaws.securityhub#AwsDynamoDbTableStreamSpecification", - "traits": { - "smithy.api#documentation": "

The current DynamoDB Streams configuration for the table.

" - } - }, - "TableId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the table.

" - } - }, - "TableName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the table.

" - } - }, - "TableSizeBytes": { - "target": "com.amazonaws.securityhub#SizeBytes", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The total size of the table in bytes.

" - } - }, - "TableStatus": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The current status of the table. Valid values are as follows:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides details about a DynamoDB table.

" - } - }, - "com.amazonaws.securityhub#AwsDynamoDbTableGlobalSecondaryIndex": { - "type": "structure", - "members": { - "Backfilling": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the index is currently backfilling.

" - } - }, - "IndexArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the index.

" - } - }, - "IndexName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the index.

" - } - }, - "IndexSizeBytes": { - "target": "com.amazonaws.securityhub#SizeBytes", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The total size in bytes of the index.

" - } - }, - "IndexStatus": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The current status of the index.

\n " - } - }, - "ItemCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of items in the index.

" - } - }, - "KeySchema": { - "target": "com.amazonaws.securityhub#AwsDynamoDbTableKeySchemaList", - "traits": { - "smithy.api#documentation": "

The key schema for the index.

" - } - }, - "Projection": { - "target": "com.amazonaws.securityhub#AwsDynamoDbTableProjection", - "traits": { - "smithy.api#documentation": "

Attributes that are copied from the table into an index.

" - } - }, - "ProvisionedThroughput": { - "target": "com.amazonaws.securityhub#AwsDynamoDbTableProvisionedThroughput", - "traits": { - "smithy.api#documentation": "

Information about the provisioned throughput settings for the indexes.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information abut a global secondary index for the table.

" - } - }, - "com.amazonaws.securityhub#AwsDynamoDbTableGlobalSecondaryIndexList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsDynamoDbTableGlobalSecondaryIndex" - } - }, - "com.amazonaws.securityhub#AwsDynamoDbTableKeySchema": { - "type": "structure", - "members": { - "AttributeName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the key schema attribute.

" - } - }, - "KeyType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of key used for the key schema attribute. Valid values are HASH or RANGE.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A component of the key schema for the DynamoDB table, a global secondary index, or a\n local secondary index.

" - } - }, - "com.amazonaws.securityhub#AwsDynamoDbTableKeySchemaList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsDynamoDbTableKeySchema" - } - }, - "com.amazonaws.securityhub#AwsDynamoDbTableLocalSecondaryIndex": { - "type": "structure", - "members": { - "IndexArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the index.

" - } - }, - "IndexName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the index.

" - } - }, - "KeySchema": { - "target": "com.amazonaws.securityhub#AwsDynamoDbTableKeySchemaList", - "traits": { - "smithy.api#documentation": "

The complete key schema for the index.

" - } - }, - "Projection": { - "target": "com.amazonaws.securityhub#AwsDynamoDbTableProjection", - "traits": { - "smithy.api#documentation": "

Attributes that are copied from the table into the index. These are in addition to the\n primary key attributes and index key attributes, which are automatically projected.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a local secondary index for a DynamoDB table.

" - } - }, - "com.amazonaws.securityhub#AwsDynamoDbTableLocalSecondaryIndexList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsDynamoDbTableLocalSecondaryIndex" - } - }, - "com.amazonaws.securityhub#AwsDynamoDbTableProjection": { - "type": "structure", - "members": { - "NonKeyAttributes": { - "target": "com.amazonaws.securityhub#StringList", - "traits": { - "smithy.api#documentation": "

The nonkey attributes that are projected into the index. For each attribute, provide the\n attribute name.

" - } - }, - "ProjectionType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The types of attributes that are projected into the index. Valid values are as follows:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

For global and local secondary indexes, identifies the attributes that are copied from\n the table into the index.

" - } - }, - "com.amazonaws.securityhub#AwsDynamoDbTableProvisionedThroughput": { - "type": "structure", - "members": { - "LastDecreaseDateTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the provisioned throughput was last decreased.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "LastIncreaseDateTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the provisioned throughput was last increased.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "NumberOfDecreasesToday": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of times during the current UTC calendar day that the provisioned throughput\n was decreased.

" - } - }, - "ReadCapacityUnits": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of strongly consistent reads consumed per second before DynamoDB\n returns a ThrottlingException.

" - } - }, - "WriteCapacityUnits": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of writes consumed per second before DynamoDB returns a\n ThrottlingException.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the provisioned throughput for the table or for a global secondary\n index.

" - } - }, - "com.amazonaws.securityhub#AwsDynamoDbTableProvisionedThroughputOverride": { - "type": "structure", - "members": { - "ReadCapacityUnits": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The read capacity units for the replica.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Replica-specific configuration for the provisioned throughput.

" - } - }, - "com.amazonaws.securityhub#AwsDynamoDbTableReplica": { - "type": "structure", - "members": { - "GlobalSecondaryIndexes": { - "target": "com.amazonaws.securityhub#AwsDynamoDbTableReplicaGlobalSecondaryIndexList", - "traits": { - "smithy.api#documentation": "

List of global secondary indexes for the replica.

" - } - }, - "KmsMasterKeyId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the KMS key that will be used for KMS\n encryption for the replica.

" - } - }, - "ProvisionedThroughputOverride": { - "target": "com.amazonaws.securityhub#AwsDynamoDbTableProvisionedThroughputOverride", - "traits": { - "smithy.api#documentation": "

Replica-specific configuration for the provisioned throughput.

" - } - }, - "RegionName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the Region where the replica is located.

" - } - }, - "ReplicaStatus": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The current status of the replica. Valid values are as follows:

\n " - } - }, - "ReplicaStatusDescription": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Detailed information about the replica status.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a replica of a DynamoDB table.

" - } - }, - "com.amazonaws.securityhub#AwsDynamoDbTableReplicaGlobalSecondaryIndex": { - "type": "structure", - "members": { - "IndexName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the index.

" - } - }, - "ProvisionedThroughputOverride": { - "target": "com.amazonaws.securityhub#AwsDynamoDbTableProvisionedThroughputOverride", - "traits": { - "smithy.api#documentation": "

Replica-specific configuration for the provisioned throughput for the index.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a global secondary index for a DynamoDB table replica.

" - } - }, - "com.amazonaws.securityhub#AwsDynamoDbTableReplicaGlobalSecondaryIndexList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsDynamoDbTableReplicaGlobalSecondaryIndex" - } - }, - "com.amazonaws.securityhub#AwsDynamoDbTableReplicaList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsDynamoDbTableReplica" - } - }, - "com.amazonaws.securityhub#AwsDynamoDbTableRestoreSummary": { - "type": "structure", - "members": { - "SourceBackupArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the source backup from which the table was restored.

" - } - }, - "SourceTableArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the source table for the backup.

" - } - }, - "RestoreDateTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates the point in time that the table was restored to.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "RestoreInProgress": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether a restore is currently in progress.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the restore for the table.

" - } - }, - "com.amazonaws.securityhub#AwsDynamoDbTableSseDescription": { - "type": "structure", - "members": { - "InaccessibleEncryptionDateTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

If the key is inaccessible, the date and time when DynamoDB detected that the key was\n inaccessible.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The status of the server-side encryption.

" - } - }, - "SseType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of server-side encryption.

" - } - }, - "KmsMasterKeyArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the KMS key that is used for the KMS\n encryption.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the server-side encryption for the table.

" - } - }, - "com.amazonaws.securityhub#AwsDynamoDbTableStreamSpecification": { - "type": "structure", - "members": { - "StreamEnabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether DynamoDB Streams is enabled on the table.

" - } - }, - "StreamViewType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Determines the information that is written to the table.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The current DynamoDB Streams configuration for the table.

" - } - }, - "com.amazonaws.securityhub#AwsEc2EipDetails": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the EC2 instance.

" - } - }, - "PublicIp": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A public IP address that is associated with the EC2 instance.

" - } - }, - "AllocationId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier that Amazon Web Services assigns to represent the allocation of the Elastic IP address\n for use with Amazon VPC.

" - } - }, - "AssociationId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier that represents the association of the Elastic IP address with an EC2\n instance.

" - } - }, - "Domain": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The domain in which to allocate the address.

\n

If the address is for use with EC2 instances in a VPC, then Domain is\n vpc. Otherwise, Domain is standard.

" - } - }, - "PublicIpv4Pool": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of an IP address pool. This parameter allows Amazon EC2 to select an IP\n address from the address pool.

" - } - }, - "NetworkBorderGroup": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the location from which the Elastic IP address is advertised.

" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the network interface.

" - } - }, - "NetworkInterfaceOwnerId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the network interface.

" - } - }, - "PrivateIpAddress": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The private IP address that is associated with the Elastic IP address.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about an Elastic IP address.

" - } - }, - "com.amazonaws.securityhub#AwsEc2InstanceDetails": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The instance type of the instance.

" - } - }, - "ImageId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Machine Image (AMI) ID of the instance.

" - } - }, - "IpV4Addresses": { - "target": "com.amazonaws.securityhub#StringList", - "traits": { - "smithy.api#documentation": "

The IPv4 addresses associated with the instance.

" - } - }, - "IpV6Addresses": { - "target": "com.amazonaws.securityhub#StringList", - "traits": { - "smithy.api#documentation": "

The IPv6 addresses associated with the instance.

" - } - }, - "KeyName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The key name associated with the instance.

" - } - }, - "IamInstanceProfileArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The IAM profile ARN of the instance.

" - } - }, - "VpcId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the VPC that the instance was launched in.

" - } - }, - "SubnetId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the subnet that the instance was launched in.

" - } - }, - "LaunchedAt": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the instance was launched.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "NetworkInterfaces": { - "target": "com.amazonaws.securityhub#AwsEc2InstanceNetworkInterfacesList", - "traits": { - "smithy.api#documentation": "

The identifiers of the network interfaces for the EC2 instance. The details for each network interface are in a corresponding AwsEc2NetworkInterfacesDetails object.

" - } - }, - "VirtualizationType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The virtualization type of the Amazon Machine Image (AMI) required to launch the instance.\n

" - } - }, - "MetadataOptions": { - "target": "com.amazonaws.securityhub#AwsEc2InstanceMetadataOptions", - "traits": { - "smithy.api#documentation": "

Details about the metadata options for the Amazon EC2 instance.\n

" - } - }, - "Monitoring": { - "target": "com.amazonaws.securityhub#AwsEc2InstanceMonitoringDetails", - "traits": { - "smithy.api#documentation": "

\n Describes the type of monitoring that’s turned on for an instance.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The details of an Amazon EC2 instance.

" - } - }, - "com.amazonaws.securityhub#AwsEc2InstanceMetadataOptions": { - "type": "structure", - "members": { - "HttpEndpoint": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Enables or disables the HTTP metadata endpoint on the instance. \n

" - } - }, - "HttpProtocolIpv6": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Enables or disables the IPv6 endpoint for the instance metadata service.\n

" - } - }, - "HttpPutResponseHopLimit": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. \n The larger the number, the further instance metadata requests can travel.\n

" - } - }, - "HttpTokens": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The state of token usage for your instance metadata requests. \n

" - } - }, - "InstanceMetadataTags": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Specifies whether to allow access to instance tags from the instance metadata.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Metadata options that allow you to configure and secure the Amazon EC2 instance.

" - } - }, - "com.amazonaws.securityhub#AwsEc2InstanceMonitoringDetails": { - "type": "structure", - "members": { - "State": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n Indicates whether detailed monitoring is turned on. Otherwise, basic monitoring is turned on.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n The type of monitoring that’s turned on for an Amazon EC2 instance.\n

" - } - }, - "com.amazonaws.securityhub#AwsEc2InstanceNetworkInterfacesDetails": { - "type": "structure", - "members": { - "NetworkInterfaceId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the network interface. The details are in a corresponding AwsEc2NetworkInterfacesDetails object.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Identifies a network interface for the Amazon EC2 instance.

" - } - }, - "com.amazonaws.securityhub#AwsEc2InstanceNetworkInterfacesList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEc2InstanceNetworkInterfacesDetails" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails": { - "type": "structure", - "members": { - "DeviceName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The device name.\n

" - } - }, - "Ebs": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails", - "traits": { - "smithy.api#documentation": "

\n Parameters used to automatically set up Amazon EBS volumes when the instance is \n launched.\n

" - } - }, - "NoDevice": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n Omits the device from the block device mapping when an empty string is specified.\n

" - } - }, - "VirtualName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The virtual device name (ephemeralN). Instance store volumes are numbered starting \n from 0. An instance type with 2 available instance store volumes can specify mappings \n for ephemeral0 and ephemeral1. The number of available instance store volumes depends \n on the instance type.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Information about a block device mapping for an Amazon Elastic Compute Cloud (Amazon EC2) launch template.\n

" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails": { - "type": "structure", - "members": { - "DeleteOnTermination": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

\n Indicates whether the EBS volume is deleted on instance termination.\n

" - } - }, - "Encrypted": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

\n Indicates whether the EBS volume is encrypted. Encrypted volumes can only be \n attached to instances that support Amazon EBS encryption. If you're creating a \n volume from a snapshot, you can't specify an encryption value.\n

" - } - }, - "Iops": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The number of I/O operations per second (IOPS). \n

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the symmetric Key Management Service (KMS) customer managed key \n used for encryption.\n

" - } - }, - "SnapshotId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The ID of the EBS snapshot.\n

" - } - }, - "Throughput": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.\n

" - } - }, - "VolumeSize": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. \n

" - } - }, - "VolumeType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The volume type.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Parameters for a block device for an Amazon Elastic Block Store (Amazon EBS) volume in an Amazon EC2 launch template.\n

" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataBlockDeviceMappingSetList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataCapacityReservationSpecificationCapacityReservationTargetDetails": { - "type": "structure", - "members": { - "CapacityReservationId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The ID of the Capacity Reservation in which to run the instance.\n

" - } - }, - "CapacityReservationResourceGroupArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the Capacity Reservation resource group in which to run the instance.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Information about the target Capacity Reservation or Capacity Reservation group in which to run an Amazon EC2 instance.\n

" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataCapacityReservationSpecificationDetails": { - "type": "structure", - "members": { - "CapacityReservationPreference": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n Indicates the instance's Capacity Reservation preferences. If equal to open, the instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). If equal to none, the instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.\n \n

" - } - }, - "CapacityReservationTarget": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataCapacityReservationSpecificationCapacityReservationTargetDetails", - "traits": { - "smithy.api#documentation": "

\n Specifies a target Capacity Reservation.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Specifies the Capacity Reservation targeting option of an Amazon EC2 instance.\n

" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataCpuOptionsDetails": { - "type": "structure", - "members": { - "CoreCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The number of CPU cores for the instance.\n

" - } - }, - "ThreadsPerCore": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The number of threads per CPU core. A value of 1 disables multithreading for the instance, \n The default value is 2.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Specifies the CPU options for an Amazon EC2 instance. For more information, see \n Optimize CPU options in the Amazon Elastic Compute Cloud User Guide.\n

" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataCreditSpecificationDetails": { - "type": "structure", - "members": { - "CpuCredits": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The credit option for CPU usage of a T instance.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Specifies the credit option for CPU usage of a T2, T3, or T3a Amazon EC2 instance.\n

" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataDetails": { - "type": "structure", - "members": { - "BlockDeviceMappingSet": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataBlockDeviceMappingSetList", - "traits": { - "smithy.api#documentation": "

\n Information about a block device mapping for an Amazon EC2 launch template.\n

" - } - }, - "CapacityReservationSpecification": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataCapacityReservationSpecificationDetails", - "traits": { - "smithy.api#documentation": "

\n Specifies an instance's Capacity Reservation targeting option. You can specify only \n one option at a time.\n

" - } - }, - "CpuOptions": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataCpuOptionsDetails", - "traits": { - "smithy.api#documentation": "

\n Specifies the CPU options for an instance. For more information, see \n Optimize CPU options in the Amazon Elastic Compute Cloud User Guide.\n

" - } - }, - "CreditSpecification": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataCreditSpecificationDetails", - "traits": { - "smithy.api#documentation": "

\n Specifies the credit option for CPU usage of a T2, T3, or T3a instance.\n

" - } - }, - "DisableApiStop": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

\n Indicates whether to enable the instance for stop protection. For more information, \n see Enable stop protection in the Amazon EC2 User Guide.\n

" - } - }, - "DisableApiTermination": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

\n If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API. If set to true, you can. \n

" - } - }, - "EbsOptimized": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

\n Indicates whether the instance is optimized for Amazon EBS I/O. \n

" - } - }, - "ElasticGpuSpecificationSet": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataElasticGpuSpecificationSetList", - "traits": { - "smithy.api#documentation": "

\n Provides details about Elastic Graphics accelerators to associate with the instance.\n

" - } - }, - "ElasticInferenceAcceleratorSet": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetList", - "traits": { - "smithy.api#documentation": "

\n The Amazon Elastic Inference accelerator for the instance.\n

" - } - }, - "EnclaveOptions": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataEnclaveOptionsDetails", - "traits": { - "smithy.api#documentation": "

\n Indicates whether the Amazon EC2 instance is enabled for Amazon Web Services Nitro Enclaves.\n

" - } - }, - "HibernationOptions": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataHibernationOptionsDetails", - "traits": { - "smithy.api#documentation": "

\n Specifies whether your Amazon EC2 instance is configured for hibernation. \n

" - } - }, - "IamInstanceProfile": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataIamInstanceProfileDetails", - "traits": { - "smithy.api#documentation": "

\n The name or Amazon Resource Name (ARN) of an IAM instance profile.\n

" - } - }, - "ImageId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The ID of the Amazon Machine Image (AMI).\n

" - } - }, - "InstanceInitiatedShutdownBehavior": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n Provides the options for specifying the instance initiated shutdown behavior.\n

" - } - }, - "InstanceMarketOptions": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceMarketOptionsDetails", - "traits": { - "smithy.api#documentation": "

\n Specifies the market (purchasing) option for an instance.\n

" - } - }, - "InstanceRequirements": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsDetails", - "traits": { - "smithy.api#documentation": "

\n The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance \n types with these attributes. If you specify InstanceRequirements, you can't specify InstanceType.\n

" - } - }, - "InstanceType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The instance type. For more information, see Instance types in the Amazon EC2 User Guide. If you specify InstanceType, you can't \n specify InstanceRequirements.\n

" - } - }, - "KernelId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The ID of the kernel.\n

" - } - }, - "KeyName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The name of the key pair that allows users to connect to the instance.\n

" - } - }, - "LicenseSet": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataLicenseSetList", - "traits": { - "smithy.api#documentation": "

\n Specifies a license configuration for an instance.\n

" - } - }, - "MaintenanceOptions": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataMaintenanceOptionsDetails", - "traits": { - "smithy.api#documentation": "

\n The maintenance options of your instance.\n

" - } - }, - "MetadataOptions": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataMetadataOptionsDetails", - "traits": { - "smithy.api#documentation": "

\n The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon EC2 User Guide.\n

" - } - }, - "Monitoring": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataMonitoringDetails", - "traits": { - "smithy.api#documentation": "

\n The monitoring for the instance.\n

" - } - }, - "NetworkInterfaceSet": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetList", - "traits": { - "smithy.api#documentation": "

\n Specifies the parameters for a network interface that is attached to the instance.\n

" - } - }, - "Placement": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataPlacementDetails", - "traits": { - "smithy.api#documentation": "

\n Specifies the placement of an instance.\n

" - } - }, - "PrivateDnsNameOptions": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataPrivateDnsNameOptionsDetails", - "traits": { - "smithy.api#documentation": "

\n The options for the instance hostname.\n

" - } - }, - "RamDiskId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The ID of the RAM disk.\n

" - } - }, - "SecurityGroupIdSet": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

\n One or more security group IDs.\n

" - } - }, - "SecurityGroupSet": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

\n 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.\n

" - } - }, - "UserData": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The user data to make available to the instance.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n The information to include in an Amazon Elastic Compute Cloud (Amazon EC2) launch template.\n

" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataElasticGpuSpecificationSetDetails": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The type of Elastic Graphics accelerator. \n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Provides details about an Elastic Graphics specification for an Amazon EC2 launch template.\n

" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataElasticGpuSpecificationSetList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataElasticGpuSpecificationSetDetails" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetDetails": { - "type": "structure", - "members": { - "Count": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The number of Elastic Inference accelerators to attach to the instance.\n

" - } - }, - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The type of Elastic Inference accelerator.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Provides details for an Amazon Elastic Inference accelerator.\n

" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetDetails" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataEnclaveOptionsDetails": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

\n If this parameter is set to true, the instance is enabled for Amazon Web Services Nitro Enclaves.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.\n

" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataHibernationOptionsDetails": { - "type": "structure", - "members": { - "Configured": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

\n If you set this parameter to true, the instance is enabled for hibernation.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Specifies whether your Amazon EC2 instance is configured for hibernation.\n

" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataIamInstanceProfileDetails": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the instance profile.\n

" - } - }, - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The name of the instance profile.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Provides details for an Identity and Access Management (IAM) instance profile, which is a container for an IAM role for your instance.\n

" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceMarketOptionsDetails": { - "type": "structure", - "members": { - "MarketType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The market type.\n

" - } - }, - "SpotOptions": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails", - "traits": { - "smithy.api#documentation": "

\n The options for Spot Instances.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Provides details about the market (purchasing) option for an Amazon EC2 instance.\n

" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails": { - "type": "structure", - "members": { - "BlockDurationMinutes": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n Deprecated.\n

" - } - }, - "InstanceInterruptionBehavior": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The behavior when a Spot Instance is interrupted.\n

" - } - }, - "MaxPrice": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The maximum hourly price you're willing to pay for the Spot Instances.\n

" - } - }, - "SpotInstanceType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The Spot Instance request type.\n

" - } - }, - "ValidUntil": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ), for persistent requests.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Provides details about the market (purchasing) options for Spot Instances.\n

" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorCountDetails": { - "type": "structure", - "members": { - "Max": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The maximum number of accelerators. If this parameter isn't specified, there's no maximum limit. To exclude accelerator-enabled instance types, set Max to 0.\n

" - } - }, - "Min": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The minimum number of accelerators. If this parameter isn't specified, there's no minimum limit.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an Amazon EC2 instance.\n

" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorTotalMemoryMiBDetails": { - "type": "structure", - "members": { - "Max": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The maximum amount of memory, in MiB. If this parameter isn't specified, there's no maximum limit.\n

" - } - }, - "Min": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The minimum amount of memory, in MiB. If 0 is specified, there's no maximum limit.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n The minimum and maximum amount of memory, in MiB, for the accelerators on an Amazon EC2 instance.\n

" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsBaselineEbsBandwidthMbpsDetails": { - "type": "structure", - "members": { - "Max": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The maximum baseline bandwidth, in Mbps. If this parameter is omitted, there's no maximum limit.\n

" - } - }, - "Min": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The minimum baseline bandwidth, in Mbps. If this parameter is omitted, there's no minimum limit.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n The minimum and maximum baseline bandwidth to Amazon Elastic Block Store (Amazon EBS), in Mbps. For more information, \n see Amazon EBS–optimized instances in the Amazon EC2 User Guide.\n

" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsDetails": { - "type": "structure", - "members": { - "AcceleratorCount": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorCountDetails", - "traits": { - "smithy.api#documentation": "

\n The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance.\n

" - } - }, - "AcceleratorManufacturers": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

Indicates whether instance types must have accelerators by specific manufacturers.\n

" - } - }, - "AcceleratorNames": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

\n The accelerators that must be on the instance type.\n

" - } - }, - "AcceleratorTotalMemoryMiB": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorTotalMemoryMiBDetails", - "traits": { - "smithy.api#documentation": "

\n The minimum and maximum amount of total accelerator memory, in MiB.\n

" - } - }, - "AcceleratorTypes": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The accelerator types that must be on the instance type.\n

" - } - }, - "BareMetal": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates whether bare metal instance types must be included, excluded, or required.\n

" - } - }, - "BaselineEbsBandwidthMbps": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsBaselineEbsBandwidthMbpsDetails", - "traits": { - "smithy.api#documentation": "

\n The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS optimized instances in the Amazon EC2 User Guide.\n

" - } - }, - "BurstablePerformance": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n Indicates whether burstable performance T instance types are included, excluded, or required. For more information, Burstable performance instances in the Amazon EC2 User Guide.\n

" - } - }, - "CpuManufacturers": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

\n The CPU manufacturers to include.\n

" - } - }, - "ExcludedInstanceTypes": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

\n The instance types to exclude.\n

" - } - }, - "InstanceGenerations": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

\n Indicates whether current or previous generation instance types are included.\n

" - } - }, - "LocalStorage": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, see Amazon EC2 instance store in the Amazon EC2 User Guide.\n

" - } - }, - "LocalStorageTypes": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

\n The type of local storage that is required.\n

" - } - }, - "MemoryGiBPerVCpu": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsMemoryGiBPerVCpuDetails", - "traits": { - "smithy.api#documentation": "

\n The minimum and maximum amount of memory per vCPU, in GiB.\n

" - } - }, - "MemoryMiB": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsMemoryMiBDetails", - "traits": { - "smithy.api#documentation": "

\n The minimum and maximum amount of memory, in MiB.\n

" - } - }, - "NetworkInterfaceCount": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsNetworkInterfaceCountDetails", - "traits": { - "smithy.api#documentation": "

\n The minimum and maximum number of network interfaces.\n

" - } - }, - "OnDemandMaxPricePercentageOverLowestPrice": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The price protection threshold for On-Demand Instances. This is the maximum you'll pay\n for an On-Demand Instance, expressed as a percentage above the least expensive current\n generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects\n instance types with your attributes, it excludes instance types priced above your\n threshold.

\n

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

\n

A high value, such as 999999, turns off price protection.

" - } - }, - "RequireHibernateSupport": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

\n Indicates whether instance types must support hibernation for On-Demand Instances.\n

" - } - }, - "SpotMaxPricePercentageOverLowestPrice": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The price protection threshold for Spot Instances. This is the maximum you'll pay for a\n Spot Instance, expressed as a percentage above the least expensive current generation M, C,\n or R instance type with your specified attributes. When Amazon EC2 selects instance\n types with your attributes, it excludes instance types priced above your threshold.

\n

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

\n

A high value, such as 999999, turns off price protection.

" - } - }, - "TotalLocalStorageGB": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsTotalLocalStorageGBDetails", - "traits": { - "smithy.api#documentation": "

\n The minimum and maximum amount of total local storage, in GB.\n

" - } - }, - "VCpuCount": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsVCpuCountDetails", - "traits": { - "smithy.api#documentation": "

\n The minimum and maximum number of vCPUs.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n The attributes for the Amazon EC2 instance types.\n

" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsMemoryGiBPerVCpuDetails": { - "type": "structure", - "members": { - "Max": { - "target": "com.amazonaws.securityhub#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The maximum amount of memory per vCPU, in GiB. If this parameter is omitted, there's no maximum limit.\n

" - } - }, - "Min": { - "target": "com.amazonaws.securityhub#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The minimum amount of memory per vCPU, in GiB. If this parameter is omitted, there's no maximum limit.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n The minimum and maximum amount of memory per vCPU, in GiB.\n

" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsMemoryMiBDetails": { - "type": "structure", - "members": { - "Max": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The maximum amount of memory, in MiB.\n

" - } - }, - "Min": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The minimum amount of memory, in MiB. \n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n The minimum and maximum amount of memory, in MiB, for an Amazon EC2 instance.\n

" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsNetworkInterfaceCountDetails": { - "type": "structure", - "members": { - "Max": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The maximum number of network interfaces. \n

" - } - }, - "Min": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The minimum number of network interfaces.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n The minimum and maximum number of network interfaces to be attached to an Amazon EC2 instance.\n

" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsTotalLocalStorageGBDetails": { - "type": "structure", - "members": { - "Max": { - "target": "com.amazonaws.securityhub#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The maximum amount of total local storage, in GB.\n

" - } - }, - "Min": { - "target": "com.amazonaws.securityhub#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The minimum amount of total local storage, in GB.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n The minimum and maximum amount of total local storage, in GB, that an Amazon EC2 instance uses.\n

" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsVCpuCountDetails": { - "type": "structure", - "members": { - "Max": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The maximum number of vCPUs. \n

" - } - }, - "Min": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The minimum number of vCPUs.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n The minimum and maximum number of vCPUs for an Amazon EC2 instance.\n

" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataLicenseSetDetails": { - "type": "structure", - "members": { - "LicenseConfigurationArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the license configuration.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Provides details about the license configuration for an Amazon EC2 instance.\n

" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataLicenseSetList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataLicenseSetDetails" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataMaintenanceOptionsDetails": { - "type": "structure", - "members": { - "AutoRecovery": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n Disables the automatic recovery behavior of your instance or sets it to default.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n The maintenance options of an Amazon EC2 instance.\n

" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataMetadataOptionsDetails": { - "type": "structure", - "members": { - "HttpEndpoint": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Enables or disables the HTTP metadata endpoint on your instances. If the parameter is\n not specified, the default state is enabled, and you won't be able to access your instance\n metadata.

" - } - }, - "HttpProtocolIpv6": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n Enables or disables the IPv6 endpoint for the instance metadata service.\n

" - } - }, - "HttpTokens": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The state of token usage for your instance metadata requests.\n

" - } - }, - "HttpPutResponseHopLimit": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The desired HTTP PUT response hop limit for instance metadata requests. The larger \n the number, the further instance metadata requests can travel.\n

" - } - }, - "InstanceMetadataTags": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n When set to enabled, this parameter allows access to instance tags from the instance metadata. When set to disabled, it turns off access to instance tags from the instance metadata. For more information, see \nWork with instance tags in instance metadata in the Amazon EC2 User Guide.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Specifies the metadata options for an Amazon EC2 instance.\n

" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataMonitoringDetails": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

\n Enables detailed monitoring when true is specified. Otherwise, basic monitoring is enabled. \n For more information about detailed monitoring, see \n Enable or turn off detailed monitoring for your instances in the Amazon EC2 User Guide. \n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n The monitoring for an Amazon EC2 instance.\n

" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails": { - "type": "structure", - "members": { - "AssociateCarrierIpAddress": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

\n Indicates whether to associate a Carrier IP address with eth0 for a new network interface. \n You use this option when you launch an instance in a Wavelength Zone and want to \n associate a Carrier IP address with the network interface. For more information, see \n Carrier IP address in the Wavelength Developer Guide.\n

" - } - }, - "AssociatePublicIpAddress": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

\n Associates a public IPv4 address with eth0 for a new network interface.\n

" - } - }, - "DeleteOnTermination": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

\n Indicates whether the network interface is deleted when the instance is terminated.\n

" - } - }, - "Description": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n A description for the network interface.\n

" - } - }, - "DeviceIndex": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The device index for the network interface attachment.\n

" - } - }, - "Groups": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

\n The IDs of one or more security groups.\n

" - } - }, - "InterfaceType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The type of network interface.\n

" - } - }, - "Ipv4PrefixCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The number of IPv4 prefixes to be automatically assigned to the network interface. \n You cannot use this option if you use the Ipv4Prefixes option.\n

" - } - }, - "Ipv4Prefixes": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv4PrefixesList", - "traits": { - "smithy.api#documentation": "

\n One or more IPv4 prefixes to be assigned to the network interface. You cannot use \n this option if you use the Ipv4PrefixCount option.\n

" - } - }, - "Ipv6AddressCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The number of IPv6 addresses to assign to a network interface. Amazon EC2 \n automatically selects the IPv6 addresses from the subnet range. You can't use this \n option if you use Ipv6Addresses.\n

" - } - }, - "Ipv6Addresses": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6AddressesList", - "traits": { - "smithy.api#documentation": "

\n One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. \n You can't use this option if you use Ipv6AddressCount.\n

" - } - }, - "Ipv6PrefixCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The number of IPv6 prefixes to be automatically assigned to the network interface. \n You cannot use this option if you use the Ipv6Prefix option.\n

" - } - }, - "Ipv6Prefixes": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6PrefixesList", - "traits": { - "smithy.api#documentation": "

\n One or more IPv6 prefixes to be assigned to the network interface. You cannot use \n this option if you use the Ipv6PrefixCount option.\n

" - } - }, - "NetworkCardIndex": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The index of the network card. Some instance types support multiple network cards. \n The primary network interface must be assigned to network card index 0. The default \n is network card index 0.\n

" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The ID of the network interface.\n

" - } - }, - "PrivateIpAddress": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The primary private IPv4 address of the network interface.\n

" - } - }, - "PrivateIpAddresses": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetPrivateIpAddressesList", - "traits": { - "smithy.api#documentation": "

\n One or more private IPv4 addresses.\n

" - } - }, - "SecondaryPrivateIpAddressCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The number of secondary private IPv4 addresses to assign to a network interface.\n

" - } - }, - "SubnetId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The ID of the subnet for the network interface.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n One or more network interfaces to attach to an Amazon EC2 instance. If you specify a network interface, you must specify \n security groups and subnets as part of the network interface.\n

" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv4PrefixesDetails": { - "type": "structure", - "members": { - "Ipv4Prefix": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The IPv4 prefix. For more information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Provides details on one or more IPv4 prefixes for a network interface. \n

" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv4PrefixesList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv4PrefixesDetails" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6AddressesDetails": { - "type": "structure", - "members": { - "Ipv6Address": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. \n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Specifies an IPv6 address in an Amazon EC2 launch template.\n

" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6AddressesList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6AddressesDetails" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6PrefixesDetails": { - "type": "structure", - "members": { - "Ipv6Prefix": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The IPv6 prefix.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Provides details on one or more IPv6 prefixes to be assigned to the network interface.\n

" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6PrefixesList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6PrefixesDetails" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetPrivateIpAddressesDetails": { - "type": "structure", - "members": { - "Primary": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

\n Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.\n

" - } - }, - "PrivateIpAddress": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The private IPv4 address.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n One or more private IPv4 addresses.\n

" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetPrivateIpAddressesList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetPrivateIpAddressesDetails" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataPlacementDetails": { - "type": "structure", - "members": { - "Affinity": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The affinity setting for an instance on an EC2 Dedicated Host.\n

" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The Availability Zone for the instance.\n

" - } - }, - "GroupName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The name of the placement group for the instance.\n

" - } - }, - "HostId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The ID of the Dedicated Host for the instance.\n

" - } - }, - "HostResourceGroupArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the host resource group in which to launch the instances. \n

" - } - }, - "PartitionNumber": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The number of the partition the instance should launch in.\n

" - } - }, - "SpreadDomain": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n Reserved for future use.\n

" - } - }, - "Tenancy": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n 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.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Provides details about the placement of an Amazon EC2 instance.\n

" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataPrivateDnsNameOptionsDetails": { - "type": "structure", - "members": { - "EnableResourceNameDnsAAAARecord": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

\n Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.\n

" - } - }, - "EnableResourceNameDnsARecord": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

\n Indicates whether to respond to DNS queries for instance hostnames with DNS A records.\n

" - } - }, - "HostnameType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The type of hostname for EC2 instances. \n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Describes the options for Amazon EC2 instance hostnames.\n

" - } - }, - "com.amazonaws.securityhub#AwsEc2LaunchTemplateDetails": { - "type": "structure", - "members": { - "LaunchTemplateName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n A name for the launch template.\n

" - } - }, - "Id": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n An ID for the launch template.\n

" - } - }, - "LaunchTemplateData": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataDetails", - "traits": { - "smithy.api#documentation": "

\n The information to include in the launch template.\n

" - } - }, - "DefaultVersionNumber": { - "target": "com.amazonaws.securityhub#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The default version of the launch template.\n

" - } - }, - "LatestVersionNumber": { - "target": "com.amazonaws.securityhub#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The latest version of the launch template.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Specifies the properties for creating an Amazon Elastic Compute Cloud (Amazon EC2) launch template.\n

" - } - }, - "com.amazonaws.securityhub#AwsEc2NetworkAclAssociation": { - "type": "structure", - "members": { - "NetworkAclAssociationId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the association between the network ACL and the subnet.

" - } - }, - "NetworkAclId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the network ACL.

" - } - }, - "SubnetId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the subnet that is associated with the network ACL.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An association between the network ACL and a subnet.

" - } - }, - "com.amazonaws.securityhub#AwsEc2NetworkAclAssociationList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEc2NetworkAclAssociation" - } - }, - "com.amazonaws.securityhub#AwsEc2NetworkAclDetails": { - "type": "structure", - "members": { - "IsDefault": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether this is the default network ACL for the VPC.

" - } - }, - "NetworkAclId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the network ACL.

" - } - }, - "OwnerId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Web Services account that owns the network ACL.

" - } - }, - "VpcId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the VPC for the network ACL.

" - } - }, - "Associations": { - "target": "com.amazonaws.securityhub#AwsEc2NetworkAclAssociationList", - "traits": { - "smithy.api#documentation": "

Associations between the network ACL and subnets.

" - } - }, - "Entries": { - "target": "com.amazonaws.securityhub#AwsEc2NetworkAclEntryList", - "traits": { - "smithy.api#documentation": "

The set of rules in the network ACL.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains details about an Amazon EC2 network access control list (ACL).

" - } - }, - "com.amazonaws.securityhub#AwsEc2NetworkAclEntry": { - "type": "structure", - "members": { - "CidrBlock": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The IPV4 network range for which to deny or allow access.

" - } - }, - "Egress": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the rule is an egress rule. An egress rule is a rule that applies to traffic that leaves the subnet.

" - } - }, - "IcmpTypeCode": { - "target": "com.amazonaws.securityhub#IcmpTypeCode", - "traits": { - "smithy.api#documentation": "

The Internet Control Message Protocol (ICMP) type and code for which to deny or allow access.

" - } - }, - "Ipv6CidrBlock": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The IPV6 network range for which to deny or allow access.

" - } - }, - "PortRange": { - "target": "com.amazonaws.securityhub#PortRangeFromTo", - "traits": { - "smithy.api#documentation": "

For TCP or UDP protocols, the range of ports that the rule applies to.

" - } - }, - "Protocol": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The protocol that the rule applies to. To deny or allow access to all protocols, use the\n value -1.

" - } - }, - "RuleAction": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Whether the rule is used to allow access or deny access.

" - } - }, - "RuleNumber": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The rule number. The rules are processed in order by their number.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A rule for the network ACL. Each rule allows or denies access based on the IP address, traffic direction, port, and protocol.

" - } - }, - "com.amazonaws.securityhub#AwsEc2NetworkAclEntryList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEc2NetworkAclEntry" - } - }, - "com.amazonaws.securityhub#AwsEc2NetworkInterfaceAttachment": { - "type": "structure", - "members": { - "AttachTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the attachment initiated.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "AttachmentId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the network interface attachment

" - } - }, - "DeleteOnTermination": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the network interface is deleted when the instance is\n terminated.

" - } - }, - "DeviceIndex": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The device index of the network interface attachment on the instance.

" - } - }, - "InstanceId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the instance.

" - } - }, - "InstanceOwnerId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the instance.

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The attachment state.

\n

Valid values: attaching | attached | detaching |\n detached\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the network interface attachment.

" - } - }, - "com.amazonaws.securityhub#AwsEc2NetworkInterfaceDetails": { - "type": "structure", - "members": { - "Attachment": { - "target": "com.amazonaws.securityhub#AwsEc2NetworkInterfaceAttachment", - "traits": { - "smithy.api#documentation": "

The network interface attachment.

" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the network interface.

" - } - }, - "SecurityGroups": { - "target": "com.amazonaws.securityhub#AwsEc2NetworkInterfaceSecurityGroupList", - "traits": { - "smithy.api#documentation": "

Security groups for the network interface.

" - } - }, - "SourceDestCheck": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether traffic to or from the instance is validated.

" - } - }, - "IpV6Addresses": { - "target": "com.amazonaws.securityhub#AwsEc2NetworkInterfaceIpV6AddressList", - "traits": { - "smithy.api#documentation": "

The IPv6 addresses associated with the network interface.

" - } - }, - "PrivateIpAddresses": { - "target": "com.amazonaws.securityhub#AwsEc2NetworkInterfacePrivateIpAddressList", - "traits": { - "smithy.api#documentation": "

The private IPv4 addresses associated with the network interface.

" - } - }, - "PublicDnsName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The public DNS name of the network interface.

" - } - }, - "PublicIp": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The address of the Elastic IP address bound to the network interface.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about the network interface

" - } - }, - "com.amazonaws.securityhub#AwsEc2NetworkInterfaceIpV6AddressDetail": { - "type": "structure", - "members": { - "IpV6Address": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The IPV6 address.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about an IPV6 address that is associated with the network\n interface.

" - } - }, - "com.amazonaws.securityhub#AwsEc2NetworkInterfaceIpV6AddressList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEc2NetworkInterfaceIpV6AddressDetail" - } - }, - "com.amazonaws.securityhub#AwsEc2NetworkInterfacePrivateIpAddressDetail": { - "type": "structure", - "members": { - "PrivateIpAddress": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The IP address.

" - } - }, - "PrivateDnsName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The private DNS name for the IP address.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about a private IPv4 address that is with the network\n interface.

" - } - }, - "com.amazonaws.securityhub#AwsEc2NetworkInterfacePrivateIpAddressList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEc2NetworkInterfacePrivateIpAddressDetail" - } - }, - "com.amazonaws.securityhub#AwsEc2NetworkInterfaceSecurityGroup": { - "type": "structure", - "members": { - "GroupName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the security group.

" - } - }, - "GroupId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the security group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A security group associated with the network interface.

" - } - }, - "com.amazonaws.securityhub#AwsEc2NetworkInterfaceSecurityGroupList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEc2NetworkInterfaceSecurityGroup" - } - }, - "com.amazonaws.securityhub#AwsEc2RouteTableDetails": { - "type": "structure", - "members": { - "AssociationSet": { - "target": "com.amazonaws.securityhub#AssociationSetList", - "traits": { - "smithy.api#documentation": "

\n The associations between a route table and one or more subnets or a gateway.\n

" - } - }, - "OwnerId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The ID of the Amazon Web Services account that owns the route table.\n

" - } - }, - "PropagatingVgwSet": { - "target": "com.amazonaws.securityhub#PropagatingVgwSetList", - "traits": { - "smithy.api#documentation": "

\n Describes a virtual private gateway propagating route.\n

" - } - }, - "RouteTableId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The ID of the route table.\n

" - } - }, - "RouteSet": { - "target": "com.amazonaws.securityhub#RouteSetList", - "traits": { - "smithy.api#documentation": "

\n The routes in the route table.\n

" - } - }, - "VpcId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The ID of the virtual private cloud (VPC).\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Provides details about a route table for the specified VPC. \n

" - } - }, - "com.amazonaws.securityhub#AwsEc2SecurityGroupDetails": { - "type": "structure", - "members": { - "GroupName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the security group.

" - } - }, - "GroupId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the security group.

" - } - }, - "OwnerId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the security group.

" - } - }, - "VpcId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

[VPC only] The ID of the VPC for the security group.

" - } - }, - "IpPermissions": { - "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupIpPermissionList", - "traits": { - "smithy.api#documentation": "

The inbound rules associated with the security group.

" - } - }, - "IpPermissionsEgress": { - "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupIpPermissionList", - "traits": { - "smithy.api#documentation": "

[VPC only] The outbound rules associated with the security group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about an Amazon EC2 security group.

" - } - }, - "com.amazonaws.securityhub#AwsEc2SecurityGroupIpPermission": { - "type": "structure", - "members": { - "IpProtocol": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The IP protocol name (tcp, udp, icmp,\n icmpv6) or number.

\n

[VPC only] Use -1 to specify all protocols.

\n

When authorizing security group rules, specifying -1\n or a protocol number other than tcp, udp, icmp, or\n icmpv6 allows traffic on all ports, regardless of any port range you\n specify.

\n

For tcp, udp, and icmp, you must specify a port\n range.

\n

For icmpv6, the port range is optional. If you omit the port range, traffic\n for all types and codes is allowed.

" - } - }, - "FromPort": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type\n number.

\n

A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you\n must specify all codes.

" - } - }, - "ToPort": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.

\n

A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all\n codes.

" - } - }, - "UserIdGroupPairs": { - "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupUserIdGroupPairList", - "traits": { - "smithy.api#documentation": "

The security group and Amazon Web Services account ID pairs.

" - } - }, - "IpRanges": { - "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupIpRangeList", - "traits": { - "smithy.api#documentation": "

The IPv4 ranges.

" - } - }, - "Ipv6Ranges": { - "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupIpv6RangeList", - "traits": { - "smithy.api#documentation": "

The IPv6 ranges.

" - } - }, - "PrefixListIds": { - "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupPrefixListIdList", - "traits": { - "smithy.api#documentation": "

[VPC only] The prefix list IDs for an Amazon Web Services service. With outbound rules, this is the Amazon Web Services\n service to access through a VPC endpoint from instances associated with the security\n group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An IP permission for an EC2 security group.

" - } - }, - "com.amazonaws.securityhub#AwsEc2SecurityGroupIpPermissionList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupIpPermission" - } - }, - "com.amazonaws.securityhub#AwsEc2SecurityGroupIpRange": { - "type": "structure", - "members": { - "CidrIp": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The IPv4 CIDR range. You can specify either a CIDR range or a source security group, but\n not both. To specify a single IPv4 address, use the /32 prefix length.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A range of IPv4 addresses.

" - } - }, - "com.amazonaws.securityhub#AwsEc2SecurityGroupIpRangeList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupIpRange" - } - }, - "com.amazonaws.securityhub#AwsEc2SecurityGroupIpv6Range": { - "type": "structure", - "members": { - "CidrIpv6": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The IPv6 CIDR range. You can specify either a CIDR range or a source security group, but\n not both. To specify a single IPv6 address, use the /128 prefix length.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A range of IPv6 addresses.

" - } - }, - "com.amazonaws.securityhub#AwsEc2SecurityGroupIpv6RangeList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupIpv6Range" - } - }, - "com.amazonaws.securityhub#AwsEc2SecurityGroupPrefixListId": { - "type": "structure", - "members": { - "PrefixListId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the prefix.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A prefix list ID.

" - } - }, - "com.amazonaws.securityhub#AwsEc2SecurityGroupPrefixListIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupPrefixListId" - } - }, - "com.amazonaws.securityhub#AwsEc2SecurityGroupUserIdGroupPair": { - "type": "structure", - "members": { - "GroupId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the security group.

" - } - }, - "GroupName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the security group.

" - } - }, - "PeeringStatus": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The status of a VPC peering connection, if applicable.

" - } - }, - "UserId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of an Amazon Web Services account.

\n

For a referenced security group in another VPC, the account ID of the referenced\n security group is returned in the response. If the referenced security group is deleted,\n this value is not returned.

\n

[EC2-Classic] Required when adding or removing rules that reference a security group in\n another VPC.

" - } - }, - "VpcId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the VPC for the referenced security group, if applicable.

" - } - }, - "VpcPeeringConnectionId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the VPC peering connection, if applicable.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A relationship between a security group and a user.

" - } - }, - "com.amazonaws.securityhub#AwsEc2SecurityGroupUserIdGroupPairList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupUserIdGroupPair" - } - }, - "com.amazonaws.securityhub#AwsEc2SubnetDetails": { - "type": "structure", - "members": { - "AssignIpv6AddressOnCreation": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether to assign an IPV6 address to a network interface that is created in this subnet.

" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Availability Zone for the subnet.

" - } - }, - "AvailabilityZoneId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the Availability Zone for the subnet.

" - } - }, - "AvailableIpAddressCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of available IPV4 addresses in the subnet. Does not include addresses for stopped instances.

" - } - }, - "CidrBlock": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The IPV4 CIDR block that is assigned to the subnet.

" - } - }, - "DefaultForAz": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether this subnet is the default subnet for the Availability Zone.

" - } - }, - "MapPublicIpOnLaunch": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether instances in this subnet receive a public IP address.

" - } - }, - "OwnerId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Web Services account that owns the subnet.

" - } - }, - "State": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The current state of the subnet. Valid values are available or pending.

" - } - }, - "SubnetArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the subnet.

" - } - }, - "SubnetId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the subnet.

" - } - }, - "VpcId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the VPC that contains the subnet.

" - } - }, - "Ipv6CidrBlockAssociationSet": { - "target": "com.amazonaws.securityhub#Ipv6CidrBlockAssociationList", - "traits": { - "smithy.api#documentation": "

The IPV6 CIDR blocks that are associated with the subnet.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about a subnet in Amazon EC2.

" - } - }, - "com.amazonaws.securityhub#AwsEc2TransitGatewayDetails": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the transit gateway.\n

" - } - }, - "Description": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The description of the transit gateway.\n

" - } - }, - "DefaultRouteTablePropagation": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Turn on or turn off automatic propagation of routes to the default propagation route table.\n

" - } - }, - "AutoAcceptSharedAttachments": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Turn on or turn off automatic acceptance of attachment requests.\n

" - } - }, - "DefaultRouteTableAssociation": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Turn on or turn off automatic association with the default association route table.\n

" - } - }, - "TransitGatewayCidrBlocks": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The transit gateway Classless Inter-Domain Routing (CIDR) blocks.\n

" - } - }, - "AssociationDefaultRouteTableId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the default association route table.\n

" - } - }, - "PropagationDefaultRouteTableId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the default propagation route table.\n

" - } - }, - "VpnEcmpSupport": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Turn on or turn off Equal Cost Multipath Protocol (ECMP) support. \n

" - } - }, - "DnsSupport": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Turn on or turn off DNS support. \n

" - } - }, - "MulticastSupport": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates whether multicast is supported on the transit gateway. \n

" - } - }, - "AmazonSideAsn": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

A private Autonomous System Number (ASN) for the Amazon side of a BGP session. \n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about an Amazon Web Services Amazon EC2 Transit Gateway that interconnects \nvirtual private clouds (VPCs) and on-premises networks.\n

" - } - }, - "com.amazonaws.securityhub#AwsEc2VolumeAttachment": { - "type": "structure", - "members": { - "AttachTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The datetime when the attachment initiated.

" - } - }, - "DeleteOnTermination": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the EBS volume is deleted when the EC2 instance is terminated.

" - } - }, - "InstanceId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the EC2 instance.

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The attachment state of the volume. Valid values are as follows:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

An attachment to an Amazon EC2 volume.

" - } - }, - "com.amazonaws.securityhub#AwsEc2VolumeAttachmentList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEc2VolumeAttachment" - } - }, - "com.amazonaws.securityhub#AwsEc2VolumeDetails": { - "type": "structure", - "members": { - "CreateTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the volume was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "DeviceName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The device name for the volume that is attached to the instance.\n

" - } - }, - "Encrypted": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether the volume is encrypted.

" - } - }, - "Size": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The size of the volume, in GiBs.

" - } - }, - "SnapshotId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The snapshot from which the volume was created.

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The volume state. Valid values are as follows:

\n " - } - }, - "KmsKeyId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the KMS key that was\n used to protect the volume encryption key for the volume.

" - } - }, - "Attachments": { - "target": "com.amazonaws.securityhub#AwsEc2VolumeAttachmentList", - "traits": { - "smithy.api#documentation": "

The volume attachments.

" - } - }, - "VolumeId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the volume.\n

" - } - }, - "VolumeType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The volume type.\n

" - } - }, - "VolumeScanStatus": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates whether the volume was scanned or skipped.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about an EC2 volume.

" - } - }, - "com.amazonaws.securityhub#AwsEc2VpcDetails": { - "type": "structure", - "members": { - "CidrBlockAssociationSet": { - "target": "com.amazonaws.securityhub#CidrBlockAssociationList", - "traits": { - "smithy.api#documentation": "

Information about the IPv4 CIDR blocks associated with the VPC.

" - } - }, - "Ipv6CidrBlockAssociationSet": { - "target": "com.amazonaws.securityhub#Ipv6CidrBlockAssociationList", - "traits": { - "smithy.api#documentation": "

Information about the IPv6 CIDR blocks associated with the VPC.

" - } - }, - "DhcpOptionsId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the set of Dynamic Host Configuration Protocol (DHCP) options that are\n associated with the VPC. If the default options are associated with the VPC, then this is\n default.

" - } - }, - "State": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The current state of the VPC. Valid values are available or pending.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about an EC2 VPC.

" - } - }, - "com.amazonaws.securityhub#AwsEc2VpcEndpointServiceDetails": { - "type": "structure", - "members": { - "AcceptanceRequired": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether requests from other Amazon Web Services accounts to create an endpoint to the service must first be accepted.

" - } - }, - "AvailabilityZones": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The Availability Zones where the service is available.

" - } - }, - "BaseEndpointDnsNames": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The DNS names for the service.

" - } - }, - "ManagesVpcEndpoints": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the service manages its VPC endpoints.

" - } - }, - "GatewayLoadBalancerArns": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The ARNs of the Gateway Load Balancers for the service.

" - } - }, - "NetworkLoadBalancerArns": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The ARNs of the Network Load Balancers for the service.

" - } - }, - "PrivateDnsName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The private DNS name for the service.

" - } - }, - "ServiceId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the service.

" - } - }, - "ServiceName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the service.

" - } - }, - "ServiceState": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The current state of the service. Valid values are as follows:

\n " - } - }, - "ServiceType": { - "target": "com.amazonaws.securityhub#AwsEc2VpcEndpointServiceServiceTypeList", - "traits": { - "smithy.api#documentation": "

The types for the service.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains details about the service configuration for a VPC endpoint service.

" - } - }, - "com.amazonaws.securityhub#AwsEc2VpcEndpointServiceServiceTypeDetails": { - "type": "structure", - "members": { - "ServiceType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of service.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The service type information for a VPC endpoint service.

" - } - }, - "com.amazonaws.securityhub#AwsEc2VpcEndpointServiceServiceTypeList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEc2VpcEndpointServiceServiceTypeDetails" - } - }, - "com.amazonaws.securityhub#AwsEc2VpcPeeringConnectionDetails": { - "type": "structure", - "members": { - "AccepterVpcInfo": { - "target": "com.amazonaws.securityhub#AwsEc2VpcPeeringConnectionVpcInfoDetails", - "traits": { - "smithy.api#documentation": "

Information about the accepter VPC.\n

" - } - }, - "ExpirationTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The time at which an unaccepted VPC peering connection will expire.\n

" - } - }, - "RequesterVpcInfo": { - "target": "com.amazonaws.securityhub#AwsEc2VpcPeeringConnectionVpcInfoDetails", - "traits": { - "smithy.api#documentation": "

Information about the requester VPC. \n

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#AwsEc2VpcPeeringConnectionStatusDetails", - "traits": { - "smithy.api#documentation": "

The status of the VPC peering connection.\n

" - } - }, - "VpcPeeringConnectionId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the VPC peering connection.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about a VPC peering connection between two VPCs: a requester VPC that you own and an \naccepter VPC with which to create the connection. \n

" - } - }, - "com.amazonaws.securityhub#AwsEc2VpcPeeringConnectionStatusDetails": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The status of the VPC peering connection.\n

" - } - }, - "Message": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A message that provides more information about the status, if applicable.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about the status of the VPC peering connection.\n

" - } - }, - "com.amazonaws.securityhub#AwsEc2VpcPeeringConnectionVpcInfoDetails": { - "type": "structure", - "members": { - "CidrBlock": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The IPv4 CIDR block for the VPC.\n

" - } - }, - "CidrBlockSet": { - "target": "com.amazonaws.securityhub#VpcInfoCidrBlockSetList", - "traits": { - "smithy.api#documentation": "

Information about the IPv4 CIDR blocks for the VPC.\n

" - } - }, - "Ipv6CidrBlockSet": { - "target": "com.amazonaws.securityhub#VpcInfoIpv6CidrBlockSetList", - "traits": { - "smithy.api#documentation": "

The IPv6 CIDR block for the VPC.\n

" - } - }, - "OwnerId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the VPC.\n

" - } - }, - "PeeringOptions": { - "target": "com.amazonaws.securityhub#VpcInfoPeeringOptionsDetails", - "traits": { - "smithy.api#documentation": "

Information about the VPC peering connection options for the accepter or requester VPC.\n

" - } - }, - "Region": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region in which the VPC is located.\n

" - } - }, - "VpcId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the VPC.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a VPC in a VPC peering connection.\n

" - } - }, - "com.amazonaws.securityhub#AwsEc2VpnConnectionDetails": { - "type": "structure", - "members": { - "VpnConnectionId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the VPN connection.

" - } - }, - "State": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The current state of the VPN connection. Valid values are as follows:

\n " - } - }, - "CustomerGatewayId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the customer gateway that is at your end of the VPN connection.

" - } - }, - "CustomerGatewayConfiguration": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The configuration information for the VPN connection's customer gateway, in the native XML\n format.

" - } - }, - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of VPN connection.

" - } - }, - "VpnGatewayId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the virtual private gateway that is at the Amazon Web Services side of the VPN\n connection.

" - } - }, - "Category": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The category of the VPN connection. VPN indicates an Amazon Web Services VPN connection. VPN-Classic\n indicates an Amazon Web Services Classic VPN connection.

" - } - }, - "VgwTelemetry": { - "target": "com.amazonaws.securityhub#AwsEc2VpnConnectionVgwTelemetryList", - "traits": { - "smithy.api#documentation": "

Information about the VPN tunnel.

" - } - }, - "Options": { - "target": "com.amazonaws.securityhub#AwsEc2VpnConnectionOptionsDetails", - "traits": { - "smithy.api#documentation": "

The VPN connection options.

" - } - }, - "Routes": { - "target": "com.amazonaws.securityhub#AwsEc2VpnConnectionRoutesList", - "traits": { - "smithy.api#documentation": "

The static routes that are associated with the VPN connection.

" - } - }, - "TransitGatewayId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the transit gateway that is associated with the VPN connection.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about an Amazon EC2 VPN\n connection.

" - } - }, - "com.amazonaws.securityhub#AwsEc2VpnConnectionOptionsDetails": { - "type": "structure", - "members": { - "StaticRoutesOnly": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the VPN connection uses static routes only.

" - } - }, - "TunnelOptions": { - "target": "com.amazonaws.securityhub#AwsEc2VpnConnectionOptionsTunnelOptionsList", - "traits": { - "smithy.api#documentation": "

The VPN tunnel options.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

VPN connection options.

" - } - }, - "com.amazonaws.securityhub#AwsEc2VpnConnectionOptionsTunnelOptionsDetails": { - "type": "structure", - "members": { - "DpdTimeoutSeconds": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of seconds after which a Dead Peer Detection (DPD) timeout occurs.

" - } - }, - "IkeVersions": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The Internet Key Exchange (IKE) versions that are permitted for the VPN tunnel.

" - } - }, - "OutsideIpAddress": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The external IP address of the VPN tunnel.

" - } - }, - "Phase1DhGroupNumbers": { - "target": "com.amazonaws.securityhub#IntegerList", - "traits": { - "smithy.api#documentation": "

The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE\n negotiations.

" - } - }, - "Phase1EncryptionAlgorithms": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The permitted encryption algorithms for the VPN tunnel for phase 1 IKE\n negotiations.

" - } - }, - "Phase1IntegrityAlgorithms": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The permitted integrity algorithms for the VPN tunnel for phase 1 IKE\n negotiations.

" - } - }, - "Phase1LifetimeSeconds": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The lifetime for phase 1 of the IKE negotiation, in seconds.

" - } - }, - "Phase2DhGroupNumbers": { - "target": "com.amazonaws.securityhub#IntegerList", - "traits": { - "smithy.api#documentation": "

The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE\n negotiations.

" - } - }, - "Phase2EncryptionAlgorithms": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The permitted encryption algorithms for the VPN tunnel for phase 2 IKE\n negotiations.

" - } - }, - "Phase2IntegrityAlgorithms": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The permitted integrity algorithms for the VPN tunnel for phase 2 IKE\n negotiations.

" - } - }, - "Phase2LifetimeSeconds": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The lifetime for phase 2 of the IKE negotiation, in seconds.

" - } - }, - "PreSharedKey": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The preshared key to establish initial authentication between the virtual private gateway\n and the customer gateway.

" - } - }, - "RekeyFuzzPercentage": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The percentage of the rekey window, which is determined by\n RekeyMarginTimeSeconds during which the rekey time is randomly selected.

" - } - }, - "RekeyMarginTimeSeconds": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The margin time, in seconds, before the phase 2 lifetime expires, during which the Amazon Web Services\n side of the VPN connection performs an IKE rekey.

" - } - }, - "ReplayWindowSize": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of packets in an IKE replay window.

" - } - }, - "TunnelInsideCidr": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The range of inside IPv4 addresses for the tunnel.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The VPN tunnel options.

" - } - }, - "com.amazonaws.securityhub#AwsEc2VpnConnectionOptionsTunnelOptionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEc2VpnConnectionOptionsTunnelOptionsDetails" - } - }, - "com.amazonaws.securityhub#AwsEc2VpnConnectionRoutesDetails": { - "type": "structure", - "members": { - "DestinationCidrBlock": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The CIDR block associated with the local subnet of the customer data center.

" - } - }, - "State": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The current state of the static route.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A static routes associated with\n the VPN connection.

" - } - }, - "com.amazonaws.securityhub#AwsEc2VpnConnectionRoutesList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEc2VpnConnectionRoutesDetails" - } - }, - "com.amazonaws.securityhub#AwsEc2VpnConnectionVgwTelemetryDetails": { - "type": "structure", - "members": { - "AcceptedRouteCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of accepted routes.

" - } - }, - "CertificateArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the VPN tunnel endpoint certificate.

" - } - }, - "LastStatusChange": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The date and time of the last change in status.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "OutsideIpAddress": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Internet-routable IP address of the virtual private gateway's outside\n interface.

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The status of the VPN tunnel. Valid values are DOWN or UP.

" - } - }, - "StatusMessage": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

If an error occurs, a description of the error.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the VPN tunnel.

" - } - }, - "com.amazonaws.securityhub#AwsEc2VpnConnectionVgwTelemetryList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEc2VpnConnectionVgwTelemetryDetails" - } - }, - "com.amazonaws.securityhub#AwsEcrContainerImageDetails": { - "type": "structure", - "members": { - "RegistryId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account identifier that is associated with the registry that the image belongs\n to.

" - } - }, - "RepositoryName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the repository that the image belongs to.

" - } - }, - "Architecture": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The architecture of the image. Valid values are as follows:

\n " - } - }, - "ImageDigest": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The sha256 digest of the image manifest.

" - } - }, - "ImageTags": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The list of tags that are associated with the image.

" - } - }, - "ImagePublishedAt": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The date and time when the image was pushed to the repository.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about an Amazon ECR image.

" - } - }, - "com.amazonaws.securityhub#AwsEcrRepositoryDetails": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the repository.

" - } - }, - "ImageScanningConfiguration": { - "target": "com.amazonaws.securityhub#AwsEcrRepositoryImageScanningConfigurationDetails", - "traits": { - "smithy.api#documentation": "

The image scanning configuration for a repository.

" - } - }, - "ImageTagMutability": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The tag mutability setting for the repository. Valid values are IMMUTABLE or MUTABLE.

" - } - }, - "LifecyclePolicy": { - "target": "com.amazonaws.securityhub#AwsEcrRepositoryLifecyclePolicyDetails", - "traits": { - "smithy.api#documentation": "

Information about the lifecycle policy for the repository.

" - } - }, - "RepositoryName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the repository.

" - } - }, - "RepositoryPolicyText": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The text of the repository policy.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about an Amazon Elastic Container Registry repository.

" - } - }, - "com.amazonaws.securityhub#AwsEcrRepositoryImageScanningConfigurationDetails": { - "type": "structure", - "members": { - "ScanOnPush": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether to scan images after they are pushed to a repository.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The image scanning configuration for a repository.

" - } - }, - "com.amazonaws.securityhub#AwsEcrRepositoryLifecyclePolicyDetails": { - "type": "structure", - "members": { - "LifecyclePolicyText": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The text of the lifecycle policy.

" - } - }, - "RegistryId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account identifier that is associated with the registry that contains the repository.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the lifecycle policy for the repository.

" - } - }, - "com.amazonaws.securityhub#AwsEcsClusterClusterSettingsDetails": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the setting. The valid value is containerInsights.

" - } - }, - "Value": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The value of the setting. Valid values are disabled or enabled.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Indicates whether to enable CloudWatch Container Insights for the ECS cluster.

" - } - }, - "com.amazonaws.securityhub#AwsEcsClusterClusterSettingsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEcsClusterClusterSettingsDetails" - } - }, - "com.amazonaws.securityhub#AwsEcsClusterConfigurationDetails": { - "type": "structure", - "members": { - "ExecuteCommandConfiguration": { - "target": "com.amazonaws.securityhub#AwsEcsClusterConfigurationExecuteCommandConfigurationDetails", - "traits": { - "smithy.api#documentation": "

Contains the run command configuration for the cluster.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The run command configuration for the cluster.

" - } - }, - "com.amazonaws.securityhub#AwsEcsClusterConfigurationExecuteCommandConfigurationDetails": { - "type": "structure", - "members": { - "KmsKeyId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the KMS key that is used to encrypt the data between the local client and the container.

" - } - }, - "LogConfiguration": { - "target": "com.amazonaws.securityhub#AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails", - "traits": { - "smithy.api#documentation": "

The log configuration for the results of the run command actions. Required if Logging is NONE.

" - } - }, - "Logging": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The log setting to use for redirecting logs for run command results.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the run command configuration for the cluster.

" - } - }, - "com.amazonaws.securityhub#AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails": { - "type": "structure", - "members": { - "CloudWatchEncryptionEnabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether to enable encryption on the CloudWatch logs.

" - } - }, - "CloudWatchLogGroupName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the CloudWatch log group to send the logs to.

" - } - }, - "S3BucketName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the S3 bucket to send logs to.

" - } - }, - "S3EncryptionEnabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether to encrypt the logs that are sent to the S3 bucket.

" - } - }, - "S3KeyPrefix": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Identifies the folder in the S3 bucket to send the logs to.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The log configuration for the results of the run command actions.

" - } - }, - "com.amazonaws.securityhub#AwsEcsClusterDefaultCapacityProviderStrategyDetails": { - "type": "structure", - "members": { - "Base": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum number of tasks to run on the specified capacity provider.

" - } - }, - "CapacityProvider": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the capacity provider.

" - } - }, - "Weight": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The relative percentage of the total number of tasks launched that should use the capacity provider.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The default capacity provider strategy for the cluster. The default capacity provider strategy is used when services or tasks are run without a specified launch type or capacity provider strategy.

" - } - }, - "com.amazonaws.securityhub#AwsEcsClusterDefaultCapacityProviderStrategyList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEcsClusterDefaultCapacityProviderStrategyDetails" - } - }, - "com.amazonaws.securityhub#AwsEcsClusterDetails": { - "type": "structure", - "members": { - "ClusterArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the cluster.\n

" - } - }, - "ActiveServicesCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of services that are running on the cluster in an ACTIVE state. You can view these services with the Amazon ECS \n ListServices\n API operation.\n

" - } - }, - "CapacityProviders": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The short name of one or more capacity providers to associate with the cluster.

" - } - }, - "ClusterSettings": { - "target": "com.amazonaws.securityhub#AwsEcsClusterClusterSettingsList", - "traits": { - "smithy.api#documentation": "

The setting to use to create the cluster. Specifically used to configure whether to enable CloudWatch Container Insights for the cluster.

" - } - }, - "Configuration": { - "target": "com.amazonaws.securityhub#AwsEcsClusterConfigurationDetails", - "traits": { - "smithy.api#documentation": "

The run command configuration for the cluster.

" - } - }, - "DefaultCapacityProviderStrategy": { - "target": "com.amazonaws.securityhub#AwsEcsClusterDefaultCapacityProviderStrategyList", - "traits": { - "smithy.api#documentation": "

The default capacity provider strategy for the cluster. The default capacity provider strategy is used when services or tasks are run without a specified launch type or capacity provider strategy.

" - } - }, - "ClusterName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A name that you use to identify your cluster. \n

" - } - }, - "RegisteredContainerInstancesCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.\n

" - } - }, - "RunningTasksCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of tasks in the cluster that are in the RUNNING state.\n

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The status of the cluster. \n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides details about an Amazon ECS cluster.

" - } - }, - "com.amazonaws.securityhub#AwsEcsContainerDetails": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the container.\n

" - } - }, - "Image": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The image used for the container.\n

" - } - }, - "MountPoints": { - "target": "com.amazonaws.securityhub#AwsMountPointList", - "traits": { - "smithy.api#documentation": "

The mount points for data volumes in your container.\n

" - } - }, - "Privileged": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

When this parameter is true, the container is given elevated privileges on the host container instance \n(similar to the root user). \n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about an Amazon ECS container.\n

" - } - }, - "com.amazonaws.securityhub#AwsEcsContainerDetailsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEcsContainerDetails" - } - }, - "com.amazonaws.securityhub#AwsEcsServiceCapacityProviderStrategyDetails": { - "type": "structure", - "members": { - "Base": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum number of tasks to run on the capacity provider. Only one strategy item can specify a value for Base.

\n

The value must be between 0 and 100000.

" - } - }, - "CapacityProvider": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The short name of the capacity provider.

" - } - }, - "Weight": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The relative percentage of the total number of tasks that should use the capacity provider.

\n

If no weight is specified, the default value is 0. At least one capacity provider must have a weight greater than 0.

\n

The value can be between 0 and 1000.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Strategy item for the capacity provider strategy that the service uses.

" - } - }, - "com.amazonaws.securityhub#AwsEcsServiceCapacityProviderStrategyList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEcsServiceCapacityProviderStrategyDetails" - } - }, - "com.amazonaws.securityhub#AwsEcsServiceDeploymentConfigurationDeploymentCircuitBreakerDetails": { - "type": "structure", - "members": { - "Enable": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether to enable the deployment circuit breaker logic for the service.

" - } - }, - "Rollback": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether to roll back the service if a service deployment fails. If rollback is enabled, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Determines whether a service deployment fails if a service cannot reach a steady state.

" - } - }, - "com.amazonaws.securityhub#AwsEcsServiceDeploymentConfigurationDetails": { - "type": "structure", - "members": { - "DeploymentCircuitBreaker": { - "target": "com.amazonaws.securityhub#AwsEcsServiceDeploymentConfigurationDeploymentCircuitBreakerDetails", - "traits": { - "smithy.api#documentation": "

Determines whether a service deployment fails if a service cannot reach a steady state.

" - } - }, - "MaximumPercent": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

For a service that uses the rolling update (ECS) deployment type, the maximum number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment, and for tasks that use the EC2 launch type, when any container instances are in the DRAINING state. Provided as a percentage of the desired number of tasks. The default value is 200%.

\n

For a service that uses the blue/green (CODE_DEPLOY) or EXTERNAL deployment types, and tasks that use the EC2 launch type, the maximum number of tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state.

\n

For the Fargate launch type, the maximum percent value is not used.

" - } - }, - "MinimumHealthyPercent": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

For a service that uses the rolling update (ECS) deployment type, the minimum number of tasks in a service that must remain in the RUNNING state during a deployment, and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Expressed as a percentage of the desired number of tasks. The default value is 100%.

\n

For a service that uses the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and tasks that use the EC2 launch type, the minimum number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state.

\n

For the Fargate launch type, the minimum healthy percent value is not used.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Optional deployment parameters for the service.

" - } - }, - "com.amazonaws.securityhub#AwsEcsServiceDeploymentControllerDetails": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The rolling update (ECS) deployment type replaces the current running version of the container with the latest version.

\n

The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model that is powered by CodeDeploy. This deployment model a new deployment of a service can be verified before production traffic is sent to it.

\n

The external (EXTERNAL) deployment type allows the use of any third-party deployment controller for full control over the deployment process for an Amazon ECS service.

\n

Valid values: ECS | CODE_DEPLOY | EXTERNAL\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the deployment controller type that the service uses.

" - } - }, - "com.amazonaws.securityhub#AwsEcsServiceDetails": { - "type": "structure", - "members": { - "CapacityProviderStrategy": { - "target": "com.amazonaws.securityhub#AwsEcsServiceCapacityProviderStrategyList", - "traits": { - "smithy.api#documentation": "

The capacity provider strategy that the service uses.

" - } - }, - "Cluster": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the cluster that hosts the service.

" - } - }, - "DeploymentConfiguration": { - "target": "com.amazonaws.securityhub#AwsEcsServiceDeploymentConfigurationDetails", - "traits": { - "smithy.api#documentation": "

Deployment parameters for the service. Includes the number of tasks that run and the order in which to start and stop tasks.

" - } - }, - "DeploymentController": { - "target": "com.amazonaws.securityhub#AwsEcsServiceDeploymentControllerDetails", - "traits": { - "smithy.api#documentation": "

Contains the deployment controller type that the service uses.

" - } - }, - "DesiredCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of instantiations of the task definition to run on the service.

" - } - }, - "EnableEcsManagedTags": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether to enable Amazon ECS managed tags for the tasks in the service.

" - } - }, - "EnableExecuteCommand": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the execute command functionality is enabled for the service.

" - } - }, - "HealthCheckGracePeriodSeconds": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

After a task starts, the amount of time in seconds that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks.

" - } - }, - "LaunchType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The launch type that the service uses.

\n

Valid values: EC2 | FARGATE | EXTERNAL\n

" - } - }, - "LoadBalancers": { - "target": "com.amazonaws.securityhub#AwsEcsServiceLoadBalancersList", - "traits": { - "smithy.api#documentation": "

Information about the load balancers that the service uses.

" - } - }, - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the service.

" - } - }, - "NetworkConfiguration": { - "target": "com.amazonaws.securityhub#AwsEcsServiceNetworkConfigurationDetails", - "traits": { - "smithy.api#documentation": "

For tasks that use the awsvpc networking mode, the VPC subnet and security group configuration.

" - } - }, - "PlacementConstraints": { - "target": "com.amazonaws.securityhub#AwsEcsServicePlacementConstraintsList", - "traits": { - "smithy.api#documentation": "

The placement constraints for the tasks in the service.

" - } - }, - "PlacementStrategies": { - "target": "com.amazonaws.securityhub#AwsEcsServicePlacementStrategiesList", - "traits": { - "smithy.api#documentation": "

Information about how tasks for the service are placed.

" - } - }, - "PlatformVersion": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The platform version on which to run the service. Only specified for tasks that are hosted on Fargate. If a platform version is not specified, the LATEST platform version is used by default.

" - } - }, - "PropagateTags": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates whether to propagate the tags from the task definition to the task or from the service to the task. If no value is provided, then tags are not propagated.

\n

Valid values: TASK_DEFINITION | SERVICE\n

" - } - }, - "Role": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the IAM role that is associated with the service. The role allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.

" - } - }, - "SchedulingStrategy": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The scheduling strategy to use for the service.

\n

The REPLICA scheduling strategy places and maintains the desired number of tasks across the cluster. By default, the service scheduler spreads tasks across Availability Zones. Task placement strategies and constraints are used to customize task placement decisions.

\n

The DAEMON scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that are specified in the cluster. The service scheduler also evaluates the task placement constraints for running tasks and stops tasks that do not meet the placement constraints.

\n

Valid values: REPLICA | DAEMON\n

" - } - }, - "ServiceArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the service.

" - } - }, - "ServiceName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the service.

\n

The name can contain up to 255 characters. It can use letters, numbers, underscores, and hyphens.

" - } - }, - "ServiceRegistries": { - "target": "com.amazonaws.securityhub#AwsEcsServiceServiceRegistriesList", - "traits": { - "smithy.api#documentation": "

Information about the service discovery registries to assign to the service.

" - } - }, - "TaskDefinition": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The task definition to use for tasks in the service.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides details about a service within an ECS cluster.

" - } - }, - "com.amazonaws.securityhub#AwsEcsServiceLoadBalancersDetails": { - "type": "structure", - "members": { - "ContainerName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the container to associate with the load balancer.

" - } - }, - "ContainerPort": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#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.

" - } - }, - "LoadBalancerName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the load balancer to associate with the Amazon ECS service or task set.

\n

Only specified when using a Classic Load Balancer. For an Application Load Balancer or a Network Load Balancer, the load balancer name is omitted.

" - } - }, - "TargetGroupArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the Elastic Load Balancing target group or groups associated with a service or task set.

\n

Only specified when using an Application Load Balancer or a Network Load Balancer. For a Classic Load Balancer, the target group ARN is omitted.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a load balancer that the service uses.

" - } - }, - "com.amazonaws.securityhub#AwsEcsServiceLoadBalancersList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEcsServiceLoadBalancersDetails" - } - }, - "com.amazonaws.securityhub#AwsEcsServiceNetworkConfigurationAwsVpcConfigurationDetails": { - "type": "structure", - "members": { - "AssignPublicIp": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Whether the task's elastic network interface receives a public IP address. The default value is DISABLED.

\n

Valid values: ENABLED | DISABLED\n

" - } - }, - "SecurityGroups": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The IDs of the security groups associated with the task or service.

\n

You can provide up to five security groups.

" - } - }, - "Subnets": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The IDs of the subnets associated with the task or service.

\n

You can provide up to 16 subnets.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

For tasks that use the awsvpc networking mode, the VPC subnet and security group configuration.

" - } - }, - "com.amazonaws.securityhub#AwsEcsServiceNetworkConfigurationDetails": { - "type": "structure", - "members": { - "AwsVpcConfiguration": { - "target": "com.amazonaws.securityhub#AwsEcsServiceNetworkConfigurationAwsVpcConfigurationDetails", - "traits": { - "smithy.api#documentation": "

The VPC subnet and security group configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

For tasks that use the awsvpc networking mode, the VPC subnet and security group configuration.

" - } - }, - "com.amazonaws.securityhub#AwsEcsServicePlacementConstraintsDetails": { - "type": "structure", - "members": { - "Expression": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance.

" - } - }, - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of constraint. Use distinctInstance to run each task in a particular group on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.

\n

Valid values: distinctInstance | memberOf\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A placement constraint for the tasks in the service.

" - } - }, - "com.amazonaws.securityhub#AwsEcsServicePlacementConstraintsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEcsServicePlacementConstraintsDetails" - } - }, - "com.amazonaws.securityhub#AwsEcsServicePlacementStrategiesDetails": { - "type": "structure", - "members": { - "Field": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The field to apply the placement strategy against.

\n

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.

\n

For the binpack placement strategy, valid values are cpu and memory.

\n

For the random placement strategy, this attribute is not used.

" - } - }, - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of placement strategy.

\n

The random placement strategy randomly places tasks on available candidates.

\n

The spread placement strategy spreads placement across available candidates evenly based on the value of Field.

\n

The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified in Field.

\n

Valid values: random | spread | binpack\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A placement strategy that determines how to place the tasks for the service.

" - } - }, - "com.amazonaws.securityhub#AwsEcsServicePlacementStrategiesList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEcsServicePlacementStrategiesDetails" - } - }, - "com.amazonaws.securityhub#AwsEcsServiceServiceRegistriesDetails": { - "type": "structure", - "members": { - "ContainerName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The container name value to use for the service discovery service.

\n

If the task definition uses the bridge or host network mode, you must specify ContainerName and ContainerPort.

\n

If the task definition uses the awsvpc network mode and a type SRV DNS record, you must specify either ContainerName and ContainerPort, or Port , but not both.

" - } - }, - "ContainerPort": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The port value to use for the service discovery service.

\n

If the task definition uses the bridge or host network mode, you must specify ContainerName and ContainerPort.

\n

If the task definition uses the awsvpc network mode and a type SRV DNS record, you must specify either ContainerName and ContainerPort, or Port , but not both.

" - } - }, - "Port": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The port value to use for a service discovery service that specifies an SRV record. This field can be used if both the awsvpcawsvpc network mode and SRV records are used.

" - } - }, - "RegistryArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the service registry.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a service discovery registry to assign to the service.

" - } - }, - "com.amazonaws.securityhub#AwsEcsServiceServiceRegistriesList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEcsServiceServiceRegistriesDetails" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails": { - "type": "structure", - "members": { - "Condition": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The dependency condition of the dependent container. Indicates the required status of the dependent container before the current container can start. Valid values are as follows:

\n " - } - }, - "ContainerName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the dependent container.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A dependency that is defined for container startup and shutdown.

" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsDependsOnList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsDetails": { - "type": "structure", - "members": { - "Command": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The command that is passed to the container.

" - } - }, - "Cpu": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of CPU units reserved for the container.

" - } - }, - "DependsOn": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsDependsOnList", - "traits": { - "smithy.api#documentation": "

The dependencies that are defined for container startup and shutdown.

" - } - }, - "DisableNetworking": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether to disable networking within the container.

" - } - }, - "DnsSearchDomains": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

A list of DNS search domains that are presented to the container.

" - } - }, - "DnsServers": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

A list of DNS servers that are presented to the container.

" - } - }, - "DockerLabels": { - "target": "com.amazonaws.securityhub#FieldMap", - "traits": { - "smithy.api#documentation": "

A key-value map of labels to add to the container.

" - } - }, - "DockerSecurityOptions": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems.

" - } - }, - "EntryPoint": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The entry point that is passed to the container.

" - } - }, - "Environment": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsEnvironmentList", - "traits": { - "smithy.api#documentation": "

The environment variables to pass to a container.

" - } - }, - "EnvironmentFiles": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesList", - "traits": { - "smithy.api#documentation": "

A list of files containing the environment variables to pass to a container.

" - } - }, - "Essential": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the container is essential. All tasks must have at least one essential container.

" - } - }, - "ExtraHosts": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsExtraHostsList", - "traits": { - "smithy.api#documentation": "

A list of hostnames and IP address mappings to append to the /etc/hosts file on the container.

" - } - }, - "FirelensConfiguration": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails", - "traits": { - "smithy.api#documentation": "

The FireLens configuration for the container. Specifies and configures a log router for container logs.

" - } - }, - "HealthCheck": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails", - "traits": { - "smithy.api#documentation": "

The container health check command and associated configuration parameters for the container.

" - } - }, - "Hostname": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The hostname to use for the container.

" - } - }, - "Image": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The image used to start the container.

" - } - }, - "Interactive": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

If set to true, then containerized applications can be deployed that require stdin or a tty to be allocated.

" - } - }, - "Links": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

A list of links for the container in the form \n container_name:alias\n . Allows containers to communicate with each other without the need for port mappings.

" - } - }, - "LinuxParameters": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails", - "traits": { - "smithy.api#documentation": "

Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.

" - } - }, - "LogConfiguration": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails", - "traits": { - "smithy.api#documentation": "

The log configuration specification for the container.

" - } - }, - "Memory": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The amount (in MiB) of memory to present to the container. If the container attempts to exceed the memory specified here, the container is shut down. The total amount of memory reserved for all containers within a task must be lower than the task memory value, if one is specified.

" - } - }, - "MemoryReservation": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The soft limit (in MiB) of memory to reserve for the container.

" - } - }, - "MountPoints": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsMountPointsList", - "traits": { - "smithy.api#documentation": "

The mount points for the data volumes in the container.

" - } - }, - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the container.

" - } - }, - "PortMappings": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsPortMappingsList", - "traits": { - "smithy.api#documentation": "

The list of port mappings for the container.

" - } - }, - "Privileged": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the container is given elevated privileges on the host container instance. The elevated privileges are similar to the root user.

" - } - }, - "PseudoTerminal": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether to allocate a TTY to the container.

" - } - }, - "ReadonlyRootFilesystem": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the container is given read-only access to its root file system.

" - } - }, - "RepositoryCredentials": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails", - "traits": { - "smithy.api#documentation": "

The private repository authentication credentials to use.

" - } - }, - "ResourceRequirements": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsList", - "traits": { - "smithy.api#documentation": "

The type and amount of a resource to assign to a container. The only supported resource is a GPU.

" - } - }, - "Secrets": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsSecretsList", - "traits": { - "smithy.api#documentation": "

The secrets to pass to the container.

" - } - }, - "StartTimeout": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of seconds to wait before giving up on resolving dependencies for a container.

" - } - }, - "StopTimeout": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of seconds to wait before the container is stopped if it doesn't shut down normally on its own.

" - } - }, - "SystemControls": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsSystemControlsList", - "traits": { - "smithy.api#documentation": "

A list of namespaced kernel parameters to set in the container.

" - } - }, - "Ulimits": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsUlimitsList", - "traits": { - "smithy.api#documentation": "

A list of ulimits to set in the container.

" - } - }, - "User": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The user to use inside the container.

\n

The value can use one of the following formats.

\n " - } - }, - "VolumesFrom": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsVolumesFromList", - "traits": { - "smithy.api#documentation": "

Data volumes to mount from another container.

" - } - }, - "WorkingDirectory": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The working directory in which to run commands inside the container.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A container definition that describes a container in the task.

" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the environment variable.

" - } - }, - "Value": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The value of the environment variable.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An environment variable to pass to the container.

" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of environment file. The valid value is s3.

" - } - }, - "Value": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the S3 object that contains the environment variable file.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A file that contain environment variables to pass to a container.

" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsEnvironmentList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails": { - "type": "structure", - "members": { - "Hostname": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The hostname to use in the /etc/hosts entry.

" - } - }, - "IpAddress": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The IP address to use in the /etc/hosts entry.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A hostname and IP address mapping to append to the /etc/hosts file on the container.

" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsExtraHostsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails": { - "type": "structure", - "members": { - "Options": { - "target": "com.amazonaws.securityhub#FieldMap", - "traits": { - "smithy.api#documentation": "

The options to use to configure the log router.

\n

The valid option keys are as follows:

\n " - } - }, - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The log router to use. Valid values are fluentbit or fluentd.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The FireLens configuration for the container. The configuration specifies and configures a log router for container logs.

" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails": { - "type": "structure", - "members": { - "Command": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The command that the container runs to determine whether it is healthy.

" - } - }, - "Interval": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The time period in seconds between each health check execution. The default value is 30 seconds.

" - } - }, - "Retries": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of times to retry a failed health check before the container is considered unhealthy. The default value is 3.

" - } - }, - "StartPeriod": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The optional grace period in seconds that allows containers time to bootstrap before failed health checks count towards the maximum number of retries.

" - } - }, - "Timeout": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The time period in seconds to wait for a health check to succeed before it is considered a failure. The default value is 5.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The container health check command and associated configuration parameters for the container.

" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails": { - "type": "structure", - "members": { - "Add": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The Linux capabilities for the container that are added to the default configuration provided by Docker. Valid values are as follows:

\n

Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" |\n \t\t\"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" |\n \t\t\"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" |\n \t\t\"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" |\n \t\t\"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" |\n \t\t\t\"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" |\n \t\t\"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" |\n \t\t\"SETFCAP\" | \"SETGID\" | \"SETPCAP\" |\n \t\t\"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" |\n \t\t\"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" |\n \t\t\"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" |\n \t\t\"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" |\n \t\t\"SYSLOG\" | \"WAKE_ALARM\"\n

" - } - }, - "Drop": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The Linux capabilities for the container that are dropped from the default configuration provided by Docker.

\n

Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" |\n \t\t\"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" |\n \t\t\"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" |\n \t\t\"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" |\n \t\t\"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" |\n \t\t\t\"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" |\n \t\t\"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" |\n \t\t\"SETFCAP\" | \"SETGID\" | \"SETPCAP\" |\n \t\t\"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" |\n \t\t\"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" |\n \t\t\"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" |\n \t\t\"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" |\n \t\t\"SYSLOG\" | \"WAKE_ALARM\"\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.

" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails": { - "type": "structure", - "members": { - "Capabilities": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails", - "traits": { - "smithy.api#documentation": "

The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.

" - } - }, - "Devices": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesList", - "traits": { - "smithy.api#documentation": "

The host devices to expose to the container.

" - } - }, - "InitProcessEnabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether to run an init process inside the container that forwards signals and reaps processes.

" - } - }, - "MaxSwap": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The total amount of swap memory (in MiB) that a container can use.

" - } - }, - "SharedMemorySize": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The value for the size (in MiB) of the /dev/shm volume.

" - } - }, - "Swappiness": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Configures the container's memory swappiness behavior. Determines how aggressively pages are swapped. The higher the value, the more aggressive the swappiness. The default is 60.

" - } - }, - "Tmpfs": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsList", - "traits": { - "smithy.api#documentation": "

The container path, mount options, and size (in MiB) of the tmpfs mount.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

>Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.

" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails": { - "type": "structure", - "members": { - "ContainerPath": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The path inside the container at which to expose the host device.

" - } - }, - "HostPath": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The path for the device on the host container instance.

" - } - }, - "Permissions": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#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.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A host device to expose to the container.

" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails": { - "type": "structure", - "members": { - "ContainerPath": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The absolute file path where the tmpfs volume is to be mounted.

" - } - }, - "MountOptions": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The list of tmpfs volume mount options.

\n

Valid values: \"defaults\" | \"ro\" | \"rw\" | \"suid\" |\n \t\t\"nosuid\" | \"dev\" | \"nodev\" | \"exec\" |\n \t\t\"noexec\" | \"sync\" | \"async\" | \"dirsync\"\n \t\t| \"remount\" | \"mand\" | \"nomand\" | \"atime\"\n \t\t| \"noatime\" | \"diratime\" | \"nodiratime\" |\n \t\t\"bind\" | \"rbind\" | \"unbindable\" |\n \t\t\"runbindable\" | \"private\" | \"rprivate\" |\n \t\t\"shared\" | \"rshared\" | \"slave\" |\n \t\t\"rslave\" | \"relatime\" | \"norelatime\" |\n \t\t\"strictatime\" | \"nostrictatime\" | \"mode\" |\n \t\t\"uid\" | \"gid\" | \"nr_inodes\" |\n \t\t\t\"nr_blocks\" | \"mpol\"\n

" - } - }, - "Size": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum size (in MiB) of the tmpfs volume.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The container path, mount options, and size (in MiB) of a tmpfs mount.

" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsDetails" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails": { - "type": "structure", - "members": { - "LogDriver": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The log driver to use for the container.

\n

Valid values on Fargate are as follows:

\n \n

Valid values on Amazon EC2 are as follows:

\n " - } - }, - "Options": { - "target": "com.amazonaws.securityhub#FieldMap", - "traits": { - "smithy.api#documentation": "

The configuration options to send to the log driver. Requires version 1.19 of the Docker Remote API or greater on your container instance.

" - } - }, - "SecretOptions": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsList", - "traits": { - "smithy.api#documentation": "

The secrets to pass to the log configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The log configuration specification for the container.

" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsDetails": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the secret.

" - } - }, - "ValueFrom": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The secret to expose to the container.

\n

The value is either the full ARN of the Secrets Manager secret or the full ARN of the\n parameter in the Systems Manager Parameter Store.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A secret to pass to the log configuration.

" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsDetails" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails": { - "type": "structure", - "members": { - "ContainerPath": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The path on the container to mount the host volume at.

" - } - }, - "ReadOnly": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the container has read-only access to the volume.

" - } - }, - "SourceVolume": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the volume to mount. Must match the name of a volume listed in VolumeDetails for the task definition.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A mount point for the data volumes in the container.

" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsMountPointsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails": { - "type": "structure", - "members": { - "ContainerPort": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The port number on the container that is bound to the user-specified or automatically assigned host port.

" - } - }, - "HostPort": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The port number on the container instance to reserve for the container.

" - } - }, - "Protocol": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The protocol used for the port mapping. The default is tcp.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A port mapping for the container.

" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsPortMappingsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails": { - "type": "structure", - "members": { - "CredentialsParameter": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the secret that contains the private repository credentials.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The private repository authentication credentials to use.

" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of resource to assign to a container. Valid values are GPU or InferenceAccelerator.

" - } - }, - "Value": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The value for the specified resource type.

\n

For GPU, the value is the number of physical GPUs the Amazon ECS container agent\n reserves for the container.

\n

For InferenceAccelerator, the value should match the DeviceName\n attribute of an entry in InferenceAccelerators.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A resource to assign to a container.

" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the secret.

" - } - }, - "ValueFrom": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The secret to expose to the container. The value is either the full ARN of the Secrets Manager\n secret or the full ARN of the parameter in the Systems Manager Parameter Store.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A secret to pass to the container.

" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsSecretsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails": { - "type": "structure", - "members": { - "Namespace": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The namespaced kernel parameter for which to set a value.

" - } - }, - "Value": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The value of the parameter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A namespaced kernel parameter to set in the container.

" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsSystemControlsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails": { - "type": "structure", - "members": { - "HardLimit": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The hard limit for the ulimit type.

" - } - }, - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of the ulimit. Valid values are as follows:

\n " - } - }, - "SoftLimit": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The soft limit for the ulimit type.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A ulimit to set in the container.

" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsUlimitsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails": { - "type": "structure", - "members": { - "ReadOnly": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the container has read-only access to the volume.

" - } - }, - "SourceContainer": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of another container within the same task definition from which to mount volumes.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A data volume to mount from another container.

" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsVolumesFromList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionDetails": { - "type": "structure", - "members": { - "ContainerDefinitions": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsList", - "traits": { - "smithy.api#documentation": "

The container definitions that describe the containers that make up the task.

" - } - }, - "Cpu": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The number of CPU units used by the task.Valid values are as follows:

\n " - } - }, - "ExecutionRoleArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the task execution role that grants the container agent permission to make API calls on behalf of the container user.

" - } - }, - "Family": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of a family that this task definition is registered to.

" - } - }, - "InferenceAccelerators": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionInferenceAcceleratorsList", - "traits": { - "smithy.api#documentation": "

The Elastic Inference accelerators to use for the containers in the task.

" - } - }, - "IpcMode": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The inter-process communication (IPC) resource namespace to use for the containers in the task. Valid values are as follows:

\n " - } - }, - "Memory": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The amount (in MiB) of memory used by the task.

\n

For tasks that are hosted on Amazon EC2, you can provide a task-level memory value or a container-level memory value.\n For tasks that are hosted on Fargate, you must use one of the specified values in the \n Amazon Elastic Container Service Developer Guide\n , which determines your range of supported values for the Cpu and Memory parameters.

" - } - }, - "NetworkMode": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Docker networking mode to use for the containers in the task. Valid values are as follows:

\n " - } - }, - "PidMode": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The process namespace to use for the containers in the task. Valid values are host or task.

" - } - }, - "PlacementConstraints": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionPlacementConstraintsList", - "traits": { - "smithy.api#documentation": "

The placement constraint objects to use for tasks.

" - } - }, - "ProxyConfiguration": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionProxyConfigurationDetails", - "traits": { - "smithy.api#documentation": "

The configuration details for the App Mesh proxy.

" - } - }, - "RequiresCompatibilities": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The task launch types that the task definition was validated against.

" - } - }, - "TaskRoleArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The short name or ARN of the IAM role that grants containers in the task permission to call Amazon Web Services API operations on your behalf.

" - } - }, - "Volumes": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionVolumesList", - "traits": { - "smithy.api#documentation": "

The data volume definitions for the task.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about a task definition. A task definition describes the container and volume definitions\n of an Amazon Elastic Container Service task.

" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionInferenceAcceleratorsDetails": { - "type": "structure", - "members": { - "DeviceName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Elastic Inference accelerator device name.

" - } - }, - "DeviceType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Elastic Inference accelerator type to use.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An Elastic Inference accelerator to use\n for the containers in the task.

" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionInferenceAcceleratorsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionInferenceAcceleratorsDetails" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionPlacementConstraintsDetails": { - "type": "structure", - "members": { - "Expression": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A cluster query language expression to apply to the constraint.

" - } - }, - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of constraint.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A placement constraint object to use for tasks.

" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionPlacementConstraintsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionPlacementConstraintsDetails" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionProxyConfigurationDetails": { - "type": "structure", - "members": { - "ContainerName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the container that will serve as the App Mesh proxy.

" - } - }, - "ProxyConfigurationProperties": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesList", - "traits": { - "smithy.api#documentation": "

The set of network configuration parameters to provide to the Container Network Interface (CNI) plugin, specified as key-value pairs.

" - } - }, - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The proxy type.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration details for the App Mesh\n proxy.

" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesDetails": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the property.

" - } - }, - "Value": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The value of the property.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A network configuration parameter to provide to the Container Network Interface (CNI) plugin.

" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesDetails" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionVolumesDetails": { - "type": "structure", - "members": { - "DockerVolumeConfiguration": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails", - "traits": { - "smithy.api#documentation": "

Information about a Docker volume.

" - } - }, - "EfsVolumeConfiguration": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails", - "traits": { - "smithy.api#documentation": "

Information about the Amazon Elastic File System file system that is used for task storage.

" - } - }, - "Host": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionVolumesHostDetails", - "traits": { - "smithy.api#documentation": "

Information about a bind mount host volume.

" - } - }, - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the data volume.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A data volume to mount from another container.

" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails": { - "type": "structure", - "members": { - "Autoprovision": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether to create the Docker volume automatically if it does not already exist.

" - } - }, - "Driver": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Docker volume driver to use.

" - } - }, - "DriverOpts": { - "target": "com.amazonaws.securityhub#FieldMap", - "traits": { - "smithy.api#documentation": "

A map of Docker driver-specific options that are passed through.

" - } - }, - "Labels": { - "target": "com.amazonaws.securityhub#FieldMap", - "traits": { - "smithy.api#documentation": "

Custom metadata to add to the Docker volume.

" - } - }, - "Scope": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task are provisioned \nautomatically when the task starts and destroyed when the task stops. Docker volumes that are shared persist after the task stops. Valid values are shared or task.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a Docker volume.

" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationAuthorizationConfigDetails": { - "type": "structure", - "members": { - "AccessPointId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon EFS access point identifier to use.

" - } - }, - "Iam": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Whether to use the Amazon ECS task IAM role defined in a task definition when mounting the Amazon EFS file system.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails": { - "type": "structure", - "members": { - "AuthorizationConfig": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationAuthorizationConfigDetails", - "traits": { - "smithy.api#documentation": "

The authorization configuration details for the Amazon EFS file system.

" - } - }, - "FilesystemId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon EFS file system identifier to use.

" - } - }, - "RootDirectory": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The directory within the Amazon EFS file system to mount as the root directory inside the host.

" - } - }, - "TransitEncryption": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server.

" - } - }, - "TransitEncryptionPort": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the Amazon Elastic File System file system that is used for task storage.

" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionVolumesHostDetails": { - "type": "structure", - "members": { - "SourcePath": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The path on the host container instance that is presented to the container.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a bind mount host volume.

" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDefinitionVolumesList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionVolumesDetails" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskDetails": { - "type": "structure", - "members": { - "ClusterArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster that hosts the task.\n

" - } - }, - "TaskDefinitionArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the task definition that creates the task.\n

" - } - }, - "Version": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The version counter for the task.\n

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Unix timestamp for the time when the task was created. More specifically, it's for the time when \nthe task entered the PENDING state.\n

" - } - }, - "StartedAt": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Unix timestamp for the time when the task started. More specifically, it's for the time when the \n task transitioned from the PENDING state to the RUNNING state.\n

" - } - }, - "StartedBy": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The tag specified when a task is started. If an Amazon ECS service started the task, the \n startedBy parameter contains the deployment ID of that service.\n

" - } - }, - "Group": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the task group that's associated with the task.\n

" - } - }, - "Volumes": { - "target": "com.amazonaws.securityhub#AwsEcsTaskVolumeDetailsList", - "traits": { - "smithy.api#documentation": "

Details about the data volume that is used in a task definition.\n

" - } - }, - "Containers": { - "target": "com.amazonaws.securityhub#AwsEcsContainerDetailsList", - "traits": { - "smithy.api#documentation": "

The containers that are associated with the task.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides details about a task in a cluster.\n

" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskVolumeDetails": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and \nhyphens are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.\n

" - } - }, - "Host": { - "target": "com.amazonaws.securityhub#AwsEcsTaskVolumeHostDetails", - "traits": { - "smithy.api#documentation": "

This parameter is specified when you use bind mount host volumes. The contents of the host parameter \ndetermine whether your bind mount host volume persists on the host container instance and where it's stored. \n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about a data volume that's used in a task definition.\n

" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskVolumeDetailsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEcsTaskVolumeDetails" - } - }, - "com.amazonaws.securityhub#AwsEcsTaskVolumeHostDetails": { - "type": "structure", - "members": { - "SourcePath": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

When the host parameter is used, specify a sourcePath to declare the path \non the host container instance that's presented to the container.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides details on a container instance bind mount host volume.\n

" - } - }, - "com.amazonaws.securityhub#AwsEfsAccessPointDetails": { - "type": "structure", - "members": { - "AccessPointId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon EFS access point.\n

" - } - }, - "Arn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon EFS access point.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The opaque string specified in the request to ensure idempotent creation.\n

" - } - }, - "FileSystemId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon EFS file system that the access point applies to.\n

" - } - }, - "PosixUser": { - "target": "com.amazonaws.securityhub#AwsEfsAccessPointPosixUserDetails", - "traits": { - "smithy.api#documentation": "

The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point, \nthat is used for all file operations by NFS clients using the access point.\n

" - } - }, - "RootDirectory": { - "target": "com.amazonaws.securityhub#AwsEfsAccessPointRootDirectoryDetails", - "traits": { - "smithy.api#documentation": "

The directory on the Amazon EFS file system that the access point exposes as the root \ndirectory to NFS clients using the access point.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about an Amazon EFS access point.\n

" - } - }, - "com.amazonaws.securityhub#AwsEfsAccessPointPosixUserDetails": { - "type": "structure", - "members": { - "Gid": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The POSIX group ID used for all file system operations using this access point.\n

" - } - }, - "SecondaryGids": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

Secondary POSIX group IDs used for all file system operations using this access point.\n

" - } - }, - "Uid": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The POSIX user ID used for all file system operations using this access point.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides details for all file system operations using this Amazon EFS access point.\n

" - } - }, - "com.amazonaws.securityhub#AwsEfsAccessPointRootDirectoryCreationInfoDetails": { - "type": "structure", - "members": { - "OwnerGid": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Specifies the POSIX group ID to apply to the root directory. \n

" - } - }, - "OwnerUid": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Specifies the POSIX user ID to apply to the root directory.\n

" - } - }, - "Permissions": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Specifies the POSIX permissions to apply to the root directory, in the format of an octal number \nrepresenting the file's mode bits.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about the settings that Amazon EFS uses to create the root directory \nwhen a client connects to an access point.\n

" - } - }, - "com.amazonaws.securityhub#AwsEfsAccessPointRootDirectoryDetails": { - "type": "structure", - "members": { - "CreationInfo": { - "target": "com.amazonaws.securityhub#AwsEfsAccessPointRootDirectoryCreationInfoDetails", - "traits": { - "smithy.api#documentation": "

Specifies the POSIX IDs and permissions to apply to the access point's root directory.\n

" - } - }, - "Path": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Specifies the path on the Amazon EFS file system to expose as the root directory to NFS clients \nusing the access point to access the EFS file system. A path can have up to four subdirectories. If the specified \npath does not exist, you are required to provide CreationInfo.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about the directory on the Amazon EFS file system that the access point exposes \nas the root directory to NFS clients using the access point.\n

" - } - }, - "com.amazonaws.securityhub#AwsEksClusterDetails": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the cluster.

" - } - }, - "CertificateAuthorityData": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The certificate authority data for the cluster.

" - } - }, - "ClusterStatus": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The status of the cluster. Valid values are as follows:

\n " - } - }, - "Endpoint": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The endpoint for the Amazon EKS API server.

" - } - }, - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the cluster.

" - } - }, - "ResourcesVpcConfig": { - "target": "com.amazonaws.securityhub#AwsEksClusterResourcesVpcConfigDetails", - "traits": { - "smithy.api#documentation": "

The VPC configuration used by the cluster control plane.

" - } - }, - "RoleArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the IAM role that provides permissions for the Amazon EKS control plane to make calls to Amazon Web Services API operations on your behalf.

" - } - }, - "Version": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon EKS server version for the cluster.

" - } - }, - "Logging": { - "target": "com.amazonaws.securityhub#AwsEksClusterLoggingDetails", - "traits": { - "smithy.api#documentation": "

The logging configuration for the cluster.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides details about an Amazon EKS cluster.

" - } - }, - "com.amazonaws.securityhub#AwsEksClusterLoggingClusterLoggingDetails": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the logging types that are listed in Types are enabled.

" - } - }, - "Types": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

A list of logging types. Valid values are as follows:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Details for a cluster logging configuration.

" - } - }, - "com.amazonaws.securityhub#AwsEksClusterLoggingClusterLoggingList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEksClusterLoggingClusterLoggingDetails" - } - }, - "com.amazonaws.securityhub#AwsEksClusterLoggingDetails": { - "type": "structure", - "members": { - "ClusterLogging": { - "target": "com.amazonaws.securityhub#AwsEksClusterLoggingClusterLoggingList", - "traits": { - "smithy.api#documentation": "

Cluster logging configurations.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The logging configuration for an Amazon EKS cluster.

" - } - }, - "com.amazonaws.securityhub#AwsEksClusterResourcesVpcConfigDetails": { - "type": "structure", - "members": { - "SecurityGroupIds": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The security groups that are associated with the cross-account elastic network interfaces that are used to allow communication between your nodes and the Amazon EKS control plane.

" - } - }, - "SubnetIds": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The subnets that are associated with the cluster.

" - } - }, - "EndpointPublicAccess": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

\n Indicates whether the Amazon EKS public API server endpoint is turned on. If the Amazon EKS public API \n server endpoint is turned off, your cluster's Kubernetes API server can only receive requests that originate from within \n the cluster VPC.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the VPC configuration used by the cluster control plane.

" - } - }, - "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentDetails": { - "type": "structure", - "members": { - "ApplicationName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the application that is associated with the environment.

" - } - }, - "Cname": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The URL to the CNAME for this environment.

" - } - }, - "DateCreated": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The creation date for this environment.

" - } - }, - "DateUpdated": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The date when this environment was last modified.

" - } - }, - "Description": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A description of the environment.

" - } - }, - "EndpointUrl": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

For load-balanced, autoscaling environments, the URL to the load balancer. For single-instance environments, the IP address of the instance.

" - } - }, - "EnvironmentArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the environment.

" - } - }, - "EnvironmentId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the environment.

" - } - }, - "EnvironmentLinks": { - "target": "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentEnvironmentLinks", - "traits": { - "smithy.api#documentation": "

Links to other environments in the same group.

" - } - }, - "EnvironmentName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the environment.

" - } - }, - "OptionSettings": { - "target": "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentOptionSettings", - "traits": { - "smithy.api#documentation": "

The configuration setting for the environment.

" - } - }, - "PlatformArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the platform version for the environment.

" - } - }, - "SolutionStackName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the solution stack that is deployed with the environment.

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The current operational status of the environment. Valid values are as follows:

\n " - } - }, - "Tier": { - "target": "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentTier", - "traits": { - "smithy.api#documentation": "

The tier of the environment.

" - } - }, - "VersionLabel": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The application version of the environment.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains details about an Elastic Beanstalk environment.

" - } - }, - "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentEnvironmentLink": { - "type": "structure", - "members": { - "EnvironmentName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the linked environment.

" - } - }, - "LinkName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the environment link.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about a link to another environment that is in the same group.

" - } - }, - "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentEnvironmentLinks": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentEnvironmentLink" - } - }, - "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentOptionSetting": { - "type": "structure", - "members": { - "Namespace": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of resource that the configuration option is associated with.

" - } - }, - "OptionName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the option.

" - } - }, - "ResourceName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the resource.

" - } - }, - "Value": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The value of the configuration setting.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A configuration option setting for the environment.

" - } - }, - "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentOptionSettings": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentOptionSetting" - } - }, - "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentTier": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the environment tier. Valid values are WebServer or Worker.

" - } - }, - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of environment tier. Valid values are Standard or SQS/HTTP.

" - } - }, - "Version": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The version of the environment tier.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about the tier of the environment.

" - } - }, - "com.amazonaws.securityhub#AwsElasticsearchDomainDetails": { - "type": "structure", - "members": { - "AccessPolicies": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

IAM policy document specifying the access policies for the new Elasticsearch domain.

" - } - }, - "DomainEndpointOptions": { - "target": "com.amazonaws.securityhub#AwsElasticsearchDomainDomainEndpointOptions", - "traits": { - "smithy.api#documentation": "

Additional options for the domain endpoint.

" - } - }, - "DomainId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Unique identifier for an Elasticsearch domain.

" - } - }, - "DomainName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Name of an Elasticsearch domain.

\n

Domain names are unique across all domains owned by the same account within an Amazon Web Services\n Region.

\n

Domain names must start with a lowercase letter and must be between 3 and 28\n characters.

\n

Valid characters are a-z (lowercase only), 0-9, and – (hyphen).

" - } - }, - "Endpoint": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Domain-specific endpoint used to submit index, search, and data upload requests to an\n Elasticsearch domain.

\n

The endpoint is a service URL.

" - } - }, - "Endpoints": { - "target": "com.amazonaws.securityhub#FieldMap", - "traits": { - "smithy.api#documentation": "

The key-value pair that exists if the Elasticsearch domain uses VPC endpoints.

" - } - }, - "ElasticsearchVersion": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

OpenSearch version.

" - } - }, - "ElasticsearchClusterConfig": { - "target": "com.amazonaws.securityhub#AwsElasticsearchDomainElasticsearchClusterConfigDetails", - "traits": { - "smithy.api#documentation": "

Information about an OpenSearch cluster configuration.

" - } - }, - "EncryptionAtRestOptions": { - "target": "com.amazonaws.securityhub#AwsElasticsearchDomainEncryptionAtRestOptions", - "traits": { - "smithy.api#documentation": "

Details about the configuration for encryption at rest.

" - } - }, - "LogPublishingOptions": { - "target": "com.amazonaws.securityhub#AwsElasticsearchDomainLogPublishingOptions", - "traits": { - "smithy.api#documentation": "

Configures the CloudWatch Logs to publish for the Elasticsearch domain.

" - } - }, - "NodeToNodeEncryptionOptions": { - "target": "com.amazonaws.securityhub#AwsElasticsearchDomainNodeToNodeEncryptionOptions", - "traits": { - "smithy.api#documentation": "

Details about the configuration for node-to-node encryption.

" - } - }, - "ServiceSoftwareOptions": { - "target": "com.amazonaws.securityhub#AwsElasticsearchDomainServiceSoftwareOptions", - "traits": { - "smithy.api#documentation": "

Information about the status of a domain relative to the latest service software.

" - } - }, - "VPCOptions": { - "target": "com.amazonaws.securityhub#AwsElasticsearchDomainVPCOptions", - "traits": { - "smithy.api#documentation": "

Information that OpenSearch derives based on VPCOptions for the\n domain.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about an Elasticsearch domain.

" - } - }, - "com.amazonaws.securityhub#AwsElasticsearchDomainDomainEndpointOptions": { - "type": "structure", - "members": { - "EnforceHTTPS": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether to require that all traffic to the domain arrive over HTTPS.

" - } - }, - "TLSSecurityPolicy": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The TLS security policy to apply to the HTTPS endpoint of the OpenSearch\n domain.

\n

Valid values:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Additional options for the domain endpoint, such as whether to require HTTPS for all\n traffic.

" - } - }, - "com.amazonaws.securityhub#AwsElasticsearchDomainElasticsearchClusterConfigDetails": { - "type": "structure", - "members": { - "DedicatedMasterCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of instances to use for the master node. If this attribute is specified, then DedicatedMasterEnabled must be true.

" - } - }, - "DedicatedMasterEnabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether to use a dedicated master node for the Elasticsearch domain. A dedicated master node performs cluster management tasks, but doesn't hold data or respond to data upload requests.

" - } - }, - "DedicatedMasterType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The hardware configuration of the computer that hosts the dedicated master node. A sample value is m3.medium.elasticsearch. If this attribute is specified, then DedicatedMasterEnabled must be true.

\n

For a list of valid values, see Supported instance types in Amazon OpenSearch Service in the Amazon OpenSearch Service Developer Guide.

" - } - }, - "InstanceCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of data nodes to use in the Elasticsearch domain.

" - } - }, - "InstanceType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The instance type for your data nodes. For example, m3.medium.elasticsearch.

\n

For a list of valid values, see Supported instance types in Amazon OpenSearch Service in the Amazon OpenSearch Service Developer Guide.

" - } - }, - "ZoneAwarenessConfig": { - "target": "com.amazonaws.securityhub#AwsElasticsearchDomainElasticsearchClusterConfigZoneAwarenessConfigDetails", - "traits": { - "smithy.api#documentation": "

Configuration options for zone awareness. Provided if ZoneAwarenessEnabled is true.

" - } - }, - "ZoneAwarenessEnabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether to enable zone awareness for the Elasticsearch domain. When zone awareness is enabled, OpenSearch allocates the cluster's nodes and replica index shards across Availability Zones in the same Region. This prevents data loss and minimizes downtime if a node or data center fails.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

details about the configuration of an OpenSearch cluster.

" - } - }, - "com.amazonaws.securityhub#AwsElasticsearchDomainElasticsearchClusterConfigZoneAwarenessConfigDetails": { - "type": "structure", - "members": { - "AvailabilityZoneCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

he number of Availability Zones that the domain uses. Valid values are 2 and 3. The default is 2.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Configuration options for zone awareness.

" - } - }, - "com.amazonaws.securityhub#AwsElasticsearchDomainEncryptionAtRestOptions": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether encryption at rest is enabled.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about the configuration for encryption at rest.

" - } - }, - "com.amazonaws.securityhub#AwsElasticsearchDomainLogPublishingOptions": { - "type": "structure", - "members": { - "IndexSlowLogs": { - "target": "com.amazonaws.securityhub#AwsElasticsearchDomainLogPublishingOptionsLogConfig", - "traits": { - "smithy.api#documentation": "

Configures the OpenSearch index logs\n publishing.

" - } - }, - "SearchSlowLogs": { - "target": "com.amazonaws.securityhub#AwsElasticsearchDomainLogPublishingOptionsLogConfig", - "traits": { - "smithy.api#documentation": "

Configures the OpenSearch search slow log\n publishing.

" - } - }, - "AuditLogs": { - "target": "com.amazonaws.securityhub#AwsElasticsearchDomainLogPublishingOptionsLogConfig" - } - }, - "traits": { - "smithy.api#documentation": "

configures the CloudWatch Logs to publish for the\n Elasticsearch domain.

" - } - }, - "com.amazonaws.securityhub#AwsElasticsearchDomainLogPublishingOptionsLogConfig": { - "type": "structure", - "members": { - "CloudWatchLogsLogGroupArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the CloudWatch Logs group to publish the logs to.

" - } - }, - "Enabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the log publishing is enabled.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The log configuration.

" - } - }, - "com.amazonaws.securityhub#AwsElasticsearchDomainNodeToNodeEncryptionOptions": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether node-to-node encryption is enabled.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about the configuration for node-to-node encryption.

" - } - }, - "com.amazonaws.securityhub#AwsElasticsearchDomainServiceSoftwareOptions": { - "type": "structure", - "members": { - "AutomatedUpdateDate": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The epoch time when the deployment window closes for required updates. After this time,\n Amazon OpenSearch Service schedules the software upgrade automatically.

" - } - }, - "Cancellable": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether a request to update the domain can be canceled.

" - } - }, - "CurrentVersion": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The version of the service software that is currently installed on the domain.

" - } - }, - "Description": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A more detailed description of the service software status.

" - } - }, - "NewVersion": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The most recent version of the service software.

" - } - }, - "UpdateAvailable": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether a service software update is available for the domain.

" - } - }, - "UpdateStatus": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The status of the service software update. Valid values are as follows:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the state of the domain relative to the latest service software.

" - } - }, - "com.amazonaws.securityhub#AwsElasticsearchDomainVPCOptions": { - "type": "structure", - "members": { - "AvailabilityZones": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The list of Availability Zones associated with the VPC subnets.

" - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The list of security group IDs associated with the VPC endpoints for the domain.

" - } - }, - "SubnetIds": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

A list of subnet IDs associated with the VPC endpoints for the domain.

" - } - }, - "VPCId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

ID for the VPC.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information that OpenSearch derives based on VPCOptions for the\n domain.

" - } - }, - "com.amazonaws.securityhub#AwsElbAppCookieStickinessPolicies": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsElbAppCookieStickinessPolicy" - } - }, - "com.amazonaws.securityhub#AwsElbAppCookieStickinessPolicy": { - "type": "structure", - "members": { - "CookieName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the application cookie used for stickiness.

" - } - }, - "PolicyName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The mnemonic name for the policy being created. The name must be unique within the set\n of policies for the load balancer.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about a stickiness policy that was created using\n CreateAppCookieStickinessPolicy.

" - } - }, - "com.amazonaws.securityhub#AwsElbLbCookieStickinessPolicies": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsElbLbCookieStickinessPolicy" - } - }, - "com.amazonaws.securityhub#AwsElbLbCookieStickinessPolicy": { - "type": "structure", - "members": { - "CookieExpirationPeriod": { - "target": "com.amazonaws.securityhub#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The amount of time, in seconds, after which the cookie is considered stale. If an\n expiration period is not specified, the stickiness session lasts for the duration of the\n browser session.

" - } - }, - "PolicyName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the policy. The name must be unique within the set of policies for the load\n balancer.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about a stickiness policy that was created using\n CreateLBCookieStickinessPolicy.

" - } - }, - "com.amazonaws.securityhub#AwsElbLoadBalancerAccessLog": { - "type": "structure", - "members": { - "EmitInterval": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The interval in minutes for publishing the access logs.

\n

You can publish access logs either every 5 minutes or every 60 minutes.

" - } - }, - "Enabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether access logs are enabled for the load balancer.

" - } - }, - "S3BucketName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the S3 bucket where the access logs are stored.

" - } - }, - "S3BucketPrefix": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The logical hierarchy that was created for the S3 bucket.

\n

If a prefix is not provided, the log is placed at the root level of the bucket.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about the access log configuration for the load balancer.

" - } - }, - "com.amazonaws.securityhub#AwsElbLoadBalancerAdditionalAttribute": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the attribute.

" - } - }, - "Value": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The value of the attribute.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about additional attributes for the load balancer.

" - } - }, - "com.amazonaws.securityhub#AwsElbLoadBalancerAdditionalAttributeList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsElbLoadBalancerAdditionalAttribute" - } - }, - "com.amazonaws.securityhub#AwsElbLoadBalancerAttributes": { - "type": "structure", - "members": { - "AccessLog": { - "target": "com.amazonaws.securityhub#AwsElbLoadBalancerAccessLog", - "traits": { - "smithy.api#documentation": "

Information about the access log configuration for the load balancer.

\n

If the access log is enabled, the load balancer captures detailed information about all\n requests. It delivers the information to a specified S3 bucket.

" - } - }, - "ConnectionDraining": { - "target": "com.amazonaws.securityhub#AwsElbLoadBalancerConnectionDraining", - "traits": { - "smithy.api#documentation": "

Information about the connection draining configuration for the load balancer.

\n

If connection draining is enabled, the load balancer allows existing requests to\n complete before it shifts traffic away from a deregistered or unhealthy instance.

" - } - }, - "ConnectionSettings": { - "target": "com.amazonaws.securityhub#AwsElbLoadBalancerConnectionSettings", - "traits": { - "smithy.api#documentation": "

Connection settings for the load balancer.

\n

If an idle timeout is configured, the load balancer allows connections to remain idle\n for the specified duration. When a connection is idle, no data is sent over the\n connection.

" - } - }, - "CrossZoneLoadBalancing": { - "target": "com.amazonaws.securityhub#AwsElbLoadBalancerCrossZoneLoadBalancing", - "traits": { - "smithy.api#documentation": "

Cross-zone load balancing settings for the load balancer.

\n

If cross-zone load balancing is enabled, the load balancer routes the request traffic\n evenly across all instances regardless of the Availability Zones.

" - } - }, - "AdditionalAttributes": { - "target": "com.amazonaws.securityhub#AwsElbLoadBalancerAdditionalAttributeList", - "traits": { - "smithy.api#documentation": "

Any additional attributes for a load balancer.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains attributes for the load balancer.

" - } - }, - "com.amazonaws.securityhub#AwsElbLoadBalancerBackendServerDescription": { - "type": "structure", - "members": { - "InstancePort": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The port on which the EC2 instance is listening.

" - } - }, - "PolicyNames": { - "target": "com.amazonaws.securityhub#StringList", - "traits": { - "smithy.api#documentation": "

The names of the policies that are enabled for the EC2 instance.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about the configuration of an EC2 instance for the load\n balancer.

" - } - }, - "com.amazonaws.securityhub#AwsElbLoadBalancerBackendServerDescriptions": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsElbLoadBalancerBackendServerDescription" - } - }, - "com.amazonaws.securityhub#AwsElbLoadBalancerConnectionDraining": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether connection draining is enabled for the load balancer.

" - } - }, - "Timeout": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum time, in seconds, to keep the existing connections open before deregistering\n the instances.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about the connection draining configuration for the load\n balancer.

" - } - }, - "com.amazonaws.securityhub#AwsElbLoadBalancerConnectionSettings": { - "type": "structure", - "members": { - "IdleTimeout": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The time, in seconds, that the connection can be idle (no data is sent over the\n connection) before it is closed by the load balancer.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains connection settings for the load balancer.

" - } - }, - "com.amazonaws.securityhub#AwsElbLoadBalancerCrossZoneLoadBalancing": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether cross-zone load balancing is enabled for the load balancer.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains cross-zone load balancing settings for the load balancer.

" - } - }, - "com.amazonaws.securityhub#AwsElbLoadBalancerDetails": { - "type": "structure", - "members": { - "AvailabilityZones": { - "target": "com.amazonaws.securityhub#StringList", - "traits": { - "smithy.api#documentation": "

The list of Availability Zones for the load balancer.

" - } - }, - "BackendServerDescriptions": { - "target": "com.amazonaws.securityhub#AwsElbLoadBalancerBackendServerDescriptions", - "traits": { - "smithy.api#documentation": "

Information about the configuration of the EC2 instances.

" - } - }, - "CanonicalHostedZoneName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the Amazon Route 53 hosted zone for the load balancer.

" - } - }, - "CanonicalHostedZoneNameID": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Route 53 hosted zone for the load balancer.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the load balancer was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "DnsName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The DNS name of the load balancer.

" - } - }, - "HealthCheck": { - "target": "com.amazonaws.securityhub#AwsElbLoadBalancerHealthCheck", - "traits": { - "smithy.api#documentation": "

Information about the health checks that are conducted on the load balancer.

" - } - }, - "Instances": { - "target": "com.amazonaws.securityhub#AwsElbLoadBalancerInstances", - "traits": { - "smithy.api#documentation": "

List of EC2 instances for the load balancer.

" - } - }, - "ListenerDescriptions": { - "target": "com.amazonaws.securityhub#AwsElbLoadBalancerListenerDescriptions", - "traits": { - "smithy.api#documentation": "

The policies that are enabled for the load balancer listeners.

" - } - }, - "LoadBalancerAttributes": { - "target": "com.amazonaws.securityhub#AwsElbLoadBalancerAttributes", - "traits": { - "smithy.api#documentation": "

The attributes for a load balancer.

" - } - }, - "LoadBalancerName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the load balancer.

" - } - }, - "Policies": { - "target": "com.amazonaws.securityhub#AwsElbLoadBalancerPolicies", - "traits": { - "smithy.api#documentation": "

The policies for a load balancer.

" - } - }, - "Scheme": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of load balancer. Only provided if the load balancer is in a VPC.

\n

If Scheme is internet-facing, the load balancer has a public\n DNS name that resolves to a public IP address.

\n

If Scheme is internal, the load balancer has a public DNS name\n that resolves to a private IP address.

" - } - }, - "SecurityGroups": { - "target": "com.amazonaws.securityhub#StringList", - "traits": { - "smithy.api#documentation": "

The security groups for the load balancer. Only provided if the load balancer is in a\n VPC.

" - } - }, - "SourceSecurityGroup": { - "target": "com.amazonaws.securityhub#AwsElbLoadBalancerSourceSecurityGroup", - "traits": { - "smithy.api#documentation": "

Information about the security group for the load balancer. This is the security group\n that is used for inbound rules.

" - } - }, - "Subnets": { - "target": "com.amazonaws.securityhub#StringList", - "traits": { - "smithy.api#documentation": "

The list of subnet identifiers for the load balancer.

" - } - }, - "VpcId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the VPC for the load balancer.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains details about a Classic Load Balancer.

" - } - }, - "com.amazonaws.securityhub#AwsElbLoadBalancerHealthCheck": { - "type": "structure", - "members": { - "HealthyThreshold": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of consecutive health check successes required before the instance is moved\n to the Healthy state.

" - } - }, - "Interval": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The approximate interval, in seconds, between health checks of an individual\n instance.

" - } - }, - "Target": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The instance that is being checked. The target specifies the protocol and port. The\n available protocols are TCP, SSL, HTTP, and HTTPS. The range of valid ports is 1 through\n 65535.

\n

For the HTTP and HTTPS protocols, the target also specifies the ping path.

\n

For the TCP protocol, the target is specified as TCP:\n \n .

\n

For the SSL protocol, the target is specified as\n SSL.\n .

\n

For the HTTP and HTTPS protocols, the target is specified as\n \n :/\n .

" - } - }, - "Timeout": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The amount of time, in seconds, during which no response means a failed health\n check.

" - } - }, - "UnhealthyThreshold": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of consecutive health check failures that must occur before the instance is\n moved to the Unhealthy state.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about the health checks that are conducted on the load\n balancer.

" - } - }, - "com.amazonaws.securityhub#AwsElbLoadBalancerInstance": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The instance identifier.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about an EC2 instance for a load balancer.

" - } - }, - "com.amazonaws.securityhub#AwsElbLoadBalancerInstances": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsElbLoadBalancerInstance" - } - }, - "com.amazonaws.securityhub#AwsElbLoadBalancerListener": { - "type": "structure", - "members": { - "InstancePort": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The port on which the instance is listening.

" - } - }, - "InstanceProtocol": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The protocol to use to route traffic to instances.

\n

Valid values: HTTP | HTTPS | TCP |\n SSL\n

" - } - }, - "LoadBalancerPort": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The port on which the load balancer is listening.

\n

On EC2-VPC, you can specify any port from the range 1-65535.

\n

On EC2-Classic, you can specify any port from the following list: 25, 80, 443, 465, 587,\n 1024-65535.

" - } - }, - "Protocol": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The load balancer transport protocol to use for routing.

\n

Valid values: HTTP | HTTPS | TCP |\n SSL\n

" - } - }, - "SslCertificateId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the server certificate.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a load balancer listener.

" - } - }, - "com.amazonaws.securityhub#AwsElbLoadBalancerListenerDescription": { - "type": "structure", - "members": { - "Listener": { - "target": "com.amazonaws.securityhub#AwsElbLoadBalancerListener", - "traits": { - "smithy.api#documentation": "

Information about the listener.

" - } - }, - "PolicyNames": { - "target": "com.amazonaws.securityhub#StringList", - "traits": { - "smithy.api#documentation": "

The policies enabled for the listener.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Lists the policies that are enabled for a load balancer listener.

" - } - }, - "com.amazonaws.securityhub#AwsElbLoadBalancerListenerDescriptions": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsElbLoadBalancerListenerDescription" - } - }, - "com.amazonaws.securityhub#AwsElbLoadBalancerPolicies": { - "type": "structure", - "members": { - "AppCookieStickinessPolicies": { - "target": "com.amazonaws.securityhub#AwsElbAppCookieStickinessPolicies", - "traits": { - "smithy.api#documentation": "

The stickiness policies that are created using\n CreateAppCookieStickinessPolicy.

" - } - }, - "LbCookieStickinessPolicies": { - "target": "com.amazonaws.securityhub#AwsElbLbCookieStickinessPolicies", - "traits": { - "smithy.api#documentation": "

The stickiness policies that are created using\n CreateLBCookieStickinessPolicy.

" - } - }, - "OtherPolicies": { - "target": "com.amazonaws.securityhub#StringList", - "traits": { - "smithy.api#documentation": "

The policies other than the stickiness policies.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about the policies for a load balancer.

" - } - }, - "com.amazonaws.securityhub#AwsElbLoadBalancerSourceSecurityGroup": { - "type": "structure", - "members": { - "GroupName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the security group.

" - } - }, - "OwnerAlias": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The owner of the security group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about the security group for the load balancer.

" - } - }, - "com.amazonaws.securityhub#AwsElbv2LoadBalancerAttribute": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the load balancer attribute.

" - } - }, - "Value": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The value of the load balancer attribute.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A load balancer attribute.

" - } - }, - "com.amazonaws.securityhub#AwsElbv2LoadBalancerAttributes": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsElbv2LoadBalancerAttribute" - } - }, - "com.amazonaws.securityhub#AwsElbv2LoadBalancerDetails": { - "type": "structure", - "members": { - "AvailabilityZones": { - "target": "com.amazonaws.securityhub#AvailabilityZones", - "traits": { - "smithy.api#documentation": "

The Availability Zones for the load balancer.

" - } - }, - "CanonicalHostedZoneId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Route 53 hosted zone associated with the load balancer.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the load balancer was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "DNSName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The public DNS name of the load balancer.

" - } - }, - "IpAddressType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of IP addresses used by the subnets for your load balancer. The possible values\n are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6\n addresses).

" - } - }, - "Scheme": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The nodes of an Internet-facing load balancer have public IP addresses.

" - } - }, - "SecurityGroups": { - "target": "com.amazonaws.securityhub#SecurityGroups", - "traits": { - "smithy.api#documentation": "

The IDs of the security groups for the load balancer.

" - } - }, - "State": { - "target": "com.amazonaws.securityhub#LoadBalancerState", - "traits": { - "smithy.api#documentation": "

The state of the load balancer.

" - } - }, - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of load balancer.

" - } - }, - "VpcId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the VPC for the load balancer.

" - } - }, - "LoadBalancerAttributes": { - "target": "com.amazonaws.securityhub#AwsElbv2LoadBalancerAttributes", - "traits": { - "smithy.api#documentation": "

Attributes of the load balancer.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a load balancer.

" - } - }, - "com.amazonaws.securityhub#AwsEventSchemasRegistryDetails": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n A description of the registry to be created. \n

" - } - }, - "RegistryArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the registry. \n

" - } - }, - "RegistryName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The name of the schema registry. \n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n A schema defines the structure of events that are sent to Amazon EventBridge. Schema registries are containers for \n schemas. They collect and organize schemas so that your schemas are in logical groups. \n

" - } - }, - "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesCloudTrailDetails": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n Specifies whether CloudTrail is activated as a data source for the detector. \n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n An object that contains information on the status of CloudTrail as a data source for the detector. \n

" - } - }, - "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesDetails": { - "type": "structure", - "members": { - "CloudTrail": { - "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesCloudTrailDetails", - "traits": { - "smithy.api#documentation": "

\n An object that contains information on the status of CloudTrail as a data source for the detector. \n

" - } - }, - "DnsLogs": { - "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesDnsLogsDetails", - "traits": { - "smithy.api#documentation": "

\n An object that contains information on the status of DNS logs as a data source for the detector.\n

" - } - }, - "FlowLogs": { - "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesFlowLogsDetails", - "traits": { - "smithy.api#documentation": "

\n An object that contains information on the status of VPC Flow Logs as a data source for the detector.\n

" - } - }, - "Kubernetes": { - "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesKubernetesDetails", - "traits": { - "smithy.api#documentation": "

\n An object that contains information on the status of Kubernetes data sources for the detector.\n

" - } - }, - "MalwareProtection": { - "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesMalwareProtectionDetails", - "traits": { - "smithy.api#documentation": "

\n An object that contains information on the status of Malware Protection as a data source for the detector.\n

" - } - }, - "S3Logs": { - "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesS3LogsDetails", - "traits": { - "smithy.api#documentation": "

\n An object that contains information on the status of S3 Data event logs as a data source for the detector.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Describes which data sources are activated for the detector. \n

" - } - }, - "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesDnsLogsDetails": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n Describes whether DNS logs is enabled as a data source for the detector.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n An object that contains information on the status of DNS logs as a data source for the detector.\n

" - } - }, - "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesFlowLogsDetails": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n Describes whether VPC Flow Logs are activated as a data source for the detector.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n An object that contains information on the status of VPC Flow Logs as a data source for the detector.\n

" - } - }, - "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesKubernetesAuditLogsDetails": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n Describes whether Kubernetes audit logs are activated as a data source for the detector.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n An object that contains information on the status of Kubernetes audit logs as a data source for the detector.\n

" - } - }, - "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesKubernetesDetails": { - "type": "structure", - "members": { - "AuditLogs": { - "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesKubernetesAuditLogsDetails", - "traits": { - "smithy.api#documentation": "

\n Describes whether Kubernetes audit logs are activated as a data source for the detector.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n An object that contains information on the status of Kubernetes data sources for the detector.\n

" - } - }, - "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesMalwareProtectionDetails": { - "type": "structure", - "members": { - "ScanEc2InstanceWithFindings": { - "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsDetails", - "traits": { - "smithy.api#documentation": "

\n Describes the configuration of Malware Protection for EC2 instances with findings.\n

" - } - }, - "ServiceRole": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The GuardDuty Malware Protection service role.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n An object that contains information on the status of Malware Protection as a data source for the detector.\n

" - } - }, - "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsDetails": { - "type": "structure", - "members": { - "EbsVolumes": { - "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumesDetails", - "traits": { - "smithy.api#documentation": "

\n Describes the configuration of scanning EBS volumes (Malware Protection) as a data source.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Describes the configuration of Malware Protection for EC2 instances with findings.\n

" - } - }, - "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumesDetails": { - "type": "structure", - "members": { - "Reason": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n Specifies the reason why scanning EBS volumes (Malware Protection) isn’t activated as a data source.\n

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n Describes whether scanning EBS volumes is activated as a data source for the detector.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Describes the configuration of scanning EBS volumes (Malware Protection) as a data source.\n

" - } - }, - "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesS3LogsDetails": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n A value that describes whether S3 data event logs are automatically enabled for new members of an organization.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n An object that contains information on the status of S3 data event logs as a data source for the detector.\n

" - } - }, - "com.amazonaws.securityhub#AwsGuardDutyDetectorDetails": { - "type": "structure", - "members": { - "DataSources": { - "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesDetails", - "traits": { - "smithy.api#documentation": "

\n Describes which data sources are activated for the detector.\n

" - } - }, - "Features": { - "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorFeaturesList", - "traits": { - "smithy.api#documentation": "

\n Describes which features are activated for the detector.\n

" - } - }, - "FindingPublishingFrequency": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The publishing frequency of the finding.\n

" - } - }, - "ServiceRole": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The GuardDuty service role.\n

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The activation status of the detector.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Provides details about an Amazon GuardDuty detector. A detector is an object that represents the GuardDuty service. A detector is required for GuardDuty to become operational.\n

" - } - }, - "com.amazonaws.securityhub#AwsGuardDutyDetectorFeaturesDetails": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n Indicates the name of the feature that is activated for the detector.\n

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n Indicates the status of the feature that is activated for the detector.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Describes which features are activated for the detector.\n

" - } - }, - "com.amazonaws.securityhub#AwsGuardDutyDetectorFeaturesList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorFeaturesDetails" - } - }, - "com.amazonaws.securityhub#AwsIamAccessKeyDetails": { - "type": "structure", - "members": { - "UserName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#deprecated": { - "message": "This filter is deprecated. Instead, use PrincipalName." - }, - "smithy.api#documentation": "

The user associated with the IAM access key related to a finding.

\n

The UserName parameter has been replaced with the\n PrincipalName parameter because access keys can also be assigned to\n principals that are not IAM users.

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#AwsIamAccessKeyStatus", - "traits": { - "smithy.api#documentation": "

The status of the IAM access key related to a finding.

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the IAM access key was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "PrincipalId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the principal associated with an access key.

" - } - }, - "PrincipalType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of principal associated with an access key.

" - } - }, - "PrincipalName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the principal.

" - } - }, - "AccountId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the account for the key.

" - } - }, - "AccessKeyId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the access key.

" - } - }, - "SessionContext": { - "target": "com.amazonaws.securityhub#AwsIamAccessKeySessionContext", - "traits": { - "smithy.api#documentation": "

Information about the session that the key was used for.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

IAM access key details related to a finding.

" - } - }, - "com.amazonaws.securityhub#AwsIamAccessKeySessionContext": { - "type": "structure", - "members": { - "Attributes": { - "target": "com.amazonaws.securityhub#AwsIamAccessKeySessionContextAttributes", - "traits": { - "smithy.api#documentation": "

Attributes of the session that the key was used for.

" - } - }, - "SessionIssuer": { - "target": "com.amazonaws.securityhub#AwsIamAccessKeySessionContextSessionIssuer", - "traits": { - "smithy.api#documentation": "

Information about the entity that created the session.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about the session that the key was used for.

" - } - }, - "com.amazonaws.securityhub#AwsIamAccessKeySessionContextAttributes": { - "type": "structure", - "members": { - "MfaAuthenticated": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the session used multi-factor authentication (MFA).

" - } - }, - "CreationDate": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the session was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Attributes of the session that the key was used for.

" - } - }, - "com.amazonaws.securityhub#AwsIamAccessKeySessionContextSessionIssuer": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of principal (user, role, or group) that created the session.

" - } - }, - "PrincipalId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The principal ID of the principal (user, role, or group) that created the\n session.

" - } - }, - "Arn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the session.

" - } - }, - "AccountId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Web Services account that created the session.

" - } - }, - "UserName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the principal that created the session.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the entity that created the session.

" - } - }, - "com.amazonaws.securityhub#AwsIamAccessKeyStatus": { - "type": "enum", - "members": { - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Active" - } - }, - "INACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Inactive" - } - } - } - }, - "com.amazonaws.securityhub#AwsIamAttachedManagedPolicy": { - "type": "structure", - "members": { - "PolicyName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the policy.

" - } - }, - "PolicyArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the policy.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A managed policy that is attached to an IAM principal.

" - } - }, - "com.amazonaws.securityhub#AwsIamAttachedManagedPolicyList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsIamAttachedManagedPolicy" - } - }, - "com.amazonaws.securityhub#AwsIamGroupDetails": { - "type": "structure", - "members": { - "AttachedManagedPolicies": { - "target": "com.amazonaws.securityhub#AwsIamAttachedManagedPolicyList", - "traits": { - "smithy.api#documentation": "

A list of the managed policies that are attached to the IAM group.

" - } - }, - "CreateDate": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the IAM group was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "GroupId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the IAM group.

" - } - }, - "GroupName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the IAM group.

" - } - }, - "GroupPolicyList": { - "target": "com.amazonaws.securityhub#AwsIamGroupPolicyList", - "traits": { - "smithy.api#documentation": "

The list of inline policies that are embedded in the group.

" - } - }, - "Path": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The path to the group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains details about an IAM group.

" - } - }, - "com.amazonaws.securityhub#AwsIamGroupPolicy": { - "type": "structure", - "members": { - "PolicyName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the policy.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A managed policy that is attached to the IAM group.

" - } - }, - "com.amazonaws.securityhub#AwsIamGroupPolicyList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsIamGroupPolicy" - } - }, - "com.amazonaws.securityhub#AwsIamInstanceProfile": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the instance profile.

" - } - }, - "CreateDate": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the instance profile was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "InstanceProfileId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the instance profile.

" - } - }, - "InstanceProfileName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the instance profile.

" - } - }, - "Path": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The path to the instance profile.

" - } - }, - "Roles": { - "target": "com.amazonaws.securityhub#AwsIamInstanceProfileRoles", - "traits": { - "smithy.api#documentation": "

The roles associated with the instance profile.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about an instance profile.

" - } - }, - "com.amazonaws.securityhub#AwsIamInstanceProfileList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsIamInstanceProfile" - } - }, - "com.amazonaws.securityhub#AwsIamInstanceProfileRole": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the role.

" - } - }, - "AssumeRolePolicyDocument": { - "target": "com.amazonaws.securityhub#AwsIamRoleAssumeRolePolicyDocument", - "traits": { - "smithy.api#documentation": "

The policy that grants an entity permission to assume the role.

" - } - }, - "CreateDate": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the role was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "Path": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The path to the role.

" - } - }, - "RoleId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the role.

" - } - }, - "RoleName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the role.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a role associated with an instance profile.

" - } - }, - "com.amazonaws.securityhub#AwsIamInstanceProfileRoles": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsIamInstanceProfileRole" - } - }, - "com.amazonaws.securityhub#AwsIamPermissionsBoundary": { - "type": "structure", - "members": { - "PermissionsBoundaryArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the policy used to set the permissions boundary.

" - } - }, - "PermissionsBoundaryType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The usage type for the permissions boundary.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the policy used to set the permissions boundary for an IAM\n principal.

" - } - }, - "com.amazonaws.securityhub#AwsIamPolicyDetails": { - "type": "structure", - "members": { - "AttachmentCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of users, groups, and roles that the policy is attached to.

" - } - }, - "CreateDate": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

When the policy was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "DefaultVersionId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the default version of the policy.

" - } - }, - "Description": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A description of the policy.

" - } - }, - "IsAttachable": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the policy can be attached to a user, group, or role.

" - } - }, - "Path": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The path to the policy.

" - } - }, - "PermissionsBoundaryUsageCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of users and roles that use the policy to set the permissions\n boundary.

" - } - }, - "PolicyId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The unique identifier of the policy.

" - } - }, - "PolicyName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the policy.

" - } - }, - "PolicyVersionList": { - "target": "com.amazonaws.securityhub#AwsIamPolicyVersionList", - "traits": { - "smithy.api#documentation": "

List of versions of the policy.

" - } - }, - "UpdateDate": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

When the policy was most recently updated.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents an IAM permissions policy.

" - } - }, - "com.amazonaws.securityhub#AwsIamPolicyVersion": { - "type": "structure", - "members": { - "VersionId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the policy version.

" - } - }, - "IsDefaultVersion": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the version is the default version.

" - } - }, - "CreateDate": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the version was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A version of an IAM policy.

" - } - }, - "com.amazonaws.securityhub#AwsIamPolicyVersionList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsIamPolicyVersion" - } - }, - "com.amazonaws.securityhub#AwsIamRoleAssumeRolePolicyDocument": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 131072 - }, - "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]+$" - } - }, - "com.amazonaws.securityhub#AwsIamRoleDetails": { - "type": "structure", - "members": { - "AssumeRolePolicyDocument": { - "target": "com.amazonaws.securityhub#AwsIamRoleAssumeRolePolicyDocument", - "traits": { - "smithy.api#documentation": "

The trust policy that grants permission to assume the role.

" - } - }, - "AttachedManagedPolicies": { - "target": "com.amazonaws.securityhub#AwsIamAttachedManagedPolicyList", - "traits": { - "smithy.api#documentation": "

The list of the managed policies that are attached to the role.

" - } - }, - "CreateDate": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the role was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "InstanceProfileList": { - "target": "com.amazonaws.securityhub#AwsIamInstanceProfileList", - "traits": { - "smithy.api#documentation": "

The list of instance profiles that contain this role.

" - } - }, - "PermissionsBoundary": { - "target": "com.amazonaws.securityhub#AwsIamPermissionsBoundary" - }, - "RoleId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The stable and unique string identifying the role.

" - } - }, - "RoleName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The friendly name that identifies the role.

" - } - }, - "RolePolicyList": { - "target": "com.amazonaws.securityhub#AwsIamRolePolicyList", - "traits": { - "smithy.api#documentation": "

The list of inline policies that are embedded in the role.

" - } - }, - "MaxSessionDuration": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum session duration (in seconds) that you want to set for the specified role.

" - } - }, - "Path": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The path to the role.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about an IAM role, including all of the role's policies.

" - } - }, - "com.amazonaws.securityhub#AwsIamRolePolicy": { - "type": "structure", - "members": { - "PolicyName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the policy.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An inline policy that is embedded in the role.

" - } - }, - "com.amazonaws.securityhub#AwsIamRolePolicyList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsIamRolePolicy" - } - }, - "com.amazonaws.securityhub#AwsIamUserDetails": { - "type": "structure", - "members": { - "AttachedManagedPolicies": { - "target": "com.amazonaws.securityhub#AwsIamAttachedManagedPolicyList", - "traits": { - "smithy.api#documentation": "

A list of the managed policies that are attached to the user.

" - } - }, - "CreateDate": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the user was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "GroupList": { - "target": "com.amazonaws.securityhub#StringList", - "traits": { - "smithy.api#documentation": "

A list of IAM groups that the user belongs to.

" - } - }, - "Path": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The path to the user.

" - } - }, - "PermissionsBoundary": { - "target": "com.amazonaws.securityhub#AwsIamPermissionsBoundary", - "traits": { - "smithy.api#documentation": "

The permissions boundary for the user.

" - } - }, - "UserId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The unique identifier for the user.

" - } - }, - "UserName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the user.

" - } - }, - "UserPolicyList": { - "target": "com.amazonaws.securityhub#AwsIamUserPolicyList", - "traits": { - "smithy.api#documentation": "

The list of inline policies that are embedded in the user.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about an IAM user.

" - } - }, - "com.amazonaws.securityhub#AwsIamUserPolicy": { - "type": "structure", - "members": { - "PolicyName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the policy.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about an inline policy that is embedded in the user.

" - } - }, - "com.amazonaws.securityhub#AwsIamUserPolicyList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsIamUserPolicy" - } - }, - "com.amazonaws.securityhub#AwsKinesisStreamDetails": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the Kinesis stream. If you don't specify a name, CloudFront generates a unique \nphysical ID and uses that ID for the stream name.\n

" - } - }, - "Arn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Kinesis data stream.\n

" - } - }, - "StreamEncryption": { - "target": "com.amazonaws.securityhub#AwsKinesisStreamStreamEncryptionDetails", - "traits": { - "smithy.api#documentation": "

When specified, enables or updates server-side encryption using an KMS key for a specified stream. \nRemoving this property from your stack template and updating your stack disables encryption.\n

" - } - }, - "ShardCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of shards that the stream uses. \n

" - } - }, - "RetentionPeriodHours": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of hours for the data records that are stored in shards to remain accessible. \n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about an Amazon Kinesis data stream.\n

" - } - }, - "com.amazonaws.securityhub#AwsKinesisStreamStreamEncryptionDetails": { - "type": "structure", - "members": { - "EncryptionType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The encryption type to use.\n

" - } - }, - "KeyId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The globally unique identifier for the customer-managed KMS key to use for encryption.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about stream encryption.\n

" - } - }, - "com.amazonaws.securityhub#AwsKmsKeyDetails": { - "type": "structure", - "members": { - "AWSAccountId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.

" - } - }, - "CreationDate": { - "target": "com.amazonaws.securityhub#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Indicates when the KMS key was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "KeyId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The globally unique identifier for the KMS key.

" - } - }, - "KeyManager": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed.

" - } - }, - "KeyState": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The state of the KMS key. Valid values are as follows:

\n " - } - }, - "Origin": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The source of the KMS key material.

\n

When this value is AWS_KMS, KMS created the key material.

\n

When this value is EXTERNAL, the key material was imported from your\n existing key management infrastructure or the KMS key lacks key material.

\n

When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated with a custom key store.

" - } - }, - "Description": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A description of the KMS key.

" - } - }, - "KeyRotationStatus": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the key has key rotation enabled.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains metadata about an KMS key.

" - } - }, - "com.amazonaws.securityhub#AwsLambdaFunctionCode": { - "type": "structure", - "members": { - "S3Bucket": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different Amazon Web Services account.

" - } - }, - "S3Key": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon S3 key of the deployment package.

" - } - }, - "S3ObjectVersion": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

For versioned objects, the version of the deployment package object to use.

" - } - }, - "ZipFile": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The base64-encoded contents of the deployment package. Amazon Web Services SDK and Amazon Web Services CLI clients handle the encoding for you.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The code for the Lambda function. You can specify either an object in Amazon S3, or upload a deployment package directly.

" - } - }, - "com.amazonaws.securityhub#AwsLambdaFunctionDeadLetterConfig": { - "type": "structure", - "members": { - "TargetArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of an SQS queue or SNS topic.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The dead-letter queue for failed asynchronous invocations.

" - } - }, - "com.amazonaws.securityhub#AwsLambdaFunctionDetails": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.securityhub#AwsLambdaFunctionCode", - "traits": { - "smithy.api#documentation": "

An AwsLambdaFunctionCode object.

" - } - }, - "CodeSha256": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The SHA256 hash of the function's deployment package.

" - } - }, - "DeadLetterConfig": { - "target": "com.amazonaws.securityhub#AwsLambdaFunctionDeadLetterConfig", - "traits": { - "smithy.api#documentation": "

The function's dead letter queue.

" - } - }, - "Environment": { - "target": "com.amazonaws.securityhub#AwsLambdaFunctionEnvironment", - "traits": { - "smithy.api#documentation": "

The function's environment variables.

" - } - }, - "FunctionName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the function.

" - } - }, - "Handler": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The function that Lambda calls to begin executing your function.

" - } - }, - "KmsKeyArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The KMS key that is used to encrypt the function's environment variables. This key is only returned if you've configured a customer managed customer managed key.

" - } - }, - "LastModified": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the function was last updated.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "Layers": { - "target": "com.amazonaws.securityhub#AwsLambdaFunctionLayerList", - "traits": { - "smithy.api#documentation": "

The function's layers.

" - } - }, - "MasterArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

For Lambda@Edge functions, the ARN of the master function.

" - } - }, - "MemorySize": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The memory that is allocated to the function.

" - } - }, - "RevisionId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The latest updated revision of the function or alias.

" - } - }, - "Role": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The function's execution role.

" - } - }, - "Runtime": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The runtime environment for the Lambda function.

" - } - }, - "Timeout": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The amount of time that Lambda allows a function to run before stopping it.

" - } - }, - "TracingConfig": { - "target": "com.amazonaws.securityhub#AwsLambdaFunctionTracingConfig", - "traits": { - "smithy.api#documentation": "

The function's X-Ray tracing configuration.

" - } - }, - "VpcConfig": { - "target": "com.amazonaws.securityhub#AwsLambdaFunctionVpcConfig", - "traits": { - "smithy.api#documentation": "

The function's networking configuration.

" - } - }, - "Version": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The version of the Lambda function.

" - } - }, - "Architectures": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The instruction set architecture that the function uses. Valid values are x86_64 or \narm64.

" - } - }, - "PackageType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of deployment package that's used to deploy the function code to Lambda. Set to Image for a container image and Zip for a .zip file archive.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about an Lambda function's configuration.

" - } - }, - "com.amazonaws.securityhub#AwsLambdaFunctionEnvironment": { - "type": "structure", - "members": { - "Variables": { - "target": "com.amazonaws.securityhub#FieldMap", - "traits": { - "smithy.api#documentation": "

Environment variable key-value pairs.

" - } - }, - "Error": { - "target": "com.amazonaws.securityhub#AwsLambdaFunctionEnvironmentError", - "traits": { - "smithy.api#documentation": "

An AwsLambdaFunctionEnvironmentError object.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A function's environment variable settings.

" - } - }, - "com.amazonaws.securityhub#AwsLambdaFunctionEnvironmentError": { - "type": "structure", - "members": { - "ErrorCode": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The error code.

" - } - }, - "Message": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The error message.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Error messages for environment variables that could not be applied.

" - } - }, - "com.amazonaws.securityhub#AwsLambdaFunctionLayer": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the function layer.

" - } - }, - "CodeSize": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The size of the layer archive in bytes.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An Lambda layer.

" - } - }, - "com.amazonaws.securityhub#AwsLambdaFunctionLayerList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsLambdaFunctionLayer" - } - }, - "com.amazonaws.securityhub#AwsLambdaFunctionTracingConfig": { - "type": "structure", - "members": { - "Mode": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The tracing mode.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The function's X-Ray tracing configuration.

" - } - }, - "com.amazonaws.securityhub#AwsLambdaFunctionVpcConfig": { - "type": "structure", - "members": { - "SecurityGroupIds": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

A list of VPC security groups IDs.

" - } - }, - "SubnetIds": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

A list of VPC subnet IDs.

" - } - }, - "VpcId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the VPC.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The VPC security groups and subnets that are attached to a Lambda function.

" - } - }, - "com.amazonaws.securityhub#AwsLambdaLayerVersionDetails": { - "type": "structure", - "members": { - "Version": { - "target": "com.amazonaws.securityhub#AwsLambdaLayerVersionNumber", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The version number.

" - } - }, - "CompatibleRuntimes": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The layer's compatible runtimes. Maximum number of five items.

\n

Valid values: nodejs10.x | nodejs12.x | java8 |\n java11 | python2.7 | python3.6 |\n python3.7 | python3.8 | dotnetcore1.0 |\n dotnetcore2.1 | go1.x | ruby2.5 |\n provided\n

" - } - }, - "CreatedDate": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the version was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about a Lambda layer version.

" - } - }, - "com.amazonaws.securityhub#AwsLambdaLayerVersionNumber": { - "type": "long", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.securityhub#AwsMountPoint": { - "type": "structure", - "members": { - "SourceVolume": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the volume to mount. Must be a volume name referenced in the name parameter \nof task definition volume.\n

" - } - }, - "ContainerPath": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The path on the container to mount the host volume at.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details for a volume mount point that's used in a container definition.\n

" - } - }, - "com.amazonaws.securityhub#AwsMountPointList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsMountPoint" - } - }, - "com.amazonaws.securityhub#AwsNetworkFirewallFirewallDetails": { - "type": "structure", - "members": { - "DeleteProtection": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the firewall is protected from deletion. If set to true, then the firewall cannot be deleted.

" - } - }, - "Description": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A description of the firewall.

" - } - }, - "FirewallArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the firewall.

" - } - }, - "FirewallId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the firewall.

" - } - }, - "FirewallName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A descriptive name of the firewall.

" - } - }, - "FirewallPolicyArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the firewall policy.

" - } - }, - "FirewallPolicyChangeProtection": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the firewall is protected from a change to the firewall policy. If set to true, you cannot associate a different policy with the firewall.

" - } - }, - "SubnetChangeProtection": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the firewall is protected from a change to the subnet associations. If set to true, you cannot map different subnets to the firewall.

" - } - }, - "SubnetMappings": { - "target": "com.amazonaws.securityhub#AwsNetworkFirewallFirewallSubnetMappingsList", - "traits": { - "smithy.api#documentation": "

The public subnets that Network Firewall uses for the firewall. Each subnet must belong to a different Availability Zone.

" - } - }, - "VpcId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the VPC where the firewall is used.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about an Network Firewall firewall.

" - } - }, - "com.amazonaws.securityhub#AwsNetworkFirewallFirewallPolicyDetails": { - "type": "structure", - "members": { - "FirewallPolicy": { - "target": "com.amazonaws.securityhub#FirewallPolicyDetails", - "traits": { - "smithy.api#documentation": "

The firewall policy configuration.

" - } - }, - "FirewallPolicyArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the firewall policy.

" - } - }, - "FirewallPolicyId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the firewall policy.

" - } - }, - "FirewallPolicyName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the firewall policy.

" - } - }, - "Description": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A description of the firewall policy.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about a firewall policy. A firewall policy defines the behavior of a network firewall.

" - } - }, - "com.amazonaws.securityhub#AwsNetworkFirewallFirewallSubnetMappingsDetails": { - "type": "structure", - "members": { - "SubnetId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the subnet

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A public subnet that Network Firewall uses for the firewall.

" - } - }, - "com.amazonaws.securityhub#AwsNetworkFirewallFirewallSubnetMappingsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsNetworkFirewallFirewallSubnetMappingsDetails" - } - }, - "com.amazonaws.securityhub#AwsNetworkFirewallRuleGroupDetails": { - "type": "structure", - "members": { - "Capacity": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of operating resources that this rule group can use.

" - } - }, - "Description": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A description of the rule group.

" - } - }, - "RuleGroup": { - "target": "com.amazonaws.securityhub#RuleGroupDetails", - "traits": { - "smithy.api#documentation": "

Details about the rule group.

" - } - }, - "RuleGroupArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the rule group.

" - } - }, - "RuleGroupId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the rule group.

" - } - }, - "RuleGroupName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The descriptive name of the rule group.

" - } - }, - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of rule group. A rule group can be stateful or stateless.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about an Network Firewall rule group. Rule groups are used to inspect and control network traffic. Stateless rule groups apply to individual packets. Stateful rule groups apply to packets in the context of their traffic flow.

\n

Rule groups are referenced in firewall policies.\n

" - } - }, - "com.amazonaws.securityhub#AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetails": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Enables fine-grained access control.\n

" - } - }, - "InternalUserDatabaseEnabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Enables the internal user database.\n

" - } - }, - "MasterUserOptions": { - "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainMasterUserOptionsDetails", - "traits": { - "smithy.api#documentation": "

Specifies information about the master user of the domain.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about domain access control options.\n

" - } - }, - "com.amazonaws.securityhub#AwsOpenSearchServiceDomainClusterConfigDetails": { - "type": "structure", - "members": { - "InstanceCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of data nodes to use in the OpenSearch domain.

" - } - }, - "WarmEnabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether UltraWarm is enabled.

" - } - }, - "WarmCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of UltraWarm instances.

" - } - }, - "DedicatedMasterEnabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether to use a dedicated master node for the OpenSearch domain. A dedicated master node performs cluster management tasks, but does not hold data or respond to data upload requests.

" - } - }, - "ZoneAwarenessConfig": { - "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails", - "traits": { - "smithy.api#documentation": "

Configuration options for zone awareness. Provided if ZoneAwarenessEnabled is true.

" - } - }, - "DedicatedMasterCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of instances to use for the master node. If this attribute is specified, then DedicatedMasterEnabled must be true.

" - } - }, - "InstanceType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The instance type for your data nodes.

\n

For a list of valid values, see Supported instance types in Amazon OpenSearch Service in the Amazon OpenSearch Service Developer Guide.

" - } - }, - "WarmType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of UltraWarm instance.

" - } - }, - "ZoneAwarenessEnabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether to enable zone awareness for the OpenSearch domain. When zone awareness is enabled, OpenSearch Service allocates the cluster's nodes and replica index shards across Availability Zones (AZs) in the same Region. This prevents data loss and minimizes downtime if a node or data center fails.

" - } - }, - "DedicatedMasterType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The hardware configuration of the computer that hosts the dedicated master node.

\n

If this attribute is specified, then DedicatedMasterEnabled must be true.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about the configuration of an OpenSearch cluster.

" - } - }, - "com.amazonaws.securityhub#AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails": { - "type": "structure", - "members": { - "AvailabilityZoneCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of Availability Zones that the domain uses. Valid values are 2 or 3. The default is 2.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Configuration options for zone awareness.

" - } - }, - "com.amazonaws.securityhub#AwsOpenSearchServiceDomainDetails": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the OpenSearch Service domain.

" - } - }, - "AccessPolicies": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

IAM policy document that specifies the access policies for the OpenSearch Service domain.

" - } - }, - "DomainName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the endpoint.

" - } - }, - "Id": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the domain.

" - } - }, - "DomainEndpoint": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The domain endpoint.

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The version of the domain engine.

" - } - }, - "EncryptionAtRestOptions": { - "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainEncryptionAtRestOptionsDetails", - "traits": { - "smithy.api#documentation": "

Details about the configuration for encryption at rest.

" - } - }, - "NodeToNodeEncryptionOptions": { - "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainNodeToNodeEncryptionOptionsDetails", - "traits": { - "smithy.api#documentation": "

Details about the configuration for node-to-node encryption.

" - } - }, - "ServiceSoftwareOptions": { - "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails", - "traits": { - "smithy.api#documentation": "

Information about the status of a domain relative to the latest service software.

" - } - }, - "ClusterConfig": { - "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainClusterConfigDetails", - "traits": { - "smithy.api#documentation": "

Details about the configuration of an OpenSearch cluster.

" - } - }, - "DomainEndpointOptions": { - "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainDomainEndpointOptionsDetails", - "traits": { - "smithy.api#documentation": "

Additional options for the domain endpoint.

" - } - }, - "VpcOptions": { - "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainVpcOptionsDetails", - "traits": { - "smithy.api#documentation": "

Information that OpenSearch Service derives based on VPCOptions for the domain.

" - } - }, - "LogPublishingOptions": { - "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainLogPublishingOptionsDetails", - "traits": { - "smithy.api#documentation": "

Configures the CloudWatch Logs to publish for the OpenSearch domain.

" - } - }, - "DomainEndpoints": { - "target": "com.amazonaws.securityhub#FieldMap", - "traits": { - "smithy.api#documentation": "

The domain endpoints. Used if the OpenSearch domain resides in a VPC.

\n

This is a map of key-value pairs. The key is always vpc. The value is the endpoint.

" - } - }, - "AdvancedSecurityOptions": { - "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetails", - "traits": { - "smithy.api#documentation": "

Specifies options for fine-grained access control.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about an Amazon OpenSearch Service domain.

" - } - }, - "com.amazonaws.securityhub#AwsOpenSearchServiceDomainDomainEndpointOptionsDetails": { - "type": "structure", - "members": { - "CustomEndpointCertificateArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN for the security certificate. The certificate is managed in ACM.

" - } - }, - "CustomEndpointEnabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether to enable a custom endpoint for the domain.

" - } - }, - "EnforceHTTPS": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether to require that all traffic to the domain arrive over HTTPS.

" - } - }, - "CustomEndpoint": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The fully qualified URL for the custom endpoint.

" - } - }, - "TLSSecurityPolicy": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The TLS security policy to apply to the HTTPS endpoint of the OpenSearch domain.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about additional options for the domain endpoint.

" - } - }, - "com.amazonaws.securityhub#AwsOpenSearchServiceDomainEncryptionAtRestOptionsDetails": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether encryption at rest is enabled.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The KMS key ID.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about the configuration for encryption at rest for the OpenSearch domain.

" - } - }, - "com.amazonaws.securityhub#AwsOpenSearchServiceDomainLogPublishingOption": { - "type": "structure", - "members": { - "CloudWatchLogsLogGroupArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the CloudWatch Logs group to publish the logs to.

" - } - }, - "Enabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the log publishing is enabled.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Configuration details for a log publishing option.

" - } - }, - "com.amazonaws.securityhub#AwsOpenSearchServiceDomainLogPublishingOptionsDetails": { - "type": "structure", - "members": { - "IndexSlowLogs": { - "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainLogPublishingOption", - "traits": { - "smithy.api#documentation": "

Configures the OpenSearch index logs publishing.

" - } - }, - "SearchSlowLogs": { - "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainLogPublishingOption", - "traits": { - "smithy.api#documentation": "

Configures the OpenSearch search slow log publishing.

" - } - }, - "AuditLogs": { - "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainLogPublishingOption", - "traits": { - "smithy.api#documentation": "

Configures the OpenSearch audit logs publishing.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Configures the CloudWatch Logs to publish for the OpenSearch domain.

" - } - }, - "com.amazonaws.securityhub#AwsOpenSearchServiceDomainMasterUserOptionsDetails": { - "type": "structure", - "members": { - "MasterUserArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the master user.\n

" - } - }, - "MasterUserName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The username for the master user.\n

" - } - }, - "MasterUserPassword": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The password for the master user.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies information about the master user of the domain.\n

" - } - }, - "com.amazonaws.securityhub#AwsOpenSearchServiceDomainNodeToNodeEncryptionOptionsDetails": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether node-to-node encryption is enabled.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides details about the configuration for node-to-node encryption.

" - } - }, - "com.amazonaws.securityhub#AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails": { - "type": "structure", - "members": { - "AutomatedUpdateDate": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The epoch time when the deployment window closes for required updates. After this time, OpenSearch Service schedules the software upgrade automatically.

" - } - }, - "Cancellable": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether a request to update the domain can be canceled.

" - } - }, - "CurrentVersion": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The version of the service software that is currently installed on the domain.

" - } - }, - "Description": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A more detailed description of the service software status.

" - } - }, - "NewVersion": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The most recent version of the service software.

" - } - }, - "UpdateAvailable": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether a service software update is available for the domain.

" - } - }, - "UpdateStatus": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The status of the service software update. Valid values are as follows:

\n " - } - }, - "OptionalDeployment": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the service software update is optional.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about the state of the domain relative to the latest service software.

" - } - }, - "com.amazonaws.securityhub#AwsOpenSearchServiceDomainVpcOptionsDetails": { - "type": "structure", - "members": { - "SecurityGroupIds": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The list of security group IDs that are associated with the VPC endpoints for the domain.

" - } - }, - "SubnetIds": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

A list of subnet IDs that are associated with the VPC endpoints for the domain.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information that OpenSearch Service derives based on the VPCOptions for the domain.

" - } - }, - "com.amazonaws.securityhub#AwsRdsDbClusterAssociatedRole": { - "type": "structure", - "members": { - "RoleArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the IAM role.

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The status of the association between the IAM role and the DB cluster. Valid values are as follows:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

An IAM role that is associated with the Amazon RDS DB cluster.

" - } - }, - "com.amazonaws.securityhub#AwsRdsDbClusterAssociatedRoles": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsRdsDbClusterAssociatedRole" - } - }, - "com.amazonaws.securityhub#AwsRdsDbClusterDetails": { - "type": "structure", - "members": { - "AllocatedStorage": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

For all database engines except Aurora, specifies the allocated storage size in\n gibibytes (GiB).

" - } - }, - "AvailabilityZones": { - "target": "com.amazonaws.securityhub#StringList", - "traits": { - "smithy.api#documentation": "

A list of Availability Zones (AZs) where instances in the DB cluster can be\n created.

" - } - }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of days for which automated backups are retained.

" - } - }, - "DatabaseName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the database.

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The current status of this DB cluster.

" - } - }, - "Endpoint": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The connection endpoint for the primary instance of the DB cluster.

" - } - }, - "ReaderEndpoint": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The reader endpoint for the DB cluster.

" - } - }, - "CustomEndpoints": { - "target": "com.amazonaws.securityhub#StringList", - "traits": { - "smithy.api#documentation": "

A list of custom endpoints for the DB cluster.

" - } - }, - "MultiAz": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the DB cluster has instances in multiple Availability Zones.

" - } - }, - "Engine": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the database engine to use for this DB cluster. Valid values are as follows:

\n " - } - }, - "EngineVersion": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The version number of the database engine to use.

" - } - }, - "Port": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The port number on which the DB instances in the DB cluster accept connections.

" - } - }, - "MasterUsername": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the master user for the DB cluster.

" - } - }, - "PreferredBackupWindow": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The range of time each day when automated backups are created, if automated backups are\n enabled.

\n

Uses the format HH:MM-HH:MM. For example, 04:52-05:22.

" - } - }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal\n Coordinated Time (UTC).

\n

Uses the format :HH:MM-:HH:MM.

\n

For the day values, use\n mon|tue|wed|thu|fri|sat|sun.

\n

For example, sun:09:32-sun:10:02.

" - } - }, - "ReadReplicaIdentifiers": { - "target": "com.amazonaws.securityhub#StringList", - "traits": { - "smithy.api#documentation": "

The identifiers of the read replicas that are associated with this DB cluster.

" - } - }, - "VpcSecurityGroups": { - "target": "com.amazonaws.securityhub#AwsRdsDbInstanceVpcSecurityGroups", - "traits": { - "smithy.api#documentation": "

A list of VPC security groups that the DB cluster belongs to.

" - } - }, - "HostedZoneId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Specifies the identifier that Amazon Route 53 assigns when you create a hosted\n zone.

" - } - }, - "StorageEncrypted": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the DB cluster is encrypted.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the KMS master key that is used to encrypt the database instances in the\n DB cluster.

" - } - }, - "DbClusterResourceId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the DB cluster. The identifier must be unique within each Amazon Web Services Region\n and is immutable.

" - } - }, - "AssociatedRoles": { - "target": "com.amazonaws.securityhub#AwsRdsDbClusterAssociatedRoles", - "traits": { - "smithy.api#documentation": "

A list of the IAM roles that are associated with the DB cluster.

" - } - }, - "ClusterCreateTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the DB cluster was created, in Universal Coordinated Time (UTC).

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "EnabledCloudWatchLogsExports": { - "target": "com.amazonaws.securityhub#StringList", - "traits": { - "smithy.api#documentation": "

A list of log types that this DB cluster is configured to export to CloudWatch\n Logs.

" - } - }, - "EngineMode": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The database engine mode of the DB cluster.Valid values are as follows:

\n " - } - }, - "DeletionProtection": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the DB cluster has deletion protection enabled.

" - } - }, - "HttpEndpointEnabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

" - } - }, - "ActivityStreamStatus": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The status of the database activity stream. Valid values are as follows:

\n " - } - }, - "CopyTagsToSnapshot": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether tags are copied from the DB cluster to snapshots of the DB cluster.

" - } - }, - "CrossAccountClone": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services\n account.

" - } - }, - "DomainMemberships": { - "target": "com.amazonaws.securityhub#AwsRdsDbDomainMemberships", - "traits": { - "smithy.api#documentation": "

The Active Directory domain membership records that are associated with the DB\n cluster.

" - } - }, - "DbClusterParameterGroup": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group for the DB cluster.

" - } - }, - "DbSubnetGroup": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The subnet group that is associated with the DB cluster, including the name,\n description, and subnets in the subnet group.

" - } - }, - "DbClusterOptionGroupMemberships": { - "target": "com.amazonaws.securityhub#AwsRdsDbClusterOptionGroupMemberships", - "traits": { - "smithy.api#documentation": "

The list of option group memberships for this DB cluster.

" - } - }, - "DbClusterIdentifier": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The DB cluster identifier that the user assigned to the cluster. This identifier is the\n unique key that identifies a DB cluster.

" - } - }, - "DbClusterMembers": { - "target": "com.amazonaws.securityhub#AwsRdsDbClusterMembers", - "traits": { - "smithy.api#documentation": "

The list of instances that make up the DB cluster.

" - } - }, - "IamDatabaseAuthenticationEnabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the mapping of IAM accounts to database accounts is enabled.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about an Amazon RDS DB cluster.

" - } - }, - "com.amazonaws.securityhub#AwsRdsDbClusterMember": { - "type": "structure", - "members": { - "IsClusterWriter": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the cluster member is the primary instance for the DB cluster.

" - } - }, - "PromotionTier": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies the order in which an Aurora replica is promoted to the primary instance when\n the existing primary instance fails.

" - } - }, - "DbInstanceIdentifier": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The instance identifier for this member of the DB cluster.

" - } - }, - "DbClusterParameterGroupStatus": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The status of the DB cluster parameter group for this member of the DB cluster.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about an instance in the DB cluster.

" - } - }, - "com.amazonaws.securityhub#AwsRdsDbClusterMembers": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsRdsDbClusterMember" - } - }, - "com.amazonaws.securityhub#AwsRdsDbClusterOptionGroupMembership": { - "type": "structure", - "members": { - "DbClusterOptionGroupName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the DB cluster option group.

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The status of the DB cluster option group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about an option group membership for a DB cluster.

" - } - }, - "com.amazonaws.securityhub#AwsRdsDbClusterOptionGroupMemberships": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsRdsDbClusterOptionGroupMembership" - } - }, - "com.amazonaws.securityhub#AwsRdsDbClusterSnapshotDetails": { - "type": "structure", - "members": { - "AvailabilityZones": { - "target": "com.amazonaws.securityhub#StringList", - "traits": { - "smithy.api#documentation": "

A list of Availability Zones where instances in the DB cluster can be created.

" - } - }, - "SnapshotCreateTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the snapshot was taken.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "Engine": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the database engine that you want to use for this DB instance.

" - } - }, - "AllocatedStorage": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies the allocated storage size in gibibytes (GiB).

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The status of this DB cluster snapshot.

" - } - }, - "Port": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The port number on which the DB instances in the DB cluster accept connections.

" - } - }, - "VpcId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The VPC ID that is associated with the DB cluster snapshot.

" - } - }, - "ClusterCreateTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the DB cluster was created, in Universal Coordinated Time (UTC).

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "MasterUsername": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the master user for the DB cluster.

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The version of the database engine to use.

" - } - }, - "LicenseModel": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The license model information for this DB cluster snapshot.

" - } - }, - "SnapshotType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of DB cluster snapshot.

" - } - }, - "PercentProgress": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies the percentage of the estimated data that has been transferred.

" - } - }, - "StorageEncrypted": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the DB cluster is encrypted.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the KMS master key that is used to encrypt the database instances in the\n DB cluster.

" - } - }, - "DbClusterIdentifier": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The DB cluster identifier.

" - } - }, - "DbClusterSnapshotIdentifier": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the DB cluster snapshot.

" - } - }, - "IamDatabaseAuthenticationEnabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether mapping of IAM accounts to database accounts is enabled.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about an Amazon RDS DB cluster snapshot.

" - } - }, - "com.amazonaws.securityhub#AwsRdsDbDomainMembership": { - "type": "structure", - "members": { - "Domain": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the Active Directory domain.

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The status of the Active Directory Domain membership for the DB instance.

" - } - }, - "Fqdn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The fully qualified domain name of the Active Directory domain.

" - } - }, - "IamRoleName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the IAM role to use when making API calls to the Directory Service.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about an Active Directory domain membership record associated with the DB\n instance.

" - } - }, - "com.amazonaws.securityhub#AwsRdsDbDomainMemberships": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsRdsDbDomainMembership" - } - }, - "com.amazonaws.securityhub#AwsRdsDbInstanceAssociatedRole": { - "type": "structure", - "members": { - "RoleArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the IAM role that is associated with the DB\n instance.

" - } - }, - "FeatureName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the feature associated with the IAM role.

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Describes the state of the association between the IAM role and the DB instance. The\n Status property returns one of the following values:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

An IAM role associated with the DB instance.

" - } - }, - "com.amazonaws.securityhub#AwsRdsDbInstanceAssociatedRoles": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsRdsDbInstanceAssociatedRole" - } - }, - "com.amazonaws.securityhub#AwsRdsDbInstanceDetails": { - "type": "structure", - "members": { - "AssociatedRoles": { - "target": "com.amazonaws.securityhub#AwsRdsDbInstanceAssociatedRoles", - "traits": { - "smithy.api#documentation": "

The IAM roles associated with the DB\n instance.

" - } - }, - "CACertificateIdentifier": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the CA certificate for this DB instance.

" - } - }, - "DBClusterIdentifier": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that\n the DB instance is a member of.

" - } - }, - "DBInstanceIdentifier": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Contains a user-supplied database identifier. This identifier is the unique key that\n identifies a DB instance.

" - } - }, - "DBInstanceClass": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Contains the name of the compute and memory capacity class of the DB instance.

" - } - }, - "DbInstancePort": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies the port that the DB instance listens on. If the DB instance is part of a DB\n cluster, this can be a different port than the DB cluster port.

" - } - }, - "DbiResourceId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is\n found in CloudTrail log entries whenever the KMS key for the DB instance is\n accessed.

" - } - }, - "DBName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The meaning of this parameter differs according to the database engine you use.

\n

\n MySQL, MariaDB, SQL Server, PostgreSQL\n

\n

Contains the name of the initial database of this instance that was provided at create\n time, if one was specified when the DB instance was created. This same name is returned for\n the life of the DB instance.

\n

\n Oracle\n

\n

Contains the Oracle System ID (SID) of the created DB instance. Not shown when the\n returned parameters do not apply to an Oracle DB instance.

" - } - }, - "DeletionProtection": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the DB instance has deletion protection enabled.

\n

When deletion protection is enabled, the database cannot be deleted.

" - } - }, - "Endpoint": { - "target": "com.amazonaws.securityhub#AwsRdsDbInstanceEndpoint", - "traits": { - "smithy.api#documentation": "

Specifies the connection endpoint.

" - } - }, - "Engine": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Provides the name of the database engine to use for this DB instance.

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates the database engine version.

" - } - }, - "IAMDatabaseAuthenticationEnabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

True if mapping of IAM accounts to database\n accounts is enabled, and otherwise false.

\n

IAM database authentication can be enabled for the following database engines.

\n " - } - }, - "InstanceCreateTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the DB instance was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

If StorageEncrypted is true, the KMS key identifier for the encrypted\n DB instance.

" - } - }, - "PubliclyAccessible": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies the accessibility options for the DB instance.

\n

A value of true specifies an Internet-facing instance with a publicly resolvable DNS\n name, which resolves to a public IP address.

\n

A value of false specifies an internal instance with a DNS name that resolves to a\n private IP address.

" - } - }, - "StorageEncrypted": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether the DB instance is encrypted.

" - } - }, - "TdeCredentialArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN from the key store with which the instance is associated for TDE\n encryption.

" - } - }, - "VpcSecurityGroups": { - "target": "com.amazonaws.securityhub#AwsRdsDbInstanceVpcSecurityGroups", - "traits": { - "smithy.api#documentation": "

A list of VPC security groups that the DB instance belongs to.

" - } - }, - "MultiAz": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the DB instance is a multiple Availability Zone deployment.

" - } - }, - "EnhancedMonitoringResourceArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the CloudWatch Logs log stream that receives the enhanced monitoring metrics\n data for the DB instance.

" - } - }, - "DbInstanceStatus": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The current status of the DB instance.

" - } - }, - "MasterUsername": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The master user name of the DB instance.

" - } - }, - "AllocatedStorage": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The amount of storage (in gigabytes) to initially allocate for the DB instance.

" - } - }, - "PreferredBackupWindow": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The range of time each day when automated backups are created, if automated backups are\n enabled.

\n

Uses the format HH:MM-HH:MM. For example, 04:52-05:22.

" - } - }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of days for which to retain automated backups.

" - } - }, - "DbSecurityGroups": { - "target": "com.amazonaws.securityhub#StringList", - "traits": { - "smithy.api#documentation": "

A list of the DB security groups to assign to the DB instance.

" - } - }, - "DbParameterGroups": { - "target": "com.amazonaws.securityhub#AwsRdsDbParameterGroups", - "traits": { - "smithy.api#documentation": "

A list of the DB parameter groups to assign to the DB instance.

" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Availability Zone where the DB instance will be created.

" - } - }, - "DbSubnetGroup": { - "target": "com.amazonaws.securityhub#AwsRdsDbSubnetGroup", - "traits": { - "smithy.api#documentation": "

Information about the subnet group that is associated with the DB instance.

" - } - }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal\n Coordinated Time (UTC).

\n

Uses the format :HH:MM-:HH:MM.

\n

For the day values, use\n mon|tue|wed|thu|fri|sat|sun.

\n

For example, sun:09:32-sun:10:02.

" - } - }, - "PendingModifiedValues": { - "target": "com.amazonaws.securityhub#AwsRdsDbPendingModifiedValues", - "traits": { - "smithy.api#documentation": "

Changes to the DB instance that are currently pending.

" - } - }, - "LatestRestorableTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Specifies the latest time to which a database can be restored with point-in-time\n restore.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether minor version patches are applied automatically.

" - } - }, - "ReadReplicaSourceDBInstanceIdentifier": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

If this DB instance is a read replica, contains the identifier of the source DB\n instance.

" - } - }, - "ReadReplicaDBInstanceIdentifiers": { - "target": "com.amazonaws.securityhub#StringList", - "traits": { - "smithy.api#documentation": "

List of identifiers of the read replicas associated with this DB instance.

" - } - }, - "ReadReplicaDBClusterIdentifiers": { - "target": "com.amazonaws.securityhub#StringList", - "traits": { - "smithy.api#documentation": "

List of identifiers of Aurora DB clusters to which the RDS DB instance is replicated as\n a read replica.

" - } - }, - "LicenseModel": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

License model information for this DB instance.

" - } - }, - "Iops": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies the provisioned IOPS (I/O operations per second) for this DB instance.

" - } - }, - "OptionGroupMemberships": { - "target": "com.amazonaws.securityhub#AwsRdsDbOptionGroupMemberships", - "traits": { - "smithy.api#documentation": "

The list of option group memberships for this DB instance.

" - } - }, - "CharacterSetName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the character set that this DB instance is associated with.

" - } - }, - "SecondaryAvailabilityZone": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

For a DB instance with multi-Availability Zone support, the name of the secondary\n Availability Zone.

" - } - }, - "StatusInfos": { - "target": "com.amazonaws.securityhub#AwsRdsDbStatusInfos", - "traits": { - "smithy.api#documentation": "

The status of a read replica. If the instance isn't a read replica, this is\n empty.

" - } - }, - "StorageType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The storage type for the DB instance.

" - } - }, - "DomainMemberships": { - "target": "com.amazonaws.securityhub#AwsRdsDbDomainMemberships", - "traits": { - "smithy.api#documentation": "

The Active Directory domain membership records associated with the DB instance.

" - } - }, - "CopyTagsToSnapshot": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether to copy resource tags to snapshots of the DB instance.

" - } - }, - "MonitoringInterval": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The interval, in seconds, between points when enhanced monitoring metrics are collected\n for the DB instance.

" - } - }, - "MonitoringRoleArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN for the IAM role that permits Amazon RDS to send enhanced monitoring metrics to\n CloudWatch Logs.

" - } - }, - "PromotionTier": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The order in which to promote an Aurora replica to the primary instance after a failure\n of the existing primary instance.

" - } - }, - "Timezone": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The time zone of the DB instance.

" - } - }, - "PerformanceInsightsEnabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether Performance Insights is enabled for the DB instance.

" - } - }, - "PerformanceInsightsKmsKeyId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the KMS key used to encrypt the Performance Insights data.

" - } - }, - "PerformanceInsightsRetentionPeriod": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of days to retain Performance Insights data.

" - } - }, - "EnabledCloudWatchLogsExports": { - "target": "com.amazonaws.securityhub#StringList", - "traits": { - "smithy.api#documentation": "

A list of log types that this DB instance is configured to export to CloudWatch Logs.

" - } - }, - "ProcessorFeatures": { - "target": "com.amazonaws.securityhub#AwsRdsDbProcessorFeatures", - "traits": { - "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of\n the DB instance.

" - } - }, - "ListenerEndpoint": { - "target": "com.amazonaws.securityhub#AwsRdsDbInstanceEndpoint" - }, - "MaxAllocatedStorage": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The upper limit to which Amazon RDS can automatically scale the storage of the DB\n instance.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the details of an Amazon RDS DB instance.

" - } - }, - "com.amazonaws.securityhub#AwsRdsDbInstanceEndpoint": { - "type": "structure", - "members": { - "Address": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Specifies the DNS address of the DB instance.

" - } - }, - "Port": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies the port that the database engine is listening on.

" - } - }, - "HostedZoneId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the connection endpoint.

" - } - }, - "com.amazonaws.securityhub#AwsRdsDbInstanceVpcSecurityGroup": { - "type": "structure", - "members": { - "VpcSecurityGroupId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the VPC security group.

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The status of the VPC security group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A VPC security groups that the DB instance belongs to.

" - } - }, - "com.amazonaws.securityhub#AwsRdsDbInstanceVpcSecurityGroups": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsRdsDbInstanceVpcSecurityGroup" - } - }, - "com.amazonaws.securityhub#AwsRdsDbOptionGroupMembership": { - "type": "structure", - "members": { - "OptionGroupName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the option group.

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The status of the option group membership.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An option group membership.

" - } - }, - "com.amazonaws.securityhub#AwsRdsDbOptionGroupMemberships": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsRdsDbOptionGroupMembership" - } - }, - "com.amazonaws.securityhub#AwsRdsDbParameterGroup": { - "type": "structure", - "members": { - "DbParameterGroupName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the parameter group.

" - } - }, - "ParameterApplyStatus": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The status of parameter updates.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about a parameter group for a DB instance.

" - } - }, - "com.amazonaws.securityhub#AwsRdsDbParameterGroups": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsRdsDbParameterGroup" - } - }, - "com.amazonaws.securityhub#AwsRdsDbPendingModifiedValues": { - "type": "structure", - "members": { - "DbInstanceClass": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The new DB instance class for the DB instance.

" - } - }, - "AllocatedStorage": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The new value of the allocated storage for the DB instance.

" - } - }, - "MasterUserPassword": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The new master user password for the DB instance.

" - } - }, - "Port": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The new port for the DB instance.

" - } - }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The new backup retention period for the DB instance.

" - } - }, - "MultiAZ": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates that a single Availability Zone DB instance is changing to a multiple Availability Zone deployment.

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The new engine version for the DB instance.

" - } - }, - "LicenseModel": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The new license model value for the DB instance.

" - } - }, - "Iops": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The new provisioned IOPS value for the DB instance.

" - } - }, - "DbInstanceIdentifier": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The new DB instance identifier for the DB instance.

" - } - }, - "StorageType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The new storage type for the DB instance.

" - } - }, - "CaCertificateIdentifier": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The new CA certificate identifier for the DB instance.

" - } - }, - "DbSubnetGroupName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the new subnet group for the DB instance.

" - } - }, - "PendingCloudWatchLogsExports": { - "target": "com.amazonaws.securityhub#AwsRdsPendingCloudWatchLogsExports", - "traits": { - "smithy.api#documentation": "

A list of log types that are being enabled or disabled.

" - } - }, - "ProcessorFeatures": { - "target": "com.amazonaws.securityhub#AwsRdsDbProcessorFeatures", - "traits": { - "smithy.api#documentation": "

Processor features that are being updated.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Changes to a DB instance that are currently pending.

" - } - }, - "com.amazonaws.securityhub#AwsRdsDbProcessorFeature": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the processor feature. Valid values are coreCount or threadsPerCore.

" - } - }, - "Value": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The value of the processor feature.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A processor feature.

" - } - }, - "com.amazonaws.securityhub#AwsRdsDbProcessorFeatures": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsRdsDbProcessorFeature" - } - }, - "com.amazonaws.securityhub#AwsRdsDbSecurityGroupDetails": { - "type": "structure", - "members": { - "DbSecurityGroupArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN for the DB security group.

" - } - }, - "DbSecurityGroupDescription": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Provides the description of the DB security group.

" - } - }, - "DbSecurityGroupName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Specifies the name of the DB security group.

" - } - }, - "Ec2SecurityGroups": { - "target": "com.amazonaws.securityhub#AwsRdsDbSecurityGroupEc2SecurityGroups", - "traits": { - "smithy.api#documentation": "

Contains a list of EC2 security groups.

" - } - }, - "IpRanges": { - "target": "com.amazonaws.securityhub#AwsRdsDbSecurityGroupIpRanges", - "traits": { - "smithy.api#documentation": "

Contains a list of IP ranges.

" - } - }, - "OwnerId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Provides the Amazon Web Services ID of the owner of a specific DB security group.

" - } - }, - "VpcId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Provides VPC ID associated with the DB security group.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about an Amazon RDS DB security group.

" - } - }, - "com.amazonaws.securityhub#AwsRdsDbSecurityGroupEc2SecurityGroup": { - "type": "structure", - "members": { - "Ec2SecurityGroupId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Specifies the ID for the EC2 security group.

" - } - }, - "Ec2SecurityGroupName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Specifies the name of the EC2 security group.

" - } - }, - "Ec2SecurityGroupOwnerId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Provides the Amazon Web Services ID of the owner of the EC2 security group.

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Provides the status of the EC2 security group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

EC2 security group information for an RDS DB security group.

" - } - }, - "com.amazonaws.securityhub#AwsRdsDbSecurityGroupEc2SecurityGroups": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsRdsDbSecurityGroupEc2SecurityGroup" - } - }, - "com.amazonaws.securityhub#AwsRdsDbSecurityGroupIpRange": { - "type": "structure", - "members": { - "CidrIp": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Specifies the IP range.

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Specifies the status of the IP range.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

IP range information for an RDS DB security group.

" - } - }, - "com.amazonaws.securityhub#AwsRdsDbSecurityGroupIpRanges": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsRdsDbSecurityGroupIpRange" - } - }, - "com.amazonaws.securityhub#AwsRdsDbSnapshotDetails": { - "type": "structure", - "members": { - "DbSnapshotIdentifier": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name or ARN of the DB snapshot that is used to restore the DB instance.

" - } - }, - "DbInstanceIdentifier": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A name for the DB instance.

" - } - }, - "SnapshotCreateTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

When the snapshot was taken in Coordinated Universal Time (UTC).

" - } - }, - "Engine": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the database engine to use for this DB instance. Valid values are as follows:

\n " - } - }, - "AllocatedStorage": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The amount of storage (in gigabytes) to be initially allocated for the database instance.

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The status of this DB snapshot.

" - } - }, - "Port": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The port that the database engine was listening on at the time of the snapshot.

" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Specifies the name of the Availability Zone in which the DB instance was located at the time of the DB snapshot.

" - } - }, - "VpcId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The VPC ID associated with the DB snapshot.

" - } - }, - "InstanceCreateTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.

" - } - }, - "MasterUsername": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The master user name for the DB snapshot.

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The version of the database engine.

" - } - }, - "LicenseModel": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

License model information for the restored DB instance.

" - } - }, - "SnapshotType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of the DB snapshot.

" - } - }, - "Iops": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

" - } - }, - "OptionGroupName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The option group name for the DB snapshot.

" - } - }, - "PercentProgress": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The percentage of the estimated data that has been transferred.

" - } - }, - "SourceRegion": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region that the DB snapshot was created in or copied from.

" - } - }, - "SourceDbSnapshotIdentifier": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The DB snapshot ARN that the DB snapshot was copied from.

" - } - }, - "StorageType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The storage type associated with the DB snapshot. Valid values are as follows:

\n " - } - }, - "TdeCredentialArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

" - } - }, - "Encrypted": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the DB snapshot is encrypted.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

If Encrypted is true, the KMS key identifier for the encrypted DB snapshot.

" - } - }, - "Timezone": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The time zone of the DB snapshot.

" - } - }, - "IamDatabaseAuthenticationEnabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether mapping of IAM accounts to database accounts is enabled.

" - } - }, - "ProcessorFeatures": { - "target": "com.amazonaws.securityhub#AwsRdsDbProcessorFeatures", - "traits": { - "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

" - } - }, - "DbiResourceId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier for the source DB instance.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides details about an Amazon RDS DB cluster snapshot.

" - } - }, - "com.amazonaws.securityhub#AwsRdsDbStatusInfo": { - "type": "structure", - "members": { - "StatusType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of status. For a read replica, the status type is read replication.

" - } - }, - "Normal": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the read replica instance is operating normally.

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The status of the read replica instance.

" - } - }, - "Message": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

If the read replica is currently in an error state, provides the error details.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the status of a read replica.

" - } - }, - "com.amazonaws.securityhub#AwsRdsDbStatusInfos": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsRdsDbStatusInfo" - } - }, - "com.amazonaws.securityhub#AwsRdsDbSubnetGroup": { - "type": "structure", - "members": { - "DbSubnetGroupName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the subnet group.

" - } - }, - "DbSubnetGroupDescription": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The description of the subnet group.

" - } - }, - "VpcId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The VPC ID of the subnet group.

" - } - }, - "SubnetGroupStatus": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The status of the subnet group.

" - } - }, - "Subnets": { - "target": "com.amazonaws.securityhub#AwsRdsDbSubnetGroupSubnets", - "traits": { - "smithy.api#documentation": "

A list of subnets in the subnet group.

" - } - }, - "DbSubnetGroupArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the subnet group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the subnet group for the database instance.

" - } - }, - "com.amazonaws.securityhub#AwsRdsDbSubnetGroupSubnet": { - "type": "structure", - "members": { - "SubnetIdentifier": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of a subnet in the subnet group.

" - } - }, - "SubnetAvailabilityZone": { - "target": "com.amazonaws.securityhub#AwsRdsDbSubnetGroupSubnetAvailabilityZone", - "traits": { - "smithy.api#documentation": "

Information about the Availability Zone for a subnet in the subnet group.

" - } - }, - "SubnetStatus": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The status of a subnet in the subnet group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a subnet in a subnet group.

" - } - }, - "com.amazonaws.securityhub#AwsRdsDbSubnetGroupSubnetAvailabilityZone": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the Availability Zone for a subnet in the subnet group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An Availability Zone for a subnet in a subnet group.

" - } - }, - "com.amazonaws.securityhub#AwsRdsDbSubnetGroupSubnets": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsRdsDbSubnetGroupSubnet" - } - }, - "com.amazonaws.securityhub#AwsRdsEventSubscriptionDetails": { - "type": "structure", - "members": { - "CustSubscriptionId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the account that is associated with the event notification subscription.

" - } - }, - "CustomerAwsId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the event notification subscription.

" - } - }, - "Enabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the event notification subscription is enabled.

" - } - }, - "EventCategoriesList": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The list of event categories for the event notification subscription.

" - } - }, - "EventSubscriptionArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the event notification subscription.

" - } - }, - "SnsTopicArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the SNS topic to post the event notifications to.

" - } - }, - "SourceIdsList": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

A list of source identifiers for the event notification subscription.

" - } - }, - "SourceType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The source type for the event notification subscription.

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The status of the event notification subscription.

\n

Valid values: creating | modifying | deleting | active | no-permission | topic-not-exist\n

" - } - }, - "SubscriptionCreationTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The datetime when the event notification subscription was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about an Amazon RDS event notification subscription. The subscription allows Amazon RDS to post events to an SNS topic.

" - } - }, - "com.amazonaws.securityhub#AwsRdsPendingCloudWatchLogsExports": { - "type": "structure", - "members": { - "LogTypesToEnable": { - "target": "com.amazonaws.securityhub#StringList", - "traits": { - "smithy.api#documentation": "

A list of log types that are being enabled.

" - } - }, - "LogTypesToDisable": { - "target": "com.amazonaws.securityhub#StringList", - "traits": { - "smithy.api#documentation": "

A list of log types that are being disabled.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Identifies the log types to enable and disable.

" - } - }, - "com.amazonaws.securityhub#AwsRedshiftClusterClusterNode": { - "type": "structure", - "members": { - "NodeRole": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The role of the node. A node might be a leader node or a compute node.

" - } - }, - "PrivateIpAddress": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The private IP address of the node.

" - } - }, - "PublicIpAddress": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The public IP address of the node.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A node in an Amazon Redshift cluster.

" - } - }, - "com.amazonaws.securityhub#AwsRedshiftClusterClusterNodes": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsRedshiftClusterClusterNode" - } - }, - "com.amazonaws.securityhub#AwsRedshiftClusterClusterParameterGroup": { - "type": "structure", - "members": { - "ClusterParameterStatusList": { - "target": "com.amazonaws.securityhub#AwsRedshiftClusterClusterParameterStatusList", - "traits": { - "smithy.api#documentation": "

The list of parameter statuses.

" - } - }, - "ParameterApplyStatus": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The status of updates to the parameters.

" - } - }, - "ParameterGroupName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the parameter group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A cluster parameter group that is associated with an Amazon Redshift cluster.

" - } - }, - "com.amazonaws.securityhub#AwsRedshiftClusterClusterParameterGroups": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsRedshiftClusterClusterParameterGroup" - } - }, - "com.amazonaws.securityhub#AwsRedshiftClusterClusterParameterStatus": { - "type": "structure", - "members": { - "ParameterName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the parameter.

" - } - }, - "ParameterApplyStatus": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The status of the parameter. Indicates whether the parameter is in sync with the\n database, waiting for a cluster reboot, or encountered an error when it was applied.

\n

Valid values: in-sync | pending-reboot | applying\n | invalid-parameter | apply-deferred | apply-error |\n unknown-error\n

" - } - }, - "ParameterApplyErrorDescription": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The error that prevented the parameter from being applied to the database.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The status of a parameter in a cluster parameter group for an Amazon Redshift\n cluster.

" - } - }, - "com.amazonaws.securityhub#AwsRedshiftClusterClusterParameterStatusList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsRedshiftClusterClusterParameterStatus" - } - }, - "com.amazonaws.securityhub#AwsRedshiftClusterClusterSecurityGroup": { - "type": "structure", - "members": { - "ClusterSecurityGroupName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the cluster security group.

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The status of the cluster security group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A security group that is associated with the cluster.

" - } - }, - "com.amazonaws.securityhub#AwsRedshiftClusterClusterSecurityGroups": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsRedshiftClusterClusterSecurityGroup" - } - }, - "com.amazonaws.securityhub#AwsRedshiftClusterClusterSnapshotCopyStatus": { - "type": "structure", - "members": { - "DestinationRegion": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The destination Region that snapshots are automatically copied to when cross-Region\n snapshot copy is enabled.

" - } - }, - "ManualSnapshotRetentionPeriod": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of days that manual snapshots are retained in the destination Region after\n they are copied from a source Region.

\n

If the value is -1,\n then the manual snapshot is retained indefinitely.

\n

Valid values: Either -1\n or an integer between 1 and 3,653

" - } - }, - "RetentionPeriod": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of days to retain automated snapshots in the destination Region after they\n are copied from a source Region.

" - } - }, - "SnapshotCopyGrantName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the snapshot copy grant.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

You can configure Amazon Redshift to copy snapshots for a cluster to another Amazon Web Services Region. This parameter \n provides information about a cross-Region snapshot copy.

" - } - }, - "com.amazonaws.securityhub#AwsRedshiftClusterDeferredMaintenanceWindow": { - "type": "structure", - "members": { - "DeferMaintenanceEndTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The end of the time window for which maintenance was deferred.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "DeferMaintenanceIdentifier": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the maintenance window.

" - } - }, - "DeferMaintenanceStartTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The start of the time window for which maintenance was deferred.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A time windows during which maintenance was deferred for an Amazon Redshift\n cluster.

" - } - }, - "com.amazonaws.securityhub#AwsRedshiftClusterDeferredMaintenanceWindows": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsRedshiftClusterDeferredMaintenanceWindow" - } - }, - "com.amazonaws.securityhub#AwsRedshiftClusterDetails": { - "type": "structure", - "members": { - "AllowVersionUpgrade": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether major version upgrades are applied automatically to the cluster during\n the maintenance window.

" - } - }, - "AutomatedSnapshotRetentionPeriod": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of days that automatic cluster snapshots are retained.

" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the Availability Zone in which the cluster is located.

" - } - }, - "ClusterAvailabilityStatus": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The availability status of the cluster for queries. Possible values are the\n following:

\n " - } - }, - "ClusterCreateTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the cluster was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "ClusterIdentifier": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The unique identifier of the cluster.

" - } - }, - "ClusterNodes": { - "target": "com.amazonaws.securityhub#AwsRedshiftClusterClusterNodes", - "traits": { - "smithy.api#documentation": "

The nodes in the cluster.

" - } - }, - "ClusterParameterGroups": { - "target": "com.amazonaws.securityhub#AwsRedshiftClusterClusterParameterGroups", - "traits": { - "smithy.api#documentation": "

The list of cluster parameter groups that are associated with this cluster.

" - } - }, - "ClusterPublicKey": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The public key for the cluster.

" - } - }, - "ClusterRevisionNumber": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The specific revision number of the database in the cluster.

" - } - }, - "ClusterSecurityGroups": { - "target": "com.amazonaws.securityhub#AwsRedshiftClusterClusterSecurityGroups", - "traits": { - "smithy.api#documentation": "

A list of cluster security groups that are associated with the cluster.

" - } - }, - "ClusterSnapshotCopyStatus": { - "target": "com.amazonaws.securityhub#AwsRedshiftClusterClusterSnapshotCopyStatus", - "traits": { - "smithy.api#documentation": "

Information about the destination Region and retention period for the cross-Region\n snapshot copy.

" - } - }, - "ClusterStatus": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The current status of the cluster.

\n

Valid values: available | available, prep-for-resize |\n available, resize-cleanup | cancelling-resize |\n creating | deleting | final-snapshot |\n hardware-failure | incompatible-hsm |\n incompatible-network | incompatible-parameters |\n incompatible-restore | modifying | paused |\n rebooting | renaming | resizing |\n rotating-keys | storage-full |\n updating-hsm\n

" - } - }, - "ClusterSubnetGroupName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the subnet group that is associated with the cluster. This parameter is\n valid only when the cluster is in a VPC.

" - } - }, - "ClusterVersion": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The version ID of the Amazon Redshift engine that runs on the cluster.

" - } - }, - "DBName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the initial database that was created when the cluster was created.

\n

The same name is returned for the life of the cluster.

\n

If an initial database is not specified, a database named devdev is created\n by default.

" - } - }, - "DeferredMaintenanceWindows": { - "target": "com.amazonaws.securityhub#AwsRedshiftClusterDeferredMaintenanceWindows", - "traits": { - "smithy.api#documentation": "

List of time windows during which maintenance was deferred.

" - } - }, - "ElasticIpStatus": { - "target": "com.amazonaws.securityhub#AwsRedshiftClusterElasticIpStatus", - "traits": { - "smithy.api#documentation": "

Information about the status of the Elastic IP (EIP) address.

" - } - }, - "ElasticResizeNumberOfNodeOptions": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The number of nodes that you can use the elastic resize method to resize the cluster\n to.

" - } - }, - "Encrypted": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the data in the cluster is encrypted at rest.

" - } - }, - "Endpoint": { - "target": "com.amazonaws.securityhub#AwsRedshiftClusterEndpoint", - "traits": { - "smithy.api#documentation": "

The connection endpoint.

" - } - }, - "EnhancedVpcRouting": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to create the cluster with enhanced VPC routing enabled.

" - } - }, - "ExpectedNextSnapshotScheduleTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the next snapshot is expected to be taken. The cluster must have a valid\n snapshot schedule and have backups enabled.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "ExpectedNextSnapshotScheduleTimeStatus": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The status of the next expected snapshot.

\n

Valid values: OnTrack | Pending\n

" - } - }, - "HsmStatus": { - "target": "com.amazonaws.securityhub#AwsRedshiftClusterHsmStatus", - "traits": { - "smithy.api#documentation": "

Information about whether the Amazon Redshift cluster finished applying any changes to\n hardware security module (HSM) settings that were specified in a modify cluster\n command.

" - } - }, - "IamRoles": { - "target": "com.amazonaws.securityhub#AwsRedshiftClusterIamRoles", - "traits": { - "smithy.api#documentation": "

A list of IAM roles that the cluster can use to access other Amazon Web Services services.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the KMS encryption key that is used to encrypt data in the\n cluster.

" - } - }, - "MaintenanceTrackName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the maintenance track for the cluster.

" - } - }, - "ManualSnapshotRetentionPeriod": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The default number of days to retain a manual snapshot.

\n

If the value is -1, the snapshot is retained indefinitely.

\n

This setting doesn't change the retention period of existing snapshots.

\n

Valid values: Either -1 or an integer between 1 and 3,653

" - } - }, - "MasterUsername": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The master user name for the cluster. This name is used to connect to the database that\n is specified in as the value of DBName.

" - } - }, - "NextMaintenanceWindowStartTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates the start of the next maintenance window.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "NodeType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The node type for the nodes in the cluster.

" - } - }, - "NumberOfNodes": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of compute nodes in the cluster.

" - } - }, - "PendingActions": { - "target": "com.amazonaws.securityhub#StringList", - "traits": { - "smithy.api#documentation": "

A list of cluster operations that are waiting to start.

" - } - }, - "PendingModifiedValues": { - "target": "com.amazonaws.securityhub#AwsRedshiftClusterPendingModifiedValues", - "traits": { - "smithy.api#documentation": "

A list of changes to the cluster that are currently pending.

" - } - }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The weekly time range, in Universal Coordinated Time (UTC), during which system\n maintenance can occur.

\n

Format:\n \n :HH:MM-:HH:MM\n

\n

For the day values, use mon | tue | wed |\n thu | fri | sat | sun\n

\n

For example, sun:09:32-sun:10:02\n

" - } - }, - "PubliclyAccessible": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the cluster can be accessed from a public network.

" - } - }, - "ResizeInfo": { - "target": "com.amazonaws.securityhub#AwsRedshiftClusterResizeInfo", - "traits": { - "smithy.api#documentation": "

Information about the resize operation for the cluster.

" - } - }, - "RestoreStatus": { - "target": "com.amazonaws.securityhub#AwsRedshiftClusterRestoreStatus", - "traits": { - "smithy.api#documentation": "

Information about the status of a cluster restore action. Only applies to a cluster that\n was created by restoring a snapshot.

" - } - }, - "SnapshotScheduleIdentifier": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A unique identifier for the cluster snapshot schedule.

" - } - }, - "SnapshotScheduleState": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The current state of the cluster snapshot schedule.

\n

Valid values: MODIFYING | ACTIVE | FAILED\n

" - } - }, - "VpcId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the VPC that the cluster is in, if the cluster is in a VPC.

" - } - }, - "VpcSecurityGroups": { - "target": "com.amazonaws.securityhub#AwsRedshiftClusterVpcSecurityGroups", - "traits": { - "smithy.api#documentation": "

The list of VPC security groups that the cluster belongs to, if the cluster is in a\n VPC.

" - } - }, - "LoggingStatus": { - "target": "com.amazonaws.securityhub#AwsRedshiftClusterLoggingStatus", - "traits": { - "smithy.api#documentation": "

Information about the logging status of the cluster.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about an Amazon Redshift cluster.

" - } - }, - "com.amazonaws.securityhub#AwsRedshiftClusterElasticIpStatus": { - "type": "structure", - "members": { - "ElasticIp": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The elastic IP address for the cluster.

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The status of the elastic IP address.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The status of the elastic IP (EIP) address for an Amazon Redshift cluster.

" - } - }, - "com.amazonaws.securityhub#AwsRedshiftClusterEndpoint": { - "type": "structure", - "members": { - "Address": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The DNS address of the cluster.

" - } - }, - "Port": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The port that the database engine listens on.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The connection endpoint for an Amazon Redshift cluster.

" - } - }, - "com.amazonaws.securityhub#AwsRedshiftClusterHsmStatus": { - "type": "structure", - "members": { - "HsmClientCertificateIdentifier": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the HSM client certificate that the Amazon Redshift cluster uses to retrieve\n the data encryption keys that are stored in an HSM.

" - } - }, - "HsmConfigurationIdentifier": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the HSM configuration that contains the information that the Amazon Redshift\n cluster can use to retrieve and store keys in an HSM.

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates whether the Amazon Redshift cluster has finished applying any HSM settings\n changes specified in a modify cluster command.

\n

Type: String

\n

Valid values: active | applying\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about whether an Amazon Redshift cluster finished applying any hardware\n changes to security module (HSM) settings that were specified in a modify cluster\n command.

" - } - }, - "com.amazonaws.securityhub#AwsRedshiftClusterIamRole": { - "type": "structure", - "members": { - "ApplyStatus": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The status of the IAM role's association with the cluster.

\n

Valid values: in-sync | adding | removing\n

" - } - }, - "IamRoleArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the IAM role.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An IAM role that the cluster can use to access other Amazon Web Services services.

" - } - }, - "com.amazonaws.securityhub#AwsRedshiftClusterIamRoles": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsRedshiftClusterIamRole" - } - }, - "com.amazonaws.securityhub#AwsRedshiftClusterLoggingStatus": { - "type": "structure", - "members": { - "BucketName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the S3 bucket where the log files are stored.

" - } - }, - "LastFailureMessage": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The message indicating that the logs failed to be delivered.

" - } - }, - "LastFailureTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The last time when logs failed to be delivered.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "LastSuccessfulDeliveryTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The last time that logs were delivered successfully.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "LoggingEnabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether logging is enabled.

" - } - }, - "S3KeyPrefix": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Provides the prefix applied to the log file names.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about the logging status of the cluster.

" - } - }, - "com.amazonaws.securityhub#AwsRedshiftClusterPendingModifiedValues": { - "type": "structure", - "members": { - "AutomatedSnapshotRetentionPeriod": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The pending or in-progress change to the automated snapshot retention period.

" - } - }, - "ClusterIdentifier": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The pending or in-progress change to the identifier for the cluster.

" - } - }, - "ClusterType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The pending or in-progress change to the cluster type.

" - } - }, - "ClusterVersion": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The pending or in-progress change to the service version.

" - } - }, - "EncryptionType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The encryption type for a cluster.

" - } - }, - "EnhancedVpcRouting": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to create the cluster with enhanced VPC routing enabled.

" - } - }, - "MaintenanceTrackName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the maintenance track that the cluster changes to during the next\n maintenance window.

" - } - }, - "MasterUserPassword": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The pending or in-progress change to the master user password for the cluster.

" - } - }, - "NodeType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The pending or in-progress change to the cluster's node type.

" - } - }, - "NumberOfNodes": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The pending or in-progress change to the number of nodes in the cluster.

" - } - }, - "PubliclyAccessible": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

The pending or in-progress change to whether the cluster can be connected to from the\n public network.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Changes to the Amazon Redshift cluster that are currently pending.

" - } - }, - "com.amazonaws.securityhub#AwsRedshiftClusterResizeInfo": { - "type": "structure", - "members": { - "AllowCancelResize": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the resize operation can be canceled.

" - } - }, - "ResizeType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of resize operation.

\n

Valid values: ClassicResize\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the resize operation for the cluster.

" - } - }, - "com.amazonaws.securityhub#AwsRedshiftClusterRestoreStatus": { - "type": "structure", - "members": { - "CurrentRestoreRateInMegaBytesPerSecond": { - "target": "com.amazonaws.securityhub#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of megabytes per second being transferred from the backup storage. Returns\n the average rate for a completed backup.

\n

This field is only updated when you restore to DC2 and DS2 node types.

" - } - }, - "ElapsedTimeInSeconds": { - "target": "com.amazonaws.securityhub#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The amount of time an in-progress restore has been running, or the amount of time it\n took a completed restore to finish.

\n

This field is only updated when you restore to DC2 and DS2 node types.

" - } - }, - "EstimatedTimeToCompletionInSeconds": { - "target": "com.amazonaws.securityhub#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The estimate of the time remaining before the restore is complete. Returns 0 for a\n completed restore.

\n

This field is only updated when you restore to DC2 and DS2 node types.

" - } - }, - "ProgressInMegaBytes": { - "target": "com.amazonaws.securityhub#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of megabytes that were transferred from snapshot storage.

\n

This field is only updated when you restore to DC2 and DS2 node types.

" - } - }, - "SnapshotSizeInMegaBytes": { - "target": "com.amazonaws.securityhub#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The size of the set of snapshot data that was used to restore the cluster.

\n

This field is only updated when you restore to DC2 and DS2 node types.

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The status of the restore action.

\n

Valid values: starting | restoring | completed |\n failed\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the status of a cluster restore action. It only applies if the cluster\n was created by restoring a snapshot.

" - } - }, - "com.amazonaws.securityhub#AwsRedshiftClusterVpcSecurityGroup": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The status of the VPC security group.

" - } - }, - "VpcSecurityGroupId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the VPC security group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A VPC security group that the cluster belongs to, if the cluster is in a VPC.

" - } - }, - "com.amazonaws.securityhub#AwsRedshiftClusterVpcSecurityGroups": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsRedshiftClusterVpcSecurityGroup" - } - }, - "com.amazonaws.securityhub#AwsS3AccountPublicAccessBlockDetails": { - "type": "structure", - "members": { - "BlockPublicAcls": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to reject calls to update an S3 bucket if the calls include a public access control list (ACL).

" - } - }, - "BlockPublicPolicy": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to reject calls to update the access policy for an S3 bucket or access point if the policy allows public access.

" - } - }, - "IgnorePublicAcls": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether Amazon S3 ignores public ACLs that are associated with an S3 bucket.

" - } - }, - "RestrictPublicBuckets": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to restrict access to an access point or S3 bucket that has a public policy to only Amazon Web Services service principals and authorized users within the S3 bucket owner's account.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

provides information about the Amazon S3 Public Access Block configuration for accounts.

" - } - }, - "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationDetails": { - "type": "structure", - "members": { - "Rules": { - "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesList", - "traits": { - "smithy.api#documentation": "

The lifecycle rules.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The lifecycle configuration for the objects in the S3 bucket.

" - } - }, - "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesAbortIncompleteMultipartUploadDetails": { - "type": "structure", - "members": { - "DaysAfterInitiation": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of days after which Amazon S3 cancels an incomplete multipart upload.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about what Amazon S3\n does when a multipart upload is incomplete.

" - } - }, - "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesDetails": { - "type": "structure", - "members": { - "AbortIncompleteMultipartUpload": { - "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesAbortIncompleteMultipartUploadDetails", - "traits": { - "smithy.api#documentation": "

How Amazon S3 responds when a multipart upload is incomplete. Specifically, provides a number\n of days before Amazon S3 cancels the entire upload.

" - } - }, - "ExpirationDate": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The date when objects are moved or deleted.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "ExpirationInDays": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The length in days of the lifetime for objects that are subject to the rule.

" - } - }, - "ExpiredObjectDeleteMarker": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether Amazon S3 removes a delete marker that has no noncurrent versions. If set to\n true, the delete marker is expired. If set to false, the policy\n takes no action.

\n

If you provide ExpiredObjectDeleteMarker, you cannot provide\n ExpirationInDays or ExpirationDate.

" - } - }, - "Filter": { - "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesFilterDetails", - "traits": { - "smithy.api#documentation": "

Identifies the objects that a rule applies to.

" - } - }, - "ID": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The unique identifier of the rule.

" - } - }, - "NoncurrentVersionExpirationInDays": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of days that an object is noncurrent before Amazon S3 can perform the associated action.

" - } - }, - "NoncurrentVersionTransitions": { - "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsList", - "traits": { - "smithy.api#documentation": "

Transition rules that describe when noncurrent objects transition to a specified storage class.

" - } - }, - "Prefix": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A prefix that identifies one or more objects that the rule applies to.

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The current status of the rule. Indicates whether the rule is currently being applied.

" - } - }, - "Transitions": { - "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesTransitionsList", - "traits": { - "smithy.api#documentation": "

Transition rules that indicate when objects transition to a specified storage class.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Configuration for a lifecycle rule.

" - } - }, - "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesFilterDetails": { - "type": "structure", - "members": { - "Predicate": { - "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails", - "traits": { - "smithy.api#documentation": "

The configuration for the filter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Identifies the objects that a rule applies to.

" - } - }, - "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails": { - "type": "structure", - "members": { - "Operands": { - "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsList", - "traits": { - "smithy.api#documentation": "

The values to use for the filter.

" - } - }, - "Prefix": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A prefix filter.

" - } - }, - "Tag": { - "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails", - "traits": { - "smithy.api#documentation": "

A tag filter.

" - } - }, - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Whether to use AND or OR to join the operands. \nValid values are LifecycleAndOperator or LifecycleOrOperator.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration for the filter.

" - } - }, - "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails": { - "type": "structure", - "members": { - "Prefix": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Prefix text for matching objects.

" - } - }, - "Tag": { - "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails", - "traits": { - "smithy.api#documentation": "

A tag that is assigned to matching objects.

" - } - }, - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of filter value. \nValid values are LifecyclePrefixPredicate or LifecycleTagPredicate.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A value to use for the filter.

" - } - }, - "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails" - } - }, - "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The tag key.

" - } - }, - "Value": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The tag value.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A tag that is assigned to matching objects.

" - } - }, - "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The tag key.

" - } - }, - "Value": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The tag value

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A tag filter.

" - } - }, - "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesDetails" - } - }, - "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDetails": { - "type": "structure", - "members": { - "Days": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of days that an object is noncurrent before Amazon S3 can perform the associated action.

" - } - }, - "StorageClass": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The class of storage to change the object to after the object is noncurrent for the specified number of days.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A transition rule that describes when noncurrent objects transition to a specified storage class.

" - } - }, - "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDetails" - } - }, - "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails": { - "type": "structure", - "members": { - "Date": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A date on which to transition objects to the specified storage class. If you provide Date, you cannot provide Days.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "Days": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of days after which to transition the object to the specified storage class. If you provide Days, you cannot provide Date.

" - } - }, - "StorageClass": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The storage class to transition the object to. Valid values are as follows:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

A rule for when objects transition to specific storage classes.

" - } - }, - "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesTransitionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails" - } - }, - "com.amazonaws.securityhub#AwsS3BucketBucketVersioningConfiguration": { - "type": "structure", - "members": { - "IsMfaDeleteEnabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether MFA delete is currently enabled in the S3 bucket versioning configuration. If the S3 bucket was never configured with MFA delete, then this attribute is not included.

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The versioning status of the S3 bucket. Valid values are Enabled or Suspended.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the versioning state of an S3 bucket.

" - } - }, - "com.amazonaws.securityhub#AwsS3BucketDetails": { - "type": "structure", - "members": { - "OwnerId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The canonical user ID of the owner of the S3 bucket.

" - } - }, - "OwnerName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The display name of the owner of the S3 bucket.

" - } - }, - "OwnerAccountId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account identifier of the account that owns the S3 bucket.

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the S3 bucket was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "ServerSideEncryptionConfiguration": { - "target": "com.amazonaws.securityhub#AwsS3BucketServerSideEncryptionConfiguration", - "traits": { - "smithy.api#documentation": "

The encryption rules that are applied to the S3 bucket.

" - } - }, - "BucketLifecycleConfiguration": { - "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationDetails", - "traits": { - "smithy.api#documentation": "

The lifecycle configuration for objects in the S3 bucket.

" - } - }, - "PublicAccessBlockConfiguration": { - "target": "com.amazonaws.securityhub#AwsS3AccountPublicAccessBlockDetails", - "traits": { - "smithy.api#documentation": "

Provides information about the Amazon S3 Public Access Block configuration for the S3 bucket.

" - } - }, - "AccessControlList": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The access control list for the S3 bucket.

" - } - }, - "BucketLoggingConfiguration": { - "target": "com.amazonaws.securityhub#AwsS3BucketLoggingConfiguration", - "traits": { - "smithy.api#documentation": "

The logging configuration for the S3 bucket.

" - } - }, - "BucketWebsiteConfiguration": { - "target": "com.amazonaws.securityhub#AwsS3BucketWebsiteConfiguration", - "traits": { - "smithy.api#documentation": "

The website configuration parameters for the S3 bucket.

" - } - }, - "BucketNotificationConfiguration": { - "target": "com.amazonaws.securityhub#AwsS3BucketNotificationConfiguration", - "traits": { - "smithy.api#documentation": "

The notification configuration for the S3 bucket.

" - } - }, - "BucketVersioningConfiguration": { - "target": "com.amazonaws.securityhub#AwsS3BucketBucketVersioningConfiguration", - "traits": { - "smithy.api#documentation": "

The versioning state of an S3 bucket.

" - } - }, - "ObjectLockConfiguration": { - "target": "com.amazonaws.securityhub#AwsS3BucketObjectLockConfiguration", - "traits": { - "smithy.api#documentation": "

\n Specifies which rule Amazon S3 applies by default to every new object placed in the specified bucket. \n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The details of an Amazon S3 bucket.

" - } - }, - "com.amazonaws.securityhub#AwsS3BucketLoggingConfiguration": { - "type": "structure", - "members": { - "DestinationBucketName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the S3 bucket where log files for the S3 bucket are stored.

" - } - }, - "LogFilePrefix": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The prefix added to log files for the S3 bucket.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about logging for\n the S3 bucket

" - } - }, - "com.amazonaws.securityhub#AwsS3BucketNotificationConfiguration": { - "type": "structure", - "members": { - "Configurations": { - "target": "com.amazonaws.securityhub#AwsS3BucketNotificationConfigurationDetails", - "traits": { - "smithy.api#documentation": "

Configurations for S3 bucket notifications.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The notification\n configuration for the S3 bucket.

" - } - }, - "com.amazonaws.securityhub#AwsS3BucketNotificationConfigurationDetail": { - "type": "structure", - "members": { - "Events": { - "target": "com.amazonaws.securityhub#AwsS3BucketNotificationConfigurationEvents", - "traits": { - "smithy.api#documentation": "

The list of events that trigger a notification.

" - } - }, - "Filter": { - "target": "com.amazonaws.securityhub#AwsS3BucketNotificationConfigurationFilter", - "traits": { - "smithy.api#documentation": "

The filters that determine which S3 buckets generate notifications.

" - } - }, - "Destination": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the Lambda function, Amazon SQS queue, or Amazon SNS topic that generates the\n notification.

" - } - }, - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates the type of notification. Notifications can be generated using Lambda functions,\n Amazon SQS queues, or Amazon SNS topics, with corresponding valid values as follows:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Details for an S3 bucket notification configuration.

" - } - }, - "com.amazonaws.securityhub#AwsS3BucketNotificationConfigurationDetails": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsS3BucketNotificationConfigurationDetail" - } - }, - "com.amazonaws.securityhub#AwsS3BucketNotificationConfigurationEvents": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#NonEmptyString" - } - }, - "com.amazonaws.securityhub#AwsS3BucketNotificationConfigurationFilter": { - "type": "structure", - "members": { - "S3KeyFilter": { - "target": "com.amazonaws.securityhub#AwsS3BucketNotificationConfigurationS3KeyFilter", - "traits": { - "smithy.api#documentation": "

Details for an Amazon S3 filter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Filtering information for the notifications. The\n filtering is based on Amazon S3 key names.

" - } - }, - "com.amazonaws.securityhub#AwsS3BucketNotificationConfigurationS3KeyFilter": { - "type": "structure", - "members": { - "FilterRules": { - "target": "com.amazonaws.securityhub#AwsS3BucketNotificationConfigurationS3KeyFilterRules", - "traits": { - "smithy.api#documentation": "

The filter rules for the filter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details for an Amazon S3 filter.

" - } - }, - "com.amazonaws.securityhub#AwsS3BucketNotificationConfigurationS3KeyFilterRule": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.securityhub#AwsS3BucketNotificationConfigurationS3KeyFilterRuleName", - "traits": { - "smithy.api#documentation": "

Indicates whether the filter is based on the prefix or suffix of the Amazon S3 key.

" - } - }, - "Value": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The filter value.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details for a filter rule.

" - } - }, - "com.amazonaws.securityhub#AwsS3BucketNotificationConfigurationS3KeyFilterRuleName": { - "type": "enum", - "members": { - "PREFIX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Prefix" - } - }, - "SUFFIX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Suffix" - } - } - } - }, - "com.amazonaws.securityhub#AwsS3BucketNotificationConfigurationS3KeyFilterRules": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsS3BucketNotificationConfigurationS3KeyFilterRule" - } - }, - "com.amazonaws.securityhub#AwsS3BucketObjectLockConfiguration": { - "type": "structure", - "members": { - "ObjectLockEnabled": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n Indicates whether the bucket has an Object Lock configuration enabled. \n

" - } - }, - "Rule": { - "target": "com.amazonaws.securityhub#AwsS3BucketObjectLockConfigurationRuleDetails", - "traits": { - "smithy.api#documentation": "

\n Specifies the Object Lock rule for the specified object. \n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n The container element for S3 Object Lock configuration parameters. In Amazon S3, Object Lock can help prevent objects from being deleted or overwritten for a fixed amount of time or indefinitely.\n

" - } - }, - "com.amazonaws.securityhub#AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails": { - "type": "structure", - "members": { - "Days": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The number of days that you want to specify for the default retention period.\n

" - } - }, - "Mode": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The default Object Lock retention mode you want to apply to new objects placed in the specified bucket.\n

" - } - }, - "Years": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The number of years that you want to specify for the default retention period.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n The default S3 Object Lock retention mode and period that you want to apply to new objects placed in the specified Amazon S3 bucket. \n

" - } - }, - "com.amazonaws.securityhub#AwsS3BucketObjectLockConfigurationRuleDetails": { - "type": "structure", - "members": { - "DefaultRetention": { - "target": "com.amazonaws.securityhub#AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails", - "traits": { - "smithy.api#documentation": "

\n The default Object Lock retention mode and period that you want to apply to new objects placed in the specified bucket. \n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Specifies the S3 Object Lock rule for the specified object. In Amazon S3, Object Lock can help prevent objects from being deleted or overwritten for a fixed amount of time or indefinitely.\n

" - } - }, - "com.amazonaws.securityhub#AwsS3BucketServerSideEncryptionByDefault": { - "type": "structure", - "members": { - "SSEAlgorithm": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Server-side encryption algorithm to use for the default encryption. Valid values are \naws: kms or AES256.

" - } - }, - "KMSMasterKeyID": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

KMS key ID to use for the default encryption.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the default server-side encryption to apply to new objects in the\n bucket.

" - } - }, - "com.amazonaws.securityhub#AwsS3BucketServerSideEncryptionConfiguration": { - "type": "structure", - "members": { - "Rules": { - "target": "com.amazonaws.securityhub#AwsS3BucketServerSideEncryptionRules", - "traits": { - "smithy.api#documentation": "

The encryption rules that are applied to the S3 bucket.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The encryption configuration for the S3 bucket.

" - } - }, - "com.amazonaws.securityhub#AwsS3BucketServerSideEncryptionRule": { - "type": "structure", - "members": { - "ApplyServerSideEncryptionByDefault": { - "target": "com.amazonaws.securityhub#AwsS3BucketServerSideEncryptionByDefault", - "traits": { - "smithy.api#documentation": "

Specifies the default server-side encryption to apply to new objects in the bucket. If a\n PUT object request doesn't specify any server-side encryption, this default\n encryption is applied.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An encryption rule to apply to the S3 bucket.

" - } - }, - "com.amazonaws.securityhub#AwsS3BucketServerSideEncryptionRules": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsS3BucketServerSideEncryptionRule" - } - }, - "com.amazonaws.securityhub#AwsS3BucketWebsiteConfiguration": { - "type": "structure", - "members": { - "ErrorDocument": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the error document for the website.

" - } - }, - "IndexDocumentSuffix": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the index document for the website.

" - } - }, - "RedirectAllRequestsTo": { - "target": "com.amazonaws.securityhub#AwsS3BucketWebsiteConfigurationRedirectTo", - "traits": { - "smithy.api#documentation": "

The redirect behavior for requests to the website.

" - } - }, - "RoutingRules": { - "target": "com.amazonaws.securityhub#AwsS3BucketWebsiteConfigurationRoutingRules", - "traits": { - "smithy.api#documentation": "

The rules for applying redirects for requests to the website.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Website parameters for the S3\n bucket.

" - } - }, - "com.amazonaws.securityhub#AwsS3BucketWebsiteConfigurationRedirectTo": { - "type": "structure", - "members": { - "Hostname": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the host to redirect requests to.

" - } - }, - "Protocol": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The protocol to use when redirecting requests. By default, this field uses the same protocol as the\n original request. Valid values are http or https.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The redirect behavior for requests\n to the website.

" - } - }, - "com.amazonaws.securityhub#AwsS3BucketWebsiteConfigurationRoutingRule": { - "type": "structure", - "members": { - "Condition": { - "target": "com.amazonaws.securityhub#AwsS3BucketWebsiteConfigurationRoutingRuleCondition", - "traits": { - "smithy.api#documentation": "

Provides the condition that must be met in order to apply the routing rule.

" - } - }, - "Redirect": { - "target": "com.amazonaws.securityhub#AwsS3BucketWebsiteConfigurationRoutingRuleRedirect", - "traits": { - "smithy.api#documentation": "

Provides the rules to redirect the request if the condition in Condition is\n met.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A rule for redirecting requests\n to the website.

" - } - }, - "com.amazonaws.securityhub#AwsS3BucketWebsiteConfigurationRoutingRuleCondition": { - "type": "structure", - "members": { - "HttpErrorCodeReturnedEquals": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates to redirect the request if the HTTP error code matches this value.

" - } - }, - "KeyPrefixEquals": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates to redirect the request if the key prefix matches this value.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The condition that must be met in order to apply the routing rule.

" - } - }, - "com.amazonaws.securityhub#AwsS3BucketWebsiteConfigurationRoutingRuleRedirect": { - "type": "structure", - "members": { - "Hostname": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The host name to use in the redirect request.

" - } - }, - "HttpRedirectCode": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The HTTP redirect code to use in the response.

" - } - }, - "Protocol": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The protocol to use to redirect the request. By default, uses the protocol from the\n original request.

" - } - }, - "ReplaceKeyPrefixWith": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The object key prefix to use in the redirect request.

\n

Cannot be provided if ReplaceKeyWith is present.

" - } - }, - "ReplaceKeyWith": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The specific object key to use in the redirect request.

\n

Cannot be provided if ReplaceKeyPrefixWith is present.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The rules to redirect the request if the condition in Condition is\n met.

" - } - }, - "com.amazonaws.securityhub#AwsS3BucketWebsiteConfigurationRoutingRules": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsS3BucketWebsiteConfigurationRoutingRule" - } - }, - "com.amazonaws.securityhub#AwsS3ObjectDetails": { - "type": "structure", - "members": { - "LastModified": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the object was last modified.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "ETag": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The opaque identifier assigned by a web server to a specific version of a resource found\n at a URL.

" - } - }, - "VersionId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The version of the object.

" - } - }, - "ContentType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A standard MIME type describing the format of the object data.

" - } - }, - "ServerSideEncryption": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

If the object is stored using server-side encryption, the value of the server-side\n encryption algorithm used when storing this object in Amazon S3.

" - } - }, - "SSEKMSKeyId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the KMS symmetric customer managed key that was used for the object.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about an Amazon S3 object.

" - } - }, - "com.amazonaws.securityhub#AwsSageMakerNotebookInstanceDetails": { - "type": "structure", - "members": { - "AcceleratorTypes": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

\n A list of Amazon Elastic Inference instance types to associate with the notebook instance. Currently, only one instance type can be associated with a notebook instance. \n

" - } - }, - "AdditionalCodeRepositories": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

\n 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 CodeCommit or in any other Git repository. \n These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git repositories with SageMaker notebook instances in the Amazon SageMaker Developer Guide.\n

" - } - }, - "DefaultCodeRepository": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n 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 CodeCommit or in any other Git repository. \n When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git repositories with SageMaker notebook instances in the Amazon SageMaker Developer Guide.\n

" - } - }, - "DirectInternetAccess": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n Sets whether SageMaker provides internet access to the notebook instance. If you set this to Disabled, this notebook instance is able to access resources only in your VPC, and is not be able to connect to SageMaker training and endpoint services unless you configure a Network Address Translation (NAT) Gateway in your VPC.\n

" - } - }, - "FailureReason": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n If status of the instance is Failed, the reason it failed.\n

" - } - }, - "InstanceMetadataServiceConfiguration": { - "target": "com.amazonaws.securityhub#AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails", - "traits": { - "smithy.api#documentation": "

\n Information on the IMDS configuration of the notebook instance.\n

" - } - }, - "InstanceType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The type of machine learning (ML) compute instance to launch for the notebook instance.\n

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of an Key Management Service (KMS) key that 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 \n Enabling and disabling keys in the Key Management Service Developer Guide.\n

" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The network interface ID that SageMaker created when the instance was created.\n

" - } - }, - "NotebookInstanceArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the notebook instance.\n

" - } - }, - "NotebookInstanceLifecycleConfigName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The name of a notebook instance lifecycle configuration.\n

" - } - }, - "NotebookInstanceName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The name of the new notebook instance.\n

" - } - }, - "NotebookInstanceStatus": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The status of the notebook instance.\n

" - } - }, - "PlatformIdentifier": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The platform identifier of the notebook instance runtime environment.\n

" - } - }, - "RoleArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the IAM role associated with the instance.\n

" - } - }, - "RootAccess": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n Whether root access is enabled or disabled for users of the notebook instance. \n

" - } - }, - "SecurityGroups": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

\n The VPC security group IDs.\n

" - } - }, - "SubnetId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The ID of the VPC subnet to which you have a connectivity from your ML compute instance.\n

" - } - }, - "Url": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.\n

" - } - }, - "VolumeSizeInGB": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The size, in GB, of the ML storage volume to attach to the notebook instance.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Provides details about an Amazon SageMaker notebook instance.\n

" - } - }, - "com.amazonaws.securityhub#AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails": { - "type": "structure", - "members": { - "MinimumInstanceMetadataServiceVersion": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n Indicates the minimum IMDS version that the notebook instance supports.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Information on the instance metadata service (IMDS) configuration of the notebook instance.\n

" - } - }, - "com.amazonaws.securityhub#AwsSecretsManagerSecretDetails": { - "type": "structure", - "members": { - "RotationRules": { - "target": "com.amazonaws.securityhub#AwsSecretsManagerSecretRotationRules", - "traits": { - "smithy.api#documentation": "

Defines the rotation schedule for the secret.

" - } - }, - "RotationOccurredWithinFrequency": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the rotation occurred within the specified rotation frequency.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN, Key ID, or alias of the KMS key used to encrypt the\n SecretString or SecretBinary values for versions of this\n secret.

" - } - }, - "RotationEnabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether rotation is enabled.

" - } - }, - "RotationLambdaArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the Lambda function that rotates the secret.

" - } - }, - "Deleted": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the secret is deleted.

" - } - }, - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the secret.

" - } - }, - "Description": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The user-provided description of the secret.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about an Secrets Manager secret.

" - } - }, - "com.amazonaws.securityhub#AwsSecretsManagerSecretRotationRules": { - "type": "structure", - "members": { - "AutomaticallyAfterDays": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of days after the previous rotation to rotate the secret.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Defines the rotation schedule for the secret.

" - } - }, - "com.amazonaws.securityhub#AwsSecurityFinding": { - "type": "structure", - "members": { - "SchemaVersion": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The schema version that a finding is formatted for.

", - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The security findings provider-specific identifier for a finding.

", - "smithy.api#required": {} - } - }, - "ProductArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN generated by Security Hub that uniquely identifies a product that generates findings.\n This can be the ARN for a third-party product that is integrated with Security Hub, or the ARN for\n a custom integration.

", - "smithy.api#required": {} - } - }, - "ProductName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the product that generated the finding.

\n

Security Hub populates this attribute automatically for each finding. You cannot update this attribute with BatchImportFindings or BatchUpdateFindings. The exception to this is a custom integration.

\n

When you use the Security Hub console or API to filter findings by product name, you use this attribute.

" - } - }, - "CompanyName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the company for the product that generated the finding.

\n

Security Hub populates this attribute automatically for each finding. You cannot update this attribute with BatchImportFindings or BatchUpdateFindings. The exception to this is a custom integration.

\n

When you use the Security Hub console or API to filter findings by company name, you use this attribute.

" - } - }, - "Region": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Region from which the finding was generated.

\n

Security Hub populates this attribute automatically for each finding. You cannot update it using BatchImportFindings or BatchUpdateFindings.

" - } - }, - "GeneratorId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier for the solution-specific component (a discrete unit of logic) that\n generated a finding. In various security findings providers' solutions, this generator can\n be called a rule, a check, a detector, a plugin, etc.

", - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID that a finding is generated in.

", - "smithy.api#required": {} - } - }, - "Types": { - "target": "com.amazonaws.securityhub#TypeList", - "traits": { - "smithy.api#documentation": "

One or more finding types in the format of namespace/category/classifier\n that classify a finding.

\n

Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual\n Behaviors | Sensitive Data Identifications

" - } - }, - "FirstObservedAt": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the security findings provider first observed the potential security\n issue that a finding captured.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "LastObservedAt": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the security findings provider most recently observed the potential\n security issue that a finding captured.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the security findings provider created the potential security issue that\n a finding captured.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

", - "smithy.api#required": {} - } - }, - "UpdatedAt": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the security findings provider last updated the finding record.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

", - "smithy.api#required": {} - } - }, - "Severity": { - "target": "com.amazonaws.securityhub#Severity", - "traits": { - "smithy.api#documentation": "

A finding's severity.

" - } - }, - "Confidence": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

A finding's confidence. Confidence is defined as the likelihood that a finding\n accurately identifies the behavior or issue that it was intended to identify.

\n

Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent\n confidence and 100 means 100 percent confidence.

" - } - }, - "Criticality": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The level of importance assigned to the resources associated with the finding.

\n

A score of 0 means that the underlying resources have no criticality, and a score of 100\n is reserved for the most critical resources.

" - } - }, - "Title": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A finding's title.

\n \n

In this release, Title is a required property.

\n ", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A finding's description.

\n \n

In this release, Description is a required property.

\n ", - "smithy.api#required": {} - } - }, - "Remediation": { - "target": "com.amazonaws.securityhub#Remediation", - "traits": { - "smithy.api#documentation": "

A data type that describes the remediation options for a finding.

" - } - }, - "SourceUrl": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A URL that links to a page about the current finding in the security findings provider's\n solution.

" - } - }, - "ProductFields": { - "target": "com.amazonaws.securityhub#FieldMap", - "traits": { - "smithy.api#documentation": "

A data type where security findings providers can include additional solution-specific\n details that aren't part of the defined AwsSecurityFinding format.

\n

Can contain up to 50 key-value pairs. For each key-value pair, the key can contain up to 128 characters, and the value can contain up to 2048 characters.

" - } - }, - "UserDefinedFields": { - "target": "com.amazonaws.securityhub#FieldMap", - "traits": { - "smithy.api#documentation": "

A list of name/value string pairs associated with the finding. These are custom,\n user-defined fields added to a finding.

" - } - }, - "Malware": { - "target": "com.amazonaws.securityhub#MalwareList", - "traits": { - "smithy.api#documentation": "

A list of malware related to a finding.

" - } - }, - "Network": { - "target": "com.amazonaws.securityhub#Network", - "traits": { - "smithy.api#documentation": "

The details of network-related information about a finding.

" - } - }, - "NetworkPath": { - "target": "com.amazonaws.securityhub#NetworkPathList", - "traits": { - "smithy.api#documentation": "

Provides information about a network path that is relevant to a finding. Each entry\n under NetworkPath represents a component of that path.

" - } - }, - "Process": { - "target": "com.amazonaws.securityhub#ProcessDetails", - "traits": { - "smithy.api#documentation": "

The details of process-related information about a finding.

" - } - }, - "Threats": { - "target": "com.amazonaws.securityhub#ThreatList", - "traits": { - "smithy.api#documentation": "

Details about the threat detected in a security finding and the file paths that were affected by the threat.\n

" - } - }, - "ThreatIntelIndicators": { - "target": "com.amazonaws.securityhub#ThreatIntelIndicatorList", - "traits": { - "smithy.api#documentation": "

Threat intelligence details related to a finding.

" - } - }, - "Resources": { - "target": "com.amazonaws.securityhub#ResourceList", - "traits": { - "smithy.api#documentation": "

A set of resource data types that describe the resources that the finding refers\n to.

", - "smithy.api#required": {} - } - }, - "Compliance": { - "target": "com.amazonaws.securityhub#Compliance", - "traits": { - "smithy.api#documentation": "

This data type is exclusive to findings that are generated as the result of a check run\n against a specific rule in a supported security standard, such as CIS Amazon Web Services Foundations.\n Contains security standard-related finding details.

" - } - }, - "VerificationState": { - "target": "com.amazonaws.securityhub#VerificationState", - "traits": { - "smithy.api#documentation": "

Indicates the veracity of a finding.

" - } - }, - "WorkflowState": { - "target": "com.amazonaws.securityhub#WorkflowState", - "traits": { - "smithy.api#documentation": "

The workflow state of a finding.

" - } - }, - "Workflow": { - "target": "com.amazonaws.securityhub#Workflow", - "traits": { - "smithy.api#documentation": "

Provides information about the status of the investigation into a finding.

" - } - }, - "RecordState": { - "target": "com.amazonaws.securityhub#RecordState", - "traits": { - "smithy.api#documentation": "

The record state of a finding.

" - } - }, - "RelatedFindings": { - "target": "com.amazonaws.securityhub#RelatedFindingList", - "traits": { - "smithy.api#documentation": "

A list of related findings.

" - } - }, - "Note": { - "target": "com.amazonaws.securityhub#Note", - "traits": { - "smithy.api#documentation": "

A user-defined note added to a finding.

" - } - }, - "Vulnerabilities": { - "target": "com.amazonaws.securityhub#VulnerabilityList", - "traits": { - "smithy.api#documentation": "

Provides a list of vulnerabilities associated with the findings.

" - } - }, - "PatchSummary": { - "target": "com.amazonaws.securityhub#PatchSummary", - "traits": { - "smithy.api#documentation": "

Provides an overview of the patch compliance status for an instance against a selected\n compliance standard.

" - } - }, - "Action": { - "target": "com.amazonaws.securityhub#Action", - "traits": { - "smithy.api#documentation": "

Provides details about an action that affects or that was taken on a resource.

" - } - }, - "FindingProviderFields": { - "target": "com.amazonaws.securityhub#FindingProviderFields", - "traits": { - "smithy.api#documentation": "

In a BatchImportFindings request, finding providers use FindingProviderFields to provide and update their own values for confidence, criticality, related findings, severity, and types.

" - } - }, - "Sample": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the finding is a sample finding.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides a consistent format for Security Hub findings.\n AwsSecurityFinding format allows you to share findings between Amazon Web Services\n security services and third-party solutions.

\n \n

A finding is a potential security issue generated either by Amazon Web Services services or by the integrated third-party\n solutions and standards checks.

\n " - } - }, - "com.amazonaws.securityhub#AwsSecurityFindingFilters": { - "type": "structure", - "members": { - "ProductArn": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The ARN generated by Security Hub that uniquely identifies a third-party company\n (security findings provider) after this provider's product (solution that generates\n findings) is registered with Security Hub.

" - } - }, - "AwsAccountId": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID that a finding is generated in.

" - } - }, - "Id": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The security findings provider-specific identifier for a finding.

" - } - }, - "GeneratorId": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The identifier for the solution-specific component (a discrete unit of logic) that\n generated a finding. In various security findings providers' solutions, this generator can\n be called a rule, a check, a detector, a plugin, etc.

" - } - }, - "Region": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The Region from which the finding was generated.

" - } - }, - "Type": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

A finding type in the format of namespace/category/classifier that\n classifies a finding.

" - } - }, - "FirstObservedAt": { - "target": "com.amazonaws.securityhub#DateFilterList", - "traits": { - "smithy.api#documentation": "

An ISO8601-formatted timestamp that indicates when the security findings provider first\n observed the potential security issue that a finding captured.

\n

A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.

" - } - }, - "LastObservedAt": { - "target": "com.amazonaws.securityhub#DateFilterList", - "traits": { - "smithy.api#documentation": "

An ISO8601-formatted timestamp that indicates when the security findings provider most\n recently observed the potential security issue that a finding captured.

\n

A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.securityhub#DateFilterList", - "traits": { - "smithy.api#documentation": "

An ISO8601-formatted timestamp that indicates when the security findings provider\n captured the potential security issue that a finding captured.

\n

A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.

" - } - }, - "UpdatedAt": { - "target": "com.amazonaws.securityhub#DateFilterList", - "traits": { - "smithy.api#documentation": "

An ISO8601-formatted timestamp that indicates when the security findings provider last\n updated the finding record.

\n

A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.

" - } - }, - "SeverityProduct": { - "target": "com.amazonaws.securityhub#NumberFilterList", - "traits": { - "smithy.api#deprecated": { - "message": "This filter is deprecated. Instead, use FindingProviderSeverityOriginal." - }, - "smithy.api#documentation": "

The native severity as defined by the security findings provider's solution that\n generated the finding.

" - } - }, - "SeverityNormalized": { - "target": "com.amazonaws.securityhub#NumberFilterList", - "traits": { - "smithy.api#deprecated": { - "message": "This filter is deprecated. Instead, use SeverityLabel or FindingProviderFieldsSeverityLabel." - }, - "smithy.api#documentation": "

The normalized severity of a finding.

" - } - }, - "SeverityLabel": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The label of a finding's severity.

" - } - }, - "Confidence": { - "target": "com.amazonaws.securityhub#NumberFilterList", - "traits": { - "smithy.api#documentation": "

A finding's confidence. Confidence is defined as the likelihood that a finding\n accurately identifies the behavior or issue that it was intended to identify.

\n

Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent\n confidence and 100 means 100 percent confidence.

" - } - }, - "Criticality": { - "target": "com.amazonaws.securityhub#NumberFilterList", - "traits": { - "smithy.api#documentation": "

The level of importance assigned to the resources associated with the finding.

\n

A score of 0 means that the underlying resources have no criticality, and a score of 100\n is reserved for the most critical resources.

" - } - }, - "Title": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

A finding's title.

" - } - }, - "Description": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

A finding's description.

" - } - }, - "RecommendationText": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The recommendation of what to do about the issue described in a finding.

" - } - }, - "SourceUrl": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

A URL that links to a page about the current finding in the security findings provider's\n solution.

" - } - }, - "ProductFields": { - "target": "com.amazonaws.securityhub#MapFilterList", - "traits": { - "smithy.api#documentation": "

A data type where security findings providers can include additional solution-specific\n details that aren't part of the defined AwsSecurityFinding format.

" - } - }, - "ProductName": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The name of the solution (product) that generates findings.

" - } - }, - "CompanyName": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The name of the findings provider (company) that owns the solution (product) that\n generates findings.

" - } - }, - "UserDefinedFields": { - "target": "com.amazonaws.securityhub#MapFilterList", - "traits": { - "smithy.api#documentation": "

A list of name/value string pairs associated with the finding. These are custom,\n user-defined fields added to a finding.

" - } - }, - "MalwareName": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The name of the malware that was observed.

" - } - }, - "MalwareType": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The type of the malware that was observed.

" - } - }, - "MalwarePath": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The filesystem path of the malware that was observed.

" - } - }, - "MalwareState": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The state of the malware that was observed.

" - } - }, - "NetworkDirection": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

Indicates the direction of network traffic associated with a finding.

" - } - }, - "NetworkProtocol": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The protocol of network-related information about a finding.

" - } - }, - "NetworkSourceIpV4": { - "target": "com.amazonaws.securityhub#IpFilterList", - "traits": { - "smithy.api#documentation": "

The source IPv4 address of network-related information about a finding.

" - } - }, - "NetworkSourceIpV6": { - "target": "com.amazonaws.securityhub#IpFilterList", - "traits": { - "smithy.api#documentation": "

The source IPv6 address of network-related information about a finding.

" - } - }, - "NetworkSourcePort": { - "target": "com.amazonaws.securityhub#NumberFilterList", - "traits": { - "smithy.api#documentation": "

The source port of network-related information about a finding.

" - } - }, - "NetworkSourceDomain": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The source domain of network-related information about a finding.

" - } - }, - "NetworkSourceMac": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The source media access control (MAC) address of network-related information about a\n finding.

" - } - }, - "NetworkDestinationIpV4": { - "target": "com.amazonaws.securityhub#IpFilterList", - "traits": { - "smithy.api#documentation": "

The destination IPv4 address of network-related information about a finding.

" - } - }, - "NetworkDestinationIpV6": { - "target": "com.amazonaws.securityhub#IpFilterList", - "traits": { - "smithy.api#documentation": "

The destination IPv6 address of network-related information about a finding.

" - } - }, - "NetworkDestinationPort": { - "target": "com.amazonaws.securityhub#NumberFilterList", - "traits": { - "smithy.api#documentation": "

The destination port of network-related information about a finding.

" - } - }, - "NetworkDestinationDomain": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The destination domain of network-related information about a finding.

" - } - }, - "ProcessName": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The name of the process.

" - } - }, - "ProcessPath": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The path to the process executable.

" - } - }, - "ProcessPid": { - "target": "com.amazonaws.securityhub#NumberFilterList", - "traits": { - "smithy.api#documentation": "

The process ID.

" - } - }, - "ProcessParentPid": { - "target": "com.amazonaws.securityhub#NumberFilterList", - "traits": { - "smithy.api#documentation": "

The parent process ID. This field accepts positive integers between O and 2147483647.

" - } - }, - "ProcessLaunchedAt": { - "target": "com.amazonaws.securityhub#DateFilterList", - "traits": { - "smithy.api#documentation": "

A timestamp that identifies when the process was launched.

\n

A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.

" - } - }, - "ProcessTerminatedAt": { - "target": "com.amazonaws.securityhub#DateFilterList", - "traits": { - "smithy.api#documentation": "

A timestamp that identifies when the process was terminated.

\n

A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.

" - } - }, - "ThreatIntelIndicatorType": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The type of a threat intelligence indicator.

" - } - }, - "ThreatIntelIndicatorValue": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The value of a threat intelligence indicator.

" - } - }, - "ThreatIntelIndicatorCategory": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The category of a threat intelligence indicator.

" - } - }, - "ThreatIntelIndicatorLastObservedAt": { - "target": "com.amazonaws.securityhub#DateFilterList", - "traits": { - "smithy.api#documentation": "

A timestamp that identifies the last observation of a threat intelligence indicator.

" - } - }, - "ThreatIntelIndicatorSource": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The source of the threat intelligence.

" - } - }, - "ThreatIntelIndicatorSourceUrl": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The URL for more details from the source of the threat intelligence.

" - } - }, - "ResourceType": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

Specifies the type of the resource that details are provided for.

" - } - }, - "ResourceId": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The canonical identifier for the given resource type.

" - } - }, - "ResourcePartition": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The canonical Amazon Web Services partition name that the Region is assigned to.

" - } - }, - "ResourceRegion": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The canonical Amazon Web Services external Region name where this resource is located.

" - } - }, - "ResourceTags": { - "target": "com.amazonaws.securityhub#MapFilterList", - "traits": { - "smithy.api#documentation": "

A list of Amazon Web Services tags associated with a resource at the time the finding was\n processed.

" - } - }, - "ResourceAwsEc2InstanceType": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The instance type of the instance.

" - } - }, - "ResourceAwsEc2InstanceImageId": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The Amazon Machine Image (AMI) ID of the instance.

" - } - }, - "ResourceAwsEc2InstanceIpV4Addresses": { - "target": "com.amazonaws.securityhub#IpFilterList", - "traits": { - "smithy.api#documentation": "

The IPv4 addresses associated with the instance.

" - } - }, - "ResourceAwsEc2InstanceIpV6Addresses": { - "target": "com.amazonaws.securityhub#IpFilterList", - "traits": { - "smithy.api#documentation": "

The IPv6 addresses associated with the instance.

" - } - }, - "ResourceAwsEc2InstanceKeyName": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The key name associated with the instance.

" - } - }, - "ResourceAwsEc2InstanceIamInstanceProfileArn": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The IAM profile ARN of the instance.

" - } - }, - "ResourceAwsEc2InstanceVpcId": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The identifier of the VPC that the instance was launched in.

" - } - }, - "ResourceAwsEc2InstanceSubnetId": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The identifier of the subnet that the instance was launched in.

" - } - }, - "ResourceAwsEc2InstanceLaunchedAt": { - "target": "com.amazonaws.securityhub#DateFilterList", - "traits": { - "smithy.api#documentation": "

The date and time the instance was launched.

" - } - }, - "ResourceAwsS3BucketOwnerId": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The canonical user ID of the owner of the S3 bucket.

" - } - }, - "ResourceAwsS3BucketOwnerName": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The display name of the owner of the S3 bucket.

" - } - }, - "ResourceAwsIamAccessKeyUserName": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#deprecated": { - "message": "This filter is deprecated. Instead, use ResourceAwsIamAccessKeyPrincipalName." - }, - "smithy.api#documentation": "

The user associated with the IAM access key related to a finding.

" - } - }, - "ResourceAwsIamAccessKeyPrincipalName": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The name of the principal that is associated with an IAM access key.

" - } - }, - "ResourceAwsIamAccessKeyStatus": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The status of the IAM access key related to a finding.

" - } - }, - "ResourceAwsIamAccessKeyCreatedAt": { - "target": "com.amazonaws.securityhub#DateFilterList", - "traits": { - "smithy.api#documentation": "

The creation date/time of the IAM access key related to a finding.

" - } - }, - "ResourceAwsIamUserUserName": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The name of an IAM user.

" - } - }, - "ResourceContainerName": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The name of the container related to a finding.

" - } - }, - "ResourceContainerImageId": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The identifier of the image related to a finding.

" - } - }, - "ResourceContainerImageName": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The name of the image related to a finding.

" - } - }, - "ResourceContainerLaunchedAt": { - "target": "com.amazonaws.securityhub#DateFilterList", - "traits": { - "smithy.api#documentation": "

A timestamp that identifies when the container was started.

\n

A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.

" - } - }, - "ResourceDetailsOther": { - "target": "com.amazonaws.securityhub#MapFilterList", - "traits": { - "smithy.api#documentation": "

The details of a resource that doesn't have a specific subfield for the resource type\n defined.

" - } - }, - "ComplianceStatus": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

Exclusive to findings that are generated as the result of a check run against a specific\n rule in a supported standard, such as CIS Amazon Web Services Foundations. Contains security\n standard-related finding details.

" - } - }, - "VerificationState": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The veracity of a finding.

" - } - }, - "WorkflowState": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The workflow state of a finding.

\n

Note that this field is deprecated. To search for a finding based on its workflow\n status, use WorkflowStatus.

" - } - }, - "WorkflowStatus": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The status of the investigation into a finding. Allowed values are the following.

\n " - } - }, - "RecordState": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The updated record state for the finding.

" - } - }, - "RelatedFindingsProductArn": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The ARN of the solution that generated a related finding.

" - } - }, - "RelatedFindingsId": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The solution-generated identifier for a related finding.

" - } - }, - "NoteText": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The text of a note.

" - } - }, - "NoteUpdatedAt": { - "target": "com.amazonaws.securityhub#DateFilterList", - "traits": { - "smithy.api#documentation": "

The timestamp of when the note was updated.

" - } - }, - "NoteUpdatedBy": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The principal that created a note.

" - } - }, - "Keyword": { - "target": "com.amazonaws.securityhub#KeywordFilterList", - "traits": { - "smithy.api#deprecated": { - "message": "The Keyword property is deprecated." - }, - "smithy.api#documentation": "

A keyword for a finding.

" - } - }, - "FindingProviderFieldsConfidence": { - "target": "com.amazonaws.securityhub#NumberFilterList", - "traits": { - "smithy.api#documentation": "

The finding provider value for the finding confidence. Confidence is defined as the likelihood\n that a finding accurately identifies the behavior or issue that it was intended to\n identify.

\n

Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent\n confidence and 100 means 100 percent confidence.

" - } - }, - "FindingProviderFieldsCriticality": { - "target": "com.amazonaws.securityhub#NumberFilterList", - "traits": { - "smithy.api#documentation": "

The finding provider value for the level of importance assigned to the resources associated with\n the findings.

\n

A score of 0 means that the underlying resources have no criticality, and a score of 100\n is reserved for the most critical resources.

" - } - }, - "FindingProviderFieldsRelatedFindingsId": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The finding identifier of a related finding that is identified by the finding provider.

" - } - }, - "FindingProviderFieldsRelatedFindingsProductArn": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The ARN of the solution that generated a related finding that is identified by the finding provider.

" - } - }, - "FindingProviderFieldsSeverityLabel": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The finding provider value for the severity label.

" - } - }, - "FindingProviderFieldsSeverityOriginal": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

The finding provider's original value for the severity.

" - } - }, - "FindingProviderFieldsTypes": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

One or more finding types that the finding provider assigned to the finding. Uses the format of namespace/category/classifier\n that classify a finding.

\n

Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual\n Behaviors | Sensitive Data Identifications

" - } - }, - "Sample": { - "target": "com.amazonaws.securityhub#BooleanFilterList", - "traits": { - "smithy.api#documentation": "

Indicates whether or not sample findings are included in the filter results.

" - } - }, - "ComplianceSecurityControlId": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

\n The unique identifier of a control across standards. Values for this field typically consist of an \n Amazon Web Service and a number, such as APIGateway.5.\n

" - } - }, - "ComplianceAssociatedStandardsId": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

\n The unique identifier of a standard in which a control is enabled. This field consists of the resource portion of the \n Amazon Resource Name (ARN) returned for a standard in the DescribeStandards API response.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A collection of attributes that are applied to all active Security Hub-aggregated findings and\n that result in a subset of findings that are included in this insight.

\n

You can filter by up to 10 finding attributes. For each attribute, you can provide up to\n 20 filter values.

" - } - }, - "com.amazonaws.securityhub#AwsSecurityFindingIdentifier": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the finding that was specified by the finding provider.

", - "smithy.api#required": {} - } - }, - "ProductArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN generated by Security Hub that uniquely identifies a product that generates findings.\n This can be the ARN for a third-party product that is integrated with Security Hub, or the ARN for\n a custom integration.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Identifies which finding to get the finding history for.

" - } - }, - "com.amazonaws.securityhub#AwsSecurityFindingIdentifierList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsSecurityFindingIdentifier" - } - }, - "com.amazonaws.securityhub#AwsSecurityFindingList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsSecurityFinding" - } - }, - "com.amazonaws.securityhub#AwsSnsTopicDetails": { - "type": "structure", - "members": { - "KmsMasterKeyId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of an Amazon Web Services managed key for Amazon SNS or a customer managed key.

" - } - }, - "Subscription": { - "target": "com.amazonaws.securityhub#AwsSnsTopicSubscriptionList", - "traits": { - "smithy.api#documentation": "

Subscription is an embedded property that describes the subscription endpoints of an Amazon SNS topic.

" - } - }, - "TopicName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the Amazon SNS topic.

" - } - }, - "Owner": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The subscription's owner.

" - } - }, - "SqsSuccessFeedbackRoleArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.\n

" - } - }, - "SqsFailureFeedbackRoleArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.\n

" - } - }, - "ApplicationSuccessFeedbackRoleArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates failed message delivery status for an Amazon SNS topic that is subscribed to a platform application endpoint.\n

" - } - }, - "FirehoseSuccessFeedbackRoleArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.\n

" - } - }, - "FirehoseFailureFeedbackRoleArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.\n

" - } - }, - "HttpSuccessFeedbackRoleArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.\n

" - } - }, - "HttpFailureFeedbackRoleArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about an Amazon SNS topic to which notifications can be published.

" - } - }, - "com.amazonaws.securityhub#AwsSnsTopicSubscription": { - "type": "structure", - "members": { - "Endpoint": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The subscription's endpoint (format depends on the protocol).

" - } - }, - "Protocol": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The subscription's protocol.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A wrapper type for the attributes of an Amazon SNS subscription.

" - } - }, - "com.amazonaws.securityhub#AwsSnsTopicSubscriptionList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsSnsTopicSubscription" - } - }, - "com.amazonaws.securityhub#AwsSqsQueueDetails": { - "type": "structure", - "members": { - "KmsDataKeyReusePeriodSeconds": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling KMS again.

" - } - }, - "KmsMasterKeyId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of an Amazon Web Services managed key for Amazon SQS or a custom\n KMS key.

" - } - }, - "QueueName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the new queue.

" - } - }, - "DeadLetterTargetArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the dead-letter queue to which Amazon SQS moves\n messages after the value of maxReceiveCount is exceeded.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Data about a queue.

" - } - }, - "com.amazonaws.securityhub#AwsSsmComplianceSummary": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The current patch compliance status. Valid values are as follows:

\n " - } - }, - "CompliantCriticalCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

For the patches that are compliant, the number that have a severity of\n CRITICAL.

" - } - }, - "CompliantHighCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

For the patches that are compliant, the number that have a severity of\n HIGH.

" - } - }, - "CompliantMediumCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

For the patches that are compliant, the number that have a severity of\n MEDIUM.

" - } - }, - "ExecutionType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of execution that was used determine compliance.

" - } - }, - "NonCompliantCriticalCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

For the patch items that are noncompliant, the number of items that have a severity of\n CRITICAL.

" - } - }, - "CompliantInformationalCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

For the patches that are compliant, the number that have a severity of\n INFORMATIONAL.

" - } - }, - "NonCompliantInformationalCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

For the patches that are noncompliant, the number that have a severity of\n INFORMATIONAL.

" - } - }, - "CompliantUnspecifiedCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

For the patches that are compliant, the number that have a severity of\n UNSPECIFIED.

" - } - }, - "NonCompliantLowCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

For the patches that are noncompliant, the number that have a severity of\n LOW.

" - } - }, - "NonCompliantHighCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

For the patches that are noncompliant, the number that have a severity of\n HIGH.

" - } - }, - "CompliantLowCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

For the patches that are compliant, the number that have a severity of\n LOW.

" - } - }, - "ComplianceType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of resource for which the compliance was determined. For\n AwsSsmPatchCompliance, ComplianceType is Patch.

" - } - }, - "PatchBaselineId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the patch baseline. The patch baseline lists the patches that are\n approved for installation.

" - } - }, - "OverallSeverity": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The highest severity for the patches. Valid values are as follows:

\n " - } - }, - "NonCompliantMediumCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

For the patches that are noncompliant, the number that have a severity of\n MEDIUM.

" - } - }, - "NonCompliantUnspecifiedCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

For the patches that are noncompliant, the number that have a severity of\n UNSPECIFIED.

" - } - }, - "PatchGroup": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the patch group for which compliance was determined. A patch group\n uses tags to group EC2 instances that should have the same patch compliance.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides the details about the compliance status for a patch.

" - } - }, - "com.amazonaws.securityhub#AwsSsmPatch": { - "type": "structure", - "members": { - "ComplianceSummary": { - "target": "com.amazonaws.securityhub#AwsSsmComplianceSummary", - "traits": { - "smithy.api#documentation": "

The compliance status details for the patch.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides details about the compliance for a patch.

" - } - }, - "com.amazonaws.securityhub#AwsSsmPatchComplianceDetails": { - "type": "structure", - "members": { - "Patch": { - "target": "com.amazonaws.securityhub#AwsSsmPatch", - "traits": { - "smithy.api#documentation": "

Information about the status of a patch.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about the state of a patch on an instance based on the patch\n baseline that was used to patch the instance.

" - } - }, - "com.amazonaws.securityhub#AwsStepFunctionStateMachineDetails": { - "type": "structure", - "members": { - "Label": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n A user-defined or an auto-generated string that identifies a Map state. This parameter is present only if \n the stateMachineArn specified in input is a qualified state machine ARN.\n

" - } - }, - "LoggingConfiguration": { - "target": "com.amazonaws.securityhub#AwsStepFunctionStateMachineLoggingConfigurationDetails", - "traits": { - "smithy.api#documentation": "

\n Used to set CloudWatch Logs options.\n

" - } - }, - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The name of the state machine.\n

" - } - }, - "RoleArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the IAM role used when creating this state machine.\n

" - } - }, - "StateMachineArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The ARN that identifies the state machine.\n

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The current status of the state machine.\n

" - } - }, - "TracingConfiguration": { - "target": "com.amazonaws.securityhub#AwsStepFunctionStateMachineTracingConfigurationDetails", - "traits": { - "smithy.api#documentation": "

\n Specifies whether X-Ray tracing is enabled.\n

" - } - }, - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The type of the state machine (STANDARD or EXPRESS).\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Provides details about an Step Functions state machine, which is a workflow consisting of a series of event-\n driven steps.\n

" - } - }, - "com.amazonaws.securityhub#AwsStepFunctionStateMachineLoggingConfigurationDestinationsCloudWatchLogsLogGroupDetails": { - "type": "structure", - "members": { - "LogGroupArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN (ends with :*) of the CloudWatch Logs log group to which you want your logs emitted.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n An object describing a CloudWatch log group. For more information, see \n \n Amazon Web Services::Logs::LogGroup in the CloudFormation User Guide.\n

" - } - }, - "com.amazonaws.securityhub#AwsStepFunctionStateMachineLoggingConfigurationDestinationsDetails": { - "type": "structure", - "members": { - "CloudWatchLogsLogGroup": { - "target": "com.amazonaws.securityhub#AwsStepFunctionStateMachineLoggingConfigurationDestinationsCloudWatchLogsLogGroupDetails", - "traits": { - "smithy.api#documentation": "

\n An object describing a CloudWatch Logs log group. For more information, see \n \n Amazon Web Services::Logs::LogGroup in the CloudFormation User Guide.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n An array of objects that describes where your execution history events will be logged.\n

" - } - }, - "com.amazonaws.securityhub#AwsStepFunctionStateMachineLoggingConfigurationDestinationsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsStepFunctionStateMachineLoggingConfigurationDestinationsDetails" - } - }, - "com.amazonaws.securityhub#AwsStepFunctionStateMachineLoggingConfigurationDetails": { - "type": "structure", - "members": { - "Destinations": { - "target": "com.amazonaws.securityhub#AwsStepFunctionStateMachineLoggingConfigurationDestinationsList", - "traits": { - "smithy.api#documentation": "

\n An array of objects that describes where your execution history events will be logged. \n

" - } - }, - "IncludeExecutionData": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

\n Determines whether execution data is included in your log. When set to false, data is excluded.\n

" - } - }, - "Level": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n Defines which category of execution history events are logged.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n The LoggingConfiguration data type is used to set CloudWatch Logs options.\n

" - } - }, - "com.amazonaws.securityhub#AwsStepFunctionStateMachineTracingConfigurationDetails": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

\n When set to true, X-Ray tracing is enabled.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Specifies whether X-Ray tracing is enabled.\n

" - } - }, - "com.amazonaws.securityhub#AwsWafRateBasedRuleDetails": { - "type": "structure", - "members": { - "MetricName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the metrics for the rate-based rule.

" - } - }, - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the rate-based rule.

" - } - }, - "RateKey": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The field that WAF uses to determine whether requests are likely arriving from single source and are subject to rate monitoring.

" - } - }, - "RateLimit": { - "target": "com.amazonaws.securityhub#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of requests that have an identical value for the field specified in RateKey that are allowed within a five-minute period. If the number of requests exceeds RateLimit and the other predicates specified in the rule are met, WAF triggers the action for the rule.

" - } - }, - "RuleId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The unique identifier for the rate-based rule.

" - } - }, - "MatchPredicates": { - "target": "com.amazonaws.securityhub#AwsWafRateBasedRuleMatchPredicateList", - "traits": { - "smithy.api#documentation": "

The predicates to include in the rate-based rule.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about a rate-based rule for global resources. A rate-based rule provides settings to indicate when to allow, block, or count a request. Rate-based rules include the number of requests that arrive over a specified period of time.

" - } - }, - "com.amazonaws.securityhub#AwsWafRateBasedRuleMatchPredicate": { - "type": "structure", - "members": { - "DataId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The unique identifier for the predicate.

" - } - }, - "Negated": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

If set to true, then the rule actions are performed on requests that match the predicate settings.

\n

If set to false, then the rule actions are performed on all requests except those that match the predicate settings.\n

" - } - }, - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of predicate. Valid values are as follows:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

A match predicate. A predicate might look for characteristics such as specific IP addresses, geographic locations, or sizes.

" - } - }, - "com.amazonaws.securityhub#AwsWafRateBasedRuleMatchPredicateList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsWafRateBasedRuleMatchPredicate" - } - }, - "com.amazonaws.securityhub#AwsWafRegionalRateBasedRuleDetails": { - "type": "structure", - "members": { - "MetricName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the metrics for the rate-based rule.

" - } - }, - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the rate-based rule.

" - } - }, - "RateKey": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The field that WAF uses to determine whether requests are likely arriving from single source and are subject to rate monitoring.

" - } - }, - "RateLimit": { - "target": "com.amazonaws.securityhub#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of requests that have an identical value for the field specified in RateKey that are allowed within a five-minute period. If the number of requests exceeds RateLimit and the other predicates specified in the rule are met, WAF triggers the action for the rule.

" - } - }, - "RuleId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The unique identifier for the rate-based rule.

" - } - }, - "MatchPredicates": { - "target": "com.amazonaws.securityhub#AwsWafRegionalRateBasedRuleMatchPredicateList", - "traits": { - "smithy.api#documentation": "

The predicates to include in the rate-based rule.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

contains details about a rate-based rule for Regional resources. A rate-based rule provides settings to indicate when to allow, block, or count a request. Rate-based rules include the number of requests that arrive over a specified period of time.

" - } - }, - "com.amazonaws.securityhub#AwsWafRegionalRateBasedRuleMatchPredicate": { - "type": "structure", - "members": { - "DataId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The unique identifier for the predicate.

" - } - }, - "Negated": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

If set to true, then the rule actions are performed on requests that match the predicate settings.

\n

If set to false, then the rule actions are performed on all requests except those that match the predicate settings.

" - } - }, - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of predicate. Valid values are as follows:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Details for a match predicate. A predicate might look for characteristics such as specific IP addresses, geographic locations, or sizes.

" - } - }, - "com.amazonaws.securityhub#AwsWafRegionalRateBasedRuleMatchPredicateList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsWafRegionalRateBasedRuleMatchPredicate" - } - }, - "com.amazonaws.securityhub#AwsWafRegionalRuleDetails": { - "type": "structure", - "members": { - "MetricName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A name for the metrics for the rule. \n

" - } - }, - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A descriptive name for the rule.\n

" - } - }, - "PredicateList": { - "target": "com.amazonaws.securityhub#AwsWafRegionalRulePredicateList", - "traits": { - "smithy.api#documentation": "

Specifies the ByteMatchSet, IPSet,\n SqlInjectionMatchSet, XssMatchSet, RegexMatchSet,\n GeoMatchSet, and SizeConstraintSet objects that you want to\n add to a rule and, for each object, indicates whether you want to negate the settings.

" - } - }, - "RuleId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the rule.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about an WAF Regional rule. This rule identifies the web requests that you want to allow, block, or count.

" - } - }, - "com.amazonaws.securityhub#AwsWafRegionalRuleGroupDetails": { - "type": "structure", - "members": { - "MetricName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A name for the metrics for this rule group.\n

" - } - }, - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The descriptive name of the rule group.\n

" - } - }, - "RuleGroupId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the rule group.\n

" - } - }, - "Rules": { - "target": "com.amazonaws.securityhub#AwsWafRegionalRuleGroupRulesList", - "traits": { - "smithy.api#documentation": "

Provides information about the rule statements used to identify the web requests that you want to allow, block, or \ncount. \n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about an WAF Regional rule group. The rule group is a collection of rules for inspecting and controlling web\n requests.

" - } - }, - "com.amazonaws.securityhub#AwsWafRegionalRuleGroupRulesActionDetails": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, \nGeoMatchSet, and SizeConstraintSet objects that you want to add to a rule and, for each object, indicates whether you want to negate the settings.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the action that WAF should take on a web request when it matches the criteria defined in the rule.\n

" - } - }, - "com.amazonaws.securityhub#AwsWafRegionalRuleGroupRulesDetails": { - "type": "structure", - "members": { - "Action": { - "target": "com.amazonaws.securityhub#AwsWafRegionalRuleGroupRulesActionDetails", - "traits": { - "smithy.api#documentation": "

The action that WAF should take on a web request when it matches the criteria defined in the rule.

" - } - }, - "Priority": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

If you define more than one rule in a web ACL, WAF evaluates each request against the rules in\n order based on the value of Priority.

" - } - }, - "RuleId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID for a rule.\n

" - } - }, - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of rule in the rule group.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about the rules attached to a rule group\n

" - } - }, - "com.amazonaws.securityhub#AwsWafRegionalRuleGroupRulesList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsWafRegionalRuleGroupRulesDetails" - } - }, - "com.amazonaws.securityhub#AwsWafRegionalRulePredicateList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsWafRegionalRulePredicateListDetails" - } - }, - "com.amazonaws.securityhub#AwsWafRegionalRulePredicateListDetails": { - "type": "structure", - "members": { - "DataId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A unique identifier for a predicate in a rule, such as ByteMatchSetId or IPSetId.\n

" - } - }, - "Negated": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies if you want WAF to allow, block, or count requests based on the settings in the \n ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, \n RegexMatchSet, GeoMatchSet, or SizeConstraintSet.\n

" - } - }, - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of predicate in a rule, such as ByteMatch or IPSet.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides details about the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, \n 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.\n

" - } - }, - "com.amazonaws.securityhub#AwsWafRegionalWebAclDetails": { - "type": "structure", - "members": { - "DefaultAction": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The action to perform if none of the rules contained in the web ACL match. \n

" - } - }, - "MetricName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A name for the metrics for this web ACL. \n

" - } - }, - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A descriptive name for the web ACL. \n

" - } - }, - "RulesList": { - "target": "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesList", - "traits": { - "smithy.api#documentation": "

An array that contains the action for each rule in a web ACL, the priority of the rule, and the ID of \nthe rule.\n

" - } - }, - "WebAclId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the web ACL.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about the web access control list (web ACL). The web ACL contains the rules that identify the requests that you\n want to allow, block, or count.

" - } - }, - "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesListDetails" - } - }, - "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesListActionDetails": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

For actions that are associated with a rule, the action that WAF takes when a web request matches all conditions in a rule.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The action that WAF takes when a web request matches all conditions in the\n rule, such as allow, block, or count the request.

" - } - }, - "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesListDetails": { - "type": "structure", - "members": { - "Action": { - "target": "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesListActionDetails", - "traits": { - "smithy.api#documentation": "

The action that WAF takes when a web request matches all conditions in the rule, such as allow, \n block, or count the request.\n

" - } - }, - "OverrideAction": { - "target": "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesListOverrideActionDetails", - "traits": { - "smithy.api#documentation": "

Overrides the rule evaluation result in the rule group. \n

" - } - }, - "Priority": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The order in which WAF evaluates the rules in a web ACL.\n

" - } - }, - "RuleId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of an WAF Regional rule to associate with a web ACL.

" - } - }, - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

For actions that are associated with a rule, the action that WAF takes when a web \nrequest matches all conditions in a rule.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A combination of ByteMatchSet, IPSet, and/or SqlInjectionMatchSet \nobjects that identify the web requests that you want to allow, block, or count. \n

" - } - }, - "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesListOverrideActionDetails": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Overrides the rule evaluation result in the rule group.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides details about the action to use in the place of the action that results from the rule group \nevaluation. \n

" - } - }, - "com.amazonaws.securityhub#AwsWafRuleDetails": { - "type": "structure", - "members": { - "MetricName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the metrics for this rule.\n

" - } - }, - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A descriptive name for the rule. \n

" - } - }, - "PredicateList": { - "target": "com.amazonaws.securityhub#AwsWafRulePredicateList", - "traits": { - "smithy.api#documentation": "

Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, \n RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a rule and, \n for each object, indicates whether you want to negate the settings.\n

" - } - }, - "RuleId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the WAF rule. \n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about a WAF rule. This rule specifies the web requests that you want to allow, block, or count.\n

" - } - }, - "com.amazonaws.securityhub#AwsWafRuleGroupDetails": { - "type": "structure", - "members": { - "MetricName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the metrics for this rule group. \n

" - } - }, - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the rule group. \n

" - } - }, - "RuleGroupId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the rule group.\n

" - } - }, - "Rules": { - "target": "com.amazonaws.securityhub#AwsWafRuleGroupRulesList", - "traits": { - "smithy.api#documentation": "

Provides information about the rules attached to the rule group. These rules identify the web requests that you want to \nallow, block, or count. \n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about an WAF rule group. A rule group is a collection of rules for inspecting and controlling web requests. \n

" - } - }, - "com.amazonaws.securityhub#AwsWafRuleGroupRulesActionDetails": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The action that WAF should take on a web request when it matches the rule's\n statement.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about what action WAF should take on a web request when it matches the criteria defined in the rule.\n

" - } - }, - "com.amazonaws.securityhub#AwsWafRuleGroupRulesDetails": { - "type": "structure", - "members": { - "Action": { - "target": "com.amazonaws.securityhub#AwsWafRuleGroupRulesActionDetails", - "traits": { - "smithy.api#documentation": "

Provides information about what action WAF should take on a web request when it matches the criteria defined in the rule.\n

" - } - }, - "Priority": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

If you define more than one rule in a web ACL, WAF evaluates each request against the rules in order\n based on the value of Priority.

" - } - }, - "RuleId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The rule ID for a rule.\n

" - } - }, - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of rule.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about the rules attached to the rule group. These rules identify the web requests that you want to \n allow, block, or count. \n

" - } - }, - "com.amazonaws.securityhub#AwsWafRuleGroupRulesList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsWafRuleGroupRulesDetails" - } - }, - "com.amazonaws.securityhub#AwsWafRulePredicateList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsWafRulePredicateListDetails" - } - }, - "com.amazonaws.securityhub#AwsWafRulePredicateListDetails": { - "type": "structure", - "members": { - "DataId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A unique identifier for a predicate in a rule, such as ByteMatchSetId or IPSetId.\n

" - } - }, - "Negated": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies if you want WAF to allow, block, or count requests based on the settings in the \n ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, \n RegexMatchSet, GeoMatchSet, or SizeConstraintSet.\n

" - } - }, - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of predicate in a rule, such as ByteMatch or IPSet.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides details about the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, \n RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a rule and, \nfor each object, indicates whether you want to negate the settings.\n

" - } - }, - "com.amazonaws.securityhub#AwsWafWebAclDetails": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A friendly name or description of the web ACL. You can't change the name of a web ACL after you create it.

" - } - }, - "DefaultAction": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The action to perform if none of the rules contained in the web ACL match.

" - } - }, - "Rules": { - "target": "com.amazonaws.securityhub#AwsWafWebAclRuleList", - "traits": { - "smithy.api#documentation": "

An array that contains the action for each rule in a web ACL, the priority of the rule, and the ID of the rule.

" - } - }, - "WebAclId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A unique identifier for a web ACL.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about an WAF web access control list (web ACL).

" - } - }, - "com.amazonaws.securityhub#AwsWafWebAclRule": { - "type": "structure", - "members": { - "Action": { - "target": "com.amazonaws.securityhub#WafAction", - "traits": { - "smithy.api#documentation": "

Specifies the action that CloudFront or WAF takes when a web request matches the\n conditions in the rule.

" - } - }, - "ExcludedRules": { - "target": "com.amazonaws.securityhub#WafExcludedRuleList", - "traits": { - "smithy.api#documentation": "

Rules to exclude from a rule group.

" - } - }, - "OverrideAction": { - "target": "com.amazonaws.securityhub#WafOverrideAction", - "traits": { - "smithy.api#documentation": "

Use the OverrideAction to test your RuleGroup.

\n

Any rule in a RuleGroup can potentially block a request. If you set the OverrideAction to\n None, the RuleGroup blocks a request if any individual rule in the RuleGroup\n matches the request and is configured to block that request.

\n

However, if you first want to test the RuleGroup,\n set the OverrideAction to Count. The RuleGroup\n then overrides any block action specified by individual rules contained within the group.\n Instead of blocking matching requests, those requests are counted.

\n

\n ActivatedRule|OverrideAction applies only when updating or\n adding a RuleGroup\n to a web ACL. In this case you do not use ActivatedRule\n Action. For all other update requests,\n ActivatedRule\n Action is used instead of ActivatedRule\n OverrideAction.

" - } - }, - "Priority": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies the order in which the rules in a web\n ACL are evaluated. Rules with a lower value for Priority are\n evaluated before rules with a higher value. The value must be a unique integer. If you add\n multiple rules to a web ACL, the values do not need to be consecutive.

" - } - }, - "RuleId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier for a rule.

" - } - }, - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The rule type.

\n

Valid values: REGULAR | RATE_BASED | GROUP\n

\n

The default is REGULAR.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details for a rule in an WAF web ACL.

" - } - }, - "com.amazonaws.securityhub#AwsWafWebAclRuleList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsWafWebAclRule" - } - }, - "com.amazonaws.securityhub#AwsWafv2ActionAllowDetails": { - "type": "structure", - "members": { - "CustomRequestHandling": { - "target": "com.amazonaws.securityhub#AwsWafv2CustomRequestHandlingDetails", - "traits": { - "smithy.api#documentation": "

\n Defines custom handling for the web request. For information about customizing web requests and responses, see \n Customizing web requests and responses in WAF in the WAF Developer Guide..\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Specifies that WAF should allow the request and optionally defines additional custom handling for the request.\n

" - } - }, - "com.amazonaws.securityhub#AwsWafv2ActionBlockDetails": { - "type": "structure", - "members": { - "CustomResponse": { - "target": "com.amazonaws.securityhub#AwsWafv2CustomResponseDetails", - "traits": { - "smithy.api#documentation": "

\n Defines a custom response for the web request. For information, see \n Customizing web requests and responses in WAF in the WAF Developer Guide..\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Specifies that WAF should block the request and optionally defines additional custom handling for the response to the web request.\n

" - } - }, - "com.amazonaws.securityhub#AwsWafv2CustomHttpHeader": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The name of the custom header.\n

" - } - }, - "Value": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The value of the custom header.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n A custom header for custom request and response handling.\n

" - } - }, - "com.amazonaws.securityhub#AwsWafv2CustomRequestHandlingDetails": { - "type": "structure", - "members": { - "InsertHeaders": { - "target": "com.amazonaws.securityhub#AwsWafv2InsertHeadersList", - "traits": { - "smithy.api#documentation": "

\n The HTTP headers to insert into the request.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Custom request handling behavior that inserts custom headers into a web request. WAF uses custom request handling when the rule action doesn't block the request.\n

" - } - }, - "com.amazonaws.securityhub#AwsWafv2CustomResponseDetails": { - "type": "structure", - "members": { - "CustomResponseBodyKey": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n References the response body that you want WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block.\n

" - } - }, - "ResponseCode": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The HTTP status code to return to the client. For a list of status codes that you can use in your custom responses, see \n Supported status codes for custom response in the WAF Developer Guide.\n

" - } - }, - "ResponseHeaders": { - "target": "com.amazonaws.securityhub#AwsWafv2InsertHeadersList", - "traits": { - "smithy.api#documentation": "

\n The HTTP headers to use in the response.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n A custom response to send to the client. You can define a custom response for rule actions and default web ACL actions that are set to block.\n

" - } - }, - "com.amazonaws.securityhub#AwsWafv2InsertHeadersList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsWafv2CustomHttpHeader" - } - }, - "com.amazonaws.securityhub#AwsWafv2RuleGroupDetails": { - "type": "structure", - "members": { - "Capacity": { - "target": "com.amazonaws.securityhub#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The web ACL capacity units (WCUs) required for this rule group. \n

" - } - }, - "Description": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n A description of the rule group that helps with identification.\n

" - } - }, - "Id": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n A unique identifier for the rule group. \n

" - } - }, - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The name of the rule group. You cannot change the name of a rule group after you create it.\n

" - } - }, - "Arn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the entity.\n

" - } - }, - "Rules": { - "target": "com.amazonaws.securityhub#AwsWafv2RulesList", - "traits": { - "smithy.api#documentation": "

\n The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one \n top-level statement that WAF uses to identify matching web requests, and parameters that govern how \n WAF handles them.\n

" - } - }, - "Scope": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n Specifies whether the rule group is for an Amazon CloudFront distribution or for a regional application. \n A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync \n GraphQL API, or an Amazon Cognito user pool.\n

" - } - }, - "VisibilityConfig": { - "target": "com.amazonaws.securityhub#AwsWafv2VisibilityConfigDetails", - "traits": { - "smithy.api#documentation": "

\n Defines and enables Amazon CloudWatch metrics and web request sample collection.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Details about an WAFv2 rule group.\n

" - } - }, - "com.amazonaws.securityhub#AwsWafv2RulesActionCaptchaDetails": { - "type": "structure", - "members": { - "CustomRequestHandling": { - "target": "com.amazonaws.securityhub#AwsWafv2CustomRequestHandlingDetails", - "traits": { - "smithy.api#documentation": "

\n Defines custom handling for the web request, used when the CAPTCHA inspection determines that the request's token is valid and unexpired. For more information, \n see Customizing web requests and responses in WAF in the WAF Developer Guide..\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Specifies that WAF should run a CAPTCHA check against the request.\n

" - } - }, - "com.amazonaws.securityhub#AwsWafv2RulesActionCountDetails": { - "type": "structure", - "members": { - "CustomRequestHandling": { - "target": "com.amazonaws.securityhub#AwsWafv2CustomRequestHandlingDetails", - "traits": { - "smithy.api#documentation": "

\n Defines custom handling for the web request. For more information, \n see Customizing web requests and responses in WAF in the WAF Developer Guide..\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Specifies that WAF should count the request.\n

" - } - }, - "com.amazonaws.securityhub#AwsWafv2RulesActionDetails": { - "type": "structure", - "members": { - "Allow": { - "target": "com.amazonaws.securityhub#AwsWafv2ActionAllowDetails", - "traits": { - "smithy.api#documentation": "

\n Instructs WAF to allow the web request.\n

" - } - }, - "Block": { - "target": "com.amazonaws.securityhub#AwsWafv2ActionBlockDetails", - "traits": { - "smithy.api#documentation": "

\n Instructs WAF to block the web request.\n

" - } - }, - "Captcha": { - "target": "com.amazonaws.securityhub#AwsWafv2RulesActionCaptchaDetails", - "traits": { - "smithy.api#documentation": "

\n Instructs WAF to run a CAPTCHA check against the web request.\n

" - } - }, - "Count": { - "target": "com.amazonaws.securityhub#AwsWafv2RulesActionCountDetails", - "traits": { - "smithy.api#documentation": "

\n Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n The action that WAF should take on a web request when it matches a rule's statement. \n Settings at the web ACL level can override the rule action setting.\n

" - } - }, - "com.amazonaws.securityhub#AwsWafv2RulesDetails": { - "type": "structure", - "members": { - "Action": { - "target": "com.amazonaws.securityhub#AwsWafv2RulesActionDetails", - "traits": { - "smithy.api#documentation": "

\n The action that WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting.\n

" - } - }, - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The name of the rule. \n

" - } - }, - "OverrideAction": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The action to use in the place of the action that results from the rule group evaluation. \n

" - } - }, - "Priority": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n If you define more than one Rule in a WebACL, WAF evaluates each request against the Rules in order based on the value of Priority. \n WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.\n

" - } - }, - "VisibilityConfig": { - "target": "com.amazonaws.securityhub#AwsWafv2VisibilityConfigDetails", - "traits": { - "smithy.api#documentation": "

\n Defines and enables Amazon CloudWatch metrics and web request sample collection.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Provides details about rules in a rule group. A rule identifies web requests that you want to allow, block, or count. Each rule includes one top-level Statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.\n

" - } - }, - "com.amazonaws.securityhub#AwsWafv2RulesList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsWafv2RulesDetails" - } - }, - "com.amazonaws.securityhub#AwsWafv2VisibilityConfigDetails": { - "type": "structure", - "members": { - "CloudWatchMetricsEnabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

\n A boolean indicating whether the associated resource sends metrics to Amazon CloudWatch. For the list of available \n metrics, see WAF metrics and dimensions in the WAF Developer Guide.\n

" - } - }, - "MetricName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n A name of the Amazon CloudWatch metric. \n

" - } - }, - "SampledRequestsEnabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

\n A boolean indicating whether WAF should store a sampling of the web requests that match the rules. \n You can view the sampled requests through the WAF console.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Defines and enables Amazon CloudWatch metrics and web request sample collection.\n

" - } - }, - "com.amazonaws.securityhub#AwsWafv2WebAclActionDetails": { - "type": "structure", - "members": { - "Allow": { - "target": "com.amazonaws.securityhub#AwsWafv2ActionAllowDetails", - "traits": { - "smithy.api#documentation": "

\n Specifies that WAF should allow requests by default.\n

" - } - }, - "Block": { - "target": "com.amazonaws.securityhub#AwsWafv2ActionBlockDetails", - "traits": { - "smithy.api#documentation": "

\n Specifies that WAF should block requests by default.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Specifies the action that Amazon CloudFront or WAF takes when a web request matches the conditions in the rule.\n

" - } - }, - "com.amazonaws.securityhub#AwsWafv2WebAclCaptchaConfigDetails": { - "type": "structure", - "members": { - "ImmunityTimeProperty": { - "target": "com.amazonaws.securityhub#AwsWafv2WebAclCaptchaConfigImmunityTimePropertyDetails", - "traits": { - "smithy.api#documentation": "

\n Determines how long a CAPTCHA timestamp in the token remains valid after the client successfully solves a CAPTCHA puzzle.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings.\n

" - } - }, - "com.amazonaws.securityhub#AwsWafv2WebAclCaptchaConfigImmunityTimePropertyDetails": { - "type": "structure", - "members": { - "ImmunityTime": { - "target": "com.amazonaws.securityhub#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The amount of time, in seconds, that a CAPTCHA or challenge timestamp is considered valid by WAF.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Used for CAPTCHA and challenge token settings. Determines how long a CAPTCHA or challenge timestamp remains valid after WAF updates it for a successful CAPTCHA or challenge response.\n

" - } - }, - "com.amazonaws.securityhub#AwsWafv2WebAclDetails": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The name of the web ACL.\n

" - } - }, - "Arn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.\n

" - } - }, - "ManagedbyFirewallManager": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

\n Indicates whether this web ACL is managed by Firewall Manager. \n

" - } - }, - "Id": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n A unique identifier for the web ACL.\n

" - } - }, - "Capacity": { - "target": "com.amazonaws.securityhub#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The web ACL capacity units (WCUs) currently being used by this web ACL.\n

" - } - }, - "CaptchaConfig": { - "target": "com.amazonaws.securityhub#AwsWafv2WebAclCaptchaConfigDetails", - "traits": { - "smithy.api#documentation": "

\n Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own \n CaptchaConfig settings.\n

" - } - }, - "DefaultAction": { - "target": "com.amazonaws.securityhub#AwsWafv2WebAclActionDetails", - "traits": { - "smithy.api#documentation": "

\n The action to perform if none of the Rules contained in the web ACL match.\n

" - } - }, - "Description": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n A description of the web ACL that helps with identification.\n

" - } - }, - "Rules": { - "target": "com.amazonaws.securityhub#AwsWafv2RulesList", - "traits": { - "smithy.api#documentation": "

\n The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one \n top-level statement that WAF uses to identify matching web requests, and parameters that govern how \n WAF handles them.\n

" - } - }, - "VisibilityConfig": { - "target": "com.amazonaws.securityhub#AwsWafv2VisibilityConfigDetails", - "traits": { - "smithy.api#documentation": "

\n Defines and enables Amazon CloudWatch metrics and web request sample collection.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Details about an WAFv2 web Access Control List (ACL).\n

" - } - }, - "com.amazonaws.securityhub#AwsXrayEncryptionConfigDetails": { - "type": "structure", - "members": { - "KeyId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the KMS key that is used for encryption. Provided if Type is KMS.

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The current status of the encryption configuration. Valid values are ACTIVE or UPDATING.

\n

When Status is equal to UPDATING, X-Ray might use both the old and new encryption.

" - } - }, - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of encryption. KMS indicates that the encryption uses KMS keys. NONE indicates the default encryption.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the encryption configuration for X-Ray.

" - } - }, - "com.amazonaws.securityhub#BatchDisableStandards": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#BatchDisableStandardsRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#BatchDisableStandardsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - } - ], - "traits": { - "smithy.api#documentation": "

Disables the standards specified by the provided\n StandardsSubscriptionArns.

\n

For more information, see Security Standards section of the Security Hub User\n Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/standards/deregister", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#BatchDisableStandardsRequest": { - "type": "structure", - "members": { - "StandardsSubscriptionArns": { - "target": "com.amazonaws.securityhub#StandardsSubscriptionArns", - "traits": { - "smithy.api#documentation": "

The ARNs of the standards subscriptions to disable.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#BatchDisableStandardsResponse": { - "type": "structure", - "members": { - "StandardsSubscriptions": { - "target": "com.amazonaws.securityhub#StandardsSubscriptions", - "traits": { - "smithy.api#documentation": "

The details of the standards subscriptions that were disabled.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#BatchEnableStandards": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#BatchEnableStandardsRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#BatchEnableStandardsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - } - ], - "traits": { - "smithy.api#documentation": "

Enables the standards specified by the provided StandardsArn. To obtain the\n ARN for a standard, use the DescribeStandards\n operation.

\n

For more information, see the Security Standards\n section of the Security Hub User Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/standards/register", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#BatchEnableStandardsRequest": { - "type": "structure", - "members": { - "StandardsSubscriptionRequests": { - "target": "com.amazonaws.securityhub#StandardsSubscriptionRequests", - "traits": { - "smithy.api#documentation": "

The list of standards checks to enable.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#BatchEnableStandardsResponse": { - "type": "structure", - "members": { - "StandardsSubscriptions": { - "target": "com.amazonaws.securityhub#StandardsSubscriptions", - "traits": { - "smithy.api#documentation": "

The details of the standards subscriptions that were enabled.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#BatchGetSecurityControls": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#BatchGetSecurityControlsRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#BatchGetSecurityControlsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Provides details about a batch of security controls for the current Amazon Web Services account and Amazon Web Services Region.\n

", - "smithy.api#http": { - "method": "POST", - "uri": "/securityControls/batchGet", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#BatchGetSecurityControlsRequest": { - "type": "structure", - "members": { - "SecurityControlIds": { - "target": "com.amazonaws.securityhub#StringList", - "traits": { - "smithy.api#documentation": "

A list of security controls (identified with SecurityControlId,\n SecurityControlArn, or a mix of both parameters). The security control ID\n or Amazon Resource Name (ARN) is the same across standards.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#BatchGetSecurityControlsResponse": { - "type": "structure", - "members": { - "SecurityControls": { - "target": "com.amazonaws.securityhub#SecurityControls", - "traits": { - "smithy.api#documentation": "

\n An array that returns the identifier, Amazon Resource Name (ARN), and other details about a security control. \n The same information is returned whether the request includes SecurityControlId or SecurityControlArn.\n

", - "smithy.api#required": {} - } - }, - "UnprocessedIds": { - "target": "com.amazonaws.securityhub#UnprocessedSecurityControls", - "traits": { - "smithy.api#documentation": "

\n A security control (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters) for which \n details cannot be returned.\n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#BatchGetStandardsControlAssociations": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#BatchGetStandardsControlAssociationsRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#BatchGetStandardsControlAssociationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - } - ], - "traits": { - "smithy.api#documentation": "

\n For a batch of security controls and standards, identifies whether each control is currently enabled or disabled in a standard.\n

", - "smithy.api#http": { - "method": "POST", - "uri": "/associations/batchGet", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#BatchGetStandardsControlAssociationsRequest": { - "type": "structure", - "members": { - "StandardsControlAssociationIds": { - "target": "com.amazonaws.securityhub#StandardsControlAssociationIds", - "traits": { - "smithy.api#documentation": "

\n An array with one or more objects that includes a security control (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters) and the Amazon Resource Name (ARN) of a standard. \n This field is used to query the enablement status of a control in a specified standard. The security control ID or ARN is the same across standards.\n

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#BatchGetStandardsControlAssociationsResponse": { - "type": "structure", - "members": { - "StandardsControlAssociationDetails": { - "target": "com.amazonaws.securityhub#StandardsControlAssociationDetails", - "traits": { - "smithy.api#documentation": "

Provides the enablement status of a security control in a specified standard and other details for the control in relation to \n the specified standard.\n

", - "smithy.api#required": {} - } - }, - "UnprocessedAssociations": { - "target": "com.amazonaws.securityhub#UnprocessedStandardsControlAssociations", - "traits": { - "smithy.api#documentation": "

\n A security control (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters) whose enablement \n status in a specified standard cannot be returned.\n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#BatchImportFindings": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#BatchImportFindingsRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#BatchImportFindingsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - } - ], - "traits": { - "smithy.api#documentation": "

Imports security findings generated by a finding provider into Security Hub.\n This action is requested by the finding provider to import its findings into\n Security Hub.

\n

\n BatchImportFindings must be called by one of the following:

\n \n

The maximum allowed size for a finding is 240 Kb. An error is returned for any finding\n larger than 240 Kb.

\n

After a finding is created, BatchImportFindings cannot be used to update\n the following finding fields and objects, which Security Hub customers use to manage their\n investigation workflow.

\n \n

Finding providers also should not use BatchImportFindings to update the following attributes.

\n \n

Instead, finding providers use FindingProviderFields to provide values for these attributes.

", - "smithy.api#http": { - "method": "POST", - "uri": "/findings/import", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#BatchImportFindingsRequest": { - "type": "structure", - "members": { - "Findings": { - "target": "com.amazonaws.securityhub#BatchImportFindingsRequestFindingList", - "traits": { - "smithy.api#documentation": "

A list of findings to import. To successfully import a finding, it must follow the\n Amazon Web Services Security Finding Format. Maximum of 100 findings per request.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#BatchImportFindingsRequestFindingList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsSecurityFinding" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.securityhub#BatchImportFindingsResponse": { - "type": "structure", - "members": { - "FailedCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of findings that failed to import.

", - "smithy.api#required": {} - } - }, - "SuccessCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of findings that were successfully imported.

", - "smithy.api#required": {} - } - }, - "FailedFindings": { - "target": "com.amazonaws.securityhub#ImportFindingsErrorList", - "traits": { - "smithy.api#documentation": "

The list of findings that failed to import.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#BatchUpdateFindings": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#BatchUpdateFindingsRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#BatchUpdateFindingsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - } - ], - "traits": { - "smithy.api#documentation": "

Used by Security Hub customers to update information about their investigation into a finding.\n Requested by administrator accounts or member accounts. Administrator accounts can update findings for\n their account and their member accounts. Member accounts can update findings for their\n account.

\n

Updates from BatchUpdateFindings do not affect the value of\n UpdatedAt for a finding.

\n

Administrator and member accounts can use BatchUpdateFindings to update the\n following finding fields and objects.

\n \n

You can configure IAM policies to restrict access to fields and field values. For\n example, you might not want member accounts to be able to suppress findings or change the\n finding severity. See Configuring access to BatchUpdateFindings in the\n Security Hub User Guide.

", - "smithy.api#http": { - "method": "PATCH", - "uri": "/findings/batchupdate", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#BatchUpdateFindingsRequest": { - "type": "structure", - "members": { - "FindingIdentifiers": { - "target": "com.amazonaws.securityhub#AwsSecurityFindingIdentifierList", - "traits": { - "smithy.api#documentation": "

The list of findings to update. BatchUpdateFindings can be used to update\n up to 100 findings at a time.

\n

For each finding, the list provides the finding identifier and the ARN of the finding\n provider.

", - "smithy.api#required": {} - } - }, - "Note": { - "target": "com.amazonaws.securityhub#NoteUpdate" - }, - "Severity": { - "target": "com.amazonaws.securityhub#SeverityUpdate", - "traits": { - "smithy.api#documentation": "

Used to update the finding severity.

" - } - }, - "VerificationState": { - "target": "com.amazonaws.securityhub#VerificationState", - "traits": { - "smithy.api#documentation": "

Indicates the veracity of a finding.

\n

The available values for VerificationState are as follows.

\n " - } - }, - "Confidence": { - "target": "com.amazonaws.securityhub#RatioScale", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The updated value for the finding confidence. Confidence is defined as the likelihood\n that a finding accurately identifies the behavior or issue that it was intended to\n identify.

\n

Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent\n confidence and 100 means 100 percent confidence.

" - } - }, - "Criticality": { - "target": "com.amazonaws.securityhub#RatioScale", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The updated value for the level of importance assigned to the resources associated with\n the findings.

\n

A score of 0 means that the underlying resources have no criticality, and a score of 100\n is reserved for the most critical resources.

" - } - }, - "Types": { - "target": "com.amazonaws.securityhub#TypeList", - "traits": { - "smithy.api#documentation": "

One or more finding types in the format of namespace/category/classifier that classify a\n finding.

\n

Valid namespace values are as follows.

\n " - } - }, - "UserDefinedFields": { - "target": "com.amazonaws.securityhub#FieldMap", - "traits": { - "smithy.api#documentation": "

A list of name/value string pairs associated with the finding. These are custom,\n user-defined fields added to a finding.

" - } - }, - "Workflow": { - "target": "com.amazonaws.securityhub#WorkflowUpdate", - "traits": { - "smithy.api#documentation": "

Used to update the workflow status of a finding.

\n

The workflow status indicates the progress of the investigation into the finding.

" - } - }, - "RelatedFindings": { - "target": "com.amazonaws.securityhub#RelatedFindingList", - "traits": { - "smithy.api#documentation": "

A list of findings that are related to the updated findings.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#BatchUpdateFindingsResponse": { - "type": "structure", - "members": { - "ProcessedFindings": { - "target": "com.amazonaws.securityhub#AwsSecurityFindingIdentifierList", - "traits": { - "smithy.api#documentation": "

The list of findings that were updated successfully.

", - "smithy.api#required": {} - } - }, - "UnprocessedFindings": { - "target": "com.amazonaws.securityhub#BatchUpdateFindingsUnprocessedFindingsList", - "traits": { - "smithy.api#documentation": "

The list of findings that were not updated.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#BatchUpdateFindingsUnprocessedFinding": { - "type": "structure", - "members": { - "FindingIdentifier": { - "target": "com.amazonaws.securityhub#AwsSecurityFindingIdentifier", - "traits": { - "smithy.api#documentation": "

The identifier of the finding that was not updated.

", - "smithy.api#required": {} - } - }, - "ErrorCode": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The code associated with the error. Possible values are:

\n ", - "smithy.api#required": {} - } - }, - "ErrorMessage": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The message associated with the error. Possible values are:

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A finding from a BatchUpdateFindings request that Security Hub was unable to\n update.

" - } - }, - "com.amazonaws.securityhub#BatchUpdateFindingsUnprocessedFindingsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#BatchUpdateFindingsUnprocessedFinding" - } - }, - "com.amazonaws.securityhub#BatchUpdateStandardsControlAssociations": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#BatchUpdateStandardsControlAssociationsRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#BatchUpdateStandardsControlAssociationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - } - ], - "traits": { - "smithy.api#documentation": "

\n For a batch of security controls and standards, this operation updates the enablement status of a control in a standard.\n

", - "smithy.api#http": { - "method": "PATCH", - "uri": "/associations", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#BatchUpdateStandardsControlAssociationsRequest": { - "type": "structure", - "members": { - "StandardsControlAssociationUpdates": { - "target": "com.amazonaws.securityhub#StandardsControlAssociationUpdates", - "traits": { - "smithy.api#documentation": "

\n Updates the enablement status of a security control in a specified standard.\n

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#BatchUpdateStandardsControlAssociationsResponse": { - "type": "structure", - "members": { - "UnprocessedAssociationUpdates": { - "target": "com.amazonaws.securityhub#UnprocessedStandardsControlAssociationUpdates", - "traits": { - "smithy.api#documentation": "

\n A security control (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters) whose enablement status in a specified standard couldn't be updated.\n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#Boolean": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.securityhub#BooleanFilter": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

The value of the boolean.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Boolean filter for querying findings.

" - } - }, - "com.amazonaws.securityhub#BooleanFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#BooleanFilter" - } - }, - "com.amazonaws.securityhub#CategoryList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#NonEmptyString" - } - }, - "com.amazonaws.securityhub#Cell": { - "type": "structure", - "members": { - "Column": { - "target": "com.amazonaws.securityhub#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The column number of the column that contains the data. For a Microsoft Excel workbook, the column number corresponds to the alphabetical column identifiers. For example, a value of 1 for Column corresponds to the A column in the workbook.

" - } - }, - "Row": { - "target": "com.amazonaws.securityhub#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The row number of the row that contains the data.

" - } - }, - "ColumnName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the column that contains the data.

" - } - }, - "CellReference": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

For a Microsoft Excel workbook, provides the location of the cell, as an absolute cell reference, that contains the data. For example, Sheet2!C5 for cell C5 on Sheet2.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An occurrence of sensitive data detected in a Microsoft Excel workbook, comma-separated value (CSV) file, or tab-separated value (TSV) file.

" - } - }, - "com.amazonaws.securityhub#Cells": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#Cell" - } - }, - "com.amazonaws.securityhub#CidrBlockAssociation": { - "type": "structure", - "members": { - "AssociationId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The association ID for the IPv4 CIDR block.

" - } - }, - "CidrBlock": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The IPv4 CIDR block.

" - } - }, - "CidrBlockState": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Information about the state of the IPv4 CIDR block.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An IPv4 CIDR block association.

" - } - }, - "com.amazonaws.securityhub#CidrBlockAssociationList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#CidrBlockAssociation" - } - }, - "com.amazonaws.securityhub#City": { - "type": "structure", - "members": { - "CityName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the city.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a city.

" - } - }, - "com.amazonaws.securityhub#ClassificationResult": { - "type": "structure", - "members": { - "MimeType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of content that the finding applies to.

" - } - }, - "SizeClassified": { - "target": "com.amazonaws.securityhub#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The total size in bytes of the affected data.

" - } - }, - "AdditionalOccurrences": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether there are additional occurrences of sensitive data that are not included in the finding. This occurs when the number of occurrences exceeds the maximum that can be included.

" - } - }, - "Status": { - "target": "com.amazonaws.securityhub#ClassificationStatus", - "traits": { - "smithy.api#documentation": "

The current status of the sensitive data detection.

" - } - }, - "SensitiveData": { - "target": "com.amazonaws.securityhub#SensitiveDataResultList", - "traits": { - "smithy.api#documentation": "

Provides details about sensitive data that was identified based on built-in configuration.

" - } - }, - "CustomDataIdentifiers": { - "target": "com.amazonaws.securityhub#CustomDataIdentifiersResult", - "traits": { - "smithy.api#documentation": "

Provides details about sensitive data that was identified based on customer-defined configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about the sensitive data that was detected on the resource.

" - } - }, - "com.amazonaws.securityhub#ClassificationStatus": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The code that represents the status of the sensitive data detection.

" - } - }, - "Reason": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A longer description of the current status of the sensitive data detection.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides details about the current status of the sensitive data detection.

" - } - }, - "com.amazonaws.securityhub#Compliance": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.securityhub#ComplianceStatus", - "traits": { - "smithy.api#documentation": "

The result of a standards check.

\n

The valid values for Status are as follows.

\n " - } - }, - "RelatedRequirements": { - "target": "com.amazonaws.securityhub#RelatedRequirementsList", - "traits": { - "smithy.api#documentation": "

For a control, the industry or regulatory framework requirements that are related to the\n control. The check for that control is aligned with these requirements.

" - } - }, - "StatusReasons": { - "target": "com.amazonaws.securityhub#StatusReasonsList", - "traits": { - "smithy.api#documentation": "

For findings generated from controls, a list of reasons behind the value of\n Status. For the list of status reason codes and their meanings, see Standards-related information in the ASFF in the\n Security Hub User Guide.

" - } - }, - "SecurityControlId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The unique identifier of a control across standards. Values for this field typically consist of an \n Amazon Web Service and a number, such as APIGateway.5.\n

" - } - }, - "AssociatedStandards": { - "target": "com.amazonaws.securityhub#AssociatedStandardsList", - "traits": { - "smithy.api#documentation": "

The enabled security standards in which a security control is currently enabled.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains finding details that are specific to control-based findings. Only returned for\n findings generated from controls.

" - } - }, - "com.amazonaws.securityhub#ComplianceStatus": { - "type": "enum", - "members": { - "PASSED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PASSED" - } - }, - "WARNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WARNING" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "NOT_AVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_AVAILABLE" - } - } - } - }, - "com.amazonaws.securityhub#ContainerDetails": { - "type": "structure", - "members": { - "ContainerRuntime": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The runtime of the container.\n

" - } - }, - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the container related to a finding.

" - } - }, - "ImageId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the container image related to a finding.

" - } - }, - "ImageName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the container image related to a finding.

" - } - }, - "LaunchedAt": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the container started.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "VolumeMounts": { - "target": "com.amazonaws.securityhub#VolumeMountList", - "traits": { - "smithy.api#documentation": "

Provides information about the mounting of a volume in a container.\n

" - } - }, - "Privileged": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

When this parameter is true, the container is given elevated privileges on the host \ncontainer instance (similar to the root user). \n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Container details related to a finding.

" - } - }, - "com.amazonaws.securityhub#ControlFindingGenerator": { - "type": "enum", - "members": { - "STANDARD_CONTROL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STANDARD_CONTROL" - } - }, - "SECURITY_CONTROL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SECURITY_CONTROL" - } - } - } - }, - "com.amazonaws.securityhub#ControlStatus": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.securityhub#Country": { - "type": "structure", - "members": { - "CountryCode": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The 2-letter ISO 3166 country code for the country.

" - } - }, - "CountryName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the country.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a country.

" - } - }, - "com.amazonaws.securityhub#CreateActionTarget": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#CreateActionTargetRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#CreateActionTargetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - }, - { - "target": "com.amazonaws.securityhub#ResourceConflictException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a custom action target in Security Hub.

\n

You can use custom actions on findings and insights in Security Hub to trigger target actions\n in Amazon CloudWatch Events.

", - "smithy.api#http": { - "method": "POST", - "uri": "/actionTargets", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#CreateActionTargetRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the custom action target. Can contain up to 20 characters.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The description for the custom action target.

", - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID for the custom action target. Can contain up to 20 alphanumeric characters.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#CreateActionTargetResponse": { - "type": "structure", - "members": { - "ActionTargetArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the custom action target.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#CreateFindingAggregator": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#CreateFindingAggregatorRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#CreateFindingAggregatorResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#AccessDeniedException" - }, - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - } - ], - "traits": { - "smithy.api#documentation": "

Used to enable finding aggregation. Must be called from the aggregation Region.

\n

For more details about cross-Region replication, see Configuring finding aggregation in the Security Hub User Guide.\n

", - "smithy.api#http": { - "method": "POST", - "uri": "/findingAggregator/create", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#CreateFindingAggregatorRequest": { - "type": "structure", - "members": { - "RegionLinkingMode": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates whether to aggregate findings from all of the available Regions in the current partition. Also determines whether to automatically aggregate findings from new Regions as Security Hub supports them and you opt into them.

\n

The selected option also determines how to use the Regions provided in the Regions list.

\n

The options are as follows:

\n ", - "smithy.api#required": {} - } - }, - "Regions": { - "target": "com.amazonaws.securityhub#StringList", - "traits": { - "smithy.api#documentation": "

If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a space-separated list of Regions that do not aggregate findings to the aggregation Region.

\n

If RegionLinkingMode is SPECIFIED_REGIONS, then this is a space-separated list of Regions that do aggregate findings to the aggregation Region.\n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#CreateFindingAggregatorResponse": { - "type": "structure", - "members": { - "FindingAggregatorArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the finding aggregator. You use the finding aggregator ARN to retrieve details for, update, and stop finding aggregation.

" - } - }, - "FindingAggregationRegion": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The aggregation Region.

" - } - }, - "RegionLinkingMode": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.

" - } - }, - "Regions": { - "target": "com.amazonaws.securityhub#StringList", - "traits": { - "smithy.api#documentation": "

The list of excluded Regions or included Regions.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#CreateInsight": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#CreateInsightRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#CreateInsightResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - }, - { - "target": "com.amazonaws.securityhub#ResourceConflictException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a custom insight in Security Hub. An insight is a consolidation of findings that relate\n to a security issue that requires attention or remediation.

\n

To group the related findings in the insight, use the\n GroupByAttribute.

", - "smithy.api#http": { - "method": "POST", - "uri": "/insights", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#CreateInsightRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the custom insight to create.

", - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.securityhub#AwsSecurityFindingFilters", - "traits": { - "smithy.api#documentation": "

One or more attributes used to filter the findings included in the insight. The insight\n only includes findings that match the criteria defined in the filters.

", - "smithy.api#required": {} - } - }, - "GroupByAttribute": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The attribute used to group the findings for the insight. The grouping attribute\n identifies the type of item that the insight applies to. For example, if an insight is\n grouped by resource identifier, then the insight produces a list of resource\n identifiers.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#CreateInsightResponse": { - "type": "structure", - "members": { - "InsightArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the insight created.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#CreateMembers": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#CreateMembersRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#CreateMembersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - }, - { - "target": "com.amazonaws.securityhub#ResourceConflictException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a member association in Security Hub between the specified accounts and the account\n used to make the request, which is the administrator account. If you are integrated with\n Organizations, then the administrator account is designated by the organization management account.

\n

\n CreateMembers is always used to add accounts that are not organization\n members.

\n

For accounts that are managed using Organizations, CreateMembers is only used\n in the following cases:

\n \n

This action can only be used by an account that has Security Hub enabled. To enable Security Hub, you\n can use the EnableSecurityHub operation.

\n

For accounts that are not organization members, you create the account association and\n then send an invitation to the member account. To send the invitation, you use the\n InviteMembers operation. If the account owner accepts\n the invitation, the account becomes a member account in Security Hub.

\n

Accounts that are managed using Organizations do not receive an invitation. They\n automatically become a member account in Security Hub.

\n \n

A permissions policy is added that permits the administrator account to view the findings\n generated in the member account.

\n

To remove the association between the administrator and member accounts, use the DisassociateFromMasterAccount or DisassociateMembers operation.

", - "smithy.api#http": { - "method": "POST", - "uri": "/members", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#CreateMembersRequest": { - "type": "structure", - "members": { - "AccountDetails": { - "target": "com.amazonaws.securityhub#AccountDetailsList", - "traits": { - "smithy.api#documentation": "

The list of accounts to associate with the Security Hub administrator account. For each account, the\n list includes the account ID and optionally the email address.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#CreateMembersResponse": { - "type": "structure", - "members": { - "UnprocessedAccounts": { - "target": "com.amazonaws.securityhub#ResultList", - "traits": { - "smithy.api#documentation": "

The list of Amazon Web Services accounts that were not processed. For each account, the list includes\n the account ID and the email address.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#CrossAccountMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.securityhub#CustomDataIdentifiersDetections": { - "type": "structure", - "members": { - "Count": { - "target": "com.amazonaws.securityhub#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The total number of occurrences of sensitive data that were detected.

" - } - }, - "Arn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the custom identifier that was used to detect the sensitive data.

" - } - }, - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

he name of the custom identifier that detected the sensitive data.

" - } - }, - "Occurrences": { - "target": "com.amazonaws.securityhub#Occurrences", - "traits": { - "smithy.api#documentation": "

Details about the sensitive data that was detected.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The list of detected instances of sensitive data.

" - } - }, - "com.amazonaws.securityhub#CustomDataIdentifiersDetectionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#CustomDataIdentifiersDetections" - } - }, - "com.amazonaws.securityhub#CustomDataIdentifiersResult": { - "type": "structure", - "members": { - "Detections": { - "target": "com.amazonaws.securityhub#CustomDataIdentifiersDetectionsList", - "traits": { - "smithy.api#documentation": "

The list of detected instances of sensitive data.

" - } - }, - "TotalCount": { - "target": "com.amazonaws.securityhub#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The total number of occurrences of sensitive data.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains an instance of sensitive data that was detected by a customer-defined identifier.

" - } - }, - "com.amazonaws.securityhub#Cvss": { - "type": "structure", - "members": { - "Version": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The version of CVSS for the CVSS score.

" - } - }, - "BaseScore": { - "target": "com.amazonaws.securityhub#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The base CVSS score.

" - } - }, - "BaseVector": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The base scoring vector for the CVSS score.

" - } - }, - "Source": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The origin of the original CVSS score and vector.

" - } - }, - "Adjustments": { - "target": "com.amazonaws.securityhub#AdjustmentList", - "traits": { - "smithy.api#documentation": "

Adjustments to the CVSS metrics.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

CVSS scores from the advisory related to the vulnerability.

" - } - }, - "com.amazonaws.securityhub#CvssList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#Cvss" - } - }, - "com.amazonaws.securityhub#DataClassificationDetails": { - "type": "structure", - "members": { - "DetailedResultsLocation": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The path to the folder or file that contains the sensitive data.

" - } - }, - "Result": { - "target": "com.amazonaws.securityhub#ClassificationResult", - "traits": { - "smithy.api#documentation": "

The details about the sensitive data that was detected on the resource.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides details about sensitive data that was detected on a resource.

" - } - }, - "com.amazonaws.securityhub#DateFilter": { - "type": "structure", - "members": { - "Start": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A timestamp that provides the start date for the date filter.

\n

A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. \n For more information, see RFC 3339 section 5.6, Internet Date/Time Format.

" - } - }, - "End": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A timestamp that provides the end date for the date filter.

\n

A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. \n For more information, see RFC 3339 section 5.6, Internet Date/Time Format.

" - } - }, - "DateRange": { - "target": "com.amazonaws.securityhub#DateRange", - "traits": { - "smithy.api#documentation": "

A date range for the date filter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A date filter for querying findings.

" - } - }, - "com.amazonaws.securityhub#DateFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#DateFilter" - } - }, - "com.amazonaws.securityhub#DateRange": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

A date range value for the date filter.

" - } - }, - "Unit": { - "target": "com.amazonaws.securityhub#DateRangeUnit", - "traits": { - "smithy.api#documentation": "

A date range unit for the date filter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A date range for the date filter.

" - } - }, - "com.amazonaws.securityhub#DateRangeUnit": { - "type": "enum", - "members": { - "DAYS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DAYS" - } - } - } - }, - "com.amazonaws.securityhub#DeclineInvitations": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#DeclineInvitationsRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#DeclineInvitationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Declines invitations to become a member account.

\n

A prospective member account uses this operation to decline an invitation to become a member.

\n

This operation is only called by member accounts that aren't part of an organization.\n Organization accounts don't receive invitations.

", - "smithy.api#http": { - "method": "POST", - "uri": "/invitations/decline", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#DeclineInvitationsRequest": { - "type": "structure", - "members": { - "AccountIds": { - "target": "com.amazonaws.securityhub#AccountIdList", - "traits": { - "smithy.api#documentation": "

The list of prospective member account IDs for which to decline an invitation.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#DeclineInvitationsResponse": { - "type": "structure", - "members": { - "UnprocessedAccounts": { - "target": "com.amazonaws.securityhub#ResultList", - "traits": { - "smithy.api#documentation": "

The list of Amazon Web Services accounts that were not processed. For each account, the list includes\n the account ID and the email address.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#DeleteActionTarget": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#DeleteActionTargetRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#DeleteActionTargetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a custom action target from Security Hub.

\n

Deleting a custom action target does not affect any findings or insights that were\n already sent to Amazon CloudWatch Events using the custom action.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/actionTargets/{ActionTargetArn+}", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#DeleteActionTargetRequest": { - "type": "structure", - "members": { - "ActionTargetArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom action target to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#DeleteActionTargetResponse": { - "type": "structure", - "members": { - "ActionTargetArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the custom action target that was deleted.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#DeleteFindingAggregator": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#DeleteFindingAggregatorRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#DeleteFindingAggregatorResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#AccessDeniedException" - }, - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - }, - { - "target": "com.amazonaws.securityhub#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a finding aggregator. When you delete the finding aggregator, you stop finding aggregation.

\n

When you stop finding aggregation, findings that were already aggregated to the aggregation Region are still visible from the aggregation Region. New findings and finding updates are not aggregated.\n

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/findingAggregator/delete/{FindingAggregatorArn+}", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#DeleteFindingAggregatorRequest": { - "type": "structure", - "members": { - "FindingAggregatorArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the finding aggregator to delete. To obtain the ARN, use ListFindingAggregators.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#DeleteFindingAggregatorResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#DeleteInsight": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#DeleteInsightRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#DeleteInsightResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - }, - { - "target": "com.amazonaws.securityhub#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the insight specified by the InsightArn.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/insights/{InsightArn+}", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#DeleteInsightRequest": { - "type": "structure", - "members": { - "InsightArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the insight to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#DeleteInsightResponse": { - "type": "structure", - "members": { - "InsightArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the insight that was deleted.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#DeleteInvitations": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#DeleteInvitationsRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#DeleteInvitationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - }, - { - "target": "com.amazonaws.securityhub#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes invitations received by the Amazon Web Services account to become a member account.

\n

A Security Hub administrator account can use this operation to delete invitations sent to one or more member accounts.

\n

This operation is only used to delete invitations that are sent to member accounts that aren't part of an organization.\n Organization accounts don't receive invitations.

", - "smithy.api#http": { - "method": "POST", - "uri": "/invitations/delete", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#DeleteInvitationsRequest": { - "type": "structure", - "members": { - "AccountIds": { - "target": "com.amazonaws.securityhub#AccountIdList", - "traits": { - "smithy.api#documentation": "

The list of member account IDs that received the invitations you want to delete.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#DeleteInvitationsResponse": { - "type": "structure", - "members": { - "UnprocessedAccounts": { - "target": "com.amazonaws.securityhub#ResultList", - "traits": { - "smithy.api#documentation": "

The list of Amazon Web Services accounts for which the invitations were not deleted. For each account,\n the list includes the account ID and the email address.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#DeleteMembers": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#DeleteMembersRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#DeleteMembersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - }, - { - "target": "com.amazonaws.securityhub#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the specified member accounts from Security Hub.

\n

Can be used to delete member accounts that belong to an organization as well as member\n accounts that were invited manually.

", - "smithy.api#http": { - "method": "POST", - "uri": "/members/delete", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#DeleteMembersRequest": { - "type": "structure", - "members": { - "AccountIds": { - "target": "com.amazonaws.securityhub#AccountIdList", - "traits": { - "smithy.api#documentation": "

The list of account IDs for the member accounts to delete.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#DeleteMembersResponse": { - "type": "structure", - "members": { - "UnprocessedAccounts": { - "target": "com.amazonaws.securityhub#ResultList", - "traits": { - "smithy.api#documentation": "

The list of Amazon Web Services accounts that were not deleted. For each account, the list includes the\n account ID and the email address.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#DescribeActionTargets": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#DescribeActionTargetsRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#DescribeActionTargetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of the custom action targets in Security Hub in your account.

", - "smithy.api#http": { - "method": "POST", - "uri": "/actionTargets/get", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ActionTargets", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.securityhub#DescribeActionTargetsRequest": { - "type": "structure", - "members": { - "ActionTargetArns": { - "target": "com.amazonaws.securityhub#ArnList", - "traits": { - "smithy.api#documentation": "

A list of custom action target ARNs for the custom action targets to retrieve.

" - } - }, - "NextToken": { - "target": "com.amazonaws.securityhub#NextToken", - "traits": { - "smithy.api#documentation": "

The token that is required for pagination. On your first call to the\n DescribeActionTargets operation, set the value of this parameter to\n NULL.

\n

For subsequent calls to the operation, to continue listing data, set the value of this\n parameter to the value returned from the previous response.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.securityhub#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#DescribeActionTargetsResponse": { - "type": "structure", - "members": { - "ActionTargets": { - "target": "com.amazonaws.securityhub#ActionTargetList", - "traits": { - "smithy.api#documentation": "

A list of ActionTarget objects. Each object includes the ActionTargetArn,\n Description, and Name of a custom action target available in\n Security Hub.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.securityhub#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token to use to request the next page of results.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#DescribeHub": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#DescribeHubRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#DescribeHubResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - }, - { - "target": "com.amazonaws.securityhub#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns details about the Hub resource in your account, including the\n HubArn and the time when you enabled Security Hub.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#DescribeHubRequest": { - "type": "structure", - "members": { - "HubArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the Hub resource to retrieve.

", - "smithy.api#httpQuery": "HubArn" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#DescribeHubResponse": { - "type": "structure", - "members": { - "HubArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the Hub resource that was retrieved.

" - } - }, - "SubscribedAt": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The date and time when Security Hub was enabled in the account.

" - } - }, - "AutoEnableControls": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether to automatically enable new controls when they are added to standards that are\n enabled.

\n

If set to true, then new controls for enabled standards are enabled\n automatically. If set to false, then new controls are not enabled.

" - } - }, - "ControlFindingGenerator": { - "target": "com.amazonaws.securityhub#ControlFindingGenerator", - "traits": { - "smithy.api#documentation": "

Specifies whether the calling account has consolidated control findings turned on. If the value for this field is set to \n SECURITY_CONTROL, Security Hub generates a single finding for a control check even when the check \n applies to multiple enabled standards.

\n

If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings \n for a control check when the check applies to multiple enabled standards.

\n

The value for this field in a member account matches the value in the administrator\n account. For accounts that aren't part of an organization, the default value of this field\n is SECURITY_CONTROL if you enabled Security Hub on or after February 23,\n 2023.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#DescribeOrganizationConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#DescribeOrganizationConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#DescribeOrganizationConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about the Organizations configuration for Security Hub. Can only be\n called from a Security Hub administrator account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/organization/configuration", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#DescribeOrganizationConfigurationRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#DescribeOrganizationConfigurationResponse": { - "type": "structure", - "members": { - "AutoEnable": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether to automatically enable Security Hub for new accounts in the organization.

\n

If set to true, then Security Hub is enabled for new accounts. If set to false,\n then new accounts are not added automatically.

" - } - }, - "MemberAccountLimitReached": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the maximum number of allowed member accounts are already associated with the\n Security Hub administrator account.

" - } - }, - "AutoEnableStandards": { - "target": "com.amazonaws.securityhub#AutoEnableStandards", - "traits": { - "smithy.api#documentation": "

Whether to automatically enable Security Hub default standards \n for new member accounts in the organization.

\n

The default value of this parameter is equal to DEFAULT.

\n

If equal to DEFAULT, then Security Hub default standards are automatically enabled for new member \n accounts. If equal to NONE, then default standards are not automatically enabled for new member \n accounts.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#DescribeProducts": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#DescribeProductsRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#DescribeProductsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about product integrations in Security Hub.

\n

You can optionally provide an integration ARN. If you provide an integration ARN, then\n the results only include that integration.

\n

If you do not provide an integration ARN, then the results include all of the available\n product integrations.

", - "smithy.api#http": { - "method": "GET", - "uri": "/products", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Products", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.securityhub#DescribeProductsRequest": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.securityhub#NextToken", - "traits": { - "smithy.api#documentation": "

The token that is required for pagination. On your first call to the\n DescribeProducts operation, set the value of this parameter to\n NULL.

\n

For subsequent calls to the operation, to continue listing data, set the value of this\n parameter to the value returned from the previous response.

", - "smithy.api#httpQuery": "NextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.securityhub#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return.

", - "smithy.api#httpQuery": "MaxResults" - } - }, - "ProductArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the integration to return.

", - "smithy.api#httpQuery": "ProductArn" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#DescribeProductsResponse": { - "type": "structure", - "members": { - "Products": { - "target": "com.amazonaws.securityhub#ProductsList", - "traits": { - "smithy.api#documentation": "

A list of products, including details for each product.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.securityhub#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token to use to request the next page of results.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#DescribeStandards": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#DescribeStandardsRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#DescribeStandardsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of the available standards in Security Hub.

\n

For each standard, the results include the standard ARN, the name, and a description.

", - "smithy.api#http": { - "method": "GET", - "uri": "/standards", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Standards", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.securityhub#DescribeStandardsControls": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#DescribeStandardsControlsRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#DescribeStandardsControlsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of security standards controls.

\n

For each control, the results include information about whether it is currently enabled,\n the severity, and a link to remediation information.

", - "smithy.api#http": { - "method": "GET", - "uri": "/standards/controls/{StandardsSubscriptionArn+}", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Controls", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.securityhub#DescribeStandardsControlsRequest": { - "type": "structure", - "members": { - "StandardsSubscriptionArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of a resource that represents your subscription to a supported standard. To get\n the subscription ARNs of the standards you have enabled, use the GetEnabledStandards operation.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.securityhub#NextToken", - "traits": { - "smithy.api#documentation": "

The token that is required for pagination. On your first call to the\n DescribeStandardsControls operation, set the value of this parameter to\n NULL.

\n

For subsequent calls to the operation, to continue listing data, set the value of this\n parameter to the value returned from the previous response.

", - "smithy.api#httpQuery": "NextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.securityhub#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of security standard controls to return.

", - "smithy.api#httpQuery": "MaxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#DescribeStandardsControlsResponse": { - "type": "structure", - "members": { - "Controls": { - "target": "com.amazonaws.securityhub#StandardsControls", - "traits": { - "smithy.api#documentation": "

A list of security standards controls.

" - } - }, - "NextToken": { - "target": "com.amazonaws.securityhub#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token to use to request the next page of results.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#DescribeStandardsRequest": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.securityhub#NextToken", - "traits": { - "smithy.api#documentation": "

The token that is required for pagination. On your first call to the\n DescribeStandards operation, set the value of this parameter to\n NULL.

\n

For subsequent calls to the operation, to continue listing data, set the value of this\n parameter to the value returned from the previous response.

", - "smithy.api#httpQuery": "NextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.securityhub#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of standards to return.

", - "smithy.api#httpQuery": "MaxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#DescribeStandardsResponse": { - "type": "structure", - "members": { - "Standards": { - "target": "com.amazonaws.securityhub#Standards", - "traits": { - "smithy.api#documentation": "

A list of available standards.

" - } - }, - "NextToken": { - "target": "com.amazonaws.securityhub#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token to use to request the next page of results.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#DisableImportFindingsForProduct": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#DisableImportFindingsForProductRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#DisableImportFindingsForProductResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - }, - { - "target": "com.amazonaws.securityhub#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Disables the integration of the specified product with Security Hub. After the integration is\n disabled, findings from that product are no longer sent to Security Hub.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/productSubscriptions/{ProductSubscriptionArn+}", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#DisableImportFindingsForProductRequest": { - "type": "structure", - "members": { - "ProductSubscriptionArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the integrated product to disable the integration for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#DisableImportFindingsForProductResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#DisableOrganizationAdminAccount": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#DisableOrganizationAdminAccountRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#DisableOrganizationAdminAccountResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - } - ], - "traits": { - "smithy.api#documentation": "

Disables a Security Hub administrator account. Can only be called by the organization\n management account.

", - "smithy.api#http": { - "method": "POST", - "uri": "/organization/admin/disable", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#DisableOrganizationAdminAccountRequest": { - "type": "structure", - "members": { - "AdminAccountId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account identifier of the Security Hub administrator account.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#DisableOrganizationAdminAccountResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#DisableSecurityHub": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#DisableSecurityHubRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#DisableSecurityHubResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - }, - { - "target": "com.amazonaws.securityhub#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Disables Security Hub in your account only in the current Region. To disable Security Hub in all\n Regions, you must submit one request per Region where you have enabled Security Hub.

\n

When you disable Security Hub for an administrator account, it doesn't disable Security Hub for any associated\n member accounts.

\n

When you disable Security Hub, your existing findings and insights and any Security Hub configuration\n settings are deleted after 90 days and cannot be recovered. Any standards that were enabled\n are disabled, and your administrator and member account associations are removed.

\n

If you want to save your existing findings, you must export them before you disable\n Security Hub.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#DisableSecurityHubRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#DisableSecurityHubResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#DisassociateFromAdministratorAccount": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#DisassociateFromAdministratorAccountRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#DisassociateFromAdministratorAccountResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - }, - { - "target": "com.amazonaws.securityhub#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Disassociates the current Security Hub member account from the associated administrator\n account.

\n

This operation is only used by accounts that are not part of an organization. For\n organization accounts, only the administrator account can\n disassociate a member account.

", - "smithy.api#http": { - "method": "POST", - "uri": "/administrator/disassociate", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#DisassociateFromAdministratorAccountRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#DisassociateFromAdministratorAccountResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#DisassociateFromMasterAccount": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#DisassociateFromMasterAccountRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#DisassociateFromMasterAccountResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - }, - { - "target": "com.amazonaws.securityhub#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This API has been deprecated, use DisassociateFromAdministratorAccount API instead." - }, - "smithy.api#documentation": "

This method is deprecated. Instead, use DisassociateFromAdministratorAccount.

\n

The Security Hub console continues to use DisassociateFromMasterAccount. It will eventually change to use DisassociateFromAdministratorAccount. Any IAM policies that specifically control access to this function must continue to use DisassociateFromMasterAccount. You should also add DisassociateFromAdministratorAccount to your policies to ensure that the correct permissions are in place after the console begins to use DisassociateFromAdministratorAccount.

\n

Disassociates the current Security Hub member account from the associated administrator\n account.

\n

This operation is only used by accounts that are not part of an organization. For\n organization accounts, only the administrator account can\n disassociate a member account.

", - "smithy.api#http": { - "method": "POST", - "uri": "/master/disassociate", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#DisassociateFromMasterAccountRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#DisassociateFromMasterAccountResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#DisassociateMembers": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#DisassociateMembersRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#DisassociateMembersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - }, - { - "target": "com.amazonaws.securityhub#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Disassociates the specified member accounts from the associated administrator account.

\n

Can be used to disassociate both accounts that are managed using Organizations and accounts that\n were invited manually.

", - "smithy.api#http": { - "method": "POST", - "uri": "/members/disassociate", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#DisassociateMembersRequest": { - "type": "structure", - "members": { - "AccountIds": { - "target": "com.amazonaws.securityhub#AccountIdList", - "traits": { - "smithy.api#documentation": "

The account IDs of the member accounts to disassociate from the administrator account.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#DisassociateMembersResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#DnsRequestAction": { - "type": "structure", - "members": { - "Domain": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The DNS domain that is associated with the DNS request.

" - } - }, - "Protocol": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The protocol that was used for the DNS request.

" - } - }, - "Blocked": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the DNS request was blocked.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provided if ActionType is DNS_REQUEST. It provides details\n about the DNS request that was detected.

" - } - }, - "com.amazonaws.securityhub#Double": { - "type": "double", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.securityhub#EnableImportFindingsForProduct": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#EnableImportFindingsForProductRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#EnableImportFindingsForProductResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - }, - { - "target": "com.amazonaws.securityhub#ResourceConflictException" - } - ], - "traits": { - "smithy.api#documentation": "

Enables the integration of a partner product with Security Hub. Integrated products send\n findings to Security Hub.

\n

When you enable a product integration, a permissions policy that grants permission for\n the product to send findings to Security Hub is applied.

", - "smithy.api#http": { - "method": "POST", - "uri": "/productSubscriptions", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#EnableImportFindingsForProductRequest": { - "type": "structure", - "members": { - "ProductArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the product to enable the integration for.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#EnableImportFindingsForProductResponse": { - "type": "structure", - "members": { - "ProductSubscriptionArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of your subscription to the product to enable integrations for.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#EnableOrganizationAdminAccount": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#EnableOrganizationAdminAccountRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#EnableOrganizationAdminAccountResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - } - ], - "traits": { - "smithy.api#documentation": "

Designates the Security Hub administrator account for an organization. Can only be called by\n the organization management account.

", - "smithy.api#http": { - "method": "POST", - "uri": "/organization/admin/enable", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#EnableOrganizationAdminAccountRequest": { - "type": "structure", - "members": { - "AdminAccountId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account identifier of the account to designate as the Security Hub administrator\n account.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#EnableOrganizationAdminAccountResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#EnableSecurityHub": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#EnableSecurityHubRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#EnableSecurityHubResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#AccessDeniedException" - }, - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - }, - { - "target": "com.amazonaws.securityhub#ResourceConflictException" - } - ], - "traits": { - "smithy.api#documentation": "

Enables Security Hub for your account in the current Region or the Region you specify in the\n request.

\n

When you enable Security Hub, you grant to Security Hub the permissions necessary to gather findings\n from other services that are integrated with Security Hub.

\n

When you use the EnableSecurityHub operation to enable Security Hub, you also\n automatically enable the following standards:

\n \n

Other standards are not automatically enabled.

\n

To opt out of automatically enabled standards, set\n EnableDefaultStandards to false.

\n

After you enable Security Hub, to enable a standard, use the BatchEnableStandards operation. To disable a standard, use the\n BatchDisableStandards operation.

\n

To learn more, see the setup information in the Security Hub User Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#EnableSecurityHubRequest": { - "type": "structure", - "members": { - "Tags": { - "target": "com.amazonaws.securityhub#TagMap", - "traits": { - "smithy.api#documentation": "

The tags to add to the hub resource when you enable Security Hub.

" - } - }, - "EnableDefaultStandards": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether to enable the security standards that Security Hub has designated as automatically\n enabled. If you do not provide a value for EnableDefaultStandards, it is set\n to true. To not enable the automatically enabled standards, set\n EnableDefaultStandards to false.

" - } - }, - "ControlFindingGenerator": { - "target": "com.amazonaws.securityhub#ControlFindingGenerator", - "traits": { - "smithy.api#documentation": "

This field, used when enabling Security Hub, specifies whether the calling account has consolidated control findings turned on. \n If the value for this field is set to \n SECURITY_CONTROL, Security Hub generates a single finding for a control check even when the check \n applies to multiple enabled standards.

\n

If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings \n for a control check when the check applies to multiple enabled standards.

\n

The value for this field in a member account matches the value in the administrator\n account. For accounts that aren't part of an organization, the default value of this field\n is SECURITY_CONTROL if you enabled Security Hub on or after February 23,\n 2023.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#EnableSecurityHubResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#FieldMap": { - "type": "map", - "key": { - "target": "com.amazonaws.securityhub#NonEmptyString" - }, - "value": { - "target": "com.amazonaws.securityhub#NonEmptyString" - } - }, - "com.amazonaws.securityhub#FilePathList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#FilePaths" - } - }, - "com.amazonaws.securityhub#FilePaths": { - "type": "structure", - "members": { - "FilePath": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Path to the infected or suspicious file on the resource it was detected on.\n\t\t

" - } - }, - "FileName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the infected or suspicious file corresponding to the hash.\n\t\t

" - } - }, - "ResourceId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource on which the threat was detected.\n\t\t

" - } - }, - "Hash": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The hash value for the infected or suspicious file.\n\t\t

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about the file paths that were affected by the threat.\n\t\t

" - } - }, - "com.amazonaws.securityhub#FindingAggregator": { - "type": "structure", - "members": { - "FindingAggregatorArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the finding aggregator. You use the finding aggregator ARN to retrieve details for, update, and delete the finding aggregator.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A finding aggregator. A finding aggregator contains the configuration for finding aggregation.

" - } - }, - "com.amazonaws.securityhub#FindingAggregatorList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#FindingAggregator" - } - }, - "com.amazonaws.securityhub#FindingHistoryRecord": { - "type": "structure", - "members": { - "FindingIdentifier": { - "target": "com.amazonaws.securityhub#AwsSecurityFindingIdentifier" - }, - "UpdateTime": { - "target": "com.amazonaws.securityhub#Timestamp", - "traits": { - "smithy.api#documentation": "

An ISO 8601-formatted timestamp that indicates when Security Hub \n processed the updated finding record.

\n

A correctly formatted example is\n 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and\n time should be separated by T. For more information, see RFC 3339 section 5.6,\n Internet Date/Time Format.

" - } - }, - "FindingCreated": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

\n Identifies whether the event marks the creation of a new finding. A value of True means that the finding is \n newly created. A value of False means that the finding isn’t newly created.\n

" - } - }, - "UpdateSource": { - "target": "com.amazonaws.securityhub#FindingHistoryUpdateSource", - "traits": { - "smithy.api#documentation": "

Identifies the source of the event that changed the finding. For example, an integrated\n Amazon Web Service or third-party partner integration may call \n BatchImportFindings\n , or an Security Hub customer\n may call \n BatchUpdateFindings\n .

" - } - }, - "Updates": { - "target": "com.amazonaws.securityhub#FindingHistoryUpdatesList", - "traits": { - "smithy.api#documentation": "

\n An array of objects that provides details about the finding change event, including the Amazon Web Services Security \n Finding Format (ASFF) field that changed, the value of the field before the change, and the value of the field after \n the change.\n

" - } - }, - "NextToken": { - "target": "com.amazonaws.securityhub#NextToken", - "traits": { - "smithy.api#documentation": "

\n A token for pagination purposes. Provide this token in the subsequent request to \n GetFindingsHistory\n to get \n up to an additional 100 results of history for the same finding that you specified in your initial request.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n A list of events that changed the specified finding during the specified time period. Each record represents a single \n finding change event.\n

" - } - }, - "com.amazonaws.securityhub#FindingHistoryRecordList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#FindingHistoryRecord" - } - }, - "com.amazonaws.securityhub#FindingHistoryUpdate": { - "type": "structure", - "members": { - "UpdatedField": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The ASFF field that changed during the finding change event.\n

" - } - }, - "OldValue": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The value of the ASFF field before the finding change event.\n

" - } - }, - "NewValue": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The value of the ASFF field after the finding change event. To preserve storage and readability, Security Hub omits this value \n if \n FindingHistoryRecord\n exceeds database limits.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An array of objects that provides details about a change to a finding, including the\n Amazon Web Services Security Finding Format (ASFF) field that changed, the value of\n the field before the change, and the value of the field after the change.

" - } - }, - "com.amazonaws.securityhub#FindingHistoryUpdateSource": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.securityhub#FindingHistoryUpdateSourceType", - "traits": { - "smithy.api#documentation": "

\n Describes the type of finding change event, such as a call to \n BatchImportFindings\n (by an integrated Amazon Web Service or third party partner integration) or \n BatchUpdateFindings\n (by a Security Hub customer). \n

" - } - }, - "Identity": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The identity of the source that initiated the finding change event. For example, the Amazon Resource Name (ARN) of a partner that calls BatchImportFindings or of a customer that calls BatchUpdateFindings.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Identifies the source of the finding change event. \n

" - } - }, - "com.amazonaws.securityhub#FindingHistoryUpdateSourceType": { - "type": "enum", - "members": { - "BATCH_UPDATE_FINDINGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BATCH_UPDATE_FINDINGS" - } - }, - "BATCH_IMPORT_FINDINGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BATCH_IMPORT_FINDINGS" - } - } - } - }, - "com.amazonaws.securityhub#FindingHistoryUpdatesList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#FindingHistoryUpdate" - } - }, - "com.amazonaws.securityhub#FindingProviderFields": { - "type": "structure", - "members": { - "Confidence": { - "target": "com.amazonaws.securityhub#RatioScale", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

A finding's confidence. Confidence is defined as the likelihood that a finding\n accurately identifies the behavior or issue that it was intended to identify.

\n

Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent\n confidence and 100 means 100 percent confidence.

" - } - }, - "Criticality": { - "target": "com.amazonaws.securityhub#RatioScale", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The level of importance assigned to the resources associated with the finding.

\n

A score of 0 means that the underlying resources have no criticality, and a score of 100\n is reserved for the most critical resources.

" - } - }, - "RelatedFindings": { - "target": "com.amazonaws.securityhub#RelatedFindingList", - "traits": { - "smithy.api#documentation": "

A list of findings that are related to the current finding.

" - } - }, - "Severity": { - "target": "com.amazonaws.securityhub#FindingProviderSeverity", - "traits": { - "smithy.api#documentation": "

The severity of a finding.

" - } - }, - "Types": { - "target": "com.amazonaws.securityhub#TypeList", - "traits": { - "smithy.api#documentation": "

One or more finding types in the format of namespace/category/classifier\n that classify a finding.

\n

Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual\n Behaviors | Sensitive Data Identifications

" - } - } - }, - "traits": { - "smithy.api#documentation": "

In a BatchImportFindings request, finding providers use FindingProviderFields to provide and update values for confidence, criticality, related findings, severity, and types.

" - } - }, - "com.amazonaws.securityhub#FindingProviderSeverity": { - "type": "structure", - "members": { - "Label": { - "target": "com.amazonaws.securityhub#SeverityLabel", - "traits": { - "smithy.api#documentation": "

The severity label assigned to the finding by the finding provider.

" - } - }, - "Original": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The finding provider's original value for the severity.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The severity assigned to the finding by the finding provider.

" - } - }, - "com.amazonaws.securityhub#FirewallPolicyDetails": { - "type": "structure", - "members": { - "StatefulRuleGroupReferences": { - "target": "com.amazonaws.securityhub#FirewallPolicyStatefulRuleGroupReferencesList", - "traits": { - "smithy.api#documentation": "

The stateful rule groups that are used in the firewall policy.

" - } - }, - "StatelessCustomActions": { - "target": "com.amazonaws.securityhub#FirewallPolicyStatelessCustomActionsList", - "traits": { - "smithy.api#documentation": "

The custom action definitions that are available to use in the firewall policy's StatelessDefaultActions setting.

" - } - }, - "StatelessDefaultActions": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The actions to take on a packet if it doesn't match any of the stateless rules in the policy.

\n

You must specify a standard action (aws:pass, aws:drop, aws:forward_to_sfe), and can optionally include a custom action from StatelessCustomActions.\n

" - } - }, - "StatelessFragmentDefaultActions": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The actions to take on a fragmented UDP packet if it doesn't match any of the stateless rules in the policy.

\n

You must specify a standard action (aws:pass, aws:drop, aws:forward_to_sfe), and can optionally include a custom action from StatelessCustomActions.\n

" - } - }, - "StatelessRuleGroupReferences": { - "target": "com.amazonaws.securityhub#FirewallPolicyStatelessRuleGroupReferencesList", - "traits": { - "smithy.api#documentation": "

The stateless rule groups that are used in the firewall policy.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Defines the behavior of the firewall.

" - } - }, - "com.amazonaws.securityhub#FirewallPolicyStatefulRuleGroupReferencesDetails": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the stateful rule group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A stateful rule group that is used by the firewall policy.

" - } - }, - "com.amazonaws.securityhub#FirewallPolicyStatefulRuleGroupReferencesList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#FirewallPolicyStatefulRuleGroupReferencesDetails" - } - }, - "com.amazonaws.securityhub#FirewallPolicyStatelessCustomActionsDetails": { - "type": "structure", - "members": { - "ActionDefinition": { - "target": "com.amazonaws.securityhub#StatelessCustomActionDefinition", - "traits": { - "smithy.api#documentation": "

The definition of the custom action.

" - } - }, - "ActionName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the custom action.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A custom action that can be used for stateless packet handling.

" - } - }, - "com.amazonaws.securityhub#FirewallPolicyStatelessCustomActionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#FirewallPolicyStatelessCustomActionsDetails" - } - }, - "com.amazonaws.securityhub#FirewallPolicyStatelessRuleGroupReferencesDetails": { - "type": "structure", - "members": { - "Priority": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The order in which to run the stateless rule group.

" - } - }, - "ResourceArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the stateless rule group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A stateless rule group that is used by the firewall policy.

" - } - }, - "com.amazonaws.securityhub#FirewallPolicyStatelessRuleGroupReferencesList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#FirewallPolicyStatelessRuleGroupReferencesDetails" - } - }, - "com.amazonaws.securityhub#GeoLocation": { - "type": "structure", - "members": { - "Lon": { - "target": "com.amazonaws.securityhub#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The longitude of the location.

" - } - }, - "Lat": { - "target": "com.amazonaws.securityhub#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The latitude of the location.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides the latitude and longitude coordinates of a location.

" - } - }, - "com.amazonaws.securityhub#GetAdministratorAccount": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#GetAdministratorAccountRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#GetAdministratorAccountResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - }, - { - "target": "com.amazonaws.securityhub#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Provides the details for the Security Hub administrator account for the current member account.

\n

Can be used by both member accounts that are managed using Organizations and accounts that were\n invited manually.

", - "smithy.api#http": { - "method": "GET", - "uri": "/administrator", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#GetAdministratorAccountRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#GetAdministratorAccountResponse": { - "type": "structure", - "members": { - "Administrator": { - "target": "com.amazonaws.securityhub#Invitation" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#GetEnabledStandards": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#GetEnabledStandardsRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#GetEnabledStandardsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of the standards that are currently enabled.

", - "smithy.api#http": { - "method": "POST", - "uri": "/standards/get", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "StandardsSubscriptions", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.securityhub#GetEnabledStandardsRequest": { - "type": "structure", - "members": { - "StandardsSubscriptionArns": { - "target": "com.amazonaws.securityhub#StandardsSubscriptionArns", - "traits": { - "smithy.api#documentation": "

The list of the standards subscription ARNs for the standards to retrieve.

" - } - }, - "NextToken": { - "target": "com.amazonaws.securityhub#NextToken", - "traits": { - "smithy.api#documentation": "

The token that is required for pagination. On your first call to the\n GetEnabledStandards operation, set the value of this parameter to\n NULL.

\n

For subsequent calls to the operation, to continue listing data, set the value of this\n parameter to the value returned from the previous response.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.securityhub#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return in the response.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#GetEnabledStandardsResponse": { - "type": "structure", - "members": { - "StandardsSubscriptions": { - "target": "com.amazonaws.securityhub#StandardsSubscriptions", - "traits": { - "smithy.api#documentation": "

The list of StandardsSubscriptions objects that include information about\n the enabled standards.

" - } - }, - "NextToken": { - "target": "com.amazonaws.securityhub#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token to use to request the next page of results.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#GetFindingAggregator": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#GetFindingAggregatorRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#GetFindingAggregatorResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#AccessDeniedException" - }, - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - }, - { - "target": "com.amazonaws.securityhub#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the current finding aggregation configuration.

", - "smithy.api#http": { - "method": "GET", - "uri": "/findingAggregator/get/{FindingAggregatorArn+}", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#GetFindingAggregatorRequest": { - "type": "structure", - "members": { - "FindingAggregatorArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the finding aggregator to return details for. To obtain the ARN, use ListFindingAggregators.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#GetFindingAggregatorResponse": { - "type": "structure", - "members": { - "FindingAggregatorArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the finding aggregator.

" - } - }, - "FindingAggregationRegion": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The aggregation Region.

" - } - }, - "RegionLinkingMode": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.

" - } - }, - "Regions": { - "target": "com.amazonaws.securityhub#StringList", - "traits": { - "smithy.api#documentation": "

The list of excluded Regions or included Regions.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#GetFindingHistory": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#GetFindingHistoryRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#GetFindingHistoryResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Returns history for a Security Hub finding in the last 90 days. The history includes changes made to any fields in \n the Amazon Web Services Security Finding Format (ASFF).\n

", - "smithy.api#http": { - "method": "POST", - "uri": "/findingHistory/get", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Records", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.securityhub#GetFindingHistoryRequest": { - "type": "structure", - "members": { - "FindingIdentifier": { - "target": "com.amazonaws.securityhub#AwsSecurityFindingIdentifier", - "traits": { - "smithy.api#required": {} - } - }, - "StartTime": { - "target": "com.amazonaws.securityhub#Timestamp", - "traits": { - "smithy.api#documentation": "

\n An ISO 8601-formatted timestamp that indicates the start time of the requested finding history. A correctly formatted \n example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated \n by T. For more information, see RFC 3339 \n section 5.6, Internet Date/Time Format.

\n

If you provide values for both StartTime and EndTime,\n Security Hub returns finding history for the specified time period. If you\n provide a value for StartTime but not for EndTime, Security Hub returns finding history from the StartTime to the time at\n which the API is called. If you provide a value for EndTime but not for\n StartTime, Security Hub returns finding history from the CreatedAt timestamp of the finding to the EndTime. If you\n provide neither StartTime nor EndTime, Security Hub\n returns finding history from the CreatedAt timestamp of the finding to the time at which\n the API is called. In all of these scenarios, the response is limited to 100 results, and the maximum time period is \n limited to 90 days.

" - } - }, - "EndTime": { - "target": "com.amazonaws.securityhub#Timestamp", - "traits": { - "smithy.api#documentation": "

\n An ISO 8601-formatted timestamp that indicates the end time of the requested finding history. A correctly formatted \n example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated \n by T. For more information, see RFC 3339 \n section 5.6, Internet Date/Time Format.

\n

If you provide values for both StartTime and EndTime,\n Security Hub returns finding history for the specified time period. If you\n provide a value for StartTime but not for EndTime, Security Hub returns finding history from the StartTime to the time at\n which the API is called. If you provide a value for EndTime but not for\n StartTime, Security Hub returns finding history from the CreatedAt timestamp of the finding to the EndTime. If you\n provide neither StartTime nor EndTime, Security Hub\n returns finding history from the CreatedAt timestamp of the finding to the time at which\n the API is called. In all of these scenarios, the response is limited to 100 results, and the maximum time period is \n limited to 90 days.

" - } - }, - "NextToken": { - "target": "com.amazonaws.securityhub#NextToken", - "traits": { - "smithy.api#documentation": "

\n A token for pagination purposes. Provide NULL as the initial value. In subsequent requests, provide the \n token included in the response to get up to an additional 100 results of finding history. If you don’t provide \n NextToken, Security Hub returns up to 100 results of finding history for each request.\n

" - } - }, - "MaxResults": { - "target": "com.amazonaws.securityhub#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The maximum number of results to be returned. If you don’t provide it, Security Hub returns up to 100 results of finding history.\n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#GetFindingHistoryResponse": { - "type": "structure", - "members": { - "Records": { - "target": "com.amazonaws.securityhub#FindingHistoryRecordList", - "traits": { - "smithy.api#documentation": "

\n A list of events that altered the specified finding during the specified time period. \n

" - } - }, - "NextToken": { - "target": "com.amazonaws.securityhub#NextToken", - "traits": { - "smithy.api#documentation": "

\n A token for pagination purposes. Provide this token in the subsequent request to GetFindingsHistory to \n get up to an additional 100 results of history for the same finding that you specified in your initial request.\n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#GetFindings": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#GetFindingsRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#GetFindingsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of findings that match the specified criteria.

\n

If finding aggregation is enabled, then when you call GetFindings from the aggregation Region, the results include all of the matching findings from both the aggregation Region and the linked Regions.

", - "smithy.api#http": { - "method": "POST", - "uri": "/findings", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Findings", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.securityhub#GetFindingsRequest": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.securityhub#AwsSecurityFindingFilters", - "traits": { - "smithy.api#documentation": "

The finding attributes used to define a condition to filter the returned\n findings.

\n

You can filter by up to 10 finding attributes. For each attribute, you can provide up to\n 20 filter values.

\n

Note that in the available filter fields, WorkflowState is deprecated. To\n search for a finding based on its workflow status, use WorkflowStatus.

" - } - }, - "SortCriteria": { - "target": "com.amazonaws.securityhub#SortCriteria", - "traits": { - "smithy.api#documentation": "

The finding attributes used to sort the list of returned findings.

" - } - }, - "NextToken": { - "target": "com.amazonaws.securityhub#NextToken", - "traits": { - "smithy.api#documentation": "

The token that is required for pagination. On your first call to the\n GetFindings operation, set the value of this parameter to\n NULL.

\n

For subsequent calls to the operation, to continue listing data, set the value of this\n parameter to the value returned from the previous response.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.securityhub#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of findings to return.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#GetFindingsResponse": { - "type": "structure", - "members": { - "Findings": { - "target": "com.amazonaws.securityhub#AwsSecurityFindingList", - "traits": { - "smithy.api#documentation": "

The findings that matched the filters specified in the request.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.securityhub#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token to use to request the next page of results.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#GetInsightResults": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#GetInsightResultsRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#GetInsightResultsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - }, - { - "target": "com.amazonaws.securityhub#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the results of the Security Hub insight specified by the insight ARN.

", - "smithy.api#http": { - "method": "GET", - "uri": "/insights/results/{InsightArn+}", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#GetInsightResultsRequest": { - "type": "structure", - "members": { - "InsightArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the insight for which to return results.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#GetInsightResultsResponse": { - "type": "structure", - "members": { - "InsightResults": { - "target": "com.amazonaws.securityhub#InsightResults", - "traits": { - "smithy.api#documentation": "

The insight results returned by the operation.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#GetInsights": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#GetInsightsRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#GetInsightsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - }, - { - "target": "com.amazonaws.securityhub#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists and describes insights for the specified insight ARNs.

", - "smithy.api#http": { - "method": "POST", - "uri": "/insights/get", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Insights", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.securityhub#GetInsightsRequest": { - "type": "structure", - "members": { - "InsightArns": { - "target": "com.amazonaws.securityhub#ArnList", - "traits": { - "smithy.api#documentation": "

The ARNs of the insights to describe. If you do not provide any insight ARNs, then\n GetInsights returns all of your custom insights. It does not return any\n managed insights.

" - } - }, - "NextToken": { - "target": "com.amazonaws.securityhub#NextToken", - "traits": { - "smithy.api#documentation": "

The token that is required for pagination. On your first call to the\n GetInsights operation, set the value of this parameter to\n NULL.

\n

For subsequent calls to the operation, to continue listing data, set the value of this\n parameter to the value returned from the previous response.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.securityhub#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return in the response.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#GetInsightsResponse": { - "type": "structure", - "members": { - "Insights": { - "target": "com.amazonaws.securityhub#InsightList", - "traits": { - "smithy.api#documentation": "

The insights returned by the operation.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.securityhub#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token to use to request the next page of results.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#GetInvitationsCount": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#GetInvitationsCountRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#GetInvitationsCountResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the count of all Security Hub membership invitations that were sent to the\n current member account, not including the currently accepted invitation.

", - "smithy.api#http": { - "method": "GET", - "uri": "/invitations/count", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#GetInvitationsCountRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#GetInvitationsCountResponse": { - "type": "structure", - "members": { - "InvitationsCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of all membership invitations sent to this Security Hub member account, not\n including the currently accepted invitation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#GetMasterAccount": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#GetMasterAccountRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#GetMasterAccountResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - }, - { - "target": "com.amazonaws.securityhub#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This API has been deprecated, use GetAdministratorAccount API instead." - }, - "smithy.api#documentation": "

This method is deprecated. Instead, use GetAdministratorAccount.

\n

The Security Hub console continues to use GetMasterAccount. It will eventually change to use GetAdministratorAccount. Any IAM policies that specifically control access to this function must continue to use GetMasterAccount. You should also add GetAdministratorAccount to your policies to ensure that the correct permissions are in place after the console begins to use GetAdministratorAccount.

\n

Provides the details for the Security Hub administrator account for the current member account.

\n

Can be used by both member accounts that are managed using Organizations and accounts that were\n invited manually.

", - "smithy.api#http": { - "method": "GET", - "uri": "/master", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#GetMasterAccountRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#GetMasterAccountResponse": { - "type": "structure", - "members": { - "Master": { - "target": "com.amazonaws.securityhub#Invitation", - "traits": { - "smithy.api#documentation": "

A list of details about the Security Hub administrator account for the current member account.\n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#GetMembers": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#GetMembersRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#GetMembersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - }, - { - "target": "com.amazonaws.securityhub#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the details for the Security Hub member accounts for the specified account IDs.

\n

An administrator account can be either the delegated Security Hub administrator account for an\n organization or an administrator account that enabled Security Hub manually.

\n

The results include both member accounts that are managed using Organizations and accounts that\n were invited manually.

", - "smithy.api#http": { - "method": "POST", - "uri": "/members/get", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#GetMembersRequest": { - "type": "structure", - "members": { - "AccountIds": { - "target": "com.amazonaws.securityhub#AccountIdList", - "traits": { - "smithy.api#documentation": "

The list of account IDs for the Security Hub member accounts to return the details for.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#GetMembersResponse": { - "type": "structure", - "members": { - "Members": { - "target": "com.amazonaws.securityhub#MemberList", - "traits": { - "smithy.api#documentation": "

The list of details about the Security Hub member accounts.

" - } - }, - "UnprocessedAccounts": { - "target": "com.amazonaws.securityhub#ResultList", - "traits": { - "smithy.api#documentation": "

The list of Amazon Web Services accounts that could not be processed. For each account, the list\n includes the account ID and the email address.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#IcmpTypeCode": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The ICMP code for which to deny or allow access. To deny or allow all codes, use the\n value -1.

" - } - }, - "Type": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The ICMP type for which to deny or allow access. To deny or allow all types, use the\n value -1.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An Internet Control Message Protocol (ICMP) type and code.

" - } - }, - "com.amazonaws.securityhub#ImportFindingsError": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the finding that could not be updated.

", - "smithy.api#required": {} - } - }, - "ErrorCode": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The code of the error returned by the BatchImportFindings operation.

", - "smithy.api#required": {} - } - }, - "ErrorMessage": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The message of the error returned by the BatchImportFindings\n operation.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The list of the findings that cannot be imported. For each finding, the list provides\n the error.

" - } - }, - "com.amazonaws.securityhub#ImportFindingsErrorList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#ImportFindingsError" - } - }, - "com.amazonaws.securityhub#Insight": { - "type": "structure", - "members": { - "InsightArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of a Security Hub insight.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of a Security Hub insight.

", - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.securityhub#AwsSecurityFindingFilters", - "traits": { - "smithy.api#documentation": "

One or more attributes used to filter the findings included in the insight. The insight\n only includes findings that match the criteria defined in the filters.

", - "smithy.api#required": {} - } - }, - "GroupByAttribute": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The grouping attribute for the insight's findings. Indicates how to group the matching\n findings, and identifies the type of item that the insight applies to. For example, if an\n insight is grouped by resource identifier, then the insight produces a list of resource\n identifiers.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about a Security Hub insight.

" - } - }, - "com.amazonaws.securityhub#InsightList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#Insight" - } - }, - "com.amazonaws.securityhub#InsightResultValue": { - "type": "structure", - "members": { - "GroupByAttributeValue": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The value of the attribute that the findings are grouped by for the insight whose\n results are returned by the GetInsightResults operation.

", - "smithy.api#required": {} - } - }, - "Count": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of findings returned for each GroupByAttributeValue.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The insight result values returned by the GetInsightResults\n operation.

" - } - }, - "com.amazonaws.securityhub#InsightResultValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#InsightResultValue" - } - }, - "com.amazonaws.securityhub#InsightResults": { - "type": "structure", - "members": { - "InsightArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the insight whose results are returned by the GetInsightResults\n operation.

", - "smithy.api#required": {} - } - }, - "GroupByAttribute": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The attribute that the findings are grouped by for the insight whose results are\n returned by the GetInsightResults operation.

", - "smithy.api#required": {} - } - }, - "ResultValues": { - "target": "com.amazonaws.securityhub#InsightResultValueList", - "traits": { - "smithy.api#documentation": "

The list of insight result values returned by the GetInsightResults\n operation.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The insight results returned by the GetInsightResults operation.

" - } - }, - "com.amazonaws.securityhub#Integer": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.securityhub#IntegerList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#Integer" - } - }, - "com.amazonaws.securityhub#IntegrationType": { - "type": "enum", - "members": { - "SEND_FINDINGS_TO_SECURITY_HUB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SEND_FINDINGS_TO_SECURITY_HUB" - } - }, - "RECEIVE_FINDINGS_FROM_SECURITY_HUB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RECEIVE_FINDINGS_FROM_SECURITY_HUB" - } - }, - "UPDATE_FINDINGS_IN_SECURITY_HUB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_FINDINGS_IN_SECURITY_HUB" - } - } - } - }, - "com.amazonaws.securityhub#IntegrationTypeList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#IntegrationType" - } - }, - "com.amazonaws.securityhub#InternalException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.securityhub#NonEmptyString" - }, - "Code": { - "target": "com.amazonaws.securityhub#NonEmptyString" - } - }, - "traits": { - "smithy.api#documentation": "

Internal server error.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.securityhub#InvalidAccessException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.securityhub#NonEmptyString" - }, - "Code": { - "target": "com.amazonaws.securityhub#NonEmptyString" - } - }, - "traits": { - "smithy.api#documentation": "

The account doesn't have permission to perform this action.

", - "smithy.api#error": "client", - "smithy.api#httpError": 401 - } - }, - "com.amazonaws.securityhub#InvalidInputException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.securityhub#NonEmptyString" - }, - "Code": { - "target": "com.amazonaws.securityhub#NonEmptyString" - } - }, - "traits": { - "smithy.api#documentation": "

The request was rejected because you supplied an invalid or out-of-range value for an\n input parameter.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.securityhub#Invitation": { - "type": "structure", - "members": { - "AccountId": { - "target": "com.amazonaws.securityhub#AccountId", - "traits": { - "smithy.api#documentation": "

The account ID of the Security Hub administrator account that the invitation was sent from.

" - } - }, - "InvitationId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the invitation sent to the member account.

" - } - }, - "InvitedAt": { - "target": "com.amazonaws.securityhub#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp of when the invitation was sent.

" - } - }, - "MemberStatus": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The current status of the association between the member and administrator accounts.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about an invitation.

" - } - }, - "com.amazonaws.securityhub#InvitationList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#Invitation" - } - }, - "com.amazonaws.securityhub#InviteMembers": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#InviteMembersRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#InviteMembersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - }, - { - "target": "com.amazonaws.securityhub#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Invites other Amazon Web Services accounts to become member accounts for the Security Hub administrator account that\n the invitation is sent from.

\n

This operation is only used to invite accounts that do not belong to an organization.\n Organization accounts do not receive invitations.

\n

Before you can use this action to invite a member, you must first use the CreateMembers action to create the member account in Security Hub.

\n

When the account owner enables Security Hub and accepts the invitation to become a member\n account, the administrator account can view the findings generated from the member account.

", - "smithy.api#http": { - "method": "POST", - "uri": "/members/invite", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#InviteMembersRequest": { - "type": "structure", - "members": { - "AccountIds": { - "target": "com.amazonaws.securityhub#AccountIdList", - "traits": { - "smithy.api#documentation": "

The list of account IDs of the Amazon Web Services accounts to invite to Security Hub as members.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#InviteMembersResponse": { - "type": "structure", - "members": { - "UnprocessedAccounts": { - "target": "com.amazonaws.securityhub#ResultList", - "traits": { - "smithy.api#documentation": "

The list of Amazon Web Services accounts that could not be processed. For each account, the list\n includes the account ID and the email address.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#IpFilter": { - "type": "structure", - "members": { - "Cidr": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A finding's CIDR value.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The IP filter for querying findings.

" - } - }, - "com.amazonaws.securityhub#IpFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#IpFilter" - } - }, - "com.amazonaws.securityhub#IpOrganizationDetails": { - "type": "structure", - "members": { - "Asn": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The Autonomous System Number (ASN) of the internet provider

" - } - }, - "AsnOrg": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the organization that registered the ASN.

" - } - }, - "Isp": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ISP information for the internet provider.

" - } - }, - "Org": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the internet provider.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about an internet provider.

" - } - }, - "com.amazonaws.securityhub#Ipv6CidrBlockAssociation": { - "type": "structure", - "members": { - "AssociationId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The association ID for the IPv6 CIDR block.

" - } - }, - "Ipv6CidrBlock": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The IPv6 CIDR block.

" - } - }, - "CidrBlockState": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Information about the state of the CIDR block. Valid values are as follows:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

An IPV6 CIDR block association.

" - } - }, - "com.amazonaws.securityhub#Ipv6CidrBlockAssociationList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#Ipv6CidrBlockAssociation" - } - }, - "com.amazonaws.securityhub#KeywordFilter": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A value for the keyword.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A keyword filter for querying findings.

" - } - }, - "com.amazonaws.securityhub#KeywordFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#KeywordFilter" - } - }, - "com.amazonaws.securityhub#LimitExceededException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.securityhub#NonEmptyString" - }, - "Code": { - "target": "com.amazonaws.securityhub#NonEmptyString" - } - }, - "traits": { - "smithy.api#documentation": "

The request was rejected because it attempted to create resources beyond the current Amazon Web Services\n account or throttling limits. The error code describes the limit exceeded.

", - "smithy.api#error": "client", - "smithy.api#httpError": 429 - } - }, - "com.amazonaws.securityhub#ListEnabledProductsForImport": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#ListEnabledProductsForImportRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#ListEnabledProductsForImportResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all findings-generating solutions (products) that you are subscribed to receive\n findings from in Security Hub.

", - "smithy.api#http": { - "method": "GET", - "uri": "/productSubscriptions", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ProductSubscriptions", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.securityhub#ListEnabledProductsForImportRequest": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.securityhub#NextToken", - "traits": { - "smithy.api#documentation": "

The token that is required for pagination. On your first call to the\n ListEnabledProductsForImport operation, set the value of this parameter to\n NULL.

\n

For subsequent calls to the operation, to continue listing data, set the value of this\n parameter to the value returned from the previous response.

", - "smithy.api#httpQuery": "NextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.securityhub#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return in the response.

", - "smithy.api#httpQuery": "MaxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#ListEnabledProductsForImportResponse": { - "type": "structure", - "members": { - "ProductSubscriptions": { - "target": "com.amazonaws.securityhub#ProductSubscriptionArnList", - "traits": { - "smithy.api#documentation": "

The list of ARNs for the resources that represent your subscriptions to products.

" - } - }, - "NextToken": { - "target": "com.amazonaws.securityhub#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token to use to request the next page of results.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#ListFindingAggregators": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#ListFindingAggregatorsRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#ListFindingAggregatorsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#AccessDeniedException" - }, - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - } - ], - "traits": { - "smithy.api#documentation": "

If finding aggregation is enabled, then ListFindingAggregators returns the ARN of the finding aggregator. You can run this operation from any Region.

", - "smithy.api#http": { - "method": "GET", - "uri": "/findingAggregator/list", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "FindingAggregators", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.securityhub#ListFindingAggregatorsRequest": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.securityhub#NextToken", - "traits": { - "smithy.api#documentation": "

The token returned with the previous set of results. Identifies the next set of results to return.

", - "smithy.api#httpQuery": "NextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.securityhub#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return. This operation currently only returns a single result.

", - "smithy.api#httpQuery": "MaxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#ListFindingAggregatorsResponse": { - "type": "structure", - "members": { - "FindingAggregators": { - "target": "com.amazonaws.securityhub#FindingAggregatorList", - "traits": { - "smithy.api#documentation": "

The list of finding aggregators. This operation currently only returns a single result.

" - } - }, - "NextToken": { - "target": "com.amazonaws.securityhub#NextToken", - "traits": { - "smithy.api#documentation": "

If there are more results, this is the token to provide in the next call to ListFindingAggregators.

\n

This operation currently only returns a single result.\n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#ListInvitations": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#ListInvitationsRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#ListInvitationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all Security Hub membership invitations that were sent to the current Amazon Web Services account.

\n

This operation is only used by accounts that are managed by invitation.\n Accounts that are managed using the integration with Organizations do not receive invitations.

", - "smithy.api#http": { - "method": "GET", - "uri": "/invitations", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Invitations", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.securityhub#ListInvitationsRequest": { - "type": "structure", - "members": { - "MaxResults": { - "target": "com.amazonaws.securityhub#CrossAccountMaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return in the response.

", - "smithy.api#httpQuery": "MaxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.securityhub#NextToken", - "traits": { - "smithy.api#documentation": "

The token that is required for pagination. On your first call to the\n ListInvitations operation, set the value of this parameter to\n NULL.

\n

For subsequent calls to the operation, to continue listing data, set the value of this\n parameter to the value returned from the previous response.

", - "smithy.api#httpQuery": "NextToken" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#ListInvitationsResponse": { - "type": "structure", - "members": { - "Invitations": { - "target": "com.amazonaws.securityhub#InvitationList", - "traits": { - "smithy.api#documentation": "

The details of the invitations returned by the operation.

" - } - }, - "NextToken": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The pagination token to use to request the next page of results.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#ListMembers": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#ListMembersRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#ListMembersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists details about all member accounts for the current Security Hub administrator\n account.

\n

The results include both member accounts that belong to an organization and member\n accounts that were invited manually.

", - "smithy.api#http": { - "method": "GET", - "uri": "/members", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Members", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.securityhub#ListMembersRequest": { - "type": "structure", - "members": { - "OnlyAssociated": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies which member accounts to include in the response based on their relationship\n status with the administrator account. The default value is TRUE.

\n

If OnlyAssociated is set to TRUE, the response includes member\n accounts whose relationship status with the administrator account is set to ENABLED.

\n

If OnlyAssociated is set to FALSE, the response includes all\n existing member accounts.

", - "smithy.api#httpQuery": "OnlyAssociated" - } - }, - "MaxResults": { - "target": "com.amazonaws.securityhub#CrossAccountMaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return in the response.

", - "smithy.api#httpQuery": "MaxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.securityhub#NextToken", - "traits": { - "smithy.api#documentation": "

The token that is required for pagination. On your first call to the\n ListMembers operation, set the value of this parameter to\n NULL.

\n

For subsequent calls to the operation, to continue listing data, set the value of this\n parameter to the value returned from the previous response.

", - "smithy.api#httpQuery": "NextToken" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#ListMembersResponse": { - "type": "structure", - "members": { - "Members": { - "target": "com.amazonaws.securityhub#MemberList", - "traits": { - "smithy.api#documentation": "

Member details returned by the operation.

" - } - }, - "NextToken": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The pagination token to use to request the next page of results.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#ListOrganizationAdminAccounts": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#ListOrganizationAdminAccountsRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#ListOrganizationAdminAccountsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the Security Hub administrator accounts. Can only be called by the organization\n management account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/organization/admin", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "AdminAccounts", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.securityhub#ListOrganizationAdminAccountsRequest": { - "type": "structure", - "members": { - "MaxResults": { - "target": "com.amazonaws.securityhub#AdminsMaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return in the response.

", - "smithy.api#httpQuery": "MaxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.securityhub#NextToken", - "traits": { - "smithy.api#documentation": "

The token that is required for pagination. On your first call to the\n ListOrganizationAdminAccounts operation, set the value of this parameter to\n NULL. For subsequent calls to the operation, to continue listing data, set\n the value of this parameter to the value returned from the previous response.

", - "smithy.api#httpQuery": "NextToken" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#ListOrganizationAdminAccountsResponse": { - "type": "structure", - "members": { - "AdminAccounts": { - "target": "com.amazonaws.securityhub#AdminAccounts", - "traits": { - "smithy.api#documentation": "

The list of Security Hub administrator accounts.

" - } - }, - "NextToken": { - "target": "com.amazonaws.securityhub#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token to use to request the next page of results.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#ListSecurityControlDefinitions": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#ListSecurityControlDefinitionsRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#ListSecurityControlDefinitionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Lists all of the security controls that apply to a specified standard. \n

", - "smithy.api#http": { - "method": "GET", - "uri": "/securityControls/definitions", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "SecurityControlDefinitions", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.securityhub#ListSecurityControlDefinitionsRequest": { - "type": "structure", - "members": { - "StandardsArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the standard that you want to view controls for.\n

", - "smithy.api#httpQuery": "StandardsArn" - } - }, - "NextToken": { - "target": "com.amazonaws.securityhub#NextToken", - "traits": { - "smithy.api#documentation": "

\n Optional pagination parameter.\n

", - "smithy.api#httpQuery": "NextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.securityhub#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

An optional parameter that limits the total results of the API response to the\n specified number. If this parameter isn't provided in the request, the results include the\n first 25 security controls that apply to the specified standard. The results also include a\n NextToken parameter that you can use in a subsequent API call to get the\n next 25 controls. This repeats until all controls for the standard are returned.

", - "smithy.api#httpQuery": "MaxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#ListSecurityControlDefinitionsResponse": { - "type": "structure", - "members": { - "SecurityControlDefinitions": { - "target": "com.amazonaws.securityhub#SecurityControlDefinitions", - "traits": { - "smithy.api#documentation": "

\n An array of controls that apply to the specified standard.\n

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.securityhub#NextToken", - "traits": { - "smithy.api#documentation": "

A pagination parameter that's included in the response only if it was included in the\n request.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#ListStandardsControlAssociations": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#ListStandardsControlAssociationsRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#ListStandardsControlAssociationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Specifies whether a control is currently enabled or disabled in each enabled standard in the calling account.\n

", - "smithy.api#http": { - "method": "GET", - "uri": "/associations", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "StandardsControlAssociationSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.securityhub#ListStandardsControlAssociationsRequest": { - "type": "structure", - "members": { - "SecurityControlId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The identifier of the control (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters) that you \n want to determine the enablement status of in each enabled standard. \n

", - "smithy.api#httpQuery": "SecurityControlId", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.securityhub#NextToken", - "traits": { - "smithy.api#documentation": "

\n Optional pagination parameter.\n

", - "smithy.api#httpQuery": "NextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.securityhub#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

An optional parameter that limits the total results of the API response to the\n specified number. If this parameter isn't provided in the request, the results include the\n first 25 standard and control associations. The results also include a\n NextToken parameter that you can use in a subsequent API call to get the\n next 25 associations. This repeats until all associations for the specified control are\n returned. The number of results is limited by the number of supported Security Hub\n standards that you've enabled in the calling account.

", - "smithy.api#httpQuery": "MaxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#ListStandardsControlAssociationsResponse": { - "type": "structure", - "members": { - "StandardsControlAssociationSummaries": { - "target": "com.amazonaws.securityhub#StandardsControlAssociationSummaries", - "traits": { - "smithy.api#documentation": "

An array that provides the enablement status and other details for each security\n control that applies to each enabled standard.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.securityhub#NextToken", - "traits": { - "smithy.api#documentation": "

A pagination parameter that's included in the response only if it was included in the\n request.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#ListTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of tags associated with a resource.

", - "smithy.api#http": { - "method": "GET", - "uri": "/tags/{ResourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.securityhub#ResourceArn", - "traits": { - "smithy.api#documentation": "

The ARN of the resource to retrieve tags for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "Tags": { - "target": "com.amazonaws.securityhub#TagMap", - "traits": { - "smithy.api#documentation": "

The tags associated with a resource.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#LoadBalancerState": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The state code. The initial state of the load balancer is provisioning.

\n

After the load balancer is fully set up and ready to route traffic, its state is\n active.

\n

If the load balancer could not be set up, its state is failed.

" - } - }, - "Reason": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A description of the state.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the state of the load balancer.

" - } - }, - "com.amazonaws.securityhub#Long": { - "type": "long", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.securityhub#Malware": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the malware that was observed.

", - "smithy.api#required": {} - } - }, - "Type": { - "target": "com.amazonaws.securityhub#MalwareType", - "traits": { - "smithy.api#documentation": "

The type of the malware that was observed.

" - } - }, - "Path": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The file system path of the malware that was observed.

" - } - }, - "State": { - "target": "com.amazonaws.securityhub#MalwareState", - "traits": { - "smithy.api#documentation": "

The state of the malware that was observed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A list of malware related to a finding.

" - } - }, - "com.amazonaws.securityhub#MalwareList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#Malware" - } - }, - "com.amazonaws.securityhub#MalwareState": { - "type": "enum", - "members": { - "OBSERVED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OBSERVED" - } - }, - "REMOVAL_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REMOVAL_FAILED" - } - }, - "REMOVED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REMOVED" - } - } - } - }, - "com.amazonaws.securityhub#MalwareType": { - "type": "enum", - "members": { - "ADWARE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ADWARE" - } - }, - "BLENDED_THREAT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BLENDED_THREAT" - } - }, - "BOTNET_AGENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BOTNET_AGENT" - } - }, - "COIN_MINER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COIN_MINER" - } - }, - "EXPLOIT_KIT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXPLOIT_KIT" - } - }, - "KEYLOGGER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KEYLOGGER" - } - }, - "MACRO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MACRO" - } - }, - "POTENTIALLY_UNWANTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "POTENTIALLY_UNWANTED" - } - }, - "SPYWARE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SPYWARE" - } - }, - "RANSOMWARE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RANSOMWARE" - } - }, - "REMOTE_ACCESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REMOTE_ACCESS" - } - }, - "ROOTKIT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ROOTKIT" - } - }, - "TROJAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TROJAN" - } - }, - "VIRUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VIRUS" - } - }, - "WORM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WORM" - } - } - } - }, - "com.amazonaws.securityhub#MapFilter": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The key of the map filter. For example, for ResourceTags, Key\n identifies the name of the tag. For UserDefinedFields, Key is the\n name of the field.

" - } - }, - "Value": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The value for the key in the map filter. Filter values are case sensitive. For example,\n one of the values for a tag called Department might be Security.\n If you provide security as the filter value, then there is no match.

" - } - }, - "Comparison": { - "target": "com.amazonaws.securityhub#MapFilterComparison", - "traits": { - "smithy.api#documentation": "

The condition to apply to the key value when querying for findings with a map\n filter.

\n

To search for values that exactly match the filter value, use EQUALS. For\n example, for the ResourceTags field, the filter Department EQUALS\n Security matches findings that have the value Security for the tag\n Department.

\n

To search for values other than the filter value, use NOT_EQUALS. For\n example, for the ResourceTags field, the filter Department NOT_EQUALS\n Finance matches findings that do not have the value Finance for the\n tag Department.

\n

\n EQUALS filters on the same field are joined by OR. A finding\n matches if it matches any one of those filters.

\n

\n NOT_EQUALS filters on the same field are joined by AND. A\n finding matches only if it matches all of those filters.

\n

You cannot have both an EQUALS filter and a NOT_EQUALS filter\n on the same field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A map filter for querying findings. Each map filter provides the field to check, the\n value to look for, and the comparison operator.

" - } - }, - "com.amazonaws.securityhub#MapFilterComparison": { - "type": "enum", - "members": { - "EQUALS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EQUALS" - } - }, - "NOT_EQUALS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_EQUALS" - } - } - } - }, - "com.amazonaws.securityhub#MapFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#MapFilter" - } - }, - "com.amazonaws.securityhub#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.securityhub#Member": { - "type": "structure", - "members": { - "AccountId": { - "target": "com.amazonaws.securityhub#AccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the member account.

" - } - }, - "Email": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The email address of the member account.

" - } - }, - "MasterId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#deprecated": { - "message": "This field is deprecated, use AdministratorId instead." - }, - "smithy.api#documentation": "

This is replaced by AdministratorID.

\n

The Amazon Web Services account ID of the Security Hub administrator account associated with this member account.

" - } - }, - "AdministratorId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the Security Hub administrator account associated with this member account.

" - } - }, - "MemberStatus": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The status of the relationship between the member account and its administrator account.\n

\n

The status can have one of the following values:

\n " - } - }, - "InvitedAt": { - "target": "com.amazonaws.securityhub#Timestamp", - "traits": { - "smithy.api#documentation": "

A timestamp for the date and time when the invitation was sent to the member\n account.

" - } - }, - "UpdatedAt": { - "target": "com.amazonaws.securityhub#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp for the date and time when the member account was updated.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The details about a member account.

" - } - }, - "com.amazonaws.securityhub#MemberList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#Member" - } - }, - "com.amazonaws.securityhub#Network": { - "type": "structure", - "members": { - "Direction": { - "target": "com.amazonaws.securityhub#NetworkDirection", - "traits": { - "smithy.api#documentation": "

The direction of network traffic associated with a finding.

" - } - }, - "Protocol": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The protocol of network-related information about a finding.

" - } - }, - "OpenPortRange": { - "target": "com.amazonaws.securityhub#PortRange", - "traits": { - "smithy.api#documentation": "

The range of open ports that is present on the network.

" - } - }, - "SourceIpV4": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The source IPv4 address of network-related information about a finding.

" - } - }, - "SourceIpV6": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The source IPv6 address of network-related information about a finding.

" - } - }, - "SourcePort": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The source port of network-related information about a finding.

" - } - }, - "SourceDomain": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The source domain of network-related information about a finding.

" - } - }, - "SourceMac": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The source media access control (MAC) address of network-related information about a\n finding.

" - } - }, - "DestinationIpV4": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The destination IPv4 address of network-related information about a finding.

" - } - }, - "DestinationIpV6": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The destination IPv6 address of network-related information about a finding.

" - } - }, - "DestinationPort": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The destination port of network-related information about a finding.

" - } - }, - "DestinationDomain": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The destination domain of network-related information about a finding.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The details of network-related information about a finding.

" - } - }, - "com.amazonaws.securityhub#NetworkConnectionAction": { - "type": "structure", - "members": { - "ConnectionDirection": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The direction of the network connection request (IN or\n OUT).

" - } - }, - "RemoteIpDetails": { - "target": "com.amazonaws.securityhub#ActionRemoteIpDetails", - "traits": { - "smithy.api#documentation": "

Information about the remote IP address that issued the network connection\n request.

" - } - }, - "RemotePortDetails": { - "target": "com.amazonaws.securityhub#ActionRemotePortDetails", - "traits": { - "smithy.api#documentation": "

Information about the port on the remote IP address.

" - } - }, - "LocalPortDetails": { - "target": "com.amazonaws.securityhub#ActionLocalPortDetails", - "traits": { - "smithy.api#documentation": "

Information about the port on the EC2 instance.

" - } - }, - "Protocol": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The protocol used to make the network connection request.

" - } - }, - "Blocked": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the network connection attempt was blocked.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provided if ActionType is NETWORK_CONNECTION. It provides\n details about the attempted network connection that was detected.

" - } - }, - "com.amazonaws.securityhub#NetworkDirection": { - "type": "enum", - "members": { - "IN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN" - } - }, - "OUT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OUT" - } - } - } - }, - "com.amazonaws.securityhub#NetworkHeader": { - "type": "structure", - "members": { - "Protocol": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The protocol used for the component.

" - } - }, - "Destination": { - "target": "com.amazonaws.securityhub#NetworkPathComponentDetails", - "traits": { - "smithy.api#documentation": "

Information about the destination of the component.

" - } - }, - "Source": { - "target": "com.amazonaws.securityhub#NetworkPathComponentDetails", - "traits": { - "smithy.api#documentation": "

Information about the origin of the component.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about a network path component that occurs before or after the current\n component.

" - } - }, - "com.amazonaws.securityhub#NetworkPathComponent": { - "type": "structure", - "members": { - "ComponentId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of a component in the network path.

" - } - }, - "ComponentType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of component.

" - } - }, - "Egress": { - "target": "com.amazonaws.securityhub#NetworkHeader", - "traits": { - "smithy.api#documentation": "

Information about the component that comes after the current component in the network\n path.

" - } - }, - "Ingress": { - "target": "com.amazonaws.securityhub#NetworkHeader", - "traits": { - "smithy.api#documentation": "

Information about the component that comes before the current node in the network\n path.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a network path component.

" - } - }, - "com.amazonaws.securityhub#NetworkPathComponentDetails": { - "type": "structure", - "members": { - "Address": { - "target": "com.amazonaws.securityhub#StringList", - "traits": { - "smithy.api#documentation": "

The IP addresses of the destination.

" - } - }, - "PortRanges": { - "target": "com.amazonaws.securityhub#PortRangeList", - "traits": { - "smithy.api#documentation": "

A list of port ranges for the destination.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the destination of the next component in the network path.

" - } - }, - "com.amazonaws.securityhub#NetworkPathList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#NetworkPathComponent" - } - }, - "com.amazonaws.securityhub#NextToken": { - "type": "string" - }, - "com.amazonaws.securityhub#NonEmptyString": { - "type": "string", - "traits": { - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.securityhub#NonEmptyStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#NonEmptyString" - } - }, - "com.amazonaws.securityhub#Note": { - "type": "structure", - "members": { - "Text": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The text of a note.

", - "smithy.api#required": {} - } - }, - "UpdatedBy": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The principal that created a note.

", - "smithy.api#required": {} - } - }, - "UpdatedAt": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The timestamp of when the note was updated.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A user-defined note added to a finding.

" - } - }, - "com.amazonaws.securityhub#NoteUpdate": { - "type": "structure", - "members": { - "Text": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The updated note text.

", - "smithy.api#required": {} - } - }, - "UpdatedBy": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The principal that updated the note.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The updated note.

" - } - }, - "com.amazonaws.securityhub#NumberFilter": { - "type": "structure", - "members": { - "Gte": { - "target": "com.amazonaws.securityhub#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The greater-than-equal condition to be applied to a single field when querying for\n findings.

" - } - }, - "Lte": { - "target": "com.amazonaws.securityhub#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The less-than-equal condition to be applied to a single field when querying for\n findings.

" - } - }, - "Eq": { - "target": "com.amazonaws.securityhub#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The equal-to condition to be applied to a single field when querying for\n findings.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A number filter for querying findings.

" - } - }, - "com.amazonaws.securityhub#NumberFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#NumberFilter" - } - }, - "com.amazonaws.securityhub#Occurrences": { - "type": "structure", - "members": { - "LineRanges": { - "target": "com.amazonaws.securityhub#Ranges", - "traits": { - "smithy.api#documentation": "

Occurrences of sensitive data detected in a non-binary text file or a Microsoft Word file. Non-binary text files include files such as HTML, XML, JSON, and TXT files.

" - } - }, - "OffsetRanges": { - "target": "com.amazonaws.securityhub#Ranges", - "traits": { - "smithy.api#documentation": "

Occurrences of sensitive data detected in a binary text file.

" - } - }, - "Pages": { - "target": "com.amazonaws.securityhub#Pages", - "traits": { - "smithy.api#documentation": "

Occurrences of sensitive data in an Adobe Portable Document Format (PDF) file.

" - } - }, - "Records": { - "target": "com.amazonaws.securityhub#Records", - "traits": { - "smithy.api#documentation": "

Occurrences of sensitive data in an Apache Avro object container or an Apache Parquet file.

" - } - }, - "Cells": { - "target": "com.amazonaws.securityhub#Cells", - "traits": { - "smithy.api#documentation": "

Occurrences of sensitive data detected in Microsoft Excel workbooks, comma-separated value (CSV) files, or tab-separated value (TSV) files.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The detected occurrences of sensitive data.

" - } - }, - "com.amazonaws.securityhub#Page": { - "type": "structure", - "members": { - "PageNumber": { - "target": "com.amazonaws.securityhub#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The page number of the page that contains the sensitive data.

" - } - }, - "LineRange": { - "target": "com.amazonaws.securityhub#Range", - "traits": { - "smithy.api#documentation": "

An occurrence of sensitive data detected in a non-binary text file or a Microsoft Word file. Non-binary text files include files such as HTML, XML, JSON, and TXT files.

" - } - }, - "OffsetRange": { - "target": "com.amazonaws.securityhub#Range", - "traits": { - "smithy.api#documentation": "

An occurrence of sensitive data detected in a binary text file.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An occurrence of sensitive data in an Adobe Portable Document Format (PDF) file.

" - } - }, - "com.amazonaws.securityhub#Pages": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#Page" - } - }, - "com.amazonaws.securityhub#Partition": { - "type": "enum", - "members": { - "AWS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "aws" - } - }, - "AWS_CN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "aws-cn" - } - }, - "AWS_US_GOV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "aws-us-gov" - } - } - } - }, - "com.amazonaws.securityhub#PatchSummary": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the compliance standard that was used to determine the patch\n compliance status.

", - "smithy.api#required": {} - } - }, - "InstalledCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of patches from the compliance standard that were installed\n successfully.

" - } - }, - "MissingCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of patches that are part of the compliance standard but are not installed.\n The count includes patches that failed to install.

" - } - }, - "FailedCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of patches from the compliance standard that failed to install.

" - } - }, - "InstalledOtherCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of installed patches that are not part of the compliance standard.

" - } - }, - "InstalledRejectedCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of patches that are installed but are also on a list of patches that the\n customer rejected.

" - } - }, - "InstalledPendingReboot": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of patches that were applied, but that require the instance to be rebooted in\n order to be marked as installed.

" - } - }, - "OperationStartTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the operation started.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "OperationEndTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the operation completed.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "RebootOption": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The reboot option specified for the instance.

" - } - }, - "Operation": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of patch operation performed. For Patch Manager, the values are\n SCAN and INSTALL.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides an overview of the patch compliance status for an instance against a selected\n compliance standard.

" - } - }, - "com.amazonaws.securityhub#PortProbeAction": { - "type": "structure", - "members": { - "PortProbeDetails": { - "target": "com.amazonaws.securityhub#PortProbeDetailList", - "traits": { - "smithy.api#documentation": "

Information about the ports affected by the port probe.

" - } - }, - "Blocked": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the port probe was blocked.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provided if ActionType is PORT_PROBE. It provides details\n about the attempted port probe that was detected.

" - } - }, - "com.amazonaws.securityhub#PortProbeDetail": { - "type": "structure", - "members": { - "LocalPortDetails": { - "target": "com.amazonaws.securityhub#ActionLocalPortDetails", - "traits": { - "smithy.api#documentation": "

Provides information about the port that was scanned.

" - } - }, - "LocalIpDetails": { - "target": "com.amazonaws.securityhub#ActionLocalIpDetails", - "traits": { - "smithy.api#documentation": "

Provides information about the IP address where the scanned port is located.

" - } - }, - "RemoteIpDetails": { - "target": "com.amazonaws.securityhub#ActionRemoteIpDetails", - "traits": { - "smithy.api#documentation": "

Provides information about the remote IP address that performed the scan.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A port scan that was part of the port probe. For each scan, PortProbeDetails provides\n information about the local IP address and port that were scanned, and the remote IP\n address that the scan originated from.

" - } - }, - "com.amazonaws.securityhub#PortProbeDetailList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#PortProbeDetail" - } - }, - "com.amazonaws.securityhub#PortRange": { - "type": "structure", - "members": { - "Begin": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The first port in the port range.

" - } - }, - "End": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The last port in the port range.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A range of ports.

" - } - }, - "com.amazonaws.securityhub#PortRangeFromTo": { - "type": "structure", - "members": { - "From": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The first port in the port range.

" - } - }, - "To": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The last port in the port range.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A range of ports.

" - } - }, - "com.amazonaws.securityhub#PortRangeList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#PortRange" - } - }, - "com.amazonaws.securityhub#ProcessDetails": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the process.

" - } - }, - "Path": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The path to the process executable.

" - } - }, - "Pid": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The process ID.

" - } - }, - "ParentPid": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The parent process ID. This field accepts positive integers between O and 2147483647.

" - } - }, - "LaunchedAt": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the process was launched.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "TerminatedAt": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the process was terminated.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The details of process-related information about a finding.

" - } - }, - "com.amazonaws.securityhub#Product": { - "type": "structure", - "members": { - "ProductArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN assigned to the product.

", - "smithy.api#required": {} - } - }, - "ProductName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the product.

" - } - }, - "CompanyName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the company that provides the product.

" - } - }, - "Description": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A description of the product.

" - } - }, - "Categories": { - "target": "com.amazonaws.securityhub#CategoryList", - "traits": { - "smithy.api#documentation": "

The categories assigned to the product.

" - } - }, - "IntegrationTypes": { - "target": "com.amazonaws.securityhub#IntegrationTypeList", - "traits": { - "smithy.api#documentation": "

The types of integration that the product supports. Available values are the\n following.

\n " - } - }, - "MarketplaceUrl": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

For integrations with Amazon Web Services services, the Amazon Web Services Console URL from which to activate the service.

\n

For integrations with third-party products, the Amazon Web Services Marketplace URL from which to subscribe to or purchase the product.

" - } - }, - "ActivationUrl": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The URL to the service or product documentation about the integration with Security Hub, including how to activate the integration.

" - } - }, - "ProductSubscriptionResourcePolicy": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The resource policy associated with the product.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains details about a product.

" - } - }, - "com.amazonaws.securityhub#ProductSubscriptionArnList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#NonEmptyString" - } - }, - "com.amazonaws.securityhub#ProductsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#Product" - } - }, - "com.amazonaws.securityhub#PropagatingVgwSetDetails": { - "type": "structure", - "members": { - "GatewayId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The ID of the virtual private gateway.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Describes a virtual private gateway propagating route.\n

" - } - }, - "com.amazonaws.securityhub#PropagatingVgwSetList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#PropagatingVgwSetDetails" - } - }, - "com.amazonaws.securityhub#Range": { - "type": "structure", - "members": { - "Start": { - "target": "com.amazonaws.securityhub#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.

" - } - }, - "End": { - "target": "com.amazonaws.securityhub#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.

" - } - }, - "StartColumn": { - "target": "com.amazonaws.securityhub#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

In the line where the sensitive data starts, the column within the line where the sensitive data starts.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Identifies where the sensitive data begins and ends.

" - } - }, - "com.amazonaws.securityhub#Ranges": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#Range" - } - }, - "com.amazonaws.securityhub#RatioScale": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.securityhub#Recommendation": { - "type": "structure", - "members": { - "Text": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Describes the recommended steps to take to remediate an issue identified in a finding.

" - } - }, - "Url": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A URL to a page or site that contains information about how to remediate a finding.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A recommendation on how to remediate the issue identified in a finding.

" - } - }, - "com.amazonaws.securityhub#Record": { - "type": "structure", - "members": { - "JsonPath": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The path, as a JSONPath expression, to the field in the record that contains the data. If the field name is longer than 20 characters, it is truncated. If the path is longer than 250 characters, it is truncated.

" - } - }, - "RecordIndex": { - "target": "com.amazonaws.securityhub#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The record index, starting from 0, for the record that contains the data.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An occurrence of sensitive data in an Apache Avro object container or an Apache Parquet file.

" - } - }, - "com.amazonaws.securityhub#RecordState": { - "type": "enum", - "members": { - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "ARCHIVED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ARCHIVED" - } - } - } - }, - "com.amazonaws.securityhub#Records": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#Record" - } - }, - "com.amazonaws.securityhub#RegionAvailabilityStatus": { - "type": "enum", - "members": { - "AVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AVAILABLE" - } - }, - "UNAVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNAVAILABLE" - } - } - } - }, - "com.amazonaws.securityhub#RelatedFinding": { - "type": "structure", - "members": { - "ProductArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the product that generated a related finding.

", - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The product-generated identifier for a related finding.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about a related finding.

" - } - }, - "com.amazonaws.securityhub#RelatedFindingList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#RelatedFinding" - } - }, - "com.amazonaws.securityhub#RelatedRequirementsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#NonEmptyString" - } - }, - "com.amazonaws.securityhub#Remediation": { - "type": "structure", - "members": { - "Recommendation": { - "target": "com.amazonaws.securityhub#Recommendation", - "traits": { - "smithy.api#documentation": "

A recommendation on the steps to take to remediate the issue identified by a finding.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about the remediation steps for a finding.

" - } - }, - "com.amazonaws.securityhub#Resource": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of the resource that details are provided for. If possible, set\n Type to one of the supported resource types. For example, if the resource\n is an EC2 instance, then set Type to AwsEc2Instance.

\n

If the resource does not match any of the provided types, then set Type to\n Other.

", - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The canonical identifier for the given resource type.

", - "smithy.api#required": {} - } - }, - "Partition": { - "target": "com.amazonaws.securityhub#Partition", - "traits": { - "smithy.api#documentation": "

The canonical Amazon Web Services partition name that the Region is assigned to.

" - } - }, - "Region": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The canonical Amazon Web Services external Region name where this resource is located.

" - } - }, - "ResourceRole": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Identifies the role of the resource in the finding. A resource is either the actor or target of the finding activity,

" - } - }, - "Tags": { - "target": "com.amazonaws.securityhub#FieldMap", - "traits": { - "smithy.api#documentation": "

A list of Amazon Web Services tags associated with a resource at the time the finding was\n processed.

" - } - }, - "DataClassification": { - "target": "com.amazonaws.securityhub#DataClassificationDetails", - "traits": { - "smithy.api#documentation": "

Contains information about sensitive data that was detected on the resource.

" - } - }, - "Details": { - "target": "com.amazonaws.securityhub#ResourceDetails", - "traits": { - "smithy.api#documentation": "

Additional details about the resource related to a finding.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A resource related to a finding.

" - } - }, - "com.amazonaws.securityhub#ResourceArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws:securityhub:" - } - }, - "com.amazonaws.securityhub#ResourceConflictException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.securityhub#NonEmptyString" - }, - "Code": { - "target": "com.amazonaws.securityhub#NonEmptyString" - } - }, - "traits": { - "smithy.api#documentation": "

The resource specified in the request conflicts with an existing resource.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.securityhub#ResourceDetails": { - "type": "structure", - "members": { - "AwsAutoScalingAutoScalingGroup": { - "target": "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupDetails", - "traits": { - "smithy.api#documentation": "

Details for an autoscaling group.

" - } - }, - "AwsCodeBuildProject": { - "target": "com.amazonaws.securityhub#AwsCodeBuildProjectDetails", - "traits": { - "smithy.api#documentation": "

Details for an CodeBuild project.

" - } - }, - "AwsCloudFrontDistribution": { - "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionDetails", - "traits": { - "smithy.api#documentation": "

Details about a CloudFront distribution.

" - } - }, - "AwsEc2Instance": { - "target": "com.amazonaws.securityhub#AwsEc2InstanceDetails", - "traits": { - "smithy.api#documentation": "

Details about an EC2 instance related to a finding.

" - } - }, - "AwsEc2NetworkInterface": { - "target": "com.amazonaws.securityhub#AwsEc2NetworkInterfaceDetails", - "traits": { - "smithy.api#documentation": "

Details for an EC2 network interface.

" - } - }, - "AwsEc2SecurityGroup": { - "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupDetails", - "traits": { - "smithy.api#documentation": "

Details for an EC2 security group.

" - } - }, - "AwsEc2Volume": { - "target": "com.amazonaws.securityhub#AwsEc2VolumeDetails", - "traits": { - "smithy.api#documentation": "

Details for an Amazon EC2 volume.

" - } - }, - "AwsEc2Vpc": { - "target": "com.amazonaws.securityhub#AwsEc2VpcDetails", - "traits": { - "smithy.api#documentation": "

Details for an Amazon EC2 VPC.

" - } - }, - "AwsEc2Eip": { - "target": "com.amazonaws.securityhub#AwsEc2EipDetails", - "traits": { - "smithy.api#documentation": "

Details about an Elastic IP address.

" - } - }, - "AwsEc2Subnet": { - "target": "com.amazonaws.securityhub#AwsEc2SubnetDetails", - "traits": { - "smithy.api#documentation": "

Details about a subnet in Amazon EC2.

" - } - }, - "AwsEc2NetworkAcl": { - "target": "com.amazonaws.securityhub#AwsEc2NetworkAclDetails", - "traits": { - "smithy.api#documentation": "

Details about an EC2 network access control list (ACL).

" - } - }, - "AwsElbv2LoadBalancer": { - "target": "com.amazonaws.securityhub#AwsElbv2LoadBalancerDetails", - "traits": { - "smithy.api#documentation": "

Details about a load balancer.

" - } - }, - "AwsElasticBeanstalkEnvironment": { - "target": "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentDetails", - "traits": { - "smithy.api#documentation": "

Details about an Elastic Beanstalk environment.

" - } - }, - "AwsElasticsearchDomain": { - "target": "com.amazonaws.securityhub#AwsElasticsearchDomainDetails", - "traits": { - "smithy.api#documentation": "

Details for an Elasticsearch domain.

" - } - }, - "AwsS3Bucket": { - "target": "com.amazonaws.securityhub#AwsS3BucketDetails", - "traits": { - "smithy.api#documentation": "

Details about an S3 bucket related to a finding.

" - } - }, - "AwsS3AccountPublicAccessBlock": { - "target": "com.amazonaws.securityhub#AwsS3AccountPublicAccessBlockDetails", - "traits": { - "smithy.api#documentation": "

Details about the Amazon S3 Public Access Block configuration for an account.

" - } - }, - "AwsS3Object": { - "target": "com.amazonaws.securityhub#AwsS3ObjectDetails", - "traits": { - "smithy.api#documentation": "

Details about an S3 object related to a finding.

" - } - }, - "AwsSecretsManagerSecret": { - "target": "com.amazonaws.securityhub#AwsSecretsManagerSecretDetails", - "traits": { - "smithy.api#documentation": "

Details about a Secrets Manager secret.

" - } - }, - "AwsIamAccessKey": { - "target": "com.amazonaws.securityhub#AwsIamAccessKeyDetails", - "traits": { - "smithy.api#documentation": "

Details about an IAM access key related to a finding.

" - } - }, - "AwsIamUser": { - "target": "com.amazonaws.securityhub#AwsIamUserDetails", - "traits": { - "smithy.api#documentation": "

Details about an IAM user.

" - } - }, - "AwsIamPolicy": { - "target": "com.amazonaws.securityhub#AwsIamPolicyDetails", - "traits": { - "smithy.api#documentation": "

Details about an IAM permissions policy.

" - } - }, - "AwsApiGatewayV2Stage": { - "target": "com.amazonaws.securityhub#AwsApiGatewayV2StageDetails", - "traits": { - "smithy.api#documentation": "

Provides information about a version 2 stage for Amazon API Gateway.

" - } - }, - "AwsApiGatewayV2Api": { - "target": "com.amazonaws.securityhub#AwsApiGatewayV2ApiDetails", - "traits": { - "smithy.api#documentation": "

Provides information about a version 2 API in Amazon API Gateway.

" - } - }, - "AwsDynamoDbTable": { - "target": "com.amazonaws.securityhub#AwsDynamoDbTableDetails", - "traits": { - "smithy.api#documentation": "

Details about a DynamoDB table.

" - } - }, - "AwsApiGatewayStage": { - "target": "com.amazonaws.securityhub#AwsApiGatewayStageDetails", - "traits": { - "smithy.api#documentation": "

Provides information about a version 1 Amazon API Gateway stage.

" - } - }, - "AwsApiGatewayRestApi": { - "target": "com.amazonaws.securityhub#AwsApiGatewayRestApiDetails", - "traits": { - "smithy.api#documentation": "

Provides information about a REST API in version 1 of Amazon API Gateway.

" - } - }, - "AwsCloudTrailTrail": { - "target": "com.amazonaws.securityhub#AwsCloudTrailTrailDetails", - "traits": { - "smithy.api#documentation": "

Provides details about a CloudTrail trail.

" - } - }, - "AwsSsmPatchCompliance": { - "target": "com.amazonaws.securityhub#AwsSsmPatchComplianceDetails", - "traits": { - "smithy.api#documentation": "

Provides information about the state of a patch on an instance based on the patch baseline that was used to patch the instance.

" - } - }, - "AwsCertificateManagerCertificate": { - "target": "com.amazonaws.securityhub#AwsCertificateManagerCertificateDetails", - "traits": { - "smithy.api#documentation": "

Provides details about an Certificate Manager certificate.

" - } - }, - "AwsRedshiftCluster": { - "target": "com.amazonaws.securityhub#AwsRedshiftClusterDetails", - "traits": { - "smithy.api#documentation": "

Contains details about an Amazon Redshift cluster.

" - } - }, - "AwsElbLoadBalancer": { - "target": "com.amazonaws.securityhub#AwsElbLoadBalancerDetails", - "traits": { - "smithy.api#documentation": "

Contains details about a Classic Load Balancer.

" - } - }, - "AwsIamGroup": { - "target": "com.amazonaws.securityhub#AwsIamGroupDetails", - "traits": { - "smithy.api#documentation": "

Contains details about an IAM group.

" - } - }, - "AwsIamRole": { - "target": "com.amazonaws.securityhub#AwsIamRoleDetails", - "traits": { - "smithy.api#documentation": "

Details about an IAM role.

" - } - }, - "AwsKmsKey": { - "target": "com.amazonaws.securityhub#AwsKmsKeyDetails", - "traits": { - "smithy.api#documentation": "

Details about an KMS key.

" - } - }, - "AwsLambdaFunction": { - "target": "com.amazonaws.securityhub#AwsLambdaFunctionDetails", - "traits": { - "smithy.api#documentation": "

Details about a Lambda function.

" - } - }, - "AwsLambdaLayerVersion": { - "target": "com.amazonaws.securityhub#AwsLambdaLayerVersionDetails", - "traits": { - "smithy.api#documentation": "

Details for a Lambda layer version.

" - } - }, - "AwsRdsDbInstance": { - "target": "com.amazonaws.securityhub#AwsRdsDbInstanceDetails", - "traits": { - "smithy.api#documentation": "

Details about an Amazon RDS database instance.

" - } - }, - "AwsSnsTopic": { - "target": "com.amazonaws.securityhub#AwsSnsTopicDetails", - "traits": { - "smithy.api#documentation": "

Details about an SNS topic.

" - } - }, - "AwsSqsQueue": { - "target": "com.amazonaws.securityhub#AwsSqsQueueDetails", - "traits": { - "smithy.api#documentation": "

Details about an SQS queue.

" - } - }, - "AwsWafWebAcl": { - "target": "com.amazonaws.securityhub#AwsWafWebAclDetails", - "traits": { - "smithy.api#documentation": "

Details for an WAF web ACL.

" - } - }, - "AwsRdsDbSnapshot": { - "target": "com.amazonaws.securityhub#AwsRdsDbSnapshotDetails", - "traits": { - "smithy.api#documentation": "

Details about an Amazon RDS database snapshot.

" - } - }, - "AwsRdsDbClusterSnapshot": { - "target": "com.amazonaws.securityhub#AwsRdsDbClusterSnapshotDetails", - "traits": { - "smithy.api#documentation": "

Details about an Amazon RDS database cluster snapshot.

" - } - }, - "AwsRdsDbCluster": { - "target": "com.amazonaws.securityhub#AwsRdsDbClusterDetails", - "traits": { - "smithy.api#documentation": "

Details about an Amazon RDS database cluster.

" - } - }, - "AwsEcsCluster": { - "target": "com.amazonaws.securityhub#AwsEcsClusterDetails", - "traits": { - "smithy.api#documentation": "

Details about an Amazon ECS cluster.

" - } - }, - "AwsEcsContainer": { - "target": "com.amazonaws.securityhub#AwsEcsContainerDetails", - "traits": { - "smithy.api#documentation": "

Provides information about a Docker container that's part of a task.\n

" - } - }, - "AwsEcsTaskDefinition": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionDetails", - "traits": { - "smithy.api#documentation": "

Details about a task definition. A task definition describes the container and volume definitions of an Amazon Elastic Container Service task.

" - } - }, - "Container": { - "target": "com.amazonaws.securityhub#ContainerDetails", - "traits": { - "smithy.api#documentation": "

Details about a container resource related to a finding.

" - } - }, - "Other": { - "target": "com.amazonaws.securityhub#FieldMap", - "traits": { - "smithy.api#documentation": "

Details about a resource that are not available in a type-specific details object. Use\n the Other object in the following cases.

\n " - } - }, - "AwsRdsEventSubscription": { - "target": "com.amazonaws.securityhub#AwsRdsEventSubscriptionDetails", - "traits": { - "smithy.api#documentation": "

Details about an RDS event notification subscription.

" - } - }, - "AwsEcsService": { - "target": "com.amazonaws.securityhub#AwsEcsServiceDetails", - "traits": { - "smithy.api#documentation": "

Details about a service within an ECS cluster.

" - } - }, - "AwsAutoScalingLaunchConfiguration": { - "target": "com.amazonaws.securityhub#AwsAutoScalingLaunchConfigurationDetails", - "traits": { - "smithy.api#documentation": "

Provides details about a launch configuration.

" - } - }, - "AwsEc2VpnConnection": { - "target": "com.amazonaws.securityhub#AwsEc2VpnConnectionDetails", - "traits": { - "smithy.api#documentation": "

Details about an Amazon EC2 VPN connection.

" - } - }, - "AwsEcrContainerImage": { - "target": "com.amazonaws.securityhub#AwsEcrContainerImageDetails", - "traits": { - "smithy.api#documentation": "

Information about an Amazon ECR image.

" - } - }, - "AwsOpenSearchServiceDomain": { - "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainDetails", - "traits": { - "smithy.api#documentation": "

Details about an Amazon OpenSearch Service domain.

" - } - }, - "AwsEc2VpcEndpointService": { - "target": "com.amazonaws.securityhub#AwsEc2VpcEndpointServiceDetails", - "traits": { - "smithy.api#documentation": "

Details about the service configuration for a VPC endpoint service.

" - } - }, - "AwsXrayEncryptionConfig": { - "target": "com.amazonaws.securityhub#AwsXrayEncryptionConfigDetails", - "traits": { - "smithy.api#documentation": "

Information about the encryption configuration for X-Ray.

" - } - }, - "AwsWafRateBasedRule": { - "target": "com.amazonaws.securityhub#AwsWafRateBasedRuleDetails", - "traits": { - "smithy.api#documentation": "

Details about a rate-based rule for global resources.

" - } - }, - "AwsWafRegionalRateBasedRule": { - "target": "com.amazonaws.securityhub#AwsWafRegionalRateBasedRuleDetails", - "traits": { - "smithy.api#documentation": "

Details about a rate-based rule for Regional resources.

" - } - }, - "AwsEcrRepository": { - "target": "com.amazonaws.securityhub#AwsEcrRepositoryDetails", - "traits": { - "smithy.api#documentation": "

Information about an Amazon Elastic Container Registry repository.

" - } - }, - "AwsEksCluster": { - "target": "com.amazonaws.securityhub#AwsEksClusterDetails", - "traits": { - "smithy.api#documentation": "

Details about an Amazon EKS cluster.

" - } - }, - "AwsNetworkFirewallFirewallPolicy": { - "target": "com.amazonaws.securityhub#AwsNetworkFirewallFirewallPolicyDetails", - "traits": { - "smithy.api#documentation": "

Details about an Network Firewall firewall policy.

" - } - }, - "AwsNetworkFirewallFirewall": { - "target": "com.amazonaws.securityhub#AwsNetworkFirewallFirewallDetails", - "traits": { - "smithy.api#documentation": "

Details about an Network Firewall firewall.

" - } - }, - "AwsNetworkFirewallRuleGroup": { - "target": "com.amazonaws.securityhub#AwsNetworkFirewallRuleGroupDetails", - "traits": { - "smithy.api#documentation": "

Details about an Network Firewall rule group.

" - } - }, - "AwsRdsDbSecurityGroup": { - "target": "com.amazonaws.securityhub#AwsRdsDbSecurityGroupDetails", - "traits": { - "smithy.api#documentation": "

Details about an Amazon RDS DB security group.

" - } - }, - "AwsKinesisStream": { - "target": "com.amazonaws.securityhub#AwsKinesisStreamDetails", - "traits": { - "smithy.api#documentation": "

Details about an Amazon Kinesis data stream.

" - } - }, - "AwsEc2TransitGateway": { - "target": "com.amazonaws.securityhub#AwsEc2TransitGatewayDetails", - "traits": { - "smithy.api#documentation": "

Details about an Amazon EC2 transit gateway that interconnects your virtual private clouds (VPC) and on-premises networks.

" - } - }, - "AwsEfsAccessPoint": { - "target": "com.amazonaws.securityhub#AwsEfsAccessPointDetails", - "traits": { - "smithy.api#documentation": "

Details about an Amazon EFS access point. An access point is an application-specific view into an EFS file system that \napplies an operating system user and group, and a file system path, to any file system request made through the access point. \n

" - } - }, - "AwsCloudFormationStack": { - "target": "com.amazonaws.securityhub#AwsCloudFormationStackDetails", - "traits": { - "smithy.api#documentation": "

Details about an CloudFormation stack. A stack is a collection of Amazon Web Services resources that you can manage as a single unit.

" - } - }, - "AwsCloudWatchAlarm": { - "target": "com.amazonaws.securityhub#AwsCloudWatchAlarmDetails", - "traits": { - "smithy.api#documentation": "

Details about an Amazon CloudWatch alarm. An alarm allows you to monitor and receive alerts about your Amazon Web Services resources and applications across multiple Regions.

" - } - }, - "AwsEc2VpcPeeringConnection": { - "target": "com.amazonaws.securityhub#AwsEc2VpcPeeringConnectionDetails", - "traits": { - "smithy.api#documentation": "

Details about an Amazon EC2 VPC peering connection. A VPC peering connection is\n a networking connection between two VPCs that enables you to route traffic between them\n privately.\n

" - } - }, - "AwsWafRegionalRuleGroup": { - "target": "com.amazonaws.securityhub#AwsWafRegionalRuleGroupDetails", - "traits": { - "smithy.api#documentation": "

Details about an WAF rule group for Regional resources.\n

" - } - }, - "AwsWafRegionalRule": { - "target": "com.amazonaws.securityhub#AwsWafRegionalRuleDetails", - "traits": { - "smithy.api#documentation": "

Details about an WAF rule for Regional resources.\n

" - } - }, - "AwsWafRegionalWebAcl": { - "target": "com.amazonaws.securityhub#AwsWafRegionalWebAclDetails", - "traits": { - "smithy.api#documentation": "

Details about an WAF web access control list (web ACL) for Regional resources.

" - } - }, - "AwsWafRule": { - "target": "com.amazonaws.securityhub#AwsWafRuleDetails", - "traits": { - "smithy.api#documentation": "

Details about an WAF rule for global resources.\n

" - } - }, - "AwsWafRuleGroup": { - "target": "com.amazonaws.securityhub#AwsWafRuleGroupDetails", - "traits": { - "smithy.api#documentation": "

Details about an WAF rule group for global resources.\n

" - } - }, - "AwsEcsTask": { - "target": "com.amazonaws.securityhub#AwsEcsTaskDetails", - "traits": { - "smithy.api#documentation": "

Details about a task in a cluster.

" - } - }, - "AwsBackupBackupVault": { - "target": "com.amazonaws.securityhub#AwsBackupBackupVaultDetails", - "traits": { - "smithy.api#documentation": "

Provides details about an Backup backup vault.\n

" - } - }, - "AwsBackupBackupPlan": { - "target": "com.amazonaws.securityhub#AwsBackupBackupPlanDetails", - "traits": { - "smithy.api#documentation": "

Provides details about an Backup backup plan.\n

" - } - }, - "AwsBackupRecoveryPoint": { - "target": "com.amazonaws.securityhub#AwsBackupRecoveryPointDetails", - "traits": { - "smithy.api#documentation": "

Provides details about an Backup backup, or recovery point.\n

" - } - }, - "AwsEc2LaunchTemplate": { - "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDetails" - }, - "AwsSageMakerNotebookInstance": { - "target": "com.amazonaws.securityhub#AwsSageMakerNotebookInstanceDetails" - }, - "AwsWafv2WebAcl": { - "target": "com.amazonaws.securityhub#AwsWafv2WebAclDetails" - }, - "AwsWafv2RuleGroup": { - "target": "com.amazonaws.securityhub#AwsWafv2RuleGroupDetails" - }, - "AwsEc2RouteTable": { - "target": "com.amazonaws.securityhub#AwsEc2RouteTableDetails", - "traits": { - "smithy.api#documentation": "

\n Provides details about a route table. A route table contains a set of rules, called routes, that \n determine where to direct network traffic from your subnet or gateway. \n

" - } - }, - "AwsAmazonMqBroker": { - "target": "com.amazonaws.securityhub#AwsAmazonMqBrokerDetails", - "traits": { - "smithy.api#documentation": "

\n Provides details about AppSync message broker. A message broker allows software applications and \n components to communicate using various programming languages, operating systems, and formal messaging protocols. \n

" - } - }, - "AwsAppSyncGraphQlApi": { - "target": "com.amazonaws.securityhub#AwsAppSyncGraphQlApiDetails", - "traits": { - "smithy.api#documentation": "

\n Provides details about an AppSync Graph QL API, which lets you query multiple databases, microservices, \n and APIs from a single GraphQL endpoint.\n

" - } - }, - "AwsEventSchemasRegistry": { - "target": "com.amazonaws.securityhub#AwsEventSchemasRegistryDetails", - "traits": { - "smithy.api#documentation": "

\n A schema defines the structure of events that are sent to Amazon EventBridge. Schema registries are containers for \n schemas. They collect and organize schemas so that your schemas are in logical groups. \n

" - } - }, - "AwsGuardDutyDetector": { - "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDetails", - "traits": { - "smithy.api#documentation": "

\n Provides details about an Amazon GuardDuty detector. A detector is an object that represents the GuardDuty \n service. A detector is required for GuardDuty to become operational.\n

" - } - }, - "AwsStepFunctionStateMachine": { - "target": "com.amazonaws.securityhub#AwsStepFunctionStateMachineDetails", - "traits": { - "smithy.api#documentation": "

\n Provides details about an Step Functions state machine, which is a workflow consisting of a series of event-driven steps.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Additional details about a resource related to a finding.

\n

To provide the details, use the object that corresponds to the resource type. For\n example, if the resource type is AwsEc2Instance, then you use the\n AwsEc2Instance object to provide the details.

\n

If the type-specific object does not contain all of the fields you want to populate,\n then you use the Other object to populate those additional fields.

\n

You also use the Other object to populate the details when the selected\n type does not have a corresponding object.

" - } - }, - "com.amazonaws.securityhub#ResourceList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#Resource" - } - }, - "com.amazonaws.securityhub#ResourceNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.securityhub#NonEmptyString" - }, - "Code": { - "target": "com.amazonaws.securityhub#NonEmptyString" - } - }, - "traits": { - "smithy.api#documentation": "

The request was rejected because we can't find the specified resource.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.securityhub#Result": { - "type": "structure", - "members": { - "AccountId": { - "target": "com.amazonaws.securityhub#AccountId", - "traits": { - "smithy.api#documentation": "

An Amazon Web Services account ID of the account that was not processed.

" - } - }, - "ProcessingResult": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The reason that the account was not processed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about the account that was not processed.

" - } - }, - "com.amazonaws.securityhub#ResultList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#Result" - } - }, - "com.amazonaws.securityhub#RouteSetDetails": { - "type": "structure", - "members": { - "CarrierGatewayId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The ID of the carrier gateway.\n

" - } - }, - "CoreNetworkArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the core network.\n

" - } - }, - "DestinationCidrBlock": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The IPv4 CIDR block used for the destination match.\n

" - } - }, - "DestinationIpv6CidrBlock": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The IPv6 CIDR block used for the destination match.\n

" - } - }, - "DestinationPrefixListId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The prefix of the destination Amazon Web Service.\n

" - } - }, - "EgressOnlyInternetGatewayId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The ID of the egress-only internet gateway.\n

" - } - }, - "GatewayId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The ID of a gateway attached to your VPC.\n

" - } - }, - "InstanceId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The ID of a NAT instance in your VPC.\n

" - } - }, - "InstanceOwnerId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The ID of the Amazon Web Services account that owns the instance.\n

" - } - }, - "LocalGatewayId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The ID of the local gateway.\n

" - } - }, - "NatGatewayId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The ID of a NAT gateway.\n

" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The ID of the network interface.\n

" - } - }, - "Origin": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n Describes how the route was created. \n

" - } - }, - "State": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The state of the route.\n

" - } - }, - "TransitGatewayId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The ID of a transit gateway.\n

" - } - }, - "VpcPeeringConnectionId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The ID of a VPC peering connection.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Provides details about the routes in the route table.\n

" - } - }, - "com.amazonaws.securityhub#RouteSetList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#RouteSetDetails" - } - }, - "com.amazonaws.securityhub#RuleGroupDetails": { - "type": "structure", - "members": { - "RuleVariables": { - "target": "com.amazonaws.securityhub#RuleGroupVariables", - "traits": { - "smithy.api#documentation": "

Additional settings to use in the specified rules.

" - } - }, - "RulesSource": { - "target": "com.amazonaws.securityhub#RuleGroupSource", - "traits": { - "smithy.api#documentation": "

The rules and actions for the rule group.

\n

For stateful rule groups, can contain RulesString, RulesSourceList, or StatefulRules.

\n

For stateless rule groups, contains StatelessRulesAndCustomActions.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about the rule group.

" - } - }, - "com.amazonaws.securityhub#RuleGroupSource": { - "type": "structure", - "members": { - "RulesSourceList": { - "target": "com.amazonaws.securityhub#RuleGroupSourceListDetails", - "traits": { - "smithy.api#documentation": "

Stateful inspection criteria for a domain list rule group. A domain list rule group determines access by specific protocols to specific domains.

" - } - }, - "RulesString": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Stateful inspection criteria, provided in Suricata compatible intrusion prevention system (IPS) rules.

" - } - }, - "StatefulRules": { - "target": "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesList", - "traits": { - "smithy.api#documentation": "

Suricata rule specifications.

" - } - }, - "StatelessRulesAndCustomActions": { - "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRulesAndCustomActionsDetails", - "traits": { - "smithy.api#documentation": "

The stateless rules and custom actions used by a stateless rule group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The rules and actions for the rule group.

" - } - }, - "com.amazonaws.securityhub#RuleGroupSourceCustomActionsDetails": { - "type": "structure", - "members": { - "ActionDefinition": { - "target": "com.amazonaws.securityhub#StatelessCustomActionDefinition", - "traits": { - "smithy.api#documentation": "

The definition of a custom action.

" - } - }, - "ActionName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A descriptive name of the custom action.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A custom action definition. A custom action is an optional, non-standard action to use for stateless packet handling.

" - } - }, - "com.amazonaws.securityhub#RuleGroupSourceCustomActionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#RuleGroupSourceCustomActionsDetails" - } - }, - "com.amazonaws.securityhub#RuleGroupSourceListDetails": { - "type": "structure", - "members": { - "GeneratedRulesType": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates whether to allow or deny access to the domains listed in Targets.

" - } - }, - "TargetTypes": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The protocols that you want to inspect. Specify LS_SNI for HTTPS. Specify HTTP_HOST for HTTP. You can specify either or both.

" - } - }, - "Targets": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The domains that you want to inspect for in your traffic flows. You can provide full domain names, or use the '.' prefix as a wildcard. For example, .example.com matches all domains that end with example.com.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Stateful inspection criteria for a domain list rule group.

" - } - }, - "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesDetails": { - "type": "structure", - "members": { - "Action": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria.

" - } - }, - "Header": { - "target": "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesHeaderDetails", - "traits": { - "smithy.api#documentation": "

The stateful inspection criteria for the rule.

" - } - }, - "RuleOptions": { - "target": "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesOptionsList", - "traits": { - "smithy.api#documentation": "

Additional options for the rule.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A Suricata rule specification.

" - } - }, - "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesHeaderDetails": { - "type": "structure", - "members": { - "Destination": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The destination IP address or address range to inspect for, in CIDR notation. To match with any address, specify ANY.

" - } - }, - "DestinationPort": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The destination port to inspect for. You can specify an individual port, such as 1994. You also can specify a port range, such as 1990:1994. To match with any port, specify ANY.

" - } - }, - "Direction": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The direction of traffic flow to inspect. If set to ANY, the inspection matches bidirectional traffic, both from the source to the destination and from the destination to the source. If set to FORWARD, the inspection only matches traffic going from the source to the destination.

" - } - }, - "Protocol": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The protocol to inspect for. To inspector for all protocols, use IP.

" - } - }, - "Source": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The source IP address or address range to inspect for, in CIDR notation. To match with any address, specify ANY.

" - } - }, - "SourcePort": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The source port to inspect for. You can specify an individual port, such as 1994. You also can specify a port range, such as 1990:1994. To match with any port, specify ANY.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The inspection criteria for a stateful rule.

" - } - }, - "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesDetails" - } - }, - "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesOptionsDetails": { - "type": "structure", - "members": { - "Keyword": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A keyword to look for.

" - } - }, - "Settings": { - "target": "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesRuleOptionsSettingsList", - "traits": { - "smithy.api#documentation": "

A list of settings.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A rule option for a stateful rule.

" - } - }, - "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesOptionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesOptionsDetails" - } - }, - "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesRuleOptionsSettingsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#NonEmptyString" - } - }, - "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleDefinition": { - "type": "structure", - "members": { - "Actions": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The actions to take on a packet that matches one of the stateless rule definition's match attributes. You must specify a standard action (aws:pass, aws:drop, or aws:forward_to_sfe). You can then add custom actions.

" - } - }, - "MatchAttributes": { - "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributes", - "traits": { - "smithy.api#documentation": "

The criteria for Network Firewall to use to inspect an individual packet in a stateless rule inspection.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition of the stateless rule.

" - } - }, - "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributes": { - "type": "structure", - "members": { - "DestinationPorts": { - "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesDestinationPortsList", - "traits": { - "smithy.api#documentation": "

A list of port ranges to specify the destination ports to inspect for.

" - } - }, - "Destinations": { - "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesDestinationsList", - "traits": { - "smithy.api#documentation": "

The destination IP addresses and address ranges to inspect for, in CIDR notation.

" - } - }, - "Protocols": { - "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesProtocolsList", - "traits": { - "smithy.api#documentation": "

The protocols to inspect for.

" - } - }, - "SourcePorts": { - "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesSourcePortsList", - "traits": { - "smithy.api#documentation": "

A list of port ranges to specify the source ports to inspect for.

" - } - }, - "Sources": { - "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesSourcesList", - "traits": { - "smithy.api#documentation": "

The source IP addresses and address ranges to inspect for, in CIDR notation.

" - } - }, - "TcpFlags": { - "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesTcpFlagsList", - "traits": { - "smithy.api#documentation": "

The TCP flags and masks to inspect for.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Criteria for the stateless rule.

" - } - }, - "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesDestinationPorts": { - "type": "structure", - "members": { - "FromPort": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The starting port value for the port range.

" - } - }, - "ToPort": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The ending port value for the port range.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A port range to specify the destination ports to inspect for.

" - } - }, - "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesDestinationPortsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesDestinationPorts" - } - }, - "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesDestinations": { - "type": "structure", - "members": { - "AddressDefinition": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

An IP address or a block of IP addresses.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A destination IP address or range.

" - } - }, - "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesDestinationsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesDestinations" - } - }, - "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesProtocolsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#Integer" - } - }, - "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesSourcePorts": { - "type": "structure", - "members": { - "FromPort": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The starting port value for the port range.

" - } - }, - "ToPort": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The ending port value for the port range.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A port range to specify the source ports to inspect for.

" - } - }, - "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesSourcePortsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesSourcePorts" - } - }, - "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesSources": { - "type": "structure", - "members": { - "AddressDefinition": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

An IP address or a block of IP addresses.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A source IP addresses and address range to inspect for.

" - } - }, - "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesSourcesList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesSources" - } - }, - "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesTcpFlags": { - "type": "structure", - "members": { - "Flags": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

Defines the flags from the Masks setting that must be set in order for the packet to match. Flags that are listed must be set. Flags that are not listed must not be set.

" - } - }, - "Masks": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The set of flags to consider in the inspection. If not specified, then all flags are inspected.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A set of TCP flags and masks to inspect for.

" - } - }, - "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesTcpFlagsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesTcpFlags" - } - }, - "com.amazonaws.securityhub#RuleGroupSourceStatelessRulesAndCustomActionsDetails": { - "type": "structure", - "members": { - "CustomActions": { - "target": "com.amazonaws.securityhub#RuleGroupSourceCustomActionsList", - "traits": { - "smithy.api#documentation": "

Custom actions for the rule group.

" - } - }, - "StatelessRules": { - "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRulesList", - "traits": { - "smithy.api#documentation": "

Stateless rules for the rule group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Stateless rules and custom actions for a stateless rule group.

" - } - }, - "com.amazonaws.securityhub#RuleGroupSourceStatelessRulesDetails": { - "type": "structure", - "members": { - "Priority": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Indicates the order in which to run this rule relative to all of the rules in the stateless rule group.

" - } - }, - "RuleDefinition": { - "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleDefinition", - "traits": { - "smithy.api#documentation": "

Provides the definition of the stateless rule.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A stateless rule in the rule group.

" - } - }, - "com.amazonaws.securityhub#RuleGroupSourceStatelessRulesList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRulesDetails" - } - }, - "com.amazonaws.securityhub#RuleGroupVariables": { - "type": "structure", - "members": { - "IpSets": { - "target": "com.amazonaws.securityhub#RuleGroupVariablesIpSetsDetails", - "traits": { - "smithy.api#documentation": "

A list of IP addresses and address ranges, in CIDR notation.

" - } - }, - "PortSets": { - "target": "com.amazonaws.securityhub#RuleGroupVariablesPortSetsDetails", - "traits": { - "smithy.api#documentation": "

A list of port ranges.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Additional settings to use in the specified rules.

" - } - }, - "com.amazonaws.securityhub#RuleGroupVariablesIpSetsDetails": { - "type": "structure", - "members": { - "Definition": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The list of IP addresses and ranges.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A list of IP addresses and address ranges, in CIDR notation.

" - } - }, - "com.amazonaws.securityhub#RuleGroupVariablesPortSetsDetails": { - "type": "structure", - "members": { - "Definition": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

The list of port ranges.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A list of port ranges.

" - } - }, - "com.amazonaws.securityhub#SecurityControl": { - "type": "structure", - "members": { - "SecurityControlId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Service name and a \n number, such as APIGateway.3.\n

", - "smithy.api#required": {} - } - }, - "SecurityControlArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for a security control across standards, such as\n arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1. This\n parameter doesn't mention a specific standard.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The title of a security control.\n

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The description of a security control across standards. This typically summarizes how\n Security Hub evaluates the control and the conditions under which it produces a\n failed finding. This parameter doesn't reference a specific standard.

", - "smithy.api#required": {} - } - }, - "RemediationUrl": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n A link to Security Hub documentation that explains how to remediate a failed finding for a security control.\n

", - "smithy.api#required": {} - } - }, - "SeverityRating": { - "target": "com.amazonaws.securityhub#SeverityRating", - "traits": { - "smithy.api#documentation": "

\n The severity of a security control. For more information about how Security Hub determines control severity, see \n Assigning severity to control findings in the \n Security Hub User Guide.\n

", - "smithy.api#required": {} - } - }, - "SecurityControlStatus": { - "target": "com.amazonaws.securityhub#ControlStatus", - "traits": { - "smithy.api#documentation": "

\n The status of a security control based on the compliance status of its findings. For more information about how control \n status is determined, see Determining the overall status of a control from its findings in the \n Security Hub User Guide.\n

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

\n A security control in Security Hub describes a security best practice related to a specific resource. \n

" - } - }, - "com.amazonaws.securityhub#SecurityControlDefinition": { - "type": "structure", - "members": { - "SecurityControlId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The unique identifier of a security control across standards. Values for this field typically consist of an \n Amazon Web Service name and a number (for example, APIGateway.3). This parameter differs from \n SecurityControlArn, which is a unique Amazon Resource Name (ARN) assigned to a control. The \n ARN references the security control ID (for example, arn:aws:securityhub:eu-central-1:123456789012:security-control/APIGateway.3).\n

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The title of a security control.\n

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The description of a security control across standards. This typically summarizes how\n Security Hub evaluates the control and the conditions under which it produces a\n failed finding. This parameter doesn't reference a specific standard.

", - "smithy.api#required": {} - } - }, - "RemediationUrl": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n A link to Security Hub documentation that explains how to remediate a failed finding for a security control.\n

", - "smithy.api#required": {} - } - }, - "SeverityRating": { - "target": "com.amazonaws.securityhub#SeverityRating", - "traits": { - "smithy.api#documentation": "

\n The severity of a security control. For more information about how Security Hub determines control severity, \n see Assigning severity to control findings in the \n Security Hub User Guide.\n

", - "smithy.api#required": {} - } - }, - "CurrentRegionAvailability": { - "target": "com.amazonaws.securityhub#RegionAvailabilityStatus", - "traits": { - "smithy.api#documentation": "

\n Specifies whether a security control is available in the current Amazon Web Services Region.\n

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Provides metadata for a security control, including its unique standard-agnostic identifier, title, description, \n severity, availability in Amazon Web Services Regions, and a link to remediation steps.\n

" - } - }, - "com.amazonaws.securityhub#SecurityControlDefinitions": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#SecurityControlDefinition" - } - }, - "com.amazonaws.securityhub#SecurityControls": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#SecurityControl" - } - }, - "com.amazonaws.securityhub#SecurityGroups": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#NonEmptyString" - } - }, - "com.amazonaws.securityhub#SecurityHubAPIService": { - "type": "service", - "version": "2018-10-26", - "operations": [ - { - "target": "com.amazonaws.securityhub#AcceptAdministratorInvitation" + "shapes": { + "com.amazonaws.securityhub#AcceptAdministratorInvitation": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#AcceptAdministratorInvitationRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#AcceptAdministratorInvitationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Accepts the invitation to be a member account and be monitored by the Security Hub administrator\n account that the invitation was sent from.

\n

This operation is only used by member accounts that are not added through\n Organizations.

\n

When the member account accepts the invitation, permission is granted to the administrator\n account to view findings generated in the member account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/administrator", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#AcceptAdministratorInvitationRequest": { + "type": "structure", + "members": { + "AdministratorId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The account ID of the Security Hub administrator account that sent the invitation.

", + "smithy.api#required": {} + } + }, + "InvitationId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the invitation sent from the Security Hub administrator account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#AcceptAdministratorInvitationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#AcceptInvitation": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#AcceptInvitationRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#AcceptInvitationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#deprecated": { + "message": "This API has been deprecated, use AcceptAdministratorInvitation API instead." + }, + "smithy.api#documentation": "

This method is deprecated. Instead, use AcceptAdministratorInvitation.

\n

The Security Hub console continues to use AcceptInvitation. It will eventually change to use AcceptAdministratorInvitation. Any IAM policies that specifically control access to this function must continue to use AcceptInvitation. You should also add AcceptAdministratorInvitation to your policies to ensure that the correct permissions are in place after the console begins to use AcceptAdministratorInvitation.

\n

Accepts the invitation to be a member account and be monitored by the Security Hub administrator\n account that the invitation was sent from.

\n

This operation is only used by member accounts that are not added through\n Organizations.

\n

When the member account accepts the invitation, permission is granted to the administrator\n account to view findings generated in the member account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/master", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#AcceptInvitationRequest": { + "type": "structure", + "members": { + "MasterId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The account ID of the Security Hub administrator account that sent the invitation.

", + "smithy.api#required": {} + } + }, + "InvitationId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the invitation sent from the Security Hub administrator account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#AcceptInvitationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.securityhub#NonEmptyString" + }, + "Code": { + "target": "com.amazonaws.securityhub#NonEmptyString" + } + }, + "traits": { + "smithy.api#documentation": "

You don't have permission to perform the action specified in the request.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.securityhub#AccountDetails": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.securityhub#AccountId", + "traits": { + "smithy.api#documentation": "

The ID of an Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "Email": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The email of an Amazon Web Services account.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details of an Amazon Web Services account.

" + } + }, + "com.amazonaws.securityhub#AccountDetailsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AccountDetails" + } + }, + "com.amazonaws.securityhub#AccountId": { + "type": "string" + }, + "com.amazonaws.securityhub#AccountIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#NonEmptyString" + } + }, + "com.amazonaws.securityhub#Action": { + "type": "structure", + "members": { + "ActionType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of action that was detected. The possible action types are:

\n " + } + }, + "NetworkConnectionAction": { + "target": "com.amazonaws.securityhub#NetworkConnectionAction", + "traits": { + "smithy.api#documentation": "

Included if ActionType is NETWORK_CONNECTION. Provides details\n about the network connection that was detected.

" + } + }, + "AwsApiCallAction": { + "target": "com.amazonaws.securityhub#AwsApiCallAction", + "traits": { + "smithy.api#documentation": "

Included if ActionType is AWS_API_CALL. Provides details about\n the API call that was detected.

" + } + }, + "DnsRequestAction": { + "target": "com.amazonaws.securityhub#DnsRequestAction", + "traits": { + "smithy.api#documentation": "

Included if ActionType is DNS_REQUEST. Provides details about\n the DNS request that was detected.

" + } + }, + "PortProbeAction": { + "target": "com.amazonaws.securityhub#PortProbeAction", + "traits": { + "smithy.api#documentation": "

Included if ActionType is PORT_PROBE. Provides details about\n the port probe that was detected.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about one of the following actions that affects or that was taken on a resource:

\n " + } + }, + "com.amazonaws.securityhub#ActionList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AutomationRulesAction" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.securityhub#ActionLocalIpDetails": { + "type": "structure", + "members": { + "IpAddressV4": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The IP address.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the IP address where the scanned port is located.

" + } + }, + "com.amazonaws.securityhub#ActionLocalPortDetails": { + "type": "structure", + "members": { + "Port": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of the port.

" + } + }, + "PortName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The port name of the local connection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

For NetworkConnectionAction and PortProbeDetails,\n LocalPortDetails provides information about the local port that was\n involved in the action.

" + } + }, + "com.amazonaws.securityhub#ActionRemoteIpDetails": { + "type": "structure", + "members": { + "IpAddressV4": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The IP address.

" + } + }, + "Organization": { + "target": "com.amazonaws.securityhub#IpOrganizationDetails", + "traits": { + "smithy.api#documentation": "

The internet service provider (ISP) organization associated with the remote IP\n address.

" + } + }, + "Country": { + "target": "com.amazonaws.securityhub#Country", + "traits": { + "smithy.api#documentation": "

The country where the remote IP address is located.

" + } + }, + "City": { + "target": "com.amazonaws.securityhub#City", + "traits": { + "smithy.api#documentation": "

The city where the remote IP address is located.

" + } + }, + "GeoLocation": { + "target": "com.amazonaws.securityhub#GeoLocation", + "traits": { + "smithy.api#documentation": "

The coordinates of the location of the remote IP address.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

For AwsApiAction, NetworkConnectionAction, and\n PortProbeAction, RemoteIpDetails provides information about\n the remote IP address that was involved in the action.

" + } + }, + "com.amazonaws.securityhub#ActionRemotePortDetails": { + "type": "structure", + "members": { + "Port": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of the port.

" + } + }, + "PortName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The port name of the remote connection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the remote port that was involved in an attempted network\n connection.

" + } + }, + "com.amazonaws.securityhub#ActionTarget": { + "type": "structure", + "members": { + "ActionTargetArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN for the target action.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the action target.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description of the target action.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An ActionTarget object.

" + } + }, + "com.amazonaws.securityhub#ActionTargetList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#ActionTarget" + } + }, + "com.amazonaws.securityhub#Adjustment": { + "type": "structure", + "members": { + "Metric": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The metric to adjust.

" + } + }, + "Reason": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The reason for the adjustment.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An adjustment to the CVSS metric.

" + } + }, + "com.amazonaws.securityhub#AdjustmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#Adjustment" + } + }, + "com.amazonaws.securityhub#AdminAccount": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account identifier of the Security Hub administrator account.

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#AdminStatus", + "traits": { + "smithy.api#documentation": "

The current status of the Security Hub administrator account. Indicates whether the account is\n currently enabled as a Security Hub administrator.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a Security Hub administrator account designated by an organization management\n account.

" + } + }, + "com.amazonaws.securityhub#AdminAccounts": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AdminAccount" + } + }, + "com.amazonaws.securityhub#AdminStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLE_IN_PROGRESS" + } + } + } + }, + "com.amazonaws.securityhub#AdminsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.securityhub#ArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#NonEmptyString" + } + }, + "com.amazonaws.securityhub#AssociatedStandard": { + "type": "structure", + "members": { + "StandardsId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The unique identifier of a standard in which a control is enabled. This field consists of the resource portion of the \n Amazon Resource Name (ARN) returned for a standard in the DescribeStandards API response.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Information about an enabled security standard in which a security control is enabled.\n

" + } + }, + "com.amazonaws.securityhub#AssociatedStandardsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AssociatedStandard" + } + }, + "com.amazonaws.securityhub#AssociationSetDetails": { + "type": "structure", + "members": { + "AssociationState": { + "target": "com.amazonaws.securityhub#AssociationStateDetails", + "traits": { + "smithy.api#documentation": "

\n The state of the association between a route table and a subnet or gateway.\n

" + } + }, + "GatewayId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of the internet gateway or virtual private gateway.\n

" + } + }, + "Main": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Indicates whether this is the main route table.\n

" + } + }, + "RouteTableAssociationId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of the association.\n

" + } + }, + "RouteTableId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of the route table.\n

" + } + }, + "SubnetId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of the subnet. A subnet ID is not returned for an implicit association.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The associations between a route table and one or more subnets or a gateway.\n

" + } + }, + "com.amazonaws.securityhub#AssociationSetList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AssociationSetDetails" + } + }, + "com.amazonaws.securityhub#AssociationStateDetails": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The state of the association.\n

" + } + }, + "StatusMessage": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The status message, if applicable.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Describes the state of an association between a route table and a subnet or gateway.\n

" + } + }, + "com.amazonaws.securityhub#AssociationStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.securityhub#AutoEnableStandards": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULT" + } + } + } + }, + "com.amazonaws.securityhub#AutomationRulesAction": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.securityhub#AutomationRulesActionType", + "traits": { + "smithy.api#documentation": "

\n Specifies that the rule action should update the Types finding field. The Types \n finding field provides one or more finding types in the format of \n namespace/category/classifier that classify a finding. For more information, see\n Types taxonomy for ASFF in \n the Security Hub User Guide.\n

" + } + }, + "FindingFieldsUpdate": { + "target": "com.amazonaws.securityhub#AutomationRulesFindingFieldsUpdate", + "traits": { + "smithy.api#documentation": "

\n Specifies that the automation rule action is an update to a finding field.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n One or more actions to update finding fields if a finding matches the defined criteria \n of the rule.\n

" + } + }, + "com.amazonaws.securityhub#AutomationRulesActionType": { + "type": "enum", + "members": { + "FINDING_FIELDS_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FINDING_FIELDS_UPDATE" + } + } + } + }, + "com.amazonaws.securityhub#AutomationRulesArnsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#NonEmptyString" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.securityhub#AutomationRulesConfig": { + "type": "structure", + "members": { + "RuleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of a rule.\n

" + } + }, + "RuleStatus": { + "target": "com.amazonaws.securityhub#RuleStatus", + "traits": { + "smithy.api#documentation": "

\n Whether the rule is active after it is created. If \n this parameter is equal to >ENABLED, Security Hub will apply the rule to findings \n and finding updates after the rule is created.\n

" + } + }, + "RuleOrder": { + "target": "com.amazonaws.securityhub#RuleOrderValue", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

An integer ranging from 1 to 1000 that represents the order in which the rule action is\n applied to findings. Security Hub applies rules with lower values for this parameter\n first.

" + } + }, + "RuleName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The name of the rule.\n

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n A description of the rule.\n

" + } + }, + "IsTerminal": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful \n when a finding matches the criteria for multiple rules, and each rule has different actions. If the value of this \n field is set to true for a rule, Security Hub applies the rule action to a finding that matches \n the rule criteria and won't evaluate other rules for the finding.\u2028 The default value of this field is false.\n

" + } + }, + "Criteria": { + "target": "com.amazonaws.securityhub#AutomationRulesFindingFilters", + "traits": { + "smithy.api#documentation": "

\n A set of Amazon Web Services Security Finding Format finding field attributes and corresponding expected values that \n Security Hub uses to filter findings. If a finding matches the conditions specified in\n this parameter, Security Hub applies the rule action to the finding.\n

" + } + }, + "Actions": { + "target": "com.amazonaws.securityhub#ActionList", + "traits": { + "smithy.api#documentation": "

\n One or more actions to update finding fields if a finding matches the defined criteria \n of the rule.\n

" + } + }, + "CreatedAt": { + "target": "com.amazonaws.securityhub#Timestamp", + "traits": { + "smithy.api#documentation": "

\n A timestamp that indicates when the rule was created.\n

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.securityhub#Timestamp", + "traits": { + "smithy.api#documentation": "

\n A timestamp that indicates when the rule was most recently updated.\n

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The principal that created a rule.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Defines the configuration of an automation rule.\n

" + } + }, + "com.amazonaws.securityhub#AutomationRulesConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AutomationRulesConfig" + } + }, + "com.amazonaws.securityhub#AutomationRulesFindingFieldsUpdate": { + "type": "structure", + "members": { + "Note": { + "target": "com.amazonaws.securityhub#NoteUpdate" + }, + "Severity": { + "target": "com.amazonaws.securityhub#SeverityUpdate" + }, + "VerificationState": { + "target": "com.amazonaws.securityhub#VerificationState", + "traits": { + "smithy.api#documentation": "

\n The rule action will update the VerificationState field of a finding.\n

" + } + }, + "Confidence": { + "target": "com.amazonaws.securityhub#RatioScale", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The rule action will update the Confidence field of a finding.\n

" + } + }, + "Criticality": { + "target": "com.amazonaws.securityhub#RatioScale", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The rule action will update the Criticality field of a finding.\n

" + } + }, + "Types": { + "target": "com.amazonaws.securityhub#TypeList", + "traits": { + "smithy.api#documentation": "

\n The rule action will update the Types field of a finding.\n

" + } + }, + "UserDefinedFields": { + "target": "com.amazonaws.securityhub#FieldMap", + "traits": { + "smithy.api#documentation": "

\n The rule action will update the UserDefinedFields field of a finding.\n

" + } + }, + "Workflow": { + "target": "com.amazonaws.securityhub#WorkflowUpdate" + }, + "RelatedFindings": { + "target": "com.amazonaws.securityhub#RelatedFindingList", + "traits": { + "smithy.api#documentation": "

\n A list of findings that are related to a finding.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Identifies the finding fields that the automation rule action will update when a \n finding matches the defined criteria.\n

" + } + }, + "com.amazonaws.securityhub#AutomationRulesFindingFilters": { + "type": "structure", + "members": { + "ProductArn": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) for a third-party product that generated a finding in \n Security Hub.\n

" + } + }, + "AwsAccountId": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID in which a finding was generated.

" + } + }, + "Id": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

\n The product-specific identifier for a finding.\n

" + } + }, + "GeneratorId": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

\n The identifier for the solution-specific component that \n generated a finding.\n

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

One or more finding types in the format of namespace/category/classifier that classify\n a finding. For a list of namespaces, classifiers, and categories, see Types\n taxonomy for ASFF in the Security Hub User Guide.

" + } + }, + "FirstObservedAt": { + "target": "com.amazonaws.securityhub#DateFilterList", + "traits": { + "smithy.api#documentation": "

\n A timestamp that indicates when the potential security issue captured by a \n finding was first observed by the security findings product.\n

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "LastObservedAt": { + "target": "com.amazonaws.securityhub#DateFilterList", + "traits": { + "smithy.api#documentation": "

\n A timestamp that indicates when the potential security issue captured by a finding \n was most recently observed by the security findings product.\n

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "CreatedAt": { + "target": "com.amazonaws.securityhub#DateFilterList", + "traits": { + "smithy.api#documentation": "

\n A timestamp that indicates when this finding record was created.\n

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.securityhub#DateFilterList", + "traits": { + "smithy.api#documentation": "

\n A timestamp that indicates when the finding record was most recently updated. \n

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "Confidence": { + "target": "com.amazonaws.securityhub#NumberFilterList", + "traits": { + "smithy.api#documentation": "

The likelihood that a finding accurately identifies the behavior or issue that it was\n intended to identify. Confidence is scored on a 0–100 basis using a ratio\n scale. A value of 0 means 0 percent confidence, and a value of\n 100 means 100 percent confidence. For example, a data exfiltration\n detection based on a statistical deviation of network traffic has low confidence because an\n actual exfiltration hasn't been verified. For more information, see Confidence in the Security Hub User Guide.

" + } + }, + "Criticality": { + "target": "com.amazonaws.securityhub#NumberFilterList", + "traits": { + "smithy.api#documentation": "

\n The level of importance that is assigned to the resources that are associated with a \n finding. Criticality is scored on a 0–100 basis, using a ratio scale that supports \n only full integers. A score of 0 means that the underlying resources have no \n criticality, and a score of 100 is reserved for the most critical resources. For \n more information, see Criticality in the Security Hub User Guide.

" + } + }, + "Title": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

\n A finding's title. \n

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

\n A finding's description. \n

" + } + }, + "SourceUrl": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

\n Provides a URL that links to a page about the current finding in the finding product.\n

" + } + }, + "ProductName": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

\n Provides the name of the product that generated the finding. For \n control-based findings, the product name is Security Hub.\n

" + } + }, + "CompanyName": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

\n The name of the company for the product that generated the finding. \n For control-based findings, the company is Amazon Web Services.\n

" + } + }, + "SeverityLabel": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

\n The severity value of the finding.\n

" + } + }, + "ResourceType": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

\n The type of resource that the finding pertains to.\n

" + } + }, + "ResourceId": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

\n The identifier for the given resource type. For Amazon Web Services resources that are identified by \n Amazon Resource Names (ARNs), this is the ARN. For Amazon Web Services resources that lack ARNs, \n this is the identifier as defined by the Amazon Web Service that created the resource. \n For non-Amazon Web Services resources, this is a unique identifier that is associated with the \n resource.\n

" + } + }, + "ResourcePartition": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

\n The partition in which the resource that the finding pertains to is located. \n A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition.\n

" + } + }, + "ResourceRegion": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services Region where the resource that a finding pertains to is located.\n

" + } + }, + "ResourceTags": { + "target": "com.amazonaws.securityhub#MapFilterList", + "traits": { + "smithy.api#documentation": "

\n A list of Amazon Web Services tags associated with a resource at the time the finding was processed.\n

" + } + }, + "ResourceDetailsOther": { + "target": "com.amazonaws.securityhub#MapFilterList", + "traits": { + "smithy.api#documentation": "

\n Custom fields and values about the resource that a finding pertains to.\n

" + } + }, + "ComplianceStatus": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

\n The result of a security check. This field is only used for findings generated \n from controls.\n

" + } + }, + "ComplianceSecurityControlId": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The security control ID for which a finding was generated. Security control IDs are the same across standards.

" + } + }, + "ComplianceAssociatedStandardsId": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The unique identifier of a standard in which a control is enabled. This field consists of the resource portion of \n the Amazon Resource Name (ARN) returned for a standard in the DescribeStandards API response.

" + } + }, + "VerificationState": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

\n Provides the veracity of a finding.\n

" + } + }, + "WorkflowStatus": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

\n Provides information about the status of the investigation into a finding.\n

" + } + }, + "RecordState": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

\n Provides the current state of a finding.\n

" + } + }, + "RelatedFindingsProductArn": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

\n The ARN for the product that generated a related finding.\n

" + } + }, + "RelatedFindingsId": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

\n The product-generated identifier for a related finding.\n

" + } + }, + "NoteText": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

\n The text of a user-defined note that's added to a finding.\n

" + } + }, + "NoteUpdatedAt": { + "target": "com.amazonaws.securityhub#DateFilterList", + "traits": { + "smithy.api#documentation": "

\n The timestamp of when the note was updated. Uses the date-time format specified in \n RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. \n For example, 2020-03-22T13:22:13.933Z.\n

" + } + }, + "NoteUpdatedBy": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

\n The principal that created a note.\n

" + } + }, + "UserDefinedFields": { + "target": "com.amazonaws.securityhub#MapFilterList", + "traits": { + "smithy.api#documentation": "

\n A list of user-defined name and value string pairs added to a finding.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The criteria that determine which findings a rule applies to.\n

" + } + }, + "com.amazonaws.securityhub#AutomationRulesMetadata": { + "type": "structure", + "members": { + "RuleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) for the rule.\n

" + } + }, + "RuleStatus": { + "target": "com.amazonaws.securityhub#RuleStatus", + "traits": { + "smithy.api#documentation": "

\n Whether the rule is active after it is created. If \n this parameter is equal to ENABLED, Security Hub will apply the rule to findings \n and finding updates after the rule is created. To change the value of this\n parameter after creating a rule, use BatchUpdateAutomationRules.\n

" + } + }, + "RuleOrder": { + "target": "com.amazonaws.securityhub#RuleOrderValue", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

An integer ranging from 1 to 1000 that represents the order in which the rule action is\n applied to findings. Security Hub applies rules with lower values for this parameter\n first.

" + } + }, + "RuleName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The name of the rule.\n

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n A description of the rule.\n

" + } + }, + "IsTerminal": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful \n when a finding matches the criteria for multiple rules, and each rule has different actions. If the value of this \n field is set to true for a rule, Security Hub applies the rule action to a finding that matches \n the rule criteria and won't evaluate other rules for the finding.\u2028 The default value of this field is false.\n

" + } + }, + "CreatedAt": { + "target": "com.amazonaws.securityhub#Timestamp", + "traits": { + "smithy.api#documentation": "

\n A timestamp that indicates when the rule was created.\n

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.securityhub#Timestamp", + "traits": { + "smithy.api#documentation": "

\n A timestamp that indicates when the rule was most recently updated.\n

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The principal that created a rule.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Metadata for automation rules in the calling account. The response includes rules \n with a RuleStatus of ENABLED and DISABLED.\n

" + } + }, + "com.amazonaws.securityhub#AutomationRulesMetadataList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AutomationRulesMetadata" + } + }, + "com.amazonaws.securityhub#AvailabilityZone": { + "type": "structure", + "members": { + "ZoneName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the Availability Zone.

" + } + }, + "SubnetId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the subnet. You can specify one subnet per Availability Zone.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an Availability Zone.

" + } + }, + "com.amazonaws.securityhub#AvailabilityZones": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AvailabilityZone" + } + }, + "com.amazonaws.securityhub#AwsAmazonMqBrokerDetails": { + "type": "structure", + "members": { + "AuthenticationStrategy": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The authentication strategy used to secure the broker. The default is SIMPLE.\n

" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Whether automatically upgrade new minor versions for brokers, as new versions are released and supported by Amazon MQ. \n Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.\n

" + } + }, + "BrokerArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the broker.\n

" + } + }, + "BrokerName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The broker's name.\n

" + } + }, + "DeploymentMode": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The broker's deployment mode. \n

" + } + }, + "EncryptionOptions": { + "target": "com.amazonaws.securityhub#AwsAmazonMqBrokerEncryptionOptionsDetails", + "traits": { + "smithy.api#documentation": "

\n Encryption options for the broker. Doesn’t apply to RabbitMQ brokers.\n

" + } + }, + "EngineType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The type of broker engine.\n

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The version of the broker engine.\n

" + } + }, + "HostInstanceType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The broker's instance type.\n

" + } + }, + "BrokerId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The unique ID that Amazon MQ generates for the broker.\n

" + } + }, + "LdapServerMetadata": { + "target": "com.amazonaws.securityhub#AwsAmazonMqBrokerLdapServerMetadataDetails", + "traits": { + "smithy.api#documentation": "

\n The metadata of the Lightweight Directory Access Protocol (LDAP) server used to authenticate and authorize connections to the broker. This is an optional failover server.\n

" + } + }, + "Logs": { + "target": "com.amazonaws.securityhub#AwsAmazonMqBrokerLogsDetails", + "traits": { + "smithy.api#documentation": "

\n Turns on Amazon CloudWatch logging for brokers.\n

" + } + }, + "MaintenanceWindowStartTime": { + "target": "com.amazonaws.securityhub#AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails", + "traits": { + "smithy.api#documentation": "

\n The scheduled time period (UTC) during which Amazon MQ begins to apply pending updates or patches to the broker.\n

" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Permits connections from applications outside of the VPC that hosts the broker's subnets.\n

" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

\n The list of rules (one minimum, 125 maximum) that authorize connections to brokers.\n

" + } + }, + "StorageType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The broker's storage type.\n

" + } + }, + "SubnetIds": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

\n The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.\n

" + } + }, + "Users": { + "target": "com.amazonaws.securityhub#AwsAmazonMqBrokerUsersList", + "traits": { + "smithy.api#documentation": "

\n The list of all broker usernames for the specified broker. Doesn't apply to RabbitMQ brokers.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides details about an Amazon MQ message broker. A message broker allows software applications and \n components to communicate using various programming languages, operating systems, and formal messaging protocols.\n

" + } + }, + "com.amazonaws.securityhub#AwsAmazonMqBrokerEncryptionOptionsDetails": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The KMS key that’s used to encrypt your data at rest. If not provided, Amazon MQ will use a \n default KMS key to encrypt your data.\n

" + } + }, + "UseAwsOwnedKey": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Specifies that an KMS key should be used for at-rest encryption. Set to true by default \n if no value is provided (for example, for RabbitMQ brokers).\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides details about broker encryption options.\n

" + } + }, + "com.amazonaws.securityhub#AwsAmazonMqBrokerLdapServerMetadataDetails": { + "type": "structure", + "members": { + "Hosts": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

\n Specifies the location of the LDAP server, such as Amazon Web Services Directory Service for Microsoft Active Directory. \n

" + } + }, + "RoleBase": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The distinguished name of the node in the directory information tree (DIT) to search for roles or groups.\n

" + } + }, + "RoleName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The group name attribute in a role entry whose value is the name of that role.\n

" + } + }, + "RoleSearchMatching": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The LDAP search filter used to find roles within the roleBase.\n

" + } + }, + "RoleSearchSubtree": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n The directory search scope for the role. If set to true, the scope is to search the entire subtree.\n

" + } + }, + "ServiceAccountUsername": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n A username for the service account, which is an account in your LDAP server that has access to initiate a connection.\n

" + } + }, + "UserBase": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Selects a particular subtree of the directory information tree (DIT) to search for user entries.\n

" + } + }, + "UserRoleName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The name of the LDAP attribute in the user's directory entry for the user's group membership.

" + } + }, + "UserSearchMatching": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The LDAP search filter used to find users within the userBase. \n

" + } + }, + "UserSearchSubtree": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n The directory search scope for the user. If set to true, the scope is to search the entire subtree.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The metadata of the Lightweight Directory Access Protocol (LDAP) server used to authenticate and authorize \n connections to the broker. This is an optional failover server.\n

" + } + }, + "com.amazonaws.securityhub#AwsAmazonMqBrokerLogsDetails": { + "type": "structure", + "members": { + "Audit": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Activates audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Doesn't apply to RabbitMQ brokers.\n

" + } + }, + "General": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Activates general logging.\n

" + } + }, + "AuditLogGroup": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The location of the CloudWatch Logs log group where audit logs are sent.\n

" + } + }, + "GeneralLogGroup": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The location of the CloudWatch Logs log group where general logs are sent.\n

" + } + }, + "Pending": { + "target": "com.amazonaws.securityhub#AwsAmazonMqBrokerLogsPendingDetails", + "traits": { + "smithy.api#documentation": "

\n The list of information about logs that are to be turned on for the specified broker.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides information about logs to be activated for the specified broker.\n

" + } + }, + "com.amazonaws.securityhub#AwsAmazonMqBrokerLogsPendingDetails": { + "type": "structure", + "members": { + "Audit": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Activates audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Doesn't apply \n to RabbitMQ brokers.\n

" + } + }, + "General": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Activates general logging.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides information about logs to be activated for the specified broker.\n

" + } + }, + "com.amazonaws.securityhub#AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails": { + "type": "structure", + "members": { + "DayOfWeek": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The day of the week on which the maintenance window falls.\n

" + } + }, + "TimeOfDay": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The time, in 24-hour format, on which the maintenance window falls.\n

" + } + }, + "TimeZone": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The time zone in either the Country/City format or the UTC offset format. UTC is the default format.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The scheduled time period (UTC) during which Amazon MQ begins to apply pending updates or patches to the broker.\n

" + } + }, + "com.amazonaws.securityhub#AwsAmazonMqBrokerUsersDetails": { + "type": "structure", + "members": { + "PendingChange": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The type of change pending for the broker user.\n

" + } + }, + "Username": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The username of the broker user. \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides details about the broker usernames for the specified broker. Doesn't apply to RabbitMQ brokers.\n

" + } + }, + "com.amazonaws.securityhub#AwsAmazonMqBrokerUsersList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsAmazonMqBrokerUsersDetails" + } + }, + "com.amazonaws.securityhub#AwsApiCallAction": { + "type": "structure", + "members": { + "Api": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the API method that was issued.

" + } + }, + "ServiceName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Web Services service that the API method belongs to.

" + } + }, + "CallerType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates whether the API call originated from a remote IP address\n (remoteip) or from a DNS domain (domain).

" + } + }, + "RemoteIpDetails": { + "target": "com.amazonaws.securityhub#ActionRemoteIpDetails", + "traits": { + "smithy.api#documentation": "

Provided if CallerType is remoteIp. Provides information about\n the remote IP address that the API call originated from.

" + } + }, + "DomainDetails": { + "target": "com.amazonaws.securityhub#AwsApiCallActionDomainDetails", + "traits": { + "smithy.api#documentation": "

Provided if CallerType is domain. Provides information about\n the DNS domain that the API call originated from.

" + } + }, + "AffectedResources": { + "target": "com.amazonaws.securityhub#FieldMap", + "traits": { + "smithy.api#documentation": "

Identifies the resources that were affected by the API call.

" + } + }, + "FirstSeen": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

An ISO8601-formatted timestamp that indicates when the API call was first\n observed.

\n

A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.

" + } + }, + "LastSeen": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

An ISO8601-formatted timestamp that indicates when the API call was most recently\n observed.

\n

A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provided if ActionType is AWS_API_CALL. It provides details\n about the API call that was detected.

" + } + }, + "com.amazonaws.securityhub#AwsApiCallActionDomainDetails": { + "type": "structure", + "members": { + "Domain": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the DNS domain that issued the API call.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provided if CallerType is domain. It provides information\n about the DNS domain that issued the API call.

" + } + }, + "com.amazonaws.securityhub#AwsApiGatewayAccessLogSettings": { + "type": "structure", + "members": { + "Format": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A single-line format of the access logs of data, as specified by selected\n $context variables. The format must include at least\n $context.requestId.

" + } + }, + "DestinationArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the CloudWatch Logs log group that receives the access logs.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about settings for logging access for the stage.

" + } + }, + "com.amazonaws.securityhub#AwsApiGatewayCanarySettings": { + "type": "structure", + "members": { + "PercentTraffic": { + "target": "com.amazonaws.securityhub#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The percentage of traffic that is diverted to a canary deployment.

" + } + }, + "DeploymentId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The deployment identifier for the canary deployment.

" + } + }, + "StageVariableOverrides": { + "target": "com.amazonaws.securityhub#FieldMap", + "traits": { + "smithy.api#documentation": "

Stage variables that are overridden in the canary release deployment. The variables\n include new stage variables that are introduced in the canary.

\n

Each variable is represented as a string-to-string map between the stage variable name\n and the variable value.

" + } + }, + "UseStageCache": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the canary deployment uses the stage cache.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about settings for canary deployment in the stage.

" + } + }, + "com.amazonaws.securityhub#AwsApiGatewayEndpointConfiguration": { + "type": "structure", + "members": { + "Types": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

A list of endpoint types for the REST API.

\n

For an edge-optimized API, the endpoint type is EDGE. For a Regional API,\n the endpoint type is REGIONAL. For a private API, the endpoint type is\n PRIVATE.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the endpoints for the API.

" + } + }, + "com.amazonaws.securityhub#AwsApiGatewayMethodSettings": { + "type": "structure", + "members": { + "MetricsEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether CloudWatch metrics are enabled for the method.

" + } + }, + "LoggingLevel": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The logging level for this method. The logging level affects the log entries that are\n pushed to CloudWatch Logs.

\n

If the logging level is ERROR, then the logs only include error-level\n entries.

\n

If the logging level is INFO, then the logs include both ERROR\n events and extra informational events.

\n

Valid values: OFF | ERROR | INFO\n

" + } + }, + "DataTraceEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether data trace logging is enabled for the method. Data trace logging\n affects the log entries that are pushed to CloudWatch Logs.

" + } + }, + "ThrottlingBurstLimit": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The throttling burst limit for the method.

" + } + }, + "ThrottlingRateLimit": { + "target": "com.amazonaws.securityhub#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The throttling rate limit for the method.

" + } + }, + "CachingEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether responses are cached and returned for requests. For responses to be\n cached, a cache cluster must be enabled on the stage.

" + } + }, + "CacheTtlInSeconds": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL,\n the longer the response is cached.

" + } + }, + "CacheDataEncrypted": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the cached responses are encrypted.

" + } + }, + "RequireAuthorizationForCacheControl": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether authorization is required for a cache invalidation request.

" + } + }, + "UnauthorizedCacheControlHeaderStrategy": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates how to handle unauthorized requests for cache invalidation.

\n

Valid values: FAIL_WITH_403 | SUCCEED_WITH_RESPONSE_HEADER |\n SUCCEED_WITHOUT_RESPONSE_HEADER\n

" + } + }, + "HttpMethod": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to\n multiple methods.

" + } + }, + "ResourcePath": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The resource path for this method. Forward slashes (/) are encoded as ~1 . The initial\n slash must include a forward slash.

\n

For example, the path value /resource/subresource must be encoded as\n /~1resource~1subresource.

\n

To specify the root path, use only a slash (/). You can use an asterisk (*) as a\n wildcard to apply method settings to multiple methods.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines settings for a method for the stage.

" + } + }, + "com.amazonaws.securityhub#AwsApiGatewayMethodSettingsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsApiGatewayMethodSettings" + } + }, + "com.amazonaws.securityhub#AwsApiGatewayRestApiDetails": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the REST API.

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the REST API.

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A description of the REST API.

" + } + }, + "CreatedDate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the API was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "Version": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The version identifier for the REST API.

" + } + }, + "BinaryMediaTypes": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The list of binary media types supported by the REST API.

" + } + }, + "MinimumCompressionSize": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum size in bytes of a payload before compression is enabled.

\n

If null, then compression is disabled.

\n

If 0, then all payloads are compressed.

" + } + }, + "ApiKeySource": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The source of the API key for metering requests according to a usage plan.

\n

\n HEADER indicates whether to read the API key from the X-API-Key header of a\n request.

\n

\n AUTHORIZER indicates whether to read the API key from the\n UsageIdentifierKey from a custom authorizer.

" + } + }, + "EndpointConfiguration": { + "target": "com.amazonaws.securityhub#AwsApiGatewayEndpointConfiguration", + "traits": { + "smithy.api#documentation": "

The endpoint configuration of the REST API.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a REST API in version 1 of Amazon API Gateway.

" + } + }, + "com.amazonaws.securityhub#AwsApiGatewayStageDetails": { + "type": "structure", + "members": { + "DeploymentId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the deployment that the stage points to.

" + } + }, + "ClientCertificateId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the client certificate for the stage.

" + } + }, + "StageName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the stage.

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A description of the stage.

" + } + }, + "CacheClusterEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether a cache cluster is enabled for the stage.

" + } + }, + "CacheClusterSize": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

If a cache cluster is enabled, the size of the cache cluster.

" + } + }, + "CacheClusterStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

If a cache cluster is enabled, the status of the cache cluster.

" + } + }, + "MethodSettings": { + "target": "com.amazonaws.securityhub#AwsApiGatewayMethodSettingsList", + "traits": { + "smithy.api#documentation": "

Defines the method settings for the stage.

" + } + }, + "Variables": { + "target": "com.amazonaws.securityhub#FieldMap", + "traits": { + "smithy.api#documentation": "

A map that defines the stage variables for the stage.

\n

Variable names can have alphanumeric and underscore characters.

\n

Variable values can contain the following characters:

\n " + } + }, + "DocumentationVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The version of the API documentation that is associated with the stage.

" + } + }, + "AccessLogSettings": { + "target": "com.amazonaws.securityhub#AwsApiGatewayAccessLogSettings", + "traits": { + "smithy.api#documentation": "

Settings for logging access for the stage.

" + } + }, + "CanarySettings": { + "target": "com.amazonaws.securityhub#AwsApiGatewayCanarySettings", + "traits": { + "smithy.api#documentation": "

Information about settings for canary deployment in the stage.

" + } + }, + "TracingEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether active tracing with X-Ray is enabled for the stage.

" + } + }, + "CreatedDate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the stage was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "LastUpdatedDate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the stage was most recently updated.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "WebAclArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the web ACL associated with the stage.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about a version 1 Amazon API Gateway stage.

" + } + }, + "com.amazonaws.securityhub#AwsApiGatewayV2ApiDetails": { + "type": "structure", + "members": { + "ApiEndpoint": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The URI of the API.

\n

Uses the format\n \n .execute-api..amazonaws.com\n

\n

The stage name is typically appended to the URI to form a complete path to a deployed\n API stage.

" + } + }, + "ApiId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the API.

" + } + }, + "ApiKeySelectionExpression": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

An API key selection expression. Supported only for WebSocket APIs.

" + } + }, + "CreatedDate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the API was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A description of the API.

" + } + }, + "Version": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The version identifier for the API.

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the API.

" + } + }, + "ProtocolType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The API protocol for the API.

\n

Valid values: WEBSOCKET | HTTP\n

" + } + }, + "RouteSelectionExpression": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The route selection expression for the API.

\n

For HTTP APIs, must be ${request.method} ${request.path}. This is the\n default value for HTTP APIs.

\n

For WebSocket APIs, there is no default value.

" + } + }, + "CorsConfiguration": { + "target": "com.amazonaws.securityhub#AwsCorsConfiguration", + "traits": { + "smithy.api#documentation": "

A cross-origin resource sharing (CORS) configuration. Supported only for HTTP\n APIs.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a version 2 API in Amazon API Gateway.

" + } + }, + "com.amazonaws.securityhub#AwsApiGatewayV2RouteSettings": { + "type": "structure", + "members": { + "DetailedMetricsEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether detailed metrics are enabled.

" + } + }, + "LoggingLevel": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The logging level. The logging level affects the log entries that are pushed to\n CloudWatch Logs. Supported only for WebSocket APIs.

\n

If the logging level is ERROR, then the logs only include error-level\n entries.

\n

If the logging level is INFO, then the logs include both ERROR\n events and extra informational events.

\n

Valid values: OFF | ERROR | INFO\n

" + } + }, + "DataTraceEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether data trace logging is enabled. Data trace logging affects the log\n entries that are pushed to CloudWatch Logs. Supported only for WebSocket APIs.

" + } + }, + "ThrottlingBurstLimit": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The throttling burst limit.

" + } + }, + "ThrottlingRateLimit": { + "target": "com.amazonaws.securityhub#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The throttling rate limit.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains route settings for a stage.

" + } + }, + "com.amazonaws.securityhub#AwsApiGatewayV2StageDetails": { + "type": "structure", + "members": { + "ClientCertificateId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of a client certificate for a stage. Supported only for WebSocket API calls.

" + } + }, + "CreatedDate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the stage was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description of the stage.

" + } + }, + "DefaultRouteSettings": { + "target": "com.amazonaws.securityhub#AwsApiGatewayV2RouteSettings", + "traits": { + "smithy.api#documentation": "

Default route settings for the stage.

" + } + }, + "DeploymentId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the deployment that the stage is associated with.

" + } + }, + "LastUpdatedDate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the stage was most recently updated.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "RouteSettings": { + "target": "com.amazonaws.securityhub#AwsApiGatewayV2RouteSettings", + "traits": { + "smithy.api#documentation": "

The route settings for the stage.

" + } + }, + "StageName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the stage.

" + } + }, + "StageVariables": { + "target": "com.amazonaws.securityhub#FieldMap", + "traits": { + "smithy.api#documentation": "

A map that defines the stage variables for the stage.

\n

Variable names can have alphanumeric and underscore characters.

\n

Variable values can contain the following characters:

\n " + } + }, + "AccessLogSettings": { + "target": "com.amazonaws.securityhub#AwsApiGatewayAccessLogSettings", + "traits": { + "smithy.api#documentation": "

Information about settings for logging access for the stage.

" + } + }, + "AutoDeploy": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether updates to an API automatically trigger a new deployment.

" + } + }, + "LastDeploymentStatusMessage": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of the last deployment of a stage. Supported only if the stage has automatic\n deployment enabled.

" + } + }, + "ApiGatewayManaged": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the stage is managed by API Gateway.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a version 2 stage for Amazon API Gateway.

" + } + }, + "com.amazonaws.securityhub#AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails": { + "type": "structure", + "members": { + "AuthenticationType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The type of security configuration for your GraphQL API: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.\n

" + } + }, + "LambdaAuthorizerConfig": { + "target": "com.amazonaws.securityhub#AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails", + "traits": { + "smithy.api#documentation": "

\n The configuration for Lambda function authorization.\n

" + } + }, + "OpenIdConnectConfig": { + "target": "com.amazonaws.securityhub#AwsAppSyncGraphQlApiOpenIdConnectConfigDetails", + "traits": { + "smithy.api#documentation": "

\n The OpenID Connect configuration.\n

" + } + }, + "UserPoolConfig": { + "target": "com.amazonaws.securityhub#AwsAppSyncGraphQlApiUserPoolConfigDetails", + "traits": { + "smithy.api#documentation": "

\n The Amazon Cognito user pools configuration.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n A list of additional authentication providers for the GraphqlApi API.\n

" + } + }, + "com.amazonaws.securityhub#AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails" + } + }, + "com.amazonaws.securityhub#AwsAppSyncGraphQlApiDetails": { + "type": "structure", + "members": { + "ApiId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The unique identifier for the API.\n

" + } + }, + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The unique identifier for the API.

" + } + }, + "OpenIdConnectConfig": { + "target": "com.amazonaws.securityhub#AwsAppSyncGraphQlApiOpenIdConnectConfigDetails", + "traits": { + "smithy.api#documentation": "

\nSpecifies the authorization configuration for using an OpenID Connect compliant service with an AppSync GraphQL API endpoint. \n

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\nThe API name.\n

" + } + }, + "LambdaAuthorizerConfig": { + "target": "com.amazonaws.securityhub#AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails", + "traits": { + "smithy.api#documentation": "

\nSpecifies the configuration for Lambda function authorization.\n

" + } + }, + "XrayEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\nIndicates whether to use X-Ray tracing for the GraphQL API.\n

" + } + }, + "Arn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\nThe Amazon Resource Name (ARN) of the API.\n

" + } + }, + "UserPoolConfig": { + "target": "com.amazonaws.securityhub#AwsAppSyncGraphQlApiUserPoolConfigDetails", + "traits": { + "smithy.api#documentation": "

\nThe Amazon Cognito user pools configuration.\n

" + } + }, + "AuthenticationType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\nThe type of security configuration for your GraphQL API: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.\n

" + } + }, + "LogConfig": { + "target": "com.amazonaws.securityhub#AwsAppSyncGraphQlApiLogConfigDetails", + "traits": { + "smithy.api#documentation": "

\n The Amazon CloudWatch Logs configuration.\n

" + } + }, + "AdditionalAuthenticationProviders": { + "target": "com.amazonaws.securityhub#AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersList", + "traits": { + "smithy.api#documentation": "

\n A list of additional authentication providers for the GraphQL API.\n

" + } + }, + "WafWebAclArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with this \n GraphQL API, if one exists.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides details about an AppSync Graph QL API, which lets you query multiple databases, microservices, and APIs from a single GraphQL endpoint.\n

" + } + }, + "com.amazonaws.securityhub#AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails": { + "type": "structure", + "members": { + "AuthorizerResultTtlInSeconds": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The number of seconds a response should be cached for. The default is 5 minutes (300 seconds).\n

" + } + }, + "AuthorizerUri": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can be a \n standard Lambda ARN, a version ARN (.../v3), or an alias ARN.\n

" + } + }, + "IdentityValidationExpression": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n A regular expression for validation of tokens before the Lambda function is called.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Specifies the authorization configuration for using an Lambda function with your AppSync \n GraphQL API endpoint.\n

" + } + }, + "com.amazonaws.securityhub#AwsAppSyncGraphQlApiLogConfigDetails": { + "type": "structure", + "members": { + "CloudWatchLogsRoleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the service role that AppSync assumes to publish to CloudWatch Logs \n in your account.\n

" + } + }, + "ExcludeVerboseContent": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, \n regardless of logging level.\n

" + } + }, + "FieldLogLevel": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The field logging level.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Specifies the logging configuration when writing GraphQL operations and tracing to Amazon CloudWatch for an \n AppSync GraphQL API.\n

" + } + }, + "com.amazonaws.securityhub#AwsAppSyncGraphQlApiOpenIdConnectConfigDetails": { + "type": "structure", + "members": { + "AuthTtL": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The number of milliseconds that a token is valid after being authenticated.\n

" + } + }, + "ClientId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The client identifier of the relying party at the OpenID identity provider. This identifier is typically obtained \n when the relying party is registered with the OpenID identity provider. You can specify a regular expression so that \n AppSync can validate against multiple client identifiers at a time.\n

" + } + }, + "IatTtL": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The number of milliseconds that a token is valid after it's issued to a user.\n

" + } + }, + "Issuer": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of iss \n in the ID token.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Specifies the authorization configuration for using an OpenID Connect compliant service with your AppSync GraphQL \n API endpoint.\n

" + } + }, + "com.amazonaws.securityhub#AwsAppSyncGraphQlApiUserPoolConfigDetails": { + "type": "structure", + "members": { + "AppIdClientRegex": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n A regular expression for validating the incoming Amazon Cognito user pools app client ID. If this value isn't set, no \n filtering is applied.\n

" + } + }, + "AwsRegion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services Region in which the user pool was created.\n

" + } + }, + "DefaultAction": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pools \n authentication doesn't match the Amazon Cognito user pools configuration.\n

" + } + }, + "UserPoolId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The user pool ID.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Specifies the authorization configuration for using Amazon Cognito user pools with your AppSync GraphQL API \n endpoint.\n

" + } + }, + "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupAvailabilityZonesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupAvailabilityZonesListDetails" + } + }, + "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupAvailabilityZonesListDetails": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the Availability Zone.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An Availability Zone for the automatic scaling group.

" + } + }, + "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupDetails": { + "type": "structure", + "members": { + "LaunchConfigurationName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the launch configuration.

" + } + }, + "LoadBalancerNames": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

The list of load balancers associated with the group.

" + } + }, + "HealthCheckType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The service to use for the health checks. Valid values are EC2 or ELB.

" + } + }, + "HealthCheckGracePeriod": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before it checks the\n health status of an EC2 instance that has come into service.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the auto scaling group was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "MixedInstancesPolicy": { + "target": "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyDetails", + "traits": { + "smithy.api#documentation": "

The mixed instances policy for the automatic scaling group.

" + } + }, + "AvailabilityZones": { + "target": "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupAvailabilityZonesList", + "traits": { + "smithy.api#documentation": "

The list of Availability Zones for the automatic scaling group.

" + } + }, + "LaunchTemplate": { + "target": "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupLaunchTemplateLaunchTemplateSpecification", + "traits": { + "smithy.api#documentation": "

The launch template to use.

" + } + }, + "CapacityRebalance": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether capacity rebalancing is enabled.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about an auto scaling group.

" + } + }, + "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupLaunchTemplateLaunchTemplateSpecification": { + "type": "structure", + "members": { + "LaunchTemplateId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the launch template. You must specify either LaunchTemplateId or LaunchTemplateName.

" + } + }, + "LaunchTemplateName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the launch template. You must specify either LaunchTemplateId or LaunchTemplateName.

" + } + }, + "Version": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Identifies the version of the launch template. You can specify a version identifier, or use the values $Latest or $Default.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the launch template to use.

" + } + }, + "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyDetails": { + "type": "structure", + "members": { + "InstancesDistribution": { + "target": "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails", + "traits": { + "smithy.api#documentation": "

The instances distribution. 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.

" + } + }, + "LaunchTemplate": { + "target": "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateDetails", + "traits": { + "smithy.api#documentation": "

The launch template to use and the instance types (overrides) to use to provision EC2 instances to fulfill On-Demand and Spot capacities.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The mixed instances policy for the automatic scaling group.

" + } + }, + "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails": { + "type": "structure", + "members": { + "OnDemandAllocationStrategy": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

How to allocate instance types to fulfill On-Demand capacity. The valid value is prioritized.

" + } + }, + "OnDemandBaseCapacity": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances.

" + } + }, + "OnDemandPercentageAboveBaseCapacity": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The percentage of On-Demand Instances and Spot Instances for additional capacity beyond OnDemandBaseCapacity.

" + } + }, + "SpotAllocationStrategy": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

How to allocate instances across Spot Instance pools. Valid values are as follows:

\n " + } + }, + "SpotInstancePools": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of Spot Instance pools across which to allocate your Spot Instances.

" + } + }, + "SpotMaxPrice": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the instances distribution.

" + } + }, + "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateDetails": { + "type": "structure", + "members": { + "LaunchTemplateSpecification": { + "target": "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification", + "traits": { + "smithy.api#documentation": "

The launch template to use for a mixed instances policy.

" + } + }, + "Overrides": { + "target": "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesList", + "traits": { + "smithy.api#documentation": "

Property values to use to override the values in the launch template.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a launch template and overrides for a mixed instances policy.

" + } + }, + "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification": { + "type": "structure", + "members": { + "LaunchTemplateId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the launch template. You must specify either LaunchTemplateId or LaunchTemplateName.

" + } + }, + "LaunchTemplateName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the launch template. You must specify either LaunchTemplateId or LaunchTemplateName.

" + } + }, + "Version": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Identifies the version of the launch template. You can specify a version identifier, or use the values $Latest or $Default.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the launch template to use for a mixed instances policy.

" + } + }, + "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesListDetails" + } + }, + "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesListDetails": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The instance type. For example, m3.xlarge.

" + } + }, + "WeightedCapacity": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The number of capacity units provided by the specified instance type in terms of virtual CPUs, memory, storage, throughput, or other relative performance characteristic.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Property values to use to override the values in the launch template.

" + } + }, + "com.amazonaws.securityhub#AwsAutoScalingLaunchConfigurationBlockDeviceMappingsDetails": { + "type": "structure", + "members": { + "DeviceName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The device name that is exposed to the EC2 instance. For example, /dev/sdh or xvdh.

" + } + }, + "Ebs": { + "target": "com.amazonaws.securityhub#AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails", + "traits": { + "smithy.api#documentation": "

Parameters that are used to automatically set up Amazon EBS volumes when an instance is launched.

" + } + }, + "NoDevice": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether to suppress the device that is included in the block device mapping of the Amazon Machine Image (AMI).

\n

If NoDevice is true, then you cannot specify Ebs.>

" + } + }, + "VirtualName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the virtual device (for example, ephemeral0).

\n

You can provide either VirtualName or Ebs, but not both.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A block device for the instance.

" + } + }, + "com.amazonaws.securityhub#AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails": { + "type": "structure", + "members": { + "DeleteOnTermination": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether to delete the volume when the instance is terminated.

" + } + }, + "Encrypted": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether to encrypt the volume.

" + } + }, + "Iops": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of input/output (I/O) operations per second (IOPS) to provision for the volume.

\n

Only supported for gp3 or io1 volumes. Required for io1 volumes. Not used with standard, gp2, st1, or sc1 volumes.

" + } + }, + "SnapshotId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The snapshot ID of the volume to use.

\n

You must specify either VolumeSize or SnapshotId.

" + } + }, + "VolumeSize": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The volume size, in GiBs. The following are the supported volumes sizes for each volume type:

\n \n

You must specify either SnapshotId or VolumeSize. If you specify both SnapshotId and VolumeSize, the volume size must be equal or greater than the size of the snapshot.

" + } + }, + "VolumeType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The volume type. Valid values are as follows:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Parameters that are used to automatically set up EBS volumes when an instance is launched.

" + } + }, + "com.amazonaws.securityhub#AwsAutoScalingLaunchConfigurationBlockDeviceMappingsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsAutoScalingLaunchConfigurationBlockDeviceMappingsDetails" + } + }, + "com.amazonaws.securityhub#AwsAutoScalingLaunchConfigurationDetails": { + "type": "structure", + "members": { + "AssociatePublicIpAddress": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

For Auto Scaling groups that run in a VPC, specifies whether to assign a public IP address to the group's instances.

" + } + }, + "BlockDeviceMappings": { + "target": "com.amazonaws.securityhub#AwsAutoScalingLaunchConfigurationBlockDeviceMappingsList", + "traits": { + "smithy.api#documentation": "

Specifies the block devices for the instance.

" + } + }, + "ClassicLinkVpcId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of a ClassicLink-enabled VPC that EC2-Classic instances are linked to.

" + } + }, + "ClassicLinkVpcSecurityGroups": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The identifiers of one or more security groups for the VPC that is specified in ClassicLinkVPCId.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The creation date and time for the launch configuration.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "EbsOptimized": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the launch configuration is optimized for Amazon EBS I/O.

" + } + }, + "IamInstanceProfile": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name or the ARN of the instance profile associated with the IAM role for the\n instance. The instance profile contains the IAM role.

" + } + }, + "ImageId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Machine Image (AMI) that is used to launch EC2\n instances.

" + } + }, + "InstanceMonitoring": { + "target": "com.amazonaws.securityhub#AwsAutoScalingLaunchConfigurationInstanceMonitoringDetails", + "traits": { + "smithy.api#documentation": "

Indicates the type of monitoring for instances in the group.

" + } + }, + "InstanceType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The instance type for the instances.

" + } + }, + "KernelId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the kernel associated with the AMI.

" + } + }, + "KeyName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the key pair.

" + } + }, + "LaunchConfigurationName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the launch configuration.

" + } + }, + "PlacementTenancy": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The tenancy of the instance. An instance with dedicated tenancy runs on\n isolated, single-tenant hardware and can only be launched into a VPC.

" + } + }, + "RamdiskId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the RAM disk associated with the AMI.

" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The security groups to assign to the instances in the Auto Scaling group.

" + } + }, + "SpotPrice": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The maximum hourly price to be paid for any Spot Instance that is launched to fulfill the\n request.

" + } + }, + "UserData": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The user data to make available to the launched EC2 instances. Must be base64-encoded\n text.

" + } + }, + "MetadataOptions": { + "target": "com.amazonaws.securityhub#AwsAutoScalingLaunchConfigurationMetadataOptions", + "traits": { + "smithy.api#documentation": "

The metadata options for the instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about a launch configuration.

" + } + }, + "com.amazonaws.securityhub#AwsAutoScalingLaunchConfigurationInstanceMonitoringDetails": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

If set to true, then instances in the group launch with detailed\n monitoring.

\n

If set to false, then instances in the group launch with basic\n monitoring.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the type of monitoring for instances in the group.

" + } + }, + "com.amazonaws.securityhub#AwsAutoScalingLaunchConfigurationMetadataOptions": { + "type": "structure", + "members": { + "HttpEndpoint": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Enables or disables the HTTP metadata endpoint on your instances. By default, the metadata endpoint is enabled.

" + } + }, + "HttpPutResponseHopLimit": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.

" + } + }, + "HttpTokens": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates whether token usage is required or optional for metadata requests. By default, token usage is optional.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The metadata options for the instances.

" + } + }, + "com.amazonaws.securityhub#AwsBackupBackupPlanAdvancedBackupSettingsDetails": { + "type": "structure", + "members": { + "BackupOptions": { + "target": "com.amazonaws.securityhub#FieldMap", + "traits": { + "smithy.api#documentation": "

Specifies the backup option for a selected resource. This option is only available for Windows \nVolume Shadow Copy Service (VSS) backup jobs. Valid values are as follows:

\n " + } + }, + "ResourceType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of a resource type. The only supported resource type is Amazon EC2 instances with Windows VSS.

\n

The only valid value is EC2.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides a list of backup options for each resource type.\n

" + } + }, + "com.amazonaws.securityhub#AwsBackupBackupPlanAdvancedBackupSettingsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsBackupBackupPlanAdvancedBackupSettingsDetails" + } + }, + "com.amazonaws.securityhub#AwsBackupBackupPlanBackupPlanDetails": { + "type": "structure", + "members": { + "BackupPlanName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The display name of a backup plan.\n

" + } + }, + "AdvancedBackupSettings": { + "target": "com.amazonaws.securityhub#AwsBackupBackupPlanAdvancedBackupSettingsList", + "traits": { + "smithy.api#documentation": "

A list of backup options for each resource type.\n

" + } + }, + "BackupPlanRule": { + "target": "com.amazonaws.securityhub#AwsBackupBackupPlanRuleList", + "traits": { + "smithy.api#documentation": "

An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about an Backup backup plan and an array of BackupRule objects, each of which specifies a backup rule.\n

" + } + }, + "com.amazonaws.securityhub#AwsBackupBackupPlanDetails": { + "type": "structure", + "members": { + "BackupPlan": { + "target": "com.amazonaws.securityhub#AwsBackupBackupPlanBackupPlanDetails", + "traits": { + "smithy.api#documentation": "

Uniquely identifies the backup plan to be associated with the selection of resources.\n

" + } + }, + "BackupPlanArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies the backup plan.\n

" + } + }, + "BackupPlanId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A unique ID for the backup plan.\n

" + } + }, + "VersionId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Unique, randomly generated, Unicode, UTF-8 encoded strings. Version IDs cannot be edited.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about an Backup backup plan and an array of BackupRule objects, each of which specifies a backup rule.\n

" + } + }, + "com.amazonaws.securityhub#AwsBackupBackupPlanLifecycleDetails": { + "type": "structure", + "members": { + "DeleteAfterDays": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.\n

" + } + }, + "MoveToColdStorageAfterDays": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Specifies the number of days after creation that a recovery point is moved to cold storage.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides lifecycle details for the backup plan. A lifecycle defines when a backup is transitioned to cold storage and when it expires.\n

" + } + }, + "com.amazonaws.securityhub#AwsBackupBackupPlanRuleCopyActionsDetails": { + "type": "structure", + "members": { + "DestinationBackupVaultArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for the copied backup.\n

" + } + }, + "Lifecycle": { + "target": "com.amazonaws.securityhub#AwsBackupBackupPlanLifecycleDetails", + "traits": { + "smithy.api#documentation": "

Defines when a protected resource is transitioned to cold storage and when it expires.\n Backup transitions and expires backups automatically according to the\n lifecycle that you define. If you do not specify a lifecycle, Backup applies\n the lifecycle policy of the source backup to the destination backup.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An array of CopyAction objects, each of which contains details of the copy operation.\n

" + } + }, + "com.amazonaws.securityhub#AwsBackupBackupPlanRuleCopyActionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsBackupBackupPlanRuleCopyActionsDetails" + } + }, + "com.amazonaws.securityhub#AwsBackupBackupPlanRuleDetails": { + "type": "structure", + "members": { + "TargetBackupVault": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the Amazon Web Services account used to create them and the Amazon Web Services Region where they are created. They consist of letters, numbers, and hyphens.\n

" + } + }, + "StartWindowMinutes": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully.\n

" + } + }, + "ScheduleExpression": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A cron expression in UTC specifying when Backup initiates a backup job.\n

" + } + }, + "RuleName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.

" + } + }, + "RuleId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Uniquely identifies a rule that is used to schedule the backup of a selection of resources.\n

" + } + }, + "EnableContinuousBackup": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether Backup creates continuous backups capable of point-in-time restore (PITR).\n

" + } + }, + "CompletionWindowMinutes": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

A value in minutes after a backup job is successfully started before it must be completed, or it is canceled by Backup.\n

" + } + }, + "CopyActions": { + "target": "com.amazonaws.securityhub#AwsBackupBackupPlanRuleCopyActionsList", + "traits": { + "smithy.api#documentation": "

An array of CopyAction objects, each of which contains details of the\n copy operation.

" + } + }, + "Lifecycle": { + "target": "com.amazonaws.securityhub#AwsBackupBackupPlanLifecycleDetails", + "traits": { + "smithy.api#documentation": "

Defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. If you do not specify a lifecycle, Backup applies the lifecycle policy of the source backup to the destination backup.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about an array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.\n

" + } + }, + "com.amazonaws.securityhub#AwsBackupBackupPlanRuleList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsBackupBackupPlanRuleDetails" + } + }, + "com.amazonaws.securityhub#AwsBackupBackupVaultDetails": { + "type": "structure", + "members": { + "BackupVaultArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup vault.\n

" + } + }, + "BackupVaultName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the \nAmazon Web Services account used to create them and the Amazon Web Services Region where they are created. \nThey consist of lowercase letters, numbers, and hyphens.\n

" + } + }, + "EncryptionKeyArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The unique ARN associated with the server-side encryption key. You can specify a key to encrypt your backups from services that support \nfull Backup management. If you do not specify a key, Backup creates an KMS key for you by default.\n

" + } + }, + "Notifications": { + "target": "com.amazonaws.securityhub#AwsBackupBackupVaultNotificationsDetails", + "traits": { + "smithy.api#documentation": "

The Amazon SNS event notifications for the specified backup vault.\n

" + } + }, + "AccessPolicy": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A resource-based policy that is used to manage access permissions on the target backup vault.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about an Backup backup vault. In Backup, a backup vault is \na container that stores and organizes your backups.\n

" + } + }, + "com.amazonaws.securityhub#AwsBackupBackupVaultNotificationsDetails": { + "type": "structure", + "members": { + "BackupVaultEvents": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

An array of events that indicate the status of jobs to back up resources to the backup vault. \nThe following events are supported:

\n " + } + }, + "SnsTopicArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the Amazon SNS topic for\n a backup vault's events.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about the Amazon SNS event notifications for the specified backup vault.\n

" + } + }, + "com.amazonaws.securityhub#AwsBackupRecoveryPointCalculatedLifecycleDetails": { + "type": "structure", + "members": { + "DeleteAt": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Specifies the number of days after creation that a recovery point is deleted. Must be greater \nthan 90 days plus MoveToColdStorageAfterDays.\n

" + } + }, + "MoveToColdStorageAt": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Specifies the number of days after creation that a recovery point is moved to cold storage.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies how long in days before a recovery point transitions to cold storage or is deleted.\n

" + } + }, + "com.amazonaws.securityhub#AwsBackupRecoveryPointCreatedByDetails": { + "type": "structure", + "members": { + "BackupPlanArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup plan.\n

" + } + }, + "BackupPlanId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Uniquely identifies a backup plan.\n

" + } + }, + "BackupPlanVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most \n1,024 bytes long. Version IDs cannot be edited.\n

" + } + }, + "BackupRuleId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Uniquely identifies a rule used to schedule the backup of a selection of resources.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the backup plan and rule that Backup used to initiate the recovery point backup.\n

" + } + }, + "com.amazonaws.securityhub#AwsBackupRecoveryPointDetails": { + "type": "structure", + "members": { + "BackupSizeInBytes": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The size, in bytes, of a backup.\n

" + } + }, + "BackupVaultArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup vault.\n

" + } + }, + "BackupVaultName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified by names \nthat are unique to the Amazon Web Services account used to create them and the Amazon Web Services Region \nwhere they are created. They consist of lowercase letters, numbers, and hyphens.\n

" + } + }, + "CalculatedLifecycle": { + "target": "com.amazonaws.securityhub#AwsBackupRecoveryPointCalculatedLifecycleDetails", + "traits": { + "smithy.api#documentation": "

A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.\n

" + } + }, + "CompletionDate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The date and time that a job to create a recovery point is completed, in Unix format and UTC. \nThe value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 \nrepresents Friday, January 26, 2018 12:11:30.087 AM.\n

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.securityhub#AwsBackupRecoveryPointCreatedByDetails", + "traits": { + "smithy.api#documentation": "

Contains identifying information about the creation of a recovery point, including the \nBackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId \nof the backup plan that is used to create it.\n

" + } + }, + "CreationDate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The date and time a recovery point is created, in Unix format and UTC. The value of CreationDate \nis accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.\n

" + } + }, + "EncryptionKeyArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN for the server-side encryption key that is used to protect your backups.\n

" + } + }, + "IamRoleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Specifies the IAM role ARN used to create the target recovery point\n

" + } + }, + "IsEncrypted": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean value that is returned as TRUE if the specified recovery point is \nencrypted, or FALSE if the recovery point is not encrypted.\n

" + } + }, + "LastRestoreTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The date and time that a recovery point was last restored, in Unix format and UTC. The value of \nLastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087 represents \nFriday, January 26, 2018 12:11:30.087 AM.\n

" + } + }, + "Lifecycle": { + "target": "com.amazonaws.securityhub#AwsBackupRecoveryPointLifecycleDetails", + "traits": { + "smithy.api#documentation": "

The lifecycle defines when a protected resource is transitioned to cold storage and when it \nexpires. Backup transitions and expires backups automatically according to the lifecycle that \nyou define\n

" + } + }, + "RecoveryPointArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

An ARN that uniquely identifies a recovery point.\n

" + } + }, + "ResourceArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.\n

" + } + }, + "ResourceType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of Amazon Web Services resource saved as a recovery point, such as an Amazon EBS volume or an Amazon RDS database.\n

" + } + }, + "SourceBackupVaultArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN for the backup vault where the recovery point was originally copied from. If the recovery \npoint is restored to the same account, this value will be null.\n

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A status code specifying the state of the recovery point. Valid values are as follows:

\n " + } + }, + "StatusMessage": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A message explaining the reason of the recovery point deletion failure.\n

" + } + }, + "StorageClass": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Specifies the storage class of the recovery point. Valid values are as follows:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains detailed information about the recovery points stored in an Backup backup vault. \nA backup, or recovery point, represents the content of a resource at a specified time.\n

" + } + }, + "com.amazonaws.securityhub#AwsBackupRecoveryPointLifecycleDetails": { + "type": "structure", + "members": { + "DeleteAfterDays": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Specifies the number of days after creation that a recovery point is deleted. Must be greater \nthan 90 days plus MoveToColdStorageAfterDays.\n

" + } + }, + "MoveToColdStorageAfterDays": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Specifies the number of days after creation that a recovery point is moved to cold storage.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains an array of Transition objects specifying how long in days before a recovery point transitions to cold storage or is deleted.\n

" + } + }, + "com.amazonaws.securityhub#AwsCertificateManagerCertificateDetails": { + "type": "structure", + "members": { + "CertificateAuthorityArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the private certificate authority (CA) that will be used to issue the\n certificate.

" + } + }, + "CreatedAt": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the certificate was requested.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "DomainName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The fully qualified domain name (FQDN), such as www.example.com, that is secured by the\n certificate.

" + } + }, + "DomainValidationOptions": { + "target": "com.amazonaws.securityhub#AwsCertificateManagerCertificateDomainValidationOptions", + "traits": { + "smithy.api#documentation": "

Contains information about the initial validation of each domain name that occurs as a\n result of the RequestCertificate request.

\n

Only provided if the certificate type is AMAZON_ISSUED.

" + } + }, + "ExtendedKeyUsages": { + "target": "com.amazonaws.securityhub#AwsCertificateManagerCertificateExtendedKeyUsages", + "traits": { + "smithy.api#documentation": "

Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies\n a purpose for which the certificate public key can be used and consists of a name and an\n object identifier (OID).

" + } + }, + "FailureReason": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

For a failed certificate request, the reason for the failure.

\n

Valid values: NO_AVAILABLE_CONTACTS |\n ADDITIONAL_VERIFICATION_REQUIRED | DOMAIN_NOT_ALLOWED |\n INVALID_PUBLIC_DOMAIN | DOMAIN_VALIDATION_DENIED |\n CAA_ERROR | PCA_LIMIT_EXCEEDED | PCA_INVALID_ARN\n | PCA_INVALID_STATE | PCA_REQUEST_FAILED |\n PCA_NAME_CONSTRAINTS_VALIDATION | PCA_RESOURCE_NOT_FOUND |\n PCA_INVALID_ARGS | PCA_INVALID_DURATION |\n PCA_ACCESS_DENIED | SLR_NOT_FOUND | OTHER\n

" + } + }, + "ImportedAt": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the certificate was imported. Provided if the certificate type is\n IMPORTED.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "InUseBy": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

The list of ARNs for the Amazon Web Services resources that use the certificate.

" + } + }, + "IssuedAt": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the certificate was issued. Provided if the certificate type is\n AMAZON_ISSUED.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "Issuer": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the certificate authority that issued and signed the certificate.

" + } + }, + "KeyAlgorithm": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The algorithm that was used to generate the public-private key pair.

\n

Valid values: RSA_2048 | RSA_1024 | RSA_4096 |\n EC_prime256v1 | EC_secp384r1 |\n EC_secp521r1\n

" + } + }, + "KeyUsages": { + "target": "com.amazonaws.securityhub#AwsCertificateManagerCertificateKeyUsages", + "traits": { + "smithy.api#documentation": "

A list of key usage X.509 v3 extension objects.

" + } + }, + "NotAfter": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The time after which the certificate becomes invalid.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "NotBefore": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The time before which the certificate is not valid.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "Options": { + "target": "com.amazonaws.securityhub#AwsCertificateManagerCertificateOptions", + "traits": { + "smithy.api#documentation": "

Provides a value that specifies whether to add the certificate to a transparency\n log.

" + } + }, + "RenewalEligibility": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Whether the certificate is eligible for renewal.

\n

Valid values: ELIGIBLE | INELIGIBLE\n

" + } + }, + "RenewalSummary": { + "target": "com.amazonaws.securityhub#AwsCertificateManagerCertificateRenewalSummary", + "traits": { + "smithy.api#documentation": "

Information about the status of the Certificate Manager managed renewal for the\n certificate. Provided only when the certificate type is AMAZON_ISSUED.

" + } + }, + "Serial": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The serial number of the certificate.

" + } + }, + "SignatureAlgorithm": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The algorithm that was used to sign the certificate.

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of the certificate.

\n

Valid values: PENDING_VALIDATION | ISSUED |\n INACTIVE | EXPIRED | VALIDATION_TIMED_OUT |\n REVOKED | FAILED\n

" + } + }, + "Subject": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the entity that is associated with the public key contained in the\n certificate.

" + } + }, + "SubjectAlternativeNames": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

One or more domain names (subject alternative names) included in the certificate. This\n list contains the domain names that are bound to the public key that is contained in the\n certificate.

\n

The subject alternative names include the canonical domain name (CN) of the certificate\n and additional domain names that can be used to connect to the website.

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The source of the certificate. For certificates that Certificate Manager provides,\n Type is AMAZON_ISSUED. For certificates that are imported with\n ImportCertificate, Type is IMPORTED.

\n

Valid values: IMPORTED | AMAZON_ISSUED |\n PRIVATE\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about an Certificate Manager certificate.

" + } + }, + "com.amazonaws.securityhub#AwsCertificateManagerCertificateDomainValidationOption": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A fully qualified domain name (FQDN) in the certificate.

" + } + }, + "ResourceRecord": { + "target": "com.amazonaws.securityhub#AwsCertificateManagerCertificateResourceRecord", + "traits": { + "smithy.api#documentation": "

The CNAME record that is added to the DNS database for domain validation.

" + } + }, + "ValidationDomain": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The domain name that Certificate Manager uses to send domain validation\n emails.

" + } + }, + "ValidationEmails": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

A list of email addresses that Certificate Manager uses to send domain validation\n emails.

" + } + }, + "ValidationMethod": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The method used to validate the domain name.

" + } + }, + "ValidationStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The validation status of the domain name.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about one of the following:

\n " + } + }, + "com.amazonaws.securityhub#AwsCertificateManagerCertificateDomainValidationOptions": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsCertificateManagerCertificateDomainValidationOption" + } + }, + "com.amazonaws.securityhub#AwsCertificateManagerCertificateExtendedKeyUsage": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of an extension value. Indicates the purpose for which the certificate public\n key can be used.

" + } + }, + "OId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

An object identifier (OID) for the extension value.

\n

The format is numbers separated by periods.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an extended key usage X.509 v3 extension object.

" + } + }, + "com.amazonaws.securityhub#AwsCertificateManagerCertificateExtendedKeyUsages": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsCertificateManagerCertificateExtendedKeyUsage" + } + }, + "com.amazonaws.securityhub#AwsCertificateManagerCertificateKeyUsage": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The key usage extension name.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a key usage X.509 v3 extension object.

" + } + }, + "com.amazonaws.securityhub#AwsCertificateManagerCertificateKeyUsages": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsCertificateManagerCertificateKeyUsage" + } + }, + "com.amazonaws.securityhub#AwsCertificateManagerCertificateOptions": { + "type": "structure", + "members": { + "CertificateTransparencyLoggingPreference": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Whether to add the certificate to a transparency log.

\n

Valid values: DISABLED | ENABLED\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains other options for the certificate.

" + } + }, + "com.amazonaws.securityhub#AwsCertificateManagerCertificateRenewalSummary": { + "type": "structure", + "members": { + "DomainValidationOptions": { + "target": "com.amazonaws.securityhub#AwsCertificateManagerCertificateDomainValidationOptions", + "traits": { + "smithy.api#documentation": "

Information about the validation of each domain name in the certificate, as it pertains\n to Certificate Manager managed renewal. Provided only when the certificate type is\n AMAZON_ISSUED.

" + } + }, + "RenewalStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of the Certificate Manager managed renewal of the certificate.

\n

Valid values: PENDING_AUTO_RENEWAL | PENDING_VALIDATION |\n SUCCESS | FAILED\n

" + } + }, + "RenewalStatusReason": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The reason that a renewal request was unsuccessful. This attribute is used only when RenewalStatus is FAILED.

\n

Valid values: NO_AVAILABLE_CONTACTS |\n ADDITIONAL_VERIFICATION_REQUIRED | DOMAIN_NOT_ALLOWED |\n INVALID_PUBLIC_DOMAIN | DOMAIN_VALIDATION_DENIED |\n CAA_ERROR | PCA_LIMIT_EXCEEDED | PCA_INVALID_ARN\n | PCA_INVALID_STATE | PCA_REQUEST_FAILED |\n PCA_NAME_CONSTRAINTS_VALIDATION | PCA_RESOURCE_NOT_FOUND |\n PCA_INVALID_ARGS | PCA_INVALID_DURATION |\n PCA_ACCESS_DENIED | SLR_NOT_FOUND | OTHER\n

" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the renewal summary was last updated.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the Certificate Manager managed renewal for an\n AMAZON_ISSUED certificate.

" + } + }, + "com.amazonaws.securityhub#AwsCertificateManagerCertificateResourceRecord": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the resource.

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of resource.

" + } + }, + "Value": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The value of the resource.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about the CNAME record that is added to the DNS database for domain\n validation.

" + } + }, + "com.amazonaws.securityhub#AwsCloudFormationStackDetails": { + "type": "structure", + "members": { + "Capabilities": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The capabilities allowed in the stack.\n

" + } + }, + "CreationTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The time at which the stack was created.

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A user-defined description associated with the stack.\n

" + } + }, + "DisableRollback": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Boolean to enable or disable rollback on stack creation failures. \n

" + } + }, + "DriftInformation": { + "target": "com.amazonaws.securityhub#AwsCloudFormationStackDriftInformationDetails", + "traits": { + "smithy.api#documentation": "

Information about whether a stack's actual configuration differs, or has drifted, from its expected \nconfiguration, as defined in the stack template and any values specified as template parameters. \n

" + } + }, + "EnableTerminationProtection": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether termination protection is enabled for the stack.\n

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The time the nested stack was last updated. This field will only be returned if the stack has been \nupdated at least once.

" + } + }, + "NotificationArns": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the Amazon SNS topic to which stack-related events are published.\n

" + } + }, + "Outputs": { + "target": "com.amazonaws.securityhub#AwsCloudFormationStackOutputsList", + "traits": { + "smithy.api#documentation": "

A list of output structures.\n

" + } + }, + "RoleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of an IAM role that's associated with the stack. \n

" + } + }, + "StackId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Unique identifier of the stack.\n

" + } + }, + "StackName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name associated with the stack.\n

" + } + }, + "StackStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Current status of the stack.\n

" + } + }, + "StackStatusReason": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Success or failure message associated with the stack status.\n

" + } + }, + "TimeoutInMinutes": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The length of time, in minutes, that CloudFormation waits for the nested stack to reach \nthe CREATE_COMPLETE state.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Nests a stack as a resource in a top-level template. Nested stacks are stacks created as resources for \nanother stack.

" + } + }, + "com.amazonaws.securityhub#AwsCloudFormationStackDriftInformationDetails": { + "type": "structure", + "members": { + "StackDriftStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Status of the stack's actual configuration compared to its expected template configuration.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the stack's conformity to its expected template configuration.\n

" + } + }, + "com.amazonaws.securityhub#AwsCloudFormationStackOutputsDetails": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A user-defined description associated with the output.\n

" + } + }, + "OutputKey": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The key associated with the output.\n

" + } + }, + "OutputValue": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The value associated with the output.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the CloudFormation stack output.\n

" + } + }, + "com.amazonaws.securityhub#AwsCloudFormationStackOutputsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsCloudFormationStackOutputsDetails" + } + }, + "com.amazonaws.securityhub#AwsCloudFrontDistributionCacheBehavior": { + "type": "structure", + "members": { + "ViewerProtocolPolicy": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The protocol that viewers can use to access the files in an origin. You can specify the\n following options:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a cache behavior for the distribution.

" + } + }, + "com.amazonaws.securityhub#AwsCloudFrontDistributionCacheBehaviors": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionCacheBehaviorsItemList", + "traits": { + "smithy.api#documentation": "

The cache behaviors for the distribution.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about caching for the CloudFront distribution.

" + } + }, + "com.amazonaws.securityhub#AwsCloudFrontDistributionCacheBehaviorsItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionCacheBehavior" + } + }, + "com.amazonaws.securityhub#AwsCloudFrontDistributionDefaultCacheBehavior": { + "type": "structure", + "members": { + "ViewerProtocolPolicy": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The protocol that viewers can use to access the files in an origin. You can specify the\n following options:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the default cache configuration for the CloudFront distribution.

" + } + }, + "com.amazonaws.securityhub#AwsCloudFrontDistributionDetails": { + "type": "structure", + "members": { + "CacheBehaviors": { + "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionCacheBehaviors", + "traits": { + "smithy.api#documentation": "

Provides information about the cache configuration for the distribution.

" + } + }, + "DefaultCacheBehavior": { + "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionDefaultCacheBehavior", + "traits": { + "smithy.api#documentation": "

The default cache behavior for the configuration.

" + } + }, + "DefaultRootObject": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The object that CloudFront sends in response to requests from the origin (for example,\n index.html) when a viewer requests the root URL for the distribution\n (http://www.example.com) instead of an object in your distribution\n (http://www.example.com/product-description.html).

" + } + }, + "DomainName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The domain name corresponding to the distribution.

" + } + }, + "ETag": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The entity tag is a hash of the object.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when that the distribution was last modified.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "Logging": { + "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionLogging", + "traits": { + "smithy.api#documentation": "

A complex type that controls whether access logs are written for the distribution.

" + } + }, + "Origins": { + "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOrigins", + "traits": { + "smithy.api#documentation": "

A complex type that contains information about origins for this distribution.

" + } + }, + "OriginGroups": { + "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroups", + "traits": { + "smithy.api#documentation": "

Provides information about the origin groups in the distribution.

" + } + }, + "ViewerCertificate": { + "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionViewerCertificate", + "traits": { + "smithy.api#documentation": "

Provides information about the TLS/SSL configuration that the distribution uses to communicate with viewers.

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates the current status of the distribution.

" + } + }, + "WebAclId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A CloudFront distribution configuration.

" + } + }, + "com.amazonaws.securityhub#AwsCloudFrontDistributionLogging": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The S3 bucket to store the access logs in.

" + } + }, + "Enabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

With this field, you can enable or disable the selected distribution.

" + } + }, + "IncludeCookies": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether you want CloudFront to include cookies in access logs.

" + } + }, + "Prefix": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

An optional string that you want CloudFront to use as a prefix to the access log\n filenames for this distribution.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that controls whether access logs are written for the CloudFront distribution.

" + } + }, + "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginCustomOriginConfig": { + "type": "structure", + "members": { + "HttpPort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP port that CloudFront uses to connect to the origin.\n

" + } + }, + "HttpsPort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTPS port that CloudFront uses to connect to the origin.\n

" + } + }, + "OriginKeepaliveTimeout": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Specifies how long, in seconds, CloudFront persists its connection to the origin.\n

" + } + }, + "OriginProtocolPolicy": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. \n

" + } + }, + "OriginReadTimeout": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Specifies how long, in seconds, CloudFront waits for a response from the origin.\n

" + } + }, + "OriginSslProtocols": { + "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginSslProtocols", + "traits": { + "smithy.api#documentation": "

Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A custom origin. A custom origin is any origin that is not an Amazon S3 bucket, with one exception. An Amazon S3 bucket that is configured with\n static website hosting is a custom origin.

" + } + }, + "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroup": { + "type": "structure", + "members": { + "FailoverCriteria": { + "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroupFailover", + "traits": { + "smithy.api#documentation": "

Provides the criteria for an origin group to fail over.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an origin group for the CloudFront distribution.

" + } + }, + "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroupFailover": { + "type": "structure", + "members": { + "StatusCodes": { + "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroupFailoverStatusCodes", + "traits": { + "smithy.api#documentation": "

Information about the status codes that cause an origin group to fail over.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about when an origin group fails over.

" + } + }, + "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroupFailoverStatusCodes": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroupFailoverStatusCodesItemList", + "traits": { + "smithy.api#documentation": "

The list of status code values that can cause a failover to the next origin.

" + } + }, + "Quantity": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of status codes that can cause a failover.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The status codes that cause an origin group to fail over.

" + } + }, + "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroupFailoverStatusCodesItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#Integer" + } + }, + "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroups": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroupsItemList", + "traits": { + "smithy.api#documentation": "

The list of origin groups.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about origin groups that are associated with the CloudFront distribution.

" + } + }, + "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroupsItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroup" + } + }, + "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginItem": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Amazon S3 origins: The DNS name of the S3 bucket from which you want\n CloudFront to get objects for this origin.

" + } + }, + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A unique identifier for the origin or origin group.

" + } + }, + "OriginPath": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

An optional element that causes CloudFront to request your content from a\n directory in your Amazon S3 bucket or your custom origin.

" + } + }, + "S3OriginConfig": { + "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginS3OriginConfig", + "traits": { + "smithy.api#documentation": "

An origin that is an S3 bucket that is not configured with static website\n hosting.

" + } + }, + "CustomOriginConfig": { + "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginCustomOriginConfig", + "traits": { + "smithy.api#documentation": "

An origin that is not an Amazon S3 bucket, with one exception. \nIf the Amazon S3 bucket is configured with static website hosting, use this attribute. \nIf the Amazon S3 bucket is not configured with static website hosting, use the S3OriginConfig type instead.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that describes the\n Amazon S3 bucket, HTTP server (for example, a web server), AWS Elemental MediaStore, or other server from which CloudFront gets your files.

" + } + }, + "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginItem" + } + }, + "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginS3OriginConfig": { + "type": "structure", + "members": { + "OriginAccessIdentity": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The CloudFront origin access identity to associate with the origin.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an origin that is an Amazon S3 bucket that is not configured with static website\n hosting.

" + } + }, + "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginSslProtocols": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

A list that contains allowed SSL/TLS protocols for this distribution.\n

" + } + }, + "Quantity": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing \nan HTTPS connection with this origin.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the SSL/TLS protocols that CloudFront can use \nwhen establishing an HTTPS connection with your origin.\n

" + } + }, + "com.amazonaws.securityhub#AwsCloudFrontDistributionOrigins": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginItemList", + "traits": { + "smithy.api#documentation": "

A complex type that contains origins or origin groups for this distribution.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains information about origins and origin groups for this CloudFront distribution.

" + } + }, + "com.amazonaws.securityhub#AwsCloudFrontDistributionViewerCertificate": { + "type": "structure", + "members": { + "AcmCertificateArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the ACM certificate. Used if the certificate is stored in ACM. If you provide an ACM certificate ARN, you must also provide MinimumCertificateVersion and SslSupportMethod.

" + } + }, + "Certificate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the certificate. Note that in CloudFront, this attribute is deprecated.

" + } + }, + "CertificateSource": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The source of the certificate identified by Certificate. Note that in CloudFront, this attribute is deprecated.

" + } + }, + "CloudFrontDefaultCertificate": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the distribution uses the CloudFront domain name. If set to false, then you provide either AcmCertificateArn or IamCertificateId.

" + } + }, + "IamCertificateId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the IAM certificate. Used if the certificate is stored in IAM. If you provide IamCertificateId, then you also must provide MinimumProtocolVersion and SslSupportMethod.

" + } + }, + "MinimumProtocolVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The security policy that CloudFront uses for HTTPS connections with viewers. If SslSupportMethod is sni-only, then MinimumProtocolVersion must be TLSv1 or higher.

" + } + }, + "SslSupportMethod": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The viewers that the distribution accepts HTTPS connections from.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the TLS/SSL configuration that the CloudFront distribution uses to communicate with viewers.

" + } + }, + "com.amazonaws.securityhub#AwsCloudTrailTrailDetails": { + "type": "structure", + "members": { + "CloudWatchLogsLogGroupArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the log group that CloudTrail logs are delivered to.

" + } + }, + "CloudWatchLogsRoleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the role that the CloudWatch Events endpoint assumes when it writes to the log\n group.

" + } + }, + "HasCustomEventSelectors": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the trail has custom event selectors.

" + } + }, + "HomeRegion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Region where the trail was created.

" + } + }, + "IncludeGlobalServiceEvents": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the trail publishes events from global services such as IAM to the log\n files.

" + } + }, + "IsMultiRegionTrail": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the trail applies only to the current Region or to all Regions.

" + } + }, + "IsOrganizationTrail": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the trail is created for all accounts in an organization in Organizations,\n or only for the current Amazon Web Services account.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The KMS key ID to use to encrypt the logs.

" + } + }, + "LogFileValidationEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether CloudTrail log file validation is enabled.

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the trail.

" + } + }, + "S3BucketName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the S3 bucket where the log files are published.

" + } + }, + "S3KeyPrefix": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The S3 key prefix. The key prefix is added after the name of the S3 bucket where the log\n files are published.

" + } + }, + "SnsTopicArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the SNS topic that is used for notifications of log file delivery.

" + } + }, + "SnsTopicName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the SNS topic that is used for notifications of log file delivery.

" + } + }, + "TrailArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the trail.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about a CloudTrail trail.

" + } + }, + "com.amazonaws.securityhub#AwsCloudWatchAlarmDetails": { + "type": "structure", + "members": { + "ActionsEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether actions should be executed during any changes to the alarm state. \n

" + } + }, + "AlarmActions": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The list of actions, specified as Amazon Resource Names (ARNs) to execute when this alarm transitions into an ALARM state from any other\n state.

" + } + }, + "AlarmArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the alarm.\n

" + } + }, + "AlarmConfigurationUpdatedTimestamp": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The time stamp of the last update to the alarm configuration.\n

" + } + }, + "AlarmDescription": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description of the alarm.\n

" + } + }, + "AlarmName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the alarm. If you don't specify a name, CloudFront generates a unique physical ID \nand uses that ID for the alarm name. \n

" + } + }, + "ComparisonOperator": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The arithmetic operation to use when comparing the specified statistic and threshold. The specified \nstatistic value is used as the first operand.\n

" + } + }, + "DatapointsToAlarm": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of datapoints that must be breaching to trigger the alarm. \n

" + } + }, + "Dimensions": { + "target": "com.amazonaws.securityhub#AwsCloudWatchAlarmDimensionsList", + "traits": { + "smithy.api#documentation": "

The dimensions for the metric associated with the alarm. \n

" + } + }, + "EvaluateLowSampleCountPercentile": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Used only for alarms based on percentiles. If ignore, the alarm state does not change during \nperiods with too few data points to be statistically significant. If evaluate or this parameter is not used, \nthe alarm is always evaluated and possibly changes state no matter how many data points are available.\n

" + } + }, + "EvaluationPeriods": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of periods over which data is compared to the specified threshold.\n

" + } + }, + "ExtendedStatistic": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The percentile statistic for the metric associated with the alarm. \n

" + } + }, + "InsufficientDataActions": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from \nany other state. Each action is specified as an ARN.\n

" + } + }, + "MetricName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the metric associated with the alarm. This is required for an alarm based on a metric. \nFor an alarm based on a math expression, you use Metrics instead and you can't specify MetricName.\n

" + } + }, + "Namespace": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The namespace of the metric associated with the alarm. This is required for an alarm based on a \nmetric. For an alarm based on a math expression, you can't specify Namespace and you use \nMetrics instead.\n

" + } + }, + "OkActions": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The actions to execute when this alarm transitions to the OK state from any other state. \nEach action is specified as an ARN.\n

" + } + }, + "Period": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The period, in seconds, over which the statistic is applied. This is required for an alarm based on a \nmetric.\n

" + } + }, + "Statistic": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.

\n

For an alarm based on a metric, you must specify either Statistic or ExtendedStatistic but not both.

\n

For an alarm based on a math expression, you can't specify Statistic. Instead, you use Metrics.

" + } + }, + "Threshold": { + "target": "com.amazonaws.securityhub#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The value to compare with the specified statistic.\n

" + } + }, + "ThresholdMetricId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

n 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.\n

" + } + }, + "TreatMissingData": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Sets how this alarm is to handle missing data points. \n

" + } + }, + "Unit": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The unit of the metric associated with the alarm.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies an alarm and associates it with the specified metric or metric math expression.\n

" + } + }, + "com.amazonaws.securityhub#AwsCloudWatchAlarmDimensionsDetails": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of a dimension.\n

" + } + }, + "Value": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The value of a dimension.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the dimensions for the metric associated with the alarm.\n

" + } + }, + "com.amazonaws.securityhub#AwsCloudWatchAlarmDimensionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsCloudWatchAlarmDimensionsDetails" + } + }, + "com.amazonaws.securityhub#AwsCodeBuildProjectArtifactsDetails": { + "type": "structure", + "members": { + "ArtifactIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

An identifier for the artifact definition.

" + } + }, + "EncryptionDisabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to disable encryption on the artifact. Only valid when Type is S3.

" + } + }, + "Location": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Only used when Type is S3. The name of the S3 bucket where the artifact is located.

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Only used when Type is S3. The name of the artifact. Used with NamepaceType and Path to determine the pattern for storing the artifact.

" + } + }, + "NamespaceType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Only used when Type is S3. The value to use for the namespace. Used with Name and Path to determine the pattern for storing the artifact.

" + } + }, + "OverrideArtifactName": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the name specified in the buildspec file overrides the artifact name.

" + } + }, + "Packaging": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Only used when Type is S3. The type of output artifact to create.

" + } + }, + "Path": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Only used when Type is S3. The path to the artifact. Used with Name and NamespaceType to determine the pattern for storing the artifact.

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of build artifact.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the build artifacts for the CodeBuild project.

" + } + }, + "com.amazonaws.securityhub#AwsCodeBuildProjectArtifactsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsCodeBuildProjectArtifactsDetails" + } + }, + "com.amazonaws.securityhub#AwsCodeBuildProjectDetails": { + "type": "structure", + "members": { + "EncryptionKey": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The KMS key used to encrypt the\n build output artifacts.

\n

You can specify either the ARN of the KMS key or, if available, the\n KMS key alias (using the format alias/alias-name).

" + } + }, + "Artifacts": { + "target": "com.amazonaws.securityhub#AwsCodeBuildProjectArtifactsList", + "traits": { + "smithy.api#documentation": "

Information about the build artifacts for the CodeBuild project.

" + } + }, + "Environment": { + "target": "com.amazonaws.securityhub#AwsCodeBuildProjectEnvironment", + "traits": { + "smithy.api#documentation": "

Information about the build environment for this build project.

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the build project.

" + } + }, + "Source": { + "target": "com.amazonaws.securityhub#AwsCodeBuildProjectSource", + "traits": { + "smithy.api#documentation": "

Information about the build input source code for this build project.

" + } + }, + "ServiceRole": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services\n services on behalf of the Amazon Web Services account.

" + } + }, + "LogsConfig": { + "target": "com.amazonaws.securityhub#AwsCodeBuildProjectLogsConfigDetails", + "traits": { + "smithy.api#documentation": "

Information about logs for the build project.

" + } + }, + "VpcConfig": { + "target": "com.amazonaws.securityhub#AwsCodeBuildProjectVpcConfig", + "traits": { + "smithy.api#documentation": "

Information about the VPC configuration that CodeBuild accesses.

" + } + }, + "SecondaryArtifacts": { + "target": "com.amazonaws.securityhub#AwsCodeBuildProjectArtifactsList", + "traits": { + "smithy.api#documentation": "

Information about the secondary artifacts for the CodeBuild project.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an CodeBuild project.

" + } + }, + "com.amazonaws.securityhub#AwsCodeBuildProjectEnvironment": { + "type": "structure", + "members": { + "Certificate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The certificate to use with this build project.

" + } + }, + "EnvironmentVariables": { + "target": "com.amazonaws.securityhub#AwsCodeBuildProjectEnvironmentEnvironmentVariablesList", + "traits": { + "smithy.api#documentation": "

A set of environment variables to make available to builds for the build project.

" + } + }, + "PrivilegedMode": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether to allow the Docker daemon to run inside a Docker container. Set to true if the build project is used to build Docker images.

" + } + }, + "ImagePullCredentialsType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of credentials CodeBuild uses to pull images in your build.

\n

Valid values:

\n \n

When you use a cross-account or private registry image, you must use\n SERVICE_ROLE credentials. When you use an CodeBuild curated image, you\n must use CODEBUILD credentials.

" + } + }, + "RegistryCredential": { + "target": "com.amazonaws.securityhub#AwsCodeBuildProjectEnvironmentRegistryCredential", + "traits": { + "smithy.api#documentation": "

The credentials for access to a private registry.

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of build environment to use for related builds.

\n

The environment type ARM_CONTAINER is available only in Regions US East (N.\n Virginia), US East (Ohio), US West (Oregon), Europe (Ireland), Asia Pacific (Mumbai), Asia\n Pacific (Tokyo), Asia Pacific (Sydney), and Europe (Frankfurt).

\n

The environment type LINUX_CONTAINER with compute type\n build.general1.2xlarge is available only in Regions US East (N. Virginia), US East (N.\n Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe\n (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia\n Pacific (Sydney), China (Beijing), and China (Ningxia).

\n

The environment type LINUX_GPU_CONTAINER is available only in Regions US\n East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), Europe\n (Ireland), Europe (London), Europe (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul),\n Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China\n (Ningxia).

\n

Valid values: WINDOWS_CONTAINER | LINUX_CONTAINER |\n LINUX_GPU_CONTAINER | ARM_CONTAINER\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the build environment for this build project.

" + } + }, + "com.amazonaws.securityhub#AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the environment variable.

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of environment variable.

" + } + }, + "Value": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The value of the environment variable.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an environment variable that is available to builds for the build project.

" + } + }, + "com.amazonaws.securityhub#AwsCodeBuildProjectEnvironmentEnvironmentVariablesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails" + } + }, + "com.amazonaws.securityhub#AwsCodeBuildProjectEnvironmentRegistryCredential": { + "type": "structure", + "members": { + "Credential": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN or name of credentials created using Secrets Manager.

\n \n

The credential can use the name of the credentials only if they exist in your current\n Amazon Web Services Region.

\n " + } + }, + "CredentialProvider": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The service that created the credentials to access a private Docker registry.

\n

The valid value, SECRETS_MANAGER, is for Secrets Manager.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The credentials for access to a private registry.

" + } + }, + "com.amazonaws.securityhub#AwsCodeBuildProjectLogsConfigCloudWatchLogsDetails": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The group name of the logs in CloudWatch Logs.

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The current status of the logs in CloudWatch Logs for a build project.

" + } + }, + "StreamName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The prefix of the stream name of the CloudWatch Logs.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about CloudWatch Logs for the build project.

" + } + }, + "com.amazonaws.securityhub#AwsCodeBuildProjectLogsConfigDetails": { + "type": "structure", + "members": { + "CloudWatchLogs": { + "target": "com.amazonaws.securityhub#AwsCodeBuildProjectLogsConfigCloudWatchLogsDetails", + "traits": { + "smithy.api#documentation": "

Information about CloudWatch Logs for the build project.

" + } + }, + "S3Logs": { + "target": "com.amazonaws.securityhub#AwsCodeBuildProjectLogsConfigS3LogsDetails", + "traits": { + "smithy.api#documentation": "

Information about logs built to an S3 bucket for a build project.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about logs for the build project.

" + } + }, + "com.amazonaws.securityhub#AwsCodeBuildProjectLogsConfigS3LogsDetails": { + "type": "structure", + "members": { + "EncryptionDisabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether to disable encryption of the S3 build log output.

" + } + }, + "Location": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the S3 bucket and the path prefix for S3 logs.

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The current status of the S3 build logs.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about logs built to an S3 bucket for a build project.

" + } + }, + "com.amazonaws.securityhub#AwsCodeBuildProjectSource": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of repository that contains the source code to be built. Valid values\n are:

\n " + } + }, + "Location": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Information about the location of the source code to be built.

\n

Valid values include:

\n " + } + }, + "GitCloneDepth": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Information about the Git clone depth for the build project.

" + } + }, + "InsecureSsl": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether to ignore SSL warnings while connecting to the project source code.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the build input source code for this build project.

" + } + }, + "com.amazonaws.securityhub#AwsCodeBuildProjectVpcConfig": { + "type": "structure", + "members": { + "VpcId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the VPC.

" + } + }, + "Subnets": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

A list of one or more subnet IDs in your VPC.

" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

A list of one or more security group IDs in your VPC.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the VPC configuration that CodeBuild accesses.

" + } + }, + "com.amazonaws.securityhub#AwsCorsConfiguration": { + "type": "structure", + "members": { + "AllowOrigins": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The allowed origins for CORS requests.

" + } + }, + "AllowCredentials": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the CORS request includes credentials.

" + } + }, + "ExposeHeaders": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The exposed headers for CORS requests.

" + } + }, + "MaxAge": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of seconds for which the browser caches preflight request results.

" + } + }, + "AllowMethods": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The allowed methods for CORS requests.

" + } + }, + "AllowHeaders": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The allowed headers for CORS requests.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the cross-origin resource sharing (CORS) configuration for the API. CORS is\n only supported for HTTP APIs.

" + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableAttributeDefinition": { + "type": "structure", + "members": { + "AttributeName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the attribute.

" + } + }, + "AttributeType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of the attribute.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains a definition of an attribute for the table.

" + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableAttributeDefinitionList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableAttributeDefinition" + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableBillingModeSummary": { + "type": "structure", + "members": { + "BillingMode": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The method used to charge for read and write throughput and to manage capacity.

" + } + }, + "LastUpdateToPayPerRequestDateTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

If the billing mode is PAY_PER_REQUEST, indicates when the billing mode was\n set to that value.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the billing for read/write capacity on the table.

" + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableDetails": { + "type": "structure", + "members": { + "AttributeDefinitions": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableAttributeDefinitionList", + "traits": { + "smithy.api#documentation": "

A list of attribute definitions for the table.

" + } + }, + "BillingModeSummary": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableBillingModeSummary", + "traits": { + "smithy.api#documentation": "

Information about the billing for read/write capacity on the table.

" + } + }, + "CreationDateTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the table was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "GlobalSecondaryIndexes": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableGlobalSecondaryIndexList", + "traits": { + "smithy.api#documentation": "

List of global secondary indexes for the table.

" + } + }, + "GlobalTableVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The version of global tables being used.

" + } + }, + "ItemCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of items in the table.

" + } + }, + "KeySchema": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableKeySchemaList", + "traits": { + "smithy.api#documentation": "

The primary key structure for the table.

" + } + }, + "LatestStreamArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the latest stream for the table.

" + } + }, + "LatestStreamLabel": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The label of the latest stream. The label is not a unique identifier.

" + } + }, + "LocalSecondaryIndexes": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableLocalSecondaryIndexList", + "traits": { + "smithy.api#documentation": "

The list of local secondary indexes for the table.

" + } + }, + "ProvisionedThroughput": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableProvisionedThroughput", + "traits": { + "smithy.api#documentation": "

Information about the provisioned throughput for the table.

" + } + }, + "Replicas": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableReplicaList", + "traits": { + "smithy.api#documentation": "

The list of replicas of this table.

" + } + }, + "RestoreSummary": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableRestoreSummary", + "traits": { + "smithy.api#documentation": "

Information about the restore for the table.

" + } + }, + "SseDescription": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableSseDescription", + "traits": { + "smithy.api#documentation": "

Information about the server-side encryption for the table.

" + } + }, + "StreamSpecification": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableStreamSpecification", + "traits": { + "smithy.api#documentation": "

The current DynamoDB Streams configuration for the table.

" + } + }, + "TableId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the table.

" + } + }, + "TableName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the table.

" + } + }, + "TableSizeBytes": { + "target": "com.amazonaws.securityhub#SizeBytes", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total size of the table in bytes.

" + } + }, + "TableStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The current status of the table. Valid values are as follows:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about a DynamoDB table.

" + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableGlobalSecondaryIndex": { + "type": "structure", + "members": { + "Backfilling": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the index is currently backfilling.

" + } + }, + "IndexArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the index.

" + } + }, + "IndexName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the index.

" + } + }, + "IndexSizeBytes": { + "target": "com.amazonaws.securityhub#SizeBytes", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total size in bytes of the index.

" + } + }, + "IndexStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The current status of the index.

\n " + } + }, + "ItemCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of items in the index.

" + } + }, + "KeySchema": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableKeySchemaList", + "traits": { + "smithy.api#documentation": "

The key schema for the index.

" + } + }, + "Projection": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableProjection", + "traits": { + "smithy.api#documentation": "

Attributes that are copied from the table into an index.

" + } + }, + "ProvisionedThroughput": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableProvisionedThroughput", + "traits": { + "smithy.api#documentation": "

Information about the provisioned throughput settings for the indexes.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information abut a global secondary index for the table.

" + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableGlobalSecondaryIndexList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableGlobalSecondaryIndex" + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableKeySchema": { + "type": "structure", + "members": { + "AttributeName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the key schema attribute.

" + } + }, + "KeyType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of key used for the key schema attribute. Valid values are HASH or RANGE.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A component of the key schema for the DynamoDB table, a global secondary index, or a\n local secondary index.

" + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableKeySchemaList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableKeySchema" + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableLocalSecondaryIndex": { + "type": "structure", + "members": { + "IndexArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the index.

" + } + }, + "IndexName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the index.

" + } + }, + "KeySchema": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableKeySchemaList", + "traits": { + "smithy.api#documentation": "

The complete key schema for the index.

" + } + }, + "Projection": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableProjection", + "traits": { + "smithy.api#documentation": "

Attributes that are copied from the table into the index. These are in addition to the\n primary key attributes and index key attributes, which are automatically projected.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a local secondary index for a DynamoDB table.

" + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableLocalSecondaryIndexList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableLocalSecondaryIndex" + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableProjection": { + "type": "structure", + "members": { + "NonKeyAttributes": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

The nonkey attributes that are projected into the index. For each attribute, provide the\n attribute name.

" + } + }, + "ProjectionType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The types of attributes that are projected into the index. Valid values are as follows:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

For global and local secondary indexes, identifies the attributes that are copied from\n the table into the index.

" + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableProvisionedThroughput": { + "type": "structure", + "members": { + "LastDecreaseDateTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the provisioned throughput was last decreased.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "LastIncreaseDateTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the provisioned throughput was last increased.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "NumberOfDecreasesToday": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of times during the current UTC calendar day that the provisioned throughput\n was decreased.

" + } + }, + "ReadCapacityUnits": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of strongly consistent reads consumed per second before DynamoDB\n returns a ThrottlingException.

" + } + }, + "WriteCapacityUnits": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of writes consumed per second before DynamoDB returns a\n ThrottlingException.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the provisioned throughput for the table or for a global secondary\n index.

" + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableProvisionedThroughputOverride": { + "type": "structure", + "members": { + "ReadCapacityUnits": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The read capacity units for the replica.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Replica-specific configuration for the provisioned throughput.

" + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableReplica": { + "type": "structure", + "members": { + "GlobalSecondaryIndexes": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableReplicaGlobalSecondaryIndexList", + "traits": { + "smithy.api#documentation": "

List of global secondary indexes for the replica.

" + } + }, + "KmsMasterKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the KMS key that will be used for KMS\n encryption for the replica.

" + } + }, + "ProvisionedThroughputOverride": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableProvisionedThroughputOverride", + "traits": { + "smithy.api#documentation": "

Replica-specific configuration for the provisioned throughput.

" + } + }, + "RegionName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the Region where the replica is located.

" + } + }, + "ReplicaStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The current status of the replica. Valid values are as follows:

\n " + } + }, + "ReplicaStatusDescription": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Detailed information about the replica status.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a replica of a DynamoDB table.

" + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableReplicaGlobalSecondaryIndex": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the index.

" + } + }, + "ProvisionedThroughputOverride": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableProvisionedThroughputOverride", + "traits": { + "smithy.api#documentation": "

Replica-specific configuration for the provisioned throughput for the index.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a global secondary index for a DynamoDB table replica.

" + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableReplicaGlobalSecondaryIndexList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableReplicaGlobalSecondaryIndex" + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableReplicaList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableReplica" + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableRestoreSummary": { + "type": "structure", + "members": { + "SourceBackupArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the source backup from which the table was restored.

" + } + }, + "SourceTableArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the source table for the backup.

" + } + }, + "RestoreDateTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates the point in time that the table was restored to.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "RestoreInProgress": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether a restore is currently in progress.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the restore for the table.

" + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableSseDescription": { + "type": "structure", + "members": { + "InaccessibleEncryptionDateTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

If the key is inaccessible, the date and time when DynamoDB detected that the key was\n inaccessible.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of the server-side encryption.

" + } + }, + "SseType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of server-side encryption.

" + } + }, + "KmsMasterKeyArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the KMS key that is used for the KMS\n encryption.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the server-side encryption for the table.

" + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableStreamSpecification": { + "type": "structure", + "members": { + "StreamEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether DynamoDB Streams is enabled on the table.

" + } + }, + "StreamViewType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Determines the information that is written to the table.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The current DynamoDB Streams configuration for the table.

" + } + }, + "com.amazonaws.securityhub#AwsEc2EipDetails": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the EC2 instance.

" + } + }, + "PublicIp": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A public IP address that is associated with the EC2 instance.

" + } + }, + "AllocationId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier that Amazon Web Services assigns to represent the allocation of the Elastic IP address\n for use with Amazon VPC.

" + } + }, + "AssociationId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier that represents the association of the Elastic IP address with an EC2\n instance.

" + } + }, + "Domain": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The domain in which to allocate the address.

\n

If the address is for use with EC2 instances in a VPC, then Domain is\n vpc. Otherwise, Domain is standard.

" + } + }, + "PublicIpv4Pool": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of an IP address pool. This parameter allows Amazon EC2 to select an IP\n address from the address pool.

" + } + }, + "NetworkBorderGroup": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the location from which the Elastic IP address is advertised.

" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the network interface.

" + } + }, + "NetworkInterfaceOwnerId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the network interface.

" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The private IP address that is associated with the Elastic IP address.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an Elastic IP address.

" + } + }, + "com.amazonaws.securityhub#AwsEc2InstanceDetails": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The instance type of the instance.

" + } + }, + "ImageId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Machine Image (AMI) ID of the instance.

" + } + }, + "IpV4Addresses": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

The IPv4 addresses associated with the instance.

" + } + }, + "IpV6Addresses": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

The IPv6 addresses associated with the instance.

" + } + }, + "KeyName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The key name associated with the instance.

" + } + }, + "IamInstanceProfileArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The IAM profile ARN of the instance.

" + } + }, + "VpcId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the VPC that the instance was launched in.

" + } + }, + "SubnetId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the subnet that the instance was launched in.

" + } + }, + "LaunchedAt": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the instance was launched.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "NetworkInterfaces": { + "target": "com.amazonaws.securityhub#AwsEc2InstanceNetworkInterfacesList", + "traits": { + "smithy.api#documentation": "

The identifiers of the network interfaces for the EC2 instance. The details for each network interface are in a corresponding AwsEc2NetworkInterfacesDetails object.

" + } + }, + "VirtualizationType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The virtualization type of the Amazon Machine Image (AMI) required to launch the instance.\n

" + } + }, + "MetadataOptions": { + "target": "com.amazonaws.securityhub#AwsEc2InstanceMetadataOptions", + "traits": { + "smithy.api#documentation": "

Details about the metadata options for the Amazon EC2 instance.\n

" + } + }, + "Monitoring": { + "target": "com.amazonaws.securityhub#AwsEc2InstanceMonitoringDetails", + "traits": { + "smithy.api#documentation": "

\n Describes the type of monitoring that’s turned on for an instance.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details of an Amazon EC2 instance.

" + } + }, + "com.amazonaws.securityhub#AwsEc2InstanceMetadataOptions": { + "type": "structure", + "members": { + "HttpEndpoint": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Enables or disables the HTTP metadata endpoint on the instance. \n

" + } + }, + "HttpProtocolIpv6": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Enables or disables the IPv6 endpoint for the instance metadata service.\n

" + } + }, + "HttpPutResponseHopLimit": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. \n The larger the number, the further instance metadata requests can travel.\n

" + } + }, + "HttpTokens": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The state of token usage for your instance metadata requests. \n

" + } + }, + "InstanceMetadataTags": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Specifies whether to allow access to instance tags from the instance metadata.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Metadata options that allow you to configure and secure the Amazon EC2 instance.

" + } + }, + "com.amazonaws.securityhub#AwsEc2InstanceMonitoringDetails": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Indicates whether detailed monitoring is turned on. Otherwise, basic monitoring is turned on.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The type of monitoring that’s turned on for an Amazon EC2 instance.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2InstanceNetworkInterfacesDetails": { + "type": "structure", + "members": { + "NetworkInterfaceId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the network interface. The details are in a corresponding AwsEc2NetworkInterfacesDetails object.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Identifies a network interface for the Amazon EC2 instance.

" + } + }, + "com.amazonaws.securityhub#AwsEc2InstanceNetworkInterfacesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2InstanceNetworkInterfacesDetails" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails": { + "type": "structure", + "members": { + "DeviceName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The device name.\n

" + } + }, + "Ebs": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails", + "traits": { + "smithy.api#documentation": "

\n Parameters used to automatically set up Amazon EBS volumes when the instance is \n launched.\n

" + } + }, + "NoDevice": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Omits the device from the block device mapping when an empty string is specified.\n

" + } + }, + "VirtualName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The virtual device name (ephemeralN). Instance store volumes are numbered starting \n from 0. An instance type with 2 available instance store volumes can specify mappings \n for ephemeral0 and ephemeral1. The number of available instance store volumes depends \n on the instance type.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Information about a block device mapping for an Amazon Elastic Compute Cloud (Amazon EC2) launch template.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails": { + "type": "structure", + "members": { + "DeleteOnTermination": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Indicates whether the EBS volume is deleted on instance termination.\n

" + } + }, + "Encrypted": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Indicates whether the EBS volume is encrypted. Encrypted volumes can only be \n attached to instances that support Amazon EBS encryption. If you're creating a \n volume from a snapshot, you can't specify an encryption value.\n

" + } + }, + "Iops": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The number of I/O operations per second (IOPS). \n

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the symmetric Key Management Service (KMS) customer managed key \n used for encryption.\n

" + } + }, + "SnapshotId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of the EBS snapshot.\n

" + } + }, + "Throughput": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.\n

" + } + }, + "VolumeSize": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. \n

" + } + }, + "VolumeType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The volume type.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Parameters for a block device for an Amazon Elastic Block Store (Amazon EBS) volume in an Amazon EC2 launch template.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataBlockDeviceMappingSetList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataCapacityReservationSpecificationCapacityReservationTargetDetails": { + "type": "structure", + "members": { + "CapacityReservationId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of the Capacity Reservation in which to run the instance.\n

" + } + }, + "CapacityReservationResourceGroupArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the Capacity Reservation resource group in which to run the instance.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Information about the target Capacity Reservation or Capacity Reservation group in which to run an Amazon EC2 instance.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataCapacityReservationSpecificationDetails": { + "type": "structure", + "members": { + "CapacityReservationPreference": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Indicates the instance's Capacity Reservation preferences. If equal to open, the instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). If equal to none, the instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.\n \n

" + } + }, + "CapacityReservationTarget": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataCapacityReservationSpecificationCapacityReservationTargetDetails", + "traits": { + "smithy.api#documentation": "

\n Specifies a target Capacity Reservation.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Specifies the Capacity Reservation targeting option of an Amazon EC2 instance.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataCpuOptionsDetails": { + "type": "structure", + "members": { + "CoreCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The number of CPU cores for the instance.\n

" + } + }, + "ThreadsPerCore": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The number of threads per CPU core. A value of 1 disables multithreading for the instance, \n The default value is 2.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Specifies the CPU options for an Amazon EC2 instance. For more information, see \n Optimize CPU options in the Amazon Elastic Compute Cloud User Guide.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataCreditSpecificationDetails": { + "type": "structure", + "members": { + "CpuCredits": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The credit option for CPU usage of a T instance.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Specifies the credit option for CPU usage of a T2, T3, or T3a Amazon EC2 instance.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataDetails": { + "type": "structure", + "members": { + "BlockDeviceMappingSet": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataBlockDeviceMappingSetList", + "traits": { + "smithy.api#documentation": "

\n Information about a block device mapping for an Amazon EC2 launch template.\n

" + } + }, + "CapacityReservationSpecification": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataCapacityReservationSpecificationDetails", + "traits": { + "smithy.api#documentation": "

\n Specifies an instance's Capacity Reservation targeting option. You can specify only \n one option at a time.\n

" + } + }, + "CpuOptions": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataCpuOptionsDetails", + "traits": { + "smithy.api#documentation": "

\n Specifies the CPU options for an instance. For more information, see \n Optimize CPU options in the Amazon Elastic Compute Cloud User Guide.\n

" + } + }, + "CreditSpecification": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataCreditSpecificationDetails", + "traits": { + "smithy.api#documentation": "

\n Specifies the credit option for CPU usage of a T2, T3, or T3a instance.\n

" + } + }, + "DisableApiStop": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Indicates whether to enable the instance for stop protection. For more information, \n see Enable stop protection in the Amazon EC2 User Guide.\n

" + } + }, + "DisableApiTermination": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API. If set to true, you can. \n

" + } + }, + "EbsOptimized": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Indicates whether the instance is optimized for Amazon EBS I/O. \n

" + } + }, + "ElasticGpuSpecificationSet": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataElasticGpuSpecificationSetList", + "traits": { + "smithy.api#documentation": "

\n Provides details about Elastic Graphics accelerators to associate with the instance.\n

" + } + }, + "ElasticInferenceAcceleratorSet": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetList", + "traits": { + "smithy.api#documentation": "

\n The Amazon Elastic Inference accelerator for the instance.\n

" + } + }, + "EnclaveOptions": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataEnclaveOptionsDetails", + "traits": { + "smithy.api#documentation": "

\n Indicates whether the Amazon EC2 instance is enabled for Amazon Web Services Nitro Enclaves.\n

" + } + }, + "HibernationOptions": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataHibernationOptionsDetails", + "traits": { + "smithy.api#documentation": "

\n Specifies whether your Amazon EC2 instance is configured for hibernation. \n

" + } + }, + "IamInstanceProfile": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataIamInstanceProfileDetails", + "traits": { + "smithy.api#documentation": "

\n The name or Amazon Resource Name (ARN) of an IAM instance profile.\n

" + } + }, + "ImageId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of the Amazon Machine Image (AMI).\n

" + } + }, + "InstanceInitiatedShutdownBehavior": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Provides the options for specifying the instance initiated shutdown behavior.\n

" + } + }, + "InstanceMarketOptions": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceMarketOptionsDetails", + "traits": { + "smithy.api#documentation": "

\n Specifies the market (purchasing) option for an instance.\n

" + } + }, + "InstanceRequirements": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsDetails", + "traits": { + "smithy.api#documentation": "

\n The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance \n types with these attributes. If you specify InstanceRequirements, you can't specify InstanceType.\n

" + } + }, + "InstanceType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The instance type. For more information, see Instance types in the Amazon EC2 User Guide. If you specify InstanceType, you can't \n specify InstanceRequirements.\n

" + } + }, + "KernelId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of the kernel.\n

" + } + }, + "KeyName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The name of the key pair that allows users to connect to the instance.\n

" + } + }, + "LicenseSet": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataLicenseSetList", + "traits": { + "smithy.api#documentation": "

\n Specifies a license configuration for an instance.\n

" + } + }, + "MaintenanceOptions": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataMaintenanceOptionsDetails", + "traits": { + "smithy.api#documentation": "

\n The maintenance options of your instance.\n

" + } + }, + "MetadataOptions": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataMetadataOptionsDetails", + "traits": { + "smithy.api#documentation": "

\n The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon EC2 User Guide.\n

" + } + }, + "Monitoring": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataMonitoringDetails", + "traits": { + "smithy.api#documentation": "

\n The monitoring for the instance.\n

" + } + }, + "NetworkInterfaceSet": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetList", + "traits": { + "smithy.api#documentation": "

\n Specifies the parameters for a network interface that is attached to the instance.\n

" + } + }, + "Placement": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataPlacementDetails", + "traits": { + "smithy.api#documentation": "

\n Specifies the placement of an instance.\n

" + } + }, + "PrivateDnsNameOptions": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataPrivateDnsNameOptionsDetails", + "traits": { + "smithy.api#documentation": "

\n The options for the instance hostname.\n

" + } + }, + "RamDiskId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of the RAM disk.\n

" + } + }, + "SecurityGroupIdSet": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

\n One or more security group IDs.\n

" + } + }, + "SecurityGroupSet": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

\n 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.\n

" + } + }, + "UserData": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The user data to make available to the instance.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The information to include in an Amazon Elastic Compute Cloud (Amazon EC2) launch template.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataElasticGpuSpecificationSetDetails": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The type of Elastic Graphics accelerator. \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides details about an Elastic Graphics specification for an Amazon EC2 launch template.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataElasticGpuSpecificationSetList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataElasticGpuSpecificationSetDetails" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetDetails": { + "type": "structure", + "members": { + "Count": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The number of Elastic Inference accelerators to attach to the instance.\n

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The type of Elastic Inference accelerator.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides details for an Amazon Elastic Inference accelerator.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetDetails" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataEnclaveOptionsDetails": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n If this parameter is set to true, the instance is enabled for Amazon Web Services Nitro Enclaves.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataHibernationOptionsDetails": { + "type": "structure", + "members": { + "Configured": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n If you set this parameter to true, the instance is enabled for hibernation.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Specifies whether your Amazon EC2 instance is configured for hibernation.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataIamInstanceProfileDetails": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the instance profile.\n

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The name of the instance profile.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides details for an Identity and Access Management (IAM) instance profile, which is a container for an IAM role for your instance.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceMarketOptionsDetails": { + "type": "structure", + "members": { + "MarketType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The market type.\n

" + } + }, + "SpotOptions": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails", + "traits": { + "smithy.api#documentation": "

\n The options for Spot Instances.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides details about the market (purchasing) option for an Amazon EC2 instance.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails": { + "type": "structure", + "members": { + "BlockDurationMinutes": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n Deprecated.\n

" + } + }, + "InstanceInterruptionBehavior": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The behavior when a Spot Instance is interrupted.\n

" + } + }, + "MaxPrice": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The maximum hourly price you're willing to pay for the Spot Instances.\n

" + } + }, + "SpotInstanceType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Spot Instance request type.\n

" + } + }, + "ValidUntil": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ), for persistent requests.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides details about the market (purchasing) options for Spot Instances.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorCountDetails": { + "type": "structure", + "members": { + "Max": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The maximum number of accelerators. If this parameter isn't specified, there's no maximum limit. To exclude accelerator-enabled instance types, set Max to 0.\n

" + } + }, + "Min": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The minimum number of accelerators. If this parameter isn't specified, there's no minimum limit.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an Amazon EC2 instance.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorTotalMemoryMiBDetails": { + "type": "structure", + "members": { + "Max": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The maximum amount of memory, in MiB. If this parameter isn't specified, there's no maximum limit.\n

" + } + }, + "Min": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The minimum amount of memory, in MiB. If 0 is specified, there's no maximum limit.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The minimum and maximum amount of memory, in MiB, for the accelerators on an Amazon EC2 instance.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsBaselineEbsBandwidthMbpsDetails": { + "type": "structure", + "members": { + "Max": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The maximum baseline bandwidth, in Mbps. If this parameter is omitted, there's no maximum limit.\n

" + } + }, + "Min": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The minimum baseline bandwidth, in Mbps. If this parameter is omitted, there's no minimum limit.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The minimum and maximum baseline bandwidth to Amazon Elastic Block Store (Amazon EBS), in Mbps. For more information, \n see Amazon EBS–optimized instances in the Amazon EC2 User Guide.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsDetails": { + "type": "structure", + "members": { + "AcceleratorCount": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorCountDetails", + "traits": { + "smithy.api#documentation": "

\n The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance.\n

" + } + }, + "AcceleratorManufacturers": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

Indicates whether instance types must have accelerators by specific manufacturers.\n

" + } + }, + "AcceleratorNames": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

\n The accelerators that must be on the instance type.\n

" + } + }, + "AcceleratorTotalMemoryMiB": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorTotalMemoryMiBDetails", + "traits": { + "smithy.api#documentation": "

\n The minimum and maximum amount of total accelerator memory, in MiB.\n

" + } + }, + "AcceleratorTypes": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The accelerator types that must be on the instance type.\n

" + } + }, + "BareMetal": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates whether bare metal instance types must be included, excluded, or required.\n

" + } + }, + "BaselineEbsBandwidthMbps": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsBaselineEbsBandwidthMbpsDetails", + "traits": { + "smithy.api#documentation": "

\n The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS optimized instances in the Amazon EC2 User Guide.\n

" + } + }, + "BurstablePerformance": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Indicates whether burstable performance T instance types are included, excluded, or required. For more information, Burstable performance instances in the Amazon EC2 User Guide.\n

" + } + }, + "CpuManufacturers": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

\n The CPU manufacturers to include.\n

" + } + }, + "ExcludedInstanceTypes": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

\n The instance types to exclude.\n

" + } + }, + "InstanceGenerations": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

\n Indicates whether current or previous generation instance types are included.\n

" + } + }, + "LocalStorage": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, see Amazon EC2 instance store in the Amazon EC2 User Guide.\n

" + } + }, + "LocalStorageTypes": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

\n The type of local storage that is required.\n

" + } + }, + "MemoryGiBPerVCpu": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsMemoryGiBPerVCpuDetails", + "traits": { + "smithy.api#documentation": "

\n The minimum and maximum amount of memory per vCPU, in GiB.\n

" + } + }, + "MemoryMiB": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsMemoryMiBDetails", + "traits": { + "smithy.api#documentation": "

\n The minimum and maximum amount of memory, in MiB.\n

" + } + }, + "NetworkInterfaceCount": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsNetworkInterfaceCountDetails", + "traits": { + "smithy.api#documentation": "

\n The minimum and maximum number of network interfaces.\n

" + } + }, + "OnDemandMaxPricePercentageOverLowestPrice": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The price protection threshold for On-Demand Instances. This is the maximum you'll pay\n for an On-Demand Instance, expressed as a percentage above the least expensive current\n generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects\n instance types with your attributes, it excludes instance types priced above your\n threshold.

\n

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

\n

A high value, such as 999999, turns off price protection.

" + } + }, + "RequireHibernateSupport": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Indicates whether instance types must support hibernation for On-Demand Instances.\n

" + } + }, + "SpotMaxPricePercentageOverLowestPrice": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The price protection threshold for Spot Instances. This is the maximum you'll pay for a\n Spot Instance, expressed as a percentage above the least expensive current generation M, C,\n or R instance type with your specified attributes. When Amazon EC2 selects instance\n types with your attributes, it excludes instance types priced above your threshold.

\n

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

\n

A high value, such as 999999, turns off price protection.

" + } + }, + "TotalLocalStorageGB": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsTotalLocalStorageGBDetails", + "traits": { + "smithy.api#documentation": "

\n The minimum and maximum amount of total local storage, in GB.\n

" + } + }, + "VCpuCount": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsVCpuCountDetails", + "traits": { + "smithy.api#documentation": "

\n The minimum and maximum number of vCPUs.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The attributes for the Amazon EC2 instance types.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsMemoryGiBPerVCpuDetails": { + "type": "structure", + "members": { + "Max": { + "target": "com.amazonaws.securityhub#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The maximum amount of memory per vCPU, in GiB. If this parameter is omitted, there's no maximum limit.\n

" + } + }, + "Min": { + "target": "com.amazonaws.securityhub#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The minimum amount of memory per vCPU, in GiB. If this parameter is omitted, there's no maximum limit.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The minimum and maximum amount of memory per vCPU, in GiB.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsMemoryMiBDetails": { + "type": "structure", + "members": { + "Max": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The maximum amount of memory, in MiB.\n

" + } + }, + "Min": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The minimum amount of memory, in MiB. \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The minimum and maximum amount of memory, in MiB, for an Amazon EC2 instance.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsNetworkInterfaceCountDetails": { + "type": "structure", + "members": { + "Max": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The maximum number of network interfaces. \n

" + } + }, + "Min": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The minimum number of network interfaces.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The minimum and maximum number of network interfaces to be attached to an Amazon EC2 instance.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsTotalLocalStorageGBDetails": { + "type": "structure", + "members": { + "Max": { + "target": "com.amazonaws.securityhub#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The maximum amount of total local storage, in GB.\n

" + } + }, + "Min": { + "target": "com.amazonaws.securityhub#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The minimum amount of total local storage, in GB.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The minimum and maximum amount of total local storage, in GB, that an Amazon EC2 instance uses.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsVCpuCountDetails": { + "type": "structure", + "members": { + "Max": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The maximum number of vCPUs. \n

" + } + }, + "Min": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The minimum number of vCPUs.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The minimum and maximum number of vCPUs for an Amazon EC2 instance.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataLicenseSetDetails": { + "type": "structure", + "members": { + "LicenseConfigurationArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the license configuration.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides details about the license configuration for an Amazon EC2 instance.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataLicenseSetList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataLicenseSetDetails" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataMaintenanceOptionsDetails": { + "type": "structure", + "members": { + "AutoRecovery": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Disables the automatic recovery behavior of your instance or sets it to default.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The maintenance options of an Amazon EC2 instance.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataMetadataOptionsDetails": { + "type": "structure", + "members": { + "HttpEndpoint": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Enables or disables the HTTP metadata endpoint on your instances. If the parameter is\n not specified, the default state is enabled, and you won't be able to access your instance\n metadata.

" + } + }, + "HttpProtocolIpv6": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Enables or disables the IPv6 endpoint for the instance metadata service.\n

" + } + }, + "HttpTokens": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The state of token usage for your instance metadata requests.\n

" + } + }, + "HttpPutResponseHopLimit": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The desired HTTP PUT response hop limit for instance metadata requests. The larger \n the number, the further instance metadata requests can travel.\n

" + } + }, + "InstanceMetadataTags": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n When set to enabled, this parameter allows access to instance tags from the instance metadata. When set to disabled, it turns off access to instance tags from the instance metadata. For more information, see \nWork with instance tags in instance metadata in the Amazon EC2 User Guide.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Specifies the metadata options for an Amazon EC2 instance.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataMonitoringDetails": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Enables detailed monitoring when true is specified. Otherwise, basic monitoring is enabled. \n For more information about detailed monitoring, see \n Enable or turn off detailed monitoring for your instances in the Amazon EC2 User Guide. \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The monitoring for an Amazon EC2 instance.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails": { + "type": "structure", + "members": { + "AssociateCarrierIpAddress": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Indicates whether to associate a Carrier IP address with eth0 for a new network interface. \n You use this option when you launch an instance in a Wavelength Zone and want to \n associate a Carrier IP address with the network interface. For more information, see \n Carrier IP address in the Wavelength Developer Guide.\n

" + } + }, + "AssociatePublicIpAddress": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Associates a public IPv4 address with eth0 for a new network interface.\n

" + } + }, + "DeleteOnTermination": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Indicates whether the network interface is deleted when the instance is terminated.\n

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n A description for the network interface.\n

" + } + }, + "DeviceIndex": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The device index for the network interface attachment.\n

" + } + }, + "Groups": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

\n The IDs of one or more security groups.\n

" + } + }, + "InterfaceType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The type of network interface.\n

" + } + }, + "Ipv4PrefixCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The number of IPv4 prefixes to be automatically assigned to the network interface. \n You cannot use this option if you use the Ipv4Prefixes option.\n

" + } + }, + "Ipv4Prefixes": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv4PrefixesList", + "traits": { + "smithy.api#documentation": "

\n One or more IPv4 prefixes to be assigned to the network interface. You cannot use \n this option if you use the Ipv4PrefixCount option.\n

" + } + }, + "Ipv6AddressCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The number of IPv6 addresses to assign to a network interface. Amazon EC2 \n automatically selects the IPv6 addresses from the subnet range. You can't use this \n option if you use Ipv6Addresses.\n

" + } + }, + "Ipv6Addresses": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6AddressesList", + "traits": { + "smithy.api#documentation": "

\n One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. \n You can't use this option if you use Ipv6AddressCount.\n

" + } + }, + "Ipv6PrefixCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The number of IPv6 prefixes to be automatically assigned to the network interface. \n You cannot use this option if you use the Ipv6Prefix option.\n

" + } + }, + "Ipv6Prefixes": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6PrefixesList", + "traits": { + "smithy.api#documentation": "

\n One or more IPv6 prefixes to be assigned to the network interface. You cannot use \n this option if you use the Ipv6PrefixCount option.\n

" + } + }, + "NetworkCardIndex": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The index of the network card. Some instance types support multiple network cards. \n The primary network interface must be assigned to network card index 0. The default \n is network card index 0.\n

" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of the network interface.\n

" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The primary private IPv4 address of the network interface.\n

" + } + }, + "PrivateIpAddresses": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetPrivateIpAddressesList", + "traits": { + "smithy.api#documentation": "

\n One or more private IPv4 addresses.\n

" + } + }, + "SecondaryPrivateIpAddressCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The number of secondary private IPv4 addresses to assign to a network interface.\n

" + } + }, + "SubnetId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of the subnet for the network interface.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n One or more network interfaces to attach to an Amazon EC2 instance. If you specify a network interface, you must specify \n security groups and subnets as part of the network interface.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv4PrefixesDetails": { + "type": "structure", + "members": { + "Ipv4Prefix": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The IPv4 prefix. For more information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides details on one or more IPv4 prefixes for a network interface. \n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv4PrefixesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv4PrefixesDetails" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6AddressesDetails": { + "type": "structure", + "members": { + "Ipv6Address": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Specifies an IPv6 address in an Amazon EC2 launch template.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6AddressesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6AddressesDetails" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6PrefixesDetails": { + "type": "structure", + "members": { + "Ipv6Prefix": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The IPv6 prefix.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides details on one or more IPv6 prefixes to be assigned to the network interface.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6PrefixesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6PrefixesDetails" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetPrivateIpAddressesDetails": { + "type": "structure", + "members": { + "Primary": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.\n

" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The private IPv4 address.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n One or more private IPv4 addresses.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetPrivateIpAddressesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetPrivateIpAddressesDetails" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataPlacementDetails": { + "type": "structure", + "members": { + "Affinity": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The affinity setting for an instance on an EC2 Dedicated Host.\n

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Availability Zone for the instance.\n

" + } + }, + "GroupName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The name of the placement group for the instance.\n

" + } + }, + "HostId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of the Dedicated Host for the instance.\n

" + } + }, + "HostResourceGroupArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the host resource group in which to launch the instances. \n

" + } + }, + "PartitionNumber": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The number of the partition the instance should launch in.\n

" + } + }, + "SpreadDomain": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Reserved for future use.\n

" + } + }, + "Tenancy": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n 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.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides details about the placement of an Amazon EC2 instance.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataPrivateDnsNameOptionsDetails": { + "type": "structure", + "members": { + "EnableResourceNameDnsAAAARecord": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.\n

" + } + }, + "EnableResourceNameDnsARecord": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Indicates whether to respond to DNS queries for instance hostnames with DNS A records.\n

" + } + }, + "HostnameType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The type of hostname for EC2 instances. \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Describes the options for Amazon EC2 instance hostnames.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDetails": { + "type": "structure", + "members": { + "LaunchTemplateName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n A name for the launch template.\n

" + } + }, + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n An ID for the launch template.\n

" + } + }, + "LaunchTemplateData": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataDetails", + "traits": { + "smithy.api#documentation": "

\n The information to include in the launch template.\n

" + } + }, + "DefaultVersionNumber": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The default version of the launch template.\n

" + } + }, + "LatestVersionNumber": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The latest version of the launch template.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Specifies the properties for creating an Amazon Elastic Compute Cloud (Amazon EC2) launch template.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2NetworkAclAssociation": { + "type": "structure", + "members": { + "NetworkAclAssociationId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the association between the network ACL and the subnet.

" + } + }, + "NetworkAclId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the network ACL.

" + } + }, + "SubnetId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the subnet that is associated with the network ACL.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An association between the network ACL and a subnet.

" + } + }, + "com.amazonaws.securityhub#AwsEc2NetworkAclAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2NetworkAclAssociation" + } + }, + "com.amazonaws.securityhub#AwsEc2NetworkAclDetails": { + "type": "structure", + "members": { + "IsDefault": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether this is the default network ACL for the VPC.

" + } + }, + "NetworkAclId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the network ACL.

" + } + }, + "OwnerId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Web Services account that owns the network ACL.

" + } + }, + "VpcId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the VPC for the network ACL.

" + } + }, + "Associations": { + "target": "com.amazonaws.securityhub#AwsEc2NetworkAclAssociationList", + "traits": { + "smithy.api#documentation": "

Associations between the network ACL and subnets.

" + } + }, + "Entries": { + "target": "com.amazonaws.securityhub#AwsEc2NetworkAclEntryList", + "traits": { + "smithy.api#documentation": "

The set of rules in the network ACL.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about an Amazon EC2 network access control list (ACL).

" + } + }, + "com.amazonaws.securityhub#AwsEc2NetworkAclEntry": { + "type": "structure", + "members": { + "CidrBlock": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The IPV4 network range for which to deny or allow access.

" + } + }, + "Egress": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the rule is an egress rule. An egress rule is a rule that applies to traffic that leaves the subnet.

" + } + }, + "IcmpTypeCode": { + "target": "com.amazonaws.securityhub#IcmpTypeCode", + "traits": { + "smithy.api#documentation": "

The Internet Control Message Protocol (ICMP) type and code for which to deny or allow access.

" + } + }, + "Ipv6CidrBlock": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The IPV6 network range for which to deny or allow access.

" + } + }, + "PortRange": { + "target": "com.amazonaws.securityhub#PortRangeFromTo", + "traits": { + "smithy.api#documentation": "

For TCP or UDP protocols, the range of ports that the rule applies to.

" + } + }, + "Protocol": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The protocol that the rule applies to. To deny or allow access to all protocols, use the\n value -1.

" + } + }, + "RuleAction": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Whether the rule is used to allow access or deny access.

" + } + }, + "RuleNumber": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The rule number. The rules are processed in order by their number.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A rule for the network ACL. Each rule allows or denies access based on the IP address, traffic direction, port, and protocol.

" + } + }, + "com.amazonaws.securityhub#AwsEc2NetworkAclEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2NetworkAclEntry" + } + }, + "com.amazonaws.securityhub#AwsEc2NetworkInterfaceAttachment": { + "type": "structure", + "members": { + "AttachTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the attachment initiated.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "AttachmentId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the network interface attachment

" + } + }, + "DeleteOnTermination": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the network interface is deleted when the instance is\n terminated.

" + } + }, + "DeviceIndex": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The device index of the network interface attachment on the instance.

" + } + }, + "InstanceId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the instance.

" + } + }, + "InstanceOwnerId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the instance.

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The attachment state.

\n

Valid values: attaching | attached | detaching |\n detached\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the network interface attachment.

" + } + }, + "com.amazonaws.securityhub#AwsEc2NetworkInterfaceDetails": { + "type": "structure", + "members": { + "Attachment": { + "target": "com.amazonaws.securityhub#AwsEc2NetworkInterfaceAttachment", + "traits": { + "smithy.api#documentation": "

The network interface attachment.

" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the network interface.

" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.securityhub#AwsEc2NetworkInterfaceSecurityGroupList", + "traits": { + "smithy.api#documentation": "

Security groups for the network interface.

" + } + }, + "SourceDestCheck": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether traffic to or from the instance is validated.

" + } + }, + "IpV6Addresses": { + "target": "com.amazonaws.securityhub#AwsEc2NetworkInterfaceIpV6AddressList", + "traits": { + "smithy.api#documentation": "

The IPv6 addresses associated with the network interface.

" + } + }, + "PrivateIpAddresses": { + "target": "com.amazonaws.securityhub#AwsEc2NetworkInterfacePrivateIpAddressList", + "traits": { + "smithy.api#documentation": "

The private IPv4 addresses associated with the network interface.

" + } + }, + "PublicDnsName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The public DNS name of the network interface.

" + } + }, + "PublicIp": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The address of the Elastic IP address bound to the network interface.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the network interface

" + } + }, + "com.amazonaws.securityhub#AwsEc2NetworkInterfaceIpV6AddressDetail": { + "type": "structure", + "members": { + "IpV6Address": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The IPV6 address.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about an IPV6 address that is associated with the network\n interface.

" + } + }, + "com.amazonaws.securityhub#AwsEc2NetworkInterfaceIpV6AddressList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2NetworkInterfaceIpV6AddressDetail" + } + }, + "com.amazonaws.securityhub#AwsEc2NetworkInterfacePrivateIpAddressDetail": { + "type": "structure", + "members": { + "PrivateIpAddress": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The IP address.

" + } + }, + "PrivateDnsName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The private DNS name for the IP address.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about a private IPv4 address that is with the network\n interface.

" + } + }, + "com.amazonaws.securityhub#AwsEc2NetworkInterfacePrivateIpAddressList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2NetworkInterfacePrivateIpAddressDetail" + } + }, + "com.amazonaws.securityhub#AwsEc2NetworkInterfaceSecurityGroup": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the security group.

" + } + }, + "GroupId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the security group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A security group associated with the network interface.

" + } + }, + "com.amazonaws.securityhub#AwsEc2NetworkInterfaceSecurityGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2NetworkInterfaceSecurityGroup" + } + }, + "com.amazonaws.securityhub#AwsEc2RouteTableDetails": { + "type": "structure", + "members": { + "AssociationSet": { + "target": "com.amazonaws.securityhub#AssociationSetList", + "traits": { + "smithy.api#documentation": "

\n The associations between a route table and one or more subnets or a gateway.\n

" + } + }, + "OwnerId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of the Amazon Web Services account that owns the route table.\n

" + } + }, + "PropagatingVgwSet": { + "target": "com.amazonaws.securityhub#PropagatingVgwSetList", + "traits": { + "smithy.api#documentation": "

\n Describes a virtual private gateway propagating route.\n

" + } + }, + "RouteTableId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of the route table.\n

" + } + }, + "RouteSet": { + "target": "com.amazonaws.securityhub#RouteSetList", + "traits": { + "smithy.api#documentation": "

\n The routes in the route table.\n

" + } + }, + "VpcId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of the virtual private cloud (VPC).\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides details about a route table for the specified VPC. \n

" + } + }, + "com.amazonaws.securityhub#AwsEc2SecurityGroupDetails": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the security group.

" + } + }, + "GroupId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the security group.

" + } + }, + "OwnerId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the security group.

" + } + }, + "VpcId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

[VPC only] The ID of the VPC for the security group.

" + } + }, + "IpPermissions": { + "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupIpPermissionList", + "traits": { + "smithy.api#documentation": "

The inbound rules associated with the security group.

" + } + }, + "IpPermissionsEgress": { + "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupIpPermissionList", + "traits": { + "smithy.api#documentation": "

[VPC only] The outbound rules associated with the security group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about an Amazon EC2 security group.

" + } + }, + "com.amazonaws.securityhub#AwsEc2SecurityGroupIpPermission": { + "type": "structure", + "members": { + "IpProtocol": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The IP protocol name (tcp, udp, icmp,\n icmpv6) or number.

\n

[VPC only] Use -1 to specify all protocols.

\n

When authorizing security group rules, specifying -1\n or a protocol number other than tcp, udp, icmp, or\n icmpv6 allows traffic on all ports, regardless of any port range you\n specify.

\n

For tcp, udp, and icmp, you must specify a port\n range.

\n

For icmpv6, the port range is optional. If you omit the port range, traffic\n for all types and codes is allowed.

" + } + }, + "FromPort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type\n number.

\n

A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you\n must specify all codes.

" + } + }, + "ToPort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.

\n

A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all\n codes.

" + } + }, + "UserIdGroupPairs": { + "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupUserIdGroupPairList", + "traits": { + "smithy.api#documentation": "

The security group and Amazon Web Services account ID pairs.

" + } + }, + "IpRanges": { + "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupIpRangeList", + "traits": { + "smithy.api#documentation": "

The IPv4 ranges.

" + } + }, + "Ipv6Ranges": { + "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupIpv6RangeList", + "traits": { + "smithy.api#documentation": "

The IPv6 ranges.

" + } + }, + "PrefixListIds": { + "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupPrefixListIdList", + "traits": { + "smithy.api#documentation": "

[VPC only] The prefix list IDs for an Amazon Web Services service. With outbound rules, this is the Amazon Web Services\n service to access through a VPC endpoint from instances associated with the security\n group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An IP permission for an EC2 security group.

" + } + }, + "com.amazonaws.securityhub#AwsEc2SecurityGroupIpPermissionList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupIpPermission" + } + }, + "com.amazonaws.securityhub#AwsEc2SecurityGroupIpRange": { + "type": "structure", + "members": { + "CidrIp": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The IPv4 CIDR range. You can specify either a CIDR range or a source security group, but\n not both. To specify a single IPv4 address, use the /32 prefix length.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A range of IPv4 addresses.

" + } + }, + "com.amazonaws.securityhub#AwsEc2SecurityGroupIpRangeList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupIpRange" + } + }, + "com.amazonaws.securityhub#AwsEc2SecurityGroupIpv6Range": { + "type": "structure", + "members": { + "CidrIpv6": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The IPv6 CIDR range. You can specify either a CIDR range or a source security group, but\n not both. To specify a single IPv6 address, use the /128 prefix length.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A range of IPv6 addresses.

" + } + }, + "com.amazonaws.securityhub#AwsEc2SecurityGroupIpv6RangeList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupIpv6Range" + } + }, + "com.amazonaws.securityhub#AwsEc2SecurityGroupPrefixListId": { + "type": "structure", + "members": { + "PrefixListId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the prefix.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A prefix list ID.

" + } + }, + "com.amazonaws.securityhub#AwsEc2SecurityGroupPrefixListIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupPrefixListId" + } + }, + "com.amazonaws.securityhub#AwsEc2SecurityGroupUserIdGroupPair": { + "type": "structure", + "members": { + "GroupId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the security group.

" + } + }, + "GroupName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the security group.

" + } + }, + "PeeringStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of a VPC peering connection, if applicable.

" + } + }, + "UserId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of an Amazon Web Services account.

\n

For a referenced security group in another VPC, the account ID of the referenced\n security group is returned in the response. If the referenced security group is deleted,\n this value is not returned.

\n

[EC2-Classic] Required when adding or removing rules that reference a security group in\n another VPC.

" + } + }, + "VpcId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the VPC for the referenced security group, if applicable.

" + } + }, + "VpcPeeringConnectionId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the VPC peering connection, if applicable.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A relationship between a security group and a user.

" + } + }, + "com.amazonaws.securityhub#AwsEc2SecurityGroupUserIdGroupPairList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupUserIdGroupPair" + } + }, + "com.amazonaws.securityhub#AwsEc2SubnetDetails": { + "type": "structure", + "members": { + "AssignIpv6AddressOnCreation": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether to assign an IPV6 address to a network interface that is created in this subnet.

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Availability Zone for the subnet.

" + } + }, + "AvailabilityZoneId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the Availability Zone for the subnet.

" + } + }, + "AvailableIpAddressCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of available IPV4 addresses in the subnet. Does not include addresses for stopped instances.

" + } + }, + "CidrBlock": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The IPV4 CIDR block that is assigned to the subnet.

" + } + }, + "DefaultForAz": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether this subnet is the default subnet for the Availability Zone.

" + } + }, + "MapPublicIpOnLaunch": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether instances in this subnet receive a public IP address.

" + } + }, + "OwnerId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Web Services account that owns the subnet.

" + } + }, + "State": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The current state of the subnet. Valid values are available or pending.

" + } + }, + "SubnetArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the subnet.

" + } + }, + "SubnetId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the subnet.

" + } + }, + "VpcId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the VPC that contains the subnet.

" + } + }, + "Ipv6CidrBlockAssociationSet": { + "target": "com.amazonaws.securityhub#Ipv6CidrBlockAssociationList", + "traits": { + "smithy.api#documentation": "

The IPV6 CIDR blocks that are associated with the subnet.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a subnet in Amazon EC2.

" + } + }, + "com.amazonaws.securityhub#AwsEc2TransitGatewayDetails": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway.\n

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description of the transit gateway.\n

" + } + }, + "DefaultRouteTablePropagation": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Turn on or turn off automatic propagation of routes to the default propagation route table.\n

" + } + }, + "AutoAcceptSharedAttachments": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Turn on or turn off automatic acceptance of attachment requests.\n

" + } + }, + "DefaultRouteTableAssociation": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Turn on or turn off automatic association with the default association route table.\n

" + } + }, + "TransitGatewayCidrBlocks": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The transit gateway Classless Inter-Domain Routing (CIDR) blocks.\n

" + } + }, + "AssociationDefaultRouteTableId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the default association route table.\n

" + } + }, + "PropagationDefaultRouteTableId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the default propagation route table.\n

" + } + }, + "VpnEcmpSupport": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Turn on or turn off Equal Cost Multipath Protocol (ECMP) support. \n

" + } + }, + "DnsSupport": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Turn on or turn off DNS support. \n

" + } + }, + "MulticastSupport": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates whether multicast is supported on the transit gateway. \n

" + } + }, + "AmazonSideAsn": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

A private Autonomous System Number (ASN) for the Amazon side of a BGP session. \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an Amazon Web Services Amazon EC2 Transit Gateway that interconnects \nvirtual private clouds (VPCs) and on-premises networks.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2VolumeAttachment": { + "type": "structure", + "members": { + "AttachTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The datetime when the attachment initiated.

" + } + }, + "DeleteOnTermination": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the EBS volume is deleted when the EC2 instance is terminated.

" + } + }, + "InstanceId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the EC2 instance.

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The attachment state of the volume. Valid values are as follows:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

An attachment to an Amazon EC2 volume.

" + } + }, + "com.amazonaws.securityhub#AwsEc2VolumeAttachmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2VolumeAttachment" + } + }, + "com.amazonaws.securityhub#AwsEc2VolumeDetails": { + "type": "structure", + "members": { + "CreateTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the volume was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "DeviceName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The device name for the volume that is attached to the instance.\n

" + } + }, + "Encrypted": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether the volume is encrypted.

" + } + }, + "Size": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The size of the volume, in GiBs.

" + } + }, + "SnapshotId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The snapshot from which the volume was created.

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The volume state. Valid values are as follows:

\n " + } + }, + "KmsKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the KMS key that was\n used to protect the volume encryption key for the volume.

" + } + }, + "Attachments": { + "target": "com.amazonaws.securityhub#AwsEc2VolumeAttachmentList", + "traits": { + "smithy.api#documentation": "

The volume attachments.

" + } + }, + "VolumeId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the volume.\n

" + } + }, + "VolumeType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The volume type.\n

" + } + }, + "VolumeScanStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates whether the volume was scanned or skipped.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about an EC2 volume.

" + } + }, + "com.amazonaws.securityhub#AwsEc2VpcDetails": { + "type": "structure", + "members": { + "CidrBlockAssociationSet": { + "target": "com.amazonaws.securityhub#CidrBlockAssociationList", + "traits": { + "smithy.api#documentation": "

Information about the IPv4 CIDR blocks associated with the VPC.

" + } + }, + "Ipv6CidrBlockAssociationSet": { + "target": "com.amazonaws.securityhub#Ipv6CidrBlockAssociationList", + "traits": { + "smithy.api#documentation": "

Information about the IPv6 CIDR blocks associated with the VPC.

" + } + }, + "DhcpOptionsId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the set of Dynamic Host Configuration Protocol (DHCP) options that are\n associated with the VPC. If the default options are associated with the VPC, then this is\n default.

" + } + }, + "State": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The current state of the VPC. Valid values are available or pending.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about an EC2 VPC.

" + } + }, + "com.amazonaws.securityhub#AwsEc2VpcEndpointServiceDetails": { + "type": "structure", + "members": { + "AcceptanceRequired": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether requests from other Amazon Web Services accounts to create an endpoint to the service must first be accepted.

" + } + }, + "AvailabilityZones": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The Availability Zones where the service is available.

" + } + }, + "BaseEndpointDnsNames": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The DNS names for the service.

" + } + }, + "ManagesVpcEndpoints": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the service manages its VPC endpoints.

" + } + }, + "GatewayLoadBalancerArns": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The ARNs of the Gateway Load Balancers for the service.

" + } + }, + "NetworkLoadBalancerArns": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The ARNs of the Network Load Balancers for the service.

" + } + }, + "PrivateDnsName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The private DNS name for the service.

" + } + }, + "ServiceId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the service.

" + } + }, + "ServiceName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the service.

" + } + }, + "ServiceState": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The current state of the service. Valid values are as follows:

\n " + } + }, + "ServiceType": { + "target": "com.amazonaws.securityhub#AwsEc2VpcEndpointServiceServiceTypeList", + "traits": { + "smithy.api#documentation": "

The types for the service.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about the service configuration for a VPC endpoint service.

" + } + }, + "com.amazonaws.securityhub#AwsEc2VpcEndpointServiceServiceTypeDetails": { + "type": "structure", + "members": { + "ServiceType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of service.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The service type information for a VPC endpoint service.

" + } + }, + "com.amazonaws.securityhub#AwsEc2VpcEndpointServiceServiceTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2VpcEndpointServiceServiceTypeDetails" + } + }, + "com.amazonaws.securityhub#AwsEc2VpcPeeringConnectionDetails": { + "type": "structure", + "members": { + "AccepterVpcInfo": { + "target": "com.amazonaws.securityhub#AwsEc2VpcPeeringConnectionVpcInfoDetails", + "traits": { + "smithy.api#documentation": "

Information about the accepter VPC.\n

" + } + }, + "ExpirationTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The time at which an unaccepted VPC peering connection will expire.\n

" + } + }, + "RequesterVpcInfo": { + "target": "com.amazonaws.securityhub#AwsEc2VpcPeeringConnectionVpcInfoDetails", + "traits": { + "smithy.api#documentation": "

Information about the requester VPC. \n

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#AwsEc2VpcPeeringConnectionStatusDetails", + "traits": { + "smithy.api#documentation": "

The status of the VPC peering connection.\n

" + } + }, + "VpcPeeringConnectionId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the VPC peering connection.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about a VPC peering connection between two VPCs: a requester VPC that you own and an \naccepter VPC with which to create the connection. \n

" + } + }, + "com.amazonaws.securityhub#AwsEc2VpcPeeringConnectionStatusDetails": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of the VPC peering connection.\n

" + } + }, + "Message": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A message that provides more information about the status, if applicable.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the status of the VPC peering connection.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2VpcPeeringConnectionVpcInfoDetails": { + "type": "structure", + "members": { + "CidrBlock": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The IPv4 CIDR block for the VPC.\n

" + } + }, + "CidrBlockSet": { + "target": "com.amazonaws.securityhub#VpcInfoCidrBlockSetList", + "traits": { + "smithy.api#documentation": "

Information about the IPv4 CIDR blocks for the VPC.\n

" + } + }, + "Ipv6CidrBlockSet": { + "target": "com.amazonaws.securityhub#VpcInfoIpv6CidrBlockSetList", + "traits": { + "smithy.api#documentation": "

The IPv6 CIDR block for the VPC.\n

" + } + }, + "OwnerId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the VPC.\n

" + } + }, + "PeeringOptions": { + "target": "com.amazonaws.securityhub#VpcInfoPeeringOptionsDetails", + "traits": { + "smithy.api#documentation": "

Information about the VPC peering connection options for the accepter or requester VPC.\n

" + } + }, + "Region": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region in which the VPC is located.\n

" + } + }, + "VpcId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the VPC.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a VPC in a VPC peering connection.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2VpnConnectionDetails": { + "type": "structure", + "members": { + "VpnConnectionId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the VPN connection.

" + } + }, + "State": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The current state of the VPN connection. Valid values are as follows:

\n " + } + }, + "CustomerGatewayId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the customer gateway that is at your end of the VPN connection.

" + } + }, + "CustomerGatewayConfiguration": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The configuration information for the VPN connection's customer gateway, in the native XML\n format.

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of VPN connection.

" + } + }, + "VpnGatewayId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the virtual private gateway that is at the Amazon Web Services side of the VPN\n connection.

" + } + }, + "Category": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The category of the VPN connection. VPN indicates an Amazon Web Services VPN connection. VPN-Classic\n indicates an Amazon Web Services Classic VPN connection.

" + } + }, + "VgwTelemetry": { + "target": "com.amazonaws.securityhub#AwsEc2VpnConnectionVgwTelemetryList", + "traits": { + "smithy.api#documentation": "

Information about the VPN tunnel.

" + } + }, + "Options": { + "target": "com.amazonaws.securityhub#AwsEc2VpnConnectionOptionsDetails", + "traits": { + "smithy.api#documentation": "

The VPN connection options.

" + } + }, + "Routes": { + "target": "com.amazonaws.securityhub#AwsEc2VpnConnectionRoutesList", + "traits": { + "smithy.api#documentation": "

The static routes that are associated with the VPN connection.

" + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the transit gateway that is associated with the VPN connection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about an Amazon EC2 VPN\n connection.

" + } + }, + "com.amazonaws.securityhub#AwsEc2VpnConnectionOptionsDetails": { + "type": "structure", + "members": { + "StaticRoutesOnly": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the VPN connection uses static routes only.

" + } + }, + "TunnelOptions": { + "target": "com.amazonaws.securityhub#AwsEc2VpnConnectionOptionsTunnelOptionsList", + "traits": { + "smithy.api#documentation": "

The VPN tunnel options.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

VPN connection options.

" + } + }, + "com.amazonaws.securityhub#AwsEc2VpnConnectionOptionsTunnelOptionsDetails": { + "type": "structure", + "members": { + "DpdTimeoutSeconds": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of seconds after which a Dead Peer Detection (DPD) timeout occurs.

" + } + }, + "IkeVersions": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The Internet Key Exchange (IKE) versions that are permitted for the VPN tunnel.

" + } + }, + "OutsideIpAddress": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The external IP address of the VPN tunnel.

" + } + }, + "Phase1DhGroupNumbers": { + "target": "com.amazonaws.securityhub#IntegerList", + "traits": { + "smithy.api#documentation": "

The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE\n negotiations.

" + } + }, + "Phase1EncryptionAlgorithms": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The permitted encryption algorithms for the VPN tunnel for phase 1 IKE\n negotiations.

" + } + }, + "Phase1IntegrityAlgorithms": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The permitted integrity algorithms for the VPN tunnel for phase 1 IKE\n negotiations.

" + } + }, + "Phase1LifetimeSeconds": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The lifetime for phase 1 of the IKE negotiation, in seconds.

" + } + }, + "Phase2DhGroupNumbers": { + "target": "com.amazonaws.securityhub#IntegerList", + "traits": { + "smithy.api#documentation": "

The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE\n negotiations.

" + } + }, + "Phase2EncryptionAlgorithms": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The permitted encryption algorithms for the VPN tunnel for phase 2 IKE\n negotiations.

" + } + }, + "Phase2IntegrityAlgorithms": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The permitted integrity algorithms for the VPN tunnel for phase 2 IKE\n negotiations.

" + } + }, + "Phase2LifetimeSeconds": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The lifetime for phase 2 of the IKE negotiation, in seconds.

" + } + }, + "PreSharedKey": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The preshared key to establish initial authentication between the virtual private gateway\n and the customer gateway.

" + } + }, + "RekeyFuzzPercentage": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The percentage of the rekey window, which is determined by\n RekeyMarginTimeSeconds during which the rekey time is randomly selected.

" + } + }, + "RekeyMarginTimeSeconds": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The margin time, in seconds, before the phase 2 lifetime expires, during which the Amazon Web Services\n side of the VPN connection performs an IKE rekey.

" + } + }, + "ReplayWindowSize": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of packets in an IKE replay window.

" + } + }, + "TunnelInsideCidr": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The range of inside IPv4 addresses for the tunnel.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The VPN tunnel options.

" + } + }, + "com.amazonaws.securityhub#AwsEc2VpnConnectionOptionsTunnelOptionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2VpnConnectionOptionsTunnelOptionsDetails" + } + }, + "com.amazonaws.securityhub#AwsEc2VpnConnectionRoutesDetails": { + "type": "structure", + "members": { + "DestinationCidrBlock": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The CIDR block associated with the local subnet of the customer data center.

" + } + }, + "State": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The current state of the static route.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A static routes associated with\n the VPN connection.

" + } + }, + "com.amazonaws.securityhub#AwsEc2VpnConnectionRoutesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2VpnConnectionRoutesDetails" + } + }, + "com.amazonaws.securityhub#AwsEc2VpnConnectionVgwTelemetryDetails": { + "type": "structure", + "members": { + "AcceptedRouteCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of accepted routes.

" + } + }, + "CertificateArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the VPN tunnel endpoint certificate.

" + } + }, + "LastStatusChange": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The date and time of the last change in status.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "OutsideIpAddress": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Internet-routable IP address of the virtual private gateway's outside\n interface.

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of the VPN tunnel. Valid values are DOWN or UP.

" + } + }, + "StatusMessage": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

If an error occurs, a description of the error.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the VPN tunnel.

" + } + }, + "com.amazonaws.securityhub#AwsEc2VpnConnectionVgwTelemetryList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2VpnConnectionVgwTelemetryDetails" + } + }, + "com.amazonaws.securityhub#AwsEcrContainerImageDetails": { + "type": "structure", + "members": { + "RegistryId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account identifier that is associated with the registry that the image belongs\n to.

" + } + }, + "RepositoryName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the repository that the image belongs to.

" + } + }, + "Architecture": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The architecture of the image. Valid values are as follows:

\n " + } + }, + "ImageDigest": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The sha256 digest of the image manifest.

" + } + }, + "ImageTags": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The list of tags that are associated with the image.

" + } + }, + "ImagePublishedAt": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The date and time when the image was pushed to the repository.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an Amazon ECR image.

" + } + }, + "com.amazonaws.securityhub#AwsEcrRepositoryDetails": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the repository.

" + } + }, + "ImageScanningConfiguration": { + "target": "com.amazonaws.securityhub#AwsEcrRepositoryImageScanningConfigurationDetails", + "traits": { + "smithy.api#documentation": "

The image scanning configuration for a repository.

" + } + }, + "ImageTagMutability": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The tag mutability setting for the repository. Valid values are IMMUTABLE or MUTABLE.

" + } + }, + "LifecyclePolicy": { + "target": "com.amazonaws.securityhub#AwsEcrRepositoryLifecyclePolicyDetails", + "traits": { + "smithy.api#documentation": "

Information about the lifecycle policy for the repository.

" + } + }, + "RepositoryName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the repository.

" + } + }, + "RepositoryPolicyText": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The text of the repository policy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about an Amazon Elastic Container Registry repository.

" + } + }, + "com.amazonaws.securityhub#AwsEcrRepositoryImageScanningConfigurationDetails": { + "type": "structure", + "members": { + "ScanOnPush": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether to scan images after they are pushed to a repository.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The image scanning configuration for a repository.

" + } + }, + "com.amazonaws.securityhub#AwsEcrRepositoryLifecyclePolicyDetails": { + "type": "structure", + "members": { + "LifecyclePolicyText": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The text of the lifecycle policy.

" + } + }, + "RegistryId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account identifier that is associated with the registry that contains the repository.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the lifecycle policy for the repository.

" + } + }, + "com.amazonaws.securityhub#AwsEcsClusterClusterSettingsDetails": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the setting. The valid value is containerInsights.

" + } + }, + "Value": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The value of the setting. Valid values are disabled or enabled.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Indicates whether to enable CloudWatch Container Insights for the ECS cluster.

" + } + }, + "com.amazonaws.securityhub#AwsEcsClusterClusterSettingsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsClusterClusterSettingsDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsClusterConfigurationDetails": { + "type": "structure", + "members": { + "ExecuteCommandConfiguration": { + "target": "com.amazonaws.securityhub#AwsEcsClusterConfigurationExecuteCommandConfigurationDetails", + "traits": { + "smithy.api#documentation": "

Contains the run command configuration for the cluster.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The run command configuration for the cluster.

" + } + }, + "com.amazonaws.securityhub#AwsEcsClusterConfigurationExecuteCommandConfigurationDetails": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the KMS key that is used to encrypt the data between the local client and the container.

" + } + }, + "LogConfiguration": { + "target": "com.amazonaws.securityhub#AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails", + "traits": { + "smithy.api#documentation": "

The log configuration for the results of the run command actions. Required if Logging is NONE.

" + } + }, + "Logging": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The log setting to use for redirecting logs for run command results.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the run command configuration for the cluster.

" + } + }, + "com.amazonaws.securityhub#AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails": { + "type": "structure", + "members": { + "CloudWatchEncryptionEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether to enable encryption on the CloudWatch logs.

" + } + }, + "CloudWatchLogGroupName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the CloudWatch log group to send the logs to.

" + } + }, + "S3BucketName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the S3 bucket to send logs to.

" + } + }, + "S3EncryptionEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether to encrypt the logs that are sent to the S3 bucket.

" + } + }, + "S3KeyPrefix": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Identifies the folder in the S3 bucket to send the logs to.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The log configuration for the results of the run command actions.

" + } + }, + "com.amazonaws.securityhub#AwsEcsClusterDefaultCapacityProviderStrategyDetails": { + "type": "structure", + "members": { + "Base": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum number of tasks to run on the specified capacity provider.

" + } + }, + "CapacityProvider": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the capacity provider.

" + } + }, + "Weight": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The relative percentage of the total number of tasks launched that should use the capacity provider.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The default capacity provider strategy for the cluster. The default capacity provider strategy is used when services or tasks are run without a specified launch type or capacity provider strategy.

" + } + }, + "com.amazonaws.securityhub#AwsEcsClusterDefaultCapacityProviderStrategyList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsClusterDefaultCapacityProviderStrategyDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsClusterDetails": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the cluster.\n

" + } + }, + "ActiveServicesCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of services that are running on the cluster in an ACTIVE state. You can view these services with the Amazon ECS \n ListServices\n API operation.\n

" + } + }, + "CapacityProviders": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The short name of one or more capacity providers to associate with the cluster.

" + } + }, + "ClusterSettings": { + "target": "com.amazonaws.securityhub#AwsEcsClusterClusterSettingsList", + "traits": { + "smithy.api#documentation": "

The setting to use to create the cluster. Specifically used to configure whether to enable CloudWatch Container Insights for the cluster.

" + } + }, + "Configuration": { + "target": "com.amazonaws.securityhub#AwsEcsClusterConfigurationDetails", + "traits": { + "smithy.api#documentation": "

The run command configuration for the cluster.

" + } + }, + "DefaultCapacityProviderStrategy": { + "target": "com.amazonaws.securityhub#AwsEcsClusterDefaultCapacityProviderStrategyList", + "traits": { + "smithy.api#documentation": "

The default capacity provider strategy for the cluster. The default capacity provider strategy is used when services or tasks are run without a specified launch type or capacity provider strategy.

" + } + }, + "ClusterName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A name that you use to identify your cluster. \n

" + } + }, + "RegisteredContainerInstancesCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.\n

" + } + }, + "RunningTasksCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of tasks in the cluster that are in the RUNNING state.\n

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of the cluster. \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about an Amazon ECS cluster.

" + } + }, + "com.amazonaws.securityhub#AwsEcsContainerDetails": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the container.\n

" + } + }, + "Image": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The image used for the container.\n

" + } + }, + "MountPoints": { + "target": "com.amazonaws.securityhub#AwsMountPointList", + "traits": { + "smithy.api#documentation": "

The mount points for data volumes in your container.\n

" + } + }, + "Privileged": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

When this parameter is true, the container is given elevated privileges on the host container instance \n(similar to the root user). \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about an Amazon ECS container.\n

" + } + }, + "com.amazonaws.securityhub#AwsEcsContainerDetailsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsContainerDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsServiceCapacityProviderStrategyDetails": { + "type": "structure", + "members": { + "Base": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum number of tasks to run on the capacity provider. Only one strategy item can specify a value for Base.

\n

The value must be between 0 and 100000.

" + } + }, + "CapacityProvider": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The short name of the capacity provider.

" + } + }, + "Weight": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The relative percentage of the total number of tasks that should use the capacity provider.

\n

If no weight is specified, the default value is 0. At least one capacity provider must have a weight greater than 0.

\n

The value can be between 0 and 1000.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Strategy item for the capacity provider strategy that the service uses.

" + } + }, + "com.amazonaws.securityhub#AwsEcsServiceCapacityProviderStrategyList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsServiceCapacityProviderStrategyDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsServiceDeploymentConfigurationDeploymentCircuitBreakerDetails": { + "type": "structure", + "members": { + "Enable": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether to enable the deployment circuit breaker logic for the service.

" + } + }, + "Rollback": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether to roll back the service if a service deployment fails. If rollback is enabled, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Determines whether a service deployment fails if a service cannot reach a steady state.

" + } + }, + "com.amazonaws.securityhub#AwsEcsServiceDeploymentConfigurationDetails": { + "type": "structure", + "members": { + "DeploymentCircuitBreaker": { + "target": "com.amazonaws.securityhub#AwsEcsServiceDeploymentConfigurationDeploymentCircuitBreakerDetails", + "traits": { + "smithy.api#documentation": "

Determines whether a service deployment fails if a service cannot reach a steady state.

" + } + }, + "MaximumPercent": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

For a service that uses the rolling update (ECS) deployment type, the maximum number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment, and for tasks that use the EC2 launch type, when any container instances are in the DRAINING state. Provided as a percentage of the desired number of tasks. The default value is 200%.

\n

For a service that uses the blue/green (CODE_DEPLOY) or EXTERNAL deployment types, and tasks that use the EC2 launch type, the maximum number of tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state.

\n

For the Fargate launch type, the maximum percent value is not used.

" + } + }, + "MinimumHealthyPercent": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

For a service that uses the rolling update (ECS) deployment type, the minimum number of tasks in a service that must remain in the RUNNING state during a deployment, and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Expressed as a percentage of the desired number of tasks. The default value is 100%.

\n

For a service that uses the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and tasks that use the EC2 launch type, the minimum number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state.

\n

For the Fargate launch type, the minimum healthy percent value is not used.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Optional deployment parameters for the service.

" + } + }, + "com.amazonaws.securityhub#AwsEcsServiceDeploymentControllerDetails": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The rolling update (ECS) deployment type replaces the current running version of the container with the latest version.

\n

The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model that is powered by CodeDeploy. This deployment model a new deployment of a service can be verified before production traffic is sent to it.

\n

The external (EXTERNAL) deployment type allows the use of any third-party deployment controller for full control over the deployment process for an Amazon ECS service.

\n

Valid values: ECS | CODE_DEPLOY | EXTERNAL\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the deployment controller type that the service uses.

" + } + }, + "com.amazonaws.securityhub#AwsEcsServiceDetails": { + "type": "structure", + "members": { + "CapacityProviderStrategy": { + "target": "com.amazonaws.securityhub#AwsEcsServiceCapacityProviderStrategyList", + "traits": { + "smithy.api#documentation": "

The capacity provider strategy that the service uses.

" + } + }, + "Cluster": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the cluster that hosts the service.

" + } + }, + "DeploymentConfiguration": { + "target": "com.amazonaws.securityhub#AwsEcsServiceDeploymentConfigurationDetails", + "traits": { + "smithy.api#documentation": "

Deployment parameters for the service. Includes the number of tasks that run and the order in which to start and stop tasks.

" + } + }, + "DeploymentController": { + "target": "com.amazonaws.securityhub#AwsEcsServiceDeploymentControllerDetails", + "traits": { + "smithy.api#documentation": "

Contains the deployment controller type that the service uses.

" + } + }, + "DesiredCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of instantiations of the task definition to run on the service.

" + } + }, + "EnableEcsManagedTags": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether to enable Amazon ECS managed tags for the tasks in the service.

" + } + }, + "EnableExecuteCommand": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the execute command functionality is enabled for the service.

" + } + }, + "HealthCheckGracePeriodSeconds": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

After a task starts, the amount of time in seconds that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks.

" + } + }, + "LaunchType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The launch type that the service uses.

\n

Valid values: EC2 | FARGATE | EXTERNAL\n

" + } + }, + "LoadBalancers": { + "target": "com.amazonaws.securityhub#AwsEcsServiceLoadBalancersList", + "traits": { + "smithy.api#documentation": "

Information about the load balancers that the service uses.

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the service.

" + } + }, + "NetworkConfiguration": { + "target": "com.amazonaws.securityhub#AwsEcsServiceNetworkConfigurationDetails", + "traits": { + "smithy.api#documentation": "

For tasks that use the awsvpc networking mode, the VPC subnet and security group configuration.

" + } + }, + "PlacementConstraints": { + "target": "com.amazonaws.securityhub#AwsEcsServicePlacementConstraintsList", + "traits": { + "smithy.api#documentation": "

The placement constraints for the tasks in the service.

" + } + }, + "PlacementStrategies": { + "target": "com.amazonaws.securityhub#AwsEcsServicePlacementStrategiesList", + "traits": { + "smithy.api#documentation": "

Information about how tasks for the service are placed.

" + } + }, + "PlatformVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The platform version on which to run the service. Only specified for tasks that are hosted on Fargate. If a platform version is not specified, the LATEST platform version is used by default.

" + } + }, + "PropagateTags": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates whether to propagate the tags from the task definition to the task or from the service to the task. If no value is provided, then tags are not propagated.

\n

Valid values: TASK_DEFINITION | SERVICE\n

" + } + }, + "Role": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role that is associated with the service. The role allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.

" + } + }, + "SchedulingStrategy": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The scheduling strategy to use for the service.

\n

The REPLICA scheduling strategy places and maintains the desired number of tasks across the cluster. By default, the service scheduler spreads tasks across Availability Zones. Task placement strategies and constraints are used to customize task placement decisions.

\n

The DAEMON scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that are specified in the cluster. The service scheduler also evaluates the task placement constraints for running tasks and stops tasks that do not meet the placement constraints.

\n

Valid values: REPLICA | DAEMON\n

" + } + }, + "ServiceArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the service.

" + } + }, + "ServiceName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the service.

\n

The name can contain up to 255 characters. It can use letters, numbers, underscores, and hyphens.

" + } + }, + "ServiceRegistries": { + "target": "com.amazonaws.securityhub#AwsEcsServiceServiceRegistriesList", + "traits": { + "smithy.api#documentation": "

Information about the service discovery registries to assign to the service.

" + } + }, + "TaskDefinition": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The task definition to use for tasks in the service.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about a service within an ECS cluster.

" + } + }, + "com.amazonaws.securityhub#AwsEcsServiceLoadBalancersDetails": { + "type": "structure", + "members": { + "ContainerName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the container to associate with the load balancer.

" + } + }, + "ContainerPort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#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.

" + } + }, + "LoadBalancerName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the load balancer to associate with the Amazon ECS service or task set.

\n

Only specified when using a Classic Load Balancer. For an Application Load Balancer or a Network Load Balancer, the load balancer name is omitted.

" + } + }, + "TargetGroupArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the Elastic Load Balancing target group or groups associated with a service or task set.

\n

Only specified when using an Application Load Balancer or a Network Load Balancer. For a Classic Load Balancer, the target group ARN is omitted.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a load balancer that the service uses.

" + } + }, + "com.amazonaws.securityhub#AwsEcsServiceLoadBalancersList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsServiceLoadBalancersDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsServiceNetworkConfigurationAwsVpcConfigurationDetails": { + "type": "structure", + "members": { + "AssignPublicIp": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Whether the task's elastic network interface receives a public IP address. The default value is DISABLED.

\n

Valid values: ENABLED | DISABLED\n

" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the security groups associated with the task or service.

\n

You can provide up to five security groups.

" + } + }, + "Subnets": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the subnets associated with the task or service.

\n

You can provide up to 16 subnets.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

For tasks that use the awsvpc networking mode, the VPC subnet and security group configuration.

" + } + }, + "com.amazonaws.securityhub#AwsEcsServiceNetworkConfigurationDetails": { + "type": "structure", + "members": { + "AwsVpcConfiguration": { + "target": "com.amazonaws.securityhub#AwsEcsServiceNetworkConfigurationAwsVpcConfigurationDetails", + "traits": { + "smithy.api#documentation": "

The VPC subnet and security group configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

For tasks that use the awsvpc networking mode, the VPC subnet and security group configuration.

" + } + }, + "com.amazonaws.securityhub#AwsEcsServicePlacementConstraintsDetails": { + "type": "structure", + "members": { + "Expression": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance.

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of constraint. Use distinctInstance to run each task in a particular group on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.

\n

Valid values: distinctInstance | memberOf\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A placement constraint for the tasks in the service.

" + } + }, + "com.amazonaws.securityhub#AwsEcsServicePlacementConstraintsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsServicePlacementConstraintsDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsServicePlacementStrategiesDetails": { + "type": "structure", + "members": { + "Field": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The field to apply the placement strategy against.

\n

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.

\n

For the binpack placement strategy, valid values are cpu and memory.

\n

For the random placement strategy, this attribute is not used.

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of placement strategy.

\n

The random placement strategy randomly places tasks on available candidates.

\n

The spread placement strategy spreads placement across available candidates evenly based on the value of Field.

\n

The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified in Field.

\n

Valid values: random | spread | binpack\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A placement strategy that determines how to place the tasks for the service.

" + } + }, + "com.amazonaws.securityhub#AwsEcsServicePlacementStrategiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsServicePlacementStrategiesDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsServiceServiceRegistriesDetails": { + "type": "structure", + "members": { + "ContainerName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The container name value to use for the service discovery service.

\n

If the task definition uses the bridge or host network mode, you must specify ContainerName and ContainerPort.

\n

If the task definition uses the awsvpc network mode and a type SRV DNS record, you must specify either ContainerName and ContainerPort, or Port , but not both.

" + } + }, + "ContainerPort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The port value to use for the service discovery service.

\n

If the task definition uses the bridge or host network mode, you must specify ContainerName and ContainerPort.

\n

If the task definition uses the awsvpc network mode and a type SRV DNS record, you must specify either ContainerName and ContainerPort, or Port , but not both.

" + } + }, + "Port": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The port value to use for a service discovery service that specifies an SRV record. This field can be used if both the awsvpcawsvpc network mode and SRV records are used.

" + } + }, + "RegistryArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the service registry.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a service discovery registry to assign to the service.

" + } + }, + "com.amazonaws.securityhub#AwsEcsServiceServiceRegistriesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsServiceServiceRegistriesDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails": { + "type": "structure", + "members": { + "Condition": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The dependency condition of the dependent container. Indicates the required status of the dependent container before the current container can start. Valid values are as follows:

\n " + } + }, + "ContainerName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the dependent container.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A dependency that is defined for container startup and shutdown.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsDependsOnList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsDetails": { + "type": "structure", + "members": { + "Command": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The command that is passed to the container.

" + } + }, + "Cpu": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of CPU units reserved for the container.

" + } + }, + "DependsOn": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsDependsOnList", + "traits": { + "smithy.api#documentation": "

The dependencies that are defined for container startup and shutdown.

" + } + }, + "DisableNetworking": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether to disable networking within the container.

" + } + }, + "DnsSearchDomains": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

A list of DNS search domains that are presented to the container.

" + } + }, + "DnsServers": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

A list of DNS servers that are presented to the container.

" + } + }, + "DockerLabels": { + "target": "com.amazonaws.securityhub#FieldMap", + "traits": { + "smithy.api#documentation": "

A key-value map of labels to add to the container.

" + } + }, + "DockerSecurityOptions": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems.

" + } + }, + "EntryPoint": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The entry point that is passed to the container.

" + } + }, + "Environment": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsEnvironmentList", + "traits": { + "smithy.api#documentation": "

The environment variables to pass to a container.

" + } + }, + "EnvironmentFiles": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesList", + "traits": { + "smithy.api#documentation": "

A list of files containing the environment variables to pass to a container.

" + } + }, + "Essential": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the container is essential. All tasks must have at least one essential container.

" + } + }, + "ExtraHosts": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsExtraHostsList", + "traits": { + "smithy.api#documentation": "

A list of hostnames and IP address mappings to append to the /etc/hosts file on the container.

" + } + }, + "FirelensConfiguration": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails", + "traits": { + "smithy.api#documentation": "

The FireLens configuration for the container. Specifies and configures a log router for container logs.

" + } + }, + "HealthCheck": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails", + "traits": { + "smithy.api#documentation": "

The container health check command and associated configuration parameters for the container.

" + } + }, + "Hostname": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The hostname to use for the container.

" + } + }, + "Image": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The image used to start the container.

" + } + }, + "Interactive": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

If set to true, then containerized applications can be deployed that require stdin or a tty to be allocated.

" + } + }, + "Links": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

A list of links for the container in the form \n container_name:alias\n . Allows containers to communicate with each other without the need for port mappings.

" + } + }, + "LinuxParameters": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails", + "traits": { + "smithy.api#documentation": "

Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.

" + } + }, + "LogConfiguration": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails", + "traits": { + "smithy.api#documentation": "

The log configuration specification for the container.

" + } + }, + "Memory": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount (in MiB) of memory to present to the container. If the container attempts to exceed the memory specified here, the container is shut down. The total amount of memory reserved for all containers within a task must be lower than the task memory value, if one is specified.

" + } + }, + "MemoryReservation": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The soft limit (in MiB) of memory to reserve for the container.

" + } + }, + "MountPoints": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsMountPointsList", + "traits": { + "smithy.api#documentation": "

The mount points for the data volumes in the container.

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the container.

" + } + }, + "PortMappings": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsPortMappingsList", + "traits": { + "smithy.api#documentation": "

The list of port mappings for the container.

" + } + }, + "Privileged": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the container is given elevated privileges on the host container instance. The elevated privileges are similar to the root user.

" + } + }, + "PseudoTerminal": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether to allocate a TTY to the container.

" + } + }, + "ReadonlyRootFilesystem": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the container is given read-only access to its root file system.

" + } + }, + "RepositoryCredentials": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails", + "traits": { + "smithy.api#documentation": "

The private repository authentication credentials to use.

" + } + }, + "ResourceRequirements": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsList", + "traits": { + "smithy.api#documentation": "

The type and amount of a resource to assign to a container. The only supported resource is a GPU.

" + } + }, + "Secrets": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsSecretsList", + "traits": { + "smithy.api#documentation": "

The secrets to pass to the container.

" + } + }, + "StartTimeout": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of seconds to wait before giving up on resolving dependencies for a container.

" + } + }, + "StopTimeout": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of seconds to wait before the container is stopped if it doesn't shut down normally on its own.

" + } + }, + "SystemControls": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsSystemControlsList", + "traits": { + "smithy.api#documentation": "

A list of namespaced kernel parameters to set in the container.

" + } + }, + "Ulimits": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsUlimitsList", + "traits": { + "smithy.api#documentation": "

A list of ulimits to set in the container.

" + } + }, + "User": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The user to use inside the container.

\n

The value can use one of the following formats.

\n " + } + }, + "VolumesFrom": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsVolumesFromList", + "traits": { + "smithy.api#documentation": "

Data volumes to mount from another container.

" + } + }, + "WorkingDirectory": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The working directory in which to run commands inside the container.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A container definition that describes a container in the task.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the environment variable.

" + } + }, + "Value": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The value of the environment variable.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An environment variable to pass to the container.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of environment file. The valid value is s3.

" + } + }, + "Value": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the S3 object that contains the environment variable file.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A file that contain environment variables to pass to a container.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsEnvironmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails": { + "type": "structure", + "members": { + "Hostname": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The hostname to use in the /etc/hosts entry.

" + } + }, + "IpAddress": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The IP address to use in the /etc/hosts entry.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A hostname and IP address mapping to append to the /etc/hosts file on the container.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsExtraHostsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails": { + "type": "structure", + "members": { + "Options": { + "target": "com.amazonaws.securityhub#FieldMap", + "traits": { + "smithy.api#documentation": "

The options to use to configure the log router.

\n

The valid option keys are as follows:

\n " + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The log router to use. Valid values are fluentbit or fluentd.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The FireLens configuration for the container. The configuration specifies and configures a log router for container logs.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails": { + "type": "structure", + "members": { + "Command": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The command that the container runs to determine whether it is healthy.

" + } + }, + "Interval": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The time period in seconds between each health check execution. The default value is 30 seconds.

" + } + }, + "Retries": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of times to retry a failed health check before the container is considered unhealthy. The default value is 3.

" + } + }, + "StartPeriod": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The optional grace period in seconds that allows containers time to bootstrap before failed health checks count towards the maximum number of retries.

" + } + }, + "Timeout": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The time period in seconds to wait for a health check to succeed before it is considered a failure. The default value is 5.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The container health check command and associated configuration parameters for the container.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails": { + "type": "structure", + "members": { + "Add": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The Linux capabilities for the container that are added to the default configuration provided by Docker. Valid values are as follows:

\n

Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" |\n \t\t\"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" |\n \t\t\"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" |\n \t\t\"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" |\n \t\t\"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" |\n \t\t\t\"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" |\n \t\t\"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" |\n \t\t\"SETFCAP\" | \"SETGID\" | \"SETPCAP\" |\n \t\t\"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" |\n \t\t\"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" |\n \t\t\"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" |\n \t\t\"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" |\n \t\t\"SYSLOG\" | \"WAKE_ALARM\"\n

" + } + }, + "Drop": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The Linux capabilities for the container that are dropped from the default configuration provided by Docker.

\n

Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" |\n \t\t\"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" |\n \t\t\"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" |\n \t\t\"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" |\n \t\t\"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" |\n \t\t\t\"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" |\n \t\t\"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" |\n \t\t\"SETFCAP\" | \"SETGID\" | \"SETPCAP\" |\n \t\t\"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" |\n \t\t\"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" |\n \t\t\"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" |\n \t\t\"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" |\n \t\t\"SYSLOG\" | \"WAKE_ALARM\"\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails": { + "type": "structure", + "members": { + "Capabilities": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails", + "traits": { + "smithy.api#documentation": "

The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.

" + } + }, + "Devices": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesList", + "traits": { + "smithy.api#documentation": "

The host devices to expose to the container.

" + } + }, + "InitProcessEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether to run an init process inside the container that forwards signals and reaps processes.

" + } + }, + "MaxSwap": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total amount of swap memory (in MiB) that a container can use.

" + } + }, + "SharedMemorySize": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The value for the size (in MiB) of the /dev/shm volume.

" + } + }, + "Swappiness": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Configures the container's memory swappiness behavior. Determines how aggressively pages are swapped. The higher the value, the more aggressive the swappiness. The default is 60.

" + } + }, + "Tmpfs": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsList", + "traits": { + "smithy.api#documentation": "

The container path, mount options, and size (in MiB) of the tmpfs mount.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

>Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails": { + "type": "structure", + "members": { + "ContainerPath": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The path inside the container at which to expose the host device.

" + } + }, + "HostPath": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The path for the device on the host container instance.

" + } + }, + "Permissions": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#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.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A host device to expose to the container.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails": { + "type": "structure", + "members": { + "ContainerPath": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The absolute file path where the tmpfs volume is to be mounted.

" + } + }, + "MountOptions": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The list of tmpfs volume mount options.

\n

Valid values: \"defaults\" | \"ro\" | \"rw\" | \"suid\" |\n \t\t\"nosuid\" | \"dev\" | \"nodev\" | \"exec\" |\n \t\t\"noexec\" | \"sync\" | \"async\" | \"dirsync\"\n \t\t| \"remount\" | \"mand\" | \"nomand\" | \"atime\"\n \t\t| \"noatime\" | \"diratime\" | \"nodiratime\" |\n \t\t\"bind\" | \"rbind\" | \"unbindable\" |\n \t\t\"runbindable\" | \"private\" | \"rprivate\" |\n \t\t\"shared\" | \"rshared\" | \"slave\" |\n \t\t\"rslave\" | \"relatime\" | \"norelatime\" |\n \t\t\"strictatime\" | \"nostrictatime\" | \"mode\" |\n \t\t\"uid\" | \"gid\" | \"nr_inodes\" |\n \t\t\t\"nr_blocks\" | \"mpol\"\n

" + } + }, + "Size": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum size (in MiB) of the tmpfs volume.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The container path, mount options, and size (in MiB) of a tmpfs mount.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails": { + "type": "structure", + "members": { + "LogDriver": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The log driver to use for the container.

\n

Valid values on Fargate are as follows:

\n \n

Valid values on Amazon EC2 are as follows:

\n " + } + }, + "Options": { + "target": "com.amazonaws.securityhub#FieldMap", + "traits": { + "smithy.api#documentation": "

The configuration options to send to the log driver. Requires version 1.19 of the Docker Remote API or greater on your container instance.

" + } + }, + "SecretOptions": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsList", + "traits": { + "smithy.api#documentation": "

The secrets to pass to the log configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The log configuration specification for the container.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsDetails": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the secret.

" + } + }, + "ValueFrom": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The secret to expose to the container.

\n

The value is either the full ARN of the Secrets Manager secret or the full ARN of the\n parameter in the Systems Manager Parameter Store.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A secret to pass to the log configuration.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails": { + "type": "structure", + "members": { + "ContainerPath": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The path on the container to mount the host volume at.

" + } + }, + "ReadOnly": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the container has read-only access to the volume.

" + } + }, + "SourceVolume": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the volume to mount. Must match the name of a volume listed in VolumeDetails for the task definition.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A mount point for the data volumes in the container.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsMountPointsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails": { + "type": "structure", + "members": { + "ContainerPort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The port number on the container that is bound to the user-specified or automatically assigned host port.

" + } + }, + "HostPort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The port number on the container instance to reserve for the container.

" + } + }, + "Protocol": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The protocol used for the port mapping. The default is tcp.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A port mapping for the container.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsPortMappingsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails": { + "type": "structure", + "members": { + "CredentialsParameter": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the secret that contains the private repository credentials.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The private repository authentication credentials to use.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of resource to assign to a container. Valid values are GPU or InferenceAccelerator.

" + } + }, + "Value": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The value for the specified resource type.

\n

For GPU, the value is the number of physical GPUs the Amazon ECS container agent\n reserves for the container.

\n

For InferenceAccelerator, the value should match the DeviceName\n attribute of an entry in InferenceAccelerators.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A resource to assign to a container.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the secret.

" + } + }, + "ValueFrom": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The secret to expose to the container. The value is either the full ARN of the Secrets Manager\n secret or the full ARN of the parameter in the Systems Manager Parameter Store.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A secret to pass to the container.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsSecretsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails": { + "type": "structure", + "members": { + "Namespace": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The namespaced kernel parameter for which to set a value.

" + } + }, + "Value": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The value of the parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A namespaced kernel parameter to set in the container.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsSystemControlsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails": { + "type": "structure", + "members": { + "HardLimit": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The hard limit for the ulimit type.

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of the ulimit. Valid values are as follows:

\n " + } + }, + "SoftLimit": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The soft limit for the ulimit type.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A ulimit to set in the container.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsUlimitsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails": { + "type": "structure", + "members": { + "ReadOnly": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the container has read-only access to the volume.

" + } + }, + "SourceContainer": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of another container within the same task definition from which to mount volumes.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A data volume to mount from another container.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsVolumesFromList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionDetails": { + "type": "structure", + "members": { + "ContainerDefinitions": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsList", + "traits": { + "smithy.api#documentation": "

The container definitions that describe the containers that make up the task.

" + } + }, + "Cpu": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The number of CPU units used by the task.Valid values are as follows:

\n " + } + }, + "ExecutionRoleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the task execution role that grants the container agent permission to make API calls on behalf of the container user.

" + } + }, + "Family": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of a family that this task definition is registered to.

" + } + }, + "InferenceAccelerators": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionInferenceAcceleratorsList", + "traits": { + "smithy.api#documentation": "

The Elastic Inference accelerators to use for the containers in the task.

" + } + }, + "IpcMode": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The inter-process communication (IPC) resource namespace to use for the containers in the task. Valid values are as follows:

\n " + } + }, + "Memory": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The amount (in MiB) of memory used by the task.

\n

For tasks that are hosted on Amazon EC2, you can provide a task-level memory value or a container-level memory value.\n For tasks that are hosted on Fargate, you must use one of the specified values in the \n Amazon Elastic Container Service Developer Guide\n , which determines your range of supported values for the Cpu and Memory parameters.

" + } + }, + "NetworkMode": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Docker networking mode to use for the containers in the task. Valid values are as follows:

\n " + } + }, + "PidMode": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The process namespace to use for the containers in the task. Valid values are host or task.

" + } + }, + "PlacementConstraints": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionPlacementConstraintsList", + "traits": { + "smithy.api#documentation": "

The placement constraint objects to use for tasks.

" + } + }, + "ProxyConfiguration": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionProxyConfigurationDetails", + "traits": { + "smithy.api#documentation": "

The configuration details for the App Mesh proxy.

" + } + }, + "RequiresCompatibilities": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The task launch types that the task definition was validated against.

" + } + }, + "TaskRoleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The short name or ARN of the IAM role that grants containers in the task permission to call Amazon Web Services API operations on your behalf.

" + } + }, + "Volumes": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionVolumesList", + "traits": { + "smithy.api#documentation": "

The data volume definitions for the task.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about a task definition. A task definition describes the container and volume definitions\n of an Amazon Elastic Container Service task.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionInferenceAcceleratorsDetails": { + "type": "structure", + "members": { + "DeviceName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Elastic Inference accelerator device name.

" + } + }, + "DeviceType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Elastic Inference accelerator type to use.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An Elastic Inference accelerator to use\n for the containers in the task.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionInferenceAcceleratorsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionInferenceAcceleratorsDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionPlacementConstraintsDetails": { + "type": "structure", + "members": { + "Expression": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A cluster query language expression to apply to the constraint.

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of constraint.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A placement constraint object to use for tasks.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionPlacementConstraintsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionPlacementConstraintsDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionProxyConfigurationDetails": { + "type": "structure", + "members": { + "ContainerName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the container that will serve as the App Mesh proxy.

" + } + }, + "ProxyConfigurationProperties": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesList", + "traits": { + "smithy.api#documentation": "

The set of network configuration parameters to provide to the Container Network Interface (CNI) plugin, specified as key-value pairs.

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The proxy type.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration details for the App Mesh\n proxy.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesDetails": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the property.

" + } + }, + "Value": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The value of the property.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A network configuration parameter to provide to the Container Network Interface (CNI) plugin.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionVolumesDetails": { + "type": "structure", + "members": { + "DockerVolumeConfiguration": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails", + "traits": { + "smithy.api#documentation": "

Information about a Docker volume.

" + } + }, + "EfsVolumeConfiguration": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails", + "traits": { + "smithy.api#documentation": "

Information about the Amazon Elastic File System file system that is used for task storage.

" + } + }, + "Host": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionVolumesHostDetails", + "traits": { + "smithy.api#documentation": "

Information about a bind mount host volume.

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the data volume.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A data volume to mount from another container.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails": { + "type": "structure", + "members": { + "Autoprovision": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether to create the Docker volume automatically if it does not already exist.

" + } + }, + "Driver": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Docker volume driver to use.

" + } + }, + "DriverOpts": { + "target": "com.amazonaws.securityhub#FieldMap", + "traits": { + "smithy.api#documentation": "

A map of Docker driver-specific options that are passed through.

" + } + }, + "Labels": { + "target": "com.amazonaws.securityhub#FieldMap", + "traits": { + "smithy.api#documentation": "

Custom metadata to add to the Docker volume.

" + } + }, + "Scope": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task are provisioned \nautomatically when the task starts and destroyed when the task stops. Docker volumes that are shared persist after the task stops. Valid values are shared or task.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a Docker volume.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationAuthorizationConfigDetails": { + "type": "structure", + "members": { + "AccessPointId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon EFS access point identifier to use.

" + } + }, + "Iam": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Whether to use the Amazon ECS task IAM role defined in a task definition when mounting the Amazon EFS file system.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails": { + "type": "structure", + "members": { + "AuthorizationConfig": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationAuthorizationConfigDetails", + "traits": { + "smithy.api#documentation": "

The authorization configuration details for the Amazon EFS file system.

" + } + }, + "FilesystemId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon EFS file system identifier to use.

" + } + }, + "RootDirectory": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The directory within the Amazon EFS file system to mount as the root directory inside the host.

" + } + }, + "TransitEncryption": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server.

" + } + }, + "TransitEncryptionPort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the Amazon Elastic File System file system that is used for task storage.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionVolumesHostDetails": { + "type": "structure", + "members": { + "SourcePath": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The path on the host container instance that is presented to the container.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a bind mount host volume.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionVolumesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionVolumesDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDetails": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster that hosts the task.\n

" + } + }, + "TaskDefinitionArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the task definition that creates the task.\n

" + } + }, + "Version": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The version counter for the task.\n

" + } + }, + "CreatedAt": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Unix timestamp for the time when the task was created. More specifically, it's for the time when \nthe task entered the PENDING state.\n

" + } + }, + "StartedAt": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Unix timestamp for the time when the task started. More specifically, it's for the time when the \n task transitioned from the PENDING state to the RUNNING state.\n

" + } + }, + "StartedBy": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The tag specified when a task is started. If an Amazon ECS service started the task, the \n startedBy parameter contains the deployment ID of that service.\n

" + } + }, + "Group": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the task group that's associated with the task.\n

" + } + }, + "Volumes": { + "target": "com.amazonaws.securityhub#AwsEcsTaskVolumeDetailsList", + "traits": { + "smithy.api#documentation": "

Details about the data volume that is used in a task definition.\n

" + } + }, + "Containers": { + "target": "com.amazonaws.securityhub#AwsEcsContainerDetailsList", + "traits": { + "smithy.api#documentation": "

The containers that are associated with the task.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about a task in a cluster.\n

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskVolumeDetails": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and \nhyphens are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.\n

" + } + }, + "Host": { + "target": "com.amazonaws.securityhub#AwsEcsTaskVolumeHostDetails", + "traits": { + "smithy.api#documentation": "

This parameter is specified when you use bind mount host volumes. The contents of the host parameter \ndetermine whether your bind mount host volume persists on the host container instance and where it's stored. \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about a data volume that's used in a task definition.\n

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskVolumeDetailsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsTaskVolumeDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskVolumeHostDetails": { + "type": "structure", + "members": { + "SourcePath": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

When the host parameter is used, specify a sourcePath to declare the path \non the host container instance that's presented to the container.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details on a container instance bind mount host volume.\n

" + } + }, + "com.amazonaws.securityhub#AwsEfsAccessPointDetails": { + "type": "structure", + "members": { + "AccessPointId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon EFS access point.\n

" + } + }, + "Arn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon EFS access point.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The opaque string specified in the request to ensure idempotent creation.\n

" + } + }, + "FileSystemId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon EFS file system that the access point applies to.\n

" + } + }, + "PosixUser": { + "target": "com.amazonaws.securityhub#AwsEfsAccessPointPosixUserDetails", + "traits": { + "smithy.api#documentation": "

The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point, \nthat is used for all file operations by NFS clients using the access point.\n

" + } + }, + "RootDirectory": { + "target": "com.amazonaws.securityhub#AwsEfsAccessPointRootDirectoryDetails", + "traits": { + "smithy.api#documentation": "

The directory on the Amazon EFS file system that the access point exposes as the root \ndirectory to NFS clients using the access point.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about an Amazon EFS access point.\n

" + } + }, + "com.amazonaws.securityhub#AwsEfsAccessPointPosixUserDetails": { + "type": "structure", + "members": { + "Gid": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The POSIX group ID used for all file system operations using this access point.\n

" + } + }, + "SecondaryGids": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

Secondary POSIX group IDs used for all file system operations using this access point.\n

" + } + }, + "Uid": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The POSIX user ID used for all file system operations using this access point.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details for all file system operations using this Amazon EFS access point.\n

" + } + }, + "com.amazonaws.securityhub#AwsEfsAccessPointRootDirectoryCreationInfoDetails": { + "type": "structure", + "members": { + "OwnerGid": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Specifies the POSIX group ID to apply to the root directory. \n

" + } + }, + "OwnerUid": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Specifies the POSIX user ID to apply to the root directory.\n

" + } + }, + "Permissions": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Specifies the POSIX permissions to apply to the root directory, in the format of an octal number \nrepresenting the file's mode bits.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the settings that Amazon EFS uses to create the root directory \nwhen a client connects to an access point.\n

" + } + }, + "com.amazonaws.securityhub#AwsEfsAccessPointRootDirectoryDetails": { + "type": "structure", + "members": { + "CreationInfo": { + "target": "com.amazonaws.securityhub#AwsEfsAccessPointRootDirectoryCreationInfoDetails", + "traits": { + "smithy.api#documentation": "

Specifies the POSIX IDs and permissions to apply to the access point's root directory.\n

" + } + }, + "Path": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Specifies the path on the Amazon EFS file system to expose as the root directory to NFS clients \nusing the access point to access the EFS file system. A path can have up to four subdirectories. If the specified \npath does not exist, you are required to provide CreationInfo.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the directory on the Amazon EFS file system that the access point exposes \nas the root directory to NFS clients using the access point.\n

" + } + }, + "com.amazonaws.securityhub#AwsEksClusterDetails": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the cluster.

" + } + }, + "CertificateAuthorityData": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The certificate authority data for the cluster.

" + } + }, + "ClusterStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of the cluster. Valid values are as follows:

\n " + } + }, + "Endpoint": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The endpoint for the Amazon EKS API server.

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the cluster.

" + } + }, + "ResourcesVpcConfig": { + "target": "com.amazonaws.securityhub#AwsEksClusterResourcesVpcConfigDetails", + "traits": { + "smithy.api#documentation": "

The VPC configuration used by the cluster control plane.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role that provides permissions for the Amazon EKS control plane to make calls to Amazon Web Services API operations on your behalf.

" + } + }, + "Version": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon EKS server version for the cluster.

" + } + }, + "Logging": { + "target": "com.amazonaws.securityhub#AwsEksClusterLoggingDetails", + "traits": { + "smithy.api#documentation": "

The logging configuration for the cluster.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about an Amazon EKS cluster.

" + } + }, + "com.amazonaws.securityhub#AwsEksClusterLoggingClusterLoggingDetails": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the logging types that are listed in Types are enabled.

" + } + }, + "Types": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

A list of logging types. Valid values are as follows:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Details for a cluster logging configuration.

" + } + }, + "com.amazonaws.securityhub#AwsEksClusterLoggingClusterLoggingList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEksClusterLoggingClusterLoggingDetails" + } + }, + "com.amazonaws.securityhub#AwsEksClusterLoggingDetails": { + "type": "structure", + "members": { + "ClusterLogging": { + "target": "com.amazonaws.securityhub#AwsEksClusterLoggingClusterLoggingList", + "traits": { + "smithy.api#documentation": "

Cluster logging configurations.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The logging configuration for an Amazon EKS cluster.

" + } + }, + "com.amazonaws.securityhub#AwsEksClusterResourcesVpcConfigDetails": { + "type": "structure", + "members": { + "SecurityGroupIds": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The security groups that are associated with the cross-account elastic network interfaces that are used to allow communication between your nodes and the Amazon EKS control plane.

" + } + }, + "SubnetIds": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The subnets that are associated with the cluster.

" + } + }, + "EndpointPublicAccess": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Indicates whether the Amazon EKS public API server endpoint is turned on. If the Amazon EKS public API \n server endpoint is turned off, your cluster's Kubernetes API server can only receive requests that originate from within \n the cluster VPC.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the VPC configuration used by the cluster control plane.

" + } + }, + "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentDetails": { + "type": "structure", + "members": { + "ApplicationName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the application that is associated with the environment.

" + } + }, + "Cname": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The URL to the CNAME for this environment.

" + } + }, + "DateCreated": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The creation date for this environment.

" + } + }, + "DateUpdated": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The date when this environment was last modified.

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A description of the environment.

" + } + }, + "EndpointUrl": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

For load-balanced, autoscaling environments, the URL to the load balancer. For single-instance environments, the IP address of the instance.

" + } + }, + "EnvironmentArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the environment.

" + } + }, + "EnvironmentId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the environment.

" + } + }, + "EnvironmentLinks": { + "target": "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentEnvironmentLinks", + "traits": { + "smithy.api#documentation": "

Links to other environments in the same group.

" + } + }, + "EnvironmentName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the environment.

" + } + }, + "OptionSettings": { + "target": "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentOptionSettings", + "traits": { + "smithy.api#documentation": "

The configuration setting for the environment.

" + } + }, + "PlatformArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the platform version for the environment.

" + } + }, + "SolutionStackName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the solution stack that is deployed with the environment.

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The current operational status of the environment. Valid values are as follows:

\n " + } + }, + "Tier": { + "target": "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentTier", + "traits": { + "smithy.api#documentation": "

The tier of the environment.

" + } + }, + "VersionLabel": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The application version of the environment.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about an Elastic Beanstalk environment.

" + } + }, + "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentEnvironmentLink": { + "type": "structure", + "members": { + "EnvironmentName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the linked environment.

" + } + }, + "LinkName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the environment link.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a link to another environment that is in the same group.

" + } + }, + "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentEnvironmentLinks": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentEnvironmentLink" + } + }, + "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentOptionSetting": { + "type": "structure", + "members": { + "Namespace": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of resource that the configuration option is associated with.

" + } + }, + "OptionName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the option.

" + } + }, + "ResourceName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the resource.

" + } + }, + "Value": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The value of the configuration setting.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A configuration option setting for the environment.

" + } + }, + "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentOptionSettings": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentOptionSetting" + } + }, + "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentTier": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the environment tier. Valid values are WebServer or Worker.

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of environment tier. Valid values are Standard or SQS/HTTP.

" + } + }, + "Version": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The version of the environment tier.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the tier of the environment.

" + } + }, + "com.amazonaws.securityhub#AwsElasticsearchDomainDetails": { + "type": "structure", + "members": { + "AccessPolicies": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

IAM policy document specifying the access policies for the new Elasticsearch domain.

" + } + }, + "DomainEndpointOptions": { + "target": "com.amazonaws.securityhub#AwsElasticsearchDomainDomainEndpointOptions", + "traits": { + "smithy.api#documentation": "

Additional options for the domain endpoint.

" + } + }, + "DomainId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Unique identifier for an Elasticsearch domain.

" + } + }, + "DomainName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Name of an Elasticsearch domain.

\n

Domain names are unique across all domains owned by the same account within an Amazon Web Services\n Region.

\n

Domain names must start with a lowercase letter and must be between 3 and 28\n characters.

\n

Valid characters are a-z (lowercase only), 0-9, and – (hyphen).

" + } + }, + "Endpoint": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Domain-specific endpoint used to submit index, search, and data upload requests to an\n Elasticsearch domain.

\n

The endpoint is a service URL.

" + } + }, + "Endpoints": { + "target": "com.amazonaws.securityhub#FieldMap", + "traits": { + "smithy.api#documentation": "

The key-value pair that exists if the Elasticsearch domain uses VPC endpoints.

" + } + }, + "ElasticsearchVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

OpenSearch version.

" + } + }, + "ElasticsearchClusterConfig": { + "target": "com.amazonaws.securityhub#AwsElasticsearchDomainElasticsearchClusterConfigDetails", + "traits": { + "smithy.api#documentation": "

Information about an OpenSearch cluster configuration.

" + } + }, + "EncryptionAtRestOptions": { + "target": "com.amazonaws.securityhub#AwsElasticsearchDomainEncryptionAtRestOptions", + "traits": { + "smithy.api#documentation": "

Details about the configuration for encryption at rest.

" + } + }, + "LogPublishingOptions": { + "target": "com.amazonaws.securityhub#AwsElasticsearchDomainLogPublishingOptions", + "traits": { + "smithy.api#documentation": "

Configures the CloudWatch Logs to publish for the Elasticsearch domain.

" + } + }, + "NodeToNodeEncryptionOptions": { + "target": "com.amazonaws.securityhub#AwsElasticsearchDomainNodeToNodeEncryptionOptions", + "traits": { + "smithy.api#documentation": "

Details about the configuration for node-to-node encryption.

" + } + }, + "ServiceSoftwareOptions": { + "target": "com.amazonaws.securityhub#AwsElasticsearchDomainServiceSoftwareOptions", + "traits": { + "smithy.api#documentation": "

Information about the status of a domain relative to the latest service software.

" + } + }, + "VPCOptions": { + "target": "com.amazonaws.securityhub#AwsElasticsearchDomainVPCOptions", + "traits": { + "smithy.api#documentation": "

Information that OpenSearch derives based on VPCOptions for the\n domain.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an Elasticsearch domain.

" + } + }, + "com.amazonaws.securityhub#AwsElasticsearchDomainDomainEndpointOptions": { + "type": "structure", + "members": { + "EnforceHTTPS": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether to require that all traffic to the domain arrive over HTTPS.

" + } + }, + "TLSSecurityPolicy": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The TLS security policy to apply to the HTTPS endpoint of the OpenSearch\n domain.

\n

Valid values:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Additional options for the domain endpoint, such as whether to require HTTPS for all\n traffic.

" + } + }, + "com.amazonaws.securityhub#AwsElasticsearchDomainElasticsearchClusterConfigDetails": { + "type": "structure", + "members": { + "DedicatedMasterCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of instances to use for the master node. If this attribute is specified, then DedicatedMasterEnabled must be true.

" + } + }, + "DedicatedMasterEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether to use a dedicated master node for the Elasticsearch domain. A dedicated master node performs cluster management tasks, but doesn't hold data or respond to data upload requests.

" + } + }, + "DedicatedMasterType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The hardware configuration of the computer that hosts the dedicated master node. A sample value is m3.medium.elasticsearch. If this attribute is specified, then DedicatedMasterEnabled must be true.

\n

For a list of valid values, see Supported instance types in Amazon OpenSearch Service in the Amazon OpenSearch Service Developer Guide.

" + } + }, + "InstanceCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of data nodes to use in the Elasticsearch domain.

" + } + }, + "InstanceType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The instance type for your data nodes. For example, m3.medium.elasticsearch.

\n

For a list of valid values, see Supported instance types in Amazon OpenSearch Service in the Amazon OpenSearch Service Developer Guide.

" + } + }, + "ZoneAwarenessConfig": { + "target": "com.amazonaws.securityhub#AwsElasticsearchDomainElasticsearchClusterConfigZoneAwarenessConfigDetails", + "traits": { + "smithy.api#documentation": "

Configuration options for zone awareness. Provided if ZoneAwarenessEnabled is true.

" + } + }, + "ZoneAwarenessEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether to enable zone awareness for the Elasticsearch domain. When zone awareness is enabled, OpenSearch allocates the cluster's nodes and replica index shards across Availability Zones in the same Region. This prevents data loss and minimizes downtime if a node or data center fails.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

details about the configuration of an OpenSearch cluster.

" + } + }, + "com.amazonaws.securityhub#AwsElasticsearchDomainElasticsearchClusterConfigZoneAwarenessConfigDetails": { + "type": "structure", + "members": { + "AvailabilityZoneCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

he number of Availability Zones that the domain uses. Valid values are 2 and 3. The default is 2.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration options for zone awareness.

" + } + }, + "com.amazonaws.securityhub#AwsElasticsearchDomainEncryptionAtRestOptions": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether encryption at rest is enabled.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the configuration for encryption at rest.

" + } + }, + "com.amazonaws.securityhub#AwsElasticsearchDomainLogPublishingOptions": { + "type": "structure", + "members": { + "IndexSlowLogs": { + "target": "com.amazonaws.securityhub#AwsElasticsearchDomainLogPublishingOptionsLogConfig", + "traits": { + "smithy.api#documentation": "

Configures the OpenSearch index logs\n publishing.

" + } + }, + "SearchSlowLogs": { + "target": "com.amazonaws.securityhub#AwsElasticsearchDomainLogPublishingOptionsLogConfig", + "traits": { + "smithy.api#documentation": "

Configures the OpenSearch search slow log\n publishing.

" + } + }, + "AuditLogs": { + "target": "com.amazonaws.securityhub#AwsElasticsearchDomainLogPublishingOptionsLogConfig" + } + }, + "traits": { + "smithy.api#documentation": "

configures the CloudWatch Logs to publish for the\n Elasticsearch domain.

" + } + }, + "com.amazonaws.securityhub#AwsElasticsearchDomainLogPublishingOptionsLogConfig": { + "type": "structure", + "members": { + "CloudWatchLogsLogGroupArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the CloudWatch Logs group to publish the logs to.

" + } + }, + "Enabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the log publishing is enabled.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The log configuration.

" + } + }, + "com.amazonaws.securityhub#AwsElasticsearchDomainNodeToNodeEncryptionOptions": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether node-to-node encryption is enabled.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the configuration for node-to-node encryption.

" + } + }, + "com.amazonaws.securityhub#AwsElasticsearchDomainServiceSoftwareOptions": { + "type": "structure", + "members": { + "AutomatedUpdateDate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The epoch time when the deployment window closes for required updates. After this time,\n Amazon OpenSearch Service schedules the software upgrade automatically.

" + } + }, + "Cancellable": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether a request to update the domain can be canceled.

" + } + }, + "CurrentVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The version of the service software that is currently installed on the domain.

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A more detailed description of the service software status.

" + } + }, + "NewVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The most recent version of the service software.

" + } + }, + "UpdateAvailable": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether a service software update is available for the domain.

" + } + }, + "UpdateStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of the service software update. Valid values are as follows:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the state of the domain relative to the latest service software.

" + } + }, + "com.amazonaws.securityhub#AwsElasticsearchDomainVPCOptions": { + "type": "structure", + "members": { + "AvailabilityZones": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The list of Availability Zones associated with the VPC subnets.

" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The list of security group IDs associated with the VPC endpoints for the domain.

" + } + }, + "SubnetIds": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

A list of subnet IDs associated with the VPC endpoints for the domain.

" + } + }, + "VPCId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

ID for the VPC.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information that OpenSearch derives based on VPCOptions for the\n domain.

" + } + }, + "com.amazonaws.securityhub#AwsElbAppCookieStickinessPolicies": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsElbAppCookieStickinessPolicy" + } + }, + "com.amazonaws.securityhub#AwsElbAppCookieStickinessPolicy": { + "type": "structure", + "members": { + "CookieName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the application cookie used for stickiness.

" + } + }, + "PolicyName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The mnemonic name for the policy being created. The name must be unique within the set\n of policies for the load balancer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a stickiness policy that was created using\n CreateAppCookieStickinessPolicy.

" + } + }, + "com.amazonaws.securityhub#AwsElbLbCookieStickinessPolicies": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsElbLbCookieStickinessPolicy" + } + }, + "com.amazonaws.securityhub#AwsElbLbCookieStickinessPolicy": { + "type": "structure", + "members": { + "CookieExpirationPeriod": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount of time, in seconds, after which the cookie is considered stale. If an\n expiration period is not specified, the stickiness session lasts for the duration of the\n browser session.

" + } + }, + "PolicyName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the policy. The name must be unique within the set of policies for the load\n balancer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a stickiness policy that was created using\n CreateLBCookieStickinessPolicy.

" + } + }, + "com.amazonaws.securityhub#AwsElbLoadBalancerAccessLog": { + "type": "structure", + "members": { + "EmitInterval": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The interval in minutes for publishing the access logs.

\n

You can publish access logs either every 5 minutes or every 60 minutes.

" + } + }, + "Enabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether access logs are enabled for the load balancer.

" + } + }, + "S3BucketName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the S3 bucket where the access logs are stored.

" + } + }, + "S3BucketPrefix": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The logical hierarchy that was created for the S3 bucket.

\n

If a prefix is not provided, the log is placed at the root level of the bucket.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the access log configuration for the load balancer.

" + } + }, + "com.amazonaws.securityhub#AwsElbLoadBalancerAdditionalAttribute": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the attribute.

" + } + }, + "Value": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The value of the attribute.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about additional attributes for the load balancer.

" + } + }, + "com.amazonaws.securityhub#AwsElbLoadBalancerAdditionalAttributeList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsElbLoadBalancerAdditionalAttribute" + } + }, + "com.amazonaws.securityhub#AwsElbLoadBalancerAttributes": { + "type": "structure", + "members": { + "AccessLog": { + "target": "com.amazonaws.securityhub#AwsElbLoadBalancerAccessLog", + "traits": { + "smithy.api#documentation": "

Information about the access log configuration for the load balancer.

\n

If the access log is enabled, the load balancer captures detailed information about all\n requests. It delivers the information to a specified S3 bucket.

" + } + }, + "ConnectionDraining": { + "target": "com.amazonaws.securityhub#AwsElbLoadBalancerConnectionDraining", + "traits": { + "smithy.api#documentation": "

Information about the connection draining configuration for the load balancer.

\n

If connection draining is enabled, the load balancer allows existing requests to\n complete before it shifts traffic away from a deregistered or unhealthy instance.

" + } + }, + "ConnectionSettings": { + "target": "com.amazonaws.securityhub#AwsElbLoadBalancerConnectionSettings", + "traits": { + "smithy.api#documentation": "

Connection settings for the load balancer.

\n

If an idle timeout is configured, the load balancer allows connections to remain idle\n for the specified duration. When a connection is idle, no data is sent over the\n connection.

" + } + }, + "CrossZoneLoadBalancing": { + "target": "com.amazonaws.securityhub#AwsElbLoadBalancerCrossZoneLoadBalancing", + "traits": { + "smithy.api#documentation": "

Cross-zone load balancing settings for the load balancer.

\n

If cross-zone load balancing is enabled, the load balancer routes the request traffic\n evenly across all instances regardless of the Availability Zones.

" + } + }, + "AdditionalAttributes": { + "target": "com.amazonaws.securityhub#AwsElbLoadBalancerAdditionalAttributeList", + "traits": { + "smithy.api#documentation": "

Any additional attributes for a load balancer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains attributes for the load balancer.

" + } + }, + "com.amazonaws.securityhub#AwsElbLoadBalancerBackendServerDescription": { + "type": "structure", + "members": { + "InstancePort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The port on which the EC2 instance is listening.

" + } + }, + "PolicyNames": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

The names of the policies that are enabled for the EC2 instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the configuration of an EC2 instance for the load\n balancer.

" + } + }, + "com.amazonaws.securityhub#AwsElbLoadBalancerBackendServerDescriptions": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsElbLoadBalancerBackendServerDescription" + } + }, + "com.amazonaws.securityhub#AwsElbLoadBalancerConnectionDraining": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether connection draining is enabled for the load balancer.

" + } + }, + "Timeout": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum time, in seconds, to keep the existing connections open before deregistering\n the instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the connection draining configuration for the load\n balancer.

" + } + }, + "com.amazonaws.securityhub#AwsElbLoadBalancerConnectionSettings": { + "type": "structure", + "members": { + "IdleTimeout": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The time, in seconds, that the connection can be idle (no data is sent over the\n connection) before it is closed by the load balancer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains connection settings for the load balancer.

" + } + }, + "com.amazonaws.securityhub#AwsElbLoadBalancerCrossZoneLoadBalancing": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether cross-zone load balancing is enabled for the load balancer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains cross-zone load balancing settings for the load balancer.

" + } + }, + "com.amazonaws.securityhub#AwsElbLoadBalancerDetails": { + "type": "structure", + "members": { + "AvailabilityZones": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

The list of Availability Zones for the load balancer.

" + } + }, + "BackendServerDescriptions": { + "target": "com.amazonaws.securityhub#AwsElbLoadBalancerBackendServerDescriptions", + "traits": { + "smithy.api#documentation": "

Information about the configuration of the EC2 instances.

" + } + }, + "CanonicalHostedZoneName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Route 53 hosted zone for the load balancer.

" + } + }, + "CanonicalHostedZoneNameID": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Route 53 hosted zone for the load balancer.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the load balancer was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "DnsName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The DNS name of the load balancer.

" + } + }, + "HealthCheck": { + "target": "com.amazonaws.securityhub#AwsElbLoadBalancerHealthCheck", + "traits": { + "smithy.api#documentation": "

Information about the health checks that are conducted on the load balancer.

" + } + }, + "Instances": { + "target": "com.amazonaws.securityhub#AwsElbLoadBalancerInstances", + "traits": { + "smithy.api#documentation": "

List of EC2 instances for the load balancer.

" + } + }, + "ListenerDescriptions": { + "target": "com.amazonaws.securityhub#AwsElbLoadBalancerListenerDescriptions", + "traits": { + "smithy.api#documentation": "

The policies that are enabled for the load balancer listeners.

" + } + }, + "LoadBalancerAttributes": { + "target": "com.amazonaws.securityhub#AwsElbLoadBalancerAttributes", + "traits": { + "smithy.api#documentation": "

The attributes for a load balancer.

" + } + }, + "LoadBalancerName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the load balancer.

" + } + }, + "Policies": { + "target": "com.amazonaws.securityhub#AwsElbLoadBalancerPolicies", + "traits": { + "smithy.api#documentation": "

The policies for a load balancer.

" + } + }, + "Scheme": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of load balancer. Only provided if the load balancer is in a VPC.

\n

If Scheme is internet-facing, the load balancer has a public\n DNS name that resolves to a public IP address.

\n

If Scheme is internal, the load balancer has a public DNS name\n that resolves to a private IP address.

" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

The security groups for the load balancer. Only provided if the load balancer is in a\n VPC.

" + } + }, + "SourceSecurityGroup": { + "target": "com.amazonaws.securityhub#AwsElbLoadBalancerSourceSecurityGroup", + "traits": { + "smithy.api#documentation": "

Information about the security group for the load balancer. This is the security group\n that is used for inbound rules.

" + } + }, + "Subnets": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

The list of subnet identifiers for the load balancer.

" + } + }, + "VpcId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the VPC for the load balancer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about a Classic Load Balancer.

" + } + }, + "com.amazonaws.securityhub#AwsElbLoadBalancerHealthCheck": { + "type": "structure", + "members": { + "HealthyThreshold": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of consecutive health check successes required before the instance is moved\n to the Healthy state.

" + } + }, + "Interval": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The approximate interval, in seconds, between health checks of an individual\n instance.

" + } + }, + "Target": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The instance that is being checked. The target specifies the protocol and port. The\n available protocols are TCP, SSL, HTTP, and HTTPS. The range of valid ports is 1 through\n 65535.

\n

For the HTTP and HTTPS protocols, the target also specifies the ping path.

\n

For the TCP protocol, the target is specified as TCP:\n \n .

\n

For the SSL protocol, the target is specified as\n SSL.\n .

\n

For the HTTP and HTTPS protocols, the target is specified as\n \n :/\n .

" + } + }, + "Timeout": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount of time, in seconds, during which no response means a failed health\n check.

" + } + }, + "UnhealthyThreshold": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of consecutive health check failures that must occur before the instance is\n moved to the Unhealthy state.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the health checks that are conducted on the load\n balancer.

" + } + }, + "com.amazonaws.securityhub#AwsElbLoadBalancerInstance": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The instance identifier.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about an EC2 instance for a load balancer.

" + } + }, + "com.amazonaws.securityhub#AwsElbLoadBalancerInstances": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsElbLoadBalancerInstance" + } + }, + "com.amazonaws.securityhub#AwsElbLoadBalancerListener": { + "type": "structure", + "members": { + "InstancePort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The port on which the instance is listening.

" + } + }, + "InstanceProtocol": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The protocol to use to route traffic to instances.

\n

Valid values: HTTP | HTTPS | TCP |\n SSL\n

" + } + }, + "LoadBalancerPort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The port on which the load balancer is listening.

\n

On EC2-VPC, you can specify any port from the range 1-65535.

\n

On EC2-Classic, you can specify any port from the following list: 25, 80, 443, 465, 587,\n 1024-65535.

" + } + }, + "Protocol": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The load balancer transport protocol to use for routing.

\n

Valid values: HTTP | HTTPS | TCP |\n SSL\n

" + } + }, + "SslCertificateId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the server certificate.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a load balancer listener.

" + } + }, + "com.amazonaws.securityhub#AwsElbLoadBalancerListenerDescription": { + "type": "structure", + "members": { + "Listener": { + "target": "com.amazonaws.securityhub#AwsElbLoadBalancerListener", + "traits": { + "smithy.api#documentation": "

Information about the listener.

" + } + }, + "PolicyNames": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

The policies enabled for the listener.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Lists the policies that are enabled for a load balancer listener.

" + } + }, + "com.amazonaws.securityhub#AwsElbLoadBalancerListenerDescriptions": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsElbLoadBalancerListenerDescription" + } + }, + "com.amazonaws.securityhub#AwsElbLoadBalancerPolicies": { + "type": "structure", + "members": { + "AppCookieStickinessPolicies": { + "target": "com.amazonaws.securityhub#AwsElbAppCookieStickinessPolicies", + "traits": { + "smithy.api#documentation": "

The stickiness policies that are created using\n CreateAppCookieStickinessPolicy.

" + } + }, + "LbCookieStickinessPolicies": { + "target": "com.amazonaws.securityhub#AwsElbLbCookieStickinessPolicies", + "traits": { + "smithy.api#documentation": "

The stickiness policies that are created using\n CreateLBCookieStickinessPolicy.

" + } + }, + "OtherPolicies": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

The policies other than the stickiness policies.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the policies for a load balancer.

" + } + }, + "com.amazonaws.securityhub#AwsElbLoadBalancerSourceSecurityGroup": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the security group.

" + } + }, + "OwnerAlias": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The owner of the security group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the security group for the load balancer.

" + } + }, + "com.amazonaws.securityhub#AwsElbv2LoadBalancerAttribute": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the load balancer attribute.

" + } + }, + "Value": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The value of the load balancer attribute.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A load balancer attribute.

" + } + }, + "com.amazonaws.securityhub#AwsElbv2LoadBalancerAttributes": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsElbv2LoadBalancerAttribute" + } + }, + "com.amazonaws.securityhub#AwsElbv2LoadBalancerDetails": { + "type": "structure", + "members": { + "AvailabilityZones": { + "target": "com.amazonaws.securityhub#AvailabilityZones", + "traits": { + "smithy.api#documentation": "

The Availability Zones for the load balancer.

" + } + }, + "CanonicalHostedZoneId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Route 53 hosted zone associated with the load balancer.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the load balancer was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "DNSName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The public DNS name of the load balancer.

" + } + }, + "IpAddressType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of IP addresses used by the subnets for your load balancer. The possible values\n are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6\n addresses).

" + } + }, + "Scheme": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The nodes of an Internet-facing load balancer have public IP addresses.

" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.securityhub#SecurityGroups", + "traits": { + "smithy.api#documentation": "

The IDs of the security groups for the load balancer.

" + } + }, + "State": { + "target": "com.amazonaws.securityhub#LoadBalancerState", + "traits": { + "smithy.api#documentation": "

The state of the load balancer.

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of load balancer.

" + } + }, + "VpcId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the VPC for the load balancer.

" + } + }, + "LoadBalancerAttributes": { + "target": "com.amazonaws.securityhub#AwsElbv2LoadBalancerAttributes", + "traits": { + "smithy.api#documentation": "

Attributes of the load balancer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a load balancer.

" + } + }, + "com.amazonaws.securityhub#AwsEventSchemasRegistryDetails": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n A description of the registry to be created. \n

" + } + }, + "RegistryArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the registry. \n

" + } + }, + "RegistryName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The name of the schema registry. \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n A schema defines the structure of events that are sent to Amazon EventBridge. Schema registries are containers for \n schemas. They collect and organize schemas so that your schemas are in logical groups. \n

" + } + }, + "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesCloudTrailDetails": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Specifies whether CloudTrail is activated as a data source for the detector. \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n An object that contains information on the status of CloudTrail as a data source for the detector. \n

" + } + }, + "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesDetails": { + "type": "structure", + "members": { + "CloudTrail": { + "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesCloudTrailDetails", + "traits": { + "smithy.api#documentation": "

\n An object that contains information on the status of CloudTrail as a data source for the detector. \n

" + } + }, + "DnsLogs": { + "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesDnsLogsDetails", + "traits": { + "smithy.api#documentation": "

\n An object that contains information on the status of DNS logs as a data source for the detector.\n

" + } + }, + "FlowLogs": { + "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesFlowLogsDetails", + "traits": { + "smithy.api#documentation": "

\n An object that contains information on the status of VPC Flow Logs as a data source for the detector.\n

" + } + }, + "Kubernetes": { + "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesKubernetesDetails", + "traits": { + "smithy.api#documentation": "

\n An object that contains information on the status of Kubernetes data sources for the detector.\n

" + } + }, + "MalwareProtection": { + "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesMalwareProtectionDetails", + "traits": { + "smithy.api#documentation": "

\n An object that contains information on the status of Malware Protection as a data source for the detector.\n

" + } + }, + "S3Logs": { + "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesS3LogsDetails", + "traits": { + "smithy.api#documentation": "

\n An object that contains information on the status of S3 Data event logs as a data source for the detector.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Describes which data sources are activated for the detector. \n

" + } + }, + "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesDnsLogsDetails": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Describes whether DNS logs is enabled as a data source for the detector.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n An object that contains information on the status of DNS logs as a data source for the detector.\n

" + } + }, + "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesFlowLogsDetails": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Describes whether VPC Flow Logs are activated as a data source for the detector.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n An object that contains information on the status of VPC Flow Logs as a data source for the detector.\n

" + } + }, + "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesKubernetesAuditLogsDetails": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Describes whether Kubernetes audit logs are activated as a data source for the detector.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n An object that contains information on the status of Kubernetes audit logs as a data source for the detector.\n

" + } + }, + "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesKubernetesDetails": { + "type": "structure", + "members": { + "AuditLogs": { + "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesKubernetesAuditLogsDetails", + "traits": { + "smithy.api#documentation": "

\n Describes whether Kubernetes audit logs are activated as a data source for the detector.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n An object that contains information on the status of Kubernetes data sources for the detector.\n

" + } + }, + "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesMalwareProtectionDetails": { + "type": "structure", + "members": { + "ScanEc2InstanceWithFindings": { + "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsDetails", + "traits": { + "smithy.api#documentation": "

\n Describes the configuration of Malware Protection for EC2 instances with findings.\n

" + } + }, + "ServiceRole": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The GuardDuty Malware Protection service role.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n An object that contains information on the status of Malware Protection as a data source for the detector.\n

" + } + }, + "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsDetails": { + "type": "structure", + "members": { + "EbsVolumes": { + "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumesDetails", + "traits": { + "smithy.api#documentation": "

\n Describes the configuration of scanning EBS volumes (Malware Protection) as a data source.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Describes the configuration of Malware Protection for EC2 instances with findings.\n

" + } + }, + "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumesDetails": { + "type": "structure", + "members": { + "Reason": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Specifies the reason why scanning EBS volumes (Malware Protection) isn’t activated as a data source.\n

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Describes whether scanning EBS volumes is activated as a data source for the detector.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Describes the configuration of scanning EBS volumes (Malware Protection) as a data source.\n

" + } + }, + "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesS3LogsDetails": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n A value that describes whether S3 data event logs are automatically enabled for new members of an organization.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n An object that contains information on the status of S3 data event logs as a data source for the detector.\n

" + } + }, + "com.amazonaws.securityhub#AwsGuardDutyDetectorDetails": { + "type": "structure", + "members": { + "DataSources": { + "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesDetails", + "traits": { + "smithy.api#documentation": "

\n Describes which data sources are activated for the detector.\n

" + } + }, + "Features": { + "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorFeaturesList", + "traits": { + "smithy.api#documentation": "

\n Describes which features are activated for the detector.\n

" + } + }, + "FindingPublishingFrequency": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The publishing frequency of the finding.\n

" + } + }, + "ServiceRole": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The GuardDuty service role.\n

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The activation status of the detector.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides details about an Amazon GuardDuty detector. A detector is an object that represents the GuardDuty service. A detector is required for GuardDuty to become operational.\n

" + } + }, + "com.amazonaws.securityhub#AwsGuardDutyDetectorFeaturesDetails": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Indicates the name of the feature that is activated for the detector.\n

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Indicates the status of the feature that is activated for the detector.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Describes which features are activated for the detector.\n

" + } + }, + "com.amazonaws.securityhub#AwsGuardDutyDetectorFeaturesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorFeaturesDetails" + } + }, + "com.amazonaws.securityhub#AwsIamAccessKeyDetails": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#deprecated": { + "message": "This filter is deprecated. Instead, use PrincipalName." + }, + "smithy.api#documentation": "

The user associated with the IAM access key related to a finding.

\n

The UserName parameter has been replaced with the\n PrincipalName parameter because access keys can also be assigned to\n principals that are not IAM users.

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#AwsIamAccessKeyStatus", + "traits": { + "smithy.api#documentation": "

The status of the IAM access key related to a finding.

" + } + }, + "CreatedAt": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the IAM access key was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "PrincipalId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the principal associated with an access key.

" + } + }, + "PrincipalType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of principal associated with an access key.

" + } + }, + "PrincipalName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the principal.

" + } + }, + "AccountId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the account for the key.

" + } + }, + "AccessKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the access key.

" + } + }, + "SessionContext": { + "target": "com.amazonaws.securityhub#AwsIamAccessKeySessionContext", + "traits": { + "smithy.api#documentation": "

Information about the session that the key was used for.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

IAM access key details related to a finding.

" + } + }, + "com.amazonaws.securityhub#AwsIamAccessKeySessionContext": { + "type": "structure", + "members": { + "Attributes": { + "target": "com.amazonaws.securityhub#AwsIamAccessKeySessionContextAttributes", + "traits": { + "smithy.api#documentation": "

Attributes of the session that the key was used for.

" + } + }, + "SessionIssuer": { + "target": "com.amazonaws.securityhub#AwsIamAccessKeySessionContextSessionIssuer", + "traits": { + "smithy.api#documentation": "

Information about the entity that created the session.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the session that the key was used for.

" + } + }, + "com.amazonaws.securityhub#AwsIamAccessKeySessionContextAttributes": { + "type": "structure", + "members": { + "MfaAuthenticated": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the session used multi-factor authentication (MFA).

" + } + }, + "CreationDate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the session was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Attributes of the session that the key was used for.

" + } + }, + "com.amazonaws.securityhub#AwsIamAccessKeySessionContextSessionIssuer": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of principal (user, role, or group) that created the session.

" + } + }, + "PrincipalId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The principal ID of the principal (user, role, or group) that created the\n session.

" + } + }, + "Arn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the session.

" + } + }, + "AccountId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Web Services account that created the session.

" + } + }, + "UserName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the principal that created the session.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the entity that created the session.

" + } + }, + "com.amazonaws.securityhub#AwsIamAccessKeyStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + }, + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Inactive" + } + } + } + }, + "com.amazonaws.securityhub#AwsIamAttachedManagedPolicy": { + "type": "structure", + "members": { + "PolicyName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the policy.

" + } + }, + "PolicyArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the policy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A managed policy that is attached to an IAM principal.

" + } + }, + "com.amazonaws.securityhub#AwsIamAttachedManagedPolicyList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsIamAttachedManagedPolicy" + } + }, + "com.amazonaws.securityhub#AwsIamGroupDetails": { + "type": "structure", + "members": { + "AttachedManagedPolicies": { + "target": "com.amazonaws.securityhub#AwsIamAttachedManagedPolicyList", + "traits": { + "smithy.api#documentation": "

A list of the managed policies that are attached to the IAM group.

" + } + }, + "CreateDate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the IAM group was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "GroupId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the IAM group.

" + } + }, + "GroupName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the IAM group.

" + } + }, + "GroupPolicyList": { + "target": "com.amazonaws.securityhub#AwsIamGroupPolicyList", + "traits": { + "smithy.api#documentation": "

The list of inline policies that are embedded in the group.

" + } + }, + "Path": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The path to the group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about an IAM group.

" + } + }, + "com.amazonaws.securityhub#AwsIamGroupPolicy": { + "type": "structure", + "members": { + "PolicyName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the policy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A managed policy that is attached to the IAM group.

" + } + }, + "com.amazonaws.securityhub#AwsIamGroupPolicyList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsIamGroupPolicy" + } + }, + "com.amazonaws.securityhub#AwsIamInstanceProfile": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the instance profile.

" + } + }, + "CreateDate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the instance profile was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "InstanceProfileId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the instance profile.

" + } + }, + "InstanceProfileName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the instance profile.

" + } + }, + "Path": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The path to the instance profile.

" + } + }, + "Roles": { + "target": "com.amazonaws.securityhub#AwsIamInstanceProfileRoles", + "traits": { + "smithy.api#documentation": "

The roles associated with the instance profile.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an instance profile.

" + } + }, + "com.amazonaws.securityhub#AwsIamInstanceProfileList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsIamInstanceProfile" + } + }, + "com.amazonaws.securityhub#AwsIamInstanceProfileRole": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the role.

" + } + }, + "AssumeRolePolicyDocument": { + "target": "com.amazonaws.securityhub#AwsIamRoleAssumeRolePolicyDocument", + "traits": { + "smithy.api#documentation": "

The policy that grants an entity permission to assume the role.

" + } + }, + "CreateDate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the role was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "Path": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The path to the role.

" + } + }, + "RoleId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the role.

" + } + }, + "RoleName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the role.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a role associated with an instance profile.

" + } + }, + "com.amazonaws.securityhub#AwsIamInstanceProfileRoles": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsIamInstanceProfileRole" + } + }, + "com.amazonaws.securityhub#AwsIamPermissionsBoundary": { + "type": "structure", + "members": { + "PermissionsBoundaryArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the policy used to set the permissions boundary.

" + } + }, + "PermissionsBoundaryType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The usage type for the permissions boundary.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the policy used to set the permissions boundary for an IAM\n principal.

" + } + }, + "com.amazonaws.securityhub#AwsIamPolicyDetails": { + "type": "structure", + "members": { + "AttachmentCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of users, groups, and roles that the policy is attached to.

" + } + }, + "CreateDate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

When the policy was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "DefaultVersionId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the default version of the policy.

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A description of the policy.

" + } + }, + "IsAttachable": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the policy can be attached to a user, group, or role.

" + } + }, + "Path": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The path to the policy.

" + } + }, + "PermissionsBoundaryUsageCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of users and roles that use the policy to set the permissions\n boundary.

" + } + }, + "PolicyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The unique identifier of the policy.

" + } + }, + "PolicyName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the policy.

" + } + }, + "PolicyVersionList": { + "target": "com.amazonaws.securityhub#AwsIamPolicyVersionList", + "traits": { + "smithy.api#documentation": "

List of versions of the policy.

" + } + }, + "UpdateDate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

When the policy was most recently updated.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents an IAM permissions policy.

" + } + }, + "com.amazonaws.securityhub#AwsIamPolicyVersion": { + "type": "structure", + "members": { + "VersionId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the policy version.

" + } + }, + "IsDefaultVersion": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the version is the default version.

" + } + }, + "CreateDate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the version was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A version of an IAM policy.

" + } + }, + "com.amazonaws.securityhub#AwsIamPolicyVersionList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsIamPolicyVersion" + } + }, + "com.amazonaws.securityhub#AwsIamRoleAssumeRolePolicyDocument": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 131072 + }, + "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]+$" + } + }, + "com.amazonaws.securityhub#AwsIamRoleDetails": { + "type": "structure", + "members": { + "AssumeRolePolicyDocument": { + "target": "com.amazonaws.securityhub#AwsIamRoleAssumeRolePolicyDocument", + "traits": { + "smithy.api#documentation": "

The trust policy that grants permission to assume the role.

" + } + }, + "AttachedManagedPolicies": { + "target": "com.amazonaws.securityhub#AwsIamAttachedManagedPolicyList", + "traits": { + "smithy.api#documentation": "

The list of the managed policies that are attached to the role.

" + } + }, + "CreateDate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the role was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "InstanceProfileList": { + "target": "com.amazonaws.securityhub#AwsIamInstanceProfileList", + "traits": { + "smithy.api#documentation": "

The list of instance profiles that contain this role.

" + } + }, + "PermissionsBoundary": { + "target": "com.amazonaws.securityhub#AwsIamPermissionsBoundary" + }, + "RoleId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The stable and unique string identifying the role.

" + } + }, + "RoleName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The friendly name that identifies the role.

" + } + }, + "RolePolicyList": { + "target": "com.amazonaws.securityhub#AwsIamRolePolicyList", + "traits": { + "smithy.api#documentation": "

The list of inline policies that are embedded in the role.

" + } + }, + "MaxSessionDuration": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum session duration (in seconds) that you want to set for the specified role.

" + } + }, + "Path": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The path to the role.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an IAM role, including all of the role's policies.

" + } + }, + "com.amazonaws.securityhub#AwsIamRolePolicy": { + "type": "structure", + "members": { + "PolicyName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the policy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An inline policy that is embedded in the role.

" + } + }, + "com.amazonaws.securityhub#AwsIamRolePolicyList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsIamRolePolicy" + } + }, + "com.amazonaws.securityhub#AwsIamUserDetails": { + "type": "structure", + "members": { + "AttachedManagedPolicies": { + "target": "com.amazonaws.securityhub#AwsIamAttachedManagedPolicyList", + "traits": { + "smithy.api#documentation": "

A list of the managed policies that are attached to the user.

" + } + }, + "CreateDate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the user was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "GroupList": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

A list of IAM groups that the user belongs to.

" + } + }, + "Path": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The path to the user.

" + } + }, + "PermissionsBoundary": { + "target": "com.amazonaws.securityhub#AwsIamPermissionsBoundary", + "traits": { + "smithy.api#documentation": "

The permissions boundary for the user.

" + } + }, + "UserId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The unique identifier for the user.

" + } + }, + "UserName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the user.

" + } + }, + "UserPolicyList": { + "target": "com.amazonaws.securityhub#AwsIamUserPolicyList", + "traits": { + "smithy.api#documentation": "

The list of inline policies that are embedded in the user.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an IAM user.

" + } + }, + "com.amazonaws.securityhub#AwsIamUserPolicy": { + "type": "structure", + "members": { + "PolicyName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the policy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an inline policy that is embedded in the user.

" + } + }, + "com.amazonaws.securityhub#AwsIamUserPolicyList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsIamUserPolicy" + } + }, + "com.amazonaws.securityhub#AwsKinesisStreamDetails": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the Kinesis stream. If you don't specify a name, CloudFront generates a unique \nphysical ID and uses that ID for the stream name.\n

" + } + }, + "Arn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Kinesis data stream.\n

" + } + }, + "StreamEncryption": { + "target": "com.amazonaws.securityhub#AwsKinesisStreamStreamEncryptionDetails", + "traits": { + "smithy.api#documentation": "

When specified, enables or updates server-side encryption using an KMS key for a specified stream. \nRemoving this property from your stack template and updating your stack disables encryption.\n

" + } + }, + "ShardCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of shards that the stream uses. \n

" + } + }, + "RetentionPeriodHours": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of hours for the data records that are stored in shards to remain accessible. \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about an Amazon Kinesis data stream.\n

" + } + }, + "com.amazonaws.securityhub#AwsKinesisStreamStreamEncryptionDetails": { + "type": "structure", + "members": { + "EncryptionType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The encryption type to use.\n

" + } + }, + "KeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The globally unique identifier for the customer-managed KMS key to use for encryption.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about stream encryption.\n

" + } + }, + "com.amazonaws.securityhub#AwsKmsKeyDetails": { + "type": "structure", + "members": { + "AWSAccountId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.

" + } + }, + "CreationDate": { + "target": "com.amazonaws.securityhub#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Indicates when the KMS key was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "KeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The globally unique identifier for the KMS key.

" + } + }, + "KeyManager": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed.

" + } + }, + "KeyState": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The state of the KMS key. Valid values are as follows:

\n " + } + }, + "Origin": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The source of the KMS key material.

\n

When this value is AWS_KMS, KMS created the key material.

\n

When this value is EXTERNAL, the key material was imported from your\n existing key management infrastructure or the KMS key lacks key material.

\n

When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated with a custom key store.

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A description of the KMS key.

" + } + }, + "KeyRotationStatus": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the key has key rotation enabled.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains metadata about an KMS key.

" + } + }, + "com.amazonaws.securityhub#AwsLambdaFunctionCode": { + "type": "structure", + "members": { + "S3Bucket": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different Amazon Web Services account.

" + } + }, + "S3Key": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon S3 key of the deployment package.

" + } + }, + "S3ObjectVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

For versioned objects, the version of the deployment package object to use.

" + } + }, + "ZipFile": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The base64-encoded contents of the deployment package. Amazon Web Services SDK and Amazon Web Services CLI clients handle the encoding for you.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The code for the Lambda function. You can specify either an object in Amazon S3, or upload a deployment package directly.

" + } + }, + "com.amazonaws.securityhub#AwsLambdaFunctionDeadLetterConfig": { + "type": "structure", + "members": { + "TargetArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of an SQS queue or SNS topic.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The dead-letter queue for failed asynchronous invocations.

" + } + }, + "com.amazonaws.securityhub#AwsLambdaFunctionDetails": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.securityhub#AwsLambdaFunctionCode", + "traits": { + "smithy.api#documentation": "

An AwsLambdaFunctionCode object.

" + } + }, + "CodeSha256": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The SHA256 hash of the function's deployment package.

" + } + }, + "DeadLetterConfig": { + "target": "com.amazonaws.securityhub#AwsLambdaFunctionDeadLetterConfig", + "traits": { + "smithy.api#documentation": "

The function's dead letter queue.

" + } + }, + "Environment": { + "target": "com.amazonaws.securityhub#AwsLambdaFunctionEnvironment", + "traits": { + "smithy.api#documentation": "

The function's environment variables.

" + } + }, + "FunctionName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the function.

" + } + }, + "Handler": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The function that Lambda calls to begin executing your function.

" + } + }, + "KmsKeyArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The KMS key that is used to encrypt the function's environment variables. This key is only returned if you've configured a customer managed customer managed key.

" + } + }, + "LastModified": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the function was last updated.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "Layers": { + "target": "com.amazonaws.securityhub#AwsLambdaFunctionLayerList", + "traits": { + "smithy.api#documentation": "

The function's layers.

" + } + }, + "MasterArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

For Lambda@Edge functions, the ARN of the master function.

" + } + }, + "MemorySize": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The memory that is allocated to the function.

" + } + }, + "RevisionId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The latest updated revision of the function or alias.

" + } + }, + "Role": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The function's execution role.

" + } + }, + "Runtime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The runtime environment for the Lambda function.

" + } + }, + "Timeout": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount of time that Lambda allows a function to run before stopping it.

" + } + }, + "TracingConfig": { + "target": "com.amazonaws.securityhub#AwsLambdaFunctionTracingConfig", + "traits": { + "smithy.api#documentation": "

The function's X-Ray tracing configuration.

" + } + }, + "VpcConfig": { + "target": "com.amazonaws.securityhub#AwsLambdaFunctionVpcConfig", + "traits": { + "smithy.api#documentation": "

The function's networking configuration.

" + } + }, + "Version": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The version of the Lambda function.

" + } + }, + "Architectures": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The instruction set architecture that the function uses. Valid values are x86_64 or \narm64.

" + } + }, + "PackageType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of deployment package that's used to deploy the function code to Lambda. Set to Image for a container image and Zip for a .zip file archive.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about an Lambda function's configuration.

" + } + }, + "com.amazonaws.securityhub#AwsLambdaFunctionEnvironment": { + "type": "structure", + "members": { + "Variables": { + "target": "com.amazonaws.securityhub#FieldMap", + "traits": { + "smithy.api#documentation": "

Environment variable key-value pairs.

" + } + }, + "Error": { + "target": "com.amazonaws.securityhub#AwsLambdaFunctionEnvironmentError", + "traits": { + "smithy.api#documentation": "

An AwsLambdaFunctionEnvironmentError object.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A function's environment variable settings.

" + } + }, + "com.amazonaws.securityhub#AwsLambdaFunctionEnvironmentError": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The error code.

" + } + }, + "Message": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The error message.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Error messages for environment variables that could not be applied.

" + } + }, + "com.amazonaws.securityhub#AwsLambdaFunctionLayer": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the function layer.

" + } + }, + "CodeSize": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The size of the layer archive in bytes.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An Lambda layer.

" + } + }, + "com.amazonaws.securityhub#AwsLambdaFunctionLayerList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsLambdaFunctionLayer" + } + }, + "com.amazonaws.securityhub#AwsLambdaFunctionTracingConfig": { + "type": "structure", + "members": { + "Mode": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The tracing mode.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The function's X-Ray tracing configuration.

" + } + }, + "com.amazonaws.securityhub#AwsLambdaFunctionVpcConfig": { + "type": "structure", + "members": { + "SecurityGroupIds": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

A list of VPC security groups IDs.

" + } + }, + "SubnetIds": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

A list of VPC subnet IDs.

" + } + }, + "VpcId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the VPC.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The VPC security groups and subnets that are attached to a Lambda function.

" + } + }, + "com.amazonaws.securityhub#AwsLambdaLayerVersionDetails": { + "type": "structure", + "members": { + "Version": { + "target": "com.amazonaws.securityhub#AwsLambdaLayerVersionNumber", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The version number.

" + } + }, + "CompatibleRuntimes": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The layer's compatible runtimes. Maximum number of five items.

\n

Valid values: nodejs10.x | nodejs12.x | java8 |\n java11 | python2.7 | python3.6 |\n python3.7 | python3.8 | dotnetcore1.0 |\n dotnetcore2.1 | go1.x | ruby2.5 |\n provided\n

" + } + }, + "CreatedDate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the version was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about a Lambda layer version.

" + } + }, + "com.amazonaws.securityhub#AwsLambdaLayerVersionNumber": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.securityhub#AwsMountPoint": { + "type": "structure", + "members": { + "SourceVolume": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the volume to mount. Must be a volume name referenced in the name parameter \nof task definition volume.\n

" + } + }, + "ContainerPath": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The path on the container to mount the host volume at.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details for a volume mount point that's used in a container definition.\n

" + } + }, + "com.amazonaws.securityhub#AwsMountPointList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsMountPoint" + } + }, + "com.amazonaws.securityhub#AwsNetworkFirewallFirewallDetails": { + "type": "structure", + "members": { + "DeleteProtection": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the firewall is protected from deletion. If set to true, then the firewall cannot be deleted.

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A description of the firewall.

" + } + }, + "FirewallArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the firewall.

" + } + }, + "FirewallId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the firewall.

" + } + }, + "FirewallName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A descriptive name of the firewall.

" + } + }, + "FirewallPolicyArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the firewall policy.

" + } + }, + "FirewallPolicyChangeProtection": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the firewall is protected from a change to the firewall policy. If set to true, you cannot associate a different policy with the firewall.

" + } + }, + "SubnetChangeProtection": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the firewall is protected from a change to the subnet associations. If set to true, you cannot map different subnets to the firewall.

" + } + }, + "SubnetMappings": { + "target": "com.amazonaws.securityhub#AwsNetworkFirewallFirewallSubnetMappingsList", + "traits": { + "smithy.api#documentation": "

The public subnets that Network Firewall uses for the firewall. Each subnet must belong to a different Availability Zone.

" + } + }, + "VpcId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the VPC where the firewall is used.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about an Network Firewall firewall.

" + } + }, + "com.amazonaws.securityhub#AwsNetworkFirewallFirewallPolicyDetails": { + "type": "structure", + "members": { + "FirewallPolicy": { + "target": "com.amazonaws.securityhub#FirewallPolicyDetails", + "traits": { + "smithy.api#documentation": "

The firewall policy configuration.

" + } + }, + "FirewallPolicyArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the firewall policy.

" + } + }, + "FirewallPolicyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the firewall policy.

" + } + }, + "FirewallPolicyName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the firewall policy.

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A description of the firewall policy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about a firewall policy. A firewall policy defines the behavior of a network firewall.

" + } + }, + "com.amazonaws.securityhub#AwsNetworkFirewallFirewallSubnetMappingsDetails": { + "type": "structure", + "members": { + "SubnetId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the subnet

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A public subnet that Network Firewall uses for the firewall.

" + } + }, + "com.amazonaws.securityhub#AwsNetworkFirewallFirewallSubnetMappingsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsNetworkFirewallFirewallSubnetMappingsDetails" + } + }, + "com.amazonaws.securityhub#AwsNetworkFirewallRuleGroupDetails": { + "type": "structure", + "members": { + "Capacity": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of operating resources that this rule group can use.

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A description of the rule group.

" + } + }, + "RuleGroup": { + "target": "com.amazonaws.securityhub#RuleGroupDetails", + "traits": { + "smithy.api#documentation": "

Details about the rule group.

" + } + }, + "RuleGroupArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the rule group.

" + } + }, + "RuleGroupId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the rule group.

" + } + }, + "RuleGroupName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The descriptive name of the rule group.

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of rule group. A rule group can be stateful or stateless.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about an Network Firewall rule group. Rule groups are used to inspect and control network traffic. Stateless rule groups apply to individual packets. Stateful rule groups apply to packets in the context of their traffic flow.

\n

Rule groups are referenced in firewall policies.\n

" + } + }, + "com.amazonaws.securityhub#AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetails": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Enables fine-grained access control.\n

" + } + }, + "InternalUserDatabaseEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Enables the internal user database.\n

" + } + }, + "MasterUserOptions": { + "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainMasterUserOptionsDetails", + "traits": { + "smithy.api#documentation": "

Specifies information about the master user of the domain.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about domain access control options.\n

" + } + }, + "com.amazonaws.securityhub#AwsOpenSearchServiceDomainClusterConfigDetails": { + "type": "structure", + "members": { + "InstanceCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of data nodes to use in the OpenSearch domain.

" + } + }, + "WarmEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether UltraWarm is enabled.

" + } + }, + "WarmCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of UltraWarm instances.

" + } + }, + "DedicatedMasterEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether to use a dedicated master node for the OpenSearch domain. A dedicated master node performs cluster management tasks, but does not hold data or respond to data upload requests.

" + } + }, + "ZoneAwarenessConfig": { + "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails", + "traits": { + "smithy.api#documentation": "

Configuration options for zone awareness. Provided if ZoneAwarenessEnabled is true.

" + } + }, + "DedicatedMasterCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of instances to use for the master node. If this attribute is specified, then DedicatedMasterEnabled must be true.

" + } + }, + "InstanceType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The instance type for your data nodes.

\n

For a list of valid values, see Supported instance types in Amazon OpenSearch Service in the Amazon OpenSearch Service Developer Guide.

" + } + }, + "WarmType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of UltraWarm instance.

" + } + }, + "ZoneAwarenessEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether to enable zone awareness for the OpenSearch domain. When zone awareness is enabled, OpenSearch Service allocates the cluster's nodes and replica index shards across Availability Zones (AZs) in the same Region. This prevents data loss and minimizes downtime if a node or data center fails.

" + } + }, + "DedicatedMasterType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The hardware configuration of the computer that hosts the dedicated master node.

\n

If this attribute is specified, then DedicatedMasterEnabled must be true.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the configuration of an OpenSearch cluster.

" + } + }, + "com.amazonaws.securityhub#AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails": { + "type": "structure", + "members": { + "AvailabilityZoneCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of Availability Zones that the domain uses. Valid values are 2 or 3. The default is 2.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration options for zone awareness.

" + } + }, + "com.amazonaws.securityhub#AwsOpenSearchServiceDomainDetails": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the OpenSearch Service domain.

" + } + }, + "AccessPolicies": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

IAM policy document that specifies the access policies for the OpenSearch Service domain.

" + } + }, + "DomainName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the endpoint.

" + } + }, + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the domain.

" + } + }, + "DomainEndpoint": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The domain endpoint.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The version of the domain engine.

" + } + }, + "EncryptionAtRestOptions": { + "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainEncryptionAtRestOptionsDetails", + "traits": { + "smithy.api#documentation": "

Details about the configuration for encryption at rest.

" + } + }, + "NodeToNodeEncryptionOptions": { + "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainNodeToNodeEncryptionOptionsDetails", + "traits": { + "smithy.api#documentation": "

Details about the configuration for node-to-node encryption.

" + } + }, + "ServiceSoftwareOptions": { + "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails", + "traits": { + "smithy.api#documentation": "

Information about the status of a domain relative to the latest service software.

" + } + }, + "ClusterConfig": { + "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainClusterConfigDetails", + "traits": { + "smithy.api#documentation": "

Details about the configuration of an OpenSearch cluster.

" + } + }, + "DomainEndpointOptions": { + "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainDomainEndpointOptionsDetails", + "traits": { + "smithy.api#documentation": "

Additional options for the domain endpoint.

" + } + }, + "VpcOptions": { + "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainVpcOptionsDetails", + "traits": { + "smithy.api#documentation": "

Information that OpenSearch Service derives based on VPCOptions for the domain.

" + } + }, + "LogPublishingOptions": { + "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainLogPublishingOptionsDetails", + "traits": { + "smithy.api#documentation": "

Configures the CloudWatch Logs to publish for the OpenSearch domain.

" + } + }, + "DomainEndpoints": { + "target": "com.amazonaws.securityhub#FieldMap", + "traits": { + "smithy.api#documentation": "

The domain endpoints. Used if the OpenSearch domain resides in a VPC.

\n

This is a map of key-value pairs. The key is always vpc. The value is the endpoint.

" + } + }, + "AdvancedSecurityOptions": { + "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetails", + "traits": { + "smithy.api#documentation": "

Specifies options for fine-grained access control.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an Amazon OpenSearch Service domain.

" + } + }, + "com.amazonaws.securityhub#AwsOpenSearchServiceDomainDomainEndpointOptionsDetails": { + "type": "structure", + "members": { + "CustomEndpointCertificateArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN for the security certificate. The certificate is managed in ACM.

" + } + }, + "CustomEndpointEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether to enable a custom endpoint for the domain.

" + } + }, + "EnforceHTTPS": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether to require that all traffic to the domain arrive over HTTPS.

" + } + }, + "CustomEndpoint": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The fully qualified URL for the custom endpoint.

" + } + }, + "TLSSecurityPolicy": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The TLS security policy to apply to the HTTPS endpoint of the OpenSearch domain.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about additional options for the domain endpoint.

" + } + }, + "com.amazonaws.securityhub#AwsOpenSearchServiceDomainEncryptionAtRestOptionsDetails": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether encryption at rest is enabled.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The KMS key ID.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the configuration for encryption at rest for the OpenSearch domain.

" + } + }, + "com.amazonaws.securityhub#AwsOpenSearchServiceDomainLogPublishingOption": { + "type": "structure", + "members": { + "CloudWatchLogsLogGroupArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the CloudWatch Logs group to publish the logs to.

" + } + }, + "Enabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the log publishing is enabled.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration details for a log publishing option.

" + } + }, + "com.amazonaws.securityhub#AwsOpenSearchServiceDomainLogPublishingOptionsDetails": { + "type": "structure", + "members": { + "IndexSlowLogs": { + "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainLogPublishingOption", + "traits": { + "smithy.api#documentation": "

Configures the OpenSearch index logs publishing.

" + } + }, + "SearchSlowLogs": { + "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainLogPublishingOption", + "traits": { + "smithy.api#documentation": "

Configures the OpenSearch search slow log publishing.

" + } + }, + "AuditLogs": { + "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainLogPublishingOption", + "traits": { + "smithy.api#documentation": "

Configures the OpenSearch audit logs publishing.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configures the CloudWatch Logs to publish for the OpenSearch domain.

" + } + }, + "com.amazonaws.securityhub#AwsOpenSearchServiceDomainMasterUserOptionsDetails": { + "type": "structure", + "members": { + "MasterUserArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the master user.\n

" + } + }, + "MasterUserName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The username for the master user.\n

" + } + }, + "MasterUserPassword": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The password for the master user.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies information about the master user of the domain.\n

" + } + }, + "com.amazonaws.securityhub#AwsOpenSearchServiceDomainNodeToNodeEncryptionOptionsDetails": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether node-to-node encryption is enabled.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about the configuration for node-to-node encryption.

" + } + }, + "com.amazonaws.securityhub#AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails": { + "type": "structure", + "members": { + "AutomatedUpdateDate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The epoch time when the deployment window closes for required updates. After this time, OpenSearch Service schedules the software upgrade automatically.

" + } + }, + "Cancellable": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether a request to update the domain can be canceled.

" + } + }, + "CurrentVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The version of the service software that is currently installed on the domain.

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A more detailed description of the service software status.

" + } + }, + "NewVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The most recent version of the service software.

" + } + }, + "UpdateAvailable": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether a service software update is available for the domain.

" + } + }, + "UpdateStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of the service software update. Valid values are as follows:

\n " + } + }, + "OptionalDeployment": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the service software update is optional.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the state of the domain relative to the latest service software.

" + } + }, + "com.amazonaws.securityhub#AwsOpenSearchServiceDomainVpcOptionsDetails": { + "type": "structure", + "members": { + "SecurityGroupIds": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The list of security group IDs that are associated with the VPC endpoints for the domain.

" + } + }, + "SubnetIds": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

A list of subnet IDs that are associated with the VPC endpoints for the domain.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information that OpenSearch Service derives based on the VPCOptions for the domain.

" + } + }, + "com.amazonaws.securityhub#AwsRdsDbClusterAssociatedRole": { + "type": "structure", + "members": { + "RoleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role.

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of the association between the IAM role and the DB cluster. Valid values are as follows:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

An IAM role that is associated with the Amazon RDS DB cluster.

" + } + }, + "com.amazonaws.securityhub#AwsRdsDbClusterAssociatedRoles": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsRdsDbClusterAssociatedRole" + } + }, + "com.amazonaws.securityhub#AwsRdsDbClusterDetails": { + "type": "structure", + "members": { + "AllocatedStorage": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

For all database engines except Aurora, specifies the allocated storage size in\n gibibytes (GiB).

" + } + }, + "AvailabilityZones": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

A list of Availability Zones (AZs) where instances in the DB cluster can be\n created.

" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of days for which automated backups are retained.

" + } + }, + "DatabaseName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the database.

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The current status of this DB cluster.

" + } + }, + "Endpoint": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The connection endpoint for the primary instance of the DB cluster.

" + } + }, + "ReaderEndpoint": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The reader endpoint for the DB cluster.

" + } + }, + "CustomEndpoints": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

A list of custom endpoints for the DB cluster.

" + } + }, + "MultiAz": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the DB cluster has instances in multiple Availability Zones.

" + } + }, + "Engine": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the database engine to use for this DB cluster. Valid values are as follows:

\n " + } + }, + "EngineVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The version number of the database engine to use.

" + } + }, + "Port": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The port number on which the DB instances in the DB cluster accept connections.

" + } + }, + "MasterUsername": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the master user for the DB cluster.

" + } + }, + "PreferredBackupWindow": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The range of time each day when automated backups are created, if automated backups are\n enabled.

\n

Uses the format HH:MM-HH:MM. For example, 04:52-05:22.

" + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal\n Coordinated Time (UTC).

\n

Uses the format :HH:MM-:HH:MM.

\n

For the day values, use\n mon|tue|wed|thu|fri|sat|sun.

\n

For example, sun:09:32-sun:10:02.

" + } + }, + "ReadReplicaIdentifiers": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

The identifiers of the read replicas that are associated with this DB cluster.

" + } + }, + "VpcSecurityGroups": { + "target": "com.amazonaws.securityhub#AwsRdsDbInstanceVpcSecurityGroups", + "traits": { + "smithy.api#documentation": "

A list of VPC security groups that the DB cluster belongs to.

" + } + }, + "HostedZoneId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Specifies the identifier that Amazon Route 53 assigns when you create a hosted\n zone.

" + } + }, + "StorageEncrypted": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the DB cluster is encrypted.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the KMS master key that is used to encrypt the database instances in the\n DB cluster.

" + } + }, + "DbClusterResourceId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the DB cluster. The identifier must be unique within each Amazon Web Services Region\n and is immutable.

" + } + }, + "AssociatedRoles": { + "target": "com.amazonaws.securityhub#AwsRdsDbClusterAssociatedRoles", + "traits": { + "smithy.api#documentation": "

A list of the IAM roles that are associated with the DB cluster.

" + } + }, + "ClusterCreateTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the DB cluster was created, in Universal Coordinated Time (UTC).

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "EnabledCloudWatchLogsExports": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

A list of log types that this DB cluster is configured to export to CloudWatch\n Logs.

" + } + }, + "EngineMode": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The database engine mode of the DB cluster.Valid values are as follows:

\n " + } + }, + "DeletionProtection": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the DB cluster has deletion protection enabled.

" + } + }, + "HttpEndpointEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

" + } + }, + "ActivityStreamStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of the database activity stream. Valid values are as follows:

\n " + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether tags are copied from the DB cluster to snapshots of the DB cluster.

" + } + }, + "CrossAccountClone": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services\n account.

" + } + }, + "DomainMemberships": { + "target": "com.amazonaws.securityhub#AwsRdsDbDomainMemberships", + "traits": { + "smithy.api#documentation": "

The Active Directory domain membership records that are associated with the DB\n cluster.

" + } + }, + "DbClusterParameterGroup": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster parameter group for the DB cluster.

" + } + }, + "DbSubnetGroup": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The subnet group that is associated with the DB cluster, including the name,\n description, and subnets in the subnet group.

" + } + }, + "DbClusterOptionGroupMemberships": { + "target": "com.amazonaws.securityhub#AwsRdsDbClusterOptionGroupMemberships", + "traits": { + "smithy.api#documentation": "

The list of option group memberships for this DB cluster.

" + } + }, + "DbClusterIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The DB cluster identifier that the user assigned to the cluster. This identifier is the\n unique key that identifies a DB cluster.

" + } + }, + "DbClusterMembers": { + "target": "com.amazonaws.securityhub#AwsRdsDbClusterMembers", + "traits": { + "smithy.api#documentation": "

The list of instances that make up the DB cluster.

" + } + }, + "IamDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the mapping of IAM accounts to database accounts is enabled.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an Amazon RDS DB cluster.

" + } + }, + "com.amazonaws.securityhub#AwsRdsDbClusterMember": { + "type": "structure", + "members": { + "IsClusterWriter": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the cluster member is the primary instance for the DB cluster.

" + } + }, + "PromotionTier": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Specifies the order in which an Aurora replica is promoted to the primary instance when\n the existing primary instance fails.

" + } + }, + "DbInstanceIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The instance identifier for this member of the DB cluster.

" + } + }, + "DbClusterParameterGroupStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of the DB cluster parameter group for this member of the DB cluster.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an instance in the DB cluster.

" + } + }, + "com.amazonaws.securityhub#AwsRdsDbClusterMembers": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsRdsDbClusterMember" + } + }, + "com.amazonaws.securityhub#AwsRdsDbClusterOptionGroupMembership": { + "type": "structure", + "members": { + "DbClusterOptionGroupName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster option group.

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of the DB cluster option group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an option group membership for a DB cluster.

" + } + }, + "com.amazonaws.securityhub#AwsRdsDbClusterOptionGroupMemberships": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsRdsDbClusterOptionGroupMembership" + } + }, + "com.amazonaws.securityhub#AwsRdsDbClusterSnapshotDetails": { + "type": "structure", + "members": { + "AvailabilityZones": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

A list of Availability Zones where instances in the DB cluster can be created.

" + } + }, + "SnapshotCreateTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the snapshot was taken.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "Engine": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the database engine that you want to use for this DB instance.

" + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Specifies the allocated storage size in gibibytes (GiB).

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of this DB cluster snapshot.

" + } + }, + "Port": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The port number on which the DB instances in the DB cluster accept connections.

" + } + }, + "VpcId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The VPC ID that is associated with the DB cluster snapshot.

" + } + }, + "ClusterCreateTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the DB cluster was created, in Universal Coordinated Time (UTC).

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "MasterUsername": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the master user for the DB cluster.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The version of the database engine to use.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The license model information for this DB cluster snapshot.

" + } + }, + "SnapshotType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of DB cluster snapshot.

" + } + }, + "PercentProgress": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Specifies the percentage of the estimated data that has been transferred.

" + } + }, + "StorageEncrypted": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the DB cluster is encrypted.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the KMS master key that is used to encrypt the database instances in the\n DB cluster.

" + } + }, + "DbClusterIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The DB cluster identifier.

" + } + }, + "DbClusterSnapshotIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the DB cluster snapshot.

" + } + }, + "IamDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether mapping of IAM accounts to database accounts is enabled.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an Amazon RDS DB cluster snapshot.

" + } + }, + "com.amazonaws.securityhub#AwsRdsDbDomainMembership": { + "type": "structure", + "members": { + "Domain": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the Active Directory domain.

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of the Active Directory Domain membership for the DB instance.

" + } + }, + "Fqdn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The fully qualified domain name of the Active Directory domain.

" + } + }, + "IamRoleName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the IAM role to use when making API calls to the Directory Service.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an Active Directory domain membership record associated with the DB\n instance.

" + } + }, + "com.amazonaws.securityhub#AwsRdsDbDomainMemberships": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsRdsDbDomainMembership" + } + }, + "com.amazonaws.securityhub#AwsRdsDbInstanceAssociatedRole": { + "type": "structure", + "members": { + "RoleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role that is associated with the DB\n instance.

" + } + }, + "FeatureName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the feature associated with the IAM role.

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Describes the state of the association between the IAM role and the DB instance. The\n Status property returns one of the following values:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

An IAM role associated with the DB instance.

" + } + }, + "com.amazonaws.securityhub#AwsRdsDbInstanceAssociatedRoles": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsRdsDbInstanceAssociatedRole" + } + }, + "com.amazonaws.securityhub#AwsRdsDbInstanceDetails": { + "type": "structure", + "members": { + "AssociatedRoles": { + "target": "com.amazonaws.securityhub#AwsRdsDbInstanceAssociatedRoles", + "traits": { + "smithy.api#documentation": "

The IAM roles associated with the DB\n instance.

" + } + }, + "CACertificateIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the CA certificate for this DB instance.

" + } + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that\n the DB instance is a member of.

" + } + }, + "DBInstanceIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Contains a user-supplied database identifier. This identifier is the unique key that\n identifies a DB instance.

" + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Contains the name of the compute and memory capacity class of the DB instance.

" + } + }, + "DbInstancePort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Specifies the port that the DB instance listens on. If the DB instance is part of a DB\n cluster, this can be a different port than the DB cluster port.

" + } + }, + "DbiResourceId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is\n found in CloudTrail log entries whenever the KMS key for the DB instance is\n accessed.

" + } + }, + "DBName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The meaning of this parameter differs according to the database engine you use.

\n

\n MySQL, MariaDB, SQL Server, PostgreSQL\n

\n

Contains the name of the initial database of this instance that was provided at create\n time, if one was specified when the DB instance was created. This same name is returned for\n the life of the DB instance.

\n

\n Oracle\n

\n

Contains the Oracle System ID (SID) of the created DB instance. Not shown when the\n returned parameters do not apply to an Oracle DB instance.

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the DB instance has deletion protection enabled.

\n

When deletion protection is enabled, the database cannot be deleted.

" + } + }, + "Endpoint": { + "target": "com.amazonaws.securityhub#AwsRdsDbInstanceEndpoint", + "traits": { + "smithy.api#documentation": "

Specifies the connection endpoint.

" + } + }, + "Engine": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Provides the name of the database engine to use for this DB instance.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates the database engine version.

" + } + }, + "IAMDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

True if mapping of IAM accounts to database\n accounts is enabled, and otherwise false.

\n

IAM database authentication can be enabled for the following database engines.

\n " + } + }, + "InstanceCreateTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the DB instance was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

If StorageEncrypted is true, the KMS key identifier for the encrypted\n DB instance.

" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies the accessibility options for the DB instance.

\n

A value of true specifies an Internet-facing instance with a publicly resolvable DNS\n name, which resolves to a public IP address.

\n

A value of false specifies an internal instance with a DNS name that resolves to a\n private IP address.

" + } + }, + "StorageEncrypted": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether the DB instance is encrypted.

" + } + }, + "TdeCredentialArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN from the key store with which the instance is associated for TDE\n encryption.

" + } + }, + "VpcSecurityGroups": { + "target": "com.amazonaws.securityhub#AwsRdsDbInstanceVpcSecurityGroups", + "traits": { + "smithy.api#documentation": "

A list of VPC security groups that the DB instance belongs to.

" + } + }, + "MultiAz": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the DB instance is a multiple Availability Zone deployment.

" + } + }, + "EnhancedMonitoringResourceArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the CloudWatch Logs log stream that receives the enhanced monitoring metrics\n data for the DB instance.

" + } + }, + "DbInstanceStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The current status of the DB instance.

" + } + }, + "MasterUsername": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The master user name of the DB instance.

" + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount of storage (in gigabytes) to initially allocate for the DB instance.

" + } + }, + "PreferredBackupWindow": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The range of time each day when automated backups are created, if automated backups are\n enabled.

\n

Uses the format HH:MM-HH:MM. For example, 04:52-05:22.

" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of days for which to retain automated backups.

" + } + }, + "DbSecurityGroups": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

A list of the DB security groups to assign to the DB instance.

" + } + }, + "DbParameterGroups": { + "target": "com.amazonaws.securityhub#AwsRdsDbParameterGroups", + "traits": { + "smithy.api#documentation": "

A list of the DB parameter groups to assign to the DB instance.

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Availability Zone where the DB instance will be created.

" + } + }, + "DbSubnetGroup": { + "target": "com.amazonaws.securityhub#AwsRdsDbSubnetGroup", + "traits": { + "smithy.api#documentation": "

Information about the subnet group that is associated with the DB instance.

" + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal\n Coordinated Time (UTC).

\n

Uses the format :HH:MM-:HH:MM.

\n

For the day values, use\n mon|tue|wed|thu|fri|sat|sun.

\n

For example, sun:09:32-sun:10:02.

" + } + }, + "PendingModifiedValues": { + "target": "com.amazonaws.securityhub#AwsRdsDbPendingModifiedValues", + "traits": { + "smithy.api#documentation": "

Changes to the DB instance that are currently pending.

" + } + }, + "LatestRestorableTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Specifies the latest time to which a database can be restored with point-in-time\n restore.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether minor version patches are applied automatically.

" + } + }, + "ReadReplicaSourceDBInstanceIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

If this DB instance is a read replica, contains the identifier of the source DB\n instance.

" + } + }, + "ReadReplicaDBInstanceIdentifiers": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

List of identifiers of the read replicas associated with this DB instance.

" + } + }, + "ReadReplicaDBClusterIdentifiers": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

List of identifiers of Aurora DB clusters to which the RDS DB instance is replicated as\n a read replica.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

License model information for this DB instance.

" + } + }, + "Iops": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Specifies the provisioned IOPS (I/O operations per second) for this DB instance.

" + } + }, + "OptionGroupMemberships": { + "target": "com.amazonaws.securityhub#AwsRdsDbOptionGroupMemberships", + "traits": { + "smithy.api#documentation": "

The list of option group memberships for this DB instance.

" + } + }, + "CharacterSetName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the character set that this DB instance is associated with.

" + } + }, + "SecondaryAvailabilityZone": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

For a DB instance with multi-Availability Zone support, the name of the secondary\n Availability Zone.

" + } + }, + "StatusInfos": { + "target": "com.amazonaws.securityhub#AwsRdsDbStatusInfos", + "traits": { + "smithy.api#documentation": "

The status of a read replica. If the instance isn't a read replica, this is\n empty.

" + } + }, + "StorageType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The storage type for the DB instance.

" + } + }, + "DomainMemberships": { + "target": "com.amazonaws.securityhub#AwsRdsDbDomainMemberships", + "traits": { + "smithy.api#documentation": "

The Active Directory domain membership records associated with the DB instance.

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether to copy resource tags to snapshots of the DB instance.

" + } + }, + "MonitoringInterval": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The interval, in seconds, between points when enhanced monitoring metrics are collected\n for the DB instance.

" + } + }, + "MonitoringRoleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN for the IAM role that permits Amazon RDS to send enhanced monitoring metrics to\n CloudWatch Logs.

" + } + }, + "PromotionTier": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The order in which to promote an Aurora replica to the primary instance after a failure\n of the existing primary instance.

" + } + }, + "Timezone": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The time zone of the DB instance.

" + } + }, + "PerformanceInsightsEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether Performance Insights is enabled for the DB instance.

" + } + }, + "PerformanceInsightsKmsKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the KMS key used to encrypt the Performance Insights data.

" + } + }, + "PerformanceInsightsRetentionPeriod": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of days to retain Performance Insights data.

" + } + }, + "EnabledCloudWatchLogsExports": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

A list of log types that this DB instance is configured to export to CloudWatch Logs.

" + } + }, + "ProcessorFeatures": { + "target": "com.amazonaws.securityhub#AwsRdsDbProcessorFeatures", + "traits": { + "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of\n the DB instance.

" + } + }, + "ListenerEndpoint": { + "target": "com.amazonaws.securityhub#AwsRdsDbInstanceEndpoint" + }, + "MaxAllocatedStorage": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The upper limit to which Amazon RDS can automatically scale the storage of the DB\n instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details of an Amazon RDS DB instance.

" + } + }, + "com.amazonaws.securityhub#AwsRdsDbInstanceEndpoint": { + "type": "structure", + "members": { + "Address": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Specifies the DNS address of the DB instance.

" + } + }, + "Port": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Specifies the port that the database engine is listening on.

" + } + }, + "HostedZoneId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the connection endpoint.

" + } + }, + "com.amazonaws.securityhub#AwsRdsDbInstanceVpcSecurityGroup": { + "type": "structure", + "members": { + "VpcSecurityGroupId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the VPC security group.

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of the VPC security group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A VPC security groups that the DB instance belongs to.

" + } + }, + "com.amazonaws.securityhub#AwsRdsDbInstanceVpcSecurityGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsRdsDbInstanceVpcSecurityGroup" + } + }, + "com.amazonaws.securityhub#AwsRdsDbOptionGroupMembership": { + "type": "structure", + "members": { + "OptionGroupName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the option group.

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of the option group membership.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An option group membership.

" + } + }, + "com.amazonaws.securityhub#AwsRdsDbOptionGroupMemberships": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsRdsDbOptionGroupMembership" + } + }, + "com.amazonaws.securityhub#AwsRdsDbParameterGroup": { + "type": "structure", + "members": { + "DbParameterGroupName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the parameter group.

" + } + }, + "ParameterApplyStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of parameter updates.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about a parameter group for a DB instance.

" + } + }, + "com.amazonaws.securityhub#AwsRdsDbParameterGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsRdsDbParameterGroup" + } + }, + "com.amazonaws.securityhub#AwsRdsDbPendingModifiedValues": { + "type": "structure", + "members": { + "DbInstanceClass": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The new DB instance class for the DB instance.

" + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The new value of the allocated storage for the DB instance.

" + } + }, + "MasterUserPassword": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The new master user password for the DB instance.

" + } + }, + "Port": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The new port for the DB instance.

" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The new backup retention period for the DB instance.

" + } + }, + "MultiAZ": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates that a single Availability Zone DB instance is changing to a multiple Availability Zone deployment.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The new engine version for the DB instance.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The new license model value for the DB instance.

" + } + }, + "Iops": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The new provisioned IOPS value for the DB instance.

" + } + }, + "DbInstanceIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The new DB instance identifier for the DB instance.

" + } + }, + "StorageType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The new storage type for the DB instance.

" + } + }, + "CaCertificateIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The new CA certificate identifier for the DB instance.

" + } + }, + "DbSubnetGroupName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the new subnet group for the DB instance.

" + } + }, + "PendingCloudWatchLogsExports": { + "target": "com.amazonaws.securityhub#AwsRdsPendingCloudWatchLogsExports", + "traits": { + "smithy.api#documentation": "

A list of log types that are being enabled or disabled.

" + } + }, + "ProcessorFeatures": { + "target": "com.amazonaws.securityhub#AwsRdsDbProcessorFeatures", + "traits": { + "smithy.api#documentation": "

Processor features that are being updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Changes to a DB instance that are currently pending.

" + } + }, + "com.amazonaws.securityhub#AwsRdsDbProcessorFeature": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the processor feature. Valid values are coreCount or threadsPerCore.

" + } + }, + "Value": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The value of the processor feature.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A processor feature.

" + } + }, + "com.amazonaws.securityhub#AwsRdsDbProcessorFeatures": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsRdsDbProcessorFeature" + } + }, + "com.amazonaws.securityhub#AwsRdsDbSecurityGroupDetails": { + "type": "structure", + "members": { + "DbSecurityGroupArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN for the DB security group.

" + } + }, + "DbSecurityGroupDescription": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Provides the description of the DB security group.

" + } + }, + "DbSecurityGroupName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Specifies the name of the DB security group.

" + } + }, + "Ec2SecurityGroups": { + "target": "com.amazonaws.securityhub#AwsRdsDbSecurityGroupEc2SecurityGroups", + "traits": { + "smithy.api#documentation": "

Contains a list of EC2 security groups.

" + } + }, + "IpRanges": { + "target": "com.amazonaws.securityhub#AwsRdsDbSecurityGroupIpRanges", + "traits": { + "smithy.api#documentation": "

Contains a list of IP ranges.

" + } + }, + "OwnerId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Provides the Amazon Web Services ID of the owner of a specific DB security group.

" + } + }, + "VpcId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Provides VPC ID associated with the DB security group.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about an Amazon RDS DB security group.

" + } + }, + "com.amazonaws.securityhub#AwsRdsDbSecurityGroupEc2SecurityGroup": { + "type": "structure", + "members": { + "Ec2SecurityGroupId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Specifies the ID for the EC2 security group.

" + } + }, + "Ec2SecurityGroupName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Specifies the name of the EC2 security group.

" + } + }, + "Ec2SecurityGroupOwnerId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Provides the Amazon Web Services ID of the owner of the EC2 security group.

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Provides the status of the EC2 security group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

EC2 security group information for an RDS DB security group.

" + } + }, + "com.amazonaws.securityhub#AwsRdsDbSecurityGroupEc2SecurityGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsRdsDbSecurityGroupEc2SecurityGroup" + } + }, + "com.amazonaws.securityhub#AwsRdsDbSecurityGroupIpRange": { + "type": "structure", + "members": { + "CidrIp": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Specifies the IP range.

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Specifies the status of the IP range.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

IP range information for an RDS DB security group.

" + } + }, + "com.amazonaws.securityhub#AwsRdsDbSecurityGroupIpRanges": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsRdsDbSecurityGroupIpRange" + } + }, + "com.amazonaws.securityhub#AwsRdsDbSnapshotDetails": { + "type": "structure", + "members": { + "DbSnapshotIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name or ARN of the DB snapshot that is used to restore the DB instance.

" + } + }, + "DbInstanceIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A name for the DB instance.

" + } + }, + "SnapshotCreateTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

When the snapshot was taken in Coordinated Universal Time (UTC).

" + } + }, + "Engine": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the database engine to use for this DB instance. Valid values are as follows:

\n " + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount of storage (in gigabytes) to be initially allocated for the database instance.

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of this DB snapshot.

" + } + }, + "Port": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The port that the database engine was listening on at the time of the snapshot.

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Specifies the name of the Availability Zone in which the DB instance was located at the time of the DB snapshot.

" + } + }, + "VpcId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The VPC ID associated with the DB snapshot.

" + } + }, + "InstanceCreateTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.

" + } + }, + "MasterUsername": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The master user name for the DB snapshot.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The version of the database engine.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

License model information for the restored DB instance.

" + } + }, + "SnapshotType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of the DB snapshot.

" + } + }, + "Iops": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The option group name for the DB snapshot.

" + } + }, + "PercentProgress": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The percentage of the estimated data that has been transferred.

" + } + }, + "SourceRegion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region that the DB snapshot was created in or copied from.

" + } + }, + "SourceDbSnapshotIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The DB snapshot ARN that the DB snapshot was copied from.

" + } + }, + "StorageType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The storage type associated with the DB snapshot. Valid values are as follows:

\n " + } + }, + "TdeCredentialArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

" + } + }, + "Encrypted": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the DB snapshot is encrypted.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

If Encrypted is true, the KMS key identifier for the encrypted DB snapshot.

" + } + }, + "Timezone": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The time zone of the DB snapshot.

" + } + }, + "IamDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether mapping of IAM accounts to database accounts is enabled.

" + } + }, + "ProcessorFeatures": { + "target": "com.amazonaws.securityhub#AwsRdsDbProcessorFeatures", + "traits": { + "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

" + } + }, + "DbiResourceId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier for the source DB instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about an Amazon RDS DB cluster snapshot.

" + } + }, + "com.amazonaws.securityhub#AwsRdsDbStatusInfo": { + "type": "structure", + "members": { + "StatusType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of status. For a read replica, the status type is read replication.

" + } + }, + "Normal": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the read replica instance is operating normally.

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of the read replica instance.

" + } + }, + "Message": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

If the read replica is currently in an error state, provides the error details.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the status of a read replica.

" + } + }, + "com.amazonaws.securityhub#AwsRdsDbStatusInfos": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsRdsDbStatusInfo" + } + }, + "com.amazonaws.securityhub#AwsRdsDbSubnetGroup": { + "type": "structure", + "members": { + "DbSubnetGroupName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the subnet group.

" + } + }, + "DbSubnetGroupDescription": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description of the subnet group.

" + } + }, + "VpcId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The VPC ID of the subnet group.

" + } + }, + "SubnetGroupStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of the subnet group.

" + } + }, + "Subnets": { + "target": "com.amazonaws.securityhub#AwsRdsDbSubnetGroupSubnets", + "traits": { + "smithy.api#documentation": "

A list of subnets in the subnet group.

" + } + }, + "DbSubnetGroupArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the subnet group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the subnet group for the database instance.

" + } + }, + "com.amazonaws.securityhub#AwsRdsDbSubnetGroupSubnet": { + "type": "structure", + "members": { + "SubnetIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of a subnet in the subnet group.

" + } + }, + "SubnetAvailabilityZone": { + "target": "com.amazonaws.securityhub#AwsRdsDbSubnetGroupSubnetAvailabilityZone", + "traits": { + "smithy.api#documentation": "

Information about the Availability Zone for a subnet in the subnet group.

" + } + }, + "SubnetStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of a subnet in the subnet group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a subnet in a subnet group.

" + } + }, + "com.amazonaws.securityhub#AwsRdsDbSubnetGroupSubnetAvailabilityZone": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the Availability Zone for a subnet in the subnet group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An Availability Zone for a subnet in a subnet group.

" + } + }, + "com.amazonaws.securityhub#AwsRdsDbSubnetGroupSubnets": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsRdsDbSubnetGroupSubnet" + } + }, + "com.amazonaws.securityhub#AwsRdsEventSubscriptionDetails": { + "type": "structure", + "members": { + "CustSubscriptionId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the account that is associated with the event notification subscription.

" + } + }, + "CustomerAwsId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the event notification subscription.

" + } + }, + "Enabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the event notification subscription is enabled.

" + } + }, + "EventCategoriesList": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The list of event categories for the event notification subscription.

" + } + }, + "EventSubscriptionArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the event notification subscription.

" + } + }, + "SnsTopicArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the SNS topic to post the event notifications to.

" + } + }, + "SourceIdsList": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

A list of source identifiers for the event notification subscription.

" + } + }, + "SourceType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The source type for the event notification subscription.

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of the event notification subscription.

\n

Valid values: creating | modifying | deleting | active | no-permission | topic-not-exist\n

" + } + }, + "SubscriptionCreationTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The datetime when the event notification subscription was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about an Amazon RDS event notification subscription. The subscription allows Amazon RDS to post events to an SNS topic.

" + } + }, + "com.amazonaws.securityhub#AwsRdsPendingCloudWatchLogsExports": { + "type": "structure", + "members": { + "LogTypesToEnable": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

A list of log types that are being enabled.

" + } + }, + "LogTypesToDisable": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

A list of log types that are being disabled.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Identifies the log types to enable and disable.

" + } + }, + "com.amazonaws.securityhub#AwsRedshiftClusterClusterNode": { + "type": "structure", + "members": { + "NodeRole": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The role of the node. A node might be a leader node or a compute node.

" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The private IP address of the node.

" + } + }, + "PublicIpAddress": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The public IP address of the node.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A node in an Amazon Redshift cluster.

" + } + }, + "com.amazonaws.securityhub#AwsRedshiftClusterClusterNodes": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterClusterNode" + } + }, + "com.amazonaws.securityhub#AwsRedshiftClusterClusterParameterGroup": { + "type": "structure", + "members": { + "ClusterParameterStatusList": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterClusterParameterStatusList", + "traits": { + "smithy.api#documentation": "

The list of parameter statuses.

" + } + }, + "ParameterApplyStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of updates to the parameters.

" + } + }, + "ParameterGroupName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the parameter group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A cluster parameter group that is associated with an Amazon Redshift cluster.

" + } + }, + "com.amazonaws.securityhub#AwsRedshiftClusterClusterParameterGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterClusterParameterGroup" + } + }, + "com.amazonaws.securityhub#AwsRedshiftClusterClusterParameterStatus": { + "type": "structure", + "members": { + "ParameterName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the parameter.

" + } + }, + "ParameterApplyStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of the parameter. Indicates whether the parameter is in sync with the\n database, waiting for a cluster reboot, or encountered an error when it was applied.

\n

Valid values: in-sync | pending-reboot | applying\n | invalid-parameter | apply-deferred | apply-error |\n unknown-error\n

" + } + }, + "ParameterApplyErrorDescription": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The error that prevented the parameter from being applied to the database.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The status of a parameter in a cluster parameter group for an Amazon Redshift\n cluster.

" + } + }, + "com.amazonaws.securityhub#AwsRedshiftClusterClusterParameterStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterClusterParameterStatus" + } + }, + "com.amazonaws.securityhub#AwsRedshiftClusterClusterSecurityGroup": { + "type": "structure", + "members": { + "ClusterSecurityGroupName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the cluster security group.

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of the cluster security group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A security group that is associated with the cluster.

" + } + }, + "com.amazonaws.securityhub#AwsRedshiftClusterClusterSecurityGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterClusterSecurityGroup" + } + }, + "com.amazonaws.securityhub#AwsRedshiftClusterClusterSnapshotCopyStatus": { + "type": "structure", + "members": { + "DestinationRegion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The destination Region that snapshots are automatically copied to when cross-Region\n snapshot copy is enabled.

" + } + }, + "ManualSnapshotRetentionPeriod": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of days that manual snapshots are retained in the destination Region after\n they are copied from a source Region.

\n

If the value is -1,\n then the manual snapshot is retained indefinitely.

\n

Valid values: Either -1\n or an integer between 1 and 3,653

" + } + }, + "RetentionPeriod": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of days to retain automated snapshots in the destination Region after they\n are copied from a source Region.

" + } + }, + "SnapshotCopyGrantName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the snapshot copy grant.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

You can configure Amazon Redshift to copy snapshots for a cluster to another Amazon Web Services Region. This parameter \n provides information about a cross-Region snapshot copy.

" + } + }, + "com.amazonaws.securityhub#AwsRedshiftClusterDeferredMaintenanceWindow": { + "type": "structure", + "members": { + "DeferMaintenanceEndTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The end of the time window for which maintenance was deferred.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "DeferMaintenanceIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the maintenance window.

" + } + }, + "DeferMaintenanceStartTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The start of the time window for which maintenance was deferred.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A time windows during which maintenance was deferred for an Amazon Redshift\n cluster.

" + } + }, + "com.amazonaws.securityhub#AwsRedshiftClusterDeferredMaintenanceWindows": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterDeferredMaintenanceWindow" + } + }, + "com.amazonaws.securityhub#AwsRedshiftClusterDetails": { + "type": "structure", + "members": { + "AllowVersionUpgrade": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether major version upgrades are applied automatically to the cluster during\n the maintenance window.

" + } + }, + "AutomatedSnapshotRetentionPeriod": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of days that automatic cluster snapshots are retained.

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the Availability Zone in which the cluster is located.

" + } + }, + "ClusterAvailabilityStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The availability status of the cluster for queries. Possible values are the\n following:

\n " + } + }, + "ClusterCreateTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the cluster was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "ClusterIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The unique identifier of the cluster.

" + } + }, + "ClusterNodes": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterClusterNodes", + "traits": { + "smithy.api#documentation": "

The nodes in the cluster.

" + } + }, + "ClusterParameterGroups": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterClusterParameterGroups", + "traits": { + "smithy.api#documentation": "

The list of cluster parameter groups that are associated with this cluster.

" + } + }, + "ClusterPublicKey": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The public key for the cluster.

" + } + }, + "ClusterRevisionNumber": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The specific revision number of the database in the cluster.

" + } + }, + "ClusterSecurityGroups": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterClusterSecurityGroups", + "traits": { + "smithy.api#documentation": "

A list of cluster security groups that are associated with the cluster.

" + } + }, + "ClusterSnapshotCopyStatus": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterClusterSnapshotCopyStatus", + "traits": { + "smithy.api#documentation": "

Information about the destination Region and retention period for the cross-Region\n snapshot copy.

" + } + }, + "ClusterStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The current status of the cluster.

\n

Valid values: available | available, prep-for-resize |\n available, resize-cleanup | cancelling-resize |\n creating | deleting | final-snapshot |\n hardware-failure | incompatible-hsm |\n incompatible-network | incompatible-parameters |\n incompatible-restore | modifying | paused |\n rebooting | renaming | resizing |\n rotating-keys | storage-full |\n updating-hsm\n

" + } + }, + "ClusterSubnetGroupName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the subnet group that is associated with the cluster. This parameter is\n valid only when the cluster is in a VPC.

" + } + }, + "ClusterVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The version ID of the Amazon Redshift engine that runs on the cluster.

" + } + }, + "DBName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the initial database that was created when the cluster was created.

\n

The same name is returned for the life of the cluster.

\n

If an initial database is not specified, a database named devdev is created\n by default.

" + } + }, + "DeferredMaintenanceWindows": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterDeferredMaintenanceWindows", + "traits": { + "smithy.api#documentation": "

List of time windows during which maintenance was deferred.

" + } + }, + "ElasticIpStatus": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterElasticIpStatus", + "traits": { + "smithy.api#documentation": "

Information about the status of the Elastic IP (EIP) address.

" + } + }, + "ElasticResizeNumberOfNodeOptions": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The number of nodes that you can use the elastic resize method to resize the cluster\n to.

" + } + }, + "Encrypted": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the data in the cluster is encrypted at rest.

" + } + }, + "Endpoint": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterEndpoint", + "traits": { + "smithy.api#documentation": "

The connection endpoint.

" + } + }, + "EnhancedVpcRouting": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to create the cluster with enhanced VPC routing enabled.

" + } + }, + "ExpectedNextSnapshotScheduleTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the next snapshot is expected to be taken. The cluster must have a valid\n snapshot schedule and have backups enabled.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "ExpectedNextSnapshotScheduleTimeStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of the next expected snapshot.

\n

Valid values: OnTrack | Pending\n

" + } + }, + "HsmStatus": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterHsmStatus", + "traits": { + "smithy.api#documentation": "

Information about whether the Amazon Redshift cluster finished applying any changes to\n hardware security module (HSM) settings that were specified in a modify cluster\n command.

" + } + }, + "IamRoles": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterIamRoles", + "traits": { + "smithy.api#documentation": "

A list of IAM roles that the cluster can use to access other Amazon Web Services services.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the KMS encryption key that is used to encrypt data in the\n cluster.

" + } + }, + "MaintenanceTrackName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the maintenance track for the cluster.

" + } + }, + "ManualSnapshotRetentionPeriod": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The default number of days to retain a manual snapshot.

\n

If the value is -1, the snapshot is retained indefinitely.

\n

This setting doesn't change the retention period of existing snapshots.

\n

Valid values: Either -1 or an integer between 1 and 3,653

" + } + }, + "MasterUsername": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The master user name for the cluster. This name is used to connect to the database that\n is specified in as the value of DBName.

" + } + }, + "NextMaintenanceWindowStartTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates the start of the next maintenance window.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "NodeType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The node type for the nodes in the cluster.

" + } + }, + "NumberOfNodes": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of compute nodes in the cluster.

" + } + }, + "PendingActions": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

A list of cluster operations that are waiting to start.

" + } + }, + "PendingModifiedValues": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterPendingModifiedValues", + "traits": { + "smithy.api#documentation": "

A list of changes to the cluster that are currently pending.

" + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The weekly time range, in Universal Coordinated Time (UTC), during which system\n maintenance can occur.

\n

Format:\n \n :HH:MM-:HH:MM\n

\n

For the day values, use mon | tue | wed |\n thu | fri | sat | sun\n

\n

For example, sun:09:32-sun:10:02\n

" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the cluster can be accessed from a public network.

" + } + }, + "ResizeInfo": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterResizeInfo", + "traits": { + "smithy.api#documentation": "

Information about the resize operation for the cluster.

" + } + }, + "RestoreStatus": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterRestoreStatus", + "traits": { + "smithy.api#documentation": "

Information about the status of a cluster restore action. Only applies to a cluster that\n was created by restoring a snapshot.

" + } + }, + "SnapshotScheduleIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A unique identifier for the cluster snapshot schedule.

" + } + }, + "SnapshotScheduleState": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The current state of the cluster snapshot schedule.

\n

Valid values: MODIFYING | ACTIVE | FAILED\n

" + } + }, + "VpcId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the VPC that the cluster is in, if the cluster is in a VPC.

" + } + }, + "VpcSecurityGroups": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterVpcSecurityGroups", + "traits": { + "smithy.api#documentation": "

The list of VPC security groups that the cluster belongs to, if the cluster is in a\n VPC.

" + } + }, + "LoggingStatus": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterLoggingStatus", + "traits": { + "smithy.api#documentation": "

Information about the logging status of the cluster.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about an Amazon Redshift cluster.

" + } + }, + "com.amazonaws.securityhub#AwsRedshiftClusterElasticIpStatus": { + "type": "structure", + "members": { + "ElasticIp": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The elastic IP address for the cluster.

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of the elastic IP address.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The status of the elastic IP (EIP) address for an Amazon Redshift cluster.

" + } + }, + "com.amazonaws.securityhub#AwsRedshiftClusterEndpoint": { + "type": "structure", + "members": { + "Address": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The DNS address of the cluster.

" + } + }, + "Port": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The port that the database engine listens on.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The connection endpoint for an Amazon Redshift cluster.

" + } + }, + "com.amazonaws.securityhub#AwsRedshiftClusterHsmStatus": { + "type": "structure", + "members": { + "HsmClientCertificateIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the HSM client certificate that the Amazon Redshift cluster uses to retrieve\n the data encryption keys that are stored in an HSM.

" + } + }, + "HsmConfigurationIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the HSM configuration that contains the information that the Amazon Redshift\n cluster can use to retrieve and store keys in an HSM.

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates whether the Amazon Redshift cluster has finished applying any HSM settings\n changes specified in a modify cluster command.

\n

Type: String

\n

Valid values: active | applying\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about whether an Amazon Redshift cluster finished applying any hardware\n changes to security module (HSM) settings that were specified in a modify cluster\n command.

" + } + }, + "com.amazonaws.securityhub#AwsRedshiftClusterIamRole": { + "type": "structure", + "members": { + "ApplyStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of the IAM role's association with the cluster.

\n

Valid values: in-sync | adding | removing\n

" + } + }, + "IamRoleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An IAM role that the cluster can use to access other Amazon Web Services services.

" + } + }, + "com.amazonaws.securityhub#AwsRedshiftClusterIamRoles": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterIamRole" + } + }, + "com.amazonaws.securityhub#AwsRedshiftClusterLoggingStatus": { + "type": "structure", + "members": { + "BucketName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the S3 bucket where the log files are stored.

" + } + }, + "LastFailureMessage": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The message indicating that the logs failed to be delivered.

" + } + }, + "LastFailureTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The last time when logs failed to be delivered.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "LastSuccessfulDeliveryTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The last time that logs were delivered successfully.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "LoggingEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether logging is enabled.

" + } + }, + "S3KeyPrefix": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Provides the prefix applied to the log file names.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the logging status of the cluster.

" + } + }, + "com.amazonaws.securityhub#AwsRedshiftClusterPendingModifiedValues": { + "type": "structure", + "members": { + "AutomatedSnapshotRetentionPeriod": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The pending or in-progress change to the automated snapshot retention period.

" + } + }, + "ClusterIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The pending or in-progress change to the identifier for the cluster.

" + } + }, + "ClusterType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The pending or in-progress change to the cluster type.

" + } + }, + "ClusterVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The pending or in-progress change to the service version.

" + } + }, + "EncryptionType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The encryption type for a cluster.

" + } + }, + "EnhancedVpcRouting": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to create the cluster with enhanced VPC routing enabled.

" + } + }, + "MaintenanceTrackName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the maintenance track that the cluster changes to during the next\n maintenance window.

" + } + }, + "MasterUserPassword": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The pending or in-progress change to the master user password for the cluster.

" + } + }, + "NodeType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The pending or in-progress change to the cluster's node type.

" + } + }, + "NumberOfNodes": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The pending or in-progress change to the number of nodes in the cluster.

" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

The pending or in-progress change to whether the cluster can be connected to from the\n public network.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Changes to the Amazon Redshift cluster that are currently pending.

" + } + }, + "com.amazonaws.securityhub#AwsRedshiftClusterResizeInfo": { + "type": "structure", + "members": { + "AllowCancelResize": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the resize operation can be canceled.

" + } + }, + "ResizeType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of resize operation.

\n

Valid values: ClassicResize\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the resize operation for the cluster.

" + } + }, + "com.amazonaws.securityhub#AwsRedshiftClusterRestoreStatus": { + "type": "structure", + "members": { + "CurrentRestoreRateInMegaBytesPerSecond": { + "target": "com.amazonaws.securityhub#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of megabytes per second being transferred from the backup storage. Returns\n the average rate for a completed backup.

\n

This field is only updated when you restore to DC2 and DS2 node types.

" + } + }, + "ElapsedTimeInSeconds": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount of time an in-progress restore has been running, or the amount of time it\n took a completed restore to finish.

\n

This field is only updated when you restore to DC2 and DS2 node types.

" + } + }, + "EstimatedTimeToCompletionInSeconds": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The estimate of the time remaining before the restore is complete. Returns 0 for a\n completed restore.

\n

This field is only updated when you restore to DC2 and DS2 node types.

" + } + }, + "ProgressInMegaBytes": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of megabytes that were transferred from snapshot storage.

\n

This field is only updated when you restore to DC2 and DS2 node types.

" + } + }, + "SnapshotSizeInMegaBytes": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The size of the set of snapshot data that was used to restore the cluster.

\n

This field is only updated when you restore to DC2 and DS2 node types.

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of the restore action.

\n

Valid values: starting | restoring | completed |\n failed\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the status of a cluster restore action. It only applies if the cluster\n was created by restoring a snapshot.

" + } + }, + "com.amazonaws.securityhub#AwsRedshiftClusterVpcSecurityGroup": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of the VPC security group.

" + } + }, + "VpcSecurityGroupId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the VPC security group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A VPC security group that the cluster belongs to, if the cluster is in a VPC.

" + } + }, + "com.amazonaws.securityhub#AwsRedshiftClusterVpcSecurityGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterVpcSecurityGroup" + } + }, + "com.amazonaws.securityhub#AwsS3AccountPublicAccessBlockDetails": { + "type": "structure", + "members": { + "BlockPublicAcls": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to reject calls to update an S3 bucket if the calls include a public access control list (ACL).

" + } + }, + "BlockPublicPolicy": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to reject calls to update the access policy for an S3 bucket or access point if the policy allows public access.

" + } + }, + "IgnorePublicAcls": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether Amazon S3 ignores public ACLs that are associated with an S3 bucket.

" + } + }, + "RestrictPublicBuckets": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to restrict access to an access point or S3 bucket that has a public policy to only Amazon Web Services service principals and authorized users within the S3 bucket owner's account.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

provides information about the Amazon S3 Public Access Block configuration for accounts.

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationDetails": { + "type": "structure", + "members": { + "Rules": { + "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesList", + "traits": { + "smithy.api#documentation": "

The lifecycle rules.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The lifecycle configuration for the objects in the S3 bucket.

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesAbortIncompleteMultipartUploadDetails": { + "type": "structure", + "members": { + "DaysAfterInitiation": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of days after which Amazon S3 cancels an incomplete multipart upload.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about what Amazon S3\n does when a multipart upload is incomplete.

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesDetails": { + "type": "structure", + "members": { + "AbortIncompleteMultipartUpload": { + "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesAbortIncompleteMultipartUploadDetails", + "traits": { + "smithy.api#documentation": "

How Amazon S3 responds when a multipart upload is incomplete. Specifically, provides a number\n of days before Amazon S3 cancels the entire upload.

" + } + }, + "ExpirationDate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The date when objects are moved or deleted.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "ExpirationInDays": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The length in days of the lifetime for objects that are subject to the rule.

" + } + }, + "ExpiredObjectDeleteMarker": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether Amazon S3 removes a delete marker that has no noncurrent versions. If set to\n true, the delete marker is expired. If set to false, the policy\n takes no action.

\n

If you provide ExpiredObjectDeleteMarker, you cannot provide\n ExpirationInDays or ExpirationDate.

" + } + }, + "Filter": { + "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesFilterDetails", + "traits": { + "smithy.api#documentation": "

Identifies the objects that a rule applies to.

" + } + }, + "ID": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The unique identifier of the rule.

" + } + }, + "NoncurrentVersionExpirationInDays": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of days that an object is noncurrent before Amazon S3 can perform the associated action.

" + } + }, + "NoncurrentVersionTransitions": { + "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsList", + "traits": { + "smithy.api#documentation": "

Transition rules that describe when noncurrent objects transition to a specified storage class.

" + } + }, + "Prefix": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A prefix that identifies one or more objects that the rule applies to.

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The current status of the rule. Indicates whether the rule is currently being applied.

" + } + }, + "Transitions": { + "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesTransitionsList", + "traits": { + "smithy.api#documentation": "

Transition rules that indicate when objects transition to a specified storage class.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration for a lifecycle rule.

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesFilterDetails": { + "type": "structure", + "members": { + "Predicate": { + "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails", + "traits": { + "smithy.api#documentation": "

The configuration for the filter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Identifies the objects that a rule applies to.

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails": { + "type": "structure", + "members": { + "Operands": { + "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsList", + "traits": { + "smithy.api#documentation": "

The values to use for the filter.

" + } + }, + "Prefix": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A prefix filter.

" + } + }, + "Tag": { + "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails", + "traits": { + "smithy.api#documentation": "

A tag filter.

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Whether to use AND or OR to join the operands. \nValid values are LifecycleAndOperator or LifecycleOrOperator.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for the filter.

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails": { + "type": "structure", + "members": { + "Prefix": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Prefix text for matching objects.

" + } + }, + "Tag": { + "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails", + "traits": { + "smithy.api#documentation": "

A tag that is assigned to matching objects.

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of filter value. \nValid values are LifecyclePrefixPredicate or LifecycleTagPredicate.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A value to use for the filter.

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails" + } + }, + "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The tag key.

" + } + }, + "Value": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The tag value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A tag that is assigned to matching objects.

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The tag key.

" + } + }, + "Value": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The tag value

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A tag filter.

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesDetails" + } + }, + "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDetails": { + "type": "structure", + "members": { + "Days": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of days that an object is noncurrent before Amazon S3 can perform the associated action.

" + } + }, + "StorageClass": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The class of storage to change the object to after the object is noncurrent for the specified number of days.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A transition rule that describes when noncurrent objects transition to a specified storage class.

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDetails" + } + }, + "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails": { + "type": "structure", + "members": { + "Date": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A date on which to transition objects to the specified storage class. If you provide Date, you cannot provide Days.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "Days": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of days after which to transition the object to the specified storage class. If you provide Days, you cannot provide Date.

" + } + }, + "StorageClass": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The storage class to transition the object to. Valid values are as follows:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

A rule for when objects transition to specific storage classes.

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesTransitionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails" + } + }, + "com.amazonaws.securityhub#AwsS3BucketBucketVersioningConfiguration": { + "type": "structure", + "members": { + "IsMfaDeleteEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether MFA delete is currently enabled in the S3 bucket versioning configuration. If the S3 bucket was never configured with MFA delete, then this attribute is not included.

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The versioning status of the S3 bucket. Valid values are Enabled or Suspended.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the versioning state of an S3 bucket.

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketDetails": { + "type": "structure", + "members": { + "OwnerId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The canonical user ID of the owner of the S3 bucket.

" + } + }, + "OwnerName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The display name of the owner of the S3 bucket.

" + } + }, + "OwnerAccountId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account identifier of the account that owns the S3 bucket.

" + } + }, + "CreatedAt": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the S3 bucket was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "ServerSideEncryptionConfiguration": { + "target": "com.amazonaws.securityhub#AwsS3BucketServerSideEncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

The encryption rules that are applied to the S3 bucket.

" + } + }, + "BucketLifecycleConfiguration": { + "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationDetails", + "traits": { + "smithy.api#documentation": "

The lifecycle configuration for objects in the S3 bucket.

" + } + }, + "PublicAccessBlockConfiguration": { + "target": "com.amazonaws.securityhub#AwsS3AccountPublicAccessBlockDetails", + "traits": { + "smithy.api#documentation": "

Provides information about the Amazon S3 Public Access Block configuration for the S3 bucket.

" + } + }, + "AccessControlList": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The access control list for the S3 bucket.

" + } + }, + "BucketLoggingConfiguration": { + "target": "com.amazonaws.securityhub#AwsS3BucketLoggingConfiguration", + "traits": { + "smithy.api#documentation": "

The logging configuration for the S3 bucket.

" + } + }, + "BucketWebsiteConfiguration": { + "target": "com.amazonaws.securityhub#AwsS3BucketWebsiteConfiguration", + "traits": { + "smithy.api#documentation": "

The website configuration parameters for the S3 bucket.

" + } + }, + "BucketNotificationConfiguration": { + "target": "com.amazonaws.securityhub#AwsS3BucketNotificationConfiguration", + "traits": { + "smithy.api#documentation": "

The notification configuration for the S3 bucket.

" + } + }, + "BucketVersioningConfiguration": { + "target": "com.amazonaws.securityhub#AwsS3BucketBucketVersioningConfiguration", + "traits": { + "smithy.api#documentation": "

The versioning state of an S3 bucket.

" + } + }, + "ObjectLockConfiguration": { + "target": "com.amazonaws.securityhub#AwsS3BucketObjectLockConfiguration", + "traits": { + "smithy.api#documentation": "

\n Specifies which rule Amazon S3 applies by default to every new object placed in the specified bucket. \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details of an Amazon S3 bucket.

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketLoggingConfiguration": { + "type": "structure", + "members": { + "DestinationBucketName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the S3 bucket where log files for the S3 bucket are stored.

" + } + }, + "LogFilePrefix": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The prefix added to log files for the S3 bucket.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about logging for\n the S3 bucket

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketNotificationConfiguration": { + "type": "structure", + "members": { + "Configurations": { + "target": "com.amazonaws.securityhub#AwsS3BucketNotificationConfigurationDetails", + "traits": { + "smithy.api#documentation": "

Configurations for S3 bucket notifications.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The notification\n configuration for the S3 bucket.

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketNotificationConfigurationDetail": { + "type": "structure", + "members": { + "Events": { + "target": "com.amazonaws.securityhub#AwsS3BucketNotificationConfigurationEvents", + "traits": { + "smithy.api#documentation": "

The list of events that trigger a notification.

" + } + }, + "Filter": { + "target": "com.amazonaws.securityhub#AwsS3BucketNotificationConfigurationFilter", + "traits": { + "smithy.api#documentation": "

The filters that determine which S3 buckets generate notifications.

" + } + }, + "Destination": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the Lambda function, Amazon SQS queue, or Amazon SNS topic that generates the\n notification.

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates the type of notification. Notifications can be generated using Lambda functions,\n Amazon SQS queues, or Amazon SNS topics, with corresponding valid values as follows:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Details for an S3 bucket notification configuration.

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketNotificationConfigurationDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsS3BucketNotificationConfigurationDetail" + } + }, + "com.amazonaws.securityhub#AwsS3BucketNotificationConfigurationEvents": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#NonEmptyString" + } + }, + "com.amazonaws.securityhub#AwsS3BucketNotificationConfigurationFilter": { + "type": "structure", + "members": { + "S3KeyFilter": { + "target": "com.amazonaws.securityhub#AwsS3BucketNotificationConfigurationS3KeyFilter", + "traits": { + "smithy.api#documentation": "

Details for an Amazon S3 filter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Filtering information for the notifications. The\n filtering is based on Amazon S3 key names.

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketNotificationConfigurationS3KeyFilter": { + "type": "structure", + "members": { + "FilterRules": { + "target": "com.amazonaws.securityhub#AwsS3BucketNotificationConfigurationS3KeyFilterRules", + "traits": { + "smithy.api#documentation": "

The filter rules for the filter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details for an Amazon S3 filter.

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketNotificationConfigurationS3KeyFilterRule": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#AwsS3BucketNotificationConfigurationS3KeyFilterRuleName", + "traits": { + "smithy.api#documentation": "

Indicates whether the filter is based on the prefix or suffix of the Amazon S3 key.

" + } + }, + "Value": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The filter value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details for a filter rule.

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketNotificationConfigurationS3KeyFilterRuleName": { + "type": "enum", + "members": { + "PREFIX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Prefix" + } + }, + "SUFFIX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Suffix" + } + } + } + }, + "com.amazonaws.securityhub#AwsS3BucketNotificationConfigurationS3KeyFilterRules": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsS3BucketNotificationConfigurationS3KeyFilterRule" + } + }, + "com.amazonaws.securityhub#AwsS3BucketObjectLockConfiguration": { + "type": "structure", + "members": { + "ObjectLockEnabled": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Indicates whether the bucket has an Object Lock configuration enabled. \n

" + } + }, + "Rule": { + "target": "com.amazonaws.securityhub#AwsS3BucketObjectLockConfigurationRuleDetails", + "traits": { + "smithy.api#documentation": "

\n Specifies the Object Lock rule for the specified object. \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The container element for S3 Object Lock configuration parameters. In Amazon S3, Object Lock can help prevent objects from being deleted or overwritten for a fixed amount of time or indefinitely.\n

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails": { + "type": "structure", + "members": { + "Days": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The number of days that you want to specify for the default retention period.\n

" + } + }, + "Mode": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The default Object Lock retention mode you want to apply to new objects placed in the specified bucket.\n

" + } + }, + "Years": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The number of years that you want to specify for the default retention period.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The default S3 Object Lock retention mode and period that you want to apply to new objects placed in the specified Amazon S3 bucket. \n

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketObjectLockConfigurationRuleDetails": { + "type": "structure", + "members": { + "DefaultRetention": { + "target": "com.amazonaws.securityhub#AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails", + "traits": { + "smithy.api#documentation": "

\n The default Object Lock retention mode and period that you want to apply to new objects placed in the specified bucket. \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Specifies the S3 Object Lock rule for the specified object. In Amazon S3, Object Lock can help prevent objects from being deleted or overwritten for a fixed amount of time or indefinitely.\n

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketServerSideEncryptionByDefault": { + "type": "structure", + "members": { + "SSEAlgorithm": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Server-side encryption algorithm to use for the default encryption. Valid values are \naws: kms or AES256.

" + } + }, + "KMSMasterKeyID": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

KMS key ID to use for the default encryption.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the default server-side encryption to apply to new objects in the\n bucket.

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketServerSideEncryptionConfiguration": { + "type": "structure", + "members": { + "Rules": { + "target": "com.amazonaws.securityhub#AwsS3BucketServerSideEncryptionRules", + "traits": { + "smithy.api#documentation": "

The encryption rules that are applied to the S3 bucket.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The encryption configuration for the S3 bucket.

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketServerSideEncryptionRule": { + "type": "structure", + "members": { + "ApplyServerSideEncryptionByDefault": { + "target": "com.amazonaws.securityhub#AwsS3BucketServerSideEncryptionByDefault", + "traits": { + "smithy.api#documentation": "

Specifies the default server-side encryption to apply to new objects in the bucket. If a\n PUT object request doesn't specify any server-side encryption, this default\n encryption is applied.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An encryption rule to apply to the S3 bucket.

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketServerSideEncryptionRules": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsS3BucketServerSideEncryptionRule" + } + }, + "com.amazonaws.securityhub#AwsS3BucketWebsiteConfiguration": { + "type": "structure", + "members": { + "ErrorDocument": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the error document for the website.

" + } + }, + "IndexDocumentSuffix": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the index document for the website.

" + } + }, + "RedirectAllRequestsTo": { + "target": "com.amazonaws.securityhub#AwsS3BucketWebsiteConfigurationRedirectTo", + "traits": { + "smithy.api#documentation": "

The redirect behavior for requests to the website.

" + } + }, + "RoutingRules": { + "target": "com.amazonaws.securityhub#AwsS3BucketWebsiteConfigurationRoutingRules", + "traits": { + "smithy.api#documentation": "

The rules for applying redirects for requests to the website.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Website parameters for the S3\n bucket.

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketWebsiteConfigurationRedirectTo": { + "type": "structure", + "members": { + "Hostname": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the host to redirect requests to.

" + } + }, + "Protocol": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The protocol to use when redirecting requests. By default, this field uses the same protocol as the\n original request. Valid values are http or https.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The redirect behavior for requests\n to the website.

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketWebsiteConfigurationRoutingRule": { + "type": "structure", + "members": { + "Condition": { + "target": "com.amazonaws.securityhub#AwsS3BucketWebsiteConfigurationRoutingRuleCondition", + "traits": { + "smithy.api#documentation": "

Provides the condition that must be met in order to apply the routing rule.

" + } + }, + "Redirect": { + "target": "com.amazonaws.securityhub#AwsS3BucketWebsiteConfigurationRoutingRuleRedirect", + "traits": { + "smithy.api#documentation": "

Provides the rules to redirect the request if the condition in Condition is\n met.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A rule for redirecting requests\n to the website.

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketWebsiteConfigurationRoutingRuleCondition": { + "type": "structure", + "members": { + "HttpErrorCodeReturnedEquals": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates to redirect the request if the HTTP error code matches this value.

" + } + }, + "KeyPrefixEquals": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates to redirect the request if the key prefix matches this value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The condition that must be met in order to apply the routing rule.

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketWebsiteConfigurationRoutingRuleRedirect": { + "type": "structure", + "members": { + "Hostname": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The host name to use in the redirect request.

" + } + }, + "HttpRedirectCode": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The HTTP redirect code to use in the response.

" + } + }, + "Protocol": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The protocol to use to redirect the request. By default, uses the protocol from the\n original request.

" + } + }, + "ReplaceKeyPrefixWith": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The object key prefix to use in the redirect request.

\n

Cannot be provided if ReplaceKeyWith is present.

" + } + }, + "ReplaceKeyWith": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The specific object key to use in the redirect request.

\n

Cannot be provided if ReplaceKeyPrefixWith is present.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The rules to redirect the request if the condition in Condition is\n met.

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketWebsiteConfigurationRoutingRules": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsS3BucketWebsiteConfigurationRoutingRule" + } + }, + "com.amazonaws.securityhub#AwsS3ObjectDetails": { + "type": "structure", + "members": { + "LastModified": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the object was last modified.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "ETag": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The opaque identifier assigned by a web server to a specific version of a resource found\n at a URL.

" + } + }, + "VersionId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The version of the object.

" + } + }, + "ContentType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A standard MIME type describing the format of the object data.

" + } + }, + "ServerSideEncryption": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

If the object is stored using server-side encryption, the value of the server-side\n encryption algorithm used when storing this object in Amazon S3.

" + } + }, + "SSEKMSKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the KMS symmetric customer managed key that was used for the object.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about an Amazon S3 object.

" + } + }, + "com.amazonaws.securityhub#AwsSageMakerNotebookInstanceDetails": { + "type": "structure", + "members": { + "AcceleratorTypes": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

\n A list of Amazon Elastic Inference instance types to associate with the notebook instance. Currently, only one instance type can be associated with a notebook instance. \n

" + } + }, + "AdditionalCodeRepositories": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

\n 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 CodeCommit or in any other Git repository. \n These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git repositories with SageMaker notebook instances in the Amazon SageMaker Developer Guide.\n

" + } + }, + "DefaultCodeRepository": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n 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 CodeCommit or in any other Git repository. \n When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git repositories with SageMaker notebook instances in the Amazon SageMaker Developer Guide.\n

" + } + }, + "DirectInternetAccess": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Sets whether SageMaker provides internet access to the notebook instance. If you set this to Disabled, this notebook instance is able to access resources only in your VPC, and is not be able to connect to SageMaker training and endpoint services unless you configure a Network Address Translation (NAT) Gateway in your VPC.\n

" + } + }, + "FailureReason": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n If status of the instance is Failed, the reason it failed.\n

" + } + }, + "InstanceMetadataServiceConfiguration": { + "target": "com.amazonaws.securityhub#AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails", + "traits": { + "smithy.api#documentation": "

\n Information on the IMDS configuration of the notebook instance.\n

" + } + }, + "InstanceType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The type of machine learning (ML) compute instance to launch for the notebook instance.\n

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of an Key Management Service (KMS) key that 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 \n Enabling and disabling keys in the Key Management Service Developer Guide.\n

" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The network interface ID that SageMaker created when the instance was created.\n

" + } + }, + "NotebookInstanceArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the notebook instance.\n

" + } + }, + "NotebookInstanceLifecycleConfigName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The name of a notebook instance lifecycle configuration.\n

" + } + }, + "NotebookInstanceName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The name of the new notebook instance.\n

" + } + }, + "NotebookInstanceStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The status of the notebook instance.\n

" + } + }, + "PlatformIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The platform identifier of the notebook instance runtime environment.\n

" + } + }, + "RoleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the IAM role associated with the instance.\n

" + } + }, + "RootAccess": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Whether root access is enabled or disabled for users of the notebook instance. \n

" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

\n The VPC security group IDs.\n

" + } + }, + "SubnetId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of the VPC subnet to which you have a connectivity from your ML compute instance.\n

" + } + }, + "Url": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.\n

" + } + }, + "VolumeSizeInGB": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The size, in GB, of the ML storage volume to attach to the notebook instance.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides details about an Amazon SageMaker notebook instance.\n

" + } + }, + "com.amazonaws.securityhub#AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails": { + "type": "structure", + "members": { + "MinimumInstanceMetadataServiceVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Indicates the minimum IMDS version that the notebook instance supports.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Information on the instance metadata service (IMDS) configuration of the notebook instance.\n

" + } + }, + "com.amazonaws.securityhub#AwsSecretsManagerSecretDetails": { + "type": "structure", + "members": { + "RotationRules": { + "target": "com.amazonaws.securityhub#AwsSecretsManagerSecretRotationRules", + "traits": { + "smithy.api#documentation": "

Defines the rotation schedule for the secret.

" + } + }, + "RotationOccurredWithinFrequency": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the rotation occurred within the specified rotation frequency.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN, Key ID, or alias of the KMS key used to encrypt the\n SecretString or SecretBinary values for versions of this\n secret.

" + } + }, + "RotationEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether rotation is enabled.

" + } + }, + "RotationLambdaArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the Lambda function that rotates the secret.

" + } + }, + "Deleted": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the secret is deleted.

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the secret.

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The user-provided description of the secret.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about an Secrets Manager secret.

" + } + }, + "com.amazonaws.securityhub#AwsSecretsManagerSecretRotationRules": { + "type": "structure", + "members": { + "AutomaticallyAfterDays": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of days after the previous rotation to rotate the secret.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the rotation schedule for the secret.

" + } + }, + "com.amazonaws.securityhub#AwsSecurityFinding": { + "type": "structure", + "members": { + "SchemaVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The schema version that a finding is formatted for.

", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The security findings provider-specific identifier for a finding.

", + "smithy.api#required": {} + } + }, + "ProductArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN generated by Security Hub that uniquely identifies a product that generates findings.\n This can be the ARN for a third-party product that is integrated with Security Hub, or the ARN for\n a custom integration.

", + "smithy.api#required": {} + } + }, + "ProductName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the product that generated the finding.

\n

Security Hub populates this attribute automatically for each finding. You cannot update this attribute with BatchImportFindings or BatchUpdateFindings. The exception to this is a custom integration.

\n

When you use the Security Hub console or API to filter findings by product name, you use this attribute.

" + } + }, + "CompanyName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the company for the product that generated the finding.

\n

Security Hub populates this attribute automatically for each finding. You cannot update this attribute with BatchImportFindings or BatchUpdateFindings. The exception to this is a custom integration.

\n

When you use the Security Hub console or API to filter findings by company name, you use this attribute.

" + } + }, + "Region": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Region from which the finding was generated.

\n

Security Hub populates this attribute automatically for each finding. You cannot update it using BatchImportFindings or BatchUpdateFindings.

" + } + }, + "GeneratorId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier for the solution-specific component (a discrete unit of logic) that\n generated a finding. In various security findings providers' solutions, this generator can\n be called a rule, a check, a detector, a plugin, etc.

", + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID that a finding is generated in.

", + "smithy.api#required": {} + } + }, + "Types": { + "target": "com.amazonaws.securityhub#TypeList", + "traits": { + "smithy.api#documentation": "

One or more finding types in the format of namespace/category/classifier\n that classify a finding.

\n

Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual\n Behaviors | Sensitive Data Identifications

" + } + }, + "FirstObservedAt": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the security findings provider first observed the potential security\n issue that a finding captured.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "LastObservedAt": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the security findings provider most recently observed the potential\n security issue that a finding captured.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "CreatedAt": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the security findings provider created the potential security issue that\n a finding captured.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

", + "smithy.api#required": {} + } + }, + "UpdatedAt": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the security findings provider last updated the finding record.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

", + "smithy.api#required": {} + } + }, + "Severity": { + "target": "com.amazonaws.securityhub#Severity", + "traits": { + "smithy.api#documentation": "

A finding's severity.

" + } + }, + "Confidence": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

A finding's confidence. Confidence is defined as the likelihood that a finding\n accurately identifies the behavior or issue that it was intended to identify.

\n

Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent\n confidence and 100 means 100 percent confidence.

" + } + }, + "Criticality": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The level of importance assigned to the resources associated with the finding.

\n

A score of 0 means that the underlying resources have no criticality, and a score of 100\n is reserved for the most critical resources.

" + } + }, + "Title": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A finding's title.

\n \n

In this release, Title is a required property.

\n ", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A finding's description.

\n \n

In this release, Description is a required property.

\n ", + "smithy.api#required": {} + } + }, + "Remediation": { + "target": "com.amazonaws.securityhub#Remediation", + "traits": { + "smithy.api#documentation": "

A data type that describes the remediation options for a finding.

" + } + }, + "SourceUrl": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A URL that links to a page about the current finding in the security findings provider's\n solution.

" + } + }, + "ProductFields": { + "target": "com.amazonaws.securityhub#FieldMap", + "traits": { + "smithy.api#documentation": "

A data type where security findings providers can include additional solution-specific\n details that aren't part of the defined AwsSecurityFinding format.

\n

Can contain up to 50 key-value pairs. For each key-value pair, the key can contain up to 128 characters, and the value can contain up to 2048 characters.

" + } + }, + "UserDefinedFields": { + "target": "com.amazonaws.securityhub#FieldMap", + "traits": { + "smithy.api#documentation": "

A list of name/value string pairs associated with the finding. These are custom,\n user-defined fields added to a finding.

" + } + }, + "Malware": { + "target": "com.amazonaws.securityhub#MalwareList", + "traits": { + "smithy.api#documentation": "

A list of malware related to a finding.

" + } + }, + "Network": { + "target": "com.amazonaws.securityhub#Network", + "traits": { + "smithy.api#documentation": "

The details of network-related information about a finding.

" + } + }, + "NetworkPath": { + "target": "com.amazonaws.securityhub#NetworkPathList", + "traits": { + "smithy.api#documentation": "

Provides information about a network path that is relevant to a finding. Each entry\n under NetworkPath represents a component of that path.

" + } + }, + "Process": { + "target": "com.amazonaws.securityhub#ProcessDetails", + "traits": { + "smithy.api#documentation": "

The details of process-related information about a finding.

" + } + }, + "Threats": { + "target": "com.amazonaws.securityhub#ThreatList", + "traits": { + "smithy.api#documentation": "

Details about the threat detected in a security finding and the file paths that were affected by the threat.\n

" + } + }, + "ThreatIntelIndicators": { + "target": "com.amazonaws.securityhub#ThreatIntelIndicatorList", + "traits": { + "smithy.api#documentation": "

Threat intelligence details related to a finding.

" + } + }, + "Resources": { + "target": "com.amazonaws.securityhub#ResourceList", + "traits": { + "smithy.api#documentation": "

A set of resource data types that describe the resources that the finding refers\n to.

", + "smithy.api#required": {} + } + }, + "Compliance": { + "target": "com.amazonaws.securityhub#Compliance", + "traits": { + "smithy.api#documentation": "

This data type is exclusive to findings that are generated as the result of a check run\n against a specific rule in a supported security standard, such as CIS Amazon Web Services Foundations.\n Contains security standard-related finding details.

" + } + }, + "VerificationState": { + "target": "com.amazonaws.securityhub#VerificationState", + "traits": { + "smithy.api#documentation": "

Indicates the veracity of a finding.

" + } + }, + "WorkflowState": { + "target": "com.amazonaws.securityhub#WorkflowState", + "traits": { + "smithy.api#documentation": "

The workflow state of a finding.

" + } + }, + "Workflow": { + "target": "com.amazonaws.securityhub#Workflow", + "traits": { + "smithy.api#documentation": "

Provides information about the status of the investigation into a finding.

" + } + }, + "RecordState": { + "target": "com.amazonaws.securityhub#RecordState", + "traits": { + "smithy.api#documentation": "

The record state of a finding.

" + } + }, + "RelatedFindings": { + "target": "com.amazonaws.securityhub#RelatedFindingList", + "traits": { + "smithy.api#documentation": "

A list of related findings.

" + } + }, + "Note": { + "target": "com.amazonaws.securityhub#Note", + "traits": { + "smithy.api#documentation": "

A user-defined note added to a finding.

" + } + }, + "Vulnerabilities": { + "target": "com.amazonaws.securityhub#VulnerabilityList", + "traits": { + "smithy.api#documentation": "

Provides a list of vulnerabilities associated with the findings.

" + } + }, + "PatchSummary": { + "target": "com.amazonaws.securityhub#PatchSummary", + "traits": { + "smithy.api#documentation": "

Provides an overview of the patch compliance status for an instance against a selected\n compliance standard.

" + } + }, + "Action": { + "target": "com.amazonaws.securityhub#Action", + "traits": { + "smithy.api#documentation": "

Provides details about an action that affects or that was taken on a resource.

" + } + }, + "FindingProviderFields": { + "target": "com.amazonaws.securityhub#FindingProviderFields", + "traits": { + "smithy.api#documentation": "

In a BatchImportFindings request, finding providers use FindingProviderFields to provide and update their own values for confidence, criticality, related findings, severity, and types.

" + } + }, + "Sample": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the finding is a sample finding.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides a consistent format for Security Hub findings.\n AwsSecurityFinding format allows you to share findings between Amazon Web Services\n security services and third-party solutions.

\n \n

A finding is a potential security issue generated either by Amazon Web Services services or by the integrated third-party\n solutions and standards checks.

\n " + } + }, + "com.amazonaws.securityhub#AwsSecurityFindingFilters": { + "type": "structure", + "members": { + "ProductArn": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The ARN generated by Security Hub that uniquely identifies a third-party company\n (security findings provider) after this provider's product (solution that generates\n findings) is registered with Security Hub.

" + } + }, + "AwsAccountId": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID that a finding is generated in.

" + } + }, + "Id": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The security findings provider-specific identifier for a finding.

" + } + }, + "GeneratorId": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The identifier for the solution-specific component (a discrete unit of logic) that\n generated a finding. In various security findings providers' solutions, this generator can\n be called a rule, a check, a detector, a plugin, etc.

" + } + }, + "Region": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The Region from which the finding was generated.

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

A finding type in the format of namespace/category/classifier that\n classifies a finding.

" + } + }, + "FirstObservedAt": { + "target": "com.amazonaws.securityhub#DateFilterList", + "traits": { + "smithy.api#documentation": "

An ISO8601-formatted timestamp that indicates when the security findings provider first\n observed the potential security issue that a finding captured.

\n

A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.

" + } + }, + "LastObservedAt": { + "target": "com.amazonaws.securityhub#DateFilterList", + "traits": { + "smithy.api#documentation": "

An ISO8601-formatted timestamp that indicates when the security findings provider most\n recently observed the potential security issue that a finding captured.

\n

A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.

" + } + }, + "CreatedAt": { + "target": "com.amazonaws.securityhub#DateFilterList", + "traits": { + "smithy.api#documentation": "

An ISO8601-formatted timestamp that indicates when the security findings provider\n captured the potential security issue that a finding captured.

\n

A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.

" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.securityhub#DateFilterList", + "traits": { + "smithy.api#documentation": "

An ISO8601-formatted timestamp that indicates when the security findings provider last\n updated the finding record.

\n

A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.

" + } + }, + "SeverityProduct": { + "target": "com.amazonaws.securityhub#NumberFilterList", + "traits": { + "smithy.api#deprecated": { + "message": "This filter is deprecated. Instead, use FindingProviderSeverityOriginal." + }, + "smithy.api#documentation": "

The native severity as defined by the security findings provider's solution that\n generated the finding.

" + } + }, + "SeverityNormalized": { + "target": "com.amazonaws.securityhub#NumberFilterList", + "traits": { + "smithy.api#deprecated": { + "message": "This filter is deprecated. Instead, use SeverityLabel or FindingProviderFieldsSeverityLabel." + }, + "smithy.api#documentation": "

The normalized severity of a finding.

" + } + }, + "SeverityLabel": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The label of a finding's severity.

" + } + }, + "Confidence": { + "target": "com.amazonaws.securityhub#NumberFilterList", + "traits": { + "smithy.api#documentation": "

A finding's confidence. Confidence is defined as the likelihood that a finding\n accurately identifies the behavior or issue that it was intended to identify.

\n

Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent\n confidence and 100 means 100 percent confidence.

" + } + }, + "Criticality": { + "target": "com.amazonaws.securityhub#NumberFilterList", + "traits": { + "smithy.api#documentation": "

The level of importance assigned to the resources associated with the finding.

\n

A score of 0 means that the underlying resources have no criticality, and a score of 100\n is reserved for the most critical resources.

" + } + }, + "Title": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

A finding's title.

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

A finding's description.

" + } + }, + "RecommendationText": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The recommendation of what to do about the issue described in a finding.

" + } + }, + "SourceUrl": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

A URL that links to a page about the current finding in the security findings provider's\n solution.

" + } + }, + "ProductFields": { + "target": "com.amazonaws.securityhub#MapFilterList", + "traits": { + "smithy.api#documentation": "

A data type where security findings providers can include additional solution-specific\n details that aren't part of the defined AwsSecurityFinding format.

" + } + }, + "ProductName": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The name of the solution (product) that generates findings.

" + } + }, + "CompanyName": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The name of the findings provider (company) that owns the solution (product) that\n generates findings.

" + } + }, + "UserDefinedFields": { + "target": "com.amazonaws.securityhub#MapFilterList", + "traits": { + "smithy.api#documentation": "

A list of name/value string pairs associated with the finding. These are custom,\n user-defined fields added to a finding.

" + } + }, + "MalwareName": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The name of the malware that was observed.

" + } + }, + "MalwareType": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The type of the malware that was observed.

" + } + }, + "MalwarePath": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The filesystem path of the malware that was observed.

" + } + }, + "MalwareState": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The state of the malware that was observed.

" + } + }, + "NetworkDirection": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

Indicates the direction of network traffic associated with a finding.

" + } + }, + "NetworkProtocol": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The protocol of network-related information about a finding.

" + } + }, + "NetworkSourceIpV4": { + "target": "com.amazonaws.securityhub#IpFilterList", + "traits": { + "smithy.api#documentation": "

The source IPv4 address of network-related information about a finding.

" + } + }, + "NetworkSourceIpV6": { + "target": "com.amazonaws.securityhub#IpFilterList", + "traits": { + "smithy.api#documentation": "

The source IPv6 address of network-related information about a finding.

" + } + }, + "NetworkSourcePort": { + "target": "com.amazonaws.securityhub#NumberFilterList", + "traits": { + "smithy.api#documentation": "

The source port of network-related information about a finding.

" + } + }, + "NetworkSourceDomain": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The source domain of network-related information about a finding.

" + } + }, + "NetworkSourceMac": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The source media access control (MAC) address of network-related information about a\n finding.

" + } + }, + "NetworkDestinationIpV4": { + "target": "com.amazonaws.securityhub#IpFilterList", + "traits": { + "smithy.api#documentation": "

The destination IPv4 address of network-related information about a finding.

" + } + }, + "NetworkDestinationIpV6": { + "target": "com.amazonaws.securityhub#IpFilterList", + "traits": { + "smithy.api#documentation": "

The destination IPv6 address of network-related information about a finding.

" + } + }, + "NetworkDestinationPort": { + "target": "com.amazonaws.securityhub#NumberFilterList", + "traits": { + "smithy.api#documentation": "

The destination port of network-related information about a finding.

" + } + }, + "NetworkDestinationDomain": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The destination domain of network-related information about a finding.

" + } + }, + "ProcessName": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The name of the process.

" + } + }, + "ProcessPath": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The path to the process executable.

" + } + }, + "ProcessPid": { + "target": "com.amazonaws.securityhub#NumberFilterList", + "traits": { + "smithy.api#documentation": "

The process ID.

" + } + }, + "ProcessParentPid": { + "target": "com.amazonaws.securityhub#NumberFilterList", + "traits": { + "smithy.api#documentation": "

The parent process ID. This field accepts positive integers between O and 2147483647.

" + } + }, + "ProcessLaunchedAt": { + "target": "com.amazonaws.securityhub#DateFilterList", + "traits": { + "smithy.api#documentation": "

A timestamp that identifies when the process was launched.

\n

A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.

" + } + }, + "ProcessTerminatedAt": { + "target": "com.amazonaws.securityhub#DateFilterList", + "traits": { + "smithy.api#documentation": "

A timestamp that identifies when the process was terminated.

\n

A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.

" + } + }, + "ThreatIntelIndicatorType": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The type of a threat intelligence indicator.

" + } + }, + "ThreatIntelIndicatorValue": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The value of a threat intelligence indicator.

" + } + }, + "ThreatIntelIndicatorCategory": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The category of a threat intelligence indicator.

" + } + }, + "ThreatIntelIndicatorLastObservedAt": { + "target": "com.amazonaws.securityhub#DateFilterList", + "traits": { + "smithy.api#documentation": "

A timestamp that identifies the last observation of a threat intelligence indicator.

" + } + }, + "ThreatIntelIndicatorSource": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The source of the threat intelligence.

" + } + }, + "ThreatIntelIndicatorSourceUrl": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The URL for more details from the source of the threat intelligence.

" + } + }, + "ResourceType": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

Specifies the type of the resource that details are provided for.

" + } + }, + "ResourceId": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The canonical identifier for the given resource type.

" + } + }, + "ResourcePartition": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The canonical Amazon Web Services partition name that the Region is assigned to.

" + } + }, + "ResourceRegion": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The canonical Amazon Web Services external Region name where this resource is located.

" + } + }, + "ResourceTags": { + "target": "com.amazonaws.securityhub#MapFilterList", + "traits": { + "smithy.api#documentation": "

A list of Amazon Web Services tags associated with a resource at the time the finding was\n processed.

" + } + }, + "ResourceAwsEc2InstanceType": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The instance type of the instance.

" + } + }, + "ResourceAwsEc2InstanceImageId": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The Amazon Machine Image (AMI) ID of the instance.

" + } + }, + "ResourceAwsEc2InstanceIpV4Addresses": { + "target": "com.amazonaws.securityhub#IpFilterList", + "traits": { + "smithy.api#documentation": "

The IPv4 addresses associated with the instance.

" + } + }, + "ResourceAwsEc2InstanceIpV6Addresses": { + "target": "com.amazonaws.securityhub#IpFilterList", + "traits": { + "smithy.api#documentation": "

The IPv6 addresses associated with the instance.

" + } + }, + "ResourceAwsEc2InstanceKeyName": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The key name associated with the instance.

" + } + }, + "ResourceAwsEc2InstanceIamInstanceProfileArn": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The IAM profile ARN of the instance.

" + } + }, + "ResourceAwsEc2InstanceVpcId": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The identifier of the VPC that the instance was launched in.

" + } + }, + "ResourceAwsEc2InstanceSubnetId": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The identifier of the subnet that the instance was launched in.

" + } + }, + "ResourceAwsEc2InstanceLaunchedAt": { + "target": "com.amazonaws.securityhub#DateFilterList", + "traits": { + "smithy.api#documentation": "

The date and time the instance was launched.

" + } + }, + "ResourceAwsS3BucketOwnerId": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The canonical user ID of the owner of the S3 bucket.

" + } + }, + "ResourceAwsS3BucketOwnerName": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The display name of the owner of the S3 bucket.

" + } + }, + "ResourceAwsIamAccessKeyUserName": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#deprecated": { + "message": "This filter is deprecated. Instead, use ResourceAwsIamAccessKeyPrincipalName." + }, + "smithy.api#documentation": "

The user associated with the IAM access key related to a finding.

" + } + }, + "ResourceAwsIamAccessKeyPrincipalName": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The name of the principal that is associated with an IAM access key.

" + } + }, + "ResourceAwsIamAccessKeyStatus": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The status of the IAM access key related to a finding.

" + } + }, + "ResourceAwsIamAccessKeyCreatedAt": { + "target": "com.amazonaws.securityhub#DateFilterList", + "traits": { + "smithy.api#documentation": "

The creation date/time of the IAM access key related to a finding.

" + } + }, + "ResourceAwsIamUserUserName": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The name of an IAM user.

" + } + }, + "ResourceContainerName": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The name of the container related to a finding.

" + } + }, + "ResourceContainerImageId": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The identifier of the image related to a finding.

" + } + }, + "ResourceContainerImageName": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The name of the image related to a finding.

" + } + }, + "ResourceContainerLaunchedAt": { + "target": "com.amazonaws.securityhub#DateFilterList", + "traits": { + "smithy.api#documentation": "

A timestamp that identifies when the container was started.

\n

A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.

" + } + }, + "ResourceDetailsOther": { + "target": "com.amazonaws.securityhub#MapFilterList", + "traits": { + "smithy.api#documentation": "

The details of a resource that doesn't have a specific subfield for the resource type\n defined.

" + } + }, + "ComplianceStatus": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

Exclusive to findings that are generated as the result of a check run against a specific\n rule in a supported standard, such as CIS Amazon Web Services Foundations. Contains security\n standard-related finding details.

" + } + }, + "VerificationState": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The veracity of a finding.

" + } + }, + "WorkflowState": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The workflow state of a finding.

\n

Note that this field is deprecated. To search for a finding based on its workflow\n status, use WorkflowStatus.

" + } + }, + "WorkflowStatus": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The status of the investigation into a finding. Allowed values are the following.

\n " + } + }, + "RecordState": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The updated record state for the finding.

" + } + }, + "RelatedFindingsProductArn": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The ARN of the solution that generated a related finding.

" + } + }, + "RelatedFindingsId": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The solution-generated identifier for a related finding.

" + } + }, + "NoteText": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The text of a note.

" + } + }, + "NoteUpdatedAt": { + "target": "com.amazonaws.securityhub#DateFilterList", + "traits": { + "smithy.api#documentation": "

The timestamp of when the note was updated.

" + } + }, + "NoteUpdatedBy": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The principal that created a note.

" + } + }, + "Keyword": { + "target": "com.amazonaws.securityhub#KeywordFilterList", + "traits": { + "smithy.api#deprecated": { + "message": "The Keyword property is deprecated." + }, + "smithy.api#documentation": "

A keyword for a finding.

" + } + }, + "FindingProviderFieldsConfidence": { + "target": "com.amazonaws.securityhub#NumberFilterList", + "traits": { + "smithy.api#documentation": "

The finding provider value for the finding confidence. Confidence is defined as the likelihood\n that a finding accurately identifies the behavior or issue that it was intended to\n identify.

\n

Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent\n confidence and 100 means 100 percent confidence.

" + } + }, + "FindingProviderFieldsCriticality": { + "target": "com.amazonaws.securityhub#NumberFilterList", + "traits": { + "smithy.api#documentation": "

The finding provider value for the level of importance assigned to the resources associated with\n the findings.

\n

A score of 0 means that the underlying resources have no criticality, and a score of 100\n is reserved for the most critical resources.

" + } + }, + "FindingProviderFieldsRelatedFindingsId": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The finding identifier of a related finding that is identified by the finding provider.

" + } + }, + "FindingProviderFieldsRelatedFindingsProductArn": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The ARN of the solution that generated a related finding that is identified by the finding provider.

" + } + }, + "FindingProviderFieldsSeverityLabel": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The finding provider value for the severity label.

" + } + }, + "FindingProviderFieldsSeverityOriginal": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The finding provider's original value for the severity.

" + } + }, + "FindingProviderFieldsTypes": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

One or more finding types that the finding provider assigned to the finding. Uses the format of namespace/category/classifier\n that classify a finding.

\n

Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual\n Behaviors | Sensitive Data Identifications

" + } + }, + "Sample": { + "target": "com.amazonaws.securityhub#BooleanFilterList", + "traits": { + "smithy.api#documentation": "

Indicates whether or not sample findings are included in the filter results.

" + } + }, + "ComplianceSecurityControlId": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of a control across standards. Values for this field typically consist of an \n Amazon Web Service and a number, such as APIGateway.5.\n

" + } + }, + "ComplianceAssociatedStandardsId": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of a standard in which a control is enabled. This field consists of the resource portion of the \n Amazon Resource Name (ARN) returned for a standard in the DescribeStandards API response.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A collection of attributes that are applied to all active Security Hub-aggregated findings and\n that result in a subset of findings that are included in this insight.

\n

You can filter by up to 10 finding attributes. For each attribute, you can provide up to\n 20 filter values.

" + } + }, + "com.amazonaws.securityhub#AwsSecurityFindingIdentifier": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the finding that was specified by the finding provider.

", + "smithy.api#required": {} + } + }, + "ProductArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN generated by Security Hub that uniquely identifies a product that generates findings.\n This can be the ARN for a third-party product that is integrated with Security Hub, or the ARN for\n a custom integration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Identifies which finding to get the finding history for.

" + } + }, + "com.amazonaws.securityhub#AwsSecurityFindingIdentifierList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsSecurityFindingIdentifier" + } + }, + "com.amazonaws.securityhub#AwsSecurityFindingList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsSecurityFinding" + } + }, + "com.amazonaws.securityhub#AwsSnsTopicDetails": { + "type": "structure", + "members": { + "KmsMasterKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of an Amazon Web Services managed key for Amazon SNS or a customer managed key.

" + } + }, + "Subscription": { + "target": "com.amazonaws.securityhub#AwsSnsTopicSubscriptionList", + "traits": { + "smithy.api#documentation": "

Subscription is an embedded property that describes the subscription endpoints of an Amazon SNS topic.

" + } + }, + "TopicName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the Amazon SNS topic.

" + } + }, + "Owner": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The subscription's owner.

" + } + }, + "SqsSuccessFeedbackRoleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.\n

" + } + }, + "SqsFailureFeedbackRoleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.\n

" + } + }, + "ApplicationSuccessFeedbackRoleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates failed message delivery status for an Amazon SNS topic that is subscribed to a platform application endpoint.\n

" + } + }, + "FirehoseSuccessFeedbackRoleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.\n

" + } + }, + "FirehoseFailureFeedbackRoleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.\n

" + } + }, + "HttpSuccessFeedbackRoleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.\n

" + } + }, + "HttpFailureFeedbackRoleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about an Amazon SNS topic to which notifications can be published.

" + } + }, + "com.amazonaws.securityhub#AwsSnsTopicSubscription": { + "type": "structure", + "members": { + "Endpoint": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The subscription's endpoint (format depends on the protocol).

" + } + }, + "Protocol": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The subscription's protocol.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A wrapper type for the attributes of an Amazon SNS subscription.

" + } + }, + "com.amazonaws.securityhub#AwsSnsTopicSubscriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsSnsTopicSubscription" + } + }, + "com.amazonaws.securityhub#AwsSqsQueueDetails": { + "type": "structure", + "members": { + "KmsDataKeyReusePeriodSeconds": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling KMS again.

" + } + }, + "KmsMasterKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of an Amazon Web Services managed key for Amazon SQS or a custom\n KMS key.

" + } + }, + "QueueName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the new queue.

" + } + }, + "DeadLetterTargetArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the dead-letter queue to which Amazon SQS moves\n messages after the value of maxReceiveCount is exceeded.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Data about a queue.

" + } + }, + "com.amazonaws.securityhub#AwsSsmComplianceSummary": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The current patch compliance status. Valid values are as follows:

\n " + } + }, + "CompliantCriticalCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

For the patches that are compliant, the number that have a severity of\n CRITICAL.

" + } + }, + "CompliantHighCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

For the patches that are compliant, the number that have a severity of\n HIGH.

" + } + }, + "CompliantMediumCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

For the patches that are compliant, the number that have a severity of\n MEDIUM.

" + } + }, + "ExecutionType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of execution that was used determine compliance.

" + } + }, + "NonCompliantCriticalCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

For the patch items that are noncompliant, the number of items that have a severity of\n CRITICAL.

" + } + }, + "CompliantInformationalCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

For the patches that are compliant, the number that have a severity of\n INFORMATIONAL.

" + } + }, + "NonCompliantInformationalCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

For the patches that are noncompliant, the number that have a severity of\n INFORMATIONAL.

" + } + }, + "CompliantUnspecifiedCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

For the patches that are compliant, the number that have a severity of\n UNSPECIFIED.

" + } + }, + "NonCompliantLowCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

For the patches that are noncompliant, the number that have a severity of\n LOW.

" + } + }, + "NonCompliantHighCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

For the patches that are noncompliant, the number that have a severity of\n HIGH.

" + } + }, + "CompliantLowCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

For the patches that are compliant, the number that have a severity of\n LOW.

" + } + }, + "ComplianceType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of resource for which the compliance was determined. For\n AwsSsmPatchCompliance, ComplianceType is Patch.

" + } + }, + "PatchBaselineId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the patch baseline. The patch baseline lists the patches that are\n approved for installation.

" + } + }, + "OverallSeverity": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The highest severity for the patches. Valid values are as follows:

\n " + } + }, + "NonCompliantMediumCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

For the patches that are noncompliant, the number that have a severity of\n MEDIUM.

" + } + }, + "NonCompliantUnspecifiedCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

For the patches that are noncompliant, the number that have a severity of\n UNSPECIFIED.

" + } + }, + "PatchGroup": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the patch group for which compliance was determined. A patch group\n uses tags to group EC2 instances that should have the same patch compliance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides the details about the compliance status for a patch.

" + } + }, + "com.amazonaws.securityhub#AwsSsmPatch": { + "type": "structure", + "members": { + "ComplianceSummary": { + "target": "com.amazonaws.securityhub#AwsSsmComplianceSummary", + "traits": { + "smithy.api#documentation": "

The compliance status details for the patch.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about the compliance for a patch.

" + } + }, + "com.amazonaws.securityhub#AwsSsmPatchComplianceDetails": { + "type": "structure", + "members": { + "Patch": { + "target": "com.amazonaws.securityhub#AwsSsmPatch", + "traits": { + "smithy.api#documentation": "

Information about the status of a patch.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the state of a patch on an instance based on the patch\n baseline that was used to patch the instance.

" + } + }, + "com.amazonaws.securityhub#AwsStepFunctionStateMachineDetails": { + "type": "structure", + "members": { + "Label": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n A user-defined or an auto-generated string that identifies a Map state. This parameter is present only if \n the stateMachineArn specified in input is a qualified state machine ARN.\n

" + } + }, + "LoggingConfiguration": { + "target": "com.amazonaws.securityhub#AwsStepFunctionStateMachineLoggingConfigurationDetails", + "traits": { + "smithy.api#documentation": "

\n Used to set CloudWatch Logs options.\n

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The name of the state machine.\n

" + } + }, + "RoleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the IAM role used when creating this state machine.\n

" + } + }, + "StateMachineArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ARN that identifies the state machine.\n

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The current status of the state machine.\n

" + } + }, + "TracingConfiguration": { + "target": "com.amazonaws.securityhub#AwsStepFunctionStateMachineTracingConfigurationDetails", + "traits": { + "smithy.api#documentation": "

\n Specifies whether X-Ray tracing is enabled.\n

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The type of the state machine (STANDARD or EXPRESS).\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides details about an Step Functions state machine, which is a workflow consisting of a series of event-\n driven steps.\n

" + } + }, + "com.amazonaws.securityhub#AwsStepFunctionStateMachineLoggingConfigurationDestinationsCloudWatchLogsLogGroupDetails": { + "type": "structure", + "members": { + "LogGroupArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN (ends with :*) of the CloudWatch Logs log group to which you want your logs emitted.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n An object describing a CloudWatch log group. For more information, see \n \n Amazon Web Services::Logs::LogGroup in the CloudFormation User Guide.\n

" + } + }, + "com.amazonaws.securityhub#AwsStepFunctionStateMachineLoggingConfigurationDestinationsDetails": { + "type": "structure", + "members": { + "CloudWatchLogsLogGroup": { + "target": "com.amazonaws.securityhub#AwsStepFunctionStateMachineLoggingConfigurationDestinationsCloudWatchLogsLogGroupDetails", + "traits": { + "smithy.api#documentation": "

\n An object describing a CloudWatch Logs log group. For more information, see \n \n Amazon Web Services::Logs::LogGroup in the CloudFormation User Guide.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n An array of objects that describes where your execution history events will be logged.\n

" + } + }, + "com.amazonaws.securityhub#AwsStepFunctionStateMachineLoggingConfigurationDestinationsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsStepFunctionStateMachineLoggingConfigurationDestinationsDetails" + } + }, + "com.amazonaws.securityhub#AwsStepFunctionStateMachineLoggingConfigurationDetails": { + "type": "structure", + "members": { + "Destinations": { + "target": "com.amazonaws.securityhub#AwsStepFunctionStateMachineLoggingConfigurationDestinationsList", + "traits": { + "smithy.api#documentation": "

\n An array of objects that describes where your execution history events will be logged. \n

" + } + }, + "IncludeExecutionData": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Determines whether execution data is included in your log. When set to false, data is excluded.\n

" + } + }, + "Level": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Defines which category of execution history events are logged.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The LoggingConfiguration data type is used to set CloudWatch Logs options.\n

" + } + }, + "com.amazonaws.securityhub#AwsStepFunctionStateMachineTracingConfigurationDetails": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n When set to true, X-Ray tracing is enabled.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Specifies whether X-Ray tracing is enabled.\n

" + } + }, + "com.amazonaws.securityhub#AwsWafRateBasedRuleDetails": { + "type": "structure", + "members": { + "MetricName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the metrics for the rate-based rule.

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the rate-based rule.

" + } + }, + "RateKey": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The field that WAF uses to determine whether requests are likely arriving from single source and are subject to rate monitoring.

" + } + }, + "RateLimit": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of requests that have an identical value for the field specified in RateKey that are allowed within a five-minute period. If the number of requests exceeds RateLimit and the other predicates specified in the rule are met, WAF triggers the action for the rule.

" + } + }, + "RuleId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The unique identifier for the rate-based rule.

" + } + }, + "MatchPredicates": { + "target": "com.amazonaws.securityhub#AwsWafRateBasedRuleMatchPredicateList", + "traits": { + "smithy.api#documentation": "

The predicates to include in the rate-based rule.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about a rate-based rule for global resources. A rate-based rule provides settings to indicate when to allow, block, or count a request. Rate-based rules include the number of requests that arrive over a specified period of time.

" + } + }, + "com.amazonaws.securityhub#AwsWafRateBasedRuleMatchPredicate": { + "type": "structure", + "members": { + "DataId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The unique identifier for the predicate.

" + } + }, + "Negated": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

If set to true, then the rule actions are performed on requests that match the predicate settings.

\n

If set to false, then the rule actions are performed on all requests except those that match the predicate settings.\n

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of predicate. Valid values are as follows:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

A match predicate. A predicate might look for characteristics such as specific IP addresses, geographic locations, or sizes.

" + } + }, + "com.amazonaws.securityhub#AwsWafRateBasedRuleMatchPredicateList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsWafRateBasedRuleMatchPredicate" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalRateBasedRuleDetails": { + "type": "structure", + "members": { + "MetricName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the metrics for the rate-based rule.

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the rate-based rule.

" + } + }, + "RateKey": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The field that WAF uses to determine whether requests are likely arriving from single source and are subject to rate monitoring.

" + } + }, + "RateLimit": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of requests that have an identical value for the field specified in RateKey that are allowed within a five-minute period. If the number of requests exceeds RateLimit and the other predicates specified in the rule are met, WAF triggers the action for the rule.

" + } + }, + "RuleId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The unique identifier for the rate-based rule.

" + } + }, + "MatchPredicates": { + "target": "com.amazonaws.securityhub#AwsWafRegionalRateBasedRuleMatchPredicateList", + "traits": { + "smithy.api#documentation": "

The predicates to include in the rate-based rule.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

contains details about a rate-based rule for Regional resources. A rate-based rule provides settings to indicate when to allow, block, or count a request. Rate-based rules include the number of requests that arrive over a specified period of time.

" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalRateBasedRuleMatchPredicate": { + "type": "structure", + "members": { + "DataId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The unique identifier for the predicate.

" + } + }, + "Negated": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

If set to true, then the rule actions are performed on requests that match the predicate settings.

\n

If set to false, then the rule actions are performed on all requests except those that match the predicate settings.

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of predicate. Valid values are as follows:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Details for a match predicate. A predicate might look for characteristics such as specific IP addresses, geographic locations, or sizes.

" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalRateBasedRuleMatchPredicateList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsWafRegionalRateBasedRuleMatchPredicate" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalRuleDetails": { + "type": "structure", + "members": { + "MetricName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A name for the metrics for the rule. \n

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A descriptive name for the rule.\n

" + } + }, + "PredicateList": { + "target": "com.amazonaws.securityhub#AwsWafRegionalRulePredicateList", + "traits": { + "smithy.api#documentation": "

Specifies the ByteMatchSet, IPSet,\n SqlInjectionMatchSet, XssMatchSet, RegexMatchSet,\n GeoMatchSet, and SizeConstraintSet objects that you want to\n add to a rule and, for each object, indicates whether you want to negate the settings.

" + } + }, + "RuleId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the rule.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about an WAF Regional rule. This rule identifies the web requests that you want to allow, block, or count.

" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalRuleGroupDetails": { + "type": "structure", + "members": { + "MetricName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A name for the metrics for this rule group.\n

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The descriptive name of the rule group.\n

" + } + }, + "RuleGroupId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the rule group.\n

" + } + }, + "Rules": { + "target": "com.amazonaws.securityhub#AwsWafRegionalRuleGroupRulesList", + "traits": { + "smithy.api#documentation": "

Provides information about the rule statements used to identify the web requests that you want to allow, block, or \ncount. \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about an WAF Regional rule group. The rule group is a collection of rules for inspecting and controlling web\n requests.

" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalRuleGroupRulesActionDetails": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, \nGeoMatchSet, and SizeConstraintSet objects that you want to add to a rule and, for each object, indicates whether you want to negate the settings.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the action that WAF should take on a web request when it matches the criteria defined in the rule.\n

" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalRuleGroupRulesDetails": { + "type": "structure", + "members": { + "Action": { + "target": "com.amazonaws.securityhub#AwsWafRegionalRuleGroupRulesActionDetails", + "traits": { + "smithy.api#documentation": "

The action that WAF should take on a web request when it matches the criteria defined in the rule.

" + } + }, + "Priority": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

If you define more than one rule in a web ACL, WAF evaluates each request against the rules in\n order based on the value of Priority.

" + } + }, + "RuleId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID for a rule.\n

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of rule in the rule group.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the rules attached to a rule group\n

" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalRuleGroupRulesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsWafRegionalRuleGroupRulesDetails" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalRulePredicateList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsWafRegionalRulePredicateListDetails" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalRulePredicateListDetails": { + "type": "structure", + "members": { + "DataId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A unique identifier for a predicate in a rule, such as ByteMatchSetId or IPSetId.\n

" + } + }, + "Negated": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies if you want WAF to allow, block, or count requests based on the settings in the \n ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, \n RegexMatchSet, GeoMatchSet, or SizeConstraintSet.\n

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of predicate in a rule, such as ByteMatch or IPSet.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, \n 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.\n

" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalWebAclDetails": { + "type": "structure", + "members": { + "DefaultAction": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The action to perform if none of the rules contained in the web ACL match. \n

" + } + }, + "MetricName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A name for the metrics for this web ACL. \n

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A descriptive name for the web ACL. \n

" + } + }, + "RulesList": { + "target": "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesList", + "traits": { + "smithy.api#documentation": "

An array that contains the action for each rule in a web ACL, the priority of the rule, and the ID of \nthe rule.\n

" + } + }, + "WebAclId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the web ACL.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the web access control list (web ACL). The web ACL contains the rules that identify the requests that you\n want to allow, block, or count.

" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesListDetails" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesListActionDetails": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

For actions that are associated with a rule, the action that WAF takes when a web request matches all conditions in a rule.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The action that WAF takes when a web request matches all conditions in the\n rule, such as allow, block, or count the request.

" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesListDetails": { + "type": "structure", + "members": { + "Action": { + "target": "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesListActionDetails", + "traits": { + "smithy.api#documentation": "

The action that WAF takes when a web request matches all conditions in the rule, such as allow, \n block, or count the request.\n

" + } + }, + "OverrideAction": { + "target": "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesListOverrideActionDetails", + "traits": { + "smithy.api#documentation": "

Overrides the rule evaluation result in the rule group. \n

" + } + }, + "Priority": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The order in which WAF evaluates the rules in a web ACL.\n

" + } + }, + "RuleId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of an WAF Regional rule to associate with a web ACL.

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

For actions that are associated with a rule, the action that WAF takes when a web \nrequest matches all conditions in a rule.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A combination of ByteMatchSet, IPSet, and/or SqlInjectionMatchSet \nobjects that identify the web requests that you want to allow, block, or count. \n

" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesListOverrideActionDetails": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Overrides the rule evaluation result in the rule group.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about the action to use in the place of the action that results from the rule group \nevaluation. \n

" + } + }, + "com.amazonaws.securityhub#AwsWafRuleDetails": { + "type": "structure", + "members": { + "MetricName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the metrics for this rule.\n

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A descriptive name for the rule. \n

" + } + }, + "PredicateList": { + "target": "com.amazonaws.securityhub#AwsWafRulePredicateList", + "traits": { + "smithy.api#documentation": "

Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, \n RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a rule and, \n for each object, indicates whether you want to negate the settings.\n

" + } + }, + "RuleId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the WAF rule. \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about a WAF rule. This rule specifies the web requests that you want to allow, block, or count.\n

" + } + }, + "com.amazonaws.securityhub#AwsWafRuleGroupDetails": { + "type": "structure", + "members": { + "MetricName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the metrics for this rule group. \n

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the rule group. \n

" + } + }, + "RuleGroupId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the rule group.\n

" + } + }, + "Rules": { + "target": "com.amazonaws.securityhub#AwsWafRuleGroupRulesList", + "traits": { + "smithy.api#documentation": "

Provides information about the rules attached to the rule group. These rules identify the web requests that you want to \nallow, block, or count. \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about an WAF rule group. A rule group is a collection of rules for inspecting and controlling web requests. \n

" + } + }, + "com.amazonaws.securityhub#AwsWafRuleGroupRulesActionDetails": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The action that WAF should take on a web request when it matches the rule's\n statement.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about what action WAF should take on a web request when it matches the criteria defined in the rule.\n

" + } + }, + "com.amazonaws.securityhub#AwsWafRuleGroupRulesDetails": { + "type": "structure", + "members": { + "Action": { + "target": "com.amazonaws.securityhub#AwsWafRuleGroupRulesActionDetails", + "traits": { + "smithy.api#documentation": "

Provides information about what action WAF should take on a web request when it matches the criteria defined in the rule.\n

" + } + }, + "Priority": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

If you define more than one rule in a web ACL, WAF evaluates each request against the rules in order\n based on the value of Priority.

" + } + }, + "RuleId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The rule ID for a rule.\n

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of rule.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the rules attached to the rule group. These rules identify the web requests that you want to \n allow, block, or count. \n

" + } + }, + "com.amazonaws.securityhub#AwsWafRuleGroupRulesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsWafRuleGroupRulesDetails" + } + }, + "com.amazonaws.securityhub#AwsWafRulePredicateList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsWafRulePredicateListDetails" + } + }, + "com.amazonaws.securityhub#AwsWafRulePredicateListDetails": { + "type": "structure", + "members": { + "DataId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A unique identifier for a predicate in a rule, such as ByteMatchSetId or IPSetId.\n

" + } + }, + "Negated": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies if you want WAF to allow, block, or count requests based on the settings in the \n ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, \n RegexMatchSet, GeoMatchSet, or SizeConstraintSet.\n

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of predicate in a rule, such as ByteMatch or IPSet.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, \n RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a rule and, \nfor each object, indicates whether you want to negate the settings.\n

" + } + }, + "com.amazonaws.securityhub#AwsWafWebAclDetails": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A friendly name or description of the web ACL. You can't change the name of a web ACL after you create it.

" + } + }, + "DefaultAction": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The action to perform if none of the rules contained in the web ACL match.

" + } + }, + "Rules": { + "target": "com.amazonaws.securityhub#AwsWafWebAclRuleList", + "traits": { + "smithy.api#documentation": "

An array that contains the action for each rule in a web ACL, the priority of the rule, and the ID of the rule.

" + } + }, + "WebAclId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A unique identifier for a web ACL.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about an WAF web access control list (web ACL).

" + } + }, + "com.amazonaws.securityhub#AwsWafWebAclRule": { + "type": "structure", + "members": { + "Action": { + "target": "com.amazonaws.securityhub#WafAction", + "traits": { + "smithy.api#documentation": "

Specifies the action that CloudFront or WAF takes when a web request matches the\n conditions in the rule.

" + } + }, + "ExcludedRules": { + "target": "com.amazonaws.securityhub#WafExcludedRuleList", + "traits": { + "smithy.api#documentation": "

Rules to exclude from a rule group.

" + } + }, + "OverrideAction": { + "target": "com.amazonaws.securityhub#WafOverrideAction", + "traits": { + "smithy.api#documentation": "

Use the OverrideAction to test your RuleGroup.

\n

Any rule in a RuleGroup can potentially block a request. If you set the OverrideAction to\n None, the RuleGroup blocks a request if any individual rule in the RuleGroup\n matches the request and is configured to block that request.

\n

However, if you first want to test the RuleGroup,\n set the OverrideAction to Count. The RuleGroup\n then overrides any block action specified by individual rules contained within the group.\n Instead of blocking matching requests, those requests are counted.

\n

\n ActivatedRule|OverrideAction applies only when updating or\n adding a RuleGroup\n to a web ACL. In this case you do not use ActivatedRule\n Action. For all other update requests,\n ActivatedRule\n Action is used instead of ActivatedRule\n OverrideAction.

" + } + }, + "Priority": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Specifies the order in which the rules in a web\n ACL are evaluated. Rules with a lower value for Priority are\n evaluated before rules with a higher value. The value must be a unique integer. If you add\n multiple rules to a web ACL, the values do not need to be consecutive.

" + } + }, + "RuleId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier for a rule.

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The rule type.

\n

Valid values: REGULAR | RATE_BASED | GROUP\n

\n

The default is REGULAR.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details for a rule in an WAF web ACL.

" + } + }, + "com.amazonaws.securityhub#AwsWafWebAclRuleList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsWafWebAclRule" + } + }, + "com.amazonaws.securityhub#AwsWafv2ActionAllowDetails": { + "type": "structure", + "members": { + "CustomRequestHandling": { + "target": "com.amazonaws.securityhub#AwsWafv2CustomRequestHandlingDetails", + "traits": { + "smithy.api#documentation": "

\n Defines custom handling for the web request. For information about customizing web requests and responses, see \n Customizing web requests and responses in WAF in the WAF Developer Guide..\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Specifies that WAF should allow the request and optionally defines additional custom handling for the request.\n

" + } + }, + "com.amazonaws.securityhub#AwsWafv2ActionBlockDetails": { + "type": "structure", + "members": { + "CustomResponse": { + "target": "com.amazonaws.securityhub#AwsWafv2CustomResponseDetails", + "traits": { + "smithy.api#documentation": "

\n Defines a custom response for the web request. For information, see \n Customizing web requests and responses in WAF in the WAF Developer Guide..\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Specifies that WAF should block the request and optionally defines additional custom handling for the response to the web request.\n

" + } + }, + "com.amazonaws.securityhub#AwsWafv2CustomHttpHeader": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The name of the custom header.\n

" + } + }, + "Value": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The value of the custom header.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n A custom header for custom request and response handling.\n

" + } + }, + "com.amazonaws.securityhub#AwsWafv2CustomRequestHandlingDetails": { + "type": "structure", + "members": { + "InsertHeaders": { + "target": "com.amazonaws.securityhub#AwsWafv2InsertHeadersList", + "traits": { + "smithy.api#documentation": "

\n The HTTP headers to insert into the request.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Custom request handling behavior that inserts custom headers into a web request. WAF uses custom request handling when the rule action doesn't block the request.\n

" + } + }, + "com.amazonaws.securityhub#AwsWafv2CustomResponseDetails": { + "type": "structure", + "members": { + "CustomResponseBodyKey": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n References the response body that you want WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block.\n

" + } + }, + "ResponseCode": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The HTTP status code to return to the client. For a list of status codes that you can use in your custom responses, see \n Supported status codes for custom response in the WAF Developer Guide.\n

" + } + }, + "ResponseHeaders": { + "target": "com.amazonaws.securityhub#AwsWafv2InsertHeadersList", + "traits": { + "smithy.api#documentation": "

\n The HTTP headers to use in the response.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n A custom response to send to the client. You can define a custom response for rule actions and default web ACL actions that are set to block.\n

" + } + }, + "com.amazonaws.securityhub#AwsWafv2InsertHeadersList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsWafv2CustomHttpHeader" + } + }, + "com.amazonaws.securityhub#AwsWafv2RuleGroupDetails": { + "type": "structure", + "members": { + "Capacity": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The web ACL capacity units (WCUs) required for this rule group. \n

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n A description of the rule group that helps with identification.\n

" + } + }, + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n A unique identifier for the rule group. \n

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The name of the rule group. You cannot change the name of a rule group after you create it.\n

" + } + }, + "Arn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the entity.\n

" + } + }, + "Rules": { + "target": "com.amazonaws.securityhub#AwsWafv2RulesList", + "traits": { + "smithy.api#documentation": "

\n The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one \n top-level statement that WAF uses to identify matching web requests, and parameters that govern how \n WAF handles them.\n

" + } + }, + "Scope": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Specifies whether the rule group is for an Amazon CloudFront distribution or for a regional application. \n A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync \n GraphQL API, or an Amazon Cognito user pool.\n

" + } + }, + "VisibilityConfig": { + "target": "com.amazonaws.securityhub#AwsWafv2VisibilityConfigDetails", + "traits": { + "smithy.api#documentation": "

\n Defines and enables Amazon CloudWatch metrics and web request sample collection.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Details about an WAFv2 rule group.\n

" + } + }, + "com.amazonaws.securityhub#AwsWafv2RulesActionCaptchaDetails": { + "type": "structure", + "members": { + "CustomRequestHandling": { + "target": "com.amazonaws.securityhub#AwsWafv2CustomRequestHandlingDetails", + "traits": { + "smithy.api#documentation": "

\n Defines custom handling for the web request, used when the CAPTCHA inspection determines that the request's token is valid and unexpired. For more information, \n see Customizing web requests and responses in WAF in the WAF Developer Guide..\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Specifies that WAF should run a CAPTCHA check against the request.\n

" + } + }, + "com.amazonaws.securityhub#AwsWafv2RulesActionCountDetails": { + "type": "structure", + "members": { + "CustomRequestHandling": { + "target": "com.amazonaws.securityhub#AwsWafv2CustomRequestHandlingDetails", + "traits": { + "smithy.api#documentation": "

\n Defines custom handling for the web request. For more information, \n see Customizing web requests and responses in WAF in the WAF Developer Guide..\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Specifies that WAF should count the request.\n

" + } + }, + "com.amazonaws.securityhub#AwsWafv2RulesActionDetails": { + "type": "structure", + "members": { + "Allow": { + "target": "com.amazonaws.securityhub#AwsWafv2ActionAllowDetails", + "traits": { + "smithy.api#documentation": "

\n Instructs WAF to allow the web request.\n

" + } + }, + "Block": { + "target": "com.amazonaws.securityhub#AwsWafv2ActionBlockDetails", + "traits": { + "smithy.api#documentation": "

\n Instructs WAF to block the web request.\n

" + } + }, + "Captcha": { + "target": "com.amazonaws.securityhub#AwsWafv2RulesActionCaptchaDetails", + "traits": { + "smithy.api#documentation": "

\n Instructs WAF to run a CAPTCHA check against the web request.\n

" + } + }, + "Count": { + "target": "com.amazonaws.securityhub#AwsWafv2RulesActionCountDetails", + "traits": { + "smithy.api#documentation": "

\n Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The action that WAF should take on a web request when it matches a rule's statement. \n Settings at the web ACL level can override the rule action setting.\n

" + } + }, + "com.amazonaws.securityhub#AwsWafv2RulesDetails": { + "type": "structure", + "members": { + "Action": { + "target": "com.amazonaws.securityhub#AwsWafv2RulesActionDetails", + "traits": { + "smithy.api#documentation": "

\n The action that WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting.\n

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The name of the rule. \n

" + } + }, + "OverrideAction": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The action to use in the place of the action that results from the rule group evaluation. \n

" + } + }, + "Priority": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n If you define more than one Rule in a WebACL, WAF evaluates each request against the Rules in order based on the value of Priority. \n WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.\n

" + } + }, + "VisibilityConfig": { + "target": "com.amazonaws.securityhub#AwsWafv2VisibilityConfigDetails", + "traits": { + "smithy.api#documentation": "

\n Defines and enables Amazon CloudWatch metrics and web request sample collection.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides details about rules in a rule group. A rule identifies web requests that you want to allow, block, or count. Each rule includes one top-level Statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.\n

" + } + }, + "com.amazonaws.securityhub#AwsWafv2RulesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsWafv2RulesDetails" + } + }, + "com.amazonaws.securityhub#AwsWafv2VisibilityConfigDetails": { + "type": "structure", + "members": { + "CloudWatchMetricsEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n A boolean indicating whether the associated resource sends metrics to Amazon CloudWatch. For the list of available \n metrics, see WAF metrics and dimensions in the WAF Developer Guide.\n

" + } + }, + "MetricName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n A name of the Amazon CloudWatch metric. \n

" + } + }, + "SampledRequestsEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n A boolean indicating whether WAF should store a sampling of the web requests that match the rules. \n You can view the sampled requests through the WAF console.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Defines and enables Amazon CloudWatch metrics and web request sample collection.\n

" + } + }, + "com.amazonaws.securityhub#AwsWafv2WebAclActionDetails": { + "type": "structure", + "members": { + "Allow": { + "target": "com.amazonaws.securityhub#AwsWafv2ActionAllowDetails", + "traits": { + "smithy.api#documentation": "

\n Specifies that WAF should allow requests by default.\n

" + } + }, + "Block": { + "target": "com.amazonaws.securityhub#AwsWafv2ActionBlockDetails", + "traits": { + "smithy.api#documentation": "

\n Specifies that WAF should block requests by default.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Specifies the action that Amazon CloudFront or WAF takes when a web request matches the conditions in the rule.\n

" + } + }, + "com.amazonaws.securityhub#AwsWafv2WebAclCaptchaConfigDetails": { + "type": "structure", + "members": { + "ImmunityTimeProperty": { + "target": "com.amazonaws.securityhub#AwsWafv2WebAclCaptchaConfigImmunityTimePropertyDetails", + "traits": { + "smithy.api#documentation": "

\n Determines how long a CAPTCHA timestamp in the token remains valid after the client successfully solves a CAPTCHA puzzle.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings.\n

" + } + }, + "com.amazonaws.securityhub#AwsWafv2WebAclCaptchaConfigImmunityTimePropertyDetails": { + "type": "structure", + "members": { + "ImmunityTime": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The amount of time, in seconds, that a CAPTCHA or challenge timestamp is considered valid by WAF.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Used for CAPTCHA and challenge token settings. Determines how long a CAPTCHA or challenge timestamp remains valid after WAF updates it for a successful CAPTCHA or challenge response.\n

" + } + }, + "com.amazonaws.securityhub#AwsWafv2WebAclDetails": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The name of the web ACL.\n

" + } + }, + "Arn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.\n

" + } + }, + "ManagedbyFirewallManager": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Indicates whether this web ACL is managed by Firewall Manager. \n

" + } + }, + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n A unique identifier for the web ACL.\n

" + } + }, + "Capacity": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The web ACL capacity units (WCUs) currently being used by this web ACL.\n

" + } + }, + "CaptchaConfig": { + "target": "com.amazonaws.securityhub#AwsWafv2WebAclCaptchaConfigDetails", + "traits": { + "smithy.api#documentation": "

\n Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own \n CaptchaConfig settings.\n

" + } + }, + "DefaultAction": { + "target": "com.amazonaws.securityhub#AwsWafv2WebAclActionDetails", + "traits": { + "smithy.api#documentation": "

\n The action to perform if none of the Rules contained in the web ACL match.\n

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n A description of the web ACL that helps with identification.\n

" + } + }, + "Rules": { + "target": "com.amazonaws.securityhub#AwsWafv2RulesList", + "traits": { + "smithy.api#documentation": "

\n The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one \n top-level statement that WAF uses to identify matching web requests, and parameters that govern how \n WAF handles them.\n

" + } + }, + "VisibilityConfig": { + "target": "com.amazonaws.securityhub#AwsWafv2VisibilityConfigDetails", + "traits": { + "smithy.api#documentation": "

\n Defines and enables Amazon CloudWatch metrics and web request sample collection.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Details about an WAFv2 web Access Control List (ACL).\n

" + } + }, + "com.amazonaws.securityhub#AwsXrayEncryptionConfigDetails": { + "type": "structure", + "members": { + "KeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the KMS key that is used for encryption. Provided if Type is KMS.

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The current status of the encryption configuration. Valid values are ACTIVE or UPDATING.

\n

When Status is equal to UPDATING, X-Ray might use both the old and new encryption.

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of encryption. KMS indicates that the encryption uses KMS keys. NONE indicates the default encryption.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the encryption configuration for X-Ray.

" + } + }, + "com.amazonaws.securityhub#BatchDeleteAutomationRules": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#BatchDeleteAutomationRulesRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#BatchDeleteAutomationRulesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Deletes one or more automation rules.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/automationrules/delete", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#BatchDeleteAutomationRulesRequest": { + "type": "structure", + "members": { + "AutomationRulesArns": { + "target": "com.amazonaws.securityhub#AutomationRulesArnsList", + "traits": { + "smithy.api#documentation": "

\n A list of Amazon Resource Names (ARNs) for the rules that are to be deleted.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#BatchDeleteAutomationRulesResponse": { + "type": "structure", + "members": { + "ProcessedAutomationRules": { + "target": "com.amazonaws.securityhub#AutomationRulesArnsList", + "traits": { + "smithy.api#documentation": "

\n A list of properly processed rule ARNs.\n

" + } + }, + "UnprocessedAutomationRules": { + "target": "com.amazonaws.securityhub#UnprocessedAutomationRulesList", + "traits": { + "smithy.api#documentation": "

\n A list of objects containing RuleArn, ErrorCode, and ErrorMessage. This parameter \n tells you which automation rules the request didn't delete and why.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#BatchDisableStandards": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#BatchDisableStandardsRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#BatchDisableStandardsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Disables the standards specified by the provided\n StandardsSubscriptionArns.

\n

For more information, see Security Standards section of the Security Hub User\n Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/standards/deregister", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#BatchDisableStandardsRequest": { + "type": "structure", + "members": { + "StandardsSubscriptionArns": { + "target": "com.amazonaws.securityhub#StandardsSubscriptionArns", + "traits": { + "smithy.api#documentation": "

The ARNs of the standards subscriptions to disable.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#BatchDisableStandardsResponse": { + "type": "structure", + "members": { + "StandardsSubscriptions": { + "target": "com.amazonaws.securityhub#StandardsSubscriptions", + "traits": { + "smithy.api#documentation": "

The details of the standards subscriptions that were disabled.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#BatchEnableStandards": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#BatchEnableStandardsRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#BatchEnableStandardsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Enables the standards specified by the provided StandardsArn. To obtain the\n ARN for a standard, use the DescribeStandards\n operation.

\n

For more information, see the Security Standards\n section of the Security Hub User Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/standards/register", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#BatchEnableStandardsRequest": { + "type": "structure", + "members": { + "StandardsSubscriptionRequests": { + "target": "com.amazonaws.securityhub#StandardsSubscriptionRequests", + "traits": { + "smithy.api#documentation": "

The list of standards checks to enable.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#BatchEnableStandardsResponse": { + "type": "structure", + "members": { + "StandardsSubscriptions": { + "target": "com.amazonaws.securityhub#StandardsSubscriptions", + "traits": { + "smithy.api#documentation": "

The details of the standards subscriptions that were enabled.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#BatchGetAutomationRules": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#BatchGetAutomationRulesRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#BatchGetAutomationRulesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#AccessDeniedException" + }, + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Retrieves a list of details for automation rules based on rule Amazon Resource Names \n (ARNs).\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/automationrules/get", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#BatchGetAutomationRulesRequest": { + "type": "structure", + "members": { + "AutomationRulesArns": { + "target": "com.amazonaws.securityhub#AutomationRulesArnsList", + "traits": { + "smithy.api#documentation": "

\n A list of rule ARNs to get details for.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#BatchGetAutomationRulesResponse": { + "type": "structure", + "members": { + "Rules": { + "target": "com.amazonaws.securityhub#AutomationRulesConfigList", + "traits": { + "smithy.api#documentation": "

\n A list of rule details for the provided rule ARNs.\n

" + } + }, + "UnprocessedAutomationRules": { + "target": "com.amazonaws.securityhub#UnprocessedAutomationRulesList", + "traits": { + "smithy.api#documentation": "

\n A list of objects containing RuleArn, ErrorCode, and ErrorMessage. This parameter \n tells you which automation rules the request didn't retrieve and why.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#BatchGetSecurityControls": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#BatchGetSecurityControlsRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#BatchGetSecurityControlsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Provides details about a batch of security controls for the current Amazon Web Services account and Amazon Web Services Region.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/securityControls/batchGet", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#BatchGetSecurityControlsRequest": { + "type": "structure", + "members": { + "SecurityControlIds": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

A list of security controls (identified with SecurityControlId,\n SecurityControlArn, or a mix of both parameters). The security control ID\n or Amazon Resource Name (ARN) is the same across standards.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#BatchGetSecurityControlsResponse": { + "type": "structure", + "members": { + "SecurityControls": { + "target": "com.amazonaws.securityhub#SecurityControls", + "traits": { + "smithy.api#documentation": "

\n An array that returns the identifier, Amazon Resource Name (ARN), and other details about a security control. \n The same information is returned whether the request includes SecurityControlId or SecurityControlArn.\n

", + "smithy.api#required": {} + } + }, + "UnprocessedIds": { + "target": "com.amazonaws.securityhub#UnprocessedSecurityControls", + "traits": { + "smithy.api#documentation": "

\n A security control (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters) for which \n details cannot be returned.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#BatchGetStandardsControlAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#BatchGetStandardsControlAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#BatchGetStandardsControlAssociationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

\n For a batch of security controls and standards, identifies whether each control is currently enabled or disabled in a standard.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/associations/batchGet", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#BatchGetStandardsControlAssociationsRequest": { + "type": "structure", + "members": { + "StandardsControlAssociationIds": { + "target": "com.amazonaws.securityhub#StandardsControlAssociationIds", + "traits": { + "smithy.api#documentation": "

\n An array with one or more objects that includes a security control (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters) and the Amazon Resource Name (ARN) of a standard. \n This field is used to query the enablement status of a control in a specified standard. The security control ID or ARN is the same across standards.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#BatchGetStandardsControlAssociationsResponse": { + "type": "structure", + "members": { + "StandardsControlAssociationDetails": { + "target": "com.amazonaws.securityhub#StandardsControlAssociationDetails", + "traits": { + "smithy.api#documentation": "

Provides the enablement status of a security control in a specified standard and other details for the control in relation to \n the specified standard.\n

", + "smithy.api#required": {} + } + }, + "UnprocessedAssociations": { + "target": "com.amazonaws.securityhub#UnprocessedStandardsControlAssociations", + "traits": { + "smithy.api#documentation": "

\n A security control (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters) whose enablement \n status in a specified standard cannot be returned.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#BatchImportFindings": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#BatchImportFindingsRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#BatchImportFindingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Imports security findings generated by a finding provider into Security Hub.\n This action is requested by the finding provider to import its findings into\n Security Hub.

\n

\n BatchImportFindings must be called by one of the following:

\n \n

The maximum allowed size for a finding is 240 Kb. An error is returned for any finding\n larger than 240 Kb.

\n

After a finding is created, BatchImportFindings cannot be used to update\n the following finding fields and objects, which Security Hub customers use to manage their\n investigation workflow.

\n \n

Finding providers also should not use BatchImportFindings to update the following attributes.

\n \n

Instead, finding providers use FindingProviderFields to provide values for these attributes.

", + "smithy.api#http": { + "method": "POST", + "uri": "/findings/import", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#BatchImportFindingsRequest": { + "type": "structure", + "members": { + "Findings": { + "target": "com.amazonaws.securityhub#BatchImportFindingsRequestFindingList", + "traits": { + "smithy.api#documentation": "

A list of findings to import. To successfully import a finding, it must follow the\n Amazon Web Services Security Finding Format. Maximum of 100 findings per request.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#BatchImportFindingsRequestFindingList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsSecurityFinding" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.securityhub#BatchImportFindingsResponse": { + "type": "structure", + "members": { + "FailedCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of findings that failed to import.

", + "smithy.api#required": {} + } + }, + "SuccessCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of findings that were successfully imported.

", + "smithy.api#required": {} + } + }, + "FailedFindings": { + "target": "com.amazonaws.securityhub#ImportFindingsErrorList", + "traits": { + "smithy.api#documentation": "

The list of findings that failed to import.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#BatchUpdateAutomationRules": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#BatchUpdateAutomationRulesRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#BatchUpdateAutomationRulesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Updates one or more automation rules based on rule Amazon Resource Names (ARNs) \n and input parameters.\n

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/automationrules/update", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#BatchUpdateAutomationRulesRequest": { + "type": "structure", + "members": { + "UpdateAutomationRulesRequestItems": { + "target": "com.amazonaws.securityhub#UpdateAutomationRulesRequestItemsList", + "traits": { + "smithy.api#documentation": "

\n An array of ARNs for the rules that are to be updated. Optionally, you can also include \n RuleStatus and RuleOrder.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#BatchUpdateAutomationRulesResponse": { + "type": "structure", + "members": { + "ProcessedAutomationRules": { + "target": "com.amazonaws.securityhub#AutomationRulesArnsList", + "traits": { + "smithy.api#documentation": "

\n A list of properly processed rule ARNs.\n

" + } + }, + "UnprocessedAutomationRules": { + "target": "com.amazonaws.securityhub#UnprocessedAutomationRulesList", + "traits": { + "smithy.api#documentation": "

\n A list of objects containing RuleArn, ErrorCode, and ErrorMessage. This parameter \n tells you which automation rules the request didn't update and why.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#BatchUpdateFindings": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#BatchUpdateFindingsRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#BatchUpdateFindingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Used by Security Hub customers to update information about their investigation into a finding.\n Requested by administrator accounts or member accounts. Administrator accounts can update findings for\n their account and their member accounts. Member accounts can update findings for their\n account.

\n

Updates from BatchUpdateFindings do not affect the value of\n UpdatedAt for a finding.

\n

Administrator and member accounts can use BatchUpdateFindings to update the\n following finding fields and objects.

\n \n

You can configure IAM policies to restrict access to fields and field values. For\n example, you might not want member accounts to be able to suppress findings or change the\n finding severity. See Configuring access to BatchUpdateFindings in the\n Security Hub User Guide.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/findings/batchupdate", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#BatchUpdateFindingsRequest": { + "type": "structure", + "members": { + "FindingIdentifiers": { + "target": "com.amazonaws.securityhub#AwsSecurityFindingIdentifierList", + "traits": { + "smithy.api#documentation": "

The list of findings to update. BatchUpdateFindings can be used to update\n up to 100 findings at a time.

\n

For each finding, the list provides the finding identifier and the ARN of the finding\n provider.

", + "smithy.api#required": {} + } + }, + "Note": { + "target": "com.amazonaws.securityhub#NoteUpdate" + }, + "Severity": { + "target": "com.amazonaws.securityhub#SeverityUpdate", + "traits": { + "smithy.api#documentation": "

Used to update the finding severity.

" + } + }, + "VerificationState": { + "target": "com.amazonaws.securityhub#VerificationState", + "traits": { + "smithy.api#documentation": "

Indicates the veracity of a finding.

\n

The available values for VerificationState are as follows.

\n " + } + }, + "Confidence": { + "target": "com.amazonaws.securityhub#RatioScale", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The updated value for the finding confidence. Confidence is defined as the likelihood\n that a finding accurately identifies the behavior or issue that it was intended to\n identify.

\n

Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent\n confidence and 100 means 100 percent confidence.

" + } + }, + "Criticality": { + "target": "com.amazonaws.securityhub#RatioScale", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The updated value for the level of importance assigned to the resources associated with\n the findings.

\n

A score of 0 means that the underlying resources have no criticality, and a score of 100\n is reserved for the most critical resources.

" + } + }, + "Types": { + "target": "com.amazonaws.securityhub#TypeList", + "traits": { + "smithy.api#documentation": "

One or more finding types in the format of namespace/category/classifier that classify a\n finding.

\n

Valid namespace values are as follows.

\n " + } + }, + "UserDefinedFields": { + "target": "com.amazonaws.securityhub#FieldMap", + "traits": { + "smithy.api#documentation": "

A list of name/value string pairs associated with the finding. These are custom,\n user-defined fields added to a finding.

" + } + }, + "Workflow": { + "target": "com.amazonaws.securityhub#WorkflowUpdate", + "traits": { + "smithy.api#documentation": "

Used to update the workflow status of a finding.

\n

The workflow status indicates the progress of the investigation into the finding.

" + } + }, + "RelatedFindings": { + "target": "com.amazonaws.securityhub#RelatedFindingList", + "traits": { + "smithy.api#documentation": "

A list of findings that are related to the updated findings.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#BatchUpdateFindingsResponse": { + "type": "structure", + "members": { + "ProcessedFindings": { + "target": "com.amazonaws.securityhub#AwsSecurityFindingIdentifierList", + "traits": { + "smithy.api#documentation": "

The list of findings that were updated successfully.

", + "smithy.api#required": {} + } + }, + "UnprocessedFindings": { + "target": "com.amazonaws.securityhub#BatchUpdateFindingsUnprocessedFindingsList", + "traits": { + "smithy.api#documentation": "

The list of findings that were not updated.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#BatchUpdateFindingsUnprocessedFinding": { + "type": "structure", + "members": { + "FindingIdentifier": { + "target": "com.amazonaws.securityhub#AwsSecurityFindingIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the finding that was not updated.

", + "smithy.api#required": {} + } + }, + "ErrorCode": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The code associated with the error. Possible values are:

\n ", + "smithy.api#required": {} + } + }, + "ErrorMessage": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The message associated with the error. Possible values are:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A finding from a BatchUpdateFindings request that Security Hub was unable to\n update.

" + } + }, + "com.amazonaws.securityhub#BatchUpdateFindingsUnprocessedFindingsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#BatchUpdateFindingsUnprocessedFinding" + } + }, + "com.amazonaws.securityhub#BatchUpdateStandardsControlAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#BatchUpdateStandardsControlAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#BatchUpdateStandardsControlAssociationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

\n For a batch of security controls and standards, this operation updates the enablement status of a control in a standard.\n

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/associations", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#BatchUpdateStandardsControlAssociationsRequest": { + "type": "structure", + "members": { + "StandardsControlAssociationUpdates": { + "target": "com.amazonaws.securityhub#StandardsControlAssociationUpdates", + "traits": { + "smithy.api#documentation": "

\n Updates the enablement status of a security control in a specified standard.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#BatchUpdateStandardsControlAssociationsResponse": { + "type": "structure", + "members": { + "UnprocessedAssociationUpdates": { + "target": "com.amazonaws.securityhub#UnprocessedStandardsControlAssociationUpdates", + "traits": { + "smithy.api#documentation": "

\n A security control (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters) whose enablement status in a specified standard couldn't be updated.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#Boolean": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.securityhub#BooleanFilter": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

The value of the boolean.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Boolean filter for querying findings.

" + } + }, + "com.amazonaws.securityhub#BooleanFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#BooleanFilter" + } + }, + "com.amazonaws.securityhub#CategoryList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#NonEmptyString" + } + }, + "com.amazonaws.securityhub#Cell": { + "type": "structure", + "members": { + "Column": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The column number of the column that contains the data. For a Microsoft Excel workbook, the column number corresponds to the alphabetical column identifiers. For example, a value of 1 for Column corresponds to the A column in the workbook.

" + } + }, + "Row": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The row number of the row that contains the data.

" + } + }, + "ColumnName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the column that contains the data.

" + } + }, + "CellReference": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

For a Microsoft Excel workbook, provides the location of the cell, as an absolute cell reference, that contains the data. For example, Sheet2!C5 for cell C5 on Sheet2.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An occurrence of sensitive data detected in a Microsoft Excel workbook, comma-separated value (CSV) file, or tab-separated value (TSV) file.

" + } + }, + "com.amazonaws.securityhub#Cells": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#Cell" + } + }, + "com.amazonaws.securityhub#CidrBlockAssociation": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The association ID for the IPv4 CIDR block.

" + } + }, + "CidrBlock": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The IPv4 CIDR block.

" + } + }, + "CidrBlockState": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Information about the state of the IPv4 CIDR block.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An IPv4 CIDR block association.

" + } + }, + "com.amazonaws.securityhub#CidrBlockAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#CidrBlockAssociation" + } + }, + "com.amazonaws.securityhub#City": { + "type": "structure", + "members": { + "CityName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the city.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a city.

" + } + }, + "com.amazonaws.securityhub#ClassificationResult": { + "type": "structure", + "members": { + "MimeType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of content that the finding applies to.

" + } + }, + "SizeClassified": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total size in bytes of the affected data.

" + } + }, + "AdditionalOccurrences": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether there are additional occurrences of sensitive data that are not included in the finding. This occurs when the number of occurrences exceeds the maximum that can be included.

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#ClassificationStatus", + "traits": { + "smithy.api#documentation": "

The current status of the sensitive data detection.

" + } + }, + "SensitiveData": { + "target": "com.amazonaws.securityhub#SensitiveDataResultList", + "traits": { + "smithy.api#documentation": "

Provides details about sensitive data that was identified based on built-in configuration.

" + } + }, + "CustomDataIdentifiers": { + "target": "com.amazonaws.securityhub#CustomDataIdentifiersResult", + "traits": { + "smithy.api#documentation": "

Provides details about sensitive data that was identified based on customer-defined configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the sensitive data that was detected on the resource.

" + } + }, + "com.amazonaws.securityhub#ClassificationStatus": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The code that represents the status of the sensitive data detection.

" + } + }, + "Reason": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A longer description of the current status of the sensitive data detection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about the current status of the sensitive data detection.

" + } + }, + "com.amazonaws.securityhub#Compliance": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.securityhub#ComplianceStatus", + "traits": { + "smithy.api#documentation": "

The result of a standards check.

\n

The valid values for Status are as follows.

\n " + } + }, + "RelatedRequirements": { + "target": "com.amazonaws.securityhub#RelatedRequirementsList", + "traits": { + "smithy.api#documentation": "

For a control, the industry or regulatory framework requirements that are related to the\n control. The check for that control is aligned with these requirements.

" + } + }, + "StatusReasons": { + "target": "com.amazonaws.securityhub#StatusReasonsList", + "traits": { + "smithy.api#documentation": "

For findings generated from controls, a list of reasons behind the value of\n Status. For the list of status reason codes and their meanings, see Standards-related information in the ASFF in the\n Security Hub User Guide.

" + } + }, + "SecurityControlId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of a control across standards. Values for this field typically consist of an \n Amazon Web Service and a number, such as APIGateway.5.\n

" + } + }, + "AssociatedStandards": { + "target": "com.amazonaws.securityhub#AssociatedStandardsList", + "traits": { + "smithy.api#documentation": "

The enabled security standards in which a security control is currently enabled.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains finding details that are specific to control-based findings. Only returned for\n findings generated from controls.

" + } + }, + "com.amazonaws.securityhub#ComplianceStatus": { + "type": "enum", + "members": { + "PASSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASSED" + } + }, + "WARNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WARNING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "NOT_AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_AVAILABLE" + } + } + } + }, + "com.amazonaws.securityhub#ContainerDetails": { + "type": "structure", + "members": { + "ContainerRuntime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The runtime of the container.\n

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the container related to a finding.

" + } + }, + "ImageId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the container image related to a finding.

" + } + }, + "ImageName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the container image related to a finding.

" + } + }, + "LaunchedAt": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the container started.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "VolumeMounts": { + "target": "com.amazonaws.securityhub#VolumeMountList", + "traits": { + "smithy.api#documentation": "

Provides information about the mounting of a volume in a container.\n

" + } + }, + "Privileged": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

When this parameter is true, the container is given elevated privileges on the host \ncontainer instance (similar to the root user). \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Container details related to a finding.

" + } + }, + "com.amazonaws.securityhub#ControlFindingGenerator": { + "type": "enum", + "members": { + "STANDARD_CONTROL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDARD_CONTROL" + } + }, + "SECURITY_CONTROL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SECURITY_CONTROL" + } + } + } + }, + "com.amazonaws.securityhub#ControlStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.securityhub#Country": { + "type": "structure", + "members": { + "CountryCode": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The 2-letter ISO 3166 country code for the country.

" + } + }, + "CountryName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the country.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a country.

" + } + }, + "com.amazonaws.securityhub#CreateActionTarget": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#CreateActionTargetRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#CreateActionTargetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceConflictException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a custom action target in Security Hub.

\n

You can use custom actions on findings and insights in Security Hub to trigger target actions\n in Amazon CloudWatch Events.

", + "smithy.api#http": { + "method": "POST", + "uri": "/actionTargets", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#CreateActionTargetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the custom action target. Can contain up to 20 characters.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description for the custom action target.

", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID for the custom action target. Can contain up to 20 alphanumeric characters.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#CreateActionTargetResponse": { + "type": "structure", + "members": { + "ActionTargetArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the custom action target.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#CreateAutomationRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#CreateAutomationRuleRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#CreateAutomationRuleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#AccessDeniedException" + }, + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Creates an automation rule based on input parameters.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/automationrules/create", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#CreateAutomationRuleRequest": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.securityhub#TagMap", + "traits": { + "smithy.api#documentation": "

\n User-defined tags that help you label the purpose of a rule. \n

" + } + }, + "RuleStatus": { + "target": "com.amazonaws.securityhub#RuleStatus", + "traits": { + "smithy.api#documentation": "

\n Whether the rule is active after it is created. If \n this parameter is equal to Enabled, Security Hub will apply the rule to findings \n and finding updates after the rule is created. To change the value of this\n parameter after creating a rule, use BatchUpdateAutomationRules.\n

" + } + }, + "RuleOrder": { + "target": "com.amazonaws.securityhub#RuleOrderValue", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

An integer ranging from 1 to 1000 that represents the order in which the rule action is\n applied to findings. Security Hub applies rules with lower values for this parameter\n first.

", + "smithy.api#required": {} + } + }, + "RuleName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The name of the rule.\n

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n A description of the rule.\n

", + "smithy.api#required": {} + } + }, + "IsTerminal": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful when a finding \n matches the criteria for multiple rules, and each rule has different actions. If the value of this field is \n set to true for a rule, Security Hub applies the rule action to a finding that matches \n the rule criteria and won't evaluate other rules for the finding. The default value of this field is false.\n

" + } + }, + "Criteria": { + "target": "com.amazonaws.securityhub#AutomationRulesFindingFilters", + "traits": { + "smithy.api#documentation": "

\n A set of ASFF finding field attributes and corresponding expected values that \n Security Hub uses to filter findings. If a finding matches the conditions specified in\n this parameter, Security Hub applies the rule action to the finding.\n

", + "smithy.api#required": {} + } + }, + "Actions": { + "target": "com.amazonaws.securityhub#ActionList", + "traits": { + "smithy.api#documentation": "

\n One or more actions to update finding fields if a finding matches the conditions \n specified in Criteria. \n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#CreateAutomationRuleResponse": { + "type": "structure", + "members": { + "RuleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the automation rule that you created.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#CreateFindingAggregator": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#CreateFindingAggregatorRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#CreateFindingAggregatorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#AccessDeniedException" + }, + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Used to enable finding aggregation. Must be called from the aggregation Region.

\n

For more details about cross-Region replication, see Configuring finding aggregation in the Security Hub User Guide.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/findingAggregator/create", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#CreateFindingAggregatorRequest": { + "type": "structure", + "members": { + "RegionLinkingMode": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates whether to aggregate findings from all of the available Regions in the current partition. Also determines whether to automatically aggregate findings from new Regions as Security Hub supports them and you opt into them.

\n

The selected option also determines how to use the Regions provided in the Regions list.

\n

The options are as follows:

\n ", + "smithy.api#required": {} + } + }, + "Regions": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a space-separated list of Regions that do not aggregate findings to the aggregation Region.

\n

If RegionLinkingMode is SPECIFIED_REGIONS, then this is a space-separated list of Regions that do aggregate findings to the aggregation Region.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#CreateFindingAggregatorResponse": { + "type": "structure", + "members": { + "FindingAggregatorArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the finding aggregator. You use the finding aggregator ARN to retrieve details for, update, and stop finding aggregation.

" + } + }, + "FindingAggregationRegion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The aggregation Region.

" + } + }, + "RegionLinkingMode": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.

" + } + }, + "Regions": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

The list of excluded Regions or included Regions.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#CreateInsight": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#CreateInsightRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#CreateInsightResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceConflictException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a custom insight in Security Hub. An insight is a consolidation of findings that relate\n to a security issue that requires attention or remediation.

\n

To group the related findings in the insight, use the\n GroupByAttribute.

", + "smithy.api#http": { + "method": "POST", + "uri": "/insights", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#CreateInsightRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the custom insight to create.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.securityhub#AwsSecurityFindingFilters", + "traits": { + "smithy.api#documentation": "

One or more attributes used to filter the findings included in the insight. The insight\n only includes findings that match the criteria defined in the filters.

", + "smithy.api#required": {} + } + }, + "GroupByAttribute": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The attribute used to group the findings for the insight. The grouping attribute\n identifies the type of item that the insight applies to. For example, if an insight is\n grouped by resource identifier, then the insight produces a list of resource\n identifiers.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#CreateInsightResponse": { + "type": "structure", + "members": { + "InsightArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the insight created.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#CreateMembers": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#CreateMembersRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#CreateMembersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceConflictException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a member association in Security Hub between the specified accounts and the account\n used to make the request, which is the administrator account. If you are integrated with\n Organizations, then the administrator account is designated by the organization management account.

\n

\n CreateMembers is always used to add accounts that are not organization\n members.

\n

For accounts that are managed using Organizations, CreateMembers is only used\n in the following cases:

\n \n

This action can only be used by an account that has Security Hub enabled. To enable Security Hub, you\n can use the EnableSecurityHub operation.

\n

For accounts that are not organization members, you create the account association and\n then send an invitation to the member account. To send the invitation, you use the\n InviteMembers operation. If the account owner accepts\n the invitation, the account becomes a member account in Security Hub.

\n

Accounts that are managed using Organizations do not receive an invitation. They\n automatically become a member account in Security Hub.

\n \n

A permissions policy is added that permits the administrator account to view the findings\n generated in the member account.

\n

To remove the association between the administrator and member accounts, use the DisassociateFromMasterAccount or DisassociateMembers operation.

", + "smithy.api#http": { + "method": "POST", + "uri": "/members", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#CreateMembersRequest": { + "type": "structure", + "members": { + "AccountDetails": { + "target": "com.amazonaws.securityhub#AccountDetailsList", + "traits": { + "smithy.api#documentation": "

The list of accounts to associate with the Security Hub administrator account. For each account, the\n list includes the account ID and optionally the email address.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#CreateMembersResponse": { + "type": "structure", + "members": { + "UnprocessedAccounts": { + "target": "com.amazonaws.securityhub#ResultList", + "traits": { + "smithy.api#documentation": "

The list of Amazon Web Services accounts that were not processed. For each account, the list includes\n the account ID and the email address.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#CrossAccountMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.securityhub#CustomDataIdentifiersDetections": { + "type": "structure", + "members": { + "Count": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of occurrences of sensitive data that were detected.

" + } + }, + "Arn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the custom identifier that was used to detect the sensitive data.

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

he name of the custom identifier that detected the sensitive data.

" + } + }, + "Occurrences": { + "target": "com.amazonaws.securityhub#Occurrences", + "traits": { + "smithy.api#documentation": "

Details about the sensitive data that was detected.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The list of detected instances of sensitive data.

" + } + }, + "com.amazonaws.securityhub#CustomDataIdentifiersDetectionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#CustomDataIdentifiersDetections" + } + }, + "com.amazonaws.securityhub#CustomDataIdentifiersResult": { + "type": "structure", + "members": { + "Detections": { + "target": "com.amazonaws.securityhub#CustomDataIdentifiersDetectionsList", + "traits": { + "smithy.api#documentation": "

The list of detected instances of sensitive data.

" + } + }, + "TotalCount": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of occurrences of sensitive data.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains an instance of sensitive data that was detected by a customer-defined identifier.

" + } + }, + "com.amazonaws.securityhub#Cvss": { + "type": "structure", + "members": { + "Version": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The version of CVSS for the CVSS score.

" + } + }, + "BaseScore": { + "target": "com.amazonaws.securityhub#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The base CVSS score.

" + } + }, + "BaseVector": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The base scoring vector for the CVSS score.

" + } + }, + "Source": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The origin of the original CVSS score and vector.

" + } + }, + "Adjustments": { + "target": "com.amazonaws.securityhub#AdjustmentList", + "traits": { + "smithy.api#documentation": "

Adjustments to the CVSS metrics.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

CVSS scores from the advisory related to the vulnerability.

" + } + }, + "com.amazonaws.securityhub#CvssList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#Cvss" + } + }, + "com.amazonaws.securityhub#DataClassificationDetails": { + "type": "structure", + "members": { + "DetailedResultsLocation": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The path to the folder or file that contains the sensitive data.

" + } + }, + "Result": { + "target": "com.amazonaws.securityhub#ClassificationResult", + "traits": { + "smithy.api#documentation": "

The details about the sensitive data that was detected on the resource.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about sensitive data that was detected on a resource.

" + } + }, + "com.amazonaws.securityhub#DateFilter": { + "type": "structure", + "members": { + "Start": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A timestamp that provides the start date for the date filter.

\n

A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. \n For more information, see RFC 3339 section 5.6, Internet Date/Time Format.

" + } + }, + "End": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A timestamp that provides the end date for the date filter.

\n

A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. \n For more information, see RFC 3339 section 5.6, Internet Date/Time Format.

" + } + }, + "DateRange": { + "target": "com.amazonaws.securityhub#DateRange", + "traits": { + "smithy.api#documentation": "

A date range for the date filter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A date filter for querying findings.

" + } + }, + "com.amazonaws.securityhub#DateFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#DateFilter" + } + }, + "com.amazonaws.securityhub#DateRange": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

A date range value for the date filter.

" + } + }, + "Unit": { + "target": "com.amazonaws.securityhub#DateRangeUnit", + "traits": { + "smithy.api#documentation": "

A date range unit for the date filter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A date range for the date filter.

" + } + }, + "com.amazonaws.securityhub#DateRangeUnit": { + "type": "enum", + "members": { + "DAYS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DAYS" + } + } + } + }, + "com.amazonaws.securityhub#DeclineInvitations": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#DeclineInvitationsRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#DeclineInvitationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Declines invitations to become a member account.

\n

A prospective member account uses this operation to decline an invitation to become a member.

\n

This operation is only called by member accounts that aren't part of an organization.\n Organization accounts don't receive invitations.

", + "smithy.api#http": { + "method": "POST", + "uri": "/invitations/decline", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#DeclineInvitationsRequest": { + "type": "structure", + "members": { + "AccountIds": { + "target": "com.amazonaws.securityhub#AccountIdList", + "traits": { + "smithy.api#documentation": "

The list of prospective member account IDs for which to decline an invitation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#DeclineInvitationsResponse": { + "type": "structure", + "members": { + "UnprocessedAccounts": { + "target": "com.amazonaws.securityhub#ResultList", + "traits": { + "smithy.api#documentation": "

The list of Amazon Web Services accounts that were not processed. For each account, the list includes\n the account ID and the email address.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#DeleteActionTarget": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#DeleteActionTargetRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#DeleteActionTargetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a custom action target from Security Hub.

\n

Deleting a custom action target does not affect any findings or insights that were\n already sent to Amazon CloudWatch Events using the custom action.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/actionTargets/{ActionTargetArn+}", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#DeleteActionTargetRequest": { + "type": "structure", + "members": { + "ActionTargetArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom action target to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#DeleteActionTargetResponse": { + "type": "structure", + "members": { + "ActionTargetArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the custom action target that was deleted.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#DeleteFindingAggregator": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#DeleteFindingAggregatorRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#DeleteFindingAggregatorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#AccessDeniedException" + }, + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a finding aggregator. When you delete the finding aggregator, you stop finding aggregation.

\n

When you stop finding aggregation, findings that were already aggregated to the aggregation Region are still visible from the aggregation Region. New findings and finding updates are not aggregated.\n

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/findingAggregator/delete/{FindingAggregatorArn+}", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#DeleteFindingAggregatorRequest": { + "type": "structure", + "members": { + "FindingAggregatorArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the finding aggregator to delete. To obtain the ARN, use ListFindingAggregators.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#DeleteFindingAggregatorResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#DeleteInsight": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#DeleteInsightRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#DeleteInsightResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the insight specified by the InsightArn.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/insights/{InsightArn+}", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#DeleteInsightRequest": { + "type": "structure", + "members": { + "InsightArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the insight to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#DeleteInsightResponse": { + "type": "structure", + "members": { + "InsightArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the insight that was deleted.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#DeleteInvitations": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#DeleteInvitationsRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#DeleteInvitationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes invitations received by the Amazon Web Services account to become a member account.

\n

A Security Hub administrator account can use this operation to delete invitations sent to one or more member accounts.

\n

This operation is only used to delete invitations that are sent to member accounts that aren't part of an organization.\n Organization accounts don't receive invitations.

", + "smithy.api#http": { + "method": "POST", + "uri": "/invitations/delete", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#DeleteInvitationsRequest": { + "type": "structure", + "members": { + "AccountIds": { + "target": "com.amazonaws.securityhub#AccountIdList", + "traits": { + "smithy.api#documentation": "

The list of member account IDs that received the invitations you want to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#DeleteInvitationsResponse": { + "type": "structure", + "members": { + "UnprocessedAccounts": { + "target": "com.amazonaws.securityhub#ResultList", + "traits": { + "smithy.api#documentation": "

The list of Amazon Web Services accounts for which the invitations were not deleted. For each account,\n the list includes the account ID and the email address.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#DeleteMembers": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#DeleteMembersRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#DeleteMembersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified member accounts from Security Hub.

\n

Can be used to delete member accounts that belong to an organization as well as member\n accounts that were invited manually.

", + "smithy.api#http": { + "method": "POST", + "uri": "/members/delete", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#DeleteMembersRequest": { + "type": "structure", + "members": { + "AccountIds": { + "target": "com.amazonaws.securityhub#AccountIdList", + "traits": { + "smithy.api#documentation": "

The list of account IDs for the member accounts to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#DeleteMembersResponse": { + "type": "structure", + "members": { + "UnprocessedAccounts": { + "target": "com.amazonaws.securityhub#ResultList", + "traits": { + "smithy.api#documentation": "

The list of Amazon Web Services accounts that were not deleted. For each account, the list includes the\n account ID and the email address.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#DescribeActionTargets": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#DescribeActionTargetsRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#DescribeActionTargetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of the custom action targets in Security Hub in your account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/actionTargets/get", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ActionTargets", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.securityhub#DescribeActionTargetsRequest": { + "type": "structure", + "members": { + "ActionTargetArns": { + "target": "com.amazonaws.securityhub#ArnList", + "traits": { + "smithy.api#documentation": "

A list of custom action target ARNs for the custom action targets to retrieve.

" + } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

The token that is required for pagination. On your first call to the\n DescribeActionTargets operation, set the value of this parameter to\n NULL.

\n

For subsequent calls to the operation, to continue listing data, set the value of this\n parameter to the value returned from the previous response.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.securityhub#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#DescribeActionTargetsResponse": { + "type": "structure", + "members": { + "ActionTargets": { + "target": "com.amazonaws.securityhub#ActionTargetList", + "traits": { + "smithy.api#documentation": "

A list of ActionTarget objects. Each object includes the ActionTargetArn,\n Description, and Name of a custom action target available in\n Security Hub.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token to use to request the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#DescribeHub": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#DescribeHubRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#DescribeHubResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns details about the Hub resource in your account, including the\n HubArn and the time when you enabled Security Hub.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#DescribeHubRequest": { + "type": "structure", + "members": { + "HubArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the Hub resource to retrieve.

", + "smithy.api#httpQuery": "HubArn" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#DescribeHubResponse": { + "type": "structure", + "members": { + "HubArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the Hub resource that was retrieved.

" + } + }, + "SubscribedAt": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The date and time when Security Hub was enabled in the account.

" + } + }, + "AutoEnableControls": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether to automatically enable new controls when they are added to standards that are\n enabled.

\n

If set to true, then new controls for enabled standards are enabled\n automatically. If set to false, then new controls are not enabled.

" + } + }, + "ControlFindingGenerator": { + "target": "com.amazonaws.securityhub#ControlFindingGenerator", + "traits": { + "smithy.api#documentation": "

Specifies whether the calling account has consolidated control findings turned on. If the value for this field is set to \n SECURITY_CONTROL, Security Hub generates a single finding for a control check even when the check \n applies to multiple enabled standards.

\n

If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings \n for a control check when the check applies to multiple enabled standards.

\n

The value for this field in a member account matches the value in the administrator\n account. For accounts that aren't part of an organization, the default value of this field\n is SECURITY_CONTROL if you enabled Security Hub on or after February 23,\n 2023.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#DescribeOrganizationConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#DescribeOrganizationConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#DescribeOrganizationConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about the Organizations configuration for Security Hub. Can only be\n called from a Security Hub administrator account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/organization/configuration", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#DescribeOrganizationConfigurationRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#DescribeOrganizationConfigurationResponse": { + "type": "structure", + "members": { + "AutoEnable": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether to automatically enable Security Hub for new accounts in the organization.

\n

If set to true, then Security Hub is enabled for new accounts. If set to false,\n then new accounts are not added automatically.

" + } + }, + "MemberAccountLimitReached": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the maximum number of allowed member accounts are already associated with the\n Security Hub administrator account.

" + } + }, + "AutoEnableStandards": { + "target": "com.amazonaws.securityhub#AutoEnableStandards", + "traits": { + "smithy.api#documentation": "

Whether to automatically enable Security Hub default standards \n for new member accounts in the organization.

\n

The default value of this parameter is equal to DEFAULT.

\n

If equal to DEFAULT, then Security Hub default standards are automatically enabled for new member \n accounts. If equal to NONE, then default standards are not automatically enabled for new member \n accounts.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#DescribeProducts": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#DescribeProductsRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#DescribeProductsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about product integrations in Security Hub.

\n

You can optionally provide an integration ARN. If you provide an integration ARN, then\n the results only include that integration.

\n

If you do not provide an integration ARN, then the results include all of the available\n product integrations.

", + "smithy.api#http": { + "method": "GET", + "uri": "/products", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Products", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.securityhub#DescribeProductsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

The token that is required for pagination. On your first call to the\n DescribeProducts operation, set the value of this parameter to\n NULL.

\n

For subsequent calls to the operation, to continue listing data, set the value of this\n parameter to the value returned from the previous response.

", + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.securityhub#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#httpQuery": "MaxResults" + } + }, + "ProductArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the integration to return.

", + "smithy.api#httpQuery": "ProductArn" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#DescribeProductsResponse": { + "type": "structure", + "members": { + "Products": { + "target": "com.amazonaws.securityhub#ProductsList", + "traits": { + "smithy.api#documentation": "

A list of products, including details for each product.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token to use to request the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#DescribeStandards": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#DescribeStandardsRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#DescribeStandardsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of the available standards in Security Hub.

\n

For each standard, the results include the standard ARN, the name, and a description.

", + "smithy.api#http": { + "method": "GET", + "uri": "/standards", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Standards", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.securityhub#DescribeStandardsControls": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#DescribeStandardsControlsRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#DescribeStandardsControlsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of security standards controls.

\n

For each control, the results include information about whether it is currently enabled,\n the severity, and a link to remediation information.

", + "smithy.api#http": { + "method": "GET", + "uri": "/standards/controls/{StandardsSubscriptionArn+}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Controls", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.securityhub#DescribeStandardsControlsRequest": { + "type": "structure", + "members": { + "StandardsSubscriptionArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of a resource that represents your subscription to a supported standard. To get\n the subscription ARNs of the standards you have enabled, use the GetEnabledStandards operation.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

The token that is required for pagination. On your first call to the\n DescribeStandardsControls operation, set the value of this parameter to\n NULL.

\n

For subsequent calls to the operation, to continue listing data, set the value of this\n parameter to the value returned from the previous response.

", + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.securityhub#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of security standard controls to return.

", + "smithy.api#httpQuery": "MaxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#DescribeStandardsControlsResponse": { + "type": "structure", + "members": { + "Controls": { + "target": "com.amazonaws.securityhub#StandardsControls", + "traits": { + "smithy.api#documentation": "

A list of security standards controls.

" + } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token to use to request the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#DescribeStandardsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

The token that is required for pagination. On your first call to the\n DescribeStandards operation, set the value of this parameter to\n NULL.

\n

For subsequent calls to the operation, to continue listing data, set the value of this\n parameter to the value returned from the previous response.

", + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.securityhub#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of standards to return.

", + "smithy.api#httpQuery": "MaxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#DescribeStandardsResponse": { + "type": "structure", + "members": { + "Standards": { + "target": "com.amazonaws.securityhub#Standards", + "traits": { + "smithy.api#documentation": "

A list of available standards.

" + } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token to use to request the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#DisableImportFindingsForProduct": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#DisableImportFindingsForProductRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#DisableImportFindingsForProductResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Disables the integration of the specified product with Security Hub. After the integration is\n disabled, findings from that product are no longer sent to Security Hub.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/productSubscriptions/{ProductSubscriptionArn+}", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#DisableImportFindingsForProductRequest": { + "type": "structure", + "members": { + "ProductSubscriptionArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the integrated product to disable the integration for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#DisableImportFindingsForProductResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#DisableOrganizationAdminAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#DisableOrganizationAdminAccountRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#DisableOrganizationAdminAccountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Disables a Security Hub administrator account. Can only be called by the organization\n management account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/organization/admin/disable", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#DisableOrganizationAdminAccountRequest": { + "type": "structure", + "members": { + "AdminAccountId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account identifier of the Security Hub administrator account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#DisableOrganizationAdminAccountResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#DisableSecurityHub": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#DisableSecurityHubRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#DisableSecurityHubResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Disables Security Hub in your account only in the current Region. To disable Security Hub in all\n Regions, you must submit one request per Region where you have enabled Security Hub.

\n

When you disable Security Hub for an administrator account, it doesn't disable Security Hub for any associated\n member accounts.

\n

When you disable Security Hub, your existing findings and insights and any Security Hub configuration\n settings are deleted after 90 days and cannot be recovered. Any standards that were enabled\n are disabled, and your administrator and member account associations are removed.

\n

If you want to save your existing findings, you must export them before you disable\n Security Hub.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#DisableSecurityHubRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#DisableSecurityHubResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#DisassociateFromAdministratorAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#DisassociateFromAdministratorAccountRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#DisassociateFromAdministratorAccountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates the current Security Hub member account from the associated administrator\n account.

\n

This operation is only used by accounts that are not part of an organization. For\n organization accounts, only the administrator account can\n disassociate a member account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/administrator/disassociate", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#DisassociateFromAdministratorAccountRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#DisassociateFromAdministratorAccountResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#DisassociateFromMasterAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#DisassociateFromMasterAccountRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#DisassociateFromMasterAccountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#deprecated": { + "message": "This API has been deprecated, use DisassociateFromAdministratorAccount API instead." + }, + "smithy.api#documentation": "

This method is deprecated. Instead, use DisassociateFromAdministratorAccount.

\n

The Security Hub console continues to use DisassociateFromMasterAccount. It will eventually change to use DisassociateFromAdministratorAccount. Any IAM policies that specifically control access to this function must continue to use DisassociateFromMasterAccount. You should also add DisassociateFromAdministratorAccount to your policies to ensure that the correct permissions are in place after the console begins to use DisassociateFromAdministratorAccount.

\n

Disassociates the current Security Hub member account from the associated administrator\n account.

\n

This operation is only used by accounts that are not part of an organization. For\n organization accounts, only the administrator account can\n disassociate a member account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/master/disassociate", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#DisassociateFromMasterAccountRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#DisassociateFromMasterAccountResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#DisassociateMembers": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#DisassociateMembersRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#DisassociateMembersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates the specified member accounts from the associated administrator account.

\n

Can be used to disassociate both accounts that are managed using Organizations and accounts that\n were invited manually.

", + "smithy.api#http": { + "method": "POST", + "uri": "/members/disassociate", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#DisassociateMembersRequest": { + "type": "structure", + "members": { + "AccountIds": { + "target": "com.amazonaws.securityhub#AccountIdList", + "traits": { + "smithy.api#documentation": "

The account IDs of the member accounts to disassociate from the administrator account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#DisassociateMembersResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#DnsRequestAction": { + "type": "structure", + "members": { + "Domain": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The DNS domain that is associated with the DNS request.

" + } + }, + "Protocol": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The protocol that was used for the DNS request.

" + } + }, + "Blocked": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the DNS request was blocked.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provided if ActionType is DNS_REQUEST. It provides details\n about the DNS request that was detected.

" + } + }, + "com.amazonaws.securityhub#Double": { + "type": "double", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.securityhub#EnableImportFindingsForProduct": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#EnableImportFindingsForProductRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#EnableImportFindingsForProductResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceConflictException" + } + ], + "traits": { + "smithy.api#documentation": "

Enables the integration of a partner product with Security Hub. Integrated products send\n findings to Security Hub.

\n

When you enable a product integration, a permissions policy that grants permission for\n the product to send findings to Security Hub is applied.

", + "smithy.api#http": { + "method": "POST", + "uri": "/productSubscriptions", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#EnableImportFindingsForProductRequest": { + "type": "structure", + "members": { + "ProductArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the product to enable the integration for.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#EnableImportFindingsForProductResponse": { + "type": "structure", + "members": { + "ProductSubscriptionArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of your subscription to the product to enable integrations for.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#EnableOrganizationAdminAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#EnableOrganizationAdminAccountRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#EnableOrganizationAdminAccountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Designates the Security Hub administrator account for an organization. Can only be called by\n the organization management account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/organization/admin/enable", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#EnableOrganizationAdminAccountRequest": { + "type": "structure", + "members": { + "AdminAccountId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account identifier of the account to designate as the Security Hub administrator\n account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#EnableOrganizationAdminAccountResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#EnableSecurityHub": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#EnableSecurityHubRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#EnableSecurityHubResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#AccessDeniedException" + }, + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceConflictException" + } + ], + "traits": { + "smithy.api#documentation": "

Enables Security Hub for your account in the current Region or the Region you specify in the\n request.

\n

When you enable Security Hub, you grant to Security Hub the permissions necessary to gather findings\n from other services that are integrated with Security Hub.

\n

When you use the EnableSecurityHub operation to enable Security Hub, you also\n automatically enable the following standards:

\n \n

Other standards are not automatically enabled.

\n

To opt out of automatically enabled standards, set\n EnableDefaultStandards to false.

\n

After you enable Security Hub, to enable a standard, use the BatchEnableStandards operation. To disable a standard, use the\n BatchDisableStandards operation.

\n

To learn more, see the setup information in the Security Hub User Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#EnableSecurityHubRequest": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.securityhub#TagMap", + "traits": { + "smithy.api#documentation": "

The tags to add to the hub resource when you enable Security Hub.

" + } + }, + "EnableDefaultStandards": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether to enable the security standards that Security Hub has designated as automatically\n enabled. If you do not provide a value for EnableDefaultStandards, it is set\n to true. To not enable the automatically enabled standards, set\n EnableDefaultStandards to false.

" + } + }, + "ControlFindingGenerator": { + "target": "com.amazonaws.securityhub#ControlFindingGenerator", + "traits": { + "smithy.api#documentation": "

This field, used when enabling Security Hub, specifies whether the calling account has consolidated control findings turned on. \n If the value for this field is set to \n SECURITY_CONTROL, Security Hub generates a single finding for a control check even when the check \n applies to multiple enabled standards.

\n

If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings \n for a control check when the check applies to multiple enabled standards.

\n

The value for this field in a member account matches the value in the administrator\n account. For accounts that aren't part of an organization, the default value of this field\n is SECURITY_CONTROL if you enabled Security Hub on or after February 23,\n 2023.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#EnableSecurityHubResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#FieldMap": { + "type": "map", + "key": { + "target": "com.amazonaws.securityhub#NonEmptyString" + }, + "value": { + "target": "com.amazonaws.securityhub#NonEmptyString" + } + }, + "com.amazonaws.securityhub#FilePathList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#FilePaths" + } + }, + "com.amazonaws.securityhub#FilePaths": { + "type": "structure", + "members": { + "FilePath": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Path to the infected or suspicious file on the resource it was detected on.\n\t\t

" + } + }, + "FileName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the infected or suspicious file corresponding to the hash.\n\t\t

" + } + }, + "ResourceId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource on which the threat was detected.\n\t\t

" + } + }, + "Hash": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The hash value for the infected or suspicious file.\n\t\t

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the file paths that were affected by the threat.\n\t\t

" + } + }, + "com.amazonaws.securityhub#FindingAggregator": { + "type": "structure", + "members": { + "FindingAggregatorArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the finding aggregator. You use the finding aggregator ARN to retrieve details for, update, and delete the finding aggregator.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A finding aggregator. A finding aggregator contains the configuration for finding aggregation.

" + } + }, + "com.amazonaws.securityhub#FindingAggregatorList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#FindingAggregator" + } + }, + "com.amazonaws.securityhub#FindingHistoryRecord": { + "type": "structure", + "members": { + "FindingIdentifier": { + "target": "com.amazonaws.securityhub#AwsSecurityFindingIdentifier" + }, + "UpdateTime": { + "target": "com.amazonaws.securityhub#Timestamp", + "traits": { + "smithy.api#documentation": "

An ISO 8601-formatted timestamp that indicates when Security Hub \n processed the updated finding record.

\n

A correctly formatted example is\n 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and\n time should be separated by T. For more information, see RFC 3339 section 5.6,\n Internet Date/Time Format.

" + } + }, + "FindingCreated": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Identifies whether the event marks the creation of a new finding. A value of True means that the finding is \n newly created. A value of False means that the finding isn’t newly created.\n

" + } + }, + "UpdateSource": { + "target": "com.amazonaws.securityhub#FindingHistoryUpdateSource", + "traits": { + "smithy.api#documentation": "

Identifies the source of the event that changed the finding. For example, an integrated\n Amazon Web Service or third-party partner integration may call \n BatchImportFindings\n , or an Security Hub customer\n may call \n BatchUpdateFindings\n .

" + } + }, + "Updates": { + "target": "com.amazonaws.securityhub#FindingHistoryUpdatesList", + "traits": { + "smithy.api#documentation": "

\n An array of objects that provides details about the finding change event, including the Amazon Web Services Security \n Finding Format (ASFF) field that changed, the value of the field before the change, and the value of the field after \n the change.\n

" + } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

\n A token for pagination purposes. Provide this token in the subsequent request to \n GetFindingsHistory\n to get \n up to an additional 100 results of history for the same finding that you specified in your initial request.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n A list of events that changed the specified finding during the specified time period. Each record represents a single \n finding change event.\n

" + } + }, + "com.amazonaws.securityhub#FindingHistoryRecordList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#FindingHistoryRecord" + } + }, + "com.amazonaws.securityhub#FindingHistoryUpdate": { + "type": "structure", + "members": { + "UpdatedField": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ASFF field that changed during the finding change event.\n

" + } + }, + "OldValue": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The value of the ASFF field before the finding change event.\n

" + } + }, + "NewValue": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The value of the ASFF field after the finding change event. To preserve storage and readability, Security Hub omits this value \n if \n FindingHistoryRecord\n exceeds database limits.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An array of objects that provides details about a change to a finding, including the\n Amazon Web Services Security Finding Format (ASFF) field that changed, the value of\n the field before the change, and the value of the field after the change.

" + } + }, + "com.amazonaws.securityhub#FindingHistoryUpdateSource": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.securityhub#FindingHistoryUpdateSourceType", + "traits": { + "smithy.api#documentation": "

\n Describes the type of finding change event, such as a call to \n BatchImportFindings\n (by an integrated Amazon Web Service or third party partner integration) or \n BatchUpdateFindings\n (by a Security Hub customer). \n

" + } + }, + "Identity": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The identity of the source that initiated the finding change event. For example, the Amazon Resource Name (ARN) of a partner that calls BatchImportFindings or of a customer that calls BatchUpdateFindings.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Identifies the source of the finding change event. \n

" + } + }, + "com.amazonaws.securityhub#FindingHistoryUpdateSourceType": { + "type": "enum", + "members": { + "BATCH_UPDATE_FINDINGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BATCH_UPDATE_FINDINGS" + } + }, + "BATCH_IMPORT_FINDINGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BATCH_IMPORT_FINDINGS" + } + } + } + }, + "com.amazonaws.securityhub#FindingHistoryUpdatesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#FindingHistoryUpdate" + } + }, + "com.amazonaws.securityhub#FindingProviderFields": { + "type": "structure", + "members": { + "Confidence": { + "target": "com.amazonaws.securityhub#RatioScale", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

A finding's confidence. Confidence is defined as the likelihood that a finding\n accurately identifies the behavior or issue that it was intended to identify.

\n

Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent\n confidence and 100 means 100 percent confidence.

" + } + }, + "Criticality": { + "target": "com.amazonaws.securityhub#RatioScale", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The level of importance assigned to the resources associated with the finding.

\n

A score of 0 means that the underlying resources have no criticality, and a score of 100\n is reserved for the most critical resources.

" + } + }, + "RelatedFindings": { + "target": "com.amazonaws.securityhub#RelatedFindingList", + "traits": { + "smithy.api#documentation": "

A list of findings that are related to the current finding.

" + } + }, + "Severity": { + "target": "com.amazonaws.securityhub#FindingProviderSeverity", + "traits": { + "smithy.api#documentation": "

The severity of a finding.

" + } + }, + "Types": { + "target": "com.amazonaws.securityhub#TypeList", + "traits": { + "smithy.api#documentation": "

One or more finding types in the format of namespace/category/classifier\n that classify a finding.

\n

Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual\n Behaviors | Sensitive Data Identifications

" + } + } + }, + "traits": { + "smithy.api#documentation": "

In a BatchImportFindings request, finding providers use FindingProviderFields to provide and update values for confidence, criticality, related findings, severity, and types.

" + } + }, + "com.amazonaws.securityhub#FindingProviderSeverity": { + "type": "structure", + "members": { + "Label": { + "target": "com.amazonaws.securityhub#SeverityLabel", + "traits": { + "smithy.api#documentation": "

The severity label assigned to the finding by the finding provider.

" + } + }, + "Original": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The finding provider's original value for the severity.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The severity assigned to the finding by the finding provider.

" + } + }, + "com.amazonaws.securityhub#FirewallPolicyDetails": { + "type": "structure", + "members": { + "StatefulRuleGroupReferences": { + "target": "com.amazonaws.securityhub#FirewallPolicyStatefulRuleGroupReferencesList", + "traits": { + "smithy.api#documentation": "

The stateful rule groups that are used in the firewall policy.

" + } + }, + "StatelessCustomActions": { + "target": "com.amazonaws.securityhub#FirewallPolicyStatelessCustomActionsList", + "traits": { + "smithy.api#documentation": "

The custom action definitions that are available to use in the firewall policy's StatelessDefaultActions setting.

" + } + }, + "StatelessDefaultActions": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The actions to take on a packet if it doesn't match any of the stateless rules in the policy.

\n

You must specify a standard action (aws:pass, aws:drop, aws:forward_to_sfe), and can optionally include a custom action from StatelessCustomActions.\n

" + } + }, + "StatelessFragmentDefaultActions": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The actions to take on a fragmented UDP packet if it doesn't match any of the stateless rules in the policy.

\n

You must specify a standard action (aws:pass, aws:drop, aws:forward_to_sfe), and can optionally include a custom action from StatelessCustomActions.\n

" + } + }, + "StatelessRuleGroupReferences": { + "target": "com.amazonaws.securityhub#FirewallPolicyStatelessRuleGroupReferencesList", + "traits": { + "smithy.api#documentation": "

The stateless rule groups that are used in the firewall policy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the behavior of the firewall.

" + } + }, + "com.amazonaws.securityhub#FirewallPolicyStatefulRuleGroupReferencesDetails": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the stateful rule group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A stateful rule group that is used by the firewall policy.

" + } + }, + "com.amazonaws.securityhub#FirewallPolicyStatefulRuleGroupReferencesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#FirewallPolicyStatefulRuleGroupReferencesDetails" + } + }, + "com.amazonaws.securityhub#FirewallPolicyStatelessCustomActionsDetails": { + "type": "structure", + "members": { + "ActionDefinition": { + "target": "com.amazonaws.securityhub#StatelessCustomActionDefinition", + "traits": { + "smithy.api#documentation": "

The definition of the custom action.

" + } + }, + "ActionName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the custom action.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A custom action that can be used for stateless packet handling.

" + } + }, + "com.amazonaws.securityhub#FirewallPolicyStatelessCustomActionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#FirewallPolicyStatelessCustomActionsDetails" + } + }, + "com.amazonaws.securityhub#FirewallPolicyStatelessRuleGroupReferencesDetails": { + "type": "structure", + "members": { + "Priority": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The order in which to run the stateless rule group.

" + } + }, + "ResourceArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the stateless rule group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A stateless rule group that is used by the firewall policy.

" + } + }, + "com.amazonaws.securityhub#FirewallPolicyStatelessRuleGroupReferencesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#FirewallPolicyStatelessRuleGroupReferencesDetails" + } + }, + "com.amazonaws.securityhub#GeoLocation": { + "type": "structure", + "members": { + "Lon": { + "target": "com.amazonaws.securityhub#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The longitude of the location.

" + } + }, + "Lat": { + "target": "com.amazonaws.securityhub#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The latitude of the location.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides the latitude and longitude coordinates of a location.

" + } + }, + "com.amazonaws.securityhub#GetAdministratorAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#GetAdministratorAccountRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#GetAdministratorAccountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides the details for the Security Hub administrator account for the current member account.

\n

Can be used by both member accounts that are managed using Organizations and accounts that were\n invited manually.

", + "smithy.api#http": { + "method": "GET", + "uri": "/administrator", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#GetAdministratorAccountRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#GetAdministratorAccountResponse": { + "type": "structure", + "members": { + "Administrator": { + "target": "com.amazonaws.securityhub#Invitation" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#GetEnabledStandards": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#GetEnabledStandardsRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#GetEnabledStandardsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of the standards that are currently enabled.

", + "smithy.api#http": { + "method": "POST", + "uri": "/standards/get", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "StandardsSubscriptions", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.securityhub#GetEnabledStandardsRequest": { + "type": "structure", + "members": { + "StandardsSubscriptionArns": { + "target": "com.amazonaws.securityhub#StandardsSubscriptionArns", + "traits": { + "smithy.api#documentation": "

The list of the standards subscription ARNs for the standards to retrieve.

" + } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

The token that is required for pagination. On your first call to the\n GetEnabledStandards operation, set the value of this parameter to\n NULL.

\n

For subsequent calls to the operation, to continue listing data, set the value of this\n parameter to the value returned from the previous response.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.securityhub#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return in the response.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#GetEnabledStandardsResponse": { + "type": "structure", + "members": { + "StandardsSubscriptions": { + "target": "com.amazonaws.securityhub#StandardsSubscriptions", + "traits": { + "smithy.api#documentation": "

The list of StandardsSubscriptions objects that include information about\n the enabled standards.

" + } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token to use to request the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#GetFindingAggregator": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#GetFindingAggregatorRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#GetFindingAggregatorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#AccessDeniedException" + }, + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the current finding aggregation configuration.

", + "smithy.api#http": { + "method": "GET", + "uri": "/findingAggregator/get/{FindingAggregatorArn+}", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#GetFindingAggregatorRequest": { + "type": "structure", + "members": { + "FindingAggregatorArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the finding aggregator to return details for. To obtain the ARN, use ListFindingAggregators.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#GetFindingAggregatorResponse": { + "type": "structure", + "members": { + "FindingAggregatorArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the finding aggregator.

" + } + }, + "FindingAggregationRegion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The aggregation Region.

" + } + }, + "RegionLinkingMode": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.

" + } + }, + "Regions": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

The list of excluded Regions or included Regions.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#GetFindingHistory": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#GetFindingHistoryRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#GetFindingHistoryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Returns history for a Security Hub finding in the last 90 days. The history includes changes made to any fields in \n the Amazon Web Services Security Finding Format (ASFF).\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/findingHistory/get", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Records", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.securityhub#GetFindingHistoryRequest": { + "type": "structure", + "members": { + "FindingIdentifier": { + "target": "com.amazonaws.securityhub#AwsSecurityFindingIdentifier", + "traits": { + "smithy.api#required": {} + } + }, + "StartTime": { + "target": "com.amazonaws.securityhub#Timestamp", + "traits": { + "smithy.api#documentation": "

\n An ISO 8601-formatted timestamp that indicates the start time of the requested finding history. A correctly formatted \n example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated \n by T. For more information, see RFC 3339 \n section 5.6, Internet Date/Time Format.

\n

If you provide values for both StartTime and EndTime,\n Security Hub returns finding history for the specified time period. If you\n provide a value for StartTime but not for EndTime, Security Hub returns finding history from the StartTime to the time at\n which the API is called. If you provide a value for EndTime but not for\n StartTime, Security Hub returns finding history from the CreatedAt timestamp of the finding to the EndTime. If you\n provide neither StartTime nor EndTime, Security Hub\n returns finding history from the CreatedAt timestamp of the finding to the time at which\n the API is called. In all of these scenarios, the response is limited to 100 results, and the maximum time period is \n limited to 90 days.

" + } + }, + "EndTime": { + "target": "com.amazonaws.securityhub#Timestamp", + "traits": { + "smithy.api#documentation": "

\n An ISO 8601-formatted timestamp that indicates the end time of the requested finding history. A correctly formatted \n example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated \n by T. For more information, see RFC 3339 \n section 5.6, Internet Date/Time Format.

\n

If you provide values for both StartTime and EndTime,\n Security Hub returns finding history for the specified time period. If you\n provide a value for StartTime but not for EndTime, Security Hub returns finding history from the StartTime to the time at\n which the API is called. If you provide a value for EndTime but not for\n StartTime, Security Hub returns finding history from the CreatedAt timestamp of the finding to the EndTime. If you\n provide neither StartTime nor EndTime, Security Hub\n returns finding history from the CreatedAt timestamp of the finding to the time at which\n the API is called. In all of these scenarios, the response is limited to 100 results, and the maximum time period is \n limited to 90 days.

" + } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

\n A token for pagination purposes. Provide NULL as the initial value. In subsequent requests, provide the \n token included in the response to get up to an additional 100 results of finding history. If you don’t provide \n NextToken, Security Hub returns up to 100 results of finding history for each request.\n

" + } + }, + "MaxResults": { + "target": "com.amazonaws.securityhub#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The maximum number of results to be returned. If you don’t provide it, Security Hub returns up to 100 results of finding history.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#GetFindingHistoryResponse": { + "type": "structure", + "members": { + "Records": { + "target": "com.amazonaws.securityhub#FindingHistoryRecordList", + "traits": { + "smithy.api#documentation": "

\n A list of events that altered the specified finding during the specified time period. \n

" + } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

\n A token for pagination purposes. Provide this token in the subsequent request to GetFindingsHistory to \n get up to an additional 100 results of history for the same finding that you specified in your initial request.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#GetFindings": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#GetFindingsRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#GetFindingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of findings that match the specified criteria.

\n

If finding aggregation is enabled, then when you call GetFindings from the aggregation Region, the results include all of the matching findings from both the aggregation Region and the linked Regions.

", + "smithy.api#http": { + "method": "POST", + "uri": "/findings", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Findings", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.securityhub#GetFindingsRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.securityhub#AwsSecurityFindingFilters", + "traits": { + "smithy.api#documentation": "

The finding attributes used to define a condition to filter the returned\n findings.

\n

You can filter by up to 10 finding attributes. For each attribute, you can provide up to\n 20 filter values.

\n

Note that in the available filter fields, WorkflowState is deprecated. To\n search for a finding based on its workflow status, use WorkflowStatus.

" + } + }, + "SortCriteria": { + "target": "com.amazonaws.securityhub#SortCriteria", + "traits": { + "smithy.api#documentation": "

The finding attributes used to sort the list of returned findings.

" + } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

The token that is required for pagination. On your first call to the\n GetFindings operation, set the value of this parameter to\n NULL.

\n

For subsequent calls to the operation, to continue listing data, set the value of this\n parameter to the value returned from the previous response.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.securityhub#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of findings to return.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#GetFindingsResponse": { + "type": "structure", + "members": { + "Findings": { + "target": "com.amazonaws.securityhub#AwsSecurityFindingList", + "traits": { + "smithy.api#documentation": "

The findings that matched the filters specified in the request.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token to use to request the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#GetInsightResults": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#GetInsightResultsRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#GetInsightResultsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the results of the Security Hub insight specified by the insight ARN.

", + "smithy.api#http": { + "method": "GET", + "uri": "/insights/results/{InsightArn+}", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#GetInsightResultsRequest": { + "type": "structure", + "members": { + "InsightArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the insight for which to return results.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#GetInsightResultsResponse": { + "type": "structure", + "members": { + "InsightResults": { + "target": "com.amazonaws.securityhub#InsightResults", + "traits": { + "smithy.api#documentation": "

The insight results returned by the operation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#GetInsights": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#GetInsightsRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#GetInsightsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists and describes insights for the specified insight ARNs.

", + "smithy.api#http": { + "method": "POST", + "uri": "/insights/get", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Insights", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.securityhub#GetInsightsRequest": { + "type": "structure", + "members": { + "InsightArns": { + "target": "com.amazonaws.securityhub#ArnList", + "traits": { + "smithy.api#documentation": "

The ARNs of the insights to describe. If you do not provide any insight ARNs, then\n GetInsights returns all of your custom insights. It does not return any\n managed insights.

" + } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

The token that is required for pagination. On your first call to the\n GetInsights operation, set the value of this parameter to\n NULL.

\n

For subsequent calls to the operation, to continue listing data, set the value of this\n parameter to the value returned from the previous response.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.securityhub#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return in the response.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#GetInsightsResponse": { + "type": "structure", + "members": { + "Insights": { + "target": "com.amazonaws.securityhub#InsightList", + "traits": { + "smithy.api#documentation": "

The insights returned by the operation.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token to use to request the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#GetInvitationsCount": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#GetInvitationsCountRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#GetInvitationsCountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the count of all Security Hub membership invitations that were sent to the\n current member account, not including the currently accepted invitation.

", + "smithy.api#http": { + "method": "GET", + "uri": "/invitations/count", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#GetInvitationsCountRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#GetInvitationsCountResponse": { + "type": "structure", + "members": { + "InvitationsCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of all membership invitations sent to this Security Hub member account, not\n including the currently accepted invitation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#GetMasterAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#GetMasterAccountRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#GetMasterAccountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#deprecated": { + "message": "This API has been deprecated, use GetAdministratorAccount API instead." + }, + "smithy.api#documentation": "

This method is deprecated. Instead, use GetAdministratorAccount.

\n

The Security Hub console continues to use GetMasterAccount. It will eventually change to use GetAdministratorAccount. Any IAM policies that specifically control access to this function must continue to use GetMasterAccount. You should also add GetAdministratorAccount to your policies to ensure that the correct permissions are in place after the console begins to use GetAdministratorAccount.

\n

Provides the details for the Security Hub administrator account for the current member account.

\n

Can be used by both member accounts that are managed using Organizations and accounts that were\n invited manually.

", + "smithy.api#http": { + "method": "GET", + "uri": "/master", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#GetMasterAccountRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#GetMasterAccountResponse": { + "type": "structure", + "members": { + "Master": { + "target": "com.amazonaws.securityhub#Invitation", + "traits": { + "smithy.api#documentation": "

A list of details about the Security Hub administrator account for the current member account.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#GetMembers": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#GetMembersRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#GetMembersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the details for the Security Hub member accounts for the specified account IDs.

\n

An administrator account can be either the delegated Security Hub administrator account for an\n organization or an administrator account that enabled Security Hub manually.

\n

The results include both member accounts that are managed using Organizations and accounts that\n were invited manually.

", + "smithy.api#http": { + "method": "POST", + "uri": "/members/get", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#GetMembersRequest": { + "type": "structure", + "members": { + "AccountIds": { + "target": "com.amazonaws.securityhub#AccountIdList", + "traits": { + "smithy.api#documentation": "

The list of account IDs for the Security Hub member accounts to return the details for.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#GetMembersResponse": { + "type": "structure", + "members": { + "Members": { + "target": "com.amazonaws.securityhub#MemberList", + "traits": { + "smithy.api#documentation": "

The list of details about the Security Hub member accounts.

" + } + }, + "UnprocessedAccounts": { + "target": "com.amazonaws.securityhub#ResultList", + "traits": { + "smithy.api#documentation": "

The list of Amazon Web Services accounts that could not be processed. For each account, the list\n includes the account ID and the email address.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#IcmpTypeCode": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The ICMP code for which to deny or allow access. To deny or allow all codes, use the\n value -1.

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The ICMP type for which to deny or allow access. To deny or allow all types, use the\n value -1.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An Internet Control Message Protocol (ICMP) type and code.

" + } + }, + "com.amazonaws.securityhub#ImportFindingsError": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the finding that could not be updated.

", + "smithy.api#required": {} + } + }, + "ErrorCode": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The code of the error returned by the BatchImportFindings operation.

", + "smithy.api#required": {} + } + }, + "ErrorMessage": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The message of the error returned by the BatchImportFindings\n operation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The list of the findings that cannot be imported. For each finding, the list provides\n the error.

" + } + }, + "com.amazonaws.securityhub#ImportFindingsErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#ImportFindingsError" + } + }, + "com.amazonaws.securityhub#Insight": { + "type": "structure", + "members": { + "InsightArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of a Security Hub insight.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of a Security Hub insight.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.securityhub#AwsSecurityFindingFilters", + "traits": { + "smithy.api#documentation": "

One or more attributes used to filter the findings included in the insight. The insight\n only includes findings that match the criteria defined in the filters.

", + "smithy.api#required": {} + } + }, + "GroupByAttribute": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The grouping attribute for the insight's findings. Indicates how to group the matching\n findings, and identifies the type of item that the insight applies to. For example, if an\n insight is grouped by resource identifier, then the insight produces a list of resource\n identifiers.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a Security Hub insight.

" + } + }, + "com.amazonaws.securityhub#InsightList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#Insight" + } + }, + "com.amazonaws.securityhub#InsightResultValue": { + "type": "structure", + "members": { + "GroupByAttributeValue": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The value of the attribute that the findings are grouped by for the insight whose\n results are returned by the GetInsightResults operation.

", + "smithy.api#required": {} + } + }, + "Count": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of findings returned for each GroupByAttributeValue.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The insight result values returned by the GetInsightResults\n operation.

" + } + }, + "com.amazonaws.securityhub#InsightResultValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#InsightResultValue" + } + }, + "com.amazonaws.securityhub#InsightResults": { + "type": "structure", + "members": { + "InsightArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the insight whose results are returned by the GetInsightResults\n operation.

", + "smithy.api#required": {} + } + }, + "GroupByAttribute": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The attribute that the findings are grouped by for the insight whose results are\n returned by the GetInsightResults operation.

", + "smithy.api#required": {} + } + }, + "ResultValues": { + "target": "com.amazonaws.securityhub#InsightResultValueList", + "traits": { + "smithy.api#documentation": "

The list of insight result values returned by the GetInsightResults\n operation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The insight results returned by the GetInsightResults operation.

" + } + }, + "com.amazonaws.securityhub#Integer": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.securityhub#IntegerList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#Integer" + } + }, + "com.amazonaws.securityhub#IntegrationType": { + "type": "enum", + "members": { + "SEND_FINDINGS_TO_SECURITY_HUB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEND_FINDINGS_TO_SECURITY_HUB" + } + }, + "RECEIVE_FINDINGS_FROM_SECURITY_HUB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RECEIVE_FINDINGS_FROM_SECURITY_HUB" + } + }, + "UPDATE_FINDINGS_IN_SECURITY_HUB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FINDINGS_IN_SECURITY_HUB" + } + } + } + }, + "com.amazonaws.securityhub#IntegrationTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#IntegrationType" + } + }, + "com.amazonaws.securityhub#InternalException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.securityhub#NonEmptyString" + }, + "Code": { + "target": "com.amazonaws.securityhub#NonEmptyString" + } + }, + "traits": { + "smithy.api#documentation": "

Internal server error.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.securityhub#InvalidAccessException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.securityhub#NonEmptyString" + }, + "Code": { + "target": "com.amazonaws.securityhub#NonEmptyString" + } + }, + "traits": { + "smithy.api#documentation": "

The account doesn't have permission to perform this action.

", + "smithy.api#error": "client", + "smithy.api#httpError": 401 + } + }, + "com.amazonaws.securityhub#InvalidInputException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.securityhub#NonEmptyString" + }, + "Code": { + "target": "com.amazonaws.securityhub#NonEmptyString" + } + }, + "traits": { + "smithy.api#documentation": "

The request was rejected because you supplied an invalid or out-of-range value for an\n input parameter.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.securityhub#Invitation": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.securityhub#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the Security Hub administrator account that the invitation was sent from.

" + } + }, + "InvitationId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the invitation sent to the member account.

" + } + }, + "InvitedAt": { + "target": "com.amazonaws.securityhub#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the invitation was sent.

" + } + }, + "MemberStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The current status of the association between the member and administrator accounts.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about an invitation.

" + } + }, + "com.amazonaws.securityhub#InvitationList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#Invitation" + } + }, + "com.amazonaws.securityhub#InviteMembers": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#InviteMembersRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#InviteMembersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Invites other Amazon Web Services accounts to become member accounts for the Security Hub administrator account that\n the invitation is sent from.

\n

This operation is only used to invite accounts that do not belong to an organization.\n Organization accounts do not receive invitations.

\n

Before you can use this action to invite a member, you must first use the CreateMembers action to create the member account in Security Hub.

\n

When the account owner enables Security Hub and accepts the invitation to become a member\n account, the administrator account can view the findings generated from the member account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/members/invite", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#InviteMembersRequest": { + "type": "structure", + "members": { + "AccountIds": { + "target": "com.amazonaws.securityhub#AccountIdList", + "traits": { + "smithy.api#documentation": "

The list of account IDs of the Amazon Web Services accounts to invite to Security Hub as members.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#InviteMembersResponse": { + "type": "structure", + "members": { + "UnprocessedAccounts": { + "target": "com.amazonaws.securityhub#ResultList", + "traits": { + "smithy.api#documentation": "

The list of Amazon Web Services accounts that could not be processed. For each account, the list\n includes the account ID and the email address.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#IpFilter": { + "type": "structure", + "members": { + "Cidr": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A finding's CIDR value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The IP filter for querying findings.

" + } + }, + "com.amazonaws.securityhub#IpFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#IpFilter" + } + }, + "com.amazonaws.securityhub#IpOrganizationDetails": { + "type": "structure", + "members": { + "Asn": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The Autonomous System Number (ASN) of the internet provider

" + } + }, + "AsnOrg": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the organization that registered the ASN.

" + } + }, + "Isp": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ISP information for the internet provider.

" + } + }, + "Org": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the internet provider.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about an internet provider.

" + } + }, + "com.amazonaws.securityhub#Ipv6CidrBlockAssociation": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The association ID for the IPv6 CIDR block.

" + } + }, + "Ipv6CidrBlock": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The IPv6 CIDR block.

" + } + }, + "CidrBlockState": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Information about the state of the CIDR block. Valid values are as follows:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

An IPV6 CIDR block association.

" + } + }, + "com.amazonaws.securityhub#Ipv6CidrBlockAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#Ipv6CidrBlockAssociation" + } + }, + "com.amazonaws.securityhub#KeywordFilter": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A value for the keyword.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A keyword filter for querying findings.

" + } + }, + "com.amazonaws.securityhub#KeywordFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#KeywordFilter" + } + }, + "com.amazonaws.securityhub#LimitExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.securityhub#NonEmptyString" + }, + "Code": { + "target": "com.amazonaws.securityhub#NonEmptyString" + } + }, + "traits": { + "smithy.api#documentation": "

The request was rejected because it attempted to create resources beyond the current Amazon Web Services\n account or throttling limits. The error code describes the limit exceeded.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.securityhub#ListAutomationRules": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#ListAutomationRulesRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#ListAutomationRulesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#AccessDeniedException" + }, + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

\n A list of automation rules and their metadata for the calling account.\n

", + "smithy.api#http": { + "method": "GET", + "uri": "/automationrules/list", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#ListAutomationRulesRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

\n A token to specify where to start paginating the response. This is the NextToken \n from a previously truncated response. On your first call to the ListAutomationRules \n API, set the value of this parameter to NULL.\n

", + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.securityhub#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of rules to return in the response. This currently ranges from 1 to\n 100.

", + "smithy.api#httpQuery": "MaxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#ListAutomationRulesResponse": { + "type": "structure", + "members": { + "AutomationRulesMetadata": { + "target": "com.amazonaws.securityhub#AutomationRulesMetadataList", + "traits": { + "smithy.api#documentation": "

\n Metadata for rules in the calling account. The response includes rules with a \n RuleStatus of ENABLED and DISABLED.\n

" + } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

\n A pagination token for the response.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#ListEnabledProductsForImport": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#ListEnabledProductsForImportRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#ListEnabledProductsForImportResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all findings-generating solutions (products) that you are subscribed to receive\n findings from in Security Hub.

", + "smithy.api#http": { + "method": "GET", + "uri": "/productSubscriptions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ProductSubscriptions", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.securityhub#ListEnabledProductsForImportRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

The token that is required for pagination. On your first call to the\n ListEnabledProductsForImport operation, set the value of this parameter to\n NULL.

\n

For subsequent calls to the operation, to continue listing data, set the value of this\n parameter to the value returned from the previous response.

", + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.securityhub#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return in the response.

", + "smithy.api#httpQuery": "MaxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#ListEnabledProductsForImportResponse": { + "type": "structure", + "members": { + "ProductSubscriptions": { + "target": "com.amazonaws.securityhub#ProductSubscriptionArnList", + "traits": { + "smithy.api#documentation": "

The list of ARNs for the resources that represent your subscriptions to products.

" + } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token to use to request the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#ListFindingAggregators": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#ListFindingAggregatorsRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#ListFindingAggregatorsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#AccessDeniedException" + }, + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

If finding aggregation is enabled, then ListFindingAggregators returns the ARN of the finding aggregator. You can run this operation from any Region.

", + "smithy.api#http": { + "method": "GET", + "uri": "/findingAggregator/list", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "FindingAggregators", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.securityhub#ListFindingAggregatorsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned with the previous set of results. Identifies the next set of results to return.

", + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.securityhub#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return. This operation currently only returns a single result.

", + "smithy.api#httpQuery": "MaxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#ListFindingAggregatorsResponse": { + "type": "structure", + "members": { + "FindingAggregators": { + "target": "com.amazonaws.securityhub#FindingAggregatorList", + "traits": { + "smithy.api#documentation": "

The list of finding aggregators. This operation currently only returns a single result.

" + } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

If there are more results, this is the token to provide in the next call to ListFindingAggregators.

\n

This operation currently only returns a single result.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#ListInvitations": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#ListInvitationsRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#ListInvitationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all Security Hub membership invitations that were sent to the current Amazon Web Services account.

\n

This operation is only used by accounts that are managed by invitation.\n Accounts that are managed using the integration with Organizations do not receive invitations.

", + "smithy.api#http": { + "method": "GET", + "uri": "/invitations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Invitations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.securityhub#ListInvitationsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.securityhub#CrossAccountMaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return in the response.

", + "smithy.api#httpQuery": "MaxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

The token that is required for pagination. On your first call to the\n ListInvitations operation, set the value of this parameter to\n NULL.

\n

For subsequent calls to the operation, to continue listing data, set the value of this\n parameter to the value returned from the previous response.

", + "smithy.api#httpQuery": "NextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#ListInvitationsResponse": { + "type": "structure", + "members": { + "Invitations": { + "target": "com.amazonaws.securityhub#InvitationList", + "traits": { + "smithy.api#documentation": "

The details of the invitations returned by the operation.

" + } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The pagination token to use to request the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#ListMembers": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#ListMembersRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#ListMembersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists details about all member accounts for the current Security Hub administrator\n account.

\n

The results include both member accounts that belong to an organization and member\n accounts that were invited manually.

", + "smithy.api#http": { + "method": "GET", + "uri": "/members", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Members", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.securityhub#ListMembersRequest": { + "type": "structure", + "members": { + "OnlyAssociated": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies which member accounts to include in the response based on their relationship\n status with the administrator account. The default value is TRUE.

\n

If OnlyAssociated is set to TRUE, the response includes member\n accounts whose relationship status with the administrator account is set to ENABLED.

\n

If OnlyAssociated is set to FALSE, the response includes all\n existing member accounts.

", + "smithy.api#httpQuery": "OnlyAssociated" + } + }, + "MaxResults": { + "target": "com.amazonaws.securityhub#CrossAccountMaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return in the response.

", + "smithy.api#httpQuery": "MaxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

The token that is required for pagination. On your first call to the\n ListMembers operation, set the value of this parameter to\n NULL.

\n

For subsequent calls to the operation, to continue listing data, set the value of this\n parameter to the value returned from the previous response.

", + "smithy.api#httpQuery": "NextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#ListMembersResponse": { + "type": "structure", + "members": { + "Members": { + "target": "com.amazonaws.securityhub#MemberList", + "traits": { + "smithy.api#documentation": "

Member details returned by the operation.

" + } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The pagination token to use to request the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#ListOrganizationAdminAccounts": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#ListOrganizationAdminAccountsRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#ListOrganizationAdminAccountsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the Security Hub administrator accounts. Can only be called by the organization\n management account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/organization/admin", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AdminAccounts", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.securityhub#ListOrganizationAdminAccountsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.securityhub#AdminsMaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of items to return in the response.

", + "smithy.api#httpQuery": "MaxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

The token that is required for pagination. On your first call to the\n ListOrganizationAdminAccounts operation, set the value of this parameter to\n NULL. For subsequent calls to the operation, to continue listing data, set\n the value of this parameter to the value returned from the previous response.

", + "smithy.api#httpQuery": "NextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#ListOrganizationAdminAccountsResponse": { + "type": "structure", + "members": { + "AdminAccounts": { + "target": "com.amazonaws.securityhub#AdminAccounts", + "traits": { + "smithy.api#documentation": "

The list of Security Hub administrator accounts.

" + } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token to use to request the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#ListSecurityControlDefinitions": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#ListSecurityControlDefinitionsRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#ListSecurityControlDefinitionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Lists all of the security controls that apply to a specified standard. \n

", + "smithy.api#http": { + "method": "GET", + "uri": "/securityControls/definitions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "SecurityControlDefinitions", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.securityhub#ListSecurityControlDefinitionsRequest": { + "type": "structure", + "members": { + "StandardsArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the standard that you want to view controls for.\n

", + "smithy.api#httpQuery": "StandardsArn" + } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

\n Optional pagination parameter.\n

", + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.securityhub#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

An optional parameter that limits the total results of the API response to the\n specified number. If this parameter isn't provided in the request, the results include the\n first 25 security controls that apply to the specified standard. The results also include a\n NextToken parameter that you can use in a subsequent API call to get the\n next 25 controls. This repeats until all controls for the standard are returned.

", + "smithy.api#httpQuery": "MaxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#ListSecurityControlDefinitionsResponse": { + "type": "structure", + "members": { + "SecurityControlDefinitions": { + "target": "com.amazonaws.securityhub#SecurityControlDefinitions", + "traits": { + "smithy.api#documentation": "

\n An array of controls that apply to the specified standard.\n

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

A pagination parameter that's included in the response only if it was included in the\n request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#ListStandardsControlAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#ListStandardsControlAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#ListStandardsControlAssociationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Specifies whether a control is currently enabled or disabled in each enabled standard in the calling account.\n

", + "smithy.api#http": { + "method": "GET", + "uri": "/associations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "StandardsControlAssociationSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.securityhub#ListStandardsControlAssociationsRequest": { + "type": "structure", + "members": { + "SecurityControlId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The identifier of the control (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters) that you \n want to determine the enablement status of in each enabled standard. \n

", + "smithy.api#httpQuery": "SecurityControlId", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

\n Optional pagination parameter.\n

", + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.securityhub#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

An optional parameter that limits the total results of the API response to the\n specified number. If this parameter isn't provided in the request, the results include the\n first 25 standard and control associations. The results also include a\n NextToken parameter that you can use in a subsequent API call to get the\n next 25 associations. This repeats until all associations for the specified control are\n returned. The number of results is limited by the number of supported Security Hub\n standards that you've enabled in the calling account.

", + "smithy.api#httpQuery": "MaxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#ListStandardsControlAssociationsResponse": { + "type": "structure", + "members": { + "StandardsControlAssociationSummaries": { + "target": "com.amazonaws.securityhub#StandardsControlAssociationSummaries", + "traits": { + "smithy.api#documentation": "

An array that provides the enablement status and other details for each security\n control that applies to each enabled standard.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

A pagination parameter that's included in the response only if it was included in the\n request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of tags associated with a resource.

", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{ResourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.securityhub#ResourceArn", + "traits": { + "smithy.api#documentation": "

The ARN of the resource to retrieve tags for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.securityhub#TagMap", + "traits": { + "smithy.api#documentation": "

The tags associated with a resource.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#LoadBalancerState": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The state code. The initial state of the load balancer is provisioning.

\n

After the load balancer is fully set up and ready to route traffic, its state is\n active.

\n

If the load balancer could not be set up, its state is failed.

" + } + }, + "Reason": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A description of the state.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the state of the load balancer.

" + } + }, + "com.amazonaws.securityhub#Long": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.securityhub#Malware": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the malware that was observed.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.securityhub#MalwareType", + "traits": { + "smithy.api#documentation": "

The type of the malware that was observed.

" + } + }, + "Path": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The file system path of the malware that was observed.

" + } + }, + "State": { + "target": "com.amazonaws.securityhub#MalwareState", + "traits": { + "smithy.api#documentation": "

The state of the malware that was observed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of malware related to a finding.

" + } + }, + "com.amazonaws.securityhub#MalwareList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#Malware" + } + }, + "com.amazonaws.securityhub#MalwareState": { + "type": "enum", + "members": { + "OBSERVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OBSERVED" + } + }, + "REMOVAL_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REMOVAL_FAILED" + } + }, + "REMOVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REMOVED" + } + } + } + }, + "com.amazonaws.securityhub#MalwareType": { + "type": "enum", + "members": { + "ADWARE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADWARE" + } + }, + "BLENDED_THREAT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLENDED_THREAT" + } + }, + "BOTNET_AGENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOTNET_AGENT" + } + }, + "COIN_MINER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COIN_MINER" + } + }, + "EXPLOIT_KIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPLOIT_KIT" + } + }, + "KEYLOGGER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KEYLOGGER" + } + }, + "MACRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MACRO" + } + }, + "POTENTIALLY_UNWANTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POTENTIALLY_UNWANTED" + } + }, + "SPYWARE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPYWARE" + } + }, + "RANSOMWARE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RANSOMWARE" + } + }, + "REMOTE_ACCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REMOTE_ACCESS" + } + }, + "ROOTKIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROOTKIT" + } + }, + "TROJAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TROJAN" + } + }, + "VIRUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VIRUS" + } + }, + "WORM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WORM" + } + } + } + }, + "com.amazonaws.securityhub#MapFilter": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The key of the map filter. For example, for ResourceTags, Key\n identifies the name of the tag. For UserDefinedFields, Key is the\n name of the field.

" + } + }, + "Value": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The value for the key in the map filter. Filter values are case sensitive. For example,\n one of the values for a tag called Department might be Security.\n If you provide security as the filter value, then there is no match.

" + } + }, + "Comparison": { + "target": "com.amazonaws.securityhub#MapFilterComparison", + "traits": { + "smithy.api#documentation": "

The condition to apply to the key value when querying for findings with a map\n filter.

\n

To search for values that exactly match the filter value, use EQUALS. For\n example, for the ResourceTags field, the filter Department EQUALS\n Security matches findings that have the value Security for the tag\n Department.

\n

To search for values other than the filter value, use NOT_EQUALS. For\n example, for the ResourceTags field, the filter Department NOT_EQUALS\n Finance matches findings that do not have the value Finance for the\n tag Department.

\n

\n EQUALS filters on the same field are joined by OR. A finding\n matches if it matches any one of those filters.

\n

\n NOT_EQUALS filters on the same field are joined by AND. A\n finding matches only if it matches all of those filters.

\n

You cannot have both an EQUALS filter and a NOT_EQUALS filter\n on the same field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A map filter for querying findings. Each map filter provides the field to check, the\n value to look for, and the comparison operator.

" + } + }, + "com.amazonaws.securityhub#MapFilterComparison": { + "type": "enum", + "members": { + "EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQUALS" + } + }, + "NOT_EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_EQUALS" + } + } + } + }, + "com.amazonaws.securityhub#MapFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#MapFilter" + } + }, + "com.amazonaws.securityhub#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.securityhub#Member": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.securityhub#AccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the member account.

" + } + }, + "Email": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The email address of the member account.

" + } + }, + "MasterId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#deprecated": { + "message": "This field is deprecated, use AdministratorId instead." + }, + "smithy.api#documentation": "

This is replaced by AdministratorID.

\n

The Amazon Web Services account ID of the Security Hub administrator account associated with this member account.

" + } + }, + "AdministratorId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the Security Hub administrator account associated with this member account.

" + } + }, + "MemberStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of the relationship between the member account and its administrator account.\n

\n

The status can have one of the following values:

\n " + } + }, + "InvitedAt": { + "target": "com.amazonaws.securityhub#Timestamp", + "traits": { + "smithy.api#documentation": "

A timestamp for the date and time when the invitation was sent to the member\n account.

" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.securityhub#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp for the date and time when the member account was updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details about a member account.

" + } + }, + "com.amazonaws.securityhub#MemberList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#Member" + } + }, + "com.amazonaws.securityhub#Network": { + "type": "structure", + "members": { + "Direction": { + "target": "com.amazonaws.securityhub#NetworkDirection", + "traits": { + "smithy.api#documentation": "

The direction of network traffic associated with a finding.

" + } + }, + "Protocol": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The protocol of network-related information about a finding.

" + } + }, + "OpenPortRange": { + "target": "com.amazonaws.securityhub#PortRange", + "traits": { + "smithy.api#documentation": "

The range of open ports that is present on the network.

" + } + }, + "SourceIpV4": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The source IPv4 address of network-related information about a finding.

" + } + }, + "SourceIpV6": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The source IPv6 address of network-related information about a finding.

" + } + }, + "SourcePort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The source port of network-related information about a finding.

" + } + }, + "SourceDomain": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The source domain of network-related information about a finding.

" + } + }, + "SourceMac": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The source media access control (MAC) address of network-related information about a\n finding.

" + } + }, + "DestinationIpV4": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The destination IPv4 address of network-related information about a finding.

" + } + }, + "DestinationIpV6": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The destination IPv6 address of network-related information about a finding.

" + } + }, + "DestinationPort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The destination port of network-related information about a finding.

" + } + }, + "DestinationDomain": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The destination domain of network-related information about a finding.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details of network-related information about a finding.

" + } + }, + "com.amazonaws.securityhub#NetworkConnectionAction": { + "type": "structure", + "members": { + "ConnectionDirection": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The direction of the network connection request (IN or\n OUT).

" + } + }, + "RemoteIpDetails": { + "target": "com.amazonaws.securityhub#ActionRemoteIpDetails", + "traits": { + "smithy.api#documentation": "

Information about the remote IP address that issued the network connection\n request.

" + } + }, + "RemotePortDetails": { + "target": "com.amazonaws.securityhub#ActionRemotePortDetails", + "traits": { + "smithy.api#documentation": "

Information about the port on the remote IP address.

" + } + }, + "LocalPortDetails": { + "target": "com.amazonaws.securityhub#ActionLocalPortDetails", + "traits": { + "smithy.api#documentation": "

Information about the port on the EC2 instance.

" + } + }, + "Protocol": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The protocol used to make the network connection request.

" + } + }, + "Blocked": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the network connection attempt was blocked.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provided if ActionType is NETWORK_CONNECTION. It provides\n details about the attempted network connection that was detected.

" + } + }, + "com.amazonaws.securityhub#NetworkDirection": { + "type": "enum", + "members": { + "IN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN" + } + }, + "OUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OUT" + } + } + } + }, + "com.amazonaws.securityhub#NetworkHeader": { + "type": "structure", + "members": { + "Protocol": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The protocol used for the component.

" + } + }, + "Destination": { + "target": "com.amazonaws.securityhub#NetworkPathComponentDetails", + "traits": { + "smithy.api#documentation": "

Information about the destination of the component.

" + } + }, + "Source": { + "target": "com.amazonaws.securityhub#NetworkPathComponentDetails", + "traits": { + "smithy.api#documentation": "

Information about the origin of the component.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about a network path component that occurs before or after the current\n component.

" + } + }, + "com.amazonaws.securityhub#NetworkPathComponent": { + "type": "structure", + "members": { + "ComponentId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of a component in the network path.

" + } + }, + "ComponentType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of component.

" + } + }, + "Egress": { + "target": "com.amazonaws.securityhub#NetworkHeader", + "traits": { + "smithy.api#documentation": "

Information about the component that comes after the current component in the network\n path.

" + } + }, + "Ingress": { + "target": "com.amazonaws.securityhub#NetworkHeader", + "traits": { + "smithy.api#documentation": "

Information about the component that comes before the current node in the network\n path.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a network path component.

" + } + }, + "com.amazonaws.securityhub#NetworkPathComponentDetails": { + "type": "structure", + "members": { + "Address": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

The IP addresses of the destination.

" + } + }, + "PortRanges": { + "target": "com.amazonaws.securityhub#PortRangeList", + "traits": { + "smithy.api#documentation": "

A list of port ranges for the destination.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the destination of the next component in the network path.

" + } + }, + "com.amazonaws.securityhub#NetworkPathList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#NetworkPathComponent" + } + }, + "com.amazonaws.securityhub#NextToken": { + "type": "string" + }, + "com.amazonaws.securityhub#NonEmptyString": { + "type": "string", + "traits": { + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.securityhub#NonEmptyStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#NonEmptyString" + } + }, + "com.amazonaws.securityhub#Note": { + "type": "structure", + "members": { + "Text": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The text of a note.

", + "smithy.api#required": {} + } + }, + "UpdatedBy": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The principal that created a note.

", + "smithy.api#required": {} + } + }, + "UpdatedAt": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The timestamp of when the note was updated.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A user-defined note added to a finding.

" + } + }, + "com.amazonaws.securityhub#NoteUpdate": { + "type": "structure", + "members": { + "Text": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The updated note text.

", + "smithy.api#required": {} + } + }, + "UpdatedBy": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The principal that updated the note.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The updated note.

" + } + }, + "com.amazonaws.securityhub#NumberFilter": { + "type": "structure", + "members": { + "Gte": { + "target": "com.amazonaws.securityhub#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The greater-than-equal condition to be applied to a single field when querying for\n findings.

" + } + }, + "Lte": { + "target": "com.amazonaws.securityhub#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The less-than-equal condition to be applied to a single field when querying for\n findings.

" + } + }, + "Eq": { + "target": "com.amazonaws.securityhub#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The equal-to condition to be applied to a single field when querying for\n findings.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A number filter for querying findings.

" + } + }, + "com.amazonaws.securityhub#NumberFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#NumberFilter" + } + }, + "com.amazonaws.securityhub#Occurrences": { + "type": "structure", + "members": { + "LineRanges": { + "target": "com.amazonaws.securityhub#Ranges", + "traits": { + "smithy.api#documentation": "

Occurrences of sensitive data detected in a non-binary text file or a Microsoft Word file. Non-binary text files include files such as HTML, XML, JSON, and TXT files.

" + } + }, + "OffsetRanges": { + "target": "com.amazonaws.securityhub#Ranges", + "traits": { + "smithy.api#documentation": "

Occurrences of sensitive data detected in a binary text file.

" + } + }, + "Pages": { + "target": "com.amazonaws.securityhub#Pages", + "traits": { + "smithy.api#documentation": "

Occurrences of sensitive data in an Adobe Portable Document Format (PDF) file.

" + } + }, + "Records": { + "target": "com.amazonaws.securityhub#Records", + "traits": { + "smithy.api#documentation": "

Occurrences of sensitive data in an Apache Avro object container or an Apache Parquet file.

" + } + }, + "Cells": { + "target": "com.amazonaws.securityhub#Cells", + "traits": { + "smithy.api#documentation": "

Occurrences of sensitive data detected in Microsoft Excel workbooks, comma-separated value (CSV) files, or tab-separated value (TSV) files.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The detected occurrences of sensitive data.

" + } + }, + "com.amazonaws.securityhub#Page": { + "type": "structure", + "members": { + "PageNumber": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The page number of the page that contains the sensitive data.

" + } + }, + "LineRange": { + "target": "com.amazonaws.securityhub#Range", + "traits": { + "smithy.api#documentation": "

An occurrence of sensitive data detected in a non-binary text file or a Microsoft Word file. Non-binary text files include files such as HTML, XML, JSON, and TXT files.

" + } + }, + "OffsetRange": { + "target": "com.amazonaws.securityhub#Range", + "traits": { + "smithy.api#documentation": "

An occurrence of sensitive data detected in a binary text file.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An occurrence of sensitive data in an Adobe Portable Document Format (PDF) file.

" + } + }, + "com.amazonaws.securityhub#Pages": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#Page" + } + }, + "com.amazonaws.securityhub#Partition": { + "type": "enum", + "members": { + "AWS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "aws" + } + }, + "AWS_CN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "aws-cn" + } + }, + "AWS_US_GOV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "aws-us-gov" + } + } + } + }, + "com.amazonaws.securityhub#PatchSummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the compliance standard that was used to determine the patch\n compliance status.

", + "smithy.api#required": {} + } + }, + "InstalledCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of patches from the compliance standard that were installed\n successfully.

" + } + }, + "MissingCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of patches that are part of the compliance standard but are not installed.\n The count includes patches that failed to install.

" + } + }, + "FailedCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of patches from the compliance standard that failed to install.

" + } + }, + "InstalledOtherCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of installed patches that are not part of the compliance standard.

" + } + }, + "InstalledRejectedCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of patches that are installed but are also on a list of patches that the\n customer rejected.

" + } + }, + "InstalledPendingReboot": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of patches that were applied, but that require the instance to be rebooted in\n order to be marked as installed.

" + } + }, + "OperationStartTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the operation started.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "OperationEndTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the operation completed.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "RebootOption": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The reboot option specified for the instance.

" + } + }, + "Operation": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of patch operation performed. For Patch Manager, the values are\n SCAN and INSTALL.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides an overview of the patch compliance status for an instance against a selected\n compliance standard.

" + } + }, + "com.amazonaws.securityhub#PortProbeAction": { + "type": "structure", + "members": { + "PortProbeDetails": { + "target": "com.amazonaws.securityhub#PortProbeDetailList", + "traits": { + "smithy.api#documentation": "

Information about the ports affected by the port probe.

" + } + }, + "Blocked": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the port probe was blocked.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provided if ActionType is PORT_PROBE. It provides details\n about the attempted port probe that was detected.

" + } + }, + "com.amazonaws.securityhub#PortProbeDetail": { + "type": "structure", + "members": { + "LocalPortDetails": { + "target": "com.amazonaws.securityhub#ActionLocalPortDetails", + "traits": { + "smithy.api#documentation": "

Provides information about the port that was scanned.

" + } + }, + "LocalIpDetails": { + "target": "com.amazonaws.securityhub#ActionLocalIpDetails", + "traits": { + "smithy.api#documentation": "

Provides information about the IP address where the scanned port is located.

" + } + }, + "RemoteIpDetails": { + "target": "com.amazonaws.securityhub#ActionRemoteIpDetails", + "traits": { + "smithy.api#documentation": "

Provides information about the remote IP address that performed the scan.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A port scan that was part of the port probe. For each scan, PortProbeDetails provides\n information about the local IP address and port that were scanned, and the remote IP\n address that the scan originated from.

" + } + }, + "com.amazonaws.securityhub#PortProbeDetailList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#PortProbeDetail" + } + }, + "com.amazonaws.securityhub#PortRange": { + "type": "structure", + "members": { + "Begin": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The first port in the port range.

" + } + }, + "End": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The last port in the port range.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A range of ports.

" + } + }, + "com.amazonaws.securityhub#PortRangeFromTo": { + "type": "structure", + "members": { + "From": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The first port in the port range.

" + } + }, + "To": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The last port in the port range.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A range of ports.

" + } + }, + "com.amazonaws.securityhub#PortRangeList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#PortRange" + } + }, + "com.amazonaws.securityhub#ProcessDetails": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the process.

" + } + }, + "Path": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The path to the process executable.

" + } + }, + "Pid": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The process ID.

" + } + }, + "ParentPid": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The parent process ID. This field accepts positive integers between O and 2147483647.

" + } + }, + "LaunchedAt": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the process was launched.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "TerminatedAt": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the process was terminated.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details of process-related information about a finding.

" + } + }, + "com.amazonaws.securityhub#Product": { + "type": "structure", + "members": { + "ProductArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN assigned to the product.

", + "smithy.api#required": {} + } + }, + "ProductName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the product.

" + } + }, + "CompanyName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the company that provides the product.

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A description of the product.

" + } + }, + "Categories": { + "target": "com.amazonaws.securityhub#CategoryList", + "traits": { + "smithy.api#documentation": "

The categories assigned to the product.

" + } + }, + "IntegrationTypes": { + "target": "com.amazonaws.securityhub#IntegrationTypeList", + "traits": { + "smithy.api#documentation": "

The types of integration that the product supports. Available values are the\n following.

\n " + } + }, + "MarketplaceUrl": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

For integrations with Amazon Web Services services, the Amazon Web Services Console URL from which to activate the service.

\n

For integrations with third-party products, the Amazon Web Services Marketplace URL from which to subscribe to or purchase the product.

" + } + }, + "ActivationUrl": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The URL to the service or product documentation about the integration with Security Hub, including how to activate the integration.

" + } + }, + "ProductSubscriptionResourcePolicy": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The resource policy associated with the product.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about a product.

" + } + }, + "com.amazonaws.securityhub#ProductSubscriptionArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#NonEmptyString" + } + }, + "com.amazonaws.securityhub#ProductsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#Product" + } + }, + "com.amazonaws.securityhub#PropagatingVgwSetDetails": { + "type": "structure", + "members": { + "GatewayId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of the virtual private gateway.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Describes a virtual private gateway propagating route.\n

" + } + }, + "com.amazonaws.securityhub#PropagatingVgwSetList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#PropagatingVgwSetDetails" + } + }, + "com.amazonaws.securityhub#Range": { + "type": "structure", + "members": { + "Start": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.

" + } + }, + "End": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.

" + } + }, + "StartColumn": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

In the line where the sensitive data starts, the column within the line where the sensitive data starts.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Identifies where the sensitive data begins and ends.

" + } + }, + "com.amazonaws.securityhub#Ranges": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#Range" + } + }, + "com.amazonaws.securityhub#RatioScale": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.securityhub#Recommendation": { + "type": "structure", + "members": { + "Text": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Describes the recommended steps to take to remediate an issue identified in a finding.

" + } + }, + "Url": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A URL to a page or site that contains information about how to remediate a finding.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A recommendation on how to remediate the issue identified in a finding.

" + } + }, + "com.amazonaws.securityhub#Record": { + "type": "structure", + "members": { + "JsonPath": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The path, as a JSONPath expression, to the field in the record that contains the data. If the field name is longer than 20 characters, it is truncated. If the path is longer than 250 characters, it is truncated.

" + } + }, + "RecordIndex": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The record index, starting from 0, for the record that contains the data.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An occurrence of sensitive data in an Apache Avro object container or an Apache Parquet file.

" + } + }, + "com.amazonaws.securityhub#RecordState": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "ARCHIVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARCHIVED" + } + } + } + }, + "com.amazonaws.securityhub#Records": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#Record" + } + }, + "com.amazonaws.securityhub#RegionAvailabilityStatus": { + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "UNAVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNAVAILABLE" + } + } + } + }, + "com.amazonaws.securityhub#RelatedFinding": { + "type": "structure", + "members": { + "ProductArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the product that generated a related finding.

", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The product-generated identifier for a related finding.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about a related finding.

" + } + }, + "com.amazonaws.securityhub#RelatedFindingList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#RelatedFinding" + } + }, + "com.amazonaws.securityhub#RelatedRequirementsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#NonEmptyString" + } + }, + "com.amazonaws.securityhub#Remediation": { + "type": "structure", + "members": { + "Recommendation": { + "target": "com.amazonaws.securityhub#Recommendation", + "traits": { + "smithy.api#documentation": "

A recommendation on the steps to take to remediate the issue identified by a finding.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the remediation steps for a finding.

" + } + }, + "com.amazonaws.securityhub#Resource": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of the resource that details are provided for. If possible, set\n Type to one of the supported resource types. For example, if the resource\n is an EC2 instance, then set Type to AwsEc2Instance.

\n

If the resource does not match any of the provided types, then set Type to\n Other.

", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The canonical identifier for the given resource type.

", + "smithy.api#required": {} + } + }, + "Partition": { + "target": "com.amazonaws.securityhub#Partition", + "traits": { + "smithy.api#documentation": "

The canonical Amazon Web Services partition name that the Region is assigned to.

" + } + }, + "Region": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The canonical Amazon Web Services external Region name where this resource is located.

" + } + }, + "ResourceRole": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Identifies the role of the resource in the finding. A resource is either the actor or target of the finding activity,

" + } + }, + "Tags": { + "target": "com.amazonaws.securityhub#FieldMap", + "traits": { + "smithy.api#documentation": "

A list of Amazon Web Services tags associated with a resource at the time the finding was\n processed.

" + } + }, + "DataClassification": { + "target": "com.amazonaws.securityhub#DataClassificationDetails", + "traits": { + "smithy.api#documentation": "

Contains information about sensitive data that was detected on the resource.

" + } + }, + "Details": { + "target": "com.amazonaws.securityhub#ResourceDetails", + "traits": { + "smithy.api#documentation": "

Additional details about the resource related to a finding.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A resource related to a finding.

" + } + }, + "com.amazonaws.securityhub#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws:securityhub:" + } + }, + "com.amazonaws.securityhub#ResourceConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.securityhub#NonEmptyString" + }, + "Code": { + "target": "com.amazonaws.securityhub#NonEmptyString" + } + }, + "traits": { + "smithy.api#documentation": "

The resource specified in the request conflicts with an existing resource.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.securityhub#ResourceDetails": { + "type": "structure", + "members": { + "AwsAutoScalingAutoScalingGroup": { + "target": "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupDetails", + "traits": { + "smithy.api#documentation": "

Details for an autoscaling group.

" + } + }, + "AwsCodeBuildProject": { + "target": "com.amazonaws.securityhub#AwsCodeBuildProjectDetails", + "traits": { + "smithy.api#documentation": "

Details for an CodeBuild project.

" + } + }, + "AwsCloudFrontDistribution": { + "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionDetails", + "traits": { + "smithy.api#documentation": "

Details about a CloudFront distribution.

" + } + }, + "AwsEc2Instance": { + "target": "com.amazonaws.securityhub#AwsEc2InstanceDetails", + "traits": { + "smithy.api#documentation": "

Details about an EC2 instance related to a finding.

" + } + }, + "AwsEc2NetworkInterface": { + "target": "com.amazonaws.securityhub#AwsEc2NetworkInterfaceDetails", + "traits": { + "smithy.api#documentation": "

Details for an EC2 network interface.

" + } + }, + "AwsEc2SecurityGroup": { + "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupDetails", + "traits": { + "smithy.api#documentation": "

Details for an EC2 security group.

" + } + }, + "AwsEc2Volume": { + "target": "com.amazonaws.securityhub#AwsEc2VolumeDetails", + "traits": { + "smithy.api#documentation": "

Details for an Amazon EC2 volume.

" + } + }, + "AwsEc2Vpc": { + "target": "com.amazonaws.securityhub#AwsEc2VpcDetails", + "traits": { + "smithy.api#documentation": "

Details for an Amazon EC2 VPC.

" + } + }, + "AwsEc2Eip": { + "target": "com.amazonaws.securityhub#AwsEc2EipDetails", + "traits": { + "smithy.api#documentation": "

Details about an Elastic IP address.

" + } + }, + "AwsEc2Subnet": { + "target": "com.amazonaws.securityhub#AwsEc2SubnetDetails", + "traits": { + "smithy.api#documentation": "

Details about a subnet in Amazon EC2.

" + } + }, + "AwsEc2NetworkAcl": { + "target": "com.amazonaws.securityhub#AwsEc2NetworkAclDetails", + "traits": { + "smithy.api#documentation": "

Details about an EC2 network access control list (ACL).

" + } + }, + "AwsElbv2LoadBalancer": { + "target": "com.amazonaws.securityhub#AwsElbv2LoadBalancerDetails", + "traits": { + "smithy.api#documentation": "

Details about a load balancer.

" + } + }, + "AwsElasticBeanstalkEnvironment": { + "target": "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentDetails", + "traits": { + "smithy.api#documentation": "

Details about an Elastic Beanstalk environment.

" + } + }, + "AwsElasticsearchDomain": { + "target": "com.amazonaws.securityhub#AwsElasticsearchDomainDetails", + "traits": { + "smithy.api#documentation": "

Details for an Elasticsearch domain.

" + } + }, + "AwsS3Bucket": { + "target": "com.amazonaws.securityhub#AwsS3BucketDetails", + "traits": { + "smithy.api#documentation": "

Details about an S3 bucket related to a finding.

" + } + }, + "AwsS3AccountPublicAccessBlock": { + "target": "com.amazonaws.securityhub#AwsS3AccountPublicAccessBlockDetails", + "traits": { + "smithy.api#documentation": "

Details about the Amazon S3 Public Access Block configuration for an account.

" + } + }, + "AwsS3Object": { + "target": "com.amazonaws.securityhub#AwsS3ObjectDetails", + "traits": { + "smithy.api#documentation": "

Details about an S3 object related to a finding.

" + } + }, + "AwsSecretsManagerSecret": { + "target": "com.amazonaws.securityhub#AwsSecretsManagerSecretDetails", + "traits": { + "smithy.api#documentation": "

Details about a Secrets Manager secret.

" + } + }, + "AwsIamAccessKey": { + "target": "com.amazonaws.securityhub#AwsIamAccessKeyDetails", + "traits": { + "smithy.api#documentation": "

Details about an IAM access key related to a finding.

" + } + }, + "AwsIamUser": { + "target": "com.amazonaws.securityhub#AwsIamUserDetails", + "traits": { + "smithy.api#documentation": "

Details about an IAM user.

" + } + }, + "AwsIamPolicy": { + "target": "com.amazonaws.securityhub#AwsIamPolicyDetails", + "traits": { + "smithy.api#documentation": "

Details about an IAM permissions policy.

" + } + }, + "AwsApiGatewayV2Stage": { + "target": "com.amazonaws.securityhub#AwsApiGatewayV2StageDetails", + "traits": { + "smithy.api#documentation": "

Provides information about a version 2 stage for Amazon API Gateway.

" + } + }, + "AwsApiGatewayV2Api": { + "target": "com.amazonaws.securityhub#AwsApiGatewayV2ApiDetails", + "traits": { + "smithy.api#documentation": "

Provides information about a version 2 API in Amazon API Gateway.

" + } + }, + "AwsDynamoDbTable": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableDetails", + "traits": { + "smithy.api#documentation": "

Details about a DynamoDB table.

" + } + }, + "AwsApiGatewayStage": { + "target": "com.amazonaws.securityhub#AwsApiGatewayStageDetails", + "traits": { + "smithy.api#documentation": "

Provides information about a version 1 Amazon API Gateway stage.

" + } + }, + "AwsApiGatewayRestApi": { + "target": "com.amazonaws.securityhub#AwsApiGatewayRestApiDetails", + "traits": { + "smithy.api#documentation": "

Provides information about a REST API in version 1 of Amazon API Gateway.

" + } + }, + "AwsCloudTrailTrail": { + "target": "com.amazonaws.securityhub#AwsCloudTrailTrailDetails", + "traits": { + "smithy.api#documentation": "

Provides details about a CloudTrail trail.

" + } + }, + "AwsSsmPatchCompliance": { + "target": "com.amazonaws.securityhub#AwsSsmPatchComplianceDetails", + "traits": { + "smithy.api#documentation": "

Provides information about the state of a patch on an instance based on the patch baseline that was used to patch the instance.

" + } + }, + "AwsCertificateManagerCertificate": { + "target": "com.amazonaws.securityhub#AwsCertificateManagerCertificateDetails", + "traits": { + "smithy.api#documentation": "

Provides details about an Certificate Manager certificate.

" + } + }, + "AwsRedshiftCluster": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterDetails", + "traits": { + "smithy.api#documentation": "

Contains details about an Amazon Redshift cluster.

" + } + }, + "AwsElbLoadBalancer": { + "target": "com.amazonaws.securityhub#AwsElbLoadBalancerDetails", + "traits": { + "smithy.api#documentation": "

Contains details about a Classic Load Balancer.

" + } + }, + "AwsIamGroup": { + "target": "com.amazonaws.securityhub#AwsIamGroupDetails", + "traits": { + "smithy.api#documentation": "

Contains details about an IAM group.

" + } + }, + "AwsIamRole": { + "target": "com.amazonaws.securityhub#AwsIamRoleDetails", + "traits": { + "smithy.api#documentation": "

Details about an IAM role.

" + } + }, + "AwsKmsKey": { + "target": "com.amazonaws.securityhub#AwsKmsKeyDetails", + "traits": { + "smithy.api#documentation": "

Details about an KMS key.

" + } + }, + "AwsLambdaFunction": { + "target": "com.amazonaws.securityhub#AwsLambdaFunctionDetails", + "traits": { + "smithy.api#documentation": "

Details about a Lambda function.

" + } + }, + "AwsLambdaLayerVersion": { + "target": "com.amazonaws.securityhub#AwsLambdaLayerVersionDetails", + "traits": { + "smithy.api#documentation": "

Details for a Lambda layer version.

" + } + }, + "AwsRdsDbInstance": { + "target": "com.amazonaws.securityhub#AwsRdsDbInstanceDetails", + "traits": { + "smithy.api#documentation": "

Details about an Amazon RDS database instance.

" + } + }, + "AwsSnsTopic": { + "target": "com.amazonaws.securityhub#AwsSnsTopicDetails", + "traits": { + "smithy.api#documentation": "

Details about an SNS topic.

" + } + }, + "AwsSqsQueue": { + "target": "com.amazonaws.securityhub#AwsSqsQueueDetails", + "traits": { + "smithy.api#documentation": "

Details about an SQS queue.

" + } + }, + "AwsWafWebAcl": { + "target": "com.amazonaws.securityhub#AwsWafWebAclDetails", + "traits": { + "smithy.api#documentation": "

Details for an WAF web ACL.

" + } + }, + "AwsRdsDbSnapshot": { + "target": "com.amazonaws.securityhub#AwsRdsDbSnapshotDetails", + "traits": { + "smithy.api#documentation": "

Details about an Amazon RDS database snapshot.

" + } + }, + "AwsRdsDbClusterSnapshot": { + "target": "com.amazonaws.securityhub#AwsRdsDbClusterSnapshotDetails", + "traits": { + "smithy.api#documentation": "

Details about an Amazon RDS database cluster snapshot.

" + } + }, + "AwsRdsDbCluster": { + "target": "com.amazonaws.securityhub#AwsRdsDbClusterDetails", + "traits": { + "smithy.api#documentation": "

Details about an Amazon RDS database cluster.

" + } + }, + "AwsEcsCluster": { + "target": "com.amazonaws.securityhub#AwsEcsClusterDetails", + "traits": { + "smithy.api#documentation": "

Details about an Amazon ECS cluster.

" + } + }, + "AwsEcsContainer": { + "target": "com.amazonaws.securityhub#AwsEcsContainerDetails", + "traits": { + "smithy.api#documentation": "

Provides information about a Docker container that's part of a task.\n

" + } + }, + "AwsEcsTaskDefinition": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionDetails", + "traits": { + "smithy.api#documentation": "

Details about a task definition. A task definition describes the container and volume definitions of an Amazon Elastic Container Service task.

" + } + }, + "Container": { + "target": "com.amazonaws.securityhub#ContainerDetails", + "traits": { + "smithy.api#documentation": "

Details about a container resource related to a finding.

" + } + }, + "Other": { + "target": "com.amazonaws.securityhub#FieldMap", + "traits": { + "smithy.api#documentation": "

Details about a resource that are not available in a type-specific details object. Use\n the Other object in the following cases.

\n " + } + }, + "AwsRdsEventSubscription": { + "target": "com.amazonaws.securityhub#AwsRdsEventSubscriptionDetails", + "traits": { + "smithy.api#documentation": "

Details about an RDS event notification subscription.

" + } + }, + "AwsEcsService": { + "target": "com.amazonaws.securityhub#AwsEcsServiceDetails", + "traits": { + "smithy.api#documentation": "

Details about a service within an ECS cluster.

" + } + }, + "AwsAutoScalingLaunchConfiguration": { + "target": "com.amazonaws.securityhub#AwsAutoScalingLaunchConfigurationDetails", + "traits": { + "smithy.api#documentation": "

Provides details about a launch configuration.

" + } + }, + "AwsEc2VpnConnection": { + "target": "com.amazonaws.securityhub#AwsEc2VpnConnectionDetails", + "traits": { + "smithy.api#documentation": "

Details about an Amazon EC2 VPN connection.

" + } + }, + "AwsEcrContainerImage": { + "target": "com.amazonaws.securityhub#AwsEcrContainerImageDetails", + "traits": { + "smithy.api#documentation": "

Information about an Amazon ECR image.

" + } + }, + "AwsOpenSearchServiceDomain": { + "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainDetails", + "traits": { + "smithy.api#documentation": "

Details about an Amazon OpenSearch Service domain.

" + } + }, + "AwsEc2VpcEndpointService": { + "target": "com.amazonaws.securityhub#AwsEc2VpcEndpointServiceDetails", + "traits": { + "smithy.api#documentation": "

Details about the service configuration for a VPC endpoint service.

" + } + }, + "AwsXrayEncryptionConfig": { + "target": "com.amazonaws.securityhub#AwsXrayEncryptionConfigDetails", + "traits": { + "smithy.api#documentation": "

Information about the encryption configuration for X-Ray.

" + } + }, + "AwsWafRateBasedRule": { + "target": "com.amazonaws.securityhub#AwsWafRateBasedRuleDetails", + "traits": { + "smithy.api#documentation": "

Details about a rate-based rule for global resources.

" + } + }, + "AwsWafRegionalRateBasedRule": { + "target": "com.amazonaws.securityhub#AwsWafRegionalRateBasedRuleDetails", + "traits": { + "smithy.api#documentation": "

Details about a rate-based rule for Regional resources.

" + } + }, + "AwsEcrRepository": { + "target": "com.amazonaws.securityhub#AwsEcrRepositoryDetails", + "traits": { + "smithy.api#documentation": "

Information about an Amazon Elastic Container Registry repository.

" + } + }, + "AwsEksCluster": { + "target": "com.amazonaws.securityhub#AwsEksClusterDetails", + "traits": { + "smithy.api#documentation": "

Details about an Amazon EKS cluster.

" + } + }, + "AwsNetworkFirewallFirewallPolicy": { + "target": "com.amazonaws.securityhub#AwsNetworkFirewallFirewallPolicyDetails", + "traits": { + "smithy.api#documentation": "

Details about an Network Firewall firewall policy.

" + } + }, + "AwsNetworkFirewallFirewall": { + "target": "com.amazonaws.securityhub#AwsNetworkFirewallFirewallDetails", + "traits": { + "smithy.api#documentation": "

Details about an Network Firewall firewall.

" + } + }, + "AwsNetworkFirewallRuleGroup": { + "target": "com.amazonaws.securityhub#AwsNetworkFirewallRuleGroupDetails", + "traits": { + "smithy.api#documentation": "

Details about an Network Firewall rule group.

" + } + }, + "AwsRdsDbSecurityGroup": { + "target": "com.amazonaws.securityhub#AwsRdsDbSecurityGroupDetails", + "traits": { + "smithy.api#documentation": "

Details about an Amazon RDS DB security group.

" + } + }, + "AwsKinesisStream": { + "target": "com.amazonaws.securityhub#AwsKinesisStreamDetails", + "traits": { + "smithy.api#documentation": "

Details about an Amazon Kinesis data stream.

" + } + }, + "AwsEc2TransitGateway": { + "target": "com.amazonaws.securityhub#AwsEc2TransitGatewayDetails", + "traits": { + "smithy.api#documentation": "

Details about an Amazon EC2 transit gateway that interconnects your virtual private clouds (VPC) and on-premises networks.

" + } + }, + "AwsEfsAccessPoint": { + "target": "com.amazonaws.securityhub#AwsEfsAccessPointDetails", + "traits": { + "smithy.api#documentation": "

Details about an Amazon EFS access point. An access point is an application-specific view into an EFS file system that \napplies an operating system user and group, and a file system path, to any file system request made through the access point. \n

" + } + }, + "AwsCloudFormationStack": { + "target": "com.amazonaws.securityhub#AwsCloudFormationStackDetails", + "traits": { + "smithy.api#documentation": "

Details about an CloudFormation stack. A stack is a collection of Amazon Web Services resources that you can manage as a single unit.

" + } + }, + "AwsCloudWatchAlarm": { + "target": "com.amazonaws.securityhub#AwsCloudWatchAlarmDetails", + "traits": { + "smithy.api#documentation": "

Details about an Amazon CloudWatch alarm. An alarm allows you to monitor and receive alerts about your Amazon Web Services resources and applications across multiple Regions.

" + } + }, + "AwsEc2VpcPeeringConnection": { + "target": "com.amazonaws.securityhub#AwsEc2VpcPeeringConnectionDetails", + "traits": { + "smithy.api#documentation": "

Details about an Amazon EC2 VPC peering connection. A VPC peering connection is\n a networking connection between two VPCs that enables you to route traffic between them\n privately.\n

" + } + }, + "AwsWafRegionalRuleGroup": { + "target": "com.amazonaws.securityhub#AwsWafRegionalRuleGroupDetails", + "traits": { + "smithy.api#documentation": "

Details about an WAF rule group for Regional resources.\n

" + } + }, + "AwsWafRegionalRule": { + "target": "com.amazonaws.securityhub#AwsWafRegionalRuleDetails", + "traits": { + "smithy.api#documentation": "

Details about an WAF rule for Regional resources.\n

" + } + }, + "AwsWafRegionalWebAcl": { + "target": "com.amazonaws.securityhub#AwsWafRegionalWebAclDetails", + "traits": { + "smithy.api#documentation": "

Details about an WAF web access control list (web ACL) for Regional resources.

" + } + }, + "AwsWafRule": { + "target": "com.amazonaws.securityhub#AwsWafRuleDetails", + "traits": { + "smithy.api#documentation": "

Details about an WAF rule for global resources.\n

" + } + }, + "AwsWafRuleGroup": { + "target": "com.amazonaws.securityhub#AwsWafRuleGroupDetails", + "traits": { + "smithy.api#documentation": "

Details about an WAF rule group for global resources.\n

" + } + }, + "AwsEcsTask": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDetails", + "traits": { + "smithy.api#documentation": "

Details about a task in a cluster.

" + } + }, + "AwsBackupBackupVault": { + "target": "com.amazonaws.securityhub#AwsBackupBackupVaultDetails", + "traits": { + "smithy.api#documentation": "

Provides details about an Backup backup vault.\n

" + } + }, + "AwsBackupBackupPlan": { + "target": "com.amazonaws.securityhub#AwsBackupBackupPlanDetails", + "traits": { + "smithy.api#documentation": "

Provides details about an Backup backup plan.\n

" + } + }, + "AwsBackupRecoveryPoint": { + "target": "com.amazonaws.securityhub#AwsBackupRecoveryPointDetails", + "traits": { + "smithy.api#documentation": "

Provides details about an Backup backup, or recovery point.\n

" + } + }, + "AwsEc2LaunchTemplate": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDetails" + }, + "AwsSageMakerNotebookInstance": { + "target": "com.amazonaws.securityhub#AwsSageMakerNotebookInstanceDetails" + }, + "AwsWafv2WebAcl": { + "target": "com.amazonaws.securityhub#AwsWafv2WebAclDetails" + }, + "AwsWafv2RuleGroup": { + "target": "com.amazonaws.securityhub#AwsWafv2RuleGroupDetails" + }, + "AwsEc2RouteTable": { + "target": "com.amazonaws.securityhub#AwsEc2RouteTableDetails", + "traits": { + "smithy.api#documentation": "

\n Provides details about a route table. A route table contains a set of rules, called routes, that \n determine where to direct network traffic from your subnet or gateway. \n

" + } + }, + "AwsAmazonMqBroker": { + "target": "com.amazonaws.securityhub#AwsAmazonMqBrokerDetails", + "traits": { + "smithy.api#documentation": "

\n Provides details about AppSync message broker. A message broker allows software applications and \n components to communicate using various programming languages, operating systems, and formal messaging protocols. \n

" + } + }, + "AwsAppSyncGraphQlApi": { + "target": "com.amazonaws.securityhub#AwsAppSyncGraphQlApiDetails", + "traits": { + "smithy.api#documentation": "

\n Provides details about an AppSync Graph QL API, which lets you query multiple databases, microservices, \n and APIs from a single GraphQL endpoint.\n

" + } + }, + "AwsEventSchemasRegistry": { + "target": "com.amazonaws.securityhub#AwsEventSchemasRegistryDetails", + "traits": { + "smithy.api#documentation": "

\n A schema defines the structure of events that are sent to Amazon EventBridge. Schema registries are containers for \n schemas. They collect and organize schemas so that your schemas are in logical groups. \n

" + } + }, + "AwsGuardDutyDetector": { + "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDetails", + "traits": { + "smithy.api#documentation": "

\n Provides details about an Amazon GuardDuty detector. A detector is an object that represents the GuardDuty \n service. A detector is required for GuardDuty to become operational.\n

" + } + }, + "AwsStepFunctionStateMachine": { + "target": "com.amazonaws.securityhub#AwsStepFunctionStateMachineDetails", + "traits": { + "smithy.api#documentation": "

\n Provides details about an Step Functions state machine, which is a workflow consisting of a series of event-driven steps.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Additional details about a resource related to a finding.

\n

To provide the details, use the object that corresponds to the resource type. For\n example, if the resource type is AwsEc2Instance, then you use the\n AwsEc2Instance object to provide the details.

\n

If the type-specific object does not contain all of the fields you want to populate,\n then you use the Other object to populate those additional fields.

\n

You also use the Other object to populate the details when the selected\n type does not have a corresponding object.

" + } + }, + "com.amazonaws.securityhub#ResourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#Resource" + } + }, + "com.amazonaws.securityhub#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.securityhub#NonEmptyString" + }, + "Code": { + "target": "com.amazonaws.securityhub#NonEmptyString" + } + }, + "traits": { + "smithy.api#documentation": "

The request was rejected because we can't find the specified resource.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.securityhub#Result": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.securityhub#AccountId", + "traits": { + "smithy.api#documentation": "

An Amazon Web Services account ID of the account that was not processed.

" + } + }, + "ProcessingResult": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The reason that the account was not processed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the account that was not processed.

" + } + }, + "com.amazonaws.securityhub#ResultList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#Result" + } + }, + "com.amazonaws.securityhub#RouteSetDetails": { + "type": "structure", + "members": { + "CarrierGatewayId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of the carrier gateway.\n

" + } + }, + "CoreNetworkArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the core network.\n

" + } + }, + "DestinationCidrBlock": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The IPv4 CIDR block used for the destination match.\n

" + } + }, + "DestinationIpv6CidrBlock": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The IPv6 CIDR block used for the destination match.\n

" + } + }, + "DestinationPrefixListId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The prefix of the destination Amazon Web Service.\n

" + } + }, + "EgressOnlyInternetGatewayId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of the egress-only internet gateway.\n

" + } + }, + "GatewayId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of a gateway attached to your VPC.\n

" + } + }, + "InstanceId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of a NAT instance in your VPC.\n

" + } + }, + "InstanceOwnerId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of the Amazon Web Services account that owns the instance.\n

" + } + }, + "LocalGatewayId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of the local gateway.\n

" + } + }, + "NatGatewayId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of a NAT gateway.\n

" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of the network interface.\n

" + } + }, + "Origin": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Describes how the route was created. \n

" + } + }, + "State": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The state of the route.\n

" + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of a transit gateway.\n

" + } + }, + "VpcPeeringConnectionId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of a VPC peering connection.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides details about the routes in the route table.\n

" + } + }, + "com.amazonaws.securityhub#RouteSetList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#RouteSetDetails" + } + }, + "com.amazonaws.securityhub#RuleGroupDetails": { + "type": "structure", + "members": { + "RuleVariables": { + "target": "com.amazonaws.securityhub#RuleGroupVariables", + "traits": { + "smithy.api#documentation": "

Additional settings to use in the specified rules.

" + } + }, + "RulesSource": { + "target": "com.amazonaws.securityhub#RuleGroupSource", + "traits": { + "smithy.api#documentation": "

The rules and actions for the rule group.

\n

For stateful rule groups, can contain RulesString, RulesSourceList, or StatefulRules.

\n

For stateless rule groups, contains StatelessRulesAndCustomActions.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the rule group.

" + } + }, + "com.amazonaws.securityhub#RuleGroupSource": { + "type": "structure", + "members": { + "RulesSourceList": { + "target": "com.amazonaws.securityhub#RuleGroupSourceListDetails", + "traits": { + "smithy.api#documentation": "

Stateful inspection criteria for a domain list rule group. A domain list rule group determines access by specific protocols to specific domains.

" + } + }, + "RulesString": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Stateful inspection criteria, provided in Suricata compatible intrusion prevention system (IPS) rules.

" + } + }, + "StatefulRules": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesList", + "traits": { + "smithy.api#documentation": "

Suricata rule specifications.

" + } + }, + "StatelessRulesAndCustomActions": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRulesAndCustomActionsDetails", + "traits": { + "smithy.api#documentation": "

The stateless rules and custom actions used by a stateless rule group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The rules and actions for the rule group.

" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceCustomActionsDetails": { + "type": "structure", + "members": { + "ActionDefinition": { + "target": "com.amazonaws.securityhub#StatelessCustomActionDefinition", + "traits": { + "smithy.api#documentation": "

The definition of a custom action.

" + } + }, + "ActionName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A descriptive name of the custom action.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A custom action definition. A custom action is an optional, non-standard action to use for stateless packet handling.

" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceCustomActionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#RuleGroupSourceCustomActionsDetails" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceListDetails": { + "type": "structure", + "members": { + "GeneratedRulesType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates whether to allow or deny access to the domains listed in Targets.

" + } + }, + "TargetTypes": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The protocols that you want to inspect. Specify LS_SNI for HTTPS. Specify HTTP_HOST for HTTP. You can specify either or both.

" + } + }, + "Targets": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The domains that you want to inspect for in your traffic flows. You can provide full domain names, or use the '.' prefix as a wildcard. For example, .example.com matches all domains that end with example.com.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Stateful inspection criteria for a domain list rule group.

" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesDetails": { + "type": "structure", + "members": { + "Action": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria.

" + } + }, + "Header": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesHeaderDetails", + "traits": { + "smithy.api#documentation": "

The stateful inspection criteria for the rule.

" + } + }, + "RuleOptions": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesOptionsList", + "traits": { + "smithy.api#documentation": "

Additional options for the rule.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A Suricata rule specification.

" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesHeaderDetails": { + "type": "structure", + "members": { + "Destination": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The destination IP address or address range to inspect for, in CIDR notation. To match with any address, specify ANY.

" + } + }, + "DestinationPort": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The destination port to inspect for. You can specify an individual port, such as 1994. You also can specify a port range, such as 1990:1994. To match with any port, specify ANY.

" + } + }, + "Direction": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The direction of traffic flow to inspect. If set to ANY, the inspection matches bidirectional traffic, both from the source to the destination and from the destination to the source. If set to FORWARD, the inspection only matches traffic going from the source to the destination.

" + } + }, + "Protocol": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The protocol to inspect for. To inspector for all protocols, use IP.

" + } + }, + "Source": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The source IP address or address range to inspect for, in CIDR notation. To match with any address, specify ANY.

" + } + }, + "SourcePort": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The source port to inspect for. You can specify an individual port, such as 1994. You also can specify a port range, such as 1990:1994. To match with any port, specify ANY.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The inspection criteria for a stateful rule.

" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesDetails" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesOptionsDetails": { + "type": "structure", + "members": { + "Keyword": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A keyword to look for.

" + } + }, + "Settings": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesRuleOptionsSettingsList", + "traits": { + "smithy.api#documentation": "

A list of settings.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A rule option for a stateful rule.

" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesOptionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesOptionsDetails" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesRuleOptionsSettingsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#NonEmptyString" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleDefinition": { + "type": "structure", + "members": { + "Actions": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The actions to take on a packet that matches one of the stateless rule definition's match attributes. You must specify a standard action (aws:pass, aws:drop, or aws:forward_to_sfe). You can then add custom actions.

" + } + }, + "MatchAttributes": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributes", + "traits": { + "smithy.api#documentation": "

The criteria for Network Firewall to use to inspect an individual packet in a stateless rule inspection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition of the stateless rule.

" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributes": { + "type": "structure", + "members": { + "DestinationPorts": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesDestinationPortsList", + "traits": { + "smithy.api#documentation": "

A list of port ranges to specify the destination ports to inspect for.

" + } + }, + "Destinations": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesDestinationsList", + "traits": { + "smithy.api#documentation": "

The destination IP addresses and address ranges to inspect for, in CIDR notation.

" + } + }, + "Protocols": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesProtocolsList", + "traits": { + "smithy.api#documentation": "

The protocols to inspect for.

" + } + }, + "SourcePorts": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesSourcePortsList", + "traits": { + "smithy.api#documentation": "

A list of port ranges to specify the source ports to inspect for.

" + } + }, + "Sources": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesSourcesList", + "traits": { + "smithy.api#documentation": "

The source IP addresses and address ranges to inspect for, in CIDR notation.

" + } + }, + "TcpFlags": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesTcpFlagsList", + "traits": { + "smithy.api#documentation": "

The TCP flags and masks to inspect for.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Criteria for the stateless rule.

" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesDestinationPorts": { + "type": "structure", + "members": { + "FromPort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The starting port value for the port range.

" + } + }, + "ToPort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The ending port value for the port range.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A port range to specify the destination ports to inspect for.

" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesDestinationPortsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesDestinationPorts" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesDestinations": { + "type": "structure", + "members": { + "AddressDefinition": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

An IP address or a block of IP addresses.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A destination IP address or range.

" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesDestinationsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesDestinations" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesProtocolsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#Integer" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesSourcePorts": { + "type": "structure", + "members": { + "FromPort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The starting port value for the port range.

" + } + }, + "ToPort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The ending port value for the port range.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A port range to specify the source ports to inspect for.

" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesSourcePortsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesSourcePorts" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesSources": { + "type": "structure", + "members": { + "AddressDefinition": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

An IP address or a block of IP addresses.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A source IP addresses and address range to inspect for.

" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesSourcesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesSources" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesTcpFlags": { + "type": "structure", + "members": { + "Flags": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

Defines the flags from the Masks setting that must be set in order for the packet to match. Flags that are listed must be set. Flags that are not listed must not be set.

" + } + }, + "Masks": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The set of flags to consider in the inspection. If not specified, then all flags are inspected.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A set of TCP flags and masks to inspect for.

" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesTcpFlagsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesTcpFlags" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRulesAndCustomActionsDetails": { + "type": "structure", + "members": { + "CustomActions": { + "target": "com.amazonaws.securityhub#RuleGroupSourceCustomActionsList", + "traits": { + "smithy.api#documentation": "

Custom actions for the rule group.

" + } + }, + "StatelessRules": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRulesList", + "traits": { + "smithy.api#documentation": "

Stateless rules for the rule group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Stateless rules and custom actions for a stateless rule group.

" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRulesDetails": { + "type": "structure", + "members": { + "Priority": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Indicates the order in which to run this rule relative to all of the rules in the stateless rule group.

" + } + }, + "RuleDefinition": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleDefinition", + "traits": { + "smithy.api#documentation": "

Provides the definition of the stateless rule.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A stateless rule in the rule group.

" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRulesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRulesDetails" + } + }, + "com.amazonaws.securityhub#RuleGroupVariables": { + "type": "structure", + "members": { + "IpSets": { + "target": "com.amazonaws.securityhub#RuleGroupVariablesIpSetsDetails", + "traits": { + "smithy.api#documentation": "

A list of IP addresses and address ranges, in CIDR notation.

" + } + }, + "PortSets": { + "target": "com.amazonaws.securityhub#RuleGroupVariablesPortSetsDetails", + "traits": { + "smithy.api#documentation": "

A list of port ranges.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Additional settings to use in the specified rules.

" + } + }, + "com.amazonaws.securityhub#RuleGroupVariablesIpSetsDetails": { + "type": "structure", + "members": { + "Definition": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The list of IP addresses and ranges.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of IP addresses and address ranges, in CIDR notation.

" + } + }, + "com.amazonaws.securityhub#RuleGroupVariablesPortSetsDetails": { + "type": "structure", + "members": { + "Definition": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The list of port ranges.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of port ranges.

" + } + }, + "com.amazonaws.securityhub#RuleOrderValue": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.securityhub#RuleStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.securityhub#SecurityControl": { + "type": "structure", + "members": { + "SecurityControlId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Service name and a \n number, such as APIGateway.3.\n

", + "smithy.api#required": {} + } + }, + "SecurityControlArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for a security control across standards, such as\n arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1. This\n parameter doesn't mention a specific standard.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The title of a security control.\n

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description of a security control across standards. This typically summarizes how\n Security Hub evaluates the control and the conditions under which it produces a\n failed finding. This parameter doesn't reference a specific standard.

", + "smithy.api#required": {} + } + }, + "RemediationUrl": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n A link to Security Hub documentation that explains how to remediate a failed finding for a security control.\n

", + "smithy.api#required": {} + } + }, + "SeverityRating": { + "target": "com.amazonaws.securityhub#SeverityRating", + "traits": { + "smithy.api#documentation": "

\n The severity of a security control. For more information about how Security Hub determines control severity, see \n Assigning severity to control findings in the \n Security Hub User Guide.\n

", + "smithy.api#required": {} + } + }, + "SecurityControlStatus": { + "target": "com.amazonaws.securityhub#ControlStatus", + "traits": { + "smithy.api#documentation": "

\n The status of a security control based on the compliance status of its findings. For more information about how control \n status is determined, see Determining the overall status of a control from its findings in the \n Security Hub User Guide.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n A security control in Security Hub describes a security best practice related to a specific resource. \n

" + } + }, + "com.amazonaws.securityhub#SecurityControlDefinition": { + "type": "structure", + "members": { + "SecurityControlId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of a security control across standards. Values for this field typically consist of an \n Amazon Web Service name and a number (for example, APIGateway.3). This parameter differs from \n SecurityControlArn, which is a unique Amazon Resource Name (ARN) assigned to a control. The \n ARN references the security control ID (for example, arn:aws:securityhub:eu-central-1:123456789012:security-control/APIGateway.3).\n

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The title of a security control.\n

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description of a security control across standards. This typically summarizes how\n Security Hub evaluates the control and the conditions under which it produces a\n failed finding. This parameter doesn't reference a specific standard.

", + "smithy.api#required": {} + } + }, + "RemediationUrl": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n A link to Security Hub documentation that explains how to remediate a failed finding for a security control.\n

", + "smithy.api#required": {} + } + }, + "SeverityRating": { + "target": "com.amazonaws.securityhub#SeverityRating", + "traits": { + "smithy.api#documentation": "

\n The severity of a security control. For more information about how Security Hub determines control severity, \n see Assigning severity to control findings in the \n Security Hub User Guide.\n

", + "smithy.api#required": {} + } + }, + "CurrentRegionAvailability": { + "target": "com.amazonaws.securityhub#RegionAvailabilityStatus", + "traits": { + "smithy.api#documentation": "

\n Specifies whether a security control is available in the current Amazon Web Services Region.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides metadata for a security control, including its unique standard-agnostic identifier, title, description, \n severity, availability in Amazon Web Services Regions, and a link to remediation steps.\n

" + } + }, + "com.amazonaws.securityhub#SecurityControlDefinitions": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#SecurityControlDefinition" + } + }, + "com.amazonaws.securityhub#SecurityControls": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#SecurityControl" + } + }, + "com.amazonaws.securityhub#SecurityGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#NonEmptyString" + } + }, + "com.amazonaws.securityhub#SecurityHubAPIService": { + "type": "service", + "version": "2018-10-26", + "operations": [ + { + "target": "com.amazonaws.securityhub#AcceptAdministratorInvitation" + }, + { + "target": "com.amazonaws.securityhub#AcceptInvitation" + }, + { + "target": "com.amazonaws.securityhub#BatchDeleteAutomationRules" + }, + { + "target": "com.amazonaws.securityhub#BatchDisableStandards" + }, + { + "target": "com.amazonaws.securityhub#BatchEnableStandards" + }, + { + "target": "com.amazonaws.securityhub#BatchGetAutomationRules" + }, + { + "target": "com.amazonaws.securityhub#BatchGetSecurityControls" + }, + { + "target": "com.amazonaws.securityhub#BatchGetStandardsControlAssociations" + }, + { + "target": "com.amazonaws.securityhub#BatchImportFindings" + }, + { + "target": "com.amazonaws.securityhub#BatchUpdateAutomationRules" + }, + { + "target": "com.amazonaws.securityhub#BatchUpdateFindings" + }, + { + "target": "com.amazonaws.securityhub#BatchUpdateStandardsControlAssociations" + }, + { + "target": "com.amazonaws.securityhub#CreateActionTarget" + }, + { + "target": "com.amazonaws.securityhub#CreateAutomationRule" + }, + { + "target": "com.amazonaws.securityhub#CreateFindingAggregator" + }, + { + "target": "com.amazonaws.securityhub#CreateInsight" + }, + { + "target": "com.amazonaws.securityhub#CreateMembers" + }, + { + "target": "com.amazonaws.securityhub#DeclineInvitations" + }, + { + "target": "com.amazonaws.securityhub#DeleteActionTarget" + }, + { + "target": "com.amazonaws.securityhub#DeleteFindingAggregator" + }, + { + "target": "com.amazonaws.securityhub#DeleteInsight" + }, + { + "target": "com.amazonaws.securityhub#DeleteInvitations" + }, + { + "target": "com.amazonaws.securityhub#DeleteMembers" + }, + { + "target": "com.amazonaws.securityhub#DescribeActionTargets" + }, + { + "target": "com.amazonaws.securityhub#DescribeHub" + }, + { + "target": "com.amazonaws.securityhub#DescribeOrganizationConfiguration" + }, + { + "target": "com.amazonaws.securityhub#DescribeProducts" + }, + { + "target": "com.amazonaws.securityhub#DescribeStandards" + }, + { + "target": "com.amazonaws.securityhub#DescribeStandardsControls" + }, + { + "target": "com.amazonaws.securityhub#DisableImportFindingsForProduct" + }, + { + "target": "com.amazonaws.securityhub#DisableOrganizationAdminAccount" + }, + { + "target": "com.amazonaws.securityhub#DisableSecurityHub" + }, + { + "target": "com.amazonaws.securityhub#DisassociateFromAdministratorAccount" + }, + { + "target": "com.amazonaws.securityhub#DisassociateFromMasterAccount" + }, + { + "target": "com.amazonaws.securityhub#DisassociateMembers" + }, + { + "target": "com.amazonaws.securityhub#EnableImportFindingsForProduct" + }, + { + "target": "com.amazonaws.securityhub#EnableOrganizationAdminAccount" + }, + { + "target": "com.amazonaws.securityhub#EnableSecurityHub" + }, + { + "target": "com.amazonaws.securityhub#GetAdministratorAccount" + }, + { + "target": "com.amazonaws.securityhub#GetEnabledStandards" + }, + { + "target": "com.amazonaws.securityhub#GetFindingAggregator" + }, + { + "target": "com.amazonaws.securityhub#GetFindingHistory" + }, + { + "target": "com.amazonaws.securityhub#GetFindings" + }, + { + "target": "com.amazonaws.securityhub#GetInsightResults" + }, + { + "target": "com.amazonaws.securityhub#GetInsights" + }, + { + "target": "com.amazonaws.securityhub#GetInvitationsCount" + }, + { + "target": "com.amazonaws.securityhub#GetMasterAccount" + }, + { + "target": "com.amazonaws.securityhub#GetMembers" + }, + { + "target": "com.amazonaws.securityhub#InviteMembers" + }, + { + "target": "com.amazonaws.securityhub#ListAutomationRules" + }, + { + "target": "com.amazonaws.securityhub#ListEnabledProductsForImport" + }, + { + "target": "com.amazonaws.securityhub#ListFindingAggregators" + }, + { + "target": "com.amazonaws.securityhub#ListInvitations" + }, + { + "target": "com.amazonaws.securityhub#ListMembers" + }, + { + "target": "com.amazonaws.securityhub#ListOrganizationAdminAccounts" + }, + { + "target": "com.amazonaws.securityhub#ListSecurityControlDefinitions" + }, + { + "target": "com.amazonaws.securityhub#ListStandardsControlAssociations" + }, + { + "target": "com.amazonaws.securityhub#ListTagsForResource" + }, + { + "target": "com.amazonaws.securityhub#TagResource" + }, + { + "target": "com.amazonaws.securityhub#UntagResource" + }, + { + "target": "com.amazonaws.securityhub#UpdateActionTarget" + }, + { + "target": "com.amazonaws.securityhub#UpdateFindingAggregator" + }, + { + "target": "com.amazonaws.securityhub#UpdateFindings" + }, + { + "target": "com.amazonaws.securityhub#UpdateInsight" + }, + { + "target": "com.amazonaws.securityhub#UpdateOrganizationConfiguration" + }, + { + "target": "com.amazonaws.securityhub#UpdateSecurityHubConfiguration" + }, + { + "target": "com.amazonaws.securityhub#UpdateStandardsControl" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "SecurityHub", + "arnNamespace": "securityhub", + "cloudFormationName": "SecurityHub", + "cloudTrailEventSource": "securityhub.amazonaws.com", + "endpointPrefix": "securityhub" + }, + "aws.auth#sigv4": { + "name": "securityhub" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

Security Hub provides you with a comprehensive view of the security state of\n your Amazon Web Services environment and resources. It also provides you with the readiness\n status of your environment based on controls from supported security standards. Security Hub collects security data from Amazon Web Services accounts, services, and\n integrated third-party products and helps you analyze security trends in your environment\n to identify the highest priority security issues. For more information about Security Hub, see the Security HubUser\n Guide.

\n

When you use operations in the Security Hub API, the requests are executed only in\n the Amazon Web Services Region that is currently active or in the specific Amazon Web Services Region that you specify in your request. Any configuration or settings change\n that results from the operation is applied only to that Region. To make the same change in\n other Regions, run the same command for each Region in which you want to apply the change.

\n

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\n the member account with the administrator account is created only in the us-west-2\n Region. Security Hub must be enabled for the member account in the same Region that the invitation\n was sent from.

\n

The following throttling limits apply to using Security Hub API operations.

\n ", + "smithy.api#title": "AWS SecurityHub", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://securityhub-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://securityhub-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://securityhub.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://securityhub.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://securityhub.af-south-1.amazonaws.com" + } + }, + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://securityhub.ap-east-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://securityhub.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://securityhub.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://securityhub.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://securityhub.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://securityhub.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://securityhub.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://securityhub.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://securityhub.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://securityhub.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://securityhub.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://securityhub.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://securityhub.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://securityhub.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://securityhub.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://securityhub.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://securityhub.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://securityhub.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://securityhub-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://securityhub.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://securityhub-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://securityhub.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://securityhub-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://securityhub.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://securityhub-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://securityhub-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://securityhub.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://securityhub.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://securityhub.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://securityhub-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://securityhub-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://securityhub.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://securityhub.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://securityhub-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://securityhub.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://securityhub-fips.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://securityhub-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://securityhub.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://securityhub-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://securityhub.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://securityhub-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://securityhub.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.securityhub#SensitiveDataDetections": { + "type": "structure", + "members": { + "Count": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of occurrences of sensitive data that were detected.

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of sensitive data that was detected. For example, the type might indicate that the data is an email address.

" + } + }, + "Occurrences": { + "target": "com.amazonaws.securityhub#Occurrences", + "traits": { + "smithy.api#documentation": "

Details about the sensitive data that was detected.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The list of detected instances of sensitive data.

" + } + }, + "com.amazonaws.securityhub#SensitiveDataDetectionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#SensitiveDataDetections" + } + }, + "com.amazonaws.securityhub#SensitiveDataResult": { + "type": "structure", + "members": { + "Category": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The category of sensitive data that was detected. For example, the category can indicate that the sensitive data involved credentials, financial information, or personal information.

" + } + }, + "Detections": { + "target": "com.amazonaws.securityhub#SensitiveDataDetectionsList", + "traits": { + "smithy.api#documentation": "

The list of detected instances of sensitive data.

" + } + }, + "TotalCount": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of occurrences of sensitive data.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains a detected instance of sensitive data that are based on built-in identifiers.

" + } + }, + "com.amazonaws.securityhub#SensitiveDataResultList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#SensitiveDataResult" + } + }, + "com.amazonaws.securityhub#Severity": { + "type": "structure", + "members": { + "Product": { + "target": "com.amazonaws.securityhub#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Deprecated. This attribute is being deprecated. Instead of providing\n Product, provide Original.

\n

The native severity as defined by the Amazon Web Services service or integrated partner product that\n generated the finding.

" + } + }, + "Label": { + "target": "com.amazonaws.securityhub#SeverityLabel", + "traits": { + "smithy.api#documentation": "

The severity value of the finding. The allowed values are the following.

\n \n

If you provide Normalized and do not provide Label, then\n Label is set automatically as follows.

\n " + } + }, + "Normalized": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Deprecated. The normalized severity of a finding. This attribute is being deprecated.\n Instead of providing Normalized, provide Label.

\n

If you provide Label and do not provide Normalized, then\n Normalized is set automatically as follows.

\n " + } + }, + "Original": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The native severity from the finding product that generated the finding.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The severity of the finding.

\n

The finding provider can provide the initial severity. The finding provider can only\n update the severity if it hasn't been updated using\n BatchUpdateFindings.

\n

The finding must have either Label or Normalized populated. If\n only one of these attributes is populated, then Security Hub automatically populates the other\n one. If neither attribute is populated, then the finding is invalid. Label is\n the preferred attribute.

" + } + }, + "com.amazonaws.securityhub#SeverityLabel": { + "type": "enum", + "members": { + "INFORMATIONAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFORMATIONAL" + } + }, + "LOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOW" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM" + } + }, + "HIGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIGH" + } + }, + "CRITICAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CRITICAL" + } + } + } + }, + "com.amazonaws.securityhub#SeverityRating": { + "type": "enum", + "members": { + "LOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOW" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM" + } + }, + "HIGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIGH" + } + }, + "CRITICAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CRITICAL" + } + } + } + }, + "com.amazonaws.securityhub#SeverityUpdate": { + "type": "structure", + "members": { + "Normalized": { + "target": "com.amazonaws.securityhub#RatioScale", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The normalized severity for the finding. This attribute is to be deprecated in favor of\n Label.

\n

If you provide Normalized and do not provide Label,\n Label is set automatically as follows.

\n " + } + }, + "Product": { + "target": "com.amazonaws.securityhub#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The native severity as defined by the Amazon Web Services service or integrated partner product that\n generated the finding.

" + } + }, + "Label": { + "target": "com.amazonaws.securityhub#SeverityLabel", + "traits": { + "smithy.api#documentation": "

The severity value of the finding. The allowed values are the following.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Updates to the severity information for a finding.

" + } + }, + "com.amazonaws.securityhub#SizeBytes": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.securityhub#SoftwarePackage": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the software package.

" + } + }, + "Version": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The version of the software package.

" + } + }, + "Epoch": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The epoch of the software package.

" + } + }, + "Release": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The release of the software package.

" + } + }, + "Architecture": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The architecture used for the software package.

" + } + }, + "PackageManager": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The source of the package.

" + } + }, + "FilePath": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The file system path to the package manager inventory file.

" + } + }, + "FixedInVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The version of the software package in which the vulnerability has been resolved.\n

" + } + }, + "Remediation": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Describes the actions a customer can take to resolve the vulnerability in the software package.\n

" + } + }, + "SourceLayerHash": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The source layer hash of the vulnerable package.\n

" + } + }, + "SourceLayerArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source layer.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a software package.

" + } + }, + "com.amazonaws.securityhub#SoftwarePackageList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#SoftwarePackage" + } + }, + "com.amazonaws.securityhub#SortCriteria": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#SortCriterion" + } + }, + "com.amazonaws.securityhub#SortCriterion": { + "type": "structure", + "members": { + "Field": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The finding attribute used to sort findings.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.securityhub#SortOrder", + "traits": { + "smithy.api#documentation": "

The order used to sort findings.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A collection of finding attributes used to sort findings.

" + } + }, + "com.amazonaws.securityhub#SortOrder": { + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "asc" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "desc" + } + } + } + }, + "com.amazonaws.securityhub#Standard": { + "type": "structure", + "members": { + "StandardsArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of a standard.

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the standard.

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A description of the standard.

" + } + }, + "EnabledByDefault": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the standard is enabled by default. When Security Hub is enabled from the console, if a\n standard is enabled by default, the check box for that standard is selected by\n default.

\n

When Security Hub is enabled using the EnableSecurityHub API operation, the\n standard is enabled by default unless EnableDefaultStandards is set to\n false.

" + } + }, + "StandardsManagedBy": { + "target": "com.amazonaws.securityhub#StandardsManagedBy", + "traits": { + "smithy.api#documentation": "

Provides details about the management of a standard.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about a specific security standard.

" + } + }, + "com.amazonaws.securityhub#Standards": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#Standard" + } + }, + "com.amazonaws.securityhub#StandardsControl": { + "type": "structure", + "members": { + "StandardsControlArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the security standard control.

" + } + }, + "ControlStatus": { + "target": "com.amazonaws.securityhub#ControlStatus", + "traits": { + "smithy.api#documentation": "

The current status of the security standard control. Indicates whether the control is\n enabled or disabled. Security Hub does not check against disabled controls.

" + } + }, + "DisabledReason": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The reason provided for the most recent change in status for the control.

" + } + }, + "ControlStatusUpdatedAt": { + "target": "com.amazonaws.securityhub#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the status of the security standard control was most recently\n updated.

" + } + }, + "ControlId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the security standard control.

" + } + }, + "Title": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The title of the security standard control.

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The longer description of the security standard control. Provides information about what\n the control is checking for.

" + } + }, + "RemediationUrl": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A link to remediation information for the control in the Security Hub user\n documentation.

" + } + }, + "SeverityRating": { + "target": "com.amazonaws.securityhub#SeverityRating", + "traits": { + "smithy.api#documentation": "

The severity of findings generated from this security standard control.

\n

The finding severity is based on an assessment of how easy it would be to compromise Amazon Web Services\n resources if the issue is detected.

" + } + }, + "RelatedRequirements": { + "target": "com.amazonaws.securityhub#RelatedRequirementsList", + "traits": { + "smithy.api#documentation": "

The list of requirements that are related to this control.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details for an individual security standard control.

" + } + }, + "com.amazonaws.securityhub#StandardsControlArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#NonEmptyString" + } + }, + "com.amazonaws.securityhub#StandardsControlAssociationDetail": { + "type": "structure", + "members": { + "StandardsArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of a security standard.\n

", + "smithy.api#required": {} + } + }, + "SecurityControlId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Service \n name and a number, such as APIGateway.3.\n

", + "smithy.api#required": {} + } + }, + "SecurityControlArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of a security control across standards, such as\n arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1. This\n parameter doesn't mention a specific standard.

", + "smithy.api#required": {} + } + }, + "AssociationStatus": { + "target": "com.amazonaws.securityhub#AssociationStatus", + "traits": { + "smithy.api#documentation": "

\n Specifies whether a control is enabled or disabled in a specified standard.\n

", + "smithy.api#required": {} + } + }, + "RelatedRequirements": { + "target": "com.amazonaws.securityhub#RelatedRequirementsList", + "traits": { + "smithy.api#documentation": "

\n The requirement that underlies a control in the compliance framework related to the standard.\n

" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.securityhub#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The time at which the enablement status of the control in the specified standard was last updated.\n

" + } + }, + "UpdatedReason": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The reason for updating the enablement status of a control in a specified standard.\n

" + } + }, + "StandardsControlTitle": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The title of a control. This field may reference a specific standard.\n

" + } + }, + "StandardsControlDescription": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The description of a control. This typically summarizes how Security Hub evaluates the control and the \n conditions under which it produces a failed finding. This parameter may reference a specific standard. \n

" + } + }, + "StandardsControlArns": { + "target": "com.amazonaws.securityhub#StandardsControlArnList", + "traits": { + "smithy.api#documentation": "

Provides the input parameter that Security Hub uses to call the UpdateStandardsControl API. This API can be used to enable or disable a control\n in a specified standard.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about a control's enablement status in a specified standard.

" + } + }, + "com.amazonaws.securityhub#StandardsControlAssociationDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#StandardsControlAssociationDetail" + } + }, + "com.amazonaws.securityhub#StandardsControlAssociationId": { + "type": "structure", + "members": { + "SecurityControlId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The unique identifier (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters) of a security \n control across standards.\n

", + "smithy.api#required": {} + } + }, + "StandardsArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ARN of a standard.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n An array with one or more objects that includes a security control (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters) \n and the Amazon Resource Name (ARN) of a standard. The security control ID or ARN is the same across standards.\n

" + } + }, + "com.amazonaws.securityhub#StandardsControlAssociationIds": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#StandardsControlAssociationId" + } + }, + "com.amazonaws.securityhub#StandardsControlAssociationSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#StandardsControlAssociationSummary" + } + }, + "com.amazonaws.securityhub#StandardsControlAssociationSummary": { + "type": "structure", + "members": { + "StandardsArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of a standard.\n

", + "smithy.api#required": {} + } + }, + "SecurityControlId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n A unique standard-agnostic identifier for a control. Values for this field typically consist of an \n Amazon Web Service and a number, such as APIGateway.5. This field doesn't reference a specific standard.\n

", + "smithy.api#required": {} + } + }, + "SecurityControlArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of a control, such as\n arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1. This\n parameter doesn't mention a specific standard.

", + "smithy.api#required": {} + } + }, + "AssociationStatus": { + "target": "com.amazonaws.securityhub#AssociationStatus", + "traits": { + "smithy.api#documentation": "

\n The enablement status of a control in a specific standard.\n

", + "smithy.api#required": {} + } + }, + "RelatedRequirements": { + "target": "com.amazonaws.securityhub#RelatedRequirementsList", + "traits": { + "smithy.api#documentation": "

\n The requirement that underlies this control in the compliance framework related to the standard.\n

" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.securityhub#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time that a control's enablement status in a specified standard was updated.

" + } + }, + "UpdatedReason": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The reason for updating the control's enablement status in a specified standard.

" + } + }, + "StandardsControlTitle": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The title of a control. \n

" + } + }, + "StandardsControlDescription": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The description of a control. This typically summarizes how Security Hub evaluates the control and the \n conditions under which it produces a failed finding. The parameter may reference a specific standard.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An array that provides the enablement status and other details for each control that\n applies to each enabled standard.

" + } + }, + "com.amazonaws.securityhub#StandardsControlAssociationUpdate": { + "type": "structure", + "members": { + "StandardsArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the standard in which you want to update the\n control's enablement status.

", + "smithy.api#required": {} + } + }, + "SecurityControlId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The unique identifier for the security control whose enablement status you want to update.

", + "smithy.api#required": {} + } + }, + "AssociationStatus": { + "target": "com.amazonaws.securityhub#AssociationStatus", + "traits": { + "smithy.api#documentation": "

The desired enablement status of the control in the standard.

", + "smithy.api#required": {} + } + }, + "UpdatedReason": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The reason for updating the control's enablement status in the standard.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An array of requested updates to the enablement status of controls in specified\n standards. The objects in the array include a security control ID, the Amazon Resource Name (ARN) of the standard, the requested\n enablement status, and the reason for updating the enablement status.

" + } + }, + "com.amazonaws.securityhub#StandardsControlAssociationUpdates": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#StandardsControlAssociationUpdate" + } + }, + "com.amazonaws.securityhub#StandardsControls": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#StandardsControl" + } + }, + "com.amazonaws.securityhub#StandardsInputParameterMap": { + "type": "map", + "key": { + "target": "com.amazonaws.securityhub#NonEmptyString" + }, + "value": { + "target": "com.amazonaws.securityhub#NonEmptyString" + } + }, + "com.amazonaws.securityhub#StandardsManagedBy": { + "type": "structure", + "members": { + "Company": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

An identifier for the company that manages a specific security standard. For existing\n standards, the value is equal to Amazon Web Services.

" + } + }, + "Product": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

An identifier for the product that manages a specific security standard. For existing\n standards, the value is equal to the Amazon Web Services service that manages the\n standard.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about the management of a security standard.

" + } + }, + "com.amazonaws.securityhub#StandardsStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "INCOMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCOMPLETE" + } + } + } + }, + "com.amazonaws.securityhub#StandardsStatusReason": { + "type": "structure", + "members": { + "StatusReasonCode": { + "target": "com.amazonaws.securityhub#StatusReasonCode", + "traits": { + "smithy.api#documentation": "

The reason code that represents the reason for the current status of a standard subscription.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The reason for the current status of a standard subscription.

" + } + }, + "com.amazonaws.securityhub#StandardsSubscription": { + "type": "structure", + "members": { + "StandardsSubscriptionArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of a resource that represents your subscription to a supported standard.

", + "smithy.api#required": {} + } + }, + "StandardsArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of a standard.

", + "smithy.api#required": {} + } + }, + "StandardsInput": { + "target": "com.amazonaws.securityhub#StandardsInputParameterMap", + "traits": { + "smithy.api#documentation": "

A key-value pair of input for the standard.

", + "smithy.api#required": {} + } + }, + "StandardsStatus": { + "target": "com.amazonaws.securityhub#StandardsStatus", + "traits": { + "smithy.api#documentation": "

The status of the standard subscription.

\n

The status values are as follows:

\n ", + "smithy.api#required": {} + } + }, + "StandardsStatusReason": { + "target": "com.amazonaws.securityhub#StandardsStatusReason", + "traits": { + "smithy.api#documentation": "

The reason for the current status.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A resource that represents your subscription to a supported standard.

" + } + }, + "com.amazonaws.securityhub#StandardsSubscriptionArns": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#NonEmptyString" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.securityhub#StandardsSubscriptionRequest": { + "type": "structure", + "members": { + "StandardsArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the standard that you want to enable. To view the list of available standards\n and their ARNs, use the DescribeStandards operation.

", + "smithy.api#required": {} + } + }, + "StandardsInput": { + "target": "com.amazonaws.securityhub#StandardsInputParameterMap", + "traits": { + "smithy.api#documentation": "

A key-value pair of input for the standard.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The standard that you want to enable.

" + } + }, + "com.amazonaws.securityhub#StandardsSubscriptionRequests": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#StandardsSubscriptionRequest" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.securityhub#StandardsSubscriptions": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#StandardsSubscription" + } + }, + "com.amazonaws.securityhub#StatelessCustomActionDefinition": { + "type": "structure", + "members": { + "PublishMetricAction": { + "target": "com.amazonaws.securityhub#StatelessCustomPublishMetricAction", + "traits": { + "smithy.api#documentation": "

Information about metrics to publish to CloudWatch.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition of a custom action that can be used for stateless packet handling.

" + } + }, + "com.amazonaws.securityhub#StatelessCustomPublishMetricAction": { + "type": "structure", + "members": { + "Dimensions": { + "target": "com.amazonaws.securityhub#StatelessCustomPublishMetricActionDimensionsList", + "traits": { + "smithy.api#documentation": "

Defines CloudWatch dimension values to publish.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about metrics to publish to CloudWatch.

" + } + }, + "com.amazonaws.securityhub#StatelessCustomPublishMetricActionDimension": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The value to use for the custom metric dimension.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines a CloudWatch dimension value to publish.

" + } + }, + "com.amazonaws.securityhub#StatelessCustomPublishMetricActionDimensionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#StatelessCustomPublishMetricActionDimension" + } + }, + "com.amazonaws.securityhub#StatusReason": { + "type": "structure", + "members": { + "ReasonCode": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A code that represents a reason for the control status. For the list of status reason\n codes and their meanings, see Standards-related information in the ASFF in the\n Security Hub User Guide.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The corresponding description for the status reason code.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides additional context for the value of Compliance.Status.

" + } + }, + "com.amazonaws.securityhub#StatusReasonCode": { + "type": "enum", + "members": { + "NO_AVAILABLE_CONFIGURATION_RECORDER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_AVAILABLE_CONFIGURATION_RECORDER" + } + }, + "INTERNAL_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_ERROR" + } + } + } + }, + "com.amazonaws.securityhub#StatusReasonsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#StatusReason" + } + }, + "com.amazonaws.securityhub#StringFilter": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The string filter value. Filter values are case sensitive. For example, the product name\n for control-based findings is Security Hub. If you provide security hub\n as the filter text, then there is no match.

" + } + }, + "Comparison": { + "target": "com.amazonaws.securityhub#StringFilterComparison", + "traits": { + "smithy.api#documentation": "

The condition to apply to a string value when querying for findings. To search for\n values that contain the filter criteria value, use one of the following comparison\n operators:

\n \n

\n EQUALS and PREFIX filters on the same field are joined by\n OR. A finding matches if it matches any one of those filters.

\n

To search for values that do not contain the filter criteria value, use one of the\n following comparison operators:

\n \n

\n NOT_EQUALS and PREFIX_NOT_EQUALS filters on the same field are\n joined by AND. A finding matches only if it matches all of those\n filters.

\n

For filters on the same field, you cannot provide both an EQUALS filter and\n a NOT_EQUALS or PREFIX_NOT_EQUALS filter. Combining filters in\n this way always returns an error, even if the provided filter values would return valid\n results.

\n

You can combine PREFIX filters with NOT_EQUALS or\n PREFIX_NOT_EQUALS filters for the same field. Security Hub first processes the\n PREFIX filters, then the NOT_EQUALS or\n PREFIX_NOT_EQUALS filters.

\n

For example, for the following filter, Security Hub first identifies findings that have\n resource types that start with either AwsIAM or AwsEc2. It then\n excludes findings that have a resource type of AwsIamPolicy and findings that\n have a resource type of AwsEc2NetworkInterface.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

A string filter for querying findings.

" + } }, - { - "target": "com.amazonaws.securityhub#AcceptInvitation" + "com.amazonaws.securityhub#StringFilterComparison": { + "type": "enum", + "members": { + "EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQUALS" + } + }, + "PREFIX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREFIX" + } + }, + "NOT_EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_EQUALS" + } + }, + "PREFIX_NOT_EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREFIX_NOT_EQUALS" + } + } + } }, - { - "target": "com.amazonaws.securityhub#BatchDisableStandards" + "com.amazonaws.securityhub#StringFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#StringFilter" + } }, - { - "target": "com.amazonaws.securityhub#BatchEnableStandards" + "com.amazonaws.securityhub#StringList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#NonEmptyString" + } }, - { - "target": "com.amazonaws.securityhub#BatchGetSecurityControls" + "com.amazonaws.securityhub#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" + } }, - { - "target": "com.amazonaws.securityhub#BatchGetStandardsControlAssociations" + "com.amazonaws.securityhub#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } }, - { - "target": "com.amazonaws.securityhub#BatchImportFindings" + "com.amazonaws.securityhub#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.securityhub#TagKey" + }, + "value": { + "target": "com.amazonaws.securityhub#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } }, - { - "target": "com.amazonaws.securityhub#BatchUpdateFindings" + "com.amazonaws.securityhub#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds one or more tags to a resource.

", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{ResourceArn}", + "code": 200 + } + } }, - { - "target": "com.amazonaws.securityhub#BatchUpdateStandardsControlAssociations" + "com.amazonaws.securityhub#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.securityhub#ResourceArn", + "traits": { + "smithy.api#documentation": "

The ARN of the resource to apply the tags to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.securityhub#TagMap", + "traits": { + "smithy.api#documentation": "

The tags to add to the resource. You can add up to 50 tags at a time. The tag keys can be no longer than 128 characters. The tag values can be no longer than 256 characters.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.securityhub#CreateActionTarget" + "com.amazonaws.securityhub#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.securityhub#CreateFindingAggregator" + "com.amazonaws.securityhub#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } }, - { - "target": "com.amazonaws.securityhub#CreateInsight" + "com.amazonaws.securityhub#Threat": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the threat.\n\t\t

" + } + }, + "Severity": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The severity of the threat. \n\t\t

" + } + }, + "ItemCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

This total number of items in which the threat has been detected.\n\t\t

" + } + }, + "FilePaths": { + "target": "com.amazonaws.securityhub#FilePathList", + "traits": { + "smithy.api#documentation": "

Provides information about the file paths that were affected by the threat.\n\t\t

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the threat detected in a security finding and the file paths that were affected by the threat.\n\t\t

" + } }, - { - "target": "com.amazonaws.securityhub#CreateMembers" + "com.amazonaws.securityhub#ThreatIntelIndicator": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.securityhub#ThreatIntelIndicatorType", + "traits": { + "smithy.api#documentation": "

The type of threat intelligence indicator.

" + } + }, + "Value": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The value of a threat intelligence indicator.

" + } + }, + "Category": { + "target": "com.amazonaws.securityhub#ThreatIntelIndicatorCategory", + "traits": { + "smithy.api#documentation": "

The category of a threat intelligence indicator.

" + } + }, + "LastObservedAt": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the most recent instance of a threat intelligence indicator was\n observed.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "Source": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The source of the threat intelligence indicator.

" + } + }, + "SourceUrl": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The URL to the page or site where you can get more information about the threat\n intelligence indicator.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the threat intelligence related to a finding.

" + } }, - { - "target": "com.amazonaws.securityhub#DeclineInvitations" + "com.amazonaws.securityhub#ThreatIntelIndicatorCategory": { + "type": "enum", + "members": { + "BACKDOOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BACKDOOR" + } + }, + "CARD_STEALER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CARD_STEALER" + } + }, + "COMMAND_AND_CONTROL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMMAND_AND_CONTROL" + } + }, + "DROP_SITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DROP_SITE" + } + }, + "EXPLOIT_SITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPLOIT_SITE" + } + }, + "KEYLOGGER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KEYLOGGER" + } + } + } }, - { - "target": "com.amazonaws.securityhub#DeleteActionTarget" + "com.amazonaws.securityhub#ThreatIntelIndicatorList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#ThreatIntelIndicator" + } }, - { - "target": "com.amazonaws.securityhub#DeleteFindingAggregator" + "com.amazonaws.securityhub#ThreatIntelIndicatorType": { + "type": "enum", + "members": { + "DOMAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN" + } + }, + "EMAIL_ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMAIL_ADDRESS" + } + }, + "HASH_MD5": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HASH_MD5" + } + }, + "HASH_SHA1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HASH_SHA1" + } + }, + "HASH_SHA256": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HASH_SHA256" + } + }, + "HASH_SHA512": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HASH_SHA512" + } + }, + "IPV4_ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IPV4_ADDRESS" + } + }, + "IPV6_ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IPV6_ADDRESS" + } + }, + "MUTEX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MUTEX" + } + }, + "PROCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROCESS" + } + }, + "URL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "URL" + } + } + } }, - { - "target": "com.amazonaws.securityhub#DeleteInsight" + "com.amazonaws.securityhub#ThreatList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#Threat" + } }, - { - "target": "com.amazonaws.securityhub#DeleteInvitations" + "com.amazonaws.securityhub#Timestamp": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } }, - { - "target": "com.amazonaws.securityhub#DeleteMembers" + "com.amazonaws.securityhub#TypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#NonEmptyString" + } }, - { - "target": "com.amazonaws.securityhub#DescribeActionTargets" + "com.amazonaws.securityhub#UnprocessedAutomationRule": { + "type": "structure", + "members": { + "RuleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) for the unprocessed automation rule.\n

" + } + }, + "ErrorCode": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The error code associated with the unprocessed automation rule.\n

" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n An error message describing why a request didn't process a specific rule.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n A list of objects containing RuleArn, ErrorCode, and ErrorMessage. This parameter \n tells you which automation rules the request didn't process and why.\n

" + } }, - { - "target": "com.amazonaws.securityhub#DescribeHub" + "com.amazonaws.securityhub#UnprocessedAutomationRulesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#UnprocessedAutomationRule" + } }, - { - "target": "com.amazonaws.securityhub#DescribeOrganizationConfiguration" + "com.amazonaws.securityhub#UnprocessedErrorCode": { + "type": "enum", + "members": { + "INVALID_INPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_INPUT" + } + }, + "ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCESS_DENIED" + } + }, + "NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_FOUND" + } + }, + "LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LIMIT_EXCEEDED" + } + } + } }, - { - "target": "com.amazonaws.securityhub#DescribeProducts" + "com.amazonaws.securityhub#UnprocessedSecurityControl": { + "type": "structure", + "members": { + "SecurityControlId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The control (identified with SecurityControlId,\n SecurityControlArn, or a mix of both parameters) for which a response\n couldn't be returned.

", + "smithy.api#required": {} + } + }, + "ErrorCode": { + "target": "com.amazonaws.securityhub#UnprocessedErrorCode", + "traits": { + "smithy.api#documentation": "

\n The error code for the unprocessed security control.\n

", + "smithy.api#required": {} + } + }, + "ErrorReason": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The reason why the security control was unprocessed.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about a security control for which a response couldn't be returned.

" + } }, - { - "target": "com.amazonaws.securityhub#DescribeStandards" + "com.amazonaws.securityhub#UnprocessedSecurityControls": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#UnprocessedSecurityControl" + } }, - { - "target": "com.amazonaws.securityhub#DescribeStandardsControls" + "com.amazonaws.securityhub#UnprocessedStandardsControlAssociation": { + "type": "structure", + "members": { + "StandardsControlAssociationId": { + "target": "com.amazonaws.securityhub#StandardsControlAssociationId", + "traits": { + "smithy.api#documentation": "

An array with one or more objects that includes a security control (identified with\n SecurityControlId, SecurityControlArn, or a mix of both\n parameters) and the Amazon Resource Name (ARN) of a standard. This parameter shows the\n specific controls for which the enablement status couldn't be retrieved in specified standards when\n calling BatchUpdateStandardsControlAssociations.

", + "smithy.api#required": {} + } + }, + "ErrorCode": { + "target": "com.amazonaws.securityhub#UnprocessedErrorCode", + "traits": { + "smithy.api#documentation": "

The error code for the unprocessed standard and control association.\n

", + "smithy.api#required": {} + } + }, + "ErrorReason": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The reason why the standard and control association was unprocessed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about which\n control's enablement status couldn't be retrieved in a specified standard when calling BatchUpdateStandardsControlAssociations. This parameter also provides details\n about why the request was unprocessed.

" + } }, - { - "target": "com.amazonaws.securityhub#DisableImportFindingsForProduct" + "com.amazonaws.securityhub#UnprocessedStandardsControlAssociationUpdate": { + "type": "structure", + "members": { + "StandardsControlAssociationUpdate": { + "target": "com.amazonaws.securityhub#StandardsControlAssociationUpdate", + "traits": { + "smithy.api#documentation": "

An array of control and standard associations for which an update failed when calling \n BatchUpdateStandardsControlAssociations.\n

", + "smithy.api#required": {} + } + }, + "ErrorCode": { + "target": "com.amazonaws.securityhub#UnprocessedErrorCode", + "traits": { + "smithy.api#documentation": "

The error code for the unprocessed update of the control's enablement status in the\n specified standard.

", + "smithy.api#required": {} + } + }, + "ErrorReason": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The reason why a control's enablement status in the specified standard couldn't be updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about which control's enablement status could not be updated in a\n specified standard when calling the BatchUpdateStandardsControlAssociations API. This parameter also provides\n details about why the request was unprocessed.

" + } }, - { - "target": "com.amazonaws.securityhub#DisableOrganizationAdminAccount" + "com.amazonaws.securityhub#UnprocessedStandardsControlAssociationUpdates": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#UnprocessedStandardsControlAssociationUpdate" + } }, - { - "target": "com.amazonaws.securityhub#DisableSecurityHub" + "com.amazonaws.securityhub#UnprocessedStandardsControlAssociations": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#UnprocessedStandardsControlAssociation" + } }, - { - "target": "com.amazonaws.securityhub#DisassociateFromAdministratorAccount" + "com.amazonaws.securityhub#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes one or more tags from a resource.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{ResourceArn}", + "code": 200 + } + } }, - { - "target": "com.amazonaws.securityhub#DisassociateFromMasterAccount" + "com.amazonaws.securityhub#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.securityhub#ResourceArn", + "traits": { + "smithy.api#documentation": "

The ARN of the resource to remove the tags from.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.securityhub#TagKeyList", + "traits": { + "smithy.api#documentation": "

The tag keys associated with the tags to remove from the resource. You can remove up to 50 tags at a time.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.securityhub#DisassociateMembers" + "com.amazonaws.securityhub#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.securityhub#EnableImportFindingsForProduct" + "com.amazonaws.securityhub#UpdateActionTarget": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#UpdateActionTargetRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#UpdateActionTargetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the name and description of a custom action target in Security Hub.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/actionTargets/{ActionTargetArn+}", + "code": 200 + } + } }, - { - "target": "com.amazonaws.securityhub#EnableOrganizationAdminAccount" + "com.amazonaws.securityhub#UpdateActionTargetRequest": { + "type": "structure", + "members": { + "ActionTargetArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the custom action target to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The updated name of the custom action target.

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The updated description for the custom action target.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.securityhub#EnableSecurityHub" + "com.amazonaws.securityhub#UpdateActionTargetResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.securityhub#GetAdministratorAccount" + "com.amazonaws.securityhub#UpdateAutomationRulesRequestItem": { + "type": "structure", + "members": { + "RuleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) for the rule.\n

", + "smithy.api#required": {} + } + }, + "RuleStatus": { + "target": "com.amazonaws.securityhub#RuleStatus", + "traits": { + "smithy.api#documentation": "

\n Whether the rule is active after it is created. If \n this parameter is equal to ENABLED, Security Hub will apply the rule to findings \n and finding updates after the rule is created. To change the value of this\n parameter after creating a rule, use BatchUpdateAutomationRules.\n

" + } + }, + "RuleOrder": { + "target": "com.amazonaws.securityhub#RuleOrderValue", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

An integer ranging from 1 to 1000 that represents the order in which the rule action is\n applied to findings. Security Hub applies rules with lower values for this parameter\n first.

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n A description of the rule.\n

" + } + }, + "RuleName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The name of the rule.\n

" + } + }, + "IsTerminal": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful \n when a finding matches the criteria for multiple rules, and each rule has different actions. If the value of this \n field is set to true for a rule, Security Hub applies the rule action to a finding that matches \n the rule criteria and won't evaluate other rules for the finding.\u2028 The default value of this field is false.\n

" + } + }, + "Criteria": { + "target": "com.amazonaws.securityhub#AutomationRulesFindingFilters", + "traits": { + "smithy.api#documentation": "

\n A set of ASFF finding field attributes and corresponding expected values that \n Security Hub uses to filter findings. If a finding matches the conditions specified in\n this parameter, Security Hub applies the rule action to the finding.\n

" + } + }, + "Actions": { + "target": "com.amazonaws.securityhub#ActionList", + "traits": { + "smithy.api#documentation": "

\n One or more actions to update finding fields if a finding matches the conditions \n specified in Criteria.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Specifies the parameters to update in an existing automation rule.\n

" + } }, - { - "target": "com.amazonaws.securityhub#GetEnabledStandards" + "com.amazonaws.securityhub#UpdateAutomationRulesRequestItemsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#UpdateAutomationRulesRequestItem" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } }, - { - "target": "com.amazonaws.securityhub#GetFindingAggregator" + "com.amazonaws.securityhub#UpdateFindingAggregator": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#UpdateFindingAggregatorRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#UpdateFindingAggregatorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#AccessDeniedException" + }, + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the finding aggregation configuration. Used to update the Region linking mode and the list of included or excluded Regions. You cannot use UpdateFindingAggregator to change the aggregation Region.

\n

You must run UpdateFindingAggregator from the current aggregation Region.\n

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/findingAggregator/update", + "code": 200 + } + } }, - { - "target": "com.amazonaws.securityhub#GetFindingHistory" + "com.amazonaws.securityhub#UpdateFindingAggregatorRequest": { + "type": "structure", + "members": { + "FindingAggregatorArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the finding aggregator. To obtain the ARN, use ListFindingAggregators.

", + "smithy.api#required": {} + } + }, + "RegionLinkingMode": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates whether to aggregate findings from all of the available Regions in the current partition. Also determines whether to automatically aggregate findings from new Regions as Security Hub supports them and you opt into them.

\n

The selected option also determines how to use the Regions provided in the Regions list.

\n

The options are as follows:

\n ", + "smithy.api#required": {} + } + }, + "Regions": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a space-separated list of Regions that do not aggregate findings to the aggregation Region.

\n

If RegionLinkingMode is SPECIFIED_REGIONS, then this is a space-separated list of Regions that do aggregate findings to the aggregation Region.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.securityhub#GetFindings" + "com.amazonaws.securityhub#UpdateFindingAggregatorResponse": { + "type": "structure", + "members": { + "FindingAggregatorArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the finding aggregator.

" + } + }, + "FindingAggregationRegion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The aggregation Region.

" + } + }, + "RegionLinkingMode": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.

" + } + }, + "Regions": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

The list of excluded Regions or included Regions.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.securityhub#GetInsightResults" + "com.amazonaws.securityhub#UpdateFindings": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#UpdateFindingsRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#UpdateFindingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

\n UpdateFindings is deprecated. Instead of UpdateFindings, use\n BatchUpdateFindings.

\n

Updates the Note and RecordState of the Security Hub-aggregated\n findings that the filter attributes specify. Any member account that can view the finding\n also sees the update to the finding.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/findings", + "code": 200 + } + } }, - { - "target": "com.amazonaws.securityhub#GetInsights" + "com.amazonaws.securityhub#UpdateFindingsRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.securityhub#AwsSecurityFindingFilters", + "traits": { + "smithy.api#documentation": "

A collection of attributes that specify which findings you want to update.

", + "smithy.api#required": {} + } + }, + "Note": { + "target": "com.amazonaws.securityhub#NoteUpdate", + "traits": { + "smithy.api#documentation": "

The updated note for the finding.

" + } + }, + "RecordState": { + "target": "com.amazonaws.securityhub#RecordState", + "traits": { + "smithy.api#documentation": "

The updated record state for the finding.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.securityhub#GetInvitationsCount" + "com.amazonaws.securityhub#UpdateFindingsResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.securityhub#GetMasterAccount" + "com.amazonaws.securityhub#UpdateInsight": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#UpdateInsightRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#UpdateInsightResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the Security Hub insight identified by the specified insight ARN.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/insights/{InsightArn+}", + "code": 200 + } + } }, - { - "target": "com.amazonaws.securityhub#GetMembers" + "com.amazonaws.securityhub#UpdateInsightRequest": { + "type": "structure", + "members": { + "InsightArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the insight that you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The updated name for the insight.

" + } + }, + "Filters": { + "target": "com.amazonaws.securityhub#AwsSecurityFindingFilters", + "traits": { + "smithy.api#documentation": "

The updated filters that define this insight.

" + } + }, + "GroupByAttribute": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The updated GroupBy attribute that defines this insight.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.securityhub#InviteMembers" + "com.amazonaws.securityhub#UpdateInsightResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.securityhub#ListEnabledProductsForImport" + "com.amazonaws.securityhub#UpdateOrganizationConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#UpdateOrganizationConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#UpdateOrganizationConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Used to update the configuration related to Organizations. Can only be called from a\n Security Hub administrator account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/organization/configuration", + "code": 200 + } + } }, - { - "target": "com.amazonaws.securityhub#ListFindingAggregators" + "com.amazonaws.securityhub#UpdateOrganizationConfigurationRequest": { + "type": "structure", + "members": { + "AutoEnable": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether to automatically enable Security Hub for new accounts in the organization.

\n

By default, this is false, and new accounts are not added\n automatically.

\n

To automatically enable Security Hub for new accounts, set this to true.

", + "smithy.api#required": {} + } + }, + "AutoEnableStandards": { + "target": "com.amazonaws.securityhub#AutoEnableStandards", + "traits": { + "smithy.api#documentation": "

Whether to automatically enable Security Hub default standards \n for new member accounts in the organization.

\n

By default, this parameter is equal to DEFAULT, and new member accounts are automatically enabled with default Security Hub standards.

\n

To opt out of enabling default standards for new member accounts, set this parameter equal to NONE.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.securityhub#ListInvitations" + "com.amazonaws.securityhub#UpdateOrganizationConfigurationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.securityhub#ListMembers" + "com.amazonaws.securityhub#UpdateSecurityHubConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#UpdateSecurityHubConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#UpdateSecurityHubConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates configuration options for Security Hub.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/accounts", + "code": 200 + } + } }, - { - "target": "com.amazonaws.securityhub#ListOrganizationAdminAccounts" + "com.amazonaws.securityhub#UpdateSecurityHubConfigurationRequest": { + "type": "structure", + "members": { + "AutoEnableControls": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether to automatically enable new controls when they are added to standards that are\n enabled.

\n

By default, this is set to true, and new controls are enabled\n automatically. To not automatically enable new controls, set this to false.\n

" + } + }, + "ControlFindingGenerator": { + "target": "com.amazonaws.securityhub#ControlFindingGenerator", + "traits": { + "smithy.api#documentation": "

Updates whether the calling account has consolidated control findings turned on. \n If the value for this field is set to \n SECURITY_CONTROL, Security Hub generates a single finding for a control check even when the check \n applies to multiple enabled standards.

\n

If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings \n for a control check when the check applies to multiple enabled standards.

\n

For accounts that are part of an organization, this value can only be updated in the administrator account.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.securityhub#ListSecurityControlDefinitions" + "com.amazonaws.securityhub#UpdateSecurityHubConfigurationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.securityhub#ListStandardsControlAssociations" + "com.amazonaws.securityhub#UpdateStandardsControl": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#UpdateStandardsControlRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#UpdateStandardsControlResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Used to control whether an individual security standard control is enabled or\n disabled.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/standards/control/{StandardsControlArn+}", + "code": 200 + } + } }, - { - "target": "com.amazonaws.securityhub#ListTagsForResource" + "com.amazonaws.securityhub#UpdateStandardsControlRequest": { + "type": "structure", + "members": { + "StandardsControlArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the security standard control to enable or disable.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ControlStatus": { + "target": "com.amazonaws.securityhub#ControlStatus", + "traits": { + "smithy.api#documentation": "

The updated status of the security standard control.

" + } + }, + "DisabledReason": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A description of the reason why you are disabling a security standard control. If you\n are disabling a control, then this is required.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.securityhub#TagResource" + "com.amazonaws.securityhub#UpdateStandardsControlResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.securityhub#UntagResource" + "com.amazonaws.securityhub#VerificationState": { + "type": "enum", + "members": { + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNKNOWN" + } + }, + "TRUE_POSITIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRUE_POSITIVE" + } + }, + "FALSE_POSITIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FALSE_POSITIVE" + } + }, + "BENIGN_POSITIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BENIGN_POSITIVE" + } + } + } }, - { - "target": "com.amazonaws.securityhub#UpdateActionTarget" + "com.amazonaws.securityhub#VolumeMount": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the volume.\n

" + } + }, + "MountPath": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The path in the container at which the volume should be mounted.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the mounting of a volume in a container.\n

" + } }, - { - "target": "com.amazonaws.securityhub#UpdateFindingAggregator" + "com.amazonaws.securityhub#VolumeMountList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#VolumeMount" + } }, - { - "target": "com.amazonaws.securityhub#UpdateFindings" + "com.amazonaws.securityhub#VpcInfoCidrBlockSetDetails": { + "type": "structure", + "members": { + "CidrBlock": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The IPv4 CIDR block for the VPC.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about the IPv4 CIDR blocks for the VPC.\n

" + } }, - { - "target": "com.amazonaws.securityhub#UpdateInsight" + "com.amazonaws.securityhub#VpcInfoCidrBlockSetList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#VpcInfoCidrBlockSetDetails" + } }, - { - "target": "com.amazonaws.securityhub#UpdateOrganizationConfiguration" + "com.amazonaws.securityhub#VpcInfoIpv6CidrBlockSetDetails": { + "type": "structure", + "members": { + "Ipv6CidrBlock": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The IPv6 CIDR block for the VPC.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about the IPv6 CIDR blocks for the VPC.\n

" + } }, - { - "target": "com.amazonaws.securityhub#UpdateSecurityHubConfiguration" + "com.amazonaws.securityhub#VpcInfoIpv6CidrBlockSetList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#VpcInfoIpv6CidrBlockSetDetails" + } }, - { - "target": "com.amazonaws.securityhub#UpdateStandardsControl" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "SecurityHub", - "arnNamespace": "securityhub", - "cloudFormationName": "SecurityHub", - "cloudTrailEventSource": "securityhub.amazonaws.com", - "endpointPrefix": "securityhub" - }, - "aws.auth#sigv4": { - "name": "securityhub" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

Security Hub provides you with a comprehensive view of the security state of\n your Amazon Web Services environment and resources. It also provides you with the readiness\n status of your environment based on controls from supported security standards. Security Hub collects security data from Amazon Web Services accounts, services, and\n integrated third-party products and helps you analyze security trends in your environment\n to identify the highest priority security issues. For more information about Security Hub, see the Security HubUser\n Guide.

\n

When you use operations in the Security Hub API, the requests are executed only in\n the Amazon Web Services Region that is currently active or in the specific Amazon Web Services Region that you specify in your request. Any configuration or settings change\n that results from the operation is applied only to that Region. To make the same change in\n other Regions, run the same command for each Region in which you want to apply the change.

\n

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\n the member account with the administrator account is created only in the us-west-2\n Region. Security Hub must be enabled for the member account in the same Region that the invitation\n was sent from.

\n

The following throttling limits apply to using Security Hub API operations.

\n ", - "smithy.api#title": "AWS SecurityHub", - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" + "com.amazonaws.securityhub#VpcInfoPeeringOptionsDetails": { + "type": "structure", + "members": { + "AllowDnsResolutionFromRemoteVpc": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.\n

" + } + }, + "AllowEgressFromLocalClassicLinkToRemoteVpc": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.\n

" + } + }, + "AllowEgressFromLocalVpcToRemoteClassicLink": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.\n

" } - ] } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] + }, + "traits": { + "smithy.api#documentation": "

Provides information about the VPC peering connection options for the accepter or requester VPC.\n

" + } + }, + "com.amazonaws.securityhub#Vulnerability": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the vulnerability.

", + "smithy.api#required": {} } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" }, - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "VulnerablePackages": { + "target": "com.amazonaws.securityhub#SoftwarePackageList", + "traits": { + "smithy.api#documentation": "

List of software packages that have the vulnerability.

" + } + }, + "Cvss": { + "target": "com.amazonaws.securityhub#CvssList", + "traits": { + "smithy.api#documentation": "

CVSS scores from the advisory related to the vulnerability.

" + } + }, + "RelatedVulnerabilities": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

List of vulnerabilities that are related to this vulnerability.

" + } + }, + "Vendor": { + "target": "com.amazonaws.securityhub#VulnerabilityVendor", + "traits": { + "smithy.api#documentation": "

Information about the vendor that generates the vulnerability report.

" + } + }, + "ReferenceUrls": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

A list of URLs that provide additional information about the vulnerability.

" + } + }, + "FixAvailable": { + "target": "com.amazonaws.securityhub#VulnerabilityFixAvailable", + "traits": { + "smithy.api#documentation": "

Specifies if all vulnerable packages in a finding have a value for FixedInVersion \nand Remediation.\nThis field is evaluated for each vulnerability Id based on the number of vulnerable packages that have a value for both \nFixedInVersion and Remediation. Valid values are as follows:

\n " } - ] } - ] }, - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] + "traits": { + "smithy.api#documentation": "

A vulnerability associated with a finding.

" + } + }, + "com.amazonaws.securityhub#VulnerabilityFixAvailable": { + "type": "enum", + "members": { + "YES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "YES" } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://securityhub-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://securityhub-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://securityhub.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ] - }, - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://securityhub.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] + }, + "NO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO" } - ] }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" + "PARTIAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARTIAL" + } } - ] } - ] }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://securityhub.af-south-1.amazonaws.com" - } - }, - "params": { - "Region": "af-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://securityhub.ap-east-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://securityhub.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://securityhub.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://securityhub.ap-northeast-3.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://securityhub.ap-south-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://securityhub.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://securityhub.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://securityhub.ap-southeast-3.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://securityhub.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://securityhub.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://securityhub.eu-north-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://securityhub.eu-south-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://securityhub.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://securityhub.eu-west-2.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://securityhub.eu-west-3.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://securityhub.me-south-1.amazonaws.com" - } - }, - "params": { - "Region": "me-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://securityhub.sa-east-1.amazonaws.com" - } - }, - "params": { - "Region": "sa-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://securityhub.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://securityhub-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://securityhub.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://securityhub-fips.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://securityhub.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://securityhub-fips.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://securityhub.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://securityhub-fips.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://securityhub-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://securityhub.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://securityhub.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://securityhub.cn-northwest-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-northwest-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://securityhub-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://securityhub-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://securityhub.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://securityhub.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://securityhub-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://securityhub.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://securityhub-fips.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://securityhub-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://securityhub.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://securityhub-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://securityhub.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://securityhub-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } + "com.amazonaws.securityhub#VulnerabilityList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#Vulnerability" + } + }, + "com.amazonaws.securityhub#VulnerabilityVendor": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the vendor.

", + "smithy.api#required": {} + } + }, + "Url": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The URL of the vulnerability advisory.

" + } + }, + "VendorSeverity": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The severity that the vendor assigned to the vulnerability.

" + } + }, + "VendorCreatedAt": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the vulnerability advisory was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "VendorUpdatedAt": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the vulnerability advisory was last updated.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + } + } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } + "traits": { + "smithy.api#documentation": "

A vendor that generates a vulnerability report.

" + } + }, + "com.amazonaws.securityhub#WafAction": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Specifies how you want WAF to respond to requests that match the settings in a\n rule.

\n

Valid settings include the following:

\n " + } + } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://securityhub.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } + "traits": { + "smithy.api#documentation": "

Details about the action that CloudFront or WAF takes when a web request matches the\n conditions in the rule.

" + } + }, + "com.amazonaws.securityhub#WafExcludedRule": { + "type": "structure", + "members": { + "RuleId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The unique identifier for the rule to exclude from the rule group.

" + } + } }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } + "traits": { + "smithy.api#documentation": "

Details about a rule to exclude from a rule group.

" + } + }, + "com.amazonaws.securityhub#WafExcludedRuleList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#WafExcludedRule" + } + }, + "com.amazonaws.securityhub#WafOverrideAction": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n COUNT overrides the action specified by the individual rule within a\n RuleGroup .

\n

If set to NONE, the rule's action takes place.

" + } + } }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } + "traits": { + "smithy.api#documentation": "

Details about an override action for a rule.

" + } + }, + "com.amazonaws.securityhub#Workflow": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.securityhub#WorkflowStatus", + "traits": { + "smithy.api#documentation": "

The status of the investigation into the finding. The workflow status is specific to an individual finding. It does not affect the generation of new findings. For example, setting the workflow status to SUPPRESSED or RESOLVED does not prevent a new finding for the same issue.

\n

The allowed values are the following.

\n " + } + } }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } + "traits": { + "smithy.api#documentation": "

Provides information about the status of the investigation into a finding.

" + } + }, + "com.amazonaws.securityhub#WorkflowState": { + "type": "enum", + "members": { + "NEW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEW" + } + }, + "ASSIGNED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASSIGNED" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "DEFERRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFERRED" + } + }, + "RESOLVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOLVED" + } + } }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } + "traits": { + "smithy.api#deprecated": { + "message": "This filter is deprecated. Instead, use SeverityLabel or FindingProviderFieldsSeverityLabel." + } + } + }, + "com.amazonaws.securityhub#WorkflowStatus": { + "type": "enum", + "members": { + "NEW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEW" + } + }, + "NOTIFIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOTIFIED" + } + }, + "RESOLVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOLVED" + } + }, + "SUPPRESSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUPPRESSED" + } + } + } + }, + "com.amazonaws.securityhub#WorkflowUpdate": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.securityhub#WorkflowStatus", + "traits": { + "smithy.api#documentation": "

The status of the investigation into the finding. The workflow status is specific to an individual finding. It does not affect the generation of new findings. For example, setting the workflow status to SUPPRESSED or RESOLVED does not prevent a new finding for the same issue.

\n

The allowed values are the following.

\n " + } + } }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } + "traits": { + "smithy.api#documentation": "

Used to update information about the investigation into the finding.

" } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.securityhub#SensitiveDataDetections": { - "type": "structure", - "members": { - "Count": { - "target": "com.amazonaws.securityhub#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The total number of occurrences of sensitive data that were detected.

" - } - }, - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of sensitive data that was detected. For example, the type might indicate that the data is an email address.

" - } - }, - "Occurrences": { - "target": "com.amazonaws.securityhub#Occurrences", - "traits": { - "smithy.api#documentation": "

Details about the sensitive data that was detected.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The list of detected instances of sensitive data.

" - } - }, - "com.amazonaws.securityhub#SensitiveDataDetectionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#SensitiveDataDetections" - } - }, - "com.amazonaws.securityhub#SensitiveDataResult": { - "type": "structure", - "members": { - "Category": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The category of sensitive data that was detected. For example, the category can indicate that the sensitive data involved credentials, financial information, or personal information.

" - } - }, - "Detections": { - "target": "com.amazonaws.securityhub#SensitiveDataDetectionsList", - "traits": { - "smithy.api#documentation": "

The list of detected instances of sensitive data.

" - } - }, - "TotalCount": { - "target": "com.amazonaws.securityhub#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The total number of occurrences of sensitive data.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains a detected instance of sensitive data that are based on built-in identifiers.

" - } - }, - "com.amazonaws.securityhub#SensitiveDataResultList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#SensitiveDataResult" - } - }, - "com.amazonaws.securityhub#Severity": { - "type": "structure", - "members": { - "Product": { - "target": "com.amazonaws.securityhub#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Deprecated. This attribute is being deprecated. Instead of providing\n Product, provide Original.

\n

The native severity as defined by the Amazon Web Services service or integrated partner product that\n generated the finding.

" - } - }, - "Label": { - "target": "com.amazonaws.securityhub#SeverityLabel", - "traits": { - "smithy.api#documentation": "

The severity value of the finding. The allowed values are the following.

\n \n

If you provide Normalized and do not provide Label, then\n Label is set automatically as follows.

\n " - } - }, - "Normalized": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Deprecated. The normalized severity of a finding. This attribute is being deprecated.\n Instead of providing Normalized, provide Label.

\n

If you provide Label and do not provide Normalized, then\n Normalized is set automatically as follows.

\n " - } - }, - "Original": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The native severity from the finding product that generated the finding.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The severity of the finding.

\n

The finding provider can provide the initial severity. The finding provider can only\n update the severity if it hasn't been updated using\n BatchUpdateFindings.

\n

The finding must have either Label or Normalized populated. If\n only one of these attributes is populated, then Security Hub automatically populates the other\n one. If neither attribute is populated, then the finding is invalid. Label is\n the preferred attribute.

" - } - }, - "com.amazonaws.securityhub#SeverityLabel": { - "type": "enum", - "members": { - "INFORMATIONAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INFORMATIONAL" - } - }, - "LOW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LOW" - } - }, - "MEDIUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MEDIUM" - } - }, - "HIGH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HIGH" - } - }, - "CRITICAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CRITICAL" - } - } - } - }, - "com.amazonaws.securityhub#SeverityRating": { - "type": "enum", - "members": { - "LOW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LOW" - } - }, - "MEDIUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MEDIUM" - } - }, - "HIGH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HIGH" - } - }, - "CRITICAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CRITICAL" - } - } - } - }, - "com.amazonaws.securityhub#SeverityUpdate": { - "type": "structure", - "members": { - "Normalized": { - "target": "com.amazonaws.securityhub#RatioScale", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The normalized severity for the finding. This attribute is to be deprecated in favor of\n Label.

\n

If you provide Normalized and do not provide Label,\n Label is set automatically as follows.

\n " - } - }, - "Product": { - "target": "com.amazonaws.securityhub#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The native severity as defined by the Amazon Web Services service or integrated partner product that\n generated the finding.

" - } - }, - "Label": { - "target": "com.amazonaws.securityhub#SeverityLabel", - "traits": { - "smithy.api#documentation": "

The severity value of the finding. The allowed values are the following.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Updates to the severity information for a finding.

" - } - }, - "com.amazonaws.securityhub#SizeBytes": { - "type": "long", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.securityhub#SoftwarePackage": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the software package.

" - } - }, - "Version": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The version of the software package.

" - } - }, - "Epoch": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The epoch of the software package.

" - } - }, - "Release": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The release of the software package.

" - } - }, - "Architecture": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The architecture used for the software package.

" - } - }, - "PackageManager": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The source of the package.

" - } - }, - "FilePath": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The file system path to the package manager inventory file.

" - } - }, - "FixedInVersion": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The version of the software package in which the vulnerability has been resolved.\n

" - } - }, - "Remediation": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Describes the actions a customer can take to resolve the vulnerability in the software package.\n

" - } - }, - "SourceLayerHash": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The source layer hash of the vulnerable package.\n

" - } - }, - "SourceLayerArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source layer.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a software package.

" - } - }, - "com.amazonaws.securityhub#SoftwarePackageList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#SoftwarePackage" - } - }, - "com.amazonaws.securityhub#SortCriteria": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#SortCriterion" - } - }, - "com.amazonaws.securityhub#SortCriterion": { - "type": "structure", - "members": { - "Field": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The finding attribute used to sort findings.

" - } - }, - "SortOrder": { - "target": "com.amazonaws.securityhub#SortOrder", - "traits": { - "smithy.api#documentation": "

The order used to sort findings.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A collection of finding attributes used to sort findings.

" - } - }, - "com.amazonaws.securityhub#SortOrder": { - "type": "enum", - "members": { - "ASCENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "asc" - } - }, - "DESCENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "desc" - } - } - } - }, - "com.amazonaws.securityhub#Standard": { - "type": "structure", - "members": { - "StandardsArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of a standard.

" - } - }, - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the standard.

" - } - }, - "Description": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A description of the standard.

" - } - }, - "EnabledByDefault": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the standard is enabled by default. When Security Hub is enabled from the console, if a\n standard is enabled by default, the check box for that standard is selected by\n default.

\n

When Security Hub is enabled using the EnableSecurityHub API operation, the\n standard is enabled by default unless EnableDefaultStandards is set to\n false.

" - } - }, - "StandardsManagedBy": { - "target": "com.amazonaws.securityhub#StandardsManagedBy", - "traits": { - "smithy.api#documentation": "

Provides details about the management of a standard.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about a specific security standard.

" - } - }, - "com.amazonaws.securityhub#Standards": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#Standard" - } - }, - "com.amazonaws.securityhub#StandardsControl": { - "type": "structure", - "members": { - "StandardsControlArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the security standard control.

" - } - }, - "ControlStatus": { - "target": "com.amazonaws.securityhub#ControlStatus", - "traits": { - "smithy.api#documentation": "

The current status of the security standard control. Indicates whether the control is\n enabled or disabled. Security Hub does not check against disabled controls.

" - } - }, - "DisabledReason": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The reason provided for the most recent change in status for the control.

" - } - }, - "ControlStatusUpdatedAt": { - "target": "com.amazonaws.securityhub#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that the status of the security standard control was most recently\n updated.

" - } - }, - "ControlId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the security standard control.

" - } - }, - "Title": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The title of the security standard control.

" - } - }, - "Description": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The longer description of the security standard control. Provides information about what\n the control is checking for.

" - } - }, - "RemediationUrl": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A link to remediation information for the control in the Security Hub user\n documentation.

" - } - }, - "SeverityRating": { - "target": "com.amazonaws.securityhub#SeverityRating", - "traits": { - "smithy.api#documentation": "

The severity of findings generated from this security standard control.

\n

The finding severity is based on an assessment of how easy it would be to compromise Amazon Web Services\n resources if the issue is detected.

" - } - }, - "RelatedRequirements": { - "target": "com.amazonaws.securityhub#RelatedRequirementsList", - "traits": { - "smithy.api#documentation": "

The list of requirements that are related to this control.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details for an individual security standard control.

" - } - }, - "com.amazonaws.securityhub#StandardsControlArnList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#NonEmptyString" - } - }, - "com.amazonaws.securityhub#StandardsControlAssociationDetail": { - "type": "structure", - "members": { - "StandardsArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of a security standard.\n

", - "smithy.api#required": {} - } - }, - "SecurityControlId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Service \n name and a number, such as APIGateway.3.\n

", - "smithy.api#required": {} - } - }, - "SecurityControlArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of a security control across standards, such as\n arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1. This\n parameter doesn't mention a specific standard.

", - "smithy.api#required": {} - } - }, - "AssociationStatus": { - "target": "com.amazonaws.securityhub#AssociationStatus", - "traits": { - "smithy.api#documentation": "

\n Specifies whether a control is enabled or disabled in a specified standard.\n

", - "smithy.api#required": {} - } - }, - "RelatedRequirements": { - "target": "com.amazonaws.securityhub#RelatedRequirementsList", - "traits": { - "smithy.api#documentation": "

\n The requirement that underlies a control in the compliance framework related to the standard.\n

" - } - }, - "UpdatedAt": { - "target": "com.amazonaws.securityhub#Timestamp", - "traits": { - "smithy.api#documentation": "

\n The time at which the enablement status of the control in the specified standard was last updated.\n

" - } - }, - "UpdatedReason": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The reason for updating the enablement status of a control in a specified standard.\n

" - } - }, - "StandardsControlTitle": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The title of a control. This field may reference a specific standard.\n

" - } - }, - "StandardsControlDescription": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The description of a control. This typically summarizes how Security Hub evaluates the control and the \n conditions under which it produces a failed finding. This parameter may reference a specific standard. \n

" - } - }, - "StandardsControlArns": { - "target": "com.amazonaws.securityhub#StandardsControlArnList", - "traits": { - "smithy.api#documentation": "

Provides the input parameter that Security Hub uses to call the UpdateStandardsControl API. This API can be used to enable or disable a control\n in a specified standard.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides details about a control's enablement status in a specified standard.

" - } - }, - "com.amazonaws.securityhub#StandardsControlAssociationDetails": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#StandardsControlAssociationDetail" - } - }, - "com.amazonaws.securityhub#StandardsControlAssociationId": { - "type": "structure", - "members": { - "SecurityControlId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The unique identifier (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters) of a security \n control across standards.\n

", - "smithy.api#required": {} - } - }, - "StandardsArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The ARN of a standard.\n

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

\n An array with one or more objects that includes a security control (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters) \n and the Amazon Resource Name (ARN) of a standard. The security control ID or ARN is the same across standards.\n

" - } - }, - "com.amazonaws.securityhub#StandardsControlAssociationIds": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#StandardsControlAssociationId" - } - }, - "com.amazonaws.securityhub#StandardsControlAssociationSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#StandardsControlAssociationSummary" - } - }, - "com.amazonaws.securityhub#StandardsControlAssociationSummary": { - "type": "structure", - "members": { - "StandardsArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of a standard.\n

", - "smithy.api#required": {} - } - }, - "SecurityControlId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n A unique standard-agnostic identifier for a control. Values for this field typically consist of an \n Amazon Web Service and a number, such as APIGateway.5. This field doesn't reference a specific standard.\n

", - "smithy.api#required": {} - } - }, - "SecurityControlArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of a control, such as\n arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1. This\n parameter doesn't mention a specific standard.

", - "smithy.api#required": {} - } - }, - "AssociationStatus": { - "target": "com.amazonaws.securityhub#AssociationStatus", - "traits": { - "smithy.api#documentation": "

\n The enablement status of a control in a specific standard.\n

", - "smithy.api#required": {} - } - }, - "RelatedRequirements": { - "target": "com.amazonaws.securityhub#RelatedRequirementsList", - "traits": { - "smithy.api#documentation": "

\n The requirement that underlies this control in the compliance framework related to the standard.\n

" - } - }, - "UpdatedAt": { - "target": "com.amazonaws.securityhub#Timestamp", - "traits": { - "smithy.api#documentation": "

The last time that a control's enablement status in a specified standard was updated.

" - } - }, - "UpdatedReason": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The reason for updating the control's enablement status in a specified standard.

" - } - }, - "StandardsControlTitle": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The title of a control. \n

" - } - }, - "StandardsControlDescription": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The description of a control. This typically summarizes how Security Hub evaluates the control and the \n conditions under which it produces a failed finding. The parameter may reference a specific standard.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An array that provides the enablement status and other details for each control that\n applies to each enabled standard.

" - } - }, - "com.amazonaws.securityhub#StandardsControlAssociationUpdate": { - "type": "structure", - "members": { - "StandardsArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the standard in which you want to update the\n control's enablement status.

", - "smithy.api#required": {} - } - }, - "SecurityControlId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The unique identifier for the security control whose enablement status you want to update.

", - "smithy.api#required": {} - } - }, - "AssociationStatus": { - "target": "com.amazonaws.securityhub#AssociationStatus", - "traits": { - "smithy.api#documentation": "

The desired enablement status of the control in the standard.

", - "smithy.api#required": {} - } - }, - "UpdatedReason": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The reason for updating the control's enablement status in the standard.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An array of requested updates to the enablement status of controls in specified\n standards. The objects in the array include a security control ID, the Amazon Resource Name (ARN) of the standard, the requested\n enablement status, and the reason for updating the enablement status.

" - } - }, - "com.amazonaws.securityhub#StandardsControlAssociationUpdates": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#StandardsControlAssociationUpdate" - } - }, - "com.amazonaws.securityhub#StandardsControls": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#StandardsControl" - } - }, - "com.amazonaws.securityhub#StandardsInputParameterMap": { - "type": "map", - "key": { - "target": "com.amazonaws.securityhub#NonEmptyString" - }, - "value": { - "target": "com.amazonaws.securityhub#NonEmptyString" - } - }, - "com.amazonaws.securityhub#StandardsManagedBy": { - "type": "structure", - "members": { - "Company": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

An identifier for the company that manages a specific security standard. For existing\n standards, the value is equal to Amazon Web Services.

" - } - }, - "Product": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

An identifier for the product that manages a specific security standard. For existing\n standards, the value is equal to the Amazon Web Services service that manages the\n standard.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides details about the management of a security standard.

" - } - }, - "com.amazonaws.securityhub#StandardsStatus": { - "type": "enum", - "members": { - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "READY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "READY" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "INCOMPLETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INCOMPLETE" - } - } - } - }, - "com.amazonaws.securityhub#StandardsStatusReason": { - "type": "structure", - "members": { - "StatusReasonCode": { - "target": "com.amazonaws.securityhub#StatusReasonCode", - "traits": { - "smithy.api#documentation": "

The reason code that represents the reason for the current status of a standard subscription.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The reason for the current status of a standard subscription.

" - } - }, - "com.amazonaws.securityhub#StandardsSubscription": { - "type": "structure", - "members": { - "StandardsSubscriptionArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of a resource that represents your subscription to a supported standard.

", - "smithy.api#required": {} - } - }, - "StandardsArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of a standard.

", - "smithy.api#required": {} - } - }, - "StandardsInput": { - "target": "com.amazonaws.securityhub#StandardsInputParameterMap", - "traits": { - "smithy.api#documentation": "

A key-value pair of input for the standard.

", - "smithy.api#required": {} - } - }, - "StandardsStatus": { - "target": "com.amazonaws.securityhub#StandardsStatus", - "traits": { - "smithy.api#documentation": "

The status of the standard subscription.

\n

The status values are as follows:

\n ", - "smithy.api#required": {} - } - }, - "StandardsStatusReason": { - "target": "com.amazonaws.securityhub#StandardsStatusReason", - "traits": { - "smithy.api#documentation": "

The reason for the current status.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A resource that represents your subscription to a supported standard.

" - } - }, - "com.amazonaws.securityhub#StandardsSubscriptionArns": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#NonEmptyString" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 25 - } - } - }, - "com.amazonaws.securityhub#StandardsSubscriptionRequest": { - "type": "structure", - "members": { - "StandardsArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the standard that you want to enable. To view the list of available standards\n and their ARNs, use the DescribeStandards operation.

", - "smithy.api#required": {} - } - }, - "StandardsInput": { - "target": "com.amazonaws.securityhub#StandardsInputParameterMap", - "traits": { - "smithy.api#documentation": "

A key-value pair of input for the standard.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The standard that you want to enable.

" - } - }, - "com.amazonaws.securityhub#StandardsSubscriptionRequests": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#StandardsSubscriptionRequest" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 25 - } - } - }, - "com.amazonaws.securityhub#StandardsSubscriptions": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#StandardsSubscription" - } - }, - "com.amazonaws.securityhub#StatelessCustomActionDefinition": { - "type": "structure", - "members": { - "PublishMetricAction": { - "target": "com.amazonaws.securityhub#StatelessCustomPublishMetricAction", - "traits": { - "smithy.api#documentation": "

Information about metrics to publish to CloudWatch.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition of a custom action that can be used for stateless packet handling.

" - } - }, - "com.amazonaws.securityhub#StatelessCustomPublishMetricAction": { - "type": "structure", - "members": { - "Dimensions": { - "target": "com.amazonaws.securityhub#StatelessCustomPublishMetricActionDimensionsList", - "traits": { - "smithy.api#documentation": "

Defines CloudWatch dimension values to publish.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about metrics to publish to CloudWatch.

" - } - }, - "com.amazonaws.securityhub#StatelessCustomPublishMetricActionDimension": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The value to use for the custom metric dimension.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Defines a CloudWatch dimension value to publish.

" - } - }, - "com.amazonaws.securityhub#StatelessCustomPublishMetricActionDimensionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#StatelessCustomPublishMetricActionDimension" - } - }, - "com.amazonaws.securityhub#StatusReason": { - "type": "structure", - "members": { - "ReasonCode": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A code that represents a reason for the control status. For the list of status reason\n codes and their meanings, see Standards-related information in the ASFF in the\n Security Hub User Guide.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The corresponding description for the status reason code.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides additional context for the value of Compliance.Status.

" - } - }, - "com.amazonaws.securityhub#StatusReasonCode": { - "type": "enum", - "members": { - "NO_AVAILABLE_CONFIGURATION_RECORDER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NO_AVAILABLE_CONFIGURATION_RECORDER" - } - }, - "INTERNAL_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTERNAL_ERROR" - } - } - } - }, - "com.amazonaws.securityhub#StatusReasonsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#StatusReason" - } - }, - "com.amazonaws.securityhub#StringFilter": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The string filter value. Filter values are case sensitive. For example, the product name\n for control-based findings is Security Hub. If you provide security hub\n as the filter text, then there is no match.

" - } - }, - "Comparison": { - "target": "com.amazonaws.securityhub#StringFilterComparison", - "traits": { - "smithy.api#documentation": "

The condition to apply to a string value when querying for findings. To search for\n values that contain the filter criteria value, use one of the following comparison\n operators:

\n \n

\n EQUALS and PREFIX filters on the same field are joined by\n OR. A finding matches if it matches any one of those filters.

\n

To search for values that do not contain the filter criteria value, use one of the\n following comparison operators:

\n \n

\n NOT_EQUALS and PREFIX_NOT_EQUALS filters on the same field are\n joined by AND. A finding matches only if it matches all of those\n filters.

\n

For filters on the same field, you cannot provide both an EQUALS filter and\n a NOT_EQUALS or PREFIX_NOT_EQUALS filter. Combining filters in\n this way always returns an error, even if the provided filter values would return valid\n results.

\n

You can combine PREFIX filters with NOT_EQUALS or\n PREFIX_NOT_EQUALS filters for the same field. Security Hub first processes the\n PREFIX filters, then the NOT_EQUALS or\n PREFIX_NOT_EQUALS filters.

\n

For example, for the following filter, Security Hub first identifies findings that have\n resource types that start with either AwsIAM or AwsEc2. It then\n excludes findings that have a resource type of AwsIamPolicy and findings that\n have a resource type of AwsEc2NetworkInterface.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

A string filter for querying findings.

" - } - }, - "com.amazonaws.securityhub#StringFilterComparison": { - "type": "enum", - "members": { - "EQUALS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EQUALS" - } - }, - "PREFIX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PREFIX" - } - }, - "NOT_EQUALS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_EQUALS" - } - }, - "PREFIX_NOT_EQUALS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PREFIX_NOT_EQUALS" - } - } - } - }, - "com.amazonaws.securityhub#StringFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#StringFilter" - } - }, - "com.amazonaws.securityhub#StringList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#NonEmptyString" - } - }, - "com.amazonaws.securityhub#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" - } - }, - "com.amazonaws.securityhub#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.securityhub#TagMap": { - "type": "map", - "key": { - "target": "com.amazonaws.securityhub#TagKey" - }, - "value": { - "target": "com.amazonaws.securityhub#TagValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.securityhub#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#TagResourceRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#TagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Adds one or more tags to a resource.

", - "smithy.api#http": { - "method": "POST", - "uri": "/tags/{ResourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#TagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.securityhub#ResourceArn", - "traits": { - "smithy.api#documentation": "

The ARN of the resource to apply the tags to.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.securityhub#TagMap", - "traits": { - "smithy.api#documentation": "

The tags to add to the resource. You can add up to 50 tags at a time. The tag keys can be no longer than 128 characters. The tag values can be no longer than 256 characters.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#TagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.securityhub#Threat": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the threat.\n\t\t

" - } - }, - "Severity": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The severity of the threat. \n\t\t

" - } - }, - "ItemCount": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

This total number of items in which the threat has been detected.\n\t\t

" - } - }, - "FilePaths": { - "target": "com.amazonaws.securityhub#FilePathList", - "traits": { - "smithy.api#documentation": "

Provides information about the file paths that were affected by the threat.\n\t\t

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about the threat detected in a security finding and the file paths that were affected by the threat.\n\t\t

" - } - }, - "com.amazonaws.securityhub#ThreatIntelIndicator": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.securityhub#ThreatIntelIndicatorType", - "traits": { - "smithy.api#documentation": "

The type of threat intelligence indicator.

" - } - }, - "Value": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The value of a threat intelligence indicator.

" - } - }, - "Category": { - "target": "com.amazonaws.securityhub#ThreatIntelIndicatorCategory", - "traits": { - "smithy.api#documentation": "

The category of a threat intelligence indicator.

" - } - }, - "LastObservedAt": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the most recent instance of a threat intelligence indicator was\n observed.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "Source": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The source of the threat intelligence indicator.

" - } - }, - "SourceUrl": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The URL to the page or site where you can get more information about the threat\n intelligence indicator.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about the threat intelligence related to a finding.

" - } - }, - "com.amazonaws.securityhub#ThreatIntelIndicatorCategory": { - "type": "enum", - "members": { - "BACKDOOR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BACKDOOR" - } - }, - "CARD_STEALER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CARD_STEALER" - } - }, - "COMMAND_AND_CONTROL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMMAND_AND_CONTROL" - } - }, - "DROP_SITE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DROP_SITE" - } - }, - "EXPLOIT_SITE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXPLOIT_SITE" - } - }, - "KEYLOGGER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KEYLOGGER" - } - } - } - }, - "com.amazonaws.securityhub#ThreatIntelIndicatorList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#ThreatIntelIndicator" - } - }, - "com.amazonaws.securityhub#ThreatIntelIndicatorType": { - "type": "enum", - "members": { - "DOMAIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOMAIN" - } - }, - "EMAIL_ADDRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EMAIL_ADDRESS" - } - }, - "HASH_MD5": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HASH_MD5" - } - }, - "HASH_SHA1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HASH_SHA1" - } - }, - "HASH_SHA256": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HASH_SHA256" - } - }, - "HASH_SHA512": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HASH_SHA512" - } - }, - "IPV4_ADDRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IPV4_ADDRESS" - } - }, - "IPV6_ADDRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IPV6_ADDRESS" - } - }, - "MUTEX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MUTEX" - } - }, - "PROCESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PROCESS" - } - }, - "URL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "URL" - } - } - } - }, - "com.amazonaws.securityhub#ThreatList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#Threat" - } - }, - "com.amazonaws.securityhub#Timestamp": { - "type": "timestamp", - "traits": { - "smithy.api#timestampFormat": "date-time" - } - }, - "com.amazonaws.securityhub#TypeList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#NonEmptyString" - } - }, - "com.amazonaws.securityhub#UnprocessedErrorCode": { - "type": "enum", - "members": { - "INVALID_INPUT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INVALID_INPUT" - } - }, - "ACCESS_DENIED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACCESS_DENIED" - } - }, - "NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_FOUND" - } - }, - "LIMIT_EXCEEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LIMIT_EXCEEDED" - } - } - } - }, - "com.amazonaws.securityhub#UnprocessedSecurityControl": { - "type": "structure", - "members": { - "SecurityControlId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The control (identified with SecurityControlId,\n SecurityControlArn, or a mix of both parameters) for which a response\n couldn't be returned.

", - "smithy.api#required": {} - } - }, - "ErrorCode": { - "target": "com.amazonaws.securityhub#UnprocessedErrorCode", - "traits": { - "smithy.api#documentation": "

\n The error code for the unprocessed security control.\n

", - "smithy.api#required": {} - } - }, - "ErrorReason": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The reason why the security control was unprocessed.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides details about a security control for which a response couldn't be returned.

" - } - }, - "com.amazonaws.securityhub#UnprocessedSecurityControls": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#UnprocessedSecurityControl" - } - }, - "com.amazonaws.securityhub#UnprocessedStandardsControlAssociation": { - "type": "structure", - "members": { - "StandardsControlAssociationId": { - "target": "com.amazonaws.securityhub#StandardsControlAssociationId", - "traits": { - "smithy.api#documentation": "

An array with one or more objects that includes a security control (identified with\n SecurityControlId, SecurityControlArn, or a mix of both\n parameters) and the Amazon Resource Name (ARN) of a standard. This parameter shows the\n specific controls for which the enablement status couldn't be retrieved in specified standards when\n calling BatchUpdateStandardsControlAssociations.

", - "smithy.api#required": {} - } - }, - "ErrorCode": { - "target": "com.amazonaws.securityhub#UnprocessedErrorCode", - "traits": { - "smithy.api#documentation": "

The error code for the unprocessed standard and control association.\n

", - "smithy.api#required": {} - } - }, - "ErrorReason": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The reason why the standard and control association was unprocessed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides details about which\n control's enablement status couldn't be retrieved in a specified standard when calling BatchUpdateStandardsControlAssociations. This parameter also provides details\n about why the request was unprocessed.

" - } - }, - "com.amazonaws.securityhub#UnprocessedStandardsControlAssociationUpdate": { - "type": "structure", - "members": { - "StandardsControlAssociationUpdate": { - "target": "com.amazonaws.securityhub#StandardsControlAssociationUpdate", - "traits": { - "smithy.api#documentation": "

An array of control and standard associations for which an update failed when calling \n BatchUpdateStandardsControlAssociations.\n

", - "smithy.api#required": {} - } - }, - "ErrorCode": { - "target": "com.amazonaws.securityhub#UnprocessedErrorCode", - "traits": { - "smithy.api#documentation": "

The error code for the unprocessed update of the control's enablement status in the\n specified standard.

", - "smithy.api#required": {} - } - }, - "ErrorReason": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The reason why a control's enablement status in the specified standard couldn't be updated.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides details about which control's enablement status could not be updated in a\n specified standard when calling the BatchUpdateStandardsControlAssociations API. This parameter also provides\n details about why the request was unprocessed.

" - } - }, - "com.amazonaws.securityhub#UnprocessedStandardsControlAssociationUpdates": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#UnprocessedStandardsControlAssociationUpdate" - } - }, - "com.amazonaws.securityhub#UnprocessedStandardsControlAssociations": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#UnprocessedStandardsControlAssociation" - } - }, - "com.amazonaws.securityhub#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#UntagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes one or more tags from a resource.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/tags/{ResourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#UntagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.securityhub#ResourceArn", - "traits": { - "smithy.api#documentation": "

The ARN of the resource to remove the tags from.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TagKeys": { - "target": "com.amazonaws.securityhub#TagKeyList", - "traits": { - "smithy.api#documentation": "

The tag keys associated with the tags to remove from the resource. You can remove up to 50 tags at a time.

", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#UntagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#UpdateActionTarget": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#UpdateActionTargetRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#UpdateActionTargetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the name and description of a custom action target in Security Hub.

", - "smithy.api#http": { - "method": "PATCH", - "uri": "/actionTargets/{ActionTargetArn+}", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#UpdateActionTargetRequest": { - "type": "structure", - "members": { - "ActionTargetArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the custom action target to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The updated name of the custom action target.

" - } - }, - "Description": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The updated description for the custom action target.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#UpdateActionTargetResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#UpdateFindingAggregator": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#UpdateFindingAggregatorRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#UpdateFindingAggregatorResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#AccessDeniedException" - }, - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - }, - { - "target": "com.amazonaws.securityhub#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the finding aggregation configuration. Used to update the Region linking mode and the list of included or excluded Regions. You cannot use UpdateFindingAggregator to change the aggregation Region.

\n

You must run UpdateFindingAggregator from the current aggregation Region.\n

", - "smithy.api#http": { - "method": "PATCH", - "uri": "/findingAggregator/update", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#UpdateFindingAggregatorRequest": { - "type": "structure", - "members": { - "FindingAggregatorArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the finding aggregator. To obtain the ARN, use ListFindingAggregators.

", - "smithy.api#required": {} - } - }, - "RegionLinkingMode": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates whether to aggregate findings from all of the available Regions in the current partition. Also determines whether to automatically aggregate findings from new Regions as Security Hub supports them and you opt into them.

\n

The selected option also determines how to use the Regions provided in the Regions list.

\n

The options are as follows:

\n ", - "smithy.api#required": {} - } - }, - "Regions": { - "target": "com.amazonaws.securityhub#StringList", - "traits": { - "smithy.api#documentation": "

If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a space-separated list of Regions that do not aggregate findings to the aggregation Region.

\n

If RegionLinkingMode is SPECIFIED_REGIONS, then this is a space-separated list of Regions that do aggregate findings to the aggregation Region.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#UpdateFindingAggregatorResponse": { - "type": "structure", - "members": { - "FindingAggregatorArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the finding aggregator.

" - } - }, - "FindingAggregationRegion": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The aggregation Region.

" - } - }, - "RegionLinkingMode": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.

" - } - }, - "Regions": { - "target": "com.amazonaws.securityhub#StringList", - "traits": { - "smithy.api#documentation": "

The list of excluded Regions or included Regions.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#UpdateFindings": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#UpdateFindingsRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#UpdateFindingsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - }, - { - "target": "com.amazonaws.securityhub#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

\n UpdateFindings is deprecated. Instead of UpdateFindings, use\n BatchUpdateFindings.

\n

Updates the Note and RecordState of the Security Hub-aggregated\n findings that the filter attributes specify. Any member account that can view the finding\n also sees the update to the finding.

", - "smithy.api#http": { - "method": "PATCH", - "uri": "/findings", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#UpdateFindingsRequest": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.securityhub#AwsSecurityFindingFilters", - "traits": { - "smithy.api#documentation": "

A collection of attributes that specify which findings you want to update.

", - "smithy.api#required": {} - } - }, - "Note": { - "target": "com.amazonaws.securityhub#NoteUpdate", - "traits": { - "smithy.api#documentation": "

The updated note for the finding.

" - } - }, - "RecordState": { - "target": "com.amazonaws.securityhub#RecordState", - "traits": { - "smithy.api#documentation": "

The updated record state for the finding.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#UpdateFindingsResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#UpdateInsight": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#UpdateInsightRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#UpdateInsightResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - }, - { - "target": "com.amazonaws.securityhub#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the Security Hub insight identified by the specified insight ARN.

", - "smithy.api#http": { - "method": "PATCH", - "uri": "/insights/{InsightArn+}", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#UpdateInsightRequest": { - "type": "structure", - "members": { - "InsightArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the insight that you want to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The updated name for the insight.

" - } - }, - "Filters": { - "target": "com.amazonaws.securityhub#AwsSecurityFindingFilters", - "traits": { - "smithy.api#documentation": "

The updated filters that define this insight.

" - } - }, - "GroupByAttribute": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The updated GroupBy attribute that defines this insight.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#UpdateInsightResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#UpdateOrganizationConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#UpdateOrganizationConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#UpdateOrganizationConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - } - ], - "traits": { - "smithy.api#documentation": "

Used to update the configuration related to Organizations. Can only be called from a\n Security Hub administrator account.

", - "smithy.api#http": { - "method": "POST", - "uri": "/organization/configuration", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#UpdateOrganizationConfigurationRequest": { - "type": "structure", - "members": { - "AutoEnable": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether to automatically enable Security Hub for new accounts in the organization.

\n

By default, this is false, and new accounts are not added\n automatically.

\n

To automatically enable Security Hub for new accounts, set this to true.

", - "smithy.api#required": {} - } - }, - "AutoEnableStandards": { - "target": "com.amazonaws.securityhub#AutoEnableStandards", - "traits": { - "smithy.api#documentation": "

Whether to automatically enable Security Hub default standards \n for new member accounts in the organization.

\n

By default, this parameter is equal to DEFAULT, and new member accounts are automatically enabled with default Security Hub standards.

\n

To opt out of enabling default standards for new member accounts, set this parameter equal to NONE.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#UpdateOrganizationConfigurationResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#UpdateSecurityHubConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#UpdateSecurityHubConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#UpdateSecurityHubConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#LimitExceededException" - }, - { - "target": "com.amazonaws.securityhub#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates configuration options for Security Hub.

", - "smithy.api#http": { - "method": "PATCH", - "uri": "/accounts", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#UpdateSecurityHubConfigurationRequest": { - "type": "structure", - "members": { - "AutoEnableControls": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether to automatically enable new controls when they are added to standards that are\n enabled.

\n

By default, this is set to true, and new controls are enabled\n automatically. To not automatically enable new controls, set this to false.\n

" - } - }, - "ControlFindingGenerator": { - "target": "com.amazonaws.securityhub#ControlFindingGenerator", - "traits": { - "smithy.api#documentation": "

Updates whether the calling account has consolidated control findings turned on. \n If the value for this field is set to \n SECURITY_CONTROL, Security Hub generates a single finding for a control check even when the check \n applies to multiple enabled standards.

\n

If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings \n for a control check when the check applies to multiple enabled standards.

\n

For accounts that are part of an organization, this value can only be updated in the administrator account.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#UpdateSecurityHubConfigurationResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#UpdateStandardsControl": { - "type": "operation", - "input": { - "target": "com.amazonaws.securityhub#UpdateStandardsControlRequest" - }, - "output": { - "target": "com.amazonaws.securityhub#UpdateStandardsControlResponse" - }, - "errors": [ - { - "target": "com.amazonaws.securityhub#InternalException" - }, - { - "target": "com.amazonaws.securityhub#InvalidAccessException" - }, - { - "target": "com.amazonaws.securityhub#InvalidInputException" - }, - { - "target": "com.amazonaws.securityhub#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Used to control whether an individual security standard control is enabled or\n disabled.

", - "smithy.api#http": { - "method": "PATCH", - "uri": "/standards/control/{StandardsControlArn+}", - "code": 200 - } - } - }, - "com.amazonaws.securityhub#UpdateStandardsControlRequest": { - "type": "structure", - "members": { - "StandardsControlArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the security standard control to enable or disable.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ControlStatus": { - "target": "com.amazonaws.securityhub#ControlStatus", - "traits": { - "smithy.api#documentation": "

The updated status of the security standard control.

" - } - }, - "DisabledReason": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A description of the reason why you are disabling a security standard control. If you\n are disabling a control, then this is required.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#UpdateStandardsControlResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#VerificationState": { - "type": "enum", - "members": { - "UNKNOWN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNKNOWN" - } - }, - "TRUE_POSITIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TRUE_POSITIVE" - } - }, - "FALSE_POSITIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FALSE_POSITIVE" - } - }, - "BENIGN_POSITIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BENIGN_POSITIVE" - } - } - } - }, - "com.amazonaws.securityhub#VolumeMount": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the volume.\n

" - } - }, - "MountPath": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The path in the container at which the volume should be mounted.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the mounting of a volume in a container.\n

" - } - }, - "com.amazonaws.securityhub#VolumeMountList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#VolumeMount" - } - }, - "com.amazonaws.securityhub#VpcInfoCidrBlockSetDetails": { - "type": "structure", - "members": { - "CidrBlock": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The IPv4 CIDR block for the VPC.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides details about the IPv4 CIDR blocks for the VPC.\n

" - } - }, - "com.amazonaws.securityhub#VpcInfoCidrBlockSetList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#VpcInfoCidrBlockSetDetails" - } - }, - "com.amazonaws.securityhub#VpcInfoIpv6CidrBlockSetDetails": { - "type": "structure", - "members": { - "Ipv6CidrBlock": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The IPv6 CIDR block for the VPC.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides details about the IPv6 CIDR blocks for the VPC.\n

" - } - }, - "com.amazonaws.securityhub#VpcInfoIpv6CidrBlockSetList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#VpcInfoIpv6CidrBlockSetDetails" - } - }, - "com.amazonaws.securityhub#VpcInfoPeeringOptionsDetails": { - "type": "structure", - "members": { - "AllowDnsResolutionFromRemoteVpc": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.\n

" - } - }, - "AllowEgressFromLocalClassicLinkToRemoteVpc": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.\n

" - } - }, - "AllowEgressFromLocalVpcToRemoteClassicLink": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about the VPC peering connection options for the accepter or requester VPC.\n

" - } - }, - "com.amazonaws.securityhub#Vulnerability": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier of the vulnerability.

", - "smithy.api#required": {} - } - }, - "VulnerablePackages": { - "target": "com.amazonaws.securityhub#SoftwarePackageList", - "traits": { - "smithy.api#documentation": "

List of software packages that have the vulnerability.

" - } - }, - "Cvss": { - "target": "com.amazonaws.securityhub#CvssList", - "traits": { - "smithy.api#documentation": "

CVSS scores from the advisory related to the vulnerability.

" - } - }, - "RelatedVulnerabilities": { - "target": "com.amazonaws.securityhub#StringList", - "traits": { - "smithy.api#documentation": "

List of vulnerabilities that are related to this vulnerability.

" - } - }, - "Vendor": { - "target": "com.amazonaws.securityhub#VulnerabilityVendor", - "traits": { - "smithy.api#documentation": "

Information about the vendor that generates the vulnerability report.

" - } - }, - "ReferenceUrls": { - "target": "com.amazonaws.securityhub#StringList", - "traits": { - "smithy.api#documentation": "

A list of URLs that provide additional information about the vulnerability.

" - } - }, - "FixAvailable": { - "target": "com.amazonaws.securityhub#VulnerabilityFixAvailable", - "traits": { - "smithy.api#documentation": "

Specifies if all vulnerable packages in a finding have a value for FixedInVersion \nand Remediation.\nThis field is evaluated for each vulnerability Id based on the number of vulnerable packages that have a value for both \nFixedInVersion and Remediation. Valid values are as follows:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

A vulnerability associated with a finding.

" - } - }, - "com.amazonaws.securityhub#VulnerabilityFixAvailable": { - "type": "enum", - "members": { - "YES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "YES" - } - }, - "NO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NO" - } - }, - "PARTIAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PARTIAL" - } - } - } - }, - "com.amazonaws.securityhub#VulnerabilityList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#Vulnerability" - } - }, - "com.amazonaws.securityhub#VulnerabilityVendor": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the vendor.

", - "smithy.api#required": {} - } - }, - "Url": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The URL of the vulnerability advisory.

" - } - }, - "VendorSeverity": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The severity that the vendor assigned to the vulnerability.

" - } - }, - "VendorCreatedAt": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the vulnerability advisory was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - }, - "VendorUpdatedAt": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates when the vulnerability advisory was last updated.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A vendor that generates a vulnerability report.

" - } - }, - "com.amazonaws.securityhub#WafAction": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Specifies how you want WAF to respond to requests that match the settings in a\n rule.

\n

Valid settings include the following:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about the action that CloudFront or WAF takes when a web request matches the\n conditions in the rule.

" - } - }, - "com.amazonaws.securityhub#WafExcludedRule": { - "type": "structure", - "members": { - "RuleId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The unique identifier for the rule to exclude from the rule group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about a rule to exclude from a rule group.

" - } - }, - "com.amazonaws.securityhub#WafExcludedRuleList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#WafExcludedRule" - } - }, - "com.amazonaws.securityhub#WafOverrideAction": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n COUNT overrides the action specified by the individual rule within a\n RuleGroup .

\n

If set to NONE, the rule's action takes place.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about an override action for a rule.

" - } - }, - "com.amazonaws.securityhub#Workflow": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.securityhub#WorkflowStatus", - "traits": { - "smithy.api#documentation": "

The status of the investigation into the finding. The workflow status is specific to an individual finding. It does not affect the generation of new findings. For example, setting the workflow status to SUPPRESSED or RESOLVED does not prevent a new finding for the same issue.

\n

The allowed values are the following.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about the status of the investigation into a finding.

" - } - }, - "com.amazonaws.securityhub#WorkflowState": { - "type": "enum", - "members": { - "NEW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NEW" - } - }, - "ASSIGNED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ASSIGNED" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_PROGRESS" - } - }, - "DEFERRED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DEFERRED" - } - }, - "RESOLVED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RESOLVED" - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "This filter is deprecated. Instead, use SeverityLabel or FindingProviderFieldsSeverityLabel." - } - } - }, - "com.amazonaws.securityhub#WorkflowStatus": { - "type": "enum", - "members": { - "NEW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NEW" - } - }, - "NOTIFIED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOTIFIED" - } - }, - "RESOLVED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RESOLVED" - } - }, - "SUPPRESSED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUPPRESSED" - } - } - } - }, - "com.amazonaws.securityhub#WorkflowUpdate": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.securityhub#WorkflowStatus", - "traits": { - "smithy.api#documentation": "

The status of the investigation into the finding. The workflow status is specific to an individual finding. It does not affect the generation of new findings. For example, setting the workflow status to SUPPRESSED or RESOLVED does not prevent a new finding for the same issue.

\n

The allowed values are the following.

\n " - } } - }, - "traits": { - "smithy.api#documentation": "

Used to update information about the investigation into the finding.

" - } } - } } diff --git a/codegen/sdk-codegen/aws-models/simspaceweaver.json b/codegen/sdk-codegen/aws-models/simspaceweaver.json index 2d445ae406b6..3f8be46b5351 100644 --- a/codegen/sdk-codegen/aws-models/simspaceweaver.json +++ b/codegen/sdk-codegen/aws-models/simspaceweaver.json @@ -1,2776 +1,2791 @@ { - "smithy": "2.0", - "shapes": { - "com.amazonaws.simspaceweaver#AccessDeniedException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.simspaceweaver#NonEmptyString" - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.simspaceweaver#AppPortMappings": { - "type": "list", - "member": { - "target": "com.amazonaws.simspaceweaver#SimulationAppPortMapping" - } - }, - "com.amazonaws.simspaceweaver#BucketName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 63 - } - } - }, - "com.amazonaws.simspaceweaver#ClientToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 32, - "max": 128 - }, - "smithy.api#pattern": "^[a-zA-Z0-9-]+$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.simspaceweaver#ClockStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "UNKNOWN", - "name": "UNKNOWN" - }, - { - "value": "STARTING", - "name": "STARTING" - }, - { - "value": "STARTED", - "name": "STARTED" - }, - { - "value": "STOPPING", - "name": "STOPPING" - }, - { - "value": "STOPPED", - "name": "STOPPED" - } - ] - } - }, - "com.amazonaws.simspaceweaver#ClockTargetStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "UNKNOWN", - "name": "UNKNOWN" - }, - { - "value": "STARTED", - "name": "STARTED" - }, - { - "value": "STOPPED", - "name": "STOPPED" - } - ] - } - }, - "com.amazonaws.simspaceweaver#CloudWatchLogsLogGroup": { - "type": "structure", - "members": { - "LogGroupArn": { - "target": "com.amazonaws.simspaceweaver#LogGroupArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log group for the simulation.\n For more information about ARNs, see Amazon Resource Names (ARNs)\n in the Amazon Web Services General Reference. For more information about log groups, see Working with log\n groups and log streams in the Amazon CloudWatch Logs User Guide.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The Amazon CloudWatch Logs log group for the simulation. For more information about log groups, see Working with log\n groups and log streams in the Amazon CloudWatch Logs User Guide.

" - } - }, - "com.amazonaws.simspaceweaver#ConflictException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.simspaceweaver#NonEmptyString" - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.simspaceweaver#CreateSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.simspaceweaver#CreateSnapshotInput" - }, - "output": { - "target": "com.amazonaws.simspaceweaver#CreateSnapshotOutput" - }, - "errors": [ - { - "target": "com.amazonaws.simspaceweaver#AccessDeniedException" - }, - { - "target": "com.amazonaws.simspaceweaver#ConflictException" - }, - { - "target": "com.amazonaws.simspaceweaver#InternalServerException" - }, - { - "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.simspaceweaver#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to create a snapshot", - "smithy.api#documentation": "

Creates a snapshot of the specified simulation. \n A snapshot is a file that contains simulation state data at a specific time.\n The state data saved in a snapshot includes entity data from the State Fabric, \n the simulation configuration specified in the schema, and the clock tick number. \n You can use the snapshot to initialize a new simulation. \n For more information about snapshots, see Snapshots\n in the SimSpace Weaver User Guide.\n

\n

You specify a Destination when you create a snapshot.\n The Destination is the name of an Amazon S3 bucket and an optional\n ObjectKeyPrefix. The ObjectKeyPrefix is\n usually the name of a folder in the bucket. SimSpace Weaver creates a \n snapshot folder inside the Destination and \n places the snapshot file there.

\n

The snapshot file is an Amazon S3 object. It has an object key with the\n form: \n object-key-prefix/snapshot/simulation-name-YYMMdd-HHmm-ss.zip, where:\n

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/createsnapshot", - "code": 200 - } - } - }, - "com.amazonaws.simspaceweaver#CreateSnapshotInput": { - "type": "structure", - "members": { - "Simulation": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the simulation.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "SimulationName" - } - }, - "Destination": { - "target": "com.amazonaws.simspaceweaver#S3Destination", - "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket and optional folder (object key prefix) where SimSpace Weaver creates the snapshot file.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.simspaceweaver#CreateSnapshotOutput": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.simspaceweaver#DeleteApp": { - "type": "operation", - "input": { - "target": "com.amazonaws.simspaceweaver#DeleteAppInput" - }, - "output": { - "target": "com.amazonaws.simspaceweaver#DeleteAppOutput" - }, - "errors": [ - { - "target": "com.amazonaws.simspaceweaver#AccessDeniedException" - }, - { - "target": "com.amazonaws.simspaceweaver#ConflictException" - }, - { - "target": "com.amazonaws.simspaceweaver#InternalServerException" - }, - { - "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.simspaceweaver#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to delete an app", - "smithy.api#documentation": "

Deletes the instance of the given custom app.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/deleteapp", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.simspaceweaver#DeleteAppInput": { - "type": "structure", - "members": { - "Simulation": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the simulation of the app.

", - "smithy.api#httpQuery": "simulation", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "SimulationName" - } - }, - "Domain": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the domain of the app.

", - "smithy.api#httpQuery": "domain", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "DomainName" - } - }, - "App": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the app.

", - "smithy.api#httpQuery": "app", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "AppName" - } - } - } - }, - "com.amazonaws.simspaceweaver#DeleteAppOutput": { - "type": "structure", - "members": {} - }, - "com.amazonaws.simspaceweaver#DeleteSimulation": { - "type": "operation", - "input": { - "target": "com.amazonaws.simspaceweaver#DeleteSimulationInput" - }, - "output": { - "target": "com.amazonaws.simspaceweaver#DeleteSimulationOutput" - }, - "errors": [ - { - "target": "com.amazonaws.simspaceweaver#AccessDeniedException" - }, - { - "target": "com.amazonaws.simspaceweaver#ConflictException" - }, - { - "target": "com.amazonaws.simspaceweaver#InternalServerException" - }, - { - "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.simspaceweaver#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to delete a simulation", - "smithy.api#documentation": "

Deletes all SimSpace Weaver resources assigned to the given simulation.

\n \n

Your simulation uses resources in other Amazon Web Services. This API operation doesn't delete\n resources in other Amazon Web Services.

\n ", - "smithy.api#http": { - "method": "DELETE", - "uri": "/deletesimulation", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.simspaceweaver#DeleteSimulationInput": { - "type": "structure", - "members": { - "Simulation": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the simulation.

", - "smithy.api#httpQuery": "simulation", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "SimulationName" - } - } - } - }, - "com.amazonaws.simspaceweaver#DeleteSimulationOutput": { - "type": "structure", - "members": {} - }, - "com.amazonaws.simspaceweaver#DescribeApp": { - "type": "operation", - "input": { - "target": "com.amazonaws.simspaceweaver#DescribeAppInput" - }, - "output": { - "target": "com.amazonaws.simspaceweaver#DescribeAppOutput" - }, - "errors": [ - { - "target": "com.amazonaws.simspaceweaver#AccessDeniedException" - }, - { - "target": "com.amazonaws.simspaceweaver#InternalServerException" - }, - { - "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.simspaceweaver#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to describe an app", - "smithy.api#documentation": "

Returns the state of the given custom app.

", - "smithy.api#http": { - "method": "GET", - "uri": "/describeapp", - "code": 200 - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.simspaceweaver#DescribeAppInput": { - "type": "structure", - "members": { - "Simulation": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the simulation of the app.

", - "smithy.api#httpQuery": "simulation", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "SimulationName" - } - }, - "Domain": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the domain of the app.

", - "smithy.api#httpQuery": "domain", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "DomainName" - } - }, - "App": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverLongResourceName", - "traits": { - "smithy.api#documentation": "

The name of the app.

", - "smithy.api#httpQuery": "app", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "AppName" - } - } - } - }, - "com.amazonaws.simspaceweaver#DescribeAppOutput": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverLongResourceName", - "traits": { - "smithy.api#documentation": "

The name of the app.

" - } - }, - "Simulation": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the simulation of the app.

" - } - }, - "Domain": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the domain of the app.

" - } - }, - "Status": { - "target": "com.amazonaws.simspaceweaver#SimulationAppStatus", - "traits": { - "smithy.api#documentation": "

The current lifecycle state of the custom app.

" - } - }, - "TargetStatus": { - "target": "com.amazonaws.simspaceweaver#SimulationAppTargetStatus", - "traits": { - "smithy.api#documentation": "

The desired lifecycle state of the custom app.

" - } - }, - "LaunchOverrides": { - "target": "com.amazonaws.simspaceweaver#LaunchOverrides" - }, - "Description": { - "target": "com.amazonaws.simspaceweaver#Description", - "traits": { - "smithy.api#documentation": "

The description of the app.

" - } - }, - "EndpointInfo": { - "target": "com.amazonaws.simspaceweaver#SimulationAppEndpointInfo", - "traits": { - "smithy.api#documentation": "

Information about the network endpoint for the custom app. You can use the endpoint to connect to the custom app.

" - } - } - } - }, - "com.amazonaws.simspaceweaver#DescribeSimulation": { - "type": "operation", - "input": { - "target": "com.amazonaws.simspaceweaver#DescribeSimulationInput" - }, - "output": { - "target": "com.amazonaws.simspaceweaver#DescribeSimulationOutput" - }, - "errors": [ - { - "target": "com.amazonaws.simspaceweaver#AccessDeniedException" - }, - { - "target": "com.amazonaws.simspaceweaver#InternalServerException" - }, - { - "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.simspaceweaver#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to describe a simulation", - "smithy.api#documentation": "

Returns the current state of the given simulation.

", - "smithy.api#http": { - "method": "GET", - "uri": "/describesimulation", - "code": 200 - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.simspaceweaver#DescribeSimulationInput": { - "type": "structure", - "members": { - "Simulation": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the simulation.

", - "smithy.api#httpQuery": "simulation", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "SimulationName" - } - } - } - }, - "com.amazonaws.simspaceweaver#DescribeSimulationOutput": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the simulation.

" - } - }, - "ExecutionId": { - "target": "com.amazonaws.simspaceweaver#UUID", - "traits": { - "smithy.api#documentation": "

A universally unique identifier (UUID) for this simulation.

" - } - }, - "Arn": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see Amazon Resource Names (ARNs)\n in the Amazon Web Services General Reference.

" - } - }, - "Description": { - "target": "com.amazonaws.simspaceweaver#Description", - "traits": { - "smithy.api#documentation": "

The description of the simulation.

" - } - }, - "RoleArn": { - "target": "com.amazonaws.simspaceweaver#RoleArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role\n that the simulation assumes to perform actions. For more information about ARNs, see Amazon Resource Names (ARNs)\n in the Amazon Web Services General Reference. For more information about IAM roles,\n see IAM roles in the \n Identity and Access Management User Guide.

" - } - }, - "CreationTime": { - "target": "com.amazonaws.simspaceweaver#Timestamp", - "traits": { - "smithy.api#documentation": "

The time when the simulation was created, expressed as the \n number of seconds and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970).

" - } - }, - "Status": { - "target": "com.amazonaws.simspaceweaver#SimulationStatus", - "traits": { - "smithy.api#documentation": "

The current lifecycle state of the simulation.

" - } - }, - "TargetStatus": { - "target": "com.amazonaws.simspaceweaver#SimulationTargetStatus", - "traits": { - "smithy.api#documentation": "

The desired lifecycle state of the simulation.

" - } - }, - "SchemaS3Location": { - "target": "com.amazonaws.simspaceweaver#S3Location", - "traits": { - "smithy.api#documentation": "

The location of the simulation schema in Amazon Simple Storage Service (Amazon S3).\n For more information about Amazon S3, see the \n Amazon Simple Storage Service User Guide\n .

" - } - }, - "SchemaError": { - "target": "com.amazonaws.simspaceweaver#OptionalString", - "traits": { - "smithy.api#deprecated": { - "message": "SchemaError is no longer used, check StartError instead." - }, - "smithy.api#documentation": "

An error message that SimSpace Weaver returns only if there is a problem with the simulation\n schema.

" - } - }, - "LoggingConfiguration": { - "target": "com.amazonaws.simspaceweaver#LoggingConfiguration", - "traits": { - "smithy.api#documentation": "

Settings that control how SimSpace Weaver handles your simulation log data.

" - } - }, - "LiveSimulationState": { - "target": "com.amazonaws.simspaceweaver#LiveSimulationState", - "traits": { - "smithy.api#documentation": "

A collection of additional state information, such as \ndomain and clock configuration.

" - } - }, - "MaximumDuration": { - "target": "com.amazonaws.simspaceweaver#TimeToLiveString", - "traits": { - "smithy.api#documentation": "

The maximum running time of the simulation,\n specified as a number of minutes (m or M), hours (h or H), or days (d or D). The simulation \n stops when it reaches this limit. The maximum value is 14D, or its equivalent in the \n other units. The default value is 14D. A value equivalent to 0 makes the\n simulation immediately transition to Stopping as soon as it reaches Started.

" - } - }, - "SnapshotS3Location": { - "target": "com.amazonaws.simspaceweaver#S3Location" - }, - "StartError": { - "target": "com.amazonaws.simspaceweaver#OptionalString", - "traits": { - "smithy.api#documentation": "

An error message that SimSpace Weaver returns only if a problem occurs when the simulation is in the STARTING state.

" - } - } - } - }, - "com.amazonaws.simspaceweaver#Description": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 500 - } - } - }, - "com.amazonaws.simspaceweaver#Domain": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the domain.

" - } - }, - "Lifecycle": { - "target": "com.amazonaws.simspaceweaver#LifecycleManagementStrategy", - "traits": { - "smithy.api#documentation": "

The type of lifecycle management for apps in the domain. Indicates whether apps in this\n domain are managed (SimSpace Weaver starts and stops the apps) or\n unmanaged (you must start and stop the apps).

\n

\n Lifecycle types\n

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

A collection of app instances that run the same executable app code and have the same\n launch options and commands.

\n

For more information about domains, see Key concepts: Domains\n in the SimSpace Weaver User Guide.

" - } - }, - "com.amazonaws.simspaceweaver#DomainList": { - "type": "list", - "member": { - "target": "com.amazonaws.simspaceweaver#Domain" - } - }, - "com.amazonaws.simspaceweaver#InternalServerException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.simspaceweaver#NonEmptyString" - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.simspaceweaver#LaunchCommandList": { - "type": "list", - "member": { - "target": "com.amazonaws.simspaceweaver#NonEmptyString" - } - }, - "com.amazonaws.simspaceweaver#LaunchOverrides": { - "type": "structure", - "members": { - "LaunchCommands": { - "target": "com.amazonaws.simspaceweaver#LaunchCommandList", - "traits": { - "smithy.api#documentation": "

App launch commands and command line parameters that override the launch command\n configured in the simulation schema.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Options that apply when the app starts. These options override default behavior.

" - } - }, - "com.amazonaws.simspaceweaver#LifecycleManagementStrategy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Unknown", - "name": "Unknown" - }, - { - "value": "PerWorker", - "name": "PerWorker" - }, - { - "value": "BySpatialSubdivision", - "name": "BySpatialSubdivision" - }, - { - "value": "ByRequest", - "name": "ByRequest" - } - ] - } - }, - "com.amazonaws.simspaceweaver#ListApps": { - "type": "operation", - "input": { - "target": "com.amazonaws.simspaceweaver#ListAppsInput" - }, - "output": { - "target": "com.amazonaws.simspaceweaver#ListAppsOutput" - }, - "errors": [ - { - "target": "com.amazonaws.simspaceweaver#AccessDeniedException" - }, - { - "target": "com.amazonaws.simspaceweaver#InternalServerException" - }, - { - "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.simspaceweaver#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to list apps", - "smithy.api#documentation": "

Lists all custom apps or service apps for the given simulation and domain.

", - "smithy.api#http": { - "method": "GET", - "uri": "/listapps", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.simspaceweaver#ListAppsInput": { - "type": "structure", - "members": { - "Simulation": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the simulation that you want to list apps for.

", - "smithy.api#httpQuery": "simulation", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "SimulationName" - } - }, - "Domain": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the domain that you want to list apps for.

", - "smithy.api#httpQuery": "domain" - } - }, - "MaxResults": { - "target": "com.amazonaws.simspaceweaver#PositiveInteger", - "traits": { - "smithy.api#documentation": "

The maximum number of apps to list.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.simspaceweaver#OptionalString", - "traits": { - "smithy.api#documentation": "

If SimSpace Weaver returns nextToken, then there are more results available. \n The value of nextToken is a unique pagination token for each page. To retrieve the next page, \n call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, \n then nextToken is set to null. Each pagination token expires after 24 hours. \n If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

", - "smithy.api#httpQuery": "nextToken" - } - } - } - }, - "com.amazonaws.simspaceweaver#ListAppsOutput": { - "type": "structure", - "members": { - "Apps": { - "target": "com.amazonaws.simspaceweaver#SimulationAppList", - "traits": { - "smithy.api#documentation": "

The list of apps for the given simulation and domain.

" - } - }, - "NextToken": { - "target": "com.amazonaws.simspaceweaver#OptionalString", - "traits": { - "smithy.api#documentation": "

If SimSpace Weaver returns nextToken, then there are more results available. \n The value of nextToken is a unique pagination token for each page. To retrieve the next page, \n call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, \n then nextToken is set to null. Each pagination token expires after 24 hours. \n If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

" - } - } - } - }, - "com.amazonaws.simspaceweaver#ListSimulations": { - "type": "operation", - "input": { - "target": "com.amazonaws.simspaceweaver#ListSimulationsInput" - }, - "output": { - "target": "com.amazonaws.simspaceweaver#ListSimulationsOutput" - }, - "errors": [ - { - "target": "com.amazonaws.simspaceweaver#AccessDeniedException" - }, - { - "target": "com.amazonaws.simspaceweaver#InternalServerException" - }, - { - "target": "com.amazonaws.simspaceweaver#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to list simulations", - "smithy.api#documentation": "

Lists the SimSpace Weaver simulations in the Amazon Web Services account used to make the API call.

", - "smithy.api#http": { - "method": "GET", - "uri": "/listsimulations", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.simspaceweaver#ListSimulationsInput": { - "type": "structure", - "members": { - "MaxResults": { - "target": "com.amazonaws.simspaceweaver#PositiveInteger", - "traits": { - "smithy.api#documentation": "

The maximum number of simulations to list.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.simspaceweaver#OptionalString", - "traits": { - "smithy.api#documentation": "

If SimSpace Weaver returns nextToken, then there are more results available. \n The value of nextToken is a unique pagination token for each page. To retrieve the next page, \n call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, \n then nextToken is set to null. Each pagination token expires after 24 hours. \n If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

", - "smithy.api#httpQuery": "nextToken" - } - } - } - }, - "com.amazonaws.simspaceweaver#ListSimulationsOutput": { - "type": "structure", - "members": { - "Simulations": { - "target": "com.amazonaws.simspaceweaver#SimulationList", - "traits": { - "smithy.api#documentation": "

The list of simulations.

" - } - }, - "NextToken": { - "target": "com.amazonaws.simspaceweaver#OptionalString", - "traits": { - "smithy.api#documentation": "

If SimSpace Weaver returns nextToken, then there are more results available. \n The value of nextToken is a unique pagination token for each page. To retrieve the next page, \n call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, \n then nextToken is set to null. Each pagination token expires after 24 hours. \n If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

" - } - } - } - }, - "com.amazonaws.simspaceweaver#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.simspaceweaver#ListTagsForResourceInput" - }, - "output": { - "target": "com.amazonaws.simspaceweaver#ListTagsForResourceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.simspaceweaver#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to list the tags for a resource", - "smithy.api#documentation": "

Lists all tags on a SimSpace Weaver resource.

", - "smithy.api#http": { - "method": "GET", - "uri": "/tags/{ResourceArn}", - "code": 200 - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.simspaceweaver#ListTagsForResourceInput": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource. For more information about ARNs, see Amazon Resource Names (ARNs)\n in the Amazon Web Services General Reference.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.simspaceweaver#ListTagsForResourceOutput": { - "type": "structure", - "members": { - "Tags": { - "target": "com.amazonaws.simspaceweaver#TagMap", - "traits": { - "smithy.api#documentation": "

The list of tags for the resource.

" - } - } - } - }, - "com.amazonaws.simspaceweaver#LiveSimulationState": { - "type": "structure", - "members": { - "Domains": { - "target": "com.amazonaws.simspaceweaver#DomainList", - "traits": { - "smithy.api#documentation": "

A list of domains for the simulation. For more information about domains, see Key concepts: Domains\n in the SimSpace Weaver User Guide.

" - } - }, - "Clocks": { - "target": "com.amazonaws.simspaceweaver#SimulationClockList", - "traits": { - "smithy.api#documentation": "

A list of simulation clocks.

\n \n

At this time, a simulation has only one clock.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

A collection of additional state information, such as \ndomain and clock configuration.

" - } - }, - "com.amazonaws.simspaceweaver#LogDestination": { - "type": "structure", - "members": { - "CloudWatchLogsLogGroup": { - "target": "com.amazonaws.simspaceweaver#CloudWatchLogsLogGroup", - "traits": { - "smithy.api#documentation": "

An Amazon CloudWatch Logs log group that stores simulation log data. For more information about log groups, see Working with log\n groups and log streams in the Amazon CloudWatch Logs User Guide.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The location where SimSpace Weaver sends simulation log data.

" - } - }, - "com.amazonaws.simspaceweaver#LogDestinations": { - "type": "list", - "member": { - "target": "com.amazonaws.simspaceweaver#LogDestination" - } - }, - "com.amazonaws.simspaceweaver#LogGroupArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1600 - }, - "smithy.api#pattern": "^arn:(?:aws|aws-cn):log-group:([a-z]{2}-[a-z]+-\\d{1}):(\\d{12})?:role\\/(.+)$" - } - }, - "com.amazonaws.simspaceweaver#LoggingConfiguration": { - "type": "structure", - "members": { - "Destinations": { - "target": "com.amazonaws.simspaceweaver#LogDestinations", - "traits": { - "smithy.api#documentation": "

A list of the locations where SimSpace Weaver sends simulation log data.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The logging configuration for a simulation.

" - } - }, - "com.amazonaws.simspaceweaver#NonEmptyString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1600 - } - } - }, - "com.amazonaws.simspaceweaver#ObjectKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.simspaceweaver#ObjectKeyPrefix": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - } - } - }, - "com.amazonaws.simspaceweaver#OptionalString": { - "type": "string" - }, - "com.amazonaws.simspaceweaver#PortNumber": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 65535 - } - } - }, - "com.amazonaws.simspaceweaver#PositiveInteger": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.simspaceweaver#ResourceNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.simspaceweaver#NonEmptyString" - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.simspaceweaver#RoleArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1600 - }, - "smithy.api#pattern": "^arn:(?:aws|aws-cn):iam::(\\d{12})?:role\\/(.+)$" - } - }, - "com.amazonaws.simspaceweaver#S3Destination": { - "type": "structure", - "members": { - "BucketName": { - "target": "com.amazonaws.simspaceweaver#BucketName", - "traits": { - "smithy.api#documentation": "

The name of an Amazon S3 bucket. For more information about buckets, see Creating,\n configuring, and working with Amazon S3 buckets in the Amazon Simple Storage Service User\n Guide.

" - } - }, - "ObjectKeyPrefix": { - "target": "com.amazonaws.simspaceweaver#ObjectKeyPrefix", - "traits": { - "smithy.api#documentation": "

A string prefix for an Amazon S3 object key. It's usually a folder name.\n For more information about folders in Amazon S3, see Organizing objects in the Amazon S3 console using folders\n in the Amazon Simple Storage Service User Guide.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An Amazon S3 bucket and optional folder (object key prefix) where SimSpace Weaver creates a file.

" - } - }, - "com.amazonaws.simspaceweaver#S3Location": { - "type": "structure", - "members": { - "BucketName": { - "target": "com.amazonaws.simspaceweaver#BucketName", - "traits": { - "smithy.api#documentation": "

The name of an Amazon S3 bucket. For more information about buckets, see Creating,\n configuring, and working with Amazon S3 buckets in the Amazon Simple Storage Service User\n Guide.

" - } - }, - "ObjectKey": { - "target": "com.amazonaws.simspaceweaver#ObjectKey", - "traits": { - "smithy.api#documentation": "

The key name of an object in Amazon S3. For more information about Amazon S3 objects and object\n keys, see Uploading,\n downloading, and working with objects in Amazon S3 in the Amazon Simple Storage Service User\n Guide.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A location in Amazon Simple Storage Service (Amazon S3) where SimSpace Weaver stores simulation data, such as your app .zip\n files and schema file. For more information about Amazon S3, see the \n Amazon Simple Storage Service User Guide\n .

" - } - }, - "com.amazonaws.simspaceweaver#ServiceQuotaExceededException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.simspaceweaver#NonEmptyString" - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#error": "client", - "smithy.api#httpError": 402 - } - }, - "com.amazonaws.simspaceweaver#SimSpaceWeaver": { - "type": "service", - "version": "2022-10-28", - "operations": [ - { - "target": "com.amazonaws.simspaceweaver#ListTagsForResource" - }, - { - "target": "com.amazonaws.simspaceweaver#TagResource" - }, - { - "target": "com.amazonaws.simspaceweaver#UntagResource" - } - ], - "resources": [ - { - "target": "com.amazonaws.simspaceweaver#Simulation" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "SimSpaceWeaver", - "arnNamespace": "simspaceweaver", - "cloudFormationName": "SimSpaceWeaver", - "endpointPrefix": "simspaceweaver", - "cloudTrailEventSource": "simspaceweaver.amazonaws.com" - }, - "aws.auth#sigv4": { - "name": "simspaceweaver" - }, - "aws.iam#defineConditionKeys": { - "aws:ResourceTag/${TagKey}": { - "type": "String", - "documentation": "Filters access by tags associated with the resource", - "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-resourcetag" - }, - "aws:RequestTag/${TagKey}": { - "type": "String", - "documentation": "Filters access by tags that are passed in the request", - "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requesttag" - }, - "aws:TagKeys": { - "type": "ArrayOfString", - "documentation": "Filters access by tag keys that are passed in the request", - "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-tagkeys" - } - }, - "aws.iam#supportedPrincipalTypes": ["Root", "IAMUser", "IAMRole", "FederatedUser"], - "aws.protocols#restJson1": {}, - "smithy.api#cors": { - "additionalAllowedHeaders": [ - "*,authorization,date,x-amz-date,x-amz-security-token,x-amz-target,content-type,x-amz-content-sha256,x-amz-user-agent,x-amzn-platform-id,x-amzn-trace-id,amz-sdk-invocation-id,amz-sdk-request" - ] - }, - "smithy.api#documentation": "

SimSpace Weaver (SimSpace Weaver) is a managed service that you can use to build and operate large-scale \n spatial simulations in the Amazon Web Services Cloud. For example, you can create a digital twin of a city,\n crowd simulations with millions of people and objects, and massively multiplayer games with\n hundreds of thousands of connected players.\n For more information about SimSpace Weaver, see the \n SimSpace Weaver User Guide\n .

\n

This API reference describes the API operations and data types that you can use to\n communicate directly with SimSpace Weaver.

\n

SimSpace Weaver also provides the SimSpace Weaver app SDK, which you use for app development. The\n SimSpace Weaver app SDK API reference is included in the SimSpace Weaver app SDK documentation. This\n documentation is part of the SimSpace Weaver app SDK distributable package.

", - "smithy.api#title": "AWS SimSpace Weaver", - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ + "smithy": "2.0", + "shapes": { + "com.amazonaws.simspaceweaver#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.simspaceweaver#NonEmptyString" + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.simspaceweaver#AppPortMappings": { + "type": "list", + "member": { + "target": "com.amazonaws.simspaceweaver#SimulationAppPortMapping" + } + }, + "com.amazonaws.simspaceweaver#BucketName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + } + } + }, + "com.amazonaws.simspaceweaver#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 32, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.simspaceweaver#ClockStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "UNKNOWN", + "name": "UNKNOWN" + }, + { + "value": "STARTING", + "name": "STARTING" + }, + { + "value": "STARTED", + "name": "STARTED" + }, + { + "value": "STOPPING", + "name": "STOPPING" + }, + { + "value": "STOPPED", + "name": "STOPPED" + } + ] + } + }, + "com.amazonaws.simspaceweaver#ClockTargetStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "UNKNOWN", + "name": "UNKNOWN" + }, + { + "value": "STARTED", + "name": "STARTED" + }, + { + "value": "STOPPED", + "name": "STOPPED" + } + ] + } + }, + "com.amazonaws.simspaceweaver#CloudWatchLogsLogGroup": { + "type": "structure", + "members": { + "LogGroupArn": { + "target": "com.amazonaws.simspaceweaver#LogGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log group for the simulation.\n For more information about ARNs, see Amazon Resource Names (ARNs)\n in the Amazon Web Services General Reference. For more information about log groups, see Working with log\n groups and log streams in the Amazon CloudWatch Logs User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon CloudWatch Logs log group for the simulation. For more information about log groups, see Working with log\n groups and log streams in the Amazon CloudWatch Logs User Guide.

" + } + }, + "com.amazonaws.simspaceweaver#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.simspaceweaver#NonEmptyString" + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.simspaceweaver#CreateSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.simspaceweaver#CreateSnapshotInput" + }, + "output": { + "target": "com.amazonaws.simspaceweaver#CreateSnapshotOutput" + }, + "errors": [ + { + "target": "com.amazonaws.simspaceweaver#AccessDeniedException" + }, + { + "target": "com.amazonaws.simspaceweaver#ConflictException" + }, + { + "target": "com.amazonaws.simspaceweaver#InternalServerException" + }, + { + "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.simspaceweaver#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to create a snapshot", + "smithy.api#documentation": "

Creates a snapshot of the specified simulation. \n A snapshot is a file that contains simulation state data at a specific time.\n The state data saved in a snapshot includes entity data from the State Fabric, \n the simulation configuration specified in the schema, and the clock tick number. \n You can use the snapshot to initialize a new simulation. \n For more information about snapshots, see Snapshots\n in the SimSpace Weaver User Guide.\n

\n

You specify a Destination when you create a snapshot.\n The Destination is the name of an Amazon S3 bucket and an optional\n ObjectKeyPrefix. The ObjectKeyPrefix is\n usually the name of a folder in the bucket. SimSpace Weaver creates a \n snapshot folder inside the Destination and \n places the snapshot file there.

\n

The snapshot file is an Amazon S3 object. It has an object key with the\n form: \n object-key-prefix/snapshot/simulation-name-YYMMdd-HHmm-ss.zip, where:\n

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/createsnapshot", + "code": 200 + } + } + }, + "com.amazonaws.simspaceweaver#CreateSnapshotInput": { + "type": "structure", + "members": { + "Simulation": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the simulation.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "SimulationName" + } + }, + "Destination": { + "target": "com.amazonaws.simspaceweaver#S3Destination", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket and optional folder (object key prefix) where SimSpace Weaver creates the snapshot file.

\n

The Amazon S3 bucket must be in the same Amazon Web Services Region as the simulation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.simspaceweaver#CreateSnapshotOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.simspaceweaver#DeleteApp": { + "type": "operation", + "input": { + "target": "com.amazonaws.simspaceweaver#DeleteAppInput" + }, + "output": { + "target": "com.amazonaws.simspaceweaver#DeleteAppOutput" + }, + "errors": [ + { + "target": "com.amazonaws.simspaceweaver#AccessDeniedException" + }, + { + "target": "com.amazonaws.simspaceweaver#ConflictException" + }, + { + "target": "com.amazonaws.simspaceweaver#InternalServerException" + }, + { + "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.simspaceweaver#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to delete an app", + "smithy.api#documentation": "

Deletes the instance of the given custom app.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/deleteapp", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.simspaceweaver#DeleteAppInput": { + "type": "structure", + "members": { + "Simulation": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the simulation of the app.

", + "smithy.api#httpQuery": "simulation", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "SimulationName" + } + }, + "Domain": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the domain of the app.

", + "smithy.api#httpQuery": "domain", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "DomainName" + } + }, + "App": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the app.

", + "smithy.api#httpQuery": "app", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "AppName" + } + } + } + }, + "com.amazonaws.simspaceweaver#DeleteAppOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.simspaceweaver#DeleteSimulation": { + "type": "operation", + "input": { + "target": "com.amazonaws.simspaceweaver#DeleteSimulationInput" + }, + "output": { + "target": "com.amazonaws.simspaceweaver#DeleteSimulationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.simspaceweaver#AccessDeniedException" + }, + { + "target": "com.amazonaws.simspaceweaver#ConflictException" + }, + { + "target": "com.amazonaws.simspaceweaver#InternalServerException" + }, + { + "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.simspaceweaver#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to delete a simulation", + "smithy.api#documentation": "

Deletes all SimSpace Weaver resources assigned to the given simulation.

\n \n

Your simulation uses resources in other Amazon Web Services. This API operation doesn't delete\n resources in other Amazon Web Services.

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/deletesimulation", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.simspaceweaver#DeleteSimulationInput": { + "type": "structure", + "members": { + "Simulation": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the simulation.

", + "smithy.api#httpQuery": "simulation", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "SimulationName" + } + } + } + }, + "com.amazonaws.simspaceweaver#DeleteSimulationOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.simspaceweaver#DescribeApp": { + "type": "operation", + "input": { + "target": "com.amazonaws.simspaceweaver#DescribeAppInput" + }, + "output": { + "target": "com.amazonaws.simspaceweaver#DescribeAppOutput" + }, + "errors": [ + { + "target": "com.amazonaws.simspaceweaver#AccessDeniedException" + }, + { + "target": "com.amazonaws.simspaceweaver#InternalServerException" + }, + { + "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.simspaceweaver#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to describe an app", + "smithy.api#documentation": "

Returns the state of the given custom app.

", + "smithy.api#http": { + "method": "GET", + "uri": "/describeapp", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.simspaceweaver#DescribeAppInput": { + "type": "structure", + "members": { + "Simulation": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the simulation of the app.

", + "smithy.api#httpQuery": "simulation", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "SimulationName" + } + }, + "Domain": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the domain of the app.

", + "smithy.api#httpQuery": "domain", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "DomainName" + } + }, + "App": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverLongResourceName", + "traits": { + "smithy.api#documentation": "

The name of the app.

", + "smithy.api#httpQuery": "app", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "AppName" + } + } + } + }, + "com.amazonaws.simspaceweaver#DescribeAppOutput": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverLongResourceName", + "traits": { + "smithy.api#documentation": "

The name of the app.

" + } + }, + "Simulation": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the simulation of the app.

" + } + }, + "Domain": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the domain of the app.

" + } + }, + "Status": { + "target": "com.amazonaws.simspaceweaver#SimulationAppStatus", + "traits": { + "smithy.api#documentation": "

The current lifecycle state of the custom app.

" + } + }, + "TargetStatus": { + "target": "com.amazonaws.simspaceweaver#SimulationAppTargetStatus", + "traits": { + "smithy.api#documentation": "

The desired lifecycle state of the custom app.

" + } + }, + "LaunchOverrides": { + "target": "com.amazonaws.simspaceweaver#LaunchOverrides" + }, + "Description": { + "target": "com.amazonaws.simspaceweaver#Description", + "traits": { + "smithy.api#documentation": "

The description of the app.

" + } + }, + "EndpointInfo": { + "target": "com.amazonaws.simspaceweaver#SimulationAppEndpointInfo", + "traits": { + "smithy.api#documentation": "

Information about the network endpoint for the custom app. You can use the endpoint to connect to the custom app.

" + } + } + } + }, + "com.amazonaws.simspaceweaver#DescribeSimulation": { + "type": "operation", + "input": { + "target": "com.amazonaws.simspaceweaver#DescribeSimulationInput" + }, + "output": { + "target": "com.amazonaws.simspaceweaver#DescribeSimulationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.simspaceweaver#AccessDeniedException" + }, + { + "target": "com.amazonaws.simspaceweaver#InternalServerException" + }, + { + "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.simspaceweaver#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to describe a simulation", + "smithy.api#documentation": "

Returns the current state of the given simulation.

", + "smithy.api#http": { + "method": "GET", + "uri": "/describesimulation", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.simspaceweaver#DescribeSimulationInput": { + "type": "structure", + "members": { + "Simulation": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the simulation.

", + "smithy.api#httpQuery": "simulation", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "SimulationName" + } + } + } + }, + "com.amazonaws.simspaceweaver#DescribeSimulationOutput": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the simulation.

" + } + }, + "ExecutionId": { + "target": "com.amazonaws.simspaceweaver#UUID", + "traits": { + "smithy.api#documentation": "

A universally unique identifier (UUID) for this simulation.

" + } + }, + "Arn": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see Amazon Resource Names (ARNs)\n in the Amazon Web Services General Reference.

" + } + }, + "Description": { + "target": "com.amazonaws.simspaceweaver#Description", + "traits": { + "smithy.api#documentation": "

The description of the simulation.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.simspaceweaver#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role\n that the simulation assumes to perform actions. For more information about ARNs, see Amazon Resource Names (ARNs)\n in the Amazon Web Services General Reference. For more information about IAM roles,\n see IAM roles in the \n Identity and Access Management User Guide.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.simspaceweaver#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the simulation was created, expressed as the \n number of seconds and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970).

" + } + }, + "Status": { + "target": "com.amazonaws.simspaceweaver#SimulationStatus", + "traits": { + "smithy.api#documentation": "

The current lifecycle state of the simulation.

" + } + }, + "TargetStatus": { + "target": "com.amazonaws.simspaceweaver#SimulationTargetStatus", + "traits": { + "smithy.api#documentation": "

The desired lifecycle state of the simulation.

" + } + }, + "SchemaS3Location": { + "target": "com.amazonaws.simspaceweaver#S3Location", + "traits": { + "smithy.api#documentation": "

The location of the simulation schema in Amazon Simple Storage Service (Amazon S3).\n For more information about Amazon S3, see the \n Amazon Simple Storage Service User Guide\n .

" + } + }, + "SchemaError": { + "target": "com.amazonaws.simspaceweaver#OptionalString", + "traits": { + "smithy.api#deprecated": { + "message": "SchemaError is no longer used, check StartError instead." + }, + "smithy.api#documentation": "

An error message that SimSpace Weaver returns only if there is a problem with the simulation\n schema.

" + } + }, + "LoggingConfiguration": { + "target": "com.amazonaws.simspaceweaver#LoggingConfiguration", + "traits": { + "smithy.api#documentation": "

Settings that control how SimSpace Weaver handles your simulation log data.

" + } + }, + "LiveSimulationState": { + "target": "com.amazonaws.simspaceweaver#LiveSimulationState", + "traits": { + "smithy.api#documentation": "

A collection of additional state information, such as \ndomain and clock configuration.

" + } + }, + "MaximumDuration": { + "target": "com.amazonaws.simspaceweaver#TimeToLiveString", + "traits": { + "smithy.api#documentation": "

The maximum running time of the simulation,\n specified as a number of minutes (m or M), hours (h or H), or days (d or D). The simulation \n stops when it reaches this limit. The maximum value is 14D, or its equivalent in the \n other units. The default value is 14D. A value equivalent to 0 makes the\n simulation immediately transition to Stopping as soon as it reaches Started.

" + } + }, + "SnapshotS3Location": { + "target": "com.amazonaws.simspaceweaver#S3Location" + }, + "StartError": { + "target": "com.amazonaws.simspaceweaver#OptionalString", + "traits": { + "smithy.api#documentation": "

An error message that SimSpace Weaver returns only if a problem occurs when the simulation is in the STARTING state.

" + } + } + } + }, + "com.amazonaws.simspaceweaver#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.simspaceweaver#Domain": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the domain.

" + } + }, + "Lifecycle": { + "target": "com.amazonaws.simspaceweaver#LifecycleManagementStrategy", + "traits": { + "smithy.api#documentation": "

The type of lifecycle management for apps in the domain. Indicates whether apps in this\n domain are managed (SimSpace Weaver starts and stops the apps) or\n unmanaged (you must start and stop the apps).

\n

\n Lifecycle types\n

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

A collection of app instances that run the same executable app code and have the same\n launch options and commands.

\n

For more information about domains, see Key concepts: Domains\n in the SimSpace Weaver User Guide.

" + } + }, + "com.amazonaws.simspaceweaver#DomainList": { + "type": "list", + "member": { + "target": "com.amazonaws.simspaceweaver#Domain" + } + }, + "com.amazonaws.simspaceweaver#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.simspaceweaver#NonEmptyString" + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.simspaceweaver#LaunchCommandList": { + "type": "list", + "member": { + "target": "com.amazonaws.simspaceweaver#NonEmptyString" + } + }, + "com.amazonaws.simspaceweaver#LaunchOverrides": { + "type": "structure", + "members": { + "LaunchCommands": { + "target": "com.amazonaws.simspaceweaver#LaunchCommandList", + "traits": { + "smithy.api#documentation": "

App launch commands and command line parameters that override the launch command\n configured in the simulation schema.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Options that apply when the app starts. These options override default behavior.

" + } + }, + "com.amazonaws.simspaceweaver#LifecycleManagementStrategy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Unknown", + "name": "Unknown" + }, + { + "value": "PerWorker", + "name": "PerWorker" + }, + { + "value": "BySpatialSubdivision", + "name": "BySpatialSubdivision" + }, + { + "value": "ByRequest", + "name": "ByRequest" + } + ] + } + }, + "com.amazonaws.simspaceweaver#ListApps": { + "type": "operation", + "input": { + "target": "com.amazonaws.simspaceweaver#ListAppsInput" + }, + "output": { + "target": "com.amazonaws.simspaceweaver#ListAppsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.simspaceweaver#AccessDeniedException" + }, + { + "target": "com.amazonaws.simspaceweaver#InternalServerException" + }, + { + "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.simspaceweaver#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list apps", + "smithy.api#documentation": "

Lists all custom apps or service apps for the given simulation and domain.

", + "smithy.api#http": { + "method": "GET", + "uri": "/listapps", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.simspaceweaver#ListAppsInput": { + "type": "structure", + "members": { + "Simulation": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the simulation that you want to list apps for.

", + "smithy.api#httpQuery": "simulation", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "SimulationName" + } + }, + "Domain": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the domain that you want to list apps for.

", + "smithy.api#httpQuery": "domain" + } + }, + "MaxResults": { + "target": "com.amazonaws.simspaceweaver#PositiveInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of apps to list.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.simspaceweaver#OptionalString", + "traits": { + "smithy.api#documentation": "

If SimSpace Weaver returns nextToken, then there are more results available. \n The value of nextToken is a unique pagination token for each page. To retrieve the next page, \n call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, \n then nextToken is set to null. Each pagination token expires after 24 hours. \n If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.simspaceweaver#ListAppsOutput": { + "type": "structure", + "members": { + "Apps": { + "target": "com.amazonaws.simspaceweaver#SimulationAppList", + "traits": { + "smithy.api#documentation": "

The list of apps for the given simulation and domain.

" + } + }, + "NextToken": { + "target": "com.amazonaws.simspaceweaver#OptionalString", + "traits": { + "smithy.api#documentation": "

If SimSpace Weaver returns nextToken, then there are more results available. \n The value of nextToken is a unique pagination token for each page. To retrieve the next page, \n call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, \n then nextToken is set to null. Each pagination token expires after 24 hours. \n If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

" + } + } + } + }, + "com.amazonaws.simspaceweaver#ListSimulations": { + "type": "operation", + "input": { + "target": "com.amazonaws.simspaceweaver#ListSimulationsInput" + }, + "output": { + "target": "com.amazonaws.simspaceweaver#ListSimulationsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.simspaceweaver#AccessDeniedException" + }, + { + "target": "com.amazonaws.simspaceweaver#InternalServerException" + }, + { + "target": "com.amazonaws.simspaceweaver#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list simulations", + "smithy.api#documentation": "

Lists the SimSpace Weaver simulations in the Amazon Web Services account used to make the API call.

", + "smithy.api#http": { + "method": "GET", + "uri": "/listsimulations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.simspaceweaver#ListSimulationsInput": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.simspaceweaver#PositiveInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of simulations to list.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.simspaceweaver#OptionalString", + "traits": { + "smithy.api#documentation": "

If SimSpace Weaver returns nextToken, then there are more results available. \n The value of nextToken is a unique pagination token for each page. To retrieve the next page, \n call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, \n then nextToken is set to null. Each pagination token expires after 24 hours. \n If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.simspaceweaver#ListSimulationsOutput": { + "type": "structure", + "members": { + "Simulations": { + "target": "com.amazonaws.simspaceweaver#SimulationList", + "traits": { + "smithy.api#documentation": "

The list of simulations.

" + } + }, + "NextToken": { + "target": "com.amazonaws.simspaceweaver#OptionalString", + "traits": { + "smithy.api#documentation": "

If SimSpace Weaver returns nextToken, then there are more results available. \n The value of nextToken is a unique pagination token for each page. To retrieve the next page, \n call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, \n then nextToken is set to null. Each pagination token expires after 24 hours. \n If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

" + } + } + } + }, + "com.amazonaws.simspaceweaver#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.simspaceweaver#ListTagsForResourceInput" + }, + "output": { + "target": "com.amazonaws.simspaceweaver#ListTagsForResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.simspaceweaver#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list the tags for a resource", + "smithy.api#documentation": "

Lists all tags on a SimSpace Weaver resource.

", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{ResourceArn}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.simspaceweaver#ListTagsForResourceInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource. For more information about ARNs, see Amazon Resource Names (ARNs)\n in the Amazon Web Services General Reference.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.simspaceweaver#ListTagsForResourceOutput": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.simspaceweaver#TagMap", + "traits": { + "smithy.api#documentation": "

The list of tags for the resource.

" + } + } + } + }, + "com.amazonaws.simspaceweaver#LiveSimulationState": { + "type": "structure", + "members": { + "Domains": { + "target": "com.amazonaws.simspaceweaver#DomainList", + "traits": { + "smithy.api#documentation": "

A list of domains for the simulation. For more information about domains, see Key concepts: Domains\n in the SimSpace Weaver User Guide.

" + } + }, + "Clocks": { + "target": "com.amazonaws.simspaceweaver#SimulationClockList", + "traits": { + "smithy.api#documentation": "

A list of simulation clocks.

\n \n

At this time, a simulation has only one clock.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

A collection of additional state information, such as \ndomain and clock configuration.

" + } + }, + "com.amazonaws.simspaceweaver#LogDestination": { + "type": "structure", + "members": { + "CloudWatchLogsLogGroup": { + "target": "com.amazonaws.simspaceweaver#CloudWatchLogsLogGroup", + "traits": { + "smithy.api#documentation": "

An Amazon CloudWatch Logs log group that stores simulation log data. For more information about log groups, see Working with log\n groups and log streams in the Amazon CloudWatch Logs User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The location where SimSpace Weaver sends simulation log data.

" + } + }, + "com.amazonaws.simspaceweaver#LogDestinations": { + "type": "list", + "member": { + "target": "com.amazonaws.simspaceweaver#LogDestination" + } + }, + "com.amazonaws.simspaceweaver#LogGroupArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1600 + }, + "smithy.api#pattern": "^arn:(?:aws|aws-cn|aws-us-gov):log-group:([a-z]{2}-[a-z]+-\\d{1}):(\\d{12})?:role\\/(.+)$" + } + }, + "com.amazonaws.simspaceweaver#LoggingConfiguration": { + "type": "structure", + "members": { + "Destinations": { + "target": "com.amazonaws.simspaceweaver#LogDestinations", + "traits": { + "smithy.api#documentation": "

A list of the locations where SimSpace Weaver sends simulation log data.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The logging configuration for a simulation.

" + } + }, + "com.amazonaws.simspaceweaver#NonEmptyString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + } + } + }, + "com.amazonaws.simspaceweaver#ObjectKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.simspaceweaver#ObjectKeyPrefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.simspaceweaver#OptionalString": { + "type": "string" + }, + "com.amazonaws.simspaceweaver#PortNumber": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 65535 + } + } + }, + "com.amazonaws.simspaceweaver#PositiveInteger": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.simspaceweaver#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.simspaceweaver#NonEmptyString" + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.simspaceweaver#RoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1600 + }, + "smithy.api#pattern": "^arn:(?:aws|aws-cn|aws-us-gov):iam::(\\d{12})?:role\\/(.+)$" + } + }, + "com.amazonaws.simspaceweaver#S3Destination": { + "type": "structure", + "members": { + "BucketName": { + "target": "com.amazonaws.simspaceweaver#BucketName", + "traits": { + "smithy.api#documentation": "

The name of an Amazon S3 bucket. For more information about buckets, see Creating,\n configuring, and working with Amazon S3 buckets in the Amazon Simple Storage Service User\n Guide.

" + } + }, + "ObjectKeyPrefix": { + "target": "com.amazonaws.simspaceweaver#ObjectKeyPrefix", + "traits": { + "smithy.api#documentation": "

A string prefix for an Amazon S3 object key. It's usually a folder name.\n For more information about folders in Amazon S3, see Organizing objects in the Amazon S3 console using folders\n in the Amazon Simple Storage Service User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An Amazon S3 bucket and optional folder (object key prefix) where SimSpace Weaver creates a file.

" + } + }, + "com.amazonaws.simspaceweaver#S3Location": { + "type": "structure", + "members": { + "BucketName": { + "target": "com.amazonaws.simspaceweaver#BucketName", + "traits": { + "smithy.api#documentation": "

The name of an Amazon S3 bucket. For more information about buckets, see Creating,\n configuring, and working with Amazon S3 buckets in the Amazon Simple Storage Service User\n Guide.

" + } + }, + "ObjectKey": { + "target": "com.amazonaws.simspaceweaver#ObjectKey", + "traits": { + "smithy.api#documentation": "

The key name of an object in Amazon S3. For more information about Amazon S3 objects and object\n keys, see Uploading,\n downloading, and working with objects in Amazon S3 in the Amazon Simple Storage Service User\n Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A location in Amazon Simple Storage Service (Amazon S3) where SimSpace Weaver stores simulation data, such as your app .zip\n files and schema file. For more information about Amazon S3, see the \n Amazon Simple Storage Service User Guide\n .

" + } + }, + "com.amazonaws.simspaceweaver#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.simspaceweaver#NonEmptyString" + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.simspaceweaver#SimSpaceWeaver": { + "type": "service", + "version": "2022-10-28", + "operations": [ + { + "target": "com.amazonaws.simspaceweaver#ListTagsForResource" + }, + { + "target": "com.amazonaws.simspaceweaver#TagResource" + }, + { + "target": "com.amazonaws.simspaceweaver#UntagResource" + } + ], + "resources": [ + { + "target": "com.amazonaws.simspaceweaver#Simulation" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "SimSpaceWeaver", + "arnNamespace": "simspaceweaver", + "cloudFormationName": "SimSpaceWeaver", + "endpointPrefix": "simspaceweaver", + "cloudTrailEventSource": "simspaceweaver.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "simspaceweaver" + }, + "aws.iam#defineConditionKeys": { + "aws:ResourceTag/${TagKey}": { + "type": "String", + "documentation": "Filters access by tags associated with the resource", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-resourcetag" + }, + "aws:RequestTag/${TagKey}": { + "type": "String", + "documentation": "Filters access by tags that are passed in the request", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requesttag" + }, + "aws:TagKeys": { + "type": "ArrayOfString", + "documentation": "Filters access by tag keys that are passed in the request", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-tagkeys" + } + }, + "aws.iam#supportedPrincipalTypes": [ + "Root", + "IAMUser", + "IAMRole", + "FederatedUser" + ], + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "*,authorization,date,x-amz-date,x-amz-security-token,x-amz-target,content-type,x-amz-content-sha256,x-amz-user-agent,x-amzn-platform-id,x-amzn-trace-id,amz-sdk-invocation-id,amz-sdk-request" + ] + }, + "smithy.api#documentation": "

SimSpace Weaver (SimSpace Weaver) is a managed service that you can use to build and operate large-scale \n spatial simulations in the Amazon Web Services Cloud. For example, you can create a digital twin of a city,\n crowd simulations with millions of people and objects, and massively multiplayer games with\n hundreds of thousands of connected players.\n For more information about SimSpace Weaver, see the \n SimSpace Weaver User Guide\n .

\n

This API reference describes the API operations and data types that you can use to\n communicate directly with SimSpace Weaver.

\n

SimSpace Weaver also provides the SimSpace Weaver app SDK, which you use for app development. The\n SimSpace Weaver app SDK API reference is included in the SimSpace Weaver app SDK documentation. This\n documentation is part of the SimSpace Weaver app SDK distributable package.

", + "smithy.api#title": "AWS SimSpace Weaver", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://simspaceweaver-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://simspaceweaver-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://simspaceweaver.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://simspaceweaver.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://simspaceweaver-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://simspaceweaver-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://simspaceweaver.us-gov-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://simspaceweaver.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://simspaceweaver-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://simspaceweaver-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://simspaceweaver.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://simspaceweaver.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://simspaceweaver-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://simspaceweaver.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://simspaceweaver-fips.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://simspaceweaver-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://simspaceweaver.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://simspaceweaver.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://simspaceweaver-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://simspaceweaver.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.simspaceweaver#SimSpaceWeaverArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1600 + }, + "smithy.api#pattern": "^arn:(?:aws|aws-cn|aws-us-gov):simspaceweaver:([a-z]{2}-[a-z]+-\\d{1}):(\\d{12})?:([a-z]+)\\/(.+)$" + } + }, + "com.amazonaws.simspaceweaver#SimSpaceWeaverLongResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" + } + }, + "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" + } + }, + "com.amazonaws.simspaceweaver#Simulation": { + "type": "resource", + "identifiers": { + "SimulationName": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName" + } + }, + "create": { + "target": "com.amazonaws.simspaceweaver#StartSimulation" + }, + "read": { + "target": "com.amazonaws.simspaceweaver#DescribeSimulation" + }, + "update": { + "target": "com.amazonaws.simspaceweaver#StopSimulation" + }, + "delete": { + "target": "com.amazonaws.simspaceweaver#DeleteSimulation" + }, + "list": { + "target": "com.amazonaws.simspaceweaver#ListSimulations" + }, + "operations": [ + { + "target": "com.amazonaws.simspaceweaver#CreateSnapshot" + }, + { + "target": "com.amazonaws.simspaceweaver#DeleteApp" + }, + { + "target": "com.amazonaws.simspaceweaver#DescribeApp" + }, + { + "target": "com.amazonaws.simspaceweaver#ListApps" + }, + { + "target": "com.amazonaws.simspaceweaver#StartApp" + }, + { + "target": "com.amazonaws.simspaceweaver#StartClock" + }, + { + "target": "com.amazonaws.simspaceweaver#StopApp" + }, + { + "target": "com.amazonaws.simspaceweaver#StopClock" + } + ], + "traits": { + "aws.api#arn": { + "template": "simulation/{SimulationName}" + }, + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}" + ], + "aws.iam#disableConditionKeyInference": {}, + "smithy.api#documentation": "Represents a simulation" + } + }, + "com.amazonaws.simspaceweaver#SimulationAppEndpointInfo": { + "type": "structure", + "members": { + "Address": { + "target": "com.amazonaws.simspaceweaver#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The IP address of the app. SimSpace Weaver dynamically assigns this IP address when the\n app starts.

" + } + }, + "IngressPortMappings": { + "target": "com.amazonaws.simspaceweaver#AppPortMappings", + "traits": { + "smithy.api#documentation": "

The inbound TCP/UDP port numbers of the app. The combination of an IP address and\n a port number form a network endpoint.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the network endpoint that you can use to connect to your custom or \n service app. For more information about SimSpace Weaver apps, see Key concepts: Apps \n in the SimSpace Weaver User Guide..

" + } + }, + "com.amazonaws.simspaceweaver#SimulationAppList": { + "type": "list", + "member": { + "target": "com.amazonaws.simspaceweaver#SimulationAppMetadata" + } + }, + "com.amazonaws.simspaceweaver#SimulationAppMetadata": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverLongResourceName", + "traits": { + "smithy.api#documentation": "

The name of the app.

" + } + }, + "Simulation": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the simulation of the app.

" + } + }, + "Domain": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The domain of the app. For more information about domains, see Key concepts: Domains\n in the SimSpace Weaver User Guide.

" + } + }, + "Status": { + "target": "com.amazonaws.simspaceweaver#SimulationAppStatus", + "traits": { + "smithy.api#documentation": "

The current status of the app.

" + } + }, + "TargetStatus": { + "target": "com.amazonaws.simspaceweaver#SimulationAppTargetStatus", + "traits": { + "smithy.api#documentation": "

The desired status of the app.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A collection of metadata about the app.

" + } + }, + "com.amazonaws.simspaceweaver#SimulationAppPortMapping": { + "type": "structure", + "members": { + "Declared": { + "target": "com.amazonaws.simspaceweaver#PortNumber", + "traits": { + "smithy.api#documentation": "

The TCP/UDP port number of the app, declared in the simulation schema. SimSpace Weaver maps\n the Declared port to the Actual port. The source code for the\n app should bind to the Declared port.

" + } + }, + "Actual": { + "target": "com.amazonaws.simspaceweaver#PortNumber", + "traits": { + "smithy.api#documentation": "

The TCP/UDP port number of the running app. SimSpace Weaver dynamically assigns this port\n number when the app starts. SimSpace Weaver maps the Declared port to the\n Actual port. Clients connect to the app using the app's IP address\n and the Actual port number.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A collection of TCP/UDP ports for a custom or service app.

" + } + }, + "com.amazonaws.simspaceweaver#SimulationAppStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "STARTING", + "name": "STARTING" + }, + { + "value": "STARTED", + "name": "STARTED" + }, + { + "value": "STOPPING", + "name": "STOPPING" + }, + { + "value": "STOPPED", + "name": "STOPPED" + }, + { + "value": "ERROR", + "name": "ERROR" + }, + { + "value": "UNKNOWN", + "name": "UNKNOWN" + } + ] + } + }, + "com.amazonaws.simspaceweaver#SimulationAppTargetStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "UNKNOWN", + "name": "UNKNOWN" + }, + { + "value": "STARTED", + "name": "STARTED" + }, + { + "value": "STOPPED", + "name": "STOPPED" + } + ] + } + }, + "com.amazonaws.simspaceweaver#SimulationClock": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.simspaceweaver#ClockStatus", + "traits": { + "smithy.api#documentation": "

The current status of the simulation clock.

" + } + }, + "TargetStatus": { + "target": "com.amazonaws.simspaceweaver#ClockTargetStatus", + "traits": { + "smithy.api#documentation": "

The desired status of the simulation clock.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Status information about the simulation clock.

" + } + }, + "com.amazonaws.simspaceweaver#SimulationClockList": { + "type": "list", + "member": { + "target": "com.amazonaws.simspaceweaver#SimulationClock" + } + }, + "com.amazonaws.simspaceweaver#SimulationList": { + "type": "list", + "member": { + "target": "com.amazonaws.simspaceweaver#SimulationMetadata" + } + }, + "com.amazonaws.simspaceweaver#SimulationMetadata": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the simulation.

" + } + }, + "Arn": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see Amazon Resource Names (ARNs)\n in the Amazon Web Services General Reference.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.simspaceweaver#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the simulation was created, expressed as the \n number of seconds and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970).

" + } + }, + "Status": { + "target": "com.amazonaws.simspaceweaver#SimulationStatus", + "traits": { + "smithy.api#documentation": "

The current status of the simulation.

" + } + }, + "TargetStatus": { + "target": "com.amazonaws.simspaceweaver#SimulationTargetStatus", + "traits": { + "smithy.api#documentation": "

The desired status of the simulation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A collection of data about the simulation.

" + } + }, + "com.amazonaws.simspaceweaver#SimulationStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "UNKNOWN", + "name": "UNKNOWN" + }, + { + "value": "STARTING", + "name": "STARTING" + }, + { + "value": "STARTED", + "name": "STARTED" + }, + { + "value": "STOPPING", + "name": "STOPPING" + }, + { + "value": "STOPPED", + "name": "STOPPED" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "DELETING", + "name": "DELETING" + }, + { + "value": "DELETED", + "name": "DELETED" + }, + { + "value": "SNAPSHOT_IN_PROGRESS", + "name": "SNAPSHOT_IN_PROGRESS" + } + ] + } + }, + "com.amazonaws.simspaceweaver#SimulationTargetStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "UNKNOWN", + "name": "UNKNOWN" + }, + { + "value": "STARTED", + "name": "STARTED" + }, + { + "value": "STOPPED", + "name": "STOPPED" + }, { - "ref": "Endpoint" + "value": "DELETED", + "name": "DELETED" + } + ] + } + }, + "com.amazonaws.simspaceweaver#StartApp": { + "type": "operation", + "input": { + "target": "com.amazonaws.simspaceweaver#StartAppInput" + }, + "output": { + "target": "com.amazonaws.simspaceweaver#StartAppOutput" + }, + "errors": [ + { + "target": "com.amazonaws.simspaceweaver#AccessDeniedException" + }, + { + "target": "com.amazonaws.simspaceweaver#ConflictException" + }, + { + "target": "com.amazonaws.simspaceweaver#InternalServerException" + }, + { + "target": "com.amazonaws.simspaceweaver#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.simspaceweaver#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to start an app", + "smithy.api#documentation": "

Starts a custom app with the configuration specified in the simulation schema.

", + "smithy.api#http": { + "method": "POST", + "uri": "/startapp", + "code": 200 + } + } + }, + "com.amazonaws.simspaceweaver#StartAppInput": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.simspaceweaver#ClientToken", + "traits": { + "smithy.api#documentation": "

A value that you provide to ensure that repeated calls to this\n API operation using the same parameters complete only once. A ClientToken is also known as an\n idempotency token. A ClientToken expires after 24 hours.

", + "smithy.api#idempotencyToken": {} + } + }, + "Simulation": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the simulation of the app.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "SimulationName" + } + }, + "Domain": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the domain of the app.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the app.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.simspaceweaver#Description", + "traits": { + "smithy.api#documentation": "

The description of the app.

" + } + }, + "LaunchOverrides": { + "target": "com.amazonaws.simspaceweaver#LaunchOverrides" + } + } + }, + "com.amazonaws.simspaceweaver#StartAppOutput": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the app.

" + } + }, + "Domain": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the domain of the app.

" + } + }, + "Simulation": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the simulation of the app.

" + } + } + } + }, + "com.amazonaws.simspaceweaver#StartClock": { + "type": "operation", + "input": { + "target": "com.amazonaws.simspaceweaver#StartClockInput" + }, + "output": { + "target": "com.amazonaws.simspaceweaver#StartClockOutput" + }, + "errors": [ + { + "target": "com.amazonaws.simspaceweaver#AccessDeniedException" + }, + { + "target": "com.amazonaws.simspaceweaver#ConflictException" + }, + { + "target": "com.amazonaws.simspaceweaver#InternalServerException" + }, + { + "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.simspaceweaver#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to start a simulation clock", + "smithy.api#documentation": "

Starts the simulation clock.

", + "smithy.api#http": { + "method": "POST", + "uri": "/startclock", + "code": 200 + } + } + }, + "com.amazonaws.simspaceweaver#StartClockInput": { + "type": "structure", + "members": { + "Simulation": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the simulation.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "SimulationName" + } + } + } + }, + "com.amazonaws.simspaceweaver#StartClockOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.simspaceweaver#StartSimulation": { + "type": "operation", + "input": { + "target": "com.amazonaws.simspaceweaver#StartSimulationInput" + }, + "output": { + "target": "com.amazonaws.simspaceweaver#StartSimulationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.simspaceweaver#AccessDeniedException" + }, + { + "target": "com.amazonaws.simspaceweaver#ConflictException" + }, + { + "target": "com.amazonaws.simspaceweaver#InternalServerException" + }, + { + "target": "com.amazonaws.simspaceweaver#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.simspaceweaver#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to start a simulation", + "aws.iam#conditionKeys": [ + "aws:TagKeys", + "aws:RequestTag/${TagKey}" + ], + "smithy.api#documentation": "

Starts a simulation with the given name. You must choose to start your\n simulation from a schema or from a snapshot.\n For more information about the schema, see the schema reference \n in the SimSpace Weaver User Guide.\n For more information about snapshots, see Snapshots\n in the SimSpace Weaver User Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/startsimulation", + "code": 200 + } + } + }, + "com.amazonaws.simspaceweaver#StartSimulationInput": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.simspaceweaver#ClientToken", + "traits": { + "smithy.api#documentation": "

A value that you provide to ensure that repeated calls to this\n API operation using the same parameters complete only once. A ClientToken is also known as an\n idempotency token. A ClientToken expires after 24 hours.

", + "smithy.api#idempotencyToken": {} + } + }, + "Name": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the simulation.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.simspaceweaver#Description", + "traits": { + "smithy.api#documentation": "

The description of the simulation.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.simspaceweaver#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role\n that the simulation assumes to perform actions. For more information about ARNs, see Amazon Resource Names (ARNs)\n in the Amazon Web Services General Reference. For more information about IAM roles,\n see IAM roles in the \n Identity and Access Management User Guide.

", + "smithy.api#required": {} + } + }, + "SchemaS3Location": { + "target": "com.amazonaws.simspaceweaver#S3Location", + "traits": { + "smithy.api#documentation": "

The location of the simulation schema in Amazon Simple Storage Service (Amazon S3).\n For more information about Amazon S3, see the \n Amazon Simple Storage Service User Guide\n .

\n

Provide a SchemaS3Location to start your simulation from a schema.

\n

If you provide a SchemaS3Location then you can't provide a SnapshotS3Location.

" + } + }, + "MaximumDuration": { + "target": "com.amazonaws.simspaceweaver#TimeToLiveString", + "traits": { + "smithy.api#documentation": "

The maximum running time of the simulation,\n specified as a number of minutes (m or M), hours (h or H), or days (d or D). The simulation \n stops when it reaches this limit. The maximum value is 14D, or its equivalent in the \n other units. The default value is 14D. A value equivalent to 0 makes the\n simulation immediately transition to Stopping as soon as it reaches Started.

" + } + }, + "Tags": { + "target": "com.amazonaws.simspaceweaver#TagMap", + "traits": { + "smithy.api#documentation": "

A list of tags for the simulation. For more information about tags, see Tagging Amazon Web Services resources in the\n Amazon Web Services General Reference.

" + } + }, + "SnapshotS3Location": { + "target": "com.amazonaws.simspaceweaver#S3Location", + "traits": { + "smithy.api#documentation": "

The location of the snapshot .zip file in Amazon Simple Storage Service (Amazon S3).\n For more information about Amazon S3, see the \n Amazon Simple Storage Service User Guide\n .

\n

Provide a SnapshotS3Location to start your simulation from a snapshot.

\n

The Amazon S3 bucket must be in the same Amazon Web Services Region as the simulation.

\n

If you provide a SnapshotS3Location then you can't provide a SchemaS3Location.

" + } + } + } + }, + "com.amazonaws.simspaceweaver#StartSimulationOutput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see Amazon Resource Names (ARNs)\n in the Amazon Web Services General Reference.

" + } + }, + "ExecutionId": { + "target": "com.amazonaws.simspaceweaver#UUID", + "traits": { + "smithy.api#documentation": "

A universally unique identifier (UUID) for this simulation.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.simspaceweaver#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the simulation was created, expressed as the \n number of seconds and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970).

" } - ] } - ], - "type": "tree", - "rules": [ + } + }, + "com.amazonaws.simspaceweaver#StopApp": { + "type": "operation", + "input": { + "target": "com.amazonaws.simspaceweaver#StopAppInput" + }, + "output": { + "target": "com.amazonaws.simspaceweaver#StopAppOutput" + }, + "errors": [ { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] + "target": "com.amazonaws.simspaceweaver#AccessDeniedException" + }, + { + "target": "com.amazonaws.simspaceweaver#ConflictException" + }, + { + "target": "com.amazonaws.simspaceweaver#InternalServerException" + }, + { + "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.simspaceweaver#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to stop an app", + "smithy.api#documentation": "

Stops the given custom app and shuts down all of its allocated compute resources.

", + "smithy.api#http": { + "method": "POST", + "uri": "/stopapp", + "code": 200 + } + } + }, + "com.amazonaws.simspaceweaver#StopAppInput": { + "type": "structure", + "members": { + "Simulation": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the simulation of the app.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "SimulationName" + } + }, + "Domain": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the domain of the app.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "DomainName" } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" }, + "App": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the app.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "AppName" + } + } + } + }, + "com.amazonaws.simspaceweaver#StopAppOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.simspaceweaver#StopClock": { + "type": "operation", + "input": { + "target": "com.amazonaws.simspaceweaver#StopClockInput" + }, + "output": { + "target": "com.amazonaws.simspaceweaver#StopClockOutput" + }, + "errors": [ { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "target": "com.amazonaws.simspaceweaver#AccessDeniedException" + }, + { + "target": "com.amazonaws.simspaceweaver#ConflictException" + }, + { + "target": "com.amazonaws.simspaceweaver#InternalServerException" + }, + { + "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.simspaceweaver#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to stop a simulation clock", + "smithy.api#documentation": "

Stops the simulation clock.

", + "smithy.api#http": { + "method": "POST", + "uri": "/stopclock", + "code": 200 + } + } + }, + "com.amazonaws.simspaceweaver#StopClockInput": { + "type": "structure", + "members": { + "Simulation": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the simulation.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "SimulationName" + } + } + } + }, + "com.amazonaws.simspaceweaver#StopClockOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.simspaceweaver#StopSimulation": { + "type": "operation", + "input": { + "target": "com.amazonaws.simspaceweaver#StopSimulationInput" + }, + "output": { + "target": "com.amazonaws.simspaceweaver#StopSimulationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.simspaceweaver#AccessDeniedException" + }, + { + "target": "com.amazonaws.simspaceweaver#ConflictException" + }, + { + "target": "com.amazonaws.simspaceweaver#InternalServerException" + }, + { + "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.simspaceweaver#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to stop a simulation", + "smithy.api#documentation": "

Stops the given simulation.

\n \n

You can't restart a simulation after you stop it. If you want to restart a simulation, then\n you must stop it, delete it, and start a new instance of it.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/stopsimulation", + "code": 200 + } + } + }, + "com.amazonaws.simspaceweaver#StopSimulationInput": { + "type": "structure", + "members": { + "Simulation": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the simulation.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "SimulationName" } - ] } - ] + } + }, + "com.amazonaws.simspaceweaver#StopSimulationOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.simspaceweaver#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.simspaceweaver#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.simspaceweaver#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.simspaceweaver#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.simspaceweaver#TagKey" + }, + "value": { + "target": "com.amazonaws.simspaceweaver#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.simspaceweaver#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.simspaceweaver#TagResourceInput" + }, + "output": { + "target": "com.amazonaws.simspaceweaver#TagResourceOutput" }, - { - "conditions": [], - "type": "tree", - "rules": [ + "errors": [ + { + "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" + }, { - "conditions": [ + "target": "com.amazonaws.simspaceweaver#TooManyTagsException" + }, + { + "target": "com.amazonaws.simspaceweaver#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to tag a resource", + "aws.iam#conditionKeys": [ + "aws:TagKeys", + "aws:RequestTag/${TagKey}" + ], + "smithy.api#documentation": "

Adds tags to a SimSpace Weaver resource. For more information about tags, see Tagging Amazon Web Services resources in the\n Amazon Web Services General Reference.

", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{ResourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.simspaceweaver#TagResourceInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to add tags to.\n For more information about ARNs, see Amazon Resource Names (ARNs)\n in the Amazon Web Services General Reference.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.simspaceweaver#TagMap", + "traits": { + "smithy.api#documentation": "

A list of tags to apply to the resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "aws.api#data": "tagging", + "smithy.api#references": [ { - "fn": "isSet", - "argv": [ - { - "ref": "Region" + "resource": "com.amazonaws.simspaceweaver#Simulation", + "ids": { + "SimulationName": "ResourceArn" } - ] } - ], - "type": "tree", - "rules": [ + ] + } + }, + "com.amazonaws.simspaceweaver#TagResourceOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.simspaceweaver#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.simspaceweaver#TimeToLiveString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 6 + }, + "smithy.api#pattern": "^\\d{1,5}[mhdMHD]$" + } + }, + "com.amazonaws.simspaceweaver#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.simspaceweaver#TooManyTagsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.simspaceweaver#NonEmptyString" + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.simspaceweaver#UUID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36 + }, + "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + } + }, + "com.amazonaws.simspaceweaver#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.simspaceweaver#UntagResourceInput" + }, + "output": { + "target": "com.amazonaws.simspaceweaver#UntagResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.simspaceweaver#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to untag a resource", + "aws.iam#conditionKeys": [ + "aws:TagKeys" + ], + "smithy.api#documentation": "

Removes tags from a SimSpace Weaver resource. For more information about tags, see Tagging Amazon Web Services resources in the\n Amazon Web Services General Reference.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{ResourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.simspaceweaver#UntagResourceInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to remove tags from.\n For more information about ARNs, see Amazon Resource Names (ARNs)\n in the Amazon Web Services General Reference.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.simspaceweaver#TagKeyList", + "traits": { + "smithy.api#documentation": "

A list of tag keys to remove from the resource.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "aws.api#data": "tagging", + "smithy.api#references": [ { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://simspaceweaver-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://simspaceweaver-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://simspaceweaver.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ] - }, - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://simspaceweaver.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + "resource": "com.amazonaws.simspaceweaver#Simulation", + "ids": { + "SimulationName": "ResourceArn" } - ] - } - ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://simspaceweaver-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://simspaceweaver-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://simspaceweaver.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://simspaceweaver.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://simspaceweaver-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://simspaceweaver-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://simspaceweaver.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://simspaceweaver.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://simspaceweaver-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://simspaceweaver.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://simspaceweaver-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://simspaceweaver-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://simspaceweaver.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://simspaceweaver.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://simspaceweaver-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://simspaceweaver.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.simspaceweaver#SimSpaceWeaverArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1600 - }, - "smithy.api#pattern": "^arn:(?:aws|aws-cn):simspaceweaver:([a-z]{2}-[a-z]+-\\d{1}):(\\d{12})?:([a-z]+)\\/(.+)$" - } - }, - "com.amazonaws.simspaceweaver#SimSpaceWeaverLongResourceName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" - } - }, - "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" - } - }, - "com.amazonaws.simspaceweaver#Simulation": { - "type": "resource", - "identifiers": { - "SimulationName": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName" - } - }, - "create": { - "target": "com.amazonaws.simspaceweaver#StartSimulation" - }, - "read": { - "target": "com.amazonaws.simspaceweaver#DescribeSimulation" - }, - "update": { - "target": "com.amazonaws.simspaceweaver#StopSimulation" - }, - "delete": { - "target": "com.amazonaws.simspaceweaver#DeleteSimulation" - }, - "list": { - "target": "com.amazonaws.simspaceweaver#ListSimulations" - }, - "operations": [ - { - "target": "com.amazonaws.simspaceweaver#CreateSnapshot" - }, - { - "target": "com.amazonaws.simspaceweaver#DeleteApp" - }, - { - "target": "com.amazonaws.simspaceweaver#DescribeApp" - }, - { - "target": "com.amazonaws.simspaceweaver#ListApps" - }, - { - "target": "com.amazonaws.simspaceweaver#StartApp" - }, - { - "target": "com.amazonaws.simspaceweaver#StartClock" - }, - { - "target": "com.amazonaws.simspaceweaver#StopApp" - }, - { - "target": "com.amazonaws.simspaceweaver#StopClock" - } - ], - "traits": { - "aws.api#arn": { - "template": "simulation/{SimulationName}" - }, - "aws.iam#conditionKeys": ["aws:ResourceTag/${TagKey}"], - "aws.iam#disableConditionKeyInference": {}, - "smithy.api#documentation": "Represents a simulation" - } - }, - "com.amazonaws.simspaceweaver#SimulationAppEndpointInfo": { - "type": "structure", - "members": { - "Address": { - "target": "com.amazonaws.simspaceweaver#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The IP address of the app. SimSpace Weaver dynamically assigns this IP address when the\n app starts.

" - } - }, - "IngressPortMappings": { - "target": "com.amazonaws.simspaceweaver#AppPortMappings", - "traits": { - "smithy.api#documentation": "

The inbound TCP/UDP port numbers of the app. The combination of an IP address and\n a port number form a network endpoint.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the network endpoint that you can use to connect to your custom or \n service app. For more information about SimSpace Weaver apps, see Key concepts: Apps \n in the SimSpace Weaver User Guide..

" - } - }, - "com.amazonaws.simspaceweaver#SimulationAppList": { - "type": "list", - "member": { - "target": "com.amazonaws.simspaceweaver#SimulationAppMetadata" - } - }, - "com.amazonaws.simspaceweaver#SimulationAppMetadata": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverLongResourceName", - "traits": { - "smithy.api#documentation": "

The name of the app.

" - } - }, - "Simulation": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the simulation of the app.

" - } - }, - "Domain": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The domain of the app. For more information about domains, see Key concepts: Domains\n in the SimSpace Weaver User Guide.

" - } - }, - "Status": { - "target": "com.amazonaws.simspaceweaver#SimulationAppStatus", - "traits": { - "smithy.api#documentation": "

The current status of the app.

" - } - }, - "TargetStatus": { - "target": "com.amazonaws.simspaceweaver#SimulationAppTargetStatus", - "traits": { - "smithy.api#documentation": "

The desired status of the app.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A collection of metadata about the app.

" - } - }, - "com.amazonaws.simspaceweaver#SimulationAppPortMapping": { - "type": "structure", - "members": { - "Declared": { - "target": "com.amazonaws.simspaceweaver#PortNumber", - "traits": { - "smithy.api#documentation": "

The TCP/UDP port number of the app, declared in the simulation schema. SimSpace Weaver maps\n the Declared port to the Actual port. The source code for the\n app should bind to the Declared port.

" - } - }, - "Actual": { - "target": "com.amazonaws.simspaceweaver#PortNumber", - "traits": { - "smithy.api#documentation": "

The TCP/UDP port number of the running app. SimSpace Weaver dynamically assigns this port\n number when the app starts. SimSpace Weaver maps the Declared port to the\n Actual port. Clients connect to the app using the app's IP address\n and the Actual port number.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A collection of TCP/UDP ports for a custom or service app.

" - } - }, - "com.amazonaws.simspaceweaver#SimulationAppStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "STARTING", - "name": "STARTING" - }, - { - "value": "STARTED", - "name": "STARTED" - }, - { - "value": "STOPPING", - "name": "STOPPING" - }, - { - "value": "STOPPED", - "name": "STOPPED" - }, - { - "value": "ERROR", - "name": "ERROR" - }, - { - "value": "UNKNOWN", - "name": "UNKNOWN" - } - ] - } - }, - "com.amazonaws.simspaceweaver#SimulationAppTargetStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "UNKNOWN", - "name": "UNKNOWN" - }, - { - "value": "STARTED", - "name": "STARTED" - }, - { - "value": "STOPPED", - "name": "STOPPED" - } - ] - } - }, - "com.amazonaws.simspaceweaver#SimulationClock": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.simspaceweaver#ClockStatus", - "traits": { - "smithy.api#documentation": "

The current status of the simulation clock.

" - } - }, - "TargetStatus": { - "target": "com.amazonaws.simspaceweaver#ClockTargetStatus", - "traits": { - "smithy.api#documentation": "

The desired status of the simulation clock.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Status information about the simulation clock.

" - } - }, - "com.amazonaws.simspaceweaver#SimulationClockList": { - "type": "list", - "member": { - "target": "com.amazonaws.simspaceweaver#SimulationClock" - } - }, - "com.amazonaws.simspaceweaver#SimulationList": { - "type": "list", - "member": { - "target": "com.amazonaws.simspaceweaver#SimulationMetadata" - } - }, - "com.amazonaws.simspaceweaver#SimulationMetadata": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the simulation.

" - } - }, - "Arn": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see Amazon Resource Names (ARNs)\n in the Amazon Web Services General Reference.

" - } - }, - "CreationTime": { - "target": "com.amazonaws.simspaceweaver#Timestamp", - "traits": { - "smithy.api#documentation": "

The time when the simulation was created, expressed as the \n number of seconds and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970).

" - } - }, - "Status": { - "target": "com.amazonaws.simspaceweaver#SimulationStatus", - "traits": { - "smithy.api#documentation": "

The current status of the simulation.

" - } - }, - "TargetStatus": { - "target": "com.amazonaws.simspaceweaver#SimulationTargetStatus", - "traits": { - "smithy.api#documentation": "

The desired status of the simulation.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A collection of data about the simulation.

" - } - }, - "com.amazonaws.simspaceweaver#SimulationStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "UNKNOWN", - "name": "UNKNOWN" - }, - { - "value": "STARTING", - "name": "STARTING" - }, - { - "value": "STARTED", - "name": "STARTED" - }, - { - "value": "STOPPING", - "name": "STOPPING" - }, - { - "value": "STOPPED", - "name": "STOPPED" - }, - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "DELETING", - "name": "DELETING" - }, - { - "value": "DELETED", - "name": "DELETED" - }, - { - "value": "SNAPSHOT_IN_PROGRESS", - "name": "SNAPSHOT_IN_PROGRESS" - } - ] - } - }, - "com.amazonaws.simspaceweaver#SimulationTargetStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "UNKNOWN", - "name": "UNKNOWN" - }, - { - "value": "STARTED", - "name": "STARTED" - }, - { - "value": "STOPPED", - "name": "STOPPED" - }, - { - "value": "DELETED", - "name": "DELETED" - } - ] - } - }, - "com.amazonaws.simspaceweaver#StartApp": { - "type": "operation", - "input": { - "target": "com.amazonaws.simspaceweaver#StartAppInput" - }, - "output": { - "target": "com.amazonaws.simspaceweaver#StartAppOutput" - }, - "errors": [ - { - "target": "com.amazonaws.simspaceweaver#AccessDeniedException" - }, - { - "target": "com.amazonaws.simspaceweaver#ConflictException" - }, - { - "target": "com.amazonaws.simspaceweaver#InternalServerException" - }, - { - "target": "com.amazonaws.simspaceweaver#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.simspaceweaver#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to start an app", - "smithy.api#documentation": "

Starts a custom app with the configuration specified in the simulation schema.

", - "smithy.api#http": { - "method": "POST", - "uri": "/startapp", - "code": 200 - } - } - }, - "com.amazonaws.simspaceweaver#StartAppInput": { - "type": "structure", - "members": { - "ClientToken": { - "target": "com.amazonaws.simspaceweaver#ClientToken", - "traits": { - "smithy.api#documentation": "

A value that you provide to ensure that repeated calls to this\n API operation using the same parameters complete only once. A ClientToken is also known as an\n idempotency token. A ClientToken expires after 24 hours.

", - "smithy.api#idempotencyToken": {} - } - }, - "Simulation": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the simulation of the app.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "SimulationName" - } - }, - "Domain": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the domain of the app.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the app.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.simspaceweaver#Description", - "traits": { - "smithy.api#documentation": "

The description of the app.

" - } - }, - "LaunchOverrides": { - "target": "com.amazonaws.simspaceweaver#LaunchOverrides" - } - } - }, - "com.amazonaws.simspaceweaver#StartAppOutput": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the app.

" - } - }, - "Domain": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the domain of the app.

" - } - }, - "Simulation": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the simulation of the app.

" - } - } - } - }, - "com.amazonaws.simspaceweaver#StartClock": { - "type": "operation", - "input": { - "target": "com.amazonaws.simspaceweaver#StartClockInput" - }, - "output": { - "target": "com.amazonaws.simspaceweaver#StartClockOutput" - }, - "errors": [ - { - "target": "com.amazonaws.simspaceweaver#AccessDeniedException" - }, - { - "target": "com.amazonaws.simspaceweaver#ConflictException" - }, - { - "target": "com.amazonaws.simspaceweaver#InternalServerException" - }, - { - "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.simspaceweaver#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to start a simulation clock", - "smithy.api#documentation": "

Starts the simulation clock.

", - "smithy.api#http": { - "method": "POST", - "uri": "/startclock", - "code": 200 - } - } - }, - "com.amazonaws.simspaceweaver#StartClockInput": { - "type": "structure", - "members": { - "Simulation": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the simulation.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "SimulationName" - } - } - } - }, - "com.amazonaws.simspaceweaver#StartClockOutput": { - "type": "structure", - "members": {} - }, - "com.amazonaws.simspaceweaver#StartSimulation": { - "type": "operation", - "input": { - "target": "com.amazonaws.simspaceweaver#StartSimulationInput" - }, - "output": { - "target": "com.amazonaws.simspaceweaver#StartSimulationOutput" - }, - "errors": [ - { - "target": "com.amazonaws.simspaceweaver#AccessDeniedException" - }, - { - "target": "com.amazonaws.simspaceweaver#ConflictException" - }, - { - "target": "com.amazonaws.simspaceweaver#InternalServerException" - }, - { - "target": "com.amazonaws.simspaceweaver#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.simspaceweaver#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to start a simulation", - "aws.iam#conditionKeys": ["aws:TagKeys", "aws:RequestTag/${TagKey}"], - "smithy.api#documentation": "

Starts a simulation with the given name. You must choose to start your\n simulation from a schema or from a snapshot.\n For more information about the schema, see the schema reference \n in the SimSpace Weaver User Guide.\n For more information about snapshots, see Snapshots\n in the SimSpace Weaver User Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/startsimulation", - "code": 200 - } - } - }, - "com.amazonaws.simspaceweaver#StartSimulationInput": { - "type": "structure", - "members": { - "ClientToken": { - "target": "com.amazonaws.simspaceweaver#ClientToken", - "traits": { - "smithy.api#documentation": "

A value that you provide to ensure that repeated calls to this\n API operation using the same parameters complete only once. A ClientToken is also known as an\n idempotency token. A ClientToken expires after 24 hours.

", - "smithy.api#idempotencyToken": {} - } - }, - "Name": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the simulation.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.simspaceweaver#Description", - "traits": { - "smithy.api#documentation": "

The description of the simulation.

" - } - }, - "RoleArn": { - "target": "com.amazonaws.simspaceweaver#RoleArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role\n that the simulation assumes to perform actions. For more information about ARNs, see Amazon Resource Names (ARNs)\n in the Amazon Web Services General Reference. For more information about IAM roles,\n see IAM roles in the \n Identity and Access Management User Guide.

", - "smithy.api#required": {} - } - }, - "SchemaS3Location": { - "target": "com.amazonaws.simspaceweaver#S3Location", - "traits": { - "smithy.api#documentation": "

The location of the simulation schema in Amazon Simple Storage Service (Amazon S3).\n For more information about Amazon S3, see the \n Amazon Simple Storage Service User Guide\n .

\n

Provide a SchemaS3Location to start your simulation from a schema.

\n

If you provide a SchemaS3Location then you can't provide a SnapshotS3Location.

" - } - }, - "MaximumDuration": { - "target": "com.amazonaws.simspaceweaver#TimeToLiveString", - "traits": { - "smithy.api#documentation": "

The maximum running time of the simulation,\n specified as a number of minutes (m or M), hours (h or H), or days (d or D). The simulation \n stops when it reaches this limit. The maximum value is 14D, or its equivalent in the \n other units. The default value is 14D. A value equivalent to 0 makes the\n simulation immediately transition to Stopping as soon as it reaches Started.

" - } - }, - "Tags": { - "target": "com.amazonaws.simspaceweaver#TagMap", - "traits": { - "smithy.api#documentation": "

A list of tags for the simulation. For more information about tags, see Tagging Amazon Web Services resources in the\n Amazon Web Services General Reference.

" - } - }, - "SnapshotS3Location": { - "target": "com.amazonaws.simspaceweaver#S3Location", - "traits": { - "smithy.api#documentation": "

The location of the snapshot .zip file in Amazon Simple Storage Service (Amazon S3).\n For more information about Amazon S3, see the \n Amazon Simple Storage Service User Guide\n .

\n

Provide a SnapshotS3Location to start your simulation from a snapshot.

\n

If you provide a SnapshotS3Location then you can't provide a SchemaS3Location.

" - } - } - } - }, - "com.amazonaws.simspaceweaver#StartSimulationOutput": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see Amazon Resource Names (ARNs)\n in the Amazon Web Services General Reference.

" - } - }, - "ExecutionId": { - "target": "com.amazonaws.simspaceweaver#UUID", - "traits": { - "smithy.api#documentation": "

A universally unique identifier (UUID) for this simulation.

" - } - }, - "CreationTime": { - "target": "com.amazonaws.simspaceweaver#Timestamp", - "traits": { - "smithy.api#documentation": "

The time when the simulation was created, expressed as the \n number of seconds and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970).

" - } - } - } - }, - "com.amazonaws.simspaceweaver#StopApp": { - "type": "operation", - "input": { - "target": "com.amazonaws.simspaceweaver#StopAppInput" - }, - "output": { - "target": "com.amazonaws.simspaceweaver#StopAppOutput" - }, - "errors": [ - { - "target": "com.amazonaws.simspaceweaver#AccessDeniedException" - }, - { - "target": "com.amazonaws.simspaceweaver#ConflictException" - }, - { - "target": "com.amazonaws.simspaceweaver#InternalServerException" - }, - { - "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.simspaceweaver#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to stop an app", - "smithy.api#documentation": "

Stops the given custom app and shuts down all of its allocated compute resources.

", - "smithy.api#http": { - "method": "POST", - "uri": "/stopapp", - "code": 200 - } - } - }, - "com.amazonaws.simspaceweaver#StopAppInput": { - "type": "structure", - "members": { - "Simulation": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the simulation of the app.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "SimulationName" - } - }, - "Domain": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the domain of the app.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "DomainName" - } - }, - "App": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the app.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "AppName" - } - } - } - }, - "com.amazonaws.simspaceweaver#StopAppOutput": { - "type": "structure", - "members": {} - }, - "com.amazonaws.simspaceweaver#StopClock": { - "type": "operation", - "input": { - "target": "com.amazonaws.simspaceweaver#StopClockInput" - }, - "output": { - "target": "com.amazonaws.simspaceweaver#StopClockOutput" - }, - "errors": [ - { - "target": "com.amazonaws.simspaceweaver#AccessDeniedException" - }, - { - "target": "com.amazonaws.simspaceweaver#ConflictException" - }, - { - "target": "com.amazonaws.simspaceweaver#InternalServerException" - }, - { - "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.simspaceweaver#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to stop a simulation clock", - "smithy.api#documentation": "

Stops the simulation clock.

", - "smithy.api#http": { - "method": "POST", - "uri": "/stopclock", - "code": 200 - } - } - }, - "com.amazonaws.simspaceweaver#StopClockInput": { - "type": "structure", - "members": { - "Simulation": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the simulation.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "SimulationName" - } - } - } - }, - "com.amazonaws.simspaceweaver#StopClockOutput": { - "type": "structure", - "members": {} - }, - "com.amazonaws.simspaceweaver#StopSimulation": { - "type": "operation", - "input": { - "target": "com.amazonaws.simspaceweaver#StopSimulationInput" - }, - "output": { - "target": "com.amazonaws.simspaceweaver#StopSimulationOutput" - }, - "errors": [ - { - "target": "com.amazonaws.simspaceweaver#AccessDeniedException" - }, - { - "target": "com.amazonaws.simspaceweaver#ConflictException" - }, - { - "target": "com.amazonaws.simspaceweaver#InternalServerException" - }, - { - "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.simspaceweaver#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to stop a simulation", - "smithy.api#documentation": "

Stops the given simulation.

\n \n

You can't restart a simulation after you stop it. If you want to restart a simulation, then\n you must stop it, delete it, and start a new instance of it.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/stopsimulation", - "code": 200 - } - } - }, - "com.amazonaws.simspaceweaver#StopSimulationInput": { - "type": "structure", - "members": { - "Simulation": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the simulation.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "SimulationName" - } - } - } - }, - "com.amazonaws.simspaceweaver#StopSimulationOutput": { - "type": "structure", - "members": {} - }, - "com.amazonaws.simspaceweaver#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.simspaceweaver#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.simspaceweaver#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.simspaceweaver#TagMap": { - "type": "map", - "key": { - "target": "com.amazonaws.simspaceweaver#TagKey" - }, - "value": { - "target": "com.amazonaws.simspaceweaver#TagValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.simspaceweaver#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.simspaceweaver#TagResourceInput" - }, - "output": { - "target": "com.amazonaws.simspaceweaver#TagResourceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.simspaceweaver#TooManyTagsException" - }, - { - "target": "com.amazonaws.simspaceweaver#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to tag a resource", - "aws.iam#conditionKeys": ["aws:TagKeys", "aws:RequestTag/${TagKey}"], - "smithy.api#documentation": "

Adds tags to a SimSpace Weaver resource. For more information about tags, see Tagging Amazon Web Services resources in the\n Amazon Web Services General Reference.

", - "smithy.api#http": { - "method": "POST", - "uri": "/tags/{ResourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.simspaceweaver#TagResourceInput": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to add tags to.\n For more information about ARNs, see Amazon Resource Names (ARNs)\n in the Amazon Web Services General Reference.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.simspaceweaver#TagMap", - "traits": { - "smithy.api#documentation": "

A list of tags to apply to the resource.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "aws.api#data": "tagging", - "smithy.api#references": [ - { - "resource": "com.amazonaws.simspaceweaver#Simulation", - "ids": { - "SimulationName": "ResourceArn" - } - } - ] - } - }, - "com.amazonaws.simspaceweaver#TagResourceOutput": { - "type": "structure", - "members": {} - }, - "com.amazonaws.simspaceweaver#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.simspaceweaver#TimeToLiveString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 2, - "max": 6 - }, - "smithy.api#pattern": "^\\d{1,5}[mhdMHD]$" - } - }, - "com.amazonaws.simspaceweaver#Timestamp": { - "type": "timestamp" - }, - "com.amazonaws.simspaceweaver#TooManyTagsException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.simspaceweaver#NonEmptyString" - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.simspaceweaver#UUID": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 36 - }, - "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" - } - }, - "com.amazonaws.simspaceweaver#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.simspaceweaver#UntagResourceInput" - }, - "output": { - "target": "com.amazonaws.simspaceweaver#UntagResourceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.simspaceweaver#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to untag a resource", - "aws.iam#conditionKeys": ["aws:TagKeys"], - "smithy.api#documentation": "

Removes tags from a SimSpace Weaver resource. For more information about tags, see Tagging Amazon Web Services resources in the\n Amazon Web Services General Reference.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/tags/{ResourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.simspaceweaver#UntagResourceInput": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to remove tags from.\n For more information about ARNs, see Amazon Resource Names (ARNs)\n in the Amazon Web Services General Reference.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TagKeys": { - "target": "com.amazonaws.simspaceweaver#TagKeyList", - "traits": { - "smithy.api#documentation": "

A list of tag keys to remove from the resource.

", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - } - }, - "traits": { - "aws.api#data": "tagging", - "smithy.api#references": [ - { - "resource": "com.amazonaws.simspaceweaver#Simulation", - "ids": { - "SimulationName": "ResourceArn" - } - } - ] - } - }, - "com.amazonaws.simspaceweaver#UntagResourceOutput": { - "type": "structure", - "members": {} - }, - "com.amazonaws.simspaceweaver#ValidationException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.simspaceweaver#NonEmptyString" + } + ] + } + }, + "com.amazonaws.simspaceweaver#UntagResourceOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.simspaceweaver#ValidationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.simspaceweaver#NonEmptyString" + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } } - } -} +} \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/verifiedpermissions.json b/codegen/sdk-codegen/aws-models/verifiedpermissions.json new file mode 100644 index 000000000000..4a1ea83e97f3 --- /dev/null +++ b/codegen/sdk-codegen/aws-models/verifiedpermissions.json @@ -0,0 +1,4314 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.verifiedpermissions#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

You don't have sufficient access to perform this action.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.verifiedpermissions#ActionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.verifiedpermissions#ActionIdentifier": { + "type": "structure", + "members": { + "actionType": { + "target": "com.amazonaws.verifiedpermissions#ActionType", + "traits": { + "smithy.api#documentation": "

The type of an action.

", + "smithy.api#required": {} + } + }, + "actionId": { + "target": "com.amazonaws.verifiedpermissions#ActionId", + "traits": { + "smithy.api#documentation": "

The ID of an action.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an action for a request for which an authorization decision\n is made.

\n

This data type is used as an request parameter to the IsAuthorized and IsAuthorizedWithToken operations.

\n

Example: { \"actionId\": \"<action name>\", \"actionType\": \"Action\"\n }\n

" + } + }, + "com.amazonaws.verifiedpermissions#ActionType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^Action$|^.+::Action$" + } + }, + "com.amazonaws.verifiedpermissions#AttributeValue": { + "type": "union", + "members": { + "boolean": { + "target": "com.amazonaws.verifiedpermissions#BooleanAttribute", + "traits": { + "smithy.api#documentation": "

An attribute value of Boolean\n type.

\n

Example: {\"boolean\": true}\n

" + } + }, + "entityIdentifier": { + "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", + "traits": { + "smithy.api#documentation": "

An attribute value of type EntityIdentifier.

\n

Example: \"entityIdentifier\": { \"entityId\": \"<id>\", \"entityType\":\n \"<entity type>\"}\n

" + } + }, + "long": { + "target": "com.amazonaws.verifiedpermissions#LongAttribute", + "traits": { + "smithy.api#documentation": "

An attribute value of Long\n type.

\n

Example: {\"long\": 0}\n

" + } + }, + "string": { + "target": "com.amazonaws.verifiedpermissions#StringAttribute", + "traits": { + "smithy.api#documentation": "

An attribute value of String\n type.

\n

Example: {\"string\": \"abc\"}\n

" + } + }, + "set": { + "target": "com.amazonaws.verifiedpermissions#SetAttribute", + "traits": { + "smithy.api#documentation": "

An attribute value of Set\n type.

\n

Example: {\"set\": [ {} ] }\n

" + } + }, + "record": { + "target": "com.amazonaws.verifiedpermissions#RecordAttribute", + "traits": { + "smithy.api#documentation": "

An attribute value of Record\n type.

\n

Example: {\"record\": { \"keyName\": {} } }\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The value of an attribute.

\n

Contains information about the runtime context for a request for which an\n authorization decision is made.

\n

This data type is used as a member of the ContextDefinition structure\n which is uses as a request parameter for the IsAuthorized and IsAuthorizedWithToken operations.

" + } + }, + "com.amazonaws.verifiedpermissions#BooleanAttribute": { + "type": "boolean" + }, + "com.amazonaws.verifiedpermissions#ClientId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.verifiedpermissions#ClientIds": { + "type": "list", + "member": { + "target": "com.amazonaws.verifiedpermissions#ClientId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + } + } + }, + "com.amazonaws.verifiedpermissions#CognitoUserPoolConfiguration": { + "type": "structure", + "members": { + "userPoolArn": { + "target": "com.amazonaws.verifiedpermissions#UserPoolArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be\n authorized.

\n

Example: \"UserPoolArn\":\n \"cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\"\n

", + "smithy.api#required": {} + } + }, + "clientIds": { + "target": "com.amazonaws.verifiedpermissions#ClientIds", + "traits": { + "smithy.api#documentation": "

The unique application client IDs that are associated with the specified Amazon Cognito user\n pool.

\n

Example: \"ClientIds\": [\"&ExampleCogClientId;\"]\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for an identity source that represents a connection to an Amazon Cognito user pool used\n as an identity provider for Verified Permissions.

\n

This data type is used as a field that is part of an Configuration structure that is\n used as a parameter to the Configuration.

\n

Example:\"CognitoUserPoolConfiguration\":{\"UserPoolArn\":\"cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"ClientIds\":\n [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"]}\n

" + } + }, + "com.amazonaws.verifiedpermissions#Configuration": { + "type": "union", + "members": { + "cognitoUserPoolConfiguration": { + "target": "com.amazonaws.verifiedpermissions#CognitoUserPoolConfiguration", + "traits": { + "smithy.api#documentation": "

Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of\n authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool\n and one or more application client IDs.

\n

Example:\n \"configuration\":{\"cognitoUserPoolConfiguration\":{\"userPoolArn\":\"cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"clientIds\":\n [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"]}}\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains configuration information used when creating a new identity source.

\n \n

At this time, the only valid member of this structure is a Amazon Cognito user pool\n configuration.

\n

You must specify a userPoolArn, and optionally, a\n ClientId.

\n \n

This data type is used as a request parameter for the CreateIdentitySource\n operation.

" + } + }, + "com.amazonaws.verifiedpermissions#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "resources": { + "target": "com.amazonaws.verifiedpermissions#ResourceConflictList", + "traits": { + "smithy.api#documentation": "

The list of resources referenced with this failed request.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request failed because another request to modify a resource occurred at the\n same.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.verifiedpermissions#ContextDefinition": { + "type": "union", + "members": { + "contextMap": { + "target": "com.amazonaws.verifiedpermissions#ContextMap", + "traits": { + "smithy.api#documentation": "

An list of attributes that are needed to successfully evaluate an authorization\n request. Each attribute in this array must include a map of a data type and its\n value.

\n

Example:\n \"Context\":{\"<KeyName1>\":{\"boolean\":true},\"<KeyName2>\":{\"long\":1234}}\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains additional details about the context of the request. Verified Permissions evaluates this\n information in an authorization request as part of the when and\n unless clauses in a policy.

\n

This data type is used as a request parameter for the IsAuthorized and IsAuthorizedWithToken operations.

\n

Example:\n \"context\":{\"Context\":{\"<KeyName1>\":{\"boolean\":true},\"<KeyName2>\":{\"long\":1234}}}\n

" + } + }, + "com.amazonaws.verifiedpermissions#ContextMap": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "com.amazonaws.verifiedpermissions#AttributeValue" + }, + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.verifiedpermissions#CreateIdentitySource": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#CreateIdentitySourceInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#CreateIdentitySourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.verifiedpermissions#ServiceQuotaExceededException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to create a reference to an external identity provider (IdP) that is compatible with OpenID Connect (OIDC) authentication protocol, such as Amazon Cognito", + "smithy.api#documentation": "

Creates a reference to an Amazon Cognito user pool as an external identity provider (IdP).\n

\n

After you create an identity source, you can use the identities provided by the IdP as proxies\n for the principal in authorization queries that use the IsAuthorizedWithToken\n operation. These identities take the form of tokens that contain claims about the user,\n such as IDs, attributes and group memberships. Amazon Cognito provides both identity tokens and\n access tokens, and Verified Permissions can use either or both. Any combination of identity and access\n tokens results in the same Cedar principal. Verified Permissions automatically translates the\n information about the identities into the standard Cedar attributes that can be\n evaluated by your policies. Because the Amazon Cognito identity and access tokens can contain\n different information, the tokens you choose to use determine which principal attributes\n are available to access when evaluating Cedar policies.

\n \n

If you delete a Amazon Cognito user pool or user, tokens from that deleted pool or that deleted user continue to be usable until they expire.

\n \n \n

To reference a user from this identity source in your Cedar policies, use the following\n syntax.

\n

\n IdentityType::\"<CognitoUserPoolIdentifier>|<CognitoClientId>\n

\n

Where IdentityType is the string that you provide to the\n PrincipalEntityType parameter for this operation. The\n CognitoUserPoolId and CognitoClientId are defined by\n the Amazon Cognito user pool.

\n ", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.verifiedpermissions#CreateIdentitySourceInput": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.verifiedpermissions#IdempotencyToken", + "traits": { + "smithy.api#documentation": "

Specifies a unique, case-sensitive ID that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..

\n

If you don't provide this value, then Amazon Web Services generates a random one for\n you.

\n

If you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an IdempotentParameterMismatch\n error.

", + "smithy.api#idempotencyToken": {} + } + }, + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

Specifies the ID of the policy store in which you want to store this identity source. Only policies and\n requests made using this policy store can reference identities from the identity provider\n configured in the new identity source.

", + "smithy.api#required": {} + } + }, + "configuration": { + "target": "com.amazonaws.verifiedpermissions#Configuration", + "traits": { + "smithy.api#documentation": "

Specifies the details required to communicate with the identity provider (IdP)\n associated with this identity source.

\n \n

At this time, the only valid member of this structure is a Amazon Cognito user pool\n configuration.

\n

You must specify a UserPoolArn, and optionally, a\n ClientId.

\n ", + "smithy.api#required": {} + } + }, + "principalEntityType": { + "target": "com.amazonaws.verifiedpermissions#PrincipalEntityType", + "traits": { + "smithy.api#documentation": "

Specifies the namespace and data type of the principals generated for identities\n authenticated by the new identity source.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#CreateIdentitySourceOutput": { + "type": "structure", + "members": { + "createdDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "

The date and time the identity source was originally created.

", + "smithy.api#required": {} + } + }, + "identitySourceId": { + "target": "com.amazonaws.verifiedpermissions#IdentitySourceId", + "traits": { + "smithy.api#documentation": "

The unique ID of the new identity source.

", + "smithy.api#required": {} + } + }, + "lastUpdatedDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "

The date and time the identity source was most recently updated.

", + "smithy.api#required": {} + } + }, + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

The ID of the policy store that contains the identity source.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#CreatePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#CreatePolicyInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#CreatePolicyOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.verifiedpermissions#ServiceQuotaExceededException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to create a Cedar policy and save it in the specified policy store", + "smithy.api#documentation": "

Creates a Cedar policy and saves it in the specified policy store. You can create either a\n static policy or a policy linked to a policy template.

\n \n \n

Creating a policy causes it to be validated against the schema in the policy store. If the\n policy doesn't pass validation, the operation fails and the policy isn't\n stored.

\n ", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.verifiedpermissions#CreatePolicyInput": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.verifiedpermissions#IdempotencyToken", + "traits": { + "smithy.api#documentation": "

Specifies a unique, case-sensitive ID that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..

\n

If you don't provide this value, then Amazon Web Services generates a random one for\n you.

\n

If you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an IdempotentParameterMismatch\n error.

", + "smithy.api#idempotencyToken": {} + } + }, + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

Specifies the PolicyStoreId of the policy store you want to store the policy\n in.

", + "smithy.api#required": {} + } + }, + "definition": { + "target": "com.amazonaws.verifiedpermissions#PolicyDefinition", + "traits": { + "smithy.api#documentation": "

A structure that specifies the policy type and content to use for the new policy. You\n must include either a static or a templateLinked element. The policy content must be written\n in the Cedar policy language.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#CreatePolicyOutput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

The ID of the policy store that contains the new policy.

", + "smithy.api#required": {} + } + }, + "policyId": { + "target": "com.amazonaws.verifiedpermissions#PolicyId", + "traits": { + "smithy.api#documentation": "

The unique ID of the new policy.

", + "smithy.api#required": {} + } + }, + "policyType": { + "target": "com.amazonaws.verifiedpermissions#PolicyType", + "traits": { + "smithy.api#documentation": "

The policy type of the new policy.

", + "smithy.api#required": {} + } + }, + "principal": { + "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", + "traits": { + "smithy.api#documentation": "

The principal specified in the new policy's scope. This response element isn't present\n when principal isn't specified in the policy content.

" + } + }, + "resource": { + "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", + "traits": { + "smithy.api#documentation": "

The resource specified in the new policy's scope. This response element isn't present\n when the resource isn't specified in the policy content.

" + } + }, + "createdDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "

The date and time the policy was originally created.

", + "smithy.api#required": {} + } + }, + "lastUpdatedDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "

The date and time the policy was last updated.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#CreatePolicyStore": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#CreatePolicyStoreInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#CreatePolicyStoreOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ServiceQuotaExceededException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to create a Cedar policy and save it in the specified policy store", + "smithy.api#documentation": "

Creates a policy store. A policy store is a container for policy resources.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.verifiedpermissions#CreatePolicyStoreInput": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.verifiedpermissions#IdempotencyToken", + "traits": { + "smithy.api#documentation": "

Specifies a unique, case-sensitive ID that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..

\n

If you don't provide this value, then Amazon Web Services generates a random one for\n you.

\n

If you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an IdempotentParameterMismatch\n error.

", + "smithy.api#idempotencyToken": {} + } + }, + "validationSettings": { + "target": "com.amazonaws.verifiedpermissions#ValidationSettings", + "traits": { + "smithy.api#documentation": "

Specifies the validation setting for this policy store.

\n

Currently, the only valid and required value is Mode.

\n \n

We recommend that you turn on STRICT mode only after you define a\n schema. If a schema doesn't exist, then STRICT mode causes any policy\n to fail validation, and Verified Permissions rejects the policy. You can turn off validation by\n using the UpdatePolicyStore. Then, when you have a schema defined, use UpdatePolicyStore again to turn validation back on.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#CreatePolicyStoreOutput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

The unique ID of the new policy store.

", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.verifiedpermissions#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the new policy store.

", + "smithy.api#required": {} + } + }, + "createdDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "

The date and time the policy store was originally created.

", + "smithy.api#required": {} + } + }, + "lastUpdatedDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "

The date and time the policy store was last updated.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#CreatePolicyTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#CreatePolicyTemplateInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#CreatePolicyTemplateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.verifiedpermissions#ServiceQuotaExceededException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to create a policy template", + "smithy.api#documentation": "

Creates a policy template. A template can use placeholders for the principal and resource. A\n template must be instantiated into a policy by associating it with specific principals\n and resources to use for the placeholders. That instantiated policy can then be\n considered in authorization decisions. The instantiated policy works identically to any\n other policy, except that it is dynamically linked to the template. If the template\n changes, then any policies that are linked to that template are immediately updated as\n well.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.verifiedpermissions#CreatePolicyTemplateInput": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.verifiedpermissions#IdempotencyToken", + "traits": { + "smithy.api#documentation": "

Specifies a unique, case-sensitive ID that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..

\n

If you don't provide this value, then Amazon Web Services generates a random one for\n you.

\n

If you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an IdempotentParameterMismatch\n error.

", + "smithy.api#idempotencyToken": {} + } + }, + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

The ID of the policy store in which to create the policy template.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.verifiedpermissions#PolicyTemplateDescription", + "traits": { + "smithy.api#documentation": "

Specifies a description for the policy template.

" + } + }, + "statement": { + "target": "com.amazonaws.verifiedpermissions#PolicyStatement", + "traits": { + "smithy.api#documentation": "

Specifies the content that you want to use for the new policy template, written in the Cedar\n policy language.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#CreatePolicyTemplateOutput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

The ID of the policy store that contains the policy template.

", + "smithy.api#required": {} + } + }, + "policyTemplateId": { + "target": "com.amazonaws.verifiedpermissions#PolicyTemplateId", + "traits": { + "smithy.api#documentation": "

The unique ID of the new policy template.

", + "smithy.api#required": {} + } + }, + "createdDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "

The date and time the policy template was originally created.

", + "smithy.api#required": {} + } + }, + "lastUpdatedDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "

The date and time the policy template was most recently updated.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#Decision": { + "type": "enum", + "members": { + "ALLOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALLOW" + } + }, + "DENY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DENY" + } + } + } + }, + "com.amazonaws.verifiedpermissions#DeleteIdentitySource": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#DeleteIdentitySourceInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#DeleteIdentitySourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ConflictException" + }, + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to delete an identity source that references an identity provider (IdP) such as Amazon Cognito", + "smithy.api#documentation": "

Deletes an identity source that references an identity provider (IdP) such as Amazon Cognito. After\n you delete the identity source, you can no longer use tokens for identities from that identity source to\n represent principals in authorization queries made using IsAuthorizedWithToken.\n operations.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.verifiedpermissions#DeleteIdentitySourceInput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

Specifies the ID of the policy store that contains the identity source that you want to delete.

", + "smithy.api#required": {} + } + }, + "identitySourceId": { + "target": "com.amazonaws.verifiedpermissions#IdentitySourceId", + "traits": { + "smithy.api#documentation": "

Specifies the ID of the identity source that you want to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#DeleteIdentitySourceOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#DeletePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#DeletePolicyInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#DeletePolicyOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ConflictException" + }, + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to delete the specified policy from the policy store", + "smithy.api#documentation": "

Deletes the specified policy from the policy store.

\n

This operation is idempotent; if you specify a policy that doesn't \n exist, the request response returns a successful HTTP 200 status code.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.verifiedpermissions#DeletePolicyInput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

Specifies the ID of the policy store that contains the policy that you want to delete.

", + "smithy.api#required": {} + } + }, + "policyId": { + "target": "com.amazonaws.verifiedpermissions#PolicyId", + "traits": { + "smithy.api#documentation": "

Specifies the ID of the policy that you want to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#DeletePolicyOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#DeletePolicyStore": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#DeletePolicyStoreInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#DeletePolicyStoreOutput" + }, + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to delete the specified policy store", + "smithy.api#documentation": "

Deletes the specified policy store.

\n

This operation is idempotent. If you specify a policy store that does not exist, the request\n response will still return a successful HTTP 200 status code.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.verifiedpermissions#DeletePolicyStoreInput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

Specifies the ID of the policy store that you want to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#DeletePolicyStoreOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#DeletePolicyTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#DeletePolicyTemplateInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#DeletePolicyTemplateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ConflictException" + }, + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to delete the specified policy template from the policy store", + "smithy.api#documentation": "

Deletes the specified policy template from the policy store.

\n \n

This operation also deletes any policies that were created from the specified\n policy template. Those policies are immediately removed from all future API responses, and are\n asynchronously deleted from the policy store.

\n ", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.verifiedpermissions#DeletePolicyTemplateInput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

Specifies the ID of the policy store that contains the policy template that you want to delete.

", + "smithy.api#required": {} + } + }, + "policyTemplateId": { + "target": "com.amazonaws.verifiedpermissions#PolicyTemplateId", + "traits": { + "smithy.api#documentation": "

Specifies the ID of the policy template that you want to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#DeletePolicyTemplateOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#DeterminingPolicyItem": { + "type": "structure", + "members": { + "policyId": { + "target": "com.amazonaws.verifiedpermissions#PolicyId", + "traits": { + "smithy.api#documentation": "

The Id of a policy that determined to an authorization decision.

\n

Example: \"policyId\":\"SPEXAMPLEabcdefg111111\"\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about one of the policies that determined an authorization\n decision.

\n

This data type is used as an element in a response parameter for the IsAuthorized\n and IsAuthorizedWithToken operations.

\n

Example: \"determiningPolicies\":[{\"policyId\":\"SPEXAMPLEabcdefg111111\"}]\n

" + } + }, + "com.amazonaws.verifiedpermissions#DeterminingPolicyList": { + "type": "list", + "member": { + "target": "com.amazonaws.verifiedpermissions#DeterminingPolicyItem" + }, + "traits": { + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.verifiedpermissions#DiscoveryUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^https://.*$" + } + }, + "com.amazonaws.verifiedpermissions#EntitiesDefinition": { + "type": "union", + "members": { + "entityList": { + "target": "com.amazonaws.verifiedpermissions#EntityList", + "traits": { + "smithy.api#documentation": "

An array of entities that are needed to successfully evaluate an authorization\n request. Each entity in this array must include an identifier for the entity, the\n attributes of the entity, and a list of any parent entities.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the list of entities to be considered during an authorization request. This\n includes all principals, resources, and actions required to successfully evaluate the\n request.

\n

This data type is used as a field in the response parameter for the IsAuthorized\n and IsAuthorizedWithToken operations.

" + } + }, + "com.amazonaws.verifiedpermissions#EntityAttributes": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "com.amazonaws.verifiedpermissions#AttributeValue" + }, + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.verifiedpermissions#EntityId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.verifiedpermissions#EntityIdentifier": { + "type": "structure", + "members": { + "entityType": { + "target": "com.amazonaws.verifiedpermissions#EntityType", + "traits": { + "smithy.api#documentation": "

The type of an entity.

\n

Example: \"entityType\":\"typeName\"\n

", + "smithy.api#required": {} + } + }, + "entityId": { + "target": "com.amazonaws.verifiedpermissions#EntityId", + "traits": { + "smithy.api#documentation": "

The identifier of an entity.

\n

\n \"entityId\":\"identifier\"\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the identifier of an entity, including its ID and type.

\n

This data type is used as a request parameter for IsAuthorized operation, and as a\n response parameter for the CreatePolicy, GetPolicy, and\n UpdatePolicy operations.

\n

Example:\n {\"entityId\":\"string\",\"entityType\":\"string\"}\n

" + } + }, + "com.amazonaws.verifiedpermissions#EntityItem": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the entity.

", + "smithy.api#required": {} + } + }, + "attributes": { + "target": "com.amazonaws.verifiedpermissions#EntityAttributes", + "traits": { + "smithy.api#documentation": "

A list of attributes for the entity.

" + } + }, + "parents": { + "target": "com.amazonaws.verifiedpermissions#ParentList", + "traits": { + "smithy.api#documentation": "

The parents in the hierarchy that contains the entity.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an entity that can be referenced in a Cedar\n policy.

\n

This data type is used as one of the fields in the EntitiesDefinition\n structure.

\n

\n {\n \"id\": {\n \"entityType\": \"Photo\",\n \"entityId\": \"VacationPhoto94.jpg\"\n },\n \"Attributes\": {},\n \"Parents\": [\n {\n \"entityType\": \"Album\",\n \"entityId\": \"alice_folder\"\n }\n ]\n}\n

" + } + }, + "com.amazonaws.verifiedpermissions#EntityList": { + "type": "list", + "member": { + "target": "com.amazonaws.verifiedpermissions#EntityItem" + }, + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.verifiedpermissions#EntityReference": { + "type": "union", + "members": { + "unspecified": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Used to indicate that a principal or resource is not specified. This can be used to\n search for policies that are not associated with a specific principal or\n resource.

" + } + }, + "identifier": { + "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the entity. It can consist of either an EntityType and EntityId, a\n principal, or a resource.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a principal or resource that can be referenced in a Cedar\n policy.

\n

This data type is used as part of the PolicyFilter structure that is\n used as a request parameter for the ListPolicies operation..

" + } + }, + "com.amazonaws.verifiedpermissions#EntityType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.verifiedpermissions#EvaluationErrorItem": { + "type": "structure", + "members": { + "errorDescription": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The error description.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains a description of an evaluation error.

\n

This data type is used as a request parameter in the IsAuthorized and IsAuthorizedWithToken operations.

" + } + }, + "com.amazonaws.verifiedpermissions#EvaluationErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.verifiedpermissions#EvaluationErrorItem" + }, + "traits": { + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.verifiedpermissions#GetIdentitySource": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#GetIdentitySourceInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#GetIdentitySourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to retrieve the details about the specified identity source", + "smithy.api#documentation": "

Retrieves the details about the specified identity source.

", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.verifiedpermissions#GetIdentitySourceInput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

Specifies the ID of the policy store that contains the identity source you want information about.

", + "smithy.api#required": {} + } + }, + "identitySourceId": { + "target": "com.amazonaws.verifiedpermissions#IdentitySourceId", + "traits": { + "smithy.api#documentation": "

Specifies the ID of the identity source you want information about.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#GetIdentitySourceOutput": { + "type": "structure", + "members": { + "createdDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The date and time that the identity source was originally created.

", + "smithy.api#required": {} + } + }, + "details": { + "target": "com.amazonaws.verifiedpermissions#IdentitySourceDetails", + "traits": { + "smithy.api#documentation": "

A structure that describes the configuration of the identity source.

", + "smithy.api#required": {} + } + }, + "identitySourceId": { + "target": "com.amazonaws.verifiedpermissions#IdentitySourceId", + "traits": { + "smithy.api#documentation": "

The ID of the identity source.

", + "smithy.api#required": {} + } + }, + "lastUpdatedDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The date and time that the identity source was most recently updated.

", + "smithy.api#required": {} + } + }, + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

The ID of the policy store that contains the identity source.

", + "smithy.api#required": {} + } + }, + "principalEntityType": { + "target": "com.amazonaws.verifiedpermissions#PrincipalEntityType", + "traits": { + "smithy.api#documentation": "

The data type of principals generated for identities authenticated by this\n identity source.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#GetPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#GetPolicyInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#GetPolicyOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to retrieve information about the specified policy", + "smithy.api#documentation": "

Retrieves information about the specified policy.

", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.verifiedpermissions#GetPolicyInput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

Specifies the ID of the policy store that contains the policy that you want information\n about.

", + "smithy.api#required": {} + } + }, + "policyId": { + "target": "com.amazonaws.verifiedpermissions#PolicyId", + "traits": { + "smithy.api#documentation": "

Specifies the ID of the policy you want information about.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#GetPolicyOutput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

The ID of the policy store that contains the policy that you want information about.

", + "smithy.api#required": {} + } + }, + "policyId": { + "target": "com.amazonaws.verifiedpermissions#PolicyId", + "traits": { + "smithy.api#documentation": "

The unique ID of the policy that you want information about.

", + "smithy.api#required": {} + } + }, + "policyType": { + "target": "com.amazonaws.verifiedpermissions#PolicyType", + "traits": { + "smithy.api#documentation": "

The type of the policy.

", + "smithy.api#required": {} + } + }, + "principal": { + "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", + "traits": { + "smithy.api#documentation": "

The principal specified in the policy's scope. This element isn't included in the\n response when Principal isn't present in the policy content.

" + } + }, + "resource": { + "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", + "traits": { + "smithy.api#documentation": "

The resource specified in the policy's scope. This element isn't included in the\n response when Resource isn't present in the policy content.

" + } + }, + "definition": { + "target": "com.amazonaws.verifiedpermissions#PolicyDefinitionDetail", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The definition of the requested policy.

", + "smithy.api#required": {} + } + }, + "createdDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The date and time that the policy was originally created.

", + "smithy.api#required": {} + } + }, + "lastUpdatedDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The date and time that the policy was last updated.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#GetPolicyStore": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#GetPolicyStoreInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#GetPolicyStoreOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to retrieve details about a policy store", + "smithy.api#documentation": "

Retrieves details about a policy store.

", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.verifiedpermissions#GetPolicyStoreInput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

Specifies the ID of the policy store that you want information about.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#GetPolicyStoreOutput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

The ID of the policy store;

", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.verifiedpermissions#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the policy store.

", + "smithy.api#required": {} + } + }, + "validationSettings": { + "target": "com.amazonaws.verifiedpermissions#ValidationSettings", + "traits": { + "smithy.api#documentation": "

The current validation settings for the policy store.

", + "smithy.api#required": {} + } + }, + "createdDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The date and time that the policy store was originally created.

", + "smithy.api#required": {} + } + }, + "lastUpdatedDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The date and time that the policy store was last updated.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#GetPolicyTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#GetPolicyTemplateInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#GetPolicyTemplateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to retrieve the details for the specified policy template in the specified policy store", + "smithy.api#documentation": "

Retrieve the details for the specified policy template in the specified policy store.

", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.verifiedpermissions#GetPolicyTemplateInput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

Specifies the ID of the policy store that contains the policy template that you want information\n about.

", + "smithy.api#required": {} + } + }, + "policyTemplateId": { + "target": "com.amazonaws.verifiedpermissions#PolicyTemplateId", + "traits": { + "smithy.api#documentation": "

Specifies the ID of the policy template that you want information about.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#GetPolicyTemplateOutput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

The ID of the policy store that contains the policy template.

", + "smithy.api#required": {} + } + }, + "policyTemplateId": { + "target": "com.amazonaws.verifiedpermissions#PolicyTemplateId", + "traits": { + "smithy.api#documentation": "

The ID of the policy template.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.verifiedpermissions#PolicyTemplateDescription", + "traits": { + "smithy.api#documentation": "

The description of the policy template.

" + } + }, + "statement": { + "target": "com.amazonaws.verifiedpermissions#PolicyStatement", + "traits": { + "smithy.api#documentation": "

The content of the body of the policy template written in the Cedar policy language.

", + "smithy.api#required": {} + } + }, + "createdDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The date and time that the policy template was originally created.

", + "smithy.api#required": {} + } + }, + "lastUpdatedDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The date and time that the policy template was most recently updated.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#GetSchema": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#GetSchemaInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#GetSchemaOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to retrieve the details for the specified schema in the specified policy store", + "smithy.api#documentation": "

Retrieve the details for the specified schema in the specified policy store.

", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.verifiedpermissions#GetSchemaInput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

Specifies the ID of the policy store that contains the schema.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#GetSchemaOutput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

The ID of the policy store that contains the schema.

", + "smithy.api#required": {} + } + }, + "schema": { + "target": "com.amazonaws.verifiedpermissions#SchemaJson", + "traits": { + "smithy.api#documentation": "

The body of the schema, written in Cedar schema JSON.

", + "smithy.api#required": {} + } + }, + "createdDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "

The date and time that the schema was originally created.

", + "smithy.api#required": {} + } + }, + "lastUpdatedDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "

The date and time that the schema was most recently updated.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#IdempotencyToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]*$" + } + }, + "com.amazonaws.verifiedpermissions#IdentitySource": { + "type": "resource", + "identifiers": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId" + }, + "identitySourceId": { + "target": "com.amazonaws.verifiedpermissions#IdentitySourceId" + } + }, + "create": { + "target": "com.amazonaws.verifiedpermissions#CreateIdentitySource" + }, + "read": { + "target": "com.amazonaws.verifiedpermissions#GetIdentitySource" + }, + "update": { + "target": "com.amazonaws.verifiedpermissions#UpdateIdentitySource" + }, + "delete": { + "target": "com.amazonaws.verifiedpermissions#DeleteIdentitySource" + }, + "list": { + "target": "com.amazonaws.verifiedpermissions#ListIdentitySources" + }, + "traits": { + "aws.cloudformation#cfnResource": {}, + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.verifiedpermissions#IdentitySourceDetails": { + "type": "structure", + "members": { + "clientIds": { + "target": "com.amazonaws.verifiedpermissions#ClientIds", + "traits": { + "smithy.api#documentation": "

The application client IDs associated with the specified Amazon Cognito user pool that are\n enabled for this identity source.

" + } + }, + "userPoolArn": { + "target": "com.amazonaws.verifiedpermissions#UserPoolArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Cognito user pool whose identities are accessible to this Verified Permissions\n policy store.

" + } + }, + "discoveryUrl": { + "target": "com.amazonaws.verifiedpermissions#DiscoveryUrl", + "traits": { + "smithy.api#documentation": "

The well-known URL that points to this user pool's OIDC discovery endpoint. This is a\n URL string in the following format. This URL replaces the placeholders for both the\n Amazon Web Services Region and the user pool identifier with those appropriate for this user\n pool.

\n

\n https://cognito-idp.<region>.amazonaws.com/<user-pool-id>/.well-known/openid-configuration\n

" + } + }, + "openIdIssuer": { + "target": "com.amazonaws.verifiedpermissions#OpenIdIssuer", + "traits": { + "smithy.api#documentation": "

A string that identifies the type of OIDC service represented by this identity source.

\n

At this time, the only valid value is cognito.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains configuration of the identity source.

\n

This data type is used as a response parameter for the CreateIdentitySource\n operation.

" + } + }, + "com.amazonaws.verifiedpermissions#IdentitySourceFilter": { + "type": "structure", + "members": { + "principalEntityType": { + "target": "com.amazonaws.verifiedpermissions#PrincipalEntityType", + "traits": { + "smithy.api#documentation": "

The Cedar entity type of the principals returned by the identity provider (IdP)\n associated with this identity source.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that defines characteristics of an identity source that you can use to\n filter.

\n

This data type is used as a request parameter for the ListIdentityStores\n operation.

" + } + }, + "com.amazonaws.verifiedpermissions#IdentitySourceFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.verifiedpermissions#IdentitySourceFilter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.verifiedpermissions#IdentitySourceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]*$" + } + }, + "com.amazonaws.verifiedpermissions#IdentitySourceItem": { + "type": "structure", + "members": { + "createdDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "

The date and time the identity source was originally created.

", + "smithy.api#required": {} + } + }, + "details": { + "target": "com.amazonaws.verifiedpermissions#IdentitySourceItemDetails", + "traits": { + "smithy.api#documentation": "

A structure that contains the details of the associated identity provider\n (IdP).

", + "smithy.api#required": {} + } + }, + "identitySourceId": { + "target": "com.amazonaws.verifiedpermissions#IdentitySourceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the identity source.

", + "smithy.api#required": {} + } + }, + "lastUpdatedDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "

The date and time the identity source was most recently updated.

", + "smithy.api#required": {} + } + }, + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

The identifier of the policy store that contains the identity source.

", + "smithy.api#required": {} + } + }, + "principalEntityType": { + "target": "com.amazonaws.verifiedpermissions#PrincipalEntityType", + "traits": { + "smithy.api#documentation": "

The Cedar entity type of the principals returned from the IdP associated with this\n identity source.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that defines an identity source.

\n

This data type is used as a request parameter for the ListIdentityStores\n operation.

" + } + }, + "com.amazonaws.verifiedpermissions#IdentitySourceItemDetails": { + "type": "structure", + "members": { + "clientIds": { + "target": "com.amazonaws.verifiedpermissions#ClientIds", + "traits": { + "smithy.api#documentation": "

The application client IDs associated with the specified Amazon Cognito user pool that are\n enabled for this identity source.

" + } + }, + "userPoolArn": { + "target": "com.amazonaws.verifiedpermissions#UserPoolArn", + "traits": { + "smithy.api#documentation": "

The Amazon Cognito user pool whose identities are accessible to this Verified Permissions policy store.

" + } + }, + "discoveryUrl": { + "target": "com.amazonaws.verifiedpermissions#DiscoveryUrl", + "traits": { + "smithy.api#documentation": "

The well-known URL that points to this user pool's OIDC discovery endpoint. This is a\n URL string in the following format. This URL replaces the placeholders for both the\n Amazon Web Services Region and the user pool identifier with those appropriate for this user\n pool.

\n

\n https://cognito-idp.<region>.amazonaws.com/<user-pool-id>/.well-known/openid-configuration\n

" + } + }, + "openIdIssuer": { + "target": "com.amazonaws.verifiedpermissions#OpenIdIssuer", + "traits": { + "smithy.api#documentation": "

A string that identifies the type of OIDC service represented by this identity source.

\n

At this time, the only valid value is cognito.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains configuration of the identity source.

\n

This data type is used as a response parameter for the CreateIdentitySource\n operation.

" + } + }, + "com.amazonaws.verifiedpermissions#IdentitySources": { + "type": "list", + "member": { + "target": "com.amazonaws.verifiedpermissions#IdentitySourceItem" + } + }, + "com.amazonaws.verifiedpermissions#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request failed because of an internal error. Try your request again later

", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.verifiedpermissions#IsAuthorized": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#IsAuthorizedInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#IsAuthorizedOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to make an authorization decision about a service request described in the parameters", + "smithy.api#documentation": "

Makes an authorization decision about a service request described in the parameters.\n The information in the parameters can also define additional context that Verified Permissions can\n include in the evaluation. The request is evaluated against all matching policies in the\n specified policy store. The result of the decision is either Allow or\n Deny, along with a list of the policies that resulted in the\n decision.

", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.verifiedpermissions#IsAuthorizedInput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

Specifies the ID of the policy store. Policies in this policy store will be used to make an\n authorization decision for the input.

", + "smithy.api#required": {} + } + }, + "principal": { + "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", + "traits": { + "smithy.api#documentation": "

Specifies the principal for which the authorization decision is to be made.

" + } + }, + "action": { + "target": "com.amazonaws.verifiedpermissions#ActionIdentifier", + "traits": { + "smithy.api#documentation": "

Specifies the requested action to be authorized. For example, is the principal\n authorized to perform this action on the resource?

" + } + }, + "resource": { + "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", + "traits": { + "smithy.api#documentation": "

Specifies the resource for which the authorization decision is to be made.

" + } + }, + "context": { + "target": "com.amazonaws.verifiedpermissions#ContextDefinition", + "traits": { + "smithy.api#documentation": "

Specifies additional context that can be used to make more granular authorization\n decisions.

" + } + }, + "entities": { + "target": "com.amazonaws.verifiedpermissions#EntitiesDefinition", + "traits": { + "smithy.api#documentation": "

Specifies the list of entities and their associated attributes that Verified Permissions can examine\n when evaluating the policies.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#IsAuthorizedOutput": { + "type": "structure", + "members": { + "decision": { + "target": "com.amazonaws.verifiedpermissions#Decision", + "traits": { + "smithy.api#documentation": "

An authorization decision that indicates if the authorization request should be\n allowed or denied.

", + "smithy.api#required": {} + } + }, + "determiningPolicies": { + "target": "com.amazonaws.verifiedpermissions#DeterminingPolicyList", + "traits": { + "smithy.api#documentation": "

The list of determining policies used to make the authorization decision. For example,\n if there are two matching policies, where one is a forbid and the other is a permit,\n then the forbid policy will be the determining policy. In the case of multiple matching\n permit policies then there would be multiple determining policies. In the case that no\n policies match, and hence the response is DENY, there would be no determining\n policies.

", + "smithy.api#required": {} + } + }, + "errors": { + "target": "com.amazonaws.verifiedpermissions#EvaluationErrorList", + "traits": { + "smithy.api#documentation": "

Errors that occurred while making an authorization decision, for example, a policy\n references an Entity or entity Attribute that does not exist in the slice.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#IsAuthorizedWithToken": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#IsAuthorizedWithTokenInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#IsAuthorizedWithTokenOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to make an authorization decision about a service request described in the parameters. The principal in this request comes from an external identity source", + "smithy.api#documentation": "

Makes an authorization decision about a service request described in the parameters.\n The principal in this request comes from an external identity source. The information in the\n parameters can also define additional context that Verified Permissions can include in the evaluation.\n The request is evaluated against all matching policies in the specified policy store. The result\n of the decision is either Allow or Deny, along with a list of\n the policies that resulted in the decision.

\n \n

If you delete a Amazon Cognito user pool or user, tokens from that deleted pool or that deleted user continue to be usable until they expire.

\n ", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.verifiedpermissions#IsAuthorizedWithTokenInput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

Specifies the ID of the policy store. Policies in this policy store will be used to make an\n authorization decision for the input.

", + "smithy.api#required": {} + } + }, + "identityToken": { + "target": "com.amazonaws.verifiedpermissions#Token", + "traits": { + "smithy.api#documentation": "

Specifies an identity token for the principal to be authorized. This token is provided\n to you by the identity provider (IdP) associated with the specified identity source. You must\n specify either an AccessToken or an IdentityToken, but not\n both.

" + } + }, + "accessToken": { + "target": "com.amazonaws.verifiedpermissions#Token", + "traits": { + "smithy.api#documentation": "

Specifies an access token for the principal to be authorized. This token is provided\n to you by the identity provider (IdP) associated with the specified identity source. You must\n specify either an AccessToken or an IdentityToken, but not\n both.

" + } + }, + "action": { + "target": "com.amazonaws.verifiedpermissions#ActionIdentifier", + "traits": { + "smithy.api#documentation": "

Specifies the requested action to be authorized. Is the specified principal authorized\n to perform this action on the specified resource.

" + } + }, + "resource": { + "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", + "traits": { + "smithy.api#documentation": "

Specifies the resource for which the authorization decision is made. For example, is\n the principal allowed to perform the action on the resource?

" + } + }, + "context": { + "target": "com.amazonaws.verifiedpermissions#ContextDefinition", + "traits": { + "smithy.api#documentation": "

Specifies additional context that can be used to make more granular authorization\n decisions.

" + } + }, + "entities": { + "target": "com.amazonaws.verifiedpermissions#EntitiesDefinition", + "traits": { + "smithy.api#documentation": "

Specifies the list of entities and their associated attributes that Verified Permissions can examine\n when evaluating the policies.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#IsAuthorizedWithTokenOutput": { + "type": "structure", + "members": { + "decision": { + "target": "com.amazonaws.verifiedpermissions#Decision", + "traits": { + "smithy.api#documentation": "

An authorization decision that indicates if the authorization request should be\n allowed or denied.

", + "smithy.api#required": {} + } + }, + "determiningPolicies": { + "target": "com.amazonaws.verifiedpermissions#DeterminingPolicyList", + "traits": { + "smithy.api#documentation": "

The list of determining policies used to make the authorization decision. For example,\n if there are multiple matching policies, where at least one is a forbid policy, then\n because forbid always overrides permit the forbid policies are the determining policies.\n If all matching policies are permit policies, then those policies are the determining\n policies. When no policies match and the response is the default DENY, there are no\n determining policies.

", + "smithy.api#required": {} + } + }, + "errors": { + "target": "com.amazonaws.verifiedpermissions#EvaluationErrorList", + "traits": { + "smithy.api#documentation": "

Errors that occurred while making an authorization decision. For example, a policy\n references an entity or entity attribute that does not exist in the slice.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#ListIdentitySources": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#ListIdentitySourcesInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#ListIdentitySourcesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to return a paginated list of all of the identity sources defined in the specified policy store", + "smithy.api#documentation": "

Returns a paginated list of all of the identity sources defined in the specified policy store.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "identitySources" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.verifiedpermissions#ListIdentitySourcesInput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

Specifies the ID of the policy store that contains the identity sources that you want to list.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.verifiedpermissions#NextToken", + "traits": { + "smithy.api#documentation": "

Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.

" + } + }, + "maxResults": { + "target": "com.amazonaws.verifiedpermissions#ListIdentitySourcesMaxResults", + "traits": { + "smithy.api#documentation": "

Specifies the total number of results that you want included on each page \n of the response. If you do not include this parameter, it defaults to a value that is \n specific to the operation. If additional items exist beyond the number you specify, the\n NextToken response element is returned with a value (not null).\n Include the specified value as the NextToken request parameter in the next \n call to the operation to get the next part of the results. Note that the service might \n return fewer results than the maximum even when there are more results available. You \n should check NextToken after every operation to ensure that you receive all\n of the results.

" + } + }, + "filters": { + "target": "com.amazonaws.verifiedpermissions#IdentitySourceFilters", + "traits": { + "smithy.api#documentation": "

Specifies characteristics of an identity source that you can use to limit the output to matching\n identity sources.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#ListIdentitySourcesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.verifiedpermissions#ListIdentitySourcesOutput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.verifiedpermissions#NextToken", + "traits": { + "smithy.api#documentation": "

If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.

" + } + }, + "identitySources": { + "target": "com.amazonaws.verifiedpermissions#IdentitySources", + "traits": { + "smithy.api#documentation": "

The list of identity sources stored in the specified policy store.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#ListPolicies": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#ListPoliciesInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#ListPoliciesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to return a paginated list of all policies stored in the specified policy store", + "smithy.api#documentation": "

Returns a paginated list of all policies stored in the specified policy store.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "policies" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.verifiedpermissions#ListPoliciesInput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

Specifies the ID of the policy store you want to list policies from.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.verifiedpermissions#NextToken", + "traits": { + "smithy.api#documentation": "

Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.

" + } + }, + "maxResults": { + "target": "com.amazonaws.verifiedpermissions#MaxResults", + "traits": { + "smithy.api#documentation": "

Specifies the total number of results that you want included on each page \n of the response. If you do not include this parameter, it defaults to a value that is \n specific to the operation. If additional items exist beyond the number you specify, the\n NextToken response element is returned with a value (not null).\n Include the specified value as the NextToken request parameter in the next \n call to the operation to get the next part of the results. Note that the service might \n return fewer results than the maximum even when there are more results available. You \n should check NextToken after every operation to ensure that you receive all\n of the results.

" + } + }, + "filter": { + "target": "com.amazonaws.verifiedpermissions#PolicyFilter", + "traits": { + "smithy.api#documentation": "

Specifies a filter that limits the response to only policies that match the specified\n criteria. For example, you list only the policies that reference a specified\n principal.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#ListPoliciesOutput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.verifiedpermissions#NextToken", + "traits": { + "smithy.api#documentation": "

If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.

" + } + }, + "policies": { + "target": "com.amazonaws.verifiedpermissions#PolicyList", + "traits": { + "smithy.api#documentation": "

Lists all policies that are available in the specified policy store.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#ListPolicyStores": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#ListPolicyStoresInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#ListPolicyStoresOutput" + }, + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to return a paginated list of all policy stores in the calling Amazon Web Services account", + "smithy.api#documentation": "

Returns a paginated list of all policy stores in the calling Amazon Web Services account.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "policyStores" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.verifiedpermissions#ListPolicyStoresInput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.verifiedpermissions#NextToken", + "traits": { + "smithy.api#documentation": "

Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.

" + } + }, + "maxResults": { + "target": "com.amazonaws.verifiedpermissions#MaxResults", + "traits": { + "smithy.api#documentation": "

Specifies the total number of results that you want included on each page \n of the response. If you do not include this parameter, it defaults to a value that is \n specific to the operation. If additional items exist beyond the number you specify, the\n NextToken response element is returned with a value (not null).\n Include the specified value as the NextToken request parameter in the next \n call to the operation to get the next part of the results. Note that the service might \n return fewer results than the maximum even when there are more results available. You \n should check NextToken after every operation to ensure that you receive all\n of the results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#ListPolicyStoresOutput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.verifiedpermissions#NextToken", + "traits": { + "smithy.api#documentation": "

If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.

" + } + }, + "policyStores": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreList", + "traits": { + "smithy.api#documentation": "

The list of policy stores in the account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#ListPolicyTemplates": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#ListPolicyTemplatesInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#ListPolicyTemplatesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to return a paginated list of all policy templates in the specified policy store", + "smithy.api#documentation": "

Returns a paginated list of all policy templates in the specified policy store.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "policyTemplates" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.verifiedpermissions#ListPolicyTemplatesInput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

Specifies the ID of the policy store that contains the policy templates you want to list.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.verifiedpermissions#NextToken", + "traits": { + "smithy.api#documentation": "

Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.

" + } + }, + "maxResults": { + "target": "com.amazonaws.verifiedpermissions#MaxResults", + "traits": { + "smithy.api#documentation": "

Specifies the total number of results that you want included on each page \n of the response. If you do not include this parameter, it defaults to a value that is \n specific to the operation. If additional items exist beyond the number you specify, the\n NextToken response element is returned with a value (not null).\n Include the specified value as the NextToken request parameter in the next \n call to the operation to get the next part of the results. Note that the service might \n return fewer results than the maximum even when there are more results available. You \n should check NextToken after every operation to ensure that you receive all\n of the results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#ListPolicyTemplatesOutput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.verifiedpermissions#NextToken", + "traits": { + "smithy.api#documentation": "

If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.

" + } + }, + "policyTemplates": { + "target": "com.amazonaws.verifiedpermissions#PolicyTemplatesList", + "traits": { + "smithy.api#documentation": "

The list of the policy templates in the specified policy store.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#LongAttribute": { + "type": "long" + }, + "com.amazonaws.verifiedpermissions#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.verifiedpermissions#Namespace": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.verifiedpermissions#NamespaceList": { + "type": "list", + "member": { + "target": "com.amazonaws.verifiedpermissions#Namespace" + } + }, + "com.amazonaws.verifiedpermissions#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 8000 + }, + "smithy.api#pattern": "^[A-Za-z0-9-_=+/\\.]*$" + } + }, + "com.amazonaws.verifiedpermissions#OpenIdIssuer": { + "type": "enum", + "members": { + "COGNITO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COGNITO" + } + } + } + }, + "com.amazonaws.verifiedpermissions#ParentList": { + "type": "list", + "member": { + "target": "com.amazonaws.verifiedpermissions#EntityIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.verifiedpermissions#Policy": { + "type": "resource", + "identifiers": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId" + }, + "policyId": { + "target": "com.amazonaws.verifiedpermissions#PolicyId" + } + }, + "create": { + "target": "com.amazonaws.verifiedpermissions#CreatePolicy" + }, + "read": { + "target": "com.amazonaws.verifiedpermissions#GetPolicy" + }, + "update": { + "target": "com.amazonaws.verifiedpermissions#UpdatePolicy" + }, + "delete": { + "target": "com.amazonaws.verifiedpermissions#DeletePolicy" + }, + "list": { + "target": "com.amazonaws.verifiedpermissions#ListPolicies" + }, + "traits": { + "aws.cloudformation#cfnResource": {}, + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.verifiedpermissions#PolicyDefinition": { + "type": "union", + "members": { + "static": { + "target": "com.amazonaws.verifiedpermissions#StaticPolicyDefinition", + "traits": { + "smithy.api#documentation": "

A structure that describes a static policy. An static policy doesn't use a template or allow\n placeholders for entities.

" + } + }, + "templateLinked": { + "target": "com.amazonaws.verifiedpermissions#TemplateLinkedPolicyDefinition", + "traits": { + "smithy.api#documentation": "

A structure that describes a policy that was instantiated from a template. The\n template can specify placeholders for principal and resource.\n When you use CreatePolicy to create a policy from a template, you specify the exact\n principal and resource to use for the instantiated policy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains the details for a Cedar policy definition. It includes the\n policy type, a description, and a policy body. This is a top level data type used to\n create a policy.

\n

This data type is used as a request parameter for the CreatePolicy operation. This\n structure must always have either an static or a templateLinked\n element.

" + } + }, + "com.amazonaws.verifiedpermissions#PolicyDefinitionDetail": { + "type": "union", + "members": { + "static": { + "target": "com.amazonaws.verifiedpermissions#StaticPolicyDefinitionDetail", + "traits": { + "smithy.api#documentation": "

Information about a static policy that wasn't created with a policy template.

" + } + }, + "templateLinked": { + "target": "com.amazonaws.verifiedpermissions#TemplateLinkedPolicyDefinitionDetail", + "traits": { + "smithy.api#documentation": "

Information about a template-linked policy that was created by instantiating a policy template.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that describes a policy definition. It must always have either an\n static or a templateLinked element.

\n

This data type is used as a response parameter for the GetPolicy operation.

" + } + }, + "com.amazonaws.verifiedpermissions#PolicyDefinitionItem": { + "type": "union", + "members": { + "static": { + "target": "com.amazonaws.verifiedpermissions#StaticPolicyDefinitionItem", + "traits": { + "smithy.api#documentation": "

Information about a static policy that wasn't created with a policy template.

" + } + }, + "templateLinked": { + "target": "com.amazonaws.verifiedpermissions#TemplateLinkedPolicyDefinitionItem", + "traits": { + "smithy.api#documentation": "

Information about a template-linked policy that was created by instantiating a policy template.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that describes a PolicyDefinintion. It will\n always have either an StaticPolicy or a TemplateLinkedPolicy\n element.

\n

This data type is used as a response parameter for the CreatePolicy and ListPolicies\n operations.

" + } + }, + "com.amazonaws.verifiedpermissions#PolicyFilter": { + "type": "structure", + "members": { + "principal": { + "target": "com.amazonaws.verifiedpermissions#EntityReference", + "traits": { + "smithy.api#documentation": "

Filters the output to only policies that reference the specified principal.

" + } + }, + "resource": { + "target": "com.amazonaws.verifiedpermissions#EntityReference", + "traits": { + "smithy.api#documentation": "

Filters the output to only policies that reference the specified resource.

" + } + }, + "policyType": { + "target": "com.amazonaws.verifiedpermissions#PolicyType", + "traits": { + "smithy.api#documentation": "

Filters the output to only policies of the specified type.

" + } + }, + "policyTemplateId": { + "target": "com.amazonaws.verifiedpermissions#PolicyTemplateId", + "traits": { + "smithy.api#documentation": "

Filters the output to only template-linked policies that were instantiated from the specified\n policy template.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a filter to refine policies returned in a query.

\n

This data type is used as a response parameter for the ListPolicies operation.

" + } + }, + "com.amazonaws.verifiedpermissions#PolicyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]*$" + } + }, + "com.amazonaws.verifiedpermissions#PolicyItem": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

The identifier of the PolicyStore where the policy you want information about is\n stored.

", + "smithy.api#required": {} + } + }, + "policyId": { + "target": "com.amazonaws.verifiedpermissions#PolicyId", + "traits": { + "smithy.api#documentation": "

The identifier of the policy you want information about.

", + "smithy.api#required": {} + } + }, + "policyType": { + "target": "com.amazonaws.verifiedpermissions#PolicyType", + "traits": { + "smithy.api#documentation": "

The type of the policy. This is one of the following values:

\n ", + "smithy.api#required": {} + } + }, + "principal": { + "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", + "traits": { + "smithy.api#documentation": "

The principal associated with the policy.

" + } + }, + "resource": { + "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", + "traits": { + "smithy.api#documentation": "

The resource associated with the policy.

" + } + }, + "definition": { + "target": "com.amazonaws.verifiedpermissions#PolicyDefinitionItem", + "traits": { + "smithy.api#documentation": "

The policy definition of an item in the list of policies returned.

", + "smithy.api#required": {} + } + }, + "createdDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "

The date and time the policy was created.

", + "smithy.api#required": {} + } + }, + "lastUpdatedDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "

The date and time the policy was most recently updated.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a policy.

\n

This data type is used as a response parameter for the ListPolicies operation.

" + } + }, + "com.amazonaws.verifiedpermissions#PolicyList": { + "type": "list", + "member": { + "target": "com.amazonaws.verifiedpermissions#PolicyItem" + } + }, + "com.amazonaws.verifiedpermissions#PolicyStatement": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10000 + } + } + }, + "com.amazonaws.verifiedpermissions#PolicyStore": { + "type": "resource", + "identifiers": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId" + } + }, + "create": { + "target": "com.amazonaws.verifiedpermissions#CreatePolicyStore" + }, + "read": { + "target": "com.amazonaws.verifiedpermissions#GetPolicyStore" + }, + "update": { + "target": "com.amazonaws.verifiedpermissions#UpdatePolicyStore" + }, + "delete": { + "target": "com.amazonaws.verifiedpermissions#DeletePolicyStore" + }, + "list": { + "target": "com.amazonaws.verifiedpermissions#ListPolicyStores" + }, + "operations": [ + { + "target": "com.amazonaws.verifiedpermissions#GetSchema" + }, + { + "target": "com.amazonaws.verifiedpermissions#IsAuthorized" + }, + { + "target": "com.amazonaws.verifiedpermissions#IsAuthorizedWithToken" + }, + { + "target": "com.amazonaws.verifiedpermissions#PutSchema" + } + ], + "resources": [ + { + "target": "com.amazonaws.verifiedpermissions#IdentitySource" + }, + { + "target": "com.amazonaws.verifiedpermissions#Policy" + }, + { + "target": "com.amazonaws.verifiedpermissions#PolicyTemplate" + } + ], + "traits": { + "aws.api#arn": { + "template": "policy-store/{policyStoreId}", + "noRegion": true + }, + "aws.cloudformation#cfnResource": {}, + "aws.iam#disableConditionKeyInference": {}, + "aws.iam#iamResource": { + "name": "policy-store" + }, + "smithy.api#documentation": "Represents a policy store that you can place schema, policies, and policy templates in to validate authorization requests" + } + }, + "com.amazonaws.verifiedpermissions#PolicyStoreId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]*$" + } + }, + "com.amazonaws.verifiedpermissions#PolicyStoreItem": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the policy store.

", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.verifiedpermissions#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the policy store.

", + "smithy.api#required": {} + } + }, + "createdDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "

The date and time the policy was created.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a policy store.

\n

This data type is used as a response parameter for the ListPolicyStores\n operation.

" + } + }, + "com.amazonaws.verifiedpermissions#PolicyStoreList": { + "type": "list", + "member": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreItem" + } + }, + "com.amazonaws.verifiedpermissions#PolicyTemplate": { + "type": "resource", + "identifiers": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId" + }, + "policyTemplateId": { + "target": "com.amazonaws.verifiedpermissions#PolicyTemplateId" + } + }, + "create": { + "target": "com.amazonaws.verifiedpermissions#CreatePolicyTemplate" + }, + "read": { + "target": "com.amazonaws.verifiedpermissions#GetPolicyTemplate" + }, + "update": { + "target": "com.amazonaws.verifiedpermissions#UpdatePolicyTemplate" + }, + "delete": { + "target": "com.amazonaws.verifiedpermissions#DeletePolicyTemplate" + }, + "list": { + "target": "com.amazonaws.verifiedpermissions#ListPolicyTemplates" + }, + "traits": { + "aws.cloudformation#cfnResource": {}, + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.verifiedpermissions#PolicyTemplateDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 150 + } + } + }, + "com.amazonaws.verifiedpermissions#PolicyTemplateId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]*$" + } + }, + "com.amazonaws.verifiedpermissions#PolicyTemplateItem": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the policy store that contains the template.

", + "smithy.api#required": {} + } + }, + "policyTemplateId": { + "target": "com.amazonaws.verifiedpermissions#PolicyTemplateId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the policy template.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.verifiedpermissions#PolicyTemplateDescription", + "traits": { + "smithy.api#documentation": "

The description attached to the policy template.

" + } + }, + "createdDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "

The date and time that the policy template was created.

", + "smithy.api#required": {} + } + }, + "lastUpdatedDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "

The date and time that the policy template was most recently updated.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about a policy template

\n

This data type is used as a response parameter for the ListPolicyTemplates\n operation.

" + } + }, + "com.amazonaws.verifiedpermissions#PolicyTemplatesList": { + "type": "list", + "member": { + "target": "com.amazonaws.verifiedpermissions#PolicyTemplateItem" + } + }, + "com.amazonaws.verifiedpermissions#PolicyType": { + "type": "enum", + "members": { + "STATIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STATIC" + } + }, + "TEMPLATE_LINKED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEMPLATE_LINKED" + } + } + } + }, + "com.amazonaws.verifiedpermissions#PrincipalEntityType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.verifiedpermissions#PutSchema": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#PutSchemaInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#PutSchemaOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ConflictException" + }, + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.verifiedpermissions#ServiceQuotaExceededException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to create or update the policy schema in the specified policy store", + "smithy.api#documentation": "

Creates or updates the policy schema in the specified policy store. The schema is used to\n validate any Cedar policies and policy templates submitted to the policy store. Any changes to the schema\n validate only policies and templates submitted after the schema change. Existing\n policies and templates are not re-evaluated against the changed schema. If you later\n update a policy, then it is evaluated against the new schema at that time.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.verifiedpermissions#PutSchemaInput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

Specifies the ID of the policy store in which to place the schema.

", + "smithy.api#required": {} + } + }, + "definition": { + "target": "com.amazonaws.verifiedpermissions#SchemaDefinition", + "traits": { + "smithy.api#documentation": "

Specifies the definition of the schema to be stored. The schema definition must be\n written in Cedar schema JSON.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#PutSchemaOutput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

The unique ID of the policy store that contains the schema.

", + "smithy.api#required": {} + } + }, + "namespaces": { + "target": "com.amazonaws.verifiedpermissions#NamespaceList", + "traits": { + "smithy.api#documentation": "

Identifies the namespaces of the entities referenced by this schema.

", + "smithy.api#required": {} + } + }, + "createdDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "

The date and time that the schema was originally created.

", + "smithy.api#required": {} + } + }, + "lastUpdatedDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "

The date and time that the schema was last updated.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#RecordAttribute": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "com.amazonaws.verifiedpermissions#AttributeValue" + } + }, + "com.amazonaws.verifiedpermissions#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2500 + }, + "smithy.api#pattern": "^arn:[^:]*:[^:]*:[^:]*:[^:]*:.*$" + } + }, + "com.amazonaws.verifiedpermissions#ResourceConflict": { + "type": "structure", + "members": { + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique identifier of the resource involved in a conflict.

", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "com.amazonaws.verifiedpermissions#ResourceType", + "traits": { + "smithy.api#documentation": "

The type of the resource involved in a conflict.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a resource conflict.

" + } + }, + "com.amazonaws.verifiedpermissions#ResourceConflictList": { + "type": "list", + "member": { + "target": "com.amazonaws.verifiedpermissions#ResourceConflict" + } + }, + "com.amazonaws.verifiedpermissions#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique ID of the resource referenced in the failed request.

", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "com.amazonaws.verifiedpermissions#ResourceType", + "traits": { + "smithy.api#documentation": "

The resource type of the resource referenced in the failed request.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request failed because it references a resource that doesn't exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.verifiedpermissions#ResourceType": { + "type": "enum", + "members": { + "IDENTITY_SOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IDENTITY_SOURCE" + } + }, + "POLICY_STORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POLICY_STORE" + } + }, + "POLICY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POLICY" + } + }, + "POLICY_TEMPLATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POLICY_TEMPLATE" + } + }, + "SCHEMA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCHEMA" + } + } + } + }, + "com.amazonaws.verifiedpermissions#SchemaDefinition": { + "type": "union", + "members": { + "cedarJson": { + "target": "com.amazonaws.verifiedpermissions#SchemaJson", + "traits": { + "smithy.api#documentation": "

A JSON string representation of the schema supported by applications that use this\n policy store. For more information, see Policy store schema in the\n Amazon Verified Permissions User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains a list of principal types, resource types, and actions that can be specified\n in policies stored in the same policy store. If the validation mode for the policy store is set to\n STRICT, then policies that can't be validated by this schema are\n rejected by Verified Permissions and can't be stored in the policy store.

" + } + }, + "com.amazonaws.verifiedpermissions#SchemaJson": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10000 + } + } + }, + "com.amazonaws.verifiedpermissions#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique ID of the resource referenced in the failed request.

" + } + }, + "resourceType": { + "target": "com.amazonaws.verifiedpermissions#ResourceType", + "traits": { + "smithy.api#documentation": "

The resource type of the resource referenced in the failed request.

", + "smithy.api#required": {} + } + }, + "serviceCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The code for the Amazon Web Service that owns the quota.

" + } + }, + "quotaCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The quota code recognized by the Amazon Web Services Service Quotas service.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The request failed because it would cause a service quota to be exceeded.

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.verifiedpermissions#SetAttribute": { + "type": "list", + "member": { + "target": "com.amazonaws.verifiedpermissions#AttributeValue" + } + }, + "com.amazonaws.verifiedpermissions#StaticPolicyDefinition": { + "type": "structure", + "members": { + "description": { + "target": "com.amazonaws.verifiedpermissions#StaticPolicyDescription", + "traits": { + "smithy.api#documentation": "

The description of the static policy.

" + } + }, + "statement": { + "target": "com.amazonaws.verifiedpermissions#PolicyStatement", + "traits": { + "smithy.api#documentation": "

The policy content of the static policy, written in the Cedar policy language.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a static policy.

\n

This data type is used as a field that is part of the PolicyDefinitionDetail\n type.

" + } + }, + "com.amazonaws.verifiedpermissions#StaticPolicyDefinitionDetail": { + "type": "structure", + "members": { + "description": { + "target": "com.amazonaws.verifiedpermissions#StaticPolicyDescription", + "traits": { + "smithy.api#documentation": "

A description of the static policy.

" + } + }, + "statement": { + "target": "com.amazonaws.verifiedpermissions#PolicyStatement", + "traits": { + "smithy.api#documentation": "

The content of the static policy written in the Cedar policy language.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains details about a static policy. It includes the description and\n policy body.

\n

This data type is used within a PolicyDefinition structure as\n part of a request parameter for the CreatePolicy operation.

" + } + }, + "com.amazonaws.verifiedpermissions#StaticPolicyDefinitionItem": { + "type": "structure", + "members": { + "description": { + "target": "com.amazonaws.verifiedpermissions#StaticPolicyDescription", + "traits": { + "smithy.api#documentation": "

A description of the static policy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains details about a static policy. It includes the description and\n policy statement.

\n

This data type is used within a PolicyDefinition structure as\n part of a request parameter for the CreatePolicy operation.

" + } + }, + "com.amazonaws.verifiedpermissions#StaticPolicyDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 150 + } + } + }, + "com.amazonaws.verifiedpermissions#StringAttribute": { + "type": "string" + }, + "com.amazonaws.verifiedpermissions#TemplateLinkedPolicyDefinition": { + "type": "structure", + "members": { + "policyTemplateId": { + "target": "com.amazonaws.verifiedpermissions#PolicyTemplateId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the policy template used to create this policy.

", + "smithy.api#required": {} + } + }, + "principal": { + "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", + "traits": { + "smithy.api#documentation": "

The principal associated with this template-linked policy. Verified Permissions substitutes this principal for the\n ?principal placeholder in the policy template when it evaluates an authorization\n request.

" + } + }, + "resource": { + "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", + "traits": { + "smithy.api#documentation": "

The resource associated with this template-linked policy. Verified Permissions substitutes this resource for the\n ?resource placeholder in the policy template when it evaluates an authorization\n request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a policy created by instantiating a policy template.

" + } + }, + "com.amazonaws.verifiedpermissions#TemplateLinkedPolicyDefinitionDetail": { + "type": "structure", + "members": { + "policyTemplateId": { + "target": "com.amazonaws.verifiedpermissions#PolicyTemplateId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the policy template used to create this policy.

", + "smithy.api#required": {} + } + }, + "principal": { + "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", + "traits": { + "smithy.api#documentation": "

The principal associated with this template-linked policy. Verified Permissions substitutes this principal for the\n ?principal placeholder in the policy template when it evaluates an authorization\n request.

" + } + }, + "resource": { + "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", + "traits": { + "smithy.api#documentation": "

The resource associated with this template-linked policy. Verified Permissions substitutes this resource for the\n ?resource placeholder in the policy template when it evaluates an authorization\n request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a policy that was

\n

\n

created by instantiating a policy template.

\n

This

" + } + }, + "com.amazonaws.verifiedpermissions#TemplateLinkedPolicyDefinitionItem": { + "type": "structure", + "members": { + "policyTemplateId": { + "target": "com.amazonaws.verifiedpermissions#PolicyTemplateId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the policy template used to create this policy.

", + "smithy.api#required": {} + } + }, + "principal": { + "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", + "traits": { + "smithy.api#documentation": "

The principal associated with this template-linked policy. Verified Permissions substitutes this principal for the\n ?principal placeholder in the policy template when it evaluates an authorization\n request.

" + } + }, + "resource": { + "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", + "traits": { + "smithy.api#documentation": "

The resource associated with this template-linked policy. Verified Permissions substitutes this resource for the\n ?resource placeholder in the policy template when it evaluates an authorization\n request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a policy created by instantiating a policy template.

\n

This

" + } + }, + "com.amazonaws.verifiedpermissions#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "serviceCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The code for the Amazon Web Service that owns the quota.

" + } + }, + "quotaCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The quota code recognized by the Amazon Web Services Service Quotas service.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The request failed because it exceeded a throttling quota.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": { + "throttling": true + } + } + }, + "com.amazonaws.verifiedpermissions#TimestampFormat": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } + }, + "com.amazonaws.verifiedpermissions#Token": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 131072 + }, + "smithy.api#pattern": "^[A-Za-z0-9-_=]+.[A-Za-z0-9-_=]+.[A-Za-z0-9-_=]+$" + } + }, + "com.amazonaws.verifiedpermissions#UpdateCognitoUserPoolConfiguration": { + "type": "structure", + "members": { + "userPoolArn": { + "target": "com.amazonaws.verifiedpermissions#UserPoolArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Cognito user pool associated with this identity source.

", + "smithy.api#required": {} + } + }, + "clientIds": { + "target": "com.amazonaws.verifiedpermissions#ClientIds", + "traits": { + "smithy.api#documentation": "

The client ID of an app client that is configured for the specified Amazon Cognito user\n pool.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains configuration details of a Amazon Cognito user pool for use with an identity source.

" + } + }, + "com.amazonaws.verifiedpermissions#UpdateConfiguration": { + "type": "union", + "members": { + "cognitoUserPoolConfiguration": { + "target": "com.amazonaws.verifiedpermissions#UpdateCognitoUserPoolConfiguration", + "traits": { + "smithy.api#documentation": "

Contains configuration details of a Amazon Cognito user pool.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains an updated configuration to replace the configuration in an existing\n identity source.

\n \n

At this time, the only valid member of this structure is a Amazon Cognito user pool\n configuration.

\n

You must specify a userPoolArn, and optionally, a\n ClientId.

\n " + } + }, + "com.amazonaws.verifiedpermissions#UpdateIdentitySource": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#UpdateIdentitySourceInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#UpdateIdentitySourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ConflictException" + }, + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to update the specified identity source to use a new identity provider (IdP) source, or to change the mapping of identities from the IdP to a different principal entity type", + "smithy.api#documentation": "

Updates the specified identity source to use a new identity provider (IdP) source, or to change\n the mapping of identities from the IdP to a different principal entity type.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.verifiedpermissions#UpdateIdentitySourceInput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

Specifies the ID of the policy store that contains the identity source that you want to update.

", + "smithy.api#required": {} + } + }, + "identitySourceId": { + "target": "com.amazonaws.verifiedpermissions#IdentitySourceId", + "traits": { + "smithy.api#documentation": "

Specifies the ID of the identity source that you want to update.

", + "smithy.api#required": {} + } + }, + "updateConfiguration": { + "target": "com.amazonaws.verifiedpermissions#UpdateConfiguration", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

Specifies the details required to communicate with the identity provider (IdP)\n associated with this identity source.

\n \n

At this time, the only valid member of this structure is a Amazon Cognito user pool\n configuration.

\n

You must specify a userPoolArn, and optionally, a\n ClientId.

\n ", + "smithy.api#required": {} + } + }, + "principalEntityType": { + "target": "com.amazonaws.verifiedpermissions#PrincipalEntityType", + "traits": { + "smithy.api#documentation": "

Specifies the data type of principals generated for identities authenticated by the\n identity source.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#UpdateIdentitySourceOutput": { + "type": "structure", + "members": { + "createdDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "

The date and time that the updated identity source was originally created.

", + "smithy.api#required": {} + } + }, + "identitySourceId": { + "target": "com.amazonaws.verifiedpermissions#IdentitySourceId", + "traits": { + "smithy.api#documentation": "

The ID of the updated identity source.

", + "smithy.api#required": {} + } + }, + "lastUpdatedDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "

The date and time that the identity source was most recently updated.

", + "smithy.api#required": {} + } + }, + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

The ID of the policy store that contains the updated identity source.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#UpdatePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#UpdatePolicyInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#UpdatePolicyOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ConflictException" + }, + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.verifiedpermissions#ServiceQuotaExceededException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to modify the specified Cedar static policy in the specified policy store", + "smithy.api#documentation": "

Modifies a Cedar static policy in the specified policy store. You can change only certain elements of\n the UpdatePolicyDefinition parameter. You can directly update only static policies. To\n change a template-linked policy, you must update the template instead, using UpdatePolicyTemplate.

\n \n

If policy validation is enabled in the policy store, then updating a static policy causes Verified Permissions to\n validate the policy against the schema in the policy store. If the updated static policy doesn't pass\n validation, the operation fails and the update isn't stored.

\n ", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.verifiedpermissions#UpdatePolicyDefinition": { + "type": "union", + "members": { + "static": { + "target": "com.amazonaws.verifiedpermissions#UpdateStaticPolicyDefinition", + "traits": { + "smithy.api#documentation": "

Contains details about the updates to be applied to a static policy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about updates to be applied to a policy.

\n

This data type is used as a request parameter in the UpdatePolicy operation.

" + } + }, + "com.amazonaws.verifiedpermissions#UpdatePolicyInput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

Specifies the ID of the policy store that contains the policy that you want to update.

", + "smithy.api#required": {} + } + }, + "policyId": { + "target": "com.amazonaws.verifiedpermissions#PolicyId", + "traits": { + "smithy.api#documentation": "

Specifies the ID of the policy that you want to update. To find this value, you can\n use ListPolicies.

", + "smithy.api#required": {} + } + }, + "definition": { + "target": "com.amazonaws.verifiedpermissions#UpdatePolicyDefinition", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

Specifies the updated policy content that you want to replace on the specified policy.\n The content must be valid Cedar policy language text.

\n

You can change only the following elements from the policy definition:

\n \n

You can't change the following elements:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#UpdatePolicyOutput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

The ID of the policy store that contains the policy that was updated.

", + "smithy.api#required": {} + } + }, + "policyId": { + "target": "com.amazonaws.verifiedpermissions#PolicyId", + "traits": { + "smithy.api#documentation": "

The ID of the policy that was updated.

", + "smithy.api#required": {} + } + }, + "policyType": { + "target": "com.amazonaws.verifiedpermissions#PolicyType", + "traits": { + "smithy.api#documentation": "

The type of the policy that was updated.

", + "smithy.api#required": {} + } + }, + "principal": { + "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", + "traits": { + "smithy.api#documentation": "

The principal specified in the policy's scope. This element isn't included in the\n response when Principal isn't present in the policy content.

" + } + }, + "resource": { + "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", + "traits": { + "smithy.api#documentation": "

The resource specified in the policy's scope. This element isn't included in the\n response when Resource isn't present in the policy content.

" + } + }, + "createdDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "

The date and time that the policy was originally created.

", + "smithy.api#required": {} + } + }, + "lastUpdatedDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "

The date and time that the policy was most recently updated.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#UpdatePolicyStore": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#UpdatePolicyStoreInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#UpdatePolicyStoreOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ConflictException" + }, + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to modify the validation setting for a policy store", + "smithy.api#documentation": "

Modifies the validation setting for a policy store.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.verifiedpermissions#UpdatePolicyStoreInput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

Specifies the ID of the policy store that you want to update

", + "smithy.api#required": {} + } + }, + "validationSettings": { + "target": "com.amazonaws.verifiedpermissions#ValidationSettings", + "traits": { + "smithy.api#documentation": "

A structure that defines the validation settings that want to enable for the\n policy store.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#UpdatePolicyStoreOutput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

The ID of the updated policy store.

", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.verifiedpermissions#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the updated policy store.

", + "smithy.api#required": {} + } + }, + "createdDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "

The date and time that the policy store was originally created.

", + "smithy.api#required": {} + } + }, + "lastUpdatedDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "

The date and time that the policy store was most recently updated.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#UpdatePolicyTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#UpdatePolicyTemplateInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#UpdatePolicyTemplateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ConflictException" + }, + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to update the specified policy template", + "smithy.api#documentation": "

Updates the specified policy template. You can update only the description and the some elements\n of the policyBody.

\n \n

Changes you make to the policy template content are immediately reflected in authorization\n decisions that involve all template-linked policies instantiated from this template.

\n ", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.verifiedpermissions#UpdatePolicyTemplateInput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

Specifies the ID of the policy store that contains the policy template that you want to update.

", + "smithy.api#required": {} + } + }, + "policyTemplateId": { + "target": "com.amazonaws.verifiedpermissions#PolicyTemplateId", + "traits": { + "smithy.api#documentation": "

Specifies the ID of the policy template that you want to update.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.verifiedpermissions#PolicyTemplateDescription", + "traits": { + "smithy.api#documentation": "

Specifies a new description to apply to the policy template.

" + } + }, + "statement": { + "target": "com.amazonaws.verifiedpermissions#PolicyStatement", + "traits": { + "smithy.api#documentation": "

Specifies new statement content written in Cedar policy language to replace the\n current body of the policy template.

\n

You can change only the following elements of the policy body:

\n \n

You can't change the following elements:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#UpdatePolicyTemplateOutput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "

The ID of the policy store that contains the updated policy template.

", + "smithy.api#required": {} + } + }, + "policyTemplateId": { + "target": "com.amazonaws.verifiedpermissions#PolicyTemplateId", + "traits": { + "smithy.api#documentation": "

The ID of the updated policy template.

", + "smithy.api#required": {} + } + }, + "createdDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "

The date and time that the policy template was originally created.

", + "smithy.api#required": {} + } + }, + "lastUpdatedDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "

The date and time that the policy template was most recently updated.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#UpdateStaticPolicyDefinition": { + "type": "structure", + "members": { + "description": { + "target": "com.amazonaws.verifiedpermissions#StaticPolicyDescription", + "traits": { + "smithy.api#documentation": "

Specifies the description to be added to or replaced on the static policy.

" + } + }, + "statement": { + "target": "com.amazonaws.verifiedpermissions#PolicyStatement", + "traits": { + "smithy.api#documentation": "

Specifies the Cedar policy language text to be added to or replaced on the static policy.

\n \n

You can change only the following elements from the original content:

\n \n

You can't change the following elements:

\n \n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an update to a static policy.

" + } + }, + "com.amazonaws.verifiedpermissions#UserPoolArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^arn:[a-zA-Z0-9-]+:cognito-idp:(([a-zA-Z0-9-]+:\\d{12}:userpool/[\\w-]+_[0-9a-zA-Z]+))$" + } + }, + "com.amazonaws.verifiedpermissions#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "fieldList": { + "target": "com.amazonaws.verifiedpermissions#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "

The list of fields that aren't valid.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The request failed because one or more input parameters don't satisfy their constraint\n requirements. The output is provided as a list of fields and a reason for each field that\n isn't valid.

\n

The possible reasons include the following:

\n ", + "smithy.api#error": "client" + } + }, + "com.amazonaws.verifiedpermissions#ValidationExceptionField": { + "type": "structure", + "members": { + "path": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The path to the specific element that Verified Permissions found to be not valid.

", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Describes the policy validation error.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about a field that failed policy validation.

" + } + }, + "com.amazonaws.verifiedpermissions#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.verifiedpermissions#ValidationExceptionField" + } + }, + "com.amazonaws.verifiedpermissions#ValidationMode": { + "type": "enum", + "members": { + "OFF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OFF" + } + }, + "STRICT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRICT" + } + } + } + }, + "com.amazonaws.verifiedpermissions#ValidationSettings": { + "type": "structure", + "members": { + "mode": { + "target": "com.amazonaws.verifiedpermissions#ValidationMode", + "traits": { + "smithy.api#documentation": "

The validation mode currently configured for this policy store. The valid values are:

\n \n \n

If Mode=STRICT and the policy store doesn't contain a schema, Verified Permissions rejects\n all static policies and policy templates because there is no schema to validate against.

\n

To submit a static policy or policy template without a schema, you must turn off validation.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains Cedar policy validation settings for the policy store. The\n validation mode determines which validation failures that Cedar considers serious\n enough to block acceptance of a new or edited static policy or policy template.

\n

This data type is used as a request parameter in the CreatePolicyStore and UpdatePolicyStore operations.

" + } + }, + "com.amazonaws.verifiedpermissions#VerifiedPermissions": { + "type": "service", + "version": "2021-12-01", + "resources": [ + { + "target": "com.amazonaws.verifiedpermissions#PolicyStore" + } + ], + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#AccessDeniedException" + }, + { + "target": "com.amazonaws.verifiedpermissions#InternalServerException" + }, + { + "target": "com.amazonaws.verifiedpermissions#ThrottlingException" + }, + { + "target": "com.amazonaws.verifiedpermissions#ThrottlingException" + }, + { + "target": "com.amazonaws.verifiedpermissions#ValidationException" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "VerifiedPermissions", + "arnNamespace": "verifiedpermissions", + "endpointPrefix": "verifiedpermissions" + }, + "aws.auth#sigv4": { + "name": "verifiedpermissions" + }, + "aws.iam#supportedPrincipalTypes": [ + "Root", + "IAMUser", + "IAMRole", + "FederatedUser" + ], + "aws.protocols#awsJson1_0": {}, + "smithy.api#documentation": "

Amazon Verified Permissions is a permissions management service from Amazon Web Services. You can use Verified Permissions to manage\n permissions for your application, and authorize user access based on those permissions.\n Using Verified Permissions, application developers can grant access based on information about the\n users, resources, and requested actions. You can also evaluate additional information\n like group membership, attributes of the resources, and session context, such as time of\n request and IP addresses. Verified Permissions manages these permissions by letting you create and\n store authorization policies for your applications, such as consumer-facing web sites\n and enterprise business systems.

\n

Verified Permissions uses Cedar as the policy language to express your permission requirements.\n Cedar supports both role-based access control (RBAC) and attribute-based access\n control (ABAC) authorization models.

\n

For more information about configuring, administering, and using Amazon Verified Permissions in your\n applications, see the Amazon Verified Permissions User Guide.

\n

For more information about the Cedar policy language, see the Cedar Policy Language Guide.

\n \n

When you write Cedar policies that reference principals, resources and actions,\n you can define the unique identifiers used for each of those elements. We strongly\n recommend that you follow these best practices:

\n \n \n

Several operations return structures that appear similar, but have different purposes.\n As new functionality is added to the product, the structure used in a parameter of one\n operation might need to change in a way that wouldn't make sense for the same parameter\n in a different operation. To help you understand the purpose of each, the following\n naming convention is used for the structures:

\n ", + "smithy.api#title": "Amazon Verified Permissions", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://verifiedpermissions-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://verifiedpermissions-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://verifiedpermissions.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://verifiedpermissions.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://verifiedpermissions-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://verifiedpermissions-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://verifiedpermissions.us-gov-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://verifiedpermissions.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://verifiedpermissions-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://verifiedpermissions-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://verifiedpermissions.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://verifiedpermissions.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://verifiedpermissions-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://verifiedpermissions.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://verifiedpermissions-fips.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://verifiedpermissions-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://verifiedpermissions.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://verifiedpermissions.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://verifiedpermissions-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://verifiedpermissions.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" + } + } + } + } +} \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/wafv2.json b/codegen/sdk-codegen/aws-models/wafv2.json index 61219bb9dbb8..9080fcd22e5f 100644 --- a/codegen/sdk-codegen/aws-models/wafv2.json +++ b/codegen/sdk-codegen/aws-models/wafv2.json @@ -1,12677 +1,12860 @@ { - "smithy": "2.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] - }, - "shapes": { - "com.amazonaws.wafv2#APIKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.wafv2#APIKeySummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#APIKeySummary" - } - }, - "com.amazonaws.wafv2#APIKeySummary": { - "type": "structure", - "members": { - "TokenDomains": { - "target": "com.amazonaws.wafv2#TokenDomains", - "traits": { - "smithy.api#documentation": "

The token domains that are defined in this API key.

" - } - }, - "APIKey": { - "target": "com.amazonaws.wafv2#APIKey", - "traits": { - "smithy.api#documentation": "

The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.

" - } - }, - "CreationTimestamp": { - "target": "com.amazonaws.wafv2#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that the key was created.

" - } - }, - "Version": { - "target": "com.amazonaws.wafv2#APIKeyVersion", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Internal value used by WAF to manage the key.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information for a single API key.

\n

API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. \n The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. \n For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.

" - } - }, - "com.amazonaws.wafv2#APIKeyTokenDomains": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#TokenDomain" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.wafv2#APIKeyVersion": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.wafv2#AWSManagedRulesATPRuleSet": { - "type": "structure", - "members": { - "LoginPath": { - "target": "com.amazonaws.wafv2#String", - "traits": { - "smithy.api#documentation": "

The path of the login endpoint for your application. For example, for the URL\n https://example.com/web/login, you would provide the path\n /web/login.

\n

The rule group inspects only HTTP POST requests to your specified login endpoint.

", - "smithy.api#required": {} - } - }, - "RequestInspection": { - "target": "com.amazonaws.wafv2#RequestInspection", - "traits": { - "smithy.api#documentation": "

The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage.

" - } - }, - "ResponseInspection": { - "target": "com.amazonaws.wafv2#ResponseInspection", - "traits": { - "smithy.api#documentation": "

The criteria for inspecting responses to login requests, used by the ATP rule group to track login failure rates.

\n

The ATP rule group evaluates the responses that your protected resources send back to client login attempts, keeping count of successful and failed attempts from each IP address and client session. Using this information, the rule group labels \n and mitigates requests from client sessions and IP addresses that submit too many failed login attempts in a short amount of time.

\n \n

Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Details for your use of the account takeover prevention managed rule group, AWSManagedRulesATPRuleSet. This configuration is used in ManagedRuleGroupConfig.

" - } - }, - "com.amazonaws.wafv2#AWSManagedRulesBotControlRuleSet": { - "type": "structure", - "members": { - "InspectionLevel": { - "target": "com.amazonaws.wafv2#InspectionLevel", - "traits": { - "smithy.api#documentation": "

The inspection level to use for the Bot Control rule group. The common level is the least expensive. The \n targeted level includes all common level rules and adds rules with more advanced inspection criteria. For \n details, see WAF Bot Control rule group\n in the WAF Developer Guide.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Details for your use of the Bot Control managed rule group, AWSManagedRulesBotControlRuleSet. This configuration is used in ManagedRuleGroupConfig.

" - } - }, - "com.amazonaws.wafv2#AWSWAF_20190729": { - "type": "service", - "version": "2019-07-29", - "operations": [ - { - "target": "com.amazonaws.wafv2#AssociateWebACL" - }, - { - "target": "com.amazonaws.wafv2#CheckCapacity" - }, - { - "target": "com.amazonaws.wafv2#CreateAPIKey" - }, - { - "target": "com.amazonaws.wafv2#CreateIPSet" - }, - { - "target": "com.amazonaws.wafv2#CreateRegexPatternSet" - }, - { - "target": "com.amazonaws.wafv2#CreateRuleGroup" - }, - { - "target": "com.amazonaws.wafv2#CreateWebACL" - }, - { - "target": "com.amazonaws.wafv2#DeleteFirewallManagerRuleGroups" - }, - { - "target": "com.amazonaws.wafv2#DeleteIPSet" - }, - { - "target": "com.amazonaws.wafv2#DeleteLoggingConfiguration" - }, - { - "target": "com.amazonaws.wafv2#DeletePermissionPolicy" - }, - { - "target": "com.amazonaws.wafv2#DeleteRegexPatternSet" - }, - { - "target": "com.amazonaws.wafv2#DeleteRuleGroup" - }, - { - "target": "com.amazonaws.wafv2#DeleteWebACL" - }, - { - "target": "com.amazonaws.wafv2#DescribeAllManagedProducts" - }, - { - "target": "com.amazonaws.wafv2#DescribeManagedProductsByVendor" - }, - { - "target": "com.amazonaws.wafv2#DescribeManagedRuleGroup" - }, - { - "target": "com.amazonaws.wafv2#DisassociateWebACL" - }, - { - "target": "com.amazonaws.wafv2#GenerateMobileSdkReleaseUrl" - }, - { - "target": "com.amazonaws.wafv2#GetDecryptedAPIKey" - }, - { - "target": "com.amazonaws.wafv2#GetIPSet" - }, - { - "target": "com.amazonaws.wafv2#GetLoggingConfiguration" - }, - { - "target": "com.amazonaws.wafv2#GetManagedRuleSet" - }, - { - "target": "com.amazonaws.wafv2#GetMobileSdkRelease" - }, - { - "target": "com.amazonaws.wafv2#GetPermissionPolicy" - }, - { - "target": "com.amazonaws.wafv2#GetRateBasedStatementManagedKeys" - }, - { - "target": "com.amazonaws.wafv2#GetRegexPatternSet" - }, - { - "target": "com.amazonaws.wafv2#GetRuleGroup" - }, - { - "target": "com.amazonaws.wafv2#GetSampledRequests" - }, - { - "target": "com.amazonaws.wafv2#GetWebACL" - }, - { - "target": "com.amazonaws.wafv2#GetWebACLForResource" - }, - { - "target": "com.amazonaws.wafv2#ListAPIKeys" - }, - { - "target": "com.amazonaws.wafv2#ListAvailableManagedRuleGroups" - }, - { - "target": "com.amazonaws.wafv2#ListAvailableManagedRuleGroupVersions" - }, - { - "target": "com.amazonaws.wafv2#ListIPSets" - }, - { - "target": "com.amazonaws.wafv2#ListLoggingConfigurations" - }, - { - "target": "com.amazonaws.wafv2#ListManagedRuleSets" - }, - { - "target": "com.amazonaws.wafv2#ListMobileSdkReleases" - }, - { - "target": "com.amazonaws.wafv2#ListRegexPatternSets" - }, - { - "target": "com.amazonaws.wafv2#ListResourcesForWebACL" - }, - { - "target": "com.amazonaws.wafv2#ListRuleGroups" - }, - { - "target": "com.amazonaws.wafv2#ListTagsForResource" - }, - { - "target": "com.amazonaws.wafv2#ListWebACLs" - }, - { - "target": "com.amazonaws.wafv2#PutLoggingConfiguration" - }, - { - "target": "com.amazonaws.wafv2#PutManagedRuleSetVersions" - }, - { - "target": "com.amazonaws.wafv2#PutPermissionPolicy" - }, - { - "target": "com.amazonaws.wafv2#TagResource" - }, - { - "target": "com.amazonaws.wafv2#UntagResource" + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.wafv2#APIKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "\\S" + } }, - { - "target": "com.amazonaws.wafv2#UpdateIPSet" + "com.amazonaws.wafv2#APIKeySummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#APIKeySummary" + } }, - { - "target": "com.amazonaws.wafv2#UpdateManagedRuleSetVersionExpiryDate" + "com.amazonaws.wafv2#APIKeySummary": { + "type": "structure", + "members": { + "TokenDomains": { + "target": "com.amazonaws.wafv2#TokenDomains", + "traits": { + "smithy.api#documentation": "

The token domains that are defined in this API key.

" + } + }, + "APIKey": { + "target": "com.amazonaws.wafv2#APIKey", + "traits": { + "smithy.api#documentation": "

The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.

" + } + }, + "CreationTimestamp": { + "target": "com.amazonaws.wafv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the key was created.

" + } + }, + "Version": { + "target": "com.amazonaws.wafv2#APIKeyVersion", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Internal value used by WAF to manage the key.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information for a single API key.

\n

API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. \n The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. \n For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.

" + } }, - { - "target": "com.amazonaws.wafv2#UpdateRegexPatternSet" + "com.amazonaws.wafv2#APIKeyTokenDomains": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#TokenDomain" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } }, - { - "target": "com.amazonaws.wafv2#UpdateRuleGroup" + "com.amazonaws.wafv2#APIKeyVersion": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } }, - { - "target": "com.amazonaws.wafv2#UpdateWebACL" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "WAFV2", - "arnNamespace": "wafv2", - "cloudFormationName": "WAFv2", - "cloudTrailEventSource": "wafv2.amazonaws.com", - "endpointPrefix": "wafv2" - }, - "aws.auth#sigv4": { - "name": "wafv2" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "WAF\n \n

This is the latest version of the WAF API,\n released in November, 2019. The names of the entities that you use to access this API,\n like endpoints and namespaces, all have the versioning information added, like \"V2\" or\n \"v2\", to distinguish from the prior version. We recommend migrating your resources to\n this version, because it has a number of significant improvements.

\n

If you used WAF prior to this release, you can't use this WAFV2 API to access any\n WAF resources that you created before. You can access your old rules, web ACLs, and\n other WAF resources only through the WAF Classic APIs. The WAF Classic APIs\n have retained the prior names, endpoints, and namespaces.

\n

For information, including how to migrate your WAF resources to this version,\n see the WAF Developer Guide.

\n \n

WAF is a web application firewall that lets you monitor the HTTP and HTTPS\n requests that are forwarded to an Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync\n GraphQL API, Amazon Cognito user pool, App Runner service, or Amazon Web Services Verified Access instance. WAF also lets you control access to your content,\n to protect the Amazon Web Services resource that WAF is monitoring. Based on conditions that\n you specify, such as the IP addresses that requests originate from or the values of query\n strings, the protected resource responds to requests with either the requested content, an HTTP 403 status code\n (Forbidden), or with a custom response.

\n

This API guide is for developers who need detailed information about WAF API actions,\n data types, and errors. For detailed information about WAF features and guidance for configuring and using \n WAF, see the WAF Developer\n Guide.

\n

You can make calls using the endpoints listed in WAF endpoints and quotas.

\n \n

Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the\n programming language or platform that you're using. For more information, see Amazon Web Services SDKs.

\n

We currently provide two versions of the WAF API: this API and the prior versions,\n the classic WAF APIs. This new API provides the same functionality as the older versions,\n with the following major improvements:

\n ", - "smithy.api#title": "AWS WAFV2", - "smithy.api#xmlNamespace": { - "uri": "http://waf.amazonaws.com/doc/2019-07-29/" - }, - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" + "com.amazonaws.wafv2#AWSManagedRulesACFPRuleSet": { + "type": "structure", + "members": { + "CreationPath": { + "target": "com.amazonaws.wafv2#CreationPathString", + "traits": { + "smithy.api#documentation": "

The path of the account creation endpoint for your application. This is the page on your website that accepts the completed registration form for a new user. This page must accept POST requests.

\n

For example, for the URL https://example.com/web/signup, you would provide the path /web/signup.

", + "smithy.api#required": {} + } + }, + "RegistrationPagePath": { + "target": "com.amazonaws.wafv2#RegistrationPagePathString", + "traits": { + "smithy.api#documentation": "

The path of the account registration endpoint for your application. This is the page on your website that presents the registration form to new users.

\n \n

This page must accept GET text/html requests.

\n \n

For example, for the URL https://example.com/web/register, you would provide the path /web/register.

", + "smithy.api#required": {} + } + }, + "RequestInspection": { + "target": "com.amazonaws.wafv2#RequestInspectionACFP", + "traits": { + "smithy.api#documentation": "

The criteria for inspecting account creation requests, used by the ACFP rule group to validate and track account creation attempts.

", + "smithy.api#required": {} + } + }, + "ResponseInspection": { + "target": "com.amazonaws.wafv2#ResponseInspection", + "traits": { + "smithy.api#documentation": "

The criteria for inspecting responses to account creation requests, used by the ACFP rule group to track account creation success rates.

\n \n

Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

\n \n

The ACFP rule group evaluates the responses that your protected resources send back to client account creation attempts, keeping count of successful and failed attempts from each IP address and client session. Using this information, the rule group labels \n and mitigates requests from client sessions and IP addresses that have had too many successful account creation attempts in a short amount of time.

" + } + }, + "EnableRegexInPath": { + "target": "com.amazonaws.wafv2#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Allow the use of regular expressions in the registration page path and the account creation path.

" } - ] } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] + }, + "traits": { + "smithy.api#documentation": "

Details for your use of the account creation fraud prevention managed rule group, AWSManagedRulesACFPRuleSet. This configuration is used in ManagedRuleGroupConfig.

" + } + }, + "com.amazonaws.wafv2#AWSManagedRulesATPRuleSet": { + "type": "structure", + "members": { + "LoginPath": { + "target": "com.amazonaws.wafv2#String", + "traits": { + "smithy.api#documentation": "

The path of the login endpoint for your application. For example, for the URL\n https://example.com/web/login, you would provide the path\n /web/login.

\n

The rule group inspects only HTTP POST requests to your specified login endpoint.

", + "smithy.api#required": {} } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" }, - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "RequestInspection": { + "target": "com.amazonaws.wafv2#RequestInspection", + "traits": { + "smithy.api#documentation": "

The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage.

" + } + }, + "ResponseInspection": { + "target": "com.amazonaws.wafv2#ResponseInspection", + "traits": { + "smithy.api#documentation": "

The criteria for inspecting responses to login requests, used by the ATP rule group to track login failure rates.

\n \n

Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

\n \n

The ATP rule group evaluates the responses that your protected resources send back to client login attempts, keeping count of successful and failed attempts for each IP address and client session. Using this information, the rule group labels \n and mitigates requests from client sessions and IP addresses that have had too many failed login attempts in a short amount of time.

" + } + }, + "EnableRegexInPath": { + "target": "com.amazonaws.wafv2#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Allow the use of regular expressions in the login page path.

" } - ] } - ] }, - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] + "traits": { + "smithy.api#documentation": "

Details for your use of the account takeover prevention managed rule group, AWSManagedRulesATPRuleSet. This configuration is used in ManagedRuleGroupConfig.

" + } + }, + "com.amazonaws.wafv2#AWSManagedRulesBotControlRuleSet": { + "type": "structure", + "members": { + "InspectionLevel": { + "target": "com.amazonaws.wafv2#InspectionLevel", + "traits": { + "smithy.api#documentation": "

The inspection level to use for the Bot Control rule group. The common level is the least expensive. The \n targeted level includes all common level rules and adds rules with more advanced inspection criteria. For \n details, see WAF Bot Control rule group\n in the WAF Developer Guide.

", + "smithy.api#required": {} } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" + } + }, + "traits": { + "smithy.api#documentation": "

Details for your use of the Bot Control managed rule group, AWSManagedRulesBotControlRuleSet. This configuration is used in ManagedRuleGroupConfig.

" + } + }, + "com.amazonaws.wafv2#AWSWAF_20190729": { + "type": "service", + "version": "2019-07-29", + "operations": [ + { + "target": "com.amazonaws.wafv2#AssociateWebACL" + }, + { + "target": "com.amazonaws.wafv2#CheckCapacity" + }, + { + "target": "com.amazonaws.wafv2#CreateAPIKey" + }, + { + "target": "com.amazonaws.wafv2#CreateIPSet" + }, + { + "target": "com.amazonaws.wafv2#CreateRegexPatternSet" + }, + { + "target": "com.amazonaws.wafv2#CreateRuleGroup" + }, + { + "target": "com.amazonaws.wafv2#CreateWebACL" + }, + { + "target": "com.amazonaws.wafv2#DeleteFirewallManagerRuleGroups" + }, + { + "target": "com.amazonaws.wafv2#DeleteIPSet" + }, + { + "target": "com.amazonaws.wafv2#DeleteLoggingConfiguration" + }, + { + "target": "com.amazonaws.wafv2#DeletePermissionPolicy" + }, + { + "target": "com.amazonaws.wafv2#DeleteRegexPatternSet" + }, + { + "target": "com.amazonaws.wafv2#DeleteRuleGroup" + }, + { + "target": "com.amazonaws.wafv2#DeleteWebACL" + }, + { + "target": "com.amazonaws.wafv2#DescribeAllManagedProducts" + }, + { + "target": "com.amazonaws.wafv2#DescribeManagedProductsByVendor" + }, + { + "target": "com.amazonaws.wafv2#DescribeManagedRuleGroup" + }, + { + "target": "com.amazonaws.wafv2#DisassociateWebACL" + }, + { + "target": "com.amazonaws.wafv2#GenerateMobileSdkReleaseUrl" + }, + { + "target": "com.amazonaws.wafv2#GetDecryptedAPIKey" + }, + { + "target": "com.amazonaws.wafv2#GetIPSet" + }, + { + "target": "com.amazonaws.wafv2#GetLoggingConfiguration" + }, + { + "target": "com.amazonaws.wafv2#GetManagedRuleSet" + }, + { + "target": "com.amazonaws.wafv2#GetMobileSdkRelease" + }, + { + "target": "com.amazonaws.wafv2#GetPermissionPolicy" + }, + { + "target": "com.amazonaws.wafv2#GetRateBasedStatementManagedKeys" + }, + { + "target": "com.amazonaws.wafv2#GetRegexPatternSet" + }, + { + "target": "com.amazonaws.wafv2#GetRuleGroup" + }, + { + "target": "com.amazonaws.wafv2#GetSampledRequests" + }, + { + "target": "com.amazonaws.wafv2#GetWebACL" + }, + { + "target": "com.amazonaws.wafv2#GetWebACLForResource" + }, + { + "target": "com.amazonaws.wafv2#ListAPIKeys" + }, + { + "target": "com.amazonaws.wafv2#ListAvailableManagedRuleGroups" + }, + { + "target": "com.amazonaws.wafv2#ListAvailableManagedRuleGroupVersions" + }, + { + "target": "com.amazonaws.wafv2#ListIPSets" + }, + { + "target": "com.amazonaws.wafv2#ListLoggingConfigurations" + }, + { + "target": "com.amazonaws.wafv2#ListManagedRuleSets" + }, + { + "target": "com.amazonaws.wafv2#ListMobileSdkReleases" + }, + { + "target": "com.amazonaws.wafv2#ListRegexPatternSets" + }, + { + "target": "com.amazonaws.wafv2#ListResourcesForWebACL" + }, + { + "target": "com.amazonaws.wafv2#ListRuleGroups" + }, + { + "target": "com.amazonaws.wafv2#ListTagsForResource" + }, + { + "target": "com.amazonaws.wafv2#ListWebACLs" + }, + { + "target": "com.amazonaws.wafv2#PutLoggingConfiguration" + }, + { + "target": "com.amazonaws.wafv2#PutManagedRuleSetVersions" + }, + { + "target": "com.amazonaws.wafv2#PutPermissionPolicy" + }, + { + "target": "com.amazonaws.wafv2#TagResource" + }, + { + "target": "com.amazonaws.wafv2#UntagResource" + }, + { + "target": "com.amazonaws.wafv2#UpdateIPSet" + }, + { + "target": "com.amazonaws.wafv2#UpdateManagedRuleSetVersionExpiryDate" + }, + { + "target": "com.amazonaws.wafv2#UpdateRegexPatternSet" + }, + { + "target": "com.amazonaws.wafv2#UpdateRuleGroup" + }, + { + "target": "com.amazonaws.wafv2#UpdateWebACL" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "WAFV2", + "arnNamespace": "wafv2", + "cloudFormationName": "WAFv2", + "cloudTrailEventSource": "wafv2.amazonaws.com", + "endpointPrefix": "wafv2" + }, + "aws.auth#sigv4": { + "name": "wafv2" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "WAF\n \n

This is the latest version of the WAF API,\n released in November, 2019. The names of the entities that you use to access this API,\n like endpoints and namespaces, all have the versioning information added, like \"V2\" or\n \"v2\", to distinguish from the prior version. We recommend migrating your resources to\n this version, because it has a number of significant improvements.

\n

If you used WAF prior to this release, you can't use this WAFV2 API to access any\n WAF resources that you created before. You can access your old rules, web ACLs, and\n other WAF resources only through the WAF Classic APIs. The WAF Classic APIs\n have retained the prior names, endpoints, and namespaces.

\n

For information, including how to migrate your WAF resources to this version,\n see the WAF Developer Guide.

\n \n

WAF is a web application firewall that lets you monitor the HTTP and HTTPS\n requests that are forwarded to an Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync\n GraphQL API, Amazon Cognito user pool, App Runner service, or Amazon Web Services Verified Access instance. WAF also lets you control access to your content,\n to protect the Amazon Web Services resource that WAF is monitoring. Based on conditions that\n you specify, such as the IP addresses that requests originate from or the values of query\n strings, the protected resource responds to requests with either the requested content, an HTTP 403 status code\n (Forbidden), or with a custom response.

\n

This API guide is for developers who need detailed information about WAF API actions,\n data types, and errors. For detailed information about WAF features and guidance for configuring and using \n WAF, see the WAF Developer\n Guide.

\n

You can make calls using the endpoints listed in WAF endpoints and quotas.

\n \n

Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the\n programming language or platform that you're using. For more information, see Amazon Web Services SDKs.

\n

We currently provide two versions of the WAF API: this API and the prior versions,\n the classic WAF APIs. This new API provides the same functionality as the older versions,\n with the following major improvements:

\n ", + "smithy.api#title": "AWS WAFV2", + "smithy.api#xmlNamespace": { + "uri": "http://waf.amazonaws.com/doc/2019-07-29/" + }, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" } - ], - "type": "tree", - "rules": [ + }, + "rules": [ { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ + "conditions": [ { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ + "conditions": [ { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" }, { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ + "conditions": [], + "type": "tree", + "rules": [ { - "ref": "PartitionResult" + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://wafv2-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] + ] }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ + "conditions": [], + "type": "tree", + "rules": [ { - "ref": "UseFIPS" + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://wafv2-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://wafv2-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://wafv2.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://wafv2.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + } + ] }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://wafv2-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.af-south-1.amazonaws.com" } - ] }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": false } - ] }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] + "documentation": "For region af-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.af-south-1.amazonaws.com" + } + }, + "params": { + "Region": "af-south-1", + "UseFIPS": true, + "UseDualStack": false } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.ap-east-1.amazonaws.com" } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://wafv2.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.ap-east-1.amazonaws.com" } - ] }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" + "params": { + "Region": "ap-east-1", + "UseFIPS": true, + "UseDualStack": false } - ] }, { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://wafv2.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false } - ] - } - ] - } - ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2.af-south-1.amazonaws.com" - } - }, - "params": { - "Region": "af-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region af-south-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2-fips.af-south-1.amazonaws.com" - } - }, - "params": { - "Region": "af-south-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2.ap-east-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2-fips.ap-east-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2-fips.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2-fips.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2.ap-northeast-3.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2-fips.ap-northeast-3.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-3", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2.ap-south-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2-fips.ap-south-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-south-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2-fips.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2-fips.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2.ap-southeast-3.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2-fips.ap-southeast-3.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-3", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2-fips.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2-fips.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2.eu-north-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2-fips.eu-north-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2.eu-south-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-south-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2-fips.eu-south-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-south-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2-fips.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2.eu-west-2.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2-fips.eu-west-2.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-2", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2.eu-west-3.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2-fips.eu-west-3.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-3", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2.me-south-1.amazonaws.com" - } - }, - "params": { - "Region": "me-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region me-south-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2-fips.me-south-1.amazonaws.com" - } - }, - "params": { - "Region": "me-south-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2.sa-east-1.amazonaws.com" - } - }, - "params": { - "Region": "sa-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2-fips.sa-east-1.amazonaws.com" - } - }, - "params": { - "Region": "sa-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2-fips.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2-fips.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2-fips.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://wafv2-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://wafv2.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2.cn-northwest-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-northwest-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2-fips.cn-northwest-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-northwest-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://wafv2-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://wafv2.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2-fips.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://wafv2-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://wafv2.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wafv2.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.wafv2#Action": { - "type": "string" - }, - "com.amazonaws.wafv2#ActionCondition": { - "type": "structure", - "members": { - "Action": { - "target": "com.amazonaws.wafv2#ActionValue", - "traits": { - "smithy.api#documentation": "

The action setting that a log record must contain in order to meet the condition. This is the action that WAF applied to the web request.

\n

For rule groups, this is either the configured rule action setting, or if you've applied a rule action override to the rule, it's the override action. \n The value EXCLUDED_AS_COUNT matches on \n excluded rules and also on rules that have a rule action override of Count.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A single action condition for a Condition in a logging filter.

" - } - }, - "com.amazonaws.wafv2#ActionValue": { - "type": "enum", - "members": { - "ALLOW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALLOW" - } - }, - "BLOCK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BLOCK" - } - }, - "COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COUNT" - } - }, - "CAPTCHA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CAPTCHA" - } - }, - "CHALLENGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CHALLENGE" - } - }, - "EXCLUDED_AS_COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXCLUDED_AS_COUNT" - } - } - } - }, - "com.amazonaws.wafv2#All": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

Inspect all of the elements that WAF has parsed and extracted from the web request\n component that you've identified in your FieldToMatch specifications.

\n

This is used in the FieldToMatch specification for some web request component types.

\n

JSON specification: \"All\": {}\n

" - } - }, - "com.amazonaws.wafv2#AllQueryArguments": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

Inspect all query arguments of the web request.

\n

This is used in the FieldToMatch specification for some web request component types.

\n

JSON specification: \"AllQueryArguments\": {}\n

" - } - }, - "com.amazonaws.wafv2#AllowAction": { - "type": "structure", - "members": { - "CustomRequestHandling": { - "target": "com.amazonaws.wafv2#CustomRequestHandling", - "traits": { - "smithy.api#documentation": "

Defines custom handling for the web request.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies that WAF should allow the request and optionally defines additional\n custom handling for the request.

\n

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

" - } - }, - "com.amazonaws.wafv2#AndStatement": { - "type": "structure", - "members": { - "Statements": { - "target": "com.amazonaws.wafv2#Statements", - "traits": { - "smithy.api#documentation": "

The statements to combine with AND logic. You can use any statements that can be nested.\n

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement.

" - } - }, - "com.amazonaws.wafv2#AssociateWebACL": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#AssociateWebACLRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#AssociateWebACLResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - }, - { - "target": "com.amazonaws.wafv2#WAFUnavailableEntityException" - } - ], - "traits": { - "smithy.api#documentation": "

Associates a web ACL with a regional application resource, to protect the resource.\n A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To\n associate a web ACL, in the CloudFront call UpdateDistribution, set the web ACL ID\n to the Amazon Resource Name (ARN) of the web ACL. For information, see UpdateDistribution in the Amazon CloudFront Developer Guide.

\n

When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

" - } - }, - "com.amazonaws.wafv2#AssociateWebACLRequest": { - "type": "structure", - "members": { - "WebACLArn": { - "target": "com.amazonaws.wafv2#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the web ACL that you want to associate with the\n resource.

", - "smithy.api#required": {} - } - }, - "ResourceArn": { - "target": "com.amazonaws.wafv2#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to associate with the web ACL.

\n

The ARN must be in one of the following formats:

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#AssociateWebACLResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#AssociatedResourceType": { - "type": "enum", - "members": { - "CLOUDFRONT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CLOUDFRONT" - } - } - } - }, - "com.amazonaws.wafv2#AssociationConfig": { - "type": "structure", - "members": { - "RequestBody": { - "target": "com.amazonaws.wafv2#RequestBody", - "traits": { - "smithy.api#documentation": "

Customizes the maximum size of the request body that your protected CloudFront distributions forward to WAF for inspection. The default size is 16 KB (16,384 kilobytes).

\n \n

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies custom configurations for the associations between the web ACL and protected resources.

\n

Use this to customize the maximum size of the request body that your protected CloudFront distributions forward to WAF for inspection. The default is 16 KB (16,384 kilobytes).

\n \n

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

\n " - } - }, - "com.amazonaws.wafv2#BlockAction": { - "type": "structure", - "members": { - "CustomResponse": { - "target": "com.amazonaws.wafv2#CustomResponse", - "traits": { - "smithy.api#documentation": "

Defines a custom response for the web request.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies that WAF should block the request and optionally defines additional\n custom handling for the response to the web request.

\n

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

" - } - }, - "com.amazonaws.wafv2#Body": { - "type": "structure", - "members": { - "OversizeHandling": { - "target": "com.amazonaws.wafv2#OversizeHandling", - "traits": { - "smithy.api#documentation": "

What WAF should do if the body is larger than WAF can inspect. \n WAF does not support inspecting the entire contents of the web request body if the body \n exceeds the limit for the resource type. If the body is larger than the limit, the underlying host service \n only forwards the contents that are below the limit to WAF for inspection.

\n

The default limit is 8 KB (8,192 kilobytes) for regional resources and 16 KB (16,384 kilobytes) for CloudFront distributions. For CloudFront distributions, \n you can increase the limit in the web ACL AssociationConfig, for additional processing fees.

\n

The options for oversize handling are the following:

\n \n

You can combine the MATCH or NO_MATCH\n settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.

\n

Default: CONTINUE\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Inspect the body of the web request. The body immediately follows the request\n headers.

\n

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

" - } - }, - "com.amazonaws.wafv2#BodyParsingFallbackBehavior": { - "type": "enum", - "members": { - "MATCH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MATCH" - } - }, - "NO_MATCH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NO_MATCH" - } - }, - "EVALUATE_AS_STRING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EVALUATE_AS_STRING" - } - } - } - }, - "com.amazonaws.wafv2#Boolean": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.wafv2#ByteMatchStatement": { - "type": "structure", - "members": { - "SearchString": { - "target": "com.amazonaws.wafv2#SearchString", - "traits": { - "smithy.api#documentation": "

A string value that you want WAF to search for. WAF searches only in the part of\n web requests that you designate for inspection in FieldToMatch. The\n maximum length of the value is 200 bytes.

\n

Valid values depend on the component that you specify for inspection in\n FieldToMatch:

\n \n

If SearchString includes alphabetic characters A-Z and a-z, note that the\n value is case sensitive.

\n

\n If you're using the WAF API\n

\n

Specify a base64-encoded version of the value. The maximum length of the value before\n you base64-encode it is 200 bytes.

\n

For example, suppose the value of Type is HEADER and the value\n of Data is User-Agent. If you want to search the\n User-Agent header for the value BadBot, you base64-encode\n BadBot using MIME base64-encoding and include the resulting value,\n QmFkQm90, in the value of SearchString.

\n

\n If you're using the CLI or one of the Amazon Web Services SDKs\n

\n

The value that you want WAF to search for. The SDK automatically base64 encodes the\n value.

", - "smithy.api#required": {} - } - }, - "FieldToMatch": { - "target": "com.amazonaws.wafv2#FieldToMatch", - "traits": { - "smithy.api#documentation": "

The part of the web request that you want WAF to inspect.

", - "smithy.api#required": {} - } - }, - "TextTransformations": { - "target": "com.amazonaws.wafv2#TextTransformations", - "traits": { - "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.

", - "smithy.api#required": {} - } - }, - "PositionalConstraint": { - "target": "com.amazonaws.wafv2#PositionalConstraint", - "traits": { - "smithy.api#documentation": "

The area within the portion of the web request that you want WAF to search for\n SearchString. Valid values include the following:

\n

\n CONTAINS\n

\n

The specified part of the web request must include the value of\n SearchString, but the location doesn't matter.

\n

\n CONTAINS_WORD\n

\n

The specified part of the web request must include the value of\n SearchString, and SearchString must contain only alphanumeric\n characters or underscore (A-Z, a-z, 0-9, or _). In addition, SearchString must\n be a word, which means that both of the following are true:

\n \n

\n EXACTLY\n

\n

The value of the specified part of the web request must exactly match the value of\n SearchString.

\n

\n STARTS_WITH\n

\n

The value of SearchString must appear at the beginning of the specified\n part of the web request.

\n

\n ENDS_WITH\n

\n

The value of SearchString must appear at the end of the specified part of\n the web request.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A rule statement that defines a string match search for WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the WAF console and the developer guide, this is called a string match statement.

" - } - }, - "com.amazonaws.wafv2#CapacityUnit": { - "type": "long", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.wafv2#CaptchaAction": { - "type": "structure", - "members": { - "CustomRequestHandling": { - "target": "com.amazonaws.wafv2#CustomRequestHandling", - "traits": { - "smithy.api#documentation": "

Defines custom handling for the web request, used when the CAPTCHA inspection determines that the request's token is valid and unexpired.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies that WAF should run a CAPTCHA check against the request:

\n \n

You can configure the expiration time \n in the CaptchaConfig\n ImmunityTimeProperty setting at the rule and web ACL level. The rule setting overrides the web ACL setting.

\n

This action option is available for rules. It isn't available for web ACL default actions.

" - } - }, - "com.amazonaws.wafv2#CaptchaConfig": { - "type": "structure", - "members": { - "ImmunityTimeProperty": { - "target": "com.amazonaws.wafv2#ImmunityTimeProperty", - "traits": { - "smithy.api#documentation": "

Determines how long a CAPTCHA timestamp in the token remains valid after the client\n successfully solves a CAPTCHA puzzle.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies how WAF should handle CAPTCHA evaluations. This is\n available at the web ACL level and in each rule.

" - } - }, - "com.amazonaws.wafv2#CaptchaResponse": { - "type": "structure", - "members": { - "ResponseCode": { - "target": "com.amazonaws.wafv2#ResponseCode", - "traits": { - "smithy.api#documentation": "

The HTTP response code indicating the status of the CAPTCHA token in the\n web request. If the token is missing, invalid, or expired, this code is 405 Method\n Not Allowed.

" - } - }, - "SolveTimestamp": { - "target": "com.amazonaws.wafv2#SolveTimestamp", - "traits": { - "smithy.api#documentation": "

The time that the CAPTCHA was last solved for the supplied token.

" - } - }, - "FailureReason": { - "target": "com.amazonaws.wafv2#FailureReason", - "traits": { - "smithy.api#documentation": "

The reason for failure, populated when the evaluation of the token fails.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The result from the inspection of the web request for a valid CAPTCHA token.

" - } - }, - "com.amazonaws.wafv2#ChallengeAction": { - "type": "structure", - "members": { - "CustomRequestHandling": { - "target": "com.amazonaws.wafv2#CustomRequestHandling", - "traits": { - "smithy.api#documentation": "

Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies that WAF should run a Challenge check against the request to verify that the request is coming from a legitimate client session:

\n \n

You can configure the expiration time \n in the ChallengeConfig\n ImmunityTimeProperty setting at the rule and web ACL level. The rule setting overrides the web ACL setting.

\n

This action option is available for rules. It isn't available for web ACL default actions.

" - } - }, - "com.amazonaws.wafv2#ChallengeConfig": { - "type": "structure", - "members": { - "ImmunityTimeProperty": { - "target": "com.amazonaws.wafv2#ImmunityTimeProperty", - "traits": { - "smithy.api#documentation": "

Determines how long a challenge timestamp in the token remains valid after the client\n successfully responds to a challenge.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies how WAF should handle Challenge evaluations. This is\n available at the web ACL level and in each rule.

" - } - }, - "com.amazonaws.wafv2#ChallengeResponse": { - "type": "structure", - "members": { - "ResponseCode": { - "target": "com.amazonaws.wafv2#ResponseCode", - "traits": { - "smithy.api#documentation": "

The HTTP response code indicating the status of the challenge token in the\n web request. If the token is missing, invalid, or expired, this code is 202 Request Accepted.

" - } - }, - "SolveTimestamp": { - "target": "com.amazonaws.wafv2#SolveTimestamp", - "traits": { - "smithy.api#documentation": "

The time that the challenge was last solved for the supplied token.

" - } - }, - "FailureReason": { - "target": "com.amazonaws.wafv2#FailureReason", - "traits": { - "smithy.api#documentation": "

The reason for failure, populated when the evaluation of the token fails.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The result from the inspection of the web request for a valid challenge token.

" - } - }, - "com.amazonaws.wafv2#CheckCapacity": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#CheckCapacityRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#CheckCapacityResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFExpiredManagedRuleGroupVersionException" - }, - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidResourceException" - }, - { - "target": "com.amazonaws.wafv2#WAFLimitsExceededException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - }, - { - "target": "com.amazonaws.wafv2#WAFSubscriptionNotFoundException" - }, - { - "target": "com.amazonaws.wafv2#WAFUnavailableEntityException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules. \n You can use this to check the capacity requirements for the rules you want to use in a \n RuleGroup or WebACL. \n

\n

WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) \n in the WAF Developer Guide.

" - } - }, - "com.amazonaws.wafv2#CheckCapacityRequest": { - "type": "structure", - "members": { - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", - "smithy.api#required": {} - } - }, - "Rules": { - "target": "com.amazonaws.wafv2#Rules", - "traits": { - "smithy.api#documentation": "

An array of Rule that you're configuring to use in a rule group or web\n ACL.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#CheckCapacityResponse": { - "type": "structure", - "members": { - "Capacity": { - "target": "com.amazonaws.wafv2#ConsumedCapacity", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The capacity required by the rules and scope.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#ComparisonOperator": { - "type": "enum", - "members": { - "EQ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EQ" - } - }, - "NE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NE" - } - }, - "LE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LE" - } - }, - "LT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LT" - } - }, - "GE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GE" - } - }, - "GT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GT" - } - } - } - }, - "com.amazonaws.wafv2#Condition": { - "type": "structure", - "members": { - "ActionCondition": { - "target": "com.amazonaws.wafv2#ActionCondition", - "traits": { - "smithy.api#documentation": "

A single action condition. This is the action setting that a log record must contain in order to meet the condition.

" - } - }, - "LabelNameCondition": { - "target": "com.amazonaws.wafv2#LabelNameCondition", - "traits": { - "smithy.api#documentation": "

A single label name condition. This is the fully qualified label name that a log record must contain in order to meet the condition. \n Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A single match condition for a Filter.

" - } - }, - "com.amazonaws.wafv2#Conditions": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#Condition" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.wafv2#ConsumedCapacity": { - "type": "long", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.wafv2#CookieMatchPattern": { - "type": "structure", - "members": { - "All": { - "target": "com.amazonaws.wafv2#All", - "traits": { - "smithy.api#documentation": "

Inspect all cookies.

" - } - }, - "IncludedCookies": { - "target": "com.amazonaws.wafv2#CookieNames", - "traits": { - "smithy.api#documentation": "

Inspect only the cookies that have a key that matches one of the strings specified here.\n

" - } - }, - "ExcludedCookies": { - "target": "com.amazonaws.wafv2#CookieNames", - "traits": { - "smithy.api#documentation": "

Inspect only the cookies whose keys don't match any of the strings specified here.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The filter to use to identify the subset of cookies to inspect in a web request.

\n

You must specify exactly one setting: either All, IncludedCookies, or ExcludedCookies.

\n

Example JSON: \"MatchPattern\": { \"IncludedCookies\": {\"KeyToInclude1\", \"KeyToInclude2\", \"KeyToInclude3\"} }\n

" - } - }, - "com.amazonaws.wafv2#CookieNames": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#SingleCookieName" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 199 - } - } - }, - "com.amazonaws.wafv2#Cookies": { - "type": "structure", - "members": { - "MatchPattern": { - "target": "com.amazonaws.wafv2#CookieMatchPattern", - "traits": { - "smithy.api#documentation": "

The filter to use to identify the subset of cookies to inspect in a web request.

\n

You must specify exactly one setting: either All, IncludedCookies, or ExcludedCookies.

\n

Example JSON: \"MatchPattern\": { \"IncludedCookies\": {\"KeyToInclude1\", \"KeyToInclude2\", \"KeyToInclude3\"} }\n

", - "smithy.api#required": {} - } - }, - "MatchScope": { - "target": "com.amazonaws.wafv2#MapMatchScope", - "traits": { - "smithy.api#documentation": "

The parts of the cookies to inspect with the rule inspection criteria. If you specify\n All, WAF inspects both keys and values.

", - "smithy.api#required": {} - } - }, - "OversizeHandling": { - "target": "com.amazonaws.wafv2#OversizeHandling", - "traits": { - "smithy.api#documentation": "

What WAF should do if the cookies of the request are more numerous or larger than WAF can inspect. \n WAF does not support inspecting the entire contents of request cookies \n when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies\n and at most 8 KB of cookie contents to WAF.

\n

The options for oversize handling are the following:

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Inspect the cookies in the web request. You can specify the parts of the cookies to\n inspect and you can narrow the set of cookies to inspect by including or excluding specific\n keys.

\n

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

\n

Example JSON: \"Cookies\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"KEY\",\n \"OversizeHandling\": \"MATCH\" }\n

" - } - }, - "com.amazonaws.wafv2#CountAction": { - "type": "structure", - "members": { - "CustomRequestHandling": { - "target": "com.amazonaws.wafv2#CustomRequestHandling", - "traits": { - "smithy.api#documentation": "

Defines custom handling for the web request.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies that WAF should count the request. Optionally defines additional custom\n handling for the request.

\n

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

" - } - }, - "com.amazonaws.wafv2#Country": { - "type": "string" - }, - "com.amazonaws.wafv2#CountryCode": { - "type": "enum", - "members": { - "AF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AF" - } - }, - "AX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AX" - } - }, - "AL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AL" - } - }, - "DZ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DZ" - } - }, - "AS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AS" - } - }, - "AD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AD" - } - }, - "AO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AO" - } - }, - "AI": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AI" - } - }, - "AQ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AQ" - } - }, - "AG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AG" - } - }, - "AR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AR" - } - }, - "AM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AM" - } - }, - "AW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AW" - } - }, - "AU": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AU" - } - }, - "AT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AT" - } - }, - "AZ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AZ" - } - }, - "BS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BS" - } - }, - "BH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BH" - } - }, - "BD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BD" - } - }, - "BB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BB" - } - }, - "BY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BY" - } - }, - "BE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BE" - } - }, - "BZ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BZ" - } - }, - "BJ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BJ" - } - }, - "BM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BM" - } - }, - "BT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BT" - } - }, - "BO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BO" - } - }, - "BQ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BQ" - } - }, - "BA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BA" - } - }, - "BW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BW" - } - }, - "BV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BV" - } - }, - "BR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BR" - } - }, - "IO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IO" - } - }, - "BN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BN" - } - }, - "BG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BG" - } - }, - "BF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BF" - } - }, - "BI": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BI" - } - }, - "KH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KH" - } - }, - "CM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CM" - } - }, - "CA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CA" - } - }, - "CV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CV" - } - }, - "KY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KY" - } - }, - "CF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CF" - } - }, - "TD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TD" - } - }, - "CL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CL" - } - }, - "CN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CN" - } - }, - "CX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CX" - } - }, - "CC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CC" - } - }, - "CO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CO" - } - }, - "KM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KM" - } - }, - "CG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CG" - } - }, - "CD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CD" - } - }, - "CK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CK" - } - }, - "CR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CR" - } - }, - "CI": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CI" - } - }, - "HR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HR" - } - }, - "CU": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CU" - } - }, - "CW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CW" - } - }, - "CY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CY" - } - }, - "CZ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CZ" - } - }, - "DK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DK" - } - }, - "DJ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DJ" - } - }, - "DM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DM" - } - }, - "DO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DO" - } - }, - "EC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EC" - } - }, - "EG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EG" - } - }, - "SV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SV" - } - }, - "GQ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GQ" - } - }, - "ER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ER" - } - }, - "EE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EE" - } - }, - "ET": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ET" - } - }, - "FK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FK" - } - }, - "FO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FO" - } - }, - "FJ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FJ" - } - }, - "FI": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FI" - } - }, - "FR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FR" - } - }, - "GF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GF" - } - }, - "PF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PF" - } - }, - "TF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TF" - } - }, - "GA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GA" - } - }, - "GM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GM" - } - }, - "GE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GE" - } - }, - "DE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DE" - } - }, - "GH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GH" - } - }, - "GI": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GI" - } - }, - "GR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GR" - } - }, - "GL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GL" - } - }, - "GD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GD" - } - }, - "GP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GP" - } - }, - "GU": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GU" - } - }, - "GT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GT" - } - }, - "GG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GG" - } - }, - "GN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GN" - } - }, - "GW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GW" - } - }, - "GY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GY" - } - }, - "HT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HT" - } - }, - "HM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HM" - } - }, - "VA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VA" - } - }, - "HN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HN" - } - }, - "HK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HK" - } - }, - "HU": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HU" - } - }, - "IS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IS" - } - }, - "IN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN" - } - }, - "ID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ID" - } - }, - "IR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IR" - } - }, - "IQ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IQ" - } - }, - "IE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IE" - } - }, - "IM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IM" - } - }, - "IL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IL" - } - }, - "IT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IT" - } - }, - "JM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JM" - } - }, - "JP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JP" - } - }, - "JE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JE" - } - }, - "JO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JO" - } - }, - "KZ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KZ" - } - }, - "KE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KE" - } - }, - "KI": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KI" - } - }, - "KP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KP" - } - }, - "KR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KR" - } - }, - "KW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KW" - } - }, - "KG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KG" - } - }, - "LA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LA" - } - }, - "LV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LV" - } - }, - "LB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LB" - } - }, - "LS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LS" - } - }, - "LR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LR" - } - }, - "LY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LY" - } - }, - "LI": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LI" - } - }, - "LT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LT" - } - }, - "LU": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LU" - } - }, - "MO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MO" - } - }, - "MK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MK" - } - }, - "MG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MG" - } - }, - "MW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MW" - } - }, - "MY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MY" - } - }, - "MV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MV" - } - }, - "ML": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ML" - } - }, - "MT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MT" - } - }, - "MH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MH" - } - }, - "MQ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MQ" - } - }, - "MR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MR" - } - }, - "MU": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MU" - } - }, - "YT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "YT" - } - }, - "MX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MX" - } - }, - "FM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FM" - } - }, - "MD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MD" - } - }, - "MC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MC" - } - }, - "MN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MN" - } - }, - "ME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ME" - } - }, - "MS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MS" - } - }, - "MA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MA" - } - }, - "MZ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MZ" - } - }, - "MM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MM" - } - }, - "NA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NA" - } - }, - "NR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NR" - } - }, - "NP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NP" - } - }, - "NL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NL" - } - }, - "NC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NC" - } - }, - "NZ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NZ" - } - }, - "NI": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NI" - } - }, - "NE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NE" - } - }, - "NG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NG" - } - }, - "NU": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NU" - } - }, - "NF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NF" - } - }, - "MP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MP" - } - }, - "NO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NO" - } - }, - "OM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OM" - } - }, - "PK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PK" - } - }, - "PW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PW" - } - }, - "PS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PS" - } - }, - "PA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PA" - } - }, - "PG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PG" - } - }, - "PY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PY" - } - }, - "PE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PE" - } - }, - "PH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PH" - } - }, - "PN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PN" - } - }, - "PL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PL" - } - }, - "PT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PT" - } - }, - "PR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PR" - } - }, - "QA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QA" - } - }, - "RE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RE" - } - }, - "RO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RO" - } - }, - "RU": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RU" - } - }, - "RW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RW" - } - }, - "BL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BL" - } - }, - "SH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SH" - } - }, - "KN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KN" - } - }, - "LC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LC" - } - }, - "MF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MF" - } - }, - "PM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PM" - } - }, - "VC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VC" - } - }, - "WS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WS" - } - }, - "SM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SM" - } - }, - "ST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ST" - } - }, - "SA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SA" - } - }, - "SN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SN" - } - }, - "RS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RS" - } - }, - "SC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SC" - } - }, - "SL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SL" - } - }, - "SG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SG" - } - }, - "SX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SX" - } - }, - "SK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SK" - } - }, - "SI": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SI" - } - }, - "SB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SB" - } - }, - "SO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SO" - } - }, - "ZA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ZA" - } - }, - "GS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GS" - } - }, - "SS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SS" - } - }, - "ES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ES" - } - }, - "LK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LK" - } - }, - "SD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SD" - } - }, - "SR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SR" - } - }, - "SJ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SJ" - } - }, - "SZ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SZ" - } - }, - "SE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SE" - } - }, - "CH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CH" - } - }, - "SY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SY" - } - }, - "TW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TW" - } - }, - "TJ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TJ" - } - }, - "TZ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TZ" - } - }, - "TH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TH" - } - }, - "TL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TL" - } - }, - "TG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TG" - } - }, - "TK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TK" - } - }, - "TO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TO" - } - }, - "TT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TT" - } - }, - "TN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TN" - } - }, - "TR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TR" - } - }, - "TM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TM" - } - }, - "TC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TC" - } - }, - "TV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TV" - } - }, - "UG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UG" - } - }, - "UA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UA" - } - }, - "AE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AE" - } - }, - "GB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GB" - } - }, - "US": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "US" - } - }, - "UM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UM" - } - }, - "UY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UY" - } - }, - "UZ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UZ" - } - }, - "VU": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VU" - } - }, - "VE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VE" - } - }, - "VN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VN" - } - }, - "VG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VG" - } - }, - "VI": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VI" - } - }, - "WF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WF" - } - }, - "EH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EH" - } - }, - "YE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "YE" - } - }, - "ZM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ZM" - } - }, - "ZW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ZW" - } - }, - "XK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "XK" - } - } - } - }, - "com.amazonaws.wafv2#CountryCodes": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#CountryCode" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.wafv2#CreateAPIKey": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#CreateAPIKeyRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#CreateAPIKeyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFLimitsExceededException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an API key that contains a set of token domains.

\n

API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. \n The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. \n For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.

\n

You can use a single key for up to 5 domains. After you generate a key, you can copy it for use in your JavaScript \n integration.

" - } - }, - "com.amazonaws.wafv2#CreateAPIKeyRequest": { - "type": "structure", - "members": { - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", - "smithy.api#required": {} - } - }, - "TokenDomains": { - "target": "com.amazonaws.wafv2#APIKeyTokenDomains", - "traits": { - "smithy.api#documentation": "

The client application domains that you want to use this API key for.

\n

Example JSON: \"TokenDomains\": [\"abc.com\", \"store.abc.com\"]\n

\n

Public suffixes aren't allowed. For example, you can't use usa.gov or co.uk as token domains.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#CreateAPIKeyResponse": { - "type": "structure", - "members": { - "APIKey": { - "target": "com.amazonaws.wafv2#APIKey", - "traits": { - "smithy.api#documentation": "

The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#CreateIPSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#CreateIPSetRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#CreateIPSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFDuplicateItemException" - }, - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFLimitsExceededException" - }, - { - "target": "com.amazonaws.wafv2#WAFOptimisticLockException" - }, - { - "target": "com.amazonaws.wafv2#WAFTagOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an IPSet, which you use to identify web requests that\n originate from specific IP addresses or ranges of IP addresses. For example, if you're\n receiving a lot of requests from a ranges of IP addresses, you can configure WAF to\n block them using an IPSet that lists those IP addresses.

" - } - }, - "com.amazonaws.wafv2#CreateIPSetRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the IP set. You cannot change the name of an IPSet after you create it.

", - "smithy.api#required": {} - } - }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.wafv2#EntityDescription", - "traits": { - "smithy.api#documentation": "

A description of the IP set that helps with identification.

" - } - }, - "IPAddressVersion": { - "target": "com.amazonaws.wafv2#IPAddressVersion", - "traits": { - "smithy.api#documentation": "

The version of the IP addresses, either IPV4 or IPV6.

", - "smithy.api#required": {} - } - }, - "Addresses": { - "target": "com.amazonaws.wafv2#IPAddresses", - "traits": { - "smithy.api#documentation": "

Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

\n

Example address strings:

\n \n

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

\n

Example JSON Addresses specifications:

\n ", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.wafv2#TagList", - "traits": { - "smithy.api#documentation": "

An array of key:value pairs to associate with the resource.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#CreateIPSetResponse": { - "type": "structure", - "members": { - "Summary": { - "target": "com.amazonaws.wafv2#IPSetSummary", - "traits": { - "smithy.api#documentation": "

High-level information about an IPSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage an IPSet, and the ARN, that you provide to the IPSetReferenceStatement to use the address set in a Rule.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#CreateRegexPatternSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#CreateRegexPatternSetRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#CreateRegexPatternSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFDuplicateItemException" - }, - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFLimitsExceededException" - }, - { - "target": "com.amazonaws.wafv2#WAFOptimisticLockException" - }, - { - "target": "com.amazonaws.wafv2#WAFTagOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have WAF inspect a web request\n component for the specified patterns.

" - } - }, - "com.amazonaws.wafv2#CreateRegexPatternSetRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the set. You cannot change the name after you create the set.

", - "smithy.api#required": {} - } - }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.wafv2#EntityDescription", - "traits": { - "smithy.api#documentation": "

A description of the set that helps with identification.

" - } - }, - "RegularExpressionList": { - "target": "com.amazonaws.wafv2#RegularExpressionList", - "traits": { - "smithy.api#documentation": "

Array of regular expression strings.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.wafv2#TagList", - "traits": { - "smithy.api#documentation": "

An array of key:value pairs to associate with the resource.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#CreateRegexPatternSetResponse": { - "type": "structure", - "members": { - "Summary": { - "target": "com.amazonaws.wafv2#RegexPatternSetSummary", - "traits": { - "smithy.api#documentation": "

High-level information about a RegexPatternSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RegexPatternSet, and the ARN, that you provide to the RegexPatternSetReferenceStatement to use the pattern set in a Rule.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#CreateRuleGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#CreateRuleGroupRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#CreateRuleGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFDuplicateItemException" - }, - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFLimitsExceededException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - }, - { - "target": "com.amazonaws.wafv2#WAFOptimisticLockException" - }, - { - "target": "com.amazonaws.wafv2#WAFSubscriptionNotFoundException" - }, - { - "target": "com.amazonaws.wafv2#WAFTagOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFUnavailableEntityException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a RuleGroup per the specifications provided.

\n

A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

" - } - }, - "com.amazonaws.wafv2#CreateRuleGroupRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the rule group. You cannot change the name of a rule group after you create it.

", - "smithy.api#required": {} - } - }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", - "smithy.api#required": {} - } - }, - "Capacity": { - "target": "com.amazonaws.wafv2#CapacityUnit", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The web ACL capacity units (WCUs) required for this rule group.

\n

When you create your own rule group, you define this, and you cannot change it after creation. \n When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity \n for a set of rules using CheckCapacity.

\n

WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) \n in the WAF Developer Guide.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.wafv2#EntityDescription", - "traits": { - "smithy.api#documentation": "

A description of the rule group that helps with identification.

" - } - }, - "Rules": { - "target": "com.amazonaws.wafv2#Rules", - "traits": { - "smithy.api#documentation": "

The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n

" - } - }, - "VisibilityConfig": { - "target": "com.amazonaws.wafv2#VisibilityConfig", - "traits": { - "smithy.api#documentation": "

Defines and enables Amazon CloudWatch metrics and web request sample collection.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.wafv2#TagList", - "traits": { - "smithy.api#documentation": "

An array of key:value pairs to associate with the resource.

" - } - }, - "CustomResponseBodies": { - "target": "com.amazonaws.wafv2#CustomResponseBodies", - "traits": { - "smithy.api#documentation": "

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas \n in the WAF Developer Guide.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#CreateRuleGroupResponse": { - "type": "structure", - "members": { - "Summary": { - "target": "com.amazonaws.wafv2#RuleGroupSummary", - "traits": { - "smithy.api#documentation": "

High-level information about a RuleGroup, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RuleGroup, and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#CreateWebACL": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#CreateWebACLRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#CreateWebACLResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFConfigurationWarningException" - }, - { - "target": "com.amazonaws.wafv2#WAFDuplicateItemException" - }, - { - "target": "com.amazonaws.wafv2#WAFExpiredManagedRuleGroupVersionException" - }, - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidResourceException" - }, - { - "target": "com.amazonaws.wafv2#WAFLimitsExceededException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - }, - { - "target": "com.amazonaws.wafv2#WAFOptimisticLockException" - }, - { - "target": "com.amazonaws.wafv2#WAFSubscriptionNotFoundException" - }, - { - "target": "com.amazonaws.wafv2#WAFTagOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFUnavailableEntityException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a WebACL per the specifications provided.

\n

A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

" - } - }, - "com.amazonaws.wafv2#CreateWebACLRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the web ACL. You cannot change the name of a web ACL after you create it.

", - "smithy.api#required": {} - } - }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", - "smithy.api#required": {} - } - }, - "DefaultAction": { - "target": "com.amazonaws.wafv2#DefaultAction", - "traits": { - "smithy.api#documentation": "

The action to perform if none of the Rules contained in the WebACL match.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.wafv2#EntityDescription", - "traits": { - "smithy.api#documentation": "

A description of the web ACL that helps with identification.

" - } - }, - "Rules": { - "target": "com.amazonaws.wafv2#Rules", - "traits": { - "smithy.api#documentation": "

The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n

" - } - }, - "VisibilityConfig": { - "target": "com.amazonaws.wafv2#VisibilityConfig", - "traits": { - "smithy.api#documentation": "

Defines and enables Amazon CloudWatch metrics and web request sample collection.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.wafv2#TagList", - "traits": { - "smithy.api#documentation": "

An array of key:value pairs to associate with the resource.

" - } - }, - "CustomResponseBodies": { - "target": "com.amazonaws.wafv2#CustomResponseBodies", - "traits": { - "smithy.api#documentation": "

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas \n in the WAF Developer Guide.

" - } - }, - "CaptchaConfig": { - "target": "com.amazonaws.wafv2#CaptchaConfig", - "traits": { - "smithy.api#documentation": "

Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its default settings for CaptchaConfig.

" - } - }, - "ChallengeConfig": { - "target": "com.amazonaws.wafv2#ChallengeConfig", - "traits": { - "smithy.api#documentation": "

Specifies how WAF should handle challenge evaluations for rules that don't have \ntheir own ChallengeConfig settings. If you don't specify this, WAF uses its default settings for ChallengeConfig.

" - } - }, - "TokenDomains": { - "target": "com.amazonaws.wafv2#TokenDomains", - "traits": { - "smithy.api#documentation": "

Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.

\n

Example JSON: \"TokenDomains\": { \"mywebsite.com\", \"myotherwebsite.com\" }\n

\n

Public suffixes aren't allowed. For example, you can't use usa.gov or co.uk as token domains.

" - } - }, - "AssociationConfig": { - "target": "com.amazonaws.wafv2#AssociationConfig", - "traits": { - "smithy.api#documentation": "

Specifies custom configurations for the associations between the web ACL and protected resources.

\n

Use this to customize the maximum size of the request body that your protected CloudFront distributions forward to WAF for inspection. The default is 16 KB (16,384 kilobytes).

\n \n

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

\n " - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#CreateWebACLResponse": { - "type": "structure", - "members": { - "Summary": { - "target": "com.amazonaws.wafv2#WebACLSummary", - "traits": { - "smithy.api#documentation": "

High-level information about a WebACL, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a WebACL, and the ARN, that you provide to operations like AssociateWebACL.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#CustomHTTPHeader": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#CustomHTTPHeaderName", - "traits": { - "smithy.api#documentation": "

The name of the custom header.

\n

For custom request header insertion, when WAF inserts the header into the request,\n it prefixes this name x-amzn-waf-, to avoid confusion with the headers that\n are already in the request. For example, for the header name sample, WAF\n inserts the header x-amzn-waf-sample.

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.wafv2#CustomHTTPHeaderValue", - "traits": { - "smithy.api#documentation": "

The value of the custom header.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling.

" - } - }, - "com.amazonaws.wafv2#CustomHTTPHeaderName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[a-zA-Z0-9._$-]+$" - } - }, - "com.amazonaws.wafv2#CustomHTTPHeaderValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.wafv2#CustomHTTPHeaders": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#CustomHTTPHeader" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.wafv2#CustomRequestHandling": { - "type": "structure", - "members": { - "InsertHeaders": { - "target": "com.amazonaws.wafv2#CustomHTTPHeaders", - "traits": { - "smithy.api#documentation": "

The HTTP headers to insert into the request. Duplicate header names are not allowed.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas \n in the WAF Developer Guide.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Custom request handling behavior that inserts custom headers into a web request. You can\n add custom request handling for WAF to use when the rule action doesn't block the request. \n For example, CaptchaAction for requests with valid t okens, and AllowAction.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

" - } - }, - "com.amazonaws.wafv2#CustomResponse": { - "type": "structure", - "members": { - "ResponseCode": { - "target": "com.amazonaws.wafv2#ResponseStatusCode", - "traits": { - "smithy.api#documentation": "

The HTTP status code to return to the client.

\n

For a list of status codes that you can use in your custom responses, see Supported status codes for custom response \n in the WAF Developer Guide.

", - "smithy.api#required": {} - } - }, - "CustomResponseBodyKey": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

References the response body that you want WAF to return to the web request\n client. You can define a custom response for a rule action or a default web ACL action that\n is set to block. To do this, you first define the response body key and value in the\n CustomResponseBodies setting for the WebACL or RuleGroup where you want to use it. Then, in the rule action or web ACL\n default action BlockAction setting, you reference the response body using this\n key.

" - } - }, - "ResponseHeaders": { - "target": "com.amazonaws.wafv2#CustomHTTPHeaders", - "traits": { - "smithy.api#documentation": "

The HTTP headers to use in the response. Duplicate header names are not allowed.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas \n in the WAF Developer Guide.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A custom response to send to the client. You can define a custom response for rule\n actions and default web ACL actions that are set to BlockAction.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

" - } - }, - "com.amazonaws.wafv2#CustomResponseBodies": { - "type": "map", - "key": { - "target": "com.amazonaws.wafv2#EntityName" - }, - "value": { - "target": "com.amazonaws.wafv2#CustomResponseBody" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.wafv2#CustomResponseBody": { - "type": "structure", - "members": { - "ContentType": { - "target": "com.amazonaws.wafv2#ResponseContentType", - "traits": { - "smithy.api#documentation": "

The type of content in the payload that you are defining in the Content\n string.

", - "smithy.api#required": {} - } - }, - "Content": { - "target": "com.amazonaws.wafv2#ResponseContent", - "traits": { - "smithy.api#documentation": "

The payload of the custom response.

\n

You can use JSON escape strings in JSON content. To do this, you must specify JSON\n content in the ContentType setting.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas \n in the WAF Developer Guide.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The response body to use in a custom response to a web request. This is referenced by\n key from CustomResponse\n CustomResponseBodyKey.

" - } - }, - "com.amazonaws.wafv2#DefaultAction": { - "type": "structure", - "members": { - "Block": { - "target": "com.amazonaws.wafv2#BlockAction", - "traits": { - "smithy.api#documentation": "

Specifies that WAF should block requests by default.

" - } - }, - "Allow": { - "target": "com.amazonaws.wafv2#AllowAction", - "traits": { - "smithy.api#documentation": "

Specifies that WAF should allow requests by default.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

In a WebACL, this is the action that you want WAF to perform\n when a web request doesn't match any of the rules in the WebACL. The default\n action must be a terminating action.

" - } - }, - "com.amazonaws.wafv2#DeleteFirewallManagerRuleGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#DeleteFirewallManagerRuleGroupsRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#DeleteFirewallManagerRuleGroupsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - }, - { - "target": "com.amazonaws.wafv2#WAFOptimisticLockException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes all rule groups that are managed by Firewall Manager for the specified web ACL.

\n

You can only use this if ManagedByFirewallManager is false in the specified\n WebACL.

" - } - }, - "com.amazonaws.wafv2#DeleteFirewallManagerRuleGroupsRequest": { - "type": "structure", - "members": { - "WebACLArn": { - "target": "com.amazonaws.wafv2#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the web ACL.

", - "smithy.api#required": {} - } - }, - "WebACLLockToken": { - "target": "com.amazonaws.wafv2#LockToken", - "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#DeleteFirewallManagerRuleGroupsResponse": { - "type": "structure", - "members": { - "NextWebACLLockToken": { - "target": "com.amazonaws.wafv2#LockToken", - "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#DeleteIPSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#DeleteIPSetRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#DeleteIPSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFAssociatedItemException" - }, - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - }, - { - "target": "com.amazonaws.wafv2#WAFOptimisticLockException" - }, - { - "target": "com.amazonaws.wafv2#WAFTagOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the specified IPSet.

" - } - }, - "com.amazonaws.wafv2#DeleteIPSetRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the IP set. You cannot change the name of an IPSet after you create it.

", - "smithy.api#required": {} - } - }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", - "smithy.api#required": {} - } - }, - "LockToken": { - "target": "com.amazonaws.wafv2#LockToken", - "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#DeleteIPSetResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#DeleteLoggingConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#DeleteLoggingConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#DeleteLoggingConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - }, - { - "target": "com.amazonaws.wafv2#WAFOptimisticLockException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the LoggingConfiguration from the specified web ACL.

" - } - }, - "com.amazonaws.wafv2#DeleteLoggingConfigurationRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.wafv2#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the web ACL from which you want to delete the LoggingConfiguration.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#DeleteLoggingConfigurationResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#DeletePermissionPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#DeletePermissionPolicyRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#DeletePermissionPolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - } - ], - "traits": { - "smithy.api#documentation": "

Permanently deletes an IAM policy from the specified rule group.

\n

You must be the owner of the rule group to perform this operation.

" - } - }, - "com.amazonaws.wafv2#DeletePermissionPolicyRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.wafv2#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule group from which you want to delete the\n policy.

\n

You must be the owner of the rule group to perform this operation.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#DeletePermissionPolicyResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#DeleteRegexPatternSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#DeleteRegexPatternSetRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#DeleteRegexPatternSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFAssociatedItemException" - }, - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - }, - { - "target": "com.amazonaws.wafv2#WAFOptimisticLockException" - }, - { - "target": "com.amazonaws.wafv2#WAFTagOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the specified RegexPatternSet.

" - } - }, - "com.amazonaws.wafv2#DeleteRegexPatternSetRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the set. You cannot change the name after you create the set.

", - "smithy.api#required": {} - } - }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", - "smithy.api#required": {} - } - }, - "LockToken": { - "target": "com.amazonaws.wafv2#LockToken", - "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#DeleteRegexPatternSetResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#DeleteRuleGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#DeleteRuleGroupRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#DeleteRuleGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFAssociatedItemException" - }, - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - }, - { - "target": "com.amazonaws.wafv2#WAFOptimisticLockException" - }, - { - "target": "com.amazonaws.wafv2#WAFTagOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the specified RuleGroup.

" - } - }, - "com.amazonaws.wafv2#DeleteRuleGroupRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the rule group. You cannot change the name of a rule group after you create it.

", - "smithy.api#required": {} - } - }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", - "smithy.api#required": {} - } - }, - "LockToken": { - "target": "com.amazonaws.wafv2#LockToken", - "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#DeleteRuleGroupResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#DeleteWebACL": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#DeleteWebACLRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#DeleteWebACLResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFAssociatedItemException" - }, - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - }, - { - "target": "com.amazonaws.wafv2#WAFOptimisticLockException" - }, - { - "target": "com.amazonaws.wafv2#WAFTagOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the specified WebACL.

\n

You can only use this if ManagedByFirewallManager is false in the specified\n WebACL.

\n \n

Before deleting any web ACL, first disassociate it from all resources.

\n \n " - } - }, - "com.amazonaws.wafv2#DeleteWebACLRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the web ACL. You cannot change the name of a web ACL after you create it.

", - "smithy.api#required": {} - } - }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", - "smithy.api#required": {} - } - }, - "LockToken": { - "target": "com.amazonaws.wafv2#LockToken", - "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#DeleteWebACLResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#DescribeAllManagedProducts": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#DescribeAllManagedProductsRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#DescribeAllManagedProductsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Provides high-level information for the Amazon Web Services Managed Rules rule groups and Amazon Web Services Marketplace managed rule groups.

" - } - }, - "com.amazonaws.wafv2#DescribeAllManagedProductsRequest": { - "type": "structure", - "members": { - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#DescribeAllManagedProductsResponse": { - "type": "structure", - "members": { - "ManagedProducts": { - "target": "com.amazonaws.wafv2#ManagedProductDescriptors", - "traits": { - "smithy.api#documentation": "

High-level information for the Amazon Web Services Managed Rules rule groups and Amazon Web Services Marketplace managed rule groups.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#DescribeManagedProductsByVendor": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#DescribeManagedProductsByVendorRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#DescribeManagedProductsByVendorResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - } - ], - "traits": { - "smithy.api#documentation": "

Provides high-level information for the managed rule groups owned by a specific vendor.

" - } - }, - "com.amazonaws.wafv2#DescribeManagedProductsByVendorRequest": { - "type": "structure", - "members": { - "VendorName": { - "target": "com.amazonaws.wafv2#VendorName", - "traits": { - "smithy.api#documentation": "

The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

", - "smithy.api#required": {} - } - }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#DescribeManagedProductsByVendorResponse": { - "type": "structure", - "members": { - "ManagedProducts": { - "target": "com.amazonaws.wafv2#ManagedProductDescriptors", - "traits": { - "smithy.api#documentation": "

High-level information for the managed rule groups owned by the specified vendor.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#DescribeManagedRuleGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#DescribeManagedRuleGroupRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#DescribeManagedRuleGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFExpiredManagedRuleGroupVersionException" - }, - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidResourceException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - } - ], - "traits": { - "smithy.api#documentation": "

Provides high-level information for a managed rule group, including descriptions of the rules.

" - } - }, - "com.amazonaws.wafv2#DescribeManagedRuleGroupRequest": { - "type": "structure", - "members": { - "VendorName": { - "target": "com.amazonaws.wafv2#VendorName", - "traits": { - "smithy.api#documentation": "

The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

", - "smithy.api#required": {} - } - }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", - "smithy.api#required": {} - } - }, - "VersionName": { - "target": "com.amazonaws.wafv2#VersionKeyString", - "traits": { - "smithy.api#documentation": "

The version of the rule group. You can only use a version that is not scheduled for\n expiration. If you don't provide this, WAF uses the vendor's default version.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#DescribeManagedRuleGroupResponse": { - "type": "structure", - "members": { - "VersionName": { - "target": "com.amazonaws.wafv2#VersionKeyString", - "traits": { - "smithy.api#documentation": "

The managed rule group's version.

" - } - }, - "SnsTopicArn": { - "target": "com.amazonaws.wafv2#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to provide notification of changes\n to the managed rule group. You can subscribe to the SNS topic to receive notifications when\n the managed rule group is modified, such as for new versions and for version expiration.\n For more information, see the Amazon Simple Notification Service Developer Guide.

" - } - }, - "Capacity": { - "target": "com.amazonaws.wafv2#CapacityUnit", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The web ACL capacity units (WCUs) required for this rule group.

\n

WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) \n in the WAF Developer Guide.

" - } - }, - "Rules": { - "target": "com.amazonaws.wafv2#RuleSummaries", - "traits": { - "smithy.api#documentation": "

" - } - }, - "LabelNamespace": { - "target": "com.amazonaws.wafv2#LabelName", - "traits": { - "smithy.api#documentation": "

The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.

\n " - } - }, - "AvailableLabels": { - "target": "com.amazonaws.wafv2#LabelSummaries", - "traits": { - "smithy.api#documentation": "

The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the RuleLabels for a Rule.

" - } - }, - "ConsumedLabels": { - "target": "com.amazonaws.wafv2#LabelSummaries", - "traits": { - "smithy.api#documentation": "

The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#DisassociateWebACL": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#DisassociateWebACLRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#DisassociateWebACLResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - } - ], - "traits": { - "smithy.api#documentation": "

Disassociates the specified regional application resource from any existing web ACL\n association. A resource can have at most one web ACL association. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To\n disassociate a web ACL, provide an empty web ACL ID in the CloudFront call\n UpdateDistribution. For information, see UpdateDistribution in the Amazon CloudFront API Reference.

" - } - }, - "com.amazonaws.wafv2#DisassociateWebACLRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.wafv2#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to disassociate from the web ACL.

\n

The ARN must be in one of the following formats:

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#DisassociateWebACLResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#DownloadUrl": { - "type": "string" - }, - "com.amazonaws.wafv2#EntityDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[\\w+=:#@/\\-,\\.][\\w+=:#@/\\-,\\.\\s]+[\\w+=:#@/\\-,\\.]$" - } - }, - "com.amazonaws.wafv2#EntityId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 36 - }, - "smithy.api#pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$" - } - }, - "com.amazonaws.wafv2#EntityName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[\\w\\-]+$" - } - }, - "com.amazonaws.wafv2#ErrorMessage": { - "type": "string" - }, - "com.amazonaws.wafv2#ErrorReason": { - "type": "string" - }, - "com.amazonaws.wafv2#ExcludedRule": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the rule whose action you want to override to Count.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies a single rule in a rule group whose action you want to override to Count.

\n \n

Instead of this option, use RuleActionOverrides. It accepts any valid action setting, including Count.

\n " - } - }, - "com.amazonaws.wafv2#ExcludedRules": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#ExcludedRule" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.wafv2#FailureCode": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 999 - } - } - }, - "com.amazonaws.wafv2#FailureReason": { - "type": "enum", - "members": { - "TOKEN_MISSING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TOKEN_MISSING" - } - }, - "TOKEN_EXPIRED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TOKEN_EXPIRED" - } - }, - "TOKEN_INVALID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TOKEN_INVALID" - } - }, - "TOKEN_DOMAIN_MISMATCH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TOKEN_DOMAIN_MISMATCH" - } - } - } - }, - "com.amazonaws.wafv2#FailureValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.wafv2#FallbackBehavior": { - "type": "enum", - "members": { - "MATCH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MATCH" - } - }, - "NO_MATCH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NO_MATCH" - } - } - } - }, - "com.amazonaws.wafv2#FieldIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.wafv2#FieldToMatch": { - "type": "structure", - "members": { - "SingleHeader": { - "target": "com.amazonaws.wafv2#SingleHeader", - "traits": { - "smithy.api#documentation": "

Inspect a single header. Provide the name of the header to inspect, for example,\n User-Agent or Referer. This setting isn't case\n sensitive.

\n

Example JSON: \"SingleHeader\": { \"Name\": \"haystack\" }\n

\n

Alternately, you can filter and inspect all headers with the Headers\n FieldToMatch setting.

" - } - }, - "SingleQueryArgument": { - "target": "com.amazonaws.wafv2#SingleQueryArgument", - "traits": { - "smithy.api#documentation": "

Inspect a single query argument. Provide the name of the query argument to inspect, such\n as UserName or SalesRegion. The name can be up to\n 30 characters long and isn't case sensitive.

\n

Example JSON: \"SingleQueryArgument\": { \"Name\": \"myArgument\" }\n

" - } - }, - "AllQueryArguments": { - "target": "com.amazonaws.wafv2#AllQueryArguments", - "traits": { - "smithy.api#documentation": "

Inspect all query arguments.

" - } - }, - "UriPath": { - "target": "com.amazonaws.wafv2#UriPath", - "traits": { - "smithy.api#documentation": "

Inspect the request URI path. This is the part of the web request that identifies a\n resource, for example, /images/daily-ad.jpg.

" - } - }, - "QueryString": { - "target": "com.amazonaws.wafv2#QueryString", - "traits": { - "smithy.api#documentation": "

Inspect the query string. This is the part of a URL that appears after a ?\n character, if any.

" - } - }, - "Body": { - "target": "com.amazonaws.wafv2#Body", - "traits": { - "smithy.api#documentation": "

Inspect the request body as plain text. The request body immediately follows the request\n headers. This is the part of a request that contains any additional data that you want to\n send to your web server as the HTTP request body, such as data from a form.

\n

A limited amount of the request body is forwarded to WAF for\n inspection by the underlying host service. For regional resources, the limit is 8 KB (8,192 kilobytes) and for CloudFront distributions, the limit is 16 KB (16,384 kilobytes). For CloudFront distributions,\n you can increase the limit in the web ACL's AssociationConfig, for additional processing fees.

\n

For information about how to handle oversized\n request bodies, see the Body object configuration.

" - } - }, - "Method": { - "target": "com.amazonaws.wafv2#Method", - "traits": { - "smithy.api#documentation": "

Inspect the HTTP method. The method indicates the type of operation that the request is\n asking the origin to perform.

" - } - }, - "JsonBody": { - "target": "com.amazonaws.wafv2#JsonBody", - "traits": { - "smithy.api#documentation": "

Inspect the request body as JSON. The request body immediately follows the request\n headers. This is the part of a request that contains any additional data that you want to\n send to your web server as the HTTP request body, such as data from a form.

\n

A limited amount of the request body is forwarded to WAF for\n inspection by the underlying host service. For regional resources, the limit is 8 KB (8,192 kilobytes) and for CloudFront distributions, the limit is 16 KB (16,384 kilobytes). For CloudFront distributions,\n you can increase the limit in the web ACL's AssociationConfig, for additional processing fees.

\n

For information about how to handle oversized\n request bodies, see the JsonBody object configuration.

" - } - }, - "Headers": { - "target": "com.amazonaws.wafv2#Headers", - "traits": { - "smithy.api#documentation": "

Inspect the request headers. You must configure scope and pattern matching filters in\n the Headers object, to define the set of headers to and the parts of the\n headers that WAF inspects.

\n

Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers\n are forwarded to WAF for inspection by the underlying host service. You must\n configure how to handle any oversize header content in the Headers object.\n WAF applies the pattern matching filters to the headers that it receives from the\n underlying host service.

" - } - }, - "Cookies": { - "target": "com.amazonaws.wafv2#Cookies", - "traits": { - "smithy.api#documentation": "

Inspect the request cookies. You must configure scope and pattern matching filters in\n the Cookies object, to define the set of cookies and the parts of the cookies\n that WAF inspects.

\n

Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies\n are forwarded to WAF for inspection by the underlying host service. You must\n configure how to handle any oversize cookie content in the Cookies object.\n WAF applies the pattern matching filters to the cookies that it receives from the\n underlying host service.

" - } - }, - "HeaderOrder": { - "target": "com.amazonaws.wafv2#HeaderOrder", - "traits": { - "smithy.api#documentation": "

Inspect a string containing the list of the request's header names, ordered as they appear in the web request\nthat WAF receives for inspection. \n WAF generates the string and then uses that as the field to match component in its inspection. \n WAF separates the header names in the string using commas and no added spaces.

\n

Matches against the header order string are case insensitive.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The part of the web request that you want WAF to inspect. Include the single\n FieldToMatch type that you want to inspect, with additional specifications\n as needed, according to the type. You specify a single request component in\n FieldToMatch for each rule statement that requires it. To inspect more than\n one component of the web request, create a separate rule statement for each\n component.

\n

Example JSON for a QueryString field to match:

\n

\n \"FieldToMatch\": { \"QueryString\": {} }\n

\n

Example JSON for a Method field to match specification:

\n

\n \"FieldToMatch\": { \"Method\": { \"Name\": \"DELETE\" } }\n

" - } - }, - "com.amazonaws.wafv2#FieldToMatchData": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.wafv2#Filter": { - "type": "structure", - "members": { - "Behavior": { - "target": "com.amazonaws.wafv2#FilterBehavior", - "traits": { - "smithy.api#documentation": "

How to handle logs that satisfy the filter's conditions and requirement.

", - "smithy.api#required": {} - } - }, - "Requirement": { - "target": "com.amazonaws.wafv2#FilterRequirement", - "traits": { - "smithy.api#documentation": "

Logic to apply to the filtering conditions. You can specify that, in order to satisfy\n the filter, a log must match all conditions or must match at least one condition.

", - "smithy.api#required": {} - } - }, - "Conditions": { - "target": "com.amazonaws.wafv2#Conditions", - "traits": { - "smithy.api#documentation": "

Match conditions for the filter.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A single logging filter, used in LoggingFilter.

" - } - }, - "com.amazonaws.wafv2#FilterBehavior": { - "type": "enum", - "members": { - "KEEP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KEEP" - } - }, - "DROP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DROP" - } - } - } - }, - "com.amazonaws.wafv2#FilterRequirement": { - "type": "enum", - "members": { - "MEETS_ALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MEETS_ALL" - } - }, - "MEETS_ANY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MEETS_ANY" - } - } - } - }, - "com.amazonaws.wafv2#Filters": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#Filter" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.wafv2#FirewallManagerRuleGroup": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the rule group. You cannot change the name of a rule group after you create it.

", - "smithy.api#required": {} - } - }, - "Priority": { - "target": "com.amazonaws.wafv2#RulePriority", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

If you define more than one rule group in the first or last Firewall Manager rule groups, WAF\n evaluates each request against the rule groups in order, starting from the lowest priority\n setting. The priorities don't need to be consecutive, but they must all be\n different.

", - "smithy.api#required": {} - } - }, - "FirewallManagerStatement": { - "target": "com.amazonaws.wafv2#FirewallManagerStatement", - "traits": { - "smithy.api#documentation": "

The processing guidance for an Firewall Manager rule. This is like a regular rule Statement, but it can only contain a rule group reference.

", - "smithy.api#required": {} - } - }, - "OverrideAction": { - "target": "com.amazonaws.wafv2#OverrideAction", - "traits": { - "smithy.api#documentation": "

The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.

\n

You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

\n \n

This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count \n matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings.

\n ", - "smithy.api#required": {} - } - }, - "VisibilityConfig": { - "target": "com.amazonaws.wafv2#VisibilityConfig", - "traits": { - "smithy.api#documentation": "

Defines and enables Amazon CloudWatch metrics and web request sample collection.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A rule group that's defined for an Firewall Manager WAF policy.

" - } - }, - "com.amazonaws.wafv2#FirewallManagerRuleGroups": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#FirewallManagerRuleGroup" - } - }, - "com.amazonaws.wafv2#FirewallManagerStatement": { - "type": "structure", - "members": { - "ManagedRuleGroupStatement": { - "target": "com.amazonaws.wafv2#ManagedRuleGroupStatement", - "traits": { - "smithy.api#documentation": "

A statement used by Firewall Manager to run the rules that are defined in a managed rule group. This is managed by Firewall Manager for an Firewall Manager WAF policy.

" - } - }, - "RuleGroupReferenceStatement": { - "target": "com.amazonaws.wafv2#RuleGroupReferenceStatement", - "traits": { - "smithy.api#documentation": "

A statement used by Firewall Manager to run the rules that are defined in a rule group. This is managed by Firewall Manager for an Firewall Manager WAF policy.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The processing guidance for an Firewall Manager rule. This is like a regular rule Statement, but it can only contain a single rule group reference.

" - } - }, - "com.amazonaws.wafv2#ForwardedIPConfig": { - "type": "structure", - "members": { - "HeaderName": { - "target": "com.amazonaws.wafv2#ForwardedIPHeaderName", - "traits": { - "smithy.api#documentation": "

The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

\n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n ", - "smithy.api#required": {} - } - }, - "FallbackBehavior": { - "target": "com.amazonaws.wafv2#FallbackBehavior", - "traits": { - "smithy.api#documentation": "

The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

\n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n \n

You can specify the following fallback behaviors:

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n \n

This configuration is used for GeoMatchStatement and RateBasedStatement. For IPSetReferenceStatement, use IPSetForwardedIPConfig instead.

\n

WAF only evaluates the first IP address found in the specified HTTP header.\n

" - } - }, - "com.amazonaws.wafv2#ForwardedIPHeaderName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[a-zA-Z0-9-]+$" - } - }, - "com.amazonaws.wafv2#ForwardedIPPosition": { - "type": "enum", - "members": { - "FIRST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FIRST" - } - }, - "LAST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LAST" - } - }, - "ANY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ANY" - } - } - } - }, - "com.amazonaws.wafv2#GenerateMobileSdkReleaseUrl": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#GenerateMobileSdkReleaseUrlRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#GenerateMobileSdkReleaseUrlResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - } - ], - "traits": { - "smithy.api#documentation": "

Generates a presigned download URL for the specified release of the mobile SDK.

\n

The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see \nWAF client application integration in the WAF Developer Guide.

" - } - }, - "com.amazonaws.wafv2#GenerateMobileSdkReleaseUrlRequest": { - "type": "structure", - "members": { - "Platform": { - "target": "com.amazonaws.wafv2#Platform", - "traits": { - "smithy.api#documentation": "

The device platform.

", - "smithy.api#required": {} - } - }, - "ReleaseVersion": { - "target": "com.amazonaws.wafv2#VersionKeyString", - "traits": { - "smithy.api#documentation": "

The release version. For the latest available version, specify\n LATEST.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#GenerateMobileSdkReleaseUrlResponse": { - "type": "structure", - "members": { - "Url": { - "target": "com.amazonaws.wafv2#DownloadUrl", - "traits": { - "smithy.api#documentation": "

The presigned download URL for the specified SDK release.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#GeoMatchStatement": { - "type": "structure", - "members": { - "CountryCodes": { - "target": "com.amazonaws.wafv2#CountryCodes", - "traits": { - "smithy.api#documentation": "

An array of two-character country codes that you want to match against, for example, [ \"US\", \"CN\" ], from\n the alpha-2 country ISO codes of the ISO 3166 international standard.

\n

When you use a geo match statement just for the region and country labels that it adds to requests, you still have to supply a country code for the rule to evaluate. In this case, you configure the rule to only count matching requests, but it will still generate logging and count metrics for any matches. You can reduce the logging and metrics that the rule produces by specifying a country that's unlikely to be a source of traffic to your site.

" - } - }, - "ForwardedIPConfig": { - "target": "com.amazonaws.wafv2#ForwardedIPConfig", - "traits": { - "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

A rule statement that labels web requests by country and region and that matches against web requests based on country code. A geo match rule labels every request that it inspects regardless of whether it finds a match.

\n \n

WAF labels requests using the alpha-2 country and region codes from the International Organization for Standardization (ISO) 3166 standard. WAF determines the codes using either the IP address in the web request origin or, if you specify it, the address in the geo match ForwardedIPConfig.

\n

If you use the web request origin, the label formats are awswaf:clientip:geo:region:- and awswaf:clientip:geo:country:.

\n

If you use a forwarded IP address, the label formats are awswaf:forwardedip:geo:region:- and awswaf:forwardedip:geo:country:.

\n

For additional details, see Geographic match rule statement in the WAF Developer Guide.

" - } - }, - "com.amazonaws.wafv2#GetDecryptedAPIKey": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#GetDecryptedAPIKeyRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#GetDecryptedAPIKeyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidResourceException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns your API key in decrypted form. Use this to check the token domains that you have defined for the key.

\n

API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. \n The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. \n For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.

" - } - }, - "com.amazonaws.wafv2#GetDecryptedAPIKeyRequest": { - "type": "structure", - "members": { - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", - "smithy.api#required": {} - } - }, - "APIKey": { - "target": "com.amazonaws.wafv2#APIKey", - "traits": { - "smithy.api#documentation": "

The encrypted API key.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#GetDecryptedAPIKeyResponse": { - "type": "structure", - "members": { - "TokenDomains": { - "target": "com.amazonaws.wafv2#TokenDomains", - "traits": { - "smithy.api#documentation": "

The token domains that are defined in this API key.

" - } - }, - "CreationTimestamp": { - "target": "com.amazonaws.wafv2#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that the key was created.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#GetIPSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#GetIPSetRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#GetIPSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves the specified IPSet.

" - } - }, - "com.amazonaws.wafv2#GetIPSetRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the IP set. You cannot change the name of an IPSet after you create it.

", - "smithy.api#required": {} - } - }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#GetIPSetResponse": { - "type": "structure", - "members": { - "IPSet": { - "target": "com.amazonaws.wafv2#IPSet", - "traits": { - "smithy.api#documentation": "

" - } - }, - "LockToken": { - "target": "com.amazonaws.wafv2#LockToken", - "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#GetLoggingConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#GetLoggingConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#GetLoggingConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the LoggingConfiguration for the specified web ACL.

" - } - }, - "com.amazonaws.wafv2#GetLoggingConfigurationRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.wafv2#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the web ACL for which you want to get the LoggingConfiguration.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#GetLoggingConfigurationResponse": { - "type": "structure", - "members": { - "LoggingConfiguration": { - "target": "com.amazonaws.wafv2#LoggingConfiguration", - "traits": { - "smithy.api#documentation": "

The LoggingConfiguration for the specified web ACL.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#GetManagedRuleSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#GetManagedRuleSetRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#GetManagedRuleSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves the specified managed rule set.

\n \n

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

\n

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

\n " - } - }, - "com.amazonaws.wafv2#GetManagedRuleSetRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

\n

This name is assigned to the corresponding managed rule group, which your customers can access and use.

", - "smithy.api#required": {} - } - }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#GetManagedRuleSetResponse": { - "type": "structure", - "members": { - "ManagedRuleSet": { - "target": "com.amazonaws.wafv2#ManagedRuleSet", - "traits": { - "smithy.api#documentation": "

The managed rule set that you requested.

" - } - }, - "LockToken": { - "target": "com.amazonaws.wafv2#LockToken", - "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#GetMobileSdkRelease": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#GetMobileSdkReleaseRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#GetMobileSdkReleaseResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves information for the specified mobile SDK release, including release notes and\n tags.

\n

The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see \nWAF client application integration in the WAF Developer Guide.

" - } - }, - "com.amazonaws.wafv2#GetMobileSdkReleaseRequest": { - "type": "structure", - "members": { - "Platform": { - "target": "com.amazonaws.wafv2#Platform", - "traits": { - "smithy.api#documentation": "

The device platform.

", - "smithy.api#required": {} - } - }, - "ReleaseVersion": { - "target": "com.amazonaws.wafv2#VersionKeyString", - "traits": { - "smithy.api#documentation": "

The release version. For the latest available version, specify\n LATEST.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#GetMobileSdkReleaseResponse": { - "type": "structure", - "members": { - "MobileSdkRelease": { - "target": "com.amazonaws.wafv2#MobileSdkRelease", - "traits": { - "smithy.api#documentation": "

Information for a specified SDK release, including release notes and tags.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#GetPermissionPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#GetPermissionPolicyRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#GetPermissionPolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the IAM policy that is attached to the specified rule group.

\n

You must be the owner of the rule group to perform this operation.

" - } - }, - "com.amazonaws.wafv2#GetPermissionPolicyRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.wafv2#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule group for which you want to get the\n policy.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#GetPermissionPolicyResponse": { - "type": "structure", - "members": { - "Policy": { - "target": "com.amazonaws.wafv2#PolicyString", - "traits": { - "smithy.api#documentation": "

The IAM policy that is attached to the specified rule group.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#GetRateBasedStatementManagedKeys": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#GetRateBasedStatementManagedKeysRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#GetRateBasedStatementManagedKeysResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - }, - { - "target": "com.amazonaws.wafv2#WAFUnsupportedAggregateKeyTypeException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves the IP addresses that are currently blocked by a rate-based rule instance. This\n is only available for rate-based rules that aggregate solely on the IP address or on the forwarded IP \n address.

\n

The maximum\n number of addresses that can be blocked for a single rate-based rule instance is 10,000.\n If more than 10,000 addresses exceed the rate limit, those with the highest rates are\n blocked.

\n

For a rate-based rule that you've defined inside a rule group, provide the name of the\n rule group reference statement in your request, in addition to the rate-based rule name and\n the web ACL name.

\n

WAF monitors web requests and manages keys independently for each unique combination\n of web ACL, optional rule group, and rate-based rule. For example, if you define a\n rate-based rule inside a rule group, and then use the rule group in a web ACL, WAF\n monitors web requests and manages keys for that web ACL, rule group reference statement,\n and rate-based rule instance. If you use the same rule group in a second web ACL, WAF\n monitors web requests and manages keys for this second usage completely independent of your\n first.

" - } - }, - "com.amazonaws.wafv2#GetRateBasedStatementManagedKeysRequest": { - "type": "structure", - "members": { - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", - "smithy.api#required": {} - } - }, - "WebACLName": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the web ACL. You cannot change the name of a web ACL after you create it.

", - "smithy.api#required": {} - } - }, - "WebACLId": { - "target": "com.amazonaws.wafv2#EntityId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", - "smithy.api#required": {} - } - }, - "RuleGroupRuleName": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the rule group reference statement in your web ACL. This is required only\n when you have the rate-based rule nested inside a rule group.

" - } - }, - "RuleName": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the rate-based rule to get the keys for. If you have the rule defined inside\n a rule group that you're using in your web ACL, also provide the name of the rule group\n reference statement in the request parameter RuleGroupRuleName.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#GetRateBasedStatementManagedKeysResponse": { - "type": "structure", - "members": { - "ManagedKeysIPV4": { - "target": "com.amazonaws.wafv2#RateBasedStatementManagedKeysIPSet", - "traits": { - "smithy.api#documentation": "

The keys that are of Internet Protocol version 4 (IPv4).

" - } - }, - "ManagedKeysIPV6": { - "target": "com.amazonaws.wafv2#RateBasedStatementManagedKeysIPSet", - "traits": { - "smithy.api#documentation": "

The keys that are of Internet Protocol version 6 (IPv6).

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#GetRegexPatternSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#GetRegexPatternSetRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#GetRegexPatternSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves the specified RegexPatternSet.

" - } - }, - "com.amazonaws.wafv2#GetRegexPatternSetRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the set. You cannot change the name after you create the set.

", - "smithy.api#required": {} - } - }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#GetRegexPatternSetResponse": { - "type": "structure", - "members": { - "RegexPatternSet": { - "target": "com.amazonaws.wafv2#RegexPatternSet", - "traits": { - "smithy.api#documentation": "

" - } - }, - "LockToken": { - "target": "com.amazonaws.wafv2#LockToken", - "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#GetRuleGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#GetRuleGroupRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#GetRuleGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves the specified RuleGroup.

" - } - }, - "com.amazonaws.wafv2#GetRuleGroupRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the rule group. You cannot change the name of a rule group after you create it.

" - } - }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n " - } - }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

" - } - }, - "ARN": { - "target": "com.amazonaws.wafv2#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entity.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#GetRuleGroupResponse": { - "type": "structure", - "members": { - "RuleGroup": { - "target": "com.amazonaws.wafv2#RuleGroup", - "traits": { - "smithy.api#documentation": "

" - } - }, - "LockToken": { - "target": "com.amazonaws.wafv2#LockToken", - "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#GetSampledRequests": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#GetSampledRequestsRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#GetSampledRequestsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - } - ], - "traits": { - "smithy.api#documentation": "

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

\n

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

" - } - }, - "com.amazonaws.wafv2#GetSampledRequestsRequest": { - "type": "structure", - "members": { - "WebAclArn": { - "target": "com.amazonaws.wafv2#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon resource name (ARN) of the WebACL for which you want a sample of\n requests.

", - "smithy.api#required": {} - } - }, - "RuleMetricName": { - "target": "com.amazonaws.wafv2#MetricName", - "traits": { - "smithy.api#documentation": "

The metric name assigned to the Rule or RuleGroup dimension for which\n you want a sample of requests.

", - "smithy.api#required": {} - } - }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", - "smithy.api#required": {} - } - }, - "TimeWindow": { - "target": "com.amazonaws.wafv2#TimeWindow", - "traits": { - "smithy.api#documentation": "

The start date and time and the end date and time of the range for which you want\n GetSampledRequests to return a sample of requests. You must specify the\n times in Coordinated Universal Time (UTC) format. UTC format includes the special\n designator, Z. For example, \"2016-09-27T14:50Z\". You can specify\n any time range in the previous three hours. If you specify a start time that's earlier than\n three hours ago, WAF sets it to three hours ago.

", - "smithy.api#required": {} - } - }, - "MaxItems": { - "target": "com.amazonaws.wafv2#ListMaxItems", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of requests that you want WAF to return from among the first 5,000\n requests that your Amazon Web Services resource received during the time range. If your resource received\n fewer requests than the value of MaxItems, GetSampledRequests\n returns information about all of them.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#GetSampledRequestsResponse": { - "type": "structure", - "members": { - "SampledRequests": { - "target": "com.amazonaws.wafv2#SampledHTTPRequests", - "traits": { - "smithy.api#documentation": "

A complex type that contains detailed information about each of the requests in the\n sample.

" - } - }, - "PopulationSize": { - "target": "com.amazonaws.wafv2#PopulationSize", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The total number of requests from which GetSampledRequests got a sample of\n MaxItems requests. If PopulationSize is less than\n MaxItems, the sample includes every request that your Amazon Web Services resource\n received during the specified time range.

" - } - }, - "TimeWindow": { - "target": "com.amazonaws.wafv2#TimeWindow", - "traits": { - "smithy.api#documentation": "

Usually, TimeWindow is the time range that you specified in the\n GetSampledRequests request. However, if your Amazon Web Services resource received more\n than 5,000 requests during the time range that you specified in the request,\n GetSampledRequests returns the time range for the first 5,000 requests.\n Times are in Coordinated Universal Time (UTC) format.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#GetWebACL": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#GetWebACLRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#GetWebACLResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves the specified WebACL.

" - } - }, - "com.amazonaws.wafv2#GetWebACLForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#GetWebACLForResourceRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#GetWebACLForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - }, - { - "target": "com.amazonaws.wafv2#WAFUnavailableEntityException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves the WebACL for the specified resource.

" - } - }, - "com.amazonaws.wafv2#GetWebACLForResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.wafv2#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource whose web ACL you want to retrieve.

\n

The ARN must be in one of the following formats:

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#GetWebACLForResourceResponse": { - "type": "structure", - "members": { - "WebACL": { - "target": "com.amazonaws.wafv2#WebACL", - "traits": { - "smithy.api#documentation": "

The web ACL that is associated with the resource. If there is no associated resource,\n WAF returns a null web ACL.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#GetWebACLRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the web ACL. You cannot change the name of a web ACL after you create it.

", - "smithy.api#required": {} - } - }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#GetWebACLResponse": { - "type": "structure", - "members": { - "WebACL": { - "target": "com.amazonaws.wafv2#WebACL", - "traits": { - "smithy.api#documentation": "

The web ACL specification. You can modify the settings in this web ACL and use it to\n update this web ACL or create a new one.

" - } - }, - "LockToken": { - "target": "com.amazonaws.wafv2#LockToken", - "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" - } - }, - "ApplicationIntegrationURL": { - "target": "com.amazonaws.wafv2#OutputUrl", - "traits": { - "smithy.api#documentation": "

The URL to use in SDK integrations with Amazon Web Services managed rule groups. For example, you can use the integration SDKs with the account takeover prevention managed rule group AWSManagedRulesATPRuleSet. This is only populated if you are using a rule group in your web ACL that integrates with your applications in this way. For more information, see WAF client application integration \nin the WAF Developer Guide.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#HTTPHeader": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#HeaderName", - "traits": { - "smithy.api#documentation": "

The name of the HTTP header.

" - } - }, - "Value": { - "target": "com.amazonaws.wafv2#HeaderValue", - "traits": { - "smithy.api#documentation": "

The value of the HTTP header.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Part of the response from GetSampledRequests. This is a complex type\n that appears as Headers in the response syntax. HTTPHeader\n contains the names and values of all of the headers that appear in one of the web requests.\n

" - } - }, - "com.amazonaws.wafv2#HTTPHeaders": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#HTTPHeader" - } - }, - "com.amazonaws.wafv2#HTTPMethod": { - "type": "string" - }, - "com.amazonaws.wafv2#HTTPRequest": { - "type": "structure", - "members": { - "ClientIP": { - "target": "com.amazonaws.wafv2#IPString", - "traits": { - "smithy.api#documentation": "

The IP address that the request originated from. If the web ACL is associated with a\n CloudFront distribution, this is the value of one of the following fields in CloudFront access\n logs:

\n " - } - }, - "Country": { - "target": "com.amazonaws.wafv2#Country", - "traits": { - "smithy.api#documentation": "

The two-letter country code for the country that the request originated from. For a\n current list of country codes, see the Wikipedia entry ISO 3166-1\n alpha-2.

" - } - }, - "URI": { - "target": "com.amazonaws.wafv2#URIString", - "traits": { - "smithy.api#documentation": "

The URI path of the request, which identifies the resource, for example,\n /images/daily-ad.jpg.

" - } - }, - "Method": { - "target": "com.amazonaws.wafv2#HTTPMethod", - "traits": { - "smithy.api#documentation": "

The HTTP method specified in the sampled web request.

" - } - }, - "HTTPVersion": { - "target": "com.amazonaws.wafv2#HTTPVersion", - "traits": { - "smithy.api#documentation": "

The HTTP version specified in the sampled web request, for example,\n HTTP/1.1.

" - } - }, - "Headers": { - "target": "com.amazonaws.wafv2#HTTPHeaders", - "traits": { - "smithy.api#documentation": "

A complex type that contains the name and value for each header in the sampled web\n request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Part of the response from GetSampledRequests. This is a complex type\n that appears as Request in the response syntax. HTTPRequest\n contains information about one of the web requests.

" - } - }, - "com.amazonaws.wafv2#HTTPVersion": { - "type": "string" - }, - "com.amazonaws.wafv2#HeaderMatchPattern": { - "type": "structure", - "members": { - "All": { - "target": "com.amazonaws.wafv2#All", - "traits": { - "smithy.api#documentation": "

Inspect all headers.

" - } - }, - "IncludedHeaders": { - "target": "com.amazonaws.wafv2#HeaderNames", - "traits": { - "smithy.api#documentation": "

Inspect only the headers that have a key that matches one of the strings specified here.\n

" - } - }, - "ExcludedHeaders": { - "target": "com.amazonaws.wafv2#HeaderNames", - "traits": { - "smithy.api#documentation": "

Inspect only the headers whose keys don't match any of the strings specified here.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The filter to use to identify the subset of headers to inspect in a web request.

\n

You must specify exactly one setting: either All, IncludedHeaders, or ExcludedHeaders.

\n

Example JSON: \"MatchPattern\": { \"ExcludedHeaders\": {\"KeyToExclude1\", \"KeyToExclude2\"} }\n

" - } - }, - "com.amazonaws.wafv2#HeaderName": { - "type": "string" - }, - "com.amazonaws.wafv2#HeaderNames": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#FieldToMatchData" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 199 - } - } - }, - "com.amazonaws.wafv2#HeaderOrder": { - "type": "structure", - "members": { - "OversizeHandling": { - "target": "com.amazonaws.wafv2#OversizeHandling", - "traits": { - "smithy.api#documentation": "

What WAF should do if the headers of the request are more numerous or larger than WAF can inspect. \n WAF does not support inspecting the entire contents of request headers \n when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers\n and at most 8 KB of header contents to WAF.

\n

The options for oversize handling are the following:

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Inspect a string containing the list of the request's header names, ordered as they appear in the web request\nthat WAF receives for inspection. \n WAF generates the string and then uses that as the field to match component in its inspection. \n WAF separates the header names in the string using commas and no added spaces.

\n

Matches against the header order string are case insensitive.

" - } - }, - "com.amazonaws.wafv2#HeaderValue": { - "type": "string" - }, - "com.amazonaws.wafv2#Headers": { - "type": "structure", - "members": { - "MatchPattern": { - "target": "com.amazonaws.wafv2#HeaderMatchPattern", - "traits": { - "smithy.api#documentation": "

The filter to use to identify the subset of headers to inspect in a web request.

\n

You must specify exactly one setting: either All, IncludedHeaders, or ExcludedHeaders.

\n

Example JSON: \"MatchPattern\": { \"ExcludedHeaders\": {\"KeyToExclude1\", \"KeyToExclude2\"} }\n

", - "smithy.api#required": {} - } - }, - "MatchScope": { - "target": "com.amazonaws.wafv2#MapMatchScope", - "traits": { - "smithy.api#documentation": "

The parts of the headers to match with the rule inspection criteria. If you specify\n All, WAF inspects both keys and values.

", - "smithy.api#required": {} - } - }, - "OversizeHandling": { - "target": "com.amazonaws.wafv2#OversizeHandling", - "traits": { - "smithy.api#documentation": "

What WAF should do if the headers of the request are more numerous or larger than WAF can inspect. \n WAF does not support inspecting the entire contents of request headers \n when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers\n and at most 8 KB of header contents to WAF.

\n

The options for oversize handling are the following:

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Inspect all headers in the web request. You can specify the parts of the headers to\n inspect and you can narrow the set of headers to inspect by including or excluding specific\n keys.

\n

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

\n

If you want to inspect just the value of a single header, use the\n SingleHeader\n FieldToMatch setting instead.

\n

Example JSON: \"Headers\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"KEY\",\n \"OversizeHandling\": \"MATCH\" }\n

" - } - }, - "com.amazonaws.wafv2#IPAddress": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.wafv2#IPAddressVersion": { - "type": "enum", - "members": { - "IPV4": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IPV4" - } - }, - "IPV6": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IPV6" - } - } - } - }, - "com.amazonaws.wafv2#IPAddresses": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#IPAddress" - } - }, - "com.amazonaws.wafv2#IPSet": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the IP set. You cannot change the name of an IPSet after you create it.

", - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", - "smithy.api#required": {} - } - }, - "ARN": { - "target": "com.amazonaws.wafv2#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entity.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.wafv2#EntityDescription", - "traits": { - "smithy.api#documentation": "

A description of the IP set that helps with identification.

" - } - }, - "IPAddressVersion": { - "target": "com.amazonaws.wafv2#IPAddressVersion", - "traits": { - "smithy.api#documentation": "

The version of the IP addresses, either IPV4 or IPV6.

", - "smithy.api#required": {} - } - }, - "Addresses": { - "target": "com.amazonaws.wafv2#IPAddresses", - "traits": { - "smithy.api#documentation": "

Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

\n

Example address strings:

\n \n

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

\n

Example JSON Addresses specifications:

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains zero or more IP addresses or blocks of IP addresses specified in Classless\n Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges\n except for /0. For information about CIDR notation, see the Wikipedia entry Classless\n Inter-Domain Routing.

\n

WAF assigns an ARN to each IPSet that you create. To use an IP set in a\n rule, you provide the ARN to the Rule statement IPSetReferenceStatement.

" - } - }, - "com.amazonaws.wafv2#IPSetForwardedIPConfig": { - "type": "structure", - "members": { - "HeaderName": { - "target": "com.amazonaws.wafv2#ForwardedIPHeaderName", - "traits": { - "smithy.api#documentation": "

The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

\n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n ", - "smithy.api#required": {} - } - }, - "FallbackBehavior": { - "target": "com.amazonaws.wafv2#FallbackBehavior", - "traits": { - "smithy.api#documentation": "

The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

\n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n \n

You can specify the following fallback behaviors:

\n ", - "smithy.api#required": {} - } - }, - "Position": { - "target": "com.amazonaws.wafv2#ForwardedIPPosition", - "traits": { - "smithy.api#documentation": "

The position in the header to search for the IP address. The header can contain IP\n addresses of the original client and also of proxies. For example, the header value could\n be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the\n original client and the rest identify proxies that the request went through.

\n

The options for this setting are the following:

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n \n

This configuration is used only for IPSetReferenceStatement. For GeoMatchStatement and RateBasedStatement, use ForwardedIPConfig instead.

" - } - }, - "com.amazonaws.wafv2#IPSetReferenceStatement": { - "type": "structure", - "members": { - "ARN": { - "target": "com.amazonaws.wafv2#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IPSet that this statement\n references.

", - "smithy.api#required": {} - } - }, - "IPSetForwardedIPConfig": { - "target": "com.amazonaws.wafv2#IPSetForwardedIPConfig", - "traits": { - "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.

\n

Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

" - } - }, - "com.amazonaws.wafv2#IPSetSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#IPSetSummary" - } - }, - "com.amazonaws.wafv2#IPSetSummary": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the IP set. You cannot change the name of an IPSet after you create it.

" - } - }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

" - } - }, - "Description": { - "target": "com.amazonaws.wafv2#EntityDescription", - "traits": { - "smithy.api#documentation": "

A description of the IP set that helps with identification.

" - } - }, - "LockToken": { - "target": "com.amazonaws.wafv2#LockToken", - "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" - } - }, - "ARN": { - "target": "com.amazonaws.wafv2#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entity.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

High-level information about an IPSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage an IPSet, and the ARN, that you provide to the IPSetReferenceStatement to use the address set in a Rule.

" - } - }, - "com.amazonaws.wafv2#IPString": { - "type": "string" - }, - "com.amazonaws.wafv2#ImmunityTimeProperty": { - "type": "structure", - "members": { - "ImmunityTime": { - "target": "com.amazonaws.wafv2#TimeWindowSecond", - "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, that a CAPTCHA or challenge timestamp is considered valid by WAF. The default\n setting is 300.

\n

For the Challenge action, the minimum setting is 300.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Used for CAPTCHA and challenge token settings. Determines \n how long a CAPTCHA or challenge timestamp remains valid after WAF updates it for a successful CAPTCHA or challenge response.

" - } - }, - "com.amazonaws.wafv2#InspectionLevel": { - "type": "enum", - "members": { - "COMMON": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMMON" - } - }, - "TARGETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TARGETED" - } - } - } - }, - "com.amazonaws.wafv2#JsonBody": { - "type": "structure", - "members": { - "MatchPattern": { - "target": "com.amazonaws.wafv2#JsonMatchPattern", - "traits": { - "smithy.api#documentation": "

The patterns to look for in the JSON body. WAF inspects the results of these\n pattern matches against the rule inspection criteria.

", - "smithy.api#required": {} - } - }, - "MatchScope": { - "target": "com.amazonaws.wafv2#JsonMatchScope", - "traits": { - "smithy.api#documentation": "

The parts of the JSON to match against using the MatchPattern. If you\n specify All, WAF matches against keys and values.

", - "smithy.api#required": {} - } - }, - "InvalidFallbackBehavior": { - "target": "com.amazonaws.wafv2#BodyParsingFallbackBehavior", - "traits": { - "smithy.api#documentation": "

What WAF should do if it fails to completely parse the JSON body. The options are\n the following:

\n \n

If you don't provide this setting, WAF parses and evaluates the content only up to the\n first parsing failure that it encounters.

\n

WAF does its best to parse the entire JSON body, but might be forced to stop for\n reasons such as invalid characters, duplicate keys, truncation, and any content whose root\n node isn't an object or an array.

\n

WAF parses the JSON in the following examples as two valid key, value pairs:

\n " - } - }, - "OversizeHandling": { - "target": "com.amazonaws.wafv2#OversizeHandling", - "traits": { - "smithy.api#documentation": "

What WAF should do if the body is larger than WAF can inspect. \n WAF does not support inspecting the entire contents of the web request body if the body \n exceeds the limit for the resource type. If the body is larger than the limit, the underlying host service \n only forwards the contents that are below the limit to WAF for inspection.

\n

The default limit is 8 KB (8,192 kilobytes) for regional resources and 16 KB (16,384 kilobytes) for CloudFront distributions. For CloudFront distributions, \n you can increase the limit in the web ACL AssociationConfig, for additional processing fees.

\n

The options for oversize handling are the following:

\n \n

You can combine the MATCH or NO_MATCH\n settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.

\n

Default: CONTINUE\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Inspect the body of the web request as JSON. The body immediately follows the request\n headers.

\n

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

\n

Use the specifications in this object to indicate which parts of the JSON body to\n inspect using the rule's inspection criteria. WAF inspects only the parts of the JSON\n that result from the matches that you indicate.\n

\n

Example JSON: \"JsonBody\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"ALL\"\n }\n

" - } - }, - "com.amazonaws.wafv2#JsonMatchPattern": { - "type": "structure", - "members": { - "All": { - "target": "com.amazonaws.wafv2#All", - "traits": { - "smithy.api#documentation": "

Match all of the elements. See also\n MatchScope\n in JsonBody.

\n

You must specify either this setting or the IncludedPaths setting, but not\n both.

" - } - }, - "IncludedPaths": { - "target": "com.amazonaws.wafv2#JsonPointerPaths", - "traits": { - "smithy.api#documentation": "

Match only the specified include paths. See also\n MatchScope\n in JsonBody.

\n

Provide the include paths using JSON Pointer syntax. For example, \"IncludedPaths\":\n [\"/dogs/0/name\", \"/dogs/1/name\"]. For information about this syntax, see the\n Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON)\n Pointer.

\n

You must specify either this setting or the All setting, but not\n both.

\n \n

Don't use this option to include all paths. Instead, use the All\n setting.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

The patterns to look for in the JSON body. WAF inspects the results of these\n pattern matches against the rule inspection criteria. This is used with the FieldToMatch option JsonBody.

" - } - }, - "com.amazonaws.wafv2#JsonMatchScope": { - "type": "enum", - "members": { - "ALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL" - } - }, - "KEY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KEY" - } - }, - "VALUE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VALUE" - } - } - } - }, - "com.amazonaws.wafv2#JsonPointerPath": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - }, - "smithy.api#pattern": "^([/])|([/](([^~])|(~[01]))+)$" - } - }, - "com.amazonaws.wafv2#JsonPointerPaths": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#JsonPointerPath" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.wafv2#Label": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#LabelName", - "traits": { - "smithy.api#documentation": "

The label string.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A single label container. This is used as an element of a label array in multiple\n contexts, for example, in RuleLabels inside a Rule and in\n Labels inside a SampledHTTPRequest.

" - } - }, - "com.amazonaws.wafv2#LabelMatchKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^[0-9A-Za-z_\\-:]+$" - } - }, - "com.amazonaws.wafv2#LabelMatchScope": { - "type": "enum", - "members": { - "LABEL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LABEL" - } - }, - "NAMESPACE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NAMESPACE" - } - } - } - }, - "com.amazonaws.wafv2#LabelMatchStatement": { - "type": "structure", - "members": { - "Scope": { - "target": "com.amazonaws.wafv2#LabelMatchScope", - "traits": { - "smithy.api#documentation": "

Specify whether you want to match using the label name or just the namespace.

", - "smithy.api#required": {} - } - }, - "Key": { - "target": "com.amazonaws.wafv2#LabelMatchKey", - "traits": { - "smithy.api#documentation": "

The string to match against. The setting you provide for this depends on the match\n statement's Scope setting:

\n \n

Labels are case sensitive and components of a label must be separated by colon, for\n example NS1:NS2:name.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A rule statement to match against labels that have been added to the web request by rules that have already run in the web ACL.

\n

The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, WAF performs the search for labels that were added in the same context as the label match statement.

" - } - }, - "com.amazonaws.wafv2#LabelName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^[0-9A-Za-z_\\-:]+$" - } - }, - "com.amazonaws.wafv2#LabelNameCondition": { - "type": "structure", - "members": { - "LabelName": { - "target": "com.amazonaws.wafv2#LabelName", - "traits": { - "smithy.api#documentation": "

The label name that a log record must contain in order to meet the condition. This must\n be a fully qualified label name. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A single label name condition for a Condition in a logging\n filter.

" - } - }, - "com.amazonaws.wafv2#LabelNamespace": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^[0-9A-Za-z_\\-:]+:$" - } - }, - "com.amazonaws.wafv2#LabelSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#LabelSummary" - } - }, - "com.amazonaws.wafv2#LabelSummary": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#LabelName", - "traits": { - "smithy.api#documentation": "

An individual label specification.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

List of labels used by one or more of the rules of a RuleGroup. This\n summary object is used for the following rule group lists:

\n " - } - }, - "com.amazonaws.wafv2#Labels": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#Label" - } - }, - "com.amazonaws.wafv2#ListAPIKeys": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#ListAPIKeysRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#ListAPIKeysResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidResourceException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves a list of the API keys that you've defined for the specified scope.

\n

API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. \n The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. \n For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.

" - } - }, - "com.amazonaws.wafv2#ListAPIKeysRequest": { - "type": "structure", - "members": { - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", - "smithy.api#required": {} - } - }, - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", - "traits": { - "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" - } - }, - "Limit": { - "target": "com.amazonaws.wafv2#PaginationLimit", - "traits": { - "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#ListAPIKeysResponse": { - "type": "structure", - "members": { - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", - "traits": { - "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" - } - }, - "APIKeySummaries": { - "target": "com.amazonaws.wafv2#APIKeySummaries", - "traits": { - "smithy.api#documentation": "

The array of key summaries. If you specified a Limit in your request, this might not be the full list.

" - } - }, - "ApplicationIntegrationURL": { - "target": "com.amazonaws.wafv2#OutputUrl", - "traits": { - "smithy.api#documentation": "

The CAPTCHA application integration URL, for use in your JavaScript implementation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#ListAvailableManagedRuleGroupVersions": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#ListAvailableManagedRuleGroupVersionsRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#ListAvailableManagedRuleGroupVersionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of the available versions for the specified managed rule group.

" - } - }, - "com.amazonaws.wafv2#ListAvailableManagedRuleGroupVersionsRequest": { - "type": "structure", - "members": { - "VendorName": { - "target": "com.amazonaws.wafv2#VendorName", - "traits": { - "smithy.api#documentation": "

The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

", - "smithy.api#required": {} - } - }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", - "smithy.api#required": {} - } - }, - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", - "traits": { - "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" - } - }, - "Limit": { - "target": "com.amazonaws.wafv2#PaginationLimit", - "traits": { - "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#ListAvailableManagedRuleGroupVersionsResponse": { - "type": "structure", - "members": { - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", - "traits": { - "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" - } - }, - "Versions": { - "target": "com.amazonaws.wafv2#ManagedRuleGroupVersions", - "traits": { - "smithy.api#documentation": "

The versions that are currently available for the specified managed rule group. If you specified a Limit in your request, this might not be the full list.

" - } - }, - "CurrentDefaultVersion": { - "target": "com.amazonaws.wafv2#VersionKeyString", - "traits": { - "smithy.api#documentation": "

The name of the version that's currently set as the default.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#ListAvailableManagedRuleGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#ListAvailableManagedRuleGroupsRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#ListAvailableManagedRuleGroupsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves an array of managed rule groups that are available for you to use. This list\n includes all Amazon Web Services Managed Rules rule groups and all of the Amazon Web Services Marketplace managed rule groups that you're\n subscribed to.

" - } - }, - "com.amazonaws.wafv2#ListAvailableManagedRuleGroupsRequest": { - "type": "structure", - "members": { - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", - "smithy.api#required": {} - } - }, - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", - "traits": { - "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" - } - }, - "Limit": { - "target": "com.amazonaws.wafv2#PaginationLimit", - "traits": { - "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#ListAvailableManagedRuleGroupsResponse": { - "type": "structure", - "members": { - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", - "traits": { - "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" - } - }, - "ManagedRuleGroups": { - "target": "com.amazonaws.wafv2#ManagedRuleGroupSummaries", - "traits": { - "smithy.api#documentation": "

Array of managed rule groups that you can use. If you specified a Limit in your request, this might not be the full list.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#ListIPSets": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#ListIPSetsRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#ListIPSetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves an array of IPSetSummary objects for the IP sets that you\n manage.

" - } - }, - "com.amazonaws.wafv2#ListIPSetsRequest": { - "type": "structure", - "members": { - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", - "smithy.api#required": {} - } - }, - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", - "traits": { - "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" - } - }, - "Limit": { - "target": "com.amazonaws.wafv2#PaginationLimit", - "traits": { - "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#ListIPSetsResponse": { - "type": "structure", - "members": { - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", - "traits": { - "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" - } - }, - "IPSets": { - "target": "com.amazonaws.wafv2#IPSetSummaries", - "traits": { - "smithy.api#documentation": "

Array of IPSets. If you specified a Limit in your request, this might not be the full list.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#ListLoggingConfigurations": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#ListLoggingConfigurationsRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#ListLoggingConfigurationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves an array of your LoggingConfiguration objects.

" - } - }, - "com.amazonaws.wafv2#ListLoggingConfigurationsRequest": { - "type": "structure", - "members": { - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", - "smithy.api#required": {} - } - }, - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", - "traits": { - "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" - } - }, - "Limit": { - "target": "com.amazonaws.wafv2#PaginationLimit", - "traits": { - "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#ListLoggingConfigurationsResponse": { - "type": "structure", - "members": { - "LoggingConfigurations": { - "target": "com.amazonaws.wafv2#LoggingConfigurations", - "traits": { - "smithy.api#documentation": "

Array of logging configurations. If you specified a Limit in your request, this might not be the full list.

" - } - }, - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", - "traits": { - "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#ListManagedRuleSets": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#ListManagedRuleSetsRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#ListManagedRuleSetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves the managed rule sets that you own.

\n \n

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

\n

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

\n " - } - }, - "com.amazonaws.wafv2#ListManagedRuleSetsRequest": { - "type": "structure", - "members": { - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", - "smithy.api#required": {} - } - }, - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", - "traits": { - "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" - } - }, - "Limit": { - "target": "com.amazonaws.wafv2#PaginationLimit", - "traits": { - "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#ListManagedRuleSetsResponse": { - "type": "structure", - "members": { - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", - "traits": { - "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" - } - }, - "ManagedRuleSets": { - "target": "com.amazonaws.wafv2#ManagedRuleSetSummaries", - "traits": { - "smithy.api#documentation": "

Your managed rule sets. If you specified a Limit in your request, this might not be the full list.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#ListMaxItems": { - "type": "long", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 500 - } - } - }, - "com.amazonaws.wafv2#ListMobileSdkReleases": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#ListMobileSdkReleasesRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#ListMobileSdkReleasesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves a list of the available releases for the mobile SDK and the specified device\n platform.

\n

The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see \nWAF client application integration in the WAF Developer Guide.

" - } - }, - "com.amazonaws.wafv2#ListMobileSdkReleasesRequest": { - "type": "structure", - "members": { - "Platform": { - "target": "com.amazonaws.wafv2#Platform", - "traits": { - "smithy.api#documentation": "

The device platform to retrieve the list for.

", - "smithy.api#required": {} - } - }, - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", - "traits": { - "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" - } - }, - "Limit": { - "target": "com.amazonaws.wafv2#PaginationLimit", - "traits": { - "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#ListMobileSdkReleasesResponse": { - "type": "structure", - "members": { - "ReleaseSummaries": { - "target": "com.amazonaws.wafv2#ReleaseSummaries", - "traits": { - "smithy.api#documentation": "

The high level information for the available SDK releases. If you specified a Limit in your request, this might not be the full list.

" - } - }, - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", - "traits": { - "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#ListRegexPatternSets": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#ListRegexPatternSetsRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#ListRegexPatternSetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves an array of RegexPatternSetSummary objects for the regex\n pattern sets that you manage.

" - } - }, - "com.amazonaws.wafv2#ListRegexPatternSetsRequest": { - "type": "structure", - "members": { - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", - "smithy.api#required": {} - } - }, - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", - "traits": { - "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" - } - }, - "Limit": { - "target": "com.amazonaws.wafv2#PaginationLimit", - "traits": { - "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#ListRegexPatternSetsResponse": { - "type": "structure", - "members": { - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", - "traits": { - "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" - } - }, - "RegexPatternSets": { - "target": "com.amazonaws.wafv2#RegexPatternSetSummaries", - "traits": { - "smithy.api#documentation": "

Array of regex pattern sets. If you specified a Limit in your request, this might not be the full list.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#ListResourcesForWebACL": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#ListResourcesForWebACLRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#ListResourcesForWebACLResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that\n are associated with the specified web ACL. If you want the list of Amazon CloudFront resources, use\n the CloudFront call ListDistributionsByWebACLId.

" - } - }, - "com.amazonaws.wafv2#ListResourcesForWebACLRequest": { - "type": "structure", - "members": { - "WebACLArn": { - "target": "com.amazonaws.wafv2#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the web ACL.

", - "smithy.api#required": {} - } - }, - "ResourceType": { - "target": "com.amazonaws.wafv2#ResourceType", - "traits": { - "smithy.api#documentation": "

Used for web ACLs that are scoped for regional applications.\n A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n \n

If you don't provide a resource type, the call uses the resource type APPLICATION_LOAD_BALANCER.

\n \n

Default: APPLICATION_LOAD_BALANCER\n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#ListResourcesForWebACLResponse": { - "type": "structure", - "members": { - "ResourceArns": { - "target": "com.amazonaws.wafv2#ResourceArns", - "traits": { - "smithy.api#documentation": "

The array of Amazon Resource Names (ARNs) of the associated resources.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#ListRuleGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#ListRuleGroupsRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#ListRuleGroupsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves an array of RuleGroupSummary objects for the rule groups\n that you manage.

" - } - }, - "com.amazonaws.wafv2#ListRuleGroupsRequest": { - "type": "structure", - "members": { - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", - "smithy.api#required": {} - } - }, - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", - "traits": { - "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" - } - }, - "Limit": { - "target": "com.amazonaws.wafv2#PaginationLimit", - "traits": { - "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#ListRuleGroupsResponse": { - "type": "structure", - "members": { - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", - "traits": { - "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" - } - }, - "RuleGroups": { - "target": "com.amazonaws.wafv2#RuleGroupSummaries", - "traits": { - "smithy.api#documentation": "

Array of rule groups. If you specified a Limit in your request, this might not be the full list.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#ListTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - }, - { - "target": "com.amazonaws.wafv2#WAFTagOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves the TagInfoForResource for the specified resource. Tags are\n key:value pairs that you can use to categorize and manage your resources, for purposes like\n billing. For example, you might set the tag key to \"customer\" and the value to the customer\n name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags\n for a resource.

\n

You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule\n groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF\n console.

" - } - }, - "com.amazonaws.wafv2#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", - "traits": { - "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" - } - }, - "Limit": { - "target": "com.amazonaws.wafv2#PaginationLimit", - "traits": { - "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" - } - }, - "ResourceARN": { - "target": "com.amazonaws.wafv2#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", - "traits": { - "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" - } - }, - "TagInfoForResource": { - "target": "com.amazonaws.wafv2#TagInfoForResource", - "traits": { - "smithy.api#documentation": "

The collection of tagging definitions for the resource. If you specified a Limit in your request, this might not be the full list.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#ListWebACLs": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#ListWebACLsRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#ListWebACLsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves an array of WebACLSummary objects for the web ACLs that you\n manage.

" - } - }, - "com.amazonaws.wafv2#ListWebACLsRequest": { - "type": "structure", - "members": { - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", - "smithy.api#required": {} - } - }, - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", - "traits": { - "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" - } - }, - "Limit": { - "target": "com.amazonaws.wafv2#PaginationLimit", - "traits": { - "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#ListWebACLsResponse": { - "type": "structure", - "members": { - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", - "traits": { - "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" - } - }, - "WebACLs": { - "target": "com.amazonaws.wafv2#WebACLSummaries", - "traits": { - "smithy.api#documentation": "

Array of web ACLs. If you specified a Limit in your request, this might not be the full list.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#LockToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 36 - }, - "smithy.api#pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$" - } - }, - "com.amazonaws.wafv2#LogDestinationConfigs": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#ResourceArn" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.wafv2#LoggingConfiguration": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.wafv2#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the web ACL that you want to associate with\n LogDestinationConfigs.

", - "smithy.api#required": {} - } - }, - "LogDestinationConfigs": { - "target": "com.amazonaws.wafv2#LogDestinationConfigs", - "traits": { - "smithy.api#documentation": "

The logging destination configuration that you want to associate with the web\n ACL.

\n \n

You can associate one logging destination to a web ACL.

\n ", - "smithy.api#required": {} - } - }, - "RedactedFields": { - "target": "com.amazonaws.wafv2#RedactedFields", - "traits": { - "smithy.api#documentation": "

The parts of the request that you want to keep out of the logs. For example, if you\n redact the SingleHeader field, the HEADER field in the logs will\n be REDACTED.

\n \n

You can specify only the following fields for redaction: UriPath,\n QueryString, SingleHeader, Method, and\n JsonBody.

\n " - } - }, - "ManagedByFirewallManager": { - "target": "com.amazonaws.wafv2#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the logging configuration was created by Firewall Manager, as part of an\n WAF policy configuration. If true, only Firewall Manager can modify or delete the\n configuration.

" - } - }, - "LoggingFilter": { - "target": "com.amazonaws.wafv2#LoggingFilter", - "traits": { - "smithy.api#documentation": "

Filtering that specifies which web requests are kept in the logs and which are dropped.\n You can filter on the rule action and on the web request labels that were applied by\n matching rules during web ACL evaluation.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Defines an association between logging destinations and a web ACL resource, for logging\n from WAF. As part of the association, you can specify parts of the standard logging\n fields to keep out of the logs and you can specify filters so that you log only a subset of\n the logging records.

\n \n

You can define one logging destination per web ACL.

\n \n

You can access information about the traffic that WAF inspects using the following\n steps:

\n
    \n
  1. \n

    Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose.

    \n

    The name that you give the destination must start with aws-waf-logs-. Depending on the type of destination, you might need to configure additional settings or permissions.

    \n

    For configuration requirements and pricing information for each destination type, see \n Logging web ACL traffic \n in the WAF Developer Guide.

    \n
    2. \n
  2. \n

    Associate your logging destination to your web ACL using a\n PutLoggingConfiguration request.

    \n
    3. \n
\n

When you successfully enable logging using a PutLoggingConfiguration\n request, WAF creates an additional role or policy that is required to write\n logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group.\n For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.

\n

For additional information about web ACL logging, see \n Logging web ACL traffic information \n in the WAF Developer Guide.

" - } - }, - "com.amazonaws.wafv2#LoggingConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#LoggingConfiguration" - } - }, - "com.amazonaws.wafv2#LoggingFilter": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.wafv2#Filters", - "traits": { - "smithy.api#documentation": "

The filters that you want to apply to the logs.

", - "smithy.api#required": {} - } - }, - "DefaultBehavior": { - "target": "com.amazonaws.wafv2#FilterBehavior", - "traits": { - "smithy.api#documentation": "

Default handling for logs that don't match any of the specified filtering conditions.\n

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Filtering that specifies which web requests are kept in the logs and which are dropped,\n defined for a web ACL's LoggingConfiguration.

\n

You can filter on the rule action and on the web request labels that were applied by\n matching rules during web ACL evaluation.

" - } - }, - "com.amazonaws.wafv2#LoginPathString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.wafv2#ManagedProductDescriptor": { - "type": "structure", - "members": { - "VendorName": { - "target": "com.amazonaws.wafv2#VendorName", - "traits": { - "smithy.api#documentation": "

The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

" - } - }, - "ManagedRuleSetName": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the managed rule group. For example, AWSManagedRulesAnonymousIpList or AWSManagedRulesATPRuleSet.

" - } - }, - "ProductId": { - "target": "com.amazonaws.wafv2#ProductId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

" - } - }, - "ProductLink": { - "target": "com.amazonaws.wafv2#ProductLink", - "traits": { - "smithy.api#documentation": "

For Amazon Web Services Marketplace managed rule groups only, the link to the rule group product page.

" - } - }, - "ProductTitle": { - "target": "com.amazonaws.wafv2#ProductTitle", - "traits": { - "smithy.api#documentation": "

The display name for the managed rule group. For example, Anonymous IP list or Account takeover prevention.

" - } - }, - "ProductDescription": { - "target": "com.amazonaws.wafv2#ProductDescription", - "traits": { - "smithy.api#documentation": "

A short description of the managed rule group.

" - } - }, - "SnsTopicArn": { - "target": "com.amazonaws.wafv2#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to provide notification of changes\n to the managed rule group. You can subscribe to the SNS topic to receive notifications when\n the managed rule group is modified, such as for new versions and for version expiration.\n For more information, see the Amazon Simple Notification Service Developer Guide.

" - } - }, - "IsVersioningSupported": { - "target": "com.amazonaws.wafv2#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the rule group is versioned.

" - } - }, - "IsAdvancedManagedRuleSet": { - "target": "com.amazonaws.wafv2#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the rule group provides an advanced set of protections, such as the the Amazon Web Services Managed Rules rule groups that \n are used for WAF intelligent threat mitigation.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The properties of a managed product, such as an Amazon Web Services Managed Rules rule group or an Amazon Web Services Marketplace managed rule group.

" - } - }, - "com.amazonaws.wafv2#ManagedProductDescriptors": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#ManagedProductDescriptor" - } - }, - "com.amazonaws.wafv2#ManagedRuleGroupConfig": { - "type": "structure", - "members": { - "LoginPath": { - "target": "com.amazonaws.wafv2#LoginPathString", - "traits": { - "smithy.api#deprecated": { - "message": "Deprecated. Use AWSManagedRulesATPRuleSet LoginPath" - }, - "smithy.api#documentation": "\n

Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet.

\n " - } - }, - "PayloadType": { - "target": "com.amazonaws.wafv2#PayloadType", - "traits": { - "smithy.api#deprecated": { - "message": "Deprecated. Use AWSManagedRulesATPRuleSet RequestInspection PayloadType" - }, - "smithy.api#documentation": "\n

Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet\n RequestInspection.

\n " - } - }, - "UsernameField": { - "target": "com.amazonaws.wafv2#UsernameField", - "traits": { - "smithy.api#deprecated": { - "message": "Deprecated. Use AWSManagedRulesATPRuleSet RequestInspection UsernameField" - }, - "smithy.api#documentation": "\n

Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet\n RequestInspection.

\n " - } - }, - "PasswordField": { - "target": "com.amazonaws.wafv2#PasswordField", - "traits": { - "smithy.api#deprecated": { - "message": "Deprecated. Use AWSManagedRulesATPRuleSet RequestInspection PasswordField" - }, - "smithy.api#documentation": "\n

Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet\n RequestInspection.

\n " - } - }, - "AWSManagedRulesBotControlRuleSet": { - "target": "com.amazonaws.wafv2#AWSManagedRulesBotControlRuleSet", - "traits": { - "smithy.api#documentation": "

Additional configuration for using the Bot Control managed rule group. Use this to specify the \n inspection level that you want to use. For information \n about using the Bot Control managed rule group, see WAF Bot Control rule group \n and WAF Bot Control\n in the WAF Developer Guide.

" - } - }, - "AWSManagedRulesATPRuleSet": { - "target": "com.amazonaws.wafv2#AWSManagedRulesATPRuleSet", - "traits": { - "smithy.api#documentation": "

Additional configuration for using the account takeover prevention (ATP) managed rule group, AWSManagedRulesATPRuleSet. \n Use this to provide login request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide\n the information about how your distribution responds to login requests.

\n

This configuration replaces the individual configuration fields in ManagedRuleGroupConfig and provides additional feature configuration.

\n

For information \n about using the ATP managed rule group, see WAF Fraud Control account takeover prevention (ATP) rule group \n and WAF Fraud Control account takeover prevention (ATP)\n in the WAF Developer Guide.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Additional information that's used by a managed rule group. Many managed rule groups don't require this.

\n

Use the AWSManagedRulesATPRuleSet configuration object for the account takeover prevention managed rule group, to provide information such as the sign-in page of your application and the type of content to accept or reject from the client.

\n

Use the AWSManagedRulesBotControlRuleSet configuration object to configure the \n protection level that you want the Bot Control rule group to use.

\n

For example specifications, see the examples section of CreateWebACL.

" - } - }, - "com.amazonaws.wafv2#ManagedRuleGroupConfigs": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#ManagedRuleGroupConfig" - } - }, - "com.amazonaws.wafv2#ManagedRuleGroupStatement": { - "type": "structure", - "members": { - "VendorName": { - "target": "com.amazonaws.wafv2#VendorName", - "traits": { - "smithy.api#documentation": "

The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

", - "smithy.api#required": {} - } - }, - "Version": { - "target": "com.amazonaws.wafv2#VersionKeyString", - "traits": { - "smithy.api#documentation": "

The version of the managed rule group to use. If you specify this, the version setting\n is fixed until you change it. If you don't specify this, WAF uses the vendor's\n default version, and then keeps the version at the vendor's default when the vendor updates\n the managed rule group settings.

" - } - }, - "ExcludedRules": { - "target": "com.amazonaws.wafv2#ExcludedRules", - "traits": { - "smithy.api#documentation": "

Rules in the referenced rule group whose actions are set to Count.

\n \n

Instead of this option, use RuleActionOverrides. It accepts any valid action setting, including Count.

\n " - } - }, - "ScopeDownStatement": { - "target": "com.amazonaws.wafv2#Statement", - "traits": { - "smithy.api#documentation": "

An optional nested statement that narrows the scope of the web requests that are\n evaluated by the managed rule group. Requests are only evaluated by the rule group if they\n match the scope-down statement. You can use any nestable Statement in the\n scope-down statement, and you can nest statements at any level, the same as you can for a\n rule statement.

" - } - }, - "ManagedRuleGroupConfigs": { - "target": "com.amazonaws.wafv2#ManagedRuleGroupConfigs", - "traits": { - "smithy.api#documentation": "

Additional information that's used by a managed rule group. Many managed rule groups don't require this.

\n

Use the AWSManagedRulesATPRuleSet configuration object for the account takeover prevention managed rule group, to provide information such as the sign-in page of your application and the type of content to accept or reject from the client.

\n

Use the AWSManagedRulesBotControlRuleSet configuration object to configure the \n protection level that you want the Bot Control rule group to use.

" - } - }, - "RuleActionOverrides": { - "target": "com.amazonaws.wafv2#RuleActionOverrides", - "traits": { - "smithy.api#documentation": "

Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.

\n

You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.

\n

You cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

\n \n

You are charged additional fees when you use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet or the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet. For more information, see WAF Pricing.

\n " - } - }, - "com.amazonaws.wafv2#ManagedRuleGroupSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#ManagedRuleGroupSummary" - } - }, - "com.amazonaws.wafv2#ManagedRuleGroupSummary": { - "type": "structure", - "members": { - "VendorName": { - "target": "com.amazonaws.wafv2#VendorName", - "traits": { - "smithy.api#documentation": "

The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

" - } - }, - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

" - } - }, - "VersioningSupported": { - "target": "com.amazonaws.wafv2#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the managed rule group is versioned. If it is, you can retrieve the\n versions list by calling ListAvailableManagedRuleGroupVersions.

" - } - }, - "Description": { - "target": "com.amazonaws.wafv2#EntityDescription", - "traits": { - "smithy.api#documentation": "

The description of the managed rule group, provided by Amazon Web Services Managed Rules or the Amazon Web Services Marketplace seller who manages it.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

High-level information about a managed rule group, returned by ListAvailableManagedRuleGroups. This provides information like the name and vendor name, that you provide when you add a ManagedRuleGroupStatement to a web ACL. Managed rule groups include Amazon Web Services Managed Rules rule groups and Amazon Web Services Marketplace managed rule groups. To use any Amazon Web Services Marketplace managed rule group, first subscribe to the rule group through Amazon Web Services Marketplace.

" - } - }, - "com.amazonaws.wafv2#ManagedRuleGroupVersion": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#VersionKeyString", - "traits": { - "smithy.api#documentation": "

The version name.

" - } - }, - "LastUpdateTimestamp": { - "target": "com.amazonaws.wafv2#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that the managed rule group owner updated the rule group version\n information.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a single version of a managed rule group.

" - } - }, - "com.amazonaws.wafv2#ManagedRuleGroupVersions": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#ManagedRuleGroupVersion" - } - }, - "com.amazonaws.wafv2#ManagedRuleSet": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

\n

This name is assigned to the corresponding managed rule group, which your customers can access and use.

", - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

", - "smithy.api#required": {} - } - }, - "ARN": { - "target": "com.amazonaws.wafv2#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entity.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.wafv2#EntityDescription", - "traits": { - "smithy.api#documentation": "

A description of the set that helps with identification.

" - } - }, - "PublishedVersions": { - "target": "com.amazonaws.wafv2#PublishedVersions", - "traits": { - "smithy.api#documentation": "

The versions of this managed rule set that are available for use by customers.

" - } - }, - "RecommendedVersion": { - "target": "com.amazonaws.wafv2#VersionKeyString", - "traits": { - "smithy.api#documentation": "

The version that you would like your customers to use.

" - } - }, - "LabelNamespace": { - "target": "com.amazonaws.wafv2#LabelName", - "traits": { - "smithy.api#documentation": "

The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

A set of rules that is managed by Amazon Web Services and Amazon Web Services Marketplace sellers to provide versioned managed\n rule groups for customers of WAF.

\n \n

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

\n

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

\n " - } - }, - "com.amazonaws.wafv2#ManagedRuleSetSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#ManagedRuleSetSummary" - } - }, - "com.amazonaws.wafv2#ManagedRuleSetSummary": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

\n

This name is assigned to the corresponding managed rule group, which your customers can access and use.

" - } - }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

" - } - }, - "Description": { - "target": "com.amazonaws.wafv2#EntityDescription", - "traits": { - "smithy.api#documentation": "

A description of the set that helps with identification.

" - } - }, - "LockToken": { - "target": "com.amazonaws.wafv2#LockToken", - "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" - } - }, - "ARN": { - "target": "com.amazonaws.wafv2#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entity.

" - } - }, - "LabelNamespace": { - "target": "com.amazonaws.wafv2#LabelName", - "traits": { - "smithy.api#documentation": "

The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

High-level information for a managed rule set.

\n \n

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

\n

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

\n " - } - }, - "com.amazonaws.wafv2#ManagedRuleSetVersion": { - "type": "structure", - "members": { - "AssociatedRuleGroupArn": { - "target": "com.amazonaws.wafv2#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the vendor rule group that's used to define the\n published version of your managed rule group.

" - } - }, - "Capacity": { - "target": "com.amazonaws.wafv2#CapacityUnit", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The web ACL capacity units (WCUs) required for this rule group.

\n

WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) \n in the WAF Developer Guide.

" - } - }, - "ForecastedLifetime": { - "target": "com.amazonaws.wafv2#TimeWindowDay", - "traits": { - "smithy.api#documentation": "

The amount of time you expect this version of your managed rule group to last, in days.\n

" - } - }, - "PublishTimestamp": { - "target": "com.amazonaws.wafv2#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that you first published this version.

\n

Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\".

" - } - }, - "LastUpdateTimestamp": { - "target": "com.amazonaws.wafv2#Timestamp", - "traits": { - "smithy.api#documentation": "

The last time that you updated this version.

\n

Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\".

" - } - }, - "ExpiryTimestamp": { - "target": "com.amazonaws.wafv2#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that this version is set to expire.

\n

Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\".

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information for a single version of a managed rule set.

\n \n

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

\n

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

\n " - } - }, - "com.amazonaws.wafv2#MapMatchScope": { - "type": "enum", - "members": { - "ALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL" - } - }, - "KEY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KEY" - } - }, - "VALUE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VALUE" - } - } - } - }, - "com.amazonaws.wafv2#Method": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

Inspect the HTTP method of the web request. The method indicates the type of operation\n that the request is asking the origin to perform.

\n

This is used in the FieldToMatch specification for some web request component types.

\n

JSON specification: \"Method\": {}\n

" - } - }, - "com.amazonaws.wafv2#MetricName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[\\w#:\\.\\-/]+$" - } - }, - "com.amazonaws.wafv2#MobileSdkRelease": { - "type": "structure", - "members": { - "ReleaseVersion": { - "target": "com.amazonaws.wafv2#VersionKeyString", - "traits": { - "smithy.api#documentation": "

The release version.

" - } - }, - "Timestamp": { - "target": "com.amazonaws.wafv2#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp of the release.

" - } - }, - "ReleaseNotes": { - "target": "com.amazonaws.wafv2#ReleaseNotes", - "traits": { - "smithy.api#documentation": "

Notes describing the release.

" - } - }, - "Tags": { - "target": "com.amazonaws.wafv2#TagList", - "traits": { - "smithy.api#documentation": "

Tags that are associated with the release.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information for a release of the mobile SDK, including release notes and tags.

\n

The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see \nWAF client application integration in the WAF Developer Guide.

" - } - }, - "com.amazonaws.wafv2#NextMarker": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.wafv2#NoneAction": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

Specifies that WAF should do nothing. This is used for the\n OverrideAction setting on a Rule when the rule uses a\n rule group reference statement.

\n

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

\n

JSON specification: \"None\": {}\n

" - } - }, - "com.amazonaws.wafv2#NotStatement": { - "type": "structure", - "members": { - "Statement": { - "target": "com.amazonaws.wafv2#Statement", - "traits": { - "smithy.api#documentation": "

The statement to negate. You can use any statement that can be nested.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement.

" - } - }, - "com.amazonaws.wafv2#OrStatement": { - "type": "structure", - "members": { - "Statements": { - "target": "com.amazonaws.wafv2#Statements", - "traits": { - "smithy.api#documentation": "

The statements to combine with OR logic. You can use any statements that can be\n nested.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement.

" - } - }, - "com.amazonaws.wafv2#OutputUrl": { - "type": "string" - }, - "com.amazonaws.wafv2#OverrideAction": { - "type": "structure", - "members": { - "Count": { - "target": "com.amazonaws.wafv2#CountAction", - "traits": { - "smithy.api#documentation": "

Override the rule group evaluation result to count only.

\n \n

This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count \n matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings.

\n " - } - }, - "None": { - "target": "com.amazonaws.wafv2#NoneAction", - "traits": { - "smithy.api#documentation": "

Don't override the rule group evaluation result. This is the most common setting.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.

\n

You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

\n \n

This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count \n matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings.

\n " - } - }, - "com.amazonaws.wafv2#OversizeHandling": { - "type": "enum", - "members": { - "CONTINUE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTINUE" - } - }, - "MATCH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MATCH" - } - }, - "NO_MATCH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NO_MATCH" - } - } - } - }, - "com.amazonaws.wafv2#PaginationLimit": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.wafv2#ParameterExceptionField": { - "type": "enum", - "members": { - "WEB_ACL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WEB_ACL" - } - }, - "RULE_GROUP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RULE_GROUP" - } - }, - "REGEX_PATTERN_SET": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REGEX_PATTERN_SET" - } - }, - "IP_SET": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IP_SET" - } - }, - "MANAGED_RULE_SET": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MANAGED_RULE_SET" - } - }, - "RULE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RULE" - } - }, - "EXCLUDED_RULE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXCLUDED_RULE" - } - }, - "STATEMENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STATEMENT" - } - }, - "BYTE_MATCH_STATEMENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BYTE_MATCH_STATEMENT" - } - }, - "SQLI_MATCH_STATEMENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SQLI_MATCH_STATEMENT" - } - }, - "XSS_MATCH_STATEMENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "XSS_MATCH_STATEMENT" - } - }, - "SIZE_CONSTRAINT_STATEMENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SIZE_CONSTRAINT_STATEMENT" - } - }, - "GEO_MATCH_STATEMENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GEO_MATCH_STATEMENT" - } - }, - "RATE_BASED_STATEMENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RATE_BASED_STATEMENT" - } - }, - "RULE_GROUP_REFERENCE_STATEMENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RULE_GROUP_REFERENCE_STATEMENT" - } - }, - "REGEX_PATTERN_REFERENCE_STATEMENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REGEX_PATTERN_REFERENCE_STATEMENT" - } - }, - "IP_SET_REFERENCE_STATEMENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IP_SET_REFERENCE_STATEMENT" - } - }, - "MANAGED_RULE_SET_STATEMENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MANAGED_RULE_SET_STATEMENT" - } - }, - "LABEL_MATCH_STATEMENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LABEL_MATCH_STATEMENT" - } - }, - "AND_STATEMENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AND_STATEMENT" - } - }, - "OR_STATEMENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OR_STATEMENT" - } - }, - "NOT_STATEMENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_STATEMENT" - } - }, - "IP_ADDRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IP_ADDRESS" - } - }, - "IP_ADDRESS_VERSION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IP_ADDRESS_VERSION" - } - }, - "FIELD_TO_MATCH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FIELD_TO_MATCH" - } - }, - "TEXT_TRANSFORMATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TEXT_TRANSFORMATION" - } - }, - "SINGLE_QUERY_ARGUMENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SINGLE_QUERY_ARGUMENT" - } - }, - "SINGLE_HEADER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SINGLE_HEADER" - } - }, - "DEFAULT_ACTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DEFAULT_ACTION" - } - }, - "RULE_ACTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RULE_ACTION" - } - }, - "ENTITY_LIMIT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENTITY_LIMIT" - } - }, - "OVERRIDE_ACTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OVERRIDE_ACTION" - } - }, - "SCOPE_VALUE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SCOPE_VALUE" - } - }, - "RESOURCE_ARN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RESOURCE_ARN" - } - }, - "RESOURCE_TYPE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RESOURCE_TYPE" - } - }, - "TAGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TAGS" - } - }, - "TAG_KEYS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TAG_KEYS" - } - }, - "METRIC_NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "METRIC_NAME" - } - }, - "FIREWALL_MANAGER_STATEMENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FIREWALL_MANAGER_STATEMENT" - } - }, - "FALLBACK_BEHAVIOR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FALLBACK_BEHAVIOR" - } - }, - "POSITION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "POSITION" - } - }, - "FORWARDED_IP_CONFIG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FORWARDED_IP_CONFIG" - } - }, - "IP_SET_FORWARDED_IP_CONFIG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IP_SET_FORWARDED_IP_CONFIG" - } - }, - "HEADER_NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HEADER_NAME" - } - }, - "CUSTOM_REQUEST_HANDLING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CUSTOM_REQUEST_HANDLING" - } - }, - "RESPONSE_CONTENT_TYPE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RESPONSE_CONTENT_TYPE" - } - }, - "CUSTOM_RESPONSE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CUSTOM_RESPONSE" - } - }, - "CUSTOM_RESPONSE_BODY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CUSTOM_RESPONSE_BODY" - } - }, - "JSON_MATCH_PATTERN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JSON_MATCH_PATTERN" - } - }, - "JSON_MATCH_SCOPE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JSON_MATCH_SCOPE" - } - }, - "BODY_PARSING_FALLBACK_BEHAVIOR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BODY_PARSING_FALLBACK_BEHAVIOR" - } - }, - "LOGGING_FILTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LOGGING_FILTER" - } - }, - "FILTER_CONDITION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FILTER_CONDITION" - } - }, - "EXPIRE_TIMESTAMP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXPIRE_TIMESTAMP" - } - }, - "CHANGE_PROPAGATION_STATUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CHANGE_PROPAGATION_STATUS" - } - }, - "ASSOCIABLE_RESOURCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ASSOCIABLE_RESOURCE" - } - }, - "LOG_DESTINATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LOG_DESTINATION" - } - }, - "MANAGED_RULE_GROUP_CONFIG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MANAGED_RULE_GROUP_CONFIG" - } - }, - "PAYLOAD_TYPE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PAYLOAD_TYPE" - } - }, - "HEADER_MATCH_PATTERN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HEADER_MATCH_PATTERN" - } - }, - "COOKIE_MATCH_PATTERN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COOKIE_MATCH_PATTERN" - } - }, - "MAP_MATCH_SCOPE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAP_MATCH_SCOPE" - } - }, - "OVERSIZE_HANDLING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OVERSIZE_HANDLING" - } - }, - "CHALLENGE_CONFIG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CHALLENGE_CONFIG" - } - }, - "TOKEN_DOMAIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TOKEN_DOMAIN" - } - }, - "ATP_RULE_SET_RESPONSE_INSPECTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ATP_RULE_SET_RESPONSE_INSPECTION" - } - }, - "ASSOCIATED_RESOURCE_TYPE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ASSOCIATED_RESOURCE_TYPE" - } - }, - "SCOPE_DOWN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SCOPE_DOWN" - } - }, - "CUSTOM_KEYS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CUSTOM_KEYS" - } - } - } - }, - "com.amazonaws.wafv2#ParameterExceptionParameter": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.wafv2#PasswordField": { - "type": "structure", - "members": { - "Identifier": { - "target": "com.amazonaws.wafv2#FieldIdentifier", - "traits": { - "smithy.api#documentation": "

The name of the password field. For example /form/password.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about your login page password field for request inspection, used in the \n AWSManagedRulesATPRuleSet\n RequestInspection configuration.

" - } - }, - "com.amazonaws.wafv2#PayloadType": { - "type": "enum", - "members": { - "JSON": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JSON" - } - }, - "FORM_ENCODED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FORM_ENCODED" - } - } - } - }, - "com.amazonaws.wafv2#Platform": { - "type": "enum", - "members": { - "IOS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IOS" - } - }, - "ANDROID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ANDROID" - } - } - } - }, - "com.amazonaws.wafv2#PolicyString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 395000 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.wafv2#PopulationSize": { - "type": "long", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.wafv2#PositionalConstraint": { - "type": "enum", - "members": { - "EXACTLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXACTLY" - } - }, - "STARTS_WITH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STARTS_WITH" - } - }, - "ENDS_WITH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENDS_WITH" - } - }, - "CONTAINS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTAINS" - } - }, - "CONTAINS_WORD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTAINS_WORD" - } - } - } - }, - "com.amazonaws.wafv2#ProductDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.wafv2#ProductId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.wafv2#ProductLink": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.wafv2#ProductTitle": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.wafv2#PublishedVersions": { - "type": "map", - "key": { - "target": "com.amazonaws.wafv2#VersionKeyString" - }, - "value": { - "target": "com.amazonaws.wafv2#ManagedRuleSetVersion" - } - }, - "com.amazonaws.wafv2#PutLoggingConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#PutLoggingConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#PutLoggingConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFLimitsExceededException" - }, - { - "target": "com.amazonaws.wafv2#WAFLogDestinationPermissionIssueException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - }, - { - "target": "com.amazonaws.wafv2#WAFOptimisticLockException" - }, - { - "target": "com.amazonaws.wafv2#WAFServiceLinkedRoleErrorException" - } - ], - "traits": { - "smithy.api#documentation": "

Enables the specified LoggingConfiguration, to start logging from a\n web ACL, according to the configuration provided.

\n \n

This operation completely replaces any mutable specifications that you already have for a logging configuration with the ones that you provide to this call.

\n

To modify an existing logging configuration, do the following:

\n
    \n
  1. \n

    Retrieve it by calling GetLoggingConfiguration\n

    \n
    2. \n
  2. \n

    Update its settings as needed

    \n
    3. \n
  3. \n

    Provide the complete logging configuration specification to this call

    \n
    4. \n
\n \n \n

You can define one logging destination per web ACL.

\n \n

You can access information about the traffic that WAF inspects using the following\n steps:

\n
    \n
  1. \n

    Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose.

    \n

    The name that you give the destination must start with aws-waf-logs-. Depending on the type of destination, you might need to configure additional settings or permissions.

    \n

    For configuration requirements and pricing information for each destination type, see \n Logging web ACL traffic \n in the WAF Developer Guide.

    \n
    2. \n
  2. \n

    Associate your logging destination to your web ACL using a\n PutLoggingConfiguration request.

    \n
    3. \n
\n

When you successfully enable logging using a PutLoggingConfiguration\n request, WAF creates an additional role or policy that is required to write\n logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group.\n For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.

\n

For additional information about web ACL logging, see \n Logging web ACL traffic information \n in the WAF Developer Guide.

" - } - }, - "com.amazonaws.wafv2#PutLoggingConfigurationRequest": { - "type": "structure", - "members": { - "LoggingConfiguration": { - "target": "com.amazonaws.wafv2#LoggingConfiguration", - "traits": { - "smithy.api#documentation": "

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#PutLoggingConfigurationResponse": { - "type": "structure", - "members": { - "LoggingConfiguration": { - "target": "com.amazonaws.wafv2#LoggingConfiguration", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#PutManagedRuleSetVersions": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#PutManagedRuleSetVersionsRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#PutManagedRuleSetVersionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - }, - { - "target": "com.amazonaws.wafv2#WAFOptimisticLockException" - } - ], - "traits": { - "smithy.api#documentation": "

Defines the versions of your managed rule set that you are offering to the customers.\n Customers see your offerings as managed rule groups with versioning.

\n \n

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

\n

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

\n \n

Customers retrieve their managed rule group list by calling ListAvailableManagedRuleGroups. The name that you provide here for your\n managed rule set is the name the customer sees for the corresponding managed rule group.\n Customers can retrieve the available versions for a managed rule group by calling ListAvailableManagedRuleGroupVersions. You provide a rule group\n specification for each version. For each managed rule set, you must specify a version that\n you recommend using.

\n

To initiate the expiration of a managed rule group version, use UpdateManagedRuleSetVersionExpiryDate.

" - } - }, - "com.amazonaws.wafv2#PutManagedRuleSetVersionsRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

\n

This name is assigned to the corresponding managed rule group, which your customers can access and use.

", - "smithy.api#required": {} - } - }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

", - "smithy.api#required": {} - } - }, - "LockToken": { - "target": "com.amazonaws.wafv2#LockToken", - "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", - "smithy.api#required": {} - } - }, - "RecommendedVersion": { - "target": "com.amazonaws.wafv2#VersionKeyString", - "traits": { - "smithy.api#documentation": "

The version of the named managed rule group that you'd like your customers to choose,\n from among your version offerings.

" - } - }, - "VersionsToPublish": { - "target": "com.amazonaws.wafv2#VersionsToPublish", - "traits": { - "smithy.api#documentation": "

The versions of the named managed rule group that you want to offer to your customers.\n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#PutManagedRuleSetVersionsResponse": { - "type": "structure", - "members": { - "NextLockToken": { - "target": "com.amazonaws.wafv2#LockToken", - "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#PutPermissionPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#PutPermissionPolicyRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#PutPermissionPolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidPermissionPolicyException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - } - ], - "traits": { - "smithy.api#documentation": "

Attaches an IAM policy to the specified resource. Use this to share a rule group across\n accounts.

\n

You must be the owner of the rule group to perform this operation.

\n

This action is subject to the following restrictions:

\n " - } - }, - "com.amazonaws.wafv2#PutPermissionPolicyRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.wafv2#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the RuleGroup to which you want to\n attach the policy.

", - "smithy.api#required": {} - } - }, - "Policy": { - "target": "com.amazonaws.wafv2#PolicyString", - "traits": { - "smithy.api#documentation": "

The policy to attach to the specified rule group.

\n

The policy specifications must conform to the following:

\n \n

For more information, see IAM Policies.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#PutPermissionPolicyResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#QueryString": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

Inspect the query string of the web request. This is the part of a URL that appears\n after a ? character, if any.

\n

This is used in the FieldToMatch specification for some web request component types.

\n

JSON specification: \"QueryString\": {}\n

" - } - }, - "com.amazonaws.wafv2#RateBasedStatement": { - "type": "structure", - "members": { - "Limit": { - "target": "com.amazonaws.wafv2#RateLimit", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The limit on requests per 5-minute period for a single aggregation instance for the rate-based rule. \n If the rate-based statement includes a ScopeDownStatement, this limit is applied only to the\n requests that match the statement.

\n

Examples:

\n ", - "smithy.api#required": {} - } - }, - "AggregateKeyType": { - "target": "com.amazonaws.wafv2#RateBasedStatementAggregateKeyType", - "traits": { - "smithy.api#documentation": "

Setting that indicates how to aggregate the request counts.

\n \n

Web requests that are missing any of the components specified in the aggregation keys\n are omitted from the rate-based rule evaluation and handling.

\n \n ", - "smithy.api#required": {} - } - }, - "ScopeDownStatement": { - "target": "com.amazonaws.wafv2#Statement", - "traits": { - "smithy.api#documentation": "

An optional nested statement that narrows the scope of the web requests that are\n evaluated and managed by the rate-based statement. When you use a scope-down statement, \n the rate-based rule only tracks and rate limits \n requests that match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any\n level, the same as you can for a rule statement.

" - } - }, - "ForwardedIPConfig": { - "target": "com.amazonaws.wafv2#ForwardedIPConfig", - "traits": { - "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n \n

This is required if you specify a forwarded IP in the rule's aggregate key settings.

" - } - }, - "CustomKeys": { - "target": "com.amazonaws.wafv2#RateBasedStatementCustomKeys", - "traits": { - "smithy.api#documentation": "

Specifies the aggregate keys to use in a rate-base rule.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A rate-based rule counts incoming requests and rate limits requests when they are coming at too fast a rate. The rule categorizes requests according to your aggregation criteria, collects them into aggregation instances, and counts and rate limits the requests for each instance.

\n

You can specify individual aggregation keys, like IP address or HTTP method. You can also specify aggregation key combinations, like IP address and HTTP method, or HTTP method, query argument, and cookie.

\n

Each unique set of values for the aggregation keys that you specify is a separate aggregation instance, with the value from each key contributing to the aggregation instance definition.

\n

For example, assume the rule evaluates web requests with the following IP address and HTTP method values:

\n \n

The rule would create different aggregation instances according to your aggregation criteria, for example:

\n \n

For any n-tuple of aggregation keys, each unique combination of values for the keys defines a separate aggregation instance, which WAF counts and rate-limits individually.

\n

You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts and rate limits requests that match the nested statement. You can use this nested scope-down statement in conjunction with your aggregation key specifications or you can just count and rate limit all requests that match the scope-down statement, without additional aggregation. When you choose to just manage all requests that match a scope-down statement, the aggregation instance is singular for the rule.

\n

You cannot nest a RateBasedStatement inside another statement, for example inside a NotStatement or OrStatement. You can define a RateBasedStatement inside a web ACL and inside a rule group.

\n

For additional information about the options, see Rate limiting web requests using rate-based rules \n in the WAF Developer Guide.

\n

If you only aggregate on the individual IP address or forwarded IP address, you can retrieve the list of IP addresses that WAF \n is currently rate limiting for a rule through the API call GetRateBasedStatementManagedKeys. This option is not available\n for other aggregation configurations.

\n

WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF.

" - } - }, - "com.amazonaws.wafv2#RateBasedStatementAggregateKeyType": { - "type": "enum", - "members": { - "IP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IP" - } - }, - "FORWARDED_IP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FORWARDED_IP" - } - }, - "CUSTOM_KEYS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CUSTOM_KEYS" - } - }, - "CONSTANT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONSTANT" - } - } - } - }, - "com.amazonaws.wafv2#RateBasedStatementCustomKey": { - "type": "structure", - "members": { - "Header": { - "target": "com.amazonaws.wafv2#RateLimitHeader", - "traits": { - "smithy.api#documentation": "

Use the value of a header in the request as an aggregate key. Each distinct value in the header contributes to the aggregation instance. If you use a single \n header as your custom key, then each value fully defines an aggregation instance.

" - } - }, - "Cookie": { - "target": "com.amazonaws.wafv2#RateLimitCookie", - "traits": { - "smithy.api#documentation": "

Use the value of a cookie in the request as an aggregate key. Each distinct value in the cookie contributes to the aggregation instance. If you use a single\n cookie as your custom key, then each value fully defines an aggregation instance.

" - } - }, - "QueryArgument": { - "target": "com.amazonaws.wafv2#RateLimitQueryArgument", - "traits": { - "smithy.api#documentation": "

Use the specified query argument as an aggregate key. Each distinct value for the named query argument contributes to the aggregation instance. If you \n use a single query argument as your custom key, then each value fully defines an aggregation instance.

" - } - }, - "QueryString": { - "target": "com.amazonaws.wafv2#RateLimitQueryString", - "traits": { - "smithy.api#documentation": "

Use the request's query string as an aggregate key. Each distinct string contributes to the aggregation instance. If you use just the \n query string as your custom key, then each string fully defines an aggregation instance.

" - } - }, - "HTTPMethod": { - "target": "com.amazonaws.wafv2#RateLimitHTTPMethod", - "traits": { - "smithy.api#documentation": "

Use the request's HTTP method as an aggregate key. Each distinct HTTP method contributes to the aggregation instance. If you use just the HTTP method\n as your custom key, then each method fully defines an aggregation instance.

" - } - }, - "ForwardedIP": { - "target": "com.amazonaws.wafv2#RateLimitForwardedIP", - "traits": { - "smithy.api#documentation": "

Use the first IP address in an HTTP header as an aggregate key. Each distinct forwarded IP address contributes to the aggregation instance.

\n

When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use.\n You can aggregate on only the forwarded IP address by specifying FORWARDED_IP in your rate-based statement's AggregateKeyType.

\n

With this option, you must specify the header to use in the rate-based rule's ForwardedIPConfig property.

" - } - }, - "IP": { - "target": "com.amazonaws.wafv2#RateLimitIP", - "traits": { - "smithy.api#documentation": "

Use the request's originating IP address as an aggregate key. Each distinct IP address contributes to the aggregation instance.

\n

When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use.\n You can aggregate on only the IP address by specifying IP in your rate-based statement's AggregateKeyType.

" - } - }, - "LabelNamespace": { - "target": "com.amazonaws.wafv2#RateLimitLabelNamespace", - "traits": { - "smithy.api#documentation": "

Use the specified label namespace as an aggregate key. Each distinct fully qualified label name that has the specified label namespace contributes to the aggregation instance. If you use just one label namespace as your custom key, then each label name fully defines an aggregation instance.

\n

This uses only labels that have been added to the request by rules that are evaluated before this rate-based rule in the web ACL.

\n

For information about label namespaces and names, see \n Label syntax and naming requirements in the WAF Developer Guide.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies a single custom aggregate key for a rate-base rule.

\n \n

Web requests that are missing any of the components specified in the aggregation keys\n are omitted from the rate-based rule evaluation and handling.

\n " - } - }, - "com.amazonaws.wafv2#RateBasedStatementCustomKeys": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#RateBasedStatementCustomKey" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.wafv2#RateBasedStatementManagedKeysIPSet": { - "type": "structure", - "members": { - "IPAddressVersion": { - "target": "com.amazonaws.wafv2#IPAddressVersion", - "traits": { - "smithy.api#documentation": "

The version of the IP addresses, either IPV4 or IPV6.

" - } - }, - "Addresses": { - "target": "com.amazonaws.wafv2#IPAddresses", - "traits": { - "smithy.api#documentation": "

The IP addresses that are currently blocked.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The set of IP addresses that are currently blocked for a RateBasedStatement. This is only available for rate-based rules \n that aggregate on just the IP address, with the AggregateKeyType set to IP or FORWARDED_IP.

\n

A rate-based rule applies its rule action to requests from IP addresses that are in the rule's managed keys list and that match the rule's scope-down statement. When a rule has no scope-down statement, it applies the action to all requests from the IP addresses that are in the list. The rule applies its rule action to rate limit the matching requests. The action is usually Block but it can be any valid rule action except for Allow.

\n

The maximum number of IP addresses that can be rate limited by a single rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, WAF limits those with the highest rates.

" - } - }, - "com.amazonaws.wafv2#RateLimit": { - "type": "long", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 100, - "max": 2000000000 - } - } - }, - "com.amazonaws.wafv2#RateLimitCookie": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#FieldToMatchData", - "traits": { - "smithy.api#documentation": "

The name of the cookie to use.

", - "smithy.api#required": {} - } - }, - "TextTransformations": { - "target": "com.amazonaws.wafv2#TextTransformations", - "traits": { - "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies a cookie as an aggregate key for a rate-based rule. Each distinct value in the cookie contributes to the aggregation instance. If you use a single\n cookie as your custom key, then each value fully defines an aggregation instance.

" - } - }, - "com.amazonaws.wafv2#RateLimitForwardedIP": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

Specifies the first IP address in an HTTP header as an aggregate key for a rate-based rule. Each distinct forwarded IP address contributes to the aggregation instance.

\n

This setting is used only in the RateBasedStatementCustomKey specification of a rate-based rule statement.\n When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use.\n You can aggregate on only the forwarded IP address by specifying FORWARDED_IP in your rate-based statement's AggregateKeyType.

\n

This data type supports using the forwarded IP address in the web request aggregation for a rate-based rule, in RateBasedStatementCustomKey. The JSON specification for using the forwarded IP address doesn't explicitly use this data type.

\n

JSON specification: \"ForwardedIP\": {}\n

\n

When you use this specification, you must also configure the forwarded IP address in the rate-based statement's ForwardedIPConfig.

" - } - }, - "com.amazonaws.wafv2#RateLimitHTTPMethod": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

Specifies the request's HTTP method as an aggregate key for a rate-based rule. Each distinct HTTP method contributes to the aggregation instance. If you use just the HTTP method\n as your custom key, then each method fully defines an aggregation instance.

\n

JSON specification: \"RateLimitHTTPMethod\": {}\n

" - } - }, - "com.amazonaws.wafv2#RateLimitHeader": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#FieldToMatchData", - "traits": { - "smithy.api#documentation": "

The name of the header to use.

", - "smithy.api#required": {} - } - }, - "TextTransformations": { - "target": "com.amazonaws.wafv2#TextTransformations", - "traits": { - "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies a header as an aggregate key for a rate-based rule. Each distinct value in the header contributes to the aggregation instance. If you use a single \n header as your custom key, then each value fully defines an aggregation instance.

" - } - }, - "com.amazonaws.wafv2#RateLimitIP": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

Specifies the IP address in the web request as an aggregate key for a rate-based rule. Each distinct IP address contributes to the aggregation instance.

\n

This setting is used only in the RateBasedStatementCustomKey specification of a rate-based rule statement.\n To use this in the custom key settings, you must specify at least one other key to use, along with the IP address. \n To aggregate on only the IP address, in your rate-based statement's AggregateKeyType, specify IP.

\n

JSON specification: \"RateLimitIP\": {}\n

" - } - }, - "com.amazonaws.wafv2#RateLimitLabelNamespace": { - "type": "structure", - "members": { - "Namespace": { - "target": "com.amazonaws.wafv2#LabelNamespace", - "traits": { - "smithy.api#documentation": "

The namespace to use for aggregation.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies a label namespace to use as an aggregate key for a rate-based rule. Each distinct fully qualified label name that has the specified label namespace contributes to the aggregation instance. If you use just one label namespace as your custom key, then each label name fully defines an aggregation instance.

\n

This uses only labels that have been added to the request by rules that are evaluated before this rate-based rule in the web ACL.

\n

For information about label namespaces and names, see \n Label syntax and naming requirements in the WAF Developer Guide.

" - } - }, - "com.amazonaws.wafv2#RateLimitQueryArgument": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#FieldToMatchData", - "traits": { - "smithy.api#documentation": "

The name of the query argument to use.

", - "smithy.api#required": {} - } - }, - "TextTransformations": { - "target": "com.amazonaws.wafv2#TextTransformations", - "traits": { - "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies a query argument in the request as an aggregate key for a rate-based rule. Each distinct value for the named query argument contributes to the aggregation instance. If you \n use a single query argument as your custom key, then each value fully defines an aggregation instance.

" - } - }, - "com.amazonaws.wafv2#RateLimitQueryString": { - "type": "structure", - "members": { - "TextTransformations": { - "target": "com.amazonaws.wafv2#TextTransformations", - "traits": { - "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the request's query string as an aggregate key for a rate-based rule. Each distinct string contributes to the aggregation instance. If you use just the \n query string as your custom key, then each string fully defines an aggregation instance.

" - } - }, - "com.amazonaws.wafv2#RedactedFields": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#FieldToMatch" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.wafv2#Regex": { - "type": "structure", - "members": { - "RegexString": { - "target": "com.amazonaws.wafv2#RegexPatternString", - "traits": { - "smithy.api#documentation": "

The string representing the regular expression.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A single regular expression. This is used in a RegexPatternSet.

" - } - }, - "com.amazonaws.wafv2#RegexMatchStatement": { - "type": "structure", - "members": { - "RegexString": { - "target": "com.amazonaws.wafv2#RegexPatternString", - "traits": { - "smithy.api#documentation": "

The string representing the regular expression.

", - "smithy.api#required": {} - } - }, - "FieldToMatch": { - "target": "com.amazonaws.wafv2#FieldToMatch", - "traits": { - "smithy.api#documentation": "

The part of the web request that you want WAF to inspect.

", - "smithy.api#required": {} - } - }, - "TextTransformations": { - "target": "com.amazonaws.wafv2#TextTransformations", - "traits": { - "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A rule statement used to search web request components for a match against a single regular expression.

" - } - }, - "com.amazonaws.wafv2#RegexPatternSet": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the set. You cannot change the name after you create the set.

" - } - }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

" - } - }, - "ARN": { - "target": "com.amazonaws.wafv2#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entity.

" - } - }, - "Description": { - "target": "com.amazonaws.wafv2#EntityDescription", - "traits": { - "smithy.api#documentation": "

A description of the set that helps with identification.

" - } - }, - "RegularExpressionList": { - "target": "com.amazonaws.wafv2#RegularExpressionList", - "traits": { - "smithy.api#documentation": "

The regular expression patterns in the set.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains one or more regular expressions.

\n

WAF assigns an ARN to each RegexPatternSet that you create. To use a\n set in a rule, you provide the ARN to the Rule statement RegexPatternSetReferenceStatement.

" - } - }, - "com.amazonaws.wafv2#RegexPatternSetReferenceStatement": { - "type": "structure", - "members": { - "ARN": { - "target": "com.amazonaws.wafv2#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the RegexPatternSet that this\n statement references.

", - "smithy.api#required": {} - } - }, - "FieldToMatch": { - "target": "com.amazonaws.wafv2#FieldToMatch", - "traits": { - "smithy.api#documentation": "

The part of the web request that you want WAF to inspect.

", - "smithy.api#required": {} - } - }, - "TextTransformations": { - "target": "com.amazonaws.wafv2#TextTransformations", - "traits": { - "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.

\n

Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

" - } - }, - "com.amazonaws.wafv2#RegexPatternSetSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#RegexPatternSetSummary" - } - }, - "com.amazonaws.wafv2#RegexPatternSetSummary": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the data type instance. You cannot change the name after you create the instance.

" - } - }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

" - } - }, - "Description": { - "target": "com.amazonaws.wafv2#EntityDescription", - "traits": { - "smithy.api#documentation": "

A description of the set that helps with identification.

" - } - }, - "LockToken": { - "target": "com.amazonaws.wafv2#LockToken", - "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" - } - }, - "ARN": { - "target": "com.amazonaws.wafv2#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entity.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

High-level information about a RegexPatternSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RegexPatternSet, and the ARN, that you provide to the RegexPatternSetReferenceStatement to use the pattern set in a Rule.

" - } - }, - "com.amazonaws.wafv2#RegexPatternString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.wafv2#RegularExpressionList": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#Regex" - } - }, - "com.amazonaws.wafv2#ReleaseNotes": { - "type": "string" - }, - "com.amazonaws.wafv2#ReleaseSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#ReleaseSummary" - } - }, - "com.amazonaws.wafv2#ReleaseSummary": { - "type": "structure", - "members": { - "ReleaseVersion": { - "target": "com.amazonaws.wafv2#VersionKeyString", - "traits": { - "smithy.api#documentation": "

The release version.

" - } - }, - "Timestamp": { - "target": "com.amazonaws.wafv2#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp of the release.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

High level information for an SDK release.

" - } - }, - "com.amazonaws.wafv2#RequestBody": { - "type": "map", - "key": { - "target": "com.amazonaws.wafv2#AssociatedResourceType" - }, - "value": { - "target": "com.amazonaws.wafv2#RequestBodyAssociatedResourceTypeConfig" - } - }, - "com.amazonaws.wafv2#RequestBodyAssociatedResourceTypeConfig": { - "type": "structure", - "members": { - "DefaultSizeInspectionLimit": { - "target": "com.amazonaws.wafv2#SizeInspectionLimit", - "traits": { - "smithy.api#documentation": "

Specifies the maximum size of the web request body component that an associated CloudFront distribution should send to WAF for inspection. This applies to statements in the web ACL that inspect the body or JSON body.

\n

Default: 16 KB (16,384 kilobytes)\n

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Customizes the maximum size of the request body that your protected CloudFront distributions forward to WAF for inspection. The default size is 16 KB (16,384 kilobytes).

\n \n

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

\n \n

This is used in the AssociationConfig of the web ACL.

" - } - }, - "com.amazonaws.wafv2#RequestInspection": { - "type": "structure", - "members": { - "PayloadType": { - "target": "com.amazonaws.wafv2#PayloadType", - "traits": { - "smithy.api#documentation": "

The payload type for your login endpoint, either JSON or form encoded.

", - "smithy.api#required": {} - } - }, - "UsernameField": { - "target": "com.amazonaws.wafv2#UsernameField", - "traits": { - "smithy.api#documentation": "

Details about your login page username field.

\n

How you specify this depends on the payload type.

\n ", - "smithy.api#required": {} - } - }, - "PasswordField": { - "target": "com.amazonaws.wafv2#PasswordField", - "traits": { - "smithy.api#documentation": "

Details about your login page password field.

\n

How you specify this depends on the payload type.

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage.

\n

This is part of the AWSManagedRulesATPRuleSet configuration in ManagedRuleGroupConfig.

\n

In these settings, you specify how your application accepts login attempts\n by providing the request payload type and the names of the fields \n within the request body where the username and password are provided.

" - } - }, - "com.amazonaws.wafv2#ResourceArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.wafv2#ResourceArns": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#ResourceArn" - } - }, - "com.amazonaws.wafv2#ResourceType": { - "type": "enum", - "members": { - "APPLICATION_LOAD_BALANCER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "APPLICATION_LOAD_BALANCER" - } - }, - "API_GATEWAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "API_GATEWAY" - } - }, - "APPSYNC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "APPSYNC" - } - }, - "COGNITIO_USER_POOL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COGNITO_USER_POOL" - } - }, - "APP_RUNNER_SERVICE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "APP_RUNNER_SERVICE" - } - }, - "VERIFIED_ACCESS_INSTANCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VERIFIED_ACCESS_INSTANCE" - } - } - } - }, - "com.amazonaws.wafv2#ResponseCode": { - "type": "integer" - }, - "com.amazonaws.wafv2#ResponseContent": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10240 - }, - "smithy.api#pattern": "^[\\s\\S]*$" - } - }, - "com.amazonaws.wafv2#ResponseContentType": { - "type": "enum", - "members": { - "TEXT_PLAIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TEXT_PLAIN" - } - }, - "TEXT_HTML": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TEXT_HTML" - } - }, - "APPLICATION_JSON": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "APPLICATION_JSON" - } - } - } - }, - "com.amazonaws.wafv2#ResponseInspection": { - "type": "structure", - "members": { - "StatusCode": { - "target": "com.amazonaws.wafv2#ResponseInspectionStatusCode", - "traits": { - "smithy.api#documentation": "

Configures inspection of the response status code.

" - } - }, - "Header": { - "target": "com.amazonaws.wafv2#ResponseInspectionHeader", - "traits": { - "smithy.api#documentation": "

Configures inspection of the response header.

" - } - }, - "BodyContains": { - "target": "com.amazonaws.wafv2#ResponseInspectionBodyContains", - "traits": { - "smithy.api#documentation": "

Configures inspection of the response body. WAF can inspect the first 65,536 bytes (64 KB) of the response body.

" - } - }, - "Json": { - "target": "com.amazonaws.wafv2#ResponseInspectionJson", - "traits": { - "smithy.api#documentation": "

Configures inspection of the response JSON. WAF can inspect the first 65,536 bytes (64 KB) of the response JSON.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The criteria for inspecting responses to login requests, used by the ATP rule group to track login failure rates.

\n

The ATP rule group evaluates the responses that your protected resources send back to client login attempts, keeping count of successful and failed attempts from each IP address and client session. Using this information, the rule group labels \n and mitigates requests from client sessions and IP addresses that submit too many failed login attempts in a short amount of time.

\n \n

Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

\n \n

This is part of the AWSManagedRulesATPRuleSet configuration in ManagedRuleGroupConfig.

\n

Enable login response inspection by configuring exactly one component of the response to inspect. You can't configure more than one. If you don't configure any of the response inspection options, response inspection is disabled.

" - } - }, - "com.amazonaws.wafv2#ResponseInspectionBodyContains": { - "type": "structure", - "members": { - "SuccessStrings": { - "target": "com.amazonaws.wafv2#ResponseInspectionBodyContainsSuccessStrings", - "traits": { - "smithy.api#documentation": "

Strings in the body of the response that indicate a successful login attempt. To be counted as a successful login, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings.

\n

JSON example: \"SuccessStrings\": [ \"Login successful\", \"Welcome to our site!\" ]\n

", - "smithy.api#required": {} - } - }, - "FailureStrings": { - "target": "com.amazonaws.wafv2#ResponseInspectionBodyContainsFailureStrings", - "traits": { - "smithy.api#documentation": "

Strings in the body of the response that indicate a failed login attempt. To be counted as a failed login, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings.

\n

JSON example: \"FailureStrings\": [ \"Login failed\" ]\n

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Configures inspection of the response body. WAF can inspect the first 65,536 bytes (64 KB) of the response body. This is part of the ResponseInspection configuration for AWSManagedRulesATPRuleSet.

\n \n

Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

\n " - } - }, - "com.amazonaws.wafv2#ResponseInspectionBodyContainsFailureStrings": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#FailureValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.wafv2#ResponseInspectionBodyContainsSuccessStrings": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#SuccessValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.wafv2#ResponseInspectionHeader": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#ResponseInspectionHeaderName", - "traits": { - "smithy.api#documentation": "

The name of the header to match against. The name must be an exact match, including case.

\n

JSON example: \"Name\": [ \"LoginResult\" ]\n

", - "smithy.api#required": {} - } - }, - "SuccessValues": { - "target": "com.amazonaws.wafv2#ResponseInspectionHeaderSuccessValues", - "traits": { - "smithy.api#documentation": "

Values in the response header with the specified name that indicate a successful login attempt. To be counted as a successful login, the value must be an exact match, including case. Each value must be unique among the success and failure values.

\n

JSON example: \"SuccessValues\": [ \"LoginPassed\", \"Successful login\" ]\n

", - "smithy.api#required": {} - } - }, - "FailureValues": { - "target": "com.amazonaws.wafv2#ResponseInspectionHeaderFailureValues", - "traits": { - "smithy.api#documentation": "

Values in the response header with the specified name that indicate a failed login attempt. To be counted as a failed login, the value must be an exact match, including case. Each value must be unique among the success and failure values.

\n

JSON example: \"FailureValues\": [ \"LoginFailed\", \"Failed login\" ]\n

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Configures inspection of the response header. This is part of the ResponseInspection configuration for AWSManagedRulesATPRuleSet.

\n \n

Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

\n " - } - }, - "com.amazonaws.wafv2#ResponseInspectionHeaderFailureValues": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#FailureValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 3 - } - } - }, - "com.amazonaws.wafv2#ResponseInspectionHeaderName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.wafv2#ResponseInspectionHeaderSuccessValues": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#SuccessValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 3 - } - } - }, - "com.amazonaws.wafv2#ResponseInspectionJson": { - "type": "structure", - "members": { - "Identifier": { - "target": "com.amazonaws.wafv2#FieldIdentifier", - "traits": { - "smithy.api#documentation": "

The identifier for the value to match against in the JSON. The identifier must be an exact match, including case.

\n

JSON example: \"Identifier\": [ \"/login/success\" ]\n

", - "smithy.api#required": {} - } - }, - "SuccessValues": { - "target": "com.amazonaws.wafv2#ResponseInspectionJsonSuccessValues", - "traits": { - "smithy.api#documentation": "

Values for the specified identifier in the response JSON that indicate a successful login attempt. To be counted as a successful login, the value must be an exact match, including case. Each value must be unique among the success and failure values.

\n

JSON example: \"SuccessValues\": [ \"True\", \"Succeeded\" ]\n

", - "smithy.api#required": {} - } - }, - "FailureValues": { - "target": "com.amazonaws.wafv2#ResponseInspectionJsonFailureValues", - "traits": { - "smithy.api#documentation": "

Values for the specified identifier in the response JSON that indicate a failed login attempt. To be counted as a failed login, the value must be an exact match, including case. Each value must be unique among the success and failure values.

\n

JSON example: \"FailureValues\": [ \"False\", \"Failed\" ]\n

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Configures inspection of the response JSON. WAF can inspect the first 65,536 bytes (64 KB) of the response JSON. This is part of the ResponseInspection configuration for AWSManagedRulesATPRuleSet.

\n \n

Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

\n " - } - }, - "com.amazonaws.wafv2#ResponseInspectionJsonFailureValues": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#FailureValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.wafv2#ResponseInspectionJsonSuccessValues": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#SuccessValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.wafv2#ResponseInspectionStatusCode": { - "type": "structure", - "members": { - "SuccessCodes": { - "target": "com.amazonaws.wafv2#ResponseInspectionStatusCodeSuccessCodes", - "traits": { - "smithy.api#documentation": "

Status codes in the response that indicate a successful login attempt. To be counted as a successful login, the response status code must match one of these. Each code must be unique among the success and failure status codes.

\n

JSON example: \"SuccessCodes\": [ 200, 201 ]\n

", - "smithy.api#required": {} - } - }, - "FailureCodes": { - "target": "com.amazonaws.wafv2#ResponseInspectionStatusCodeFailureCodes", - "traits": { - "smithy.api#documentation": "

Status codes in the response that indicate a failed login attempt. To be counted as a failed login, the response status code must match one of these. Each code must be unique among the success and failure status codes.

\n

JSON example: \"FailureCodes\": [ 400, 404 ]\n

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Configures inspection of the response status code. This is part of the ResponseInspection configuration for AWSManagedRulesATPRuleSet.

\n \n

Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

\n " - } - }, - "com.amazonaws.wafv2#ResponseInspectionStatusCodeFailureCodes": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#FailureCode" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.wafv2#ResponseInspectionStatusCodeSuccessCodes": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#SuccessCode" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.wafv2#ResponseStatusCode": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 200, - "max": 599 - } - } - }, - "com.amazonaws.wafv2#Rule": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the rule. You can't change the name of a Rule after you create\n it.

", - "smithy.api#required": {} - } - }, - "Priority": { - "target": "com.amazonaws.wafv2#RulePriority", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

If you define more than one Rule in a WebACL, WAF\n evaluates each request against the Rules in order based on the value of\n Priority. WAF processes rules with lower priority first. The priorities\n don't need to be consecutive, but they must all be different.

", - "smithy.api#required": {} - } - }, - "Statement": { - "target": "com.amazonaws.wafv2#Statement", - "traits": { - "smithy.api#documentation": "

The WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement.

", - "smithy.api#required": {} - } - }, - "Action": { - "target": "com.amazonaws.wafv2#RuleAction", - "traits": { - "smithy.api#documentation": "

The action that WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting.

\n

This is used only for rules whose statements do not reference a rule group. Rule statements that reference a rule group include RuleGroupReferenceStatement and ManagedRuleGroupStatement.

\n

You must specify either this Action setting or the rule OverrideAction setting, but not both:

\n " - } - }, - "OverrideAction": { - "target": "com.amazonaws.wafv2#OverrideAction", - "traits": { - "smithy.api#documentation": "

The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.

\n

You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

\n \n

This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count \n matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings.

\n " - } - }, - "RuleLabels": { - "target": "com.amazonaws.wafv2#Labels", - "traits": { - "smithy.api#documentation": "

Labels to apply to web requests that match the rule match statement. WAF applies\n fully qualified labels to matching web requests. A fully qualified label is the\n concatenation of a label namespace and a rule label. The rule's rule group or web ACL\n defines the label namespace.

\n

Rules that run after this rule in the web ACL can match against these labels using a\n LabelMatchStatement.

\n

For each label, provide a case-sensitive string containing optional namespaces and a\n label name, according to the following guidelines:

\n \n

For example, myLabelName or nameSpace1:nameSpace2:myLabelName.\n

" - } - }, - "VisibilityConfig": { - "target": "com.amazonaws.wafv2#VisibilityConfig", - "traits": { - "smithy.api#documentation": "

Defines and enables Amazon CloudWatch metrics and web request sample collection.

", - "smithy.api#required": {} - } - }, - "CaptchaConfig": { - "target": "com.amazonaws.wafv2#CaptchaConfig", - "traits": { - "smithy.api#documentation": "

Specifies how WAF should handle CAPTCHA evaluations. If you don't specify this, WAF uses the CAPTCHA configuration that's defined for the web ACL.

" - } - }, - "ChallengeConfig": { - "target": "com.amazonaws.wafv2#ChallengeConfig", - "traits": { - "smithy.api#documentation": "

Specifies how WAF should handle Challenge evaluations. If you don't specify this, WAF uses the challenge configuration that's defined for the web ACL.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A single rule, which you can use in a WebACL or RuleGroup to identify web requests that you want to allow, block, or count.\n Each rule includes one top-level Statement that WAF uses to\n identify matching web requests, and parameters that govern how WAF handles them.

" - } - }, - "com.amazonaws.wafv2#RuleAction": { - "type": "structure", - "members": { - "Block": { - "target": "com.amazonaws.wafv2#BlockAction", - "traits": { - "smithy.api#documentation": "

Instructs WAF to block the web request.

" - } - }, - "Allow": { - "target": "com.amazonaws.wafv2#AllowAction", - "traits": { - "smithy.api#documentation": "

Instructs WAF to allow the web request.

" - } - }, - "Count": { - "target": "com.amazonaws.wafv2#CountAction", - "traits": { - "smithy.api#documentation": "

Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.

" - } - }, - "Captcha": { - "target": "com.amazonaws.wafv2#CaptchaAction", - "traits": { - "smithy.api#documentation": "

Instructs WAF to run a CAPTCHA check against the web request.

" - } - }, - "Challenge": { - "target": "com.amazonaws.wafv2#ChallengeAction", - "traits": { - "smithy.api#documentation": "

Instructs WAF to run a Challenge check against the web request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The action that WAF should take on a web request when it matches a rule's\n statement. Settings at the web ACL level can override the rule action setting.

" - } - }, - "com.amazonaws.wafv2#RuleActionOverride": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the rule to override.

", - "smithy.api#required": {} - } - }, - "ActionToUse": { - "target": "com.amazonaws.wafv2#RuleAction", - "traits": { - "smithy.api#documentation": "

The override action to use, in place of the configured action of the rule in the rule group.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Action setting to use in the place of a rule action that is configured inside the rule group. You specify one override for each rule whose action you want to change.

\n

You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

" - } - }, - "com.amazonaws.wafv2#RuleActionOverrides": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#RuleActionOverride" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.wafv2#RuleGroup": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the rule group. You cannot change the name of a rule group after you create it.

", - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", - "smithy.api#required": {} - } - }, - "Capacity": { - "target": "com.amazonaws.wafv2#CapacityUnit", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The web ACL capacity units (WCUs) required for this rule group.

\n

When you create your own rule group, you define this, and you cannot change it after creation. \n When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity \n for a set of rules using CheckCapacity.

\n

WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) \n in the WAF Developer Guide.

", - "smithy.api#required": {} - } - }, - "ARN": { - "target": "com.amazonaws.wafv2#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entity.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.wafv2#EntityDescription", - "traits": { - "smithy.api#documentation": "

A description of the rule group that helps with identification.

" - } - }, - "Rules": { - "target": "com.amazonaws.wafv2#Rules", - "traits": { - "smithy.api#documentation": "

The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n

" - } - }, - "VisibilityConfig": { - "target": "com.amazonaws.wafv2#VisibilityConfig", - "traits": { - "smithy.api#documentation": "

Defines and enables Amazon CloudWatch metrics and web request sample collection.

", - "smithy.api#required": {} - } - }, - "LabelNamespace": { - "target": "com.amazonaws.wafv2#LabelName", - "traits": { - "smithy.api#documentation": "

The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.

\n " - } - }, - "CustomResponseBodies": { - "target": "com.amazonaws.wafv2#CustomResponseBodies", - "traits": { - "smithy.api#documentation": "

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas \n in the WAF Developer Guide.

" - } - }, - "AvailableLabels": { - "target": "com.amazonaws.wafv2#LabelSummaries", - "traits": { - "smithy.api#documentation": "

The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the RuleLabels for a Rule.

" - } - }, - "ConsumedLabels": { - "target": "com.amazonaws.wafv2#LabelSummaries", - "traits": { - "smithy.api#documentation": "

The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

" - } - }, - "com.amazonaws.wafv2#RuleGroupReferenceStatement": { - "type": "structure", - "members": { - "ARN": { - "target": "com.amazonaws.wafv2#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entity.

", - "smithy.api#required": {} - } - }, - "ExcludedRules": { - "target": "com.amazonaws.wafv2#ExcludedRules", - "traits": { - "smithy.api#documentation": "

Rules in the referenced rule group whose actions are set to Count.

\n \n

Instead of this option, use RuleActionOverrides. It accepts any valid action setting, including Count.

\n " - } - }, - "RuleActionOverrides": { - "target": "com.amazonaws.wafv2#RuleActionOverrides", - "traits": { - "smithy.api#documentation": "

Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.

\n

You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.

\n

You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. You \n can only use a rule group reference statement at the top level inside a web ACL.

" - } - }, - "com.amazonaws.wafv2#RuleGroupSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#RuleGroupSummary" - } - }, - "com.amazonaws.wafv2#RuleGroupSummary": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the data type instance. You cannot change the name after you create the instance.

" - } - }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

" - } - }, - "Description": { - "target": "com.amazonaws.wafv2#EntityDescription", - "traits": { - "smithy.api#documentation": "

A description of the rule group that helps with identification.

" - } - }, - "LockToken": { - "target": "com.amazonaws.wafv2#LockToken", - "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" - } - }, - "ARN": { - "target": "com.amazonaws.wafv2#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entity.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

High-level information about a RuleGroup, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RuleGroup, and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule.

" - } - }, - "com.amazonaws.wafv2#RulePriority": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.wafv2#RuleSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#RuleSummary" - } - }, - "com.amazonaws.wafv2#RuleSummary": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the rule.

" - } - }, - "Action": { - "target": "com.amazonaws.wafv2#RuleAction", - "traits": { - "smithy.api#documentation": "

The action that WAF should take on a web request when it matches a rule's\n statement. Settings at the web ACL level can override the rule action setting.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

High-level information about a Rule, returned by operations like DescribeManagedRuleGroup. This provides information like the ID, that you can use to retrieve and manage a RuleGroup, and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule.

" - } - }, - "com.amazonaws.wafv2#Rules": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#Rule" - } - }, - "com.amazonaws.wafv2#SampleWeight": { - "type": "long", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.wafv2#SampledHTTPRequest": { - "type": "structure", - "members": { - "Request": { - "target": "com.amazonaws.wafv2#HTTPRequest", - "traits": { - "smithy.api#documentation": "

A complex type that contains detailed information about the request.

", - "smithy.api#required": {} - } - }, - "Weight": { - "target": "com.amazonaws.wafv2#SampleWeight", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

A value that indicates how one result in the response relates proportionally to other\n results in the response. For example, a result that has a weight of 2\n represents roughly twice as many web requests as a result that has a weight of\n 1.

", - "smithy.api#required": {} - } - }, - "Timestamp": { - "target": "com.amazonaws.wafv2#Timestamp", - "traits": { - "smithy.api#documentation": "

The time at which WAF received the request from your Amazon Web Services resource, in Unix time\n format (in seconds).

" - } - }, - "Action": { - "target": "com.amazonaws.wafv2#Action", - "traits": { - "smithy.api#documentation": "

The action that WAF applied to the request.

" - } - }, - "RuleNameWithinRuleGroup": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the Rule that the request matched. For managed rule groups, the\n format for this name is ##. For your own rule groups, the format for this name is #. If the rule is not in a rule group, this field\n is absent.

" - } - }, - "RequestHeadersInserted": { - "target": "com.amazonaws.wafv2#HTTPHeaders", - "traits": { - "smithy.api#documentation": "

Custom request headers inserted by WAF into the request, according to the custom\n request configuration for the matching rule action.

" - } - }, - "ResponseCodeSent": { - "target": "com.amazonaws.wafv2#ResponseStatusCode", - "traits": { - "smithy.api#documentation": "

The response code that was sent for the request.

" - } - }, - "Labels": { - "target": "com.amazonaws.wafv2#Labels", - "traits": { - "smithy.api#documentation": "

Labels applied to the web request by matching rules. WAF applies fully qualified\n labels to matching web requests. A fully qualified label is the concatenation of a label\n namespace and a rule label. The rule's rule group or web ACL defines the label namespace.

\n

For example,\n awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or\n awswaf:managed:aws:managed-rule-set:header:encoding:utf8.

" - } - }, - "CaptchaResponse": { - "target": "com.amazonaws.wafv2#CaptchaResponse", - "traits": { - "smithy.api#documentation": "

The CAPTCHA response for the request.

" - } - }, - "ChallengeResponse": { - "target": "com.amazonaws.wafv2#ChallengeResponse", - "traits": { - "smithy.api#documentation": "

The Challenge response for the request.

" - } - }, - "OverriddenAction": { - "target": "com.amazonaws.wafv2#Action", - "traits": { - "smithy.api#documentation": "

Used only for rule group rules that have a rule action override in place in the web ACL. This is the action that the rule group rule is configured for, and not the action that was applied to the request. The action that WAF applied is the Action value.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents a single sampled web request. The response from GetSampledRequests includes a SampledHTTPRequests complex type\n that appears as SampledRequests in the response syntax.\n SampledHTTPRequests contains an array of SampledHTTPRequest\n objects.

" - } - }, - "com.amazonaws.wafv2#SampledHTTPRequests": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#SampledHTTPRequest" - } - }, - "com.amazonaws.wafv2#Scope": { - "type": "enum", - "members": { - "CLOUDFRONT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CLOUDFRONT" - } - }, - "REGIONAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REGIONAL" - } - } - } - }, - "com.amazonaws.wafv2#SearchString": { - "type": "blob" - }, - "com.amazonaws.wafv2#SensitivityLevel": { - "type": "enum", - "members": { - "LOW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LOW" - } - }, - "HIGH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HIGH" - } - } - } - }, - "com.amazonaws.wafv2#SingleCookieName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 60 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.wafv2#SingleHeader": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#FieldToMatchData", - "traits": { - "smithy.api#documentation": "

The name of the query header to inspect.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Inspect one of the headers in the web request, identified by name, for example,\n User-Agent or Referer. The name isn't case sensitive.

\n

You can filter and inspect all headers with the FieldToMatch setting\n Headers.

\n

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

\n

Example JSON: \"SingleHeader\": { \"Name\": \"haystack\" }\n

" - } - }, - "com.amazonaws.wafv2#SingleQueryArgument": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#FieldToMatchData", - "traits": { - "smithy.api#documentation": "

The name of the query argument to inspect.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Inspect one query argument in the web request, identified by name, for example\n UserName or SalesRegion. The name isn't case\n sensitive.

\n

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

\n

Example JSON: \"SingleQueryArgument\": { \"Name\": \"myArgument\" }\n

" - } - }, - "com.amazonaws.wafv2#Size": { - "type": "long", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 21474836480 - } - } - }, - "com.amazonaws.wafv2#SizeConstraintStatement": { - "type": "structure", - "members": { - "FieldToMatch": { - "target": "com.amazonaws.wafv2#FieldToMatch", - "traits": { - "smithy.api#documentation": "

The part of the web request that you want WAF to inspect.

", - "smithy.api#required": {} - } - }, - "ComparisonOperator": { - "target": "com.amazonaws.wafv2#ComparisonOperator", - "traits": { - "smithy.api#documentation": "

The operator to use to compare the request part to the size setting.

", - "smithy.api#required": {} - } - }, - "Size": { - "target": "com.amazonaws.wafv2#Size", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The size, in byte, to compare to the request part, after any transformations.

", - "smithy.api#required": {} - } - }, - "TextTransformations": { - "target": "com.amazonaws.wafv2#TextTransformations", - "traits": { - "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.

\n

If you configure WAF to inspect the request body, WAF inspects only the number of bytes of the body up to the limit for the web ACL. By default, for regional web ACLs, this limit is 8 KB (8,192 kilobytes) and for CloudFront web ACLs, this limit is 16 KB (16,384 kilobytes). For CloudFront web ACLs, you can increase the limit in the web ACL AssociationConfig, for additional fees. If you know that the request body for your web requests should never exceed the inspection limit, you could use a size constraint statement to block requests that have a larger request body size.

\n

If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.

" - } - }, - "com.amazonaws.wafv2#SizeInspectionLimit": { - "type": "enum", - "members": { - "KB_16": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KB_16" - } - }, - "KB_32": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KB_32" - } - }, - "KB_48": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KB_48" - } - }, - "KB_64": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KB_64" - } - } - } - }, - "com.amazonaws.wafv2#SolveTimestamp": { - "type": "long" - }, - "com.amazonaws.wafv2#SqliMatchStatement": { - "type": "structure", - "members": { - "FieldToMatch": { - "target": "com.amazonaws.wafv2#FieldToMatch", - "traits": { - "smithy.api#documentation": "

The part of the web request that you want WAF to inspect.

", - "smithy.api#required": {} - } - }, - "TextTransformations": { - "target": "com.amazonaws.wafv2#TextTransformations", - "traits": { - "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.

", - "smithy.api#required": {} - } - }, - "SensitivityLevel": { - "target": "com.amazonaws.wafv2#SensitivityLevel", - "traits": { - "smithy.api#documentation": "

The sensitivity that you want WAF to use to inspect for SQL injection attacks.

\n

\n HIGH detects more attacks, but might generate more false positives, \n especially if your web requests frequently contain unusual strings. \n For information about identifying and mitigating false positives, see \n Testing and tuning in the \n WAF Developer Guide.

\n

\n LOW is generally a better choice for resources that already have other \n protections against SQL injection attacks or that have a low tolerance for false positives.

\n

Default: LOW\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A rule statement that inspects for malicious SQL code. Attackers insert malicious SQL code into web requests to do things like modify your database or extract data from it.

" - } - }, - "com.amazonaws.wafv2#Statement": { - "type": "structure", - "members": { - "ByteMatchStatement": { - "target": "com.amazonaws.wafv2#ByteMatchStatement", - "traits": { - "smithy.api#documentation": "

A rule statement that defines a string match search for WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the WAF console and the developer guide, this is called a string match statement.

" - } - }, - "SqliMatchStatement": { - "target": "com.amazonaws.wafv2#SqliMatchStatement", - "traits": { - "smithy.api#documentation": "

A rule statement that inspects for malicious SQL code. Attackers insert malicious SQL code into web requests to do things like modify your database or extract data from it.

" - } - }, - "XssMatchStatement": { - "target": "com.amazonaws.wafv2#XssMatchStatement", - "traits": { - "smithy.api#documentation": "

A rule statement that inspects for cross-site scripting (XSS) attacks. In XSS attacks, the attacker \nuses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers.

" - } - }, - "SizeConstraintStatement": { - "target": "com.amazonaws.wafv2#SizeConstraintStatement", - "traits": { - "smithy.api#documentation": "

A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.

\n

If you configure WAF to inspect the request body, WAF inspects only the number of bytes of the body up to the limit for the web ACL. By default, for regional web ACLs, this limit is 8 KB (8,192 kilobytes) and for CloudFront web ACLs, this limit is 16 KB (16,384 kilobytes). For CloudFront web ACLs, you can increase the limit in the web ACL AssociationConfig, for additional fees. If you know that the request body for your web requests should never exceed the inspection limit, you could use a size constraint statement to block requests that have a larger request body size.

\n

If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.

" - } - }, - "GeoMatchStatement": { - "target": "com.amazonaws.wafv2#GeoMatchStatement", - "traits": { - "smithy.api#documentation": "

A rule statement that labels web requests by country and region and that matches against web requests based on country code. A geo match rule labels every request that it inspects regardless of whether it finds a match.

\n \n

WAF labels requests using the alpha-2 country and region codes from the International Organization for Standardization (ISO) 3166 standard. WAF determines the codes using either the IP address in the web request origin or, if you specify it, the address in the geo match ForwardedIPConfig.

\n

If you use the web request origin, the label formats are awswaf:clientip:geo:region:- and awswaf:clientip:geo:country:.

\n

If you use a forwarded IP address, the label formats are awswaf:forwardedip:geo:region:- and awswaf:forwardedip:geo:country:.

\n

For additional details, see Geographic match rule statement in the WAF Developer Guide.

" - } - }, - "RuleGroupReferenceStatement": { - "target": "com.amazonaws.wafv2#RuleGroupReferenceStatement", - "traits": { - "smithy.api#documentation": "

A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.

\n

You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. You \n can only use a rule group reference statement at the top level inside a web ACL.

" - } - }, - "IPSetReferenceStatement": { - "target": "com.amazonaws.wafv2#IPSetReferenceStatement", - "traits": { - "smithy.api#documentation": "

A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.

\n

Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

" - } - }, - "RegexPatternSetReferenceStatement": { - "target": "com.amazonaws.wafv2#RegexPatternSetReferenceStatement", - "traits": { - "smithy.api#documentation": "

A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.

\n

Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

" - } - }, - "RateBasedStatement": { - "target": "com.amazonaws.wafv2#RateBasedStatement", - "traits": { - "smithy.api#documentation": "

A rate-based rule counts incoming requests and rate limits requests when they are coming at too fast a rate. The rule categorizes requests according to your aggregation criteria, collects them into aggregation instances, and counts and rate limits the requests for each instance.

\n

You can specify individual aggregation keys, like IP address or HTTP method. You can also specify aggregation key combinations, like IP address and HTTP method, or HTTP method, query argument, and cookie.

\n

Each unique set of values for the aggregation keys that you specify is a separate aggregation instance, with the value from each key contributing to the aggregation instance definition.

\n

For example, assume the rule evaluates web requests with the following IP address and HTTP method values:

\n \n

The rule would create different aggregation instances according to your aggregation criteria, for example:

\n \n

For any n-tuple of aggregation keys, each unique combination of values for the keys defines a separate aggregation instance, which WAF counts and rate-limits individually.

\n

You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts and rate limits requests that match the nested statement. You can use this nested scope-down statement in conjunction with your aggregation key specifications or you can just count and rate limit all requests that match the scope-down statement, without additional aggregation. When you choose to just manage all requests that match a scope-down statement, the aggregation instance is singular for the rule.

\n

You cannot nest a RateBasedStatement inside another statement, for example inside a NotStatement or OrStatement. You can define a RateBasedStatement inside a web ACL and inside a rule group.

\n

For additional information about the options, see Rate limiting web requests using rate-based rules \n in the WAF Developer Guide.

\n

If you only aggregate on the individual IP address or forwarded IP address, you can retrieve the list of IP addresses that WAF \n is currently rate limiting for a rule through the API call GetRateBasedStatementManagedKeys. This option is not available\n for other aggregation configurations.

\n

WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF.

" - } - }, - "AndStatement": { - "target": "com.amazonaws.wafv2#AndStatement", - "traits": { - "smithy.api#documentation": "

A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement.

" - } - }, - "OrStatement": { - "target": "com.amazonaws.wafv2#OrStatement", - "traits": { - "smithy.api#documentation": "

A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement.

" - } - }, - "NotStatement": { - "target": "com.amazonaws.wafv2#NotStatement", - "traits": { - "smithy.api#documentation": "

A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement.

" - } - }, - "ManagedRuleGroupStatement": { - "target": "com.amazonaws.wafv2#ManagedRuleGroupStatement", - "traits": { - "smithy.api#documentation": "

A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.

\n

You cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

\n \n

You are charged additional fees when you use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet or the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet. For more information, see WAF Pricing.

\n " - } - }, - "LabelMatchStatement": { - "target": "com.amazonaws.wafv2#LabelMatchStatement", - "traits": { - "smithy.api#documentation": "

A rule statement to match against labels that have been added to the web request by rules that have already run in the web ACL.

\n

The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, WAF performs the search for labels that were added in the same context as the label match statement.

" - } - }, - "RegexMatchStatement": { - "target": "com.amazonaws.wafv2#RegexMatchStatement", - "traits": { - "smithy.api#documentation": "

A rule statement used to search web request components for a match against a single regular expression.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The processing guidance for a Rule, used by WAF to determine whether\n a web request matches the rule.

\n

For example specifications, see the examples section of CreateWebACL.

" - } - }, - "com.amazonaws.wafv2#Statements": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#Statement" - } - }, - "com.amazonaws.wafv2#String": { - "type": "string" - }, - "com.amazonaws.wafv2#SuccessCode": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 999 - } - } - }, - "com.amazonaws.wafv2#SuccessValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.wafv2#Tag": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.wafv2#TagKey", - "traits": { - "smithy.api#documentation": "

Part of the key:value pair that defines a tag. You can use a tag key to describe a\n category of information, such as \"customer.\" Tag keys are case-sensitive.

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.wafv2#TagValue", - "traits": { - "smithy.api#documentation": "

Part of the key:value pair that defines a tag. You can use a tag value to describe a\n specific value within a category, such as \"companyA\" or \"companyB.\" Tag values are\n case-sensitive.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A tag associated with an Amazon Web Services resource. Tags are key:value pairs that you can use to\n categorize and manage your resources, for purposes like billing or other management.\n Typically, the tag key represents a category, such as \"environment\", and the tag value\n represents a specific value within that category, such as \"test,\" \"development,\" or\n \"production\". Or you might set the tag key to \"customer\" and the value to the customer name\n or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a\n resource.

\n

You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule\n groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF\n console.

" - } - }, - "com.amazonaws.wafv2#TagInfoForResource": { - "type": "structure", - "members": { - "ResourceARN": { - "target": "com.amazonaws.wafv2#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" - } - }, - "TagList": { - "target": "com.amazonaws.wafv2#TagList", - "traits": { - "smithy.api#documentation": "

The array of Tag objects defined for the resource.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The collection of tagging definitions for an Amazon Web Services resource. Tags are key:value pairs\n that you can use to categorize and manage your resources, for purposes like billing or\n other management. Typically, the tag key represents a category, such as \"environment\", and\n the tag value represents a specific value within that category, such as \"test,\"\n \"development,\" or \"production\". Or you might set the tag key to \"customer\" and the value to\n the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up\n to 50 tags for a resource.

\n

You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule\n groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF\n console.

" - } - }, - "com.amazonaws.wafv2#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" - } - }, - "com.amazonaws.wafv2#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.wafv2#TagList": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#Tag" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.wafv2#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#TagResourceRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#TagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFLimitsExceededException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - }, - { - "target": "com.amazonaws.wafv2#WAFTagOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" - } - ], - "traits": { - "smithy.api#documentation": "

Associates tags with the specified Amazon Web Services resource. Tags are key:value pairs that you can\n use to categorize and manage your resources, for purposes like billing. For example, you\n might set the tag key to \"customer\" and the value to the customer name or ID. You can\n specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a\n resource.

\n

You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule\n groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF\n console.

" - } - }, - "com.amazonaws.wafv2#TagResourceRequest": { - "type": "structure", - "members": { - "ResourceARN": { - "target": "com.amazonaws.wafv2#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.wafv2#TagList", - "traits": { - "smithy.api#documentation": "

An array of key:value pairs to associate with the resource.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#TagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" - } - }, - "com.amazonaws.wafv2#TextTransformation": { - "type": "structure", - "members": { - "Priority": { - "target": "com.amazonaws.wafv2#TextTransformationPriority", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Sets the relative processing order for multiple transformations.\n WAF processes all transformations, from lowest priority to highest,\n before inspecting the transformed content. The priorities don't need to be consecutive, but\n they must all be different.

", - "smithy.api#required": {} - } - }, - "Type": { - "target": "com.amazonaws.wafv2#TextTransformationType", - "traits": { - "smithy.api#documentation": "

You can specify the following transformation types:

\n

\n BASE64_DECODE - Decode a\n Base64-encoded string.

\n

\n BASE64_DECODE_EXT - Decode a\n Base64-encoded string, but use a forgiving implementation that ignores\n characters that aren't valid.

\n

\n CMD_LINE - Command-line transformations. These are\n helpful in reducing effectiveness of attackers who inject an operating system command-line \n command and use unusual formatting to disguise some or all of the command.

\n \n

\n COMPRESS_WHITE_SPACE - Replace these characters\n with a space character (decimal 32):

\n \n

\n COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

\n

\n CSS_DECODE - Decode characters that were encoded\n using CSS 2.x escape rules syndata.html#characters. This function uses up to\n two bytes in the decoding process, so it can help to uncover ASCII characters that were\n encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in\n countering evasion, which is a combination of a backslash and non-hexadecimal characters.\n For example, ja\\vascript for javascript.

\n

\n ESCAPE_SEQ_DECODE - Decode the following ANSI C\n escape sequences: \\a, \\b, \\f, \\n,\n \\r, \\t, \\v, \\\\, \\?,\n \\', \\\", \\xHH (hexadecimal), \\0OOO\n (octal). Encodings that aren't valid remain in the output.

\n

\n HEX_DECODE - Decode a string of hexadecimal\n characters into a binary.

\n

\n HTML_ENTITY_DECODE - Replace HTML-encoded\n characters with unencoded characters. HTML_ENTITY_DECODE performs these\n operations:

\n \n

\n JS_DECODE - Decode JavaScript escape sequences. If\n a\n \\\n u\n HHHH\n code is in the full-width ASCII code range of FF01-FF5E, then the higher byte\n is used to detect and adjust the lower byte. If not, only the lower byte is used and the\n higher byte is zeroed, causing a possible loss of information.

\n

\n LOWERCASE - Convert uppercase letters (A-Z) to\n lowercase (a-z).

\n

\n MD5 - Calculate an MD5 hash from the data in the\n input. The computed hash is in a raw binary form.

\n

\n NONE - Specify NONE if you don't want\n any text transformations.

\n

\n NORMALIZE_PATH - Remove multiple slashes, directory\n self-references, and directory back-references that are not at the beginning of the input\n from an input string.

\n

\n NORMALIZE_PATH_WIN - This is the same as\n NORMALIZE_PATH, but first converts backslash characters to forward slashes.

\n

\n REMOVE_NULLS - Remove all NULL bytes\n from the input.

\n

\n REPLACE_COMMENTS - Replace each occurrence of a\n C-style comment (/* ... */) with a single space. Multiple consecutive\n occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII\n 0x20). However, a standalone termination of a comment (*/) is not acted upon.

\n

\n REPLACE_NULLS - Replace NULL bytes in the input\n with space characters (ASCII 0x20).

\n

\n SQL_HEX_DECODE - Decode SQL hex data. Example\n (0x414243) will be decoded to (ABC).

\n

\n URL_DECODE - Decode a URL-encoded value.

\n

\n URL_DECODE_UNI - Like URL_DECODE, but\n with support for Microsoft-specific %u encoding. If the code is in the\n full-width ASCII code range of FF01-FF5E, the higher byte is used to detect\n and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is\n zeroed.

\n

\n UTF8_TO_UNICODE - Convert all UTF-8 character\n sequences to Unicode. This helps input normalization, and minimizing false-positives and\n false-negatives for non-English languages.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web\n requests in an effort to bypass detection.

" - } - }, - "com.amazonaws.wafv2#TextTransformationPriority": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.wafv2#TextTransformationType": { - "type": "enum", - "members": { - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - }, - "COMPRESS_WHITE_SPACE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPRESS_WHITE_SPACE" - } - }, - "HTML_ENTITY_DECODE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTML_ENTITY_DECODE" - } - }, - "LOWERCASE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LOWERCASE" - } - }, - "CMD_LINE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CMD_LINE" - } - }, - "URL_DECODE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "URL_DECODE" - } - }, - "BASE64_DECODE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BASE64_DECODE" - } - }, - "HEX_DECODE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HEX_DECODE" - } - }, - "MD5": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MD5" - } - }, - "REPLACE_COMMENTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REPLACE_COMMENTS" - } - }, - "ESCAPE_SEQ_DECODE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ESCAPE_SEQ_DECODE" - } - }, - "SQL_HEX_DECODE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SQL_HEX_DECODE" - } - }, - "CSS_DECODE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CSS_DECODE" - } - }, - "JS_DECODE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JS_DECODE" - } - }, - "NORMALIZE_PATH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NORMALIZE_PATH" - } - }, - "NORMALIZE_PATH_WIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NORMALIZE_PATH_WIN" - } - }, - "REMOVE_NULLS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REMOVE_NULLS" - } - }, - "REPLACE_NULLS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REPLACE_NULLS" - } - }, - "BASE64_DECODE_EXT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BASE64_DECODE_EXT" - } - }, - "URL_DECODE_UNI": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "URL_DECODE_UNI" - } - }, - "UTF8_TO_UNICODE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UTF8_TO_UNICODE" - } - } - } - }, - "com.amazonaws.wafv2#TextTransformations": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#TextTransformation" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.wafv2#TimeWindow": { - "type": "structure", - "members": { - "StartTime": { - "target": "com.amazonaws.wafv2#Timestamp", - "traits": { - "smithy.api#documentation": "

The beginning of the time range from which you want GetSampledRequests to\n return a sample of the requests that your Amazon Web Services resource received. You must specify the\n times in Coordinated Universal Time (UTC) format. UTC format includes the special\n designator, Z. For example, \"2016-09-27T14:50Z\". You can specify\n any time range in the previous three hours.

", - "smithy.api#required": {} - } - }, - "EndTime": { - "target": "com.amazonaws.wafv2#Timestamp", - "traits": { - "smithy.api#documentation": "

The end of the time range from which you want GetSampledRequests to return\n a sample of the requests that your Amazon Web Services resource received. You must specify the times in\n Coordinated Universal Time (UTC) format. UTC format includes the special designator,\n Z. For example, \"2016-09-27T14:50Z\". You can specify any time\n range in the previous three hours.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

In a GetSampledRequests request, the StartTime and\n EndTime objects specify the time range for which you want WAF to\n return a sample of web requests.

\n

You must specify the times in Coordinated Universal Time (UTC) format. UTC format\n includes the special designator, Z. For example,\n \"2016-09-27T14:50Z\". You can specify any time range in the previous three\n hours.

\n

In a GetSampledRequests response, the StartTime and\n EndTime objects specify the time range for which WAF actually returned a\n sample of web requests. WAF gets the specified number of requests from among the first\n 5,000 requests that your Amazon Web Services resource receives during the specified time period. If your\n resource receives more than 5,000 requests during that period, WAF stops sampling after\n the 5,000th request. In that case, EndTime is the time that WAF received the\n 5,000th request.

" - } - }, - "com.amazonaws.wafv2#TimeWindowDay": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.wafv2#TimeWindowSecond": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 60, - "max": 259200 - } - } - }, - "com.amazonaws.wafv2#Timestamp": { - "type": "timestamp" - }, - "com.amazonaws.wafv2#TokenDomain": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 253 - }, - "smithy.api#pattern": "^[\\w\\.\\-/]+$" - } - }, - "com.amazonaws.wafv2#TokenDomains": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#TokenDomain" - } - }, - "com.amazonaws.wafv2#URIString": { - "type": "string" - }, - "com.amazonaws.wafv2#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#UntagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - }, - { - "target": "com.amazonaws.wafv2#WAFTagOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" - } - ], - "traits": { - "smithy.api#documentation": "

Disassociates tags from an Amazon Web Services resource. Tags are key:value pairs that you can\n associate with Amazon Web Services resources. For example, the tag key might be \"customer\" and the tag\n value might be \"companyA.\" You can specify one or more tags to add to each container. You\n can add up to 50 tags to each Amazon Web Services resource.

" - } - }, - "com.amazonaws.wafv2#UntagResourceRequest": { - "type": "structure", - "members": { - "ResourceARN": { - "target": "com.amazonaws.wafv2#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", - "smithy.api#required": {} - } - }, - "TagKeys": { - "target": "com.amazonaws.wafv2#TagKeyList", - "traits": { - "smithy.api#documentation": "

An array of keys identifying the tags to disassociate from the resource.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#UntagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#UpdateIPSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#UpdateIPSetRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#UpdateIPSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFDuplicateItemException" - }, - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFLimitsExceededException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - }, - { - "target": "com.amazonaws.wafv2#WAFOptimisticLockException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the specified IPSet.

\n \n

This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call.

\n

To modify an IP set, do the following:

\n
    \n
  1. \n

    Retrieve it by calling GetIPSet\n

    \n
    2. \n
  2. \n

    Update its settings as needed

    \n
    3. \n
  3. \n

    Provide the complete IP set specification to this call

    \n
    4. \n
\n \n

When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

" - } - }, - "com.amazonaws.wafv2#UpdateIPSetRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the IP set. You cannot change the name of an IPSet after you create it.

", - "smithy.api#required": {} - } - }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.wafv2#EntityDescription", - "traits": { - "smithy.api#documentation": "

A description of the IP set that helps with identification.

" - } - }, - "Addresses": { - "target": "com.amazonaws.wafv2#IPAddresses", - "traits": { - "smithy.api#documentation": "

Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

\n

Example address strings:

\n \n

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

\n

Example JSON Addresses specifications:

\n ", - "smithy.api#required": {} - } - }, - "LockToken": { - "target": "com.amazonaws.wafv2#LockToken", - "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#UpdateIPSetResponse": { - "type": "structure", - "members": { - "NextLockToken": { - "target": "com.amazonaws.wafv2#LockToken", - "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#UpdateManagedRuleSetVersionExpiryDate": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#UpdateManagedRuleSetVersionExpiryDateRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#UpdateManagedRuleSetVersionExpiryDateResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - }, - { - "target": "com.amazonaws.wafv2#WAFOptimisticLockException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the expiration information for your managed rule set. Use this to initiate the\n expiration of a managed rule group version. After you initiate expiration for a version,\n WAF excludes it from the response to ListAvailableManagedRuleGroupVersions for the managed rule group.

\n \n

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

\n

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

\n " - } - }, - "com.amazonaws.wafv2#UpdateManagedRuleSetVersionExpiryDateRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

\n

This name is assigned to the corresponding managed rule group, which your customers can access and use.

", - "smithy.api#required": {} - } - }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

", - "smithy.api#required": {} - } - }, - "LockToken": { - "target": "com.amazonaws.wafv2#LockToken", - "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", - "smithy.api#required": {} - } - }, - "VersionToExpire": { - "target": "com.amazonaws.wafv2#VersionKeyString", - "traits": { - "smithy.api#documentation": "

The version that you want to remove from your list of offerings for the named managed\n rule group.

", - "smithy.api#required": {} - } - }, - "ExpiryTimestamp": { - "target": "com.amazonaws.wafv2#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that you want the version to expire.

\n

Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\".

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#UpdateManagedRuleSetVersionExpiryDateResponse": { - "type": "structure", - "members": { - "ExpiringVersion": { - "target": "com.amazonaws.wafv2#VersionKeyString", - "traits": { - "smithy.api#documentation": "

The version that is set to expire.

" - } - }, - "ExpiryTimestamp": { - "target": "com.amazonaws.wafv2#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the version will expire.

\n

Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\".

" - } - }, - "NextLockToken": { - "target": "com.amazonaws.wafv2#LockToken", - "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#UpdateRegexPatternSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#UpdateRegexPatternSetRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#UpdateRegexPatternSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFDuplicateItemException" - }, - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" - }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" - }, - { - "target": "com.amazonaws.wafv2#WAFLimitsExceededException" - }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" - }, - { - "target": "com.amazonaws.wafv2#WAFOptimisticLockException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the specified RegexPatternSet.

\n \n

This operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call.

\n

To modify a regex pattern set, do the following:

\n
    \n
  1. \n

    Retrieve it by calling GetRegexPatternSet\n

    \n
    2. \n
  2. \n

    Update its settings as needed

    \n
    3. \n
  3. \n

    Provide the complete regex pattern set specification to this call

    \n
    4. \n
\n \n

When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

" - } - }, - "com.amazonaws.wafv2#UpdateRegexPatternSetRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the set. You cannot change the name after you create the set.

", - "smithy.api#required": {} - } - }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.wafv2#EntityDescription", - "traits": { - "smithy.api#documentation": "

A description of the set that helps with identification.

" - } - }, - "RegularExpressionList": { - "target": "com.amazonaws.wafv2#RegularExpressionList", - "traits": { - "smithy.api#documentation": "

", - "smithy.api#required": {} - } - }, - "LockToken": { - "target": "com.amazonaws.wafv2#LockToken", - "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#UpdateRegexPatternSetResponse": { - "type": "structure", - "members": { - "NextLockToken": { - "target": "com.amazonaws.wafv2#LockToken", - "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#UpdateRuleGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#UpdateRuleGroupRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#UpdateRuleGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFConfigurationWarningException" + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://wafv2.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://wafv2.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://wafv2.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.wafv2#Action": { + "type": "string" + }, + "com.amazonaws.wafv2#ActionCondition": { + "type": "structure", + "members": { + "Action": { + "target": "com.amazonaws.wafv2#ActionValue", + "traits": { + "smithy.api#documentation": "

The action setting that a log record must contain in order to meet the condition. This is the action that WAF applied to the web request.

\n

For rule groups, this is either the configured rule action setting, or if you've applied a rule action override to the rule, it's the override action. \n The value EXCLUDED_AS_COUNT matches on \n excluded rules and also on rules that have a rule action override of Count.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A single action condition for a Condition in a logging filter.

" + } + }, + "com.amazonaws.wafv2#ActionValue": { + "type": "enum", + "members": { + "ALLOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALLOW" + } + }, + "BLOCK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLOCK" + } + }, + "COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNT" + } + }, + "CAPTCHA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CAPTCHA" + } + }, + "CHALLENGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CHALLENGE" + } + }, + "EXCLUDED_AS_COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXCLUDED_AS_COUNT" + } + } + } + }, + "com.amazonaws.wafv2#AddressField": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.wafv2#FieldIdentifier", + "traits": { + "smithy.api#documentation": "

The name of a single primary address field.

\n

How you specify the address fields depends on the request inspection payload type.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The name of a field in the request payload that contains part or all of your customer's primary physical address.

\n

This data type is used in the RequestInspectionACFP data type.

" + } + }, + "com.amazonaws.wafv2#AddressFields": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#AddressField" + } + }, + "com.amazonaws.wafv2#All": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Inspect all of the elements that WAF has parsed and extracted from the web request\n component that you've identified in your FieldToMatch specifications.

\n

This is used in the FieldToMatch specification for some web request component types.

\n

JSON specification: \"All\": {}\n

" + } + }, + "com.amazonaws.wafv2#AllQueryArguments": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Inspect all query arguments of the web request.

\n

This is used in the FieldToMatch specification for some web request component types.

\n

JSON specification: \"AllQueryArguments\": {}\n

" + } + }, + "com.amazonaws.wafv2#AllowAction": { + "type": "structure", + "members": { + "CustomRequestHandling": { + "target": "com.amazonaws.wafv2#CustomRequestHandling", + "traits": { + "smithy.api#documentation": "

Defines custom handling for the web request.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies that WAF should allow the request and optionally defines additional\n custom handling for the request.

\n

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

" + } + }, + "com.amazonaws.wafv2#AndStatement": { + "type": "structure", + "members": { + "Statements": { + "target": "com.amazonaws.wafv2#Statements", + "traits": { + "smithy.api#documentation": "

The statements to combine with AND logic. You can use any statements that can be nested.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement.

" + } + }, + "com.amazonaws.wafv2#AssociateWebACL": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#AssociateWebACLRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#AssociateWebACLResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFUnavailableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates a web ACL with a regional application resource, to protect the resource.\n A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To\n associate a web ACL, in the CloudFront call UpdateDistribution, set the web ACL ID\n to the Amazon Resource Name (ARN) of the web ACL. For information, see UpdateDistribution in the Amazon CloudFront Developer Guide.

\n

When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

" + } + }, + "com.amazonaws.wafv2#AssociateWebACLRequest": { + "type": "structure", + "members": { + "WebACLArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the web ACL that you want to associate with the\n resource.

", + "smithy.api#required": {} + } + }, + "ResourceArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to associate with the web ACL.

\n

The ARN must be in one of the following formats:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#AssociateWebACLResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#AssociatedResourceType": { + "type": "enum", + "members": { + "CLOUDFRONT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOUDFRONT" + } + } + } + }, + "com.amazonaws.wafv2#AssociationConfig": { + "type": "structure", + "members": { + "RequestBody": { + "target": "com.amazonaws.wafv2#RequestBody", + "traits": { + "smithy.api#documentation": "

Customizes the maximum size of the request body that your protected CloudFront distributions forward to WAF for inspection. The default size is 16 KB (16,384 kilobytes).

\n \n

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies custom configurations for the associations between the web ACL and protected resources.

\n

Use this to customize the maximum size of the request body that your protected CloudFront distributions forward to WAF for inspection. The default is 16 KB (16,384 kilobytes).

\n \n

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

\n " + } + }, + "com.amazonaws.wafv2#BlockAction": { + "type": "structure", + "members": { + "CustomResponse": { + "target": "com.amazonaws.wafv2#CustomResponse", + "traits": { + "smithy.api#documentation": "

Defines a custom response for the web request.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies that WAF should block the request and optionally defines additional\n custom handling for the response to the web request.

\n

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

" + } + }, + "com.amazonaws.wafv2#Body": { + "type": "structure", + "members": { + "OversizeHandling": { + "target": "com.amazonaws.wafv2#OversizeHandling", + "traits": { + "smithy.api#documentation": "

What WAF should do if the body is larger than WAF can inspect. \n WAF does not support inspecting the entire contents of the web request body if the body \n exceeds the limit for the resource type. If the body is larger than the limit, the underlying host service \n only forwards the contents that are below the limit to WAF for inspection.

\n

The default limit is 8 KB (8,192 kilobytes) for regional resources and 16 KB (16,384 kilobytes) for CloudFront distributions. For CloudFront distributions, \n you can increase the limit in the web ACL AssociationConfig, for additional processing fees.

\n

The options for oversize handling are the following:

\n \n

You can combine the MATCH or NO_MATCH\n settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.

\n

Default: CONTINUE\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Inspect the body of the web request. The body immediately follows the request\n headers.

\n

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

" + } + }, + "com.amazonaws.wafv2#BodyParsingFallbackBehavior": { + "type": "enum", + "members": { + "MATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MATCH" + } + }, + "NO_MATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_MATCH" + } + }, + "EVALUATE_AS_STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EVALUATE_AS_STRING" + } + } + } + }, + "com.amazonaws.wafv2#Boolean": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.wafv2#ByteMatchStatement": { + "type": "structure", + "members": { + "SearchString": { + "target": "com.amazonaws.wafv2#SearchString", + "traits": { + "smithy.api#documentation": "

A string value that you want WAF to search for. WAF searches only in the part of\n web requests that you designate for inspection in FieldToMatch. The\n maximum length of the value is 200 bytes.

\n

Valid values depend on the component that you specify for inspection in\n FieldToMatch:

\n \n

If SearchString includes alphabetic characters A-Z and a-z, note that the\n value is case sensitive.

\n

\n If you're using the WAF API\n

\n

Specify a base64-encoded version of the value. The maximum length of the value before\n you base64-encode it is 200 bytes.

\n

For example, suppose the value of Type is HEADER and the value\n of Data is User-Agent. If you want to search the\n User-Agent header for the value BadBot, you base64-encode\n BadBot using MIME base64-encoding and include the resulting value,\n QmFkQm90, in the value of SearchString.

\n

\n If you're using the CLI or one of the Amazon Web Services SDKs\n

\n

The value that you want WAF to search for. The SDK automatically base64 encodes the\n value.

", + "smithy.api#required": {} + } + }, + "FieldToMatch": { + "target": "com.amazonaws.wafv2#FieldToMatch", + "traits": { + "smithy.api#documentation": "

The part of the web request that you want WAF to inspect.

", + "smithy.api#required": {} + } + }, + "TextTransformations": { + "target": "com.amazonaws.wafv2#TextTransformations", + "traits": { + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.

", + "smithy.api#required": {} + } + }, + "PositionalConstraint": { + "target": "com.amazonaws.wafv2#PositionalConstraint", + "traits": { + "smithy.api#documentation": "

The area within the portion of the web request that you want WAF to search for\n SearchString. Valid values include the following:

\n

\n CONTAINS\n

\n

The specified part of the web request must include the value of\n SearchString, but the location doesn't matter.

\n

\n CONTAINS_WORD\n

\n

The specified part of the web request must include the value of\n SearchString, and SearchString must contain only alphanumeric\n characters or underscore (A-Z, a-z, 0-9, or _). In addition, SearchString must\n be a word, which means that both of the following are true:

\n \n

\n EXACTLY\n

\n

The value of the specified part of the web request must exactly match the value of\n SearchString.

\n

\n STARTS_WITH\n

\n

The value of SearchString must appear at the beginning of the specified\n part of the web request.

\n

\n ENDS_WITH\n

\n

The value of SearchString must appear at the end of the specified part of\n the web request.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A rule statement that defines a string match search for WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the WAF console and the developer guide, this is called a string match statement.

" + } + }, + "com.amazonaws.wafv2#CapacityUnit": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.wafv2#CaptchaAction": { + "type": "structure", + "members": { + "CustomRequestHandling": { + "target": "com.amazonaws.wafv2#CustomRequestHandling", + "traits": { + "smithy.api#documentation": "

Defines custom handling for the web request, used when the CAPTCHA inspection determines that the request's token is valid and unexpired.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies that WAF should run a CAPTCHA check against the request:

\n \n

You can configure the expiration time \n in the CaptchaConfig\n ImmunityTimeProperty setting at the rule and web ACL level. The rule setting overrides the web ACL setting.

\n

This action option is available for rules. It isn't available for web ACL default actions.

" + } + }, + "com.amazonaws.wafv2#CaptchaConfig": { + "type": "structure", + "members": { + "ImmunityTimeProperty": { + "target": "com.amazonaws.wafv2#ImmunityTimeProperty", + "traits": { + "smithy.api#documentation": "

Determines how long a CAPTCHA timestamp in the token remains valid after the client\n successfully solves a CAPTCHA puzzle.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies how WAF should handle CAPTCHA evaluations. This is\n available at the web ACL level and in each rule.

" + } + }, + "com.amazonaws.wafv2#CaptchaResponse": { + "type": "structure", + "members": { + "ResponseCode": { + "target": "com.amazonaws.wafv2#ResponseCode", + "traits": { + "smithy.api#documentation": "

The HTTP response code indicating the status of the CAPTCHA token in the\n web request. If the token is missing, invalid, or expired, this code is 405 Method\n Not Allowed.

" + } + }, + "SolveTimestamp": { + "target": "com.amazonaws.wafv2#SolveTimestamp", + "traits": { + "smithy.api#documentation": "

The time that the CAPTCHA was last solved for the supplied token.

" + } + }, + "FailureReason": { + "target": "com.amazonaws.wafv2#FailureReason", + "traits": { + "smithy.api#documentation": "

The reason for failure, populated when the evaluation of the token fails.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The result from the inspection of the web request for a valid CAPTCHA token.

" + } + }, + "com.amazonaws.wafv2#ChallengeAction": { + "type": "structure", + "members": { + "CustomRequestHandling": { + "target": "com.amazonaws.wafv2#CustomRequestHandling", + "traits": { + "smithy.api#documentation": "

Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies that WAF should run a Challenge check against the request to verify that the request is coming from a legitimate client session:

\n \n

You can configure the expiration time \n in the ChallengeConfig\n ImmunityTimeProperty setting at the rule and web ACL level. The rule setting overrides the web ACL setting.

\n

This action option is available for rules. It isn't available for web ACL default actions.

" + } + }, + "com.amazonaws.wafv2#ChallengeConfig": { + "type": "structure", + "members": { + "ImmunityTimeProperty": { + "target": "com.amazonaws.wafv2#ImmunityTimeProperty", + "traits": { + "smithy.api#documentation": "

Determines how long a challenge timestamp in the token remains valid after the client\n successfully responds to a challenge.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies how WAF should handle Challenge evaluations. This is\n available at the web ACL level and in each rule.

" + } + }, + "com.amazonaws.wafv2#ChallengeResponse": { + "type": "structure", + "members": { + "ResponseCode": { + "target": "com.amazonaws.wafv2#ResponseCode", + "traits": { + "smithy.api#documentation": "

The HTTP response code indicating the status of the challenge token in the\n web request. If the token is missing, invalid, or expired, this code is 202 Request Accepted.

" + } + }, + "SolveTimestamp": { + "target": "com.amazonaws.wafv2#SolveTimestamp", + "traits": { + "smithy.api#documentation": "

The time that the challenge was last solved for the supplied token.

" + } + }, + "FailureReason": { + "target": "com.amazonaws.wafv2#FailureReason", + "traits": { + "smithy.api#documentation": "

The reason for failure, populated when the evaluation of the token fails.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The result from the inspection of the web request for a valid challenge token.

" + } + }, + "com.amazonaws.wafv2#CheckCapacity": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#CheckCapacityRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#CheckCapacityResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFExpiredManagedRuleGroupVersionException" + }, + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidResourceException" + }, + { + "target": "com.amazonaws.wafv2#WAFLimitsExceededException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFSubscriptionNotFoundException" + }, + { + "target": "com.amazonaws.wafv2#WAFUnavailableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules. \n You can use this to check the capacity requirements for the rules you want to use in a \n RuleGroup or WebACL. \n

\n

WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) \n in the WAF Developer Guide.

" + } + }, + "com.amazonaws.wafv2#CheckCapacityRequest": { + "type": "structure", + "members": { + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", + "smithy.api#required": {} + } + }, + "Rules": { + "target": "com.amazonaws.wafv2#Rules", + "traits": { + "smithy.api#documentation": "

An array of Rule that you're configuring to use in a rule group or web\n ACL.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#CheckCapacityResponse": { + "type": "structure", + "members": { + "Capacity": { + "target": "com.amazonaws.wafv2#ConsumedCapacity", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The capacity required by the rules and scope.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#ComparisonOperator": { + "type": "enum", + "members": { + "EQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQ" + } + }, + "NE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NE" + } + }, + "LE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LE" + } + }, + "LT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LT" + } + }, + "GE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GE" + } + }, + "GT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GT" + } + } + } + }, + "com.amazonaws.wafv2#Condition": { + "type": "structure", + "members": { + "ActionCondition": { + "target": "com.amazonaws.wafv2#ActionCondition", + "traits": { + "smithy.api#documentation": "

A single action condition. This is the action setting that a log record must contain in order to meet the condition.

" + } + }, + "LabelNameCondition": { + "target": "com.amazonaws.wafv2#LabelNameCondition", + "traits": { + "smithy.api#documentation": "

A single label name condition. This is the fully qualified label name that a log record must contain in order to meet the condition. \n Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A single match condition for a Filter.

" + } + }, + "com.amazonaws.wafv2#Conditions": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#Condition" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.wafv2#ConsumedCapacity": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.wafv2#CookieMatchPattern": { + "type": "structure", + "members": { + "All": { + "target": "com.amazonaws.wafv2#All", + "traits": { + "smithy.api#documentation": "

Inspect all cookies.

" + } + }, + "IncludedCookies": { + "target": "com.amazonaws.wafv2#CookieNames", + "traits": { + "smithy.api#documentation": "

Inspect only the cookies that have a key that matches one of the strings specified here.\n

" + } + }, + "ExcludedCookies": { + "target": "com.amazonaws.wafv2#CookieNames", + "traits": { + "smithy.api#documentation": "

Inspect only the cookies whose keys don't match any of the strings specified here.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The filter to use to identify the subset of cookies to inspect in a web request.

\n

You must specify exactly one setting: either All, IncludedCookies, or ExcludedCookies.

\n

Example JSON: \"MatchPattern\": { \"IncludedCookies\": {\"KeyToInclude1\", \"KeyToInclude2\", \"KeyToInclude3\"} }\n

" + } + }, + "com.amazonaws.wafv2#CookieNames": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#SingleCookieName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 199 + } + } + }, + "com.amazonaws.wafv2#Cookies": { + "type": "structure", + "members": { + "MatchPattern": { + "target": "com.amazonaws.wafv2#CookieMatchPattern", + "traits": { + "smithy.api#documentation": "

The filter to use to identify the subset of cookies to inspect in a web request.

\n

You must specify exactly one setting: either All, IncludedCookies, or ExcludedCookies.

\n

Example JSON: \"MatchPattern\": { \"IncludedCookies\": {\"KeyToInclude1\", \"KeyToInclude2\", \"KeyToInclude3\"} }\n

", + "smithy.api#required": {} + } + }, + "MatchScope": { + "target": "com.amazonaws.wafv2#MapMatchScope", + "traits": { + "smithy.api#documentation": "

The parts of the cookies to inspect with the rule inspection criteria. If you specify\n All, WAF inspects both keys and values.

", + "smithy.api#required": {} + } + }, + "OversizeHandling": { + "target": "com.amazonaws.wafv2#OversizeHandling", + "traits": { + "smithy.api#documentation": "

What WAF should do if the cookies of the request are more numerous or larger than WAF can inspect. \n WAF does not support inspecting the entire contents of request cookies \n when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies\n and at most 8 KB of cookie contents to WAF.

\n

The options for oversize handling are the following:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Inspect the cookies in the web request. You can specify the parts of the cookies to\n inspect and you can narrow the set of cookies to inspect by including or excluding specific\n keys.

\n

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

\n

Example JSON: \"Cookies\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"KEY\",\n \"OversizeHandling\": \"MATCH\" }\n

" + } + }, + "com.amazonaws.wafv2#CountAction": { + "type": "structure", + "members": { + "CustomRequestHandling": { + "target": "com.amazonaws.wafv2#CustomRequestHandling", + "traits": { + "smithy.api#documentation": "

Defines custom handling for the web request.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies that WAF should count the request. Optionally defines additional custom\n handling for the request.

\n

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

" + } + }, + "com.amazonaws.wafv2#Country": { + "type": "string" + }, + "com.amazonaws.wafv2#CountryCode": { + "type": "enum", + "members": { + "AF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AF" + } + }, + "AX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AX" + } + }, + "AL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AL" + } + }, + "DZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DZ" + } + }, + "AS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AS" + } + }, + "AD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AD" + } + }, + "AO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AO" + } + }, + "AI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AI" + } + }, + "AQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AQ" + } + }, + "AG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AG" + } + }, + "AR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AR" + } + }, + "AM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AM" + } + }, + "AW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AW" + } + }, + "AU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AU" + } + }, + "AT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AT" + } + }, + "AZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AZ" + } + }, + "BS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BS" + } + }, + "BH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BH" + } + }, + "BD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BD" + } + }, + "BB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BB" + } + }, + "BY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BY" + } + }, + "BE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BE" + } + }, + "BZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BZ" + } + }, + "BJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BJ" + } + }, + "BM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BM" + } + }, + "BT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BT" + } + }, + "BO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BO" + } + }, + "BQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BQ" + } + }, + "BA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BA" + } + }, + "BW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BW" + } + }, + "BV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BV" + } + }, + "BR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BR" + } + }, + "IO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IO" + } + }, + "BN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BN" + } + }, + "BG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BG" + } + }, + "BF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BF" + } + }, + "BI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BI" + } + }, + "KH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KH" + } + }, + "CM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CM" + } + }, + "CA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CA" + } + }, + "CV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CV" + } + }, + "KY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KY" + } + }, + "CF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CF" + } + }, + "TD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TD" + } + }, + "CL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CL" + } + }, + "CN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CN" + } + }, + "CX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CX" + } + }, + "CC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CC" + } + }, + "CO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CO" + } + }, + "KM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KM" + } + }, + "CG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CG" + } + }, + "CD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CD" + } + }, + "CK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CK" + } + }, + "CR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CR" + } + }, + "CI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CI" + } + }, + "HR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HR" + } + }, + "CU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CU" + } + }, + "CW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CW" + } + }, + "CY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CY" + } + }, + "CZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CZ" + } + }, + "DK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DK" + } + }, + "DJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DJ" + } + }, + "DM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DM" + } + }, + "DO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DO" + } + }, + "EC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC" + } + }, + "EG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EG" + } + }, + "SV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SV" + } + }, + "GQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GQ" + } + }, + "ER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ER" + } + }, + "EE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EE" + } + }, + "ET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ET" + } + }, + "FK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FK" + } + }, + "FO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FO" + } + }, + "FJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FJ" + } + }, + "FI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FI" + } + }, + "FR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FR" + } + }, + "GF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GF" + } + }, + "PF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PF" + } + }, + "TF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TF" + } + }, + "GA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GA" + } + }, + "GM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GM" + } + }, + "GE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GE" + } + }, + "DE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DE" + } + }, + "GH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GH" + } + }, + "GI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GI" + } + }, + "GR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GR" + } + }, + "GL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GL" + } + }, + "GD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GD" + } + }, + "GP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GP" + } + }, + "GU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GU" + } + }, + "GT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GT" + } + }, + "GG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GG" + } + }, + "GN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GN" + } + }, + "GW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GW" + } + }, + "GY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GY" + } + }, + "HT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HT" + } + }, + "HM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HM" + } + }, + "VA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VA" + } + }, + "HN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HN" + } + }, + "HK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HK" + } + }, + "HU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HU" + } + }, + "IS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IS" + } + }, + "IN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN" + } + }, + "ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ID" + } + }, + "IR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IR" + } + }, + "IQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IQ" + } + }, + "IE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IE" + } + }, + "IM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IM" + } + }, + "IL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IL" + } + }, + "IT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IT" + } + }, + "JM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JM" + } + }, + "JP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JP" + } + }, + "JE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JE" + } + }, + "JO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JO" + } + }, + "KZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KZ" + } + }, + "KE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KE" + } + }, + "KI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KI" + } + }, + "KP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KP" + } + }, + "KR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KR" + } + }, + "KW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KW" + } + }, + "KG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KG" + } + }, + "LA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LA" + } + }, + "LV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LV" + } + }, + "LB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LB" + } + }, + "LS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LS" + } + }, + "LR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LR" + } + }, + "LY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LY" + } + }, + "LI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LI" + } + }, + "LT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LT" + } + }, + "LU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LU" + } + }, + "MO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MO" + } + }, + "MK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MK" + } + }, + "MG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MG" + } + }, + "MW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MW" + } + }, + "MY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MY" + } + }, + "MV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MV" + } + }, + "ML": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ML" + } + }, + "MT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MT" + } + }, + "MH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MH" + } + }, + "MQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MQ" + } + }, + "MR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MR" + } + }, + "MU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MU" + } + }, + "YT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "YT" + } + }, + "MX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MX" + } + }, + "FM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FM" + } + }, + "MD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MD" + } + }, + "MC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MC" + } + }, + "MN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MN" + } + }, + "ME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ME" + } + }, + "MS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MS" + } + }, + "MA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MA" + } + }, + "MZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MZ" + } + }, + "MM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MM" + } + }, + "NA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NA" + } + }, + "NR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NR" + } + }, + "NP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NP" + } + }, + "NL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NL" + } + }, + "NC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NC" + } + }, + "NZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NZ" + } + }, + "NI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NI" + } + }, + "NE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NE" + } + }, + "NG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NG" + } + }, + "NU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NU" + } + }, + "NF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NF" + } + }, + "MP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MP" + } + }, + "NO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO" + } + }, + "OM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OM" + } + }, + "PK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PK" + } + }, + "PW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PW" + } + }, + "PS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PS" + } + }, + "PA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PA" + } + }, + "PG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PG" + } + }, + "PY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PY" + } + }, + "PE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PE" + } + }, + "PH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PH" + } + }, + "PN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PN" + } + }, + "PL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PL" + } + }, + "PT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT" + } + }, + "PR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PR" + } + }, + "QA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QA" + } + }, + "RE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RE" + } + }, + "RO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RO" + } + }, + "RU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RU" + } + }, + "RW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RW" + } + }, + "BL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BL" + } + }, + "SH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SH" + } + }, + "KN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KN" + } + }, + "LC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LC" + } + }, + "MF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MF" + } + }, + "PM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PM" + } + }, + "VC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VC" + } + }, + "WS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WS" + } + }, + "SM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SM" + } + }, + "ST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ST" + } + }, + "SA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SA" + } + }, + "SN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SN" + } + }, + "RS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RS" + } + }, + "SC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SC" + } + }, + "SL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SL" + } + }, + "SG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SG" + } + }, + "SX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SX" + } + }, + "SK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SK" + } + }, + "SI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SI" + } + }, + "SB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SB" + } + }, + "SO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SO" + } + }, + "ZA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZA" + } + }, + "GS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GS" + } + }, + "SS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SS" + } + }, + "ES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ES" + } + }, + "LK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LK" + } + }, + "SD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SD" + } + }, + "SR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SR" + } + }, + "SJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SJ" + } + }, + "SZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SZ" + } + }, + "SE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SE" + } + }, + "CH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CH" + } + }, + "SY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SY" + } + }, + "TW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TW" + } + }, + "TJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TJ" + } + }, + "TZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TZ" + } + }, + "TH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TH" + } + }, + "TL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TL" + } + }, + "TG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TG" + } + }, + "TK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TK" + } + }, + "TO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TO" + } + }, + "TT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TT" + } + }, + "TN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TN" + } + }, + "TR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TR" + } + }, + "TM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TM" + } + }, + "TC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TC" + } + }, + "TV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TV" + } + }, + "UG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UG" + } + }, + "UA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UA" + } + }, + "AE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AE" + } + }, + "GB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GB" + } + }, + "US": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US" + } + }, + "UM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UM" + } + }, + "UY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UY" + } + }, + "UZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UZ" + } + }, + "VU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VU" + } + }, + "VE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VE" + } + }, + "VN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VN" + } + }, + "VG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VG" + } + }, + "VI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VI" + } + }, + "WF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WF" + } + }, + "EH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EH" + } + }, + "YE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "YE" + } + }, + "ZM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZM" + } + }, + "ZW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZW" + } + }, + "XK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "XK" + } + } + } + }, + "com.amazonaws.wafv2#CountryCodes": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#CountryCode" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.wafv2#CreateAPIKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#CreateAPIKeyRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#CreateAPIKeyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFLimitsExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an API key that contains a set of token domains.

\n

API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. \n The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. \n For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.

\n

You can use a single key for up to 5 domains. After you generate a key, you can copy it for use in your JavaScript \n integration.

" + } + }, + "com.amazonaws.wafv2#CreateAPIKeyRequest": { + "type": "structure", + "members": { + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", + "smithy.api#required": {} + } + }, + "TokenDomains": { + "target": "com.amazonaws.wafv2#APIKeyTokenDomains", + "traits": { + "smithy.api#documentation": "

The client application domains that you want to use this API key for.

\n

Example JSON: \"TokenDomains\": [\"abc.com\", \"store.abc.com\"]\n

\n

Public suffixes aren't allowed. For example, you can't use usa.gov or co.uk as token domains.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#CreateAPIKeyResponse": { + "type": "structure", + "members": { + "APIKey": { + "target": "com.amazonaws.wafv2#APIKey", + "traits": { + "smithy.api#documentation": "

The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#CreateIPSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#CreateIPSetRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#CreateIPSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFDuplicateItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFLimitsExceededException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an IPSet, which you use to identify web requests that\n originate from specific IP addresses or ranges of IP addresses. For example, if you're\n receiving a lot of requests from a ranges of IP addresses, you can configure WAF to\n block them using an IPSet that lists those IP addresses.

" + } + }, + "com.amazonaws.wafv2#CreateIPSetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the IP set. You cannot change the name of an IPSet after you create it.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the IP set that helps with identification.

" + } + }, + "IPAddressVersion": { + "target": "com.amazonaws.wafv2#IPAddressVersion", + "traits": { + "smithy.api#documentation": "

The version of the IP addresses, either IPV4 or IPV6.

", + "smithy.api#required": {} + } + }, + "Addresses": { + "target": "com.amazonaws.wafv2#IPAddresses", + "traits": { + "smithy.api#documentation": "

Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

\n

Example address strings:

\n \n

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

\n

Example JSON Addresses specifications:

\n ", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.wafv2#TagList", + "traits": { + "smithy.api#documentation": "

An array of key:value pairs to associate with the resource.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#CreateIPSetResponse": { + "type": "structure", + "members": { + "Summary": { + "target": "com.amazonaws.wafv2#IPSetSummary", + "traits": { + "smithy.api#documentation": "

High-level information about an IPSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage an IPSet, and the ARN, that you provide to the IPSetReferenceStatement to use the address set in a Rule.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#CreateRegexPatternSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#CreateRegexPatternSetRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#CreateRegexPatternSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFDuplicateItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFLimitsExceededException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have WAF inspect a web request\n component for the specified patterns.

" + } + }, + "com.amazonaws.wafv2#CreateRegexPatternSetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the set. You cannot change the name after you create the set.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the set that helps with identification.

" + } + }, + "RegularExpressionList": { + "target": "com.amazonaws.wafv2#RegularExpressionList", + "traits": { + "smithy.api#documentation": "

Array of regular expression strings.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.wafv2#TagList", + "traits": { + "smithy.api#documentation": "

An array of key:value pairs to associate with the resource.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#CreateRegexPatternSetResponse": { + "type": "structure", + "members": { + "Summary": { + "target": "com.amazonaws.wafv2#RegexPatternSetSummary", + "traits": { + "smithy.api#documentation": "

High-level information about a RegexPatternSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RegexPatternSet, and the ARN, that you provide to the RegexPatternSetReferenceStatement to use the pattern set in a Rule.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#CreateRuleGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#CreateRuleGroupRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#CreateRuleGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFDuplicateItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFLimitsExceededException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + }, + { + "target": "com.amazonaws.wafv2#WAFSubscriptionNotFoundException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFUnavailableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a RuleGroup per the specifications provided.

\n

A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

" + } + }, + "com.amazonaws.wafv2#CreateRuleGroupRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the rule group. You cannot change the name of a rule group after you create it.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", + "smithy.api#required": {} + } + }, + "Capacity": { + "target": "com.amazonaws.wafv2#CapacityUnit", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The web ACL capacity units (WCUs) required for this rule group.

\n

When you create your own rule group, you define this, and you cannot change it after creation. \n When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity \n for a set of rules using CheckCapacity.

\n

WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) \n in the WAF Developer Guide.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the rule group that helps with identification.

" + } + }, + "Rules": { + "target": "com.amazonaws.wafv2#Rules", + "traits": { + "smithy.api#documentation": "

The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n

" + } + }, + "VisibilityConfig": { + "target": "com.amazonaws.wafv2#VisibilityConfig", + "traits": { + "smithy.api#documentation": "

Defines and enables Amazon CloudWatch metrics and web request sample collection.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.wafv2#TagList", + "traits": { + "smithy.api#documentation": "

An array of key:value pairs to associate with the resource.

" + } + }, + "CustomResponseBodies": { + "target": "com.amazonaws.wafv2#CustomResponseBodies", + "traits": { + "smithy.api#documentation": "

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas \n in the WAF Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#CreateRuleGroupResponse": { + "type": "structure", + "members": { + "Summary": { + "target": "com.amazonaws.wafv2#RuleGroupSummary", + "traits": { + "smithy.api#documentation": "

High-level information about a RuleGroup, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RuleGroup, and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#CreateWebACL": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#CreateWebACLRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#CreateWebACLResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFConfigurationWarningException" + }, + { + "target": "com.amazonaws.wafv2#WAFDuplicateItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFExpiredManagedRuleGroupVersionException" + }, + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidResourceException" + }, + { + "target": "com.amazonaws.wafv2#WAFLimitsExceededException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + }, + { + "target": "com.amazonaws.wafv2#WAFSubscriptionNotFoundException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFUnavailableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a WebACL per the specifications provided.

\n

A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

" + } + }, + "com.amazonaws.wafv2#CreateWebACLRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the web ACL. You cannot change the name of a web ACL after you create it.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", + "smithy.api#required": {} + } + }, + "DefaultAction": { + "target": "com.amazonaws.wafv2#DefaultAction", + "traits": { + "smithy.api#documentation": "

The action to perform if none of the Rules contained in the WebACL match.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the web ACL that helps with identification.

" + } + }, + "Rules": { + "target": "com.amazonaws.wafv2#Rules", + "traits": { + "smithy.api#documentation": "

The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n

" + } + }, + "VisibilityConfig": { + "target": "com.amazonaws.wafv2#VisibilityConfig", + "traits": { + "smithy.api#documentation": "

Defines and enables Amazon CloudWatch metrics and web request sample collection.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.wafv2#TagList", + "traits": { + "smithy.api#documentation": "

An array of key:value pairs to associate with the resource.

" + } + }, + "CustomResponseBodies": { + "target": "com.amazonaws.wafv2#CustomResponseBodies", + "traits": { + "smithy.api#documentation": "

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas \n in the WAF Developer Guide.

" + } + }, + "CaptchaConfig": { + "target": "com.amazonaws.wafv2#CaptchaConfig", + "traits": { + "smithy.api#documentation": "

Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its default settings for CaptchaConfig.

" + } + }, + "ChallengeConfig": { + "target": "com.amazonaws.wafv2#ChallengeConfig", + "traits": { + "smithy.api#documentation": "

Specifies how WAF should handle challenge evaluations for rules that don't have \ntheir own ChallengeConfig settings. If you don't specify this, WAF uses its default settings for ChallengeConfig.

" + } + }, + "TokenDomains": { + "target": "com.amazonaws.wafv2#TokenDomains", + "traits": { + "smithy.api#documentation": "

Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.

\n

Example JSON: \"TokenDomains\": { \"mywebsite.com\", \"myotherwebsite.com\" }\n

\n

Public suffixes aren't allowed. For example, you can't use usa.gov or co.uk as token domains.

" + } + }, + "AssociationConfig": { + "target": "com.amazonaws.wafv2#AssociationConfig", + "traits": { + "smithy.api#documentation": "

Specifies custom configurations for the associations between the web ACL and protected resources.

\n

Use this to customize the maximum size of the request body that your protected CloudFront distributions forward to WAF for inspection. The default is 16 KB (16,384 kilobytes).

\n \n

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#CreateWebACLResponse": { + "type": "structure", + "members": { + "Summary": { + "target": "com.amazonaws.wafv2#WebACLSummary", + "traits": { + "smithy.api#documentation": "

High-level information about a WebACL, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a WebACL, and the ARN, that you provide to operations like AssociateWebACL.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#CreationPathString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.wafv2#CustomHTTPHeader": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#CustomHTTPHeaderName", + "traits": { + "smithy.api#documentation": "

The name of the custom header.

\n

For custom request header insertion, when WAF inserts the header into the request,\n it prefixes this name x-amzn-waf-, to avoid confusion with the headers that\n are already in the request. For example, for the header name sample, WAF\n inserts the header x-amzn-waf-sample.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.wafv2#CustomHTTPHeaderValue", + "traits": { + "smithy.api#documentation": "

The value of the custom header.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling.

" + } + }, + "com.amazonaws.wafv2#CustomHTTPHeaderName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._$-]+$" + } + }, + "com.amazonaws.wafv2#CustomHTTPHeaderValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.wafv2#CustomHTTPHeaders": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#CustomHTTPHeader" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.wafv2#CustomRequestHandling": { + "type": "structure", + "members": { + "InsertHeaders": { + "target": "com.amazonaws.wafv2#CustomHTTPHeaders", + "traits": { + "smithy.api#documentation": "

The HTTP headers to insert into the request. Duplicate header names are not allowed.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas \n in the WAF Developer Guide.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Custom request handling behavior that inserts custom headers into a web request. You can\n add custom request handling for WAF to use when the rule action doesn't block the request. \n For example, CaptchaAction for requests with valid t okens, and AllowAction.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

" + } + }, + "com.amazonaws.wafv2#CustomResponse": { + "type": "structure", + "members": { + "ResponseCode": { + "target": "com.amazonaws.wafv2#ResponseStatusCode", + "traits": { + "smithy.api#documentation": "

The HTTP status code to return to the client.

\n

For a list of status codes that you can use in your custom responses, see Supported status codes for custom response \n in the WAF Developer Guide.

", + "smithy.api#required": {} + } + }, + "CustomResponseBodyKey": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

References the response body that you want WAF to return to the web request\n client. You can define a custom response for a rule action or a default web ACL action that\n is set to block. To do this, you first define the response body key and value in the\n CustomResponseBodies setting for the WebACL or RuleGroup where you want to use it. Then, in the rule action or web ACL\n default action BlockAction setting, you reference the response body using this\n key.

" + } + }, + "ResponseHeaders": { + "target": "com.amazonaws.wafv2#CustomHTTPHeaders", + "traits": { + "smithy.api#documentation": "

The HTTP headers to use in the response. Duplicate header names are not allowed.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas \n in the WAF Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A custom response to send to the client. You can define a custom response for rule\n actions and default web ACL actions that are set to BlockAction.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

" + } + }, + "com.amazonaws.wafv2#CustomResponseBodies": { + "type": "map", + "key": { + "target": "com.amazonaws.wafv2#EntityName" + }, + "value": { + "target": "com.amazonaws.wafv2#CustomResponseBody" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.wafv2#CustomResponseBody": { + "type": "structure", + "members": { + "ContentType": { + "target": "com.amazonaws.wafv2#ResponseContentType", + "traits": { + "smithy.api#documentation": "

The type of content in the payload that you are defining in the Content\n string.

", + "smithy.api#required": {} + } + }, + "Content": { + "target": "com.amazonaws.wafv2#ResponseContent", + "traits": { + "smithy.api#documentation": "

The payload of the custom response.

\n

You can use JSON escape strings in JSON content. To do this, you must specify JSON\n content in the ContentType setting.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas \n in the WAF Developer Guide.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The response body to use in a custom response to a web request. This is referenced by\n key from CustomResponse\n CustomResponseBodyKey.

" + } + }, + "com.amazonaws.wafv2#DefaultAction": { + "type": "structure", + "members": { + "Block": { + "target": "com.amazonaws.wafv2#BlockAction", + "traits": { + "smithy.api#documentation": "

Specifies that WAF should block requests by default.

" + } + }, + "Allow": { + "target": "com.amazonaws.wafv2#AllowAction", + "traits": { + "smithy.api#documentation": "

Specifies that WAF should allow requests by default.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

In a WebACL, this is the action that you want WAF to perform\n when a web request doesn't match any of the rules in the WebACL. The default\n action must be a terminating action.

" + } + }, + "com.amazonaws.wafv2#DeleteFirewallManagerRuleGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#DeleteFirewallManagerRuleGroupsRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#DeleteFirewallManagerRuleGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes all rule groups that are managed by Firewall Manager for the specified web ACL.

\n

You can only use this if ManagedByFirewallManager is false in the specified\n WebACL.

" + } + }, + "com.amazonaws.wafv2#DeleteFirewallManagerRuleGroupsRequest": { + "type": "structure", + "members": { + "WebACLArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the web ACL.

", + "smithy.api#required": {} + } + }, + "WebACLLockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#DeleteFirewallManagerRuleGroupsResponse": { + "type": "structure", + "members": { + "NextWebACLLockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#DeleteIPSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#DeleteIPSetRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#DeleteIPSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFAssociatedItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified IPSet.

" + } + }, + "com.amazonaws.wafv2#DeleteIPSetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the IP set. You cannot change the name of an IPSet after you create it.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", + "smithy.api#required": {} + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#DeleteIPSetResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#DeleteLoggingConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#DeleteLoggingConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#DeleteLoggingConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the LoggingConfiguration from the specified web ACL.

" + } + }, + "com.amazonaws.wafv2#DeleteLoggingConfigurationRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the web ACL from which you want to delete the LoggingConfiguration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#DeleteLoggingConfigurationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#DeletePermissionPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#DeletePermissionPolicyRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#DeletePermissionPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + } + ], + "traits": { + "smithy.api#documentation": "

Permanently deletes an IAM policy from the specified rule group.

\n

You must be the owner of the rule group to perform this operation.

" + } + }, + "com.amazonaws.wafv2#DeletePermissionPolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule group from which you want to delete the\n policy.

\n

You must be the owner of the rule group to perform this operation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#DeletePermissionPolicyResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#DeleteRegexPatternSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#DeleteRegexPatternSetRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#DeleteRegexPatternSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFAssociatedItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified RegexPatternSet.

" + } + }, + "com.amazonaws.wafv2#DeleteRegexPatternSetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the set. You cannot change the name after you create the set.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", + "smithy.api#required": {} + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#DeleteRegexPatternSetResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#DeleteRuleGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#DeleteRuleGroupRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#DeleteRuleGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFAssociatedItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified RuleGroup.

" + } + }, + "com.amazonaws.wafv2#DeleteRuleGroupRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the rule group. You cannot change the name of a rule group after you create it.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", + "smithy.api#required": {} + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#DeleteRuleGroupResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#DeleteWebACL": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#DeleteWebACLRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#DeleteWebACLResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFAssociatedItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified WebACL.

\n

You can only use this if ManagedByFirewallManager is false in the specified\n WebACL.

\n \n

Before deleting any web ACL, first disassociate it from all resources.

\n \n " + } + }, + "com.amazonaws.wafv2#DeleteWebACLRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the web ACL. You cannot change the name of a web ACL after you create it.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", + "smithy.api#required": {} + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#DeleteWebACLResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#DescribeAllManagedProducts": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#DescribeAllManagedProductsRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#DescribeAllManagedProductsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides high-level information for the Amazon Web Services Managed Rules rule groups and Amazon Web Services Marketplace managed rule groups.

" + } + }, + "com.amazonaws.wafv2#DescribeAllManagedProductsRequest": { + "type": "structure", + "members": { + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#DescribeAllManagedProductsResponse": { + "type": "structure", + "members": { + "ManagedProducts": { + "target": "com.amazonaws.wafv2#ManagedProductDescriptors", + "traits": { + "smithy.api#documentation": "

High-level information for the Amazon Web Services Managed Rules rule groups and Amazon Web Services Marketplace managed rule groups.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#DescribeManagedProductsByVendor": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#DescribeManagedProductsByVendorRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#DescribeManagedProductsByVendorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides high-level information for the managed rule groups owned by a specific vendor.

" + } + }, + "com.amazonaws.wafv2#DescribeManagedProductsByVendorRequest": { + "type": "structure", + "members": { + "VendorName": { + "target": "com.amazonaws.wafv2#VendorName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#DescribeManagedProductsByVendorResponse": { + "type": "structure", + "members": { + "ManagedProducts": { + "target": "com.amazonaws.wafv2#ManagedProductDescriptors", + "traits": { + "smithy.api#documentation": "

High-level information for the managed rule groups owned by the specified vendor.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#DescribeManagedRuleGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#DescribeManagedRuleGroupRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#DescribeManagedRuleGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFExpiredManagedRuleGroupVersionException" + }, + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidResourceException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides high-level information for a managed rule group, including descriptions of the rules.

" + } + }, + "com.amazonaws.wafv2#DescribeManagedRuleGroupRequest": { + "type": "structure", + "members": { + "VendorName": { + "target": "com.amazonaws.wafv2#VendorName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", + "smithy.api#required": {} + } + }, + "VersionName": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "

The version of the rule group. You can only use a version that is not scheduled for\n expiration. If you don't provide this, WAF uses the vendor's default version.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#DescribeManagedRuleGroupResponse": { + "type": "structure", + "members": { + "VersionName": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "

The managed rule group's version.

" + } + }, + "SnsTopicArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to provide notification of changes\n to the managed rule group. You can subscribe to the SNS topic to receive notifications when\n the managed rule group is modified, such as for new versions and for version expiration.\n For more information, see the Amazon Simple Notification Service Developer Guide.

" + } + }, + "Capacity": { + "target": "com.amazonaws.wafv2#CapacityUnit", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The web ACL capacity units (WCUs) required for this rule group.

\n

WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) \n in the WAF Developer Guide.

" + } + }, + "Rules": { + "target": "com.amazonaws.wafv2#RuleSummaries", + "traits": { + "smithy.api#documentation": "

" + } + }, + "LabelNamespace": { + "target": "com.amazonaws.wafv2#LabelName", + "traits": { + "smithy.api#documentation": "

The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.

\n " + } + }, + "AvailableLabels": { + "target": "com.amazonaws.wafv2#LabelSummaries", + "traits": { + "smithy.api#documentation": "

The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the RuleLabels for a Rule.

" + } + }, + "ConsumedLabels": { + "target": "com.amazonaws.wafv2#LabelSummaries", + "traits": { + "smithy.api#documentation": "

The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#DisassociateWebACL": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#DisassociateWebACLRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#DisassociateWebACLResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates the specified regional application resource from any existing web ACL\n association. A resource can have at most one web ACL association. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To\n disassociate a web ACL, provide an empty web ACL ID in the CloudFront call\n UpdateDistribution. For information, see UpdateDistribution in the Amazon CloudFront API Reference.

" + } + }, + "com.amazonaws.wafv2#DisassociateWebACLRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to disassociate from the web ACL.

\n

The ARN must be in one of the following formats:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#DisassociateWebACLResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#DownloadUrl": { + "type": "string" + }, + "com.amazonaws.wafv2#EmailField": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.wafv2#FieldIdentifier", + "traits": { + "smithy.api#documentation": "

The name of the email field.

\n

How you specify this depends on the request inspection payload type.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The name of the field in the request payload that contains your customer's email.

\n

This data type is used in the RequestInspectionACFP data type.

" + } + }, + "com.amazonaws.wafv2#EntityDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[\\w+=:#@/\\-,\\.][\\w+=:#@/\\-,\\.\\s]+[\\w+=:#@/\\-,\\.]$" + } + }, + "com.amazonaws.wafv2#EntityId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 36 + }, + "smithy.api#pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$" + } + }, + "com.amazonaws.wafv2#EntityName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\w\\-]+$" + } + }, + "com.amazonaws.wafv2#ErrorMessage": { + "type": "string" + }, + "com.amazonaws.wafv2#ErrorReason": { + "type": "string" + }, + "com.amazonaws.wafv2#ExcludedRule": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the rule whose action you want to override to Count.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a single rule in a rule group whose action you want to override to Count.

\n \n

Instead of this option, use RuleActionOverrides. It accepts any valid action setting, including Count.

\n " + } + }, + "com.amazonaws.wafv2#ExcludedRules": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#ExcludedRule" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.wafv2#FailureCode": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 999 + } + } + }, + "com.amazonaws.wafv2#FailureReason": { + "type": "enum", + "members": { + "TOKEN_MISSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOKEN_MISSING" + } + }, + "TOKEN_EXPIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOKEN_EXPIRED" + } + }, + "TOKEN_INVALID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOKEN_INVALID" + } + }, + "TOKEN_DOMAIN_MISMATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOKEN_DOMAIN_MISMATCH" + } + } + } + }, + "com.amazonaws.wafv2#FailureValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.wafv2#FallbackBehavior": { + "type": "enum", + "members": { + "MATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MATCH" + } + }, + "NO_MATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_MATCH" + } + } + } + }, + "com.amazonaws.wafv2#FieldIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.wafv2#FieldToMatch": { + "type": "structure", + "members": { + "SingleHeader": { + "target": "com.amazonaws.wafv2#SingleHeader", + "traits": { + "smithy.api#documentation": "

Inspect a single header. Provide the name of the header to inspect, for example,\n User-Agent or Referer. This setting isn't case\n sensitive.

\n

Example JSON: \"SingleHeader\": { \"Name\": \"haystack\" }\n

\n

Alternately, you can filter and inspect all headers with the Headers\n FieldToMatch setting.

" + } + }, + "SingleQueryArgument": { + "target": "com.amazonaws.wafv2#SingleQueryArgument", + "traits": { + "smithy.api#documentation": "

Inspect a single query argument. Provide the name of the query argument to inspect, such\n as UserName or SalesRegion. The name can be up to\n 30 characters long and isn't case sensitive.

\n

Example JSON: \"SingleQueryArgument\": { \"Name\": \"myArgument\" }\n

" + } + }, + "AllQueryArguments": { + "target": "com.amazonaws.wafv2#AllQueryArguments", + "traits": { + "smithy.api#documentation": "

Inspect all query arguments.

" + } + }, + "UriPath": { + "target": "com.amazonaws.wafv2#UriPath", + "traits": { + "smithy.api#documentation": "

Inspect the request URI path. This is the part of the web request that identifies a\n resource, for example, /images/daily-ad.jpg.

" + } + }, + "QueryString": { + "target": "com.amazonaws.wafv2#QueryString", + "traits": { + "smithy.api#documentation": "

Inspect the query string. This is the part of a URL that appears after a ?\n character, if any.

" + } + }, + "Body": { + "target": "com.amazonaws.wafv2#Body", + "traits": { + "smithy.api#documentation": "

Inspect the request body as plain text. The request body immediately follows the request\n headers. This is the part of a request that contains any additional data that you want to\n send to your web server as the HTTP request body, such as data from a form.

\n

A limited amount of the request body is forwarded to WAF for\n inspection by the underlying host service. For regional resources, the limit is 8 KB (8,192 kilobytes) and for CloudFront distributions, the limit is 16 KB (16,384 kilobytes). For CloudFront distributions,\n you can increase the limit in the web ACL's AssociationConfig, for additional processing fees.

\n

For information about how to handle oversized\n request bodies, see the Body object configuration.

" + } + }, + "Method": { + "target": "com.amazonaws.wafv2#Method", + "traits": { + "smithy.api#documentation": "

Inspect the HTTP method. The method indicates the type of operation that the request is\n asking the origin to perform.

" + } + }, + "JsonBody": { + "target": "com.amazonaws.wafv2#JsonBody", + "traits": { + "smithy.api#documentation": "

Inspect the request body as JSON. The request body immediately follows the request\n headers. This is the part of a request that contains any additional data that you want to\n send to your web server as the HTTP request body, such as data from a form.

\n

A limited amount of the request body is forwarded to WAF for\n inspection by the underlying host service. For regional resources, the limit is 8 KB (8,192 kilobytes) and for CloudFront distributions, the limit is 16 KB (16,384 kilobytes). For CloudFront distributions,\n you can increase the limit in the web ACL's AssociationConfig, for additional processing fees.

\n

For information about how to handle oversized\n request bodies, see the JsonBody object configuration.

" + } + }, + "Headers": { + "target": "com.amazonaws.wafv2#Headers", + "traits": { + "smithy.api#documentation": "

Inspect the request headers. You must configure scope and pattern matching filters in\n the Headers object, to define the set of headers to and the parts of the\n headers that WAF inspects.

\n

Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers\n are forwarded to WAF for inspection by the underlying host service. You must\n configure how to handle any oversize header content in the Headers object.\n WAF applies the pattern matching filters to the headers that it receives from the\n underlying host service.

" + } + }, + "Cookies": { + "target": "com.amazonaws.wafv2#Cookies", + "traits": { + "smithy.api#documentation": "

Inspect the request cookies. You must configure scope and pattern matching filters in\n the Cookies object, to define the set of cookies and the parts of the cookies\n that WAF inspects.

\n

Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies\n are forwarded to WAF for inspection by the underlying host service. You must\n configure how to handle any oversize cookie content in the Cookies object.\n WAF applies the pattern matching filters to the cookies that it receives from the\n underlying host service.

" + } + }, + "HeaderOrder": { + "target": "com.amazonaws.wafv2#HeaderOrder", + "traits": { + "smithy.api#documentation": "

Inspect a string containing the list of the request's header names, ordered as they appear in the web request\nthat WAF receives for inspection. \n WAF generates the string and then uses that as the field to match component in its inspection. \n WAF separates the header names in the string using colons and no added spaces, for example host:user-agent:accept:authorization:referer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The part of the web request that you want WAF to inspect. Include the single\n FieldToMatch type that you want to inspect, with additional specifications\n as needed, according to the type. You specify a single request component in\n FieldToMatch for each rule statement that requires it. To inspect more than\n one component of the web request, create a separate rule statement for each\n component.

\n

Example JSON for a QueryString field to match:

\n

\n \"FieldToMatch\": { \"QueryString\": {} }\n

\n

Example JSON for a Method field to match specification:

\n

\n \"FieldToMatch\": { \"Method\": { \"Name\": \"DELETE\" } }\n

" + } + }, + "com.amazonaws.wafv2#FieldToMatchData": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.wafv2#Filter": { + "type": "structure", + "members": { + "Behavior": { + "target": "com.amazonaws.wafv2#FilterBehavior", + "traits": { + "smithy.api#documentation": "

How to handle logs that satisfy the filter's conditions and requirement.

", + "smithy.api#required": {} + } + }, + "Requirement": { + "target": "com.amazonaws.wafv2#FilterRequirement", + "traits": { + "smithy.api#documentation": "

Logic to apply to the filtering conditions. You can specify that, in order to satisfy\n the filter, a log must match all conditions or must match at least one condition.

", + "smithy.api#required": {} + } + }, + "Conditions": { + "target": "com.amazonaws.wafv2#Conditions", + "traits": { + "smithy.api#documentation": "

Match conditions for the filter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A single logging filter, used in LoggingFilter.

" + } + }, + "com.amazonaws.wafv2#FilterBehavior": { + "type": "enum", + "members": { + "KEEP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KEEP" + } + }, + "DROP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DROP" + } + } + } + }, + "com.amazonaws.wafv2#FilterRequirement": { + "type": "enum", + "members": { + "MEETS_ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEETS_ALL" + } + }, + "MEETS_ANY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEETS_ANY" + } + } + } + }, + "com.amazonaws.wafv2#Filters": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#Filter" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.wafv2#FirewallManagerRuleGroup": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the rule group. You cannot change the name of a rule group after you create it.

", + "smithy.api#required": {} + } + }, + "Priority": { + "target": "com.amazonaws.wafv2#RulePriority", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

If you define more than one rule group in the first or last Firewall Manager rule groups, WAF\n evaluates each request against the rule groups in order, starting from the lowest priority\n setting. The priorities don't need to be consecutive, but they must all be\n different.

", + "smithy.api#required": {} + } + }, + "FirewallManagerStatement": { + "target": "com.amazonaws.wafv2#FirewallManagerStatement", + "traits": { + "smithy.api#documentation": "

The processing guidance for an Firewall Manager rule. This is like a regular rule Statement, but it can only contain a rule group reference.

", + "smithy.api#required": {} + } + }, + "OverrideAction": { + "target": "com.amazonaws.wafv2#OverrideAction", + "traits": { + "smithy.api#documentation": "

The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.

\n

You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

\n \n

This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count \n matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings.

\n ", + "smithy.api#required": {} + } + }, + "VisibilityConfig": { + "target": "com.amazonaws.wafv2#VisibilityConfig", + "traits": { + "smithy.api#documentation": "

Defines and enables Amazon CloudWatch metrics and web request sample collection.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A rule group that's defined for an Firewall Manager WAF policy.

" + } + }, + "com.amazonaws.wafv2#FirewallManagerRuleGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#FirewallManagerRuleGroup" + } + }, + "com.amazonaws.wafv2#FirewallManagerStatement": { + "type": "structure", + "members": { + "ManagedRuleGroupStatement": { + "target": "com.amazonaws.wafv2#ManagedRuleGroupStatement", + "traits": { + "smithy.api#documentation": "

A statement used by Firewall Manager to run the rules that are defined in a managed rule group. This is managed by Firewall Manager for an Firewall Manager WAF policy.

" + } + }, + "RuleGroupReferenceStatement": { + "target": "com.amazonaws.wafv2#RuleGroupReferenceStatement", + "traits": { + "smithy.api#documentation": "

A statement used by Firewall Manager to run the rules that are defined in a rule group. This is managed by Firewall Manager for an Firewall Manager WAF policy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The processing guidance for an Firewall Manager rule. This is like a regular rule Statement, but it can only contain a single rule group reference.

" + } + }, + "com.amazonaws.wafv2#ForwardedIPConfig": { + "type": "structure", + "members": { + "HeaderName": { + "target": "com.amazonaws.wafv2#ForwardedIPHeaderName", + "traits": { + "smithy.api#documentation": "

The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

\n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n ", + "smithy.api#required": {} + } + }, + "FallbackBehavior": { + "target": "com.amazonaws.wafv2#FallbackBehavior", + "traits": { + "smithy.api#documentation": "

The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

\n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n \n

You can specify the following fallback behaviors:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n \n

This configuration is used for GeoMatchStatement and RateBasedStatement. For IPSetReferenceStatement, use IPSetForwardedIPConfig instead.

\n

WAF only evaluates the first IP address found in the specified HTTP header.\n

" + } + }, + "com.amazonaws.wafv2#ForwardedIPHeaderName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.wafv2#ForwardedIPPosition": { + "type": "enum", + "members": { + "FIRST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIRST" + } + }, + "LAST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAST" + } + }, + "ANY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANY" + } + } + } + }, + "com.amazonaws.wafv2#GenerateMobileSdkReleaseUrl": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#GenerateMobileSdkReleaseUrlRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#GenerateMobileSdkReleaseUrlResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + } + ], + "traits": { + "smithy.api#documentation": "

Generates a presigned download URL for the specified release of the mobile SDK.

\n

The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see \nWAF client application integration in the WAF Developer Guide.

" + } + }, + "com.amazonaws.wafv2#GenerateMobileSdkReleaseUrlRequest": { + "type": "structure", + "members": { + "Platform": { + "target": "com.amazonaws.wafv2#Platform", + "traits": { + "smithy.api#documentation": "

The device platform.

", + "smithy.api#required": {} + } + }, + "ReleaseVersion": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "

The release version. For the latest available version, specify\n LATEST.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#GenerateMobileSdkReleaseUrlResponse": { + "type": "structure", + "members": { + "Url": { + "target": "com.amazonaws.wafv2#DownloadUrl", + "traits": { + "smithy.api#documentation": "

The presigned download URL for the specified SDK release.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#GeoMatchStatement": { + "type": "structure", + "members": { + "CountryCodes": { + "target": "com.amazonaws.wafv2#CountryCodes", + "traits": { + "smithy.api#documentation": "

An array of two-character country codes that you want to match against, for example, [ \"US\", \"CN\" ], from\n the alpha-2 country ISO codes of the ISO 3166 international standard.

\n

When you use a geo match statement just for the region and country labels that it adds to requests, you still have to supply a country code for the rule to evaluate. In this case, you configure the rule to only count matching requests, but it will still generate logging and count metrics for any matches. You can reduce the logging and metrics that the rule produces by specifying a country that's unlikely to be a source of traffic to your site.

" + } + }, + "ForwardedIPConfig": { + "target": "com.amazonaws.wafv2#ForwardedIPConfig", + "traits": { + "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

A rule statement that labels web requests by country and region and that matches against web requests based on country code. A geo match rule labels every request that it inspects regardless of whether it finds a match.

\n \n

WAF labels requests using the alpha-2 country and region codes from the International Organization for Standardization (ISO) 3166 standard. WAF determines the codes using either the IP address in the web request origin or, if you specify it, the address in the geo match ForwardedIPConfig.

\n

If you use the web request origin, the label formats are awswaf:clientip:geo:region:- and awswaf:clientip:geo:country:.

\n

If you use a forwarded IP address, the label formats are awswaf:forwardedip:geo:region:- and awswaf:forwardedip:geo:country:.

\n

For additional details, see Geographic match rule statement in the WAF Developer Guide.

" + } + }, + "com.amazonaws.wafv2#GetDecryptedAPIKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#GetDecryptedAPIKeyRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#GetDecryptedAPIKeyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidResourceException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns your API key in decrypted form. Use this to check the token domains that you have defined for the key.

\n

API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. \n The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. \n For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.

" + } + }, + "com.amazonaws.wafv2#GetDecryptedAPIKeyRequest": { + "type": "structure", + "members": { + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", + "smithy.api#required": {} + } + }, + "APIKey": { + "target": "com.amazonaws.wafv2#APIKey", + "traits": { + "smithy.api#documentation": "

The encrypted API key.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#GetDecryptedAPIKeyResponse": { + "type": "structure", + "members": { + "TokenDomains": { + "target": "com.amazonaws.wafv2#TokenDomains", + "traits": { + "smithy.api#documentation": "

The token domains that are defined in this API key.

" + } + }, + "CreationTimestamp": { + "target": "com.amazonaws.wafv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the key was created.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#GetIPSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#GetIPSetRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#GetIPSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the specified IPSet.

" + } + }, + "com.amazonaws.wafv2#GetIPSetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the IP set. You cannot change the name of an IPSet after you create it.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#GetIPSetResponse": { + "type": "structure", + "members": { + "IPSet": { + "target": "com.amazonaws.wafv2#IPSet", + "traits": { + "smithy.api#documentation": "

" + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#GetLoggingConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#GetLoggingConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#GetLoggingConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the LoggingConfiguration for the specified web ACL.

" + } + }, + "com.amazonaws.wafv2#GetLoggingConfigurationRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the web ACL for which you want to get the LoggingConfiguration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#GetLoggingConfigurationResponse": { + "type": "structure", + "members": { + "LoggingConfiguration": { + "target": "com.amazonaws.wafv2#LoggingConfiguration", + "traits": { + "smithy.api#documentation": "

The LoggingConfiguration for the specified web ACL.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#GetManagedRuleSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#GetManagedRuleSetRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#GetManagedRuleSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the specified managed rule set.

\n \n

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

\n

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

\n " + } + }, + "com.amazonaws.wafv2#GetManagedRuleSetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

\n

This name is assigned to the corresponding managed rule group, which your customers can access and use.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#GetManagedRuleSetResponse": { + "type": "structure", + "members": { + "ManagedRuleSet": { + "target": "com.amazonaws.wafv2#ManagedRuleSet", + "traits": { + "smithy.api#documentation": "

The managed rule set that you requested.

" + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#GetMobileSdkRelease": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#GetMobileSdkReleaseRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#GetMobileSdkReleaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information for the specified mobile SDK release, including release notes and\n tags.

\n

The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see \nWAF client application integration in the WAF Developer Guide.

" + } + }, + "com.amazonaws.wafv2#GetMobileSdkReleaseRequest": { + "type": "structure", + "members": { + "Platform": { + "target": "com.amazonaws.wafv2#Platform", + "traits": { + "smithy.api#documentation": "

The device platform.

", + "smithy.api#required": {} + } + }, + "ReleaseVersion": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "

The release version. For the latest available version, specify\n LATEST.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#GetMobileSdkReleaseResponse": { + "type": "structure", + "members": { + "MobileSdkRelease": { + "target": "com.amazonaws.wafv2#MobileSdkRelease", + "traits": { + "smithy.api#documentation": "

Information for a specified SDK release, including release notes and tags.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#GetPermissionPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#GetPermissionPolicyRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#GetPermissionPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the IAM policy that is attached to the specified rule group.

\n

You must be the owner of the rule group to perform this operation.

" + } + }, + "com.amazonaws.wafv2#GetPermissionPolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule group for which you want to get the\n policy.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#GetPermissionPolicyResponse": { + "type": "structure", + "members": { + "Policy": { + "target": "com.amazonaws.wafv2#PolicyString", + "traits": { + "smithy.api#documentation": "

The IAM policy that is attached to the specified rule group.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#GetRateBasedStatementManagedKeys": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#GetRateBasedStatementManagedKeysRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#GetRateBasedStatementManagedKeysResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFUnsupportedAggregateKeyTypeException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the IP addresses that are currently blocked by a rate-based rule instance. This\n is only available for rate-based rules that aggregate solely on the IP address or on the forwarded IP \n address.

\n

The maximum\n number of addresses that can be blocked for a single rate-based rule instance is 10,000.\n If more than 10,000 addresses exceed the rate limit, those with the highest rates are\n blocked.

\n

For a rate-based rule that you've defined inside a rule group, provide the name of the\n rule group reference statement in your request, in addition to the rate-based rule name and\n the web ACL name.

\n

WAF monitors web requests and manages keys independently for each unique combination\n of web ACL, optional rule group, and rate-based rule. For example, if you define a\n rate-based rule inside a rule group, and then use the rule group in a web ACL, WAF\n monitors web requests and manages keys for that web ACL, rule group reference statement,\n and rate-based rule instance. If you use the same rule group in a second web ACL, WAF\n monitors web requests and manages keys for this second usage completely independent of your\n first.

" + } + }, + "com.amazonaws.wafv2#GetRateBasedStatementManagedKeysRequest": { + "type": "structure", + "members": { + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", + "smithy.api#required": {} + } + }, + "WebACLName": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the web ACL. You cannot change the name of a web ACL after you create it.

", + "smithy.api#required": {} + } + }, + "WebACLId": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", + "smithy.api#required": {} + } + }, + "RuleGroupRuleName": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the rule group reference statement in your web ACL. This is required only\n when you have the rate-based rule nested inside a rule group.

" + } + }, + "RuleName": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the rate-based rule to get the keys for. If you have the rule defined inside\n a rule group that you're using in your web ACL, also provide the name of the rule group\n reference statement in the request parameter RuleGroupRuleName.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#GetRateBasedStatementManagedKeysResponse": { + "type": "structure", + "members": { + "ManagedKeysIPV4": { + "target": "com.amazonaws.wafv2#RateBasedStatementManagedKeysIPSet", + "traits": { + "smithy.api#documentation": "

The keys that are of Internet Protocol version 4 (IPv4).

" + } + }, + "ManagedKeysIPV6": { + "target": "com.amazonaws.wafv2#RateBasedStatementManagedKeysIPSet", + "traits": { + "smithy.api#documentation": "

The keys that are of Internet Protocol version 6 (IPv6).

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#GetRegexPatternSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#GetRegexPatternSetRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#GetRegexPatternSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the specified RegexPatternSet.

" + } + }, + "com.amazonaws.wafv2#GetRegexPatternSetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the set. You cannot change the name after you create the set.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#GetRegexPatternSetResponse": { + "type": "structure", + "members": { + "RegexPatternSet": { + "target": "com.amazonaws.wafv2#RegexPatternSet", + "traits": { + "smithy.api#documentation": "

" + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#GetRuleGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#GetRuleGroupRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#GetRuleGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the specified RuleGroup.

" + } + }, + "com.amazonaws.wafv2#GetRuleGroupRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the rule group. You cannot change the name of a rule group after you create it.

" + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n " + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

" + } + }, + "ARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entity.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#GetRuleGroupResponse": { + "type": "structure", + "members": { + "RuleGroup": { + "target": "com.amazonaws.wafv2#RuleGroup", + "traits": { + "smithy.api#documentation": "

" + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#GetSampledRequests": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#GetSampledRequestsRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#GetSampledRequestsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + } + ], + "traits": { + "smithy.api#documentation": "

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

\n

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

" + } + }, + "com.amazonaws.wafv2#GetSampledRequestsRequest": { + "type": "structure", + "members": { + "WebAclArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) of the WebACL for which you want a sample of\n requests.

", + "smithy.api#required": {} + } + }, + "RuleMetricName": { + "target": "com.amazonaws.wafv2#MetricName", + "traits": { + "smithy.api#documentation": "

The metric name assigned to the Rule or RuleGroup dimension for which\n you want a sample of requests.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", + "smithy.api#required": {} + } + }, + "TimeWindow": { + "target": "com.amazonaws.wafv2#TimeWindow", + "traits": { + "smithy.api#documentation": "

The start date and time and the end date and time of the range for which you want\n GetSampledRequests to return a sample of requests. You must specify the\n times in Coordinated Universal Time (UTC) format. UTC format includes the special\n designator, Z. For example, \"2016-09-27T14:50Z\". You can specify\n any time range in the previous three hours. If you specify a start time that's earlier than\n three hours ago, WAF sets it to three hours ago.

", + "smithy.api#required": {} + } + }, + "MaxItems": { + "target": "com.amazonaws.wafv2#ListMaxItems", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of requests that you want WAF to return from among the first 5,000\n requests that your Amazon Web Services resource received during the time range. If your resource received\n fewer requests than the value of MaxItems, GetSampledRequests\n returns information about all of them.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#GetSampledRequestsResponse": { + "type": "structure", + "members": { + "SampledRequests": { + "target": "com.amazonaws.wafv2#SampledHTTPRequests", + "traits": { + "smithy.api#documentation": "

A complex type that contains detailed information about each of the requests in the\n sample.

" + } + }, + "PopulationSize": { + "target": "com.amazonaws.wafv2#PopulationSize", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of requests from which GetSampledRequests got a sample of\n MaxItems requests. If PopulationSize is less than\n MaxItems, the sample includes every request that your Amazon Web Services resource\n received during the specified time range.

" + } + }, + "TimeWindow": { + "target": "com.amazonaws.wafv2#TimeWindow", + "traits": { + "smithy.api#documentation": "

Usually, TimeWindow is the time range that you specified in the\n GetSampledRequests request. However, if your Amazon Web Services resource received more\n than 5,000 requests during the time range that you specified in the request,\n GetSampledRequests returns the time range for the first 5,000 requests.\n Times are in Coordinated Universal Time (UTC) format.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#GetWebACL": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#GetWebACLRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#GetWebACLResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the specified WebACL.

" + } + }, + "com.amazonaws.wafv2#GetWebACLForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#GetWebACLForResourceRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#GetWebACLForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFUnavailableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the WebACL for the specified resource.

" + } + }, + "com.amazonaws.wafv2#GetWebACLForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource whose web ACL you want to retrieve.

\n

The ARN must be in one of the following formats:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#GetWebACLForResourceResponse": { + "type": "structure", + "members": { + "WebACL": { + "target": "com.amazonaws.wafv2#WebACL", + "traits": { + "smithy.api#documentation": "

The web ACL that is associated with the resource. If there is no associated resource,\n WAF returns a null web ACL.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#GetWebACLRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the web ACL. You cannot change the name of a web ACL after you create it.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#GetWebACLResponse": { + "type": "structure", + "members": { + "WebACL": { + "target": "com.amazonaws.wafv2#WebACL", + "traits": { + "smithy.api#documentation": "

The web ACL specification. You can modify the settings in this web ACL and use it to\n update this web ACL or create a new one.

" + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + } + }, + "ApplicationIntegrationURL": { + "target": "com.amazonaws.wafv2#OutputUrl", + "traits": { + "smithy.api#documentation": "

The URL to use in SDK integrations with Amazon Web Services managed rule groups. For example, you can use the integration SDKs with the account takeover prevention managed rule group AWSManagedRulesATPRuleSet and the account creation fraud prevention managed rule group AWSManagedRulesACFPRuleSet. This is only populated if you are using a rule group in your web ACL that integrates with your applications in this way. For more information, see WAF client application integration \nin the WAF Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#HTTPHeader": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#HeaderName", + "traits": { + "smithy.api#documentation": "

The name of the HTTP header.

" + } + }, + "Value": { + "target": "com.amazonaws.wafv2#HeaderValue", + "traits": { + "smithy.api#documentation": "

The value of the HTTP header.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Part of the response from GetSampledRequests. This is a complex type\n that appears as Headers in the response syntax. HTTPHeader\n contains the names and values of all of the headers that appear in one of the web requests.\n

" + } + }, + "com.amazonaws.wafv2#HTTPHeaders": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#HTTPHeader" + } + }, + "com.amazonaws.wafv2#HTTPMethod": { + "type": "string" + }, + "com.amazonaws.wafv2#HTTPRequest": { + "type": "structure", + "members": { + "ClientIP": { + "target": "com.amazonaws.wafv2#IPString", + "traits": { + "smithy.api#documentation": "

The IP address that the request originated from. If the web ACL is associated with a\n CloudFront distribution, this is the value of one of the following fields in CloudFront access\n logs:

\n " + } + }, + "Country": { + "target": "com.amazonaws.wafv2#Country", + "traits": { + "smithy.api#documentation": "

The two-letter country code for the country that the request originated from. For a\n current list of country codes, see the Wikipedia entry ISO 3166-1\n alpha-2.

" + } + }, + "URI": { + "target": "com.amazonaws.wafv2#URIString", + "traits": { + "smithy.api#documentation": "

The URI path of the request, which identifies the resource, for example,\n /images/daily-ad.jpg.

" + } + }, + "Method": { + "target": "com.amazonaws.wafv2#HTTPMethod", + "traits": { + "smithy.api#documentation": "

The HTTP method specified in the sampled web request.

" + } + }, + "HTTPVersion": { + "target": "com.amazonaws.wafv2#HTTPVersion", + "traits": { + "smithy.api#documentation": "

The HTTP version specified in the sampled web request, for example,\n HTTP/1.1.

" + } + }, + "Headers": { + "target": "com.amazonaws.wafv2#HTTPHeaders", + "traits": { + "smithy.api#documentation": "

A complex type that contains the name and value for each header in the sampled web\n request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Part of the response from GetSampledRequests. This is a complex type\n that appears as Request in the response syntax. HTTPRequest\n contains information about one of the web requests.

" + } + }, + "com.amazonaws.wafv2#HTTPVersion": { + "type": "string" + }, + "com.amazonaws.wafv2#HeaderMatchPattern": { + "type": "structure", + "members": { + "All": { + "target": "com.amazonaws.wafv2#All", + "traits": { + "smithy.api#documentation": "

Inspect all headers.

" + } + }, + "IncludedHeaders": { + "target": "com.amazonaws.wafv2#HeaderNames", + "traits": { + "smithy.api#documentation": "

Inspect only the headers that have a key that matches one of the strings specified here.\n

" + } + }, + "ExcludedHeaders": { + "target": "com.amazonaws.wafv2#HeaderNames", + "traits": { + "smithy.api#documentation": "

Inspect only the headers whose keys don't match any of the strings specified here.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The filter to use to identify the subset of headers to inspect in a web request.

\n

You must specify exactly one setting: either All, IncludedHeaders, or ExcludedHeaders.

\n

Example JSON: \"MatchPattern\": { \"ExcludedHeaders\": {\"KeyToExclude1\", \"KeyToExclude2\"} }\n

" + } + }, + "com.amazonaws.wafv2#HeaderName": { + "type": "string" + }, + "com.amazonaws.wafv2#HeaderNames": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#FieldToMatchData" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 199 + } + } + }, + "com.amazonaws.wafv2#HeaderOrder": { + "type": "structure", + "members": { + "OversizeHandling": { + "target": "com.amazonaws.wafv2#OversizeHandling", + "traits": { + "smithy.api#documentation": "

What WAF should do if the headers of the request are more numerous or larger than WAF can inspect. \n WAF does not support inspecting the entire contents of request headers \n when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers\n and at most 8 KB of header contents to WAF.

\n

The options for oversize handling are the following:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Inspect a string containing the list of the request's header names, ordered as they appear in the web request\nthat WAF receives for inspection. \n WAF generates the string and then uses that as the field to match component in its inspection. \n WAF separates the header names in the string using colons and no added spaces, for example host:user-agent:accept:authorization:referer.

" + } + }, + "com.amazonaws.wafv2#HeaderValue": { + "type": "string" + }, + "com.amazonaws.wafv2#Headers": { + "type": "structure", + "members": { + "MatchPattern": { + "target": "com.amazonaws.wafv2#HeaderMatchPattern", + "traits": { + "smithy.api#documentation": "

The filter to use to identify the subset of headers to inspect in a web request.

\n

You must specify exactly one setting: either All, IncludedHeaders, or ExcludedHeaders.

\n

Example JSON: \"MatchPattern\": { \"ExcludedHeaders\": {\"KeyToExclude1\", \"KeyToExclude2\"} }\n

", + "smithy.api#required": {} + } + }, + "MatchScope": { + "target": "com.amazonaws.wafv2#MapMatchScope", + "traits": { + "smithy.api#documentation": "

The parts of the headers to match with the rule inspection criteria. If you specify\n All, WAF inspects both keys and values.

", + "smithy.api#required": {} + } + }, + "OversizeHandling": { + "target": "com.amazonaws.wafv2#OversizeHandling", + "traits": { + "smithy.api#documentation": "

What WAF should do if the headers of the request are more numerous or larger than WAF can inspect. \n WAF does not support inspecting the entire contents of request headers \n when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers\n and at most 8 KB of header contents to WAF.

\n

The options for oversize handling are the following:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Inspect all headers in the web request. You can specify the parts of the headers to\n inspect and you can narrow the set of headers to inspect by including or excluding specific\n keys.

\n

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

\n

If you want to inspect just the value of a single header, use the\n SingleHeader\n FieldToMatch setting instead.

\n

Example JSON: \"Headers\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"KEY\",\n \"OversizeHandling\": \"MATCH\" }\n

" + } + }, + "com.amazonaws.wafv2#IPAddress": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.wafv2#IPAddressVersion": { + "type": "enum", + "members": { + "IPV4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IPV4" + } + }, + "IPV6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IPV6" + } + } + } + }, + "com.amazonaws.wafv2#IPAddresses": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#IPAddress" + } + }, + "com.amazonaws.wafv2#IPSet": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the IP set. You cannot change the name of an IPSet after you create it.

", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", + "smithy.api#required": {} + } + }, + "ARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entity.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the IP set that helps with identification.

" + } + }, + "IPAddressVersion": { + "target": "com.amazonaws.wafv2#IPAddressVersion", + "traits": { + "smithy.api#documentation": "

The version of the IP addresses, either IPV4 or IPV6.

", + "smithy.api#required": {} + } + }, + "Addresses": { + "target": "com.amazonaws.wafv2#IPAddresses", + "traits": { + "smithy.api#documentation": "

Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

\n

Example address strings:

\n \n

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

\n

Example JSON Addresses specifications:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains zero or more IP addresses or blocks of IP addresses specified in Classless\n Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges\n except for /0. For information about CIDR notation, see the Wikipedia entry Classless\n Inter-Domain Routing.

\n

WAF assigns an ARN to each IPSet that you create. To use an IP set in a\n rule, you provide the ARN to the Rule statement IPSetReferenceStatement.

" + } + }, + "com.amazonaws.wafv2#IPSetForwardedIPConfig": { + "type": "structure", + "members": { + "HeaderName": { + "target": "com.amazonaws.wafv2#ForwardedIPHeaderName", + "traits": { + "smithy.api#documentation": "

The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

\n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n ", + "smithy.api#required": {} + } + }, + "FallbackBehavior": { + "target": "com.amazonaws.wafv2#FallbackBehavior", + "traits": { + "smithy.api#documentation": "

The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

\n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n \n

You can specify the following fallback behaviors:

\n ", + "smithy.api#required": {} + } + }, + "Position": { + "target": "com.amazonaws.wafv2#ForwardedIPPosition", + "traits": { + "smithy.api#documentation": "

The position in the header to search for the IP address. The header can contain IP\n addresses of the original client and also of proxies. For example, the header value could\n be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the\n original client and the rest identify proxies that the request went through.

\n

The options for this setting are the following:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n \n

This configuration is used only for IPSetReferenceStatement. For GeoMatchStatement and RateBasedStatement, use ForwardedIPConfig instead.

" + } + }, + "com.amazonaws.wafv2#IPSetReferenceStatement": { + "type": "structure", + "members": { + "ARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IPSet that this statement\n references.

", + "smithy.api#required": {} + } + }, + "IPSetForwardedIPConfig": { + "target": "com.amazonaws.wafv2#IPSetForwardedIPConfig", + "traits": { + "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.

\n

Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

" + } + }, + "com.amazonaws.wafv2#IPSetSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#IPSetSummary" + } + }, + "com.amazonaws.wafv2#IPSetSummary": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the IP set. You cannot change the name of an IPSet after you create it.

" + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

" + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the IP set that helps with identification.

" + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + } + }, + "ARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entity.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

High-level information about an IPSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage an IPSet, and the ARN, that you provide to the IPSetReferenceStatement to use the address set in a Rule.

" + } + }, + "com.amazonaws.wafv2#IPString": { + "type": "string" + }, + "com.amazonaws.wafv2#ImmunityTimeProperty": { + "type": "structure", + "members": { + "ImmunityTime": { + "target": "com.amazonaws.wafv2#TimeWindowSecond", + "traits": { + "smithy.api#documentation": "

The amount of time, in seconds, that a CAPTCHA or challenge timestamp is considered valid by WAF. The default\n setting is 300.

\n

For the Challenge action, the minimum setting is 300.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Used for CAPTCHA and challenge token settings. Determines \n how long a CAPTCHA or challenge timestamp remains valid after WAF updates it for a successful CAPTCHA or challenge response.

" + } + }, + "com.amazonaws.wafv2#InspectionLevel": { + "type": "enum", + "members": { + "COMMON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMMON" + } + }, + "TARGETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TARGETED" + } + } + } + }, + "com.amazonaws.wafv2#JsonBody": { + "type": "structure", + "members": { + "MatchPattern": { + "target": "com.amazonaws.wafv2#JsonMatchPattern", + "traits": { + "smithy.api#documentation": "

The patterns to look for in the JSON body. WAF inspects the results of these\n pattern matches against the rule inspection criteria.

", + "smithy.api#required": {} + } + }, + "MatchScope": { + "target": "com.amazonaws.wafv2#JsonMatchScope", + "traits": { + "smithy.api#documentation": "

The parts of the JSON to match against using the MatchPattern. If you\n specify All, WAF matches against keys and values.

", + "smithy.api#required": {} + } + }, + "InvalidFallbackBehavior": { + "target": "com.amazonaws.wafv2#BodyParsingFallbackBehavior", + "traits": { + "smithy.api#documentation": "

What WAF should do if it fails to completely parse the JSON body. The options are\n the following:

\n \n

If you don't provide this setting, WAF parses and evaluates the content only up to the\n first parsing failure that it encounters.

\n

WAF does its best to parse the entire JSON body, but might be forced to stop for\n reasons such as invalid characters, duplicate keys, truncation, and any content whose root\n node isn't an object or an array.

\n

WAF parses the JSON in the following examples as two valid key, value pairs:

\n " + } + }, + "OversizeHandling": { + "target": "com.amazonaws.wafv2#OversizeHandling", + "traits": { + "smithy.api#documentation": "

What WAF should do if the body is larger than WAF can inspect. \n WAF does not support inspecting the entire contents of the web request body if the body \n exceeds the limit for the resource type. If the body is larger than the limit, the underlying host service \n only forwards the contents that are below the limit to WAF for inspection.

\n

The default limit is 8 KB (8,192 kilobytes) for regional resources and 16 KB (16,384 kilobytes) for CloudFront distributions. For CloudFront distributions, \n you can increase the limit in the web ACL AssociationConfig, for additional processing fees.

\n

The options for oversize handling are the following:

\n \n

You can combine the MATCH or NO_MATCH\n settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.

\n

Default: CONTINUE\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Inspect the body of the web request as JSON. The body immediately follows the request\n headers.

\n

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

\n

Use the specifications in this object to indicate which parts of the JSON body to\n inspect using the rule's inspection criteria. WAF inspects only the parts of the JSON\n that result from the matches that you indicate.\n

\n

Example JSON: \"JsonBody\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"ALL\"\n }\n

" + } + }, + "com.amazonaws.wafv2#JsonMatchPattern": { + "type": "structure", + "members": { + "All": { + "target": "com.amazonaws.wafv2#All", + "traits": { + "smithy.api#documentation": "

Match all of the elements. See also\n MatchScope\n in JsonBody.

\n

You must specify either this setting or the IncludedPaths setting, but not\n both.

" + } + }, + "IncludedPaths": { + "target": "com.amazonaws.wafv2#JsonPointerPaths", + "traits": { + "smithy.api#documentation": "

Match only the specified include paths. See also\n MatchScope\n in JsonBody.

\n

Provide the include paths using JSON Pointer syntax. For example, \"IncludedPaths\":\n [\"/dogs/0/name\", \"/dogs/1/name\"]. For information about this syntax, see the\n Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON)\n Pointer.

\n

You must specify either this setting or the All setting, but not\n both.

\n \n

Don't use this option to include all paths. Instead, use the All\n setting.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

The patterns to look for in the JSON body. WAF inspects the results of these\n pattern matches against the rule inspection criteria. This is used with the FieldToMatch option JsonBody.

" + } + }, + "com.amazonaws.wafv2#JsonMatchScope": { + "type": "enum", + "members": { + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + }, + "KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KEY" + } + }, + "VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALUE" + } + } + } + }, + "com.amazonaws.wafv2#JsonPointerPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^([/])|([/](([^~])|(~[01]))+)$" + } + }, + "com.amazonaws.wafv2#JsonPointerPaths": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#JsonPointerPath" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.wafv2#Label": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#LabelName", + "traits": { + "smithy.api#documentation": "

The label string.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A single label container. This is used as an element of a label array in multiple\n contexts, for example, in RuleLabels inside a Rule and in\n Labels inside a SampledHTTPRequest.

" + } + }, + "com.amazonaws.wafv2#LabelMatchKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[0-9A-Za-z_\\-:]+$" + } + }, + "com.amazonaws.wafv2#LabelMatchScope": { + "type": "enum", + "members": { + "LABEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LABEL" + } + }, + "NAMESPACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAMESPACE" + } + } + } + }, + "com.amazonaws.wafv2#LabelMatchStatement": { + "type": "structure", + "members": { + "Scope": { + "target": "com.amazonaws.wafv2#LabelMatchScope", + "traits": { + "smithy.api#documentation": "

Specify whether you want to match using the label name or just the namespace.

", + "smithy.api#required": {} + } + }, + "Key": { + "target": "com.amazonaws.wafv2#LabelMatchKey", + "traits": { + "smithy.api#documentation": "

The string to match against. The setting you provide for this depends on the match\n statement's Scope setting:

\n \n

Labels are case sensitive and components of a label must be separated by colon, for\n example NS1:NS2:name.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A rule statement to match against labels that have been added to the web request by rules that have already run in the web ACL.

\n

The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, WAF performs the search for labels that were added in the same context as the label match statement.

" + } + }, + "com.amazonaws.wafv2#LabelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[0-9A-Za-z_\\-:]+$" + } + }, + "com.amazonaws.wafv2#LabelNameCondition": { + "type": "structure", + "members": { + "LabelName": { + "target": "com.amazonaws.wafv2#LabelName", + "traits": { + "smithy.api#documentation": "

The label name that a log record must contain in order to meet the condition. This must\n be a fully qualified label name. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A single label name condition for a Condition in a logging\n filter.

" + } + }, + "com.amazonaws.wafv2#LabelNamespace": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[0-9A-Za-z_\\-:]+:$" + } + }, + "com.amazonaws.wafv2#LabelSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#LabelSummary" + } + }, + "com.amazonaws.wafv2#LabelSummary": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#LabelName", + "traits": { + "smithy.api#documentation": "

An individual label specification.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

List of labels used by one or more of the rules of a RuleGroup. This\n summary object is used for the following rule group lists:

\n " + } + }, + "com.amazonaws.wafv2#Labels": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#Label" + } + }, + "com.amazonaws.wafv2#ListAPIKeys": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#ListAPIKeysRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#ListAPIKeysResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidResourceException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a list of the API keys that you've defined for the specified scope.

\n

API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. \n The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. \n For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.

" + } + }, + "com.amazonaws.wafv2#ListAPIKeysRequest": { + "type": "structure", + "members": { + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", + "smithy.api#required": {} + } + }, + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "Limit": { + "target": "com.amazonaws.wafv2#PaginationLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#ListAPIKeysResponse": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "APIKeySummaries": { + "target": "com.amazonaws.wafv2#APIKeySummaries", + "traits": { + "smithy.api#documentation": "

The array of key summaries. If you specified a Limit in your request, this might not be the full list.

" + } + }, + "ApplicationIntegrationURL": { + "target": "com.amazonaws.wafv2#OutputUrl", + "traits": { + "smithy.api#documentation": "

The CAPTCHA application integration URL, for use in your JavaScript implementation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#ListAvailableManagedRuleGroupVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#ListAvailableManagedRuleGroupVersionsRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#ListAvailableManagedRuleGroupVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of the available versions for the specified managed rule group.

" + } + }, + "com.amazonaws.wafv2#ListAvailableManagedRuleGroupVersionsRequest": { + "type": "structure", + "members": { + "VendorName": { + "target": "com.amazonaws.wafv2#VendorName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", + "smithy.api#required": {} + } + }, + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "Limit": { + "target": "com.amazonaws.wafv2#PaginationLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#ListAvailableManagedRuleGroupVersionsResponse": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "Versions": { + "target": "com.amazonaws.wafv2#ManagedRuleGroupVersions", + "traits": { + "smithy.api#documentation": "

The versions that are currently available for the specified managed rule group. If you specified a Limit in your request, this might not be the full list.

" + } + }, + "CurrentDefaultVersion": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "

The name of the version that's currently set as the default.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#ListAvailableManagedRuleGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#ListAvailableManagedRuleGroupsRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#ListAvailableManagedRuleGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves an array of managed rule groups that are available for you to use. This list\n includes all Amazon Web Services Managed Rules rule groups and all of the Amazon Web Services Marketplace managed rule groups that you're\n subscribed to.

" + } + }, + "com.amazonaws.wafv2#ListAvailableManagedRuleGroupsRequest": { + "type": "structure", + "members": { + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", + "smithy.api#required": {} + } + }, + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "Limit": { + "target": "com.amazonaws.wafv2#PaginationLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#ListAvailableManagedRuleGroupsResponse": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "ManagedRuleGroups": { + "target": "com.amazonaws.wafv2#ManagedRuleGroupSummaries", + "traits": { + "smithy.api#documentation": "

Array of managed rule groups that you can use. If you specified a Limit in your request, this might not be the full list.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#ListIPSets": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#ListIPSetsRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#ListIPSetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves an array of IPSetSummary objects for the IP sets that you\n manage.

" + } + }, + "com.amazonaws.wafv2#ListIPSetsRequest": { + "type": "structure", + "members": { + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", + "smithy.api#required": {} + } + }, + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "Limit": { + "target": "com.amazonaws.wafv2#PaginationLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#ListIPSetsResponse": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "IPSets": { + "target": "com.amazonaws.wafv2#IPSetSummaries", + "traits": { + "smithy.api#documentation": "

Array of IPSets. If you specified a Limit in your request, this might not be the full list.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#ListLoggingConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#ListLoggingConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#ListLoggingConfigurationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves an array of your LoggingConfiguration objects.

" + } + }, + "com.amazonaws.wafv2#ListLoggingConfigurationsRequest": { + "type": "structure", + "members": { + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", + "smithy.api#required": {} + } + }, + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "Limit": { + "target": "com.amazonaws.wafv2#PaginationLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#ListLoggingConfigurationsResponse": { + "type": "structure", + "members": { + "LoggingConfigurations": { + "target": "com.amazonaws.wafv2#LoggingConfigurations", + "traits": { + "smithy.api#documentation": "

Array of logging configurations. If you specified a Limit in your request, this might not be the full list.

" + } + }, + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#ListManagedRuleSets": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#ListManagedRuleSetsRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#ListManagedRuleSetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the managed rule sets that you own.

\n \n

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

\n

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

\n " + } + }, + "com.amazonaws.wafv2#ListManagedRuleSetsRequest": { + "type": "structure", + "members": { + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", + "smithy.api#required": {} + } + }, + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "Limit": { + "target": "com.amazonaws.wafv2#PaginationLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#ListManagedRuleSetsResponse": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "ManagedRuleSets": { + "target": "com.amazonaws.wafv2#ManagedRuleSetSummaries", + "traits": { + "smithy.api#documentation": "

Your managed rule sets. If you specified a Limit in your request, this might not be the full list.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#ListMaxItems": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.wafv2#ListMobileSdkReleases": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#ListMobileSdkReleasesRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#ListMobileSdkReleasesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a list of the available releases for the mobile SDK and the specified device\n platform.

\n

The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see \nWAF client application integration in the WAF Developer Guide.

" + } + }, + "com.amazonaws.wafv2#ListMobileSdkReleasesRequest": { + "type": "structure", + "members": { + "Platform": { + "target": "com.amazonaws.wafv2#Platform", + "traits": { + "smithy.api#documentation": "

The device platform to retrieve the list for.

", + "smithy.api#required": {} + } + }, + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "Limit": { + "target": "com.amazonaws.wafv2#PaginationLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#ListMobileSdkReleasesResponse": { + "type": "structure", + "members": { + "ReleaseSummaries": { + "target": "com.amazonaws.wafv2#ReleaseSummaries", + "traits": { + "smithy.api#documentation": "

The high level information for the available SDK releases. If you specified a Limit in your request, this might not be the full list.

" + } + }, + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#ListRegexPatternSets": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#ListRegexPatternSetsRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#ListRegexPatternSetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves an array of RegexPatternSetSummary objects for the regex\n pattern sets that you manage.

" + } + }, + "com.amazonaws.wafv2#ListRegexPatternSetsRequest": { + "type": "structure", + "members": { + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", + "smithy.api#required": {} + } + }, + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "Limit": { + "target": "com.amazonaws.wafv2#PaginationLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#ListRegexPatternSetsResponse": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "RegexPatternSets": { + "target": "com.amazonaws.wafv2#RegexPatternSetSummaries", + "traits": { + "smithy.api#documentation": "

Array of regex pattern sets. If you specified a Limit in your request, this might not be the full list.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#ListResourcesForWebACL": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#ListResourcesForWebACLRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#ListResourcesForWebACLResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that\n are associated with the specified web ACL. If you want the list of Amazon CloudFront resources, use\n the CloudFront call ListDistributionsByWebACLId.

" + } + }, + "com.amazonaws.wafv2#ListResourcesForWebACLRequest": { + "type": "structure", + "members": { + "WebACLArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the web ACL.

", + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "com.amazonaws.wafv2#ResourceType", + "traits": { + "smithy.api#documentation": "

Used for web ACLs that are scoped for regional applications.\n A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n \n

If you don't provide a resource type, the call uses the resource type APPLICATION_LOAD_BALANCER.

\n \n

Default: APPLICATION_LOAD_BALANCER\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#ListResourcesForWebACLResponse": { + "type": "structure", + "members": { + "ResourceArns": { + "target": "com.amazonaws.wafv2#ResourceArns", + "traits": { + "smithy.api#documentation": "

The array of Amazon Resource Names (ARNs) of the associated resources.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#ListRuleGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#ListRuleGroupsRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#ListRuleGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves an array of RuleGroupSummary objects for the rule groups\n that you manage.

" + } + }, + "com.amazonaws.wafv2#ListRuleGroupsRequest": { + "type": "structure", + "members": { + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", + "smithy.api#required": {} + } + }, + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "Limit": { + "target": "com.amazonaws.wafv2#PaginationLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#ListRuleGroupsResponse": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "RuleGroups": { + "target": "com.amazonaws.wafv2#RuleGroupSummaries", + "traits": { + "smithy.api#documentation": "

Array of rule groups. If you specified a Limit in your request, this might not be the full list.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the TagInfoForResource for the specified resource. Tags are\n key:value pairs that you can use to categorize and manage your resources, for purposes like\n billing. For example, you might set the tag key to \"customer\" and the value to the customer\n name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags\n for a resource.

\n

You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule\n groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF\n console.

" + } + }, + "com.amazonaws.wafv2#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "Limit": { + "target": "com.amazonaws.wafv2#PaginationLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" + } + }, + "ResourceARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "TagInfoForResource": { + "target": "com.amazonaws.wafv2#TagInfoForResource", + "traits": { + "smithy.api#documentation": "

The collection of tagging definitions for the resource. If you specified a Limit in your request, this might not be the full list.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#ListWebACLs": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#ListWebACLsRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#ListWebACLsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves an array of WebACLSummary objects for the web ACLs that you\n manage.

" + } + }, + "com.amazonaws.wafv2#ListWebACLsRequest": { + "type": "structure", + "members": { + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", + "smithy.api#required": {} + } + }, + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "Limit": { + "target": "com.amazonaws.wafv2#PaginationLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#ListWebACLsResponse": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "WebACLs": { + "target": "com.amazonaws.wafv2#WebACLSummaries", + "traits": { + "smithy.api#documentation": "

Array of web ACLs. If you specified a Limit in your request, this might not be the full list.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#LockToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 36 + }, + "smithy.api#pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$" + } + }, + "com.amazonaws.wafv2#LogDestinationConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#ResourceArn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.wafv2#LoggingConfiguration": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the web ACL that you want to associate with\n LogDestinationConfigs.

", + "smithy.api#required": {} + } + }, + "LogDestinationConfigs": { + "target": "com.amazonaws.wafv2#LogDestinationConfigs", + "traits": { + "smithy.api#documentation": "

The logging destination configuration that you want to associate with the web\n ACL.

\n \n

You can associate one logging destination to a web ACL.

\n ", + "smithy.api#required": {} + } + }, + "RedactedFields": { + "target": "com.amazonaws.wafv2#RedactedFields", + "traits": { + "smithy.api#documentation": "

The parts of the request that you want to keep out of the logs.

\n

For example, if you\n redact the SingleHeader field, the HEADER field in the logs will\n be REDACTED for all rules that use the SingleHeader\n FieldToMatch setting.

\n

Redaction applies only to the component that's specified in the rule's FieldToMatch setting, so the SingleHeader redaction \n doesn't apply to rules that use the Headers\n FieldToMatch.

\n \n

You can specify only the following fields for redaction: UriPath,\n QueryString, SingleHeader, and Method.

\n " + } + }, + "ManagedByFirewallManager": { + "target": "com.amazonaws.wafv2#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the logging configuration was created by Firewall Manager, as part of an\n WAF policy configuration. If true, only Firewall Manager can modify or delete the\n configuration.

" + } + }, + "LoggingFilter": { + "target": "com.amazonaws.wafv2#LoggingFilter", + "traits": { + "smithy.api#documentation": "

Filtering that specifies which web requests are kept in the logs and which are dropped.\n You can filter on the rule action and on the web request labels that were applied by\n matching rules during web ACL evaluation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines an association between logging destinations and a web ACL resource, for logging\n from WAF. As part of the association, you can specify parts of the standard logging\n fields to keep out of the logs and you can specify filters so that you log only a subset of\n the logging records.

\n \n

You can define one logging destination per web ACL.

\n \n

You can access information about the traffic that WAF inspects using the following\n steps:

\n
    \n
  1. \n

    Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose.

    \n

    The name that you give the destination must start with aws-waf-logs-. Depending on the type of destination, you might need to configure additional settings or permissions.

    \n

    For configuration requirements and pricing information for each destination type, see \n Logging web ACL traffic \n in the WAF Developer Guide.

    \n
    2. \n
  2. \n

    Associate your logging destination to your web ACL using a\n PutLoggingConfiguration request.

    \n
    3. \n
\n

When you successfully enable logging using a PutLoggingConfiguration\n request, WAF creates an additional role or policy that is required to write\n logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group.\n For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.

\n

For additional information about web ACL logging, see \n Logging web ACL traffic information \n in the WAF Developer Guide.

" + } + }, + "com.amazonaws.wafv2#LoggingConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#LoggingConfiguration" + } + }, + "com.amazonaws.wafv2#LoggingFilter": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.wafv2#Filters", + "traits": { + "smithy.api#documentation": "

The filters that you want to apply to the logs.

", + "smithy.api#required": {} + } + }, + "DefaultBehavior": { + "target": "com.amazonaws.wafv2#FilterBehavior", + "traits": { + "smithy.api#documentation": "

Default handling for logs that don't match any of the specified filtering conditions.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Filtering that specifies which web requests are kept in the logs and which are dropped,\n defined for a web ACL's LoggingConfiguration.

\n

You can filter on the rule action and on the web request labels that were applied by\n matching rules during web ACL evaluation.

" + } + }, + "com.amazonaws.wafv2#LoginPathString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.wafv2#ManagedProductDescriptor": { + "type": "structure", + "members": { + "VendorName": { + "target": "com.amazonaws.wafv2#VendorName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

" + } + }, + "ManagedRuleSetName": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule group. For example, AWSManagedRulesAnonymousIpList or AWSManagedRulesATPRuleSet.

" + } + }, + "ProductId": { + "target": "com.amazonaws.wafv2#ProductId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

" + } + }, + "ProductLink": { + "target": "com.amazonaws.wafv2#ProductLink", + "traits": { + "smithy.api#documentation": "

For Amazon Web Services Marketplace managed rule groups only, the link to the rule group product page.

" + } + }, + "ProductTitle": { + "target": "com.amazonaws.wafv2#ProductTitle", + "traits": { + "smithy.api#documentation": "

The display name for the managed rule group. For example, Anonymous IP list or Account takeover prevention.

" + } + }, + "ProductDescription": { + "target": "com.amazonaws.wafv2#ProductDescription", + "traits": { + "smithy.api#documentation": "

A short description of the managed rule group.

" + } + }, + "SnsTopicArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to provide notification of changes\n to the managed rule group. You can subscribe to the SNS topic to receive notifications when\n the managed rule group is modified, such as for new versions and for version expiration.\n For more information, see the Amazon Simple Notification Service Developer Guide.

" + } + }, + "IsVersioningSupported": { + "target": "com.amazonaws.wafv2#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the rule group is versioned.

" + } + }, + "IsAdvancedManagedRuleSet": { + "target": "com.amazonaws.wafv2#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the rule group provides an advanced set of protections, such as the the Amazon Web Services Managed Rules rule groups that \n are used for WAF intelligent threat mitigation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The properties of a managed product, such as an Amazon Web Services Managed Rules rule group or an Amazon Web Services Marketplace managed rule group.

" + } + }, + "com.amazonaws.wafv2#ManagedProductDescriptors": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#ManagedProductDescriptor" + } + }, + "com.amazonaws.wafv2#ManagedRuleGroupConfig": { + "type": "structure", + "members": { + "LoginPath": { + "target": "com.amazonaws.wafv2#LoginPathString", + "traits": { + "smithy.api#deprecated": { + "message": "Deprecated. Use AWSManagedRulesATPRuleSet LoginPath" + }, + "smithy.api#documentation": "\n

Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet.

\n " + } + }, + "PayloadType": { + "target": "com.amazonaws.wafv2#PayloadType", + "traits": { + "smithy.api#deprecated": { + "message": "Deprecated. Use AWSManagedRulesATPRuleSet RequestInspection PayloadType" + }, + "smithy.api#documentation": "\n

Instead of this setting, provide your configuration under the request inspection configuration for AWSManagedRulesATPRuleSet or AWSManagedRulesACFPRuleSet.

\n " + } + }, + "UsernameField": { + "target": "com.amazonaws.wafv2#UsernameField", + "traits": { + "smithy.api#deprecated": { + "message": "Deprecated. Use AWSManagedRulesATPRuleSet RequestInspection UsernameField" + }, + "smithy.api#documentation": "\n

Instead of this setting, provide your configuration under the request inspection configuration for AWSManagedRulesATPRuleSet or AWSManagedRulesACFPRuleSet.

\n " + } + }, + "PasswordField": { + "target": "com.amazonaws.wafv2#PasswordField", + "traits": { + "smithy.api#deprecated": { + "message": "Deprecated. Use AWSManagedRulesATPRuleSet RequestInspection PasswordField" + }, + "smithy.api#documentation": "\n

Instead of this setting, provide your configuration under the request inspection configuration for AWSManagedRulesATPRuleSet or AWSManagedRulesACFPRuleSet.

\n " + } + }, + "AWSManagedRulesBotControlRuleSet": { + "target": "com.amazonaws.wafv2#AWSManagedRulesBotControlRuleSet", + "traits": { + "smithy.api#documentation": "

Additional configuration for using the Bot Control managed rule group. Use this to specify the \n inspection level that you want to use. For information \n about using the Bot Control managed rule group, see WAF Bot Control rule group \n and WAF Bot Control\n in the WAF Developer Guide.

" + } + }, + "AWSManagedRulesATPRuleSet": { + "target": "com.amazonaws.wafv2#AWSManagedRulesATPRuleSet", + "traits": { + "smithy.api#documentation": "

Additional configuration for using the account takeover prevention (ATP) managed rule group, AWSManagedRulesATPRuleSet. \n Use this to provide login request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide\n the information about how your distribution responds to login requests.

\n

This configuration replaces the individual configuration fields in ManagedRuleGroupConfig and provides additional feature configuration.

\n

For information \n about using the ATP managed rule group, see WAF Fraud Control account takeover prevention (ATP) rule group \n and WAF Fraud Control account takeover prevention (ATP)\n in the WAF Developer Guide.

" + } + }, + "AWSManagedRulesACFPRuleSet": { + "target": "com.amazonaws.wafv2#AWSManagedRulesACFPRuleSet", + "traits": { + "smithy.api#documentation": "

Additional configuration for using the account creation fraud prevention (ACFP) managed rule group, AWSManagedRulesACFPRuleSet. \n Use this to provide account creation request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide\n the information about how your distribution responds to account creation requests.

\n

For information \n about using the ACFP managed rule group, see WAF Fraud Control account creation fraud prevention (ACFP) rule group \n and WAF Fraud Control account creation fraud prevention (ACFP)\n in the WAF Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Additional information that's used by a managed rule group. Many managed rule groups don't require this.

\n

The rule groups used for intelligent threat mitigation require additional configuration:

\n \n

For example specifications, see the examples section of CreateWebACL.

" + } + }, + "com.amazonaws.wafv2#ManagedRuleGroupConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#ManagedRuleGroupConfig" + } + }, + "com.amazonaws.wafv2#ManagedRuleGroupStatement": { + "type": "structure", + "members": { + "VendorName": { + "target": "com.amazonaws.wafv2#VendorName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

", + "smithy.api#required": {} + } + }, + "Version": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "

The version of the managed rule group to use. If you specify this, the version setting\n is fixed until you change it. If you don't specify this, WAF uses the vendor's\n default version, and then keeps the version at the vendor's default when the vendor updates\n the managed rule group settings.

" + } + }, + "ExcludedRules": { + "target": "com.amazonaws.wafv2#ExcludedRules", + "traits": { + "smithy.api#documentation": "

Rules in the referenced rule group whose actions are set to Count.

\n \n

Instead of this option, use RuleActionOverrides. It accepts any valid action setting, including Count.

\n " + } + }, + "ScopeDownStatement": { + "target": "com.amazonaws.wafv2#Statement", + "traits": { + "smithy.api#documentation": "

An optional nested statement that narrows the scope of the web requests that are\n evaluated by the managed rule group. Requests are only evaluated by the rule group if they\n match the scope-down statement. You can use any nestable Statement in the\n scope-down statement, and you can nest statements at any level, the same as you can for a\n rule statement.

" + } + }, + "ManagedRuleGroupConfigs": { + "target": "com.amazonaws.wafv2#ManagedRuleGroupConfigs", + "traits": { + "smithy.api#documentation": "

Additional information that's used by a managed rule group. Many managed rule groups don't require this.

\n

The rule groups used for intelligent threat mitigation require additional configuration:

\n " + } + }, + "RuleActionOverrides": { + "target": "com.amazonaws.wafv2#RuleActionOverrides", + "traits": { + "smithy.api#documentation": "

Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.

\n

You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.

\n

You cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

\n \n

You are charged additional fees when you use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet, the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet, or the WAF Fraud Control account creation fraud prevention (ACFP) managed rule group AWSManagedRulesACFPRuleSet. For more information, see WAF Pricing.

\n " + } + }, + "com.amazonaws.wafv2#ManagedRuleGroupSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#ManagedRuleGroupSummary" + } + }, + "com.amazonaws.wafv2#ManagedRuleGroupSummary": { + "type": "structure", + "members": { + "VendorName": { + "target": "com.amazonaws.wafv2#VendorName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

" + } + }, + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

" + } + }, + "VersioningSupported": { + "target": "com.amazonaws.wafv2#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the managed rule group is versioned. If it is, you can retrieve the\n versions list by calling ListAvailableManagedRuleGroupVersions.

" + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

The description of the managed rule group, provided by Amazon Web Services Managed Rules or the Amazon Web Services Marketplace seller who manages it.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

High-level information about a managed rule group, returned by ListAvailableManagedRuleGroups. This provides information like the name and vendor name, that you provide when you add a ManagedRuleGroupStatement to a web ACL. Managed rule groups include Amazon Web Services Managed Rules rule groups and Amazon Web Services Marketplace managed rule groups. To use any Amazon Web Services Marketplace managed rule group, first subscribe to the rule group through Amazon Web Services Marketplace.

" + } + }, + "com.amazonaws.wafv2#ManagedRuleGroupVersion": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "

The version name.

" + } + }, + "LastUpdateTimestamp": { + "target": "com.amazonaws.wafv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the managed rule group owner updated the rule group version\n information.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a single version of a managed rule group.

" + } + }, + "com.amazonaws.wafv2#ManagedRuleGroupVersions": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#ManagedRuleGroupVersion" + } + }, + "com.amazonaws.wafv2#ManagedRuleSet": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

\n

This name is assigned to the corresponding managed rule group, which your customers can access and use.

", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

", + "smithy.api#required": {} + } + }, + "ARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entity.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the set that helps with identification.

" + } + }, + "PublishedVersions": { + "target": "com.amazonaws.wafv2#PublishedVersions", + "traits": { + "smithy.api#documentation": "

The versions of this managed rule set that are available for use by customers.

" + } + }, + "RecommendedVersion": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "

The version that you would like your customers to use.

" + } + }, + "LabelNamespace": { + "target": "com.amazonaws.wafv2#LabelName", + "traits": { + "smithy.api#documentation": "

The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

A set of rules that is managed by Amazon Web Services and Amazon Web Services Marketplace sellers to provide versioned managed\n rule groups for customers of WAF.

\n \n

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

\n

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

\n " + } + }, + "com.amazonaws.wafv2#ManagedRuleSetSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#ManagedRuleSetSummary" + } + }, + "com.amazonaws.wafv2#ManagedRuleSetSummary": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

\n

This name is assigned to the corresponding managed rule group, which your customers can access and use.

" + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

" + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the set that helps with identification.

" + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + } + }, + "ARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entity.

" + } + }, + "LabelNamespace": { + "target": "com.amazonaws.wafv2#LabelName", + "traits": { + "smithy.api#documentation": "

The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

High-level information for a managed rule set.

\n \n

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

\n

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

\n " + } + }, + "com.amazonaws.wafv2#ManagedRuleSetVersion": { + "type": "structure", + "members": { + "AssociatedRuleGroupArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the vendor rule group that's used to define the\n published version of your managed rule group.

" + } + }, + "Capacity": { + "target": "com.amazonaws.wafv2#CapacityUnit", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The web ACL capacity units (WCUs) required for this rule group.

\n

WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) \n in the WAF Developer Guide.

" + } + }, + "ForecastedLifetime": { + "target": "com.amazonaws.wafv2#TimeWindowDay", + "traits": { + "smithy.api#documentation": "

The amount of time you expect this version of your managed rule group to last, in days.\n

" + } + }, + "PublishTimestamp": { + "target": "com.amazonaws.wafv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that you first published this version.

\n

Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\".

" + } + }, + "LastUpdateTimestamp": { + "target": "com.amazonaws.wafv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time that you updated this version.

\n

Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\".

" + } + }, + "ExpiryTimestamp": { + "target": "com.amazonaws.wafv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that this version is set to expire.

\n

Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\".

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information for a single version of a managed rule set.

\n \n

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

\n

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

\n " + } + }, + "com.amazonaws.wafv2#MapMatchScope": { + "type": "enum", + "members": { + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + }, + "KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KEY" + } + }, + "VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALUE" + } + } + } + }, + "com.amazonaws.wafv2#Method": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Inspect the HTTP method of the web request. The method indicates the type of operation\n that the request is asking the origin to perform.

\n

This is used in the FieldToMatch specification for some web request component types.

\n

JSON specification: \"Method\": {}\n

" + } + }, + "com.amazonaws.wafv2#MetricName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[\\w#:\\.\\-/]+$" + } + }, + "com.amazonaws.wafv2#MobileSdkRelease": { + "type": "structure", + "members": { + "ReleaseVersion": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "

The release version.

" + } + }, + "Timestamp": { + "target": "com.amazonaws.wafv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of the release.

" + } + }, + "ReleaseNotes": { + "target": "com.amazonaws.wafv2#ReleaseNotes", + "traits": { + "smithy.api#documentation": "

Notes describing the release.

" + } + }, + "Tags": { + "target": "com.amazonaws.wafv2#TagList", + "traits": { + "smithy.api#documentation": "

Tags that are associated with the release.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information for a release of the mobile SDK, including release notes and tags.

\n

The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see \nWAF client application integration in the WAF Developer Guide.

" + } + }, + "com.amazonaws.wafv2#NextMarker": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.wafv2#NoneAction": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Specifies that WAF should do nothing. This is used for the\n OverrideAction setting on a Rule when the rule uses a\n rule group reference statement.

\n

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

\n

JSON specification: \"None\": {}\n

" + } + }, + "com.amazonaws.wafv2#NotStatement": { + "type": "structure", + "members": { + "Statement": { + "target": "com.amazonaws.wafv2#Statement", + "traits": { + "smithy.api#documentation": "

The statement to negate. You can use any statement that can be nested.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement.

" + } + }, + "com.amazonaws.wafv2#OrStatement": { + "type": "structure", + "members": { + "Statements": { + "target": "com.amazonaws.wafv2#Statements", + "traits": { + "smithy.api#documentation": "

The statements to combine with OR logic. You can use any statements that can be\n nested.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement.

" + } + }, + "com.amazonaws.wafv2#OutputUrl": { + "type": "string" + }, + "com.amazonaws.wafv2#OverrideAction": { + "type": "structure", + "members": { + "Count": { + "target": "com.amazonaws.wafv2#CountAction", + "traits": { + "smithy.api#documentation": "

Override the rule group evaluation result to count only.

\n \n

This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count \n matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings.

\n " + } + }, + "None": { + "target": "com.amazonaws.wafv2#NoneAction", + "traits": { + "smithy.api#documentation": "

Don't override the rule group evaluation result. This is the most common setting.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.

\n

You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

\n \n

This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count \n matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings.

\n " + } + }, + "com.amazonaws.wafv2#OversizeHandling": { + "type": "enum", + "members": { + "CONTINUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTINUE" + } + }, + "MATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MATCH" + } + }, + "NO_MATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_MATCH" + } + } + } + }, + "com.amazonaws.wafv2#PaginationLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.wafv2#ParameterExceptionField": { + "type": "enum", + "members": { + "WEB_ACL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEB_ACL" + } + }, + "RULE_GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RULE_GROUP" + } + }, + "REGEX_PATTERN_SET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REGEX_PATTERN_SET" + } + }, + "IP_SET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IP_SET" + } + }, + "MANAGED_RULE_SET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANAGED_RULE_SET" + } + }, + "RULE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RULE" + } + }, + "EXCLUDED_RULE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXCLUDED_RULE" + } + }, + "STATEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STATEMENT" + } + }, + "BYTE_MATCH_STATEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BYTE_MATCH_STATEMENT" + } + }, + "SQLI_MATCH_STATEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQLI_MATCH_STATEMENT" + } + }, + "XSS_MATCH_STATEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "XSS_MATCH_STATEMENT" + } + }, + "SIZE_CONSTRAINT_STATEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SIZE_CONSTRAINT_STATEMENT" + } + }, + "GEO_MATCH_STATEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GEO_MATCH_STATEMENT" + } + }, + "RATE_BASED_STATEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RATE_BASED_STATEMENT" + } + }, + "RULE_GROUP_REFERENCE_STATEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RULE_GROUP_REFERENCE_STATEMENT" + } + }, + "REGEX_PATTERN_REFERENCE_STATEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REGEX_PATTERN_REFERENCE_STATEMENT" + } + }, + "IP_SET_REFERENCE_STATEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IP_SET_REFERENCE_STATEMENT" + } + }, + "MANAGED_RULE_SET_STATEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANAGED_RULE_SET_STATEMENT" + } + }, + "LABEL_MATCH_STATEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LABEL_MATCH_STATEMENT" + } + }, + "AND_STATEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AND_STATEMENT" + } + }, + "OR_STATEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OR_STATEMENT" + } + }, + "NOT_STATEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_STATEMENT" + } + }, + "IP_ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IP_ADDRESS" + } + }, + "IP_ADDRESS_VERSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IP_ADDRESS_VERSION" + } + }, + "FIELD_TO_MATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIELD_TO_MATCH" + } + }, + "TEXT_TRANSFORMATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXT_TRANSFORMATION" + } + }, + "SINGLE_QUERY_ARGUMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SINGLE_QUERY_ARGUMENT" + } + }, + "SINGLE_HEADER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SINGLE_HEADER" + } + }, + "DEFAULT_ACTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULT_ACTION" + } + }, + "RULE_ACTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RULE_ACTION" + } + }, + "ENTITY_LIMIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENTITY_LIMIT" + } + }, + "OVERRIDE_ACTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OVERRIDE_ACTION" + } + }, + "SCOPE_VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCOPE_VALUE" + } + }, + "RESOURCE_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE_ARN" + } + }, + "RESOURCE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE_TYPE" + } + }, + "TAGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TAGS" + } + }, + "TAG_KEYS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TAG_KEYS" + } + }, + "METRIC_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "METRIC_NAME" + } + }, + "FIREWALL_MANAGER_STATEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIREWALL_MANAGER_STATEMENT" + } + }, + "FALLBACK_BEHAVIOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FALLBACK_BEHAVIOR" + } + }, + "POSITION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POSITION" + } + }, + "FORWARDED_IP_CONFIG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FORWARDED_IP_CONFIG" + } + }, + "IP_SET_FORWARDED_IP_CONFIG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IP_SET_FORWARDED_IP_CONFIG" + } + }, + "HEADER_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HEADER_NAME" + } + }, + "CUSTOM_REQUEST_HANDLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM_REQUEST_HANDLING" + } + }, + "RESPONSE_CONTENT_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESPONSE_CONTENT_TYPE" + } + }, + "CUSTOM_RESPONSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM_RESPONSE" + } + }, + "CUSTOM_RESPONSE_BODY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM_RESPONSE_BODY" + } + }, + "JSON_MATCH_PATTERN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON_MATCH_PATTERN" + } + }, + "JSON_MATCH_SCOPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON_MATCH_SCOPE" + } + }, + "BODY_PARSING_FALLBACK_BEHAVIOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BODY_PARSING_FALLBACK_BEHAVIOR" + } + }, + "LOGGING_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOGGING_FILTER" + } + }, + "FILTER_CONDITION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FILTER_CONDITION" + } + }, + "EXPIRE_TIMESTAMP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPIRE_TIMESTAMP" + } + }, + "CHANGE_PROPAGATION_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CHANGE_PROPAGATION_STATUS" + } + }, + "ASSOCIABLE_RESOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASSOCIABLE_RESOURCE" + } + }, + "LOG_DESTINATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOG_DESTINATION" + } + }, + "MANAGED_RULE_GROUP_CONFIG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANAGED_RULE_GROUP_CONFIG" + } + }, + "PAYLOAD_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAYLOAD_TYPE" + } + }, + "HEADER_MATCH_PATTERN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HEADER_MATCH_PATTERN" + } + }, + "COOKIE_MATCH_PATTERN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COOKIE_MATCH_PATTERN" + } + }, + "MAP_MATCH_SCOPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAP_MATCH_SCOPE" + } + }, + "OVERSIZE_HANDLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OVERSIZE_HANDLING" + } + }, + "CHALLENGE_CONFIG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CHALLENGE_CONFIG" + } + }, + "TOKEN_DOMAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOKEN_DOMAIN" + } + }, + "ATP_RULE_SET_RESPONSE_INSPECTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ATP_RULE_SET_RESPONSE_INSPECTION" + } + }, + "ASSOCIATED_RESOURCE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASSOCIATED_RESOURCE_TYPE" + } + }, + "SCOPE_DOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCOPE_DOWN" + } + }, + "CUSTOM_KEYS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM_KEYS" + } + }, + "ACP_RULE_SET_RESPONSE_INSPECTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACP_RULE_SET_RESPONSE_INSPECTION" + } + } + } + }, + "com.amazonaws.wafv2#ParameterExceptionParameter": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.wafv2#PasswordField": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.wafv2#FieldIdentifier", + "traits": { + "smithy.api#documentation": "

The name of the password field.

\n

How you specify this depends on the request inspection payload type.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The name of the field in the request payload that contains your customer's password.

\n

This data type is used in the RequestInspection and RequestInspectionACFP data types.

" + } + }, + "com.amazonaws.wafv2#PayloadType": { + "type": "enum", + "members": { + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON" + } + }, + "FORM_ENCODED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FORM_ENCODED" + } + } + } + }, + "com.amazonaws.wafv2#PhoneNumberField": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.wafv2#FieldIdentifier", + "traits": { + "smithy.api#documentation": "

The name of a single primary phone number field.

\n

How you specify the phone number fields depends on the request inspection payload type.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The name of a field in the request payload that contains part or all of your customer's primary phone number.

\n

This data type is used in the RequestInspectionACFP data type.

" + } + }, + "com.amazonaws.wafv2#PhoneNumberFields": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#PhoneNumberField" + } + }, + "com.amazonaws.wafv2#Platform": { + "type": "enum", + "members": { + "IOS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IOS" + } + }, + "ANDROID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANDROID" + } + } + } + }, + "com.amazonaws.wafv2#PolicyString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 395000 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.wafv2#PopulationSize": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.wafv2#PositionalConstraint": { + "type": "enum", + "members": { + "EXACTLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXACTLY" + } + }, + "STARTS_WITH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTS_WITH" + } + }, + "ENDS_WITH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENDS_WITH" + } + }, + "CONTAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTAINS" + } + }, + "CONTAINS_WORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTAINS_WORD" + } + } + } + }, + "com.amazonaws.wafv2#ProductDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.wafv2#ProductId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.wafv2#ProductLink": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.wafv2#ProductTitle": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.wafv2#PublishedVersions": { + "type": "map", + "key": { + "target": "com.amazonaws.wafv2#VersionKeyString" + }, + "value": { + "target": "com.amazonaws.wafv2#ManagedRuleSetVersion" + } + }, + "com.amazonaws.wafv2#PutLoggingConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#PutLoggingConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#PutLoggingConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFLimitsExceededException" + }, + { + "target": "com.amazonaws.wafv2#WAFLogDestinationPermissionIssueException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + }, + { + "target": "com.amazonaws.wafv2#WAFServiceLinkedRoleErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Enables the specified LoggingConfiguration, to start logging from a\n web ACL, according to the configuration provided.

\n \n

This operation completely replaces any mutable specifications that you already have for a logging configuration with the ones that you provide to this call.

\n

To modify an existing logging configuration, do the following:

\n
    \n
  1. \n

    Retrieve it by calling GetLoggingConfiguration\n

    \n
    2. \n
  2. \n

    Update its settings as needed

    \n
    3. \n
  3. \n

    Provide the complete logging configuration specification to this call

    \n
    4. \n
\n \n \n

You can define one logging destination per web ACL.

\n \n

You can access information about the traffic that WAF inspects using the following\n steps:

\n
    \n
  1. \n

    Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose.

    \n

    The name that you give the destination must start with aws-waf-logs-. Depending on the type of destination, you might need to configure additional settings or permissions.

    \n

    For configuration requirements and pricing information for each destination type, see \n Logging web ACL traffic \n in the WAF Developer Guide.

    \n
    2. \n
  2. \n

    Associate your logging destination to your web ACL using a\n PutLoggingConfiguration request.

    \n
    3. \n
\n

When you successfully enable logging using a PutLoggingConfiguration\n request, WAF creates an additional role or policy that is required to write\n logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group.\n For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.

\n

For additional information about web ACL logging, see \n Logging web ACL traffic information \n in the WAF Developer Guide.

" + } + }, + "com.amazonaws.wafv2#PutLoggingConfigurationRequest": { + "type": "structure", + "members": { + "LoggingConfiguration": { + "target": "com.amazonaws.wafv2#LoggingConfiguration", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#PutLoggingConfigurationResponse": { + "type": "structure", + "members": { + "LoggingConfiguration": { + "target": "com.amazonaws.wafv2#LoggingConfiguration", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#PutManagedRuleSetVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#PutManagedRuleSetVersionsRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#PutManagedRuleSetVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + } + ], + "traits": { + "smithy.api#documentation": "

Defines the versions of your managed rule set that you are offering to the customers.\n Customers see your offerings as managed rule groups with versioning.

\n \n

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

\n

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

\n \n

Customers retrieve their managed rule group list by calling ListAvailableManagedRuleGroups. The name that you provide here for your\n managed rule set is the name the customer sees for the corresponding managed rule group.\n Customers can retrieve the available versions for a managed rule group by calling ListAvailableManagedRuleGroupVersions. You provide a rule group\n specification for each version. For each managed rule set, you must specify a version that\n you recommend using.

\n

To initiate the expiration of a managed rule group version, use UpdateManagedRuleSetVersionExpiryDate.

" + } + }, + "com.amazonaws.wafv2#PutManagedRuleSetVersionsRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

\n

This name is assigned to the corresponding managed rule group, which your customers can access and use.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

", + "smithy.api#required": {} + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#required": {} + } + }, + "RecommendedVersion": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "

The version of the named managed rule group that you'd like your customers to choose,\n from among your version offerings.

" + } + }, + "VersionsToPublish": { + "target": "com.amazonaws.wafv2#VersionsToPublish", + "traits": { + "smithy.api#documentation": "

The versions of the named managed rule group that you want to offer to your customers.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#PutManagedRuleSetVersionsResponse": { + "type": "structure", + "members": { + "NextLockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#PutPermissionPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#PutPermissionPolicyRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#PutPermissionPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidPermissionPolicyException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + } + ], + "traits": { + "smithy.api#documentation": "

Attaches an IAM policy to the specified resource. Use this to share a rule group across\n accounts.

\n

You must be the owner of the rule group to perform this operation.

\n

This action is subject to the following restrictions:

\n " + } + }, + "com.amazonaws.wafv2#PutPermissionPolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the RuleGroup to which you want to\n attach the policy.

", + "smithy.api#required": {} + } + }, + "Policy": { + "target": "com.amazonaws.wafv2#PolicyString", + "traits": { + "smithy.api#documentation": "

The policy to attach to the specified rule group.

\n

The policy specifications must conform to the following:

\n \n

For more information, see IAM Policies.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#PutPermissionPolicyResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#QueryString": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Inspect the query string of the web request. This is the part of a URL that appears\n after a ? character, if any.

\n

This is used in the FieldToMatch specification for some web request component types.

\n

JSON specification: \"QueryString\": {}\n

" + } + }, + "com.amazonaws.wafv2#RateBasedStatement": { + "type": "structure", + "members": { + "Limit": { + "target": "com.amazonaws.wafv2#RateLimit", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The limit on requests per 5-minute period for a single aggregation instance for the rate-based rule. \n If the rate-based statement includes a ScopeDownStatement, this limit is applied only to the\n requests that match the statement.

\n

Examples:

\n ", + "smithy.api#required": {} + } + }, + "AggregateKeyType": { + "target": "com.amazonaws.wafv2#RateBasedStatementAggregateKeyType", + "traits": { + "smithy.api#documentation": "

Setting that indicates how to aggregate the request counts.

\n \n

Web requests that are missing any of the components specified in the aggregation keys\n are omitted from the rate-based rule evaluation and handling.

\n \n ", + "smithy.api#required": {} + } + }, + "ScopeDownStatement": { + "target": "com.amazonaws.wafv2#Statement", + "traits": { + "smithy.api#documentation": "

An optional nested statement that narrows the scope of the web requests that are\n evaluated and managed by the rate-based statement. When you use a scope-down statement, \n the rate-based rule only tracks and rate limits \n requests that match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any\n level, the same as you can for a rule statement.

" + } + }, + "ForwardedIPConfig": { + "target": "com.amazonaws.wafv2#ForwardedIPConfig", + "traits": { + "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n \n

This is required if you specify a forwarded IP in the rule's aggregate key settings.

" + } + }, + "CustomKeys": { + "target": "com.amazonaws.wafv2#RateBasedStatementCustomKeys", + "traits": { + "smithy.api#documentation": "

Specifies the aggregate keys to use in a rate-base rule.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A rate-based rule counts incoming requests and rate limits requests when they are coming at too fast a rate. The rule categorizes requests according to your aggregation criteria, collects them into aggregation instances, and counts and rate limits the requests for each instance.

\n

You can specify individual aggregation keys, like IP address or HTTP method. You can also specify aggregation key combinations, like IP address and HTTP method, or HTTP method, query argument, and cookie.

\n

Each unique set of values for the aggregation keys that you specify is a separate aggregation instance, with the value from each key contributing to the aggregation instance definition.

\n

For example, assume the rule evaluates web requests with the following IP address and HTTP method values:

\n \n

The rule would create different aggregation instances according to your aggregation criteria, for example:

\n \n

For any n-tuple of aggregation keys, each unique combination of values for the keys defines a separate aggregation instance, which WAF counts and rate-limits individually.

\n

You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts and rate limits requests that match the nested statement. You can use this nested scope-down statement in conjunction with your aggregation key specifications or you can just count and rate limit all requests that match the scope-down statement, without additional aggregation. When you choose to just manage all requests that match a scope-down statement, the aggregation instance is singular for the rule.

\n

You cannot nest a RateBasedStatement inside another statement, for example inside a NotStatement or OrStatement. You can define a RateBasedStatement inside a web ACL and inside a rule group.

\n

For additional information about the options, see Rate limiting web requests using rate-based rules \n in the WAF Developer Guide.

\n

If you only aggregate on the individual IP address or forwarded IP address, you can retrieve the list of IP addresses that WAF \n is currently rate limiting for a rule through the API call GetRateBasedStatementManagedKeys. This option is not available\n for other aggregation configurations.

\n

WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF.

" + } + }, + "com.amazonaws.wafv2#RateBasedStatementAggregateKeyType": { + "type": "enum", + "members": { + "IP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IP" + } + }, + "FORWARDED_IP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FORWARDED_IP" + } + }, + "CUSTOM_KEYS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM_KEYS" + } + }, + "CONSTANT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONSTANT" + } + } + } + }, + "com.amazonaws.wafv2#RateBasedStatementCustomKey": { + "type": "structure", + "members": { + "Header": { + "target": "com.amazonaws.wafv2#RateLimitHeader", + "traits": { + "smithy.api#documentation": "

Use the value of a header in the request as an aggregate key. Each distinct value in the header contributes to the aggregation instance. If you use a single \n header as your custom key, then each value fully defines an aggregation instance.

" + } + }, + "Cookie": { + "target": "com.amazonaws.wafv2#RateLimitCookie", + "traits": { + "smithy.api#documentation": "

Use the value of a cookie in the request as an aggregate key. Each distinct value in the cookie contributes to the aggregation instance. If you use a single\n cookie as your custom key, then each value fully defines an aggregation instance.

" + } + }, + "QueryArgument": { + "target": "com.amazonaws.wafv2#RateLimitQueryArgument", + "traits": { + "smithy.api#documentation": "

Use the specified query argument as an aggregate key. Each distinct value for the named query argument contributes to the aggregation instance. If you \n use a single query argument as your custom key, then each value fully defines an aggregation instance.

" + } + }, + "QueryString": { + "target": "com.amazonaws.wafv2#RateLimitQueryString", + "traits": { + "smithy.api#documentation": "

Use the request's query string as an aggregate key. Each distinct string contributes to the aggregation instance. If you use just the \n query string as your custom key, then each string fully defines an aggregation instance.

" + } + }, + "HTTPMethod": { + "target": "com.amazonaws.wafv2#RateLimitHTTPMethod", + "traits": { + "smithy.api#documentation": "

Use the request's HTTP method as an aggregate key. Each distinct HTTP method contributes to the aggregation instance. If you use just the HTTP method\n as your custom key, then each method fully defines an aggregation instance.

" + } + }, + "ForwardedIP": { + "target": "com.amazonaws.wafv2#RateLimitForwardedIP", + "traits": { + "smithy.api#documentation": "

Use the first IP address in an HTTP header as an aggregate key. Each distinct forwarded IP address contributes to the aggregation instance.

\n

When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use.\n You can aggregate on only the forwarded IP address by specifying FORWARDED_IP in your rate-based statement's AggregateKeyType.

\n

With this option, you must specify the header to use in the rate-based rule's ForwardedIPConfig property.

" + } + }, + "IP": { + "target": "com.amazonaws.wafv2#RateLimitIP", + "traits": { + "smithy.api#documentation": "

Use the request's originating IP address as an aggregate key. Each distinct IP address contributes to the aggregation instance.

\n

When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use.\n You can aggregate on only the IP address by specifying IP in your rate-based statement's AggregateKeyType.

" + } + }, + "LabelNamespace": { + "target": "com.amazonaws.wafv2#RateLimitLabelNamespace", + "traits": { + "smithy.api#documentation": "

Use the specified label namespace as an aggregate key. Each distinct fully qualified label name that has the specified label namespace contributes to the aggregation instance. If you use just one label namespace as your custom key, then each label name fully defines an aggregation instance.

\n

This uses only labels that have been added to the request by rules that are evaluated before this rate-based rule in the web ACL.

\n

For information about label namespaces and names, see \n Label syntax and naming requirements in the WAF Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a single custom aggregate key for a rate-base rule.

\n \n

Web requests that are missing any of the components specified in the aggregation keys\n are omitted from the rate-based rule evaluation and handling.

\n " + } + }, + "com.amazonaws.wafv2#RateBasedStatementCustomKeys": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#RateBasedStatementCustomKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.wafv2#RateBasedStatementManagedKeysIPSet": { + "type": "structure", + "members": { + "IPAddressVersion": { + "target": "com.amazonaws.wafv2#IPAddressVersion", + "traits": { + "smithy.api#documentation": "

The version of the IP addresses, either IPV4 or IPV6.

" + } + }, + "Addresses": { + "target": "com.amazonaws.wafv2#IPAddresses", + "traits": { + "smithy.api#documentation": "

The IP addresses that are currently blocked.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The set of IP addresses that are currently blocked for a RateBasedStatement. This is only available for rate-based rules \n that aggregate on just the IP address, with the AggregateKeyType set to IP or FORWARDED_IP.

\n

A rate-based rule applies its rule action to requests from IP addresses that are in the rule's managed keys list and that match the rule's scope-down statement. When a rule has no scope-down statement, it applies the action to all requests from the IP addresses that are in the list. The rule applies its rule action to rate limit the matching requests. The action is usually Block but it can be any valid rule action except for Allow.

\n

The maximum number of IP addresses that can be rate limited by a single rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, WAF limits those with the highest rates.

" + } + }, + "com.amazonaws.wafv2#RateLimit": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 100, + "max": 2000000000 + } + } + }, + "com.amazonaws.wafv2#RateLimitCookie": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#FieldToMatchData", + "traits": { + "smithy.api#documentation": "

The name of the cookie to use.

", + "smithy.api#required": {} + } + }, + "TextTransformations": { + "target": "com.amazonaws.wafv2#TextTransformations", + "traits": { + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a cookie as an aggregate key for a rate-based rule. Each distinct value in the cookie contributes to the aggregation instance. If you use a single\n cookie as your custom key, then each value fully defines an aggregation instance.

" + } + }, + "com.amazonaws.wafv2#RateLimitForwardedIP": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Specifies the first IP address in an HTTP header as an aggregate key for a rate-based rule. Each distinct forwarded IP address contributes to the aggregation instance.

\n

This setting is used only in the RateBasedStatementCustomKey specification of a rate-based rule statement.\n When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use.\n You can aggregate on only the forwarded IP address by specifying FORWARDED_IP in your rate-based statement's AggregateKeyType.

\n

This data type supports using the forwarded IP address in the web request aggregation for a rate-based rule, in RateBasedStatementCustomKey. The JSON specification for using the forwarded IP address doesn't explicitly use this data type.

\n

JSON specification: \"ForwardedIP\": {}\n

\n

When you use this specification, you must also configure the forwarded IP address in the rate-based statement's ForwardedIPConfig.

" + } + }, + "com.amazonaws.wafv2#RateLimitHTTPMethod": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Specifies the request's HTTP method as an aggregate key for a rate-based rule. Each distinct HTTP method contributes to the aggregation instance. If you use just the HTTP method\n as your custom key, then each method fully defines an aggregation instance.

\n

JSON specification: \"RateLimitHTTPMethod\": {}\n

" + } + }, + "com.amazonaws.wafv2#RateLimitHeader": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#FieldToMatchData", + "traits": { + "smithy.api#documentation": "

The name of the header to use.

", + "smithy.api#required": {} + } + }, + "TextTransformations": { + "target": "com.amazonaws.wafv2#TextTransformations", + "traits": { + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a header as an aggregate key for a rate-based rule. Each distinct value in the header contributes to the aggregation instance. If you use a single \n header as your custom key, then each value fully defines an aggregation instance.

" + } + }, + "com.amazonaws.wafv2#RateLimitIP": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Specifies the IP address in the web request as an aggregate key for a rate-based rule. Each distinct IP address contributes to the aggregation instance.

\n

This setting is used only in the RateBasedStatementCustomKey specification of a rate-based rule statement.\n To use this in the custom key settings, you must specify at least one other key to use, along with the IP address. \n To aggregate on only the IP address, in your rate-based statement's AggregateKeyType, specify IP.

\n

JSON specification: \"RateLimitIP\": {}\n

" + } + }, + "com.amazonaws.wafv2#RateLimitLabelNamespace": { + "type": "structure", + "members": { + "Namespace": { + "target": "com.amazonaws.wafv2#LabelNamespace", + "traits": { + "smithy.api#documentation": "

The namespace to use for aggregation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a label namespace to use as an aggregate key for a rate-based rule. Each distinct fully qualified label name that has the specified label namespace contributes to the aggregation instance. If you use just one label namespace as your custom key, then each label name fully defines an aggregation instance.

\n

This uses only labels that have been added to the request by rules that are evaluated before this rate-based rule in the web ACL.

\n

For information about label namespaces and names, see \n Label syntax and naming requirements in the WAF Developer Guide.

" + } + }, + "com.amazonaws.wafv2#RateLimitQueryArgument": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#FieldToMatchData", + "traits": { + "smithy.api#documentation": "

The name of the query argument to use.

", + "smithy.api#required": {} + } + }, + "TextTransformations": { + "target": "com.amazonaws.wafv2#TextTransformations", + "traits": { + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a query argument in the request as an aggregate key for a rate-based rule. Each distinct value for the named query argument contributes to the aggregation instance. If you \n use a single query argument as your custom key, then each value fully defines an aggregation instance.

" + } + }, + "com.amazonaws.wafv2#RateLimitQueryString": { + "type": "structure", + "members": { + "TextTransformations": { + "target": "com.amazonaws.wafv2#TextTransformations", + "traits": { + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the request's query string as an aggregate key for a rate-based rule. Each distinct string contributes to the aggregation instance. If you use just the \n query string as your custom key, then each string fully defines an aggregation instance.

" + } + }, + "com.amazonaws.wafv2#RedactedFields": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#FieldToMatch" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.wafv2#Regex": { + "type": "structure", + "members": { + "RegexString": { + "target": "com.amazonaws.wafv2#RegexPatternString", + "traits": { + "smithy.api#documentation": "

The string representing the regular expression.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A single regular expression. This is used in a RegexPatternSet.

" + } + }, + "com.amazonaws.wafv2#RegexMatchStatement": { + "type": "structure", + "members": { + "RegexString": { + "target": "com.amazonaws.wafv2#RegexPatternString", + "traits": { + "smithy.api#documentation": "

The string representing the regular expression.

", + "smithy.api#required": {} + } + }, + "FieldToMatch": { + "target": "com.amazonaws.wafv2#FieldToMatch", + "traits": { + "smithy.api#documentation": "

The part of the web request that you want WAF to inspect.

", + "smithy.api#required": {} + } + }, + "TextTransformations": { + "target": "com.amazonaws.wafv2#TextTransformations", + "traits": { + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A rule statement used to search web request components for a match against a single regular expression.

" + } + }, + "com.amazonaws.wafv2#RegexPatternSet": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the set. You cannot change the name after you create the set.

" + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

" + } + }, + "ARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entity.

" + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the set that helps with identification.

" + } + }, + "RegularExpressionList": { + "target": "com.amazonaws.wafv2#RegularExpressionList", + "traits": { + "smithy.api#documentation": "

The regular expression patterns in the set.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains one or more regular expressions.

\n

WAF assigns an ARN to each RegexPatternSet that you create. To use a\n set in a rule, you provide the ARN to the Rule statement RegexPatternSetReferenceStatement.

" + } + }, + "com.amazonaws.wafv2#RegexPatternSetReferenceStatement": { + "type": "structure", + "members": { + "ARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the RegexPatternSet that this\n statement references.

", + "smithy.api#required": {} + } + }, + "FieldToMatch": { + "target": "com.amazonaws.wafv2#FieldToMatch", + "traits": { + "smithy.api#documentation": "

The part of the web request that you want WAF to inspect.

", + "smithy.api#required": {} + } + }, + "TextTransformations": { + "target": "com.amazonaws.wafv2#TextTransformations", + "traits": { + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.

\n

Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

" + } + }, + "com.amazonaws.wafv2#RegexPatternSetSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#RegexPatternSetSummary" + } + }, + "com.amazonaws.wafv2#RegexPatternSetSummary": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the data type instance. You cannot change the name after you create the instance.

" + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

" + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the set that helps with identification.

" + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + } + }, + "ARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entity.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

High-level information about a RegexPatternSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RegexPatternSet, and the ARN, that you provide to the RegexPatternSetReferenceStatement to use the pattern set in a Rule.

" + } + }, + "com.amazonaws.wafv2#RegexPatternString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.wafv2#RegistrationPagePathString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.wafv2#RegularExpressionList": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#Regex" + } + }, + "com.amazonaws.wafv2#ReleaseNotes": { + "type": "string" + }, + "com.amazonaws.wafv2#ReleaseSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#ReleaseSummary" + } + }, + "com.amazonaws.wafv2#ReleaseSummary": { + "type": "structure", + "members": { + "ReleaseVersion": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "

The release version.

" + } + }, + "Timestamp": { + "target": "com.amazonaws.wafv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of the release.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

High level information for an SDK release.

" + } + }, + "com.amazonaws.wafv2#RequestBody": { + "type": "map", + "key": { + "target": "com.amazonaws.wafv2#AssociatedResourceType" + }, + "value": { + "target": "com.amazonaws.wafv2#RequestBodyAssociatedResourceTypeConfig" + } + }, + "com.amazonaws.wafv2#RequestBodyAssociatedResourceTypeConfig": { + "type": "structure", + "members": { + "DefaultSizeInspectionLimit": { + "target": "com.amazonaws.wafv2#SizeInspectionLimit", + "traits": { + "smithy.api#documentation": "

Specifies the maximum size of the web request body component that an associated CloudFront distribution should send to WAF for inspection. This applies to statements in the web ACL that inspect the body or JSON body.

\n

Default: 16 KB (16,384 kilobytes)\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Customizes the maximum size of the request body that your protected CloudFront distributions forward to WAF for inspection. The default size is 16 KB (16,384 kilobytes).

\n \n

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

\n \n

This is used in the AssociationConfig of the web ACL.

" + } + }, + "com.amazonaws.wafv2#RequestInspection": { + "type": "structure", + "members": { + "PayloadType": { + "target": "com.amazonaws.wafv2#PayloadType", + "traits": { + "smithy.api#documentation": "

The payload type for your login endpoint, either JSON or form encoded.

", + "smithy.api#required": {} + } + }, + "UsernameField": { + "target": "com.amazonaws.wafv2#UsernameField", + "traits": { + "smithy.api#documentation": "

The name of the field in the request payload that contains your customer's username.

\n

How you specify this depends on the request inspection payload type.

\n ", + "smithy.api#required": {} + } + }, + "PasswordField": { + "target": "com.amazonaws.wafv2#PasswordField", + "traits": { + "smithy.api#documentation": "

The name of the field in the request payload that contains your customer's password.

\n

How you specify this depends on the request inspection payload type.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage.

\n

This is part of the AWSManagedRulesATPRuleSet configuration in ManagedRuleGroupConfig.

\n

In these settings, you specify how your application accepts login attempts\n by providing the request payload type and the names of the fields \n within the request body where the username and password are provided.

" + } + }, + "com.amazonaws.wafv2#RequestInspectionACFP": { + "type": "structure", + "members": { + "PayloadType": { + "target": "com.amazonaws.wafv2#PayloadType", + "traits": { + "smithy.api#documentation": "

The payload type for your account creation endpoint, either JSON or form encoded.

", + "smithy.api#required": {} + } + }, + "UsernameField": { + "target": "com.amazonaws.wafv2#UsernameField", + "traits": { + "smithy.api#documentation": "

The name of the field in the request payload that contains your customer's username.

\n

How you specify this depends on the request inspection payload type.

\n " + } + }, + "PasswordField": { + "target": "com.amazonaws.wafv2#PasswordField", + "traits": { + "smithy.api#documentation": "

The name of the field in the request payload that contains your customer's password.

\n

How you specify this depends on the request inspection payload type.

\n " + } + }, + "EmailField": { + "target": "com.amazonaws.wafv2#EmailField", + "traits": { + "smithy.api#documentation": "

The name of the field in the request payload that contains your customer's email.

\n

How you specify this depends on the request inspection payload type.

\n " + } + }, + "PhoneNumberFields": { + "target": "com.amazonaws.wafv2#PhoneNumberFields", + "traits": { + "smithy.api#documentation": "

The names of the fields in the request payload that contain your customer's primary phone number.

\n

Order the phone number fields in the array exactly as they are ordered in the request payload.

\n

How you specify the phone number fields depends on the request inspection payload type.

\n " + } + }, + "AddressFields": { + "target": "com.amazonaws.wafv2#AddressFields", + "traits": { + "smithy.api#documentation": "

The names of the fields in the request payload that contain your customer's primary physical address.

\n

Order the address fields in the array exactly as they are ordered in the request payload.

\n

How you specify the address fields depends on the request inspection payload type.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

The criteria for inspecting account creation requests, used by the ACFP rule group to validate and track account creation attempts.

\n

This is part of the AWSManagedRulesACFPRuleSet configuration in ManagedRuleGroupConfig.

\n

In these settings, you specify how your application accepts account creation attempts\n by providing the request payload type and the names of the fields \n within the request body where the username, password, email, and primary address and phone number fields are provided.

" + } + }, + "com.amazonaws.wafv2#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.wafv2#ResourceArns": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#ResourceArn" + } + }, + "com.amazonaws.wafv2#ResourceType": { + "type": "enum", + "members": { + "APPLICATION_LOAD_BALANCER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPLICATION_LOAD_BALANCER" + } + }, + "API_GATEWAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "API_GATEWAY" + } + }, + "APPSYNC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPSYNC" + } + }, + "COGNITIO_USER_POOL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COGNITO_USER_POOL" + } + }, + "APP_RUNNER_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APP_RUNNER_SERVICE" + } + }, + "VERIFIED_ACCESS_INSTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VERIFIED_ACCESS_INSTANCE" + } + } + } + }, + "com.amazonaws.wafv2#ResponseCode": { + "type": "integer" + }, + "com.amazonaws.wafv2#ResponseContent": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10240 + }, + "smithy.api#pattern": "^[\\s\\S]*$" + } + }, + "com.amazonaws.wafv2#ResponseContentType": { + "type": "enum", + "members": { + "TEXT_PLAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXT_PLAIN" + } + }, + "TEXT_HTML": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXT_HTML" + } + }, + "APPLICATION_JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPLICATION_JSON" + } + } + } + }, + "com.amazonaws.wafv2#ResponseInspection": { + "type": "structure", + "members": { + "StatusCode": { + "target": "com.amazonaws.wafv2#ResponseInspectionStatusCode", + "traits": { + "smithy.api#documentation": "

Configures inspection of the response status code for success and failure indicators.

" + } + }, + "Header": { + "target": "com.amazonaws.wafv2#ResponseInspectionHeader", + "traits": { + "smithy.api#documentation": "

Configures inspection of the response header for success and failure indicators.

" + } + }, + "BodyContains": { + "target": "com.amazonaws.wafv2#ResponseInspectionBodyContains", + "traits": { + "smithy.api#documentation": "

Configures inspection of the response body for success and failure indicators. WAF can inspect the first 65,536 bytes (64 KB) of the response body.

" + } + }, + "Json": { + "target": "com.amazonaws.wafv2#ResponseInspectionJson", + "traits": { + "smithy.api#documentation": "

Configures inspection of the response JSON for success and failure indicators. WAF can inspect the first 65,536 bytes (64 KB) of the response JSON.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The criteria for inspecting responses to login requests and account creation requests, used by the ATP and ACFP rule groups to track login and account creation success and failure rates.

\n \n

Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

\n \n

The rule groups evaluates the responses that your protected resources send back to client login and account creation attempts, keeping count of successful and failed attempts from each IP address and client session. Using this information, the rule group labels \n and mitigates requests from client sessions and IP addresses with too much suspicious activity in a short amount of time.

\n

This is part of the AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet configurations in ManagedRuleGroupConfig.

\n

Enable response inspection by configuring exactly one component of the response to inspect, for example, Header or StatusCode. You can't configure more than one component for inspection. If you don't configure any of the response inspection options, response inspection is disabled.

" + } + }, + "com.amazonaws.wafv2#ResponseInspectionBodyContains": { + "type": "structure", + "members": { + "SuccessStrings": { + "target": "com.amazonaws.wafv2#ResponseInspectionBodyContainsSuccessStrings", + "traits": { + "smithy.api#documentation": "

Strings in the body of the response that indicate a successful login or account creation attempt. To be counted as a success, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings.

\n

JSON examples: \"SuccessStrings\": [ \"Login successful\" ] and \"SuccessStrings\": [ \"Account creation successful\", \"Welcome to our site!\" ]\n

", + "smithy.api#required": {} + } + }, + "FailureStrings": { + "target": "com.amazonaws.wafv2#ResponseInspectionBodyContainsFailureStrings", + "traits": { + "smithy.api#documentation": "

Strings in the body of the response that indicate a failed login or account creation attempt. To be counted as a failure, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings.

\n

JSON example: \"FailureStrings\": [ \"Request failed\" ]\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Configures inspection of the response body. WAF can inspect the first 65,536 bytes (64 KB) of the response body. \n This is part of the ResponseInspection configuration for AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet.

\n \n

Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

\n " + } + }, + "com.amazonaws.wafv2#ResponseInspectionBodyContainsFailureStrings": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#FailureValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.wafv2#ResponseInspectionBodyContainsSuccessStrings": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#SuccessValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.wafv2#ResponseInspectionHeader": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#ResponseInspectionHeaderName", + "traits": { + "smithy.api#documentation": "

The name of the header to match against. The name must be an exact match, including case.

\n

JSON example: \"Name\": [ \"RequestResult\" ]\n

", + "smithy.api#required": {} + } + }, + "SuccessValues": { + "target": "com.amazonaws.wafv2#ResponseInspectionHeaderSuccessValues", + "traits": { + "smithy.api#documentation": "

Values in the response header with the specified name that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.

\n

JSON examples: \"SuccessValues\": [ \"LoginPassed\", \"Successful login\" ] and \"SuccessValues\": [ \"AccountCreated\", \"Successful account creation\" ]\n

", + "smithy.api#required": {} + } + }, + "FailureValues": { + "target": "com.amazonaws.wafv2#ResponseInspectionHeaderFailureValues", + "traits": { + "smithy.api#documentation": "

Values in the response header with the specified name that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.

\n

JSON examples: \"FailureValues\": [ \"LoginFailed\", \"Failed login\" ] and \"FailureValues\": [ \"AccountCreationFailed\" ]\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Configures inspection of the response header. \n This is part of the ResponseInspection configuration for AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet.

\n \n

Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

\n " + } + }, + "com.amazonaws.wafv2#ResponseInspectionHeaderFailureValues": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#FailureValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 3 + } + } + }, + "com.amazonaws.wafv2#ResponseInspectionHeaderName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.wafv2#ResponseInspectionHeaderSuccessValues": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#SuccessValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 3 + } + } + }, + "com.amazonaws.wafv2#ResponseInspectionJson": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.wafv2#FieldIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier for the value to match against in the JSON. The identifier must be an exact match, including case.

\n

JSON examples: \"Identifier\": [ \"/login/success\" ] and \"Identifier\": [ \"/sign-up/success\" ]\n

", + "smithy.api#required": {} + } + }, + "SuccessValues": { + "target": "com.amazonaws.wafv2#ResponseInspectionJsonSuccessValues", + "traits": { + "smithy.api#documentation": "

Values for the specified identifier in the response JSON that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.

\n

JSON example: \"SuccessValues\": [ \"True\", \"Succeeded\" ]\n

", + "smithy.api#required": {} + } + }, + "FailureValues": { + "target": "com.amazonaws.wafv2#ResponseInspectionJsonFailureValues", + "traits": { + "smithy.api#documentation": "

Values for the specified identifier in the response JSON that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.

\n

JSON example: \"FailureValues\": [ \"False\", \"Failed\" ]\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Configures inspection of the response JSON. WAF can inspect the first 65,536 bytes (64 KB) of the response JSON. \n This is part of the ResponseInspection configuration for AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet.

\n \n

Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

\n " + } + }, + "com.amazonaws.wafv2#ResponseInspectionJsonFailureValues": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#FailureValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.wafv2#ResponseInspectionJsonSuccessValues": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#SuccessValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.wafv2#ResponseInspectionStatusCode": { + "type": "structure", + "members": { + "SuccessCodes": { + "target": "com.amazonaws.wafv2#ResponseInspectionStatusCodeSuccessCodes", + "traits": { + "smithy.api#documentation": "

Status codes in the response that indicate a successful login or account creation attempt. To be counted as a success, the response status code must match one of these. Each code must be unique among the success and failure status codes.

\n

JSON example: \"SuccessCodes\": [ 200, 201 ]\n

", + "smithy.api#required": {} + } + }, + "FailureCodes": { + "target": "com.amazonaws.wafv2#ResponseInspectionStatusCodeFailureCodes", + "traits": { + "smithy.api#documentation": "

Status codes in the response that indicate a failed login or account creation attempt. To be counted as a failure, the response status code must match one of these. Each code must be unique among the success and failure status codes.

\n

JSON example: \"FailureCodes\": [ 400, 404 ]\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Configures inspection of the response status code. \n This is part of the ResponseInspection configuration for AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet.

\n \n

Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

\n " + } + }, + "com.amazonaws.wafv2#ResponseInspectionStatusCodeFailureCodes": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#FailureCode" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.wafv2#ResponseInspectionStatusCodeSuccessCodes": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#SuccessCode" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.wafv2#ResponseStatusCode": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 200, + "max": 599 + } + } + }, + "com.amazonaws.wafv2#Rule": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the rule. You can't change the name of a Rule after you create\n it.

", + "smithy.api#required": {} + } + }, + "Priority": { + "target": "com.amazonaws.wafv2#RulePriority", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

If you define more than one Rule in a WebACL, WAF\n evaluates each request against the Rules in order based on the value of\n Priority. WAF processes rules with lower priority first. The priorities\n don't need to be consecutive, but they must all be different.

", + "smithy.api#required": {} + } + }, + "Statement": { + "target": "com.amazonaws.wafv2#Statement", + "traits": { + "smithy.api#documentation": "

The WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement.

", + "smithy.api#required": {} + } + }, + "Action": { + "target": "com.amazonaws.wafv2#RuleAction", + "traits": { + "smithy.api#documentation": "

The action that WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting.

\n

This is used only for rules whose statements do not reference a rule group. Rule statements that reference a rule group include RuleGroupReferenceStatement and ManagedRuleGroupStatement.

\n

You must specify either this Action setting or the rule OverrideAction setting, but not both:

\n " + } + }, + "OverrideAction": { + "target": "com.amazonaws.wafv2#OverrideAction", + "traits": { + "smithy.api#documentation": "

The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.

\n

You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

\n \n

This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count \n matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings.

\n " + } + }, + "RuleLabels": { + "target": "com.amazonaws.wafv2#Labels", + "traits": { + "smithy.api#documentation": "

Labels to apply to web requests that match the rule match statement. WAF applies\n fully qualified labels to matching web requests. A fully qualified label is the\n concatenation of a label namespace and a rule label. The rule's rule group or web ACL\n defines the label namespace.

\n

Rules that run after this rule in the web ACL can match against these labels using a\n LabelMatchStatement.

\n

For each label, provide a case-sensitive string containing optional namespaces and a\n label name, according to the following guidelines:

\n \n

For example, myLabelName or nameSpace1:nameSpace2:myLabelName.\n

" + } + }, + "VisibilityConfig": { + "target": "com.amazonaws.wafv2#VisibilityConfig", + "traits": { + "smithy.api#documentation": "

Defines and enables Amazon CloudWatch metrics and web request sample collection.

", + "smithy.api#required": {} + } + }, + "CaptchaConfig": { + "target": "com.amazonaws.wafv2#CaptchaConfig", + "traits": { + "smithy.api#documentation": "

Specifies how WAF should handle CAPTCHA evaluations. If you don't specify this, WAF uses the CAPTCHA configuration that's defined for the web ACL.

" + } + }, + "ChallengeConfig": { + "target": "com.amazonaws.wafv2#ChallengeConfig", + "traits": { + "smithy.api#documentation": "

Specifies how WAF should handle Challenge evaluations. If you don't specify this, WAF uses the challenge configuration that's defined for the web ACL.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A single rule, which you can use in a WebACL or RuleGroup to identify web requests that you want to allow, block, or count.\n Each rule includes one top-level Statement that WAF uses to\n identify matching web requests, and parameters that govern how WAF handles them.

" + } + }, + "com.amazonaws.wafv2#RuleAction": { + "type": "structure", + "members": { + "Block": { + "target": "com.amazonaws.wafv2#BlockAction", + "traits": { + "smithy.api#documentation": "

Instructs WAF to block the web request.

" + } + }, + "Allow": { + "target": "com.amazonaws.wafv2#AllowAction", + "traits": { + "smithy.api#documentation": "

Instructs WAF to allow the web request.

" + } + }, + "Count": { + "target": "com.amazonaws.wafv2#CountAction", + "traits": { + "smithy.api#documentation": "

Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.

" + } + }, + "Captcha": { + "target": "com.amazonaws.wafv2#CaptchaAction", + "traits": { + "smithy.api#documentation": "

Instructs WAF to run a CAPTCHA check against the web request.

" + } + }, + "Challenge": { + "target": "com.amazonaws.wafv2#ChallengeAction", + "traits": { + "smithy.api#documentation": "

Instructs WAF to run a Challenge check against the web request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The action that WAF should take on a web request when it matches a rule's\n statement. Settings at the web ACL level can override the rule action setting.

" + } + }, + "com.amazonaws.wafv2#RuleActionOverride": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the rule to override.

", + "smithy.api#required": {} + } + }, + "ActionToUse": { + "target": "com.amazonaws.wafv2#RuleAction", + "traits": { + "smithy.api#documentation": "

The override action to use, in place of the configured action of the rule in the rule group.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Action setting to use in the place of a rule action that is configured inside the rule group. You specify one override for each rule whose action you want to change.

\n

You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

" + } + }, + "com.amazonaws.wafv2#RuleActionOverrides": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#RuleActionOverride" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.wafv2#RuleGroup": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the rule group. You cannot change the name of a rule group after you create it.

", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", + "smithy.api#required": {} + } + }, + "Capacity": { + "target": "com.amazonaws.wafv2#CapacityUnit", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The web ACL capacity units (WCUs) required for this rule group.

\n

When you create your own rule group, you define this, and you cannot change it after creation. \n When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity \n for a set of rules using CheckCapacity.

\n

WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) \n in the WAF Developer Guide.

", + "smithy.api#required": {} + } + }, + "ARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entity.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the rule group that helps with identification.

" + } + }, + "Rules": { + "target": "com.amazonaws.wafv2#Rules", + "traits": { + "smithy.api#documentation": "

The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n

" + } + }, + "VisibilityConfig": { + "target": "com.amazonaws.wafv2#VisibilityConfig", + "traits": { + "smithy.api#documentation": "

Defines and enables Amazon CloudWatch metrics and web request sample collection.

", + "smithy.api#required": {} + } + }, + "LabelNamespace": { + "target": "com.amazonaws.wafv2#LabelName", + "traits": { + "smithy.api#documentation": "

The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.

\n " + } + }, + "CustomResponseBodies": { + "target": "com.amazonaws.wafv2#CustomResponseBodies", + "traits": { + "smithy.api#documentation": "

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas \n in the WAF Developer Guide.

" + } + }, + "AvailableLabels": { + "target": "com.amazonaws.wafv2#LabelSummaries", + "traits": { + "smithy.api#documentation": "

The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the RuleLabels for a Rule.

" + } + }, + "ConsumedLabels": { + "target": "com.amazonaws.wafv2#LabelSummaries", + "traits": { + "smithy.api#documentation": "

The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

" + } + }, + "com.amazonaws.wafv2#RuleGroupReferenceStatement": { + "type": "structure", + "members": { + "ARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entity.

", + "smithy.api#required": {} + } + }, + "ExcludedRules": { + "target": "com.amazonaws.wafv2#ExcludedRules", + "traits": { + "smithy.api#documentation": "

Rules in the referenced rule group whose actions are set to Count.

\n \n

Instead of this option, use RuleActionOverrides. It accepts any valid action setting, including Count.

\n " + } + }, + "RuleActionOverrides": { + "target": "com.amazonaws.wafv2#RuleActionOverrides", + "traits": { + "smithy.api#documentation": "

Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.

\n

You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.

\n

You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. You \n can only use a rule group reference statement at the top level inside a web ACL.

" + } + }, + "com.amazonaws.wafv2#RuleGroupSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#RuleGroupSummary" + } + }, + "com.amazonaws.wafv2#RuleGroupSummary": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the data type instance. You cannot change the name after you create the instance.

" + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

" + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the rule group that helps with identification.

" + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + } + }, + "ARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entity.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

High-level information about a RuleGroup, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RuleGroup, and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule.

" + } + }, + "com.amazonaws.wafv2#RulePriority": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.wafv2#RuleSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#RuleSummary" + } + }, + "com.amazonaws.wafv2#RuleSummary": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the rule.

" + } + }, + "Action": { + "target": "com.amazonaws.wafv2#RuleAction", + "traits": { + "smithy.api#documentation": "

The action that WAF should take on a web request when it matches a rule's\n statement. Settings at the web ACL level can override the rule action setting.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

High-level information about a Rule, returned by operations like DescribeManagedRuleGroup. This provides information like the ID, that you can use to retrieve and manage a RuleGroup, and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule.

" + } + }, + "com.amazonaws.wafv2#Rules": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#Rule" + } + }, + "com.amazonaws.wafv2#SampleWeight": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.wafv2#SampledHTTPRequest": { + "type": "structure", + "members": { + "Request": { + "target": "com.amazonaws.wafv2#HTTPRequest", + "traits": { + "smithy.api#documentation": "

A complex type that contains detailed information about the request.

", + "smithy.api#required": {} + } + }, + "Weight": { + "target": "com.amazonaws.wafv2#SampleWeight", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

A value that indicates how one result in the response relates proportionally to other\n results in the response. For example, a result that has a weight of 2\n represents roughly twice as many web requests as a result that has a weight of\n 1.

", + "smithy.api#required": {} + } + }, + "Timestamp": { + "target": "com.amazonaws.wafv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which WAF received the request from your Amazon Web Services resource, in Unix time\n format (in seconds).

" + } + }, + "Action": { + "target": "com.amazonaws.wafv2#Action", + "traits": { + "smithy.api#documentation": "

The action that WAF applied to the request.

" + } + }, + "RuleNameWithinRuleGroup": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the Rule that the request matched. For managed rule groups, the\n format for this name is ##. For your own rule groups, the format for this name is #. If the rule is not in a rule group, this field\n is absent.

" + } + }, + "RequestHeadersInserted": { + "target": "com.amazonaws.wafv2#HTTPHeaders", + "traits": { + "smithy.api#documentation": "

Custom request headers inserted by WAF into the request, according to the custom\n request configuration for the matching rule action.

" + } + }, + "ResponseCodeSent": { + "target": "com.amazonaws.wafv2#ResponseStatusCode", + "traits": { + "smithy.api#documentation": "

The response code that was sent for the request.

" + } + }, + "Labels": { + "target": "com.amazonaws.wafv2#Labels", + "traits": { + "smithy.api#documentation": "

Labels applied to the web request by matching rules. WAF applies fully qualified\n labels to matching web requests. A fully qualified label is the concatenation of a label\n namespace and a rule label. The rule's rule group or web ACL defines the label namespace.

\n

For example,\n awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or\n awswaf:managed:aws:managed-rule-set:header:encoding:utf8.

" + } + }, + "CaptchaResponse": { + "target": "com.amazonaws.wafv2#CaptchaResponse", + "traits": { + "smithy.api#documentation": "

The CAPTCHA response for the request.

" + } + }, + "ChallengeResponse": { + "target": "com.amazonaws.wafv2#ChallengeResponse", + "traits": { + "smithy.api#documentation": "

The Challenge response for the request.

" + } + }, + "OverriddenAction": { + "target": "com.amazonaws.wafv2#Action", + "traits": { + "smithy.api#documentation": "

Used only for rule group rules that have a rule action override in place in the web ACL. This is the action that the rule group rule is configured for, and not the action that was applied to the request. The action that WAF applied is the Action value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a single sampled web request. The response from GetSampledRequests includes a SampledHTTPRequests complex type\n that appears as SampledRequests in the response syntax.\n SampledHTTPRequests contains an array of SampledHTTPRequest\n objects.

" + } + }, + "com.amazonaws.wafv2#SampledHTTPRequests": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#SampledHTTPRequest" + } + }, + "com.amazonaws.wafv2#Scope": { + "type": "enum", + "members": { + "CLOUDFRONT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOUDFRONT" + } + }, + "REGIONAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REGIONAL" + } + } + } + }, + "com.amazonaws.wafv2#SearchString": { + "type": "blob" + }, + "com.amazonaws.wafv2#SensitivityLevel": { + "type": "enum", + "members": { + "LOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOW" + } + }, + "HIGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIGH" + } + } + } + }, + "com.amazonaws.wafv2#SingleCookieName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 60 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.wafv2#SingleHeader": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#FieldToMatchData", + "traits": { + "smithy.api#documentation": "

The name of the query header to inspect.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Inspect one of the headers in the web request, identified by name, for example,\n User-Agent or Referer. The name isn't case sensitive.

\n

You can filter and inspect all headers with the FieldToMatch setting\n Headers.

\n

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

\n

Example JSON: \"SingleHeader\": { \"Name\": \"haystack\" }\n

" + } + }, + "com.amazonaws.wafv2#SingleQueryArgument": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#FieldToMatchData", + "traits": { + "smithy.api#documentation": "

The name of the query argument to inspect.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Inspect one query argument in the web request, identified by name, for example\n UserName or SalesRegion. The name isn't case\n sensitive.

\n

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

\n

Example JSON: \"SingleQueryArgument\": { \"Name\": \"myArgument\" }\n

" + } + }, + "com.amazonaws.wafv2#Size": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 21474836480 + } + } + }, + "com.amazonaws.wafv2#SizeConstraintStatement": { + "type": "structure", + "members": { + "FieldToMatch": { + "target": "com.amazonaws.wafv2#FieldToMatch", + "traits": { + "smithy.api#documentation": "

The part of the web request that you want WAF to inspect.

", + "smithy.api#required": {} + } + }, + "ComparisonOperator": { + "target": "com.amazonaws.wafv2#ComparisonOperator", + "traits": { + "smithy.api#documentation": "

The operator to use to compare the request part to the size setting.

", + "smithy.api#required": {} + } + }, + "Size": { + "target": "com.amazonaws.wafv2#Size", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The size, in byte, to compare to the request part, after any transformations.

", + "smithy.api#required": {} + } + }, + "TextTransformations": { + "target": "com.amazonaws.wafv2#TextTransformations", + "traits": { + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.

\n

If you configure WAF to inspect the request body, WAF inspects only the number of bytes of the body up to the limit for the web ACL. By default, for regional web ACLs, this limit is 8 KB (8,192 kilobytes) and for CloudFront web ACLs, this limit is 16 KB (16,384 kilobytes). For CloudFront web ACLs, you can increase the limit in the web ACL AssociationConfig, for additional fees. If you know that the request body for your web requests should never exceed the inspection limit, you could use a size constraint statement to block requests that have a larger request body size.

\n

If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.

" + } + }, + "com.amazonaws.wafv2#SizeInspectionLimit": { + "type": "enum", + "members": { + "KB_16": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KB_16" + } + }, + "KB_32": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KB_32" + } + }, + "KB_48": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KB_48" + } + }, + "KB_64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KB_64" + } + } + } + }, + "com.amazonaws.wafv2#SolveTimestamp": { + "type": "long" + }, + "com.amazonaws.wafv2#SqliMatchStatement": { + "type": "structure", + "members": { + "FieldToMatch": { + "target": "com.amazonaws.wafv2#FieldToMatch", + "traits": { + "smithy.api#documentation": "

The part of the web request that you want WAF to inspect.

", + "smithy.api#required": {} + } + }, + "TextTransformations": { + "target": "com.amazonaws.wafv2#TextTransformations", + "traits": { + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.

", + "smithy.api#required": {} + } + }, + "SensitivityLevel": { + "target": "com.amazonaws.wafv2#SensitivityLevel", + "traits": { + "smithy.api#documentation": "

The sensitivity that you want WAF to use to inspect for SQL injection attacks.

\n

\n HIGH detects more attacks, but might generate more false positives, \n especially if your web requests frequently contain unusual strings. \n For information about identifying and mitigating false positives, see \n Testing and tuning in the \n WAF Developer Guide.

\n

\n LOW is generally a better choice for resources that already have other \n protections against SQL injection attacks or that have a low tolerance for false positives.

\n

Default: LOW\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A rule statement that inspects for malicious SQL code. Attackers insert malicious SQL code into web requests to do things like modify your database or extract data from it.

" + } + }, + "com.amazonaws.wafv2#Statement": { + "type": "structure", + "members": { + "ByteMatchStatement": { + "target": "com.amazonaws.wafv2#ByteMatchStatement", + "traits": { + "smithy.api#documentation": "

A rule statement that defines a string match search for WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the WAF console and the developer guide, this is called a string match statement.

" + } + }, + "SqliMatchStatement": { + "target": "com.amazonaws.wafv2#SqliMatchStatement", + "traits": { + "smithy.api#documentation": "

A rule statement that inspects for malicious SQL code. Attackers insert malicious SQL code into web requests to do things like modify your database or extract data from it.

" + } + }, + "XssMatchStatement": { + "target": "com.amazonaws.wafv2#XssMatchStatement", + "traits": { + "smithy.api#documentation": "

A rule statement that inspects for cross-site scripting (XSS) attacks. In XSS attacks, the attacker \nuses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers.

" + } + }, + "SizeConstraintStatement": { + "target": "com.amazonaws.wafv2#SizeConstraintStatement", + "traits": { + "smithy.api#documentation": "

A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.

\n

If you configure WAF to inspect the request body, WAF inspects only the number of bytes of the body up to the limit for the web ACL. By default, for regional web ACLs, this limit is 8 KB (8,192 kilobytes) and for CloudFront web ACLs, this limit is 16 KB (16,384 kilobytes). For CloudFront web ACLs, you can increase the limit in the web ACL AssociationConfig, for additional fees. If you know that the request body for your web requests should never exceed the inspection limit, you could use a size constraint statement to block requests that have a larger request body size.

\n

If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.

" + } + }, + "GeoMatchStatement": { + "target": "com.amazonaws.wafv2#GeoMatchStatement", + "traits": { + "smithy.api#documentation": "

A rule statement that labels web requests by country and region and that matches against web requests based on country code. A geo match rule labels every request that it inspects regardless of whether it finds a match.

\n \n

WAF labels requests using the alpha-2 country and region codes from the International Organization for Standardization (ISO) 3166 standard. WAF determines the codes using either the IP address in the web request origin or, if you specify it, the address in the geo match ForwardedIPConfig.

\n

If you use the web request origin, the label formats are awswaf:clientip:geo:region:- and awswaf:clientip:geo:country:.

\n

If you use a forwarded IP address, the label formats are awswaf:forwardedip:geo:region:- and awswaf:forwardedip:geo:country:.

\n

For additional details, see Geographic match rule statement in the WAF Developer Guide.

" + } + }, + "RuleGroupReferenceStatement": { + "target": "com.amazonaws.wafv2#RuleGroupReferenceStatement", + "traits": { + "smithy.api#documentation": "

A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.

\n

You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. You \n can only use a rule group reference statement at the top level inside a web ACL.

" + } + }, + "IPSetReferenceStatement": { + "target": "com.amazonaws.wafv2#IPSetReferenceStatement", + "traits": { + "smithy.api#documentation": "

A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.

\n

Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

" + } + }, + "RegexPatternSetReferenceStatement": { + "target": "com.amazonaws.wafv2#RegexPatternSetReferenceStatement", + "traits": { + "smithy.api#documentation": "

A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.

\n

Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

" + } + }, + "RateBasedStatement": { + "target": "com.amazonaws.wafv2#RateBasedStatement", + "traits": { + "smithy.api#documentation": "

A rate-based rule counts incoming requests and rate limits requests when they are coming at too fast a rate. The rule categorizes requests according to your aggregation criteria, collects them into aggregation instances, and counts and rate limits the requests for each instance.

\n

You can specify individual aggregation keys, like IP address or HTTP method. You can also specify aggregation key combinations, like IP address and HTTP method, or HTTP method, query argument, and cookie.

\n

Each unique set of values for the aggregation keys that you specify is a separate aggregation instance, with the value from each key contributing to the aggregation instance definition.

\n

For example, assume the rule evaluates web requests with the following IP address and HTTP method values:

\n \n

The rule would create different aggregation instances according to your aggregation criteria, for example:

\n \n

For any n-tuple of aggregation keys, each unique combination of values for the keys defines a separate aggregation instance, which WAF counts and rate-limits individually.

\n

You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts and rate limits requests that match the nested statement. You can use this nested scope-down statement in conjunction with your aggregation key specifications or you can just count and rate limit all requests that match the scope-down statement, without additional aggregation. When you choose to just manage all requests that match a scope-down statement, the aggregation instance is singular for the rule.

\n

You cannot nest a RateBasedStatement inside another statement, for example inside a NotStatement or OrStatement. You can define a RateBasedStatement inside a web ACL and inside a rule group.

\n

For additional information about the options, see Rate limiting web requests using rate-based rules \n in the WAF Developer Guide.

\n

If you only aggregate on the individual IP address or forwarded IP address, you can retrieve the list of IP addresses that WAF \n is currently rate limiting for a rule through the API call GetRateBasedStatementManagedKeys. This option is not available\n for other aggregation configurations.

\n

WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF.

" + } + }, + "AndStatement": { + "target": "com.amazonaws.wafv2#AndStatement", + "traits": { + "smithy.api#documentation": "

A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement.

" + } + }, + "OrStatement": { + "target": "com.amazonaws.wafv2#OrStatement", + "traits": { + "smithy.api#documentation": "

A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement.

" + } + }, + "NotStatement": { + "target": "com.amazonaws.wafv2#NotStatement", + "traits": { + "smithy.api#documentation": "

A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement.

" + } + }, + "ManagedRuleGroupStatement": { + "target": "com.amazonaws.wafv2#ManagedRuleGroupStatement", + "traits": { + "smithy.api#documentation": "

A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.

\n

You cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

\n \n

You are charged additional fees when you use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet, the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet, or the WAF Fraud Control account creation fraud prevention (ACFP) managed rule group AWSManagedRulesACFPRuleSet. For more information, see WAF Pricing.

\n " + } + }, + "LabelMatchStatement": { + "target": "com.amazonaws.wafv2#LabelMatchStatement", + "traits": { + "smithy.api#documentation": "

A rule statement to match against labels that have been added to the web request by rules that have already run in the web ACL.

\n

The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, WAF performs the search for labels that were added in the same context as the label match statement.

" + } + }, + "RegexMatchStatement": { + "target": "com.amazonaws.wafv2#RegexMatchStatement", + "traits": { + "smithy.api#documentation": "

A rule statement used to search web request components for a match against a single regular expression.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The processing guidance for a Rule, used by WAF to determine whether\n a web request matches the rule.

\n

For example specifications, see the examples section of CreateWebACL.

" + } + }, + "com.amazonaws.wafv2#Statements": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#Statement" + } + }, + "com.amazonaws.wafv2#String": { + "type": "string" + }, + "com.amazonaws.wafv2#SuccessCode": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 999 + } + } + }, + "com.amazonaws.wafv2#SuccessValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.wafv2#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.wafv2#TagKey", + "traits": { + "smithy.api#documentation": "

Part of the key:value pair that defines a tag. You can use a tag key to describe a\n category of information, such as \"customer.\" Tag keys are case-sensitive.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.wafv2#TagValue", + "traits": { + "smithy.api#documentation": "

Part of the key:value pair that defines a tag. You can use a tag value to describe a\n specific value within a category, such as \"companyA\" or \"companyB.\" Tag values are\n case-sensitive.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A tag associated with an Amazon Web Services resource. Tags are key:value pairs that you can use to\n categorize and manage your resources, for purposes like billing or other management.\n Typically, the tag key represents a category, such as \"environment\", and the tag value\n represents a specific value within that category, such as \"test,\" \"development,\" or\n \"production\". Or you might set the tag key to \"customer\" and the value to the customer name\n or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a\n resource.

\n

You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule\n groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF\n console.

" + } + }, + "com.amazonaws.wafv2#TagInfoForResource": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" + } + }, + "TagList": { + "target": "com.amazonaws.wafv2#TagList", + "traits": { + "smithy.api#documentation": "

The array of Tag objects defined for the resource.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The collection of tagging definitions for an Amazon Web Services resource. Tags are key:value pairs\n that you can use to categorize and manage your resources, for purposes like billing or\n other management. Typically, the tag key represents a category, such as \"environment\", and\n the tag value represents a specific value within that category, such as \"test,\"\n \"development,\" or \"production\". Or you might set the tag key to \"customer\" and the value to\n the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up\n to 50 tags for a resource.

\n

You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule\n groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF\n console.

" + } + }, + "com.amazonaws.wafv2#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + } + }, + "com.amazonaws.wafv2#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.wafv2#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.wafv2#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFLimitsExceededException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates tags with the specified Amazon Web Services resource. Tags are key:value pairs that you can\n use to categorize and manage your resources, for purposes like billing. For example, you\n might set the tag key to \"customer\" and the value to the customer name or ID. You can\n specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a\n resource.

\n

You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule\n groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF\n console.

" + } + }, + "com.amazonaws.wafv2#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.wafv2#TagList", + "traits": { + "smithy.api#documentation": "

An array of key:value pairs to associate with the resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + } + }, + "com.amazonaws.wafv2#TextTransformation": { + "type": "structure", + "members": { + "Priority": { + "target": "com.amazonaws.wafv2#TextTransformationPriority", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Sets the relative processing order for multiple transformations.\n WAF processes all transformations, from lowest priority to highest,\n before inspecting the transformed content. The priorities don't need to be consecutive, but\n they must all be different.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.wafv2#TextTransformationType", + "traits": { + "smithy.api#documentation": "

You can specify the following transformation types:

\n

\n BASE64_DECODE - Decode a\n Base64-encoded string.

\n

\n BASE64_DECODE_EXT - Decode a\n Base64-encoded string, but use a forgiving implementation that ignores\n characters that aren't valid.

\n

\n CMD_LINE - Command-line transformations. These are\n helpful in reducing effectiveness of attackers who inject an operating system command-line \n command and use unusual formatting to disguise some or all of the command.

\n \n

\n COMPRESS_WHITE_SPACE - Replace these characters\n with a space character (decimal 32):

\n \n

\n COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

\n

\n CSS_DECODE - Decode characters that were encoded\n using CSS 2.x escape rules syndata.html#characters. This function uses up to\n two bytes in the decoding process, so it can help to uncover ASCII characters that were\n encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in\n countering evasion, which is a combination of a backslash and non-hexadecimal characters.\n For example, ja\\vascript for javascript.

\n

\n ESCAPE_SEQ_DECODE - Decode the following ANSI C\n escape sequences: \\a, \\b, \\f, \\n,\n \\r, \\t, \\v, \\\\, \\?,\n \\', \\\", \\xHH (hexadecimal), \\0OOO\n (octal). Encodings that aren't valid remain in the output.

\n

\n HEX_DECODE - Decode a string of hexadecimal\n characters into a binary.

\n

\n HTML_ENTITY_DECODE - Replace HTML-encoded\n characters with unencoded characters. HTML_ENTITY_DECODE performs these\n operations:

\n \n

\n JS_DECODE - Decode JavaScript escape sequences. If\n a\n \\\n u\n HHHH\n code is in the full-width ASCII code range of FF01-FF5E, then the higher byte\n is used to detect and adjust the lower byte. If not, only the lower byte is used and the\n higher byte is zeroed, causing a possible loss of information.

\n

\n LOWERCASE - Convert uppercase letters (A-Z) to\n lowercase (a-z).

\n

\n MD5 - Calculate an MD5 hash from the data in the\n input. The computed hash is in a raw binary form.

\n

\n NONE - Specify NONE if you don't want\n any text transformations.

\n

\n NORMALIZE_PATH - Remove multiple slashes, directory\n self-references, and directory back-references that are not at the beginning of the input\n from an input string.

\n

\n NORMALIZE_PATH_WIN - This is the same as\n NORMALIZE_PATH, but first converts backslash characters to forward slashes.

\n

\n REMOVE_NULLS - Remove all NULL bytes\n from the input.

\n

\n REPLACE_COMMENTS - Replace each occurrence of a\n C-style comment (/* ... */) with a single space. Multiple consecutive\n occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII\n 0x20). However, a standalone termination of a comment (*/) is not acted upon.

\n

\n REPLACE_NULLS - Replace NULL bytes in the input\n with space characters (ASCII 0x20).

\n

\n SQL_HEX_DECODE - Decode SQL hex data. Example\n (0x414243) will be decoded to (ABC).

\n

\n URL_DECODE - Decode a URL-encoded value.

\n

\n URL_DECODE_UNI - Like URL_DECODE, but\n with support for Microsoft-specific %u encoding. If the code is in the\n full-width ASCII code range of FF01-FF5E, the higher byte is used to detect\n and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is\n zeroed.

\n

\n UTF8_TO_UNICODE - Convert all UTF-8 character\n sequences to Unicode. This helps input normalization, and minimizing false-positives and\n false-negatives for non-English languages.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web\n requests in an effort to bypass detection.

" + } + }, + "com.amazonaws.wafv2#TextTransformationPriority": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.wafv2#TextTransformationType": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "COMPRESS_WHITE_SPACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPRESS_WHITE_SPACE" + } + }, + "HTML_ENTITY_DECODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTML_ENTITY_DECODE" + } + }, + "LOWERCASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOWERCASE" + } + }, + "CMD_LINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CMD_LINE" + } + }, + "URL_DECODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "URL_DECODE" + } + }, + "BASE64_DECODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BASE64_DECODE" + } + }, + "HEX_DECODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HEX_DECODE" + } + }, + "MD5": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MD5" + } + }, + "REPLACE_COMMENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REPLACE_COMMENTS" + } + }, + "ESCAPE_SEQ_DECODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ESCAPE_SEQ_DECODE" + } + }, + "SQL_HEX_DECODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQL_HEX_DECODE" + } + }, + "CSS_DECODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CSS_DECODE" + } + }, + "JS_DECODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JS_DECODE" + } + }, + "NORMALIZE_PATH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NORMALIZE_PATH" + } + }, + "NORMALIZE_PATH_WIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NORMALIZE_PATH_WIN" + } + }, + "REMOVE_NULLS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REMOVE_NULLS" + } + }, + "REPLACE_NULLS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REPLACE_NULLS" + } + }, + "BASE64_DECODE_EXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BASE64_DECODE_EXT" + } + }, + "URL_DECODE_UNI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "URL_DECODE_UNI" + } + }, + "UTF8_TO_UNICODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UTF8_TO_UNICODE" + } + } + } + }, + "com.amazonaws.wafv2#TextTransformations": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#TextTransformation" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.wafv2#TimeWindow": { + "type": "structure", + "members": { + "StartTime": { + "target": "com.amazonaws.wafv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The beginning of the time range from which you want GetSampledRequests to\n return a sample of the requests that your Amazon Web Services resource received. You must specify the\n times in Coordinated Universal Time (UTC) format. UTC format includes the special\n designator, Z. For example, \"2016-09-27T14:50Z\". You can specify\n any time range in the previous three hours.

", + "smithy.api#required": {} + } + }, + "EndTime": { + "target": "com.amazonaws.wafv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The end of the time range from which you want GetSampledRequests to return\n a sample of the requests that your Amazon Web Services resource received. You must specify the times in\n Coordinated Universal Time (UTC) format. UTC format includes the special designator,\n Z. For example, \"2016-09-27T14:50Z\". You can specify any time\n range in the previous three hours.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

In a GetSampledRequests request, the StartTime and\n EndTime objects specify the time range for which you want WAF to\n return a sample of web requests.

\n

You must specify the times in Coordinated Universal Time (UTC) format. UTC format\n includes the special designator, Z. For example,\n \"2016-09-27T14:50Z\". You can specify any time range in the previous three\n hours.

\n

In a GetSampledRequests response, the StartTime and\n EndTime objects specify the time range for which WAF actually returned a\n sample of web requests. WAF gets the specified number of requests from among the first\n 5,000 requests that your Amazon Web Services resource receives during the specified time period. If your\n resource receives more than 5,000 requests during that period, WAF stops sampling after\n the 5,000th request. In that case, EndTime is the time that WAF received the\n 5,000th request.

" + } + }, + "com.amazonaws.wafv2#TimeWindowDay": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.wafv2#TimeWindowSecond": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 60, + "max": 259200 + } + } + }, + "com.amazonaws.wafv2#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.wafv2#TokenDomain": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 253 + }, + "smithy.api#pattern": "^[\\w\\.\\-/]+$" + } + }, + "com.amazonaws.wafv2#TokenDomains": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#TokenDomain" + } + }, + "com.amazonaws.wafv2#URIString": { + "type": "string" + }, + "com.amazonaws.wafv2#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFTagOperationInternalErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates tags from an Amazon Web Services resource. Tags are key:value pairs that you can\n associate with Amazon Web Services resources. For example, the tag key might be \"customer\" and the tag\n value might be \"companyA.\" You can specify one or more tags to add to each container. You\n can add up to 50 tags to each Amazon Web Services resource.

" + } + }, + "com.amazonaws.wafv2#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.wafv2#TagKeyList", + "traits": { + "smithy.api#documentation": "

An array of keys identifying the tags to disassociate from the resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#UpdateIPSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#UpdateIPSetRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#UpdateIPSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFDuplicateItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFLimitsExceededException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the specified IPSet.

\n \n

This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call.

\n

To modify an IP set, do the following:

\n
    \n
  1. \n

    Retrieve it by calling GetIPSet\n

    \n
    2. \n
  2. \n

    Update its settings as needed

    \n
    3. \n
  3. \n

    Provide the complete IP set specification to this call

    \n
    4. \n
\n \n

When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

" + } + }, + "com.amazonaws.wafv2#UpdateIPSetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the IP set. You cannot change the name of an IPSet after you create it.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the IP set that helps with identification.

" + } + }, + "Addresses": { + "target": "com.amazonaws.wafv2#IPAddresses", + "traits": { + "smithy.api#documentation": "

Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

\n

Example address strings:

\n \n

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

\n

Example JSON Addresses specifications:

\n ", + "smithy.api#required": {} + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#UpdateIPSetResponse": { + "type": "structure", + "members": { + "NextLockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#UpdateManagedRuleSetVersionExpiryDate": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#UpdateManagedRuleSetVersionExpiryDateRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#UpdateManagedRuleSetVersionExpiryDateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the expiration information for your managed rule set. Use this to initiate the\n expiration of a managed rule group version. After you initiate expiration for a version,\n WAF excludes it from the response to ListAvailableManagedRuleGroupVersions for the managed rule group.

\n \n

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

\n

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

\n " + } + }, + "com.amazonaws.wafv2#UpdateManagedRuleSetVersionExpiryDateRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

\n

This name is assigned to the corresponding managed rule group, which your customers can access and use.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

", + "smithy.api#required": {} + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#required": {} + } + }, + "VersionToExpire": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "

The version that you want to remove from your list of offerings for the named managed\n rule group.

", + "smithy.api#required": {} + } + }, + "ExpiryTimestamp": { + "target": "com.amazonaws.wafv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that you want the version to expire.

\n

Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\".

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#UpdateManagedRuleSetVersionExpiryDateResponse": { + "type": "structure", + "members": { + "ExpiringVersion": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "

The version that is set to expire.

" + } + }, + "ExpiryTimestamp": { + "target": "com.amazonaws.wafv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the version will expire.

\n

Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\".

" + } + }, + "NextLockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#UpdateRegexPatternSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#UpdateRegexPatternSetRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#UpdateRegexPatternSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFDuplicateItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFLimitsExceededException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the specified RegexPatternSet.

\n \n

This operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call.

\n

To modify a regex pattern set, do the following:

\n
    \n
  1. \n

    Retrieve it by calling GetRegexPatternSet\n

    \n
    2. \n
  2. \n

    Update its settings as needed

    \n
    3. \n
  3. \n

    Provide the complete regex pattern set specification to this call

    \n
    4. \n
\n \n

When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

" + } + }, + "com.amazonaws.wafv2#UpdateRegexPatternSetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the set. You cannot change the name after you create the set.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the set that helps with identification.

" + } + }, + "RegularExpressionList": { + "target": "com.amazonaws.wafv2#RegularExpressionList", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#UpdateRegexPatternSetResponse": { + "type": "structure", + "members": { + "NextLockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#UpdateRuleGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#UpdateRuleGroupRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#UpdateRuleGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFConfigurationWarningException" + }, + { + "target": "com.amazonaws.wafv2#WAFDuplicateItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFLimitsExceededException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + }, + { + "target": "com.amazonaws.wafv2#WAFSubscriptionNotFoundException" + }, + { + "target": "com.amazonaws.wafv2#WAFUnavailableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the specified RuleGroup.

\n \n

This operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call.

\n

To modify a rule group, do the following:

\n
    \n
  1. \n

    Retrieve it by calling GetRuleGroup\n

    \n
    2. \n
  2. \n

    Update its settings as needed

    \n
    3. \n
  3. \n

    Provide the complete rule group specification to this call

    \n
    4. \n
\n \n

When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

\n

A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

" + } + }, + "com.amazonaws.wafv2#UpdateRuleGroupRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the rule group. You cannot change the name of a rule group after you create it.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the rule group that helps with identification.

" + } + }, + "Rules": { + "target": "com.amazonaws.wafv2#Rules", + "traits": { + "smithy.api#documentation": "

The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n

" + } + }, + "VisibilityConfig": { + "target": "com.amazonaws.wafv2#VisibilityConfig", + "traits": { + "smithy.api#documentation": "

Defines and enables Amazon CloudWatch metrics and web request sample collection.

", + "smithy.api#required": {} + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#required": {} + } + }, + "CustomResponseBodies": { + "target": "com.amazonaws.wafv2#CustomResponseBodies", + "traits": { + "smithy.api#documentation": "

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas \n in the WAF Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#UpdateRuleGroupResponse": { + "type": "structure", + "members": { + "NextLockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wafv2#UpdateWebACL": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#UpdateWebACLRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#UpdateWebACLResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFConfigurationWarningException" + }, + { + "target": "com.amazonaws.wafv2#WAFDuplicateItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFExpiredManagedRuleGroupVersionException" + }, + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidResourceException" + }, + { + "target": "com.amazonaws.wafv2#WAFLimitsExceededException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + }, + { + "target": "com.amazonaws.wafv2#WAFSubscriptionNotFoundException" + }, + { + "target": "com.amazonaws.wafv2#WAFUnavailableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the specified WebACL. While updating a web ACL, WAF provides\n continuous coverage to the resources that you have associated with the web ACL.

\n \n

This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call.

\n

To modify a web ACL, do the following:

\n
    \n
  1. \n

    Retrieve it by calling GetWebACL\n

    \n
    2. \n
  2. \n

    Update its settings as needed

    \n
    3. \n
  3. \n

    Provide the complete web ACL specification to this call

    \n
    4. \n
\n \n

When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

\n

A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

" + } }, - { - "target": "com.amazonaws.wafv2#WAFDuplicateItemException" + "com.amazonaws.wafv2#UpdateWebACLRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the web ACL. You cannot change the name of a web ACL after you create it.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", + "smithy.api#required": {} + } + }, + "DefaultAction": { + "target": "com.amazonaws.wafv2#DefaultAction", + "traits": { + "smithy.api#documentation": "

The action to perform if none of the Rules contained in the WebACL match.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the web ACL that helps with identification.

" + } + }, + "Rules": { + "target": "com.amazonaws.wafv2#Rules", + "traits": { + "smithy.api#documentation": "

The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n

" + } + }, + "VisibilityConfig": { + "target": "com.amazonaws.wafv2#VisibilityConfig", + "traits": { + "smithy.api#documentation": "

Defines and enables Amazon CloudWatch metrics and web request sample collection.

", + "smithy.api#required": {} + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#required": {} + } + }, + "CustomResponseBodies": { + "target": "com.amazonaws.wafv2#CustomResponseBodies", + "traits": { + "smithy.api#documentation": "

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas \n in the WAF Developer Guide.

" + } + }, + "CaptchaConfig": { + "target": "com.amazonaws.wafv2#CaptchaConfig", + "traits": { + "smithy.api#documentation": "

Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its default settings for CaptchaConfig.

" + } + }, + "ChallengeConfig": { + "target": "com.amazonaws.wafv2#ChallengeConfig", + "traits": { + "smithy.api#documentation": "

Specifies how WAF should handle challenge evaluations for rules that don't have \ntheir own ChallengeConfig settings. If you don't specify this, WAF uses its default settings for ChallengeConfig.

" + } + }, + "TokenDomains": { + "target": "com.amazonaws.wafv2#TokenDomains", + "traits": { + "smithy.api#documentation": "

Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.

\n

Example JSON: \"TokenDomains\": { \"mywebsite.com\", \"myotherwebsite.com\" }\n

\n

Public suffixes aren't allowed. For example, you can't use usa.gov or co.uk as token domains.

" + } + }, + "AssociationConfig": { + "target": "com.amazonaws.wafv2#AssociationConfig", + "traits": { + "smithy.api#documentation": "

Specifies custom configurations for the associations between the web ACL and protected resources.

\n

Use this to customize the maximum size of the request body that your protected CloudFront distributions forward to WAF for inspection. The default is 16 KB (16,384 kilobytes).

\n \n

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" + "com.amazonaws.wafv2#UpdateWebACLResponse": { + "type": "structure", + "members": { + "NextLockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + "com.amazonaws.wafv2#UriPath": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Inspect the path component of the URI of the web request. This is the part of the web\n request that identifies a resource. For example, /images/daily-ad.jpg.

\n

This is used in the FieldToMatch specification for some web request component types.

\n

JSON specification: \"UriPath\": {}\n

" + } }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + "com.amazonaws.wafv2#UsernameField": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.wafv2#FieldIdentifier", + "traits": { + "smithy.api#documentation": "

The name of the username field.

\n

How you specify this depends on the request inspection payload type.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The name of the field in the request payload that contains your customer's username.

\n

This data type is used in the RequestInspection and RequestInspectionACFP data types.

" + } }, - { - "target": "com.amazonaws.wafv2#WAFLimitsExceededException" + "com.amazonaws.wafv2#VendorName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "\\S" + } }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + "com.amazonaws.wafv2#VersionKeyString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[\\w#:\\.\\-/]+$" + } }, - { - "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + "com.amazonaws.wafv2#VersionToPublish": { + "type": "structure", + "members": { + "AssociatedRuleGroupArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the vendor's rule group that's used in the published\n managed rule group version.

" + } + }, + "ForecastedLifetime": { + "target": "com.amazonaws.wafv2#TimeWindowDay", + "traits": { + "smithy.api#documentation": "

The amount of time the vendor expects this version of the managed rule group to last, in\n days.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A version of the named managed rule group, that the rule group's vendor publishes for\n use by customers.

\n \n

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

\n

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

\n " + } }, - { - "target": "com.amazonaws.wafv2#WAFSubscriptionNotFoundException" + "com.amazonaws.wafv2#VersionsToPublish": { + "type": "map", + "key": { + "target": "com.amazonaws.wafv2#VersionKeyString" + }, + "value": { + "target": "com.amazonaws.wafv2#VersionToPublish" + } }, - { - "target": "com.amazonaws.wafv2#WAFUnavailableEntityException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the specified RuleGroup.

\n \n

This operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call.

\n

To modify a rule group, do the following:

\n
    \n
  1. \n

    Retrieve it by calling GetRuleGroup\n

    \n
    2. \n
  2. \n

    Update its settings as needed

    \n
    3. \n
  3. \n

    Provide the complete rule group specification to this call

    \n
    4. \n
\n \n

When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

\n

A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

" - } - }, - "com.amazonaws.wafv2#UpdateRuleGroupRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the rule group. You cannot change the name of a rule group after you create it.

", - "smithy.api#required": {} - } - }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.wafv2#EntityDescription", - "traits": { - "smithy.api#documentation": "

A description of the rule group that helps with identification.

" - } - }, - "Rules": { - "target": "com.amazonaws.wafv2#Rules", - "traits": { - "smithy.api#documentation": "

The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n

" - } - }, - "VisibilityConfig": { - "target": "com.amazonaws.wafv2#VisibilityConfig", - "traits": { - "smithy.api#documentation": "

Defines and enables Amazon CloudWatch metrics and web request sample collection.

", - "smithy.api#required": {} - } - }, - "LockToken": { - "target": "com.amazonaws.wafv2#LockToken", - "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", - "smithy.api#required": {} - } - }, - "CustomResponseBodies": { - "target": "com.amazonaws.wafv2#CustomResponseBodies", - "traits": { - "smithy.api#documentation": "

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas \n in the WAF Developer Guide.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#UpdateRuleGroupResponse": { - "type": "structure", - "members": { - "NextLockToken": { - "target": "com.amazonaws.wafv2#LockToken", - "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#UpdateWebACL": { - "type": "operation", - "input": { - "target": "com.amazonaws.wafv2#UpdateWebACLRequest" - }, - "output": { - "target": "com.amazonaws.wafv2#UpdateWebACLResponse" - }, - "errors": [ - { - "target": "com.amazonaws.wafv2#WAFConfigurationWarningException" + "com.amazonaws.wafv2#VisibilityConfig": { + "type": "structure", + "members": { + "SampledRequestsEnabled": { + "target": "com.amazonaws.wafv2#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether WAF should store a sampling of the web requests that\n match the rules. You can view the sampled requests through the WAF console.

", + "smithy.api#required": {} + } + }, + "CloudWatchMetricsEnabled": { + "target": "com.amazonaws.wafv2#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the associated resource sends metrics to Amazon CloudWatch. For the\n list of available metrics, see WAF\n Metrics in the WAF Developer Guide.

\n

For web ACLs, the metrics are for web requests that have the web ACL default action applied. \n WAF applies the default action to web requests that pass the inspection of all rules \n in the web ACL without being either allowed or blocked. For more information,\nsee The web ACL default action in the WAF Developer Guide.

", + "smithy.api#required": {} + } + }, + "MetricName": { + "target": "com.amazonaws.wafv2#MetricName", + "traits": { + "smithy.api#documentation": "

A name of the Amazon CloudWatch metric dimension. The name can contain only the characters: A-Z, a-z, 0-9,\n - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't\n contain whitespace or metric names that are reserved for WAF, for example All and\n Default_Action.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines and enables Amazon CloudWatch metrics and web request sample collection.

" + } }, - { - "target": "com.amazonaws.wafv2#WAFDuplicateItemException" + "com.amazonaws.wafv2#WAFAssociatedItemException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

WAF couldn’t perform the operation because your resource is being used by another\n resource or it’s associated with another resource.

", + "smithy.api#error": "client" + } }, - { - "target": "com.amazonaws.wafv2#WAFExpiredManagedRuleGroupVersionException" + "com.amazonaws.wafv2#WAFConfigurationWarningException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The operation failed because you are inspecting the web request body, headers, or\n cookies without specifying how to handle oversize components. Rules that inspect the body\n must either provide an OversizeHandling configuration or they must be preceded\n by a SizeConstraintStatement that blocks the body content from being too\n large. Rules that inspect the headers or cookies must provide an\n OversizeHandling configuration.

\n

Provide the handling configuration and retry your operation.

\n

Alternately, you can suppress this warning by adding the following tag to the resource\n that you provide to this operation: Tag\n (key:WAF:OversizeFieldsHandlingConstraintOptOut,\n value:true).

", + "smithy.api#error": "client" + } }, - { - "target": "com.amazonaws.wafv2#WAFInternalErrorException" + "com.amazonaws.wafv2#WAFDuplicateItemException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

WAF couldn’t perform the operation because the resource that you tried to save is\n a duplicate of an existing one.

", + "smithy.api#error": "client" + } }, - { - "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + "com.amazonaws.wafv2#WAFExpiredManagedRuleGroupVersionException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The operation failed because the specified version for the managed rule group has\n expired. You can retrieve the available versions for the managed rule group by calling\n ListAvailableManagedRuleGroupVersions.

", + "smithy.api#error": "client" + } }, - { - "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + "com.amazonaws.wafv2#WAFInternalErrorException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

Your request is valid, but WAF couldn’t perform the operation because of a system\n problem. Retry your request.

", + "smithy.api#error": "server" + } }, - { - "target": "com.amazonaws.wafv2#WAFInvalidResourceException" + "com.amazonaws.wafv2#WAFInvalidOperationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The operation isn't valid.

", + "smithy.api#error": "client" + } }, - { - "target": "com.amazonaws.wafv2#WAFLimitsExceededException" + "com.amazonaws.wafv2#WAFInvalidParameterException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + }, + "Field": { + "target": "com.amazonaws.wafv2#ParameterExceptionField", + "traits": { + "smithy.api#documentation": "

The settings where the invalid parameter was found.

" + } + }, + "Parameter": { + "target": "com.amazonaws.wafv2#ParameterExceptionParameter", + "traits": { + "smithy.api#documentation": "

The invalid parameter that resulted in the exception.

" + } + }, + "Reason": { + "target": "com.amazonaws.wafv2#ErrorReason", + "traits": { + "smithy.api#documentation": "

Additional information about the exception.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The operation failed because WAF didn't recognize a parameter in the request. For\n example:

\n ", + "smithy.api#error": "client" + } }, - { - "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + "com.amazonaws.wafv2#WAFInvalidPermissionPolicyException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The operation failed because the specified policy isn't in the proper format.

\n

The policy specifications must conform to the following:

\n \n

For more information, see IAM Policies.

", + "smithy.api#error": "client" + } }, - { - "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + "com.amazonaws.wafv2#WAFInvalidResourceException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

WAF couldn’t perform the operation because the resource that you requested isn’t\n valid. Check the resource, and try again.

", + "smithy.api#error": "client" + } }, - { - "target": "com.amazonaws.wafv2#WAFSubscriptionNotFoundException" + "com.amazonaws.wafv2#WAFLimitsExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

WAF couldn’t perform the operation because you exceeded your resource limit. For\n example, the maximum number of WebACL objects that you can create for an Amazon Web Services\n account. For more information, see WAF quotas in the\n WAF Developer Guide.

", + "smithy.api#error": "client" + } }, - { - "target": "com.amazonaws.wafv2#WAFUnavailableEntityException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the specified WebACL. While updating a web ACL, WAF provides\n continuous coverage to the resources that you have associated with the web ACL.

\n \n

This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call.

\n

To modify a web ACL, do the following:

\n
    \n
  1. \n

    Retrieve it by calling GetWebACL\n

    \n
    2. \n
  2. \n

    Update its settings as needed

    \n
    3. \n
  3. \n

    Provide the complete web ACL specification to this call

    \n
    4. \n
\n \n

When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

\n

A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

" - } - }, - "com.amazonaws.wafv2#UpdateWebACLRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the web ACL. You cannot change the name of a web ACL after you create it.

", - "smithy.api#required": {} - } - }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", - "smithy.api#required": {} - } - }, - "DefaultAction": { - "target": "com.amazonaws.wafv2#DefaultAction", - "traits": { - "smithy.api#documentation": "

The action to perform if none of the Rules contained in the WebACL match.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.wafv2#EntityDescription", - "traits": { - "smithy.api#documentation": "

A description of the web ACL that helps with identification.

" - } - }, - "Rules": { - "target": "com.amazonaws.wafv2#Rules", - "traits": { - "smithy.api#documentation": "

The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n

" - } - }, - "VisibilityConfig": { - "target": "com.amazonaws.wafv2#VisibilityConfig", - "traits": { - "smithy.api#documentation": "

Defines and enables Amazon CloudWatch metrics and web request sample collection.

", - "smithy.api#required": {} - } - }, - "LockToken": { - "target": "com.amazonaws.wafv2#LockToken", - "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", - "smithy.api#required": {} - } - }, - "CustomResponseBodies": { - "target": "com.amazonaws.wafv2#CustomResponseBodies", - "traits": { - "smithy.api#documentation": "

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas \n in the WAF Developer Guide.

" - } - }, - "CaptchaConfig": { - "target": "com.amazonaws.wafv2#CaptchaConfig", - "traits": { - "smithy.api#documentation": "

Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its default settings for CaptchaConfig.

" - } - }, - "ChallengeConfig": { - "target": "com.amazonaws.wafv2#ChallengeConfig", - "traits": { - "smithy.api#documentation": "

Specifies how WAF should handle challenge evaluations for rules that don't have \ntheir own ChallengeConfig settings. If you don't specify this, WAF uses its default settings for ChallengeConfig.

" - } - }, - "TokenDomains": { - "target": "com.amazonaws.wafv2#TokenDomains", - "traits": { - "smithy.api#documentation": "

Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.

\n

Example JSON: \"TokenDomains\": { \"mywebsite.com\", \"myotherwebsite.com\" }\n

\n

Public suffixes aren't allowed. For example, you can't use usa.gov or co.uk as token domains.

" - } - }, - "AssociationConfig": { - "target": "com.amazonaws.wafv2#AssociationConfig", - "traits": { - "smithy.api#documentation": "

Specifies custom configurations for the associations between the web ACL and protected resources.

\n

Use this to customize the maximum size of the request body that your protected CloudFront distributions forward to WAF for inspection. The default is 16 KB (16,384 kilobytes).

\n \n

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

\n " - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wafv2#UpdateWebACLResponse": { - "type": "structure", - "members": { - "NextLockToken": { - "target": "com.amazonaws.wafv2#LockToken", - "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wafv2#UriPath": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

Inspect the path component of the URI of the web request. This is the part of the web\n request that identifies a resource. For example, /images/daily-ad.jpg.

\n

This is used in the FieldToMatch specification for some web request component types.

\n

JSON specification: \"UriPath\": {}\n

" - } - }, - "com.amazonaws.wafv2#UsernameField": { - "type": "structure", - "members": { - "Identifier": { - "target": "com.amazonaws.wafv2#FieldIdentifier", - "traits": { - "smithy.api#documentation": "

The name of the username field. For example /form/username.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about your login page username field for request inspection, used in the \n AWSManagedRulesATPRuleSet\n RequestInspection configuration.

" - } - }, - "com.amazonaws.wafv2#VendorName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.wafv2#VersionKeyString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[\\w#:\\.\\-/]+$" - } - }, - "com.amazonaws.wafv2#VersionToPublish": { - "type": "structure", - "members": { - "AssociatedRuleGroupArn": { - "target": "com.amazonaws.wafv2#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the vendor's rule group that's used in the published\n managed rule group version.

" - } - }, - "ForecastedLifetime": { - "target": "com.amazonaws.wafv2#TimeWindowDay", - "traits": { - "smithy.api#documentation": "

The amount of time the vendor expects this version of the managed rule group to last, in\n days.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A version of the named managed rule group, that the rule group's vendor publishes for\n use by customers.

\n \n

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

\n

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

\n " - } - }, - "com.amazonaws.wafv2#VersionsToPublish": { - "type": "map", - "key": { - "target": "com.amazonaws.wafv2#VersionKeyString" - }, - "value": { - "target": "com.amazonaws.wafv2#VersionToPublish" - } - }, - "com.amazonaws.wafv2#VisibilityConfig": { - "type": "structure", - "members": { - "SampledRequestsEnabled": { - "target": "com.amazonaws.wafv2#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether WAF should store a sampling of the web requests that\n match the rules. You can view the sampled requests through the WAF console.

", - "smithy.api#required": {} - } - }, - "CloudWatchMetricsEnabled": { - "target": "com.amazonaws.wafv2#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the associated resource sends metrics to Amazon CloudWatch. For the\n list of available metrics, see WAF\n Metrics in the WAF Developer Guide.

\n

For web ACLs, the metrics are for web requests that have the web ACL default action applied. \n WAF applies the default action to web requests that pass the inspection of all rules \n in the web ACL without being either allowed or blocked. For more information,\nsee The web ACL default action in the WAF Developer Guide.

", - "smithy.api#required": {} - } - }, - "MetricName": { - "target": "com.amazonaws.wafv2#MetricName", - "traits": { - "smithy.api#documentation": "

A name of the Amazon CloudWatch metric dimension. The name can contain only the characters: A-Z, a-z, 0-9,\n - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't\n contain whitespace or metric names that are reserved for WAF, for example All and\n Default_Action.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Defines and enables Amazon CloudWatch metrics and web request sample collection.

" - } - }, - "com.amazonaws.wafv2#WAFAssociatedItemException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.wafv2#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

WAF couldn’t perform the operation because your resource is being used by another\n resource or it’s associated with another resource.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.wafv2#WAFConfigurationWarningException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.wafv2#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The operation failed because you are inspecting the web request body, headers, or\n cookies without specifying how to handle oversize components. Rules that inspect the body\n must either provide an OversizeHandling configuration or they must be preceded\n by a SizeConstraintStatement that blocks the body content from being too\n large. Rules that inspect the headers or cookies must provide an\n OversizeHandling configuration.

\n

Provide the handling configuration and retry your operation.

\n

Alternately, you can suppress this warning by adding the following tag to the resource\n that you provide to this operation: Tag\n (key:WAF:OversizeFieldsHandlingConstraintOptOut,\n value:true).

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.wafv2#WAFDuplicateItemException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.wafv2#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

WAF couldn’t perform the operation because the resource that you tried to save is\n a duplicate of an existing one.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.wafv2#WAFExpiredManagedRuleGroupVersionException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.wafv2#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The operation failed because the specified version for the managed rule group has\n expired. You can retrieve the available versions for the managed rule group by calling\n ListAvailableManagedRuleGroupVersions.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.wafv2#WAFInternalErrorException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.wafv2#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

Your request is valid, but WAF couldn’t perform the operation because of a system\n problem. Retry your request.

", - "smithy.api#error": "server" - } - }, - "com.amazonaws.wafv2#WAFInvalidOperationException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.wafv2#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The operation isn't valid.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.wafv2#WAFInvalidParameterException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.wafv2#ErrorMessage" - }, - "Field": { - "target": "com.amazonaws.wafv2#ParameterExceptionField", - "traits": { - "smithy.api#documentation": "

The settings where the invalid parameter was found.

" - } - }, - "Parameter": { - "target": "com.amazonaws.wafv2#ParameterExceptionParameter", - "traits": { - "smithy.api#documentation": "

The invalid parameter that resulted in the exception.

" - } - }, - "Reason": { - "target": "com.amazonaws.wafv2#ErrorReason", - "traits": { - "smithy.api#documentation": "

Additional information about the exception.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The operation failed because WAF didn't recognize a parameter in the request. For\n example:

\n ", - "smithy.api#error": "client" - } - }, - "com.amazonaws.wafv2#WAFInvalidPermissionPolicyException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.wafv2#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The operation failed because the specified policy isn't in the proper format.

\n

The policy specifications must conform to the following:

\n \n

For more information, see IAM Policies.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.wafv2#WAFInvalidResourceException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.wafv2#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

WAF couldn’t perform the operation because the resource that you requested isn’t\n valid. Check the resource, and try again.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.wafv2#WAFLimitsExceededException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.wafv2#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

WAF couldn’t perform the operation because you exceeded your resource limit. For\n example, the maximum number of WebACL objects that you can create for an Amazon Web Services\n account. For more information, see WAF quotas in the\n WAF Developer Guide.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.wafv2#WAFLogDestinationPermissionIssueException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.wafv2#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The operation failed because you don't have the permissions that your logging\n configuration requires. For information, see Logging web ACL traffic information\n in the WAF Developer Guide.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.wafv2#WAFNonexistentItemException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.wafv2#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

WAF couldn’t perform the operation because your resource doesn't exist. \n If you've just created a resource that you're using in this operation, you might \n just need to wait a few minutes. It can take from a few seconds to a number of minutes \n for changes to propagate.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.wafv2#WAFOptimisticLockException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.wafv2#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

WAF couldn’t save your changes because you tried to update or delete a resource\n that has changed since you last retrieved it. Get the resource again, make any changes you\n need to make to the new copy, and retry your operation.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.wafv2#WAFServiceLinkedRoleErrorException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.wafv2#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

WAF is not able to access the service linked role. This can be caused by a\n previous PutLoggingConfiguration request, which can lock the service linked\n role for about 20 seconds. Please try your request again. The service linked role can also\n be locked by a previous DeleteServiceLinkedRole request, which can lock the\n role for 15 minutes or more. If you recently made a call to\n DeleteServiceLinkedRole, wait at least 15 minutes and try the request\n again. If you receive this same exception again, you will have to wait additional time\n until the role is unlocked.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.wafv2#WAFSubscriptionNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.wafv2#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

You tried to use a managed rule group that's available by subscription, but you aren't\n subscribed to it yet.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.wafv2#WAFTagOperationException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.wafv2#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

An error occurred during the tagging operation. Retry your request.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.wafv2#WAFTagOperationInternalErrorException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.wafv2#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

WAF couldn’t perform your tagging operation because of an internal error. Retry\n your request.

", - "smithy.api#error": "server" - } - }, - "com.amazonaws.wafv2#WAFUnavailableEntityException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.wafv2#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

WAF couldn’t retrieve a resource that you specified for this operation. \n If you've just created a resource that you're using in this operation, you might \n just need to wait a few minutes. It can take from a few seconds to a number of minutes \n for changes to propagate. Verify the resources that you are specifying in your request \n parameters and then retry the operation.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.wafv2#WAFUnsupportedAggregateKeyTypeException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.wafv2#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The rule that you've named doesn't aggregate solely on the IP address or solely on the forwarded IP address. This call \n is only available for rate-based rules with an AggregateKeyType setting of IP or FORWARDED_IP.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.wafv2#WebACL": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the web ACL. You cannot change the name of a web ACL after you create it.

", - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the WebACL. This ID is returned in the responses to\n create and list commands. You use this ID to do things like get, update, and delete a\n WebACL.

", - "smithy.api#required": {} - } - }, - "ARN": { - "target": "com.amazonaws.wafv2#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the web ACL that you want to associate with the\n resource.

", - "smithy.api#required": {} - } - }, - "DefaultAction": { - "target": "com.amazonaws.wafv2#DefaultAction", - "traits": { - "smithy.api#documentation": "

The action to perform if none of the Rules contained in the WebACL match.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.wafv2#EntityDescription", - "traits": { - "smithy.api#documentation": "

A description of the web ACL that helps with identification.

" - } - }, - "Rules": { - "target": "com.amazonaws.wafv2#Rules", - "traits": { - "smithy.api#documentation": "

The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n

" - } - }, - "VisibilityConfig": { - "target": "com.amazonaws.wafv2#VisibilityConfig", - "traits": { - "smithy.api#documentation": "

Defines and enables Amazon CloudWatch metrics and web request sample collection.

", - "smithy.api#required": {} - } - }, - "Capacity": { - "target": "com.amazonaws.wafv2#ConsumedCapacity", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The web ACL capacity units (WCUs) currently being used by this web ACL.

\n

WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) \n in the WAF Developer Guide.

" - } - }, - "PreProcessFirewallManagerRuleGroups": { - "target": "com.amazonaws.wafv2#FirewallManagerRuleGroups", - "traits": { - "smithy.api#documentation": "

The first set of rules for WAF to process in the web ACL. This is defined in an\n Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any\n rules and rule groups that you define for the web ACL are prioritized after these.

\n

In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run\n first in the web ACL and a set of rule groups to run last. Within each set, the\n administrator prioritizes the rule groups, to determine their relative processing\n order.

" - } - }, - "PostProcessFirewallManagerRuleGroups": { - "target": "com.amazonaws.wafv2#FirewallManagerRuleGroups", - "traits": { - "smithy.api#documentation": "

The last set of rules for WAF to process in the web ACL. This is defined in an\n Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any\n rules and rule groups that you define for the web ACL are prioritized before these.

\n

In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run\n first in the web ACL and a set of rule groups to run last. Within each set, the\n administrator prioritizes the rule groups, to determine their relative processing\n order.

" - } - }, - "ManagedByFirewallManager": { - "target": "com.amazonaws.wafv2#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether this web ACL is managed by Firewall Manager. If true, then only Firewall Manager can\n delete the web ACL or any Firewall Manager rule groups in the web ACL.

" - } - }, - "LabelNamespace": { - "target": "com.amazonaws.wafv2#LabelName", - "traits": { - "smithy.api#documentation": "

The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix.

\n " - } - }, - "CustomResponseBodies": { - "target": "com.amazonaws.wafv2#CustomResponseBodies", - "traits": { - "smithy.api#documentation": "

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas \n in the WAF Developer Guide.

" - } - }, - "CaptchaConfig": { - "target": "com.amazonaws.wafv2#CaptchaConfig", - "traits": { - "smithy.api#documentation": "

Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its default settings for CaptchaConfig.

" - } - }, - "ChallengeConfig": { - "target": "com.amazonaws.wafv2#ChallengeConfig", - "traits": { - "smithy.api#documentation": "

Specifies how WAF should handle challenge evaluations for rules that don't have \ntheir own ChallengeConfig settings. If you don't specify this, WAF uses its default settings for ChallengeConfig.

" - } - }, - "TokenDomains": { - "target": "com.amazonaws.wafv2#TokenDomains", - "traits": { - "smithy.api#documentation": "

Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.

" - } - }, - "AssociationConfig": { - "target": "com.amazonaws.wafv2#AssociationConfig", - "traits": { - "smithy.api#documentation": "

Specifies custom configurations for the associations between the web ACL and protected resources.

\n

Use this to customize the maximum size of the request body that your protected CloudFront distributions forward to WAF for inspection. The default is 16 KB (16,384 kilobytes).

\n \n

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

" - } - }, - "com.amazonaws.wafv2#WebACLSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.wafv2#WebACLSummary" - } - }, - "com.amazonaws.wafv2#WebACLSummary": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

The name of the web ACL. You cannot change the name of a web ACL after you create it.

" - } - }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

" - } - }, - "Description": { - "target": "com.amazonaws.wafv2#EntityDescription", - "traits": { - "smithy.api#documentation": "

A description of the web ACL that helps with identification.

" - } - }, - "LockToken": { - "target": "com.amazonaws.wafv2#LockToken", - "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" - } - }, - "ARN": { - "target": "com.amazonaws.wafv2#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entity.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

High-level information about a WebACL, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a WebACL, and the ARN, that you provide to operations like AssociateWebACL.

" - } - }, - "com.amazonaws.wafv2#XssMatchStatement": { - "type": "structure", - "members": { - "FieldToMatch": { - "target": "com.amazonaws.wafv2#FieldToMatch", - "traits": { - "smithy.api#documentation": "

The part of the web request that you want WAF to inspect.

", - "smithy.api#required": {} - } - }, - "TextTransformations": { - "target": "com.amazonaws.wafv2#TextTransformations", - "traits": { - "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.

", - "smithy.api#required": {} - } + "com.amazonaws.wafv2#WAFLogDestinationPermissionIssueException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The operation failed because you don't have the permissions that your logging\n configuration requires. For information, see Logging web ACL traffic information\n in the WAF Developer Guide.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.wafv2#WAFNonexistentItemException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

WAF couldn’t perform the operation because your resource doesn't exist. \n If you've just created a resource that you're using in this operation, you might \n just need to wait a few minutes. It can take from a few seconds to a number of minutes \n for changes to propagate.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.wafv2#WAFOptimisticLockException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

WAF couldn’t save your changes because you tried to update or delete a resource\n that has changed since you last retrieved it. Get the resource again, make any changes you\n need to make to the new copy, and retry your operation.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.wafv2#WAFServiceLinkedRoleErrorException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

WAF is not able to access the service linked role. This can be caused by a\n previous PutLoggingConfiguration request, which can lock the service linked\n role for about 20 seconds. Please try your request again. The service linked role can also\n be locked by a previous DeleteServiceLinkedRole request, which can lock the\n role for 15 minutes or more. If you recently made a call to\n DeleteServiceLinkedRole, wait at least 15 minutes and try the request\n again. If you receive this same exception again, you will have to wait additional time\n until the role is unlocked.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.wafv2#WAFSubscriptionNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

You tried to use a managed rule group that's available by subscription, but you aren't\n subscribed to it yet.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.wafv2#WAFTagOperationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

An error occurred during the tagging operation. Retry your request.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.wafv2#WAFTagOperationInternalErrorException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

WAF couldn’t perform your tagging operation because of an internal error. Retry\n your request.

", + "smithy.api#error": "server" + } + }, + "com.amazonaws.wafv2#WAFUnavailableEntityException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

WAF couldn’t retrieve a resource that you specified for this operation. \n If you've just created a resource that you're using in this operation, you might \n just need to wait a few minutes. It can take from a few seconds to a number of minutes \n for changes to propagate. Verify the resources that you are specifying in your request \n parameters and then retry the operation.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.wafv2#WAFUnsupportedAggregateKeyTypeException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The rule that you've named doesn't aggregate solely on the IP address or solely on the forwarded IP address. This call \n is only available for rate-based rules with an AggregateKeyType setting of IP or FORWARDED_IP.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.wafv2#WebACL": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the web ACL. You cannot change the name of a web ACL after you create it.

", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the WebACL. This ID is returned in the responses to\n create and list commands. You use this ID to do things like get, update, and delete a\n WebACL.

", + "smithy.api#required": {} + } + }, + "ARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the web ACL that you want to associate with the\n resource.

", + "smithy.api#required": {} + } + }, + "DefaultAction": { + "target": "com.amazonaws.wafv2#DefaultAction", + "traits": { + "smithy.api#documentation": "

The action to perform if none of the Rules contained in the WebACL match.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the web ACL that helps with identification.

" + } + }, + "Rules": { + "target": "com.amazonaws.wafv2#Rules", + "traits": { + "smithy.api#documentation": "

The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n

" + } + }, + "VisibilityConfig": { + "target": "com.amazonaws.wafv2#VisibilityConfig", + "traits": { + "smithy.api#documentation": "

Defines and enables Amazon CloudWatch metrics and web request sample collection.

", + "smithy.api#required": {} + } + }, + "Capacity": { + "target": "com.amazonaws.wafv2#ConsumedCapacity", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The web ACL capacity units (WCUs) currently being used by this web ACL.

\n

WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) \n in the WAF Developer Guide.

" + } + }, + "PreProcessFirewallManagerRuleGroups": { + "target": "com.amazonaws.wafv2#FirewallManagerRuleGroups", + "traits": { + "smithy.api#documentation": "

The first set of rules for WAF to process in the web ACL. This is defined in an\n Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any\n rules and rule groups that you define for the web ACL are prioritized after these.

\n

In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run\n first in the web ACL and a set of rule groups to run last. Within each set, the\n administrator prioritizes the rule groups, to determine their relative processing\n order.

" + } + }, + "PostProcessFirewallManagerRuleGroups": { + "target": "com.amazonaws.wafv2#FirewallManagerRuleGroups", + "traits": { + "smithy.api#documentation": "

The last set of rules for WAF to process in the web ACL. This is defined in an\n Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any\n rules and rule groups that you define for the web ACL are prioritized before these.

\n

In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run\n first in the web ACL and a set of rule groups to run last. Within each set, the\n administrator prioritizes the rule groups, to determine their relative processing\n order.

" + } + }, + "ManagedByFirewallManager": { + "target": "com.amazonaws.wafv2#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether this web ACL is managed by Firewall Manager. If true, then only Firewall Manager can\n delete the web ACL or any Firewall Manager rule groups in the web ACL.

" + } + }, + "LabelNamespace": { + "target": "com.amazonaws.wafv2#LabelName", + "traits": { + "smithy.api#documentation": "

The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix.

\n " + } + }, + "CustomResponseBodies": { + "target": "com.amazonaws.wafv2#CustomResponseBodies", + "traits": { + "smithy.api#documentation": "

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

\n

For information about customizing web requests and responses, \n see Customizing web requests and responses in WAF \n in the WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas \n in the WAF Developer Guide.

" + } + }, + "CaptchaConfig": { + "target": "com.amazonaws.wafv2#CaptchaConfig", + "traits": { + "smithy.api#documentation": "

Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its default settings for CaptchaConfig.

" + } + }, + "ChallengeConfig": { + "target": "com.amazonaws.wafv2#ChallengeConfig", + "traits": { + "smithy.api#documentation": "

Specifies how WAF should handle challenge evaluations for rules that don't have \ntheir own ChallengeConfig settings. If you don't specify this, WAF uses its default settings for ChallengeConfig.

" + } + }, + "TokenDomains": { + "target": "com.amazonaws.wafv2#TokenDomains", + "traits": { + "smithy.api#documentation": "

Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.

" + } + }, + "AssociationConfig": { + "target": "com.amazonaws.wafv2#AssociationConfig", + "traits": { + "smithy.api#documentation": "

Specifies custom configurations for the associations between the web ACL and protected resources.

\n

Use this to customize the maximum size of the request body that your protected CloudFront distributions forward to WAF for inspection. The default is 16 KB (16,384 kilobytes).

\n \n

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

" + } + }, + "com.amazonaws.wafv2#WebACLSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#WebACLSummary" + } + }, + "com.amazonaws.wafv2#WebACLSummary": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the web ACL. You cannot change the name of a web ACL after you create it.

" + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

" + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the web ACL that helps with identification.

" + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + } + }, + "ARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entity.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

High-level information about a WebACL, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a WebACL, and the ARN, that you provide to operations like AssociateWebACL.

" + } + }, + "com.amazonaws.wafv2#XssMatchStatement": { + "type": "structure", + "members": { + "FieldToMatch": { + "target": "com.amazonaws.wafv2#FieldToMatch", + "traits": { + "smithy.api#documentation": "

The part of the web request that you want WAF to inspect.

", + "smithy.api#required": {} + } + }, + "TextTransformations": { + "target": "com.amazonaws.wafv2#TextTransformations", + "traits": { + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A rule statement that inspects for cross-site scripting (XSS) attacks. In XSS attacks, the attacker \nuses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers.

" + } } - }, - "traits": { - "smithy.api#documentation": "

A rule statement that inspects for cross-site scripting (XSS) attacks. In XSS attacks, the attacker \nuses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers.

" - } } - } } diff --git a/codegen/sdk-codegen/aws-models/wellarchitected.json b/codegen/sdk-codegen/aws-models/wellarchitected.json index b2d7178a75f9..1f09035ce509 100644 --- a/codegen/sdk-codegen/aws-models/wellarchitected.json +++ b/codegen/sdk-codegen/aws-models/wellarchitected.json @@ -1,7788 +1,9493 @@ { - "smithy": "2.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] - }, - "shapes": { - "com.amazonaws.wellarchitected#AccessDeniedException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.wellarchitected#ExceptionMessage", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

User does not have sufficient access to perform this action.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.wellarchitected#AccountSummary": { - "type": "map", - "key": { - "target": "com.amazonaws.wellarchitected#CheckStatus" - }, - "value": { - "target": "com.amazonaws.wellarchitected#CheckStatusCount" - }, - "traits": { - "smithy.api#documentation": "

Account summary for a Well-Architected best practice in relation to Trusted Advisor checks.

" - } - }, - "com.amazonaws.wellarchitected#AdditionalResourceType": { - "type": "enum", - "members": { - "HELPFUL_RESOURCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HELPFUL_RESOURCE" - } - }, - "IMPROVEMENT_PLAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IMPROVEMENT_PLAN" - } - } - } - }, - "com.amazonaws.wellarchitected#AdditionalResources": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.wellarchitected#AdditionalResourceType", - "traits": { - "smithy.api#documentation": "

Type of additional resource for a custom lens.

" - } - }, - "Content": { - "target": "com.amazonaws.wellarchitected#Urls", - "traits": { - "smithy.api#documentation": "

The URLs for additional resources, either helpful resources or improvement plans, for a custom lens. Up to five additional URLs can be specified.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The choice level additional resources for a custom lens.

\n

This field does not apply to Amazon Web Services official lenses.

" - } - }, - "com.amazonaws.wellarchitected#AdditionalResourcesList": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#AdditionalResources" - } - }, - "com.amazonaws.wellarchitected#Answer": { - "type": "structure", - "members": { - "QuestionId": { - "target": "com.amazonaws.wellarchitected#QuestionId" - }, - "PillarId": { - "target": "com.amazonaws.wellarchitected#PillarId" - }, - "QuestionTitle": { - "target": "com.amazonaws.wellarchitected#QuestionTitle" - }, - "QuestionDescription": { - "target": "com.amazonaws.wellarchitected#QuestionDescription" - }, - "ImprovementPlanUrl": { - "target": "com.amazonaws.wellarchitected#ImprovementPlanUrl" - }, - "HelpfulResourceUrl": { - "target": "com.amazonaws.wellarchitected#HelpfulResourceUrl" - }, - "HelpfulResourceDisplayText": { - "target": "com.amazonaws.wellarchitected#DisplayText", - "traits": { - "smithy.api#documentation": "

The helpful resource text to be displayed for a custom lens.

\n

This field does not apply to Amazon Web Services official lenses.

" - } - }, - "Choices": { - "target": "com.amazonaws.wellarchitected#Choices" - }, - "SelectedChoices": { - "target": "com.amazonaws.wellarchitected#SelectedChoices" - }, - "ChoiceAnswers": { - "target": "com.amazonaws.wellarchitected#ChoiceAnswers", - "traits": { - "smithy.api#documentation": "

A list of selected choices to a question in your workload.

" - } - }, - "IsApplicable": { - "target": "com.amazonaws.wellarchitected#IsApplicable", - "traits": { - "smithy.api#default": false - } - }, - "Risk": { - "target": "com.amazonaws.wellarchitected#Risk" - }, - "Notes": { - "target": "com.amazonaws.wellarchitected#Notes" - }, - "Reason": { - "target": "com.amazonaws.wellarchitected#AnswerReason", - "traits": { - "smithy.api#documentation": "

The reason why the question is not applicable to your workload.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An answer of the question.

" - } - }, - "com.amazonaws.wellarchitected#AnswerReason": { - "type": "enum", - "members": { - "OUT_OF_SCOPE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OUT_OF_SCOPE" - } - }, - "BUSINESS_PRIORITIES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BUSINESS_PRIORITIES" - } - }, - "ARCHITECTURE_CONSTRAINTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ARCHITECTURE_CONSTRAINTS" - } - }, - "OTHER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OTHER" - } - }, - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - } - } - }, - "com.amazonaws.wellarchitected#AnswerSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#AnswerSummary" - }, - "traits": { - "smithy.api#documentation": "

List of answer summaries of lens review in a workload.

" - } - }, - "com.amazonaws.wellarchitected#AnswerSummary": { - "type": "structure", - "members": { - "QuestionId": { - "target": "com.amazonaws.wellarchitected#QuestionId" - }, - "PillarId": { - "target": "com.amazonaws.wellarchitected#PillarId" - }, - "QuestionTitle": { - "target": "com.amazonaws.wellarchitected#QuestionTitle" - }, - "Choices": { - "target": "com.amazonaws.wellarchitected#Choices" - }, - "SelectedChoices": { - "target": "com.amazonaws.wellarchitected#SelectedChoices" - }, - "ChoiceAnswerSummaries": { - "target": "com.amazonaws.wellarchitected#ChoiceAnswerSummaries", - "traits": { - "smithy.api#documentation": "

A list of selected choices to a question in your workload.

" - } - }, - "IsApplicable": { - "target": "com.amazonaws.wellarchitected#IsApplicable", - "traits": { - "smithy.api#default": false - } - }, - "Risk": { - "target": "com.amazonaws.wellarchitected#Risk" - }, - "Reason": { - "target": "com.amazonaws.wellarchitected#AnswerReason", - "traits": { - "smithy.api#documentation": "

The reason why a choice is non-applicable to a question in your workload.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An answer summary of a lens review in a workload.

" - } - }, - "com.amazonaws.wellarchitected#ApplicationArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2084 - }, - "smithy.api#pattern": "^arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:/applications/[a-z0-9]+$" - } - }, - "com.amazonaws.wellarchitected#AssociateLenses": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#AssociateLensesInput" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#ConflictException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Associate a lens to a workload.

\n

Up to 10 lenses can be associated with a workload in a single API operation. A \n maximum of 20 lenses can be associated with a workload.

\n \n

\n Disclaimer\n

\n

By accessing and/or applying custom lenses created by another Amazon Web Services user or account, \n you acknowledge that custom lenses created by other users and shared with you are \n Third Party Content as defined in the Amazon Web Services Customer Agreement.

\n ", - "smithy.api#http": { - "method": "PATCH", - "uri": "/workloads/{WorkloadId}/associateLenses", - "code": 200 - } - } - }, - "com.amazonaws.wellarchitected#AssociateLensesInput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "LensAliases": { - "target": "com.amazonaws.wellarchitected#LensAliases", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Input to associate lens reviews.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#AwsAccountId": { - "type": "string", - "traits": { - "smithy.api#documentation": "

An Amazon Web Services account ID.

", - "smithy.api#pattern": "^[0-9]{12}$" - } - }, - "com.amazonaws.wellarchitected#AwsRegion": { - "type": "string", - "traits": { - "smithy.api#documentation": "

An Amazon Web Services Region, for example, us-west-2 or\n ap-northeast-1.

", - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.wellarchitected#Base64String": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The Base64-encoded string representation of a lens review report.

\n

This data can be used to create a PDF file.

\n

Only returned by GetConsolidatedReport \n when PDF format is requested.

" - } - }, - "com.amazonaws.wellarchitected#BestPractice": { - "type": "structure", - "members": { - "ChoiceId": { - "target": "com.amazonaws.wellarchitected#ChoiceId" - }, - "ChoiceTitle": { - "target": "com.amazonaws.wellarchitected#ChoiceTitle" - } - }, - "traits": { - "smithy.api#documentation": "

A best practice, or question choice, that has been identified as a risk in this question.

" - } - }, - "com.amazonaws.wellarchitected#BestPractices": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#BestPractice" - } - }, - "com.amazonaws.wellarchitected#CheckDescription": { - "type": "string" - }, - "com.amazonaws.wellarchitected#CheckDetail": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.wellarchitected#CheckId", - "traits": { - "smithy.api#documentation": "

Trusted Advisor check ID.

" - } - }, - "Name": { - "target": "com.amazonaws.wellarchitected#CheckName", - "traits": { - "smithy.api#documentation": "

Trusted Advisor check name.

" - } - }, - "Description": { - "target": "com.amazonaws.wellarchitected#CheckDescription", - "traits": { - "smithy.api#documentation": "

Trusted Advisor check description.

" - } - }, - "Provider": { - "target": "com.amazonaws.wellarchitected#CheckProvider", - "traits": { - "smithy.api#documentation": "

Provider of the check related to the best practice.

" - } - }, - "LensArn": { - "target": "com.amazonaws.wellarchitected#LensArn", - "traits": { - "smithy.api#documentation": "

Well-Architected Lens ARN associated to the check.

" - } - }, - "PillarId": { - "target": "com.amazonaws.wellarchitected#PillarId" - }, - "QuestionId": { - "target": "com.amazonaws.wellarchitected#QuestionId" - }, - "ChoiceId": { - "target": "com.amazonaws.wellarchitected#ChoiceId" - }, - "Status": { - "target": "com.amazonaws.wellarchitected#CheckStatus", - "traits": { - "smithy.api#documentation": "

Status associated to the check.

" - } - }, - "AccountId": { - "target": "com.amazonaws.wellarchitected#AwsAccountId" - }, - "FlaggedResources": { - "target": "com.amazonaws.wellarchitected#FlaggedResources", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Count of flagged resources associated to the check.

" - } - }, - "Reason": { - "target": "com.amazonaws.wellarchitected#CheckFailureReason", - "traits": { - "smithy.api#documentation": "

Reason associated to the check.

" - } - }, - "UpdatedAt": { - "target": "com.amazonaws.wellarchitected#Timestamp" - } - }, - "traits": { - "smithy.api#documentation": "

Account details for a Well-Architected best practice in relation to Trusted Advisor checks.

" - } - }, - "com.amazonaws.wellarchitected#CheckDetails": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#CheckDetail" - } - }, - "com.amazonaws.wellarchitected#CheckFailureReason": { - "type": "enum", - "members": { - "ASSUME_ROLE_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ASSUME_ROLE_ERROR" - } - }, - "ACCESS_DENIED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACCESS_DENIED" - } - }, - "UNKNOWN_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNKNOWN_ERROR" - } - }, - "PREMIUM_SUPPORT_REQUIRED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PREMIUM_SUPPORT_REQUIRED" - } - } - } - }, - "com.amazonaws.wellarchitected#CheckId": { - "type": "string" - }, - "com.amazonaws.wellarchitected#CheckName": { - "type": "string" - }, - "com.amazonaws.wellarchitected#CheckProvider": { - "type": "enum", - "members": { - "TRUSTED_ADVISOR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TRUSTED_ADVISOR" - } - } - } - }, - "com.amazonaws.wellarchitected#CheckStatus": { - "type": "enum", - "members": { - "OKAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OKAY" - } - }, - "WARNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WARNING" - } - }, - "ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ERROR" - } - }, - "NOT_AVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_AVAILABLE" - } - }, - "FETCH_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FETCH_FAILED" - } - } - } - }, - "com.amazonaws.wellarchitected#CheckStatusCount": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 101 - } - } - }, - "com.amazonaws.wellarchitected#CheckSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#CheckSummary" - } - }, - "com.amazonaws.wellarchitected#CheckSummary": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.wellarchitected#CheckId", - "traits": { - "smithy.api#documentation": "

Trusted Advisor check ID.

" - } - }, - "Name": { - "target": "com.amazonaws.wellarchitected#CheckName", - "traits": { - "smithy.api#documentation": "

Trusted Advisor check name.

" - } - }, - "Provider": { - "target": "com.amazonaws.wellarchitected#CheckProvider", - "traits": { - "smithy.api#documentation": "

Provider of the check related to the best practice.

" - } - }, - "Description": { - "target": "com.amazonaws.wellarchitected#CheckDescription", - "traits": { - "smithy.api#documentation": "

Trusted Advisor check description.

" - } - }, - "UpdatedAt": { - "target": "com.amazonaws.wellarchitected#Timestamp" - }, - "LensArn": { - "target": "com.amazonaws.wellarchitected#LensArn", - "traits": { - "smithy.api#documentation": "

Well-Architected Lens ARN associated to the check.

" - } - }, - "PillarId": { - "target": "com.amazonaws.wellarchitected#PillarId" - }, - "QuestionId": { - "target": "com.amazonaws.wellarchitected#QuestionId" - }, - "ChoiceId": { - "target": "com.amazonaws.wellarchitected#ChoiceId" - }, - "Status": { - "target": "com.amazonaws.wellarchitected#CheckStatus", - "traits": { - "smithy.api#documentation": "

Status associated to the check.

" - } - }, - "AccountSummary": { - "target": "com.amazonaws.wellarchitected#AccountSummary", - "traits": { - "smithy.api#documentation": "

Account summary associated to the check.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Trusted Advisor check summary.

" - } - }, - "com.amazonaws.wellarchitected#Choice": { - "type": "structure", - "members": { - "ChoiceId": { - "target": "com.amazonaws.wellarchitected#ChoiceId" - }, - "Title": { - "target": "com.amazonaws.wellarchitected#ChoiceTitle" - }, - "Description": { - "target": "com.amazonaws.wellarchitected#ChoiceDescription" - }, - "HelpfulResource": { - "target": "com.amazonaws.wellarchitected#ChoiceContent", - "traits": { - "smithy.api#documentation": "

The helpful resource (both text and URL) for a particular choice.

\n

This field only applies to custom lenses. Each choice can have only one helpful resource.

" - } - }, - "ImprovementPlan": { - "target": "com.amazonaws.wellarchitected#ChoiceContent", - "traits": { - "smithy.api#documentation": "

The improvement plan (both text and URL) for a particular choice.

\n

This field only applies to custom lenses. Each choice can have only one improvement plan.

" - } - }, - "AdditionalResources": { - "target": "com.amazonaws.wellarchitected#AdditionalResourcesList", - "traits": { - "smithy.api#documentation": "

The additional resources for a choice in a custom lens.

\n

A choice can have up to two additional resources: one of type HELPFUL_RESOURCE, \n one of type IMPROVEMENT_PLAN, or both.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A choice available to answer question.

" - } - }, - "com.amazonaws.wellarchitected#ChoiceAnswer": { - "type": "structure", - "members": { - "ChoiceId": { - "target": "com.amazonaws.wellarchitected#ChoiceId" - }, - "Status": { - "target": "com.amazonaws.wellarchitected#ChoiceStatus", - "traits": { - "smithy.api#documentation": "

The status of a choice.

" - } - }, - "Reason": { - "target": "com.amazonaws.wellarchitected#ChoiceReason", - "traits": { - "smithy.api#documentation": "

The reason why a choice is non-applicable to a question in your workload.

" - } - }, - "Notes": { - "target": "com.amazonaws.wellarchitected#ChoiceNotes", - "traits": { - "smithy.api#documentation": "

The notes associated with a choice.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A choice that has been answered on a question in your workload.

" - } - }, - "com.amazonaws.wellarchitected#ChoiceAnswerSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#ChoiceAnswerSummary" - } - }, - "com.amazonaws.wellarchitected#ChoiceAnswerSummary": { - "type": "structure", - "members": { - "ChoiceId": { - "target": "com.amazonaws.wellarchitected#ChoiceId" - }, - "Status": { - "target": "com.amazonaws.wellarchitected#ChoiceStatus", - "traits": { - "smithy.api#documentation": "

The status of a choice.

" - } - }, - "Reason": { - "target": "com.amazonaws.wellarchitected#ChoiceReason", - "traits": { - "smithy.api#documentation": "

The reason why a choice is non-applicable to a question in your workload.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A choice summary that has been answered on a question in your workload.

" - } - }, - "com.amazonaws.wellarchitected#ChoiceAnswers": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#ChoiceAnswer" - } - }, - "com.amazonaws.wellarchitected#ChoiceContent": { - "type": "structure", - "members": { - "DisplayText": { - "target": "com.amazonaws.wellarchitected#ChoiceContentDisplayText", - "traits": { - "smithy.api#documentation": "

The display text for the choice content.

" - } - }, - "Url": { - "target": "com.amazonaws.wellarchitected#ChoiceContentUrl", - "traits": { - "smithy.api#documentation": "

The URL for the choice content.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The choice content.

" - } - }, - "com.amazonaws.wellarchitected#ChoiceContentDisplayText": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.wellarchitected#ChoiceContentUrl": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.wellarchitected#ChoiceDescription": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The description of a choice.

", - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.wellarchitected#ChoiceId": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The ID of a choice.

", - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.wellarchitected#ChoiceImprovementPlan": { - "type": "structure", - "members": { - "ChoiceId": { - "target": "com.amazonaws.wellarchitected#ChoiceId" - }, - "DisplayText": { - "target": "com.amazonaws.wellarchitected#DisplayText", - "traits": { - "smithy.api#documentation": "

The display text for the improvement plan.

" - } - }, - "ImprovementPlanUrl": { - "target": "com.amazonaws.wellarchitected#ImprovementPlanUrl" - } - }, - "traits": { - "smithy.api#documentation": "

The choice level improvement plan.

" - } - }, - "com.amazonaws.wellarchitected#ChoiceImprovementPlans": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#ChoiceImprovementPlan" - } - }, - "com.amazonaws.wellarchitected#ChoiceNotes": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 250 - } - } - }, - "com.amazonaws.wellarchitected#ChoiceReason": { - "type": "enum", - "members": { - "OUT_OF_SCOPE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OUT_OF_SCOPE" - } - }, - "BUSINESS_PRIORITIES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BUSINESS_PRIORITIES" - } - }, - "ARCHITECTURE_CONSTRAINTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ARCHITECTURE_CONSTRAINTS" - } - }, - "OTHER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OTHER" - } - }, - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - } - } - }, - "com.amazonaws.wellarchitected#ChoiceStatus": { - "type": "enum", - "members": { - "SELECTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SELECTED" - } - }, - "NOT_APPLICABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_APPLICABLE" - } - }, - "UNSELECTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNSELECTED" - } - } - } - }, - "com.amazonaws.wellarchitected#ChoiceTitle": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The title of a choice.

", - "smithy.api#length": { - "min": 1, - "max": 512 - } - } - }, - "com.amazonaws.wellarchitected#ChoiceUpdate": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.wellarchitected#ChoiceStatus", - "traits": { - "smithy.api#documentation": "

The status of a choice.

", - "smithy.api#required": {} - } - }, - "Reason": { - "target": "com.amazonaws.wellarchitected#ChoiceReason", - "traits": { - "smithy.api#documentation": "

The reason why a choice is non-applicable to a question in your workload.

" - } - }, - "Notes": { - "target": "com.amazonaws.wellarchitected#ChoiceNotes", - "traits": { - "smithy.api#documentation": "

The notes associated with a choice.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A list of choices to be updated.

" - } - }, - "com.amazonaws.wellarchitected#ChoiceUpdates": { - "type": "map", - "key": { - "target": "com.amazonaws.wellarchitected#ChoiceId" - }, - "value": { - "target": "com.amazonaws.wellarchitected#ChoiceUpdate" - } - }, - "com.amazonaws.wellarchitected#Choices": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#Choice" - }, - "traits": { - "smithy.api#documentation": "

List of choices available for a question.

" - } - }, - "com.amazonaws.wellarchitected#ClientRequestToken": { - "type": "string", - "traits": { - "smithy.api#documentation": "

A unique case-sensitive string used to ensure that this request is idempotent\n (executes only once).

\n

You should not reuse the same token for other requests. If you retry a request with\n the same client request token and the same parameters after the original request has completed\n successfully, the result of the original request is returned.

\n \n

This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs\n automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI,\n you must provide this token or the request will fail.

\n " - } - }, - "com.amazonaws.wellarchitected#ConflictException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.wellarchitected#ExceptionMessage", - "traits": { - "smithy.api#required": {} - } - }, - "ResourceId": { - "target": "com.amazonaws.wellarchitected#ExceptionResourceId", - "traits": { - "smithy.api#required": {} - } - }, - "ResourceType": { - "target": "com.amazonaws.wellarchitected#ExceptionResourceType", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The resource has already been processed, was deleted, or is too large.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.wellarchitected#ConsolidatedReportMetric": { - "type": "structure", - "members": { - "MetricType": { - "target": "com.amazonaws.wellarchitected#MetricType", - "traits": { - "smithy.api#documentation": "

The metric type of a metric in the consolidated report. Currently only WORKLOAD metric types are supported.

" - } - }, - "RiskCounts": { - "target": "com.amazonaws.wellarchitected#RiskCounts" - }, - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId" - }, - "WorkloadName": { - "target": "com.amazonaws.wellarchitected#WorkloadName" - }, - "WorkloadArn": { - "target": "com.amazonaws.wellarchitected#WorkloadArn" - }, - "UpdatedAt": { - "target": "com.amazonaws.wellarchitected#Timestamp" - }, - "Lenses": { - "target": "com.amazonaws.wellarchitected#LensMetrics", - "traits": { - "smithy.api#documentation": "

The metrics for the lenses in the workload.

" - } - }, - "LensesAppliedCount": { - "target": "com.amazonaws.wellarchitected#LensesAppliedCount", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The total number of lenses applied to the workload.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A metric that contributes to the consolidated report.

" - } - }, - "com.amazonaws.wellarchitected#ConsolidatedReportMetrics": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#ConsolidatedReportMetric" - } - }, - "com.amazonaws.wellarchitected#Count": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

A non-negative integer that denotes how many.

", - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.wellarchitected#CreateLensShare": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#CreateLensShareInput" - }, - "output": { - "target": "com.amazonaws.wellarchitected#CreateLensShareOutput" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#ConflictException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Create a lens share.

\n

The owner of a lens can share it with other Amazon Web Services accounts, users, an organization,\n and organizational units (OUs) in the same Amazon Web Services Region.\n Lenses provided by Amazon Web Services (Amazon Web Services Official Content) cannot be shared.

\n

\n Shared access to a lens is not removed until the lens invitation is deleted.

\n

If you share a lens with an organization or OU, all accounts in the organization or OU\n are granted access to the lens.

\n

For more information, see Sharing a custom lens in the\n Well-Architected Tool User Guide.

\n \n

\n Disclaimer\n

\n

By sharing your custom lenses with other Amazon Web Services accounts, \n you acknowledge that Amazon Web Services will make your custom lenses available to those \n other accounts. Those other accounts may continue to access and use your \n shared custom lenses even if you delete the custom lenses \n from your own Amazon Web Services account or terminate \n your Amazon Web Services account.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/lenses/{LensAlias}/shares", - "code": 200 - } - } - }, - "com.amazonaws.wellarchitected#CreateLensShareInput": { - "type": "structure", - "members": { - "LensAlias": { - "target": "com.amazonaws.wellarchitected#LensAlias", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "SharedWith": { - "target": "com.amazonaws.wellarchitected#SharedWith", - "traits": { - "smithy.api#required": {} - } - }, - "ClientRequestToken": { - "target": "com.amazonaws.wellarchitected#ClientRequestToken", - "traits": { - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#CreateLensShareOutput": { - "type": "structure", - "members": { - "ShareId": { - "target": "com.amazonaws.wellarchitected#ShareId" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#CreateLensVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#CreateLensVersionInput" - }, - "output": { - "target": "com.amazonaws.wellarchitected#CreateLensVersionOutput" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#ConflictException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Create a new lens version.

\n

A lens can have up to 100 versions.

\n

Use this operation to publish a new lens version after you have imported a lens. The LensAlias \n is used to identify the lens to be published. \n The owner of a lens can share the lens with other \n Amazon Web Services accounts and users in the same Amazon Web Services Region. Only the owner of a lens can delete it.\n

", - "smithy.api#http": { - "method": "POST", - "uri": "/lenses/{LensAlias}/versions", - "code": 200 - } - } - }, - "com.amazonaws.wellarchitected#CreateLensVersionInput": { - "type": "structure", - "members": { - "LensAlias": { - "target": "com.amazonaws.wellarchitected#LensAlias", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "LensVersion": { - "target": "com.amazonaws.wellarchitected#LensVersion", - "traits": { - "smithy.api#documentation": "

The version of the lens being created.

", - "smithy.api#required": {} - } - }, - "IsMajorVersion": { - "target": "com.amazonaws.wellarchitected#IsMajorVersion", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Set to true if this new major lens version.

" - } - }, - "ClientRequestToken": { - "target": "com.amazonaws.wellarchitected#ClientRequestToken", - "traits": { - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#CreateLensVersionOutput": { - "type": "structure", - "members": { - "LensArn": { - "target": "com.amazonaws.wellarchitected#LensArn", - "traits": { - "smithy.api#documentation": "

The ARN for the lens.

" - } - }, - "LensVersion": { - "target": "com.amazonaws.wellarchitected#LensVersion", - "traits": { - "smithy.api#documentation": "

The version of the lens.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#CreateMilestone": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#CreateMilestoneInput" - }, - "output": { - "target": "com.amazonaws.wellarchitected#CreateMilestoneOutput" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#ConflictException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Create a milestone for an existing workload.

", - "smithy.api#http": { - "method": "POST", - "uri": "/workloads/{WorkloadId}/milestones", - "code": 200 - } - } - }, - "com.amazonaws.wellarchitected#CreateMilestoneInput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "MilestoneName": { - "target": "com.amazonaws.wellarchitected#MilestoneName", - "traits": { - "smithy.api#required": {} - } - }, - "ClientRequestToken": { - "target": "com.amazonaws.wellarchitected#ClientRequestToken", - "traits": { - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Input for milestone creation.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#CreateMilestoneOutput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId" - }, - "MilestoneNumber": { - "target": "com.amazonaws.wellarchitected#MilestoneNumber", - "traits": { - "smithy.api#default": 0 - } - } - }, - "traits": { - "smithy.api#documentation": "

Output of a create milestone call.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#CreateWorkload": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#CreateWorkloadInput" - }, - "output": { - "target": "com.amazonaws.wellarchitected#CreateWorkloadOutput" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#ConflictException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Create a new workload.

\n

The owner of a workload can share the workload with other Amazon Web Services accounts, users,\n an organization, and organizational units (OUs) \n in the same Amazon Web Services Region. Only the owner of a workload can delete it.

\n

For more information, see Defining a Workload in the\n Well-Architected Tool User Guide.

\n \n

Either AwsRegions, NonAwsRegions, or both must be specified when\n creating a workload.

\n

You also must specify ReviewOwner, even though the\n parameter is listed as not being required in the following section.\n

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/workloads", - "code": 200 - } - } - }, - "com.amazonaws.wellarchitected#CreateWorkloadInput": { - "type": "structure", - "members": { - "WorkloadName": { - "target": "com.amazonaws.wellarchitected#WorkloadName", - "traits": { - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.wellarchitected#WorkloadDescription", - "traits": { - "smithy.api#required": {} - } - }, - "Environment": { - "target": "com.amazonaws.wellarchitected#WorkloadEnvironment", - "traits": { - "smithy.api#required": {} - } - }, - "AccountIds": { - "target": "com.amazonaws.wellarchitected#WorkloadAccountIds" - }, - "AwsRegions": { - "target": "com.amazonaws.wellarchitected#WorkloadAwsRegions" - }, - "NonAwsRegions": { - "target": "com.amazonaws.wellarchitected#WorkloadNonAwsRegions" - }, - "PillarPriorities": { - "target": "com.amazonaws.wellarchitected#WorkloadPillarPriorities" - }, - "ArchitecturalDesign": { - "target": "com.amazonaws.wellarchitected#WorkloadArchitecturalDesign" - }, - "ReviewOwner": { - "target": "com.amazonaws.wellarchitected#WorkloadReviewOwner" - }, - "IndustryType": { - "target": "com.amazonaws.wellarchitected#WorkloadIndustryType" - }, - "Industry": { - "target": "com.amazonaws.wellarchitected#WorkloadIndustry" - }, - "Lenses": { - "target": "com.amazonaws.wellarchitected#WorkloadLenses", - "traits": { - "smithy.api#required": {} - } - }, - "Notes": { - "target": "com.amazonaws.wellarchitected#Notes" - }, - "ClientRequestToken": { - "target": "com.amazonaws.wellarchitected#ClientRequestToken", - "traits": { - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.wellarchitected#TagMap", - "traits": { - "smithy.api#documentation": "

The tags to be associated with the workload.

" - } - }, - "DiscoveryConfig": { - "target": "com.amazonaws.wellarchitected#WorkloadDiscoveryConfig", - "traits": { - "smithy.api#documentation": "

Well-Architected discovery configuration settings associated to the workload.

" - } - }, - "Applications": { - "target": "com.amazonaws.wellarchitected#WorkloadApplications", - "traits": { - "smithy.api#documentation": "

List of AppRegistry application ARNs associated to the workload.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Input for workload creation.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#CreateWorkloadOutput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId" - }, - "WorkloadArn": { - "target": "com.amazonaws.wellarchitected#WorkloadArn" - } - }, - "traits": { - "smithy.api#documentation": "

Output of a create workload call.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#CreateWorkloadShare": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#CreateWorkloadShareInput" - }, - "output": { - "target": "com.amazonaws.wellarchitected#CreateWorkloadShareOutput" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#ConflictException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Create a workload share.

\n

The owner of a workload can share it with other Amazon Web Services accounts and users in the same\n Amazon Web Services Region. Shared access to a workload is not removed until the workload invitation is\n deleted.

\n

If you share a workload with an organization or OU, all accounts in the organization or OU\n are granted access to the workload.

\n

For more information, see Sharing a workload in the\n Well-Architected Tool User Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/workloads/{WorkloadId}/shares", - "code": 200 - } - } - }, - "com.amazonaws.wellarchitected#CreateWorkloadShareInput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "SharedWith": { - "target": "com.amazonaws.wellarchitected#SharedWith", - "traits": { - "smithy.api#required": {} - } - }, - "PermissionType": { - "target": "com.amazonaws.wellarchitected#PermissionType", - "traits": { - "smithy.api#required": {} - } - }, - "ClientRequestToken": { - "target": "com.amazonaws.wellarchitected#ClientRequestToken", - "traits": { - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Input for Create Workload Share

", - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#CreateWorkloadShareOutput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId" - }, - "ShareId": { - "target": "com.amazonaws.wellarchitected#ShareId" - } - }, - "traits": { - "smithy.api#documentation": "

Input for Create Workload Share

", - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#DefinitionType": { - "type": "enum", - "members": { - "WORKLOAD_METADATA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WORKLOAD_METADATA" - } - }, - "APP_REGISTRY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "APP_REGISTRY" - } - } - } - }, - "com.amazonaws.wellarchitected#DeleteLens": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#DeleteLensInput" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#ConflictException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Delete an existing lens.

\n

Only the owner of a lens can delete it. After the lens is deleted, Amazon Web Services accounts and users \n that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads.\n

\n \n

\n Disclaimer\n

\n

By sharing your custom lenses with other Amazon Web Services accounts, \n you acknowledge that Amazon Web Services will make your custom lenses available to those \n other accounts. Those other accounts may continue to access and use your \n shared custom lenses even if you delete the custom lenses \n from your own Amazon Web Services account or terminate \n your Amazon Web Services account.

\n ", - "smithy.api#http": { - "method": "DELETE", - "uri": "/lenses/{LensAlias}", - "code": 200 - } - } - }, - "com.amazonaws.wellarchitected#DeleteLensInput": { - "type": "structure", - "members": { - "LensAlias": { - "target": "com.amazonaws.wellarchitected#LensAlias", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ClientRequestToken": { - "target": "com.amazonaws.wellarchitected#ClientRequestToken", - "traits": { - "smithy.api#httpQuery": "ClientRequestToken", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "LensStatus": { - "target": "com.amazonaws.wellarchitected#LensStatusType", - "traits": { - "smithy.api#documentation": "

The status of the lens to be deleted.

", - "smithy.api#httpQuery": "LensStatus", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#DeleteLensShare": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#DeleteLensShareInput" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#ConflictException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Delete a lens share.

\n

After the lens share is deleted, Amazon Web Services accounts, users, organizations,\n and organizational units (OUs) \n that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads.

\n \n

\n Disclaimer\n

\n

By sharing your custom lenses with other Amazon Web Services accounts, \n you acknowledge that Amazon Web Services will make your custom lenses available to those \n other accounts. Those other accounts may continue to access and use your \n shared custom lenses even if you delete the custom lenses \n from your own Amazon Web Services account or terminate \n your Amazon Web Services account.

\n ", - "smithy.api#http": { - "method": "DELETE", - "uri": "/lenses/{LensAlias}/shares/{ShareId}", - "code": 200 - } - } - }, - "com.amazonaws.wellarchitected#DeleteLensShareInput": { - "type": "structure", - "members": { - "ShareId": { - "target": "com.amazonaws.wellarchitected#ShareId", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "LensAlias": { - "target": "com.amazonaws.wellarchitected#LensAlias", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ClientRequestToken": { - "target": "com.amazonaws.wellarchitected#ClientRequestToken", - "traits": { - "smithy.api#httpQuery": "ClientRequestToken", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#DeleteWorkload": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#DeleteWorkloadInput" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#ConflictException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Delete an existing workload.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/workloads/{WorkloadId}", - "code": 200 - } - } - }, - "com.amazonaws.wellarchitected#DeleteWorkloadInput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ClientRequestToken": { - "target": "com.amazonaws.wellarchitected#ClientRequestToken", - "traits": { - "smithy.api#httpQuery": "ClientRequestToken", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Input for workload deletion.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#DeleteWorkloadShare": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#DeleteWorkloadShareInput" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#ConflictException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Delete a workload share.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/workloads/{WorkloadId}/shares/{ShareId}", - "code": 200 - } - } - }, - "com.amazonaws.wellarchitected#DeleteWorkloadShareInput": { - "type": "structure", - "members": { - "ShareId": { - "target": "com.amazonaws.wellarchitected#ShareId", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ClientRequestToken": { - "target": "com.amazonaws.wellarchitected#ClientRequestToken", - "traits": { - "smithy.api#httpQuery": "ClientRequestToken", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Input for Delete Workload Share

", - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#DifferenceStatus": { - "type": "enum", - "members": { - "UPDATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATED" - } - }, - "NEW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NEW" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETED" - } - } - } - }, - "com.amazonaws.wellarchitected#DisassociateLenses": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#DisassociateLensesInput" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#ConflictException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Disassociate a lens from a workload.

\n

Up to 10 lenses can be disassociated from a workload in a single API operation.

\n \n

The Amazon Web Services Well-Architected Framework lens (wellarchitected) cannot be\n removed from a workload.

\n ", - "smithy.api#http": { - "method": "PATCH", - "uri": "/workloads/{WorkloadId}/disassociateLenses", - "code": 200 - } - } - }, - "com.amazonaws.wellarchitected#DisassociateLensesInput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "LensAliases": { - "target": "com.amazonaws.wellarchitected#LensAliases", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Input to disassociate lens reviews.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#DiscoveryIntegrationStatus": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.wellarchitected#DisplayText": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.wellarchitected#ExceptionMessage": { - "type": "string", - "traits": { - "smithy.api#documentation": "

Description of the error.

" - } - }, - "com.amazonaws.wellarchitected#ExceptionResourceId": { - "type": "string", - "traits": { - "smithy.api#documentation": "

Identifier of the resource affected.

" - } - }, - "com.amazonaws.wellarchitected#ExceptionResourceType": { - "type": "string", - "traits": { - "smithy.api#documentation": "

Type of the resource affected.

" - } - }, - "com.amazonaws.wellarchitected#ExportLens": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#ExportLensInput" - }, - "output": { - "target": "com.amazonaws.wellarchitected#ExportLensOutput" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Export an existing lens.

\n

Only the owner of a lens can export it. Lenses provided by Amazon Web Services (Amazon Web Services Official Content) \n cannot be exported.

\n

Lenses are defined in JSON. For more information, see JSON format specification \n in the Well-Architected Tool User Guide.

\n \n

\n Disclaimer\n

\n

Do not include or gather personal identifiable information (PII) of end users or \n other identifiable individuals in or via your custom lenses. If your custom \n lens or those shared with you and used in your account do include or collect \n PII you are responsible for: ensuring that the included PII is processed in accordance \n with applicable law, providing adequate privacy notices, and obtaining necessary \n consents for processing such data.

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/lenses/{LensAlias}/export", - "code": 200 - } - } - }, - "com.amazonaws.wellarchitected#ExportLensInput": { - "type": "structure", - "members": { - "LensAlias": { - "target": "com.amazonaws.wellarchitected#LensAlias", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "LensVersion": { - "target": "com.amazonaws.wellarchitected#LensVersion", - "traits": { - "smithy.api#documentation": "

The lens version to be exported.

", - "smithy.api#httpQuery": "LensVersion" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#ExportLensOutput": { - "type": "structure", - "members": { - "LensJSON": { - "target": "com.amazonaws.wellarchitected#LensJSON", - "traits": { - "smithy.api#documentation": "

The JSON representation of a lens.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#FlaggedResources": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 9999 - } - } - }, - "com.amazonaws.wellarchitected#GetAnswer": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#GetAnswerInput" - }, - "output": { - "target": "com.amazonaws.wellarchitected#GetAnswerOutput" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Get the answer to a specific question in a workload review.

", - "smithy.api#http": { - "method": "GET", - "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}/answers/{QuestionId}", - "code": 200 - } - } - }, - "com.amazonaws.wellarchitected#GetAnswerInput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "LensAlias": { - "target": "com.amazonaws.wellarchitected#LensAlias", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "QuestionId": { - "target": "com.amazonaws.wellarchitected#QuestionId", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "MilestoneNumber": { - "target": "com.amazonaws.wellarchitected#MilestoneNumber", - "traits": { - "smithy.api#default": 0, - "smithy.api#httpQuery": "MilestoneNumber" - } - } - }, - "traits": { - "smithy.api#documentation": "

Input to get answer.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#GetAnswerOutput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId" - }, - "MilestoneNumber": { - "target": "com.amazonaws.wellarchitected#MilestoneNumber", - "traits": { - "smithy.api#default": 0 - } - }, - "LensAlias": { - "target": "com.amazonaws.wellarchitected#LensAlias" - }, - "LensArn": { - "target": "com.amazonaws.wellarchitected#LensArn", - "traits": { - "smithy.api#documentation": "

The ARN for the lens.

" - } - }, - "Answer": { - "target": "com.amazonaws.wellarchitected#Answer" - } - }, - "traits": { - "smithy.api#documentation": "

Output of a get answer call.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#GetConsolidatedReport": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#GetConsolidatedReportInput" - }, - "output": { - "target": "com.amazonaws.wellarchitected#GetConsolidatedReportOutput" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#ConflictException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Get a consolidated report of your workloads.

\n

You can optionally choose to include workloads that have been shared with you.

", - "smithy.api#http": { - "method": "GET", - "uri": "/consolidatedReport", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.wellarchitected#GetConsolidatedReportInput": { - "type": "structure", - "members": { - "Format": { - "target": "com.amazonaws.wellarchitected#ReportFormat", - "traits": { - "smithy.api#documentation": "

The format of the consolidated report.

\n

For PDF, Base64String is returned. For JSON, \n Metrics is returned.

", - "smithy.api#httpQuery": "Format", - "smithy.api#required": {} - } - }, - "IncludeSharedResources": { - "target": "com.amazonaws.wellarchitected#IncludeSharedResources", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Set to true to have shared resources included in the report.

", - "smithy.api#httpQuery": "IncludeSharedResources" - } - }, - "NextToken": { - "target": "com.amazonaws.wellarchitected#NextToken", - "traits": { - "smithy.api#httpQuery": "NextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.wellarchitected#GetConsolidatedReportMaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return for this request.

", - "smithy.api#httpQuery": "MaxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#GetConsolidatedReportMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 15 - } - } - }, - "com.amazonaws.wellarchitected#GetConsolidatedReportOutput": { - "type": "structure", - "members": { - "Metrics": { - "target": "com.amazonaws.wellarchitected#ConsolidatedReportMetrics", - "traits": { - "smithy.api#documentation": "

The metrics that make up the consolidated report.

\n

Only returned when JSON format is requested.

" - } - }, - "NextToken": { - "target": "com.amazonaws.wellarchitected#NextToken" - }, - "Base64String": { - "target": "com.amazonaws.wellarchitected#Base64String" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#GetLens": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#GetLensInput" - }, - "output": { - "target": "com.amazonaws.wellarchitected#GetLensOutput" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Get an existing lens.

", - "smithy.api#http": { - "method": "GET", - "uri": "/lenses/{LensAlias}", - "code": 200 - } - } - }, - "com.amazonaws.wellarchitected#GetLensInput": { - "type": "structure", - "members": { - "LensAlias": { - "target": "com.amazonaws.wellarchitected#LensAlias", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "LensVersion": { - "target": "com.amazonaws.wellarchitected#LensVersion", - "traits": { - "smithy.api#documentation": "

The lens version to be retrieved.

", - "smithy.api#httpQuery": "LensVersion" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#GetLensOutput": { - "type": "structure", - "members": { - "Lens": { - "target": "com.amazonaws.wellarchitected#Lens", - "traits": { - "smithy.api#documentation": "

A lens return object.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#GetLensReview": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#GetLensReviewInput" - }, - "output": { - "target": "com.amazonaws.wellarchitected#GetLensReviewOutput" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Get lens review.

", - "smithy.api#http": { - "method": "GET", - "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}", - "code": 200 - } - } - }, - "com.amazonaws.wellarchitected#GetLensReviewInput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "LensAlias": { - "target": "com.amazonaws.wellarchitected#LensAlias", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "MilestoneNumber": { - "target": "com.amazonaws.wellarchitected#MilestoneNumber", - "traits": { - "smithy.api#default": 0, - "smithy.api#httpQuery": "MilestoneNumber" - } - } - }, - "traits": { - "smithy.api#documentation": "

Input to get lens review.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#GetLensReviewOutput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId" - }, - "MilestoneNumber": { - "target": "com.amazonaws.wellarchitected#MilestoneNumber", - "traits": { - "smithy.api#default": 0 - } - }, - "LensReview": { - "target": "com.amazonaws.wellarchitected#LensReview" - } - }, - "traits": { - "smithy.api#documentation": "

Output of a get lens review call.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#GetLensReviewReport": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#GetLensReviewReportInput" - }, - "output": { - "target": "com.amazonaws.wellarchitected#GetLensReviewReportOutput" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Get lens review report.

", - "smithy.api#http": { - "method": "GET", - "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}/report", - "code": 200 - } - } - }, - "com.amazonaws.wellarchitected#GetLensReviewReportInput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "LensAlias": { - "target": "com.amazonaws.wellarchitected#LensAlias", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "MilestoneNumber": { - "target": "com.amazonaws.wellarchitected#MilestoneNumber", - "traits": { - "smithy.api#default": 0, - "smithy.api#httpQuery": "MilestoneNumber" - } - } - }, - "traits": { - "smithy.api#documentation": "

Input to get lens review report.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#GetLensReviewReportOutput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId" - }, - "MilestoneNumber": { - "target": "com.amazonaws.wellarchitected#MilestoneNumber", - "traits": { - "smithy.api#default": 0 - } - }, - "LensReviewReport": { - "target": "com.amazonaws.wellarchitected#LensReviewReport" - } - }, - "traits": { - "smithy.api#documentation": "

Output of a get lens review report call.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#GetLensVersionDifference": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#GetLensVersionDifferenceInput" - }, - "output": { - "target": "com.amazonaws.wellarchitected#GetLensVersionDifferenceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Get lens version differences.

", - "smithy.api#http": { - "method": "GET", - "uri": "/lenses/{LensAlias}/versionDifference", - "code": 200 - } - } - }, - "com.amazonaws.wellarchitected#GetLensVersionDifferenceInput": { - "type": "structure", - "members": { - "LensAlias": { - "target": "com.amazonaws.wellarchitected#LensAlias", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "BaseLensVersion": { - "target": "com.amazonaws.wellarchitected#LensVersion", - "traits": { - "smithy.api#documentation": "

The base version of the lens.

", - "smithy.api#httpQuery": "BaseLensVersion" - } - }, - "TargetLensVersion": { - "target": "com.amazonaws.wellarchitected#LensVersion", - "traits": { - "smithy.api#documentation": "

The lens version to target a difference for.

", - "smithy.api#httpQuery": "TargetLensVersion" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#GetLensVersionDifferenceOutput": { - "type": "structure", - "members": { - "LensAlias": { - "target": "com.amazonaws.wellarchitected#LensAlias" - }, - "LensArn": { - "target": "com.amazonaws.wellarchitected#LensArn", - "traits": { - "smithy.api#documentation": "

The ARN for the lens.

" - } - }, - "BaseLensVersion": { - "target": "com.amazonaws.wellarchitected#LensVersion", - "traits": { - "smithy.api#documentation": "

The base version of the lens.

" - } - }, - "TargetLensVersion": { - "target": "com.amazonaws.wellarchitected#LensVersion", - "traits": { - "smithy.api#documentation": "

The target lens version for the lens.

" - } - }, - "LatestLensVersion": { - "target": "com.amazonaws.wellarchitected#LensVersion", - "traits": { - "smithy.api#documentation": "

The latest version of the lens.

" - } - }, - "VersionDifferences": { - "target": "com.amazonaws.wellarchitected#VersionDifferences" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#GetMilestone": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#GetMilestoneInput" - }, - "output": { - "target": "com.amazonaws.wellarchitected#GetMilestoneOutput" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Get a milestone for an existing workload.

", - "smithy.api#http": { - "method": "GET", - "uri": "/workloads/{WorkloadId}/milestones/{MilestoneNumber}", - "code": 200 - } - } - }, - "com.amazonaws.wellarchitected#GetMilestoneInput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "MilestoneNumber": { - "target": "com.amazonaws.wellarchitected#MilestoneNumber", - "traits": { - "smithy.api#default": 0, - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Input to get a milestone.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#GetMilestoneOutput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId" - }, - "Milestone": { - "target": "com.amazonaws.wellarchitected#Milestone" - } - }, - "traits": { - "smithy.api#documentation": "

Output of a get milestone call.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#GetWorkload": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#GetWorkloadInput" - }, - "output": { - "target": "com.amazonaws.wellarchitected#GetWorkloadOutput" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Get an existing workload.

", - "smithy.api#http": { - "method": "GET", - "uri": "/workloads/{WorkloadId}", - "code": 200 - } - } - }, - "com.amazonaws.wellarchitected#GetWorkloadInput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Input to get a workload.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#GetWorkloadOutput": { - "type": "structure", - "members": { - "Workload": { - "target": "com.amazonaws.wellarchitected#Workload" - } - }, - "traits": { - "smithy.api#documentation": "

Output of a get workload call.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#HelpfulResourceUrl": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The helpful resource URL.

\n

For Amazon Web Services official lenses, this is the helpful resource URL for a question or choice.

\n

For custom lenses, this is the helpful resource URL for a question and is only provided\n if HelpfulResourceDisplayText was specified for the question.

", - "smithy.api#length": { - "min": 1, - "max": 2048 - } - } - }, - "com.amazonaws.wellarchitected#ImportLens": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#ImportLensInput" - }, - "output": { - "target": "com.amazonaws.wellarchitected#ImportLensOutput" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#ConflictException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Import a new custom lens or update an existing custom lens.

\n

To update an existing custom lens, specify its ARN as the LensAlias. If\n no ARN is specified, a new custom lens is created.

\n

The new or updated lens will have a status of DRAFT. The lens cannot be\n applied to workloads or shared with other Amazon Web Services accounts until it's\n published with CreateLensVersion.

\n

Lenses are defined in JSON. For more information, see JSON format specification \n in the Well-Architected Tool User Guide.

\n

A custom lens cannot exceed 500 KB in size.

\n \n

\n Disclaimer\n

\n

Do not include or gather personal identifiable information (PII) of end users or \n other identifiable individuals in or via your custom lenses. If your custom \n lens or those shared with you and used in your account do include or collect \n PII you are responsible for: ensuring that the included PII is processed in accordance \n with applicable law, providing adequate privacy notices, and obtaining necessary \n consents for processing such data.

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/importLens", - "code": 200 - } - } - }, - "com.amazonaws.wellarchitected#ImportLensInput": { - "type": "structure", - "members": { - "LensAlias": { - "target": "com.amazonaws.wellarchitected#LensAlias" - }, - "JSONString": { - "target": "com.amazonaws.wellarchitected#LensJSON", - "traits": { - "smithy.api#documentation": "

The JSON representation of a lens.

", - "smithy.api#required": {} - } - }, - "ClientRequestToken": { - "target": "com.amazonaws.wellarchitected#ClientRequestToken", - "traits": { - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.wellarchitected#TagMap", - "traits": { - "smithy.api#documentation": "

Tags to associate to a lens.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#ImportLensOutput": { - "type": "structure", - "members": { - "LensArn": { - "target": "com.amazonaws.wellarchitected#LensArn", - "traits": { - "smithy.api#documentation": "

The ARN for the lens that was created or updated.

" - } - }, - "Status": { - "target": "com.amazonaws.wellarchitected#ImportLensStatus", - "traits": { - "smithy.api#documentation": "

The status of the imported lens.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#ImportLensStatus": { - "type": "enum", - "members": { - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_PROGRESS" - } - }, - "COMPLETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETE" - } - }, - "ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ERROR" - } - } - } - }, - "com.amazonaws.wellarchitected#ImprovementPlanUrl": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The improvement plan URL for a question in an Amazon Web Services official lenses.

\n

This value is only available if the question has been answered.

\n

This value does not apply to custom lenses.

", - "smithy.api#length": { - "min": 1, - "max": 2048 - } - } - }, - "com.amazonaws.wellarchitected#ImprovementSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#ImprovementSummary" - }, - "traits": { - "smithy.api#documentation": "

List of improvement summaries of lens review in a workload.

" - } - }, - "com.amazonaws.wellarchitected#ImprovementSummary": { - "type": "structure", - "members": { - "QuestionId": { - "target": "com.amazonaws.wellarchitected#QuestionId" + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.wellarchitected#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wellarchitected#ExceptionMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

User does not have sufficient access to perform this action.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.wellarchitected#AccountSummary": { + "type": "map", + "key": { + "target": "com.amazonaws.wellarchitected#CheckStatus" + }, + "value": { + "target": "com.amazonaws.wellarchitected#CheckStatusCount" + }, + "traits": { + "smithy.api#documentation": "

Account summary for a Well-Architected best practice in relation to Trusted Advisor checks.

" + } + }, + "com.amazonaws.wellarchitected#AdditionalResourceType": { + "type": "enum", + "members": { + "HELPFUL_RESOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HELPFUL_RESOURCE" + } + }, + "IMPROVEMENT_PLAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPROVEMENT_PLAN" + } + } + } + }, + "com.amazonaws.wellarchitected#AdditionalResources": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.wellarchitected#AdditionalResourceType", + "traits": { + "smithy.api#documentation": "

Type of additional resource for a custom lens.

" + } + }, + "Content": { + "target": "com.amazonaws.wellarchitected#Urls", + "traits": { + "smithy.api#documentation": "

The URLs for additional resources, either helpful resources or improvement plans, for a custom lens. Up to five additional URLs can be specified.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The choice level additional resources for a custom lens.

\n

This field does not apply to Amazon Web Services official lenses.

" + } + }, + "com.amazonaws.wellarchitected#AdditionalResourcesList": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#AdditionalResources" + } + }, + "com.amazonaws.wellarchitected#Answer": { + "type": "structure", + "members": { + "QuestionId": { + "target": "com.amazonaws.wellarchitected#QuestionId" + }, + "PillarId": { + "target": "com.amazonaws.wellarchitected#PillarId" + }, + "QuestionTitle": { + "target": "com.amazonaws.wellarchitected#QuestionTitle" + }, + "QuestionDescription": { + "target": "com.amazonaws.wellarchitected#QuestionDescription" + }, + "ImprovementPlanUrl": { + "target": "com.amazonaws.wellarchitected#ImprovementPlanUrl" + }, + "HelpfulResourceUrl": { + "target": "com.amazonaws.wellarchitected#HelpfulResourceUrl" + }, + "HelpfulResourceDisplayText": { + "target": "com.amazonaws.wellarchitected#DisplayText", + "traits": { + "smithy.api#documentation": "

The helpful resource text to be displayed for a custom lens.

\n

This field does not apply to Amazon Web Services official lenses.

" + } + }, + "Choices": { + "target": "com.amazonaws.wellarchitected#Choices" + }, + "SelectedChoices": { + "target": "com.amazonaws.wellarchitected#SelectedChoices" + }, + "ChoiceAnswers": { + "target": "com.amazonaws.wellarchitected#ChoiceAnswers", + "traits": { + "smithy.api#documentation": "

A list of selected choices to a question in your workload.

" + } + }, + "IsApplicable": { + "target": "com.amazonaws.wellarchitected#IsApplicable", + "traits": { + "smithy.api#default": false + } + }, + "Risk": { + "target": "com.amazonaws.wellarchitected#Risk" + }, + "Notes": { + "target": "com.amazonaws.wellarchitected#Notes" + }, + "Reason": { + "target": "com.amazonaws.wellarchitected#AnswerReason", + "traits": { + "smithy.api#documentation": "

The reason why the question is not applicable to your workload.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An answer of the question.

" + } + }, + "com.amazonaws.wellarchitected#AnswerReason": { + "type": "enum", + "members": { + "OUT_OF_SCOPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OUT_OF_SCOPE" + } + }, + "BUSINESS_PRIORITIES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BUSINESS_PRIORITIES" + } + }, + "ARCHITECTURE_CONSTRAINTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARCHITECTURE_CONSTRAINTS" + } + }, + "OTHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OTHER" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.wellarchitected#AnswerSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#AnswerSummary" + }, + "traits": { + "smithy.api#documentation": "

List of answer summaries of lens review in a workload.

" + } + }, + "com.amazonaws.wellarchitected#AnswerSummary": { + "type": "structure", + "members": { + "QuestionId": { + "target": "com.amazonaws.wellarchitected#QuestionId" + }, + "PillarId": { + "target": "com.amazonaws.wellarchitected#PillarId" + }, + "QuestionTitle": { + "target": "com.amazonaws.wellarchitected#QuestionTitle" + }, + "Choices": { + "target": "com.amazonaws.wellarchitected#Choices" + }, + "SelectedChoices": { + "target": "com.amazonaws.wellarchitected#SelectedChoices" + }, + "ChoiceAnswerSummaries": { + "target": "com.amazonaws.wellarchitected#ChoiceAnswerSummaries", + "traits": { + "smithy.api#documentation": "

A list of selected choices to a question in your workload.

" + } + }, + "IsApplicable": { + "target": "com.amazonaws.wellarchitected#IsApplicable", + "traits": { + "smithy.api#default": false + } + }, + "Risk": { + "target": "com.amazonaws.wellarchitected#Risk" + }, + "Reason": { + "target": "com.amazonaws.wellarchitected#AnswerReason", + "traits": { + "smithy.api#documentation": "

The reason why a choice is non-applicable to a question in your workload.

" + } + }, + "QuestionType": { + "target": "com.amazonaws.wellarchitected#QuestionType", + "traits": { + "smithy.api#documentation": "

The type of the question.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An answer summary of a lens review in a workload.

" + } + }, + "com.amazonaws.wellarchitected#ApplicationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2084 + }, + "smithy.api#pattern": "^arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:/applications/[a-z0-9]+$" + } + }, + "com.amazonaws.wellarchitected#AssociateLenses": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#AssociateLensesInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Associate a lens to a workload.

\n

Up to 10 lenses can be associated with a workload in a single API operation. A \n maximum of 20 lenses can be associated with a workload.

\n \n

\n Disclaimer\n

\n

By accessing and/or applying custom lenses created by another Amazon Web Services user or account, \n you acknowledge that custom lenses created by other users and shared with you are \n Third Party Content as defined in the Amazon Web Services Customer Agreement.

\n ", + "smithy.api#http": { + "method": "PATCH", + "uri": "/workloads/{WorkloadId}/associateLenses", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#AssociateLensesInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LensAliases": { + "target": "com.amazonaws.wellarchitected#LensAliases", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input to associate lens reviews.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#AssociateProfiles": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#AssociateProfilesInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Associate a profile with a workload.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/workloads/{WorkloadId}/associateProfiles", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#AssociateProfilesInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ProfileArns": { + "target": "com.amazonaws.wellarchitected#ProfileArns", + "traits": { + "smithy.api#documentation": "

The list of profile ARNs to associate with the workload.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#AwsAccountId": { + "type": "string", + "traits": { + "smithy.api#documentation": "

An Amazon Web Services account ID.

", + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^[0-9]{12}$" + } + }, + "com.amazonaws.wellarchitected#AwsRegion": { + "type": "string", + "traits": { + "smithy.api#documentation": "

An Amazon Web Services Region, for example, us-west-2 or\n ap-northeast-1.

", + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.wellarchitected#Base64String": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The Base64-encoded string representation of a lens review report.

\n

This data can be used to create a PDF file.

\n

Only returned by GetConsolidatedReport \n when PDF format is requested.

" + } + }, + "com.amazonaws.wellarchitected#BestPractice": { + "type": "structure", + "members": { + "ChoiceId": { + "target": "com.amazonaws.wellarchitected#ChoiceId" + }, + "ChoiceTitle": { + "target": "com.amazonaws.wellarchitected#ChoiceTitle" + } + }, + "traits": { + "smithy.api#documentation": "

A best practice, or question choice, that has been identified as a risk in this question.

" + } + }, + "com.amazonaws.wellarchitected#BestPractices": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#BestPractice" + } + }, + "com.amazonaws.wellarchitected#CheckDescription": { + "type": "string" + }, + "com.amazonaws.wellarchitected#CheckDetail": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.wellarchitected#CheckId", + "traits": { + "smithy.api#documentation": "

Trusted Advisor check ID.

" + } + }, + "Name": { + "target": "com.amazonaws.wellarchitected#CheckName", + "traits": { + "smithy.api#documentation": "

Trusted Advisor check name.

" + } + }, + "Description": { + "target": "com.amazonaws.wellarchitected#CheckDescription", + "traits": { + "smithy.api#documentation": "

Trusted Advisor check description.

" + } + }, + "Provider": { + "target": "com.amazonaws.wellarchitected#CheckProvider", + "traits": { + "smithy.api#documentation": "

Provider of the check related to the best practice.

" + } + }, + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "

Well-Architected Lens ARN associated to the check.

" + } + }, + "PillarId": { + "target": "com.amazonaws.wellarchitected#PillarId" + }, + "QuestionId": { + "target": "com.amazonaws.wellarchitected#QuestionId" + }, + "ChoiceId": { + "target": "com.amazonaws.wellarchitected#ChoiceId" + }, + "Status": { + "target": "com.amazonaws.wellarchitected#CheckStatus", + "traits": { + "smithy.api#documentation": "

Status associated to the check.

" + } + }, + "AccountId": { + "target": "com.amazonaws.wellarchitected#AwsAccountId" + }, + "FlaggedResources": { + "target": "com.amazonaws.wellarchitected#FlaggedResources", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Count of flagged resources associated to the check.

" + } + }, + "Reason": { + "target": "com.amazonaws.wellarchitected#CheckFailureReason", + "traits": { + "smithy.api#documentation": "

Reason associated to the check.

" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.wellarchitected#Timestamp" + } + }, + "traits": { + "smithy.api#documentation": "

Account details for a Well-Architected best practice in relation to Trusted Advisor checks.

" + } + }, + "com.amazonaws.wellarchitected#CheckDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#CheckDetail" + } + }, + "com.amazonaws.wellarchitected#CheckFailureReason": { + "type": "enum", + "members": { + "ASSUME_ROLE_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASSUME_ROLE_ERROR" + } + }, + "ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCESS_DENIED" + } + }, + "UNKNOWN_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNKNOWN_ERROR" + } + }, + "PREMIUM_SUPPORT_REQUIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREMIUM_SUPPORT_REQUIRED" + } + } + } + }, + "com.amazonaws.wellarchitected#CheckId": { + "type": "string" + }, + "com.amazonaws.wellarchitected#CheckName": { + "type": "string" + }, + "com.amazonaws.wellarchitected#CheckProvider": { + "type": "enum", + "members": { + "TRUSTED_ADVISOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRUSTED_ADVISOR" + } + } + } + }, + "com.amazonaws.wellarchitected#CheckStatus": { + "type": "enum", + "members": { + "OKAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OKAY" + } + }, + "WARNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WARNING" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + }, + "NOT_AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_AVAILABLE" + } + }, + "FETCH_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FETCH_FAILED" + } + } + } + }, + "com.amazonaws.wellarchitected#CheckStatusCount": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 101 + } + } + }, + "com.amazonaws.wellarchitected#CheckSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#CheckSummary" + } + }, + "com.amazonaws.wellarchitected#CheckSummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.wellarchitected#CheckId", + "traits": { + "smithy.api#documentation": "

Trusted Advisor check ID.

" + } + }, + "Name": { + "target": "com.amazonaws.wellarchitected#CheckName", + "traits": { + "smithy.api#documentation": "

Trusted Advisor check name.

" + } + }, + "Provider": { + "target": "com.amazonaws.wellarchitected#CheckProvider", + "traits": { + "smithy.api#documentation": "

Provider of the check related to the best practice.

" + } + }, + "Description": { + "target": "com.amazonaws.wellarchitected#CheckDescription", + "traits": { + "smithy.api#documentation": "

Trusted Advisor check description.

" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.wellarchitected#Timestamp" + }, + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "

Well-Architected Lens ARN associated to the check.

" + } + }, + "PillarId": { + "target": "com.amazonaws.wellarchitected#PillarId" + }, + "QuestionId": { + "target": "com.amazonaws.wellarchitected#QuestionId" + }, + "ChoiceId": { + "target": "com.amazonaws.wellarchitected#ChoiceId" + }, + "Status": { + "target": "com.amazonaws.wellarchitected#CheckStatus", + "traits": { + "smithy.api#documentation": "

Status associated to the check.

" + } + }, + "AccountSummary": { + "target": "com.amazonaws.wellarchitected#AccountSummary", + "traits": { + "smithy.api#documentation": "

Account summary associated to the check.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Trusted Advisor check summary.

" + } + }, + "com.amazonaws.wellarchitected#Choice": { + "type": "structure", + "members": { + "ChoiceId": { + "target": "com.amazonaws.wellarchitected#ChoiceId" + }, + "Title": { + "target": "com.amazonaws.wellarchitected#ChoiceTitle" + }, + "Description": { + "target": "com.amazonaws.wellarchitected#ChoiceDescription" + }, + "HelpfulResource": { + "target": "com.amazonaws.wellarchitected#ChoiceContent", + "traits": { + "smithy.api#documentation": "

The helpful resource (both text and URL) for a particular choice.

\n

This field only applies to custom lenses. Each choice can have only one helpful resource.

" + } + }, + "ImprovementPlan": { + "target": "com.amazonaws.wellarchitected#ChoiceContent", + "traits": { + "smithy.api#documentation": "

The improvement plan (both text and URL) for a particular choice.

\n

This field only applies to custom lenses. Each choice can have only one improvement plan.

" + } + }, + "AdditionalResources": { + "target": "com.amazonaws.wellarchitected#AdditionalResourcesList", + "traits": { + "smithy.api#documentation": "

The additional resources for a choice in a custom lens.

\n

A choice can have up to two additional resources: one of type HELPFUL_RESOURCE, \n one of type IMPROVEMENT_PLAN, or both.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A choice available to answer question.

" + } + }, + "com.amazonaws.wellarchitected#ChoiceAnswer": { + "type": "structure", + "members": { + "ChoiceId": { + "target": "com.amazonaws.wellarchitected#ChoiceId" + }, + "Status": { + "target": "com.amazonaws.wellarchitected#ChoiceStatus", + "traits": { + "smithy.api#documentation": "

The status of a choice.

" + } + }, + "Reason": { + "target": "com.amazonaws.wellarchitected#ChoiceReason", + "traits": { + "smithy.api#documentation": "

The reason why a choice is non-applicable to a question in your workload.

" + } + }, + "Notes": { + "target": "com.amazonaws.wellarchitected#ChoiceNotes", + "traits": { + "smithy.api#documentation": "

The notes associated with a choice.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A choice that has been answered on a question in your workload.

" + } + }, + "com.amazonaws.wellarchitected#ChoiceAnswerSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ChoiceAnswerSummary" + } + }, + "com.amazonaws.wellarchitected#ChoiceAnswerSummary": { + "type": "structure", + "members": { + "ChoiceId": { + "target": "com.amazonaws.wellarchitected#ChoiceId" + }, + "Status": { + "target": "com.amazonaws.wellarchitected#ChoiceStatus", + "traits": { + "smithy.api#documentation": "

The status of a choice.

" + } + }, + "Reason": { + "target": "com.amazonaws.wellarchitected#ChoiceReason", + "traits": { + "smithy.api#documentation": "

The reason why a choice is non-applicable to a question in your workload.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A choice summary that has been answered on a question in your workload.

" + } + }, + "com.amazonaws.wellarchitected#ChoiceAnswers": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ChoiceAnswer" + } + }, + "com.amazonaws.wellarchitected#ChoiceContent": { + "type": "structure", + "members": { + "DisplayText": { + "target": "com.amazonaws.wellarchitected#ChoiceContentDisplayText", + "traits": { + "smithy.api#documentation": "

The display text for the choice content.

" + } + }, + "Url": { + "target": "com.amazonaws.wellarchitected#ChoiceContentUrl", + "traits": { + "smithy.api#documentation": "

The URL for the choice content.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The choice content.

" + } + }, + "com.amazonaws.wellarchitected#ChoiceContentDisplayText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.wellarchitected#ChoiceContentUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.wellarchitected#ChoiceDescription": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The description of a choice.

", + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.wellarchitected#ChoiceId": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The ID of a choice.

", + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.wellarchitected#ChoiceImprovementPlan": { + "type": "structure", + "members": { + "ChoiceId": { + "target": "com.amazonaws.wellarchitected#ChoiceId" + }, + "DisplayText": { + "target": "com.amazonaws.wellarchitected#DisplayText", + "traits": { + "smithy.api#documentation": "

The display text for the improvement plan.

" + } + }, + "ImprovementPlanUrl": { + "target": "com.amazonaws.wellarchitected#ImprovementPlanUrl" + } + }, + "traits": { + "smithy.api#documentation": "

The choice level improvement plan.

" + } + }, + "com.amazonaws.wellarchitected#ChoiceImprovementPlans": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ChoiceImprovementPlan" + } + }, + "com.amazonaws.wellarchitected#ChoiceNotes": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 250 + } + } + }, + "com.amazonaws.wellarchitected#ChoiceReason": { + "type": "enum", + "members": { + "OUT_OF_SCOPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OUT_OF_SCOPE" + } + }, + "BUSINESS_PRIORITIES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BUSINESS_PRIORITIES" + } + }, + "ARCHITECTURE_CONSTRAINTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARCHITECTURE_CONSTRAINTS" + } + }, + "OTHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OTHER" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.wellarchitected#ChoiceStatus": { + "type": "enum", + "members": { + "SELECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SELECTED" + } + }, + "NOT_APPLICABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_APPLICABLE" + } + }, + "UNSELECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNSELECTED" + } + } + } + }, + "com.amazonaws.wellarchitected#ChoiceTitle": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The title of a choice.

", + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.wellarchitected#ChoiceUpdate": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.wellarchitected#ChoiceStatus", + "traits": { + "smithy.api#documentation": "

The status of a choice.

", + "smithy.api#required": {} + } + }, + "Reason": { + "target": "com.amazonaws.wellarchitected#ChoiceReason", + "traits": { + "smithy.api#documentation": "

The reason why a choice is non-applicable to a question in your workload.

" + } + }, + "Notes": { + "target": "com.amazonaws.wellarchitected#ChoiceNotes", + "traits": { + "smithy.api#documentation": "

The notes associated with a choice.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of choices to be updated.

" + } + }, + "com.amazonaws.wellarchitected#ChoiceUpdates": { + "type": "map", + "key": { + "target": "com.amazonaws.wellarchitected#ChoiceId" + }, + "value": { + "target": "com.amazonaws.wellarchitected#ChoiceUpdate" + } + }, + "com.amazonaws.wellarchitected#Choices": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#Choice" + }, + "traits": { + "smithy.api#documentation": "

List of choices available for a question.

" + } + }, + "com.amazonaws.wellarchitected#ClientRequestToken": { + "type": "string", + "traits": { + "smithy.api#documentation": "

A unique case-sensitive string used to ensure that this request is idempotent\n (executes only once).

\n

You should not reuse the same token for other requests. If you retry a request with\n the same client request token and the same parameters after the original request has completed\n successfully, the result of the original request is returned.

\n \n

This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs\n automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI,\n you must provide this token or the request will fail.

\n ", + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.wellarchitected#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wellarchitected#ExceptionMessage", + "traits": { + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.wellarchitected#ExceptionResourceId", + "traits": { + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "com.amazonaws.wellarchitected#ExceptionResourceType", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The resource has already been processed, was deleted, or is too large.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.wellarchitected#ConsolidatedReportMetric": { + "type": "structure", + "members": { + "MetricType": { + "target": "com.amazonaws.wellarchitected#MetricType", + "traits": { + "smithy.api#documentation": "

The metric type of a metric in the consolidated report. Currently only WORKLOAD metric types are supported.

" + } + }, + "RiskCounts": { + "target": "com.amazonaws.wellarchitected#RiskCounts" + }, + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "WorkloadName": { + "target": "com.amazonaws.wellarchitected#WorkloadName" + }, + "WorkloadArn": { + "target": "com.amazonaws.wellarchitected#WorkloadArn" + }, + "UpdatedAt": { + "target": "com.amazonaws.wellarchitected#Timestamp" + }, + "Lenses": { + "target": "com.amazonaws.wellarchitected#LensMetrics", + "traits": { + "smithy.api#documentation": "

The metrics for the lenses in the workload.

" + } + }, + "LensesAppliedCount": { + "target": "com.amazonaws.wellarchitected#LensesAppliedCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of lenses applied to the workload.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A metric that contributes to the consolidated report.

" + } + }, + "com.amazonaws.wellarchitected#ConsolidatedReportMetrics": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ConsolidatedReportMetric" + } + }, + "com.amazonaws.wellarchitected#Count": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

A non-negative integer that denotes how many.

", + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.wellarchitected#CreateLensShare": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#CreateLensShareInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#CreateLensShareOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Create a lens share.

\n

The owner of a lens can share it with other Amazon Web Services accounts, users, an organization,\n and organizational units (OUs) in the same Amazon Web Services Region.\n Lenses provided by Amazon Web Services (Amazon Web Services Official Content) cannot be shared.

\n

\n Shared access to a lens is not removed until the lens invitation is deleted.

\n

If you share a lens with an organization or OU, all accounts in the organization or OU\n are granted access to the lens.

\n

For more information, see Sharing a custom lens in the\n Well-Architected Tool User Guide.

\n \n

\n Disclaimer\n

\n

By sharing your custom lenses with other Amazon Web Services accounts, \n you acknowledge that Amazon Web Services will make your custom lenses available to those \n other accounts. Those other accounts may continue to access and use your \n shared custom lenses even if you delete the custom lenses \n from your own Amazon Web Services account or terminate \n your Amazon Web Services account.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/lenses/{LensAlias}/shares", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#CreateLensShareInput": { + "type": "structure", + "members": { + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SharedWith": { + "target": "com.amazonaws.wellarchitected#SharedWith", + "traits": { + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.wellarchitected#ClientRequestToken", + "traits": { + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#CreateLensShareOutput": { + "type": "structure", + "members": { + "ShareId": { + "target": "com.amazonaws.wellarchitected#ShareId" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#CreateLensVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#CreateLensVersionInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#CreateLensVersionOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Create a new lens version.

\n

A lens can have up to 100 versions.

\n

Use this operation to publish a new lens version after you have imported a lens. The LensAlias \n is used to identify the lens to be published. \n The owner of a lens can share the lens with other \n Amazon Web Services accounts and users in the same Amazon Web Services Region. Only the owner of a lens can delete it.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/lenses/{LensAlias}/versions", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#CreateLensVersionInput": { + "type": "structure", + "members": { + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LensVersion": { + "target": "com.amazonaws.wellarchitected#LensVersion", + "traits": { + "smithy.api#documentation": "

The version of the lens being created.

", + "smithy.api#required": {} + } + }, + "IsMajorVersion": { + "target": "com.amazonaws.wellarchitected#IsMajorVersion", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Set to true if this new major lens version.

" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.wellarchitected#ClientRequestToken", + "traits": { + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#CreateLensVersionOutput": { + "type": "structure", + "members": { + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "

The ARN for the lens.

" + } + }, + "LensVersion": { + "target": "com.amazonaws.wellarchitected#LensVersion", + "traits": { + "smithy.api#documentation": "

The version of the lens.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#CreateMilestone": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#CreateMilestoneInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#CreateMilestoneOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Create a milestone for an existing workload.

", + "smithy.api#http": { + "method": "POST", + "uri": "/workloads/{WorkloadId}/milestones", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#CreateMilestoneInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MilestoneName": { + "target": "com.amazonaws.wellarchitected#MilestoneName", + "traits": { + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.wellarchitected#ClientRequestToken", + "traits": { + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for milestone creation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#CreateMilestoneOutput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "MilestoneNumber": { + "target": "com.amazonaws.wellarchitected#MilestoneNumber", + "traits": { + "smithy.api#default": 0 + } + } + }, + "traits": { + "smithy.api#documentation": "

Output of a create milestone call.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#CreateProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#CreateProfileInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#CreateProfileOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Create a profile.

", + "smithy.api#http": { + "method": "POST", + "uri": "/profiles", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#CreateProfileInput": { + "type": "structure", + "members": { + "ProfileName": { + "target": "com.amazonaws.wellarchitected#ProfileName", + "traits": { + "smithy.api#documentation": "

Name of the profile.

", + "smithy.api#required": {} + } + }, + "ProfileDescription": { + "target": "com.amazonaws.wellarchitected#ProfileDescription", + "traits": { + "smithy.api#documentation": "

The profile description.

", + "smithy.api#required": {} + } + }, + "ProfileQuestions": { + "target": "com.amazonaws.wellarchitected#ProfileQuestionUpdates", + "traits": { + "smithy.api#documentation": "

The profile questions.

", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.wellarchitected#ClientRequestToken", + "traits": { + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.wellarchitected#TagMap", + "traits": { + "smithy.api#documentation": "

The tags assigned to the profile.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#CreateProfileOutput": { + "type": "structure", + "members": { + "ProfileArn": { + "target": "com.amazonaws.wellarchitected#ProfileArn", + "traits": { + "smithy.api#documentation": "

The profile ARN.

" + } + }, + "ProfileVersion": { + "target": "com.amazonaws.wellarchitected#ProfileVersion", + "traits": { + "smithy.api#documentation": "

Version of the profile.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#CreateProfileShare": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#CreateProfileShareInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#CreateProfileShareOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Create a profile share.

", + "smithy.api#http": { + "method": "POST", + "uri": "/profiles/{ProfileArn}/shares", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#CreateProfileShareInput": { + "type": "structure", + "members": { + "ProfileArn": { + "target": "com.amazonaws.wellarchitected#ProfileArn", + "traits": { + "smithy.api#documentation": "

The profile ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SharedWith": { + "target": "com.amazonaws.wellarchitected#SharedWith", + "traits": { + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.wellarchitected#ClientRequestToken", + "traits": { + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#CreateProfileShareOutput": { + "type": "structure", + "members": { + "ShareId": { + "target": "com.amazonaws.wellarchitected#ShareId" + }, + "ProfileArn": { + "target": "com.amazonaws.wellarchitected#ProfileArn", + "traits": { + "smithy.api#documentation": "

The profile ARN.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#CreateWorkload": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#CreateWorkloadInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#CreateWorkloadOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Create a new workload.

\n

The owner of a workload can share the workload with other Amazon Web Services accounts, users,\n an organization, and organizational units (OUs) \n in the same Amazon Web Services Region. Only the owner of a workload can delete it.

\n

For more information, see Defining a Workload in the\n Well-Architected Tool User Guide.

\n \n

Either AwsRegions, NonAwsRegions, or both must be specified when\n creating a workload.

\n

You also must specify ReviewOwner, even though the\n parameter is listed as not being required in the following section.\n

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/workloads", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#CreateWorkloadInput": { + "type": "structure", + "members": { + "WorkloadName": { + "target": "com.amazonaws.wellarchitected#WorkloadName", + "traits": { + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.wellarchitected#WorkloadDescription", + "traits": { + "smithy.api#required": {} + } + }, + "Environment": { + "target": "com.amazonaws.wellarchitected#WorkloadEnvironment", + "traits": { + "smithy.api#required": {} + } + }, + "AccountIds": { + "target": "com.amazonaws.wellarchitected#WorkloadAccountIds" + }, + "AwsRegions": { + "target": "com.amazonaws.wellarchitected#WorkloadAwsRegions" + }, + "NonAwsRegions": { + "target": "com.amazonaws.wellarchitected#WorkloadNonAwsRegions" + }, + "PillarPriorities": { + "target": "com.amazonaws.wellarchitected#WorkloadPillarPriorities" + }, + "ArchitecturalDesign": { + "target": "com.amazonaws.wellarchitected#WorkloadArchitecturalDesign" + }, + "ReviewOwner": { + "target": "com.amazonaws.wellarchitected#WorkloadReviewOwner" + }, + "IndustryType": { + "target": "com.amazonaws.wellarchitected#WorkloadIndustryType" + }, + "Industry": { + "target": "com.amazonaws.wellarchitected#WorkloadIndustry" + }, + "Lenses": { + "target": "com.amazonaws.wellarchitected#WorkloadLenses", + "traits": { + "smithy.api#required": {} + } + }, + "Notes": { + "target": "com.amazonaws.wellarchitected#Notes" + }, + "ClientRequestToken": { + "target": "com.amazonaws.wellarchitected#ClientRequestToken", + "traits": { + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.wellarchitected#TagMap", + "traits": { + "smithy.api#documentation": "

The tags to be associated with the workload.

" + } + }, + "DiscoveryConfig": { + "target": "com.amazonaws.wellarchitected#WorkloadDiscoveryConfig", + "traits": { + "smithy.api#documentation": "

Well-Architected discovery configuration settings associated to the workload.

" + } + }, + "Applications": { + "target": "com.amazonaws.wellarchitected#WorkloadApplications", + "traits": { + "smithy.api#documentation": "

List of AppRegistry application ARNs associated to the workload.

" + } + }, + "ProfileArns": { + "target": "com.amazonaws.wellarchitected#WorkloadProfileArns", + "traits": { + "smithy.api#documentation": "

The list of profile ARNs associated with the workload.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for workload creation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#CreateWorkloadOutput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "WorkloadArn": { + "target": "com.amazonaws.wellarchitected#WorkloadArn" + } + }, + "traits": { + "smithy.api#documentation": "

Output of a create workload call.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#CreateWorkloadShare": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#CreateWorkloadShareInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#CreateWorkloadShareOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Create a workload share.

\n

The owner of a workload can share it with other Amazon Web Services accounts and users in the same\n Amazon Web Services Region. Shared access to a workload is not removed until the workload invitation is\n deleted.

\n

If you share a workload with an organization or OU, all accounts in the organization or OU\n are granted access to the workload.

\n

For more information, see Sharing a workload in the\n Well-Architected Tool User Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/workloads/{WorkloadId}/shares", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#CreateWorkloadShareInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SharedWith": { + "target": "com.amazonaws.wellarchitected#SharedWith", + "traits": { + "smithy.api#required": {} + } + }, + "PermissionType": { + "target": "com.amazonaws.wellarchitected#PermissionType", + "traits": { + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.wellarchitected#ClientRequestToken", + "traits": { + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for Create Workload Share

", + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#CreateWorkloadShareOutput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "ShareId": { + "target": "com.amazonaws.wellarchitected#ShareId" + } + }, + "traits": { + "smithy.api#documentation": "

Input for Create Workload Share

", + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#DefinitionType": { + "type": "enum", + "members": { + "WORKLOAD_METADATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WORKLOAD_METADATA" + } + }, + "APP_REGISTRY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APP_REGISTRY" + } + } + } + }, + "com.amazonaws.wellarchitected#DeleteLens": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#DeleteLensInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Delete an existing lens.

\n

Only the owner of a lens can delete it. After the lens is deleted, Amazon Web Services accounts and users \n that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads.\n

\n \n

\n Disclaimer\n

\n

By sharing your custom lenses with other Amazon Web Services accounts, \n you acknowledge that Amazon Web Services will make your custom lenses available to those \n other accounts. Those other accounts may continue to access and use your \n shared custom lenses even if you delete the custom lenses \n from your own Amazon Web Services account or terminate \n your Amazon Web Services account.

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/lenses/{LensAlias}", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#DeleteLensInput": { + "type": "structure", + "members": { + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.wellarchitected#ClientRequestToken", + "traits": { + "smithy.api#httpQuery": "ClientRequestToken", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "LensStatus": { + "target": "com.amazonaws.wellarchitected#LensStatusType", + "traits": { + "smithy.api#documentation": "

The status of the lens to be deleted.

", + "smithy.api#httpQuery": "LensStatus", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#DeleteLensShare": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#DeleteLensShareInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Delete a lens share.

\n

After the lens share is deleted, Amazon Web Services accounts, users, organizations,\n and organizational units (OUs) \n that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads.

\n \n

\n Disclaimer\n

\n

By sharing your custom lenses with other Amazon Web Services accounts, \n you acknowledge that Amazon Web Services will make your custom lenses available to those \n other accounts. Those other accounts may continue to access and use your \n shared custom lenses even if you delete the custom lenses \n from your own Amazon Web Services account or terminate \n your Amazon Web Services account.

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/lenses/{LensAlias}/shares/{ShareId}", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#DeleteLensShareInput": { + "type": "structure", + "members": { + "ShareId": { + "target": "com.amazonaws.wellarchitected#ShareId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.wellarchitected#ClientRequestToken", + "traits": { + "smithy.api#httpQuery": "ClientRequestToken", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#DeleteProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#DeleteProfileInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Delete a profile.

\n \n

\n Disclaimer\n

\n

By sharing your profile with other Amazon Web Services accounts, \n you acknowledge that Amazon Web Services will make your profile available to those \n other accounts. Those other accounts may continue to access and use your \n shared profile even if you delete the profile \n from your own Amazon Web Services account or terminate \n your Amazon Web Services account.

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/profiles/{ProfileArn}", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#DeleteProfileInput": { + "type": "structure", + "members": { + "ProfileArn": { + "target": "com.amazonaws.wellarchitected#ProfileArn", + "traits": { + "smithy.api#documentation": "

The profile ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.wellarchitected#ClientRequestToken", + "traits": { + "smithy.api#httpQuery": "ClientRequestToken", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#DeleteProfileShare": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#DeleteProfileShareInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Delete a profile share.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/profiles/{ProfileArn}/shares/{ShareId}", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#DeleteProfileShareInput": { + "type": "structure", + "members": { + "ShareId": { + "target": "com.amazonaws.wellarchitected#ShareId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ProfileArn": { + "target": "com.amazonaws.wellarchitected#ProfileArn", + "traits": { + "smithy.api#documentation": "

The profile ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.wellarchitected#ClientRequestToken", + "traits": { + "smithy.api#httpQuery": "ClientRequestToken", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#DeleteWorkload": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#DeleteWorkloadInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Delete an existing workload.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/workloads/{WorkloadId}", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#DeleteWorkloadInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.wellarchitected#ClientRequestToken", + "traits": { + "smithy.api#httpQuery": "ClientRequestToken", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for workload deletion.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#DeleteWorkloadShare": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#DeleteWorkloadShareInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Delete a workload share.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/workloads/{WorkloadId}/shares/{ShareId}", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#DeleteWorkloadShareInput": { + "type": "structure", + "members": { + "ShareId": { + "target": "com.amazonaws.wellarchitected#ShareId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.wellarchitected#ClientRequestToken", + "traits": { + "smithy.api#httpQuery": "ClientRequestToken", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for Delete Workload Share

", + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#DifferenceStatus": { + "type": "enum", + "members": { + "UPDATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATED" + } + }, + "NEW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEW" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } + } + }, + "com.amazonaws.wellarchitected#DisassociateLenses": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#DisassociateLensesInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociate a lens from a workload.

\n

Up to 10 lenses can be disassociated from a workload in a single API operation.

\n \n

The Amazon Web Services Well-Architected Framework lens (wellarchitected) cannot be\n removed from a workload.

\n ", + "smithy.api#http": { + "method": "PATCH", + "uri": "/workloads/{WorkloadId}/disassociateLenses", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#DisassociateLensesInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LensAliases": { + "target": "com.amazonaws.wellarchitected#LensAliases", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input to disassociate lens reviews.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#DisassociateProfiles": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#DisassociateProfilesInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociate a profile from a workload.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/workloads/{WorkloadId}/disassociateProfiles", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#DisassociateProfilesInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ProfileArns": { + "target": "com.amazonaws.wellarchitected#ProfileArns", + "traits": { + "smithy.api#documentation": "

The list of profile ARNs to disassociate from the workload.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#DiscoveryIntegrationStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.wellarchitected#DisplayText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.wellarchitected#ExceptionMessage": { + "type": "string", + "traits": { + "smithy.api#documentation": "

Description of the error.

" + } + }, + "com.amazonaws.wellarchitected#ExceptionResourceId": { + "type": "string", + "traits": { + "smithy.api#documentation": "

Identifier of the resource affected.

" + } + }, + "com.amazonaws.wellarchitected#ExceptionResourceType": { + "type": "string", + "traits": { + "smithy.api#documentation": "

Type of the resource affected.

" + } + }, + "com.amazonaws.wellarchitected#ExportLens": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#ExportLensInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#ExportLensOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Export an existing lens.

\n

Only the owner of a lens can export it. Lenses provided by Amazon Web Services (Amazon Web Services Official Content) \n cannot be exported.

\n

Lenses are defined in JSON. For more information, see JSON format specification \n in the Well-Architected Tool User Guide.

\n \n

\n Disclaimer\n

\n

Do not include or gather personal identifiable information (PII) of end users or \n other identifiable individuals in or via your custom lenses. If your custom \n lens or those shared with you and used in your account do include or collect \n PII you are responsible for: ensuring that the included PII is processed in accordance \n with applicable law, providing adequate privacy notices, and obtaining necessary \n consents for processing such data.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/lenses/{LensAlias}/export", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#ExportLensInput": { + "type": "structure", + "members": { + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LensVersion": { + "target": "com.amazonaws.wellarchitected#LensVersion", + "traits": { + "smithy.api#documentation": "

The lens version to be exported.

", + "smithy.api#httpQuery": "LensVersion" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#ExportLensOutput": { + "type": "structure", + "members": { + "LensJSON": { + "target": "com.amazonaws.wellarchitected#LensJSON", + "traits": { + "smithy.api#documentation": "

The JSON representation of a lens.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#FlaggedResources": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 9999 + } + } + }, + "com.amazonaws.wellarchitected#GetAnswer": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#GetAnswerInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#GetAnswerOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Get the answer to a specific question in a workload review.

", + "smithy.api#http": { + "method": "GET", + "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}/answers/{QuestionId}", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#GetAnswerInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QuestionId": { + "target": "com.amazonaws.wellarchitected#QuestionId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MilestoneNumber": { + "target": "com.amazonaws.wellarchitected#MilestoneNumber", + "traits": { + "smithy.api#default": 0, + "smithy.api#httpQuery": "MilestoneNumber" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input to get answer.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#GetAnswerOutput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "MilestoneNumber": { + "target": "com.amazonaws.wellarchitected#MilestoneNumber", + "traits": { + "smithy.api#default": 0 + } + }, + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias" + }, + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "

The ARN for the lens.

" + } + }, + "Answer": { + "target": "com.amazonaws.wellarchitected#Answer" + } + }, + "traits": { + "smithy.api#documentation": "

Output of a get answer call.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#GetConsolidatedReport": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#GetConsolidatedReportInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#GetConsolidatedReportOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Get a consolidated report of your workloads.

\n

You can optionally choose to include workloads that have been shared with you.

", + "smithy.api#http": { + "method": "GET", + "uri": "/consolidatedReport", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.wellarchitected#GetConsolidatedReportInput": { + "type": "structure", + "members": { + "Format": { + "target": "com.amazonaws.wellarchitected#ReportFormat", + "traits": { + "smithy.api#documentation": "

The format of the consolidated report.

\n

For PDF, Base64String is returned. For JSON, \n Metrics is returned.

", + "smithy.api#httpQuery": "Format", + "smithy.api#required": {} + } + }, + "IncludeSharedResources": { + "target": "com.amazonaws.wellarchitected#IncludeSharedResources", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Set to true to have shared resources included in the report.

", + "smithy.api#httpQuery": "IncludeSharedResources" + } + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken", + "traits": { + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.wellarchitected#GetConsolidatedReportMaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return for this request.

", + "smithy.api#httpQuery": "MaxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#GetConsolidatedReportMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 15 + } + } + }, + "com.amazonaws.wellarchitected#GetConsolidatedReportOutput": { + "type": "structure", + "members": { + "Metrics": { + "target": "com.amazonaws.wellarchitected#ConsolidatedReportMetrics", + "traits": { + "smithy.api#documentation": "

The metrics that make up the consolidated report.

\n

Only returned when JSON format is requested.

" + } + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + }, + "Base64String": { + "target": "com.amazonaws.wellarchitected#Base64String" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#GetLens": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#GetLensInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#GetLensOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Get an existing lens.

", + "smithy.api#http": { + "method": "GET", + "uri": "/lenses/{LensAlias}", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#GetLensInput": { + "type": "structure", + "members": { + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LensVersion": { + "target": "com.amazonaws.wellarchitected#LensVersion", + "traits": { + "smithy.api#documentation": "

The lens version to be retrieved.

", + "smithy.api#httpQuery": "LensVersion" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#GetLensOutput": { + "type": "structure", + "members": { + "Lens": { + "target": "com.amazonaws.wellarchitected#Lens", + "traits": { + "smithy.api#documentation": "

A lens return object.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#GetLensReview": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#GetLensReviewInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#GetLensReviewOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Get lens review.

", + "smithy.api#http": { + "method": "GET", + "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#GetLensReviewInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MilestoneNumber": { + "target": "com.amazonaws.wellarchitected#MilestoneNumber", + "traits": { + "smithy.api#default": 0, + "smithy.api#httpQuery": "MilestoneNumber" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input to get lens review.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#GetLensReviewOutput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "MilestoneNumber": { + "target": "com.amazonaws.wellarchitected#MilestoneNumber", + "traits": { + "smithy.api#default": 0 + } + }, + "LensReview": { + "target": "com.amazonaws.wellarchitected#LensReview" + } + }, + "traits": { + "smithy.api#documentation": "

Output of a get lens review call.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#GetLensReviewReport": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#GetLensReviewReportInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#GetLensReviewReportOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Get lens review report.

", + "smithy.api#http": { + "method": "GET", + "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}/report", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#GetLensReviewReportInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MilestoneNumber": { + "target": "com.amazonaws.wellarchitected#MilestoneNumber", + "traits": { + "smithy.api#default": 0, + "smithy.api#httpQuery": "MilestoneNumber" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input to get lens review report.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#GetLensReviewReportOutput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "MilestoneNumber": { + "target": "com.amazonaws.wellarchitected#MilestoneNumber", + "traits": { + "smithy.api#default": 0 + } + }, + "LensReviewReport": { + "target": "com.amazonaws.wellarchitected#LensReviewReport" + } + }, + "traits": { + "smithy.api#documentation": "

Output of a get lens review report call.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#GetLensVersionDifference": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#GetLensVersionDifferenceInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#GetLensVersionDifferenceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Get lens version differences.

", + "smithy.api#http": { + "method": "GET", + "uri": "/lenses/{LensAlias}/versionDifference", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#GetLensVersionDifferenceInput": { + "type": "structure", + "members": { + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BaseLensVersion": { + "target": "com.amazonaws.wellarchitected#LensVersion", + "traits": { + "smithy.api#documentation": "

The base version of the lens.

", + "smithy.api#httpQuery": "BaseLensVersion" + } + }, + "TargetLensVersion": { + "target": "com.amazonaws.wellarchitected#LensVersion", + "traits": { + "smithy.api#documentation": "

The lens version to target a difference for.

", + "smithy.api#httpQuery": "TargetLensVersion" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#GetLensVersionDifferenceOutput": { + "type": "structure", + "members": { + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias" + }, + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "

The ARN for the lens.

" + } + }, + "BaseLensVersion": { + "target": "com.amazonaws.wellarchitected#LensVersion", + "traits": { + "smithy.api#documentation": "

The base version of the lens.

" + } + }, + "TargetLensVersion": { + "target": "com.amazonaws.wellarchitected#LensVersion", + "traits": { + "smithy.api#documentation": "

The target lens version for the lens.

" + } + }, + "LatestLensVersion": { + "target": "com.amazonaws.wellarchitected#LensVersion", + "traits": { + "smithy.api#documentation": "

The latest version of the lens.

" + } + }, + "VersionDifferences": { + "target": "com.amazonaws.wellarchitected#VersionDifferences" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#GetMilestone": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#GetMilestoneInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#GetMilestoneOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Get a milestone for an existing workload.

", + "smithy.api#http": { + "method": "GET", + "uri": "/workloads/{WorkloadId}/milestones/{MilestoneNumber}", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#GetMilestoneInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MilestoneNumber": { + "target": "com.amazonaws.wellarchitected#MilestoneNumber", + "traits": { + "smithy.api#default": 0, + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input to get a milestone.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#GetMilestoneOutput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "Milestone": { + "target": "com.amazonaws.wellarchitected#Milestone" + } + }, + "traits": { + "smithy.api#documentation": "

Output of a get milestone call.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#GetProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#GetProfileInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#GetProfileOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Get profile information.

", + "smithy.api#http": { + "method": "GET", + "uri": "/profiles/{ProfileArn}", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#GetProfileInput": { + "type": "structure", + "members": { + "ProfileArn": { + "target": "com.amazonaws.wellarchitected#ProfileArn", + "traits": { + "smithy.api#documentation": "

The profile ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ProfileVersion": { + "target": "com.amazonaws.wellarchitected#ProfileVersion", + "traits": { + "smithy.api#documentation": "

The profile version.

", + "smithy.api#httpQuery": "ProfileVersion" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#GetProfileOutput": { + "type": "structure", + "members": { + "Profile": { + "target": "com.amazonaws.wellarchitected#Profile", + "traits": { + "smithy.api#documentation": "

The profile.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#GetProfileTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#GetProfileTemplateInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#GetProfileTemplateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Get profile template.

", + "smithy.api#http": { + "method": "GET", + "uri": "/profileTemplate", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#GetProfileTemplateInput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#GetProfileTemplateOutput": { + "type": "structure", + "members": { + "ProfileTemplate": { + "target": "com.amazonaws.wellarchitected#ProfileTemplate", + "traits": { + "smithy.api#documentation": "

The profile template.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#GetWorkload": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#GetWorkloadInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#GetWorkloadOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Get an existing workload.

", + "smithy.api#http": { + "method": "GET", + "uri": "/workloads/{WorkloadId}", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#GetWorkloadInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input to get a workload.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#GetWorkloadOutput": { + "type": "structure", + "members": { + "Workload": { + "target": "com.amazonaws.wellarchitected#Workload" + } + }, + "traits": { + "smithy.api#documentation": "

Output of a get workload call.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#HelpfulResourceUrl": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The helpful resource URL.

\n

For Amazon Web Services official lenses, this is the helpful resource URL for a question or choice.

\n

For custom lenses, this is the helpful resource URL for a question and is only provided\n if HelpfulResourceDisplayText was specified for the question.

", + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.wellarchitected#ImportLens": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#ImportLensInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#ImportLensOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Import a new custom lens or update an existing custom lens.

\n

To update an existing custom lens, specify its ARN as the LensAlias. If\n no ARN is specified, a new custom lens is created.

\n

The new or updated lens will have a status of DRAFT. The lens cannot be\n applied to workloads or shared with other Amazon Web Services accounts until it's\n published with CreateLensVersion.

\n

Lenses are defined in JSON. For more information, see JSON format specification \n in the Well-Architected Tool User Guide.

\n

A custom lens cannot exceed 500 KB in size.

\n \n

\n Disclaimer\n

\n

Do not include or gather personal identifiable information (PII) of end users or \n other identifiable individuals in or via your custom lenses. If your custom \n lens or those shared with you and used in your account do include or collect \n PII you are responsible for: ensuring that the included PII is processed in accordance \n with applicable law, providing adequate privacy notices, and obtaining necessary \n consents for processing such data.

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/importLens", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#ImportLensInput": { + "type": "structure", + "members": { + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias" + }, + "JSONString": { + "target": "com.amazonaws.wellarchitected#LensJSON", + "traits": { + "smithy.api#documentation": "

The JSON representation of a lens.

", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.wellarchitected#ClientRequestToken", + "traits": { + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.wellarchitected#TagMap", + "traits": { + "smithy.api#documentation": "

Tags to associate to a lens.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#ImportLensOutput": { + "type": "structure", + "members": { + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "

The ARN for the lens that was created or updated.

" + } + }, + "Status": { + "target": "com.amazonaws.wellarchitected#ImportLensStatus", + "traits": { + "smithy.api#documentation": "

The status of the imported lens.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#ImportLensStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETE" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + } + } + }, + "com.amazonaws.wellarchitected#ImprovementPlanUrl": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The improvement plan URL for a question in an Amazon Web Services official lenses.

\n

This value is only available if the question has been answered.

\n

This value does not apply to custom lenses.

", + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.wellarchitected#ImprovementSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ImprovementSummary" + }, + "traits": { + "smithy.api#documentation": "

List of improvement summaries of lens review in a workload.

" + } + }, + "com.amazonaws.wellarchitected#ImprovementSummary": { + "type": "structure", + "members": { + "QuestionId": { + "target": "com.amazonaws.wellarchitected#QuestionId" + }, + "PillarId": { + "target": "com.amazonaws.wellarchitected#PillarId" + }, + "QuestionTitle": { + "target": "com.amazonaws.wellarchitected#QuestionTitle" + }, + "Risk": { + "target": "com.amazonaws.wellarchitected#Risk" + }, + "ImprovementPlanUrl": { + "target": "com.amazonaws.wellarchitected#ImprovementPlanUrl" + }, + "ImprovementPlans": { + "target": "com.amazonaws.wellarchitected#ChoiceImprovementPlans", + "traits": { + "smithy.api#documentation": "

The improvement plan details.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An improvement summary of a lens review in a workload.

" + } + }, + "com.amazonaws.wellarchitected#IncludeSharedResources": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.wellarchitected#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wellarchitected#ExceptionMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

There is a problem with the Well-Architected Tool API service.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.wellarchitected#IsApplicable": { + "type": "boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Defines whether this question is applicable to a lens review.

" + } + }, + "com.amazonaws.wellarchitected#IsMajorVersion": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.wellarchitected#IsReviewOwnerUpdateAcknowledged": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.wellarchitected#Lens": { + "type": "structure", + "members": { + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "

The ARN of a lens.

" + } + }, + "LensVersion": { + "target": "com.amazonaws.wellarchitected#LensVersion", + "traits": { + "smithy.api#documentation": "

The version of a lens.

" + } + }, + "Name": { + "target": "com.amazonaws.wellarchitected#LensName" + }, + "Description": { + "target": "com.amazonaws.wellarchitected#LensDescription" + }, + "Owner": { + "target": "com.amazonaws.wellarchitected#LensOwner", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID that owns the lens.

" + } + }, + "ShareInvitationId": { + "target": "com.amazonaws.wellarchitected#ShareInvitationId", + "traits": { + "smithy.api#documentation": "

The ID assigned to the share invitation.

" + } + }, + "Tags": { + "target": "com.amazonaws.wellarchitected#TagMap", + "traits": { + "smithy.api#documentation": "

The tags assigned to the lens.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A lens return object.

" + } + }, + "com.amazonaws.wellarchitected#LensAlias": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The alias of the lens.

\n

For Amazon Web Services official lenses, this is either the lens alias, such as\n serverless, or the lens ARN, such as\n arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some\n operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

\n

For custom lenses, this is the lens ARN, such as\n arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

\n

Each lens is identified by its LensSummary$LensAlias.

", + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.wellarchitected#LensAliases": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#LensAlias" + }, + "traits": { + "smithy.api#documentation": "

List of lens aliases to associate or disassociate with a workload. Up to 10 lenses can be specified.

\n

Identify a lens using its LensSummary$LensAlias.

", + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.wellarchitected#LensArn": { + "type": "string" + }, + "com.amazonaws.wellarchitected#LensDescription": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The description of the lens.

", + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.wellarchitected#LensJSON": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 500000 + } + } + }, + "com.amazonaws.wellarchitected#LensMetric": { + "type": "structure", + "members": { + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "

The lens ARN.

" + } + }, + "Pillars": { + "target": "com.amazonaws.wellarchitected#PillarMetrics", + "traits": { + "smithy.api#documentation": "

The metrics for the pillars in a lens.

" + } + }, + "RiskCounts": { + "target": "com.amazonaws.wellarchitected#RiskCounts" + } + }, + "traits": { + "smithy.api#documentation": "

A metric for a particular lens in a workload.

" + } + }, + "com.amazonaws.wellarchitected#LensMetrics": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#LensMetric" + } + }, + "com.amazonaws.wellarchitected#LensName": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The full name of the lens.

", + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.wellarchitected#LensNamePrefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.wellarchitected#LensOwner": { + "type": "string" + }, + "com.amazonaws.wellarchitected#LensReview": { + "type": "structure", + "members": { + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias" + }, + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "

The ARN for the lens.

" + } + }, + "LensVersion": { + "target": "com.amazonaws.wellarchitected#LensVersion", + "traits": { + "smithy.api#documentation": "

The version of the lens.

" + } + }, + "LensName": { + "target": "com.amazonaws.wellarchitected#LensName" + }, + "LensStatus": { + "target": "com.amazonaws.wellarchitected#LensStatus", + "traits": { + "smithy.api#documentation": "

The status of the lens.

" + } + }, + "PillarReviewSummaries": { + "target": "com.amazonaws.wellarchitected#PillarReviewSummaries" + }, + "UpdatedAt": { + "target": "com.amazonaws.wellarchitected#Timestamp" + }, + "Notes": { + "target": "com.amazonaws.wellarchitected#Notes" + }, + "RiskCounts": { + "target": "com.amazonaws.wellarchitected#RiskCounts" + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + }, + "Profiles": { + "target": "com.amazonaws.wellarchitected#WorkloadProfiles", + "traits": { + "smithy.api#documentation": "

The profiles associated with the workload.

" + } + }, + "PrioritizedRiskCounts": { + "target": "com.amazonaws.wellarchitected#RiskCounts" + } + }, + "traits": { + "smithy.api#documentation": "

A lens review of a question.

" + } + }, + "com.amazonaws.wellarchitected#LensReviewReport": { + "type": "structure", + "members": { + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias" + }, + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "

The ARN for the lens.

" + } + }, + "Base64String": { + "target": "com.amazonaws.wellarchitected#Base64String" + } + }, + "traits": { + "smithy.api#documentation": "

A report of a lens review.

" + } + }, + "com.amazonaws.wellarchitected#LensReviewSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#LensReviewSummary" + }, + "traits": { + "smithy.api#documentation": "

List of lens summaries of lens reviews of a workload.

" + } + }, + "com.amazonaws.wellarchitected#LensReviewSummary": { + "type": "structure", + "members": { + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias" + }, + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "

The ARN for the lens.

" + } + }, + "LensVersion": { + "target": "com.amazonaws.wellarchitected#LensVersion", + "traits": { + "smithy.api#documentation": "

The version of the lens.

" + } + }, + "LensName": { + "target": "com.amazonaws.wellarchitected#LensName" + }, + "LensStatus": { + "target": "com.amazonaws.wellarchitected#LensStatus", + "traits": { + "smithy.api#documentation": "

The status of the lens.

" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.wellarchitected#Timestamp" + }, + "RiskCounts": { + "target": "com.amazonaws.wellarchitected#RiskCounts" + }, + "Profiles": { + "target": "com.amazonaws.wellarchitected#WorkloadProfiles", + "traits": { + "smithy.api#documentation": "

The profiles associated with the workload.

" + } + }, + "PrioritizedRiskCounts": { + "target": "com.amazonaws.wellarchitected#RiskCounts" + } + }, + "traits": { + "smithy.api#documentation": "

A lens review summary of a workload.

" + } + }, + "com.amazonaws.wellarchitected#LensShareSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#LensShareSummary" + } + }, + "com.amazonaws.wellarchitected#LensShareSummary": { + "type": "structure", + "members": { + "ShareId": { + "target": "com.amazonaws.wellarchitected#ShareId" + }, + "SharedWith": { + "target": "com.amazonaws.wellarchitected#SharedWith" + }, + "Status": { + "target": "com.amazonaws.wellarchitected#ShareStatus" + }, + "StatusMessage": { + "target": "com.amazonaws.wellarchitected#StatusMessage", + "traits": { + "smithy.api#documentation": "

Optional message to compliment the Status field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A lens share summary return object.

" + } + }, + "com.amazonaws.wellarchitected#LensStatus": { + "type": "enum", + "members": { + "CURRENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CURRENT" + } + }, + "NOT_CURRENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_CURRENT" + } + }, + "DEPRECATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPRECATED" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "UNSHARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNSHARED" + } + } + } + }, + "com.amazonaws.wellarchitected#LensStatusType": { + "type": "enum", + "members": { + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + }, + "DRAFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DRAFT" + } + }, + "PUBLISHED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PUBLISHED" + } + } + } + }, + "com.amazonaws.wellarchitected#LensSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#LensSummary" + }, + "traits": { + "smithy.api#documentation": "

List of lens summaries of available lenses.

" + } + }, + "com.amazonaws.wellarchitected#LensSummary": { + "type": "structure", + "members": { + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "

The ARN of the lens.

" + } + }, + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias" + }, + "LensName": { + "target": "com.amazonaws.wellarchitected#LensName" + }, + "LensType": { + "target": "com.amazonaws.wellarchitected#LensType", + "traits": { + "smithy.api#documentation": "

The type of the lens.

" + } + }, + "Description": { + "target": "com.amazonaws.wellarchitected#LensDescription" + }, + "CreatedAt": { + "target": "com.amazonaws.wellarchitected#Timestamp" + }, + "UpdatedAt": { + "target": "com.amazonaws.wellarchitected#Timestamp" + }, + "LensVersion": { + "target": "com.amazonaws.wellarchitected#LensVersion", + "traits": { + "smithy.api#documentation": "

The version of the lens.

" + } + }, + "Owner": { + "target": "com.amazonaws.wellarchitected#AwsAccountId" + }, + "LensStatus": { + "target": "com.amazonaws.wellarchitected#LensStatus", + "traits": { + "smithy.api#documentation": "

The status of the lens.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A lens summary of a lens.

" + } + }, + "com.amazonaws.wellarchitected#LensType": { + "type": "enum", + "members": { + "AWS_OFFICIAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_OFFICIAL" + } + }, + "CUSTOM_SHARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM_SHARED" + } + }, + "CUSTOM_SELF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM_SELF" + } + } + } + }, + "com.amazonaws.wellarchitected#LensUpgradeSummary": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "WorkloadName": { + "target": "com.amazonaws.wellarchitected#WorkloadName" + }, + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias" + }, + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "

The ARN for the lens.

" + } + }, + "CurrentLensVersion": { + "target": "com.amazonaws.wellarchitected#LensVersion", + "traits": { + "smithy.api#documentation": "

The current version of the lens.

" + } + }, + "LatestLensVersion": { + "target": "com.amazonaws.wellarchitected#LensVersion", + "traits": { + "smithy.api#documentation": "

The latest version of the lens.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Lens upgrade summary return object.

" + } + }, + "com.amazonaws.wellarchitected#LensVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + } + } + }, + "com.amazonaws.wellarchitected#LensesAppliedCount": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.wellarchitected#ListAnswers": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#ListAnswersInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#ListAnswersOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List of answers for a particular workload and lens.

", + "smithy.api#http": { + "method": "GET", + "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}/answers", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.wellarchitected#ListAnswersInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PillarId": { + "target": "com.amazonaws.wellarchitected#PillarId", + "traits": { + "smithy.api#httpQuery": "PillarId" + } + }, + "MilestoneNumber": { + "target": "com.amazonaws.wellarchitected#MilestoneNumber", + "traits": { + "smithy.api#default": 0, + "smithy.api#httpQuery": "MilestoneNumber" + } + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken", + "traits": { + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.wellarchitected#ListAnswersMaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return for this request.

", + "smithy.api#httpQuery": "MaxResults" + } + }, + "QuestionPriority": { + "target": "com.amazonaws.wellarchitected#QuestionPriority", + "traits": { + "smithy.api#documentation": "

The priority of the question.

", + "smithy.api#httpQuery": "QuestionPriority" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input to list answers.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#ListAnswersMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.wellarchitected#ListAnswersOutput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "MilestoneNumber": { + "target": "com.amazonaws.wellarchitected#MilestoneNumber", + "traits": { + "smithy.api#default": 0 + } + }, + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias" + }, + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "

The ARN for the lens.

" + } + }, + "AnswerSummaries": { + "target": "com.amazonaws.wellarchitected#AnswerSummaries" + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + } + }, + "traits": { + "smithy.api#documentation": "

Output of a list answers call.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#ListCheckDetails": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#ListCheckDetailsInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#ListCheckDetailsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List of Trusted Advisor check details by account related to the workload.

", + "smithy.api#http": { + "method": "POST", + "uri": "/workloads/{WorkloadId}/checks", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.wellarchitected#ListCheckDetailsInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + }, + "MaxResults": { + "target": "com.amazonaws.wellarchitected#MaxResults", + "traits": { + "smithy.api#default": 0 + } + }, + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "

Well-Architected Lens ARN.

", + "smithy.api#required": {} + } + }, + "PillarId": { + "target": "com.amazonaws.wellarchitected#PillarId", + "traits": { + "smithy.api#required": {} + } + }, + "QuestionId": { + "target": "com.amazonaws.wellarchitected#QuestionId", + "traits": { + "smithy.api#required": {} + } + }, + "ChoiceId": { + "target": "com.amazonaws.wellarchitected#ChoiceId", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#ListCheckDetailsOutput": { + "type": "structure", + "members": { + "CheckDetails": { + "target": "com.amazonaws.wellarchitected#CheckDetails", + "traits": { + "smithy.api#documentation": "

The details about the Trusted Advisor checks related to the Well-Architected best practice.

" + } + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#ListCheckSummaries": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#ListCheckSummariesInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#ListCheckSummariesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List of Trusted Advisor checks summarized for all accounts related to the workload.

", + "smithy.api#http": { + "method": "POST", + "uri": "/workloads/{WorkloadId}/checkSummaries", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.wellarchitected#ListCheckSummariesInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + }, + "MaxResults": { + "target": "com.amazonaws.wellarchitected#MaxResults", + "traits": { + "smithy.api#default": 0 + } + }, + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "

Well-Architected Lens ARN.

", + "smithy.api#required": {} + } + }, + "PillarId": { + "target": "com.amazonaws.wellarchitected#PillarId", + "traits": { + "smithy.api#required": {} + } + }, + "QuestionId": { + "target": "com.amazonaws.wellarchitected#QuestionId", + "traits": { + "smithy.api#required": {} + } + }, + "ChoiceId": { + "target": "com.amazonaws.wellarchitected#ChoiceId", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#ListCheckSummariesOutput": { + "type": "structure", + "members": { + "CheckSummaries": { + "target": "com.amazonaws.wellarchitected#CheckSummaries", + "traits": { + "smithy.api#documentation": "

List of Trusted Advisor summaries related to the Well-Architected best practice.

" + } + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#ListLensReviewImprovements": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#ListLensReviewImprovementsInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#ListLensReviewImprovementsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List lens review improvements.

", + "smithy.api#http": { + "method": "GET", + "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}/improvements", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.wellarchitected#ListLensReviewImprovementsInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PillarId": { + "target": "com.amazonaws.wellarchitected#PillarId", + "traits": { + "smithy.api#httpQuery": "PillarId" + } + }, + "MilestoneNumber": { + "target": "com.amazonaws.wellarchitected#MilestoneNumber", + "traits": { + "smithy.api#default": 0, + "smithy.api#httpQuery": "MilestoneNumber" + } + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken", + "traits": { + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.wellarchitected#ListLensReviewImprovementsMaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return for this request.

", + "smithy.api#httpQuery": "MaxResults" + } + }, + "QuestionPriority": { + "target": "com.amazonaws.wellarchitected#QuestionPriority", + "traits": { + "smithy.api#documentation": "

The priority of the question.

", + "smithy.api#httpQuery": "QuestionPriority" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input to list lens review improvements.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#ListLensReviewImprovementsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.wellarchitected#ListLensReviewImprovementsOutput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "MilestoneNumber": { + "target": "com.amazonaws.wellarchitected#MilestoneNumber", + "traits": { + "smithy.api#default": 0 + } + }, + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias" + }, + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "

The ARN for the lens.

" + } + }, + "ImprovementSummaries": { + "target": "com.amazonaws.wellarchitected#ImprovementSummaries" + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + } + }, + "traits": { + "smithy.api#documentation": "

Output of a list lens review improvements call.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#ListLensReviews": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#ListLensReviewsInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#ListLensReviewsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List lens reviews for a particular workload.

", + "smithy.api#http": { + "method": "GET", + "uri": "/workloads/{WorkloadId}/lensReviews", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.wellarchitected#ListLensReviewsInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MilestoneNumber": { + "target": "com.amazonaws.wellarchitected#MilestoneNumber", + "traits": { + "smithy.api#default": 0, + "smithy.api#httpQuery": "MilestoneNumber" + } + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken", + "traits": { + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.wellarchitected#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#httpQuery": "MaxResults" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input to list lens reviews.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#ListLensReviewsOutput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "MilestoneNumber": { + "target": "com.amazonaws.wellarchitected#MilestoneNumber", + "traits": { + "smithy.api#default": 0 + } + }, + "LensReviewSummaries": { + "target": "com.amazonaws.wellarchitected#LensReviewSummaries" + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + } + }, + "traits": { + "smithy.api#documentation": "

Output of a list lens reviews call.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#ListLensShares": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#ListLensSharesInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#ListLensSharesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List the lens shares associated with the lens.

", + "smithy.api#http": { + "method": "GET", + "uri": "/lenses/{LensAlias}/shares", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.wellarchitected#ListLensSharesInput": { + "type": "structure", + "members": { + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SharedWithPrefix": { + "target": "com.amazonaws.wellarchitected#SharedWithPrefix", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the lens is shared.

", + "smithy.api#httpQuery": "SharedWithPrefix" + } + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken", + "traits": { + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.wellarchitected#ListWorkloadSharesMaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return for this request.

", + "smithy.api#httpQuery": "MaxResults" + } + }, + "Status": { + "target": "com.amazonaws.wellarchitected#ShareStatus", + "traits": { + "smithy.api#httpQuery": "Status" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#ListLensSharesOutput": { + "type": "structure", + "members": { + "LensShareSummaries": { + "target": "com.amazonaws.wellarchitected#LensShareSummaries", + "traits": { + "smithy.api#documentation": "

A list of lens share summaries.

" + } + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#ListLenses": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#ListLensesInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#ListLensesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List the available lenses.

", + "smithy.api#http": { + "method": "GET", + "uri": "/lenses", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.wellarchitected#ListLensesInput": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken", + "traits": { + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.wellarchitected#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#httpQuery": "MaxResults" + } + }, + "LensType": { + "target": "com.amazonaws.wellarchitected#LensType", + "traits": { + "smithy.api#documentation": "

The type of lenses to be returned.

", + "smithy.api#httpQuery": "LensType" + } + }, + "LensStatus": { + "target": "com.amazonaws.wellarchitected#LensStatusType", + "traits": { + "smithy.api#documentation": "

The status of lenses to be returned.

", + "smithy.api#httpQuery": "LensStatus" + } + }, + "LensName": { + "target": "com.amazonaws.wellarchitected#LensName", + "traits": { + "smithy.api#httpQuery": "LensName" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input to list lenses.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#ListLensesOutput": { + "type": "structure", + "members": { + "LensSummaries": { + "target": "com.amazonaws.wellarchitected#LensSummaries" + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + } + }, + "traits": { + "smithy.api#documentation": "

Output of a list lenses call.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#ListMilestones": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#ListMilestonesInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#ListMilestonesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List all milestones for an existing workload.

", + "smithy.api#http": { + "method": "POST", + "uri": "/workloads/{WorkloadId}/milestonesSummaries", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.wellarchitected#ListMilestonesInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + }, + "MaxResults": { + "target": "com.amazonaws.wellarchitected#MaxResults", + "traits": { + "smithy.api#default": 0 + } + } + }, + "traits": { + "smithy.api#documentation": "

Input to list all milestones for a workload.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#ListMilestonesOutput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "MilestoneSummaries": { + "target": "com.amazonaws.wellarchitected#MilestoneSummaries" + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + } + }, + "traits": { + "smithy.api#documentation": "

Output of a list milestones call.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#ListNotifications": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#ListNotificationsInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#ListNotificationsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List lens notifications.

", + "smithy.api#http": { + "method": "POST", + "uri": "/notifications", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.wellarchitected#ListNotificationsInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + }, + "MaxResults": { + "target": "com.amazonaws.wellarchitected#ListNotificationsMaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return for this request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#ListNotificationsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.wellarchitected#ListNotificationsOutput": { + "type": "structure", + "members": { + "NotificationSummaries": { + "target": "com.amazonaws.wellarchitected#NotificationSummaries", + "traits": { + "smithy.api#documentation": "

List of lens notification summaries in a workload.

" + } + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#ListProfileNotifications": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#ListProfileNotificationsInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#ListProfileNotificationsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List profile notifications.

", + "smithy.api#http": { + "method": "GET", + "uri": "/profileNotifications", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.wellarchitected#ListProfileNotificationsInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpQuery": "WorkloadId" + } + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken", + "traits": { + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.wellarchitected#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#httpQuery": "MaxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#ListProfileNotificationsOutput": { + "type": "structure", + "members": { + "NotificationSummaries": { + "target": "com.amazonaws.wellarchitected#ProfileNotificationSummaries", + "traits": { + "smithy.api#documentation": "

Notification summaries.

" + } + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#ListProfileShares": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#ListProfileSharesInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#ListProfileSharesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List profile shares.

", + "smithy.api#http": { + "method": "GET", + "uri": "/profiles/{ProfileArn}/shares", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.wellarchitected#ListProfileSharesInput": { + "type": "structure", + "members": { + "ProfileArn": { + "target": "com.amazonaws.wellarchitected#ProfileArn", + "traits": { + "smithy.api#documentation": "

The profile ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SharedWithPrefix": { + "target": "com.amazonaws.wellarchitected#SharedWithPrefix", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the profile is shared.

", + "smithy.api#httpQuery": "SharedWithPrefix" + } + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken", + "traits": { + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.wellarchitected#ListProfileSharesMaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return for this request.

", + "smithy.api#httpQuery": "MaxResults" + } + }, + "Status": { + "target": "com.amazonaws.wellarchitected#ShareStatus", + "traits": { + "smithy.api#httpQuery": "Status" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#ListProfileSharesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.wellarchitected#ListProfileSharesOutput": { + "type": "structure", + "members": { + "ProfileShareSummaries": { + "target": "com.amazonaws.wellarchitected#ProfileShareSummaries", + "traits": { + "smithy.api#documentation": "

Profile share summaries.

" + } + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#ListProfiles": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#ListProfilesInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#ListProfilesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List profiles.

", + "smithy.api#http": { + "method": "GET", + "uri": "/profileSummaries", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.wellarchitected#ListProfilesInput": { + "type": "structure", + "members": { + "ProfileNamePrefix": { + "target": "com.amazonaws.wellarchitected#ProfileNamePrefix", + "traits": { + "smithy.api#documentation": "

Prefix for profile name.

", + "smithy.api#httpQuery": "ProfileNamePrefix" + } + }, + "ProfileOwnerType": { + "target": "com.amazonaws.wellarchitected#ProfileOwnerType", + "traits": { + "smithy.api#documentation": "

Profile owner type.

", + "smithy.api#httpQuery": "ProfileOwnerType" + } + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken", + "traits": { + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.wellarchitected#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#httpQuery": "MaxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#ListProfilesOutput": { + "type": "structure", + "members": { + "ProfileSummaries": { + "target": "com.amazonaws.wellarchitected#ProfileSummaries", + "traits": { + "smithy.api#documentation": "

Profile summaries.

" + } + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#ListShareInvitations": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#ListShareInvitationsInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#ListShareInvitationsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List the workload invitations.

", + "smithy.api#http": { + "method": "GET", + "uri": "/shareInvitations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.wellarchitected#ListShareInvitationsInput": { + "type": "structure", + "members": { + "WorkloadNamePrefix": { + "target": "com.amazonaws.wellarchitected#WorkloadNamePrefix", + "traits": { + "smithy.api#httpQuery": "WorkloadNamePrefix" + } + }, + "LensNamePrefix": { + "target": "com.amazonaws.wellarchitected#LensNamePrefix", + "traits": { + "smithy.api#documentation": "

An optional string added to the beginning of each lens name returned in the results.

", + "smithy.api#httpQuery": "LensNamePrefix" + } + }, + "ShareResourceType": { + "target": "com.amazonaws.wellarchitected#ShareResourceType", + "traits": { + "smithy.api#documentation": "

The type of share invitations to be returned.

", + "smithy.api#httpQuery": "ShareResourceType" + } + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken", + "traits": { + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.wellarchitected#ListShareInvitationsMaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return for this request.

", + "smithy.api#httpQuery": "MaxResults" + } + }, + "ProfileNamePrefix": { + "target": "com.amazonaws.wellarchitected#ProfileNamePrefix", + "traits": { + "smithy.api#documentation": "

Profile name prefix.

", + "smithy.api#httpQuery": "ProfileNamePrefix" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for List Share Invitations

", + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#ListShareInvitationsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.wellarchitected#ListShareInvitationsOutput": { + "type": "structure", + "members": { + "ShareInvitationSummaries": { + "target": "com.amazonaws.wellarchitected#ShareInvitationSummaries", + "traits": { + "smithy.api#documentation": "

List of share invitation summaries in a workload.

" + } + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + } + }, + "traits": { + "smithy.api#documentation": "

Input for List Share Invitations

", + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#ListTagsForResourceInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#ListTagsForResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

List the tags for a resource.

\n \n

The WorkloadArn parameter can be a workload ARN, a custom lens ARN, or a profile ARN.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{WorkloadArn}", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#ListTagsForResourceInput": { + "type": "structure", + "members": { + "WorkloadArn": { + "target": "com.amazonaws.wellarchitected#WorkloadArn", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#ListTagsForResourceOutput": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.wellarchitected#TagMap", + "traits": { + "smithy.api#documentation": "

The tags for the resource.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#ListWorkloadShares": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#ListWorkloadSharesInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#ListWorkloadSharesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List the workload shares associated with the workload.

", + "smithy.api#http": { + "method": "GET", + "uri": "/workloads/{WorkloadId}/shares", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.wellarchitected#ListWorkloadSharesInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SharedWithPrefix": { + "target": "com.amazonaws.wellarchitected#SharedWithPrefix", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload is shared.

", + "smithy.api#httpQuery": "SharedWithPrefix" + } + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken", + "traits": { + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.wellarchitected#ListWorkloadSharesMaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return for this request.

", + "smithy.api#httpQuery": "MaxResults" + } + }, + "Status": { + "target": "com.amazonaws.wellarchitected#ShareStatus", + "traits": { + "smithy.api#httpQuery": "Status" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for List Workload Share

", + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#ListWorkloadSharesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.wellarchitected#ListWorkloadSharesOutput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "WorkloadShareSummaries": { + "target": "com.amazonaws.wellarchitected#WorkloadShareSummaries" + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + } + }, + "traits": { + "smithy.api#documentation": "

Input for List Workload Share

", + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#ListWorkloads": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#ListWorkloadsInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#ListWorkloadsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Paginated list of workloads.

", + "smithy.api#http": { + "method": "POST", + "uri": "/workloadsSummaries", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.wellarchitected#ListWorkloadsInput": { + "type": "structure", + "members": { + "WorkloadNamePrefix": { + "target": "com.amazonaws.wellarchitected#WorkloadNamePrefix" + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + }, + "MaxResults": { + "target": "com.amazonaws.wellarchitected#ListWorkloadsMaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return for this request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input to list all workloads.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#ListWorkloadsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.wellarchitected#ListWorkloadsOutput": { + "type": "structure", + "members": { + "WorkloadSummaries": { + "target": "com.amazonaws.wellarchitected#WorkloadSummaries" + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + } + }, + "traits": { + "smithy.api#documentation": "

Output of a list workloads call.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return for this request.

", + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.wellarchitected#MaxSelectedProfileChoices": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.wellarchitected#MetricType": { + "type": "enum", + "members": { + "WORKLOAD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WORKLOAD" + } + } + } + }, + "com.amazonaws.wellarchitected#Milestone": { + "type": "structure", + "members": { + "MilestoneNumber": { + "target": "com.amazonaws.wellarchitected#MilestoneNumber", + "traits": { + "smithy.api#default": 0 + } + }, + "MilestoneName": { + "target": "com.amazonaws.wellarchitected#MilestoneName" + }, + "RecordedAt": { + "target": "com.amazonaws.wellarchitected#Timestamp" + }, + "Workload": { + "target": "com.amazonaws.wellarchitected#Workload" + } + }, + "traits": { + "smithy.api#documentation": "

A milestone return object.

" + } + }, + "com.amazonaws.wellarchitected#MilestoneName": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The name of the milestone in a workload.

\n

Milestone names must be unique within a workload.

", + "smithy.api#length": { + "min": 3, + "max": 100 + } + } + }, + "com.amazonaws.wellarchitected#MilestoneNumber": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The milestone number.

\n

A workload can have a maximum of 100 milestones.

", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.wellarchitected#MilestoneSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#MilestoneSummary" + }, + "traits": { + "smithy.api#documentation": "

A list of milestone summaries.

" + } + }, + "com.amazonaws.wellarchitected#MilestoneSummary": { + "type": "structure", + "members": { + "MilestoneNumber": { + "target": "com.amazonaws.wellarchitected#MilestoneNumber", + "traits": { + "smithy.api#default": 0 + } + }, + "MilestoneName": { + "target": "com.amazonaws.wellarchitected#MilestoneName" + }, + "RecordedAt": { + "target": "com.amazonaws.wellarchitected#Timestamp" + }, + "WorkloadSummary": { + "target": "com.amazonaws.wellarchitected#WorkloadSummary" + } + }, + "traits": { + "smithy.api#documentation": "

A milestone summary return object.

" + } + }, + "com.amazonaws.wellarchitected#MinSelectedProfileChoices": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.wellarchitected#NextToken": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next set of results.

" + } + }, + "com.amazonaws.wellarchitected#Notes": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The notes associated with the workload.

", + "smithy.api#length": { + "min": 0, + "max": 2084 + } + } + }, + "com.amazonaws.wellarchitected#NotificationSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#NotificationSummary" + } + }, + "com.amazonaws.wellarchitected#NotificationSummary": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.wellarchitected#NotificationType", + "traits": { + "smithy.api#documentation": "

The type of notification.

" + } + }, + "LensUpgradeSummary": { + "target": "com.amazonaws.wellarchitected#LensUpgradeSummary", + "traits": { + "smithy.api#documentation": "

Summary of lens upgrade.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A notification summary return object.

" + } + }, + "com.amazonaws.wellarchitected#NotificationType": { + "type": "enum", + "members": { + "LENS_VERSION_UPGRADED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LENS_VERSION_UPGRADED" + } + }, + "LENS_VERSION_DEPRECATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LENS_VERSION_DEPRECATED" + } + } + } + }, + "com.amazonaws.wellarchitected#OrganizationSharingStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.wellarchitected#PermissionType": { + "type": "enum", + "members": { + "READONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READONLY" + } + }, + "CONTRIBUTOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTRIBUTOR" + } + } + }, + "traits": { + "smithy.api#documentation": "

Permission granted on a share request.

" + } + }, + "com.amazonaws.wellarchitected#PillarDifference": { + "type": "structure", + "members": { + "PillarId": { + "target": "com.amazonaws.wellarchitected#PillarId" + }, + "PillarName": { + "target": "com.amazonaws.wellarchitected#PillarName" + }, + "DifferenceStatus": { + "target": "com.amazonaws.wellarchitected#DifferenceStatus", + "traits": { + "smithy.api#documentation": "

Indicates the type of change to the pillar.

" + } + }, + "QuestionDifferences": { + "target": "com.amazonaws.wellarchitected#QuestionDifferences", + "traits": { + "smithy.api#documentation": "

List of question differences.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A pillar difference return object.

" + } + }, + "com.amazonaws.wellarchitected#PillarDifferences": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#PillarDifference" + } + }, + "com.amazonaws.wellarchitected#PillarId": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The ID used to identify a pillar, for example, security.

\n

A pillar is identified by its PillarReviewSummary$PillarId.

", + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.wellarchitected#PillarMetric": { + "type": "structure", + "members": { + "PillarId": { + "target": "com.amazonaws.wellarchitected#PillarId" + }, + "RiskCounts": { + "target": "com.amazonaws.wellarchitected#RiskCounts" + }, + "Questions": { + "target": "com.amazonaws.wellarchitected#QuestionMetrics", + "traits": { + "smithy.api#documentation": "

The questions that have been identified as risks in the pillar.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A metric for a particular pillar in a lens.

" + } + }, + "com.amazonaws.wellarchitected#PillarMetrics": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#PillarMetric" + } + }, + "com.amazonaws.wellarchitected#PillarName": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The name of the pillar.

", + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.wellarchitected#PillarNotes": { + "type": "map", + "key": { + "target": "com.amazonaws.wellarchitected#PillarId" + }, + "value": { + "target": "com.amazonaws.wellarchitected#Notes" + }, + "traits": { + "smithy.api#documentation": "

List of pillar notes of a lens review in a workload.

" + } + }, + "com.amazonaws.wellarchitected#PillarReviewSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#PillarReviewSummary" + }, + "traits": { + "smithy.api#documentation": "

List of pillar review summaries of lens review in a workload.

" + } + }, + "com.amazonaws.wellarchitected#PillarReviewSummary": { + "type": "structure", + "members": { + "PillarId": { + "target": "com.amazonaws.wellarchitected#PillarId" + }, + "PillarName": { + "target": "com.amazonaws.wellarchitected#PillarName" + }, + "Notes": { + "target": "com.amazonaws.wellarchitected#Notes" + }, + "RiskCounts": { + "target": "com.amazonaws.wellarchitected#RiskCounts" + }, + "PrioritizedRiskCounts": { + "target": "com.amazonaws.wellarchitected#RiskCounts" + } + }, + "traits": { + "smithy.api#documentation": "

A pillar review summary of a lens review.

" + } + }, + "com.amazonaws.wellarchitected#Profile": { + "type": "structure", + "members": { + "ProfileArn": { + "target": "com.amazonaws.wellarchitected#ProfileArn", + "traits": { + "smithy.api#documentation": "

The profile ARN.

" + } + }, + "ProfileVersion": { + "target": "com.amazonaws.wellarchitected#ProfileVersion", + "traits": { + "smithy.api#documentation": "

The profile version.

" + } + }, + "ProfileName": { + "target": "com.amazonaws.wellarchitected#ProfileName", + "traits": { + "smithy.api#documentation": "

The profile name.

" + } + }, + "ProfileDescription": { + "target": "com.amazonaws.wellarchitected#ProfileDescription", + "traits": { + "smithy.api#documentation": "

The profile description.

" + } + }, + "ProfileQuestions": { + "target": "com.amazonaws.wellarchitected#ProfileQuestions", + "traits": { + "smithy.api#documentation": "

Profile questions.

" + } + }, + "Owner": { + "target": "com.amazonaws.wellarchitected#AwsAccountId" + }, + "CreatedAt": { + "target": "com.amazonaws.wellarchitected#Timestamp" + }, + "UpdatedAt": { + "target": "com.amazonaws.wellarchitected#Timestamp" + }, + "ShareInvitationId": { + "target": "com.amazonaws.wellarchitected#ShareInvitationId", + "traits": { + "smithy.api#documentation": "

The ID assigned to the share invitation.

" + } + }, + "Tags": { + "target": "com.amazonaws.wellarchitected#TagMap", + "traits": { + "smithy.api#documentation": "

The tags assigned to the profile.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A profile.

" + } + }, + "com.amazonaws.wellarchitected#ProfileArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2084 + }, + "smithy.api#pattern": "^arn:aws[-a-z]*:wellarchitected:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:profile/[a-z0-9]+$" + } + }, + "com.amazonaws.wellarchitected#ProfileArns": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ProfileArn" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.wellarchitected#ProfileChoice": { + "type": "structure", + "members": { + "ChoiceId": { + "target": "com.amazonaws.wellarchitected#ChoiceId" + }, + "ChoiceTitle": { + "target": "com.amazonaws.wellarchitected#ChoiceTitle" + }, + "ChoiceDescription": { + "target": "com.amazonaws.wellarchitected#ChoiceDescription" + } + }, + "traits": { + "smithy.api#documentation": "

The profile choice.

" + } + }, + "com.amazonaws.wellarchitected#ProfileDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 100 + }, + "smithy.api#pattern": "^[A-Za-z0-9-_.,:/()@!&?#+'’\\s]+$" + } + }, + "com.amazonaws.wellarchitected#ProfileName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 100 + }, + "smithy.api#pattern": "^[A-Za-z0-9-_.,:/()@!&?#+'’\\s]+$" + } + }, + "com.amazonaws.wellarchitected#ProfileNamePrefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + }, + "smithy.api#pattern": "^[A-Za-z0-9-_.,:/()@!&?#+'’\\s]+$" + } + }, + "com.amazonaws.wellarchitected#ProfileNotificationSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ProfileNotificationSummary" + } + }, + "com.amazonaws.wellarchitected#ProfileNotificationSummary": { + "type": "structure", + "members": { + "CurrentProfileVersion": { + "target": "com.amazonaws.wellarchitected#ProfileVersion", + "traits": { + "smithy.api#documentation": "

The current profile version.

" + } + }, + "LatestProfileVersion": { + "target": "com.amazonaws.wellarchitected#ProfileVersion", + "traits": { + "smithy.api#documentation": "

The latest profile version.

" + } + }, + "Type": { + "target": "com.amazonaws.wellarchitected#ProfileNotificationType", + "traits": { + "smithy.api#documentation": "

Type of notification.

" + } + }, + "ProfileArn": { + "target": "com.amazonaws.wellarchitected#ProfileArn", + "traits": { + "smithy.api#documentation": "

The profile ARN.

" + } + }, + "ProfileName": { + "target": "com.amazonaws.wellarchitected#ProfileName", + "traits": { + "smithy.api#documentation": "

The profile name.

" + } + }, + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "WorkloadName": { + "target": "com.amazonaws.wellarchitected#WorkloadName" + } + }, + "traits": { + "smithy.api#documentation": "

The profile notification summary.

" + } }, - "PillarId": { - "target": "com.amazonaws.wellarchitected#PillarId" + "com.amazonaws.wellarchitected#ProfileNotificationType": { + "type": "enum", + "members": { + "PROFILE_ANSWERS_UPDATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROFILE_ANSWERS_UPDATED" + } + }, + "PROFILE_DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROFILE_DELETED" + } + } + } }, - "QuestionTitle": { - "target": "com.amazonaws.wellarchitected#QuestionTitle" + "com.amazonaws.wellarchitected#ProfileOwnerType": { + "type": "enum", + "members": { + "SELF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SELF" + } + }, + "SHARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHARED" + } + } + } }, - "Risk": { - "target": "com.amazonaws.wellarchitected#Risk" + "com.amazonaws.wellarchitected#ProfileQuestion": { + "type": "structure", + "members": { + "QuestionId": { + "target": "com.amazonaws.wellarchitected#QuestionId" + }, + "QuestionTitle": { + "target": "com.amazonaws.wellarchitected#QuestionTitle" + }, + "QuestionDescription": { + "target": "com.amazonaws.wellarchitected#QuestionDescription" + }, + "QuestionChoices": { + "target": "com.amazonaws.wellarchitected#ProfileQuestionChoices", + "traits": { + "smithy.api#documentation": "

The question choices.

" + } + }, + "SelectedChoiceIds": { + "target": "com.amazonaws.wellarchitected#SelectedChoiceIds", + "traits": { + "smithy.api#documentation": "

The selected choices.

" + } + }, + "MinSelectedChoices": { + "target": "com.amazonaws.wellarchitected#MinSelectedProfileChoices", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum number of selected choices.

" + } + }, + "MaxSelectedChoices": { + "target": "com.amazonaws.wellarchitected#MaxSelectedProfileChoices", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of selected choices.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A profile question.

" + } }, - "ImprovementPlanUrl": { - "target": "com.amazonaws.wellarchitected#ImprovementPlanUrl" + "com.amazonaws.wellarchitected#ProfileQuestionChoices": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ProfileChoice" + } }, - "ImprovementPlans": { - "target": "com.amazonaws.wellarchitected#ChoiceImprovementPlans", - "traits": { - "smithy.api#documentation": "

The improvement plan details.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An improvement summary of a lens review in a workload.

" - } - }, - "com.amazonaws.wellarchitected#IncludeSharedResources": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.wellarchitected#InternalServerException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.wellarchitected#ExceptionMessage", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

There is a problem with the Well-Architected Tool API service.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.wellarchitected#IsApplicable": { - "type": "boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Defines whether this question is applicable to a lens review.

" - } - }, - "com.amazonaws.wellarchitected#IsMajorVersion": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.wellarchitected#IsReviewOwnerUpdateAcknowledged": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.wellarchitected#Lens": { - "type": "structure", - "members": { - "LensArn": { - "target": "com.amazonaws.wellarchitected#LensArn", - "traits": { - "smithy.api#documentation": "

The ARN of a lens.

" - } - }, - "LensVersion": { - "target": "com.amazonaws.wellarchitected#LensVersion", - "traits": { - "smithy.api#documentation": "

The version of a lens.

" - } - }, - "Name": { - "target": "com.amazonaws.wellarchitected#LensName" - }, - "Description": { - "target": "com.amazonaws.wellarchitected#LensDescription" - }, - "Owner": { - "target": "com.amazonaws.wellarchitected#LensOwner", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID that owns the lens.

" - } - }, - "ShareInvitationId": { - "target": "com.amazonaws.wellarchitected#ShareInvitationId", - "traits": { - "smithy.api#documentation": "

The ID assigned to the share invitation.

" - } - }, - "Tags": { - "target": "com.amazonaws.wellarchitected#TagMap", - "traits": { - "smithy.api#documentation": "

The tags assigned to the lens.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A lens return object.

" - } - }, - "com.amazonaws.wellarchitected#LensAlias": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The alias of the lens.

\n

For Amazon Web Services official lenses, this is either the lens alias, such as\n serverless, or the lens ARN, such as\n arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some\n operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

\n

For custom lenses, this is the lens ARN, such as\n arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

\n

Each lens is identified by its LensSummary$LensAlias.

", - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.wellarchitected#LensAliases": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#LensAlias" - }, - "traits": { - "smithy.api#documentation": "

List of lens aliases to associate or disassociate with a workload. Up to 10 lenses can be specified.

\n

Identify a lens using its LensSummary$LensAlias.

", - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.wellarchitected#LensArn": { - "type": "string" - }, - "com.amazonaws.wellarchitected#LensDescription": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The description of the lens.

", - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.wellarchitected#LensJSON": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 2, - "max": 500000 - } - } - }, - "com.amazonaws.wellarchitected#LensMetric": { - "type": "structure", - "members": { - "LensArn": { - "target": "com.amazonaws.wellarchitected#LensArn", - "traits": { - "smithy.api#documentation": "

The lens ARN.

" - } - }, - "Pillars": { - "target": "com.amazonaws.wellarchitected#PillarMetrics", - "traits": { - "smithy.api#documentation": "

The metrics for the pillars in a lens.

" - } - }, - "RiskCounts": { - "target": "com.amazonaws.wellarchitected#RiskCounts" - } - }, - "traits": { - "smithy.api#documentation": "

A metric for a particular lens in a workload.

" - } - }, - "com.amazonaws.wellarchitected#LensMetrics": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#LensMetric" - } - }, - "com.amazonaws.wellarchitected#LensName": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The full name of the lens.

", - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.wellarchitected#LensNamePrefix": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.wellarchitected#LensOwner": { - "type": "string" - }, - "com.amazonaws.wellarchitected#LensReview": { - "type": "structure", - "members": { - "LensAlias": { - "target": "com.amazonaws.wellarchitected#LensAlias" - }, - "LensArn": { - "target": "com.amazonaws.wellarchitected#LensArn", - "traits": { - "smithy.api#documentation": "

The ARN for the lens.

" - } - }, - "LensVersion": { - "target": "com.amazonaws.wellarchitected#LensVersion", - "traits": { - "smithy.api#documentation": "

The version of the lens.

" - } - }, - "LensName": { - "target": "com.amazonaws.wellarchitected#LensName" - }, - "LensStatus": { - "target": "com.amazonaws.wellarchitected#LensStatus", - "traits": { - "smithy.api#documentation": "

The status of the lens.

" - } - }, - "PillarReviewSummaries": { - "target": "com.amazonaws.wellarchitected#PillarReviewSummaries" - }, - "UpdatedAt": { - "target": "com.amazonaws.wellarchitected#Timestamp" - }, - "Notes": { - "target": "com.amazonaws.wellarchitected#Notes" - }, - "RiskCounts": { - "target": "com.amazonaws.wellarchitected#RiskCounts" - }, - "NextToken": { - "target": "com.amazonaws.wellarchitected#NextToken" - } - }, - "traits": { - "smithy.api#documentation": "

A lens review of a question.

" - } - }, - "com.amazonaws.wellarchitected#LensReviewReport": { - "type": "structure", - "members": { - "LensAlias": { - "target": "com.amazonaws.wellarchitected#LensAlias" - }, - "LensArn": { - "target": "com.amazonaws.wellarchitected#LensArn", - "traits": { - "smithy.api#documentation": "

The ARN for the lens.

" - } - }, - "Base64String": { - "target": "com.amazonaws.wellarchitected#Base64String" - } - }, - "traits": { - "smithy.api#documentation": "

A report of a lens review.

" - } - }, - "com.amazonaws.wellarchitected#LensReviewSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#LensReviewSummary" - }, - "traits": { - "smithy.api#documentation": "

List of lens summaries of lens reviews of a workload.

" - } - }, - "com.amazonaws.wellarchitected#LensReviewSummary": { - "type": "structure", - "members": { - "LensAlias": { - "target": "com.amazonaws.wellarchitected#LensAlias" - }, - "LensArn": { - "target": "com.amazonaws.wellarchitected#LensArn", - "traits": { - "smithy.api#documentation": "

The ARN for the lens.

" - } - }, - "LensVersion": { - "target": "com.amazonaws.wellarchitected#LensVersion", - "traits": { - "smithy.api#documentation": "

The version of the lens.

" - } - }, - "LensName": { - "target": "com.amazonaws.wellarchitected#LensName" - }, - "LensStatus": { - "target": "com.amazonaws.wellarchitected#LensStatus", - "traits": { - "smithy.api#documentation": "

The status of the lens.

" - } - }, - "UpdatedAt": { - "target": "com.amazonaws.wellarchitected#Timestamp" - }, - "RiskCounts": { - "target": "com.amazonaws.wellarchitected#RiskCounts" - } - }, - "traits": { - "smithy.api#documentation": "

A lens review summary of a workload.

" - } - }, - "com.amazonaws.wellarchitected#LensShareSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#LensShareSummary" - } - }, - "com.amazonaws.wellarchitected#LensShareSummary": { - "type": "structure", - "members": { - "ShareId": { - "target": "com.amazonaws.wellarchitected#ShareId" - }, - "SharedWith": { - "target": "com.amazonaws.wellarchitected#SharedWith" - }, - "Status": { - "target": "com.amazonaws.wellarchitected#ShareStatus" - }, - "StatusMessage": { - "target": "com.amazonaws.wellarchitected#StatusMessage", - "traits": { - "smithy.api#documentation": "

Optional message to compliment the Status field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A lens share summary return object.

" - } - }, - "com.amazonaws.wellarchitected#LensStatus": { - "type": "enum", - "members": { - "CURRENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CURRENT" - } - }, - "NOT_CURRENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_CURRENT" - } - }, - "DEPRECATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DEPRECATED" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETED" - } - }, - "UNSHARED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNSHARED" - } - } - } - }, - "com.amazonaws.wellarchitected#LensStatusType": { - "type": "enum", - "members": { - "ALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL" - } - }, - "DRAFT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DRAFT" - } - }, - "PUBLISHED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PUBLISHED" - } - } - } - }, - "com.amazonaws.wellarchitected#LensSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#LensSummary" - }, - "traits": { - "smithy.api#documentation": "

List of lens summaries of available lenses.

" - } - }, - "com.amazonaws.wellarchitected#LensSummary": { - "type": "structure", - "members": { - "LensArn": { - "target": "com.amazonaws.wellarchitected#LensArn", - "traits": { - "smithy.api#documentation": "

The ARN of the lens.

" - } - }, - "LensAlias": { - "target": "com.amazonaws.wellarchitected#LensAlias" - }, - "LensName": { - "target": "com.amazonaws.wellarchitected#LensName" - }, - "LensType": { - "target": "com.amazonaws.wellarchitected#LensType", - "traits": { - "smithy.api#documentation": "

The type of the lens.

" - } - }, - "Description": { - "target": "com.amazonaws.wellarchitected#LensDescription" - }, - "CreatedAt": { - "target": "com.amazonaws.wellarchitected#Timestamp" - }, - "UpdatedAt": { - "target": "com.amazonaws.wellarchitected#Timestamp" - }, - "LensVersion": { - "target": "com.amazonaws.wellarchitected#LensVersion", - "traits": { - "smithy.api#documentation": "

The version of the lens.

" - } - }, - "Owner": { - "target": "com.amazonaws.wellarchitected#AwsAccountId" - }, - "LensStatus": { - "target": "com.amazonaws.wellarchitected#LensStatus", - "traits": { - "smithy.api#documentation": "

The status of the lens.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A lens summary of a lens.

" - } - }, - "com.amazonaws.wellarchitected#LensType": { - "type": "enum", - "members": { - "AWS_OFFICIAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AWS_OFFICIAL" - } - }, - "CUSTOM_SHARED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CUSTOM_SHARED" - } - }, - "CUSTOM_SELF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CUSTOM_SELF" - } - } - } - }, - "com.amazonaws.wellarchitected#LensUpgradeSummary": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId" - }, - "WorkloadName": { - "target": "com.amazonaws.wellarchitected#WorkloadName" - }, - "LensAlias": { - "target": "com.amazonaws.wellarchitected#LensAlias" - }, - "LensArn": { - "target": "com.amazonaws.wellarchitected#LensArn", - "traits": { - "smithy.api#documentation": "

The ARN for the lens.

" - } - }, - "CurrentLensVersion": { - "target": "com.amazonaws.wellarchitected#LensVersion", - "traits": { - "smithy.api#documentation": "

The current version of the lens.

" - } - }, - "LatestLensVersion": { - "target": "com.amazonaws.wellarchitected#LensVersion", - "traits": { - "smithy.api#documentation": "

The latest version of the lens.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Lens upgrade summary return object.

" - } - }, - "com.amazonaws.wellarchitected#LensVersion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - } - } - }, - "com.amazonaws.wellarchitected#LensesAppliedCount": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.wellarchitected#ListAnswers": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#ListAnswersInput" - }, - "output": { - "target": "com.amazonaws.wellarchitected#ListAnswersOutput" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

List of answers for a particular workload and lens.

", - "smithy.api#http": { - "method": "GET", - "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}/answers", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.wellarchitected#ListAnswersInput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "LensAlias": { - "target": "com.amazonaws.wellarchitected#LensAlias", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "PillarId": { - "target": "com.amazonaws.wellarchitected#PillarId", - "traits": { - "smithy.api#httpQuery": "PillarId" - } - }, - "MilestoneNumber": { - "target": "com.amazonaws.wellarchitected#MilestoneNumber", - "traits": { - "smithy.api#default": 0, - "smithy.api#httpQuery": "MilestoneNumber" - } - }, - "NextToken": { - "target": "com.amazonaws.wellarchitected#NextToken", - "traits": { - "smithy.api#httpQuery": "NextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.wellarchitected#ListAnswersMaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return for this request.

", - "smithy.api#httpQuery": "MaxResults" - } - } - }, - "traits": { - "smithy.api#documentation": "

Input to list answers.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#ListAnswersMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.wellarchitected#ListAnswersOutput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId" - }, - "MilestoneNumber": { - "target": "com.amazonaws.wellarchitected#MilestoneNumber", - "traits": { - "smithy.api#default": 0 - } - }, - "LensAlias": { - "target": "com.amazonaws.wellarchitected#LensAlias" - }, - "LensArn": { - "target": "com.amazonaws.wellarchitected#LensArn", - "traits": { - "smithy.api#documentation": "

The ARN for the lens.

" - } - }, - "AnswerSummaries": { - "target": "com.amazonaws.wellarchitected#AnswerSummaries" - }, - "NextToken": { - "target": "com.amazonaws.wellarchitected#NextToken" - } - }, - "traits": { - "smithy.api#documentation": "

Output of a list answers call.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#ListCheckDetails": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#ListCheckDetailsInput" - }, - "output": { - "target": "com.amazonaws.wellarchitected#ListCheckDetailsOutput" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

List of Trusted Advisor check details by account related to the workload.

", - "smithy.api#http": { - "method": "POST", - "uri": "/workloads/{WorkloadId}/checks", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.wellarchitected#ListCheckDetailsInput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.wellarchitected#NextToken" - }, - "MaxResults": { - "target": "com.amazonaws.wellarchitected#MaxResults", - "traits": { - "smithy.api#default": 0 - } - }, - "LensArn": { - "target": "com.amazonaws.wellarchitected#LensArn", - "traits": { - "smithy.api#documentation": "

Well-Architected Lens ARN.

", - "smithy.api#required": {} - } - }, - "PillarId": { - "target": "com.amazonaws.wellarchitected#PillarId", - "traits": { - "smithy.api#required": {} - } - }, - "QuestionId": { - "target": "com.amazonaws.wellarchitected#QuestionId", - "traits": { - "smithy.api#required": {} - } - }, - "ChoiceId": { - "target": "com.amazonaws.wellarchitected#ChoiceId", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#ListCheckDetailsOutput": { - "type": "structure", - "members": { - "CheckDetails": { - "target": "com.amazonaws.wellarchitected#CheckDetails", - "traits": { - "smithy.api#documentation": "

The details about the Trusted Advisor checks related to the Well-Architected best practice.

" - } - }, - "NextToken": { - "target": "com.amazonaws.wellarchitected#NextToken" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#ListCheckSummaries": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#ListCheckSummariesInput" - }, - "output": { - "target": "com.amazonaws.wellarchitected#ListCheckSummariesOutput" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

List of Trusted Advisor checks summarized for all accounts related to the workload.

", - "smithy.api#http": { - "method": "POST", - "uri": "/workloads/{WorkloadId}/checkSummaries", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.wellarchitected#ListCheckSummariesInput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.wellarchitected#NextToken" - }, - "MaxResults": { - "target": "com.amazonaws.wellarchitected#MaxResults", - "traits": { - "smithy.api#default": 0 - } - }, - "LensArn": { - "target": "com.amazonaws.wellarchitected#LensArn", - "traits": { - "smithy.api#documentation": "

Well-Architected Lens ARN.

", - "smithy.api#required": {} - } - }, - "PillarId": { - "target": "com.amazonaws.wellarchitected#PillarId", - "traits": { - "smithy.api#required": {} - } - }, - "QuestionId": { - "target": "com.amazonaws.wellarchitected#QuestionId", - "traits": { - "smithy.api#required": {} - } - }, - "ChoiceId": { - "target": "com.amazonaws.wellarchitected#ChoiceId", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#ListCheckSummariesOutput": { - "type": "structure", - "members": { - "CheckSummaries": { - "target": "com.amazonaws.wellarchitected#CheckSummaries", - "traits": { - "smithy.api#documentation": "

List of Trusted Advisor summaries related to the Well-Architected best practice.

" - } - }, - "NextToken": { - "target": "com.amazonaws.wellarchitected#NextToken" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#ListLensReviewImprovements": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#ListLensReviewImprovementsInput" - }, - "output": { - "target": "com.amazonaws.wellarchitected#ListLensReviewImprovementsOutput" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

List lens review improvements.

", - "smithy.api#http": { - "method": "GET", - "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}/improvements", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.wellarchitected#ListLensReviewImprovementsInput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "LensAlias": { - "target": "com.amazonaws.wellarchitected#LensAlias", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "PillarId": { - "target": "com.amazonaws.wellarchitected#PillarId", - "traits": { - "smithy.api#httpQuery": "PillarId" - } - }, - "MilestoneNumber": { - "target": "com.amazonaws.wellarchitected#MilestoneNumber", - "traits": { - "smithy.api#default": 0, - "smithy.api#httpQuery": "MilestoneNumber" - } - }, - "NextToken": { - "target": "com.amazonaws.wellarchitected#NextToken", - "traits": { - "smithy.api#httpQuery": "NextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.wellarchitected#ListLensReviewImprovementsMaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return for this request.

", - "smithy.api#httpQuery": "MaxResults" - } - } - }, - "traits": { - "smithy.api#documentation": "

Input to list lens review improvements.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#ListLensReviewImprovementsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.wellarchitected#ListLensReviewImprovementsOutput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId" - }, - "MilestoneNumber": { - "target": "com.amazonaws.wellarchitected#MilestoneNumber", - "traits": { - "smithy.api#default": 0 - } - }, - "LensAlias": { - "target": "com.amazonaws.wellarchitected#LensAlias" - }, - "LensArn": { - "target": "com.amazonaws.wellarchitected#LensArn", - "traits": { - "smithy.api#documentation": "

The ARN for the lens.

" - } - }, - "ImprovementSummaries": { - "target": "com.amazonaws.wellarchitected#ImprovementSummaries" - }, - "NextToken": { - "target": "com.amazonaws.wellarchitected#NextToken" - } - }, - "traits": { - "smithy.api#documentation": "

Output of a list lens review improvements call.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#ListLensReviews": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#ListLensReviewsInput" - }, - "output": { - "target": "com.amazonaws.wellarchitected#ListLensReviewsOutput" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

List lens reviews for a particular workload.

", - "smithy.api#http": { - "method": "GET", - "uri": "/workloads/{WorkloadId}/lensReviews", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.wellarchitected#ListLensReviewsInput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "MilestoneNumber": { - "target": "com.amazonaws.wellarchitected#MilestoneNumber", - "traits": { - "smithy.api#default": 0, - "smithy.api#httpQuery": "MilestoneNumber" - } - }, - "NextToken": { - "target": "com.amazonaws.wellarchitected#NextToken", - "traits": { - "smithy.api#httpQuery": "NextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.wellarchitected#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#httpQuery": "MaxResults" - } - } - }, - "traits": { - "smithy.api#documentation": "

Input to list lens reviews.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#ListLensReviewsOutput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId" - }, - "MilestoneNumber": { - "target": "com.amazonaws.wellarchitected#MilestoneNumber", - "traits": { - "smithy.api#default": 0 - } - }, - "LensReviewSummaries": { - "target": "com.amazonaws.wellarchitected#LensReviewSummaries" - }, - "NextToken": { - "target": "com.amazonaws.wellarchitected#NextToken" - } - }, - "traits": { - "smithy.api#documentation": "

Output of a list lens reviews call.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#ListLensShares": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#ListLensSharesInput" - }, - "output": { - "target": "com.amazonaws.wellarchitected#ListLensSharesOutput" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

List the lens shares associated with the lens.

", - "smithy.api#http": { - "method": "GET", - "uri": "/lenses/{LensAlias}/shares", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.wellarchitected#ListLensSharesInput": { - "type": "structure", - "members": { - "LensAlias": { - "target": "com.amazonaws.wellarchitected#LensAlias", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "SharedWithPrefix": { - "target": "com.amazonaws.wellarchitected#SharedWithPrefix", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the lens is shared.

", - "smithy.api#httpQuery": "SharedWithPrefix" - } - }, - "NextToken": { - "target": "com.amazonaws.wellarchitected#NextToken", - "traits": { - "smithy.api#httpQuery": "NextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.wellarchitected#ListWorkloadSharesMaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return for this request.

", - "smithy.api#httpQuery": "MaxResults" - } - }, - "Status": { - "target": "com.amazonaws.wellarchitected#ShareStatus", - "traits": { - "smithy.api#httpQuery": "Status" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#ListLensSharesOutput": { - "type": "structure", - "members": { - "LensShareSummaries": { - "target": "com.amazonaws.wellarchitected#LensShareSummaries", - "traits": { - "smithy.api#documentation": "

A list of lens share summaries.

" - } - }, - "NextToken": { - "target": "com.amazonaws.wellarchitected#NextToken" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#ListLenses": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#ListLensesInput" - }, - "output": { - "target": "com.amazonaws.wellarchitected#ListLensesOutput" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

List the available lenses.

", - "smithy.api#http": { - "method": "GET", - "uri": "/lenses", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.wellarchitected#ListLensesInput": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.wellarchitected#NextToken", - "traits": { - "smithy.api#httpQuery": "NextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.wellarchitected#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#httpQuery": "MaxResults" - } - }, - "LensType": { - "target": "com.amazonaws.wellarchitected#LensType", - "traits": { - "smithy.api#documentation": "

The type of lenses to be returned.

", - "smithy.api#httpQuery": "LensType" - } - }, - "LensStatus": { - "target": "com.amazonaws.wellarchitected#LensStatusType", - "traits": { - "smithy.api#documentation": "

The status of lenses to be returned.

", - "smithy.api#httpQuery": "LensStatus" - } - }, - "LensName": { - "target": "com.amazonaws.wellarchitected#LensName", - "traits": { - "smithy.api#httpQuery": "LensName" - } - } - }, - "traits": { - "smithy.api#documentation": "

Input to list lenses.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#ListLensesOutput": { - "type": "structure", - "members": { - "LensSummaries": { - "target": "com.amazonaws.wellarchitected#LensSummaries" - }, - "NextToken": { - "target": "com.amazonaws.wellarchitected#NextToken" - } - }, - "traits": { - "smithy.api#documentation": "

Output of a list lenses call.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#ListMilestones": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#ListMilestonesInput" - }, - "output": { - "target": "com.amazonaws.wellarchitected#ListMilestonesOutput" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

List all milestones for an existing workload.

", - "smithy.api#http": { - "method": "POST", - "uri": "/workloads/{WorkloadId}/milestonesSummaries", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.wellarchitected#ListMilestonesInput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.wellarchitected#NextToken" - }, - "MaxResults": { - "target": "com.amazonaws.wellarchitected#MaxResults", - "traits": { - "smithy.api#default": 0 - } - } - }, - "traits": { - "smithy.api#documentation": "

Input to list all milestones for a workload.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#ListMilestonesOutput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId" + "com.amazonaws.wellarchitected#ProfileQuestionUpdate": { + "type": "structure", + "members": { + "QuestionId": { + "target": "com.amazonaws.wellarchitected#QuestionId" + }, + "SelectedChoiceIds": { + "target": "com.amazonaws.wellarchitected#SelectedProfileChoiceIds", + "traits": { + "smithy.api#documentation": "

The selected choices.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An update to a profile question.

" + } + }, + "com.amazonaws.wellarchitected#ProfileQuestionUpdates": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ProfileQuestionUpdate" + } + }, + "com.amazonaws.wellarchitected#ProfileQuestions": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ProfileQuestion" + } + }, + "com.amazonaws.wellarchitected#ProfileShareSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ProfileShareSummary" + } + }, + "com.amazonaws.wellarchitected#ProfileShareSummary": { + "type": "structure", + "members": { + "ShareId": { + "target": "com.amazonaws.wellarchitected#ShareId" + }, + "SharedWith": { + "target": "com.amazonaws.wellarchitected#SharedWith" + }, + "Status": { + "target": "com.amazonaws.wellarchitected#ShareStatus" + }, + "StatusMessage": { + "target": "com.amazonaws.wellarchitected#StatusMessage", + "traits": { + "smithy.api#documentation": "

Profile share invitation status message.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Summary of a profile share.

" + } + }, + "com.amazonaws.wellarchitected#ProfileSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ProfileSummary" + } + }, + "com.amazonaws.wellarchitected#ProfileSummary": { + "type": "structure", + "members": { + "ProfileArn": { + "target": "com.amazonaws.wellarchitected#ProfileArn", + "traits": { + "smithy.api#documentation": "

The profile ARN.

" + } + }, + "ProfileVersion": { + "target": "com.amazonaws.wellarchitected#ProfileVersion", + "traits": { + "smithy.api#documentation": "

The profile version.

" + } + }, + "ProfileName": { + "target": "com.amazonaws.wellarchitected#ProfileName", + "traits": { + "smithy.api#documentation": "

The profile name.

" + } + }, + "ProfileDescription": { + "target": "com.amazonaws.wellarchitected#ProfileDescription", + "traits": { + "smithy.api#documentation": "

The profile description.

" + } + }, + "Owner": { + "target": "com.amazonaws.wellarchitected#AwsAccountId" + }, + "CreatedAt": { + "target": "com.amazonaws.wellarchitected#Timestamp" + }, + "UpdatedAt": { + "target": "com.amazonaws.wellarchitected#Timestamp" + } + }, + "traits": { + "smithy.api#documentation": "

Summary of a profile.

" + } + }, + "com.amazonaws.wellarchitected#ProfileTemplate": { + "type": "structure", + "members": { + "TemplateName": { + "target": "com.amazonaws.wellarchitected#ProfileName", + "traits": { + "smithy.api#documentation": "

The name of the profile template.

" + } + }, + "TemplateQuestions": { + "target": "com.amazonaws.wellarchitected#TemplateQuestions", + "traits": { + "smithy.api#documentation": "

Profile template questions.

" + } + }, + "CreatedAt": { + "target": "com.amazonaws.wellarchitected#Timestamp" + }, + "UpdatedAt": { + "target": "com.amazonaws.wellarchitected#Timestamp" + } + }, + "traits": { + "smithy.api#documentation": "

The profile template.

" + } + }, + "com.amazonaws.wellarchitected#ProfileTemplateChoice": { + "type": "structure", + "members": { + "ChoiceId": { + "target": "com.amazonaws.wellarchitected#ChoiceId" + }, + "ChoiceTitle": { + "target": "com.amazonaws.wellarchitected#ChoiceTitle" + }, + "ChoiceDescription": { + "target": "com.amazonaws.wellarchitected#ChoiceDescription" + } + }, + "traits": { + "smithy.api#documentation": "

A profile template choice.

" + } + }, + "com.amazonaws.wellarchitected#ProfileTemplateQuestion": { + "type": "structure", + "members": { + "QuestionId": { + "target": "com.amazonaws.wellarchitected#QuestionId" + }, + "QuestionTitle": { + "target": "com.amazonaws.wellarchitected#QuestionTitle" + }, + "QuestionDescription": { + "target": "com.amazonaws.wellarchitected#QuestionDescription" + }, + "QuestionChoices": { + "target": "com.amazonaws.wellarchitected#ProfileTemplateQuestionChoices", + "traits": { + "smithy.api#documentation": "

The question choices.

" + } + }, + "MinSelectedChoices": { + "target": "com.amazonaws.wellarchitected#MinSelectedProfileChoices", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum number of choices selected.

" + } + }, + "MaxSelectedChoices": { + "target": "com.amazonaws.wellarchitected#MaxSelectedProfileChoices", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of choices selected.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A profile template question.

" + } + }, + "com.amazonaws.wellarchitected#ProfileTemplateQuestionChoices": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ProfileTemplateChoice" + } + }, + "com.amazonaws.wellarchitected#ProfileVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^[A-Za-z0-9-]+$" + } + }, + "com.amazonaws.wellarchitected#QuestionDescription": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The description of the question.

", + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.wellarchitected#QuestionDifference": { + "type": "structure", + "members": { + "QuestionId": { + "target": "com.amazonaws.wellarchitected#QuestionId" + }, + "QuestionTitle": { + "target": "com.amazonaws.wellarchitected#QuestionTitle" + }, + "DifferenceStatus": { + "target": "com.amazonaws.wellarchitected#DifferenceStatus", + "traits": { + "smithy.api#documentation": "

Indicates the type of change to the question.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A question difference return object.

" + } + }, + "com.amazonaws.wellarchitected#QuestionDifferences": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#QuestionDifference" + } + }, + "com.amazonaws.wellarchitected#QuestionId": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The ID of the question.

", + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.wellarchitected#QuestionMetric": { + "type": "structure", + "members": { + "QuestionId": { + "target": "com.amazonaws.wellarchitected#QuestionId" + }, + "Risk": { + "target": "com.amazonaws.wellarchitected#Risk" + }, + "BestPractices": { + "target": "com.amazonaws.wellarchitected#BestPractices", + "traits": { + "smithy.api#documentation": "

The best practices, or choices, that have been identified as contributing to risk in a question.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A metric for a particular question in the pillar.

" + } + }, + "com.amazonaws.wellarchitected#QuestionMetrics": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#QuestionMetric" + } + }, + "com.amazonaws.wellarchitected#QuestionPriority": { + "type": "enum", + "members": { + "PRIORITIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIORITIZED" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.wellarchitected#QuestionTitle": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The title of the question.

", + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.wellarchitected#QuestionType": { + "type": "enum", + "members": { + "PRIORITIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIORITIZED" + } + }, + "NON_PRIORITIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NON_PRIORITIZED" + } + } + } + }, + "com.amazonaws.wellarchitected#QuotaCode": { + "type": "string", + "traits": { + "smithy.api#documentation": "

Service Quotas requirement to identify originating quota.

" + } + }, + "com.amazonaws.wellarchitected#ReportFormat": { + "type": "enum", + "members": { + "PDF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PDF" + } + }, + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON" + } + } + } }, - "MilestoneSummaries": { - "target": "com.amazonaws.wellarchitected#MilestoneSummaries" + "com.amazonaws.wellarchitected#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wellarchitected#ExceptionMessage", + "traits": { + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.wellarchitected#ExceptionResourceId", + "traits": { + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "com.amazonaws.wellarchitected#ExceptionResourceType", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The requested resource was not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } }, - "NextToken": { - "target": "com.amazonaws.wellarchitected#NextToken" - } - }, - "traits": { - "smithy.api#documentation": "

Output of a list milestones call.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#ListNotifications": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#ListNotificationsInput" - }, - "output": { - "target": "com.amazonaws.wellarchitected#ListNotificationsOutput" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

List lens notifications.

", - "smithy.api#http": { - "method": "POST", - "uri": "/notifications", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.wellarchitected#ListNotificationsInput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId" - }, - "NextToken": { - "target": "com.amazonaws.wellarchitected#NextToken" - }, - "MaxResults": { - "target": "com.amazonaws.wellarchitected#ListNotificationsMaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return for this request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#ListNotificationsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.wellarchitected#ListNotificationsOutput": { - "type": "structure", - "members": { - "NotificationSummaries": { - "target": "com.amazonaws.wellarchitected#NotificationSummaries", - "traits": { - "smithy.api#documentation": "

List of lens notification summaries in a workload.

" - } - }, - "NextToken": { - "target": "com.amazonaws.wellarchitected#NextToken" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#ListShareInvitations": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#ListShareInvitationsInput" - }, - "output": { - "target": "com.amazonaws.wellarchitected#ListShareInvitationsOutput" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

List the workload invitations.

", - "smithy.api#http": { - "method": "GET", - "uri": "/shareInvitations", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.wellarchitected#ListShareInvitationsInput": { - "type": "structure", - "members": { - "WorkloadNamePrefix": { - "target": "com.amazonaws.wellarchitected#WorkloadNamePrefix", - "traits": { - "smithy.api#httpQuery": "WorkloadNamePrefix" - } - }, - "LensNamePrefix": { - "target": "com.amazonaws.wellarchitected#LensNamePrefix", - "traits": { - "smithy.api#documentation": "

An optional string added to the beginning of each lens name returned in the results.

", - "smithy.api#httpQuery": "LensNamePrefix" - } - }, - "ShareResourceType": { - "target": "com.amazonaws.wellarchitected#ShareResourceType", - "traits": { - "smithy.api#documentation": "

The type of share invitations to be returned.

", - "smithy.api#httpQuery": "ShareResourceType" - } - }, - "NextToken": { - "target": "com.amazonaws.wellarchitected#NextToken", - "traits": { - "smithy.api#httpQuery": "NextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.wellarchitected#ListShareInvitationsMaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return for this request.

", - "smithy.api#httpQuery": "MaxResults" - } - } - }, - "traits": { - "smithy.api#documentation": "

Input for List Share Invitations

", - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#ListShareInvitationsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.wellarchitected#ListShareInvitationsOutput": { - "type": "structure", - "members": { - "ShareInvitationSummaries": { - "target": "com.amazonaws.wellarchitected#ShareInvitationSummaries", - "traits": { - "smithy.api#documentation": "

List of share invitation summaries in a workload.

" - } - }, - "NextToken": { - "target": "com.amazonaws.wellarchitected#NextToken" - } - }, - "traits": { - "smithy.api#documentation": "

Input for List Share Invitations

", - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#ListTagsForResourceInput" - }, - "output": { - "target": "com.amazonaws.wellarchitected#ListTagsForResourceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

List the tags for a resource.

\n \n

The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/tags/{WorkloadArn}", - "code": 200 - } - } - }, - "com.amazonaws.wellarchitected#ListTagsForResourceInput": { - "type": "structure", - "members": { - "WorkloadArn": { - "target": "com.amazonaws.wellarchitected#WorkloadArn", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#ListTagsForResourceOutput": { - "type": "structure", - "members": { - "Tags": { - "target": "com.amazonaws.wellarchitected#TagMap", - "traits": { - "smithy.api#documentation": "

The tags for the resource.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#ListWorkloadShares": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#ListWorkloadSharesInput" - }, - "output": { - "target": "com.amazonaws.wellarchitected#ListWorkloadSharesOutput" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

List the workload shares associated with the workload.

", - "smithy.api#http": { - "method": "GET", - "uri": "/workloads/{WorkloadId}/shares", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.wellarchitected#ListWorkloadSharesInput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "SharedWithPrefix": { - "target": "com.amazonaws.wellarchitected#SharedWithPrefix", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload is shared.

", - "smithy.api#httpQuery": "SharedWithPrefix" - } - }, - "NextToken": { - "target": "com.amazonaws.wellarchitected#NextToken", - "traits": { - "smithy.api#httpQuery": "NextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.wellarchitected#ListWorkloadSharesMaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return for this request.

", - "smithy.api#httpQuery": "MaxResults" - } - }, - "Status": { - "target": "com.amazonaws.wellarchitected#ShareStatus", - "traits": { - "smithy.api#httpQuery": "Status" - } - } - }, - "traits": { - "smithy.api#documentation": "

Input for List Workload Share

", - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#ListWorkloadSharesMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.wellarchitected#ListWorkloadSharesOutput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId" + "com.amazonaws.wellarchitected#Risk": { + "type": "enum", + "members": { + "UNANSWERED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNANSWERED" + } + }, + "HIGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIGH" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "NOT_APPLICABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_APPLICABLE" + } + } + }, + "traits": { + "smithy.api#documentation": "

The risk for a given workload, lens review, pillar, or question.

" + } }, - "WorkloadShareSummaries": { - "target": "com.amazonaws.wellarchitected#WorkloadShareSummaries" + "com.amazonaws.wellarchitected#RiskCounts": { + "type": "map", + "key": { + "target": "com.amazonaws.wellarchitected#Risk" + }, + "value": { + "target": "com.amazonaws.wellarchitected#Count" + }, + "traits": { + "smithy.api#documentation": "

A map from risk names to the count of how many questions have that rating.

" + } }, - "NextToken": { - "target": "com.amazonaws.wellarchitected#NextToken" - } - }, - "traits": { - "smithy.api#documentation": "

Input for List Workload Share

", - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#ListWorkloads": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#ListWorkloadsInput" - }, - "output": { - "target": "com.amazonaws.wellarchitected#ListWorkloadsOutput" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Paginated list of workloads.

", - "smithy.api#http": { - "method": "POST", - "uri": "/workloadsSummaries", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.wellarchitected#ListWorkloadsInput": { - "type": "structure", - "members": { - "WorkloadNamePrefix": { - "target": "com.amazonaws.wellarchitected#WorkloadNamePrefix" - }, - "NextToken": { - "target": "com.amazonaws.wellarchitected#NextToken" - }, - "MaxResults": { - "target": "com.amazonaws.wellarchitected#ListWorkloadsMaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return for this request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Input to list all workloads.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#ListWorkloadsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.wellarchitected#ListWorkloadsOutput": { - "type": "structure", - "members": { - "WorkloadSummaries": { - "target": "com.amazonaws.wellarchitected#WorkloadSummaries" - }, - "NextToken": { - "target": "com.amazonaws.wellarchitected#NextToken" - } - }, - "traits": { - "smithy.api#documentation": "

Output of a list workloads call.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return for this request.

", - "smithy.api#range": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.wellarchitected#MetricType": { - "type": "enum", - "members": { - "WORKLOAD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WORKLOAD" - } - } - } - }, - "com.amazonaws.wellarchitected#Milestone": { - "type": "structure", - "members": { - "MilestoneNumber": { - "target": "com.amazonaws.wellarchitected#MilestoneNumber", - "traits": { - "smithy.api#default": 0 - } - }, - "MilestoneName": { - "target": "com.amazonaws.wellarchitected#MilestoneName" - }, - "RecordedAt": { - "target": "com.amazonaws.wellarchitected#Timestamp" - }, - "Workload": { - "target": "com.amazonaws.wellarchitected#Workload" - } - }, - "traits": { - "smithy.api#documentation": "

A milestone return object.

" - } - }, - "com.amazonaws.wellarchitected#MilestoneName": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The name of the milestone in a workload.

\n

Milestone names must be unique within a workload.

", - "smithy.api#length": { - "min": 3, - "max": 100 - } - } - }, - "com.amazonaws.wellarchitected#MilestoneNumber": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The milestone number.

\n

A workload can have a maximum of 100 milestones.

", - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.wellarchitected#MilestoneSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#MilestoneSummary" - }, - "traits": { - "smithy.api#documentation": "

A list of milestone summaries.

" - } - }, - "com.amazonaws.wellarchitected#MilestoneSummary": { - "type": "structure", - "members": { - "MilestoneNumber": { - "target": "com.amazonaws.wellarchitected#MilestoneNumber", - "traits": { - "smithy.api#default": 0 - } - }, - "MilestoneName": { - "target": "com.amazonaws.wellarchitected#MilestoneName" - }, - "RecordedAt": { - "target": "com.amazonaws.wellarchitected#Timestamp" - }, - "WorkloadSummary": { - "target": "com.amazonaws.wellarchitected#WorkloadSummary" - } - }, - "traits": { - "smithy.api#documentation": "

A milestone summary return object.

" - } - }, - "com.amazonaws.wellarchitected#NextToken": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next set of results.

" - } - }, - "com.amazonaws.wellarchitected#Notes": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The notes associated with the workload.

", - "smithy.api#length": { - "min": 0, - "max": 2084 - } - } - }, - "com.amazonaws.wellarchitected#NotificationSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#NotificationSummary" - } - }, - "com.amazonaws.wellarchitected#NotificationSummary": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.wellarchitected#NotificationType", - "traits": { - "smithy.api#documentation": "

The type of notification.

" - } - }, - "LensUpgradeSummary": { - "target": "com.amazonaws.wellarchitected#LensUpgradeSummary", - "traits": { - "smithy.api#documentation": "

Summary of lens upgrade.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A notification summary return object.

" - } - }, - "com.amazonaws.wellarchitected#NotificationType": { - "type": "enum", - "members": { - "LENS_VERSION_UPGRADED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LENS_VERSION_UPGRADED" - } - }, - "LENS_VERSION_DEPRECATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LENS_VERSION_DEPRECATED" - } - } - } - }, - "com.amazonaws.wellarchitected#OrganizationSharingStatus": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.wellarchitected#PermissionType": { - "type": "enum", - "members": { - "READONLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "READONLY" - } - }, - "CONTRIBUTOR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTRIBUTOR" - } - } - }, - "traits": { - "smithy.api#documentation": "

Permission granted on a workload share.

" - } - }, - "com.amazonaws.wellarchitected#PillarDifference": { - "type": "structure", - "members": { - "PillarId": { - "target": "com.amazonaws.wellarchitected#PillarId" - }, - "PillarName": { - "target": "com.amazonaws.wellarchitected#PillarName" - }, - "DifferenceStatus": { - "target": "com.amazonaws.wellarchitected#DifferenceStatus", - "traits": { - "smithy.api#documentation": "

Indicates the type of change to the pillar.

" - } - }, - "QuestionDifferences": { - "target": "com.amazonaws.wellarchitected#QuestionDifferences", - "traits": { - "smithy.api#documentation": "

List of question differences.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A pillar difference return object.

" - } - }, - "com.amazonaws.wellarchitected#PillarDifferences": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#PillarDifference" - } - }, - "com.amazonaws.wellarchitected#PillarId": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The ID used to identify a pillar, for example, security.

\n

A pillar is identified by its PillarReviewSummary$PillarId.

", - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.wellarchitected#PillarMetric": { - "type": "structure", - "members": { - "PillarId": { - "target": "com.amazonaws.wellarchitected#PillarId" - }, - "RiskCounts": { - "target": "com.amazonaws.wellarchitected#RiskCounts" - }, - "Questions": { - "target": "com.amazonaws.wellarchitected#QuestionMetrics", - "traits": { - "smithy.api#documentation": "

The questions that have been identified as risks in the pillar.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A metric for a particular pillar in a lens.

" - } - }, - "com.amazonaws.wellarchitected#PillarMetrics": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#PillarMetric" - } - }, - "com.amazonaws.wellarchitected#PillarName": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The name of the pillar.

", - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.wellarchitected#PillarNotes": { - "type": "map", - "key": { - "target": "com.amazonaws.wellarchitected#PillarId" - }, - "value": { - "target": "com.amazonaws.wellarchitected#Notes" - }, - "traits": { - "smithy.api#documentation": "

List of pillar notes of a lens review in a workload.

" - } - }, - "com.amazonaws.wellarchitected#PillarReviewSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#PillarReviewSummary" - }, - "traits": { - "smithy.api#documentation": "

List of pillar review summaries of lens review in a workload.

" - } - }, - "com.amazonaws.wellarchitected#PillarReviewSummary": { - "type": "structure", - "members": { - "PillarId": { - "target": "com.amazonaws.wellarchitected#PillarId" + "com.amazonaws.wellarchitected#SelectedChoiceIds": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ChoiceId" + } }, - "PillarName": { - "target": "com.amazonaws.wellarchitected#PillarName" + "com.amazonaws.wellarchitected#SelectedChoices": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ChoiceId" + }, + "traits": { + "smithy.api#documentation": "

List of selected choice IDs in a question answer.

\n

The values entered replace the previously selected choices.

" + } }, - "Notes": { - "target": "com.amazonaws.wellarchitected#Notes" + "com.amazonaws.wellarchitected#SelectedProfileChoiceIds": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ChoiceId" + } }, - "RiskCounts": { - "target": "com.amazonaws.wellarchitected#RiskCounts" - } - }, - "traits": { - "smithy.api#documentation": "

A pillar review summary of a lens review.

" - } - }, - "com.amazonaws.wellarchitected#QuestionDescription": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The description of the question.

", - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.wellarchitected#QuestionDifference": { - "type": "structure", - "members": { - "QuestionId": { - "target": "com.amazonaws.wellarchitected#QuestionId" - }, - "QuestionTitle": { - "target": "com.amazonaws.wellarchitected#QuestionTitle" - }, - "DifferenceStatus": { - "target": "com.amazonaws.wellarchitected#DifferenceStatus", - "traits": { - "smithy.api#documentation": "

Indicates the type of change to the question.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A question difference return object.

" - } - }, - "com.amazonaws.wellarchitected#QuestionDifferences": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#QuestionDifference" - } - }, - "com.amazonaws.wellarchitected#QuestionId": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The ID of the question.

", - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.wellarchitected#QuestionMetric": { - "type": "structure", - "members": { - "QuestionId": { - "target": "com.amazonaws.wellarchitected#QuestionId" - }, - "Risk": { - "target": "com.amazonaws.wellarchitected#Risk" - }, - "BestPractices": { - "target": "com.amazonaws.wellarchitected#BestPractices", - "traits": { - "smithy.api#documentation": "

The best practices, or choices, that have been identified as contributing to risk in a question.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A metric for a particular question in the pillar.

" - } - }, - "com.amazonaws.wellarchitected#QuestionMetrics": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#QuestionMetric" - } - }, - "com.amazonaws.wellarchitected#QuestionTitle": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The title of the question.

", - "smithy.api#length": { - "min": 1, - "max": 512 - } - } - }, - "com.amazonaws.wellarchitected#QuotaCode": { - "type": "string", - "traits": { - "smithy.api#documentation": "

Service Quotas requirement to identify originating quota.

" - } - }, - "com.amazonaws.wellarchitected#ReportFormat": { - "type": "enum", - "members": { - "PDF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PDF" - } - }, - "JSON": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JSON" - } - } - } - }, - "com.amazonaws.wellarchitected#ResourceNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.wellarchitected#ExceptionMessage", - "traits": { - "smithy.api#required": {} - } - }, - "ResourceId": { - "target": "com.amazonaws.wellarchitected#ExceptionResourceId", - "traits": { - "smithy.api#required": {} - } - }, - "ResourceType": { - "target": "com.amazonaws.wellarchitected#ExceptionResourceType", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The requested resource was not found.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.wellarchitected#Risk": { - "type": "enum", - "members": { - "UNANSWERED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNANSWERED" - } - }, - "HIGH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HIGH" - } - }, - "MEDIUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MEDIUM" - } - }, - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - }, - "NOT_APPLICABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_APPLICABLE" - } - } - }, - "traits": { - "smithy.api#documentation": "

The risk for a given workload, lens review, pillar, or question.

" - } - }, - "com.amazonaws.wellarchitected#RiskCounts": { - "type": "map", - "key": { - "target": "com.amazonaws.wellarchitected#Risk" - }, - "value": { - "target": "com.amazonaws.wellarchitected#Count" - }, - "traits": { - "smithy.api#documentation": "

A map from risk names to the count of how many questions have that rating.

" - } - }, - "com.amazonaws.wellarchitected#SelectedChoices": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#ChoiceId" - }, - "traits": { - "smithy.api#documentation": "

List of selected choice IDs in a question answer.

\n

The values entered replace the previously selected choices.

" - } - }, - "com.amazonaws.wellarchitected#ServiceCode": { - "type": "string", - "traits": { - "smithy.api#documentation": "

Service Quotas requirement to identify originating service.

" - } - }, - "com.amazonaws.wellarchitected#ServiceQuotaExceededException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.wellarchitected#ExceptionMessage", - "traits": { - "smithy.api#required": {} - } - }, - "ResourceId": { - "target": "com.amazonaws.wellarchitected#ExceptionResourceId" - }, - "ResourceType": { - "target": "com.amazonaws.wellarchitected#ExceptionResourceType" - }, - "QuotaCode": { - "target": "com.amazonaws.wellarchitected#QuotaCode", - "traits": { - "smithy.api#required": {} - } - }, - "ServiceCode": { - "target": "com.amazonaws.wellarchitected#ServiceCode", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The user has reached their resource quota.

", - "smithy.api#error": "client", - "smithy.api#httpError": 402 - } - }, - "com.amazonaws.wellarchitected#ShareId": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The ID associated with the workload share.

", - "smithy.api#pattern": "^[0-9a-f]{32}$" - } - }, - "com.amazonaws.wellarchitected#ShareInvitation": { - "type": "structure", - "members": { - "ShareInvitationId": { - "target": "com.amazonaws.wellarchitected#ShareInvitationId", - "traits": { - "smithy.api#documentation": "

The ID assigned to the share invitation.

" - } - }, - "ShareResourceType": { - "target": "com.amazonaws.wellarchitected#ShareResourceType", - "traits": { - "smithy.api#documentation": "

The resource type of the share invitation.

" - } - }, - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId" - }, - "LensAlias": { - "target": "com.amazonaws.wellarchitected#LensAlias" - }, - "LensArn": { - "target": "com.amazonaws.wellarchitected#LensArn", - "traits": { - "smithy.api#documentation": "

The ARN for the lens.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The share invitation.

" - } - }, - "com.amazonaws.wellarchitected#ShareInvitationAction": { - "type": "enum", - "members": { - "ACCEPT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACCEPT" - } - }, - "REJECT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REJECT" - } - } - }, - "traits": { - "smithy.api#documentation": "

Share invitation action taken by contributor.

" - } - }, - "com.amazonaws.wellarchitected#ShareInvitationId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[0-9a-f]{32}$" - } - }, - "com.amazonaws.wellarchitected#ShareInvitationSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#ShareInvitationSummary" - } - }, - "com.amazonaws.wellarchitected#ShareInvitationSummary": { - "type": "structure", - "members": { - "ShareInvitationId": { - "target": "com.amazonaws.wellarchitected#ShareInvitationId", - "traits": { - "smithy.api#documentation": "

The ID assigned to the share invitation.

" - } - }, - "SharedBy": { - "target": "com.amazonaws.wellarchitected#AwsAccountId" - }, - "SharedWith": { - "target": "com.amazonaws.wellarchitected#SharedWith" - }, - "PermissionType": { - "target": "com.amazonaws.wellarchitected#PermissionType" - }, - "ShareResourceType": { - "target": "com.amazonaws.wellarchitected#ShareResourceType", - "traits": { - "smithy.api#documentation": "

The resource type of the share invitation.

" - } - }, - "WorkloadName": { - "target": "com.amazonaws.wellarchitected#WorkloadName" - }, - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId" - }, - "LensName": { - "target": "com.amazonaws.wellarchitected#LensName" - }, - "LensArn": { - "target": "com.amazonaws.wellarchitected#LensArn", - "traits": { - "smithy.api#documentation": "

The ARN for the lens.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A share invitation summary return object.

" - } - }, - "com.amazonaws.wellarchitected#ShareResourceType": { - "type": "enum", - "members": { - "WORKLOAD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WORKLOAD" - } - }, - "LENS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LENS" - } - } - } - }, - "com.amazonaws.wellarchitected#ShareStatus": { - "type": "enum", - "members": { - "ACCEPTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACCEPTED" - } - }, - "REJECTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REJECTED" - } - }, - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "REVOKED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REVOKED" - } - }, - "EXPIRED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXPIRED" - } - }, - "ASSOCIATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ASSOCIATING" - } - }, - "ASSOCIATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ASSOCIATED" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - } - }, - "traits": { - "smithy.api#documentation": "

The status of a workload share.

" - } - }, - "com.amazonaws.wellarchitected#SharedWith": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload is shared.

", - "smithy.api#length": { - "min": 12, - "max": 2048 - } - } - }, - "com.amazonaws.wellarchitected#SharedWithPrefix": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.wellarchitected#StatusMessage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - } - } - }, - "com.amazonaws.wellarchitected#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.wellarchitected#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.wellarchitected#TagMap": { - "type": "map", - "key": { - "target": "com.amazonaws.wellarchitected#TagKey" - }, - "value": { - "target": "com.amazonaws.wellarchitected#TagValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.wellarchitected#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#TagResourceInput" - }, - "output": { - "target": "com.amazonaws.wellarchitected#TagResourceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Adds one or more tags to the specified resource.

\n \n

The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/tags/{WorkloadArn}", - "code": 200 - } - } - }, - "com.amazonaws.wellarchitected#TagResourceInput": { - "type": "structure", - "members": { - "WorkloadArn": { - "target": "com.amazonaws.wellarchitected#WorkloadArn", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.wellarchitected#TagMap", - "traits": { - "smithy.api#documentation": "

The tags for the resource.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#TagResourceOutput": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.wellarchitected#ThrottlingException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.wellarchitected#ExceptionMessage", - "traits": { - "smithy.api#required": {} - } - }, - "QuotaCode": { - "target": "com.amazonaws.wellarchitected#QuotaCode" - }, - "ServiceCode": { - "target": "com.amazonaws.wellarchitected#ServiceCode" - } - }, - "traits": { - "smithy.api#documentation": "

Request was denied due to request throttling.

", - "smithy.api#error": "client", - "smithy.api#httpError": 429 - } - }, - "com.amazonaws.wellarchitected#Timestamp": { - "type": "timestamp", - "traits": { - "smithy.api#documentation": "

The date and time recorded.

" - } - }, - "com.amazonaws.wellarchitected#TrustedAdvisorIntegrationStatus": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.wellarchitected#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#UntagResourceInput" - }, - "output": { - "target": "com.amazonaws.wellarchitected#UntagResourceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes specified tags from a resource.

\n \n

The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.

\n \n

To specify multiple tags, use separate tagKeys parameters, for example:

\n

\n DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2\n

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/tags/{WorkloadArn}", - "code": 200 - } - } - }, - "com.amazonaws.wellarchitected#UntagResourceInput": { - "type": "structure", - "members": { - "WorkloadArn": { - "target": "com.amazonaws.wellarchitected#WorkloadArn", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TagKeys": { - "target": "com.amazonaws.wellarchitected#TagKeyList", - "traits": { - "smithy.api#documentation": "

A list of tag keys. Existing tags of the resource \n whose keys are members of this list are removed from the resource.

", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#UntagResourceOutput": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#UpdateAnswer": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#UpdateAnswerInput" - }, - "output": { - "target": "com.amazonaws.wellarchitected#UpdateAnswerOutput" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#ConflictException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Update the answer to a specific question in a workload review.

", - "smithy.api#http": { - "method": "PATCH", - "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}/answers/{QuestionId}", - "code": 200 - } - } - }, - "com.amazonaws.wellarchitected#UpdateAnswerInput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "LensAlias": { - "target": "com.amazonaws.wellarchitected#LensAlias", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "QuestionId": { - "target": "com.amazonaws.wellarchitected#QuestionId", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "SelectedChoices": { - "target": "com.amazonaws.wellarchitected#SelectedChoices" - }, - "ChoiceUpdates": { - "target": "com.amazonaws.wellarchitected#ChoiceUpdates", - "traits": { - "smithy.api#documentation": "

A list of choices to update on a question in your workload. The String key \n corresponds to the choice ID to be updated.

" - } - }, - "Notes": { - "target": "com.amazonaws.wellarchitected#Notes" - }, - "IsApplicable": { - "target": "com.amazonaws.wellarchitected#IsApplicable", - "traits": { - "smithy.api#default": false - } - }, - "Reason": { - "target": "com.amazonaws.wellarchitected#AnswerReason", - "traits": { - "smithy.api#documentation": "

The reason why a question is not applicable to your workload.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Input to update answer.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#UpdateAnswerOutput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId" - }, - "LensAlias": { - "target": "com.amazonaws.wellarchitected#LensAlias" - }, - "LensArn": { - "target": "com.amazonaws.wellarchitected#LensArn", - "traits": { - "smithy.api#documentation": "

The ARN for the lens.

" - } - }, - "Answer": { - "target": "com.amazonaws.wellarchitected#Answer" - } - }, - "traits": { - "smithy.api#documentation": "

Output of a update answer call.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#UpdateGlobalSettings": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#UpdateGlobalSettingsInput" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#ConflictException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates whether the Amazon Web Services account is opted into organization sharing and discovery integration features.

", - "smithy.api#http": { - "method": "PATCH", - "uri": "/global-settings", - "code": 200 - } - } - }, - "com.amazonaws.wellarchitected#UpdateGlobalSettingsInput": { - "type": "structure", - "members": { - "OrganizationSharingStatus": { - "target": "com.amazonaws.wellarchitected#OrganizationSharingStatus", - "traits": { - "smithy.api#documentation": "

The status of organization sharing settings.

" - } - }, - "DiscoveryIntegrationStatus": { - "target": "com.amazonaws.wellarchitected#DiscoveryIntegrationStatus", - "traits": { - "smithy.api#documentation": "

The status of discovery support settings.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#UpdateLensReview": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#UpdateLensReviewInput" - }, - "output": { - "target": "com.amazonaws.wellarchitected#UpdateLensReviewOutput" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#ConflictException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Update lens review for a particular workload.

", - "smithy.api#http": { - "method": "PATCH", - "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}", - "code": 200 - } - } - }, - "com.amazonaws.wellarchitected#UpdateLensReviewInput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "LensAlias": { - "target": "com.amazonaws.wellarchitected#LensAlias", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "LensNotes": { - "target": "com.amazonaws.wellarchitected#Notes" - }, - "PillarNotes": { - "target": "com.amazonaws.wellarchitected#PillarNotes" - } - }, - "traits": { - "smithy.api#documentation": "

Input for update lens review.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#UpdateLensReviewOutput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId" - }, - "LensReview": { - "target": "com.amazonaws.wellarchitected#LensReview" - } - }, - "traits": { - "smithy.api#documentation": "

Output of a update lens review call.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#UpdateShareInvitation": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#UpdateShareInvitationInput" - }, - "output": { - "target": "com.amazonaws.wellarchitected#UpdateShareInvitationOutput" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#ConflictException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Update a workload or custom lens share invitation.

\n \n

This API operation can be called independently of any resource. Previous documentation implied that a workload ARN must be specified.

\n ", - "smithy.api#http": { - "method": "PATCH", - "uri": "/shareInvitations/{ShareInvitationId}", - "code": 200 - } - } - }, - "com.amazonaws.wellarchitected#UpdateShareInvitationInput": { - "type": "structure", - "members": { - "ShareInvitationId": { - "target": "com.amazonaws.wellarchitected#ShareInvitationId", - "traits": { - "smithy.api#documentation": "

The ID assigned to the share invitation.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ShareInvitationAction": { - "target": "com.amazonaws.wellarchitected#ShareInvitationAction", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Input for Update Share Invitation

", - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#UpdateShareInvitationOutput": { - "type": "structure", - "members": { - "ShareInvitation": { - "target": "com.amazonaws.wellarchitected#ShareInvitation", - "traits": { - "smithy.api#documentation": "

The updated workload or custom lens share invitation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#UpdateWorkload": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#UpdateWorkloadInput" - }, - "output": { - "target": "com.amazonaws.wellarchitected#UpdateWorkloadOutput" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#ConflictException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Update an existing workload.

", - "smithy.api#http": { - "method": "PATCH", - "uri": "/workloads/{WorkloadId}", - "code": 200 - } - } - }, - "com.amazonaws.wellarchitected#UpdateWorkloadInput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } + "com.amazonaws.wellarchitected#ServiceCode": { + "type": "string", + "traits": { + "smithy.api#documentation": "

Service Quotas requirement to identify originating service.

" + } }, - "WorkloadName": { - "target": "com.amazonaws.wellarchitected#WorkloadName" + "com.amazonaws.wellarchitected#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wellarchitected#ExceptionMessage", + "traits": { + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.wellarchitected#ExceptionResourceId" + }, + "ResourceType": { + "target": "com.amazonaws.wellarchitected#ExceptionResourceType" + }, + "QuotaCode": { + "target": "com.amazonaws.wellarchitected#QuotaCode", + "traits": { + "smithy.api#required": {} + } + }, + "ServiceCode": { + "target": "com.amazonaws.wellarchitected#ServiceCode", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The user has reached their resource quota.

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } }, - "Description": { - "target": "com.amazonaws.wellarchitected#WorkloadDescription" + "com.amazonaws.wellarchitected#ShareId": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The ID associated with the share.

", + "smithy.api#pattern": "^[0-9a-f]{32}$" + } }, - "Environment": { - "target": "com.amazonaws.wellarchitected#WorkloadEnvironment" + "com.amazonaws.wellarchitected#ShareInvitation": { + "type": "structure", + "members": { + "ShareInvitationId": { + "target": "com.amazonaws.wellarchitected#ShareInvitationId", + "traits": { + "smithy.api#documentation": "

The ID assigned to the share invitation.

" + } + }, + "ShareResourceType": { + "target": "com.amazonaws.wellarchitected#ShareResourceType", + "traits": { + "smithy.api#documentation": "

The resource type of the share invitation.

" + } + }, + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias" + }, + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "

The ARN for the lens.

" + } + }, + "ProfileArn": { + "target": "com.amazonaws.wellarchitected#ProfileArn", + "traits": { + "smithy.api#documentation": "

The profile ARN.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The share invitation.

" + } }, - "AccountIds": { - "target": "com.amazonaws.wellarchitected#WorkloadAccountIds" + "com.amazonaws.wellarchitected#ShareInvitationAction": { + "type": "enum", + "members": { + "ACCEPT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCEPT" + } + }, + "REJECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REJECT" + } + } + }, + "traits": { + "smithy.api#documentation": "

Share invitation action taken by contributor.

" + } }, - "AwsRegions": { - "target": "com.amazonaws.wellarchitected#WorkloadAwsRegions" + "com.amazonaws.wellarchitected#ShareInvitationId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9a-f]{32}$" + } }, - "NonAwsRegions": { - "target": "com.amazonaws.wellarchitected#WorkloadNonAwsRegions" + "com.amazonaws.wellarchitected#ShareInvitationSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ShareInvitationSummary" + } }, - "PillarPriorities": { - "target": "com.amazonaws.wellarchitected#WorkloadPillarPriorities" + "com.amazonaws.wellarchitected#ShareInvitationSummary": { + "type": "structure", + "members": { + "ShareInvitationId": { + "target": "com.amazonaws.wellarchitected#ShareInvitationId", + "traits": { + "smithy.api#documentation": "

The ID assigned to the share invitation.

" + } + }, + "SharedBy": { + "target": "com.amazonaws.wellarchitected#AwsAccountId" + }, + "SharedWith": { + "target": "com.amazonaws.wellarchitected#SharedWith" + }, + "PermissionType": { + "target": "com.amazonaws.wellarchitected#PermissionType" + }, + "ShareResourceType": { + "target": "com.amazonaws.wellarchitected#ShareResourceType", + "traits": { + "smithy.api#documentation": "

The resource type of the share invitation.

" + } + }, + "WorkloadName": { + "target": "com.amazonaws.wellarchitected#WorkloadName" + }, + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "LensName": { + "target": "com.amazonaws.wellarchitected#LensName" + }, + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "

The ARN for the lens.

" + } + }, + "ProfileName": { + "target": "com.amazonaws.wellarchitected#ProfileName", + "traits": { + "smithy.api#documentation": "

The profile name.

" + } + }, + "ProfileArn": { + "target": "com.amazonaws.wellarchitected#ProfileArn", + "traits": { + "smithy.api#documentation": "

The profile ARN.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A share invitation summary return object.

" + } }, - "ArchitecturalDesign": { - "target": "com.amazonaws.wellarchitected#WorkloadArchitecturalDesign" + "com.amazonaws.wellarchitected#ShareResourceType": { + "type": "enum", + "members": { + "WORKLOAD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WORKLOAD" + } + }, + "LENS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LENS" + } + }, + "PROFILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROFILE" + } + } + } }, - "ReviewOwner": { - "target": "com.amazonaws.wellarchitected#WorkloadReviewOwner" + "com.amazonaws.wellarchitected#ShareStatus": { + "type": "enum", + "members": { + "ACCEPTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCEPTED" + } + }, + "REJECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REJECTED" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "REVOKED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REVOKED" + } + }, + "EXPIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPIRED" + } + }, + "ASSOCIATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASSOCIATING" + } + }, + "ASSOCIATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASSOCIATED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + }, + "traits": { + "smithy.api#documentation": "

The status of the share request.

" + } }, - "IsReviewOwnerUpdateAcknowledged": { - "target": "com.amazonaws.wellarchitected#IsReviewOwnerUpdateAcknowledged", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Flag indicating whether the workload owner has acknowledged that the Review\n owner field is required.

\n

If a Review owner is not added to the workload within\n 60 days of acknowledgement, access to the workload is restricted until an owner is\n added.

" - } + "com.amazonaws.wellarchitected#SharedWith": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload, lens, or profile is shared.

", + "smithy.api#length": { + "min": 12, + "max": 2048 + } + } }, - "IndustryType": { - "target": "com.amazonaws.wellarchitected#WorkloadIndustryType" + "com.amazonaws.wellarchitected#SharedWithPrefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } }, - "Industry": { - "target": "com.amazonaws.wellarchitected#WorkloadIndustry" + "com.amazonaws.wellarchitected#StatusMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } }, - "Notes": { - "target": "com.amazonaws.wellarchitected#Notes" + "com.amazonaws.wellarchitected#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } }, - "ImprovementStatus": { - "target": "com.amazonaws.wellarchitected#WorkloadImprovementStatus" + "com.amazonaws.wellarchitected#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } }, - "DiscoveryConfig": { - "target": "com.amazonaws.wellarchitected#WorkloadDiscoveryConfig", - "traits": { - "smithy.api#documentation": "

Well-Architected discovery configuration settings to associate to the workload.

" - } + "com.amazonaws.wellarchitected#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.wellarchitected#TagKey" + }, + "value": { + "target": "com.amazonaws.wellarchitected#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } }, - "Applications": { - "target": "com.amazonaws.wellarchitected#WorkloadApplications", - "traits": { - "smithy.api#documentation": "

List of AppRegistry application ARNs to associate to the workload.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Input to update a workload.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#UpdateWorkloadOutput": { - "type": "structure", - "members": { - "Workload": { - "target": "com.amazonaws.wellarchitected#Workload" - } - }, - "traits": { - "smithy.api#documentation": "

Output of an update workload call.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#UpdateWorkloadShare": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#UpdateWorkloadShareInput" - }, - "output": { - "target": "com.amazonaws.wellarchitected#UpdateWorkloadShareOutput" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#ConflictException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Update a workload share.

", - "smithy.api#http": { - "method": "PATCH", - "uri": "/workloads/{WorkloadId}/shares/{ShareId}", - "code": 200 - } - } - }, - "com.amazonaws.wellarchitected#UpdateWorkloadShareInput": { - "type": "structure", - "members": { - "ShareId": { - "target": "com.amazonaws.wellarchitected#ShareId", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "PermissionType": { - "target": "com.amazonaws.wellarchitected#PermissionType", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Input for Update Workload Share

", - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#UpdateWorkloadShareOutput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId" - }, - "WorkloadShare": { - "target": "com.amazonaws.wellarchitected#WorkloadShare" - } - }, - "traits": { - "smithy.api#documentation": "

Input for Update Workload Share

", - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#UpgradeLensReview": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#UpgradeLensReviewInput" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#AccessDeniedException" - }, - { - "target": "com.amazonaws.wellarchitected#ConflictException" - }, - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.wellarchitected#ThrottlingException" - }, - { - "target": "com.amazonaws.wellarchitected#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Upgrade lens review for a particular workload.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}/upgrade", - "code": 200 - } - } - }, - "com.amazonaws.wellarchitected#UpgradeLensReviewInput": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "LensAlias": { - "target": "com.amazonaws.wellarchitected#LensAlias", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "MilestoneName": { - "target": "com.amazonaws.wellarchitected#MilestoneName", - "traits": { - "smithy.api#required": {} - } - }, - "ClientRequestToken": { - "target": "com.amazonaws.wellarchitected#ClientRequestToken" - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.wellarchitected#Urls": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#ChoiceContent" - } - }, - "com.amazonaws.wellarchitected#ValidationException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.wellarchitected#ExceptionMessage", - "traits": { - "smithy.api#required": {} - } - }, - "Reason": { - "target": "com.amazonaws.wellarchitected#ValidationExceptionReason" - }, - "Fields": { - "target": "com.amazonaws.wellarchitected#ValidationExceptionFieldList" - } - }, - "traits": { - "smithy.api#documentation": "

The user input is not valid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.wellarchitected#ValidationExceptionField": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.wellarchitected#ValidationExceptionFieldName", - "traits": { - "smithy.api#required": {} - } - }, - "Message": { - "target": "com.amazonaws.wellarchitected#ExceptionMessage", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Stores information about a field passed inside a request that resulted in an exception.

" - } - }, - "com.amazonaws.wellarchitected#ValidationExceptionFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#ValidationExceptionField" - }, - "traits": { - "smithy.api#documentation": "

The fields that caused the error, if applicable.

" - } - }, - "com.amazonaws.wellarchitected#ValidationExceptionFieldName": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The field name for which validation failed.

" - } - }, - "com.amazonaws.wellarchitected#ValidationExceptionReason": { - "type": "enum", - "members": { - "UNKNOWN_OPERATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNKNOWN_OPERATION" - } - }, - "CANNOT_PARSE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CANNOT_PARSE" - } - }, - "FIELD_VALIDATION_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FIELD_VALIDATION_FAILED" - } - }, - "OTHER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OTHER" - } - } - }, - "traits": { - "smithy.api#documentation": "

The reason why the request failed validation.

" - } - }, - "com.amazonaws.wellarchitected#VersionDifferences": { - "type": "structure", - "members": { - "PillarDifferences": { - "target": "com.amazonaws.wellarchitected#PillarDifferences", - "traits": { - "smithy.api#documentation": "

The differences between the base and latest versions of the lens.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The differences between the base and latest versions of the lens.

" - } - }, - "com.amazonaws.wellarchitected#WellArchitectedApiServiceLambda": { - "type": "service", - "version": "2020-03-31", - "operations": [ - { - "target": "com.amazonaws.wellarchitected#AssociateLenses" + "com.amazonaws.wellarchitected#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#TagResourceInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#TagResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds one or more tags to the specified resource.

\n \n

The WorkloadArn parameter can be a workload ARN, a custom lens ARN, or a profile ARN.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{WorkloadArn}", + "code": 200 + } + } }, - { - "target": "com.amazonaws.wellarchitected#CreateLensShare" + "com.amazonaws.wellarchitected#TagResourceInput": { + "type": "structure", + "members": { + "WorkloadArn": { + "target": "com.amazonaws.wellarchitected#WorkloadArn", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.wellarchitected#TagMap", + "traits": { + "smithy.api#documentation": "

The tags for the resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.wellarchitected#CreateLensVersion" + "com.amazonaws.wellarchitected#TagResourceOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.wellarchitected#CreateMilestone" + "com.amazonaws.wellarchitected#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } }, - { - "target": "com.amazonaws.wellarchitected#CreateWorkload" + "com.amazonaws.wellarchitected#TemplateQuestions": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ProfileTemplateQuestion" + } }, - { - "target": "com.amazonaws.wellarchitected#CreateWorkloadShare" + "com.amazonaws.wellarchitected#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wellarchitected#ExceptionMessage", + "traits": { + "smithy.api#required": {} + } + }, + "QuotaCode": { + "target": "com.amazonaws.wellarchitected#QuotaCode" + }, + "ServiceCode": { + "target": "com.amazonaws.wellarchitected#ServiceCode" + } + }, + "traits": { + "smithy.api#documentation": "

Request was denied due to request throttling.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } }, - { - "target": "com.amazonaws.wellarchitected#DeleteLens" + "com.amazonaws.wellarchitected#Timestamp": { + "type": "timestamp", + "traits": { + "smithy.api#documentation": "

The date and time recorded.

" + } }, - { - "target": "com.amazonaws.wellarchitected#DeleteLensShare" + "com.amazonaws.wellarchitected#TrustedAdvisorIntegrationStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } }, - { - "target": "com.amazonaws.wellarchitected#DeleteWorkload" + "com.amazonaws.wellarchitected#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#UntagResourceInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#UntagResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes specified tags from a resource.

\n \n

The WorkloadArn parameter can be a workload ARN, a custom lens ARN, or a profile ARN.

\n \n

To specify multiple tags, use separate tagKeys parameters, for example:

\n

\n DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2\n

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{WorkloadArn}", + "code": 200 + } + } }, - { - "target": "com.amazonaws.wellarchitected#DeleteWorkloadShare" + "com.amazonaws.wellarchitected#UntagResourceInput": { + "type": "structure", + "members": { + "WorkloadArn": { + "target": "com.amazonaws.wellarchitected#WorkloadArn", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.wellarchitected#TagKeyList", + "traits": { + "smithy.api#documentation": "

A list of tag keys. Existing tags of the resource \n whose keys are members of this list are removed from the resource.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.wellarchitected#DisassociateLenses" + "com.amazonaws.wellarchitected#UntagResourceOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.wellarchitected#ExportLens" + "com.amazonaws.wellarchitected#UpdateAnswer": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#UpdateAnswerInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#UpdateAnswerOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Update the answer to a specific question in a workload review.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}/answers/{QuestionId}", + "code": 200 + } + } }, - { - "target": "com.amazonaws.wellarchitected#GetAnswer" + "com.amazonaws.wellarchitected#UpdateAnswerInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QuestionId": { + "target": "com.amazonaws.wellarchitected#QuestionId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SelectedChoices": { + "target": "com.amazonaws.wellarchitected#SelectedChoices" + }, + "ChoiceUpdates": { + "target": "com.amazonaws.wellarchitected#ChoiceUpdates", + "traits": { + "smithy.api#documentation": "

A list of choices to update on a question in your workload. The String key \n corresponds to the choice ID to be updated.

" + } + }, + "Notes": { + "target": "com.amazonaws.wellarchitected#Notes" + }, + "IsApplicable": { + "target": "com.amazonaws.wellarchitected#IsApplicable", + "traits": { + "smithy.api#default": false + } + }, + "Reason": { + "target": "com.amazonaws.wellarchitected#AnswerReason", + "traits": { + "smithy.api#documentation": "

The reason why a question is not applicable to your workload.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input to update answer.

", + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.wellarchitected#GetConsolidatedReport" + "com.amazonaws.wellarchitected#UpdateAnswerOutput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias" + }, + "LensArn": { + "target": "com.amazonaws.wellarchitected#LensArn", + "traits": { + "smithy.api#documentation": "

The ARN for the lens.

" + } + }, + "Answer": { + "target": "com.amazonaws.wellarchitected#Answer" + } + }, + "traits": { + "smithy.api#documentation": "

Output of a update answer call.

", + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.wellarchitected#GetLens" + "com.amazonaws.wellarchitected#UpdateGlobalSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#UpdateGlobalSettingsInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates whether the Amazon Web Services account is opted into organization sharing and discovery integration features.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/global-settings", + "code": 200 + } + } }, - { - "target": "com.amazonaws.wellarchitected#GetLensReview" + "com.amazonaws.wellarchitected#UpdateGlobalSettingsInput": { + "type": "structure", + "members": { + "OrganizationSharingStatus": { + "target": "com.amazonaws.wellarchitected#OrganizationSharingStatus", + "traits": { + "smithy.api#documentation": "

The status of organization sharing settings.

" + } + }, + "DiscoveryIntegrationStatus": { + "target": "com.amazonaws.wellarchitected#DiscoveryIntegrationStatus", + "traits": { + "smithy.api#documentation": "

The status of discovery support settings.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.wellarchitected#GetLensReviewReport" + "com.amazonaws.wellarchitected#UpdateLensReview": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#UpdateLensReviewInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#UpdateLensReviewOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Update lens review for a particular workload.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}", + "code": 200 + } + } }, - { - "target": "com.amazonaws.wellarchitected#GetLensVersionDifference" + "com.amazonaws.wellarchitected#UpdateLensReviewInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LensNotes": { + "target": "com.amazonaws.wellarchitected#Notes" + }, + "PillarNotes": { + "target": "com.amazonaws.wellarchitected#PillarNotes" + } + }, + "traits": { + "smithy.api#documentation": "

Input for update lens review.

", + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.wellarchitected#GetMilestone" + "com.amazonaws.wellarchitected#UpdateLensReviewOutput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "LensReview": { + "target": "com.amazonaws.wellarchitected#LensReview" + } + }, + "traits": { + "smithy.api#documentation": "

Output of a update lens review call.

", + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.wellarchitected#GetWorkload" + "com.amazonaws.wellarchitected#UpdateProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#UpdateProfileInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#UpdateProfileOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Update a profile.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/profiles/{ProfileArn}", + "code": 200 + } + } }, - { - "target": "com.amazonaws.wellarchitected#ImportLens" + "com.amazonaws.wellarchitected#UpdateProfileInput": { + "type": "structure", + "members": { + "ProfileArn": { + "target": "com.amazonaws.wellarchitected#ProfileArn", + "traits": { + "smithy.api#documentation": "

The profile ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ProfileDescription": { + "target": "com.amazonaws.wellarchitected#ProfileDescription", + "traits": { + "smithy.api#documentation": "

The profile description.

" + } + }, + "ProfileQuestions": { + "target": "com.amazonaws.wellarchitected#ProfileQuestionUpdates", + "traits": { + "smithy.api#documentation": "

Profile questions.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.wellarchitected#ListAnswers" + "com.amazonaws.wellarchitected#UpdateProfileOutput": { + "type": "structure", + "members": { + "Profile": { + "target": "com.amazonaws.wellarchitected#Profile", + "traits": { + "smithy.api#documentation": "

The profile.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.wellarchitected#ListCheckDetails" + "com.amazonaws.wellarchitected#UpdateShareInvitation": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#UpdateShareInvitationInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#UpdateShareInvitationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Update a workload or custom lens share invitation.

\n \n

This API operation can be called independently of any resource. Previous documentation implied that a workload ARN must be specified.

\n ", + "smithy.api#http": { + "method": "PATCH", + "uri": "/shareInvitations/{ShareInvitationId}", + "code": 200 + } + } }, - { - "target": "com.amazonaws.wellarchitected#ListCheckSummaries" + "com.amazonaws.wellarchitected#UpdateShareInvitationInput": { + "type": "structure", + "members": { + "ShareInvitationId": { + "target": "com.amazonaws.wellarchitected#ShareInvitationId", + "traits": { + "smithy.api#documentation": "

The ID assigned to the share invitation.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ShareInvitationAction": { + "target": "com.amazonaws.wellarchitected#ShareInvitationAction", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for Update Share Invitation

", + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.wellarchitected#ListLenses" + "com.amazonaws.wellarchitected#UpdateShareInvitationOutput": { + "type": "structure", + "members": { + "ShareInvitation": { + "target": "com.amazonaws.wellarchitected#ShareInvitation", + "traits": { + "smithy.api#documentation": "

The updated workload or custom lens share invitation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.wellarchitected#ListLensReviewImprovements" + "com.amazonaws.wellarchitected#UpdateWorkload": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#UpdateWorkloadInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#UpdateWorkloadOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Update an existing workload.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/workloads/{WorkloadId}", + "code": 200 + } + } }, - { - "target": "com.amazonaws.wellarchitected#ListLensReviews" + "com.amazonaws.wellarchitected#UpdateWorkloadInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "WorkloadName": { + "target": "com.amazonaws.wellarchitected#WorkloadName" + }, + "Description": { + "target": "com.amazonaws.wellarchitected#WorkloadDescription" + }, + "Environment": { + "target": "com.amazonaws.wellarchitected#WorkloadEnvironment" + }, + "AccountIds": { + "target": "com.amazonaws.wellarchitected#WorkloadAccountIds" + }, + "AwsRegions": { + "target": "com.amazonaws.wellarchitected#WorkloadAwsRegions" + }, + "NonAwsRegions": { + "target": "com.amazonaws.wellarchitected#WorkloadNonAwsRegions" + }, + "PillarPriorities": { + "target": "com.amazonaws.wellarchitected#WorkloadPillarPriorities" + }, + "ArchitecturalDesign": { + "target": "com.amazonaws.wellarchitected#WorkloadArchitecturalDesign" + }, + "ReviewOwner": { + "target": "com.amazonaws.wellarchitected#WorkloadReviewOwner" + }, + "IsReviewOwnerUpdateAcknowledged": { + "target": "com.amazonaws.wellarchitected#IsReviewOwnerUpdateAcknowledged", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Flag indicating whether the workload owner has acknowledged that the Review\n owner field is required.

\n

If a Review owner is not added to the workload within\n 60 days of acknowledgement, access to the workload is restricted until an owner is\n added.

" + } + }, + "IndustryType": { + "target": "com.amazonaws.wellarchitected#WorkloadIndustryType" + }, + "Industry": { + "target": "com.amazonaws.wellarchitected#WorkloadIndustry" + }, + "Notes": { + "target": "com.amazonaws.wellarchitected#Notes" + }, + "ImprovementStatus": { + "target": "com.amazonaws.wellarchitected#WorkloadImprovementStatus" + }, + "DiscoveryConfig": { + "target": "com.amazonaws.wellarchitected#WorkloadDiscoveryConfig", + "traits": { + "smithy.api#documentation": "

Well-Architected discovery configuration settings to associate to the workload.

" + } + }, + "Applications": { + "target": "com.amazonaws.wellarchitected#WorkloadApplications", + "traits": { + "smithy.api#documentation": "

List of AppRegistry application ARNs to associate to the workload.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input to update a workload.

", + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.wellarchitected#ListLensShares" + "com.amazonaws.wellarchitected#UpdateWorkloadOutput": { + "type": "structure", + "members": { + "Workload": { + "target": "com.amazonaws.wellarchitected#Workload" + } + }, + "traits": { + "smithy.api#documentation": "

Output of an update workload call.

", + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.wellarchitected#ListMilestones" + "com.amazonaws.wellarchitected#UpdateWorkloadShare": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#UpdateWorkloadShareInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#UpdateWorkloadShareOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Update a workload share.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/workloads/{WorkloadId}/shares/{ShareId}", + "code": 200 + } + } }, - { - "target": "com.amazonaws.wellarchitected#ListNotifications" + "com.amazonaws.wellarchitected#UpdateWorkloadShareInput": { + "type": "structure", + "members": { + "ShareId": { + "target": "com.amazonaws.wellarchitected#ShareId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PermissionType": { + "target": "com.amazonaws.wellarchitected#PermissionType", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for Update Workload Share

", + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.wellarchitected#ListShareInvitations" + "com.amazonaws.wellarchitected#UpdateWorkloadShareOutput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "WorkloadShare": { + "target": "com.amazonaws.wellarchitected#WorkloadShare" + } + }, + "traits": { + "smithy.api#documentation": "

Input for Update Workload Share

", + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.wellarchitected#ListTagsForResource" + "com.amazonaws.wellarchitected#UpgradeLensReview": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#UpgradeLensReviewInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Upgrade lens review for a particular workload.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}/upgrade", + "code": 200 + } + } }, - { - "target": "com.amazonaws.wellarchitected#ListWorkloads" + "com.amazonaws.wellarchitected#UpgradeLensReviewInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MilestoneName": { + "target": "com.amazonaws.wellarchitected#MilestoneName", + "traits": { + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.wellarchitected#ClientRequestToken" + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.wellarchitected#ListWorkloadShares" + "com.amazonaws.wellarchitected#UpgradeProfileVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#UpgradeProfileVersionInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Upgrade a profile.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/workloads/{WorkloadId}/profiles/{ProfileArn}/upgrade", + "code": 200 + } + } }, - { - "target": "com.amazonaws.wellarchitected#TagResource" + "com.amazonaws.wellarchitected#UpgradeProfileVersionInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ProfileArn": { + "target": "com.amazonaws.wellarchitected#ProfileArn", + "traits": { + "smithy.api#documentation": "

The profile ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MilestoneName": { + "target": "com.amazonaws.wellarchitected#MilestoneName" + }, + "ClientRequestToken": { + "target": "com.amazonaws.wellarchitected#ClientRequestToken", + "traits": { + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.wellarchitected#UntagResource" + "com.amazonaws.wellarchitected#Urls": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ChoiceContent" + } }, - { - "target": "com.amazonaws.wellarchitected#UpdateAnswer" + "com.amazonaws.wellarchitected#ValidationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wellarchitected#ExceptionMessage", + "traits": { + "smithy.api#required": {} + } + }, + "Reason": { + "target": "com.amazonaws.wellarchitected#ValidationExceptionReason" + }, + "Fields": { + "target": "com.amazonaws.wellarchitected#ValidationExceptionFieldList" + } + }, + "traits": { + "smithy.api#documentation": "

The user input is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.wellarchitected#UpdateGlobalSettings" + "com.amazonaws.wellarchitected#ValidationExceptionField": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wellarchitected#ValidationExceptionFieldName", + "traits": { + "smithy.api#required": {} + } + }, + "Message": { + "target": "com.amazonaws.wellarchitected#ExceptionMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Stores information about a field passed inside a request that resulted in an exception.

" + } }, - { - "target": "com.amazonaws.wellarchitected#UpdateLensReview" + "com.amazonaws.wellarchitected#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ValidationExceptionField" + }, + "traits": { + "smithy.api#documentation": "

The fields that caused the error, if applicable.

" + } }, - { - "target": "com.amazonaws.wellarchitected#UpdateShareInvitation" + "com.amazonaws.wellarchitected#ValidationExceptionFieldName": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The field name for which validation failed.

" + } }, - { - "target": "com.amazonaws.wellarchitected#UpdateWorkload" + "com.amazonaws.wellarchitected#ValidationExceptionReason": { + "type": "enum", + "members": { + "UNKNOWN_OPERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNKNOWN_OPERATION" + } + }, + "CANNOT_PARSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANNOT_PARSE" + } + }, + "FIELD_VALIDATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIELD_VALIDATION_FAILED" + } + }, + "OTHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OTHER" + } + } + }, + "traits": { + "smithy.api#documentation": "

The reason why the request failed validation.

" + } }, - { - "target": "com.amazonaws.wellarchitected#UpdateWorkloadShare" + "com.amazonaws.wellarchitected#VersionDifferences": { + "type": "structure", + "members": { + "PillarDifferences": { + "target": "com.amazonaws.wellarchitected#PillarDifferences", + "traits": { + "smithy.api#documentation": "

The differences between the base and latest versions of the lens.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The differences between the base and latest versions of the lens.

" + } }, - { - "target": "com.amazonaws.wellarchitected#UpgradeLensReview" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "WellArchitected", - "arnNamespace": "wellarchitected", - "cloudFormationName": "WellArchitected", - "cloudTrailEventSource": "wellarchitected.amazonaws.com", - "endpointPrefix": "wellarchitected" - }, - "aws.auth#sigv4": { - "name": "wellarchitected" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Well-Architected Tool\n

This is the Well-Architected Tool API Reference. The WA Tool API provides programmatic access to the \n Well-Architected Tool in the \n Amazon Web Services Management Console. For information \n about the Well-Architected Tool, see the \n Well-Architected Tool User Guide.

", - "smithy.api#title": "AWS Well-Architected Tool", - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ + "com.amazonaws.wellarchitected#WellArchitectedApiServiceLambda": { + "type": "service", + "version": "2020-03-31", + "operations": [ + { + "target": "com.amazonaws.wellarchitected#AssociateLenses" + }, + { + "target": "com.amazonaws.wellarchitected#AssociateProfiles" + }, + { + "target": "com.amazonaws.wellarchitected#CreateLensShare" + }, + { + "target": "com.amazonaws.wellarchitected#CreateLensVersion" + }, + { + "target": "com.amazonaws.wellarchitected#CreateMilestone" + }, + { + "target": "com.amazonaws.wellarchitected#CreateProfile" + }, + { + "target": "com.amazonaws.wellarchitected#CreateProfileShare" + }, + { + "target": "com.amazonaws.wellarchitected#CreateWorkload" + }, + { + "target": "com.amazonaws.wellarchitected#CreateWorkloadShare" + }, + { + "target": "com.amazonaws.wellarchitected#DeleteLens" + }, + { + "target": "com.amazonaws.wellarchitected#DeleteLensShare" + }, + { + "target": "com.amazonaws.wellarchitected#DeleteProfile" + }, + { + "target": "com.amazonaws.wellarchitected#DeleteProfileShare" + }, + { + "target": "com.amazonaws.wellarchitected#DeleteWorkload" + }, + { + "target": "com.amazonaws.wellarchitected#DeleteWorkloadShare" + }, + { + "target": "com.amazonaws.wellarchitected#DisassociateLenses" + }, + { + "target": "com.amazonaws.wellarchitected#DisassociateProfiles" + }, + { + "target": "com.amazonaws.wellarchitected#ExportLens" + }, + { + "target": "com.amazonaws.wellarchitected#GetAnswer" + }, + { + "target": "com.amazonaws.wellarchitected#GetConsolidatedReport" + }, + { + "target": "com.amazonaws.wellarchitected#GetLens" + }, + { + "target": "com.amazonaws.wellarchitected#GetLensReview" + }, + { + "target": "com.amazonaws.wellarchitected#GetLensReviewReport" + }, + { + "target": "com.amazonaws.wellarchitected#GetLensVersionDifference" + }, + { + "target": "com.amazonaws.wellarchitected#GetMilestone" + }, + { + "target": "com.amazonaws.wellarchitected#GetProfile" + }, + { + "target": "com.amazonaws.wellarchitected#GetProfileTemplate" + }, + { + "target": "com.amazonaws.wellarchitected#GetWorkload" + }, + { + "target": "com.amazonaws.wellarchitected#ImportLens" + }, + { + "target": "com.amazonaws.wellarchitected#ListAnswers" + }, + { + "target": "com.amazonaws.wellarchitected#ListCheckDetails" + }, + { + "target": "com.amazonaws.wellarchitected#ListCheckSummaries" + }, + { + "target": "com.amazonaws.wellarchitected#ListLenses" + }, + { + "target": "com.amazonaws.wellarchitected#ListLensReviewImprovements" + }, + { + "target": "com.amazonaws.wellarchitected#ListLensReviews" + }, + { + "target": "com.amazonaws.wellarchitected#ListLensShares" + }, + { + "target": "com.amazonaws.wellarchitected#ListMilestones" + }, + { + "target": "com.amazonaws.wellarchitected#ListNotifications" + }, + { + "target": "com.amazonaws.wellarchitected#ListProfileNotifications" + }, + { + "target": "com.amazonaws.wellarchitected#ListProfiles" + }, + { + "target": "com.amazonaws.wellarchitected#ListProfileShares" + }, + { + "target": "com.amazonaws.wellarchitected#ListShareInvitations" + }, + { + "target": "com.amazonaws.wellarchitected#ListTagsForResource" + }, + { + "target": "com.amazonaws.wellarchitected#ListWorkloads" + }, + { + "target": "com.amazonaws.wellarchitected#ListWorkloadShares" + }, + { + "target": "com.amazonaws.wellarchitected#TagResource" + }, + { + "target": "com.amazonaws.wellarchitected#UntagResource" + }, + { + "target": "com.amazonaws.wellarchitected#UpdateAnswer" + }, + { + "target": "com.amazonaws.wellarchitected#UpdateGlobalSettings" + }, + { + "target": "com.amazonaws.wellarchitected#UpdateLensReview" + }, + { + "target": "com.amazonaws.wellarchitected#UpdateProfile" + }, + { + "target": "com.amazonaws.wellarchitected#UpdateShareInvitation" + }, + { + "target": "com.amazonaws.wellarchitected#UpdateWorkload" + }, { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "type": "tree", - "rules": [ + "target": "com.amazonaws.wellarchitected#UpdateWorkloadShare" + }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" + "target": "com.amazonaws.wellarchitected#UpgradeLensReview" }, { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + "target": "com.amazonaws.wellarchitected#UpgradeProfileVersion" } - ] - }, - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" + ], + "traits": { + "aws.api#service": { + "sdkId": "WellArchitected", + "arnNamespace": "wellarchitected", + "cloudFormationName": "WellArchitected", + "cloudTrailEventSource": "wellarchitected.amazonaws.com", + "endpointPrefix": "wellarchitected" + }, + "aws.auth#sigv4": { + "name": "wellarchitected" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Well-Architected Tool\n

This is the Well-Architected Tool API Reference. The WA Tool API provides programmatic access to the \n Well-Architected Tool in the \n Amazon Web Services Management Console. For information \n about the Well-Architected Tool, see the \n Well-Architected Tool User Guide.

", + "smithy.api#title": "AWS Well-Architected Tool", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" } - ], - "type": "tree", - "rules": [ + }, + "rules": [ { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ + "conditions": [ { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ + "conditions": [ { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" }, { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ + "conditions": [], + "type": "tree", + "rules": [ { - "ref": "PartitionResult" + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" }, - "supportsDualStack" - ] - } - ] + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] } - ], - "type": "tree", - "rules": [ + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://wellarchitected-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://wellarchitected-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://wellarchitected.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://wellarchitected.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + } + ] + }, { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://wellarchitected-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wellarchitected.ap-east-1.amazonaws.com" } - ] }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false } - ] }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wellarchitected.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wellarchitected.ap-northeast-2.amazonaws.com" } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://wellarchitected-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wellarchitected.ap-south-1.amazonaws.com" } - ] }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false } - ] }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wellarchitected.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wellarchitected.ap-southeast-2.amazonaws.com" } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://wellarchitected.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wellarchitected.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wellarchitected.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wellarchitected.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wellarchitected.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wellarchitected.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wellarchitected.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wellarchitected.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wellarchitected.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wellarchitected.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wellarchitected.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wellarchitected.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wellarchitected.us-west-2.amazonaws.com" } - ] }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false } - ] }, { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://wellarchitected.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://wellarchitected-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wellarchitected-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://wellarchitected.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://wellarchitected-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wellarchitected-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://wellarchitected.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wellarchitected.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://wellarchitected-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wellarchitected-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://wellarchitected.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wellarchitected.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wellarchitected-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wellarchitected.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wellarchitected-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wellarchitected.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" } - ] } - ] + ], + "version": "1.0" + } + } + }, + "com.amazonaws.wellarchitected#Workload": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "WorkloadArn": { + "target": "com.amazonaws.wellarchitected#WorkloadArn" + }, + "WorkloadName": { + "target": "com.amazonaws.wellarchitected#WorkloadName" + }, + "Description": { + "target": "com.amazonaws.wellarchitected#WorkloadDescription" + }, + "Environment": { + "target": "com.amazonaws.wellarchitected#WorkloadEnvironment" + }, + "UpdatedAt": { + "target": "com.amazonaws.wellarchitected#Timestamp" + }, + "AccountIds": { + "target": "com.amazonaws.wellarchitected#WorkloadAccountIds" + }, + "AwsRegions": { + "target": "com.amazonaws.wellarchitected#WorkloadAwsRegions" + }, + "NonAwsRegions": { + "target": "com.amazonaws.wellarchitected#WorkloadNonAwsRegions" + }, + "ArchitecturalDesign": { + "target": "com.amazonaws.wellarchitected#WorkloadArchitecturalDesign" + }, + "ReviewOwner": { + "target": "com.amazonaws.wellarchitected#WorkloadReviewOwner" + }, + "ReviewRestrictionDate": { + "target": "com.amazonaws.wellarchitected#Timestamp" + }, + "IsReviewOwnerUpdateAcknowledged": { + "target": "com.amazonaws.wellarchitected#IsReviewOwnerUpdateAcknowledged", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Flag indicating whether the workload owner has acknowledged that the Review\n owner field is required.

\n

If a Review owner is not added to the workload within\n 60 days of acknowledgement, access to the workload is restricted until an owner is\n added.

" + } + }, + "IndustryType": { + "target": "com.amazonaws.wellarchitected#WorkloadIndustryType" + }, + "Industry": { + "target": "com.amazonaws.wellarchitected#WorkloadIndustry" + }, + "Notes": { + "target": "com.amazonaws.wellarchitected#Notes" + }, + "ImprovementStatus": { + "target": "com.amazonaws.wellarchitected#WorkloadImprovementStatus" + }, + "RiskCounts": { + "target": "com.amazonaws.wellarchitected#RiskCounts" + }, + "PillarPriorities": { + "target": "com.amazonaws.wellarchitected#WorkloadPillarPriorities" + }, + "Lenses": { + "target": "com.amazonaws.wellarchitected#WorkloadLenses" + }, + "Owner": { + "target": "com.amazonaws.wellarchitected#AwsAccountId" + }, + "ShareInvitationId": { + "target": "com.amazonaws.wellarchitected#ShareInvitationId", + "traits": { + "smithy.api#documentation": "

The ID assigned to the share invitation.

" } - ] }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" + "Tags": { + "target": "com.amazonaws.wellarchitected#TagMap", + "traits": { + "smithy.api#documentation": "

The tags associated with the workload.

" + } + }, + "DiscoveryConfig": { + "target": "com.amazonaws.wellarchitected#WorkloadDiscoveryConfig", + "traits": { + "smithy.api#documentation": "

Discovery configuration associated to the workload.

" + } + }, + "Applications": { + "target": "com.amazonaws.wellarchitected#WorkloadApplications", + "traits": { + "smithy.api#documentation": "

List of AppRegistry application ARNs associated to the workload.

" + } + }, + "Profiles": { + "target": "com.amazonaws.wellarchitected#WorkloadProfiles", + "traits": { + "smithy.api#documentation": "

Profile associated with a workload.

" + } + }, + "PrioritizedRiskCounts": { + "target": "com.amazonaws.wellarchitected#RiskCounts" } - ] + }, + "traits": { + "smithy.api#documentation": "

A workload return object.

" } - ] }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wellarchitected.ap-east-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wellarchitected.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wellarchitected.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wellarchitected.ap-south-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wellarchitected.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wellarchitected.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wellarchitected.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wellarchitected.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wellarchitected.eu-north-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wellarchitected.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wellarchitected.eu-west-2.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wellarchitected.eu-west-3.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wellarchitected.me-south-1.amazonaws.com" - } - }, - "params": { - "Region": "me-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wellarchitected.sa-east-1.amazonaws.com" - } - }, - "params": { - "Region": "sa-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wellarchitected.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wellarchitected.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wellarchitected.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wellarchitected.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://wellarchitected-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wellarchitected-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://wellarchitected.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://wellarchitected-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wellarchitected-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://wellarchitected.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wellarchitected.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://wellarchitected-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wellarchitected-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://wellarchitected.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wellarchitected.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wellarchitected-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wellarchitected.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wellarchitected-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://wellarchitected.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } + "com.amazonaws.wellarchitected#WorkloadAccountIds": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#AwsAccountId" }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } + "traits": { + "smithy.api#documentation": "

The list of Amazon Web Services account IDs associated with the workload.

", + "smithy.api#length": { + "min": 0, + "max": 100 + } } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.wellarchitected#Workload": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId" - }, - "WorkloadArn": { - "target": "com.amazonaws.wellarchitected#WorkloadArn" - }, - "WorkloadName": { - "target": "com.amazonaws.wellarchitected#WorkloadName" - }, - "Description": { - "target": "com.amazonaws.wellarchitected#WorkloadDescription" }, - "Environment": { - "target": "com.amazonaws.wellarchitected#WorkloadEnvironment" - }, - "UpdatedAt": { - "target": "com.amazonaws.wellarchitected#Timestamp" - }, - "AccountIds": { - "target": "com.amazonaws.wellarchitected#WorkloadAccountIds" - }, - "AwsRegions": { - "target": "com.amazonaws.wellarchitected#WorkloadAwsRegions" - }, - "NonAwsRegions": { - "target": "com.amazonaws.wellarchitected#WorkloadNonAwsRegions" - }, - "ArchitecturalDesign": { - "target": "com.amazonaws.wellarchitected#WorkloadArchitecturalDesign" - }, - "ReviewOwner": { - "target": "com.amazonaws.wellarchitected#WorkloadReviewOwner" - }, - "ReviewRestrictionDate": { - "target": "com.amazonaws.wellarchitected#Timestamp" + "com.amazonaws.wellarchitected#WorkloadApplications": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ApplicationArn" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } }, - "IsReviewOwnerUpdateAcknowledged": { - "target": "com.amazonaws.wellarchitected#IsReviewOwnerUpdateAcknowledged", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Flag indicating whether the workload owner has acknowledged that the Review\n owner field is required.

\n

If a Review owner is not added to the workload within\n 60 days of acknowledgement, access to the workload is restricted until an owner is\n added.

" - } + "com.amazonaws.wellarchitected#WorkloadArchitecturalDesign": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The URL of the architectural design for the workload.

", + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^(|(https?|ftp):\\/\\/[^\\s/$.?#].[^\\s]*)$" + } }, - "IndustryType": { - "target": "com.amazonaws.wellarchitected#WorkloadIndustryType" + "com.amazonaws.wellarchitected#WorkloadArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The ARN for the workload.

" + } }, - "Industry": { - "target": "com.amazonaws.wellarchitected#WorkloadIndustry" + "com.amazonaws.wellarchitected#WorkloadAwsRegions": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#AwsRegion" + }, + "traits": { + "smithy.api#documentation": "

The list of Amazon Web Services Regions associated with the workload, for example,\n us-east-2, or ca-central-1.

", + "smithy.api#length": { + "min": 0, + "max": 50 + } + } }, - "Notes": { - "target": "com.amazonaws.wellarchitected#Notes" + "com.amazonaws.wellarchitected#WorkloadDescription": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The description for the workload.

", + "smithy.api#length": { + "min": 3, + "max": 250 + } + } }, - "ImprovementStatus": { - "target": "com.amazonaws.wellarchitected#WorkloadImprovementStatus" + "com.amazonaws.wellarchitected#WorkloadDiscoveryConfig": { + "type": "structure", + "members": { + "TrustedAdvisorIntegrationStatus": { + "target": "com.amazonaws.wellarchitected#TrustedAdvisorIntegrationStatus", + "traits": { + "smithy.api#documentation": "

Discovery integration status in respect to Trusted Advisor for the workload.

" + } + }, + "WorkloadResourceDefinition": { + "target": "com.amazonaws.wellarchitected#WorkloadResourceDefinition", + "traits": { + "smithy.api#documentation": "

The mode to use for identifying resources associated with the workload.

\n

You can specify WORKLOAD_METADATA, APP_REGISTRY, or both.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Discovery configuration associated to the workload.

" + } }, - "RiskCounts": { - "target": "com.amazonaws.wellarchitected#RiskCounts" + "com.amazonaws.wellarchitected#WorkloadEnvironment": { + "type": "enum", + "members": { + "PRODUCTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRODUCTION" + } + }, + "PREPRODUCTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREPRODUCTION" + } + } + }, + "traits": { + "smithy.api#documentation": "

The environment for the workload.

" + } }, - "PillarPriorities": { - "target": "com.amazonaws.wellarchitected#WorkloadPillarPriorities" + "com.amazonaws.wellarchitected#WorkloadId": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

", + "smithy.api#length": { + "min": 32, + "max": 32 + }, + "smithy.api#pattern": "^[0-9a-f]{32}$" + } }, - "Lenses": { - "target": "com.amazonaws.wellarchitected#WorkloadLenses" + "com.amazonaws.wellarchitected#WorkloadImprovementStatus": { + "type": "enum", + "members": { + "NOT_APPLICABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_APPLICABLE" + } + }, + "NOT_STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_STARTED" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETE" + } + }, + "RISK_ACKNOWLEDGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RISK_ACKNOWLEDGED" + } + } + }, + "traits": { + "smithy.api#documentation": "

The improvement status for a workload.

" + } }, - "Owner": { - "target": "com.amazonaws.wellarchitected#AwsAccountId" + "com.amazonaws.wellarchitected#WorkloadIndustry": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The industry for the workload.

", + "smithy.api#length": { + "min": 0, + "max": 100 + } + } }, - "ShareInvitationId": { - "target": "com.amazonaws.wellarchitected#ShareInvitationId", - "traits": { - "smithy.api#documentation": "

The ID assigned to the share invitation.

" - } + "com.amazonaws.wellarchitected#WorkloadIndustryType": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The industry type for the workload.

\n

If specified, must be one of the following:

\n ", + "smithy.api#length": { + "min": 0, + "max": 100 + } + } }, - "Tags": { - "target": "com.amazonaws.wellarchitected#TagMap", - "traits": { - "smithy.api#documentation": "

The tags associated with the workload.

" - } + "com.amazonaws.wellarchitected#WorkloadLenses": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#LensAlias" + }, + "traits": { + "smithy.api#documentation": "

The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.

" + } }, - "DiscoveryConfig": { - "target": "com.amazonaws.wellarchitected#WorkloadDiscoveryConfig", - "traits": { - "smithy.api#documentation": "

Discovery configuration associated to the workload.

" - } + "com.amazonaws.wellarchitected#WorkloadName": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The name of the workload.

\n

The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization\n are ignored when checking for uniqueness.

", + "smithy.api#length": { + "min": 3, + "max": 100 + } + } }, - "Applications": { - "target": "com.amazonaws.wellarchitected#WorkloadApplications", - "traits": { - "smithy.api#documentation": "

List of AppRegistry application ARNs associated to the workload.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A workload return object.

" - } - }, - "com.amazonaws.wellarchitected#WorkloadAccountIds": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#AwsAccountId" - }, - "traits": { - "smithy.api#documentation": "

The list of Amazon Web Services account IDs associated with the workload.

", - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.wellarchitected#WorkloadApplications": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#ApplicationArn" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.wellarchitected#WorkloadArchitecturalDesign": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The URL of the architectural design for the workload.

", - "smithy.api#length": { - "min": 0, - "max": 2048 - }, - "smithy.api#pattern": "^(|(https?|ftp):\\/\\/[^\\s/$.?#].[^\\s]*)$" - } - }, - "com.amazonaws.wellarchitected#WorkloadArn": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The ARN for the workload.

" - } - }, - "com.amazonaws.wellarchitected#WorkloadAwsRegions": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#AwsRegion" - }, - "traits": { - "smithy.api#documentation": "

The list of Amazon Web Services Regions associated with the workload, for example,\n us-east-2, or ca-central-1.

", - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.wellarchitected#WorkloadDescription": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The description for the workload.

", - "smithy.api#length": { - "min": 3, - "max": 250 - } - } - }, - "com.amazonaws.wellarchitected#WorkloadDiscoveryConfig": { - "type": "structure", - "members": { - "TrustedAdvisorIntegrationStatus": { - "target": "com.amazonaws.wellarchitected#TrustedAdvisorIntegrationStatus", - "traits": { - "smithy.api#documentation": "

Discovery integration status in respect to Trusted Advisor for the workload.

" - } - }, - "WorkloadResourceDefinition": { - "target": "com.amazonaws.wellarchitected#WorkloadResourceDefinition", - "traits": { - "smithy.api#documentation": "

The mode to use for identifying resources associated with the workload.

\n

You can specify WORKLOAD_METADATA, APP_REGISTRY, or both.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Discovery configuration associated to the workload.

" - } - }, - "com.amazonaws.wellarchitected#WorkloadEnvironment": { - "type": "enum", - "members": { - "PRODUCTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PRODUCTION" - } - }, - "PREPRODUCTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PREPRODUCTION" - } - } - }, - "traits": { - "smithy.api#documentation": "

The environment for the workload.

" - } - }, - "com.amazonaws.wellarchitected#WorkloadId": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

", - "smithy.api#pattern": "^[0-9a-f]{32}$" - } - }, - "com.amazonaws.wellarchitected#WorkloadImprovementStatus": { - "type": "enum", - "members": { - "NOT_APPLICABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_APPLICABLE" - } - }, - "NOT_STARTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_STARTED" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_PROGRESS" - } - }, - "COMPLETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETE" - } - }, - "RISK_ACKNOWLEDGED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RISK_ACKNOWLEDGED" - } - } - }, - "traits": { - "smithy.api#documentation": "

The improvement status for a workload.

" - } - }, - "com.amazonaws.wellarchitected#WorkloadIndustry": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The industry for the workload.

", - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.wellarchitected#WorkloadIndustryType": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The industry type for the workload.

\n

If specified, must be one of the following:

\n ", - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.wellarchitected#WorkloadLenses": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#LensAlias" - }, - "traits": { - "smithy.api#documentation": "

The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.

" - } - }, - "com.amazonaws.wellarchitected#WorkloadName": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The name of the workload.

\n

The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization\n are ignored when checking for uniqueness.

", - "smithy.api#length": { - "min": 3, - "max": 100 - } - } - }, - "com.amazonaws.wellarchitected#WorkloadNamePrefix": { - "type": "string", - "traits": { - "smithy.api#documentation": "

An optional string added to the beginning of each workload name returned in the\n results.

", - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.wellarchitected#WorkloadNonAwsRegion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 25 - } - } - }, - "com.amazonaws.wellarchitected#WorkloadNonAwsRegions": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#WorkloadNonAwsRegion" - }, - "traits": { - "smithy.api#documentation": "

The list of non-Amazon Web Services Regions associated with the workload.

", - "smithy.api#length": { - "min": 0, - "max": 5 - } - } - }, - "com.amazonaws.wellarchitected#WorkloadPillarPriorities": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#PillarId" - }, - "traits": { - "smithy.api#documentation": "

The priorities of the pillars, which are used to order items in the improvement plan.\n Each pillar is represented by its PillarReviewSummary$PillarId.

" - } - }, - "com.amazonaws.wellarchitected#WorkloadResourceDefinition": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#DefinitionType" - } - }, - "com.amazonaws.wellarchitected#WorkloadReviewOwner": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The review owner of the workload. The name, email address, or identifier for the\n primary group or individual that owns the workload review process.

", - "smithy.api#length": { - "min": 3, - "max": 255 - } - } - }, - "com.amazonaws.wellarchitected#WorkloadShare": { - "type": "structure", - "members": { - "ShareId": { - "target": "com.amazonaws.wellarchitected#ShareId" + "com.amazonaws.wellarchitected#WorkloadNamePrefix": { + "type": "string", + "traits": { + "smithy.api#documentation": "

An optional string added to the beginning of each workload name returned in the\n results.

", + "smithy.api#length": { + "min": 0, + "max": 100 + } + } }, - "SharedBy": { - "target": "com.amazonaws.wellarchitected#AwsAccountId" + "com.amazonaws.wellarchitected#WorkloadNonAwsRegion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 25 + } + } }, - "SharedWith": { - "target": "com.amazonaws.wellarchitected#SharedWith" + "com.amazonaws.wellarchitected#WorkloadNonAwsRegions": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#WorkloadNonAwsRegion" + }, + "traits": { + "smithy.api#documentation": "

The list of non-Amazon Web Services Regions associated with the workload.

", + "smithy.api#length": { + "min": 0, + "max": 5 + } + } }, - "PermissionType": { - "target": "com.amazonaws.wellarchitected#PermissionType" + "com.amazonaws.wellarchitected#WorkloadPillarPriorities": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#PillarId" + }, + "traits": { + "smithy.api#documentation": "

The priorities of the pillars, which are used to order items in the improvement plan.\n Each pillar is represented by its PillarReviewSummary$PillarId.

" + } }, - "Status": { - "target": "com.amazonaws.wellarchitected#ShareStatus" + "com.amazonaws.wellarchitected#WorkloadProfile": { + "type": "structure", + "members": { + "ProfileArn": { + "target": "com.amazonaws.wellarchitected#ProfileArn", + "traits": { + "smithy.api#documentation": "

The profile ARN.

" + } + }, + "ProfileVersion": { + "target": "com.amazonaws.wellarchitected#ProfileVersion", + "traits": { + "smithy.api#documentation": "

The profile version.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The profile associated with a workload.

" + } }, - "WorkloadName": { - "target": "com.amazonaws.wellarchitected#WorkloadName" + "com.amazonaws.wellarchitected#WorkloadProfileArns": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ProfileArn" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } }, - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId" - } - }, - "traits": { - "smithy.api#documentation": "

A workload share return object.

" - } - }, - "com.amazonaws.wellarchitected#WorkloadShareSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#WorkloadShareSummary" - }, - "traits": { - "smithy.api#documentation": "

A list of workload share summaries.

" - } - }, - "com.amazonaws.wellarchitected#WorkloadShareSummary": { - "type": "structure", - "members": { - "ShareId": { - "target": "com.amazonaws.wellarchitected#ShareId" - }, - "SharedWith": { - "target": "com.amazonaws.wellarchitected#SharedWith" - }, - "PermissionType": { - "target": "com.amazonaws.wellarchitected#PermissionType" - }, - "Status": { - "target": "com.amazonaws.wellarchitected#ShareStatus" - }, - "StatusMessage": { - "target": "com.amazonaws.wellarchitected#StatusMessage", - "traits": { - "smithy.api#documentation": "

Optional message to compliment the Status field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A workload share summary return object.

" - } - }, - "com.amazonaws.wellarchitected#WorkloadSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#WorkloadSummary" - }, - "traits": { - "smithy.api#documentation": "

A list of workload summaries.

" - } - }, - "com.amazonaws.wellarchitected#WorkloadSummary": { - "type": "structure", - "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId" + "com.amazonaws.wellarchitected#WorkloadProfiles": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#WorkloadProfile" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } }, - "WorkloadArn": { - "target": "com.amazonaws.wellarchitected#WorkloadArn" + "com.amazonaws.wellarchitected#WorkloadResourceDefinition": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#DefinitionType" + } }, - "WorkloadName": { - "target": "com.amazonaws.wellarchitected#WorkloadName" + "com.amazonaws.wellarchitected#WorkloadReviewOwner": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The review owner of the workload. The name, email address, or identifier for the\n primary group or individual that owns the workload review process.

", + "smithy.api#length": { + "min": 3, + "max": 255 + } + } }, - "Owner": { - "target": "com.amazonaws.wellarchitected#AwsAccountId" + "com.amazonaws.wellarchitected#WorkloadShare": { + "type": "structure", + "members": { + "ShareId": { + "target": "com.amazonaws.wellarchitected#ShareId" + }, + "SharedBy": { + "target": "com.amazonaws.wellarchitected#AwsAccountId" + }, + "SharedWith": { + "target": "com.amazonaws.wellarchitected#SharedWith" + }, + "PermissionType": { + "target": "com.amazonaws.wellarchitected#PermissionType" + }, + "Status": { + "target": "com.amazonaws.wellarchitected#ShareStatus" + }, + "WorkloadName": { + "target": "com.amazonaws.wellarchitected#WorkloadName" + }, + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + } + }, + "traits": { + "smithy.api#documentation": "

A workload share return object.

" + } }, - "UpdatedAt": { - "target": "com.amazonaws.wellarchitected#Timestamp" + "com.amazonaws.wellarchitected#WorkloadShareSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#WorkloadShareSummary" + }, + "traits": { + "smithy.api#documentation": "

A list of workload share summaries.

" + } }, - "Lenses": { - "target": "com.amazonaws.wellarchitected#WorkloadLenses" + "com.amazonaws.wellarchitected#WorkloadShareSummary": { + "type": "structure", + "members": { + "ShareId": { + "target": "com.amazonaws.wellarchitected#ShareId" + }, + "SharedWith": { + "target": "com.amazonaws.wellarchitected#SharedWith" + }, + "PermissionType": { + "target": "com.amazonaws.wellarchitected#PermissionType" + }, + "Status": { + "target": "com.amazonaws.wellarchitected#ShareStatus" + }, + "StatusMessage": { + "target": "com.amazonaws.wellarchitected#StatusMessage", + "traits": { + "smithy.api#documentation": "

Optional message to compliment the Status field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A workload share summary return object.

" + } }, - "RiskCounts": { - "target": "com.amazonaws.wellarchitected#RiskCounts" + "com.amazonaws.wellarchitected#WorkloadSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#WorkloadSummary" + }, + "traits": { + "smithy.api#documentation": "

A list of workload summaries.

" + } }, - "ImprovementStatus": { - "target": "com.amazonaws.wellarchitected#WorkloadImprovementStatus" + "com.amazonaws.wellarchitected#WorkloadSummary": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "WorkloadArn": { + "target": "com.amazonaws.wellarchitected#WorkloadArn" + }, + "WorkloadName": { + "target": "com.amazonaws.wellarchitected#WorkloadName" + }, + "Owner": { + "target": "com.amazonaws.wellarchitected#AwsAccountId" + }, + "UpdatedAt": { + "target": "com.amazonaws.wellarchitected#Timestamp" + }, + "Lenses": { + "target": "com.amazonaws.wellarchitected#WorkloadLenses" + }, + "RiskCounts": { + "target": "com.amazonaws.wellarchitected#RiskCounts" + }, + "ImprovementStatus": { + "target": "com.amazonaws.wellarchitected#WorkloadImprovementStatus" + }, + "Profiles": { + "target": "com.amazonaws.wellarchitected#WorkloadProfiles", + "traits": { + "smithy.api#documentation": "

Profile associated with a workload.

" + } + }, + "PrioritizedRiskCounts": { + "target": "com.amazonaws.wellarchitected#RiskCounts" + } + }, + "traits": { + "smithy.api#documentation": "

A workload summary return object.

" + } } - }, - "traits": { - "smithy.api#documentation": "

A workload summary return object.

" - } } - } }